Autenticazione service-to-service

Se la tua architettura utilizza più servizi, è probabile che questi servizi debbano comunicare tra loro, utilizzando mezzi asincroni o sincroni. Molti di questi servizi potrebbero essere privati e pertanto richiedono credenziali per l'accesso.

Nota: non sono previsti addebiti di networking per il traffico tra servizi nella stessa regione.

Per la comunicazione asincrona, puoi utilizzare i seguenti servizi Google Cloud:

• Cloud Tasks per una comunicazione asincrona individuale
• Pub/Sub per la comunicazione asincrona da uno a uno, uno a uno e da molti a uno
• Cloud Scheduler per una comunicazione asincrona pianificata regolarmente
• Eventarc per la comunicazione basata sugli eventi

In tutti questi casi, il servizio utilizzato gestisce l'interazione con il servizio ricevente, in base alla configurazione che hai impostato.

Tuttavia, per la comunicazione sincrona, il servizio chiama un altro servizio direttamente, tramite HTTP, utilizzando il relativo URL dell'endpoint. Per questo caso d'uso, devi assicurarti che ogni servizio sia in grado di effettuare richieste solo a servizi specifici. Ad esempio, se hai un servizio login, questo dovrebbe essere in grado di accedere al servizio user-profiles, ma non al servizio search.

In questo caso, Google consiglia di utilizzare IAM e un'identità di servizio basata su un account di servizio gestito dall'utente per servizio a cui è stato concesso l'insieme minimo di autorizzazioni necessarie per svolgere il proprio lavoro.

Inoltre, la richiesta deve presentare una prova dell'identità del servizio chiamante. A questo scopo, configura il servizio di chiamata in modo da aggiungere un token ID OpenID Connect firmato da Google come parte della richiesta.

Configura l'account di servizio

Nota: se non hai un account di servizio che vuoi utilizzare, puoi crearne uno nuovo.

Per impostare un account di servizio, configura il servizio ricevente in modo che accetti le richieste del servizio di chiamata rendendo l'account di servizio del servizio di chiamata come entità del servizio ricevente. Quindi concederai a quell'account di servizio il ruolo Invoker di Cloud Run (roles/run.invoker). Per eseguire entrambe le operazioni, segui le istruzioni nella scheda appropriata:

Interfaccia utente della console

1. Vai alla console Google Cloud:

   Vai alla console Google Cloud

2. Seleziona il servizio di ricezione.

3. Fai clic su Mostra riquadro informazioni nell'angolo in alto a destra per visualizzare la scheda Autorizzazioni.

4. Fai clic su Aggiungi entità.

   1. Inserisci l'identità del servizio chiamante. In genere si tratta di un indirizzo email, per impostazione predefinita [e-mail].

   2. Seleziona il ruolo Cloud Run Invoker dal menu a discesa Seleziona un ruolo.

   3. Fai clic su Salva.

gcloud

Usa il comando gcloud run services add-iam-policy-binding:

gcloud run services add-iam-policy-binding RECEIVING_SERVICE \
  --member='serviceAccount:CALLING_SERVICE_IDENTITY' \
  --role='roles/run.invoker'

dove RECEIVING_SERVICE è il nome del servizio ricevente e CALLING_SERVICE_IDENTITY è l'indirizzo email dell'account di servizio, per impostazione predefinita [e-mail].

Terraform

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.

Il seguente codice Terraform crea un servizio Cloud Run iniziale che deve essere pubblico.

resource "google_cloud_run_v2_service" "public" {
  name     = "public-service"
  location = "us-central1"

  template {
    containers {
      # TODO<developer>: replace this with a public service container
      # (This service can be invoked by anyone on the internet)
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      # Include a reference to the private Cloud Run
      # service's URL as an environment variable.
      env {
        name  = "URL"
        value = google_cloud_run_v2_service.private.uri
      }
    }
    # Give the "public" Cloud Run service
    # a service account's identity
    service_account = google_service_account.default.email
  }
}

Sostituisci us-docker.pkg.dev/cloudrun/container/hello con un riferimento all'immagine container.

Il seguente codice Terraform rende pubblico il servizio iniziale.

data "google_iam_policy" "public" {
  binding {
    role = "roles/run.invoker"
    members = [
      "allUsers",
    ]
  }
}

resource "google_cloud_run_service_iam_policy" "public" {
  location = google_cloud_run_v2_service.public.location
  project  = google_cloud_run_v2_service.public.project
  service  = google_cloud_run_v2_service.public.name

  policy_data = data.google_iam_policy.public.policy_data
}

Il seguente codice Terraform crea un secondo servizio Cloud Run destinato a essere privato.

