bd34dba8298be28a88f9501273fa9a9cfec86665
[exim.git] / src / src / spam.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003 - 2015
6  * License: GPL
7  * Copyright (c) The Exim Maintainers 2016 - 2020
8  */
9
10 /* Code for calling spamassassin's spamd. Called from acl.c. */
11
12 #include "exim.h"
13 #ifdef WITH_CONTENT_SCAN
14 #include "spam.h"
15
16 uschar spam_score_buffer[16];
17 uschar spam_score_int_buffer[16];
18 uschar spam_bar_buffer[128];
19 uschar spam_action_buffer[32];
20 uschar spam_report_buffer[32600];
21 uschar prev_user_name[128] = "";
22 int spam_ok = 0;
23 int spam_rc = 0;
24 uschar *prev_spamd_address_work = NULL;
25
26 static const uschar * loglabel = US"spam acl condition:";
27
28
29 static int
30 spamd_param_init(spamd_address_container *spamd)
31 {
32 /* default spamd server weight, time and priority value */
33 spamd->is_rspamd = FALSE;
34 spamd->is_failed = FALSE;
35 spamd->weight = SPAMD_WEIGHT;
36 spamd->timeout = SPAMD_TIMEOUT;
37 spamd->retry = 0;
38 spamd->priority = 1;
39 return 0;
40 }
41
42
43 static int
44 spamd_param(const uschar * param, spamd_address_container * spamd)
45 {
46 static int timesinceday = -1;
47 const uschar * s;
48 const uschar * name;
49
50 /*XXX more clever parsing could discard embedded spaces? */
51
52 if (sscanf(CCS param, "pri=%u", &spamd->priority))
53   return 0; /* OK */
54
55 if (sscanf(CCS param, "weight=%u", &spamd->weight))
56   {
57   if (spamd->weight == 0) /* this server disabled: skip it */
58     return 1;
59   return 0; /* OK */
60   }
61
62 if (Ustrncmp(param, "time=", 5) == 0)
63   {
64   unsigned int start_h = 0, start_m = 0, start_s = 0;
65   unsigned int end_h = 24, end_m = 0, end_s = 0;
66   unsigned int time_start, time_end;
67   const uschar * end_string;
68
69   name = US"time";
70   s = param+5;
71   if ((end_string = Ustrchr(s, '-')))
72     {
73     end_string++;
74     if (  sscanf(CS end_string, "%u.%u.%u", &end_h,   &end_m,   &end_s)   == 0
75        || sscanf(CS s,          "%u.%u.%u", &start_h, &start_m, &start_s) == 0
76        )
77       goto badval;
78     }
79   else
80     goto badval;
81
82   if (timesinceday < 0)
83     {
84     time_t now = time(NULL);
85     struct tm *tmp = localtime(&now);
86     timesinceday = tmp->tm_hour*3600 + tmp->tm_min*60 + tmp->tm_sec;
87     }
88
89   time_start = start_h*3600 + start_m*60 + start_s;
90   time_end = end_h*3600 + end_m*60 + end_s;
91
92   if (timesinceday < time_start || timesinceday >= time_end)
93     return 1; /* skip spamd server */
94
95   return 0; /* OK */
96   }
97
98 if (Ustrcmp(param, "variant=rspamd") == 0)
99   {
100   spamd->is_rspamd = TRUE;
101   return 0;
102   }
103
104 if (Ustrncmp(param, "tmo=", 4) == 0)
105   {
106   int sec = readconf_readtime((s = param+4), '\0', FALSE);
107   name = US"timeout";
108   if (sec < 0)
109     goto badval;
110   spamd->timeout = sec;
111   return 0;
112   }
113
114 if (Ustrncmp(param, "retry=", 6) == 0)
115   {
116   int sec = readconf_readtime((s = param+6), '\0', FALSE);
117   name = US"retry";
118   if (sec < 0)
119     goto badval;
120   spamd->retry = sec;
121   return 0;
122   }
123
124 log_write(0, LOG_MAIN, "%s warning - invalid spamd parameter: '%s'",
125   loglabel, param);
126 return -1; /* syntax error */
127
128 badval:
129   log_write(0, LOG_MAIN,
130     "%s warning - invalid spamd %s value: '%s'", loglabel, name, s);
131   return -1; /* syntax error */
132 }
133
134
135 static int
136 spamd_get_server(spamd_address_container ** spamds, int num_servers)
137 {
138 unsigned int i;
139 spamd_address_container * sd;
140 long weights;
141 unsigned pri;
142 static BOOL srandomed = FALSE;
143
144 /* speedup, if we have only 1 server */
145 if (num_servers == 1)
146   return (spamds[0]->is_failed ? -1 : 0);
147
148 /* init ranmod */
149 if (!srandomed)
150   {
151   struct timeval tv;
152   gettimeofday(&tv, NULL);
153   srandom((unsigned int)(tv.tv_usec/1000));
154   srandomed = TRUE;
155   }
156
157 /* scan for highest pri */
158 for (pri = 0, i = 0; i < num_servers; i++)
159   {
160   sd = spamds[i];
161   if (!sd->is_failed && sd->priority > pri) pri = sd->priority;
162   }
163
164 /* get sum of weights */
165 for (weights = 0, i = 0; i < num_servers; i++)
166   {
167   sd = spamds[i];
168   if (!sd->is_failed && sd->priority == pri) weights += sd->weight;
169   }
170 if (weights == 0)       /* all servers failed */
171   return -1;
172
173 for (long rnd = random() % weights, i = 0; i < num_servers; i++)
174   {
175   sd = spamds[i];
176   if (!sd->is_failed && sd->priority == pri)
177     if ((rnd -= sd->weight) <= 0)
178       return i;
179   }
180
181 log_write(0, LOG_MAIN|LOG_PANIC,
182   "%s unknown error (memory/cpu corruption?)", loglabel);
183 return -1;
184 }
185
186
187 int
188 spam(const uschar **listptr)
189 {
190 int sep = 0;
191 const uschar *list = *listptr;
192 uschar *user_name;
193 unsigned long mbox_size;
194 FILE *mbox_file;
195 client_conn_ctx spamd_cctx = {.sock = -1};
196 uschar spamd_buffer[32600];
197 int i, j, offset, result;
198 uschar spamd_version[8];
199 uschar spamd_short_result[8];
200 uschar spamd_score_char;
201 double spamd_threshold, spamd_score, spamd_reject_score;
202 int spamd_report_offset;
203 uschar *p,*q;
204 int override = 0;
205 time_t start;
206 size_t read, wrote;
207 #ifndef NO_POLL_H
208 struct pollfd pollfd;
209 #else                               /* Patch posted by Erik ? for OS X */
210 struct timeval select_tv;         /* and applied by PH */
211 fd_set select_fd;
212 #endif
213 uschar *spamd_address_work;
214 spamd_address_container * sd;
215
216 /* stop compiler warning */
217 result = 0;
218
219 /* find the username from the option list */
220 if (!(user_name = string_nextinlist(&list, &sep, NULL, 0)))
221   {
222   /* no username given, this means no scanning should be done */
223   return FAIL;
224   }
225
226 /* if username is "0" or "false", do not scan */
227 if (Ustrcmp(user_name, "0") == 0 || strcmpic(user_name, US"false") == 0)
228   return FAIL;
229
230 /* if there is an additional option, check if it is "true" */
231 if (strcmpic(list,US"true") == 0)
232   /* in that case, always return true later */
233   override = 1;
234
235 /* expand spamd_address if needed */
236 if (*spamd_address != '$')
237   spamd_address_work = spamd_address;
238 else if (!(spamd_address_work = expand_string(spamd_address)))
239   {
240   log_write(0, LOG_MAIN|LOG_PANIC,
241     "%s spamd_address starts with $, but expansion failed: %s",
242     loglabel, expand_string_message);
243   return DEFER;
244   }
245
246 DEBUG(D_acl) debug_printf_indent("spamd: addrlist '%s'\n", spamd_address_work);
247
248 /* check if previous spamd_address was expanded and has changed. dump cached results if so */
249 if (  spam_ok
250    && prev_spamd_address_work != NULL
251    && Ustrcmp(prev_spamd_address_work, spamd_address_work) != 0
252    )
253   spam_ok = 0;
254
255 /* if we scanned for this username last time, just return */
256 if (spam_ok && Ustrcmp(prev_user_name, user_name) == 0)
257   return override ? OK : spam_rc;
258
259 /* make sure the eml mbox file is spooled up */
260
261 if (!(mbox_file = spool_mbox(&mbox_size, NULL, NULL)))
262   {                                                             /* error while spooling */
263   log_write(0, LOG_MAIN|LOG_PANIC,
264          "%s error while creating mbox spool file", loglabel);
265   return DEFER;
266   }
267
268 start = time(NULL);
269
270   {
271   int num_servers = 0;
272   int current_server;
273   uschar * address;
274   const uschar * spamd_address_list_ptr = spamd_address_work;
275   spamd_address_container * spamd_address_vector[32];
276
277   /* Check how many spamd servers we have
278      and register their addresses */
279   sep = 0;                              /* default colon-sep */
280   while ((address = string_nextinlist(&spamd_address_list_ptr, &sep, NULL, 0)))
281     {
282     const uschar * sublist;
283     int sublist_sep = -(int)' ';        /* default space-sep */
284     unsigned args;
285     uschar * s;
286
287     DEBUG(D_acl) debug_printf_indent("spamd: addr entry '%s'\n", address);
288     sd = store_get(sizeof(spamd_address_container), FALSE);
289
290     for (sublist = address, args = 0, spamd_param_init(sd);
291          (s = string_nextinlist(&sublist, &sublist_sep, NULL, 0));
292          args++
293          )
294       {
295         DEBUG(D_acl) debug_printf_indent("spamd:  addr parm '%s'\n", s);
296         switch (args)
297         {
298         case 0:   sd->hostspec = s;
299                   if (*s == '/') args++;        /* local; no port */
300                   break;
301         case 1:   sd->hostspec = string_sprintf("%s %s", sd->hostspec, s);
302                   break;
303         default:  spamd_param(s, sd);
304                   break;
305         }
306       }
307     if (args < 2)
308       {
309       log_write(0, LOG_MAIN,
310         "%s warning - invalid spamd address: '%s'", loglabel, address);
311       continue;
312       }
313
314     spamd_address_vector[num_servers] = sd;
315     if (++num_servers > 31)
316       break;
317     }
318
319   /* check if we have at least one server */
320   if (!num_servers)
321     {
322     log_write(0, LOG_MAIN|LOG_PANIC,
323        "%s no useable spamd server addresses in spamd_address configuration option.",
324        loglabel);
325     goto defer;
326     }
327
328   current_server = spamd_get_server(spamd_address_vector, num_servers);
329   sd = spamd_address_vector[current_server];
330   for(;;)
331     {
332     uschar * errstr;
333
334     DEBUG(D_acl) debug_printf_indent("spamd: trying server %s\n", sd->hostspec);
335
336     for (;;)
337       {
338       /*XXX could potentially use TFO early-data here */
339       if (  (spamd_cctx.sock = ip_streamsocket(sd->hostspec, &errstr, 5, NULL)) >= 0
340          || sd->retry <= 0
341          )
342         break;
343       DEBUG(D_acl) debug_printf_indent("spamd: server %s: retry conn\n", sd->hostspec);
344       while (sd->retry > 0) sd->retry = sleep(sd->retry);
345       }
346     if (spamd_cctx.sock >= 0)
347       break;
348
349     log_write(0, LOG_MAIN, "%s spamd: %s", loglabel, errstr);
350     sd->is_failed = TRUE;
351
352     current_server = spamd_get_server(spamd_address_vector, num_servers);
353     if (current_server < 0)
354       {
355       log_write(0, LOG_MAIN|LOG_PANIC, "%s all spamd servers failed", loglabel);
356       goto defer;
357       }
358     sd = spamd_address_vector[current_server];
359     }
360   }
361
362 (void)fcntl(spamd_cctx.sock, F_SETFL, O_NONBLOCK);
363 /* now we are connected to spamd on spamd_cctx.sock */
364 if (sd->is_rspamd)
365   {
366   gstring * req_str;
367   const uschar * s;
368
369   req_str = string_append(NULL, 8,
370     "CHECK RSPAMC/1.3\r\nContent-length: ", string_sprintf("%lu\r\n", mbox_size),
371     "Queue-Id: ", message_id,
372     "\r\nFrom: <", sender_address,
373     ">\r\nRecipient-Number: ", string_sprintf("%d\r\n", recipients_count));
374
375   for (int i = 0; i < recipients_count; i++)
376     req_str = string_append(req_str, 3,
377       "Rcpt: <", recipients_list[i].address, ">\r\n");
378   if ((s = expand_string(US"$sender_helo_name")) && *s)
379     req_str = string_append(req_str, 3, "Helo: ", s, "\r\n");
380   if ((s = expand_string(US"$sender_host_name")) && *s)
381     req_str = string_append(req_str, 3, "Hostname: ", s, "\r\n");
382   if (sender_host_address)
383     req_str = string_append(req_str, 3, "IP: ", sender_host_address, "\r\n");
384   if ((s = expand_string(US"$authenticated_id")) && *s)
385     req_str = string_append(req_str, 3, "User: ", s, "\r\n");
386   req_str = string_catn(req_str, US"\r\n", 2);
387   wrote = send(spamd_cctx.sock, req_str->s, req_str->ptr, 0);
388   }
389 else
390   {                             /* spamassassin variant */
391   (void)string_format(spamd_buffer,
392           sizeof(spamd_buffer),
393           "REPORT SPAMC/1.2\r\nUser: %s\r\nContent-length: %ld\r\n\r\n",
394           user_name,
395           mbox_size);
396   /* send our request */
397   wrote = send(spamd_cctx.sock, spamd_buffer, Ustrlen(spamd_buffer), 0);
398   }
399
400 if (wrote == -1)
401   {
402   (void)close(spamd_cctx.sock);
403   log_write(0, LOG_MAIN|LOG_PANIC,
404        "%s spamd %s send failed: %s", loglabel, callout_address, strerror(errno));
405   goto defer;
406   }
407
408 /* now send the file */
409 /* spamd sometimes accepts connections but doesn't read data off
410  * the connection.  We make the file descriptor non-blocking so
411  * that the write will only write sufficient data without blocking
412  * and we poll the descriptor to make sure that we can write without
413  * blocking.  Short writes are gracefully handled and if the whole
414  * transaction takes too long it is aborted.
415  * Note: poll() is not supported in OSX 10.2 and is reported to be
416  *       broken in more recent versions (up to 10.4).
417  */
418 #ifndef NO_POLL_H
419 pollfd.fd = spamd_cctx.sock;
420 pollfd.events = POLLOUT;
421 #endif
422 (void)fcntl(spamd_cctx.sock, F_SETFL, O_NONBLOCK);
423 do
424   {
425   read = fread(spamd_buffer,1,sizeof(spamd_buffer),mbox_file);
426   if (read > 0)
427     {
428     offset = 0;
429 again:
430 #ifndef NO_POLL_H
431     result = poll(&pollfd, 1, 1000);
432
433 /* Patch posted by Erik ? for OS X and applied by PH */
434 #else
435     select_tv.tv_sec = 1;
436     select_tv.tv_usec = 0;
437     FD_ZERO(&select_fd);
438     FD_SET(spamd_cctx.sock, &select_fd);
439     result = select(spamd_cctx.sock+1, NULL, &select_fd, NULL, &select_tv);
440 #endif
441 /* End Erik's patch */
442
443     if (result == -1 && errno == EINTR)
444       goto again;
445     else if (result < 1)
446       {
447       if (result == -1)
448         log_write(0, LOG_MAIN|LOG_PANIC,
449           "%s %s on spamd %s socket", loglabel, callout_address, strerror(errno));
450       else
451         {
452         if (time(NULL) - start < sd->timeout)
453           goto again;
454         log_write(0, LOG_MAIN|LOG_PANIC,
455           "%s timed out writing spamd %s, socket", loglabel, callout_address);
456         }
457       (void)close(spamd_cctx.sock);
458       goto defer;
459       }
460
461     wrote = send(spamd_cctx.sock,spamd_buffer + offset,read - offset,0);
462     if (wrote == -1)
463       {
464       log_write(0, LOG_MAIN|LOG_PANIC,
465           "%s %s on spamd %s socket", loglabel, callout_address, strerror(errno));
466       (void)close(spamd_cctx.sock);
467       goto defer;
468       }
469     if (offset + wrote != read)
470       {
471       offset += wrote;
472       goto again;
473       }
474     }
475   }
476 while (!feof(mbox_file) && !ferror(mbox_file));
477
478 if (ferror(mbox_file))
479   {
480   log_write(0, LOG_MAIN|LOG_PANIC,
481     "%s error reading spool file: %s", loglabel, strerror(errno));
482   (void)close(spamd_cctx.sock);
483   goto defer;
484   }
485
486 (void)fclose(mbox_file);
487
488 /* we're done sending, close socket for writing */
489 if (!sd->is_rspamd)
490   shutdown(spamd_cctx.sock,SHUT_WR);
491
492 /* read spamd response using what's left of the timeout.  */
493 memset(spamd_buffer, 0, sizeof(spamd_buffer));
494 offset = 0;
495 while ((i = ip_recv(&spamd_cctx,
496                    spamd_buffer + offset,
497                    sizeof(spamd_buffer) - offset - 1,
498                    sd->timeout + start)) > 0)
499   offset += i;
500 spamd_buffer[offset] = '\0';    /* guard byte */
501
502 /* error handling */
503 if (i <= 0 && errno != 0)
504   {
505   log_write(0, LOG_MAIN|LOG_PANIC,
506        "%s error reading from spamd %s, socket: %s", loglabel, callout_address, strerror(errno));
507   (void)close(spamd_cctx.sock);
508   return DEFER;
509   }
510
511 /* reading done */
512 (void)close(spamd_cctx.sock);
513
514 if (sd->is_rspamd)
515   {                             /* rspamd variant of reply */
516   int r;
517   if (  (r = sscanf(CS spamd_buffer,
518           "RSPAMD/%7s 0 EX_OK\r\nMetric: default; %7s %lf / %lf / %lf\r\n%n",
519           spamd_version, spamd_short_result, &spamd_score, &spamd_threshold,
520           &spamd_reject_score, &spamd_report_offset)) != 5
521      || spamd_report_offset >= offset           /* verify within buffer */
522      )
523     {
524     log_write(0, LOG_MAIN|LOG_PANIC,
525               "%s cannot parse spamd %s, output: %d", loglabel, callout_address, r);
526     return DEFER;
527     }
528   /* now parse action */
529   p = &spamd_buffer[spamd_report_offset];
530
531   if (Ustrncmp(p, "Action: ", sizeof("Action: ") - 1) == 0)
532     {
533     p += sizeof("Action: ") - 1;
534     q = &spam_action_buffer[0];
535     while (*p && *p != '\r' && (q - spam_action_buffer) < sizeof(spam_action_buffer) - 1)
536       *q++ = *p++;
537     *q = '\0';
538     }
539   }
540 else
541   {                             /* spamassassin */
542   /* dig in the spamd output and put the report in a multiline header,
543   if requested */
544   if (sscanf(CS spamd_buffer,
545        "SPAMD/%7s 0 EX_OK\r\nContent-length: %*u\r\n\r\n%lf/%lf\r\n%n",
546        spamd_version,&spamd_score,&spamd_threshold,&spamd_report_offset) != 3)
547     {
548       /* try to fall back to pre-2.50 spamd output */
549       if (sscanf(CS spamd_buffer,
550            "SPAMD/%7s 0 EX_OK\r\nSpam: %*s ; %lf / %lf\r\n\r\n%n",
551            spamd_version,&spamd_score,&spamd_threshold,&spamd_report_offset) != 3)
552         {
553         log_write(0, LOG_MAIN|LOG_PANIC,
554                   "%s cannot parse spamd %s output", loglabel, callout_address);
555         return DEFER;
556         }
557     }
558
559   Ustrcpy(spam_action_buffer,
560     spamd_score >= spamd_threshold ? US"reject" : US"no action");
561   }
562
563 /* Create report. Since this is a multiline string,
564 we must hack it into shape first */
565 p = &spamd_buffer[spamd_report_offset];
566 q = spam_report_buffer;
567 while (*p != '\0')
568   {
569   /* skip \r */
570   if (*p == '\r')
571     {
572     p++;
573     continue;
574     }
575   *q++ = *p;
576   if (*p++ == '\n')
577     {
578     /* add an extra space after the newline to ensure
579     that it is treated as a header continuation line */
580     *q++ = ' ';
581     }
582   }
583 /* NULL-terminate */
584 *q-- = '\0';
585 /* cut off trailing leftovers */
586 while (*q <= ' ')
587   *q-- = '\0';
588
589 spam_report = spam_report_buffer;
590 spam_action = spam_action_buffer;
591
592 /* create spam bar */
593 spamd_score_char = spamd_score > 0 ? '+' : '-';
594 j = abs((int)(spamd_score));
595 i = 0;
596 if (j != 0)
597   while ((i < j) && (i <= MAX_SPAM_BAR_CHARS))
598      spam_bar_buffer[i++] = spamd_score_char;
599 else
600   {
601   spam_bar_buffer[0] = '/';
602   i = 1;
603   }
604 spam_bar_buffer[i] = '\0';
605 spam_bar = spam_bar_buffer;
606
607 /* create "float" spam score */
608 (void)string_format(spam_score_buffer, sizeof(spam_score_buffer),
609         "%.1f", spamd_score);
610 spam_score = spam_score_buffer;
611
612 /* create "int" spam score */
613 j = (int)((spamd_score + 0.001)*10);
614 (void)string_format(spam_score_int_buffer, sizeof(spam_score_int_buffer),
615         "%d", j);
616 spam_score_int = spam_score_int_buffer;
617
618 /* compare threshold against score */
619 spam_rc = spamd_score >= spamd_threshold
620   ? OK  /* spam as determined by user's threshold */
621   : FAIL;       /* not spam */
622
623 /* remember expanded spamd_address if needed */
624 if (spamd_address_work != spamd_address)
625   prev_spamd_address_work = string_copy(spamd_address_work);
626
627 /* remember user name and "been here" for it */
628 Ustrcpy(prev_user_name, user_name);
629 spam_ok = 1;
630
631 return override
632   ? OK          /* always return OK, no matter what the score */
633   : spam_rc;
634
635 defer:
636   (void)fclose(mbox_file);
637   return DEFER;
638 }
639
640 #endif
641 /* vi: aw ai sw=2
642 */