OAuth ile Google Hesabı Bağlama

Hesaplar, sektör standardı OAuth 2.0 örtülü ve yetkilendirme kodu akışları kullanılarak bağlanır. Hizmetiniz OAuth 2.0 uyumlu yetkilendirmeyi ve jeton değişimi uç noktalarını desteklemelidir.

在隐式流程中，Google 会在用户的浏览器中打开您的授权端点。成功登录后，系统会将长期访问令牌返回到 Google。现在，从 Google 发送的每个请求中都包含此访问令牌。

在授权代码流程中，您需要两个端点：

• 授权端点 - 向尚未登录的用户显示登录界面。授权端点还会创建一个短期授权代码，用于记录用户针对所请求的访问权限的同意情况。

• 令牌交换端点，负责两种交换类型：

  1. 将授权代码交换为长期刷新令牌和短期访问令牌。这种交换会在用户完成帐号关联流程时进行。
  2. 将长期有效的刷新令牌交换为短期访问令牌。当 Google 需要新的访问令牌时，由于此令牌已过期，因此出现这种交换。

选择 OAuth 2.0 流程

虽然隐式数据流的实现过程更简单，但 Google 建议隐式数据流签发的访问令牌永远不会过期。这是因为在令牌随隐式流程过期后，用户被迫再次关联自己的帐号。出于安全考虑，如果您需要令牌过期，我们强烈建议您改为使用授权代码流程。

注意：使用以下按钮选择要实现的 OAuth 2.0 流程。如有必要，本指南的内容将重新加载以符合您的选择。

隐式流程 授权代码

设计准则

本部分将介绍针对 OAuth 关联流程托管的用户屏幕的设计要求和建议。在由 Google 的应用调用后，您的平台会向用户显示“登录 Google”页面和帐号关联屏幕。用户同意关联帐号后，会被重定向回 Google 的应用。

图 1.帐号关联用户登录 Google 和同意屏幕。

要求

1. 您必须告知用户该用户帐号将与 Google 关联，而不是与特定 Google 产品（例如 Google Home 或 Google 助理）关联。

建议

建议您执行以下操作：

1. 显示 Google 的隐私权政策。在同意屏幕上添加指向 Google 隐私权政策的链接。

2. 要共享的数据。使用简洁明了的语言向用户说明他们的 Google 需要哪些数据以及为何收集这些数据。

3. 明确的号召性用语。在同意屏幕上提供明确的号召性用语，例如“同意并关联”。这是因为用户需要了解他们需要与 Google 共享哪些数据，才能关联帐号。

4. 能够取消。如果用户不关联，则可以提供返回或取消的方式。

5. 清除登录流程。确保用户有明确的登录 Google 帐号的方法，例如用户名和密码字段或使用 Google 帐号登录字段。

6. 能够解除关联。为用户提供解除关联的机制，例如他们在平台上的帐号设置网址。或者，您也可以添加指向 Google 帐号的链接，以便用户可以管理关联的帐号。

7. 能够更改用户帐号。推荐一种供用户切换帐号的方法。如果用户往往拥有多个帐号，这一点尤其有用。

   • 如果用户必须关闭同意屏幕才能切换帐号，请向 Google 发送一个可恢复错误，以便用户通过 OAuth 关联和隐式流程登录所需帐号。

8. 添加徽标。在同意屏幕上显示公司徽标。 根据样式指南放置徽标。如果您还希望显示 Google 的徽标，请参阅徽标和商标。

图 2.关于用户登录 Google 和同意屏幕的设计准则。

创建项目

注意 ：您可以重复使用现有项目，而无需主要为了关联帐号而创建新项目。

如需创建项目以使用帐号关联，请按以下步骤操作：

1. Go to the Google API Console.
2. Proje oluştur'u tıklayın.
3. Bir ad girin veya oluşturulan öneriyi kabul edin.
4. Kalan alanları onaylayın veya düzenleyin.
5. Oluştur'u tıklayın.

Proje kimliğinizi görüntülemek için:

1. Go to the Google API Console.
2. Projenizi açılış sayfasındaki tabloda bulun. Proje kimliği Kimlik sütununda görünür.

配置 OAuth 权限请求页面

Google 帐号关联流程包括一个同意屏幕，用于告知用户请求访问其数据的应用、用户要求的数据类型以及适用的条款。您需要先配置 OAuth 权限请求页面，然后才能生成 Google API 客户端 ID。

