1Mail::SpamAssassin::PluUgsienr::CDoKnItMr(i3b)uted PerlMDaoiclu:m:eSnptaamtAisosnassin::Plugin::DKIM(3)
2
6 Mail::SpamAssassin::Plugin::DKIM - perform DKIM verification tests
7
9 loadplugin Mail::SpamAssassin::Plugin::DKIM [/path/to/DKIM.pm]
10 full DKIM_VALID eval:check_dkim_valid()
12 full DKIM_VALID_AU eval:check_dkim_valid_author_sig()
13 (for compatibility, a check_dkim_verified is a synonym for
15 check_dkim_valid)
16
18 This SpamAssassin plugin implements DKIM lookups as described by the
19 RFC 4871, as well as historical DomainKeys lookups, as described by RFC
20 4870, thanks to the support for both types of signatures by newer ver‐
21 sions of module Mail::DKIM (0.22 or later).
22 It requires the "Mail::DKIM" CPAN module to operate. Many thanks to
24 Jason Long for that module.
25
27 The following tags are added to the set, available for use in reports,
28 header fields, other plugins, etc.:
29 _DKIMIDENTITY_ signing identities (the 'i' tag) from valid signatures;
31 _DKIMDOMAIN_ signing domains (the 'd' tag) from valid signatures;
32 Identities and domains from signatures which failed verification are
34 not included in these tags. Duplicates are eliminated (e.g. when there
35 are two or more valid signatures from the same signer, only one copy
36 makes it into a tag). Note that there may be more than one signature
37 in a message - currently they are provided as a space-separated list,
38 although this behaviour may change.
39
41 "Mail::DKIM", "Mail::SpamAssassin::Plugin"
42 http://jason.long.name/dkimproxy/
44 http://tools.ietf.org/rfc/rfc4871.txt
45 http://tools.ietf.org/rfc/rfc4870.txt
46 http://ietf.org/html.charters/dkim-charter.html
47
49 whitelist_from_dkim author@example.com [signing-identity]
50 Use this to supplement the whitelist_from addresses with a check to
51 make sure the message with a given From address (the author's
52 address) carries a valid Domain Keys Identified Mail (DKIM) signa‐
53 ture by a verifier-acceptable signing-identity (the i= tag).
54 Only one whitelist entry is allowed per line, as in
56 "whitelist_from_rcvd". Multiple "whitelist_from_dkim" lines are
57 allowed. File-glob style characters are allowed for the From
58 address (the first parameter), just like with
59 "whitelist_from_rcvd". The second parameter does not accept wild‐
60 cards.
61 If no signing identity parameter is specified, the only acceptable
63 signature will be a first-party signature, i.e. the so called
64 author signature, which is a signature where the signing identity
65 of a signature matches the author address (i.e. the address in a
66 From header field).
67 Since this whitelist requires a DKIM check to be made, network
69 tests must be enabled.
70 Examples of whitelisting based on an author signature
72 (first-party):
73 whitelist_from_dkim joe@example.com
75 whitelist_from_dkim *@corp.example.com
76 whitelist_from_dkim *@*.example.com
77 Examples of whitelisting based on third-party signatures:
79 whitelist_from_dkim rick@example.net richard@example.net
81 whitelist_from_dkim rick@sub.example.net example.net
82 whitelist_from_dkim jane@example.net example.org
83 whitelist_from_dkim *@info.example.com example.com
84 whitelist_from_dkim *@* remailer.example.com
85 def_whitelist_from_dkim author@example.com [signing-identity]
87 Same as "whitelist_from_dkim", but used for the default whitelist
88 entries in the SpamAssassin distribution. The whitelist score is
89 lower, because these are often targets for abuse of public mailers
90 which sign their mail.
91
93 dkim_timeout n (default: 5)
94 How many seconds to wait for a DKIM query to complete, before scan‐
95 ning continues without the DKIM result.
96perl v5.8.8 2008-01-05Mail::SpamAssassin::Plugin::DKIM(3)