/usr/share/perl5/Mail/SPF/Mech/Include.pm is in libmail-spf-perl 2.9.0-2.
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 | #
# Mail::SPF::Mech::Include
# SPF record "include" mechanism class.
#
# (C) 2005-2012 Julian Mehnle <julian@mehnle.net>
# 2005 Shevek <cpan@anarres.org>
# $Id: Include.pm 57 2012-01-30 08:15:31Z julian $
#
##############################################################################
package Mail::SPF::Mech::Include;
=head1 NAME
Mail::SPF::Mech::Include - SPF record C<include> mechanism class
=cut
use warnings;
use strict;
use base 'Mail::SPF::Mech';
use constant TRUE => (0 == 0);
use constant FALSE => not TRUE;
use constant name => 'include';
use constant name_pattern => qr/${\name}/i;
=head1 DESCRIPTION
An object of class B<Mail::SPF::Mech::Include> represents an SPF record
mechanism of type C<include>.
=head2 Constructors
The following constructors are provided:
=over
=item B<new(%options)>: returns I<Mail::SPF::Mech::Include>
Creates a new SPF record C<include> mechanism object.
%options is a list of key/value pairs representing any of the following
options:
=over
=item B<qualifier>
=item B<domain_spec>
See L<Mail::SPF::Mech/new>.
=back
=item B<new_from_string($text, %options)>: returns I<Mail::SPF::Mech::Include>;
throws I<Mail::SPF::ENothingToParse>, I<Mail::SPF::EInvalidMech>
Creates a new SPF record C<include> mechanism object by parsing the string and
any options given.
=back
=head2 Class methods
The following class methods are provided:
=over
=item B<default_qualifier>
=item B<qualifier_pattern>
See L<Mail::SPF::Mech/Class methods>.
=item B<name>: returns I<string>
Returns B<'include'>.
=item B<name_pattern>: returns I<Regexp>
Returns a regular expression that matches a mechanism name of B<'include'>.
=back
=head2 Instance methods
The following instance methods are provided:
=over
=cut
sub parse_params {
my ($self) = @_;
$self->parse_domain_spec(TRUE);
return;
}
=item B<text>
=item B<qualifier>
=item B<params>
=cut
sub params {
my ($self) = @_;
return defined($self->{domain_spec}) ? ':' . $self->{domain_spec} : undef;
}
=item B<stringify>
See L<Mail::SPF::Mech/Instance methods>.
=item B<domain_spec>: returns I<Mail::SPF::MacroString>
Returns the C<domain-spec> parameter of the mechanism.
=cut
# Make read-only accessor:
__PACKAGE__->make_accessor('domain_spec', TRUE);
=item B<match($server, $request)>: returns I<boolean>
Performs a recursive SPF check using the given SPF server and request objects
and substituting the mechanism's target domain name for the request's authority
domain. The result of the recursive SPF check is translated as follows:
Recursive result | Effect
------------------+-----------------
pass | return true
fail | return false
softfail | return false
neutral | return false
none | throw PermError
permerror | throw PermError
temperror | throw TempError
See RFC 4408, 5.2, for the exact algorithm used.
=cut
sub match {
my ($self, $server, $request) = @_;
$server->count_dns_interactive_term($request);
# Create sub-request with mutated authority domain:
my $authority_domain = $self->domain($server, $request);
my $sub_request = $request->new_sub_request(authority_domain => $authority_domain);
# Process sub-request:
my $result = $server->process($sub_request);
# Translate result of sub-request (RFC 4408, 5/9):
return TRUE
if $result->isa('Mail::SPF::Result::Pass');
return FALSE
if $result->isa('Mail::SPF::Result::Fail')
or $result->isa('Mail::SPF::Result::SoftFail')
or $result->isa('Mail::SPF::Result::Neutral');
$server->throw_result('permerror', $request,
"Included domain '$authority_domain' has no applicable sender policy")
if $result->isa('Mail::SPF::Result::None');
# Propagate any other results (including {Perm,Temp}Error) as-is:
$result->throw();
}
=back
=head1 SEE ALSO
L<Mail::SPF>, L<Mail::SPF::Record>, L<Mail::SPF::Term>, L<Mail::SPF::Mech>
L<http://tools.ietf.org/html/rfc4408>
For availability, support, and license information, see the README file
included with Mail::SPF.
=head1 AUTHORS
Julian Mehnle <julian@mehnle.net>, Shevek <cpan@anarres.org>
=cut
TRUE;
|