Quản lý chứng chỉ S/MIME bằng Gmail API

Tài liệu này giải thích cách sử dụng chứng chỉ email S/MIME trong Gmail API.

Gmail 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 được lưu trữ 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 cho việc mã hoá khoá công khai và ký dữ liệu MIME. Khi bạn định cấu hình chứng chỉ S/MIME trong tài khoản người dùng, Gmail sẽ sử dụng các chứng chỉ đó theo những cách sau:

• Ký thư gửi đi bằng chứng chỉ người dùng và khoá riêng tư.

• Giải mã thư đến bằng khoá riêng tư của người dùng.

• Mã hoá thư gửi đi bằng chứng chỉ và khoá công khai của người nhận.

• Xác minh thư đến bằng chứng chỉ và khoá công khai của người gửi.

Bạn có thể tạo từng chứng chỉ S/MIME và tải chúng lên bằng API Gmail. Mỗi chứng chỉ S/MIME là dành cho một bí danh cụ thể của tài khoản email người dùng. Bí danh bao gồm địa chỉ email chính và địa chỉ "Gửi dưới tên" tuỳ chỉnh. API này đánh dấu một chứng chỉ S/MIME duy nhất là chứng chỉ mặc định cho mỗi bí danh.

Để biết thêm thông tin về biệt hiệu, hãy xem bài viết Quản lý biệt hiệu và chữ ký bằng Gmail API.

Cấp quyền truy cập API

Để uỷ quyền truy cập vào Gmail API, hãy sử dụng một trong các phương thức sau:

1. Sử dụng tài khoản dịch vụ có quyền uỷ quyền trên toàn miền. Để biết giải thích về các thuật ngữ này, hãy xem phần Tìm hiểu về quy trình xác thực và uỷ quyền. Để bật lựa chọn này, hãy xem phần Tạo thông tin đăng nhập để truy cập.

2. Sử dụng quy trình OAuth 2.0 tiêu chuẩn yêu cầu sự đồng ý của người dùng cuối để lấy mã truy cập OAuth 2.0. Để biết thêm thông tin, hãy xem phần Tìm hiểu về quy trình 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 chọn hộp đánh dấu Bật mã hoá S/MIME để gửi và nhận email trong Bảng điều khiển dành cho quản trị viên của Google. Để biết thêm thông tin, hãy xem bài viết Bật S/MIME được lưu trữ trong Bảng điều khiển dành cho quản trị viên của Google.

Phạm vi ACL

Gmail API 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 S/MIME from tuỳ chỉnh.

Định cấu hình khoá S/MIME

Tài nguyên settings.sendAs.smimeInfo cung cấp một số phương thức để 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.

Để xác định các bí danh gửi dưới tên của người dùng, hãy sử dụng phương thức settings.sendAs.list trên tài nguyên settings.sendAs.

Tải khoá S/MIME lên

Sử dụng phương thức settings.sendAs.smimeInfo.insert trên tài nguyên settings.sendAs.smimeInfo để tải khoá S/MIME mới lên cho một email đại diện thuộc về người dùng. Xác định bí danh mục tiêu bằng các tham số đường dẫn sau:

• userId: Địa chỉ email của người dùng. Sử dụng giá trị đặc biệt me để cho biết người dùng đã xác thực.

• sendAsEmail: Bí danh mà bạn đang tải khoá lên. Địa chỉ email này xuất hiện trong tiêu đề From: của thư được gửi bằng bí danh 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 bất kỳ trường nào khác trong yêu cầu. Trường pkcs12 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 Google.
• 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á, mật khẩu phải nằm trong trường encryptedKeyPassword. Lệnh gọi phương thức settings.sendAs.smimeInfo.insert thành công sẽ trả về tài nguyên settings.sendAs.smimeInfo id được dùng để 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 settings.sendAs.smimeInfo.list trên tài nguyên settings.sendAs.smimeInfo để trả về danh sách khoá S/MIME cho người dùng đã cho đối với email đại diện đã cho. Xác định bí danh mục tiêu bằng các tham số đường dẫn sau:

• userId: Địa chỉ email của người dùng. Sử dụng giá trị đặc biệt me để cho biết người dùng đã xác thực.

• sendAsEmail: Bí danh để liệt kê các khoá. Địa chỉ email này xuất hiện trong tiêu đề From: của thư được gửi bằng email đại diện này.

Khoá chỉ được trả về ở định dạng PEM và chỉ chứa chứng chỉ S/MIME, chứ không chứa khoá riêng tư.

Truy xuất khoá S/MIME cho một biệt hiệu

Sử dụng phương thức settings.sendAs.smimeInfo.get trên tài nguyên settings.sendAs.smimeInfo để trả về các khoá S/MIME cụ thể cho một email đại diện gửi dưới tên riêng cụ thể của người dùng. Xác định bí danh mục tiêu bằng các tham số đường dẫn sau:

• userId: Địa chỉ email của người dùng. Sử dụng giá trị đặc biệt me để cho biết người dùng đã xác thực.

• sendAsEmail: Bí danh mà bạn đang truy xuất các khoá. Địa chỉ email này xuất hiện trong tiêu đề From: của thư được gửi bằng bí danh này.

Khoá chỉ được trả về ở định dạng PEM và chỉ chứa chứng chỉ S/MIME, chứ không chứa khoá riêng tư.

Xoá khoá S/MIME

Sử dụng phương thức settings.sendAs.smimeInfo.delete trên tài nguyên settings.sendAs.smimeInfo để xoá khoá S/MIME đã chỉ định khỏi một biệt hiệu. Xác định bí danh mục tiêu bằng các tham số đường dẫn sau:

• userId: Địa chỉ email của người dùng. Sử dụng giá trị đặc biệt me để cho biết người dùng đã xác thực.

• sendAsEmail: Email đại diện mà bạn đang xoá các khoá. Địa chỉ email này xuất hiện trong tiêu đề From: của thư được gửi bằng bí danh này.

• id: Mã nhận dạng không thay đổi cho smimeInfo.

Khoá đã bị xoá sẽ không còn xuất hiện hoặc sử dụng được nữa. Bạn không thể giải mã những email S/MIME nhận được được mã hoá bằng khoá công khai tương ứng. Trước khi xoá một khoá, hãy thu hồi khoá đó bằng cơ quan cấp (CA).

Đặt khoá S/MIME mặc định cho một bí danh

Sử dụng phương thức settings.sendAs.smimeInfo.setDefault trên tài nguyên settings.sendAs.smimeInfo để đánh dấu khoá S/MIME đã chỉ định làm khoá mặc định cho email đại diện đã chỉ định. Xác định bí danh mục tiêu bằng các tham số đường dẫn sau:

• userId: Địa chỉ email của người dùng. Sử dụng giá trị đặc biệt me để cho biết người dùng đã xác thực.

• sendAsEmail: Bí danh mà bạn muốn đặt khoá làm mặc định. Địa chỉ email này xuất hiện trong tiêu đề From: của thư được gửi bằng bí danh này.

• id: Mã nhận dạng không thay đổi cho smimeInfo.

Theo mặc định, mỗi người dùng chỉ có một khoá S/MIME cho `SendAs`. Việc gọi phương thức settings.sendAs.smimeInfo.setDefault sẽ huỷ chế độ mặc định trước đó.

Khi nhận được thư S/MIME được ký bằng một khoá nhất định, Gmail sẽ liên kết khoá đó với not_before ngày hết hạn xa nhất trong tương lai làm ngày mặc định khi mã hoá thư gửi đến người dùng được liên kết. Để đảm bảo rằng khoá mặc định mới được những người dùng Gmail mà người dùng đã liên lạc sử dụng, hãy đảm bảo rằng khoá mặc định mới có ngày not_before muộn hơn khoá mặc định trước đó hoặc thu hồi khoá mặc định trước đó.