1. 打开 Google API 控制台的 OAuth 同意屏幕页面。
2. 如果出现提示，请选择您刚刚创建的项目。

3. 在“OAuth 同意屏幕”页面上，填写表单，然后点击“保存”按钮。

   应用名称：请求用户同意的应用的名称。该名称应准确反映您的应用，并与用户在别处看到的应用名称保持一致。应用名称将显示在帐号关联同意屏幕上。

   应用徽标：同意屏幕上的图片，有助于用户识别您的应用。徽标会显示在帐号关联同意屏幕和帐号设置中

   支持电子邮件地址：供用户就其同意情况与您联系。

   Google API 的范围：范围允许您的应用访问用户的私有 Google 数据。对于 Google 帐号关联用例，默认范围（电子邮件、个人资料、OpenID）就足够了，您无需添加任何敏感范围。最佳做法一般是在需要访问时逐步请求作用域，而不是预先请求。了解详情。

   已获授权的网域：为保护您和您的用户，Google 仅允许使用 OAuth 进行身份验证的应用使用已获授权的网域。您应用的链接必须托管在已获授权的网域上。了解详情。

   应用首页链接：您的应用的首页。必须托管在已获授权的网域上。

   应用隐私权政策链接：在 Google 帐号关联同意屏幕上显示。必须托管在已获授权的网域上。

   应用服务条款链接（可选）：必须托管在已获授权的网域上。

   

   图 1. 一款虚构应用 Tunery 的 Google 帐号关联同意屏幕

4. 查看“验证状态”。如果您的申请需要验证，请点击“提交验证”按钮，提交您的申请。如需了解详情，请参阅 OAuth 验证要求。

OAuth sunucunuzu uygulama

Yetki kodu akışının OAth 2.0 sunucu uygulaması servis HTTPS tarafından kullanılabilir hale getirir iki uç nokta oluşur. İlk uç nokta, veri erişimi için kullanıcıların onayını bulmaktan veya almaktan sorumlu olan yetkilendirme uç noktasıdır. Yetkilendirme uç noktası, henüz oturum açmamış olan kullanıcılarınıza bir oturum açma kullanıcı arabirimi sunar ve istenen erişime yönelik onayları kaydeder. İkinci uç nokta, bir kullanıcının hizmetinize erişmesine izin veren, belirteç adı verilen şifreli dizeleri elde etmek için kullanılan belirteç değişimi bitiş noktasıdır.

Bir Google uygulamasının hizmetinizin API'lerinden birini çağırması gerektiğinde, Google, kullanıcılarınızdan bu API'leri onlar adına çağırma izni almak için bu uç noktaları birlikte kullanır.

Google tarafından başlatılan bir OAuth 2.0 yetkilendirme kodu akışı oturumu aşağıdaki akışa sahiptir:

1. Google, yetkilendirme uç noktanızı kullanıcının tarayıcısında açar. Bir İşlem için akış yalnızca sesli bir cihazda başladıysa Google, yürütmeyi bir telefona aktarır.
2. Kullanıcı, henüz oturum açmadıysa oturum açar ve henüz izin vermemişse Google'a API'niz ile verilerine erişme izni verir.
3. Servis bir yetkilendirme kodu oluşturur ve Google'a döndürür. Bunu yapmak için, isteğe bağlı yetkilendirme koduyla kullanıcının tarayıcısını Google'a geri yönlendirin.
4. Google koduna orijinalliğini doğrular ve bir erişim belirteci ve bir yenileme jetonu döndürdüğünü parçacık değişiminde son nokta, yetkilendirme kodu gönderir. Erişim belirteci, hizmetinizin API'lere erişmek için kimlik bilgileri olarak kabul ettiği kısa ömürlü bir belirteçtir. Yenileme belirteci, Google'ın depolayabileceği ve süresi dolduğunda yeni erişim belirteçleri almak için kullanabileceği uzun ömürlü bir belirteçtir.
5. Kullanıcı hesap bağlama akışını tamamladıktan sonra, Google'dan gönderilen sonraki her istek bir erişim belirteci içerir.

Yetkilendirme isteklerini işleme

OAuth 2.0 yetkilendirme kodu akışını kullanarak hesap bağlama gerçekleştirmeniz gerektiğinde Google, aşağıdaki parametreleri içeren bir istekle kullanıcıyı yetkilendirme uç noktanıza gönderir:

