Gestione dei certificati S/MIME

L'API Gmail S/MIME fornisce l'accesso programmatico per gestire i certificati email S/MIME per gli utenti di un dominio Google Workspace .

Affinché i certificati funzionino, un amministratore deve attivare S/MIME per il dominio.

Lo standard S/MIME fornisce una specifica per la crittografia e la firma con chiave pubblica dei dati MIME. La configurazione dei certificati S/MIME nell'account di un utente fa sì che Gmail utilizzi il certificato nei seguenti modi:

  • Gmail utilizza il certificato e la chiave privata dell'utente per firmare la posta in uscita.
  • Gmail utilizza la chiave privata dell'utente per decriptare la posta in arrivo.
  • Gmail utilizza il certificato e la chiave pubblica del destinatario per criptare la posta in uscita.
  • Gmail utilizza il certificato e la chiave pubblica del mittente per verificare la posta in arrivo.

Generi singoli certificati S/MIME e li carichi utilizzando l'API. Ogni certificato S/MIME è per un alias specifico di un account email utente. Gli alias includono l'indirizzo email principale e gli indirizzi "Invia come" personalizzati. Un singolo certificato S/MIME viene contrassegnato come predefinito per ogni alias.

Autorizzazione dell'accesso all'API

Esistono due modi per autorizzare l'accesso all'API:

  1. Puoi utilizzare un service account con delega dell'autorità a livello di dominio. Per una spiegazione di questi termini, consulta la pagina Termini della panoramica di autenticazione e autorizzazione. Per informazioni su come attivare questa opzione, consulta Creare un service account con delega dell'autorità a livello di dominio
  2. Puoi utilizzare un flusso OAuth2 standard che richiede il consenso dell'utente finale per ottenere un token di accesso OAuth2. Per ulteriori informazioni, consulta la Panoramica di autenticazione e autorizzazione. Per utilizzare questa opzione, l'amministratore di dominio deve attivare la casella di controllo "Accesso utente finale API S/MIME attivato" nel pannello di controllo del dominio.

Ambiti ACL

Questa API si basa sugli stessi ambiti ACL dei metodi Gmail sendAs:

gmail.settings.basic
Questo ambito è necessario per aggiornare S/MIME Invia come principale.
gmail.settings.sharing
Questo ambito è necessario per aggiornare la crittografia S/MIME da quella personalizzata.

Utilizzo dell'API

La risorsa users.settings.sendAs.smimeInfo fornisce i metodi che utilizzi per gestire i certificati S/MIME. Ogni certificato è associato a un alias Invia come per un utente.

Caricare una chiave S/MIME

Utilizza il metodo smimeInfo.insert() per caricare una nuova chiave S/MIME per un alias appartenente a un utente. Identifica l'alias del target utilizzando i seguenti parametri:

userId
L'indirizzo email dell'utente. Puoi utilizzare il valore speciale me per indicare l'utente attualmente autenticato.
sendAsEmail
L'alias per cui stai caricando la chiave. Questo è l'indirizzo email visualizzato nell'intestazione "Da:" per la posta inviata utilizzando questo alias.

Il certificato S/MIME e la chiave privata devono essere presenti nel campo pkcs12 in questo formato; nessun altro campo deve essere impostato nella richiesta. Il campo PKCS12 deve contenere sia la chiave S/MIME dell'utente sia la catena di certificati di firma. L'API esegue convalide standard su questo campo prima di accettarlo, verificando quanto segue:

  • L'oggetto corrisponde all'indirizzo email specificato.
  • Le scadenze sono valide.
  • L'autorità di certificazione (CA) che lo ha emesso è presente nel nostro elenco di CA attendibili.
  • I certificati corrispondono ai vincoli tecnici di Gmail.

Se la chiave è criptata, la password deve essere nel campo encryptedKeyPassword. Le chiamate insert() riuscite restituiranno l'ID di smimeInfo che può essere utilizzato per fare riferimento alla chiave in futuro.

