コンテンツにスキップ

DEA SDK for Flutter

アプリのセッションが実在の人物によるものかどうかを検出します。SDK は Flutter アプリ全体にわたってタッチ、 スタイラス、マウス、スクロール、端末の動きの入力を観測し、セッションを端末上でスコアリングします。

このページの内容: 前提条件 · インストール · SDK の初期化 · 同意を求める · 分類を使う · セットアップの確認 · リリース前に · 次のステップ

前提条件

  • アプリを配布する各プラットフォームの appId と appKey。 アカウントとキーを参照してください。DEA は Android アプリと iOS アプリを 2 つのアプリとして登録し、それぞれに固有のペアを発行します。
  • Flutter 3.24 以降、Dart 3.5 以降
  • Android: minSdkVersion 21(Android 5.0)以降
  • iOS: デプロイメントターゲット 12.0 以降

SDK は Android と iOS で動作します。パッケージには Android の arm64-v8a と x86_64(64 ビット エミュレーターでも動作します)、および iOS 端末と iOS シミュレーター向けの スコアリングエンジンが含まれています。

注: 32 ビットアプリしか実行できない Android 端末(armeabi-v7a)では、スコアリングエンジンは 読み込まれません。SDK は起動しますが、isScoring は false になり、error にその理由が入ります。 トラブルシューティングを参照してください。

インストール

Flutter SDK は 3 つの zip ファイル(dea_sdk と、それに付随する dea_base および dea_automation_detection)として配布され、プロジェクトにベンダリングして使います。3 つとも同じ リリースのものでなければなりません。

注: パッケージは以下の DEA のリリース URL からダウンロードします。pub.dev には公開されていません。

パッケージをダウンロードする

アプリのルートフォルダーから:

mkdir -p vendor/dea && cd vendor/dea
curl -sSO https://sdk.dep-protocol.com/0.26.0/flutter/base/dea-base-0.26.0.zip
curl -sSO https://sdk.dep-protocol.com/0.26.0/flutter/automation-detection/dea-automation-detection-0.26.0.zip
curl -sSO https://sdk.dep-protocol.com/0.26.0/flutter/sdk/dea-sdk-0.26.0.zip
unzip -qo dea-base-0.26.0.zip && unzip -qo dea-automation-detection-0.26.0.zip && unzip -qo dea-sdk-0.26.0.zip

これで vendor/dea/base、vendor/dea/automation_detection、vendor/dea/sdk が作成されます。

pubspec.yaml

dependencies:
  dea_sdk:
    path: vendor/dea/sdk

dependency_overrides:
  dea_base:
    path: vendor/dea/base
  dea_automation_detection:
    path: vendor/dea/automation_detection

続けて flutter pub get を実行します。

dea_sdk は、自身と完全に同じバージョンの dea_base と dea_automation_detection を必要とします。 上記のオーバーライドで、ダウンロードしたコピーを指すようにします。dea_automation_detection は、 自動化の検出がオフの場合でも必要です。アップグレードするには、新しいバージョンの zip を 3 つとも再度 ダウンロードします。バージョンが一致しなくてもビルドは失敗しませんが、SDK は実行を拒否します。 トラブルシューティングを参照してください。

プラットフォームのセットアップ

取得のためのプラットフォーム側のセットアップは不要です。プラグインは自身を登録し、Android では アプリのマニフェストに INTERNET パーミッションを追加します。

iOS では、ios/Podfile のターゲットが iOS 12 以上になっていることを確認してください:

platform :ios, '12.0'

アテステーションには、Android と iOS で追加のセットアップがあります。

SDK の初期化

セッション全体を取得の対象にするため、main() の中で runApp の前に一度だけ初期化します。アプリが 動作しているプラットフォームの appId と appKey を渡します:

import 'dart:io' show Platform;

import 'package:dea_sdk/dea_sdk.dart';
import 'package:flutter/material.dart';

void main() {
  DeaSdk.init(
    DeaOptions(
      appId: Platform.isIOS ? 'YOUR_IOS_APP_ID' : 'YOUR_ANDROID_APP_ID',
    ),
    appKey: Platform.isIOS ? 'YOUR_IOS_APP_KEY' : 'YOUR_ANDROID_APP_KEY',
  );
  runApp(const MyApp());
}
  • appId は DeaOptions のフィールドで、appKey は DeaSdk.init の名前付き引数です。アプリキーは 秘密情報ではありません。DEA に対してアプリを識別するもので、アプリの中に同梱されます。 アカウントとキーを参照してください。
  • appKey はアテステーションに必要で、X-App-Key ヘッダーとして DEA に 送られます。これがないと、attest() は DEA に接続せずに unsupported を返します。取得と分類では 使われません。
  • 先に WidgetsFlutterBinding.ensureInitialized() を呼ぶ必要はありません。init が行います。
  • init は複数回呼んでも安全です。2 回目以降の呼び出しは実行中のインスタンスを返し、そのオプションを 維持します。
  • init は決して例外を投げません。起動中に何かが失敗した場合、SDK はスコアなしで動作を続け、問題を error で報告します。モデル更新、自動化の検出、証明も停止します。 トラブルシューティングを参照してください。
  • automationDetection: true の場合、自動化がアプリを操作している確かな兆候を最初に見つけた時点で、SDK は すべてのアカウントとビルドで直ちに停止します。何も取得、スコアリング、署名、登録されず、分類は insufficient のままです。停止は reset() または新しい起動(アプリの再起動、または dispose() の後の init)まで続き、その間 stopped は null ではありません。Android の外付けタッチスクリーンでは SDK は 停止しません。root 化またはジェイルブレイクされた端末では停止します(テストビルドを除く)。 自動化の検出と root 化・ジェイルブレイクされた端末を参照してください。
  • 取得はグローバルです。Flutter がアプリ内でルーティングするすべてのポインター、モーションセンサー、 アプリのライフサイクルが対象です。ラップするウィジェットも、登録するものもありません。Flutter が ルーティングしない入力(キー入力、Web ビュー内のタッチ)はアプリ側から報告します。 ヒューマンスコアリングを 参照してください。
  • ユーザーが同意するまで何も記録されません。 次のステップを参照してください。

