Mark variables unused before release of store in the queue-runner loop
[exim.git] / src / src / spool_in.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8 /* Functions for reading spool files. When compiling for a utility (eximon),
9 not all are needed, and some functionality can be cut out. */
10
11
12 #include "exim.h"
13
14
15
16 #ifndef COMPILE_UTILITY
17 /*************************************************
18 *           Open and lock data file              *
19 *************************************************/
20
21 /* The data file is the one that is used for locking, because the header file
22 can get replaced during delivery because of header rewriting. The file has
23 to opened with write access so that we can get an exclusive lock, but in
24 fact it won't be written to. Just in case there's a major disaster (e.g.
25 overwriting some other file descriptor with the value of this one), open it
26 with append.
27
28 As called by deliver_message() (at least) we are operating as root.
29
30 Argument: the id of the message
31 Returns:  fd if file successfully opened and locked, else -1
32
33 Side effect: message_subdir is set for the (possibly split) spool directory
34 */
35
36 int
37 spool_open_datafile(uschar *id)
38 {
39 int i;
40 struct stat statbuf;
41 flock_t lock_data;
42 int fd;
43
44 /* If split_spool_directory is set, first look for the file in the appropriate
45 sub-directory of the input directory. If it is not found there, try the input
46 directory itself, to pick up leftovers from before the splitting. If split_
47 spool_directory is not set, first look in the main input directory. If it is
48 not found there, try the split sub-directory, in case it is left over from a
49 splitting state. */
50
51 for (i = 0; i < 2; i++)
52   {
53   uschar * fname;
54   int save_errno;
55
56   message_subdir[0] = split_spool_directory == i ? '\0' : id[5];
57   fname = spool_fname(US"input", message_subdir, id, US"-D");
58   DEBUG(D_deliver) debug_printf("Trying spool file %s\n", fname);
59
60   if ((fd = Uopen(fname,
61 #ifdef O_CLOEXEC
62                       O_CLOEXEC |
63 #endif
64                       O_RDWR | O_APPEND, 0)) >= 0)
65     break;
66   save_errno = errno;
67   if (errno == ENOENT)
68     {
69     if (i == 0) continue;
70     if (!queue_running)
71       log_write(0, LOG_MAIN, "Spool%s%s file %s-D not found",
72         *queue_name ? US" Q=" : US"",
73         *queue_name ? queue_name : US"",
74         id);
75     }
76   else
77     log_write(0, LOG_MAIN, "Spool error for %s: %s", fname, strerror(errno));
78   errno = save_errno;
79   return -1;
80   }
81
82 /* File is open and message_subdir is set. Set the close-on-exec flag, and lock
83 the file. We lock only the first line of the file (containing the message ID)
84 because this apparently is needed for running Exim under Cygwin. If the entire
85 file is locked in one process, a sub-process cannot access it, even when passed
86 an open file descriptor (at least, I think that's the Cygwin story). On real
87 Unix systems it doesn't make any difference as long as Exim is consistent in
88 what it locks. */
89
90 #ifndef O_CLOEXEC
91 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
92 #endif
93
94 lock_data.l_type = F_WRLCK;
95 lock_data.l_whence = SEEK_SET;
96 lock_data.l_start = 0;
97 lock_data.l_len = SPOOL_DATA_START_OFFSET;
98
99 if (fcntl(fd, F_SETLK, &lock_data) < 0)
100   {
101   log_write(L_skip_delivery,
102             LOG_MAIN,
103             "Spool file is locked (another process is handling this message)");
104   (void)close(fd);
105   errno = 0;
106   return -1;
107   }
108
109 /* Get the size of the data; don't include the leading filename line
110 in the count, but add one for the newline before the data. */
111
112 if (fstat(fd, &statbuf) == 0)
113   {
114   message_body_size = statbuf.st_size - SPOOL_DATA_START_OFFSET;
115   message_size = message_body_size + 1;
116   }
117
118 return fd;
119 }
120 #endif  /* COMPILE_UTILITY */
121
122
123
124 /*************************************************
125 *    Read non-recipients tree from spool file    *
126 *************************************************/
127
128 /* The tree of non-recipients is written to the spool file in a form that
129 makes it easy to read back into a tree. The format is as follows:
130
131    . Each node is preceded by two letter(Y/N) indicating whether it has left
132      or right children. There's one space after the two flags, before the name.
133
134    . The left subtree (if any) then follows, then the right subtree (if any).
135
136 This function is entered with the next input line in the buffer. Note we must
137 save the right flag before recursing with the same buffer.
138
139 Once the tree is read, we re-construct the balance fields by scanning the tree.
140 I forgot to write them out originally, and the compatible fix is to do it this
141 way. This initial local recursing function does the necessary.
142
143 Arguments:
144   node      tree node
145
146 Returns:    maximum depth below the node, including the node itself
147 */
148
149 static int
150 count_below(tree_node *node)
151 {
152 int nleft, nright;
153 if (node == NULL) return 0;
154 nleft = count_below(node->left);
155 nright = count_below(node->right);
156 node->balance = (nleft > nright)? 1 : ((nright > nleft)? 2 : 0);
157 return 1 + ((nleft > nright)? nleft : nright);
158 }
159
160 /* This is the real function...
161
162 Arguments:
163   connect      pointer to the root of the tree
164   f            FILE to read data from
165   buffer       contains next input line; further lines read into it
166   buffer_size  size of the buffer
167
168 Returns:       FALSE on format error
169 */
170
171 static BOOL
172 read_nonrecipients_tree(tree_node **connect, FILE *f, uschar *buffer,
173   int buffer_size)
174 {
175 tree_node *node;
176 int n = Ustrlen(buffer);
177 BOOL right = buffer[1] == 'Y';
178
179 if (n < 5) return FALSE;    /* malformed line */
180 buffer[n-1] = 0;            /* Remove \n */
181 node = store_get(sizeof(tree_node) + n - 3);
182 *connect = node;
183 Ustrcpy(node->name, buffer + 3);
184 node->data.ptr = NULL;
185
186 if (buffer[0] == 'Y')
187   {
188   if (Ufgets(buffer, buffer_size, f) == NULL ||
189     !read_nonrecipients_tree(&node->left, f, buffer, buffer_size))
190       return FALSE;
191   }
192 else node->left = NULL;
193
194 if (right)
195   {
196   if (Ufgets(buffer, buffer_size, f) == NULL ||
197     !read_nonrecipients_tree(&node->right, f, buffer, buffer_size))
198       return FALSE;
199   }
200 else node->right = NULL;
201
202 (void) count_below(*connect);
203 return TRUE;
204 }
205
206
207
208
209 /* Reset all the global variables to their default values. However, there is
210 one exception. DO NOT change the default value of dont_deliver, because it may
211 be forced by an external setting. */
212
213 void
214 spool_clear_header_globals(void)
215 {
216 acl_var_c = acl_var_m = NULL;
217 authenticated_id = NULL;
218 authenticated_sender = NULL;
219 allow_unqualified_recipient = FALSE;
220 allow_unqualified_sender = FALSE;
221 body_linecount = 0;
222 body_zerocount = 0;
223 deliver_firsttime = FALSE;
224 deliver_freeze = FALSE;
225 deliver_frozen_at = 0;
226 deliver_manual_thaw = FALSE;
227 /* dont_deliver must NOT be reset */
228 header_list = header_last = NULL;
229 host_lookup_deferred = FALSE;
230 host_lookup_failed = FALSE;
231 interface_address = NULL;
232 interface_port = 0;
233 local_error_message = FALSE;
234 local_scan_data = NULL;
235 max_received_linelength = 0;
236 message_linecount = 0;
237 received_protocol = NULL;
238 received_count = 0;
239 recipients_list = NULL;
240 sender_address = NULL;
241 sender_fullhost = NULL;
242 sender_helo_name = NULL;
243 sender_host_address = NULL;
244 sender_host_name = NULL;
245 sender_host_port = 0;
246 sender_host_authenticated = NULL;
247 sender_ident = NULL;
248 sender_local = FALSE;
249 sender_set_untrusted = FALSE;
250 smtp_active_hostname = primary_hostname;
251 #ifndef COMPILE_UTILITY
252 spool_file_wireformat = FALSE;
253 #endif
254 tree_nonrecipients = NULL;
255
256 #ifdef EXPERIMENTAL_BRIGHTMAIL
257 bmi_run = 0;
258 bmi_verdicts = NULL;
259 #endif
260
261 #ifndef DISABLE_DKIM
262 dkim_signers = NULL;
263 dkim_disable_verify = FALSE;
264 dkim_collect_input = FALSE;
265 #endif
266
267 #ifdef SUPPORT_TLS
268 tls_in.certificate_verified = FALSE;
269 # ifdef SUPPORT_DANE
270 tls_in.dane_verified = FALSE;
271 # endif
272 tls_in.cipher = NULL;
273 # ifndef COMPILE_UTILITY        /* tls support fns not built in */
274 tls_free_cert(&tls_in.ourcert);
275 tls_free_cert(&tls_in.peercert);
276 # endif
277 tls_in.peerdn = NULL;
278 tls_in.sni = NULL;
279 tls_in.ocsp = OCSP_NOT_REQ;
280 #endif
281
282 #ifdef WITH_CONTENT_SCAN
283 spam_bar = NULL;
284 spam_score = NULL;
285 spam_score_int = NULL;
286 #endif
287
288 #if defined(SUPPORT_I18N) && !defined(COMPILE_UTILITY)
289 message_smtputf8 = FALSE;
290 message_utf8_downconvert = 0;
291 #endif
292
293 dsn_ret = 0;
294 dsn_envid = NULL;
295 }
296
297
298 /*************************************************
299 *             Read spool header file             *
300 *************************************************/
301
302 /* This function reads a spool header file and places the data into the
303 appropriate global variables. The header portion is always read, but header
304 structures are built only if read_headers is set true. It isn't, for example,
305 while generating -bp output.
306
307 It may be possible for blocks of nulls (binary zeroes) to get written on the
308 end of a file if there is a system crash during writing. It was observed on an
309 earlier version of Exim that omitted to fsync() the files - this is thought to
310 have been the cause of that incident, but in any case, this code must be robust
311 against such an event, and if such a file is encountered, it must be treated as
312 malformed.
313
314 As called from deliver_message() (at least) we are running as root.
315
316 Arguments:
317   name          name of the header file, including the -H
318   read_headers  TRUE if in-store header structures are to be built
319   subdir_set    TRUE is message_subdir is already set
320
321 Returns:        spool_read_OK        success
322                 spool_read_notopen   open failed
323                 spool_read_enverror  error in the envelope portion
324                 spool_read_hdrerror  error in the header portion
325 */
326
327 int
328 spool_read_header(uschar *name, BOOL read_headers, BOOL subdir_set)
329 {
330 FILE *f = NULL;
331 int n;
332 int rcount = 0;
333 long int uid, gid;
334 BOOL inheader = FALSE;
335 uschar *p;
336
337 /* Reset all the global variables to their default values. However, there is
338 one exception. DO NOT change the default value of dont_deliver, because it may
339 be forced by an external setting. */
340
341 spool_clear_header_globals();
342
343 /* Generate the full name and open the file. If message_subdir is already
344 set, just look in the given directory. Otherwise, look in both the split
345 and unsplit directories, as for the data file above. */
346
347 for (n = 0; n < 2; n++)
348   {
349   if (!subdir_set)
350     message_subdir[0] = split_spool_directory == (n == 0) ? name[5] : 0;
351
352   if ((f = Ufopen(spool_fname(US"input", message_subdir, name, US""), "rb")))
353     break;
354   if (n != 0 || subdir_set || errno != ENOENT)
355     return spool_read_notopen;
356   }
357
358 errno = 0;
359
360 #ifndef COMPILE_UTILITY
361 DEBUG(D_deliver) debug_printf("reading spool file %s\n", name);
362 #endif  /* COMPILE_UTILITY */
363
364 /* The first line of a spool file contains the message id followed by -H (i.e.
365 the file name), in order to make the file self-identifying. */
366
367 if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
368 if (Ustrlen(big_buffer) != MESSAGE_ID_LENGTH + 3 ||
369     Ustrncmp(big_buffer, name, MESSAGE_ID_LENGTH + 2) != 0)
370   goto SPOOL_FORMAT_ERROR;
371
372 /* The next three lines in the header file are in a fixed format. The first
373 contains the login, uid, and gid of the user who caused the file to be written.
374 There are known cases where a negative gid is used, so we allow for both
375 negative uids and gids. The second contains the mail address of the message's
376 sender, enclosed in <>. The third contains the time the message was received,
377 and the number of warning messages for delivery delays that have been sent. */
378
379 if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
380
381 p = big_buffer + Ustrlen(big_buffer);
382 while (p > big_buffer && isspace(p[-1])) p--;
383 *p = 0;
384 if (!isdigit(p[-1])) goto SPOOL_FORMAT_ERROR;
385 while (p > big_buffer && (isdigit(p[-1]) || '-' == p[-1])) p--;
386 gid = Uatoi(p);
387 if (p <= big_buffer || *(--p) != ' ') goto SPOOL_FORMAT_ERROR;
388 *p = 0;
389 if (!isdigit(p[-1])) goto SPOOL_FORMAT_ERROR;
390 while (p > big_buffer && (isdigit(p[-1]) || '-' == p[-1])) p--;
391 uid = Uatoi(p);
392 if (p <= big_buffer || *(--p) != ' ') goto SPOOL_FORMAT_ERROR;
393 *p = 0;
394
395 originator_login = string_copy(big_buffer);
396 originator_uid = (uid_t)uid;
397 originator_gid = (gid_t)gid;
398
399 /* envelope from */
400 if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
401 n = Ustrlen(big_buffer);
402 if (n < 3 || big_buffer[0] != '<' || big_buffer[n-2] != '>')
403   goto SPOOL_FORMAT_ERROR;
404
405 sender_address = store_get(n-2);
406 Ustrncpy(sender_address, big_buffer+1, n-3);
407 sender_address[n-3] = 0;
408
409 /* time */
410 if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
411 if (sscanf(CS big_buffer, TIME_T_FMT " %d", &received_time.tv_sec, &warning_count) != 2)
412   goto SPOOL_FORMAT_ERROR;
413 received_time.tv_usec = 0;
414
415 message_age = time(NULL) - received_time.tv_sec;
416
417 #ifndef COMPILE_UTILITY
418 DEBUG(D_deliver) debug_printf("user=%s uid=%ld gid=%ld sender=%s\n",
419   originator_login, (long int)originator_uid, (long int)originator_gid,
420   sender_address);
421 #endif  /* COMPILE_UTILITY */
422
423 /* Now there may be a number of optional lines, each starting with "-". If you
424 add a new setting here, make sure you set the default above.
425
426 Because there are now quite a number of different possibilities, we use a
427 switch on the first character to avoid too many failing tests. Thanks to Nico
428 Erfurth for the patch that implemented this. I have made it even more efficient
429 by not re-scanning the first two characters.
430
431 To allow new versions of Exim that add additional flags to interwork with older
432 versions that do not understand them, just ignore any lines starting with "-"
433 that we don't recognize. Otherwise it wouldn't be possible to back off a new
434 version that left new-style flags written on the spool. */
435
436 p = big_buffer + 2;
437 for (;;)
438   {
439   int len;
440   if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
441   if (big_buffer[0] != '-') break;
442   while (  (len = Ustrlen(big_buffer)) == big_buffer_size-1
443         && big_buffer[len-1] != '\n'
444         )
445     {   /* buffer not big enough for line; certs make this possible */
446     uschar * buf;
447     if (big_buffer_size >= BIG_BUFFER_SIZE*4) goto SPOOL_READ_ERROR;
448     buf = store_get_perm(big_buffer_size *= 2);
449     memcpy(buf, big_buffer, --len);
450     big_buffer = buf;
451     if (Ufgets(big_buffer+len, big_buffer_size-len, f) == NULL)
452       goto SPOOL_READ_ERROR;
453     }
454   big_buffer[len-1] = 0;
455
456   switch(big_buffer[1])
457     {
458     case 'a':
459
460     /* Nowadays we use "-aclc" and "-aclm" for the different types of ACL
461     variable, because Exim allows any number of them, with arbitrary names.
462     The line in the spool file is "-acl[cm] <name> <length>". The name excludes
463     the c or m. */
464
465     if (Ustrncmp(p, "clc ", 4) == 0 ||
466         Ustrncmp(p, "clm ", 4) == 0)
467       {
468       uschar *name, *endptr;
469       int count;
470       tree_node *node;
471       endptr = Ustrchr(big_buffer + 6, ' ');
472       if (endptr == NULL) goto SPOOL_FORMAT_ERROR;
473       name = string_sprintf("%c%.*s", big_buffer[4],
474         (int)(endptr - big_buffer - 6), big_buffer + 6);
475       if (sscanf(CS endptr, " %d", &count) != 1) goto SPOOL_FORMAT_ERROR;
476       node = acl_var_create(name);
477       node->data.ptr = store_get(count + 1);
478       if (fread(node->data.ptr, 1, count+1, f) < count) goto SPOOL_READ_ERROR;
479       ((uschar*)node->data.ptr)[count] = 0;
480       }
481
482     else if (Ustrcmp(p, "llow_unqualified_recipient") == 0)
483       allow_unqualified_recipient = TRUE;
484     else if (Ustrcmp(p, "llow_unqualified_sender") == 0)
485       allow_unqualified_sender = TRUE;
486
487     else if (Ustrncmp(p, "uth_id", 6) == 0)
488       authenticated_id = string_copy(big_buffer + 9);
489     else if (Ustrncmp(p, "uth_sender", 10) == 0)
490       authenticated_sender = string_copy(big_buffer + 13);
491     else if (Ustrncmp(p, "ctive_hostname", 14) == 0)
492       smtp_active_hostname = string_copy(big_buffer + 17);
493
494     /* For long-term backward compatibility, we recognize "-acl", which was
495     used before the number of ACL variables changed from 10 to 20. This was
496     before the subsequent change to an arbitrary number of named variables.
497     This code is retained so that upgrades from very old versions can still
498     handle old-format spool files. The value given after "-acl" is a number
499     that is 0-9 for connection variables, and 10-19 for message variables. */
500
501     else if (Ustrncmp(p, "cl ", 3) == 0)
502       {
503       unsigned index, count;
504       uschar name[20];   /* Need plenty of space for %u format */
505       tree_node * node;
506       if (  sscanf(CS big_buffer + 5, "%u %u", &index, &count) != 2
507          || index >= 20
508          || count > 16384       /* arbitrary limit on variable size */
509          )
510         goto SPOOL_FORMAT_ERROR;
511       if (index < 10)
512         (void) string_format(name, sizeof(name), "%c%u", 'c', index);
513       else
514         (void) string_format(name, sizeof(name), "%c%u", 'm', index - 10);
515       node = acl_var_create(name);
516       node->data.ptr = store_get(count + 1);
517       /* We sanity-checked the count, so disable the Coverity error */
518       /* coverity[tainted_data] */
519       if (fread(node->data.ptr, 1, count+1, f) < count) goto SPOOL_READ_ERROR;
520       (US node->data.ptr)[count] = '\0';
521       }
522     break;
523
524     case 'b':
525     if (Ustrncmp(p, "ody_linecount", 13) == 0)
526       body_linecount = Uatoi(big_buffer + 15);
527     else if (Ustrncmp(p, "ody_zerocount", 13) == 0)
528       body_zerocount = Uatoi(big_buffer + 15);
529 #ifdef EXPERIMENTAL_BRIGHTMAIL
530     else if (Ustrncmp(p, "mi_verdicts ", 12) == 0)
531       bmi_verdicts = string_copy(big_buffer + 14);
532 #endif
533     break;
534
535     case 'd':
536     if (Ustrcmp(p, "eliver_firsttime") == 0)
537       deliver_firsttime = TRUE;
538     /* Check if the dsn flags have been set in the header file */
539     else if (Ustrncmp(p, "sn_ret", 6) == 0)
540       dsn_ret= atoi(CS big_buffer + 8);
541     else if (Ustrncmp(p, "sn_envid", 8) == 0)
542       dsn_envid = string_copy(big_buffer + 11);
543     break;
544
545     case 'f':
546     if (Ustrncmp(p, "rozen", 5) == 0)
547       {
548       deliver_freeze = TRUE;
549       if (sscanf(CS big_buffer+7, TIME_T_FMT, &deliver_frozen_at) != 1)
550         goto SPOOL_READ_ERROR;
551       }
552     break;
553
554     case 'h':
555     if (Ustrcmp(p, "ost_lookup_deferred") == 0)
556       host_lookup_deferred = TRUE;
557     else if (Ustrcmp(p, "ost_lookup_failed") == 0)
558       host_lookup_failed = TRUE;
559     else if (Ustrncmp(p, "ost_auth", 8) == 0)
560       sender_host_authenticated = string_copy(big_buffer + 11);
561     else if (Ustrncmp(p, "ost_name", 8) == 0)
562       sender_host_name = string_copy(big_buffer + 11);
563     else if (Ustrncmp(p, "elo_name", 8) == 0)
564       sender_helo_name = string_copy(big_buffer + 11);
565
566     /* We now record the port number after the address, separated by a
567     dot. For compatibility during upgrading, do nothing if there
568     isn't a value (it gets left at zero). */
569
570     else if (Ustrncmp(p, "ost_address", 11) == 0)
571       {
572       sender_host_port = host_address_extract_port(big_buffer + 14);
573       sender_host_address = string_copy(big_buffer + 14);
574       }
575     break;
576
577     case 'i':
578     if (Ustrncmp(p, "nterface_address", 16) == 0)
579       {
580       interface_port = host_address_extract_port(big_buffer + 19);
581       interface_address = string_copy(big_buffer + 19);
582       }
583     else if (Ustrncmp(p, "dent", 4) == 0)
584       sender_ident = string_copy(big_buffer + 7);
585     break;
586
587     case 'l':
588     if (Ustrcmp(p, "ocal") == 0)
589       sender_local = TRUE;
590     else if (Ustrcmp(big_buffer, "-localerror") == 0)
591       local_error_message = TRUE;
592     else if (Ustrncmp(p, "ocal_scan ", 10) == 0)
593       local_scan_data = string_copy(big_buffer + 12);
594     break;
595
596     case 'm':
597     if (Ustrcmp(p, "anual_thaw") == 0) deliver_manual_thaw = TRUE;
598     else if (Ustrncmp(p, "ax_received_linelength", 22) == 0)
599       max_received_linelength = Uatoi(big_buffer + 24);
600     break;
601
602     case 'N':
603     if (*p == 0) dont_deliver = TRUE;   /* -N */
604     break;
605
606     case 'r':
607     if (Ustrncmp(p, "eceived_protocol", 16) == 0)
608       received_protocol = string_copy(big_buffer + 19);
609     else if (Ustrncmp(p, "eceived_time_usec", 17) == 0)
610       {
611       unsigned usec;
612       if (sscanf(CS big_buffer + 21, "%u", &usec) == 1)
613         received_time.tv_usec = usec;
614       }
615     break;
616
617     case 's':
618     if (Ustrncmp(p, "ender_set_untrusted", 19) == 0)
619       sender_set_untrusted = TRUE;
620 #ifdef WITH_CONTENT_SCAN
621     else if (Ustrncmp(p, "pam_bar ", 8) == 0)
622       spam_bar = string_copy(big_buffer + 10);
623     else if (Ustrncmp(p, "pam_score ", 10) == 0)
624       spam_score = string_copy(big_buffer + 12);
625     else if (Ustrncmp(p, "pam_score_int ", 14) == 0)
626       spam_score_int = string_copy(big_buffer + 16);
627 #endif
628 #ifndef COMPILE_UTILITY
629     else if (Ustrncmp(p, "pool_file_wireformat", 20) == 0)
630       spool_file_wireformat = TRUE;
631 #endif
632 #if defined(SUPPORT_I18N) && !defined(COMPILE_UTILITY)
633     else if (Ustrncmp(p, "mtputf8", 7) == 0)
634       message_smtputf8 = TRUE;
635 #endif
636     break;
637
638 #ifdef SUPPORT_TLS
639     case 't':
640     if (Ustrncmp(p, "ls_certificate_verified", 23) == 0)
641       tls_in.certificate_verified = TRUE;
642     else if (Ustrncmp(p, "ls_cipher", 9) == 0)
643       tls_in.cipher = string_copy(big_buffer + 12);
644 # ifndef COMPILE_UTILITY        /* tls support fns not built in */
645     else if (Ustrncmp(p, "ls_ourcert", 10) == 0)
646       (void) tls_import_cert(big_buffer + 13, &tls_in.ourcert);
647     else if (Ustrncmp(p, "ls_peercert", 11) == 0)
648       (void) tls_import_cert(big_buffer + 14, &tls_in.peercert);
649 # endif
650     else if (Ustrncmp(p, "ls_peerdn", 9) == 0)
651       tls_in.peerdn = string_unprinting(string_copy(big_buffer + 12));
652     else if (Ustrncmp(p, "ls_sni", 6) == 0)
653       tls_in.sni = string_unprinting(string_copy(big_buffer + 9));
654     else if (Ustrncmp(p, "ls_ocsp", 7) == 0)
655       tls_in.ocsp = big_buffer[10] - '0';
656     break;
657 #endif
658
659 #if defined(SUPPORT_I18N) && !defined(COMPILE_UTILITY)
660     case 'u':
661     if (Ustrncmp(p, "tf8_downcvt", 11) == 0)
662       message_utf8_downconvert = 1;
663     else if (Ustrncmp(p, "tf8_optdowncvt", 15) == 0)
664       message_utf8_downconvert = -1;
665     break;
666 #endif
667
668     default:    /* Present because some compilers complain if all */
669     break;      /* possibilities are not covered. */
670     }
671   }
672
673 /* Build sender_fullhost if required */
674
675 #ifndef COMPILE_UTILITY
676 host_build_sender_fullhost();
677 #endif  /* COMPILE_UTILITY */
678
679 #ifndef COMPILE_UTILITY
680 DEBUG(D_deliver)
681   debug_printf("sender_local=%d ident=%s\n", sender_local,
682     (sender_ident == NULL)? US"unset" : sender_ident);
683 #endif  /* COMPILE_UTILITY */
684
685 /* We now have the tree of addresses NOT to deliver to, or a line
686 containing "XX", indicating no tree. */
687
688 if (Ustrncmp(big_buffer, "XX\n", 3) != 0 &&
689   !read_nonrecipients_tree(&tree_nonrecipients, f, big_buffer, big_buffer_size))
690     goto SPOOL_FORMAT_ERROR;
691
692 #ifndef COMPILE_UTILITY
693 DEBUG(D_deliver)
694   {
695   debug_printf("Non-recipients:\n");
696   debug_print_tree(tree_nonrecipients);
697   }
698 #endif  /* COMPILE_UTILITY */
699
700 /* After reading the tree, the next line has not yet been read into the
701 buffer. It contains the count of recipients which follow on separate lines.
702 Apply an arbitrary sanity check.*/
703
704 if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
705 if (sscanf(CS big_buffer, "%d", &rcount) != 1 || rcount > 16384)
706   goto SPOOL_FORMAT_ERROR;
707
708 #ifndef COMPILE_UTILITY
709 DEBUG(D_deliver) debug_printf("recipients_count=%d\n", rcount);
710 #endif  /* COMPILE_UTILITY */
711
712 recipients_list_max = rcount;
713 recipients_list = store_get(rcount * sizeof(recipient_item));
714
715 /* We sanitised the count and know we have enough memory, so disable
716 the Coverity error on recipients_count */
717 /* coverity[tainted_data] */
718
719 for (recipients_count = 0; recipients_count < rcount; recipients_count++)
720   {
721   int nn;
722   int pno = -1;
723   int dsn_flags = 0;
724   uschar *orcpt = NULL;
725   uschar *errors_to = NULL;
726   uschar *p;
727
728   if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
729   nn = Ustrlen(big_buffer);
730   if (nn < 2) goto SPOOL_FORMAT_ERROR;
731
732   /* Remove the newline; this terminates the address if there is no additional
733   data on the line. */
734
735   p = big_buffer + nn - 1;
736   *p-- = 0;
737
738   /* Look back from the end of the line for digits and special terminators.
739   Since an address must end with a domain, we can tell that extra data is
740   present by the presence of the terminator, which is always some character
741   that cannot exist in a domain. (If I'd thought of the need for additional
742   data early on, I'd have put it at the start, with the address at the end. As
743   it is, we have to operate backwards. Addresses are permitted to contain
744   spaces, you see.)
745
746   This code has to cope with various versions of this data that have evolved
747   over time. In all cases, the line might just contain an address, with no
748   additional data. Otherwise, the possibilities are as follows:
749
750   Exim 3 type:       <address><space><digits>,<digits>,<digits>
751
752     The second set of digits is the parent number for one_time addresses. The
753     other values were remnants of earlier experiments that were abandoned.
754
755   Exim 4 first type: <address><space><digits>
756
757     The digits are the parent number for one_time addresses.
758
759   Exim 4 new type:   <address><space><data>#<type bits>
760
761     The type bits indicate what the contents of the data are.
762
763     Bit 01 indicates that, reading from right to left, the data
764       ends with <errors_to address><space><len>,<pno> where pno is
765       the parent number for one_time addresses, and len is the length
766       of the errors_to address (zero meaning none).
767
768     Bit 02 indicates that, again reading from right to left, the data continues
769      with orcpt len(orcpt),dsn_flags
770    */
771
772   while (isdigit(*p)) p--;
773
774   /* Handle Exim 3 spool files */
775
776   if (*p == ',')
777     {
778     int dummy;
779     while (isdigit(*(--p)) || *p == ',');
780     if (*p == ' ')
781       {
782       *p++ = 0;
783       (void)sscanf(CS p, "%d,%d", &dummy, &pno);
784       }
785     }
786
787   /* Handle early Exim 4 spool files */
788
789   else if (*p == ' ')
790     {
791     *p++ = 0;
792     (void)sscanf(CS p, "%d", &pno);
793     }
794
795   /* Handle current format Exim 4 spool files */
796
797   else if (*p == '#')
798     {
799     int flags;
800
801 #if !defined (COMPILE_UTILITY)
802     DEBUG(D_deliver) debug_printf("**** SPOOL_IN - Exim 4 standard format spoolfile\n");
803 #endif
804
805     (void)sscanf(CS p+1, "%d", &flags);
806
807     if ((flags & 0x01) != 0)      /* one_time data exists */
808       {
809       int len;
810       while (isdigit(*(--p)) || *p == ',' || *p == '-');
811       (void)sscanf(CS p+1, "%d,%d", &len, &pno);
812       *p = 0;
813       if (len > 0)
814         {
815         p -= len;
816         errors_to = string_copy(p);
817         }
818       }
819
820     *(--p) = 0;   /* Terminate address */
821     if ((flags & 0x02) != 0)      /* one_time data exists */
822       {
823       int len;
824       while (isdigit(*(--p)) || *p == ',' || *p == '-');
825       (void)sscanf(CS p+1, "%d,%d", &len, &dsn_flags);
826       *p = 0;
827       if (len > 0)
828         {
829         p -= len;
830         orcpt = string_copy(p);
831         }
832       }
833
834     *(--p) = 0;   /* Terminate address */
835     }
836 #if !defined(COMPILE_UTILITY)
837   else
838     { DEBUG(D_deliver) debug_printf("**** SPOOL_IN - No additional fields\n"); }
839
840   if ((orcpt != NULL) || (dsn_flags != 0))
841     {
842     DEBUG(D_deliver) debug_printf("**** SPOOL_IN - address: |%s| orcpt: |%s| dsn_flags: %d\n",
843       big_buffer, orcpt, dsn_flags);
844     }
845   if (errors_to != NULL)
846     {
847     DEBUG(D_deliver) debug_printf("**** SPOOL_IN - address: |%s| errorsto: |%s|\n",
848       big_buffer, errors_to);
849     }
850 #endif
851
852   recipients_list[recipients_count].address = string_copy(big_buffer);
853   recipients_list[recipients_count].pno = pno;
854   recipients_list[recipients_count].errors_to = errors_to;
855   recipients_list[recipients_count].orcpt = orcpt;
856   recipients_list[recipients_count].dsn_flags = dsn_flags;
857   }
858
859 /* The remainder of the spool header file contains the headers for the message,
860 separated off from the previous data by a blank line. Each header is preceded
861 by a count of its length and either a certain letter (for various identified
862 headers), space (for a miscellaneous live header) or an asterisk (for a header
863 that has been rewritten). Count the Received: headers. We read the headers
864 always, in order to check on the format of the file, but only create a header
865 list if requested to do so. */
866
867 inheader = TRUE;
868 if (Ufgets(big_buffer, big_buffer_size, f) == NULL) goto SPOOL_READ_ERROR;
869 if (big_buffer[0] != '\n') goto SPOOL_FORMAT_ERROR;
870
871 while ((n = fgetc(f)) != EOF)
872   {
873   header_line *h;
874   uschar flag[4];
875   int i;
876
877   if (!isdigit(n)) goto SPOOL_FORMAT_ERROR;
878   if(ungetc(n, f) == EOF  ||  fscanf(f, "%d%c ", &n, flag) == EOF)
879     goto SPOOL_READ_ERROR;
880   if (flag[0] != '*') message_size += n;  /* Omit non-transmitted headers */
881
882   if (read_headers)
883     {
884     h = store_get(sizeof(header_line));
885     h->next = NULL;
886     h->type = flag[0];
887     h->slen = n;
888     h->text = store_get(n+1);
889
890     if (h->type == htype_received) received_count++;
891
892     if (header_list == NULL) header_list = h;
893       else header_last->next = h;
894     header_last = h;
895
896     for (i = 0; i < n; i++)
897       {
898       int c = fgetc(f);
899       if (c == 0 || c == EOF) goto SPOOL_FORMAT_ERROR;
900       if (c == '\n' && h->type != htype_old) message_linecount++;
901       h->text[i] = c;
902       }
903     h->text[i] = 0;
904     }
905
906   /* Not requiring header data, just skip through the bytes */
907
908   else for (i = 0; i < n; i++)
909     {
910     int c = fgetc(f);
911     if (c == 0 || c == EOF) goto SPOOL_FORMAT_ERROR;
912     }
913   }
914
915 /* We have successfully read the data in the header file. Update the message
916 line count by adding the body linecount to the header linecount. Close the file
917 and give a positive response. */
918
919 #ifndef COMPILE_UTILITY
920 DEBUG(D_deliver) debug_printf("body_linecount=%d message_linecount=%d\n",
921   body_linecount, message_linecount);
922 #endif  /* COMPILE_UTILITY */
923
924 message_linecount += body_linecount;
925
926 fclose(f);
927 return spool_read_OK;
928
929
930 /* There was an error reading the spool or there was missing data,
931 or there was a format error. A "read error" with no errno means an
932 unexpected EOF, which we treat as a format error. */
933
934 SPOOL_READ_ERROR:
935 if (errno != 0)
936   {
937   n = errno;
938
939 #ifndef COMPILE_UTILITY
940   DEBUG(D_any) debug_printf("Error while reading spool file %s\n", name);
941 #endif  /* COMPILE_UTILITY */
942
943   fclose(f);
944   errno = n;
945   return inheader? spool_read_hdrerror : spool_read_enverror;
946   }
947
948 SPOOL_FORMAT_ERROR:
949
950 #ifndef COMPILE_UTILITY
951 DEBUG(D_any) debug_printf("Format error in spool file %s\n", name);
952 #endif  /* COMPILE_UTILITY */
953
954 fclose(f);
955 errno = ERRNO_SPOOLFORMAT;
956 return inheader? spool_read_hdrerror : spool_read_enverror;
957 }
958
959 /* vi: aw ai sw=2
960 */
961 /* End of spool_in.c */