S/MIME सर्टिफ़िकेट मैनेज करना

Gmail S/MIME API, किसी डोमेन में उपयोगकर्ताओं के लिए S/MIME ईमेल सर्टिफ़िकेट मैनेज करने के लिए, प्रोग्राम के हिसाब से ऐक्सेस देता है.

सर्टिफ़िकेट काम कर सकें, इसके लिए एडमिन को डोमेन के लिए S/MIME इस्तेमाल करने की सुविधा चालू करनी होगी.

S/MIME स्टैंडर्ड, सार्वजनिक कुंजी से एमआईएमई डेटा को एन्क्रिप्ट (सुरक्षित) करने और उस पर हस्ताक्षर करने के लिए, खास जानकारी देता है. उपयोगकर्ता के खाते में S/MIME सर्टिफ़िकेट कॉन्फ़िगर करने पर, Gmail उस सर्टिफ़िकेट का इस्तेमाल इन तरीकों से करता है:

  • Gmail, भेजे जाने वाले ईमेल पर हस्ताक्षर करने के लिए, उपयोगकर्ता के सर्टिफ़िकेट और निजी कुंजी का इस्तेमाल करता है.
  • Gmail, आने वाले ईमेल को डिक्रिप्ट करने के लिए, उपयोगकर्ता की निजी कुंजी का इस्तेमाल करता है.
  • Gmail, ईमेल पाने वाले व्यक्ति के सर्टिफ़िकेट और सार्वजनिक पासकोड का इस्तेमाल करके, भेजे जाने वाले ईमेल को एन्क्रिप्ट (सुरक्षित) करता है.
  • Gmail, आने वाले ईमेल की पुष्टि करने के लिए, ईमेल भेजने वाले के सर्टिफ़िकेट और पब्लिक पासकोड का इस्तेमाल करता है.

आपके पास अलग-अलग S/MIME सर्टिफ़िकेट जनरेट करने और एपीआई का इस्तेमाल करके उन्हें अपलोड करने का विकल्प होता है. हर S/MIME सर्टिफ़िकेट, उपयोगकर्ता के ईमेल खाते के किसी खास उपनाम के लिए होता है. उपनाम में मुख्य ईमेल पता और पसंद के मुताबिक "इस रूप में भेजें" पते शामिल होते हैं. हर अन्य नाम के लिए, एक S/MIME सर्टिफ़िकेट को डिफ़ॉल्ट के तौर पर मार्क किया जाता है.

एपीआई ऐक्सेस की अनुमति देना

एपीआई को ऐक्सेस करने की अनुमति देने के दो तरीके हैं:

  1. डोमेन के लिए अधिकार देने की सुविधा के साथ, सेवा खाते का इस्तेमाल किया जा सकता है. इन शर्तों के बारे में जानने के लिए, पुष्टि और अनुमति से जुड़ी खास जानकारी देखें. इस विकल्प को चालू करने के बारे में जानने के लिए, डोमेन के लिए अधिकार देने की सुविधा वाला सेवा खाता बनाएं लेख पढ़ें
  2. OAuth2 ऐक्सेस टोकन पाने के लिए, OAuth2 के स्टैंडर्ड फ़्लो का इस्तेमाल किया जा सकता है. इसके लिए, आपको एंड-यूज़र की सहमति लेनी होगी. ज़्यादा जानकारी के लिए, पुष्टि और अनुमति की खास जानकारी देखें. इस विकल्प का इस्तेमाल करने के लिए, डोमेन एडमिन को डोमेन कंट्रोल पैनल में "S/MIME API के असली उपयोगकर्ता के लिए ऐक्सेस चालू है" चेकबॉक्स को चालू करना होगा.

एसीएल के स्कोप

यह एपीआई, Gmail sendAs के तरीकों के एक जैसे एसीएल स्कोप पर निर्भर करता है:

gmail.settings.basic
SendAs S/MIME को प्राइमरी के तौर पर अपडेट करने के लिए, यह स्कोप ज़रूरी है.
gmail.settings.sharing
S/MIME से कस्टम को अपडेट करने के लिए, यह स्कोप ज़रूरी है.

एपीआई का इस्तेमाल करना

