Google ใช้เทคโนโลยี AI เพื่อแปลเนื้อหาเป็นภาษาที่คุณต้องการ การแปลโดย AI อาจมีข้อผิดพลาด

จัดการใบรับรอง S/MIME ด้วย Gmail API

เอกสารนี้อธิบายวิธีใช้ใบรับรองอีเมล S/MIME กับ Gmail API

Gmail API ให้สิทธิ์เข้าถึงแบบเป็นโปรแกรมเพื่อจัดการใบรับรองอีเมล S/MIME สำหรับผู้ใช้ในโดเมน Google Workspace

ผู้ดูแลระบบต้องเปิดใช้ S/MIME ที่โฮสต์สำหรับโดเมนเพื่อให้ใบรับรองทำงานได้

มาตรฐาน S/MIME มีข้อกำหนดสำหรับการเข้ารหัสคีย์สาธารณะและการลงนามข้อมูล MIME เมื่อกำหนดค่าใบรับรอง S/MIME สำหรับบัญชีผู้ใช้ Gmail จะใช้ใบรับรองดังกล่าวในลักษณะต่อไปนี้

ลงนามในอีเมลขาออกด้วยใบรับรองผู้ใช้และคีย์ส่วนตัว
ถอดรหัสอีเมลขาเข้าด้วยคีย์ส่วนตัวของผู้ใช้
เข้ารหัสอีเมลขาออกด้วยใบรับรองและคีย์สาธารณะของผู้รับ
ยืนยันอีเมลขาเข้าด้วยใบรับรองผู้ส่งและคีย์สาธารณะ

คุณสร้างใบรับรอง S/MIME แต่ละใบและอัปโหลดได้โดยใช้ Gmail API ใบรับรอง S/MIME แต่ละใบมีไว้สำหรับอีเมลแทนที่เฉพาะเจาะจงสำหรับบัญชีอีเมลของผู้ใช้ อีเมลแทนประกอบด้วยอีเมลหลักและอีเมลที่กำหนดเองสำหรับส่งในนาม API จะทำเครื่องหมายใบรับรอง S/MIME รายการเดียวเป็นค่าเริ่มต้นสำหรับ นามแฝงแต่ละรายการ

ดูข้อมูลเพิ่มเติมเกี่ยวกับอีเมลแทนได้ที่จัดการอีเมลแทนและลายเซ็นด้วย Gmail API

ให้สิทธิ์เข้าถึง API

หากต้องการให้สิทธิ์เข้าถึง Gmail API ให้ใช้วิธีใดวิธีหนึ่งต่อไปนี้

ใช้บัญชีบริการที่มีการมอบสิทธิ์ทั่วทั้งโดเมน ดูคำอธิบายของคำศัพท์เหล่านี้ได้ที่ดูข้อมูลเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์ หากต้องการ เปิดใช้ตัวเลือกนี้ โปรดดูสร้างข้อมูล เข้าสู่ระบบ
ใช้ขั้นตอน OAuth 2.0 มาตรฐานที่ต้องได้รับความยินยอมของผู้ใช้เพื่อรับโทเค็นเพื่อการเข้าถึง OAuth 2.0 ดูข้อมูลเพิ่มเติมได้ที่ดูข้อมูลเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์

หากต้องการใช้ตัวเลือกนี้ ผู้ดูแลระบบโดเมนต้องเลือกช่องทำเครื่องหมายเปิดใช้การเข้ารหัส S/MIME ในการรับส่งอีเมลในคอนโซลผู้ดูแลระบบของ Google ดูข้อมูลเพิ่มเติมได้ที่หัวข้อเปิดใช้ S/MIME ที่โฮสต์ ใน คอนโซลผู้ดูแลระบบ

ขอบเขตการให้สิทธิ์

Gmail API ใช้ขอบเขต OAuth เดียวกันกับเมธอด Gmail sendAs ดังนี้

gmail.settings.basic: ต้องอัปเดต SendAs S/MIME หลัก
gmail.settings.sharing: ต้องอัปเดต from S/MIME ที่กำหนดเอง

กำหนดค่าคีย์ S/MIME

แหล่งข้อมูล settings.sendAs.smimeInfo มีหลายวิธีในการจัดการใบรับรอง S/MIME ใบรับรองแต่ละรายการจะเชื่อมโยงกับนามแฝงส่งในนามของผู้ใช้ 1 ราย

หากต้องการกำหนดชื่อแทนสำหรับส่งในนามของผู้ใช้ ให้ใช้เมธอด settings.sendAs.list ในทรัพยากร settings.sendAs