Yetkilendirme uç noktası parametreleri
client_id	Google'a atadığınız Müşteri Kimliği.
redirect_uri	Bu isteğe yanıt gönderdiğiniz URL.
state	Yönlendirme URI'sinde değiştirilmeden Google'a geri gönderilen bir defter tutma değeri.
scope	İsteğe bağlı: Google için yetki isteyen verileri belirtmek kapsamı dizeleri boşlukla sınırlandırılmış seti.
response_type	Yanıtta döndürülecek değer türü. OAuth 2.0 yetkilendirme kodu akışı için, yanıt türü daima code .
user_locale	Google Hesabı dil ayarı RFC5646 kullanıcının tercih ettiği dilde içeriği lokalize için kullanılan biçimi.

Yetkilendirme son nokta mevcuttur Örneğin, https://myservice.example.com/auth bir istek aşağıdaki gibi görünebilir:

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

Yetkilendirme uç noktanızın oturum açma isteklerini işlemesi için aşağıdaki adımları uygulayın:

1. Doğrulayın client_id Google'a atanan İstemci Kimliği ile eşleşir ve redirect_uri hizmetinize Google tarafından sağlanan yönlendirme URL'sini eşleşir. Bu kontroller, istenmeyen veya yanlış yapılandırılmış istemci uygulamalarına erişim verilmesini önlemek için önemlidir. Birden OAuth 2.0 akışlarını destekleyen varsa da teyit response_type olan code .
2. Kullanıcının hizmetinizde oturum açıp açmadığını kontrol edin. Kullanıcı oturum açmadıysa hizmetinizin oturum açma veya kaydolma akışını tamamlayın.
3. Google'ın API'nize erişmek için kullanması için bir yetkilendirme kodu oluşturun. Yetkilendirme kodu herhangi bir dize değeri olabilir, ancak kullanıcıyı, belirtecin ait olduğu müşteriyi ve kodun sona erme süresini benzersiz bir şekilde temsil etmelidir ve tahmin edilebilir olmamalıdır. Genellikle yaklaşık 10 dakika sonra süresi dolan yetkilendirme kodları yayınlarsınız.
4. URL tarafından belirtilen Onayla redirect_uri parametre aşağıdaki forma sahiptir:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
     https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
     

5. Tarafından belirtilen URL'ye kullanıcının tarayıcısını yönlendir redirect_uri parametresi. Eğer ekleyerek yönlendirme yaparken biraz önce oluşturduğunuz yetkilendirme kodu ve orijinali, değiştirilmemiş devlet değerini dahil code ve state parametrelerini. Şu elde edilen URL bir örneğidir:

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Belirteç değişim isteklerini işleme

Hizmetinizin belirteç değişimi uç noktası, iki tür belirteç değişiminden sorumludur:

• Erişim belirteçleri ve yenileme belirteçleri için yetkilendirme kodlarını değiştirin
• Erişim belirteçleri için yenileme belirteçlerini değiştirin

Belirteç değişimi istekleri aşağıdaki parametreleri içerir:

Belirteç değişimi uç noktası parametreleri
client_id	İstek kaynağını Google olarak tanımlayan bir dize. Bu dize, sisteminizde Google'ın benzersiz tanımlayıcısı olarak kaydedilmelidir.
client_secret	Hizmetiniz için Google'a kaydettirdiğiniz gizli bir dize.
grant_type	Değiştirilen jetonun türü. Ya var authorization_code veya refresh_token .
code	Ne zaman grant_type=authorization_code bu parametre Google ya da de oturum açma veya jeton değiş son nokta alınan kodudur.
redirect_uri	Tüm grant_type=authorization_code bu parametre ilk yetkilendirme isteği kullanılan URL'dir.
refresh_token	Ne zaman grant_type=refresh_token bu parametre Google'ın parçacık değişiminde son nokta alınan belirtecinin yenilenmesi olduğunu.

Erişim belirteçleri ve yenileme belirteçleri için yetkilendirme kodlarını değiştirin

Kullanıcı oturum açtıktan ve yetkilendirme uç noktanız Google'a kısa ömürlü bir yetkilendirme kodu döndürdükten sonra Google, yetkilendirme kodunu bir erişim belirteci ve bir yenileme belirteci ile değiştirmek için belirteç değişim uç noktanıza bir istek gönderir.

Bu istekler için, değeri grant_type olan authorization_code ve değeri code önceden Google'a verilen yetki kodu değeridir. Aşağıda, bir erişim belirteci ve bir yenileme belirteci için bir yetkilendirme kodunun değiş tokuş edilmesi talebine bir örnek verilmiştir:

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

