Migrazione all'API Service Account Credentials

L'API Service Account Credentials crea credenziali di breve durata per gli account di servizio Identity and Access Management (IAM). Puoi utilizzare questa API anche per firmare token web JSON (JWT), oltre a blob di dati binari che contengono altri tipi di token.

L'API IAM contiene anche metodi per la firma di JWT e blob binari. A partire dal 1° luglio 2020, questi metodi sono deprecati nell'API REST e in tutte le librerie client per l'API IAM. Inoltre, se utilizzi l'interfaccia a riga di comando di Google Cloud per firmare i JWT, potresti dover aggiungere una nuova rivendicazione al set di reclami JWT. I metodi deprecati sono ancora supportati, ma ti invitiamo a eseguire la migrazione all'API Service Credentials.

Rispetto all'API IAM, l'API Service Account Credentials offre maggiore flessibilità per la data di scadenza dei JWT firmati. Inoltre, l'API Service Account Credentials aggiunge diversi nuovi metodi API per generare token di rappresentazione.

Questa pagina spiega come aggiornare il codice esistente per utilizzare l'API Service Account Credentials. Se hai feedback in merito a questa modifica, puoi compilare il modulo di feedback. Puoi anche utilizzare l'indirizzo email iam-sign-deprecation-public@google.com per richiedere assistenza e fornire un feedback dettagliato.

Prima di iniziare

  • Attiva Service Account Credentials API.

    Abilita l'API

Attivazione degli audit log in corso...

Se vuoi ricevere audit log per la richiesta di firma JWT e blob, devi attivare i log di controllo di accesso ai dati per l'API IAM. L'abilitazione degli audit log per l'accesso ai dati per l'API IAM comporta anche l'attivazione di questi audit log per l'API Service Account Credentials.

Esistono alcune differenze significative tra le voci di log generate da ogni API:

Differenze per le voci del log di controllo
Nome metodo

API IAM

Il nome del metodo (protoPayload.methodName) è uno dei seguenti:

  • google.iam.admin.v1.SignBlob
  • google.iam.admin.v1.SignJwt

API Service Account Credentials

Il nome del metodo è uno dei seguenti:

  • SignBlob
  • SignJwt
Tipo di richiesta

API IAM

Il tipo di richiesta (protoPayload.request.@type) è uno dei seguenti:

  • type.googleapis.com/google.iam.admin.v1.SignBlobRequest
  • type.googleapis.com/google.iam.admin.v1.SignJwtRequest

API Service Account Credentials

Il tipo di richiesta è uno dei seguenti:

  • type.googleapis.com/google.iam.credentials.v1.SignBlobRequest
  • type.googleapis.com/google.iam.credentials.v1.SignJwtRequest
Nome servizio

API IAM

Il nome del servizio (protoPayload.serviceName) è iam.googleapis.com.

API Service Account Credentials

Il nome del servizio è iamcredentials.googleapis.com.

Gli audit log di accesso ai dati vengono conteggiati per l'allocazione mensile gratuita dell'importazione dei dati di logging. Se superi questa quota, l'importazione dei log ti verrà addebitata. Per maggiori dettagli, consulta la pagina Prezzi della suite operativa di Google Cloud.

Migrazione del codice per la firma di JWT

Questa sezione descrive come eseguire la migrazione del codice che firma i JWT nell'API Service Credentials.

Firma dei JWT con l'API REST

La tabella seguente mostra le differenze tra la firma di un JWT con l'API IAM IAM e la firma di un JWT con l'API Service Account Credentials. Aggiorna il codice per riflettere queste differenze:

Differenze relative alla firma di un JWT
Endpoint HTTP

API IAM

L'API IAM utilizza i seguenti metodi e endpoint HTTP:

  • POST https://iam.googleapis.com/v1/projects/project-id/serviceAccounts/sa-email:signJwt

    In questo URL, project-id è l'ID progetto, mentre sa-email è l'indirizzo email dell'account di servizio.

  • POST https://iam.googleapis.com/v1/projects/-/serviceAccounts/sa-email:signJwt

    In questo URL, il carattere jolly - occupa il posto dell'ID progetto, mentre sa-email è l'indirizzo email dell'account di servizio.

API Service Account Credentials

Utilizza il metodo e l'endpoint HTTP riportati di seguito. Non sostituire il carattere jolly con l'ID progetto:

POST https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/sa-email:signJwt

In questo URL, sa-email è l'indirizzo email dell'account di servizio.

