Migrating CTE Resources from CipherTrust Manager Appliance
You can migrate CipherTrust Transparent Encryption (CTE) resources from CipherTrust Manager Appliance version 2.13.x-2.16.x to your CipherTrust Data Security Platform Service (CDSPaaS).
Note
Supported CipherTrust Manager Appliance versions for migration change over time as CDSPaaS adds functionality from more recent versions. Subscribe to the Changelog for updates on migration support changes.
Consult CipherTrust Manager appliance documentation of the applicable version for more details and the most current information on operations performed on CipherTrust Manager appliance.
Prerequisite
A CipherTrust Data Security Platform Service must be provisioned with all required CTE purchased services, as outlined in Get Started with CipherTrust Data Security Platform Services.
Migrate CTE Resources
To migrate CTE resources, follow these high level steps in order:
The following objects are migrated after these stages:
All keys, including CTE keys
CTE Policies
Policy elements associated with CTE policies
CTE clients
Backup CTE Resources on CipherTrust Manager Appliance
Login to the CipherTrust WebUI for the desired domain, as a user in the
admin
orBackup Admins
group.Obtain a domain backup key.
Navigate to Admin Settings > Backup keys.
Review the list of backup keys to see if a domain backup key exists. If no domain backup key exists, click + Add Backup Key to add one.
Click the ellipsis icon (
) corresponding to the desired backup key.
Click Download.
Enter and confirm a password.
Click Download.
The backup key file is downloaded to your local computer.
Create the backup.
Navigate to Admin Settings > Backups.
Click Add Backup.
Select Domain Backup for the backup scope.
Click Next.
Provide a description and select the domain backup key obtained in step 2 from the list.
Caution
Make sure to select the correct backup key, so the backup can be successfully restored on the CipherTrust Data Security Platform Service.
Click Add Backup. The backup includes all resources types including CTE resources.
Click the ellipsis icon (
) corresponding to the new backup.
Select Download.
The backup file is downloaded to your local computer.
Proceed to Restore CTE Resources on the CipherTrust Data Security Platform Service.
Restore CTE Resources on the CipherTrust Data Security Platform Service
This stage migrates keys, CTE policies, and CTE policy elements.
Caution
If a CTE policy or key in the backup file is already present on the CipherTrust Data Security Platform Service with the same name, restoring these objects can create a conflict. Conflicting keys cause the restore operation to fail with the error Error copying data from backup database
. Refer to Handling Conflicting Resources for information on how CipherTrust Data Security Platform Service handles these cases, and actions you can take to resolve conflicts.
Login to the CipherTrust Data Security Platform Service as a member of the
admin
group, or of all of theCTE Admins
,Domain Backup Admins
,Domain Restore Admins
,Key Admins
groups.Note
Generally, the first user created on the CipherTrust Data Security Platform Service has sufficient permissions.
Upload the backup key file obtained from the CipherTrust Manager appliance.
Navigate to Admin Settings > Backup keys.
Select Upload Backup Key.
Click Browse to browse to the backup key file on your local system.
Enter the password for the backup key file.
Click Upload.
Upload the backup file obtained from the CipherTrust Manager appliance.
Navigate to Admin Settings > Backups.
Select Upload Backup.
Click Browse to browse to the backup file on your local system.
Click Upload.
On the backups page, click the ellipsis icon (
) corresponding to the newly uploaded backup.
Click Restore.
Wait for the restore operation to complete.
Confirm that all objects restored correctly.
Keys: Navigate to the Keys page.
CTE Policies: Navigate to Products > Transparent Encryption > Policies > Policies.
CTE Policy Elements: Navigate to Products > Transparent Encryption > Policies > Policy Elements.
Delete the backup file.
Note
CipherTrust Data Security Platform Service has limited storage for backup files. We recommend deleting them immediately after you confirm the restore has succeeded. We can only guarantee that backup files will be retained for 3 days.
Navigate to Admin Settings > Backups.
Click the ellipsis icon (
) corresponding to the newly restored backup.
Click Delete.
Proceed to Re-register CTE Agents to migrate clients.
Re-register CTE Agents
This stage migrates CTE clients.
CDSPaaS supports CTE Agent for Windows 7.6.0-132 and above, CTE Agent for Linux 7.6.0-134 and above, and CTE Agent for AIX 7.7.0-36 and above. Each CDSPaaS service supports up to 50 clients. We recommend up to 100 guardpoints per client. Contact Thales to set up deployments with more than 50 clients or more than 5000 guardpoints.
Log on to the CipherTrust Data Security Platform Service Web UI as a member of the
admins
orClient Admins
group.In the left pane, click Access Management > Registration Tokens.
On the right, click Add Registration Token. The Create New Registration Token wizard is displayed. This is a three-step wizard.
Click Begin to start token creation. The Configure Token screen is displayed.
(Optional) Specify a Name Prefix. Prefix for the client name. This prefix is used to construct names for clients whose names are not specified during registration with the CipherTrust Data Security Platform Service using this token.
If the name prefix is specified as
ks_client
, client names will be constructed asks_client#
; for example,ks_client1
,ks_client2
,ks_client3
, and so on.If the name prefix is not specified, the CipherTrust Data Security Platform Service will construct a random name for clients.
However, if a client's name is specified during registration, this name prefix will not be used for that client.
Specify Token lifetime. This is the duration (in minutes, hours, or days) for which this token can be used for registering clients. For example, specify the lifetime as:
1 minutes
for 1 minute2 hours
for 2 hours3 days
for 3 daysunlimited
for a token that never expires.
By default, the token lifetime is
unlimited
. The token will never expire.Specify Client Capacity. This is the maximum number of clients that can be registered using this registration token. The default capacity is
100
clients.Click Create Token. The Create Token screen is displayed. The screen displays the generated registration token in ASCII and Base64 encoding. Select ASCII encoding.
Click Copy next to the token. Save the copied token. This token will be used when registering and migrating clients.
Click Close.
Re-register the client as outlined in Installing and Registering CTE in CTE Agent documentation. You must provide the new registration token, and the hostname of the CipherTrust Data Security Platform Service.
On the CipherTrust Data Security Platform Service, re-create the guardpoints using the migrated policies.
Handling Conflicting Resources
If you attempt to migrate resources which already exist with the same name in the CipherTrust Data Security Platform Service, the CipherTrust Data Security Platform Service uses these strategies:
Strategy | Description | Resource Type |
---|---|---|
Error | An error, "Error copying data from backup database" is thrown during restore. | Keys with the same name and version, different ID |
Skip | Skips the conflicting resource in the backup file, and keeps the resource present in the CipherTrust Data Security Platform Service. | CTE policies with the same name |
There are two options to migrate conflicting keys:
Retain both keys.
Take the backup without the conflicting key using filters.
Export the key material and import it separately.
Retain only the key in the backup file.
Delete the key with duplicate name on the CipherTrust Data Security Platform Service.
Restore the backup.
To migrate conflicting CTE policies, delete the CTE policy on the CipherTrust Data Security Platform Service before restoring the backup.