@capgo/capacitor-native-biometric

概要

ネイティブバイオメトリックは、iOSとAndroid用の安全な認証情報の保管庫です。KeychainまたはKeystoreに認証情報を保存し、敏感な値が返される前にバイオメトリック認証を要求できます。Ionic Identity Vaultの認証情報の保管庫のフローに直接置き換えられます。アプリはタイムアウト、ライフサイクル、プライバシースクリーン、カスタムパスコードポリシーを制御します。

主な機能

• setCredentials そして getCredentials - あるサーバーに対して、安全にクレデンシャルを保存および取得します。
• getSecureCredentials - ネイティブバイオメトリックチェック後にのみクレデンシャルを読み取ります。
• isCredentialsSaved と deleteCredentials - オンボーディング、ロック状態、ログアウトフローの構築。
• isAvailable と verifyIdentity - 認証の可用性を確認し、必要に応じてユーザーに通知します。

Public API

メソッド	説明
isAvailable	バイオメトリック認証ハードウェアの利用可能性を確認します。
addListener	アプリがバックグラウンドから復帰したときに呼び出されるリスナーを追加します。このリスナーは、ユーザーがバイオメトリックを登録/解除した場合に、バイオメトリックの利用可能性が変更されたことを検出するのに役立ちます。
verifyIdentity	ユーザーにバイオメトリクス認証を求める。
getCredentials	指定されたサーバーに保存されているクレデンシャルを取得します。
setCredentials	指定されたサーバーにクレデンシャルを保存します。
deleteCredentials	指定されたサーバーに保存されているクレデンシャルを削除します。
getSecureCredentials	指定されたサーバーに保存されているクレデンシャルを取得し、バイオメトリクス認証が必要です。クレデンシャルは、BIOMETRY_CURRENT_SETまたはBIOMETRY_ANYでアクセス制御が設定されている必要があります。
isCredentialsSaved	指定されたサーバーにクレデンシャルがすでに保存されているかどうかを確認します。
getPluginVersion	Get the native Capacitor plugin version.

参照値

これらの値をバイオメトリクス認証の結果を処理する際に使用します。 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	アプリは認証フローをキャンセルしました。
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	ユーザーがフォールバック認証を選択しました。

ソース・オブ・トゥルース

この参照は src/definitions.ts にsynced されています。 capacitor-native-biometric.

Capgoから続けて@capgo/capacitor-native-biometric

@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometricを使用している場合 @capgo/capacitor-native-biometric @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometricを使用して認証とアカウントフローの計画に役立てることができます。@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometricを @capgo/capacitor-native-biometricを使用して@capgo/capacitor-native-biometricのネイティブ機能に接続する @capgo/capacitor-social-loginを使用して@capgo/capacitor-social-loginの実装詳細に @capgo/capacitor-passkeyを使用して@capgo/capacitor-passkeyの実装詳細に for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, Two-factor authentication 2要素認証の実装詳細については SSO (エンタープライズ) エンタープライズ SSO の実装詳細については