Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vasilenkoigor/BiometricAuth
Framework for biometric authentication (via TouchID) in your application
https://github.com/vasilenkoigor/BiometricAuth
biometrics touchid
Last synced: about 1 month ago
JSON representation
Framework for biometric authentication (via TouchID) in your application
- Host: GitHub
- URL: https://github.com/vasilenkoigor/BiometricAuth
- Owner: vasilenkoigor
- License: mit
- Created: 2016-11-29T23:00:29.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-22T22:09:12.000Z (almost 7 years ago)
- Last Synced: 2024-08-06T12:07:55.761Z (about 1 month ago)
- Topics: biometrics, touchid
- Language: Swift
- Homepage:
- Size: 202 KB
- Stars: 27
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - BiometricAuth - Simple framework for biometric authentication (via TouchID) in your application. (Security / Unofficial)
- awesome-ios-star - BiometricAuth - Simple framework for biometric authentication (via TouchID) in your application. (Security / Unofficial)
README
[](https://github.com/vasilenkoigor/BiometricAuth/releases) [](https://github.com/vasilenkoigor/BiometricAuth/releases) [](https://github.com/Carthage/Carthage)   [](https://raw.githubusercontent.com/vasilenkoigor/BiometricAuth/master/LICENSE)
- [Features](#features)
- [Requirements](#requirements)
- [Communication](#communication)
- [Installation](#installation)
- [Usage](#usage)
- [Intro](#intro)
- [Biometric authentication availability](#biometric-authentication-availability)
- [Feature enabled/disabled for biometric authentication](#feature-availability-for-biometric-authentication)
- [Authenticating](#authenticating)
- [License](#license)
## Features
- [x] Force failure authentication if was added new fingerprint to device. This feature for security considerations.
- [x] Saving features list that's needs authentication via TouchID
## Requirements
- iOS 9.0+ / macOS 10.12+
- Xcode 8.1+
- Swift 4.0+
## Communication
- If you **found a bug**, open an issue.
- If you **have a feature request**, open an issue.
- If you **want to contribute**, submit a pull request.
## Installation
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
```bash
$ gem install cocoapods
```
To integrate BiometricAuth into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
platform :ios, '9.0'
use_frameworks!
target '' do
pod 'BiometricAuth'
end
```
Then, run the following command:
```bash
$ pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate BiometricAuth into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
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`
```swift
let biometricAuth = BiometricAuth(forceThrowsOnChangedDomainState: true)
```
### Biometric authentication availability
```swift
do {
try self.biometricAuth.isAvailable()
} catch let error as BiometricAuthError {
print(error.localizedDescription)
} catch {
print("Something went wrong")
}
```
### Feature enabled/disabled for biometric authentication
```swift
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
```swift
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.