Skip to content

[flutter_appauth] Refactor authorization handling to support multiple response types in OAuth flows #666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kangatahy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[flutter_appauth] Refactor authorization handling to support multiple response types in OAuth flows #666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions flutter_appauth/android/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,5 @@ android {

dependencies {
implementation 'net.openid:appauth:0.11.1'
implementation 'androidx.browser:browser:1.8.0'
}
15 changes: 13 additions & 2 deletions flutter_appauth/android/src/main/AndroidManifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,18 @@
xmlns:tools="http://schemas.android.com/tools">
<application>
<activity android:name="net.openid.appauth.RedirectUriReceiverActivity"
android:theme="@style/Theme.AppCompat.Translucent.NoTitleBar"
tools:replace="android:theme" />
tools:node="remove" />

<activity
android:name=".FlutterAppAuthRedirectUriReceiverActivity"
android:exported="true"
android:theme="@style/Theme.AppCompat.Translucent.NoTitleBar">
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="${appAuthRedirectScheme}" />
</intent-filter>
</activity>
</application>
</manifest>
29 changes: 29 additions & 0 deletions .../java/io/crossingthestreams/flutterappauth/FlutterAppAuthRedirectUriReceiverActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package io.crossingthestreams.flutterappauth;

import android.net.Uri;
import android.os.Bundle;
import androidx.appcompat.app.AppCompatActivity;
import net.openid.appauth.AuthorizationManagementActivity;

/**
* Receives OAuth redirect URIs for flutter_appauth.
*
* <p>Implicit flows ({@code id_token token}, etc.) are handled manually so query and fragment
* parameters are both parsed. Authorization code flows are forwarded to AppAuth as usual.
*/
public class FlutterAppAuthRedirectUriReceiverActivity extends AppCompatActivity {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);

Uri uri = getIntent() != null ? getIntent().getData() : null;
if (FlutterAppauthPlugin.handleManualImplicitRedirectUri(uri)) {
finish();
return;
}

startActivity(
AuthorizationManagementActivity.createResponseHandlingIntent(this, uri));
finish();
}
}
149 changes: 141 additions & 8 deletions ...auth/android/src/main/java/io/crossingthestreams/flutterappauth/FlutterAppauthPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
import android.content.Context;
import android.content.Intent;
import android.net.Uri;
import android.text.TextUtils;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.browser.customtabs.CustomTabsIntent;

import net.openid.appauth.AppAuthConfiguration;
import net.openid.appauth.AuthorizationException;
Expand All @@ -30,6 +32,7 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;

import io.flutter.embedding.engine.plugins.FlutterPlugin;
Expand Down Expand Up @@ -85,6 +88,8 @@ public class FlutterAppauthPlugin
private final int RC_AUTH = 65031;
private final int RC_END_SESSION = 65032;

private static @Nullable FlutterAppauthPlugin instance;

private Context applicationContext;
private Activity mainActivity;
private PendingOperation pendingOperation;
Expand All @@ -94,6 +99,7 @@ public class FlutterAppauthPlugin
private AuthorizationService insecureAuthorizationService;

private void onAttachedToEngine(Context context, BinaryMessenger binaryMessenger) {
instance = this;
this.applicationContext = context;
createAuthorizationServices();
final MethodChannel channel =
Expand All @@ -108,6 +114,9 @@ public void onAttachedToEngine(FlutterPluginBinding binding) {

@Override
public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
if (instance == this) {
instance = null;
}
disposeAuthorizationServices();
}

Expand Down Expand Up @@ -221,6 +230,7 @@ private AuthorizationTokenRequestParameters processAuthorizationTokenRequestArgu
(Map<String, String>) arguments.get("additionalParameters");
allowInsecureConnections = (boolean) arguments.get("allowInsecureConnections");
final String responseMode = (String) arguments.get("responseMode");
final ArrayList<String> responseTypes = (ArrayList<String>) arguments.get("responseTypes");

return new AuthorizationTokenRequestParameters(
clientId,
Expand All @@ -233,7 +243,8 @@ private AuthorizationTokenRequestParameters processAuthorizationTokenRequestArgu
loginHint,
nonce,
promptValues,
responseMode);
responseMode,
responseTypes);
}

