指纹识别官方API
// 导入资源
LocalAuthentication.framework
// 导入头文件
#import <LocalAuthentication/LocalAuthentication.h>
资源下主要文件是
- LAError.h
- LAContext.h
- LAPublicDefines.h
- LocalAuthentication.h
- LocalAuthentication.h 就是一个公开接口，供调用
- LAError.h 系统定义的错误类型
typedef NS_ENUM(NSInteger, LAError)
{
LAErrorAuthenticationFailed, // 验证信息出错，指纹验证不匹配
LAErrorUserCancel // 用户取消了验证（例如点击返回按钮）
LAErrorUserFallback // 用户点击了fallback按钮，去手动输入密码
LAErrorSystemCancel // 系统取消，其他app在前台，验证的时候app进入了后台
LAErrorPasscodeNotSet // 用户没有设置密码，无法开启指纹验证
LAErrorTouchIDNotAvailable // 用户设备不支持TouchID
LAErrorTouchIDNotEnrolled // 用户没有设置手指指纹
LAErrorTouchIDLockout // 由于多次指纹验证失败导致 TouchID已经被锁定，现在只可以用密码去解锁TouchID
LAErrorAppCancel // 在验证中被其他app中断
LAErrorInvalidContext // 请求验证出错
} NS_ENUM_AVAILABLE(10_10, 8_0);
- LAPublicDefines.h 一个宏定义文件
// Policies
#define kLAPolicyDeviceOwnerAuthenticationWithBiometrics 1
#define kLAPolicyDeviceOwnerAuthentication 2
// Options
#define kLAOptionUserFallback 1
#define kLAOptionAuthenticationReason 2
// Credential types
#define kLACredentialTypePasscode -1
#define kLACredentialTypePassphrase -2
#define kLACredentialCTKPIN -3
// Error codes
#define kLAErrorAuthenticationFailed -1
#define kLAErrorUserCancel -2
#define kLAErrorUserFallback -3
#define kLAErrorSystemCancel -4
#define kLAErrorPasscodeNotSet -5
#define kLAErrorTouchIDNotAvailable -6
#define kLAErrorTouchIDNotEnrolled -7
#define kLAErrorTouchIDLockout -8
#define kLAErrorAppCancel -9
#define kLAErrorInvalidContext -10
// Error domain
#define kLAErrorDomain "com.apple.LocalAuthentication"
- LAContext.h 主要的使用文件
typedef NS_ENUM(NSInteger, LAPolicy)
{
// 这种情况就是指纹识别，如果指纹识别失败，导致TouchID被锁定，则再次调用这个验证，会一致处于LAErrorTouchIDLockout状态，除非你重新解锁TouchID。我只发现了关闭屏幕，输入密码解锁，才可以重新使用指纹识别功能
LAPolicyDeviceOwnerAuthenticationWithBiometrics NS_ENUM_AVAILABLE(10_12_2, 8_0) __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0) = kLAPolicyDeviceOwnerAuthenticationWithBiometrics,
// 这种情况下当指纹识别失败一定次数后，会主动调用系统的密码输入界面去解锁你的指纹识别功能，或者你在识别失败后的再试一次的界面，点击输入密码调用系统的密码输入界面
LAPolicyDeviceOwnerAuthentication NS_ENUM_AVAILABLE(10_11, 9_0) = kLAPolicyDeviceOwnerAuthentication
} NS_ENUM_AVAILABLE(10_10, 8_0) __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0);
/// The maximum value for LAContext touchIDAuthenticationAllowableReuseDuration property.
extern const NSTimeInterval LATouchIDAuthenticationMaximumAllowableReuseDuration NS_AVAILABLE(10_12, 9_0) __WATCHOS_UNAVAILABLE __TVOS_UNAVAILABLE;
NS_CLASS_AVAILABLE(10_10, 8_0) __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0)
@interface LAContext : NSObject
// 在调用验证指纹识别前，先查询下本机是否支持指纹识别功能
- (BOOL)canEvaluatePolicy:(LAPolicy)policy error:(NSError * __autoreleasing *)error __attribute__((swift_error(none)));
// 调用指纹识别
// 第一个参数是识别的类型详解参考上面的枚举LAPolicy
// 第二参数是你请求指纹解锁的原因，不可以为nil或者@""，会crash，
// 第三个为回调函数，成功或者失败，以及失败的原因
- (void)evaluatePolicy:(LAPolicy)policy
localizedReason:(NSString *)localizedReason
reply:(void(^)(BOOL success, NSError * __nullable error))reply;
// 手动取消这个调用对象context（LAContext *context = [[LAContext alloc] init];）
- (void)invalidate NS_AVAILABLE(10_11, 9_0);
/*
暂时没有LACredentialType 这个相关的应用场景
*/
typedef NS_ENUM(NSInteger, LACredentialType)
{
// 证书类型为密码类型
LACredentialTypeApplicationPassword __TVOS_UNAVAILABLE = 0,
} NS_ENUM_AVAILABLE(10_11, 9_0) __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0);
// 设置一个内部评估时使用的身份验证凭据
// 设置这个参数为nil将会删除指定类型的任何现有的凭证。
- (BOOL)setCredential:(nullable NSData *)credential
type:(LACredentialType)type NS_AVAILABLE(10_11, 9_0) __WATCHOS_AVAILABLE(3.0) __TVOS_UNAVAILABLE;
// 是否是某个类型，现在只有一个类型
- (BOOL)isCredentialSet:(LACredentialType)type NS_AVAILABLE(10_11, 9_0) __WATCHOS_AVAILABLE(3.0) __TVOS_UNAVAILABLE;
/*
暂时没有LAAccessControlOperation 这个相关的应用场景
*/
typedef NS_ENUM(NSInteger, LAAccessControlOperation)
{
/// Access control will be used for item creation.
LAAccessControlOperationCreateItem,
/// Access control will be used for accessing existing item.
LAAccessControlOperationUseItem,
/// Access control will be used for key creation.
LAAccessControlOperationCreateKey,
/// Access control will be used for sign operation with existing key.
LAAccessControlOperationUseKeySign,
/// Access control will be used for data decryption using existing key.
LAAccessControlOperationUseKeyDecrypt NS_ENUM_AVAILABLE(10_12, 10_0),
/// Access control will be used for key exchange.
LAAccessControlOperationUseKeyKeyExchange NS_ENUM_AVAILABLE(10_12, 10_0),
} NS_ENUM_AVAILABLE(10_11, 9_0) __WATCHOS_AVAILABLE(3.0) __TVOS_AVAILABLE(10.0);
- (void)evaluateAccessControl:(SecAccessControlRef)accessControl
operation:(LAAccessControlOperation)operation
localizedReason:(NSString *)localizedReason
reply:(void(^)(BOOL success, NSError * __nullable error))reply
NS_AVAILABLE(10_11, 9_0) __WATCHOS_AVAILABLE(3.0) __TVOS_UNAVAILABLE;
// 当第一次指纹验证失败后，界面会发生改变，右侧会出现请输入密码提示，左侧默认是取消。右侧的按钮就是fallback按钮，内容就是fallbacktitle。如果为@""fallback按钮则隐藏
@property (nonatomic, nullable, copy) NSString *localizedFallbackTitle;
// 指纹识别默认cancle按钮title为取消，你可以改变内容在iOS10之后
@property (nonatomic, nullable, copy) NSString *localizedCancelTitle NS_AVAILABLE(10_12, 10_0);
// 指纹识别失败的次数设置，即当失败多少次之后做什么，iOS8.3---iOS9.0之间可以设置
@property (nonatomic, nullable) NSNumber *maxBiometryFailures NS_DEPRECATED_IOS(8_3, 9_0) __WATCHOS_UNAVAILABLE __TVOS_UNAVAILABLE;
// 当你的指纹有增删操作后，这个状态会发生变化
@property (nonatomic, nullable, readonly) NSData *evaluatedPolicyDomainState NS_AVAILABLE(10_11, 9_0) __WATCHOS_UNAVAILABLE __TVOS_UNAVAILABLE;
// 这个属性可以设置一个时间间隔，在时间间隔内是不需要再次录入。默认是0秒，最长可以设置5分钟。暂未触发这个属性的应用场景
@property (nonatomic) NSTimeInterval touchIDAuthenticationAllowableReuseDuration NS_AVAILABLE(10_12, 9_0) __WATCHOS_UNAVAILABLE __TVOS_UNAVAILABLE;
@end
- 注意事项
// 指纹识别完成后，回主线程更新UI
dispatch_async(dispatch_get_main_queue(), ^{
// do something
});
参考资料
官方文档
LocalAuthentication源码学习
iOS 指纹识别常见问题汇总
