@capgo/capacitor-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	Android, iOS	设备上未注册任何生物识别信息。
USER_TEMPORARY_LOCKOUT	4	Android	用户暂时被锁定，通常为30秒。
AUTHENTICATION_FAILED	10	Android, iOS	认证失败。
APP_CANCEL	11	iOS	应用程序取消了认证流程。
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 为在使用 @capgo/capacitor-native-biometric 中的原生能力 @capgo/capacitor-social-login 为在 @capgo/capacitor-social-login 中的实现细节 @capgo/capacitor-passkey 为在 @capgo/capacitor-passkey 中的实现细节 双因素认证 双因素认证的实现细节 SSO (企业) SSO (企业)的实现细节