Sử dụng OAuth 2.0 để truy cập API Google

API của Google sử dụng giao thức OAuth 2.0 để xác thực và uỷ quyền. Google hỗ trợ các trường hợp OAuth 2.0 phổ biến, chẳng hạn như các tình huống cho máy chủ web, ứng dụng phía máy khách, các ứng dụng được cài đặt và đầu vào giới hạn.

Để bắt đầu, hãy lấy thông tin xác thực ứng dụng OAuth 2.0 từ Google API Console. Sau đó, ứng dụng khách của bạn yêu cầu một mã truy cập từ Máy chủ uỷ quyền của Google, trích xuất mã thông báo từ phản hồi và gửi mã thông báo tới API Google mà bạn muốn truy cập. Để minh họa tương tác về việc sử dụng OAuth 2.0 với Google (bao gồm tùy chọn sử dụng thông tin xác thực ứng dụng của riêng bạn), hãy thử nghiệm Playground 2.0 Play.

Trang này cung cấp thông tin tổng quan về các trường hợp uỷ quyền OAuth 2.0 mà Google hỗ trợ và cung cấp đường liên kết đến nội dung chi tiết hơn. Để biết thông tin chi tiết về cách sử dụng OAuth 2.0 cho quá trình xác thực, hãy xem phần OpenID Connect.

Các bước cơ bản

Tất cả ứng dụng đều tuân theo một mẫu cơ bản khi truy cập vào một API của Google bằng OAuth 2.0. Ở cấp độ cao, bạn sẽ thực hiện theo 5 bước:

1. Nhận thông tin xác thực OAuth 2.0 từ Google API Console.

Truy cập vào Google API Console để lấy thông tin xác thực OAuth 2.0, chẳng hạn như mã ứng dụng khách và mật khẩu ứng dụng mà cả Google và ứng dụng của bạn đều biết. Tập hợp giá trị sẽ khác nhau tuỳ theo loại ứng dụng bạn đang tạo. Ví dụ: một ứng dụng JavaScript không yêu cầu bí mật nhưng ứng dụng máy chủ web thì không.

Bạn phải tạo một ứng dụng OAuth phù hợp với nền tảng mà ứng dụng của bạn sẽ chạy, ví dụ:

2. Lấy mã truy cập từ Máy chủ uỷ quyền của Google.

Trước khi có thể truy cập vào dữ liệu riêng tư bằng API Google, ứng dụng của bạn phải có được mã truy cập cấp quyền truy cập vào API đó. Một mã truy cập có thể cấp quyền truy cập khác nhau cho nhiều API. Một thông số biến có tên là scope kiểm soát tập hợp tài nguyên và toán tử mà mã truy cập cho phép. Trong yêu cầu mã thông báo truy cập, ứng dụng sẽ gửi một hoặc nhiều giá trị trong tham số scope.

Có nhiều cách để tạo yêu cầu này và các thay đổi dựa trên loại ứng dụng bạn đang tạo. Ví dụ: một ứng dụng JavaScript có thể yêu cầu một mã truy cập bằng cách sử dụng lệnh chuyển hướng trình duyệt đến Google, trong khi một ứng dụng được cài đặt trên thiết bị không có trình duyệt sử dụng yêu cầu dịch vụ web.

Một số yêu cầu yêu cầu một bước xác thực để người dùng đăng nhập bằng Tài khoản Google. Sau khi đăng nhập, người dùng được hỏi có sẵn sàng cấp một hoặc nhiều quyền mà ứng dụng của bạn đang yêu cầu không. Quá trình này gọi là sự đồng ý của người dùng.

Nếu người dùng cấp ít nhất một quyền, thì Máy chủ uỷ quyền của Google sẽ gửi cho ứng dụng của bạn một mã truy cập (hoặc một mã uỷ quyền mà ứng dụng của bạn có thể dùng để lấy mã truy cập) và một danh sách phạm vi truy cập mà mã thông báo đó cấp. Nếu người dùng không cấp quyền, máy chủ sẽ trả về lỗi.

