Управление S/MIME-сертификатами с помощью API Gmail

В этом документе объясняется, как использовать S/MIME-сертификаты электронной почты в API Gmail.

API Gmail предоставляет программный доступ к управлению сертификатами электронной почты S/MIME для пользователей в домене Google Workspace.

Для корректной работы сертификатов администратор должен включить поддержку S/MIME для данного домена .

Стандарт S/MIME предоставляет спецификацию для шифрования и подписи MIME-данных с использованием открытого ключа. Когда в учетной записи пользователя настроены сертификаты S/MIME, Gmail использует их следующим образом:

  • Подписывайте исходящие письма с помощью пользовательского сертификата и закрытого ключа.

  • Расшифруйте входящие письма с помощью закрытого ключа пользователя.

  • Шифрование исходящей почты с помощью сертификата получателя и открытого ключа.

  • Проверяйте входящую почту с помощью сертификата отправителя и открытого ключа.

Вы можете генерировать отдельные S/MIME-сертификаты и загружать их с помощью API Gmail. Каждый S/MIME-сертификат предназначен для определенного псевдонима учетной записи электронной почты пользователя. Псевдонимы включают основной адрес электронной почты и пользовательские адреса «Отправлять как». API помечает один S/MIME-сертификат как сертификат по умолчанию для каждого псевдонима.

Для получения дополнительной информации о псевдонимах см. раздел «Управление псевдонимами и подписями с помощью API Gmail» .

Авторизация доступа к API

Для авторизации доступа к API Gmail используйте один из следующих способов:

  1. Используйте служебную учетную запись с делегированием полномочий в масштабах всего домена . Пояснение к этим терминам см. в разделе «Узнайте больше об аутентификации и авторизации» . Чтобы включить эту опцию, см. раздел «Создание учетных данных доступа» .

  2. Используйте стандартный процесс OAuth 2.0, требующий согласия конечного пользователя для получения токена доступа OAuth 2.0. Для получения дополнительной информации см. раздел «Подробнее об аутентификации и авторизации» .

    Для использования этой опции администратор домена должен установить флажок «Включить шифрование S/MIME для отправки и получения электронных писем» в консоли администратора Google. Дополнительную информацию см. в разделе «Включение размещенного S/MIME в консоли администратора Google» .

Области действия ACL

API Gmail использует те же области действия ACL , что и методы sendAs в Gmail :

  • gmail.settings.basic : Эта область действия необходима для обновления основного S/MIME- SendAs .

  • gmail.settings.sharing : Эта область действия необходима для обновления пользовательских настроек из S/MIME.

Настройка ключей S/MIME

Ресурс settings.sendAs.smimeInfo предоставляет несколько методов для управления сертификатами S/MIME. Каждому сертификату присваивается один псевдоним для отправки сообщений пользователю.

Чтобы определить псевдонимы для отправки сообщений пользователю, используйте метод settings.sendAs.list ресурса settings.sendAs .

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

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

  • userId : Адрес электронной почты пользователя. Используйте специальное значение me для обозначения авторизованного пользователя.

  • sendAsEmail : Псевдоним, для которого вы загружаете ключ. Этот адрес электронной почты отображается в заголовке From: для писем, отправленных с использованием этого псевдонима.

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

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

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

Вывести список S/MIME-ключей пользователя.

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

  • userId : Адрес электронной почты пользователя. Используйте специальное значение me для обозначения авторизованного пользователя.

  • sendAsEmail : Псевдоним, для которого нужно перечислить ключи. Этот адрес электронной почты отображается в заголовке From: для писем, отправленных с использованием этого псевдонима.

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

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

  • userId : Адрес электронной почты пользователя. Используйте специальное значение me для обозначения авторизованного пользователя.

  • sendAsEmail : Псевдоним, для которого вы получаете ключи. Этот адрес электронной почты отображается в заголовке From: для писем, отправленных с использованием этого псевдонима.

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

Для удаления указанного ключа S/MIME из псевдонима используйте метод settings.sendAs.smimeInfo.delete ресурса settings.sendAs.smimeInfo . Укажите целевой псевдоним, используя следующие параметры пути:

  • userId : Адрес электронной почты пользователя. Используйте специальное значение me для обозначения авторизованного пользователя.

  • sendAsEmail : Псевдоним, для которого вы удаляете ключи. Этот адрес электронной почты отображается в заголовке From: для писем, отправленных с использованием этого псевдонима.

  • id : Неизменяемый идентификатор для smimeInfo .

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

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

  • userId : Адрес электронной почты пользователя. Используйте специальное значение me для обозначения авторизованного пользователя.

  • sendAsEmail : Псевдоним, для которого следует установить ключи по умолчанию. Этот адрес электронной почты отображается в заголовке From: для писем, отправляемых с использованием этого псевдонима.

  • id : Неизменяемый идентификатор для smimeInfo .

Примеры кода

Приведенные ниже примеры кода демонстрируют, как использовать API Gmail для управления S/MIME-сертификатами в организации с несколькими пользователями:

Создайте ресурс smimeInfo для сертификата S/MIME.

В этом примере кода показано, как прочитать сертификат из файла, закодировать его в строку Base64URL и присвоить её полю pkcs12 ресурса 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"))

Загрузите S/MIME-сертификат.

Для загрузки сертификата вызовите метод settings.sendAs.smimeInfo.insert и укажите ресурс settings.sendAs.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

Для загрузки сертификатов пользователей, указанных в CSV-файле, можно использовать примеры CreateSmimeInfo и InsertSmimeInfo :

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

Для загрузки сертификатов для пользователей, указанных в CSV-файле, можно использовать примеры функций create_smime_info и insert_smime_info :

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

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

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

Затем эта функция обрабатывает CSV-файл, аналогично предыдущему примеру "Вставка сертификатов из 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,
  )