Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo
back

External CipherTrust Resources

Managing External CipherTrust Keys

search

Please Note:

Managing External CipherTrust Keys

This section describes how to manage CipherTrust keys or CipherTrust (External) keys on CCKM. Before proceeding, you must have an CipherTrust domain added to the CCKM. Refer to Managing CipherTrust Domains for details.

Adding CipherTrust (External) Keys

To add a CipherTrust (External) key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > CipherTrust. The list of available CipherTrust (External) keys is displayed.

  3. Click Add Key. The Add CipherTrust (External) Key screen of the Add CipherTrust (External) Key wizard is displayed.

Add CipherTrust (External) Key

  1. Select Domain for the key. The key will be added to this domain.

  2. (Optional) Enter the Key Name. This helps in uniquely identifying a key.

  3. Select the key Algorithm. The algorighm can be AES (default), TDES, RSA, Elliptic Curve, HMAC-SHA1, HMAC-SHA256, HMAC-SHA384, and HMAC-SHA512.

  4. Select the Key Size or Curve.

    Note

    If the algorithm is not Elliptic Curve, select the Key Size. If the algorithm is Elliptic Curve, select the Curve.

  5. (Optional) Select the Key Attributes. The supported attributes are Exportable and Deletable.

  6. (Optional) Select the Key Usage(s).

  7. (Optional) Enter KMIP Mask Shorthand.

  8. (Optional) Enter Labels. A label is a label assigned to the key that consists of a user-defined key and a value.

    To add a label:

    1. Specify a label name.

    2. Specify the label value.

      • CCKM allows the following characters in label values:

        • Alphanumeric characters

        • Special characters ** ! @ # $ % ) ( { } > < ? + - / \ [ ] ^ & + = | ~ ` , ; . ' " _ **

      • CCKM does not allow the colon (:) in label values.

    3. Click the + button.

    Similarly, you can add more labels. To remove a label, click the close (X) icon in the label name.

  9. Click Next. The Review and Add screen is displayed. This screen shows the key details.

    Tip

    Before adding the CipherTrust (External) key, it is recommended to review its details. After the key is added, its certain features cannot be edited.

Review And Add

  1. Review the key details. If the key requires any changes, click the Back link and modify the details.

  2. Click Save.

    After the key is created successfully, a success message Key added successfully. is displayed.

  3. Click Close.

The newly created key is displayed in the keys list.

Note

<!---Creation of an CipherTrust (External) key fails if:
• The selected CipherTrust domain is full. If the key creation fails, ensure enough free disk space is available on the domain and retry the key creation.
• The external CM user credentials are incorrect or the password has expired. Check the credentials or reset the user password, as appropriate, test the connection, and retry the key creation.
• The CipherTrust domain admin is different from the external CM admin used for creating the external CM connection.

-->

Viewing CipherTrust (External) Keys

The CipherTrust (External) Keys page displays the available CipherTrust (External) keys. Search for CipherTrust (External) keys by Key Name or UUID (Universally Unique Identifier) of the key.

To view a CipherTrust (External) key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > CipherTrust. The CipherTrust (External) Keys page displays following details:

    FieldDescription
    Key NameName of the CipherTrust (External) key. Click to view details of keys. Refer to Viewing CipherTrust (External) Keys for details.
    StatusState of the Google Cloud key. The status can be:
    • Active
    • Pre-Active
    • Deactivated
    • Destroyed
    • Compromised
    • Destroyed Compromised
    • Deleted
    VersionVersion of the CipherTrust (External) key.
    OwnerOwner of the CipherTrust (External) key.
    Creation DateTime when the key is added to CCKM.
    TypeType of the CipherTrust (External) key - Symmetric, Public, or Private.
    AlgorithmAlgorithm of the CipherTrust (External) key. The algorighm can be:
    • AES
    • TDES
    • RSA
    • Elliptic Curve
    • HMAC-SHA1
    • HMAC-SHA256
    • HMAC-SHA384
    • HMAC-SHA512.
    SizeSize of the CipherTrust (External) key.
    DomainID of the CipherTrust domain where the key is created.
    Click on the ID to view the details of the domain.

