Google si impegna a promuovere l'equità razziale per le comunità nere. Vedi come.
Questa pagina è stata tradotta dall'API Cloud Translation.
Switch to English

Utilizzo di OAuth 2.0 per accedere alle API di Google

Le API di Google utilizzano il protocollo OAuth 2.0 per l'autenticazione e l'autorizzazione. Google supporta scenari OAuth 2.0 comuni come quelli per applicazioni per server web, lato client, installati e dispositivi con input limitato.

Per iniziare, ottieni le credenziali del client OAuth 2.0 da Google API Console . Quindi l'applicazione client richiede un token di accesso dal server di autorizzazione di Google, estrae un token dalla risposta e invia il token all'API di Google a cui desideri accedere. Per una dimostrazione interattiva dell'utilizzo di OAuth 2.0 con Google (inclusa l'opzione per utilizzare le proprie credenziali client), sperimentare con OAuth 2.0 Playground .

Questa pagina offre una panoramica degli scenari di autorizzazione OAuth 2.0 supportati da Google e fornisce collegamenti a contenuti più dettagliati. Per i dettagli sull'utilizzo di OAuth 2.0 per l'autenticazione, vedere OpenID Connect .

Passaggi di base

Tutte le applicazioni seguono uno schema di base quando accedono a un'API di Google utilizzando OAuth 2.0. Ad alto livello, segui cinque passaggi:

1. Ottieni le credenziali OAuth 2.0 da Google API Console.

Visita lo Google API Console per ottenere le credenziali OAuth 2.0 come un ID client e un client secret noti sia a Google che alla tua applicazione. Il set di valori varia in base al tipo di applicazione che stai creando. Ad esempio, un'applicazione JavaScript non richiede un segreto, ma un'applicazione server Web lo fa.

2. Ottieni un token di accesso dal server di autorizzazione di Google.

Prima che la tua applicazione possa accedere ai dati privati ​​utilizzando un'API di Google, deve ottenere un token di accesso che conceda l'accesso a tale API. Un singolo token di accesso può concedere diversi gradi di accesso a più API. Un parametro variabile denominato scope controlla l'insieme di risorse e operazioni consentite da un token di accesso. Durante la richiesta del token di accesso, l'applicazione invia uno o più valori nel parametro scope .

Esistono diversi modi per effettuare questa richiesta e variano in base al tipo di applicazione che si sta creando. Ad esempio, un'applicazione JavaScript potrebbe richiedere un token di accesso utilizzando un browser che reindirizza a Google, mentre un'applicazione installata su un dispositivo senza browser utilizza le richieste del servizio web.

Alcune richieste richiedono un passaggio di autenticazione in cui l'utente accede con il proprio account Google. Dopo aver effettuato l'accesso, all'utente viene chiesto se desidera concedere una o più autorizzazioni richieste dall'applicazione. Questo processo è chiamato consenso dell'utente .

Se l'utente concede almeno un'autorizzazione, il server di autorizzazione di Google invia alla tua applicazione un token di accesso (o un codice di autorizzazione che la tua applicazione può utilizzare per ottenere un token di accesso) e un elenco di ambiti di accesso concessi da quel token. Se l'utente non concede l'autorizzazione, il server restituisce un errore.

In genere è consigliabile richiedere gli ambiti in modo incrementale, nel momento in cui è richiesto l'accesso, piuttosto che in anticipo. Ad esempio, un'app che desidera supportare il salvataggio di un evento in un calendario non dovrebbe richiedere l'accesso a Google Calendar fino a quando l'utente non preme il pulsante "Aggiungi al calendario"; vedere Autorizzazione incrementale .

3. Esaminare gli ambiti di accesso concesso dall'utente.

Confronta gli ambiti inclusi nella risposta del token di accesso con gli ambiti richiesti per accedere a funzioni e funzionalità dell'applicazione in base all'accesso a un'API di Google correlata. Disabilita tutte le funzionalità della tua app che non possono funzionare senza l'accesso all'API correlata.

