Đơn giản hoá việc liên kết với OAuth và tính năng Đăng nhập bằng Google

Tổng quan

Liên kết tinh giản tính năng Đăng nhập bằng Google dựa trên OAuth sẽ thêm tính năng Đăng nhập bằng Google ở đầu 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, đồng thời tính năng tạo tài khoản cũng 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 bằng OAuth và Đăng nhập bằng Google, hãy làm theo các bước chung sau các bước:

  1. 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ọ.
  2. 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.
  3. Đối với người dùng hiện tại, hãy liên kết các tài khoản này.
  4. Nếu bạn không tìm thấy thông tin trùng khớp với người dùng Google trong hệ thống xác thực của mình, xác thực mã thông báo nhận dạng nhận được từ Google. Sau đó, bạn có thể tạo một báo cáo dựa trên người dùng về thông tin hồ sơ có trong mã thông báo nhận dạng.
Hình này minh hoạ các bước để người dùng liên kết Tài khoản Google của họ bằng quy trình liên kết đơn giản. Ảnh chụp màn hình đầu tiên cho thấy cách người dùng có thể chọn ứng dụng của bạn để liên kết. Ảnh chụp màn hình thứ hai cho phép người dùng xác nhận xem họ đã có tài khoản trên dịch vụ của bạn hay chưa. Ảnh chụp màn hình thứ ba cho phép người dùng chọn Tài khoản Google họ muốn liên kết. Ảnh chụp màn hình thứ tư cho thấy thông báo xác nhận liên kết Tài khoản Google của họ với ứng dụng của bạn. Ảnh chụp màn hình thứ năm cho thấy một tài khoản người dùng được liên kết thành công trong ứng dụng Google.

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

Yêu cầu đối với đường liên kết được tinh giản

Triển khai máy chủ OAuth

Điểm cuối trao đổi mã thông báo của bạn phải hỗ trợ ý định check, create, get. Dưới đây là các bước đã hoàn tất thông qua quy trình liên kết tài khoản và cho biết thời điểm gọi các ý định khác nhau:

  1. 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)
    1. 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)
      1. CÓ : Người dùng có tài khoản trùng khớp trong hệ thống xác thực của bạn không? (check intent được gọi để xác nhận)
        1. CÓ : get intent sẽ được gọi và tài khoản sẽ được liên kết nếu nhận được ý định trả về thành công.
        2. 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)
          1. CÓ : create intent được gọi và tài khoản sẽ được liên kết nếu trả về ý định tạo thành công.
          2. KHÔNG : Luồng OAuth trên web được kích hoạt, người dùng được chuyển hướng đến trình duyệt của họ và người dùng được cung cấp tuỳ chọn liên kết với một email khác.
      2. KHÔNG : Luồng OAuth trên web được kích hoạt, người dùng được chuyển hướng đến trình duyệt của họ và người dùng được chọn liên kết với một email khác.
    2. KHÔNG : Người dùng có tài khoản trùng khớp trong hệ thống xác thực của bạn không? (check intent được gọi để xác nhận)
      1. CÓ : get intent sẽ được gọi và tài khoản sẽ được liên kết nếu nhận được ý định trả về thành công.
      2. KHÔNG : create intent được gọi và tài khoản sẽ được liên kết nếu trả về ý định tạo thành công.

Kiểm tra tài khoản người dùng hiện có (kiểm tra ý định)

Sau khi người dùng đồng ý truy cập vào hồ sơ trên Google của họ, Google sẽ gửi yêu cầu chứa xác nhận có chữ ký về danh tính của người dùng Google. Chiến lược phát hành đĩa đơn xác nhận chứa thông tin bao gồm ID Tài khoản Google của người dùng, tên và địa chỉ email của bạn. Điểm cuối trao đổi mã thông báo được định cấu hình cho dự án sẽ xử lý yêu cầu đó.

Nếu đã có Tài khoản Google tương ứng trong quá trình xác thực hệ thống, điểm cuối trao đổi mã thông báo của bạn sẽ phản hồi bằng account_found=true. Nếu Tài khoản Google không khớp với người dùng hiện có, điểm cuối trao đổi mã thông báo của bạn trả về lỗi HTTP 404 Not found (Không tìm thấy) với account_found=false.

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=check&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ó khả năng xử lý các tham số sau:

