Mengelola Sertifikat S/MIME

Gmail S/MIME API menyediakan akses terprogram untuk mengelola sertifikat email S/MIME bagi pengguna di domain Google Workspace .

Administrator harus mengaktifkan S/MIME untuk domain agar sertifikat berfungsi.

Standar S/MIME menyediakan spesifikasi untuk enkripsi kunci publik dan penandatanganan data MIME. Mengonfigurasi sertifikat S/MIME di akun pengguna akan menyebabkan Gmail menggunakan sertifikat tersebut dengan cara berikut:

  • Gmail menggunakan sertifikat dan kunci pribadi pengguna untuk menandatangani email keluar.
  • Gmail menggunakan kunci pribadi pengguna untuk mendekripsi email masuk.
  • Gmail menggunakan sertifikat dan kunci publik penerima untuk mengenkripsi email keluar.
  • Gmail menggunakan sertifikat dan kunci publik pengirim untuk memverifikasi email masuk.

Anda membuat setiap sertifikat S/MIME dan menguploadnya menggunakan API. Setiap sertifikat S/MIME ditujukan untuk alias tertentu untuk akun email pengguna. Alias mencakup alamat email utama serta alamat "Kirim Sebagai" kustom. Satu sertifikat S/MIME ditandai sebagai default untuk setiap alias.

Memberi otorisasi akses API

Ada dua bentuk otorisasi akses ke API:

  1. Anda dapat menggunakan akun layanan dengan delegasi wewenang seluruh domain. Untuk penjelasan istilah ini, lihat Istilah ringkasan autentikasi dan otorisasi. Untuk mengetahui informasi tentang cara mengaktifkan opsi ini, lihat Membuat akun layanan dengan delegasi otoritas seluruh domain
  2. Anda dapat menggunakan alur OAuth2 standar yang memerlukan izin pengguna akhir untuk mendapatkan token akses Oauth2. Untuk informasi lebih lanjut, lihat Ringkasan autentikasi dan otorisasi Untuk menggunakan opsi ini, admin domain harus mengaktifkan kotak centang "Akses pengguna akhir S/MIME API diaktifkan" di panel kontrol Domain.

Cakupan ACL

API ini mengandalkan cakupan ACL yang sama dengan metode Gmail sendAs:

gmail.settings.basic
Cakupan ini diperlukan untuk memperbarui S/MIME SendAs utama.
gmail.settings.sharing
Cakupan ini diperlukan untuk memperbarui S/MIME kustom dari.

Menggunakan API

Resource users.settings.sendAs.smimeInfo menyediakan metode yang Anda gunakan untuk mengelola sertifikat S/MIME. Setiap sertifikat dikaitkan dengan satu alias send-as untuk pengguna.

Mengupload kunci S/MIME

Gunakan metode smimeInfo.insert() untuk mengupload kunci S/MIME baru untuk alias milik pengguna. Anda mengidentifikasi alias target menggunakan parameter berikut:

userId
Alamat email pengguna. Anda dapat menggunakan nilai khusus me untuk menunjukkan pengguna yang saat ini diautentikasi.
sendAsEmail
Alias yang kuncinya Anda upload. Ini adalah alamat email yang muncul di header "Dari:" untuk email yang dikirim menggunakan alias ini.

Sertifikat S/MIME dan kunci pribadi harus ada di kolom pkcs12 dalam format tersebut; tidak ada kolom lain yang harus ditetapkan dalam permintaan. Kolom PKCS12 diharapkan berisi kunci S/MIME pengguna dan rantai sertifikat penandatanganan. API melakukan validasi standar pada kolom ini sebelum menerimanya, dengan memverifikasi hal berikut:

  • Subjek cocok dengan alamat email yang ditentukan.
  • Masa berlaku valid.
  • Certificate authority (CA) penerbit ada dalam daftar tepercaya kami.
  • Sertifikat cocok dengan batasan teknis Gmail.

Jika kunci dienkripsi, sandi harus berada di kolom encryptedKeyPassword. Panggilan insert() yang berhasil akan menampilkan ID smimeInfo yang dapat digunakan untuk merujuk ke kunci pada masa mendatang.

Mencantumkan kunci S/MIME pengguna

Gunakan metode smimeInfo.list() untuk menampilkan daftar kunci S/MIME bagi pengguna tertentu untuk alias tertentu. Anda mengidentifikasi alias target menggunakan parameter berikut:

userId
Alamat email pengguna. Anda dapat menggunakan nilai khusus me untuk menunjukkan pengguna yang saat ini diautentikasi.
sendAsEmail
Alias yang akan mencantumkan kunci. Ini adalah alamat email yang muncul di header "Dari:" untuk email yang dikirim menggunakan alias ini.

Mengambil kunci S/MIME untuk alias

Gunakan metode smimeInfo.get() untuk menampilkan kunci S/MIME tertentu untuk alias send-as tertentu bagi pengguna. Anda mengidentifikasi alias target menggunakan parameter berikut:

userId
Alamat email pengguna. Anda dapat menggunakan nilai khusus me untuk menunjukkan pengguna yang saat ini diautentikasi.
sendAsEmail
Alias yang kuncinya Anda ambil. Ini adalah alamat email yang muncul di header "Dari:" untuk email yang dikirim menggunakan alias ini.

Menghapus kunci S/MIME

Gunakan metode smimeInfo.delete() untuk menghapus kunci S/MIME yang ditentukan dari alias. Anda mengidentifikasi alias target menggunakan parameter berikut:

userId
Alamat email pengguna. Anda dapat menggunakan nilai khusus me untuk menunjukkan pengguna yang saat ini diautentikasi.
sendAsEmail
Alias yang kuncinya Anda ambil. Ini adalah alamat email yang muncul di header "Dari:" untuk email yang dikirim menggunakan alias ini.
id
ID yang tidak dapat diubah untuk SmimeInfo.

Menetapkan kunci S/MIME default untuk alias

Gunakan metode smimeInfo.setDefault() untuk menandai kunci S/MIME yang ditentukan sebagai default untuk alias yang ditentukan. Anda mengidentifikasi alias target menggunakan parameter berikut:

userId
Alamat email pengguna. Anda dapat menggunakan nilai khusus me untuk menunjukkan pengguna yang saat ini diautentikasi.
sendAsEmail
Alias yang kuncinya Anda ambil. Ini adalah alamat email yang muncul di header "Dari:" untuk email yang dikirim menggunakan alias ini.
id
ID yang tidak dapat diubah untuk SmimeInfo.

Kode contoh

Contoh kode berikut menunjukkan penggunaan API untuk mengelola sertifikat S/MIME untuk organisasi dengan beberapa pengguna.

Membuat resource SmimeInfo untuk sertifikat S/MIME

Contoh kode berikut menunjukkan pembacaan sertifikat dari file, enkode ke string base64url, dan menetapkannya ke kolom pkcs12 dari resource 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"))

Mengupload sertifikat S/MIME

Untuk mengupload sertifikat, panggil smimeInfo.insert, dan berikan resource smimeInfo dalam isi permintaan:

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

Contoh untuk mengelola banyak sertifikat pengguna

Anda mungkin ingin mengelola sertifikat untuk banyak pengguna di organisasi sekaligus. Contoh berikut menunjukkan cara mengelola sertifikat untuk beberapa pengguna dalam satu panggilan batch.

Menyisipkan sertifikat dari file CSV

Misalnya, Anda memiliki file CSV yang mencantumkan ID pengguna dan jalur ke setiap sertifikat pengguna:

$ 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

Anda dapat menggunakan panggilan createSmimeInfo dan insertSmimeInfo dari sebelumnya untuk mengupload sertifikat seperti yang ditentukan dalam 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

Anda dapat menggunakan panggilan create_smime_info dan insert_smime_info dari sebelumnya untuk mengupload sertifikat seperti yang ditentukan dalam 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")

Pengelolaan sertifikat

Contoh ini menggabungkan beberapa panggilan dari smimeInfo API untuk menunjukkan cara mengelola sertifikat untuk organisasi Anda. Fungsi ini mencantumkan sertifikat untuk pengguna dan jika sertifikat default sudah tidak berlaku atau tidak ditetapkan, fungsi ini akan mengupload sertifikat yang ditemukan di file yang ditentukan. Kemudian, sertifikat yang masa berlakunya paling lama di masa mendatang akan ditetapkan sebagai default.

Fungsi ini kemudian dipanggil dari fungsi yang memproses file CSV seperti pada contoh sebelumnya.

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