Gmail S/MIME API cung cấp quyền truy cập theo chương trình để quản lý chứng chỉ email S/MIME cho người dùng trong một miền Google Workspace .
Quản trị viên phải bật S/MIME cho miền thì các chứng chỉ mới hoạt động.
Tiêu chuẩn S/MIME cung cấp một quy cách để mã hoá khoá công khai và ký dữ liệu MIME. Việc định cấu hình chứng chỉ S/MIME trong tài khoản của người dùng khiến Gmail sử dụng chứng chỉ đó theo những cách sau:
- Gmail sử dụng chứng chỉ và khoá riêng tư của người dùng để ký thư gửi đi.
- Gmail sử dụng khoá riêng tư của người dùng để giải mã thư đến.
- Gmail sử dụng chứng chỉ và khoá công khai của người nhận để mã hoá thư gửi đi.
- Gmail sử dụng chứng chỉ và khoá công khai của người gửi để xác minh thư đến.
Bạn tạo từng chứng chỉ S/MIME và tải chúng lên bằng API. Mỗi chứng chỉ S/MIME dành cho một email đại diện cụ thể của tài khoản email người dùng. Bí danh bao gồm địa chỉ email chính cũng như địa chỉ "Gửi dưới tên" tuỳ chỉnh. Một chứng chỉ S/MIME duy nhất được đánh dấu là chứng chỉ mặc định cho mỗi bí danh.
Cấp quyền truy cập API
Có 2 hình thức cho phép truy cập vào API:
- Bạn có thể sử dụng tài khoản dịch vụ với tính năng uỷ quyền trên toàn miền. Để biết nội dung giải thích về các thuật ngữ này, hãy tham khảo bài viết Các thuật ngữ tổng quan về hoạt động xác thực và uỷ quyền. Để biết thông tin về cách bật lựa chọn này, hãy tham khảo bài viết Tạo tài khoản dịch vụ có quyền uỷ quyền trên toàn miền
- Bạn có thể sử dụng một quy trình OAuth2 tiêu chuẩn yêu cầu sự đồng ý của người dùng cuối để lấy mã truy cập Oauth2. Để biết thêm thông tin, hãy tham khảo phần Tổng quan về hoạt động xác thực và uỷ quyền. Để sử dụng lựa chọn này, quản trị viên miền phải đánh dấu vào hộp "Đã bật quyền truy cập của người dùng cuối vào API S/MIME" trong bảng điều khiển Miền.
Phạm vi ACL
API này dựa vào cùng các phạm vi ACL như các phương thức Gmail sendAs:
- gmail.settings.basic
- Phạm vi này là bắt buộc để cập nhật S/MIME SendAs chính.
- gmail.settings.sharing
- Phạm vi này là bắt buộc để cập nhật từ S/MIME tuỳ chỉnh.
Sử dụng API
Tài nguyên users.settings.sendAs.smimeInfo cung cấp các phương thức mà bạn dùng để quản lý chứng chỉ S/MIME. Mỗi chứng chỉ được liên kết với một bí danh gửi dưới tên của người dùng.
Tải khoá S/MIME lên
Sử dụng phương thức smimeInfo.insert() để tải khoá S/MIME mới lên cho một biệt hiệu thuộc về người dùng. Bạn xác định bí danh mục tiêu bằng các tham số sau:
- userId
- Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt
me
để cho biết người dùng hiện đã xác thực. - sendAsEmail
- Bí danh mà bạn đang tải khoá lên. Đây là địa chỉ email xuất hiện trong tiêu đề "Từ:" của thư được gửi bằng email đại diện này.
Chứng chỉ S/MIME và khoá riêng tư phải có trong trường pkcs12
ở định dạng đó; không được đặt các trường khác trong yêu cầu. Trường PKCS12 dự kiến sẽ chứa cả khoá S/MIME của người dùng và chuỗi chứng chỉ ký. API thực hiện các bước xác thực tiêu chuẩn trên trường này trước khi chấp nhận, xác minh những điều sau:
- Tiêu đề khớp với địa chỉ email đã chỉ định.
- Ngày hết hạn là hợp lệ.
- Tổ chức phát hành chứng chỉ (CA) nằm trong danh sách đáng tin cậy của chúng tôi.
- Các chứng chỉ này đáp ứng các hạn chế kỹ thuật của Gmail.
Nếu khoá được mã hoá thì mật khẩu phải nằm trong trường encryptedKeyPassword
. Các lệnh gọi insert() thành công sẽ trả về mã nhận dạng của smimeInfo. Bạn có thể dùng mã nhận dạng này để tham chiếu đến khoá trong tương lai.
Liệt kê các khoá S/MIME của người dùng
Sử dụng phương thức smimeInfo.list() để trả về danh sách khoá S/MIME cho người dùng đã cho đối với bí danh đã cho. Bạn xác định bí danh mục tiêu bằng các tham số sau:
- userId
- Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt
me
để cho biết người dùng hiện đã xác thực. - sendAsEmail
- Bí danh để liệt kê các khoá. Đây là địa chỉ email xuất hiện trong tiêu đề "Từ:" của thư được gửi bằng email đại diện này.
Truy xuất khoá S/MIME cho một biệt hiệu
Sử dụng phương thức smimeInfo.get() để trả về các khoá S/MIME cụ thể cho một bí danh gửi dưới tên của người dùng. Bạn xác định bí danh mục tiêu bằng các tham số sau:
- userId
- Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt
me
để cho biết người dùng hiện đã xác thực. - sendAsEmail
- Bí danh mà bạn đang truy xuất khoá. Đây là địa chỉ email xuất hiện trong tiêu đề "Từ:" của thư được gửi bằng email đại diện này.
Xoá khoá S/MIME
Sử dụng phương thức smimeInfo.delete() để xoá khoá S/MIME đã chỉ định khỏi một biệt hiệu. Bạn xác định bí danh mục tiêu bằng các tham số sau:
- userId
- Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt
me
để cho biết người dùng hiện đã xác thực. - sendAsEmail
- Bí danh mà bạn đang truy xuất khoá. Đây là địa chỉ email xuất hiện trong tiêu đề "Người gửi:" của thư được gửi bằng email đại diện này.
- id
- Mã nhận dạng không thể thay đổi cho SmimeInfo.
Đặt khoá S/MIME mặc định cho một bí danh
Sử dụng phương thức smimeInfo.setDefault() để đánh dấu khoá S/MIME đã chỉ định làm khoá mặc định cho bí danh đã chỉ định. Bạn xác định bí danh mục tiêu bằng các tham số sau:
- userId
- Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt
me
để cho biết người dùng hiện đã xác thực. - sendAsEmail
- Bí danh mà bạn đang truy xuất khoá. Đây là địa chỉ email xuất hiện trong tiêu đề "Người gửi:" của thư được gửi bằng email đại diện này.
- id
- Mã nhận dạng không thể thay đổi cho SmimeInfo.
Mã mẫu
Các mẫu mã sau đây minh hoạ cách sử dụng API để quản lý chứng chỉ S/MIME cho một tổ chức có nhiều người dùng.
Tạo tài nguyên SmimeInfo cho chứng chỉ S/MIME
Mẫu mã sau đây minh hoạ cách đọc chứng chỉ từ tệp, mã hoá thành chuỗi base64url và chỉ định chuỗi đó cho trường pkcs12
của tài nguyên smimeInfo
:
Java
Python
Tải chứng chỉ S/MIME lên
Để tải một chứng chỉ lên, hãy gọi smimeInfo.insert
và cung cấp tài nguyên smimeInfo
trong nội dung yêu cầu:
Java
Python
Ví dụ về cách quản lý chứng chỉ của nhiều người dùng
Bạn có thể muốn quản lý chứng chỉ cho nhiều người dùng trong tổ chức cùng một lúc. Các ví dụ sau đây cho thấy cách quản lý chứng chỉ cho nhiều người dùng trong một lệnh gọi hàng loạt.
Chèn chứng chỉ từ tệp CSV
Giả sử bạn có một tệp CSV liệt kê mã nhận dạng người dùng và đường dẫn đến chứng chỉ của từng người dùng:
$ cat certificates.csv
user1@example.com,/path/to/user1_cert.p12,cert_password_1
user2@example.com,/path/to/user2_cert.p12,cert_password_2
user3@example.com,/path/to/user3_cert.p12,cert_password_3
Java
Bạn có thể sử dụng các lệnh gọi createSmimeInfo
và insertSmimeInfo
từ trước để tải các chứng chỉ lên như được chỉ định trong tệp CSV:
Python
Bạn có thể sử dụng các lệnh gọi create_smime_info
và insert_smime_info
từ trước để tải các chứng chỉ lên như được chỉ định trong tệp CSV:
Quản lý chứng chỉ
Ví dụ này kết hợp một số lệnh gọi từ API smimeInfo
để cho biết cách bạn có thể quản lý chứng chỉ cho tổ chức của mình. Thao tác này liệt kê các chứng chỉ cho người dùng và nếu chứng chỉ mặc định đã hết hạn hoặc chưa được đặt, thì thao tác này sẽ tải chứng chỉ có trong tệp được chỉ định lên. Sau đó, nó sẽ đặt chứng chỉ có thời gian hết hạn xa nhất trong tương lai làm chứng chỉ mặc định.
Sau đó, hàm này được gọi từ một hàm xử lý tệp CSV như trong ví dụ trước.