Zarządzanie certyfikatami S/MIME za pomocą interfejsu Gmail API

Ten dokument wyjaśnia, jak używać certyfikatów e-mail S/MIME z interfejsem Gmail API.

Interfejs Gmail API zapewnia programowy dostęp do zarządzania certyfikatami e-maili S/MIME użytkowników w domenie Google Workspace.

Aby certyfikaty działały, administrator musi włączyć hostowane szyfrowanie S/MIME w domenie.

Standard S/MIME zawiera specyfikację szyfrowania kluczem publicznym i podpisywania danych MIME. Gdy skonfigurujesz certyfikaty S/MIME na koncie użytkownika, Gmail będzie ich używać w następujący sposób:

  • Podpisywanie poczty wychodzącej za pomocą certyfikatu użytkownika i klucza prywatnego.

  • odszyfrowywać przychodzące e-maile za pomocą klucza prywatnego użytkownika;

  • szyfrować pocztę wychodzącą za pomocą certyfikatu odbiorcy i klucza publicznego;

  • weryfikować przychodzące e-maile za pomocą certyfikatu nadawcy i klucza publicznego;

Możesz wygenerować poszczególne certyfikaty S/MIME i przesłać je za pomocą interfejsu Gmail API. Każdy certyfikat S/MIME jest przeznaczony dla konkretnego aliasu konta e-mail użytkownika. Aliasy obejmują podstawowy adres e-mail i niestandardowe adresy „Wyślij jako”. Interfejs API oznacza pojedynczy certyfikat S/MIME jako domyślny dla każdego aliasu.

Więcej informacji o aliasach znajdziesz w artykule Zarządzanie aliasami i podpisami za pomocą interfejsu Gmail API.

Autoryzowanie dostępu do interfejsu API

Aby autoryzować dostęp do interfejsu Gmail API, użyj jednej z tych metod:

  1. Użyj konta usługi z przekazywaniem dostępu w całej domenie. Wyjaśnienie tych terminów znajdziesz w artykule Uwierzytelnianie i autoryzacja. Aby włączyć tę opcję, zapoznaj się z artykułem Tworzenie danych logowania.

  2. Użyj standardowego przepływu OAuth 2.0, który wymaga zgody użytkownika na uzyskanie tokena dostępu OAuth 2.0. Więcej informacji znajdziesz w artykule Uwierzytelnianie i autoryzacja.

    Aby skorzystać z tej opcji, administrator domeny musi zaznaczyć pole wyboru Włącz szyfrowanie S/MIME dla wysyłanych i odbieranych e-maili w konsoli administracyjnej Google. Więcej informacji znajdziesz w artykule Włączanie hostowanego szyfrowania S/MIME w konsoli administracyjnej.

Zakresy autoryzacji

Interfejs Gmail API korzysta z tych samych zakresów OAuth co metody Gmail sendAs:

  • gmail.settings.basic: wymagane do zaktualizowania głównego SendAs S/MIME.

  • gmail.settings.sharing: wymagane do zaktualizowania niestandardowego adresu od S/MIME.

Konfigurowanie kluczy S/MIME

Zasób settings.sendAs.smimeInfo udostępnia kilka metod zarządzania certyfikatami S/MIME. Każdy certyfikat jest powiązany z 1 aliasem „Wyślij jako” użytkownika.

Aby określić aliasy „Wyślij jako” użytkownika, użyj metody settings.sendAs.list w zasobie settings.sendAs.

Przesyłanie klucza S/MIME

Użyj metody settings.sendAs.smimeInfo.insert w zasobie settings.sendAs.smimeInfo, aby przesłać nowy klucz S/MIME dla aliasu należącego do użytkownika. Określ alias celu, używając tych parametrów ścieżki:

  • userId: adres e-mail użytkownika. Aby wskazać uwierzytelnionego użytkownika, użyj wartości specjalnej me.

  • sendAsEmail: alias, dla którego przesyłasz klucz. Ten adres e-mail pojawi się w nagłówku From: poczty wysłanej przy użyciu tego aliasu.

Podaj certyfikat S/MIME i klucz prywatny w polu pkcs12 w formacie PKCS #12. Nie ustawiaj w żądaniu żadnych innych pól. Pole pkcs12 zawiera zarówno klucz S/MIME użytkownika, jak i łańcuch certyfikatów podpisywania. Interfejs API przeprowadza standardowe testy poprawności tego pola przed jego zaakceptowaniem, sprawdzając:

  • Temat pasuje do podanego adresu e-mail.
  • Daty wygaśnięcia są prawidłowe.
  • Wystawiający urząd certyfikacji znajduje się na liście zaufanych urzędów certyfikacji Google.
  • Certyfikaty są zgodne z ograniczeniami technicznymi Gmaila.

Jeśli klucz jest zaszyfrowany, podaj hasło w polu encryptedKeyPassword. Wywołanie metody settings.sendAs.smimeInfo.insert zakończone sukcesem zwraca zasób settings.sendAs.smimeInfo id, który będzie używany do odwoływania się do klucza w przyszłości.

Wyświetlanie listy kluczy S/MIME użytkownika

