Loại liên kết OAuth và Đăng nhập bằng Google thêm tính năng Đăng nhập bằng Google lên trên liên kết tài khoản dựa trên OAuth. Điều này mang lại tính năng liên kết liền mạch dựa trên giọng nói cho người dùng Google, đồng thời cho phép liên kết tài khoản cho những người dùng đã đăng ký dịch vụ bằng danh tính không phải của Google.
Loại liên kết này bắt đầu bằng tính năng Đăng nhập bằng Google, cho phép bạn kiểm tra xem thông tin hồ sơ trên Google của người dùng có tồn tại trong hệ thống của bạn hay không. Nếu không tìm thấy thông tin của người dùng trong hệ thống, thì một luồng OAuth tiêu 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 trong hồ sơ của họ trên Google.
![](https://developers-dot-devsite-v2-prod.appspot.com/static/assistant/df-asdk/identity/images/gsi-oauth-flow.png?authuser=4&hl=vi)
Để thực hiện liên kết tài khoản với OAuth và tính năng Đăng nhập bằng Google, hãy làm theo các bước chung sau đây:
- Trước tiên, hãy yêu cầu người dùng đồng ý truy cập vào hồ sơ của họ trên Google.
- Sử dụng thông tin trong hồ sơ của họ để xác định người dùng.
- 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, thì luồng sẽ tiếp tục tuỳ thuộc vào việc bạn đã định cấu hình dự án Actions 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 hay chỉ trên trang web của bạn.
- Nếu bạn cho phép tạo tài khoản thông qua giọng nói, hãy xác thực mã thông báo mã nhận dạng 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 mã nhận dạng.
- Nếu bạn không cho phép tạo tài khoản qua giọng nói, người dùng sẽ được chuyển sang trình duyệt để họ có thể tải trang uỷ quyền của bạn và hoàn tất quy trình tạo người dùng.
![Nếu bạn cho phép tạo tài khoản thông qua giọng nói và không thể tìm thấy kết quả trùng khớp với hồ sơ trên Google trong hệ thống xác thực của mình, bạn cần 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 người dùng dựa trên thông tin hồ sơ có trong mã thông báo giá trị nhận dạng.
Nếu bạn không cho phép tạo tài khoản người dùng qua giọng nói, người dùng sẽ được chuyển sang một trình duyệt để họ có thể tải trang uỷ quyền của bạn và hoàn tất quy trình.](https://developers-dot-devsite-v2-prod.appspot.com/static/assistant/df-asdk/identity/images/gsi-oauth-flow-creation.png?authuser=4&hl=vi)
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 thông qua giọng nói, Trợ lý sẽ hỏi xem người dùng có muốn làm như sau hay không:
- Tạo một tài khoản mới trên hệ thống của bạn bằ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 người đó đã có một tài khoản không phải của Google.
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 toái của quy trình tạo tài khoản. Người dùng chỉ cần rời khỏi luồng thoại nếu muốn đăng nhập bằng tài khoản hiện 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 thông qua giọng nói, Trợ lý sẽ mở URL tới trang web mà bạn đã cung cấp để xác thực người dùng. Nếu tương tác diễn ra trên một thiết bị không có màn hình, Trợ lý sẽ chuyển người dùng đến một đ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 Tài khoản Google tạo tài khoản người dùng mới mà muốn họ liên kết với tài khoản người dùng hiện có trong hệ thống xác thực của bạn. Ví dụ: nếu cung cấp chương trình khách hàng thân thiết, bạn nên đảm bảo rằng người dùng không bị mất số điểm đã tích luỹ trên tài khoản hiện có của họ.
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 tài khoản nếu cần hiển thị điều khoản dịch vụ cho người dùng trong quá trình tạo tài khoản.
Triển khai 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 quy trình OAuth 2.0 theo tiêu chuẩn ngành. Actions on Google hỗ trợ các luồng mã ngầm định và uỷ quyề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
Để định cấu hình dự án nhằm sử dụng tính năng liên kết tài khoản OAuth và tính năng liên kết 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 (Thao tác) 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 mục Liên kết tài khoản.
- Trong phần Tạo tài khoản, hãy chọn Có.
Trong mục Loại liên kết, hãy chọn OAuth và Đăng nhập bằng Google và Ngụ ý.
Trong Thông tin ứng dụng, hãy làm như sau:
- Chỉ định một giá trị cho Mã ứng dụng khách do Hành động của bạn gửi cho 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 của bạn.
Nhấp vào Lưu.
Triển khai máy chủ OAuth
Để hỗ trợ luồng ngầm ẩn OAuth 2.0, dịch vụ của bạn sẽ cung cấp một điểm cuối cấp quyền qua HTTPS. Điểm cuối này chịu trách nhiệm xác thực và lấy sự đồng ý của người dùng về việc truy cập dữ liệu. Điểm cuối uỷ quyền hiển thị 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 đã yêu cầu.
Khi Hành động của bạn cần gọi một trong các API được uỷ quyền của dịch vụ, Google sẽ sử dụng điểm cuối này để được người dùng cho phép gọi các API này thay mặt cho họ.
Một phiên luồng ngầm ẩn OAuth 2.0 thông thường do Google khởi tạo có quy trình sau đây:
- Google sẽ mở điểm cuối uỷ quyền của bạn trong trình duyệt của người dùng. Người dùng đăng nhập nếu chưa đăng nhập và cấp cho Google quyền truy cập vào dữ liệu của họ bằng API của bạn nếu họ chưa cấp quyền.
- Dịch vụ của bạn sẽ tạo một mã truy cập và trả lại cho Google bằng cách chuyển hướng trình duyệt của người dùng trở lại Google với mã truy cập được đính kèm với yêu cầu.
- Google gọi các API của dịch vụ và đính kèm mã truy cập vào từng yêu cầu. Dịch vụ của bạn sẽ xác minh rằng mã truy cập cấp cho Google quyền truy cập vào API, sau đó hoàn tất lệnh gọi API.
Xử lý các yêu cầu uỷ quyền
Khi Hành động của bạn cần thực hiện liên kết tài khoản thông qua một luồng ngầm ẩn OAuth2, Google sẽ gửi người dùng đến điểm cuối ủy quyền của bạn bằng một yêu cầu bao gồm các tham số sau:
Tham số điểm cuối uỷ quyền | |
---|---|
client_id |
Mã ứng dụng khách mà bạn đã chỉ định cho Google. |
redirect_uri |
URL mà bạn gửi phản hồi cho yêu cầu này. |
state |
Một giá trị ghi sổ được trả về cho Google sẽ không thay đổi trong URI chuyển hướng. |
response_type |
Loại giá trị cần trả về trong phản hồi. Đối với luồng ngầm ẩn OAuth 2.0, loại phản hồi luôn là token . |
Ví dụ: nếu điểm cuối uỷ quyền của bạn có sẵn tại https://myservice.example.com/auth
, thì yêu cầu có thể có dạng như sau:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token
Để điểm cuối uỷ quyền xử lý các yêu cầu đăng nhập, hãy làm theo các bước sau:
Xác minh các giá trị
client_id
vàredirect_uri
để ngăn việc cấp quyền truy cập vào các ứng dụng khách ngoài ý muốn hoặc bị định cấu hình sai:- Xác nhận rằng
client_id
khớp với mã ứng dụng khách mà bạn đã chỉ định cho Google. - Xác nhận rằng URL do tham số
redirect_uri
chỉ định có dạng sau:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID là mã nhận dạng trên trang Cài đặt dự án của Bảng điều khiển Actions.
- Xác nhận rằng
Kiểm tra xem người dùng có đăng nhập vào dịch vụ của bạn hay không. Nếu người dùng chưa đăng nhập, hãy hoàn tất quy trình đăng nhập hoặc đăng ký dịch vụ của bạn.
Tạo một mã truy cập mà Google sẽ dùng để truy cập vào API của bạn. Mã truy cập có thể là bất kỳ giá trị chuỗi nào, nhưng mã đó phải đại diện riêng cho người dùng và máy khách có mã thông báo và không được đoán được.
Gửi phản hồi HTTP chuyển hướng trình duyệt của người dùng đến URL do tham số
redirect_uri
chỉ định. Đưa mọi tham số sau đây vào phân đoạn URL:access_token
: mã truy cập bạn vừa tạotoken_type
: chuỗibearer
state
: giá trị trạng thái chưa sửa đổi từ yêu cầu ban đầu Sau đây là ví dụ về URL kết quả:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
Trình xử lý chuyển hướng OAuth 2.0 của Google sẽ nhận được mã truy cập và xác nhận rằng giá trị state
vẫn không thay đổi. Sau khi có được mã truy cập cho dịch vụ của bạn, Google sẽ đính kèm mã truy cập này vào các lệnh gọi tiếp theo vào Hành động của bạn trong AppRequest.
Xử lý việc liên kết tự động
Sau khi người dùng cho phép Hành động của bạn truy cập vào hồ sơ trên Google của họ, Google sẽ gửi một yêu cầu chứa lời xác nhận có chữ ký về danh tính của người dùng Google. Câu nhận định này 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. Đ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, thì đ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, đ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ó dạng như 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 xử lý được 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 những yêu cầu như vậy, tham số
này có giá trị urn:ietf:params:oauth:grant-type:jwt-bearer . |
intent |
Đối với những 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 lời khẳng định 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. |
consent_code |
Không bắt buộc: Khi có, mã một lần cho biết người dùng đã đồng ý cho Hành động của bạn truy cập vào các phạm vi đã chỉ định. |
scope |
Không bắt buộc: Bất kỳ phạm vi nào mà bạn đã thiết lập để Google yêu cầu người dùng. |
Khi điểm cuối trao đổi mã thông báo của bạn nhận được yêu cầu liên kết, điểm cuối đó sẽ thực hiện những việc 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ó 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ã, 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 người phát hành câu nhận định (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
Hãy kiểm tra xem một trong các điều kiện sau có đúng không:
- Mã Tài khoản Google (tìm thấy 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 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 đó đúng, thì người dùng đã đăng ký và bạn có thể cấp mã truy cập.
Nếu cả mã Tài khoản Google và địa chỉ email được chỉ định trong phần xác nhận đều không khớp với người dùng trong cơ sở dữ liệu, thì tức là người dùng đó vẫn 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 sẽ trả lời bằng lỗi HTTP 401. Lỗi này 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 sẽ gọi điểm cuối trao đổi mã thông báo với giá trị của tham số intent
được đặt thành tạo và gửi một mã thông báo mã nhận dạng chứa thông tin hồ sơ của người dùng cù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 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
, 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ột Mã thông báo web JSON (JWT) cung cấp lời 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. Bạn có thể sử dụng những thông tin này để tạo tài khoản mới trên dịch vụ của mình.
Để 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 làm 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ó 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ã, 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 người phát hành câu nhận định (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
Hãy kiểm tra xem một trong các điều kiện sau có đúng không:
- Mã Tài khoản Google (tìm thấy 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 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 này đúng, hãy nhắc người dùng liên kết tài khoản hiện có với Tài khoản Google bằng cách phản hồi yêu cầu kèm theo 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 được cung cấp trong JWT. Tài khoản mới thường không có mật khẩu. 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 để cho phép người dùng đăng nhập 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 đường liên kết bắt đầu quy trình khôi phục mật khẩu qua email để cho phép người dùng đặt mật khẩu để đăng nhập trên các nền tảng khác.
Sau khi tạo xong, hãy cấp mã truy cập , sau đó trả về các giá trị trong đối tượng JSON trong phần nội dung 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 của trì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 truy cập dữ liệu
Nếu yêu cầu Trợ lý chứa mã truy cập, trước tiên, hãy kiểm tra để đảm bảo rằng mã truy cập này là hợp lệ và chưa hết hạn. Sau đó, truy xuất tài khoản người dùng liên kết với mã truy cập từ cơ sở dữ liệu tài khoản người dùng của bạn.