ניהול אישורי S/MIME באמצעות Gmail API

במאמר הזה מוסבר איך להשתמש באישור אימייל של S/MIME ב-Gmail API.

‫Gmail API מספק גישה פרוגרמטית לניהול אישורים של אימיילים ב-S/MIME למשתמשים בדומיין Google Workspace.

כדי שהאישורים יפעלו, האדמין צריך להפעיל S/MIME מתארח עבור הדומיין.

תקן S/MIME מספק מפרט להצפנה של מפתח ציבורי ולחתימה של נתוני MIME. כשמגדירים אישורי S/MIME בחשבון משתמש, Gmail משתמש בהם בדרכים הבאות:

חתימה על אימייל יוצא באמצעות אישור המשתמש והמפתח הפרטי.
לפענח את האימייל הנכנס באמצעות המפתח הפרטי של המשתמש.
הצפנה של אימייל יוצא באמצעות האישור והמפתח הציבורי של הנמען.
מאמתים אימייל נכנס באמצעות האישור והמפתח הציבורי של השולח.

אתם יכולים ליצור אישורי S/MIME פרטניים ולהעלות אותם באמצעות Gmail API. כל אישור S/MIME מיועד לכינוי ספציפי של חשבון אימייל של משתמש. כינויים כוללים את כתובת האימייל הראשית וכתובות מותאמות אישית של 'שליחה בתור'. ה-API מסמן אישור S/MIME יחיד כברירת המחדל לכל כינוי.

מידע נוסף על כתובות אימייל חלופיות זמין במאמר ניהול כתובות אימייל חלופיות וחתימות באמצעות Gmail API.

אישור גישה ל-API

כדי לאשר גישה ל-Gmail API, משתמשים באחת מהשיטות הבאות:

להשתמש בחשבון שירות עם האצלת הרשאות גישה ברמת הדומיין. הסבר על המונחים האלה מופיע במאמר מידע על אימות והרשאה. הוראות להפעלת האפשרות הזו מופיעות במאמר בנושא יצירת פרטי גישה.
משתמשים בתהליך סטנדרטי של OAuth 2.0 שדורש הסכמה מהמשתמש כדי לקבל טוקן גישה מסוג OAuth 2.0. מידע נוסף זמין במאמר מידע על אימות והרשאה.

כדי להשתמש באפשרות הזו, האדמין של הדומיין צריך לסמן את התיבה הפעלת הצפנה באמצעות S/MIME לשליחה וקבלה של אימיילים במסוף Google Admin. מידע נוסף מופיע במאמר בנושא הפעלה של S/MIME מתארח במסוף Google Admin.

היקפים של רשימות ACL

‫Gmail API מסתמך על אותם היקפי ACL כמו שיטות Gmail sendAs:

‫gmail.settings.basic: ההיקף הזה נדרש לעדכון של S/MIME הראשי.SendAs
‫gmail.settings.sharing: ההיקף הזה נדרש לעדכון ה-S/MIME המותאם אישית של מ.

הגדרת מפתחות S/MIME

במשאב settings.sendAs.smimeInfo יש כמה שיטות לניהול אישורי S/MIME. כל אישור משויך לכינוי 'שליחה בשם' אחד של משתמש.

כדי לקבוע את הכינויים של משתמש לשליחה בשם, משתמשים ב-method ‏settings.sendAs.list במשאב settings.sendAs.

העלאת מפתח S/MIME

משתמשים ב-method‏ settings.sendAs.smimeInfo.insert במשאב settings.sendAs.smimeInfo כדי להעלות מפתח S/MIME חדש עבור כינוי ששייך למשתמש. מזהים את הכינוי של היעד באמצעות פרמטרים של נתיב:

‫userId: כתובת האימייל של המשתמש. משתמשים בערך המיוחד me כדי לציין את המשתמש המאומת.
‫sendAsEmail: הכינוי שעבורו מעלים את המפתח. כתובת האימייל הזו מופיעה בכותרת של From: עבור אימייל שנשלח באמצעות הכינוי הזה.

