Azure Auth
Learn how to authenticate with Infisical for services on Azure
Azure Auth is an Azure-native authentication method for Azure resources like Azure VMs, Azure App Services, Azure Functions, Azure Kubernetes Service, etc. to access Infisical.
Diagram
The following sequence digram illustrates the Azure Auth workflow for authenticating Azure service principals with Infisical.
Concept
At a high-level, Infisical authenticates an Azure service by verifying its identity and checking that it meets specific requirements (e.g. it is bound to an allowed service principal) at the /api/v1/auth/azure-auth/login
endpoint. If successful,
then Infisical returns a short-lived access token that can be used to make authenticated requests to the Infisical API.
To be more specific:
- The client running on an Azure service obtains an access token that is a JWT token representing the managed identity for the Azure resource such as a Virtual Machine; the managed identity is associated with a service principal in Azure AD.
- The client sends the access token to Infisical.
- Infisical verifies the token against the corresponding public key at the public Azure AD OpenID configuration endpoint.
- Infisical checks if the entity behind the access token is allowed to authenticate with Infisical based on set criteria such as Allowed Service Principal IDs.
- If all is well, Infisical returns a short-lived access token that the client can use to make authenticated requests to the Infisical API.
We recommend using one of Infisical’s clients like SDKs or the Infisical Agent to authenticate with Infisical using Azure Auth as they handle the authentication process including generating the client access token for you.
Also, note that Infisical needs network-level access to send requests to the Google Cloud API as part of the Azure Auth workflow.
Guide
In the following steps, we explore how to create and use identities for your applications in Azure to access the Infisical API using the Azure Auth authentication method.
Creating an identity
To create an identity, head to your Organization Settings > Access Control > Machine Identities and press Create identity.
When creating an identity, you specify an organization level role for it to assume; you can configure roles in Organization Settings > Access Control > Organization Roles.
Now input a few details for your new identity. Here’s some guidance for each field:
- Name (required): A friendly name for the identity.
- Role (required): A role from the Organization Roles tab for the identity to assume. The organization role assigned will determine what organization level resources this identity can have access to.
Once you’ve created an identity, you’ll be prompted to configure the authentication method for it. Here, select Azure Auth.
Here’s some more guidance on each field:
- Tenant ID: The tenant ID for the Azure AD organization.
- Resource / Audience: The resource URL for the application registered in Azure AD. The value is expected to match the
aud
claim of the access token JWT later used in the login operation against Infisical. See the resource parameter for how the audience is set when requesting a JWT access token from the Azure Instance Metadata Service (IMDS) endpoint. In most cases, this value should behttps://management.azure.com/
which is the default. - Allowed Service Principal IDs: A comma-separated list of Azure AD service principal IDs that are allowed to authenticate with Infisical.
- Access Token TTL (default is
2592000
equivalent to 30 days): The lifetime for an acccess token in seconds. This value will be referenced at renewal time. - Access Token Max TTL (default is
2592000
equivalent to 30 days): The maximum lifetime for an acccess token in seconds. This value will be referenced at renewal time. - Access Token Max Number of Uses (default is
0
): The maximum number of times that an access token can be used; a value of0
implies infinite number of uses. - Access Token Trusted IPs: The IPs or CIDR ranges that access tokens can be used from. By default, each token is given the
0.0.0.0/0
, allowing usage from any network address.
Adding an identity to a project
To enable the identity to access project-level resources such as secrets within a specific project, you should add it to that project.
To do this, head over to the project you want to add the identity to and go to Project Settings > Access Control > Machine Identities and press Add identity.
Next, select the identity you want to add to the project and the project level role you want to allow it to assume. The project role assigned will determine what project level resources this identity can have access to.
Accessing the Infisical API with the identity
To access the Infisical API as the identity, you need to generate a managed identity access token that is a JWT token representing the managed identity for the Azure resource such as a Virtual Machine. The client token must be sent to the /api/v1/auth/azure-auth/login
endpoint in exchange for a separate access token to access the Infisical API.
We provide a few code examples below of how you can authenticate with Infisical to access the Infisical API.
We recommend using one of Infisical’s clients like SDKs or the Infisical Agent to authenticate with Infisical using Azure Auth as they handle the authentication process including retrieving the client access token.
Each identity access token has a time-to-live (TLL) which you can infer from the response of the login operation;
the default TTL is 7200
seconds which can be adjusted.
If an identity access token expires, it can no longer authenticate with the Infisical API. In this case,
a new access token should be obtained by performing another login operation.