Tham số điểm cuối của mã thông báo
intent Đối với các yêu cầu này, giá trị của thông số này là check.
grant_type Loại mã thông báo đang được trao đổi. Đối với các yêu cầu này, tham số 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 có chữ ký của Google danh tính của người dùng. JWT chứa thông tin bao gồm Mã Tài khoản Google, tên và địa chỉ email.
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 đã chỉ định cho Google.

Để phản hồi các yêu cầu về ý định check, điểm cuối trao đổi mã thông báo phải thực hiện các bước sau:

  • Xác thực và giải mã câu nhận định JWT.
  • 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 解码库。使用 Google 的公钥,在 JWKPEM 格式,用于验证 令牌的签名。

解码后,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 字段)。

使用 emailemail_verifiedhd 字段,您可以确定 Google 负责托管电子邮件地址,并对其具有权威性。如果 Google 权威性 - 用户当前被认定为合法账号所有者 您可以跳过密码或其他验证方法。否则,这些方法 可用于在关联之前验证账号。

Google 具有权威性的情形:

  • email 的后缀为 @gmail.com,这是一个 Gmail 账号。
  • email_verified 为 true 且 hd 已设置,这是 G Suite 账号。

用户无需使用 Gmail 或 G Suite 即可注册 Google 账号。时间 email 不包含 @gmail.com 后缀,且 hd 不存在 Google 不 建议使用权威凭据和密码或其他验证方法进行验证 用户。email_verified 可能为 true,因为 Google 最初验证了 创建 Google 账号后,该用户会获得第三方的所有权, 后,电子邮件账号可能已更改。

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 (trong trường sub của câu nhận định) nằm trong tài khoản người dùng của bạn cơ sở dữ liệu.
  • Địa chỉ email trong câu nhận định khớp với một người dùng trong cơ sở dữ liệu người dùng của bạn.

Nếu một trong hai điều kiện đúng, thì người dùng đã đăng ký. Trong trường hợp đó, trả về phản hồi như sau:

HTTP/1.1 200 Success
Content-Type: application/json;charset=UTF-8

{
  "account_found":"true",
}

Nếu cả mã Tài khoản Google và địa chỉ email được chỉ định trong khớp với người dùng trong cơ sở dữ liệu của bạn, người dùng chưa đăng ký. Trong trong trường hợp này, đ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 404 chỉ định "account_found": "false", như trong ví dụ sau:

HTTP/1.1 404 Not found
Content-Type: application/json;charset=UTF-8

{
  "account_found":"false",
}

处理自动链接(获取 intent)

在用户同意访问其 Google 个人资料后,Google 会发送 请求,其中包含 Google 用户身份的已签名断言。通过 断言包含的信息包括用户的 Google 账号 ID、 姓名和电子邮件地址为您的 Google Cloud 控制台配置的令牌交换端点 项目处理该请求。

如果您的身份验证中已有相应的 Google 账号 系统,您的令牌交换端点将为用户返回一个令牌。如果 Google 账号与现有用户不匹配,您的令牌交换端点 返回 linking_error 错误和可选的 login_hint

请求的格式如下:

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

您的令牌交换端点必须能够处理以下参数:

令牌端点参数
intent 对于这些请求,此参数的值为 get
grant_type 所交换的令牌的类型。对于这类请求 参数的值为 urn:ietf:params:oauth:grant-type:jwt-bearer
assertion 一个 JSON Web 令牌 (JWT),提供 Google 用户身份。JWT 包含的信息包括用户 Google 账号 ID、姓名和电子邮件地址。
scope 可选:您已将 Google 配置为向其请求访问权限的任何范围 用户。
client_id 您分配给 Google 的客户 ID。
client_secret 您分配给 Google 的客户端密钥。

如需响应 get intent 请求,您的令牌交换端点必须执行以下步骤:

  • 验证和解码 JWT 断言。
  • 检查您的身份验证系统中是否已存在该 Google 账号。
验证和解码 JWT 断言

您可以使用 适用于您所用语言的 JWT 解码库。使用 Google 的公钥,在 JWKPEM 格式,用于验证 令牌的签名。

解码后,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 字段)。

