src/src/spam.c

   1 /* $Cambridge: exim/src/src/spam.c,v 1.1.2.1 2004/11/26 09:13:34 tom Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* This file is part of the exiscan-acl content scanner
   8 patch. It is NOT part of the standard exim distribution. */
   9
  10 /* Copyright (c) Tom Kistner <tom@duncanthrax.net> 2003-???? */
  11 /* License: GPL */
  12
  13 /* Code for calling spamassassin's spamd. Called from acl.c. */
  14
  15 #include "exim.h"
  16 #include "spam.h"
  17
  18 uschar spam_score_buffer[16];
  19 uschar spam_score_int_buffer[16];
  20 uschar spam_bar_buffer[128];
  21 uschar spam_report_buffer[32600];
  22 uschar prev_user_name[128] = "";
  23 int spam_ok = 0;
  24 int spam_rc = 0;
  25
  26 int spam(uschar **listptr) {
  27   int sep = 0;
  28   uschar *list = *listptr;
  29   uschar *user_name;
  30   uschar user_name_buffer[128];
  31   unsigned long long mbox_size;
  32   FILE *mbox_file;
  33   int spamd_sock;
  34   uschar spamd_buffer[32600];
  35   int i, j, offset;
  36   uschar spamd_version[8];
  37   uschar spamd_score_char;
  38   double spamd_threshold, spamd_score;
  39   int spamd_report_offset;
  40   uschar *p,*q;
  41   int override = 0;
  42   struct sockaddr_un server;
  43
  44   /* find the username from the option list */
  45   if ((user_name = string_nextinlist(&list, &sep,
  46                                      user_name_buffer,
  47                                      sizeof(user_name_buffer))) == NULL) {
  48     /* no username given, this means no scanning should be done */
  49     return FAIL;
  50   };
  51
  52   /* if username is "0" or "false", do not scan */
  53   if ( (Ustrcmp(user_name,"0") == 0) ||
  54        (strcmpic(user_name,US"false") == 0) ) {
  55     return FAIL;
  56   };
  57
  58   /* if there is an additional option, check if it is "true" */
  59   if (strcmpic(list,US"true") == 0) {
  60     /* in that case, always return true later */
  61     override = 1;
  62   };
  63
  64   /* if we scanned for this username last time, just return */
  65   if ( spam_ok && ( Ustrcmp(prev_user_name, user_name) == 0 ) ) {
  66     if (override)
  67       return OK;
  68     else
  69       return spam_rc;
  70   };
  71
  72   /* make sure the eml mbox file is spooled up */
  73   mbox_file = spool_mbox(&mbox_size);
  74
  75   if (mbox_file == NULL) {
  76     /* error while spooling */
  77     log_write(0, LOG_MAIN|LOG_PANIC,
  78            "spam acl condition: error while creating mbox spool file");
  79     return DEFER;
  80   };
  81
  82   /* socket does not start with '/' -> network socket */
  83   if (*spamd_address != '/') {
  84     time_t now = time(NULL);
  85     int num_servers = 0;
  86     int current_server = 0;
  87     int start_server = 0;
  88     uschar *address = NULL;
  89     uschar *spamd_address_list_ptr = spamd_address;
  90     uschar address_buffer[256];
  91     spamd_address_container * spamd_address_vector[32];
  92
  93     /* Check how many spamd servers we have
  94        and register their addresses */
  95     while ((address = string_nextinlist(&spamd_address_list_ptr, &sep,
  96                                         address_buffer,
  97                                         sizeof(address_buffer))) != NULL) {
  98
  99       spamd_address_container *this_spamd =
 100         (spamd_address_container *)store_get(sizeof(spamd_address_container));
 101
 102       /* grok spamd address and port */
 103       if( sscanf(CS address, "%s %u", this_spamd->tcp_addr, &(this_spamd->tcp_port)) != 2 ) {
 104         log_write(0, LOG_MAIN,
 105           "spam acl condition: warning - invalid spamd address: '%s'", address);
 106         continue;
 107       };
 108
 109       spamd_address_vector[num_servers] = this_spamd;
 110       num_servers++;
 111       if (num_servers > 31)
 112         break;
 113     };
 114
 115     /* check if we have at least one server */
 116     if (!num_servers) {
 117       log_write(0, LOG_MAIN|LOG_PANIC,
 118          "spam acl condition: no useable spamd server addresses in spamd_address configuration option.");
 119       fclose(mbox_file);
 120       return DEFER;
 121     };
 122
 123     current_server = start_server = (int)now % num_servers;
 124
 125     while (1) {
 126
 127       debug_printf("trying server %s, port %u\n",
 128                    spamd_address_vector[current_server]->tcp_addr,
 129                    spamd_address_vector[current_server]->tcp_port);
 130
 131       /* contact a spamd */
 132       if ( (spamd_sock = ip_socket(SOCK_STREAM, AF_INET)) < 0) {
 133         log_write(0, LOG_MAIN|LOG_PANIC,
 134            "spam acl condition: error creating IP socket for spamd");
 135         fclose(mbox_file);
 136         return DEFER;
 137       };
 138
 139       if (ip_connect( spamd_sock,
 140                       AF_INET,
 141                       spamd_address_vector[current_server]->tcp_addr,
 142                       spamd_address_vector[current_server]->tcp_port,
 143                       5 ) > -1) {
 144         /* connection OK */
 145         break;
 146       };
 147
 148       log_write(0, LOG_MAIN|LOG_PANIC,
 149          "spam acl condition: warning - spamd connection to %s, port %u failed: %s",
 150          spamd_address_vector[current_server]->tcp_addr,
 151          spamd_address_vector[current_server]->tcp_port,
 152          strerror(errno));
 153       current_server++;
 154       if (current_server >= num_servers)
 155         current_server = 0;
 156       if (current_server == start_server) {
 157         log_write(0, LOG_MAIN|LOG_PANIC, "spam acl condition: all spamd servers failed");
 158         fclose(mbox_file);
 159         close(spamd_sock);
 160         return DEFER;
 161       };
 162     };
 163
 164   }
 165   else {
 166     /* open the local socket */
 167
 168     if ((spamd_sock = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
 169       log_write(0, LOG_MAIN|LOG_PANIC,
 170                 "malware acl condition: spamd: unable to acquire socket (%s)",
 171                 strerror(errno));
 172       fclose(mbox_file);
 173       return DEFER;
 174     }
 175
 176     server.sun_family = AF_UNIX;
 177     Ustrcpy(server.sun_path, spamd_address);
 178
 179     if (connect(spamd_sock, (struct sockaddr *) &server, sizeof(struct sockaddr_un)) < 0) {
 180       log_write(0, LOG_MAIN|LOG_PANIC,
 181                 "malware acl condition: spamd: unable to connect to UNIX socket %s (%s)",
 182                 spamd_address, strerror(errno) );
 183       fclose(mbox_file);
 184       close(spamd_sock);
 185       return DEFER;
 186     }
 187
 188   }
 189
 190   /* now we are connected to spamd on spamd_sock */
 191   snprintf(CS spamd_buffer,
 192            sizeof(spamd_buffer),
 193            "REPORT SPAMC/1.2\r\nUser: %s\r\nContent-length: %lld\r\n\r\n",
 194            user_name,
 195            mbox_size);
 196
 197   /* send our request */
 198   if (send(spamd_sock, spamd_buffer, Ustrlen(spamd_buffer), 0) < 0) {
 199     close(spamd_sock);
 200     log_write(0, LOG_MAIN|LOG_PANIC,
 201          "spam acl condition: spamd send failed: %s", strerror(errno));
 202     fclose(mbox_file);
 203     close(spamd_sock);
 204     return DEFER;
 205   };
 206
 207   /* now send the file */
 208   do {
 209     j = fread(spamd_buffer,1,sizeof(spamd_buffer),mbox_file);
 210     if (j > 0) {
 211       i = send(spamd_sock,spamd_buffer,j,0);
 212       if (i != j) {
 213         log_write(0, LOG_MAIN|LOG_PANIC,
 214           "spam acl condition: error/short send to spamd");
 215         close(spamd_sock);
 216         fclose(mbox_file);
 217         return DEFER;
 218       };
 219     };
 220   }
 221   while (j > 0);
 222
 223   fclose(mbox_file);
 224
 225   /* we're done sending, close socket for writing */
 226   shutdown(spamd_sock,SHUT_WR);
 227
 228   /* read spamd response */
 229   memset(spamd_buffer, 0, sizeof(spamd_buffer));
 230   offset = 0;
 231   while((i = ip_recv(spamd_sock,
 232                      spamd_buffer + offset,
 233                      sizeof(spamd_buffer) - offset - 1,
 234                      SPAMD_READ_TIMEOUT)) > 0 ) {
 235     offset += i;
 236   }
 237
 238   /* error handling */
 239   if((i <= 0) && (errno != 0)) {
 240     log_write(0, LOG_MAIN|LOG_PANIC,
 241          "spam acl condition: error reading from spamd socket: %s", strerror(errno));
 242     close(spamd_sock);
 243     return DEFER;
 244   }
 245
 246   /* reading done */
 247   close(spamd_sock);
 248
 249   /* dig in the spamd output and put the report in a multiline header, if requested */
 250   if( sscanf(CS spamd_buffer,"SPAMD/%s 0 EX_OK\r\nContent-length: %*u\r\n\r\n%lf/%lf\r\n%n",
 251              spamd_version,&spamd_score,&spamd_threshold,&spamd_report_offset) != 3 ) {
 252
 253     /* try to fall back to pre-2.50 spamd output */
 254     if( sscanf(CS spamd_buffer,"SPAMD/%s 0 EX_OK\r\nSpam: %*s ; %lf / %lf\r\n\r\n%n",
 255                spamd_version,&spamd_score,&spamd_threshold,&spamd_report_offset) != 3 ) {
 256       log_write(0, LOG_MAIN|LOG_PANIC,
 257          "spam acl condition: cannot parse spamd output");
 258       return DEFER;
 259     };
 260   };
 261
 262   /* Create report. Since this is a multiline string,
 263   we must hack it into shape first */
 264   p = &spamd_buffer[spamd_report_offset];
 265   q = spam_report_buffer;
 266   while (*p != '\0') {
 267     /* skip \r */
 268     if (*p == '\r') {
 269       p++;
 270       continue;
 271     };
 272     *q = *p;
 273     q++;
 274     if (*p == '\n') {
 275       *q = '\t';
 276       q++;
 277       /* eat whitespace */
 278       while( (*p <= ' ') && (*p != '\0') ) {
 279         p++;
 280       };
 281       p--;
 282     };
 283     p++;
 284   };
 285   /* NULL-terminate */
 286   *q = '\0';
 287   q--;
 288   /* cut off trailing leftovers */
 289   while (*q <= ' ') {
 290     *q = '\0';
 291     q--;
 292   };
 293   spam_report = spam_report_buffer;
 294
 295   /* create spam bar */
 296   spamd_score_char = spamd_score > 0 ? '+' : '-';
 297   j = abs((int)(spamd_score));
 298   i = 0;
 299   if( j != 0 ) {
 300     while((i < j) && (i <= MAX_SPAM_BAR_CHARS))
 301        spam_bar_buffer[i++] = spamd_score_char;
 302   }
 303   else{
 304     spam_bar_buffer[0] = '/';
 305     i = 1;
 306   }
 307   spam_bar_buffer[i] = '\0';
 308   spam_bar = spam_bar_buffer;
 309
 310   /* create "float" spam score */
 311   snprintf(CS spam_score_buffer, sizeof(spam_score_buffer),"%.1f", spamd_score);
 312   spam_score = spam_score_buffer;
 313
 314   /* create "int" spam score */
 315   j = (int)((spamd_score + 0.001)*10);
 316   snprintf(CS spam_score_int_buffer, sizeof(spam_score_int_buffer), "%d", j);
 317   spam_score_int = spam_score_int_buffer;
 318
 319   /* compare threshold against score */
 320   if (spamd_score >= spamd_threshold) {
 321     /* spam as determined by user's threshold */
 322     spam_rc = OK;
 323   }
 324   else {
 325     /* not spam */
 326     spam_rc = FAIL;
 327   };
 328
 329   /* remember user name and "been here" for it */
 330   Ustrcpy(prev_user_name, user_name);
 331   spam_ok = 1;
 332
 333   if (override) {
 334     /* always return OK, no matter what the score */
 335     return OK;
 336   }
 337   else {
 338     return spam_rc;
 339   };
 340 }