Implementare un server OAuth 2.0

Ogni azione smart home deve includere un meccanismo per autenticare gli utenti.

L'autenticazione ti consente di collegare gli Account Google dei tuoi utenti agli account utente nel tuo sistema di autenticazione. In questo modo puoi identificare gli utenti quando la tua distribuzione riceve un intent per la smart home. La smart home di Google supporta OAuth solo con un flusso del codice di autorizzazione.

In questa pagina viene descritto come configurare il server OAuth 2.0 in modo che funzioni con l'azione smart home.

Collegamento dell'Account Google con OAuth

Nel flusso del codice di autorizzazione, sono necessari due endpoint:

  • L'endpoint di autorizzazione, che presenta la UI di accesso agli utenti che non hanno ancora eseguito l'accesso. L'endpoint di autorizzazione crea anche un codice di autorizzazione di breve durata per registrare il consenso degli utenti all'accesso richiesto.

  • L'endpoint di scambio di token, che è responsabile di due tipi di scambi:

    1. Scambia un codice di autorizzazione con un token di aggiornamento di lunga durata e un token di accesso di breve durata. Questo scambio avviene quando l'utente accede al flusso di collegamento dell'account.
    2. Scambia un token di aggiornamento di lunga durata con un token di accesso di breve durata. Questo scambio si verifica quando Google ha bisogno di un nuovo token di accesso perché quello è scaduto.

Istruzioni sul design

Questa sezione descrive i requisiti di progettazione e i suggerimenti per la schermata utente che ospiti per i flussi di collegamento OAuth. Dopo essere stata chiamata dall'app di Google, la piattaforma mostra all'utente una pagina di accesso alla pagina Google e la schermata per il collegamento dell'account. L'utente viene reindirizzato all'app di Google dopo aver dato il suo consenso a collegare gli account.

Questa figura mostra i passaggi che devono essere eseguiti da un utente per collegare il proprio Account Google al tuo sistema di autenticazione. Il primo screenshot mostra il collegamento avviato dall'utente dalla tua piattaforma. La seconda immagine mostra l'accesso dell'utente a Google, mentre la terza mostra il consenso e la conferma dell'utente per il collegamento del suo Account Google alla tua app. Lo screenshot finale mostra un account utente collegato correttamente nell'app Google.
Figura 1. Accesso dell'utente a Google e schermate per il consenso con il collegamento dell'account.

Requisiti

  1. Devi comunicare che l'account dell'utente verrà collegato a Google, non a un prodotto Google specifico come Google Home o l'Assistente Google.
  2. Devi avere una dichiarazione di autorizzazione di Google, ad esempio "Se accedi, autorizzi Google a controllare i tuoi dispositivi". Consulta la sezione relativa all'autorizzazione per il controllo dei dispositivi Google delle norme per gli sviluppatori di Google Home.
  3. Devi fornire agli utenti un modo per tornare indietro o annullare il collegamento, se scelgono di non effettuare il collegamento.
  4. Devi aprire la pagina di collegamento OAuth web e assicurarti che gli utenti dispongano di un metodo chiaro per accedere al proprio Account Google, ad esempio i campi per nome utente e password. Non utilizzare il metodo Accedi con Google (GSI) che consente agli utenti di effettuare il collegamento senza essere indirizzati alla pagina Collegamento OAuth per il Web. Si tratta di una violazione delle norme di Google.

Suggerimenti