Corpo della richiesta

API IAM

Il corpo della richiesta include un campo payload. Il suo valore è il payload JWT da firmare. Il payload deve essere un oggetto JSON, serializzato come stringa, che contiene un set di attestazioni JWT.

Se fornisci un reclamo per data di scadenza (exp), la data successiva non dovrà superare le 12 ore. Se ometti la rivendicazione exp, questa viene aggiunta automaticamente e viene impostata su 1 ora nel futuro.

API Service Account Credentials

Il corpo della richiesta include un campo payload identico all'API IAM, ad eccezione del comportamento della dichiarazione della data di scadenza (exp):

  • Se fornisci il reclamo exp, non devono trascorrere più di 12 ore nel futuro.
  • Se ometti la rivendicazione exp, non viene aggiunta automaticamente. Devi fornire questa dichiarazione se utilizzi il JWT firmato per autenticarti con le API di Google o con un'altra API che richiede la rivendicazione exp.
Corpo della risposta

Entrambe le API utilizzano gli stessi campi nel corpo della risposta.

Firmare i JWT con una libreria client

Le librerie client per l'API Service Account Credentials sono separate da quelle per l'API IAM.

Per utilizzare l'API Service Account Credentials, aggiungi la relativa libreria client all'applicazione e aggiorna il codice in modo che utilizzi la nuova libreria client:

C#

Aggiungi la libreria client delle credenziali dell'account di servizio per C# all'applicazione. Utilizza il metodo SignJwt() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per C#, puoi rimuoverla dalla tua applicazione.

Go

Aggiungi la libreria client delle credenziali dell'account di servizio per Go all'applicazione. Utilizza IamCredentialsClient.SignJwt() function per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per Go, puoi rimuoverla dall'applicazione.

Java

Aggiungi la libreria client delle credenziali dell'account di servizio per Java all'applicazione. Utilizza il metodo IamCredentialsClient#signJwt() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per Java, puoi rimuoverla dall'applicazione.

Node.js

Aggiungi la libreria client delle credenziali dell'account di servizio per Node.js all'applicazione. Utilizza il metodo signJwt() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per Node.js, puoi rimuoverla dall'applicazione.

PHP

Aggiungi la libreria client delle credenziali dell'account di servizio per PHP all'applicazione. Utilizza il metodo signJwt() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido:nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per PHP, puoi rimuoverla dall'applicazione.

Python

Aggiungi la libreria client delle credenziali dell'account di servizio per Python all'applicazione. Utilizza il metodo sign_jwt() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido:nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di google-cloud-iam, puoi rimuoverla dalla tua applicazione.

Ruby

Aggiungi la libreria client delle credenziali dell'account di servizio per Ruby all'applicazione. Utilizza il metodo sign_service_account_jwt() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido:nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per Ruby, puoi rimuoverla dall'applicazione.

Migrazione del codice per la firma di blob binari

Questa sezione descrive come eseguire la migrazione del codice che firma i blob binari nell'API Service Account Credentials.

Firma blob binari con l'API REST

La tabella seguente mostra le differenze tra la firma di un blob binario con l'API IAM IAM e la firma di un blob binario con l'API Service Account Credentials. Aggiorna il codice in modo che rifletta queste differenze:

Differenze per la firma di un blob binario
Endpoint HTTP

API IAM

L'API IAM utilizza i seguenti metodi e endpoint HTTP:

  • POST https://iam.googleapis.com/v1/projects/project-id/serviceAccounts/sa-email:signBlob

    In questo URL, project-id è l'ID progetto, mentre sa-email è l'indirizzo email dell'account di servizio.

  • POST https://iam.googleapis.com/v1/projects/-/serviceAccounts/sa-email:signBlob

    In questo URL, il carattere jolly - occupa il posto dell'ID progetto, mentre sa-email è l'indirizzo email dell'account di servizio.

API Service Account Credentials

Utilizza il metodo e l'endpoint HTTP riportati di seguito. Non sostituire il carattere jolly con l'ID progetto:

POST https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/sa-email:signBlob

In questo URL, sa-email è l'indirizzo email dell'account di servizio.

Corpo della richiesta

API IAM

Il corpo della richiesta include un campo bytesToSign. Il suo valore è una stringa con codifica base64 che rappresenta il blob binario da firmare.

API Service Account Credentials

Il corpo della richiesta include un campo payload che ha lo stesso valore del campo bytesToSign nell'API IAM.

Corpo della risposta

API IAM

