การจัดการใบรับรอง S/MIME

API S/MIME ของ Gmail ช่วยให้เข้าถึงแบบเป็นโปรแกรมเพื่อจัดการใบรับรองอีเมล S/MIME สำหรับผู้ใช้ใน Google Workspace โดเมน

ผู้ดูแลระบบต้องเปิดใช้ S/MIME สำหรับ โดเมนเพื่อให้ใบรับรองทำงานได้

มาตรฐาน S/MIME มีข้อกำหนดสำหรับการเข้ารหัสคีย์สาธารณะและการลงนามข้อมูล MIME การกำหนดค่าใบรับรอง S/MIME ในบัญชีของผู้ใช้จะทำให้ Gmail ใช้ใบรับรองนั้นในลักษณะต่อไปนี้

  • Gmail ใช้ใบรับรองและคีย์ส่วนตัวของผู้ใช้เพื่อลงนามในอีเมลที่ส่งออก
  • Gmail ใช้คีย์ส่วนตัวของผู้ใช้เพื่อถอดรหัสอีเมลขาเข้า
  • Gmail ใช้ใบรับรองและคีย์สาธารณะของผู้รับเพื่อเข้ารหัสอีเมลขาออก
  • Gmail ใช้ใบรับรองและคีย์สาธารณะของผู้ส่งเพื่อยืนยันอีเมลขาเข้า

คุณสร้างใบรับรอง S/MIME แต่ละรายการและอัปโหลดโดยใช้ API ใบรับรอง S/MIME แต่ละใบใช้สำหรับนามแฝงที่เฉพาะเจาะจงของบัญชีอีเมลผู้ใช้ อีเมลแทนประกอบด้วยอีเมลหลักและอีเมล "ส่งในชื่อ" ที่กำหนดเอง ระบบจะทำเครื่องหมายใบรับรอง S/MIME รายการเดียวเป็นค่าเริ่มต้นสำหรับแต่ละนามแฝง

การให้สิทธิ์เข้าถึง API

การให้สิทธิ์เข้าถึง API มี 2 รูปแบบ ได้แก่

  1. คุณใช้บัญชีบริการที่มีการมอบสิทธิ์ทั่วทั้งโดเมนได้ ดูคำอธิบายคำศัพท์เหล่านี้ได้ที่ คำศัพท์ภาพรวมการตรวจสอบสิทธิ์และการให้สิทธิ์ ดูข้อมูลเกี่ยวกับการเปิดใช้ตัวเลือกนี้ได้ที่ สร้างบัญชีบริการที่มีการมอบสิทธิ์ทั่วทั้งโดเมน
  2. คุณสามารถใช้ขั้นตอน OAuth2 มาตรฐานที่ต้องได้รับความยินยอมจากผู้ใช้ปลายทาง เพื่อรับโทเค็นเพื่อการเข้าถึง Oauth2 ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์และการให้สิทธิ์ หากต้องการใช้ตัวเลือกนี้ ผู้ดูแลระบบโดเมนต้องเลือกช่องทำเครื่องหมาย "เปิดใช้การเข้าถึงของผู้ใช้ปลายทางของ S/MIME API" ในแผงควบคุมโดเมน

ขอบเขต ACL

API นี้ใช้ขอบเขต ACL เดียวกันกับเมธอด Gmail sendAs ดังนี้

gmail.settings.basic
ต้องใช้ขอบเขตนี้ในการอัปเดต S/MIME ของ SendAs หลัก
gmail.settings.sharing
ขอบเขตนี้จำเป็นสำหรับการอัปเดต จาก S/MIME ที่กำหนดเอง

การใช้ API

แหล่งข้อมูล users.settings.sendAs.smimeInfo มีเมธอดที่คุณใช้เพื่อจัดการใบรับรอง S/MIME ใบรับรองแต่ละรายการจะเชื่อมโยงกับนามแฝงส่งในฐานะ 1 รายการสำหรับผู้ใช้

อัปโหลดคีย์ S/MIME

ใช้วิธี smimeInfo.insert() เพื่อ อัปโหลดคีย์ S/MIME ใหม่สำหรับนามแฝงที่เป็นของผู้ใช้ คุณระบุชื่อแทนเป้าหมายได้โดยใช้พารามิเตอร์ต่อไปนี้

