Class ServiceAccountCredentials

All Implemented Interfaces:
IdTokenProvider, JwtProvider, QuotaProjectIdProvider, ServiceAccountSigner, Serializable

public class ServiceAccountCredentials extends GoogleCredentials implements ServiceAccountSigner, IdTokenProvider, JwtProvider
OAuth2 credentials representing a Service Account for calling Google APIs.

By default uses a JSON Web Token (JWT) to fetch access tokens.

See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • GRANT_TYPE

      private static final String GRANT_TYPE
      See Also:
    • PARSE_ERROR_PREFIX

      private static final String PARSE_ERROR_PREFIX
      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:
    • clientId

      private final String clientId
    • clientEmail

      private final String clientEmail
    • privateKey

      private final PrivateKey privateKey
    • privateKeyId

      private final String privateKeyId
    • serviceAccountUser

      private final String serviceAccountUser
    • projectId

      private final String projectId
    • transportFactoryClassName

      private final String transportFactoryClassName
    • tokenServerUri

      private final URI tokenServerUri
    • scopes

      private final Collection<String> scopes
    • defaultScopes

      private final Collection<String> defaultScopes
    • lifetime

      private final int lifetime
    • useJwtAccessWithScope

      private final boolean useJwtAccessWithScope
    • defaultRetriesEnabled

      private final boolean defaultRetriesEnabled
    • transportFactory

      private transient HttpTransportFactory transportFactory
    • selfSignedJwtCredentialsWithScope

      private transient JwtCredentials selfSignedJwtCredentialsWithScope
  • Constructor Details

  • Method Details

    • fromJson

      static ServiceAccountCredentials fromJson(Map<String,Object> json, HttpTransportFactory transportFactory) throws IOException
      Returns service account credentials defined by JSON using the format supported by the Google Developers Console.
      Parameters:
      json - a map from the JSON representing the credentials.
      transportFactory - 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.
    • fromPkcs8

      public static ServiceAccountCredentials fromPkcs8(String clientId, String clientEmail, String privateKeyPkcs8, String privateKeyId, Collection<String> scopes) throws IOException
      Factory with minimum identifying information using PKCS#8 for the private key.
      Parameters:
      clientId - Client ID of the service account from the console. May be null.
      clientEmail - Client email address of the service account from the console.
      privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.
      privateKeyId - Private key identifier for the service account. May be null.
      scopes - Scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.
      Returns:
      New ServiceAccountCredentials created from a private key.
      Throws:
      IOException - if the credential cannot be created from the private key.
    • fromPkcs8

      public static ServiceAccountCredentials fromPkcs8(String clientId, String clientEmail, String privateKeyPkcs8, String privateKeyId, Collection<String> scopes, Collection<String> defaultScopes) throws IOException
      Factory with minimum identifying information using PKCS#8 for the private key.
      Parameters:
      clientId - client ID of the service account from the console. May be null.
      clientEmail - client email address of the service account from the console
      privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.
      privateKeyId - private key identifier for the service account. May be null.
      scopes - scope strings for the APIs to be called. May be null or an empty collection.
      defaultScopes - default scope strings for the APIs to be called. May be null or an empty.
      Returns:
      new ServiceAccountCredentials created from a private key
      Throws:
      IOException - if the credential cannot be created from the private key
    • fromPkcs8

      public static ServiceAccountCredentials fromPkcs8(String clientId, String clientEmail, String privateKeyPkcs8, String privateKeyId, Collection<String> scopes, HttpTransportFactory transportFactory, URI tokenServerUri) throws IOException
      Factory with minimum identifying information and custom transport using PKCS#8 for the private key.
      Parameters:
      clientId - Client ID of the service account from the console. May be null.
      clientEmail - Client email address of the service account from the console.
      privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.
      privateKeyId - Private key identifier for the service account. May be null.
      scopes - Scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.
      transportFactory - HTTP transport factory, creates the transport used to get access tokens.
      tokenServerUri - URI of the end point that provides tokens.
      Returns:
      New ServiceAccountCredentials created from a private key.
      Throws:
      IOException - if the credential cannot be created from the private key.
    • fromPkcs8

      public static ServiceAccountCredentials fromPkcs8(String clientId, String clientEmail, String privateKeyPkcs8, String privateKeyId, Collection<String> scopes, Collection<String> defaultScopes, HttpTransportFactory transportFactory, URI tokenServerUri) throws IOException
      Factory with minimum identifying information and custom transport using PKCS#8 for the private key.
      Parameters:
      clientId - client ID of the service account from the console. May be null.
      clientEmail - client email address of the service account from the console
      privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.
      privateKeyId - private key identifier for the service account. May be null.
      scopes - scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.
      defaultScopes - default scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.
      transportFactory - HTTP transport factory, creates the transport used to get access tokens.
      tokenServerUri - URI of the end point that provides tokens
      Returns:
      new ServiceAccountCredentials created from a private key
      Throws:
      IOException - if the credential cannot be created from the private key
    • fromPkcs8

      public static ServiceAccountCredentials fromPkcs8(String clientId, String clientEmail, String privateKeyPkcs8, String privateKeyId, Collection<String> scopes, HttpTransportFactory transportFactory, URI tokenServerUri, String serviceAccountUser) throws IOException
      Factory with minimum identifying information and custom transport using PKCS#8 for the private key.
      Parameters:
      clientId - Client ID of the service account from the console. May be null.
      clientEmail - Client email address of the service account from the console.
      privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.
      privateKeyId - Private key identifier for the service account. May be null.
      scopes - Scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.
      transportFactory - HTTP transport factory, creates the transport used to get access tokens.
      tokenServerUri - URI of the end point that provides tokens.
      serviceAccountUser - The email of the user account to impersonate, if delegating domain-wide authority to the service account.
      Returns:
      New ServiceAccountCredentials created from a private key.
      Throws:
      IOException - if the credential cannot be created from the private key.
    • fromPkcs8

      public static ServiceAccountCredentials fromPkcs8(String clientId, String clientEmail, String privateKeyPkcs8, String privateKeyId, Collection<String> scopes, Collection<String> defaultScopes, HttpTransportFactory transportFactory, URI tokenServerUri, String serviceAccountUser) throws IOException
      Factory with minimum identifying information and custom transport using PKCS#8 for the private key.
      Parameters:
      clientId - client ID of the service account from the console. May be null.
      clientEmail - client email address of the service account from the console
      privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.
      privateKeyId - private key identifier for the service account. May be null.
      scopes - scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.
      defaultScopes - default scope strings for the APIs to be called. May be null or an empty collection, which results in a credential that must have createScoped called before use.
      transportFactory - HTTP transport factory, creates the transport used to get access tokens.
      tokenServerUri - URI of the end point that provides tokens
      serviceAccountUser - the email of the user account to impersonate, if delegating domain-wide authority to the service account.
      Returns:
      new ServiceAccountCredentials created from a private key
      Throws:
      IOException - if the credential cannot be created from the private key
    • fromPkcs8

      static ServiceAccountCredentials fromPkcs8(String privateKeyPkcs8, ServiceAccountCredentials.Builder builder) throws IOException
      Internal constructor
      Parameters:
      privateKeyPkcs8 - RSA private key object for the service account in PKCS#8 format.
      builder - A builder for ServiceAccountCredentials See ServiceAccountCredentials.Builder
      Returns:
      an instance of ServiceAccountCredentials
      Throws:
      IOException
    • fromStream

      public static ServiceAccountCredentials fromStream(InputStream credentialsStream) throws IOException
      Returns credentials defined by a Service Account key file in JSON format from the Google Developers Console.
      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 ServiceAccountCredentials fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory) throws IOException
      Returns credentials defined by a Service Account key file in JSON format from the Google Developers Console.
      Parameters:
      credentialsStream - the stream with the credential definition.
      transportFactory - HTTP transport factory, creates the transport used to get access tokens.
      Returns:
      the credential defined by the credentialsStream.
      Throws:
      IOException - if the credential cannot be created from the stream.
    • createScopedRequired

      public boolean createScopedRequired()
      Returns whether the scopes are empty, meaning createScoped must be called before use.
      Overrides:
      createScopedRequired in class GoogleCredentials
      Returns:
      Whether the credentials require scopes to be specified.
    • isConfiguredForDomainWideDelegation

      boolean isConfiguredForDomainWideDelegation()
      Returns true if credential is configured domain wide delegation
    • refreshAccessToken

      public AccessToken refreshAccessToken() throws IOException
      Refreshes the OAuth2 access token by getting a new access token using a JSON Web Token (JWT).
      Overrides:
      refreshAccessToken in class OAuth2Credentials
      Returns:
      never
      Throws:
      IOException
    • idTokenWithAudience

      public IdToken idTokenWithAudience(String targetAudience, List<IdTokenProvider.Option> options) throws IOException
      Returns a Google ID Token from either the Oauth or IAM Endpoint. For Credentials that are in the Google Default Universe (googleapis.com), the ID Token will be retrieved from the Oauth Endpoint. Otherwise, it will be retrieved from the IAM Endpoint.
      Specified by:
      idTokenWithAudience in interface IdTokenProvider
      Parameters:
      targetAudience - the aud: field the IdToken should include.
      options - list of Credential specific options for the token. Currently, unused for ServiceAccountCredentials.
      Returns:
      IdToken object which includes the raw id_token, expiration and audience
      Throws:
      IOException - if the attempt to get an IdToken failed
    • getIdTokenOauthEndpoint

      private IdToken getIdTokenOauthEndpoint(String targetAudience) throws IOException
      Uses the Oauth Endpoint to generate an ID token. Assertions and grant_type are sent in the request body.
      Throws:
      IOException
    • getIdTokenIamEndpoint

      private IdToken getIdTokenIamEndpoint(String targetAudience) throws IOException
      Use IAM generateIdToken endpoint to obtain an ID token.

      This flow works as follows:

      1. Create a self-signed jwt with `https://www.googleapis.com/auth/iam` as the scope.
      2. Use the self-signed jwt as the access token, and make a POST request to IAM generateIdToken endpoint.
      3. If the request is successfully, it will return {"token":"the ID token"}. Extract the ID token.
      Throws:
      IOException
    • buildIdTokenRequest

      private com.google.api.client.http.HttpRequest buildIdTokenRequest(URI uri, HttpTransportFactory transportFactory, com.google.api.client.http.HttpContent content) throws IOException
      Throws:
      IOException
    • executeRequest

      private com.google.api.client.http.HttpResponse executeRequest(com.google.api.client.http.HttpRequest request) throws IOException
      Throws:
      IOException
    • createWithCustomRetryStrategy

      public ServiceAccountCredentials createWithCustomRetryStrategy(boolean defaultRetriesEnabled)
      Clones the service account with the specified default retries.
      Overrides:
      createWithCustomRetryStrategy in class GoogleCredentials
      Parameters:
      defaultRetriesEnabled - a flag enabling or disabling default retries
      Returns:
      GoogleCredentials with the specified retry configuration.
    • createScoped

      public GoogleCredentials createScoped(Collection<String> newScopes)
      Clones the service account with the specified scopes.

      Should be called before use for instances with empty scopes.

      Overrides:
      createScoped in class GoogleCredentials
      Parameters:
      newScopes - Collection of scopes to request.
      Returns:
      GoogleCredentials with requested scopes.
    • createScoped

      public GoogleCredentials createScoped(Collection<String> newScopes, Collection<String> newDefaultScopes)
      Clones the service account with the specified scopes. The Access Token is invalidated even if the same scopes are provided. Access Tokens contain information of the internal values (i.e. scope). If an internal value (scope) is modified, then the existing Access Token is no longer valid and should not be re-used.

      Should be called before use for instances with empty scopes.

      Overrides:
      createScoped in class GoogleCredentials
      Parameters:
      newScopes - Collection of scopes to request.
      newDefaultScopes - Collection of default scopes to request.
      Returns:
      GoogleCredentials with requested scopes.
    • createWithCustomLifetime

      public ServiceAccountCredentials createWithCustomLifetime(int lifetime)
      Clones the service account with a new lifetime value.
      Parameters:
      lifetime - life time value in seconds. The value should be at most 43200 (12 hours). If the token is used for calling a Google API, then the value should be at most 3600 (1 hour). If the given value is 0, then the default value 3600 will be used when creating the credentials.
      Returns:
      the cloned service account credentials with the given custom life time
    • createWithUseJwtAccessWithScope

      public ServiceAccountCredentials createWithUseJwtAccessWithScope(boolean useJwtAccessWithScope)
      Clones the service account with a new useJwtAccessWithScope value. This flag will be ignored if universeDomain field is different from Credentials.GOOGLE_DEFAULT_UNIVERSE.
      Parameters:
      useJwtAccessWithScope - whether self-signed JWT with scopes should be used
      Returns:
      the cloned service account credentials with the given useJwtAccessWithScope
    • createDelegated

      public GoogleCredentials createDelegated(String user)
      Description copied from class: GoogleCredentials
      If the credentials support domain-wide delegation, creates a copy of the identity so that it impersonates the specified user; otherwise, returns the same instance.
      Overrides:
      createDelegated in class GoogleCredentials
      Parameters:
      user - User to impersonate.
      Returns:
      GoogleCredentials with a delegated user.
    • getClientId

      public final String getClientId()
    • getClientEmail

      public final String getClientEmail()
    • getPrivateKey

      public final PrivateKey getPrivateKey()
    • getPrivateKeyId

      public final String getPrivateKeyId()
    • getScopes

      public final Collection<String> getScopes()
    • getDefaultScopes

      public final Collection<String> getDefaultScopes()
    • getServiceAccountUser

      public final String getServiceAccountUser()
    • getProjectId

      public final String getProjectId()
    • getTokenServerUri

      public final URI getTokenServerUri()
    • getIssuer

      private String getIssuer()
    • getLifetime

      int getLifetime()
    • getUseJwtAccessWithScope

      public boolean getUseJwtAccessWithScope()
    • getSelfSignedJwtCredentialsWithScope

      JwtCredentials getSelfSignedJwtCredentialsWithScope()
    • getAccount

      public String getAccount()
      Description copied from interface: ServiceAccountSigner
      Returns the service account associated with the signer.
      Specified by:
      getAccount in interface ServiceAccountSigner
      Returns:
      The service account associated with the signer.
    • sign

      public byte[] sign(byte[] toSign)
      Description copied from interface: ServiceAccountSigner
      Signs the provided bytes using the private key associated with the service account.
      Specified by:
      sign in interface ServiceAccountSigner
      Parameters:
      toSign - bytes to sign
      Returns:
      signed bytes
    • jwtWithClaims

      public JwtCredentials jwtWithClaims(JwtClaims newClaims)
      Returns a new JwtCredentials instance with modified claims.
      Specified by:
      jwtWithClaims in interface JwtProvider
      Parameters:
      newClaims - new claims. Any unspecified claim fields will default to the current values.
      Returns:
      new credentials
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class GoogleCredentials
    • toStringHelper

      protected com.google.common.base.MoreObjects.ToStringHelper toStringHelper()
      Description copied from class: GoogleCredentials
      A helper for overriding the toString() method. This allows inheritance of super class fields. Extending classes can override this implementation and call super implementation and add more fields. Same cannot be done with overriding the toString() directly.
      Overrides:
      toStringHelper in class GoogleCredentials
      Returns:
      an instance of the ToStringHelper that has public fields added
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class GoogleCredentials
    • createAssertion

      String createAssertion(com.google.api.client.json.JsonFactory jsonFactory, long currentTime) throws IOException
      Throws:
      IOException
    • createAssertionForIdToken

      String createAssertionForIdToken(long currentTime, String audience, String targetAudience) throws IOException
      Throws:
      IOException
    • getUriForSelfSignedJWT

      static URI getUriForSelfSignedJWT(URI uri)
      Self-signed JWT uses uri as audience, which should have the "https://{host}/" format. For instance, if the uri is "https://compute.googleapis.com/compute/v1/projects/", then this function returns "https://compute.googleapis.com/".
    • createSelfSignedJwtCredentials

      JwtCredentials createSelfSignedJwtCredentials(URI uri)
    • createSelfSignedJwtCredentials

      JwtCredentials createSelfSignedJwtCredentials(URI uri, Collection<String> scopes)
    • getRequestMetadata

      public void getRequestMetadata(URI uri, Executor executor, RequestMetadataCallback callback)
      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 class OAuth2Credentials
      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.
    • getRequestMetadata

      public Map<String,List<String>> getRequestMetadata(URI uri) throws IOException
      Provide the request metadata by putting an access JWT directly in the metadata.
      Overrides:
      getRequestMetadata in class OAuth2Credentials
      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 implement Retryable and isRetryable() will return true if the operation may be retried.
    • getMetricsCredentialType

      public CredentialTypeForMetrics 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 class Credentials
      Returns:
      a enum value for credential type
    • shouldUseAssertionFlowForGdu

      boolean shouldUseAssertionFlowForGdu()
    • getRequestMetadataForGdu

      private Map<String,List<String>> getRequestMetadataForGdu(URI uri) throws IOException
      Throws:
      IOException
    • getRequestMetadataForNonGdu

      private Map<String,List<String>> getRequestMetadataForNonGdu(URI uri) throws IOException
      Throws:
      IOException
    • getRequestMetadataWithSelfSignedJwt

      private Map<String,List<String>> getRequestMetadataWithSelfSignedJwt(URI uri) throws IOException
      Provide the access JWT for scopes if provided, for uri as aud otherwise
      Throws:
      IOException
    • readObject

      private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException
      Throws:
      IOException
      ClassNotFoundException
    • newBuilder

      public static ServiceAccountCredentials.Builder newBuilder()
    • toBuilder

      Overrides:
      toBuilder in class GoogleCredentials