Die Gmail S/MIME API bietet programmatischen Zugriff zum Verwalten 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 die Signierung 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.
- 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 individuelle S/MIME-Zertifikate und laden sie über die API hoch. Jedes S/MIME-Zertifikat ist für einen bestimmten Alias für ein Nutzer-E-Mail-Konto bestimmt. Aliasse umfassen die primäre E‑Mail-Adresse sowie benutzerdefinierte „Senden als“-Adressen. Für jeden Alias ist ein einzelnes S/MIME-Zertifikat als Standard festgelegt.
API-Zugriff autorisieren
Es gibt zwei Möglichkeiten, den Zugriff auf die API zu autorisieren:
- Sie können ein Dienstkonto mit domainweiter Delegierung von Befugnissen verwenden. Eine Erläuterung dieser Begriffe finden Sie unter Begriffe für 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 erforderlich ist, um ein OAuth2-Zugriffstoken zu erhalten. Weitere Informationen finden Sie unter Übersicht über Authentifizierung und Autorisierung. Für die Verwendung dieser Option muss der Domainadministrator das Kästchen „S/MIME API end user access enabled“ (Endnutzerzugriff auf die S/MIME API aktiviert) in der Domain-Systemsteuerung aktivieren.
ACL-Bereiche
Diese API verwendet dieselben ACL-Bereiche wie die Gmail-Methoden „sendAs“:
- gmail.settings.basic
- Dieser Bereich ist erforderlich, um das primäre „Senden als“-S/MIME zu aktualisieren.
- gmail.settings.sharing
- Dieser Bereich ist erforderlich, um benutzerdefinierte Von-S/MIME-Adressen zu aktualisieren.
API verwenden
Die Ressource users.settings.sendAs.smimeInfo bietet 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 zu einem Nutzer gehört. Sie identifizieren den Zielalias mit den folgenden Parametern:
- userId
- Die E-Mail-Adresse des Nutzers. Mit dem speziellen Wert
me
können Sie den aktuell authentifizierten Nutzer angeben. - sendAsEmail
- Der Alias, für den Sie den Schlüssel hochladen. Dies ist die E‑Mail-Adresse, die im Header „Von:“ für E‑Mails angezeigt wird, die über diesen Alias gesendet werden.
Das S/MIME-Zertifikat und der private Schlüssel sollten in diesem Format im Feld pkcs12
vorhanden sein. In der Anfrage dürfen keine anderen Felder festgelegt werden. Das PKCS12-Feld muss sowohl den S/MIME-Schlüssel des Nutzers als auch die Signaturzertifikatskette enthalten. 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 ist in unserer Liste der vertrauenswürdigen Zertifizierungsstellen enthalten.
- Die Zertifikate entsprechen den technischen Einschränkungen von Gmail.
Wenn der Schlüssel verschlüsselt ist, sollte sich das Passwort im Feld encryptedKeyPassword
befinden. Bei erfolgreichen insert()-Aufrufen wird die ID von „smimeInfo“ 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 angegebenen Nutzer für den angegebenen Alias zurückzugeben. Sie identifizieren den Zielalias mit den folgenden Parametern:
- userId
- Die E-Mail-Adresse des Nutzers. Mit dem speziellen Wert
me
können Sie den aktuell authentifizierten Nutzer angeben. - sendAsEmail
- Der Alias, für den Schlüssel aufgeführt werden sollen. Dies ist die E‑Mail-Adresse, die im Header „Von:“ für E‑Mails angezeigt wird, die über diesen Alias gesendet werden.
S/MIME-Schlüssel für einen Alias abrufen
Mit der Methode smimeInfo.get() können Sie die spezifischen S/MIME-Schlüssel für einen bestimmten „Senden als“-Alias für einen Nutzer zurückgeben. Sie identifizieren den Zielalias mit den folgenden Parametern:
- userId
- Die E-Mail-Adresse des Nutzers. Mit dem speziellen Wert
me
können Sie den aktuell authentifizierten Nutzer angeben. - sendAsEmail
- Der Alias, für den Sie die Schlüssel abrufen. Dies ist die E‑Mail-Adresse, die im Header „Von:“ für E‑Mails angezeigt wird, 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 identifizieren den Zielalias mit den folgenden Parametern:
- userId
- Die E-Mail-Adresse des Nutzers. Mit dem speziellen Wert
me
können Sie den aktuell authentifizierten Nutzer angeben. - sendAsEmail
- Der Alias, für den Sie die Schlüssel abrufen. Dies ist die E‑Mail-Adresse, die im Header „Von:“ für E‑Mails angezeigt wird, die mit diesem Alias gesendet werden.
- 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 kennzeichnen. Sie identifizieren den Zielalias mit den folgenden Parametern:
- userId
- Die E-Mail-Adresse des Nutzers. Mit dem speziellen Wert
me
können Sie den aktuell authentifizierten Nutzer angeben. - sendAsEmail
- Der Alias, für den Sie die Schlüssel abrufen. Dies ist die E‑Mail-Adresse, die im Header „Von:“ für E‑Mails angezeigt wird, die mit diesem Alias gesendet werden.
- id
- Die unveränderliche ID für die SmimeInfo.
Beispielcode
Die folgenden Codebeispiele zeigen, wie Sie die API verwenden, um S/MIME-Zertifikate für eine Organisation mit mehreren Nutzern zu verwalten.
SmimeInfo-Ressource für ein S/MIME-Zertifikat erstellen
Das folgende Codebeispiel zeigt, wie ein Zertifikat aus einer Datei gelesen, in einen base64url-String codiert und dem Feld pkcs12
der smimeInfo
-Ressource 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
Möglicherweise möchten Sie Zertifikate für viele Nutzer in der Organisation gleichzeitig verwalten. Die folgenden Beispiele zeigen, 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 Aufrufe createSmimeInfo
und insertSmimeInfo
aus dem vorherigen Schritt verwenden, um die Zertifikate wie in der CSV-Datei angegeben hochzuladen:
Python
Sie können die Aufrufe create_smime_info
und insert_smime_info
aus dem vorherigen Schritt 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. Darin sind die Zertifikate für den Nutzer aufgeführt. Wenn das Standardzertifikat abgelaufen oder nicht festgelegt ist, wird das Zertifikat aus der angegebenen Datei hochgeladen. Anschließend wird das Zertifikat, dessen Ablaufdatum am weitesten in der Zukunft liegt, als Standard festgelegt.
Sie wird dann von einer Funktion aufgerufen, die eine CSV-Datei wie im vorherigen Beispiel verarbeitet.