Skip to content

tejas-ardeshna/TJBioAuthentication

Repository files navigation

TJBioAuthentication

Apple bio metric authentication for touchID and faceID

Swift Version Build Status License CocoaPods Compatible Platform PRs Welcome

Features

  • FaceID authentication
  • TouchID authentication
  • Passcode authentication
  • Batter error handeling

Requirements

  • iOS 10.0+
  • Xcode 9.0

Installation

CocoaPods

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

$ gem install cocoapods

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

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

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

Then, run the following command:

$ pod install

Manually

  1. Download and drop TJAuthErrors.swift,TJBioAuthenticator.swift and TJDefaultMessages.swift in your project.
  2. Congratulations!

Usage

Note: - To use faceID you need to add following lines in your info.plist

<key>NSFaceIDUsageDescription</key>
<string>$(PRODUCT_NAME) requires Face ID permission to authenticate using Face recognition.</string>

Check biometric authentication is available or not.

if TJBioAuthenticator.shared.isBiometricAuthenticationAvailable(){
        // Bio metric is available, write your code here
}

Check faceID authentication is available or not.

if TJBioAuthenticator.shared.isFaceIDAvailable(){
      // FaceID is available, write your code here
}

Authentication using bioMetric.

TJBioAuthenticator.shared.authenticateUserWithBioMetrics(success: {
            // Biometric Authentication success
        }) { (error) in
            // Biometric Authentication unsuccessful
        }

Authentication using passcode.

TJBioAuthenticator.shared.authenticateUserWithPasscode(success: {
            // Biometric Authentication success
        }) { (error) in
            // Biometric Authentication unsuccessful
        }

Contribute

We would love you for the contribution to TJBioAuthentication, check the LICENSE file for more info.

Author

Tejas Ardeshna – @tejas_ardeshnatejasardeshna@gmail.com

Distributed under the MIT license. See LICENSE for more information.