/usr/share/perl5/Mail/DKIM/AuthorDomainPolicy.pm is in libmail-dkim-perl 0.44-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 | #!/usr/bin/perl
# Copyright 2005-2009 Messiah College.
# Jason Long <jlong@messiah.edu>
# Copyright (c) 2004 Anthony D. Urso. All rights reserved.
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
use strict;
use warnings;
package Mail::DKIM::AuthorDomainPolicy;
use base "Mail::DKIM::Policy";
# base class is used for parse(), as_string()
use Mail::DKIM::DNS;
=head1 NAME
Mail::DKIM::AuthorDomainPolicy - represents an Author Domain Signing Practices (ADSP) record
=head1 DESCRIPTION
The Author Domain Signing Policies (ADSP) record can be published by any
domain to help a receiver know what to do when it encounters an unsigned
message claiming to originate from that domain.
The record is published as a DNS TXT record at _adsp._domainkey.DOMAIN
where DOMAIN is the domain of the message's "From" address.
More details about this record can be found by reading the specification
itself at L<http://tools.ietf.org/html/rfc5617>.
=head1 CONSTRUCTORS
=head2 fetch()
Lookup an ADSP record in DNS.
my $policy = Mail::DKIM::AuthorDomainPolicy->fetch(
Protocol => "dns",
Author => 'jsmith@example.org',
);
If the ADSP record is found and appears to be valid, an object
containing that record's information will be constructed and returned.
If the ADSP record is blank or simply does not exist, an object
representing the default policy will be returned instead.
(See also L</"is_implied_default_policy()">.)
If a DNS error occurs (e.g. SERVFAIL or time-out), this method
will "die".
=cut
sub fetch
{
my $class = shift;
my %prms = @_;
my $self = eval { $class->SUPER::fetch(%prms) };
my $E = $@;
if ($self && !$self->is_implied_default_policy)
{
return $self;
}
# didn't find a policy; check the domain itself
{
#FIXME- not good to have this code duplicated between
#here and get_lookup_name()
#
if ($prms{Author} && !$prms{Domain})
{
$prms{Domain} = ($prms{Author} =~ /\@([^@]*)$/ and $1);
}
unless ($prms{Domain})
{
die "no domain to fetch policy for\n";
}
my @resp = Mail::DKIM::DNS::query($prms{Domain}, "MX");
if (!@resp && $@ eq "NXDOMAIN")
{
return $class->nxdomain_policy;
}
}
die $E if $E;
return $self;
}
# get_lookup_name() - determine name of record to fetch
#
sub get_lookup_name
{
my $self = shift;
my ($prms) = @_;
# in ADSP, the record to fetch is determined based on the From header
if ($prms->{Author} && !$prms->{Domain})
{
$prms->{Domain} = ($prms->{Author} =~ /\@([^@]*)$/ and $1);
}
unless ($prms->{Domain})
{
die "no domain to fetch policy for\n";
}
# IETF seems poised to create policy records this way
return "_adsp._domainkey." . $prms->{Domain};
}
=head2 new()
Construct a default policy object.
my $policy = Mail::DKIM::AuthorDomainPolicy->new;
=cut
sub new
{
my $class = shift;
return $class->parse(String => "");
}
=head2 parse()
Construct an ADSP record from a string.
my $policy = Mail::DKIM::AuthorDomainPolicy->parse(
String => "dkim=all",
Domain => "aaa.example",
);
=cut
#undocumented private class method
our $DEFAULT_POLICY;
sub default
{
my $class = shift;
$DEFAULT_POLICY ||= $class->new;
return $DEFAULT_POLICY;
}
#undocumented private class method
our $NXDOMAIN_POLICY;
sub nxdomain_policy
{
my $class = shift;
if (!$NXDOMAIN_POLICY)
{
$NXDOMAIN_POLICY = $class->new;
$NXDOMAIN_POLICY->policy("NXDOMAIN");
}
return $NXDOMAIN_POLICY;
}
=head1 METHODS
=head2 apply()
Apply the policy to the results of a DKIM verifier.
my $result = $policy->apply($dkim_verifier);
The caller must provide an instance of L<Mail::DKIM::Verifier>, one which
has already been fed the message being verified.
Possible results are:
=over
=item accept
The message is approved by the sender signing policy.
=item reject
The message is rejected by the sender signing policy.
It can be considered very suspicious.
=item neutral
The message is neither approved nor rejected by the sender signing
policy. It can be considered somewhat suspicious.
=back
Note: in the future, these values may become:
none - no ADSP record is published
pass - a passing signature is present
fail - ADSP record is "all" and no passing signature is found
discard - ADSP record is "discardable" and no passing signature is found
nxdomain - the DNS domain does not exist
temperror - transient error occurred
permerror - non-transient error occurred
=cut
sub apply
{
my $self = shift;
my ($dkim) = @_;
# first_party indicates whether there is a DKIM signature with
# a d= tag matching the address in the From: header
my $first_party;
my @passing_signatures = grep {
$_->result && $_->result eq "pass"
} $dkim->signatures;
foreach my $signature (@passing_signatures)
{
my $author_domain = $dkim->message_originator->host;
if (lc $author_domain eq lc $signature->domain)
{
# found a first party signature
$first_party = 1;
last;
}
}
return "accept" if $first_party;
return "reject" if ($self->signall_strict);
return "neutral";
}
=head2 is_implied_default_policy()
Tells whether this policy implied.
my $is_implied = $policy->is_implied_default_policy;
If you fetch the policy for a particular domain, but that domain
does not have a policy published, then the "default policy" is
in effect. Use this method to detect when that happens.
=cut
sub is_implied_default_policy
{
my $self = shift;
my $default_policy = ref($self)->default;
return ($self == $default_policy);
}
=head2 location()
Tells where the policy was fetched from.
If the policy is domain-wide, this will be domain where the policy was
published.
If the policy is user-specific, TBD.
If nothing is published for the domain, and the default policy
was returned instead, the location will be C<undef>.
=cut
sub location
{
my $self = shift;
return $self->{Domain};
}
sub name
{
return "ADSP";
}
=head2 policy()
Get or set the outbound signing policy (dkim=) tag.
my $sp = $policy->policy;
Outbound signing policy for the entity. Possible values are:
=over
=item C<unknown>
The default. The entity may sign some or all email.
=item C<all>
All mail from the domain is expected to be signed, using a valid Author
signature, but the author does not suggest discarding mail without a
valid signature.
=item C<discardable>
All mail from the domain is expected to be signed, using a valid Author
signature, and the author is so confident that non-signed mail claiming
to be from this domain can be automatically discarded by the recipient's
mail server.
=item C<"NXDOMAIN">
The domain is out of scope, i.e., the domain does not exist in the
DNS.
=back
=cut
sub policy
{
my $self = shift;
(@_) and
$self->{tags}->{dkim} = shift;
if (defined $self->{tags}->{dkim})
{
return $self->{tags}->{dkim};
}
else
{
return "unknown";
}
}
=head2 signall()
True if policy is "all".
=cut
sub signall
{
my $self = shift;
return $self->policy &&
($self->policy =~ /all/i);
}
=head2 signall_discardable()
True if policy is "strict".
=cut
sub signall_strict
{
my $self = shift;
return $self->policy &&
($self->policy =~ /discardable/i);
}
1;
=head1 BUGS
=over
=item *
Section 4.3 of the specification says to perform a query on the
domain itself just to see if it exists. This class is not
currently doing that, i.e. it might report NXDOMAIN because
_adsp._domainkey.example.org is nonexistent, but it should
not be treated the same as example.org being nonexistent.
=back
=head1 AUTHOR
Jason Long, E<lt>jlong@messiah.eduE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2006-2009 by Messiah College
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.
=cut
|