1 fe371fc9 2019-09-05 martijn .\" $OpenBSD$
3 fe371fc9 2019-09-05 martijn .\" Copyright (c) 2019 Martijn van Duren <martijn@openbsd.org>
5 fe371fc9 2019-09-05 martijn .\" Permission to use, copy, modify, and distribute this software for any
6 fe371fc9 2019-09-05 martijn .\" purpose with or without fee is hereby granted, provided that the above
7 fe371fc9 2019-09-05 martijn .\" copyright notice and this permission notice appear in all copies.
9 fe371fc9 2019-09-05 martijn .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 fe371fc9 2019-09-05 martijn .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 fe371fc9 2019-09-05 martijn .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 fe371fc9 2019-09-05 martijn .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 fe371fc9 2019-09-05 martijn .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 fe371fc9 2019-09-05 martijn .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 fe371fc9 2019-09-05 martijn .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 fe371fc9 2019-09-05 martijn .Dd $Mdocdate$
18 fe371fc9 2019-09-05 martijn .Dt FILTER-DKIMSIGN 8
21 fe371fc9 2019-09-05 martijn .Nm filter-dkimsign
22 fe371fc9 2019-09-05 martijn .Nd add dkim signature to messages
23 fe371fc9 2019-09-05 martijn .Sh SYNOPSIS
25 fe371fc9 2019-09-05 martijn .Op Fl tz
26 fe371fc9 2019-09-05 martijn .Op Fl a Ar algorithm
27 fe371fc9 2019-09-05 martijn .Op Fl c Ar canonicalization
28 fe371fc9 2019-09-05 martijn .Op Fl h Ar headers
29 fe371fc9 2019-09-05 martijn .Op Fl x Ar seconds
30 fe371fc9 2019-09-05 martijn .Fl d Ar domain
31 fe371fc9 2019-09-05 martijn .Fl k Ar file
32 fe371fc9 2019-09-05 martijn .Fl s Ar selector
33 fe371fc9 2019-09-05 martijn .Sh DESCRIPTION
35 fe371fc9 2019-09-05 martijn adds a dkim signature to the message.
36 fe371fc9 2019-09-05 martijn The following flags are supported:
37 fe371fc9 2019-09-05 martijn .Bl -tag -width Ds
38 fe371fc9 2019-09-05 martijn .It Fl a Ar algorithm
40 6bcbc798 2021-05-16 martijn .Ar algorithm
42 6bcbc798 2021-05-16 martijn Supported signing algorithms are
45 6bcbc798 2021-05-16 martijn .Em ed25519 Pq when enabled at compile time .
46 fe371fc9 2019-09-05 martijn Only sha256 should be used for hashing, since other algorithms are most likely
47 fe371fc9 2019-09-05 martijn not supported by verifiers.
48 fe371fc9 2019-09-05 martijn Defaults to
49 6bcbc798 2021-05-16 martijn .Cm rsa-sha256 .
50 fe371fc9 2019-09-05 martijn .It Fl c Ar canonicalization
51 11b561e3 2020-10-18 martijn The canonicalization algorithm used to sign the message.
52 fe371fc9 2019-09-05 martijn Defaults to
53 11b561e3 2020-10-18 martijn .Em simple/simple .
54 fe371fc9 2019-09-05 martijn .It Fl d Ar domain
56 40cd76f4 2020-08-30 martijn .Ar domain
57 40cd76f4 2020-08-30 martijn where the public key can be found.
58 40cd76f4 2020-08-30 martijn This option can be specified multiple times to select the best
59 40cd76f4 2020-08-30 martijn .Ar domain
60 40cd76f4 2020-08-30 martijn during signing.
61 40cd76f4 2020-08-30 martijn If specified multiple times it looks at the domain component of the first
62 40cd76f4 2020-08-30 martijn mailbox in the from-header and tries to find a match.
63 40cd76f4 2020-08-30 martijn If no exact match can be found it looks for the closest parent
64 40cd76f4 2020-08-30 martijn .Ar domain .
65 40cd76f4 2020-08-30 martijn If no matches can be the first
66 40cd76f4 2020-08-30 martijn .Ar domain
67 40cd76f4 2020-08-30 martijn specified will be used.
68 fe371fc9 2019-09-05 martijn .It Fl h Ar headers
69 fe371fc9 2019-09-05 martijn The email headers which are included in the mail signature.
70 fe371fc9 2019-09-05 martijn Per RFC this option requires at least the from header to be included.
71 fe371fc9 2019-09-05 martijn The headers are specified by separating them with a colon.
72 fe371fc9 2019-09-05 martijn The default is
73 11b561e3 2020-10-18 martijn .Em from:reply-to:subject:date:to:cc:resent-date:resent-from:resent-to:resent-cc:in-reply-to:references:list-id:list-help:list-unsubscribe:list-subscribe:list-post:list-owner:list-archive .
74 fe371fc9 2019-09-05 martijn .It Fl k Ar file
76 fe371fc9 2019-09-05 martijn should point to a file containing the RSA private key to sign the messages.
77 fe371fc9 2019-09-05 martijn .It Fl s Ar selector
78 fe371fc9 2019-09-05 martijn The selector within the _domainkey subdomain of
79 fe371fc9 2019-09-05 martijn .Ar domain
80 fe371fc9 2019-09-05 martijn where the public key can be found.
82 fe371fc9 2019-09-05 martijn Add the time of signing to the dkim header.
83 fe371fc9 2019-09-05 martijn .It Fl x Ar seconds
84 fe371fc9 2019-09-05 martijn Add the amount of
85 fe371fc9 2019-09-05 martijn .Ar seconds
86 fe371fc9 2019-09-05 martijn the signature is valid to the dkim header.
88 fe371fc9 2019-09-05 martijn Add the mail headers used in the dkim signature to the dkim header.
89 fe371fc9 2019-09-05 martijn If a second
91 fe371fc9 2019-09-05 martijn is specified all headers will be included in the dkim header.
92 fe371fc9 2019-09-05 martijn Useful for debugging purposes.
94 fe371fc9 2019-09-05 martijn .Sh SEE ALSO
95 fe371fc9 2019-09-05 martijn .Xr smtpd 8
96 11b561e3 2020-10-18 martijn .Sh STANDARDS
98 11b561e3 2020-10-18 martijn .%A D. Crocker, Ed.
99 59519201 2021-06-02 martijn .%Q Brandenburg InternetWorking
100 11b561e3 2020-10-18 martijn .%A T. Hansen, Ed.
101 59519201 2021-06-02 martijn .%Q AT&T Laboratories
102 11b561e3 2020-10-18 martijn .%A M. Kucherawy, Ed.
103 59519201 2021-06-02 martijn .%Q Cloudmark
104 11b561e3 2020-10-18 martijn .%D September 2011
105 11b561e3 2020-10-18 martijn .%R RFC 6376
106 11b561e3 2020-10-18 martijn .%T DomainKeys Identified Mail (DKIM) Signatures
110 59519201 2021-06-02 martijn .%A J. Levine
111 59519201 2021-06-02 martijn .%Q Taughannock Networks
112 59519201 2021-06-02 martijn .%D September 2018
113 59519201 2021-06-02 martijn .%R RFC 8463
114 59519201 2021-06-02 martijn .%T A New Cryptographic Signature Method for DomainKeys Identified Mail
116 11b561e3 2020-10-18 martijn .Sh AUTHORS
117 11b561e3 2020-10-18 martijn .An Martijn van Duren Aq Mt martijn@openbsd.org
