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ọ.
Để 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:
- 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ọ.
- Sử dụng thông tin trong hồ sơ của họ để nhận dạng người dùng.
- 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.
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:
- 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.
- 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:
- Mở Bảng điều khiển Actions rồi chọn dự án mà bạn muốn sử dụng.
- Nhấp vào thẻ Phát triển rồi chọn Liên kết tài khoản.
- Bật nút chuyển bên cạnh Liên kết tài khoản.
- Trong phần Tạo tài khoản, hãy chọn Có.
Trong phần Loại liên kết, hãy chọn OAuth và Đăng nhập bằng Google và Ngầm ẩn.
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.
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:
- 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.
- 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.
- 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:
Verify the
client_idandredirect_urivalues to prevent granting access to unintended or misconfigured client apps:- Confirm that the
client_idmatches the client ID you assigned to Google. - Confirm that the URL specified by the
redirect_uriparameter has the following form:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
- Confirm that the
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.
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.
Send an HTTP response that redirects the user's browser to the URL specified by the
redirect_uriparameter. Include all of the following parameters in the URL fragment:access_token: the access token you just generatedtoken_type: the stringbearerstate: 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.
Handle automatic linking
After the user gives your Action 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 user_not_found error.
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&consent_code=CONSENT_CODE&scope=SCOPES
Your token exchange endpoint must be able to handle the following parameters:
| Token endpoint parameters | |
|---|---|
grant_type |
The type of token being exchanged. For these requests, this
parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer. |
intent |
For these requests, the value of this parameter is `get`. |
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. |
consent_code |
Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes. |
scope |
Optional: Any scopes you configured Google to request from users. |
When your token exchange endpoint receives the linking request, it should do the following:
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 format) 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 "locale": "en_US" }
In addition to verifying the token's signature, verify that the assertion's issuer
(iss field) is https://accounts.google.com and that the audience (aud field)
is the client ID assigned to your Action.
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
subfield, is in your user database. - The email address in the assertion matches a user in your user database.
If either condition is true, the user has already signed up and you can issue an access token.
If neither the Google Account ID nor the email address specified in the assertion
matches a user in your database, the user hasn't signed up yet. In this case, your
token exchange endpoint should reply with a HTTP 401 error, that specifies error=user_not_found,
as in the following example:
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"error":"user_not_found",
}
user_not_found error, Google
calls your token exchange endpoint with the value of the intent parameter
set to create and sending an ID token that contains the user's profile information
with the request.
Handle account creation via Google Sign-In
When a user needs to create an account on your service, Google makes a
request to your token exchange endpoint that specifies
intent=create, as in the following example:
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]
The assertion parameter contains 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, which you can use
to create a new account on your service.
To respond to account creation requests, your token exchange endpoint must do the following:
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 format) 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 "locale": "en_US" }
In addition to verifying the token's signature, verify that the assertion's issuer
(iss field) is https://accounts.google.com and that the audience (aud field)
is the client ID assigned to your Action.
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
subfield, 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 by responding to the request with an HTTP 401 error, specifying
error=linking_error and the user's email address as the login_hint, as in the
following example:
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"error":"linking_error",
"login_hint":"foo@bar.com"
}
If neither condition is true, create a new user account using the information provided in the JWT. New accounts do not typically have a password set. It is recommended that you add Google Sign In to other platforms to enable users to log in via 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 for signing 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 }
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.
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')) })
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(); }
const app = actionssdk({ clientId: CLIENT_ID, }) app.intent('Start Signin', conv => { conv.ask(new SignIn('To get your account details')) })
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.