Mã mẫu

Các mã mẫu sau đây cho biết cách sử dụng API Gmail để 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ã này cho biết cách đọc một chứng chỉ từ một tệp, mã hoá chứng chỉ đó thành một chuỗi Base64URL và chỉ định chứng chỉ đó cho trường pkcs12 trên tài nguyên settings.sendAs.smimeInfo:

Java

gmail/snippets/src/main/java/CreateSmimeInfo.java

Xem trên GitHub

import com.google.api.services.gmail.model.SmimeInfo;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Base64;

/* Class to demonstrate the use of Gmail Create SmimeInfo API */
public class CreateSmimeInfo {
  /**
   * Create an SmimeInfo resource for a certificate from file.
   *
   * @param filename Name of the file containing the S/MIME certificate.
   * @param password Password for the certificate file, or null if the file is not
   *                 password-protected.
   * @return An SmimeInfo object with the specified certificate.
   */
  public static SmimeInfo createSmimeInfo(String filename, String password) {
    SmimeInfo smimeInfo = null;
    InputStream in = null;

    try {
      File file = new File(filename);
      in = new FileInputStream(file);
      byte[] fileContent = new byte[(int) file.length()];
      in.read(fileContent);

      smimeInfo = new SmimeInfo();
      smimeInfo.setPkcs12(Base64.getUrlEncoder().encodeToString(fileContent));
      if (password != null && password.length() > 0) {
        smimeInfo.setEncryptedKeyPassword(password);
      }
    } catch (Exception e) {
      System.out.printf("An error occured while reading the certificate file: %s\n", e);
    } finally {
      try {
        if (in != null) {
          in.close();
        }
      } catch (IOException ioe) {
        System.out.printf("An error occured while closing the input stream: %s\n", ioe);
      }
    }
    return smimeInfo;
  }
}

Python

gmail/snippet/smime snippets/create_smime_info.py

Xem trên GitHub

import base64


def create_smime_info(cert_filename, cert_password):
  """Create an smimeInfo resource for a certificate from file.
  Args:
    cert_filename: Name of the file containing the S/MIME certificate.
    cert_password: Password for the certificate file, or None if the file is not
        password-protected.
  Returns : Smime object, including smime information
  """

  smime_info = None
  try:
    with open(cert_filename, "rb") as cert:
      smime_info = {}
      data = cert.read().encode("UTF-8")
      smime_info["pkcs12"] = base64.urlsafe_b64encode(data).decode()
      if cert_password and len(cert_password) > 0:
        smime_info["encryptedKeyPassword"] = cert_password

  except (OSError, IOError) as error:
    print(f"An error occurred while reading the certificate file: {error}")
    smime_info = None

  return smime_info


if __name__ == "__main__":
  print(create_smime_info(cert_filename="xyz", cert_password="xyz"))

Tải chứng chỉ S/MIME lên

Để tải một chứng chỉ lên, hãy gọi phương thức settings.sendAs.smimeInfo.insert và cung cấp tài nguyên settings.sendAs.smimeInfo trong nội dung yêu cầu:

Java

gmail/snippets/src/main/java/InsertSmimeInfo.java

Xem trên GitHub

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.SmimeInfo;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;

