Allow ProjectId to be read from Service Account Configuration.

foxxtrot · neozwu · commit 9ffb543c41c4 · 2017-06-30T15:36:53.000-07:00
For Firebase, we are using the Service Account configuration file parsed by GoogleCredential to set many of the values needed. We wish to pull the ProjectId from the GoogleCredential, rather than requiring that developers supply it separately. While all new versions of these files have the project_id field, older versions do not, and thus we can't make this a required field currently. Clients that require this field to have been present will need to verify this at a higher level. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=121412159
diff --git a/google-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/GoogleCredential.java b/google-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/GoogleCredential.java
@@ -271,6 +271,12 @@ public static GoogleCredential fromStream(InputStream credentialStream, HttpTran
    */
   private String serviceAccountId;
 
+  /**
+   * Service account Project ID or {@code null} if not present, either because this is not using the
+   * service account flow, or is using an older version of the service account configuration.
+   */
+  private String serviceAccountProjectId;
+
   /**
    * Collection of OAuth scopes to use with the service account flow or {@code null} if not
    * using the service account flow.
@@ -318,6 +324,7 @@ protected GoogleCredential(Builder builder) {
           && builder.serviceAccountScopes == null && builder.serviceAccountUser == null);
     } else {
       serviceAccountId = Preconditions.checkNotNull(builder.serviceAccountId);
+      serviceAccountProjectId = builder.serviceAccountProjectId;
       serviceAccountScopes = Collections.unmodifiableCollection(builder.serviceAccountScopes);
       serviceAccountPrivateKey = builder.serviceAccountPrivateKey;
       serviceAccountPrivateKeyId = builder.serviceAccountPrivateKeyId;
@@ -397,6 +404,15 @@ public final String getServiceAccountId() {
     return serviceAccountId;
   }
 
+  /**
+   * Returns the service account Project ID or {@code null} if not present, either because this is
+   * not using the service account flow, or is using an older version of the service account
+   * configuration.
+   */
+  public final String getServiceAccountProjectId() {
+    return serviceAccountProjectId;
+  }
+
   /**
    * Returns a collection of OAuth scopes to use with the service account flow or {@code null}
    * if not using the service account flow.
@@ -500,6 +516,9 @@ public static class Builder extends Credential.Builder {
     /** Id of the private key to use with the service account flow or {@code null} for none. */
     String serviceAccountPrivateKeyId;
 
+    /** Project Id associated with the Service Account */
+    String serviceAccountProjectId;
+
     /**
      * Email address of the user the application is trying to impersonate in the service account
      * flow or {@code null} for none.
@@ -582,6 +601,26 @@ public Builder setServiceAccountId(String serviceAccountId) {
       return this;
     }
 
+    /**
+     * Returns the service account Project ID or {@code null} for none.
+     */
+    public final String getServiceAccountProjectId() {
+      return serviceAccountProjectId;
+    }
+
+    /**
+     * Sets the service account Project ID or {@code null} for none.
+     *
+     * <p>
+     * Overriding is only supported for the purpose of calling the super implementation and changing
+     * the return type, but nothing else.
+     * </p>
+     */
+    public Builder setServiceAccountProjectId(String serviceAccountProjectId) {
+      this.serviceAccountProjectId = serviceAccountProjectId;
+      return this;
+    }
+
     /**
      * Returns a collection of OAuth scopes to use with the service account flow or {@code null}
      * for none.
@@ -780,7 +819,8 @@ private static GoogleCredential fromStreamServiceAccount(GenericJson fileContent
     String clientEmail = (String) fileContents.get("client_email");
     String privateKeyPem = (String) fileContents.get("private_key");
     String privateKeyId = (String) fileContents.get("private_key_id");
-    if (clientId == null || clientEmail == null || privateKeyPem == null || privateKeyId == null) {
+    if (clientId == null || clientEmail == null || privateKeyPem == null
+        || privateKeyId == null) {
       throw new IOException("Error reading service account credential from stream, "
           + "expecting  'client_id', 'client_email', 'private_key' and 'private_key_id'.");
     }
@@ -800,6 +840,11 @@ private static GoogleCredential fromStreamServiceAccount(GenericJson fileContent
     if (tokenUri != null) {
       credentialBuilder.setTokenServerEncodedUrl(tokenUri);
     }
+    String projectId = (String) fileContents.get("project_id");
+    if (projectId != null) {
+      credentialBuilder.setServiceAccountProjectId(projectId);
+    }
+
     // Don't do a refresh at this point, as it will always fail before the scopes are added.
     return credentialBuilder.build();
   }
