Your suggested change has been received. Thank you.

close

Suggest A Change

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

Thales Logo

All

  • All
back

Azure Resources

Managing Azure Keys

search

Managing Azure Keys

This section describes how to manage Azure keys on CCKM. Before proceeding, you must have an Azure key vault added to the CCKM. Refer to Managing Azure Vaults for details.

Adding Azure Keys

CCKM provides two methods to add Azure keys:

Creating/Uploading New Key Material

To add an Azure key by creating/uploading new key material:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure.

  3. Click Add Key. The Select Material Origin screen of the Add Azure Key wizard is displayed.

  4. Under Select Method, select Create/Upload New Key Material. The Select Source section appears. Depending on your requirements, select from the following:

Uploading CipherTrust (Local) Key Material

Upload the local key material using CipherTrust to configure source key.

Select Material Origin

  1. Select CipherTrust (Local).

  2. Click Next. The Configure Source Key screen is displayed.

Configure CipherTrust (Local) Key

  1. Enter a Key Name.

  2. Select the Key Size from the available options. The supported sizes are 2048, 3072, and 4096.

  3. Click Next.

Configure Destination (Azure) Key

  1. Enter a user-friendly alias as the Azure Key Name. This helps uniquely identify a key. By default, the Key Name specified on the previous screen is populated.

  2. Select the desired Vault from the drop-down list. The list shows the available Azure key vaults with their types specified in parenthesis. The Azure key vault types are Standard, Premium, and ManagedHSM.

  3. Select the Key Type.

    • For a standard vault, the key type is RSA.

    • For vaults inside an Azure Managed HSM pool, the key type is RSA HSM.

    • For a premium vault, the key type can be RSA or RSA HSM.

  4. (Optional) Set the key activation and expiration dates.

    • Select the Set Activation Date check box and from the on-screen calendar, select the date and time to activate the key.

    • Select the Set Expiration Date check box and from the on-screen calendar, select the key expiration date and time.

  5. (Optional) Select the Enable Key check box.

  6. Select the Key Attributes. The supported attributes are:

    • Encrypt, Decrypt, Sign

    • Verify, Wrap Key, Unwrap Key

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

    To add a tag:

    1. Specify a tag name.

    2. Specify the tag value.

      • CCKM allows the following characters in tag values:

        • Alphanumeric characters

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

    3. Click the + button.

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

  8. Click Next.

Review and Add

This screen shows the key details that you have provided. These details are divided into MATERIAL ORIGIN, SOURCE KEY, DESTINATION KEY, and KEY SCHEDULES sections.

Before adding the key, review all details. After the key is added, certain features will no longer be editable.

  1. Review the key details displayed on the screen.

    If details are incorrect or you want to make any changes, click Edit next to the SOURCE KEY, DESTINATION KEY, and KEY SCHEDULES sections and update details. Alternatively, click Back and make changes, as appropriate.

  2. Click Add Key.

    The key creation starts. A Create Key In Progress message is displayed on the screen. Leave the window open until the process is completed.

    When the status next to the SOURCE KEY, DESTINATION KEY and KEY SCHEDULES sections becomes Complete and the Key ID links are displayed, the key is created successfully.

  3. Click Close. The Add Azure Key wizard is closed.

The newly created key is displayed in the list of Azure keys. The origin of the key is CCKM.

Creating Microsoft Azure (Native) Key Material

Create the Azure key material directly using the native Microsoft Azure application.

Select Material Origin

  1. Select Microsoft Azure (Native).

  2. Click Next. The Configure Source Key screen is displayed.