Il corpo della risposta contiene un campo keyId, che identifica la chiave utilizzata per firmare il blob, e un campo signature, che contiene una stringa con codifica base64 che rappresenta la firma.

API Service Account Credentials

Il corpo della risposta contiene un campo keyId identico al campo keyId nell'API IAM, nonché un campo signedBlob che è identico al campo signature nell'API IAM.

Firma blob binari con una libreria client

Le librerie client per l'API Service Account Credentials sono separate da quelle per l'API IAM.

Per utilizzare l'API Service Account Credentials, aggiungi la relativa libreria client all'applicazione e aggiorna il codice in modo che utilizzi la nuova libreria client:

C++

Se utilizzi la libreria client C++ di Cloud Storage per firmare i blob,direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 0.9.0 o successiva di google-cloud-cpp.

Se utilizzi un'altra libreria client per firmare i blob:

Contatta iam-sign-deprecation-public@google.com per ricevere assistenza.

C#

Se utilizzi la libreria client IAM per C#, direttamente o come dipendenza di un'altra libreria client:

Aggiungi la libreria client delle credenziali dell'account di servizio per C# all'applicazione. Utilizza il metodo SignBlob() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per C#, puoi rimuoverla dalla tua applicazione.

Se utilizzi l'SDK Firebase Admin DotNet, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 1.17.1 o successive di firebase-admin-dotnet.

Se utilizzi un'altra libreria client per firmare i blob:

Contatta iam-sign-deprecation-public@google.com per ricevere assistenza.

Go

Se utilizzi la libreria client di IAM per Go, direttamente o come dipendenza di un'altra libreria client:

Aggiungi la libreria client delle credenziali dell'account di servizio per Go all'applicazione. Utilizza IamCredentialsClient.SignBlob() function per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per Go, puoi rimuoverla dall'applicazione.

Se utilizzi l'SDK Firebase Admin Go, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 4.1.0 o successive di firebase-admin-go.

Se utilizzi un'altra libreria client per firmare i blob:

Contatta iam-sign-deprecation-public@google.com per ricevere assistenza.

Java

Se utilizzi la libreria client IAM per Java, direttamente o come dipendenza di un'altra libreria client:

Aggiungi la libreria client delle credenziali dell'account di servizio per Java all'applicazione. Utilizza il metodo IamCredentialsClient#signBlob() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per Java, puoi rimuoverla dall'applicazione.

Se utilizzi la libreria di autenticazione Google per Java, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 0.14.0 o successiva di google-auth-library-java.

Se utilizzi l'SDK Java Admin di Firebase, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 7.0.1 o successive di firebase-admin-java.

Se utilizzi un'altra libreria client per firmare i blob:

Contatta iam-sign-deprecation-public@google.com per ricevere assistenza.

Node.js

Se utilizzi la libreria client IAM per Node.js, direttamente o come dipendenza di un'altra libreria client:

Aggiungi la libreria client delle credenziali dell'account di servizio per Node.js all'applicazione. Utilizza il metodo signBlob() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido:nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per Node.js, puoi rimuoverla dall'applicazione.

Se utilizzi la libreria di autenticazione Google per Node.js, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 6.0.0 o successiva di google-auth-library-nodejs.

Se utilizzi l'SDK Node.js di amministrazione Firebase, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 8.13.0 o successive di firebase-admin-node.

Se utilizzi un'altra libreria client per firmare i blob:

Contatta iam-sign-deprecation-public@google.com per ricevere assistenza.

PHP

Se utilizzi la libreria client IAM per PHP, direttamente o come dipendenza di un'altra libreria client:

Aggiungi la libreria client delle credenziali dell'account di servizio per PHP all'applicazione. Utilizza il metodo signBlob() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per PHP, puoi rimuoverla dall'applicazione.

Se utilizzi la libreria di autenticazione Google per PHP, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 1.5.0 o successiva di google-auth-library-php.

Se utilizzi un'altra libreria client per firmare i blob:

Contatta iam-sign-deprecation-public@google.com per ricevere assistenza.

Python

Se utilizzi la libreria client IAM per Python, direttamente o come dipendenza di un'altra libreria client:

Aggiungi la libreria client delle credenziali dell'account di servizio per Python all'applicazione. Utilizza il metodo sign_blob() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di google-cloud-iam, puoi rimuoverla dalla tua applicazione.

Se utilizzi la libreria di autenticazione Google per Python, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 1.21.2 o successiva di google-auth-library-python.

