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
39 fe371fc9 2019-09-05 martijn The algorithm to use.
40 fe371fc9 2019-09-05 martijn This implementation only supports rsa cryptography.
41 fe371fc9 2019-09-05 martijn Only sha256 should be used for hashing, since other algorithms are most likely
42 fe371fc9 2019-09-05 martijn not supported by verifiers.
43 fe371fc9 2019-09-05 martijn Defaults to
44 fe371fc9 2019-09-05 martijn .Ar rsa-sha256 .
45 fe371fc9 2019-09-05 martijn .It Fl c Ar canonicalization
46 fe371fc9 2019-09-05 martijn The canonicalization algorithm used to sign the messge.
47 fe371fc9 2019-09-05 martijn Defaults to
48 fe371fc9 2019-09-05 martijn .Ar simple/simple .
49 fe371fc9 2019-09-05 martijn .It Fl d Ar domain
51 40cd76f4 2020-08-30 martijn .Ar domain
52 40cd76f4 2020-08-30 martijn where the public key can be found.
53 40cd76f4 2020-08-30 martijn This option can be specified multiple times to select the best
54 40cd76f4 2020-08-30 martijn .Ar domain
55 40cd76f4 2020-08-30 martijn during signing.
56 40cd76f4 2020-08-30 martijn If specified multiple times it looks at the domain component of the first
57 40cd76f4 2020-08-30 martijn mailbox in the from-header and tries to find a match.
58 40cd76f4 2020-08-30 martijn If no exact match can be found it looks for the closest parent
59 40cd76f4 2020-08-30 martijn .Ar domain .
60 40cd76f4 2020-08-30 martijn If no matches can be the first
61 40cd76f4 2020-08-30 martijn .Ar domain
62 40cd76f4 2020-08-30 martijn specified will be used.
63 fe371fc9 2019-09-05 martijn .It Fl h Ar headers
64 fe371fc9 2019-09-05 martijn The email headers which are included in the mail signature.
65 fe371fc9 2019-09-05 martijn Per RFC this option requires at least the from header to be included.
66 fe371fc9 2019-09-05 martijn The headers are specified by separating them with a colon.
67 fe371fc9 2019-09-05 martijn The default is
68 fe371fc9 2019-09-05 martijn 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 .
69 fe371fc9 2019-09-05 martijn .It Fl k Ar file
71 fe371fc9 2019-09-05 martijn should point to a file containing the RSA private key to sign the messages.
72 fe371fc9 2019-09-05 martijn .It Fl s Ar selector
73 fe371fc9 2019-09-05 martijn The selector within the _domainkey subdomain of
74 fe371fc9 2019-09-05 martijn .Ar domain
75 fe371fc9 2019-09-05 martijn where the public key can be found.
77 fe371fc9 2019-09-05 martijn Add the time of signing to the dkim header.
78 fe371fc9 2019-09-05 martijn .It Fl x Ar seconds
79 fe371fc9 2019-09-05 martijn Add the amount of
80 fe371fc9 2019-09-05 martijn .Ar seconds
81 fe371fc9 2019-09-05 martijn the signature is valid to the dkim header.
83 fe371fc9 2019-09-05 martijn Add the mail headers used in the dkim signature to the dkim header.
84 fe371fc9 2019-09-05 martijn If a second
86 fe371fc9 2019-09-05 martijn is specified all headers will be included in the dkim header.
87 fe371fc9 2019-09-05 martijn Useful for debugging purposes.
89 fe371fc9 2019-09-05 martijn .Sh SEE ALSO
90 fe371fc9 2019-09-05 martijn .Xr smtpd 8