/* Class to demonstrate the use of Gmail Insert Smime Certificate API*/
public class InsertSmimeInfo {
  /**
   * Upload an S/MIME certificate for the user.
   *
   * @param userId      User's email address.
   * @param sendAsEmail The "send as" email address, or null if it should be the same as userId.
   * @param smimeInfo   The SmimeInfo object containing the user's S/MIME certificate.
   * @return An SmimeInfo object with details about the uploaded certificate, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static SmimeInfo insertSmimeInfo(String userId,
                                          String sendAsEmail,
                                          SmimeInfo smimeInfo)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_SHARING);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    if (sendAsEmail == null) {
      sendAsEmail = userId;
    }

    try {
      SmimeInfo results = service.users().settings().sendAs().smimeInfo()
          .insert(userId, sendAsEmail, smimeInfo)
          .execute();
      System.out.printf("Inserted certificate, id: %s\n", results.getId());
      return results;
    } catch (IOException e) {
      System.err.printf("An error occured: %s", e);
    }
    return null;
  }
}

Python

gmail/snippet/smime snippets/insert_smime_info.py

Xem trên GitHub

import create_smime_info
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def insert_smime_info():
  """Upload an S/MIME certificate for the user.
  Print the inserted certificate's id
  Returns : Result object with inserted certificate id and other meta-data

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    user_id = "[e-mail]"
    smime_info = create_smime_info.create_smime_info(
        cert_filename="xyz", cert_password="xyz"
    )
    send_as_email = None

    if not send_as_email:
      send_as_email = user_id

    # pylint: disable=maybe-no-member
    results = (
        service.users()
        .settings()
        .sendAs()
        .smimeInfo()
        .insert(userId=user_id, sendAsEmail=send_as_email, body=smime_info)
        .execute()
    )
    print(f'Inserted certificate; id: {results["id"]}')

  except HttpError as error:
    print(f"An error occurred: {error}")
    results = None

  return results


if __name__ == "__main__":
  insert_smime_info()

Quản lý chứng chỉ của nhiều người dùng

Các mẫu mã này cho thấy cách quản lý chứng chỉ cho nhiều người dùng trong một tổ chức trong một lệnh gọi hàng loạt:

Chèn chứng chỉ từ tệp CSV

Sau đây là một tệp CSV mẫu 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
[e-mail],/path/to/user1_cert.p12,cert_password_1
[e-mail],/path/to/user2_cert.p12,cert_password_2
[e-mail],/path/to/user3_cert.p12,cert_password_3

Java

Bạn có thể sử dụng các mẫu CreateSmimeInfo và InsertSmimeInfo để tải chứng chỉ lên cho những người dùng được chỉ định trong tệp CSV:

gmail/snippets/src/main/java/InsertCertFromCsv.java

Xem trên GitHub

import com.google.api.services.gmail.model.SmimeInfo;
import java.io.File;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVParser;
import org.apache.commons.csv.CSVRecord;

/* Class to demonstrate the use of Gmail Insert Certificate from CSV File */
public class InsertCertFromCsv {
  /**
   * Upload S/MIME certificates based on the contents of a CSV file.
   *
   * <p>Each row of the CSV file should contain a user ID, path to the certificate, and the
   * certificate password.
   *
   * @param csvFilename Name of the CSV file.
   */
  public static void insertCertFromCsv(String csvFilename) {
    try {
      File csvFile = new File(csvFilename);
      CSVParser parser =
          CSVParser.parse(csvFile, java.nio.charset.StandardCharsets.UTF_8, CSVFormat.DEFAULT);
      for (CSVRecord record : parser) {
        String userId = record.get(0);
        String certFilename = record.get(1);
        String certPassword = record.get(2);
        SmimeInfo smimeInfo = CreateSmimeInfo.createSmimeInfo(certFilename,
            certPassword);
        if (smimeInfo != null) {
          InsertSmimeInfo.insertSmimeInfo(userId,
              userId,
              smimeInfo);
        } else {
          System.err.printf("Unable to read certificate file for userId: %s\n", userId);
        }
      }
    } catch (Exception e) {
      System.err.printf("An error occured while reading the CSV file: %s", e);
    }
  }
}

Python

Bạn có thể sử dụng các mẫu create_smime_info và insert_smime_info để tải chứng chỉ lên cho người dùng được chỉ định trong tệp CSV:

gmail/snippet/smime snippets/insert_cert_from_csv.py

Xem trên GitHub

import csv

import create_smime_info
import insert_smime_info


def insert_cert_from_csv(csv_filename):
  """Upload S/MIME certificates based on the contents of a CSV file.
  Each row of the CSV file should contain a user ID, path to the certificate,
  and the certificate password.

  Args:
    csv_filename: Name of the CSV file.
  """