Bir erişim için yetkilendirme kodlarını alışverişi için jeton ve bir yenileme jetonu, sizin jeton değiş uç nokta yanıt verir POST aşağıdaki adımları yürüterek istekleri:

1. Doğrulayın client_id tanımlar yetkili kökenli olarak ve bu istek kökenli client_secret beklenen değeri ile eşleşir.
2. Yetkilendirme kodunun geçerli olduğunu ve süresinin dolmadığını ve istekte belirtilen müşteri kimliğinin, yetkilendirme koduyla ilişkili müşteri kimliğiyle eşleştiğini doğrulayın.
3. URL tarafından belirtilen teyit redirect_uri parametresi ilk yetkilendirme isteği olarak kullanılan değeri ile aynıdır.
4. Yukarıdaki tüm kriterleri doğrulayamazsanız, bir HTTP 400 kötü istek hata döndürür {"error": "invalid_grant"} organ olarak.
5. Aksi takdirde, bir yenileme belirteci ve bir erişim belirteci oluşturmak için yetkilendirme kodundaki kullanıcı kimliğini kullanın. Bu belirteçler herhangi bir dize değeri olabilir, ancak belirtecin ait olduğu kullanıcıyı ve müşteriyi benzersiz bir şekilde temsil etmelidirler ve tahmin edilemez olmalıdırlar. Erişim belirteçleri için, belirteci verdikten sonra genellikle bir saat olan belirtecin sona erme süresini de kaydedin. Yenileme belirteçlerinin süresi dolmaz.
6. HTTPS yanıt metnine aşağıdaki JSON nesnesi Dönüş:

   {
   "token_type": "Bearer",
   "access_token": "ACCESS_TOKEN",
   "refresh_token": "REFRESH_TOKEN",
   "expires_in": SECONDS_TO_EXPIRATION
   }
   

Google, kullanıcı için erişim belirtecini ve yenileme belirtecini saklar ve erişim belirtecinin sona erme tarihini kaydeder. Erişim belirtecinin süresi dolduğunda Google, belirteç değişimi uç noktanızdan yeni bir erişim belirteci almak için yenileme belirtecini kullanır.

Erişim belirteçleri için yenileme belirteçlerini değiştirin

Bir erişim belirtecinin süresi dolduğunda, Google, yeni bir erişim belirteci için bir yenileme belirtecini değiştirmek için belirteç değişimi uç noktanıza bir istek gönderir.

Bu istekler için, değeri grant_type edilir refresh_token ve değeri refresh_token daha önce Google'a verilen belirteç yenileme değeridir. Aşağıdaki, bir erişim belirteci için yenileme belirtecini değiştirme isteğine bir örnektir:

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

Bir erişim jetonu belirteci bir yenileme alışverişi için için belirteç değişim uç nokta yanıt verir POST aşağıdaki adımları yürüterek istekleri:

1. Doğrulayın client_id tanımlar isteği Google gibi kökeni ve bu client_secret beklenen değeriyle eşleşir.
2. Yenileme belirtecinin geçerli olduğunu ve istekte belirtilen istemci kimliğinin, yenileme belirteciyle ilişkili istemci kimliğiyle eşleştiğini doğrulayın.
3. Yukarıdaki tüm kriterleri doğrulayamazsanız, bir HTTP 400 kötü istek hata döndürür {"error": "invalid_grant"} organ olarak.
4. Aksi takdirde, bir erişim belirteci oluşturmak için yenileme belirtecindeki kullanıcı kimliğini kullanın. Bu belirteçler herhangi bir dize değeri olabilir, ancak belirtecin ait olduğu kullanıcıyı ve müşteriyi benzersiz bir şekilde temsil etmelidirler ve tahmin edilemez olmalıdırlar. Erişim belirteçleri için, belirtecin sona erme süresini de (genellikle belirteci verdikten bir saat sonra) kaydedin.
5. HTTPS yanıtının gövdesinde aşağıdaki JSON nesnesini döndürün:

   {
   "token_type": "Bearer",
   "access_token": " ACCESS_TOKEN ",
   "expires_in": SECONDS_TO_EXPIRATION
   }

Not: İsteğe bağlı olarak yeni bir dönebilirsiniz refresh_token yanıtınızda. Yeni dönerken hakkında daha fazla bilgi için refresh_token tercih edilir, bkz fişlerle Çalışma .

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:

• Linked Account Sign-In with Google One Tap.
• Frictionless subscription on AndroidTV.

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.

Uygulamanızı doğrulama

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.