L'ambito incluso nella richiesta potrebbe non corrispondere all'ambito incluso nella risposta, anche se l'utente ha concesso tutti gli ambiti richiesti. Fare riferimento alla documentazione di ciascuna API di Google per gli ambiti richiesti per l'accesso. Un'API può mappare più valori di stringa di ambito a un singolo ambito di accesso, restituendo la stessa stringa di ambito per tutti i valori consentiti nella richiesta. Esempio: l'API di Google People può restituire un ambito di https://www.googleapis.com/auth/contacts quando un'app ha richiesto a un utente l'autorizzazione di un ambito di https://www.google.com/m8/feeds/ ; il metodo dell'API di Google People people.updateContact richiede un ambito concesso di https://www.googleapis.com/auth/contacts .

4. Inviare il token di accesso a un'API.

Dopo che un'applicazione ottiene un token di accesso, invia il token a un'API di Google in un'intestazione della richiesta di autorizzazione HTTP . È possibile inviare token come parametri della stringa di query URI, ma non lo consigliamo, perché i parametri URI possono finire in file di log che non sono completamente sicuri. Inoltre, è buona norma REST evitare di creare nomi di parametri URI non necessari. Tieni presente che il supporto delle stringhe di query verrà ritirato il 1 ° giugno 2021.

I token di accesso sono validi solo per il set di operazioni e risorse descritte scope della richiesta del token. Ad esempio, se viene emesso un token di accesso per l'API di Google Calendar, non concede l'accesso all'API dei contatti di Google. Tuttavia, puoi inviare più volte il token di accesso all'API di Google Calendar per operazioni simili.

5. Aggiornare il token di accesso, se necessario.

I token di accesso hanno una durata limitata. Se la tua applicazione deve accedere a un'API di Google oltre la durata di un singolo token di accesso, può ottenere un token di aggiornamento. Un token di aggiornamento consente alla tua applicazione di ottenere nuovi token di accesso.

Scenari

Applicazioni del server web

L'endpoint Google OAuth 2.0 supporta applicazioni server web che utilizzano linguaggi e framework come PHP, Java, Python, Ruby e ASP.NET.

La sequenza di autorizzazione inizia quando la tua applicazione reindirizza un browser a un URL di Google; l'URL include parametri di query che indicano il tipo di accesso richiesto. Google gestisce l'autenticazione dell'utente, la selezione della sessione e il consenso dell'utente. Il risultato è un codice di autorizzazione, che l'applicazione può scambiare con un token di accesso e un token di aggiornamento.

L'applicazione dovrebbe memorizzare il token di aggiornamento per un utilizzo futuro e utilizzare il token di accesso per accedere a un'API di Google. Una volta scaduto il token di accesso, l'applicazione utilizza il token di aggiornamento per ottenerne uno nuovo.

La tua applicazione invia una richiesta di token al server di autorizzazione di Google, riceve un codice di autorizzazione, scambia il codice con un token e utilizza il token per chiamare un endpoint dell'API di Google.

Per i dettagli, vedere Utilizzo di OAuth 2.0 per applicazioni server Web .

Applicazioni installate

L'endpoint Google OAuth 2.0 supporta le applicazioni installate su dispositivi come computer, dispositivi mobili e tablet. Quando crei un ID client tramite Google API Console , specifica che si tratta di un'applicazione installata, quindi seleziona Android, app Chrome, iOS, piattaforma UWP (Universal Windows Platform) o app desktop come tipo di applicazione.

Il processo si traduce in un ID client e, in alcuni casi, in un segreto client, da incorporare nel codice sorgente dell'applicazione. (In questo contesto, il segreto del client ovviamente non viene trattato come un segreto.)

La sequenza di autorizzazione inizia quando la tua applicazione reindirizza un browser a un URL di Google; l'URL include parametri di query che indicano il tipo di accesso richiesto. Google gestisce l'autenticazione dell'utente, la selezione della sessione e il consenso dell'utente. Il risultato è un codice di autorizzazione, che l'applicazione può scambiare con un token di accesso e un token di aggiornamento.

L'applicazione dovrebbe memorizzare il token di aggiornamento per un utilizzo futuro e utilizzare il token di accesso per accedere a un'API di Google. Una volta scaduto il token di accesso, l'applicazione utilizza il token di aggiornamento per ottenerne uno nuovo.