userId
อีเมลของผู้ใช้ คุณใช้ค่าพิเศษ me เพื่อระบุผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ในปัจจุบันได้
sendAsEmail
นามแฝงที่คุณอัปโหลดคีย์ นี่คืออีเมลที่จะปรากฏในส่วนหัว "จาก:" สำหรับอีเมลที่ส่งโดยใช้อีเมลแทนนี้

ใบรับรอง S/MIME และคีย์ส่วนตัวควรอยู่ในฟิลด์ pkcs12 ในรูปแบบดังกล่าว และไม่ควรตั้งค่าฟิลด์อื่นๆ ในคำขอ ฟิลด์ PKCS12 ควรมีทั้งคีย์ S/MIME ของผู้ใช้ และเชนใบรับรองการลงนาม API จะตรวจสอบความถูกต้องตามมาตรฐานในฟิลด์นี้ก่อนยอมรับ โดยจะตรวจสอบสิ่งต่อไปนี้

  • เรื่องตรงกับอีเมลที่ระบุ
  • วันหมดอายุถูกต้อง
  • ผู้ออกใบรับรอง (CA) อยู่ในรายการที่เชื่อถือได้ของเรา
  • ใบรับรองตรงกับข้อจำกัดทางเทคนิคของ Gmail

หากคีย์มีการเข้ารหัส รหัสผ่านควรอยู่ในencryptedKeyPassword ฟิลด์ การเรียกใช้ insert() ที่สำเร็จจะแสดงรหัสของ smimeInfo ที่ใช้เพื่ออ้างอิงคีย์ในอนาคตได้

แสดงรายการคีย์ S/MIME ของผู้ใช้

ใช้วิธี smimeInfo.list() เพื่อ แสดงรายการคีย์ S/MIME สำหรับผู้ใช้ที่ระบุสำหรับนามแฝงที่ระบุ คุณระบุชื่อแทนเป้าหมายได้โดยใช้พารามิเตอร์ต่อไปนี้

userId
อีเมลของผู้ใช้ คุณใช้ค่าพิเศษ me เพื่อระบุผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ในปัจจุบันได้
sendAsEmail
นามแฝงที่จะแสดงรายการคีย์ นี่คืออีเมลที่จะปรากฏในส่วนหัว "จาก:" สำหรับอีเมลที่ส่งโดยใช้อีเมลแทนนี้

ดึงคีย์ S/MIME สำหรับอีเมลแทน

ใช้วิธี smimeInfo.get() เพื่อ แสดงคีย์ S/MIME ที่เฉพาะเจาะจงสำหรับนามแฝงส่งในฐานะที่เฉพาะเจาะจงสำหรับผู้ใช้ คุณระบุชื่อแทนเป้าหมายได้โดยใช้พารามิเตอร์ต่อไปนี้

userId
อีเมลของผู้ใช้ คุณใช้ค่าพิเศษ me เพื่อระบุผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ในปัจจุบันได้
sendAsEmail
ชื่อแทนที่คุณกำลังดึงข้อมูลคีย์ นี่คืออีเมลที่จะปรากฏในส่วนหัว "จาก:" สำหรับอีเมลที่ส่งโดยใช้อีเมลแทนนี้

ลบคีย์ S/MIME

ใช้เมธอด smimeInfo.delete() เพื่อ ลบคีย์ S/MIME ที่ระบุจากนามแฝง คุณระบุชื่อแทนเป้าหมายได้โดยใช้พารามิเตอร์ต่อไปนี้

userId
อีเมลของผู้ใช้ คุณใช้ค่าพิเศษ me เพื่อระบุผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ในปัจจุบันได้
sendAsEmail
ชื่อแทนที่คุณกำลังดึงข้อมูลคีย์ นี่คืออีเมลที่จะปรากฏในส่วนหัว "จาก:" สำหรับอีเมลที่ส่งโดยใช้นามแฝงนี้
id
รหัสที่เปลี่ยนแปลงไม่ได้สำหรับ SmimeInfo