Elenca le chiavi S/MIME di un utente

Utilizza il metodo smimeInfo.list() per restituire l'elenco delle chiavi S/MIME per l'utente specificato per l'alias specificato. Identifica l'alias del target utilizzando i seguenti parametri:

userId
L'indirizzo email dell'utente. Puoi utilizzare il valore speciale me per indicare l'utente attualmente autenticato.
sendAsEmail
L'alias per cui elencare le chiavi. Questo è l'indirizzo email visualizzato nell'intestazione "Da:" per la posta inviata utilizzando questo alias.

Recuperare le chiavi S/MIME per un alias

Utilizza il metodo smimeInfo.get() per restituire le chiavi S/MIME specifiche per un alias Invia come specifico per un utente. Identifica l'alias del target utilizzando i seguenti parametri:

userId
L'indirizzo email dell'utente. Puoi utilizzare il valore speciale me per indicare l'utente attualmente autenticato.
sendAsEmail
L'alias per cui stai recuperando le chiavi. Questo è l'indirizzo email visualizzato nell'intestazione "Da:" per la posta inviata utilizzando questo alias.

Eliminare una chiave S/MIME

Utilizza il metodo smimeInfo.delete() per eliminare la chiave S/MIME specificata da un alias. Identifica l'alias del target utilizzando i seguenti parametri:

userId
L'indirizzo email dell'utente. Puoi utilizzare il valore speciale me per indicare l'utente attualmente autenticato.
sendAsEmail
L'alias per cui stai recuperando le chiavi. Questo è l'indirizzo email visualizzato nell'intestazione "Da:" per la posta inviata utilizzando questo alias.
id
L'ID non modificabile per SmimeInfo.

Impostare la chiave S/MIME predefinita per un alias

Utilizza il metodo smimeInfo.setDefault() per contrassegnare la chiave S/MIME specificata come predefinita per l'alias specificato. Identifica l'alias del target utilizzando i seguenti parametri:

userId
L'indirizzo email dell'utente. Puoi utilizzare il valore speciale me per indicare l'utente attualmente autenticato.
sendAsEmail
L'alias per cui stai recuperando le chiavi. Questo è l'indirizzo email visualizzato nell'intestazione "Da:" per la posta inviata utilizzando questo alias.
id
L'ID non modificabile per SmimeInfo.

Codice di esempio

I seguenti esempi di codice mostrano l'utilizzo dell'API per gestire i certificati S/MIME per un'organizzazione con più utenti.

Creazione di una risorsa SmimeInfo per un certificato S/MIME

Il seguente esempio di codice mostra la lettura di un certificato da un file, la codifica in una stringa base64url e l'assegnazione al campo pkcs12 della risorsa 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"))

Caricare un certificato S/MIME

Per caricare un certificato, chiama smimeInfo.insert e fornisci la risorsa smimeInfo nel corpo della richiesta:

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

Esempi di gestione dei certificati di molti utenti

Potresti voler gestire i certificati per molti utenti dell'organizzazione contemporaneamente. Gli esempi seguenti mostrano come gestire i certificati per più utenti in una singola chiamata batch.

Inserimento di certificati da un file CSV

Supponiamo di avere un file CSV che elenca gli ID utente e il percorso del certificato di ciascun utente:

$ 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

Puoi utilizzare le chiamate createSmimeInfo e insertSmimeInfo precedenti per caricare i certificati come specificato nel file 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

Puoi utilizzare le chiamate create_smime_info e insert_smime_info precedenti per caricare i certificati come specificato nel file 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")

Gestione dei certificati

Questo esempio combina diverse chiamate dall'API smimeInfo per mostrare come potresti gestire i certificati per la tua organizzazione. Elenca i certificati per l'utente e, se il certificato predefinito è scaduto o non è impostato, carica il certificato trovato nel file specificato. Quindi imposta come predefinito il certificato con scadenza più lontana nel futuro.

Viene quindi chiamato da una funzione che elabora un file CSV come nell'esempio precedente.

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