2b2ffd34129ad0e4aaabaf74ed98b493040f3285
[exim.git] / src / src / parse.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 parsing addresses */
10
11
12 #include "exim.h"
13
14
15 static uschar *last_comment_position;
16
17
18
19 /* In stand-alone mode, provide a replacement for deliver_make_addr()
20 and rewrite_address[_qualify]() so as to avoid having to drag in too much
21 redundant apparatus. */
22
23 #ifdef STAND_ALONE
24
25 address_item *deliver_make_addr(uschar *address, BOOL copy)
26 {
27 address_item *addr = store_get(sizeof(address_item), FALSE);
28 addr->next = NULL;
29 addr->parent = NULL;
30 addr->address = address;
31 return addr;
32 }
33
34 uschar *rewrite_address(uschar *recipient, BOOL dummy1, BOOL dummy2, rewrite_rule
35   *dummy3, int dummy4)
36 {
37 return recipient;
38 }
39
40 uschar *rewrite_address_qualify(uschar *recipient, BOOL dummy1)
41 {
42 return recipient;
43 }
44
45 #endif
46
47
48
49
50 /*************************************************
51 *             Find the end of an address         *
52 *************************************************/
53
54 /* Scan over a string looking for the termination of an address at a comma,
55 or end of the string. It's the source-routed addresses which cause much pain
56 here. Although Exim ignores source routes, it must recognize such addresses, so
57 we cannot get rid of this logic.
58
59 Argument:
60   s        pointer to the start of an address
61   nl_ends  if TRUE, '\n' terminates an address
62
63 Returns:   pointer past the end of the address
64            (i.e. points to null or comma)
65 */
66
67 uschar *
68 parse_find_address_end(uschar *s, BOOL nl_ends)
69 {
70 BOOL source_routing = *s == '@';
71 int no_term = source_routing? 1 : 0;
72
73 while (*s != 0 && (*s != ',' || no_term > 0) && (*s != '\n' || !nl_ends))
74   {
75   /* Skip single quoted characters. Strictly these should not occur outside
76   quoted strings in RFC 822 addresses, but they can in RFC 821 addresses. Pity
77   about the lack of consistency, isn't it? */
78
79   if (*s == '\\' && s[1] != 0) s += 2;
80
81   /* Skip quoted items that are not inside brackets. Note that
82   quoted pairs are allowed inside quoted strings. */
83
84   else if (*s == '\"')
85     {
86     while (*(++s) != 0 && (*s != '\n' || !nl_ends))
87       {
88       if (*s == '\\' && s[1] != 0) s++;
89         else if (*s == '\"') { s++; break; }
90       }
91     }
92
93   /* Skip comments, which may include nested brackets, but quotes
94   are not recognized inside comments, though quoted pairs are. */
95
96   else if (*s == '(')
97     {
98     int level = 1;
99     while (*(++s) != 0 && (*s != '\n' || !nl_ends))
100       {
101       if (*s == '\\' && s[1] != 0) s++;
102         else if (*s == '(') level++;
103           else if (*s == ')' && --level <= 0) { s++; break; }
104       }
105     }
106
107   /* Non-special character; just advance. Passing the colon in a source
108   routed address means that any subsequent comma or colon may terminate unless
109   inside angle brackets. */
110
111   else
112     {
113     if (*s == '<')
114       {
115       source_routing = s[1] == '@';
116       no_term = source_routing? 2 : 1;
117       }
118     else if (*s == '>') no_term--;
119     else if (source_routing && *s == ':') no_term--;
120     s++;
121     }
122   }
123
124 return s;
125 }
126
127
128
129 /*************************************************
130 *            Find last @ in an address           *
131 *************************************************/
132
133 /* This function is used when we have something that may not qualified. If we
134 know it's qualified, searching for the rightmost '@' is sufficient. Here we
135 have to be a bit more clever than just a plain search, in order to handle
136 unqualified local parts like "thing@thong" correctly. Since quotes may not
137 legally be part of a domain name, we can give up on hitting the first quote
138 when searching from the right. Now that the parsing also permits the RFC 821
139 form of address, where quoted-pairs are allowed in unquoted local parts, we
140 must take care to handle that too.
141
142 Argument:  pointer to an address, possibly unqualified
143 Returns:   pointer to the last @ in an address, or NULL if none
144 */
145
146 uschar *
147 parse_find_at(uschar *s)
148 {
149 uschar *t = s + Ustrlen(s);
150 while (--t >= s)
151   {
152   if (*t == '@')
153     {
154     int backslash_count = 0;
155     uschar *tt = t - 1;
156     while (tt > s && *tt-- == '\\') backslash_count++;
157     if ((backslash_count & 1) == 0) return t;
158     }
159   else if (*t == '\"') return NULL;
160   }
161 return NULL;
162 }
163
164
165
166
167 /***************************************************************************
168 * In all the functions below that read a particular object type from       *
169 * the input, return the new value of the pointer s (the first argument),   *
170 * and put the object into the store pointed to by t (the second argument), *
171 * adding a terminating zero. If no object is found, t will point to zero   *
172 * on return.                                                               *
173 ***************************************************************************/
174
175
176 /*************************************************
177 *          Skip white space and comment          *
178 *************************************************/
179
180 /* Algorithm:
181   (1) Skip spaces.
182   (2) If uschar not '(', return.
183   (3) Skip till matching ')', not counting any characters
184       escaped with '\'.
185   (4) Move past ')' and goto (1).
186
187 The start of the last potential comment position is remembered to
188 make it possible to ignore comments at the end of compound items.
189
190 Argument: current character pointer
191 Returns:  new character pointer
192 */
193
194 static uschar *
195 skip_comment(uschar *s)
196 {
197 last_comment_position = s;
198 while (*s)
199   {
200   int c, level;
201
202   if (Uskip_whitespace(&s) != '(') break;
203   level = 1;
204   while((c = *(++s)))
205     {
206     if (c == '(') level++;
207     else if (c == ')') { if (--level <= 0) { s++; break; } }
208     else if (c == '\\' && s[1] != 0) s++;
209     }
210   }
211 return s;
212 }
213
214
215
216 /*************************************************
217 *             Read a domain                      *
218 *************************************************/
219
220 /* A domain is a sequence of subdomains, separated by dots. See comments below
221 for detailed syntax of the subdomains.
222
223 If allow_domain_literals is TRUE, a "domain" may also be an IP address enclosed
224 in []. Make sure the output is set to the null string if there is a syntax
225 error as well as if there is no domain at all.
226
227 Arguments:
228   s          current character pointer
229   t          where to put the domain
230   errorptr   put error message here on failure (*t will be 0 on exit)
231
232 Returns:     new character pointer
233 */
234
235 static uschar *
236 read_domain(uschar *s, uschar *t, uschar **errorptr)
237 {
238 uschar *tt = t;
239 s = skip_comment(s);
240
241 /* Handle domain literals if permitted. An RFC 822 domain literal may contain
242 any character except [ ] \, including linear white space, and may contain
243 quoted characters. However, RFC 821 restricts literals to being dot-separated
244 3-digit numbers, and we make the obvious extension for IPv6. Go for a sequence
245 of digits, dots, hex digits, and colons here; later this will be checked for
246 being a syntactically valid IP address if it ever gets to a router.
247
248 Allow both the formal IPv6 form, with IPV6: at the start, and the informal form
249 without it, and accept IPV4: as well, 'cause someone will use it sooner or
250 later. */
251
252 if (*s == '[')
253   {
254   *t++ = *s++;
255
256   if (strncmpic(s, US"IPv6:", 5) == 0 || strncmpic(s, US"IPv4:", 5) == 0)
257     {
258     memcpy(t, s, 5);
259     t += 5;
260     s += 5;
261     }
262   while (*s == '.' || *s == ':' || isxdigit(*s)) *t++ = *s++;
263
264   if (*s == ']') *t++ = *s++; else
265     {
266     *errorptr = US"malformed domain literal";
267     *tt = 0;
268     }
269
270   if (!allow_domain_literals)
271     {
272     *errorptr = US"domain literals not allowed";
273     *tt = 0;
274     }
275   *t = 0;
276   return skip_comment(s);
277   }
278
279 /* Handle a proper domain, which is a sequence of dot-separated atoms. Remove
280 trailing dots if strip_trailing_dot is set. A subdomain is an atom.
281
282 An atom is a sequence of any characters except specials, space, and controls.
283 The specials are ( ) < > @ , ; : \ " . [ and ]. This is the rule for RFC 822
284 and its successor (RFC 2822). However, RFC 821 and its successor (RFC 2821) is
285 tighter, allowing only letters, digits, and hyphens, not starting with a
286 hyphen.
287
288 There used to be a global flag that got set when checking addresses that came
289 in over SMTP and which should therefore should be checked according to the
290 stricter rule. However, it seems silly to make the distinction, because I don't
291 suppose anybody ever uses local domains that are 822-compliant and not
292 821-compliant. Furthermore, Exim now has additional data on the spool file line
293 after an address (after "one_time" processing), and it makes use of a #
294 character to delimit it. When I wrote that code, I forgot about this 822-domain
295 stuff, and assumed # could never appear in a domain.
296
297 So the old code is now cut out for Release 4.11 onwards, on 09-Aug-02. In a few
298 years, when we are sure this isn't actually causing trouble, throw it away.
299
300 March 2003: the story continues: There is a camp that is arguing for the use of
301 UTF-8 in domain names as the way to internationalization, and other MTAs
302 support this. Therefore, we now have a flag that permits the use of characters
303 with values greater than 127, encoded in UTF-8, in subdomains, so that Exim can
304 be used experimentally in this way. */
305
306 for (;;)
307   {
308   uschar *tsave = t;
309
310 /*********************
311   if (rfc821_domains)
312     {
313     if (*s != '-') while (isalnum(*s) || *s == '-') *t++ = *s++;
314     }
315   else
316     while (!mac_iscntrl_or_special(*s)) *t++ = *s++;
317 *********************/
318
319   if (*s != '-')
320     {
321     /* Only letters, digits, and hyphens */
322
323     if (!allow_utf8_domains)
324       {
325       while (isalnum(*s) || *s == '-') *t++ = *s++;
326       }
327
328     /* Permit legal UTF-8 characters to be included */
329
330     else for(;;)
331       {
332       int i, d;
333       if (isalnum(*s) || *s == '-')    /* legal ascii characters */
334         {
335         *t++ = *s++;
336         continue;
337         }
338       if ((*s & 0xc0) != 0xc0) break;  /* not start of UTF-8 character */
339       d = *s << 2;
340       for (i = 1; i < 6; i++)          /* i is the number of additional bytes */
341         {
342         if ((d & 0x80) == 0) break;
343         d <<= 1;
344         }
345       if (i == 6) goto BAD_UTF8;       /* invalid UTF-8 */
346       *t++ = *s++;                     /* leading UTF-8 byte */
347       while (i-- > 0)                  /* copy and check remainder */
348         {
349         if ((*s & 0xc0) != 0x80)
350           {
351           BAD_UTF8:
352           *errorptr = US"invalid UTF-8 byte sequence";
353           *tt = 0;
354           return s;
355           }
356         *t++ = *s++;
357         }
358       }    /* End of loop for UTF-8 character */
359     }      /* End of subdomain */
360
361   s = skip_comment(s);
362   *t = 0;
363
364   if (t == tsave)   /* empty component */
365     {
366     if (strip_trailing_dot && t > tt && *s != '.') t[-1] = 0; else
367       {
368       *errorptr = US"domain missing or malformed";
369       *tt = 0;
370       }
371     return s;
372     }
373
374   if (*s != '.') break;
375   *t++ = *s++;
376   s = skip_comment(s);
377   }
378
379 return s;
380 }
381
382
383
384 /*************************************************
385 *            Read a local-part                   *
386 *************************************************/
387
388 /* A local-part is a sequence of words, separated by periods. A null word
389 between dots is not strictly allowed but apparently many mailers permit it,
390 so, sigh, better be compatible. Even accept a trailing dot...
391
392 A <word> is either a quoted string, or an <atom>, which is a sequence
393 of any characters except specials, space, and controls. The specials are
394 ( ) < > @ , ; : \ " . [ and ]. In RFC 822, a single quoted character, (a
395 quoted-pair) is not allowed in a word. However, in RFC 821, it is permitted in
396 the local part of an address. Rather than have separate parsing functions for
397 the different cases, take the liberal attitude always. At least one MUA is
398 happy to recognize this case; I don't know how many other programs do.
399
400 Arguments:
401   s           current character pointer
402   t           where to put the local part
403   error       where to point error text
404   allow_null  TRUE if an empty local part is not an error
405
406 Returns:   new character pointer
407 */
408
409 static uschar *
410 read_local_part(uschar *s, uschar *t, uschar **error, BOOL allow_null)
411 {
412 uschar *tt = t;
413 *error = NULL;
414 for (;;)
415   {
416   int c;
417   uschar *tsave = t;
418   s = skip_comment(s);
419
420   /* Handle a quoted string */
421
422   if (*s == '\"')
423     {
424     *t++ = '\"';
425     while ((c = *++s) && c != '\"')
426       {
427       *t++ = c;
428       if (c == '\\' && s[1]) *t++ = *++s;
429       }
430     if (c == '\"')
431       {
432       s++;
433       *t++ = '\"';
434       }
435     else
436       {
437       *error = US"unmatched doublequote in local part";
438       return s;
439       }
440     }
441
442   /* Handle an atom, but allow quoted pairs within it. */
443
444   else while (!mac_iscntrl_or_special(*s) || *s == '\\')
445     {
446     c = *t++ = *s++;
447     if (c == '\\' && *s) *t++ = *s++;
448     }
449
450   /* Terminate the word and skip subsequent comment */
451
452   *t = 0;
453   s = skip_comment(s);
454
455   /* If we have read a null component at this point, give an error unless it is
456   terminated by a dot - an extension to RFC 822 - or if it is the first
457   component of the local part and an empty local part is permitted, in which
458   case just return normally. */
459
460   if (t == tsave && *s != '.')
461     {
462     if (t == tt && !allow_null)
463       *error = US"missing or malformed local part";
464     return s;
465     }
466
467   /* Anything other than a dot terminates the local part. Treat multiple dots
468   as a single dot, as this seems to be a common extension. */
469
470   if (*s != '.') break;
471   do { *t++ = *s++; } while (*s == '.');
472   }
473
474 return s;
475 }
476
477
478 /*************************************************
479 *            Read route part of route-addr       *
480 *************************************************/
481
482 /* The pointer is at the initial "@" on entry. Return it following the
483 terminating colon. Exim no longer supports the use of source routes, but it is
484 required to accept the syntax.
485
486 Arguments:
487   s          current character pointer
488   t          where to put the route
489   errorptr   where to put an error message
490
491 Returns:     new character pointer
492 */
493
494 static uschar *
495 read_route(uschar *s, uschar *t, uschar **errorptr)
496 {
497 BOOL commas = FALSE;
498 *errorptr = NULL;
499
500 while (*s == '@')
501   {
502   *t++ = '@';
503   s = read_domain(s+1, t, errorptr);
504   if (*t == 0) return s;
505   t += Ustrlen((const uschar *)t);
506   if (*s != ',') break;
507   *t++ = *s++;
508   commas = TRUE;
509   s = skip_comment(s);
510   }
511
512 if (*s == ':') *t++ = *s++;
513
514 /* If there is no colon, and there were no commas, the most likely error
515 is in fact a missing local part in the address rather than a missing colon
516 after the route. */
517
518 else *errorptr = commas?
519   US"colon expected after route list" :
520   US"no local part";
521
522 /* Terminate the route and return */
523
524 *t = 0;
525 return skip_comment(s);
526 }
527
528
529
530 /*************************************************
531 *                Read addr-spec                  *
532 *************************************************/
533
534 /* Addr-spec is local-part@domain. We make the domain optional -
535 the expected terminator for the whole thing is passed to check this.
536 This function is called only when we know we have a route-addr.
537
538 Arguments:
539   s          current character pointer
540   t          where to put the addr-spec
541   term       expected terminator (0 or >)
542   errorptr   where to put an error message
543   domainptr  set to point to the start of the domain
544
545 Returns:     new character pointer
546 */
547
548 static uschar *
549 read_addr_spec(uschar *s, uschar *t, int term, uschar **errorptr,
550   uschar **domainptr)
551 {
552 s = read_local_part(s, t, errorptr, FALSE);
553 if (*errorptr == NULL)
554   if (*s != term)
555     if (*s != '@')
556       *errorptr = string_sprintf("\"@\" or \".\" expected after \"%s\"", t);
557     else
558       {
559       t += Ustrlen((const uschar *)t);
560       *t++ = *s++;
561       *domainptr = t;
562       s = read_domain(s, t, errorptr);
563       }
564 return s;
565 }
566
567
568
569 /*************************************************
570 *         Extract operative address              *
571 *************************************************/
572
573 /* This function extracts an operative address from a full RFC822 mailbox and
574 returns it in a piece of dynamic store. We take the easy way and get a piece
575 of store the same size as the input, and then copy into it whatever is
576 necessary. If we cannot find a valid address (syntax error), return NULL, and
577 point the error pointer to the reason. The arguments "start" and "end" are used
578 to return the offsets of the first and one past the last characters in the
579 original mailbox of the address that has been extracted, to aid in re-writing.
580 The argument "domain" is set to point to the first character after "@" in the
581 final part of the returned address, or zero if there is no @.
582
583 Exim no longer supports the use of source routed addresses (those of the form
584 @domain,...:route_addr). It recognizes the syntax, but collapses such addresses
585 down to their final components. Formerly, collapse_source_routes had to be set
586 to achieve this effect. RFC 1123 allows collapsing with MAY, while the revision
587 of RFC 821 had increased this to SHOULD, so I've gone for it, because it makes
588 a lot of code elsewhere in Exim much simpler.
589
590 There are some special fudges here for handling RFC 822 group address notation
591 which may appear in certain headers. If the flag parse_allow_group is set
592 TRUE and parse_found_group is FALSE when this function is called, an address
593 which is the start of a group (i.e. preceded by a phrase and a colon) is
594 recognized; the phrase is ignored and the flag parse_found_group is set. If
595 this flag is TRUE at the end of an address, and if an extraneous semicolon is
596 found, it is ignored and the flag is cleared.
597
598 This logic is used only when scanning through addresses in headers, either to
599 fulfil the -t option, or for rewriting, or for checking header syntax. Because
600 the group "state" has to be remembered between multiple calls of this function,
601 the variables parse_{allow,found}_group are global. It is important to ensure
602 that they are reset to FALSE at the end of scanning a header's list of
603 addresses.
604
605 Arguments:
606   mailbox     points to the RFC822 mailbox
607   errorptr    where to point an error message
608   start       set to start offset in mailbox
609   end         set to end offset in mailbox
610   domain      set to domain offset in result, or 0 if no domain present
611   allow_null  allow <> if TRUE
612
613 Returns:      points to the extracted address, or NULL on error
614 */
615
616 #define FAILED(s) { *errorptr = s; goto PARSE_FAILED; }
617
618 uschar *
619 parse_extract_address(uschar *mailbox, uschar **errorptr, int *start, int *end,
620   int *domain, BOOL allow_null)
621 {
622 uschar *yield = store_get(Ustrlen(mailbox) + 1, is_tainted(mailbox));
623 uschar *startptr, *endptr;
624 uschar *s = US mailbox;
625 uschar *t = US yield;
626
627 *domain = 0;
628
629 /* At the start of the string we expect either an addr-spec or a phrase
630 preceding a <route-addr>. If groups are allowed, we might also find a phrase
631 preceding a colon and an address. If we find an initial word followed by
632 a dot, strict interpretation of the RFC would cause it to be taken
633 as the start of an addr-spec. However, many mailers break the rules
634 and use addresses of the form "a.n.other <ano@somewhere>" and so we
635 allow this case. */
636
637 RESTART:   /* Come back here after passing a group name */
638
639 s = skip_comment(s);
640 startptr = s;                                 /* In case addr-spec */
641 s = read_local_part(s, t, errorptr, TRUE);    /* Dot separated words */
642 if (*errorptr) goto PARSE_FAILED;
643
644 /* If the terminator is neither < nor @ then the format of the address
645 must either be a bare local-part (we are now at the end), or a phrase
646 followed by a route-addr (more words must follow). */
647
648 if (*s != '@' && *s != '<')
649   {
650   if (*s == 0 || *s == ';')
651     {
652     if (*t == 0) FAILED(US"empty address");
653     endptr = last_comment_position;
654     goto PARSE_SUCCEEDED;              /* Bare local part */
655     }
656
657   /* Expect phrase route-addr, or phrase : if groups permitted, but allow
658   dots in the phrase; complete the loop only when '<' or ':' is encountered -
659   end of string will produce a null local_part and therefore fail. We don't
660   need to keep updating t, as the phrase isn't to be kept. */
661
662   while (*s != '<' && (!f.parse_allow_group || *s != ':'))
663     {
664     s = read_local_part(s, t, errorptr, FALSE);
665     if (*errorptr)
666       {
667       *errorptr = string_sprintf("%s (expected word or \"<\")", *errorptr);
668       goto PARSE_FAILED;
669       }
670     }
671
672   if (*s == ':')
673     {
674     f.parse_found_group = TRUE;
675     f.parse_allow_group = FALSE;
676     s++;
677     goto RESTART;
678     }
679
680   /* Assert *s == '<' */
681   }
682
683 /* At this point the next character is either '@' or '<'. If it is '@', only a
684 single local-part has previously been read. An angle bracket signifies the
685 start of an <addr-spec>. Throw away anything we have saved so far before
686 processing it. Note that this is "if" rather than "else if" because it's also
687 used after reading a preceding phrase.
688
689 There are a lot of broken sendmails out there that put additional pairs of <>
690 round <route-addr>s.  If strip_excess_angle_brackets is set, allow a limited
691 number of them, as long as they match. */
692
693 if (*s == '<')
694   {
695   uschar *domainptr = yield;
696   BOOL source_routed = FALSE;
697   int bracket_count = 1;
698
699   s++;
700   if (strip_excess_angle_brackets) while (*s == '<')
701    {
702    if(bracket_count++ > 5) FAILED(US"angle-brackets nested too deep");
703    s++;
704    }
705
706   t = yield;
707   startptr = s;
708   s = skip_comment(s);
709
710   /* Read an optional series of routes, each of which is a domain. They
711   are separated by commas and terminated by a colon. However, we totally ignore
712   such routes (RFC 1123 says we MAY, and the revision of RFC 821 says we
713   SHOULD). */
714
715   if (*s == '@')
716     {
717     s = read_route(s, t, errorptr);
718     if (*errorptr) goto PARSE_FAILED;
719     *t = 0;                  /* Ensure route is ignored - probably overkill */
720     source_routed = TRUE;
721     }
722
723   /* Now an addr-spec, terminated by '>'. If there is no preceding route,
724   we must allow an empty addr-spec if allow_null is TRUE, to permit the
725   address "<>" in some circumstances. A source-routed address MUST have
726   a domain in the final part. */
727
728   if (allow_null && !source_routed && *s == '>')
729     {
730     *t = 0;
731     *errorptr = NULL;
732     }
733   else
734     {
735     s = read_addr_spec(s, t, '>', errorptr, &domainptr);
736     if (*errorptr) goto PARSE_FAILED;
737     *domain = domainptr - yield;
738     if (source_routed && *domain == 0)
739       FAILED(US"domain missing in source-routed address");
740     }
741
742   endptr = s;
743   if (*errorptr != NULL) goto PARSE_FAILED;
744   while (bracket_count-- > 0) if (*s++ != '>')
745     {
746     *errorptr = s[-1] == 0
747       ? US"'>' missing at end of address"
748       : string_sprintf("malformed address: %.32s may not follow %.*s",
749           s-1, (int)(s - US mailbox - 1), mailbox);
750     goto PARSE_FAILED;
751     }
752
753   s = skip_comment(s);
754   }
755
756 /* Hitting '@' after the first local-part means we have definitely got an
757 addr-spec, on a strict reading of the RFC, and the rest of the string
758 should be the domain. However, for flexibility we allow for a route-address
759 not enclosed in <> as well, which is indicated by an empty first local
760 part preceding '@'. The source routing is, however, ignored. */
761
762 else if (*t == 0)
763   {
764   uschar *domainptr = yield;
765   s = read_route(s, t, errorptr);
766   if (*errorptr != NULL) goto PARSE_FAILED;
767   *t = 0;         /* Ensure route is ignored - probably overkill */
768   s = read_addr_spec(s, t, 0, errorptr, &domainptr);
769   if (*errorptr != NULL) goto PARSE_FAILED;
770   *domain = domainptr - yield;
771   endptr = last_comment_position;
772   if (*domain == 0) FAILED(US"domain missing in source-routed address");
773   }
774
775 /* This is the strict case of local-part@domain. */
776
777 else
778   {
779   t += Ustrlen((const uschar *)t);
780   *t++ = *s++;
781   *domain = t - yield;
782   s = read_domain(s, t, errorptr);
783   if (*t == 0) goto PARSE_FAILED;
784   endptr = last_comment_position;
785   }
786
787 /* Use goto to get here from the bare local part case. Arrive by falling
788 through for other cases. Endptr may have been moved over whitespace, so
789 move it back past white space if necessary. */
790
791 PARSE_SUCCEEDED:
792 if (*s != 0)
793   {
794   if (f.parse_found_group && *s == ';')
795     {
796     f.parse_found_group = FALSE;
797     f.parse_allow_group = TRUE;
798     }
799   else
800     {
801     *errorptr = string_sprintf("malformed address: %.32s may not follow %.*s",
802       s, (int)(s - US mailbox), mailbox);
803     goto PARSE_FAILED;
804     }
805   }
806 *start = startptr - US mailbox;      /* Return offsets */
807 while (isspace(endptr[-1])) endptr--;
808 *end = endptr - US mailbox;
809
810 /* Although this code has no limitation on the length of address extracted,
811 other parts of Exim may have limits, and in any case, RFC 2821 limits local
812 parts to 64 and domains to 255, so we do a check here, giving an error if the
813 address is ridiculously long. */
814
815 if (*end - *start > ADDRESS_MAXLENGTH)
816   {
817   *errorptr = string_sprintf("address is ridiculously long: %.64s...", yield);
818   return NULL;
819   }
820
821 return yield;
822
823 /* Use goto (via the macro FAILED) to get to here from a variety of places.
824 We might have an empty address in a group - the caller can choose to ignore
825 this. We must, however, keep the flags correct. */
826
827 PARSE_FAILED:
828 if (f.parse_found_group && *s == ';')
829   {
830   f.parse_found_group = FALSE;
831   f.parse_allow_group = TRUE;
832   }
833 return NULL;
834 }
835
836 #undef FAILED
837
838
839
840 /*************************************************
841 *        Quote according to RFC 2047             *
842 *************************************************/
843
844 /* This function is used for quoting text in headers according to RFC 2047.
845 If the only characters that strictly need quoting are spaces, we return the
846 original string, unmodified.
847
848 Hmmph. As always, things get perverted for other uses. This function was
849 originally for the "phrase" part of addresses. Now it is being used for much
850 longer texts in ACLs and via the ${rfc2047: expansion item. This means we have
851 to check for overlong "encoded-word"s and split them. November 2004.
852
853 Arguments:
854   string       the string to quote - already checked to contain non-printing
855                  chars
856   len          the length of the string
857   charset      the name of the character set; NULL => iso-8859-1
858   fold         if TRUE, a newline is inserted before the separating space when
859                  more than one encoded-word is generated
860
861 Returns:       pointer to the original string, if no quoting needed, or
862                pointer to allocated memory containing the quoted string
863 */
864
865 const uschar *
866 parse_quote_2047(const uschar *string, int len, uschar *charset, BOOL fold)
867 {
868 const uschar * s = string;
869 int hlen, l;
870 BOOL coded = FALSE;
871 BOOL first_byte = FALSE;
872 gstring * g =
873   string_fmt_append(NULL, "=?%s?Q?", charset ? charset : US"iso-8859-1");
874
875 hlen = l = g->ptr;
876
877 for (s = string; len > 0; s++, len--)
878   {
879   int ch = *s;
880
881   if (g->ptr - l > 67 && !first_byte)
882     {
883     g = fold ? string_catn(g, US"?=\n ", 4) : string_catn(g, US"?= ", 3);
884     l = g->ptr;
885     g = string_catn(g, g->s, hlen);
886     }
887
888   if (  ch < 33 || ch > 126
889      || Ustrchr("?=()<>@,;:\\\".[]_", ch) != NULL)
890     {
891     if (ch == ' ')
892       {
893       g = string_catn(g, US"_", 1);
894       first_byte = FALSE;
895       }
896     else
897       {
898       g = string_fmt_append(g, "=%02X", ch);
899       coded = TRUE;
900       first_byte = !first_byte;
901       }
902     }
903   else
904     { g = string_catn(g, s, 1); first_byte = FALSE; }
905   }
906
907 if (coded)
908   string = string_from_gstring(g = string_catn(g, US"?=", 2));
909 else
910   g->ptr = -1;
911
912 gstring_release_unused(g);
913 return string;
914 }
915
916
917
918
919 /*************************************************
920 *            Fix up an RFC 822 "phrase"          *
921 *************************************************/
922
923 /* This function is called to repair any syntactic defects in the "phrase" part
924 of an RFC822 address. In particular, it is applied to the user's name as read
925 from the passwd file when accepting a local message, and to the data from the
926 -F option.
927
928 If the string contains existing quoted strings or comments containing
929 freestanding quotes, then we just quote those bits that need quoting -
930 otherwise it would get awfully messy and probably not look good. If not, we
931 quote the whole thing if necessary. Thus
932
933    John Q. Smith            =>  "John Q. Smith"
934    John "Jack" Smith        =>  John "Jack" Smith
935    John "Jack" Q. Smith     =>  John "Jack" "Q." Smith
936    John (Jack) Q. Smith     =>  "John (Jack) Q. Smith"
937    John ("Jack") Q. Smith   =>  John ("Jack") "Q." Smith
938 but
939    John (\"Jack\") Q. Smith =>  "John (\"Jack\") Q. Smith"
940
941 Sheesh! This is tedious code. It is a great pity that the syntax of RFC822 is
942 the way it is...
943
944 August 2000: Additional code added:
945
946   Previously, non-printing characters were turned into question marks, which do
947   not need to be quoted.
948
949   Now, a different tactic is used if there are any non-printing ASCII
950   characters. The encoding method from RFC 2047 is used, assuming iso-8859-1 as
951   the character set.
952
953   We *could* use this for all cases, getting rid of the messy original code,
954   but leave it for now. It would complicate simple cases like "John Q. Smith".
955
956 The result is passed back in allocated memory.
957
958 Arguments:
959   phrase       an RFC822 phrase
960   len          the length of the phrase
961
962 Returns:       the fixed RFC822 phrase
963 */
964
965 const uschar *
966 parse_fix_phrase(const uschar *phrase, int len)
967 {
968 int ch, i;
969 BOOL quoted = FALSE;
970 const uschar *s, *end;
971 uschar * buffer;
972 uschar *t, *yield;
973
974 while (len > 0 && isspace(*phrase)) { phrase++; len--; }
975
976 /* See if there are any non-printing characters, and if so, use the RFC 2047
977 encoding for the whole thing. */
978
979 for (i = 0, s = phrase; i < len; i++, s++)
980   if ((*s < 32 && *s != '\t') || *s > 126) break;
981
982 if (i < len)
983   return parse_quote_2047(phrase, len, headers_charset, FALSE);
984
985 /* No non-printers; use the RFC 822 quoting rules */
986
987 buffer = store_get(len*4, is_tainted(phrase));
988
989 s = phrase;
990 end = s + len;
991 yield = t = buffer + 1;
992
993 while (s < end)
994   {
995   ch = *s++;
996
997   /* Copy over quoted strings, remembering we encountered one */
998
999   if (ch == '\"')
1000     {
1001     *t++ = '\"';
1002     while (s < end && (ch = *s++) != '\"')
1003       {
1004       *t++ = ch;
1005       if (ch == '\\' && s < end) *t++ = *s++;
1006       }
1007     *t++ = '\"';
1008     if (s >= end) break;
1009     quoted = TRUE;
1010     }
1011
1012   /* Copy over comments, noting if they contain freestanding quote
1013   characters */
1014
1015   else if (ch == '(')
1016     {
1017     int level = 1;
1018     *t++ = '(';
1019     while (s < end)
1020       {
1021       ch = *s++;
1022       *t++ = ch;
1023       if (ch == '(') level++;
1024       else if (ch == ')') { if (--level <= 0) break; }
1025       else if (ch == '\\' && s < end) *t++ = *s++ & 127;
1026       else if (ch == '\"') quoted = TRUE;
1027       }
1028     if (ch == 0)
1029       {
1030       while (level--) *t++ = ')';
1031       break;
1032       }
1033     }
1034
1035   /* Handle special characters that need to be quoted */
1036
1037   else if (Ustrchr(")<>@,;:\\.[]", ch) != NULL)
1038     {
1039     /* If hit previous quotes just make one quoted "word" */
1040
1041     if (quoted)
1042       {
1043       uschar *tt = t++;
1044       while (*(--tt) != ' ' && *tt != '\"' && *tt != ')') tt[1] = *tt;
1045       tt[1] = '\"';
1046       *t++ = ch;
1047       while (s < end)
1048         {
1049         ch = *s++;
1050         if (ch == ' ' || ch == '\"') { s--; break; } else *t++ = ch;
1051         }
1052       *t++ = '\"';
1053       }
1054
1055     /* Else quote the whole string so far, and the rest up to any following
1056     quotes. We must treat anything following a backslash as a literal. */
1057
1058     else
1059       {
1060       BOOL escaped = (ch == '\\');
1061       *(--yield) = '\"';
1062       *t++ = ch;
1063
1064       /* Now look for the end or a quote */
1065
1066       while (s < end)
1067         {
1068         ch = *s++;
1069
1070         /* Handle escaped pairs */
1071
1072         if (escaped)
1073           {
1074           *t++ = ch;
1075           escaped = FALSE;
1076           }
1077
1078         else if (ch == '\\')
1079           {
1080           *t++ = ch;
1081           escaped = TRUE;
1082           }
1083
1084         /* If hit subsequent quotes, insert our quote before any trailing
1085         spaces and back up to re-handle the quote in the outer loop. */
1086
1087         else if (ch == '\"')
1088           {
1089           int count = 0;
1090           while (t[-1] == ' ') { t--; count++; }
1091           *t++ = '\"';
1092           while (count-- > 0) *t++ = ' ';
1093           s--;
1094           break;
1095           }
1096
1097         /* If hit a subsequent comment, check it for unescaped quotes,
1098         and if so, end our quote before it. */
1099
1100         else if (ch == '(')
1101           {
1102           const uschar *ss = s;     /* uschar after '(' */
1103           int level = 1;
1104           while(ss < end)
1105             {
1106             ch = *ss++;
1107             if (ch == '(') level++;
1108             else if (ch == ')') { if (--level <= 0) break; }
1109             else if (ch == '\\' && ss+1 < end) ss++;
1110             else if (ch == '\"') { quoted = TRUE; break; }
1111             }
1112
1113           /* Comment contains unescaped quotes; end our quote before
1114           the start of the comment. */
1115
1116           if (quoted)
1117             {
1118             int count = 0;
1119             while (t[-1] == ' ') { t--; count++; }
1120             *t++ = '\"';
1121             while (count-- > 0) *t++ = ' ';
1122             break;
1123             }
1124
1125           /* Comment does not contain unescaped quotes; include it in
1126           our quote. */
1127
1128           else
1129             {
1130             if (ss >= end) ss--;
1131             *t++ = '(';
1132             Ustrncpy(t, s, ss-s);
1133             t += ss-s;
1134             s = ss;
1135             }
1136           }
1137
1138         /* Not a comment or quote; include this character in our quotes. */
1139
1140         else *t++ = ch;
1141         }
1142       }
1143
1144     /* Add a final quote if we hit the end of the string. */
1145
1146     if (s >= end) *t++ = '\"';
1147     }
1148
1149   /* Non-special character; just copy it over */
1150
1151   else *t++ = ch;
1152   }
1153
1154 *t = 0;
1155 store_release_above(t+1);
1156 return yield;
1157 }
1158
1159
1160 /*************************************************
1161 *          Extract addresses from a list         *
1162 *************************************************/
1163
1164 /* This function is called by the redirect router to scan a string containing a
1165 list of addresses separated by commas (with optional white space) or by
1166 newlines, and to generate a chain of address items from them. In other words,
1167 to unpick data from an alias or .forward file.
1168
1169 The SunOS5 documentation for alias files is not very clear on the syntax; it
1170 does not say that either a comma or a newline can be used for separation.
1171 However, that is the way Smail does it, so we follow suit.
1172
1173 If a # character is encountered in a white space position, then characters from
1174 there to the next newline are skipped.
1175
1176 If an unqualified address begins with '\', just skip that character. This gives
1177 compatibility with Sendmail's use of \ to prevent looping. Exim has its own
1178 loop prevention scheme which handles other cases too - see the code in
1179 route_address().
1180
1181 An "address" can be a specification of a file or a pipe; the latter may often
1182 need to be quoted because it may contain spaces, but we don't want to retain
1183 the quotes. Quotes may appear in normal addresses too, and should be retained.
1184 We can distinguish between these cases, because in addresses, quotes are used
1185 only for parts of the address, not the whole thing. Therefore, we remove quotes
1186 from items when they entirely enclose them, but not otherwise.
1187
1188 An "address" can also be of the form :include:pathname to include a list of
1189 addresses contained in the specified file.
1190
1191 Any unqualified addresses are qualified with and rewritten if necessary, via
1192 the rewrite_address() function.
1193
1194 Arguments:
1195   s                the list of addresses (typically a complete
1196                      .forward file or a list of entries in an alias file)
1197   options          option bits for permitting or denying various special cases;
1198                      not all bits are relevant here - some are for filter
1199                      files; those we use here are:
1200                        RDO_DEFER
1201                        RDO_FREEZE
1202                        RDO_FAIL
1203                        RDO_BLACKHOLE
1204                        RDO_REWRITE
1205                        RDO_INCLUDE
1206   anchor           where to hang the chain of newly-created addresses. This
1207                      should be initialized to NULL.
1208   error            where to return an error text
1209   incoming domain  domain of the incoming address; used to qualify unqualified
1210                      local parts preceded by \
1211   directory        if NULL, no checks are done on :include: files
1212                    otherwise, included file names must start with the given
1213                      directory
1214   syntax_errors    if not NULL, it carries on after syntax errors in addresses,
1215                      building up a list of errors as error blocks chained on
1216                      here.
1217
1218 Returns:      FF_DELIVERED      addresses extracted
1219               FF_NOTDELIVERED   no addresses extracted, but no errors
1220               FF_BLACKHOLE      :blackhole:
1221               FF_DEFER          :defer:
1222               FF_FAIL           :fail:
1223               FF_INCLUDEFAIL    some problem with :include:; *error set
1224               FF_ERROR          other problems; *error is set
1225 */
1226
1227 int
1228 parse_forward_list(uschar *s, int options, address_item **anchor,
1229   uschar **error, const uschar *incoming_domain, uschar *directory,
1230   error_block **syntax_errors)
1231 {
1232 int count = 0;
1233
1234 DEBUG(D_route) debug_printf("parse_forward_list: %s\n", s);
1235
1236 for (;;)
1237   {
1238   int len;
1239   int special = 0;
1240   int specopt = 0;
1241   int specbit = 0;
1242   uschar *ss, *nexts;
1243   address_item *addr;
1244   BOOL inquote = FALSE;
1245
1246   for (;;)
1247     {
1248     while (isspace(*s) || *s == ',') s++;
1249     if (*s == '#') { while (*s != 0 && *s != '\n') s++; } else break;
1250     }
1251
1252   /* When we reach the end of the list, we return FF_DELIVERED if any child
1253   addresses have been generated. If nothing has been generated, there are two
1254   possibilities: either the list is really empty, or there were syntax errors
1255   that are being skipped. (If syntax errors are not being skipped, an FF_ERROR
1256   return is generated on hitting a syntax error and we don't get here.) For a
1257   truly empty list we return FF_NOTDELIVERED so that the router can decline.
1258   However, if the list is empty only because syntax errors were skipped, we
1259   return FF_DELIVERED. */
1260
1261   if (!*s)
1262     {
1263     return (count > 0 || (syntax_errors && *syntax_errors))
1264       ?  FF_DELIVERED : FF_NOTDELIVERED;
1265
1266     /* This previous code returns FF_ERROR if nothing is generated but a
1267     syntax error has been skipped. I now think it is the wrong approach, but
1268     have left this here just in case, and for the record. */
1269
1270     #ifdef NEVER
1271     if (count > 0) return FF_DELIVERED;   /* Something was generated */
1272
1273     if (syntax_errors == NULL ||          /* Not skipping syntax errors, or */
1274        *syntax_errors == NULL)            /*   we didn't actually skip any */
1275       return FF_NOTDELIVERED;
1276
1277     *error = string_sprintf("no addresses generated: syntax error in %s: %s",
1278        (*syntax_errors)->text2, (*syntax_errors)->text1);
1279     return FF_ERROR;
1280     #endif
1281
1282     }
1283
1284   /* Find the end of the next address. Quoted strings in addresses may contain
1285   escaped characters; I haven't found a proper specification of .forward or
1286   alias files that mentions the quoting properties, but it seems right to do
1287   the escaping thing in all cases, so use the function that finds the end of an
1288   address. However, don't let a quoted string extend over the end of a line. */
1289
1290   ss = parse_find_address_end(s, TRUE);
1291
1292   /* Remember where we finished, for starting the next one. */
1293
1294   nexts = ss;
1295
1296   /* Remove any trailing spaces; we know there's at least one non-space. */
1297
1298   while (isspace((ss[-1]))) ss--;
1299
1300   /* We now have s->start and ss->end of the next address. Remove quotes
1301   if they completely enclose, remembering the address started with a quote
1302   for handling pipes and files. Another round of removal of leading and
1303   trailing spaces is then required. */
1304
1305   if (*s == '\"' && ss[-1] == '\"')
1306     {
1307     s++;
1308     ss--;
1309     inquote = TRUE;
1310     while (s < ss && isspace(*s)) s++;
1311     while (ss > s && isspace((ss[-1]))) ss--;
1312     }
1313
1314   /* Set up the length of the address. */
1315
1316   len = ss - s;
1317
1318   DEBUG(D_route)
1319     {
1320     int save = s[len];
1321     s[len] = 0;
1322     debug_printf("extract item: %s\n", s);
1323     s[len] = save;
1324     }
1325
1326   /* Handle special addresses if permitted. If the address is :unknown:
1327   ignore it - this is for backward compatibility with old alias files. You
1328   don't need to use it nowadays - just generate an empty string. For :defer:,
1329   :blackhole:, or :fail: we have to set up the error message and give up right
1330   away. */
1331
1332   if (Ustrncmp(s, ":unknown:", len) == 0)
1333     {
1334     s = nexts;
1335     continue;
1336     }
1337
1338   if      (Ustrncmp(s, ":defer:", 7) == 0)
1339     { special = FF_DEFER; specopt = RDO_DEFER; }  /* specbit is 0 */
1340   else if (Ustrncmp(s, ":blackhole:", 11) == 0)
1341     { special = FF_BLACKHOLE; specopt = specbit = RDO_BLACKHOLE; }
1342   else if (Ustrncmp(s, ":fail:", 6) == 0)
1343     { special = FF_FAIL; specopt = RDO_FAIL; }  /* specbit is 0 */
1344
1345   if (special != 0)
1346     {
1347     uschar *ss = Ustrchr(s+1, ':') + 1;
1348     if ((options & specopt) == specbit)
1349       {
1350       *error = string_sprintf("\"%.*s\" is not permitted", len, s);
1351       return FF_ERROR;
1352       }
1353     while (*ss != 0 && isspace(*ss)) ss++;
1354     while (s[len] != 0 && s[len] != '\n') len++;
1355     s[len] = 0;
1356     *error = string_copy(ss);
1357     return special;
1358     }
1359
1360   /* If the address is of the form :include:pathname, read the file, and call
1361   this function recursively to extract the addresses from it. If directory is
1362   NULL, do no checks. Otherwise, insist that the file name starts with the
1363   given directory and is a regular file. */
1364
1365   if (Ustrncmp(s, ":include:", 9) == 0)
1366     {
1367     uschar *filebuf;
1368     uschar filename[256];
1369     uschar *t = s+9;
1370     int flen = len - 9;
1371     int frc;
1372     struct stat statbuf;
1373     address_item *last;
1374     FILE *f;
1375
1376     while (flen > 0 && isspace(*t)) { t++; flen--; }
1377
1378     if (flen <= 0)
1379       {
1380       *error = US"file name missing after :include:";
1381       return FF_ERROR;
1382       }
1383
1384     if (flen > 255)
1385       {
1386       *error = string_sprintf("included file name \"%s\" is too long", t);
1387       return FF_ERROR;
1388       }
1389
1390     Ustrncpy(filename, t, flen);
1391     filename[flen] = 0;
1392
1393     /* Insist on absolute path */
1394
1395     if (filename[0] != '/')
1396       {
1397       *error = string_sprintf("included file \"%s\" is not an absolute path",
1398         filename);
1399       return FF_ERROR;
1400       }
1401
1402     /* Check if include is permitted */
1403
1404     if (options & RDO_INCLUDE)
1405       {
1406       *error = US"included files not permitted";
1407       return FF_ERROR;
1408       }
1409
1410     if (is_tainted(filename))
1411       {
1412       *error = string_sprintf("Tainted name '%s' for included file  not permitted\n",
1413        filename);
1414       return FF_ERROR;
1415       }
1416
1417     /* Check file name if required */
1418
1419     if (directory)
1420       {
1421       int len = Ustrlen(directory);
1422       uschar *p = filename + len;
1423
1424       if (Ustrncmp(filename, directory, len) != 0 || *p != '/')
1425         {
1426         *error = string_sprintf("included file %s is not in directory %s",
1427           filename, directory);
1428         return FF_ERROR;
1429         }
1430
1431 #ifdef EXIM_HAVE_OPENAT
1432       /* It is necessary to check that every component inside the directory
1433       is NOT a symbolic link, in order to keep the file inside the directory.
1434       This is mighty tedious. We open the directory and openat every component,
1435       with a flag that fails symlinks. */
1436
1437       {
1438       int fd = exim_open2(CS directory, O_RDONLY);
1439       if (fd < 0)
1440         {
1441         *error = string_sprintf("failed to open directory %s", directory);
1442         return FF_ERROR;
1443         }
1444       while (*p)
1445         {
1446         uschar temp;
1447         int fd2;
1448         uschar * q = p;
1449
1450         while (*++p && *p != '/') ;
1451         temp = *p;
1452         *p = '\0';
1453
1454         fd2 = exim_openat(fd, CS q, O_RDONLY|O_NOFOLLOW);
1455         close(fd);
1456         *p = temp;
1457         if (fd2 < 0)
1458           {
1459           *error = string_sprintf("failed to open %s (component of included "
1460             "file); could be symbolic link", filename);
1461           return FF_ERROR;
1462           }
1463         fd = fd2;
1464         }
1465       f = fdopen(fd, "rb");
1466       }
1467 #else
1468       /* It is necessary to check that every component inside the directory
1469       is NOT a symbolic link, in order to keep the file inside the directory.
1470       This is mighty tedious. It is also not totally foolproof in that it
1471       leaves the possibility of a race attack, but I don't know how to do
1472       any better. */
1473
1474       while (*p)
1475         {
1476         int temp;
1477         while (*++p && *p != '/');
1478         temp = *p;
1479         *p = 0;
1480         if (Ulstat(filename, &statbuf) != 0)
1481           {
1482           *error = string_sprintf("failed to stat %s (component of included "
1483             "file)", filename);
1484           *p = temp;
1485           return FF_ERROR;
1486           }
1487
1488         *p = temp;
1489
1490         if ((statbuf.st_mode & S_IFMT) == S_IFLNK)
1491           {
1492           *error = string_sprintf("included file %s in the %s directory "
1493             "involves a symbolic link", filename, directory);
1494           return FF_ERROR;
1495           }
1496         }
1497 #endif
1498       }
1499
1500 #ifdef EXIM_HAVE_OPENAT
1501     else
1502 #endif
1503       /* Open and stat the file */
1504       f = Ufopen(filename, "rb");
1505
1506     if (!f)
1507       {
1508       *error = string_open_failed("included file %s", filename);
1509       return FF_INCLUDEFAIL;
1510       }
1511
1512     if (fstat(fileno(f), &statbuf) != 0)
1513       {
1514       *error = string_sprintf("failed to stat included file %s: %s",
1515         filename, strerror(errno));
1516       (void)fclose(f);
1517       return FF_INCLUDEFAIL;
1518       }
1519
1520     /* If directory was checked, double check that we opened a regular file */
1521
1522     if (directory && (statbuf.st_mode & S_IFMT) != S_IFREG)
1523       {
1524       *error = string_sprintf("included file %s is not a regular file in "
1525         "the %s directory", filename, directory);
1526       return FF_ERROR;
1527       }
1528
1529     /* Get a buffer and read the contents */
1530
1531     if (statbuf.st_size > MAX_INCLUDE_SIZE)
1532       {
1533       *error = string_sprintf("included file %s is too big (max %d)",
1534         filename, MAX_INCLUDE_SIZE);
1535       return FF_ERROR;
1536       }
1537
1538     filebuf = store_get(statbuf.st_size + 1, is_tainted(filename));
1539     if (fread(filebuf, 1, statbuf.st_size, f) != statbuf.st_size)
1540       {
1541       *error = string_sprintf("error while reading included file %s: %s",
1542         filename, strerror(errno));
1543       (void)fclose(f);
1544       return FF_ERROR;
1545       }
1546     filebuf[statbuf.st_size] = 0;
1547     (void)fclose(f);
1548
1549     addr = NULL;
1550     frc = parse_forward_list(filebuf, options, &addr,
1551       error, incoming_domain, directory, syntax_errors);
1552     if (frc != FF_DELIVERED && frc != FF_NOTDELIVERED) return frc;
1553
1554     if (addr)
1555       {
1556       for (last = addr; last->next; last = last->next) count++;
1557       last->next = *anchor;
1558       *anchor = addr;
1559       count++;
1560       }
1561     }
1562
1563   /* Else (not :include:) ensure address is syntactically correct and fully
1564   qualified if not a pipe or a file, removing a leading \ if present on an
1565   unqualified address. For pipes and files we must handle quoting. It's
1566   not quite clear exactly what to do for partially quoted things, but the
1567   common case of having the whole thing in quotes is straightforward. If this
1568   was the case, inquote will have been set TRUE above and the quotes removed.
1569
1570   There is a possible ambiguity over addresses whose local parts start with
1571   a vertical bar or a slash, and the latter do in fact occur, thanks to X.400.
1572   Consider a .forward file that contains the line
1573
1574      /X=xxx/Y=xxx/OU=xxx/@some.gate.way
1575
1576   Is this a file or an X.400 address? Does it make any difference if it is in
1577   quotes? On the grounds that file names of this type are rare, Exim treats
1578   something that parses as an RFC 822 address and has a domain as an address
1579   rather than a file or a pipe. This is also how an address such as the above
1580   would be treated if it came in from outside. */
1581
1582   else
1583     {
1584     int start, end, domain;
1585     uschar *recipient = NULL;
1586     int save = s[len];
1587     s[len] = 0;
1588
1589     /* If it starts with \ and the rest of it parses as a valid mail address
1590     without a domain, carry on with that address, but qualify it with the
1591     incoming domain. Otherwise arrange for the address to fall through,
1592     causing an error message on the re-parse. */
1593
1594     if (*s == '\\')
1595       {
1596       recipient =
1597         parse_extract_address(s+1, error, &start, &end, &domain, FALSE);
1598       if (recipient)
1599         recipient = domain != 0 ? NULL :
1600           string_sprintf("%s@%s", recipient, incoming_domain);
1601       }
1602
1603     /* Try parsing the item as an address. */
1604
1605     if (!recipient) recipient =
1606       parse_extract_address(s, error, &start, &end, &domain, FALSE);
1607
1608     /* If item starts with / or | and is not a valid address, or there
1609     is no domain, treat it as a file or pipe. If it was a quoted item,
1610     remove the quoting occurrences of \ within it. */
1611
1612     if ((*s == '|' || *s == '/') && (recipient == NULL || domain == 0))
1613       {
1614       uschar *t = store_get(Ustrlen(s) + 1, is_tainted(s));
1615       uschar *p = t;
1616       uschar *q = s;
1617       while (*q != 0)
1618         {
1619         if (inquote)
1620           {
1621           *p++ = (*q == '\\')? *(++q) : *q;
1622           q++;
1623           }
1624         else *p++ = *q++;
1625         }
1626       *p = 0;
1627       addr = deliver_make_addr(t, TRUE);
1628       setflag(addr, af_pfr);                   /* indicates pipe/file/reply */
1629       if (*s != '|') setflag(addr, af_file);   /* indicates file */
1630       }
1631
1632     /* Item must be an address. Complain if not, else qualify, rewrite and set
1633     up the control block. It appears that people are in the habit of using
1634     empty addresses but with comments as a way of putting comments into
1635     alias and forward files. Therefore, ignore the error "empty address".
1636     Mailing lists might want to tolerate syntax errors; there is therefore
1637     an option to do so. */
1638
1639     else
1640       {
1641       if (recipient == NULL)
1642         {
1643         if (Ustrcmp(*error, "empty address") == 0)
1644           {
1645           *error = NULL;
1646           s[len] = save;
1647           s = nexts;
1648           continue;
1649           }
1650
1651         if (syntax_errors != NULL)
1652           {
1653           error_block *e = store_get(sizeof(error_block), FALSE);
1654           error_block *last = *syntax_errors;
1655           if (last == NULL) *syntax_errors = e; else
1656             {
1657             while (last->next != NULL) last = last->next;
1658             last->next = e;
1659             }
1660           e->next = NULL;
1661           e->text1 = *error;
1662           e->text2 = string_copy(s);
1663           s[len] = save;
1664           s = nexts;
1665           continue;
1666           }
1667         else
1668           {
1669           *error = string_sprintf("%s in \"%s\"", *error, s);
1670           s[len] = save;   /* _after_ using it for *error */
1671           return FF_ERROR;
1672           }
1673         }
1674
1675       /* Address was successfully parsed. Rewrite, and then make an address
1676       block. */
1677
1678       recipient = ((options & RDO_REWRITE) != 0)?
1679         rewrite_address(recipient, TRUE, FALSE, global_rewrite_rules,
1680           rewrite_existflags) :
1681         rewrite_address_qualify(recipient, TRUE);
1682       addr = deliver_make_addr(recipient, TRUE);  /* TRUE => copy recipient */
1683       }
1684
1685     /* Restore the final character in the original data, and add to the
1686     output chain. */
1687
1688     s[len] = save;
1689     addr->next = *anchor;
1690     *anchor = addr;
1691     count++;
1692     }
1693
1694   /* Advance pointer for the next address */
1695
1696   s = nexts;
1697   }
1698 }
1699
1700
1701 /*************************************************
1702 *            Extract a Message-ID                *
1703 *************************************************/
1704
1705 /* This function is used to extract message ids from In-Reply-To: and
1706 References: header lines.
1707
1708 Arguments:
1709   str          pointer to the start of the message-id
1710   yield        put pointer to the message id (in dynamic memory) here
1711   error        put error message here on failure
1712
1713 Returns:       points after the processed message-id or NULL on error
1714 */
1715
1716 uschar *
1717 parse_message_id(uschar *str, uschar **yield, uschar **error)
1718 {
1719 uschar *domain = NULL;
1720 uschar *id;
1721 rmark reset_point;
1722
1723 str = skip_comment(str);
1724 if (*str != '<')
1725   {
1726   *error = US"Missing '<' before message-id";
1727   return NULL;
1728   }
1729
1730 /* Getting a block the size of the input string will definitely be sufficient
1731 for the answer, but it may also be very long if we are processing a header
1732 line. Therefore, take care to release unwanted store afterwards. */
1733
1734 reset_point = store_mark();
1735 id = *yield = store_get(Ustrlen(str) + 1, is_tainted(str));
1736 *id++ = *str++;
1737
1738 str = read_addr_spec(str, id, '>', error, &domain);
1739
1740 if (!*error)
1741   {
1742   if (*str != '>') *error = US"Missing '>' after message-id";
1743     else if (domain == NULL) *error = US"domain missing in message-id";
1744   }
1745
1746 if (*error)
1747   {
1748   store_reset(reset_point);
1749   return NULL;
1750   }
1751
1752 while (*id) id++;
1753 *id++ = *str++;
1754 *id++ = 0;
1755 store_release_above(id);
1756
1757 str = skip_comment(str);
1758 return str;
1759 }
1760
1761
1762 /*************************************************
1763 *        Parse a fixed digit number              *
1764 *************************************************/
1765
1766 /* Parse a string containing an ASCII encoded fixed digits number
1767
1768 Arguments:
1769   str          pointer to the start of the ASCII encoded number
1770   n            pointer to the resulting value
1771   digits       number of required digits
1772
1773 Returns:       points after the processed date or NULL on error
1774 */
1775
1776 static uschar *
1777 parse_number(uschar *str, int *n, int digits)
1778 {
1779   *n=0;
1780   while (digits--)
1781   {
1782     if (*str<'0' || *str>'9') return NULL;
1783     *n=10*(*n)+(*str++-'0');
1784   }
1785   return str;
1786 }
1787
1788
1789 /*************************************************
1790 *        Parse a RFC 2822 day of week            *
1791 *************************************************/
1792
1793 /* Parse the day of the week from a RFC 2822 date, but do not
1794    decode it, because it is only for humans.
1795
1796 Arguments:
1797   str          pointer to the start of the day of the week
1798
1799 Returns:       points after the parsed day or NULL on error
1800 */
1801
1802 static uschar *
1803 parse_day_of_week(uschar *str)
1804 {
1805 /*
1806 day-of-week     =       ([FWS] day-name) / obs-day-of-week
1807
1808 day-name        =       "Mon" / "Tue" / "Wed" / "Thu" /
1809                         "Fri" / "Sat" / "Sun"
1810
1811 obs-day-of-week =       [CFWS] day-name [CFWS]
1812 */
1813
1814 static const uschar *day_name[7]={ US"mon", US"tue", US"wed", US"thu", US"fri", US"sat", US"sun" };
1815 int i;
1816 uschar day[4];
1817
1818 str=skip_comment(str);
1819 for (i=0; i<3; ++i)
1820   {
1821   if ((day[i]=tolower(*str))=='\0') return NULL;
1822   ++str;
1823   }
1824 day[3]='\0';
1825 for (i=0; i<7; ++i) if (Ustrcmp(day,day_name[i])==0) break;
1826 if (i==7) return NULL;
1827 str=skip_comment(str);
1828 return str;
1829 }
1830
1831
1832 /*************************************************
1833 *            Parse a RFC 2822 date               *
1834 *************************************************/
1835
1836 /* Parse the date part of a RFC 2822 date-time, extracting the
1837    day, month and year.
1838
1839 Arguments:
1840   str          pointer to the start of the date
1841   d            pointer to the resulting day
1842   m            pointer to the resulting month
1843   y            pointer to the resulting year
1844
1845 Returns:       points after the processed date or NULL on error
1846 */
1847
1848 static uschar *
1849 parse_date(uschar *str, int *d, int *m, int *y)
1850 {
1851 /*
1852 date            =       day month year
1853
1854 year            =       4*DIGIT / obs-year
1855
1856 obs-year        =       [CFWS] 2*DIGIT [CFWS]
1857
1858 month           =       (FWS month-name FWS) / obs-month
1859
1860 month-name      =       "Jan" / "Feb" / "Mar" / "Apr" /
1861                         "May" / "Jun" / "Jul" / "Aug" /
1862                         "Sep" / "Oct" / "Nov" / "Dec"
1863
1864 obs-month       =       CFWS month-name CFWS
1865
1866 day             =       ([FWS] 1*2DIGIT) / obs-day
1867
1868 obs-day         =       [CFWS] 1*2DIGIT [CFWS]
1869 */
1870
1871 uschar *c,*n;
1872 static const uschar *month_name[]={ US"jan", US"feb", US"mar", US"apr", US"may", US"jun", US"jul", US"aug", US"sep", US"oct", US"nov", US"dec" };
1873 int i;
1874 uschar month[4];
1875
1876 str=skip_comment(str);
1877 if ((str=parse_number(str,d,1))==NULL) return NULL;
1878 if (*str>='0' && *str<='9') *d=10*(*d)+(*str++-'0');
1879 c=skip_comment(str);
1880 if (c==str) return NULL;
1881 else str=c;
1882 for (i=0; i<3; ++i) if ((month[i]=tolower(*(str+i)))=='\0') return NULL;
1883 month[3]='\0';
1884 for (i=0; i<12; ++i) if (Ustrcmp(month,month_name[i])==0) break;
1885 if (i==12) return NULL;
1886 str+=3;
1887 *m=i;
1888 c=skip_comment(str);
1889 if (c==str) return NULL;
1890 else str=c;
1891 if ((n=parse_number(str,y,4)))
1892   {
1893   str=n;
1894   if (*y<1900) return NULL;
1895   *y=*y-1900;
1896   }
1897 else if ((n=parse_number(str,y,2)))
1898   {
1899   str=skip_comment(n);
1900   while (*(str-1)==' ' || *(str-1)=='\t') --str; /* match last FWS later */
1901   if (*y<50) *y+=100;
1902   }
1903 else return NULL;
1904 return str;
1905 }
1906
1907
1908 /*************************************************
1909 *            Parse a RFC 2822 Time               *
1910 *************************************************/
1911
1912 /* Parse the time part of a RFC 2822 date-time, extracting the
1913    hour, minute, second and timezone.
1914
1915 Arguments:
1916   str          pointer to the start of the time
1917   h            pointer to the resulting hour
1918   m            pointer to the resulting minute
1919   s            pointer to the resulting second
1920   z            pointer to the resulting timezone (offset in seconds)
1921
1922 Returns:       points after the processed time or NULL on error
1923 */
1924
1925 static uschar *
1926 parse_time(uschar *str, int *h, int *m, int *s, int *z)
1927 {
1928 /*
1929 time            =       time-of-day FWS zone
1930
1931 time-of-day     =       hour ":" minute [ ":" second ]
1932
1933 hour            =       2DIGIT / obs-hour
1934
1935 obs-hour        =       [CFWS] 2DIGIT [CFWS]
1936
1937 minute          =       2DIGIT / obs-minute
1938
1939 obs-minute      =       [CFWS] 2DIGIT [CFWS]
1940
1941 second          =       2DIGIT / obs-second
1942
1943 obs-second      =       [CFWS] 2DIGIT [CFWS]
1944
1945 zone            =       (( "+" / "-" ) 4DIGIT) / obs-zone
1946
1947 obs-zone        =       "UT" / "GMT" /          ; Universal Time
1948                                                 ; North American UT
1949                                                 ; offsets
1950                         "EST" / "EDT" /         ; Eastern:  - 5/ - 4
1951                         "CST" / "CDT" /         ; Central:  - 6/ - 5
1952                         "MST" / "MDT" /         ; Mountain: - 7/ - 6
1953                         "PST" / "PDT" /         ; Pacific:  - 8/ - 7
1954
1955                         %d65-73 /               ; Military zones - "A"
1956                         %d75-90 /               ; through "I" and "K"
1957                         %d97-105 /              ; through "Z", both
1958                         %d107-122               ; upper and lower case
1959 */
1960
1961 uschar *c;
1962
1963 str=skip_comment(str);
1964 if ((str=parse_number(str,h,2))==NULL) return NULL;
1965 str=skip_comment(str);
1966 if (*str!=':') return NULL;
1967 ++str;
1968 str=skip_comment(str);
1969 if ((str=parse_number(str,m,2))==NULL) return NULL;
1970 c=skip_comment(str);
1971 if (*str==':')
1972   {
1973   ++str;
1974   str=skip_comment(str);
1975   if ((str=parse_number(str,s,2))==NULL) return NULL;
1976   c=skip_comment(str);
1977   }
1978 if (c==str) return NULL;
1979 else str=c;
1980 if (*str=='+' || *str=='-')
1981   {
1982   int neg;
1983
1984   neg=(*str=='-');
1985   ++str;
1986   if ((str=parse_number(str,z,4))==NULL) return NULL;
1987   *z=(*z/100)*3600+(*z%100)*60;
1988   if (neg) *z=-*z;
1989   }
1990 else
1991   {
1992   char zone[5];
1993   struct { const char *name; int off; } zone_name[10]=
1994   { {"gmt",0}, {"ut",0}, {"est",-5}, {"edt",-4}, {"cst",-6}, {"cdt",-5}, {"mst",-7}, {"mdt",-6}, {"pst",-8}, {"pdt",-7}};
1995   int i,j;
1996
1997   for (i=0; i<4; ++i)
1998     {
1999     zone[i]=tolower(*(str+i));
2000     if (zone[i]<'a' || zone[i]>'z') break;
2001     }
2002   zone[i]='\0';
2003   for (j=0; j<10 && strcmp(zone,zone_name[j].name); ++j);
2004   /* Besides zones named in the grammar, RFC 2822 says other alphabetic */
2005   /* time zones should be treated as unknown offsets. */
2006   if (j<10)
2007     {
2008     *z=zone_name[j].off*3600;
2009     str+=i;
2010     }
2011   else if (zone[0]<'a' || zone[1]>'z') return 0;
2012   else
2013     {
2014     while ((*str>='a' && *str<='z') || (*str>='A' && *str<='Z')) ++str;
2015     *z=0;
2016     }
2017   }
2018 return str;
2019 }
2020
2021
2022 /*************************************************
2023 *          Parse a RFC 2822 date-time            *
2024 *************************************************/
2025
2026 /* Parse a RFC 2822 date-time and return it in seconds since the epoch.
2027
2028 Arguments:
2029   str          pointer to the start of the date-time
2030   t            pointer to the parsed time
2031
2032 Returns:       points after the processed date-time or NULL on error
2033 */
2034
2035 uschar *
2036 parse_date_time(uschar *str, time_t *t)
2037 {
2038 /*
2039 date-time       =       [ day-of-week "," ] date FWS time [CFWS]
2040 */
2041
2042 struct tm tm;
2043 int zone;
2044 extern char **environ;
2045 char **old_environ;
2046 static char gmt0[]="TZ=GMT0";
2047 static char *gmt_env[]={ gmt0, (char*)0 };
2048 uschar *try;
2049
2050 if ((try=parse_day_of_week(str)))
2051   {
2052   str=try;
2053   if (*str!=',') return 0;
2054   ++str;
2055   }
2056 if ((str=parse_date(str,&tm.tm_mday,&tm.tm_mon,&tm.tm_year))==NULL) return NULL;
2057 if (*str!=' ' && *str!='\t') return NULL;
2058 while (*str==' ' || *str=='\t') ++str;
2059 if ((str=parse_time(str,&tm.tm_hour,&tm.tm_min,&tm.tm_sec,&zone))==NULL) return NULL;
2060 tm.tm_isdst=0;
2061 old_environ=environ;
2062 environ=gmt_env;
2063 *t=mktime(&tm);
2064 environ=old_environ;
2065 if (*t==-1) return NULL;
2066 *t-=zone;
2067 str=skip_comment(str);
2068 return str;
2069 }
2070
2071
2072
2073
2074 /*************************************************
2075 **************************************************
2076 *             Stand-alone test program           *
2077 **************************************************
2078 *************************************************/
2079
2080 #if defined STAND_ALONE
2081 int main(void)
2082 {
2083 int start, end, domain;
2084 uschar buffer[1024];
2085
2086 big_buffer = store_malloc(big_buffer_size);
2087
2088 /* strip_trailing_dot = TRUE; */
2089 allow_domain_literals = TRUE;
2090
2091 printf("Testing parse_fix_phrase\n");
2092
2093 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2094   {
2095   buffer[Ustrlen(buffer)-1] = 0;
2096   if (buffer[0] == 0) break;
2097   printf("%s\n", CS parse_fix_phrase(buffer, Ustrlen(buffer)));
2098   }
2099
2100 printf("Testing parse_extract_address without group syntax and without UTF-8\n");
2101
2102 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2103   {
2104   uschar *out;
2105   uschar *errmess;
2106   buffer[Ustrlen(buffer) - 1] = 0;
2107   if (buffer[0] == 0) break;
2108   out = parse_extract_address(buffer, &errmess, &start, &end, &domain, FALSE);
2109   if (!out)
2110     printf("*** bad address: %s\n", errmess);
2111   else
2112     {
2113     uschar extract[1024];
2114     Ustrncpy(extract, buffer+start, end-start);
2115     extract[end-start] = 0;
2116     printf("%s %d %d %d \"%s\"\n", out, start, end, domain, extract);
2117     }
2118   }
2119
2120 printf("Testing parse_extract_address without group syntax but with UTF-8\n");
2121
2122 allow_utf8_domains = TRUE;
2123 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2124   {
2125   uschar *out;
2126   uschar *errmess;
2127   buffer[Ustrlen(buffer) - 1] = 0;
2128   if (buffer[0] == 0) break;
2129   out = parse_extract_address(buffer, &errmess, &start, &end, &domain, FALSE);
2130   if (!out)
2131     printf("*** bad address: %s\n", errmess);
2132   else
2133     {
2134     uschar extract[1024];
2135     Ustrncpy(extract, buffer+start, end-start);
2136     extract[end-start] = 0;
2137     printf("%s %d %d %d \"%s\"\n", out, start, end, domain, extract);
2138     }
2139   }
2140 allow_utf8_domains = FALSE;
2141
2142 printf("Testing parse_extract_address with group syntax\n");
2143
2144 f.parse_allow_group = TRUE;
2145 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2146   {
2147   uschar *out;
2148   uschar *errmess;
2149   uschar *s;
2150   buffer[Ustrlen(buffer) - 1] = 0;
2151   if (buffer[0] == 0) break;
2152   s = buffer;
2153   while (*s)
2154     {
2155     uschar *ss = parse_find_address_end(s, FALSE);
2156     int terminator = *ss;
2157     *ss = 0;
2158     out = parse_extract_address(buffer, &errmess, &start, &end, &domain, FALSE);
2159     *ss = terminator;
2160
2161     if (!out)
2162       printf("*** bad address: %s\n", errmess);
2163     else
2164       {
2165       uschar extract[1024];
2166       Ustrncpy(extract, buffer+start, end-start);
2167       extract[end-start] = 0;
2168       printf("%s %d %d %d \"%s\"\n", out, start, end, domain, extract);
2169       }
2170
2171     s = ss + (terminator? 1:0);
2172     Uskip_whitespace(&s);
2173     }
2174   }
2175
2176 printf("Testing parse_find_at\n");
2177
2178 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2179   {
2180   uschar *s;
2181   buffer[Ustrlen(buffer)-1] = 0;
2182   if (buffer[0] == 0) break;
2183   s = parse_find_at(buffer);
2184   if (s == NULL) printf("no @ found\n");
2185     else printf("offset = %d\n", s - buffer);
2186   }
2187
2188 printf("Testing parse_extract_addresses\n");
2189
2190 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2191   {
2192   uschar *errmess;
2193   int extracted;
2194   address_item *anchor = NULL;
2195   buffer[Ustrlen(buffer) - 1] = 0;
2196   if (buffer[0] == 0) break;
2197   if ((extracted = parse_forward_list(buffer, -1, &anchor,
2198       &errmess, US"incoming.domain", NULL, NULL)) == FF_DELIVERED)
2199     {
2200     while (anchor != NULL)
2201       {
2202       address_item *addr = anchor;
2203       anchor = anchor->next;
2204       printf("%d %s\n", testflag(addr, af_pfr), addr->address);
2205       }
2206     }
2207   else printf("Failed: %d %s\n", extracted, errmess);
2208   }
2209
2210 printf("Testing parse_message_id\n");
2211
2212 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2213   {
2214   uschar *s, *t, *errmess;
2215   buffer[Ustrlen(buffer) - 1] = 0;
2216   if (buffer[0] == 0) break;
2217   s = buffer;
2218   while (*s != 0)
2219     {
2220     s = parse_message_id(s, &t, &errmess);
2221     if (errmess != NULL)
2222       {
2223       printf("Failed: %s\n", errmess);
2224       break;
2225       }
2226     printf("%s\n", t);
2227     }
2228   }
2229
2230 return 0;
2231 }
2232
2233 #endif
2234
2235 /* End of parse.c */