使用 emailemail_verifiedhd 字段,您可以确定 Google 负责托管电子邮件地址,并对其具有权威性。如果 Google 权威性 - 用户当前被认定为合法账号所有者 您可以跳过密码或其他验证方法。否则,这些方法 可用于在关联之前验证账号。

Google 具有权威性的情形:

  • email 的后缀为 @gmail.com,这是一个 Gmail 账号。
  • email_verified 为 true 且 hd 已设置,这是 G Suite 账号。

用户无需使用 Gmail 或 G Suite 即可注册 Google 账号。时间 email 不包含 @gmail.com 后缀,且 hd 不存在 Google 不 建议使用权威凭据和密码或其他验证方法进行验证 用户。email_verified 可能为 true,因为 Google 最初验证了 创建 Google 账号后,该用户会获得第三方的所有权, 后,电子邮件账号可能已更改。

检查您的身份验证系统中是否已存在该 Google 账号

请检查以下任一条件是否成立:

  • Google 账号 ID(可在断言的 sub 字段中找到)位于您的用户中 数据库。
  • 断言中的电子邮件地址与用户数据库中的用户匹配。

如果找到了用户的账号,请发出访问令牌,并在 HTTPS 响应正文的 JSON 对象中返回相应值,如以下示例所示:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",

  "refresh_token": "REFRESH_TOKEN",

  "expires_in": SECONDS_TO_EXPIRATION
}

在某些情况下,基于 ID 令牌的账号关联可能会失败。如果 因为任何原因,您的令牌交换端点都需要以 HTTP 响应 指定 error=linking_error 的 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 关联流程完成账号关联。

Xử lý việc tạo tài khoản thông qua tính năng Đăng nhập bằng Google (tạo ý định)

Khi người dùng cần tạo một tài khoản trên dịch vụ của bạn, Google sẽ đưa ra yêu cầu đến điểm cuối trao đổi mã thông báo chỉ định intent=create.

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

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

Điểm cuối trao đổi mã thông báo của bạn phải có khả năng xử lý các tham số sau:

Tham số điểm cuối của mã thông báo
intent Đối với các yêu cầu này, giá trị của tham số này là create.
grant_type Loại mã thông báo đang được trao đổi. Đối với các yêu cầu này, tham số 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 có chữ ký của Google danh tính của người dùng. JWT chứa thông tin bao gồm Mã Tài khoản Google, tên và địa chỉ email.
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 đã chỉ định cho Google.

JWT trong tham số assertion chứa ID Tài khoản Google của người dùng, tên và địa chỉ email mà bạn có thể sử dụng để tạo tài khoản mới trên .

Để phản hồi các yêu cầu về ý định create, điểm cuối trao đổi mã thông báo phải thực hiện các bước sau:

  • Xác thực và giải mã câu nhận định JWT.
  • Xác thực thông tin người dùng và tạo tài khoản mới.
验证和解码 JWT 断言

您可以使用 适用于您所用语言的 JWT 解码库。使用 Google 的公钥,在 JWKPEM 格式,用于验证 令牌的签名。

解码后,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 字段)。

使用 emailemail_verifiedhd 字段,您可以确定 Google 负责托管电子邮件地址,并对其具有权威性。如果 Google 权威性 - 用户当前被认定为合法账号所有者 您可以跳过密码或其他验证方法。否则,这些方法 可用于在关联之前验证账号。

Google 具有权威性的情形:

  • email 的后缀为 @gmail.com,这是一个 Gmail 账号。
  • email_verified 为 true 且 hd 已设置,这是 G Suite 账号。

用户无需使用 Gmail 或 G Suite 即可注册 Google 账号。时间 email 不包含 @gmail.com 后缀,且 hd 不存在 Google 不 建议使用权威凭据和密码或其他验证方法进行验证 用户。email_verified 可能为 true,因为 Google 最初验证了 创建 Google 账号后,该用户会获得第三方的所有权, 后,电子邮件账号可能已更改。

Xác thực thông tin người dùng và tạo tài khoản mới

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 (trong trường sub của câu nhận định) nằm trong tài khoản người dùng của bạn cơ sở dữ liệu.
  • Địa chỉ email trong câu nhận định khớp với một người dùng trong cơ sở dữ liệu người dùng của bạn.

