1 /* $Cambridge: exim/src/src/expand.c,v 1.7 2004/11/18 11:17:33 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2004 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /* Functions for handling string expansion. */
17 #ifndef SUPPORT_CRYPTEQ
18 #define SUPPORT_CRYPTEQ
22 #ifdef SUPPORT_CRYPTEQ
27 extern char* crypt16(char*, char*);
32 #include "lookups/ldap.h"
37 /* Recursively called function */
39 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
43 /*************************************************
44 * Local statics and tables *
45 *************************************************/
47 /* Table of item names, and corresponding switch numbers. The names must be in
48 alphabetical order. */
50 static uschar *item_table[] = {
86 /* Tables of operator names, and corresponding switch numbers. The names must be
87 in alphabetical order. There are two tables, because underscore is used in some
88 cases to introduce arguments, whereas for other it is part of the name. This is
89 an historical mis-design. */
91 static uschar *op_table_underscore[] = {
100 EOP_QUOTE_LOCAL_PART,
103 static uschar *op_table_main[] = {
134 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
164 /* Table of condition names, and corresponding switch numbers. The names must
165 be in alphabetical order. */
167 static uschar *cond_table[] = {
171 US"==", /* Backward compatibility */
196 US"match_local_part",
218 ECOND_FIRST_DELIVERY,
234 ECOND_MATCH_LOCAL_PART,
244 /* Type for main variable table */
252 /* Type for entries pointing to address/length pairs. Not currently
260 /* Types of table entry */
263 vtype_int, /* value is address of int */
264 vtype_filter_int, /* ditto, but recognized only when filtering */
265 vtype_ino, /* value is address of ino_t (not always an int) */
266 vtype_uid, /* value is address of uid_t (not always an int) */
267 vtype_gid, /* value is address of gid_t (not always an int) */
268 vtype_stringptr, /* value is address of pointer to string */
269 vtype_msgbody, /* as stringptr, but read when first required */
270 vtype_msgbody_end, /* ditto, the end of the message */
271 vtype_msgheaders, /* the message's headers */
272 vtype_localpart, /* extract local part from string */
273 vtype_domain, /* extract domain from string */
274 vtype_recipients, /* extract recipients from recipients list */
275 /* (enabled only during system filtering */
276 vtype_todbsdin, /* value not used; generate BSD inbox tod */
277 vtype_tode, /* value not used; generate tod in epoch format */
278 vtype_todf, /* value not used; generate full tod */
279 vtype_todl, /* value not used; generate log tod */
280 vtype_todlf, /* value not used; generate log file datestamp tod */
281 vtype_todzone, /* value not used; generate time zone only */
282 vtype_todzulu, /* value not used; generate zulu tod */
283 vtype_reply, /* value not used; get reply from headers */
284 vtype_pid, /* value not used; result is pid */
285 vtype_host_lookup, /* value not used; get host name */
286 vtype_load_avg, /* value not used; result is int from os_getloadavg */
287 vtype_pspace, /* partition space; value is T/F for spool/log */
288 vtype_pinodes /* partition inodes; value is T/F for spool/log */
291 /* This table must be kept in alphabetical order. */
293 static var_entry var_table[] = {
294 { "acl_c0", vtype_stringptr, &acl_var[0] },
295 { "acl_c1", vtype_stringptr, &acl_var[1] },
296 { "acl_c2", vtype_stringptr, &acl_var[2] },
297 { "acl_c3", vtype_stringptr, &acl_var[3] },
298 { "acl_c4", vtype_stringptr, &acl_var[4] },
299 { "acl_c5", vtype_stringptr, &acl_var[5] },
300 { "acl_c6", vtype_stringptr, &acl_var[6] },
301 { "acl_c7", vtype_stringptr, &acl_var[7] },
302 { "acl_c8", vtype_stringptr, &acl_var[8] },
303 { "acl_c9", vtype_stringptr, &acl_var[9] },
304 { "acl_m0", vtype_stringptr, &acl_var[10] },
305 { "acl_m1", vtype_stringptr, &acl_var[11] },
306 { "acl_m2", vtype_stringptr, &acl_var[12] },
307 { "acl_m3", vtype_stringptr, &acl_var[13] },
308 { "acl_m4", vtype_stringptr, &acl_var[14] },
309 { "acl_m5", vtype_stringptr, &acl_var[15] },
310 { "acl_m6", vtype_stringptr, &acl_var[16] },
311 { "acl_m7", vtype_stringptr, &acl_var[17] },
312 { "acl_m8", vtype_stringptr, &acl_var[18] },
313 { "acl_m9", vtype_stringptr, &acl_var[19] },
314 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
315 { "address_data", vtype_stringptr, &deliver_address_data },
316 { "address_file", vtype_stringptr, &address_file },
317 { "address_pipe", vtype_stringptr, &address_pipe },
318 { "authenticated_id", vtype_stringptr, &authenticated_id },
319 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
320 { "authentication_failed",vtype_int, &authentication_failed },
321 { "body_linecount", vtype_int, &body_linecount },
322 { "body_zerocount", vtype_int, &body_zerocount },
323 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
324 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
325 { "caller_gid", vtype_gid, &real_gid },
326 { "caller_uid", vtype_uid, &real_uid },
327 { "compile_date", vtype_stringptr, &version_date },
328 { "compile_number", vtype_stringptr, &version_cnumber },
329 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
330 { "dnslist_text", vtype_stringptr, &dnslist_text },
331 { "dnslist_value", vtype_stringptr, &dnslist_value },
332 { "domain", vtype_stringptr, &deliver_domain },
333 { "domain_data", vtype_stringptr, &deliver_domain_data },
334 { "exim_gid", vtype_gid, &exim_gid },
335 { "exim_path", vtype_stringptr, &exim_path },
336 { "exim_uid", vtype_uid, &exim_uid },
337 { "home", vtype_stringptr, &deliver_home },
338 { "host", vtype_stringptr, &deliver_host },
339 { "host_address", vtype_stringptr, &deliver_host_address },
340 { "host_data", vtype_stringptr, &host_data },
341 { "host_lookup_failed", vtype_int, &host_lookup_failed },
342 { "inode", vtype_ino, &deliver_inode },
343 { "interface_address", vtype_stringptr, &interface_address },
344 { "interface_port", vtype_int, &interface_port },
346 { "ldap_dn", vtype_stringptr, &eldap_dn },
348 { "load_average", vtype_load_avg, NULL },
349 { "local_part", vtype_stringptr, &deliver_localpart },
350 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
351 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
352 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
353 { "local_scan_data", vtype_stringptr, &local_scan_data },
354 { "local_user_gid", vtype_gid, &local_user_gid },
355 { "local_user_uid", vtype_uid, &local_user_uid },
356 { "localhost_number", vtype_int, &host_number },
357 { "log_inodes", vtype_pinodes, (void *)FALSE },
358 { "log_space", vtype_pspace, (void *)FALSE },
359 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
360 { "message_age", vtype_int, &message_age },
361 { "message_body", vtype_msgbody, &message_body },
362 { "message_body_end", vtype_msgbody_end, &message_body_end },
363 { "message_body_size", vtype_int, &message_body_size },
364 { "message_headers", vtype_msgheaders, NULL },
365 { "message_id", vtype_stringptr, &message_id },
366 { "message_size", vtype_int, &message_size },
367 { "n0", vtype_filter_int, &filter_n[0] },
368 { "n1", vtype_filter_int, &filter_n[1] },
369 { "n2", vtype_filter_int, &filter_n[2] },
370 { "n3", vtype_filter_int, &filter_n[3] },
371 { "n4", vtype_filter_int, &filter_n[4] },
372 { "n5", vtype_filter_int, &filter_n[5] },
373 { "n6", vtype_filter_int, &filter_n[6] },
374 { "n7", vtype_filter_int, &filter_n[7] },
375 { "n8", vtype_filter_int, &filter_n[8] },
376 { "n9", vtype_filter_int, &filter_n[9] },
377 { "original_domain", vtype_stringptr, &deliver_domain_orig },
378 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
379 { "originator_gid", vtype_gid, &originator_gid },
380 { "originator_uid", vtype_uid, &originator_uid },
381 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
382 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
383 { "pid", vtype_pid, NULL },
384 { "primary_hostname", vtype_stringptr, &primary_hostname },
385 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
386 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
387 { "rcpt_count", vtype_int, &rcpt_count },
388 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
389 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
390 { "received_count", vtype_int, &received_count },
391 { "received_for", vtype_stringptr, &received_for },
392 { "received_protocol", vtype_stringptr, &received_protocol },
393 { "recipient_data", vtype_stringptr, &recipient_data },
394 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
395 { "recipients", vtype_recipients, NULL },
396 { "recipients_count", vtype_int, &recipients_count },
397 { "reply_address", vtype_reply, NULL },
398 { "return_path", vtype_stringptr, &return_path },
399 { "return_size_limit", vtype_int, &bounce_return_size_limit },
400 { "runrc", vtype_int, &runrc },
401 { "self_hostname", vtype_stringptr, &self_hostname },
402 { "sender_address", vtype_stringptr, &sender_address },
403 { "sender_address_data", vtype_stringptr, &sender_address_data },
404 { "sender_address_domain", vtype_domain, &sender_address },
405 { "sender_address_local_part", vtype_localpart, &sender_address },
406 { "sender_data", vtype_stringptr, &sender_data },
407 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
408 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
409 { "sender_host_address", vtype_stringptr, &sender_host_address },
410 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
411 { "sender_host_name", vtype_host_lookup, NULL },
412 { "sender_host_port", vtype_int, &sender_host_port },
413 { "sender_ident", vtype_stringptr, &sender_ident },
414 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
415 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
416 { "smtp_command_argument", vtype_stringptr, &smtp_command_argument },
417 { "sn0", vtype_filter_int, &filter_sn[0] },
418 { "sn1", vtype_filter_int, &filter_sn[1] },
419 { "sn2", vtype_filter_int, &filter_sn[2] },
420 { "sn3", vtype_filter_int, &filter_sn[3] },
421 { "sn4", vtype_filter_int, &filter_sn[4] },
422 { "sn5", vtype_filter_int, &filter_sn[5] },
423 { "sn6", vtype_filter_int, &filter_sn[6] },
424 { "sn7", vtype_filter_int, &filter_sn[7] },
425 { "sn8", vtype_filter_int, &filter_sn[8] },
426 { "sn9", vtype_filter_int, &filter_sn[9] },
427 { "spool_directory", vtype_stringptr, &spool_directory },
428 { "spool_inodes", vtype_pinodes, (void *)TRUE },
429 { "spool_space", vtype_pspace, (void *)TRUE },
430 { "thisaddress", vtype_stringptr, &filter_thisaddress },
431 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
432 { "tls_cipher", vtype_stringptr, &tls_cipher },
433 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
434 { "tod_bsdinbox", vtype_todbsdin, NULL },
435 { "tod_epoch", vtype_tode, NULL },
436 { "tod_full", vtype_todf, NULL },
437 { "tod_log", vtype_todl, NULL },
438 { "tod_logfile", vtype_todlf, NULL },
439 { "tod_zone", vtype_todzone, NULL },
440 { "tod_zulu", vtype_todzulu, NULL },
441 { "value", vtype_stringptr, &lookup_value },
442 { "version_number", vtype_stringptr, &version_string },
443 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
444 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
445 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
446 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
447 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
448 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
451 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
452 static uschar var_buffer[256];
453 static BOOL malformed_header;
455 /* For textual hashes */
457 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
458 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
461 enum { HMAC_MD5, HMAC_SHA1 };
463 /* For numeric hashes */
465 static unsigned int prime[] = {
466 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
467 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
468 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
470 /* For printing modes in symbolic form */
472 static uschar *mtable_normal[] =
473 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
475 static uschar *mtable_setid[] =
476 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
478 static uschar *mtable_sticky[] =
479 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
483 /*************************************************
484 * Tables for UTF-8 support *
485 *************************************************/
487 /* Table of the number of extra characters, indexed by the first character
488 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
491 static uschar utf8_table1[] = {
492 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
493 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
494 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
495 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
497 /* These are the masks for the data bits in the first byte of a character,
498 indexed by the number of additional bytes. */
500 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
502 /* Get the next UTF-8 character, advancing the pointer. */
504 #define GETUTF8INC(c, ptr) \
506 if ((c & 0xc0) == 0xc0) \
508 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
510 c = (c & utf8_table2[a]) << s; \
514 c |= (*ptr++ & 0x3f) << s; \
519 /*************************************************
520 * Binary chop search on a table *
521 *************************************************/
523 /* This is used for matching expansion items and operators.
526 name the name that is being sought
527 table the table to search
528 table_size the number of items in the table
530 Returns: the offset in the table, or -1
534 chop_match(uschar *name, uschar **table, int table_size)
536 uschar **bot = table;
537 uschar **top = table + table_size;
541 uschar **mid = bot + (top - bot)/2;
542 int c = Ustrcmp(name, *mid);
543 if (c == 0) return mid - table;
544 if (c > 0) bot = mid + 1; else top = mid;
552 /*************************************************
553 * Check a condition string *
554 *************************************************/
556 /* This function is called to expand a string, and test the result for a "true"
557 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
558 forced fail or lookup defer. All store used by the function can be released on
562 condition the condition string
563 m1 text to be incorporated in panic error
566 Returns: TRUE if condition is met, FALSE if not
570 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
573 void *reset_point = store_get(0);
574 uschar *ss = expand_string(condition);
577 if (!expand_string_forcedfail && !search_find_defer)
578 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
579 "for %s %s: %s", condition, m1, m2, expand_string_message);
582 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
583 strcmpic(ss, US"false") != 0;
584 store_reset(reset_point);
590 /*************************************************
591 * Pick out a name from a string *
592 *************************************************/
594 /* If the name is too long, it is silently truncated.
597 name points to a buffer into which to put the name
598 max is the length of the buffer
599 s points to the first alphabetic character of the name
600 extras chars other than alphanumerics to permit
602 Returns: pointer to the first character after the name
604 Note: The test for *s != 0 in the while loop is necessary because
605 Ustrchr() yields non-NULL if the character is zero (which is not something
609 read_name(uschar *name, int max, uschar *s, uschar *extras)
612 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
614 if (ptr < max-1) name[ptr++] = *s;
623 /*************************************************
624 * Pick out the rest of a header name *
625 *************************************************/
627 /* A variable name starting $header_ (or just $h_ for those who like
628 abbreviations) might not be the complete header name because headers can
629 contain any printing characters in their names, except ':'. This function is
630 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
631 on the end, if the name was terminated by white space.
634 name points to a buffer in which the name read so far exists
635 max is the length of the buffer
636 s points to the first character after the name so far, i.e. the
637 first non-alphameric character after $header_xxxxx
639 Returns: a pointer to the first character after the header name
643 read_header_name(uschar *name, int max, uschar *s)
645 int prelen = Ustrchr(name, '_') - name + 1;
646 int ptr = Ustrlen(name) - prelen;
647 if (ptr > 0) memmove(name, name+prelen, ptr);
648 while (mac_isgraph(*s) && *s != ':')
650 if (ptr < max-1) name[ptr++] = *s;
661 /*************************************************
662 * Pick out a number from a string *
663 *************************************************/
666 n points to an integer into which to put the number
667 s points to the first digit of the number
669 Returns: a pointer to the character after the last digit
673 read_number(int *n, uschar *s)
676 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
682 /*************************************************
683 * Extract keyed subfield from a string *
684 *************************************************/
686 /* The yield is in dynamic store; NULL means that the key was not found.
689 key points to the name of the key
690 s points to the string from which to extract the subfield
692 Returns: NULL if the subfield was not found, or
693 a pointer to the subfield's data
697 expand_getkeyed(uschar *key, uschar *s)
699 int length = Ustrlen(key);
700 while (isspace(*s)) s++;
702 /* Loop to search for the key */
710 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
711 dkeylength = s - dkey;
712 while (isspace(*s)) s++;
713 if (*s == '=') while (isspace((*(++s))));
715 data = string_dequote(&s);
716 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
719 while (isspace(*s)) s++;
728 /*************************************************
729 * Extract numbered subfield from string *
730 *************************************************/
732 /* Extracts a numbered field from a string that is divided by tokens - for
733 example a line from /etc/passwd is divided by colon characters. First field is
734 numbered one. Negative arguments count from the right. Zero returns the whole
735 string. Returns NULL if there are insufficient tokens in the string
738 Modifies final argument - this is a dynamically generated string, so that's OK.
741 field number of field to be extracted,
742 first field = 1, whole string = 0, last field = -1
743 separators characters that are used to break string into tokens
744 s points to the string from which to extract the subfield
746 Returns: NULL if the field was not found,
747 a pointer to the field's data inside s (modified to add 0)
751 expand_gettokened (int field, uschar *separators, uschar *s)
756 uschar *fieldtext = NULL;
758 if (field == 0) return s;
760 /* Break the line up into fields in place; for field > 0 we stop when we have
761 done the number of fields we want. For field < 0 we continue till the end of
762 the string, counting the number of fields. */
764 count = (field > 0)? field : INT_MAX;
770 /* Previous field was the last one in the string. For a positive field
771 number, this means there are not enough fields. For a negative field number,
772 check that there are enough, and scan back to find the one that is wanted. */
776 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
777 if ((-field) == (INT_MAX - count - 1)) return s;
781 while (ss[-1] != 0) ss--;
787 /* Previous field was not last in the string; save its start and put a
791 len = Ustrcspn(ss, separators);
802 /*************************************************
803 * Extract a substring from a string *
804 *************************************************/
806 /* Perform the ${substr or ${length expansion operations.
809 subject the input string
810 value1 the offset from the start of the input string to the start of
811 the output string; if negative, count from the right.
812 value2 the length of the output string, or negative (-1) for unset
813 if value1 is positive, unset means "all after"
814 if value1 is negative, unset means "all before"
815 len set to the length of the returned string
817 Returns: pointer to the output string, or NULL if there is an error
821 extract_substr(uschar *subject, int value1, int value2, int *len)
823 int sublen = Ustrlen(subject);
825 if (value1 < 0) /* count from right */
829 /* If the position is before the start, skip to the start, and adjust the
830 length. If the length ends up negative, the substring is null because nothing
831 can precede. This falls out naturally when the length is unset, meaning "all
837 if (value2 < 0) value2 = 0;
841 /* Otherwise an unset length => characters before value1 */
850 /* For a non-negative offset, if the starting position is past the end of the
851 string, the result will be the null string. Otherwise, an unset length means
852 "rest"; just set it to the maximum - it will be cut down below if necessary. */
861 else if (value2 < 0) value2 = sublen;
864 /* Cut the length down to the maximum possible for the offset value, and get
865 the required characters. */
867 if (value1 + value2 > sublen) value2 = sublen - value1;
869 return subject + value1;
875 /*************************************************
876 * Old-style hash of a string *
877 *************************************************/
879 /* Perform the ${hash expansion operation.
882 subject the input string (an expanded substring)
883 value1 the length of the output string; if greater or equal to the
884 length of the input string, the input string is returned
885 value2 the number of hash characters to use, or 26 if negative
886 len set to the length of the returned string
888 Returns: pointer to the output string, or NULL if there is an error
892 compute_hash(uschar *subject, int value1, int value2, int *len)
894 int sublen = Ustrlen(subject);
896 if (value2 < 0) value2 = 26;
897 else if (value2 > Ustrlen(hashcodes))
899 expand_string_message =
900 string_sprintf("hash count \"%d\" too big", value2);
904 /* Calculate the hash text. We know it is shorter than the original string, so
905 can safely place it in subject[] (we know that subject is always itself an
906 expanded substring). */
913 while ((c = (subject[j])) != 0)
915 int shift = (c + j++) & 7;
916 subject[i] ^= (c << shift) | (c >> (8-shift));
917 if (++i >= value1) i = 0;
919 for (i = 0; i < value1; i++)
920 subject[i] = hashcodes[(subject[i]) % value2];
922 else value1 = sublen;
931 /*************************************************
932 * Numeric hash of a string *
933 *************************************************/
935 /* Perform the ${nhash expansion operation. The first characters of the
936 string are treated as most important, and get the highest prime numbers.
939 subject the input string
940 value1 the maximum value of the first part of the result
941 value2 the maximum value of the second part of the result,
942 or negative to produce only a one-part result
943 len set to the length of the returned string
945 Returns: pointer to the output string, or NULL if there is an error.
949 compute_nhash (uschar *subject, int value1, int value2, int *len)
953 unsigned long int total = 0; /* no overflow */
957 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
958 total += prime[i--] * (unsigned int)(*s++);
961 /* If value2 is unset, just compute one number */
965 s = string_sprintf("%d", total % value1);
968 /* Otherwise do a div/mod hash */
972 total = total % (value1 * value2);
973 s = string_sprintf("%d/%d", total/value2, total % value2);
984 /*************************************************
985 * Find the value of a header or headers *
986 *************************************************/
988 /* Multiple instances of the same header get concatenated, and this function
989 can also return a concatenation of all the header lines. When concatenating
990 specific headers that contain lists of addresses, a comma is inserted between
991 them. Otherwise we use a straight concatenation. Because some messages can have
992 pathologically large number of lines, there is a limit on the length that is
993 returned. Also, to avoid massive store use which would result from using
994 string_cat() as it copies and extends strings, we do a preliminary pass to find
995 out exactly how much store will be needed. On "normal" messages this will be
999 name the name of the header, without the leading $header_ or $h_,
1000 or NULL if a concatenation of all headers is required
1001 exists_only TRUE if called from a def: test; don't need to build a string;
1002 just return a string that is not "" and not "0" if the header
1004 newsize return the size of memory block that was obtained; may be NULL
1005 if exists_only is TRUE
1006 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1007 other than concatenating, will be done on the header
1008 charset name of charset to translate MIME words to; used only if
1009 want_raw is false; if NULL, no translation is done (this is
1010 used for $bh_ and $bheader_)
1012 Returns: NULL if the header does not exist, else a pointer to a new
1017 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1020 BOOL found = name == NULL;
1022 int len = found? 0 : Ustrlen(name);
1024 uschar *yield = NULL;
1027 /* Loop for two passes - saves code repetition */
1029 for (i = 0; i < 2; i++)
1034 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1036 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1038 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1043 if (exists_only) return US"1"; /* don't need actual string */
1045 t = h->text + len; /* text to insert */
1046 if (!want_raw) /* unless wanted raw, */
1047 while (isspace(*t)) t++; /* remove leading white space */
1048 ilen = h->slen - (t - h->text); /* length to insert */
1050 /* Set comma = 1 if handling a single header and it's one of those
1051 that contains an address list, except when asked for raw headers. Only
1052 need to do this once. */
1054 if (!want_raw && name != NULL && comma == 0 &&
1055 Ustrchr("BCFRST", h->type) != NULL)
1058 /* First pass - compute total store needed; second pass - compute
1059 total store used, including this header. */
1061 size += ilen + comma;
1063 /* Second pass - concatentate the data, up to a maximum. Note that
1064 the loop stops when size hits the limit. */
1068 if (size > header_insert_maxlen)
1070 ilen -= size - header_insert_maxlen;
1073 Ustrncpy(ptr, t, ilen);
1075 if (comma != 0 && ilen > 0)
1085 /* At end of first pass, truncate size if necessary, and get the buffer
1086 to hold the data, returning the buffer size. */
1090 if (!found) return NULL;
1091 if (size > header_insert_maxlen) size = header_insert_maxlen;
1092 *newsize = size + 1;
1093 ptr = yield = store_get(*newsize);
1097 /* Remove a redundant added comma if present */
1099 if (comma != 0 && ptr > yield) ptr -= 2;
1101 /* That's all we do for raw header expansion. */
1108 /* Otherwise, we remove trailing whitespace, including newlines. Then we do RFC
1109 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1110 function can return an error with decoded data if the charset translation
1111 fails. If decoding fails, it returns NULL. */
1115 uschar *decoded, *error;
1116 while (ptr > yield && isspace(ptr[-1])) ptr--;
1118 decoded = rfc2047_decode2(yield, TRUE, charset, '?', NULL, newsize, &error);
1121 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1122 " input was: %s\n", error, yield);
1124 if (decoded != NULL) yield = decoded;
1133 /*************************************************
1134 * Find value of a variable *
1135 *************************************************/
1137 /* The table of variables is kept in alphabetic order, so we can search it
1138 using a binary chop. The "choplen" variable is nothing to do with the binary
1142 name the name of the variable being sought
1143 exists_only TRUE if this is a def: test; passed on to find_header()
1144 skipping TRUE => skip any processing evaluation; this is not the same as
1145 exists_only because def: may test for values that are first
1147 newsize pointer to an int which is initially zero; if the answer is in
1148 a new memory buffer, *newsize is set to its size
1150 Returns: NULL if the variable does not exist, or
1151 a pointer to the variable's contents, or
1152 something non-NULL if exists_only is TRUE
1156 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1159 int last = var_table_size;
1161 while (last > first)
1165 int middle = (first + last)/2;
1166 int c = Ustrcmp(name, var_table[middle].name);
1168 if (c > 0) { first = middle + 1; continue; }
1169 if (c < 0) { last = middle; continue; }
1171 /* Found an existing variable. If in skipping state, the value isn't needed,
1172 and we want to avoid processing (such as looking up up the host name). */
1174 if (skipping) return US"";
1176 switch (var_table[middle].type)
1178 case vtype_filter_int:
1179 if (!filter_running) return NULL;
1183 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1187 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1191 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1195 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1198 case vtype_stringptr: /* Pointer to string */
1199 s = *((uschar **)(var_table[middle].value));
1200 return (s == NULL)? US"" : s;
1203 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1206 case vtype_load_avg:
1207 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1210 case vtype_host_lookup: /* Lookup if not done so */
1211 if (sender_host_name == NULL && sender_host_address != NULL &&
1212 !host_lookup_failed && host_name_lookup() == OK)
1213 host_build_sender_fullhost();
1214 return (sender_host_name == NULL)? US"" : sender_host_name;
1216 case vtype_localpart: /* Get local part from address */
1217 s = *((uschar **)(var_table[middle].value));
1218 if (s == NULL) return US"";
1219 domain = Ustrrchr(s, '@');
1220 if (domain == NULL) return s;
1221 if (domain - s > sizeof(var_buffer) - 1)
1222 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1223 "string expansion", sizeof(var_buffer));
1224 Ustrncpy(var_buffer, s, domain - s);
1225 var_buffer[domain - s] = 0;
1228 case vtype_domain: /* Get domain from address */
1229 s = *((uschar **)(var_table[middle].value));
1230 if (s == NULL) return US"";
1231 domain = Ustrrchr(s, '@');
1232 return (domain == NULL)? US"" : domain + 1;
1234 case vtype_msgheaders:
1235 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1237 case vtype_msgbody: /* Pointer to msgbody string */
1238 case vtype_msgbody_end: /* Ditto, the end of the msg */
1239 ss = (uschar **)(var_table[middle].value);
1240 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1243 int start_offset = SPOOL_DATA_START_OFFSET;
1244 int len = message_body_visible;
1245 if (len > message_size) len = message_size;
1246 *ss = body = store_malloc(len+1);
1248 if (var_table[middle].type == vtype_msgbody_end)
1250 struct stat statbuf;
1251 if (fstat(deliver_datafile, &statbuf) == 0)
1253 start_offset = statbuf.st_size - len;
1254 if (start_offset < SPOOL_DATA_START_OFFSET)
1255 start_offset = SPOOL_DATA_START_OFFSET;
1258 lseek(deliver_datafile, start_offset, SEEK_SET);
1259 len = read(deliver_datafile, body, len);
1265 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1269 return (*ss == NULL)? US"" : *ss;
1271 case vtype_todbsdin: /* BSD inbox time of day */
1272 return tod_stamp(tod_bsdin);
1274 case vtype_tode: /* Unix epoch time of day */
1275 return tod_stamp(tod_epoch);
1277 case vtype_todf: /* Full time of day */
1278 return tod_stamp(tod_full);
1280 case vtype_todl: /* Log format time of day */
1281 return tod_stamp(tod_log_bare); /* (without timezone) */
1283 case vtype_todzone: /* Time zone offset only */
1284 return tod_stamp(tod_zone);
1286 case vtype_todzulu: /* Zulu time */
1287 return tod_stamp(tod_zulu);
1289 case vtype_todlf: /* Log file datestamp tod */
1290 return tod_stamp(tod_log_datestamp);
1292 case vtype_reply: /* Get reply address */
1293 s = find_header(US"reply-to:", exists_only, newsize, FALSE,
1295 if (s == NULL || *s == 0)
1296 s = find_header(US"from:", exists_only, newsize, FALSE, headers_charset);
1297 return (s == NULL)? US"" : s;
1299 /* A recipients list is available only during system message filtering,
1300 during ACL processing after DATA, and while expanding pipe commands
1301 generated from a system filter, but not elsewhere. */
1303 case vtype_recipients:
1304 if (!enable_dollar_recipients) return NULL; else
1309 s = store_get(size);
1310 for (i = 0; i < recipients_count; i++)
1312 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1313 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1314 Ustrlen(recipients_list[i].address));
1316 s[ptr] = 0; /* string_cat() leaves room */
1323 sprintf(CS var_buffer, "%d",
1324 receive_statvfs((BOOL)(var_table[middle].value), &inodes));
1331 (void) receive_statvfs((BOOL)(var_table[middle].value), &inodes);
1332 sprintf(CS var_buffer, "%d", inodes);
1338 return NULL; /* Unknown variable name */
1344 /*************************************************
1345 * Read and expand substrings *
1346 *************************************************/
1348 /* This function is called to read and expand argument substrings for various
1349 expansion items. Some have a minimum requirement that is less than the maximum;
1350 in these cases, the first non-present one is set to NULL.
1353 sub points to vector of pointers to set
1354 n maximum number of substrings
1356 sptr points to current string pointer
1357 skipping the skipping flag
1358 check_end if TRUE, check for final '}'
1359 name name of item, for error message
1361 Returns: 0 OK; string pointer updated
1362 1 curly bracketing error (too few arguments)
1363 2 too many arguments (only if check_end is set); message set
1364 3 other error (expansion failure)
1368 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1369 BOOL check_end, uschar *name)
1374 while (isspace(*s)) s++;
1375 for (i = 0; i < n; i++)
1379 if (i < m) return 1;
1383 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1384 if (sub[i] == NULL) return 3;
1385 if (*s++ != '}') return 1;
1386 while (isspace(*s)) s++;
1388 if (check_end && *s++ != '}')
1392 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1393 "(max is %d)", name, n);
1406 /*************************************************
1407 * Read and evaluate a condition *
1408 *************************************************/
1412 s points to the start of the condition text
1413 yield points to a BOOL to hold the result of the condition test;
1414 if NULL, we are just reading through a condition that is
1415 part of an "or" combination to check syntax, or in a state
1416 where the answer isn't required
1418 Returns: a pointer to the first character after the condition, or
1423 eval_condition(uschar *s, BOOL *yield)
1425 BOOL testfor = TRUE;
1426 BOOL tempcond, combined_cond;
1428 int i, rc, cond_type, roffset;
1430 struct stat statbuf;
1435 const uschar *rerror;
1439 while (isspace(*s)) s++;
1440 if (*s == '!') { testfor = !testfor; s++; } else break;
1443 /* Numeric comparisons are symbolic */
1445 if (*s == '=' || *s == '>' || *s == '<')
1457 /* All other conditions are named */
1459 else s = read_name(name, 256, s, US"_");
1461 /* If we haven't read a name, it means some non-alpha character is first. */
1465 expand_string_message = string_sprintf("condition name expected, "
1466 "but found \"%.16s\"", s);
1470 /* Find which condition we are dealing with, and switch on it */
1472 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1475 /* def: tests for a non-zero or non-NULL variable, or for an existing
1481 expand_string_message = US"\":\" expected after \"def\"";
1485 s = read_name(name, 256, s+1, US"_");
1487 /* Test for a header's existence */
1489 if (Ustrncmp(name, "h_", 2) == 0 ||
1490 Ustrncmp(name, "rh_", 3) == 0 ||
1491 Ustrncmp(name, "bh_", 3) == 0 ||
1492 Ustrncmp(name, "header_", 7) == 0 ||
1493 Ustrncmp(name, "rheader_", 8) == 0 ||
1494 Ustrncmp(name, "bheader_", 8) == 0)
1496 s = read_header_name(name, 256, s);
1497 if (yield != NULL) *yield =
1498 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1501 /* Test for a variable's having a non-empty value. If yield == NULL we
1502 are in a skipping state, and don't care about the answer. */
1506 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1509 expand_string_message = (name[0] == 0)?
1510 string_sprintf("variable name omitted after \"def:\"") :
1511 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1515 *yield = (value[0] != 0 && Ustrcmp(value, "0") != 0) == testfor;
1521 /* first_delivery tests for first delivery attempt */
1523 case ECOND_FIRST_DELIVERY:
1524 if (yield != NULL) *yield = deliver_firsttime == testfor;
1528 /* queue_running tests for any process started by a queue runner */
1530 case ECOND_QUEUE_RUNNING:
1531 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1535 /* exists: tests for file existence
1536 isip: tests for any IP address
1537 isip4: tests for an IPv4 address
1538 isip6: tests for an IPv6 address
1539 pam: does PAM authentication
1540 radius: does RADIUS authentication
1541 ldapauth: does LDAP authentication
1542 pwcheck: does Cyrus SASL pwcheck authentication
1551 case ECOND_LDAPAUTH:
1554 while (isspace(*s)) s++;
1555 if (*s != '{') goto COND_FAILED_CURLY_START;
1557 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1558 if (sub[0] == NULL) return NULL;
1559 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1561 if (yield == NULL) return s; /* No need to run the test if skipping */
1566 if ((expand_forbid & RDO_EXISTS) != 0)
1568 expand_string_message = US"File existence tests are not permitted";
1571 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1577 rc = string_is_ip_address(sub[0], NULL);
1578 *yield = ((cond_type == ECOND_ISIP)? (rc > 0) :
1579 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1582 /* Various authentication tests - all optionally compiled */
1586 rc = auth_call_pam(sub[0], &expand_string_message);
1589 goto COND_FAILED_NOT_COMPILED;
1590 #endif /* SUPPORT_PAM */
1593 #ifdef RADIUS_CONFIG_FILE
1594 rc = auth_call_radius(sub[0], &expand_string_message);
1597 goto COND_FAILED_NOT_COMPILED;
1598 #endif /* RADIUS_CONFIG_FILE */
1600 case ECOND_LDAPAUTH:
1603 /* Just to keep the interface the same */
1605 int old_pool = store_pool;
1606 store_pool = POOL_SEARCH;
1607 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1608 &expand_string_message, &do_cache);
1609 store_pool = old_pool;
1613 goto COND_FAILED_NOT_COMPILED;
1614 #endif /* LOOKUP_LDAP */
1617 #ifdef CYRUS_PWCHECK_SOCKET
1618 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1621 goto COND_FAILED_NOT_COMPILED;
1622 #endif /* CYRUS_PWCHECK_SOCKET */
1624 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1625 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1627 if (rc == ERROR || rc == DEFER) return NULL;
1628 *yield = (rc == OK) == testfor;
1634 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1636 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1638 However, the last two are optional. That is why the whole set is enclosed
1639 in their own set or braces. */
1641 case ECOND_SASLAUTHD:
1642 #ifndef CYRUS_SASLAUTHD_SOCKET
1643 goto COND_FAILED_NOT_COMPILED;
1645 while (isspace(*s)) s++;
1646 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1647 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1649 case 1: expand_string_message = US"too few arguments or bracketing "
1650 "error for saslauthd";
1652 case 3: return NULL;
1654 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1658 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1659 &expand_string_message);
1660 if (rc == ERROR || rc == DEFER) return NULL;
1661 *yield = (rc == OK) == testfor;
1664 #endif /* CYRUS_SASLAUTHD_SOCKET */
1667 /* symbolic operators for numeric and string comparison, and a number of
1668 other operators, all requiring two arguments.
1670 match: does a regular expression match and sets up the numerical
1671 variables if it succeeds
1672 match_address: matches in an address list
1673 match_domain: matches in a domain list
1674 match_local_part: matches in a local part list
1675 crypteq: encrypts plaintext and compares against an encrypted text,
1676 using crypt(), crypt16(), MD5 or SHA-1
1680 case ECOND_MATCH_ADDRESS:
1681 case ECOND_MATCH_DOMAIN:
1682 case ECOND_MATCH_LOCAL_PART:
1685 case ECOND_NUM_L: /* Numerical comparisons */
1692 case ECOND_STR_LT: /* String comparisons */
1703 for (i = 0; i < 2; i++)
1705 while (isspace(*s)) s++;
1708 if (i == 0) goto COND_FAILED_CURLY_START;
1709 expand_string_message = string_sprintf("missing 2nd string in {} "
1710 "after \"%s\"", name);
1713 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1714 if (sub[i] == NULL) return NULL;
1715 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1717 /* Convert to numerical if required; we know that the names of all the
1718 conditions that compare numbers do not start with a letter. This just saves
1719 checking for them individually. */
1721 if (!isalpha(name[0]))
1724 num[i] = (int)Ustrtol((const uschar *)sub[i], &endptr, 10);
1725 if (tolower(*endptr) == 'k')
1730 else if (tolower(*endptr) == 'm')
1732 num[i] *= 1024*1024;
1735 while (isspace(*endptr)) endptr++;
1738 expand_string_message = string_sprintf("\"%s\" is not a number",
1745 /* Result not required */
1747 if (yield == NULL) return s;
1749 /* Do an appropriate comparison */
1755 *yield = (num[0] == num[1]) == testfor;
1759 *yield = (num[0] > num[1]) == testfor;
1763 *yield = (num[0] >= num[1]) == testfor;
1767 *yield = (num[0] < num[1]) == testfor;
1771 *yield = (num[0] <= num[1]) == testfor;
1775 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1779 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1783 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1787 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1791 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1795 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1799 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1803 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1807 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
1811 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
1814 case ECOND_MATCH: /* Regular expression match */
1815 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1819 expand_string_message = string_sprintf("regular expression error in "
1820 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1823 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1826 case ECOND_MATCH_ADDRESS: /* Match in an address list */
1827 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1828 goto MATCHED_SOMETHING;
1830 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
1831 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1832 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1833 goto MATCHED_SOMETHING;
1835 case ECOND_MATCH_LOCAL_PART:
1836 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
1837 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
1852 expand_string_message = string_sprintf("unable to complete match "
1853 "against \"%s\": %s", sub[1], search_error_message);
1859 /* Various "encrypted" comparisons. If the second string starts with
1860 "{" then an encryption type is given. Default to crypt() or crypt16()
1861 (build-time choice). */
1864 #ifndef SUPPORT_CRYPTEQ
1865 goto COND_FAILED_NOT_COMPILED;
1867 if (strncmpic(sub[1], US"{md5}", 5) == 0)
1869 int sublen = Ustrlen(sub[1]+5);
1874 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
1876 /* If the length that we are comparing against is 24, the MD5 digest
1877 is expressed as a base64 string. This is the way LDAP does it. However,
1878 some other software uses a straightforward hex representation. We assume
1879 this if the length is 32. Other lengths fail. */
1883 uschar *coded = auth_b64encode((uschar *)digest, 16);
1884 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
1885 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
1886 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
1888 else if (sublen == 32)
1892 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
1894 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
1895 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
1896 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
1900 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
1901 "fail\n crypted=%s\n", sub[1]+5);
1906 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
1908 int sublen = Ustrlen(sub[1]+6);
1913 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
1915 /* If the length that we are comparing against is 28, assume the SHA1
1916 digest is expressed as a base64 string. If the length is 40, assume a
1917 straightforward hex representation. Other lengths fail. */
1921 uschar *coded = auth_b64encode((uschar *)digest, 20);
1922 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
1923 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
1924 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
1926 else if (sublen == 40)
1930 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
1932 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
1933 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
1934 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
1938 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
1939 "fail\n crypted=%s\n", sub[1]+6);
1944 else /* {crypt} or {crypt16} and non-{ at start */
1949 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
1954 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
1959 else if (sub[1][0] == '{')
1961 expand_string_message = string_sprintf("unknown encryption mechanism "
1962 "in \"%s\"", sub[1]);
1968 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
1969 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
1970 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
1974 #define XSTR(s) STR(s)
1975 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
1976 " subject=%s\n crypted=%s\n",
1977 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
1982 /* If the encrypted string contains fewer than two characters (for the
1983 salt), force failure. Otherwise we get false positives: with an empty
1984 string the yield of crypt() is an empty string! */
1986 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
1987 (Ustrcmp(coded, sub[1]) == 0) == testfor;
1990 #endif /* SUPPORT_CRYPTEQ */
1991 } /* Switch for comparison conditions */
1993 return s; /* End of comparison conditions */
1996 /* and/or: computes logical and/or of several conditions */
2000 subcondptr = (yield == NULL)? NULL : &tempcond;
2001 combined_cond = (cond_type == ECOND_AND);
2003 while (isspace(*s)) s++;
2004 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2008 while (isspace(*s)) s++;
2009 if (*s == '}') break;
2012 expand_string_message = string_sprintf("each subcondition "
2013 "inside an \"%s{...}\" condition must be in its own {}", name);
2017 s = eval_condition(s+1, subcondptr);
2020 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2021 expand_string_message, name);
2024 while (isspace(*s)) s++;
2028 expand_string_message = string_sprintf("missing } at end of condition "
2029 "inside \"%s\" group", name);
2035 if (cond_type == ECOND_AND)
2037 combined_cond &= tempcond;
2038 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2039 } /* evaluate any more */
2042 combined_cond |= tempcond;
2043 if (combined_cond) subcondptr = NULL; /* once true, don't */
2044 } /* evaluate any more */
2048 if (yield != NULL) *yield = (combined_cond == testfor);
2052 /* Unknown condition */
2055 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2057 } /* End switch on condition type */
2059 /* Missing braces at start and end of data */
2061 COND_FAILED_CURLY_START:
2062 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2065 COND_FAILED_CURLY_END:
2066 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2070 /* A condition requires code that is not compiled */
2072 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2073 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2074 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2075 COND_FAILED_NOT_COMPILED:
2076 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2085 /*************************************************
2086 * Save numerical variables *
2087 *************************************************/
2089 /* This function is called from items such as "if" that want to preserve and
2090 restore the numbered variables.
2093 save_expand_string points to an array of pointers to set
2094 save_expand_nlength points to an array of ints for the lengths
2096 Returns: the value of expand max to save
2100 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2103 for (i = 0; i <= expand_nmax; i++)
2105 save_expand_nstring[i] = expand_nstring[i];
2106 save_expand_nlength[i] = expand_nlength[i];
2113 /*************************************************
2114 * Restore numerical variables *
2115 *************************************************/
2117 /* This function restored saved values of numerical strings.
2120 save_expand_nmax the number of strings to restore
2121 save_expand_string points to an array of pointers
2122 save_expand_nlength points to an array of ints
2128 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2129 int *save_expand_nlength)
2132 expand_nmax = save_expand_nmax;
2133 for (i = 0; i <= expand_nmax; i++)
2135 expand_nstring[i] = save_expand_nstring[i];
2136 expand_nlength[i] = save_expand_nlength[i];
2144 /*************************************************
2145 * Handle yes/no substrings *
2146 *************************************************/
2148 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2149 alternative substrings that depend on whether or not the condition was true,
2150 or the lookup or extraction succeeded. The substrings always have to be
2151 expanded, to check their syntax, but "skipping" is set when the result is not
2152 needed - this avoids unnecessary nested lookups.
2155 skipping TRUE if we were skipping when this item was reached
2156 yes TRUE if the first string is to be used, else use the second
2157 save_lookup a value to put back into lookup_value before the 2nd expansion
2158 sptr points to the input string pointer
2159 yieldptr points to the output string pointer
2160 sizeptr points to the output string size
2161 ptrptr points to the output string pointer
2162 type "lookup" or "if" or "extract" or "run", for error message
2164 Returns: 0 OK; lookup_value has been reset to save_lookup
2166 2 expansion failed because of bracketing error
2170 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2171 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2174 uschar *s = *sptr; /* Local value */
2175 uschar *sub1, *sub2;
2177 /* If there are no following strings, we substitute the contents of $value for
2178 lookups and for extractions in the success case. For the ${if item, the string
2179 "true" is substituted. In the fail case, nothing is substituted for all three
2182 while (isspace(*s)) s++;
2187 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2191 if (yes && lookup_value != NULL)
2192 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2193 Ustrlen(lookup_value));
2194 lookup_value = save_lookup;
2200 /* Expand the first substring. Forced failures are noticed only if we actually
2201 want this string. Set skipping in the call in the fail case (this will always
2202 be the case if we were already skipping). */
2204 sub1 = expand_string_internal(s+1, TRUE, &s, !yes);
2205 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2206 expand_string_forcedfail = FALSE;
2207 if (*s++ != '}') goto FAILED_CURLY;
2209 /* If we want the first string, add it to the output */
2212 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2214 /* If this is called from a lookup or an extract, we want to restore $value to
2215 what it was at the start of the item, so that it has this value during the
2216 second string expansion. For the call from "if" to this function, save_lookup
2217 is set to lookup_value, so that this statement does nothing. */
2219 lookup_value = save_lookup;
2221 /* There now follows either another substring, or "fail", or nothing. This
2222 time, forced failures are noticed only if we want the second string. We must
2223 set skipping in the nested call if we don't want this string, or if we were
2224 already skipping. */
2226 while (isspace(*s)) s++;
2229 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2230 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2231 expand_string_forcedfail = FALSE;
2232 if (*s++ != '}') goto FAILED_CURLY;
2234 /* If we want the second string, add it to the output */
2237 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2240 /* If there is no second string, but the word "fail" is present when the use of
2241 the second string is wanted, set a flag indicating it was a forced failure
2242 rather than a syntactic error. Swallow the terminating } in case this is nested
2243 inside another lookup or if or extract. */
2248 s = read_name(name, sizeof(name), s, US"_");
2249 if (Ustrcmp(name, "fail") == 0)
2251 if (!yes && !skipping)
2253 while (isspace(*s)) s++;
2254 if (*s++ != '}') goto FAILED_CURLY;
2255 expand_string_message =
2256 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2257 expand_string_forcedfail = TRUE;
2263 expand_string_message =
2264 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2269 /* All we have to do now is to check on the final closing brace. */
2271 while (isspace(*s)) s++;
2272 if (*s++ == '}') goto RETURN;
2274 /* Get here if there is a bracketing failure */
2279 /* Get here for other failures */
2284 /* Update the input pointer value before returning */
2296 /*************************************************
2297 * Handle MD5 or SHA-1 computation for HMAC *
2298 *************************************************/
2300 /* These are some wrapping functions that enable the HMAC code to be a bit
2301 cleaner. A good compiler will spot the tail recursion.
2304 type HMAC_MD5 or HMAC_SHA1
2305 remaining are as for the cryptographic hash functions
2311 chash_start(int type, void *base)
2313 if (type == HMAC_MD5)
2314 md5_start((md5 *)base);
2316 sha1_start((sha1 *)base);
2320 chash_mid(int type, void *base, uschar *string)
2322 if (type == HMAC_MD5)
2323 md5_mid((md5 *)base, string);
2325 sha1_mid((sha1 *)base, string);
2329 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2331 if (type == HMAC_MD5)
2332 md5_end((md5 *)base, string, length, digest);
2334 sha1_end((sha1 *)base, string, length, digest);
2341 /*************************************************
2342 * Join a file onto the output string *
2343 *************************************************/
2345 /* This is used for readfile and after a run expansion. It joins the contents
2346 of a file onto the output string, globally replacing newlines with a given
2347 string (optionally). The file is closed at the end.
2351 yield pointer to the expandable string
2352 sizep pointer to the current size
2353 ptrp pointer to the current position
2354 eol newline replacement string, or NULL
2356 Returns: new value of string pointer
2360 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2363 uschar buffer[1024];
2365 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2367 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2369 int len = Ustrlen(buffer);
2370 if (eol != NULL && buffer[len-1] == '\n') len--;
2371 yield = string_cat(yield, sizep, ptrp, buffer, len);
2372 if (buffer[len] != 0)
2373 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2376 if (yield != NULL) yield[*ptrp] = 0;
2384 /*************************************************
2385 * Evaluate numeric expression *
2386 *************************************************/
2388 /* This is a set of mutually recursive functions that evaluate a simple
2389 arithmetic expression involving only + - * / and parentheses. The only one that
2390 is called from elsewhere is eval_expr, whose interface is:
2393 sptr pointer to the pointer to the string - gets updated
2394 decimal TRUE if numbers are to be assumed decimal
2395 error pointer to where to put an error message - must be NULL on input
2396 endket TRUE if ')' must terminate - FALSE for external call
2399 Returns: on success: the value of the expression, with *error still NULL
2400 on failure: an undefined value, with *error = a message
2403 static int eval_sumterm(uschar **, BOOL, uschar **);
2406 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2409 int x = eval_sumterm(&s, decimal, error);
2412 while (*s == '+' || *s == '-')
2415 int y = eval_sumterm(&s, decimal, error);
2416 if (*error != NULL) break;
2417 if (op == '+') x += y; else x -= y;
2424 *error = US"expecting closing parenthesis";
2426 while (isspace(*(++s)));
2428 else if (*s != 0) *error = US"expecting + or -";
2437 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2442 while (isspace(*s)) s++;
2444 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2447 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2449 if (tolower(*s) == 'k') { n *= 1024; s++; }
2450 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2451 while (isspace (*s)) s++;
2456 n = eval_expr(&s, decimal, error, 1);
2460 *error = US"expecting number or opening parenthesis";
2467 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2470 int x = eval_term(&s, decimal, error);
2473 while (*s == '*' || *s == '/')
2476 int y = eval_term(&s, decimal, error);
2477 if (*error != NULL) break;
2478 if (op == '*') x *= y; else x /= y;
2488 /*************************************************
2490 *************************************************/
2492 /* Returns either an unchanged string, or the expanded string in stacking pool
2493 store. Interpreted sequences are:
2495 \... normal escaping rules
2496 $name substitutes the variable
2498 ${op:string} operates on the expanded string value
2499 ${item{arg1}{arg2}...} expands the args and then does the business
2500 some literal args are not enclosed in {}
2502 There are now far too many operators and item types to make it worth listing
2503 them here in detail any more.
2505 We use an internal routine recursively to handle embedded substrings. The
2506 external function follows. The yield is NULL if the expansion failed, and there
2507 are two cases: if something collapsed syntactically, or if "fail" was given
2508 as the action on a lookup failure. These can be distinguised by looking at the
2509 variable expand_string_forcedfail, which is TRUE in the latter case.
2511 The skipping flag is set true when expanding a substring that isn't actually
2512 going to be used (after "if" or "lookup") and it prevents lookups from
2513 happening lower down.
2515 Store usage: At start, a store block of the length of the input plus 64
2516 is obtained. This is expanded as necessary by string_cat(), which might have to
2517 get a new block, or might be able to expand the original. At the end of the
2518 function we can release any store above that portion of the yield block that
2519 was actually used. In many cases this will be optimal.
2521 However: if the first item in the expansion is a variable name or header name,
2522 we reset the store before processing it; if the result is in fresh store, we
2523 use that without copying. This is helpful for expanding strings like
2524 $message_headers which can get very long.
2527 string the string to be expanded
2528 ket_ends true if expansion is to stop at }
2529 left if not NULL, a pointer to the first character after the
2530 expansion is placed here (typically used with ket_ends)
2531 skipping TRUE for recursive calls when the value isn't actually going
2532 to be used (to allow for optimisation)
2534 Returns: NULL if expansion fails:
2535 expand_string_forcedfail is set TRUE if failure was forced
2536 expand_string_message contains a textual error message
2537 a pointer to the expanded string on success
2541 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2545 int size = Ustrlen(string)+ 64;
2547 uschar *yield = store_get(size);
2549 uschar *save_expand_nstring[EXPAND_MAXN+1];
2550 int save_expand_nlength[EXPAND_MAXN+1];
2552 expand_string_forcedfail = FALSE;
2553 expand_string_message = US"";
2560 /* \ escapes the next character, which must exist, or else
2561 the expansion fails. There's a special escape, \N, which causes
2562 copying of the subject verbatim up to the next \N. Otherwise,
2563 the escapes are the standard set. */
2569 expand_string_message = US"\\ at end of string";
2576 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2577 yield = string_cat(yield, &size, &ptr, t, s - t);
2578 if (*s != 0) s += 2;
2584 ch[0] = string_interpret_escape(&s);
2586 yield = string_cat(yield, &size, &ptr, ch, 1);
2592 /* Anything other than $ is just copied verbatim, unless we are
2593 looking for a terminating } character. */
2595 if (ket_ends && *s == '}') break;
2599 yield = string_cat(yield, &size, &ptr, s++, 1);
2603 /* No { after the $ - must be a plain name or a number for string
2604 match variable. There has to be a fudge for variables that are the
2605 names of header fields preceded by "$header_" because header field
2606 names can contain any printing characters except space and colon.
2607 For those that don't like typing this much, "$h_" is a synonym for
2608 "$header_". A non-existent header yields a NULL value; nothing is
2611 if (isalpha((*(++s))))
2616 s = read_name(name, sizeof(name), s, US"_");
2618 /* If this is the first thing to be expanded, release the pre-allocated
2621 if (ptr == 0 && yield != NULL)
2630 if (Ustrncmp(name, "h_", 2) == 0 ||
2631 Ustrncmp(name, "rh_", 3) == 0 ||
2632 Ustrncmp(name, "bh_", 3) == 0 ||
2633 Ustrncmp(name, "header_", 7) == 0 ||
2634 Ustrncmp(name, "rheader_", 8) == 0 ||
2635 Ustrncmp(name, "bheader_", 8) == 0)
2637 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2638 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2639 s = read_header_name(name, sizeof(name), s);
2640 value = find_header(name, FALSE, &newsize, want_raw, charset);
2642 /* If we didn't find the header, and the header contains a closing brace
2643 characters, this may be a user error where the terminating colon
2644 has been omitted. Set a flag to adjust the error message in this case.
2645 But there is no error here - nothing gets inserted. */
2649 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2658 value = find_variable(name, FALSE, skipping, &newsize);
2661 expand_string_message =
2662 string_sprintf("unknown variable name \"%s\"", name);
2667 /* If the data is known to be in a new buffer, newsize will be set to the
2668 size of that buffer. If this is the first thing in an expansion string,
2669 yield will be NULL; just point it at the new store instead of copying. Many
2670 expansion strings contain just one reference, so this is a useful
2671 optimization, especially for humungous headers. */
2673 len = Ustrlen(value);
2674 if (yield == NULL && newsize != 0)
2680 else yield = string_cat(yield, &size, &ptr, value, len);
2688 s = read_number(&n, s);
2689 if (n >= 0 && n <= expand_nmax)
2690 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2695 /* Otherwise, if there's no '{' after $ it's an error. */
2699 expand_string_message = US"$ not followed by letter, digit, or {";
2703 /* After { there can be various things, but they all start with
2704 an initial word, except for a number for a string match variable. */
2706 if (isdigit((*(++s))))
2709 s = read_number(&n, s);
2712 expand_string_message = US"} expected after number";
2715 if (n >= 0 && n <= expand_nmax)
2716 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2723 expand_string_message = US"letter or digit expected after ${";
2727 /* Allow "-" in names to cater for substrings with negative
2728 arguments. Since we are checking for known names after { this is
2731 s = read_name(name, sizeof(name), s, US"_-");
2732 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
2736 /* Handle conditionals - preserve the values of the numerical expansion
2737 variables in case they get changed by a regular expression match in the
2738 condition. If not, they retain their external settings. At the end
2739 of this "if" section, they get restored to their previous values. */
2745 int save_expand_nmax =
2746 save_expand_strings(save_expand_nstring, save_expand_nlength);
2748 while (isspace(*s)) s++;
2749 next_s = eval_condition(s, skipping? NULL : &cond);
2750 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
2753 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
2754 cond? "true" : "false");
2758 /* The handling of "yes" and "no" result strings is now in a separate
2759 function that is also used by ${lookup} and ${extract} and ${run}. */
2761 switch(process_yesno(
2762 skipping, /* were previously skipping */
2763 cond, /* success/failure indicator */
2764 lookup_value, /* value to reset for string2 */
2765 &s, /* input pointer */
2766 &yield, /* output pointer */
2767 &size, /* output size */
2768 &ptr, /* output current point */
2769 US"if")) /* condition type */
2771 case 1: goto EXPAND_FAILED; /* when all is well, the */
2772 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
2775 /* Restore external setting of expansion variables for continuation
2778 restore_expand_strings(save_expand_nmax, save_expand_nstring,
2779 save_expand_nlength);
2783 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
2784 expanding an internal string that isn't actually going to be used. All we
2785 need to do is check the syntax, so don't do a lookup at all. Preserve the
2786 values of the numerical expansion variables in case they get changed by a
2787 partial lookup. If not, they retain their external settings. At the end
2788 of this "lookup" section, they get restored to their previous values. */
2792 int stype, partial, affixlen, starflags;
2793 int expand_setup = 0;
2795 uschar *key, *filename, *affix;
2796 uschar *save_lookup_value = lookup_value;
2797 int save_expand_nmax =
2798 save_expand_strings(save_expand_nstring, save_expand_nlength);
2800 if ((expand_forbid & RDO_LOOKUP) != 0)
2802 expand_string_message = US"lookup expansions are not permitted";
2806 /* Get the key we are to look up for single-key+file style lookups.
2807 Otherwise set the key NULL pro-tem. */
2809 while (isspace(*s)) s++;
2812 key = expand_string_internal(s+1, TRUE, &s, skipping);
2813 if (key == NULL) goto EXPAND_FAILED;
2814 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
2815 while (isspace(*s)) s++;
2819 /* Find out the type of database */
2823 expand_string_message = US"missing lookup type";
2827 /* The type is a string that may contain special characters of various
2828 kinds. Allow everything except space or { to appear; the actual content
2829 is checked by search_findtype_partial. */
2831 while (*s != 0 && *s != '{' && !isspace(*s))
2833 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
2837 while (isspace(*s)) s++;
2839 /* Now check for the individual search type and any partial or default
2840 options. Only those types that are actually in the binary are valid. */
2842 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
2846 expand_string_message = search_error_message;
2850 /* Check that a key was provided for those lookup types that need it,
2851 and was not supplied for those that use the query style. */
2853 if (!mac_islookup(stype, lookup_querystyle))
2857 expand_string_message = string_sprintf("missing {key} for single-"
2858 "key \"%s\" lookup", name);
2866 expand_string_message = string_sprintf("a single key was given for "
2867 "lookup type \"%s\", which is not a single-key lookup type", name);
2872 /* Get the next string in brackets and expand it. It is the file name for
2873 single-key+file lookups, and the whole query otherwise. */
2875 if (*s != '{') goto EXPAND_FAILED_CURLY;
2876 filename = expand_string_internal(s+1, TRUE, &s, skipping);
2877 if (filename == NULL) goto EXPAND_FAILED;
2878 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
2879 while (isspace(*s)) s++;
2881 /* If this isn't a single-key+file lookup, re-arrange the variables
2882 to be appropriate for the search_ functions. */
2890 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
2891 the entry was not found. Note that there is no search_close() function.
2892 Files are left open in case of re-use. At suitable places in higher logic,
2893 search_tidyup() is called to tidy all open files. This can save opening
2894 the same file several times. However, files may also get closed when
2895 others are opened, if too many are open at once. The rule is that a
2896 handle should not be used after a second search_open().
2898 Request that a partial search sets up $1 and maybe $2 by passing
2899 expand_setup containing zero. If its value changes, reset expand_nmax,
2900 since new variables will have been set. Note that at the end of this
2901 "lookup" section, the old numeric variables are restored. */
2904 lookup_value = NULL;
2907 void *handle = search_open(filename, stype, 0, NULL, NULL);
2910 expand_string_message = search_error_message;
2913 lookup_value = search_find(handle, filename, key, partial, affix,
2914 affixlen, starflags, &expand_setup);
2915 if (search_find_defer)
2917 expand_string_message =
2918 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
2919 search_error_message);
2922 if (expand_setup > 0) expand_nmax = expand_setup;
2925 /* The handling of "yes" and "no" result strings is now in a separate
2926 function that is also used by ${if} and ${extract}. */
2928 switch(process_yesno(
2929 skipping, /* were previously skipping */
2930 lookup_value != NULL, /* success/failure indicator */
2931 save_lookup_value, /* value to reset for string2 */
2932 &s, /* input pointer */
2933 &yield, /* output pointer */
2934 &size, /* output size */
2935 &ptr, /* output current point */
2936 US"lookup")) /* condition type */
2938 case 1: goto EXPAND_FAILED; /* when all is well, the */
2939 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
2942 /* Restore external setting of expansion variables for carrying on
2943 at this level, and continue. */
2945 restore_expand_strings(save_expand_nmax, save_expand_nstring,
2946 save_expand_nlength);
2950 /* If Perl support is configured, handle calling embedded perl subroutines,
2951 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
2952 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
2953 arguments (defined below). */
2956 #define EXIM_PERL_MAX_ARGS 8
2960 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
2963 if ((expand_forbid & RDO_PERL) != 0)
2965 expand_string_message = US"Perl calls are not permitted";
2969 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
2972 case 1: goto EXPAND_FAILED_CURLY;
2974 case 3: goto EXPAND_FAILED;
2977 /* If skipping, we don't actually do anything */
2979 if (skipping) continue;
2981 /* Start the interpreter if necessary */
2983 if (!opt_perl_started)
2986 if (opt_perl_startup == NULL)
2988 expand_string_message = US"A setting of perl_startup is needed when "
2989 "using the Perl interpreter";
2992 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
2993 initerror = init_perl(opt_perl_startup);
2994 if (initerror != NULL)
2996 expand_string_message =
2997 string_sprintf("error in perl_startup code: %s\n", initerror);
3000 opt_perl_started = TRUE;
3003 /* Call the function */
3005 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3006 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3007 sub_arg[0], sub_arg + 1);
3009 /* NULL yield indicates failure; if the message pointer has been set to
3010 NULL, the yield was undef, indicating a forced failure. Otherwise the
3011 message will indicate some kind of Perl error. */
3013 if (new_yield == NULL)
3015 if (expand_string_message == NULL)
3017 expand_string_message =
3018 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3019 "failure", sub_arg[0]);
3020 expand_string_forcedfail = TRUE;
3025 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3026 set during a callback from Perl. */
3028 expand_string_forcedfail = FALSE;
3032 #endif /* EXIM_PERL */
3034 /* Handle "readfile" to insert an entire file */
3036 case EITEM_READFILE:
3041 if ((expand_forbid & RDO_READFILE) != 0)
3043 expand_string_message = US"file insertions are not permitted";
3047 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3049 case 1: goto EXPAND_FAILED_CURLY;
3051 case 3: goto EXPAND_FAILED;
3054 /* If skipping, we don't actually do anything */
3056 if (skipping) continue;
3058 /* Open the file and read it */
3060 f = Ufopen(sub_arg[0], "rb");
3063 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3067 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3072 /* Handle "readsocket" to insert data from a Unix domain socket */
3074 case EITEM_READSOCK:
3080 struct sockaddr_un sockun; /* don't call this "sun" ! */
3084 if ((expand_forbid & RDO_READSOCK) != 0)
3086 expand_string_message = US"socket insertions are not permitted";
3090 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3091 because there may be a string for expansion on failure. */
3093 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3095 case 1: goto EXPAND_FAILED_CURLY;
3096 case 2: /* Won't occur: no end check */
3097 case 3: goto EXPAND_FAILED;
3100 /* Sort out timeout, if given */
3102 if (sub_arg[2] != NULL)
3104 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3107 expand_string_message = string_sprintf("bad time value %s",
3112 else sub_arg[3] = NULL; /* No eol if no timeout */
3114 /* If skipping, we don't actually do anything */
3118 /* Make a connection to the socket */
3120 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3122 expand_string_message = string_sprintf("failed to create socket: %s",
3127 sockun.sun_family = AF_UNIX;
3128 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3130 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3132 expand_string_message = string_sprintf("failed to connect to socket "
3133 "%s: %s", sub_arg[0], strerror(errno));
3136 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3138 /* Write the request string, if not empty */
3140 if (sub_arg[1][0] != 0)
3142 int len = Ustrlen(sub_arg[1]);
3143 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3145 if (write(fd, sub_arg[1], len) != len)
3147 expand_string_message = string_sprintf("request write to socket "
3148 "failed: %s", strerror(errno));
3153 /* Now we need to read from the socket, under a timeout. The function
3154 that reads a file can be used. */
3156 f = fdopen(fd, "rb");
3157 sigalrm_seen = FALSE;
3159 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3163 /* After a timeout, we restore the pointer in the result, that is,
3164 make sure we add nothing from the socket. */
3169 expand_string_message = US"socket read timed out";
3174 /* The whole thing has worked (or we were skipping). If there is a
3175 failure string following, we need to skip it. */
3179 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3181 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3182 while (isspace(*s)) s++;
3184 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3187 /* Come here on failure to create socket, connect socket, write to the
3188 socket, or timeout on reading. If another substring follows, expand and
3189 use it. Otherwise, those conditions give expand errors. */
3192 if (*s != '{') goto EXPAND_FAILED;
3193 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3194 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3195 if (arg == NULL) goto EXPAND_FAILED;
3196 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3197 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3198 while (isspace(*s)) s++;
3199 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3203 /* Handle "run" to execute a program. */
3208 uschar *old_lookup_value = NULL;
3216 if ((expand_forbid & RDO_RUN) != 0)
3218 expand_string_message = US"running a command is not permitted";
3222 while (isspace(*s)) s++;
3223 if (*s != '{') goto EXPAND_FAILED_CURLY;
3224 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3225 if (arg == NULL) goto EXPAND_FAILED;
3226 while (isspace(*s)) s++;
3227 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3229 if (skipping) /* Just pretend it worked when we're skipping */
3235 if (!transport_set_up_command(&argv, /* anchor for arg list */
3236 arg, /* raw command */
3237 FALSE, /* don't expand the arguments */
3238 0, /* not relevant when... */
3239 NULL, /* no transporting address */
3240 US"${run} expansion", /* for error messages */
3241 &expand_string_message)) /* where to put error message */
3246 /* Create the child process, making it a group leader. */
3248 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3252 expand_string_message =
3253 string_sprintf("couldn't create child process: %s", strerror(errno));
3257 /* Nothing is written to the standard input. */
3261 /* Wait for the process to finish, applying the timeout, and inspect its
3262 return code for serious disasters. Simple non-zero returns are passed on.
3265 if ((runrc = child_close(pid, 60)) < 0)
3269 expand_string_message = string_sprintf("command timed out");
3270 killpg(pid, SIGKILL); /* Kill the whole process group */
3273 else if (runrc == -257)
3274 expand_string_message = string_sprintf("wait() failed: %s",
3278 expand_string_message = string_sprintf("command killed by signal %d",
3284 /* Read the pipe to get the command's output into $value (which is kept
3285 in lookup_value). */
3287 f = fdopen(fd_out, "rb");
3288 old_lookup_value = lookup_value;
3289 lookup_value = NULL;
3290 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3294 /* Process the yes/no strings */
3296 switch(process_yesno(
3297 skipping, /* were previously skipping */
3298 runrc == 0, /* success/failure indicator */
3299 old_lookup_value, /* value to reset for string2 */
3300 &s, /* input pointer */
3301 &yield, /* output pointer */
3302 &size, /* output size */
3303 &ptr, /* output current point */
3304 US"run")) /* condition type */
3306 case 1: goto EXPAND_FAILED; /* when all is well, the */
3307 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3313 /* Handle character translation for "tr" */
3321 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3323 case 1: goto EXPAND_FAILED_CURLY;
3325 case 3: goto EXPAND_FAILED;
3328 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3329 o2m = Ustrlen(sub[2]) - 1;
3331 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3333 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3337 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3344 /* Handle "hash", "length", "nhash", and "substr" when they are given with
3345 expanded arguments. */
3355 int val[2] = { 0, -1 };
3358 /* "length" takes only 2 arguments whereas the others take 2 or 3.
3359 Ensure that sub[2] is set in the ${length case. */
3362 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
3365 case 1: goto EXPAND_FAILED_CURLY;
3367 case 3: goto EXPAND_FAILED;
3370 /* Juggle the arguments if there are only two of them: always move the
3371 string to the last position and make ${length{n}{str}} equivalent to
3372 ${substr{0}{n}{str}}. See the defaults for val[] above. */
3378 if (item_type == EITEM_LENGTH)
3385 for (i = 0; i < 2; i++)
3387 if (sub[i] == NULL) continue;
3388 val[i] = (int)Ustrtol(sub[i], &ret, 10);
3389 if (*ret != 0 || (i != 0 && val[i] < 0))
3391 expand_string_message = string_sprintf("\"%s\" is not a%s number "
3392 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
3398 (item_type == EITEM_HASH)?
3399 compute_hash(sub[2], val[0], val[1], &len) :
3400 (item_type == EITEM_NHASH)?
3401 compute_nhash(sub[2], val[0], val[1], &len) :
3402 extract_substr(sub[2], val[0], val[1], &len);
3404 if (ret == NULL) goto EXPAND_FAILED;
3405 yield = string_cat(yield, &size, &ptr, ret, len);
3409 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
3410 This code originally contributed by Steve Haslam. It currently supports
3411 the use of MD5 and SHA-1 hashes.
3413 We need some workspace that is large enough to handle all the supported
3414 hash types. Use macros to set the sizes rather than be too elaborate. */
3416 #define MAX_HASHLEN 20
3417 #define MAX_HASHBLOCKLEN 64
3426 int hashlen; /* Number of octets for the hash algorithm's output */
3427 int hashblocklen; /* Number of octets the hash algorithm processes */
3429 unsigned int keylen;
3431 uschar keyhash[MAX_HASHLEN];
3432 uschar innerhash[MAX_HASHLEN];
3433 uschar finalhash[MAX_HASHLEN];
3434 uschar finalhash_hex[2*MAX_HASHLEN];
3435 uschar innerkey[MAX_HASHBLOCKLEN];
3436 uschar outerkey[MAX_HASHBLOCKLEN];
3438 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
3440 case 1: goto EXPAND_FAILED_CURLY;
3442 case 3: goto EXPAND_FAILED;
3445 if (Ustrcmp(sub[0], "md5") == 0)
3448 use_base = &md5_base;
3452 else if (Ustrcmp(sub[0], "sha1") == 0)
3455 use_base = &sha1_base;
3461 expand_string_message =
3462 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
3467 keylen = Ustrlen(keyptr);
3469 /* If the key is longer than the hash block length, then hash the key
3472 if (keylen > hashblocklen)
3474 chash_start(type, use_base);
3475 chash_end(type, use_base, keyptr, keylen, keyhash);
3480 /* Now make the inner and outer key values */
3482 memset(innerkey, 0x36, hashblocklen);
3483 memset(outerkey, 0x5c, hashblocklen);
3485 for (i = 0; i < keylen; i++)
3487 innerkey[i] ^= keyptr[i];
3488 outerkey[i] ^= keyptr[i];
3491 /* Now do the hashes */
3493 chash_start(type, use_base);
3494 chash_mid(type, use_base, innerkey);
3495 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
3497 chash_start(type, use_base);
3498 chash_mid(type, use_base, outerkey);
3499 chash_end(type, use_base, innerhash, hashlen, finalhash);
3501 /* Encode the final hash as a hex string */
3504 for (i = 0; i < hashlen; i++)
3506 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3507 *p++ = hex_digits[finalhash[i] & 0x0f];
3510 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
3511 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
3513 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
3518 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
3519 We have to save the numerical variables and restore them afterwards. */
3524 int moffset, moffsetextra, slen;
3527 const uschar *rerror;
3530 int save_expand_nmax =
3531 save_expand_strings(save_expand_nstring, save_expand_nlength);
3533 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
3535 case 1: goto EXPAND_FAILED_CURLY;
3537 case 3: goto EXPAND_FAILED;
3540 /* Compile the regular expression */
3542 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
3547 expand_string_message = string_sprintf("regular expression error in "
3548 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
3552 /* Now run a loop to do the substitutions as often as necessary. It ends
3553 when there are no more matches. Take care over matches of the null string;
3554 do the same thing as Perl does. */
3557 slen = Ustrlen(sub[0]);
3558 moffset = moffsetextra = 0;
3563 int ovector[3*(EXPAND_MAXN+1)];
3564 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
3565 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
3569 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
3570 is not necessarily the end. We want to repeat the match from one
3571 character further along, but leaving the basic offset the same (for
3572 copying below). We can't be at the end of the string - that was checked
3573 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
3574 finished; copy the remaining string and end the loop. */
3584 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
3588 /* Match - set up for expanding the replacement. */
3590 if (n == 0) n = EXPAND_MAXN + 1;
3592 for (nn = 0; nn < n*2; nn += 2)
3594 expand_nstring[expand_nmax] = subject + ovector[nn];
3595 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
3599 /* Copy the characters before the match, plus the expanded insertion. */
3601 yield = string_cat(yield, &size, &ptr, subject + moffset,
3602 ovector[0] - moffset);
3603 insert = expand_string(sub[2]);
3604 if (insert == NULL) goto EXPAND_FAILED;
3605 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
3607 moffset = ovector[1];
3611 /* If we have matched an empty string, first check to see if we are at
3612 the end of the subject. If so, the loop is over. Otherwise, mimic
3613 what Perl's /g options does. This turns out to be rather cunning. First
3614 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
3615 string at the same point. If this fails (picked up above) we advance to
3616 the next character. */
3618 if (ovector[0] == ovector[1])
3620 if (ovector[0] == slen) break;
3621 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
3625 /* All done - restore numerical variables. */
3627 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3628 save_expand_nlength);
3632 /* Handle keyed and numbered substring extraction. If the first argument
3633 consists entirely of digits, then a numerical extraction is assumed. */
3639 int field_number = 1;
3640 BOOL field_number_set = FALSE;
3641 uschar *save_lookup_value = lookup_value;
3643 int save_expand_nmax =
3644 save_expand_strings(save_expand_nstring, save_expand_nlength);
3646 /* Read the arguments */
3648 for (i = 0; i < j; i++)
3650 while (isspace(*s)) s++;
3653 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
3654 if (sub[i] == NULL) goto EXPAND_FAILED;
3655 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3657 /* After removal of leading and trailing white space, the first
3658 argument must not be empty; if it consists entirely of digits
3659 (optionally preceded by a minus sign), this is a numerical
3660 extraction, and we expect 3 arguments. */
3668 while (isspace(*p)) p++;
3672 while (len > 0 && isspace(p[len-1])) len--;
3677 expand_string_message = US"first argument of \"expand\" must not "
3687 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
3691 j = 3; /* Need 3 args */
3692 field_number_set = TRUE;
3696 else goto EXPAND_FAILED_CURLY;
3699 /* Extract either the numbered or the keyed substring into $value. If
3700 skipping, just pretend the extraction failed. */
3702 lookup_value = skipping? NULL : field_number_set?
3703 expand_gettokened(field_number, sub[1], sub[2]) :
3704 expand_getkeyed(sub[0], sub[1]);
3706 /* If no string follows, $value gets substituted; otherwise there can
3707 be yes/no strings, as for lookup or if. */
3709 switch(process_yesno(
3710 skipping, /* were previously skipping */
3711 lookup_value != NULL, /* success/failure indicator */
3712 save_lookup_value, /* value to reset for string2 */
3713 &s, /* input pointer */
3714 &yield, /* output pointer */
3715 &size, /* output size */
3716 &ptr, /* output current point */
3717 US"extract")) /* condition type */
3719 case 1: goto EXPAND_FAILED; /* when all is well, the */
3720 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3723 /* All done - restore numerical variables. */
3725 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3726 save_expand_nlength);
3732 /* Control reaches here if the name is not recognized as one of the more
3733 complicated expansion items. Check for the "operator" syntax (name terminated
3734 by a colon). Some of the operators have arguments, separated by _ from the
3741 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
3742 if (sub == NULL) goto EXPAND_FAILED;
3745 /* Owing to an historical mis-design, an underscore may be part of the
3746 operator name, or it may introduce arguments. We therefore first scan the
3747 table of names that contain underscores. If there is no match, we cut off
3748 the arguments and then scan the main table. */
3750 c = chop_match(name, op_table_underscore,
3751 sizeof(op_table_underscore)/sizeof(uschar *));
3755 arg = Ustrchr(name, '_');
3756 if (arg != NULL) *arg = 0;
3757 c = chop_match(name, op_table_main,
3758 sizeof(op_table_main)/sizeof(uschar *));
3759 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
3760 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
3763 /* If we are skipping, we don't need to perform the operation at all.
3764 This matters for operations like "mask", because the data may not be
3765 in the correct format when skipping. For example, the expression may test
3766 for the existence of $sender_host_address before trying to mask it. For
3767 other operations, doing them may not fail, but it is a waste of time. */
3769 if (skipping && c >= 0) continue;
3771 /* Otherwise, switch on the operator type */
3778 unsigned long int n = Ustrtoul(sub, &t, 10);
3781 expand_string_message = string_sprintf("argument for base62 "
3782 "operator is \"%s\", which is not a decimal number", sub);
3785 t = string_base62(n);
3786 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
3794 unsigned long int n = 0;
3797 uschar *t = Ustrchr(base62_chars, *tt++);
3800 expand_string_message = string_sprintf("argument for base62d "
3801 "operator is \"%s\", which is not a base 62 number", sub);
3804 n = n * 62 + (t - base62_chars);
3806 (void)sprintf(CS buf, "%ld", n);
3807 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
3813 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
3814 if (expanded == NULL)
3816 expand_string_message =
3817 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
3818 expand_string_message);
3821 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
3828 uschar *t = sub - 1;
3829 while (*(++t) != 0) { *t = tolower(*t); count++; }
3830 yield = string_cat(yield, &size, &ptr, sub, count);
3837 uschar *t = sub - 1;
3838 while (*(++t) != 0) { *t = toupper(*t); count++; }
3839 yield = string_cat(yield, &size, &ptr, sub, count);
3850 md5_end(&base, sub, Ustrlen(sub), digest);
3851 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
3852 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
3863 sha1_end(&base, sub, Ustrlen(sub), digest);
3864 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
3865 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
3869 /* Convert hex encoding to base64 encoding */
3879 for (enc = sub; *enc != 0; enc++)
3881 if (!isxdigit(*enc))
3883 expand_string_message = string_sprintf("\"%s\" is not a hex "
3892 expand_string_message = string_sprintf("\"%s\" contains an odd "
3893 "number of characters", sub);
3897 while ((c = *in++) != 0)
3899 if (isdigit(c)) c -= '0';
3900 else c = toupper(c) - 'A' + 10;
3912 enc = auth_b64encode(sub, out - sub);
3913 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
3917 /* mask applies a mask to an IP address; for example the result of
3918 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
3925 int mask, maskoffset;
3926 int type = string_is_ip_address(sub, &maskoffset);
3931 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3936 if (maskoffset == 0)
3938 expand_string_message = string_sprintf("missing mask value in \"%s\"",
3943 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
3945 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
3947 expand_string_message = string_sprintf("mask value too big in \"%s\"",
3952 /* Convert the address to binary integer(s) and apply the mask */
3954 sub[maskoffset] = 0;
3955 count = host_aton(sub, binary);
3956 host_mask(count, binary, mask);
3958 /* Convert to masked textual format and add to output. */
3960 yield = string_cat(yield, &size, &ptr, buffer,
3961 host_nmtoa(count, binary, mask, buffer, '.'));
3966 case EOP_LOCAL_PART:
3970 int start, end, domain;
3971 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
3975 if (c != EOP_DOMAIN)
3977 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
3978 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
3980 else if (domain != 0)
3983 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
3989 /* quote puts a string in quotes if it is empty or contains anything
3990 other than alphamerics, underscore, dot, or hyphen.
3992 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
3993 be quoted in order to be a valid local part.
3995 In both cases, newlines and carriage returns are converted into \n and \r
3999 case EOP_QUOTE_LOCAL_PART:
4002 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4003 uschar *t = sub - 1;
4007 while (!needs_quote && *(++t) != 0)
4008 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4010 else /* EOP_QUOTE_LOCAL_PART */
4012 while (!needs_quote && *(++t) != 0)
4013 needs_quote = !isalnum(*t) &&
4014 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4015 (*t != '.' || t == sub || t[1] == 0);
4020 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4025 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4026 else if (*t == '\r')
4027 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4030 if (*t == '\\' || *t == '"')
4031 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4032 yield = string_cat(yield, &size, &ptr, t, 1);
4035 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4037 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4041 /* quote_lookuptype does lookup-specific quoting */
4046 uschar *opt = Ustrchr(arg, '_');
4048 if (opt != NULL) *opt++ = 0;
4050 n = search_findtype(arg, Ustrlen(arg));
4053 expand_string_message = search_error_message;
4057 if (lookup_list[n].quote != NULL)
4058 sub = (lookup_list[n].quote)(sub, opt);
4059 else if (opt != NULL) sub = NULL;
4063 expand_string_message = string_sprintf(
4064 "\"%s\" unrecognized after \"${quote_%s\"",
4069 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4073 /* rx quote sticks in \ before any non-alphameric character so that
4074 the insertion works in a regular expression. */
4078 uschar *t = sub - 1;
4082 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4083 yield = string_cat(yield, &size, &ptr, t, 1);
4088 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4089 prescribed by the RFC, if there are characters that need to be encoded */
4093 uschar buffer[2048];
4094 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4095 buffer, sizeof(buffer));
4096 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4100 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4110 if (c > 255) c = '_';
4112 yield = string_cat(yield, &size, &ptr, buff, 1);
4117 /* escape turns all non-printing characters into escape sequences. */
4121 uschar *t = string_printing(sub);
4122 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4126 /* Handle numeric expression evaluation */
4131 uschar *save_sub = sub;
4132 uschar *error = NULL;
4133 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4136 expand_string_message = string_sprintf("error in expression "
4137 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4141 sprintf(CS var_buffer, "%d", n);
4142 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4146 /* Handle time period formating */
4148 case EOP_TIME_INTERVAL:
4151 uschar *t = read_number(&n, sub);
4152 if (*t != 0) /* Not A Number*/
4154 expand_string_message = string_sprintf("string \"%s\" is not a "
4155 "positive number in \"%s\" operator", sub, name);
4158 t = readconf_printtime(n);
4159 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4163 /* Convert string to base64 encoding */
4167 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4168 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4172 /* strlen returns the length of the string */
4177 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4178 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4182 /* length_n or l_n takes just the first n characters or the whole string,
4183 whichever is the shorter;
4185 substr_m_n, and s_m_n take n characters from offset m; negative m take
4186 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4187 takes the rest, either to the right or to the left.
4189 hash_n or h_n makes a hash of length n from the string, yielding n
4190 characters from the set a-z; hash_n_m makes a hash of length n, but
4191 uses m characters from the set a-zA-Z0-9.
4193 nhash_n returns a single number between 0 and n-1 (in text form), while
4194 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4195 between 0 and n-1 and the second between 0 and m-1. */
4215 expand_string_message = string_sprintf("missing values after %s",
4220 /* "length" has only one argument, effectively being synonymous with
4223 if (c == EOP_LENGTH || c == EOP_L)
4229 /* The others have one or two arguments; for "substr" the first may be
4230 negative. The second being negative means "not supplied". */
4235 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
4238 /* Read up to two numbers, separated by underscores */
4243 if (arg != ret && *arg == '_' && pn == &value1)
4247 if (arg[1] != 0) arg++;
4249 else if (!isdigit(*arg))
4251 expand_string_message =
4252 string_sprintf("non-digit after underscore in \"%s\"", name);
4255 else *pn = (*pn)*10 + *arg++ - '0';
4259 /* Perform the required operation */
4262 (c == EOP_HASH || c == EOP_H)?
4263 compute_hash(sub, value1, value2, &len) :
4264 (c == EOP_NHASH || c == EOP_NH)?
4265 compute_nhash(sub, value1, value2, &len) :
4266 extract_substr(sub, value1, value2, &len);
4268 if (ret == NULL) goto EXPAND_FAILED;
4269 yield = string_cat(yield, &size, &ptr, ret, len);
4279 uschar **modetable[3];
4284 if (stat(CS sub, &st) < 0)
4286 expand_string_message = string_sprintf("stat(%s) failed: %s",
4287 sub, strerror(errno));
4291 switch (mode & S_IFMT)
4293 case S_IFIFO: smode[0] = 'p'; break;
4294 case S_IFCHR: smode[0] = 'c'; break;
4295 case S_IFDIR: smode[0] = 'd'; break;
4296 case S_IFBLK: smode[0] = 'b'; break;
4297 case S_IFREG: smode[0] = '-'; break;
4298 default: smode[0] = '?'; break;
4301 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
4302 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
4303 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
4305 for (i = 0; i < 3; i++)
4307 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
4312 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
4313 "uid=%ld gid=%ld size=%ld atime=%ld mtime=%ld ctime=%ld",
4314 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
4315 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
4316 (long)st.st_gid, (long)st.st_size, (long)st.st_atime,
4317 (long)st.st_mtime, (long)st.st_ctime);
4318 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
4322 /* Unknown operator */
4325 expand_string_message =
4326 string_sprintf("unknown expansion operator \"%s\"", name);
4331 /* Handle a plain name. If this is the first thing in the expansion, release
4332 the pre-allocated buffer. If the result data is known to be in a new buffer,
4333 newsize will be set to the size of that buffer, and we can just point at that
4334 store instead of copying. Many expansion strings contain just one reference,
4335 so this is a useful optimization, especially for humungous headers
4336 ($message_headers). */
4348 value = find_variable(name, FALSE, skipping, &newsize);
4351 expand_string_message =
4352 string_sprintf("unknown variable in \"${%s}\"", name);
4355 len = Ustrlen(value);
4356 if (yield == NULL && newsize != 0)
4362 else yield = string_cat(yield, &size, &ptr, value, len);
4366 /* Else there's something wrong */
4368 expand_string_message =
4369 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
4370 "in a variable reference)", name);
4374 /* If we hit the end of the string when ket_ends is set, there is a missing
4375 terminating brace. */
4377 if (ket_ends && *s == 0)
4379 expand_string_message = malformed_header?
4380 US"missing } at end of string - could be header name not terminated by colon"
4382 US"missing } at end of string";
4386 /* Expansion succeeded; yield may still be NULL here if nothing was actually
4387 added to the string. If so, set up an empty string. Add a terminating zero. If
4388 left != NULL, return a pointer to the terminator. */
4390 if (yield == NULL) yield = store_get(1);
4392 if (left != NULL) *left = s;
4394 /* Any stacking store that was used above the final string is no longer needed.
4395 In many cases the final string will be the first one that was got and so there
4396 will be optimal store usage. */
4398 store_reset(yield + ptr + 1);
4401 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
4403 if (skipping) debug_printf("skipping: result is not used\n");
4407 /* This is the failure exit: easiest to program with a goto. We still need
4408 to update the pointer to the terminator, for cases of nested calls with "fail".
4411 EXPAND_FAILED_CURLY:
4412 expand_string_message = malformed_header?
4413 US"missing or misplaced { or } - could be header name not terminated by colon"
4415 US"missing or misplaced { or }";
4417 /* At one point, Exim reset the store to yield (if yield was not NULL), but
4418 that is a bad idea, because expand_string_message is in dynamic store. */
4421 if (left != NULL) *left = s;
4424 debug_printf("failed to expand: %s\n", string);
4425 debug_printf(" error message: %s\n", expand_string_message);
4426 if (expand_string_forcedfail) debug_printf("failure was forced\n");
4432 /* This is the external function call. Do a quick check for any expansion
4433 metacharacters, and if there are none, just return the input string.
4435 Argument: the string to be expanded
4436 Returns: the expanded string, or NULL if expansion failed; if failure was
4437 due to a lookup deferring, search_find_defer will be TRUE
4441 expand_string(uschar *string)
4443 search_find_defer = FALSE;
4444 malformed_header = FALSE;
4445 return (Ustrpbrk(string, "$\\") == NULL)? string :
4446 expand_string_internal(string, FALSE, NULL, FALSE);
4451 /*************************************************
4453 *************************************************/
4455 /* Now and again we want to expand a string and be sure that the result is in a
4456 new bit of store. This function does that.
4458 Argument: the string to be expanded
4459 Returns: the expanded string, always in a new bit of store, or NULL
4463 expand_string_copy(uschar *string)
4465 uschar *yield = expand_string(string);
4466 if (yield == string) yield = string_copy(string);
4472 /*************************************************
4473 * Expand and interpret as an integer *
4474 *************************************************/
4476 /* Expand a string, and convert the result into an integer.
4478 Argument: the string to be expanded
4480 Returns: the integer value, or
4481 -1 for an expansion error ) in both cases, message in
4482 -2 for an integer interpretation error ) expand_string_message
4487 expand_string_integer(uschar *string)
4490 uschar *s = expand_string(string);
4491 uschar *msg = US"invalid integer \"%s\"";
4494 if (s == NULL) return -1;
4496 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
4497 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
4498 systems, so we set it zero ourselves. */
4501 value = strtol(CS s, CSS &endptr, 0);
4505 msg = US"integer expected but \"%s\" found";
4509 /* Ensure we can cast this down to an int */
4510 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
4512 if (errno != ERANGE)
4514 if (tolower(*endptr) == 'k')
4516 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
4520 else if (tolower(*endptr) == 'm')
4522 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
4524 else value *= 1024*1024;
4528 if (errno == ERANGE)
4529 msg = US"absolute value of integer \"%s\" is too large (overflow)";
4532 while (isspace(*endptr)) endptr++;
4533 if (*endptr == 0) return (int)value;
4537 expand_string_message = string_sprintf(CS msg, s);
4543 /*************************************************
4544 **************************************************
4545 * Stand-alone test program *
4546 **************************************************
4547 *************************************************/
4553 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
4555 int ovector[3*(EXPAND_MAXN+1)];
4556 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
4557 ovector, sizeof(ovector)/sizeof(int));
4558 BOOL yield = n >= 0;
4559 if (n == 0) n = EXPAND_MAXN + 1;
4563 expand_nmax = (setup < 0)? 0 : setup + 1;
4564 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
4566 expand_nstring[expand_nmax] = subject + ovector[nn];
4567 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4575 int main(int argc, uschar **argv)
4578 uschar buffer[1024];
4580 debug_selector = D_v;
4581 debug_file = stderr;
4582 debug_fd = fileno(debug_file);
4583 big_buffer = malloc(big_buffer_size);
4585 for (i = 1; i < argc; i++)
4587 if (argv[i][0] == '+')
4589 debug_trace_memory = 2;
4592 if (isdigit(argv[i][0]))
4593 debug_selector = Ustrtol(argv[i], NULL, 0);
4595 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
4599 eldap_default_servers = argv[i];
4602 mysql_servers = argv[i];
4605 pgsql_servers = argv[i];
4609 else opt_perl_startup = argv[i];
4613 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
4615 expand_nstring[1] = US"string 1....";
4616 expand_nlength[1] = 8;
4620 if (opt_perl_startup != NULL)
4623 printf("Starting Perl interpreter\n");
4624 errstr = init_perl(opt_perl_startup);
4627 printf("** error in perl_startup code: %s\n", errstr);
4628 return EXIT_FAILURE;
4631 #endif /* EXIM_PERL */
4633 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
4635 void *reset_point = store_get(0);
4636 uschar *yield = expand_string(buffer);
4639 printf("%s\n", yield);
4640 store_reset(reset_point);
4644 if (search_find_defer) printf("search_find deferred\n");
4645 printf("Failed: %s\n", expand_string_message);
4646 if (expand_string_forcedfail) printf("Forced failure\n");
4658 /* End of expand.c */