Se utilizzi il client Python per Cloud Storage, direttamente o come dipendenza di un'altra libreria client:

Esegui l'upgrade alla versione 1.30.0 o successiva di python-storage.

Se utilizzi un'altra libreria client per firmare i blob:

Contatta iam-sign-deprecation-public@google.com per ricevere assistenza.

Ruby

Se utilizzi la libreria client IAM per Ruby, direttamente o come dipendenza di un'altra libreria client:

Aggiungi la libreria client delle credenziali dell'account di servizio per Ruby all'applicazione. Utilizza il metodo sign_service_account_blob() per generare una firma.

Il nome dell'account di servizio deve utilizzare il carattere jolly - per rappresentare l'ID progetto.

Valido: nome con carattere jolly

projects/-/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Non valido: nome con ID progetto.

projects/my-project/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com

Se non utilizzi più la libreria client di IAM per Ruby, puoi rimuoverla dall'applicazione.

Se utilizzi un'altra libreria client per firmare i blob:

Contatta iam-sign-deprecation-public@google.com per ricevere assistenza.

Migrazione del codice che utilizza l'interfaccia a riga di comando gcloud

L'interfaccia a riga di comando di Google Cloud fornisce comandi che utilizzano l'API IAM per firmare JWT e blob binari, tra cui:

A partire dal 1° luglio 2021, aggiorneremo questi comandi in modo che utilizzino l'API Service Account Credentials. Questa modifica non interesserà i comandi per firmare i blob.

Se utilizzi l'interfaccia a riga di comando gcloud per firmare i JWT, devi seguire questi passaggi prima del 1° luglio 2021:

  1. Controlla se includi il periodo di scadenza (exp) nel set di attestazioni JWT.

    Se includi già questa rivendicazione, non devi apportare alcuna modifica. Puoi saltare i passaggi rimanenti.

    Se non includi questa rivendicazione, vai al passaggio successivo.

  2. Verifica se utilizzi il JWT firmato per autenticarti con le API di Google o con un'altra API che richiede la rivendicazione exp.

    Se ometti questa rivendicazione, l'API IAM la imposta automaticamente su 1 ora nel futuro. Al contrario, l'API Service Account Credentials non imposta automaticamente questo campo.

    Se hai la certezza di non aver bisogno della rivendicazione exp, non devi apportare alcuna modifica. Puoi ignorare i passaggi rimanenti.

    Se hai bisogno della rivendicazione exp o se non sei sicuro, vai al prossimo passaggio.

  3. Aggiorna il codice per la creazione di JWT in modo che aggiunga la rivendicazione exp al set di attestazioni JWT.

    Puoi impostare la rivendicazione exp fino a un'ora nel futuro.

Verifica delle quote

La quota per l'API Service Account Credentials è separata da quella per l'API IAM. Se hai ricevuto un aumento della quota per firmare JWT e blob con l'API IAM, potresti anche dover richiedere un aumento dell'API Service Account Credentials.

Per visualizzare la tua quota e l'utilizzo effettivo per entrambe le API e richiedere un aumento della quota, se necessario, procedi come segue:

  1. In Cloud Console, vai alla pagina Quote.

    Vai alla pagina Quote

  2. Seleziona un progetto. Puoi fare clic su un progetto recente o fare clic su Seleziona progetto per cercare in tutti i progetti.

  3. Nella casella di testo Filtra tabella sopra la tabella, inserisci Sign requests per minute, quindi seleziona il valore visualizzato.

  4. Nella casella di testo Filtra tabella, seleziona O dall'elenco a discesa.

  5. Nella casella di testo Filtra tabella, inserisci Generate credentials, quindi seleziona il valore visualizzato.

    Cloud Console mostra l'utilizzo corrente per la firma di JWT e blob nell'ultimo minuto, l'utilizzo massimo al minuto negli ultimi sette giorni e la quota attuale visualizzata nella colonna Limite.

  6. Confronta le quote per ogni riga nella tabella e assicurati che la quota per l'API Service Account Credentials sia superiore al tuo picco di utilizzo di 7 giorni dell'API IAM.

  7. (Facoltativo) Se la tua quota per l'API Service Account Credentials è troppo bassa, seleziona la casella di controllo per l'API Service Account Credentials, quindi fai clic su Modifica quote. Compila il modulo per richiedere un aumento della quota.

  8. Ripeti questi passaggi per ogni progetto in cui utilizzi l'API IAM per firmare JWT e blob.

Passaggi successivi