Die Gmail S/MIME API bietet programmatischen Zugriff auf die Verwaltung von S/MIME-E-Mail-Zertifikaten für Nutzer in einer Google Workspace -Domain.
Ein Administrator muss S/MIME für die Domain aktivieren, damit die Zertifikate funktionieren.
Der S/MIME-Standard bietet eine Spezifikation für die Public-Key-Verschlüsselung und Signatur von MIME-Daten. Wenn Sie S/MIME-Zertifikate im Konto eines Nutzers konfigurieren, verwendet Gmail dieses Zertifikat auf folgende Weise:
- Gmail verwendet das Zertifikat und den privaten Schlüssel des Nutzers, um ausgehende E-Mails zu signieren.
- Gmail verwendet den privaten Schlüssel des Nutzers, um eingehende E-Mails zu entschlüsseln.
- In Gmail werden ausgehende E-Mails mit dem Zertifikat und dem öffentlichen Schlüssel des Empfängers verschlüsselt.
- Gmail verwendet das Zertifikat und den öffentlichen Schlüssel des Absenders, um eingehende E-Mails zu überprüfen.
Sie generieren einzelne S/MIME-Zertifikate und laden sie über die API hoch. Jedes S/MIME-Zertifikat gilt für einen bestimmten Alias für ein Nutzer-E-Mail-Konto. Zu den Aliassen gehören die primäre E-Mail-Adresse sowie benutzerdefinierte „Als… senden“-Adressen. Für jeden Alias wird ein einzelnes S/MIME-Zertifikat als Standard markiert.
API-Zugriff autorisieren
Es gibt zwei Möglichkeiten, den Zugriff auf die API zu autorisieren:
- Sie können ein Dienstkonto mit domainweiter Delegierung von Berechtigungen verwenden. Eine Erklärung dieser Begriffe finden Sie unter Begriffe zur Authentifizierung und Autorisierung. Informationen zum Aktivieren dieser Option finden Sie unter Dienstkonto mit domainweiter Delegierung von Berechtigungen erstellen.
- Sie können einen standardmäßigen OAuth2-Ablauf verwenden, für den die Einwilligung des Endnutzers zum Abrufen eines OAuth2-Zugriffstokens erforderlich ist. Weitere Informationen finden Sie unter Authentifizierung und Autorisierung. Um diese Option zu verwenden, muss der Domainadministrator im Domain-Steuerfeld das Kästchen „S/MIME API-Endnutzerzugriff aktiviert“ aktivieren.
ACL-Bereiche
Diese API verwendet die gleichen ACL-Bereiche wie die Gmail-Methoden „sendAs“:
- gmail.settings.basic
- Dieser Umfang ist erforderlich, um das primäre SendAs-S/MIME-Konto zu aktualisieren.
- gmail.settings.sharing
- Dieser Umfang ist erforderlich, um benutzerdefinierte von S/MIME zu aktualisieren.
API verwenden
Die Ressource users.settings.sendAs.smimeInfo enthält die Methoden, mit denen Sie S/MIME-Zertifikate verwalten. Jedes Zertifikat ist mit einem Alias für die Absenderadresse eines Nutzers verknüpft.
S/MIME-Schlüssel hochladen
Verwenden Sie die Methode smimeInfo.insert(), um einen neuen S/MIME-Schlüssel für einen Alias eines Nutzers hochzuladen. Sie geben den Zielalias mit den folgenden Parametern an:
- userId
- Die E-Mail-Adresse des Nutzers. Sie können den speziellen Wert
me
verwenden, um den aktuell authentifizierten Nutzer anzugeben. - sendAsEmail
- Der Alias, für den Sie den Schlüssel hochladen. Dies ist die E-Mail-Adresse, die im Absenderheader von E-Mails erscheint, die über diesen Alias gesendet werden.
Das S/MIME-Zertifikat und der private Schlüssel müssen in diesem Format im Feld pkcs12
vorhanden sein. In der Anfrage dürfen keine anderen Felder festgelegt sein. Das PKCS12-Feld enthält voraussichtlich sowohl den S/MIME-Schlüssel des Nutzers als auch die Signaturzertifikatskette. Die API führt Standardvalidierungen für dieses Feld durch, bevor es akzeptiert wird. Dabei wird Folgendes geprüft:
- Der Betreff stimmt mit der angegebenen E-Mail-Adresse überein.
- Ablaufdaten sind gültig.
- Die ausstellende Zertifizierungsstelle (Certificate Authority, CA) ist in unserer vertrauenswürdigen Liste.
- Die Zertifikate entsprechen den technischen Einschränkungen von Gmail.
Wenn der Schlüssel verschlüsselt ist, sollte das Passwort im Feld encryptedKeyPassword
angegeben werden. Bei erfolgreichen insert()-Aufrufen wird die ID von smimeInfo zurückgegeben, die in Zukunft als Verweis auf den Schlüssel verwendet werden kann.
S/MIME-Schlüssel eines Nutzers auflisten
Verwenden Sie die Methode smimeInfo.list(), um die Liste der S/MIME-Schlüssel für den angegebenen Nutzer für den angegebenen Alias zurückzugeben. Sie geben den Zielalias mit den folgenden Parametern an:
- userId
- Die E-Mail-Adresse des Nutzers. Sie können den speziellen Wert
me
verwenden, um den aktuell authentifizierten Nutzer anzugeben. - sendAsEmail
- Der Alias, für den Schlüssel aufgelistet werden sollen. Dies ist die E-Mail-Adresse, die im Absenderheader von E-Mails erscheint, die über diesen Alias gesendet werden.
S/MIME-Schlüssel für einen Alias abrufen
Verwenden Sie die Methode smimeInfo.get(), um die spezifischen S/MIME-Schlüssel für einen bestimmten Alias für das Senden als für einen Nutzer zurückzugeben. Sie geben den Zielalias mit den folgenden Parametern an:
- userId
- Die E-Mail-Adresse des Nutzers. Sie können den speziellen Wert
me
verwenden, um den aktuell authentifizierten Nutzer anzugeben. - sendAsEmail
- Der Alias, für den Sie die Schlüssel abrufen. Dies ist die E-Mail-Adresse, die im Absenderheader von E-Mails erscheint, die über diesen Alias gesendet werden.
S/MIME-Schlüssel löschen
Verwenden Sie die Methode smimeInfo.delete(), um den angegebenen S/MIME-Schlüssel aus einem Alias zu löschen. Sie geben den Zielalias mit den folgenden Parametern an:
- userId
- Die E-Mail-Adresse des Nutzers. Sie können den speziellen Wert
me
verwenden, um den aktuell authentifizierten Nutzer anzugeben. - sendAsEmail
- Der Alias, für den Sie die Schlüssel abrufen. Dies ist die E-Mail-Adresse, die im Absenderheader für E-Mails angezeigt wird, die mit diesem Alias gesendet wurden.
- id
- Die unveränderliche ID für die SmimeInfo.
Standard-S/MIME-Schlüssel für einen Alias festlegen
Verwenden Sie die Methode smimeInfo.setDefault(), um den angegebenen S/MIME-Schlüssel als Standard für den angegebenen Alias zu markieren. Sie geben den Zielalias mit den folgenden Parametern an:
- userId
- Die E-Mail-Adresse des Nutzers. Sie können den speziellen Wert
me
verwenden, um den aktuell authentifizierten Nutzer anzugeben. - sendAsEmail
- Der Alias, für den Sie die Schlüssel abrufen. Dies ist die E-Mail-Adresse, die im Absenderheader für E-Mails angezeigt wird, die mit diesem Alias gesendet wurden.
- id
- Die unveränderliche ID für die SmimeInfo.
Beispielcode
Die folgenden Codebeispiele zeigen, wie Sie mit der API S/MIME-Zertifikate für eine Organisation mit mehreren Nutzern verwalten.
SmimeInfo-Ressource für ein S/MIME-Zertifikat erstellen
Im folgenden Codebeispiel wird gezeigt, wie ein Zertifikat aus einer Datei gelesen, in einen Base64url-String codiert und dem Feld pkcs12
der Ressource smimeInfo
zugewiesen wird:
Java
Python
S/MIME-Zertifikat hochladen
Rufen Sie zum Hochladen eines Zertifikats smimeInfo.insert
auf und geben Sie die smimeInfo
-Ressource im Anfragetext an:
Java
Python
Beispiele für die Verwaltung von Zertifikaten vieler Nutzer
Sie möchten möglicherweise Zertifikate für viele Nutzer in der Organisation gleichzeitig verwalten. In den folgenden Beispielen wird gezeigt, wie Sie Zertifikate für mehrere Nutzer in einem Batchaufruf verwalten.
Zertifikate aus einer CSV-Datei einfügen
Angenommen, Sie haben eine CSV-Datei mit Nutzer-IDs und dem Pfad zum Zertifikat jedes Nutzers:
$ 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
Sie können die createSmimeInfo
- und insertSmimeInfo
-Aufrufe aus Schritt 1 verwenden, um die Zertifikate wie in der CSV-Datei angegeben hochzuladen:
Python
Sie können die create_smime_info
- und insert_smime_info
-Aufrufe aus Schritt 1 verwenden, um die Zertifikate wie in der CSV-Datei angegeben hochzuladen:
Zertifikatsverwaltung
In diesem Beispiel werden mehrere Aufrufe der smimeInfo
API kombiniert, um zu zeigen, wie Sie Zertifikate für Ihre Organisation verwalten können. Es werden die Zertifikate für den Nutzer aufgelistet. Wenn das Standardzertifikat abgelaufen ist oder nicht festgelegt ist, wird das in der angegebenen Datei gefundene Zertifikat hochgeladen. Anschließend wird das Zertifikat mit dem längsten Ablaufdatum als Standard festgelegt.
Diese wird dann von einer Funktion aufgerufen, die eine CSV-Datei verarbeitet, wie im vorherigen Beispiel.