Configure Source Key

  1. Enter a user-friendly alias as the Azure Key Name. This helps uniquely identify a key.

  2. Select the desired Vault from the drop-down list. The list shows the available Azure key vaults with their types specified in parenthesis. The Azure key vault types are Standard, Premium, and ManagedHSM.

  3. Select the Key Type.

    • For a standard vault, the key type can be RSA or Elliptic Curve.

    • For vaults inside an Azure Managed HSM pool, the key type can be RSA HSM or Elliptic Curve HSM.

    • For a premium vault, the key type can be Elliptic Curve, Elliptic Curve HSM, RSA, or RSA HSM.

  4. (Applicable to RSA or RSA HSM key types) Select Size from the following options: 2048, 3072, and 4096.

  5. (Applicable to Elliptic Curve or Elliptic Curve HSM key types) Select Curve from the following options: P-256, P-384, P-521, and SECP256K1.

  6. (Optional) Set the key activation and expiration dates.

    • Select the Set Activation Date check box and from the on-screen calendar, select the date and time to activate the key.

    • Select the Set Expiration Date check box and from the on-screen calendar, select the key expiration date and time.

  7. (Optional) Select the Enable Key check box.

  8. Select the Key Attributes.

    If the Key Type is RSA or RSA HSM, the supported attributes are:

    • Encrypt, Decrypt, Sign

    • Verify, Wrap Key, Unwrap Key

    If the Key Type is Elliptic Curve or Elliptic Curve HSM, the supported attributes are:

    • Sign

    • Verify

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

    To add a tag:

    1. Specify a tag name.

    2. Specify the tag value.

      • CCKM allows the following characters in tag values:

        • Alphanumeric characters

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

    3. Click the + button.

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

  10. Click Next.

Review and Add

This screen shows the key details that you have provided. These details are divided into MATERIAL ORIGIN, NATIVE KEY and KEY SCHEDULES sections.

Before adding the key, review all details. After the key is added, certain features will no longer be editable.

  1. Review the key details displayed on the screen.

    If details are incorrect or you want to make any changes, click Edit next to the NATIVE KEY and KEY SCHEDULES section and update details. Alternatively, click Back and make changes, as appropriate.

  2. Click Add Key.

    The key creation starts. A Create Key In Progress message is displayed on the screen. Leave the window open until the process is completed.

    When the status next to the NATIVE KEY and KEY SCHEDULES sections becomes Complete and the Key ID link is displayed, the key is created successfully.

  3. Click Close. The Add Azure Key wizard is closed.

The newly created key is displayed in the list of Azure keys. The origin of the key is Native.

Cloning Existing Key Material

To add a new Azure key by cloning existing key material:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure.

  3. Click Add Key. The Select Material Origin screen of the Add Azure Key wizard is displayed.

  4. Under Select Method, select Clone Existing Key Material. The Select Source section appears. Depending on your requirements, select from the following:

Cloning CipherTrust (Local) Key Material

Upload the local key material using CipherTrust to configure source key.

Select Material Origin

  1. Select CipherTrust (Local).

  2. Click Next. The Select CipherTrust Key screen is displayed.

Select CipherTrust (Local) Key

  1. Select the desired key from the Key Name drop-down list. This field contains the available local CipherTrust Manager keys.

  2. Click Next. The Configure Destination (Azure) Key screen is displayed.

Configure Destination (Azure) Key

  1. Enter a user-friendly alias as the Azure Key Name. This helps uniquely identify a key.

  2. Select the desired Vault from the drop-down list. The list shows the available Azure key vaults with their types specified in parenthesis. The Azure key vault types are Standard, Premium, and ManagedHSM.

  3. Select the Key Type.

    • For a standard vault, the key type is RSA.

    • For a premium vault, the key type can be RSA or RSA HSM.

  4. (Optional) Set the key activation and expiration dates.

    • Select the Set Activation Date check box and from the on-screen calendar, select the date and time to activate the key.

    • Select the Set Expiration Date check box and from the on-screen calendar, select the key expiration date and time.

  5. (Optional) Select the Enable Key check box.

  6. Select the Key Attributes. The supported attributes are:

    • Encrypt, Decrypt, Sign

    • Verify, Wrap Key, Unwrap Key

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

    To add a tag:

    1. Specify a tag name.

    2. Specify the tag value.

      • CCKM allows the following characters in tag values:

        • Alphanumeric characters

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

    3. Click the + button.

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

  8. Click Next. The Add to Schedule screen is displayed.

Add to Schedule

  1. Select Rotation Schedule.

  2. Select the Key Origin from the available options. The key origin can be:

    • CipherTrust: CipherTrust Manager.

    • Native (Azure): Native Microsoft Azure application. Also select the Key Type - RSA or EC.

    • Luna: HSM Luna. Also select a Partition.

    • DSM: Vormetric Data Security Manager. Also select a Domain.

  3. Select a Key Size.

    Note

    When the key origin is native Azure, select a curve for Elliptic Curve or Elliptic Curve HSM key types.

  4. (Optional) Select the Enabled check box to enable the key.

  5. Click Next.

