Đơ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 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 quy trình liên kết OAuth cơ bản trên web. Dịch vụ của bạn phải hỗ trợ tuân thủ OAuth 2.0 uỷ quyền và điểm cuối trao đổi mã thông báo.
• Điểm cuối trao đổi mã thông báo của bạn phải hỗ trợ xác nhận Mã thông báo web JSON (JWT) và triển khai các ý định check, create và get.

• Đăng ký mã ứng dụng khách Google API.

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:

Để 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.

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

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

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com, that the audience (aud field) is your assigned client ID, and that the token has not expired (exp field).

Using the email, email_verified and hd fields you can determine if Google hosts and is authoritative for an email address. In cases where Google is authoritative the user is currently known to be the legitimate account owner and you may skip password or other challenges methods. Otherwise, these methods can be used to verify the account prior to linking.

Cases where Google is authoritative:

• email has a @gmail.com suffix, this is a Gmail account.
• email_verified is true and hd is set, this is a G Suite account.

Users may register for Google Accounts without using Gmail or G Suite. When email does not contain a @gmail.com suffix and hd is absent Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verified can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

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

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:

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.

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

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

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com, that the audience (aud field) is your assigned client ID, and that the token has not expired (exp field).

Using the email, email_verified and hd fields you can determine if Google hosts and is authoritative for an email address. In cases where Google is authoritative the user is currently known to be the legitimate account owner and you may skip password or other challenges methods. Otherwise, these methods can be used to verify the account prior to linking.

Cases where Google is authoritative:

• email has a @gmail.com suffix, this is a Gmail account.
• email_verified is true and hd is set, this is a G Suite account.

Users may register for Google Accounts without using Gmail or G Suite. When email does not contain a @gmail.com suffix and hd is absent Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verified can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

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",

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

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:

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.

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

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

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com, that the audience (aud field) is your assigned client ID, and that the token has not expired (exp field).

Using the email, email_verified and hd fields you can determine if Google hosts and is authoritative for an email address. In cases where Google is authoritative the user is currently known to be the legitimate account owner and you may skip password or other challenges methods. Otherwise, these methods can be used to verify the account prior to linking.

Cases where Google is authoritative:

• email has a @gmail.com suffix, this is a Gmail account.
• email_verified is true and hd is set, this is a G Suite account.

Users may register for Google Accounts without using Gmail or G Suite. When email does not contain a @gmail.com suffix and hd is absent Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verified can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

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 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",

  "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://localhost và http://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 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:

1. Nhấp vào biểu tượng Configuration (Cấu hình) settings để mở cửa sổ OAuth 2.0 Configuration (Cấu hình OAuth 2.0).
2. Trong trường Quy trình OAuth, hãy chọn Phía máy khách.
3. Trong trường OAuth Endpoints (Điểm cuối OAuth), hãy chọn Custom (Tuỳ chỉnh).
4. 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.
5. 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.
6. 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:

1. Nhấp vào nút Đăng nhập bằng Google.
2. Chọn tài khoản mà bạn muốn liên kết.
3. Nhập mã dịch vụ.
4. 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.
5. Nhấp vào Bắt đầu bản minh hoạ.
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.