AWS AppSync Android SDK version 2.6.18

Author: minbi

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log - AWS AppSync SDK for Android
 
+## [Release 2.6.18](https://github.com/awslabs/aws-mobile-appsync-sdk-android/releases/tag/release_v2.6.18)
+
+### New Features
+
+* Adds OpenID Connect (OIDC) support as an authorization option.
+
 ## [Release 2.6.17](https://github.com/awslabs/aws-mobile-appsync-sdk-android/releases/tag/release_v2.6.17)
 
 ### Enhancements

README.md

@@ -19,19 +19,19 @@ Android library files for Offline, Sync, Sigv4.
 In the project's `build.gradle`, add the following dependency in
 the build script:
 
-```
-    classpath 'com.amazonaws:aws-android-sdk-appsync-gradle-plugin:2.6.17'
+```groovy
+    classpath 'com.amazonaws:aws-android-sdk-appsync-gradle-plugin:2.6.18'
 ```
 
 **Sample project's build.gradle**
 
-```
+```groovy
     // Top-level build file where you can add configuration options common to all sub-projects/modules.
     buildscript {
         // ..other code..
         dependencies {
             classpath 'com.android.tools.build:gradle:3.0.1'
-            classpath 'com.amazonaws:aws-android-sdk-appsync-gradle-plugin:2.6.17'
+            classpath 'com.amazonaws:aws-android-sdk-appsync-gradle-plugin:2.6.18'
             // NOTE: Do not place your application dependencies here; they belong
             // in the individual module build.gradle files
         }
@@ -42,27 +42,27 @@ the build script:
 
 In the app's `build.gradle`, add the following plugin:
 
-```
+```groovy
     apply plugin: 'com.amazonaws.appsync'
 ```
 
 Add the following dependency:
 
-```
-    compile 'com.amazonaws:aws-android-sdk-appsync:2.6.17'
+```groovy
+    compile 'com.amazonaws:aws-android-sdk-appsync:2.6.18'
 ```
 
 **Sample app's build.gradle**
 
-```
+```groovy
     apply plugin: 'com.android.application'
     apply plugin: 'com.amazonaws.appsync'
     android {
         // Typical items
     }
     dependencies {
         // Typical dependencies
-        compile 'com.amazonaws:aws-android-sdk-appsync:2.6.17'
+        compile 'com.amazonaws:aws-android-sdk-appsync:2.6.18'
     }
 ```
 
@@ -71,7 +71,7 @@ Add the following dependency:
 Add the permissions to access network state to determine if the device
 is offline.
 
