@capgo/capacitor-native-biometric

概述

Native Biometric 是一个安全的 iOS 和 Android 凭证库。它将凭证存储在本机 Keychain 或 Keystore 中，并且在返回敏感值之前需要生物识别验证。它是 Ionic Identity Vault 凭证库流的直接替代品；您的应用程序控制超时、生命周期、隐私屏幕和自定义密码政策。

核心功能

• setCredentials 和 getCredentials - 为给定服务器安全存储和检索凭证。
• getSecureCredentials - 在生物识别检查后读取凭证。
• isCredentialsSaved 和 deleteCredentials - 在登录、锁定状态和注销流程中进行引导。
• isAvailable 和 verifyIdentity - 检查认证可用性并在需要时提示用户。

公共API

方法	描述
isAvailable	检查生物识别认证硬件是否可用。
addListener	添加一个监听器，当应用程序从后台恢复时会被调用。这对于检测应用程序在后台期间（例如用户注册/注销生物识别）是否发生了生物识别可用性变化非常有用。
verifyIdentity	提示用户使用生物识别进行认证。
getCredentials	获取给定服务器的存储凭据。
setCredentials	存储给定的凭据到给定的服务器。
deleteCredentials	删除给定服务器的存储凭据。
getSecureCredentials	获取存储的凭据，需要生物识别验证。凭据必须已存储并且accessControl设置为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	安卓	用户被暂时锁定，通常为30秒。
AUTHENTICATION_FAILED	10	Android, iOS	认证失败。
APP_CANCEL	11	iOS	App取消了认证流程。
INVALID_CONTEXT	12	iOS	认证上下文无效。
NOT_INTERACTIVE	13	iOS	认证不是交互式的。
PASSCODE_NOT_SET	14	Android, iOS	设备的密码、PIN或备份凭证未设置。
SYSTEM_CANCEL	15	Android, iOS	系统取消了认证，例如屏幕锁定后。
USER_CANCEL	16	Android, iOS	用户取消了认证。
USER_FALLBACK	17	Android, iOS	用户选择了 fallback 认证。

真实来源

此参考资料是从 src/definitions.ts 在 capacitor-native-biometric.

从 @capgo/capacitor-native-biometric 继续

如果您正在使用 @capgo/capacitor-native-biometric 来规划身份验证和帐户流程，连接它与 使用 @capgo/capacitor-native-biometric 为native能力在使用 @capgo/capacitor-native-biometric, @capgo/capacitor-social-login 为实现细节在 @capgo/capacitor-social-login, @capgo/capacitor-passkey 为实现细节在 @capgo/capacitor-passkey, 双因素身份验证 为实现细节在双因素身份验证，和 SSO (企业) [__CAPGO_KEEP_0__]在企业SSO（单点登录）中实现详细信息。