Package org.springframework.vault.authentication

Class GcpIamAuthentication

java.lang.Object

org.springframework.vault.authentication.GcpJwtAuthenticationSupport

org.springframework.vault.authentication.GcpIamAuthentication

All Implemented Interfaces:

ClientAuthentication

@Deprecated(since="2.3.2",
            forRemoval=true)
public class GcpIamAuthentication
extends GcpJwtAuthenticationSupport
implements ClientAuthentication

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.3.2, use GcpIamCredentialsAuthentication instead.

GCP IAM login implementation using GCP IAM service accounts to legitimate its authenticity via JSON Web Token using the deprecated IAM projects.serviceAccounts.signJwt method.

This authentication method uses Googles IAM API to obtain a signed token for a specific GoogleCredential. Project and service account details are obtained from a GoogleCredential that can be retrieved either from a JSON file or the runtime environment (GAE, GCE).

GcpIamAuthentication uses Google Java API that uses synchronous API.

Since:

2.1

Author:

Mark Paluch, Magnus Jungsbluth, Bruno Rodrigues

See Also:

• GcpIamAuthenticationOptions
• HttpTransport
• GoogleCredential
• GoogleCredentials.getApplicationDefault()
• RestOperations
• Auth Backend: gcp (IAM)
• GCP: projects.serviceAccounts.signJwt

Constructor Summary

Constructors

Constructor	Description
GcpIamAuthentication(GcpIamAuthenticationOptions options, RestOperations restOperations)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new instance of GcpIamAuthentication given GcpIamAuthenticationOptions and RestOperations.
GcpIamAuthentication(GcpIamAuthenticationOptions options, RestOperations restOperations, com.google.api.client.http.HttpTransport httpTransport)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new instance of GcpIamAuthentication given GcpIamAuthenticationOptions, RestOperations and HttpTransport.

Method Summary

Modifier and Type	Method	Description
VaultToken	login()	Deprecated, for removal: This API element is subject to removal in a future version. Obtain a VaultToken for authenticated Vault access.
protected String	signJwt()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GcpIamAuthentication

public GcpIamAuthentication(GcpIamAuthenticationOptions options,
 RestOperations restOperations)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new instance of GcpIamAuthentication given GcpIamAuthenticationOptions and RestOperations. This constructor initializes NetHttpTransport for Google API usage.

Parameters:

options - must not be null.

restOperations - HTTP client for Vault login, must not be null.

GcpIamAuthentication

public GcpIamAuthentication(GcpIamAuthenticationOptions options,
 RestOperations restOperations,
 com.google.api.client.http.HttpTransport httpTransport)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new instance of GcpIamAuthentication given GcpIamAuthenticationOptions, RestOperations and HttpTransport.

Parameters:

options - must not be null.

restOperations - HTTP client for Vault login, must not be null.

httpTransport - HTTP client for Google API use, must not be null.

Method Details

login

public VaultToken login()
                 throws VaultException

Deprecated, for removal: This API element is subject to removal in a future version.

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

signJwt

protected String signJwt()

Deprecated, for removal: This API element is subject to removal in a future version.