Android OAuth Client Library (android-oauth-client)

The

android-oauth-client

WebView

To help you manage access tokens, the library also includes an out-of-the-box credential store which stores tokens in SharedPreferences.

This client library is an Android extension to the Google OAuth Client Library for Java.

FEATURES

• Supports the following OAuth flows via the

  google-oauth-java-client

  library:
  • OAuth 1.0a
  • OAuth 2.0 Explicit Authorization (authorization code)
  • OAuth 2.0 Implicit Authorization
• Automatically handles the OAuth flow in both

  android.app.DialogFragment

  and

  android.support.v4.app.DialogFragment

  . The dialog UI is fully customizable.
• Provides an out-of-the-box credential store implementation via

  SharedPreferences

  .
• Provides sample applications that already work with popular social network services such as:
  • Flickr (OAuth 1.0a)
  • Foursquare (OAuth 2.0 Explicit/Implicit)
  • GitHub (OAuth 2.0 Explicit)
  • Instagram (OAuth 2.0 Implicit)
  • LinkedIn (OAuth 1.0a, OAuth 2.0 Explicit)
  • Plurk (OAuth 1.0a)
  • Twitter (OAuth 1.0a)

Note on OAuth flows: In general you should prefer OAuth 2.0 Implicit Authorization over OAuth 2.0 Explicit Authorization because implicit authorization does not require the client secret to be stored in the client.

USAGE

Regardless of which OAuth flow you intend to incorporate into your Android application, the

android-oauth-client

1. Obtain an instance of

   OAuthManager

   by supplying the following 2 parameters:
   • An

     AuthorizationFlow

     instance which automatically handles the OAuth flow logic,
   • An

     AuthorizationUIController

     which manages the UI.
2. Call one of the 3 possible

   authorize

   methods on

   OAuthManager

   . The call may be called from any thread either synchronously or asynchronously with an

   OAuthCallback

   .

   • OAuthManager.authorize10a()

   • OAuthManager.authorizeExplicitly()

   • OAuthManager.authorizeImplicitly()

We will go into more detail about each of the steps.

Obtaining an OAuthManager instance

OAuthManager

OAuthManager oauth = new OAuthManager(flow, controller);

Obtaining an access token via the OAuthManager

To start the OAuth flow and obtain an access token, call one of the

authorize()

You may invoke the

authorize()

Credential credential = oauth.authorizeImplicitly("userId", null, null).getResult();
// continue to make API queries with credential.getAccessToken()

You may also invoke the

authorize()

OAuthCallback

android.os.Handler

OAuthCallback callback = new OAuthCallback() {
    @Override public void run(OAuthFuture future) {
        Credential credential = future.getResult();
        // make API queries with credential.getAccessToken()
    }
};
oauth.authorizeImplicitly("userId", callback, handler);

Note that if a

Handler

callback

CredentialStore

Use the provided

SharedPreferencesCredentialStore

SharedPreferences

SharedPreferencesCredentialStore credentialStore =
    new SharedPreferencesCredentialStore(context,
        "preferenceFileName", new JacksonFactory());

AuthorizationFlow

An

AuthorizationFlow

Builder

AuthorizationFlow.Builder builder = new AuthorizationFlow.Builder(
    BearerToken.authorizationHeaderAccessMethod(),
    AndroidHttp.newCompatibleTransport(),
    new JacksonFactory(),
    new GenericUrl("https://socialservice.com/oauth2/access_token"),
    new ClientParametersAuthentication("CLIENT_ID", "CLIENT_SECRET"),
    "CLIENT_ID",
    "https://socialservice.com/oauth2/authorize");
builder.setCredentialStore(credentialStore);
AuthorizationFlow flow = builder.build();

For OAuth 2.0 flows, you may wish to add OAuth scopes:

builder.setScopes(Arrays.asList("scope1", "scope2"));

For the OAuth 1.0a flow, you need to set the temporary token request URL:

builder.setTemporaryTokenRequestUrl("https://socialservice.com/oauth/requestToken");

Note that

CLIENT_SECRET

null

Also,

CLIENT_ID

CLIENT_SECRET

CONSUMER_KEY

CONSUMER_SECRET

AuthorizationUIController

Use the provided

DialogFragmentController

DialogFragmentController

android.app.FragmentManager

android.support.v4.app.FragmentManager

android.app.DialogFragment

android.support.v4.app.DialogFragment

AuthorizationUIController controller =
    new DialogFragmentController(getFragmentManager()) {

    @Override
    public String getRedirectUri() throws IOException {
        return "http://localhost/Callback";
    }

    @Override
    public boolean isJavascriptEnabledForWebView() {
        return true;
    }

};

PROGUARD

On Android it is typical to use Proguard to obfuscate and shrink code in order to reduce application size and improve security. If you are using Proguard, make sure you include the following configurations:

# Needed to keep generic types and @Key annotations accessed via reflection
-keepattributes Signature,RuntimeVisibleAnnotations,AnnotationDefault

-keepclasseswithmembers class * {
  @com.google.api.client.util.Key ;
}
-keepclasseswithmembers class * {
  @com.google.api.client.util.Value ;
}
-keepnames class com.google.api.client.http.HttpTransport
Needed by google-http-client-android when linking against an older platform version
-dontwarn com.google.api.client.extensions.android.**
Needed by google-api-client-android when linking against an older platform version
-dontwarn com.google.api.client.googleapis.extensions.android.**
Do not obfuscate but allow shrinking of android-oauth-client
-keepnames class com.wuman.android.auth.** { *; }

SAMPLES

A sample application is provided to showcase how you might use the library in a real-life Android application. In addition to default usage, the sample application also has examples for customizing the Dialog UI as well as OAuth integrations for popular social network services such as Flickr, LinkedIn, Twitter, etc.

HOW TO USE THE LIBRARY

Android OAuth Client is available for download from the Maven Central repository. You may also include it as a dependency by including the following coordinates:

  com.wu-man
  android-oauth-client
  0.4.5

or using Gradle

dependencies {
   compile 'com.wu-man:android-oauth-client:0.4.5'
}

As of v0.0.3, an Android library

AAR

  com.wu-man
  android-oauth-client
  0.4.5
  aar

HOW TO BUILD THE PROJECT

You should use the included Gradle wrapper to build the project with the following command:

./gradlew clean build

The resulting jar file is located at

library/build/libs/library.jar

library/build/libs/library.aar

CONTRIBUTE

If you would like to contribute code to android-oauth-client you can do so through GitHub by forking the repository and sending a pull request.

In general if you are contributing we ask you to follow the AOSP coding style guidelines. If you are using an IDE such as Eclipse, it is easiest to use the AOSP style formatters.

You may file an issue if you find bugs or would like to add a new feature.

We do not have a mailing list. All questions should be asked and will be answered on StackOverflow using the android-oauth-client tag.

DEVELOPED BY

• David Wu - [email protected] - http://blog.wu-man.com

LICENSE

Copyright 2013 David Wu
Copyright (C) 2010 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.