aiDee 1.0.1

aiDee 1.0.1

Jose Figueiredo 维护。



aiDee 1.0.1

aiDee

aiDee (/ɪd/), 名词

"...缩写是身份验证:任何带有您的名字和照片或其他信息的官方卡片或文件,您用它来证明您是谁。"

iOS 生物识别微框架

aiDee 是一个 Swift 微框架,可以用于使用生物识别(指纹识别或面部识别)在 iOS 设备上进行身份验证。它是用 Swift 编写的,旨在作为 Apple 不太新的 LocalAuthentication API 使用的一个简单示例。

Platform Swift CocoaPods Carthage compatible SPM apm

要求

  • Swift 5.1
  • Xcode 11
  • iOS 11

开始使用

作为第一步,您应该在 Info.plist 文件中添加一个名为 NSFaceIDUsageDescription 的条目。

该值应为一串描述为什么您的应用程序使用指纹或面部识别的字符串。更多关于这个主题的详细信息可以在 Apple 的 文档 中找到。

安装

- CocoaPods

aiDee 通过 CocoaPods 提供使用。只需将以下行添加到您的 PodFile

pod 'aiDee'

然后在终端运行以下命令

pod install

- Carthage

在您的 Cartfile 中添加条目

github "aiFigueiredo/aiDee"

然后在终端运行以下命令

carthage update

- Swift Package Manager

将包添加到您的 Package.swift 文件中的依赖项下

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

用法

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)
    }
}

实用技巧

  • 在模拟器中,您可以通过选择 "硬件" > "TouchID"/"FaceID" > "已注册" 来测试 FaceID 和 TouchID。
  • 应与 Keychain 一起使用此微框架存储敏感信息。

贡献

您可以自由地向本项目贡献,通过打开 问题 或打开 拉取请求

许可证

aiDee 使用 MIT 许可证。更多信息请参阅 LICENSE 文件。