tidying

[exim.git] / src / src / spam.c

diff --git a/src/src/spam.c b/src/src/spam.c
index fa3a4fb68dac74253d13b568b197dfef4979b0df..e3316ed968f4912e04dc253c1d2ac18570b7dd9d 100644 (file)
--- a/src/src/spam.c
+++ b/src/src/spam.c
@@ -4,7 +4,7 @@
 
 /* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003 - 2015
  * License: GPL
 
 /* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003 - 2015
  * License: GPL

- * Copyright (c) The Exim Maintainers 2016
+ * Copyright (c) The Exim Maintainers 2016 - 2021

  */
 
 /* Code for calling spamassassin's spamd. Called from acl.c. */
  */
 
 /* Code for calling spamassassin's spamd. Called from acl.c. */


@@ -18,7 +18,7 @@ uschar spam_score_int_buffer[16];
 uschar spam_bar_buffer[128];
 uschar spam_action_buffer[32];
 uschar spam_report_buffer[32600];
 uschar spam_bar_buffer[128];
 uschar spam_action_buffer[32];
 uschar spam_report_buffer[32600];

-uschar prev_user_name[128] = "";
+uschar * prev_user_name = NULL;

 int spam_ok = 0;
 int spam_rc = 0;
 uschar *prev_spamd_address_work = NULL;
 int spam_ok = 0;
 int spam_rc = 0;
 uschar *prev_spamd_address_work = NULL;


@@ -35,7 +35,7 @@ spamd->is_failed = FALSE;
 spamd->weight = SPAMD_WEIGHT;
 spamd->timeout = SPAMD_TIMEOUT;
 spamd->retry = 0;
 spamd->weight = SPAMD_WEIGHT;
 spamd->timeout = SPAMD_TIMEOUT;
 spamd->retry = 0;

-spamd->priority = 1;
+spamd->priority = SPAMD_PRIORITY;

 return 0;
 }
 
 return 0;
 }
 


