メインコンテンツへスキップ
Capgo - Capacitor アプリのビルド、リリース、アップデート Capgo

@capgo/capacitor-native-biometric

AndroidおよびiOS向けの、安全な認証情報ストレージと生体認証によるアクセス制御。
今すぐ始める GitHub

概要

「概要」セクション

Native Biometric は、iOS と Android 用のセキュアな認証情報保管庫（credential vault）です。認証情報をネイティブの Keychain または Keystore に保存し、機密性の高い値を返す前に生体認証を要求できます。これは Ionic Identity Vault の credential-vault フローを直接置き換えるもので、タイムアウト、ライフサイクル、プライバシー画面、カスタムパスコードなどのポリシーは引き続きアプリ側で制御可能です。

コア機能

「コア機能」セクション
  • 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_ERROR0Android、iOS不明なエラーが発生しました。
BIOMETRICS_UNAVAILABLE1Android、iOSハードウェアが未搭載、または利用できないため、生体認証は利用できません。
USER_LOCKOUT2Android、iOS認証失敗が続いたため、ユーザーがロックされました。
BIOMETRICS_NOT_ENROLLED3Android、iOSデバイスに生体認証が登録されていません。
USER_TEMPORARY_LOCKOUT4Androidユーザーは一時的にロックされています（通常30秒間）。
AUTHENTICATION_FAILED10Android、iOS認証に失敗しました。
APP_CANCEL11iOSとアプリによって認証フローがキャンセルされました。
INVALID_CONTEXT12iOSと認証コンテキストが無効です。
NOT_INTERACTIVE13iOSと認証がインタラクティブに行われませんでした。
PASSCODE_NOT_SET14Android、iOSデバイスのパスコード、PIN、または代替の認証情報が設定されていません。
SYSTEM_CANCEL15Android、iOS画面ロックなどにより、システムが認証をキャンセルしました。
USER_CANCEL16Android、iOSユーザーが認証をキャンセルしました。
USER_FALLBACK17Android、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) の実装の詳細については。