Liên kết tài khoản bằng OAuth và tính năng Đăng nhập bằng Google (Dialogflow)

Loại liên kết OAuth và Đăng nhập bằng Google sẽ thêm tính năng Đăng nhập bằng Google bên cạnh OAuth dựa trên liên kết tài khoản. Việc này giúp người dùng Google liên kết liền mạch dựa trên giọng nói đồng thời bật tính năng liên kết tài khoản cho những người dùng đã đăng ký dịch vụ của bạn có thông tin nhận dạng không phải của Google.

Loại liên kết này bắt đầu bằng phương thức Đăng nhập bằng Google, cho phép bạn kiểm tra xem Thông tin hồ sơ trên Google có trong hệ thống của bạn. Nếu thông tin của người dùng nếu không thấy, một quy trình OAuth chuẩn sẽ bắt đầu. Người dùng cũng có thể chọn tạo một tài khoản mới bằng thông tin hồ sơ trên Google của họ.

Hình 1: Sau khi Hành động của bạn có quyền truy cập vào , bạn có thể sử dụng mã này để tìm thông tin trùng khớp với người dùng trong hệ thống xác thực của mình.

Để 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ọ để nhận dạng người dùng.
  3. 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, quy trình sẽ tiếp tục tuỳ thuộc vào việc bạn đã định cấu hình dự án Actions hay chưa trong bảng điều khiển Actions để cho phép tạo tài khoản người dùng thông qua giọng nói hoặc chỉ bật trang web của bạn.
    • Nếu bạn cho phép tạo tài khoản qua giọng nói, hãy xác thực mã mã thông báo nhận được từ Google. Sau đó, bạn có thể tạo người dùng dựa trên thông tin hồ sơ có trong mã thông báo ID.
    • Nếu bạn không cho phép tạo tài khoản qua giọng nói, thì người dùng sẽ được chuyển sang trình duyệt nơi họ có thể tải trang uỷ quyền của bạn và hoàn tất quá trình người dùng trong quy trình sáng tạo.
Nếu bạn cho phép tạo tài khoản qua giọng nói và không tìm thấy kết quả phù hợp cho
            hồ sơ trên Google trong hệ thống xác thực của mình, bạn cần phải
            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
            người dùng dựa trên thông tin hồ sơ có trong mã thông báo ID.
            Nếu bạn không cho phép tạo tài khoản người dùng qua giọng nói, thì người dùng sẽ
            được chuyển sang trình duyệt nơi họ có thể tải trang ủy quyền của bạn
            và hoàn tất luồng.
Hình 2. Bản minh hoạ bằng hình ảnh về OAuth và Google Quy trình đăng nhập khi không tìm thấy thông tin của người dùng trong hệ thống của bạn.

Hỗ trợ tạo tài khoản qua giọng nói

Nếu bạn cho phép tạo tài khoản người dùng qua giọng nói, Trợ lý sẽ hỏi người dùng xem họ muốn làm những việc sau:

  • Tạo tài khoản mới trên hệ thống của bạn bằng cách sử dụng thông tin tài khoản Google của họ hoặc
  • Đăng nhập vào hệ thống xác thực của bạn bằng một tài khoản khác nếu họ có tài khoản không phải tài khoản Google hiện có.

Bạn nên cho phép tạo tài khoản qua giọng nói nếu muốn giảm thiểu sự phiền hà trong quy trình tạo tài khoản. Người dùng chỉ cần rời khỏi quy trình giọng nói nếu họ muốn đăng nhập bằng một tài khoản hiện có, không phải của Google.

Không cho phép tạo tài khoản qua giọng nói

Nếu bạn không cho phép tạo tài khoản người dùng qua giọng nói, Trợ lý sẽ mở URL đến mà bạn đã cung cấp để xác thực người dùng. Nếu hoạt động tương tác đang diễn ra trên thiết bị không có màn hình, Trợ lý sẽ hướng người dùng đến điện thoại để tiếp tục quy trình liên kết tài khoản.

Bạn nên không cho phép tạo nếu:

  • Bạn không muốn cho phép người dùng có tài khoản không phải của Google tạo tài khoản mới tài khoản người dùng của họ và muốn họ liên kết với tài khoản người dùng hiện có của họ trong xác thực thay thế. Ví dụ: nếu cung cấp chương trình khách hàng thân thiết, bạn có thể cần đảm bảo rằng người dùng không bị mất điểm đã tích luỹ tài khoản hiện có.

  • Bạn cần có toàn quyền kiểm soát quy trình tạo tài khoản. Ví dụ: bạn có thể không cho phép tạo nếu bạn cần hiển thị điều khoản dịch vụ cho người dùng trong tạo tài khoản.

