Identity Platform を reCAPTCHA Enterprise API と統合する

メールとパスワードのプロバイダ

メールアドレスとパスワードの認証フローでは、監査モードと適用モードは次のように動作します。

監査モード

メールアドレスとパスワードの適用を監査モードに設定すると、Identity Platform は、リクエストをブロックせずに Identity Platform API へのトラフィックを評価するために使用される 1 つ以上の reCAPTCHA キーをプロジェクトに作成します。監査モードで出力される指標を使用して、reCAPTCHA の適用を有効にするかどうかを判断します。

自動適用モード

メールとパスワードの適用を適用モードに設定すると、Identity Platform は、Identity Platform API へのトラフィックを評価するために使用される 1 つ以上の reCAPTCHA キーをプロジェクトに作成します。reCAPTCHA トークンを含まない API リクエストは拒否されます。reCAPTCHA をサポートする SDK にすべてのクライアントを移行した後にのみ、適用を有効にします。

電話プロバイダ

電話認証フローでは、監査モードと適用モードは次のように動作します。

監査モード

電話認証の適用を監査モードに設定すると、Identity Platform はアプリの確認に reCAPTCHA ボット保護を使用します。ユーザーのリクエストが通信不正利用の評価で合格した場合、SMS 確認コードが送信されます。ユーザーのリクエストが通信不正利用の評価で不合格であり、クライアント SDK を使用している場合、Identity Platform はフォールバックの確認方法をトリガーして、電話認証フローを完了します。受け入れられるフォールバック メソッドは、アプリのプラットフォームによって異なります。

クライアント SDK は、次のシナリオでフォールバックの確認方法をトリガーします。

• reCAPTCHA トークンがありません。
• reCAPTCHA トークンが無効であるか、期限切れです。
• reCAPTCHA トークンがスコアのしきい値を超えていません。
• reCAPTCHA が正しく設定されていない。

アプリのプラットフォームのフォールバック確認方法が設定され、必要に応じてクライアント SDK によってトリガーされる準備ができていることを確認します。

自動適用モード

電話認証の適用を適用モードに設定すると、Identity Platform はアプリの確認に reCAPTCHA ボット保護を使用します。ユーザーのリクエストが通信不正利用の評価で合格した場合、SMS 確認コードが送信されます。ユーザーのリクエストが通信不正利用の評価で不合格になると、Identity Platform はリクエストをブロックし、確認コードを含む SMS メッセージを送信しません。

適用モードではフォールバック検証は必要ないため、アプリに追加の検証方法を設定する必要はありません。ただし、アプリの reCAPTCHA モードを AUDIT または OFF に変更する場合は、reCAPTCHA v2 が有効になるように、ウェブアプリ用の reCAPTCHA 検証ツールを設定することをおすすめします。

メールとパスワードのプロバイダ

メールアドレスとパスワードの認証フローで reCAPTCHA ボット保護を有効にするには、次の操作を行います。

1. まだ行っていない場合は、プロジェクトで reCAPTCHA Enterprise API を有効にします。

2. プロジェクトのボット保護を有効にするには、Admin SDK を使用します。reCAPTCHA のサポートは、Node.js Admin SDK バージョン 11.7.0 以降で利用できます。

   次に例を示します。

   // Update project config with reCAPTCHA config
   const updateConfigRequest = {
     recaptchaConfig: {
       emailPasswordEnforcementState:  'ENFORCE_MODE',
       managedRules: [{
         endScore: END_SCORE,
         action: 'BLOCK'
       }]
     }
   };
   const updateProjectConfigWithRecaptcha = () => {
     getAuth().projectConfigManager().updateProjectConfig(updateConfigRequest).then((response) => {
       console.log('Updated reCAPTCHA config for project: ', response.recaptchaConfig);
     }).catch((error) => {
       console.log('Error updating project config:', error);
     });
   }
   

   次のように置き換えます。

   • ENFORCE_MODE: reCAPTCHA のメールアドレスとパスワードによる認証の適用に設定するモード。有効な値は OFF、AUDIT、ENFORCE です。ボット保護を有効にするには、このパラメータを AUDIT または ENFORCE に設定する必要があります。ボット保護を初めて有効にする場合は、このパラメータを AUDIT に設定し、認証フローが保護されていることを確認してから ENFORCE に設定することをおすすめします。モードの仕組みについて詳しくは、reCAPTCHA bot 保護モードをご覧ください。
   • END_SCORE: リクエストが失敗する前に取得できるボット保護評価スコアの最低値。このスコアは 0.0～1.0 の範囲で設定できます。たとえば、しきい値を 0.6 に設定すると、reCAPTCHA は 0.5 以下のリクエストをすべて失敗させます。したがって、スコアを高く設定するほど、ルールは厳しくなります。

   Admin SDK を使用して、テナントに対して同じ構成メソッドでボット保護を有効にすることもできます。テナントの更新の詳細については、テナントを更新するをご覧ください。

