概述
概述部分Native Biometric是一款安全的iOS和Android设备凭证库,它将凭证存储在本地Keychain或Keystore中,并且在返回敏感值之前要求生物识别验证。它是Ionic Identity Vault凭证库流程的直接替代品;您的应用程序控制超时、生命周期、隐私屏幕和自定义密码政策。
核心功能
核心功能部分setCredentials和getCredentials- 为给定服务器安全存储和检索凭证。getSecureCredentials- 只有在进行本机生物识别检查后才能读取凭证。isCredentialsSaved和deleteCredentials- 构建登录、锁定状态和注销流程。isAvailable和verifyIdentity- 检查认证可用性并在需要时提示用户。
公共 API
公共 API| 方法 | 描述 |
|---|---|
isAvailable | 检查生物识别硬件是否可用。 |
addListener | 添加一个监听器,当应用程序从后台恢复时会被调用。这对于检测应用程序在后台期间(例如用户注册/注销生物识别)是否发生了生物识别可用性变化非常有用。 |
verifyIdentity | 提示用户使用生物识别进行身份验证。 |
getCredentials | 获取给定服务器的存储凭据。 |
setCredentials | 存储给定服务器的凭据。 |
deleteCredentials | 删除给定服务器的存储凭据。 |
getSecureCredentials | 获取指定服务器的存储凭据,需要生物识别身份验证。凭据必须已存储并且访问控制设置为BIOMETRY_CURRENT_SET或BIOMETRY_ANY。 |
isCredentialsSaved | 检查是否已为指定服务器保存凭据。 |
getPluginVersion | 获取本机Capacitor插件版本。 |
参考值
参考值在处理 biometricError 来自 authenticate.
生物识别身份验证错误
参考值| 值 | Code | 平台 | 含义 |
|---|---|---|---|
UNKNOWN_ERROR | 0 | 安卓, iOS | 未知错误已发生。 |
BIOMETRICS_UNAVAILABLE | 1 | 安卓, iOS | 由于硬件缺失或不可用,生物识别功能不可用。 |
USER_LOCKOUT | 2 | 安卓, iOS | 用户因多次尝试失败而被锁定。 |
BIOMETRICS_NOT_ENROLLED | 3 | 安卓, iOS | 设备上未注册任何生物识别信息。 |
USER_TEMPORARY_LOCKOUT | 4 | Android | 用户暂时被锁定,通常为30秒。 |
AUTHENTICATION_FAILED | 10 | 安卓, iOS | 认证失败。 |
APP_CANCEL | 11 | iOS | 应用程序取消了认证流程。 |
INVALID_CONTEXT | 12 | iOS | 认证上下文无效。 |
NOT_INTERACTIVE | 13 | iOS | 认证不是交互式的。 |
PASSCODE_NOT_SET | 14 | 安卓, iOS | 设备密码、PIN或回退凭证未设置。 |
SYSTEM_CANCEL | 15 | 安卓, iOS | 系统取消了认证,例如屏幕锁定后。 |
USER_CANCEL | 16 | 安卓, iOS | 用户取消了身份验证。 |
USER_FALLBACK | 17 | 安卓, iOS | 用户选择了 fallback 身份验证。 |
真实来源
真实来源此参考资料是从 src/definitions.ts 在 capacitor-native-biometric.
继续阅读 @capgo/capacitor-native-biometric
继续阅读 “继续阅读 @capgo/capacitor-native-biometric”如果您正在使用 @capgo/capacitor-native-biometric 为了计划身份验证和帐户流程,连接它 使用@capgo/capacitor-native-biometric 为@capgo/capacitor-native-biometric中的本机能力 @capgo/capacitor-社会登录 为@capgo/capacitor-social-login中的实现细节 @capgo/capacitor-指纹识别 为@capgo/capacitor-passkey中的实现细节 双因素身份验证 双因素身份验证的实现细节 SSO (企业) SSO (企业)的实现细节