Managing User Permissions for Key Vault
Please check here for scripts using the latest PowerShell cmdlets.
Granting access to different users to manage the key vault would be a typical scenario in an organization. This could either be to create new vaults or manage keys and secrets within an existing key vault. One way to do that would be to create an AD application and use that to manage the vault. Alternatively you would also want to add users to your azure subscription and grant them access for this (which was exactly what one of my readers wanted to achieve and reached out to me for).
In this post we will see how we can add a new user and grant him the required permissions. The permissions to be provided would differ based on your requirement, so you would want to modify them as required.
Creating a new user to the azure subscription can easily be done from the management portal. We need to create the user in the azure subscription, as any resource in the subscription can be accessed only after authenticating against the Active Directory (AD) associated with it.
Every Azure subscription is associated with an Azure Active Directory (AD) and needs to be authenticated with, before any of its resources can be used.
Azure Key Vault gets created in the default AD associated with the subscription, so we need to add the new user to that. (If you are not sure on how to find the default AD this post describes it in the beginning). In the portal under the Azure Directory option, select the default directory and on the Users tab, we can add a new user.
When creating the user, you can assign the role required based on the requirement. In this case I have added the user to a ’User’ role, as I do not want this user to have any administrative access to the my azure subscriptions or resources.
To create a key vault that we want to give permissions for the user, the below powershell scripts can be used. If you are new to key vault, then check out the Getting Started with Azure Key Vault or other related articles.
Switch-AzureMode AzureResourceManager New-AzureResourceGroup –Name 'SharedGroup' –Location 'East Asia' New-AzureKeyVault -VaultName 'TestKeyVault' -ResourceGroupName 'SharedGroup' -Location 'East Asia'
The above scripts creates the key vault under the ’SharedGroup‘. Resource Groups are logical containers, used to group resources together as required. Access to azure resources can be assigned at any of the three levels (subscription, resource group or resource) and it inherits down the hierarchy as shown below. Roles can be assigned specifically to a resource, or to resource group (which would mean all to all resources in that group) or at the subscription level (which would apply to all resources/resource groups in that subscription.).
As an administrator I want the newly created user to have permission to interact with the key vault, but not create new or delete existing vaults. I would also want to give the user ability to modify keys and secrets within the vault. Currently since the new user does not have any rights, we should first give him rights to see the vaults in the SharedGroup. For this a Reader role from the set of built in roles can be assinged, through the new azure portal or powershell.
New-AzureRoleAssignment -Mail email@example.com -RoleDefinitionName Reader -ResourceGroupName SharedGroup
To modify objects (keys/secrets) in the key vault we need to run Set-AzureKeyVaultAccessPolicy cmdlet with the required permissions, to grant access for the user. In the below script the user is given all Permissions to both keys and secrets, and this again depends on your requirement.
Set-AzureKeyVaultAccessPolicy -VaultName "TestKeyVault" -UserPrincipalName "firstname.lastname@example.org" -PermissionsToKeys all -PermissionsToSecrets all
The new user can login with the email id and password, shared to him by the administrator (received when creating the user in the AD), in the powershell prompt and create keys/secrets in the key vault.
$userName = 'email@example.com' $subscriptionPassword = 'mypassword' $securePassword = ConvertTo-SecureString -String $subscriptionPassword -AsPlainText -Force $cred = New-Object System.Management.Automation.PSCredential($userName, $securePassword) Add-AzureAccount -Credential $cred Add-AzureKeyVaultKey -VaultName 'TestKeyVault' -Name 'MyKey' -Destination 'Software'
The newly created user now has full access on the key vault and only that. He can only add/remove objects within the key vault and see resources within the SharedGroup. This way the administrator can be rest assured that no other sensitive information or accesses is being shared accidentally. Periodically revisiting these permissions and revoking unnecessary accesses is recommended!