ガイド
Capacitor で Native Biometric を使う方法
@capgo/capacitor-native-biometric を使用する場合
このプラグインを使用すると、Android と iOS のネイティブな生体認証 API にアクセスできます。
インストール
bun add @capgo/capacitor-native-biometric
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
API の概要
| メソッド | 説明 |
|---|---|
isAvailable |
生体認証ハードウェアが利用可能かどうかを確認します。 |
verifyIdentity |
ユーザーに生体認証を求めます。 |
getCredentials |
指定したサーバーの保存済み認証情報を取得します。 |
setCredentials |
指定したサーバーの認証情報を保存します。 |
deleteCredentials |
指定したサーバーの保存済み認証情報を削除します。 |
getSecureCredentials |
生体認証を要求して、指定したサーバーの保存済み認証情報を取得します。認証情報は、accessControlをBIOMETRY_CURRENT_SETまたはBIOMETRY_ANYに設定して保存されている必要があります。 |
isCredentialsSaved |
指定したサーバーの認証情報が既に保存されているか確認します。 |
setData |
指定したキーに任意の文字列値を保存します。値はプラットフォームのセキュアストレージバックエンド（Android Keystore + SharedPreferences、iOS Keychain）で保存時に暗号化されます。 |
getData |
指定したキーで以前に保存された値を取得します。生体認証保護なしで保存された値のみを返します。 accessControl. |
getSecureData |
指定したキーの生体認証で保護された値を取得します。値は、次のいずれかが設定された状態で保存されている必要があります： accessControl BIOMETRY_CURRENT_SET または BIOMETRY_ANY。 |
deleteData |
指定したキーの保存済み値を削除します（保護された値、保護されていない値の両方）。 |
isDataSaved |
指定したキーに対して値が既に保存されているかを確認します。 |
例
isAvailable()
生体認証ハードウェアが利用可能かどうかを確認します。
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.isAvailable();
console.log(result);
verifyIdentity()
ユーザーに生体認証を求めます。
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.verifyIdentity();
getCredentials()
指定したサーバーの保存済み認証情報を取得します。
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.getCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.
setCredentials()
指定したサーバーの認証情報を保存します。
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.setCredentials({
username: 'username',
password: 'password',
server: 'example.com',
});
deleteCredentials()
指定したサーバーの保存済み認証情報を削除します。
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.deleteCredentials({ server: 'example.com' });
getSecureCredentials()
生体認証を要求して、指定したサーバーの保存済み認証情報を取得します。認証情報は、accessControlをBIOMETRY_CURRENT_SETまたはBIOMETRY_ANYに設定して保存されている必要があります。
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.getSecureCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.
上記の表は12個のコアメソッドを一覧にしています。リスナーとバージョンのヘルパー、および各メソッドの完全な仕様は、以下に記載されています。 GitHub リポジトリ.
イベントをリッスンする
addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() を呼び出してください。
完全なリファレンス
@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要素認証 二要素認証の実装の詳細については。