Der Befehl createkeys() erstellt neue Schlüssel für einen authentisierten Benutzer.
Dieser Befehl stellt sicher, dass für einen authentisierten Benutzer das gewünschte Schlüsselmaterial zur Verfügung steht. Das heißt, sofern der entsprechende Benutzer kein oder nur abgelaufenes Schlüsselmaterial zur Verfügung hat, würde neues Schlüsselmaterial gemäß Einstellung (siehe Parameter keys) generiert. Dies entspricht den Einstellungen, wie sie im Ruleset generator unter Key generation vorgenommen werden können.
Aufbau des Befehls
createkeys('keys',['continue']);
Rückgabewert
positiv |
bei erfolgreichem Ausstellen der angegebenen Schlüssel |
negativ |
bei Fehlschlagen des Ausstellens |
Parameter
keys (optional)
Dieser Parameter gibt an, welches Schlüsselmaterial generiert werden soll. Das Format entspricht einer Bitmaske in Oktalnotation.
Die folgenden Werte stehe zur Verfügung:
Bit 0 : OpenPGP-Schlüsselpaar generieren
Bit 1 : S/MIME-Zertifikat mit der eigenen Zertifizierungsstelle generieren
Bit 2 : S/MIME-Zertifikat via CA-Connector generieren
Werte |
Mask |
||||
|---|---|---|---|---|---|
Bit 0: OpenPGP |
x |
|
x |
|
x |
Bit 1: S/MIME mit eigener CA |
|
x |
x |
|
|
Bit 2: S/MIME via CA-Connector |
|
|
|
x |
x |
Wert für keys |
1 |
2 |
3 |
4 |
5 |
continue (optional)
Über diesen Parameter wird entschieden, ob eine E-Mail während des Generierens des Schlüsselmaterials temporär mit (420 An encryption key for your account '$senderemail' will be available shortly also beispielsweise 420 An encryption key for your account 'max.mustermann@meinefirma.tld' will be available shortly) abgelehnt (false) oder in der Warteschlange des SEPPmail Secure E-Mail Gateways gehalten wird.
Mögliche Werte
•true, yes oder 1
•false, no oder 0
Standardeinstellung ist 0
Beispiel 1
Zeile |
Code |
|---|---|
01 |
if (authenticated()) { |
02 |
createkeys('3'); |
03 |
log(1,'OpenPGP Key generated'); |
04 |
} |
Erklärung
Das Beispiel wertet den Rückgabewert des Befehls authenticated() aus (Zeile 01). Konnte der interne Absender der E-Mail erfolgreich authentifiziert werden, so ist der Rückgabewert true. Somit wird mit createkeys() (Zeile 02), fortgefahren und ein OpenPGP Schlüsselpaar erzeugt, sofern nicht bereits gültiges vorhanden ist (Zeile 02). Weiterhin wird ein Log-Eintrag erzeugt (Zeile 03).
