OAuth 2.0 per applicazioni TV e di dispositivi con input limitato

di una nota

Questo documento spiega come implementare l'autorizzazione OAuth 2.0 per accedere alle API di Google tramite applicazioni in esecuzione su dispositivi quali TV, console per videogiochi e stampanti. Più precisamente, questo flusso è progettato per i dispositivi che non hanno accesso a un browser o che hanno funzionalità di input limitate.

OAuth 2.0 consente agli utenti di condividere dati specifici con un'applicazione, mantenendo privati i propri nomi utente, le password e altre informazioni. Ad esempio, un'applicazione TV potrebbe utilizzare OAuth 2.0 per ottenere l'autorizzazione a selezionare un file archiviato su Google Drive.

Poiché le applicazioni che utilizzano questo flusso vengono distribuite ai singoli dispositivi, si presume che le app non possano conservare i secret. Possono accedere alle API di Google mentre l'utente è presente nell'app o quando l'app è in esecuzione in background.

Alternative

Se stai scrivendo un'app per una piattaforma come Android, iOS, macOS, Linux o Windows (inclusa la piattaforma Universal Windows), che ha accesso al browser e a funzionalità di input complete, utilizza il flusso OAuth 2.0 per applicazioni mobile e desktop. Dovresti utilizzare questo flusso anche se l'app è uno strumento a riga di comando senza interfaccia grafica.

Se vuoi eseguire solo l'accesso degli utenti con i loro Account Google e utilizzare il token ID JWT per ottenere le informazioni di base del profilo utente, consulta la sezione Accesso su TV e dispositivi di immissione limitata.

Prerequisiti

Abilita le API per il tuo progetto

Qualsiasi applicazione che chiama le API di Google deve abilitare queste API in API Console.

Per abilitare un'API per il tuo progetto:

  1. Open the API Library in Google API Console.
  2. If prompted, select a project, or create a new one.
  3. L' API Library elenca tutte le API disponibili, raggruppate per famiglia di prodotti e popolarità. Se l'API che vuoi attivare non è visibile nell'elenco, utilizza la funzione di ricerca per trovarla oppure fai clic su Visualizza tutto nella famiglia di prodotti a cui appartiene.
  4. Seleziona l'API che vuoi attivare e fai clic sul pulsante Abilita.
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

Crea credenziali di autorizzazione

Qualsiasi applicazione che utilizza OAuth 2.0 per accedere alle API di Google deve avere credenziali di autorizzazione che identificano l'applicazione sul server OAuth 2.0 di Google. I passaggi seguenti spiegano come creare le credenziali per il progetto. Le applicazioni potranno quindi utilizzare le credenziali per accedere alle API che hai abilitato per il progetto.

  1. Go to the Credentials page.
  2. Fai clic su Crea credenziali > ID client OAuth.
  3. Seleziona il tipo di applicazione TV e dispositivi di input limitato.
  4. Assegna un nome al client OAuth 2.0 e fai clic su Crea.

Identificare gli ambiti di accesso

Gli ambiti consentono alla tua applicazione di richiedere l'accesso solo alle risorse di cui ha bisogno, permettendo al contempo agli utenti di controllare la quantità di accesso che concederanno all'applicazione. Pertanto, potrebbe esistere una relazione inversa tra il numero di ambiti richiesti e la probabilità di ottenere il consenso dell'utente.

Prima di iniziare a implementare l'autorizzazione OAuth 2.0, ti consigliamo di identificare gli ambiti a cui la tua applicazione dovrà accedere.

Consulta l'elenco Ambiti consentiti per le app o i dispositivi installati.

Ottenere i token di accesso OAuth 2.0

Anche se l'applicazione viene eseguita su un dispositivo con funzionalità di input limitate, per completare questo flusso di autorizzazione gli utenti devono avere un accesso separato a un dispositivo con funzionalità di input più avanzate. Il flusso prevede i seguenti passaggi:

  1. L'applicazione invia una richiesta al server di autorizzazione di Google per identificare gli ambiti a cui l'applicazione richiederà l'autorizzazione.
  2. Il server risponde con diverse informazioni utilizzate nei passaggi successivi, ad esempio un codice dispositivo e un codice utente.
  3. Vengono mostrate le informazioni che l'utente può inserire su un dispositivo separato per autorizzare la tua app.
  4. L'applicazione avvia il polling del server di autorizzazione di Google per determinare se l'utente ha autorizzato l'app.
  5. L'utente passa a un dispositivo con funzionalità di input più avanzate, avvia un browser web, accede all'URL visualizzato nel passaggio 3 e inserisce un codice che è visualizzato anche nel passaggio 3. L'utente potrà quindi concedere (o negare) l'accesso alla tua applicazione.
  6. La risposta successiva alla richiesta di polling contiene i token necessari che l'app deve autorizzare per le richieste per conto dell'utente. Se l'utente ha rifiutato l'accesso alla tua applicazione, la risposta non contiene token.