อัปโหลดคีย์ S/MIME

ใช้วิธี settings.sendAs.smimeInfo.insert ในทรัพยากร settings.sendAs.smimeInfo เพื่ออัปโหลดคีย์ S/MIME ใหม่ สำหรับอีเมลแทนที่เป็นของผู้ใช้ ระบุชื่อแทนเป้าหมายโดยใช้พารามิเตอร์เส้นทางต่อไปนี้

userId: อีเมลของผู้ใช้ ใช้ค่าพิเศษ me เพื่อระบุ ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
sendAsEmail: นามแฝงที่คุณอัปโหลดคีย์ อีเมลนี้จะปรากฏในส่วนหัว From: ของอีเมลที่ส่งโดยใช้อีเมลแทนนี้

ระบุใบรับรอง S/MIME และคีย์ส่วนตัวในฟิลด์ pkcs12 ในรูปแบบ PKCS #12 อย่าตั้งค่าฟิลด์อื่นๆ ในคำขอ ฟิลด์ pkcs12 มีทั้งคีย์ S/MIME ของผู้ใช้และห่วงโซ่ ใบรับรองการลงนาม API จะทำการตรวจสอบมาตรฐานในช่องนี้ก่อนที่จะยอมรับ โดยจะตรวจสอบสิ่งต่อไปนี้

