24 |
25 |
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | AppAuth Sample App
3 | Android AppAuth Sample Application
4 |
5 | // Note: This MUST match the scheme from the OIDC_REDIRECT_URI constant in MainActivity.java
6 | com.pingidentity.developer.appauth
7 |
8 | Sign In to Application
9 | Refresh Access Token
10 | Query UserInfo
11 |
12 | OAuth 2.0 Access Token
13 | OAuth 2.0 Refresh Token
14 | OpenID Connect ID Token
15 | OpenID Connect UserInfo
16 |
17 | { NO TOKEN PRESENT }
18 | { NOT AUTHORIZED }
19 | { ERROR PARSING JSON }
20 |
21 |
22 |
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/DISCLAIMER:
--------------------------------------------------------------------------------
1 | /***************************************************************************
2 | * Copyright (C) 2014 Ping Identity Corporation
3 | * All rights reserved.
4 | *
5 | * Ping Identity Corporation
6 | * 1099 18th St Suite 2950
7 | * Denver, CO 80202
8 | * 303.468.2900
9 | * http://www.pingidentity.com
10 | *
11 | * DISCLAIMER OF WARRANTIES:
12 | *
13 | * THE SOFTWARE PROVIDED HEREUNDER IS PROVIDED ON AN "AS IS" BASIS, WITHOUT
14 | * ANY WARRANTIES OR REPRESENTATIONS EXPRESS, IMPLIED OR STATUTORY; INCLUDING,
15 | * WITHOUT LIMITATION, WARRANTIES OF QUALITY, PERFORMANCE, NONINFRINGEMENT,
16 | * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. NOR ARE THERE ANY
17 | * WARRANTIES CREATED BY A COURSE OR DEALING, COURSE OF PERFORMANCE OR TRADE
18 | * USAGE. FURTHERMORE, THERE ARE NO WARRANTIES THAT THE SOFTWARE WILL MEET
19 | * YOUR NEEDS OR BE FREE FROM ERRORS, OR THAT THE OPERATION OF THE SOFTWARE
20 | * WILL BE UNINTERRUPTED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
21 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES HOWEVER CAUSED AND ON ANY THEORY OF
23 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 | */
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
12 | set DEFAULT_JVM_OPTS=
13 |
14 | set DIRNAME=%~dp0
15 | if "%DIRNAME%" == "" set DIRNAME=.
16 | set APP_BASE_NAME=%~n0
17 | set APP_HOME=%DIRNAME%
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windowz variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 | if "%@eval[2+2]" == "4" goto 4NT_args
53 |
54 | :win9xME_args
55 | @rem Slurp the command line arguments.
56 | set CMD_LINE_ARGS=
57 | set _SKIP=2
58 |
59 | :win9xME_args_slurp
60 | if "x%~1" == "x" goto execute
61 |
62 | set CMD_LINE_ARGS=%*
63 | goto execute
64 |
65 | :4NT_args
66 | @rem Get arguments from the 4NT Shell from JP Software
67 | set CMD_LINE_ARGS=%$
68 |
69 | :execute
70 | @rem Setup the command line
71 |
72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
73 |
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
76 |
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if "%ERRORLEVEL%"=="0" goto mainEnd
80 |
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
85 | exit /b 1
86 |
87 | :mainEnd
88 | if "%OS%"=="Windows_NT" endlocal
89 |
90 | :omega
91 |
--------------------------------------------------------------------------------
/.idea/misc.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
57 |
58 |
59 |
60 |
61 |
62 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Android Native Application SSO Sample Application
2 |
3 | **android-appauth-sample-application** is a basic sample application to demonstrate native application single sign-on using the [AppAuth library for Android](https://github.com/openid/AppAuth-Android) from the OpenID Foundation.
4 |
5 | This sample application is based on the "example" in the AppAuth reference libraries and will authenticate the user and present the user's subject and tokens on the screen. Options to refresh the OAuth 2.0 access token and to refresh the authentication session are also demonstrated.
6 |
7 | Refer to the [Mobile Application SSO Developers Guide](https://developer.pingidentity.com/en/resources/napps-native-app-sso) for more detailed information.
8 |
9 | Note: You can get developer licenses and the PingFederate software at https://developer.pingidentity.com/get-started
10 |
11 |
12 | ## Installation
13 |
14 | This sample application has been built using PingFederate 8.0.1 and the OAuth Playground 3.2. Follow the documentation for PingFederate and the OAuth Playground to quickly stand up an OpenID Connect Provider / OAuth Authorization Server.
15 |
16 | ### You will need
17 |
18 | * PingFederate server & license ([download developer software and licenses](https://developer.pingidentity.com/get-started))
19 | * OAuth Playground (available from [product downloads](https://www.pingidentity.com/en/products/downloads/pingfederate-downloads.html))
20 | * [AppAuth library for Android](https://github.com/openid/AppAuth-Android)
21 |
22 | ### Android Studio & project configuration
23 |
24 | * Open this project (android-appauth-sample-application) in Android Studio
25 | * Add the [AppAuth library for Android](https://github.com/openid/AppAuth-Android) project to your XCode project
26 | * File > Project Structure > '+' > Import Gradle Project (browse to the AppAuth library)
27 | * Clean up any dependencies (i.e. comment out com.jfrog.bintray if you don't use bintray)
28 | * Add the library as a dependency (File > Project Structure > app > Dependencies ('+ Module dependency')
29 | * Modify the MainActivity.java file to define your PingFederate server, your client_id and redirect_uri
30 | * Modify the strings.xml file to define the redirect scheme for the Intent
31 |
32 | ### PingFederate configuration
33 |
34 | * Install PingFederate and the OAuth Playground (see the readme in the OAuth Playground distribution)
35 | * Modify the OAuth client "ac_client" in the PingFederate configuration:
36 | * OAuth Settings -> Client Management -> ac_client
37 | * Edit the "Redirect URIs" option to include the application callback URI (com.pingidentity.developer.appauth://oidc_callback)
38 |
39 |
40 | ## Disclaimer
41 |
42 | *This software is open sourced by Ping Identity but not supported commercially as such. Any questions/issues/comments should be directed to the "Developer Q&A" group in the Ping Identity Support Communities https://community.pingidentity.com/collaborate.*
43 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10 | DEFAULT_JVM_OPTS=""
11 |
12 | APP_NAME="Gradle"
13 | APP_BASE_NAME=`basename "$0"`
14 |
15 | # Use the maximum available, or set MAX_FD != -1 to use that value.
16 | MAX_FD="maximum"
17 |
18 | warn ( ) {
19 | echo "$*"
20 | }
21 |
22 | die ( ) {
23 | echo
24 | echo "$*"
25 | echo
26 | exit 1
27 | }
28 |
29 | # OS specific support (must be 'true' or 'false').
30 | cygwin=false
31 | msys=false
32 | darwin=false
33 | case "`uname`" in
34 | CYGWIN* )
35 | cygwin=true
36 | ;;
37 | Darwin* )
38 | darwin=true
39 | ;;
40 | MINGW* )
41 | msys=true
42 | ;;
43 | esac
44 |
45 | # Attempt to set APP_HOME
46 | # Resolve links: $0 may be a link
47 | PRG="$0"
48 | # Need this for relative symlinks.
49 | while [ -h "$PRG" ] ; do
50 | ls=`ls -ld "$PRG"`
51 | link=`expr "$ls" : '.*-> \(.*\)$'`
52 | if expr "$link" : '/.*' > /dev/null; then
53 | PRG="$link"
54 | else
55 | PRG=`dirname "$PRG"`"/$link"
56 | fi
57 | done
58 | SAVED="`pwd`"
59 | cd "`dirname \"$PRG\"`/" >/dev/null
60 | APP_HOME="`pwd -P`"
61 | cd "$SAVED" >/dev/null
62 |
63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
64 |
65 | # Determine the Java command to use to start the JVM.
66 | if [ -n "$JAVA_HOME" ] ; then
67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
68 | # IBM's JDK on AIX uses strange locations for the executables
69 | JAVACMD="$JAVA_HOME/jre/sh/java"
70 | else
71 | JAVACMD="$JAVA_HOME/bin/java"
72 | fi
73 | if [ ! -x "$JAVACMD" ] ; then
74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
75 |
76 | Please set the JAVA_HOME variable in your environment to match the
77 | location of your Java installation."
78 | fi
79 | else
80 | JAVACMD="java"
81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
82 |
83 | Please set the JAVA_HOME variable in your environment to match the
84 | location of your Java installation."
85 | fi
86 |
87 | # Increase the maximum file descriptors if we can.
88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
89 | MAX_FD_LIMIT=`ulimit -H -n`
90 | if [ $? -eq 0 ] ; then
91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
92 | MAX_FD="$MAX_FD_LIMIT"
93 | fi
94 | ulimit -n $MAX_FD
95 | if [ $? -ne 0 ] ; then
96 | warn "Could not set maximum file descriptor limit: $MAX_FD"
97 | fi
98 | else
99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
100 | fi
101 | fi
102 |
103 | # For Darwin, add options to specify how the application appears in the dock
104 | if $darwin; then
105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
106 | fi
107 |
108 | # For Cygwin, switch paths to Windows format before running java
109 | if $cygwin ; then
110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
112 | JAVACMD=`cygpath --unix "$JAVACMD"`
113 |
114 | # We build the pattern for arguments to be converted via cygpath
115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
116 | SEP=""
117 | for dir in $ROOTDIRSRAW ; do
118 | ROOTDIRS="$ROOTDIRS$SEP$dir"
119 | SEP="|"
120 | done
121 | OURCYGPATTERN="(^($ROOTDIRS))"
122 | # Add a user-defined pattern to the cygpath arguments
123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
125 | fi
126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
127 | i=0
128 | for arg in "$@" ; do
129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
131 |
132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
134 | else
135 | eval `echo args$i`="\"$arg\""
136 | fi
137 | i=$((i+1))
138 | done
139 | case $i in
140 | (0) set -- ;;
141 | (1) set -- "$args0" ;;
142 | (2) set -- "$args0" "$args1" ;;
143 | (3) set -- "$args0" "$args1" "$args2" ;;
144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
150 | esac
151 | fi
152 |
153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
154 | function splitJvmOpts() {
155 | JVM_OPTS=("$@")
156 | }
157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
159 |
160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
161 |
--------------------------------------------------------------------------------
/app/src/main/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
2 |
9 |
10 |
13 |
14 |
23 |
24 |
32 |
40 |
49 |
57 |
66 |
74 |
83 |
90 |
97 |
104 |
112 |
120 |
121 |
122 |
123 |
124 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
203 |
--------------------------------------------------------------------------------
/app/src/main/java/com/pingidentity/developer/android_appauth_sample_application/MainActivity.java:
--------------------------------------------------------------------------------
1 | package com.pingidentity.developer.android_appauth_sample_application;
2 |
3 | import android.app.PendingIntent;
4 | import android.content.Context;
5 | import android.content.Intent;
6 | import android.net.Uri;
7 | import android.os.Handler;
8 | import android.os.Looper;
9 | import android.os.StrictMode;
10 | import android.support.annotation.NonNull;
11 | import android.support.annotation.Nullable;
12 | import android.support.v7.app.AppCompatActivity;
13 | import android.os.Bundle;
14 | import android.util.Log;
15 | import android.view.View;
16 | import android.widget.Button;
17 | import android.widget.TextView;
18 |
19 | import net.openid.appauth.AuthState;
20 | import net.openid.appauth.AuthorizationException;
21 | import net.openid.appauth.AuthorizationRequest;
22 | import net.openid.appauth.AuthorizationResponse;
23 | import net.openid.appauth.AuthorizationService;
24 | import net.openid.appauth.AuthorizationServiceConfiguration;
25 | import net.openid.appauth.AuthorizationServiceDiscovery;
26 | import net.openid.appauth.CodeVerifierUtil;
27 | import net.openid.appauth.TokenRequest;
28 | import net.openid.appauth.TokenResponse;
29 |
30 | import org.json.JSONException;
31 | import org.json.JSONObject;
32 |
33 | import java.io.BufferedReader;
34 | import java.io.IOException;
35 | import java.io.InputStream;
36 | import java.io.InputStreamReader;
37 | import java.net.HttpURLConnection;
38 | import java.net.MalformedURLException;
39 | import java.net.URL;
40 | import java.util.HashMap;
41 |
42 |
43 | public class MainActivity extends AppCompatActivity {
44 |
45 | // TODO: Configure this to your environment
46 | // IDP Configuration
47 |
48 | // The OIDC issuer from which the configuration will be discovered. This is your base PingFederate server URL.
49 | private static final String OIDC_ISSUER = "https://sso.pingdevelopers.com";
50 |
51 | // The OAuth client ID. This is configured in your PingFederate administration console under OAuth Settings > Client Management.
52 | // The example "ac_client" from the OAuth playground can be used here.
53 | private static final String OIDC_CLIENT_ID = "ac_client";
54 |
55 | // The redirect URI that PingFederate will send the user back to after the authorization step. To avoid
56 | // collisions, this should be a reverse domain formatted string. You must define this in your OAuth client in PingFederate.
57 | private static final String OIDC_REDIRECT_URI = "com.pingidentity.developer.appauth://oidc_callback";
58 |
59 | // The scope to send in the request
60 | private static final String OIDC_SCOPE = "openid profile email";
61 |
62 | // Other constants
63 | // tag for logging
64 | private static final String TAG = "MainActivity";
65 | // key for authorization state
66 | private static final String KEY_AUTH_STATE = "com.pingidentity.developer.appauth.authState";
67 | private static final String KEY_USER_INFO = "userInfo";
68 | private static final String EXTRA_AUTH_SERVICE_DISCOVERY = "authServiceDiscovery";
69 |
70 | private static final int BUFFER_SIZE = 1024;
71 |
72 | private AuthState mAuthState;
73 | private AuthorizationService mAuthService;
74 | private JSONObject mUserInfoJson;
75 |
76 |
77 | @Override
78 | protected void onCreate(Bundle savedInstanceState) {
79 | super.onCreate(savedInstanceState);
80 | setContentView(R.layout.activity_main);
81 |
82 | // TODO: DEV ONLY! Remove before deploying in production
83 | // For simplicity of the demo, all actions are performed on the main thread
84 | StrictMode.ThreadPolicy policy = new StrictMode.ThreadPolicy.Builder().permitAll().build();
85 | StrictMode.setThreadPolicy(policy);
86 |
87 | mAuthService = new AuthorizationService(this);
88 |
89 | // Check for saved state first (may already have a session in the app)
90 | if (savedInstanceState != null) {
91 | if (savedInstanceState.containsKey(KEY_AUTH_STATE)) {
92 | try {
93 | mAuthState = AuthState.fromJson(savedInstanceState.getString(KEY_AUTH_STATE));
94 | } catch (JSONException ex) {
95 | Log.e(TAG, "Malformed authorization JSON saved", ex);
96 | }
97 | }
98 |
99 | if (savedInstanceState.containsKey(KEY_USER_INFO)) {
100 | try {
101 | mUserInfoJson = new JSONObject(savedInstanceState.getString(KEY_USER_INFO));
102 | } catch (JSONException ex) {
103 | Log.e(TAG, "Failed to parse saved user info JSON", ex);
104 | }
105 | }
106 | }
107 |
108 | // Check for authorization callback
109 | Intent intent = getIntent();
110 |
111 | if (intent != null) {
112 |
113 | Log.d(TAG, "Intent received");
114 |
115 | if (mAuthState == null) {
116 |
117 | // Parse the authorization response
118 | AuthorizationResponse response = AuthorizationResponse.fromIntent(getIntent());
119 | AuthorizationException ex = AuthorizationException.fromIntent(getIntent());
120 |
121 | if (response != null || ex != null) {
122 | mAuthState = new AuthState(response, ex);
123 | }
124 |
125 | if (response != null) {
126 | Log.d(TAG, "Received AuthorizationResponse.");
127 | exchangeAuthorizationCode(response);
128 | } else {
129 | Log.i(TAG, "Authorization failed: " + ex);
130 | }
131 | }
132 | } else {
133 | Log.d(TAG, "NO Intent received");
134 | }
135 |
136 | refreshUi();
137 | }
138 |
139 | @Override
140 | protected void onDestroy() {
141 | super.onDestroy();
142 | mAuthService.dispose();
143 | }
144 |
145 | // redraw the UI after an action occurs
146 | public void refreshUi() {
147 |
148 | TextView textAccessToken = (TextView) findViewById(R.id.oauth2_access_token);
149 | TextView textRefreshToken = (TextView) findViewById(R.id.oauth2_refresh_token);
150 | TextView textIdToken = (TextView) findViewById(R.id.oidc_id_token);
151 | TextView textUserInfo = (TextView) findViewById(R.id.oidc_userinfo);
152 | Button buttonAuthorize = (Button) findViewById(R.id.button_authorize);
153 | Button buttonRefresh = (Button) findViewById(R.id.button_refresh);
154 | Button buttonUserInfo = (Button) findViewById(R.id.button_userinfo);
155 |
156 | buttonAuthorize.setVisibility(View.VISIBLE);
157 |
158 | if (mAuthState == null) {
159 |
160 | textAccessToken.setText(R.string.not_authorized);
161 | textRefreshToken.setText(R.string.not_authorized);
162 | textIdToken.setText(R.string.not_authorized);
163 |
164 | buttonRefresh.setVisibility(View.GONE);
165 | buttonUserInfo.setVisibility(View.GONE);
166 | return;
167 | }
168 |
169 | if (mAuthState.isAuthorized()) {
170 |
171 | buttonRefresh.setVisibility(View.VISIBLE);
172 | buttonUserInfo.setVisibility(View.VISIBLE);
173 |
174 | textAccessToken.setText((mAuthState.getAccessToken() != null)
175 | ? mAuthState.getAccessToken()
176 | : getString(R.string.no_token));
177 |
178 | textRefreshToken.setText((mAuthState.getRefreshToken() != null)
179 | ? mAuthState.getRefreshToken()
180 | : getString(R.string.no_token));
181 |
182 | textIdToken.setText((mAuthState.getIdToken() != null)
183 | ? mAuthState.getIdToken()
184 | : getString(R.string.no_token));
185 |
186 | if (mUserInfoJson != null) {
187 | try {
188 | textUserInfo.setText(mUserInfoJson.toString(3));
189 | } catch (Exception ex) {
190 | textUserInfo.setText(getString(R.string.json_error));
191 | }
192 | }
193 |
194 | } else {
195 |
196 | textAccessToken.setText(R.string.not_authorized);
197 | textRefreshToken.setText(R.string.not_authorized);
198 | textIdToken.setText(R.string.not_authorized);
199 |
200 | buttonRefresh.setVisibility(View.GONE);
201 | buttonUserInfo.setVisibility(View.GONE);
202 | }
203 | }
204 |
205 | // button action handlers
206 | public void requestAuthorization(View view) {
207 |
208 | final AuthorizationServiceConfiguration.RetrieveConfigurationCallback retrieveCallback =
209 | new AuthorizationServiceConfiguration.RetrieveConfigurationCallback() {
210 |
211 | @Override
212 | public void onFetchConfigurationCompleted(
213 | @Nullable AuthorizationServiceConfiguration serviceConfiguration,
214 | @Nullable AuthorizationException ex) {
215 | if (ex != null) {
216 | Log.w(TAG, "Failed to retrieve configuration for " + OIDC_ISSUER, ex);
217 | } else {
218 | Log.d(TAG, "configuration retrieved for " + OIDC_ISSUER
219 | + ", proceeding");
220 | authorize(serviceConfiguration);
221 | }
222 | }
223 | };
224 |
225 | String discoveryEndpoint = OIDC_ISSUER + "/.well-known/openid-configuration";
226 |
227 | AuthorizationServiceConfiguration.fetchFromUrl(Uri.parse(discoveryEndpoint), retrieveCallback);
228 | }
229 |
230 | public void refreshToken(View view) {
231 | performTokenRequest(mAuthState.createTokenRefreshRequest());
232 | }
233 |
234 | public void getUserinfo(View view) {
235 |
236 | Log.d(TAG, "Calling Userinfo...");
237 |
238 | if (mAuthState.getAuthorizationServiceConfiguration() == null) {
239 | Log.e(TAG, "Cannot make userInfo request without service configuration");
240 | }
241 |
242 | mAuthState.performActionWithFreshTokens(mAuthService, new AuthState.AuthStateAction() {
243 | @Override
244 | public void execute(String accessToken, String idToken, AuthorizationException ex) {
245 | if (ex != null) {
246 | Log.e(TAG, "Token refresh failed when fetching user info");
247 | return;
248 | }
249 |
250 | AuthorizationServiceDiscovery discoveryDoc = getDiscoveryDocFromIntent(getIntent());
251 | if (discoveryDoc == null) {
252 | throw new IllegalStateException("no available discovery doc");
253 | }
254 |
255 | URL userInfoEndpoint;
256 | try {
257 | userInfoEndpoint = new URL(discoveryDoc.getUserinfoEndpoint().toString());
258 | } catch (MalformedURLException urlEx) {
259 | Log.e(TAG, "Failed to construct user info endpoint URL", urlEx);
260 | return;
261 | }
262 |
263 | InputStream userInfoResponse = null;
264 | try {
265 | HttpURLConnection conn = (HttpURLConnection) userInfoEndpoint.openConnection();
266 | conn.setRequestProperty("Authorization", "Bearer " + accessToken);
267 | conn.setInstanceFollowRedirects(false);
268 | userInfoResponse = conn.getInputStream();
269 | String response = readStream(userInfoResponse);
270 | updateUserInfo(new JSONObject(response));
271 | } catch (IOException ioEx) {
272 | Log.e(TAG, "Network error when querying userinfo endpoint", ioEx);
273 | } catch (JSONException jsonEx) {
274 | Log.e(TAG, "Failed to parse userinfo response");
275 | } finally {
276 | if (userInfoResponse != null) {
277 | try {
278 | userInfoResponse.close();
279 | } catch (IOException ioEx) {
280 | Log.e(TAG, "Failed to close userinfo response stream", ioEx);
281 | }
282 | }
283 | }
284 | }
285 | });
286 | }
287 |
288 |
289 | // Kick off an authorization request
290 | private void authorize(AuthorizationServiceConfiguration authServiceConfiguration) {
291 |
292 | // NOTE: Required for PingFederate 8.1 and below for the .setCodeVerifier() option below
293 | // to generate "plain" code_challenge_method these versions of PingFederate do not support
294 | // S256 PKCE.
295 | String codeVerifier = CodeVerifierUtil.generateRandomCodeVerifier();
296 |
297 | // OPTIONAL: Add any additional parameters to the authorization request
298 | HashMap additionalParams = new HashMap<>();
299 | additionalParams.put("acr_values", "urn:acr:form");
300 |
301 | AuthorizationRequest authRequest = new AuthorizationRequest.Builder(
302 | authServiceConfiguration,
303 | OIDC_CLIENT_ID,
304 | AuthorizationRequest.RESPONSE_TYPE_CODE,
305 | Uri.parse(OIDC_REDIRECT_URI))
306 | .setScope(OIDC_SCOPE)
307 | .setCodeVerifier(codeVerifier, codeVerifier, "plain")
308 | .setAdditionalParameters(additionalParams)
309 | .build();
310 |
311 | Log.d(TAG, "Making auth request to " + authServiceConfiguration.authorizationEndpoint);
312 | mAuthService.performAuthorizationRequest(
313 | authRequest,
314 | createPostAuthorizationIntent(
315 | this.getApplicationContext(),
316 | authRequest,
317 | authServiceConfiguration.discoveryDoc));
318 | }
319 |
320 | private void exchangeAuthorizationCode(AuthorizationResponse authorizationResponse) {
321 |
322 | performTokenRequest(authorizationResponse.createTokenExchangeRequest());
323 | }
324 |
325 | private void performTokenRequest(TokenRequest tokenRequest) {
326 |
327 | mAuthService.performTokenRequest(
328 | tokenRequest,
329 | new AuthorizationService.TokenResponseCallback()
330 |
331 | {
332 | @Override
333 | public void onTokenRequestCompleted (
334 | @Nullable TokenResponse tokenResponse,
335 | @Nullable AuthorizationException ex){
336 | receivedTokenResponse(tokenResponse, ex);
337 | }
338 | }
339 |
340 | );
341 | }
342 |
343 |
344 | private void receivedTokenResponse(
345 | @Nullable TokenResponse tokenResponse,
346 | @Nullable AuthorizationException authException) {
347 | Log.d(TAG, "Token request complete");
348 | mAuthState.update(tokenResponse, authException);
349 | refreshUi();
350 | }
351 |
352 | private PendingIntent createPostAuthorizationIntent(
353 | @NonNull Context context,
354 | @NonNull AuthorizationRequest request,
355 | @Nullable AuthorizationServiceDiscovery discoveryDoc) {
356 |
357 | Intent intent = new Intent(context, this.getClass());
358 | if (discoveryDoc != null) {
359 | intent.putExtra(EXTRA_AUTH_SERVICE_DISCOVERY, discoveryDoc.docJson.toString());
360 | }
361 |
362 | return PendingIntent.getActivity(context, request.hashCode(), intent, 0);
363 | }
364 |
365 | private AuthorizationServiceDiscovery getDiscoveryDocFromIntent(Intent intent) {
366 | if (!intent.hasExtra(EXTRA_AUTH_SERVICE_DISCOVERY)) {
367 | return null;
368 | }
369 | String discoveryJson = intent.getStringExtra(EXTRA_AUTH_SERVICE_DISCOVERY);
370 | try {
371 | return new AuthorizationServiceDiscovery(new JSONObject(discoveryJson));
372 | } catch (JSONException | AuthorizationServiceDiscovery.MissingArgumentException ex) {
373 | throw new IllegalStateException("Malformed JSON in discovery doc");
374 | }
375 | }
376 |
377 | private void updateUserInfo(final JSONObject jsonObject) {
378 | new Handler(Looper.getMainLooper()).post(new Runnable() {
379 | @Override
380 | public void run() {
381 | mUserInfoJson = jsonObject;
382 | refreshUi();
383 | }
384 | });
385 | }
386 |
387 | private static String readStream(InputStream stream) throws IOException {
388 | BufferedReader br = new BufferedReader(new InputStreamReader(stream));
389 | char[] buffer = new char[BUFFER_SIZE];
390 | StringBuilder sb = new StringBuilder();
391 | int readCount;
392 | while ((readCount = br.read(buffer)) != -1) {
393 | sb.append(buffer, 0, readCount);
394 | }
395 | return sb.toString();
396 | }
397 | }
398 |
--------------------------------------------------------------------------------