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 5fdffb49 2022-01-27 martijn .Fl D Ar file
32 fe371fc9 2019-09-05 martijn .Fl k Ar file
33 fe371fc9 2019-09-05 martijn .Fl s Ar selector
34 fe371fc9 2019-09-05 martijn .Sh DESCRIPTION
36 fe371fc9 2019-09-05 martijn adds a dkim signature to the message.
37 fe371fc9 2019-09-05 martijn The following flags are supported:
38 fe371fc9 2019-09-05 martijn .Bl -tag -width Ds
39 fe371fc9 2019-09-05 martijn .It Fl a Ar algorithm
41 6bcbc798 2021-05-16 martijn .Ar algorithm
43 6bcbc798 2021-05-16 martijn Supported signing algorithms are
46 6bcbc798 2021-05-16 martijn .Em ed25519 Pq when enabled at compile time .
47 fe371fc9 2019-09-05 martijn Only sha256 should be used for hashing, since other algorithms are most likely
48 fe371fc9 2019-09-05 martijn not supported by verifiers.
49 fe371fc9 2019-09-05 martijn Defaults to
50 6bcbc798 2021-05-16 martijn .Cm rsa-sha256 .
51 fe371fc9 2019-09-05 martijn .It Fl c Ar canonicalization
52 11b561e3 2020-10-18 martijn The canonicalization algorithm used to sign the message.
53 fe371fc9 2019-09-05 martijn Defaults to
54 11b561e3 2020-10-18 martijn .Em simple/simple .
55 5fdffb49 2022-01-27 martijn .It Fl D Ar file
57 5fdffb49 2022-01-27 martijn should point to a file containing a list of domains.
58 5fdffb49 2022-01-27 martijn Only one domain per line should be specified.
61 5fdffb49 2022-01-27 martijn for more information.
62 fe371fc9 2019-09-05 martijn .It Fl d Ar domain
64 40cd76f4 2020-08-30 martijn .Ar domain
65 40cd76f4 2020-08-30 martijn where the public key can be found.
66 40cd76f4 2020-08-30 martijn This option can be specified multiple times to select the best
67 40cd76f4 2020-08-30 martijn .Ar domain
68 40cd76f4 2020-08-30 martijn during signing.
69 40cd76f4 2020-08-30 martijn If specified multiple times it looks at the domain component of the first
70 40cd76f4 2020-08-30 martijn mailbox in the from-header and tries to find a match.
71 40cd76f4 2020-08-30 martijn If no exact match can be found it looks for the closest parent
72 40cd76f4 2020-08-30 martijn .Ar domain .
73 40cd76f4 2020-08-30 martijn If no matches can be the first
74 40cd76f4 2020-08-30 martijn .Ar domain
75 40cd76f4 2020-08-30 martijn specified will be used.
76 fe371fc9 2019-09-05 martijn .It Fl h Ar headers
77 fe371fc9 2019-09-05 martijn The email headers which are included in the mail signature.
78 fe371fc9 2019-09-05 martijn Per RFC this option requires at least the from header to be included.
79 fe371fc9 2019-09-05 martijn The headers are specified by separating them with a colon.
80 fe371fc9 2019-09-05 martijn The default is
81 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 .
82 fe371fc9 2019-09-05 martijn .It Fl k Ar file
84 fe371fc9 2019-09-05 martijn should point to a file containing the RSA private key to sign the messages.
85 fe371fc9 2019-09-05 martijn .It Fl s Ar selector
86 fe371fc9 2019-09-05 martijn The selector within the _domainkey subdomain of
87 fe371fc9 2019-09-05 martijn .Ar domain
88 fe371fc9 2019-09-05 martijn where the public key can be found.
90 fe371fc9 2019-09-05 martijn Add the time of signing to the dkim header.
91 fe371fc9 2019-09-05 martijn .It Fl x Ar seconds
92 fe371fc9 2019-09-05 martijn Add the amount of
93 fe371fc9 2019-09-05 martijn .Ar seconds
94 fe371fc9 2019-09-05 martijn the signature is valid to the dkim header.
96 fe371fc9 2019-09-05 martijn Add the mail headers used in the dkim signature to the dkim header.
97 fe371fc9 2019-09-05 martijn If a second
99 fe371fc9 2019-09-05 martijn is specified all headers will be included in the dkim header.
100 fe371fc9 2019-09-05 martijn Useful for debugging purposes.
102 fe371fc9 2019-09-05 martijn .Sh SEE ALSO
103 fe371fc9 2019-09-05 martijn .Xr smtpd 8
104 11b561e3 2020-10-18 martijn .Sh STANDARDS
106 11b561e3 2020-10-18 martijn .%A D. Crocker, Ed.
107 59519201 2021-06-02 martijn .%Q Brandenburg InternetWorking
108 11b561e3 2020-10-18 martijn .%A T. Hansen, Ed.
109 59519201 2021-06-02 martijn .%Q AT&T Laboratories
110 11b561e3 2020-10-18 martijn .%A M. Kucherawy, Ed.
111 59519201 2021-06-02 martijn .%Q Cloudmark
112 11b561e3 2020-10-18 martijn .%D September 2011
113 11b561e3 2020-10-18 martijn .%R RFC 6376
114 11b561e3 2020-10-18 martijn .%T DomainKeys Identified Mail (DKIM) Signatures
118 59519201 2021-06-02 martijn .%A J. Levine
119 59519201 2021-06-02 martijn .%Q Taughannock Networks
120 59519201 2021-06-02 martijn .%D September 2018
121 59519201 2021-06-02 martijn .%R RFC 8463
122 59519201 2021-06-02 martijn .%T A New Cryptographic Signature Method for DomainKeys Identified Mail
124 11b561e3 2020-10-18 martijn .Sh AUTHORS
125 11b561e3 2020-10-18 martijn .An Martijn van Duren Aq Mt martijn@openbsd.org