L'immagine seguente illustra questo processo:

L'utente esegue l'accesso su un dispositivo separato in cui è installato un browser.

Le seguenti sezioni spiegano questi passaggi in dettaglio. Data la gamma di funzionalità e gli ambienti di runtime che possono avere i dispositivi, gli esempi mostrati in questo documento utilizzano l'utilità a riga di comando curl. Questi esempi dovrebbero essere facili da trasferire in vari linguaggi e runtime.

Passaggio 1: richiedi i codici dispositivo e utente

In questo passaggio, il dispositivo invia una richiesta HTTP POST al server di autorizzazione di Google, all'indirizzo https://oauth2.googleapis.com/device/code, che identifica la tua applicazione e gli ambiti di accesso a cui l'applicazione vuole accedere per conto dell'utente. Dovresti recuperare questo URL dal documento di rilevamento utilizzando il valore dei metadati device_authorization_endpoint. Includi i seguenti parametri di richiesta HTTP:

Parametri
client_id Obbligatorio

L'ID client della tua applicazione. Puoi trovare questo valore in API Console Credentials page.

scope Obbligatorio

Un elenco di ambiti delimitato da spazi che identificano le risorse a cui l'applicazione potrebbe accedere per conto dell'utente. Questi valori indicano la schermata per il consenso che Google mostra all'utente. Consulta l'elenco Ambiti consentiti per le app o i dispositivi installati.

Gli ambiti consentono alla tua applicazione di richiedere l'accesso solo alle risorse di cui ha bisogno, permettendo al contempo agli utenti di controllare la quantità di accesso che concederanno all'applicazione. Esiste quindi una relazione inversa tra il numero di ambiti richiesti e la probabilità di ottenere il consenso dell'utente.

Esempi

Lo snippet seguente mostra una richiesta di esempio:

POST /device/code HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=client_id&scope=email%20profile

Questo esempio mostra un comando curl per inviare la stessa richiesta:

curl -d "client_id=client_id&scope=email%20profile" \
     https://oauth2.googleapis.com/device/code

Passaggio 2: gestisci la risposta del server di autorizzazione

Il server di autorizzazione restituirà una delle seguenti risposte:

Risposta riuscita

Se la richiesta è valida, la risposta sarà un oggetto JSON contenente le seguenti proprietà:

Proprietà
device_code Un valore assegnato in modo univoco da Google per identificare il dispositivo che esegue l'app richiedendo l'autorizzazione. L'utente autorizza il dispositivo da un altro dispositivo con funzionalità di input più avanzate. Ad esempio, un utente potrebbe utilizzare un laptop o un cellulare per autorizzare un'app in esecuzione su una TV. In questo caso, device_code identifica la TV.

Questo codice consente al dispositivo che esegue l'app di determinare in modo sicuro se l'utente ha concesso o negato l'accesso.

expires_in Il periodo di tempo, in secondi, durante il quale device_code e user_code sono validi. Se, durante questo periodo, l'utente non completa il flusso di autorizzazione e il tuo dispositivo non esegue il polling anche per recuperare informazioni sulla decisione dell'utente, potresti dover riavviare il processo dal passaggio 1.
interval Il periodo di tempo, in secondi, che il dispositivo deve attendere tra una richiesta di polling e l'altra. Ad esempio, se il valore è 5, il dispositivo deve inviare una richiesta di polling al server di autorizzazione di Google ogni cinque secondi. Per ulteriori dettagli, vedi il passaggio 3.
user_code Un valore sensibile alle maiuscole che identifica a Google gli ambiti a cui l'applicazione richiede l'accesso. L'interfaccia utente indicherà all'utente di inserire questo valore su un dispositivo separato con funzionalità di input più avanzate. Google utilizza quindi il valore per visualizzare l'insieme di ambiti corretto quando viene richiesto all'utente di concedere l'accesso all'applicazione.
verification_url Un URL a cui l'utente deve accedere su un dispositivo separato per inserire il user_code e concedere o negare l'accesso all'applicazione. Questo valore verrà visualizzato anche nell'interfaccia utente.

