SignatureBiometricSwift

Generate key pair and signing (NIST P-256 EC key pair using ECDSA) using Local Authentication for iOS.

Android

https://github.com/prongbang/SignatureBiometricSwift

CocoaPods

pod 'SignatureBiometricSwift'

Swift Package Manager

In your Package.swift file, add SignatureBiometricSwift dependency to corresponding targets:

let package = Package(
  dependencies: [
    .package(url: "https://github.com/prongbang/SignatureBiometricSwift.git", from: "1.0.10"),
  ],
)

How to use

Privacy info.plist

<dict>
  <key>NSFaceIDUsageDescription</key>
  <string>This application wants to access your TouchID or FaceID</string>
</dict>

Initialize

import SignatureBiometricSwift

let keyConfig = KeyConfig(name: "com.prongbang.signx.kSecAccKey")
let signatureBiometricManager = LocalSignatureBiometricManager.newInstance(
    keyConfig: keyConfig
)

Generate KeyPair

import SignatureBiometricSwift

let reason = "Please scan your fingerprint (or face) to authenticate"
signatureBiometricManager.createKeyPair(reason: reason) { result in
    if result.status == SignatureBiometricStatus.success {
        let publicKey = result.publicKey ?? ""
        print("publicKey: \(publicKey)")
    } else {
        print("Error: \(result.status)")
    }
}

Sign

import SignatureBiometricSwift

let clearText = "Hello"
signatureBiometricManager.sign(payload: clearText) { result in
    if result.status == SignatureBiometricStatus.success {
        print("signature: \(result.signature)")    
    } else {
        print("Error: \(result.status)")
    }
}

Verify

import SignatureBiometricSwift

let clearText = "Hello"
let reason = "Please scan your fingerprint (or face) to authenticate"
signatureBiometricManager.verify(reason: reason, payload: clearText, signature: signed) { result in
    if result.status == SignatureBiometricStatus.success {
        print("verified: \(result.verified)")
    } else {
        print("Error: \(result.status)")
    }
}

Biometrics Changed

import SignatureBiometricSwift

let changed = signatureBiometricManager.biometricsChanged()

Reset Biometrics Policy State

signatureBiometricManager.biometricsPolicyStateReset()

Documentation

Protecting keys with the Secure Enclave

https://developer.apple.com/documentation/security/certificate_key_and_trust_services/keys/protecting_keys_with_the_secure_enclave

Storing Keys in the Keychain

https://developer.apple.com/documentation/security/certificate_key_and_trust_services/keys/storing_keys_in_the_keychain

SecKeyAlgorithm

https://developer.apple.com/documentation/security/seckeyalgorithm/