resource "google_cloud_run_v2_service" "private" {
  name     = "private-service"
  location = "us-central1"

  template {
    containers {
      // TODO<developer>: replace this with a private service container
      // (This service should only be invocable by the public service)
      image = "us-docker.pkg.dev/cloudrun/container/hello"
    }
  }
}

Sostituisci us-docker.pkg.dev/cloudrun/container/hello con un riferimento all'immagine container.

Il seguente codice Terraform rende privato il secondo servizio.

data "google_iam_policy" "private" {
  binding {
    role = "roles/run.invoker"
    members = [
      "serviceAccount:${google_service_account.default.email}",
    ]
  }
}

resource "google_cloud_run_service_iam_policy" "private" {
  location = google_cloud_run_v2_service.private.location
  project  = google_cloud_run_v2_service.private.project
  service  = google_cloud_run_v2_service.private.name

  policy_data = data.google_iam_policy.private.policy_data
}

Il seguente codice Terraform crea un account di servizio.

resource "google_service_account" "default" {
  account_id   = "cloud-run-interservice-id"
  description  = "Identity used by a public Cloud Run service to call private Cloud Run services."
  display_name = "cloud-run-interservice-id"
}

Il seguente codice Terraform consente ai servizi collegati all'account di servizio di richiamare il servizio Cloud Run privato iniziale.

data "google_iam_policy" "private" {
  binding {
    role = "roles/run.invoker"
    members = [
      "serviceAccount:${google_service_account.default.email}",
    ]
  }
}

resource "google_cloud_run_service_iam_policy" "private" {
  location = google_cloud_run_v2_service.private.location
  project  = google_cloud_run_v2_service.private.project
  service  = google_cloud_run_v2_service.private.name

  policy_data = data.google_iam_policy.private.policy_data
}

Acquisisci e configura il token ID

Dopo aver concesso il ruolo corretto all'account di servizio per le chiamate, segui questi passaggi:

1. Recupera un token ID firmato da Google utilizzando uno dei metodi descritti nella sezione seguente. Imposta la rivendicazione del segmento di pubblico (aud) sull'URL del servizio ricevente o su un segmento di pubblico personalizzato configurato. Se non utilizzi un segmento di pubblico personalizzato, il valore aud deve rimanere come URL del servizio, anche quando vengono effettuate richieste a un tag di traffico specifico.

   Nota: i domini personalizzati non sono attualmente supportati per il valore aud.

2. Aggiungi il token ID che hai recuperato dal passaggio precedente a una delle seguenti intestazioni della richiesta al servizio di destinazione:

   • Un'intestazione Authorization: Bearer ID_TOKEN.
   • Un'intestazione X-Serverless-Authorization: Bearer ID_TOKEN. Puoi utilizzare questa intestazione se la tua applicazione utilizza già l'intestazione Authorization per l'autorizzazione personalizzata. In questo modo viene rimossa la firma prima di trasmettere il token al container dell'utente.
   Nota: se fornisci entrambe le intestazioni, viene selezionata solo l'intestazione X-Serverless-Authorization.

Per altri modi per ottenere un token ID non descritti in questa pagina, consulta la sezione Metodi per ottenere un token ID.

Utilizzare le librerie di autenticazione

Il modo più semplice e affidabile per gestire questo processo è utilizzare le librerie di autenticazione, come mostrato di seguito, per generare e utilizzare questo token. Questo codice funziona in qualsiasi ambiente, anche all'esterno di Google Cloud, in cui le librerie possono ottenere le credenziali di autenticazione per un account di servizio, inclusi gli ambienti che supportano credenziali predefinite dell'applicazione locali. Tuttavia, il codice non funziona per ottenere le credenziali di autenticazione per un account utente.

Node.js

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// Example: https://my-cloud-run-service.run.app/books/delete/12345
// const url = 'https://TARGET_HOSTNAME/TARGET_URL';

// Example (Cloud Run): https://my-cloud-run-service.run.app/
// const targetAudience = 'https://TARGET_AUDIENCE/';

const {GoogleAuth} = require('google-auth-library');
const auth = new GoogleAuth();

async function request() {
  console.info(`request ${url} with target audience ${targetAudience}`);
  const client = await auth.getIdTokenClient(targetAudience);

  // Alternatively, one can use `client.idTokenProvider.fetchIdToken`
  // to return the ID Token.
  const res = await client.request({url});
  console.info(res.data);
}

request().catch(err => {
  console.error(err.message);
  process.exitCode = 1;
});

Python

import urllib

import google.auth.transport.requests
import google.oauth2.id_token

