DEA SDK for React Native¶
アプリのセッションが実在の人物によるものかどうかを検出します。SDK は React Native アプリ全体のタッチ入力と 端末の動きを、Android と iOS のネイティブ側で観測し、セッションを端末上でスコアリングします。
このページの内容: 前提条件 · インストール · SDK の初期化 · 同意を求める · 分類を使う · セットアップの確認 · リリース前に · 次のステップ
前提条件¶
- 各プラットフォームのアプリごとの
appIdとappKey。 アカウントとキーを参照してください。Android では、Play Integrity のために DEA が発行した Google Cloud プロジェクト番号も必要です。アテステーションを 参照してください。 - React Native 0.76 以降で、New Architecture が有効であること。SDK は TurboModule であり、旧アーキテクチャ では読み込まれません。
- Android:
minSdkVersion24(Android 7.0)以降 - iOS: デプロイメントターゲット 15.1 以降
SDK は Android と iOS で動作します。その他の React Native ターゲット(web、Windows、macOS)はサポートされて
おらず、init は reject されます。
Expo¶
Expo Go はサポートされていません。 SDK には Expo Go に含まれないネイティブコードが含まれています。
パッケージは Expo config plugin を提供していないため、npx expo prebuild が生成するネイティブプロジェクトには、
以下で説明する iOS と Android のセットアップは追加されません。
インストール¶
注:
@dea/react-nativeは npm レジストリではなく、DEA のリリース URL からインストールします。URL が リリースを指定します。このパッケージがラップするネイティブ SDK も同じリリースから取得し、以下のとおりに セットアップします。
npm¶
JavaScript パッケージは DEA のネイティブ Android SDK と iOS SDK をラップします。React Native の autolinking が
両方のネイティブ側をリンクします。各ネイティブ側は、@dea/react-native と同じバージョンのネイティブ SDK に
依存し、アプリは次の 2 つの手順でそれを追加します。アップグレードするには、新しいリリースの URL を
インストールし、新しいバージョンで 2 つの手順を繰り返します。
iOS のセットアップ¶
iOS 側は DeaSDK pod に依存し、DeaSDK は DeaBase と DeaAutomationDetection の pod に依存します。
DEA はこれらを CocoaPods trunk ではなく Swift パッケージのアーカイブとして公開しているため、アプリが
ダウンロードし、それぞれを podspec で記述します。
-
アプリのルートフォルダーから、アーカイブをダウンロードします:
-
次の 3 つの podspec を、3 つのフォルダーと並べて
ios/vendor/deaに書きます:# ios/vendor/dea/DeaBase.podspec Pod::Spec.new do |s| s.name = 'DeaBase' s.version = '0.26.0' s.summary = 'DEA SDK: capture and shared types.' s.homepage = 'https://sdk.dep-protocol.com' s.license = { :type => 'Proprietary' } s.author = 'DEA' s.source = { :path => '.' } s.ios.deployment_target = '13.0' s.swift_version = '5.9' s.source_files = 'dea-base-0.26.0/Sources/DeaBase/**/*.swift' end# ios/vendor/dea/DeaAutomationDetection.podspec Pod::Spec.new do |s| s.name = 'DeaAutomationDetection' s.version = '0.26.0' s.summary = 'DEA SDK: automation detection.' s.homepage = 'https://sdk.dep-protocol.com' s.license = { :type => 'Proprietary' } s.author = 'DEA' s.source = { :path => '.' } s.ios.deployment_target = '13.0' s.swift_version = '5.9' s.source_files = 'dea-automation-detection-0.26.0/Sources/DeaAutomationDetection/**/*.swift' s.dependency 'DeaBase', s.version.to_s end# ios/vendor/dea/DeaSDK.podspec Pod::Spec.new do |s| s.name = 'DeaSDK' s.version = '0.26.0' s.summary = 'DEA SDK: scoring, the device key, proofs and models.' s.homepage = 'https://sdk.dep-protocol.com' s.license = { :type => 'Proprietary' } s.author = 'DEA' s.source = { :path => '.' } s.ios.deployment_target = '13.0' s.swift_version = '5.9' s.source_files = 'dea-sdk-0.26.0/Sources/DeaSDK/**/*.swift' s.dependency 'DeaBase', s.version.to_s s.dependency 'DeaAutomationDetection', s.version.to_s s.vendored_frameworks = 'dea-sdk-0.26.0/Frameworks/DeaCore.xcframework' core_headers = '"${PODS_XCFRAMEWORKS_BUILD_DIR}/DeaSDK/Headers"' s.pod_target_xcconfig = { 'SWIFT_INCLUDE_PATHS' => core_headers } s.user_target_xcconfig = { 'SWIFT_INCLUDE_PATHS' => core_headers } s.frameworks = 'DeviceCheck', 'CryptoKit', 'Security' end -
ios/Podfileのアプリのターゲットで 3 つの pod を指定します。パスはiosフォルダーからの相対パス です: -
pod をインストールします:
パッケージの pod は iOS デプロイメントターゲット 15.1 以降を必要とします。この pod は @dea/react-native と
完全に同じバージョンの DeaSDK を要求するため、podspec にはそのバージョンを指定してください。
Android のセットアップ¶
Android 側は、@dea/react-native と同じバージョンの ai.dea:dea-sdk に依存します。Gradle はライブラリの
依存関係をアプリのリポジトリから解決するため、android/build.gradle の末尾に、リリースに対応する DEA の
Maven リポジトリを追加します:
// android/build.gradle
allprojects {
repositories {
maven {
url = uri("https://sdk.dep-protocol.com/0.26.0/android")
content { includeGroup("ai.dea") }
}
}
}
リポジトリの URL がリリースを指定し、各リリースのリポジトリはそのリリースだけを配信します。
@dea/react-native と同じバージョンにしてください。content フィルターにより、Gradle は DEA の
リポジトリに DEA のパッケージだけを問い合わせます。
ネイティブ Android SDK は INTERNET パーミッションを宣言しており、Android のマニフェストマージャーがアプリに
追加します。
SDK の初期化¶
初期化は一度だけ、できるだけ早く行います。エントリーファイルのトップレベル、またはルートコンポーネントの最初の effect で呼び出し、取得がセッション全体を覆うようにします。
import {useEffect} from 'react';
import * as Dea from '@dea/react-native';
import {Root} from './Root';
export default function App() {
useEffect(() => {
Dea.init({appId: 'YOUR_APP_ID'}).then(started => {
if (!started.ready) {
console.warn('DEA cannot score:', started.coreFault);
}
});
}, []);
return <Root />;
}
- すべての呼び出しは promise を返します。 軽い呼び出しも同様です。順序が重要な場合は await してください。
initは複数回呼び出しても安全です。再度呼び出すと、実行中のセッションを返し、そのオプションを保持します。- スコアリングエンジンが起動できなくても
initは失敗しません。 SDK は取得を続け、started.readyはfalseになり、started.coreFaultが理由を示します。 automationDetection: trueの場合、自動化がアプリを操作している確かな兆候を最初に見つけた時点で、SDK は すべてのアカウントとビルドで直ちに停止します。何も取得、スコアリング、署名、登録されず、分類はinsufficientのままです。停止はreset()または新しい起動(アプリの再起動、またはdispose()の後のinit)まで続き、その間stopped()はオブジェクトを返します。root 化された Android 端末やジェイルブレイク された iPhone でも SDK は停止します(テストビルドを除く)。 自動化の検出と root 化・ジェイルブレイクされた端末を参照してください。- 取得はグローバルです。アプリ内のすべてのタッチ、モーションセンサー、アプリのライフサイクルが対象です。 アプリをラップするコンポーネントも、画面ごとに登録するものもありません。
deaTarget、getTargetTally、onAttestationEventを除くその他すべての呼び出しは、initが実行されるまで reject されます。- ユーザーが同意するまで何も記録されません。 次のステップを参照してください。
注:
initにはappKeyも渡してください。ビルド対象プラットフォームのキーです。分類の読み取りには 不要で、スコアリングは端末上で行われます。キーがない場合、本番環境のappIdではattest()が DEA に接続せずにunsupportedを返します。キーの用途は アカウントとキーを参照してください。
同意を求める¶
デフォルトでは、ユーザーが同意するまで SDK は何も記録しません。このステップは必須です。同意を求めないアプリは データを収集せず、分類も得られません。
React Native SDK には同意ダイアログは組み込まれていません。独自の UI で尋ねたうえで、回答を記録します。
import {Alert} from 'react-native';
import * as Dea from '@dea/react-native';
export async function askForConsent(): Promise<void> {
if ((await Dea.getConsent()) !== 'unknown') return; // already answered
Alert.alert(
'Help us keep bots out',
'We measure how you touch and hold your phone to tell people apart from bots. We never record what you type or what is on your screen.',
[
{text: 'Not now', style: 'cancel', onPress: () => Dea.setConsent(false)},
{text: 'Allow', onPress: () => Dea.setConsent(true)},
],
);
}
回答は端末に保存されるため、質問は一度だけで済みます。init の前にすでに尋ねている場合は、代わりに回答を
init に渡してください。ユーザー同意を参照してください。SDK が
取得するものと決して読み取らないものは、プライバシーとネットワークに
あります。
分類を使う¶
判断を下す瞬間に分類を読み取ります。読み取りは高速でローカルに 完結し、ネットワークを呼び出しません。
import * as Dea from '@dea/react-native';
async function onSignUp(form: SignUpForm) {
const {result} = await Dea.getClassification();
if (result === 'human') {
await submitSignUp(form);
} else {
showChallenge(); // 'bot', 'undetermined' or 'insufficient': a captcha, a delay, a manual review
}
}
しきい値は読み込まれたモデルに由来し、アプリからは決まりません。
insufficient と undetermined はそれ自体がひとつの結果であり、それぞれで何を許可するかはアプリが決めます。
insufficient は、セッションがモデルの要求するアクション数(組み込み
モデルでは 8。証拠を参照)に達しておらず、まだ
十分でないことを意味します。このとき value は null です。
undetermined はスコアが 2 つのしきい値の間にあることを意味します。
スコアリングの仕組みを参照してください。
セットアップの確認¶
initの後、コードから SDK を確認します。
const started = await Dea.init({appId: 'YOUR_APP_ID'});
console.log('ready:', started.ready); // true
console.log('fault:', started.coreFault); // null
console.log('sdk:', started.sdkVersion);
const info = await Dea.getSessionInfo();
console.log('session:', info.session); // a UUID
- 同意を与え、アプリを操作(タップ、スクロール、スワイプ)してアクションを 8 回以上発生させ、分類を読み取ります。
console.log(await Dea.getConsent()); // 'granted'
console.log(await Dea.getClassification());
// { result, value, actions, botThreshold, humanThreshold, modelVersion }
actions がモデルの要求する数(組み込みモデルでは 8)に達すると、result は 'insufficient' から
変わります。
- Android で
testチャネルの SDK ビルドを使う場合は、debugを有効にして Logcat を確認することもできます。出荷する SDK は何も出力しません。
同意後は、取得したイベントごとに [dea] … の行が 1 行表示されるはずです。画面に触れても何も表示されない
場合は、トラブルシューティングを参照してください。
リリース前に debug を無効にしてください。
リリース前に¶
- [ ]
debugがfalseになっている - [ ] 同意フローが
setConsentを呼び出すか、consentをinitに渡している。ユーザー同意を参照 - [ ] 判断ポイントで分類を読み取り、
bot、undetermined、insufficientのフォールバックがある。ヒューマンスコアリングを参照 - [ ] 主要なコントロールに
deaTargetで名前を付けている。ビューに名前を付けるを参照 - [ ] パスワード画面と決済画面で取得を一時停止している。機密性の高い画面を参照
- [ ] ログアウト時に
reset()を呼び出している。セッションを参照 - [ ] プライバシーポリシーが SDK の取得・送信内容を網羅している。プライバシーとネットワークと本番環境への移行を参照
次のステップ¶
- ユーザー同意 — 何かを記録する前に尋ねる
- ヒューマンスコアリング — 分類を読み取り、ビューに名前を付ける
- 機密性の高い画面 — パスワード画面と決済画面で取得を一時停止する
- セッション — ログアウト時に新しいセッションを開始する
- オプション —
initが受け付けるすべてのオプション - スコアリングの仕組み — セッション、証拠、モデルとそのしきい値
- アカウントとキー — DEA が発行する
appIdとappKey - トラブルシューティング