跳过内容

Capgocapgocapacitor原生生物识别

为 Android 和 iOS 提供安全的凭证存储和生物识别门控访问

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_ERROR0安卓, iOS未知错误已发生。
BIOMETRICS_UNAVAILABLE1安卓, iOS由于硬件缺失或不可用,生物识别功能不可用。
USER_LOCKOUT2安卓, iOS用户因多次尝试失败而被锁定。
BIOMETRICS_NOT_ENROLLED3安卓, iOS设备上未注册任何生物识别信息。
USER_TEMPORARY_LOCKOUT4Android用户暂时被锁定,通常为30秒。
AUTHENTICATION_FAILED10安卓, iOS认证失败。
APP_CANCEL11iOS应用程序取消了认证流程。
INVALID_CONTEXT12iOS认证上下文无效。
NOT_INTERACTIVE13iOS认证不是交互式的。
PASSCODE_NOT_SET14安卓, iOS设备密码、PIN或回退凭证未设置。
SYSTEM_CANCEL15安卓, iOS系统取消了认证,例如屏幕锁定后。
USER_CANCEL16安卓, iOS用户取消了身份验证。
USER_FALLBACK17安卓, 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 (企业)的实现细节