Administra certificados S/MIME con la API de Gmail

En este documento, se explica cómo usar los certificados de correo electrónico S/MIME en la API de Gmail.

La API de Gmail proporciona acceso programático para administrar los certificados de correo electrónico S/MIME de los usuarios en un dominio de Google Workspace.

Para que los certificados funcionen, el administrador debe activar S/MIME alojado para el dominio.

El estándar S/MIME proporciona una especificación para la encriptación de clave pública y la firma de datos MIME. Cuando se configuran certificados S/MIME en una cuenta de usuario, Gmail los usa de las siguientes maneras:

  • Firma el correo saliente con el certificado de usuario y la clave privada.

  • Desencriptar el correo entrante con la clave privada del usuario

  • Encripta el correo saliente con el certificado y la clave pública del destinatario.

  • Verifica el correo entrante con el certificado del remitente y la clave pública.

Puedes generar certificados S/MIME individuales y subirlos con la API de Gmail. Cada certificado de S/MIME es para un alias específico de una cuenta de correo electrónico del usuario. Los alias incluyen la dirección de correo electrónico principal y las direcciones personalizadas de "Enviar como". La API marca un solo certificado de S/MIME como predeterminado para cada alias.

Para obtener más información sobre los alias, consulta Administra alias y firmas con la API de Gmail.

Autoriza el acceso a la API

Para autorizar el acceso a la API de Gmail, usa uno de los siguientes métodos:

  1. Usa una cuenta de servicio con delegación de autoridad en todo el dominio. Para obtener una explicación de estos términos, consulta Obtén información sobre la autenticación y la autorización. Para habilitar esta opción, consulta Crea credenciales de acceso.

  2. Usa un flujo estándar de OAuth 2.0 que requiera el consentimiento del usuario final para obtener un token de acceso de OAuth 2.0. Para obtener más información, consulta Más información sobre la autenticación y la autorización.

    Para usar esta opción, el administrador del dominio debe seleccionar la casilla de verificación Habilitar la encriptación S/MIME para enviar y recibir correos electrónicos en la Consola del administrador de Google. Para obtener más información, consulta Cómo activar S/MIME alojado en la Consola del administrador de Google.

Alcances de LCA

La API de Gmail se basa en los mismos permisos de ACL que los métodos Gmail sendAs:

  • gmail.settings.basic: Este alcance es obligatorio para actualizar el S/MIME SendAs principal.

  • gmail.settings.sharing: Este alcance es obligatorio para actualizar el S/MIME personalizado de.

Cómo configurar claves S/MIME

El recurso settings.sendAs.smimeInfo proporciona varios métodos para administrar certificados de S/MIME. Cada certificado está asociado con un alias de enviar como para un usuario.

Para determinar los alias de envío de un usuario, usa el método settings.sendAs.list en el recurso settings.sendAs.

Cómo subir una clave S/MIME

Usa el método settings.sendAs.smimeInfo.insert en el recurso settings.sendAs.smimeInfo para subir una clave S/MIME nueva para un alias que pertenece a un usuario. Identifica el alias de destino con los siguientes parámetros de ruta de acceso:

  • userId: La dirección de correo electrónico del usuario. Usa el valor especial me para indicar el usuario autenticado.

  • sendAsEmail: Es el alias para el que subes la clave. Esta dirección de correo electrónico aparece en el encabezado From: del correo enviado con este alias.

El certificado de S/MIME y la clave privada deben estar presentes en el campo pkcs12 en ese formato. No se debe configurar ningún otro campo en la solicitud. El campo pkcs12 contiene la clave S/MIME del usuario y la cadena de certificados de firma. La API realiza validaciones estándar en este campo antes de aceptarlo y verifica lo siguiente:

  • El asunto coincide con la dirección de correo electrónico especificada.
  • Los vencimientos son válidos.
  • La autoridad certificadora (CA) emisora se encuentra en la lista de entidades de confianza de Google.
  • Los certificados cumplen con las restricciones técnicas de Gmail.

Si la clave está encriptada, la contraseña debe estar en el campo encryptedKeyPassword. Una llamada correcta al método settings.sendAs.smimeInfo.insert devuelve el recurso settings.sendAs.smimeInfo id que se usará para hacer referencia a la clave en el futuro.

