Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

General

There are two version of the The Android FIDO Client API . The FIDO Client Intent API which calls the stand-alone FIDO Client app via an implicit Intent that is share by many apps. As well as the FIDO Client Embedded API which is a part of your app and is only used by your appprovides a wrapper for all calls to the SurePassID FIDO Server as well as initiating the Google FIDO U2F Client.

Requirements

Minimum SDK Version: Android 4.4 - 4.4.4 KitKat (API level 19)

Supported U2F Authenticator Transports

  • NFC
  • USB HID
  • Bluetooth Low Energy (A.K.A. BLE, Bluetooth Smart)Virtual (included in client)

Maven Repository Access

Access to the SurePassID Maven Repository is required to build the demo application code below. Please request a username and password for access. The gradle build scripts use system environment variables for to resolve your username and password for the maven repository. The environment variable names are "MVN_USERNAME" and "MVN_PASSWORD". Please refer to your OS instructions for setting these environment variables.

Google FIDO U2F Client

...

API - Demo App

Follow these steps to build, install and run the U2F App using the Intent API demo code.

1. Install the SurePassID FIDO Client app from the Google Play Store.

https://play.google.com/store/apps/details?id=com.surepassid.u2fclient

2. Create an account to use with the app that you are about ready to build and install. It is important to include an email address and phone number when creating the account.

https://fidocert.surepassid.com/account.aspx

32. Clone the code from GitHub. (you must request access to this repository for your GitHub account from SurePassID)

Code Block
$ git clone https://github.com/SurePassID/U2FApp

43. Open the project that you just cloned using Android Studio.

File > Open...

54. When the project loads you will see the following two errors. 

/U2FApp/U2FApp/build.gradle
Error:(34, 13) Failed to resolve: com.surepassid.ui:ui-lib:1.0-SNAPSHOT
Error:(33, 13) Failed to resolve: com.surepassid.fido:u2f-client-intent-api:1.01-SNAPSHOT

65. To correct these error edit the file /U2FApp/build.gradle and add the maven repository information that was provided to you. After saving the changes select the following from the Android Studio menu.

Tools > Android > Sync Project with Gradle Files

76. You can now run the app on your Android device.

Run > Run 'U2FApp-U2FApp'

FIDO Client Embedded API - Demo App

Follow these steps to build, install and run the U2F App using the Embedded API demo code.

1. Create an account to use with the app that you are about ready to build and install. It is important to include an email address and phone number when creating the account.

https://fidocert.surepassid.com/account.aspx

2. Clone the code from GitHub. (you must request access to this repository for your GitHub account from SurePassID)

Code Block
$ git clone https://github.com/SurePassID/U2FAppEmbededClient

3. Open the project that you just cloned using Android Studio.

File > Open...

4. You can now run the app on your Android device.

Run > Run 'U2FAppWithEmbededClient'