Add the SDK to Your App

View this page for | |

The recommended development environment is:

  • Apple Xcode® (latest available version)
  • The minimum target version supported by the SDK
    is iOS 12.0

The following are recommended XCode secure-coding compiler settings:

  • Debugging symbols stripped (release binary) - build setting
  • Automatic Reference Counting (ARC) memory management - build setting
  • Stack Canary – buffer overflow protection

    • "-fstack-protector-all" (Other C Flags)

    For further information, go to https://developer.apple.com/forums/thread/104048

  • Position Independent Executable (PIE) to enable full ASLR for binary - set Generate Position-Dependent Code to NO

    • For further information, go to https://developer.apple.com/library/archive/qa/qa1788/_index.html

  • Stack smashing protection is activated with PIE and "-fstack-protector-all" (Other C Flags)

The SDK does not support the Apple “sharing access to keychain items among a collection of apps” feature. Sharing access to keychain items between several apps will lead to irrecoverable errors.

For further information about the feature, go to https://developer.apple.com/documentation/security/keychain_services/keychain_items/sharing_access_to_keychain_items_among_a_collection_of_apps.

Your cross-platform framework might require disabling Bitcode on the HID Approve SDK framework.

This can be done automatically by disabling Bitcode in the Xcode build options - in the Build Settings tab, go to Build Options and set Enable Bitcode to No.

Alternatively, you can disable the functionality using the xcode strip_bitcode utility:

Copy

Sample command to disable Bitcode

xcrun bitcode_strip -r HID_Approve_SDK.xcframework/ios-arm64/HID_Approve_SDK.framework/HID_Approve_SDK -o HID_Approve_SDK.xcframework/ios-arm64/HID_Approve_SDK.framework/HID_Approve_SDK

For further information about Bitcode deprecation, refer to the Apple XCode 14 Release Notes (item 86118779).

Use the SDK v5.9 in your App

The HID Approve SDK is delivered as a XCFramework bundle (HID_Approve_SDK.xcframework). It is available in the iOS/Libraries folder of the delivery package.

In order to facilitate testing during the development process, this XCFramework bundle also provides the iOS simulator binaries.

  1. Copy the XCFramework bundle (content of the iOS/Libraries folder) to your preferred libraries location.
  2. In your Xcode target, add the XCFramework bundle to your project Frameworks, Libraries and embedded contents setting.

Add Functions to your App

Managing Persistent Data

  • For iOS, the HID Approve SDK stores it's persistent data in several databases in the iOS application sandbox.

    This persistent data can be removed by either:

    • Resetting the HID Approve SDK with the dedicated HIDDeviceFactory.reset() method - all the data will be removed (existing containers, keys...)

    • Uninstalling the application

  • For macOS, the HID Approve SDK stores it's persistent data in several databases in the SearchPathDirectory > librarydirectory and SearchPathDomainMask > userdomainmask directories of the application (for further information, go to https://developer.apple.com/documentation/foundation/filemanager)

    Note: These directories will remain on the macOS workstation even after the application is uninstalled. As an integrator, you must make sure the SDK's persistent data is correctly removed. The typical persistent data path is Users/%username%/Library/Containers/%appbundlename%.