Enumera las claves de S/MIME de un usuario

Usa el método settings.sendAs.smimeInfo.list en el recurso settings.sendAs.smimeInfo para mostrar la lista de claves de S/MIME del usuario y el alias especificados. Identifica el alias de destino con los siguientes parámetros de ruta:

  • userId: La dirección de correo electrónico del usuario. Usa el valor especial me para indicar el usuario autenticado.

  • sendAsEmail: Es el alias para el que se enumerarán las claves. Esta dirección de correo electrónico aparece en el encabezado From: del correo electrónico enviado con este alias.

Recupera las claves de S/MIME para un alias

Usa el método settings.sendAs.smimeInfo.get en el recurso settings.sendAs.smimeInfo para devolver las claves S/MIME específicas de un alias de envío como específico para un usuario. Identifica el alias de destino con los siguientes parámetros de ruta:

  • userId: La dirección de correo electrónico del usuario. Usa el valor especial me para indicar el usuario autenticado.

  • sendAsEmail: Es el alias para el que recuperas las claves. Esta dirección de correo electrónico aparece en el encabezado From: del correo enviado con este alias.

Borra una clave S/MIME

Usa el método settings.sendAs.smimeInfo.delete en el recurso settings.sendAs.smimeInfo para borrar la clave S/MIME especificada de un alias. Identifica el alias de destino con los siguientes parámetros de ruta:

  • userId: La dirección de correo electrónico del usuario. Usa el valor especial me para indicar el usuario autenticado.

  • sendAsEmail: Es el alias para el que borrarás las claves. Esta dirección de correo electrónico aparece en el encabezado From: del correo enviado con este alias.

  • id: Es el ID inmutable del smimeInfo.

Cómo establecer la clave S/MIME predeterminada para un alias

Usa el método settings.sendAs.smimeInfo.setDefault en el recurso settings.sendAs.smimeInfo para marcar la clave de S/MIME especificada como la predeterminada para el alias especificado. Identifica el alias de destino con los siguientes parámetros de ruta:

  • userId: La dirección de correo electrónico del usuario. Usa el valor especial me para indicar el usuario autenticado.

  • sendAsEmail: Es el alias para el que se establecerán las claves como predeterminadas. Esta dirección de correo electrónico aparece en el encabezado From: del correo enviado con este alias.

  • id: Es el ID inmutable del smimeInfo.

Muestras de código

En los siguientes ejemplos de código, se muestra cómo usar la API de Gmail para administrar certificados S/MIME para una organización con varios usuarios:

Crea un recurso smimeInfo para un certificado de S/MIME

En esta muestra de código, se muestra cómo leer un certificado de un archivo, codificarlo en una cadena Base64URL y asignarlo al campo pkcs12 del 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"))

Cómo subir un certificado de S/MIME

Para subir un certificado, llama al método settings.sendAs.smimeInfo.insert y proporciona el recurso settings.sendAs.smimeInfo en el cuerpo de la solicitud:

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

Administra los certificados de varios usuarios

En estas muestras de código, se muestra cómo administrar certificados para varios usuarios de una organización en una sola llamada por lotes:

Cómo insertar certificados desde un archivo CSV

A continuación, se muestra un ejemplo de un archivo CSV que enumera los IDs de usuario y la ruta de acceso al certificado de cada usuario:

$ 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

Puedes usar los ejemplos CreateSmimeInfo y InsertSmimeInfo para subir los certificados de los usuarios especificados en un archivo 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

Puedes usar las muestras create_smime_info y insert_smime_info para subir los certificados de los usuarios especificados en un archivo 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")

Administración de certificados

En esta muestra, se combinan varios métodos del recurso settings.sendAs.smimeInfo para mostrar cómo administrar los certificados de tu organización. Enumera los certificados del usuario. Si el certificado predeterminado venció o no está configurado, se sube el certificado que se encuentra en el archivo especificado. Luego, establece como predeterminado el certificado cuya fecha de vencimiento sea la más lejana.

Luego, esta función procesa un archivo CSV, de manera similar al ejemplo anterior de Insertar certificados desde un archivo 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,
  )