Łączenie konta Google z protokołem OAuth

Konta są łączone przy użyciu standardowych przepływów protokołu OAuth 2.0 i kodu autoryzacji. Twoja usługa musi obsługiwać punkty końcowe autoryzacji zgodnej z protokołem OAuth 2.0 i punkty końcowe tokena.

W ramach procesu domyślnego Google otwiera punkt końcowy autoryzacji w przeglądarce użytkownika. Po udanym logowaniu zwracasz do Google token dostępu o dłuższej długości. Ten token dostępu jest teraz dołączany do każdego żądania wysyłanego przez Google.

W procesie kodu autoryzacji potrzebujesz 2 punktów końcowych:

  • Punkt końcowy autoryzacji, który wyświetla interfejs logowania użytkownikom, którzy jeszcze nie są zalogowani. Punkt końcowy autoryzacji tworzy też krótki kod autoryzacji do rejestrowania użytkowników i uzyskiwania zgody na żądany dostęp.

  • Punkt końcowy token Exchange, który jest odpowiedzialny za 2 typy giełd:

    1. Wymiana kodu autoryzacji dla długotrwałego tokenu odświeżania i krótkoterminowego tokena dostępu. Wymiana następuje, gdy użytkownik przeprowadzi proces łączenia kont.
    2. Wymiana tokenu odświeżania o długim czasie ważności na token dostępu o krótkim czasie ważności. Ta wymiana ma miejsce, gdy Google potrzebuje nowego tokena dostępu, ponieważ wygasł.

Wybierz przepływ OAuth 2.0

Chociaż procedura domyślna jest prostsza, zalecamy, by tokeny dostępu domyślnie ustały. Dzieje się tak, ponieważ użytkownik jest zmuszony ponownie połączyć swoje konto po wygaśnięciu tokena w wynikowy sposób. Jeśli ze względów bezpieczeństwa zależy Ci na wygaśnięciu tokena, zdecydowanie zalecamy użycie procesu kodu autoryzacji.

Wskazówki dotyczące wyglądu

W tej sekcji opisano wymagania projektowe i zalecenia dotyczące ekranu użytkownika hostowanego przez proces łączenia OAuth. Po wywołaniu jej przez aplikację Google na Twojej platformie wyświetla się ekran logowania na stronie Google, a użytkownik wyraża zgodę na połączenie konta. Gdy użytkownik wyrazi zgodę na połączenie kont, zostanie przekierowany z powrotem do aplikacji Google.

Ten wykres przedstawia czynności, jakie musi wykonać użytkownik, aby połączyć swoje konto Google z Twoim systemem uwierzytelniania. Pierwszy zrzut ekranu przedstawia linki inicjowane przez użytkownika na Twojej platformie. Drugi obraz przedstawia logowanie użytkownika w Google, a trzeci – zgodę użytkownika i jego potwierdzenie na potrzeby połączenia konta Google z aplikacją. Ostatni zrzut ekranu przedstawia połączone konto użytkownika w aplikacji Google.
Rysunek 1. Łączenie kont loguje się w Google i na ekranach zgody.

Wymagania

  1. Musisz poinformować, że konto użytkownika zostanie połączone z Google, a nie z konkretną usługą Google, taką jak Google Home czy Asystent Google.

Zalecenia

Zalecamy wykonanie tych czynności:

  1. Wyświetl Politykę prywatności Google Podaj na ekranie zgody link do Polityki prywatności Google.

  2. Dane do udostępnienia. Stosuj jasne i zwięzłe sformułowania, których użytkownik potrzebuje, i wyjaśnij, jakich danych Google potrzebuje i dlaczego.

  3. Stosuj jednoznaczne wezwania do działania. Jasno umieść wezwanie do działania na ekranie zgody, np. „Zgadzam się i łączę”. Użytkownicy muszą wiedzieć, jakie dane muszą udostępnić Google, by połączyć swoje konta.

  4. Możliwość anulowania. Zapewnij użytkownikom możliwość powrotu lub anulowania subskrypcji, jeśli nie chcą tworzyć linków.

  5. Przejrzysty proces logowania. Upewnij się, że użytkownicy mają wyraźną metodę logowania się na swoje konto Google, np. pola do wpisania nazwy użytkownika i hasła lub logowania się przez Google.

  6. Możliwość odłączenia. Udostępnij użytkownikom mechanizm odłączenia kont, na przykład URL do ustawień ich konta na Twojej platformie. Możesz też podać link do konta Google, na którym użytkownicy mogą zarządzać swoim połączonym kontem.

  7. Możliwość zmiany konta użytkownika. Zasugeruj użytkownikom zmianę swojego konta. Jest to szczególnie przydatne, gdy użytkownicy mają zwykle kilka kont.

    • Jeśli użytkownik musi zamknąć ekran zgody, aby przełączyć konta, wyślij do Google opis możliwego do odzyskania błędu, aby mógł zalogować się na wybrane konto przy użyciu łączenia OAuth i procesu domyślnego.

  8. Logo. Wyświetlaj logo swojej firmy na ekranie zgody. Umieść swoje logo zgodnie ze wskazówkami dotyczącymi stylu. Jeśli chcesz też wyświetlać logo Google, zobacz Logo i znaki towarowe.