Nhìn chung, bạn nên yêu cầu tăng phạm vi khi cần truy cập vào thời điểm đó thay vì ở phía trước. Ví dụ: một ứng dụng muốn hỗ trợ lưu sự kiện vào lịch không được yêu cầu quyền truy cập vào Lịch Google cho đến khi người dùng nhấn nút "Thêm vào Lịch"; xem Ủy quyền gia tăng.

3. Kiểm tra các phạm vi truy cập do người dùng cấp.

So sánh các phạm vi có trong phản hồi của mã truy cập với các phạm vi cần thiết để truy cập vào các tính năng và chức năng của ứng dụng phụ thuộc vào quyền truy cập vào một API liên quan của Google. Tắt mọi tính năng của ứng dụng không thể hoạt động nếu không có quyền truy cập vào API liên quan.

Phạm vi đưa ra trong yêu cầu của bạn có thể không khớp với phạm vi có trong phản hồi của bạn, ngay cả khi người dùng đã cấp tất cả các phạm vi yêu cầu. Tham khảo tài liệu về từng API Google để biết phạm vi cần thiết để truy cập. API có thể liên kết nhiều giá trị chuỗi phạm vi với một phạm vi truy cập duy nhất, trả về cùng một chuỗi phạm vi cho tất cả các giá trị được phép trong yêu cầu. Ví dụ: API Google People có thể trả về phạm vi https://www.googleapis.com/auth/contacts khi một ứng dụng yêu cầu người dùng cấp quyền cho phạm vi https://www.google.com/m8/feeds/; phương thức API Google People people.updateContact yêu cầu phạm vi https://www.googleapis.com/auth/contacts được cấp.

4. Gửi mã thông báo truy cập đến một API.

Sau khi nhận được mã truy cập, ứng dụng sẽ gửi mã thông báo đó đến API Google trong tiêu đề của yêu cầu uỷ quyền HTTP. Bạn có thể gửi mã thông báo dưới dạng tham số chuỗi truy vấn URI, nhưng bạn không nên gửi mã này vì tham số URI có thể xuất hiện trong các tệp nhật ký không hoàn toàn an toàn. Ngoài ra, bạn cũng nên tránh sử dụng tên tham số URI không cần thiết.

Mã thông báo truy cập chỉ hợp lệ đối với tập hợp thao tác và tài nguyên được mô tả trong scope của yêu cầu mã thông báo. Ví dụ: nếu một mã truy cập được cấp cho API Lịch Google, thì mã truy cập đó không cấp quyền truy cập vào API Danh bạ Google. Tuy nhiên, bạn có thể gửi mã truy cập đó đến API Lịch Google nhiều lần cho các hoạt động tương tự.

5. Làm mới mã truy cập, nếu cần.

Mã truy cập có thời gian tồn tại hạn chế. Nếu ứng dụng của bạn cần quyền truy cập vào một API của Google vượt quá thời gian tồn tại của một mã truy cập, thì ứng dụng đó có thể lấy mã làm mới. Mã làm mới cho phép ứng dụng của bạn lấy mã truy cập mới.

Trường hợp

Ứng dụng máy chủ web

Điểm cuối Google OAuth 2.0 hỗ trợ các ứng dụng máy chủ web sử dụng ngôn ngữ và khung như PHP, Java, Python, Ruby và ASP.NET.

Trình tự uỷ quyền bắt đầu khi ứng dụng của bạn chuyển hướng trình duyệt đến một URL Google; URL đó bao gồm các tham số truy vấn cho biết loại quyền truy cập đang được yêu cầu. Google xử lý việc xác thực người dùng, lựa chọn phiên và sự đồng ý của người dùng. Kết quả là một mã uỷ quyền mà ứng dụng có thể trao đổi để lấy mã truy cập và mã làm mới.

Ứng dụng sẽ lưu trữ mã làm mới để sử dụng sau này và sử dụng mã truy cập để truy cập vào một API của Google. Sau khi mã truy cập hết hạn, ứng dụng sẽ sử dụng mã làm mới để lấy mã mới.

