1 55999c73 2019-08-22 martijn .\" $OpenBSD$
3 55999c73 2019-08-22 martijn .\" Copyright (c) 2019 Martijn van Duren <martijn@openbsd.org>
5 55999c73 2019-08-22 martijn .\" Permission to use, copy, modify, and distribute this software for any
6 55999c73 2019-08-22 martijn .\" purpose with or without fee is hereby granted, provided that the above
7 55999c73 2019-08-22 martijn .\" copyright notice and this permission notice appear in all copies.
9 55999c73 2019-08-22 martijn .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 55999c73 2019-08-22 martijn .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 55999c73 2019-08-22 martijn .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 55999c73 2019-08-22 martijn .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 55999c73 2019-08-22 martijn .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 55999c73 2019-08-22 martijn .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 55999c73 2019-08-22 martijn .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 55999c73 2019-08-22 martijn .Dd $Mdocdate$
18 55999c73 2019-08-22 martijn .Dt FILTER-DKIM 8
21 55999c73 2019-08-22 martijn .Nm filter-dkim
22 55999c73 2019-08-22 martijn .Nd add dkim signature to messages
23 55999c73 2019-08-22 martijn .Sh SYNOPSIS
25 55999c73 2019-08-22 martijn .Op Fl tz
26 55999c73 2019-08-22 martijn .Op Fl a Ar algorithm
27 55999c73 2019-08-22 martijn .Op Fl c Ar canonicalization
28 55999c73 2019-08-22 martijn .Op Fl h Ar headers
29 55999c73 2019-08-22 martijn .Op Fl x Ar seconds
30 55999c73 2019-08-22 martijn .Fl d Ar domain
31 55999c73 2019-08-22 martijn .Fl k Ar file
32 55999c73 2019-08-22 martijn .Fl s Ar selector
33 55999c73 2019-08-22 martijn .Sh DESCRIPTION
35 55999c73 2019-08-22 martijn adds a dkim signature to the message.
36 55999c73 2019-08-22 martijn The following flags are supported:
37 55999c73 2019-08-22 martijn .Bl -tag -width Ds
38 f49f2044 2019-08-23 martijn .It Fl a Ar algorithm
39 55999c73 2019-08-22 martijn The algorithm to use.
40 55999c73 2019-08-22 martijn This implementation only supports rsa cryptography.
41 55999c73 2019-08-22 martijn Only sha256 should be used for hashing, since other algorithms are most likely
42 55999c73 2019-08-22 martijn not supported by verifiers.
43 55999c73 2019-08-22 martijn Defaults to
44 55999c73 2019-08-22 martijn .Ar rsa-sha256 .
45 f49f2044 2019-08-23 martijn .It Fl c Ar canonicalization
46 55999c73 2019-08-22 martijn The canonicalization algorithm used to sign the messge.
47 55999c73 2019-08-22 martijn Defaults to
48 55999c73 2019-08-22 martijn .Ar simple/simple .
49 f49f2044 2019-08-23 martijn .It Fl d Ar domain
50 55999c73 2019-08-22 martijn The domain where the public key can be found.
51 f49f2044 2019-08-23 martijn .It Fl h Ar headers
52 55999c73 2019-08-22 martijn The email headers which are included in the mail signature.
53 55999c73 2019-08-22 martijn Per RFC this option requires at least the from header to be included.
54 55999c73 2019-08-22 martijn The headers are specified by separating them with a colon.
55 55999c73 2019-08-22 martijn The default is
56 55999c73 2019-08-22 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 .
57 f49f2044 2019-08-23 martijn .It Fl k Ar file
59 55999c73 2019-08-22 martijn should point to a file containing the RSA private key to sign the messages.
60 f49f2044 2019-08-23 martijn .It Fl s Ar selector
61 55999c73 2019-08-22 martijn The selector within the _domainkey subdomain of
62 55999c73 2019-08-22 martijn .Ar domain
63 55999c73 2019-08-22 martijn where the public key can be found.
65 55999c73 2019-08-22 martijn Add the time of signing to the dkim header.
66 f49f2044 2019-08-23 martijn .It Fl x Ar seconds
67 55999c73 2019-08-22 martijn Add the amount of
68 55999c73 2019-08-22 martijn .Ar seconds
69 55999c73 2019-08-22 martijn the signature is valid to the dkim header.
71 55999c73 2019-08-22 martijn Add the mail headers used in the dkim signature to the dkim header.
72 55999c73 2019-08-22 martijn If a second
74 55999c73 2019-08-22 martijn is specified all headers will be included in the dkim header.
75 55999c73 2019-08-22 martijn Useful for debugging purposes.
77 55999c73 2019-08-22 martijn .Sh SEE ALSO
78 55999c73 2019-08-22 martijn .Xr smtpd 8
