アテステーション¶
この端末の署名キーを DEA に登録します。SDK は最初に必要になったときに、Android Keystore または iOS Secure Enclave の 内部でキーを生成します。秘密鍵の側はアプリからも SDK からも読み取れません。プラットフォームが対応していれば、 登録には Google Play Integrity(Android)または Apple App Attest(iOS)のトークンも添付され、DEA は端末とアプリが 正規のものであることを確認できます。
DEA は、appKey が属するアプリの下に登録を記録します。
アカウントとキーを参照してください。
使いどころ¶
- 機密性の高いステップの前に、端末が登録されていることを確認するとき
- 診断画面でアテステーションの状態を表示するとき
前提条件¶
- SDK がインストールされ、
appIdとappKey、Android ではplayIntegrityProjectも渡して初期化されている。 クイックスタートとアカウントとキーを参照して ください。 - 以下のプラットフォームセットアップ。
プラットフォームのセットアップ¶
Android: Play Integrity¶
Play は、認識しているアプリ(Google Play からインストールされたもの、または Play Console のアプリ登録に登録された キーで署名されたもの)にのみ正規のトークンを発行します。Google Play のテストトラックからのビルドを、Google Play 開発者サービスのある実機でテストしてください。
Android アプリのために DEA が発行した Google Cloud プロジェクト番号を playIntegrityProject として渡します。
これは、Play Console の「アプリの完全性」ページでアプリにリンクされているプロジェクトでなければなりません。
それ以外の番号では、attest() は failed を返します。
import {Platform} from 'react-native';
import * as Dea from '@dea/react-native';
await Dea.init({
appId: Platform.OS === 'ios' ? 'YOUR_IOS_APP_ID' : 'YOUR_ANDROID_APP_ID',
appKey: Platform.OS === 'ios' ? 'YOUR_IOS_APP_KEY' : 'YOUR_ANDROID_APP_KEY',
playIntegrityProject: 123456789012, // read on Android only
});
iOS: App Attest¶
アプリに App Attest capability を追加します。
- Xcode で
ios/YourApp.xcworkspaceを開きます。 - アプリのターゲットを選択し、Signing & Capabilities を開きます。
- + Capability をクリックして App Attest を追加します。
これにより com.apple.developer.devicecheck.appattest-environment entitlement が追加されます。この capability が
ないと attest() は failed を返し、attestation.detail には通常 invalidKey が含まれます。
App Attest には iOS 14 以降の実機が必要です。iOS シミュレーターでは登録は App Attest トークンなしで送信されるため、
platformAttested は false になります。
使い方¶
アテステーションを行う¶
import * as Dea from '@dea/react-native';
const attestation = await Dea.attest();
switch (attestation.verdict) {
case 'passed':
// DEA accepted this device's key.
break;
case 'unsupported':
// No key could be created on this device, or no appKey was given. See attestation.detail.
break;
case 'failed':
// DEA refused, or could not be reached. See attestation.detail.
break;
}
attest()は、拒否、タイムアウト、キーストアの欠如では reject されません。すべての結果はAttestationとして返ります。reject されるのはinitが実行されていない場合のみです。- 結果はキャッシュされ、アプリの再起動後も保持されるため、期限切れの直前までは再度呼び出してもコストは かかりません。
- 最初の呼び出しで自動更新も有効になります。 それ以降、SDK は期限切れの直前に登録を更新し、アプリが
フォアグラウンドに戻ったときに再計画します。
attest()を一度も呼び出さないアプリは、キーを登録しません。
プラットフォームが端末を保証したか確認する¶
passed は DEA がキーを受け入れたことを意味します。これが端末についての保証となるのは、platformAttested が
true の場合のみです。
if (attestation.verdict === 'passed' && attestation.platformAttested) {
// Google or Apple confirmed the device and app.
}
platformAttested は、エミュレーターとシミュレーター、Google Play 開発者サービスのない Android 端末、Play が
認識しないビルドでは false になります。
再度アテステーションせずに最後の結果を読み取る¶
今すぐ更新する¶
登録を直ちに更新し、次の自動更新を再計画します。拒否された場合は、すでに保持している登録が維持されます。
自動更新を追跡する¶
最初の attest() が最初の更新をスケジュールするため、その前に購読してください。
import * as Dea from '@dea/react-native';
const subscription = Dea.onAttestationEvent(event => {
switch (event.type) {
case 'scheduled':
console.log(`renewal in ${event.afterSeconds} s`);
break;
case 'fired':
console.log('renewed:', event.verdict);
break;
case 'idle':
console.log('nothing to renew');
break;
}
});
// later
subscription.remove();
getNextAttestationRefresh() は次の自動更新の時刻をエポック秒で返し、計画されていない場合は null を返します。
例¶
決済ステップの前にアテステーションを行う¶
import * as Dea from '@dea/react-native';
export async function openPayment(navigation: {navigate: (route: string) => void}) {
const attestation = await Dea.attest().catch(() => null);
if (attestation?.verdict !== 'passed') {
console.warn('DEA attestation:', attestation);
}
navigation.navigate('Payment');
}
API¶
| メンバー | 戻り値 | 説明 |
|---|---|---|
attest() |
Promise<Attestation> |
端末キーを登録して結果を返す。自動更新を有効にする |
renewAttestation() |
Promise<Attestation> |
今すぐ更新し、自動更新を再計画する |
getLastAttestation() |
Promise<Attestation \| null> |
再度アテステーションせずに最後の結果を返す |
getNextAttestationRefresh() |
Promise<number \| null> |
次の自動更新(エポック秒) |
onAttestationEvent(listener) |
EventSubscription |
自動更新が下すすべての判断 |
Attestation:
| フィールド | 型 | 説明 |
|---|---|---|
supported |
boolean |
この端末でキーを生成できたか |
verdict |
'passed' \| 'failed' \| 'unsupported' |
結果 |
platformAttested |
boolean |
Play Integrity または App Attest が端末を保証したか |
expiresAt |
number \| null |
有効期限(エポック秒) |
kid |
string \| null |
キーの識別子 |
tier |
string \| null |
DEA が割り当てた信頼ティア |
backing |
string \| null |
端末上でキーが保管されている場所 |
detail |
string \| null |
アテステーションが失敗した場合の理由 |