Nếu một trong hai điều kiện đúng, hãy nhắc người dùng liên kết tài khoản hiện có của họ bằng Tài khoản Google của họ. Để thực hiện việc này, hãy phản hồi yêu cầu với lỗi HTTP 401 chỉ định error=linking_error và cung cấp địa chỉ email của người dùng làm login_hint Sau đây là phản hồi mẫu:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

Khi 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 uỷ quyền của bạn bằng tham số login_hint. Chiến lược phát hành đĩa đơn người dùng hoàn tất quá trình liên kết tài khoản bằng quy trình liên kết OAuth trong trình duyệt của họ.

Nếu không có điều kiện nào đúng, hãy tạo tài khoản người dùng mới có thông tin đó được cung cấp trong JWT. Các tài khoản mới thường chưa đặt mật khẩu. Bây giờ bạn nên thêm tính năng Đăng nhập bằng Google vào các nền tảng khác để người dùng có thể đăng nhập bằng Google trên các nền tảng của ứng dụng. Ngoài ra, bạn có thể gửi email cho người dùng một liên kết bắt đầu quy trình khôi phục mật khẩu để cho phép đặt mật khẩu để đăng nhập trên các nền tảng khác.

Khi quá trình tạo hoàn tất, hãy cấp một mã truy cập và làm mới mã thông báo rồi trả về các giá trị trong đối tượng JSON trong nội dung của phản hồi HTTPS, như trong ví dụ sau:

{
  "token_type": "Bearer",
  "access_token": "ACCESS_TOKEN",

  "refresh_token": "REFRESH_TOKEN",

  "expires_in": SECONDS_TO_EXPIRATION
}

Lấy mã ứng dụng khách Google API của bạn

Bạn sẽ phải cung cấp Mã ứng dụng khách Google API trong quá trình đăng ký tính năng Liên kết tài khoản.

Cách nhận ID ứng dụng API bằng cách sử dụng dự án bạn đã tạo trong khi hoàn tất các bước Liên kết OAuth. Để thực hiện điều này, vui lòng hoàn thành các bước sau:

  1. Mở trang Thông tin đăng nhập của Bảng điều khiển API của Google.
  2. Tạo hoặc chọn một dự án Google API.

    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 > Mã ứng dụng OAuth để tạo một mã. Hãy nhớ cung cấp miền trang web của bạn vào hộp Nguồn gốc JavaScript được cho phép. Khi bạn biểu diễn kiểm thử hoặc phát triển cục bộ, bạn phải thêm cả http://localhosthttp://localhost:<port_number> vào trường Các nguồn gốc JavaScript được cho phép.

Xác thực quá trình triển khai

Bạn có thể xác nhận thực hiện của bạn bằng cách sử dụng các sân chơi OAuth 2.0 công cụ.

Trong công cụ, hãy thực hiện các bước sau:

  1. Nhấp vào Cấu hình để mở cửa sổ OAuth 2.0 Configuration.
  2. Trong lĩnh vực dòng chảy OAuth, chọn Client-side.
  3. Trong lĩnh vực OAuth thiết bị đầu cuối, chọn Custom.
  4. Chỉ định điểm cuối OAuth 2.0 của bạn và ID khách hàng mà bạn đã chỉ định cho Google trong các trường tương ứng.
  5. Trong phần Bước 1, không chọn bất kỳ phạm vi của Google. Thay vào đó, hãy để trống trường này hoặc nhập phạm vi hợp lệ cho máy chủ của bạn (hoặc một chuỗi tùy ý nếu bạn không sử dụng phạm vi OAuth). Khi bạn đã hoàn tất, nhấn Authorize API.
  6. Trong các phần Bước 2Bước 3, đi qua các dòng chảy 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 nhận thực hiện của bạn bằng cách sử dụng các tài khoản Google Liên kết Demo công cụ.

Trong công cụ, hãy thực hiện các bước sau:

  1. Nhấp vào Sign-in với nút Google.
  2. Chọn tài khoản bạn muốn liên kết.
  3. Nhập ID dịch vụ.
  4. Tùy ý nhập một hoặc nhiều phạm vi mà bạn sẽ yêu cầu quyền truy cập.
  5. Nhấp vào Bắt đầu Demo.
  6. 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.
  7. Xác nhận rằng bạn được chuyển hướng đến nền tảng của mình.