Управление сертификатами S/MIME

Gmail S/MIME API обеспечивает программный доступ для управления сертификатами электронной почты 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:

  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. Каждый сертификат связан с одним псевдонимом отправки как для пользователя.

Загрузите ключ S/MIME

Используйте метод smimeInfo.insert() , чтобы загрузить новый ключ S/MIME для псевдонима, принадлежащего пользователю. Вы определяете целевой псевдоним, используя следующие параметры:

ID пользователя
Адрес электронной почты пользователя. Вы можете использовать специальное значение me чтобы указать текущего аутентифицированного пользователя.
ОтправитьКакEmail
Псевдоним, для которого вы загружаете ключ. Это адрес электронной почты, который отображается в заголовке «От:» для писем, отправленных с использованием этого псевдонима.

Сертификат S/MIME и закрытый ключ должны присутствовать в поле pkcs12 в этом формате; никакие другие поля в запросе задаваться не должны. Ожидается, что поле PKCS12 будет содержать как пользовательский ключ S/MIME, так и цепочку сертификатов подписи. API выполняет стандартную проверку этого поля перед его принятием, проверяя следующее:

  • Тема соответствует указанному адресу электронной почты.
  • Сроки годности действительны.
  • Выдающий центр сертификации (CA) находится в нашем списке доверенных.
  • Сертификаты соответствуют техническим ограничениям Gmail.

Если ключ зашифрован, пароль должен быть в поле encryptedKeyPassword . Успешные вызовы метода Insert() вернут идентификатор smimeInfo, который можно будет использовать для ссылки на ключ в будущем.

Получение списка ключей S/MIME пользователя

Используйте метод smimeInfo.list(), чтобы вернуть список ключей S/MIME для данного пользователя для данного псевдонима. Вы определяете целевой псевдоним, используя следующие параметры:

ID пользователя
Адрес электронной почты пользователя. Вы можете использовать специальное значение me чтобы указать текущего аутентифицированного пользователя.
ОтправитьКакEmail
Псевдоним, для которого нужно перечислить ключи. Это адрес электронной почты, который отображается в заголовке «От:» для писем, отправленных с использованием этого псевдонима.

Получите ключи S/MIME для псевдонима.

Используйте метод smimeInfo.get(), чтобы вернуть определенные ключи S/MIME для определенного псевдонима отправки для пользователя. Вы определяете целевой псевдоним, используя следующие параметры:

ID пользователя
Адрес электронной почты пользователя. Вы можете использовать специальное значение me чтобы указать текущего аутентифицированного пользователя.
ОтправитьКакEmail
Псевдоним, для которого вы получаете ключи. Это адрес электронной почты, который отображается в заголовке «От:» для писем, отправленных с использованием этого псевдонима.

Удаление ключа S/MIME

Используйте метод smimeInfo.delete(), чтобы удалить указанный ключ S/MIME из псевдонима. Вы определяете целевой псевдоним, используя следующие параметры:

ID пользователя
Адрес электронной почты пользователя. Вы можете использовать специальное значение me чтобы указать текущего аутентифицированного пользователя.
ОтправитьКакEmail
Псевдоним, для которого вы получаете ключи. Это адрес электронной почты, который отображается в заголовке «От:» для писем, отправленных с использованием этого псевдонима.
идентификатор
Неизменяемый идентификатор для SmimeInfo.

Установите ключ S/MIME по умолчанию для псевдонима

Используйте метод smimeInfo.setDefault(), чтобы пометить указанный ключ S/MIME как ключ по умолчанию для указанного псевдонима. Вы определяете целевой псевдоним, используя следующие параметры:

ID пользователя
Адрес электронной почты пользователя. Вы можете использовать специальное значение me чтобы указать текущего аутентифицированного пользователя.
ОтправитьКакEmail
Псевдоним, для которого вы получаете ключи. Это адрес электронной почты, который отображается в заголовке «От:» для писем, отправленных с использованием этого псевдонима.
идентификатор
Неизменяемый идентификатор для SmimeInfo.

Пример кода

В следующих примерах кода показано использование API для управления сертификатами S/MIME для организации с несколькими пользователями.

Создание ресурса SmimeInfo для сертификата S/MIME

В следующем примере кода показано чтение сертификата из файла, его кодирование в строку base64url и присвоение ее полю pkcs12 ресурса smimeInfo :

Ява

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;
  }
}

Питон

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 в теле запроса:

Ява

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;
  }
}

Питон

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

Ява

Вы можете использовать ранее использованные вызовы 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);
    }
  }
}

Питон

Вы можете использовать вызовы 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")

Управление сертификатами

Этот пример объединяет несколько вызовов API smimeInfo , чтобы показать, как вы можете управлять сертификатами для своей организации. В нем перечислены сертификаты для пользователя, и если срок действия сертификата по умолчанию истек или он не установлен, он загружает сертификат, найденный в указанном файле. Затем он устанавливает сертификат, срок действия которого истекает дальше всего в будущем, в качестве сертификата по умолчанию.

Затем он вызывается из функции, которая обрабатывает CSV-файл, как в предыдущем примере.

Ява

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;
  }
}

Питон

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