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 关联流程托管的用户屏幕的设计要求和建议。在由 Google 的应用调用后,您的平台会向用户显示“登录 Google”页面和帐号关联屏幕。用户同意关联帐号后,会被重定向回 Google 的应用。

此图显示了用户将其 Google 帐号与身份验证系统关联的步骤。第一个屏幕截图显示了用户从您的平台发起的关联。第二张图片展示了用户登录 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 的徽标,请参阅徽标和商标

Projeyi oluşturma

Hesap bağlamayı kullanmak amacıyla projenizi oluşturmak için:

  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.

Google Hesabı bağlama işlemi, uygulamanın verilerine erişmek isteyen kullanıcılara, istedikleri veri türlerini ve geçerli şartları bildiren bir izin ekranı içerir. Google API istemci kimliği oluşturmadan önce OAuth izin ekranınızı yapılandırmanız gerekir.

  1. Google API'leri konsolunun OAuth izin ekranı sayfasını açın.
  2. İstenirse az önce oluşturduğunuz projeyi seçin.
  3. "OAuth izin ekranı" sayfasında formu doldurun ve "Save" (Kaydet) düğmesini tıklayın.

    Uygulama adı: İzin isteyen uygulamanın adı. Ad, uygulamanızı doğru şekilde yansıtmalı ve kullanıcıların başka bir yerde gördüğü uygulama adıyla tutarlı olmalıdır. Uygulama adı, Hesap Bağlama izin ekranında gösterilir.

    Uygulama logosu: Kullanıcı rızası ekranında kullanıcıların uygulamanızı tanımasına yardımcı olacak bir resim. Logo, Hesap bağlama izin ekranında ve hesap ayarlarında gösterilir.

    Destek e-postası: Kullanıcıların rızalarıyla ilgili soruları için sizinle iletişime geçmesi içindir.

    Google API'leri için kapsamlar: Kapsamlar, uygulamanızın kullanıcınızın özel Google verilerine erişmesine olanak tanır. Google Hesabı Bağlama kullanım alanı için varsayılan kapsam (e-posta, profil, openid) yeterlidir. Herhangi bir hassas kapsam eklemeniz gerekmez. Kapsamları önceden değil de aşamalı olarak erişim talep etmek genellikle en iyi uygulamadır. Daha fazla bilgi edinin.

    Yetkili alanlar: Sizi ve kullanıcılarınızı korumak için Google, yalnızca OAuth kullanarak kimlik doğrulaması yapan uygulamaların Yetkilendirilen Alanları kullanmasına izin verir. Uygulamalarınızın bağlantıları Yetkilendirilen Alanlar'da barındırılmalıdır. Daha fazla bilgi edinin.

    Uygulama Ana Sayfası bağlantısı: Uygulamanız için ana sayfa. Yetkilendirilen Alanda barındırılmalıdır.

    Uygulama Gizlilik Politikası bağlantısı: Google Hesabı bağlama izin ekranında gösterilir. Yetkilendirilen Alanda barındırılmalıdır.

    Uygulama Hizmet Şartları bağlantısı (İsteğe bağlı): Yetkilendirilen bir alanda barındırılmalıdır.

    Şekil 1. Google Hesabı ile Hayali Bir Uygulama İçin İzin Ekranını Bağlama, Tunery

  4. "Doğrulama Durumu"nu kontrol edin, başvurunuzun doğrulanması gerekiyorsa başvurunuzu doğrulama için göndermek üzere "Doğrulama İçin Gönder" düğmesini tıklayın. Ayrıntılar için OAuth doğrulama gereksinimleri sayfasına bakın.

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
    }
处理用户信息请求

用户信息终端是一个OAuth 2.0保护的资源,对链接的用户返回的权利要求。实现和托管 userinfo 端点是可选的,以下用例除外:

从您的令牌端点成功检索访问令牌后,Google 会向您的 userinfo 端点发送请求,以检索有关链接用户的基本个人资料信息。

userinfo 端点请求标头
Authorization header Bearer 类型的访问令牌。

例如,如果你的用户信息终端可在https://myservice.example.com/userinfo ,请求看起来像下面这样:

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

要让您的 userinfo 端点处理请求,请执行以下步骤:

  1. 从 Authorization 标头中提取访问令牌并返回与访问令牌关联的用户的信息。
  2. 如果访问令牌无效,返回HTTP 401错误未经授权使用的WWW-Authenticate响应头。下面是一个userinfo的错误响应的一个示例:
    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: error="invalid_token",
    error_description="The Access Token expired"
    
    如果一个401未经授权,或任何其它不成功错误响应在关联过程返回时,误差将是不可恢复的,所检索的令牌将被丢弃,并且用户将必须再次启动链接过程。
  3. 如果访问令牌是有效的,回国与以下JSON对象在HTTPS响应的身体HTTP 200回应:

    {
    "sub": "USER_UUID",
    "email": "EMAIL_ADDRESS",
    "given_name": "FIRST_NAME",
    "family_name": "LAST_NAME",
    "name": "FULL_NAME",
    "picture": "PROFILE_PICTURE",
    }
    
    如果你的用户信息端点返回一个HTTP 200成功响应,检索到的令牌和索赔登记针对用户的谷歌帐户。

    用户信息端点响应
    sub标识系统中用户的唯一 ID。
    email用户的电子邮件地址。
    given_name可选:用户的名字。
    family_name可选:用户的姓氏。
    name可选:用户的全名。
    picture可选:用户的档案图片。

Uygulamanızı doğrulama

Sen kullanarak uygulanmasını doğrulamak OAuth 2.0 Bahçesi aracı.

Araçta aşağıdaki adımları uygulayın:

  1. Yapılandırma tıklayın OAuth 2.0 Yapılandırma penceresini açın.
  2. OAuth akış alanında, istemci tarafı seçin.
  3. OAuth Endpoints alanında, Özel'i seçin.
  4. OAuth 2.0 uç noktanızı ve Google'a atadığınız müşteri kimliğini ilgili alanlarda belirtin.
  5. Adım 1 bölümünde, herhangi bir Google kapsamları seçmeyin. Bunun yerine, bu alanı boş bırakın veya sunucunuz için geçerli bir kapsam (veya OAuth kapsamları kullanmıyorsanız rastgele bir dize) yazın. İşiniz bittiğinde, Yetkilendirme API'leri tıklayın.
  6. Aşama 2 ile Aşama 3 bölümlerde OAuth 2.0 akışı geçmesi ve istendiği gibi her aşama çalıştığını doğrulamak.

Sen kullanarak uygulanmasını doğrulamak Google Hesap Bağlama Demo aracı.

Araçta aşağıdaki adımları uygulayın:

  1. Oturum Google düğmesiyle tıklayın.
  2. Bağlamak istediğiniz hesabı seçin.
  3. Hizmet kimliğini girin.
  4. İsteğe bağlı olarak, erişim isteyeceğiniz bir veya daha fazla kapsam girin.
  5. Başlangıç Demo tıklayın.
  6. İstendiğinde, bağlantı isteğini kabul edip reddedebileceğinizi onaylayın.
  7. Platformunuza yönlendirildiğinizi onaylayın.