SDK overview

SDK component versions

The SDK contains the following components:

• uaf-core-ext 3.0.7
• fido-sample-webapp 3.0.9

Supported versions

Table: Supported platforms and versions lists the platforms and versions that the OneSpan FIDO UAF SDK currently supports.

Product package contents

The structure of the product package ZIP file is as follows:

• doc: This directory contains the OneSpan FIDO UAF SDK Integration Guide.

• library: This directory contains the SDK files:

  • bin: This directory contains the binary files.

    • uaf-core-ext-3.0.7.jar: Contains the FIDO UAF SDK implementation files without the required third-party dependencies.
    • uaf-core-ext-3.0.7.pom: Contains the list of third-party dependencies together with their associated versions, which are needed by the FIDO UAF SDK implementation.
  • doc: Contains the ZIP file that holds the SDK Java code documentation.
  • db-schema.sql: Contains an example database schema generated for MariaDB that can be used to store FIDO-related data in a persistent relational database.

• sample: This directory contains an example application that uses the OneSpan FIDO UAF SDK. It exposes REST endpoints and a simple front end to demonstrate FIDO UAF usage scenarios. The sample directory contains the following sub-directories:

  • bin: Contains the application WAR archive (fido-sample-webapp-3.0.9.war), which can be deployed to the web server.
  • src: Contains the sample web application source code.

Adding the OneSpan FIDO UAF SDK to your project

The uaf-core-ext-3.0.7.jar is a thin Java archive file (JAR) that contains the FIDO UAF SDK implementation. It does not contain the required third-party dependencies. The SDK includes a Project Object Model (POM) file that declares all the required third-party dependencies and their associated versions.

The POM file can be found in the binary folder of the extracted package, i.e. sdk\uaf11\library\bin\uaf-core-ext-3.0.7.pom.

To integrate the SDK library into your project

1. Create the following repository folder structure in your project root folder:

   project_folder\repository\com\onespan\fido\uaf11\uaf-core-ext\3.0.7

   Replace project_folder with the top folder of your project.

2. Copy uaf-core-ext-3.0.7.jar and uaf-core-ext-3.0.7.pom to the new repository folder.

3. Adapt your build.gradle file to enable the import from the new repository folder:

   repositories {
     maven {
       url "${projectDir}/repository"
     }
     mavenCentral()
   }

4. To import the OneSpan FIDO UAF SDK implementation, update the dependency section:

   dependencies {
     implementation 'com.onespan.fido.uaf11:uaf-core-ext:3.0.7'
   }