You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/key-vault/managed-hsm/access-control.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ tags: azure-resource-manager
8
8
ms.service: key-vault
9
9
ms.subservice: managed-hsm
10
10
ms.topic: conceptual
11
-
ms.date: 02/17/2021
11
+
ms.date: 01/04/2023
12
12
ms.author: mbaldwin
13
13
# Customer intent: As the admin for managed HSMs, I want to set access policies and configure the Managed HSM, so that I can ensure it's secure and auditors can properly monitor all activities for these managed HSMs.
14
14
---
@@ -22,26 +22,26 @@ Azure Key Vault Managed HSM is a cloud service that safeguards encryption keys.
22
22
23
23
## Access control model
24
24
25
-
Access to a managed HSM is controlled through two interfaces: the **management plane** and the **data plane**. The management plane is where you manage the HSM itself. Operations in this plane include creating and deleting managed HSMs and retrieving managed HSM properties. The data plane is where you work with the data stored in an managed HSM -- that is HSM-backed encryption keys. You can add, delete, modify, and use keys to perform cryptographic operations, manage role assignments to control access to the keys, create a full HSM backup, restore full backup, and manage security domain from the data plane interface.
25
+
Access to a managed HSM is controlled through two interfaces: the **management plane** and the **data plane**. The management plane is where you manage the HSM itself. Operations in this plane include creating and deleting managed HSMs and retrieving managed HSM properties. The data plane is where you work with the data stored in a managed HSM — that is, the HSM-backed encryption keys. You can add, delete, modify, and use keys to perform cryptographic operations, manage role assignments to control access to the keys, create a full HSM backup, restore full backup, and manage security domain from the data plane interface.
26
26
27
27
To access a managed HSM in either plane, all callers must have proper authentication and authorization. Authentication establishes the identity of the caller. Authorization determines which operations the caller can execute. A caller can be any one of the [security principals](../../role-based-access-control/overview.md#security-principal) defined in Azure Active Directory - user, group, service principal or managed identity.
28
28
29
-
Both planes use Azure Active Directory for authentication. For authorization they use different systems as follows
30
-
- The management plane uses Azure role-based access control -- Azure RBAC -- an authorization system built on Azure Azure Resource Manager
31
-
- The data plane uses a managed HSM-level RBAC (Managed HSM local RBAC) -- an authorization system implemented and enforced at the managed HSM level.
29
+
Both planes use Azure Active Directory for authentication. For authorization, they use different systems as follows
30
+
- The management plane uses Azure role-based access control (Azure RBAC), an authorization system built on Azure Resource Manager
31
+
- The data plane uses a managed HSM-level RBAC (Managed HSM local RBAC), an authorization system implemented and enforced at the managed HSM level.
32
32
33
33
When a managed HSM is created, the requestor also provides a list of data plane administrators (all [security principals](../../role-based-access-control/overview.md#security-principal) are supported). Only these administrators are able to access the managed HSM data plane to perform key operations and manage data plane role assignments (Managed HSM local RBAC).
34
34
35
-
Permission model for both planes uses the same syntax, but they are enforced at different levels and role assignments use different scopes. Management plane Azure RBAC is enforced by Azure Resource Manager while data plane Managed HSM local RBAC is enforced by managed HSM itself.
35
+
Permission model for both planes uses the same syntax, but they're enforced at different levels and role assignments use different scopes. Management plane Azure RBAC is enforced by Azure Resource Manager while data plane Managed HSM local RBAC is enforced by managed HSM itself.
36
36
37
37
> [!IMPORTANT]
38
38
> Granting a security principal management plane access to an managed HSM does not grant them any access to data plane to access keys or data plane role assignments Managed HSM local RBAC). This isolation is by design to prevent inadvertent expansion of privileges affecting access to keys stored in Managed HSM.
39
39
40
-
For example, a subscription administrator (since they have "Contributor" permission to all resources in the subscription) can delete an managed HSM in their subscription, but if they don't have data plane access specifically granted through Managed HSM local RBAC, they cannot gain access to keys or manage role assignment in the managed HSM to grant themselves or others access to data plane.
40
+
For example, a subscription administrator (since they have "Contributor" permission to all resources in the subscription) can delete an managed HSM in their subscription, but if they don't have data plane access specifically granted through Managed HSM local RBAC, they can't gain access to keys or manage role assignment in the managed HSM to grant themselves or others access to data plane.
41
41
42
42
## Azure Active Directory authentication
43
43
44
-
When you create an managed HSM in an Azure subscription, it's automatically associated with the Azure Active Directory tenant of the subscription. All callers in both planes must be registered in this tenant and authenticate to access the managed HSM.
44
+
When you create a managed HSM in an Azure subscription, it's automatically associated with the Azure Active Directory tenant of the subscription. All callers in both planes must be registered in this tenant and authenticate to access the managed HSM.
45
45
46
46
The application authenticates with Azure Active Directory before calling either plane. The application can use any [supported authentication method](../../active-directory/develop/authentication-vs-authorization.md) based on the application type. The application acquires a token for a resource in the plane to gain access. The resource is an endpoint in the management or data plane, based on the Azure environment. The application uses the token and sends a REST API request to Managed HSM endpoint. To learn more, review the [whole authentication flow](../../active-directory/develop/v2-oauth2-auth-code-flow.md).
47
47
@@ -53,7 +53,7 @@ The use of a single authentication mechanism for both planes has several benefit
53
53
54
54
## Resource endpoints
55
55
56
-
Security principals access the planes through endpoints. The access controls for the two planes work independently. To grant an application access to use keys in an managed HSM, you grant data plane access by using Managed HSM local RBAC. To grant a user access to Managed HSM resource to create, read, delete, move the managed HSMs and edit other properties and tags you use Azure RBAC.
56
+
Security principals access the planes through endpoints. The access controls for the two planes work independently. To grant an application access to use keys in a managed HSM, you grant data plane access by using Managed HSM local RBAC. To grant a user access to Managed HSM resource to create, read, delete, move the managed HSMs and edit other properties and tags you use Azure RBAC.
57
57
58
58
The following table shows the endpoints for the management and data planes.
59
59
@@ -78,7 +78,7 @@ There are several predefined roles. If a predefined role doesn't fit your needs,
78
78
79
79
## Data plane and Managed HSM local RBAC
80
80
81
-
You grant a security principal access to execute specific key operations by assigning a role. For each role assignment you need to specify a role and scope over which that assignment applies. For Managed HSM local RBAC two scopes are available.
81
+
You grant a security principal access to execute specific key operations by assigning a role. For each role assignment, you must specify a role and scope over which that assignment applies. For Managed HSM local RBAC two scopes are available.
82
82
83
83
-**"/" or "/keys"**: HSM level scope. Security principals assigned a role at this scope can perform the operations defined in the role for all objects (keys) in the managed HSM.
84
84
-**"/keys/<key-name>"**: Key level scope. Security principals assigned a role at this scope can perform the operations defined in this role for all versions of the specified key only.
Copy file name to clipboardExpand all lines: articles/key-vault/managed-hsm/backup-restore.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ tags: azure-key-vault
8
8
ms.service: key-vault
9
9
ms.subservice: managed-hsm
10
10
ms.topic: tutorial
11
-
ms.date: 09/15/2020
11
+
ms.date: 01/04/2023
12
12
ms.author: mbaldwin
13
13
# Customer intent: As a developer using Key Vault I want to know the best practices so I can implement them.
14
14
---
@@ -75,7 +75,7 @@ You must provide the following information to execute a full restore:
75
75
- Storage account name
76
76
- Storage account blob container
77
77
- Storage container SAS token with permissions `rl`
78
-
- Storage container folder name where the source backup is store
78
+
- Storage container folder name where the source backup is stored
79
79
80
80
Restore is a long running operation but will immediately return a Job ID. You can check the status of the restore process using this Job ID. When the restore process is in progress, the HSM enters a restore mode and all data plane command (except check restore status) are disabled.
Copy file name to clipboardExpand all lines: articles/key-vault/managed-hsm/best-practices.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ tags: azure-key-vault
8
8
ms.service: key-vault
9
9
ms.subservice: managed-hsm
10
10
ms.topic: conceptual
11
-
ms.date: 06/21/2021
11
+
ms.date: 01/04/2023
12
12
ms.author: mbaldwin
13
13
# Customer intent: As a developer using Managed HSM I want to know the best practices so I can implement them.
14
14
---
@@ -17,10 +17,10 @@ ms.author: mbaldwin
17
17
## Control Access to your managed HSM
18
18
19
19
Managed HSM is a cloud service that safeguards encryption keys. As these keys are sensitive and business critical, make sure to secure access to your managed HSMs by allowing only authorized applications and users. This [article](access-control.md) provides an overview of the access model. It explains authentication and authorization, and role-based access control.
20
-
- Create an [Azure Active Directory Security Group](../../active-directory/fundamentals/active-directory-manage-groups.md) for the HSM Administrators (instead of assigning Administrator role to individuals). This will prevent "administration lock-out" in case of individual account deletion.
20
+
- Create an [Azure Active Directory Security Group](../../active-directory/fundamentals/active-directory-manage-groups.md) for the HSM Administrators (instead of assigning Administrator role to individuals), to prevent "administration lock-out" if there was individual account deletion.
21
21
- Lock down access to your management groups, subscriptions, resource groups and Managed HSMs - Use Azure RBAC to control access to your management groups, subscriptions, and resource groups
22
22
- Create per key role assignments using [Managed HSM local RBAC](access-control.md#data-plane-and-managed-hsm-local-rbac).
23
-
- To maintain separation of duties avoid assigning multiple roles to same principals.
23
+
- To maintain separation of duties, avoid assigning multiple roles to same principals.
24
24
- Use least privilege access principal to assign roles.
25
25
- Create custom role definition with precise set of permissions.
Copy file name to clipboardExpand all lines: articles/key-vault/managed-hsm/built-in-roles.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ author: mbaldwin
7
7
ms.service: key-vault
8
8
ms.subservice: managed-hsm
9
9
ms.topic: tutorial
10
-
ms.date: 06/01/2021
10
+
ms.date: 01/04/2023
11
11
ms.author: mbaldwin
12
12
13
13
---
@@ -30,7 +30,7 @@ Managed HSM local RBAC has several built-in roles. You can assign these roles to
30
30
## Permitted operations
31
31
> [!NOTE]
32
32
> - An 'X' indicates that a role is allowed to perform the data action. Empty cell indicates the role does not have pemission to perform that data action.
33
-
> - All the data action names have a 'Microsoft.KeyVault/managedHsm' prefix, which is omitted in the tables below for brevity.
33
+
> - All the data action names have a 'Microsoft.KeyVault/managedHsm' prefix, which is omitted in the tables for brevity.
34
34
> - All role names have a prefix "Managed HSM" which is omitted in the below table for brevity.
0 commit comments