Ti consigliamo di procedere nel seguente modo:

  1. Visualizza le Norme sulla privacy di Google. Includi un link alle Norme sulla privacy di Google nella schermata per il consenso.

  2. Dati da condividere. Utilizza un linguaggio chiaro e conciso per comunicare all'utente quali dati richiede Google e perché.

  3. Invito all'azione chiaro. Indica un invito all'azione chiaro nella schermata per il consenso, ad esempio "Accetta e collega". Questo perché gli utenti devono capire quali dati sono tenuti a condividere con Google per collegare i propri account.

  4. Possibilità di scollegamento. Offri agli utenti un meccanismo di scollegamento, ad esempio un URL che rimanda alle impostazioni dell'account sulla tua piattaforma. In alternativa, puoi includere un link all'Account Google in cui gli utenti possono gestire il proprio account collegato.

  5. Possibilità di cambiare account utente. Suggerisci agli utenti un metodo per cambiare account. Ciò è particolarmente utile se gli utenti tendono ad avere più account.

    • Se un utente deve chiudere la schermata di consenso per cambiare account, invia un errore recuperabile a Google in modo che l'utente possa accedere all'account desiderato con il collegamento OAuth.
  6. Includi il tuo logo. Mostra il logo della tua azienda nella schermata per il consenso. Segui le tue linee guida per lo stile per posizionare il logo. Se vuoi mostrare anche il logo di Google, consulta la sezione Loghi e marchi.

Flusso del codice di autorizzazione

Un'implementazione del server OAuth 2.0 del flusso del codice di autorizzazione consiste in due endpoint, che il tuo servizio rende disponibili tramite HTTPS. Il primo endpoint è l'endpoint di autorizzazione, che è responsabile di ottenere o ottenere il consenso degli utenti per l'accesso ai dati. L'endpoint di autorizzazione presenta una UI di accesso agli utenti che non hanno ancora eseguito l'accesso e registra il consenso all'accesso richiesto. Il secondo endpoint è l'endpoint di scambio dei token, utilizzato per ottenere stringhe criptate, dette token, che autorizzano un utente ad accedere al tuo servizio.

Quando un'applicazione Google deve chiamare una delle API del tuo servizio, Google utilizza questi endpoint insieme per ottenere l'autorizzazione degli utenti a chiamare tali API per loro conto.

Una sessione di flusso del codice di autorizzazione OAuth 2.0 avviata da Google ha il seguente flusso:

  1. Google apre il tuo endpoint di autorizzazione nel browser dell'utente. Se il flusso è iniziato su un dispositivo con sola voce per un'azione, Google trasferisce l'esecuzione a un telefono.
  2. L'utente accede, se non ha già eseguito l'accesso, e concede a Google l'autorizzazione per accedere ai suoi dati con la tua API, se non ha già concesso l'autorizzazione.
  3. Il servizio crea un codice di autorizzazione e lo restituisce a Google. Per farlo, reindirizza il browser dell'utente a Google con il codice di autorizzazione allegato alla richiesta.
  4. Google invia il codice di autorizzazione all'endpoint di scambio di token, che verifica l'autenticità del codice e restituisce un token di accesso e un token di aggiornamento. Il token di accesso è un token di breve durata accettato dal servizio per accedere alle API. Il token di aggiornamento è un token di lunga durata che Google può archiviare e utilizzare per acquisire nuovi token di accesso alla scadenza.
  5. Dopo che l'utente ha completato il flusso di collegamento dell'account, ogni richiesta successiva inviata da Google contiene un token di accesso.

Gestire le richieste di autorizzazione

Quando devi eseguire il collegamento dell'account utilizzando il flusso del codice di autorizzazione OAuth 2.0, Google invia l'utente all'endpoint di autorizzazione con una richiesta che include i seguenti parametri:

Parametri endpoint di autorizzazione
client_id L'ID client che hai assegnato a Google.
redirect_uri L'URL a cui invii la risposta a questa richiesta.
state Un valore di contabilità ritrasmesso a Google invariato nell'URI di reindirizzamento.
scope Facoltativo: un insieme di stringhe di ambito delimitate da spazi che specificano i dati per cui Google richiede l'autorizzazione.
response_type Il tipo di valore da restituire nella risposta. Per il flusso del codice di autorizzazione OAuth 2.0, il tipo di risposta è sempre code.
user_locale L'impostazione della lingua dell'Account Google in formato RFC5646, utilizzata per localizzare i contenuti nella lingua preferita dell'utente.

Ad esempio, se il tuo endpoint di autorizzazione è disponibile all'indirizzo https://myservice.example.com/auth, una richiesta potrebbe avere il seguente aspetto:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

