Package org.springframework.vault.authentication

Class JwtAuthentication

java.lang.Object

org.springframework.vault.authentication.JwtAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class JwtAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

JWT implementation of ClientAuthentication. JwtAuthentication uses a JSON Web Token to login into Vault. JWT and Role are sent in the login request to Vault to obtain a VaultToken.

Since:

3.1

Author:

Nanne Baars

See Also:

• JwtAuthenticationOptions
• VaultClient
• Vault Auth Method: JWT

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_JWT_AUTHENTICATION_PATH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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

Field Details

DEFAULT_JWT_AUTHENTICATION_PATH

public static final String DEFAULT_JWT_AUTHENTICATION_PATH

See Also:

• Constant Field Values

Constructor Details

JwtAuthentication

@Deprecated(since="4.1")
public JwtAuthentication(JwtAuthenticationOptions options,
 RestOperations restOperations)

Deprecated.

since 4.1, use JwtAuthentication(JwtAuthenticationOptions, VaultClient) instead.

Create a JwtAuthentication using JwtAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

JwtAuthentication

public JwtAuthentication(JwtAuthenticationOptions options,
 RestClient client)

Create a JwtAuthentication using JwtAuthenticationOptions and RestClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.0

JwtAuthentication

public JwtAuthentication(JwtAuthenticationOptions options,
 VaultClient client)

Create a JwtAuthentication using JwtAuthenticationOptions and VaultClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.1

Method Details

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.

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