Anfragen von Google Chat prüfen

In diesem Abschnitt wird beschrieben, wie Sie bei Google Chat-Apps, die auf HTTP-Endpunkten basieren, überprüfen können, ob die Anfragen an Ihren Endpunkt von Chat stammen.

Damit Interaktionsereignisse an den Endpunkt Ihrer Chat-App gesendet werden, stellt Google Anfragen an Ihren Dienst. Damit Sie überprüfen können, ob die Anfrage von Google stammt, enthält Chat in jedem Authorization-Header jeder HTTPS-Anfrage an Ihren Endpunkt ein Bearer-Token. Beispiel:

POST Host: yourappurl.com Authorization: Bearer AbCdEf123456 Content-Type: application/json User-Agent: Google-Dynamite

Der String AbCdEf123456 im vorherigen Beispiel ist das Bearer-Autorisierungstoken. Dies ist ein von Google erstelltes kryptografisches Token. Der Typ des Bearer-Tokens und der Wert des Felds audience hängen vom Typ der Authentifizierungszielgruppe ab, die Sie beim Konfigurieren der Chat-App ausgewählt haben.

Wenn Sie Ihre Chat-App mit Cloud Functions oder Cloud Run implementiert haben, übernimmt Cloud IAM die Tokenüberprüfung automatisch. Sie müssen das Google Chat-Dienstkonto nur als autorisierten Aufrufer hinzufügen. Wenn Ihre App einen eigenen HTTP-Server implementiert, können Sie Ihr Bearertoken mit einer Open-Source-Google API-Clientbibliothek überprüfen:

Wenn das Token für die Chat-App nicht bestätigt wird, sollte Ihr Dienst mit dem HTTPS-Antwortcode 401 (Unauthorized) auf die Anfrage antworten.

Anfragen mit Cloud Functions oder Cloud Run authentifizieren

Wenn Ihre Funktionslogik mit Cloud Functions oder Cloud Run implementiert wird, müssen Sie im Feld Authentication Audience (Authentifizierungszielgruppe) der Verbindungseinstellung der Chat-App die Option HTTP endpoint URL (HTTP-Endpunkt-URL) auswählen. Außerdem muss die HTTP-Endpunkt-URL in der Konfiguration mit der URL des Cloud Functions- oder Cloud Run-Endpunkts übereinstimmen.

Anschließend müssen Sie das Google Chat-Dienstkonto [email protected] als Aufrufer autorisieren.

In den folgenden Schritten wird gezeigt, wie Sie Cloud Functions (1. Generation) verwenden:

Console

Nachdem Sie Ihre Funktion in Google Cloud bereitgestellt haben:

  1. Wechseln Sie in der Google Cloud Console zur Seite Cloud Functions:

    Zu Cloud Functions

  2. Klicken Sie in der Cloud Functions-Liste auf das Kästchen neben der empfangenden Funktion. (Klicken Sie nicht auf die Funktion selbst.)

  3. Klicken Sie oben auf dem Bildschirm auf Berechtigungen. Der Bereich Berechtigungen wird geöffnet.

  4. Klicken Sie auf Hauptkonto hinzufügen.

  5. Geben Sie im Feld Neue Hauptkonten [email protected] ein.

  6. Wählen Sie im Drop-down-Menü Rolle auswählen die Rolle Cloud Functions > Cloud Functions-Aufrufer aus.

  7. Klicken Sie auf Speichern.

gcloud

Führen Sie den Befehl gcloud functions add-iam-policy-binding aus:

gcloud functions add-iam-policy-binding RECEIVING_FUNCTION \   --member='serviceAccount:[email protected]' \   --role='roles/cloudfunctions.invoker'

Ersetzen Sie RECEIVING_FUNCTION durch den Namen der Funktion Ihrer Chat-App.

In den folgenden Schritten wird beschrieben, wie Sie Cloud Functions (2. Generation) oder Cloud Run-Dienste verwenden:

Console

Nachdem Sie Ihre Funktion oder Ihren Dienst in Google Cloud bereitgestellt haben:

  1. Wechseln Sie in der Google Cloud Console zur Seite Cloud Run.

    Zu Cloud Run

  2. Klicken Sie in der Liste der Cloud Run-Dienste auf das Kästchen neben der empfangenden Funktion. (Klicken Sie nicht auf die Funktion selbst.)

  3. Klicken Sie oben auf dem Bildschirm auf Berechtigungen. Der Bereich Berechtigungen wird geöffnet.

  4. Klicken Sie auf Hauptkonto hinzufügen.

  5. Geben Sie im Feld Neue Hauptkonten [email protected] ein.

  6. Wählen Sie im Drop-down-Menü Rolle auswählen die Rolle Cloud Run > Cloud Run Invoker aus.

  7. Klicken Sie auf Speichern.

gcloud

Führen Sie den Befehl gcloud functions add-invoker-policy-binding aus:

gcloud functions add-invoker-policy-binding RECEIVING_FUNCTION \   --member='serviceAccount:[email protected]'

Ersetzen Sie RECEIVING_FUNCTION durch den Namen der Funktion Ihrer Chat-App.

HTTP-Anfragen mit einem ID-Token authentifizieren

Wenn das Feld „Authentifizierungszielgruppe“ der Verbindungseinstellung der Chat-App auf HTTP-Endpunkt-URL festgelegt ist, ist das Bearer-Autorisierungstoken in der Anfrage ein von Google signiertes OIDC-ID-Token (OpenID Connect). Das Feld email ist auf [email protected] gesetzt. Das Feld Authentifizierungszielgruppe ist auf die URL festgelegt, die Sie für Google Chat konfiguriert haben, um Anfragen an Ihre Chat-App zu senden. Wenn der konfigurierte Endpunkt Ihrer Chat-App beispielsweise https://example.com/app/ ist, lautet das Feld Authentifizierungszielgruppe im ID-Token https://example.com/app/.

