Como gerenciar certificados S/MIME

A API Gmail S/MIME oferece acesso programático para gerenciar certificados de e-mail S/MIME para usuários em um Google Workspace domínio.

Um administrador precisa ativar o S/MIME para o domínio para que os certificados funcionem.

O padrão S/MIME fornece uma especificação para criptografia de chave pública e assinatura de dados MIME. A configuração de certificados S/MIME na conta de um usuário faz com que o Gmail use esse certificado das seguintes maneiras:

• O Gmail usa o certificado e a chave privada do usuário para assinar e-mails enviados.
• O Gmail usa a chave privada do usuário para descriptografar o e-mail recebido.
• O Gmail usa o certificado e a chave pública do destinatário para criptografar o e-mail enviado.
• O Gmail usa o certificado e a chave pública do remetente para verificar o e-mail recebido.

Você gera certificados S/MIME individuais e os envia usando a API. Cada certificado S/MIME é para um alias específico de uma conta de e-mail do usuário. Os aliases incluem o endereço de e-mail principal e os endereços personalizados "Enviar como". Um único certificado S/MIME é marcado como padrão para cada alias.

Como autorizar o acesso à API

Há duas formas de autorizar o acesso à API:

1. É possível usar uma conta de serviço com delegação de autoridade em todo o domínio. Para uma explicação desses termos, consulte Termos da visão geral da autenticação e autorização. Para saber como ativar essa opção, consulte Criar uma conta de serviço com delegação de autoridade em todo o domínio.
2. É possível usar um fluxo OAuth2 padrão que exige o consentimento do usuário final para receber um token de acesso Oauth2. Para mais informações, consulte a Visão geral de autenticação e autorização. Para usar essa opção, o administrador do domínio precisa ativar a caixa de seleção "Acesso do usuário final à API S/MIME ativado" no painel de controle do domínio.

Escopos da ACL

Essa API depende dos mesmos escopos de ACL que os métodos sendAs do Gmail:

gmail.settings.basic

Esse escopo é necessário para atualizar o S/MIME do remetente principal.

gmail.settings.sharing

Esse escopo é necessário para atualizar o S/MIME de personalizado.

Como usar a API

O recurso users.settings.sendAs.smimeInfo fornece os métodos usados para gerenciar certificados S/MIME. Cada certificado é associado a um alias de envio para um usuário.

Observação: para determinar os pseudônimos de envio em nome de outro usuário, use o método sendAs.list().

Fazer upload de uma chave S/MIME

Use o método smimeInfo.insert() para enviar uma nova chave S/MIME para um alias pertencente a um usuário. Identifique o alias de destino usando os seguintes parâmetros:

userId

O endereço de e-mail do usuário. É possível usar o valor especial me para indicar o usuário autenticado no momento.

sendAsEmail

O alias para o qual você está fazendo o upload da chave. É o endereço de e-mail que aparece no cabeçalho "De:" das mensagens enviadas usando esse alias.

O certificado S/MIME e a chave privada precisam estar presentes no campo pkcs12 nesse formato. Nenhum outro campo pode ser definido na solicitação. O campo PKCS12 precisa conter a chave S/MIME do usuário e a cadeia de certificados de assinatura. A API realiza validações padrão nesse campo antes de aceitá-lo, verificando o seguinte:

• O assunto corresponde ao endereço de e-mail especificado.
• As datas de validade são válidas.
• A autoridade certificadora (AC) emissora está na nossa lista de confiança.
• Os certificados correspondem às restrições técnicas do Gmail.

Se a chave estiver criptografada, a senha precisará estar no campo encryptedKeyPassword. As chamadas insert() bem-sucedidas vão retornar o ID do smimeInfo, que pode ser usado para se referir à chave no futuro.

Listar as chaves S/MIME de um usuário

Use o método smimeInfo.list() para retornar a lista de chaves S/MIME do usuário para o alias especificado. Identifique o alias de destino usando os seguintes parâmetros:

userId

O endereço de e-mail do usuário. É possível usar o valor especial me para indicar o usuário autenticado no momento.

sendAsEmail

O alias para listar chaves. É o endereço de e-mail que aparece no cabeçalho "De:" das mensagens enviadas usando esse alias.

As chaves são retornadas apenas no formato PEM e contêm apenas o certificado S/MIME, não a chave privada.

Extrair as chaves S/MIME de um alias

Use o método smimeInfo.get() para retornar as chaves S/MIME específicas de um alias de envio para um usuário. Identifique o alias de destino usando os seguintes parâmetros:

userId

O endereço de e-mail do usuário. É possível usar o valor especial me para indicar o usuário autenticado no momento.

sendAsEmail