def make_authorized_get_request(endpoint, audience):
    """
    make_authorized_get_request makes a GET request to the specified HTTP endpoint
    by authenticating with the ID token obtained from the google-auth client library
    using the specified audience value.
    """

    # Cloud Run uses your service's hostname as the `audience` value
    # audience = 'https://my-cloud-run-service.run.app/'
    # For Cloud Run, `endpoint` is the URL (hostname + path) receiving the request
    # endpoint = 'https://my-cloud-run-service.run.app/my/awesome/url'

    req = urllib.request.Request(endpoint)

    auth_req = google.auth.transport.requests.Request()
    id_token = google.oauth2.id_token.fetch_id_token(auth_req, audience)

    req.add_header("Authorization", f"Bearer {id_token}")
    response = urllib.request.urlopen(req)

    return response.read()

Go

import (
	"context"
	"fmt"
	"io"

	"google.golang.org/api/idtoken"
)

// `makeGetRequest` makes a request to the provided `targetURL`
// with an authenticated client using audience `audience`.
func makeGetRequest(w io.Writer, targetURL string, audience string) error {
	// Example `audience` value (Cloud Run): https://my-cloud-run-service.run.app/
	// (`targetURL` and `audience` will differ for non-root URLs and GET parameters)
	ctx := context.Background()

	// client is a http.Client that automatically adds an "Authorization" header
	// to any requests made.
	client, err := idtoken.NewClient(ctx, audience)
	if err != nil {
		return fmt.Errorf("idtoken.NewClient: %w", err)
	}

	resp, err := client.Get(targetURL)
	if err != nil {
		return fmt.Errorf("client.Get: %w", err)
	}
	defer resp.Body.Close()
	if _, err := io.Copy(w, resp.Body); err != nil {
		return fmt.Errorf("io.Copy: %w", err)
	}

	return nil
}

Java

import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.auth.oauth2.IdTokenCredentials;
import com.google.auth.oauth2.IdTokenProvider;
import java.io.IOException;

public class Authentication {

  // makeGetRequest makes a GET request to the specified Cloud Run or
  // Cloud Functions endpoint `serviceUrl` (must be a complete URL), by
  // authenticating with an ID token retrieved from Application Default
  // Credentials using the specified `audience`.
  //
  // Example `audience` value (Cloud Run): https://my-cloud-run-service.run.app/
  public static HttpResponse makeGetRequest(String serviceUrl, String audience) throws IOException {
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault();
    if (!(credentials instanceof IdTokenProvider)) {
      throw new IllegalArgumentException("Credentials are not an instance of IdTokenProvider.");
    }
    IdTokenCredentials tokenCredential =
        IdTokenCredentials.newBuilder()
            .setIdTokenProvider((IdTokenProvider) credentials)
            .setTargetAudience(audience)
            .build();

    GenericUrl genericUrl = new GenericUrl(serviceUrl);
    HttpCredentialsAdapter adapter = new HttpCredentialsAdapter(tokenCredential);
    HttpTransport transport = new NetHttpTransport();
    HttpRequest request = transport.createRequestFactory(adapter).buildGetRequest(genericUrl);
    return request.execute();
  }
}

Utilizzare il server dei metadati

Se per qualche motivo non puoi utilizzare le librerie di autenticazione, puoi recuperare un token ID dal server di metadati Compute mentre il container è in esecuzione su Cloud Run. Tieni presente che questo metodo non funziona al di fuori di Google Cloud, nemmeno dalla tua macchina locale.

curl "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity?audience=[AUDIENCE]" \
     -H "Metadata-Flavor: Google"

Dove PUBBLICO è l'URL del servizio che stai richiamando o di un segmento di pubblico personalizzato configurato.

La seguente tabella riassume le parti principali di una richiesta di query sui metadati:

Componenti	Descrizione
URL principale	Tutti i valori dei metadati sono definiti come percorsi secondari al di sotto del seguente URL principale: http://metadata.google.internal/computeMetadata/v1
Intestazione della richiesta	In ogni richiesta deve essere presente la seguente intestazione: Metadata-Flavor: Google Questa intestazione indica che la richiesta è stata inviata con l'intento di recuperare i valori dei metadati, anziché involontariamente da un'origine non sicura, e consente al server dei metadati di restituire i dati richiesti. Se non fornisci questa intestazione, il server dei metadati rifiuta la tua richiesta. Nota: in precedenza, l'intestazione X-Google-Metadata-Request: True era obbligatoria nelle richieste. Entrambe queste intestazioni sono ancora supportate, ma ti consigliamo di utilizzare l'intestazione Metadata-Flavor anziché l'intestazione X-Google-Metadata-Request: True.

Nota: i token ID sono JWT (JSON Web Token) che scadono circa un'ora dopo la creazione. Se recuperi i token dal server di metadati, riceverai sempre un token valido. Se scegli di memorizzare i token nella cache, puoi decodificarli e controllare il tempo exp per vedere se è necessario aggiornarlo.

