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
• RestOperations
• Vault Auth Backend: JWT

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_JWT_AUTHENTICATION_PATH

Constructor Summary

Constructors

Constructor	Description
JwtAuthentication(JwtAuthenticationOptions options, RestOperations restOperations)	Create a JwtAuthentication using JwtAuthenticationOptions and RestOperations.

Method Summary

Modifier and Type	Method	Description
AuthenticationSteps	getAuthenticationSteps()	Get the AuthenticationSteps describing an authentication flow.
VaultToken	login()	Return a VaultToken.

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

public JwtAuthentication(JwtAuthenticationOptions options,
 RestOperations restOperations)

Create a JwtAuthentication using JwtAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

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

Return a VaultToken. This method can optionally log into Vault to obtain a token.

Specified by:

login in interface ClientAuthentication

Returns:

a VaultToken.

Throws:

VaultException