Package org.springframework.vault.authentication

Class AzureMsiAuthentication

java.lang.Object

org.springframework.vault.authentication.AzureMsiAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class AzureMsiAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

Azure MSI (Managed Service Identity) authentication using Azure as trusted third party.

Azure MSI authentication uses AzureVmEnvironment and the MSI OAuth2 token (referenced as JWT token in Vault docs) to log into Vault. VM environment and OAuth2 token are fetched from the Azure Instance Metadata service. Instances of this class are immutable once constructed.

Since:

2.1

Author:

Mark Paluch

See Also:

• AzureMsiAuthenticationOptions
• VaultClient
• Auth Method: azure

Constructor Summary

Constructors

Constructor	Description
AzureMsiAuthentication(AzureMsiAuthenticationOptions options, VaultClient vaultClient)	Create a new AzureMsiAuthentication specifying AzureMsiAuthenticationOptions and VaultClient.
AzureMsiAuthentication(AzureMsiAuthenticationOptions options, VaultClient vaultClient, RestClient azureMetadataClient)	Create a new AzureMsiAuthentication specifying AzureMsiAuthenticationOptions, VaultClient and an Azure-Metadata-specific RestClient.
AzureMsiAuthentication(AzureMsiAuthenticationOptions options, RestClient client)	Create a new AzureMsiAuthentication.
AzureMsiAuthentication(AzureMsiAuthenticationOptions options, RestClient vaultClient, RestClient azureMetadataClient)	Create a new AzureMsiAuthentication specifying AzureMsiAuthenticationOptions, a Vault and an Azure-Metadata-specific RestClient.
AzureMsiAuthentication(AzureMsiAuthenticationOptions options, RestOperations restOperations)	Deprecated. since 4.1, use AzureMsiAuthentication(AzureMsiAuthenticationOptions, VaultClient, RestClient) instead.
AzureMsiAuthentication(AzureMsiAuthenticationOptions options, RestOperations vaultRestOperations, RestOperations azureMetadataRestOperations)	Create a new AzureMsiAuthentication specifying AzureMsiAuthenticationOptions, a Vault and an Azure-Metadata-specific RestOperations.

Method Summary

Modifier and Type	Method	Description
static AuthenticationSteps	createAuthenticationSteps(AzureMsiAuthenticationOptions options)	Create AuthenticationSteps for Azure authentication given AzureMsiAuthenticationOptions.
protected static AuthenticationSteps	createAuthenticationSteps(AzureMsiAuthenticationOptions options, @Nullable AzureVmEnvironment environment)
AuthenticationSteps	getAuthenticationSteps()	Get the AuthenticationSteps describing an authentication flow.
VaultToken	login()	Obtain a VaultToken for authenticated Vault access.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AzureMsiAuthentication

@Deprecated(since="4.1")
public AzureMsiAuthentication(AzureMsiAuthenticationOptions options,
 RestOperations restOperations)

Deprecated.

since 4.1, use AzureMsiAuthentication(AzureMsiAuthenticationOptions, VaultClient, RestClient) instead.

Create a new AzureMsiAuthentication.

Parameters:

options - must not be null.

restOperations - must not be null.

AzureMsiAuthentication

public AzureMsiAuthentication(AzureMsiAuthenticationOptions options,
 RestOperations vaultRestOperations,
 RestOperations azureMetadataRestOperations)

Create a new AzureMsiAuthentication specifying AzureMsiAuthenticationOptions, a Vault and an Azure-Metadata-specific RestOperations.

Parameters:

options - must not be null.

vaultRestOperations - must not be null.

azureMetadataRestOperations - must not be null.

AzureMsiAuthentication

public AzureMsiAuthentication(AzureMsiAuthenticationOptions options,
 RestClient client)

Create a new AzureMsiAuthentication.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.0

AzureMsiAuthentication

public AzureMsiAuthentication(AzureMsiAuthenticationOptions options,
 RestClient vaultClient,
 RestClient azureMetadataClient)

Create a new AzureMsiAuthentication specifying AzureMsiAuthenticationOptions, a Vault and an Azure-Metadata-specific RestClient.

Parameters:

options - must not be null.

vaultClient - must not be null.

azureMetadataClient - must not be null.

Since:

4.0

AzureMsiAuthentication

public AzureMsiAuthentication(AzureMsiAuthenticationOptions options,
 VaultClient vaultClient)

Create a new AzureMsiAuthentication specifying AzureMsiAuthenticationOptions and VaultClient.

Parameters:

options - must not be null.

vaultClient - must not be null.

Since:

4.1

AzureMsiAuthentication

public AzureMsiAuthentication(AzureMsiAuthenticationOptions options,
 VaultClient vaultClient,
 RestClient azureMetadataClient)

Create a new AzureMsiAuthentication specifying AzureMsiAuthenticationOptions, VaultClient and an Azure-Metadata-specific RestClient.

Parameters:

options - must not be null.

vaultClient - must not be null.

azureMetadataClient - must not be null.

Since:

4.1

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(AzureMsiAuthenticationOptions options)

Create AuthenticationSteps for Azure authentication given AzureMsiAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for Azure authentication.

createAuthenticationSteps

protected static AuthenticationSteps createAuthenticationSteps(AzureMsiAuthenticationOptions options,
 @Nullable AzureVmEnvironment environment)

login

public VaultToken login()
                 throws VaultException

Description copied from interface: ClientAuthentication

Obtain a VaultToken for authenticated Vault access.

This method may perform an authentication request to Vault or return a cached or pre-configured token.

Specified by:

login in interface ClientAuthentication

Returns:

the Vault token for subsequent authenticated requests

Throws:

VaultLoginException - if authentication fails.

VaultException

See Also:

• LoginToken

getAuthenticationSteps

public AuthenticationSteps getAuthenticationSteps()

Description copied from interface: AuthenticationStepsFactory

Get the AuthenticationSteps describing an authentication flow.

Specified by:

getAuthenticationSteps in interface AuthenticationStepsFactory

Returns:

the AuthenticationSteps describing an authentication flow.