Skip to content

Commit 4f003b0

Browse files
committed
Updates
1 parent 98d149b commit 4f003b0

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

articles/key-vault/managed-hsm/tls-offload-library.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ For more information, see [Azure Managed HSM TLS Offload Library GitHub](https:/
1818

1919
The TLS Offload Library internally uses the Azure Key Vault REST API to interact with Azure Managed HSM.
2020

21-
## Get Started
21+
## Get started
2222

23-
### PKCS#11 Attributes
23+
### PKCS#11 attributes
2424

2525
To properly integrate with PKCS#11, generating keys (via C_GenerateKeyPair) and locating key objects (via C_FindObjectsInit/C_FindObjects) requires a solution for storing PKCS#11 attributes on the Azure Key Vault key object. The TLS Offload Library converts these necessary PKCS#11 attributes into Azure Key Vault Tags.
2626

@@ -35,7 +35,7 @@ Applications that use the TLS Offload Library use one or more PKCS#11 attributes
3535
> [!WARNING]
3636
> Keys generated by the TLS Offload Library and their Tags are accessible over Azure Key Vault REST API. Manipulating these P11 Attribute Tags using Azure Key Vault REST API may break the TLS Offload Library applications.
3737
38-
### Key Generation
38+
### Key generation
3939

4040
The TLS Offload Library includes a key creation tool, mhsm_p11_create_key. Running the tool without any command line arguments shows the correct usage of the tool.
4141

@@ -61,7 +61,7 @@ The `--label` argument to the key creation tool specifies the desired CKA_LABEL
6161

6262
You need the key name for any role assignment changes via the Azure CLI.
6363

64-
### Access Control
64+
### Access control
6565

6666
The TLS Offload Library translates the C_FindObjectsInit into an Azure Key Vault REST API call, which operates at the /keys scope. The MHSM service requires the Read permission at this scope for the TLS Offload Library User to authorize the find operation for the keys created via the key creation tool.
6767

@@ -91,9 +91,9 @@ The key generation service principal is used with the key creation tool (mhsm_p1
9191

9292
#### Azure CLI
9393

94-
Azure CLI can be used to perform tasks such as Role Assignment.
94+
Azure CLI can be used to perform tasks such as role assignment.
9595

96-
### Permissive Approach
96+
### Permissive approach
9797

9898
The permissive approach is simpler, and suitable when the Azure Managed HSM is exclusively used for TLS offloading.
9999

@@ -106,13 +106,13 @@ az keyvault role assignment create --hsm-name ContosoMHSM \
106106
--scope /keys
107107
```
108108

109-
### Granular Approach
109+
### Granular approach
110110

111111
The granular approach implements fine grained access control. It requires two service principals (TLS Offload service principal and Key Generation service principal) and an Admin User.
112112

113113
The objective is to restrict the TLS Offload service principal's permissions to support the minimum required for TLS offload. The user must have the Read permission for other keys to support the library's C_FindObject* function.
114114

115-
#### TLS Offload Library User Read Role
115+
#### TLS Offload Library User Read role
116116

117117
The first step in implementing the granular approach is to create a custom role. This operation only needs to be done once.
118118

@@ -129,11 +129,11 @@ az keyvault role definition create --hsm-name ContosoMHSM --role-definition '{ \
129129
}'
130130
```
131131

132-
#### Generate Keys
132+
#### Generate keys
133133

134134
Keys can be generated using the Key Generation service principal with the key creation tool (mhsm_p11_create_key).
135135

136-
#### Grant Permission
136+
#### Grant permission
137137

138138
The Admin User assigns the following roles to the TLS Offload service principal.
139139
- Assign "TLS Library User Read Role" role at the "/keys" scope
@@ -153,11 +153,11 @@ az keyvault role assignment create --hsm-name ContosoMHSM \
153153
--scope /keys/p11-6a2155dc40c94367a0f97ab452dc216f
154154
```
155155

156-
## How To
156+
## Using the TLS Offload Library
157157

158-
### How to generate keys using the TLS Offload Library
158+
### Generate keys
159159

160-
The TLS Offload Library includes a key creation tool - mhsm_p11_create_key. Running the tool without any command line arguments shows the correct usage of the tool.
160+
The TLS Offload Library includes a key creation tool, mhsm_p11_create_key. Running the tool without any command line arguments shows the correct usage of the tool.
161161

162162
The key creation tool requires a service principal, which is assigned to the "Managed HSM Crypto User" role at the "/keys" scope.
163163

@@ -181,7 +181,7 @@ The `--label` argument to the key creation tool specifies the desired CKA_LABEL
181181

182182
The key name is required if you're planning to implement granular access to keys.
183183

184-
### How to implement keyless TLS
184+
### Implement keyless TLS
185185

186186
There are two approaches to generating a key and using the key for the Key Less TLS: a simpler, more permissive approach, and a granular approach, which offers better security. The approaches differ in implementation effort and security enforcement.
187187

0 commit comments

Comments
 (0)