Package org.springframework.vault.authentication

Class PcfAuthentication

java.lang.Object

org.springframework.vault.authentication.PcfAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class PcfAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

PCF implementation of ClientAuthentication. PcfAuthentication uses a PCF instance certificate and key to login into Vault.

Requires BouncyCastle to generate a RSA PSS signature.

Since:

2.2

Author:

Mark Paluch

See Also:

• PcfAuthenticationOptions
• VaultClient
• Auth Method: PCF

Constructor Summary

Constructors

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

Method Summary

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

PcfAuthentication

@Deprecated(since="4.1")
public PcfAuthentication(PcfAuthenticationOptions options,
 RestOperations restOperations)

Deprecated.

since 4.1, use PcfAuthentication(PcfAuthenticationOptions, VaultClient) instead.

Create a PcfAuthentication using PcfAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

PcfAuthentication

public PcfAuthentication(PcfAuthenticationOptions options,
 RestClient client)

Create a PcfAuthentication using PcfAuthenticationOptions and RestClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.0

PcfAuthentication

public PcfAuthentication(PcfAuthenticationOptions options,
 VaultClient client)

Create a PcfAuthentication using PcfAuthenticationOptions and VaultClient.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.1

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(PcfAuthenticationOptions options)

Create AuthenticationSteps for pcf authentication given PcfAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for pcf 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.