Package 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
• VaultClient
• Auth Method: Kubernetes

Constructor Summary

Constructors

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

Method Summary

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

KubernetesAuthentication

@Deprecated(since="4.1")
public KubernetesAuthentication(KubernetesAuthenticationOptions options,
 RestOperations restOperations)

Deprecated.

since 4.1, use KubernetesAuthentication(KubernetesAuthenticationOptions, VaultClient) instead.

Create a KubernetesAuthentication using KubernetesAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

KubernetesAuthentication

public KubernetesAuthentication(KubernetesAuthenticationOptions options,
 RestClient client)

Create a KubernetesAuthentication using KubernetesAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.0

KubernetesAuthentication

public KubernetesAuthentication(KubernetesAuthenticationOptions options,
 VaultClient client)

Create a KubernetesAuthentication using KubernetesAuthenticationOptions and VaultClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.1

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(KubernetesAuthenticationOptions options)

Create 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

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.