3. iOS または Android で Identity Platform を使用している場合は、Firebase コンソールからアプリを登録する必要があります。

   • iOS の場合は、Identity Platform を使用する各バンドル ID を登録します
   • Android の場合は、Identity Platform を使用する各 Android パッケージ名を登録します

   ウェブで Identity Platform を使用している場合は、reCAPTCHA を使用する各ドメインに対して承認済みドメインを追加する必要があります。承認済みドメインを追加するには、次の操作を行います。

   1. Google Cloud コンソールで、Identity Platform ページに移動します。

      Identity Platform に移動

   2. [設定] > [セキュリティ] に移動します。

   3. [ドメインを追加] をクリックします。

   4. ドメイン名を入力し、[追加] をクリックしてドメインを保存します。

   reCAPTCHA キーのプロビジョニングが完了するまでに数分かかることがあります。

4. 適用を監査モードに設定した場合は、ボット保護の reCAPTCHA 指標をモニタリングして、フローが保護されていることを確認することをおすすめします。

電話プロバイダ

SMS ベースの認証フローで reCAPTCHA ボット保護を有効にするには、次の操作を行います。

1. まだ行っていない場合は、プロジェクトで reCAPTCHA Enterprise API を有効にします。

2. プロジェクトのボット保護を有効にするには、Admin SDK を使用します。reCAPTCHA のサポートは、Node.js Admin SDK バージョン 12.7.0 以降で利用できます。

   次に例を示します。

   // Update project config with reCAPTCHA config
   const updateProjectConfigRequest = {
     recaptchaConfig: {
       phoneEnforcementState: 'ENFORCE_MODE',
       managedRules: [{ endScore: END_SCORE, action: 'BLOCK' }],
       useSmsBotScore: 'true',
     }
   }
   let projectConfig = await getAuth().projectConfigManager().updateProject(updateProjectConfigRequest);
   

   次のように置き換えます。

   • ENFORCE_MODE: reCAPTCHA 電話認証の強制適用に設定するモード。有効な値は OFF、AUDIT、ENFORCE です。SMS ベースのフローでボット保護を有効にするには、このパラメータを AUDIT または ENFORCE に設定し、useSmsBotScore を true に設定する必要があります。

     ボット保護を初めて有効にする場合は、このパラメータを AUDIT に設定し、認証フローが保護されていることを確認してから ENFORCE に設定することをおすすめします。モードの仕組みについて詳しくは、reCAPTCHA bot 保護モードをご覧ください。

   • END_SCORE: リクエストが失敗する前に取得できるボット保護評価スコアの最低値。このスコアは 0.0～1.0 の範囲で設定できます。たとえば、しきい値を 0.6 に設定すると、reCAPTCHA は 0.5 以下のリクエストをすべて失敗させます。したがって、スコアを高く設定するほど、ルールは厳しくなります。

   Admin SDK を使用して、テナントに対して同じ構成メソッドでボット保護を有効にすることもできます。テナントの更新の詳細については、テナントを更新するをご覧ください。

3. iOS または Android で Identity Platform を使用している場合は、Firebase コンソールからアプリを登録する必要があります。

   • iOS の場合は、Identity Platform を使用する各バンドル ID を登録します
   • Android の場合は、Identity Platform を使用する各 Android パッケージ名を登録します

   ウェブで Identity Platform を使用している場合は、reCAPTCHA を使用する各ドメインに対して承認済みドメインを追加する必要があります。承認済みドメインを追加するには、次の操作を行います。

   1. Google Cloud コンソールで、Identity Platform ページに移動します。

      Identity Platform に移動

   2. [設定] > [セキュリティ] に移動します。

   3. [ドメインを追加] をクリックします。

   4. ドメイン名を入力し、[追加] をクリックしてドメインを保存します。

   reCAPTCHA キーのプロビジョニングが完了するまでに数分かかることがあります。

4. 適用を監査モードに設定した場合は、ボット保護の reCAPTCHA 指標をモニタリングして、フローが保護されていることを確認することをおすすめします。

Web

1. 最新バージョンのウェブ SDK に更新します。

   • ウェブアプリでのメールアドレスとパスワードによる認証の reCAPTCHA サポートは、JavaScript SDK バージョン 9.20.0 以降で利用できます。
   • ウェブアプリの電話番号認証の reCAPTCHA サポートは、JavaScript SDK バージョン 11 以降で利用できます。

   Web SDK をアプリと統合すると、SDK は reCAPTCHA 構成を自動的に取得し、構成したプロバイダの保護を有効にします。