To hide/display columns, click the Customize View (Custom View) icon, select or clear the desired check boxes, and click OK.

Viewing or Editing Details of CipherTrust Keys

To view or edit a CipherTrust key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > CipherTrust. The list of available CipherTrust (External) keys is displayed.

  3. Click the overflow icon (Overflow Icon) corresponding to the desired key and click View/Edit Details. Alternatively, you can click the key name link. The edit view of the key is displayed. The edit view is divided into:

Updating General Info

  1. Expand the GENERAL INFO section, if needed.

  2. Add or update the following details.

    1. Key Attributes

    2. Key Usages

    3. KMIP Mask Shorthand

    4. Labels.

      To add a label:

      1. Specify a label name.

      2. Specify the label value.

        • CCKM allows the following characters in label values:

          • Alphanumeric characters

          • Special characters ** ! @ # $ % ) ( { } > < ? + - / \ [ ] ^ & + = | ~ ` , ; . ' " _ **

        • CCKM does not allow the colon (:) in label values.

      3. Click the + button.

      Similarly, you can add more labels. To remove a label, click the close (X) icon in the label name.

    5. Key Metadata

  3. Click Update.

Adding and Updating Dates

  1. Expand the DATES section.

  2. Add or Update Deactivation Date.

  3. Add or Update Protect Start Date.

  4. Add or Update Protect Stop Date.

  5. Click Update.

Viewing Key Version Details

To view the details of key versions, expand the KEY VERSIONS section. The list of key versions with their details are displayed:

FieldDescription
VersionVersion of the CipherTrust (External) key.
ID
StatusState of the Google Cloud key. The status can be:
• Active
• Pre-Active
• Deactivated
• Destroyed
• Compromised
• Destroyed Compromised
• Deleted
Exportable
Deletable
Never Exported
Never Exportable
CreatedTime when the version is created.
ModifiedTime when the version is modified.

Refreshing CipherTrust (External) Keys

Refreshing is the process of downloading keys from configured CipherTrust domains and updating their details on the CCKM GUI. You can refresh keys of all domains at once.

To refresh keys of all domains:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > CipherTrust. The list of available CipherTrust (External) keys is displayed.

  3. Click Refresh All. The This may take a while... message is displayed.

    Note

    Refreshing all CipherTrust domains is a time intensive operation that could take several hours or days to complete. It will continue running in the background.

  4. Click Refresh All to continue.

A message Refresh started... is displayed on the screen. To cancel the refresh, click Cancel Refresh.

The refreshed keys are listed on the Cloud Keys > CipherTrust > CipherTrust Keys page.

Adding a Key Version

To add a new key version:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > CipherTrust. The list of available CipherTrust (External) keys is displayed.

  3. Click the overflow icon (Overflow Icon) corresponding to the desired key.

  4. Click Add Version. The Add Version dialog box is displayed.

  5. Click Yes, Add Version. A success message Version added successfully. is displayed.

A new version is added to the key. The Version Count increases by one on the CipherTrust (External) keys page.

Deleting CipherTrust (External) Keys

To delete a CipherTrust (External) key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > CipherTrust. The list of available CipherTrust (External) keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired key.

  4. Click Delete. The Delete Key dialog box is displayed.

  5. Click Delete Key.

A success message Delete is in progress is displayed. It may take some time to reflect the changes. After a key is deleted, its status becomes Deleted on the CipherTrust (External) Keys page.

Deleting a Key Version

To delete a key version:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > CipherTrust. The list of available CipherTrust (External) keys is displayed.

  3. Click the Key Name link of the desired key.

    Alternatively, click the overflow icon (ellipsis) corresponding to the desired key and click View/Edit.

  4. Expand VERSIONS.

  5. Click the overflow icon (ellipsis) corresponding to the desired key version.

  6. Click Delete. The Delete Version dialog box is displayed.

  7. Click Delete Key Version.

A success message Version deleted successfully. is displayed. After a key version is deleted, its status becomes Deleted.

On this page