1Mail::DKIM::DkimPolicy(U3s)er Contributed Perl DocumentatMiaoinl::DKIM::DkimPolicy(3)
2
3
4

NAME

6       Mail::DKIM::DkimPolicy - represents a DKIM Sender Signing Practices
7       record
8

VERSION

10       version 1.20220520
11

DESCRIPTION

13       The Sender Signing Practices (SSP) record can be published by any
14       domain to help a receiver know what to do when it encounters an
15       unsigned message claiming to originate from that domain.
16
17       The record is published as a DNS TXT record at
18       _policy._domainkey.DOMAIN where DOMAIN is the domain of the message's
19       "From" address.
20
21       This record format has been superceded by ADSP. See
22       Mail::DKIM::AuthorDomainPolicy for information about ADSP.  It is
23       implemented here because at one time it appeared this is what would be
24       standardized by the IETF. It will be removed from Mail::DKIM at some
25       point in the future.  The last version of the SSP specification can be
26       found at <http://tools.ietf.org/html/draft-ietf-dkim-ssp-02>.
27

CONSTRUCTORS

29   fetch()
30       Lookup a DKIM signing practices record.
31
32         my $policy = Mail::DKIM::DkimPolicy->fetch(
33                   Protocol => 'dns',
34                   Author => 'jsmith@example.org',
35                 );
36
37   new()
38       Construct a default policy object.
39
40         my $policy = Mail::DKIM::DkimPolicy->new;
41

METHODS

43   apply()
44       Apply the policy to the results of a DKIM verifier.
45
46         my $result = $policy->apply($dkim_verifier);
47
48       The caller must provide an instance of Mail::DKIM::Verifier, one which
49       has already been fed the message being verified.
50
51       Possible results are:
52
53       accept
54           The message is approved by the sender signing policy.
55
56       reject
57           The message is rejected by the sender signing policy.  It can be
58           considered very suspicious.
59
60       neutral
61           The message is neither approved nor rejected by the sender signing
62           policy. It can be considered somewhat suspicious.
63
64   flags()
65       Get or set the flags (t=) tag.
66
67       A colon-separated list of flags. Flag values are:
68
69       y   The entity is testing signing practices, and the Verifier SHOULD
70           NOT consider a message suspicious based on the record.
71
72       s   The signing practices apply only to the named domain, and not to
73           subdomains.
74
75   is_implied_default_policy()
76       Is this policy implied?
77
78         my $is_implied = $policy->is_implied_default_policy;
79
80       If you fetch the policy for a particular domain, but that domain does
81       not have a policy published, then the "default policy" is in effect.
82       Use this method to detect when that happens.
83
84   location()
85       Where the policy was fetched from.
86
87       If the policy is domain-wide, this will be domain where the policy was
88       published.
89
90       If the policy is user-specific, TBD.
91
92       If nothing is published for the domain, and the default policy was
93       returned instead, the location will be "undef".
94
95   policy()
96       Get or set the outbound signing policy (dkim=) tag.
97
98         my $sp = $policy->policy;
99
100       Outbound signing policy for the entity. Possible values are:
101
102       "unknown"
103           The default. The entity may sign some or all email.
104
105       "all"
106           All mail from the entity is signed.  (The DKIM signature can use
107           any domain, not necessarily matching the From: address.)
108
109       "strict"
110           All mail from the entity is signed with Originator signatures.
111           (The DKIM signature uses a domain matching the From: address.)
112
113   signall()
114       True if policy is "all".
115
116   signall_strict()
117       True if policy is "strict".
118
119   testing()
120       Checks the testing flag.
121
122         my $testing = $policy->testing;
123
124       If nonzero, the testing flag is set on the signing policy, and the
125       verify should not consider a message suspicious based on this policy.
126

BUGS

128       •   If a sender signing policy is not found for a given domain, the
129           fetch() method should search the parent domains, according to
130           section 4 of the dkim-ssp Internet Draft.
131

AUTHORS

133       •   Jason Long <jason@long.name>
134
135       •   Marc Bradshaw <marc@marcbradshaw.net>
136
137       •   Bron Gondwana <brong@fastmailteam.com> (ARC)
138

THANKS

140       Work on ensuring that this module passes the ARC test suite was
141       generously sponsored by Valimail (https://www.valimail.com/)
142

144       •   Copyright (C) 2013 by Messiah College
145
146       •   Copyright (C) 2010 by Jason Long
147
148       •   Copyright (C) 2017 by Standcore LLC
149
150       •   Copyright (C) 2020 by FastMail Pty Ltd
151
152       This library is free software; you can redistribute it and/or modify it
153       under the same terms as Perl itself, either Perl version 5.8.6 or, at
154       your option, any later version of Perl 5 you may have available.
155
156
157
158perl v5.36.0                      2023-01-20         Mail::DKIM::DkimPolicy(3)
Impressum