דף זה תורגם על ידי Cloud Translation API.

ניהול אישורי S/MIME

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

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

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

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

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

מתן הרשאה לגישה ל-API

יש שתי דרכים לאשר גישה ל-API:

אפשר להשתמש בחשבון שירות עם הענקת הרשאות גישה ברמת הדומיין. הסבר על המונחים האלה מופיע במאמר סקירה כללית על מונחים שקשורים לאימות ולהרשאה. מידע על הפעלת האפשרות הזו זמין במאמר יצירת חשבון שירות עם הענקת גישה ברמת הדומיין
אתם יכולים להשתמש בתהליך OAuth2 רגיל שדורש הסכמה של משתמש הקצה כדי לקבל אסימון גישה של Oauth2. מידע נוסף זמין במאמר בנושא סקירה כללית על אימות והרשאה. כדי להשתמש באפשרות הזו, אדמין הדומיין צריך לסמן את התיבה 'הפעלת גישת משתמשי קצה ל-S/MIME API' בלוח הבקרה של הדומיין.

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

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

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

שימוש ב-API

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

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

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

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

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

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

אם המפתח מוצפן, הסיסמה צריכה להיות בשדה encryptedKeyPassword. קריאות מוצלחות ל-insert() יחזירו את המזהה של smimeInfo, שאפשר להשתמש בו כדי להתייחס למפתח בעתיד.

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

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

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

שליפת מפתחות S/MIME עבור כינוי

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

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

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

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

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

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

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

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

רק מפתח S/MIME אחד יכול להיות ברירת המחדל עבור משתמש ב-SendAs: קריאה ל-setDefault() תבטל את ברירת המחדל הקודמת.

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

קוד לדוגמה

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

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

בדוגמת הקוד הבאה מוצגת קריאה של אישור מקובץ, קידוד למחרוזת base64url והקצאה לשדה pkcs12 של משאב 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

כדי להעלות אישור, קוראים לשיטה smimeInfo.insert ומספקים את משאב 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")

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

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

לאחר מכן, הפונקציה הזו נקראת מפונקציה שמבצעת עיבוד של קובץ CSV, כמו בדוגמה הקודמת.

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 קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

מתן הרשאה לגישה ל-API

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

שימוש ב-API

העלאת מפתח 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