src/src/spam.c

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