Die Gmail S/MIME API bietet programmatischen Zugriff zur 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 Verschlüsselung mit öffentlichen Schlüsseln und das Signieren von MIME-Daten. Wenn Sie S/MIME-Zertifikate im Konto eines Nutzers konfigurieren, verwendet Gmail dieses Zertifikat so:
- 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.
- Gmail verwendet das Zertifikat und den öffentlichen Schlüssel des Empfängers, um ausgehende E-Mails zu verschlüsseln.
- 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 das E-Mail-Konto eines Nutzers. Aliasse umfassen die primäre E-Mail-Adresse sowie benutzerdefinierte „Senden als“-Adressen. Ein einzelnes S/MIME-Zertifikat wird als Standard für jeden Alias gekennzeichnet.
API-Zugriff autorisieren
Es gibt zwei Möglichkeiten, den Zugriff auf die API zu autorisieren:
- Sie können ein Dienstkonto mit der domainweiten Delegierung von Befugnissen verwenden. Eine Erläuterung dieser Begriffe finden Sie in der Übersicht über die Nutzungsbedingungen von Authentifizierung und Autorisierung. Informationen zum Aktivieren dieser Option finden Sie unter Dienstkonto mit domainweiter Befugnisdelegierung erstellen.
- Sie können einen standardmäßigen OAuth2-Ablauf verwenden, in dem die Einwilligung des Endnutzers zum Abrufen eines Oauth2-Zugriffstokens erforderlich ist. Weitere Informationen finden Sie unter Authentifizierung und Autorisierung – Übersicht. Damit Sie diese Option verwenden können, muss der Domainadministrator im Steuerfeld der Domain das Kästchen „S/MIME API-Endnutzerzugriff aktiviert“ aktivieren.
ACL-Bereiche
Diese API basiert auf denselben ACL-Bereichen wie die Gmail-Methode "sendAs":
- gmail.settings.basic
- Dieser Bereich ist für die Aktualisierung des primären SendAs-S/MIME erforderlich.
- gmail.settings.sharing
- Dieser Bereich ist erforderlich, um benutzerdefiniertes S/MIME-Typ von zu aktualisieren.
API verwenden
Die Ressource users.settings.sendAs.smimeInfo enthält die Methoden, mit denen Sie S/MIME-Zertifikate verwalten. Jedes Zertifikat ist einem „Senden als“-Alias für einen Nutzer zugeordnet.
S/MIME-Schlüssel hochladen
Verwenden Sie die Methode smimeInfo.insert(), um einen neuen S/MIME-Schlüssel für einen Alias hochzuladen, der einem Nutzer gehört. Sie ermitteln den Zielalias mithilfe der folgenden Parameter:
- userId
- E-Mail-Adresse des Nutzers Sie können den speziellen Wert
me
verwenden, um den aktuell authentifizierten Nutzer anzugeben. - sendAsEmail
- Das Alias, für das Sie den Schlüssel hochladen. Das ist die E-Mail-Adresse, die bei E-Mails, die über dieses Alias gesendet werden, im Header „Von:“ angezeigt wird.
Das S/MIME-Zertifikat und der private Schlüssel sollten in diesem Format im Feld pkcs12
vorhanden sein. In der Anfrage sollten keine anderen Felder festgelegt werden. Das PKCS12-Feld muss sowohl den S/MIME-Schlüssel des Nutzers als auch die Zertifikatkette für die Signatur enthalten. Die API führt Standardvalidierungen für dieses Feld durch, bevor es es akzeptiert. Dabei wird Folgendes überprüft:
- Der Betreff stimmt mit der angegebenen E-Mail-Adresse überein.
- Ablaufzeiten sind gültig.
- Die ausstellende Zertifizierungsstelle ist in unserer Liste vertrauenswürdiger Zertifizierungsstellen enthalten.
- Die Zertifikate entsprechen den technischen Anforderungen von Gmail.
Wenn der Schlüssel verschlüsselt ist, sollte das Passwort im Feld encryptedKeyPassword
stehen. Bei erfolgreichen „insert()“-Aufrufen wird die smimeInfo-ID zurückgegeben, mit der in Zukunft auf den Schlüssel verwiesen 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 jeweiligen Nutzer und den Alias zurückzugeben. Sie ermitteln den Zielalias mithilfe der folgenden Parameter:
- userId
- 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. Das ist die E-Mail-Adresse, die bei E-Mails, die über dieses Alias gesendet werden, im Header „Von:“ angezeigt wird.
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 „Senden als“-Alias für einen Nutzer zurückzugeben. Sie ermitteln den Zielalias mithilfe der folgenden Parameter:
- userId
- 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. Das ist die E-Mail-Adresse, die bei E-Mails, die über dieses Alias gesendet werden, im Header „Von:“ angezeigt wird.
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 ermitteln den Zielalias mithilfe der folgenden Parameter:
- userId
- 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. Das ist die E-Mail-Adresse, die bei E-Mails, die über dieses Alias gesendet werden, im „Von:“-Header angezeigt wird.
- id
- Die unveränderliche ID für 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 ermitteln den Zielalias mithilfe der folgenden Parameter:
- userId
- 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. Das ist die E-Mail-Adresse, die bei E-Mails, die über dieses Alias gesendet werden, im „Von:“-Header angezeigt wird.
- id
- Die unveränderliche ID für SmimeInfo.
Beispielcode
Die folgenden Codebeispiele zeigen, wie die API zum Verwalten von S/MIME-Zertifikaten für eine Organisation mit mehreren Nutzern verwendet wird.
SmimeInfo-Ressource für ein S/MIME-Zertifikat erstellen
Im folgenden Codebeispiel wird gezeigt, wie ein Zertifikat aus einer Datei gelesen, in einem 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 Ressource smimeInfo
im Text der Anfrage an:
Java
Python
Beispiele für die Verwaltung zahlreicher Nutzerzertifikate
Sie können Zertifikate für viele Nutzer in der Organisation gleichzeitig verwalten. Die folgenden Beispiele zeigen, wie Zertifikate für mehrere Nutzer in einem Batchaufruf verwaltet werden.
Zertifikate aus einer CSV-Datei einfügen
Angenommen, Sie haben eine CSV-Datei, in der die Nutzer-IDs und der Pfad zum Zertifikat jedes Nutzers aufgeführt sind:
$ 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 zuvor erwähnten Aufrufe createSmimeInfo
und insertSmimeInfo
verwenden, um die Zertifikate wie in der CSV-Datei angegeben hochzuladen:
Python
Sie können die zuvor erwähnten Aufrufe create_smime_info
und insert_smime_info
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 oder nicht festgelegt ist, wird das Zertifikat in der angegebenen Datei hochgeladen. Dann wird das Zertifikat als Standard festgelegt, dessen Ablauf am weitesten in der Zukunft liegt.
Dieses wird dann von einer Funktion aufgerufen, die wie im vorherigen Beispiel eine CSV-Datei verarbeitet.