users.settings.sendAs.smimeInfo रिसोर्स, S/MIME सर्टिफ़िकेट मैनेज करने के तरीके उपलब्ध कराता है. हर सर्टिफ़िकेट, किसी उपयोगकर्ता के लिए 'इस पते से भेजें' सुविधा के एक उपनाम से जुड़ा होता है.

S/MIME पासकोड अपलोड करना

किसी उपयोगकर्ता के उपनाम के लिए नई S/MIME कुंजी अपलोड करने के लिए, smimeInfo.insert() तरीके का इस्तेमाल करें. टारगेट के उपनाम की पहचान करने के लिए, इन पैरामीटर का इस्तेमाल किया जाता है:

userId
उपयोगकर्ता का ईमेल पता. फ़िलहाल पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, खास वैल्यू me का इस्तेमाल किया जा सकता है.
sendAsEmail
वह उपनाम जिसके लिए पासकोड अपलोड किया जा रहा है. यह वह ईमेल पता है जो इस उपनाम का इस्तेमाल करके भेजे गए ईमेल के लिए, "भेजने वाला:" हेडर में दिखता है.

S/MIME सर्टिफ़िकेट और निजी कुंजी, pkcs12 फ़ील्ड में उस फ़ॉर्मैट में मौजूद होनी चाहिए. अनुरोध में कोई दूसरा फ़ील्ड सेट नहीं किया जाना चाहिए. PKCS12 फ़ील्ड में, उपयोगकर्ता की S/MIME पासकोड और हस्ताक्षर करने के लिए सर्टिफ़िकेट चेन, दोनों शामिल होने चाहिए. एपीआई इस फ़ील्ड को स्वीकार करने से पहले, इसकी मानक पुष्टि करता है. इसमें इन चीज़ों की पुष्टि की जाती है:

  • ईमेल का विषय, दिए गए ईमेल पते से मेल खाता हो.
  • समयसीमा खत्म होने की तारीखें मान्य हों.
  • सर्टिफ़िकेट देने वाली संस्था (सीए) हमारी भरोसेमंद सूची में शामिल हो.
  • सर्टिफ़िकेट, Gmail की तकनीकी शर्तों के मुताबिक हों.

अगर पासवर्ड एन्क्रिप्ट किया गया है, तो पासवर्ड encryptedKeyPassword फ़ील्ड में होना चाहिए. insert() कॉल के सही तरीके से काम करने पर, smimeInfo का आईडी दिखेगा. इसका इस्तेमाल, आने वाले समय में पासकोड के रेफ़रंस के लिए किया जा सकता है.

किसी उपयोगकर्ता की S/MIME कुंजियों की सूची बनाना

किसी उपयोगकर्ता के लिए, किसी उपनाम की S/MIME कुंजियों की सूची दिखाने के लिए, smimeInfo.list() तरीके का इस्तेमाल करें. टारगेट के उपनाम की पहचान करने के लिए, इन पैरामीटर का इस्तेमाल किया जाता है:

userId
उपयोगकर्ता का ईमेल पता. फ़िलहाल पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, खास वैल्यू me का इस्तेमाल किया जा सकता है.
sendAsEmail
वह उपनाम जिसके लिए कुंजियों की सूची बनानी है. यह वह ईमेल पता है जो इस उपनाम का इस्तेमाल करके भेजे गए ईमेल के लिए, "भेजने वाला:" हेडर में दिखता है.

किसी उपनाम के लिए S/MIME कुंजियां वापस पाना

किसी उपयोगकर्ता के लिए, 'भेजने के लिए इस्तेमाल किया जाने वाला कोई दूसरा नाम' के तौर पर सेट की गई किसी खास ईमेल पते के लिए, S/MIME की खास कुंजियां पाने के लिए, smimeInfo.get() तरीके का इस्तेमाल करें. टारगेट के उपनाम की पहचान करने के लिए, इन पैरामीटर का इस्तेमाल किया जाता है:

userId
उपयोगकर्ता का ईमेल पता. फ़िलहाल पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, खास वैल्यू me का इस्तेमाल किया जा सकता है.
sendAsEmail
वह उपनाम जिसके लिए पासकी वापस लाई जा रही हैं. यह वह ईमेल पता है जो इस उपनाम का इस्तेमाल करके भेजे गए ईमेल के लिए, "भेजने वाला:" हेडर में दिखता है.

S/MIME पासकोड मिटाना

