lib/PublicInbox/Filter.pm

   1 # Copyright (C) 2013-2015 all contributors <meta@public-inbox.org>
   2 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
   3 #
   4 # Used to filter incoming mail for -mda and importers
   5 # This only exposes one function: run
   6 # Note: the settings here are highly opinionated.  Obviously, this is
   7 # Free Software (AGPLv3), so you may change it if you host yourself.
   8 package PublicInbox::Filter;
   9 use strict;
  10 use warnings;
  11 use Email::MIME;
  12 use Email::MIME::ContentType qw/parse_content_type/;
  13 use Email::Filter;
  14 use IPC::Run;
  15 our $VERSION = '0.0.1';
  16 use constant NO_HTML => '*** We only accept plain-text email, no HTML ***';
  17 use constant TEXT_ONLY => '*** We only accept plain-text email ***';
  18
  19 # start with the same defaults as mailman
  20 our $BAD_EXT = qr/\.(exe|bat|cmd|com|pif|scr|vbs|cpl|zip)\s*\z/i;
  21 our $MIME_HTML = qr!\btext/x?html\b!i;
  22 our $MIME_TEXT_ANY = qr!\btext/[a-z0-9\+\._-]+\b!i;
  23
  24 # this is highly opinionated delivery
  25 # returns 0 only if there is nothing to deliver
  26 sub run {
  27         my ($class, $mime, $filter) = @_;
  28
  29         my $content_type = $mime->header('Content-Type') || 'text/plain';
  30
  31         # kill potentially bad/confusing headers
  32         # Note: ssoma already does this, but since we mangle the message,
  33         # we should do this before it gets to ssoma.
  34         foreach my $d (qw(status lines content-length)) {
  35                 $mime->header_set($d);
  36         }
  37
  38         if ($content_type =~ m!\btext/plain\b!i) {
  39                 return 1; # yay, nothing to do
  40         } elsif ($content_type =~ $MIME_HTML) {
  41                 $filter->reject(NO_HTML) if $filter;
  42                 # HTML-only, non-multipart
  43                 my $body = $mime->body;
  44                 my $ct_parsed = parse_content_type($content_type);
  45                 dump_html(\$body, $ct_parsed->{attributes}->{charset});
  46                 replace_body($mime, $body);
  47                 return 1;
  48         } elsif ($content_type =~ m!\bmultipart/!i) {
  49                 return strip_multipart($mime, $content_type, $filter);
  50         } else {
  51                 $filter->reject(TEXT_ONLY) if $filter;
  52                 replace_body($mime, "$content_type message scrubbed");
  53                 return 0;
  54         }
  55 }
  56
  57 sub replace_part {
  58         my ($mime, $part, $type) = ($_[0], $_[1], $_[3]);
  59         # don't copy $_[2], that's the body (it may be huge)
  60
  61         # Email::MIME insists on setting Date:, so just set it consistently
  62         # to avoid conflicts to avoid git merge conflicts in a split brain
  63         # situation.
  64         unless (defined $part->header('Date')) {
  65                 my $date = $mime->header('Date') ||
  66                            'Thu, 01 Jan 1970 00:00:00 +0000';
  67                 $part->header_set('Date', $date);
  68         }
  69
  70         $part->charset_set(undef);
  71         $part->name_set(undef);
  72         $part->filename_set(undef);
  73         $part->format_set(undef);
  74         $part->encoding_set('8bit');
  75         $part->disposition_set(undef);
  76         $part->content_type_set($type);
  77         $part->body_set($_[2]);
  78 }
  79
  80 # converts one part of a multipart message to text
  81 sub html_part_to_text {
  82         my ($mime, $part) = @_;
  83         my $body = $part->body;
  84         my $ct_parsed = parse_content_type($part->content_type);
  85         dump_html(\$body, $ct_parsed->{attributes}->{charset});
  86         replace_part($mime, $part, $body, 'text/plain');
  87 }
  88
  89 # modifies $_[0] in place
  90 sub dump_html {
  91         my ($body, $charset) = @_;
  92         $charset ||= 'US-ASCII';
  93         my @cmd = qw(lynx -stdin -stderr -dump);
  94         my $out = "";
  95         my $err = "";
  96
  97         # be careful about remote command injection!
  98         if ($charset =~ /\A([A-Za-z0-9\-]+)\z/) {
  99                 push @cmd, "-assume_charset=$charset";
 100         }
 101         if (IPC::Run::run(\@cmd, $body, \$out, \$err)) {
 102                 $out =~ s/\r\n/\n/sg;
 103                 $$body = $out;
 104         } else {
 105                 # give them an ugly version:
 106                 $$body = "public-inbox HTML conversion failed: $err\n" .
 107                          $$body . "\n";
 108         }
 109 }
 110
 111 # this is to correct old archives during import.
 112 sub strip_multipart {
 113         my ($mime, $content_type, $filter) = @_;
 114
 115         my (@html, @keep);
 116         my $rejected = 0;
 117         my $ok = 1;
 118
 119         # scan through all parts once
 120         $mime->walk_parts(sub {
 121                 my ($part) = @_;
 122                 return if $part->subparts; # walk_parts already recurses
 123
 124                 # some extensions are just bad, reject them outright
 125                 my $fn = $part->filename;
 126                 if (defined($fn) && $fn =~ $BAD_EXT) {
 127                         $filter->reject("Bad file type: $1") if $filter;
 128                         $rejected++;
 129                         return;
 130                 }
 131
 132                 my $part_type = $part->content_type || '';
 133                 if ($part_type =~ m!\btext/plain\b!i) {
 134                         push @keep, $part;
 135                 } elsif ($part_type =~ $MIME_HTML) {
 136                         $filter->reject(NO_HTML) if $filter;
 137                         push @html, $part;
 138                 } elsif ($part_type =~ $MIME_TEXT_ANY) {
 139                         # Give other text attachments the benefit of the doubt,
 140                         # here?  Could be source code or script the user wants
 141                         # help with.
 142
 143                         push @keep, $part;
 144                 } elsif ($part_type eq '' ||
 145                          $part_type =~ m!\bapplication/octet-stream\b!i) {
 146                         # unfortunately, some mailers don't set correct types,
 147                         # let messages of unknown type through but do not
 148                         # change the sender-specified type
 149                         if (recheck_type_ok($part)) {
 150                                 push @keep, $part;
 151                         } elsif ($filter) {
 152                                 $filter->reject("Bad attachment: $part_type ".
 153                                                 TEXT_ONLY);
 154                         } else {
 155                                 $rejected++;
 156                         }
 157                 } elsif ($part_type =~ m!\bapplication/pgp-signature\b!i) {
 158                         # PGP signatures are not huge, we may keep them.
 159                         # They can only be valid if it's the last element,
 160                         # so we keep them iff the message is unmodified:
 161                         if ($rejected == 0 && !@html) {
 162                                 push @keep, $part;
 163                         }
 164                 } elsif ($filter) {
 165                         $filter->reject("unacceptable mime-type: $part_type ".
 166                                         TEXT_ONLY);
 167                 } else {
 168                         # reject everything else, including non-PGP signatures
 169                         $rejected++;
 170                 }
 171         });
 172
 173         if ($content_type =~ m!\bmultipart/alternative\b!i) {
 174                 if (scalar @keep == 1) {
 175                         return collapse($mime, $keep[0]);
 176                 }
 177         } else { # convert HTML parts to plain text
 178                 foreach my $part (@html) {
 179                         html_part_to_text($mime, $part);
 180                         push @keep, $part;
 181                 }
 182         }
 183
 184         if (@keep == 0) {
 185                 @keep = (Email::MIME->create(
 186                         attributes => {
 187                                 content_type => 'text/plain',
 188                                 charset => 'US-ASCII',
 189                                 encoding => '8bit',
 190                         },
 191                         body_str => 'all attachments scrubbed by '. __PACKAGE__
 192                 ));
 193                 $ok = 0;
 194         }
 195         if (scalar(@html) || $rejected) {
 196                 $mime->parts_set(\@keep);
 197                 $mime->body_set($mime->body_raw);
 198                 mark_changed($mime);
 199         } # else: no changes
 200
 201         return $ok;
 202 }
 203
 204 sub mark_changed {
 205         my ($mime) = @_;
 206         $mime->header_set('X-Content-Filtered-By', __PACKAGE__ ." $VERSION");
 207 }
 208
 209 sub collapse {
 210         my ($mime, $part) = @_;
 211         $mime->header_set('Content-Type', $part->content_type);
 212         $mime->body_set($part->body_raw);
 213         my $cte = $part->header('Content-Transfer-Encoding');
 214         if (defined($cte) && $cte ne '') {
 215                 $mime->header_set('Content-Transfer-Encoding', $cte);
 216         }
 217         mark_changed($mime);
 218         return 1;
 219 }
 220
 221 sub replace_body {
 222         my $mime = $_[0];
 223         $mime->body_set($_[1]);
 224         $mime->header_set('Content-Type', 'text/plain');
 225         if ($mime->header('Content-Transfer-Encoding')) {
 226                 $mime->header_set('Content-Transfer-Encoding', undef);
 227         }
 228         mark_changed($mime);
 229 }
 230
 231 # Check for display-able text, no messed up binaries
 232 # Note: we can not rewrite the message with the detected mime type
 233 sub recheck_type_ok {
 234         my ($part) = @_;
 235         my $s = $part->body;
 236         ((length($s) < 0x10000) && ($s =~ /\A([[:print:]\s]+)\z/s));
 237 }
 238
 239 1;