Managing Azure Key Templates

An Azure Key Template is a predefined structure that enables users to repeatedly create similar types of Azure keys. Once created, it can be reused to generate new keys of the same configuration, ensuring consistency and efficiency.

This section describes how to manage Azure key templates in CCKM. Before you begin, ensure that an Azure key vault is added to CCKM. For more information, see Managing Azure Vaults.

Adding Azure Key Templates

To add an Azure key template:

1. Open the Cloud Key Manager application.

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

3. Click the Key Templates tab.

4. Click Add Template. The General Info tab of the Add Template wizard appears.

General Info

1. Enter Template Name.

2. (Optional) Enter Description.

3. (Optional) Enable Overwrite Template Attributes on Key Creation.

4. (Optional) Select a Source. The options are CipherTrust (External), CipherTrust (Local), Luna HSM, and Microsoft Azure (Native).

   Click the Clear link to clear your selection.

   (Optional) If you select CipherTrust (External) as the source, select a Domain from the drop-down list.

   (Optional) If you select Luna HSM as the source, select a Partition ID.

5. Click Next. The Configure Key tab appears.

Configure Key

The fields on the Configure Key tab are optional.

1. Select a Vault.

2. Select a Key Type.

3. Select one or more Key Attributes. The supported attributes are:

   • Encrypt, Decrypt, Sign

   • Verify, Wrap Key, Unwrap Key

4. Select the Enable Key check box.

5. (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.

6. Click Next. The Add to Schedule tab appears.

Add to Schedule

The fields on the Add to Schedule tab are optional.

1. Select Rotation Schedule.

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

   • CipherTrust (Local).

   • CipherTrust (External): Also select a Domain.

   • Native (Azure).

   • Luna: Also select a Partition.

   • None.

3. Select a Key Type.

4. Select a Key Size.

5. Select the Enable New Key check box.

6. Click Next. The Review and Add tab appears.

Review and Add

The Review and Add tab displays the details you configured for the key template, organized into the GENERAL INFO, CONFIGURE KEY, and KEY SCHEDULES sections.

Review all details before adding the template. Some settings cannot be changed after creation.

1. Review the key template details displayed on the screen.

   If details are incorrect or you want to make changes, click Edit next to the GENERAL INFO, CONFIGURE KEY, or KEY SCHEDULES sections to update the details. Alternatively, click Back to make changes.

2. Click Create Template.

   A "Key template has been created successfully" message appears.

3. Click Close. The Add Template wizard closes.

The new key template appears in the list of Azure key templates.

Viewing Azure Key Templates

Search for Azure key templates by Template Name.

To view an Azure key template:

1. Open the Cloud Key Manager application.

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

3. Click the Key Templates tab. The list of available Azure key templates appears. The Azure Key Templates page displays the following details:

   Field	Description
   Template Name	The unique, user-friendly name of the key template.
   Overwrite Template	Specifies if template attributes can be overwritten when a key is created. The options are Yes and No.
   Creation Date	The date and time when the template was created.
   Last Modified	The date and time when the template was last updated.
   Description	The description for the key template.

Editing Azure Key Templates

To view or edit an Azure key template:

1. Open the Cloud Key Manager application.

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

3. Click the Key Templates tab. The list of available Azure key templates appears.

4. Click the overflow icon () next to the desired key template and click View/Edit. Alternatively, click the key template name link. The edit view appears, which is divided into the GENERAL INFO, KEY CONFIGURATION, and KEY SCHEDULES sections.

Updating General Info

To update the general information:

1. Expand the GENERAL INFO section.

2. Update the following details as needed:

   • Description

   • Overwrite Template Attributes on Key Creation

   • Source

3. Click Update.

Updating Key Configuration

To update the key configuration:

1. Expand the KEY CONFIGURATION section.

2. Update the following details as needed:

   • Vault

   • Key Type

   • Key Size

   • Key Attributes

   • Select the Enable Key check box.

   • (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.

3. Click Update.

Updating Key Schedules

To update the key schedules:

1. Expand the KEY SCHEDULES section.

2. Update the following details as needed:

   • Rotation Schedule

   • Key Origin

   • Key Type

   • Key Size

   • Select the Enable New Key check box.

3. Click Update.

Deleting Azure Key Templates

To delete an Azure key template:

1. Open the Cloud Key Manager application.

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

3. Click the Key Templates tab. The list of available Azure key templates appears.

4. Click the overflow icon () next to the desired key template, and then select Delete. The Delete Template dialog box appears.

5. Click Delete Template.

When the template is successfully deleted, a confirmation message appears.