S/MIME-Zertifikate mit der Gmail API verwalten

In diesem Dokument wird beschrieben, wie Sie S/MIME-E-Mail-Zertifikate in der Gmail API verwenden.

Die Gmail API bietet programmatischen Zugriff zum Verwalten von S/MIME-E-Mail-Zertifikaten für Nutzer in einer Google Workspace-Domain.

Ein Administrator muss gehostetes S/MIME für die Domain aktivieren, damit die Zertifikate funktionieren.

Der S/MIME-Standard bietet eine Spezifikation für die Verschlüsselung mit öffentlichen Schlüsseln und die Signierung von MIME-Daten. Wenn S/MIME-Zertifikate in einem Nutzerkonto konfiguriert sind, verwendet Gmail sie auf folgende Weise:

  • Ausgehende E‑Mails mit dem Nutzerzertifikat und dem privaten Schlüssel signieren.

  • Eingehende E‑Mails mit dem privaten Schlüssel des Nutzers entschlüsseln.

  • Ausgehende E‑Mails mit dem Zertifikat und dem öffentlichen Schlüssel des Empfängers verschlüsseln.

  • Eingehende E‑Mails mit dem Absenderzertifikat und dem öffentlichen Schlüssel prüfen.

Sie können individuelle S/MIME-Zertifikate generieren und mit der Gmail API hochladen. Jedes S/MIME-Zertifikat gilt für einen bestimmten Alias für das E-Mail-Konto eines Nutzers. Aliasse umfassen die primäre E‑Mail-Adresse und benutzerdefinierte „Senden als“-Adressen. Die API kennzeichnet ein einzelnes S/MIME-Zertifikat als Standard für jeden Alias.

Weitere Informationen zu Aliasen finden Sie unter Aliase und Signaturen mit der Gmail API verwalten.

API-Zugriff autorisieren

Verwenden Sie eine der folgenden Methoden, um den Zugriff auf die Gmail API zu autorisieren:

  1. Verwenden Sie ein Dienstkonto mit domainweiter Delegierung von Befugnissen. Eine Erklärung dieser Begriffe finden Sie unter Informationen zur Authentifizierung und Autorisierung. Informationen zum Aktivieren dieser Option finden Sie unter Anmeldedaten für den Zugriff erstellen.

  2. Verwenden Sie einen standardmäßigen OAuth 2.0-Ablauf, für den die Einwilligung des Endnutzers erforderlich ist, um ein OAuth 2.0-Zugriffstoken zu erhalten. Weitere Informationen finden Sie unter Informationen zu Authentifizierung und Autorisierung.

    Damit diese Option verwendet werden kann, muss der Domainadministrator in der Google Admin-Konsole das Kästchen S/MIME-Verschlüsselung für den Versand und Empfang von E‑Mails aktivieren anklicken. Weitere Informationen finden Sie im Hilfeartikel Gehostetes S/MIME in der Google Admin-Konsole aktivieren.

ACL-Bereiche

Die Gmail API verwendet dieselben ACL-Bereiche wie die Gmail-Methoden sendAs:

  • gmail.settings.basic: Dieser Bereich ist erforderlich, um das primäre SendAs S/MIME-Zertifikat zu aktualisieren.

  • gmail.settings.sharing: Dieser Bereich ist erforderlich, um die benutzerdefinierte from-Adresse für S/MIME zu aktualisieren.

S/MIME-Schlüssel konfigurieren

Die Ressource settings.sendAs.smimeInfo bietet mehrere Methoden zum Verwalten von S/MIME-Zertifikaten. Jedes Zertifikat ist einem „Senden als“-Alias für einen Nutzer zugeordnet.

Verwenden Sie die Methode settings.sendAs.list für die Ressource settings.sendAs, um die Aliasse vom Typ „Senden als“ für einen Nutzer zu ermitteln.

S/MIME-Schlüssel hochladen

Verwenden Sie die Methode settings.sendAs.smimeInfo.insert für die Ressource settings.sendAs.smimeInfo, um einen neuen S/MIME-Schlüssel für einen Alias hochzuladen, der zu einem Nutzer gehört. Identifizieren Sie den Zielalias mit den folgenden Pfadparametern:

  • userId: E-Mail-Adresse des Nutzers. Verwenden Sie den speziellen Wert me, um den authentifizierten Nutzer anzugeben.

  • sendAsEmail: Der Alias, für den Sie den Schlüssel hochladen. Diese E‑Mail-Adresse wird im From:-Header für E‑Mails angezeigt, die mit diesem Alias gesendet werden.

Das S/MIME-Zertifikat und der private Schlüssel sollten in diesem Format im Feld pkcs12 vorhanden sein. In der Anfrage dürfen keine anderen Felder festgelegt werden. Das Feld pkcs12 enthält sowohl den S/MIME-Schlüssel des Nutzers als auch die Signaturzertifikatskette. Die API führt Standardvalidierungen für dieses Feld durch, bevor sie es akzeptiert. Dabei wird Folgendes überprüft:

  • Der Betreff stimmt mit der angegebenen E‑Mail-Adresse überein.
  • Ablaufdaten sind gültig.
  • Die ausstellende Zertifizierungsstelle ist in der Liste der vertrauenswürdigen Zertifizierungsstellen von Google enthalten.
  • Die Zertifikate entsprechen den technischen Einschränkungen von Gmail.

Wenn der Schlüssel verschlüsselt ist, sollte sich das Passwort im Feld encryptedKeyPassword befinden. Ein erfolgreicher Aufruf der Methode settings.sendAs.smimeInfo.insert gibt die settings.sendAs.smimeInfo-Ressource id zurück, die in Zukunft zum Verweisen auf den Schlüssel verwendet wird.