Triển khai việc liên kết tài khoản OAuth và tài khoản Đăng nhập bằng Google

Các tài khoản được liên kết với các luồng OAuth 2.0 theo tiêu chuẩn ngành. Actions on Google hỗ trợ các luồng mã uỷ quyền và ngầm ẩn.

Trong luồng mã ngầm định, Google sẽ mở điểm cuối ủy quyền của bạn trong trình duyệt của người dùng. Sau khi đăng nhập thành công, bạn sẽ trả về một mã thông báo truy cập dài hạn cho Google. Mã thông báo truy cập này hiện được đưa vào mọi yêu cầu gửi từ Trợ lý tới Hành động của bạn.

Trong quy trình mã uỷ quyền, bạn cần có 2 điểm cuối:

  • Điểm cuối uỷ quyền (trách nhiệm trình bày giao diện người dùng đăng nhập cho người dùng chưa đăng nhập và ghi lại sự đồng ý đối với quyền truy cập được yêu cầu dưới dạng mã uỷ quyền ngắn hạn).
  • Điểm cuối token exchange chịu trách nhiệm về hai hình thức trao đổi:
    1. Trao đổi một mã ủy quyền để lấy mã làm mới trong thời gian dài và một mã truy cập ngắn hạn. Quá trình trao đổi này diễn ra khi người dùng trải qua quy trình liên kết tài khoản.
    2. Trao đổi mã làm mới trong thời gian dài để lấy mã truy cập ngắn hạn. Quá trình trao đổi này diễn ra khi Google cần một mã truy cập mới vì mã này đã hết hạn.

Mặc dù quy trình mã ngầm định đơn giản hơn nên triển khai, bạn nên sử dụng các mã thông báo truy cập được phát hành bằng quy trình ngầm ẩn, vì việc sử dụng mã thông báo hết hạn với luồng ngầm định sẽ buộc người dùng liên kết lại tài khoản của họ. Nếu cần mã hết hạn vì lý do bảo mật, bạn nên cân nhắc sử dụng quy trình mã xác thực.

Định cấu hình dự án

Cách định cấu hình dự án để sử dụng OAuth và tài khoản Đăng nhập bằng Google hãy làm theo các bước sau:

  1. Mở Bảng điều khiển Actions rồi chọn dự án mà bạn muốn sử dụng.
  2. Nhấp vào thẻ Phát triển rồi chọn Liên kết tài khoản.
  3. Bật nút chuyển bên cạnh Liên kết tài khoản.
  4. Trong phần Tạo tài khoản, hãy chọn .

  5. Trong phần Loại liên kết, hãy chọn OAuth và Đăng nhập bằng GoogleNgầm ẩn.

  6. Trong phần Thông tin khách hàng, hãy làm như sau:

    • Gán một giá trị cho Mã ứng dụng khách do Actions to Google để xác định các yêu cầu đến từ Google.
    • Chèn URL cho điểm cuối Uỷ quyền và Trao đổi mã thông báo.
  7. Nhấp vào Lưu.

Triển khai máy chủ OAuth

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.

When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.

A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:

  1. Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
  2. Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
  3. Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.

Handle authorization requests

When your Action needs to perform account linking via an OAuth2 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id The client ID you assigned to Google.
redirect_uri The URL to which you send the response to this request.
state A bookkeeping value that is passed back to Google unchanged in the redirect URI.
response_type The type of value to return in the response. For the OAuth 2.0 implicit flow, the response type is always token.

For example, if your authorization endpoint is available at https://myservice.example.com/auth, a request might look like:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

For your authorization endpoint to handle sign-in requests, do the following steps:

  1. Verify the client_id and redirect_uri values to prevent granting access to unintended or misconfigured client apps:

    • Confirm that the client_id matches the client ID you assigned to Google.
    • Confirm that the URL specified by the redirect_uri parameter has the following form:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.
  2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

  3. Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.

  4. Send an HTTP response that redirects the user's browser to the URL specified by the redirect_uri parameter. Include all of the following parameters in the URL fragment:

    • access_token: the access token you just generated
    • token_type: the string bearer
    • state: the unmodified state value from the original request The following is an example of the resulting URL:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google's OAuth 2.0 redirect handler will receive the access token and confirm that the state value hasn't changed. After Google has obtained an access token for your service, Google will attach the token to subsequent calls to your Action as part of the AppRequest.

Xử lý hoạt động liên kết tự động

Sau khi người dùng đồng ý cho Hành động của bạn truy cập vào hồ sơ của họ trên Google, Google gửi yêu cầu có chứa xác nhận có chữ ký về danh tính của người dùng Google. 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. Điểm cuối trao đổi mã thông báo được định cấu hình cho các trình xử lý dự án của bạn yêu cầu đó.

