Class ExternalAccountCredentials
- All Implemented Interfaces:
QuotaProjectIdProvider
,Serializable
- Direct Known Subclasses:
AwsCredentials
,IdentityPoolCredentials
,PluggableAuthCredentials
Handles initializing external credentials, calls to the Security Token Service, and service account impersonation.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Base builder for external account credentials.(package private) static class
Base credential source class.(package private) static final class
Encapsulates the service account impersonation options portion of the configuration for ExternalAccountCredentials.static enum
Enum specifying values for the subjectTokenType field inExternalAccountCredentials
.Nested classes/interfaces inherited from class com.google.auth.oauth2.OAuth2Credentials
OAuth2Credentials.AsyncRefreshResult, OAuth2Credentials.CacheState, OAuth2Credentials.CredentialsChangedListener, OAuth2Credentials.FutureCallbackToMetadataCallbackAdapter, OAuth2Credentials.OAuthValue, OAuth2Credentials.RefreshTask, OAuth2Credentials.RefreshTaskListener
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
private final String
private final String
private static final String
private final ExternalAccountCredentials.CredentialSource
(package private) static final String
private EnvironmentProvider
(package private) static final String
(package private) static final String
protected ImpersonatedCredentials
private ExternalAccountMetricsHandler
(package private) static final String
private final Collection
<String> private static final long
private final String
private final String
private final String
private final String
protected HttpTransportFactory
private final String
private final String
Fields inherited from class com.google.auth.oauth2.GoogleCredentials
GDCH_SERVICE_ACCOUNT_FILE_TYPE, QUOTA_PROJECT_ID_HEADER_KEY, quotaProjectId, SERVICE_ACCOUNT_FILE_TYPE, USER_FILE_TYPE
Fields inherited from class com.google.auth.oauth2.OAuth2Credentials
clock, DEFAULT_EXPIRATION_MARGIN, DEFAULT_REFRESH_MARGIN, lock, refreshTask
Fields inherited from class com.google.auth.Credentials
GOOGLE_DEFAULT_UNIVERSE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ExternalAccountCredentials
(HttpTransportFactory transportFactory, String audience, String subjectTokenType, String tokenUrl, ExternalAccountCredentials.CredentialSource credentialSource, String tokenInfoUrl, String serviceAccountImpersonationUrl, String quotaProjectId, String clientId, String clientSecret, Collection<String> scopes) Constructor with minimum identifying information and custom HTTP transport.protected
ExternalAccountCredentials
(HttpTransportFactory transportFactory, String audience, String subjectTokenType, String tokenUrl, ExternalAccountCredentials.CredentialSource credentialSource, String tokenInfoUrl, String serviceAccountImpersonationUrl, String quotaProjectId, String clientId, String clientSecret, Collection<String> scopes, EnvironmentProvider environmentProvider) Constructor with minimum identifying information and custom HTTP transport.protected
Internal constructor with minimum identifying information and custom HTTP transport. -
Method Summary
Modifier and TypeMethodDescription(package private) ImpersonatedCredentials
protected AccessToken
exchangeExternalCredentialForAccessToken
(StsTokenExchangeRequest stsTokenExchangeRequest) Exchanges the external credential for a Google Cloud access token.(package private) static ExternalAccountCredentials
fromJson
(Map<String, Object> json, HttpTransportFactory transportFactory) Returns external account credentials defined by JSON using the format generated by gCloud.static ExternalAccountCredentials
fromStream
(InputStream credentialsStream) Returns credentials defined by a JSON file stream.static ExternalAccountCredentials
fromStream
(InputStream credentialsStream, HttpTransportFactory transportFactory) Returns credentials defined by a JSON file stream.(package private) String
(package private) EnvironmentProvider
getRequestMetadata
(URI uri) Provide the request metadata by ensuring there is a current access token and providing it as an authorization bearer token.void
getRequestMetadata
(URI uri, Executor executor, RequestMetadataCallback callback) Get the current request metadata without blocking.Gets the universe domain for the credential.private static boolean
isAwsCredential
(Map<String, Object> credentialSource) private static boolean
isPluggableAuthCredential
(Map<String, Object> credentialSource) private static boolean
isValidUrl
(String url) Returns true if the provided URL's scheme is valid and is HTTPS.boolean
private void
readObject
(ObjectInputStream input) abstract String
Retrieves the external subject token to be exchanged for a Google Cloud access token.private boolean
(package private) static void
validateServiceAccountImpersonationInfoUrl
(String serviceAccountImpersonationUrl) (package private) static void
validateTokenUrl
(String tokenUrl) Methods inherited from class com.google.auth.oauth2.GoogleCredentials
addQuotaProjectIdToRequestMetadata, create, create, createDelegated, createScoped, createScoped, createScoped, createScopedRequired, createWithCustomRetryStrategy, createWithQuotaProject, equals, getAdditionalHeaders, getApplicationDefault, getApplicationDefault, getQuotaProjectId, hashCode, isDefaultUniverseDomain, isExplicitUniverseDomain, newBuilder, toBuilder, toString, toStringHelper
Methods inherited from class com.google.auth.oauth2.OAuth2Credentials
addChangeListener, getAccessToken, getAuthenticationType, getExpirationMargin, getFromServiceLoader, getRefreshMargin, getRequestMetadataInternal, hasRequestMetadata, hasRequestMetadataOnly, newInstance, refresh, refreshAccessToken, refreshIfExpired, removeChangeListener
Methods inherited from class com.google.auth.Credentials
blockingGetToCallback, getMetricsCredentialType, getRequestMetadata
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
CLOUD_PLATFORM_SCOPE
- See Also:
-
EXTERNAL_ACCOUNT_FILE_TYPE
- See Also:
-
EXECUTABLE_SOURCE_KEY
- See Also:
-
DEFAULT_TOKEN_URL
- See Also:
-
PROGRAMMATIC_METRICS_HEADER_VALUE
- See Also:
-
transportFactoryClassName
-
audience
-
subjectTokenType
-
tokenUrl
-
credentialSource
-
scopes
-
serviceAccountImpersonationOptions
private final ExternalAccountCredentials.ServiceAccountImpersonationOptions serviceAccountImpersonationOptions -
metricsHandler
-
tokenInfoUrl
-
serviceAccountImpersonationUrl
-
clientId
-
clientSecret
-
workforcePoolUserProject
-
transportFactory
-
impersonatedCredentials
-
environmentProvider
-
-
Constructor Details
-
ExternalAccountCredentials
protected ExternalAccountCredentials(HttpTransportFactory transportFactory, String audience, String subjectTokenType, String tokenUrl, ExternalAccountCredentials.CredentialSource credentialSource, @Nullable String tokenInfoUrl, @Nullable String serviceAccountImpersonationUrl, @Nullable String quotaProjectId, @Nullable String clientId, @Nullable String clientSecret, @Nullable Collection<String> scopes) Constructor with minimum identifying information and custom HTTP transport. Does not support workforce credentials.- Parameters:
transportFactory
- HTTP transport factory, creates the transport used to get access tokensaudience
- the Security Token Service audience, which is usually the fully specified resource name of the workload/workforce pool providersubjectTokenType
- the Security Token Service subject token type based on the OAuth 2.0 token exchange spec. Indicates the type of the security token in the credential filetokenUrl
- the Security Token Service token exchange endpointcredentialSource
- the external credential sourcetokenInfoUrl
- the endpoint used to retrieve account related information. Required for gCloud session account identification.serviceAccountImpersonationUrl
- the URL for the service account impersonation request. This URL is required for some APIs. If this URL is not available, the access token from the Security Token Service is used directly. May be null.quotaProjectId
- the project used for quota and billing purposes. May be null.clientId
- client ID of the service account from the console. May be null.clientSecret
- client secret of the service account from the console. May be null.scopes
- the scopes to request during the authorization grant. May be null.
-
ExternalAccountCredentials
protected ExternalAccountCredentials(HttpTransportFactory transportFactory, String audience, String subjectTokenType, String tokenUrl, ExternalAccountCredentials.CredentialSource credentialSource, @Nullable String tokenInfoUrl, @Nullable String serviceAccountImpersonationUrl, @Nullable String quotaProjectId, @Nullable String clientId, @Nullable String clientSecret, @Nullable Collection<String> scopes, @Nullable EnvironmentProvider environmentProvider) Constructor with minimum identifying information and custom HTTP transport. Does not support workforce credentials.- Parameters:
transportFactory
- HTTP transport factory, creates the transport used to get access tokensaudience
- the Security Token Service audience, which is usually the fully specified resource name of the workload/workforce pool providersubjectTokenType
- the Security Token Service subject token type based on the OAuth 2.0 token exchange spec. Indicates the type of the security token in the credential filetokenUrl
- the Security Token Service token exchange endpointcredentialSource
- the external credential sourcetokenInfoUrl
- the endpoint used to retrieve account related information. Required for gCloud session account identification.serviceAccountImpersonationUrl
- the URL for the service account impersonation request. This URL is required for some APIs. If this URL is not available, the access token from the Security Token Service is used directly. May be null.quotaProjectId
- the project used for quota and billing purposes. May be null.clientId
- client ID of the service account from the console. May be null.clientSecret
- client secret of the service account from the console. May be null.scopes
- the scopes to request during the authorization grant. May be null.environmentProvider
- the environment provider. May be null. Defaults toSystemEnvironmentProvider
.
-
ExternalAccountCredentials
Internal constructor with minimum identifying information and custom HTTP transport. SeeExternalAccountCredentials.Builder
.- Parameters:
builder
- theBuilder
object used to construct the credentials.
-
-
Method Details
-
buildImpersonatedCredentials
ImpersonatedCredentials buildImpersonatedCredentials() -
getRequestMetadata
Description copied from class:Credentials
Get the current request metadata without blocking.This should be called by the transport layer on each request, and the data should be populated in headers or other context. The implementation can either call the callback inline or asynchronously. Either way it should never block in this method. The executor is provided for tasks that may block.
The default implementation will just call
Credentials.getRequestMetadata(URI)
then the callback from the given executor.The convention for handling binary data is for the key in the returned map to end with
"-bin"
and for the corresponding values to be base64 encoded.- Overrides:
getRequestMetadata
in classOAuth2Credentials
- Parameters:
uri
- URI of the entry point for the request.executor
- Executor to perform the request.callback
- Callback to execute when the request is finished.
-
getUniverseDomain
Description copied from class:GoogleCredentials
Gets the universe domain for the credential.- Overrides:
getUniverseDomain
in classGoogleCredentials
- Returns:
- An explicit universe domain if it was explicitly provided, invokes the super implementation otherwise
-
getRequestMetadata
Description copied from class:OAuth2Credentials
Provide the request metadata by ensuring there is a current access token and providing it as an authorization bearer token.- Overrides:
getRequestMetadata
in classOAuth2Credentials
- Parameters:
uri
- URI of the entry point for the request.- Returns:
- The request metadata used for populating headers or other context.
- Throws:
IOException
- if there was an error getting up-to-date access. The exception should implementRetryable
andisRetryable()
will return true if the operation may be retried.
-
fromStream
public static ExternalAccountCredentials fromStream(InputStream credentialsStream) throws IOException Returns credentials defined by a JSON file stream.Returns
IdentityPoolCredentials
orAwsCredentials
.- Parameters:
credentialsStream
- the stream with the credential definition- Returns:
- the credential defined by the credentialsStream
- Throws:
IOException
- if the credential cannot be created from the stream
-
fromStream
public static ExternalAccountCredentials fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory) throws IOException Returns credentials defined by a JSON file stream.Returns a
IdentityPoolCredentials
orAwsCredentials
.- Parameters:
credentialsStream
- the stream with the credential definitiontransportFactory
- the HTTP transport factory used to create the transport to get access tokens- Returns:
- the credential defined by the credentialsStream
- Throws:
IOException
- if the credential cannot be created from the stream
-
fromJson
static ExternalAccountCredentials fromJson(Map<String, Object> json, HttpTransportFactory transportFactory) Returns external account credentials defined by JSON using the format generated by gCloud.- Parameters:
json
- a map from the JSON representing the credentialstransportFactory
- HTTP transport factory, creates the transport used to get access tokens- Returns:
- the credentials defined by the JSON
-
isPluggableAuthCredential
-
isAwsCredential
-
shouldBuildImpersonatedCredential
private boolean shouldBuildImpersonatedCredential() -
exchangeExternalCredentialForAccessToken
protected AccessToken exchangeExternalCredentialForAccessToken(StsTokenExchangeRequest stsTokenExchangeRequest) throws IOException Exchanges the external credential for a Google Cloud access token.- Parameters:
stsTokenExchangeRequest
- the Security Token Service token exchange request- Returns:
- the access token returned by the Security Token Service
- Throws:
OAuthException
- if the call to the Security Token Service failsIOException
-
retrieveSubjectToken
Retrieves the external subject token to be exchanged for a Google Cloud access token.Must be implemented by subclasses as the retrieval method is dependent on the credential source.
- Returns:
- the external subject token
- Throws:
IOException
- if the subject token cannot be retrieved
-
getAudience
-
getSubjectTokenType
-
getTokenUrl
-
getTokenInfoUrl
-
getCredentialSource
-
readObject
- Throws:
IOException
ClassNotFoundException
-
getServiceAccountImpersonationUrl
-
getServiceAccountEmail
- Returns:
- The service account email to be impersonated, if available
-
getClientId
-
getClientSecret
-
getScopes
-
getWorkforcePoolUserProject
-
getServiceAccountImpersonationOptions
@Nullable public ExternalAccountCredentials.ServiceAccountImpersonationOptions getServiceAccountImpersonationOptions() -
getCredentialSourceType
String getCredentialSourceType() -
getEnvironmentProvider
EnvironmentProvider getEnvironmentProvider() -
isWorkforcePoolConfiguration
public boolean isWorkforcePoolConfiguration()- Returns:
- whether the current configuration is for Workforce Pools (which enable 3p user identities, rather than workloads)
-
validateTokenUrl
-
validateServiceAccountImpersonationInfoUrl
-
isValidUrl
Returns true if the provided URL's scheme is valid and is HTTPS.
-