Gerenciar certificados S/MIME com a API Gmail

Este documento explica como usar certificados de e-mail S/MIME na API Gmail.

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

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

O padrão S/MIME oferece uma especificação para criptografia de chave pública e assinatura de dados MIME. Quando os certificados S/MIME são configurados em uma conta de usuário, o Gmail os usa das seguintes maneiras:

  • Assine e-mails enviados com o certificado do usuário e a chave privada.

  • Descriptografar e-mails recebidos com a chave privada do usuário.

  • Criptografe o e-mail de saída com o certificado e a chave pública do destinatário.

  • Verifique o e-mail recebido com o certificado do remetente e a chave pública.

É possível gerar certificados S/MIME individuais e fazer upload deles usando a API Gmail. Cada certificado S/MIME é para um alias específico de uma conta de e-mail de usuário. Os aliases incluem o endereço de e-mail principal e os endereços personalizados "Enviar como". A API marca um único certificado S/MIME como padrão para cada alias.

Para mais informações sobre aliases, consulte Gerenciar aliases e assinaturas com a API Gmail.

Autorizar o acesso à API

Para autorizar o acesso à API Gmail, use um dos seguintes métodos:

  1. Use uma conta de serviço com delegação de autoridade em todo o domínio. Para uma explicação desses termos, consulte Saiba mais sobre autenticação e autorização. Para ativar essa opção, consulte Criar credenciais de acesso.

  2. Use um fluxo padrão do OAuth 2.0 que exija o consentimento do usuário final para receber um token de acesso do OAuth 2.0. Para mais informações, consulte Saiba mais sobre autenticação e autorização.

    Para usar essa opção, o administrador do domínio precisa marcar a caixa de seleção Ativar a criptografia S/MIME para enviar e receber e-mails no Google Admin Console. Para mais informações, consulte Ativar o S/MIME hospedado no Google Admin Console.

Escopos da ACL

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

  • gmail.settings.basic: esse escopo é necessário para atualizar o S/MIME SendAs principal.

  • gmail.settings.sharing: esse escopo é necessário para atualizar o S/MIME de personalizado.

Configurar chaves S/MIME

O recurso settings.sendAs.smimeInfo oferece vários métodos para gerenciar certificados S/MIME. Cada certificado está associado a um alias "Enviar como" de um usuário.

Para determinar os aliases de envio como de um usuário, use o método settings.sendAs.list no recurso settings.sendAs.

Fazer upload de uma chave S/MIME

Use o método settings.sendAs.smimeInfo.insert no recurso settings.sendAs.smimeInfo para fazer upload de uma nova chave S/MIME para um alias pertencente a um usuário. Identifique o alias de destino usando os seguintes parâmetros de caminho:

  • userId: o endereço de e-mail do usuário. Use o valor especial me para indicar o usuário autenticado.

  • sendAsEmail: o alias para o qual você está enviando a chave. Esse endereço de e-mail aparece no cabeçalho From: das mensagens enviadas usando esse alias.

O certificado S/MIME e a chave privada precisam estar no campo pkcs12 nesse formato. Nenhum outro campo pode ser definido na solicitação. O campo pkcs12 contém 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 expirações são válidas.
  • A autoridade certificadora (CA) emissora está na lista de confiança do Google.
  • Os certificados atendem às restrições técnicas do Gmail.

Se a chave estiver criptografada, a senha vai estar no campo encryptedKeyPassword. Uma chamada de método settings.sendAs.smimeInfo.insert bem-sucedida retorna o recurso settings.sendAs.smimeInfo id usado para se referir à chave no futuro.

Listar as chaves S/MIME de um usuário

Use o método settings.sendAs.smimeInfo.list no recurso settings.sendAs.smimeInfo para retornar a lista de chaves S/MIME do usuário e do alias especificados. Identifique o alias de destino usando os seguintes parâmetros de caminho:

  • userId: o endereço de e-mail do usuário. Use o valor especial me para indicar o usuário autenticado.

  • sendAsEmail: o alias para listar as chaves. Esse endereço de e-mail aparece no cabeçalho From: das mensagens enviadas com esse alias.

Recuperar as chaves S/MIME de um alias

Use o método settings.sendAs.smimeInfo.get no recurso settings.sendAs.smimeInfo para retornar as chaves S/MIME específicas de um alias "Enviar como" de um usuário. Identifique o alias de destino usando os seguintes parâmetros de caminho:

  • userId: o endereço de e-mail do usuário. Use o valor especial me para indicar o usuário autenticado.

  • sendAsEmail: o alias para o qual você está recuperando as chaves. Esse endereço de e-mail aparece no cabeçalho From: das mensagens enviadas usando esse alias.

Excluir uma chave S/MIME

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

  • userId: o endereço de e-mail do usuário. Use o valor especial me para indicar o usuário autenticado.

  • sendAsEmail: o alias das chaves que você está excluindo. Esse endereço de e-mail aparece no cabeçalho From: das mensagens enviadas usando esse alias.

  • id: o ID imutável do smimeInfo.

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

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

  • userId: o endereço de e-mail do usuário. Use o valor especial me para indicar o usuário autenticado.

  • sendAsEmail: o alias para as chaves a serem definidas como padrão. Esse endereço de e-mail aparece no cabeçalho From: das mensagens enviadas usando esse alias.

  • id: o ID imutável do smimeInfo.

Amostras de código

Os exemplos de código a seguir mostram como usar a API Gmail para gerenciar certificados S/MIME de uma organização com vários usuários:

Crie um recurso smimeInfo para um certificado S/MIME

Este exemplo de código mostra como ler um certificado de um arquivo, codificá-lo em uma string Base64URL e atribuí-lo ao campo pkcs12 no recurso 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"))

Fazer upload de um certificado S/MIME

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

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

Gerenciar certificados de vários usuários

Estes exemplos de código mostram como gerenciar certificados para vários usuários em uma organização em uma única chamada em lote:

Inserir certificados de um arquivo CSV

Confira a seguir um exemplo de arquivo CSV que lista IDs de usuários e o caminho para o certificado de cada usuário:

$ 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

Você pode usar as amostras CreateSmimeInfo e InsertSmimeInfo para fazer upload dos certificados dos usuários especificados em um arquivo 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

Você pode usar os exemplos create_smime_info e insert_smime_info para fazer upload dos certificados dos usuários especificados em um arquivo 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")

Gerenciamento de certificados

Este exemplo combina vários métodos do recurso settings.sendAs.smimeInfo para mostrar como gerenciar certificados da sua organização. Ela lista os certificados do usuário. Se o certificado padrão estiver expirado ou não estiver definido, ele vai fazer upload do certificado encontrado no arquivo especificado. Em seguida, ele define como padrão o certificado com a data de validade mais distante.

Em seguida, essa função processa um arquivo CSV, semelhante ao exemplo anterior Inserir certificados de um arquivo 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,
  )