src/src/spool_out.c

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