Kurzanleitung: reCAPTCHA Enterprise in Google Cloud einrichten

In dieser Kurzanleitung erfahren Sie, wie Sie reCAPTCHA Enterprise in Google Cloud einrichten. Für die Einrichtung von reCAPTCHA Enterprise in Google Cloud müssen die reCAPTCHA Enterprise API aktiviert, ein Dienstkonto erstellt und das Dienstkonto für die Back-End-Authentifizierung konfiguriert werden. Dieses Dokument gilt sowohl für PaaS-Optionen wie App Engine- als auch IaaS-Optionen wie virtuelle Maschinen in Compute Engine.

Hinweis

  1. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Projektauswahl

  2. Die Abrechnung für das Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für Ihr Projekt aktiviert ist.

    reCAPTCHA Enterprise erfordert eine Verknüpfung und Aktivierung der Abrechnung für das Projekt, um auf die API zugreifen zu können. Sie können die Abrechnung entweder mithilfe einer Kreditkarte oder anhand einer vorhandenen Abrechnungs-ID im Google Cloud-Projekt aktivieren. Wenn Sie Hilfe bei der Abrechnung benötigen, wenden Sie sich an den Cloud Billing-Support.

reCAPTCHA Enterprise API aktivieren

Console

  1. Rufen Sie in der Cloud Console die Seite reCAPTCHA Enterprise API auf.

    Zur reCAPTCHA Enterprise API

  2. Prüfen Sie, ob der Name Ihres Projekts in der Projektauswahl oben auf der Seite angezeigt wird.

    Wenn Sie den Namen Ihres Projekts nicht sehen, klicken Sie auf die Projektauswahl und wählen Sie Ihr Projekt aus.

  3. Klicken Sie auf Aktivieren.

gcloud

  1. Führen Sie den Befehl gcloud config set project aus, um Ihr Google Cloud-Projekt in der gcloud-Sitzung festzulegen. Ersetzen Sie PROJECT_ID durch Ihre Google Cloud-Projekt-ID.
           gcloud config set project PROJECT_ID
           
  2. Führen Sie den Befehl gcloud services enable aus, um die reCAPTCHA Enterprise API zu aktivieren:
             gcloud services enable recaptchaenterprise.googleapis.com
           
  3. Führen Sie den Befehl gcloud services list aus, um zu prüfen, ob die reCAPTCHA Enterprise API aktiviert ist:
             gcloud services list --enabled
           

    Prüfen Sie, ob die reCAPTCHA Enterprise API in der Liste der aktivierten APIs aufgeführt ist.

Dienstkonto für die Back-End-Authentifizierung erstellen

Console

  1. Rufen Sie in der Cloud Console die Seite Dienstkonten auf.

    Zur Seite „Dienstkonten“

  2. Wählen Sie das Projekt aus, für das Sie die reCAPTCHA Enterprise API aktiviert haben.
  3. Klicken Sie auf Dienstkonto erstellen.
  4. Geben Sie einen Dienstkontonamen ein, der in der Cloud Console angezeigt werden soll.

    Die Cloud Console generiert anhand dieses Namens eine Dienstkonto-ID. Bearbeiten Sie gegebenenfalls die ID. Sie können die ID später nicht mehr ändern.

  5. Optional: Geben Sie eine Beschreibung für das Dienstkonto ein.
  6. Klicken Sie auf Erstellen.
  7. Wählen Sie im Drop-down-Menü Rolle auswählen die Option reCAPTCHA Enterprise Agent aus.
  8. Klicken Sie auf Fertig.
  9. Klicken Sie in der Liste der Dienstkonten auf die E-Mail-Adresse des von Ihnen erstellten Dienstkontos.
  10. Klicken Sie auf Schlüssel.
  11. Klicken Sie auf Schlüssel hinzufügen und wählen Sie Neuen Schlüssel erstellen aus.
  12. Wählen Sie im Dialogfeld JSON aus und klicken Sie auf Erstellen.

    Eine JSON-Datei mit Ihrem Schlüssel wird auf Ihren Computer heruntergeladen.

  13. Klicken Sie auf Schließen.