2. 必要に応じて、次のように reCAPTCHA シグナルを強制的に取得できます。

   import { initializeRecaptchaConfig } from '@firebase/auth';
   
   // Initialize Firebase Authentication
   const auth = getAuth();
   initializeRecaptchaConfig(auth)
     .then(() => {
       console.log("Recaptcha Enterprise Config Initialization successful.")
     })
     .catch((error) => {
       console.error("Recaptcha Enterprise Config Initialization failed with " + error)
     });
   

Android

1. Android SDK の最新バージョンに更新します。Android アプリでのメールアドレスとパスワード認証、電話番号認証の reCAPTCHA サポートは、Android SDK バージョン 23.1.0 以降で利用できます。

   また、reCAPTCHA のサポートには API レベル 23（Marshmallow）以上と Android 6 以上が必要です。

   Android SDK をアプリと統合した後、SDK は reCAPTCHA 構成を自動的に取得し、構成したプロバイダの保護を有効にします。

2. アプリレベルの build.gradle ファイルの依存関係セクションに、次のビルドルールを追加します。

   implementation 'com.google.android.recaptcha:recaptcha:18.5.1'
   

   reCAPTCHA SDK バージョン 18.5.1 以降を使用していることを確認します。

3. 必要に応じて、次のように reCAPTCHA シグナルを強制的に取得できます。

   • Kotlin:

   // Initialize Firebase Authentication
   auth = Firebase.auth
   
   auth.initializeRecaptchaConfig().addOnCompleteListener(this) { task ->
       if (task.isSuccessful) {
           Log.d(TAG, "Recaptcha Enterprise Initialization successful.")
       } else {
           Log.w(TAG, "Recaptcha Enterprise Initialization failed.")
       }
   }
   

   • Java:

   // Initialize Firebase Authentication
   auth = FirebaseAuth.getInstance();
   auth.initializeRecaptchaConfig().addOnCompleteListener(
     this, new OnCompleteListener<void>() {
     @Override
     public void onComplete(@NonNull Task<void> task) {
       if (task.isSuccessful()) {
         Log.d(TAG, "Recaptcha Enterprise Initialization successful.");
       } else {
         Log.w(TAG, "Recaptcha Enterprise Initialization failed.");
       }
     }
   });
   

iOS

1. iOS SDK バージョン 11.6.0 以降に更新します。iOS SDK をアプリと統合すると、SDK は reCAPTCHA 構成を自動的に取得し、構成したプロバイダの保護を有効にします。

2. reCAPTCHA iOS SDK をアプリに統合するには、環境を準備するをご覧ください。

3. リンカーフラグに -ObjC が一覧表示されていることを確認します。[Target] > [Build Settings] > [All] > [Linking] に移動し、Other Linker Flags に -ObjC が表示されていることを確認します。

4. 必要に応じて、次のように reCAPTCHA シグナルを強制的に取得できます。

   • Swift:

   // Initialize Firebase Authentication
   try await Auth.auth().initializeRecaptchaConfig()
   

   • Objective-C:

   // Initialize Firebase Authentication
   [[FIRAuth auth] initializeRecaptchaConfigWithCompletion:^(NSError * _Nullable error) {
     // Firebase Authentication initialization finished
   }];
   

メールとパスワードのプロバイダ

プロジェクトまたはテナントのメールアドレスとパスワードの認証フローで reCAPTCHA の適用を有効にするには、Admin SDK を使用して次のコマンドを実行します。

const enforceRequest = {
  recaptchaConfig: {
    emailPasswordEnforcementState:  'ENFORCE',
    }]
  }
};

電話プロバイダ

プロジェクトまたはテナントで SMS ベースの認証フローに対して reCAPTCHA の適用を有効にするには、Admin SDK を使用して次のコマンドを実行します。

const enforceRequest = {
  recaptchaConfig: {
    phoneEnforcementState:  'ENFORCE',
    useSmsBotScore: 'true'
    }]
  }
};

メールとパスワードのプロバイダ

メールアドレスとパスワードによる認証フローのボット保護を無効にするには、Admin SDK を使用して次のコマンドを実行します。

const disableRequest = {
  recaptchaConfig: {
    emailPasswordEnforcementState:  'OFF',
  }
};

電話プロバイダ

SMS ベースの認証フローでボット保護を無効にするには、Admin SDK を使用して次のコマンドを実行します。

const disableRequest = {
  recaptchaConfig: {
    phoneEnforcementState:  'OFF',
    useSmsBotScore: 'false'
  }
};