S/MIME-Schlüssel eines Nutzers auflisten

Verwenden Sie die Methode settings.sendAs.smimeInfo.list für die Ressource settings.sendAs.smimeInfo, um die Liste der S/MIME-Schlüssel für den angegebenen Nutzer für den angegebenen Alias zurückzugeben. Identifizieren Sie den Zielalias mit den folgenden Pfadparametern:

  • userId: E-Mail-Adresse des Nutzers. Verwenden Sie den speziellen Wert me, um den authentifizierten Nutzer anzugeben.

  • sendAsEmail: Der Alias, für den Schlüssel aufgelistet werden sollen. Diese E‑Mail-Adresse wird im From:-Header für E‑Mails angezeigt, die mit diesem Alias gesendet werden.

S/MIME-Schlüssel für einen Alias abrufen

Mit der Methode settings.sendAs.smimeInfo.get für die Ressource settings.sendAs.smimeInfo können Sie die spezifischen S/MIME-Schlüssel für einen bestimmten „Senden als“-Alias für einen Nutzer zurückgeben. Ermitteln Sie den Zielalias anhand der folgenden Pfadparameter:

  • userId: E-Mail-Adresse des Nutzers. Verwenden Sie den speziellen Wert me, um den authentifizierten Nutzer anzugeben.

  • sendAsEmail: Der Alias, für den Sie die Schlüssel abrufen. Diese E‑Mail-Adresse wird im From:-Header für E‑Mails angezeigt, die mit diesem Alias gesendet werden.

S/MIME-Schlüssel löschen

Verwenden Sie die Methode settings.sendAs.smimeInfo.delete für die Ressource settings.sendAs.smimeInfo, um den angegebenen S/MIME-Schlüssel aus einem Alias zu löschen. Geben Sie den Zielalias mit den folgenden Pfadparametern an:

  • userId: E-Mail-Adresse des Nutzers. Verwenden Sie den speziellen Wert me, um den authentifizierten Nutzer anzugeben.

  • sendAsEmail: Der Alias, für den Sie die Schlüssel löschen. Diese E‑Mail-Adresse wird im From:-Header für E‑Mails angezeigt, die mit diesem Alias gesendet werden.

  • id: Die unveränderliche ID für die smimeInfo.

Standardschlüssel für S/MIME für einen Alias festlegen

Verwenden Sie die Methode settings.sendAs.smimeInfo.setDefault für die Ressource settings.sendAs.smimeInfo, um den angegebenen S/MIME-Schlüssel als Standard für den angegebenen Alias zu kennzeichnen. Identifizieren Sie den Zielalias mit den folgenden Pfadparametern:

  • userId: E-Mail-Adresse des Nutzers. Verwenden Sie den speziellen Wert me, um den authentifizierten Nutzer anzugeben.

  • sendAsEmail: Der Alias, für den Schlüssel als Standard festgelegt werden sollen. Diese E‑Mail-Adresse wird im From:-Header für E‑Mails angezeigt, die mit diesem Alias gesendet werden.

  • id: Die unveränderliche ID für die smimeInfo.

Codebeispiele

Die folgenden Codebeispiele zeigen, wie Sie die Gmail API verwenden, um S/MIME-Zertifikate für eine Organisation mit mehreren Nutzern zu verwalten:

smimeInfo-Ressource für ein S/MIME-Zertifikat erstellen

In diesem Codebeispiel wird gezeigt, wie ein Zertifikat aus einer Datei gelesen, in einen Base64URL-String codiert und dem Feld pkcs12 in der settings.sendAs.smimeInfo-Ressource zugewiesen wird:

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-Zertifikat hochladen

Rufen Sie zum Hochladen eines Zertifikats die Methode settings.sendAs.smimeInfo.insert auf und geben Sie die Ressource settings.sendAs.smimeInfo im Text der Anfrage an:

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()

Zertifikate mehrerer Nutzer verwalten

Die folgenden Codebeispiele zeigen, wie Sie Zertifikate für mehrere Nutzer in einer Organisation in einem Batchaufruf verwalten:

Zertifikate aus einer CSV-Datei einfügen

Hier ist ein Beispiel für eine CSV-Datei mit Nutzer-IDs und dem Pfad zum Zertifikat jedes Nutzers:

$ 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

Sie können die Beispiele CreateSmimeInfo und InsertSmimeInfo verwenden, um die Zertifikate für die in einer CSV-Datei angegebenen Nutzer hochzuladen:

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

Mit den Beispielen create_smime_info und insert_smime_info können Sie die Zertifikate für die in einer CSV-Datei angegebenen Nutzer hochladen:

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")

Zertifikatsverwaltung

In diesem Beispiel werden mehrere Methoden aus der settings.sendAs.smimeInfo-Ressource kombiniert, um zu zeigen, wie Sie Zertifikate für Ihre Organisation verwalten können. Hier werden die Zertifikate für den Nutzer aufgeführt. Wenn das Standardzertifikat abgelaufen oder nicht festgelegt ist, wird das Zertifikat hochgeladen, das in der angegebenen Datei gefunden wurde. Anschließend wird das Zertifikat mit dem Ablaufdatum, das am weitesten in der Zukunft liegt, als Standard festgelegt.

Diese Funktion verarbeitet dann eine CSV-Datei, ähnlich wie das vorherige Beispiel Zertifikate aus einer CSV-Datei einfügen.

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,
  )