חשבונות מקושרים באמצעות תהליך המשתמע וקוד הרשאה רגיל של OAuth 2.0. השירות חייב לתמוך בנקודות קצה (endpoint) מסוג הרשאה ו-Token Exchange התואמות ל-OAuth 2.0.
在隐式流程中,Google 会在用户的浏览器中打开您的授权端点。成功登录后,系统会将长期访问令牌返回到 Google。现在,从 Google 发送的每个请求中都包含此访问令牌。
在授权代码流程中,您需要两个端点:
授权端点 - 向尚未登录的用户显示登录界面。授权端点还会创建一个短期授权代码,用于记录用户针对所请求的访问权限的同意情况。
令牌交换端点,负责两种交换类型:
- 将授权代码交换为长期刷新令牌和短期访问令牌。这种交换会在用户完成帐号关联流程时进行。
- 将长期有效的刷新令牌交换为短期访问令牌。当 Google 需要新的访问令牌时,由于此令牌已过期,因此出现这种交换。
选择 OAuth 2.0 流程
虽然隐式数据流的实现过程更简单,但 Google 建议隐式数据流签发的访问令牌永远不会过期。这是因为在令牌随隐式流程过期后,用户被迫再次关联自己的帐号。出于安全考虑,如果您需要令牌过期,我们强烈建议您改为使用授权代码流程。
设计准则
本部分将介绍针对 OAuth 关联流程托管的用户屏幕的设计要求和建议。在由 Google 的应用调用后,您的平台会向用户显示“登录 Google”页面和帐号关联屏幕。用户同意关联帐号后,会被重定向回 Google 的应用。
要求
- 您必须告知用户该用户帐号将与 Google 关联,而不是与特定 Google 产品(例如 Google Home 或 Google 助理)关联。
建议
建议您执行以下操作:
显示 Google 的隐私权政策。在同意屏幕上添加指向 Google 隐私权政策的链接。
要共享的数据。使用简洁明了的语言向用户说明他们的 Google 需要哪些数据以及为何收集这些数据。
明确的号召性用语。在同意屏幕上提供明确的号召性用语,例如“同意并关联”。这是因为用户需要了解他们需要与 Google 共享哪些数据,才能关联帐号。
能够取消。如果用户不关联,则可以提供返回或取消的方式。
清除登录流程。确保用户有明确的登录 Google 帐号的方法,例如用户名和密码字段或使用 Google 帐号登录字段。
能够解除关联。为用户提供解除关联的机制,例如他们在平台上的帐号设置网址。或者,您也可以添加指向 Google 帐号的链接,以便用户可以管理关联的帐号。
能够更改用户帐号。推荐一种供用户切换帐号的方法。如果用户往往拥有多个帐号,这一点尤其有用。
- 如果用户必须关闭同意屏幕才能切换帐号,请向 Google 发送一个可恢复错误,以便用户通过 OAuth 关联和隐式流程登录所需帐号。
添加徽标。在同意屏幕上显示公司徽标。 根据样式指南放置徽标。如果您还希望显示 Google 的徽标,请参阅徽标和商标。
Create the project
To create your project to use account linking:
- Go to the Google API Console.
- לחץ על צור פרויקט .
- הזן שם או קבל את ההצעה שנוצרה.
- אשר או ערוך את כל השדות שנותרו.
- לחץ על צור .
לצפייה במזהה הפרוייקט שלך:
- Go to the Google API Console.
- מצא את הפרוייקט שלך בטבלה בדף הנחיתה. מזהה הפרויקט מופיע בעמודה מזהה .
Configure your OAuth Consent Screen
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.
- Open the OAuth consent screen page of the Google APIs console.
- If prompted, select the project you just created.
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
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.
הטמעה של שרת ה-OAuth
יישום של שרת OAuth 2.0 של תהליך קוד ההרשאה כולל שתי נקודות קצה, שהשירות שלך מספק באמצעות HTTPS. נקודת הקצה הראשונה היא נקודת הקצה של ההרשאה, שאחראית למצוא או להשיג הסכמה של משתמשים לקבלת גישה לנתונים. נקודת הקצה של ההרשאה מציגה לכניסה למשתמשים שעדיין לא נכנסו לחשבון ומתעדים הסכמה ל: את הרשאת הגישה המבוקשת. נקודת הקצה השנייה היא נקודת הקצה של המרת אסימונים, משמשות לקבלת מחרוזות מוצפנות, שנקראות אסימונים, שמאשרות למשתמש ניגשים לשירות.
כשאפליקציה של Google צריכה לשלוח קריאה לאחד מממשקי ה-API של השירות שלכם, Google משתמשת את נקודות הקצה האלה יחד כדי לקבל מהמשתמשים הרשאה לקרוא לממשקי ה-API בשמם.
בסשן של זרימת קוד הרשאה OAuth 2.0 ש-Google יזמה התהליך הבא:
- Google פותחת את נקודת הקצה להרשאה בדפדפן של המשתמש. אם התהליך שמופעל במכשיר עם קול בלבד עבור פעולה, Google מעבירה את בטלפון.
- המשתמש נכנס לחשבון, אם הוא עדיין לא מחובר, ומעניק ל-Google הרשאה לגשת לנתונים שלהם באמצעות ה-API, אם הוא עדיין לא העניק הרשאה.
- השירות שלכם יוצר קוד הרשאה ומחזיר אותו ל-Google. לבצע לכן, להפנות את הדפדפן של המשתמש חזרה אל Google עם קוד ההרשאה שמצורף לבקשה.
- Google שולחת את קוד ההרשאה לנקודת הקצה של המרת האסימון, מאמת את האותנטיות של הקוד ומחזיר אסימון גישה, רענון של אסימון. אסימון הגישה הוא אסימון לטווח קצר שהשירות שלך מקבל כפרטי כניסה לגישה לממשקי API. אסימון הרענון הוא לטווח ארוך אסימון ש-Google יכולה לאחסן ולהשתמש בו כדי לקבל אסימוני גישה חדשים כשהם שפג תוקפן.
- אחרי שהמשתמש משלים את תהליך קישור החשבון, כל קישור הבקשה שנשלחה מ-Google מכילה אסימון גישה.
טיפול בבקשות הרשאה
מתי צריך לבצע קישור חשבונות באמצעות קוד הרשאה מסוג OAuth 2.0 Google שולחת את המשתמש לנקודת הקצה (endpoint) של ההרשאה בבקשה כוללת את הפרמטרים הבאים:
פרמטרים של נקודת קצה להרשאה | |
---|---|
client_id |
מזהה הלקוח שהקצית ל-Google. |
redirect_uri |
כתובת ה-URL שאליה שולחים את התגובה לבקשה הזו. |
state |
ערך של ניהול חשבונות שמועבר אל Google ללא שינוי URI להפניה אוטומטית. |
scope |
אופציונלי: קבוצה מופרדת ברווחים של מחרוזות היקף שמציינות את התג הנתונים ש-Google מבקשת עבורם הרשאה. |
response_type |
סוג הערך שיוחזר בתשובה. ל-OAuth 2.0
הרשאה באמצעות קוד, סוג התגובה הוא תמיד code .
|
user_locale |
הגדרת השפה בחשבון Google בקטע RFC5646 , משמש להתאמת התוכן שלך לשפה המועדפת של המשתמש. |
לדוגמה, אם נקודת הקצה להרשאה זמינה ב-
https://myservice.example.com/auth
, בקשה עשויה להיראות כך:
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
כדי שנקודת הקצה להרשאה תטפל בבקשות כניסה, צריך לבצע את הפעולות הבאות שלבים:
- צריך לוודא שה-
client_id
תואם למזהה הלקוח שהקצית ל-Google, ושה-redirect_uri
תואם לכתובת ה-URL להפניה אוטומטית ש-Google סיפקה לשירות שלך. הבדיקות האלה חשובות כדי למנוע גישה לאפליקציות לקוח לא מכוונות או שהוגדרו באופן שגוי. אם אתם תומכים בכמה מוצרים, תהליכי OAuth 2.0, מאשרים גם שה-response_type
הואcode
. - לבדוק אם המשתמש נכנס לשירות. אם המשתמש לא מחובר, להשלים את תהליך הכניסה או ההרשמה לשירות.
- אפשר ליצור קוד הרשאה ש-Google תשתמש בו כדי לגשת ל-API. קוד ההרשאה יכול להיות כל ערך מחרוזת, אבל הוא חייב להיות ייחודי שמייצג את המשתמש, את הלקוח שעבורו האסימון מיועד ואת תאריך התפוגה של הקוד זמן אחר, ואסור לנחש אותו. בדרך כלל אתם מנפיקים הרשאה קודים שהתוקף שלהם פג לאחר כ-10 דקות.
- מוודאים שכתובת ה-URL שצוינה על ידי הפרמטר
redirect_uri
כוללת את בצורה הבאה:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
- מפנים את דפדפן המשתמש לכתובת ה-URL שצוינה ב-
הפרמטר
redirect_uri
. מוסיפים את קוד ההרשאה שנוצר עכשיו והערך של המצב המקורי שלא השתנה כאשר מבצעים הפניה אוטומטית על ידי הוספת הפרמטריםcode
ו-state
. זוהי דוגמה דוגמה לכתובת ה-URL שתתקבל:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
טיפול בבקשות להחלפת אסימונים
נקודת הקצה (endpoint) של המרת האסימונים של השירות אחראית על שני סוגים של אסימונים Exchanges:
- המרת קודי הרשאה באסימוני גישה ובאסימוני רענון
- המרת אסימוני רענון באסימוני גישה
בקשות להחלפת אסימונים כוללות את הפרמטרים הבאים:
פרמטרים של נקודת קצה להחלפת אסימונים | |
---|---|
client_id |
מחרוזת המזהה את מקור הבקשה כ-Google. המחרוזת הזו חייבת יהיה רשום במערכת שלך כמזהה הייחודי של Google. |
client_secret |
מחרוזת סודית שרשמתם ב-Google לשירות שלכם. |
grant_type |
סוג האסימון המוחלף. זה או אחת מהאפשרויות
authorization_code או refresh_token . |
code |
כשהערך הוא grant_type=authorization_code , הפרמטר הזה
קוד ש-Google קיבלה מהכניסה או מהמרת האסימון
נקודת הקצה. |
redirect_uri |
כשהערך הוא grant_type=authorization_code , הפרמטר הזה
כתובת ה-URL ששימשה בבקשת ההרשאה הראשונית. |
refresh_token |
כשהערך הוא grant_type=refresh_token , הפרמטר הזה
אסימון הרענון ש-Google קיבלה מנקודת הקצה של המרת האסימונים שלך. |
המרת קודי הרשאה באסימוני גישה ובאסימוני רענון
אחרי שהמשתמש נכנס לחשבון ונקודת הקצה (endpoint) של ההרשאה מחזירה דוח לטווח קצר. את קוד ההרשאה ל-Google, Google שולחת בקשה להמרת האסימון שתחליף את קוד ההרשאה באסימון גישה וברענון ב-Assistant.
בבקשות האלה, הערך של grant_type
הוא authorization_code
,
הערך code
הוא הערך של קוד ההרשאה שנתת בעבר
ל-Google. הדוגמה הבאה היא בקשה להחלפת
קוד הרשאה עבור אסימון גישה ואסימון רענון:
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
כדי להחליף קודי הרשאה באסימון גישה ובאסימון רענון,
נקודת הקצה (endpoint) של המרת אסימונים מגיבה לבקשות POST
על ידי ביצוע
שלבים:
- יש לוודא שה-
client_id
מזהה את מקור הבקשה כגורם מורשה origin, ושה-client_secret
תואם לערך הצפוי. - מוודאים שקוד ההרשאה בתוקף, ושהוא לא בתוקף. מזהה הלקוח שצוין בבקשה תואם את מזהה הלקוח המשויך אל קוד הרשאה.
- מוודאים שכתובת ה-URL שצוינה על ידי הפרמטר
redirect_uri
זהה לערך שנעשה בו שימוש בבקשת ההרשאה הראשונית. - אם לא ניתן לאמת את כל הקריטריונים שלמעלה, מוחזר
שגיאה מסוג 'בקשה שגויה' 400 עם
{"error": "invalid_grant"}
בגוף ההודעה. - אחרת, משתמשים במזהה המשתמש מקוד ההרשאה כדי ליצור רענון וגם אסימון גישה. האסימונים האלה יכולים להיות כל ערכי מחרוזת, אבל הם לייצג את המשתמש ואת הלקוח שעבורו האסימון מיועד באופן ייחודי, שלא ניתן לנחש. עבור אסימוני גישה, צריך לרשום גם את זמן התפוגה של את האסימון, שזמינה בדרך כלל שעה אחרי הנפקת האסימון. אין תפוגה לאסימוני רענון.
- מחזירים את אובייקט ה-JSON הבא בגוף תגובת ה-HTTPS:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "refresh_token": "REFRESH_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Google מאחסנת את אסימון הגישה ואת אסימון הרענון עבור המשתמש והרשומות את אסימון הגישה. כשפג התוקף של אסימון הגישה, Google משתמשת אסימון הרענון כדי לקבל אסימון גישה חדש מנקודת הקצה של המרת האסימונים.
המרת אסימוני רענון באסימוני גישה
כשפג התוקף של אסימון הגישה, Google שולחת בקשה להחלפת האסימון של נקודת הקצה להחלפת אסימון רענון באסימון גישה חדש.
בבקשות האלה, הערך של grant_type
הוא refresh_token
והערך
של refresh_token
הוא הערך של אסימון הרענון שהענקת לו בעבר
Google. דוגמה לבקשה להחלפת אסימון רענון
לאסימון גישה:
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
כדי להחליף אסימון רענון באסימון גישה, נקודת הקצה של המרת האסימון
מגיב לבקשות POST
על ידי ביצוע השלבים הבאים:
- מוודאים ש-
client_id
מזהה את מקור הבקשה כ-Google, וכן שה-client_secret
תואם לערך הצפוי. - יש לוודא שאסימון הרענון חוקי, ושמזהה הלקוח שצוין ב- הבקשה תואמת למזהה הלקוח שמשויך לאסימון הרענון.
- אם לא ניתן לאמת את כל הקריטריונים שלמעלה, מוחזר HTTP 400
שגיאת 'בקשה שגויה' עם
{"error": "invalid_grant"}
בגוף ההודעה. - אחרת, משתמשים במזהה המשתמש מאסימון הרענון כדי ליצור גישה ב-Assistant. האסימונים האלה יכולים להיות כל ערכי מחרוזת, אבל הם חייבים להיות ייחודיים שמייצגים את המשתמש ואת הלקוח שעבורו האסימון מיועד, ואסור שהוא בלתי מונחית לניחוש. עבור אסימוני גישה, צריך גם לתעד את זמן התפוגה של האסימון, בדרך כלל שעה לאחר הנפקת האסימון.
- החזרת אובייקט ה-JSON הבא בגוף ה-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:
- 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:
- Extract access token from the Authorization header and return information for the user associated with the access token.
- 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. 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.
אימות ההטמעה
אתה יכול לאמת את הביצוע שלך באמצעות מגרש 2.0 OAuth הכלי.
בצע את הפעולות הבאות בכלי:
- לחץ תצורת כדי לפתוח את חלון תצורת 2.0 OAuth.
- בתחום זרימת OAuth, בחר בצד הלקוח.
- בתחום נקודות קצה OAuth, בחר Custom.
- ציין את נקודת הקצה של OAuth 2.0 ואת מזהה הלקוח שהקצית ל- Google בשדות המתאימים.
- במקטע שלב 1, לא יבחר אף היקפי Google. במקום זאת, השאר שדה זה ריק או הקלד טווח תקף עבור השרת שלך (או מחרוזת שרירותית אם אינך משתמש בהיקפי OAuth). כשתסיים, לחץ על הרשה APIs.
- בסעיפים שלב 2 ושלב 3, לעבור את זרימת 2.0 OAuth ולוודא כי כל צעד עובד כמתוכנן.
אתה יכול לאמת את הביצוע שלך באמצעות קישור הדגמת חשבון Google הכלי.
בצע את הפעולות הבאות בכלי:
- לחץ על כניסה עם כפתור גוגל.
- בחר את החשבון שברצונך לקשר.
- הזן את מזהה השירות.
- לחלופין, הזן אחד או יותר טווחים שאליהם תבקש גישה.
- לחץ על התחל הדגמה.
- כשתתבקש, אשר שאתה רשאי להסכים ולדחות את בקשת הקישור.
- אשר שהפנית לפלטפורמה שלך.