ตั้งค่าคีย์ S/MIME เริ่มต้นสำหรับนามแฝง

ใช้วิธี smimeInfo.setDefault() เพื่อ ทำเครื่องหมายคีย์ S/MIME ที่ระบุเป็นค่าเริ่มต้นสำหรับนามแฝงที่ระบุ คุณระบุชื่อแทนเป้าหมายได้โดยใช้พารามิเตอร์ต่อไปนี้

userId
อีเมลของผู้ใช้ คุณใช้ค่าพิเศษ me เพื่อระบุผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ในปัจจุบันได้
sendAsEmail
ชื่อแทนที่คุณกำลังดึงข้อมูลคีย์ นี่คืออีเมลที่จะปรากฏในส่วนหัว "จาก:" สำหรับอีเมลที่ส่งโดยใช้นามแฝงนี้
id
รหัสที่เปลี่ยนแปลงไม่ได้สำหรับ SmimeInfo

โค้ดตัวอย่าง

ตัวอย่างโค้ดต่อไปนี้แสดงการใช้ API เพื่อจัดการใบรับรอง S/MIME สำหรับองค์กรที่มีผู้ใช้หลายราย

การสร้างทรัพยากร SmimeInfo สำหรับใบรับรอง S/MIME

ตัวอย่างโค้ดต่อไปนี้แสดงการอ่านใบรับรองจากไฟล์ การเข้ารหัส เป็นสตริง base64url และการกำหนดให้กับฟิลด์ pkcs12 ของทรัพยากร smimeInfo

Java

gmail/snippets/src/main/java/CreateSmimeInfo.java
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
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"))

การอัปโหลดใบรับรอง S/MIME

หากต้องการอัปโหลดใบรับรอง ให้เรียกใช้ smimeInfo.insert และระบุทรัพยากร smimeInfo ในเนื้อหาของคำขอ

Java

gmail/snippets/src/main/java/InsertSmimeInfo.java
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
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 = "gduser1@workspacesamples.dev"
    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()

ตัวอย่างการจัดการใบรับรองของผู้ใช้จำนวนมาก

คุณอาจต้องการจัดการใบรับรองสำหรับผู้ใช้จำนวนมากในองค์กรพร้อมกัน ตัวอย่างต่อไปนี้แสดงวิธีจัดการใบรับรองสำหรับผู้ใช้หลายรายในการเรียกใช้แบบกลุ่มครั้งเดียว

การแทรกใบรับรองจากไฟล์ CSV

สมมติว่าคุณมีไฟล์ CSV ที่แสดงรหัสผู้ใช้และเส้นทางไปยังใบรับรองของ ผู้ใช้แต่ละราย

$ 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

คุณใช้การเรียก createSmimeInfo และ insertSmimeInfo จากก่อนหน้านี้เพื่ออัปโหลดใบรับรองตามที่ระบุไว้ในไฟล์ CSV ได้

gmail/snippets/src/main/java/InsertCertFromCsv.java
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

คุณใช้การเรียก create_smime_info และ insert_smime_info จากก่อนหน้านี้เพื่ออัปโหลดใบรับรองตามที่ระบุไว้ในไฟล์ CSV ได้

gmail/snippet/smime snippets/insert_cert_from_csv.py
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")

การจัดการใบรับรอง

ตัวอย่างนี้รวมการเรียกหลายรายการจาก smimeInfo API เพื่อแสดงวิธีที่คุณอาจจัดการใบรับรองสำหรับองค์กร โดยจะแสดงรายการใบรับรองสำหรับ ผู้ใช้ และหากใบรับรองเริ่มต้นหมดอายุหรือไม่ได้ตั้งค่าไว้ ระบบจะอัปโหลดใบรับรองที่พบใน ไฟล์ที่ระบุ จากนั้นจะตั้งค่าใบรับรองที่มีวันหมดอายุใน อนาคตเป็นค่าเริ่มต้น

จากนั้นจะเรียกใช้จากฟังก์ชันที่ประมวลผลไฟล์ CSV ดังในตัวอย่างก่อนหน้า

Java

gmail/snippets/src/main/java/UpdateSmimeCerts.java
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
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,
  )