gcloud

  1. Erstellen Sie das Dienstkonto. Ersetzen Sie NAME mit einem Namen für das Dienstkonto.

    gcloud iam service-accounts create NAME
  2. Erteilen Sie dem Dienstkonto die Berechtigung reCAPTCHA Enterprise Agent (roles/recaptchaenterprise.agent). Ersetzen Sie die folgenden Werte:

    • PROJECT_ID: Ihre Google Cloud-Projekt-ID.
    • NAME: Der Name des Dienstkontos, für das die Berechtigung erteilt werden soll.
    gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role="roles/recaptchaenterprise.agent"
         
  3. Generieren Sie die Dienstkontoschlüsseldatei. Ersetzen Sie die folgenden Werte:

    • KEY_PATH: Der Pfad zu einer neuen Ausgabedatei für den privaten Schlüssel, z. B. /home/user/Downloads/service-account-file.json.
    • NAME: Der Name des Dienstkontos, für das ein Schlüssel erstellt werden soll.
    • PROJECT_ID: Ihre Google Cloud-Projekt-ID.
    gcloud iam service-accounts keys create KEY_PATH --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com

Dienstkonto für die Back-End-Authentifizierung konfigurieren

Die Konfiguration Ihres Dienstkontos für die Back-End-Authentifizierung in der Google Cloud-Umgebung hängt von den verwendeten Produkten ab, z. B. App Engine, Compute Engine und Google Kubernetes Engine (GKE).

App Engine

Bei App Engine können Sie das Dienstkonto mithilfe der reCAPTCHA Enterprise-Clientbibliotheken authentifizieren.

  1. Geben Sie die Anmeldedaten zur Authentifizierung für Ihren Anwendungscode durch Festlegung der Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS an. Diese Variable gilt nur für Ihre aktuelle Shellsitzung. Wenn Sie möchten, dass die Variable für zukünftige Shell-Sitzungen gilt, legen Sie die Variable in Ihrer Shell-Startdatei fest, z. B. in der Datei ~/.bashrc oder ~/.profile.

    Linux oder macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

    Beispiel:

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

    Windows

    Für PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

    Beispiel:

    $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

    Für Eingabeaufforderung:

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

  2. Installieren Sie die Clientbibliothek.

    C#

    Weitere Informationen finden Sie unter C#-Entwicklungsumgebung einrichten.
    Install-Package Google.Cloud.RecaptchaEnterprise.V1
    

    Go

    Weitere Informationen finden Sie unter Go-Entwicklungsumgebung einrichten.
    go get cloud.google.com/go/recaptchaenterprise/apiv1
    

    Java

    Weitere Informationen finden Sie unter Java-Entwicklungsumgebung einrichten.

    Wenn Sie Maven verwenden, fügen Sie Ihrer Datei pom.xml den folgenden Code hinzu. Weitere Informationen zu BOMs finden Sie unter The Google Cloud Platform Libraries BOM.

    <dependencyManagement>
      <dependencies>
        <dependency>
          <groupId>com.google.cloud</groupId>
          <artifactId>libraries-bom</artifactId>
          <version>24.0.0</version>
          <type>pom</type>
          <scope>import</scope>
        </dependency>
      </dependencies>
    </dependencyManagement>
    
    <dependencies>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>google-cloud-recaptchaenterprise</artifactId>
      </dependency>
    </dependencies>
    

    Wenn Sie Gradle verwenden, fügen Sie den Abhängigkeiten Folgendes hinzu:

    implementation platform('com.google.cloud:libraries-bom:24.0.0')
    
    implementation 'com.google.cloud:google-cloud-recaptchaenterprise'

    Wenn Sie sbt nutzen, fügen Sie den Abhängigkeiten Folgendes hinzu:

    libraryDependencies += "com.google.cloud" % "google-cloud-recaptchaenterprise" % "2.3.0"

    Wenn Sie Visual Studio Code, IntelliJ oder Eclipse verwenden, können Sie Ihrem Projekt mithilfe der folgenden IDE-Plug-ins Clientbibliotheken hinzufügen:

    Diese Plug-ins bieten zusätzliche Funktionen wie die Schlüsselverwaltung für Dienstkonten. Einzelheiten finden Sie in der Dokumentation der einzelnen Plug-ins.

    Node.js

    Weitere Informationen finden Sie unter Node.js-Entwicklungsumgebung einrichten.
    npm install --save @google-cloud/recaptcha-enterprise
    

    PHP

    Weitere Informationen finden Sie unter PHP auf Google Cloud verwenden. Fügen Sie die Bibliothek als Abhängigkeit in Ihre composer.json-Datei ein:
    composer require google/cloud-recaptcha-enterprise
    
    Alternativ können Sie das Paket lokal herunterladen.

    Python

    Weitere Informationen finden Sie unter Python-Entwicklungsumgebung einrichten.
    pip install --upgrade google-cloud-recaptcha-enterprise
    

    Ruby

    Weitere Informationen finden Sie unter Ruby-Entwicklungsumgebung einrichten.
    gem install google-cloud-recaptcha_enterprise
    

