chiark / gitweb /
Merge remote branch 'origin/master'
[modbot-ulm.git] / stump / bin / submission.pl
1 #
2 # this script accepts submissions that come to the robomoderator by
3 # email. It make s a decision whether the submission deserves
4 # rejection, automatic approval, or is suspicious and should be
5 # forwarded to human moderators for review.
6 #
7 # A decision is essentially a choice of the program that will be
8 # fed with preprocessed article.
9 #
10 # Also note that this script fixes common problems and mistakes in
11 # newsreaders, newsservers, and users. Even though we have no
12 # obligation to fix these problems, people get really disappointed
13 # if we outright reject their bogus messages, because these
14 # people often have no control over how the posts get delivered to us.
15 #
16 # This script supports notion of blacklisting and list of
17 # preapproved persons. As the names imply, we reject all submissions
18 # from blacklisted posters and automatically approve all messages submitted
19 # by preapproved posters (provided that their posts meet other criteria
20 # imposed by the robomoderator.
21 #
22 # For an automatic rejection, it gives a main "reason" for rejection
23 #
24 #Currently supported list of reasons: 
25 #
26 #       - crosspost
27 #       - abuse
28 #       - harassing
29 #       - offtopic
30
31 # get the directory where robomod is residing
32 $MNG_ROOT = $ENV{'MNG_ROOT'} || die "Root dir for moderation not specified";
33
34 # common library
35 require "$MNG_ROOT/bin/robomod.pl";
36
37 # max allowed number of newsgroups in crossposts
38 # change it if you want, but 5 is really good.
39 $maxNewsgroups = $ENV{'MAX_CROSSPOSTS'} || 5; 
40
41 # should we ALWAYS require preapproved posters to sign their submissions
42 # with PGP? Turn it on in the `etc/modenv' if you suffer from numerous
43 # forgeries in the names of preapproved posters.
44 $PGPCheckPreapproved = $ENV{ "WHITELIST_MUST_SIGN" } eq "YES";
45
46 # So, what newsgroup I am moderating?
47 $Newsgroup = $ENV{'NEWSGROUP'};
48
49 # as the name implies. ATTENTION: $TMP must be mode 700!!!
50 $TmpFile = "$ENV{'TMP'}/submission.$$";
51
52 # how do we treat suspicious articles?
53 $Command_Suspicious = "formail -a \"Newsgroups: $Newsgroup\" " .
54                       "| stump.pl suspicious.pl";
55
56 # approved
57 $Command_Approve = "processApproved robomod";
58 # rejected
59 $Command_Reject  = "processRejected robomod";
60
61 # location of blacklist
62 $badGuys = "bad.guys.list";
63
64 # location of preapproved list
65 $goodGuys = "good.guys.list";
66
67 # words that trigger robomod to mark messages suspicious, even 
68 # when the message comes from a preapproved person.
69 $badWords = "bad.words.list";
70
71 # list of people who want all their submissions to be signed
72 $PGPMustList = "pgp.must.list";
73
74 # set PMUSER and ROBOMOD to Internal. Will be used by `suspicious' script.
75 $ENV{'PMUSER'} = $ENV{'PMUSER_INTERNAL'};
76 $ENV{'ROBOMOD'} = $ENV{'ROBOMOD_INTERNAL'};
77
78
79 ######################################################################
80 # Filter rules
81 # checks if all is OK with newsgroups.
82 # what's not OK: 
83 #   1. Megacrossposts
84 #   2. Crossposts to other moderated groups
85 #   3. Control messages (currently)
86 #
87 sub checkNewsgroups {
88
89   # We have not implemented Control: yet...
90   if( $Control ) {
91 print STDERR "CONTROL message - rejected\n";
92     return "$Command_Reject crosspost You posted a Control message which " .
93            "is not allowed.";
94   }
95
96   if( $#newsgroups >= $maxNewsgroups ) {
97 print STDERR "Too many newsgroups\n";
98     return "$Command_Reject crosspost Too many newsgroups, " .
99            "$maxNewsgroups is maximum.";
100   }
101
102   local( $good ) = 0;
103
104   for( $i = 0; $i <= $#newsgroups; $i++ ) {
105
106     if( $newsgroups[$i] eq $Newsgroup ) {
107       $good = 1;
108       next;
109     }
110
111     if( $NewsgroupsDB{$newsgroups[$i]} eq 'm' && 
112         $newsgroups[$i] ne $Newsgroup) {
113 print STDERR "posting to ANOTHER moderated newsgroups\n";
114       return "$Command_Reject crosspost You crossposted to another " .
115              "moderated newsgroup.";
116     }
117
118   }
119
120   if( !$good ) { # Some fool forgot to list the moderated newsgroup
121                  # in the Newsgroups
122     $Newsgroups .= ",$Newsgroup";
123     if( $#newsgroups + 1 >= $maxNewsgroups ) {
124 print STDERR "Too many newsgroups\n";
125       return "$Command_Reject crosspost Too many newsgroups, FIVE is maximum.";
126     }
127   }
128
129   return 0;
130 }
131
132 ###################################################################### checkAck
133 # checks if poster needs acknowledgment of receipt
134 #
135 sub checkAck {
136   #ULM mods want to disable this, so just return "no"
137   $needAck = "no";
138 }
139
140 ################################################################### checkPGP
141 # checks PGP sig IF REQUIRED
142 #
143 # we can reject a post if
144 #
145 #   1. A post must be signed accordinng to rules OR
146 #   2. A post is signed but verification fails.
147 #
148 # Note that we set From: to the user ID in the PGP signature
149 # if a signature is present. It allows for identification of trolls
150 # and for preventing subtle forgeries.
151 #
152 sub checkPGP {
153
154   local( $FromSig ) = `verifySignature < $TmpFile`; chop( $FromSig );
155   local( $good ) = $? == 0;
156
157 print STDERR "FromSig = $FromSig, good = $good\n" if $FromSig;
158
159   if( !$good ) {
160     return "$Command_Reject signature Your PGP signature does NOT match, or is not in our keyring";
161   }
162
163   if( &nameIsInListRegexp( $From, $PGPMustList ) ||
164       ($PGPCheckPreapproved && &nameIsInListExactly($From, $goodGuys) ) ) {
165     if( $FromSig eq "" ) {
166       return "$Command_Reject signature You are REQUIRED to sign your posts.";
167     } 
168   }
169
170   if( $FromSig ) {
171     $X_Origin = $From;
172     $From = "From: $FromSig";
173     $ReplyTo = $From;
174   }
175
176   # else nothing to do
177   return 0;
178 }
179
180 ################################################################ checkCharter
181 # checks charter calling conforms_charter
182 #
183 sub checkCharter {
184   open( VERIFY, "|conforms_charter" ) or die $!;
185   print VERIFY $Body or die $!;
186   close( VERIFY );
187
188   return $? == 0;
189 }
190
191 ################################################################### Filter
192 # contains all filtering rules. calls subroutines above.
193 sub Filter {
194
195
196   local( $response );
197
198   @newsgroups = split( /,/, $Newsgroups );
199
200   return "Command_Reject charter We do not allow any control and " .
201          "cancel messages. contact newsgroup administrator" 
202     if( $Control );
203
204   if( $response = &checkNewsgroups() ) {
205       return $response;
206   }
207
208   if( $paranoid_pgp ) {
209     if( $response = &checkPGP() ) {
210         return $response;
211     }
212   }
213
214   if( &nameIsInListRegexp( $From, $badGuys ) ) {
215     return "$Command_Reject blocklist";
216   }
217
218   # note that if even a preapproved person uses "BAD words" (that is
219   # words from a special list), his/her message will be marked
220   # "suspicious" and will be forwarded to a humen mod for review.
221   # As an example of a bad word may be "MAKE MONEY FAST - IT REALLY WORKS!!!"
222   #
223   if( $badWord = &nameIsInListRegexp( $Body, $badWords ) ) {
224 print STDERR "BAD WORD $badWord FOUND!!!\n";
225     return $Command_Suspicious; # messages from approved guys MAY be 
226                          # suspicious if they write about
227                          # homosexual forgers
228   }
229
230   # checking for charter-specific restrictions
231   if( !&checkCharter || ($Encoding =~ "base64") ) {
232     return "$Command_Reject charter you sent a " .
233            "binary encoded file which is not allowed.";
234   }
235
236   # Checking preapproved list
237   if( &nameIsInListExactly( $From, $goodGuys ) ) {
238   local( $from ) = $From; $from =~ s/^From: //i;
239 print STDERR "$from is a PREAPPROVED person\n";
240     return $Command_Approve;
241   }
242
243   # Here I may put some more rules...
244
245   return $Command_Suspicious;
246 }
247
248 ######################################################################
249 # set defaults
250 sub setDefaults {
251   if( !$Newsgroups ) {
252     $Newsgroups = $ENV{ "NEWSGROUP" } || die "No default newsgroup";
253   }
254 }
255
256 ################################################################# ignoreHeader
257 # some of the header fields present in emails must be ignored.
258 #
259 sub ignoreHeader {
260   local( $header ) = pop( @_ );
261
262 #  return 1 if( $header =~ /^Control:/i );
263   return 1 if( $header =~ /^Expires:/i );
264   return 1 if( $header =~ /^Supersedes:/i );
265   return 1 if( $header =~ /^Precedence:/i );
266   return 1 if( $header =~ /^Apparently-To:/i );
267   return 1 if( $header =~ /^Date:/i );
268   return 1 if( $header =~ /^Expires:/i );
269   return 1 if( $header =~ /^Distribution:/i );
270   return 1 if( $header =~ /^Path:/i );
271   return 1 if( $header =~ /^NNTP-Posting-Host:/i );
272   return 1 if( $header =~ /^Xref:/i );
273   return 1 if( $header =~ /^Status:/i );
274   return 1 if( $header =~ /^Lines:/i );
275   return 1 if( $header =~ /^Apparently-To:/i );
276   return 1 if( $header =~ /^Cc:/i );
277   return 1 if( $header =~ /^Sender:/i );
278   return 1 if( $header =~ /^In-Reply-To:/i );
279   return 1 if( $header =~ /^Originator:/i );
280
281   return 0;
282 }
283
284
285 ######################################################################
286 # Getting data
287
288 # reads message, sets variables describing header fields
289 #
290 # it also tries to "fix" the problem with old newsservers (B-News I think)
291 # when they try to "wrap" a submission in one more layer of meaningless
292 # headers. It is recognized by STUPID presense of TWO identical To: 
293 # fields.
294 #
295
296 sub readMessage {
297
298 #open IWJL, ">>/home/webstump/t.log";
299 #print IWJL "=========== SUBMISSION READMESSAGE\n";
300
301   open( TMPFILE, "> $TmpFile" ) or die $!;
302
303   $IsBody = 0;
304   
305   while( <> ) {
306 #print IWJL "SbRm $_\n";
307     $Body .= $_;
308
309     if( !$IsBody && &ignoreHeader( $_ ) ) {
310       next;
311     }
312
313     print TMPFILE or die $!;
314   
315     chop;
316   
317     if( /^$/ ) {
318       if( !$Subject && $From =~ /news\@/) {
319         $BadNewsserver = 1;
320       }
321
322       if( $BadNewsserver ) { # just ignore the outer layer of headers
323         $To = 0;
324       } else {
325         $IsBody = 1;
326       }
327     }
328   
329     if( !$IsBody ) {
330   
331       if( /^Newsgroups: / ) { # set Newsgroups, remove spaces
332         $Newsgroups = $_;
333         $Newsgroups =~ s/^Newsgroups: //i;
334         $Newsgroups =~ s/ //g; # some fools put spaces in list of newsgroups
335       } elsif( /^Subject: / ) {
336         $Subject = $_;
337       } elsif( /^From: / ) {
338         $From = $_;
339       } elsif( /^To: / ) {
340         if( $To && ($To eq $_)) { 
341           # Old & crappy news servers that wrap submissions with one more
342           # layer of headers. For them, I simply ignore the outer
343           # headers. These (at least I think) submissions may be
344           # recognized by TWO idiotic To: header fields.
345 print STDERR "BAD NEWSSERVER\n";
346           $BadNewsserver = 1;
347         }
348         $To = $_;
349       } elsif( /^Path: / ) {
350         $Path = $_;
351       } elsif( /^Keywords: / ) {
352         $Keywords = $_;
353       } elsif( /^Summary: / ) {
354         $Summary = $_;
355       } elsif( /^Control: / ) {
356         $Control = $_;
357       } elsif( /^Message-ID: / ) {
358         $Message_ID = $_;
359       } elsif ( /^Content-Transfer-Encoding: / ) {
360         $Encoding = $_;
361         $Encoding =~ s/^Content-Transfer-Encoding: //;
362       }
363   
364     }
365   }
366 use IO::Handle;
367 #  print IWJL "SbRmE $!\n";
368   die "read message $! !" if STDIN->error;
369
370   close( TMPFILE );
371 }
372
373 ###################################################################### work
374 # all main work is done here
375
376 ######################################################################
377 # read the thing
378 &readMessage();
379
380 if( !$Newsgroups ) {
381   $Newsgroups = $Newsgroup;
382 }
383
384 ######################################################################
385 # process acks
386 &checkAck;
387 $Command_Suspicious .= " $needAck";
388
389 ######################################################################
390 # set defaults
391 &setDefaults();
392
393 ######################################################################
394 # Check
395
396 $command = &Filter;
397
398 ######################################################################
399 # process
400 print STDERR "command = $command\n";
401
402 #open IWJL, ">>/home/webstump/t.log";
403 #print IWJL "=========== SUBMISSION MAIN\n";
404
405 open( COMMAND, "| $command" ) or die $!;
406 open( TMPFILE, "$TmpFile" ) || die "cant open tmpfile";
407
408   $IsBody = 0;
409
410   while( <TMPFILE> ) {
411
412     if( $BadNewsserver && !(/^$/) ) {
413       next;
414     }
415
416     if( $BadNewsserver && /^$/ ) {
417       $BadNewsserver = 0;
418       next;
419     }
420
421     if( /^$/ ) {
422       $IsBody = 1;
423     }
424
425     if( /^From / ) {
426       print COMMAND or die $!;
427       print COMMAND "X-Origin: $X_Origin, $_" or die $! if $X_Origin;
428       print STDERR "Subject =`$Subject'\n";
429       print COMMAND "Subject: No subject given\n" or die $! if !$Subject;
430       # nothing
431     } elsif( /^From: / && !$IsBody) {
432       next if $FromWasUsed;
433
434       $FromWasUsed = 1; # note that some crappy remailers have several
435                         # "From: " fields. We really do NOT want two
436                         # "From: " to go to headers!
437
438       if( $From ) {
439         print COMMAND "$From\n" or die $!;
440         $From = "";
441       } else {
442         print COMMAND or die $!;
443       }
444     } elsif( /^Newsgroups: / && !$IsBody ) {
445       print COMMAND "Newsgroups: $Newsgroups\n" or die $!;
446     } else {
447       print COMMAND or die $!;
448     }
449   }
450
451 close( TMPFILE ) or die $!;
452 close( COMMAND ) or die "$? $!";
453
454 ################################################################## Archiving
455 # archive
456
457 #open( COMMAND, "| procmail -f- $MNG_ROOT/etc/procmail/save-incoming" );
458 #print COMMAND $Body;
459 #close( COMMAND );
460
461 unlink( $TmpFile );