Der Befehl sign_smime() signiert eine E-Mail.
Dieser Befehl signiert die ausgehende E-Mail mit dem persönlichen privaten S/MIME Schlüssel des authentifizierten (authenticated()) Absenders (siehe Users S/MIME) der E-Mail.
Aufbau des Befehls
sign_smime(['hash[;pAdd-Ing][;opaque]']);
Rückgabewert
positiv |
wenn die Nachricht erfolgreich signiert wurde |
negativ |
bei Fehlschlagen der Signatur |
Parameter
hash (optional)
Mit diesem Parameters wird der für das Signieren verwendete hash-Algorithmus angegeben (siehe auch Mail Processing Ruleset generator Signing Outgoing e-mails Use default digest for S/MIME signing).
Mögliche Werte:
•sha1
•sha256
•sha512
Standardeinstellung ist sha256
pAdd-Ing (optional)
Dieser Parameter erzwingt das gewählte pAdd-Ing-Verfahren (siehe auch Mail Processing Ruleset generator Signing Outgoing e-mails Prefer RSA-PSS for S/MIME signatures).
Mögliche Werte:
•pkcs
•pss
Standardeinstellung ist pkcs
opaque (optional)
Mit diesem Parameters wird das Signaturverfahren gewählt, detached (oder auch clear text) oder opaque (siehe auch Settings S/MIME options Use opaque signature).
Mögliche Werte:
•true, yes oder 1
•false, no oder 0
Standardeinstellung ist 0
Beispiel 1
Zeile |
Code |
|---|---|
01 |
if (has_smime_key()) { |
02 |
log(1,'S/MIME key available, trying to sign'); |
03 |
if (sign_smime(';;1')) { |
04 |
log(1,'signing successful'); |
05 |
} else { |
06 |
log(1,'signing failed'); |
07 |
} |
08 |
} else { |
09 |
log(1,'no S/MIME key available, do not sign'); |
10 |
} |
Erklärung
In diesem Beispiel wird zunächst geprüft, ob ein privater S/MIME Schlüssel verfügbar ist (Zeile 01). Das Ergebnis wird protokolliert (Zeile 02 und 09). Ist ein privater S/MIME Schlüssel vorhanden, so wird die E-Mail unter Verwenden des SHA256Algorithmus (Standard) im Opaque Verfahren signiert (Zeile 03) und das Ergebnis dieser Aktion wird ebenfalls in das Log geschrieben (Zeile 04 beziehungsweise 06).
