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

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:

  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.
  4. 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 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 quy trình liên kết được sắp xếp hợp lý. Ả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 để 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ư hiển thị 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 hiển thị một tài khoản người dùng đã 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

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

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:

  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 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)
        1. 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.
        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 được liên kết nếu việc tạo ý định trả về thành công.
          2. 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.
      2. 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.
    2. 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)
      1. 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.
      2. 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.

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ã câu nhận định JWT

Bạn có thể xác thực và giải mã câu nhận định 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 Khoá công khai của Google, có trong JWK hoặc Định dạng PEM để xác minh chữ ký của mã thông báo.

Khi được giải mã, câu nhận định JWT sẽ có dạ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 việc xác minh chữ ký của mã thông báo, hãy xác minh rằng công ty phát hành (trường iss) là https://accounts.google.com, mà đối tượng (trường aud) là mã ứng dụng khách được chỉ định và mã thông báo chưa hết hạn (trường exp).

Bằng cách sử dụng các trường email, email_verifiedhd, bạn có thể xác định xem Google lưu trữ và có thẩm quyền đối với một địa chỉ email. Trong trường hợp Google có thẩm quyền mà người dùng hiện được biết 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 thức xác thực khác. Nếu không, các phương thức này có thể dùng để xác minh tài khoản trước khi liên kết.

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

  • email có hậu tố @gmail.com, đây là một tài khoản Gmail.
  • email_verified là đúng 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. Thời gian email không chứa hậu tố @gmail.comhd không có Google thì không xác thực và sử dụng mật khẩu hoặc các phương pháp xác thực khác để xác minh người dùng. email_verified 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 đối với bên thứ ba tài khoản email 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",
}

Handle automatic linking (get intent)

After the user gives consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.

If the corresponding Google Account is already present in your authentication system, your token exchange endpoint returns a token for the user. If the Google Account doesn't match an existing user, your token exchange endpoint returns a linking_error error and optional login_hint.

The request has the following form:

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

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

Token endpoint parameters
intent For these requests, the value of this parameter is get.
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.
scope Optional: Any scopes that you've configured Google to request from users.
client_id The client ID you assigned to Google.
client_secret The client secret you assigned to Google.

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

  • Validate and decode the JWT assertion.
  • Check if the Google account is already present in your authentication system.
Xác thực và giải mã câu nhận định JWT

Bạn có thể xác thực và giải mã câu nhận định 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 Khoá công khai của Google, có trong JWK hoặc Định dạng PEM để xác minh chữ ký của mã thông báo.

Khi được giải mã, câu nhận định JWT sẽ có dạ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 việc xác minh chữ ký của mã thông báo, hãy xác minh rằng công ty phát hành (trường iss) là https://accounts.google.com, mà đối tượng (trường aud) là mã ứng dụng khách được chỉ định và mã thông báo chưa hết hạn (trường exp).

Bằng cách sử dụng các trường email, email_verifiedhd, bạn có thể xác định xem Google lưu trữ và có thẩm quyền đối với một địa chỉ email. Trong trường hợp Google có thẩm quyền mà người dùng hiện được biết 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 thức xác thực khác. Nếu không, các phương thức này có thể dùng để xác minh tài khoản trước khi liên kết.

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

  • email có hậu tố @gmail.com, đây là một tài khoản Gmail.
  • email_verified là đúng 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. Thời gian email không chứa hậu tố @gmail.comhd không có Google thì không xác thực và sử dụng mật khẩu hoặc các phương pháp xác thực khác để xác minh người dùng. email_verified 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 đối với bên thứ ba tài khoản email có thể đã thay đổi.

Check if the Google account is already present in your authentication system

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 an account is found for the user, 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",

  "refresh_token": "REFRESH_TOKEN",

  "expires_in": SECONDS_TO_EXPIRATION
}

In some cases, account linking based on ID token might fail for the user. If it does so for any reason, your token exchange endpoint needs to reply with a HTTP 401 error that specifies error=linking_error, as the following example shows:

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.

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ã câu nhận định JWT

Bạn có thể xác thực và giải mã câu nhận định 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 Khoá công khai của Google, có trong JWK hoặc Định dạng PEM để xác minh chữ ký của mã thông báo.

Khi được giải mã, câu nhận định JWT sẽ có dạ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 việc xác minh chữ ký của mã thông báo, hãy xác minh rằng công ty phát hành (trường iss) là https://accounts.google.com, mà đối tượng (trường aud) là mã ứng dụng khách được chỉ định và mã thông báo chưa hết hạn (trường exp).

Bằng cách sử dụng các trường email, email_verifiedhd, bạn có thể xác định xem Google lưu trữ và có thẩm quyền đối với một địa chỉ email. Trong trường hợp Google có thẩm quyền mà người dùng hiện được biết 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 thức xác thực khác. Nếu không, các phương thức này có thể dùng để xác minh tài khoản trước khi liên kết.

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

  • email có hậu tố @gmail.com, đây là một tài khoản Gmail.
  • email_verified là đúng 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. Thời gian email không chứa hậu tố @gmail.comhd không có Google thì không xác thực và sử dụng mật khẩu hoặc các phương pháp xác thực khác để xác minh người dùng. email_verified 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 đối với bên thứ ba tài khoản email 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 refresh 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",

  "refresh_token": "REFRESH_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:

  1. Mở trang Credentials (Thông tin xác thực) của bảng điều khiển API Google.
  2. 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://localhosthttp://localhost:<port_number> vào trường Nguồn JavaScript được ủy quyền.

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.