1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for writing spool files, and moving them about. */
15 /*************************************************
16 * Deal with header writing errors *
17 *************************************************/
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.
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
32 Returns: -1 if errmsg is not NULL; otherwise doesn't return
36 spool_write_error(int where, uschar **errmsg, uschar *s, uschar *temp_name,
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,
43 : string_sprintf("spool file %s error while %s: %s", s,
44 where == SW_DELIVERING ? "delivering" : "modifying",
47 if (temp_name) Uunlink(temp_name);
48 if (f) (void)fclose(f);
53 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", msg);
60 /*************************************************
61 * Open file under temporary name *
62 *************************************************/
64 /* This is used for opening spool files under a temporary name,
65 with a single attempt at deleting if they already exist.
67 Argument: temporary name for spool header file
68 Returns: file descriptor of open file, or < 0 on failure, with errno unchanged
72 spool_open_temp(uschar *temp_name)
74 int fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
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.
83 if (fd < 0 && errno == EEXIST)
85 DEBUG(D_any) debug_printf("%s exists: unlinking\n", temp_name);
87 fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
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
95 if (fchown(fd, exim_uid, exim_gid) || fchmod(fd, SPOOL_MODE))
97 DEBUG(D_any) debug_printf("failed setting perms on %s\n", temp_name);
98 (void) close(fd); fd = -1;
107 /*************************************************
108 * Write the header spool file *
109 *************************************************/
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
120 where SW_RECEIVING, SW_DELIVERING, or SW_MODIFYING
121 errmsg where to put an error message; if NULL, panic-die on error
123 Returns: the size of the header texts on success;
124 negative on writing failure, unless errmsg == NULL
128 spool_write_header(uschar *id, int where, uschar **errmsg)
137 tname = spool_fname(US"input", message_subdir,
138 string_sprintf("hdr.%d", (int)getpid()), US"");
140 if ((fd = spool_open_temp(tname)) < 0)
141 return spool_write_error(where, errmsg, US"open", NULL, NULL);
142 fp = fdopen(fd, "wb");
143 DEBUG(D_receive|D_deliver) debug_printf("Writing spool header file: %s\n", tname);
145 /* We now have an open file to which the header data is to be written. Start
146 with the file's leaf name, to make the file self-identifying. Continue with the
147 identity of the submitting user, followed by the sender's address. The sender's
148 address is enclosed in <> because it might be the null address. Then write the
149 received time and the number of warning messages that have been sent. */
151 fprintf(fp, "%s-H\n", message_id);
152 fprintf(fp, "%.63s %ld %ld\n", originator_login, (long int)originator_uid,
153 (long int)originator_gid);
154 fprintf(fp, "<%s>\n", sender_address);
155 fprintf(fp, "%d %d\n", (int)received_time.tv_sec, warning_count);
157 fprintf(fp, "-received_time_usec .%06d\n", (int)received_time.tv_usec);
159 /* If there is information about a sending host, remember it. The HELO
160 data can be set for local SMTP as well as remote. */
162 if (sender_helo_name)
163 fprintf(fp, "-helo_name %s\n", sender_helo_name);
165 if (sender_host_address)
167 fprintf(fp, "-host_address %s.%d\n", sender_host_address, sender_host_port);
168 if (sender_host_name)
169 fprintf(fp, "-host_name %s\n", sender_host_name);
170 if (sender_host_authenticated)
171 fprintf(fp, "-host_auth %s\n", sender_host_authenticated);
174 /* Also about the interface a message came in on */
176 if (interface_address)
177 fprintf(fp, "-interface_address %s.%d\n", interface_address, interface_port);
179 if (smtp_active_hostname != primary_hostname)
180 fprintf(fp, "-active_hostname %s\n", smtp_active_hostname);
182 /* Likewise for any ident information; for local messages this is
183 likely to be the same as originator_login, but will be different if
184 the originator was root, forcing a different ident. */
186 if (sender_ident) fprintf(fp, "-ident %s\n", sender_ident);
188 /* Ditto for the received protocol */
190 if (received_protocol)
191 fprintf(fp, "-received_protocol %s\n", received_protocol);
193 /* Preserve any ACL variables that are set. */
195 tree_walk(acl_var_c, &acl_var_write, fp);
196 tree_walk(acl_var_m, &acl_var_write, fp);
198 /* Now any other data that needs to be remembered. */
200 if (f.spool_file_wireformat)
201 fprintf(fp, "-spool_file_wireformat\n");
203 fprintf(fp, "-body_linecount %d\n", body_linecount);
204 fprintf(fp, "-max_received_linelength %d\n", max_received_linelength);
206 if (body_zerocount > 0) fprintf(fp, "-body_zerocount %d\n", body_zerocount);
208 if (authenticated_id)
209 fprintf(fp, "-auth_id %s\n", authenticated_id);
210 if (authenticated_sender)
211 fprintf(fp, "-auth_sender %s\n", authenticated_sender);
213 if (f.allow_unqualified_recipient) fprintf(fp, "-allow_unqualified_recipient\n");
214 if (f.allow_unqualified_sender) fprintf(fp, "-allow_unqualified_sender\n");
215 if (f.deliver_firsttime) fprintf(fp, "-deliver_firsttime\n");
216 if (f.deliver_freeze) fprintf(fp, "-frozen " TIME_T_FMT "\n", deliver_frozen_at);
217 if (f.dont_deliver) fprintf(fp, "-N\n");
218 if (host_lookup_deferred) fprintf(fp, "-host_lookup_deferred\n");
219 if (host_lookup_failed) fprintf(fp, "-host_lookup_failed\n");
220 if (f.sender_local) fprintf(fp, "-local\n");
221 if (f.local_error_message) fprintf(fp, "-localerror\n");
222 #ifdef HAVE_LOCAL_SCAN
223 if (local_scan_data) fprintf(fp, "-local_scan %s\n", local_scan_data);
225 #ifdef WITH_CONTENT_SCAN
226 if (spam_bar) fprintf(fp,"-spam_bar %s\n", spam_bar);
227 if (spam_score) fprintf(fp,"-spam_score %s\n", spam_score);
228 if (spam_score_int) fprintf(fp,"-spam_score_int %s\n", spam_score_int);
230 if (f.deliver_manual_thaw) fprintf(fp, "-manual_thaw\n");
231 if (f.sender_set_untrusted) fprintf(fp, "-sender_set_untrusted\n");
233 #ifdef EXPERIMENTAL_BRIGHTMAIL
234 if (bmi_verdicts) fprintf(fp, "-bmi_verdicts %s\n", bmi_verdicts);
238 if (tls_in.certificate_verified) fprintf(fp, "-tls_certificate_verified\n");
239 if (tls_in.cipher) fprintf(fp, "-tls_cipher %s\n", tls_in.cipher);
242 (void) tls_export_cert(big_buffer, big_buffer_size, tls_in.peercert);
243 fprintf(fp, "-tls_peercert %s\n", CS big_buffer);
245 if (tls_in.peerdn) fprintf(fp, "-tls_peerdn %s\n", string_printing(tls_in.peerdn));
246 if (tls_in.sni) fprintf(fp, "-tls_sni %s\n", string_printing(tls_in.sni));
249 (void) tls_export_cert(big_buffer, big_buffer_size, tls_in.ourcert);
250 fprintf(fp, "-tls_ourcert %s\n", CS big_buffer);
252 if (tls_in.ocsp) fprintf(fp, "-tls_ocsp %d\n", tls_in.ocsp);
256 if (message_smtputf8)
258 fprintf(fp, "-smtputf8\n");
259 if (message_utf8_downconvert)
260 fprintf(fp, "-utf8_%sdowncvt\n", message_utf8_downconvert < 0 ? "opt" : "");
264 /* Write the dsn flags to the spool header file */
265 DEBUG(D_deliver) debug_printf("DSN: Write SPOOL :-dsn_envid %s\n", dsn_envid);
266 if (dsn_envid) fprintf(fp, "-dsn_envid %s\n", dsn_envid);
267 DEBUG(D_deliver) debug_printf("DSN: Write SPOOL :-dsn_ret %d\n", dsn_ret);
268 if (dsn_ret) fprintf(fp, "-dsn_ret %d\n", dsn_ret);
270 /* To complete the envelope, write out the tree of non-recipients, followed by
271 the list of recipients. These won't be disjoint the first time, when no
272 checking has been done. If a recipient is a "one-time" alias, it is followed by
273 a space and its parent address number (pno). */
275 tree_write(tree_nonrecipients, fp);
276 fprintf(fp, "%d\n", recipients_count);
277 for (int i = 0; i < recipients_count; i++)
279 recipient_item *r = recipients_list + i;
281 DEBUG(D_deliver) debug_printf("DSN: Flags :%d\n", r->dsn_flags);
283 if (r->pno < 0 && r->errors_to == NULL && r->dsn_flags == 0)
284 fprintf(fp, "%s\n", r->address);
287 uschar * errors_to = r->errors_to ? r->errors_to : US"";
288 /* for DSN SUPPORT extend exim 4 spool in a compatible way by
289 adding new values upfront and add flag 0x02 */
290 uschar * orcpt = r->orcpt ? r->orcpt : US"";
292 fprintf(fp, "%s %s %d,%d %s %d,%d#3\n", r->address, orcpt, Ustrlen(orcpt),
293 r->dsn_flags, errors_to, Ustrlen(errors_to), r->pno);
296 DEBUG(D_deliver) debug_printf("DSN: **** SPOOL_OUT - "
297 "address: |%s| errorsto: |%s| orcpt: |%s| dsn_flags: %d\n",
298 r->address, r->errors_to, r->orcpt, r->dsn_flags);
301 /* Put a blank line before the headers */
305 /* Save the size of the file so far so we can subtract it from the final length
306 to get the actual size of the headers. */
309 if (fstat(fd, &statbuf))
310 return spool_write_error(where, errmsg, US"fstat", tname, fp);
311 size_correction = statbuf.st_size;
313 /* Finally, write out the message's headers. To make it easier to read them
314 in again, precede each one with the count of its length. Make the count fixed
315 length to aid human eyes when debugging and arrange for it not be included in
316 the size. It is followed by a space for normal headers, a flagging letter for
317 various other headers, or an asterisk for old headers that have been rewritten.
318 These are saved as a record for debugging. Don't included them in the message's
321 for (header_line * h = header_list; h; h = h->next)
323 fprintf(fp, "%03d%c %s", h->slen, h->type, h->text);
324 size_correction += 5;
325 if (h->type == '*') size_correction += h->slen;
328 /* Flush and check for any errors while writing */
330 if (fflush(fp) != 0 || ferror(fp))
331 return spool_write_error(where, errmsg, US"write", tname, fp);
333 /* Force the file's contents to be written to disk. Note that fflush()
334 just pushes it out of C, and fclose() doesn't guarantee to do the write
335 either. That's just the way Unix works... */
337 if (EXIMfsync(fileno(fp)) < 0)
338 return spool_write_error(where, errmsg, US"sync", tname, fp);
340 /* Get the size of the file, and close it. */
342 if (fstat(fd, &statbuf) != 0)
343 return spool_write_error(where, errmsg, US"fstat", tname, NULL);
345 return spool_write_error(where, errmsg, US"close", tname, NULL);
347 /* Rename the file to its correct name, thereby replacing any previous
350 fname = spool_fname(US"input", message_subdir, id, US"-H");
351 DEBUG(D_receive|D_deliver) debug_printf("Renaming spool header file: %s\n", fname);
353 if (Urename(tname, fname) < 0)
354 return spool_write_error(where, errmsg, US"rename", tname, NULL);
356 /* Linux (and maybe other OS?) does not automatically sync a directory after
357 an operation like rename. We therefore have to do it forcibly ourselves in
358 these cases, to make sure the file is actually accessible on disk, as opposed
359 to just the data being accessible from a file in lost+found. Linux also has
360 O_DIRECTORY, for opening a directory.
362 However, it turns out that some file systems (some versions of NFS?) do not
363 support directory syncing. It seems safe enough to ignore EINVAL to cope with
364 these cases. One hack on top of another... but that's life. */
366 #ifdef NEED_SYNC_DIRECTORY
368 tname = spool_fname(US"input", message_subdir, US".", US"");
371 # define O_DIRECTORY 0
374 if ((fd = Uopen(tname, O_RDONLY|O_DIRECTORY, 0)) < 0)
375 return spool_write_error(where, errmsg, US"directory open", fname, NULL);
377 if (EXIMfsync(fd) < 0 && errno != EINVAL)
378 return spool_write_error(where, errmsg, US"directory sync", fname, NULL);
381 return spool_write_error(where, errmsg, US"directory close", fname, NULL);
383 #endif /* NEED_SYNC_DIRECTORY */
385 /* Return the number of characters in the headers, which is the file size, less
386 the preliminary stuff, less the additional count fields on the headers. */
388 DEBUG(D_receive) debug_printf("Size of headers = %d\n",
389 (int)(statbuf.st_size - size_correction));
391 return statbuf.st_size - size_correction;
395 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
397 /************************************************
399 ************************************************/
401 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
402 of spool_directory is checked to ensure that it is less than 200 characters at
406 dir base directory name
407 subdir subdirectory name
409 suffix suffix to add to id
410 from source directory prefix
411 to destination directory prefix
412 noentok if TRUE, absence of file is not an error
414 Returns: TRUE if all went well
415 FALSE, having panic logged if not
419 make_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
420 uschar *to, BOOL noentok)
422 uschar * fname = spool_fname(string_sprintf("%s%s", from, dir), subdir, id, suffix);
423 uschar * tname = spool_fname(string_sprintf("%s%s", to, dir), subdir, id, suffix);
424 if (Ulink(fname, tname) < 0 && (!noentok || errno != ENOENT))
426 log_write(0, LOG_MAIN|LOG_PANIC, "link(\"%s\", \"%s\") failed while moving "
427 "message: %s", fname, tname, strerror(errno));
435 /************************************************
437 ************************************************/
439 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
440 of spool_directory is checked to ensure that it is less than 200 characters at
444 dir base directory name
445 subdir subdirectory name
447 suffix suffix to add to id
448 from source directory prefix
449 noentok if TRUE, absence of file is not an error
451 Returns: TRUE if all went well
452 FALSE, having panic logged if not
456 break_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
459 uschar * fname = spool_fname(string_sprintf("%s%s", from, dir), subdir, id, suffix);
460 if (Uunlink(fname) < 0 && (!noentok || errno != ENOENT))
462 log_write(0, LOG_MAIN|LOG_PANIC, "unlink(\"%s\") failed while moving "
463 "message: %s", fname, strerror(errno));
471 /************************************************
472 * Move message files *
473 ************************************************/
475 /* Move the files for a message (-H, -D, and msglog) from one directory (or
476 hierarchy) to another. It is assume that there is no -J file in existence when
477 this is done. At present, this is used only when move_frozen_messages is set,
478 so compile it only when that support is configured.
481 id the id of the message to be delivered
482 subdir the subdirectory name, or an empty string
483 from a prefix for "input" or "msglog" for where the message is now
484 to a prefix for "input" or "msglog" for where the message is to go
486 Returns: TRUE if all is well
487 FALSE if not, with error logged in panic and main logs
491 spool_move_message(uschar *id, uschar *subdir, uschar *from, uschar *to)
493 /* Create any output directories that do not exist. */
495 (void) directory_make(spool_directory,
496 spool_sname(string_sprintf("%sinput", to), subdir),
497 INPUT_DIRECTORY_MODE, TRUE);
498 (void) directory_make(spool_directory,
499 spool_sname(string_sprintf("%smsglog", to), subdir),
500 INPUT_DIRECTORY_MODE, TRUE);
502 /* Move the message by first creating new hard links for all the files, and
503 then removing the old links. When moving messages onto the main spool, the -H
504 file should be set up last, because that's the one that tells Exim there is a
505 message to be delivered, so we create its new link last and remove its old link
506 first. Programs that look at the alternate directories should follow the same
507 rule of waiting for a -H file before doing anything. When moving messages off
508 the mail spool, the -D file should be open and locked at the time, thus keeping
511 if (!make_link(US"msglog", subdir, id, US"", from, to, TRUE) ||
512 !make_link(US"input", subdir, id, US"-D", from, to, FALSE) ||
513 !make_link(US"input", subdir, id, US"-H", from, to, FALSE))
516 if (!break_link(US"input", subdir, id, US"-H", from, FALSE) ||
517 !break_link(US"input", subdir, id, US"-D", from, FALSE) ||
518 !break_link(US"msglog", subdir, id, US"", from, TRUE))
521 log_write(0, LOG_MAIN, "moved from %sinput, %smsglog to %sinput, %smsglog",
529 /* End of spool_out.c */