Integrate Bometric Authentication (IFAA) SDK for iOS

1. Download the SDK

Download the SDK package from the official website and decompress the SDK package. The following folders are extracted from the SDK package:

2. Before you start

2.1 Make preparations

Make sure that an application is created in the Security Authentication console and the biometric authentication (IFAA) feature is enabled.

2.2 Understand the integration process

2.3 Run the demo project

Decompress the IDaaSDoraemonDemo demo project. Change the bundle ID and the application key to the actual values.

2.4 Build a development environment

The operating system on which the application runs must be iOS 11.0 or later.

The supported programming languages are Objective C and Swift.

2.4.1 Add a primary library

Choose Targets > General > Linked Frameworks and Libraries and add the primary library.

IDaaSDoraemonSDK.framework

If you want to add an additional primary library for authentication, perform the following steps:

Step 1: Choose Targets > General > Linked Frameworks and Libraries and add the primary library.

IFAAAuthenticator.framework
etasSdk.framework
APOpenSSL.framework
APSecCrypto.framework

Step 2: Add system libraries.

Security.framework
AVFoundation.framework
LocalAuthentication.framework
Foundation.framework
libc++.tbd

Step 3: Choose Targets > Build Phases > Copy Bundle Resources and add the resource file.

etasSdk.bundle

2.4.2 Configure the build settings

Choose Targets > BuildSettings and add the -ObjC prefix to the parameters in the Other Linker Flags section. Make sure that the prefix is added and the letter C is in the uppercase. Otherwise, a crash occurs when you run the demo project.

3. Use Bometric Authentication (IFAA) SDK

3.1 Methods and properties of the IDaaSDoraemonManager class

3.1.1 Obtain an authentication instance

  /** 
  * Method: sharedInstance
  * @param None.
  * Return value: the shared instance of the class.
  */  
+ (instancetype _Nonnull )sharedInstance;  

3.1.2 Obtain the SDK version

/** 
* Method: getVersion
* @param None.
* Return value: the SDK version number in the string format.
*/  
- (NSString *_Nonnull)getVersion;

3.1.3 Initialize the security authentication service

/**
 * Initialize the security authentication service
 *  @param applicationExternalId The external ID of the application.
 *  @param appKey The application key.
 *  @param complete The callback to return the result to the main thread.
 */
-(void)SDKInitWithApplicationExternalId:(NSString *)applicationExternalId appKey:(NSString *)appKey complete:(void (^)(NSDictionary *resultDic))complete;

3.1.4 Obtain an access token

Call the FetchAccessToken operation of the server SDK and pass the token to the client SDK.

/** Obtain a token */
@property (nonatomic,copy) NSDictionary *(^fetchAccessTokenCallBack)(NSString *mobileExtendParamsJson, NSString *mobileExtendParamsJsonSign);

3.2 SDK return codes

4. Examples of authentication

4.1 IFAA authenticator registration and authentication

4.1.1 IFAA authenticator registration

 [[IDaaSDoraemonManager sharedInstance]authenticatorServiceWithAuthMethod:@"IFAA" action:DoraemonAuthTypeRegister userId:@"zhangsan"complete:^(NSDictionary *resultDic) {

        HKLog(@"IFAA authenticator - Registration result %@",resultDic);
 }];

4.1.2 Authentication by using the IFAA authenticator

 [[IDaaSDoraemonManager sharedInstance]authenticatorServiceWithAuthMethod:@"IFAA" action:DoraemonAuthTypeAuth userId:@"zhangsan"complete:^(NSDictionary *resultDic) {

        NSLog(@"IFAA authenticator - Authentication result %@",resultDic);
 }];

4.2 Verify a JWT token

You need to verify a JSON Web Token (JWT) token to ensure that the verification result is valid.