The Review and Add screen is displayed.

Review and Add

This screen shows the key details that you have provided. These details are divided into MATERIAL ORIGIN, SOURCE KEY, DESTINATION KEY, and KEY SCHEDULES sections.

Before adding the key, review all details. After the key is added, certain features will no longer be editable.

  1. Review the key details displayed on the screen.

    If details are incorrect or you want to make any changes, click Edit next to the SOURCE KEY, DESTINATION KEY, and KEY SCHEDULES sections and update details. Alternatively, click Back and make changes, as appropriate.

  2. Click Add Key.

    The key creation starts. A Create Key In Progress message is displayed on the screen. Leave the window open until the process is completed.

    When the status next to the DESTINATION KEY and KEY SCHEDULES section becomes Complete and the Key ID link is displayed, the key is created successfully.

  3. Click Close. The Add Azure Key wizard is closed.

The newly created key is displayed in the list of Azure keys. The origin of the key is CCKM.

Viewing Azure Keys

Search for Azure keys by Key Name, Key Vault, or Tags.

CCKM does not allow searching for keys:

  • By tag values using colon (:)

  • By "key:value" pair using these characters:

    \ , : " %

To view an Azure key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed. The Azure Keys page displays the following details:

    Field Description
    Key Name Unique, user-friendly alias of the key. This is useful in searching for specific keys.
    Current Version Current version of the key. Click the expand icon (expand icon) corresponding to a key to view its versions.
    Key Vault Name of the Azure key vault.
    Region Azure region where the key is created. Click the filter icon (filter) to view the list of supported Azure regions.
    Status State of the key. The status can be:
    • Available
    • Soft Deleted
    • Deleted
    Algorithm Name of the algorithm. Supported algorithms are:
    • EC
    • RSA
    • EC-HSM
    • RSA HSM
    Origin Source of the key material. The origin of the key can be:
    • CCKM: Key material is created on CCKM.
    • Native: Key material is created on the cloud.
    • External (Unknown): Source of the key material is unknown. It is different than CCKM and the native cloud.
    Cloud Name of the cloud. Supported clouds are:
    • Azure Cloud
    • Azure China Cloud
    • Azure German Cloud
    • Azure US Government
    • Azure Stack
    Creation Date Time when the key is created.

Sometimes, you might notice certain keys are displayed as grayed out. This happens when the keys are no longer accessible. For example, when:

  • Any cloud permissions on the keys are changed. The keys are no longer accessible from the Azure connection.

  • Connection is changed in KMS. The new connection does not have permissions to access the keys.

Editing Azure Keys

To view or edit an Azure key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired alias and click View/Edit.

  4. Configure the KEY SCHEDULES. Refer to KEY SCHEDULES for details.

KEY SCHEDULES

To configure the key schedules, go to the KEY SCHEDULES section and select/enter the following details:

  1. From the Select Rotation Schedule drop-down list, select a rotation schedule.

  2. Select the key origin. The available options are CipherTrust (Local), and Native (Azure).

    Click the desired tab to view the instructions.

    1. Select the Key Type. The available options are RSA and RSA-HSM.

    2. Select the Key Size. The available options are 2048, 3072, and 4096.

    1. Select the Key Type. The available options are RSA, EC, RSA-HSM, and EC-HSM.

    2. select the Elliptical Curve Name. The available options are P-56, P-384, P-521, and SECP256K1.

  3. Select Enabled if you want to enable the rotated key.

  4. Click Update.

A message Key schedule updated successfully is displayed on the screen.

Refreshing Azure Keys

Refreshing is the process of downloading keys created on the Azure key vault to CCKM. Keys from all key vaults are refreshed at once.

To refresh keys:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure.

  3. Click the Keys tab. The list of available Azure keys is displayed.

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

    Note

    Refresh is a time intensive operation that could take several hours or days to complete. It will continue running in the background. Do you want to continue?

  5. Click Refresh to continue.

A message Refresh started... is displayed on the screen. The refreshed keys are listed on the Cloud Keys > Azure > Keys tab.

To cancel the refresh:

  1. Click Cancel Refresh. The Cancel Refresh? message is displayed. The action will terminate all currently active refresh operations. All progress will be lost and this action cannot be undone. Do you want to proceed to cancel refresh or cancel this action?

  2. Click Cancel Refresh.

