Tổng quan
Tính năng Liên kết đăng nhập hợp lý dựa trên OAuth dựa trên OAuth sẽ thêm tính năng Đăng nhập bằng Google vào phần Liên kết OAuth. Điều này mang lại trải nghiệm liên kết liền mạch cho người dùng Google và cũng cho phép tạo tài khoản, cho phép người dùng tạo tài khoản mới trên dịch vụ của bạn bằng Tài khoản Google của họ.
Để thực hiện liên kết tài khoản với OAuth và đăng nhập bằng Google, hãy làm theo các bước chung sau:
- Trước tiên, hãy yêu cầu người dùng đồng ý để truy cập vào hồ sơ trên Google của họ.
- Sử dụng thông tin trong hồ sơ của họ để kiểm tra xem tài khoản người dùng có tồn tại không.
- Đối với người dùng hiện tại, hãy liên kết các tài khoản.
- Nếu bạn không tìm thấy kết quả phù hợp cho người dùng Google trong hệ thống xác thực của mình, hãy xác thực mã thông báo nhận được mà bạn nhận được từ Google. Sau đó, bạn có thể tạo một người dùng dựa trên thông tin hồ sơ có trong mã thông báo nhận dạng.
Hình 1 Liên kết tài khoản trên điện thoại của người dùng bằng tính năng Liên kết đơn giản
Các yêu cầu đối với việc liên kết đơn giản
- Triển khai quy trình liên kết OAuth web cơ bản. Dịch vụ của bạn phải hỗ trợ các điểm cuối ủy quyền và token Exchange tuân thủ OAuth 2.0.
- Điểm cuối mã trao đổi mã thông báo của bạn phải hỗ trợ câu nhận định Mã thông báo web JSON (JWT) và triển khai ý định
check
,create
vàget
.
Triển khai máy chủ OAuth
Điểm cuối giao thức mã thông báo của bạn phải hỗ trợ các ý định check
, create
, get
. Dưới đây là các bước đã hoàn thành thông qua quy trình liên kết tài khoản và cho biết thời điểm các ý định khác nhau được gọi:
- Người dùng có tài khoản trong hệ thống xác thực của bạn không? (Người dùng quyết định bằng cách chọn CÓ hoặc KHÔNG)
- CÓ : Người dùng có sử dụng email liên kết với Tài khoản Google của họ để đăng nhập vào nền tảng của bạn không? (Người dùng quyết định bằng cách chọn CÓ hoặc KHÔNG)
- CÓ : Người dùng có tài khoản phù hợp trong hệ thống xác thực của bạn không? (
check intent
được gọi để xác nhận)- CÓ :
get intent
được gọi và tài khoản được liên kết nếu tính năng trả về ý định được trả về thành công. - KHÔNG : Tạo tài khoản mới? (Người dùng quyết định bằng cách chọn CÓ hoặc KHÔNG)
- CÓ :
create intent
được gọi và tài khoản được liên kết nếu việc tạo ý định trả về thành công. - KHÔNG : Luồng OAuth của web được kích hoạt, người dùng được chuyển hướng đến trình duyệt và người dùng được cung cấp tùy chọn liên kết với một email khác.
- CÓ :
- CÓ :
- KHÔNG : Quy trình OAuth của web được kích hoạt, người dùng được chuyển hướng đến trình duyệt và người dùng được cung cấp tùy chọn liên kết với một email khác.
- CÓ : Người dùng có tài khoản phù hợp trong hệ thống xác thực của bạn không? (
- KHÔNG : Người dùng có tài khoản phù hợp trong hệ thống xác thực của bạn không? (
check intent
được gọi để xác nhận)- CÓ :
get intent
được gọi và tài khoản được liên kết nếu tính năng trả về ý định được trả về thành công. - KHÔNG:
create intent
được gọi và tài khoản được liên kết nếu việc tạo ý định trả về thành công.
- CÓ :
- CÓ : Người dùng có sử dụng email liên kết với Tài khoản Google của họ để đăng nhập vào nền tảng của bạn không? (Người dùng quyết định bằng cách chọn CÓ hoặc KHÔNG)
检查现有用户帐号(检查 intent)
在用户同意访问其 Google 个人资料后,Google 会发送一个请求,其中包含 Google 用户身份的签名断言。该断言包含用户的 Google 帐号 ID、姓名和电子邮件地址。为您的项目配置的令牌交换端点会处理该请求。
如果您的身份验证系统中已存在相应的 Google 帐号,则您的令牌交换端点会返回 account_found=true
。如果 Google 帐号与现有用户不匹配,那么您的令牌交换端点会返回 account_found=false
的 HTTP 404 Not Found 错误。
请求的格式如下:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=check&assertion=JWT&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
您的令牌交换端点必须能够处理以下参数:
令牌端点参数 | |
---|---|
intent |
对于这些请求,此参数的值为 check 。 |
grant_type |
要交换的令牌的类型。对于这些请求,此参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer 。 |
assertion |
一个 JSON Web 令牌 (JWT),用于提供 Google 用户身份的签名断言。JWT 包含用户的 Google 帐号 ID、姓名和电子邮件地址等信息。 |
client_id |
您分配给 Google 的客户端 ID。 |
client_secret |
您分配给 Google 的客户端密钥。 |
为了响应 check
intent 请求,您的令牌交换端点必须执行以下步骤:
- 验证并解码 JWT 断言。
- 检查您的身份验证系统中是否已存在该 Google 帐号。
验证并解码JWT断言
您可以使用针对您的语言的JWT解码库来验证和解码JWT断言。使用Google的JWK或PEM格式的公钥来验证令牌的签名。
解码后,JWT断言类似于以下示例:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
除了验证令牌的签名外,还要验证断言的颁发者( iss
字段)为https://accounts.google.com
,受众( aud
字段)是您分配的客户端ID,并且令牌尚未过期( exp
场地)。
使用email
, email_verified
和hd
字段,您可以确定Google是否托管电子邮件地址并对其具有权威性。如果Google具有权威性,则当前已知该用户为合法帐户所有者,您可以跳过密码或其他挑战方法。否则,可以使用这些方法在链接之前验证帐户。
Google具有权威性的情况:
-
email
后缀为@gmail.com
,这是一个Gmail帐户。 -
email_verified
为true并且设置了hd
,这是一个G Suite帐户。
用户可以在不使用Gmail或G Suite的情况下注册Google帐户。如果email
不包含@gmail.com
后缀,并且没有hd
则Google并不具有权威性,建议您使用密码或其他验证方法来验证用户。当Google在创建Google帐户时最初验证了用户时, email_verfied
也可能为true,但是此后第三方电子邮件帐户的所有权可能已更改。
检查您的身份验证系统中是否已存在该 Google 帐号
检查是否满足以下任一条件:
- Google 帐号 ID 可在用户的数据库中找到,可在断言的
sub
字段找到。 - 断言中的电子邮件地址与您的用户数据库中的用户匹配。
如果其中任一条件为 true,则表示用户已注册。在这种情况下,系统将返回如下所示的响应:
HTTP/1.1 200 Success Content-Type: application/json;charset=UTF-8 { "account_found":"true", }
如果断言中指定的 Google 帐号 ID 和电子邮件地址都与用户数据库中的用户不匹配,则表示用户尚未注册。在这种情况下,您的令牌交换端点需要使用包含 "account_found": "false"
的 HTTP 404 错误进行响应,如以下示例所示:
HTTP/1.1 404 Not found Content-Type: application/json;charset=UTF-8 { "account_found":"false", }
Xử lý đường liên kết tự động (lấy ý định)
Sau khi người dùng đồng ý truy cập vào Hồ sơ trên Google, Google sẽ gửi một yêu cầu chứa thông tin xác nhận đã ký về danh tính của người dùng Google đó. Quy trình xác nhận chứa thông tin bao gồm mã, tên và địa chỉ email của Tài khoản Google của người dùng. Điểm cuối trao đổi mã thông báo được định cấu hình cho dự án của bạn sẽ xử lý yêu cầu đó.
Nếu Tài khoản Google tương ứng đã có trong hệ thống xác thực, điểm cuối trao đổi mã thông báo sẽ trả về một mã thông báo cho người dùng. Nếu Tài khoản Google không khớp với người dùng hiện tại, thì điểm cuối mã thông báo trao đổi của bạn sẽ trả về lỗi linking_error
và login_hint
(không bắt buộc).
Yêu cầu có biểu mẫu sau:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
Điểm cuối trao đổi mã thông báo của bạn phải có thể xử lý các thông số sau:
Thông số điểm cuối mã thông báo | |
---|---|
intent |
Đối với những yêu cầu này, giá trị của thông số này là get . |
grant_type |
Loại mã thông báo đang được trao đổi. Đối với những yêu cầu này, thông số
này có giá trị urn:ietf:params:oauth:grant-type:jwt-bearer . |
assertion |
Mã thông báo Web JSON (JWT) cung cấp xác nhận đã ký về danh tính người dùng Google. JWT chứa thông tin bao gồm tên, địa chỉ email và mã Tài khoản Google của người dùng. |
scope |
Không bắt buộc: Mọi phạm vi mà bạn đã định cấu hình để Google yêu cầu người dùng. |
client_id |
Mã ứng dụng khách mà bạn đã chỉ định cho Google. |
client_secret |
Mật khẩu ứng dụng khách mà bạn đã gán cho Google. |
Để phản hồi các yêu cầu ý định get
, điểm cuối trao đổi mã thông báo của bạn phải thực hiện các bước sau:
- Xác thực và giải mã lời khẳng định trong WWT.
- Kiểm tra xem Tài khoản Google đã có trong hệ thống xác thực của bạn hay chưa.
验证并解码JWT断言
您可以使用针对您的语言的JWT解码库来验证和解码JWT断言。使用Google的JWK或PEM格式的公钥来验证令牌的签名。
解码后,JWT断言类似于以下示例:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
除了验证令牌的签名外,还要验证断言的颁发者( iss
字段)为https://accounts.google.com
,受众( aud
字段)是您分配的客户端ID,并且令牌尚未过期( exp
场地)。
使用email
, email_verified
和hd
字段,您可以确定Google是否托管电子邮件地址并对其具有权威性。如果Google具有权威性,则当前已知该用户为合法帐户所有者,您可以跳过密码或其他挑战方法。否则,可以使用这些方法在链接之前验证帐户。
Google具有权威性的情况:
-
email
后缀为@gmail.com
,这是一个Gmail帐户。 -
email_verified
为true并且设置了hd
,这是一个G Suite帐户。
用户可以在不使用Gmail或G Suite的情况下注册Google帐户。如果email
不包含@gmail.com
后缀,并且没有hd
则Google并不具有权威性,建议您使用密码或其他验证方法来验证用户。当Google在创建Google帐户时最初验证了用户时, email_verfied
也可能为true,但是此后第三方电子邮件帐户的所有权可能已更改。
Kiểm tra xem Tài khoản Google đã có trong hệ thống xác thực của bạn hay chưa
Kiểm tra xem một trong các điều kiện sau có đúng hay không:
- Mã tài khoản Google có trong trường
sub
xác nhận nằm trong cơ sở dữ liệu người dùng của bạn. - Địa chỉ email trong phần xác nhận khớp với người dùng trong cơ sở dữ liệu người dùng của bạn.
Nếu người dùng tìm thấy một tài khoản, hãy cấp mã truy cập và trả về các giá trị trong một đối tượng JSON trong phần nội dung của phản hồi HTTPS, như trong ví dụ sau:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Trong một số trường hợp, việc liên kết tài khoản dựa trên mã thông báo nhận dạng có thể không thành công cho người dùng. Nếu
làm như vậy vì bất kỳ lý do gì, điểm cuối trao đổi mã thông báo của bạn cần phải trả lời bằng lỗi HTTP
401 chỉ định error=linking_error
, như trong ví dụ sau:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
Khi Google nhận được phản hồi lỗi 401 với linking_error
, Google sẽ gửi
người dùng đến điểm cuối ủy quyền của bạn với thông số login_hint
. Người dùng
hoàn tất việc liên kết tài khoản bằng cách sử dụng quy trình liên kết OAuth trong trình duyệt của họ.
通过 Google 登录功能创建帐号(创建 intent)
当用户需要在您的服务上创建帐号时,Google 会向您的令牌交换端点发出请求,并指定 intent=create
。
请求的格式如下:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&assertion=JWT&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET
您的令牌交换端点必须能够处理以下参数:
令牌端点参数 | |
---|---|
intent |
对于这些请求,此参数的值为 create 。 |
grant_type |
要交换的令牌的类型。对于这些请求,此参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer 。 |
assertion |
一个 JSON Web 令牌 (JWT),用于提供 Google 用户身份的签名断言。JWT 包含用户的 Google 帐号 ID、姓名和电子邮件地址等信息。 |
client_id |
您分配给 Google 的客户端 ID。 |
client_secret |
您分配给 Google 的客户端密钥。 |
assertion
参数中的 JWT 包含用户的 Google 帐号 ID、名称和电子邮件地址,您可以使用这些信息在服务中创建新帐号。
为了响应 create
intent 请求,您的令牌交换端点必须执行以下步骤:
- 验证并解码 JWT 断言。
- 验证用户信息并创建新帐号。
验证并解码JWT断言
您可以使用针对您的语言的JWT解码库来验证和解码JWT断言。使用Google的JWK或PEM格式的公钥来验证令牌的签名。
解码后,JWT断言类似于以下示例:
{ "sub": "1234567890", // The unique ID of the user's Google Account "iss": "https://accounts.google.com", // The assertion's issuer "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID "iat": 233366400, // Unix timestamp of the assertion's creation time "exp": 233370000, // Unix timestamp of the assertion's expiration time "name": "Jan Jansen", "given_name": "Jan", "family_name": "Jansen", "email": "jan@gmail.com", // If present, the user's email address "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
除了验证令牌的签名外,还要验证断言的颁发者( iss
字段)为https://accounts.google.com
,受众( aud
字段)是您分配的客户端ID,并且令牌尚未过期( exp
场地)。
使用email
, email_verified
和hd
字段,您可以确定Google是否托管电子邮件地址并对其具有权威性。如果Google具有权威性,则当前已知该用户为合法帐户所有者,您可以跳过密码或其他挑战方法。否则,可以使用这些方法在链接之前验证帐户。
Google具有权威性的情况:
-
email
后缀为@gmail.com
,这是一个Gmail帐户。 -
email_verified
为true并且设置了hd
,这是一个G Suite帐户。
用户可以在不使用Gmail或G Suite的情况下注册Google帐户。如果email
不包含@gmail.com
后缀,并且没有hd
则Google并不具有权威性,建议您使用密码或其他验证方法来验证用户。当Google在创建Google帐户时最初验证了用户时, email_verfied
也可能为true,但是此后第三方电子邮件帐户的所有权可能已更改。
验证用户信息并创建新帐号
检查是否满足以下任一条件:
- Google 帐号 ID 可在用户的数据库中找到,可在断言的
sub
字段找到。 - 断言中的电子邮件地址与您的用户数据库中的用户匹配。
如果任一条件为 true,请提示用户将其现有帐号与其 Google 帐号相关联。为此,请对请求进行响应,并提供指定 error=linking_error
并将用户的电子邮件地址作为 login_hint
的 HTTP 401 错误。以下是一个示例响应:
HTTP/1.1 401 Unauthorized Content-Type: application/json;charset=UTF-8 { "error":"linking_error", "login_hint":"foo@bar.com" }
Google 收到包含 linking_error
的 401 错误响应后,会将用户作为授权参数 login_hint
发送到您的授权端点。用户在浏览器中使用 OAuth 关联流程完成帐号关联。
如果两个条件都不满足,请使用 JWT 中提供的信息创建新的用户帐号。新帐号通常不会设置密码。建议您将 Google 登录功能添加到其他平台,以便用户能够在应用界面使用 Google 帐号登录。或者,您也可以通过电子邮件向用户发送一个启动密码恢复流程的链接,以便用户设置密码以在其他平台上登录。
创建完成后,发出访问令牌 ,并在 HTTPS 响应的正文中以 JSON 对象形式返回值,如以下示例所示:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Lấy mã ứng dụng khách Google API
Bạn sẽ phải cung cấp Mã ứng dụng khách Google API của mình trong quá trình đăng ký Liên kết tài khoản.
Cách lấy mã nhận dạng ứng dụng khách API bằng dự án bạn đã tạo trong khi hoàn thành các bước Liên kết OAuth. Để làm được điều này, vui lòng hoàn thành các bước sau:
- Mở trang Credentials (Thông tin xác thực) của bảng điều khiển API Google.
Tạo hoặc chọn dự án API của Google.
Nếu dự án của bạn không có Mã ứng dụng khách cho Loại ứng dụng web, hãy nhấp vào Tạo thông tin xác thực & gt; Mã ứng dụng khách OAuth để tạo. Hãy nhớ đưa miền của trang web vào hộp Nguồn JavaScript được ủy quyền. Khi thực hiện các thử nghiệm cục bộ hoặc phát triển, bạn phải thêm cả
http://localhost
vàhttp://localhost:<port_number>
vào trường Nguồn JavaScript được ủy quyền.
Xác thực quá trình triển khai
您可以通过使用验证实现的OAuth 2.0游乐场工具。
在工具中,执行以下步骤:
- 单击配置 打开的OAuth 2.0配置窗口。
- 在OAuth流场中,选择客户端。
- 在OAuth端点字段中,选择自定义。
- 在相应字段中指定您的 OAuth 2.0 端点和您分配给 Google 的客户端 ID。
- 在步骤1部分,不要选择任何谷歌范围。相反,将此字段留空或键入对您的服务器有效的范围(如果不使用 OAuth 范围,则输入任意字符串)。当您完成后,单击授权的API。
- 在步骤2和步骤3段,完成OAuth 2.0流程和验证每个步骤按预期工作。
您可以通过验证您的实现谷歌帐户链接演示工具。
在工具中,执行以下步骤:
- 点击登录在与谷歌按钮。
- 选择您要关联的帐户。
- 输入服务标识。
- (可选)输入您将请求访问的一个或多个范围。
- 单击开始演示。
- 出现提示时,确认您可以同意并拒绝链接请求。
- 确认您被重定向到您的平台。