Per fare in modo che l'endpoint di autorizzazione gestisca le richieste di accesso, segui questi passaggi:

  1. Verifica che client_id corrisponda all'ID client che hai assegnato a Google e che redirect_uri corrisponda all'URL di reindirizzamento fornito da Google per il tuo servizio. Questi controlli sono importanti per evitare di concedere l'accesso ad app client indesiderate o configurate in modo errato. Se supporti più flussi OAuth 2.0, verifica anche che response_type sia code.
  2. Controlla se l'utente ha eseguito l'accesso al tuo servizio. Se l'utente non ha eseguito l'accesso, completa la procedura di accesso o registrazione.
  3. Generare un codice di autorizzazione che Google possa utilizzare per accedere all'API. Il codice di autorizzazione può essere qualsiasi valore stringa, ma deve rappresentare in modo univoco l'utente, il client a cui è destinato il token e la scadenza del codice e non deve essere intuibile. In genere emetti codici di autorizzazione che scadono dopo circa 10 minuti.
  4. Verifica che l'URL specificato dal parametro redirect_uri abbia il seguente formato:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
      
  5. Reindirizza il browser dell'utente all'URL specificato dal parametro redirect_uri. Includi il codice di autorizzazione appena generato e il valore originale dello stato non modificato quando esegui il reindirizzamento aggiungendo i parametri code e state. Di seguito è riportato un esempio di URL risultante:
    https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Gestire le richieste di scambio di token

L'endpoint di scambio di token del servizio è responsabile di due tipi di scambi di token:

  • Scambiare codici di autorizzazione per i token di accesso e i token di aggiornamento
  • Token di aggiornamento Exchange per i token di accesso

Le richieste di scambio di token includono i seguenti parametri:

Parametri endpoint di Exchange per il token
client_id Una stringa che identifica l'origine della richiesta come Google. Questa stringa deve essere registrata all'interno del tuo sistema come identificatore univoco di Google.
client_secret Una stringa segreta registrata con Google per il tuo servizio.
grant_type Il tipo di token scambiato. È authorization_code o refresh_token.
code Quando grant_type=authorization_code, questo parametro è il codice che Google ha ricevuto dall'endpoint di accesso o dallo scambio di token.
redirect_uri Quando grant_type=authorization_code, questo parametro è l'URL utilizzato nella richiesta di autorizzazione iniziale.
refresh_token Quando grant_type=refresh_token, questo parametro è il token di aggiornamento che Google ha ricevuto dal tuo endpoint di scambio di token.

Scambiare codici di autorizzazione per i token di accesso e i token di aggiornamento

Dopo che l'utente ha eseguito l'accesso e dopo che l'endpoint di autorizzazione restituisce un codice di autorizzazione di breve durata a Google, Google invia una richiesta all'endpoint di scambio dei token per scambiare il codice di autorizzazione con un token di accesso e un token di aggiornamento.

Per queste richieste, il valore di grant_type è authorization_code e il valore di code è il valore del codice di autorizzazione che hai precedentemente concesso a Google. Di seguito è riportato un esempio di richiesta di scambio di un codice di autorizzazione con un token di accesso e un token di aggiornamento:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

Per scambiare i codici di autorizzazione con un token di accesso e un token di aggiornamento, l'endpoint di scambio di token risponde alle richieste POST eseguendo i seguenti passaggi:

  1. Verifica che client_id identifichi l'origine della richiesta come un'origine autorizzata e che client_secret corrisponda al valore previsto.
  2. Verifica che il codice di autorizzazione sia valido e che non sia scaduto e che l'ID client specificato nella richiesta corrisponda all'ID client associato al codice di autorizzazione.
  3. Verifica che l'URL specificato dal parametro redirect_uri sia identico al valore utilizzato nella richiesta di autorizzazione iniziale.
  4. Se non riesci a verificare tutti i criteri riportati sopra, restituisci un errore HTTP 400 Bad Request con {"error": "invalid_grant"} come corpo.
  5. In caso contrario, utilizza lo User-ID del codice di autorizzazione per generare un token di aggiornamento e un token di accesso. Questi token possono essere di qualsiasi valore stringa, ma devono rappresentare in modo univoco l'utente e il client a cui è destinato il token e non devono essere indovinabili. Per i token di accesso, registra anche la data di scadenza del token, che di solito è un'ora dopo l'emissione. I token di aggiornamento non hanno scadenza.
  6. Restituisce il seguente oggetto JSON nel corpo della risposta HTTPS:
    {
    "token_type": "Bearer",
    "access_token": "ACCESS_TOKEN",
    "refresh_token": "REFRESH_TOKEN",
    "expires_in": SECONDS_TO_EXPIRATION
    }
    