Lo snippet seguente mostra una risposta di esempio:

{
  "device_code": "4/4-GMMhmHCXhWEzkobqIHGG_EnNYYsAkukHspeYUk9E8",
  "user_code": "GQVQ-JKEC",
  "verification_url": "https://www.google.com/device",
  "expires_in": 1800,
  "interval": 5
}

Risposta di superamento quota

Se le richieste di codice del dispositivo hanno superato la quota associata al tuo ID client, riceverai una risposta 403 contenente il seguente errore:

{
  "error_code": "rate_limit_exceeded"
}

In questo caso, utilizza una strategia di backoff per ridurre la frequenza delle richieste.

Passaggio 3: visualizza il codice utente

Mostra all'utente verification_url e user_code ottenuti nel passaggio 2. Entrambi i valori possono contenere qualsiasi carattere stampabile del set di caratteri US-ASCII. I contenuti che mostri all'utente devono indicare all'utente di andare a verification_url su un dispositivo separato e inserire user_code.

Progetta l'interfaccia utente (UI) tenendo presente le seguenti regole:

  • user_code
    • user_code deve essere visualizzato in un campo che può gestire 15 caratteri di dimensione "W". In altre parole, se riesci a visualizzare correttamente il codice WWWWWWWWWWWWWWW, la tua UI è valida e ti consigliamo di utilizzare questo valore di stringa quando testi la modalità di visualizzazione di user_code nell'interfaccia utente.
    • Il campo user_code è sensibile alle maiuscole e non deve essere modificato in alcun modo, ad esempio cambiando le maiuscole e le minuscole o inserendo altri caratteri di formattazione.
  • verification_url
    • Lo spazio in cui viene visualizzato verification_url deve essere abbastanza ampio da gestire una stringa URL di 40 caratteri.
    • Non devi modificare verification_url in alcun modo, tranne per rimuovere facoltativamente lo schema per la visualizzazione. Se prevedi di rimuovere lo schema (ad es. https://) dall'URL per motivi di visualizzazione, assicurati che la tua app sia in grado di gestire entrambe le varianti http e https.

Passaggio 4: esegui un sondaggio sul server di autorizzazione di Google

Poiché l'utente utilizzerà un dispositivo separato per accedere a verification_url e concedere (o negare) l'accesso, il dispositivo richiedente non riceve automaticamente una notifica quando l'utente risponde alla richiesta di accesso. Per questo motivo, il dispositivo richiedente deve interrogare il server di autorizzazione di Google per determinare quando l'utente ha risposto alla richiesta.

Il dispositivo richiedente deve continuare a inviare richieste di polling finché non riceve una risposta che indica che l'utente ha risposto alla richiesta di accesso o fino a quando i device_code e user_code ottenuti nel passaggio 2 non sono scaduti. Il valore interval restituito nel passaggio 2 specifica la quantità di tempo, in secondi, di attesa tra una richiesta e l'altra.

L'URL dell'endpoint per il sondaggio è https://oauth2.googleapis.com/token. La richiesta di polling contiene i seguenti parametri:

Parametri
client_id L'ID client della tua applicazione. Puoi trovare questo valore in API Console Credentials page.
client_secret Il client secret per il client_id fornito. Puoi trovare questo valore in API Console Credentials page.
device_code device_code restituito dal server di autorizzazione nel passaggio 2.
grant_type Imposta questo valore su urn:ietf:params:oauth:grant-type:device_code.

Esempi

Lo snippet seguente mostra una richiesta di esempio:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=client_id&
client_secret=client_secret&
device_code=device_code&
grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code

Questo esempio mostra un comando curl per inviare la stessa richiesta:

curl -d "client_id=client_id&client_secret=client_secret& \
         device_code=device_code& \
         grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code" \
         -H "Content-Type: application/x-www-form-urlencoded" \
         https://oauth2.googleapis.com/token

Passaggio 5: l'utente risponde alla richiesta di accesso

L'immagine seguente mostra una pagina simile a quella che gli utenti vedono quando visitano il verification_url che hai visualizzato nel passaggio 3:

Connetti un dispositivo inserendo un codice

Dopo aver inserito il user_code e, se non ha già effettuato l'accesso, dopo aver eseguito l'accesso a Google, l'utente visualizza una schermata per il consenso come quella mostrata di seguito:

Esempio di schermata di consenso per un client del dispositivo

Passaggio 6: gestisci le risposte alle richieste di polling

Il server di autorizzazione di Google risponde a ogni richiesta di polling con una delle seguenti risposte:

Accesso consentito

Se l'utente ha concesso l'accesso al dispositivo (facendo clic su Allow nella schermata per il consenso), la risposta contiene un token di accesso e un token di aggiornamento. I token consentono al dispositivo di accedere alle API di Google per conto dell'utente. (La proprietà scope nella risposta determina a quali API può accedere il dispositivo.)

In questo caso, la risposta dell'API contiene i seguenti campi:

Campi
access_token Il token inviato dalla tua applicazione per autorizzare una richiesta API di Google.
expires_in La durata rimanente del token di accesso in secondi.
refresh_token Un token che puoi utilizzare per ottenere un nuovo token di accesso. I token di aggiornamento sono validi fino a quando l'utente non revoca l'accesso. Tieni presente che i token di aggiornamento vengono sempre restituiti per i dispositivi.
scope Gli ambiti di accesso concessi da access_token espressi come elenco di stringhe sensibili alle maiuscole e delimitate da spazi.
token_type Il tipo di token restituito. Al momento, il valore di questo campo è sempre impostato su Bearer.

Lo snippet seguente mostra una risposta di esempio:

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
  "token_type": "Bearer",
  "refresh_token": "1/xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
}

