Package org.springframework.vault.authentication

Class UsernamePasswordAuthentication

java.lang.Object

org.springframework.vault.authentication.UsernamePasswordAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class UsernamePasswordAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

Username and password implementation of ClientAuthentication. Can be used for userpass, ldap, okta, and radius authentication methods.

Since:

2.4

Author:

Mikhael Sokolov, Mark Paluch

See Also:

• UsernamePasswordAuthenticationOptions
• VaultClient
• Username and password
• LDAP authentication
• Okta authentication
• RADIUS authentication

Constructor Summary

Constructors

Constructor	Description
UsernamePasswordAuthentication(UsernamePasswordAuthenticationOptions options, VaultClient client)	Create a UsernamePasswordAuthentication using UsernamePasswordAuthenticationOptions and VaultClient.
UsernamePasswordAuthentication(UsernamePasswordAuthenticationOptions options, RestClient client)	Create a UsernamePasswordAuthentication using UsernamePasswordAuthenticationOptions and RestClient.
UsernamePasswordAuthentication(UsernamePasswordAuthenticationOptions options, RestOperations restOperations)	Deprecated. since 4.1, use UsernamePasswordAuthentication(UsernamePasswordAuthenticationOptions, VaultClient) instead.

Method Summary

Modifier and Type	Method	Description
static AuthenticationSteps	createAuthenticationSteps(UsernamePasswordAuthenticationOptions options)	Create AuthenticationSteps for username/password authentication given UsernamePasswordAuthenticationOptions.
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

UsernamePasswordAuthentication

@Deprecated(since="4.1")
public UsernamePasswordAuthentication(UsernamePasswordAuthenticationOptions options,
 RestOperations restOperations)

Deprecated.

since 4.1, use UsernamePasswordAuthentication(UsernamePasswordAuthenticationOptions, VaultClient) instead.

Create a UsernamePasswordAuthentication using UsernamePasswordAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

UsernamePasswordAuthentication

public UsernamePasswordAuthentication(UsernamePasswordAuthenticationOptions options,
 RestClient client)

Create a UsernamePasswordAuthentication using UsernamePasswordAuthenticationOptions and RestClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.0

UsernamePasswordAuthentication

public UsernamePasswordAuthentication(UsernamePasswordAuthenticationOptions options,
 VaultClient client)

Create a UsernamePasswordAuthentication using UsernamePasswordAuthenticationOptions and VaultClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.1

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(UsernamePasswordAuthenticationOptions options)

Create AuthenticationSteps for username/password authentication given UsernamePasswordAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for username/password authentication.

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.