La tua applicazione invia una richiesta di token al server di autorizzazione di Google, riceve un codice di autorizzazione, scambia il codice con un token e utilizza il token per chiamare un endpoint dell'API di Google.

Per i dettagli, vedere Utilizzo di OAuth 2.0 per le applicazioni installate .

Applicazioni lato client (JavaScript)

L'endpoint Google OAuth 2.0 supporta le applicazioni JavaScript eseguite in un browser.

La sequenza di autorizzazione inizia quando la tua applicazione reindirizza un browser a un URL di Google; l'URL include parametri di query che indicano il tipo di accesso richiesto. Google gestisce l'autenticazione dell'utente, la selezione della sessione e il consenso dell'utente.

Il risultato è un token di accesso, che il client deve convalidare prima di includerlo in una richiesta API di Google. Quando il token scade, l'applicazione ripete il processo.

La tua applicazione JS invia una richiesta di token al server di autorizzazione di Google, riceve un token, convalida il token e utilizza il token per chiamare un endpoint dell'API di Google.

Per i dettagli, vedere Utilizzo di OAuth 2.0 per applicazioni lato client .

Applicazioni su dispositivi con input limitato

L'endpoint Google OAuth 2.0 supporta applicazioni eseguite su dispositivi con input limitato come console di gioco, videocamere e stampanti.

La sequenza di autorizzazione inizia con l'applicazione che effettua una richiesta di servizio web a un URL di Google per un codice di autorizzazione. La risposta contiene diversi parametri, tra cui un URL e un codice che l'applicazione mostra all'utente.

L'utente ottiene l'URL e il codice dal dispositivo, quindi passa a un dispositivo o computer separato con funzionalità di input più avanzate. L'utente avvia un browser, naviga all'URL specificato, accede e inserisce il codice.

Nel frattempo, l'applicazione esegue il polling di un URL di Google a un intervallo specificato. Dopo che l'utente ha approvato l'accesso, la risposta dal server di Google contiene un token di accesso e un token di aggiornamento. L'applicazione dovrebbe memorizzare il token di aggiornamento per un utilizzo futuro e utilizzare il token di accesso per accedere a un'API di Google. Una volta scaduto il token di accesso, l'applicazione utilizza il token di aggiornamento per ottenerne uno nuovo.

L'utente accede a un dispositivo separato dotato di browser

Per i dettagli, vedere Utilizzo di OAuth 2.0 per i dispositivi .

Account di servizio

Le API di Google come l'API Prediction e Google Cloud Storage possono agire per conto della tua applicazione senza accedere alle informazioni dell'utente. In queste situazioni la tua applicazione deve dimostrare la propria identità all'API, ma non è necessario il consenso dell'utente. Allo stesso modo, negli scenari aziendali, l'applicazione può richiedere l'accesso delegato ad alcune risorse.

Per questi tipi di interazioni da server a server è necessario un account di servizio , che è un account che appartiene all'applicazione anziché a un singolo utente finale. La tua applicazione chiama le API di Google per conto dell'account di servizio e non è richiesto il consenso dell'utente. (In scenari senza account di servizio, la tua applicazione chiama le API di Google per conto degli utenti finali e talvolta è richiesto il consenso dell'utente).

Le credenziali di un account di servizio, ottenute da Google API Console, includono un indirizzo e-mail generato univoco, un ID client e almeno una coppia di chiavi pubblica / privata. Utilizzare l'ID client e una chiave privata per creare un JWT firmato e costruire una richiesta di token di accesso nel formato appropriato. La tua applicazione invia quindi la richiesta del token al server di autorizzazione di Google OAuth 2.0, che restituisce un token di accesso. L'applicazione utilizza il token per accedere a un'API di Google. Quando il token scade, l'applicazione ripete il processo.

La tua applicazione server utilizza un JWT per richiedere un token dal server di autorizzazione di Google, quindi utilizza il token per chiamare un endpoint dell'API di Google. Nessun utente finale è coinvolto.

