Google, içerikleri tercih ettiğiniz dile çevirmek için yapay zeka teknolojisini kullanır. Yapay zeka çevirilerinde hata olabilir.

Gmail API ile S/MIME sertifikalarını yönetme

Bu belgede, S/MIME e-posta sertifikalarının Gmail API ile nasıl kullanılacağı açıklanmaktadır.

Gmail API, Google Workspace alanındaki kullanıcıların S/MIME e-posta sertifikalarını yönetmek için programatik erişim sağlar.

Sertifikaların çalışması için bir yöneticinin alan için barındırılan S/MIME'yi etkinleştirmesi gerekir.

S/MIME standardı, MIME verilerinin ortak anahtar şifrelemesi ve imzalanması için bir spesifikasyon sağlar. Bir kullanıcı hesabı için S/MIME sertifikalarını yapılandırdığınızda Gmail bunları şu şekillerde kullanır:

Giden postaları kullanıcı sertifikası ve özel anahtarla imzalayın.
Gelen postanın şifresini kullanıcının özel anahtarıyla çözün.
Giden postaları alıcı sertifikası ve ortak anahtarıyla şifreleyin.
Gelen postayı gönderen sertifikası ve ortak anahtarla doğrulayın.

Gmail API'yi kullanarak ayrı S/MIME sertifikaları oluşturabilir ve bunları yükleyebilirsiniz. Her S/MIME sertifikası, bir kullanıcı e-posta hesabının belirli bir takma adı içindir. Takma adlar, birincil e-posta adresini ve özel "Farklı gönder" adreslerini içerir. API, her bir takma ad için tek bir S/MIME sertifikasını varsayılan olarak işaretler.

Takma adlar hakkında daha fazla bilgi için Gmail API ile takma adları ve imzaları yönetme başlıklı makaleyi inceleyin.

API erişimini yetkilendirme

Gmail API'ye erişimi yetkilendirmek için aşağıdaki yöntemlerden birini kullanın:

Alan genelinde yetki devri olan bir hizmet hesabı kullanın. Bu terimlerin açıklaması için Kimlik doğrulama ve yetkilendirme hakkında bilgi başlıklı makaleyi inceleyin. Bu seçeneği etkinleştirmek için Erişim kimlik bilgileri oluşturma başlıklı makaleye bakın.
OAuth 2.0 erişim jetonu almak için kullanıcı izni gerektiren standart bir OAuth 2.0 akışı kullanın. Daha fazla bilgi için Kimlik doğrulama ve yetkilendirme hakkında bilgi başlıklı makaleyi inceleyin.

Bu seçeneği kullanmak için alan yöneticisinin Google Yönetici Konsolu'nda E-posta gönderme ve alma için S/MIME şifrelemesini etkinleştir onay kutusunu işaretlemesi gerekir. Daha fazla bilgi için Yönetici Konsolunuzda barındırılan S/MIME özelliğini etkinleştirme başlıklı makaleyi inceleyin.

Yetkilendirme kapsamları

Gmail API, Gmail sendAs yöntemleriyle aynı OAuth kapsamlarını kullanır:

gmail.settings.basic: Birincil SendAs S/MIME'yi güncellemek için gereklidir.
gmail.settings.sharing: Özel from S/MIME'yi güncellemek için gereklidir.

S/MIME anahtarlarını yapılandırma

settings.sendAs.smimeInfo kaynağı, S/MIME sertifikalarını yönetmek için çeşitli yöntemler sunar. Her sertifika, bir kullanıcının "farklı gönder" takma adıyla ilişkilendirilir.

Bir kullanıcının farklı adres olarak gönderdiği takma adları belirlemek için settings.sendAs kaynağında settings.sendAs.list yöntemini kullanın.

S/MIME anahtarı yükleme

Bir kullanıcıya ait olan bir diğer ad için yeni bir S/MIME anahtarı yüklemek üzere settings.sendAs.smimeInfo kaynağında settings.sendAs.smimeInfo.insert yöntemini kullanın. Aşağıdaki yol parametrelerini kullanarak hedef takma adı belirleyin:

userId: Kullanıcının e-posta adresi. Kimliği doğrulanmış kullanıcıyı belirtmek için me özel değerini kullanın.
sendAsEmail: Anahtarı yüklediğiniz takma ad. Bu e-posta adresi, bu takma ad kullanılarak gönderilen postaların From: üstbilgisinde görünür.

