Android で reCAPTCHA Enterprise を使用して App Check を使ってみる

このページでは、reCAPTCHA Enterprise プロバイダを使用して、Android アプリで App Check を設定する方法について説明します。App Check を使用すると、自分のアプリだけがプロジェクトのバックエンド リソースにアクセスできるようになります。詳しくは、App Check の概要をご覧ください。

App Check では、スコアベースの reCAPTCHA キーを使用する必要があります。これにより、ユーザーには表示されなくなります。つまり、reCAPTCHA Enterprise プロバイダがユーザーに問題の解決を求めることはありません。

ユースケースで App Check によって実装されない reCAPTCHA Enterprise 機能を必要とする場合や、独自のカスタム プロバイダで App Check を使用する場合は、App Check カスタム プロバイダを実装するをご覧ください。

1. Firebase プロジェクトを設定する

1. まだ追加していない場合は、Firebase を Android プロジェクトに追加します。

2. Google Cloud コンソールで、[Fraud Defense] ページに移動し、reCAPTCHA Enterprise プロバイダに対して次の操作を行います。

   1. 正しいプロジェクトが選択されていることを確認します（画面上部のプロジェクト選択ツールを参照）。

   2. プロンプトが表示されたら、reCAPTCHA Enterprise API を有効にします。

   3. Android タイプのキーを作成し、アプリのパッケージ名（例: com.example.my_app）を指定します。

      • Firebase プロジェクトで Firebase Android アプリを作成したときに指定したパッケージ名と同じパッケージ名を入力してください。パッケージ名の値では大文字と小文字が区別されます。

      • App Check の場合、各パッケージ名は 1 つの reCAPTCHA キーにのみ対応できます。

      詳細な手順については、スコアベースの reCAPTCHA キーを作成するをご覧ください。

   4. このキーをメモしておきます。Firebase コンソールの登録フローに追加する必要があります。

3. Firebase コンソールで、[セキュリティ] > [App Check] に移動します。

4. [アプリ] タブで、reCAPTCHA Enterprise プロバイダで App Check を使用するように Android アプリを登録します。Google Cloud コンソールで取得したキーを指定する必要があります。

5. 省略可: トークンの有効期間（TTL）を設定します。

   アプリの登録設定で、プロバイダが発行する App Check トークンのカスタム有効期間（TTL）を設定します。TTL は 30 分から 7 日までの任意の値に設定できます。この値を変更する場合は、次のトレードオフに注意してください。

   • セキュリティ: TTL が短いほど、漏えいしたトークンや傍受されたトークンが攻撃者によって悪用される可能性が低減するため、セキュリティが向上します。
   • パフォーマンス: TTL が短いほど、アプリで証明書の取得が頻繁に行われます。アプリで証明書が取得されるたびにネットワーク リクエストのレイテンシが増加するため、TTL が短いと、アプリのパフォーマンスに影響する可能性があります。
   • 割り当てとコスト: TTL を短くすると、証明書の取得が頻繁に発生し、割り当てが早く消費されます。有料サービスの場合は、費用が増加する可能性があります。割り当てと上限をご覧ください。

   通常は、デフォルトの TTL（1 時間）で十分です。App Check ライブラリは TTL の約半分でトークンを更新することに留意してください。

6. 省略可: 詳細設定を構成します。

7. [保存] をクリックします。

（省略可）詳細設定を構成する

ユーザーがアプリを開くと、reCAPTCHA Enterprise はキーの下でユーザー インタラクションがもたらすリスクレベルを評価し、0.1 刻みの 0.0 ～ 1.0 の範囲でスコアを返します。

• スコア 0.0 は、インタラクションのリスクが高く、不正行為の可能性があることを示します。
• スコア 1.0 は、インタラクションのリスクが低く、正当である可能性が非常に高いことを示します。

App Check では、アプリのリスクしきい値を設定して、このリスクに対する許容度を調整できます。

ほとんどのユースケースでは、デフォルトのしきい値 0.5 をおすすめします。ユースケースで調整が必要な場合は、Firebase コンソールで各アプリに対してこの値を構成できます（[セキュリティ] > [App Check] に移動します）。以下のアプリのリスクしきい値の構成に関する重要な考慮事項を開いて確認してください。

2. アプリに App Check SDK を追加する

reCAPTCHA Enterprise プロバイダを使用するには、対応する依存関係を追加する必要があります。

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:35.1.0"))

    // Add the dependency for the App Check reCAPTCHA library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-recaptcha")
}

Firebase Android BoM を使用すると、アプリは常に互換性のあるバージョンの Firebase Android ライブラリを使用します。

dependencies {
    // Add the dependency for the App Check reCAPTCHA library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-recaptcha:20.0.0")
}

3. App Check を初期化する

アプリで他の Firebase サービスを使用する前に、App Check を初期化する必要があります。

Firebase.initialize(context = this)
Firebase.appCheck.installAppCheckProviderFactory(
    RecaptchaAppCheckProviderFactory.getInstance("SITE_KEY")
)

FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
      RecaptchaAppCheckProviderFactory.getInstance("SITE_KEY"));

4. 指標をモニタリングして適用を有効にする

アプリで App Check を設定したら、更新されたアプリのユーザーへの配布を開始します。

更新されたクライアント アプリは、Firebase にリクエストを送信するたびに App Check トークンを送信します。ただし、App Check は、App Check が適用されるまで、無効なトークンを含むリクエストをブロックしません。

指標をモニタリングする

適用を有効にする前に、既存の正規ユーザーを中断しないように対策を行う必要があります。一方、アプリリソースの不審な使用に気づいた場合は、すぐに適用を有効にすることもできます。

使用するサービスの App Check 指標を確認すると、この決定を行ううえで役立ちます。

• Firebase AI Logic、SQL Connect、Realtime Database、Cloud Firestore、Cloud Storage、Authentication、Google Identity for iOS、Maps JavaScript API、Places API（新規）の App Check リクエスト指標をモニタリングします。
• Cloud Functions に対して App Check リクエスト指標をモニタリングします。

App Check 適用を有効にする

App Check がユーザーに与える影響を理解し、続行する準備ができたら、App Check の適用を有効にできます。

• Firebase AI Logic、SQL Connect、Realtime Database、Cloud Firestore、Cloud Storage、Authentication、Google Identity for iOS、Maps JavaScript API、Places API（新規）の App Check の適用を有効にします。
• Cloud Functions に対して App Check の適用を有効にします。

デバッグ環境で App Check を使用する

App Check は、開発中のエミュレータ / シミュレータからのリクエストや、継続的インテグレーション（CI）環境からのリクエストなど、一部の環境を無効として分類します。

App Check が適用された後にこのような環境でアプリを実行するには、本番環境の証明書プロバイダの代わりに App Check デバッグ プロバイダを使用するアプリのデバッグビルドを作成する必要があります。

詳細については、Android のデバッグ プロバイダで App Check を使用するをご覧ください。

料金

App Check は、アプリが App Check トークンを更新するたびに、ユーザーのレスポンス トークンを検証するために、ユーザーに代わって評価を作成します。無料割り当て枠を超えて作成された評価ごとに、Firebase プロジェクトに課金されます。詳細については、reCAPTCHA の料金をご覧ください。

デフォルトでは、アプリはこのトークンを 1 時間に 2 回更新します。アプリで App Check トークンの更新頻度（つまり、新しい評価を作成する頻度）を制御するには、トークンの TTL を構成します。