Skip to content

Commit 65e5fc1

Browse files
ukaratkevichukaratkevich
authored
Merge pull request #486 from erikrodriguez-se/auth-tab-example
CCT - AuthTab Sample Demo
2 parents 76d082d + 8b974ff commit 65e5fc1

File tree

35 files changed

+742
-15
lines changed

35 files changed

+742
-15
lines changed

‎build.gradle

-8
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ buildscript {
2020
repositories {
2121
google()
2222
jcenter()
23-
maven {
24-
url = "https://androidx.dev/snapshots/builds/12815573/artifacts/repository"
25-
}
2623
}
2724
dependencies {
2825
classpath 'com.android.tools.build:gradle:8.7.3'
@@ -34,11 +31,6 @@ allprojects {
3431
google()
3532
jcenter()
3633

37-
// AndroidX snapshots repository
38-
maven {
39-
url = "https://androidx.dev/snapshots/builds/12815573/artifacts/repository"
40-
}
41-
4234
// Repository for DexMaker
4335
maven {
4436
url = "https://linkedin.jfrog.io/artifactory/open-source/"

‎demos/custom-tabs-auth-tab/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/build

‎demos/custom-tabs-auth-tab/build.gradle

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
apply plugin: 'com.android.application'
18+
19+
android {
20+
namespace 'com.google.androidbrowserhelper.demos.customtabsauthtab'
21+
compileSdkVersion 35
22+
defaultConfig {
23+
applicationId "com.google.androidbrowserhelper.demos.customtabsauthtab"
24+
minSdkVersion 26
25+
targetSdkVersion 35
26+
versionCode 1
27+
versionName "1.0"
28+
}
29+
30+
buildTypes {
31+
release {
32+
minifyEnabled false
33+
}
34+
}
35+
36+
compileOptions {
37+
sourceCompatibility JavaVersion.VERSION_17
38+
targetCompatibility JavaVersion.VERSION_17
39+
}
40+
}
41+
42+
dependencies {
43+
implementation project(path: ':androidbrowserhelper')
44+
implementation fileTree(dir: "libs", include: ["*.jar"])
45+
implementation 'androidx.appcompat:appcompat:1.7.0'
46+
implementation 'androidx.activity:activity:1.9.3'
47+
implementation 'androidx.browser:browser:1.9.0-alpha01'
48+
implementation 'com.google.android.material:material:1.12.0'
49+
implementation 'androidx.annotation:annotation:1.9.1'
50+
implementation 'androidx.constraintlayout:constraintlayout:2.2.0'
51+
}

‎demos/custom-tabs-auth-tab/src/main/AndroidManifest.xml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
3+
xmlns:tools="http://schemas.android.com/tools"
4+
package="com.google.androidbrowserhelper.demos.customtabsauthtab">
5+
<uses-permission android:name="android.permission.INTERNET" />
6+
7+
<application
8+
android:allowBackup="true"
9+
android:dataExtractionRules="@xml/data_extraction_rules"
10+
android:fullBackupContent="@xml/backup_rules"
11+
android:icon="@mipmap/ic_launcher"
12+
android:label="@string/app_name"
13+
android:roundIcon="@mipmap/ic_launcher_round"
14+
android:supportsRtl="true"
15+
android:theme="@style/Theme.AuthTab"
16+
tools:targetApi="31">
17+
<activity
18+
android:name=".MainActivity"
19+
android:exported="true">
20+
<intent-filter>
21+
<action android:name="android.intent.action.MAIN" />
22+
<category android:name="android.intent.category.LAUNCHER" />
23+
</intent-filter>
24+
25+
<!-- An intent-filter for fallback to Chrome Custom Tabs -->
26+
<intent-filter>
27+
<action android:name="android.intent.action.VIEW" />
28+
<category android:name="android.intent.category.DEFAULT" />
29+
<category android:name="android.intent.category.BROWSABLE" />
30+
<data android:scheme="auth" />
31+
<data android:host="callback" />
32+
</intent-filter>
33+
</activity>
34+
</application>
35+
</manifest>

‎demos/custom-tabs-auth-tab/src/main/java/com/google/androidbrowserhelper/demos/customtabsauthtab/AuthManager.java

+106
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
package com.google.androidbrowserhelper.demos.customtabsauthtab;
2+
3+
import android.content.Context;
4+
import android.content.Intent;
5+
import android.content.SharedPreferences;
6+
import android.net.Uri;
7+
import android.os.Handler;
8+
import android.os.Looper;
9+
import android.util.Log;
10+
11+
import androidx.activity.result.ActivityResultLauncher;
12+
import androidx.annotation.NonNull;
13+
import androidx.browser.auth.AuthTabIntent;
14+
import androidx.annotation.OptIn;
15+
import androidx.browser.auth.ExperimentalAuthTab;
16+
17+
import java.io.IOException;
18+
import java.util.UUID;
19+
20+
/**
21+
* This class helps managing an authentication flow. It was created with the goal of demonstrating
22+
* how to use Custom Tabs Auth Tab to handle auth and is not meant as a complete implementation
23+
* of the OAuth protocol. We recommend checking out https://github.com/openid/AppAuth-Android for
24+
* a comprehensive implementation of the OAuth protocol.
25+
*/
26+
27+
@OptIn(markerClass = ExperimentalAuthTab.class)
28+
public class AuthManager {
29+
private static final String TAG = "OAuthManager";
30+
31+
private final String mClientId;
32+
private final String mClientSecret;
33+
private final String mAuthorizationEndpoint;
34+
private final String mRedirectScheme;
35+
36+
public interface OAuthCallback {
37+
void auth(String accessToken, String scope, String tokenType);
38+
}
39+
40+
public AuthManager(String clientId, String clientSecret, String authorizationEndpoint,
41+
String redirectScheme) {
42+
mClientId = clientId;
43+
mClientSecret = clientSecret;
44+
mAuthorizationEndpoint = authorizationEndpoint;
45+
mRedirectScheme = redirectScheme;
46+
}
47+
48+
public void authorize(Context context, ActivityResultLauncher<Intent> launcher, String scope) {
49+
// Generate a random state.
50+
String state = UUID.randomUUID().toString();
51+
52+
// Save the state so we can verify later.
53+
SharedPreferences preferences =
54+
context.getSharedPreferences("OAUTH_STORAGE", Context.MODE_PRIVATE);
55+
preferences.edit()
56+
.putString("OAUTH_STATE", state)
57+
.apply();
58+
59+
// Create an authorization URI to the OAuth Endpoint.
60+
Uri uri = Uri.parse(mAuthorizationEndpoint)
61+
.buildUpon()
62+
.appendQueryParameter("response_type", "code")
63+
.appendQueryParameter("client_id", mClientId)
64+
.appendQueryParameter("scope", scope)
65+
.appendQueryParameter("state", state)
66+
.build();
67+
68+
// Open the Authorization URI in a Chrome Custom Auth Tab.
69+
AuthTabIntent authTabIntent = new AuthTabIntent.Builder().build();
70+
authTabIntent.launch(launcher, uri, mRedirectScheme);
71+
}
72+
73+
public void continueAuthFlow(@NonNull Context context, Uri uri, @NonNull OAuthCallback callback) {
74+
String code = uri.getQueryParameter("code");
75+
SharedPreferences preferences =
76+
context.getSharedPreferences("OAUTH_STORAGE", Context.MODE_PRIVATE);
77+
String state = preferences.getString("OAUTH_STATE", "");
78+
Uri tokenUri = Uri.parse("https://github.com/login/oauth/access_token")
79+
.buildUpon()
80+
.appendQueryParameter("client_id", mClientId)
81+
.appendQueryParameter("client_secret", mClientSecret)
82+
.appendQueryParameter("code", code)
83+
.appendQueryParameter("state", state)
84+
.build();
85+
86+
// Run the network request off the UI thread.
87+
new Thread(() -> {
88+
try {
89+
String response = Utils.fetch(tokenUri);
90+
// The response is a query-string. We concatenate with a valid domain to be
91+
// able to easily parse and extract values.
92+
Uri responseUri = Uri.parse("http://example.com?" + response);
93+
String accessToken = responseUri.getQueryParameter("access_token");
94+
String tokenType = responseUri.getQueryParameter("token_type");
95+
String scope = responseUri.getQueryParameter("scope");
96+
97+
// Invoke the callback in the main thread.
98+
new Handler(Looper.getMainLooper()).post(
99+
() -> callback.auth(accessToken, scope, tokenType));
100+
101+
} catch (IOException e) {
102+
Log.e(TAG, "Error requesting access token: " + e.getMessage());
103+
}
104+
}).start();
105+
}
106+
}

‎demos/custom-tabs-auth-tab/src/main/java/com/google/androidbrowserhelper/demos/customtabsauthtab/GithubApi.java

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
package com.google.androidbrowserhelper.demos.customtabsauthtab;
2+
3+
import android.net.Uri;
4+
import android.os.Handler;
5+
import android.os.Looper;
6+
import android.util.Log;
7+
8+
import org.json.JSONException;
9+
import org.json.JSONObject;
10+
11+
import java.io.IOException;
12+
import java.util.Collections;
13+
import java.util.Map;
14+
15+
public class GithubApi {
16+
private static final String TAG = "GithubAPI";
17+
private static final String API_ENDPOINT = "https://api.github.com/user";
18+
private static final String AUTH_HEADER_KEY = "Authorization";
19+
20+
public interface UserCallback {
21+
void onUserData(String username);
22+
}
23+
24+
public static void requestGithubUsername(String token, UserCallback callback) {
25+
new Thread(() -> {
26+
try {
27+
Uri uri = Uri.parse(API_ENDPOINT);
28+
Map<String, String> headers =
29+
Collections.singletonMap(AUTH_HEADER_KEY, "token " + token);
30+
String response = Utils.fetch(uri, headers);
31+
JSONObject user = new JSONObject(response);
32+
String username = user.getString("name");
33+
34+
// Invoke the callback in the main thread.
35+
new Handler(Looper.getMainLooper()).post(() -> {
36+
callback.onUserData(username);
37+
});
38+
} catch (IOException | JSONException ex) {
39+
Log.e(TAG, "Error fetching GitHub user: " + ex.getMessage());
40+
}
41+
}).start();
42+
}
43+
}

‎demos/custom-tabs-auth-tab/src/main/java/com/google/androidbrowserhelper/demos/customtabsauthtab/MainActivity.java

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.androidbrowserhelper.demos.customtabsauthtab;
18+
19+
import android.content.Intent;
20+
import android.net.Uri;
21+
import android.os.Bundle;
22+
import android.view.View;
23+
import android.widget.Button;
24+
import android.widget.ProgressBar;
25+
import android.widget.TextView;
26+
27+
import androidx.activity.result.ActivityResultLauncher;
28+
import androidx.annotation.OptIn;
29+
import androidx.appcompat.app.AppCompatActivity;
30+
import androidx.browser.auth.AuthTabIntent;
31+
import androidx.browser.auth.ExperimentalAuthTab;
32+
33+
@OptIn(markerClass = ExperimentalAuthTab.class)
34+
public class MainActivity extends AppCompatActivity {
35+
private static final String TAG = "MainActivity";
36+
37+
private static final String AUTHORIZATION_ENDPOINT = "https://github.com/login/oauth/authorize";
38+
private static final String CLIENT_ID = "<github-client-id>";
39+
private static final String CLIENT_SECRET = "<github-client-secret>";
40+
private static final String REDIRECT_SCHEME = "auth";
41+
42+
private static final AuthManager O_AUTH_MANAGER =
43+
new AuthManager(CLIENT_ID, CLIENT_SECRET, AUTHORIZATION_ENDPOINT, REDIRECT_SCHEME);
44+
45+
private final ActivityResultLauncher<Intent> mLauncher =
46+
AuthTabIntent.registerActivityResultLauncher(this, this::handleAuthResult);
47+
48+
private Button mLoginButton;
49+
private TextView mUserText;
50+
private ProgressBar mProgressBar;
51+
private boolean mLoggedIn;
52+
53+
@Override
54+
protected void onCreate(Bundle savedInstanceState) {
55+
super.onCreate(savedInstanceState);
56+
setContentView(R.layout.activity_main);
57+
58+
mLoginButton = findViewById(R.id.login_button);
59+
mUserText = findViewById(R.id.user_text);
60+
mProgressBar = findViewById(R.id.progress_bar);
61+
62+
Intent intent = getIntent();
63+
if (intent != null) {
64+
Uri data = intent.getData();
65+
if (data != null && data.getHost() != null
66+
&& data.getHost().startsWith("callback")) {
67+
mProgressBar.setVisibility(View.VISIBLE);
68+
mLoginButton.setEnabled(false);
69+
completeAuth(data);
70+
}
71+
}
72+
}
73+
74+
public void login(View v) {
75+
if (mLoggedIn) {
76+
mLoginButton.setText(R.string.login);
77+
mUserText.setText(R.string.logged_out);
78+
mLoggedIn = false;
79+
} else {
80+
O_AUTH_MANAGER.authorize(this, mLauncher, "user");
81+
}
82+
}
83+
84+
private void handleAuthResult(AuthTabIntent.AuthResult result) {
85+
if (result.resultCode == AuthTabIntent.RESULT_OK) {
86+
completeAuth(result.resultUri);
87+
}
88+
}
89+
90+
private void completeAuth(Uri uri) {
91+
O_AUTH_MANAGER.continueAuthFlow(this, uri, (accessToken, scope, tokenType) -> {
92+
GithubApi.requestGithubUsername(accessToken, (username -> {
93+
mLoginButton.setText(R.string.logout);
94+
mLoginButton.setEnabled(true);
95+
mProgressBar.setVisibility(View.INVISIBLE);
96+
mUserText.setText(getString(R.string.logged_in, username));
97+
mLoggedIn = true;
98+
}));
99+
});
100+
}
101+
}

0 commit comments

Comments
 (0)