Das von Ihnen erstellte Dienstkonto ist jetzt für die Back-End-Authentifizierung bereit. Beim Erstellen einer Bewertung können Sie das Dienstkonto mithilfe der reCAPTCHA Enterprise-Clientbibliotheken authentifizieren.

Compute Engine

Sie können das neue Dienstkonto, das Sie für die Back-End-Authentifizierung erstellt haben, mithilfe von reCAPTCHA Enterprise-Clientbibliotheken oder dem gcloud-Befehlszeilentool konfigurieren.

reCAPTCHA Enterprise-Clientbibliotheken

  1. Geben Sie die Anmeldedaten zur Authentifizierung für Ihren Anwendungscode durch Festlegung der Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS an. Diese Variable gilt nur für Ihre aktuelle Shellsitzung. Wenn Sie möchten, dass die Variable für zukünftige Shell-Sitzungen gilt, legen Sie die Variable in Ihrer Shell-Startdatei fest, z. B. in der Datei ~/.bashrc oder ~/.profile.

    Linux oder macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

    Beispiel:

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

    Windows

    Für PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

    Beispiel:

    $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

    Für Eingabeaufforderung:

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

  2. Installieren Sie die Clientbibliothek.

    C#

    Weitere Informationen finden Sie unter C#-Entwicklungsumgebung einrichten.
    Install-Package Google.Cloud.RecaptchaEnterprise.V1
    

    Go

    Weitere Informationen finden Sie unter Go-Entwicklungsumgebung einrichten.
    go get cloud.google.com/go/recaptchaenterprise/apiv1
    

    Java

    Weitere Informationen finden Sie unter Java-Entwicklungsumgebung einrichten.

    Wenn Sie Maven verwenden, fügen Sie Ihrer Datei pom.xml den folgenden Code hinzu. Weitere Informationen zu BOMs finden Sie unter The Google Cloud Platform Libraries BOM.

    <dependencyManagement>
      <dependencies>
        <dependency>
          <groupId>com.google.cloud</groupId>
          <artifactId>libraries-bom</artifactId>
          <version>24.0.0</version>
          <type>pom</type>
          <scope>import</scope>
        </dependency>
      </dependencies>
    </dependencyManagement>
    
    <dependencies>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>google-cloud-recaptchaenterprise</artifactId>
      </dependency>
    </dependencies>
    

    Wenn Sie Gradle verwenden, fügen Sie den Abhängigkeiten Folgendes hinzu:

    implementation platform('com.google.cloud:libraries-bom:24.0.0')
    
    implementation 'com.google.cloud:google-cloud-recaptchaenterprise'

    Wenn Sie sbt nutzen, fügen Sie den Abhängigkeiten Folgendes hinzu:

    libraryDependencies += "com.google.cloud" % "google-cloud-recaptchaenterprise" % "2.3.0"

    Wenn Sie Visual Studio Code, IntelliJ oder Eclipse verwenden, können Sie Ihrem Projekt mithilfe der folgenden IDE-Plug-ins Clientbibliotheken hinzufügen:

    Diese Plug-ins bieten zusätzliche Funktionen wie die Schlüsselverwaltung für Dienstkonten. Einzelheiten finden Sie in der Dokumentation der einzelnen Plug-ins.

    Node.js

    Weitere Informationen finden Sie unter Node.js-Entwicklungsumgebung einrichten.
    npm install --save @google-cloud/recaptcha-enterprise
    

    PHP

    Weitere Informationen finden Sie unter PHP auf Google Cloud verwenden. Fügen Sie die Bibliothek als Abhängigkeit in Ihre composer.json-Datei ein:
    composer require google/cloud-recaptcha-enterprise
    
    Alternativ können Sie das Paket lokal herunterladen.

    Python

    Weitere Informationen finden Sie unter Python-Entwicklungsumgebung einrichten.
    pip install --upgrade google-cloud-recaptcha-enterprise
    

    Ruby

    Weitere Informationen finden Sie unter Ruby-Entwicklungsumgebung einrichten.
    gem install google-cloud-recaptcha_enterprise
    

