Configure Azure Key Vault Integration
Last modified on September 1, 2022
Azure Key Vault is a cloud service for securely storing and accessing secrets like API keys, passwords, certificates, and cryptographic keys. This guide will walk you through how to integrate Key Vault with strongDM and use the secret store integration to connect to resources.
Secret store integrations allow you to use your existing third-party secret stores with strongDM. Your credentials are stored in a service that is controlled by you, and those credentials are never transmitted to strongDM in any form. If you would like to learn more about how the Secret Store integration works and why you might wish to use it, please read the Secret Stores Reference.
Make sure you are an account administrator in strongDM.
In your Azure AD permissions, your account must have a role that’s allowed to manage the Key Vault and assign a managed identity to a VM.
In your Azure subscription, your account must have the Owner role or User Access Administrator role.
See Microsoft’s documentation for more information on requirements for Azure AD permissions and Azure subscription permissions. Without proper permissions, you will not be able to create/register an application.
Set up Key Vault
Create a Key Vault in Azure
If you haven’t already established a Key Vault, create one now. If you already have one, skip to the next step, Update access policies.
- From either the Azure portal menu or the Home page, click Create a resource.
- Search for Key Vault, and from the search results list, select Key Vault.
- In the Key Vault section, click Create.
- Set the following Key Vault properties:
- Name: Enter a unique name for the vault.
- Subscription: Select a subscription.
- Resource Group: Select Create new and enter a resource group name.
- Location: Select a location from the pull-down menu.
- Keep the other options at their defaults.
- Click Next: Access Policy.
- Select Azure role-based access control.
- Click Next: Networking and ensure that the networking is configured so that the Gateway/Relay can access the vault.
- Select Review + create, make sure it looks OK, and then click Create.
- Once the deployment is complete, select go to resource.
- Note your Vault Name and Vault URI (e.g.,
https://contoso-vault2.vault.azure.net/), which will be viewable after the application has been created on the Overview section of the Vault.
Set up access to Key Vault
There are several ways to authenticate with Azure Key Vault. One of these needs to be configured in order to allow your Gateway to authenticate with the Key Vault and retrieve credentials. In this configuration guide, you will use your VM’s Managed Identity.
- Managed Identity (this is the method recommended by strongDM)
- Service Principal
- App Registration
Create a strongDM gateway in Azure
- Create an Ubuntu 20.03 Azure VM.
- Give the VM your SSH public key.
- Once the VM is created, install a Relay on the machine.
Enable the VM’s managed identity
- Select your new Azure VM in the Azure UI.
- In the sidebar, under Settings, select Identity.
- Toggle the system-assigned managed identity status to On and save.
Update Key Vault access policies
You need to update the Key Vault’s Access Control (IAM) to allow whatever Azure user(s) or group(s) you require, as well as allow access for the managed identity of the Gateway you just created. You can learn more about this in Azure’s Managed Identities documentation.
Configure the Secret Store with the Admin UI
Once you have Key Vault set up, credentials stored, and your relay server able to access said credentials, it’s time to integrate the secret store with strongDM.
Add secret store
- In the strongDM Admin UI, go to the Settings page, and click the Secret Stores tab.
- Click add secret store.
- On the Add Secret Store form that displays, set:
- Display Name: Enter a name for this secret store integration. This name will be displayed in the Admin UI.
- Secret Store Type: Select Azure Key Vault.
- Vault URI: Set the URI of your Key Vault (e.g.,
- Click create.
If you’ve configured the Relay server correctly for secret store access and authorization, you will see the green online indicator.
Add a resource, grant access to it, and test the connection
Now, create a resource that uses the secret store, grant access to it, and verify that you can connect.
- In the Admin UI, add a new resource, such as a Server or Datasource, and choose the Azure Key Vault Secret Store type.
- Fill out the information for a resource whose credentials you have stored in your secret store.
- Select the Azure Key Vault secret store you created for the Secret Store field, and then fill in the path to the secrets that you’ve stored in your secret store.
- Submit the form.
- Grant access to the resource so that a User can use it.
- Log in as that User in your local GUI (or have the User do so, if not yours).
- Verify that the resource exists, test a connection, and execute a query.
Congratulations, you’ve connected to a resource using secret stores.
path-to-secret?encoding=base64). However, we do not support creating secrets or using key arguments, such as