किसी उपनाम से, चुनी गई S/MIME कुंजी को मिटाने के लिए, smimeInfo.delete() तरीके का इस्तेमाल करें. टारगेट के उपनाम की पहचान करने के लिए, इन पैरामीटर का इस्तेमाल किया जाता है:

userId
उपयोगकर्ता का ईमेल पता. फ़िलहाल पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, खास वैल्यू me का इस्तेमाल किया जा सकता है.
sendAsEmail
वह उपनाम जिसके लिए पासकी वापस लाई जा रही हैं. यह वह ईमेल पता होता है जो इस उपनाम का इस्तेमाल करके भेजे गए ईमेल के लिए, "भेजने वाला:" हेडर में दिखता है.
आईडी
SmimeInfo के लिए बदला न जा सकने वाला आईडी.

किसी उपनाम के लिए डिफ़ॉल्ट S/MIME पासकोड सेट करना

smimeInfo.setDefault() तरीके का इस्तेमाल करके, किसी खास उपनाम के लिए S/MIME कुंजी को डिफ़ॉल्ट के तौर पर मार्क करें. टारगेट के उपनाम की पहचान करने के लिए, इन पैरामीटर का इस्तेमाल किया जाता है:

userId
उपयोगकर्ता का ईमेल पता. फ़िलहाल पुष्टि किए गए उपयोगकर्ता की जानकारी देने के लिए, खास वैल्यू me का इस्तेमाल किया जा सकता है.
sendAsEmail
वह उपनाम जिसके लिए पासकी वापस लाई जा रही हैं. यह वह ईमेल पता होता है जो इस उपनाम का इस्तेमाल करके भेजे गए ईमेल के लिए, "भेजने वाला:" हेडर में दिखता है.
आईडी
SmimeInfo के लिए बदला न जा सकने वाला आईडी.

नमूना कोड

नीचे दिए गए कोड सैंपल में, एक से ज़्यादा उपयोगकर्ताओं वाले संगठन के लिए S/MIME सर्टिफ़िकेट मैनेज करने के लिए, एपीआई का इस्तेमाल करने का तरीका बताया गया है.

S/MIME सर्टिफ़िकेट के लिए SmimeInfo रिसॉर्स बनाना

नीचे दिए गए कोड सैंपल में, फ़ाइल से सर्टिफ़िकेट पढ़ने, उसे Base64URL स्ट्रिंग में एन्कोड करने, और उसे smimeInfo संसाधन के pkcs12 फ़ील्ड में असाइन करने का तरीका बताया गया है:

JavaPython
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 सर्टिफ़िकेट अपलोड करना

सर्टिफ़िकेट अपलोड करने के लिए, smimeInfo.insert को कॉल करें और अनुरोध के मुख्य हिस्से में smimeInfo संसाधन दें:

JavaPython
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
JavaPython

CSV फ़ाइल में बताए गए तरीके से सर्टिफ़िकेट अपलोड करने के लिए, पहले से मौजूद createSmimeInfo और insertSmimeInfo कॉल का इस्तेमाल किया जा सकता है:

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

CSV फ़ाइल में बताए गए तरीके से सर्टिफ़िकेट अपलोड करने के लिए, पहले से मौजूद create_smime_info और insert_smime_info कॉल का इस्तेमाल किया जा सकता है:

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

सर्टिफ़िकेट मैनेजमेंट

इस उदाहरण में, smimeInfo एपीआई के कई कॉल को जोड़ा गया है. इससे यह पता चलता है कि अपने संगठन के लिए सर्टिफ़िकेट कैसे मैनेज किए जा सकते हैं. यह उपयोगकर्ता के सर्टिफ़िकेट की सूची दिखाता है. अगर डिफ़ॉल्ट सर्टिफ़िकेट की समयसीमा खत्म हो गई है या वह सेट नहीं है, तो यह बताई गई फ़ाइल में मौजूद सर्टिफ़िकेट अपलोड करता है. इसके बाद, वह सर्टिफ़िकेट को डिफ़ॉल्ट के तौर पर सेट करता है जिसकी समयसीमा सबसे बाद में खत्म होती है.

इसके बाद, इसे उस फ़ंक्शन से कॉल किया जाता है जो पिछले उदाहरण की तरह CSV फ़ाइल को प्रोसेस करता है.

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