Per una procedura dettagliata end-to-end di un'applicazione che utilizza questa tecnica di autenticazione service-to-service, segui il tutorial per la protezione dei servizi Cloud Run.

Utilizza la federazione delle identità per i carichi di lavoro dall'esterno di Google Cloud

Se il tuo ambiente utilizza un provider di identità supportato dalla federazione delle identità per i carichi di lavoro, puoi utilizzare il seguente metodo per eseguire l'autenticazione in modo sicuro al servizio Cloud Run dall'esterno di Google Cloud:

1. Configura l'account di servizio come descritto in Configurare l'account di servizio in questa pagina.

2. Configura la federazione delle identità per i carichi di lavoro per il tuo provider di identità come descritto in Configurazione della federazione delle identità per i carichi di lavoro.

3. Segui le istruzioni in Concessione dell'autorizzazione per identità esterne per impersonare un account di servizio.

4. Utilizza l'API REST per acquisire un token di breve durata, ma invece di chiamare generateAccessToken per ottenere un token di accesso, chiama generateIdToken per ottenere un token ID.

   Ad esempio, utilizzando cURL:

   ID_TOKEN=$(curl -0 -X POST https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/SERVICE_ACCOUNT:generateIdToken \
     -H "Content-Type: text/json; charset=utf-8" \
     -H "Authorization: Bearer $STS_TOKEN" \
     -d @- <<EOF | jq -r .token
     {
         "audience": "SERVICE_URL"
     }
   EOF
   )
   echo $ID_TOKEN
   

   Dove SERVICE_ACCOUNT è l'indirizzo email dell'account di servizio a cui è configurato il pool di identità per i carichi di lavoro e SERVICE_URL è l'URL del servizio Cloud Run che stai richiamando. Questo valore deve rimanere come URL del servizio, anche quando si effettuano richieste a un tag di traffico specifico. $STS_TOKEN è il token del servizio token di sicurezza che hai ricevuto nel passaggio precedente nelle istruzioni della federazione delle identità per i carichi di lavoro.

Puoi includere nella richiesta al servizio il token ID del passaggio precedente utilizzando un'intestazione Authorization: Bearer ID_TOKEN o X-Serverless-Authorization: Bearer ID_TOKEN. Se vengono fornite entrambe le intestazioni, viene selezionata solo l'intestazione X-Serverless-Authorization.

Usa una chiave dell'account di servizio scaricata dall'esterno di Google Cloud

Se la federazione delle identità per i carichi di lavoro non è appropriata per il tuo ambiente, puoi utilizzare una chiave dell'account di servizio scaricata per eseguire l'autenticazione dall'esterno di Google Cloud. Aggiorna il codice client per utilizzare le librerie di autenticazione come descritto in precedenza con Credenziali predefinite dell'applicazione.

Puoi acquisire un token ID firmato da Google utilizzando un JWT autofirmato, ma è piuttosto complicato e potenzialmente soggetto a errori. I passaggi di base sono i seguenti:

1. Firma autonomamente un JWT dell'account di servizio con la rivendicazione target_audience impostata sull'URL del servizio ricevente o su un segmento di pubblico personalizzato configurato. Se non utilizzi domini personalizzati, il valore target_audience deve rimanere l'URL del servizio, anche quando si effettuano richieste a un tag di traffico specifico.

2. Scambia il JWT autofirmato con un token ID firmato da Google, che deve avere la rivendicazione aud impostata sull'URL precedente.

3. Includi il token ID nella richiesta al servizio utilizzando un'intestazione Authorization: Bearer ID_TOKEN o X-Serverless-Authorization: Bearer ID_TOKEN. Se vengono fornite entrambe le intestazioni, viene selezionata solo l'intestazione X-Serverless-Authorization.

Puoi esaminare questo esempio di Cloud Functions per avere un esempio dei passaggi precedenti.

Ricevi richieste autenticate

All'interno del servizio privato di ricezione, puoi analizzare l'intestazione di autorizzazione per ricevere le informazioni inviate dal token di connessione.

Python

from google.auth.transport import requests
from google.oauth2 import id_token

def receive_authorized_get_request(request):
    """Parse the authorization header and decode the information
    being sent by the Bearer token.

    Args:
        request: Flask request object

    Returns:
        The email from the request's Authorization header.
    """
    auth_header = request.headers.get("Authorization")
    if auth_header:
        # split the auth type and value from the header.
        auth_type, creds = auth_header.split(" ", 1)

        if auth_type.lower() == "bearer":
            claims = id_token.verify_token(creds, requests.Request())
            return f"Hello, {claims['email']}!\n"

        else:
            return f"Unhandled header format ({auth_type}).\n"
    return "Hello, anonymous user.\n"