Collegamento dell'Account Google a OAuth

Gli account vengono collegati utilizzando i flussi OAuth 2.0 impliciti e codice di autorizzazione standard di settore. Il servizio deve supportare gli endpoint di autorizzazione e scambio di token conformi a OAuth 2.0.

Nel flusso implicito, Google apre il tuo endpoint di autorizzazione nel browser dell'utente. Una volta eseguito l'accesso, restituisci un token di accesso di lunga durata a Google. Questo token di accesso è ora incluso in ogni richiesta inviata da Google.

Nel flusso del codice di autorizzazione sono necessari due endpoint:

• L'endpoint di autorizzazione, che mostra l'interfaccia utente 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, 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 segue il flusso di collegamento dell'account.
  2. Scambia un token di aggiornamento a lungo termine con un token di accesso a breve termine. Questo scambio avviene quando Google ha bisogno di un nuovo token di accesso perché quello in suo possesso è scaduto.

Scegliere un flusso OAuth 2.0

Sebbene il flusso implicito sia più semplice da implementare, Google consiglia di non far scadere mai i token di accesso emessi dal flusso implicito. Questo accade perché l'utente è costretto a collegare di nuovo il proprio account dopo la scadenza di un token con il flusso implicito. Se hai bisogno della scadenza del token per motivi di sicurezza, ti consigliamo vivamente di utilizzare il flusso del codice di autorizzazione.

Istruzioni sul design

Questa sezione descrive i requisiti di progettazione e i consigli per la schermata utente ospitata per i flussi di collegamento OAuth. Dopo essere stata richiamata dall'app di Google, la tua piattaforma mostra all'utente una schermata di accesso alla pagina Google e all'account per il consenso per il collegamento. L'utente viene reindirizzato all'app di Google dopo aver dato il suo consenso al collegamento degli 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.

Consigli

Ti consigliamo di procedere come segue:

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

2. Dati da condividere. Usa un linguaggio chiaro e conciso per spiegare all'utente quali dati di sua proprietà richiedono Google e perché.

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

4. Possibilità di annullare. Fornisci agli utenti un modo per tornare indietro o annullare, se scelgono di non eseguire il collegamento.

5. Cancella la procedura di accesso. Assicurati che gli utenti dispongano di un metodo chiaro per accedere al loro Account Google, ad esempio campi per nome utente e password o Accedi con Google.

6. Possibilità di scollegare. Offrire un meccanismo per consentire agli utenti di scollegare, ad esempio un URL alle impostazioni del loro account sulla tua piattaforma. In alternativa, puoi includere un link all'Account Google in cui gli utenti possono gestire il proprio account collegato.

7. Possibilità di modificare l'account utente. Suggerisci un metodo per consentire agli utenti di cambiare account. Questa opzione è particolarmente utile se gli utenti tendono ad avere più account.

   • Se un utente deve chiudere la schermata del consenso per cambiare account, invia un errore recuperabile a Google in modo che l'utente possa accedere all'account preferito con il collegamento OAuth e il flusso implicito.

8. Includi il tuo logo. Mostra il logo della tua azienda nella schermata del consenso. Utilizza le linee guida di stile per posizionare il logo. Se vuoi mostrare anche il logo di Google, consulta Loghi e marchi.

Crea il progetto

Per creare il tuo progetto in modo da utilizzare il collegamento dell'account:

1. Go to the Google API Console.
2. Fai clic su Crea progetto .
3. Inserisci un nome o accetta il suggerimento generato.
4. Conferma o modifica tutti i campi rimanenti.
5. Fai clic su Crea .

Per visualizzare l'ID del progetto:

1. Go to the Google API Console.
2. Trova il tuo progetto nella tabella nella pagina di destinazione. L'ID progetto viene visualizzato nella colonna ID .

Configura la schermata per il consenso OAuth

La procedura di collegamento dell'Account Google include una schermata per il consenso che indica agli utenti l'applicazione che richiede l'accesso ai loro dati, il tipo di dati richiesti e i termini applicabili. Devi configurare la schermata per il consenso OAuth prima di generare un ID client dell'API Google.

