@capgo/capacitor-native-biometric

概要

Native Biometricは、iOSおよびAndroid向けの安全な資格情報の保管庫です。資格情報は、ネイティブのKeychainまたはKeystoreに保存され、敏感な値が返される前にバイオメトリック認証を必要とすることができます。Ionic Identity Vault資格情報の保管庫の代替として直接使用できます。アプリはタイムアウト、ライフサイクル、プライバシースクリーン、カスタムパスコードポリシーなどの制御を維持します。

主な機能

• setCredentials 、 getCredentials 資格情報を指定されたサーバーに対して安全に保存および取得します。
• getSecureCredentials ネイティブのバイオメトリックチェック後に資格情報のみを読み取ります。
• isCredentialsSaved 、 deleteCredentials ロック状態、ログアウトフロー、オンボーディングフローを構築します。
• isAvailable 、 verifyIdentity 認証の可用性を確認し、必要に応じてユーザーに求めます。

Public API

Method	Description
isAvailable	バイオメトリック認証ハードウェアが利用可能かどうかを確認します。
addListener	アプリがバックグラウンドから復帰したときに呼び出されるリスナーを追加します。このリスナーは、ユーザーがバックグラウンドでバイオメトリック認証を登録/解除した場合に有用です。
verifyIdentity	ユーザーにバイオメトリック認証を求めます。
getCredentials	指定されたサーバーに保存されているクレデンシャルを取得します。
setCredentials	指定されたサーバーにクレデンシャルを保存します。
deleteCredentials	指定されたサーバーに保存されているクレデンシャルを削除します。
getSecureCredentials	指定されたサーバーに保存されているクレデンシャルを取得し、バイオメトリック認証が必要です。クレデンシャルは、BIOMETRY_CURRENT_SETまたはBIOMETRY_ANYでアクセス制御を設定した場合にのみ取得できます。
isCredentialsSaved	指定されたサーバーに保存されているクレデンシャルがすでに存在するかどうかを確認します。
getPluginVersion	CapgoのCapacitorネイティブプラグインのバージョンを取得します。

参照値

これらの値を使用して biometricError 結果を authenticate.

バイオメトリック認証エラー

値	Code	プラットフォーム	意味
UNKNOWN_ERROR	0	Android、iOS	不明のエラーが発生しました。
BIOMETRICS_UNAVAILABLE	1	Android、iOS	ハードウェアが欠落または利用できないため、バイオメトリクスは利用できません。
USER_LOCKOUT	2	Android、iOS	多回の失敗によりユーザーはロックアウトされます。
BIOMETRICS_NOT_ENROLLED	3	Android、iOS	デバイスにバイオメトリクスが登録されていません。
USER_TEMPORARY_LOCKOUT	4	Android	ユーザーは通常30秒間ロックアウトされます。
AUTHENTICATION_FAILED	10	Android、iOS	認証に失敗しました。
APP_CANCEL	11	iOS	__CAPGO_KEEP_0__は認証フローをキャンセルしました。
INVALID_CONTEXT	12	iOS	認証コンテキストが無効です。
NOT_INTERACTIVE	13	iOS	認証が非対話的でした。
PASSCODE_NOT_SET	14	__CAPGO_KEEP_0__, __CAPGO_KEEP_1__	デバイスのパスコード、PIN、またはフォールバック認証情報が設定されていません。
SYSTEM_CANCEL	15	__CAPGO_KEEP_0__, __CAPGO_KEEP_1__	システムが認証をキャンセルしました。例えば、画面ロック後など。
USER_CANCEL	16	__CAPGO_KEEP_0__, __CAPGO_KEEP_1__	ユーザーが認証をキャンセルしました。
USER_FALLBACK	17	__CAPGO_KEEP_0__, __CAPGO_KEEP_1__	ユーザーはフォールバック認証を選択しました。

真実の源

この参照は、 src/definitions.ts に capacitor-native-biometric.

「@capgo/capacitor-native-biometric」から続けてください。

「@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometric」から続けてください。 @capgo/capacitor-native-biometric 「@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometric」をCloudflareに接続します。 Using @capgo/capacitor-native-biometric native capability in Using @capgo/capacitor-native-biometric @capgo/capacitor-ソーシャルログイン implementation detail in @capgo/capacitor-social-login @capgo/capacitor-パスキー implementation detail in @capgo/capacitor-passkey 二要素認証 implementation detail in Two-factor authentication, and Enterprise SSO implementation detail in SSO (Enterprise).