Native Biometric は、iOS および Android 向けのセキュアな認証情報保管庫(credential vault)です。認証情報をネイティブの Keychain または Keystore に保存し、機密性の高い値を返す前に生体認証を要求できます。Ionic Identity Vault の credential-vault フローを直接置き換えられるうえ、タイムアウト、ライフサイクル、プライバシースクリーン、カスタムパスコードの各ポリシーは引き続きアプリ側で制御できます。
互換性
「互換性」セクションプラグインのメジャーバージョンは Capacitor に従います: Capacitor 8 用は v8(アクティブにメンテナンス中)、Capacitor 7 用は v7(必要に応じてメンテナンス)。
コア機能
「コア機能」セクションsetCredentialsとgetCredentials- 特定のサーバーの認証情報を安全に保存・取得します。getSecureCredentials- ネイティブの生体認証が完了した後にのみ認証情報を読み取ります。isCredentialsSavedとdeleteCredentials- オンボーディング、ロック状態、ログアウトのフローを構築できます。isAvailableとverifyIdentity- 認証が利用可能か確認し、必要に応じてユーザーにプロンプトを表示します。
公開 API
「Public API」セクション| メソッド | 説明 |
|---|---|
isAvailable | 生体認証ハードウェアが利用可能かどうかを確認します。 |
addListener | アプリがバックグラウンドから復帰したときに呼び出されるリスナーを追加します。アプリがバックグラウンドにある間に生体認証の利用可否が変わった場合(例:ユーザーが生体認証を登録/解除した場合)を検知するのに便利です。 |
verifyIdentity | ユーザーに生体認証を求めます。 |
getCredentials | 指定したサーバーの保存済み認証情報を取得します。 |
setCredentials | 指定したサーバーの認証情報を保存します。 |
deleteCredentials | 指定したサーバーの保存済み認証情報を削除します。 |
getSecureCredentials | 生体認証を要求して、指定したサーバーの保存済み認証情報を取得します。認証情報は、accessControlをBIOMETRY_CURRENT_SETまたはBIOMETRY_ANYに設定して保存されている必要があります。 |
isCredentialsSaved | 指定したサーバーの認証情報が既に保存されているか確認します。 |
getPluginVersion | ネイティブの 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と | アプリが認証フローをキャンセルしました。 |
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 | ユーザーが代替の認証方法を選択しました。 |
Source of Truth
「Source Of Truth」セクションこのリファレンスは以下から同期されています: 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-social-login @capgo/capacitor-social-login の実装の詳細については、 @capgo/capacitor-passkey @capgo/capacitor-passkey の実装詳細については、 2要素認証 二要素認証の実装の詳細については、また、 SSO (エンタープライズ) SSO (Enterprise) の実装の詳細については。