tidying: dkim output function args
[exim.git] / src / src / spam.c
index 96780f59e0ba94a9d3d221c84018d5744bdcf788..f46e11e42391d7005d412b42afa73a87f4db4bb5 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 2016
+ */
 
 /* Code for calling spamassassin's spamd. Called from acl.c. */
 
@@ -27,41 +29,36 @@ 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 */
+/* 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;
 const uschar * s;
 const uschar * name;
 
-/* check backup parameter */
-if (Ustrcmp(param, "backup") == 0)
-  {
-  spamd->is_backup = TRUE;
-  return 0; /* OK */
-  }
-
 /*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 (Ustrncmp(param, "time=", 5) == 0)
   {
   unsigned int start_h = 0, start_m = 0, start_s = 0;
@@ -136,46 +133,50 @@ badval:
 
 
 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;
-
-for (;;)
-  {
-  /* seedup, if we have only 1 server */
-  if (num_servers == 1)
-    return (spamds[0]->is_failed ? -1 : 0);
+spamd_address_container * sd;
+long rnd, weights;
+unsigned pri;
+static BOOL srandomed = FALSE;
 
-  /* init ranmod */
-  if (!srandomed)
-    {
-    struct timeval tv;
-    gettimeofday(&tv, NULL);
-    srandom((unsigned int)(tv.tv_usec/1000));
-    srandomed = TRUE;
-    }
+/* speedup, if we have only 1 server */
+if (num_servers == 1)
+  return (spamds[0]->is_failed ? -1 : 0);
 
-  /* 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);
@@ -204,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 */
@@ -251,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("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
@@ -280,12 +280,13 @@ start = time(NULL);
   {
   int num_servers = 0;
   int current_server;
-  uschar *address;
-  const 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];
 
   /* Check how many spamd servers we have
      and register their addresses */
+  sep = 0;                             /* default colon-sep */
   while ((address = string_nextinlist(&spamd_address_list_ptr, &sep,
                                      NULL, 0)) != NULL)
     {
@@ -294,15 +295,15 @@ start = time(NULL);
     unsigned args;
     uschar * s;
 
-    HDEBUG(D_acl) debug_printf("spamd: addr entry '%s'\n", address);
+    DEBUG(D_acl) debug_printf("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("spamd:  addr parm '%s'\n", s);
        switch (args)
        {
        case 0:   sd->hostspec = s;
@@ -341,7 +342,7 @@ start = time(NULL);
     {
     uschar * errstr;
 
-    debug_printf("trying server %s\n", sd->hostspec);
+    DEBUG(D_acl) debug_printf("spamd: trying server %s\n", sd->hostspec);
 
     for (;;)
       {
@@ -349,7 +350,7 @@ start = time(NULL);
          || sd->retry <= 0
         )
        break;
-      debug_printf("server %s: retry conn\n", sd->hostspec);
+      DEBUG(D_acl) debug_printf("spamd: server %s: retry conn\n", sd->hostspec);
       while (sd->retry > 0) sd->retry = sleep(sd->retry);
       }
     if (spamd_sock >= 0)
@@ -368,24 +369,18 @@ start = time(NULL);
     }
   }
 
-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 (sd->is_rspamd)
   {                            /* rspamd variant */
   uschar *req_str;
-  const char *helo;
-  const char *fcrdns;
+  const uschar * helo;
+  const uschar * fcrdns;
+  const uschar * authid;
 
   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);
+    "Queue-Id: %s\r\nFrom: <%s>\r\nRecipient-Number: %d\r\n",
+    mbox_size, message_id, sender_address, 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')
@@ -394,10 +389,12 @@ if (sd->is_rspamd)
     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);
+  if ((authid = expand_string(US"$authenticated_id")) != NULL && *authid != '\0')
+    req_str = string_sprintf("%sUser: %s\r\n", req_str, authid);
   req_str = string_sprintf("%s\r\n", req_str);
-  wrote = send(spamd_sock, req_str, Ustrlen(req_str), 0); 
+  wrote = send(spamd_sock, req_str, Ustrlen(req_str), 0);
   }
-  else
+else
   {                            /* spamassassin variant */
   (void)string_format(spamd_buffer,
          sizeof(spamd_buffer),
@@ -407,11 +404,12 @@ if (sd->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;
   }
 
@@ -456,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 < 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;
@@ -472,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;
       }
@@ -504,14 +502,15 @@ offset = 0;
 while ((i = ip_recv(spamd_sock,
                   spamd_buffer + offset,
                   sizeof(spamd_buffer) - offset - 1,
-                  sd->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;
   }
@@ -522,14 +521,16 @@ if (i <= 0 && errno != 0)
 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];
@@ -557,7 +558,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;
        }
     }