1. Apri la pagina Schermata per il consenso OAuth della console API Google.
2. Se richiesto, seleziona il progetto appena creato.

3. Nella pagina "Schermata consenso OAuth", compila il modulo e fai clic sul pulsante "Salva".

   Nome dell'applicazione:il nome dell'applicazione che richiede il consenso. Il nome deve rispecchiare accuratamente la tua applicazione ed essere coerente con il nome dell'applicazione che gli utenti vedono altrove. Il nome dell'applicazione verrà visualizzato nella schermata del consenso per il collegamento dell'account.

   Logo dell'applicazione: un'immagine nella schermata per il consenso che aiuterà gli utenti a riconoscere la tua app. Il logo viene visualizzato nella schermata per il consenso del collegamento dell'account e nelle impostazioni dell'account

   Indirizzo email dell'assistenza:per consentire agli utenti di contattarti per domande sul loro consenso.

   Ambiti per le API di Google:gli ambiti consentono alla tua applicazione di accedere ai dati privati di Google dell'utente. Per il caso d'uso Collegamento dell'Account Google, l'ambito predefinito (email, profilo, openid) è sufficiente, non è necessario aggiungere ambiti sensibili. In genere, è buona prassi richiedere gli ambiti in modo incrementale, al momento del bisogno, anziché in anticipo. Scopri di più.

   Domini autorizzati:per proteggere te e i tuoi utenti, Google consente l'utilizzo dei domini autorizzati solo alle applicazioni che si autenticano tramite OAuth. I link delle tue applicazioni devono essere ospitati su domini autorizzati. Scopri di più.

   Link alla home page dell'applicazione: home page della tua applicazione. Deve essere ospitato su un dominio autorizzato.

   Link alle norme sulla privacy dell'applicazione:visualizzato nella schermata del consenso per il collegamento dell'Account Google. Deve essere ospitato su un dominio autorizzato.

   (Facoltativo) Link ai Termini di servizio dell'applicazione: deve essere ospitato in un dominio autorizzato.

   

   Figura 1. Schermata del consenso per il collegamento dell'Account Google per un'applicazione fittizia, Tunery

4. Controlla "Stato verifica". Se la tua richiesta deve essere verificata, fai clic sul pulsante "Invia per la verifica" per inviarla. Per maggiori dettagli, consulta i requisiti per la verifica OAuth.

Implementa il server OAuth

Un'implementazione server OAuth 2.0 del flusso del codice di autorizzazione è composta da due endpoint, che il tuo servizio rende disponibili tramite HTTPS. Il primo endpoint è l'endpoint di autorizzazione, responsabile di trovare il consenso degli utenti all'accesso ai dati. L'endpoint di autorizzazione presenta che consente agli utenti che non hanno ancora effettuato l'accesso e che registrano il consenso l'accesso richiesto. Il secondo endpoint è quello di scambio di token, viene utilizzato per ottenere stringhe criptate, chiamate token, che autorizzano un utente a per accedere al tuo servizio.

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

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

