SDK Integration
This section provides detailed information on how to integrate the Netcetera 3DS SDK into an iOS Application or Library.
Cocoapods Setup
Steps to include the SDK into the project:
- Install Cocoapods following the instructions on the Cocoapods website.
- In your Podfile add the 3DS SDK private spec repo as source, and add the ThreeDS SDK as dependency.
- To install the pods run
pod install.
Swift Package Manager Setup
To add 3DS SDK as dependency to your Xcode project, select File > Add Packages and enter the repository URL: https://github.com/ios-3ds-sdk/SPM.git. Proceed by selecting which version of the SDK you want to integrate.
You can also navigate to your target’s General pane, and in the “Frameworks, Libraries, and Embedded Content” section, click the + button, select Add Other, and choose Add Package Dependency.
Manual Setup
Dynamic Framework
Extract the Netcetera iOS 3DS SDK zip archive that is part of the delivery. Inside there is a single XCFramework
ThreeDS_SDK.xcframeworkIn your project, add the XCFramework in the "Frameworks, Libraries, and Embedded Content" section in the General target's tab.
Static Framework
Extract the Netcetera iOS 3DS SDK Static zip archive that is part of the delivery. Inside there is an XCFramework
ThreeDS_SDK.xcframeworkand a bundleThreeDS-SDK-Resources.bundleIn your project, add the XCFramework in the "Frameworks, Libraries, and Embedded Content" section in the General target's tab.
Add the resources bundle in "Copy Bundle Resources" of the "Build Phases" section.
License Setup
A license file containing a license key is distributed along with the SDK. In order to be able to use the Netcetera iOS 3DS SDK, the license key must be added in the ConfigParameters which are passed in the Initialization of the ThreeDS2Service.
Using ConfigurationBuilder (Recommended)
An easier way to pass the license key is to use the ConfigurationBuilder. This is done by using the license(key: String) function. The builder helps populate the ConfigParameters easier.
After setting all values in the builder, simply call .configParameters() to generate the ConfigParameters object that can be passed in the initialize method of ThreeDS2Service class.
Example:
Configuration with ConfigParameters
To define the license without the use of a ConfigurationBuilder, use ConfigParameters.addParameters(...) with the following arguments:
| Argument | Value |
|---|---|
group | nil |
paramName | "license-key" |
paramValue | The content of the license file. |
Example:
Dependencies
Several external dependencies are used by the Netcetera iOS 3DS SDK. These libraries are integrated inside the SDK. The full list of dependencies is:
| Name | Description | Website | License | Version |
|---|---|---|---|---|
| ASN1Decoder | Used to parse keys and certificates in ASN1 structure | https://github.com/filom/ASN1Decoder | MIT license | 1.2 |
| SwCrypt | Library with crypto functions used in the SDK for JWS validation and signing, used only in iOS 10 | https://github.com/soyersoyer/SwCrypt | MIT license | 5.1.3 |
| GMEllipticCurveCrypto | Security framework used for Elliptic Curve keys | https://github.com/ricmoo/GMEllipticCurveCrypto | BSD 2-Clause "Simplified" License | 1.1 |
App Transport Security - HTTP Loads
The EMVCo 3DS Specification requires the communication between the 3DS SDK and the ACS to go through HTTPS, but there is no such requirement for what protocol to be used when downloading the Payment System and Issuer logo images that shall be shown in the challenge screens. The URLs of these images are provided as parameters by the ACS in the CRes and it is expected they will be HTTPS URLs. The SDK doesn't have influence over this and if HTTP URLs are provided, the images will not be shown on the challenge screens.
More information about this and how to ensure that these images will be downloaded and shown on the challenge screen even if they are served using unsecured connection, please check Preventing Insecure Network Connections