Ứng dụng của bạn gửi yêu cầu mã thông báo đến Máy chủ uỷ quyền của Google, nhận mã uỷ quyền, trao đổi mã lấy mã thông báo và sử dụng mã để gọi một điểm cuối API của Google.

Để biết thông tin chi tiết, hãy xem phần Sử dụng OAuth 2.0 cho ứng dụng máy chủ web.

Các ứng dụng đã cài đặt

Điểm cuối Google OAuth 2.0 hỗ trợ các ứng dụng được cài đặt trên thiết bị như máy tính, thiết bị di động và máy tính bảng. Khi bạn tạo mã ứng dụng khách thông qua Google API Console, hãy chỉ định đây là Ứng dụng đã cài đặt, sau đó chọn ứng dụng Android, Chrome, iOS, Universal Windows Platform (UWP) hoặc Máy tính làm loại ứng dụng.

Quá trình này sẽ dẫn đến một mã ứng dụng khách và trong một số trường hợp, sẽ là một mã bí mật ứng dụng mà bạn nhúng vào mã nguồn của ứng dụng. (Trong trường hợp này, mật khẩu ứng dụng khách rõ ràng không được coi là bí mật).

Trình tự uỷ quyền bắt đầu khi ứng dụng của bạn chuyển hướng trình duyệt đến một URL Google; URL đó bao gồm các tham số truy vấn cho biết loại quyền truy cập đang được yêu cầu. Google xử lý việc xác thực người dùng, lựa chọn phiên và sự đồng ý của người dùng. Kết quả là một mã uỷ quyền mà ứng dụng có thể trao đổi để lấy mã truy cập và mã làm mới.

Ứng dụng sẽ lưu trữ mã làm mới để sử dụng sau này và sử dụng mã truy cập để truy cập vào một API của Google. Sau khi mã truy cập hết hạn, ứng dụng sẽ sử dụng mã làm mới để lấy mã mới.

Ứng dụng của bạn gửi yêu cầu mã thông báo đến Máy chủ uỷ quyền của Google, nhận mã uỷ quyền, trao đổi mã lấy mã thông báo và sử dụng mã để gọi một điểm cuối API của Google.

Để biết chi tiết, hãy xem phần Sử dụng OAuth 2.0 cho ứng dụng đã cài đặt.

Ứng dụng phía máy khách (JavaScript)

Điểm cuối Google OAuth 2.0 hỗ trợ các ứng dụng JavaScript chạy trong trình duyệt.

Trình tự uỷ quyền bắt đầu khi ứng dụng của bạn chuyển hướng trình duyệt đến một URL Google; URL đó bao gồm các tham số truy vấn cho biết loại quyền truy cập đang được yêu cầu. Google xử lý việc xác thực người dùng, lựa chọn phiên và sự đồng ý của người dùng.

Kết quả là một mã truy cập mà ứng dụng nên xác thực trước khi đưa vào yêu cầu API Google. Khi mã thông báo hết hạn, ứng dụng sẽ lặp lại quá trình.

Ứng dụng JS của bạn gửi một yêu cầu mã thông báo đến Máy chủ uỷ quyền của Google, nhận một mã thông báo, xác thực mã thông báo và sử dụng mã thông báo đó để gọi một điểm cuối API Google.

Để biết thông tin chi tiết, hãy xem phần Sử dụng OAuth 2.0 cho ứng dụng phía máy khách.

Ứng dụng trên thiết bị nhập hạn chế

Điểm cuối Google OAuth 2.0 hỗ trợ các ứng dụng chạy trên các thiết bị đầu vào giới hạn như máy chơi trò chơi, máy quay video và máy in.

Trình tự uỷ quyền bắt đầu bằng việc ứng dụng tạo yêu cầu dịch vụ web cho một URL của Google để lấy mã uỷ quyền. Phản hồi chứa một số tham số, trong đó có URL và mã mà ứng dụng hiển thị cho người dùng.

