Liên kết Tài khoản Google với OAuth

Các tài khoản được liên kết bằng cách sử dụng quy trình ngầm ẩn và mã uỷ quyền OAuth 2.0 tiêu chuẩn ngành. Dịch vụ của bạn phải hỗ trợ điểm cuối ủy quyền và tuân thủ giao thức trao đổi mã thông báo dựa trên OAuth 2.0.

Trong luồng ngầm ẩn, 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ã truy cập dài hạn cho Google. Mã truy cập này hiện nằm trong mọi yêu cầu do Google gửi.

Trong quy trình mã ủy quyền, bạn cần có hai điểm cuối:

  • Điểm cuối ủy quyền, giới thiệu giao diện người dùng đăng nhập cho người dùng chưa đăng nhập. Điểm cuối ủy quyền cũng tạo một mã ủy quyền ngắn hạn để ghi lại người dùng\39; đồng ý với quyền truy cập được yêu cầu.

  • Điểm cuối mã trao đổi, chịu trách nhiệm đối với hai loại sàn giao dịch:

    1. Trao đổi mã ủy quyền cho mã làm mới lâu dài và mã truy cập ngắn hạn. Việc trao đổi này xảy ra khi người dùng trải qua luồng liên kết tài khoản.
    2. Trao đổi một mã làm mới lâu dài để lấy mã truy cập ngắn hạn. Việc trao đổi này xảy ra khi Google cần một mã truy cập mới vì mã đó đã hết hạn.

Chọn một quy trình OAuth 2.0

Mặc dù quy trình ngầm ẩn đơn giản hơn để triển khai, nhưng Google khuyến nghị rằng mã thông báo truy cập do luồng ngầm ẩn cấp sẽ không bao giờ hết hạn. Điều này là do người dùng bắt buộc phải liên kết lại tài khoản của họ sau khi mã thông báo hết hạn với luồng ngầm ẩn. Nếu cần hết hạn mã thông báo vì lý do bảo mật, bạn nên sử dụng quy trình mã ủy quyền.

Hướng dẫn thiết kế

Phần này mô tả các yêu cầu về thiết kế và đề xuất cho màn hình người dùng mà bạn lưu trữ cho luồng liên kết OAuth. Sau khi ứng dụng Google gọi điện, nền tảng của bạn sẽ hiển thị màn hình đăng nhập vào trang Google và màn hình đồng ý liên kết tài khoản với người dùng. Người dùng được chuyển hướng lại ứng dụng của Google sau khi đồng ý liên kết tài khoản.

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ọ với hệ thống xác thực của bạn. Ảnh chụp màn hình đầu tiên cho thấy quá trình liên kết do người dùng tạo từ nền tảng của bạn. Hình ảnh thứ hai cho thấy thông tin đăng nhập của người dùng cho Google, còn hình ảnh thứ ba cho thấy sự đồng ý của người dùng và thông báo 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 cuối cùng 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. Tài khoản liên kết người dùng đăng nhập vào Google và các màn hình đồng ý.

Yêu cầu

  1. Bạn phải thông báo rằng tài khoản của người dùng sẽ được liên kết với Google, không phải một sản phẩm cụ thể của Google như Google Home hoặc Trợ lý Google.

Đề xuất

