Package com.google.auth.oauth2
Class ImpersonatedCredentials
java.lang.Object
com.google.auth.Credentials
com.google.auth.oauth2.OAuth2Credentials
com.google.auth.oauth2.GoogleCredentials
com.google.auth.oauth2.ImpersonatedCredentials
- All Implemented Interfaces:
IdTokenProvider
,QuotaProjectIdProvider
,ServiceAccountSigner
,Serializable
public class ImpersonatedCredentials
extends GoogleCredentials
implements ServiceAccountSigner, IdTokenProvider
ImpersonatedCredentials allowing credentials issued to a user or service account to impersonate
another. The source project using ImpersonatedCredentials must enable the "IAMCredentials" API.
Also, the target service account must grant the originating principal the "Service Account Token
Creator" IAM role.
Usage:
String credPath = "/path/to/svc_account.json"; ServiceAccountCredentials sourceCredentials = ServiceAccountCredentials .fromStream(new FileInputStream(credPath)); sourceCredentials = (ServiceAccountCredentials) sourceCredentials .createScoped(Arrays.asList("https://www.googleapis.com/auth/iam")); ImpersonatedCredentials targetCredentials = ImpersonatedCredentials.create(sourceCredentials, "impersonated-account@project.iam.gserviceaccount.com", null, Arrays.asList("https://www.googleapis.com/auth/devstorage.read_only"), 300); Storage storage_service = StorageOptions.newBuilder().setProjectId("project-id") .setCredentials(targetCredentials).build().getService(); for (Bucket b : storage_service.list().iterateAll()) System.out.println(b);
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class com.google.auth.oauth2.OAuth2Credentials
OAuth2Credentials.AsyncRefreshResult, OAuth2Credentials.CacheState, OAuth2Credentials.CredentialsChangedListener, OAuth2Credentials.FutureCallbackToMetadataCallbackAdapter, OAuth2Credentials.OAuthValue, OAuth2Credentials.RefreshTask, OAuth2Credentials.RefreshTaskListener
Nested classes/interfaces inherited from interface com.google.auth.oauth2.IdTokenProvider
IdTokenProvider.Option
Nested classes/interfaces inherited from interface com.google.auth.ServiceAccountSigner
ServiceAccountSigner.SigningException
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Calendar
private static final String
private static final int
private String
(package private) static final String
private int
private static final String
private static final long
private GoogleCredentials
private String
private HttpTransportFactory
private final String
private static final int
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
ConstructorsModifierConstructorDescriptionprivate
-
Method Summary
Modifier and TypeMethodDescriptionstatic ImpersonatedCredentials
create
(GoogleCredentials sourceCredentials, String targetPrincipal, List<String> delegates, List<String> scopes, int lifetime) static ImpersonatedCredentials
create
(GoogleCredentials sourceCredentials, String targetPrincipal, List<String> delegates, List<String> scopes, int lifetime, HttpTransportFactory transportFactory) static ImpersonatedCredentials
create
(GoogleCredentials sourceCredentials, String targetPrincipal, List<String> delegates, List<String> scopes, int lifetime, HttpTransportFactory transportFactory, String quotaProjectId) static ImpersonatedCredentials
create
(GoogleCredentials sourceCredentials, String targetPrincipal, List<String> delegates, List<String> scopes, int lifetime, HttpTransportFactory transportFactory, String quotaProjectId, String iamEndpointOverride) createScoped
(Collection<String> scopes) If the credentials support scopes, creates a copy of the identity with the specified scopes, invalidates the existing scoped access token; otherwise, return the same instance.boolean
Indicates whether the credentials require scopes to be specified via a call toGoogleCredentials.createScoped(java.util.Collection<java.lang.String>)
before use.createWithCustomCalendar
(Calendar calendar) Clones the impersonated credentials with a new calendar.boolean
(package private) static String
extractTargetPrincipal
(String serviceAccountImpersonationUrl) (package private) static ImpersonatedCredentials
fromJson
(Map<String, Object> json, HttpTransportFactory transportFactory) Returns impersonation account credentials defined by JSON using the format generated by gCloud.Returns the email field of the serviceAccount that is being impersonated.(package private) String
(package private) int
Gets the credential type used for internal metrics header.Gets the universe domain for the credential.int
hashCode()
idTokenWithAudience
(String targetAudience, List<IdTokenProvider.Option> options) Returns an IdToken for the current Credential.private void
readObject
(ObjectInputStream input) Method to refresh the access token according to the specific type of credentials.void
setTransportFactory
(HttpTransportFactory httpTransportFactory) byte[]
sign
(byte[] toSign) Signs the provided bytes using the private key associated with the impersonated service accounttoString()
Methods inherited from class com.google.auth.oauth2.GoogleCredentials
addQuotaProjectIdToRequestMetadata, create, create, createDelegated, createScoped, createScoped, createWithCustomRetryStrategy, createWithQuotaProject, fromStream, fromStream, getAdditionalHeaders, getApplicationDefault, getApplicationDefault, getQuotaProjectId, isDefaultUniverseDomain, isExplicitUniverseDomain, toStringHelper
Methods inherited from class com.google.auth.oauth2.OAuth2Credentials
addChangeListener, getAccessToken, getAuthenticationType, getExpirationMargin, getFromServiceLoader, getRefreshMargin, getRequestMetadata, getRequestMetadata, getRequestMetadataInternal, hasRequestMetadata, hasRequestMetadataOnly, newInstance, refresh, refreshIfExpired, removeChangeListener
Methods inherited from class com.google.auth.Credentials
blockingGetToCallback, getRequestMetadata
-
Field Details
-
IMPERSONATED_CREDENTIALS_FILE_TYPE
- See Also:
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
RFC3339
- See Also:
-
TWELVE_HOURS_IN_SECONDS
private static final int TWELVE_HOURS_IN_SECONDS- See Also:
-
DEFAULT_LIFETIME_IN_SECONDS
private static final int DEFAULT_LIFETIME_IN_SECONDS- See Also:
-
CLOUD_PLATFORM_SCOPE
- See Also:
-
sourceCredentials
-
targetPrincipal
-
delegates
-
scopes
-
lifetime
private int lifetime -
iamEndpointOverride
-
transportFactoryClassName
-
transportFactory
-
calendar
-
-
Constructor Details
-
ImpersonatedCredentials
- Throws:
IOException
-
-
Method Details
-
create
public static ImpersonatedCredentials create(GoogleCredentials sourceCredentials, String targetPrincipal, List<String> delegates, List<String> scopes, int lifetime, HttpTransportFactory transportFactory) - Parameters:
sourceCredentials
- the source credential used to acquire the impersonated credentials. It should be either a user account credential or a service account credential.targetPrincipal
- the service account to impersonatedelegates
- the chained list of delegates required to grant the final access_token. If set, the sequence of identities must have "Service Account Token Creator" capability granted to the preceding identity. For example, if set to [serviceAccountB, serviceAccountC], the sourceCredential must have the Token Creator role on serviceAccountB. serviceAccountB must have the Token Creator on serviceAccountC. Finally, C must have Token Creator on target_principal. If unset, sourceCredential must have that role on targetPrincipal.scopes
- scopes to request during the authorization grantlifetime
- number of seconds the delegated credential should be valid. By default this value should be at most 3600. However, you can follow these instructions to set up the service account and extend the maximum lifetime to 43200 (12 hours). If the given lifetime is 0, default value 3600 will be used instead when creating the credentials.transportFactory
- HTTP transport factory that creates the transport used to get access tokens- Returns:
- new credentials
-
create
public static ImpersonatedCredentials create(GoogleCredentials sourceCredentials, String targetPrincipal, List<String> delegates, List<String> scopes, int lifetime, HttpTransportFactory transportFactory, String quotaProjectId) - Parameters:
sourceCredentials
- the source credential used to acquire the impersonated credentials. It should be either a user account credential or a service account credential.targetPrincipal
- the service account to impersonatedelegates
- the chained list of delegates required to grant the final access_token. If set, the sequence of identities must have "Service Account Token Creator" capability granted to the preceding identity. For example, if set to [serviceAccountB, serviceAccountC], the sourceCredential must have the Token Creator role on serviceAccountB. serviceAccountB must have the Token Creator on serviceAccountC. Finally, C must have Token Creator on target_principal. If unset, sourceCredential must have that role on targetPrincipal.scopes
- scopes to request during the authorization grantlifetime
- number of seconds the delegated credential should be valid. By default this value should be at most 3600. However, you can follow these instructions to set up the service account and extend the maximum lifetime to 43200 (12 hours). If the given lifetime is 0, default value 3600 will be used instead when creating the credentials.transportFactory
- HTTP transport factory that creates the transport used to get access tokens.quotaProjectId
- the project used for quota and billing purposes. Should be null unless the caller wants to use a project different from the one that owns the impersonated credential for billing/quota purposes.- Returns:
- new credentials
-
create
public static ImpersonatedCredentials create(GoogleCredentials sourceCredentials, String targetPrincipal, List<String> delegates, List<String> scopes, int lifetime, HttpTransportFactory transportFactory, String quotaProjectId, String iamEndpointOverride) - Parameters:
sourceCredentials
- the source credential used to acquire the impersonated credentials. It should be either a user account credential or a service account credential.targetPrincipal
- the service account to impersonatedelegates
- the chained list of delegates required to grant the final access_token. If set, the sequence of identities must have "Service Account Token Creator" capability granted to the preceding identity. For example, if set to [serviceAccountB, serviceAccountC], the sourceCredential must have the Token Creator role on serviceAccountB. serviceAccountB must have the Token Creator on serviceAccountC. Finally, C must have Token Creator on target_principal. If unset, sourceCredential must have that role on targetPrincipal.scopes
- scopes to request during the authorization grantlifetime
- number of seconds the delegated credential should be valid. By default this value should be at most 3600. However, you can follow these instructions to set up the service account and extend the maximum lifetime to 43200 (12 hours). If the given lifetime is 0, default value 3600 will be used instead when creating the credentials.transportFactory
- HTTP transport factory that creates the transport used to get access tokens.quotaProjectId
- the project used for quota and billing purposes. Should be null unless the caller wants to use a project different from the one that owns the impersonated credential for billing/quota purposes.iamEndpointOverride
- The full IAM endpoint override with the target_principal embedded. This is useful when supporting impersonation with regional endpoints.- Returns:
- new credentials
-
create
public static ImpersonatedCredentials create(GoogleCredentials sourceCredentials, String targetPrincipal, List<String> delegates, List<String> scopes, int lifetime) - Parameters:
sourceCredentials
- the source credential used to acquire the impersonated credentials. It should be either a user account credential or a service account credential.targetPrincipal
- the service account to impersonatedelegates
- the chained list of delegates required to grant the final access_token. If set, the sequence of identities must have "Service Account Token Creator" capability granted to the preceding identity. For example, if set to [serviceAccountB, serviceAccountC], the sourceCredential must have the Token Creator role on serviceAccountB. serviceAccountB must have the Token Creator on serviceAccountC. Finally, C must have Token Creator on target_principal. If left unset, sourceCredential must have that role on targetPrincipal.scopes
- scopes to request during the authorization grantlifetime
- number of seconds the delegated credential should be valid. By default this value should be at most 3600. However, you can follow these instructions to set up the service account and extend the maximum lifetime to 43200 (12 hours). https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials#sa-credentials-oauth If the given lifetime is 0, default value 3600 will be used instead when creating the credentials.- Returns:
- new credentials
-
extractTargetPrincipal
-
getAccount
Returns the email field of the serviceAccount that is being impersonated.- Specified by:
getAccount
in interfaceServiceAccountSigner
- Returns:
- email address of the impersonated service account
-
getIamEndpointOverride
String getIamEndpointOverride() -
getDelegates
-
getScopes
-
getSourceCredentials
-
getLifetime
int getLifetime() -
setTransportFactory
-
sign
public byte[] sign(byte[] toSign) Signs the provided bytes using the private key associated with the impersonated service account- Specified by:
sign
in interfaceServiceAccountSigner
- Parameters:
toSign
- bytes to sign- Returns:
- signed bytes
- Throws:
ServiceAccountSigner.SigningException
- if the attempt to sign the provided bytes failed- See Also:
-
fromJson
static ImpersonatedCredentials fromJson(Map<String, Object> json, HttpTransportFactory transportFactory) throws IOExceptionReturns impersonation account credentials defined by JSON using the format generated by gCloud. The source credentials in the JSON should be either user account credentials or service account credentials.- 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
- Throws:
IOException
- if the credential cannot be created from the JSON.
-
createScopedRequired
public boolean createScopedRequired()Description copied from class:GoogleCredentials
Indicates whether the credentials require scopes to be specified via a call toGoogleCredentials.createScoped(java.util.Collection<java.lang.String>)
before use.- Overrides:
createScopedRequired
in classGoogleCredentials
- Returns:
- Whether the credentials require scopes to be specified.
-
createScoped
Description copied from class:GoogleCredentials
If the credentials support scopes, creates a copy of the identity with the specified scopes, invalidates the existing scoped access token; otherwise, return the same instance.- Overrides:
createScoped
in classGoogleCredentials
- Parameters:
scopes
- Collection of scopes to request.- Returns:
- GoogleCredentials with requested scopes.
-
getMetricsCredentialType
Description copied from class:Credentials
Gets the credential type used for internal metrics header.The default is
CredentialTypeForMetrics.DO_NOT_SEND
. For a credential that is established to track for metrics, this default should be overridden.- Overrides:
getMetricsCredentialType
in classCredentials
- Returns:
- a enum value for credential type
-
createWithCustomCalendar
Clones the impersonated credentials with a new calendar.- Parameters:
calendar
- the calendar that will be used by the new ImpersonatedCredentials instance when parsing the received expiration time of the refreshed access token- Returns:
- the cloned impersonated credentials with the given custom calendar
-
getUniverseDomain
Gets the universe domain for the credential.- Overrides:
getUniverseDomain
in classGoogleCredentials
- Returns:
- the universe domain from source credentials
- Throws:
IOException
- extending classes might have to do remote calls to determine the universe domain. The exception must implementRetryable
andisRetryable()
will return true if the operation may be retried.
-
refreshAccessToken
Description copied from class:OAuth2Credentials
Method to refresh the access token according to the specific type of credentials.Throws IllegalStateException if not overridden since direct use of OAuth2Credentials is only for temporary or non-refreshing access tokens.
- Overrides:
refreshAccessToken
in classOAuth2Credentials
- Returns:
- never
- Throws:
IOException
-
idTokenWithAudience
public IdToken idTokenWithAudience(String targetAudience, List<IdTokenProvider.Option> options) throws IOException Returns an IdToken for the current Credential.- Specified by:
idTokenWithAudience
in interfaceIdTokenProvider
- Parameters:
targetAudience
- the audience field for the issued ID tokenoptions
- credential specific options for for the token. For example, an ID token for an ImpersonatedCredentials can return the email address within the token claims if "ImpersonatedCredentials.INCLUDE_EMAIL" is provided as a list option.
Only one option value is supported: "ImpersonatedCredentials.INCLUDE_EMAIL" If no options are set, the default excludes the "includeEmail" attribute in the API request.- Returns:
- IdToken object which includes the raw id_token, expiration, and audience
- Throws:
IOException
- if the attempt to get an ID token failed
-
hashCode
public int hashCode()- Overrides:
hashCode
in classGoogleCredentials
-
toString
- Overrides:
toString
in classGoogleCredentials
-
equals
- Overrides:
equals
in classGoogleCredentials
-
toBuilder
- Overrides:
toBuilder
in classGoogleCredentials
-
newBuilder
-
readObject
- Throws:
IOException
ClassNotFoundException
-