Google archivia il token di accesso e il token di aggiornamento per l'utente e registra la scadenza del token di accesso. Alla scadenza del token di accesso, Google lo utilizza per ricevere un nuovo token di accesso dal tuo endpoint di scambio di token.

Token di aggiornamento Exchange per i token di accesso

Alla scadenza di un token di accesso, Google invia una richiesta al tuo endpoint di scambio di token per scambiare un token di aggiornamento con un nuovo token di accesso.

Per queste richieste, il valore di grant_type è refresh_token e il valore di refresh_token è il valore del token di aggiornamento che hai precedentemente concesso a Google. Di seguito è riportato un esempio di richiesta di scambio di un token di aggiornamento con un token di accesso:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Per scambiare un token di aggiornamento con un token di accesso, l'endpoint di scambio di token risponde alle richieste POST eseguendo i seguenti passaggi:

  1. Verifica che client_id identifichi l'origine della richiesta come Google e che client_secret corrisponda al valore previsto.
  2. Verifica che il token di aggiornamento sia valido e che l'ID client specificato nella richiesta corrisponda all'ID client associato al token di aggiornamento.
  3. Se non riesci a verificare tutti i criteri riportati sopra, restituisci un errore HTTP 400 Request errato con {"error": "invalid_grant"} come corpo.
  4. In caso contrario, utilizza lo User-ID del token di aggiornamento per generare un token di accesso. Questi token possono essere di qualsiasi valore stringa, ma devono rappresentare in modo univoco l'utente e il client a cui è destinato il token e non devono essere incerti. Per i token di accesso, registra anche la sua data di scadenza, in genere un'ora dopo l'emissione.
  5. Restituisce il seguente oggetto JSON nel corpo della risposta HTTPS:
    {
    "token_type": "Bearer",
    "access_token": "ACCESS_TOKEN",
    "expires_in": SECONDS_TO_EXPIRATION
    }

Handle userinfo requests

The userinfo endpoint is an OAuth 2.0 protected resource that return claims about the linked user. Implementing and hosting the userinfo endpoint is optional, except for the following use cases:

After the access token has been successfully retrieved from your token endpoint, Google sends a request to your userinfo endpoint to retrieve basic profile information about the linked user.

userinfo endpoint request headers
Authorization header The access token of type Bearer.

For example, if your userinfo endpoint is available at https://myservice.example.com/userinfo, a request might look like the following:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

For your userinfo endpoint to handle requests, do the following steps:

  1. Extract access token from the Authorization header and return information for the user associated with the access token.
  2. If the access token is invalid, return an HTTP 401 Unauthorized error with using the WWW-Authenticate Response Header. Below is an example of a userinfo error response:
    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: error="invalid_token",
    error_description="The Access Token expired"
    
    If a 401 Unauthorized, or any other unsuccessful error response is returned during the linking process, the error will be non-recoverable, the retrieved token will be discarded and the user will have to initiate the linking process again.
  3. If the access token is valid, return and HTTP 200 response with the following JSON object in the body of the HTTPS response:

    {
    "sub": "USER_UUID",
    "email": "EMAIL_ADDRESS",
    "given_name": "FIRST_NAME",
    "family_name": "LAST_NAME",
    "name": "FULL_NAME",
    "picture": "PROFILE_PICTURE",
    }
    
    If your userinfo endpoint returns an HTTP 200 success response, the retrieved token and claims are registered against the user's Google account.

    userinfo endpoint response
    sub A unique ID that identifies the user in your system.
    email Email address of the user.
    given_name Optional: First name of the user.
    family_name Optional: Last name of the user.
    name Optional: Full name of the user.
    picture Optional: Profile picture of the user.