I token di accesso hanno una durata limitata. Se la tua applicazione ha bisogno di accedere a un'API per un lungo periodo di tempo, può utilizzare il token di aggiornamento per ottenere un nuovo token di accesso. Se la tua applicazione richiede questo tipo di accesso, deve archiviare il token di aggiornamento per utilizzarlo in un secondo momento.

Accesso negato

Se l'utente rifiuta di concedere l'accesso al dispositivo, la risposta del server ha un codice di stato della risposta HTTP 403 (Forbidden). La risposta contiene il seguente errore:

{
  "error": "access_denied",
  "error_description": "Forbidden"
}

In attesa di autorizzazione

Se l'utente non ha ancora completato il flusso di autorizzazione, il server restituisce un codice di stato della risposta HTTP 428 (Precondition Required). La risposta contiene il seguente errore:

{
  "error": "authorization_pending",
  "error_description": "Precondition Required"
}

Sondaggi troppo frequenti

Se il dispositivo invia richieste di polling troppo spesso, il server restituisce un codice di stato di risposta HTTP 403 (Forbidden). La risposta contiene il seguente errore:

{
  "error": "slow_down",
  "error_description": "Forbidden"
}

Altri errori

Il server di autorizzazione restituisce anche errori se nella richiesta di polling mancano alcuni parametri obbligatori o se presenta un valore parametro errato. Di solito, queste richieste hanno un codice di stato di risposta HTTP 400 (Bad Request) o 401 (Unauthorized). Questi errori includono:

Errore Codice di stato HTTP Descrizione
admin_policy_enforced 400 L'Account Google non è in grado di autorizzare uno o più ambiti richiesti a causa delle norme dell'amministratore di Google Workspace. Per saperne di più su come un amministratore può limitare l'accesso agli ambiti, consulta l'articolo del Centro assistenza per amministratori di Google Workspace Specificare quali app di terze parti e interne possono accedere ai dati di Google Workspace per saperne di più su come un amministratore può limitare l'accesso agli ambiti finché l'accesso non viene concesso esplicitamente al tuo ID client OAuth.
invalid_client 401

Client OAuth non trovato. Ad esempio, questo errore si verifica se il valore del parametro client_id non è valido.

Il tipo di client OAuth non è corretto. Assicurati che il tipo di applicazione per l'ID client sia impostato su TV e dispositivi di input limitato.

invalid_grant 400 Il valore del parametro code non è valido, è già stato rivendicato o non può essere analizzato.
unsupported_grant_type 400 Il valore del parametro grant_type non è valido.
org_internal 403 L'ID client OAuth nella richiesta fa parte di un progetto che limita l'accesso agli Account Google in una organizzazione Google Cloud specifica. Conferma la configurazione del tipo di utente per la tua applicazione OAuth.

Chiamata alle API di Google

Dopo che l'applicazione ha ottenuto un token di accesso, puoi utilizzarlo per effettuare chiamate a un'API di Google per conto di un determinato account utente se gli ambiti di accesso richiesti dall'API sono stati concessi. A questo scopo, includi il token di accesso in una richiesta all'API includendo un parametro di query access_token o un valore Bearer di intestazione HTTP Authorization. Quando possibile, è preferibile utilizzare l'intestazione HTTP, perché le stringhe di query tendono a essere visibili nei log del server. Nella maggior parte dei casi puoi utilizzare una libreria client per configurare le chiamate alle API di Google (ad esempio, quando chiami l'API Drive Files).