אישור ה-S/MIME והמפתח הפרטי צריכים להיות בפורמט הזה בשדה pkcs12. לא צריך להגדיר שדות אחרים בבקשה. השדה pkcs12 מכיל גם את מפתח ה-S/MIME של המשתמש וגם את שרשרת אישורי החתימה. ממשק ה-API מבצע אימותים רגילים בשדה הזה לפני שהוא מקבל אותו, ומוודא את הפרטים הבאים:

הנושא זהה לכתובת האימייל שצוינה.
זמני התפוגה תקינים.
רשות האישורים (CA) המנפיקה נמצאת ברשימת הרשויות המהימנות של Google.
האישורים תואמים למגבלות הטכניות של Gmail.

אם המפתח מוצפן, הסיסמה צריכה להיות בשדה encryptedKeyPassword. קריאה מוצלחת ל-method‏ settings.sendAs.smimeInfo.insert מחזירה את המשאב settings.sendAs.smimeInfo id שמשמש להתייחסות למפתח בעתיד.

הצגת רשימה של מפתחות S/MIME של משתמש

משתמשים בשיטה settings.sendAs.smimeInfo.list במשאב settings.sendAs.smimeInfo כדי להחזיר את רשימת מפתחות S/MIME של המשתמש שצוין עבור הכינוי שצוין. מזהים את הכינוי של היעד באמצעות פרמטרים של נתיב:

‫userId: כתובת האימייל של המשתמש. משתמשים בערך המיוחד me כדי לציין את המשתמש המאומת.
‫sendAsEmail: הכינוי שעבורו רוצים להציג את רשימת המפתחות. כתובת האימייל הזו מופיעה בכותרת From: של אימיילים שנשלחים באמצעות הכינוי הזה.

שליפת מפתחות S/MIME של כתובת אימייל חלופית

משתמשים ב-method‏ settings.sendAs.smimeInfo.get במשאב settings.sendAs.smimeInfo כדי להחזיר את מפתחות ה-S/MIME הספציפיים עבור כינוי ספציפי של משתמש לשליחת אימייל. מזהים את הכינוי של היעד באמצעות פרמטרים של נתיב:

‫userId: כתובת האימייל של המשתמש. משתמשים בערך המיוחד me כדי לציין את המשתמש המאומת.
‫sendAsEmail: הכינוי שממנו מאחזרים את המפתחות. כתובת האימייל הזו מופיעה בכותרת של From: עבור אימייל שנשלח באמצעות הכינוי הזה.

מחיקה של מפתח S/MIME

משתמשים ב-method‏ settings.sendAs.smimeInfo.delete במשאב settings.sendAs.smimeInfo כדי למחוק את מפתח ה-S/MIME שצוין מכינוי. מזהים את הכינוי של היעד באמצעות הפרמטרים הבאים של נתיב:

‫userId: כתובת האימייל של המשתמש. משתמשים בערך המיוחד me כדי לציין את המשתמש המאומת.
‫sendAsEmail: הכינוי שממנו רוצים למחוק את המפתחות. כתובת האימייל הזו מופיעה בכותרת של From: עבור אימייל שנשלח באמצעות הכינוי הזה.
‫id: המזהה הקבוע של smimeInfo.

הגדרת מפתח S/MIME שמשמש כברירת מחדל לכתובת אימייל חלופית

משתמשים ב-method‏ settings.sendAs.smimeInfo.setDefault במשאב settings.sendAs.smimeInfo כדי לסמן את מפתח ה-S/MIME שצוין כמפתח ברירת המחדל עבור הכינוי שצוין. מזהים את הכינוי של היעד באמצעות פרמטרים של נתיב:

‫userId: כתובת האימייל של המשתמש. משתמשים בערך המיוחד me כדי לציין את המשתמש המאומת.
‫sendAsEmail: הכינוי שעבורו רוצים להגדיר מפתחות כברירת מחדל. כתובת האימייל הזו מופיעה בכותרת של From: עבור אימייל שנשלח באמצעות הכינוי הזה.
‫id: המזהה הקבוע של smimeInfo.

רק מפתח S/MIME אחד מוגדר כברירת מחדל עבור `SendAs` של משתמש. הפעלת השיטה settings.sendAs.smimeInfo.setDefault מבטלת את ברירת המחדל הקודמת.

