Migrate from Data Security Manager
You can restore the following objects from a Data Security Manager (DSM) backup file:
Agent keys, including versioned keys
Vault keys
Domains
Note
As the DSM migration is a technical preview for demonstration purposes, all other DSM objects are not yet supported on CipherTrust Manager. These objects are skipped during restoration.
By default, the user who restores the backup file becomes the administrator of the newly created CipherTrust Manager domain(s), and has access to the restored keys within the domain(s). There is an additional option to create a key-sharing group with permissions for the restored keys in all domains. You can later add CipherTrust Manager users to this group to grant access to the keys.
The DSM Administration Guide version 6.4.4 describes creating and encrypting a backup file for CipherTrust Manager in Chapter 12 "Backing Up and Restoring".
Exporting and Importing the Backup File
As part of exporting a backup file from a DSM, you create a wrapper key to encrypt the file. On the target CipherTrust Manager, you create a migration split key with the same values as the wrapper key. This migration split key is needed for CipherTrust Manager to decrypt the backup file to restore the DSM objects.
The wrapper key and migration split key divides a single key into multiple shares, with a minimum number of shares required to reassemble the key. This configuration, called M of N, provides more security as a different custodian holds and controls each share.
To migrate agent keys and vault keys from DSM
On your DSM appliance, create a wrapper key, and split it into key shares as described in the DSM Administration Guide version 6.4.4 Chapter 12 "Backing Up and Restoring".
You need the following values to later create the corresponding migration split key and key shares on CipherTrust Manager:
The wrapper key identifier
The Minimum Custodians Needed to assemble the wrapper key
The Total Number of Custodians who hold key shares
The key material from the wrapper key shares
Create a backup file on the DSM, using the wrapper key to encrypt the backup file.
Note
The backup file can include objects other than agent keys, vault keys, or domains. CipherTrust Manager skips these items and does not restore them.
Create a migration split key on a CipherTrust Manager to decrypt the backup file.
Note
You cannot directly import a DSM-created wrapper key into the CipherTrust Manager. You must re-create the wrapper key as a migration split key.
Create the migration split key.
$ ksctl migration-split-keys create --name <name> --max-shares <max-shares> --threshold <threshold> --digest <digest>
You must provide:
a
name
for the key.max-shares
— a number of key shares, based on Total Number of Custodians from the DSM wrapper key. The minimum value is 2 and the maximum value is 10.threshold
— a minimum number of keys needed to reconstruct the split key, based on Minimum Custodians Needed from the DSM wrapper key. This value is lesser than or equal to themax-shares
value.digest
— the identifier from the original DSM wrapper key.
Create shares for the split key. Create as many as shares as indicated in the
threshold
value for the migration split key.$ ksctl migration-split-keys shares create --name <name> --share-key <share-key> $ ksctl migration-split-keys shares create --name <name> --share-key <share-key>
You must provide the name of the migration split key and the key material from the DSM wrapper key share.
Upload the backup file into the CipherTrust Manager. Take note of the ID returned in the response.
$ ksctl migrations upload --file <filename>
Apply the backup file.
$ ksctl migrations apply --id <id> [--user <user-name> --password <user-password>] [--domains <DSM-domains>] [--group-name <DSM group name>]
You must provide the
id
for the backup file. This was indicated when you uploaded the backup, or you can view it with theksctl migrations list
command.The following parameters are optional:
user
— The CipherTrust Manager user who will become the administrator of the created domain(s). If not specified, the user currently logged in to ksctl is granted this permission.password
— Password of the above CipherTrust Manager user.domains
— Limits the DSM domains that are restored. The accepted format is a comma-separate list of domain names.group-name
— Creates a new group with this name in every domain that is migrated. Users belonging to this group can access all keys in the domain.
You can check the status of the migration with
ksctl migrations status
.List your keys to ensure that DSM keys were successfully migrated into the CipherTrust Manager domain.
$ ksctl --domain <domain-name> keys list