acece9b782aed90045eed3fe44b699655a1eb258
[users/heiko/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 g = string_catn(g, US"?=", 2);
908 return coded ? string_from_gstring(g) : string;
909 }
910
911
912
913
914 /*************************************************
915 *            Fix up an RFC 822 "phrase"          *
916 *************************************************/
917
918 /* This function is called to repair any syntactic defects in the "phrase" part
919 of an RFC822 address. In particular, it is applied to the user's name as read
920 from the passwd file when accepting a local message, and to the data from the
921 -F option.
922
923 If the string contains existing quoted strings or comments containing
924 freestanding quotes, then we just quote those bits that need quoting -
925 otherwise it would get awfully messy and probably not look good. If not, we
926 quote the whole thing if necessary. Thus
927
928    John Q. Smith            =>  "John Q. Smith"
929    John "Jack" Smith        =>  John "Jack" Smith
930    John "Jack" Q. Smith     =>  John "Jack" "Q." Smith
931    John (Jack) Q. Smith     =>  "John (Jack) Q. Smith"
932    John ("Jack") Q. Smith   =>  John ("Jack") "Q." Smith
933 but
934    John (\"Jack\") Q. Smith =>  "John (\"Jack\") Q. Smith"
935
936 Sheesh! This is tedious code. It is a great pity that the syntax of RFC822 is
937 the way it is...
938
939 August 2000: Additional code added:
940
941   Previously, non-printing characters were turned into question marks, which do
942   not need to be quoted.
943
944   Now, a different tactic is used if there are any non-printing ASCII
945   characters. The encoding method from RFC 2047 is used, assuming iso-8859-1 as
946   the character set.
947
948   We *could* use this for all cases, getting rid of the messy original code,
949   but leave it for now. It would complicate simple cases like "John Q. Smith".
950
951 The result is passed back in allocated memory.
952
953 Arguments:
954   phrase       an RFC822 phrase
955   len          the length of the phrase
956
957 Returns:       the fixed RFC822 phrase
958 */
959
960 const uschar *
961 parse_fix_phrase(const uschar *phrase, int len)
962 {
963 int ch, i;
964 BOOL quoted = FALSE;
965 const uschar *s, *end;
966 uschar * buffer;
967 uschar *t, *yield;
968
969 while (len > 0 && isspace(*phrase)) { phrase++; len--; }
970
971 /* See if there are any non-printing characters, and if so, use the RFC 2047
972 encoding for the whole thing. */
973
974 for (i = 0, s = phrase; i < len; i++, s++)
975   if ((*s < 32 && *s != '\t') || *s > 126) break;
976
977 if (i < len)
978   return parse_quote_2047(phrase, len, headers_charset, FALSE);
979
980 /* No non-printers; use the RFC 822 quoting rules */
981
982 buffer = store_get(len*4, is_tainted(phrase));
983
984 s = phrase;
985 end = s + len;
986 yield = t = buffer + 1;
987
988 while (s < end)
989   {
990   ch = *s++;
991
992   /* Copy over quoted strings, remembering we encountered one */
993
994   if (ch == '\"')
995     {
996     *t++ = '\"';
997     while (s < end && (ch = *s++) != '\"')
998       {
999       *t++ = ch;
1000       if (ch == '\\' && s < end) *t++ = *s++;
1001       }
1002     *t++ = '\"';
1003     if (s >= end) break;
1004     quoted = TRUE;
1005     }
1006
1007   /* Copy over comments, noting if they contain freestanding quote
1008   characters */
1009
1010   else if (ch == '(')
1011     {
1012     int level = 1;
1013     *t++ = '(';
1014     while (s < end)
1015       {
1016       ch = *s++;
1017       *t++ = ch;
1018       if (ch == '(') level++;
1019       else if (ch == ')') { if (--level <= 0) break; }
1020       else if (ch == '\\' && s < end) *t++ = *s++ & 127;
1021       else if (ch == '\"') quoted = TRUE;
1022       }
1023     if (ch == 0)
1024       {
1025       while (level--) *t++ = ')';
1026       break;
1027       }
1028     }
1029
1030   /* Handle special characters that need to be quoted */
1031
1032   else if (Ustrchr(")<>@,;:\\.[]", ch) != NULL)
1033     {
1034     /* If hit previous quotes just make one quoted "word" */
1035
1036     if (quoted)
1037       {
1038       uschar *tt = t++;
1039       while (*(--tt) != ' ' && *tt != '\"' && *tt != ')') tt[1] = *tt;
1040       tt[1] = '\"';
1041       *t++ = ch;
1042       while (s < end)
1043         {
1044         ch = *s++;
1045         if (ch == ' ' || ch == '\"') { s--; break; } else *t++ = ch;
1046         }
1047       *t++ = '\"';
1048       }
1049
1050     /* Else quote the whole string so far, and the rest up to any following
1051     quotes. We must treat anything following a backslash as a literal. */
1052
1053     else
1054       {
1055       BOOL escaped = (ch == '\\');
1056       *(--yield) = '\"';
1057       *t++ = ch;
1058
1059       /* Now look for the end or a quote */
1060
1061       while (s < end)
1062         {
1063         ch = *s++;
1064
1065         /* Handle escaped pairs */
1066
1067         if (escaped)
1068           {
1069           *t++ = ch;
1070           escaped = FALSE;
1071           }
1072
1073         else if (ch == '\\')
1074           {
1075           *t++ = ch;
1076           escaped = TRUE;
1077           }
1078
1079         /* If hit subsequent quotes, insert our quote before any trailing
1080         spaces and back up to re-handle the quote in the outer loop. */
1081
1082         else if (ch == '\"')
1083           {
1084           int count = 0;
1085           while (t[-1] == ' ') { t--; count++; }
1086           *t++ = '\"';
1087           while (count-- > 0) *t++ = ' ';
1088           s--;
1089           break;
1090           }
1091
1092         /* If hit a subsequent comment, check it for unescaped quotes,
1093         and if so, end our quote before it. */
1094
1095         else if (ch == '(')
1096           {
1097           const uschar *ss = s;     /* uschar after '(' */
1098           int level = 1;
1099           while(ss < end)
1100             {
1101             ch = *ss++;
1102             if (ch == '(') level++;
1103             else if (ch == ')') { if (--level <= 0) break; }
1104             else if (ch == '\\' && ss+1 < end) ss++;
1105             else if (ch == '\"') { quoted = TRUE; break; }
1106             }
1107
1108           /* Comment contains unescaped quotes; end our quote before
1109           the start of the comment. */
1110
1111           if (quoted)
1112             {
1113             int count = 0;
1114             while (t[-1] == ' ') { t--; count++; }
1115             *t++ = '\"';
1116             while (count-- > 0) *t++ = ' ';
1117             break;
1118             }
1119
1120           /* Comment does not contain unescaped quotes; include it in
1121           our quote. */
1122
1123           else
1124             {
1125             if (ss >= end) ss--;
1126             *t++ = '(';
1127             Ustrncpy(t, s, ss-s);
1128             t += ss-s;
1129             s = ss;
1130             }
1131           }
1132
1133         /* Not a comment or quote; include this character in our quotes. */
1134
1135         else *t++ = ch;
1136         }
1137       }
1138
1139     /* Add a final quote if we hit the end of the string. */
1140
1141     if (s >= end) *t++ = '\"';
1142     }
1143
1144   /* Non-special character; just copy it over */
1145
1146   else *t++ = ch;
1147   }
1148
1149 *t = 0;
1150 store_release_above(t+1);
1151 return yield;
1152 }
1153
1154
1155 /*************************************************
1156 *          Extract addresses from a list         *
1157 *************************************************/
1158
1159 /* This function is called by the redirect router to scan a string containing a
1160 list of addresses separated by commas (with optional white space) or by
1161 newlines, and to generate a chain of address items from them. In other words,
1162 to unpick data from an alias or .forward file.
1163
1164 The SunOS5 documentation for alias files is not very clear on the syntax; it
1165 does not say that either a comma or a newline can be used for separation.
1166 However, that is the way Smail does it, so we follow suit.
1167
1168 If a # character is encountered in a white space position, then characters from
1169 there to the next newline are skipped.
1170
1171 If an unqualified address begins with '\', just skip that character. This gives
1172 compatibility with Sendmail's use of \ to prevent looping. Exim has its own
1173 loop prevention scheme which handles other cases too - see the code in
1174 route_address().
1175
1176 An "address" can be a specification of a file or a pipe; the latter may often
1177 need to be quoted because it may contain spaces, but we don't want to retain
1178 the quotes. Quotes may appear in normal addresses too, and should be retained.
1179 We can distinguish between these cases, because in addresses, quotes are used
1180 only for parts of the address, not the whole thing. Therefore, we remove quotes
1181 from items when they entirely enclose them, but not otherwise.
1182
1183 An "address" can also be of the form :include:pathname to include a list of
1184 addresses contained in the specified file.
1185
1186 Any unqualified addresses are qualified with and rewritten if necessary, via
1187 the rewrite_address() function.
1188
1189 Arguments:
1190   s                the list of addresses (typically a complete
1191                      .forward file or a list of entries in an alias file)
1192   options          option bits for permitting or denying various special cases;
1193                      not all bits are relevant here - some are for filter
1194                      files; those we use here are:
1195                        RDO_DEFER
1196                        RDO_FREEZE
1197                        RDO_FAIL
1198                        RDO_BLACKHOLE
1199                        RDO_REWRITE
1200                        RDO_INCLUDE
1201   anchor           where to hang the chain of newly-created addresses. This
1202                      should be initialized to NULL.
1203   error            where to return an error text
1204   incoming domain  domain of the incoming address; used to qualify unqualified
1205                      local parts preceded by \
1206   directory        if NULL, no checks are done on :include: files
1207                    otherwise, included file names must start with the given
1208                      directory
1209   syntax_errors    if not NULL, it carries on after syntax errors in addresses,
1210                      building up a list of errors as error blocks chained on
1211                      here.
1212
1213 Returns:      FF_DELIVERED      addresses extracted
1214               FF_NOTDELIVERED   no addresses extracted, but no errors
1215               FF_BLACKHOLE      :blackhole:
1216               FF_DEFER          :defer:
1217               FF_FAIL           :fail:
1218               FF_INCLUDEFAIL    some problem with :include:; *error set
1219               FF_ERROR          other problems; *error is set
1220 */
1221
1222 int
1223 parse_forward_list(uschar *s, int options, address_item **anchor,
1224   uschar **error, const uschar *incoming_domain, uschar *directory,
1225   error_block **syntax_errors)
1226 {
1227 int count = 0;
1228
1229 DEBUG(D_route) debug_printf("parse_forward_list: %s\n", s);
1230
1231 for (;;)
1232   {
1233   int len;
1234   int special = 0;
1235   int specopt = 0;
1236   int specbit = 0;
1237   uschar *ss, *nexts;
1238   address_item *addr;
1239   BOOL inquote = FALSE;
1240
1241   for (;;)
1242     {
1243     while (isspace(*s) || *s == ',') s++;
1244     if (*s == '#') { while (*s != 0 && *s != '\n') s++; } else break;
1245     }
1246
1247   /* When we reach the end of the list, we return FF_DELIVERED if any child
1248   addresses have been generated. If nothing has been generated, there are two
1249   possibilities: either the list is really empty, or there were syntax errors
1250   that are being skipped. (If syntax errors are not being skipped, an FF_ERROR
1251   return is generated on hitting a syntax error and we don't get here.) For a
1252   truly empty list we return FF_NOTDELIVERED so that the router can decline.
1253   However, if the list is empty only because syntax errors were skipped, we
1254   return FF_DELIVERED. */
1255
1256   if (!*s)
1257     {
1258     return (count > 0 || (syntax_errors && *syntax_errors))
1259       ?  FF_DELIVERED : FF_NOTDELIVERED;
1260
1261     /* This previous code returns FF_ERROR if nothing is generated but a
1262     syntax error has been skipped. I now think it is the wrong approach, but
1263     have left this here just in case, and for the record. */
1264
1265     #ifdef NEVER
1266     if (count > 0) return FF_DELIVERED;   /* Something was generated */
1267
1268     if (syntax_errors == NULL ||          /* Not skipping syntax errors, or */
1269        *syntax_errors == NULL)            /*   we didn't actually skip any */
1270       return FF_NOTDELIVERED;
1271
1272     *error = string_sprintf("no addresses generated: syntax error in %s: %s",
1273        (*syntax_errors)->text2, (*syntax_errors)->text1);
1274     return FF_ERROR;
1275     #endif
1276
1277     }
1278
1279   /* Find the end of the next address. Quoted strings in addresses may contain
1280   escaped characters; I haven't found a proper specification of .forward or
1281   alias files that mentions the quoting properties, but it seems right to do
1282   the escaping thing in all cases, so use the function that finds the end of an
1283   address. However, don't let a quoted string extend over the end of a line. */
1284
1285   ss = parse_find_address_end(s, TRUE);
1286
1287   /* Remember where we finished, for starting the next one. */
1288
1289   nexts = ss;
1290
1291   /* Remove any trailing spaces; we know there's at least one non-space. */
1292
1293   while (isspace((ss[-1]))) ss--;
1294
1295   /* We now have s->start and ss->end of the next address. Remove quotes
1296   if they completely enclose, remembering the address started with a quote
1297   for handling pipes and files. Another round of removal of leading and
1298   trailing spaces is then required. */
1299
1300   if (*s == '\"' && ss[-1] == '\"')
1301     {
1302     s++;
1303     ss--;
1304     inquote = TRUE;
1305     while (s < ss && isspace(*s)) s++;
1306     while (ss > s && isspace((ss[-1]))) ss--;
1307     }
1308
1309   /* Set up the length of the address. */
1310
1311   len = ss - s;
1312
1313   DEBUG(D_route)
1314     {
1315     int save = s[len];
1316     s[len] = 0;
1317     debug_printf("extract item: %s\n", s);
1318     s[len] = save;
1319     }
1320
1321   /* Handle special addresses if permitted. If the address is :unknown:
1322   ignore it - this is for backward compatibility with old alias files. You
1323   don't need to use it nowadays - just generate an empty string. For :defer:,
1324   :blackhole:, or :fail: we have to set up the error message and give up right
1325   away. */
1326
1327   if (Ustrncmp(s, ":unknown:", len) == 0)
1328     {
1329     s = nexts;
1330     continue;
1331     }
1332
1333   if      (Ustrncmp(s, ":defer:", 7) == 0)
1334     { special = FF_DEFER; specopt = RDO_DEFER; }  /* specbit is 0 */
1335   else if (Ustrncmp(s, ":blackhole:", 11) == 0)
1336     { special = FF_BLACKHOLE; specopt = specbit = RDO_BLACKHOLE; }
1337   else if (Ustrncmp(s, ":fail:", 6) == 0)
1338     { special = FF_FAIL; specopt = RDO_FAIL; }  /* specbit is 0 */
1339
1340   if (special != 0)
1341     {
1342     uschar *ss = Ustrchr(s+1, ':') + 1;
1343     if ((options & specopt) == specbit)
1344       {
1345       *error = string_sprintf("\"%.*s\" is not permitted", len, s);
1346       return FF_ERROR;
1347       }
1348     while (*ss != 0 && isspace(*ss)) ss++;
1349     while (s[len] != 0 && s[len] != '\n') len++;
1350     s[len] = 0;
1351     *error = string_copy(ss);
1352     return special;
1353     }
1354
1355   /* If the address is of the form :include:pathname, read the file, and call
1356   this function recursively to extract the addresses from it. If directory is
1357   NULL, do no checks. Otherwise, insist that the file name starts with the
1358   given directory and is a regular file. */
1359
1360   if (Ustrncmp(s, ":include:", 9) == 0)
1361     {
1362     uschar *filebuf;
1363     uschar filename[256];
1364     uschar *t = s+9;
1365     int flen = len - 9;
1366     int frc;
1367     struct stat statbuf;
1368     address_item *last;
1369     FILE *f;
1370
1371     while (flen > 0 && isspace(*t)) { t++; flen--; }
1372
1373     if (flen <= 0)
1374       {
1375       *error = US"file name missing after :include:";
1376       return FF_ERROR;
1377       }
1378
1379     if (flen > 255)
1380       {
1381       *error = string_sprintf("included file name \"%s\" is too long", t);
1382       return FF_ERROR;
1383       }
1384
1385     Ustrncpy(filename, t, flen);
1386     filename[flen] = 0;
1387
1388     /* Insist on absolute path */
1389
1390     if (filename[0] != '/')
1391       {
1392       *error = string_sprintf("included file \"%s\" is not an absolute path",
1393         filename);
1394       return FF_ERROR;
1395       }
1396
1397     /* Check if include is permitted */
1398
1399     if (options & RDO_INCLUDE)
1400       {
1401       *error = US"included files not permitted";
1402       return FF_ERROR;
1403       }
1404
1405     if (is_tainted(filename))
1406       {
1407       *error = string_sprintf("Tainted name '%s' for included file  not permitted\n",
1408        filename);
1409       return FF_ERROR;
1410       }
1411
1412     /* Check file name if required */
1413
1414     if (directory)
1415       {
1416       int len = Ustrlen(directory);
1417       uschar *p = filename + len;
1418
1419       if (Ustrncmp(filename, directory, len) != 0 || *p != '/')
1420         {
1421         *error = string_sprintf("included file %s is not in directory %s",
1422           filename, directory);
1423         return FF_ERROR;
1424         }
1425
1426 #ifdef EXIM_HAVE_OPENAT
1427       /* It is necessary to check that every component inside the directory
1428       is NOT a symbolic link, in order to keep the file inside the directory.
1429       This is mighty tedious. We open the directory and openat every component,
1430       with a flag that fails symlinks. */
1431
1432       {
1433       int fd = exim_open2(CS directory, O_RDONLY);
1434       if (fd < 0)
1435         {
1436         *error = string_sprintf("failed to open directory %s", directory);
1437         return FF_ERROR;
1438         }
1439       while (*p)
1440         {
1441         uschar temp;
1442         int fd2;
1443         uschar * q = p;
1444
1445         while (*++p && *p != '/') ;
1446         temp = *p;
1447         *p = '\0';
1448
1449         fd2 = exim_openat(fd, CS q, O_RDONLY|O_NOFOLLOW);
1450         close(fd);
1451         *p = temp;
1452         if (fd2 < 0)
1453           {
1454           *error = string_sprintf("failed to open %s (component of included "
1455             "file); could be symbolic link", filename);
1456           return FF_ERROR;
1457           }
1458         fd = fd2;
1459         }
1460       f = fdopen(fd, "rb");
1461       }
1462 #else
1463       /* It is necessary to check that every component inside the directory
1464       is NOT a symbolic link, in order to keep the file inside the directory.
1465       This is mighty tedious. It is also not totally foolproof in that it
1466       leaves the possibility of a race attack, but I don't know how to do
1467       any better. */
1468
1469       while (*p)
1470         {
1471         int temp;
1472         while (*++p && *p != '/');
1473         temp = *p;
1474         *p = 0;
1475         if (Ulstat(filename, &statbuf) != 0)
1476           {
1477           *error = string_sprintf("failed to stat %s (component of included "
1478             "file)", filename);
1479           *p = temp;
1480           return FF_ERROR;
1481           }
1482
1483         *p = temp;
1484
1485         if ((statbuf.st_mode & S_IFMT) == S_IFLNK)
1486           {
1487           *error = string_sprintf("included file %s in the %s directory "
1488             "involves a symbolic link", filename, directory);
1489           return FF_ERROR;
1490           }
1491         }
1492 #endif
1493       }
1494
1495 #ifdef EXIM_HAVE_OPENAT
1496     else
1497 #endif
1498       /* Open and stat the file */
1499       f = Ufopen(filename, "rb");
1500
1501     if (!f)
1502       {
1503       *error = string_open_failed("included file %s", filename);
1504       return FF_INCLUDEFAIL;
1505       }
1506
1507     if (fstat(fileno(f), &statbuf) != 0)
1508       {
1509       *error = string_sprintf("failed to stat included file %s: %s",
1510         filename, strerror(errno));
1511       (void)fclose(f);
1512       return FF_INCLUDEFAIL;
1513       }
1514
1515     /* If directory was checked, double check that we opened a regular file */
1516
1517     if (directory && (statbuf.st_mode & S_IFMT) != S_IFREG)
1518       {
1519       *error = string_sprintf("included file %s is not a regular file in "
1520         "the %s directory", filename, directory);
1521       return FF_ERROR;
1522       }
1523
1524     /* Get a buffer and read the contents */
1525
1526     if (statbuf.st_size > MAX_INCLUDE_SIZE)
1527       {
1528       *error = string_sprintf("included file %s is too big (max %d)",
1529         filename, MAX_INCLUDE_SIZE);
1530       return FF_ERROR;
1531       }
1532
1533     filebuf = store_get(statbuf.st_size + 1, is_tainted(filename));
1534     if (fread(filebuf, 1, statbuf.st_size, f) != statbuf.st_size)
1535       {
1536       *error = string_sprintf("error while reading included file %s: %s",
1537         filename, strerror(errno));
1538       (void)fclose(f);
1539       return FF_ERROR;
1540       }
1541     filebuf[statbuf.st_size] = 0;
1542     (void)fclose(f);
1543
1544     addr = NULL;
1545     frc = parse_forward_list(filebuf, options, &addr,
1546       error, incoming_domain, directory, syntax_errors);
1547     if (frc != FF_DELIVERED && frc != FF_NOTDELIVERED) return frc;
1548
1549     if (addr)
1550       {
1551       for (last = addr; last->next; last = last->next) count++;
1552       last->next = *anchor;
1553       *anchor = addr;
1554       count++;
1555       }
1556     }
1557
1558   /* Else (not :include:) ensure address is syntactically correct and fully
1559   qualified if not a pipe or a file, removing a leading \ if present on an
1560   unqualified address. For pipes and files we must handle quoting. It's
1561   not quite clear exactly what to do for partially quoted things, but the
1562   common case of having the whole thing in quotes is straightforward. If this
1563   was the case, inquote will have been set TRUE above and the quotes removed.
1564
1565   There is a possible ambiguity over addresses whose local parts start with
1566   a vertical bar or a slash, and the latter do in fact occur, thanks to X.400.
1567   Consider a .forward file that contains the line
1568
1569      /X=xxx/Y=xxx/OU=xxx/@some.gate.way
1570
1571   Is this a file or an X.400 address? Does it make any difference if it is in
1572   quotes? On the grounds that file names of this type are rare, Exim treats
1573   something that parses as an RFC 822 address and has a domain as an address
1574   rather than a file or a pipe. This is also how an address such as the above
1575   would be treated if it came in from outside. */
1576
1577   else
1578     {
1579     int start, end, domain;
1580     uschar *recipient = NULL;
1581     int save = s[len];
1582     s[len] = 0;
1583
1584     /* If it starts with \ and the rest of it parses as a valid mail address
1585     without a domain, carry on with that address, but qualify it with the
1586     incoming domain. Otherwise arrange for the address to fall through,
1587     causing an error message on the re-parse. */
1588
1589     if (*s == '\\')
1590       {
1591       recipient =
1592         parse_extract_address(s+1, error, &start, &end, &domain, FALSE);
1593       if (recipient)
1594         recipient = domain != 0 ? NULL :
1595           string_sprintf("%s@%s", recipient, incoming_domain);
1596       }
1597
1598     /* Try parsing the item as an address. */
1599
1600     if (!recipient) recipient =
1601       parse_extract_address(s, error, &start, &end, &domain, FALSE);
1602
1603     /* If item starts with / or | and is not a valid address, or there
1604     is no domain, treat it as a file or pipe. If it was a quoted item,
1605     remove the quoting occurrences of \ within it. */
1606
1607     if ((*s == '|' || *s == '/') && (recipient == NULL || domain == 0))
1608       {
1609       uschar *t = store_get(Ustrlen(s) + 1, is_tainted(s));
1610       uschar *p = t;
1611       uschar *q = s;
1612       while (*q != 0)
1613         {
1614         if (inquote)
1615           {
1616           *p++ = (*q == '\\')? *(++q) : *q;
1617           q++;
1618           }
1619         else *p++ = *q++;
1620         }
1621       *p = 0;
1622       addr = deliver_make_addr(t, TRUE);
1623       setflag(addr, af_pfr);                   /* indicates pipe/file/reply */
1624       if (*s != '|') setflag(addr, af_file);   /* indicates file */
1625       }
1626
1627     /* Item must be an address. Complain if not, else qualify, rewrite and set
1628     up the control block. It appears that people are in the habit of using
1629     empty addresses but with comments as a way of putting comments into
1630     alias and forward files. Therefore, ignore the error "empty address".
1631     Mailing lists might want to tolerate syntax errors; there is therefore
1632     an option to do so. */
1633
1634     else
1635       {
1636       if (recipient == NULL)
1637         {
1638         if (Ustrcmp(*error, "empty address") == 0)
1639           {
1640           *error = NULL;
1641           s[len] = save;
1642           s = nexts;
1643           continue;
1644           }
1645
1646         if (syntax_errors != NULL)
1647           {
1648           error_block *e = store_get(sizeof(error_block), FALSE);
1649           error_block *last = *syntax_errors;
1650           if (last == NULL) *syntax_errors = e; else
1651             {
1652             while (last->next != NULL) last = last->next;
1653             last->next = e;
1654             }
1655           e->next = NULL;
1656           e->text1 = *error;
1657           e->text2 = string_copy(s);
1658           s[len] = save;
1659           s = nexts;
1660           continue;
1661           }
1662         else
1663           {
1664           *error = string_sprintf("%s in \"%s\"", *error, s);
1665           s[len] = save;   /* _after_ using it for *error */
1666           return FF_ERROR;
1667           }
1668         }
1669
1670       /* Address was successfully parsed. Rewrite, and then make an address
1671       block. */
1672
1673       recipient = ((options & RDO_REWRITE) != 0)?
1674         rewrite_address(recipient, TRUE, FALSE, global_rewrite_rules,
1675           rewrite_existflags) :
1676         rewrite_address_qualify(recipient, TRUE);
1677       addr = deliver_make_addr(recipient, TRUE);  /* TRUE => copy recipient */
1678       }
1679
1680     /* Restore the final character in the original data, and add to the
1681     output chain. */
1682
1683     s[len] = save;
1684     addr->next = *anchor;
1685     *anchor = addr;
1686     count++;
1687     }
1688
1689   /* Advance pointer for the next address */
1690
1691   s = nexts;
1692   }
1693 }
1694
1695
1696 /*************************************************
1697 *            Extract a Message-ID                *
1698 *************************************************/
1699
1700 /* This function is used to extract message ids from In-Reply-To: and
1701 References: header lines.
1702
1703 Arguments:
1704   str          pointer to the start of the message-id
1705   yield        put pointer to the message id (in dynamic memory) here
1706   error        put error message here on failure
1707
1708 Returns:       points after the processed message-id or NULL on error
1709 */
1710
1711 uschar *
1712 parse_message_id(uschar *str, uschar **yield, uschar **error)
1713 {
1714 uschar *domain = NULL;
1715 uschar *id;
1716 rmark reset_point;
1717
1718 str = skip_comment(str);
1719 if (*str != '<')
1720   {
1721   *error = US"Missing '<' before message-id";
1722   return NULL;
1723   }
1724
1725 /* Getting a block the size of the input string will definitely be sufficient
1726 for the answer, but it may also be very long if we are processing a header
1727 line. Therefore, take care to release unwanted store afterwards. */
1728
1729 reset_point = store_mark();
1730 id = *yield = store_get(Ustrlen(str) + 1, is_tainted(str));
1731 *id++ = *str++;
1732
1733 str = read_addr_spec(str, id, '>', error, &domain);
1734
1735 if (!*error)
1736   {
1737   if (*str != '>') *error = US"Missing '>' after message-id";
1738     else if (domain == NULL) *error = US"domain missing in message-id";
1739   }
1740
1741 if (*error)
1742   {
1743   store_reset(reset_point);
1744   return NULL;
1745   }
1746
1747 while (*id) id++;
1748 *id++ = *str++;
1749 *id++ = 0;
1750 store_release_above(id);
1751
1752 str = skip_comment(str);
1753 return str;
1754 }
1755
1756
1757 /*************************************************
1758 *        Parse a fixed digit number              *
1759 *************************************************/
1760
1761 /* Parse a string containing an ASCII encoded fixed digits number
1762
1763 Arguments:
1764   str          pointer to the start of the ASCII encoded number
1765   n            pointer to the resulting value
1766   digits       number of required digits
1767
1768 Returns:       points after the processed date or NULL on error
1769 */
1770
1771 static uschar *
1772 parse_number(uschar *str, int *n, int digits)
1773 {
1774   *n=0;
1775   while (digits--)
1776   {
1777     if (*str<'0' || *str>'9') return NULL;
1778     *n=10*(*n)+(*str++-'0');
1779   }
1780   return str;
1781 }
1782
1783
1784 /*************************************************
1785 *        Parse a RFC 2822 day of week            *
1786 *************************************************/
1787
1788 /* Parse the day of the week from a RFC 2822 date, but do not
1789    decode it, because it is only for humans.
1790
1791 Arguments:
1792   str          pointer to the start of the day of the week
1793
1794 Returns:       points after the parsed day or NULL on error
1795 */
1796
1797 static uschar *
1798 parse_day_of_week(uschar *str)
1799 {
1800 /*
1801 day-of-week     =       ([FWS] day-name) / obs-day-of-week
1802
1803 day-name        =       "Mon" / "Tue" / "Wed" / "Thu" /
1804                         "Fri" / "Sat" / "Sun"
1805
1806 obs-day-of-week =       [CFWS] day-name [CFWS]
1807 */
1808
1809 static const uschar *day_name[7]={ US"mon", US"tue", US"wed", US"thu", US"fri", US"sat", US"sun" };
1810 int i;
1811 uschar day[4];
1812
1813 str=skip_comment(str);
1814 for (i=0; i<3; ++i)
1815   {
1816   if ((day[i]=tolower(*str))=='\0') return NULL;
1817   ++str;
1818   }
1819 day[3]='\0';
1820 for (i=0; i<7; ++i) if (Ustrcmp(day,day_name[i])==0) break;
1821 if (i==7) return NULL;
1822 str=skip_comment(str);
1823 return str;
1824 }
1825
1826
1827 /*************************************************
1828 *            Parse a RFC 2822 date               *
1829 *************************************************/
1830
1831 /* Parse the date part of a RFC 2822 date-time, extracting the
1832    day, month and year.
1833
1834 Arguments:
1835   str          pointer to the start of the date
1836   d            pointer to the resulting day
1837   m            pointer to the resulting month
1838   y            pointer to the resulting year
1839
1840 Returns:       points after the processed date or NULL on error
1841 */
1842
1843 static uschar *
1844 parse_date(uschar *str, int *d, int *m, int *y)
1845 {
1846 /*
1847 date            =       day month year
1848
1849 year            =       4*DIGIT / obs-year
1850
1851 obs-year        =       [CFWS] 2*DIGIT [CFWS]
1852
1853 month           =       (FWS month-name FWS) / obs-month
1854
1855 month-name      =       "Jan" / "Feb" / "Mar" / "Apr" /
1856                         "May" / "Jun" / "Jul" / "Aug" /
1857                         "Sep" / "Oct" / "Nov" / "Dec"
1858
1859 obs-month       =       CFWS month-name CFWS
1860
1861 day             =       ([FWS] 1*2DIGIT) / obs-day
1862
1863 obs-day         =       [CFWS] 1*2DIGIT [CFWS]
1864 */
1865
1866 uschar *c,*n;
1867 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" };
1868 int i;
1869 uschar month[4];
1870
1871 str=skip_comment(str);
1872 if ((str=parse_number(str,d,1))==NULL) return NULL;
1873 if (*str>='0' && *str<='9') *d=10*(*d)+(*str++-'0');
1874 c=skip_comment(str);
1875 if (c==str) return NULL;
1876 else str=c;
1877 for (i=0; i<3; ++i) if ((month[i]=tolower(*(str+i)))=='\0') return NULL;
1878 month[3]='\0';
1879 for (i=0; i<12; ++i) if (Ustrcmp(month,month_name[i])==0) break;
1880 if (i==12) return NULL;
1881 str+=3;
1882 *m=i;
1883 c=skip_comment(str);
1884 if (c==str) return NULL;
1885 else str=c;
1886 if ((n=parse_number(str,y,4)))
1887   {
1888   str=n;
1889   if (*y<1900) return NULL;
1890   *y=*y-1900;
1891   }
1892 else if ((n=parse_number(str,y,2)))
1893   {
1894   str=skip_comment(n);
1895   while (*(str-1)==' ' || *(str-1)=='\t') --str; /* match last FWS later */
1896   if (*y<50) *y+=100;
1897   }
1898 else return NULL;
1899 return str;
1900 }
1901
1902
1903 /*************************************************
1904 *            Parse a RFC 2822 Time               *
1905 *************************************************/
1906
1907 /* Parse the time part of a RFC 2822 date-time, extracting the
1908    hour, minute, second and timezone.
1909
1910 Arguments:
1911   str          pointer to the start of the time
1912   h            pointer to the resulting hour
1913   m            pointer to the resulting minute
1914   s            pointer to the resulting second
1915   z            pointer to the resulting timezone (offset in seconds)
1916
1917 Returns:       points after the processed time or NULL on error
1918 */
1919
1920 static uschar *
1921 parse_time(uschar *str, int *h, int *m, int *s, int *z)
1922 {
1923 /*
1924 time            =       time-of-day FWS zone
1925
1926 time-of-day     =       hour ":" minute [ ":" second ]
1927
1928 hour            =       2DIGIT / obs-hour
1929
1930 obs-hour        =       [CFWS] 2DIGIT [CFWS]
1931
1932 minute          =       2DIGIT / obs-minute
1933
1934 obs-minute      =       [CFWS] 2DIGIT [CFWS]
1935
1936 second          =       2DIGIT / obs-second
1937
1938 obs-second      =       [CFWS] 2DIGIT [CFWS]
1939
1940 zone            =       (( "+" / "-" ) 4DIGIT) / obs-zone
1941
1942 obs-zone        =       "UT" / "GMT" /          ; Universal Time
1943                                                 ; North American UT
1944                                                 ; offsets
1945                         "EST" / "EDT" /         ; Eastern:  - 5/ - 4
1946                         "CST" / "CDT" /         ; Central:  - 6/ - 5
1947                         "MST" / "MDT" /         ; Mountain: - 7/ - 6
1948                         "PST" / "PDT" /         ; Pacific:  - 8/ - 7
1949
1950                         %d65-73 /               ; Military zones - "A"
1951                         %d75-90 /               ; through "I" and "K"
1952                         %d97-105 /              ; through "Z", both
1953                         %d107-122               ; upper and lower case
1954 */
1955
1956 uschar *c;
1957
1958 str=skip_comment(str);
1959 if ((str=parse_number(str,h,2))==NULL) return NULL;
1960 str=skip_comment(str);
1961 if (*str!=':') return NULL;
1962 ++str;
1963 str=skip_comment(str);
1964 if ((str=parse_number(str,m,2))==NULL) return NULL;
1965 c=skip_comment(str);
1966 if (*str==':')
1967   {
1968   ++str;
1969   str=skip_comment(str);
1970   if ((str=parse_number(str,s,2))==NULL) return NULL;
1971   c=skip_comment(str);
1972   }
1973 if (c==str) return NULL;
1974 else str=c;
1975 if (*str=='+' || *str=='-')
1976   {
1977   int neg;
1978
1979   neg=(*str=='-');
1980   ++str;
1981   if ((str=parse_number(str,z,4))==NULL) return NULL;
1982   *z=(*z/100)*3600+(*z%100)*60;
1983   if (neg) *z=-*z;
1984   }
1985 else
1986   {
1987   char zone[5];
1988   struct { const char *name; int off; } zone_name[10]=
1989   { {"gmt",0}, {"ut",0}, {"est",-5}, {"edt",-4}, {"cst",-6}, {"cdt",-5}, {"mst",-7}, {"mdt",-6}, {"pst",-8}, {"pdt",-7}};
1990   int i,j;
1991
1992   for (i=0; i<4; ++i)
1993     {
1994     zone[i]=tolower(*(str+i));
1995     if (zone[i]<'a' || zone[i]>'z') break;
1996     }
1997   zone[i]='\0';
1998   for (j=0; j<10 && strcmp(zone,zone_name[j].name); ++j);
1999   /* Besides zones named in the grammar, RFC 2822 says other alphabetic */
2000   /* time zones should be treated as unknown offsets. */
2001   if (j<10)
2002     {
2003     *z=zone_name[j].off*3600;
2004     str+=i;
2005     }
2006   else if (zone[0]<'a' || zone[1]>'z') return 0;
2007   else
2008     {
2009     while ((*str>='a' && *str<='z') || (*str>='A' && *str<='Z')) ++str;
2010     *z=0;
2011     }
2012   }
2013 return str;
2014 }
2015
2016
2017 /*************************************************
2018 *          Parse a RFC 2822 date-time            *
2019 *************************************************/
2020
2021 /* Parse a RFC 2822 date-time and return it in seconds since the epoch.
2022
2023 Arguments:
2024   str          pointer to the start of the date-time
2025   t            pointer to the parsed time
2026
2027 Returns:       points after the processed date-time or NULL on error
2028 */
2029
2030 uschar *
2031 parse_date_time(uschar *str, time_t *t)
2032 {
2033 /*
2034 date-time       =       [ day-of-week "," ] date FWS time [CFWS]
2035 */
2036
2037 struct tm tm;
2038 int zone;
2039 extern char **environ;
2040 char **old_environ;
2041 static char gmt0[]="TZ=GMT0";
2042 static char *gmt_env[]={ gmt0, (char*)0 };
2043 uschar *try;
2044
2045 if ((try=parse_day_of_week(str)))
2046   {
2047   str=try;
2048   if (*str!=',') return 0;
2049   ++str;
2050   }
2051 if ((str=parse_date(str,&tm.tm_mday,&tm.tm_mon,&tm.tm_year))==NULL) return NULL;
2052 if (*str!=' ' && *str!='\t') return NULL;
2053 while (*str==' ' || *str=='\t') ++str;
2054 if ((str=parse_time(str,&tm.tm_hour,&tm.tm_min,&tm.tm_sec,&zone))==NULL) return NULL;
2055 tm.tm_isdst=0;
2056 old_environ=environ;
2057 environ=gmt_env;
2058 *t=mktime(&tm);
2059 environ=old_environ;
2060 if (*t==-1) return NULL;
2061 *t-=zone;
2062 str=skip_comment(str);
2063 return str;
2064 }
2065
2066
2067
2068
2069 /*************************************************
2070 **************************************************
2071 *             Stand-alone test program           *
2072 **************************************************
2073 *************************************************/
2074
2075 #if defined STAND_ALONE
2076 int main(void)
2077 {
2078 int start, end, domain;
2079 uschar buffer[1024];
2080
2081 big_buffer = store_malloc(big_buffer_size);
2082
2083 /* strip_trailing_dot = TRUE; */
2084 allow_domain_literals = TRUE;
2085
2086 printf("Testing parse_fix_phrase\n");
2087
2088 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2089   {
2090   buffer[Ustrlen(buffer)-1] = 0;
2091   if (buffer[0] == 0) break;
2092   printf("%s\n", CS parse_fix_phrase(buffer, Ustrlen(buffer)));
2093   }
2094
2095 printf("Testing parse_extract_address without group syntax and without UTF-8\n");
2096
2097 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2098   {
2099   uschar *out;
2100   uschar *errmess;
2101   buffer[Ustrlen(buffer) - 1] = 0;
2102   if (buffer[0] == 0) break;
2103   out = parse_extract_address(buffer, &errmess, &start, &end, &domain, FALSE);
2104   if (!out)
2105     printf("*** bad address: %s\n", errmess);
2106   else
2107     {
2108     uschar extract[1024];
2109     Ustrncpy(extract, buffer+start, end-start);
2110     extract[end-start] = 0;
2111     printf("%s %d %d %d \"%s\"\n", out, start, end, domain, extract);
2112     }
2113   }
2114
2115 printf("Testing parse_extract_address without group syntax but with UTF-8\n");
2116
2117 allow_utf8_domains = TRUE;
2118 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2119   {
2120   uschar *out;
2121   uschar *errmess;
2122   buffer[Ustrlen(buffer) - 1] = 0;
2123   if (buffer[0] == 0) break;
2124   out = parse_extract_address(buffer, &errmess, &start, &end, &domain, FALSE);
2125   if (!out)
2126     printf("*** bad address: %s\n", errmess);
2127   else
2128     {
2129     uschar extract[1024];
2130     Ustrncpy(extract, buffer+start, end-start);
2131     extract[end-start] = 0;
2132     printf("%s %d %d %d \"%s\"\n", out, start, end, domain, extract);
2133     }
2134   }
2135 allow_utf8_domains = FALSE;
2136
2137 printf("Testing parse_extract_address with group syntax\n");
2138
2139 f.parse_allow_group = TRUE;
2140 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2141   {
2142   uschar *out;
2143   uschar *errmess;
2144   uschar *s;
2145   buffer[Ustrlen(buffer) - 1] = 0;
2146   if (buffer[0] == 0) break;
2147   s = buffer;
2148   while (*s)
2149     {
2150     uschar *ss = parse_find_address_end(s, FALSE);
2151     int terminator = *ss;
2152     *ss = 0;
2153     out = parse_extract_address(buffer, &errmess, &start, &end, &domain, FALSE);
2154     *ss = terminator;
2155
2156     if (!out)
2157       printf("*** bad address: %s\n", errmess);
2158     else
2159       {
2160       uschar extract[1024];
2161       Ustrncpy(extract, buffer+start, end-start);
2162       extract[end-start] = 0;
2163       printf("%s %d %d %d \"%s\"\n", out, start, end, domain, extract);
2164       }
2165
2166     s = ss + (terminator? 1:0);
2167     Uskip_whitespace(&s);
2168     }
2169   }
2170
2171 printf("Testing parse_find_at\n");
2172
2173 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2174   {
2175   uschar *s;
2176   buffer[Ustrlen(buffer)-1] = 0;
2177   if (buffer[0] == 0) break;
2178   s = parse_find_at(buffer);
2179   if (s == NULL) printf("no @ found\n");
2180     else printf("offset = %d\n", s - buffer);
2181   }
2182
2183 printf("Testing parse_extract_addresses\n");
2184
2185 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2186   {
2187   uschar *errmess;
2188   int extracted;
2189   address_item *anchor = NULL;
2190   buffer[Ustrlen(buffer) - 1] = 0;
2191   if (buffer[0] == 0) break;
2192   if ((extracted = parse_forward_list(buffer, -1, &anchor,
2193       &errmess, US"incoming.domain", NULL, NULL)) == FF_DELIVERED)
2194     {
2195     while (anchor != NULL)
2196       {
2197       address_item *addr = anchor;
2198       anchor = anchor->next;
2199       printf("%d %s\n", testflag(addr, af_pfr), addr->address);
2200       }
2201     }
2202   else printf("Failed: %d %s\n", extracted, errmess);
2203   }
2204
2205 printf("Testing parse_message_id\n");
2206
2207 while (Ufgets(buffer, sizeof(buffer), stdin) != NULL)
2208   {
2209   uschar *s, *t, *errmess;
2210   buffer[Ustrlen(buffer) - 1] = 0;
2211   if (buffer[0] == 0) break;
2212   s = buffer;
2213   while (*s != 0)
2214     {
2215     s = parse_message_id(s, &t, &errmess);
2216     if (errmess != NULL)
2217       {
2218       printf("Failed: %s\n", errmess);
2219       break;
2220       }
2221     printf("%s\n", t);
2222     }
2223   }
2224
2225 return 0;
2226 }
2227
2228 #endif
2229
2230 /* End of parse.c */