S/MIME sertifikasını ve özel anahtarı PKCS #12 biçiminde pkcs12 alanında sağlayın. İstekle ilgili başka alan ayarlamayın. pkcs12 alanı hem kullanıcı S/MIME anahtarını hem de imzalama sertifikası zincirini içerir. API, bu alanı kabul etmeden önce üzerinde standart doğrulamalar gerçekleştirerek aşağıdakileri doğrular:

Konu, belirtilen e-posta adresiyle eşleşiyor.
Son kullanma tarihleri geçerlidir.
Sertifikayı veren sertifika yetkilisi (CA), Google'ın güvenilir listesinde olmalıdır.
Sertifikalar, Gmail'in teknik kısıtlamalarıyla eşleşmelidir.

Anahtar şifrelenmişse şifreyi encryptedKeyPassword alanına girin. Başarılı bir settings.sendAs.smimeInfo.insert yöntem çağrısı, gelecekte anahtara başvurmak için kullanılan settings.sendAs.smimeInfo kaynağını id döndürür.

Kullanıcının S/MIME anahtarlarını listeleme

Belirli bir kullanıcı için belirli bir takma adın S/MIME anahtarlarının listesini döndürmek üzere settings.sendAs.smimeInfo kaynağında settings.sendAs.smimeInfo.list yöntemini kullanın. Aşağıdaki yol parametrelerini kullanarak hedef takma adı belirleyin:

userId: Kullanıcının e-posta adresi. Kimliği doğrulanmış kullanıcıyı belirtmek için me özel değerini kullanın.
sendAsEmail: Anahtarların listeleneceği takma ad. Bu e-posta adresi, bu takma ad kullanılarak gönderilen postaların From: üstbilgisinde görünür.

Bir takma ad için S/MIME anahtarlarını alma

Bir kullanıcının belirli bir "farklı gönder" takma adı için belirli S/MIME anahtarlarını döndürmek üzere settings.sendAs.smimeInfo kaynağında settings.sendAs.smimeInfo.get yöntemini kullanın. Aşağıdaki yol parametrelerini kullanarak hedef takma adı belirleyin:

userId: Kullanıcının e-posta adresi. Kimliği doğrulanmış kullanıcıyı belirtmek için me özel değerini kullanın.
sendAsEmail: Anahtarları aldığınız takma ad. Bu e-posta adresi, bu takma ad kullanılarak gönderilen postaların From: üstbilgisinde görünür.

S/MIME anahtarını silme

Belirtilen S/MIME anahtarını bir takma adından silmek için settings.sendAs.smimeInfo kaynağında settings.sendAs.smimeInfo.delete yöntemini kullanın. Aşağıdaki yol parametrelerini kullanarak hedef takma adı belirleyin:

userId: Kullanıcının e-posta adresi. Kimliği doğrulanmış kullanıcıyı belirtmek için me özel değerini kullanın.
sendAsEmail: Anahtarı sildiğiniz takma ad. Bu e-posta adresi, bu takma ad kullanılarak gönderilen postaların From: üstbilgisinde görünür.
id: smimeInfo için değişmez kimlik.

Silinen anahtarlar artık görünmez veya kullanılamaz. İlgili ortak anahtar kullanılarak şifrelenmiş S/MIME e-postalarının şifresini çözemezsiniz. Bir anahtarı silmeden önce, veren yetkili (CA) ile iptal edin.

Bir diğer ad için varsayılan S/MIME anahtarını ayarlama

Belirtilen S/MIME anahtarını belirtilen takma ad için varsayılan olarak işaretlemek üzere settings.sendAs.smimeInfo kaynağında settings.sendAs.smimeInfo.setDefault yöntemini kullanın. Aşağıdaki yol parametrelerini kullanarak hedef takma adı belirleyin:

userId: Kullanıcının e-posta adresi. Kimliği doğrulanmış kullanıcıyı belirtmek için me özel değerini kullanın.
sendAsEmail: Varsayılan anahtarın ayarlanacağı takma ad. Bu e-posta adresi, bu takma ad kullanılarak gönderilen postaların From: üstbilgisinde görünür.
id: smimeInfo için değişmez kimlik.