O alias para o qual você está recuperando as chaves. É o endereço de e-mail que aparece no cabeçalho "De:" das mensagens enviadas usando esse alias.

As chaves são retornadas apenas no formato PEM e contêm apenas o certificado S/MIME, não a chave privada.

Excluir uma chave S/MIME

Use o método smimeInfo.delete() para excluir a chave S/MIME especificada de um alias. Identifique o alias de destino usando os seguintes parâmetros:

userId

O endereço de e-mail do usuário. É possível usar o valor especial me para indicar o usuário autenticado no momento.

sendAsEmail

O alias para o qual você está recuperando as chaves. Esse é o endereço de e-mail que aparece no cabeçalho "De:" das mensagens enviadas usando esse alias.

id

O ID imutável do SmimeInfo.

Uma chave excluída não fica mais visível nem utilizável, e os e-mails S/MIME recebidos que são criptografados usando a chave pública correspondente não podem ser descriptografados. Portanto, é recomendável que a chave seja revogada com a autoridade certificadora (AC) antes de ser excluída.

Definir a chave S/MIME padrão para um alias

Use o método smimeInfo.setDefault() para marcar a chave S/MIME especificada como padrão para o alias especificado. Identifique o alias de destino usando os seguintes parâmetros:

userId

O endereço de e-mail do usuário. É possível usar o valor especial me para indicar o usuário autenticado no momento.

sendAsEmail

O alias para o qual você está recuperando as chaves. Esse é o endereço de e-mail que aparece no cabeçalho "De:" das mensagens enviadas usando esse alias.

id

O ID imutável do SmimeInfo.

Uma e apenas uma chave S/MIME é padrão para o Enviar como de um usuário: chamar setDefault() desativa o padrão anterior.

Ao receber mensagens S/MIME assinadas com uma chave específica, o Gmail associa a chave com a data de validade not_before mais distante no futuro como padrão ao criptografar e-mails enviados para o usuário associado. Para garantir que a nova chave padrão seja usada pelos usuários do Gmail com quem o usuário já se comunicou, verifique se a nova chave padrão tem uma data not_before mais recente do que a chave padrão anterior ou revogue a chave padrão anterior.

Código de amostra

Os exemplos de código abaixo demonstram como usar a API para gerenciar certificados S/MIME de uma organização com vários usuários.

Como criar um recurso SmimeInfo para um certificado S/MIME

O exemplo de código a seguir demonstra a leitura de um certificado do arquivo, a codificação em uma string base64url e a atribuição ao campo pkcs12 do recurso smimeInfo:

Java

gmail/snippets/src/main/java/CreateSmimeInfo.java

Ver no GitHub

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

Ver no GitHub

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

Como fazer upload de um certificado S/MIME

Para fazer upload de um certificado, chame smimeInfo.insert e forneça o recurso smimeInfo no corpo da solicitação:

Java

gmail/snippets/src/main/java/InsertSmimeInfo.java

Ver no GitHub

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

Ver no GitHub

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 = "[e-mail]"
    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()

Exemplos de gerenciamento de certificados de vários usuários

Talvez você queira gerenciar certificados de vários usuários na organização de uma só vez. Os exemplos a seguir mostram como gerenciar certificados para vários usuários em uma chamada em lote.

Inserir certificados de um arquivo CSV

Suponha que você tenha um arquivo CSV que lista os IDs de usuários e o caminho para o certificado de cada usuário:

$ cat certificates.csv
[e-mail],/path/to/user1_cert.p12,cert_password_1
[e-mail],/path/to/user2_cert.p12,cert_password_2
[e-mail],/path/to/user3_cert.p12,cert_password_3

Java

Você pode usar as chamadas createSmimeInfo e insertSmimeInfo anteriores para fazer upload dos certificados conforme especificado no arquivo CSV:

gmail/snippets/src/main/java/InsertCertFromCsv.java

Ver no GitHub

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

Você pode usar as chamadas create_smime_info e insert_smime_info anteriores para fazer upload dos certificados conforme especificado no arquivo CSV:

gmail/snippet/smime snippets/insert_cert_from_csv.py

Ver no GitHub

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

Gerenciamento de certificados

Este exemplo combina várias chamadas da API smimeInfo para mostrar como gerenciar certificados para sua organização. Ele lista os certificados do usuário e, se o certificado padrão estiver expirado ou não estiver definido, ele fará o upload do certificado encontrado no arquivo especificado. Em seguida, ele define o certificado com a data de validade mais distante como padrão.

Isso é chamado de uma função que processa um arquivo CSV, como no exemplo anterior.

Java

gmail/snippets/src/main/java/UpdateSmimeCerts.java

Ver no GitHub

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

Ver no GitHub

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