Dies ist die empfohlene Authentifizierungsmethode, wenn Ihr HTTP-Endpunkt nicht auf einem Dienst gehostet wird, der IAM-basierte Authentifizierung unterstützt (z. B. Cloud Functions oder Cloud Run). Bei dieser Methode benötigt Ihr HTTP-Dienst Informationen zur URL des Endpunkts, an dem er ausgeführt wird, aber keine Informationen zur Cloud-Projektnummer.

In den folgenden Beispielen wird gezeigt, wie Sie mit der Google OAuth-Clientbibliothek überprüfen, ob das Bearertoken von Google Chat ausgestellt wurde und für Ihre App bestimmt ist.

Java

java/basic-app/src/main/java/com/google/chat/app/basic/App.java
String CHAT_ISSUER = "[email protected]"; JsonFactory factory = JacksonFactory.getDefaultInstance();  GoogleIdTokenVerifier verifier =     new GoogleIdTokenVerifier.Builder(new ApacheHttpTransport(), factory)         .setAudience(Collections.singletonList(AUDIENCE))         .build();  GoogleIdToken idToken = GoogleIdToken.parse(factory, bearer); return idToken != null     && verifier.verify(idToken)     && idToken.getPayload().getEmailVerified()     && idToken.getPayload().getEmail().equals(CHAT_ISSUER);

Python

python/basic-app/main.py
# Bearer Tokens received by apps will always specify this issuer. CHAT_ISSUER = '[email protected]'  try:     # Verify valid token, signed by CHAT_ISSUER, intended for a third party.     request = requests.Request()     token = id_token.verify_oauth2_token(bearer, request, AUDIENCE)     return token['email'] == CHAT_ISSUER  except:     return False

Node.js

node/basic-app/index.js
// Bearer Tokens received by apps will always specify this issuer. const chatIssuer = '[email protected]';  // Verify valid token, signed by chatIssuer, intended for a third party. try {   const ticket = await client.verifyIdToken({     idToken: bearer,     audience: audience   });   return ticket.getPayload().email_verified       && ticket.getPayload().email === chatIssuer; } catch (unused) {   return false; }

Anfragen mit einem JWT für die Projektnummer authentifizieren

Wenn das Feld „Authentication Audience“ (Authentifizierungszielgruppe) der Verbindungseinstellung der Chat-App auf Project Number festgelegt ist, ist das Bearer-Autorisierungstoken in der Anfrage ein selbstsigniertes JSON Web Token (JWT), das von [email protected] ausgestellt und signiert wurde. Das Feld audience ist auf die Google Cloud-Projektnummer festgelegt, die Sie zum Erstellen Ihrer Chat-App verwendet haben. Wenn die Cloud-Projektnummer Ihrer Chat-App beispielsweise 1234567890 ist, ist das Feld audience im JWT 1234567890.

Diese Authentifizierungsmethode wird nur empfohlen, wenn Sie die Cloud-Projektnummer anstelle der HTTP-Endpunkt-URL verwenden möchten, um Anfragen zu bestätigen. Das ist z. B. nützlich, wenn Sie die Endpunkt-URL im Laufe der Zeit ändern möchten, aber dieselbe Cloud-Projektnummer beibehalten möchten, oder wenn Sie denselben Endpunkt für mehrere Cloud-Projektnummern verwenden und das Feld audience mit einer Liste von Cloud-Projektnummern vergleichen möchten.

Die folgenden Beispiele zeigen, wie Sie mit der Google OAuth-Clientbibliothek überprüfen, ob das Bearertoken von Google Chat ausgestellt und auf Ihr Projekt ausgerichtet wurde.

Java

java/basic-app/src/main/java/com/google/chat/app/basic/App.java
String CHAT_ISSUER = "[email protected]"; JsonFactory factory = JacksonFactory.getDefaultInstance();  GooglePublicKeysManager keyManagerBuilder =     new GooglePublicKeysManager.Builder(new ApacheHttpTransport(), factory)         .setPublicCertsEncodedUrl(             "https://www.googleapis.com/service_accounts/v1/metadata/x509/" + CHAT_ISSUER)         .build();  GoogleIdTokenVerifier verifier =     new GoogleIdTokenVerifier.Builder(keyManagerBuilder).setIssuer(CHAT_ISSUER).build();  GoogleIdToken idToken = GoogleIdToken.parse(factory, bearer); return idToken != null     && verifier.verify(idToken)     && idToken.verifyAudience(Collections.singletonList(AUDIENCE))     && idToken.verifyIssuer(CHAT_ISSUER);

Python

python/basic-app/main.py
# Bearer Tokens received by apps will always specify this issuer. CHAT_ISSUER = '[email protected]'  try:     # Verify valid token, signed by CHAT_ISSUER, intended for a third party.     request = requests.Request()     certs_url = 'https://www.googleapis.com/service_accounts/v1/metadata/x509/' + CHAT_ISSUER     token = id_token.verify_token(bearer, request, AUDIENCE, certs_url)     return token['iss'] == CHAT_ISSUER  except:     return False

Node.js

node/basic-app/index.js
// Bearer Tokens received by apps will always specify this issuer. const chatIssuer = '[email protected]';  // Verify valid token, signed by CHAT_ISSUER, intended for a third party. try {   const response = await fetch('https://www.googleapis.com/service_accounts/v1/metadata/x509/' + chatIssuer);   const certs = await response.json();   await client.verifySignedJwtWithCertsAsync(     bearer, certs, audience, [chatIssuer]);   return true; } catch (unused) {   return false; }