@SuppressWarnings("unchecked")
Expand Down Expand Up @@ -323,7 +334,8 @@ private void handleAuthorizeMethodCall(
tokenRequestParameters.additionalParameters,
exchangeCode,
tokenRequestParameters.promptValues,
tokenRequestParameters.responseMode);
tokenRequestParameters.responseMode,
tokenRequestParameters.responseTypes);
} else {
AuthorizationServiceConfiguration.RetrieveConfigurationCallback callback =
new AuthorizationServiceConfiguration.RetrieveConfigurationCallback() {
Expand All @@ -342,7 +354,8 @@ public void onFetchConfigurationCompleted(
tokenRequestParameters.additionalParameters,
exchangeCode,
tokenRequestParameters.promptValues,
tokenRequestParameters.responseMode);
tokenRequestParameters.responseMode,
tokenRequestParameters.responseTypes);
} else {
finishWithDiscoveryError(ex);
}
Expand Down Expand Up @@ -415,10 +428,15 @@ private void performAuthorization(
Map<String, String> additionalParameters,
boolean exchangeCode,
ArrayList<String> promptValues,
String responseMode) {
String responseMode,
ArrayList<String> responseTypes) {
final String responseType =
responseTypes != null && !responseTypes.isEmpty()
? TextUtils.join(" ", responseTypes)
: ResponseTypeValues.CODE;
AuthorizationRequest.Builder authRequestBuilder =
new AuthorizationRequest.Builder(
serviceConfiguration, clientId, ResponseTypeValues.CODE, Uri.parse(redirectUrl));
serviceConfiguration, clientId, responseType, Uri.parse(redirectUrl));

