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