Welcome to the Fortanix Data Security Manager (DSM) and Azure Key Vault (AKV) Bring Your Own Key (BYOK) User Guide. This document describes how to perform BYOK lifecycle management in AKV using Fortanix DSM.
The Fortanix solution for AKV offers complete Bring Your Own Key (BYOK), as explained in this article, as well as Cloud Native Key Management (CNKMS) with complete lifecycle management for automation.
2.0 Getting Started with Fortanix Cloud Data Control
To understand which solution between CNKMS, BYOK, or Bring Your Own Encryption (BYOK) is right for you, please see Fortanix Data Security Manager Cloud Data Control Getting Started Guide.
3.0 Fortanix AWS BYOK Workflows Overview
- Generate key: Navigate to a source key in Fortanix DSM and copy the key into a Azure CDC group to create a linked key and a BYOK key in Azure Key Vault.
- Rotate source key: Rotate the source key that was originally generated in "Fortanix DSM" and click “rotate linked/copied keys”.
- Disable/Enable: Navigate to the detailed view of the key in the Azure CDC group and disable or enable it from Fortanix DSM.
- Soft delete a key: Navigate to the detailed view of an Azure virtual key and in the AZURE KEY DETAILS tab click the link SOFT DELETE KEY.
4.0 Fortanix Data Security Manager Azure KMS Security Objects
You can generate a key in a configured Azure KMS (Software-backed or HSM-backed Key Vault).
4.1 Bring Your Own Key - Copy Key to Azure Key Vault
Use this option when you want to generate a key in Fortanix DSM and then import the key into the configured Azure Key Vault. The copy key to the Azure feature will copy a security object from one regular Fortanix DSM group to another regular/Azure KMS Fortanix DSM group. This feature has the following advantages:
- Maintains a single source of key material while using/importing that key into various Fortanix DSM groups where applications may need to use a single key to meet business objectives.
- Maintains a link of various copies of the same key material to the source key for audit and tracking purposes.
The following actions will happen as part of the copy key operation:
- A new key will be created in the target group: The new key will have the same key material as the original.
- The source key links to the copied keys: There will be a link maintained from all copied keys to the source key.
- The Source key will also have basic metadata-based information about the linked keys such as:
- Copied by <user-name/app id>
- Date of Copy <time stamp>
- Target copy group name
To copy a key from a regular Fortanix DSM group to an Azure CDC group:
- Generate an RSA or EC key in Fortanix DSM, if the key is not already present.
- Go to the detailed view to a key and click the NEW OBJECT icon on the far right of the screen.
- In the menu that appears, click the COPY KEY button.
- In the COPY KEY window, update the name of the key if required using the edit icon.
- Click Import key to HSM/External KMS check box to filter the groups to show only HSM/AWS KMS/Azure KMS groups. Select the Azure CDC group for the new key into which the copied key should be imported.
- If the key vault associated with the Azure CDC group is a Premium key vault, then in the Create key as section, select Software protected or Hardware protected. For the Standard key vault, the key is created as software-protected by default.
- Enter the Azure key name.
- Update KEY PERMISSIONS if you want to modify the permissions of the key.
- Click CREATE COPY to create a copy of the key as shown in the figure above.
- The source key will now appear as a key link in the KEY LINKS tab in the detailed view of the copied key.
4.2 Bring Your Own Key - Import Key
This action will import the configured key type in the software-backed Azure Key Vault directly, and it will be represented as a virtual key in the corresponding Azure CDC group. This means that the virtual key in the Azure CDC group will point to the actual key in the Azure Key Vault that stores the key material of this new key. The virtual key only stores the key information and key attributes, but it does not have the key material. The import action will not store a copy of the key material in Fortanix DSM.
- Click the Security Objects tab.
- Click to create a new Security Object.
- In the Add New Security Object form enter a name for the Security Object (Key).
- Select the This is an HSM/external KMS object check box. This will show the AWS CDC configured groups in the Select group list.
- In the AWS group list, select the Azure CDC group into which the keys will be generated. The keys will be generated into the region that was selected in the Azure CDC group.
- Select IMPORT to initiate the import key in Azure workflow.
- If the key vault associated with the Azure group is a Premium key vault, then in the Create key as section, select Software protected keys or Hardware protected keys. For the Standard key vault, the key is created as software-protected by default.
- Enter the Azure key name.
- Select the key type for the new Azure KMS key.
- Sometimes keys of type RSA that need to be imported from a file were previously wrapped (encrypted) by a key from Fortanix DSM. This is done so that the key should not go over the TLS in plain text format. In such scenarios select the check box The key has been encrypted.
- Next enter or select a Key ID or SO name in the Select Key Encryption Key section which will be used to unwrap (decrypt) the encrypted key in the file which will later be stored securely in Fortanix DSM. This key should have already been created or imported into Fortanix DSM.
- Click UPLOAD A FILE to upload the key file in Raw, Base64, or Hex format.
- Enter the key Expiration Date and key Activation Date.
- Select the permitted key operations and any key tags if required using ADD TAG.
- Click IMPORT to import the key.
- The key is successfully imported.
4.3 Sync Keys
When you edit the Azure Key Vault connection details in the Azure CDC group detailed view under HSM/KMS tab, click SYNC KEYS to import new keys. On clicking SYNC KEYS, Fortanix DSM connects to Azure Key Vault and gets all the keys available. Fortanix DSM then stores them as virtual keys.
4.4 Attributes/Tags Tab
This tab will have all the tags of the software-backed Azure key. You can add new tags using the NEW TAG button.
4.5 Azure Key Details
This tab displays details of the Azure key properties such as Resource ID and Key version number.
The AZURE KEY DETAILS tab also contains SOFTDELETE KEY option, which is explained in Section 4.8.
4.6 Security Objects Table View
After you add new Azure keys, go to the Security Objects page to view all the security objects from all the groups (Regular and HSM/External KMS).
In the security object table, you will notice that every key belongs to a group and some keys which are virtual keys added from an Azure Key Vault, belongs to a group with a special symbol . The security objects table view will continue to show all the keys irrespective of if they belong to an Azure KMS group or not.
4.7 Deactivate a Key in Azure CDC Group
When you deactivate an Azure key in Fortanix DSM, the action will deactivate the virtual key in Fortanix DSM and the actual key in the configured Azure Key Vault KMS will be disabled.
To deactivate a key:
- Select the Azure key to deactivate.
- In the security object detailed view, scroll down, and click the DEACTIVATE button.
4.8 Soft-Delete a Key in Azure Key Vault
Soft delete deletes a key from an Azure Key Vault which was already scanned in the Azure KMS Group in Fortanix DSM with a link to recover this key. Now, when you click SYNC KEYS in Fortanix DSM:
- The status of the key in the Azure KMS group will become “soft-deleted in Azure”.
- The key can only be recovered for a retention period set in the key vault.
- If you choose to recover this key, the virtual key will become active as well as the actual key will become active in the Azure Key Vault.
- If you do not recover the key within the retention period, the Azure key vault will automatically purge and delete the key permanently.
To delete a key from Azure Key Vault:
- Go to the detailed view of an Azure KMS virtual key and select the AZURE KEY DETAILS tab.
- Click the link SOFT DELETE KEY.
- In the Soft Key Deletion in Azure Key Vault window, select the confirmation “I understand that the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations once it is deleted.”
- Click SOFT DELETE KEY button to mark the key for deletion.
- You can recover the deleted key any time before the retention period ends using the RECOVER DELETED KEY link on the top of the screen in the detailed view of the virtual key. When the “Recover Key“ link is clicked, the key will be recovered back in Azure Key Vault with all its versions.
4.9 Delete a Key in Azure CDC Group
The DELETE KEY button will be enabled when the key material has been purged in Azure. When you click DELETE KEY, Fortanix DSM will remove the key backup blob, and hence the key cannot be restored.
To delete a virtual key:
- Select the Azure key to delete.
- In the security object detailed view, scroll down and click the DELETE KEY button.
5.0 Rotate a Key In Azure CDC Group
5.1 Rotating Keys in Fortanix DSM Source Group
Prerequisites: This scenario requires creating a regular Fortanix DSM group with source keys copied to the Azure CDC group.
When a key is rotated that belongs to a Fortanix DSM source group and has linked keys that are copies of the Fortanix DSM source key with the same key material as the source key, then the user is given the option to select the linked keys for the key rotation. If these linked keys are part of an Azure CDC group, rotating the linked keys also rotates the keys in Azure Key Vault by making nested copies of the keys in the configured Azure Key Vault.
- Click ROTATE KEY in the detailed view of a Fortanix DSM Source Key.
- In the KEY ROTATION window, select the Rotate linked keys check box.
- Select the Azure Virtual Keys that need to be rotated along with the Fortanix DSM source key and click ROTATE KEY to rotate the linked key.
- Once the keys are rotated, click the OK button.
You can also schedule a key rotation policy for the Fortanix DSM source key such that the linked Azure keys that are copies of the source keys are also periodically rotated automatically.
To schedule a key rotation policy for the source key:
- Go to the detailed view of the source key in the Fortanix DSM UI.
- In the detailed view, click the KEY ROTATION tab and click the ADD POLICY button.
- Enter the key rotation schedule by specifying the rotation frequency, start date, and time.
- To deactivate the old key after key rotation, select the Deactivate original key after the rotation check box.
- To rotate the linked copied keys, select the Rotate all copied keys check box.
- Click SAVE POLICY to save the policy.
For more information on the key rotation policy, refer to the User’s Guide: Key Lifecycle Management.
5.2 Rotate Azure Native Key to Fortanix DSM Owned Key
When an Azure KMS virtual key whose key material is owned by Azure KMS is rotated, the user is given the option to rotate the virtual key with a Fortanix DSM-backed key. When the user selects this option and performs the rotation, a new virtual key is created, with the corresponding key in Azure KMS, which has the key material of the Fortanix DSM-backed key. As a result, the Azure KMS virtual key is backed by a Fortanix DSM Source key.
To rotate a virtual key with Fortanix DSM backed key:
- Click ROTATE KEY in the detailed view of an Azure virtual key.
- In the Key Rotation window, select the Rotate to DSM key check box.
- Select the Fortanix DSM group that contains the source key.
- Select the source key and click the ROTATE KEY button.
The Virtual key is successfully rotated and backed by the source key. To confirm go to the detailed view of the newly rotated Azure virtual key and click the AZURE KEY DETAILS tab. The SOURCE field now points to “FortanixHSM” instead of “External”.
For details on how to set up an Azure-backed group in Fortanix DSM, refer to the User's Guide: Fortanix DSM Azure Key Vault Setup.
For details on how to perform native key lifecycle management in Azure Key Vault using Fortanix DSM, refer to the User's Guide: Fortanix DSM Azure Key Vault Cloud Native Key Management.