این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

مدیریت گواهی‌های S/MIME با Gmail API

این سند نحوه استفاده از گواهی‌های ایمیل S/MIME را در API جیمیل توضیح می‌دهد.

رابط برنامه‌نویسی کاربردی (API) جیمیل، دسترسی برنامه‌نویسی‌شده برای مدیریت گواهی‌های ایمیل S/MIME را برای کاربران در دامنه‌ی Google Workspace فراهم می‌کند.

برای اینکه گواهی‌ها کار کنند، مدیر باید Hosted S/MIME را برای دامنه فعال کند .

استاندارد S/MIME مشخصاتی را برای رمزگذاری کلید عمومی و امضای داده‌های MIME ارائه می‌دهد. هنگامی که گواهی‌های S/MIME در یک حساب کاربری پیکربندی می‌شوند، Gmail از آنها به روش‌های زیر استفاده می‌کند:

ایمیل‌های خروجی را با گواهی کاربر و کلید خصوصی امضا کنید.
رمزگشایی ایمیل‌های دریافتی با کلید خصوصی کاربر.
ایمیل‌های خروجی را با گواهی گیرنده و کلید عمومی رمزگذاری کنید.
ایمیل دریافتی را با گواهی فرستنده و کلید عمومی تأیید کنید.

شما می‌توانید گواهی‌های S/MIME جداگانه تولید کنید و آنها را با استفاده از API جیمیل آپلود کنید. هر گواهی S/MIME برای یک نام مستعار خاص برای یک حساب ایمیل کاربر است. نام‌های مستعار شامل آدرس ایمیل اصلی و آدرس‌های سفارشی "ارسال به عنوان" هستند. API یک گواهی S/MIME واحد را به عنوان پیش‌فرض برای هر نام مستعار علامت‌گذاری می‌کند.

برای اطلاعات بیشتر در مورد نام‌های مستعار، به مدیریت نام‌های مستعار و امضاها با Gmail API مراجعه کنید.

دسترسی API را مجاز کنید

برای اجازه دسترسی به API جیمیل، از یکی از روش‌های زیر استفاده کنید:

از یک حساب کاربری سرویس با تفویض اختیار در سطح دامنه استفاده کنید. برای توضیح این اصطلاحات، به «درباره احراز هویت و مجوز» اطلاعات کسب کنید. برای فعال کردن این گزینه، به «ایجاد اعتبارنامه‌های دسترسی» مراجعه کنید.
از یک جریان استاندارد OAuth 2.0 استفاده کنید که برای دریافت توکن دسترسی OAuth 2.0 نیاز به رضایت کاربر نهایی دارد. برای اطلاعات بیشتر، به بخش «درباره احراز هویت و مجوز بیشتر بدانید» مراجعه کنید.
برای استفاده از این گزینه، مدیر دامنه باید کادر فعال کردن رمزگذاری S/MIME برای ارسال و دریافت ایمیل‌ها را در کنسول مدیریت گوگل انتخاب کند. برای اطلاعات بیشتر، به بخش فعال کردن رمزگذاری میزبانی‌شده S/MIME در کنسول مدیریت گوگل خود مراجعه کنید.

دامنه‌های ACL

API جیمیل به همان محدوده‌های ACL که متدهای sendAs جیمیل از آن استفاده می‌کنند، متکی است:

gmail.settings.basic : این scope برای به‌روزرسانی SendAs S/MIME اصلی مورد نیاز است.
gmail.settings.sharing : این دامنه برای به‌روزرسانی سفارشی از S/MIME مورد نیاز است.

پیکربندی کلیدهای S/MIME

منبع settings.sendAs.smimeInfo چندین روش برای مدیریت گواهی‌های S/MIME ارائه می‌دهد. هر گواهی با یک نام مستعار send-as برای یک کاربر مرتبط است.

برای تعیین نام‌های مستعار ارسالی برای یک کاربر، از متد 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 کاربر و زنجیره گواهی امضا است. API قبل از پذیرش این فیلد، اعتبارسنجی‌های استاندارد را روی آن انجام می‌دهد و موارد زیر را تأیید می‌کند:

موضوع با آدرس ایمیل مشخص شده مطابقت دارد.
تاریخ انقضا معتبر است.
مرجع صدور گواهی (CA) در فهرست مورد اعتماد گوگل قرار دارد.
این گواهینامه‌ها با محدودیت‌های فنی جیمیل مطابقت دارند.

اگر کلید رمزگذاری شده باشد، رمز عبور باید در فیلد encryptedKeyPassword باشد. فراخوانی موفقیت‌آمیز متد settings.sendAs.smimeInfo.insert id منبع settings.sendAs.smimeInfo را که برای ارجاع به کلید در آینده استفاده می‌شود، برمی‌گرداند.

فهرست کردن کلیدهای 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 خاص برای یک نام مستعار send-as خاص برای یک کاربر استفاده کنید. نام مستعار هدف را با استفاده از پارامترهای مسیر زیر شناسایی کنید:

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 دیرتر از کلید پیش‌فرض قبلی باشد یا کلید پیش‌فرض قبلی را لغو کنید.

نمونه‌های کد

نمونه‌های کد زیر نحوه استفاده از API جیمیل برای مدیریت گواهی‌های S/MIME برای سازمانی با چندین کاربر را نشان می‌دهد:

ایجاد یک منبع smimeInfo برای گواهی S/MIME

این نمونه کد نحوه خواندن یک گواهی از یک فایل، کدگذاری آن به یک رشته Base64URL و اختصاص آن به فیلد pkcs12 در منبع settings.sendAs.smimeInfo را نشان می‌دهد:

جاوا

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;
  }
}

پایتون

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

یک گواهی S/MIME آپلود کنید

برای آپلود یک گواهی، متد settings.sendAs.smimeInfo.insert را فراخوانی کنید و منبع settings.sendAs.smimeInfo را در بدنه درخواست ارائه دهید:

جاوا

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;
  }
}

پایتون

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

مدیریت گواهی‌های چندین کاربر

این نمونه‌های کد نحوه مدیریت گواهینامه‌ها برای چندین کاربر در یک سازمان را در یک فراخوانی دسته‌ای نشان می‌دهند:

درج گواهی‌ها از فایل 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

مشاهده در گیت‌هاب

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);
    }
  }
}

پایتون

شما می‌توانید از نمونه‌های create_smime_info و insert_smime_info برای آپلود گواهی‌نامه‌ها برای کاربران مشخص‌شده در یک فایل 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")

مدیریت گواهی

این نمونه چندین روش از منبع settings.sendAs.smimeInfo را ترکیب می‌کند تا نحوه مدیریت گواهینامه‌ها برای سازمان شما را نشان دهد. این نمونه گواهینامه‌های کاربر را فهرست می‌کند. اگر گواهینامه پیش‌فرض منقضی شده یا تنظیم نشده باشد، گواهینامه موجود در فایل مشخص شده را بارگذاری می‌کند. سپس گواهینامه‌ای را که انقضای آن به آینده دورتری مربوط می‌شود، به عنوان پیش‌فرض تنظیم می‌کند.

سپس این تابع، مشابه نمونه‌ی قبلیِ درج گواهی‌ها از یک فایل CSV ، یک فایل CSV را پردازش می‌کند.

جاوا

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;
  }
}

پایتون

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

مدیریت گواهی‌های S/MIME با Gmail API با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.

دسترسی API را مجاز کنید

دامنه‌های ACL

پیکربندی کلیدهای S/MIME

یک کلید S/MIME آپلود کنید

فهرست کردن کلیدهای S/MIME کاربر

کلیدهای S/MIME را برای یک نام مستعار بازیابی کنید

حذف کلید S/MIME

تنظیم کلید پیش‌فرض S/MIME برای یک نام مستعار

نمونه‌های کد

ایجاد یک منبع smimeInfo برای گواهی S/MIME

جاوا

پایتون

یک گواهی S/MIME آپلود کنید

جاوا

پایتون

مدیریت گواهی‌های چندین کاربر

درج گواهی‌ها از فایل CSV

جاوا

پایتون

مدیریت گواهی

جاوا

پایتون

مباحث مرتبط

مدیریت گواهی‌های S/MIME با Gmail API