https://github.com/nimblehq/local-authentication-ios

A wrapper of the LocalAuthentication framework
https://github.com/nimblehq/local-authentication-ios

cocoapods ios local-authentication swift

Last synced: 7 months ago
JSON representation

A wrapper of the LocalAuthentication framework

• Host: GitHub
• URL: https://github.com/nimblehq/local-authentication-ios
• Owner: nimblehq
• License: mit
• Created: 2021-01-12T08:53:44.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2021-03-17T10:17:40.000Z (over 5 years ago)
• Last Synced: 2025-03-04T14:48:17.012Z (over 1 year ago)
• Topics: cocoapods, ios, local-authentication, swift
• Language: Swift
• Homepage:
• Size: 5.19 MB
• Stars: 1
• Watchers: 9
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  



---

# NimbleLocalAuthentication

![Tests](https://github.com/nimblehq/local-authentication-ios/workflows/Tests/badge.svg?branch=develop)

The basic idea of NimbleLocalAuthentication is that we want to wrap the LocalAuthentication framework. Developer can easily authenticate users biometrically or with a passphrase.

Some awesome features of NimbleLocalAuthentication:

- Support enable or disable the biometric feature on the application.

- Easy to localized strings on biometric screens.

You can check out more about the SDK in [this document](https://nimblehq.github.io/local-authentication-ios) generated by [jazzy](https://github.com/realm/jazzy)

## Sample projects

We have a sample project in the repository. To use it, download the repo, run `pod install` in Example folder to download the required libraries and open [Example.xcworkspace](https://github.com/nimblehq/local-authentication-ios/tree/main/Example/Example.xcworkspace).

## Installation

For `NimbleLocalAuthentication`, use the following entry in your Podfile:

```rb

pod 'NimbleLocalAuthentication', '~> 1.0'

```

Then run `pod install`

## Usage

Using `NimbleLocalAuthentication` is really simple. You can access an API like this:

```swift

let biometryService: BiometryService = NimbleLocalAuthenticator()

biometryService.authenticate { [weak self] result in

  DispatchQueue.main.async {

    switch result {

    case .success:

      // do something after authenticate successfully

    case .failure(let error):

      // hackers are trying to authenticate :D

    }

  }

}

```

## License

This project is Copyright (c) 2014-2021 Nimble. It is free software,

and may be redistributed under the terms specified in the [LICENSE] file.

[LICENSE]: /LICENSE

## About

![Nimble](https://assets.nimblehq.co/logo/dark/logo-dark-text-160.png)

This project is maintained and funded by Nimble.

We love open source and do our part in sharing our work with the community!

See [our other projects][community] or [hire our team][hire] to help build your product.

[community]: https://github.com/nimblehq

[hire]: https://nimblehq.co/