Search <book_title>...

Veritas NetBackup™ Security and Encryption Guide

Last Published: 2017-09-25

Product(s): NetBackup (8.1)

Installing KMS

The following procedure describes how to install KMS.

Note:

For more information on configuring KMS in a Cloud storage environment refer to the NetBackup Cloud Administrator's Guide.

The KMS service is called nbkms.

The service does not run until the data file has been set up, which minimizes the effect on environments not using KMS.

To install KMS

Run the nbkms -createemptydb command.
Enter a pass phrase for the host master key (HMK). You can also press Enter to create a randomly generated key.
Enter an ID for the HMK. This ID can be anything descriptive that you want to use to identify the HMK.
Enter a pass phrase for the key protection key (KPK).
Enter an ID for the KPK. The ID can be anything descriptive that you want to use to identify the KPK.
The KMS service starts when after you enter the ID and press Enter.
Start the service by running the following command:
```
nbkms
```
Use the grep command to ensure that the service has started, as follows:
```
ps -ef | grep nbkms
```
Create the key group. The key group name must be an identical match to the volume pool name. All key group names must have a prefix ENCR_.
Note:
When using key management with Cloud storage, the ENCR_ prefix is not required for the key group name.
To create a (non-Cloud storage) key group use the following command syntax.
```
nbkmsutil -createkg -kgname ENCR_volumepoolname
```
The ENCR_ prefix is essential. When BPTM receives a volume pool request that includes the ENCR_ prefix, it provides that volume pool name to KMS. KMS identifies it as an exact match of the volume pool and then picks the active key record for backups out of that group.
To create a Cloud storage key group use the following command syntax.
```
nbkmsutil -createkg -kgname cloud_provider_URL:volume_name
```
Create a key record by using the -createkey option.
```
nbkmsutil -createkey -kgname ENCR_volumepool -keyname keyname -activate -desc "message"
```
The key name and message are optional; they can help you identify this key when you display the key.
The -activate option skips the prelive state and creates this key as active.
Provide the pass phrase again when the script prompts you.
In the following example the key group is called ENCR_pool1 and the key name is Q1_2008_key. The description explains that this key is for the months January, February, and March.
```
nbkmsutil -createkey -kgname ENCR_pool1 -keyname Q1_2008_key -activate -desc "key for 
Jan, Feb, & Mar"
```
You can create another key record using the same command; a different key name and description help you distinguish they key records:
```
nbkmsutil -createkey -kgname ENCR_pool1 -keyname Q2_2008_key -activate -desc "key for 
Apr, May, & Jun"
```
Note:
If you create more than one key record by using the command nbkmsutil -kgname name -activate, only the last key remains active.
To list all of the keys that belong to a key group name, use the following command:
```
nbkmsutil -listkeys -kgname keyname
```
Note:
Veritas recommends that you keep a record of the output of the nbkmsutil -listkeys command. The key tag that is listed in the output is necessary if you need to recover keys.
The following command and output use the examples in this procedure.

More Information

About installing KMS with HA clustering

Using KMS with NBAC