1 /* $Cambridge: exim/src/src/expand.c,v 1.85 2007/05/11 08:48:31 tom Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2007 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /* Functions for handling string expansion. */
16 /* Recursively called function */
18 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
21 #ifndef SUPPORT_CRYPTEQ
22 #define SUPPORT_CRYPTEQ
27 #include "lookups/ldap.h"
30 #ifdef SUPPORT_CRYPTEQ
35 extern char* crypt16(char*, char*);
39 /* The handling of crypt16() is a mess. I will record below the analysis of the
40 mess that was sent to me. We decided, however, to make changing this very low
41 priority, because in practice people are moving away from the crypt()
42 algorithms nowadays, so it doesn't seem worth it.
45 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
46 the first 8 characters of the password using a 20-round version of crypt
47 (standard crypt does 25 rounds). It then crypts the next 8 characters,
48 or an empty block if the password is less than 9 characters, using a
49 20-round version of crypt and the same salt as was used for the first
50 block. Charaters after the first 16 are ignored. It always generates
51 a 16-byte hash, which is expressed together with the salt as a string
52 of 24 base 64 digits. Here are some links to peruse:
54 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
55 http://seclists.org/bugtraq/1999/Mar/0076.html
57 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
58 and OSF/1. This is the same as the standard crypt if given a password
59 of 8 characters or less. If given more, it first does the same as crypt
60 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
61 using as salt the first two base 64 digits from the first hash block.
62 If the password is more than 16 characters then it crypts the 17th to 24th
63 characters using as salt the first two base 64 digits from the second hash
64 block. And so on: I've seen references to it cutting off the password at
65 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
67 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
68 http://seclists.org/bugtraq/1999/Mar/0109.html
69 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
70 TET1_html/sec.c222.html#no_id_208
72 Exim has something it calls "crypt16". It will either use a native
73 crypt16 or its own implementation. A native crypt16 will presumably
74 be the one that I called "crypt16" above. The internal "crypt16"
75 function, however, is a two-block-maximum implementation of what I called
76 "bigcrypt". The documentation matches the internal code.
78 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
79 that crypt16 and bigcrypt were different things.
81 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
82 to whatever it is using under that name. This unfortunately sets a
83 precedent for using "{crypt16}" to identify two incompatible algorithms
84 whose output can't be distinguished. With "{crypt16}" thus rendered
85 ambiguous, I suggest you deprecate it and invent two new identifiers
86 for the two algorithms.
88 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
89 of the password separately means they can be cracked separately, so
90 the double-length hash only doubles the cracking effort instead of
91 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
99 /*************************************************
100 * Local statics and tables *
101 *************************************************/
103 /* Table of item names, and corresponding switch numbers. The names must be in
104 alphabetical order. */
106 static uschar *item_table[] = {
150 /* Tables of operator names, and corresponding switch numbers. The names must be
151 in alphabetical order. There are two tables, because underscore is used in some
152 cases to introduce arguments, whereas for other it is part of the name. This is
153 an historical mis-design. */
155 static uschar *op_table_underscore[] = {
158 US"quote_local_part",
165 EOP_QUOTE_LOCAL_PART,
169 static uschar *op_table_main[] = {
202 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
234 /* Table of condition names, and corresponding switch numbers. The names must
235 be in alphabetical order. */
237 static uschar *cond_table[] = {
241 US"==", /* Backward compatibility */
269 US"match_local_part",
291 ECOND_FIRST_DELIVERY,
310 ECOND_MATCH_LOCAL_PART,
320 /* Type for main variable table */
328 /* Type for entries pointing to address/length pairs. Not currently
336 /* Types of table entry */
339 vtype_int, /* value is address of int */
340 vtype_filter_int, /* ditto, but recognized only when filtering */
341 vtype_ino, /* value is address of ino_t (not always an int) */
342 vtype_uid, /* value is address of uid_t (not always an int) */
343 vtype_gid, /* value is address of gid_t (not always an int) */
344 vtype_stringptr, /* value is address of pointer to string */
345 vtype_msgbody, /* as stringptr, but read when first required */
346 vtype_msgbody_end, /* ditto, the end of the message */
347 vtype_msgheaders, /* the message's headers, processed */
348 vtype_msgheaders_raw, /* the message's headers, unprocessed */
349 vtype_localpart, /* extract local part from string */
350 vtype_domain, /* extract domain from string */
351 vtype_recipients, /* extract recipients from recipients list */
352 /* (available only in system filters, ACLs, and */
354 vtype_todbsdin, /* value not used; generate BSD inbox tod */
355 vtype_tode, /* value not used; generate tod in epoch format */
356 vtype_todf, /* value not used; generate full tod */
357 vtype_todl, /* value not used; generate log tod */
358 vtype_todlf, /* value not used; generate log file datestamp tod */
359 vtype_todzone, /* value not used; generate time zone only */
360 vtype_todzulu, /* value not used; generate zulu tod */
361 vtype_reply, /* value not used; get reply from headers */
362 vtype_pid, /* value not used; result is pid */
363 vtype_host_lookup, /* value not used; get host name */
364 vtype_load_avg, /* value not used; result is int from os_getloadavg */
365 vtype_pspace, /* partition space; value is T/F for spool/log */
366 vtype_pinodes /* partition inodes; value is T/F for spool/log */
367 #ifdef EXPERIMENTAL_DOMAINKEYS
368 ,vtype_dk_verify /* Serve request out of DomainKeys verification structure */
372 /* This table must be kept in alphabetical order. */
374 static var_entry var_table[] = {
375 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
376 they will be confused with user-creatable ACL variables. */
377 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
378 { "address_data", vtype_stringptr, &deliver_address_data },
379 { "address_file", vtype_stringptr, &address_file },
380 { "address_pipe", vtype_stringptr, &address_pipe },
381 { "authenticated_id", vtype_stringptr, &authenticated_id },
382 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
383 { "authentication_failed",vtype_int, &authentication_failed },
384 #ifdef EXPERIMENTAL_BRIGHTMAIL
385 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
386 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
387 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
388 { "bmi_deliver", vtype_int, &bmi_deliver },
390 { "body_linecount", vtype_int, &body_linecount },
391 { "body_zerocount", vtype_int, &body_zerocount },
392 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
393 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
394 { "caller_gid", vtype_gid, &real_gid },
395 { "caller_uid", vtype_uid, &real_uid },
396 { "compile_date", vtype_stringptr, &version_date },
397 { "compile_number", vtype_stringptr, &version_cnumber },
398 { "csa_status", vtype_stringptr, &csa_status },
399 #ifdef WITH_OLD_DEMIME
400 { "demime_errorlevel", vtype_int, &demime_errorlevel },
401 { "demime_reason", vtype_stringptr, &demime_reason },
403 #ifdef EXPERIMENTAL_DOMAINKEYS
404 { "dk_domain", vtype_stringptr, &dk_signing_domain },
405 { "dk_is_signed", vtype_dk_verify, NULL },
406 { "dk_result", vtype_dk_verify, NULL },
407 { "dk_selector", vtype_stringptr, &dk_signing_selector },
408 { "dk_sender", vtype_dk_verify, NULL },
409 { "dk_sender_domain", vtype_dk_verify, NULL },
410 { "dk_sender_local_part",vtype_dk_verify, NULL },
411 { "dk_sender_source", vtype_dk_verify, NULL },
412 { "dk_signsall", vtype_dk_verify, NULL },
413 { "dk_status", vtype_dk_verify, NULL },
414 { "dk_testing", vtype_dk_verify, NULL },
416 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
417 { "dnslist_text", vtype_stringptr, &dnslist_text },
418 { "dnslist_value", vtype_stringptr, &dnslist_value },
419 { "domain", vtype_stringptr, &deliver_domain },
420 { "domain_data", vtype_stringptr, &deliver_domain_data },
421 { "exim_gid", vtype_gid, &exim_gid },
422 { "exim_path", vtype_stringptr, &exim_path },
423 { "exim_uid", vtype_uid, &exim_uid },
424 #ifdef WITH_OLD_DEMIME
425 { "found_extension", vtype_stringptr, &found_extension },
427 { "home", vtype_stringptr, &deliver_home },
428 { "host", vtype_stringptr, &deliver_host },
429 { "host_address", vtype_stringptr, &deliver_host_address },
430 { "host_data", vtype_stringptr, &host_data },
431 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
432 { "host_lookup_failed", vtype_int, &host_lookup_failed },
433 { "inode", vtype_ino, &deliver_inode },
434 { "interface_address", vtype_stringptr, &interface_address },
435 { "interface_port", vtype_int, &interface_port },
436 { "item", vtype_stringptr, &iterate_item },
438 { "ldap_dn", vtype_stringptr, &eldap_dn },
440 { "load_average", vtype_load_avg, NULL },
441 { "local_part", vtype_stringptr, &deliver_localpart },
442 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
443 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
444 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
445 { "local_scan_data", vtype_stringptr, &local_scan_data },
446 { "local_user_gid", vtype_gid, &local_user_gid },
447 { "local_user_uid", vtype_uid, &local_user_uid },
448 { "localhost_number", vtype_int, &host_number },
449 { "log_inodes", vtype_pinodes, (void *)FALSE },
450 { "log_space", vtype_pspace, (void *)FALSE },
451 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
452 #ifdef WITH_CONTENT_SCAN
453 { "malware_name", vtype_stringptr, &malware_name },
455 { "message_age", vtype_int, &message_age },
456 { "message_body", vtype_msgbody, &message_body },
457 { "message_body_end", vtype_msgbody_end, &message_body_end },
458 { "message_body_size", vtype_int, &message_body_size },
459 { "message_exim_id", vtype_stringptr, &message_id },
460 { "message_headers", vtype_msgheaders, NULL },
461 { "message_headers_raw", vtype_msgheaders_raw, NULL },
462 { "message_id", vtype_stringptr, &message_id },
463 { "message_linecount", vtype_int, &message_linecount },
464 { "message_size", vtype_int, &message_size },
465 #ifdef WITH_CONTENT_SCAN
466 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
467 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
468 { "mime_boundary", vtype_stringptr, &mime_boundary },
469 { "mime_charset", vtype_stringptr, &mime_charset },
470 { "mime_content_description", vtype_stringptr, &mime_content_description },
471 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
472 { "mime_content_id", vtype_stringptr, &mime_content_id },
473 { "mime_content_size", vtype_int, &mime_content_size },
474 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
475 { "mime_content_type", vtype_stringptr, &mime_content_type },
476 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
477 { "mime_filename", vtype_stringptr, &mime_filename },
478 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
479 { "mime_is_multipart", vtype_int, &mime_is_multipart },
480 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
481 { "mime_part_count", vtype_int, &mime_part_count },
483 { "n0", vtype_filter_int, &filter_n[0] },
484 { "n1", vtype_filter_int, &filter_n[1] },
485 { "n2", vtype_filter_int, &filter_n[2] },
486 { "n3", vtype_filter_int, &filter_n[3] },
487 { "n4", vtype_filter_int, &filter_n[4] },
488 { "n5", vtype_filter_int, &filter_n[5] },
489 { "n6", vtype_filter_int, &filter_n[6] },
490 { "n7", vtype_filter_int, &filter_n[7] },
491 { "n8", vtype_filter_int, &filter_n[8] },
492 { "n9", vtype_filter_int, &filter_n[9] },
493 { "original_domain", vtype_stringptr, &deliver_domain_orig },
494 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
495 { "originator_gid", vtype_gid, &originator_gid },
496 { "originator_uid", vtype_uid, &originator_uid },
497 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
498 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
499 { "pid", vtype_pid, NULL },
500 { "primary_hostname", vtype_stringptr, &primary_hostname },
501 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
502 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
503 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
504 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
505 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
506 { "rcpt_count", vtype_int, &rcpt_count },
507 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
508 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
509 { "received_count", vtype_int, &received_count },
510 { "received_for", vtype_stringptr, &received_for },
511 { "received_ip_address", vtype_stringptr, &interface_address },
512 { "received_port", vtype_int, &interface_port },
513 { "received_protocol", vtype_stringptr, &received_protocol },
514 { "received_time", vtype_int, &received_time },
515 { "recipient_data", vtype_stringptr, &recipient_data },
516 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
517 { "recipients", vtype_recipients, NULL },
518 { "recipients_count", vtype_int, &recipients_count },
519 #ifdef WITH_CONTENT_SCAN
520 { "regex_match_string", vtype_stringptr, ®ex_match_string },
522 { "reply_address", vtype_reply, NULL },
523 { "return_path", vtype_stringptr, &return_path },
524 { "return_size_limit", vtype_int, &bounce_return_size_limit },
525 { "runrc", vtype_int, &runrc },
526 { "self_hostname", vtype_stringptr, &self_hostname },
527 { "sender_address", vtype_stringptr, &sender_address },
528 { "sender_address_data", vtype_stringptr, &sender_address_data },
529 { "sender_address_domain", vtype_domain, &sender_address },
530 { "sender_address_local_part", vtype_localpart, &sender_address },
531 { "sender_data", vtype_stringptr, &sender_data },
532 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
533 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
534 { "sender_host_address", vtype_stringptr, &sender_host_address },
535 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
536 { "sender_host_name", vtype_host_lookup, NULL },
537 { "sender_host_port", vtype_int, &sender_host_port },
538 { "sender_ident", vtype_stringptr, &sender_ident },
539 { "sender_rate", vtype_stringptr, &sender_rate },
540 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
541 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
542 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
543 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
544 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
545 { "sending_port", vtype_int, &sending_port },
546 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
547 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
548 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
549 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
550 { "sn0", vtype_filter_int, &filter_sn[0] },
551 { "sn1", vtype_filter_int, &filter_sn[1] },
552 { "sn2", vtype_filter_int, &filter_sn[2] },
553 { "sn3", vtype_filter_int, &filter_sn[3] },
554 { "sn4", vtype_filter_int, &filter_sn[4] },
555 { "sn5", vtype_filter_int, &filter_sn[5] },
556 { "sn6", vtype_filter_int, &filter_sn[6] },
557 { "sn7", vtype_filter_int, &filter_sn[7] },
558 { "sn8", vtype_filter_int, &filter_sn[8] },
559 { "sn9", vtype_filter_int, &filter_sn[9] },
560 #ifdef WITH_CONTENT_SCAN
561 { "spam_bar", vtype_stringptr, &spam_bar },
562 { "spam_report", vtype_stringptr, &spam_report },
563 { "spam_score", vtype_stringptr, &spam_score },
564 { "spam_score_int", vtype_stringptr, &spam_score_int },
566 #ifdef EXPERIMENTAL_SPF
567 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
568 { "spf_received", vtype_stringptr, &spf_received },
569 { "spf_result", vtype_stringptr, &spf_result },
570 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
572 { "spool_directory", vtype_stringptr, &spool_directory },
573 { "spool_inodes", vtype_pinodes, (void *)TRUE },
574 { "spool_space", vtype_pspace, (void *)TRUE },
575 #ifdef EXPERIMENTAL_SRS
576 { "srs_db_address", vtype_stringptr, &srs_db_address },
577 { "srs_db_key", vtype_stringptr, &srs_db_key },
578 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
579 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
580 { "srs_recipient", vtype_stringptr, &srs_recipient },
581 { "srs_status", vtype_stringptr, &srs_status },
583 { "thisaddress", vtype_stringptr, &filter_thisaddress },
584 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
585 { "tls_cipher", vtype_stringptr, &tls_cipher },
586 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
587 { "tod_bsdinbox", vtype_todbsdin, NULL },
588 { "tod_epoch", vtype_tode, NULL },
589 { "tod_full", vtype_todf, NULL },
590 { "tod_log", vtype_todl, NULL },
591 { "tod_logfile", vtype_todlf, NULL },
592 { "tod_zone", vtype_todzone, NULL },
593 { "tod_zulu", vtype_todzulu, NULL },
594 { "value", vtype_stringptr, &lookup_value },
595 { "version_number", vtype_stringptr, &version_string },
596 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
597 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
598 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
599 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
600 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
601 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
604 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
605 static uschar var_buffer[256];
606 static BOOL malformed_header;
608 /* For textual hashes */
610 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
611 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
614 enum { HMAC_MD5, HMAC_SHA1 };
616 /* For numeric hashes */
618 static unsigned int prime[] = {
619 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
620 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
621 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
623 /* For printing modes in symbolic form */
625 static uschar *mtable_normal[] =
626 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
628 static uschar *mtable_setid[] =
629 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
631 static uschar *mtable_sticky[] =
632 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
636 /*************************************************
637 * Tables for UTF-8 support *
638 *************************************************/
640 /* Table of the number of extra characters, indexed by the first character
641 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
644 static uschar utf8_table1[] = {
645 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
646 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
647 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
648 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
650 /* These are the masks for the data bits in the first byte of a character,
651 indexed by the number of additional bytes. */
653 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
655 /* Get the next UTF-8 character, advancing the pointer. */
657 #define GETUTF8INC(c, ptr) \
659 if ((c & 0xc0) == 0xc0) \
661 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
663 c = (c & utf8_table2[a]) << s; \
667 c |= (*ptr++ & 0x3f) << s; \
672 /*************************************************
673 * Binary chop search on a table *
674 *************************************************/
676 /* This is used for matching expansion items and operators.
679 name the name that is being sought
680 table the table to search
681 table_size the number of items in the table
683 Returns: the offset in the table, or -1
687 chop_match(uschar *name, uschar **table, int table_size)
689 uschar **bot = table;
690 uschar **top = table + table_size;
694 uschar **mid = bot + (top - bot)/2;
695 int c = Ustrcmp(name, *mid);
696 if (c == 0) return mid - table;
697 if (c > 0) bot = mid + 1; else top = mid;
705 /*************************************************
706 * Check a condition string *
707 *************************************************/
709 /* This function is called to expand a string, and test the result for a "true"
710 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
711 forced fail or lookup defer. All store used by the function can be released on
715 condition the condition string
716 m1 text to be incorporated in panic error
719 Returns: TRUE if condition is met, FALSE if not
723 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
726 void *reset_point = store_get(0);
727 uschar *ss = expand_string(condition);
730 if (!expand_string_forcedfail && !search_find_defer)
731 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
732 "for %s %s: %s", condition, m1, m2, expand_string_message);
735 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
736 strcmpic(ss, US"false") != 0;
737 store_reset(reset_point);
743 /*************************************************
744 * Pick out a name from a string *
745 *************************************************/
747 /* If the name is too long, it is silently truncated.
750 name points to a buffer into which to put the name
751 max is the length of the buffer
752 s points to the first alphabetic character of the name
753 extras chars other than alphanumerics to permit
755 Returns: pointer to the first character after the name
757 Note: The test for *s != 0 in the while loop is necessary because
758 Ustrchr() yields non-NULL if the character is zero (which is not something
762 read_name(uschar *name, int max, uschar *s, uschar *extras)
765 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
767 if (ptr < max-1) name[ptr++] = *s;
776 /*************************************************
777 * Pick out the rest of a header name *
778 *************************************************/
780 /* A variable name starting $header_ (or just $h_ for those who like
781 abbreviations) might not be the complete header name because headers can
782 contain any printing characters in their names, except ':'. This function is
783 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
784 on the end, if the name was terminated by white space.
787 name points to a buffer in which the name read so far exists
788 max is the length of the buffer
789 s points to the first character after the name so far, i.e. the
790 first non-alphameric character after $header_xxxxx
792 Returns: a pointer to the first character after the header name
796 read_header_name(uschar *name, int max, uschar *s)
798 int prelen = Ustrchr(name, '_') - name + 1;
799 int ptr = Ustrlen(name) - prelen;
800 if (ptr > 0) memmove(name, name+prelen, ptr);
801 while (mac_isgraph(*s) && *s != ':')
803 if (ptr < max-1) name[ptr++] = *s;
814 /*************************************************
815 * Pick out a number from a string *
816 *************************************************/
819 n points to an integer into which to put the number
820 s points to the first digit of the number
822 Returns: a pointer to the character after the last digit
826 read_number(int *n, uschar *s)
829 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
835 /*************************************************
836 * Extract keyed subfield from a string *
837 *************************************************/
839 /* The yield is in dynamic store; NULL means that the key was not found.
842 key points to the name of the key
843 s points to the string from which to extract the subfield
845 Returns: NULL if the subfield was not found, or
846 a pointer to the subfield's data
850 expand_getkeyed(uschar *key, uschar *s)
852 int length = Ustrlen(key);
853 while (isspace(*s)) s++;
855 /* Loop to search for the key */
863 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
864 dkeylength = s - dkey;
865 while (isspace(*s)) s++;
866 if (*s == '=') while (isspace((*(++s))));
868 data = string_dequote(&s);
869 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
872 while (isspace(*s)) s++;
881 /*************************************************
882 * Extract numbered subfield from string *
883 *************************************************/
885 /* Extracts a numbered field from a string that is divided by tokens - for
886 example a line from /etc/passwd is divided by colon characters. First field is
887 numbered one. Negative arguments count from the right. Zero returns the whole
888 string. Returns NULL if there are insufficient tokens in the string
891 Modifies final argument - this is a dynamically generated string, so that's OK.
894 field number of field to be extracted,
895 first field = 1, whole string = 0, last field = -1
896 separators characters that are used to break string into tokens
897 s points to the string from which to extract the subfield
899 Returns: NULL if the field was not found,
900 a pointer to the field's data inside s (modified to add 0)
904 expand_gettokened (int field, uschar *separators, uschar *s)
909 uschar *fieldtext = NULL;
911 if (field == 0) return s;
913 /* Break the line up into fields in place; for field > 0 we stop when we have
914 done the number of fields we want. For field < 0 we continue till the end of
915 the string, counting the number of fields. */
917 count = (field > 0)? field : INT_MAX;
923 /* Previous field was the last one in the string. For a positive field
924 number, this means there are not enough fields. For a negative field number,
925 check that there are enough, and scan back to find the one that is wanted. */
929 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
930 if ((-field) == (INT_MAX - count - 1)) return s;
934 while (ss[-1] != 0) ss--;
940 /* Previous field was not last in the string; save its start and put a
944 len = Ustrcspn(ss, separators);
955 /*************************************************
956 * Extract a substring from a string *
957 *************************************************/
959 /* Perform the ${substr or ${length expansion operations.
962 subject the input string
963 value1 the offset from the start of the input string to the start of
964 the output string; if negative, count from the right.
965 value2 the length of the output string, or negative (-1) for unset
966 if value1 is positive, unset means "all after"
967 if value1 is negative, unset means "all before"
968 len set to the length of the returned string
970 Returns: pointer to the output string, or NULL if there is an error
974 extract_substr(uschar *subject, int value1, int value2, int *len)
976 int sublen = Ustrlen(subject);
978 if (value1 < 0) /* count from right */
982 /* If the position is before the start, skip to the start, and adjust the
983 length. If the length ends up negative, the substring is null because nothing
984 can precede. This falls out naturally when the length is unset, meaning "all
990 if (value2 < 0) value2 = 0;
994 /* Otherwise an unset length => characters before value1 */
1003 /* For a non-negative offset, if the starting position is past the end of the
1004 string, the result will be the null string. Otherwise, an unset length means
1005 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1009 if (value1 > sublen)
1014 else if (value2 < 0) value2 = sublen;
1017 /* Cut the length down to the maximum possible for the offset value, and get
1018 the required characters. */
1020 if (value1 + value2 > sublen) value2 = sublen - value1;
1022 return subject + value1;
1028 /*************************************************
1029 * Old-style hash of a string *
1030 *************************************************/
1032 /* Perform the ${hash expansion operation.
1035 subject the input string (an expanded substring)
1036 value1 the length of the output string; if greater or equal to the
1037 length of the input string, the input string is returned
1038 value2 the number of hash characters to use, or 26 if negative
1039 len set to the length of the returned string
1041 Returns: pointer to the output string, or NULL if there is an error
1045 compute_hash(uschar *subject, int value1, int value2, int *len)
1047 int sublen = Ustrlen(subject);
1049 if (value2 < 0) value2 = 26;
1050 else if (value2 > Ustrlen(hashcodes))
1052 expand_string_message =
1053 string_sprintf("hash count \"%d\" too big", value2);
1057 /* Calculate the hash text. We know it is shorter than the original string, so
1058 can safely place it in subject[] (we know that subject is always itself an
1059 expanded substring). */
1061 if (value1 < sublen)
1066 while ((c = (subject[j])) != 0)
1068 int shift = (c + j++) & 7;
1069 subject[i] ^= (c << shift) | (c >> (8-shift));
1070 if (++i >= value1) i = 0;
1072 for (i = 0; i < value1; i++)
1073 subject[i] = hashcodes[(subject[i]) % value2];
1075 else value1 = sublen;
1084 /*************************************************
1085 * Numeric hash of a string *
1086 *************************************************/
1088 /* Perform the ${nhash expansion operation. The first characters of the
1089 string are treated as most important, and get the highest prime numbers.
1092 subject the input string
1093 value1 the maximum value of the first part of the result
1094 value2 the maximum value of the second part of the result,
1095 or negative to produce only a one-part result
1096 len set to the length of the returned string
1098 Returns: pointer to the output string, or NULL if there is an error.
1102 compute_nhash (uschar *subject, int value1, int value2, int *len)
1104 uschar *s = subject;
1106 unsigned long int total = 0; /* no overflow */
1110 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1111 total += prime[i--] * (unsigned int)(*s++);
1114 /* If value2 is unset, just compute one number */
1118 s = string_sprintf("%d", total % value1);
1121 /* Otherwise do a div/mod hash */
1125 total = total % (value1 * value2);
1126 s = string_sprintf("%d/%d", total/value2, total % value2);
1137 /*************************************************
1138 * Find the value of a header or headers *
1139 *************************************************/
1141 /* Multiple instances of the same header get concatenated, and this function
1142 can also return a concatenation of all the header lines. When concatenating
1143 specific headers that contain lists of addresses, a comma is inserted between
1144 them. Otherwise we use a straight concatenation. Because some messages can have
1145 pathologically large number of lines, there is a limit on the length that is
1146 returned. Also, to avoid massive store use which would result from using
1147 string_cat() as it copies and extends strings, we do a preliminary pass to find
1148 out exactly how much store will be needed. On "normal" messages this will be
1152 name the name of the header, without the leading $header_ or $h_,
1153 or NULL if a concatenation of all headers is required
1154 exists_only TRUE if called from a def: test; don't need to build a string;
1155 just return a string that is not "" and not "0" if the header
1157 newsize return the size of memory block that was obtained; may be NULL
1158 if exists_only is TRUE
1159 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1160 other than concatenating, will be done on the header. Also used
1161 for $message_headers_raw.
1162 charset name of charset to translate MIME words to; used only if
1163 want_raw is false; if NULL, no translation is done (this is
1164 used for $bh_ and $bheader_)
1166 Returns: NULL if the header does not exist, else a pointer to a new
1171 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1174 BOOL found = name == NULL;
1176 int len = found? 0 : Ustrlen(name);
1178 uschar *yield = NULL;
1181 /* Loop for two passes - saves code repetition */
1183 for (i = 0; i < 2; i++)
1188 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1190 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1192 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1197 if (exists_only) return US"1"; /* don't need actual string */
1199 t = h->text + len; /* text to insert */
1200 if (!want_raw) /* unless wanted raw, */
1201 while (isspace(*t)) t++; /* remove leading white space */
1202 ilen = h->slen - (t - h->text); /* length to insert */
1204 /* Unless wanted raw, remove trailing whitespace, including the
1208 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1210 /* Set comma = 1 if handling a single header and it's one of those
1211 that contains an address list, except when asked for raw headers. Only
1212 need to do this once. */
1214 if (!want_raw && name != NULL && comma == 0 &&
1215 Ustrchr("BCFRST", h->type) != NULL)
1218 /* First pass - compute total store needed; second pass - compute
1219 total store used, including this header. */
1221 size += ilen + comma + 1; /* +1 for the newline */
1223 /* Second pass - concatentate the data, up to a maximum. Note that
1224 the loop stops when size hits the limit. */
1228 if (size > header_insert_maxlen)
1230 ilen -= size - header_insert_maxlen - 1;
1233 Ustrncpy(ptr, t, ilen);
1236 /* For a non-raw header, put in the comma if needed, then add
1237 back the newline we removed above, provided there was some text in
1240 if (!want_raw && ilen > 0)
1242 if (comma != 0) *ptr++ = ',';
1250 /* At end of first pass, return NULL if no header found. Then truncate size
1251 if necessary, and get the buffer to hold the data, returning the buffer size.
1256 if (!found) return NULL;
1257 if (size > header_insert_maxlen) size = header_insert_maxlen;
1258 *newsize = size + 1;
1259 ptr = yield = store_get(*newsize);
1263 /* That's all we do for raw header expansion. */
1270 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1271 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1272 function can return an error with decoded data if the charset translation
1273 fails. If decoding fails, it returns NULL. */
1277 uschar *decoded, *error;
1278 if (ptr > yield && ptr[-1] == '\n') ptr--;
1279 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1281 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1285 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1286 " input was: %s\n", error, yield);
1288 if (decoded != NULL) yield = decoded;
1297 /*************************************************
1298 * Find value of a variable *
1299 *************************************************/
1301 /* The table of variables is kept in alphabetic order, so we can search it
1302 using a binary chop. The "choplen" variable is nothing to do with the binary
1306 name the name of the variable being sought
1307 exists_only TRUE if this is a def: test; passed on to find_header()
1308 skipping TRUE => skip any processing evaluation; this is not the same as
1309 exists_only because def: may test for values that are first
1311 newsize pointer to an int which is initially zero; if the answer is in
1312 a new memory buffer, *newsize is set to its size
1314 Returns: NULL if the variable does not exist, or
1315 a pointer to the variable's contents, or
1316 something non-NULL if exists_only is TRUE
1320 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1323 int last = var_table_size;
1325 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1326 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1327 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1328 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1329 (this gave backwards compatibility at the changeover). There may be built-in
1330 variables whose names start acl_ but they should never start in this way. This
1331 slightly messy specification is a consequence of the history, needless to say.
1333 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1334 set, in which case give an error. */
1336 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1340 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1341 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1344 /* Handle $auth<n> variables. */
1346 if (Ustrncmp(name, "auth", 4) == 0)
1349 int n = Ustrtoul(name + 4, &endptr, 10);
1350 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1351 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1354 /* For all other variables, search the table */
1356 while (last > first)
1360 int middle = (first + last)/2;
1361 int c = Ustrcmp(name, var_table[middle].name);
1363 if (c > 0) { first = middle + 1; continue; }
1364 if (c < 0) { last = middle; continue; }
1366 /* Found an existing variable. If in skipping state, the value isn't needed,
1367 and we want to avoid processing (such as looking up the host name). */
1369 if (skipping) return US"";
1371 switch (var_table[middle].type)
1373 #ifdef EXPERIMENTAL_DOMAINKEYS
1375 case vtype_dk_verify:
1376 if (dk_verify_block == NULL) return US"";
1378 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1379 s = dk_verify_block->result_string;
1380 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1381 s = dk_verify_block->address;
1382 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1383 s = dk_verify_block->domain;
1384 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1385 s = dk_verify_block->local_part;
1387 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1388 switch(dk_verify_block->address_source) {
1389 case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1390 case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1391 case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1394 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1395 switch(dk_verify_block->result) {
1396 case DK_EXIM_RESULT_ERR: s = US"error"; break;
1397 case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1398 case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1399 case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1400 case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1401 case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1402 case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1403 case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1406 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1407 s = (dk_verify_block->signsall)? US"1" : US"0";
1409 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1410 s = (dk_verify_block->testing)? US"1" : US"0";
1412 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1413 s = (dk_verify_block->is_signed)? US"1" : US"0";
1415 return (s == NULL)? US"" : s;
1418 case vtype_filter_int:
1419 if (!filter_running) return NULL;
1423 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1427 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1431 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1435 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1438 case vtype_stringptr: /* Pointer to string */
1439 s = *((uschar **)(var_table[middle].value));
1440 return (s == NULL)? US"" : s;
1443 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1446 case vtype_load_avg:
1447 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1450 case vtype_host_lookup: /* Lookup if not done so */
1451 if (sender_host_name == NULL && sender_host_address != NULL &&
1452 !host_lookup_failed && host_name_lookup() == OK)
1453 host_build_sender_fullhost();
1454 return (sender_host_name == NULL)? US"" : sender_host_name;
1456 case vtype_localpart: /* Get local part from address */
1457 s = *((uschar **)(var_table[middle].value));
1458 if (s == NULL) return US"";
1459 domain = Ustrrchr(s, '@');
1460 if (domain == NULL) return s;
1461 if (domain - s > sizeof(var_buffer) - 1)
1462 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1463 "string expansion", sizeof(var_buffer));
1464 Ustrncpy(var_buffer, s, domain - s);
1465 var_buffer[domain - s] = 0;
1468 case vtype_domain: /* Get domain from address */
1469 s = *((uschar **)(var_table[middle].value));
1470 if (s == NULL) return US"";
1471 domain = Ustrrchr(s, '@');
1472 return (domain == NULL)? US"" : domain + 1;
1474 case vtype_msgheaders:
1475 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1477 case vtype_msgheaders_raw:
1478 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1480 case vtype_msgbody: /* Pointer to msgbody string */
1481 case vtype_msgbody_end: /* Ditto, the end of the msg */
1482 ss = (uschar **)(var_table[middle].value);
1483 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1486 off_t start_offset = SPOOL_DATA_START_OFFSET;
1487 int len = message_body_visible;
1488 if (len > message_size) len = message_size;
1489 *ss = body = store_malloc(len+1);
1491 if (var_table[middle].type == vtype_msgbody_end)
1493 struct stat statbuf;
1494 if (fstat(deliver_datafile, &statbuf) == 0)
1496 start_offset = statbuf.st_size - len;
1497 if (start_offset < SPOOL_DATA_START_OFFSET)
1498 start_offset = SPOOL_DATA_START_OFFSET;
1501 lseek(deliver_datafile, start_offset, SEEK_SET);
1502 len = read(deliver_datafile, body, len);
1508 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1512 return (*ss == NULL)? US"" : *ss;
1514 case vtype_todbsdin: /* BSD inbox time of day */
1515 return tod_stamp(tod_bsdin);
1517 case vtype_tode: /* Unix epoch time of day */
1518 return tod_stamp(tod_epoch);
1520 case vtype_todf: /* Full time of day */
1521 return tod_stamp(tod_full);
1523 case vtype_todl: /* Log format time of day */
1524 return tod_stamp(tod_log_bare); /* (without timezone) */
1526 case vtype_todzone: /* Time zone offset only */
1527 return tod_stamp(tod_zone);
1529 case vtype_todzulu: /* Zulu time */
1530 return tod_stamp(tod_zulu);
1532 case vtype_todlf: /* Log file datestamp tod */
1533 return tod_stamp(tod_log_datestamp);
1535 case vtype_reply: /* Get reply address */
1536 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1538 if (s != NULL) while (isspace(*s)) s++;
1539 if (s == NULL || *s == 0)
1541 *newsize = 0; /* For the *s==0 case */
1542 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1547 while (isspace(*s)) s++;
1548 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1549 while (t > s && isspace(t[-1])) t--;
1552 return (s == NULL)? US"" : s;
1554 /* A recipients list is available only during system message filtering,
1555 during ACL processing after DATA, and while expanding pipe commands
1556 generated from a system filter, but not elsewhere. */
1558 case vtype_recipients:
1559 if (!enable_dollar_recipients) return NULL; else
1564 s = store_get(size);
1565 for (i = 0; i < recipients_count; i++)
1567 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1568 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1569 Ustrlen(recipients_list[i].address));
1571 s[ptr] = 0; /* string_cat() leaves room */
1578 sprintf(CS var_buffer, "%d",
1579 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1586 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1587 sprintf(CS var_buffer, "%d", inodes);
1593 return NULL; /* Unknown variable name */
1599 /*************************************************
1600 * Read and expand substrings *
1601 *************************************************/
1603 /* This function is called to read and expand argument substrings for various
1604 expansion items. Some have a minimum requirement that is less than the maximum;
1605 in these cases, the first non-present one is set to NULL.
1608 sub points to vector of pointers to set
1609 n maximum number of substrings
1611 sptr points to current string pointer
1612 skipping the skipping flag
1613 check_end if TRUE, check for final '}'
1614 name name of item, for error message
1616 Returns: 0 OK; string pointer updated
1617 1 curly bracketing error (too few arguments)
1618 2 too many arguments (only if check_end is set); message set
1619 3 other error (expansion failure)
1623 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1624 BOOL check_end, uschar *name)
1629 while (isspace(*s)) s++;
1630 for (i = 0; i < n; i++)
1634 if (i < m) return 1;
1638 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1639 if (sub[i] == NULL) return 3;
1640 if (*s++ != '}') return 1;
1641 while (isspace(*s)) s++;
1643 if (check_end && *s++ != '}')
1647 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1648 "(max is %d)", name, n);
1661 /*************************************************
1662 * Elaborate message for bad variable *
1663 *************************************************/
1665 /* For the "unknown variable" message, take a look at the variable's name, and
1666 give additional information about possible ACL variables. The extra information
1667 is added on to expand_string_message.
1669 Argument: the name of the variable
1674 check_variable_error_message(uschar *name)
1676 if (Ustrncmp(name, "acl_", 4) == 0)
1677 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1678 (name[4] == 'c' || name[4] == 'm')?
1680 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1681 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1683 US"user-defined ACL variables must start acl_c or acl_m");
1688 /*************************************************
1689 * Read and evaluate a condition *
1690 *************************************************/
1694 s points to the start of the condition text
1695 yield points to a BOOL to hold the result of the condition test;
1696 if NULL, we are just reading through a condition that is
1697 part of an "or" combination to check syntax, or in a state
1698 where the answer isn't required
1700 Returns: a pointer to the first character after the condition, or
1705 eval_condition(uschar *s, BOOL *yield)
1707 BOOL testfor = TRUE;
1708 BOOL tempcond, combined_cond;
1710 int i, rc, cond_type, roffset;
1712 struct stat statbuf;
1717 const uschar *rerror;
1721 while (isspace(*s)) s++;
1722 if (*s == '!') { testfor = !testfor; s++; } else break;
1725 /* Numeric comparisons are symbolic */
1727 if (*s == '=' || *s == '>' || *s == '<')
1739 /* All other conditions are named */
1741 else s = read_name(name, 256, s, US"_");
1743 /* If we haven't read a name, it means some non-alpha character is first. */
1747 expand_string_message = string_sprintf("condition name expected, "
1748 "but found \"%.16s\"", s);
1752 /* Find which condition we are dealing with, and switch on it */
1754 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1757 /* def: tests for a non-empty variable, or for the existence of a header. If
1758 yield == NULL we are in a skipping state, and don't care about the answer. */
1763 expand_string_message = US"\":\" expected after \"def\"";
1767 s = read_name(name, 256, s+1, US"_");
1769 /* Test for a header's existence. If the name contains a closing brace
1770 character, this may be a user error where the terminating colon has been
1771 omitted. Set a flag to adjust a subsequent error message in this case. */
1773 if (Ustrncmp(name, "h_", 2) == 0 ||
1774 Ustrncmp(name, "rh_", 3) == 0 ||
1775 Ustrncmp(name, "bh_", 3) == 0 ||
1776 Ustrncmp(name, "header_", 7) == 0 ||
1777 Ustrncmp(name, "rheader_", 8) == 0 ||
1778 Ustrncmp(name, "bheader_", 8) == 0)
1780 s = read_header_name(name, 256, s);
1781 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1782 if (yield != NULL) *yield =
1783 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1786 /* Test for a variable's having a non-empty value. A non-existent variable
1787 causes an expansion failure. */
1791 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1794 expand_string_message = (name[0] == 0)?
1795 string_sprintf("variable name omitted after \"def:\"") :
1796 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1797 check_variable_error_message(name);
1800 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1806 /* first_delivery tests for first delivery attempt */
1808 case ECOND_FIRST_DELIVERY:
1809 if (yield != NULL) *yield = deliver_firsttime == testfor;
1813 /* queue_running tests for any process started by a queue runner */
1815 case ECOND_QUEUE_RUNNING:
1816 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1820 /* exists: tests for file existence
1821 isip: tests for any IP address
1822 isip4: tests for an IPv4 address
1823 isip6: tests for an IPv6 address
1824 pam: does PAM authentication
1825 radius: does RADIUS authentication
1826 ldapauth: does LDAP authentication
1827 pwcheck: does Cyrus SASL pwcheck authentication
1836 case ECOND_LDAPAUTH:
1839 while (isspace(*s)) s++;
1840 if (*s != '{') goto COND_FAILED_CURLY_START;
1842 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1843 if (sub[0] == NULL) return NULL;
1844 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1846 if (yield == NULL) return s; /* No need to run the test if skipping */
1851 if ((expand_forbid & RDO_EXISTS) != 0)
1853 expand_string_message = US"File existence tests are not permitted";
1856 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1862 rc = string_is_ip_address(sub[0], NULL);
1863 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1864 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1867 /* Various authentication tests - all optionally compiled */
1871 rc = auth_call_pam(sub[0], &expand_string_message);
1874 goto COND_FAILED_NOT_COMPILED;
1875 #endif /* SUPPORT_PAM */
1878 #ifdef RADIUS_CONFIG_FILE
1879 rc = auth_call_radius(sub[0], &expand_string_message);
1882 goto COND_FAILED_NOT_COMPILED;
1883 #endif /* RADIUS_CONFIG_FILE */
1885 case ECOND_LDAPAUTH:
1888 /* Just to keep the interface the same */
1890 int old_pool = store_pool;
1891 store_pool = POOL_SEARCH;
1892 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1893 &expand_string_message, &do_cache);
1894 store_pool = old_pool;
1898 goto COND_FAILED_NOT_COMPILED;
1899 #endif /* LOOKUP_LDAP */
1902 #ifdef CYRUS_PWCHECK_SOCKET
1903 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1906 goto COND_FAILED_NOT_COMPILED;
1907 #endif /* CYRUS_PWCHECK_SOCKET */
1909 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1910 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1912 if (rc == ERROR || rc == DEFER) return NULL;
1913 *yield = (rc == OK) == testfor;
1919 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1921 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1923 However, the last two are optional. That is why the whole set is enclosed
1924 in their own set or braces. */
1926 case ECOND_SASLAUTHD:
1927 #ifndef CYRUS_SASLAUTHD_SOCKET
1928 goto COND_FAILED_NOT_COMPILED;
1930 while (isspace(*s)) s++;
1931 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1932 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1934 case 1: expand_string_message = US"too few arguments or bracketing "
1935 "error for saslauthd";
1937 case 3: return NULL;
1939 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1943 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1944 &expand_string_message);
1945 if (rc == ERROR || rc == DEFER) return NULL;
1946 *yield = (rc == OK) == testfor;
1949 #endif /* CYRUS_SASLAUTHD_SOCKET */
1952 /* symbolic operators for numeric and string comparison, and a number of
1953 other operators, all requiring two arguments.
1955 match: does a regular expression match and sets up the numerical
1956 variables if it succeeds
1957 match_address: matches in an address list
1958 match_domain: matches in a domain list
1959 match_ip: matches a host list that is restricted to IP addresses
1960 match_local_part: matches in a local part list
1961 crypteq: encrypts plaintext and compares against an encrypted text,
1962 using crypt(), crypt16(), MD5 or SHA-1
1966 case ECOND_MATCH_ADDRESS:
1967 case ECOND_MATCH_DOMAIN:
1968 case ECOND_MATCH_IP:
1969 case ECOND_MATCH_LOCAL_PART:
1972 case ECOND_NUM_L: /* Numerical comparisons */
1979 case ECOND_STR_LT: /* String comparisons */
1990 for (i = 0; i < 2; i++)
1992 while (isspace(*s)) s++;
1995 if (i == 0) goto COND_FAILED_CURLY_START;
1996 expand_string_message = string_sprintf("missing 2nd string in {} "
1997 "after \"%s\"", name);
2000 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
2001 if (sub[i] == NULL) return NULL;
2002 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2004 /* Convert to numerical if required; we know that the names of all the
2005 conditions that compare numbers do not start with a letter. This just saves
2006 checking for them individually. */
2008 if (!isalpha(name[0]) && yield != NULL)
2014 debug_printf("empty string cast to zero for numerical comparison\n");
2018 num[i] = expand_string_integer(sub[i], FALSE);
2019 if (expand_string_message != NULL) return NULL;
2024 /* Result not required */
2026 if (yield == NULL) return s;
2028 /* Do an appropriate comparison */
2034 *yield = (num[0] == num[1]) == testfor;
2038 *yield = (num[0] > num[1]) == testfor;
2042 *yield = (num[0] >= num[1]) == testfor;
2046 *yield = (num[0] < num[1]) == testfor;
2050 *yield = (num[0] <= num[1]) == testfor;
2054 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2058 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2062 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2066 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2070 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2074 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2078 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2082 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2086 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2090 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2093 case ECOND_MATCH: /* Regular expression match */
2094 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2098 expand_string_message = string_sprintf("regular expression error in "
2099 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2102 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2105 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2106 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2107 goto MATCHED_SOMETHING;
2109 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2110 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2111 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2112 goto MATCHED_SOMETHING;
2114 case ECOND_MATCH_IP: /* Match IP address in a host list */
2115 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2117 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2123 unsigned int *nullcache = NULL;
2124 check_host_block cb;
2126 cb.host_name = US"";
2127 cb.host_address = sub[0];
2129 /* If the host address starts off ::ffff: it is an IPv6 address in
2130 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2133 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2134 cb.host_address + 7 : cb.host_address;
2136 rc = match_check_list(
2137 &sub[1], /* the list */
2138 0, /* separator character */
2139 &hostlist_anchor, /* anchor pointer */
2140 &nullcache, /* cache pointer */
2141 check_host, /* function for testing */
2142 &cb, /* argument for function */
2143 MCL_HOST, /* type of check */
2144 sub[0], /* text for debugging */
2145 NULL); /* where to pass back data */
2147 goto MATCHED_SOMETHING;
2149 case ECOND_MATCH_LOCAL_PART:
2150 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2151 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2166 expand_string_message = string_sprintf("unable to complete match "
2167 "against \"%s\": %s", sub[1], search_error_message);
2173 /* Various "encrypted" comparisons. If the second string starts with
2174 "{" then an encryption type is given. Default to crypt() or crypt16()
2175 (build-time choice). */
2178 #ifndef SUPPORT_CRYPTEQ
2179 goto COND_FAILED_NOT_COMPILED;
2181 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2183 int sublen = Ustrlen(sub[1]+5);
2188 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2190 /* If the length that we are comparing against is 24, the MD5 digest
2191 is expressed as a base64 string. This is the way LDAP does it. However,
2192 some other software uses a straightforward hex representation. We assume
2193 this if the length is 32. Other lengths fail. */
2197 uschar *coded = auth_b64encode((uschar *)digest, 16);
2198 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2199 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2200 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2202 else if (sublen == 32)
2206 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2208 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2209 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2210 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2214 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2215 "fail\n crypted=%s\n", sub[1]+5);
2220 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2222 int sublen = Ustrlen(sub[1]+6);
2227 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2229 /* If the length that we are comparing against is 28, assume the SHA1
2230 digest is expressed as a base64 string. If the length is 40, assume a
2231 straightforward hex representation. Other lengths fail. */
2235 uschar *coded = auth_b64encode((uschar *)digest, 20);
2236 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2237 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2238 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2240 else if (sublen == 40)
2244 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2246 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2247 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2248 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2252 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2253 "fail\n crypted=%s\n", sub[1]+6);
2258 else /* {crypt} or {crypt16} and non-{ at start */
2263 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2268 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2273 else if (sub[1][0] == '{')
2275 expand_string_message = string_sprintf("unknown encryption mechanism "
2276 "in \"%s\"", sub[1]);
2282 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2283 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2284 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2288 #define XSTR(s) STR(s)
2289 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2290 " subject=%s\n crypted=%s\n",
2291 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2296 /* If the encrypted string contains fewer than two characters (for the
2297 salt), force failure. Otherwise we get false positives: with an empty
2298 string the yield of crypt() is an empty string! */
2300 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2301 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2304 #endif /* SUPPORT_CRYPTEQ */
2305 } /* Switch for comparison conditions */
2307 return s; /* End of comparison conditions */
2310 /* and/or: computes logical and/or of several conditions */
2314 subcondptr = (yield == NULL)? NULL : &tempcond;
2315 combined_cond = (cond_type == ECOND_AND);
2317 while (isspace(*s)) s++;
2318 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2322 while (isspace(*s)) s++;
2323 if (*s == '}') break;
2326 expand_string_message = string_sprintf("each subcondition "
2327 "inside an \"%s{...}\" condition must be in its own {}", name);
2331 s = eval_condition(s+1, subcondptr);
2334 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2335 expand_string_message, name);
2338 while (isspace(*s)) s++;
2342 expand_string_message = string_sprintf("missing } at end of condition "
2343 "inside \"%s\" group", name);
2349 if (cond_type == ECOND_AND)
2351 combined_cond &= tempcond;
2352 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2353 } /* evaluate any more */
2356 combined_cond |= tempcond;
2357 if (combined_cond) subcondptr = NULL; /* once true, don't */
2358 } /* evaluate any more */
2362 if (yield != NULL) *yield = (combined_cond == testfor);
2366 /* forall/forany: iterates a condition with different values */
2372 uschar *save_iterate_item = iterate_item;
2374 while (isspace(*s)) s++;
2375 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2376 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL));
2377 if (sub[0] == NULL) return NULL;
2378 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2380 while (isspace(*s)) s++;
2381 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2385 /* Call eval_condition once, with result discarded (as if scanning a
2386 "false" part). This allows us to find the end of the condition, because if
2387 the list it empty, we won't actually evaluate the condition for real. */
2389 s = eval_condition(sub[1], NULL);
2392 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2393 expand_string_message, name);
2396 while (isspace(*s)) s++;
2400 expand_string_message = string_sprintf("missing } at end of condition "
2401 "inside \"%s\"", name);
2405 if (yield != NULL) *yield = !testfor;
2406 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2408 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2409 if (eval_condition(sub[1], &tempcond) == NULL)
2411 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2412 expand_string_message, name);
2413 iterate_item = save_iterate_item;
2416 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2417 tempcond? "true":"false");
2419 if (yield != NULL) *yield = (tempcond == testfor);
2420 if (tempcond == (cond_type == ECOND_FORANY)) break;
2423 iterate_item = save_iterate_item;
2428 /* Unknown condition */
2431 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2433 } /* End switch on condition type */
2435 /* Missing braces at start and end of data */
2437 COND_FAILED_CURLY_START:
2438 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2441 COND_FAILED_CURLY_END:
2442 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2446 /* A condition requires code that is not compiled */
2448 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2449 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2450 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2451 COND_FAILED_NOT_COMPILED:
2452 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2461 /*************************************************
2462 * Save numerical variables *
2463 *************************************************/
2465 /* This function is called from items such as "if" that want to preserve and
2466 restore the numbered variables.
2469 save_expand_string points to an array of pointers to set
2470 save_expand_nlength points to an array of ints for the lengths
2472 Returns: the value of expand max to save
2476 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2479 for (i = 0; i <= expand_nmax; i++)
2481 save_expand_nstring[i] = expand_nstring[i];
2482 save_expand_nlength[i] = expand_nlength[i];
2489 /*************************************************
2490 * Restore numerical variables *
2491 *************************************************/
2493 /* This function restored saved values of numerical strings.
2496 save_expand_nmax the number of strings to restore
2497 save_expand_string points to an array of pointers
2498 save_expand_nlength points to an array of ints
2504 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2505 int *save_expand_nlength)
2508 expand_nmax = save_expand_nmax;
2509 for (i = 0; i <= expand_nmax; i++)
2511 expand_nstring[i] = save_expand_nstring[i];
2512 expand_nlength[i] = save_expand_nlength[i];
2520 /*************************************************
2521 * Handle yes/no substrings *
2522 *************************************************/
2524 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2525 alternative substrings that depend on whether or not the condition was true,
2526 or the lookup or extraction succeeded. The substrings always have to be
2527 expanded, to check their syntax, but "skipping" is set when the result is not
2528 needed - this avoids unnecessary nested lookups.
2531 skipping TRUE if we were skipping when this item was reached
2532 yes TRUE if the first string is to be used, else use the second
2533 save_lookup a value to put back into lookup_value before the 2nd expansion
2534 sptr points to the input string pointer
2535 yieldptr points to the output string pointer
2536 sizeptr points to the output string size
2537 ptrptr points to the output string pointer
2538 type "lookup" or "if" or "extract" or "run", for error message
2540 Returns: 0 OK; lookup_value has been reset to save_lookup
2542 2 expansion failed because of bracketing error
2546 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2547 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2550 uschar *s = *sptr; /* Local value */
2551 uschar *sub1, *sub2;
2553 /* If there are no following strings, we substitute the contents of $value for
2554 lookups and for extractions in the success case. For the ${if item, the string
2555 "true" is substituted. In the fail case, nothing is substituted for all three
2558 while (isspace(*s)) s++;
2563 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2567 if (yes && lookup_value != NULL)
2568 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2569 Ustrlen(lookup_value));
2570 lookup_value = save_lookup;
2576 /* The first following string must be braced. */
2578 if (*s++ != '{') goto FAILED_CURLY;
2580 /* Expand the first substring. Forced failures are noticed only if we actually
2581 want this string. Set skipping in the call in the fail case (this will always
2582 be the case if we were already skipping). */
2584 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2585 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2586 expand_string_forcedfail = FALSE;
2587 if (*s++ != '}') goto FAILED_CURLY;
2589 /* If we want the first string, add it to the output */
2592 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2594 /* If this is called from a lookup or an extract, we want to restore $value to
2595 what it was at the start of the item, so that it has this value during the
2596 second string expansion. For the call from "if" or "run" to this function,
2597 save_lookup is set to lookup_value, so that this statement does nothing. */
2599 lookup_value = save_lookup;
2601 /* There now follows either another substring, or "fail", or nothing. This
2602 time, forced failures are noticed only if we want the second string. We must
2603 set skipping in the nested call if we don't want this string, or if we were
2604 already skipping. */
2606 while (isspace(*s)) s++;
2609 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2610 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2611 expand_string_forcedfail = FALSE;
2612 if (*s++ != '}') goto FAILED_CURLY;
2614 /* If we want the second string, add it to the output */
2617 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2620 /* If there is no second string, but the word "fail" is present when the use of
2621 the second string is wanted, set a flag indicating it was a forced failure
2622 rather than a syntactic error. Swallow the terminating } in case this is nested
2623 inside another lookup or if or extract. */
2628 s = read_name(name, sizeof(name), s, US"_");
2629 if (Ustrcmp(name, "fail") == 0)
2631 if (!yes && !skipping)
2633 while (isspace(*s)) s++;
2634 if (*s++ != '}') goto FAILED_CURLY;
2635 expand_string_message =
2636 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2637 expand_string_forcedfail = TRUE;
2643 expand_string_message =
2644 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2649 /* All we have to do now is to check on the final closing brace. */
2651 while (isspace(*s)) s++;
2652 if (*s++ == '}') goto RETURN;
2654 /* Get here if there is a bracketing failure */
2659 /* Get here for other failures */
2664 /* Update the input pointer value before returning */
2674 /*************************************************
2675 * Handle MD5 or SHA-1 computation for HMAC *
2676 *************************************************/
2678 /* These are some wrapping functions that enable the HMAC code to be a bit
2679 cleaner. A good compiler will spot the tail recursion.
2682 type HMAC_MD5 or HMAC_SHA1
2683 remaining are as for the cryptographic hash functions
2689 chash_start(int type, void *base)
2691 if (type == HMAC_MD5)
2692 md5_start((md5 *)base);
2694 sha1_start((sha1 *)base);
2698 chash_mid(int type, void *base, uschar *string)
2700 if (type == HMAC_MD5)
2701 md5_mid((md5 *)base, string);
2703 sha1_mid((sha1 *)base, string);
2707 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2709 if (type == HMAC_MD5)
2710 md5_end((md5 *)base, string, length, digest);
2712 sha1_end((sha1 *)base, string, length, digest);
2719 /********************************************************
2720 * prvs: Get last three digits of days since Jan 1, 1970 *
2721 ********************************************************/
2723 /* This is needed to implement the "prvs" BATV reverse
2726 Argument: integer "days" offset to add or substract to
2727 or from the current number of days.
2729 Returns: pointer to string containing the last three
2730 digits of the number of days since Jan 1, 1970,
2731 modified by the offset argument, NULL if there
2732 was an error in the conversion.
2737 prvs_daystamp(int day_offset)
2739 uschar *days = store_get(32); /* Need at least 24 for cases */
2740 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2741 (time(NULL) + day_offset*86400)/86400);
2742 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2747 /********************************************************
2748 * prvs: perform HMAC-SHA1 computation of prvs bits *
2749 ********************************************************/
2751 /* This is needed to implement the "prvs" BATV reverse
2755 address RFC2821 Address to use
2756 key The key to use (must be less than 64 characters
2758 key_num Single-digit key number to use. Defaults to
2761 Returns: pointer to string containing the first three
2762 bytes of the final hash in hex format, NULL if
2763 there was an error in the process.
2767 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2769 uschar *hash_source, *p;
2770 int size = 0,offset = 0,i;
2772 void *use_base = &sha1_base;
2773 uschar innerhash[20];
2774 uschar finalhash[20];
2775 uschar innerkey[64];
2776 uschar outerkey[64];
2777 uschar *finalhash_hex = store_get(40);
2779 if (key_num == NULL)
2782 if (Ustrlen(key) > 64)
2785 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2786 string_cat(hash_source,&size,&offset,daystamp,3);
2787 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2788 hash_source[offset] = '\0';
2790 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2792 memset(innerkey, 0x36, 64);
2793 memset(outerkey, 0x5c, 64);
2795 for (i = 0; i < Ustrlen(key); i++)
2797 innerkey[i] ^= key[i];
2798 outerkey[i] ^= key[i];
2801 chash_start(HMAC_SHA1, use_base);
2802 chash_mid(HMAC_SHA1, use_base, innerkey);
2803 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2805 chash_start(HMAC_SHA1, use_base);
2806 chash_mid(HMAC_SHA1, use_base, outerkey);
2807 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2810 for (i = 0; i < 3; i++)
2812 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2813 *p++ = hex_digits[finalhash[i] & 0x0f];
2817 return finalhash_hex;
2823 /*************************************************
2824 * Join a file onto the output string *
2825 *************************************************/
2827 /* This is used for readfile and after a run expansion. It joins the contents
2828 of a file onto the output string, globally replacing newlines with a given
2829 string (optionally). The file is closed at the end.
2833 yield pointer to the expandable string
2834 sizep pointer to the current size
2835 ptrp pointer to the current position
2836 eol newline replacement string, or NULL
2838 Returns: new value of string pointer
2842 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2845 uschar buffer[1024];
2847 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2849 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2851 int len = Ustrlen(buffer);
2852 if (eol != NULL && buffer[len-1] == '\n') len--;
2853 yield = string_cat(yield, sizep, ptrp, buffer, len);
2854 if (buffer[len] != 0)
2855 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2858 if (yield != NULL) yield[*ptrp] = 0;
2866 /*************************************************
2867 * Evaluate numeric expression *
2868 *************************************************/
2870 /* This is a set of mutually recursive functions that evaluate an arithmetic
2871 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
2872 these functions that is called from elsewhere is eval_expr, whose interface is:
2875 sptr pointer to the pointer to the string - gets updated
2876 decimal TRUE if numbers are to be assumed decimal
2877 error pointer to where to put an error message - must be NULL on input
2878 endket TRUE if ')' must terminate - FALSE for external call
2880 Returns: on success: the value of the expression, with *error still NULL
2881 on failure: an undefined value, with *error = a message
2884 static int eval_op_or(uschar **, BOOL, uschar **);
2888 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2891 int x = eval_op_or(&s, decimal, error);
2897 *error = US"expecting closing parenthesis";
2899 while (isspace(*(++s)));
2901 else if (*s != 0) *error = US"expecting operator";
2909 eval_number(uschar **sptr, BOOL decimal, uschar **error)
2914 while (isspace(*s)) s++;
2919 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2921 if (tolower(*s) == 'k') { n *= 1024; s++; }
2922 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2923 while (isspace (*s)) s++;
2928 n = eval_expr(&s, decimal, error, 1);
2932 *error = US"expecting number or opening parenthesis";
2940 static int eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
2944 while (isspace(*s)) s++;
2945 if (*s == '+' || *s == '-' || *s == '~')
2948 x = eval_op_unary(&s, decimal, error);
2949 if (op == '-') x = -x;
2950 else if (op == '~') x = ~x;
2954 x = eval_number(&s, decimal, error);
2961 static int eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
2964 int x = eval_op_unary(&s, decimal, error);
2967 while (*s == '*' || *s == '/' || *s == '%')
2970 int y = eval_op_unary(&s, decimal, error);
2971 if (*error != NULL) break;
2972 if (op == '*') x *= y;
2973 else if (op == '/') x /= y;
2982 static int eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
2985 int x = eval_op_mult(&s, decimal, error);
2988 while (*s == '+' || *s == '-')
2991 int y = eval_op_mult(&s, decimal, error);
2992 if (*error != NULL) break;
2993 if (op == '+') x += y; else x -= y;
3001 static int eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3004 int x = eval_op_sum(&s, decimal, error);
3007 while ((*s == '<' || *s == '>') && s[1] == s[0])
3012 y = eval_op_sum(&s, decimal, error);
3013 if (*error != NULL) break;
3014 if (op == '<') x <<= y; else x >>= y;
3022 static int eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3025 int x = eval_op_shift(&s, decimal, error);
3032 y = eval_op_shift(&s, decimal, error);
3033 if (*error != NULL) break;
3042 static int eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3045 int x = eval_op_and(&s, decimal, error);
3052 y = eval_op_and(&s, decimal, error);
3053 if (*error != NULL) break;
3062 static int eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3065 int x = eval_op_xor(&s, decimal, error);
3072 y = eval_op_xor(&s, decimal, error);
3073 if (*error != NULL) break;
3083 /*************************************************
3085 *************************************************/
3087 /* Returns either an unchanged string, or the expanded string in stacking pool
3088 store. Interpreted sequences are:
3090 \... normal escaping rules
3091 $name substitutes the variable
3093 ${op:string} operates on the expanded string value
3094 ${item{arg1}{arg2}...} expands the args and then does the business
3095 some literal args are not enclosed in {}
3097 There are now far too many operators and item types to make it worth listing
3098 them here in detail any more.
3100 We use an internal routine recursively to handle embedded substrings. The
3101 external function follows. The yield is NULL if the expansion failed, and there
3102 are two cases: if something collapsed syntactically, or if "fail" was given
3103 as the action on a lookup failure. These can be distinguised by looking at the
3104 variable expand_string_forcedfail, which is TRUE in the latter case.
3106 The skipping flag is set true when expanding a substring that isn't actually
3107 going to be used (after "if" or "lookup") and it prevents lookups from
3108 happening lower down.
3110 Store usage: At start, a store block of the length of the input plus 64
3111 is obtained. This is expanded as necessary by string_cat(), which might have to
3112 get a new block, or might be able to expand the original. At the end of the
3113 function we can release any store above that portion of the yield block that
3114 was actually used. In many cases this will be optimal.
3116 However: if the first item in the expansion is a variable name or header name,
3117 we reset the store before processing it; if the result is in fresh store, we
3118 use that without copying. This is helpful for expanding strings like
3119 $message_headers which can get very long.
3122 string the string to be expanded
3123 ket_ends true if expansion is to stop at }
3124 left if not NULL, a pointer to the first character after the
3125 expansion is placed here (typically used with ket_ends)
3126 skipping TRUE for recursive calls when the value isn't actually going
3127 to be used (to allow for optimisation)
3129 Returns: NULL if expansion fails:
3130 expand_string_forcedfail is set TRUE if failure was forced
3131 expand_string_message contains a textual error message
3132 a pointer to the expanded string on success
3136 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3140 int size = Ustrlen(string)+ 64;
3142 uschar *yield = store_get(size);
3144 uschar *save_expand_nstring[EXPAND_MAXN+1];
3145 int save_expand_nlength[EXPAND_MAXN+1];
3147 expand_string_forcedfail = FALSE;
3148 expand_string_message = US"";
3155 /* \ escapes the next character, which must exist, or else
3156 the expansion fails. There's a special escape, \N, which causes
3157 copying of the subject verbatim up to the next \N. Otherwise,
3158 the escapes are the standard set. */
3164 expand_string_message = US"\\ at end of string";
3171 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3172 yield = string_cat(yield, &size, &ptr, t, s - t);
3173 if (*s != 0) s += 2;
3179 ch[0] = string_interpret_escape(&s);
3181 yield = string_cat(yield, &size, &ptr, ch, 1);
3187 /* Anything other than $ is just copied verbatim, unless we are
3188 looking for a terminating } character. */
3190 if (ket_ends && *s == '}') break;
3194 yield = string_cat(yield, &size, &ptr, s++, 1);
3198 /* No { after the $ - must be a plain name or a number for string
3199 match variable. There has to be a fudge for variables that are the
3200 names of header fields preceded by "$header_" because header field
3201 names can contain any printing characters except space and colon.
3202 For those that don't like typing this much, "$h_" is a synonym for
3203 "$header_". A non-existent header yields a NULL value; nothing is
3206 if (isalpha((*(++s))))
3211 s = read_name(name, sizeof(name), s, US"_");
3213 /* If this is the first thing to be expanded, release the pre-allocated
3216 if (ptr == 0 && yield != NULL)
3225 if (Ustrncmp(name, "h_", 2) == 0 ||
3226 Ustrncmp(name, "rh_", 3) == 0 ||
3227 Ustrncmp(name, "bh_", 3) == 0 ||
3228 Ustrncmp(name, "header_", 7) == 0 ||
3229 Ustrncmp(name, "rheader_", 8) == 0 ||
3230 Ustrncmp(name, "bheader_", 8) == 0)
3232 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3233 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3234 s = read_header_name(name, sizeof(name), s);
3235 value = find_header(name, FALSE, &newsize, want_raw, charset);
3237 /* If we didn't find the header, and the header contains a closing brace
3238 character, this may be a user error where the terminating colon
3239 has been omitted. Set a flag to adjust the error message in this case.
3240 But there is no error here - nothing gets inserted. */
3244 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3253 value = find_variable(name, FALSE, skipping, &newsize);
3256 expand_string_message =
3257 string_sprintf("unknown variable name \"%s\"", name);
3258 check_variable_error_message(name);
3263 /* If the data is known to be in a new buffer, newsize will be set to the
3264 size of that buffer. If this is the first thing in an expansion string,
3265 yield will be NULL; just point it at the new store instead of copying. Many
3266 expansion strings contain just one reference, so this is a useful
3267 optimization, especially for humungous headers. */
3269 len = Ustrlen(value);
3270 if (yield == NULL && newsize != 0)
3276 else yield = string_cat(yield, &size, &ptr, value, len);
3284 s = read_number(&n, s);
3285 if (n >= 0 && n <= expand_nmax)
3286 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3291 /* Otherwise, if there's no '{' after $ it's an error. */
3295 expand_string_message = US"$ not followed by letter, digit, or {";
3299 /* After { there can be various things, but they all start with
3300 an initial word, except for a number for a string match variable. */
3302 if (isdigit((*(++s))))
3305 s = read_number(&n, s);
3308 expand_string_message = US"} expected after number";
3311 if (n >= 0 && n <= expand_nmax)
3312 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3319 expand_string_message = US"letter or digit expected after ${";
3323 /* Allow "-" in names to cater for substrings with negative
3324 arguments. Since we are checking for known names after { this is
3327 s = read_name(name, sizeof(name), s, US"_-");
3328 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3332 /* Handle conditionals - preserve the values of the numerical expansion
3333 variables in case they get changed by a regular expression match in the
3334 condition. If not, they retain their external settings. At the end
3335 of this "if" section, they get restored to their previous values. */
3341 int save_expand_nmax =
3342 save_expand_strings(save_expand_nstring, save_expand_nlength);
3344 while (isspace(*s)) s++;
3345 next_s = eval_condition(s, skipping? NULL : &cond);
3346 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3349 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3350 cond? "true" : "false");
3354 /* The handling of "yes" and "no" result strings is now in a separate
3355 function that is also used by ${lookup} and ${extract} and ${run}. */
3357 switch(process_yesno(
3358 skipping, /* were previously skipping */
3359 cond, /* success/failure indicator */
3360 lookup_value, /* value to reset for string2 */
3361 &s, /* input pointer */
3362 &yield, /* output pointer */
3363 &size, /* output size */
3364 &ptr, /* output current point */
3365 US"if")) /* condition type */
3367 case 1: goto EXPAND_FAILED; /* when all is well, the */
3368 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3371 /* Restore external setting of expansion variables for continuation
3374 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3375 save_expand_nlength);
3379 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3380 expanding an internal string that isn't actually going to be used. All we
3381 need to do is check the syntax, so don't do a lookup at all. Preserve the
3382 values of the numerical expansion variables in case they get changed by a
3383 partial lookup. If not, they retain their external settings. At the end
3384 of this "lookup" section, they get restored to their previous values. */
3388 int stype, partial, affixlen, starflags;
3389 int expand_setup = 0;
3391 uschar *key, *filename, *affix;
3392 uschar *save_lookup_value = lookup_value;
3393 int save_expand_nmax =
3394 save_expand_strings(save_expand_nstring, save_expand_nlength);
3396 if ((expand_forbid & RDO_LOOKUP) != 0)
3398 expand_string_message = US"lookup expansions are not permitted";
3402 /* Get the key we are to look up for single-key+file style lookups.
3403 Otherwise set the key NULL pro-tem. */
3405 while (isspace(*s)) s++;
3408 key = expand_string_internal(s+1, TRUE, &s, skipping);
3409 if (key == NULL) goto EXPAND_FAILED;
3410 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3411 while (isspace(*s)) s++;
3415 /* Find out the type of database */
3419 expand_string_message = US"missing lookup type";
3423 /* The type is a string that may contain special characters of various
3424 kinds. Allow everything except space or { to appear; the actual content
3425 is checked by search_findtype_partial. */
3427 while (*s != 0 && *s != '{' && !isspace(*s))
3429 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3433 while (isspace(*s)) s++;
3435 /* Now check for the individual search type and any partial or default
3436 options. Only those types that are actually in the binary are valid. */
3438 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3442 expand_string_message = search_error_message;
3446 /* Check that a key was provided for those lookup types that need it,
3447 and was not supplied for those that use the query style. */
3449 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3453 expand_string_message = string_sprintf("missing {key} for single-"
3454 "key \"%s\" lookup", name);
3462 expand_string_message = string_sprintf("a single key was given for "
3463 "lookup type \"%s\", which is not a single-key lookup type", name);
3468 /* Get the next string in brackets and expand it. It is the file name for
3469 single-key+file lookups, and the whole query otherwise. In the case of
3470 queries that also require a file name (e.g. sqlite), the file name comes
3473 if (*s != '{') goto EXPAND_FAILED_CURLY;
3474 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3475 if (filename == NULL) goto EXPAND_FAILED;
3476 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3477 while (isspace(*s)) s++;
3479 /* If this isn't a single-key+file lookup, re-arrange the variables
3480 to be appropriate for the search_ functions. For query-style lookups,
3481 there is just a "key", and no file name. For the special query-style +
3482 file types, the query (i.e. "key") starts with a file name. */
3486 while (isspace(*filename)) filename++;
3489 if (mac_islookup(stype, lookup_querystyle))
3495 if (*filename != '/')
3497 expand_string_message = string_sprintf(
3498 "absolute file name expected for \"%s\" lookup", name);
3501 while (*key != 0 && !isspace(*key)) key++;
3502 if (*key != 0) *key++ = 0;
3506 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3507 the entry was not found. Note that there is no search_close() function.
3508 Files are left open in case of re-use. At suitable places in higher logic,
3509 search_tidyup() is called to tidy all open files. This can save opening
3510 the same file several times. However, files may also get closed when
3511 others are opened, if too many are open at once. The rule is that a
3512 handle should not be used after a second search_open().
3514 Request that a partial search sets up $1 and maybe $2 by passing
3515 expand_setup containing zero. If its value changes, reset expand_nmax,
3516 since new variables will have been set. Note that at the end of this
3517 "lookup" section, the old numeric variables are restored. */
3520 lookup_value = NULL;
3523 void *handle = search_open(filename, stype, 0, NULL, NULL);
3526 expand_string_message = search_error_message;
3529 lookup_value = search_find(handle, filename, key, partial, affix,
3530 affixlen, starflags, &expand_setup);
3531 if (search_find_defer)
3533 expand_string_message =
3534 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3535 search_error_message);
3538 if (expand_setup > 0) expand_nmax = expand_setup;
3541 /* The handling of "yes" and "no" result strings is now in a separate
3542 function that is also used by ${if} and ${extract}. */
3544 switch(process_yesno(
3545 skipping, /* were previously skipping */
3546 lookup_value != NULL, /* success/failure indicator */
3547 save_lookup_value, /* value to reset for string2 */
3548 &s, /* input pointer */
3549 &yield, /* output pointer */
3550 &size, /* output size */
3551 &ptr, /* output current point */
3552 US"lookup")) /* condition type */
3554 case 1: goto EXPAND_FAILED; /* when all is well, the */
3555 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3558 /* Restore external setting of expansion variables for carrying on
3559 at this level, and continue. */
3561 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3562 save_expand_nlength);
3566 /* If Perl support is configured, handle calling embedded perl subroutines,
3567 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3568 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3569 arguments (defined below). */
3571 #define EXIM_PERL_MAX_ARGS 8
3575 expand_string_message = US"\"${perl\" encountered, but this facility "
3576 "is not included in this binary";
3579 #else /* EXIM_PERL */
3581 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3584 if ((expand_forbid & RDO_PERL) != 0)
3586 expand_string_message = US"Perl calls are not permitted";
3590 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3593 case 1: goto EXPAND_FAILED_CURLY;
3595 case 3: goto EXPAND_FAILED;
3598 /* If skipping, we don't actually do anything */
3600 if (skipping) continue;
3602 /* Start the interpreter if necessary */
3604 if (!opt_perl_started)
3607 if (opt_perl_startup == NULL)
3609 expand_string_message = US"A setting of perl_startup is needed when "
3610 "using the Perl interpreter";
3613 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3614 initerror = init_perl(opt_perl_startup);
3615 if (initerror != NULL)
3617 expand_string_message =
3618 string_sprintf("error in perl_startup code: %s\n", initerror);
3621 opt_perl_started = TRUE;
3624 /* Call the function */
3626 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3627 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3628 sub_arg[0], sub_arg + 1);
3630 /* NULL yield indicates failure; if the message pointer has been set to
3631 NULL, the yield was undef, indicating a forced failure. Otherwise the
3632 message will indicate some kind of Perl error. */
3634 if (new_yield == NULL)
3636 if (expand_string_message == NULL)
3638 expand_string_message =
3639 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3640 "failure", sub_arg[0]);
3641 expand_string_forcedfail = TRUE;
3646 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3647 set during a callback from Perl. */
3649 expand_string_forcedfail = FALSE;
3653 #endif /* EXIM_PERL */
3655 /* Transform email address to "prvs" scheme to use
3656 as BATV-signed return path */
3663 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3665 case 1: goto EXPAND_FAILED_CURLY;
3667 case 3: goto EXPAND_FAILED;
3670 /* If skipping, we don't actually do anything */
3671 if (skipping) continue;
3673 /* sub_arg[0] is the address */
3674 domain = Ustrrchr(sub_arg[0],'@');
3675 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3677 expand_string_message = US"prvs first argument must be a qualified email address";
3681 /* Calculate the hash. The second argument must be a single-digit
3682 key number, or unset. */
3684 if (sub_arg[2] != NULL &&
3685 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3687 expand_string_message = US"prvs second argument must be a single digit";
3691 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3694 expand_string_message = US"prvs hmac-sha1 conversion failed";
3698 /* Now separate the domain from the local part */
3701 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3702 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3703 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3704 string_cat(yield,&size,&ptr,p,6);
3705 string_cat(yield,&size,&ptr,US"=",1);
3706 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3707 string_cat(yield,&size,&ptr,US"@",1);
3708 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3713 /* Check a prvs-encoded address for validity */
3715 case EITEM_PRVSCHECK:
3718 int mysize = 0, myptr = 0;
3722 /* TF: Ugliness: We want to expand parameter 1 first, then set
3723 up expansion variables that are used in the expansion of
3724 parameter 2. So we clone the string for the first
3725 expansion, where we only expand parameter 1.
3727 PH: Actually, that isn't necessary. The read_subs() function is
3728 designed to work this way for the ${if and ${lookup expansions. I've
3732 /* Reset expansion variables */
3733 prvscheck_result = NULL;
3734 prvscheck_address = NULL;
3735 prvscheck_keynum = NULL;
3737 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3739 case 1: goto EXPAND_FAILED_CURLY;
3741 case 3: goto EXPAND_FAILED;
3744 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
3747 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3749 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
3750 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
3751 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
3752 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
3753 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3755 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3756 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3757 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3758 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3759 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3761 /* Set up expansion variables */
3762 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3763 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3764 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3765 prvscheck_address[myptr] = '\0';
3766 prvscheck_keynum = string_copy(key_num);
3768 /* Now expand the second argument */
3769 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3771 case 1: goto EXPAND_FAILED_CURLY;
3773 case 3: goto EXPAND_FAILED;
3776 /* Now we have the key and can check the address. */
3778 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3783 expand_string_message = US"hmac-sha1 conversion failed";
3787 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3788 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3790 if (Ustrcmp(p,hash) == 0)
3792 /* Success, valid BATV address. Now check the expiry date. */
3793 uschar *now = prvs_daystamp(0);
3794 unsigned int inow = 0,iexpire = 1;
3796 (void)sscanf(CS now,"%u",&inow);
3797 (void)sscanf(CS daystamp,"%u",&iexpire);
3799 /* When "iexpire" is < 7, a "flip" has occured.
3800 Adjust "inow" accordingly. */
3801 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3805 prvscheck_result = US"1";
3806 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3810 prvscheck_result = NULL;
3811 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3816 prvscheck_result = NULL;
3817 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3820 /* Now expand the final argument. We leave this till now so that
3821 it can include $prvscheck_result. */
3823 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3825 case 1: goto EXPAND_FAILED_CURLY;
3827 case 3: goto EXPAND_FAILED;
3830 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3831 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3833 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3835 /* Reset the "internal" variables afterwards, because they are in
3836 dynamic store that will be reclaimed if the expansion succeeded. */
3838 prvscheck_address = NULL;
3839 prvscheck_keynum = NULL;
3843 /* Does not look like a prvs encoded address, return the empty string.
3844 We need to make sure all subs are expanded first, so as to skip over
3847 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3849 case 1: goto EXPAND_FAILED_CURLY;
3851 case 3: goto EXPAND_FAILED;
3858 /* Handle "readfile" to insert an entire file */
3860 case EITEM_READFILE:
3865 if ((expand_forbid & RDO_READFILE) != 0)
3867 expand_string_message = US"file insertions are not permitted";
3871 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3873 case 1: goto EXPAND_FAILED_CURLY;
3875 case 3: goto EXPAND_FAILED;
3878 /* If skipping, we don't actually do anything */
3880 if (skipping) continue;
3882 /* Open the file and read it */
3884 f = Ufopen(sub_arg[0], "rb");
3887 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3891 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3896 /* Handle "readsocket" to insert data from a Unix domain socket */
3898 case EITEM_READSOCK:
3904 struct sockaddr_un sockun; /* don't call this "sun" ! */
3908 if ((expand_forbid & RDO_READSOCK) != 0)
3910 expand_string_message = US"socket insertions are not permitted";
3914 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3915 because there may be a string for expansion on failure. */
3917 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3919 case 1: goto EXPAND_FAILED_CURLY;
3920 case 2: /* Won't occur: no end check */
3921 case 3: goto EXPAND_FAILED;
3924 /* Sort out timeout, if given */
3926 if (sub_arg[2] != NULL)
3928 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3931 expand_string_message = string_sprintf("bad time value %s",
3936 else sub_arg[3] = NULL; /* No eol if no timeout */
3938 /* If skipping, we don't actually do anything. Otherwise, arrange to
3939 connect to either an IP or a Unix socket. */
3943 /* Handle an IP (internet) domain */
3945 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
3947 BOOL connected = FALSE;
3951 uschar *server_name = sub_arg[0] + 5;
3952 uschar *port_name = Ustrrchr(server_name, ':');
3954 /* Sort out the port */
3956 if (port_name == NULL)
3958 expand_string_message =
3959 string_sprintf("missing port for readsocket %s", sub_arg[0]);
3962 *port_name++ = 0; /* Terminate server name */
3964 if (isdigit(*port_name))
3967 port = Ustrtol(port_name, &end, 0);
3968 if (end != port_name + Ustrlen(port_name))
3970 expand_string_message =
3971 string_sprintf("invalid port number %s", port_name);
3977 struct servent *service_info = getservbyname(CS port_name, "tcp");
3978 if (service_info == NULL)
3980 expand_string_message = string_sprintf("unknown port \"%s\"",
3984 port = ntohs(service_info->s_port);
3987 /* Sort out the server. */
3990 shost.address = NULL;
3994 namelen = Ustrlen(server_name);
3996 /* Anything enclosed in [] must be an IP address. */
3998 if (server_name[0] == '[' &&
3999 server_name[namelen - 1] == ']')
4001 server_name[namelen - 1] = 0;
4003 if (string_is_ip_address(server_name, NULL) == 0)
4005 expand_string_message =
4006 string_sprintf("malformed IP address \"%s\"", server_name);
4009 shost.name = shost.address = server_name;
4012 /* Otherwise check for an unadorned IP address */
4014 else if (string_is_ip_address(server_name, NULL) != 0)
4015 shost.name = shost.address = server_name;
4017 /* Otherwise lookup IP address(es) from the name */
4021 shost.name = server_name;
4022 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4023 FALSE) != HOST_FOUND)
4025 expand_string_message =
4026 string_sprintf("no IP address found for host %s", shost.name);
4031 /* Try to connect to the server - test each IP till one works */
4033 for (h = &shost; h != NULL; h = h->next)
4035 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4036 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4038 expand_string_message = string_sprintf("failed to create socket: "
4039 "%s", strerror(errno));
4043 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4052 expand_string_message = string_sprintf("failed to connect to "
4053 "socket %s: couldn't connect to any host", sub_arg[0],
4059 /* Handle a Unix domain socket */
4064 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4066 expand_string_message = string_sprintf("failed to create socket: %s",
4071 sockun.sun_family = AF_UNIX;
4072 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4075 sigalrm_seen = FALSE;
4077 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4081 expand_string_message = US "socket connect timed out";
4086 expand_string_message = string_sprintf("failed to connect to socket "
4087 "%s: %s", sub_arg[0], strerror(errno));
4092 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4094 /* Write the request string, if not empty */
4096 if (sub_arg[1][0] != 0)
4098 int len = Ustrlen(sub_arg[1]);
4099 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4101 if (write(fd, sub_arg[1], len) != len)
4103 expand_string_message = string_sprintf("request write to socket "
4104 "failed: %s", strerror(errno));
4109 /* Shut down the sending side of the socket. This helps some servers to
4110 recognise that it is their turn to do some work. Just in case some
4111 system doesn't have this function, make it conditional. */
4114 shutdown(fd, SHUT_WR);
4117 /* Now we need to read from the socket, under a timeout. The function
4118 that reads a file can be used. */
4120 f = fdopen(fd, "rb");
4121 sigalrm_seen = FALSE;
4123 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4127 /* After a timeout, we restore the pointer in the result, that is,
4128 make sure we add nothing from the socket. */
4133 expand_string_message = US "socket read timed out";
4138 /* The whole thing has worked (or we were skipping). If there is a
4139 failure string following, we need to skip it. */
4143 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
4145 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4146 while (isspace(*s)) s++;
4148 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4151 /* Come here on failure to create socket, connect socket, write to the
4152 socket, or timeout on reading. If another substring follows, expand and
4153 use it. Otherwise, those conditions give expand errors. */
4156 if (*s != '{') goto EXPAND_FAILED;
4157 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4158 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
4159 if (arg == NULL) goto EXPAND_FAILED;
4160 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4161 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4162 while (isspace(*s)) s++;
4163 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4167 /* Handle "run" to execute a program. */
4179 if ((expand_forbid & RDO_RUN) != 0)
4181 expand_string_message = US"running a command is not permitted";
4185 while (isspace(*s)) s++;
4186 if (*s != '{') goto EXPAND_FAILED_CURLY;
4187 arg = expand_string_internal(s+1, TRUE, &s, skipping);
4188 if (arg == NULL) goto EXPAND_FAILED;
4189 while (isspace(*s)) s++;
4190 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4192 if (skipping) /* Just pretend it worked when we're skipping */
4198 if (!transport_set_up_command(&argv, /* anchor for arg list */
4199 arg, /* raw command */
4200 FALSE, /* don't expand the arguments */
4201 0, /* not relevant when... */
4202 NULL, /* no transporting address */
4203 US"${run} expansion", /* for error messages */
4204 &expand_string_message)) /* where to put error message */
4209 /* Create the child process, making it a group leader. */
4211 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4215 expand_string_message =
4216 string_sprintf("couldn't create child process: %s", strerror(errno));
4220 /* Nothing is written to the standard input. */
4224 /* Wait for the process to finish, applying the timeout, and inspect its
4225 return code for serious disasters. Simple non-zero returns are passed on.
4228 if ((runrc = child_close(pid, 60)) < 0)
4232 expand_string_message = string_sprintf("command timed out");
4233 killpg(pid, SIGKILL); /* Kill the whole process group */
4236 else if (runrc == -257)
4237 expand_string_message = string_sprintf("wait() failed: %s",
4241 expand_string_message = string_sprintf("command killed by signal %d",
4247 /* Read the pipe to get the command's output into $value (which is kept
4248 in lookup_value). */
4250 f = fdopen(fd_out, "rb");
4251 lookup_value = NULL;
4252 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4256 /* Process the yes/no strings; $value may be useful in both cases */
4258 switch(process_yesno(
4259 skipping, /* were previously skipping */
4260 runrc == 0, /* success/failure indicator */
4261 lookup_value, /* value to reset for string2 */
4262 &s, /* input pointer */
4263 &yield, /* output pointer */
4264 &size, /* output size */
4265 &ptr, /* output current point */
4266 US"run")) /* condition type */
4268 case 1: goto EXPAND_FAILED; /* when all is well, the */
4269 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4275 /* Handle character translation for "tr" */
4283 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4285 case 1: goto EXPAND_FAILED_CURLY;
4287 case 3: goto EXPAND_FAILED;
4290 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4291 o2m = Ustrlen(sub[2]) - 1;
4293 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4295 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4299 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4306 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4307 expanded arguments. */
4317 int val[2] = { 0, -1 };
4320 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4321 Ensure that sub[2] is set in the ${length case. */
4324 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4327 case 1: goto EXPAND_FAILED_CURLY;
4329 case 3: goto EXPAND_FAILED;
4332 /* Juggle the arguments if there are only two of them: always move the
4333 string to the last position and make ${length{n}{str}} equivalent to
4334 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4340 if (item_type == EITEM_LENGTH)
4347 for (i = 0; i < 2; i++)
4349 if (sub[i] == NULL) continue;
4350 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4351 if (*ret != 0 || (i != 0 && val[i] < 0))
4353 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4354 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4360 (item_type == EITEM_HASH)?
4361 compute_hash(sub[2], val[0], val[1], &len) :
4362 (item_type == EITEM_NHASH)?
4363 compute_nhash(sub[2], val[0], val[1], &len) :
4364 extract_substr(sub[2], val[0], val[1], &len);
4366 if (ret == NULL) goto EXPAND_FAILED;
4367 yield = string_cat(yield, &size, &ptr, ret, len);
4371 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4372 This code originally contributed by Steve Haslam. It currently supports
4373 the use of MD5 and SHA-1 hashes.
4375 We need some workspace that is large enough to handle all the supported
4376 hash types. Use macros to set the sizes rather than be too elaborate. */
4378 #define MAX_HASHLEN 20
4379 #define MAX_HASHBLOCKLEN 64
4388 int hashlen; /* Number of octets for the hash algorithm's output */
4389 int hashblocklen; /* Number of octets the hash algorithm processes */
4391 unsigned int keylen;
4393 uschar keyhash[MAX_HASHLEN];
4394 uschar innerhash[MAX_HASHLEN];
4395 uschar finalhash[MAX_HASHLEN];
4396 uschar finalhash_hex[2*MAX_HASHLEN];
4397 uschar innerkey[MAX_HASHBLOCKLEN];
4398 uschar outerkey[MAX_HASHBLOCKLEN];
4400 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4402 case 1: goto EXPAND_FAILED_CURLY;
4404 case 3: goto EXPAND_FAILED;
4407 if (Ustrcmp(sub[0], "md5") == 0)
4410 use_base = &md5_base;
4414 else if (Ustrcmp(sub[0], "sha1") == 0)
4417 use_base = &sha1_base;
4423 expand_string_message =
4424 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4429 keylen = Ustrlen(keyptr);
4431 /* If the key is longer than the hash block length, then hash the key
4434 if (keylen > hashblocklen)
4436 chash_start(type, use_base);
4437 chash_end(type, use_base, keyptr, keylen, keyhash);
4442 /* Now make the inner and outer key values */
4444 memset(innerkey, 0x36, hashblocklen);
4445 memset(outerkey, 0x5c, hashblocklen);
4447 for (i = 0; i < keylen; i++)
4449 innerkey[i] ^= keyptr[i];
4450 outerkey[i] ^= keyptr[i];
4453 /* Now do the hashes */
4455 chash_start(type, use_base);
4456 chash_mid(type, use_base, innerkey);
4457 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4459 chash_start(type, use_base);
4460 chash_mid(type, use_base, outerkey);
4461 chash_end(type, use_base, innerhash, hashlen, finalhash);
4463 /* Encode the final hash as a hex string */
4466 for (i = 0; i < hashlen; i++)
4468 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4469 *p++ = hex_digits[finalhash[i] & 0x0f];
4472 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4473 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4475 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4480 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4481 We have to save the numerical variables and restore them afterwards. */
4486 int moffset, moffsetextra, slen;
4489 const uschar *rerror;
4492 int save_expand_nmax =
4493 save_expand_strings(save_expand_nstring, save_expand_nlength);
4495 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4497 case 1: goto EXPAND_FAILED_CURLY;
4499 case 3: goto EXPAND_FAILED;
4502 /* Compile the regular expression */
4504 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4509 expand_string_message = string_sprintf("regular expression error in "
4510 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4514 /* Now run a loop to do the substitutions as often as necessary. It ends
4515 when there are no more matches. Take care over matches of the null string;
4516 do the same thing as Perl does. */
4519 slen = Ustrlen(sub[0]);
4520 moffset = moffsetextra = 0;
4525 int ovector[3*(EXPAND_MAXN+1)];
4526 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4527 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4531 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4532 is not necessarily the end. We want to repeat the match from one
4533 character further along, but leaving the basic offset the same (for
4534 copying below). We can't be at the end of the string - that was checked
4535 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4536 finished; copy the remaining string and end the loop. */
4546 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4550 /* Match - set up for expanding the replacement. */
4552 if (n == 0) n = EXPAND_MAXN + 1;
4554 for (nn = 0; nn < n*2; nn += 2)
4556 expand_nstring[expand_nmax] = subject + ovector[nn];
4557 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4561 /* Copy the characters before the match, plus the expanded insertion. */
4563 yield = string_cat(yield, &size, &ptr, subject + moffset,
4564 ovector[0] - moffset);
4565 insert = expand_string(sub[2]);
4566 if (insert == NULL) goto EXPAND_FAILED;
4567 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4569 moffset = ovector[1];
4573 /* If we have matched an empty string, first check to see if we are at
4574 the end of the subject. If so, the loop is over. Otherwise, mimic
4575 what Perl's /g options does. This turns out to be rather cunning. First
4576 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4577 string at the same point. If this fails (picked up above) we advance to
4578 the next character. */
4580 if (ovector[0] == ovector[1])
4582 if (ovector[0] == slen) break;
4583 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4587 /* All done - restore numerical variables. */
4589 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4590 save_expand_nlength);
4594 /* Handle keyed and numbered substring extraction. If the first argument
4595 consists entirely of digits, then a numerical extraction is assumed. */
4601 int field_number = 1;
4602 BOOL field_number_set = FALSE;
4603 uschar *save_lookup_value = lookup_value;
4605 int save_expand_nmax =
4606 save_expand_strings(save_expand_nstring, save_expand_nlength);
4608 /* Read the arguments */
4610 for (i = 0; i < j; i++)
4612 while (isspace(*s)) s++;
4615 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4616 if (sub[i] == NULL) goto EXPAND_FAILED;
4617 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4619 /* After removal of leading and trailing white space, the first
4620 argument must not be empty; if it consists entirely of digits
4621 (optionally preceded by a minus sign), this is a numerical
4622 extraction, and we expect 3 arguments. */
4630 while (isspace(*p)) p++;
4634 while (len > 0 && isspace(p[len-1])) len--;
4639 expand_string_message = US"first argument of \"extract\" must "
4649 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4653 j = 3; /* Need 3 args */
4654 field_number_set = TRUE;
4658 else goto EXPAND_FAILED_CURLY;
4661 /* Extract either the numbered or the keyed substring into $value. If
4662 skipping, just pretend the extraction failed. */
4664 lookup_value = skipping? NULL : field_number_set?
4665 expand_gettokened(field_number, sub[1], sub[2]) :
4666 expand_getkeyed(sub[0], sub[1]);
4668 /* If no string follows, $value gets substituted; otherwise there can
4669 be yes/no strings, as for lookup or if. */
4671 switch(process_yesno(
4672 skipping, /* were previously skipping */
4673 lookup_value != NULL, /* success/failure indicator */
4674 save_lookup_value, /* value to reset for string2 */
4675 &s, /* input pointer */
4676 &yield, /* output pointer */
4677 &size, /* output size */
4678 &ptr, /* output current point */
4679 US"extract")) /* condition type */
4681 case 1: goto EXPAND_FAILED; /* when all is well, the */
4682 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4685 /* All done - restore numerical variables. */
4687 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4688 save_expand_nlength);
4694 /* Handle list operations */
4702 uschar outsep[2] = { '\0', '\0' };
4703 uschar *list, *expr, *temp;
4704 uschar *save_iterate_item = iterate_item;
4705 uschar *save_lookup_value = lookup_value;
4707 while (isspace(*s)) s++;
4708 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4710 list = expand_string_internal(s, TRUE, &s, skipping);
4711 if (list == NULL) goto EXPAND_FAILED;
4712 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4714 if (item_type == EITEM_REDUCE)
4716 while (isspace(*s)) s++;
4717 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4718 temp = expand_string_internal(s, TRUE, &s, skipping);
4719 if (temp == NULL) goto EXPAND_FAILED;
4720 lookup_value = temp;
4721 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4724 while (isspace(*s)) s++;
4725 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4729 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
4730 if scanning a "false" part). This allows us to find the end of the
4731 condition, because if the list is empty, we won't actually evaluate the
4732 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
4733 the normal internal expansion function. */
4735 if (item_type == EITEM_FILTER)
4737 temp = eval_condition(expr, NULL);
4738 if (temp != NULL) s = temp;
4742 temp = expand_string_internal(s, TRUE, &s, TRUE);
4747 expand_string_message = string_sprintf("%s inside \"%s\" item",
4748 expand_string_message, name);
4752 while (isspace(*s)) s++;
4755 expand_string_message = string_sprintf("missing } at end of condition "
4756 "or expression inside \"%s\"", name);
4760 while (isspace(*s)) s++;
4763 expand_string_message = string_sprintf("missing } at end of \"%s\"",
4768 /* If we are skipping, we can now just move on to the next item. When
4769 processing for real, we perform the iteration. */
4771 if (skipping) continue;
4772 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
4774 *outsep = (uschar)sep; /* Separator as a string */
4776 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
4778 if (item_type == EITEM_FILTER)
4781 if (eval_condition(expr, &condresult) == NULL)
4783 iterate_item = save_iterate_item;
4784 lookup_value = save_lookup_value;
4785 expand_string_message = string_sprintf("%s inside \"%s\" condition",
4786 expand_string_message, name);
4789 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
4790 condresult? "true":"false");
4792 temp = iterate_item; /* TRUE => include this item */
4794 continue; /* FALSE => skip this item */
4797 /* EITEM_MAP and EITEM_REDUCE */
4801 temp = expand_string_internal(expr, TRUE, NULL, skipping);
4804 iterate_item = save_iterate_item;
4805 expand_string_message = string_sprintf("%s inside \"%s\" item",
4806 expand_string_message, name);
4809 if (item_type == EITEM_REDUCE)
4811 lookup_value = temp; /* Update the value of $value */
4812 continue; /* and continue the iteration */
4816 /* We reach here for FILTER if the condition is true, always for MAP,
4817 and never for REDUCE. The value in "temp" is to be added to the output
4818 list that is being created, ensuring that any occurrences of the
4819 separator character are doubled. Unless we are dealing with the first
4820 item of the output list, add in a space if the new item begins with the
4821 separator character, or is an empty string. */
4823 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
4824 yield = string_cat(yield, &size, &ptr, US" ", 1);
4826 /* Add the string in "temp" to the output list that we are building,
4827 This is done in chunks by searching for the separator character. */
4831 size_t seglen = Ustrcspn(temp, outsep);
4832 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
4834 /* If we got to the end of the string we output one character
4835 too many; backup and end the loop. Otherwise arrange to double the
4838 if (temp[seglen] == '\0') { ptr--; break; }
4839 yield = string_cat(yield, &size, &ptr, outsep, 1);
4843 /* Output a separator after the string: we will remove the redundant
4844 final one at the end. */
4846 yield = string_cat(yield, &size, &ptr, outsep, 1);
4847 } /* End of iteration over the list loop */
4849 /* REDUCE has generated no output above: output the final value of
4852 if (item_type == EITEM_REDUCE)
4854 yield = string_cat(yield, &size, &ptr, lookup_value,
4855 Ustrlen(lookup_value));
4856 lookup_value = save_lookup_value; /* Restore $value */
4859 /* FILTER and MAP generate lists: if they have generated anything, remove
4860 the redundant final separator. Even though an empty item at the end of a
4861 list does not count, this is tidier. */
4863 else if (ptr != save_ptr) ptr--;
4865 /* Restore preserved $item */
4867 iterate_item = save_iterate_item;
4872 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4873 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4874 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4875 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4877 #define EXPAND_DLFUNC_MAX_ARGS 8
4880 #ifndef EXPAND_DLFUNC
4881 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4882 "is not included in this binary";
4885 #else /* EXPAND_DLFUNC */
4888 exim_dlfunc_t *func;
4891 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4893 if ((expand_forbid & RDO_DLFUNC) != 0)
4895 expand_string_message =
4896 US"dynamically-loaded functions are not permitted";
4900 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4903 case 1: goto EXPAND_FAILED_CURLY;
4905 case 3: goto EXPAND_FAILED;
4908 /* If skipping, we don't actually do anything */
4910 if (skipping) continue;
4912 /* Look up the dynamically loaded object handle in the tree. If it isn't
4913 found, dlopen() the file and put the handle in the tree for next time. */
4915 t = tree_search(dlobj_anchor, argv[0]);
4918 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4921 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4922 argv[0], dlerror());
4923 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4926 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4927 Ustrcpy(t->name, argv[0]);
4928 t->data.ptr = handle;
4929 (void)tree_insertnode(&dlobj_anchor, t);
4932 /* Having obtained the dynamically loaded object handle, look up the
4933 function pointer. */
4935 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4938 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4939 "%s", argv[1], argv[0], dlerror());
4940 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4944 /* Call the function and work out what to do with the result. If it
4945 returns OK, we have a replacement string; if it returns DEFER then
4946 expansion has failed in a non-forced manner; if it returns FAIL then
4947 failure was forced; if it returns ERROR or any other value there's a
4948 problem, so panic slightly. */
4951 for (argc = 0; argv[argc] != NULL; argc++);
4952 status = func(&result, argc - 2, &argv[2]);
4955 if (result == NULL) result = US"";
4956 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4961 expand_string_message = result == NULL ? US"(no message)" : result;
4962 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4963 else if(status != FAIL)
4964 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4965 argv[0], argv[1], status, expand_string_message);
4969 #endif /* EXPAND_DLFUNC */
4972 /* Control reaches here if the name is not recognized as one of the more
4973 complicated expansion items. Check for the "operator" syntax (name terminated
4974 by a colon). Some of the operators have arguments, separated by _ from the
4981 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4982 if (sub == NULL) goto EXPAND_FAILED;
4985 /* Owing to an historical mis-design, an underscore may be part of the
4986 operator name, or it may introduce arguments. We therefore first scan the
4987 table of names that contain underscores. If there is no match, we cut off
4988 the arguments and then scan the main table. */
4990 c = chop_match(name, op_table_underscore,
4991 sizeof(op_table_underscore)/sizeof(uschar *));
4995 arg = Ustrchr(name, '_');
4996 if (arg != NULL) *arg = 0;
4997 c = chop_match(name, op_table_main,
4998 sizeof(op_table_main)/sizeof(uschar *));
4999 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5000 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5003 /* If we are skipping, we don't need to perform the operation at all.
5004 This matters for operations like "mask", because the data may not be
5005 in the correct format when skipping. For example, the expression may test
5006 for the existence of $sender_host_address before trying to mask it. For
5007 other operations, doing them may not fail, but it is a waste of time. */
5009 if (skipping && c >= 0) continue;
5011 /* Otherwise, switch on the operator type */
5018 unsigned long int n = Ustrtoul(sub, &t, 10);
5021 expand_string_message = string_sprintf("argument for base62 "
5022 "operator is \"%s\", which is not a decimal number", sub);
5025 t = string_base62(n);
5026 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5030 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5036 unsigned long int n = 0;
5039 uschar *t = Ustrchr(base62_chars, *tt++);
5042 expand_string_message = string_sprintf("argument for base62d "
5043 "operator is \"%s\", which is not a base %d number", sub,
5047 n = n * BASE_62 + (t - base62_chars);
5049 (void)sprintf(CS buf, "%ld", n);
5050 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5056 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
5057 if (expanded == NULL)
5059 expand_string_message =
5060 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5061 expand_string_message);
5064 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5071 uschar *t = sub - 1;
5072 while (*(++t) != 0) { *t = tolower(*t); count++; }
5073 yield = string_cat(yield, &size, &ptr, sub, count);
5080 uschar *t = sub - 1;
5081 while (*(++t) != 0) { *t = toupper(*t); count++; }
5082 yield = string_cat(yield, &size, &ptr, sub, count);
5093 md5_end(&base, sub, Ustrlen(sub), digest);
5094 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5095 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5106 sha1_end(&base, sub, Ustrlen(sub), digest);
5107 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5108 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5112 /* Convert hex encoding to base64 encoding */
5122 for (enc = sub; *enc != 0; enc++)
5124 if (!isxdigit(*enc))
5126 expand_string_message = string_sprintf("\"%s\" is not a hex "
5135 expand_string_message = string_sprintf("\"%s\" contains an odd "
5136 "number of characters", sub);
5140 while ((c = *in++) != 0)
5142 if (isdigit(c)) c -= '0';
5143 else c = toupper(c) - 'A' + 10;
5155 enc = auth_b64encode(sub, out - sub);
5156 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5160 /* mask applies a mask to an IP address; for example the result of
5161 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5168 int mask, maskoffset;
5169 int type = string_is_ip_address(sub, &maskoffset);
5174 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5179 if (maskoffset == 0)
5181 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5186 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5188 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5190 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5195 /* Convert the address to binary integer(s) and apply the mask */
5197 sub[maskoffset] = 0;
5198 count = host_aton(sub, binary);
5199 host_mask(count, binary, mask);
5201 /* Convert to masked textual format and add to output. */
5203 yield = string_cat(yield, &size, &ptr, buffer,
5204 host_nmtoa(count, binary, mask, buffer, '.'));
5209 case EOP_LOCAL_PART:
5213 int start, end, domain;
5214 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5218 if (c != EOP_DOMAIN)
5220 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5221 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5223 else if (domain != 0)
5226 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5234 uschar outsep[2] = { ':', '\0' };
5235 uschar *address, *error;
5237 int start, end, domain; /* Not really used */
5239 while (isspace(*sub)) sub++;
5240 if (*sub == '>') { *outsep = *++sub; ++sub; }
5241 parse_allow_group = TRUE;
5245 uschar *p = parse_find_address_end(sub, FALSE);
5246 uschar saveend = *p;
5248 address = parse_extract_address(sub, &error, &start, &end, &domain,
5252 /* Add the address to the output list that we are building. This is
5253 done in chunks by searching for the separator character. At the
5254 start, unless we are dealing with the first address of the output
5255 list, add in a space if the new address begins with the separator
5256 character, or is an empty string. */
5258 if (address != NULL)
5260 if (ptr != save_ptr && address[0] == *outsep)
5261 yield = string_cat(yield, &size, &ptr, US" ", 1);
5265 size_t seglen = Ustrcspn(address, outsep);
5266 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5268 /* If we got to the end of the string we output one character
5271 if (address[seglen] == '\0') { ptr--; break; }
5272 yield = string_cat(yield, &size, &ptr, outsep, 1);
5273 address += seglen + 1;
5276 /* Output a separator after the string: we will remove the
5277 redundant final one at the end. */
5279 yield = string_cat(yield, &size, &ptr, outsep, 1);
5282 if (saveend == '\0') break;
5286 /* If we have generated anything, remove the redundant final
5289 if (ptr != save_ptr) ptr--;
5290 parse_allow_group = FALSE;
5295 /* quote puts a string in quotes if it is empty or contains anything
5296 other than alphamerics, underscore, dot, or hyphen.
5298 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5299 be quoted in order to be a valid local part.
5301 In both cases, newlines and carriage returns are converted into \n and \r
5305 case EOP_QUOTE_LOCAL_PART:
5308 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5309 uschar *t = sub - 1;
5313 while (!needs_quote && *(++t) != 0)
5314 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5316 else /* EOP_QUOTE_LOCAL_PART */
5318 while (!needs_quote && *(++t) != 0)
5319 needs_quote = !isalnum(*t) &&
5320 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5321 (*t != '.' || t == sub || t[1] == 0);
5326 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5331 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5332 else if (*t == '\r')
5333 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5336 if (*t == '\\' || *t == '"')
5337 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5338 yield = string_cat(yield, &size, &ptr, t, 1);
5341 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5343 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5347 /* quote_lookuptype does lookup-specific quoting */
5352 uschar *opt = Ustrchr(arg, '_');
5354 if (opt != NULL) *opt++ = 0;
5356 n = search_findtype(arg, Ustrlen(arg));
5359 expand_string_message = search_error_message;
5363 if (lookup_list[n].quote != NULL)
5364 sub = (lookup_list[n].quote)(sub, opt);
5365 else if (opt != NULL) sub = NULL;
5369 expand_string_message = string_sprintf(
5370 "\"%s\" unrecognized after \"${quote_%s\"",
5375 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5379 /* rx quote sticks in \ before any non-alphameric character so that
5380 the insertion works in a regular expression. */
5384 uschar *t = sub - 1;
5388 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5389 yield = string_cat(yield, &size, &ptr, t, 1);
5394 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5395 prescribed by the RFC, if there are characters that need to be encoded */
5399 uschar buffer[2048];
5400 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5401 buffer, sizeof(buffer), FALSE);
5402 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5406 /* RFC 2047 decode */
5412 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5413 headers_charset, '?', &len, &error);
5416 expand_string_message = error;
5419 yield = string_cat(yield, &size, &ptr, decoded, len);
5423 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5433 if (c > 255) c = '_';
5435 yield = string_cat(yield, &size, &ptr, buff, 1);
5440 /* escape turns all non-printing characters into escape sequences. */
5444 uschar *t = string_printing(sub);
5445 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5449 /* Handle numeric expression evaluation */
5454 uschar *save_sub = sub;
5455 uschar *error = NULL;
5456 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5459 expand_string_message = string_sprintf("error in expression "
5460 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5464 sprintf(CS var_buffer, "%d", n);
5465 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5469 /* Handle time period formating */
5473 int n = readconf_readtime(sub, 0, FALSE);
5476 expand_string_message = string_sprintf("string \"%s\" is not an "
5477 "Exim time interval in \"%s\" operator", sub, name);
5480 sprintf(CS var_buffer, "%d", n);
5481 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5485 case EOP_TIME_INTERVAL:
5488 uschar *t = read_number(&n, sub);
5489 if (*t != 0) /* Not A Number*/
5491 expand_string_message = string_sprintf("string \"%s\" is not a "
5492 "positive number in \"%s\" operator", sub, name);
5495 t = readconf_printtime(n);
5496 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5500 /* Convert string to base64 encoding */
5504 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5505 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5509 /* strlen returns the length of the string */
5514 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5515 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5519 /* length_n or l_n takes just the first n characters or the whole string,
5520 whichever is the shorter;
5522 substr_m_n, and s_m_n take n characters from offset m; negative m take
5523 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5524 takes the rest, either to the right or to the left.
5526 hash_n or h_n makes a hash of length n from the string, yielding n
5527 characters from the set a-z; hash_n_m makes a hash of length n, but
5528 uses m characters from the set a-zA-Z0-9.
5530 nhash_n returns a single number between 0 and n-1 (in text form), while
5531 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5532 between 0 and n-1 and the second between 0 and m-1. */
5552 expand_string_message = string_sprintf("missing values after %s",
5557 /* "length" has only one argument, effectively being synonymous with
5560 if (c == EOP_LENGTH || c == EOP_L)
5566 /* The others have one or two arguments; for "substr" the first may be
5567 negative. The second being negative means "not supplied". */
5572 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5575 /* Read up to two numbers, separated by underscores */
5580 if (arg != ret && *arg == '_' && pn == &value1)
5584 if (arg[1] != 0) arg++;
5586 else if (!isdigit(*arg))
5588 expand_string_message =
5589 string_sprintf("non-digit after underscore in \"%s\"", name);
5592 else *pn = (*pn)*10 + *arg++ - '0';
5596 /* Perform the required operation */
5599 (c == EOP_HASH || c == EOP_H)?
5600 compute_hash(sub, value1, value2, &len) :
5601 (c == EOP_NHASH || c == EOP_NH)?
5602 compute_nhash(sub, value1, value2, &len) :
5603 extract_substr(sub, value1, value2, &len);
5605 if (ret == NULL) goto EXPAND_FAILED;
5606 yield = string_cat(yield, &size, &ptr, ret, len);
5616 uschar **modetable[3];
5621 if ((expand_forbid & RDO_EXISTS) != 0)
5623 expand_string_message = US"Use of the stat() expansion is not permitted";
5627 if (stat(CS sub, &st) < 0)
5629 expand_string_message = string_sprintf("stat(%s) failed: %s",
5630 sub, strerror(errno));
5634 switch (mode & S_IFMT)
5636 case S_IFIFO: smode[0] = 'p'; break;
5637 case S_IFCHR: smode[0] = 'c'; break;
5638 case S_IFDIR: smode[0] = 'd'; break;
5639 case S_IFBLK: smode[0] = 'b'; break;
5640 case S_IFREG: smode[0] = '-'; break;
5641 default: smode[0] = '?'; break;
5644 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5645 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5646 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5648 for (i = 0; i < 3; i++)
5650 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5655 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5656 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5657 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5658 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5659 (long)st.st_gid, st.st_size, (long)st.st_atime,
5660 (long)st.st_mtime, (long)st.st_ctime);
5661 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5665 /* Unknown operator */
5668 expand_string_message =
5669 string_sprintf("unknown expansion operator \"%s\"", name);
5674 /* Handle a plain name. If this is the first thing in the expansion, release
5675 the pre-allocated buffer. If the result data is known to be in a new buffer,
5676 newsize will be set to the size of that buffer, and we can just point at that
5677 store instead of copying. Many expansion strings contain just one reference,
5678 so this is a useful optimization, especially for humungous headers
5679 ($message_headers). */
5691 value = find_variable(name, FALSE, skipping, &newsize);
5694 expand_string_message =
5695 string_sprintf("unknown variable in \"${%s}\"", name);
5696 check_variable_error_message(name);
5699 len = Ustrlen(value);
5700 if (yield == NULL && newsize != 0)
5706 else yield = string_cat(yield, &size, &ptr, value, len);
5710 /* Else there's something wrong */
5712 expand_string_message =
5713 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5714 "in a variable reference)", name);
5718 /* If we hit the end of the string when ket_ends is set, there is a missing
5719 terminating brace. */
5721 if (ket_ends && *s == 0)
5723 expand_string_message = malformed_header?
5724 US"missing } at end of string - could be header name not terminated by colon"
5726 US"missing } at end of string";
5730 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5731 added to the string. If so, set up an empty string. Add a terminating zero. If
5732 left != NULL, return a pointer to the terminator. */
5734 if (yield == NULL) yield = store_get(1);
5736 if (left != NULL) *left = s;
5738 /* Any stacking store that was used above the final string is no longer needed.
5739 In many cases the final string will be the first one that was got and so there
5740 will be optimal store usage. */
5742 store_reset(yield + ptr + 1);
5745 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5747 if (skipping) debug_printf("skipping: result is not used\n");
5751 /* This is the failure exit: easiest to program with a goto. We still need
5752 to update the pointer to the terminator, for cases of nested calls with "fail".
5755 EXPAND_FAILED_CURLY:
5756 expand_string_message = malformed_header?
5757 US"missing or misplaced { or } - could be header name not terminated by colon"
5759 US"missing or misplaced { or }";
5761 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5762 that is a bad idea, because expand_string_message is in dynamic store. */
5765 if (left != NULL) *left = s;
5768 debug_printf("failed to expand: %s\n", string);
5769 debug_printf(" error message: %s\n", expand_string_message);
5770 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5776 /* This is the external function call. Do a quick check for any expansion
5777 metacharacters, and if there are none, just return the input string.
5779 Argument: the string to be expanded
5780 Returns: the expanded string, or NULL if expansion failed; if failure was
5781 due to a lookup deferring, search_find_defer will be TRUE
5785 expand_string(uschar *string)
5787 search_find_defer = FALSE;
5788 malformed_header = FALSE;
5789 return (Ustrpbrk(string, "$\\") == NULL)? string :
5790 expand_string_internal(string, FALSE, NULL, FALSE);
5795 /*************************************************
5797 *************************************************/
5799 /* Now and again we want to expand a string and be sure that the result is in a
5800 new bit of store. This function does that.
5802 Argument: the string to be expanded
5803 Returns: the expanded string, always in a new bit of store, or NULL
5807 expand_string_copy(uschar *string)
5809 uschar *yield = expand_string(string);
5810 if (yield == string) yield = string_copy(string);
5816 /*************************************************
5817 * Expand and interpret as an integer *
5818 *************************************************/
5820 /* Expand a string, and convert the result into an integer.
5823 string the string to be expanded
5824 isplus TRUE if a non-negative number is expected
5826 Returns: the integer value, or
5827 -1 for an expansion error ) in both cases, message in
5828 -2 for an integer interpretation error ) expand_string_message
5829 expand_string_message is set NULL for an OK integer
5833 expand_string_integer(uschar *string, BOOL isplus)
5836 uschar *s = expand_string(string);
5837 uschar *msg = US"invalid integer \"%s\"";
5840 /* If expansion failed, expand_string_message will be set. */
5842 if (s == NULL) return -1;
5844 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5845 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5846 systems, so we set it zero ourselves. */
5849 expand_string_message = NULL; /* Indicates no error */
5850 value = strtol(CS s, CSS &endptr, 10);
5854 msg = US"integer expected but \"%s\" found";
5856 else if (value < 0 && isplus)
5858 msg = US"non-negative integer expected but \"%s\" found";
5862 /* Ensure we can cast this down to an int */
5863 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5865 if (errno != ERANGE)
5867 if (tolower(*endptr) == 'k')
5869 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5873 else if (tolower(*endptr) == 'm')
5875 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5877 else value *= 1024*1024;
5881 if (errno == ERANGE)
5882 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5885 while (isspace(*endptr)) endptr++;
5886 if (*endptr == 0) return (int)value;
5890 expand_string_message = string_sprintf(CS msg, s);
5895 /*************************************************
5896 **************************************************
5897 * Stand-alone test program *
5898 **************************************************
5899 *************************************************/
5905 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5907 int ovector[3*(EXPAND_MAXN+1)];
5908 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5909 ovector, sizeof(ovector)/sizeof(int));
5910 BOOL yield = n >= 0;
5911 if (n == 0) n = EXPAND_MAXN + 1;
5915 expand_nmax = (setup < 0)? 0 : setup + 1;
5916 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5918 expand_nstring[expand_nmax] = subject + ovector[nn];
5919 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5927 int main(int argc, uschar **argv)
5930 uschar buffer[1024];
5932 debug_selector = D_v;
5933 debug_file = stderr;
5934 debug_fd = fileno(debug_file);
5935 big_buffer = malloc(big_buffer_size);
5937 for (i = 1; i < argc; i++)
5939 if (argv[i][0] == '+')
5941 debug_trace_memory = 2;
5944 if (isdigit(argv[i][0]))
5945 debug_selector = Ustrtol(argv[i], NULL, 0);
5947 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5951 eldap_default_servers = argv[i];
5954 mysql_servers = argv[i];
5957 pgsql_servers = argv[i];
5961 else opt_perl_startup = argv[i];
5965 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5967 expand_nstring[1] = US"string 1....";
5968 expand_nlength[1] = 8;
5972 if (opt_perl_startup != NULL)
5975 printf("Starting Perl interpreter\n");
5976 errstr = init_perl(opt_perl_startup);
5979 printf("** error in perl_startup code: %s\n", errstr);
5980 return EXIT_FAILURE;
5983 #endif /* EXIM_PERL */
5985 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5987 void *reset_point = store_get(0);
5988 uschar *yield = expand_string(buffer);
5991 printf("%s\n", yield);
5992 store_reset(reset_point);
5996 if (search_find_defer) printf("search_find deferred\n");
5997 printf("Failed: %s\n", expand_string_message);
5998 if (expand_string_forcedfail) printf("Forced failure\n");
6010 /* End of expand.c */