コードの他の場所では、DeaSdk.instance で実行中のインスタンスを取得します:

final dea = DeaSdk.instance; // null before init

デフォルトでは、SDK はユーザーが同意するまで何も記録しません。このステップは必須です。同意を求めない アプリは何も記録せず、分類も得られません。

SDK には既製のダイアログが用意されています。最初の画面が表示されたら、それを一度表示します:

import 'package:dea_sdk/dea_sdk.dart';
import 'package:flutter/material.dart';

class HomeScreen extends StatefulWidget {
  const HomeScreen({super.key});

  @override
  State<HomeScreen> createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  @override
  void initState() {
    super.initState();
    WidgetsBinding.instance.addPostFrameCallback((_) {
      if (mounted) showDeaConsentDialog(context);
    });
  }

  @override
  Widget build(BuildContext context) {
    return const Scaffold(body: Center(child: Text('Home')));
  }
}

回答は端末に保存されるため、ダイアログはユーザーが回答するまでしか表示されません。独自の UI を使う、 文言を変える、再度尋ねる方法はユーザー同意を参照してください。

分類を使う

判断を下す瞬間に分類を読み取ります。読み取りは同期的で、 ネットワーク呼び出しは発生しません。

import 'package:dea_sdk/dea_sdk.dart';

Future<void> onSignUp(SignUpForm form) async {
  final result =
      DeaSdk.instance?.getClassification().result ?? ClassificationResult.insufficient;
  if (result == ClassificationResult.human) {
    await submitSignUp(form);
  } else {
    showChallenge(); // bot, undetermined or insufficient: a captcha, a delay, a manual review
  }
}

注: 分類はセッションに関するひとつのシグナルであり、それ自体が判断ではありません。上記のように、 bot、undetermined、insufficient に対するフォールバックの経路を用意してください。スコアがどのように 作られるかはスコアリングの仕組みで説明しています。

セットアップの確認

本番パッケージはログを出力しないため、コードから SDK を確認します。ステージングパッケージは各ステップを ログにも書きます。テレメトリを参照してください。

  1. flutter run で端末またはエミュレーター上でアプリを実行し、同意ダイアログを受け入れて、アプリを 使います(タップ、スクロール、スワイプ)。タップ、ドラッグ、スクロールのそれぞれが アクションです。 モデルが求める数(組み込みモデルでは 8)に達すると、スコアは 十分になります。 証拠を参照してください。

  2. たとえばデバッグ用ボタンから、SDK の状態を出力します:

import 'package:dea_sdk/dea_sdk.dart';
import 'package:flutter/foundation.dart';

void printDeaState() {
  final dea = DeaSdk.instance!;
  debugPrint('error: ${dea.error}');                // null
  debugPrint('scoring: ${dea.isScoring}');          // true
  debugPrint('consent: ${dea.consent.decision}');   // ConsentDecision.granted

  final info = dea.getSessionInfo();
  debugPrint('session: ${info.session}');           // a UUID
  debugPrint('sdk: ${info.sdk.version}');           // 0.26.0

  final read = dea.getClassification();
  debugPrint('actions: ${read.actions}, result: ${read.result}, '
      'score: ${read.value}, model: ${read.modelVersion}');
}
  1. さらに操作してから再度呼び出します。アプリを使うにつれて actions が増え、8 に達すると result が insufficient から変わるはずです。0 のままの場合はトラブルシューティングを 参照してください。

リリース前に

  • [ ] 各プラットフォームが固有の appId と appKey を DeaSdk.init に渡している — オプションを参照
  • [ ] 同意ダイアログを表示している、または独自の同意フローが setConsent を呼んでいる — ユーザー同意を参照
  • [ ] 判断ポイントで分類を読み取り、bot、undetermined、insufficient に対するフォールバックがある — ヒューマンスコアリングを参照
  • [ ] パスワード画面と決済画面で取得を一時停止している — 機密性の高い画面を参照
  • [ ] ログアウト時に reset() を呼んでいる — セッションを参照
  • [ ] Web ビュー内の入力の後に判断がある場合、そのタッチを転送している — ヒューマンスコアリングを参照
  • [ ] Android: アプリが Play Integrity 向けにセットアップされている。iOS: App Attest ケイパビリティが追加されている — アテステーションを参照
  • [ ] クロスプラットフォームのチェックリストの残り — 本番環境への移行を参照

次のステップ