A message Canceled Refresh is displayed on the screen.

Rotating Keys (Add Version)

Note

To rotate Azure keys, CCKM Users require Add Key and Upload Key permissions.

To rotate a key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired alias and click Rotate Now (Add Version). The Add New Version screen is displayed.

  4. Select Key Material Origin. Depending on your requirements, select an appropriate option. Refer to the following sections for details:

A message Azure Key successfully rotated is displayed on the screen. Navigate to Cloud Keys > Azure > View/Edit > Versions to view the versions of the rotated Azure key.

Deleting Azure Keys

Non-soft-delete keys can be deleted directly from the Azure vaults using CCKM.

To delete an Azure key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired alias and click Delete. The Confirm Delete dialog box is displayed.

  4. Click Delete.

A confirmation message is displayed on the screen. The key status changes to DELETED.

Soft-Deleting Azure Keys

Soft deleting is the process of deleting Azure keys from the Azure vaults and CCKM. These keys still exist on CCKM and in the Azure vaults. The soft-deleted keys can be recovered.

Note

This operation can be performed only on the Azure keys residing in the soft-enabled key vaults.

To soft-delete an Azure key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired alias and click Soft Delete. The Confirm Soft Delete dialog box is displayed.

  4. Click Soft Delete.

A message key <key name> soft-deleted is displayed on the screen. The status of the key changes to SOFT-DELETED.

Recovering Soft-Deleted Azure Keys

If needed, you can recover a soft-deleted key.

To recover a soft-deleted Azure key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired alias and click Recover Soft Delete. The Confirm Recover Key dialog box is displayed.

  4. Click Recover Key.

A message Key <key name> recovered from soft-delete. is displayed on the screen. The status of the key changes to AVAILABLE.

Purging Azure Keys

Purging is the process of permanently deleting soft-deleted Azure keys from the Azure vaults. However, backup of the purged key can be restored on CCKM. If you wish to restore backup of the purged key, follow the steps mentioned in the Restoring Backup section.

Note

This operation can be performed only on the soft-deleted Azure keys residing in the soft-enabled key vaults.

To purge an Azure key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired alias and click Purge. The Purge Azure Key dialog box is displayed.

  4. Select the I wish to purge this key. check box.

  5. Click Purge Key.

Purging a key might take some time. After successful deletion, a message key <key name> hard deleted is displayed on the screen. The status of the key changes to DELETED.

If needed, you can restore a purged key from its backup. Refer to Restoring Backup for details.

Restoring Backup

To restore a purged Azure key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired alias and click Restore Backup. The Confirm Restore Key dialog box is displayed.

  4. Select the desired key vault from the Select Vault drop-down list.

    Note

    Restoration of keys among cross-region vaults is not allowed.

  5. Click Restore Key.

A message Key <key name> restored is displayed on the screen. The key is restored to the selected key vault. The key status changes to AVAILABLE.

Deleting Backup

Deleting a backup permanently removes the backup of a deleted Azure key from CCKM.

Note

This operation can be performed only on keys with a DELETED status. You can delete or purge keys to change their status to DELETED.

To delete the backup of an Azure key from CCKM:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired alias and click Delete Backup. The Hard Delete Azure Key dialog box is displayed.

  4. Select the I wish to delete the backup of this key. check box.

  5. Click Delete Key Backup.

A message Key <key name> backup deleted is displayed on the screen. The backup of the key is permanently deleted from CCKM.

Downloading Keys and Versions

Asymmetric RSA/RSA-HSM keys and their older versions with the status AVAILABLE can be downloaded to your local machines. Other keys cannot be downloaded.

Downloading Keys

To download an AVAILABLE asymmetric RSA/RSA-HSM key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the overflow icon (ellipsis) corresponding to the desired key and click Download Key. The key is downloaded.

Downloading Key Versions

To download an older version of an AVAILABLE asymmetric RSA/RSA-HSM key:

  1. Open the Cloud Key Manager application.

  2. In the left pane, click Cloud Keys > Azure. The list of available Azure keys is displayed.

  3. Click the expand icon (expand) corresponding to the desired key. The Older Versions are displayed.

  4. Click the overflow icon (ellipsis) corresponding to the desired key version and click Download Key. The key version is downloaded.

Alternatively, click the key link under the Key Name field to view the key details. Scroll down to the VERSIONS section.

On this page