כשמתקבלות הודעות S/MIME שחתומות באמצעות מפתח מסוים, ‫Gmail משייך את המפתח לתאריך התוקף הכי רחוק בעתיד כברירת המחדל כשמצפינים אימייל שנשלח למשתמש המשויך.not_before כדי לוודא שמשתמשי Gmail שהמשתמש כבר תקשר איתם ישתמשו במפתח ברירת המחדל החדש, צריך לוודא שתאריך התפוגה של מפתח ברירת המחדל החדש מאוחר יותר מזה של מפתח ברירת המחדל הקודם, או לבטל את מפתח ברירת המחדל הקודם.not_before

דוגמאות קוד

בדוגמאות הקוד הבאות אפשר לראות איך משתמשים ב-Gmail API כדי לנהל אישורי S/MIME בארגון עם כמה משתמשים:

יצירת משאב smimeInfo לאישור S/MIME

בדוגמת הקוד הזו מוצג איך לקרוא אישור מקובץ, לקודד אותו למחרוזת Base64URL ולהקצות אותו לשדה pkcs12 במשאב settings.sendAs.smimeInfo:

Java

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

הצגת הקוד ב-GitHub

import com.google.api.services.gmail.model.SmimeInfo;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Base64;

/* Class to demonstrate the use of Gmail Create SmimeInfo API */
public class CreateSmimeInfo {
  /**
   * Create an SmimeInfo resource for a certificate from file.
   *
   * @param filename Name of the file containing the S/MIME certificate.
   * @param password Password for the certificate file, or null if the file is not
   *                 password-protected.
   * @return An SmimeInfo object with the specified certificate.
   */
  public static SmimeInfo createSmimeInfo(String filename, String password) {
    SmimeInfo smimeInfo = null;
    InputStream in = null;

    try {
      File file = new File(filename);
      in = new FileInputStream(file);
      byte[] fileContent = new byte[(int) file.length()];
      in.read(fileContent);

      smimeInfo = new SmimeInfo();
      smimeInfo.setPkcs12(Base64.getUrlEncoder().encodeToString(fileContent));
      if (password != null && password.length() > 0) {
        smimeInfo.setEncryptedKeyPassword(password);
      }
    } catch (Exception e) {
      System.out.printf("An error occured while reading the certificate file: %s\n", e);
    } finally {
      try {
        if (in != null) {
          in.close();
        }
      } catch (IOException ioe) {
        System.out.printf("An error occured while closing the input stream: %s\n", ioe);
      }
    }
    return smimeInfo;
  }
}

Python

gmail/snippet/smime snippets/create_smime_info.py

הצגת הקוד ב-GitHub

import base64


def create_smime_info(cert_filename, cert_password):
  """Create an smimeInfo resource for a certificate from file.
  Args:
    cert_filename: Name of the file containing the S/MIME certificate.
    cert_password: Password for the certificate file, or None if the file is not
        password-protected.
  Returns : Smime object, including smime information
  """

  smime_info = None
  try:
    with open(cert_filename, "rb") as cert:
      smime_info = {}
      data = cert.read().encode("UTF-8")
      smime_info["pkcs12"] = base64.urlsafe_b64encode(data).decode()
      if cert_password and len(cert_password) > 0:
        smime_info["encryptedKeyPassword"] = cert_password

  except (OSError, IOError) as error:
    print(f"An error occurred while reading the certificate file: {error}")
    smime_info = None

  return smime_info


if __name__ == "__main__":
  print(create_smime_info(cert_filename="xyz", cert_password="xyz"))

העלאת אישור S/MIME

כדי להעלות אישור, צריך לבצע קריאה ל-method‏ settings.sendAs.smimeInfo.insert ולספק את משאב settings.sendAs.smimeInfo בגוף הבקשה:

Java

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

הצגת הקוד ב-GitHub

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.SmimeInfo;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;

