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.

In the implicit flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from Google.

In the authorization code flow, you need two endpoints:

  • The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

  • The token exchange endpoint, which is responsible for two types of exchanges:

    1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
    2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Choose an OAuth 2.0 flow

Although the implicit flow is simpler to implement, Google recommends that access tokens issued by the implicit flow never expire. This is because the user is forced to link their account again after a token expires with the implicit flow. If you need token expiration for security reasons, we strongly recommend that you use the authorization code flow instead.

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

This figure shows the steps for a user to link their Google account to your authentication system. The first screenshot shows user-initiated linking from your platform. The second image shows user sign-in to Google, while the third shows the user consent and confirmation for linking their Google account with your app. The final screenshot shows a successfully linked user account in the Google app.
Figure 1. Account linking user sign in to Google and consent screens.

Requirements

  1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.

Recommendations

We recommend that you do the following:

  1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

  2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

  3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

  4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

  5. Clear sign-in process. Ensure that users have clear method for signing in to their Google account, such as fields for their username and password or Sign in with Google.

  6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

  7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

    • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking and the implicit flow.

  8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

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
}
Kullanıcı bilgisi isteklerini işleme

Userınfo uç OAth 2.0 korumalı bir kaynak olduğunu bağlı kullanıcı hakkında geri istemler. Userinfo uç noktasının uygulanması ve barındırılması, aşağıdaki kullanım durumları dışında isteğe bağlıdır:

Erişim belirteci, belirteç uç noktanızdan başarıyla alındıktan sonra Google, bağlantılı kullanıcı hakkında temel profil bilgilerini almak için userinfo uç noktanıza bir istek gönderir.

userinfo uç nokta istek üstbilgileri
Authorization header Taşıyıcı türünde erişim belirteci.

Örneğin, senin Userınfo son nokta mevcut ise https://myservice.example.com/userinfo bir istek aşağıdaki gibi görünebilir:

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

Kullanıcı bilgileri uç noktanızın istekleri işlemesi için aşağıdaki adımları uygulayın:

  1. Yetkilendirme başlığından erişim belirtecini çıkarın ve erişim belirteci ile ilişkili kullanıcı için bilgi döndürün.
  2. Erişim kodu geçersiz ise, kullanarak HTTP 401 Yetkisiz hata döndürür WWW-Authenticate Tepki Başlığını. Aşağıda, bir Userınfo hatası yanıtının bir örneği aşağıda verilmektedir:
    HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
    izinsiz veya başka bir başarısız hata yanıtı bağlama işlemi esnasında döndürülen bir 401 hata geri kazanımı mümkün olmayan olacak, Alınan belirteç atılır ve kullanıcı olacaktır bağlama işlemini yeniden başlatmak için.

  3. Erişim belirteci geçerli, dönüş ve HTTPS yanıt metnine aşağıdaki JSON nesnesi ile HTTP 200 yanıt ise: 

    {
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}
    senin userinfo uç nokta döner HTTP 200 başarı yanıtı ise belirteç alınır ve iddialar kullanıcının Google'a karşı kayıtlıdır hesap.

    userinfo uç nokta yanıtı
    sub Sisteminizde kullanıcıyı tanımlayan benzersiz bir kimlik.
    email Kullanıcının e-posta adresi.
    given_name İsteğe bağlı: kullanıcının adı.
    family_name İsteğe bağlı: kullanıcının soyadı.
    name İsteğe bağlı: kullanıcının tam adı.
    picture İsteğe bağlı: Kullanıcının profil resmi.

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.