-```
+```xml
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 ```
 
@@ -113,7 +113,7 @@ are added in the build path.
 
 ## Create a client
 
-```
+```java
 AWSAppSyncClient client = AWSAppSyncClient.builder()
                     .context(context)
                     .apiKey(new BasicAPIKeyAuthProvider(Constants.APPSYNC_API_KEY)) // API Key based authorization
@@ -124,7 +124,7 @@ AWSAppSyncClient client = AWSAppSyncClient.builder()
 
 ## Make a call
 
-```
+```java
 public void addPost() {
 	AddPostMutation addPostMutation = AddPostMutation.builder()
             .id(UUID.randomUUID().toString())

aws-android-sdk-appsync-compiler/src/generated/kotlin/com/apollographql/android/Version.kt

@@ -1,3 +1,3 @@
 // Generated file. Do not edit!
 package com.apollographql.android
-val VERSION = "2.6.17"
+val VERSION = "2.6.18"

aws-android-sdk-appsync/src/main/java/com/amazonaws/mobileconnectors/appsync/AWSAppSyncClient.java

@@ -26,6 +26,7 @@
 import com.amazonaws.mobileconnectors.appsync.sigv4.APIKeyAuthProvider;
 import com.amazonaws.mobileconnectors.appsync.sigv4.AppSyncSigV4SignerInterceptor;
 import com.amazonaws.mobileconnectors.appsync.sigv4.CognitoUserPoolsAuthProvider;
+import com.amazonaws.mobileconnectors.appsync.sigv4.OidcAuthProvider;
 import com.amazonaws.mobileconnectors.appsync.subscription.RealSubscriptionManager;
 import com.amazonaws.regions.Regions;
 import com.apollographql.apollo.ApolloClient;
@@ -73,6 +74,8 @@ private AWSAppSyncClient(AWSAppSyncClient.Builder builder) {
             appSyncSigV4SignerInterceptor = new AppSyncSigV4SignerInterceptor(builder.mCredentialsProvider, builder.mRegion.getName());
         } else if (builder.mCognitoUserPoolsAuthProvider != null) {
             appSyncSigV4SignerInterceptor = new AppSyncSigV4SignerInterceptor(builder.mCognitoUserPoolsAuthProvider, builder.mRegion.getName());
+        } else if (builder.mOidcAuthProvider != null) {
+            appSyncSigV4SignerInterceptor = new AppSyncSigV4SignerInterceptor(builder.mOidcAuthProvider);
         } else if (builder.mApiKey != null) {
             appSyncSigV4SignerInterceptor = new AppSyncSigV4SignerInterceptor(builder.mApiKey, builder.mRegion.getName());
         } else {
@@ -155,6 +158,7 @@ public static class Builder {
         AWSCredentialsProvider mCredentialsProvider;
         APIKeyAuthProvider mApiKey;
         CognitoUserPoolsAuthProvider mCognitoUserPoolsAuthProvider;
+        OidcAuthProvider mOidcAuthProvider;
         NormalizedCacheFactory mNormalizedCacheFactory;
         CacheKeyResolver mResolver;
         ConflictResolverInterface mConflictResolver;
@@ -194,6 +198,11 @@ public Builder cognitoUserPoolsAuthProvider(CognitoUserPoolsAuthProvider cognito
             return this;
         }
 
+        public Builder oidcAuthProvider(OidcAuthProvider oidcAuthProvider) {
+            mOidcAuthProvider = oidcAuthProvider;
+            return this;
+        }
+
         public Builder serverUrl(String serverUrl) {
             mServerUrl = serverUrl;
             return this;

aws-android-sdk-appsync/src/main/java/com/amazonaws/mobileconnectors/appsync/sigv4/AppSyncSigV4SignerInterceptor.java

@@ -47,20 +47,22 @@ public class AppSyncSigV4SignerInterceptor implements Interceptor {
     private final AWSCredentialsProvider credentialsProvider;
     private final APIKeyAuthProvider apiKey;
     private final CognitoUserPoolsAuthProvider cognitoUserPoolsAuthProvider;
+    private final OidcAuthProvider oidcAuthProvider;
     private final String awsRegion;
     private final AuthMode authMode;
 
     private enum AuthMode {
         API_KEY,
         IAM,
-        USER_POOL
+        AUTHORIZATION_TOKEN
     }
 
     public AppSyncSigV4SignerInterceptor(APIKeyAuthProvider apiKey, final String awsRegion){
         this.apiKey = apiKey;
         this.awsRegion = awsRegion;
         this.credentialsProvider = null;
         this.cognitoUserPoolsAuthProvider = null;
+        this.oidcAuthProvider = null;
         authMode = AuthMode.API_KEY;
     }
 
@@ -69,6 +71,7 @@ public AppSyncSigV4SignerInterceptor(AWSCredentialsProvider credentialsProvider,
         this.awsRegion = awsRegion;
         this.apiKey = null;
         this.cognitoUserPoolsAuthProvider = null;
+        this.oidcAuthProvider = null;
         authMode = AuthMode.IAM;
     }
 
@@ -77,7 +80,17 @@ public AppSyncSigV4SignerInterceptor(CognitoUserPoolsAuthProvider cognitoUserPoo
         this.awsRegion = awsRegion;
         this.apiKey = null;
         this.cognitoUserPoolsAuthProvider = cognitoUserPoolsAuthProvider;
-        authMode = AuthMode.USER_POOL;
+        this.oidcAuthProvider = null;
+        authMode = AuthMode.AUTHORIZATION_TOKEN;
+    }
+
+    public AppSyncSigV4SignerInterceptor(OidcAuthProvider oidcAuthProvider){
+        this.credentialsProvider = null;
+        this.awsRegion = null;
+        this.apiKey = null;
+        this.cognitoUserPoolsAuthProvider = null;
+        this.oidcAuthProvider = oidcAuthProvider;
+        authMode = AuthMode.AUTHORIZATION_TOKEN;
     }
 
     @Override
@@ -99,13 +112,20 @@ public Response intercept(Chain chain) throws IOException {
         dr.setHttpMethod(HttpMethodName.valueOf(req.method()));
         if (AuthMode.API_KEY.equals(authMode)) {
             dr.addHeader("x-api-key", apiKey.getAPIKey());
-        } else if (AuthMode.USER_POOL.equals(authMode)) {
+        } else if (AuthMode.AUTHORIZATION_TOKEN.equals(authMode) && cognitoUserPoolsAuthProvider != null) {
             try {
                 dr.addHeader("authorization", cognitoUserPoolsAuthProvider.getLatestAuthToken());
             } catch (Exception e) {
                 IOException ioe = new IOException("Failed to retrieve Cognito User Pools token.", e);
                 throw ioe;
             }
+        } else if (AuthMode.AUTHORIZATION_TOKEN.equals(authMode) && oidcAuthProvider != null) {
+            try {
+                dr.addHeader("authorization", oidcAuthProvider.getLatestAuthToken());
+            } catch (Exception e) {
+                IOException ioe = new IOException("Failed to retrieve OIDC token.", e);
+                throw ioe;
+            }
         }
 
         dr.addHeader(HEADER_USER_AGENT, VersionInfoUtils.getUserAgent());

aws-android-sdk-appsync/src/main/java/com/amazonaws/mobileconnectors/appsync/sigv4/OidcAuthProvider.java

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2018-2018 Amazon.com,
+ * Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Amazon Software License (the "License").
+ * You may not use this file except in compliance with the
+ * License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/asl/
+ *
+ * or in the "license" file accompanying this file. This file is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, express or implied. See the License
+ * for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.amazonaws.mobileconnectors.appsync.sigv4;
+
+public interface OidcAuthProvider {
+    public String getLatestAuthToken();
+}

gradle.properties

@@ -13,7 +13,7 @@ org.gradle.jvmargs=-Xmx1536m
 org.gradle.parallel=true
 
 GROUP=com.amazonaws
-VERSION_NAME=2.6.17
+VERSION_NAME=2.6.18
 
 POM_URL=https://github.com/awslabs/aws-mobile-appsync-sdk-android
 POM_SCM_URL=https://github.com/awslabs/aws-mobile-appsync-sdk-android