if (scopes != null && !scopes.isEmpty()) {
authRequestBuilder.setScopes(scopes);
Expand Down Expand Up @@ -462,10 +480,26 @@ private void performAuthorization(
}

AuthorizationService authorizationService = getAuthorizationService();
AuthorizationRequest authRequest = authRequestBuilder.build();

if (isManualImplicitResponseType(responseType)) {
pendingOperation.manualImplicit = true;
pendingOperation.expectedState = authRequest.state;
pendingOperation.expectedNonce = authRequest.nonce;

try {
CustomTabsIntent customTabsIntent = new CustomTabsIntent.Builder().build();
customTabsIntent.launchUrl(mainActivity, authRequest.toUri());
} catch (ActivityNotFoundException ex) {
finishWithError(NO_BROWSER_AVAILABLE_ERROR_CODE, NO_BROWSER_AVAILABLE_ERROR_FORMAT, ex);
} catch (NullPointerException ex) {
finishWithError(NULL_ACTIVITY_ERROR_CODE, NULL_ACTIVITY_ERROR_FORMAT, ex);
}
return;
}

try {
Intent authIntent =
authorizationService.getAuthorizationRequestIntent(authRequestBuilder.build());
Intent authIntent = authorizationService.getAuthorizationRequestIntent(authRequest);
mainActivity.startActivityForResult(
authIntent, exchangeCode ? RC_AUTH_EXCHANGE_CODE : RC_AUTH);
} catch (ActivityNotFoundException ex) {
Expand All @@ -475,6 +509,97 @@ private void performAuthorization(
}
}

static boolean handleManualImplicitRedirectUri(@Nullable Uri uri) {
if (instance == null || instance.pendingOperation == null) {
return false;
}
return instance.processManualImplicitRedirectUri(uri);
}

private boolean isManualImplicitResponseType(@NonNull String responseType) {
return ResponseTypeValues.TOKEN.equals(responseType)
|| ResponseTypeValues.ID_TOKEN.equals(responseType)
|| "id_token token".equals(responseType)
|| "token id_token".equals(responseType);
}

private boolean processManualImplicitRedirectUri(@Nullable Uri uri) {
if (pendingOperation == null || !pendingOperation.manualImplicit) {
return false;
}

if (uri == null) {
finishWithError(
NULL_INTENT_ERROR_CODE,
NULL_INTENT_ERROR_FORMAT,
null);
return true;
}

Map<String, String> params = parseUriParameters(uri);

if (params.containsKey("error")) {
String message =
params.containsKey("error_description")
? params.get("error_description")
: params.get("error");
finishWithError(AUTHORIZE_ERROR_CODE, message, null);
return true;
}

String responseState = params.get("state");
if (pendingOperation.expectedState != null
&& !pendingOperation.expectedState.equals(responseState)) {
finishWithError(
AUTHORIZE_ERROR_CODE,
"Response state param did not match request state",
null);
return true;
}

Map<String, Object> responseMap = new HashMap<>();
responseMap.put("authorizationAdditionalParameters", new HashMap<>());
if (params.containsKey("id_token")) {
responseMap.put("idToken", params.get("id_token"));
}
if (params.containsKey("access_token")) {
responseMap.put("accessToken", params.get("access_token"));
}
if (params.containsKey("code")) {
responseMap.put("authorizationCode", params.get("code"));
}
responseMap.put("nonce", pendingOperation.expectedNonce);
finishWithSuccess(responseMap);
return true;
}

private Map<String, String> parseUriParameters(@NonNull Uri uri) {
Map<String, String> params = new LinkedHashMap<>();
if (uri.getQuery() != null) {
params.putAll(parseParameterString(uri.getQuery()));
}
if (uri.getFragment() != null) {
params.putAll(parseParameterString(uri.getFragment()));
}
return params;
}

private Map<String, String> parseParameterString(@NonNull String parameterString) {
Map<String, String> params = new LinkedHashMap<>();
for (String pair : parameterString.split("&")) {
int separatorIndex = pair.indexOf('=');
if (separatorIndex == -1) {
continue;
}
String key = Uri.decode(pair.substring(0, separatorIndex));
String value = Uri.decode(pair.substring(separatorIndex + 1));
if (!key.isEmpty()) {
params.put(key, value);
}
}
return params;
}

private void performTokenRequest(
AuthorizationServiceConfiguration serviceConfiguration,
TokenRequestParameters tokenRequestParameters) {
Expand Down Expand Up @@ -771,13 +896,18 @@ private Map<String, Object> authorizationResponseToMap(AuthorizationResponse aut
responseMap.put("codeVerifier", authResponse.request.codeVerifier);
responseMap.put("nonce", authResponse.request.nonce);
responseMap.put("authorizationCode", authResponse.authorizationCode);
responseMap.put("idToken", authResponse.idToken);
responseMap.put("accessToken", authResponse.accessToken);
responseMap.put("authorizationAdditionalParameters", authResponse.additionalParameters);
return responseMap;
}

private class PendingOperation {
final String method;
final Result result;
boolean manualImplicit = false;
@Nullable String expectedState;
@Nullable String expectedNonce;

PendingOperation(String method, Result result) {
this.method = method;
Expand Down Expand Up @@ -861,6 +991,7 @@ private class AuthorizationTokenRequestParameters extends TokenRequestParameters
final String loginHint;
final ArrayList<String> promptValues;
final String responseMode;
final ArrayList<String> responseTypes;

private AuthorizationTokenRequestParameters(
String clientId,
Expand All @@ -873,7 +1004,8 @@ private AuthorizationTokenRequestParameters(
String loginHint,
String nonce,
ArrayList<String> promptValues,
String responseMode) {
String responseMode,
ArrayList<String> responseTypes) {
super(
clientId,
issuer,
Expand All @@ -890,6 +1022,7 @@ private AuthorizationTokenRequestParameters(
this.loginHint = loginHint;
this.promptValues = promptValues;
this.responseMode = responseMode;
this.responseTypes = responseTypes;
}
}
}
Loading