Per i dettagli, vedere la documentazione dell'account di servizio .

Dimensione del token

I token possono variare in termini di dimensioni, fino ai seguenti limiti:

  • Codici di autorizzazione: 256 byte
  • Token di accesso: 2048 byte
  • Aggiorna token: 512 byte

I token di accesso restituiti dall'API del servizio token di sicurezza di Google Cloud sono strutturati in modo simile ai token di accesso OAuth 2.0 dell'API di Google ma hanno limiti di dimensione dei token diversi. Per i dettagli, vedere la documentazione dell'API .

Google si riserva il diritto di modificare le dimensioni del token entro questi limiti e la tua applicazione deve supportare dimensioni variabili del token di conseguenza.

Aggiorna la scadenza del token

È necessario scrivere il codice per anticipare la possibilità che un token di aggiornamento concesso non funzioni più. Un token di aggiornamento potrebbe smettere di funzionare per uno di questi motivi:

  • L'utente ha revocato l'accesso alla tua app .
  • Il token di aggiornamento non è stato utilizzato per sei mesi.
  • L'utente ha cambiato le password e il token di aggiornamento contiene gli ambiti di Gmail.
  • L'account utente ha superato il numero massimo di token di aggiornamento concessi (live).
  • L'utente appartiene a un'organizzazione di Google Cloud Platform che dispone di criteri di controllo della sessione in vigore.

A un progetto Google Cloud Platform con una schermata di consenso OAuth configurata per un tipo di utente esterno e uno stato di pubblicazione "Test in corso" viene emesso un token di aggiornamento che scade tra 7 giorni.

Attualmente esiste un limite di 50 token di aggiornamento per account Google per ID client OAuth 2.0. Se viene raggiunto il limite, la creazione di un nuovo token di aggiornamento invalida automaticamente il token di aggiornamento più vecchio senza preavviso. Questo limite non si applica agli account di servizio .

Esiste anche un limite maggiore al numero totale di token di aggiornamento che un account utente o un account di servizio può avere su tutti i client. La maggior parte degli utenti normali non supererà questo limite ma potrebbe farlo l'account di uno sviluppatore utilizzato per testare un'implementazione.

Se devi autorizzare più programmi, macchine o dispositivi, una soluzione alternativa è limitare il numero di client che autorizzi per account Google a 15 o 20. Se sei un amministratore di Google Workspace , puoi creare utenti aggiuntivi con privilegi usali per autorizzare alcuni dei clienti.

Gestione dei criteri di controllo della sessione per le organizzazioni di Google Cloud Platform (GCP)

Gli amministratori delle organizzazioni GCP potrebbero richiedere la riautenticazione frequente degli utenti mentre accedono alle risorse GCP, utilizzando la funzione di controllo della sessione di Google Cloud. Questo criterio influisce sull'accesso a Google Cloud Console, a Google Cloud SDK (noto anche come gcloud CLI) e a qualsiasi applicazione OAuth di terze parti che richiede l'ambito di Cloud Platform. Se un utente dispone di una politica di controllo della sessione, alla scadenza della durata della sessione, le chiamate API avranno un errore simile a quello che accadrebbe se il token di aggiornamento fosse revocato. Poiché la durata della sessione può essere molto limitata (da 1 ora a 24 ore), questo scenario deve essere gestito correttamente riavviando una sessione di autenticazione.

Allo stesso modo, non è necessario utilizzare o incoraggiare l'uso di credenziali utente per la distribuzione da server a server. Se le credenziali utente vengono distribuite su un server per lavori o operazioni a lunga esecuzione e un cliente applica criteri di controllo della sessione su tali utenti, l'applicazione server non riuscirà poiché non sarà possibile autenticare nuovamente l'utente quando la durata della sessione scade.

Per ulteriori informazioni su come aiutare i clienti a distribuire questa funzionalità, fare riferimento a questo articolo della guida incentrato sull'amministratore.

Librerie client

Le seguenti librerie client si integrano con i framework più diffusi, il che semplifica l'implementazione di OAuth 2.0. Altre funzionalità verranno aggiunte alle librerie nel tempo.