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