  try:
    with open(csv_filename, "rb") as cert:
      csv_reader = csv.reader(cert, delimiter=",")
      next(csv_reader, None)  # skip CSV file header
      for row in csv_reader:
        user_id = row[0]
        cert_filename = row[1]
        cert_password = row[2]
        smime_info = create_smime_info.create_smime_info(
            cert_filename=cert_filename, cert_password=cert_password
        )
        if smime_info:
          insert_smime_info.insert_smime_info()
        else:
          print(f"Unable to read certificate file for user_id: {user_id}")
        return smime_info

  except (OSError, IOError) as error:
    print(f"An error occured while reading the CSV file: {error}")


if __name__ == "__main__":
  insert_cert_from_csv(csv_filename="xyz")

Quản lý chứng chỉ

Mẫu này kết hợp một số phương thức từ tài nguyên settings.sendAs.smimeInfo để cho biết cách quản lý chứng chỉ cho tổ chức của bạn. URL này liệt kê các chứng chỉ của người dùng. Nếu chứng chỉ mặc định đã hết hạn hoặc chưa được đặt, thì chứng chỉ 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 hạn xa nhất trong tương lai làm chứng chỉ mặc định.

Sau đó, hàm này sẽ xử lý một tệp CSV, tương tự như mẫu Chèn chứng chỉ từ tệp CSV trước đó.

Java

gmail/snippets/src/main/java/UpdateSmimeCerts.java

Xem trên GitHub

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.ListSmimeInfoResponse;
import com.google.api.services.gmail.model.SmimeInfo;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;

/* Class to demonstrate the use of Gmail Update Smime Certificate API*/
public class UpdateSmimeCerts {
  /**
   * Update S/MIME certificates for the user.
   *
   * <p>First performs a lookup of all certificates for a user. If there are no certificates, or
   * they all expire before the specified date/time, uploads the certificate in the specified file.
   * If the default certificate is expired or there was no default set, chooses the certificate with
   * the expiration furthest into the future and sets it as default.
   *
   * @param userId       User's email address.
   * @param sendAsEmail  The "send as" email address, or None if it should be the same as user_id.
   * @param certFilename Name of the file containing the S/MIME certificate.
   * @param certPassword Password for the certificate file, or None if the file is not
   *                     password-protected.
   * @param expireTime   DateTime object against which the certificate expiration is compared. If
   *                     None, uses the current time. @ returns: The ID of the default certificate.
   * @return The ID of the default certificate, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static String updateSmimeCerts(String userId,
                                        String sendAsEmail,
                                        String certFilename,
                                        String certPassword,
                                        LocalDateTime expireTime)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_SHARING);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    if (sendAsEmail == null) {
      sendAsEmail = userId;
    }

    ListSmimeInfoResponse listResults;
    try {
      listResults =
          service.users().settings().sendAs().smimeInfo().list(userId, sendAsEmail).execute();
    } catch (IOException e) {
      System.err.printf("An error occurred during list: %s\n", e);
      return null;
    }

    String defaultCertId = null;
    String bestCertId = null;
    LocalDateTime bestCertExpire = LocalDateTime.MIN;

    if (expireTime == null) {
      expireTime = LocalDateTime.now();
    }
    if (listResults != null && listResults.getSmimeInfo() != null) {
      for (SmimeInfo smimeInfo : listResults.getSmimeInfo()) {
        String certId = smimeInfo.getId();
        boolean isDefaultCert = smimeInfo.getIsDefault();
        if (isDefaultCert) {
          defaultCertId = certId;
        }
        LocalDateTime exp =
            LocalDateTime.ofInstant(
                Instant.ofEpochMilli(smimeInfo.getExpiration()), ZoneId.systemDefault());
        if (exp.isAfter(expireTime)) {
          if (exp.isAfter(bestCertExpire)) {
            bestCertId = certId;
            bestCertExpire = exp;
          }
        } else {
          if (isDefaultCert) {
            defaultCertId = null;
          }
        }
      }
    }
    if (defaultCertId == null) {
      String defaultId = bestCertId;
      if (defaultId == null && certFilename != null) {
        SmimeInfo smimeInfo = CreateSmimeInfo.createSmimeInfo(certFilename,
            certPassword);
        SmimeInfo insertResults = InsertSmimeInfo.insertSmimeInfo(userId,
            sendAsEmail,
            smimeInfo);
        if (insertResults != null) {
          defaultId = insertResults.getId();
        }
      }

      if (defaultId != null) {
        try {
          service.users().settings().sendAs().smimeInfo().setDefault(userId, sendAsEmail, defaultId)
              .execute();
          return defaultId;
        } catch (IOException e) {
          System.err.printf("An error occured during setDefault: %s", e);
        }
      }
    } else {
      return defaultCertId;
    }

    return null;
  }
}

Python

gmail/snippet/smime snippets/update_smime_cert.py

Xem trên GitHub

from datetime import datetime

import create_smime_info
import google.auth
import insert_smime_info
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def update_smime_cert(
    user_id, send_as_email, cert_filename, cert_password, expire_dt
):
  """Update S/MIME certificates for the user.

  First performs a lookup of all certificates for a user.  If there are no
  certificates, or they all expire before the specified date/time, uploads the
  certificate in the specified file.  If the default certificate is expired or
  there was no default set, chooses the certificate with the expiration furthest
  into the future and sets it as default.

  Args:
    user_id: User's email address.
    send_as_email: The "send as" email address, or None if it should be the same
        as user_id.
    cert_filename: Name of the file containing the S/MIME certificate.
    cert_password: Password for the certificate file, or None if the file is not
        password-protected.
    expire_dt: DateTime object against which the certificate expiration is
      compared.  If None, uses the current time.

  Returns:
    The ID of the default certificate.

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  if not send_as_email:
    send_as_email = user_id

  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    # pylint: disable=maybe-no-member
    results = (
        service.users()
        .settings()
        .sendAs()
        .smimeInfo()
        .list(userId=user_id, sendAsEmail=send_as_email)
        .execute()
    )

  except HttpError as error:
    print(f"An error occurred during list: {error}")
    return None

  default_cert_id = None
  best_cert_id = (None, datetime.datetime.fromtimestamp(0))

  if not expire_dt:
    expire_dt = datetime.datetime.now()
  if results and "smimeInfo" in results:
    for smime_info in results["smimeInfo"]:
      cert_id = smime_info["id"]
      is_default_cert = smime_info["isDefault"]
      if is_default_cert:
        default_cert_id = cert_id
      exp = datetime.datetime.fromtimestamp(smime_info["expiration"] / 1000)
      if exp > expire_dt:
        if exp > best_cert_id[1]:
          best_cert_id = (cert_id, exp)
      else:
        if is_default_cert:
          default_cert_id = None

  if not default_cert_id:
    default_id = best_cert_id[0]
    if not default_id and cert_filename:
      create_smime_info.create_smime_info(
          cert_filename=cert_filename, cert_password=cert_password
      )
      results = insert_smime_info.insert_smime_info()
      if results:
        default_id = results["id"]

    if default_id:
      try:
        # pylint: disable=maybe-no-member
        service.users().settings().sendAs().smimeInfo().setDefault(
            userId=user_id, sendAsEmail=send_as_email, id=default_id
        ).execute()
        return default_id
      except HttpError as error:
        print(f"An error occurred during setDefault: {error}")
  else:
    return default_cert_id

  return None


if __name__ == "__main__":
  update_smime_cert(
      user_id="xyz",
      send_as_email=None,
      cert_filename="xyz",
      cert_password="xyz",
      expire_dt=None,
  )

Chủ đề có liên quan

• Quản lý biệt hiệu và chữ ký bằng Gmail API
• Chọn các phạm vi của Gmail API
• Bật S/MIME được lưu trữ để mã hoá thư