Hanzo
PlatformHanzo KMSIntegrationsApp Connections

Azure Key Vault Connection

Learn how to configure a Azure Key Vault Connection for Hanzo KMS.

Hanzo KMS currently only supports two methods for connecting to Azure, which are OAuth and Client Secrets.

Using the Azure Key Vault connection on a self-hosted instance of Hanzo KMS requires configuring an application in Azure and registering your instance with it.

Prerequisites:

  • Set up Azure and have an existing Key Vault instance.

Navigate to Azure Active Directory > App registrations to create a new application.

Azure Active Directory is now Microsoft Entra ID.

Azure key vault Azure key vault

Create the application. As part of the form, set the Redirect URI to https://your-domain.com/organization/app-connections/azure/oauth/callback.

The domain you defined in the Redirect URI should be equivalent to the SITE_URL configured in your Hanzo KMS instance.

Azure key vault

For the Azure Connection to work with Key Vault, you need to assign multiple permissions to the application.

Azure Key Vault permissions

Set the API permissions of the Azure application to include user.impersonation for the Key Vault API. Azure key vault

Obtain the Application (Client) ID in Overview and generate a Client Secret in Certificate & secrets for your Azure application.

Azure key vault Azure key vault Azure key vault

Back in your Hanzo KMS instance, add two new environment variables for the credentials of your Azure application.

  • INF_APP_CONNECTION_AZURE_KEY_VAULT_CLIENT_ID: The Application (Client) ID of your Azure application.
  • INF_APP_CONNECTION_AZURE_KEY_VAULT_CLIENT_SECRET: The Client Secret of your Azure application.

Once added, restart your Hanzo KMS instance and use the Azure Key Vault connection.

To use client secret authentication, ensure your Azure Service Principal has the required permissions and is connected to the Azure Key Vault instances you want to use.

Prerequisites:

  • Set up Azure and have an existing Key Vault instance.
  • The service principal must be connected to your target Azure Key Vault instance(s)

Configure the required API permissions for your App Registration to interact with Azure Key Vault:

Azure Key Vault permissions

Set the API permissions of your Azure service principal to include user_impersonation for the Key Vault API. Azure key vault

Setup Azure Connection in Hanzo KMS

Navigate to the Integrations tab in the desired project, then select App Connections. App Connections
Tab

Select the Azure Connection option from the connection options modal. Select Azure Connection

You can optionally authenticate against a specific tenant by providing the Azure Tenant or Directory ID.

Now select the OAuth method and click Connect to Azure.

Connect via Azure OAUth

You will then be redirected to Azure to grant Hanzo KMS access to your Azure account. Once granted, you will redirect you back to Hanzo KMS's App Connections page. Azure Key Vault
Authorization

Fill in the Tenant ID, Client ID, Client Secret fields with the Directory (Tenant) ID, Application (Client) ID, Client Secret you obtained in the previous step. Connect via Azure OAUth

Your Azure Key Vault Connection is now available for use. Assume Role AWS Connection

How is this guide?

Last updated on

On this page