Create the project

To create your project to use account linking:

  1. Go to the Google API Console.
  2. Kliknij Utwórz projekt .
  3. Wpisz nazwę lub zaakceptuj wygenerowaną sugestię.
  4. Potwierdź lub edytuj pozostałe pola.
  5. Kliknij Utwórz .

Aby wyświetlić identyfikator projektu:

  1. Go to the Google API Console.
  2. Znajdź swój projekt w tabeli na landing page. Identyfikator projektu pojawia się w kolumnie ID .

The Google Account Linking process includes a consent screen which tells users the application requesting access to their data, what kind of data they are asking for and the terms that apply. You will need to configure your OAuth consent screen before generating a Google API client ID.

  1. Open the OAuth consent screen page of the Google APIs console.
  2. If prompted, select the project you just created.

  3. On the "OAuth consent screen" page, fill out the form and click the “Save” button.

    Application name: The name of the application asking for consent. The name should accurately reflect your application and be consistent with the application name users see elsewhere. The application name will be shown on the Account Linking consent screen.

    Application logo: An image on the consent screen that will help users recognize your app. The logo is shown on Account linking consent screen and on account settings

    Support email: For users to contact you with questions about their consent.

    Scopes for Google APIs: Scopes allow your application to access your user's private Google data. For the Google Account Linking use case, default scope (email, profile, openid) is sufficient, you don’t need to add any sensitive scopes. It is generally a best practice to request scopes incrementally, at the time access is required, rather than up front. Learn more.

    Authorized domains: To protect you and your users, Google only allows applications that authenticate using OAuth to use Authorized Domains. Your applications' links must be hosted on Authorized Domains. Learn more.

    Application Homepage link: Home page for your application. Must be hosted on an Authorized Domain.

    Application Privacy Policy link: Shown on Google Account Linking consent screen. Must be hosted on an Authorized Domain.

    Application Terms of Service link (Optional): Must be hosted on an Authorized Domain.

    Figure 1. Google Account Linking Consent Screen for a fictitious Application, Tunery

  4. Check "Verification Status", if your application needs verification then click the "Submit For Verification" button to submit your application for verification. Refer to OAuth verification requirements for details.

Implementowanie serwera OAuth

OAuth implementacja serwera 2,0 przepływu kodu autoryzacji składa się z dwóch punktów końcowych, które sprawia, że usługa dostępna przez HTTPS. Pierwszym punktem końcowym jest punkt końcowy autoryzacji, który odpowiada za znalezienie lub uzyskanie zgody użytkowników na dostęp do danych. Punkt końcowy autoryzacji przedstawia interfejs logowania użytkownikom, którzy nie są jeszcze zalogowani, i rejestruje zgodę na żądany dostęp. Drugim punktem końcowym jest punkt końcowy wymiany tokenów, który służy do uzyskiwania zaszyfrowanych ciągów, zwanych tokenami, które autoryzują użytkownika do dostępu do Twojej usługi.

Gdy aplikacja Google musi wywołać jeden z interfejsów API Twojej usługi, Google używa tych punktów końcowych razem, aby uzyskać od użytkowników uprawnienia do wywoływania tych interfejsów API w ich imieniu.