Puoi provare tutte le API di Google e visualizzarne gli ambiti in OAuth 2.0 Playground.

Esempi di HTTP GET

Una chiamata all'endpoint drive.files (l'API Drive Files) utilizzando l'intestazione HTTP Authorization: Bearer potrebbe essere simile alla seguente. Tieni presente che devi specificare un tuo token di accesso:

GET /drive/v2/files HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

Di seguito è riportata una chiamata alla stessa API per l'utente autenticato utilizzando il parametro della stringa di query access_token:

GET https://www.googleapis.com/drive/v2/files?access_token=access_token

Esempi di curl

Puoi testare questi comandi con l'applicazione a riga di comando curl. Ecco un esempio in cui viene utilizzata l'opzione dell'intestazione HTTP (opzione preferita):

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files

In alternativa, l'opzione del parametro della stringa di query:

curl https://www.googleapis.com/drive/v2/files?access_token=access_token

Aggiornamento di un token di accesso

I token di accesso scadono periodicamente e diventano credenziali non valide per una richiesta API correlata. Puoi aggiornare un token di accesso senza chiedere all'utente l'autorizzazione (anche quando l'utente non è presente) se hai richiesto l'accesso offline agli ambiti associati al token.

Per aggiornare un token di accesso, la tua applicazione invia una richiesta POST HTTPS al server di autorizzazione di Google (https://oauth2.googleapis.com/token) che include i seguenti parametri:

Campi
client_id L'ID client ottenuto da API Console.
client_secret Il client secret ottenuto da API Console.
grant_type Come definito nella specifica OAuth 2.0, il valore di questo campo deve essere impostato su refresh_token.
refresh_token Il token di aggiornamento restituito dallo scambio del codice di autorizzazione.

Lo snippet seguente mostra una richiesta di esempio:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=your_client_id&
client_secret=your_client_secret&
refresh_token=refresh_token&
grant_type=refresh_token

Se l'utente non ha revocato l'accesso concesso all'applicazione, il server dei token restituisce un oggetto JSON contenente un nuovo token di accesso. Lo snippet seguente mostra una risposta di esempio:

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "https://www.googleapis.com/auth/drive.metadata.readonly",
  "token_type": "Bearer"
}

Tieni presente che sono previsti limiti al numero di token di aggiornamento che verranno emessi: un limite per combinazione client/utente e un altro per utente in tutti i client. Devi salvare i token di aggiornamento nello spazio di archiviazione a lungo termine e continuare a utilizzarli finché rimangono validi. Se l'applicazione richiede troppi token di aggiornamento, potrebbe raggiungere questi limiti, nel qual caso i token di aggiornamento meno recenti smetteranno di funzionare.

Revoca di un token

In alcuni casi un utente potrebbe voler revocare l'accesso concesso a un'applicazione. Un utente può revocare l'accesso visitando le impostazioni dell'account. Per saperne di più, consulta la sezione relativa alla rimozione dell'accesso di siti o app del documento di assistenza Siti e app di terze parti con accesso al tuo account.

Un'applicazione può anche revocare in modo programmatico l'accesso che le è stato concesso. La revoca programmatica è importante nelle istanze in cui un utente annulla l'iscrizione, rimuove un'applicazione o le risorse API richieste da un'app sono cambiate in modo significativo. In altre parole, parte del processo di rimozione può includere una richiesta API per garantire che le autorizzazioni concesse in precedenza all'applicazione vengano rimosse.

Per revocare in modo programmatico un token, l'applicazione invia una richiesta a https://oauth2.googleapis.com/revoke e include il token come parametro:

curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
        https://oauth2.googleapis.com/revoke?token={token}

Il token può essere un token di accesso o un token di aggiornamento. Se il token è un token di accesso e ha un token di aggiornamento corrispondente, verrà revocato anche il token di aggiornamento.

Se la revoca viene elaborata correttamente, il codice di stato HTTP della risposta è 200. Per le condizioni di errore, viene restituito un codice di stato HTTP 400 insieme a un codice di errore.

Ambiti consentiti

Il flusso OAuth 2.0 per i dispositivi è supportato solo per i seguenti ambiti:

OpenID Connect, Accedi con Google

  • email
  • openid
  • profile

API Drive

  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.file

API di YouTube

  • https://www.googleapis.com/auth/youtube
  • https://www.googleapis.com/auth/youtube.readonly