1. Google apre il tuo endpoint di autorizzazione nel browser dell'utente. Se il flusso avviato su un dispositivo con solo comandi vocali per un'azione, Google trasferisce o l'esecuzione di queste query a un telefono.
2. L'utente esegue l'accesso (se non l'ha già fatto) e concede a Google l'autorizzazione per accedere ai propri dati con la tua API, se non hanno già concesso l'autorizzazione.
3. Il servizio crea un codice di autorizzazione e lo restituisce a Google. Da fare Devi quindi reindirizzare il browser dell'utente a Google con il codice di autorizzazione in allegato alla richiesta.
4. Google invia il codice di autorizzazione al tuo endpoint di scambio di token, che consente di verificare l'autenticità del codice e restituisce un token di accesso e un token di aggiornamento. Il token di accesso è un token di breve durata che il tuo servizio accetta come credenziali per accedere alle API. Il token di aggiornamento è un token di token che Google può archiviare e utilizzare per acquisire nuovi token di accesso quando scadono.
5. Dopo che l'utente ha completato il flusso di collegamento dell'account, ogni richiesta inviata da Google contiene un token di accesso.

Gestire le richieste di autorizzazione

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

Ad esempio, se l'endpoint di autorizzazione è disponibile su 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 passaggi:

1. Verifica che il client_id corrisponda all'ID client che hai assegnato a Google e che il valore redirect_uri corrisponda all'URL di reindirizzamento fornito da Google per il tuo servizio. Questi controlli sono importanti per evitare di concedere ad app client indesiderate o configurate in modo errato. Se supporti più Flussi OAuth 2.0, verifica inoltre che response_type sia code.
2. Verifica se l'utente ha eseguito l'accesso al tuo servizio. Se l'utente non ha eseguito l'accesso, completare la procedura di accesso o di registrazione al servizio.
3. Genera un codice di autorizzazione che Google dovrà utilizzare per accedere all'API. Il codice di autorizzazione può essere qualsiasi valore stringa, ma deve essere univoco rappresentano l'utente, il client a cui è destinato il token e la scadenza del codice e non deve essere indovibile. Di solito concedi l'autorizzazione che scadono dopo circa 10 minuti.
4. Verifica che l'URL specificato dal parametro redirect_uri abbia il valore modulo seguente:

     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 nel Parametro redirect_uri. Includi il codice di autorizzazione appena generato e il valore originale dello stato non modificato quando reindirizzi aggiungendo i parametri code e state. Di seguito è riportato un esempio dell'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 tuo servizio è responsabile di due tipi di token piattaforme di scambio pubblicitario:

• Scambia codici di autorizzazione con token di accesso e token di aggiornamento
• Scambia i token di aggiornamento per i token di accesso

Le richieste di scambio di token includono i seguenti parametri:

Scambia codici di autorizzazione con token di accesso e token di aggiornamento

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

Per queste richieste, il valore di grant_type è authorization_code e il valore di code è il valore del codice di autorizzazione concesso in precedenza a Google. Di seguito è riportato un esempio di richiesta di scambio un codice di autorizzazione per 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 dello scambio di token risponde alle richieste POST eseguendo questo comando passaggi:

1. Verifica che client_id identifichi l'origine della richiesta come autorizzata e che client_secret corrisponda al valore previsto.
2. Verifica che il codice di autorizzazione sia valido e non scaduto e che il codice L'ID client specificato nella richiesta corrisponde 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 precedenti, restituisci una richiesta HTTP 400 Errore di richiesta non valida con {"error": "invalid_grant"} come corpo.
5. Altrimenti, utilizza l'ID utente del codice di autorizzazione per generare un aggiornamento e un token di accesso. Questi token possono essere qualsiasi valore stringa, ma Deve rappresentare in modo univoco l'utente e il client a cui è destinato il token. non deve essere indovinabile. Per i token di accesso, registra anche la scadenza il token, che in genere corrisponde a un'ora dopo l'emissione. I token di aggiornamento non hanno scadenza.
6. Restituisci 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 i record la scadenza del token di accesso. Alla scadenza del token di accesso, Google utilizza il token di aggiornamento per riceverne uno nuovo dall'endpoint di scambio di token.

Scambia i token di aggiornamento per i token di accesso

Quando un token di accesso scade, Google invia una richiesta allo 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 concesso in precedenza in tutti i canali Google. Di seguito è riportato un esempio di richiesta per lo scambio di un token di aggiornamento per 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 dei token risponde alle richieste POST eseguendo questi passaggi:

1. Verifica che client_id identifichi l'origine della richiesta come Google. che client_secret corrisponda al valore previsto.
2. Verifica che il token di aggiornamento sia valido e che l'ID client specificato corrisponda all'ID client associato al token di aggiornamento.
3. Se non riesci a verificare tutti i criteri precedenti, restituisci un errore HTTP 400 Errore di richiesta non valido con {"error": "invalid_grant"} come corpo.
4. In caso contrario, utilizza l'ID utente del token di aggiornamento per generare un accesso di accesso. Questi token possono essere qualsiasi valore stringa, ma devono essere univoci rappresentano l'utente e il client a cui è destinato il token e non devono essere ipotizzabile. Per i token di accesso, registra anche la scadenza del token, in genere un'ora dopo l'emissione del token.
5. Restituisci il seguente oggetto JSON nel corpo del file HTTPS risposta:

   {
   "token_type": "Portatore",
   "access_token": "ACCESS_TOKEN",
   "scadenza_in": SECONDS_TO_EXPIRATION
   }

Gestire le richieste di informazioni utente

L'endpoint userinfo è una risorsa protetta da OAuth 2.0 che restituisce attestazioni sull'utente collegato. L'implementazione e l'hosting dell'endpoint userinfo sono facoltative, ad eccezione dei seguenti casi d'uso:

• Accesso a un account collegato con Google One Tap.
• Abbonamento senza problemi su AndroidTV.

Dopo che il token di accesso è stato recuperato correttamente dall'endpoint del token, Google invia una richiesta all'endpoint userinfo per recuperare le informazioni di base del profilo dell'utente collegato.

Ad esempio, se l'endpoint userinfo è disponibile su https://myservice.example.com/userinfo, una richiesta potrebbe avere il seguente aspetto:

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

Affinché l'endpoint userinfo possa gestire le richieste, segui questi passaggi:

1. Estrai il token di accesso dall'intestazione Autorizzazione e restituisci le informazioni per l'utente associato al token di accesso.
2. Se il token di accesso non è valido, restituisce un errore HTTP 401 Autorizzazione non autorizzata utilizzando l'intestazione della risposta WWW-Authenticate. Di seguito è riportato un esempio di risposta di errore userinfo:

   HTTP/1.1 401 Unauthorized
   WWW-Authenticate: error="invalid_token",
   error_description="The Access Token expired"
   

   Se durante la procedura di collegamento viene restituito un errore 401 Autorizzazione o qualsiasi altra risposta di errore non riuscita durante la procedura di collegamento, l'errore non sarà recuperabile, il token recuperato verrà eliminato e l'utente dovrà avviare nuovamente la procedura di collegamento.

3. Se il token di accesso è valido, restituisce e invia una risposta HTTP 200 con il seguente oggetto JSON nel corpo dell'HTTPS risposta:

   {
   "sub": "USER_UUID",
   "email": "EMAIL_ADDRESS",
   "given_name": "FIRST_NAME",
   "family_name": "LAST_NAME",
   "name": "FULL_NAME",
   "picture": "PROFILE_PICTURE",
   }
   

   Se l'endpoint userinfo restituisce una risposta HTTP 200 riuscita, il token e le attestazioni recuperati vengono registrati in base all'Account Google dell'utente.

   risposta endpoint userinfo
   sub	Un ID univoco che identifica l'utente nel sistema.
   email	Indirizzo email dell'utente.
   given_name	Facoltativo:nome dell'utente.
   family_name	Facoltativo:il cognome dell'utente.
   name	Facoltativo:nome completo dell'utente.
   picture	(Facoltativo) Immagine del profilo dell'utente.

Convalidare l'implementazione

You can validate your implementation by using the OAuth 2.0 Playground tool.

In the tool, do the following steps:

1. Click Configuration settings to open the OAuth 2.0 Configuration window.
2. In the OAuth flow field, select Client-side.
3. In the OAuth Endpoints field, select Custom.
4. Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
5. In the Step 1 section, don't select any Google scopes. Instead, leave this field blank or type a scope valid for your server (or an arbitrary string if you don't use OAuth scopes). When you're done, click Authorize APIs.
6. In the Step 2 and Step 3 sections, go through the OAuth 2.0 flow and verify that each step works as intended.

You can validate your implementation by using the Google Account Linking Demo tool.

In the tool, do the following steps:

1. Click the Sign-in with Google button.
2. Choose the account you'd like to link.
3. Enter the service ID.
4. Optionally enter one or more scopes that you will request access for.
5. Click Start Demo.
6. When prompted, confirm that you may consent and deny the linking request.
7. Confirm that you are redirected to your platform.