เรื่องตรงกับอีเมลที่ระบุ
วันหมดอายุถูกต้อง
ผู้ออกใบรับรอง (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 ที่ได้รับซึ่งเข้ารหัสโดยใช้คีย์สาธารณะที่เกี่ยวข้องไม่ได้ ก่อนลบคีย์ ให้เพิกถอนคีย์กับผู้ออกคีย์ (CA)

ตั้งค่าคีย์ S/MIME เริ่มต้นสำหรับอีเมลแทน

ใช้เมธอด settings.sendAs.smimeInfo.setDefault ในทรัพยากร settings.sendAs.smimeInfo เพื่อทำเครื่องหมายคีย์ S/MIME ที่ระบุเป็นค่าเริ่มต้นสำหรับชื่อแทนที่ระบุ ระบุชื่อแทนเป้าหมายโดยใช้พารามิเตอร์เส้นทางต่อไปนี้

userId: อีเมลของผู้ใช้ ใช้ค่าพิเศษ me เพื่อระบุ ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
sendAsEmail: นามแฝงที่จะตั้งค่าคีย์เริ่มต้น อีเมลนี้จะปรากฏในส่วนหัว From: ของอีเมลที่ส่งโดยใช้อีเมลแทนนี้
id: รหัสที่เปลี่ยนแปลงไม่ได้สำหรับ smimeInfo

มีเพียงคีย์ S/MIME รายการเดียวเท่านั้นที่เป็นค่าเริ่มต้นสำหรับอีเมลแทนที่ใช้ส่งของผู้ใช้ การเรียกใช้เมธอด settings.sendAs.smimeInfo.setDefault จะยกเลิกการตั้งค่าเริ่มต้นก่อนหน้า

เมื่อผู้ใช้ได้รับข้อความ S/MIME ที่ลงนามด้วยคีย์ที่ระบุ Gmail จะเชื่อมโยงคีย์กับnot_beforeวันที่หมดอายุ ที่อยู่ไกลที่สุดในอนาคตเป็นค่าเริ่มต้นเมื่อเข้ารหัสอีเมลที่ส่งไปยัง ผู้ใช้ที่เชื่อมโยง หากต้องการให้ผู้ใช้ Gmail ที่ผู้ใช้เคยสื่อสารด้วยใช้คีย์เริ่มต้นใหม่ ให้ตรวจสอบว่าคีย์เริ่มต้นใหม่มีnot_beforeวันที่หลังจากคีย์เริ่มต้นก่อนหน้า หรือเพิกถอนคีย์เริ่มต้นก่อนหน้า

ตัวอย่างโค้ด

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้ Gmail API เพื่อจัดการ ใบรับรอง S/MIME สำหรับองค์กรที่มีผู้ใช้หลายราย

สร้าง`smimeInfo`สำหรับใบรับรอง S/MIME

ตัวอย่างโค้ดนี้แสดงวิธีอ่านใบรับรองจากไฟล์ เข้ารหัสเป็นสตริง Base64URL และกำหนดให้กับฟิลด์ pkcs12 ในทรัพยากร settings.sendAs.smimeInfo

Java

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

ดูใน GitHub

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

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

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

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

Python

gmail/snippet/smime snippets/create_smime_info.py

ดูใน GitHub

import base64


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

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

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

  return smime_info


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

อัปโหลดใบรับรอง S/MIME

หากต้องการอัปโหลดใบรับรอง ให้เรียกใช้เมธอด settings.sendAs.smimeInfo.insert และระบุทรัพยากร settings.sendAs.smimeInfo ในเนื้อหาของคำขอ

Java

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

ดูใน GitHub

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

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

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

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

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

Python

gmail/snippet/smime snippets/insert_smime_info.py

ดูใน GitHub

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


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

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

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

    user_id = "gduser1@workspacesamples.dev"
    smime_info = create_smime_info.create_smime_info(
        cert_filename="xyz", cert_password="xyz"
    )
    send_as_email = None

    if not send_as_email:
      send_as_email = user_id

    # pylint: disable=maybe-no-member
    results = (
        service.users()
        .settings()
        .sendAs()
        .smimeInfo()
        .insert(userId=user_id, sendAsEmail=send_as_email, body=smime_info)
        .execute()
    )
    print(f'Inserted certificate; id: {results["id"]}')

  except HttpError as error:
    print(f"An error occurred: {error}")
    results = None

  return results


if __name__ == "__main__":
  insert_smime_info()

จัดการใบรับรองของผู้ใช้หลายคน

ตัวอย่างโค้ดเหล่านี้แสดงวิธีจัดการใบรับรองสำหรับผู้ใช้หลายรายในองค์กรในการเรียกแบบกลุ่มครั้งเดียว

แทรกใบรับรองจากไฟล์ CSV

ต่อไปนี้คือตัวอย่างไฟล์ CSV ที่แสดงรหัสผู้ใช้และเส้นทางไปยังใบรับรองของผู้ใช้แต่ละราย

$ cat certificates.csv
user1@example.com,/path/to/user1_cert.p12,cert_password_1
user2@example.com,/path/to/user2_cert.p12,cert_password_2
user3@example.com,/path/to/user3_cert.p12,cert_password_3

Java

คุณสามารถใช้ตัวอย่าง CreateSmimeInfo และ InsertSmimeInfo เพื่ออัปโหลดใบรับรองสำหรับผู้ใช้ที่ระบุในไฟล์ CSV ได้

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

ดูใน GitHub

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

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

Python

คุณสามารถใช้ตัวอย่าง create_smime_info และ insert_smime_info เพื่ออัปโหลดใบรับรองสำหรับผู้ใช้ที่ระบุในไฟล์ CSV ได้

gmail/snippet/smime snippets/insert_cert_from_csv.py

ดูใน GitHub

import csv

import create_smime_info
import insert_smime_info


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

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

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

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


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

การจัดการใบรับรอง

ตัวอย่างนี้รวมหลายวิธีจากแหล่งข้อมูล settings.sendAs.smimeInfo เพื่อแสดงวิธีจัดการใบรับรองสำหรับองค์กร โดยจะแสดงรายการ ใบรับรองสำหรับผู้ใช้ หากใบรับรองเริ่มต้นหมดอายุหรือไม่ได้ตั้งค่า ระบบจะ อัปโหลดใบรับรองที่พบในไฟล์ที่ระบุ จากนั้นจะตั้งค่าใบรับรองที่หมดอายุในอนาคตเป็นค่าเริ่มต้น

จากนั้นฟังก์ชันนี้จะประมวลผลไฟล์ CSV ซึ่งคล้ายกับตัวอย่างแทรก ใบรับรองจากไฟล์ 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,
  )

ให้สิทธิ์เข้าถึง API

ขอบเขตการให้สิทธิ์

กำหนดค่าคีย์ S/MIME

อัปโหลดคีย์ S/MIME

แสดงรายการคีย์ S/MIME ของผู้ใช้

ดึงคีย์ S/MIME สำหรับอีเมลแทน

ลบคีย์ S/MIME

ตั้งค่าคีย์ S/MIME เริ่มต้นสำหรับอีเมลแทน

ตัวอย่างโค้ด

สร้างsmimeInfoสำหรับใบรับรอง S/MIME

Java

Python

อัปโหลดใบรับรอง S/MIME

Java

Python

จัดการใบรับรองของผู้ใช้หลายคน

แทรกใบรับรองจากไฟล์ CSV

Java

Python

การจัดการใบรับรอง

Java

Python

หัวข้อที่เกี่ยวข้อง

สร้าง`smimeInfo`สำหรับใบรับรอง S/MIME