org.springframework.vault.authentication

Class KubernetesAuthentication

java.lang.Object

org.springframework.vault.authentication.KubernetesAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class KubernetesAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

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

Since:

2.0

Author:

Michal Budzyn, Mark Paluch

See Also:

KubernetesAuthenticationOptions, RestOperations, Auth Backend: Kubernetes

Constructor Summary

Constructors

Constructor and Description
KubernetesAuthentication(KubernetesAuthenticationOptions options, RestOperations restOperations) Create a KubernetesAuthentication using KubernetesAuthenticationOptions and RestOperations.

Method Summary

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

Constructor Detail

KubernetesAuthentication

public KubernetesAuthentication(KubernetesAuthenticationOptions options,
                                RestOperations restOperations)

Create a KubernetesAuthentication using KubernetesAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

Method Detail

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(KubernetesAuthenticationOptions options)

Creates a AuthenticationSteps for kubernetes authentication given KubernetesAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for kubernetes authentication.

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

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.