Nếu đã có Tài khoản Google tương ứng 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 một 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 user_not_found.

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&consent_code=CONSENT_CODE&scope=SCOPES

Đ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
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.
intent Đối với các yêu cầu này, giá trị của tham số này là "get".
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, tên và địa chỉ email.
consent_code Không bắt buộc: Nếu có, mã dùng một lần cho biết rằng người dùng đã đồng ý cho phép Hành động của bạn truy cập vào các phạm vi được chỉ định.
scope Không bắt buộc: Mọi phạm vi mà bạn đã thiết lập để Google yêu cầu người dùng cung cấp.

Khi nhận được yêu cầu liên kết, điểm cuối trao đổi mã thông báo của bạn sẽ thực hiện sau:

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 mình. Sử dụng khoá công khai của Google (có trong JWK hoặc định dạng PEM để xác minh mã thông báo của bạn.

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
  "locale": "en_US"
}

Ngoài việc xác minh chữ ký của mã thông báo, hãy xác minh rằng nhà phát hành xác nhận (trường iss) là https://accounts.google.com và đối tượng (trường aud) là mã ứng dụng khách được chỉ định cho Hành động của bạn.

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) có trong cơ sở dữ liệu người dùng của bạn.
  • Đị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 đều đúng thì người dùng đã đăng ký và bạn có thể đưa ra mã truy cập.

Nếu cả mã Tài khoản Google và địa chỉ email được chỉ định trong câu nhận định đều không khớp với người dùng trong cơ sở dữ liệu của bạn mà 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 sẽ phản hồi bằng lỗi HTTP 401, trong đó chỉ định error=user_not_found, như trong ví dụ sau:

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

{
  "error":"user_not_found",
}
Khi Google nhận được phản hồi lỗi 401 kèm theo lỗi user_not_found, Google gọi điểm cuối trao đổi mã thông báo bằng giá trị của tham số intent đặt để tạo và gửi mã thông báo ID chứa thông tin hồ sơ của người dùng với yêu cầu.

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

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ẽ tạo một đến điểm cuối trao đổi mã thông báo của bạn để chỉ định intent=create, như trong ví dụ 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&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

Tham số assertion chứa Mã thông báo web JSON (JWT) cung cấp xác nhận có chữ ký về danh tính của người dùng Google. JWT chứa thông tin bao gồm mã Tài khoản Google, tên và địa chỉ email của người dùng mà bạn có thể sử dụng để tạo một tài khoản mới trên dịch vụ của bạn.

Để phản hồi các yêu cầu tạo tài khoản, điểm cuối trao đổi mã thông báo của bạn phải như sau:

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 mình. Sử dụng khoá công khai của Google (có trong JWK hoặc định dạng PEM để xác minh mã thông báo của bạn.

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
  "locale": "en_US"
}

Ngoài việc xác minh chữ ký của mã thông báo, hãy xác minh rằng nhà phát hành xác nhận (trường iss) là https://accounts.google.com và đối tượng (trường aud) là mã ứng dụng khách được chỉ định cho Hành động của bạn.

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) có trong cơ sở dữ liệu người dùng của bạn.
  • Đị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ọ với Tài khoản Google của họ bằng cách phản hồi yêu cầu với lỗi HTTP 401, trong đó chỉ định error=linking_error và địa chỉ email của người dùng là login_hint, 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"
}

Nếu không có điều kiện nào đúng, hãy tạo một tài khoản người dùng mới bằng thông tin này được cung cấp trong JWT. Các tài khoản mới thường chưa đặt mật khẩu. Đó là 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 trong thông qua Google trên các nền tảng của ứng dụng. Ngoài ra, bạn có thể gửi cho người dùng một đường liên kết bắt đầu quy trình khôi phục mật khẩu để cho phép người dùng thiết lập 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
}

Bắt đầu quy trình xác thực

Sử dụng ý định trợ giúp Đăng nhập vào tài khoản để bắt đầu quy trình xác thực.

Dialogflow (Node.js)
const app = dialogflow({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
})

// Intent that starts the account linking flow.
app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})
Dialogflow (Java)
private String clientId = "<your_client_id>";

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}
SDK Hành động (Node.js)
const app = actionssdk({
  clientId: CLIENT_ID,
})

app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})
SDK Actions (Java)
private String clientId = "<your_client_id>";

@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

Xử lý các yêu cầu về quyền truy cập dữ liệu

Nếu yêu cầu của Trợ lý chứa mã truy cập, trước tiên, hãy kiểm tra để đảm bảo mã truy cập là hợp lệ và chưa hết hạn, sau đó truy xuất mã này từ cơ sở dữ liệu tài khoản người dùng mà tài khoản người dùng được liên kết với mã thông báo.