src/src/dcc.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /*
   6  * Copyright (c) The Exim Maintainers 2015 - 2023
   7  * Copyright (c) Wolfgang Breyha 2005 - 2019
   8  * Vienna University Computer Center
   9  * wbreyha@gmx.net
  10  * See the file NOTICE for conditions of use and distribution.
  11  *
  12  * SPDX-License-Identifier: GPL-2.0-or-later
  13  */
  14
  15 /* Code for calling dccifd. Called from acl.c. */
  16
  17 #include "exim.h"
  18 #ifdef EXPERIMENTAL_DCC
  19 #ifndef WITH_CONTENT_SCAN
  20 # error EXPERIMENTAL_DCC requires WITH_CONTENT_SCAN
  21 #endif
  22
  23 #include "dcc.h"
  24 #include "unistd.h"
  25
  26 #define DCC_HEADER_LIMIT 120
  27
  28 int dcc_ok = 0;
  29 int dcc_rc = 0;
  30
  31 /* This function takes a file descriptor and a buffer as input and
  32 returns either 0 for success or errno in case of error. */
  33
  34 static int flushbuffer
  35 (int socket, gstring *buffer)
  36 {
  37 int rsp;
  38
  39 rsp = write(socket, buffer->s, buffer->ptr);
  40 DEBUG(D_acl)
  41   debug_printf("DCC: flushbuffer(): Result of the write() = %d\n", rsp);
  42 if(rsp < 0)
  43   {
  44   DEBUG(D_acl)
  45     debug_printf("DCC: flushbuffer(): Error writing buffer to socket: %s\n", strerror(errno));
  46   return errno;
  47   }
  48 DEBUG(D_acl)
  49   debug_printf("DCC: flushbuffer(): Wrote buffer to socket:\n%.*s\n", buffer->ptr, buffer->s);
  50 return 0;
  51 }
  52
  53 int
  54 dcc_process(uschar **listptr)
  55 {
  56 int sep = 0;
  57 const uschar *list = *listptr;
  58 FILE *data_file;
  59 uschar *dcc_default_ip_option = US"127.0.0.1";
  60 uschar *dcc_helo_option = US"localhost";
  61 uschar *xtra_hdrs = NULL;
  62 uschar *override_client_ip  = NULL;
  63
  64 /* from local_scan */
  65 int dcc_resplen, retval, sockfd, resp;
  66 unsigned int portnr;
  67 struct sockaddr_un  serv_addr;
  68 struct sockaddr_in  serv_addr_in;
  69 struct hostent *ipaddress;
  70 uschar sockpath[128];
  71 uschar sockip[40], client_ip[40];
  72 gstring *dcc_headers;
  73 gstring *sendbuf;
  74 uschar *dcc_return_text = US"''";
  75 struct header_line *mail_headers;
  76 uschar *dcc_acl_options;
  77 gstring *dcc_xtra_hdrs;
  78 gstring *dcc_header_str;
  79
  80 /* grep 1st option */
  81 if ((dcc_acl_options = string_nextinlist(&list, &sep, NULL, 0)))
  82   {
  83   /* parse 1st option */
  84   if (  strcmpic(dcc_acl_options, US"false") == 0
  85      || Ustrcmp(dcc_acl_options, "0") == 0)
  86     return FAIL;        /* explicitly no matching */
  87   }
  88 else
  89   return FAIL;  /* empty means "don't match anything" */
  90
  91 sep = 0;
  92
  93 /* if we scanned this message last time, just return */
  94 if (dcc_ok)
  95   return dcc_rc;
  96
  97 /* open the spooled body */
  98 for (int i = 0; i < 2; i++)
  99   {
 100   uschar message_subdir[2];
 101   set_subdir_str(message_subdir, message_id, i);
 102   if ((data_file = Ufopen(
 103           spool_fname(US"input", message_subdir, message_id, US"-D"), "rb")))
 104     break;
 105   }
 106
 107 if (!data_file)
 108   {
 109   /* error while spooling */
 110   log_write(0, LOG_MAIN|LOG_PANIC,
 111          "DCC: error while opening spool file");
 112   return DEFER;
 113   }
 114
 115 /* Initialize the variables */
 116
 117 bzero(sockip,sizeof(sockip));
 118 if (dccifd_address)
 119   {
 120   if (dccifd_address[0] == '/')
 121     Ustrncpy(sockpath, dccifd_address, sizeof(sockpath));
 122   else
 123     if( sscanf(CS dccifd_address, "%s %u", sockip, &portnr) != 2)
 124       {
 125       log_write(0, LOG_MAIN,
 126         "DCC: warning - invalid dccifd address: '%s'", dccifd_address);
 127       (void)fclose(data_file);
 128       return DEFER;
 129       }
 130   }
 131
 132 /* dcc_headers is what we send as dccifd options - see man dccifd */
 133 /* We don't support any other option than 'header' so just copy that */
 134 dcc_headers = string_cat(NULL, dccifd_options);
 135 /* if $acl_m_dcc_override_client_ip is set use it */
 136 if (((override_client_ip = expand_string(US"$acl_m_dcc_override_client_ip")) != NULL) &&
 137      (override_client_ip[0] != '\0'))
 138   {
 139   Ustrncpy(client_ip, override_client_ip, sizeof(client_ip)-1);
 140   DEBUG(D_acl)
 141     debug_printf("DCC: Client IP (overridden): %s\n", client_ip);
 142   }
 143 else if(sender_host_address)
 144   {
 145   /* else if $sender_host_address is available use that? */
 146   Ustrncpy(client_ip, sender_host_address, sizeof(client_ip)-1);
 147   DEBUG(D_acl)
 148     debug_printf("DCC: Client IP (sender_host_address): %s\n", client_ip);
 149   }
 150 else
 151   {
 152   /* sender_host_address is NULL which means it comes from localhost */
 153   Ustrncpy(client_ip, dcc_default_ip_option, sizeof(client_ip)-1);
 154   DEBUG(D_acl)
 155     debug_printf("DCC: Client IP (default): %s\n", client_ip);
 156   }
 157 /* build options block */
 158 dcc_headers = string_append(dcc_headers, 5, US"\n", client_ip, US"\nHELO ", dcc_helo_option, US"\n");
 159
 160 /* initialize the other variables */
 161 mail_headers = header_list;
 162 /* we set the default return value to DEFER */
 163 retval = DEFER;
 164
 165 /* send a null return path as "<>". */
 166 dcc_headers = string_cat (dcc_headers, *sender_address ? sender_address : US"<>");
 167 dcc_headers = string_catn(dcc_headers, US"\n", 1);
 168
 169 /**************************************
 170  * Now creating the socket connection *
 171  **************************************/
 172
 173 /* If sockip contains an ip, we use a tcp socket, otherwise a UNIX socket */
 174 if(Ustrcmp(sockip, ""))
 175   {
 176   ipaddress = gethostbyname(CS sockip);
 177   bzero(CS  &serv_addr_in, sizeof(serv_addr_in));
 178   serv_addr_in.sin_family = AF_INET;
 179   bcopy(CS ipaddress->h_addr, CS &serv_addr_in.sin_addr.s_addr, ipaddress->h_length);
 180   serv_addr_in.sin_port = htons(portnr);
 181   if ((sockfd = socket(AF_INET, SOCK_STREAM,0)) < 0)
 182     {
 183     DEBUG(D_acl)
 184       debug_printf("DCC: Creating TCP socket connection failed: %s\n", strerror(errno));
 185     log_write(0,LOG_PANIC,"DCC: Creating TCP socket connection failed: %s\n", strerror(errno));
 186     /* if we cannot create the socket, defer the mail */
 187     (void)fclose(data_file);
 188     return retval;
 189     }
 190   /* Now connecting the socket (INET) */
 191   if (connect(sockfd, (struct sockaddr *)&serv_addr_in, sizeof(serv_addr_in)) < 0)
 192     {
 193     DEBUG(D_acl)
 194       debug_printf("DCC: Connecting to TCP socket failed: %s\n", strerror(errno));
 195     log_write(0,LOG_PANIC,"DCC: Connecting to TCP socket failed: %s\n", strerror(errno));
 196     /* if we cannot contact the socket, defer the mail */
 197     (void)fclose(data_file);
 198     return retval;
 199     }
 200   }
 201 else
 202   {
 203   /* connecting to the dccifd UNIX socket */
 204   bzero(&serv_addr, sizeof(serv_addr));
 205   serv_addr.sun_family = AF_UNIX;
 206   Ustrncpy(US serv_addr.sun_path, sockpath, sizeof(serv_addr.sun_path));
 207   if ((sockfd = socket(AF_UNIX, SOCK_STREAM,0)) < 0)
 208     {
 209     DEBUG(D_acl)
 210       debug_printf("DCC: Creating UNIX socket connection failed: %s\n", strerror(errno));
 211     log_write(0,LOG_PANIC,"DCC: Creating UNIX socket connection failed: %s\n", strerror(errno));
 212     /* if we cannot create the socket, defer the mail */
 213     (void)fclose(data_file);
 214     return retval;
 215     }
 216   /* Now connecting the socket (UNIX) */
 217   if (connect(sockfd, (struct sockaddr *) &serv_addr, sizeof(serv_addr)) < 0)
 218     {
 219     DEBUG(D_acl)
 220       debug_printf("DCC: Connecting to UNIX socket failed: %s\n", strerror(errno));
 221     log_write(0,LOG_PANIC,"DCC: Connecting to UNIX socket failed: %s\n", strerror(errno));
 222     /* if we cannot contact the socket, defer the mail */
 223     (void)fclose(data_file);
 224     return retval;
 225     }
 226   }
 227 /* the socket is open, now send the options to dccifd*/
 228 DEBUG(D_acl)
 229   debug_printf("DCC: -----------------------------------\nDCC: Socket opened; now sending input\n"
 230                "DCC: -----------------------------------\n");
 231
 232 /* let's send each of the recipients to dccifd */
 233 for (int i = 0; i < recipients_count; i++)
 234   {
 235   DEBUG(D_acl)
 236     debug_printf("DCC: recipient = %s\n",recipients_list[i].address);
 237   dcc_headers = string_append(dcc_headers, 2, recipients_list[i].address, "\n");
 238   }
 239 /* send a blank line between options and message */
 240 dcc_headers = string_catn(dcc_headers, US"\n", 1);
 241
 242 /* Now we send the input buffer */
 243 DEBUG(D_acl)
 244   debug_printf("DCC: ***********************************\nDCC: Sending options:\n%Y"
 245                "DCC: ***********************************\n", dcc_headers);
 246 if (flushbuffer(sockfd, dcc_headers) != 0)
 247   {
 248   (void)fclose(data_file);
 249   return retval;
 250   }
 251
 252 /* now send the message */
 253 /* First send the headers */
 254 DEBUG(D_acl)
 255   debug_printf("DCC: ***********************************\nDCC: Sending headers:\n");
 256 sendbuf = string_get(8192);
 257 sendbuf = string_catn(sendbuf, mail_headers->text, mail_headers->slen);
 258 while((mail_headers=mail_headers->next))
 259   sendbuf = string_catn(sendbuf, mail_headers->text, mail_headers->slen);
 260
 261 /* a blank line separates header from body */
 262 sendbuf = string_catn(sendbuf, US"\r\n", 2);
 263 gstring_release_unused(sendbuf);
 264 DEBUG(D_acl)
 265   debug_printf("%YDCC: ***********************************\n", sendbuf);
 266 if (flushbuffer(sockfd, sendbuf) != 0)
 267   {
 268   (void)fclose(data_file);
 269   return retval;
 270   }
 271
 272 /* now send the body */
 273 DEBUG(D_acl)
 274   debug_printf("DCC: ***********************************\nDCC: Writing body:\n");
 275 (void)fseek(data_file, spool_data_start_offset(message_id), SEEK_SET);
 276
 277 gstring filebuf = { .size = big_buffer_size, .ptr = 0, .s = big_buffer };
 278
 279 while((filebuf.ptr = fread(filebuf.s, 1, filebuf.size, data_file)) > 0)
 280   if (flushbuffer(sockfd, &filebuf) != 0)
 281     {
 282     (void)fclose(data_file);
 283     return retval;
 284     }
 285 DEBUG(D_acl)
 286   debug_printf("DCC: ***********************************\n");
 287
 288 /* shutdown() the socket */
 289 if(shutdown(sockfd, SHUT_WR) < 0)
 290   {
 291   DEBUG(D_acl)
 292     debug_printf("DCC: Couldn't shutdown socket: %s\n", strerror(errno));
 293   log_write(0,LOG_MAIN,"DCC: Couldn't shutdown socket: %s\n", strerror(errno));
 294   /* If there is a problem with the shutdown()
 295    * defer the mail. */
 296   (void)fclose(data_file);
 297   return retval;
 298   }
 299 DEBUG(D_acl)
 300   debug_printf("DCC: Input sent.\n"
 301                "DCC: +++++++++++++++++++++++++++++++++++\n"
 302                "DCC: Now receiving output from server\n"
 303                "DCC: -----------------------------------\n");
 304
 305 /********************************
 306  * receiving output from dccifd *
 307  ********************************/
 308
 309 /******************************************************************
 310  * We should get 3 lines:                                         *
 311  * 1/ First line is overall result: either 'A' for Accept,        *
 312  *    'R' for Reject, 'S' for accept Some recipients or           *
 313  *    'T' for a Temporary error.                                  *
 314  * 2/ Second line contains the list of Accepted/Rejected          *
 315  *    recipients in the form AARRA (A = accepted, R = rejected).  *
 316  * 3/ Third line contains the X-DCC header.                       *
 317  ******************************************************************/
 318
 319 int line = 1;    /* we start at the first line of the output */
 320 int bufoffset;
 321
 322 dcc_header_str = string_get(DCC_HEADER_LIMIT + 2);
 323 /* Let's read from the socket until there's nothing left to read */
 324 while((dcc_resplen = read(sockfd, big_buffer, big_buffer_size-1)) > 0)
 325   {
 326   /* fail on read error */
 327   if(dcc_resplen < 0)
 328     {
 329     DEBUG(D_acl)
 330       debug_printf("DCC: Error reading from socket: %s\n", strerror(errno));
 331     (void)fclose(data_file);
 332     return retval;
 333     }
 334   /* make the answer 0-terminated. only needed for debug_printf */
 335   DEBUG(D_acl)
 336     debug_printf("DCC: Length of the output buffer is: %d\nDCC: Output buffer is:\n"
 337                  "DCC: -----------------------------------\n%.*s\n"
 338                  "DCC: -----------------------------------\n", dcc_resplen, dcc_resplen, big_buffer);
 339
 340   /* Now let's read each character and see what we've got */
 341   for(bufoffset = 0; bufoffset < dcc_resplen && line <= 2; bufoffset++)
 342     {
 343     /* First check if we reached the end of the line and
 344     then increment the line counter */
 345     if(big_buffer[bufoffset] == '\n')
 346       line++;
 347     else
 348       {
 349       /* The first character of the first line is the overall response. If
 350       there's another character on that line it is not correct. */
 351       if(line == 1)
 352         {
 353         if(bufoffset == 0)
 354           {
 355           /* Now get the value and set the return value accordingly */
 356           switch (big_buffer[bufoffset])
 357             {
 358             case 'A':
 359               DEBUG(D_acl)
 360                 debug_printf("DCC: Overall result = A\treturning OK\n");
 361               dcc_return_text = US"Mail accepted by DCC";
 362               dcc_result = US"A";
 363               retval = OK;
 364               break;
 365             case 'R':
 366               DEBUG(D_acl)
 367                 debug_printf("DCC: Overall result = R\treturning FAIL\n");
 368               dcc_return_text = US"Rejected by DCC";
 369               dcc_result = US"R";
 370               retval = FAIL;
 371               if(sender_host_name)
 372                 log_write(0, LOG_MAIN, "H=%s [%s] F=<%s>: rejected by DCC",
 373                            sender_host_name, sender_host_address, sender_address);
 374               else
 375                 log_write(0, LOG_MAIN, "H=[%s] F=<%s>: rejected by DCC",
 376                            sender_host_address, sender_address);
 377               break;
 378             case 'S':
 379               DEBUG(D_acl)
 380                 debug_printf("DCC: Overall result  = S\treturning OK\n");
 381               dcc_return_text = US"Not all recipients accepted by DCC";
 382               /* Since we're in an ACL we want a global result so we accept for all */
 383               dcc_result = US"A";
 384               retval = OK;
 385               break;
 386             case 'G':
 387               DEBUG(D_acl)
 388                 debug_printf("DCC: Overall result  = G\treturning FAIL\n");
 389               dcc_return_text = US"Greylisted by DCC";
 390               dcc_result = US"G";
 391               retval = FAIL;
 392               break;
 393             case 'T':
 394               DEBUG(D_acl)
 395                 debug_printf("DCC: Overall result = T\treturning DEFER\n");
 396               dcc_return_text = US"Temporary error with DCC";
 397               dcc_result = US"T";
 398               retval = DEFER;
 399               log_write(0,LOG_MAIN,"Temporary error with DCC: %s\n", big_buffer);
 400               break;
 401             default:
 402               DEBUG(D_acl)
 403                 debug_printf("DCC: Overall result = something else\treturning DEFER\n");
 404               dcc_return_text = US"Unknown DCC response";
 405               dcc_result = US"T";
 406               retval = DEFER;
 407               log_write(0,LOG_MAIN,"Unknown DCC response: %s\n", big_buffer);
 408               break;
 409             }
 410         }
 411         else
 412           {
 413           /* We're on the first line but not on the first character,
 414            * there must be something wrong. */
 415           DEBUG(D_acl) debug_printf("DCC: Line = %d but bufoffset = %d != 0"
 416               "  character is %c - This is wrong!\n", line, bufoffset, big_buffer[bufoffset]);
 417           log_write(0,LOG_MAIN,"Wrong header from DCC, output is %s\n", big_buffer);
 418           }
 419         }
 420       else if(line == 2)
 421         {
 422         /* On the second line we get a list of answers for each recipient. We
 423         don't care about it because we're in an acl and take the global result. */
 424         }
 425       }
 426     }
 427   if(line > 2)
 428     {
 429     /* The third and following lines are the X-DCC header, so we store it in
 430     dcc_header_str up to our limit. */
 431     /* check if buffer contains the end of the header .."\n\n" and truncate it */
 432     if ((big_buffer[dcc_resplen-1] == '\n') &&
 433         (big_buffer[dcc_resplen-2] == '\n'))
 434       dcc_resplen -= 2;
 435     dcc_resplen -= bufoffset;
 436     if (dcc_header_str->ptr + dcc_resplen > DCC_HEADER_LIMIT)
 437       {
 438       dcc_resplen = DCC_HEADER_LIMIT - dcc_header_str->ptr;
 439       DEBUG(D_acl) debug_printf("DCC: We got more output than we can store"
 440                          "in the X-DCC header. Truncating at 120 characters.\n");
 441       }
 442     dcc_header_str = string_catn(dcc_header_str, &big_buffer[bufoffset], dcc_resplen);
 443     }
 444   }
 445 /* We have read everything from the socket. make sure the header ends with "\n" */
 446 dcc_header_str = string_catn(dcc_header_str, US"\n", 1);
 447
 448 (void) string_from_gstring(dcc_header_str);
 449 /* Now let's sum up what we've got. */
 450 DEBUG(D_acl)
 451   debug_printf("\nDCC: --------------------------\nDCC: Overall result = %d\n"
 452                "DCC: X-DCC header: %YReturn message: %s\nDCC: dcc_result: %s\n",
 453                  retval, dcc_header_str, dcc_return_text, dcc_result);
 454
 455 /* We only add the X-DCC header if it starts with X-DCC */
 456 if(!(Ustrncmp(dcc_header_str->s, "X-DCC", 5)))
 457   {
 458   dcc_header = string_from_gstring(dcc_header_str);
 459   if(dcc_direct_add_header)
 460     {
 461     header_add(' ' , "%s", dcc_header);
 462 /* since the MIME ACL already writes the .eml file to disk without DCC Header we've to erase it */
 463     unspool_mbox();
 464     }
 465   }
 466 else
 467   DEBUG(D_acl)
 468     debug_printf("DCC: Wrong format of the X-DCC header: %Y\n", dcc_header_str);
 469
 470 /* check if we should add additional headers passed in acl_m_dcc_add_header */
 471 if (dcc_direct_add_header)
 472   {
 473   if (((xtra_hdrs = expand_string(US"$acl_m_dcc_add_header")) != NULL) && (xtra_hdrs[0] != '\0'))
 474     {
 475     dcc_xtra_hdrs = string_cat(NULL, xtra_hdrs);
 476     if (dcc_xtra_hdrs->s[dcc_xtra_hdrs->ptr - 1] != '\n')
 477       dcc_xtra_hdrs = string_catn(dcc_xtra_hdrs, US"\n", 1);
 478     header_add(' ', "%s", string_from_gstring(dcc_xtra_hdrs));
 479     DEBUG(D_acl)
 480       debug_printf("DCC: adding additional headers in $acl_m_dcc_add_header: %Y", dcc_xtra_hdrs);
 481     }
 482   }
 483
 484 dcc_ok = 1;
 485 /* Now return to exim main process */
 486 DEBUG(D_acl)
 487   debug_printf("DCC: Before returning to exim main process:\nDCC: return_text = %s - retval = %d\n"
 488                "DCC: dcc_result = %s\n", dcc_return_text, retval, dcc_result);
 489
 490 (void)fclose(data_file);
 491 dcc_rc = retval;
 492 return dcc_rc;
 493 }
 494
 495 #endif