Sesja przepływu kodu autoryzacji OAuth 2.0 zainicjowana przez Google ma następujący przepływ:

  1. Google otwiera Twój punkt końcowy autoryzacji w przeglądarce użytkownika. Jeśli przepływ akcji rozpoczął się na urządzeniu obsługującym tylko głos, Google przeniesie wykonanie na telefon.
  2. Użytkownik loguje się, jeśli jeszcze się nie zalogował, i udziela Google pozwolenia na dostęp do swoich danych za pomocą Twojego interfejsu API, jeśli jeszcze nie udzielił pozwolenia.
  3. Usługa tworzy kod autoryzacji i zwraca go do Google. W tym celu przekieruj przeglądarkę użytkownika z powrotem do Google z kodem autoryzacyjnym dołączonym do żądania.
  4. Google wysyła kod autoryzacji do tokenu końcowego wymiany, który weryfikuje autentyczność kod i zwraca token dostępu i odświeżenie tokena. Token dostępu to krótkotrwały token, który Twoja usługa akceptuje jako dane logowania umożliwiające dostęp do interfejsów API. Token odświeżania to trwały token, który Google może przechowywać i używać do uzyskiwania nowych tokenów dostępu po ich wygaśnięciu.
  5. Gdy użytkownik zakończy proces łączenia kont, każde kolejne żądanie wysłane z Google zawiera token dostępu.

Obsługuj żądania autoryzacji

Gdy musisz wykonać połączenie kont przy użyciu przepływu kodu autoryzacji OAuth 2.0, Google wysyła użytkownika do Twojego punktu końcowego autoryzacji z żądaniem zawierającym następujące parametry:

Parametry punktu końcowego autoryzacji
client_id Identyfikator klienta przypisany do Google.
redirect_uri Adres URL, na który wysyłasz odpowiedź na to żądanie.
state Wartość księgowa przekazywana z powrotem do Google bez zmian w identyfikatorze URI przekierowania.
scope Opcjonalnie: Przestrzeń rozdzielany zbiór ciągów określających zakres danych Google z prośbą o pozwolenie.
response_type Typ wartości do zwrócenia w odpowiedzi. Do autoryzacji OAuth 2.0 przepływ kodu typu reakcja jest zawsze code .
user_locale Ustawienie języka konto Google w RFC5646 formacie, używane do lokalizowania treści w preferowanym języku użytkownika.

Na przykład, jeśli końcowy autoryzacji jest dostępny na https://myservice.example.com/auth , wniosek może wyglądać następująco:

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

Aby punkt końcowy autoryzacji obsługiwał żądania logowania, wykonaj następujące czynności:

  1. Sprawdź, czy client_id dopasowuje identyfikator klienta przypisany do Google, i że redirect_uri mecze przekierowanie udostępnianej przez Google dla swojej usługi. Te kontrole są ważne, aby zapobiec przyznawaniu dostępu do niezamierzonych lub błędnie skonfigurowanych aplikacji klienckich. Jeśli obsługiwać wiele przepływów OAuth 2.0, także potwierdzają, że response_type jest code .
  2. Sprawdź, czy użytkownik jest zalogowany do Twojej usługi. Jeśli użytkownik nie jest zalogowany, dokończ proces logowania lub rejestracji w usłudze.
  3. Wygeneruj kod autoryzacyjny, którego Google użyje, aby uzyskać dostęp do Twojego interfejsu API. Kod autoryzacji może być dowolną wartością ciągu, ale musi jednoznacznie reprezentować użytkownika, klienta, dla którego jest przeznaczony token, oraz czas wygaśnięcia kodu i nie może być możliwy do odgadnięcia. Zazwyczaj wydajesz kody autoryzacyjne, które wygasają po około 10 minutach.
  4. Potwierdź, że adres URL podany przez redirect_uri parametr ma następującą postać: 
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
  https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
  5. Przekierować przeglądarkę użytkownika do adresu URL określonego przez redirect_uri parametru. Zawierać kod autoryzacji po prostu generowane i pierwotnym, niezmodyfikowanym wartość stanu po przekierowaniu przez dołączanie code i state parametry. Poniżej znajduje się przykład powstałego URL: 
    https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Obsługuj żądania wymiany tokenów

Punkt końcowy wymiany tokenów Twojej usługi jest odpowiedzialny za dwa rodzaje wymiany tokenów:

  • Wymiana kodów autoryzacyjnych na tokeny dostępu i tokeny odświeżania
  • Wymień tokeny odświeżania na tokeny dostępu

Żądania wymiany tokenów zawierają następujące parametry:

Parametry punktu końcowego wymiany tokenów
client_id Ciąg znaków identyfikujący źródło żądania jako Google. Ten ciąg musi być zarejestrowany w Twoim systemie jako unikalny identyfikator Google.
client_secret Tajny ciąg znaków zarejestrowany w Google dla Twojej usługi.
grant_type Rodzaj wymienianego tokena. To albo authorization_code lub refresh_token .
code Kiedy grant_type=authorization_code , parametr ten jest kod Google otrzymał z dysku się lub tokena końcowym wymiany.
redirect_uri Kiedy grant_type=authorization_code , parametr ten jest adres URL używany w początkowym wniosku o udzielenie zezwolenia.
refresh_token Kiedy grant_type=refresh_token , parametr ten jest odświeżenie tokena Google otrzymał od symbolicznego punktu końcowego wymiany.
Wymiana kodów autoryzacyjnych na tokeny dostępu i tokeny odświeżania