/* Class to demonstrate the use of Gmail Insert Smime Certificate API*/
public class InsertSmimeInfo {
  /**
   * Upload an S/MIME certificate for the user.
   *
   * @param userId      User's email address.
   * @param sendAsEmail The "send as" email address, or null if it should be the same as userId.
   * @param smimeInfo   The SmimeInfo object containing the user's S/MIME certificate.
   * @return An SmimeInfo object with details about the uploaded certificate, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static SmimeInfo insertSmimeInfo(String userId,
                                          String sendAsEmail,
                                          SmimeInfo smimeInfo)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_SHARING);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    if (sendAsEmail == null) {
      sendAsEmail = userId;
    }

    try {
      SmimeInfo results = service.users().settings().sendAs().smimeInfo()
          .insert(userId, sendAsEmail, smimeInfo)
          .execute();
      System.out.printf("Inserted certificate, id: %s\n", results.getId());
      return results;
    } catch (IOException e) {
      System.err.printf("An error occured: %s", e);
    }
    return null;
  }
}

Python

gmail/snippet/smime snippets/insert_smime_info.py

הצגת הקוד ב-GitHub

import create_smime_info
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def insert_smime_info():
  """Upload an S/MIME certificate for the user.
  Print the inserted certificate's id
  Returns : Result object with inserted certificate id and other meta-data

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    user_id = "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()

ניהול אישורים של כמה משתמשים

בדוגמאות הקוד האלה אפשר לראות איך לנהל אישורים של כמה משתמשים בארגון באמצעות קריאה אחת של קבוצת משתמשים:

הוספת אישורים מקובץ CSV

זוהי דוגמה לקובץ CSV שכולל רשימה של מזהי משתמשים והנתיב לכל אישור משתמש:

$ 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

אפשר להשתמש בדוגמאות של CreateSmimeInfo ושל InsertSmimeInfo כדי להעלות את האישורים של המשתמשים שמצוינים בקובץ CSV:

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

הצגת הקוד ב-GitHub

import com.google.api.services.gmail.model.SmimeInfo;
import java.io.File;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVParser;
import org.apache.commons.csv.CSVRecord;

/* Class to demonstrate the use of Gmail Insert Certificate from CSV File */
public class InsertCertFromCsv {
  /**
   * Upload S/MIME certificates based on the contents of a CSV file.
   *
   * <p>Each row of the CSV file should contain a user ID, path to the certificate, and the
   * certificate password.
   *
   * @param csvFilename Name of the CSV file.
   */
  public static void insertCertFromCsv(String csvFilename) {
    try {
      File csvFile = new File(csvFilename);
      CSVParser parser =
          CSVParser.parse(csvFile, java.nio.charset.StandardCharsets.UTF_8, CSVFormat.DEFAULT);
      for (CSVRecord record : parser) {
        String userId = record.get(0);
        String certFilename = record.get(1);
        String certPassword = record.get(2);
        SmimeInfo smimeInfo = CreateSmimeInfo.createSmimeInfo(certFilename,
            certPassword);
        if (smimeInfo != null) {
          InsertSmimeInfo.insertSmimeInfo(userId,
              userId,
              smimeInfo);
        } else {
          System.err.printf("Unable to read certificate file for userId: %s\n", userId);
        }
      }
    } catch (Exception e) {
      System.err.printf("An error occured while reading the CSV file: %s", e);
    }
  }
}

Python

אתם יכולים להשתמש בדוגמאות של create_smime_info ושל insert_smime_info כדי להעלות את האישורים של המשתמשים שצוינו בקובץ CSV:

gmail/snippet/smime snippets/insert_cert_from_csv.py

הצגת הקוד ב-GitHub

import csv

import create_smime_info
import insert_smime_info


def insert_cert_from_csv(csv_filename):
  """Upload S/MIME certificates based on the contents of a CSV file.
  Each row of the CSV file should contain a user ID, path to the certificate,
  and the certificate password.

  Args:
    csv_filename: Name of the CSV file.
  """

  try:
    with open(csv_filename, "rb") as cert:
      csv_reader = csv.reader(cert, delimiter=",")
      next(csv_reader, None)  # skip CSV file header
      for row in csv_reader:
        user_id = row[0]
        cert_filename = row[1]
        cert_password = row[2]
        smime_info = create_smime_info.create_smime_info(
            cert_filename=cert_filename, cert_password=cert_password
        )
        if smime_info:
          insert_smime_info.insert_smime_info()
        else:
          print(f"Unable to read certificate file for user_id: {user_id}")
        return smime_info