@@ -137,23 +137,13 @@ spamd_get_server(spamd_address_container ** spamds, int num_servers)
 {
 unsigned int i;
 spamd_address_container * sd;
 {
 unsigned int i;
 spamd_address_container * sd;

-long rnd, weights;
+long weights;

 unsigned pri;
 unsigned pri;

-static BOOL srandomed = FALSE;

 
 /* speedup, 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;
-  }
-

 /* scan for highest pri */
 for (pri = 0, i = 0; i < num_servers; i++)
   {
 /* scan for highest pri */
 for (pri = 0, i = 0; i < num_servers; i++)
   {


@@ -170,11 +160,11 @@ for (weights = 0, i = 0; i < num_servers; i++)
 if (weights == 0)      /* all servers failed */
   return -1;
 
 if (weights == 0)      /* all servers failed */
   return -1;
 

-for (rnd = random() % weights, i = 0; i < num_servers; i++)
+for (long rnd = random_number(weights), i = 0; i < num_servers; i++)

   {
   sd = spamds[i];
   if (!sd->is_failed && sd->priority == pri)
   {
   sd = spamds[i];
   if (!sd->is_failed && sd->priority == pri)

-    if ((rnd -= sd->weight) <= 0)
+    if ((rnd -= sd->weight) < 0)

       return i;
   }
 
       return i;
   }
 


@@ -190,10 +180,9 @@ spam(const uschar **listptr)
 int sep = 0;
 const uschar *list = *listptr;
 uschar *user_name;
 int sep = 0;
 const uschar *list = *listptr;
 uschar *user_name;

-uschar user_name_buffer[128];

 unsigned long mbox_size;
 FILE *mbox_file;
 unsigned long mbox_size;
 FILE *mbox_file;

-int spamd_sock = -1;
+client_conn_ctx spamd_cctx = {.sock = -1};

 uschar spamd_buffer[32600];
 int i, j, offset, result;
 uschar spamd_version[8];
 uschar spamd_buffer[32600];
 int i, j, offset, result;
 uschar spamd_version[8];


@@ -205,12 +194,6 @@ uschar *p,*q;
 int override = 0;
 time_t start;
 size_t read, wrote;
 int override = 0;
 time_t start;
 size_t read, wrote;

-#ifndef NO_POLL_H
-struct pollfd pollfd;
-#else                               /* Patch posted by Erik ? for OS X */
-struct timeval select_tv;         /* and applied by PH */
-fd_set select_fd;
-#endif

 uschar *spamd_address_work;
 spamd_address_container * sd;
 
 uschar *spamd_address_work;
 spamd_address_container * sd;
 


@@ -218,17 +201,14 @@ spamd_address_container * sd;
 result = 0;
 
 /* find the username from the option list */
 result = 0;
 
 /* find the username from the option list */

-if ((user_name = string_nextinlist(&list, &sep,
-                                  user_name_buffer,
-                                  sizeof(user_name_buffer))) == NULL)
+if (!(user_name = string_nextinlist(&list, &sep, NULL, 0)))

   {
   /* no username given, this means no scanning should be done */
   return FAIL;
   }
 
 /* if username is "0" or "false", do not scan */
   {
   /* no username given, this means no scanning should be done */
   return FAIL;
   }
 
 /* if username is "0" or "false", do not scan */

-if ( (Ustrcmp(user_name,"0") == 0) ||
-     (strcmpic(user_name,US"false") == 0) )
+if (Ustrcmp(user_name, "0") == 0 || strcmpic(user_name, US"false") == 0)

   return FAIL;
 
 /* if there is an additional option, check if it is "true" */
   return FAIL;
 
 /* if there is an additional option, check if it is "true" */


@@ -237,19 +217,15 @@ if (strcmpic(list,US"true") == 0)
   override = 1;
 
 /* expand spamd_address if needed */
   override = 1;
 
 /* expand spamd_address if needed */

-if (*spamd_address == '$')
+if (*spamd_address != '$')
+  spamd_address_work = spamd_address;
+else if (!(spamd_address_work = expand_string(spamd_address)))

   {
   {

-  spamd_address_work = expand_string(spamd_address);
-  if (spamd_address_work == NULL)
-    {
-    log_write(0, LOG_MAIN|LOG_PANIC,
-      "%s spamd_address starts with $, but expansion failed: %s",
-      loglabel, expand_string_message);
-    return DEFER;
-    }
+  log_write(0, LOG_MAIN|LOG_PANIC,
+    "%s spamd_address starts with $, but expansion failed: %s",
+    loglabel, expand_string_message);
+  return DEFER;

   }
   }

-else
-  spamd_address_work = spamd_address;

 
 DEBUG(D_acl) debug_printf_indent("spamd: addrlist '%s'\n", spamd_address_work);
 
 
 DEBUG(D_acl) debug_printf_indent("spamd: addrlist '%s'\n", spamd_address_work);
 


@@ -293,7 +269,7 @@ start = time(NULL);
     uschar * s;
 
     DEBUG(D_acl) debug_printf_indent("spamd: addr entry '%s'\n", address);
     uschar * s;
 
     DEBUG(D_acl) debug_printf_indent("spamd: addr entry '%s'\n", address);

-    sd = (spamd_address_container *)store_get(sizeof(spamd_address_container));
+    sd = store_get(sizeof(spamd_address_container), FALSE);

 
     for (sublist = address, args = 0, spamd_param_init(sd);
         (s = string_nextinlist(&sublist, &sublist_sep, NULL, 0));
 
     for (sublist = address, args = 0, spamd_param_init(sd);
         (s = string_nextinlist(&sublist, &sublist_sep, NULL, 0));


@@ -343,14 +319,15 @@ start = time(NULL);
 
     for (;;)
       {
 
     for (;;)
       {

-      if (  (spamd_sock = ip_streamsocket(sd->hostspec, &errstr, 5)) >= 0
+      /*XXX could potentially use TFO early-data here */
+      if (  (spamd_cctx.sock = ip_streamsocket(sd->hostspec, &errstr, 5, NULL)) >= 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);
       }
          || 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)
+    if (spamd_cctx.sock >= 0)

       break;
 
     log_write(0, LOG_MAIN, "%s spamd: %s", loglabel, errstr);
       break;
 
     log_write(0, LOG_MAIN, "%s spamd: %s", loglabel, errstr);


@@ -366,68 +343,66 @@ start = time(NULL);
     }
   }
 
     }
   }
 

-(void)fcntl(spamd_sock, F_SETFL, O_NONBLOCK);
-/* now we are connected to spamd on spamd_sock */
+(void)fcntl(spamd_cctx.sock, F_SETFL, O_NONBLOCK);
+/* now we are connected to spamd on spamd_cctx.sock */

 if (sd->is_rspamd)
   {
 if (sd->is_rspamd)
   {

-  uschar * req_str = NULL;
-  int size = 0, len = 0;
+  gstring * req_str;

   const uschar * s;
 
   const uschar * s;
 

-  req_str = string_append(req_str, &size, &len, 8,
+  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));
 
     "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_append(req_str, &size, &len, 3,
+  for (int i = 0; i < recipients_count; i++)
+    req_str = string_append(req_str, 3,

       "Rcpt: <", recipients_list[i].address, ">\r\n");
   if ((s = expand_string(US"$sender_helo_name")) && *s)
       "Rcpt: <", recipients_list[i].address, ">\r\n");
   if ((s = expand_string(US"$sender_helo_name")) && *s)

-    req_str = string_append(req_str, &size, &len, 3, "Helo: ", s, "\r\n");
+    req_str = string_append(req_str, 3, "Helo: ", s, "\r\n");

   if ((s = expand_string(US"$sender_host_name")) && *s)
   if ((s = expand_string(US"$sender_host_name")) && *s)

-    req_str = string_append(req_str, &size, &len, 3, "Hostname: ", s, "\r\n");
+    req_str = string_append(req_str, 3, "Hostname: ", s, "\r\n");

   if (sender_host_address)
   if (sender_host_address)

-    req_str = string_append(req_str, &size, &len, 3, "IP: ", sender_host_address, "\r\n");
+    req_str = string_append(req_str, 3, "IP: ", sender_host_address, "\r\n");

   if ((s = expand_string(US"$authenticated_id")) && *s)
   if ((s = expand_string(US"$authenticated_id")) && *s)

-    req_str = string_append(req_str, &size, &len, 3, "User: ", s, "\r\n");
-  req_str = string_catn(req_str, &size, &len, "\r\n", 2);
-  wrote = send(spamd_sock, req_str, len, 0);
+    req_str = string_append(req_str, 3, "User: ", s, "\r\n");
+  req_str = string_catn(req_str, US"\r\n", 2);
+  wrote = send(spamd_cctx.sock, req_str->s, req_str->ptr, 0);

   }
 else
   {                            /* spamassassin variant */
   }
 else
   {                            /* spamassassin variant */

-  (void)string_format(spamd_buffer,
-         sizeof(spamd_buffer),
-         "REPORT SPAMC/1.2\r\nUser: %s\r\nContent-length: %ld\r\n\r\n",
-         user_name,
-         mbox_size);
+  int n;
+  uschar * s = string_sprintf(
+         "REPORT SPAMC/1.2\r\nUser: %s\r\nContent-length: %ld\r\n\r\n%n",
+         user_name, mbox_size, &n);

   /* send our request */
   /* send our request */

-  wrote = send(spamd_sock, spamd_buffer, Ustrlen(spamd_buffer), 0);
+  wrote = send(spamd_cctx.sock, s, n, 0);

   }
 
 if (wrote == -1)
   {
   }
 
 if (wrote == -1)
   {

-  (void)close(spamd_sock);
+  (void)close(spamd_cctx.sock);

   log_write(0, LOG_MAIN|LOG_PANIC,
        "%s spamd %s send failed: %s", loglabel, callout_address, strerror(errno));
   goto defer;
   }
 
 /* now send the file */
   log_write(0, LOG_MAIN|LOG_PANIC,
        "%s spamd %s send failed: %s", loglabel, callout_address, strerror(errno));
   goto defer;
   }
 
 /* now send the file */

-/* 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 descriptor to make sure that we can write without
- * blocking.  Short writes are gracefully handled and if the whole
- * 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).
+/* 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 descriptor to make sure that we
+can write without blocking.  Short writes are gracefully handled and if the
+whole 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). Workaround using select() removed 2021/11 (jgh).

  */
  */

-#ifndef NO_POLL_H
-pollfd.fd = spamd_sock;
-pollfd.events = POLLOUT;
+#ifdef NO_POLL_H
+# error Need poll(2) support

 #endif
 #endif

-(void)fcntl(spamd_sock, F_SETFL, O_NONBLOCK);
+
+(void)fcntl(spamd_cctx.sock, F_SETFL, O_NONBLOCK);

 do
   {
   read = fread(spamd_buffer,1,sizeof(spamd_buffer),mbox_file);
 do
   {
   read = fread(spamd_buffer,1,sizeof(spamd_buffer),mbox_file);


@@ -435,19 +410,7 @@ do
     {
     offset = 0;
 again:
     {
     offset = 0;
 again:

-#ifndef NO_POLL_H
-    result = poll(&pollfd, 1, 1000);
-
-/* Patch posted by Erik ? for OS X and applied by PH */
-#else
-    select_tv.tv_sec = 1;
-    select_tv.tv_usec = 0;
-    FD_ZERO(&select_fd);
-    FD_SET(spamd_sock, &select_fd);
-    result = select(spamd_sock+1, NULL, &select_fd, NULL, &select_tv);
-#endif
-/* End Erik's patch */
-
+    result = poll_one_fd(spamd_cctx.sock, POLLOUT, 1000);

     if (result == -1 && errno == EINTR)
       goto again;
     else if (result < 1)
     if (result == -1 && errno == EINTR)
       goto again;
     else if (result < 1)


@@ -462,16 +425,16 @@ again:
        log_write(0, LOG_MAIN|LOG_PANIC,
          "%s timed out writing spamd %s, socket", loglabel, callout_address);
        }
        log_write(0, LOG_MAIN|LOG_PANIC,
          "%s timed out writing spamd %s, socket", loglabel, callout_address);
        }

-      (void)close(spamd_sock);
+      (void)close(spamd_cctx.sock);

       goto defer;
       }
 
       goto defer;
       }
 

-    wrote = send(spamd_sock,spamd_buffer + offset,read - offset,0);
+    wrote = send(spamd_cctx.sock,spamd_buffer + offset,read - offset,0);

     if (wrote == -1)
       {
       log_write(0, LOG_MAIN|LOG_PANIC,
          "%s %s on spamd %s socket", loglabel, callout_address, strerror(errno));
     if (wrote == -1)
       {
       log_write(0, LOG_MAIN|LOG_PANIC,
          "%s %s on spamd %s socket", loglabel, callout_address, strerror(errno));

-      (void)close(spamd_sock);
+      (void)close(spamd_cctx.sock);

       goto defer;
       }
     if (offset + wrote != read)
       goto defer;
       }
     if (offset + wrote != read)


@@ -487,7 +450,7 @@ if (ferror(mbox_file))
   {
   log_write(0, LOG_MAIN|LOG_PANIC,
     "%s error reading spool file: %s", loglabel, strerror(errno));
   {
   log_write(0, LOG_MAIN|LOG_PANIC,
     "%s error reading spool file: %s", loglabel, strerror(errno));

-  (void)close(spamd_sock);
+  (void)close(spamd_cctx.sock);

   goto defer;
   }
 
   goto defer;
   }
 


@@ -495,15 +458,15 @@ if (ferror(mbox_file))
 
 /* we're done sending, close socket for writing */
 if (!sd->is_rspamd)
 
 /* we're done sending, close socket for writing */
 if (!sd->is_rspamd)

-  shutdown(spamd_sock,SHUT_WR);
+  shutdown(spamd_cctx.sock,SHUT_WR);

 
 /* read spamd response using what's left of the timeout.  */
 memset(spamd_buffer, 0, sizeof(spamd_buffer));
 offset = 0;
 
 /* read spamd response using what's left of the timeout.  */
 memset(spamd_buffer, 0, sizeof(spamd_buffer));
 offset = 0;

-while ((i = ip_recv(spamd_sock,
+while ((i = ip_recv(&spamd_cctx,

                   spamd_buffer + offset,
                   sizeof(spamd_buffer) - offset - 1,
                   spamd_buffer + offset,
                   sizeof(spamd_buffer) - offset - 1,

-                  sd->timeout - time(NULL) + start)) > 0)
+                  sd->timeout + start)) > 0)

   offset += i;
 spamd_buffer[offset] = '\0';   /* guard byte */
 
   offset += i;
 spamd_buffer[offset] = '\0';   /* guard byte */
 


@@ -512,12 +475,12 @@ if (i <= 0 && errno != 0)
   {
   log_write(0, LOG_MAIN|LOG_PANIC,
        "%s error reading from spamd %s, socket: %s", loglabel, callout_address, strerror(errno));
   {
   log_write(0, LOG_MAIN|LOG_PANIC,
        "%s error reading from spamd %s, socket: %s", loglabel, callout_address, strerror(errno));

-  (void)close(spamd_sock);
+  (void)close(spamd_cctx.sock);

   return DEFER;
   }
 
 /* reading done */
   return DEFER;
   }
 
 /* reading done */

-(void)close(spamd_sock);
+(void)close(spamd_cctx.sock);

 
 if (sd->is_rspamd)
   {                            /* rspamd variant of reply */
 
 if (sd->is_rspamd)
   {                            /* rspamd variant of reply */


@@ -565,7 +528,7 @@ else
     }
 
   Ustrcpy(spam_action_buffer,
     }
 
   Ustrcpy(spam_action_buffer,

-    spamd_score >= spamd_threshold ? "reject" : "no action");
+    spamd_score >= spamd_threshold ? US"reject" : US"no action");

   }
 
 /* Create report. Since this is a multiline string,
   }
 
 /* Create report. Since this is a multiline string,


@@ -633,7 +596,7 @@ if (spamd_address_work != spamd_address)
   prev_spamd_address_work = string_copy(spamd_address_work);
 
 /* remember user name and "been here" for it */
   prev_spamd_address_work = string_copy(spamd_address_work);
 
 /* remember user name and "been here" for it */

-Ustrcpy(prev_user_name, user_name);
+prev_user_name = user_name;

 spam_ok = 1;
 
 return override
 spam_ok = 1;
 
 return override