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