Bạn nên làm như sau:

  1. Hiển thị Chính sách quyền riêng tư của Google. Thêm một đường liên kết đến Chính sách quyền riêng tư của Google trên màn hình đồng ý.

  2. Dữ liệu cần chia sẻ. Sử dụng ngôn ngữ rõ ràng và súc tích để cho người dùng biết dữ liệu của họ mà Google yêu cầu và lý do.

  3. Lời kêu gọi hành động rõ ràng. Nêu rõ lời kêu gọi hành động rõ ràng trên màn hình đồng ý của bạn, chẳng hạn như "Đồng ý và liên kết". Điều này là do người dùng cần phải hiểu được dữ liệu mà họ cần chia sẻ với Google để liên kết tài khoản.

  4. Khả năng hủy. Cung cấp cho người dùng một cách để quay lại hoặc hủy, nếu họ chọn không liên kết.

  5. Xóa quy trình đăng nhập. Đảm bảo rằng người dùng có phương thức rõ ràng để đăng nhập vào Tài khoản Google của họ, chẳng hạn như các trường cho tên người dùng và mật khẩu hoặc Đăng nhập bằng Google.

  6. Khả năng hủy liên kết. Cung cấp một cơ chế để người dùng huỷ liên kết, chẳng hạn như URL đến chế độ cài đặt tài khoản của họ trên nền tảng của bạn. Ngoài ra, bạn có thể bao gồm đường liên kết đến Tài khoản Google để người dùng có thể quản lý tài khoản được liên kết.

  7. Khả năng thay đổi tài khoản người dùng. Đề xuất một phương thức để người dùng chuyển(các) tài khoản của họ. Điều này đặc biệt có lợi nếu người dùng có xu hướng có nhiều tài khoản.

    • Nếu người dùng phải đóng màn hình đồng ý để chuyển đổi tài khoản, hãy gửi lỗi có thể khôi phục cho Google để người dùng có thể đăng nhập vào tài khoản mong muốn bằng quy trình liên kết OAuth và quy trình ngầm ẩn.

  8. Bao gồm biểu trưng của bạn. Hiển thị biểu tượng công ty trên màn hình xin phép. Sử dụng nguyên tắc chọn kiểu để đặt biểu tượng của bạn. Nếu bạn muốn hiển thị biểu trưng của Google, hãy xem Biểu trưng và nhãn hiệu.

Tạo dự án

Cách tạo dự án để sử dụng tính năng liên kết tài khoản:

  1. Go to the Google API Console.
  2. Nhấp vào Tạo dự án .
  3. Nhập tên hoặc chấp nhận đề xuất được tạo.
  4. Xác nhận hoặc chỉnh sửa bất kỳ trường nào còn lại.
  5. Nhấp vào Tạo .

Để xem ID dự án của bạn:

  1. Go to the Google API Console.
  2. Tìm dự án của bạn trong bảng trên trang đích. ID dự án xuất hiện trong cột ID .

Quy trình Liên kết Tài khoản Google bao gồm một màn hình xin phép để cho người dùng biết ứng dụng đang yêu cầu quyền truy cập vào dữ liệu của họ, loại dữ liệu mà họ đang yêu cầu và các điều khoản áp dụng. Bạn sẽ cần định cấu hình màn hình xin phép bằng OAuth trước khi tạo mã ứng dụng khách Google API.

  1. Mở trang màn hình xin phép bằng OAuth trên bảng điều khiển API của Google.
  2. Nếu được nhắc, hãy chọn dự án bạn vừa tạo.

  3. Trên trang "Màn hình xin phép bằng OAuth", hãy điền vào biểu mẫu rồi nhấp vào nút "Lưu".

    Tên ứng dụng: Tên của ứng dụng đã yêu cầu sự đồng ý. Tên này phải phản ánh chính xác ứng dụng của bạn và nhất quán với tên ứng dụng mà người dùng thấy ở nơi khác. Tên ứng dụng sẽ xuất hiện trên màn hình đồng ý liên kết tài khoản.

    Biểu trưng ứng dụng: Một hình ảnh trên màn hình xin phép sẽ giúp người dùng nhận ra ứng dụng của bạn. Biểu trưng này xuất hiện trên màn hình xin phép liên kết tài khoản và trong phần cài đặt tài khoản

    Email hỗ trợ: Dành cho người dùng liên hệ với bạn khi có thắc mắc về sự đồng ý của họ.

    Phạm vi cho API Google: Phạm vi cho phép ứng dụng của bạn truy cập vào dữ liệu riêng tư của người dùng trên Google. Đối với trường hợp sử dụng tính năng Liên kết Tài khoản Google, phạm vi mặc định (email, hồ sơ, openid) là đủ, bạn không cần thêm bất kỳ phạm vi nhạy cảm nào. Nhìn chung, phương pháp hay nhất là yêu cầu dần phạm vi (yêu cầu truy cập từ trước) tại thời điểm cần thiết. Tìm hiểu thêm.

    Miền được uỷ quyền: Để bảo vệ bạn và người dùng của bạn, Google chỉ cho phép những ứng dụng xác thực bằng OAuth sử dụng Miền được uỷ quyền. Đường liên kết đến ứng dụng của bạn phải được lưu trữ trên Miền được cấp phép. Tìm hiểu thêm.

    Đường liên kết đến Trang chủ của ứng dụng: Trang chủ dành cho ứng dụng. Phải được lưu trữ trên Miền được uỷ quyền.

    Đường liên kết đến Chính sách quyền riêng tư của ứng dụng: Xuất hiện trên màn hình đồng ý liên kết Tài khoản Google. Phải được lưu trữ trên Miền được uỷ quyền.

    Đường liên kết đến Điều khoản dịch vụ của ứng dụng (Không bắt buộc): Phải được lưu trữ trên một Miền được cấp phép.

    Hình 1 Màn hình đồng ý liên kết Tài khoản Google cho một Ứng dụng giả định, Tunery

  4. Kiểm tra "Trạng thái xác minh", nếu đơn đăng ký của bạn cần được xác minh rồi nhấp vào nút "Gửi để xác minh" để gửi đơn đăng ký xác minh. Tham khảo Các yêu cầu đối với việc xác minh bằng OAuth để biết thông tin chi tiết.

