1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
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 and 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 != NULL)? sender_fullhost : sender_ident,
44 string_sprintf("spool file %s error while %s: %s", s,
45 (where == SW_DELIVERING)? "delivering" : "modifying",
48 if (temp_name != NULL) Uunlink(temp_name);
49 if (f != NULL) (void)fclose(f);
52 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", msg);
61 /*************************************************
62 * Open file under temporary name *
63 *************************************************/
65 /* This is used for opening spool files under a temporary name,
66 with a single attempt at deleting if they already exist.
68 Argument: temporary name for spool header file
69 Returns: file descriptor of open file, or < 0 on failure, with errno unchanged
73 spool_open_temp(uschar *temp_name)
75 int fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
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.
84 if (fd < 0 && errno == EEXIST)
86 DEBUG(D_any) debug_printf("%s exists: unlinking\n", temp_name);
88 fd = Uopen(temp_name, O_RDWR|O_CREAT|O_EXCL, SPOOL_MODE);
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
96 if (fchown(fd, exim_uid, exim_gid) || fchmod(fd, SPOOL_MODE))
98 DEBUG(D_any) debug_printf("failed setting perms on %s\n", temp_name);
99 (void) close(fd); fd = -1;
108 /*************************************************
109 * Write the header spool file *
110 *************************************************/
112 /* Returns the size of the file for success; zero for failure. The file is
113 written under a temporary name, and then renamed. It's done this way so that it
114 works with re-writing the file on message deferral as well as for the initial
115 write. Whenever this function is called, the data file for the message should
116 be open and locked, thus preventing any other exim process from working on this
121 where SW_RECEIVING, SW_DELIVERING, or SW_MODIFYING
122 errmsg where to put an error message; if NULL, panic-die on error
124 Returns: the size of the header texts on success;
125 negative on writing failure, unless errmsg == NULL
129 spool_write_header(uschar *id, int where, uschar **errmsg)
138 uschar temp_name[256];
140 sprintf(CS temp_name, "%s/input/%s/hdr.%d", spool_directory, message_subdir,
142 fd = spool_open_temp(temp_name);
143 if (fd < 0) return spool_write_error(where, errmsg, US"open", NULL, NULL);
144 f = fdopen(fd, "wb");
145 DEBUG(D_receive|D_deliver) debug_printf("Writing spool header file\n");
147 /* We now have an open file to which the header data is to be written. Start
148 with the file's leaf name, to make the file self-identifying. Continue with the
149 identity of the submitting user, followed by the sender's address. The sender's
150 address is enclosed in <> because it might be the null address. Then write the
151 received time and the number of warning messages that have been sent. */
153 fprintf(f, "%s-H\n", message_id);
154 fprintf(f, "%.63s %ld %ld\n", originator_login, (long int)originator_uid,
155 (long int)originator_gid);
156 fprintf(f, "<%s>\n", sender_address);
157 fprintf(f, "%d %d\n", received_time, warning_count);
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 != NULL)
163 fprintf(f, "-helo_name %s\n", sender_helo_name);
165 if (sender_host_address != NULL)
167 fprintf(f, "-host_address %s.%d\n", sender_host_address, sender_host_port);
168 if (sender_host_name != NULL)
169 fprintf(f, "-host_name %s\n", sender_host_name);
170 if (sender_host_authenticated != NULL)
171 fprintf(f, "-host_auth %s\n", sender_host_authenticated);
174 /* Also about the interface a message came in on */
176 if (interface_address != NULL)
177 fprintf(f, "-interface_address %s.%d\n", interface_address, interface_port);
179 if (smtp_active_hostname != primary_hostname)
180 fprintf(f, "-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 != NULL) fprintf(f, "-ident %s\n", sender_ident);
188 /* Ditto for the received protocol */
190 if (received_protocol != NULL)
191 fprintf(f, "-received_protocol %s\n", received_protocol);
193 /* Preserve any ACL variables that are set. */
195 tree_walk(acl_var_c, &acl_var_write, f);
196 tree_walk(acl_var_m, &acl_var_write, f);
198 /* Now any other data that needs to be remembered. */
200 fprintf(f, "-body_linecount %d\n", body_linecount);
201 fprintf(f, "-max_received_linelength %d\n", max_received_linelength);
203 if (body_zerocount > 0) fprintf(f, "-body_zerocount %d\n", body_zerocount);
205 if (authenticated_id != NULL)
206 fprintf(f, "-auth_id %s\n", authenticated_id);
207 if (authenticated_sender != NULL)
208 fprintf(f, "-auth_sender %s\n", authenticated_sender);
210 if (allow_unqualified_recipient) fprintf(f, "-allow_unqualified_recipient\n");
211 if (allow_unqualified_sender) fprintf(f, "-allow_unqualified_sender\n");
212 if (deliver_firsttime) fprintf(f, "-deliver_firsttime\n");
213 if (deliver_freeze) fprintf(f, "-frozen " TIME_T_FMT "\n", deliver_frozen_at);
214 if (dont_deliver) fprintf(f, "-N\n");
215 if (host_lookup_deferred) fprintf(f, "-host_lookup_deferred\n");
216 if (host_lookup_failed) fprintf(f, "-host_lookup_failed\n");
217 if (sender_local) fprintf(f, "-local\n");
218 if (local_error_message) fprintf(f, "-localerror\n");
219 if (local_scan_data != NULL) fprintf(f, "-local_scan %s\n", local_scan_data);
220 #ifdef WITH_CONTENT_SCAN
221 if (spam_bar) fprintf(f,"-spam_bar %s\n", spam_bar);
222 if (spam_score) fprintf(f,"-spam_score %s\n", spam_score);
223 if (spam_score_int) fprintf(f,"-spam_score_int %s\n", spam_score_int);
225 if (deliver_manual_thaw) fprintf(f, "-manual_thaw\n");
226 if (sender_set_untrusted) fprintf(f, "-sender_set_untrusted\n");
228 #ifdef EXPERIMENTAL_BRIGHTMAIL
229 if (bmi_verdicts != NULL) fprintf(f, "-bmi_verdicts %s\n", bmi_verdicts);
233 if (tls_in.certificate_verified) fprintf(f, "-tls_certificate_verified\n");
234 if (tls_in.cipher) fprintf(f, "-tls_cipher %s\n", tls_in.cipher);
237 (void) tls_export_cert(big_buffer, big_buffer_size, tls_in.peercert);
238 fprintf(f, "-tls_peercert %s\n", CS big_buffer);
240 if (tls_in.peerdn) fprintf(f, "-tls_peerdn %s\n", string_printing(tls_in.peerdn));
241 if (tls_in.sni) fprintf(f, "-tls_sni %s\n", string_printing(tls_in.sni));
244 (void) tls_export_cert(big_buffer, big_buffer_size, tls_in.ourcert);
245 fprintf(f, "-tls_ourcert %s\n", CS big_buffer);
247 if (tls_in.ocsp) fprintf(f, "-tls_ocsp %d\n", tls_in.ocsp);
251 if (message_smtputf8)
253 fprintf(f, "-smtputf8\n");
254 if (message_utf8_downconvert)
255 fprintf(f, "-utf8_%sdowncvt\n", message_utf8_downconvert < 0 ? "opt" : "");
259 /* Write the dsn flags to the spool header file */
260 DEBUG(D_deliver) debug_printf("DSN: Write SPOOL :-dsn_envid %s\n", dsn_envid);
261 if (dsn_envid != NULL) fprintf(f, "-dsn_envid %s\n", dsn_envid);
262 DEBUG(D_deliver) debug_printf("DSN: Write SPOOL :-dsn_ret %d\n", dsn_ret);
263 if (dsn_ret != 0) fprintf(f, "-dsn_ret %d\n", dsn_ret);
265 /* To complete the envelope, write out the tree of non-recipients, followed by
266 the list of recipients. These won't be disjoint the first time, when no
267 checking has been done. If a recipient is a "one-time" alias, it is followed by
268 a space and its parent address number (pno). */
270 tree_write(tree_nonrecipients, f);
271 fprintf(f, "%d\n", recipients_count);
272 for (i = 0; i < recipients_count; i++)
274 recipient_item *r = recipients_list + i;
275 DEBUG(D_deliver) debug_printf("DSN: Flags :%d\n", r->dsn_flags);
276 if (r->pno < 0 && r->errors_to == NULL && r->dsn_flags == 0)
277 fprintf(f, "%s\n", r->address);
280 uschar *errors_to = (r->errors_to == NULL)? US"" : r->errors_to;
281 /* for DSN SUPPORT extend exim 4 spool in a compatible way by
282 adding new values upfront and add flag 0x02 */
283 uschar *orcpt = (r->orcpt == NULL)? US"" : r->orcpt;
284 fprintf(f, "%s %s %d,%d %s %d,%d#3\n", r->address, orcpt, Ustrlen(orcpt), r->dsn_flags,
285 errors_to, Ustrlen(errors_to), r->pno);
288 DEBUG(D_deliver) debug_printf("DSN: **** SPOOL_OUT - address: |%s| errorsto: |%s| orcpt: |%s| dsn_flags: %d\n",
289 r->address, r->errors_to, r->orcpt, r->dsn_flags);
292 /* Put a blank line before the headers */
296 /* Save the size of the file so far so we can subtract it from the final length
297 to get the actual size of the headers. */
301 size_correction = statbuf.st_size;
303 /* Finally, write out the message's headers. To make it easier to read them
304 in again, precede each one with the count of its length. Make the count fixed
305 length to aid human eyes when debugging and arrange for it not be included in
306 the size. It is followed by a space for normal headers, a flagging letter for
307 various other headers, or an asterisk for old headers that have been rewritten.
308 These are saved as a record for debugging. Don't included them in the message's
311 for (h = header_list; h != NULL; h = h->next)
313 fprintf(f, "%03d%c %s", h->slen, h->type, h->text);
314 size_correction += 5;
315 if (h->type == '*') size_correction += h->slen;
318 /* Flush and check for any errors while writing */
320 if (fflush(f) != 0 || ferror(f))
321 return spool_write_error(where, errmsg, US"write", temp_name, f);
323 /* Force the file's contents to be written to disk. Note that fflush()
324 just pushes it out of C, and fclose() doesn't guarantee to do the write
325 either. That's just the way Unix works... */
327 if (EXIMfsync(fileno(f)) < 0)
328 return spool_write_error(where, errmsg, US"sync", temp_name, f);
330 /* Get the size of the file, and close it. */
332 if (fstat(fd, &statbuf) != 0)
333 return spool_write_error(where, errmsg, US"fstat", temp_name, NULL);
335 return spool_write_error(where, errmsg, US"close", temp_name, NULL);
337 /* Rename the file to its correct name, thereby replacing any previous
340 sprintf(CS name, "%s/input/%s/%s-H", spool_directory, message_subdir, id);
342 if (Urename(temp_name, name) < 0)
343 return spool_write_error(where, errmsg, US"rename", temp_name, NULL);
345 /* Linux (and maybe other OS?) does not automatically sync a directory after
346 an operation like rename. We therefore have to do it forcibly ourselves in
347 these cases, to make sure the file is actually accessible on disk, as opposed
348 to just the data being accessible from a file in lost+found. Linux also has
349 O_DIRECTORY, for opening a directory.
351 However, it turns out that some file systems (some versions of NFS?) do not
352 support directory syncing. It seems safe enough to ignore EINVAL to cope with
353 these cases. One hack on top of another... but that's life. */
355 #ifdef NEED_SYNC_DIRECTORY
357 sprintf(CS temp_name, "%s/input/%s/.", spool_directory, message_subdir);
360 #define O_DIRECTORY 0
363 if ((fd = Uopen(temp_name, O_RDONLY|O_DIRECTORY, 0)) < 0)
364 return spool_write_error(where, errmsg, US"directory open", name, NULL);
366 if (EXIMfsync(fd) < 0 && errno != EINVAL)
367 return spool_write_error(where, errmsg, US"directory sync", name, NULL);
370 return spool_write_error(where, errmsg, US"directory close", name, NULL);
372 #endif /* NEED_SYNC_DIRECTORY */
374 /* Return the number of characters in the headers, which is the file size, less
375 the prelimary stuff, less the additional count fields on the headers. */
377 DEBUG(D_receive) debug_printf("Size of headers = %d\n",
378 (int)(statbuf.st_size - size_correction));
380 return statbuf.st_size - size_correction;
384 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
386 /************************************************
388 ************************************************/
390 /* Used by spool_move_message() below. Note re the use of sprintf(): the value
391 of spool_directory is checked to ensure that it is less than 200 characters at
395 dir base directory name
396 subdir subdirectory name
398 suffix suffix to add to id
399 from source directory prefix
400 to destination directory prefix
401 noentok if TRUE, absence of file is not an error
403 Returns: TRUE if all went well
404 FALSE, having panic logged if not
408 make_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
409 uschar *to, BOOL noentok)
411 uschar f[256], t[256];
412 sprintf(CS f, "%s/%s%s/%s/%s%s", spool_directory, from, dir, subdir, id, suffix);
413 sprintf(CS t, "%s/%s%s/%s/%s%s", spool_directory, to, dir, subdir, id, suffix);
414 if (Ulink(f, t) < 0 && (!noentok || errno != ENOENT))
416 log_write(0, LOG_MAIN|LOG_PANIC, "link(\"%s\", \"%s\") failed while moving "
417 "message: %s", f, t, strerror(errno));
425 /************************************************
427 ************************************************/
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
434 dir base directory name
435 subdir subdirectory name
437 suffix suffix to add to id
438 from source directory prefix
439 noentok if TRUE, absence of file is not an error
441 Returns: TRUE if all went well
442 FALSE, having panic logged if not
446 break_link(uschar *dir, uschar *subdir, uschar *id, uschar *suffix, uschar *from,
450 sprintf(CS f, "%s/%s%s/%s/%s%s", spool_directory, from, dir, subdir, id, suffix);
451 if (Uunlink(f) < 0 && (!noentok || errno != ENOENT))
453 log_write(0, LOG_MAIN|LOG_PANIC, "unlink(\"%s\") failed while moving "
454 "message: %s", f, strerror(errno));
462 /************************************************
463 * Move message files *
464 ************************************************/
466 /* Move the files for a message (-H, -D, and msglog) from one directory (or
467 hierarchy) to another. It is assume that there is no -J file in existence when
468 this is done. At present, this is used only when move_frozen_messages is set,
469 so compile it only when that support is configured.
472 id the id of the message to be delivered
473 subdir the subdirectory name, or an empty string
474 from a prefix for "input" or "msglog" for where the message is now
475 to a prefix for "input" or "msglog" for where the message is to go
477 Returns: TRUE if all is well
478 FALSE if not, with error logged in panic and main logs
482 spool_move_message(uschar *id, uschar *subdir, uschar *from, uschar *to)
484 /* Create any output directories that do not exist. */
486 sprintf(CS big_buffer, "%sinput/%s", to, subdir);
487 (void)directory_make(spool_directory, big_buffer, INPUT_DIRECTORY_MODE, TRUE);
488 sprintf(CS big_buffer, "%smsglog/%s", to, subdir);
489 (void)directory_make(spool_directory, big_buffer, INPUT_DIRECTORY_MODE, TRUE);
491 /* Move the message by first creating new hard links for all the files, and
492 then removing the old links. When moving messages onto the main spool, the -H
493 file should be set up last, because that's the one that tells Exim there is a
494 message to be delivered, so we create its new link last and remove its old link
495 first. Programs that look at the alternate directories should follow the same
496 rule of waiting for a -H file before doing anything. When moving messsages off
497 the mail spool, the -D file should be open and locked at the time, thus keeping
500 if (!make_link(US"msglog", subdir, id, US"", from, to, TRUE) ||
501 !make_link(US"input", subdir, id, US"-D", from, to, FALSE) ||
502 !make_link(US"input", subdir, id, US"-H", from, to, FALSE))
505 if (!break_link(US"input", subdir, id, US"-H", from, FALSE) ||
506 !break_link(US"input", subdir, id, US"-D", from, FALSE) ||
507 !break_link(US"msglog", subdir, id, US"", from, TRUE))
510 log_write(0, LOG_MAIN, "moved from %sinput, %smsglog to %sinput, %smsglog",
518 /* End of spool_out.c */