Liên kết hợp lý với OAuth và Đăng nhập bằng Google

Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Tổng quan

Tính năng Liên kết hợp lý để đăng nhập bằng Google OAuth sẽ thêm tính năng Đăng nhập bằng Google ngoài Tính năng 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ọ.

Để liên kết tài khoản bằng OAuth và tính năng Đăng nhập bằng Google, hãy làm theo những bước chung sau đây:

  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 hay 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 đó.
  4. Nếu bạn không tìm thấy thông tin khớp cho người dùng Google trong hệ thống xác thực, hãy xác thực mã thông báo nhận dạng mà Google nhận được. Sau đó, bạn có thể tạo người dùng dựa trên thông tin tiểu sử có trong mã thông báo nhận dạng.
Hình này cho thấy các bước để người dùng liên kết Tài khoản Google của họ bằng cách sử dụ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 mà 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 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 được đơn giản hóa

Yêu cầu đối với việc liên kết đơn giản

Triển khai máy chủ OAuth của bạn

Điểm cuối token trao đổi 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:

  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ả lại 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 quá trình tạo ý định 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ó thể 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ả lại 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 quá trình tạo ý định thành công.

Kiểm tra để tìm 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, 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 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 tại, thì điểm cuối trao đổi mã thông báo của bạn sẽ trả về lỗi Không tìm thấy HTTP 404 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ó 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à check.
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.
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 check, đ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.
Xác thực và giải mã khẳng định JWT

Bạn có thể xác thực và giải mã xác nhận JWT bằng cách sử dụng thư viện giải mã JWT cho ngôn ngữ của bạn . Sử dụng khóa công khai của Google, có sẵn ở định dạng JWK hoặc PEM , để xác minh chữ ký của mã thông báo.

Khi được giải mã, xác nhận JWT trông giống như ví dụ sau:

{
  "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
}

Ngoài xác minh chữ ký của mã thông báo, xác minh rằng tổ chức phát hành của sự khẳng định ( iss trường) là https://accounts.google.com , mà khán giả ( aud trường) là ID của khách hàng được phân công của mình, và rằng các dấu hiệu chưa hết hạn ( exp cánh đồng).

Sử dụng các trường email , email_verifiedhd bạn có thể xác định xem Google có lưu trữ và có thẩm quyền cho một địa chỉ email hay không. Trong trường hợp Google có thẩm quyền, người dùng hiện được coi là chủ sở hữu tài khoản hợp pháp và bạn có thể bỏ qua mật khẩu hoặc các phương pháp thử thách khác. Nếu không, các phương pháp này có thể được sử dụng để xác minh tài khoản trước khi liên kết.

Các trường hợp mà Google có thẩm quyền:

  • email có hậu tố @gmail.com , đây là tài khoản Gmail.
  • email_verified là true và hd được đặt, đây là tài khoản G Suite.

Người dùng có thể đăng ký Tài khoản Google mà không cần sử dụng Gmail hoặc G Suite. Khi email không chứa hậu tố @gmail.com và không có hd Google không có thẩm quyền và bạn nên sử dụng mật khẩu hoặc các phương pháp thử thách khác để xác minh người dùng. email_verfied cũng có thể đúng vì ban đầu Google đã xác minh người dùng khi tài khoản Google được tạo, tuy nhiên quyền sở hữu tài khoản email của bên thứ ba có thể đã thay đổi.

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 một trong hai điều kiện là đúng thì người dùng đã đăng ký. Trong trường hợp đó, hãy 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 mã tài khoản Google và địa chỉ email đã chỉ định trong xác nhận không khớp với người dùng trong cơ sở dữ liệu của bạn, thì người dùng chưa đăng ký. 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 phản hồ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",
}

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_errorlogin_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.
Xác thực và giải mã khẳng định JWT

Bạn có thể xác thực và giải mã xác nhận JWT bằng cách sử dụng thư viện giải mã JWT cho ngôn ngữ của bạn . Sử dụng khóa công khai của Google, có sẵn ở định dạng JWK hoặc PEM , để xác minh chữ ký của mã thông báo.

Khi được giải mã, xác nhận JWT trông giống như ví dụ sau:

{
  "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
}

Ngoài xác minh chữ ký của mã thông báo, xác minh rằng tổ chức phát hành của sự khẳng định ( iss trường) là https://accounts.google.com , mà khán giả ( aud trường) là ID của khách hàng được phân công của mình, và rằng các dấu hiệu chưa hết hạn ( exp cánh đồng).

Sử dụng các trường email , email_verifiedhd bạn có thể xác định xem Google có lưu trữ và có thẩm quyền cho một địa chỉ email hay không. Trong trường hợp Google có thẩm quyền, người dùng hiện được coi là chủ sở hữu tài khoản hợp pháp và bạn có thể bỏ qua mật khẩu hoặc các phương pháp thử thách khác. Nếu không, các phương pháp này có thể được sử dụng để xác minh tài khoản trước khi liên kết.

Các trường hợp mà Google có thẩm quyền:

  • email có hậu tố @gmail.com , đây là tài khoản Gmail.
  • email_verified là true và hd được đặt, đây là tài khoản G Suite.

Người dùng có thể đăng ký Tài khoản Google mà không cần sử dụng Gmail hoặc G Suite. Khi email không chứa hậu tố @gmail.com và không có hd Google không có thẩm quyền và bạn nên sử dụng mật khẩu hoặc các phương pháp thử thách khác để xác minh người dùng. email_verfied cũng có thể đúng vì ban đầu Google đã xác minh người dùng khi tài khoản Google được tạo, tuy nhiên quyền sở hữu tài khoản email của bên thứ ba có thể đã thay đổi.

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ọ.