Użyj metody settings.sendAs.smimeInfo.list w zasobie settings.sendAs.smimeInfo, aby zwrócić listę kluczy S/MIME dla danego użytkownika i danego aliasu. Określ alias celu, korzystając z tych parametrów ścieżki:

  • userId: adres e-mail użytkownika. Aby wskazać uwierzytelnionego użytkownika, użyj wartości specjalnej me.

  • sendAsEmail: Alias, dla którego mają zostać wyświetlone klucze. Ten adres e-mail pojawia się w nagłówku From: poczty wysyłanej przy użyciu tego aliasu.

Pobieranie kluczy S/MIME dla aliasu

Użyj metody settings.sendAs.smimeInfo.get w zasobie settings.sendAs.smimeInfo, aby zwrócić konkretne klucze S/MIME dla określonego aliasu „wyślij jako” użytkownika. Określ alias celu, korzystając z tych parametrów ścieżki:

  • userId: adres e-mail użytkownika. Aby wskazać uwierzytelnionego użytkownika, użyj wartości specjalnej me.

  • sendAsEmail: alias, dla którego pobierasz klucze. Ten adres e-mail pojawi się w nagłówku From: poczty wysłanej przy użyciu tego aliasu.

Usuwanie klucza S/MIME

Użyj metody settings.sendAs.smimeInfo.delete w zasobie settings.sendAs.smimeInfo, aby usunąć określony klucz S/MIME z aliasu. Określ alias celu, korzystając z tych parametrów ścieżki:

  • userId: adres e-mail użytkownika. Aby wskazać uwierzytelnionego użytkownika, użyj wartości specjalnej me.

  • sendAsEmail: alias, z którego usuwasz klucz. Ten adres e-mail pojawi się w nagłówku From: poczty wysłanej przy użyciu tego aliasu.

  • id: niezmienny identyfikator smimeInfo.

Usunięty klucz nie jest już widoczny ani użyteczny. Nie możesz odszyfrować odebranych e-maili S/MIME, które zostały zaszyfrowane przy użyciu odpowiedniego klucza publicznego. Przed usunięciem klucza cofnij go w urzędzie certyfikacji, który go wydał.

Ustawianie domyślnego klucza S/MIME dla aliasu

Użyj metody settings.sendAs.smimeInfo.setDefault w zasobie settings.sendAs.smimeInfo, aby oznaczyć określony klucz S/MIME jako domyślny dla danego aliasu. Określ alias celu, korzystając z tych parametrów ścieżki:

  • userId: adres e-mail użytkownika. Aby wskazać uwierzytelnionego użytkownika, użyj wartości specjalnej me.

  • sendAsEmail: alias, dla którego chcesz ustawić klucz domyślny. Ten adres e-mail pojawi się w nagłówku From: poczty wysłanej przy użyciu tego aliasu.

  • id: niezmienny identyfikator smimeInfo.

Tylko jeden klucz S/MIME jest domyślny dla aliasu „Wyślij jako” użytkownika. Wywołanie metody settings.sendAs.smimeInfo.setDefault powoduje usunięcie poprzedniego ustawienia domyślnego.

Gdy użytkownik odbiera wiadomości S/MIME podpisane danym kluczem, Gmail kojarzy ten klucz z not_beforedatą ważności najbardziej odległą w przyszłości jako domyślny podczas szyfrowania poczty wysyłanej do powiązanego użytkownika. Aby mieć pewność, że użytkownicy Gmaila, z którymi użytkownik już się komunikował, będą używać nowego klucza domyślnego, sprawdź, czy nowy klucz domyślny ma not_before datę późniejszą niż poprzedni klucz domyślny, lub cofnij poprzedni klucz domyślny.

Przykładowe fragmenty kodu

Poniższe przykłady kodu pokazują, jak za pomocą interfejsu Gmail API zarządzać certyfikatami S/MIME w organizacji z wieloma użytkownikami:

Utwórz zasób smimeInfo dla certyfikatu S/MIME.

Ten przykładowy kod pokazuje, jak odczytać certyfikat z pliku, zakodować go do postaci ciągu Base64URL i przypisać go do pola pkcs12 w zasobie settings.sendAs.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"))

Przesyłanie certyfikatu S/MIME

Aby przesłać certyfikat, wywołaj metodę settings.sendAs.smimeInfo.insert i podaj zasób settings.sendAs.smimeInfo w treści żądania:

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

Zarządzanie certyfikatami wielu użytkowników

Te przykłady kodu pokazują, jak zarządzać certyfikatami wielu użytkowników w organizacji w ramach jednego wywołania zbiorczego:

Wstawianie certyfikatów z pliku CSV

Oto przykładowy plik CSV z identyfikatorami użytkowników i ścieżkami do certyfikatów poszczególnych użytkowników:

$ 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

Możesz użyć przykładów CreateSmimeInfo i InsertSmimeInfo, aby przesłać certyfikaty użytkowników wskazanych w pliku 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

Możesz użyć przykładów create_smime_info i insert_smime_info, aby przesłać certyfikaty użytkowników wskazanych w pliku 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")

Zarządzanie certyfikatami

Ten przykład łączy kilka metod z settings.sendAs.smimeInfo, aby pokazać, jak zarządzać certyfikatami w organizacji. Wyświetla listę certyfikatów użytkownika. Jeśli domyślny certyfikat wygasł lub nie został ustawiony, przesyła certyfikat znaleziony w określonym pliku. Następnie ustawia jako domyślny certyfikat, którego data ważności jest najbardziej odległa w przyszłości.

Funkcja ta przetwarza plik CSV podobnie jak poprzedni przykład Wstawianie certyfikatów z pliku 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,
  )