Package org.springframework.vault.authentication

Class AppRoleAuthentication

java.lang.Object

org.springframework.vault.authentication.AppRoleAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class AppRoleAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

AppRole implementation of ClientAuthentication. RoleId and SecretId (optional) are sent in the login request to Vault to obtain a VaultToken.

AppRoleAuthentication can be configured for push and pull mode by setting AppRoleAuthenticationOptions.getSecretId().

Author:

Mark Paluch, Vincent Le Nair, Christophe Tafani-Dereeper

See Also:

• AppRoleAuthenticationOptions
• VaultClient
• Auth Method: AppRole

Constructor Summary

Constructors

Constructor	Description
AppRoleAuthentication(AppRoleAuthenticationOptions options, VaultClient client)	Create a AppRoleAuthentication using AppRoleAuthenticationOptions and VaultClient.
AppRoleAuthentication(AppRoleAuthenticationOptions options, RestClient client)	Create a AppRoleAuthentication using AppRoleAuthenticationOptions and RestClient.
AppRoleAuthentication(AppRoleAuthenticationOptions options, RestOperations restOperations)	Deprecated. use AppRoleAuthentication(AppRoleAuthenticationOptions, VaultClient) instead.

Method Summary

Modifier and Type	Method	Description
static AuthenticationSteps	createAuthenticationSteps(AppRoleAuthenticationOptions options)	Create a AuthenticationSteps for AppRole authentication given AppRoleAuthenticationOptions.
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

AppRoleAuthentication

@Deprecated(since="4.1")
public AppRoleAuthentication(AppRoleAuthenticationOptions options,
 RestOperations restOperations)

Deprecated.

use AppRoleAuthentication(AppRoleAuthenticationOptions, VaultClient) instead.

Create a AppRoleAuthentication using AppRoleAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

AppRoleAuthentication

public AppRoleAuthentication(AppRoleAuthenticationOptions options,
 RestClient client)

Create a AppRoleAuthentication using AppRoleAuthenticationOptions and RestClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.0

AppRoleAuthentication

public AppRoleAuthentication(AppRoleAuthenticationOptions options,
 VaultClient client)

Create a AppRoleAuthentication using AppRoleAuthenticationOptions and VaultClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.1

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(AppRoleAuthenticationOptions options)

Create a AuthenticationSteps for AppRole authentication given AppRoleAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for AppRole authentication.

Since:

2.0

login

public VaultToken login()

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

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.