]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/SaPlugin/ListMirror.pm
localize $/ when using chomp
[public-inbox.git] / lib / PublicInbox / SaPlugin / ListMirror.pm
1 # Copyright (C) 2016 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3
4 # Rules useful for running a mailing list mirror.  We want to:
5 # * ensure Received: headers are really from the list mail server
6 #   users expect.  This is to prevent malicious users from
7 #   injecting spam into mirrors without going through the expected
8 #   server
9 # * flag messages where the mailing list is Bcc:-ed since it is
10 #   common for spam to have wrong or non-existent To:/Cc: headers.
11
12 package PublicInbox::SaPlugin::ListMirror;
13 use strict;
14 use warnings;
15 use base qw(Mail::SpamAssassin::Plugin);
16
17 # constructor: register the eval rules
18 sub new {
19         my ($class, $mail) = @_;
20
21         # some boilerplate...
22         $class = ref($class) || $class;
23         my $self = $class->SUPER::new($mail);
24         bless $self, $class;
25         $mail->{conf}->{list_mirror_check} = [];
26         $self->register_eval_rule('check_list_mirror_received');
27         $self->register_eval_rule('check_list_mirror_bcc');
28         $self->set_config($mail->{conf});
29         $self;
30 }
31
32 sub check_list_mirror_received {
33         my ($self, $pms) = @_;
34         my $recvd = $pms->get('Received') || '';
35         $recvd =~ s/\n.*\z//s;
36
37         foreach my $cfg (@{$pms->{conf}->{list_mirror_check}}) {
38                 my ($hdr, $hval, $host_re, $addr_re) = @$cfg;
39                 my $v = $pms->get($hdr) or next;
40                 local $/ = "\n";
41                 chomp $v;
42                 next if $v ne $hval;
43                 return 1 if $recvd !~ $host_re;
44         }
45
46         0;
47 }
48
49 sub check_list_mirror_bcc {
50         my ($self, $pms) = @_;
51         my $tocc = $pms->get('ToCc');
52
53         foreach my $cfg (@{$pms->{conf}->{list_mirror_check}}) {
54                 my ($hdr, $hval, $host_re, $addr_re) = @$cfg;
55                 defined $addr_re or next;
56                 my $v = $pms->get($hdr) or next;
57                 local $/ = "\n";
58                 chomp $v;
59                 next if $v ne $hval;
60                 return 1 if !$tocc || $tocc !~ $addr_re;
61         }
62
63         0;
64 }
65
66 # list_mirror HEADER HEADER_VALUE HOSTNAME_GLOB [LIST_ADDRESS]
67 # list_mirror X-Mailing-List git@vger.kernel.org *.kernel.org
68 # list_mirror List-Id <foo.example.org> *.example.org foo@example.org
69 sub config_list_mirror {
70         my ($self, $key, $value, $line) = @_;
71
72         defined $value or
73                 return $Mail::SpamAssassin::Conf::MISSING_REQUIRED_VALUE;
74
75         my ($hdr, $hval, $host_glob, @extra) = split(/\s+/, $value);
76         my $addr = shift @extra;
77
78         if (defined $addr) {
79                 $addr !~ /\@/ and
80                         return $Mail::SpamAssassin::Conf::INVALID_VALUE;
81                 $addr = join('|', map { quotemeta } split(/,/, $addr));
82                 $addr = qr/\b$addr\b/i;
83         }
84
85         @extra and return $Mail::SpamAssassin::Conf::INVALID_VALUE;
86
87         defined $host_glob or
88                 return $Mail::SpamAssassin::Conf::MISSING_REQUIRED_VALUE;
89
90         my %patmap = ('*' => '\S+', '?' => '.', '[' => '[', ']' => ']');
91         $host_glob =~ s!(.)!$patmap{$1} || "\Q$1"!ge;
92         my $host_re = qr/\A\s*from\s+$host_glob(?:\s|$)/si;
93
94         push @{$self->{list_mirror_check}}, [ $hdr, $hval, $host_re, $addr ];
95 }
96
97 sub set_config {
98         my ($self, $conf) = @_;
99         my @cmds;
100         push @cmds, {
101                 setting => 'list_mirror',
102                 default => '',
103                 type => $Mail::SpamAssassin::Conf::CONF_TYPE_STRING,
104                 code => *config_list_mirror,
105         };
106         $conf->{parser}->register_commands(\@cmds);
107 }
108
109 1;