Người dùng sẽ lấy URL và mã từ thiết bị, sau đó chuyển sang một thiết bị hoặc máy tính riêng có khả năng nhập đầu vào phong phú hơn. Người dùng khởi chạy một trình duyệt, chuyển đến URL được chỉ định, đăng nhập rồi nhập mã.

Trong khi đó, ứng dụng thăm dò ý kiến một URL của Google theo khoảng thời gian định sẵn. Sau khi người dùng phê duyệt quyền truy cập, phản hồi từ máy chủ của Google sẽ chứa mã truy cập và mã làm mới. Ứng dụng sẽ lưu trữ mã làm mới để sử dụng sau này và sử dụng mã truy cập để truy cập vào một API của Google. Sau khi mã truy cập hết hạn, ứng dụng sẽ sử dụng mã làm mới để lấy mã mới.

Người dùng đăng nhập trên một thiết bị riêng biệt có trình duyệt

Để biết chi tiết, hãy xem phần Sử dụng OAuth 2.0 cho thiết bị.

Tài khoản dịch vụ

Các API của Google như API dự đoán và Google Cloud Storage có thể hoạt động thay mặt cho ứng dụng mà không cần truy cập vào thông tin người dùng. Trong những trường hợp như vậy, ứng dụng của bạn cần chứng minh danh tính của riêng mình với API, nhưng không cần người dùng đồng ý. Tương tự, trong các trường hợp dành cho doanh nghiệp, ứng dụng của bạn có thể yêu cầu quyền truy cập được uỷ quyền cho một số tài nguyên.

Đối với các loại tương tác từ máy chủ đến máy chủ này, bạn cần có tài khoản dịch vụ. Tài khoản này là tài khoản thuộc về ứng dụng của bạn thay vì thuộc về người dùng cuối riêng lẻ. Ứng dụng của bạn gọi API Google thay mặt cho tài khoản dịch vụ và người dùng không cần phải đồng ý. (Trong các trường hợp không có tài khoản dịch vụ, ứng dụng của bạn sẽ gọi API của Google thay mặt cho người dùng cuối và đôi khi cần có sự đồng ý của người dùng.)

Thông tin đăng nhập của tài khoản dịch vụ mà bạn nhận được từ Google API Console, bao gồm một địa chỉ email đã tạo riêng biệt, mã ứng dụng khách và ít nhất một cặp khoá công khai/riêng tư. Bạn sẽ sử dụng mã ứng dụng khách và một khoá riêng tư để tạo JWT đã ký và tạo yêu cầu mã thông báo truy cập theo định dạng thích hợp. Sau đó, ứng dụng của bạn sẽ gửi yêu cầu mã thông báo đến Máy chủ uỷ quyền Google OAuth 2.0. Máy chủ này sẽ trả về một mã truy cập. Ứng dụng sử dụng mã thông báo để truy cập vào một API của Google. Khi mã thông báo hết hạn, ứng dụng sẽ lặp lại quy trình.

Ứng dụng máy chủ của bạn sử dụng JWT để yêu cầu mã thông báo từ Máy chủ uỷ quyền của Google, sau đó dùng mã này để gọi một điểm cuối API của Google. Việc này không liên quan đến người dùng cuối.

Để biết thông tin chi tiết, hãy xem tài liệu về tài khoản dịch vụ.

Kích thước mã thông báo

Mã thông báo có thể có kích thước khác nhau, cho đến các giới hạn sau:

  • Mã uỷ quyền: 256 byte
  • Mã thông báo truy cập: 2048 byte
  • Làm mới mã thông báo: 512 byte

Các mã truy cập do API dịch vụ mã thông báo bảo mật của Google Cloud trả về có cấu trúc tương tự như mã truy cập OAuth 2.0 của API Google nhưng có giới hạn kích thước mã thông báo khác nhau. Để biết thông tin chi tiết, hãy xem tài liệu về API.

Google giữ quyền thay đổi kích thước mã thông báo trong giới hạn này và ứng dụng của bạn phải hỗ trợ kích thước mã thông báo thay đổi tương ứng.

Làm mới thời gian hết hạn mã thông báo

