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