Handle optional fields with null JSON value gracefully

Author: clementdenis

oauth2_http/java/com/google/auth/oauth2/ExternalAccountCredentials.java

@@ -36,6 +36,7 @@
 import com.google.api.client.http.HttpHeaders;
 import com.google.api.client.json.GenericJson;
 import com.google.api.client.json.JsonObjectParser;
+import com.google.api.client.util.Data;
 import com.google.auth.RequestMetadataCallback;
 import com.google.auth.http.HttpTransportFactory;
 import com.google.common.base.MoreObjects;
@@ -418,15 +419,15 @@ static ExternalAccountCredentials fromJson(
     Map<String, Object> credentialSourceMap = (Map<String, Object>) json.get("credential_source");
 
     // Optional params.
-    String serviceAccountImpersonationUrl = (String) json.get("service_account_impersonation_url");
-    String tokenInfoUrl = (String) json.get("token_info_url");
-    String clientId = (String) json.get("client_id");
-    String clientSecret = (String) json.get("client_secret");
-    String quotaProjectId = (String) json.get("quota_project_id");
-    String userProject = (String) json.get("workforce_pool_user_project");
-    String universeDomain = (String) json.get("universe_domain");
+    String serviceAccountImpersonationUrl = getOptional(json, "service_account_impersonation_url", String.class);
+    String tokenInfoUrl = getOptional(json, "token_info_url", String.class);
+    String clientId = getOptional(json, "client_id", String.class);
+    String clientSecret = getOptional(json, "client_secret", String.class);
+    String quotaProjectId = getOptional(json, "quota_project_id", String.class);
+    String userProject = getOptional(json, "workforce_pool_user_project", String.class);
+    String universeDomain = getOptional(json, "universe_domain", String.class);
     Map<String, Object> impersonationOptionsMap =
-        (Map<String, Object>) json.get("service_account_impersonation");
+            getOptional(json, "service_account_impersonation", Map.class);
 
     if (impersonationOptionsMap == null) {
       impersonationOptionsMap = new HashMap<String, Object>();
@@ -481,6 +482,14 @@ static ExternalAccountCredentials fromJson(
         .build();
   }
 
+  private static <T> T getOptional(Map<String, Object> json, String fieldName, Class<T> clazz) {
+    Object value = json.get(fieldName);
+    if (value == null || Data.isNull(value)) {
+      return null;
+    }
+    return clazz.cast(value);
+  }
+
   private static boolean isPluggableAuthCredential(Map<String, Object> credentialSource) {
     // Pluggable Auth is enabled via a nested executable field in the credential source.
     return credentialSource.containsKey(EXECUTABLE_SOURCE_KEY);

oauth2_http/javatests/com/google/auth/oauth2/ExternalAccountCredentialsTest.java

@@ -148,6 +148,19 @@ public void fromStream_nullTransport_throws() throws IOException {
     }
   }
 
+  @Test
+  public void fromStream_nullOptionalField() throws IOException {
+    ExternalAccountCredentials credentials = ExternalAccountCredentials.fromStream(
+            new ByteArrayInputStream(("{" +
+                                      "\"service_account_impersonation_url\": null," +
+                                      //required
+                                      "\"audience\": \"audience\"," +
+                                      "\"subject_token_type\": \"subjectTokenType\"," +
+                                      "\"credential_source\": {\"file\":\"file\"}" +
+                                      "}").getBytes()));
+    assertNull(credentials.getServiceAccountImpersonationUrl());
+  }
+
   @Test
   public void fromStream_nullStream_throws() throws IOException {
     try {