Bạn phải viết mã của mình để dự đoán khả năng một mã làm mới đã cấp có thể không còn hoạt động. Mã làm mới có thể ngừng hoạt động vì một trong những lý do sau:

Một dự án Google Cloud Platform có màn hình xin phép bằng OAuth được định cấu hình cho một loại người dùng bên ngoài và trạng thái xuất bản "Thử nghiệm" sẽ được cấp mã thông báo làm mới sau 7 ngày, trừ phi phạm vi duy nhất OAuth được yêu cầu là một tập hợp con của tên, địa chỉ email và hồ sơ người dùng (thông qua phạm vi userinfo.email, userinfo.profile, openid hoặc OpenID Connect tương đương).

Hiện có giới hạn 100 mã làm mới cho mỗi Tài khoản Google trên mỗi mã ứng dụng khách OAuth 2.0. Nếu đạt đến giới hạn, việc tạo mã làm mới mới sẽ tự động vô hiệu hoá mã làm mới cũ nhất mà không có cảnh báo. Giới hạn này không áp dụng cho tài khoản dịch vụ.

Ngoài ra, chúng tôi cũng có một hạn mức lớn hơn về tổng số mã làm mới mà một tài khoản người dùng hoặc tài khoản dịch vụ có thể có trên tất cả ứng dụng. Hầu hết người dùng thông thường sẽ không vượt quá giới hạn này, nhưng tài khoản nhà phát triển được dùng để thử nghiệm một cách triển khai có thể.

Nếu bạn cần uỷ quyền cho nhiều chương trình, máy hoặc thiết bị, một cách giải quyết là giới hạn số lượng ứng dụng khách mà bạn uỷ quyền trên mỗi Tài khoản Google ở mức 15 hoặc 20. Nếu là quản trị viên Google Workspace, bạn có thể tạo thêm người dùng có đặc quyền của quản trị viên và sử dụng những đặc quyền đó để uỷ quyền cho một số khách hàng.

Xử lý các chính sách kiểm soát phiên cho tổ chức Google Cloud Platform (GCP)

Quản trị viên của các tổ chức GCP có thể yêu cầu xác thực lại người dùng thường xuyên trong khi họ truy cập vào các tài nguyên GCP, bằng cách sử dụng tính năng kiểm soát phiên của Google Cloud. Chính sách này tác động đến quyền truy cập vào Google Cloud Console, Google Cloud SDK (còn gọi là gcloud CLI) và mọi ứng dụng OAuth của bên thứ ba yêu cầu phạm vi Cloud Platform. Nếu người dùng áp dụng chính sách kiểm soát phiên, thì khi thời lượng phiên hết hạn, các lệnh gọi API của bạn sẽ gặp lỗi tương tự như điều sẽ xảy ra nếu mã làm mới bị thu hồi – lệnh gọi sẽ không thành công với loại lỗi invalid_grant; có thể sử dụng trường error_subtype để phân biệt giữa mã thông báo bị thu hồi và thời gian gia hạn là 1 giờ, thời gian này sẽ là 2 giờ một lần.

Đồng thời, bạn không được sử dụng hoặc khuyến khích sử dụng thông tin xác thực người dùng để triển khai máy chủ sang máy chủ. Nếu thông tin xác thực người dùng được triển khai trên máy chủ cho các công việc hoặc hoạt động dài hạn và một khách hàng áp dụng chính sách kiểm soát phiên cho những người dùng đó, thì ứng dụng máy chủ sẽ không thực hiện được vì không có cách nào để xác thực lại người dùng khi thời lượng phiên kết thúc.

Để biết thêm thông tin về cách giúp khách hàng triển khai tính năng này, hãy tham khảo bài viết trợ giúp tập trung vào quản trị viên này.

Thư viện ứng dụng

Các thư viện ứng dụng sau đây tích hợp với các khung phổ biến, giúp việc triển khai OAuth 2.0 trở nên đơn giản hơn. Chúng tôi sẽ thêm nhiều tính năng hơn vào thư viện theo thời gian.