Das von Ihnen erstellte Dienstkonto ist jetzt für die Back-End-Authentifizierung bereit. Beim Erstellen einer Bewertung können Sie das Dienstkonto mithilfe der reCAPTCHA Enterprise-Clientbibliotheken authentifizieren.

gcloud-Befehlszeile

  1. Installieren und initialisieren Sie das Cloud SDK.
  2. Geben Sie die Anmeldedaten zur Authentifizierung für Ihren Anwendungscode durch Festlegung der Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS an. Diese Variable gilt nur für Ihre aktuelle Shellsitzung. Wenn Sie möchten, dass die Variable für zukünftige Shell-Sitzungen gilt, legen Sie die Variable in Ihrer Shell-Startdatei fest, z. B. in der Datei ~/.bashrc oder ~/.profile.

    Linux oder macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

    Beispiel:

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

    Windows

    Für PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

    Beispiel:

    $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

    Für Eingabeaufforderung:

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Geben Sie für KEY_PATH den Dateipfad der JSON-Datei an, die Ihren Dienstkontoschlüssel enthält.

Das von Ihnen erstellte Dienstkonto ist jetzt für die Back-End-Authentifizierung bereit. Beim Erstellen einer Bewertung können Sie das Dienstkonto mit dem gcloud-Tool authentifizieren.

GKE

  1. Workload Identity mit einem Dienstkonto verwenden, um von Anwendungen in GKE auf Google Cloud-Dienste zuzugreifen.

    Weitere Informationen zum Erstellen von Dienstkonten finden Sie unter Dienstkonten für die Back-End-Authentifizierung erstellen.

  2. Mit Workload Identity bei Google Cloud authentifizieren

Nächste Schritte

  1. Entscheiden Sie, welche Art von reCAPTCHA-Schlüssel (Websiteschlüssel) verwendet werden soll, und erstellen Sie einen reCAPTCHA-Schlüssel.
  2. Installieren Sie punktebasierte oder Kästchen-Websiteschlüssel auf Webseiten.

    OR

    Integrieren Sie reCAPTCHA Enterprise in Android-Apps oder iOS-Apps.

  3. Bewertung erstellen.

  4. Interpretieren Sie eine Bewertung und führen Sie anhand der Punktzahl eine geeignete Aktion für Ihre Website aus.