Gdy użytkownik się zaloguje, a punkt końcowy autoryzacji zwróci do Google krótkotrwały kod autoryzacji, Google wyśle ​​do punktu końcowego wymiany tokenów żądanie wymiany kodu autoryzacji na token dostępu i token odświeżania.

Do tych wniosków, wartość grant_type jest authorization_code , a wartość code jest wartością kodu autoryzacji wcześniej udzielonego Google. Poniżej znajduje się przykład żądania wymiany kodu autoryzacyjnego na token dostępu i token odświeżania:

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

Wymieniać kody autoryzacji na token dostępu i odświeżania token token reaguje końcowych wymiana do POST żądań, wykonując następujące kroki:

  1. Sprawdź, czy client_id identyfikuje pochodzenie żądanie jako autoryzowany pochodzenia i że client_secret odpowiada wartości oczekiwanej.
  2. Sprawdź, czy kod autoryzacji jest poprawny i nie wygasł oraz czy identyfikator klienta określony w żądaniu jest zgodny z identyfikatorem klienta powiązanym z kodem autoryzacji.
  3. Potwierdź, że adres URL podany przez redirect_uri parametru jest identyczny do wartości stosowanej w pierwotnym wniosku o udzielenie zezwolenia.
  4. Jeśli nie można zweryfikować wszystkie powyższe kryteria, zwróci błąd HTTP 400 Bad Request z {"error": "invalid_grant"} co korpus.
  5. W przeciwnym razie użyj identyfikatora użytkownika z kodu autoryzacji, aby wygenerować token odświeżania i token dostępu. Te tokeny mogą być dowolną wartością ciągu, ale muszą jednoznacznie reprezentować użytkownika i klienta, dla którego przeznaczony jest token, i nie mogą być odgadnięte. W przypadku tokenów dostępu zanotuj również czas wygaśnięcia tokenu, który zwykle wynosi godzinę po wystawieniu tokenu. Tokeny odświeżania nie wygasają.
  6. Powrót następujący obiekt JSON w organizmie odpowiedzi https:
    {
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"refresh_token": "REFRESH_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

Google przechowuje token dostępu i token odświeżania dla użytkownika oraz rejestruje wygaśnięcie tokenu dostępu. Gdy token dostępu wygaśnie, Google używa tokenu odświeżania, aby uzyskać nowy token dostępu z punktu końcowego wymiany tokenów.

Wymień tokeny odświeżania na tokeny dostępu

Gdy token dostępu wygaśnie, Google wysyła do punktu końcowego wymiany tokenów żądanie wymiany tokenu odświeżania na nowy token dostępu.

Do tych wniosków, wartość grant_type jest refresh_token , a wartość refresh_token jest wartością odświeżania żeton wcześniej udzielonego Google. Poniżej znajduje się przykład żądania wymiany tokenu odświeżania na token dostępu:

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

Do wymiany odświeżenia token token dostępu token reaguje końcowych wymiana do POST żądań, wykonując następujące kroki:

  1. Sprawdź, czy client_id identyfikuje pochodzenie prośba jak Google, i że client_secret zgodna z wartością oczekiwaną.
  2. Sprawdź, czy znacznik odświeżania jest poprawny i czy identyfikator klienta określony w żądaniu jest zgodny z identyfikatorem klienta powiązanym ze znacznikiem odświeżania.
  3. Jeśli nie można zweryfikować wszystkie powyższe kryteria, zwróci błąd HTTP 400 Bad Request z {"error": "invalid_grant"} co korpus.
  4. W przeciwnym razie użyj identyfikatora użytkownika z tokenu odświeżania, aby wygenerować token dostępu. Te tokeny mogą być dowolną wartością ciągu, ale muszą jednoznacznie reprezentować użytkownika i klienta, dla którego przeznaczony jest token, i nie mogą być odgadnięte. W przypadku tokenów dostępu zanotuj również czas wygaśnięcia tokenu, zwykle godzinę po wystawieniu tokenu.
  5. Zwróć następujący obiekt JSON w treści odpowiedzi 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.

Sprawdzanie poprawności implementacji

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

In the tool, do the following steps:

  1. Click Configuration 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.