Sử dụng OAuth 2.0 cho ứng dụng từ máy chủ đến máy chủ

Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
175 Để biết thêm thông tin, hãy xem phần Tổng quan về xác thực trong tài liệu của Google Cloud Platform.

Hệ thống Google OAuth 2.0 hỗ trợ các hoạt động tương tác từ máy chủ đến máy chủ, chẳng hạn như các hoạt động giữa một ứng dụng web và một dịch vụ của Google. Trong trường hợp này, bạn cần có một tài khoản dịch vụ, đây là tài khoản thuộc ứng dụng của bạn thay vì một người dùng cuối riêng lẻ. Ứng dụng của bạn thay mặt cho tài khoản dịch vụ gọi các API của Google, vì vậy, người dùng không cần trực tiếp tham gia. Tình huống này đôi khi được gọi là "OAuth chân;" hoặc "2LO." (Thuật ngữ liên quan &&tt;Ba chân OAuth" là các tình huống mà trong đó ứng dụng của bạn gọi API của Google thay mặt cho người dùng cuối và đôi khi người dùng cuối phải đồng ý.)

Thông thường, ứng dụng sẽ sử dụng tài khoản dịch vụ khi ứng dụng đó sử dụng API của Google để làm việc với dữ liệu của riêng mình thay vì dùng dữ liệu của người dùng. Ví dụ: một ứng dụng sử dụng dịch vụ lưu trữ dữ liệu của Google Cloud để lưu trữ dữ liệu sẽ sử dụng một tài khoản dịch vụ để xác thực các lệnh gọi của ứng dụng đó đến API Google Cloud Datastore.

Quản trị viên miền Google Workspace cũng có thể cấp quyền cho toàn bộ tài khoản dịch vụ trên miền để truy cập vào dữ liệu của người dùng thay mặt người dùng trong miền.

Tài liệu này mô tả cách một ứng dụng có thể hoàn tất quy trình OAuth 2.0 từ máy chủ đến máy chủ bằng cách sử dụng thư viện ứng dụng API của Google (nên dùng) hoặc HTTP.

Tổng quan

Để hỗ trợ các hoạt động tương tác giữa các máy chủ, trước tiên, hãy tạo một tài khoản dịch vụ cho dự án của bạn trong . Nếu bạn muốn truy cập vào dữ liệu người dùng đối với người dùng trong tài khoản Google Workspace, hãy ủy quyền truy cập trên toàn miền vào tài khoản dịch vụ.

Sau đó, ứng dụng của bạn sẽ chuẩn bị thực hiện các lệnh gọi API được cấp phép bằng cách sử dụng thông tin đăng nhập của tài khoản dịch vụ để yêu cầu mã truy cập từ máy chủ xác thực OAuth 2.0.

Cuối cùng, ứng dụng của bạn có thể sử dụng mã truy cập để gọi API của Google.

Tạo một tài khoản dịch vụ

Thông tin đăng nhập của tài khoản dịch vụ bao gồm một địa chỉ email đã tạo duy nhất và có ít nhất một cặp khóa công khai/riêng tư. Nếu chế độ ủy quyền trên toàn miền đang bật, thì mã ứng dụng cũng là một phần trong thông tin đăng nhập của tài khoản dịch vụ đó.

Nếu ứng dụng của bạn chạy trên Google App Engine, một tài khoản dịch vụ sẽ tự động được thiết lập khi bạn tạo dự án.

Nếu ứng dụng của bạn chạy trên Google Compute Engine, thì một tài khoản dịch vụ cũng sẽ được thiết lập tự động khi bạn tạo dự án. Tuy nhiên, bạn phải chỉ định các phạm vi mà ứng dụng của bạn cần quyền truy cập khi tạo một phiên bản Google Compute Engine. Để biết thêm thông tin, hãy xem phần Chuẩn bị bản sao để sử dụng tài khoản dịch vụ.

Nếu ứng dụng của bạn không chạy trên Google App Engine hoặc Google Compute Engine, bạn phải lấy các thông tin đăng nhập này trong . Để tạo thông tin xác thực tài khoản dịch vụ hoặc để xem thông tin xác thực công khai mà bạn đã tạo, hãy làm như sau:

Đầu tiên, hãy tạo một tài khoản dịch vụ:

  1. Mở Service accounts page.
  2. If prompted, select a project, or create a new one.
  3. Nhấn vào Tạo tài khoản dịch vụ.
  4. Theo chi tiết tài khoản dịch vụ, gõ tên, ID, và mô tả cho tài khoản dịch vụ, sau đó nhấp vào Tạo và tiếp tục.
  5. Tùy chọn: Theo Grant dịch vụ này truy cập tài khoản cho dự án, chọn vai trò IAM cấp cho tài khoản dịch vụ.
  6. Nhấp vào Tiếp tục.
  7. Tùy chọn: Theo Grant người dùng truy cập vào tài khoản của dịch vụ này, thêm người dùng hoặc nhóm được phép sử dụng và quản lý tài khoản dịch vụ.
  8. Nhấn Done.
  9. Nhấn Tạo chìa khóa, sau đó nhấp vào Tạo.

Tiếp theo, tạo khóa tài khoản dịch vụ:

  1. Nhấp vào địa chỉ email cho tài khoản dịch vụ bạn đã tạo.
  2. Nhấp vào tab Keys.
  3. Trong các Thêm chủ chốt danh sách thả xuống, chọn Tạo khóa mới.
  4. Nhấp vào Tạo.

Cặp khóa công khai / riêng tư mới của bạn được tạo và tải xuống máy của bạn; nó đóng vai trò là bản sao duy nhất của khóa cá nhân. Bạn có trách nhiệm lưu trữ nó một cách an toàn. Nếu bạn làm mất cặp khóa này, bạn sẽ cần tạo một cặp khóa mới.

Bạn có thể quay lại API Console bất cứ lúc nào để xem địa chỉ email, vân tay số của khoá công khai và các thông tin khác, hoặc để tạo thêm các cặp khoá công khai/riêng tư. Để biết thêm thông tin về thông tin đăng nhập của tài khoản dịch vụ trong API Console, hãy xem phần Tài khoản dịch vụ trong tệp trợ giúp API Console.

Hãy ghi lại địa chỉ email của tài khoản dịch vụ và lưu trữ tệp khóa riêng tư của tài khoản dịch vụ ở một vị trí mà ứng dụng của bạn có thể truy cập. Ứng dụng cần chúng để thực hiện các lệnh gọi API được phép.

Ủy quyền trên toàn miền cho tài khoản dịch vụ

Nếu bạn có tài khoản Google Workspace, quản trị viên của tổ chức có thể thay mặt người dùng trong miền Google Workspace cấp quyền cho một ứng dụng truy cập vào dữ liệu người dùng. Ví dụ: một ứng dụng sử dụng API Lịch Google để thêm các sự kiện vào lịch của tất cả người dùng trong một miền Google Workspace sẽ sử dụng một tài khoản dịch vụ để truy cập API Lịch Google thay mặt cho người dùng. Việc cấp phép cho một tài khoản dịch vụ truy cập vào dữ liệu thay mặt cho người dùng trong một miền đôi khi được gọi là "ủy quyền trên toàn miền" cho một tài khoản dịch vụ.

Để ủy quyền quyền trên toàn miền cho một tài khoản dịch vụ, quản trị viên cấp cao của miền Google Workspace phải hoàn thành các bước sau:

  1. Từ Bảng điều khiển dành cho quản trị viên của miền Google Workspace, hãy chuyển đến Trình đơn chính > Bảo mật > Quyền truy cập và kiểm soát dữ liệu > Kiểm soát API.
  2. Trong ngăn Ủy quyền trên toàn miền, hãy chọn Quản lý ủy quyền trên toàn miền.
  3. Nhấp vào Thêm mới.
  4. Trong trường Mã ứng dụng, hãy nhập Mã ứng dụng của tài khoản dịch vụ. Bạn có thể tìm thấy mã khách hàng của tài khoản dịch vụ trong Service accounts page.
  5. Trong trường các phạm vi OAuth (phân tách bằng dấu phẩy), hãy nhập danh sách các phạm vi mà ứng dụng của bạn được cấp quyền truy cập. Ví dụ: nếu ứng dụng của bạn cần quyền truy cập đầy đủ vào toàn bộ miền đối với API Google Drive và API Lịch Google, hãy nhập: https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/calendar.
  6. Nhấp vào Uỷ quyền.

Ứng dụng của bạn hiện có quyền thực hiện lệnh gọi API với tư cách là người dùng trong miền của bạn (để "impersonate" người dùng). Khi chuẩn bị thực hiện các lệnh gọi API được cấp phép, bạn chỉ định người dùng mạo danh.

Chuẩn bị thực hiện lệnh gọi API được ủy quyền

Java

Sau khi bạn có địa chỉ email khách và khoá riêng tư từ API Console, hãy sử dụng Thư viện ứng dụng API của Google cho Java để tạo đối tượng GoogleCredential từ thông tin đăng nhập của tài khoản dịch vụ và phạm vi mà ứng dụng của bạn cần quyền truy cập. Ví dụ:

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.services.sqladmin.SQLAdminScopes;

// ...

GoogleCredential credential = GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"))
    .createScoped(Collections.singleton(SQLAdminScopes.SQLSERVICE_ADMIN));

Nếu đang phát triển một ứng dụng trên Google Cloud Platform, bạn có thể sử dụng thông tin xác thực mặc định của ứng dụng để đơn giản hoá quy trình.

Ủy quyền trên toàn miền

Nếu bạn được ủy quyền truy cập vào toàn bộ miền vào tài khoản dịch vụ và muốn mạo danh tài khoản người dùng, hãy chỉ định địa chỉ email của tài khoản người dùng bằng phương thức createDelegated của đối tượng GoogleCredential. Ví dụ:

GoogleCredential credential = GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"))
    .createScoped(Collections.singleton(SQLAdminScopes.SQLSERVICE_ADMIN))
    .createDelegated("user@example.com");

Sử dụng đối tượng GoogleCredential để gọi các API của Google trong ứng dụng của bạn.

Python

Sau khi bạn có địa chỉ email khách hàng và khoá riêng tư từ API Console, hãy sử dụng Thư viện ứng dụng Python cho API của Google để hoàn thành các bước sau:

  1. Tạo đối tượng Credentials từ thông tin đăng nhập của tài khoản dịch vụ và phạm vi mà ứng dụng của bạn cần quyền truy cập. Ví dụ:
    from google.oauth2 import service_account
    
    SCOPES = ['https://www.googleapis.com/auth/sqlservice.admin']
    SERVICE_ACCOUNT_FILE = '/path/to/service.json'
    
    credentials = service_account.Credentials.from_service_account_file(
            SERVICE_ACCOUNT_FILE, scopes=SCOPES)

    Nếu đang phát triển một ứng dụng trên Google Cloud Platform, bạn có thể sử dụng thông tin xác thực mặc định của ứng dụng để đơn giản hoá quy trình.

  2. Ủy quyền trên toàn miền

    Nếu bạn được ủy quyền truy cập vào toàn bộ miền vào tài khoản dịch vụ và muốn mạo danh tài khoản người dùng, hãy sử dụng phương thức with_subject của đối tượng ServiceAccountCredentials hiện có. Ví dụ:

    delegated_credentials = credentials.with_subject('user@example.org')

Sử dụng đối tượng Thông tin đăng nhập để gọi các API của Google trong ứng dụng của bạn.

HTTP/REST

Sau khi bạn có được mã ứng dụng khách và khoá riêng tư từ API Console, ứng dụng của bạn cần hoàn tất các bước sau:

  1. Tạo Mã thông báo web JSON (JWT, được phát âm, "jot") bao gồm tiêu đề, bộ thông báo xác nhận quyền sở hữu và chữ ký.
  2. Yêu cầu mã truy cập từ Máy chủ ủy quyền Google OAuth 2.0.
  3. Xử lý phản hồi JSON mà Máy chủ uỷ quyền trả về.

Các phần sau đây mô tả cách hoàn tất các bước này.

Nếu phản hồi chứa mã truy cập, bạn có thể sử dụng mã truy cập để gọi API Google. (Nếu nội dung phản hồi không chứa mã truy cập, có thể yêu cầu mã thông báo và JWT của bạn không được tạo đúng cách, hoặc tài khoản dịch vụ có thể không có quyền truy cập vào phạm vi yêu cầu.)

Khi mã truy cập hết hạn, ứng dụng của bạn sẽ tạo một WWT khác, ký mã đó và yêu cầu một mã truy cập khác.

Ứ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 đó sử dụng mã thông báo để gọi điểm cuối Google API. Không có người dùng cuối nào tham gia.

Phần còn lại của mục này mô tả thông tin cụ thể về cách tạo JWT, ký JWT, tạo yêu cầu mã thông báo truy cập và xử lý phản hồi.

Tạo JWT

JWT bao gồm ba phần: tiêu đề, tập hợp xác nhận quyền sở hữu và chữ ký. Tiêu đề và bộ thông báo xác nhận quyền sở hữu là các đối tượng JSON. Các đối tượng JSON này được chuyển đổi tuần tự thành byte UTF-8, sau đó được mã hoá bằng phương thức mã hoá Base64url. Phương thức mã hoá này cung cấp khả năng phục hồi trước các thay đổi về mã hoá do các thao tác mã hoá lặp lại. Tiêu đề, tập hợp xác nhận quyền sở hữu và chữ ký được nối với nhau bằng ký tự dấu chấm (.).

JWT bao gồm như sau:

{Base64url encoded header}.{Base64url encoded claim set}.{Base64url encoded signature}

Chuỗi cơ sở cho chữ ký như sau:

{Base64url encoded header}.{Base64url encoded claim set}
Tạo tiêu đề JWT

Tiêu đề này có hai trường cho biết thuật toán ký và định dạng của câu nhận định. Cả hai trường là bắt buộc và mỗi trường chỉ có một giá trị. Khi các thuật toán và định dạng bổ sung được ra mắt, tiêu đề này sẽ thay đổi tương ứng.

Tài khoản dịch vụ dựa vào thuật toán SHA-256 của RSA và định dạng mã thông báo JWT. Do đó, cách trình bày JSON của tiêu đề như sau:

{"alg":"RS256","typ":"JWT"}

Nội dung trình bày của Base64url như sau:

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9
Tạo đơn khiếu nại JWT

Tập hợp xác nhận quyền sở hữu JWT chứa thông tin về JWT, bao gồm các quyền được yêu cầu (phạm vi), mục tiêu của mã thông báo, nhà phát hành, thời gian mã thông báo được phát hành và toàn bộ thời gian của mã thông báo. Hầu hết các trường là bắt buộc. Giống như tiêu đề JWT, tập hợp thông báo xác nhận quyền sở hữu JWT là một đối tượng JSON và được dùng để tính toán chữ ký.

Thông báo xác nhận quyền sở hữu bắt buộc

Dưới đây là các thông báo xác nhận quyền sở hữu bắt buộc trong tập hợp thông báo xác nhận quyền sở hữu của JWT. Các nguyên tắc này có thể xuất hiện theo bất kỳ thứ tự nào trong thông báo xác nhận quyền sở hữu.

Tên Nội dung mô tả
iss Địa chỉ email của tài khoản dịch vụ.
scope Danh sách các quyền được phân tách bằng dấu cách mà ứng dụng yêu cầu.
aud Chỉ số mô tả mục tiêu dự định của câu nhận định. Khi tạo yêu cầu mã truy cập, giá trị này luôn là https://oauth2.googleapis.com/token.
exp Thời gian hết hạn của xác nhận, được chỉ định bằng giây kể từ 00:00:00 UTC, ngày 1 tháng 1 năm 1970. Giá trị này có tối đa 1 giờ sau thời gian phát hành.
iat Thời gian đưa ra xác nhận, được chỉ định là giây kể từ 00:00:00 UTC, ngày 1 tháng 1 năm 1970.

Dưới đây là nội dung trình bày về các trường bắt buộc trong một bộ thông báo xác nhận quyền sở hữu JWT:

{
  "iss": "761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com",
  "scope": "https://www.googleapis.com/auth/devstorage.read_only",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}
Thông báo xác nhận quyền sở hữu bổ sung

Trong một số trường hợp doanh nghiệp, ứng dụng có thể sử dụng tính năng ủy quyền trên toàn miền để hành động thay mặt cho một người dùng cụ thể trong tổ chức. Quyền thực hiện loại mạo danh này phải được cấp trước khi ứng dụng mạo danh người dùng và thường do quản trị viên cấp cao xử lý. Để biết thêm thông tin, hãy xem phần Kiểm soát quyền truy cập của API bằng tính năng ủy quyền trên toàn miền.

Để có được mã truy cập cấp cho một ứng dụng quyền truy cập vào một tài nguyên, hãy cung cấp địa chỉ email của người dùng trong thông báo xác nhận quyền sở hữu JWT đã đặt làm giá trị của trường sub.

Tên Nội dung mô tả
sub Địa chỉ email của người dùng mà ứng dụng đang yêu cầu quyền truy cập được ủy quyền.

Nếu một ứng dụng không có quyền mạo danh người dùng, thì phản hồi cho một yêu cầu mã thông báo truy cập có chứa trường sub sẽ là một lỗi.

Dưới đây là ví dụ về một nhóm thông báo xác nhận quyền sở hữu JWT có trường sub:

{
  "iss": "761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com",
  "sub": "some.user@example.com",
  "scope": "https://www.googleapis.com/auth/prediction",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}
Mã hoá tập hợp xác nhận quyền sở hữu JWT

Giống như tiêu đề JWT, tập hợp thông báo xác nhận quyền sở hữu JWT phải được chuyển đổi tuần tự thành UTF-8 và Base64url-safe được mã hoá. Dưới đây là ví dụ về cách biểu diễn JSON của tập hợp thông báo xác nhận quyền sở hữu JWT:

{
  "iss": "761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com",
  "scope": "https://www.googleapis.com/auth/prediction",
  "aud": "https://oauth2.googleapis.com/token",
  "exp": 1328554385,
  "iat": 1328550785
}
Đang tính toán chữ ký

Chữ ký trên web JSON (JWS) là thông số hướng dẫn cơ chế tạo chữ ký cho JWT. Dữ liệu đầu vào cho chữ ký là mảng byte của nội dung sau:

{Base64url encoded header}.{Base64url encoded claim set}

Thuật toán ký trong tiêu đề JWT phải được sử dụng khi tính toán chữ ký. Thuật toán ký duy nhất mà Máy chủ ủy quyền Google OAuth 2.0 hỗ trợ là RSA sử dụng thuật toán băm SHA-256. Điều này được biểu thị dưới dạng RS256 trong trường alg của tiêu đề JWT.

Ký đại diện UTF-8 của đầu vào bằng cách sử dụng SHA256withRSA (còn gọi là RSASSA-PKCS1-V1_5-SIGN với hàm băm SHA-256) bằng khoá riêng tư thu được từ Google API Console. Đầu ra sẽ là một mảng byte.

Sau đó, chữ ký phải được mã hoá bằng Base64url. Tiêu đề, tập hợp xác nhận quyền sở hữu và chữ ký được nối với nhau bằng ký tự dấu chấm (.). Kết quả là JWT. Phần này phải có nội dung như sau (dấu ngắt dòng được thêm vào để rõ ràng):

{Base64url encoded header}.
{Base64url encoded claim set}.
{Base64url encoded signature}

Dưới đây là ví dụ về JWT trước khi mã hoá Base64url:

{"alg":"RS256","typ":"JWT"}.
{
"iss":"761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com",
"scope":"https://www.googleapis.com/auth/prediction",
"aud":"https://oauth2.googleapis.com/token",
"exp":1328554385,
"iat":1328550785
}.
[signature bytes]

Dưới đây là ví dụ về JWT đã được ký và sẵn sàng truyền:

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL29hdXRoMi92NC90b2tlbiIsImV4cCI6MTMyODU1NDM4NSwiaWF0IjoxMzI4NTUwNzg1fQ.UFUt59SUM2_AW4cRU8Y0BYVQsNTo4n7AFsNrqOpYiICDu37vVt-tw38UKzjmUKtcRsLLjrR3gFW3dNDMx_pL9DVjgVHDdYirtrCekUHOYoa1CMR66nxep5q5cBQ4y4u2kIgSvChCTc9pmLLNoIem-ruCecAJYgI9Ks7pTnW1gkOKs0x3YpiLpzplVHAkkHztaXiJdtpBcY1OXyo6jTQCa3Lk2Q3va1dPkh_d--GU2M5flgd8xNBPYw4vxyt0mP59XZlHMpztZt0soSgObf7G3GXArreF_6tpbFsS3z2t5zkEiHuWJXpzcYr5zWTRPDEHsejeBSG8EgpLDce2380ROQ

Gửi yêu cầu mã thông báo truy cập

Sau khi tạo JWT đã ký, ứng dụng có thể sử dụng JWT đó để yêu cầu mã truy cập. Yêu cầu mã thông báo truy cập này là một yêu cầu POST HTTPS và nội dung được mã hóa URL. URL xuất hiện bên dưới:

https://oauth2.googleapis.com/token

Các tham số sau đây là bắt buộc trong yêu cầu HTTPS POST:

Tên Nội dung mô tả
grant_type Sử dụng chuỗi sau, được mã hóa URL nếu cần: urn:ietf:params:oauth:grant-type:jwt-bearer
assertion JWT, bao gồm cả chữ ký.

Dưới đây là tệp kết xuất thô của yêu cầu HTTPS POST dùng trong yêu cầu mã truy cập:

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vYWNjb3VudHMuZ29vZ2xlLmNvbS9vL29hdXRoMi90b2tlbiIsImV4cCI6MTMyODU3MzM4MSwiaWF0IjoxMzI4NTY5NzgxfQ.ixOUGehweEVX_UKXv5BbbwVEdcz6AYS-6uQV6fGorGKrHf3LIJnyREw9evE-gs2bmMaQI5_UbabvI4k-mQE4kBqtmSpTzxYBL1TCd7Kv5nTZoUC1CmwmWCFqT9RE6D7XSgPUh_jF1qskLa2w0rxMSjwruNKbysgRNctZPln7cqQ

Dưới đây là yêu cầu tương tự, sử dụng curl:

curl -d 'grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI3NjEzMjY3OTgwNjktcjVtbGpsbG4xcmQ0bHJiaGc3NWVmZ2lncDM2bTc4ajVAZGV2ZWxvcGVyLmdzZXJ2aWNlYWNjb3VudC5jb20iLCJzY29wZSI6Imh0dHBzOi8vd3d3Lmdvb2dsZWFwaXMuY29tL2F1dGgvcHJlZGljdGlvbiIsImF1ZCI6Imh0dHBzOi8vYWNjb3VudHMuZ29vZ2xlLmNvbS9vL29hdXRoMi90b2tlbiIsImV4cCI6MTMyODU3MzM4MSwiaWF0IjoxMzI4NTY5NzgxfQ.RZVpzWygMLuL-n3GwjW1_yhQhrqDacyvaXkuf8HcJl8EtXYjGjMaW5oiM5cgAaIorrqgYlp4DPF_GuncFqg9uDZrx7pMmCZ_yHfxhSCXru3gbXrZvAIicNQZMFxrEEn4REVuq7DjkTMyCMGCY1dpMa8aWfTQFt3Eh7smLchaZsU
' https://oauth2.googleapis.com/token

Xử lý phản hồi

Nếu yêu cầu mã thông báo truy cập và JWT được định dạng đúng và tài khoản dịch vụ có quyền thực hiện thao tác, thì phản hồi JSON qua Máy chủ ủy quyền sẽ bao gồm mã thông báo truy cập. Sau đây là ví dụ về phản hồi:

{
  "access_token": "1/8xbJqaOZXSUZbHLl5EOtu1pxz3fmmetKx9W8CV4t79M",
  "scope": "https://www.googleapis.com/auth/prediction"
  "token_type": "Bearer",
  "expires_in": 3600
}

Bạn có thể sử dụng lại mã truy cập trong khoảng thời gian mà giá trị expires_in chỉ định.

Gọi API Google

Java

Sử dụng đối tượng GoogleCredential để gọi API Google bằng cách hoàn thành các bước sau:

  1. Tạo đối tượng dịch vụ cho API mà bạn muốn gọi bằng đối tượng GoogleCredential. Ví dụ:
    SQLAdmin sqladmin =
        new SQLAdmin.Builder(httpTransport, JSON_FACTORY, credential).build();
  2. Gửi yêu cầu đến dịch vụ API bằng giao diện do đối tượng dịch vụ cung cấp. Ví dụ: để liệt kê các thực thể của cơ sở dữ liệu Cloud SQL trong dự án fun-example-123:
    SQLAdmin.Instances.List instances =
        sqladmin.instances().list("exciting-example-123").execute();

Python

Sử dụng đối tượng Credentials được phép để gọi các API của Google bằng cách hoàn thành các bước sau:

  1. Tạo một đối tượng dịch vụ cho API mà bạn muốn gọi. Bạn tạo một đối tượng dịch vụ bằng cách gọi hàm build có tên, phiên bản API và đối tượng Credentials được phép. Ví dụ: để gọi phiên bản 1beta3 của API quản trị Cloud SQL:
    import googleapiclient.discovery
    
    sqladmin = googleapiclient.discovery.build('sqladmin', 'v1beta3', credentials=credentials)
  2. Gửi yêu cầu đến dịch vụ API bằng giao diện do đối tượng dịch vụ cung cấp. Ví dụ: để liệt kê các thực thể của cơ sở dữ liệu Cloud SQL trong dự án fun-example-123:
    response = sqladmin.instances().list(project='exciting-example-123').execute()

HTTP/REST

Sau khi ứng dụng của bạn nhận được mã thông báo truy cập, bạn có thể sử dụng mã thông báo đó để thay mặt cho một tài khoản dịch vụ hoặc tài khoản người dùng nhất định gọi API tới Google nếu(các) phạm vi quyền truy cập mà API yêu cầu đã được cấp. Để thực hiện việc này, hãy đưa mã truy cập vào yêu cầu tới API bằng cách thêm tham số truy vấn access_token hoặc giá trị Bearer tiêu đề HTTP Authorization. Khi có thể, bạn nên dùng tiêu đề HTTP vì các chuỗi truy vấn này thường xuất hiện trong nhật ký máy chủ. Trong hầu hết các trường hợp, bạn có thể sử dụng thư viện ứng dụng để thiết lập lệnh gọi đến các API của Google (ví dụ: khi gọi API Drive Drive).

Bạn có thể dùng thử tất cả API của Google và xem phạm vi của các API đó tại OAuth 2.0 Playground.

Ví dụ về GET GET HTTP

Lệnh gọi đến điểm cuối drive.files (API Drive Drive) bằng tiêu đề HTTP Authorization: Bearer có thể có dạng như sau. Xin lưu ý rằng bạn cần chỉ định mã thông báo truy cập của riêng mình:

GET /drive/v2/files HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

Sau đây là một lệnh gọi đến cùng một API cho người dùng đã xác thực bằng cách sử dụng tham số chuỗi truy vấn access_token:

GET https://www.googleapis.com/drive/v2/files?access_token=access_token

Ví dụ về curl

Bạn có thể kiểm thử các lệnh này bằng ứng dụng dòng lệnh curl. Sau đây là một ví dụ về tuỳ chọn tiêu đề HTTP (ưu tiên):

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files

Hoặc tùy chọn tham số chuỗi truy vấn:

curl https://www.googleapis.com/drive/v2/files?access_token=access_token

Khi mã thông báo truy cập hết hạn

Mã thông báo truy cập do Máy chủ ủy quyền Google OAuth 2.0 cấp sẽ hết hạn sau thời hạn mà giá trị expires_in cung cấp. Khi mã truy cập hết hạn, ứng dụng sẽ tạo một JWT khác, ký mã đó và yêu cầu một mã truy cập khác.

Mã lỗi JWT

Trường error Trường error_description Ý nghĩa Cách giải quyết
unauthorized_client Unauthorized client or scope in request. Nếu bạn cố gắng sử dụng tính năng ủy quyền trên toàn miền, thì tài khoản dịch vụ không được ủy quyền trong Bảng điều khiển dành cho quản trị viên của miền của người dùng.

Đảm bảo rằng tài khoản dịch vụ được cấp phép trong trang Ủy quyền trên toàn miền trên Bảng điều khiển dành cho quản trị viên cho người dùng trong thông báo xác nhận quyền sở hữu (trường) sub.

Mặc dù thường mất vài phút, nhưng có thể mất tối đa 24 giờ để việc ủy quyền có hiệu lực với tất cả người dùng trong Tài khoản Google của bạn.

unauthorized_client Client is unauthorized to retrieve access tokens using this method, or client not authorized for any of the scopes requested. Tài khoản dịch vụ được ủy quyền bằng địa chỉ email của khách hàng chứ không phải mã khách hàng (bằng số) trong Bảng điều khiển dành cho quản trị viên. Trên trang Uỷ quyền trên toàn miền trong Bảng điều khiển dành cho quản trị viên, hãy xoá máy khách rồi thêm lại bằng mã nhận dạng dạng số.
access_denied (giá trị bất kỳ) Nếu bạn đang dùng chế độ ủy quyền trên toàn miền, thì một hoặc nhiều phạm vi mà bạn yêu cầu sẽ không được ủy quyền trong Bảng điều khiển dành cho quản trị viên.

Đảm bảo rằng tài khoản dịch vụ được ủy quyền trong trang Ủy quyền trên toàn miền trên Bảng điều khiển dành cho quản trị viên cho người dùng trong thông báo xác nhận quyền sở hữu (sub) và trong đó có tất cả phạm vi mà bạn đang yêu cầu trong thông báo xác nhận quyền sở hữu scope trong JWT.

Mặc dù thường mất vài phút, nhưng có thể mất tối đa 24 giờ để việc ủy quyền có hiệu lực với tất cả người dùng trong Tài khoản Google của bạn.

invalid_grant Not a valid email. Người dùng không tồn tại. Kiểm tra để đảm bảo địa chỉ email trong thông báo xác nhận quyền sở hữu (trường) sub là chính xác.
invalid_grant

Invalid JWT: Token must be a short-lived token (60 minutes) and in a reasonable timeframe. Check your 'iat' and 'exp' values and use a clock with skew to account for clock differences between systems.

Thông thường, điều này có nghĩa là giờ hệ thống địa phương không chính xác. Điều này cũng có thể xảy ra nếu giá trị exp cách thời điểm hiện tại hơn 65 phút so với giá trị iat hoặc giá trị exp thấp hơn giá trị iat.

Đảm bảo rằng đồng hồ trên hệ thống nơi JWT được tạo là chính xác. Nếu cần, hãy đồng bộ hoá thời gian của bạn với Google NTP.

invalid_grant Invalid JWT Signature.

Xác nhận JWT được ký bằng một khoá riêng tư không liên kết với tài khoản dịch vụ được xác định trong email của khách hàng hoặc khoá được sử dụng đã bị xoá, vô hiệu hoá hoặc đã hết hạn.

Ngoài ra, câu nhận định JWT có thể được mã hoá không chính xác – phải được mã hoá bằng Base64, không có dòng mới hoặc dấu bằng bằng khoảng đệm.

Giải mã bộ xác nhận quyền sở hữu JWT và xác minh khoá đã ký xác nhận được liên kết với tài khoản dịch vụ.

Hãy thử sử dụng thư viện OAuth do Google cung cấp để đảm bảo JWT được tạo chính xác.

invalid_scope Invalid OAuth scope or ID token audience provided. Không có phạm vi được yêu cầu (danh sách phạm vi trống) hoặc một trong các phạm vi được yêu cầu không tồn tại (tức là không hợp lệ).

Đảm bảo rằng thông báo xác nhận quyền sở hữu (trường) của JWT được điền sẵn và so sánh các phạm vi của thông báo đó với phạm vi được ghi nhận trong các API mà bạn muốn sử dụng để đảm bảo không có lỗi hoặc lỗi đánh máy.

Lưu ý rằng danh sách phạm vi trong thông báo xác nhận quyền sở hữu scope cần được phân tách bằng dấu cách, chứ không phải dấu phẩy.

disabled_client The OAuth client was disabled. Khoá dùng để ký xác nhận JWT bị tắt.

Truy cập Google API Console, và trong IAM & Admin & gt; Tài khoản dịch vụ, hãy bật tài khoản dịch vụ có chứa "Key ID" đã dùng để ký xác nhận.

Phụ lục: Ủy quyền tài khoản dịch vụ không có OAuth

Đối với một số API của Google, bạn có thể thực hiện các lệnh gọi API được cấp phép bằng cách sử dụng JWT đã ký trực tiếp dưới dạng mã thông báo mang, thay vì mã truy cập OAuth 2.0. Khi có thể, bạn có thể tránh phải gửi yêu cầu kết nối mạng đến máy chủ uỷ quyền của Google trước khi thực hiện lệnh gọi API.

Nếu API bạn muốn gọi có định nghĩa dịch vụ được xuất bản trong kho lưu trữ GitHub của API Google, bạn có thể thực hiện các lệnh gọi API được ủy quyền bằng cách sử dụng JWT thay vì mã truy cập. Cách làm như sau:

  1. Tạo tài khoản dịch vụ như mô tả ở trên. Hãy nhớ giữ lại tệp JSON mà bạn nhận được khi tạo tài khoản.
  2. Sử dụng bất kỳ thư viện JWT chuẩn nào, chẳng hạn như thư viện có tại jwt.io, tạo JWT có tiêu đề và trọng tải như ví dụ sau:
    {
      "alg": "RS256",
      "typ": "JWT",
      "kid": "abcdef1234567890"
    }
    .
    {
      "iss": "123456-compute@developer.gserviceaccount.com",
      "sub": "123456-compute@developer.gserviceaccount.com",
      "aud": "https://firestore.googleapis.com/",
      "iat": 1511900000,
      "exp": 1511903600
    }
    • Đối với trường kid trong tiêu đề, hãy chỉ định mã khoá riêng tư cho tài khoản dịch vụ của bạn. Bạn có thể tìm thấy giá trị này trong trường private_key_id của tệp JSON trong tài khoản dịch vụ.
    • Đối với các trường isssub, hãy chỉ định địa chỉ email của tài khoản dịch vụ của bạn. Bạn có thể tìm thấy giá trị này trong trường client_email của tệp JSON trong tài khoản dịch vụ.
    • Đối với trường aud, hãy chỉ định điểm cuối API. Ví dụ: https://SERVICE.googleapis.com/.
    • Đối với trường iat, hãy chỉ định thời gian Unix hiện tại. Đối với trường exp, hãy chỉ định thời gian chính xác 3600 giây sau đó, khi JWT sẽ hết hạn.

Ký JWT bằng RSA-256 bằng cách sử dụng khoá riêng tư có trong tệp JSON của tài khoản dịch vụ.

Ví dụ:

Java

Sử dụng google-api-java-clientjava-jwt:

GoogleCredential credential =
        GoogleCredential.fromStream(new FileInputStream("MyProject-1234.json"));
PrivateKey privateKey = credential.getServiceAccountPrivateKey();
String privateKeyId = credential.getServiceAccountPrivateKeyId();

long now = System.currentTimeMillis();

try {
    Algorithm algorithm = Algorithm.RSA256(null, privateKey);
    String signedJwt = JWT.create()
        .withKeyId(privateKeyId)
        .withIssuer("123456-compute@developer.gserviceaccount.com")
        .withSubject("123456-compute@developer.gserviceaccount.com")
        .withAudience("https://firestore.googleapis.com/")
        .withIssuedAt(new Date(now))
        .withExpiresAt(new Date(now + 3600 * 1000L))
        .sign(algorithm);
} catch ...

Python

Sử dụng PyJWT:

iat = time.time()
exp = iat + 3600
payload = {'iss': '123456-compute@developer.gserviceaccount.com',
           'sub': '123456-compute@developer.gserviceaccount.com',
           'aud': 'https://firestore.googleapis.com/',
           'iat': iat,
           'exp': exp}
additional_headers = {'kid': PRIVATE_KEY_ID_FROM_JSON}
signed_jwt = jwt.encode(payload, PRIVATE_KEY_FROM_JSON, headers=additional_headers,
                       algorithm='RS256')
  1. Gọi API này bằng cách sử dụng mã WWT đã ký làm mã thông báo truy cập:
    GET /v1/projects/abc/databases/123/indexes HTTP/1.1
    Authorization: Bearer SIGNED_JWT
    Host: firestore.googleapis.com