Triển khai máy chủ OAuth

Để hỗ trợ các OAuth 2.0 dòng chảy ngầm, dịch vụ của bạn làm cho một thiết bị đầu cuối cho phép có sẵn bằng HTTPS. Điểm cuối này chịu trách nhiệm xác thực và nhận được sự đồng ý của người dùng để truy cập dữ liệu. Điểm cuối ủy quyền cung cấp giao diện người dùng đăng nhập cho người dùng của bạn chưa đăng nhập và ghi lại sự đồng ý đối với quyền truy cập được yêu cầu.

Khi một ứng dụng của Google cần gọi một trong các API được ủy quyền của dịch vụ của bạn, Google sẽ sử dụng điểm cuối này để xin phép người dùng của bạn thay mặt họ gọi các API này.

Một phiên quy trình ngầm định OAuth 2.0 điển hình do Google khởi xướng có quy trình sau:

  1. Google mở điểm cuối ủy 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 dữ liệu của họ bằng API của bạn, nếu họ chưa cấp quyền.
  2. Dịch vụ của bạn tạo ra một access token và trả về nó cho Google. Để làm như vậy, hãy chuyển hướng trình duyệt của người dùng trở lại Google với mã thông báo truy cập được đính kèm với yêu cầu.
  3. Google gọi các API của dịch vụ của bạn và đính kèm mã thông báo truy cập với mỗi yêu cầu. Dịch vụ của bạn xác minh rằng mã thông báo truy cập cấp quyền cho Google để truy cập API và sau đó hoàn tất lệnh gọi API.

Xử lý các yêu cầu ủy quyền

Khi một ứng dụng của Google cần thực hiện liên kết tài khoản thông qua luồng ngầm định OAuth 2.0, Google sẽ gửi người dùng đến điểm cuối ủy quyền của bạn với một yêu cầu bao gồm các thông số sau:

Tham số điểm cuối ủy quyền
client_id ID khách hàng 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 Giá trị sổ sách kế toán được chuyển lại cho Google không thay đổi trong URI chuyển hướng.
response_type Loại giá trị sẽ trả về trong phản hồi. Đối với OAuth 2.0 dòng chảy ngầm, loại phản ứng luôn được token .
user_locale Cài đặt ngôn ngữ tài khoản Google trong RFC5646 dạng được sử dụng để bản địa hoá nội dung của bạn trong ngôn ngữ ưa thích của người dùng.

Ví dụ, nếu thiết bị đầu cuối cho phép bạn có sẵn tại https://myservice.example.com/auth , một yêu cầu có thể trông như sau:

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

