本番環境への移行¶
現在のリリース(0.26.0)が各プラットフォームで提供するものと、SDK を組み込んだアプリを出荷する前に 確認すべき事項です。
各プラットフォームで利用できるもの¶
| Web | Flutter | Android | iOS | React Native | |
|---|---|---|---|---|---|
| 現在のリリースのインストール | 可。DEA のリリース URL から | 可。DEA のリリース URL から | 可。DEA の Maven リポジトリから | 可。DEA のリリース URL から | 可。DEA のリリース URL から |
| 分類の読み取り | 可 | 可 | 可 | 可 | 可 |
appKey の指定 |
可 | 可 | 可 | 可 | 可 |
| アテステーション | 可。ブラウザーキー | Android 6.0 以上と iOS 14 以上 | Android 6.0 以上 | iOS 14 以上 | Android 6.0 以上と iOS 14 以上 |
| 広告 | 可。attest() の後 |
証明の呼び出しのみ。タッチの検証なし | 証明の呼び出しのみ。タッチの検証なし | 証明の呼び出しのみ。タッチの検証なし | 証明の呼び出しのみ。タッチの検証なし |
| AI データタスク | 可。@dea/contribution で |
SDK のタスクページを Web ビューで表示 | SDK のタスクページを Web ビューで表示 | SDK のタスクページを Web ビューで表示 | SDK のタスクページを Web ビューで表示。署名はアプリのネイティブモジュール経由 |
| モデルの OTA 更新 | デフォルトで有効 | デフォルトで有効 | デフォルトで有効 | デフォルトで有効 | デフォルトで有効 |
| デフォルトで同意が必要 | いいえ。requireConsent で有効化 |
はい | はい | はい | はい |
分類の裏にあるモデル¶
各パッケージはモデルを組み込んでおり、DEA が新しいモデルを公開し、更新が有効な場合、SDK はそれを新しい
ものに置き換えます。分類は由来するモデルを modelVersion で示し、スコアと比較するしきい値はそのモデルから
来ます(スコアリングの仕組みを参照)。
分類は、すでに持っているシグナルのうちの 1 つとして扱ってください。慎重なロールアウトでは、まず分類を
読み取って既存のチェックと並べてログに記録し、自分のトラフィックでの振る舞いを確認してから、それに基づいて
行動を始めます。undetermined には必ず代替経路を用意し、insufficient は bot ではなく「まだ早い」と
して扱ってください。
アテステーション¶
アテステーションは、appKey が示すアプリの下に端末の署名キーを DEA に登録します。必要なものは次の通りです。
appKey(アカウントとキーを参照)- Android では Google Play Integrity(Standard API)。Play は、Google Play からインストールされたか、
Play Console のエントリーに登録されたキーで署名された、Play が認識するビルドに対してのみ、かつ
Play Console でアプリにリンクされた Google Cloud プロジェクトに対してのみトークンを発行します。
playIntegrityProjectを設定しない限り、SDK は DEA 自身のプロジェクト向けのトークンを要求し、DEA の サービスはそのプロジェクトの資格情報でトークンを復号します。アプリをどのプロジェクトにリンクするかは、 DEA がアプリを登録する際に DEA と取り決めます - iOS では App Attest の capability。iOS 14 以降
- Web ではセキュアなオリジン。ブラウザーにはプラットフォームのアテステーションがないため、Google や Apple のトークンなしでキーが登録されます
各プラットフォームの「アテステーション」ページに、SDK が送信するものと各結果の意味の一覧があります。
ブラウザーのサポート¶
Web SDK には、Chrome または Edge 96、Firefox 95、Safari 15.4(macOS および iOS)以降と、HTTPS または
localhost から配信されるページが必要です。これらは、SDK が使うすべてのブラウザー機能を備えた最初の
バージョンです。平文 HTTP のページや古いブラウザーでは init が例外を投げます(Web の
トラブルシューティングを参照)。
ページが Content Security Policy を送る場合、script-src で 'wasm-unsafe-eval' を、connect-src で
SDK の要求を許可する必要があります。Web ガイドに
各ディレクティブの一覧があります。
オフラインとネットワーク障害¶
取得と分類はネットワークを一切使いません。オフラインのアプリも通常通りスコアリングします。
| 要求 | 失敗した場合 |
|---|---|
| モデル更新の確認 | 使用中のモデルがスコアリングを続けます。次の確認は次の起動時に行われます(Android、iOS、Flutter では、1 日後にアプリがフォアグラウンドに戻ったときにも) |
| アテステーション(Android、iOS、Flutter) | 更新は 30 秒後、次に 1 分、2 分、5 分後、その後は 15 分ごとに再試行されます。Play Integrity または App Attest のトークンを使った登録を DEA またはプラットフォームが拒否した場合、SDK は 1 時間試行を止め、連続して拒否されるごとに 2 倍にして最長 7 日まで延ばします。これはアプリの起動をまたいで続きます |
| アテステーション(Web) | 自動では何も再試行されません。次の attest() 呼び出しで再度試みます |
| 証明 | DEA に到達できないか、サーバーエラーが返った場合のみ再試行します。最大 5 回送信し、2 秒待ってから最長 30 秒まで倍増させ、証明の有効期間 90 秒を超えては送りません。拒否された場合はその時点で終了します。証明は保存されません。期限内に届かなかったものは失われます |
Android と iOS では、証明とアテステーションの呼び出しはこれらの待機中、呼び出したスレッドをブロックします。
自動化の検出¶
automationDetection: true の場合、自動化がアプリやページを操作している確かな兆候を最初に見つけた時点で、
SDK は直ちに停止します。この停止は、テストビルドを含むすべてのアカウントとすべてのビルドに適用されます。
| 動作 | |
|---|---|
| 停止するもの | 取得、スコアリング、証明、アテステーション、モデル更新、および収集トランスポーターなどのインテグレーション。停止前に送信されたものは送信済みのままです |
| アプリが読み取るもの | stopped は理由 automated とともに停止を返し、SDK の動作中は null です。getClassification() は、すべての数値が null で actions が 0 の insufficient を返します。証明の呼び出しは何も署名せず、理由は automated です。attest() は要求を送らずに failed を返します |
| 期間 | reset() または新しい起動まで。新しい起動とは、アプリの再起動、ページの再読み込み、または dispose() の後の新しいインスタンスです |
| 起動をまたいだ場合 | 端末は停止を保持しません。次の起動またはページの読み込みでは通常通り開始します |
| 解除するもの | reset()。新しいセッションを開始し、取得、証明、モデル更新、自動化の検出が再び始まります。自動化が続く場合、SDK は再び停止します。resume() と setConsent(true) では解除されません |
| どのチェックが反応したか | アプリには示されません。ログを出力するビルドは、シグナルとともに automation.detected を書き、続いて sdk.stopped を書きます。本番ビルドは何もログに出力しません |
| 人が生じさせうる兆候 | Android と iOS: 外付けタッチスクリーン、またはジェイルブレイクされた iPhone の tweak ローダーは、automation.soft_signal としてログに記録されます。自動化の検出はこれで SDK を停止しません。ただし、root 化・ジェイルブレイクされた端末を参照してください |
| 検出が失敗した場合 | 検出がオフの場合と同様に、SDK は動作を続けます |
automationDetection: false(デフォルト) |
検出も停止もありません |
自社の自動テストでは automationDetection をオフのままにしてください。自動操作されたテスト実行では SDK が
停止します。
root 化・ジェイルブレイクされた端末¶
Android と iOS では、automationDetection: true の場合、root 化またはジェイルブレイクされた端末では
自動化の検出と同じように SDK が停止し、アプリへの結果も同じです。アプリは動作を
続けます。
| 動作 | |
|---|---|
| 適用されるビルド | ステージングビルドと本番ビルド。テストビルドはログに記録するだけで、動作を続けます |
| アプリが読み取るもの | stopped は理由 automated とともに停止を返します |
| どのチェックが反応したか | アプリには示されません。ログを出力するビルドは、見つけた痕跡とともに sdk.device_compromised を書き、続いて sdk.stopped を書きます。本番ビルドは何もログに出力しません |
| 解除するもの | reset() または新しい起動で解除されます。その後スキャンが再び実行され、同じ端末では SDK が再び停止します |
| 停止しないもの | デバッガー、エミュレーターやシミュレーター、または root の兆候がないカスタム ROM |
| 検出できないもの | root 化やジェイルブレイクをアプリから隠している端末 |
automationDetection: false(デフォルト) |
停止しません。ログを出力するビルドは引き続き sdk.device_compromised を書きます |
バッテリー¶
| プラットフォーム | 動作するもの |
|---|---|
| Android、iOS、Flutter | 加速度センサーとジャイロスコープが、init から dispose() まで毎秒 motionRate 回(デフォルト 50)動作します。取得の一時停止中、同意前、バックグラウンドでも動作します。ユーザーが操作していない間、SDK は 3 秒に 1 件だけ保持しますが、センサーのレートは変わりません。setMotion(false) でセンサーを止めると、分類はモーションなしで計算され、モバイルモデルはそれを読み取ります |
| React Native | Android および iOS と同じ。iOS 側はモーションのオプションを無視します |
| スマートフォンとタブレットの Web | ページが開いている間、ブラウザー自身のレートでのモーションイベント。setMotion(false) で止まります |
| デスクトップの Web | ページが表示され取得が動作している間の 50 ms タイマー |
motionRate を下げるとコストが減ります。0 の動作はプラットフォームで異なります。Web と Android は
モーションを無効にし(Web では setMotion(true) で 50 Hz で再び有効になり、Android では setMotion(true) で再有効化できません)、iOS と Flutter は 25 未満の値を
25 に引き上げ、React Native の Android は 0 を 50 として扱います。
SDK 自身のネットワーク使用は、起動ごとに 1 回のモデル確認と、Android、iOS、Flutter でアプリが attest()
を呼んだ後は、アプリの動作中におよそ 1 時間に 1 回の更新です。
スレッド¶
| プラットフォーム | 規則 |
|---|---|
| Web | すべてページのメインスレッドで動作します。getClassification() は同期的で軽量です。フレームごとではなく判断ごとに読んでください。ネットワークを使う呼び出しと getProof() は Promise を返します |
| Android | init と取得系メソッド(pause、resume、reset、setConsent、captureEvent)はメインスレッドで呼びます。attest()、renewAttestation()、storedAttestation()、checkForModel()、record()、sendProof()、getProof() はブロックするため、メインスレッド以外で呼びます。getClassification() はどのスレッドからでも安全です。モデルリスナーは SDK のスレッド、アテステーションイベントは判断を行ったスレッド、onLog はログを出力したスレッド、同意ダイアログのコールバックはメインスレッドで実行されます |
| iOS | 同じ分け方です。init と取得系メソッドはメインスレッド、アテステーションと証明の呼び出しはメインスレッド以外、getClassification() はどのスレッドからでも。modelChanges と checkForModel の完了ハンドラーはメインスレッド以外で、onLog はログを出力したスレッドで実行されます。onLog の中から SDK を呼び返さないでください |
| Flutter | すべて UI isolate で動作します。ネットワークを使う呼び出しは Future を返し、getClassification() は同期的です。SDK はメイン isolate からのみ使ってください |
| React Native | すべての呼び出しが Promise を返します。ネイティブ SDK はメインスレッドで、ネットワーク呼び出しはバックグラウンドキューで動作します |
Android ビルド¶
Android SDK は minSdk 21(アテステーションには API 23 が必要)、compileSdk 35、Java 17、Kotlin 2.2.20、
Android Gradle Plugin 9.4.0 でビルドされ、Google の Play Integrity ライブラリ 1.4.0 に依存します。Kotlin 2.2
以降でコンパイルされたアプリから利用できます。Kotlin 自身の互換性ポリシーにより、Kotlin 2.1 はベスト
エフォートであり保証はありません。
バージョンと互換性¶
- リリースごとに 1 つのバージョン。 プラットフォームのパッケージは 1 つのバージョン番号を共有します。
SDK とその付属パッケージは同じリリースからインストールしてください。Web では SDK が付属パッケージを
一緒に持ってきます。Flutter ではすべての zip を同じバージョンでダウンロードしてください。組み合わせが
合わないと
initがCoreMismatchを報告し、何もスコアリングしません。Android では、Gradle が付属 パッケージを同じリリースの Maven リポジトリから取得します。iOS では、同じリリースのアーカイブをすべて ダウンロードしてください。React Native では、npm パッケージ、Maven リポジトリ、pod が同じリリースを 指定します。 - モデル。 SDK は、スコアリングエンジンが読めるモデルのみダウンロードします。それ以外のモデルは無視され、 現在のモデルがスコアリングを続けます。
- リリース。 各リリースは
https://sdk.dep-protocol.com/<version>/manifest.jsonにファイルを SHA-256 チェックサム付きで一覧し、https://sdk.dep-protocol.com/registry/latest.jsonが最新のリリースを示します。本ガイドのビルド時点では 0.26.0 です。DEA はリリースノートを公開しません。
リリース前に¶
- [ ] 各アプリが DEA に登録され、各ビルドが対応するアプリの
appIdとappKeyを渡している — アカウントとキー - [ ] インストール行が、テストしたリリースを指している
- [ ] 同意: ポリシーが求める場合、取得の前にユーザーに確認している — プラットフォームの「ユーザー同意」ページ
- [ ] 機密性の高い内容を表示する画面で取得を一時停止している — プラットフォームの「機密性の高い画面」ページ
- [ ] ログアウトとアカウント切り替えでセッションをリセットしている — プラットフォームの「セッション」ページ
- [ ] 分類を判断ポイントで読み取り、
bot、undetermined、insufficientの代替経路を用意し、ThresholdMissingエラーを捕捉している — プラットフォームの「ヒューマンスコアリング」ページ - [ ] Android と iOS で、アテステーションと証明の呼び出しをメインスレッド以外で実行している — スレッド
- [ ] Android で、アプリが Play Console 上で DEA と取り決めた Google Cloud プロジェクトにリンクされている — アテステーション
- [ ] Web で、サポートするブラウザーと Content Security Policy がブラウザーのサポートに 合っている
- [ ] リリースビルドでデバッグ出力が無効になっている
- [ ] プライバシーの開示が、SDK が取得・保存・送信するものを網羅している — プライバシーとネットワーク
- [ ] プラットフォームガイド自身の「リリース前に」チェックリストを完了している