Handle account creation via Google Sign-In (create intent)

When a user needs to create an account on your service, Google makes a request to your token exchange endpoint that specifies intent=create.

The request has the following form:

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

Your token exchange endpoint must able to handle the following parameters:

Token endpoint parameters
intent For these requests, the value of this parameter is create.
grant_type The type of token being exchanged. For these requests, this parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer.
assertion A JSON Web Token (JWT) that provides a signed assertion of the Google user's identity. The JWT contains information that includes the user's Google Account ID, name, and email address.
client_id The client ID you assigned to Google.
client_secret The client secret you assigned to Google.

The JWT within the assertion parameter contains the user's Google Account ID, name, and email address, which you can use to create a new account on your service.

To respond to the create intent requests, your token exchange endpoint must perform the following steps:

  • Validate and decode the JWT assertion.
  • Validate user information and create new account.
Xác thực và giải mã khẳng định JWT

Bạn có thể xác thực và giải mã xác nhận JWT bằng cách sử dụng thư viện giải mã JWT cho ngôn ngữ của bạn . Sử dụng khóa công khai của Google, có sẵn ở định dạng JWK hoặc PEM , để xác minh chữ ký của mã thông báo.

Khi được giải mã, xác nhận JWT trông giống như ví dụ sau:

{
  "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
}

Ngoài xác minh chữ ký của mã thông báo, xác minh rằng tổ chức phát hành của sự khẳng định ( iss trường) là https://accounts.google.com , mà khán giả ( aud trường) là ID của khách hàng được phân công của mình, và rằng các dấu hiệu chưa hết hạn ( exp cánh đồng).

Sử dụng các trường email , email_verifiedhd bạn có thể xác định xem Google có lưu trữ và có thẩm quyền cho một địa chỉ email hay không. Trong trường hợp Google có thẩm quyền, người dùng hiện được coi là chủ sở hữu tài khoản hợp pháp và bạn có thể bỏ qua mật khẩu hoặc các phương pháp thử thách khác. Nếu không, các phương pháp này có thể được sử dụng để xác minh tài khoản trước khi liên kết.

Các trường hợp mà Google có thẩm quyền:

  • email có hậu tố @gmail.com , đây là tài khoản Gmail.
  • email_verified là true và hd được đặt, đây là tài khoản G Suite.

Người dùng có thể đăng ký Tài khoản Google mà không cần sử dụng Gmail hoặc G Suite. Khi email không chứa hậu tố @gmail.com và không có hd Google không có thẩm quyền và bạn nên sử dụng mật khẩu hoặc các phương pháp thử thách khác để xác minh người dùng. email_verfied cũng có thể đúng vì ban đầu Google đã xác minh người dùng khi tài khoản Google được tạo, tuy nhiên quyền sở hữu tài khoản email của bên thứ ba có thể đã thay đổi.

Validate user information and create new account

Check whether either of the following conditions are true:

  • The Google Account ID, found in the assertion's sub field, is in your user database.
  • The email address in the assertion matches a user in your user database.

If either condition is true, prompt the user to link their existing account with their Google Account. To do so, respond to the request with an HTTP 401 error that specifies error=linking_error and gives the user's email address as the login_hint. The following is a sample response:

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

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

When Google receives a 401 error response with linking_error, Google sends the user to your authorization endpoint with login_hint as a parameter. The user completes account linking using the OAuth linking flow in their browser.

If neither condition is true, create a new user account with the information provided in the JWT. New accounts don't typically have a password set. It's recommended that you add Google Sign-In to other platforms to enable users to log in with Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password to sign in on other platforms.

When the creation is completed, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example:

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

  "expires_in": SECONDS_TO_EXPIRATION
}

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

Bạn sẽ được yêu cầu cung cấp mã nhận dạng ứng dụng khách Google API trong quá trình đăng ký Liên kết tài khoản.

Để nhận mã ứ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:

  1. Mở trang Thông tin xác thực của Bảng điều khiển API của Google.
  2. Tạo hoặc chọn một 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 > Mã ứng dụng OAuth để tạo một mã. Hãy nhớ đưa miền của trang web vào hộp Nguồn gốc JavaScript được cho phép. Khi thực hiện thử nghiệm 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 Nguồn gốc JavaScript được ủy quyền.

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

You can validate your implementation by using the OAuth 2.0 Playground tool.

In the tool, do the following steps:

  1. Click Configuration to open the OAuth 2.0 Configuration window.
  2. In the OAuth flow field, select Client-side.
  3. In the OAuth Endpoints field, select Custom.
  4. Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
  5. In the Step 1 section, don't select any Google scopes. Instead, leave this field blank or type a scope valid for your server (or an arbitrary string if you don't use OAuth scopes). When you're done, click Authorize APIs.
  6. In the Step 2 and Step 3 sections, go through the OAuth 2.0 flow and verify that each step works as intended.

You can validate your implementation by using the Google Account Linking Demo tool.

In the tool, do the following steps:

  1. Click the Sign-in with Google button.
  2. Choose the account you'd like to link.
  3. Enter the service ID.
  4. Optionally enter one or more scopes that you will request access for.
  5. Click Start Demo.
  6. When prompted, confirm that you may consent and deny the linking request.
  7. Confirm that you are redirected to your platform.