Bir kullanıcının "farklı gönder" takma adı için yalnızca bir S/MIME anahtarı varsayılandır. settings.sendAs.smimeInfo.setDefault yöntemini çağırmak önceki varsayılanı kaldırır.

Bir kullanıcı, belirli bir anahtarla imzalanmış S/MIME iletileri aldığında Gmail, ilişkili kullanıcıya gönderilen postaları şifrelerken anahtarı varsayılan olarak gelecekteki en uzak not_before geçerlilik tarihiyle ilişkilendirir. Kullanıcının daha önce iletişim kurduğu Gmail kullanıcılarının yeni varsayılan anahtarı kullanmasını sağlamak için yeni varsayılan anahtarın not_before tarihinin önceki varsayılan anahtardan daha sonraki bir tarih olduğundan emin olun veya önceki varsayılan anahtarı iptal edin.

Kod örnekleri

Aşağıdaki kod örneklerinde, Gmail API'yi kullanarak birden fazla kullanıcısı olan bir kuruluşun S/MIME sertifikalarının nasıl yönetileceği gösterilmektedir:

S/MIME sertifikası için `smimeInfo` kaynağı oluşturma

Bu kod örneğinde, bir sertifikanın dosyadan nasıl okunacağı, Base64URL dizesine nasıl kodlanacağı ve settings.sendAs.smimeInfo kaynağındaki pkcs12 alanına nasıl atanacağı gösterilmektedir:

Java

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

GitHub'da göster

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'da göster

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 sertifikası yükleme

Sertifika yüklemek için settings.sendAs.smimeInfo.insert yöntemini çağırın ve isteğin gövdesinde settings.sendAs.smimeInfo kaynağını sağlayın:

Java

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

GitHub'da göster

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'da göster

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

Birden fazla kullanıcının sertifikalarını yönetme

Bu kod örnekleri, bir kuruluşta birden fazla kullanıcının sertifikalarının tek bir toplu çağrıyla nasıl yönetileceğini gösterir:

CSV dosyasından sertifika ekleme

Aşağıda, kullanıcı kimliklerini ve her kullanıcının sertifikasının yolunu listeleyen örnek bir CSV dosyası verilmiştir:

$ 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

CSV dosyasında belirtilen kullanıcıların sertifikalarını yüklemek için CreateSmimeInfo ve InsertSmimeInfo örneklerini kullanabilirsiniz:

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

GitHub'da göster

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

CSV dosyasında belirtilen kullanıcıların sertifikalarını yüklemek için create_smime_info ve insert_smime_info örneklerini kullanabilirsiniz:

gmail/snippet/smime snippets/insert_cert_from_csv.py

GitHub'da göster

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

Sertifika yönetimi

Bu örnekte, kuruluşunuzun sertifikalarını nasıl yöneteceğinizi göstermek için settings.sendAs.smimeInfo kaynağındaki çeşitli yöntemler birleştirilmiştir. Kullanıcının sertifikalarını listeler. Varsayılan sertifikanın süresi dolmuşsa veya ayarlanmamışsa belirtilen dosyada bulunan sertifika yüklenir. Ardından, geçerlilik süresi en uzun olan sertifikayı varsayılan olarak ayarlar.

Bu işlev, önceki CSV dosyasından sertifika ekleme örneğine benzer şekilde bir CSV dosyasını işler.

Java

gmail/snippets/src/main/java/UpdateSmimeCerts.java

GitHub'da göster

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'da göster

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

Gmail API ile S/MIME sertifikalarını yönetme Koleksiyonlar ile düzeninizi koruyun İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.

API erişimini yetkilendirme

Yetkilendirme kapsamları

S/MIME anahtarlarını yapılandırma

S/MIME anahtarı yükleme

Kullanıcının S/MIME anahtarlarını listeleme

Bir takma ad için S/MIME anahtarlarını alma

S/MIME anahtarını silme

Bir diğer ad için varsayılan S/MIME anahtarını ayarlama

Kod örnekleri

S/MIME sertifikası için smimeInfo kaynağı oluşturma

Java

Python

S/MIME sertifikası yükleme

Java

Python

Birden fazla kullanıcının sertifikalarını yönetme

CSV dosyasından sertifika ekleme

Java

Python

Sertifika yönetimi

Java

Python

İlgili konular

Gmail API ile S/MIME sertifikalarını yönetme

S/MIME sertifikası için `smimeInfo` kaynağı oluşturma