The SDK is distributed as a ZIP archive file. This archive includes platform and architecture-independent libraries for both ASP.NET and Java color QR code technologies.
SDK prerequisites
The prerequisites for the SDK depend on the integration type and level of SDK usage.
| Integration type | Run samples/sample website | Modify samples/Create own solution |
|---|---|---|
Client integration (Java) | Web server and servlet container supporting Java Servlet specification 3.1.0 and JavaServer Pages specification (JSP) 2.3, i.e., JavaEE 7 web profile-compliant. Example: Apache Tomcat 10 | Java IDE of your choice Example: NetBeans or Eclipse with JDK integrated |
Client integration (ASP.NET) | Internet Information Services (IIS) 10 with ASP.NET support enabled. | Microsoft Visual Studio |
Client integration (SOAP) | Generic SOAP client Example: SoapUI | SOAP library of your choice that you integrate into your client applications. Example: gSOAP |
Back-end integration (Plug-in engine) | OneSpan Authentication Server | A C compiler of your choice,capable of generating a dynamic-link library (.dll) or shared object library (.so) file, depending on the selected platform. |
SDK sample websites
The SDK provides the following sample websites:
Java sample website
ASP.NET sample website
Each sample website comes with a default homepage providing an overview of the functionality that can be tested. The functionality provided by the sample websites is divided into the following functional groups:
Authentication auth-sdk full-sdk
Signature validation auth-sdk full-sdk
Administration full-sdk
Mobile Authenticator Studio provisioning full-sdk
Java sample website requirements
The Java sample website provided in this SDK requires the following:
A web server and servlet container compliant with:
Jakarta Servlet specification 6.0.0
Jakarta Server Pages (JSP) specification 3.1
Java Development Kit (JDK) 17
Jakarta EE 10
The Java sample website has been tested successfully in the following environment:
Apache Tomcat 10.1.48
Azul Zulu 17
ASP.NET sample website requirements
The ASP.NET sample website provided in this SDK requires the following:
Microsoft Internet Information Services (IIS) 10
Microsoft .NET Framework 4.7 or 4.8
Preparing OneSpan Authentication Server for the SDK sample website installation
Before you set up a sample website, ensure that OneSpan Authentication Server is installed properly. For more information about installing OneSpan Authentication Server, refer to the OneSpan Authentication Server Installation Guide for Linux or OneSpan Authentication Server Installation Guide for Windows.
Configuration
OneSpan Authentication Server must be configured accordingly to install the SDK sample website. You can apply all the required settings via the OneSpan Authentication Server Configuration Utility. The following settings are required:
Communicators. In the SOAP tab, the SOAP protocol must be enabled.
By default, the SSL cipher suite security level for SOAP is set to Very High. This implies that TLS v1.2 or later is supported only.
If your organization is impacted by the General Data Protection Regulation (GDPR), ensure that the SOAP communicator interface is configured to use SSL. If an OneSpan Authentication Server component does not support SSL, the SOAP interface must be configured without SSL; however, to be GDPR-compliant, you must set up an encrypted VPN tunnel to secure the communication.
For more information about GDPR, refer to the OneSpan Authentication Server General Data Protection Regulation Compliance Guide.
OneSpan Authentication Server Component. A client component must be defined for the IP address of the OneSpan Authentication Server.
License. A license must be loaded for the OneSpan Authentication Server component. This license should have SOAP enabled, along with the different SOAP features you want to test using the sample website.
Client components
Depending on your requirements, you need to create the respective SOAP client components in OneSpan Authentication Server.
To use the basic authentication functionality of the sample websites:
Location: IP address of the machine hosting the sample website.
Component Type: Authentication Sample Client
Policy ID: Identikey Local Authentication
To use the signature validation functionality of the sample websites:
Location: IP address of the machine hosting the sample website.
Component Type: Signature Sample Client
Policy ID: Identikey Real-time Signature verification 1
To use the Secure Channel authentication functionality of the sample websites:
Location: IP address of the machine hosting the sample website.
Component Type: Authentication with Secure Channel Sample Client
Policy ID: IDENTIKEY Authentication with Secure Channel
To use the Secure Channel signature functionality of the sample websites:
Location: IP address of the machine hosting the sample website.
Component Type: Signature Secure Channel Sample Client
Policy ID: IDENTIKEY Signature Validation with Secure Channel
To use the multi-device licensing (MDL) provisioning functionality of the sample websites:
Location: IP address of the machine hosting the sample website.
Component Type: Multi-Device Licensing Provisioning Sample Client
Policy ID: IDENTIKEY Provisioning for Multi-Device Licensing
When you perform an advanced installation of OneSpan Authentication Server, you can provide the IP address of the SDK host during the initial configuration. If you do, the Configuration Wizard automatically creates the required client components automatically.
Next steps
Once these settings are applied, you can install the sample websites as required for Java and .NET.