├── app
├── .gitignore
├── keystore.jks
├── src
│ └── main
│ │ ├── ic_launcher-web.png
│ │ ├── res
│ │ ├── drawable-v24
│ │ │ ├── sklogo.png
│ │ │ └── ic_launcher_foreground.xml
│ │ ├── mipmap-hdpi
│ │ │ ├── ic_launcher.png
│ │ │ ├── ic_launcher_round.png
│ │ │ └── ic_launcher_foreground.png
│ │ ├── mipmap-mdpi
│ │ │ ├── ic_launcher.png
│ │ │ ├── ic_launcher_round.png
│ │ │ └── ic_launcher_foreground.png
│ │ ├── mipmap-xhdpi
│ │ │ ├── ic_launcher.png
│ │ │ ├── ic_launcher_round.png
│ │ │ └── ic_launcher_foreground.png
│ │ ├── mipmap-xxhdpi
│ │ │ ├── ic_launcher.png
│ │ │ ├── ic_launcher_round.png
│ │ │ └── ic_launcher_foreground.png
│ │ ├── mipmap-xxxhdpi
│ │ │ ├── ic_launcher.png
│ │ │ ├── ic_launcher_round.png
│ │ │ └── ic_launcher_foreground.png
│ │ ├── values
│ │ │ ├── ic_launcher_background.xml
│ │ │ ├── strings.xml
│ │ │ ├── colors.xml
│ │ │ └── styles.xml
│ │ ├── mipmap-anydpi-v26
│ │ │ ├── ic_launcher.xml
│ │ │ └── ic_launcher_round.xml
│ │ ├── drawable
│ │ │ ├── ic_launcher_foreground.xml
│ │ │ └── ic_launcher_background.xml
│ │ └── layout
│ │ │ └── activity_main.xml
│ │ ├── AndroidManifest.xml
│ │ └── java
│ │ └── com
│ │ └── singularkey
│ │ └── androidfido2
│ │ ├── RPApiService.kt
│ │ └── MainActivity.kt
├── proguard-rules.pro
└── build.gradle
├── settings.gradle
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── .gitignore
├── scripts
└── get_cert_fingerprint.sh
├── web
├── firebase.json
├── public
│ └── .well-known
│ │ └── assetlinks.json
└── .gitignore
├── gradle.properties
├── gradlew.bat
├── gradlew
├── README.md
└── LICENSE
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | include ':app'
2 |
--------------------------------------------------------------------------------
/app/keystore.jks:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/keystore.jks
--------------------------------------------------------------------------------
/app/src/main/ic_launcher-web.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/ic_launcher-web.png
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/app/src/main/res/drawable-v24/sklogo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/drawable-v24/sklogo.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.iml
2 | .gradle
3 | /local.properties
4 | /.idea
5 | .DS_Store
6 | /build
7 | /captures
8 | .externalNativeBuild
9 |
10 | .settings
11 | .project
12 | .classpath
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/singularkey/androidfido2demo/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.png
--------------------------------------------------------------------------------
/app/src/main/res/values/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #FFFFFF
4 |
--------------------------------------------------------------------------------
/scripts/get_cert_fingerprint.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | echo Android Certificate fingerprint
3 |
4 | keytool -list -v -alias fido2 -storepass fido2password -keystore ../app/keystore.jks 2> /dev/null | grep SHA256:
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | Singular Key Fido2 Demo
3 | FIDO2 Register
4 | FIDO2 Login
5 |
6 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Mon Jan 11 10:41:33 NPT 2021
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip
7 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/web/firebase.json:
--------------------------------------------------------------------------------
1 | {
2 | "hosting": {
3 | "public": "public",
4 | "ignore": [
5 | "firebase.json",
6 | "**/.*",
7 | "**/node_modules/**"
8 | ],
9 | "rewrites": [
10 | {
11 | "source": "**",
12 | "destination": "/index.html"
13 | }
14 | ]
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/app/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | #004B4E
5 | #172F30
6 | #FFBF3B
7 |
8 |
--------------------------------------------------------------------------------
/web/public/.well-known/assetlinks.json:
--------------------------------------------------------------------------------
1 | [
2 | {
3 | "relation": ["delegate_permission/common.handle_all_urls"],
4 | "target": {
5 | "namespace": "android_app",
6 | "package_name": "com.singular.singularkey",
7 | "sha256_cert_fingerprints": [
8 | "EF:9E:6C:A0:DE:0B:A5:CE:53:7F:8E:18:39:B3:FA:F1:3A:5F:5C:6A:93:5E:07:3E:AD:47:62:27:10:AB:E6:C1"
9 | ]
10 | }
11 | }
12 | ]
13 |
--------------------------------------------------------------------------------
/app/src/main/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/app/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
22 |
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 |
7 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 | # IDE (e.g. Android Studio) users:
3 | # Gradle settings configured through the IDE *will override*
4 | # any settings specified in this file.
5 | # For more details on how to configure your build environment visit
6 | # http://www.gradle.org/docs/current/userguide/build_environment.html
7 | # Specifies the JVM arguments used for the daemon process.
8 | # The setting is particularly useful for tweaking memory settings.
9 | org.gradle.jvmargs=-Xmx1536m
10 | # When configured, Gradle will run in incubating parallel mode.
11 | # This option should only be used with decoupled projects. More details, visit
12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
13 | # org.gradle.parallel=true
14 | # AndroidX package structure to make it clearer which packages are bundled with the
15 | # Android operating system, and which are packaged with your app's APK
16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn
17 | android.useAndroidX=true
18 | # Automatically convert third-party libraries to use AndroidX
19 | android.enableJetifier=true
20 | # Kotlin code style for this project: "official" or "obsolete":
21 | kotlin.code.style=official
22 | authToken=jp_qdbor4t2ul84ql2sj8vuspuqf5
23 |
24 |
--------------------------------------------------------------------------------
/web/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 | firebase-debug.log*
8 |
9 | # Firebase cache
10 | .firebase/
11 |
12 | # Firebase config
13 |
14 | # Uncomment this if you'd like others to create their own Firebase project.
15 | # For a team working on the same Firebase project(s), it is recommended to leave
16 | # it commented so all members can deploy to the same project(s) in .firebaserc.
17 | # .firebaserc
18 |
19 | # Runtime data
20 | pids
21 | *.pid
22 | *.seed
23 | *.pid.lock
24 |
25 | # Directory for instrumented libs generated by jscoverage/JSCover
26 | lib-cov
27 |
28 | # Coverage directory used by tools like istanbul
29 | coverage
30 |
31 | # nyc test coverage
32 | .nyc_output
33 |
34 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
35 | .grunt
36 |
37 | # Bower dependency directory (https://bower.io/)
38 | bower_components
39 |
40 | # node-waf configuration
41 | .lock-wscript
42 |
43 | # Compiled binary addons (http://nodejs.org/api/addons.html)
44 | build/Release
45 |
46 | # Dependency directories
47 | node_modules/
48 |
49 | # Optional npm cache directory
50 | .npm
51 |
52 | # Optional eslint cache
53 | .eslintcache
54 |
55 | # Optional REPL history
56 | .node_repl_history
57 |
58 | # Output of 'npm pack'
59 | *.tgz
60 |
61 | # Yarn Integrity file
62 | .yarn-integrity
63 |
64 | # dotenv environment variables file
65 | .env
66 |
67 | .firebaserc
--------------------------------------------------------------------------------
/app/src/main/res/drawable-v24/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
12 |
13 |
19 |
22 |
25 |
26 |
27 |
28 |
34 |
35 |
--------------------------------------------------------------------------------
/app/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'com.android.application'
2 | apply plugin: 'kotlin-android'
3 | apply plugin: 'kotlin-android-extensions'
4 |
5 | android {
6 | compileSdkVersion 28
7 | defaultConfig {
8 | applicationId "com.singularkey.androidfido2"
9 | minSdkVersion 21
10 | targetSdkVersion 28
11 | versionCode 1
12 | versionName "1.0"
13 | }
14 | signingConfigs {
15 | release {
16 | storeFile file("keystore.jks")
17 | storePassword "fido2android"
18 | keyAlias "fido2"
19 | keyPassword "fido2android"
20 | }
21 | }
22 | buildTypes {
23 | release {
24 | shrinkResources true
25 | minifyEnabled true
26 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
27 | signingConfig signingConfigs.release
28 | }
29 | debug {
30 | signingConfig signingConfigs.release
31 | }
32 | }
33 | compileOptions {
34 | encoding "UTF-8"
35 | sourceCompatibility JavaVersion.VERSION_1_8
36 | targetCompatibility JavaVersion.VERSION_1_8
37 | }
38 |
39 | // For Kotlin projects add also this line
40 | kotlinOptions.jvmTarget = "1.8"
41 | }
42 |
43 | dependencies {
44 | implementation"org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
45 |
46 | implementation 'androidx.appcompat:appcompat:1.2.0'
47 | implementation 'androidx.core:core-ktx:1.3.2'
48 | implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
49 |
50 | implementation 'com.google.android.gms:play-services-fido:18.1.0'
51 | implementation 'com.squareup.retrofit2:retrofit:2.9.0'
52 | implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
53 | api(platform("com.squareup.okhttp3:okhttp-bom:4.8.0"))
54 | implementation "com.squareup.okhttp3:okhttp-urlconnection:4.8.0"
55 | implementation 'com.squareup.okhttp3:logging-interceptor:4.9.0'
56 | implementation 'com.github.franmontiel:PersistentCookieJar:v1.0.1'
57 |
58 | }
59 |
--------------------------------------------------------------------------------
/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 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
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 Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
6 |
8 |
11 |
14 |
17 |
20 |
23 |
26 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/app/src/main/java/com/singularkey/androidfido2/RPApiService.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2019 Singular Key Inc. All Rights Reserved.
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 | * http://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.singularkey.androidfido2
18 |
19 | import okhttp3.JavaNetCookieJar
20 | import okhttp3.OkHttpClient
21 | import okhttp3.RequestBody
22 | import okhttp3.ResponseBody
23 | import okhttp3.logging.HttpLoggingInterceptor
24 | import retrofit2.Call
25 | import retrofit2.Retrofit
26 | import retrofit2.http.Body
27 | import retrofit2.http.Header
28 | import retrofit2.http.Headers
29 | import retrofit2.http.POST
30 | import java.net.CookieManager
31 | import java.net.CookiePolicy
32 | import java.util.concurrent.TimeUnit
33 |
34 | interface RPApi {
35 | @Headers("Accept: application/json", "Content-Type: application/json")
36 | @POST("register/initiate")
37 | fun registerInitiate(@Body postBody: RequestBody): Call
38 |
39 | @Headers("Accept: application/json", "Content-Type: application/json")
40 | @POST("register/complete")
41 | fun registerComplete(
42 | @Header("Cookie") cookie: String,
43 | @Body body: RequestBody
44 | ): Call
45 | //fun registerComplete(@Body body: RequestBody): Call
46 |
47 | @Headers("Accept: application/json", "Content-Type: application/json")
48 | @POST("auth/initiate")
49 | fun authInitiate(@Body postBody: RequestBody): Call
50 |
51 | @Headers("Accept: application/json", "Content-Type: application/json")
52 | @POST("auth/complete")
53 | fun authComplete(
54 | @Header("Cookie") cookie: String,
55 | @Body postBody: RequestBody
56 | ): Call
57 |
58 | }
59 |
60 | class RPApiService {
61 |
62 | companion object {
63 | var cookieManager: CookieManager? = null
64 |
65 | fun getApi(): RPApi {
66 |
67 | val interceptor = HttpLoggingInterceptor()
68 | interceptor.setLevel(HttpLoggingInterceptor.Level.BODY)
69 | if (cookieManager == null) {
70 | cookieManager = CookieManager()
71 | cookieManager!!.setCookiePolicy(CookiePolicy.ACCEPT_ALL)
72 | }
73 |
74 | val okHttpClientBuilder = OkHttpClient().newBuilder() //create OKHTTPClient
75 | okHttpClientBuilder.cookieJar(JavaNetCookieJar(cookieManager!!))
76 |
77 | val okHttpClient = okHttpClientBuilder
78 | .connectTimeout(120, TimeUnit.SECONDS)
79 | .readTimeout(120, TimeUnit.SECONDS)
80 | .writeTimeout(120, TimeUnit.SECONDS)
81 | .addInterceptor(interceptor)
82 | .build()
83 |
84 | val retrofit =
85 | Retrofit.Builder().client(okHttpClient)
86 | .baseUrl(RP_SERVER_URL)
87 | .build();
88 |
89 | return retrofit.create(RPApi::class.java)
90 | }
91 | }
92 |
93 | }
--------------------------------------------------------------------------------
/app/src/main/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
15 |
16 |
24 |
25 |
26 |
27 |
35 |
36 |
45 |
46 |
47 |
53 |
54 |
64 |
65 |
75 |
76 |
77 |
78 |
79 |
87 |
88 |
89 |
90 |
91 |
92 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
10 |
12 |
14 |
16 |
18 |
20 |
22 |
24 |
26 |
28 |
30 |
32 |
34 |
36 |
38 |
40 |
42 |
44 |
46 |
48 |
50 |
52 |
54 |
56 |
58 |
60 |
62 |
64 |
66 |
68 |
70 |
72 |
74 |
75 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Singular Key Android FIDO2 Demo
2 |
3 | This project demonstrates the registration and use of a FIDO2 credential in an Android App. It uses Android's FIDO2 native API and Singular Key's FIDO2 Cloud Service. FIDO2 Credentials are phishing resistant, attested public key based credentials for strong authentication of users.
4 | The demo supports Android Platform authenticator using fingerprint/screen lock and BLE,NFC,USB based security Keys (roaming authenticators)
5 |
6 | This demonstration requires Demo RP (Relying Party) Server (https://github.com/singularkey/webauthndemo) which communicates to Singular Key's FIDO2 Cloud Service. Please contact support (`support@singularkey.com`) for your `free Api Key`.
7 |
8 | ------------
9 |
10 | ### Dependencies
11 | * Android 7+ device with latest updates with a registered fingerprint. Screenlock can be used as well.
12 | * RP Server (https://github.com/singularkey/webauthndemo) - e.g. https://api.yourcompany.com
13 | * Singular Key API Key
14 |
15 | ### Install
16 | ```sh
17 | git clone https://github.com/singularkey/androidfido2demo.git
18 | ```
19 |
20 | ### Configure
21 |
22 | ##### RP Server (https://github.com/singularkey/webauthndemo)
23 |
24 | * View Readme.md for https://github.com/singularkey/webauthndemo to install and configure the RP Server
25 | * The Android FIDO2 App needs to communicate with the RP Server on `https://`, so you will either need to front the Node RP Server with a reverse Proxy like Nginx and install the certificate in Nginx or just enable https on the Node Service itself. In order to enable https on the Node Service, edit `server/config.json
26 | ```js
27 | "https":{
28 | "enabled":false,
29 | "keyFilePath":"PATH_TO_SSL_KEY_FILE",
30 | "certFilePath":"PATH_TO_SSL_CERT_FILE"
31 | }
32 | ```
33 |
34 | ##### Associate your website with your android App - Update `assetlinks.json`
35 | * To use the FIDO2 API in your android App, you will need to associate your android app with your website. The Android App uses the `RPID` (you'll configure in the next section) to construct a URL to fetch the assetslinks.json file from your RP Server. The url is `https:///.well-known/assetlinks.json`
36 | We have provided you with the assetlinks.json in the RP Server `webapp/.well-known/assetlinks.json`
37 |
38 | * Find the SHA256 Fingerprint of the signing certifiate of your android app by executing the following command in your android project. Password for the keystore is `fido2android`
39 | ```js
40 | cd app
41 | keytool -exportcert -list -v -keystore ./keystore.jks
42 | ```
43 | * Update the /webapp/.well-known/assetslinks.json file in the RP Server project
44 | ```
45 | sha256_cert_fingerprints entry in the assetlinks.json file.
46 | ```
47 |
48 | ##### Android FIDO2 App (This Repository)
49 |
50 | Edit `MainActivity.kt`
51 | ```Js
52 | var RP_SERVER_URL = "ADD_YOUR_RP_SERVER_URL_HERE"; //e.g., https://api.singularkey.com
53 | var RPID = "ADD_YOUR_RPID_HERE" // e.g., api.yourcompany.com. RPID is a valid domain string that identifies the WebAuthn Relying Party on whose behalf a given registration or authentication ceremony is being performed. A public key credential can only be used for authentication with the same entity (as identified by RP ID) it was registered with.
54 | ```
55 |
56 | ##### Singular Key FIDO2 Settings (https://devportal.singularkey.com)
57 | * There are two main settings for the FIDO2 Section in your client app in the Singular Key Admin Portal. Log into the Admin portal using the credentials provided to you.
58 | * `Supported Origin Domain Name`: In case of Android, this will be the apk-key-hash in the format android:apk-key-hash: (e.g. android:apk-key-hash:xYvjmzazZxLXDNrFnWUq_EObrht2yX2hfmkrehWrJ5Y). One way to find out this value is to attempt to register a FIDO2 credential using the Android Demo app. You'll see a client mismatch error in the RP Server logs with the android origin value.
59 | * `Rp Id`: Enable this and update the value with the RPID used in the Android Fido2 App. (in the section above)
60 |
61 | Click on `Save` towards the bottom of the Fido2 settings form to persist your changes.
62 |
63 | ### Run
64 | Build your Android App and install it on an android device. Below is a demonstration of the functionality:
65 |
66 |
67 |
68 |
69 | ### Architecture
70 | `Android FIDO2 Demo App` --> `RP Server (Default Port 3001)` API --> `Singular Key's FIDO Cloud Service`
71 |
72 | ### Key Files
73 | * `MainActivity.kt` : Check out https://webauthn.singularkey.com/ for FIDO2 Sequence Diagrams.
74 | * FIDO2 Registration Steps:
75 | * 1. `fido2RegisterInitiate()` : Relying Party (RP) Server API call which is proxied to Singular Key FIDO Service to initiate the FIDO2 registration process to retrieve a randomly generated challenge and other RP and User information
76 | * 2. `fido2AndroidRegister()` : Android Attestation API call to create a fingerprint/screenlock secured public key based strong `FIDO2 credential`and sign the response (`public key`, challenge and other information)
77 | * 3. `fido2RegisterComplete()` : The signed response is sent to the RP Server API which is proxied to Singular Key FIDO Service to complete the FIDO2 registration process
78 | * FIDO2 Authentication Steps:
79 | * `fido2AuthInitiate()` : RP Server API call which is proxied to Singular Key FIDO Service to initiate the FIDO2 Authentication process to retrieve a randomly generated challenge and other information
80 | * `fido2AndroidAuth()` : Android Assertion API call to create a signed response (challenge and other information) with the previously created FIDO2 Credential.
81 | * `fido2AuthComplete()` : The signed response is sent to the RP Server API which is proxied to Singular Key FIDO Service to complete the FIDO2 Authentication process
82 |
83 | * `RPApiService.kt` - RP API Interface
84 | * POST /register/initiate
85 | * POST /register/complete
86 | * POST /auth/initiate
87 | * POST /auth/complete
88 |
89 | ------------
90 | # Support
91 | Have questions? Please contact Support (`support@singularkey.com`) or sign up at http://singularkey.com/singular-key-web-authn-fido-developer-program-api/
92 |
93 | # License
94 | Apache 2.0
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/app/src/main/java/com/singularkey/androidfido2/MainActivity.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2019 Singular Key Inc. All Rights Reserved.
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 | * http://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.singularkey.androidfido2
18 |
19 | import android.content.Intent
20 | import android.content.IntentSender
21 | import android.os.Bundle
22 | import android.util.Base64
23 | import android.util.Log
24 | import androidx.appcompat.app.AppCompatActivity
25 | import com.google.android.gms.fido.Fido
26 | import com.google.android.gms.fido.fido2.api.common.*
27 | import kotlinx.android.synthetic.main.activity_main.*
28 | import okhttp3.MediaType.Companion.toMediaTypeOrNull
29 | import okhttp3.RequestBody
30 | import okhttp3.ResponseBody
31 | import org.json.JSONArray
32 | import org.json.JSONObject
33 | import retrofit2.Call
34 | import retrofit2.Callback
35 | import retrofit2.Response
36 |
37 | //var RP_SERVER_URL = "https://12841968ac5b.ngrok.io"; //e.g., https://api.singularkey.com
38 | var RP_SERVER_URL = "https://webauthndemo.singularkey.com"; //e.g., https://api.singularkey.com
39 |
40 | //var RPID = "12841968ac5b.ngrok.io" // e.g., api.yourcompany.com
41 | var RPID = "webauthndemo.singularkey.com" // e.g., api.yourcompany.com
42 |
43 |
44 | private const val BASE64_FLAG = Base64.NO_PADDING or Base64.NO_WRAP or Base64.URL_SAFE
45 |
46 |
47 | class MainActivity : AppCompatActivity() {
48 | companion object {
49 | private const val LOG_TAG = "SingularKeyFido2Demo"
50 | private const val REQUEST_CODE_REGISTER = 1
51 | private const val REQUEST_CODE_SIGN = 2
52 | private const val KEY_HANDLE_PREF = "key_handle"
53 | }
54 |
55 | override fun onCreate(savedInstanceState: Bundle?) {
56 | super.onCreate(savedInstanceState)
57 | setContentView(R.layout.activity_main)
58 |
59 | //Listener for the 2 Buttons - Fido2 Register and Fido2 Login
60 | registerFido2Button.setOnClickListener { fido2RegisterInitiate() }
61 | loginFido2Button.setOnClickListener { fido2AuthInitiate() }
62 | }
63 |
64 | //**********************************************************************************************************//
65 | //******************************* Android FIDO2 API Response ***********************************************//
66 | //**********************************************************************************************************//
67 | override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
68 | super.onActivityResult(requestCode, resultCode, data)
69 | Log.d(LOG_TAG, "onActivityResult - requestCode: $requestCode, resultCode: $resultCode")
70 |
71 | when (resultCode) {
72 | RESULT_OK -> {
73 | data?.let {
74 | if (it.hasExtra(Fido.FIDO2_KEY_ERROR_EXTRA)) {
75 |
76 | val errorExtra = data.getByteArrayExtra(Fido.FIDO2_KEY_ERROR_EXTRA)
77 | val authenticatorErrorResponse =
78 | AuthenticatorErrorResponse.deserializeFromBytes(errorExtra)
79 | val errorName = authenticatorErrorResponse.errorCode.name
80 | val errorMessage = authenticatorErrorResponse.errorMessage
81 |
82 | Log.e(LOG_TAG, "errorCode.name: $errorName")
83 | Log.e(LOG_TAG, "errorMessage: $errorMessage")
84 |
85 | resultText.text =
86 | "An Error Occurred\n\nError Name:\n$errorName\n\nError Message:\n$errorMessage"
87 |
88 | } else if (it.hasExtra(Fido.FIDO2_KEY_RESPONSE_EXTRA)) {
89 | val fido2Response = data.getByteArrayExtra(Fido.FIDO2_KEY_RESPONSE_EXTRA)
90 | when (requestCode) {
91 | REQUEST_CODE_REGISTER -> fido2RegisterComplete(fido2Response)
92 | REQUEST_CODE_SIGN -> fido2AuthComplete(fido2Response)
93 | }
94 | }
95 | }
96 | }
97 | RESULT_CANCELED -> {
98 | val result = "Operation is cancelled"
99 | resultText.text = result
100 | Log.d(LOG_TAG, result)
101 | }
102 | else -> {
103 | val result = "Operation failed, with resultCode: $resultCode"
104 | resultText.text = result
105 | Log.e(LOG_TAG, result)
106 | }
107 | }
108 | }
109 |
110 | //**********************************************************************************************************//
111 | //******************************* FIDO2 Registration Step 1 ************************************************//
112 | //******************************* Get challenge from the Server ********************************************//
113 | //**********************************************************************************************************//
114 | private fun fido2RegisterInitiate() {
115 |
116 | val result = JSONObject()
117 | val mediaType = "application/json".toMediaTypeOrNull()
118 |
119 | result.put("username", usernameButton.text.toString())
120 |
121 | //Optional
122 | val jsonObject = JSONObject()
123 | //jsonObject.put("authenticatorAttachment","platform")
124 | jsonObject.put("userVerification", "required")
125 | result.put("authenticatorSelection", jsonObject)
126 |
127 | val requestBody = RequestBody.create(mediaType, result.toString())
128 |
129 | try {
130 | RPApiService.getApi().registerInitiate(requestBody)
131 | .enqueue(object : Callback {
132 | override fun onResponse(
133 | call: Call,
134 | response: Response
135 | ) {
136 | if (response.isSuccessful) {
137 |
138 | var obj = JSONObject(response.body()?.string())
139 | var intiateResponse = obj.getJSONObject("initiateRegistrationResponse")
140 | val c = intiateResponse?.getString("challenge")
141 | val challenge = Base64.decode(c!!, BASE64_FLAG)
142 | var rpname = intiateResponse?.getJSONObject("rp")!!.getString("name")
143 | var username =
144 | intiateResponse?.getJSONObject("user")!!.getString("name")
145 | var userId = intiateResponse?.getJSONObject("user")!!.getString("id")
146 |
147 | var authenticatorAttachement = ""
148 | if (intiateResponse.has("authenticatorSelection")) {
149 | if (intiateResponse?.getJSONObject("authenticatorSelection")
150 | .has("authenticatorAttachment")
151 | ) {
152 | authenticatorAttachement =
153 | intiateResponse?.getJSONObject("authenticatorSelection")
154 | ?.getString("authenticatorAttachment")!!
155 | Log.d(
156 | LOG_TAG,
157 | "authenticatorAttachement $authenticatorAttachement"
158 | )
159 | }
160 | }
161 |
162 | val attestation = intiateResponse?.getString("attestation")
163 | Log.d(LOG_TAG, attestation)
164 | var attestationPreference: AttestationConveyancePreference =
165 | AttestationConveyancePreference.NONE
166 | if (attestation == "direct") {
167 | attestationPreference = AttestationConveyancePreference.DIRECT
168 | } else if (attestation == "indirect") {
169 | attestationPreference = AttestationConveyancePreference.INDIRECT
170 | } else if (attestation == "none") {
171 | attestationPreference = AttestationConveyancePreference.NONE
172 | }
173 |
174 | fido2AndroidRegister(
175 | rpname,
176 | challenge,
177 | userId,
178 | username,
179 | authenticatorAttachement,
180 | attestationPreference
181 | )
182 | } else {
183 | resultText.text = response.toString()
184 | }
185 |
186 | }
187 |
188 | override fun onFailure(call: Call, t: Throwable) {
189 | Log.d(LOG_TAG, t.message)
190 | resultText.text = t.message
191 | }
192 | })
193 | } catch (e: Exception) {
194 | e.printStackTrace()
195 | }
196 |
197 | }
198 |
199 |
200 | //**********************************************************************************************************//
201 | //******************************* FIDO2 Registration Step 2 ************************************************//
202 | //******************************* Invoke Android FIDO2 API ************************************************//
203 | //**********************************************************************************************************//
204 |
205 | private fun fido2AndroidRegister(
206 | rpname: String,
207 | challenge: ByteArray,
208 | userId: String,
209 | userName: String?,
210 | authenticatorAttachment: String?,
211 | attestationPreference: AttestationConveyancePreference
212 | ) {
213 |
214 | try {
215 | val options = PublicKeyCredentialCreationOptions.Builder()
216 | .setAttestationConveyancePreference(attestationPreference)
217 | .setRp(PublicKeyCredentialRpEntity(RPID, rpname, null))
218 | .setUser(
219 | PublicKeyCredentialUserEntity(
220 | userId.toByteArray(),
221 | userId,
222 | null,
223 | userName
224 | )
225 | )
226 | .setChallenge(challenge)
227 | .setParameters(
228 | listOf(
229 | PublicKeyCredentialParameters(
230 | PublicKeyCredentialType.PUBLIC_KEY.toString(),
231 | EC2Algorithm.ES256.algoValue
232 | )
233 | )
234 | )
235 |
236 | if (authenticatorAttachment != "") {
237 | val builder = AuthenticatorSelectionCriteria.Builder()
238 | builder.setAttachment(Attachment.fromString("platform"))
239 | options.setAuthenticatorSelection(builder.build())
240 | }
241 |
242 | val fido2ApiClient = Fido.getFido2ApiClient(applicationContext)
243 | val fido2PendingIntentTask = fido2ApiClient.getRegisterIntent(options.build())
244 | fido2PendingIntentTask.addOnSuccessListener { fido2PendingIntent ->
245 | if (fido2PendingIntent.hasPendingIntent()) {
246 | try {
247 | Log.d(LOG_TAG, "launching Fido2 Pending Intent")
248 | fido2PendingIntent.launchPendingIntent(
249 | this@MainActivity,
250 | REQUEST_CODE_REGISTER
251 | )
252 | } catch (e: IntentSender.SendIntentException) {
253 | e.printStackTrace()
254 | }
255 | }
256 | }
257 | } catch (e: Exception) {
258 | e.printStackTrace()
259 | }
260 |
261 |
262 | }
263 |
264 |
265 | //**********************************************************************************************************//
266 | //******************************* FIDO2 Registration Step 3 ************************************************//
267 | //***************************** Send Signed Challenge (Attestation) to the Server for validation ***********//
268 | //**********************************************************************************************************//
269 | private fun fido2RegisterComplete(fido2Response: ByteArray) {
270 | val attestationResponse =
271 | AuthenticatorAttestationResponse.deserializeFromBytes(fido2Response)
272 | val credId = Base64.encodeToString(attestationResponse.keyHandle, BASE64_FLAG)
273 | val clientDataJson = Base64.encodeToString(attestationResponse.clientDataJSON, BASE64_FLAG)
274 | val attestationObjectBase64 =
275 | Base64.encodeToString(attestationResponse.attestationObject, Base64.DEFAULT)
276 |
277 | val webAuthnResponse = JSONObject()
278 | val response = JSONObject()
279 |
280 | response.put("attestationObject", attestationObjectBase64)
281 | response.put("clientDataJSON", clientDataJson)
282 |
283 |
284 | webAuthnResponse.put("type", "public-key")
285 | webAuthnResponse.put("id", credId)
286 | webAuthnResponse.put("rawId", credId)
287 | webAuthnResponse.put("getClientExtensionResults", JSONObject())
288 | webAuthnResponse.put("response", response)
289 |
290 | val mediaType = "application/json".toMediaTypeOrNull()
291 | val requestBody = RequestBody.create(mediaType, webAuthnResponse.toString())
292 |
293 | try {
294 | RPApiService.getApi()
295 | .registerComplete("username=${usernameButton.text.toString()}", requestBody)
296 | //.registerComplete( requestBody)
297 | .enqueue(object : Callback {
298 | override fun onResponse(
299 | call: Call,
300 | response: Response
301 | ) {
302 | if (response.isSuccessful) {
303 | resultText.text = "Registration Successful"
304 | Log.d("response", response.message())
305 | } else {
306 | resultText.text = "Registration Failed" + "\n" + response.toString()
307 | Log.d("response", response.errorBody().toString())
308 | }
309 |
310 | }
311 |
312 | override fun onFailure(call: Call, t: Throwable) {
313 | Log.d("response", t.message)
314 |
315 | }
316 | })
317 | } catch (e: Exception) {
318 | e.printStackTrace()
319 | }
320 | }
321 |
322 |
323 | //**********************************************************************************************************//
324 | //******************************* FIDO2 Authentication Step 1 **********************************************//
325 | //******************************* Get challenge from the Server ********************************************//
326 | //**********************************************************************************************************//
327 | private fun fido2AuthInitiate() {
328 |
329 | val result = JSONObject()
330 | val mediaType = "application/json".toMediaTypeOrNull()
331 | result.put("username", usernameButton.text.toString())
332 | val requestBody = RequestBody.create(mediaType, result.toString())
333 | try {
334 | RPApiService.getApi().authInitiate(requestBody)
335 | .enqueue(object : Callback {
336 | override fun onResponse(
337 | call: Call,
338 | response: Response
339 | ) {
340 | if (response.isSuccessful) {
341 | val obj = JSONObject(response.body()?.string())
342 | val c = obj?.getString("challenge")
343 | val challenge = Base64.decode(c!!, BASE64_FLAG)
344 | val allowCredentials = obj?.getJSONArray("allowCredentials")
345 |
346 | fido2AndroidAuth(allowCredentials, challenge)
347 |
348 | Log.d("response", response.message())
349 | } else {
350 | Log.d("response", response.errorBody().toString())
351 | resultText.text = "Authentication Failed" + "\n" + response.toString()
352 | }
353 |
354 | }
355 |
356 | override fun onFailure(call: Call, t: Throwable) {
357 | Log.d("response", t.message)
358 |
359 | }
360 | })
361 | } catch (e: Exception) {
362 | e.printStackTrace()
363 | }
364 | }
365 |
366 | //**********************************************************************************************************//
367 | //******************************* FIDO2 Authentication Step 2 **********************************************//
368 | //******************************* Invoke Android FIDO2 API ************************************************//
369 | //**********************************************************************************************************//
370 | private fun fido2AndroidAuth(
371 | allowCredentials: JSONArray,
372 | challenge: ByteArray
373 | ) {
374 | try {
375 | val list = mutableListOf()
376 | for (i in 0..(allowCredentials.length() - 1)) {
377 | val item = allowCredentials.getJSONObject(i)
378 | list.add(
379 | PublicKeyCredentialDescriptor(
380 | PublicKeyCredentialType.PUBLIC_KEY.toString(),
381 | Base64.decode(item.getString("id"), BASE64_FLAG),
382 | /* transports */ null
383 | )
384 | )
385 | }
386 |
387 | val options = PublicKeyCredentialRequestOptions.Builder()
388 | .setRpId(RPID)
389 | .setAllowList(list)
390 | .setChallenge(challenge)
391 | .build()
392 |
393 | val fido2ApiClient = Fido.getFido2ApiClient(applicationContext)
394 | val fido2PendingIntentTask = fido2ApiClient.getSignIntent(options)
395 | fido2PendingIntentTask.addOnSuccessListener { fido2PendingIntent ->
396 | if (fido2PendingIntent.hasPendingIntent()) {
397 | try {
398 | Log.d(LOG_TAG, "launching Fido2 Pending Intent")
399 | fido2PendingIntent.launchPendingIntent(this@MainActivity, REQUEST_CODE_SIGN)
400 | } catch (e: IntentSender.SendIntentException) {
401 | e.printStackTrace()
402 | }
403 | }
404 | }
405 | } catch (e: Exception) {
406 | e.printStackTrace()
407 | }
408 | }
409 |
410 | //**********************************************************************************************************//
411 | //******************************* FIDO2 Authentication Step 3 **********************************************//
412 | //**************** Send Signed Challenge (Assertion) to the Server for verification ************************//
413 | //**********************************************************************************************************//
414 | private fun fido2AuthComplete(fido2Response: ByteArray) {
415 |
416 | val assertionResponse = AuthenticatorAssertionResponse.deserializeFromBytes(fido2Response)
417 | val credId = Base64.encodeToString(assertionResponse.keyHandle, BASE64_FLAG)
418 | val signature = Base64.encodeToString(assertionResponse.signature, BASE64_FLAG)
419 | val authenticatorData =
420 | Base64.encodeToString(assertionResponse.authenticatorData, BASE64_FLAG)
421 | val clientDataJson = Base64.encodeToString(assertionResponse.clientDataJSON, BASE64_FLAG)
422 |
423 |
424 | val response = JSONObject()
425 | response.put("clientDataJSON", clientDataJson)
426 | response.put("signature", signature)
427 | response.put("userHandle", "")
428 | response.put("authenticatorData", authenticatorData)
429 |
430 | val jsonObject = JSONObject()
431 | jsonObject.put("type", "public-key")
432 | jsonObject.put("id", credId)
433 | jsonObject.put("rawId", credId)
434 | jsonObject.put("getClientExtensionResults", JSONObject())
435 | jsonObject.put("response", response)
436 |
437 | val mediaType = "application/json".toMediaTypeOrNull()
438 | val requestBody = RequestBody.create(mediaType, jsonObject.toString())
439 |
440 | try {
441 | RPApiService.getApi()
442 | .authComplete("username=${usernameButton.text.toString()}", requestBody)
443 | .enqueue(object : Callback {
444 | override fun onResponse(
445 | call: Call,
446 | response: Response
447 | ) {
448 | if (response.isSuccessful) {
449 | resultText.text = "Authentication Successful"
450 | Log.d("response", response.message())
451 | } else {
452 | Log.d("response", response.errorBody().toString())
453 | resultText.text = "Authentication Failed" + "\n" + response.toString()
454 | }
455 |
456 | }
457 |
458 | override fun onFailure(call: Call, t: Throwable) {
459 | Log.d("response", t.message)
460 |
461 | }
462 | })
463 | } catch (e: Exception) {
464 | e.printStackTrace()
465 | }
466 | }
467 |
468 | }
469 |
--------------------------------------------------------------------------------