Home

Awesome

GitHub release CocoaPods Carthage Compatible Swift 4.0.x platforms GitHub license

Features

Requirements

Communication

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate BiometricAuth into your Xcode project using CocoaPods, specify it in your Podfile:

platform :ios, '9.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'BiometricAuth'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate BiometricAuth into your Xcode project using Carthage, specify it in your Cartfile:

github "vasilenkoigor/BiometricAuth"

Run carthage update to build the framework and drag the built BiometricAuth.framework into your Xcode project.

Usage

Intro

In security cosiderations strongly recommented enable forceThrowsOnChangedDomainState

let biometricAuth = BiometricAuth(forceThrowsOnChangedDomainState: true)

Biometric authentication availability

do {
    try self.biometricAuth.isAvailable()
} catch let error as BiometricAuthError {
    print(error.localizedDescription)
} catch {
    print("Something went wrong")
}

Feature enabled/disabled for biometric authentication

let feature = "Passcode Screen Auth"

do {
    try self.biometricAuth.enableAuthentication(forFeature: feature)
} catch let error as BiometricAuthError {
    print(error.localizedDescription)
} catch {
    print("Something went wrong")
}

Authenticating

self.biometricAuth.requestAuthentication(forFeature: feature, reason: "Reason", completion: { (result, error) in
    if result {
        print("Success")
    }
})

License

BiometricAuth is released under the MIT license. See LICENSE for details.