tidying
[exim.git] / src / src / spam.c
index 76db2b667f052a631bdf5887807b66ba832e30ee..b05f2d7089d3a0a2df4158ef3f2133cb7b39bc6e 100644 (file)
@@ -2,8 +2,10 @@
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 
-/* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003-???? */
-/* License: GPL */
+/* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003 - 2015
+ * License: GPL
+ * Copyright (c) The Exim Maintainers 2017
+ */
 
 /* Code for calling spamassassin's spamd. Called from acl.c. */
 
@@ -23,69 +25,59 @@ uschar *prev_spamd_address_work = NULL;
 
 static const uschar * loglabel = US"spam acl condition:";
 
+
 static int
 spamd_param_init(spamd_address_container *spamd)
 {
-/* default spamd server weight, time and backup value */
-spamd->weight = SPAMD_WEIGHT;
+/* default spamd server weight, time and priority value */
+spamd->is_rspamd = FALSE;
 spamd->is_failed = FALSE;
-spamd->is_backup = FALSE;
+spamd->weight = SPAMD_WEIGHT;
+spamd->timeout = SPAMD_TIMEOUT;
+spamd->retry = 0;
+spamd->priority = 1;
 return 0;
 }
 
 
 static int
-spamd_param(const uschar *param, spamd_address_container *spamd)
+spamd_param(const uschar * param, spamd_address_container * spamd)
 {
 static int timesinceday = -1;
-uschar buffer[256];
-
-/* check backup parameter */
-if (Ustrcmp(param, "backup") == 0)
-  {
-  spamd->is_backup = TRUE;
-  return 0; /* OK */
-  }
+const uschar * s;
+const uschar * name;
 
 /*XXX more clever parsing could discard embedded spaces? */
 
-/* check weight parameter */
-if (sscanf(param, "weight=%u", &spamd->weight))
+if (sscanf(CCS param, "pri=%u", &spamd->priority))
+  return 0; /* OK */
+
+if (sscanf(CCS param, "weight=%u", &spamd->weight))
   {
   if (spamd->weight == 0) /* this server disabled: skip it */
     return 1;
   return 0; /* OK */
   }
 
-/* check time parameter */
-if (sscanf(param, "time=%s", buffer))
+if (Ustrncmp(param, "time=", 5) == 0)
   {
   unsigned int start_h = 0, start_m = 0, start_s = 0;
   unsigned int end_h = 24, end_m = 0, end_s = 0;
   unsigned int time_start, time_end;
-  uschar *start_string;
-  uschar *end_string;
-  uschar *delimiter;
+  const uschar * end_string;
 
-  if ((delimiter = US strchr(CS buffer, '-')))
+  name = US"time";
+  s = param+5;
+  if ((end_string = Ustrchr(s, '-')))
     {
-    *delimiter   = '\0';
-    start_string = buffer;
-    end_string   = delimiter + 1;
-    if (sscanf(CS end_string, "%u.%u.%u", &end_h, &end_m, &end_s) == 0 ||
-      sscanf(CS start_string, "%u.%u.%u", &start_h, &start_m, &start_s) == 0)
-      {
-      log_write(0, LOG_MAIN,
-       "%s warning - invalid spamd time value: '%s'", loglabel, buffer);
-      return -1; /* syntax error */
-      }
+    end_string++;
+    if (  sscanf(CS end_string, "%u.%u.%u", &end_h,   &end_m,   &end_s)   == 0
+       || sscanf(CS s,          "%u.%u.%u", &start_h, &start_m, &start_s) == 0
+       )
+      goto badval;
     }
   else
-    {
-    log_write(0, LOG_MAIN,
-    "%s warning - invalid spamd time value: '%s'", loglabel, buffer);
-    return -1; /* syntax error */
-    }
+    goto badval;
 
   if (timesinceday < 0)
     {
@@ -109,53 +101,82 @@ if (Ustrcmp(param, "variant=rspamd") == 0)
   return 0;
   }
 
+if (Ustrncmp(param, "tmo=", 4) == 0)
+  {
+  int sec = readconf_readtime((s = param+4), '\0', FALSE);
+  name = US"timeout";
+  if (sec < 0)
+    goto badval;
+  spamd->timeout = sec;
+  return 0;
+  }
+
+if (Ustrncmp(param, "retry=", 6) == 0)
+  {
+  int sec = readconf_readtime((s = param+6), '\0', FALSE);
+  name = US"retry";
+  if (sec < 0)
+    goto badval;
+  spamd->retry = sec;
+  return 0;
+  }
+
 log_write(0, LOG_MAIN, "%s warning - invalid spamd parameter: '%s'",
   loglabel, param);
 return -1; /* syntax error */
+
+badval:
+  log_write(0, LOG_MAIN,
+    "%s warning - invalid spamd %s value: '%s'", loglabel, name, s);
+  return -1; /* syntax error */
 }
 
 
 static int
-spamd_get_server(spamd_address_container **spamds, int num_servers)
+spamd_get_server(spamd_address_container ** spamds, int num_servers)
 {
 unsigned int i;
-long rnd, weights = 0;
-static BOOL srandomed = 0;
-BOOL usebackup = FALSE;
+spamd_address_container * sd;
+long rnd, weights;
+unsigned pri;
+static BOOL srandomed = FALSE;
 
-for (;;)
-  {
-  /* seedup, if we have only 1 server */
-  if (num_servers == 1)
-    return (spamds[0]->is_failed ? -1 : 0);
+/* speedup, if we have only 1 server */
+if (num_servers == 1)
+  return (spamds[0]->is_failed ? -1 : 0);
 
-  /* init ranmod */
-  if (!srandomed)
-    {
-    struct timeval tv;
-    gettimeofday(&tv, NULL);
-    srandom((unsigned int)(tv.tv_usec/1000));
-    srandomed = TRUE;
-    }
-
-  /* get sum of all weights */
-  for (i = 0; i < num_servers; i++)
-    if (!spamds[i]->is_failed && spamds[i]->is_backup == usebackup)
-      weights += spamds[i]->weight;
+/* init ranmod */
+if (!srandomed)
+  {
+  struct timeval tv;
+  gettimeofday(&tv, NULL);
+  srandom((unsigned int)(tv.tv_usec/1000));
+  srandomed = TRUE;
+  }
 
-  if (weights != 0)
-    break;
-  if (usebackup)       /* all servers failed (backups too) */
-    return -1;
-  usebackup = TRUE;
+/* scan for highest pri */
+for (pri = 0, i = 0; i < num_servers; i++)
+  {
+  sd = spamds[i];
+  if (!sd->is_failed && sd->priority > pri) pri = sd->priority;
   }
 
-rnd = random() % weights;
+/* get sum of weights */
+for (weights = 0, i = 0; i < num_servers; i++)
+  {
+  sd = spamds[i];
+  if (!sd->is_failed && sd->priority == pri) weights += sd->weight;
+  }
+if (weights == 0)      /* all servers failed */
+  return -1;
 
-for (i = 0; i < num_servers; i++)
-  if (!spamds[i]->is_failed && spamds[i]->is_backup == usebackup)
-    if ((rnd -= spamds[i]->weight) < 0)
+for (rnd = random() % weights, i = 0; i < num_servers; i++)
+  {
+  sd = spamds[i];
+  if (!sd->is_failed && sd->priority == pri)
+    if ((rnd -= sd->weight) <= 0)
       return i;
+  }
 
 log_write(0, LOG_MAIN|LOG_PANIC,
   "%s unknown error (memory/cpu corruption?)", loglabel);
@@ -164,10 +185,10 @@ return -1;
 
 
 int
-spam(uschar **listptr)
+spam(const uschar **listptr)
 {
 int sep = 0;
-uschar *list = *listptr;
+const uschar *list = *listptr;
 uschar *user_name;
 uschar user_name_buffer[128];
 unsigned long mbox_size;
@@ -175,7 +196,6 @@ FILE *mbox_file;
 int spamd_sock = -1;
 uschar spamd_buffer[32600];
 int i, j, offset, result;
-BOOL is_rspamd;
 uschar spamd_version[8];
 uschar spamd_short_result[8];
 uschar spamd_score_char;
@@ -185,7 +205,6 @@ uschar *p,*q;
 int override = 0;
 time_t start;
 size_t read, wrote;
-struct sockaddr_un server;
 #ifndef NO_POLL_H
 struct pollfd pollfd;
 #else                               /* Patch posted by Erik ? for OS X */
@@ -193,6 +212,7 @@ struct timeval select_tv;         /* and applied by PH */
 fd_set select_fd;
 #endif
 uschar *spamd_address_work;
+spamd_address_container * sd;
 
 /* stop compiler warning */
 result = 0;
@@ -231,7 +251,7 @@ if (*spamd_address == '$')
 else
   spamd_address_work = spamd_address;
 
-HDEBUG(D_acl) debug_printf("spamd: addrlist '%s'\n", spamd_address_work);
+DEBUG(D_acl) debug_printf_indent("spamd: addrlist '%s'\n", spamd_address_work);
 
 /* check if previous spamd_address was expanded and has changed. dump cached results if so */
 if (  spam_ok
@@ -245,11 +265,9 @@ if (spam_ok && Ustrcmp(prev_user_name, user_name) == 0)
   return override ? OK : spam_rc;
 
 /* make sure the eml mbox file is spooled up */
-mbox_file = spool_mbox(&mbox_size, NULL);
 
-if (mbox_file == NULL)
-  {
-  /* error while spooling */
+if (!(mbox_file = spool_mbox(&mbox_size, NULL, NULL)))
+  {                                                            /* error while spooling */
   log_write(0, LOG_MAIN|LOG_PANIC,
         "%s error while creating mbox spool file", loglabel);
   return DEFER;
@@ -260,30 +278,29 @@ start = time(NULL);
   {
   int num_servers = 0;
   int current_server;
-  uschar *address;
-  uschar *spamd_address_list_ptr = spamd_address_work;
+  uschar * address;
+  const uschar * spamd_address_list_ptr = spamd_address_work;
   spamd_address_container * spamd_address_vector[32];
-  spamd_address_container * sd;
 
   /* Check how many spamd servers we have
      and register their addresses */
-  while ((address = string_nextinlist(&spamd_address_list_ptr, &sep,
-                                     NULL, 0)) != NULL)
+  sep = 0;                             /* default colon-sep */
+  while ((address = string_nextinlist(&spamd_address_list_ptr, &sep, NULL, 0)))
     {
-    uschar * sublist;
+    const uschar * sublist;
     int sublist_sep = -(int)' ';       /* default space-sep */
     unsigned args;
     uschar * s;
 
-    HDEBUG(D_acl) debug_printf("spamd: addr entry '%s'\n", address);
+    DEBUG(D_acl) debug_printf_indent("spamd: addr entry '%s'\n", address);
     sd = (spamd_address_container *)store_get(sizeof(spamd_address_container));
 
     for (sublist = address, args = 0, spamd_param_init(sd);
-        s = string_nextinlist(&sublist, &sublist_sep, NULL, 0);
+        (s = string_nextinlist(&sublist, &sublist_sep, NULL, 0));
         args++
         )
       {
-       HDEBUG(D_acl) debug_printf("spamd: addr parm '%s'\n", s);
+       DEBUG(D_acl) debug_printf_indent("spamd:  addr parm '%s'\n", s);
        switch (args)
        {
        case 0:   sd->hostspec = s;
@@ -316,17 +333,25 @@ start = time(NULL);
     goto defer;
     }
 
-  while (1)
+  current_server = spamd_get_server(spamd_address_vector, num_servers);
+  sd = spamd_address_vector[current_server];
+  for(;;)
     {
     uschar * errstr;
 
-    current_server = spamd_get_server(spamd_address_vector, num_servers);
-    sd = spamd_address_vector[current_server];
+    DEBUG(D_acl) debug_printf_indent("spamd: trying server %s\n", sd->hostspec);
 
-    debug_printf("trying server %s\n", sd->hostspec);
-
-    /* contact a spamd */
-    if ((spamd_sock = ip_streamsocket(sd->hostspec, &errstr, 5)) >= 0)
+    for (;;)
+      {
+      /*XXX could potentially use TFO early-data here */
+      if (  (spamd_sock = ip_streamsocket(sd->hostspec, &errstr, 5)) >= 0
+         || sd->retry <= 0
+        )
+       break;
+      DEBUG(D_acl) debug_printf_indent("spamd: server %s: retry conn\n", sd->hostspec);
+      while (sd->retry > 0) sd->retry = sleep(sd->retry);
+      }
+    if (spamd_sock >= 0)
       break;
 
     log_write(0, LOG_MAIN, "%s spamd: %s", loglabel, errstr);
@@ -335,44 +360,41 @@ start = time(NULL);
     current_server = spamd_get_server(spamd_address_vector, num_servers);
     if (current_server < 0)
       {
-      log_write(0, LOG_MAIN|LOG_PANIC, "%s all spamd servers failed",
-       loglabel);
+      log_write(0, LOG_MAIN|LOG_PANIC, "%s all spamd servers failed", loglabel);
       goto defer;
       }
+    sd = spamd_address_vector[current_server];
     }
-    is_rspamd = sd->is_rspamd;
-  }
-
-if (spamd_sock == -1)
-  {
-  log_write(0, LOG_MAIN|LOG_PANIC,
-      "programming fault, spamd_sock unexpectedly unset");
-  goto defer;
   }
 
 (void)fcntl(spamd_sock, F_SETFL, O_NONBLOCK);
 /* now we are connected to spamd on spamd_sock */
-if (is_rspamd)
-  {                            /* rspamd variant */
-  uschar *req_str;
-  const char *helo;
-  const char *fcrdns;
-
-  req_str = string_sprintf("CHECK RSPAMC/1.3\r\nContent-length: %lu\r\n"
-    "Queue-Id: %s\r\nFrom: <%s>\r\nRecipient-Number: %d\r\n", mbox_size,
-    message_id, sender_address, recipients_count);
+if (sd->is_rspamd)
+  {
+  gstring * req_str;
+  const uschar * s;
+
+  req_str = string_append(NULL, 8,
+    "CHECK RSPAMC/1.3\r\nContent-length: ", string_sprintf("%lu\r\n", mbox_size),
+    "Queue-Id: ", message_id,
+    "\r\nFrom: <", sender_address,
+    ">\r\nRecipient-Number: ", string_sprintf("%d\r\n", recipients_count));
+
   for (i = 0; i < recipients_count; i ++)
-    req_str = string_sprintf("%sRcpt: <%s>\r\n", req_str, recipients_list[i].address);
-  if ((helo = expand_string(US"$sender_helo_name")) != NULL && *helo != '\0')
-    req_str = string_sprintf("%sHelo: %s\r\n", req_str, helo);
-  if ((fcrdns = expand_string(US"$sender_host_name")) != NULL && *fcrdns != '\0')
-    req_str = string_sprintf("%sHostname: %s\r\n", req_str, fcrdns);
-  if (sender_host_address != NULL)
-    req_str = string_sprintf("%sIP: %s\r\n", req_str, sender_host_address);
-  req_str = string_sprintf("%s\r\n", req_str);
-  wrote = send(spamd_sock, req_str, Ustrlen(req_str), 0); 
+    req_str = string_append(req_str, 3,
+      "Rcpt: <", recipients_list[i].address, ">\r\n");
+  if ((s = expand_string(US"$sender_helo_name")) && *s)
+    req_str = string_append(req_str, 3, "Helo: ", s, "\r\n");
+  if ((s = expand_string(US"$sender_host_name")) && *s)
+    req_str = string_append(req_str, 3, "Hostname: ", s, "\r\n");
+  if (sender_host_address)
+    req_str = string_append(req_str, 3, "IP: ", sender_host_address, "\r\n");
+  if ((s = expand_string(US"$authenticated_id")) && *s)
+    req_str = string_append(req_str, 3, "User: ", s, "\r\n");
+  req_str = string_catn(req_str, US"\r\n", 2);
+  wrote = send(spamd_sock, req_str->s, req_str->ptr, 0);
   }
-  else
+else
   {                            /* spamassassin variant */
   (void)string_format(spamd_buffer,
          sizeof(spamd_buffer),
@@ -382,21 +404,22 @@ if (is_rspamd)
   /* send our request */
   wrote = send(spamd_sock, spamd_buffer, Ustrlen(spamd_buffer), 0);
   }
+
 if (wrote == -1)
   {
   (void)close(spamd_sock);
   log_write(0, LOG_MAIN|LOG_PANIC,
-       "%s spamd send failed: %s", loglabel, strerror(errno));
+       "%s spamd %s send failed: %s", loglabel, callout_address, strerror(errno));
   goto defer;
   }
 
 /* now send the file */
-/* spamd sometimes accepts conections but doesn't read data off
+/* spamd sometimes accepts connections but doesn't read data off
  * the connection.  We make the file descriptor non-blocking so
  * that the write will only write sufficient data without blocking
- * and we poll the desciptor to make sure that we can write without
+ * and we poll the descriptor to make sure that we can write without
  * blocking.  Short writes are gracefully handled and if the whole
- * trasaction takes too long it is aborted.
+ * transaction takes too long it is aborted.
  * Note: poll() is not supported in OSX 10.2 and is reported to be
  *       broken in more recent versions (up to 10.4).
  */
@@ -431,13 +454,13 @@ again:
       {
       if (result == -1)
        log_write(0, LOG_MAIN|LOG_PANIC,
-         "%s %s on spamd socket", loglabel, strerror(errno));
+         "%s %s on spamd %s socket", loglabel, callout_address, strerror(errno));
       else
        {
-       if (time(NULL) - start < SPAMD_TIMEOUT)
+       if (time(NULL) - start < sd->timeout)
          goto again;
        log_write(0, LOG_MAIN|LOG_PANIC,
-         "%s timed out writing spamd socket", loglabel);
+         "%s timed out writing spamd %s, socket", loglabel, callout_address);
        }
       (void)close(spamd_sock);
       goto defer;
@@ -447,7 +470,7 @@ again:
     if (wrote == -1)
       {
       log_write(0, LOG_MAIN|LOG_PANIC,
-         "%s %s on spamd socket", loglabel, strerror(errno));
+         "%s %s on spamd %s socket", loglabel, callout_address, strerror(errno));
       (void)close(spamd_sock);
       goto defer;
       }
@@ -471,7 +494,8 @@ if (ferror(mbox_file))
 (void)fclose(mbox_file);
 
 /* we're done sending, close socket for writing */
-shutdown(spamd_sock,SHUT_WR);
+if (!sd->is_rspamd)
+  shutdown(spamd_sock,SHUT_WR);
 
 /* read spamd response using what's left of the timeout.  */
 memset(spamd_buffer, 0, sizeof(spamd_buffer));
@@ -479,14 +503,15 @@ offset = 0;
 while ((i = ip_recv(spamd_sock,
                   spamd_buffer + offset,
                   sizeof(spamd_buffer) - offset - 1,
-                  SPAMD_TIMEOUT - time(NULL) + start)) > 0 )
+                  sd->timeout - time(NULL) + start)) > 0)
   offset += i;
+spamd_buffer[offset] = '\0';   /* guard byte */
 
 /* error handling */
 if (i <= 0 && errno != 0)
   {
   log_write(0, LOG_MAIN|LOG_PANIC,
-       "%s error reading from spamd socket: %s", loglabel, strerror(errno));
+       "%s error reading from spamd %s, socket: %s", loglabel, callout_address, strerror(errno));
   (void)close(spamd_sock);
   return DEFER;
   }
@@ -494,17 +519,19 @@ if (i <= 0 && errno != 0)
 /* reading done */
 (void)close(spamd_sock);
 
-if (is_rspamd)
+if (sd->is_rspamd)
   {                            /* rspamd variant of reply */
   int r;
-  if ((r = sscanf(CS spamd_buffer,
+  if (  (r = sscanf(CS spamd_buffer,
          "RSPAMD/%7s 0 EX_OK\r\nMetric: default; %7s %lf / %lf / %lf\r\n%n",
          spamd_version, spamd_short_result, &spamd_score, &spamd_threshold,
-         &spamd_reject_score, &spamd_report_offset)) != 5)
+         &spamd_reject_score, &spamd_report_offset)) != 5
+     || spamd_report_offset >= offset          /* verify within buffer */
+     )
     {
-      log_write(0, LOG_MAIN|LOG_PANIC,
-               "%s cannot parse spamd output: %d", loglabel, r);
-      return DEFER;
+    log_write(0, LOG_MAIN|LOG_PANIC,
+             "%s cannot parse spamd %s, output: %d", loglabel, callout_address, r);
+    return DEFER;
     }
   /* now parse action */
   p = &spamd_buffer[spamd_report_offset];
@@ -532,7 +559,7 @@ else
           spamd_version,&spamd_score,&spamd_threshold,&spamd_report_offset) != 3)
        {
        log_write(0, LOG_MAIN|LOG_PANIC,
-                 "%s cannot parse spamd output", loglabel);
+                 "%s cannot parse spamd %s output", loglabel, callout_address);
        return DEFER;
        }
     }