Để điểm cuối ủy quyền của bạn xử lý các yêu cầu đăng nhập, hãy làm theo các bước sau:

  1. Xác minh client_id và redirect_uri giá trị để ngăn chặn cấp quyền truy cập vào các ứng dụng của khách hàng ngoài ý muốn hoặc cấu hình sai:

    • Xác nhận rằng client_id phù hợp với ID khách hàng bạn đã gán cho Google.
    • Xác nhận rằng URL được chỉ định bởi các redirect_uri tham số có dạng sau:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID

  2. Kiểm tra xem người dùng đã đăng nhập vào dịch vụ của bạn chưa. 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.

  3. Tạo mã thông báo truy cập để Google sử dụng để truy cập API của bạn. Mã thông báo truy cập có thể là bất kỳ giá trị chuỗi nào, nhưng nó phải đại diện duy nhất cho người dùng và khách hàng mà mã thông báo dành cho và không được đoán.

  4. Gửi thư trả lời HTTP chuyển hướng trình duyệt của người dùng đến URL được chỉ định bởi các redirect_uri tham số. Bao gồm tất cả các tham số sau trong phân đoạn URL:

    • access_token : Các access token bạn vừa tạo
    • token_type : Chuỗi bearer
    • state : Giá trị nhà nước chưa sửa đổi từ yêu cầu ban đầu

    Sau đây là một 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

Chuyển hướng xử lý OAuth 2.0 của Google nhận được access token và khẳng định rằng state có giá trị không thay đổi. Sau khi Google có được mã thông báo truy cập cho dịch vụ của bạn, Google sẽ đính kèm mã thông báo này vào các lệnh gọi tiếp theo tới các API dịch vụ của bạn.

Xử lý các yêu cầu thông tin sử dụng

Các thiết bị đầu cuối UserInfo là một nguồn tài nguyên được bảo vệ OAuth 2.0 rằng tuyên bố trở về người dùng được liên kết. Việc triển khai và lưu trữ điểm cuối userinfo là tùy chọn, ngoại trừ các trường hợp sử dụng sau:

Sau khi mã thông báo truy cập đã được truy xuất thành công từ điểm cuối mã thông báo của bạn, Google sẽ gửi yêu cầu đến điểm cuối userinfo của bạn để truy xuất thông tin hồ sơ cơ bản về người dùng được liên kết.

tiêu đề yêu cầu điểm cuối userinfo
Authorization header Mã thông báo truy cập của loại Bearer.

Ví dụ, nếu thiết bị đầu cuối UserInfo của bạn có sẵn tại https://myservice.example.com/userinfo , một yêu cầu có thể trông như sau:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

Để điểm cuối userinfo của bạn có thể xử lý các yêu cầu, hãy làm theo các bước sau:

  1. Trích xuất mã thông báo truy cập từ tiêu đề Ủy quyền và trả lại thông tin cho người dùng được liên kết với mã thông báo truy cập.
  2. Nếu mã thông báo truy cập không hợp lệ, trả về một lỗi HTTP 401 Unauthorized với việc sử dụng WWW-Authenticate đáp ứng Header. Dưới đây là một ví dụ về một phản ứng lỗi UserInfo:
    HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
    Nếu một 401 Unauthorized, hoặc bất kỳ phản ứng lỗi không thành công khác được trả về trong quá trình liên kết, các lỗi sẽ không thể phục hồi được, token truy xuất sẽ bị loại bỏ và người dùng sẽ có để bắt đầu lại quá trình liên kết.

  3. Nếu mã thông báo truy cập có giá trị, lợi nhuận và HTTP 200 phản ứng với các đối tượng JSON sau trong cơ thể của HTTPS phản ứng: 

    {
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}
    Nếu UserInfo bạn endpoint lợi nhuận một thành công phản ứng HTTP 200, lấy token và tuyên bố được đăng ký so với của người dùng Google tài khoản.

    phản hồi điểm cuối userinfo
    sub Một ID duy nhất xác định người dùng trong hệ thống của bạn.
    email Địa chỉ email của người dùng.
    given_name Tùy chọn: First name của người dùng.
    family_name Tùy chọn: Last name của người dùng.
    name Tùy chọn: Họ và tên của người dùng.
    picture Tùy chọn: Profile picture của người dùng.

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 2 và Bướ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.