Skip to content

Commit 2e2cafc

Browse files
authored
Merge pull request #2 from msmbaldwin/akv-new-byok
Agree with proposed revisions
2 parents 0edddc7 + b4727a7 commit 2e2cafc

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

articles/key-vault/hsm-protected-keys-vendor-agnostic-byok.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,18 @@ ms.author: ambapat
1616
# Import HSM-protected keys to Key Vault (preview)
1717

1818
> [!NOTE]
19-
> This feature is currently in preview and only available in **East US 2 EUAP** and **Central US EUAP** regions.
19+
> This feature is in preview and only available in **East US 2 EUAP** and **Central US EUAP** regions.
2020
21-
For added assurance, when you use Azure Key Vault, you can import or generate keys in hardware security modules (HSMs) that never leave the HSM boundary. This scenario is often referred to as *bring your own key*, or BYOK. Azure Key Vault uses nCipher nShield family of HSMs (FIPS 140-2 Level 2 validated) to protect your keys.
21+
For added assurance when using Azure Key Vault, you can import or generate keys in hardware security modules (HSMs) that never leave the HSM boundary. This scenario is often referred to as *bring your own key*, or BYOK. Azure Key Vault uses nCipher nShield family of HSMs (FIPS 140-2 Level 2 validated) to protect your keys.
2222

2323
Use the information in this topic to help you plan for, generate, and then transfer your own HSM-protected keys to use with Azure Key Vault.
2424

25-
This functionality is not available for Azure China 21Vianet.
26-
This import method is only available for [supported HSMs](#supported-hsms).
27-
28-
2925
> [!NOTE]
30-
> For more information about Azure Key Vault, see [What is Azure Key Vault?](key-vault-overview.md)
31-
> For a getting started tutorial, which includes creating a key vault for HSM-protected keys, see [What is Azure Key Vault?](key-vault-overview.md).
26+
> This functionality is not available for Azure China 21Vianet.
27+
>
28+
> This import method is only available for [supported HSMs](#supported-hsms).
29+
30+
For more information about Azure Key Vault, see [What is Azure Key Vault?](key-vault-overview.md) For a getting started tutorial, which includes creating a key vault for HSM-protected keys, see [What is Azure Key Vault?](key-vault-overview.md).
3231

3332
## Overview
3433

@@ -72,7 +71,7 @@ You will use the following steps to generate and transfer your key to an Azure K
7271
* [Step 3: Generate and prepare your key for transfer](#step-3-generate-and-prepare-your-key-for-transfer)
7372
* [Step 4: Transfer your key to Azure Key Vault](#step-4-transfer-your-key-to-azure-key-vault)
7473

75-
## Step 1: Generate a KEK
74+
### Step 1: Generate a KEK
7675

7776
The KEK (Key Exchange Key) is an RSA key generated in Key Vault's HSM. This key is used to encrypt the key to be imported (target key).
7877

@@ -88,8 +87,7 @@ Use the [az keyvault key create](/cli/azure/keyvault/key?view=azure-cli-latest#a
8887
az keyvault key create --kty RSA-HSM --size 4096 --name KEKforBYOK --ops import --vault-name ContosoKeyVaultHSM
8988
```
9089

91-
92-
## Step 2: Download KEK public key
90+
### Step 2: Download KEK public key
9391

9492
Use the [az keyvault key download](/cli/azure/keyvault/key?view=azure-cli-latest#az-keyvault-key-download) to download the KEK public key into a .pem file. The target key you import is encrypted using the KEK public key.
9593

@@ -99,7 +97,7 @@ az keyvault key download --name KEKforBYOK --vault-name ContosoKeyVaultHSM --fil
9997

10098
Transfer the KEKforBYOK.publickey.pem file to your offline workstation. You will need this file during next step.
10199

102-
## Step 3: Generate and prepare your key for transfer
100+
### Step 3: Generate and prepare your key for transfer
103101

104102
Please refer to your HSM vendor's documentation to download and install the BYOK tool. Follow instruction from your HSM vendor to generate a target key and then create a Key Transfer Package (a BYOK file). The BYOK tool will use the key identifier from [Step 1](#step-1-generate-a-kek) and KEKforBYOK.publickey.pem file you downloaded in [Step 2](#step-2-download-kek-public-key) to generate an encrypted target key in a BYOK file.
105103

@@ -109,7 +107,7 @@ Transfer the BYOK file to your connected workstation.
109107
> Target key must be an RSA key of size 2048-bit or 3072-bit or 4096-bit. Importing Elliptic Curve keys is not supported at this time.
110108
> <br/><strong>Known issue:</strong> Importing RSA 4K target key from SafeNet Luna HSMs fails. When the issue is resolved this document will be updated.
111109
112-
## Step 4: Transfer your key to Azure Key Vault
110+
### Step 4: Transfer your key to Azure Key Vault
113111

114112
For this final step, transfer the Key Transfer Package (a BYOK file) from your disconnected workstation to the Internet-connected workstation and then use the [az keyvault key import](/cli/azure/keyvault/key?view=azure-cli-latest#az-keyvault-key-import) command to upload the BYOK file the Azure Key Vault HSM, to complete the key import.
115113

0 commit comments

Comments
 (0)