src/src/spool_out.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2018 */
   6 /* Copyright (c) The Exim Maintainers 2020 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8
   9 /* Functions for writing spool files, and moving them about. */
  10
  11
  12 #include "exim.h"
  13
  14
  15
  16 /*************************************************
  17 *       Deal with header writing errors          *
  18 *************************************************/
  19
  20 /* This function is called immediately after errors in writing the spool, with
  21 errno still set. It creates an error message, depending on the circumstances.
  22 If errmsg is NULL, it logs the message and panic-dies. Otherwise errmsg is set
  23 to point to the message, and -1 is returned. This function makes the code of
  24 spool_write_header() a bit neater.
  25
  26 Arguments:
  27    where      SW_RECEIVING, SW_DELIVERING, or SW_MODIFYING
  28    errmsg     where to put the message; NULL => panic-die
  29    s          text to add to log string
  30    temp_name  name of temp file to unlink
  31    f          FILE to close, if not NULL
  32
  33 Returns:      -1 if errmsg is not NULL; otherwise doesn't return
  34 */
  35
  36 static int
  37 spool_write_error(int where, uschar **errmsg, uschar *s, uschar *temp_name,
  38   FILE *f)
  39 {
  40 uschar *msg = where == SW_RECEIVING
  41   ? string_sprintf("spool file %s error while receiving from %s: %s", s,
  42       sender_fullhost ? sender_fullhost : sender_ident,
  43       strerror(errno))
  44   : string_sprintf("spool file %s error while %s: %s", s,
  45       where == SW_DELIVERING ? "delivering" : "modifying",
  46       strerror(errno));
  47
  48 if (temp_name) Uunlink(temp_name);
  49 if (f) (void)fclose(f);
  50
  51 if (errmsg)
  52   *errmsg = msg;
  53 else
  54   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", msg);
  55
  56 return -1;
  57 }
  58
  59
  60
  61 /*************************************************
  62 *            Open file under temporary name      *
  63 *************************************************/
  64
  65 /* This is used for opening spool files under a temporary name,
  66 with a single attempt at deleting if they already exist.
  67
  68 Argument: temporary name for spool header file
  69 Returns:  file descriptor of open file, or < 0 on failure, with errno unchanged
  70 */
  71
  72 int
  73 spool_open_temp(uschar *temp_name)
  74 {
  75 int fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
  76
  77 /* If the file already exists, something has gone wrong. This process may well
  78 have previously created the file if it is delivering more than one address, but
  79 it should have renamed it almost immediately. A file could, however, be left
  80 around as a result of a system crash, and by coincidence this process might
  81 have the same pid. We therefore have one go at unlinking it before giving up.
  82 */
  83
  84 if (fd < 0 && errno == EEXIST)
  85   {
  86   DEBUG(D_any) debug_printf("%s exists: unlinking\n", temp_name);
  87   Uunlink(temp_name);
  88   fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
  89   }
  90
  91 /* If the file has been opened, make sure the file's group is the Exim gid, and
  92 double-check the mode because the group setting doesn't always get set
  93 automatically. */
  94
  95 if (fd >= 0)
  96   if (exim_fchown(fd, exim_uid, exim_gid, temp_name) || fchmod(fd, SPOOL_MODE))
  97     {
  98     DEBUG(D_any) debug_printf("failed setting perms on %s\n", temp_name);
  99     (void) close(fd); fd = -1;
 100     Uunlink(temp_name);
 101     }
 102
 103 return fd;
 104 }
 105
 106
 107
 108 static const uschar *
 109 zap_newlines(const uschar *s)
 110 {
 111 uschar *z, *p;
 112
 113 if (Ustrchr(s, '\n') == NULL) return s;
 114
 115 p = z = string_copy(s);
 116 while ((p = Ustrchr(p, '\n')) != NULL) *p++ = ' ';
 117 return z;
 118 }
 119
 120 static void
 121 spool_var_write(FILE * fp, const uschar * name, const uschar * val)
 122 {
 123 if (is_tainted(val)) putc('-', fp);
 124 fprintf(fp, "-%s %s\n", name, val);
 125 }
 126
 127 /*************************************************
 128 *          Write the header spool file           *
 129 *************************************************/
 130
 131 /* Returns the size of the file for success; zero for failure. The file is
 132 written under a temporary name, and then renamed. It's done this way so that it
 133 works with re-writing the file on message deferral as well as for the initial
 134 write. Whenever this function is called, the data file for the message should
 135 be open and locked, thus preventing any other exim process from working on this
 136 message.
 137
 138 Argument:
 139   id      the message id
 140   where   SW_RECEIVING, SW_DELIVERING, or SW_MODIFYING
 141   errmsg  where to put an error message; if NULL, panic-die on error
 142
 143 Returns:  the size of the header texts on success;
 144           negative on writing failure, unless errmsg == NULL
 145 */
 146
 147 int
 148 spool_write_header(uschar *id, int where, uschar **errmsg)
 149 {
 150 int fd;
 151 int size_correction;
 152 FILE * fp;
 153 struct stat statbuf;
 154 uschar * tname;
 155 uschar * fname;
 156
 157 tname = spool_fname(US"input", message_subdir, US"hdr.", message_id);
 158
 159 if ((fd = spool_open_temp(tname)) < 0)
 160   return spool_write_error(where, errmsg, US"open", NULL, NULL);
 161 fp = fdopen(fd, "wb");
 162 DEBUG(D_receive|D_deliver) debug_printf("Writing spool header file: %s\n", tname);
 163
 164 /* We now have an open file to which the header data is to be written. Start
 165 with the file's leaf name, to make the file self-identifying. Continue with the
 166 identity of the submitting user, followed by the sender's address. The sender's
 167 address is enclosed in <> because it might be the null address. Then write the
 168 received time and the number of warning messages that have been sent. */
 169
 170 fprintf(fp, "%s-H\n", message_id);
 171 fprintf(fp, "%.63s %ld %ld\n", originator_login, (long int)originator_uid,
 172   (long int)originator_gid);
 173 fprintf(fp, "<%s>\n", sender_address);
 174 fprintf(fp, "%d %d\n", (int)received_time.tv_sec, warning_count);
 175
 176 fprintf(fp, "-received_time_usec .%06d\n", (int)received_time.tv_usec);
 177
 178 /* If there is information about a sending host, remember it. The HELO
 179 data can be set for local SMTP as well as remote. */
 180
 181 if (sender_helo_name) spool_var_write(fp, US"helo_name", sender_helo_name);
 182
 183 if (sender_host_address)
 184   {
 185   if (is_tainted(sender_host_address)) putc('-', fp);
 186   fprintf(fp, "-host_address %s.%d\n", sender_host_address, sender_host_port);
 187   if (sender_host_name)
 188     spool_var_write(fp, US"host_name", sender_host_name);
 189   }
 190 if (sender_host_authenticated)
 191   spool_var_write(fp, US"host_auth", sender_host_authenticated);
 192 if (sender_host_auth_pubname)
 193   spool_var_write(fp, US"host_auth_pubname", sender_host_auth_pubname);
 194
 195 /* Also about the interface a message came in on */
 196
 197 if (interface_address)
 198   {
 199   if (is_tainted(interface_address)) putc('-', fp);
 200   fprintf(fp, "-interface_address %s.%d\n", interface_address, interface_port);
 201   }
 202
 203 if (smtp_active_hostname != primary_hostname)
 204   spool_var_write(fp, US"active_hostname", smtp_active_hostname);
 205
 206 /* Likewise for any ident information; for local messages this is
 207 likely to be the same as originator_login, but will be different if
 208 the originator was root, forcing a different ident. */
 209
 210 if (sender_ident)
 211   spool_var_write(fp, US"ident", sender_ident);
 212
 213 /* Ditto for the received protocol */
 214
 215 if (received_protocol)
 216   spool_var_write(fp, US"received_protocol", received_protocol);
 217
 218 /* Preserve any ACL variables that are set. */
 219
 220 tree_walk(acl_var_c, &acl_var_write, fp);
 221 tree_walk(acl_var_m, &acl_var_write, fp);
 222
 223 /* Now any other data that needs to be remembered. */
 224
 225 if (f.spool_file_wireformat)
 226   fprintf(fp, "-spool_file_wireformat\n");
 227 else
 228   fprintf(fp, "-body_linecount %d\n", body_linecount);
 229 fprintf(fp, "-max_received_linelength %d\n", max_received_linelength);
 230
 231 if (body_zerocount > 0) fprintf(fp, "-body_zerocount %d\n", body_zerocount);
 232
 233 if (authenticated_id)
 234   spool_var_write(fp, US"auth_id", authenticated_id);
 235 if (authenticated_sender)
 236   spool_var_write(fp, US"auth_sender", zap_newlines(authenticated_sender));
 237
 238 if (f.allow_unqualified_recipient) fprintf(fp, "-allow_unqualified_recipient\n");
 239 if (f.allow_unqualified_sender) fprintf(fp, "-allow_unqualified_sender\n");
 240 if (f.deliver_firsttime) fprintf(fp, "-deliver_firsttime\n");
 241 if (f.deliver_freeze) fprintf(fp, "-frozen " TIME_T_FMT "\n", deliver_frozen_at);
 242 if (f.dont_deliver) fprintf(fp, "-N\n");
 243 if (host_lookup_deferred) fprintf(fp, "-host_lookup_deferred\n");
 244 if (host_lookup_failed) fprintf(fp, "-host_lookup_failed\n");
 245 if (f.sender_local) fprintf(fp, "-local\n");
 246 if (f.local_error_message) fprintf(fp, "-localerror\n");
 247 #ifdef HAVE_LOCAL_SCAN
 248 if (local_scan_data) spool_var_write(fp, US"local_scan", local_scan_data);
 249 #endif
 250 #ifdef WITH_CONTENT_SCAN
 251 if (spam_bar)       spool_var_write(fp, US"spam_bar",       spam_bar);
 252 if (spam_score)     spool_var_write(fp, US"spam_score",     spam_score);
 253 if (spam_score_int) spool_var_write(fp, US"spam_score_int", spam_score_int);
 254 #endif
 255 if (f.deliver_manual_thaw) fprintf(fp, "-manual_thaw\n");
 256 if (f.sender_set_untrusted) fprintf(fp, "-sender_set_untrusted\n");
 257
 258 #ifdef EXPERIMENTAL_BRIGHTMAIL
 259 if (bmi_verdicts) spool_var_write(fp, US"bmi_verdicts", bmi_verdicts);
 260 #endif
 261
 262 #ifndef DISABLE_TLS
 263 if (tls_in.certificate_verified) fprintf(fp, "-tls_certificate_verified\n");
 264 if (tls_in.cipher) spool_var_write(fp, US"tls_cipher", tls_in.cipher);
 265 if (tls_in.peercert)
 266   {
 267   if (tls_export_cert(big_buffer, big_buffer_size, tls_in.peercert))
 268     fprintf(fp, "--tls_peercert %s\n", CS big_buffer);
 269   }
 270 if (tls_in.peerdn)       spool_var_write(fp, US"tls_peerdn", string_printing(tls_in.peerdn));
 271 if (tls_in.sni)          spool_var_write(fp, US"tls_sni",    string_printing(tls_in.sni));
 272 if (tls_in.ourcert)
 273   {
 274   if (tls_export_cert(big_buffer, big_buffer_size, tls_in.ourcert))
 275     fprintf(fp, "-tls_ourcert %s\n", CS big_buffer);
 276   }
 277 if (tls_in.ocsp)         fprintf(fp, "-tls_ocsp %d\n",   tls_in.ocsp);
 278 # ifdef EXPERIMENTAL_TLS_RESUME
 279 fprintf(fp, "-tls_resumption %c\n", 'A' + tls_in.resumption);
 280 # endif
 281 if (tls_in.ver) spool_var_write(fp, US"tls_ver", tls_in.ver);
 282 #endif
 283
 284 #ifdef SUPPORT_I18N
 285 if (message_smtputf8)
 286   {
 287   fprintf(fp, "-smtputf8\n");
 288   if (message_utf8_downconvert)
 289     fprintf(fp, "-utf8_%sdowncvt\n", message_utf8_downconvert < 0 ? "opt" : "");
 290   }
 291 #endif
 292
 293 /* Write the dsn flags to the spool header file */
 294 /* DEBUG(D_deliver) debug_printf("DSN: Write SPOOL: -dsn_envid %s\n", dsn_envid); */
 295 if (dsn_envid) fprintf(fp, "-dsn_envid %s\n", dsn_envid);
 296 /* DEBUG(D_deliver) debug_printf("DSN: Write SPOOL: -dsn_ret %d\n", dsn_ret); */
 297 if (dsn_ret) fprintf(fp, "-dsn_ret %d\n", dsn_ret);
 298
 299 /* To complete the envelope, write out the tree of non-recipients, followed by
 300 the list of recipients. These won't be disjoint the first time, when no
 301 checking has been done. If a recipient is a "one-time" alias, it is followed by
 302 a space and its parent address number (pno). */
 303
 304 tree_write(tree_nonrecipients, fp);
 305 fprintf(fp, "%d\n", recipients_count);
 306 for (int i = 0; i < recipients_count; i++)
 307   {
 308   recipient_item *r = recipients_list + i;
 309   const uschar *address = zap_newlines(r->address);
 310
 311   /* DEBUG(D_deliver) debug_printf("DSN: Flags: 0x%x\n", r->dsn_flags); */
 312
 313   if (r->pno < 0 && !r->errors_to && r->dsn_flags == 0)
 314     fprintf(fp, "%s\n", address);
 315   else
 316     {
 317     const uschar *errors_to = r->errors_to ? zap_newlines(r->errors_to) : CUS"";
 318     /* for DSN SUPPORT extend exim 4 spool in a compatible way by
 319     adding new values upfront and add flag 0x02 */
 320     const uschar *orcpt = r->orcpt ? zap_newlines(r->orcpt) : CUS"";
 321
 322     fprintf(fp, "%s %s %d,%d %s %d,%d#3\n", address, orcpt, Ustrlen(orcpt),
 323       r->dsn_flags, errors_to, Ustrlen(errors_to), r->pno);
 324     }
 325
 326     DEBUG(D_deliver) debug_printf("DSN: **** SPOOL_OUT - "
 327       "address: <%s> errorsto: <%s> orcpt: <%s> dsn_flags: 0x%x\n",
 328       r->address, r->errors_to, r->orcpt, r->dsn_flags);
 329   }
 330
 331 /* Put a blank line before the headers */
 332
 333 fprintf(fp, "\n");
 334
 335 /* Save the size of the file so far so we can subtract it from the final length
 336 to get the actual size of the headers. */
 337
 338 fflush(fp);
 339 if (fstat(fd, &statbuf))
 340   return spool_write_error(where, errmsg, US"fstat", tname, fp);
 341 size_correction = statbuf.st_size;
 342
 343 /* Finally, write out the message's headers. To make it easier to read them
 344 in again, precede each one with the count of its length. Make the count fixed
 345 length to aid human eyes when debugging and arrange for it not be included in
 346 the size. It is followed by a space for normal headers, a flagging letter for
 347 various other headers, or an asterisk for old headers that have been rewritten.
 348 These are saved as a record for debugging. Don't included them in the message's
 349 size. */
 350
 351 for (header_line * h = header_list; h; h = h->next)
 352   {
 353   fprintf(fp, "%03d%c %s", h->slen, h->type, h->text);
 354   size_correction += 5;
 355   if (h->type == '*') size_correction += h->slen;
 356   }
 357
 358 /* Flush and check for any errors while writing */
 359
 360 if (fflush(fp) != 0 || ferror(fp))
 361   return spool_write_error(where, errmsg, US"write", tname, fp);
 362
 363 /* Force the file's contents to be written to disk. Note that fflush()
 364 just pushes it out of C, and fclose() doesn't guarantee to do the write
 365 either. That's just the way Unix works... */
 366
 367 if (EXIMfsync(fileno(fp)) < 0)
 368   return spool_write_error(where, errmsg, US"sync", tname, fp);
 369
 370 /* Get the size of the file, and close it. */
 371
 372 if (fstat(fd, &statbuf) != 0)
 373   return spool_write_error(where, errmsg, US"fstat", tname, NULL);
 374 if (fclose(fp) != 0)
 375   return spool_write_error(where, errmsg, US"close", tname, NULL);
 376
 377 /* Rename the file to its correct name, thereby replacing any previous
 378 incarnation. */
 379
 380 fname = spool_fname(US"input", message_subdir, id, US"-H");
 381 DEBUG(D_receive|D_deliver) debug_printf("Renaming spool header file: %s\n", fname);
 382
 383 if (Urename(tname, fname) < 0)
 384   return spool_write_error(where, errmsg, US"rename", tname, NULL);
 385
 386 /* Linux (and maybe other OS?) does not automatically sync a directory after
 387 an operation like rename. We therefore have to do it forcibly ourselves in
 388 these cases, to make sure the file is actually accessible on disk, as opposed
 389 to just the data being accessible from a file in lost+found. Linux also has
 390 O_DIRECTORY, for opening a directory.
 391
 392 However, it turns out that some file systems (some versions of NFS?) do not
 393 support directory syncing. It seems safe enough to ignore EINVAL to cope with
 394 these cases. One hack on top of another... but that's life. */
 395
 396 #ifdef NEED_SYNC_DIRECTORY
 397
 398 tname = spool_fname(US"input", message_subdir, US".", US"");
 399
 400 # ifndef O_DIRECTORY
 401 #  define O_DIRECTORY 0
 402 # endif
 403
 404 if ((fd = Uopen(tname, O_RDONLY|O_DIRECTORY, 0)) < 0)
 405   return spool_write_error(where, errmsg, US"directory open", fname, NULL);
 406
 407 if (EXIMfsync(fd) < 0 && errno != EINVAL)
 408   return spool_write_error(where, errmsg, US"directory sync", fname, NULL);
 409
 410 if (close(fd) < 0)
 411   return spool_write_error(where, errmsg, US"directory close", fname, NULL);
 412
 413 #endif  /* NEED_SYNC_DIRECTORY */
 414
 415 /* Return the number of characters in the headers, which is the file size, less
 416 the preliminary stuff, less the additional count fields on the headers. */
 417
 418 DEBUG(D_receive) debug_printf("Size of headers = %d\n",
 419   (int)(statbuf.st_size - size_correction));
 420
 421 return statbuf.st_size - size_correction;
 422 }
 423
 424
 425 /************************************************
 426 *              Make a hard link                 *
 427 ************************************************/
 428
 429 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
 430 of spool_directory is checked to ensure that it is less than 200 characters at
 431 start-up time.
 432
 433 Arguments:
 434   dir        base directory name
 435   dq         destiinationqueue name
 436   subdir     subdirectory name
 437   id         message id
 438   suffix     suffix to add to id
 439   from       source directory prefix
 440   to         destination directory prefix
 441   noentok    if TRUE, absence of file is not an error
 442
 443 Returns:     TRUE if all went well
 444              FALSE, having panic logged if not
 445 */
 446
 447 static BOOL
 448 make_link(uschar *dir, uschar * dq, uschar *subdir, uschar *id, uschar *suffix,
 449   uschar *from, uschar *to, BOOL noentok)
 450 {
 451 uschar * fname = spool_fname(string_sprintf("%s%s", from, dir), subdir, id, suffix);
 452 uschar * tname = spool_q_fname(string_sprintf("%s%s", to,   dir), dq, subdir, id, suffix);
 453 if (Ulink(fname, tname) < 0 && (!noentok || errno != ENOENT))
 454   {
 455   log_write(0, LOG_MAIN|LOG_PANIC, "link(\"%s\", \"%s\") failed while moving "
 456     "message: %s", fname, tname, strerror(errno));
 457   return FALSE;
 458   }
 459 return TRUE;
 460 }
 461
 462
 463
 464 /************************************************
 465 *                Break a link                   *
 466 ************************************************/
 467
 468 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
 469 of spool_directory is checked to ensure that it is less than 200 characters at
 470 start-up time.
 471
 472 Arguments:
 473   dir        base directory name
 474   subdir     subdirectory name
 475   id         message id
 476   suffix     suffix to add to id
 477   from       source directory prefix
 478   noentok    if TRUE, absence of file is not an error
 479
 480 Returns:     TRUE if all went well
 481              FALSE, having panic logged if not
 482 */
 483
 484 static BOOL
 485 break_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
 486   BOOL noentok)
 487 {
 488 uschar * fname = spool_fname(string_sprintf("%s%s", from, dir), subdir, id, suffix);
 489 if (Uunlink(fname) < 0 && (!noentok || errno != ENOENT))
 490   {
 491   log_write(0, LOG_MAIN|LOG_PANIC, "unlink(\"%s\") failed while moving "
 492     "message: %s", fname, strerror(errno));
 493   return FALSE;
 494   }
 495 return TRUE;
 496 }
 497
 498
 499
 500 /************************************************
 501 *            Move message files                 *
 502 ************************************************/
 503
 504 /* Move the files for a message (-H, -D, and msglog) from one directory (or
 505 hierarchy) to another. It is assume that there is no -J file in existence when
 506 this is done.
 507
 508 Arguments:
 509   id          the id of the message to be delivered
 510   subdir      the subdirectory name, or an empty string
 511   from        a prefix for "input" or "msglog" for where the message is now
 512   to          a prefix for "input" or "msglog" for where the message is to go
 513
 514 Returns:      TRUE if all is well
 515               FALSE if not, with error logged in panic and main logs
 516 */
 517
 518 BOOL
 519 spool_move_message(uschar *id, uschar *subdir, uschar *from, uschar *to)
 520 {
 521 uschar * dest_qname = queue_name_dest ? queue_name_dest : queue_name;
 522
 523 /* Create any output directories that do not exist. */
 524
 525 (void) directory_make(spool_directory,
 526   spool_q_sname(string_sprintf("%sinput", to), dest_qname, subdir),
 527   INPUT_DIRECTORY_MODE, TRUE);
 528 (void) directory_make(spool_directory,
 529   spool_q_sname(string_sprintf("%smsglog", to), dest_qname, subdir),
 530   INPUT_DIRECTORY_MODE, TRUE);
 531
 532 /* Move the message by first creating new hard links for all the files, and
 533 then removing the old links. When moving messages onto the main spool, the -H
 534 file should be set up last, because that's the one that tells Exim there is a
 535 message to be delivered, so we create its new link last and remove its old link
 536 first. Programs that look at the alternate directories should follow the same
 537 rule of waiting for a -H file before doing anything. When moving messages off
 538 the mail spool, the -D file should be open and locked at the time, thus keeping
 539 Exim's hands off. */
 540
 541 if (!make_link(US"msglog", dest_qname, subdir, id, US"", from, to, TRUE) ||
 542     !make_link(US"input",  dest_qname, subdir, id, US"-D", from, to, FALSE) ||
 543     !make_link(US"input",  dest_qname, subdir, id, US"-H", from, to, FALSE))
 544   return FALSE;
 545
 546 if (!break_link(US"input",  subdir, id, US"-H", from, FALSE) ||
 547     !break_link(US"input",  subdir, id, US"-D", from, FALSE) ||
 548     !break_link(US"msglog", subdir, id, US"", from, TRUE))
 549   return FALSE;
 550
 551 log_write(0, LOG_MAIN, "moved from %s%s%s%sinput, %smsglog to %s%s%s%sinput, %smsglog",
 552    *queue_name?"(":"", *queue_name?queue_name:US"", *queue_name?") ":"",
 553    from, from,
 554    *dest_qname?"(":"", *dest_qname?dest_qname:US"", *dest_qname?") ":"",
 555    to, to);
 556
 557 return TRUE;
 558 }
 559
 560
 561 /* End of spool_out.c */
 562 /* vi: aw ai sw=2
 563 */