Các tài khoản được liên kết bằng các quy trình ngầm ẩn và mã uỷ quyền OAuth 2.0 theo tiêu chuẩn ngành. Dịch vụ của bạn phải hỗ trợ các điểm cuối uỷ quyền và trao đổi mã thông báo tuân thủ OAuth 2.0.
在隐式流程中，Google 会在用户的浏览器中打开您的授权端点。成功登录后，您将向 Google 返回一个长期访问令牌。现在，此访问令牌会包含在 Google 发送的每个请求中。
在授权代码流程中，您需要两个端点：
授权端点，用于向尚未登录的用户显示登录界面。授权端点还会创建一个短期授权代码，以记录用户对所请求访问权限的同意情况。
令牌交换端点，负责两种类型的交换：
- 使用授权代码换取长期有效的刷新令牌和短期有效的访问令牌。当用户完成账号关联流程时，就会发生此交换。
- 将长期有效的刷新令牌换成短期有效的访问令牌。当 Google 需要新的访问令牌（因为现有访问令牌已过期）时，就会发生这种交换。
选择 OAuth 2.0 流程
虽然隐式流程更易于实现，但 Google 建议通过隐式流程签发的访问令牌永不过期。这是因为，在隐式流程中，令牌过期后，系统会强制用户重新关联其账号。如果您出于安全考虑需要令牌过期，我们强烈建议您改用授权码流程。
设计准则
本部分介绍了您为 OAuth 关联流程托管的用户屏幕的设计要求和建议。在 Google 应用调用该 API 后，您的平台会向用户显示登录 Google 页面和账号关联意见征求界面。同意关联账号后，系统会将用户重定向回 Google 的应用。
要求
- 您必须说明用户的账号将与 Google 相关联，而非 Google Home 或 Google 助理等特定 Google 产品相关联。
建议
建议您执行以下操作：
显示 Google 的隐私权政策。在同意屏幕上添加指向 Google 隐私权政策的链接。
要共享的数据。使用清晰简洁的语言告知用户 Google 需要哪些用户数据以及原因。
添加醒目的号召性用语。在用户同意页面上提供明确的号召性用语，例如“同意并关联”。这是因为用户需要了解他们需要与 Google 分享哪些数据才能关联账号。
可以取消。为用户提供返回或取消链接的途径，如果用户选择不进行关联。
明确的登录流程。确保用户有明确的 Google 账号登录方法，例如用户名和密码字段或使用 Google 账号登录。
能够解除关联。提供一种可让用户解除关联的机制，例如指向您平台上账号设置的网址。或者，您也可以添加指向 Google 账号的链接，以便用户管理其关联的账号。
能够更改用户账号。建议用户切换账号的方法。如果用户通常拥有多个账号，这种做法尤为有益。
- 如果用户必须关闭意见征求界面才能切换账号，请向 Google 发送可恢复的错误，以便用户可以使用 OAuth 关联和隐式流程登录所需的账号。
添加您的徽标。在意见征求页面上显示您的公司徽标。 按照您的样式准则放置徽标。如果您还想显示 Google 的徽标，请参阅徽标和商标。
创建项目
如需创建项目以使用账号关联功能，请执行以下操作：
- Go to the Google API Console.
- Nhấp vào Tạo dự án .
- Nhập tên hoặc chấp nhận đề xuất được tạo.
- Xác nhận hoặc chỉnh sửa bất kỳ trường nào còn lại.
- Nhấp vào Tạo .
Để xem ID dự án của bạn:
- Go to the Google API Console.
- Tìm dự án của bạn trong bảng trên trang đích. ID dự án xuất hiện trong cột ID .
配置 OAuth 同意屏幕
Google 账号关联流程包含一个权限请求页面，用于告知用户请求访问其数据的应用、应用请求访问的数据类型以及适用的条款。您需要先配置 OAuth 权限请求页面，然后才能生成 Google API 客户端 ID。
- 打开 Google API 控制台的 OAuth 同意屏幕页面。
- 如果出现提示，请选择您刚刚创建的项目。
在“OAuth 同意屏幕”页面上，填写表单，然后点击“保存”按钮。
应用名称：征求用户同意的应用的名称。该名称应准确反映您的应用，并与用户在其他地方看到的应用名称一致。应用名称将显示在账号关联意见征求界面上。
应用徽标：权限请求页面上显示的一张图片，用以让用户认出您的应用。该徽标会显示在账号关联意见征求页面和账号设置中
支持电子邮件：供用户就其是否同意的问题与您联系。
Google API 的范围：借助范围，您的应用可以访问用户的私密 Google 数据。对于 Google 账号关联用例，默认范围（电子邮件地址、个人资料、openid）已足够，您无需添加任何敏感范围。通常，最佳做法是在需要访问权限时逐步请求相应权限范围，而不是提前请求。了解详情。
已获授权的网域：为了保护您和您的用户，Google 只允许使用 OAuth 进行身份验证的应用使用已获授权的网域。您应用的链接必须托管在已获授权的网域上。了解详情。
应用首页链接：应用的首页。必须托管在已获授权的网域上。
应用隐私权政策链接：显示在 Google 账号关联意见征求界面上。必须托管在已获授权的网域上。
应用服务条款链接（可选）：必须托管在已获授权的网域上。
图 1. 虚构应用 Tunery 的 Google 账号关联意见征求界面
查看“验证状态”，如果您的应用需要验证，请点击“提交以供验证”按钮，以提交您的应用以供验证。如需了解详情，请参阅 OAuth 验证要求。
Triển khai máy chủ OAuth
Quá trình triển khai máy chủ OAuth 2.0 của quy trình mã uỷ quyền bao gồm hai điểm cuối mà dịch vụ của bạn cung cấp qua HTTPS. Điểm cuối đầu tiên là điểm cuối uỷ quyền, chịu trách nhiệm tìm hoặc lấy sự đồng ý của người dùng về quyền truy cập dữ liệu. Điểm cuối uỷ quyền đưa ra giao diện người dùng đăng nhập cho những người dùng chưa đăng nhập và ghi lại sự đồng ý đối với quyền truy cập được yêu cầu. Điểm cuối thứ hai là điểm cuối trao đổi mã thông báo, được dùng để lấy các chuỗi đã mã hoá (được gọi là mã thông báo) cho phép người dùng truy cập vào dịch vụ của bạn.
Khi ứng dụng của Google cần gọi một trong các API của dịch vụ, Google sẽ sử dụng các điểm cuối này cùng nhau để yêu cầu người dùng cho phép gọi các API này thay mặt cho công ty.
Phiên quy trình mã uỷ quyền OAuth 2.0 do Google khởi tạo có quy trình sau:
- Google sẽ mở điểm cuối uỷ quyền của bạn trong trình duyệt của người dùng. Nếu luồng bắt đầu trên một thiết bị chỉ dùng giọng nói cho một Hành động, thì Google sẽ chuyển thực thi trên điện thoại.
- Người dùng này đăng nhập (nếu chưa đăng nhập) và cấp cho Google quyền truy cập vào dữ liệu của họ bằng API của bạn nếu họ chưa cấp quyền.
- Dịch vụ của bạn sẽ tạo một mã uỷ quyền rồi trả lại mã này cho Google. Việc cần làm do đó, hãy chuyển hướng trình duyệt của người dùng trở lại Google bằng mã uỷ quyền được đính kèm vào yêu cầu.
- Google sẽ gửi mã uỷ quyền đến điểm cuối trao đổi mã thông báo của bạn. Điểm cuối này xác minh tính xác thực của mã và trả về mã truy cập cũng như mã làm mới. Mã truy cập là một mã ngắn hạn mà dịch vụ của bạn chấp nhận làm thông tin đăng nhập để truy cập các API. Mã làm mới là mã tồn tại trong một thời gian dài mã thông báo mà Google có thể lưu trữ và sử dụng để thu nạp mã truy cập mới khi hết hạn.
- Sau khi người dùng hoàn tất quy trình liên kết tài khoản, mỗi yêu cầu do Google gửi có chứa mã truy cập.
Xử lý yêu cầu uỷ quyền
Khi bạn cần liên kết tài khoản bằng mã uỷ quyền OAuth 2.0 quy trình này, Google sẽ chuyển người dùng đến điểm cuối uỷ quyền của bạn kèm theo yêu cầu bao gồm các thông số sau:
| Tham số điểm cuối ủy quyền | |
|---|---|
client_id |
Mã ứng dụng khách mà bạn đã chỉ định cho Google. |
redirect_uri |
URL mà bạn gửi phản hồi tới yêu cầu này. |
state |
Giá trị sổ sách được chuyển lại cho Google không thay đổi trong URI chuyển hướng. |
scope |
Không bắt buộc: Một tập hợp chuỗi phạm vi được phân tách bằng dấu cách chỉ định dữ liệu mà Google đang yêu cầu uỷ quyền. |
response_type |
Loại giá trị cần trả về trong phản hồi. Đối với OAuth 2.0
luồng mã uỷ quyền, loại phản hồi luôn là code.
|
user_locale |
Chế độ cài đặt ngôn ngữ trong Tài khoản Google trong RFC5646 định dạng này, được dùng để bản địa hoá nội dung của bạn sang ngôn ngữ ưu tiên của người dùng. |
Ví dụ: nếu điểm cuối uỷ quyền của bạn có tại
https://myservice.example.com/auth, một yêu cầu có thể có dạng như sau:
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
Để điểm cuối uỷ quyền của bạn có thể xử lý các yêu cầu đăng nhập, hãy làm như sau các bước:
- Xác minh rằng
client_idkhớp với Mã ứng dụng khách mà bạn đã chỉ định cho Google, vàredirect_urikhớp với URL chuyển hướng do Google cung cấp cho dịch vụ của bạn. Đây là những bước kiểm tra quan trọng để ngăn chặn việc cấp truy cập vào các ứng dụng khách ngoài ý muốn hoặc bị định cấu hình sai. Nếu bạn hỗ trợ nhiều Luồng OAuth 2.0, cũng xác nhận rằngresponse_typelàcode. - Kiểm tra xem người dùng đã đăng nhập vào dịch vụ của bạn chưa. Nếu người dùng chưa đăng nhập, hoàn tất quy trình đăng nhập hoặc đăng ký dịch vụ của bạn.
- Tạo mã uỷ quyền cho Google dùng để truy cập vào API của bạn. Mã uỷ quyền có thể là bất kỳ giá trị chuỗi nào, nhưng phải là duy nhất đại diện cho người dùng, máy khách và thời gian hết hạn của mã và thông tin đó không phải ai cũng đoán được. Bạn thường cấp phép các mã sẽ hết hạn sau khoảng 10 phút.
- Xác nhận rằng URL do tham số
redirect_urichỉ định có biểu mẫu sau:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
- Chuyển hướng trình duyệt của người dùng tới URL được chỉ định
Tham số
redirect_uri. Bao gồm mã uỷ quyền mà bạn vừa được tạo và giá trị trạng thái ban đầu, chưa sửa đổi khi bạn chuyển hướng bằng cách thêm các tham sốcodevàstate. Sau đây là một ví dụ về URL kết quả:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
Xử lý các yêu cầu trao đổi mã thông báo
Điểm cuối trao đổi mã thông báo của dịch vụ của bạn chịu trách nhiệm về 2 loại mã thông báo sàn giao dịch:
- Trao đổi mã uỷ quyền để lấy mã truy cập và mã làm mới
- Mã làm mới trao đổi cho mã truy cập
Yêu cầu trao đổi mã thông báo bao gồm các tham số sau:
| Tham số điểm cuối trao đổi mã thông báo | |
|---|---|
client_id |
Một chuỗi xác định nguồn gốc của yêu cầu là Google. Chuỗi này phải được đăng ký trong hệ thống của bạn dưới dạng mã nhận dạng duy nhất của Google. |
client_secret |
Chuỗi bí mật mà bạn đã đăng ký với Google cho dịch vụ của bạn. |
grant_type |
Loại mã thông báo đang được trao đổi. Có một trong hai
authorization_code hoặc refresh_token. |
code |
Khi grant_type=authorization_code, tham số này sẽ là
mã Google nhận được từ thông tin đăng nhập của bạn hoặc từ trao đổi mã thông báo
điểm cuối. |
redirect_uri |
Khi grant_type=authorization_code, tham số này sẽ là
URL dùng trong yêu cầu uỷ quyền ban đầu. |
refresh_token |
Khi grant_type=refresh_token, tham số này sẽ là
mã làm mới mà Google nhận được từ điểm cuối trao đổi mã thông báo của bạn. |
Trao đổi mã uỷ quyền để lấy mã truy cập và mã làm mới
Sau khi người dùng đăng nhập và điểm cuối uỷ quyền của bạn trả về một thông báo ngắn hạn mã uỷ quyền cho Google, Google sẽ gửi yêu cầu đến sàn giao dịch mã thông báo của bạn điểm cuối để trao đổi mã uỷ quyền lấy mã truy cập và làm mới mã thông báo.
Đối với các yêu cầu này, giá trị của grant_type là authorization_code và
giá trị code là giá trị của mã uỷ quyền mà bạn đã cấp trước đó
cho Google. Sau đây là ví dụ về yêu cầu trao đổi
mã uỷ quyền cho mã truy cập và mã làm mới:
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
Để đổi mã uỷ quyền lấy mã truy cập và mã làm mới,
điểm cuối trao đổi mã thông báo phản hồi các yêu cầu POST bằng cách thực thi lệnh sau
các bước:
- Xác minh rằng
client_idxác định nguồn gốc của yêu cầu là nguồn đã được uỷ quyền điểm gốc vàclient_secretkhớp với giá trị dự kiến. - Xác minh rằng mã uỷ quyền là hợp lệ và chưa hết hạn, đồng thời client ID được chỉ định trong yêu cầu khớp với ID ứng dụng khách được liên kết với mã uỷ quyền.
- Xác nhận rằng URL mà tham số
redirect_urichỉ định là giống hệt nhau thành giá trị được sử dụng trong yêu cầu uỷ quyền ban đầu. - Nếu bạn không thể xác minh tất cả các tiêu chí trên, hãy trả về một HTTP
400 Lỗi Yêu cầu không hợp lệ, trong đó
{"error": "invalid_grant"}là phần nội dung. - Nếu không, hãy sử dụng mã nhận dạng người dùng trong mã uỷ quyền để tạo quy trình làm mới và mã truy cập. Các mã thông báo này có thể là giá trị chuỗi bất kỳ, nhưng phải đại diện riêng cho người dùng và khách hàng mà mã thông báo dành cho họ, đồng thời không được dễ đoán. Đối với mã truy cập, hãy ghi lại cả thời gian hết hạn của mã thông báo. Thời gian này thường là một giờ sau khi bạn cấp mã thông báo. Mã làm mới không hết hạn.
- Trả về đối tượng JSON sau đây trong phần nội dung của phản hồi HTTPS:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "refresh_token": "REFRESH_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Google lưu trữ mã truy cập và mã làm mới cho người dùng và bản ghi mã truy cập đã hết hạn. Khi mã truy cập hết hạn, Google sẽ sử dụng mã làm mới để nhận mã truy cập mới từ điểm cuối trao đổi mã thông báo.
Mã làm mới trao đổi cho mã truy cập
Khi mã truy cập hết hạn, Google sẽ gửi yêu cầu đến sàn giao dịch mã thông báo của bạn để trao đổi mã làm mới lấy mã truy cập mới.
Đối với các yêu cầu này, giá trị của grant_type là refresh_token và giá trị
refresh_token là giá trị của mã làm mới mà bạn đã cấp trước đó
Google. Sau đây là ví dụ về yêu cầu trao đổi mã làm mới
đối với mã truy cập:
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
Để đổi mã làm mới lấy mã truy cập, điểm cuối trao đổi mã thông báo của bạn
phản hồi các yêu cầu POST bằng cách thực thi các bước sau:
- Xác minh rằng
client_idxác định nguồn gốc của yêu cầu là Google, vàclient_secretkhớp với giá trị dự kiến. - Xác minh rằng mã làm mới là hợp lệ và mã ứng dụng khách được chỉ định trong yêu cầu khớp với mã ứng dụng khách liên kết với mã làm mới.
- Nếu bạn không thể xác minh tất cả các tiêu chí trên, hãy trả về HTTP 400
Lỗi Yêu cầu không hợp lệ, trong đó phần nội dung là
{"error": "invalid_grant"}. - Nếu không, hãy sử dụng mã nhận dạng người dùng từ mã làm mới để tạo quyền truy cập mã thông báo. Các mã thông báo này có thể là bất kỳ giá trị chuỗi nào, nhưng phải là duy nhất đại diện cho người dùng và khách hàng mà mã thông báo dành cho họ, đồng thời không được có thể đoán được. Đối với mã truy cập, hãy ghi lại thời gian hết hạn của mã thông báo, thường là một giờ sau khi bạn phát hành mã thông báo.
- Trả về đối tượng JSON sau trong phần nội dung của HTTPS
trả lời:
{ "token_type": "Người mang", "access_token": "ACCESS_TOKEN", "expiry_in" (hết hạn): SECONDS_TO_EXPIRATION }
处理 userinfo 请求
userinfo 端点是受 OAuth 2.0 保护的资源，会返回关联用户的声明。实现和托管 userinfo 端点是可选的，但以下用例除外：
从您的令牌端点成功检索到访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索关联用户的基本个人资料信息。
| userinfo 端点请求标头 | |
|---|---|
Authorization header |
Bearer 类型的访问令牌。 |
例如，如果您的 userinfo 端点可通过
https://myservice.example.com/userinfo 时，请求可能如下所示：
GET /userinfo HTTP/1.1 Host: myservice.example.com Authorization: Bearer ACCESS_TOKEN
为了让 userinfo 端点能够处理请求，请执行以下步骤：
- 从 Authorization 标头中提取访问令牌，并返回与访问令牌相关联的用户的信息。
- 如果访问令牌无效，则使用
WWW-Authenticate响应标头返回 HTTP 401 Unauthorized 错误。下面是一个 userinfo 错误响应示例：HTTP/1.1 401 Unauthorized WWW-Authenticate: error="invalid_token", error_description="The Access Token expired"
如果在关联过程中返回 401 未经授权错误或任何其他失败的错误响应，该错误将无法恢复，检索到的令牌将被舍弃，并且用户必须重新开始关联流程。 如果访问令牌有效，则返回 HTTPS 正文中包含以下 JSON 对象的 HTTP 200 响应 回复：
{ "sub": "USER_UUID", "email": "EMAIL_ADDRESS", "given_name": "FIRST_NAME", "family_name": "LAST_NAME", "name": "FULL_NAME", "picture": "PROFILE_PICTURE", }如果您的 userinfo 端点返回 HTTP 200 成功响应，则系统会针对用户的 Google 账号注册检索到的令牌和声明。userinfo 端点响应 sub系统中用于识别用户的唯一 ID。 email用户的电子邮件地址。 given_name可选：用户的名字。 family_name可选：用户的姓氏。 name可选：用户的全名。 picture可选：用户的个人资料照片。
Xác thực quá trình triển khai
Bạn có thể xác thực phương thức triển khai bằng cách sử dụng công cụ OAuth 2.0 Playground.
Trong công cụ này, hãy làm theo các bước sau:
- Nhấp vào biểu tượng Configuration (Cấu hình) để mở cửa sổ OAuth 2.0 Configuration (Cấu hình OAuth 2.0).
- Trong trường Quy trình OAuth, hãy chọn Phía máy khách.
- Trong trường OAuth Endpoints (Điểm cuối OAuth), hãy chọn Custom (Tuỳ chỉnh).
- Chỉ định điểm cuối OAuth 2.0 và mã ứng dụng khách mà bạn đã chỉ định cho Google trong các trường tương ứng.
- Trong phần Bước 1, đừng chọn bất kỳ phạm vi nào của Google. Thay vào đó, hãy để trống trường này hoặc nhập một phạm vi hợp lệ cho máy chủ của bạn (hoặc một chuỗi tuỳ ý nếu bạn không sử dụng phạm vi OAuth). Khi bạn hoàn tất, hãy nhấp vào Uỷ quyền cho API.
- Trong các mục Bước 2 và Bước 3, hãy thực hiện quy trình OAuth 2.0 và xác minh rằng mỗi bước hoạt động như dự kiến.
Bạn có thể xác thực việc triển khai của mình bằng cách sử dụng công cụ Bản minh hoạ về cách liên kết Tài khoản Google.
Trong công cụ này, hãy làm theo các bước sau:
- Nhấp vào nút Đăng nhập bằng Google.
- Chọn tài khoản mà bạn muốn liên kết.
- Nhập mã dịch vụ.
- Bạn có thể nhập một hoặc nhiều phạm vi mà bạn sẽ yêu cầu quyền truy cập.
- Nhấp vào Bắt đầu bản minh hoạ.
- Khi được nhắc, hãy xác nhận rằng bạn có thể đồng ý và từ chối yêu cầu liên kết.
- Xác nhận rằng bạn được chuyển hướng đến nền tảng của mình.