aid

aiDee

Micro-framework to enable and facilitate the use of LocalAuthentication (Touch / Face ID) on your iOS Projects

Showing:

Popularity

Downloads/wk

0

GitHub Stars

133

Maintenance

Last Commit

2yrs ago

Contributors

5

Package

Dependencies

0

License

MIT

Categories

Readme

aiDee

aiDee (/ɪd/), noun

"... abbreviation for identification: any official card or document with your name and photograph or other information on it that you use to prove who you are."

iOS Biometrics Micro-Framework

aiDee is a Swift micro-framework that can be used to authenticate with iOS Devices using biometrics: Touch ID or Face ID. Written in Swift this aims to be a simple example of Apple's not-so-new LocalAuthentication API usage.

Platform Swift CocoaPods Carthage compatible SPM apm

Requirements

  • Swift 5.1
  • Xcode 11
  • iOS 11

Get Started

As a first step you should add an entry on your Info.plist file for key NSFaceIDUsageDescription.

The value should be a string describing the reason why your app uses Touch or Face ID. More information on this subject can be found on Apple's Documentation.

Installation

- CocoaPods

aiDee is available through CocoaPods. Just add the following line to your PodFile:

pod 'aiDee'

And then run the following command on the terminal:

pod install

- Carthage

Add the entry to your Cartfile:

github "aiFigueiredo/aiDee"

And then run the following command on the terminal:

carthage update

- Swift Package Manager

Add the package to your Package.swift file, under dependencies:

dependencies: [
    .package(url: "https://github.com/aiFigueiredo/aiDee.git", from: "1.0.1")
]

Usage

import aiDee
...
// Instantiate BiometricAuthentication object
let biometricAuth = BiometricAuthentication()
// Get Biometric Availability Information
let biometricsAvailable: Bool = biometricAuth.isBiometricsAvailable()
let biometricsType: BiometricType = biometricAuth.biometricType() // .touchId / .faceId / .none
// Authenticate using Biometrics providing a LocalizedString with a reason for the request
biometricAuth.authenticateUser(localizedReason: "Reason for Biometric request") { [weak self] result in
switch result {
case .success: self?.showAlert(title: "Success", message: "Biometric Auth Successful")
case .failure(let error): self?.showAlert(title: "Error", message: error.errorDescription)
}
}

Useful Tips

  • Both FaceID and TouchID can be tested in the simulator by selecting "Hardware" > "TouchID"/"FaceID" > "Enrolled"
  • This micro framework should be used alongside the use of Keychain to store sensitive information.

Contributing

Feel free to contribute to this project by opening issues or opening pull requests.

License

aiDee's available under the MIT license. See the LICENSE file for more information.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100