Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

إدارة شهادات 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 مخصّصة لاسم مستعار معيّن لحساب بريد إلكتروني خاص بمستخدم. تشمل الأسماء المستعارة عنوان البريد الإلكتروني الأساسي وعناوين "الإرسال باسم" المخصّصة. تضع واجهة برمجة التطبيقات علامة على شهادة S/MIME واحدة باعتبارها الشهادة التلقائية لكل اسم مستعار.

لمزيد من المعلومات عن الأسماء المستعارة، يُرجى الاطّلاع على إدارة الأسماء المستعارة والتوقيعات باستخدام Gmail API.

السماح بالوصول إلى واجهة برمجة التطبيقات

للسماح بالوصول إلى Gmail API، استخدِم إحدى الطريقتَين التاليتَين:

استخدِم حساب خدمة مع تفويض السلطة على مستوى النطاق. للحصول على شرح لهذَين المصطلحَين، يُرجى الاطّلاع على مقالة لمحة عن المصادقة والترخيص. لتفعيل هذا الخيار، يُرجى الاطّلاع على مقالة إنشاء بيانات اعتماد الوصول.
استخدِم مسار OAuth 2.0 العادي الذي يتطلب موافقة المستخدم النهائي للحصول على رمز الدخول OAuth 2.0. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة لمحة عن المصادقة والترخيص.

لاستخدام هذا الخيار، على مشرف النطاق وضع علامة في مربّع الاختيار تفعيل تشفير S/MIME لإرسال الرسائل الإلكترونية واستلامها في "وحدة تحكّم المشرف في Google". لمزيد من المعلومات، يُرجى الاطّلاع على مقالة تفعيل S/MIME المُستضاف في "وحدة تحكّم المشرف في Google".

نطاقات قائمة التحكّم بالوصول

تعتمد Gmail API على نطاقات قائمة التحكّم بالوصول نفسها التي تستخدمها طرق sendAs في Gmail:

gmail.settings.basic: هذا النطاق مطلوب لتعديل S/MIME الأساسي لـ SendAs.
gmail.settings.sharing: هذا النطاق مطلوب لتعديل S/MIME المخصّص لـ from.

ضبط مفاتيح S/MIME

يوفّر المصدر settings.sendAs.smimeInfo عدة طرق لإدارة شهادات S/MIME. ترتبط كل شهادة باسم مستعار واحد لـ "الإرسال باسم" خاص بمستخدم.

لتحديد الأسماء المستعارة لـ "الإرسال باسم" الخاصة بمستخدم، استخدِم الـ settings.sendAs.list طريقة في الـ settings.sendAs مصدر.

تحميل مفتاح S/MIME

استخدِم طريقة settings.sendAs.smimeInfo.insert في مورد settings.sendAs.smimeInfoلتحميل مفتاح S/MIME جديد لاسم مستعار يخصّ مستخدمًا. حدِّد الاسم المستعار المستهدف باستخدام مَعلمات المسار التالية:

userId: عنوان البريد الإلكتروني للمستخدم استخدِم القيمة الخاصة me للإشارة إلى المستخدم الذي تم التحقّق من هويته.
sendAsEmail: الاسم المستعار الذي تحمِّل المفتاح له يظهر عنوان البريد الإلكتروني هذا في عنوان From: للرسائل الإلكترونية المُرسَلة باستخدام هذا الاسم المستعار.

يجب أن تكون شهادة S/MIME والمفتاح الخاص بتنسيق pkcs12 ، ويجب عدم ضبط أي حقول أخرى في الطلب. يحتوي حقل pkcs12 على كل من مفتاح S/MIME للمستخدم وسلسلة شهادات التوقيع. تُجري واجهة برمجة التطبيقات عمليات التحقّق العادية من هذا الحقل قبل قبوله، وتتحقّق من ما يلي:

يتطابق الموضوع مع عنوان البريد الإلكتروني المحدّد.
تكون تواريخ انتهاء الصلاحية صالحة.
تكون هيئة إصدار الشهادات (CA) ضمن قائمة Google الموثوق بها.
تتطابق الشهادات مع القيود الفنية في Gmail.

إذا كان المفتاح مشفّرًا، يجب أن تكون كلمة المرور في الـ encryptedKeyPassword حقل. تعرض استدعاءات طريقة 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 لاسم مستعار

استخدِم طريقة settings.sendAs.smimeInfo.get في مورد settings.sendAs.smimeInfoلعرض مفاتيح S/MIME المحدّدة لعنوان بريد إلكتروني بديل محدّد لـ "الإرسال باسم" خاص بمستخدم. حدِّد الاسم المستعار المستهدف باستخدام مَعلمات المسار التالية:

userId: عنوان البريد الإلكتروني للمستخدم استخدِم القيمة الخاصة me للإشارة إلى المستخدم الذي تم التحقّق من هويته.
sendAsEmail: الاسم المستعار الذي تستردّ المفاتيح له يظهر عنوان البريد الإلكتروني هذا في عنوان From: للرسائل الإلكترونية المُرسَلة باستخدام هذا الاسم المستعار.

حذف مفتاح S/MIME

استخدِم طريقة settings.sendAs.smimeInfo.delete في مورد settings.sendAs.smimeInfo لحذف مفتاح S/MIME المحدّد من اسم مستعار. حدِّد الاسم المستعار المستهدف باستخدام مَعلمات المسار التالية:

userId: عنوان البريد الإلكتروني للمستخدم استخدِم القيمة الخاصة me للإشارة إلى المستخدم الذي تم التحقّق من هويته.
sendAsEmail: الاسم المستعار الذي تحذف المفاتيح منه يظهر عنوان البريد الإلكتروني هذا في عنوان From: للرسائل الإلكترونية المُرسَلة باستخدام هذا الاسم المستعار.
id: رقم التعريف الثابت لـ smimeInfo

ضبط مفتاح S/MIME التلقائي لاسم مستعار

استخدِم طريقة 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:

جافا

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

لتحميل شهادة، استدعِ طريقة settings.sendAs.smimeInfo.insert وقدِّم مصدر settings.sendAs.smimeInfo في نص الـ طلب:

جافا

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

جافا

يمكنك استخدام 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، على غرار عينة التعليمات البرمجية السابقة إدراج الشهادات من ملف CSV.

جافا

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 تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

السماح بالوصول إلى واجهة برمجة التطبيقات

نطاقات قائمة التحكّم بالوصول

ضبط مفاتيح S/MIME

تحميل مفتاح S/MIME

عرض قائمة بمفاتيح S/MIME الخاصة بمستخدم

استرداد مفاتيح S/MIME لاسم مستعار

حذف مفتاح S/MIME

ضبط مفتاح S/MIME التلقائي لاسم مستعار

عيّنات تعليمات برمجية

إنشاء مصدر smimeInfo لشهادة S/MIME

جافا

Python

تحميل شهادة S/MIME

جافا

Python

إدارة شهادات مستخدمين متعددين

إدراج الشهادات من ملف CSV

جافا

Python

إدارة الشهادة

جافا

Python

مواضيع ذات صلة

إدارة شهادات S/MIME باستخدام Gmail API