  except (OSError, IOError) as error:
    print(f"An error occured while reading the CSV file: {error}")


if __name__ == "__main__":
  insert_cert_from_csv(csv_filename="xyz")

ניהול אישורים

בדוגמה הזו משולבות כמה שיטות מהמקור settings.sendAs.smimeInfo כדי להראות איך לנהל אישורים בארגון. מוצגת רשימה של האישורים של המשתמש. אם תוקף אישור ברירת המחדל פג או שהוא לא מוגדר, המערכת מעלה את האישור שנמצא בקובץ שצוין. לאחר מכן, המערכת מגדירה את האישור שתוקף שלו יפוג הכי מאוחר כברירת מחדל.

הפונקציה הזו מעבדת קובץ CSV, בדומה לדוגמה הקודמת Insert certificates from a CSV file.

Java

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

הצגת הקוד ב-GitHub

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.ListSmimeInfoResponse;
import com.google.api.services.gmail.model.SmimeInfo;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;

/* Class to demonstrate the use of Gmail Update Smime Certificate API*/
public class UpdateSmimeCerts {
  /**
   * Update S/MIME certificates for the user.
   *
   * <p>First performs a lookup of all certificates for a user. If there are no certificates, or
   * they all expire before the specified date/time, uploads the certificate in the specified file.
   * If the default certificate is expired or there was no default set, chooses the certificate with
   * the expiration furthest into the future and sets it as default.
   *
   * @param userId       User's email address.
   * @param sendAsEmail  The "send as" email address, or None if it should be the same as user_id.
   * @param certFilename Name of the file containing the S/MIME certificate.
   * @param certPassword Password for the certificate file, or None if the file is not
   *                     password-protected.
   * @param expireTime   DateTime object against which the certificate expiration is compared. If
   *                     None, uses the current time. @ returns: The ID of the default certificate.
   * @return The ID of the default certificate, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static String updateSmimeCerts(String userId,
                                        String sendAsEmail,
                                        String certFilename,
                                        String certPassword,
                                        LocalDateTime expireTime)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_SHARING);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    if (sendAsEmail == null) {
      sendAsEmail = userId;
    }

    ListSmimeInfoResponse listResults;
    try {
      listResults =
          service.users().settings().sendAs().smimeInfo().list(userId, sendAsEmail).execute();
    } catch (IOException e) {
      System.err.printf("An error occurred during list: %s\n", e);
      return null;
    }

    String defaultCertId = null;
    String bestCertId = null;
    LocalDateTime bestCertExpire = LocalDateTime.MIN;

    if (expireTime == null) {
      expireTime = LocalDateTime.now();
    }
    if (listResults != null && listResults.getSmimeInfo() != null) {
      for (SmimeInfo smimeInfo : listResults.getSmimeInfo()) {
        String certId = smimeInfo.getId();
        boolean isDefaultCert = smimeInfo.getIsDefault();
        if (isDefaultCert) {
          defaultCertId = certId;
        }
        LocalDateTime exp =
            LocalDateTime.ofInstant(
                Instant.ofEpochMilli(smimeInfo.getExpiration()), ZoneId.systemDefault());
        if (exp.isAfter(expireTime)) {
          if (exp.isAfter(bestCertExpire)) {
            bestCertId = certId;
            bestCertExpire = exp;
          }
        } else {
          if (isDefaultCert) {
            defaultCertId = null;
          }
        }
      }
    }
    if (defaultCertId == null) {
      String defaultId = bestCertId;
      if (defaultId == null && certFilename != null) {
        SmimeInfo smimeInfo = CreateSmimeInfo.createSmimeInfo(certFilename,
            certPassword);
        SmimeInfo insertResults = InsertSmimeInfo.insertSmimeInfo(userId,
            sendAsEmail,
            smimeInfo);
        if (insertResults != null) {
          defaultId = insertResults.getId();
        }
      }

      if (defaultId != null) {
        try {
          service.users().settings().sendAs().smimeInfo().setDefault(userId, sendAsEmail, defaultId)
              .execute();
          return defaultId;
        } catch (IOException e) {
          System.err.printf("An error occured during setDefault: %s", e);
        }
      }
    } else {
      return defaultCertId;
    }

    return null;
  }
}

Python

gmail/snippet/smime snippets/update_smime_cert.py

הצגת הקוד ב-GitHub

from datetime import datetime

import create_smime_info
import google.auth
import insert_smime_info
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def update_smime_cert(
    user_id, send_as_email, cert_filename, cert_password, expire_dt
):
  """Update S/MIME certificates for the user.

  First performs a lookup of all certificates for a user.  If there are no
  certificates, or they all expire before the specified date/time, uploads the
  certificate in the specified file.  If the default certificate is expired or
  there was no default set, chooses the certificate with the expiration furthest
  into the future and sets it as default.

  Args:
    user_id: User's email address.
    send_as_email: The "send as" email address, or None if it should be the same
        as user_id.
    cert_filename: Name of the file containing the S/MIME certificate.
    cert_password: Password for the certificate file, or None if the file is not
        password-protected.
    expire_dt: DateTime object against which the certificate expiration is
      compared.  If None, uses the current time.

  Returns:
    The ID of the default certificate.

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  if not send_as_email:
    send_as_email = user_id

  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    # pylint: disable=maybe-no-member
    results = (
        service.users()
        .settings()
        .sendAs()
        .smimeInfo()
        .list(userId=user_id, sendAsEmail=send_as_email)
        .execute()
    )

  except HttpError as error:
    print(f"An error occurred during list: {error}")
    return None

  default_cert_id = None
  best_cert_id = (None, datetime.datetime.fromtimestamp(0))

  if not expire_dt:
    expire_dt = datetime.datetime.now()
  if results and "smimeInfo" in results:
    for smime_info in results["smimeInfo"]:
      cert_id = smime_info["id"]
      is_default_cert = smime_info["isDefault"]
      if is_default_cert:
        default_cert_id = cert_id
      exp = datetime.datetime.fromtimestamp(smime_info["expiration"] / 1000)
      if exp > expire_dt:
        if exp > best_cert_id[1]:
          best_cert_id = (cert_id, exp)
      else:
        if is_default_cert:
          default_cert_id = None

  if not default_cert_id:
    default_id = best_cert_id[0]
    if not default_id and cert_filename:
      create_smime_info.create_smime_info(
          cert_filename=cert_filename, cert_password=cert_password
      )
      results = insert_smime_info.insert_smime_info()
      if results:
        default_id = results["id"]

    if default_id:
      try:
        # pylint: disable=maybe-no-member
        service.users().settings().sendAs().smimeInfo().setDefault(
            userId=user_id, sendAsEmail=send_as_email, id=default_id
        ).execute()
        return default_id
      except HttpError as error:
        print(f"An error occurred during setDefault: {error}")
  else:
    return default_cert_id

  return None


if __name__ == "__main__":
  update_smime_cert(
      user_id="xyz",
      send_as_email=None,
      cert_filename="xyz",
      cert_password="xyz",
      expire_dt=None,
  )

ניהול אישורי S/MIME באמצעות Gmail API קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

אישור גישה ל-API

היקפים של רשימות ACL

הגדרת מפתחות S/MIME

העלאת מפתח S/MIME

הצגת רשימה של מפתחות S/MIME של משתמש

שליפת מפתחות S/MIME של כתובת אימייל חלופית

מחיקה של מפתח S/MIME

הגדרת מפתח S/MIME שמשמש כברירת מחדל לכתובת אימייל חלופית

דוגמאות קוד

יצירת משאב smimeInfo לאישור S/MIME

Java

Python

העלאת אישור S/MIME

Java

Python

ניהול אישורים של כמה משתמשים

הוספת אישורים מקובץ CSV

Java

Python

ניהול אישורים

Java

Python

נושאים קשורים

ניהול אישורי S/MIME באמצעות Gmail API