1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, BOOL);
19 #ifndef SUPPORT_CRYPTEQ
20 #define SUPPORT_CRYPTEQ
25 #include "lookups/ldap.h"
28 #ifdef SUPPORT_CRYPTEQ
33 extern char* crypt16(char*, char*);
37 /* The handling of crypt16() is a mess. I will record below the analysis of the
38 mess that was sent to me. We decided, however, to make changing this very low
39 priority, because in practice people are moving away from the crypt()
40 algorithms nowadays, so it doesn't seem worth it.
43 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
44 the first 8 characters of the password using a 20-round version of crypt
45 (standard crypt does 25 rounds). It then crypts the next 8 characters,
46 or an empty block if the password is less than 9 characters, using a
47 20-round version of crypt and the same salt as was used for the first
48 block. Charaters after the first 16 are ignored. It always generates
49 a 16-byte hash, which is expressed together with the salt as a string
50 of 24 base 64 digits. Here are some links to peruse:
52 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
53 http://seclists.org/bugtraq/1999/Mar/0076.html
55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
56 and OSF/1. This is the same as the standard crypt if given a password
57 of 8 characters or less. If given more, it first does the same as crypt
58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
59 using as salt the first two base 64 digits from the first hash block.
60 If the password is more than 16 characters then it crypts the 17th to 24th
61 characters using as salt the first two base 64 digits from the second hash
62 block. And so on: I've seen references to it cutting off the password at
63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0109.html
67 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
68 TET1_html/sec.c222.html#no_id_208
70 Exim has something it calls "crypt16". It will either use a native
71 crypt16 or its own implementation. A native crypt16 will presumably
72 be the one that I called "crypt16" above. The internal "crypt16"
73 function, however, is a two-block-maximum implementation of what I called
74 "bigcrypt". The documentation matches the internal code.
76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
77 that crypt16 and bigcrypt were different things.
79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
80 to whatever it is using under that name. This unfortunately sets a
81 precedent for using "{crypt16}" to identify two incompatible algorithms
82 whose output can't be distinguished. With "{crypt16}" thus rendered
83 ambiguous, I suggest you deprecate it and invent two new identifiers
84 for the two algorithms.
86 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
87 of the password separately means they can be cracked separately, so
88 the double-length hash only doubles the cracking effort instead of
89 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
148 /* Tables of operator names, and corresponding switch numbers. The names must be
149 in alphabetical order. There are two tables, because underscore is used in some
150 cases to introduce arguments, whereas for other it is part of the name. This is
151 an historical mis-design. */
153 static uschar *op_table_underscore[] = {
156 US"quote_local_part",
164 EOP_QUOTE_LOCAL_PART,
169 static uschar *op_table_main[] = {
203 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
236 /* Table of condition names, and corresponding switch numbers. The names must
237 be in alphabetical order. */
239 static uschar *cond_table[] = {
243 US"==", /* Backward compatibility */
275 US"match_local_part",
299 ECOND_FIRST_DELIVERY,
320 ECOND_MATCH_LOCAL_PART,
330 /* Type for main variable table */
338 /* Type for entries pointing to address/length pairs. Not currently
346 /* Types of table entry */
349 vtype_int, /* value is address of int */
350 vtype_filter_int, /* ditto, but recognized only when filtering */
351 vtype_ino, /* value is address of ino_t (not always an int) */
352 vtype_uid, /* value is address of uid_t (not always an int) */
353 vtype_gid, /* value is address of gid_t (not always an int) */
354 vtype_stringptr, /* value is address of pointer to string */
355 vtype_msgbody, /* as stringptr, but read when first required */
356 vtype_msgbody_end, /* ditto, the end of the message */
357 vtype_msgheaders, /* the message's headers, processed */
358 vtype_msgheaders_raw, /* the message's headers, unprocessed */
359 vtype_localpart, /* extract local part from string */
360 vtype_domain, /* extract domain from string */
361 vtype_recipients, /* extract recipients from recipients list */
362 /* (available only in system filters, ACLs, and */
364 vtype_todbsdin, /* value not used; generate BSD inbox tod */
365 vtype_tode, /* value not used; generate tod in epoch format */
366 vtype_todf, /* value not used; generate full tod */
367 vtype_todl, /* value not used; generate log tod */
368 vtype_todlf, /* value not used; generate log file datestamp tod */
369 vtype_todzone, /* value not used; generate time zone only */
370 vtype_todzulu, /* value not used; generate zulu tod */
371 vtype_reply, /* value not used; get reply from headers */
372 vtype_pid, /* value not used; result is pid */
373 vtype_host_lookup, /* value not used; get host name */
374 vtype_load_avg, /* value not used; result is int from os_getloadavg */
375 vtype_pspace, /* partition space; value is T/F for spool/log */
376 vtype_pinodes /* partition inodes; value is T/F for spool/log */
378 ,vtype_dkim /* Lookup of value in DKIM signature */
382 /* This table must be kept in alphabetical order. */
384 static var_entry var_table[] = {
385 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
386 they will be confused with user-creatable ACL variables. */
387 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
388 { "address_data", vtype_stringptr, &deliver_address_data },
389 { "address_file", vtype_stringptr, &address_file },
390 { "address_pipe", vtype_stringptr, &address_pipe },
391 { "authenticated_id", vtype_stringptr, &authenticated_id },
392 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
393 { "authentication_failed",vtype_int, &authentication_failed },
394 #ifdef WITH_CONTENT_SCAN
395 { "av_failed", vtype_int, &av_failed },
397 #ifdef EXPERIMENTAL_BRIGHTMAIL
398 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
399 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
400 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
401 { "bmi_deliver", vtype_int, &bmi_deliver },
403 { "body_linecount", vtype_int, &body_linecount },
404 { "body_zerocount", vtype_int, &body_zerocount },
405 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
406 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
407 { "caller_gid", vtype_gid, &real_gid },
408 { "caller_uid", vtype_uid, &real_uid },
409 { "compile_date", vtype_stringptr, &version_date },
410 { "compile_number", vtype_stringptr, &version_cnumber },
411 { "csa_status", vtype_stringptr, &csa_status },
412 #ifdef EXPERIMENTAL_DCC
413 { "dcc_header", vtype_stringptr, &dcc_header },
414 { "dcc_result", vtype_stringptr, &dcc_result },
416 #ifdef WITH_OLD_DEMIME
417 { "demime_errorlevel", vtype_int, &demime_errorlevel },
418 { "demime_reason", vtype_stringptr, &demime_reason },
421 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
422 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
423 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
424 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
425 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
426 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
427 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
428 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
429 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
430 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
431 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
432 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
433 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
434 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
435 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
436 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
437 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
438 { "dkim_signers", vtype_stringptr, &dkim_signers },
439 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
440 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
442 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
443 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
444 { "dnslist_text", vtype_stringptr, &dnslist_text },
445 { "dnslist_value", vtype_stringptr, &dnslist_value },
446 { "domain", vtype_stringptr, &deliver_domain },
447 { "domain_data", vtype_stringptr, &deliver_domain_data },
448 { "exim_gid", vtype_gid, &exim_gid },
449 { "exim_path", vtype_stringptr, &exim_path },
450 { "exim_uid", vtype_uid, &exim_uid },
451 #ifdef WITH_OLD_DEMIME
452 { "found_extension", vtype_stringptr, &found_extension },
454 { "home", vtype_stringptr, &deliver_home },
455 { "host", vtype_stringptr, &deliver_host },
456 { "host_address", vtype_stringptr, &deliver_host_address },
457 { "host_data", vtype_stringptr, &host_data },
458 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
459 { "host_lookup_failed", vtype_int, &host_lookup_failed },
460 { "inode", vtype_ino, &deliver_inode },
461 { "interface_address", vtype_stringptr, &interface_address },
462 { "interface_port", vtype_int, &interface_port },
463 { "item", vtype_stringptr, &iterate_item },
465 { "ldap_dn", vtype_stringptr, &eldap_dn },
467 { "load_average", vtype_load_avg, NULL },
468 { "local_part", vtype_stringptr, &deliver_localpart },
469 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
470 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
471 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
472 { "local_scan_data", vtype_stringptr, &local_scan_data },
473 { "local_user_gid", vtype_gid, &local_user_gid },
474 { "local_user_uid", vtype_uid, &local_user_uid },
475 { "localhost_number", vtype_int, &host_number },
476 { "log_inodes", vtype_pinodes, (void *)FALSE },
477 { "log_space", vtype_pspace, (void *)FALSE },
478 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
479 #ifdef WITH_CONTENT_SCAN
480 { "malware_name", vtype_stringptr, &malware_name },
482 { "max_received_linelength", vtype_int, &max_received_linelength },
483 { "message_age", vtype_int, &message_age },
484 { "message_body", vtype_msgbody, &message_body },
485 { "message_body_end", vtype_msgbody_end, &message_body_end },
486 { "message_body_size", vtype_int, &message_body_size },
487 { "message_exim_id", vtype_stringptr, &message_id },
488 { "message_headers", vtype_msgheaders, NULL },
489 { "message_headers_raw", vtype_msgheaders_raw, NULL },
490 { "message_id", vtype_stringptr, &message_id },
491 { "message_linecount", vtype_int, &message_linecount },
492 { "message_size", vtype_int, &message_size },
493 #ifdef WITH_CONTENT_SCAN
494 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
495 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
496 { "mime_boundary", vtype_stringptr, &mime_boundary },
497 { "mime_charset", vtype_stringptr, &mime_charset },
498 { "mime_content_description", vtype_stringptr, &mime_content_description },
499 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
500 { "mime_content_id", vtype_stringptr, &mime_content_id },
501 { "mime_content_size", vtype_int, &mime_content_size },
502 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
503 { "mime_content_type", vtype_stringptr, &mime_content_type },
504 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
505 { "mime_filename", vtype_stringptr, &mime_filename },
506 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
507 { "mime_is_multipart", vtype_int, &mime_is_multipart },
508 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
509 { "mime_part_count", vtype_int, &mime_part_count },
511 { "n0", vtype_filter_int, &filter_n[0] },
512 { "n1", vtype_filter_int, &filter_n[1] },
513 { "n2", vtype_filter_int, &filter_n[2] },
514 { "n3", vtype_filter_int, &filter_n[3] },
515 { "n4", vtype_filter_int, &filter_n[4] },
516 { "n5", vtype_filter_int, &filter_n[5] },
517 { "n6", vtype_filter_int, &filter_n[6] },
518 { "n7", vtype_filter_int, &filter_n[7] },
519 { "n8", vtype_filter_int, &filter_n[8] },
520 { "n9", vtype_filter_int, &filter_n[9] },
521 { "original_domain", vtype_stringptr, &deliver_domain_orig },
522 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
523 { "originator_gid", vtype_gid, &originator_gid },
524 { "originator_uid", vtype_uid, &originator_uid },
525 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
526 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
527 { "pid", vtype_pid, NULL },
528 { "primary_hostname", vtype_stringptr, &primary_hostname },
529 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
530 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
531 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
532 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
533 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
534 { "rcpt_count", vtype_int, &rcpt_count },
535 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
536 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
537 { "received_count", vtype_int, &received_count },
538 { "received_for", vtype_stringptr, &received_for },
539 { "received_ip_address", vtype_stringptr, &interface_address },
540 { "received_port", vtype_int, &interface_port },
541 { "received_protocol", vtype_stringptr, &received_protocol },
542 { "received_time", vtype_int, &received_time },
543 { "recipient_data", vtype_stringptr, &recipient_data },
544 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
545 { "recipients", vtype_recipients, NULL },
546 { "recipients_count", vtype_int, &recipients_count },
547 #ifdef WITH_CONTENT_SCAN
548 { "regex_match_string", vtype_stringptr, ®ex_match_string },
550 { "reply_address", vtype_reply, NULL },
551 { "return_path", vtype_stringptr, &return_path },
552 { "return_size_limit", vtype_int, &bounce_return_size_limit },
553 { "runrc", vtype_int, &runrc },
554 { "self_hostname", vtype_stringptr, &self_hostname },
555 { "sender_address", vtype_stringptr, &sender_address },
556 { "sender_address_data", vtype_stringptr, &sender_address_data },
557 { "sender_address_domain", vtype_domain, &sender_address },
558 { "sender_address_local_part", vtype_localpart, &sender_address },
559 { "sender_data", vtype_stringptr, &sender_data },
560 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
561 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
562 { "sender_host_address", vtype_stringptr, &sender_host_address },
563 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
564 { "sender_host_name", vtype_host_lookup, NULL },
565 { "sender_host_port", vtype_int, &sender_host_port },
566 { "sender_ident", vtype_stringptr, &sender_ident },
567 { "sender_rate", vtype_stringptr, &sender_rate },
568 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
569 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
570 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
571 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
572 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
573 { "sending_port", vtype_int, &sending_port },
574 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
575 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
576 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
577 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
578 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
579 { "sn0", vtype_filter_int, &filter_sn[0] },
580 { "sn1", vtype_filter_int, &filter_sn[1] },
581 { "sn2", vtype_filter_int, &filter_sn[2] },
582 { "sn3", vtype_filter_int, &filter_sn[3] },
583 { "sn4", vtype_filter_int, &filter_sn[4] },
584 { "sn5", vtype_filter_int, &filter_sn[5] },
585 { "sn6", vtype_filter_int, &filter_sn[6] },
586 { "sn7", vtype_filter_int, &filter_sn[7] },
587 { "sn8", vtype_filter_int, &filter_sn[8] },
588 { "sn9", vtype_filter_int, &filter_sn[9] },
589 #ifdef WITH_CONTENT_SCAN
590 { "spam_bar", vtype_stringptr, &spam_bar },
591 { "spam_report", vtype_stringptr, &spam_report },
592 { "spam_score", vtype_stringptr, &spam_score },
593 { "spam_score_int", vtype_stringptr, &spam_score_int },
595 #ifdef EXPERIMENTAL_SPF
596 { "spf_guess", vtype_stringptr, &spf_guess },
597 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
598 { "spf_received", vtype_stringptr, &spf_received },
599 { "spf_result", vtype_stringptr, &spf_result },
600 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
602 { "spool_directory", vtype_stringptr, &spool_directory },
603 { "spool_inodes", vtype_pinodes, (void *)TRUE },
604 { "spool_space", vtype_pspace, (void *)TRUE },
605 #ifdef EXPERIMENTAL_SRS
606 { "srs_db_address", vtype_stringptr, &srs_db_address },
607 { "srs_db_key", vtype_stringptr, &srs_db_key },
608 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
609 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
610 { "srs_recipient", vtype_stringptr, &srs_recipient },
611 { "srs_status", vtype_stringptr, &srs_status },
613 { "thisaddress", vtype_stringptr, &filter_thisaddress },
614 { "tls_bits", vtype_int, &tls_bits },
615 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
616 { "tls_cipher", vtype_stringptr, &tls_cipher },
617 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
618 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
619 { "tls_sni", vtype_stringptr, &tls_sni },
621 { "tod_bsdinbox", vtype_todbsdin, NULL },
622 { "tod_epoch", vtype_tode, NULL },
623 { "tod_full", vtype_todf, NULL },
624 { "tod_log", vtype_todl, NULL },
625 { "tod_logfile", vtype_todlf, NULL },
626 { "tod_zone", vtype_todzone, NULL },
627 { "tod_zulu", vtype_todzulu, NULL },
628 { "value", vtype_stringptr, &lookup_value },
629 { "version_number", vtype_stringptr, &version_string },
630 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
631 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
632 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
633 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
634 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
635 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
638 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
639 static uschar var_buffer[256];
640 static BOOL malformed_header;
642 /* For textual hashes */
644 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
645 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
648 enum { HMAC_MD5, HMAC_SHA1 };
650 /* For numeric hashes */
652 static unsigned int prime[] = {
653 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
654 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
655 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
657 /* For printing modes in symbolic form */
659 static uschar *mtable_normal[] =
660 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
662 static uschar *mtable_setid[] =
663 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
665 static uschar *mtable_sticky[] =
666 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
670 /*************************************************
671 * Tables for UTF-8 support *
672 *************************************************/
674 /* Table of the number of extra characters, indexed by the first character
675 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
678 static uschar utf8_table1[] = {
679 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
680 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
681 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
682 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
684 /* These are the masks for the data bits in the first byte of a character,
685 indexed by the number of additional bytes. */
687 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
689 /* Get the next UTF-8 character, advancing the pointer. */
691 #define GETUTF8INC(c, ptr) \
693 if ((c & 0xc0) == 0xc0) \
695 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
697 c = (c & utf8_table2[a]) << s; \
701 c |= (*ptr++ & 0x3f) << s; \
706 /*************************************************
707 * Binary chop search on a table *
708 *************************************************/
710 /* This is used for matching expansion items and operators.
713 name the name that is being sought
714 table the table to search
715 table_size the number of items in the table
717 Returns: the offset in the table, or -1
721 chop_match(uschar *name, uschar **table, int table_size)
723 uschar **bot = table;
724 uschar **top = table + table_size;
728 uschar **mid = bot + (top - bot)/2;
729 int c = Ustrcmp(name, *mid);
730 if (c == 0) return mid - table;
731 if (c > 0) bot = mid + 1; else top = mid;
739 /*************************************************
740 * Check a condition string *
741 *************************************************/
743 /* This function is called to expand a string, and test the result for a "true"
744 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
745 forced fail or lookup defer. All store used by the function can be released on
748 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
751 condition the condition string
752 m1 text to be incorporated in panic error
755 Returns: TRUE if condition is met, FALSE if not
759 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
762 void *reset_point = store_get(0);
763 uschar *ss = expand_string(condition);
766 if (!expand_string_forcedfail && !search_find_defer)
767 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
768 "for %s %s: %s", condition, m1, m2, expand_string_message);
771 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
772 strcmpic(ss, US"false") != 0;
773 store_reset(reset_point);
779 /*************************************************
780 * Pseudo-random number generation *
781 *************************************************/
783 /* Pseudo-random number generation. The result is not "expected" to be
784 cryptographically strong but not so weak that someone will shoot themselves
785 in the foot using it as a nonce in some email header scheme or whatever
786 weirdness they'll twist this into. The result should ideally handle fork().
788 However, if we're stuck unable to provide this, then we'll fall back to
789 appallingly bad randomness.
791 If SUPPORT_TLS is defined and OpenSSL is used, then this will not be used.
792 The GNUTLS randomness functions found do not seem amenable to extracting
793 random numbers outside of a TLS context. Any volunteers?
797 Returns a random number in range [0, max-1]
800 #if !defined(SUPPORT_TLS) || defined(USE_GNUTLS)
802 pseudo_random_number(int max)
804 static pid_t pid = 0;
806 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
816 #ifdef HAVE_ARC4RANDOM
817 /* cryptographically strong randomness, common on *BSD platforms, not
818 so much elsewhere. Alas. */
820 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
821 #ifdef HAVE_SRANDOMDEV
822 /* uses random(4) for seeding */
825 gettimeofday(&tv, NULL);
826 srandom(tv.tv_sec | tv.tv_usec | getpid());
829 /* Poor randomness and no seeding here */
836 #ifdef HAVE_ARC4RANDOM
837 return arc4random() % max;
838 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
839 return random() % max;
841 /* This one returns a 16-bit number, definitely not crypto-strong */
842 return random_number(max);
848 /*************************************************
849 * Pick out a name from a string *
850 *************************************************/
852 /* If the name is too long, it is silently truncated.
855 name points to a buffer into which to put the name
856 max is the length of the buffer
857 s points to the first alphabetic character of the name
858 extras chars other than alphanumerics to permit
860 Returns: pointer to the first character after the name
862 Note: The test for *s != 0 in the while loop is necessary because
863 Ustrchr() yields non-NULL if the character is zero (which is not something
867 read_name(uschar *name, int max, uschar *s, uschar *extras)
870 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
872 if (ptr < max-1) name[ptr++] = *s;
881 /*************************************************
882 * Pick out the rest of a header name *
883 *************************************************/
885 /* A variable name starting $header_ (or just $h_ for those who like
886 abbreviations) might not be the complete header name because headers can
887 contain any printing characters in their names, except ':'. This function is
888 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
889 on the end, if the name was terminated by white space.
892 name points to a buffer in which the name read so far exists
893 max is the length of the buffer
894 s points to the first character after the name so far, i.e. the
895 first non-alphameric character after $header_xxxxx
897 Returns: a pointer to the first character after the header name
901 read_header_name(uschar *name, int max, uschar *s)
903 int prelen = Ustrchr(name, '_') - name + 1;
904 int ptr = Ustrlen(name) - prelen;
905 if (ptr > 0) memmove(name, name+prelen, ptr);
906 while (mac_isgraph(*s) && *s != ':')
908 if (ptr < max-1) name[ptr++] = *s;
919 /*************************************************
920 * Pick out a number from a string *
921 *************************************************/
924 n points to an integer into which to put the number
925 s points to the first digit of the number
927 Returns: a pointer to the character after the last digit
931 read_number(int *n, uschar *s)
934 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
940 /*************************************************
941 * Extract keyed subfield from a string *
942 *************************************************/
944 /* The yield is in dynamic store; NULL means that the key was not found.
947 key points to the name of the key
948 s points to the string from which to extract the subfield
950 Returns: NULL if the subfield was not found, or
951 a pointer to the subfield's data
955 expand_getkeyed(uschar *key, uschar *s)
957 int length = Ustrlen(key);
958 while (isspace(*s)) s++;
960 /* Loop to search for the key */
968 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
969 dkeylength = s - dkey;
970 while (isspace(*s)) s++;
971 if (*s == '=') while (isspace((*(++s))));
973 data = string_dequote(&s);
974 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
977 while (isspace(*s)) s++;
986 /*************************************************
987 * Extract numbered subfield from string *
988 *************************************************/
990 /* Extracts a numbered field from a string that is divided by tokens - for
991 example a line from /etc/passwd is divided by colon characters. First field is
992 numbered one. Negative arguments count from the right. Zero returns the whole
993 string. Returns NULL if there are insufficient tokens in the string
996 Modifies final argument - this is a dynamically generated string, so that's OK.
999 field number of field to be extracted,
1000 first field = 1, whole string = 0, last field = -1
1001 separators characters that are used to break string into tokens
1002 s points to the string from which to extract the subfield
1004 Returns: NULL if the field was not found,
1005 a pointer to the field's data inside s (modified to add 0)
1009 expand_gettokened (int field, uschar *separators, uschar *s)
1014 uschar *fieldtext = NULL;
1016 if (field == 0) return s;
1018 /* Break the line up into fields in place; for field > 0 we stop when we have
1019 done the number of fields we want. For field < 0 we continue till the end of
1020 the string, counting the number of fields. */
1022 count = (field > 0)? field : INT_MAX;
1028 /* Previous field was the last one in the string. For a positive field
1029 number, this means there are not enough fields. For a negative field number,
1030 check that there are enough, and scan back to find the one that is wanted. */
1034 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1035 if ((-field) == (INT_MAX - count - 1)) return s;
1039 while (ss[-1] != 0) ss--;
1045 /* Previous field was not last in the string; save its start and put a
1049 len = Ustrcspn(ss, separators);
1060 /*************************************************
1061 * Extract a substring from a string *
1062 *************************************************/
1064 /* Perform the ${substr or ${length expansion operations.
1067 subject the input string
1068 value1 the offset from the start of the input string to the start of
1069 the output string; if negative, count from the right.
1070 value2 the length of the output string, or negative (-1) for unset
1071 if value1 is positive, unset means "all after"
1072 if value1 is negative, unset means "all before"
1073 len set to the length of the returned string
1075 Returns: pointer to the output string, or NULL if there is an error
1079 extract_substr(uschar *subject, int value1, int value2, int *len)
1081 int sublen = Ustrlen(subject);
1083 if (value1 < 0) /* count from right */
1087 /* If the position is before the start, skip to the start, and adjust the
1088 length. If the length ends up negative, the substring is null because nothing
1089 can precede. This falls out naturally when the length is unset, meaning "all
1095 if (value2 < 0) value2 = 0;
1099 /* Otherwise an unset length => characters before value1 */
1101 else if (value2 < 0)
1108 /* For a non-negative offset, if the starting position is past the end of the
1109 string, the result will be the null string. Otherwise, an unset length means
1110 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1114 if (value1 > sublen)
1119 else if (value2 < 0) value2 = sublen;
1122 /* Cut the length down to the maximum possible for the offset value, and get
1123 the required characters. */
1125 if (value1 + value2 > sublen) value2 = sublen - value1;
1127 return subject + value1;
1133 /*************************************************
1134 * Old-style hash of a string *
1135 *************************************************/
1137 /* Perform the ${hash expansion operation.
1140 subject the input string (an expanded substring)
1141 value1 the length of the output string; if greater or equal to the
1142 length of the input string, the input string is returned
1143 value2 the number of hash characters to use, or 26 if negative
1144 len set to the length of the returned string
1146 Returns: pointer to the output string, or NULL if there is an error
1150 compute_hash(uschar *subject, int value1, int value2, int *len)
1152 int sublen = Ustrlen(subject);
1154 if (value2 < 0) value2 = 26;
1155 else if (value2 > Ustrlen(hashcodes))
1157 expand_string_message =
1158 string_sprintf("hash count \"%d\" too big", value2);
1162 /* Calculate the hash text. We know it is shorter than the original string, so
1163 can safely place it in subject[] (we know that subject is always itself an
1164 expanded substring). */
1166 if (value1 < sublen)
1171 while ((c = (subject[j])) != 0)
1173 int shift = (c + j++) & 7;
1174 subject[i] ^= (c << shift) | (c >> (8-shift));
1175 if (++i >= value1) i = 0;
1177 for (i = 0; i < value1; i++)
1178 subject[i] = hashcodes[(subject[i]) % value2];
1180 else value1 = sublen;
1189 /*************************************************
1190 * Numeric hash of a string *
1191 *************************************************/
1193 /* Perform the ${nhash expansion operation. The first characters of the
1194 string are treated as most important, and get the highest prime numbers.
1197 subject the input string
1198 value1 the maximum value of the first part of the result
1199 value2 the maximum value of the second part of the result,
1200 or negative to produce only a one-part result
1201 len set to the length of the returned string
1203 Returns: pointer to the output string, or NULL if there is an error.
1207 compute_nhash (uschar *subject, int value1, int value2, int *len)
1209 uschar *s = subject;
1211 unsigned long int total = 0; /* no overflow */
1215 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1216 total += prime[i--] * (unsigned int)(*s++);
1219 /* If value2 is unset, just compute one number */
1223 s = string_sprintf("%d", total % value1);
1226 /* Otherwise do a div/mod hash */
1230 total = total % (value1 * value2);
1231 s = string_sprintf("%d/%d", total/value2, total % value2);
1242 /*************************************************
1243 * Find the value of a header or headers *
1244 *************************************************/
1246 /* Multiple instances of the same header get concatenated, and this function
1247 can also return a concatenation of all the header lines. When concatenating
1248 specific headers that contain lists of addresses, a comma is inserted between
1249 them. Otherwise we use a straight concatenation. Because some messages can have
1250 pathologically large number of lines, there is a limit on the length that is
1251 returned. Also, to avoid massive store use which would result from using
1252 string_cat() as it copies and extends strings, we do a preliminary pass to find
1253 out exactly how much store will be needed. On "normal" messages this will be
1257 name the name of the header, without the leading $header_ or $h_,
1258 or NULL if a concatenation of all headers is required
1259 exists_only TRUE if called from a def: test; don't need to build a string;
1260 just return a string that is not "" and not "0" if the header
1262 newsize return the size of memory block that was obtained; may be NULL
1263 if exists_only is TRUE
1264 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1265 other than concatenating, will be done on the header. Also used
1266 for $message_headers_raw.
1267 charset name of charset to translate MIME words to; used only if
1268 want_raw is false; if NULL, no translation is done (this is
1269 used for $bh_ and $bheader_)
1271 Returns: NULL if the header does not exist, else a pointer to a new
1276 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1279 BOOL found = name == NULL;
1281 int len = found? 0 : Ustrlen(name);
1283 uschar *yield = NULL;
1286 /* Loop for two passes - saves code repetition */
1288 for (i = 0; i < 2; i++)
1293 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1295 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1297 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1302 if (exists_only) return US"1"; /* don't need actual string */
1304 t = h->text + len; /* text to insert */
1305 if (!want_raw) /* unless wanted raw, */
1306 while (isspace(*t)) t++; /* remove leading white space */
1307 ilen = h->slen - (t - h->text); /* length to insert */
1309 /* Unless wanted raw, remove trailing whitespace, including the
1313 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1315 /* Set comma = 1 if handling a single header and it's one of those
1316 that contains an address list, except when asked for raw headers. Only
1317 need to do this once. */
1319 if (!want_raw && name != NULL && comma == 0 &&
1320 Ustrchr("BCFRST", h->type) != NULL)
1323 /* First pass - compute total store needed; second pass - compute
1324 total store used, including this header. */
1326 size += ilen + comma + 1; /* +1 for the newline */
1328 /* Second pass - concatentate the data, up to a maximum. Note that
1329 the loop stops when size hits the limit. */
1333 if (size > header_insert_maxlen)
1335 ilen -= size - header_insert_maxlen - 1;
1338 Ustrncpy(ptr, t, ilen);
1341 /* For a non-raw header, put in the comma if needed, then add
1342 back the newline we removed above, provided there was some text in
1345 if (!want_raw && ilen > 0)
1347 if (comma != 0) *ptr++ = ',';
1355 /* At end of first pass, return NULL if no header found. Then truncate size
1356 if necessary, and get the buffer to hold the data, returning the buffer size.
1361 if (!found) return NULL;
1362 if (size > header_insert_maxlen) size = header_insert_maxlen;
1363 *newsize = size + 1;
1364 ptr = yield = store_get(*newsize);
1368 /* That's all we do for raw header expansion. */
1375 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1376 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1377 function can return an error with decoded data if the charset translation
1378 fails. If decoding fails, it returns NULL. */
1382 uschar *decoded, *error;
1383 if (ptr > yield && ptr[-1] == '\n') ptr--;
1384 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1386 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1390 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1391 " input was: %s\n", error, yield);
1393 if (decoded != NULL) yield = decoded;
1402 /*************************************************
1403 * Find value of a variable *
1404 *************************************************/
1406 /* The table of variables is kept in alphabetic order, so we can search it
1407 using a binary chop. The "choplen" variable is nothing to do with the binary
1411 name the name of the variable being sought
1412 exists_only TRUE if this is a def: test; passed on to find_header()
1413 skipping TRUE => skip any processing evaluation; this is not the same as
1414 exists_only because def: may test for values that are first
1416 newsize pointer to an int which is initially zero; if the answer is in
1417 a new memory buffer, *newsize is set to its size
1419 Returns: NULL if the variable does not exist, or
1420 a pointer to the variable's contents, or
1421 something non-NULL if exists_only is TRUE
1425 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1428 int last = var_table_size;
1430 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1431 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1432 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1433 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1434 (this gave backwards compatibility at the changeover). There may be built-in
1435 variables whose names start acl_ but they should never start in this way. This
1436 slightly messy specification is a consequence of the history, needless to say.
1438 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1439 set, in which case give an error. */
1441 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1445 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1446 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1449 /* Handle $auth<n> variables. */
1451 if (Ustrncmp(name, "auth", 4) == 0)
1454 int n = Ustrtoul(name + 4, &endptr, 10);
1455 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1456 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1459 /* For all other variables, search the table */
1461 while (last > first)
1465 int middle = (first + last)/2;
1466 int c = Ustrcmp(name, var_table[middle].name);
1468 if (c > 0) { first = middle + 1; continue; }
1469 if (c < 0) { last = middle; continue; }
1471 /* Found an existing variable. If in skipping state, the value isn't needed,
1472 and we want to avoid processing (such as looking up the host name). */
1474 if (skipping) return US"";
1476 switch (var_table[middle].type)
1478 case vtype_filter_int:
1479 if (!filter_running) return NULL;
1483 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1487 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1491 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1495 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1498 case vtype_stringptr: /* Pointer to string */
1499 s = *((uschar **)(var_table[middle].value));
1500 return (s == NULL)? US"" : s;
1503 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1506 case vtype_load_avg:
1507 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1510 case vtype_host_lookup: /* Lookup if not done so */
1511 if (sender_host_name == NULL && sender_host_address != NULL &&
1512 !host_lookup_failed && host_name_lookup() == OK)
1513 host_build_sender_fullhost();
1514 return (sender_host_name == NULL)? US"" : sender_host_name;
1516 case vtype_localpart: /* Get local part from address */
1517 s = *((uschar **)(var_table[middle].value));
1518 if (s == NULL) return US"";
1519 domain = Ustrrchr(s, '@');
1520 if (domain == NULL) return s;
1521 if (domain - s > sizeof(var_buffer) - 1)
1522 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1523 "string expansion", sizeof(var_buffer));
1524 Ustrncpy(var_buffer, s, domain - s);
1525 var_buffer[domain - s] = 0;
1528 case vtype_domain: /* Get domain from address */
1529 s = *((uschar **)(var_table[middle].value));
1530 if (s == NULL) return US"";
1531 domain = Ustrrchr(s, '@');
1532 return (domain == NULL)? US"" : domain + 1;
1534 case vtype_msgheaders:
1535 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1537 case vtype_msgheaders_raw:
1538 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1540 case vtype_msgbody: /* Pointer to msgbody string */
1541 case vtype_msgbody_end: /* Ditto, the end of the msg */
1542 ss = (uschar **)(var_table[middle].value);
1543 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1546 off_t start_offset = SPOOL_DATA_START_OFFSET;
1547 int len = message_body_visible;
1548 if (len > message_size) len = message_size;
1549 *ss = body = store_malloc(len+1);
1551 if (var_table[middle].type == vtype_msgbody_end)
1553 struct stat statbuf;
1554 if (fstat(deliver_datafile, &statbuf) == 0)
1556 start_offset = statbuf.st_size - len;
1557 if (start_offset < SPOOL_DATA_START_OFFSET)
1558 start_offset = SPOOL_DATA_START_OFFSET;
1561 lseek(deliver_datafile, start_offset, SEEK_SET);
1562 len = read(deliver_datafile, body, len);
1566 if (message_body_newlines) /* Separate loops for efficiency */
1569 { if (body[--len] == 0) body[len] = ' '; }
1574 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1578 return (*ss == NULL)? US"" : *ss;
1580 case vtype_todbsdin: /* BSD inbox time of day */
1581 return tod_stamp(tod_bsdin);
1583 case vtype_tode: /* Unix epoch time of day */
1584 return tod_stamp(tod_epoch);
1586 case vtype_todf: /* Full time of day */
1587 return tod_stamp(tod_full);
1589 case vtype_todl: /* Log format time of day */
1590 return tod_stamp(tod_log_bare); /* (without timezone) */
1592 case vtype_todzone: /* Time zone offset only */
1593 return tod_stamp(tod_zone);
1595 case vtype_todzulu: /* Zulu time */
1596 return tod_stamp(tod_zulu);
1598 case vtype_todlf: /* Log file datestamp tod */
1599 return tod_stamp(tod_log_datestamp_daily);
1601 case vtype_reply: /* Get reply address */
1602 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1604 if (s != NULL) while (isspace(*s)) s++;
1605 if (s == NULL || *s == 0)
1607 *newsize = 0; /* For the *s==0 case */
1608 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1613 while (isspace(*s)) s++;
1614 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1615 while (t > s && isspace(t[-1])) t--;
1618 return (s == NULL)? US"" : s;
1620 /* A recipients list is available only during system message filtering,
1621 during ACL processing after DATA, and while expanding pipe commands
1622 generated from a system filter, but not elsewhere. */
1624 case vtype_recipients:
1625 if (!enable_dollar_recipients) return NULL; else
1630 s = store_get(size);
1631 for (i = 0; i < recipients_count; i++)
1633 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1634 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1635 Ustrlen(recipients_list[i].address));
1637 s[ptr] = 0; /* string_cat() leaves room */
1644 sprintf(CS var_buffer, "%d",
1645 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1652 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1653 sprintf(CS var_buffer, "%d", inodes);
1657 #ifndef DISABLE_DKIM
1659 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1665 return NULL; /* Unknown variable name */
1671 /*************************************************
1672 * Read and expand substrings *
1673 *************************************************/
1675 /* This function is called to read and expand argument substrings for various
1676 expansion items. Some have a minimum requirement that is less than the maximum;
1677 in these cases, the first non-present one is set to NULL.
1680 sub points to vector of pointers to set
1681 n maximum number of substrings
1683 sptr points to current string pointer
1684 skipping the skipping flag
1685 check_end if TRUE, check for final '}'
1686 name name of item, for error message
1688 Returns: 0 OK; string pointer updated
1689 1 curly bracketing error (too few arguments)
1690 2 too many arguments (only if check_end is set); message set
1691 3 other error (expansion failure)
1695 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1696 BOOL check_end, uschar *name)
1701 while (isspace(*s)) s++;
1702 for (i = 0; i < n; i++)
1706 if (i < m) return 1;
1710 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1711 if (sub[i] == NULL) return 3;
1712 if (*s++ != '}') return 1;
1713 while (isspace(*s)) s++;
1715 if (check_end && *s++ != '}')
1719 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1720 "(max is %d)", name, n);
1733 /*************************************************
1734 * Elaborate message for bad variable *
1735 *************************************************/
1737 /* For the "unknown variable" message, take a look at the variable's name, and
1738 give additional information about possible ACL variables. The extra information
1739 is added on to expand_string_message.
1741 Argument: the name of the variable
1746 check_variable_error_message(uschar *name)
1748 if (Ustrncmp(name, "acl_", 4) == 0)
1749 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1750 (name[4] == 'c' || name[4] == 'm')?
1752 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1753 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1755 US"user-defined ACL variables must start acl_c or acl_m");
1760 /*************************************************
1761 * Read and evaluate a condition *
1762 *************************************************/
1766 s points to the start of the condition text
1767 yield points to a BOOL to hold the result of the condition test;
1768 if NULL, we are just reading through a condition that is
1769 part of an "or" combination to check syntax, or in a state
1770 where the answer isn't required
1772 Returns: a pointer to the first character after the condition, or
1777 eval_condition(uschar *s, BOOL *yield)
1779 BOOL testfor = TRUE;
1780 BOOL tempcond, combined_cond;
1782 BOOL sub2_honour_dollar = TRUE;
1783 int i, rc, cond_type, roffset;
1785 struct stat statbuf;
1790 const uschar *rerror;
1794 while (isspace(*s)) s++;
1795 if (*s == '!') { testfor = !testfor; s++; } else break;
1798 /* Numeric comparisons are symbolic */
1800 if (*s == '=' || *s == '>' || *s == '<')
1812 /* All other conditions are named */
1814 else s = read_name(name, 256, s, US"_");
1816 /* If we haven't read a name, it means some non-alpha character is first. */
1820 expand_string_message = string_sprintf("condition name expected, "
1821 "but found \"%.16s\"", s);
1825 /* Find which condition we are dealing with, and switch on it */
1827 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1830 /* def: tests for a non-empty variable, or for the existence of a header. If
1831 yield == NULL we are in a skipping state, and don't care about the answer. */
1836 expand_string_message = US"\":\" expected after \"def\"";
1840 s = read_name(name, 256, s+1, US"_");
1842 /* Test for a header's existence. If the name contains a closing brace
1843 character, this may be a user error where the terminating colon has been
1844 omitted. Set a flag to adjust a subsequent error message in this case. */
1846 if (Ustrncmp(name, "h_", 2) == 0 ||
1847 Ustrncmp(name, "rh_", 3) == 0 ||
1848 Ustrncmp(name, "bh_", 3) == 0 ||
1849 Ustrncmp(name, "header_", 7) == 0 ||
1850 Ustrncmp(name, "rheader_", 8) == 0 ||
1851 Ustrncmp(name, "bheader_", 8) == 0)
1853 s = read_header_name(name, 256, s);
1854 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1855 if (yield != NULL) *yield =
1856 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1859 /* Test for a variable's having a non-empty value. A non-existent variable
1860 causes an expansion failure. */
1864 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1867 expand_string_message = (name[0] == 0)?
1868 string_sprintf("variable name omitted after \"def:\"") :
1869 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1870 check_variable_error_message(name);
1873 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1879 /* first_delivery tests for first delivery attempt */
1881 case ECOND_FIRST_DELIVERY:
1882 if (yield != NULL) *yield = deliver_firsttime == testfor;
1886 /* queue_running tests for any process started by a queue runner */
1888 case ECOND_QUEUE_RUNNING:
1889 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1893 /* exists: tests for file existence
1894 isip: tests for any IP address
1895 isip4: tests for an IPv4 address
1896 isip6: tests for an IPv6 address
1897 pam: does PAM authentication
1898 radius: does RADIUS authentication
1899 ldapauth: does LDAP authentication
1900 pwcheck: does Cyrus SASL pwcheck authentication
1909 case ECOND_LDAPAUTH:
1912 while (isspace(*s)) s++;
1913 if (*s != '{') goto COND_FAILED_CURLY_START;
1915 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
1916 if (sub[0] == NULL) return NULL;
1917 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1919 if (yield == NULL) return s; /* No need to run the test if skipping */
1924 if ((expand_forbid & RDO_EXISTS) != 0)
1926 expand_string_message = US"File existence tests are not permitted";
1929 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1935 rc = string_is_ip_address(sub[0], NULL);
1936 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1937 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1940 /* Various authentication tests - all optionally compiled */
1944 rc = auth_call_pam(sub[0], &expand_string_message);
1947 goto COND_FAILED_NOT_COMPILED;
1948 #endif /* SUPPORT_PAM */
1951 #ifdef RADIUS_CONFIG_FILE
1952 rc = auth_call_radius(sub[0], &expand_string_message);
1955 goto COND_FAILED_NOT_COMPILED;
1956 #endif /* RADIUS_CONFIG_FILE */
1958 case ECOND_LDAPAUTH:
1961 /* Just to keep the interface the same */
1963 int old_pool = store_pool;
1964 store_pool = POOL_SEARCH;
1965 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1966 &expand_string_message, &do_cache);
1967 store_pool = old_pool;
1971 goto COND_FAILED_NOT_COMPILED;
1972 #endif /* LOOKUP_LDAP */
1975 #ifdef CYRUS_PWCHECK_SOCKET
1976 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1979 goto COND_FAILED_NOT_COMPILED;
1980 #endif /* CYRUS_PWCHECK_SOCKET */
1982 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1983 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1985 if (rc == ERROR || rc == DEFER) return NULL;
1986 *yield = (rc == OK) == testfor;
1992 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1994 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1996 However, the last two are optional. That is why the whole set is enclosed
1997 in their own set or braces. */
1999 case ECOND_SASLAUTHD:
2000 #ifndef CYRUS_SASLAUTHD_SOCKET
2001 goto COND_FAILED_NOT_COMPILED;
2003 while (isspace(*s)) s++;
2004 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2005 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2007 case 1: expand_string_message = US"too few arguments or bracketing "
2008 "error for saslauthd";
2010 case 3: return NULL;
2012 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2016 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2017 &expand_string_message);
2018 if (rc == ERROR || rc == DEFER) return NULL;
2019 *yield = (rc == OK) == testfor;
2022 #endif /* CYRUS_SASLAUTHD_SOCKET */
2025 /* symbolic operators for numeric and string comparison, and a number of
2026 other operators, all requiring two arguments.
2028 crypteq: encrypts plaintext and compares against an encrypted text,
2029 using crypt(), crypt16(), MD5 or SHA-1
2030 inlist/inlisti: checks if first argument is in the list of the second
2031 match: does a regular expression match and sets up the numerical
2032 variables if it succeeds
2033 match_address: matches in an address list
2034 match_domain: matches in a domain list
2035 match_ip: matches a host list that is restricted to IP addresses
2036 match_local_part: matches in a local part list
2039 case ECOND_MATCH_ADDRESS:
2040 case ECOND_MATCH_DOMAIN:
2041 case ECOND_MATCH_IP:
2042 case ECOND_MATCH_LOCAL_PART:
2043 #ifndef EXPAND_LISTMATCH_RHS
2044 sub2_honour_dollar = FALSE;
2053 case ECOND_NUM_L: /* Numerical comparisons */
2060 case ECOND_STR_LT: /* String comparisons */
2071 for (i = 0; i < 2; i++)
2073 /* Sometimes, we don't expand substrings; too many insecure configurations
2074 created using match_address{}{} and friends, where the second param
2075 includes information from untrustworthy sources. */
2076 BOOL honour_dollar = TRUE;
2077 if ((i > 0) && !sub2_honour_dollar)
2078 honour_dollar = FALSE;
2080 while (isspace(*s)) s++;
2083 if (i == 0) goto COND_FAILED_CURLY_START;
2084 expand_string_message = string_sprintf("missing 2nd string in {} "
2085 "after \"%s\"", name);
2088 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2090 if (sub[i] == NULL) return NULL;
2091 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2093 /* Convert to numerical if required; we know that the names of all the
2094 conditions that compare numbers do not start with a letter. This just saves
2095 checking for them individually. */
2097 if (!isalpha(name[0]) && yield != NULL)
2103 debug_printf("empty string cast to zero for numerical comparison\n");
2107 num[i] = expand_string_integer(sub[i], FALSE);
2108 if (expand_string_message != NULL) return NULL;
2113 /* Result not required */
2115 if (yield == NULL) return s;
2117 /* Do an appropriate comparison */
2123 *yield = (num[0] == num[1]) == testfor;
2127 *yield = (num[0] > num[1]) == testfor;
2131 *yield = (num[0] >= num[1]) == testfor;
2135 *yield = (num[0] < num[1]) == testfor;
2139 *yield = (num[0] <= num[1]) == testfor;
2143 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2147 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2151 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2155 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2159 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2163 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2167 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2171 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2175 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2179 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2182 case ECOND_MATCH: /* Regular expression match */
2183 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2187 expand_string_message = string_sprintf("regular expression error in "
2188 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2191 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2194 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2195 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2196 goto MATCHED_SOMETHING;
2198 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2199 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2200 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2201 goto MATCHED_SOMETHING;
2203 case ECOND_MATCH_IP: /* Match IP address in a host list */
2204 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2206 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2212 unsigned int *nullcache = NULL;
2213 check_host_block cb;
2215 cb.host_name = US"";
2216 cb.host_address = sub[0];
2218 /* If the host address starts off ::ffff: it is an IPv6 address in
2219 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2222 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2223 cb.host_address + 7 : cb.host_address;
2225 rc = match_check_list(
2226 &sub[1], /* the list */
2227 0, /* separator character */
2228 &hostlist_anchor, /* anchor pointer */
2229 &nullcache, /* cache pointer */
2230 check_host, /* function for testing */
2231 &cb, /* argument for function */
2232 MCL_HOST, /* type of check */
2233 sub[0], /* text for debugging */
2234 NULL); /* where to pass back data */
2236 goto MATCHED_SOMETHING;
2238 case ECOND_MATCH_LOCAL_PART:
2239 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2240 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2255 expand_string_message = string_sprintf("unable to complete match "
2256 "against \"%s\": %s", sub[1], search_error_message);
2262 /* Various "encrypted" comparisons. If the second string starts with
2263 "{" then an encryption type is given. Default to crypt() or crypt16()
2264 (build-time choice). */
2267 #ifndef SUPPORT_CRYPTEQ
2268 goto COND_FAILED_NOT_COMPILED;
2270 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2272 int sublen = Ustrlen(sub[1]+5);
2277 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2279 /* If the length that we are comparing against is 24, the MD5 digest
2280 is expressed as a base64 string. This is the way LDAP does it. However,
2281 some other software uses a straightforward hex representation. We assume
2282 this if the length is 32. Other lengths fail. */
2286 uschar *coded = auth_b64encode((uschar *)digest, 16);
2287 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2288 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2289 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2291 else if (sublen == 32)
2295 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2297 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2298 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2299 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2303 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2304 "fail\n crypted=%s\n", sub[1]+5);
2309 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2311 int sublen = Ustrlen(sub[1]+6);
2316 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2318 /* If the length that we are comparing against is 28, assume the SHA1
2319 digest is expressed as a base64 string. If the length is 40, assume a
2320 straightforward hex representation. Other lengths fail. */
2324 uschar *coded = auth_b64encode((uschar *)digest, 20);
2325 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2326 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2327 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2329 else if (sublen == 40)
2333 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2335 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2336 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2337 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2341 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2342 "fail\n crypted=%s\n", sub[1]+6);
2347 else /* {crypt} or {crypt16} and non-{ at start */
2348 /* }-for-text-editors */
2353 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2358 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2363 else if (sub[1][0] == '{')
2365 expand_string_message = string_sprintf("unknown encryption mechanism "
2366 "in \"%s\"", sub[1]);
2372 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2373 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2374 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2378 #define XSTR(s) STR(s)
2379 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2380 " subject=%s\n crypted=%s\n",
2381 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2386 /* If the encrypted string contains fewer than two characters (for the
2387 salt), force failure. Otherwise we get false positives: with an empty
2388 string the yield of crypt() is an empty string! */
2390 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2391 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2394 #endif /* SUPPORT_CRYPTEQ */
2401 uschar *save_iterate_item = iterate_item;
2402 int (*compare)(const uschar *, const uschar *);
2404 if (cond_type == ECOND_INLISTI)
2407 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2409 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2410 if (compare(sub[0], iterate_item) == 0)
2415 iterate_item = save_iterate_item;
2419 } /* Switch for comparison conditions */
2421 return s; /* End of comparison conditions */
2424 /* and/or: computes logical and/or of several conditions */
2428 subcondptr = (yield == NULL)? NULL : &tempcond;
2429 combined_cond = (cond_type == ECOND_AND);
2431 while (isspace(*s)) s++;
2432 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2436 while (isspace(*s)) s++;
2437 if (*s == '}') break;
2440 expand_string_message = string_sprintf("each subcondition "
2441 "inside an \"%s{...}\" condition must be in its own {}", name);
2445 s = eval_condition(s+1, subcondptr);
2448 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2449 expand_string_message, name);
2452 while (isspace(*s)) s++;
2456 expand_string_message = string_sprintf("missing } at end of condition "
2457 "inside \"%s\" group", name);
2463 if (cond_type == ECOND_AND)
2465 combined_cond &= tempcond;
2466 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2467 } /* evaluate any more */
2470 combined_cond |= tempcond;
2471 if (combined_cond) subcondptr = NULL; /* once true, don't */
2472 } /* evaluate any more */
2476 if (yield != NULL) *yield = (combined_cond == testfor);
2480 /* forall/forany: iterates a condition with different values */
2486 uschar *save_iterate_item = iterate_item;
2488 while (isspace(*s)) s++;
2489 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2490 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2491 if (sub[0] == NULL) return NULL;
2492 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2494 while (isspace(*s)) s++;
2495 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2499 /* Call eval_condition once, with result discarded (as if scanning a
2500 "false" part). This allows us to find the end of the condition, because if
2501 the list it empty, we won't actually evaluate the condition for real. */
2503 s = eval_condition(sub[1], NULL);
2506 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2507 expand_string_message, name);
2510 while (isspace(*s)) s++;
2514 expand_string_message = string_sprintf("missing } at end of condition "
2515 "inside \"%s\"", name);
2519 if (yield != NULL) *yield = !testfor;
2520 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2522 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2523 if (eval_condition(sub[1], &tempcond) == NULL)
2525 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2526 expand_string_message, name);
2527 iterate_item = save_iterate_item;
2530 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2531 tempcond? "true":"false");
2533 if (yield != NULL) *yield = (tempcond == testfor);
2534 if (tempcond == (cond_type == ECOND_FORANY)) break;
2537 iterate_item = save_iterate_item;
2542 /* The bool{} expansion condition maps a string to boolean.
2543 The values supported should match those supported by the ACL condition
2544 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2545 of true/false. Note that Router "condition" rules have a different
2546 interpretation, where general data can be used and only a few values
2548 Note that readconf.c boolean matching, for boolean configuration options,
2549 only matches true/yes/false/no.
2550 The bool_lax{} condition matches the Router logic, which is much more
2553 case ECOND_BOOL_LAX:
2559 BOOL boolvalue = FALSE;
2560 while (isspace(*s)) s++;
2561 if (*s != '{') goto COND_FAILED_CURLY_START;
2562 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2563 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2565 case 1: expand_string_message = string_sprintf(
2566 "too few arguments or bracketing error for %s",
2570 case 3: return NULL;
2573 while (isspace(*t)) t++;
2577 /* trailing whitespace: seems like a good idea to ignore it too */
2579 while (isspace(*t2)) t2--;
2580 if (t2 != (t + len))
2587 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2588 /* logic for the lax case from expand_check_condition(), which also does
2589 expands, and the logic is both short and stable enough that there should
2590 be no maintenance burden from replicating it. */
2593 else if (Ustrspn(t, "0123456789") == len)
2595 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2596 /* expand_check_condition only does a literal string "0" check */
2597 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2600 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2602 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2604 else if (cond_type == ECOND_BOOL_LAX)
2608 expand_string_message = string_sprintf("unrecognised boolean "
2612 if (yield != NULL) *yield = (boolvalue == testfor);
2616 /* Unknown condition */
2619 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2621 } /* End switch on condition type */
2623 /* Missing braces at start and end of data */
2625 COND_FAILED_CURLY_START:
2626 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2629 COND_FAILED_CURLY_END:
2630 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2634 /* A condition requires code that is not compiled */
2636 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2637 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2638 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2639 COND_FAILED_NOT_COMPILED:
2640 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2649 /*************************************************
2650 * Save numerical variables *
2651 *************************************************/
2653 /* This function is called from items such as "if" that want to preserve and
2654 restore the numbered variables.
2657 save_expand_string points to an array of pointers to set
2658 save_expand_nlength points to an array of ints for the lengths
2660 Returns: the value of expand max to save
2664 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2667 for (i = 0; i <= expand_nmax; i++)
2669 save_expand_nstring[i] = expand_nstring[i];
2670 save_expand_nlength[i] = expand_nlength[i];
2677 /*************************************************
2678 * Restore numerical variables *
2679 *************************************************/
2681 /* This function restored saved values of numerical strings.
2684 save_expand_nmax the number of strings to restore
2685 save_expand_string points to an array of pointers
2686 save_expand_nlength points to an array of ints
2692 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2693 int *save_expand_nlength)
2696 expand_nmax = save_expand_nmax;
2697 for (i = 0; i <= expand_nmax; i++)
2699 expand_nstring[i] = save_expand_nstring[i];
2700 expand_nlength[i] = save_expand_nlength[i];
2708 /*************************************************
2709 * Handle yes/no substrings *
2710 *************************************************/
2712 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2713 alternative substrings that depend on whether or not the condition was true,
2714 or the lookup or extraction succeeded. The substrings always have to be
2715 expanded, to check their syntax, but "skipping" is set when the result is not
2716 needed - this avoids unnecessary nested lookups.
2719 skipping TRUE if we were skipping when this item was reached
2720 yes TRUE if the first string is to be used, else use the second
2721 save_lookup a value to put back into lookup_value before the 2nd expansion
2722 sptr points to the input string pointer
2723 yieldptr points to the output string pointer
2724 sizeptr points to the output string size
2725 ptrptr points to the output string pointer
2726 type "lookup" or "if" or "extract" or "run", for error message
2728 Returns: 0 OK; lookup_value has been reset to save_lookup
2730 2 expansion failed because of bracketing error
2734 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2735 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2738 uschar *s = *sptr; /* Local value */
2739 uschar *sub1, *sub2;
2741 /* If there are no following strings, we substitute the contents of $value for
2742 lookups and for extractions in the success case. For the ${if item, the string
2743 "true" is substituted. In the fail case, nothing is substituted for all three
2746 while (isspace(*s)) s++;
2751 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2755 if (yes && lookup_value != NULL)
2756 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2757 Ustrlen(lookup_value));
2758 lookup_value = save_lookup;
2764 /* The first following string must be braced. */
2766 if (*s++ != '{') goto FAILED_CURLY;
2768 /* Expand the first substring. Forced failures are noticed only if we actually
2769 want this string. Set skipping in the call in the fail case (this will always
2770 be the case if we were already skipping). */
2772 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
2773 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2774 expand_string_forcedfail = FALSE;
2775 if (*s++ != '}') goto FAILED_CURLY;
2777 /* If we want the first string, add it to the output */
2780 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2782 /* If this is called from a lookup or an extract, we want to restore $value to
2783 what it was at the start of the item, so that it has this value during the
2784 second string expansion. For the call from "if" or "run" to this function,
2785 save_lookup is set to lookup_value, so that this statement does nothing. */
2787 lookup_value = save_lookup;
2789 /* There now follows either another substring, or "fail", or nothing. This
2790 time, forced failures are noticed only if we want the second string. We must
2791 set skipping in the nested call if we don't want this string, or if we were
2792 already skipping. */
2794 while (isspace(*s)) s++;
2797 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
2798 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2799 expand_string_forcedfail = FALSE;
2800 if (*s++ != '}') goto FAILED_CURLY;
2802 /* If we want the second string, add it to the output */
2805 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2808 /* If there is no second string, but the word "fail" is present when the use of
2809 the second string is wanted, set a flag indicating it was a forced failure
2810 rather than a syntactic error. Swallow the terminating } in case this is nested
2811 inside another lookup or if or extract. */
2816 s = read_name(name, sizeof(name), s, US"_");
2817 if (Ustrcmp(name, "fail") == 0)
2819 if (!yes && !skipping)
2821 while (isspace(*s)) s++;
2822 if (*s++ != '}') goto FAILED_CURLY;
2823 expand_string_message =
2824 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2825 expand_string_forcedfail = TRUE;
2831 expand_string_message =
2832 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2837 /* All we have to do now is to check on the final closing brace. */
2839 while (isspace(*s)) s++;
2840 if (*s++ == '}') goto RETURN;
2842 /* Get here if there is a bracketing failure */
2847 /* Get here for other failures */
2852 /* Update the input pointer value before returning */
2862 /*************************************************
2863 * Handle MD5 or SHA-1 computation for HMAC *
2864 *************************************************/
2866 /* These are some wrapping functions that enable the HMAC code to be a bit
2867 cleaner. A good compiler will spot the tail recursion.
2870 type HMAC_MD5 or HMAC_SHA1
2871 remaining are as for the cryptographic hash functions
2877 chash_start(int type, void *base)
2879 if (type == HMAC_MD5)
2880 md5_start((md5 *)base);
2882 sha1_start((sha1 *)base);
2886 chash_mid(int type, void *base, uschar *string)
2888 if (type == HMAC_MD5)
2889 md5_mid((md5 *)base, string);
2891 sha1_mid((sha1 *)base, string);
2895 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2897 if (type == HMAC_MD5)
2898 md5_end((md5 *)base, string, length, digest);
2900 sha1_end((sha1 *)base, string, length, digest);
2907 /********************************************************
2908 * prvs: Get last three digits of days since Jan 1, 1970 *
2909 ********************************************************/
2911 /* This is needed to implement the "prvs" BATV reverse
2914 Argument: integer "days" offset to add or substract to
2915 or from the current number of days.
2917 Returns: pointer to string containing the last three
2918 digits of the number of days since Jan 1, 1970,
2919 modified by the offset argument, NULL if there
2920 was an error in the conversion.
2925 prvs_daystamp(int day_offset)
2927 uschar *days = store_get(32); /* Need at least 24 for cases */
2928 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2929 (time(NULL) + day_offset*86400)/86400);
2930 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2935 /********************************************************
2936 * prvs: perform HMAC-SHA1 computation of prvs bits *
2937 ********************************************************/
2939 /* This is needed to implement the "prvs" BATV reverse
2943 address RFC2821 Address to use
2944 key The key to use (must be less than 64 characters
2946 key_num Single-digit key number to use. Defaults to
2949 Returns: pointer to string containing the first three
2950 bytes of the final hash in hex format, NULL if
2951 there was an error in the process.
2955 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2957 uschar *hash_source, *p;
2958 int size = 0,offset = 0,i;
2960 void *use_base = &sha1_base;
2961 uschar innerhash[20];
2962 uschar finalhash[20];
2963 uschar innerkey[64];
2964 uschar outerkey[64];
2965 uschar *finalhash_hex = store_get(40);
2967 if (key_num == NULL)
2970 if (Ustrlen(key) > 64)
2973 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2974 string_cat(hash_source,&size,&offset,daystamp,3);
2975 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2976 hash_source[offset] = '\0';
2978 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2980 memset(innerkey, 0x36, 64);
2981 memset(outerkey, 0x5c, 64);
2983 for (i = 0; i < Ustrlen(key); i++)
2985 innerkey[i] ^= key[i];
2986 outerkey[i] ^= key[i];
2989 chash_start(HMAC_SHA1, use_base);
2990 chash_mid(HMAC_SHA1, use_base, innerkey);
2991 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2993 chash_start(HMAC_SHA1, use_base);
2994 chash_mid(HMAC_SHA1, use_base, outerkey);
2995 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2998 for (i = 0; i < 3; i++)
3000 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3001 *p++ = hex_digits[finalhash[i] & 0x0f];
3005 return finalhash_hex;
3011 /*************************************************
3012 * Join a file onto the output string *
3013 *************************************************/
3015 /* This is used for readfile and after a run expansion. It joins the contents
3016 of a file onto the output string, globally replacing newlines with a given
3017 string (optionally). The file is closed at the end.
3021 yield pointer to the expandable string
3022 sizep pointer to the current size
3023 ptrp pointer to the current position
3024 eol newline replacement string, or NULL
3026 Returns: new value of string pointer
3030 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3033 uschar buffer[1024];
3035 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3037 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3039 int len = Ustrlen(buffer);
3040 if (eol != NULL && buffer[len-1] == '\n') len--;
3041 yield = string_cat(yield, sizep, ptrp, buffer, len);
3042 if (buffer[len] != 0)
3043 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3046 if (yield != NULL) yield[*ptrp] = 0;
3054 /*************************************************
3055 * Evaluate numeric expression *
3056 *************************************************/
3058 /* This is a set of mutually recursive functions that evaluate an arithmetic
3059 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3060 these functions that is called from elsewhere is eval_expr, whose interface is:
3063 sptr pointer to the pointer to the string - gets updated
3064 decimal TRUE if numbers are to be assumed decimal
3065 error pointer to where to put an error message - must be NULL on input
3066 endket TRUE if ')' must terminate - FALSE for external call
3068 Returns: on success: the value of the expression, with *error still NULL
3069 on failure: an undefined value, with *error = a message
3072 static int64_t eval_op_or(uschar **, BOOL, uschar **);
3076 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3079 int64_t x = eval_op_or(&s, decimal, error);
3085 *error = US"expecting closing parenthesis";
3087 while (isspace(*(++s)));
3089 else if (*s != 0) *error = US"expecting operator";
3097 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3102 while (isspace(*s)) s++;
3107 (void)sscanf(CS s, (decimal? "%lld%n" : "%lli%n"), &n, &count);
3109 if (tolower(*s) == 'k') { n *= 1024; s++; }
3110 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
3111 while (isspace (*s)) s++;
3116 n = eval_expr(&s, decimal, error, 1);
3120 *error = US"expecting number or opening parenthesis";
3129 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3133 while (isspace(*s)) s++;
3134 if (*s == '+' || *s == '-' || *s == '~')
3137 x = eval_op_unary(&s, decimal, error);
3138 if (op == '-') x = -x;
3139 else if (op == '~') x = ~x;
3143 x = eval_number(&s, decimal, error);
3151 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3154 int64_t x = eval_op_unary(&s, decimal, error);
3157 while (*s == '*' || *s == '/' || *s == '%')
3160 int64_t y = eval_op_unary(&s, decimal, error);
3161 if (*error != NULL) break;
3162 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3163 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3164 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3165 * -N*M is INT_MIN will yielf INT_MIN.
3166 * Since we don't support floating point, this is somewhat simpler.
3167 * Ideally, we'd return an error, but since we overflow for all other
3168 * arithmetic, consistency suggests otherwise, but what's the correct value
3169 * to use? There is none.
3170 * The C standard guarantees overflow for unsigned arithmetic but signed
3171 * overflow invokes undefined behaviour; in practice, this is overflow
3172 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3173 * that long/longlong larger than int are available, or we could just work
3174 * with larger types. We should consider whether to guarantee 32bit eval
3175 * and 64-bit working variables, with errors returned. For now ...
3176 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3177 * can just let the other invalid results occur otherwise, as they have
3178 * until now. For this one case, we can coerce.
3180 if (y == -1 && x == LLONG_MIN && op != '*')
3183 debug_printf("Integer exception dodging: %lld%c-1 coerced to %lld\n",
3184 LLONG_MIN, op, LLONG_MAX);
3194 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3211 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3214 int64_t x = eval_op_mult(&s, decimal, error);
3217 while (*s == '+' || *s == '-')
3220 int64_t y = eval_op_mult(&s, decimal, error);
3221 if (*error != NULL) break;
3222 if (op == '+') x += y; else x -= y;
3231 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3234 int64_t x = eval_op_sum(&s, decimal, error);
3237 while ((*s == '<' || *s == '>') && s[1] == s[0])
3242 y = eval_op_sum(&s, decimal, error);
3243 if (*error != NULL) break;
3244 if (op == '<') x <<= y; else x >>= y;
3253 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3256 int64_t x = eval_op_shift(&s, decimal, error);
3263 y = eval_op_shift(&s, decimal, error);
3264 if (*error != NULL) break;
3274 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3277 int64_t x = eval_op_and(&s, decimal, error);
3284 y = eval_op_and(&s, decimal, error);
3285 if (*error != NULL) break;
3295 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3298 int64_t x = eval_op_xor(&s, decimal, error);
3305 y = eval_op_xor(&s, decimal, error);
3306 if (*error != NULL) break;
3316 /*************************************************
3318 *************************************************/
3320 /* Returns either an unchanged string, or the expanded string in stacking pool
3321 store. Interpreted sequences are:
3323 \... normal escaping rules
3324 $name substitutes the variable
3326 ${op:string} operates on the expanded string value
3327 ${item{arg1}{arg2}...} expands the args and then does the business
3328 some literal args are not enclosed in {}
3330 There are now far too many operators and item types to make it worth listing
3331 them here in detail any more.
3333 We use an internal routine recursively to handle embedded substrings. The
3334 external function follows. The yield is NULL if the expansion failed, and there
3335 are two cases: if something collapsed syntactically, or if "fail" was given
3336 as the action on a lookup failure. These can be distinguised by looking at the
3337 variable expand_string_forcedfail, which is TRUE in the latter case.
3339 The skipping flag is set true when expanding a substring that isn't actually
3340 going to be used (after "if" or "lookup") and it prevents lookups from
3341 happening lower down.
3343 Store usage: At start, a store block of the length of the input plus 64
3344 is obtained. This is expanded as necessary by string_cat(), which might have to
3345 get a new block, or might be able to expand the original. At the end of the
3346 function we can release any store above that portion of the yield block that
3347 was actually used. In many cases this will be optimal.
3349 However: if the first item in the expansion is a variable name or header name,
3350 we reset the store before processing it; if the result is in fresh store, we
3351 use that without copying. This is helpful for expanding strings like
3352 $message_headers which can get very long.
3354 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3355 since resetting the store at the end of the expansion will free store that was
3356 allocated by the plugin code as well as the slop after the expanded string. So
3357 we skip any resets if ${dlfunc has been used. This is an unfortunate
3358 consequence of string expansion becoming too powerful.
3361 string the string to be expanded
3362 ket_ends true if expansion is to stop at }
3363 left if not NULL, a pointer to the first character after the
3364 expansion is placed here (typically used with ket_ends)
3365 skipping TRUE for recursive calls when the value isn't actually going
3366 to be used (to allow for optimisation)
3367 honour_dollar TRUE if $ is to be expanded,
3368 FALSE if it's just another character
3370 Returns: NULL if expansion fails:
3371 expand_string_forcedfail is set TRUE if failure was forced
3372 expand_string_message contains a textual error message
3373 a pointer to the expanded string on success
3377 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3378 BOOL skipping, BOOL honour_dollar)
3381 int size = Ustrlen(string)+ 64;
3383 uschar *yield = store_get(size);
3385 uschar *save_expand_nstring[EXPAND_MAXN+1];
3386 int save_expand_nlength[EXPAND_MAXN+1];
3387 BOOL resetok = TRUE;
3389 expand_string_forcedfail = FALSE;
3390 expand_string_message = US"";
3397 /* \ escapes the next character, which must exist, or else
3398 the expansion fails. There's a special escape, \N, which causes
3399 copying of the subject verbatim up to the next \N. Otherwise,
3400 the escapes are the standard set. */
3406 expand_string_message = US"\\ at end of string";
3413 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3414 yield = string_cat(yield, &size, &ptr, t, s - t);
3415 if (*s != 0) s += 2;
3421 ch[0] = string_interpret_escape(&s);
3423 yield = string_cat(yield, &size, &ptr, ch, 1);
3429 /* Anything other than $ is just copied verbatim, unless we are
3430 looking for a terminating } character. */
3432 if (ket_ends && *s == '}') break;
3434 if (*s != '$' || !honour_dollar)
3436 yield = string_cat(yield, &size, &ptr, s++, 1);
3440 /* No { after the $ - must be a plain name or a number for string
3441 match variable. There has to be a fudge for variables that are the
3442 names of header fields preceded by "$header_" because header field
3443 names can contain any printing characters except space and colon.
3444 For those that don't like typing this much, "$h_" is a synonym for
3445 "$header_". A non-existent header yields a NULL value; nothing is
3448 if (isalpha((*(++s))))
3453 s = read_name(name, sizeof(name), s, US"_");
3455 /* If this is the first thing to be expanded, release the pre-allocated
3458 if (ptr == 0 && yield != NULL)
3460 if (resetok) store_reset(yield);
3467 if (Ustrncmp(name, "h_", 2) == 0 ||
3468 Ustrncmp(name, "rh_", 3) == 0 ||
3469 Ustrncmp(name, "bh_", 3) == 0 ||
3470 Ustrncmp(name, "header_", 7) == 0 ||
3471 Ustrncmp(name, "rheader_", 8) == 0 ||
3472 Ustrncmp(name, "bheader_", 8) == 0)
3474 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3475 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3476 s = read_header_name(name, sizeof(name), s);
3477 value = find_header(name, FALSE, &newsize, want_raw, charset);
3479 /* If we didn't find the header, and the header contains a closing brace
3480 character, this may be a user error where the terminating colon
3481 has been omitted. Set a flag to adjust the error message in this case.
3482 But there is no error here - nothing gets inserted. */
3486 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3495 value = find_variable(name, FALSE, skipping, &newsize);
3498 expand_string_message =
3499 string_sprintf("unknown variable name \"%s\"", name);
3500 check_variable_error_message(name);
3505 /* If the data is known to be in a new buffer, newsize will be set to the
3506 size of that buffer. If this is the first thing in an expansion string,
3507 yield will be NULL; just point it at the new store instead of copying. Many
3508 expansion strings contain just one reference, so this is a useful
3509 optimization, especially for humungous headers. */
3511 len = Ustrlen(value);
3512 if (yield == NULL && newsize != 0)
3518 else yield = string_cat(yield, &size, &ptr, value, len);
3526 s = read_number(&n, s);
3527 if (n >= 0 && n <= expand_nmax)
3528 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3533 /* Otherwise, if there's no '{' after $ it's an error. */
3537 expand_string_message = US"$ not followed by letter, digit, or {";
3541 /* After { there can be various things, but they all start with
3542 an initial word, except for a number for a string match variable. */
3544 if (isdigit((*(++s))))
3547 s = read_number(&n, s);
3550 expand_string_message = US"} expected after number";
3553 if (n >= 0 && n <= expand_nmax)
3554 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3561 expand_string_message = US"letter or digit expected after ${";
3565 /* Allow "-" in names to cater for substrings with negative
3566 arguments. Since we are checking for known names after { this is
3569 s = read_name(name, sizeof(name), s, US"_-");
3570 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3574 /* Handle conditionals - preserve the values of the numerical expansion
3575 variables in case they get changed by a regular expression match in the
3576 condition. If not, they retain their external settings. At the end
3577 of this "if" section, they get restored to their previous values. */
3583 int save_expand_nmax =
3584 save_expand_strings(save_expand_nstring, save_expand_nlength);
3586 while (isspace(*s)) s++;
3587 next_s = eval_condition(s, skipping? NULL : &cond);
3588 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3591 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3592 cond? "true" : "false");
3596 /* The handling of "yes" and "no" result strings is now in a separate
3597 function that is also used by ${lookup} and ${extract} and ${run}. */
3599 switch(process_yesno(
3600 skipping, /* were previously skipping */
3601 cond, /* success/failure indicator */
3602 lookup_value, /* value to reset for string2 */
3603 &s, /* input pointer */
3604 &yield, /* output pointer */
3605 &size, /* output size */
3606 &ptr, /* output current point */
3607 US"if")) /* condition type */
3609 case 1: goto EXPAND_FAILED; /* when all is well, the */
3610 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3613 /* Restore external setting of expansion variables for continuation
3616 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3617 save_expand_nlength);
3621 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3622 expanding an internal string that isn't actually going to be used. All we
3623 need to do is check the syntax, so don't do a lookup at all. Preserve the
3624 values of the numerical expansion variables in case they get changed by a
3625 partial lookup. If not, they retain their external settings. At the end
3626 of this "lookup" section, they get restored to their previous values. */
3630 int stype, partial, affixlen, starflags;
3631 int expand_setup = 0;
3633 uschar *key, *filename, *affix;
3634 uschar *save_lookup_value = lookup_value;
3635 int save_expand_nmax =
3636 save_expand_strings(save_expand_nstring, save_expand_nlength);
3638 if ((expand_forbid & RDO_LOOKUP) != 0)
3640 expand_string_message = US"lookup expansions are not permitted";
3644 /* Get the key we are to look up for single-key+file style lookups.
3645 Otherwise set the key NULL pro-tem. */
3647 while (isspace(*s)) s++;
3650 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3651 if (key == NULL) goto EXPAND_FAILED;
3652 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3653 while (isspace(*s)) s++;
3657 /* Find out the type of database */
3661 expand_string_message = US"missing lookup type";
3665 /* The type is a string that may contain special characters of various
3666 kinds. Allow everything except space or { to appear; the actual content
3667 is checked by search_findtype_partial. */
3669 while (*s != 0 && *s != '{' && !isspace(*s))
3671 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3675 while (isspace(*s)) s++;
3677 /* Now check for the individual search type and any partial or default
3678 options. Only those types that are actually in the binary are valid. */
3680 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3684 expand_string_message = search_error_message;
3688 /* Check that a key was provided for those lookup types that need it,
3689 and was not supplied for those that use the query style. */
3691 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3695 expand_string_message = string_sprintf("missing {key} for single-"
3696 "key \"%s\" lookup", name);
3704 expand_string_message = string_sprintf("a single key was given for "
3705 "lookup type \"%s\", which is not a single-key lookup type", name);
3710 /* Get the next string in brackets and expand it. It is the file name for
3711 single-key+file lookups, and the whole query otherwise. In the case of
3712 queries that also require a file name (e.g. sqlite), the file name comes
3715 if (*s != '{') goto EXPAND_FAILED_CURLY;
3716 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3717 if (filename == NULL) goto EXPAND_FAILED;
3718 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3719 while (isspace(*s)) s++;
3721 /* If this isn't a single-key+file lookup, re-arrange the variables
3722 to be appropriate for the search_ functions. For query-style lookups,
3723 there is just a "key", and no file name. For the special query-style +
3724 file types, the query (i.e. "key") starts with a file name. */
3728 while (isspace(*filename)) filename++;
3731 if (mac_islookup(stype, lookup_querystyle))
3737 if (*filename != '/')
3739 expand_string_message = string_sprintf(
3740 "absolute file name expected for \"%s\" lookup", name);
3743 while (*key != 0 && !isspace(*key)) key++;
3744 if (*key != 0) *key++ = 0;
3748 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3749 the entry was not found. Note that there is no search_close() function.
3750 Files are left open in case of re-use. At suitable places in higher logic,
3751 search_tidyup() is called to tidy all open files. This can save opening
3752 the same file several times. However, files may also get closed when
3753 others are opened, if too many are open at once. The rule is that a
3754 handle should not be used after a second search_open().
3756 Request that a partial search sets up $1 and maybe $2 by passing
3757 expand_setup containing zero. If its value changes, reset expand_nmax,
3758 since new variables will have been set. Note that at the end of this
3759 "lookup" section, the old numeric variables are restored. */
3762 lookup_value = NULL;
3765 void *handle = search_open(filename, stype, 0, NULL, NULL);
3768 expand_string_message = search_error_message;
3771 lookup_value = search_find(handle, filename, key, partial, affix,
3772 affixlen, starflags, &expand_setup);
3773 if (search_find_defer)
3775 expand_string_message =
3776 string_sprintf("lookup of \"%s\" gave DEFER: %s",
3777 string_printing2(key, FALSE), search_error_message);
3780 if (expand_setup > 0) expand_nmax = expand_setup;
3783 /* The handling of "yes" and "no" result strings is now in a separate
3784 function that is also used by ${if} and ${extract}. */
3786 switch(process_yesno(
3787 skipping, /* were previously skipping */
3788 lookup_value != NULL, /* success/failure indicator */
3789 save_lookup_value, /* value to reset for string2 */
3790 &s, /* input pointer */
3791 &yield, /* output pointer */
3792 &size, /* output size */
3793 &ptr, /* output current point */
3794 US"lookup")) /* condition type */
3796 case 1: goto EXPAND_FAILED; /* when all is well, the */
3797 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3800 /* Restore external setting of expansion variables for carrying on
3801 at this level, and continue. */
3803 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3804 save_expand_nlength);
3808 /* If Perl support is configured, handle calling embedded perl subroutines,
3809 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3810 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3811 arguments (defined below). */
3813 #define EXIM_PERL_MAX_ARGS 8
3817 expand_string_message = US"\"${perl\" encountered, but this facility "
3818 "is not included in this binary";
3821 #else /* EXIM_PERL */
3823 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3826 if ((expand_forbid & RDO_PERL) != 0)
3828 expand_string_message = US"Perl calls are not permitted";
3832 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3835 case 1: goto EXPAND_FAILED_CURLY;
3837 case 3: goto EXPAND_FAILED;
3840 /* If skipping, we don't actually do anything */
3842 if (skipping) continue;
3844 /* Start the interpreter if necessary */
3846 if (!opt_perl_started)
3849 if (opt_perl_startup == NULL)
3851 expand_string_message = US"A setting of perl_startup is needed when "
3852 "using the Perl interpreter";
3855 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3856 initerror = init_perl(opt_perl_startup);
3857 if (initerror != NULL)
3859 expand_string_message =
3860 string_sprintf("error in perl_startup code: %s\n", initerror);
3863 opt_perl_started = TRUE;
3866 /* Call the function */
3868 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3869 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3870 sub_arg[0], sub_arg + 1);
3872 /* NULL yield indicates failure; if the message pointer has been set to
3873 NULL, the yield was undef, indicating a forced failure. Otherwise the
3874 message will indicate some kind of Perl error. */
3876 if (new_yield == NULL)
3878 if (expand_string_message == NULL)
3880 expand_string_message =
3881 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3882 "failure", sub_arg[0]);
3883 expand_string_forcedfail = TRUE;
3888 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3889 set during a callback from Perl. */
3891 expand_string_forcedfail = FALSE;
3895 #endif /* EXIM_PERL */
3897 /* Transform email address to "prvs" scheme to use
3898 as BATV-signed return path */
3905 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3907 case 1: goto EXPAND_FAILED_CURLY;
3909 case 3: goto EXPAND_FAILED;
3912 /* If skipping, we don't actually do anything */
3913 if (skipping) continue;
3915 /* sub_arg[0] is the address */
3916 domain = Ustrrchr(sub_arg[0],'@');
3917 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3919 expand_string_message = US"prvs first argument must be a qualified email address";
3923 /* Calculate the hash. The second argument must be a single-digit
3924 key number, or unset. */
3926 if (sub_arg[2] != NULL &&
3927 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3929 expand_string_message = US"prvs second argument must be a single digit";
3933 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3936 expand_string_message = US"prvs hmac-sha1 conversion failed";
3940 /* Now separate the domain from the local part */
3943 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3944 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3945 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3946 string_cat(yield,&size,&ptr,p,6);
3947 string_cat(yield,&size,&ptr,US"=",1);
3948 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3949 string_cat(yield,&size,&ptr,US"@",1);
3950 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3955 /* Check a prvs-encoded address for validity */
3957 case EITEM_PRVSCHECK:
3960 int mysize = 0, myptr = 0;
3964 /* TF: Ugliness: We want to expand parameter 1 first, then set
3965 up expansion variables that are used in the expansion of
3966 parameter 2. So we clone the string for the first
3967 expansion, where we only expand parameter 1.
3969 PH: Actually, that isn't necessary. The read_subs() function is
3970 designed to work this way for the ${if and ${lookup expansions. I've
3974 /* Reset expansion variables */
3975 prvscheck_result = NULL;
3976 prvscheck_address = NULL;
3977 prvscheck_keynum = NULL;
3979 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3981 case 1: goto EXPAND_FAILED_CURLY;
3983 case 3: goto EXPAND_FAILED;
3986 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
3989 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3991 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
3992 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
3993 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
3994 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
3995 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3997 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3998 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3999 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4000 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4001 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4003 /* Set up expansion variables */
4004 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4005 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4006 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4007 prvscheck_address[myptr] = '\0';
4008 prvscheck_keynum = string_copy(key_num);
4010 /* Now expand the second argument */
4011 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4013 case 1: goto EXPAND_FAILED_CURLY;
4015 case 3: goto EXPAND_FAILED;
4018 /* Now we have the key and can check the address. */
4020 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4025 expand_string_message = US"hmac-sha1 conversion failed";
4029 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4030 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4032 if (Ustrcmp(p,hash) == 0)
4034 /* Success, valid BATV address. Now check the expiry date. */
4035 uschar *now = prvs_daystamp(0);
4036 unsigned int inow = 0,iexpire = 1;
4038 (void)sscanf(CS now,"%u",&inow);
4039 (void)sscanf(CS daystamp,"%u",&iexpire);
4041 /* When "iexpire" is < 7, a "flip" has occured.
4042 Adjust "inow" accordingly. */
4043 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4045 if (iexpire >= inow)
4047 prvscheck_result = US"1";
4048 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4052 prvscheck_result = NULL;
4053 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4058 prvscheck_result = NULL;
4059 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4062 /* Now expand the final argument. We leave this till now so that
4063 it can include $prvscheck_result. */
4065 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4067 case 1: goto EXPAND_FAILED_CURLY;
4069 case 3: goto EXPAND_FAILED;
4072 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4073 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4075 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4077 /* Reset the "internal" variables afterwards, because they are in
4078 dynamic store that will be reclaimed if the expansion succeeded. */
4080 prvscheck_address = NULL;
4081 prvscheck_keynum = NULL;
4085 /* Does not look like a prvs encoded address, return the empty string.
4086 We need to make sure all subs are expanded first, so as to skip over
4089 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4091 case 1: goto EXPAND_FAILED_CURLY;
4093 case 3: goto EXPAND_FAILED;
4100 /* Handle "readfile" to insert an entire file */
4102 case EITEM_READFILE:
4107 if ((expand_forbid & RDO_READFILE) != 0)
4109 expand_string_message = US"file insertions are not permitted";
4113 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4115 case 1: goto EXPAND_FAILED_CURLY;
4117 case 3: goto EXPAND_FAILED;
4120 /* If skipping, we don't actually do anything */
4122 if (skipping) continue;
4124 /* Open the file and read it */
4126 f = Ufopen(sub_arg[0], "rb");
4129 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4133 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4138 /* Handle "readsocket" to insert data from a Unix domain socket */
4140 case EITEM_READSOCK:
4146 struct sockaddr_un sockun; /* don't call this "sun" ! */
4150 if ((expand_forbid & RDO_READSOCK) != 0)
4152 expand_string_message = US"socket insertions are not permitted";
4156 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4157 because there may be a string for expansion on failure. */
4159 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4161 case 1: goto EXPAND_FAILED_CURLY;
4162 case 2: /* Won't occur: no end check */
4163 case 3: goto EXPAND_FAILED;
4166 /* Sort out timeout, if given */
4168 if (sub_arg[2] != NULL)
4170 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4173 expand_string_message = string_sprintf("bad time value %s",
4178 else sub_arg[3] = NULL; /* No eol if no timeout */
4180 /* If skipping, we don't actually do anything. Otherwise, arrange to
4181 connect to either an IP or a Unix socket. */
4185 /* Handle an IP (internet) domain */
4187 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4189 BOOL connected = FALSE;
4193 uschar *server_name = sub_arg[0] + 5;
4194 uschar *port_name = Ustrrchr(server_name, ':');
4196 /* Sort out the port */
4198 if (port_name == NULL)
4200 expand_string_message =
4201 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4204 *port_name++ = 0; /* Terminate server name */
4206 if (isdigit(*port_name))
4209 port = Ustrtol(port_name, &end, 0);
4210 if (end != port_name + Ustrlen(port_name))
4212 expand_string_message =
4213 string_sprintf("invalid port number %s", port_name);
4219 struct servent *service_info = getservbyname(CS port_name, "tcp");
4220 if (service_info == NULL)
4222 expand_string_message = string_sprintf("unknown port \"%s\"",
4226 port = ntohs(service_info->s_port);
4229 /* Sort out the server. */
4232 shost.address = NULL;
4236 namelen = Ustrlen(server_name);
4238 /* Anything enclosed in [] must be an IP address. */
4240 if (server_name[0] == '[' &&
4241 server_name[namelen - 1] == ']')
4243 server_name[namelen - 1] = 0;
4245 if (string_is_ip_address(server_name, NULL) == 0)
4247 expand_string_message =
4248 string_sprintf("malformed IP address \"%s\"", server_name);
4251 shost.name = shost.address = server_name;
4254 /* Otherwise check for an unadorned IP address */
4256 else if (string_is_ip_address(server_name, NULL) != 0)
4257 shost.name = shost.address = server_name;
4259 /* Otherwise lookup IP address(es) from the name */
4263 shost.name = server_name;
4264 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4265 FALSE) != HOST_FOUND)
4267 expand_string_message =
4268 string_sprintf("no IP address found for host %s", shost.name);
4273 /* Try to connect to the server - test each IP till one works */
4275 for (h = &shost; h != NULL; h = h->next)
4277 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4278 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4280 expand_string_message = string_sprintf("failed to create socket: "
4281 "%s", strerror(errno));
4285 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4294 expand_string_message = string_sprintf("failed to connect to "
4295 "socket %s: couldn't connect to any host", sub_arg[0],
4301 /* Handle a Unix domain socket */
4306 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4308 expand_string_message = string_sprintf("failed to create socket: %s",
4313 sockun.sun_family = AF_UNIX;
4314 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4317 sigalrm_seen = FALSE;
4319 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4323 expand_string_message = US "socket connect timed out";
4328 expand_string_message = string_sprintf("failed to connect to socket "
4329 "%s: %s", sub_arg[0], strerror(errno));
4334 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4336 /* Write the request string, if not empty */
4338 if (sub_arg[1][0] != 0)
4340 int len = Ustrlen(sub_arg[1]);
4341 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4343 if (write(fd, sub_arg[1], len) != len)
4345 expand_string_message = string_sprintf("request write to socket "
4346 "failed: %s", strerror(errno));
4351 /* Shut down the sending side of the socket. This helps some servers to
4352 recognise that it is their turn to do some work. Just in case some
4353 system doesn't have this function, make it conditional. */
4356 shutdown(fd, SHUT_WR);
4359 /* Now we need to read from the socket, under a timeout. The function
4360 that reads a file can be used. */
4362 f = fdopen(fd, "rb");
4363 sigalrm_seen = FALSE;
4365 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4369 /* After a timeout, we restore the pointer in the result, that is,
4370 make sure we add nothing from the socket. */
4375 expand_string_message = US "socket read timed out";
4380 /* The whole thing has worked (or we were skipping). If there is a
4381 failure string following, we need to skip it. */
4385 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4387 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4388 while (isspace(*s)) s++;
4390 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4393 /* Come here on failure to create socket, connect socket, write to the
4394 socket, or timeout on reading. If another substring follows, expand and
4395 use it. Otherwise, those conditions give expand errors. */
4398 if (*s != '{') goto EXPAND_FAILED;
4399 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4400 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4401 if (arg == NULL) goto EXPAND_FAILED;
4402 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4403 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4404 while (isspace(*s)) s++;
4405 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4409 /* Handle "run" to execute a program. */
4421 if ((expand_forbid & RDO_RUN) != 0)
4423 expand_string_message = US"running a command is not permitted";
4427 while (isspace(*s)) s++;
4428 if (*s != '{') goto EXPAND_FAILED_CURLY;
4429 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4430 if (arg == NULL) goto EXPAND_FAILED;
4431 while (isspace(*s)) s++;
4432 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4434 if (skipping) /* Just pretend it worked when we're skipping */
4440 if (!transport_set_up_command(&argv, /* anchor for arg list */
4441 arg, /* raw command */
4442 FALSE, /* don't expand the arguments */
4443 0, /* not relevant when... */
4444 NULL, /* no transporting address */
4445 US"${run} expansion", /* for error messages */
4446 &expand_string_message)) /* where to put error message */
4451 /* Create the child process, making it a group leader. */
4453 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4457 expand_string_message =
4458 string_sprintf("couldn't create child process: %s", strerror(errno));
4462 /* Nothing is written to the standard input. */
4466 /* Read the pipe to get the command's output into $value (which is kept
4467 in lookup_value). Read during execution, so that if the output exceeds
4468 the OS pipe buffer limit, we don't block forever. */
4470 f = fdopen(fd_out, "rb");
4471 sigalrm_seen = FALSE;
4473 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4477 /* Wait for the process to finish, applying the timeout, and inspect its
4478 return code for serious disasters. Simple non-zero returns are passed on.
4481 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4483 if (sigalrm_seen == TRUE || runrc == -256)
4485 expand_string_message = string_sprintf("command timed out");
4486 killpg(pid, SIGKILL); /* Kill the whole process group */
4489 else if (runrc == -257)
4490 expand_string_message = string_sprintf("wait() failed: %s",
4494 expand_string_message = string_sprintf("command killed by signal %d",
4501 /* Process the yes/no strings; $value may be useful in both cases */
4503 switch(process_yesno(
4504 skipping, /* were previously skipping */
4505 runrc == 0, /* success/failure indicator */
4506 lookup_value, /* value to reset for string2 */
4507 &s, /* input pointer */
4508 &yield, /* output pointer */
4509 &size, /* output size */
4510 &ptr, /* output current point */
4511 US"run")) /* condition type */
4513 case 1: goto EXPAND_FAILED; /* when all is well, the */
4514 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4520 /* Handle character translation for "tr" */
4528 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4530 case 1: goto EXPAND_FAILED_CURLY;
4532 case 3: goto EXPAND_FAILED;
4535 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4536 o2m = Ustrlen(sub[2]) - 1;
4538 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4540 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4544 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4551 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4552 expanded arguments. */
4562 int val[2] = { 0, -1 };
4565 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4566 Ensure that sub[2] is set in the ${length case. */
4569 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4572 case 1: goto EXPAND_FAILED_CURLY;
4574 case 3: goto EXPAND_FAILED;
4577 /* Juggle the arguments if there are only two of them: always move the
4578 string to the last position and make ${length{n}{str}} equivalent to
4579 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4585 if (item_type == EITEM_LENGTH)
4592 for (i = 0; i < 2; i++)
4594 if (sub[i] == NULL) continue;
4595 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4596 if (*ret != 0 || (i != 0 && val[i] < 0))
4598 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4599 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4605 (item_type == EITEM_HASH)?
4606 compute_hash(sub[2], val[0], val[1], &len) :
4607 (item_type == EITEM_NHASH)?
4608 compute_nhash(sub[2], val[0], val[1], &len) :
4609 extract_substr(sub[2], val[0], val[1], &len);
4611 if (ret == NULL) goto EXPAND_FAILED;
4612 yield = string_cat(yield, &size, &ptr, ret, len);
4616 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4617 This code originally contributed by Steve Haslam. It currently supports
4618 the use of MD5 and SHA-1 hashes.
4620 We need some workspace that is large enough to handle all the supported
4621 hash types. Use macros to set the sizes rather than be too elaborate. */
4623 #define MAX_HASHLEN 20
4624 #define MAX_HASHBLOCKLEN 64
4633 int hashlen; /* Number of octets for the hash algorithm's output */
4634 int hashblocklen; /* Number of octets the hash algorithm processes */
4636 unsigned int keylen;
4638 uschar keyhash[MAX_HASHLEN];
4639 uschar innerhash[MAX_HASHLEN];
4640 uschar finalhash[MAX_HASHLEN];
4641 uschar finalhash_hex[2*MAX_HASHLEN];
4642 uschar innerkey[MAX_HASHBLOCKLEN];
4643 uschar outerkey[MAX_HASHBLOCKLEN];
4645 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4647 case 1: goto EXPAND_FAILED_CURLY;
4649 case 3: goto EXPAND_FAILED;
4652 if (Ustrcmp(sub[0], "md5") == 0)
4655 use_base = &md5_base;
4659 else if (Ustrcmp(sub[0], "sha1") == 0)
4662 use_base = &sha1_base;
4668 expand_string_message =
4669 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4674 keylen = Ustrlen(keyptr);
4676 /* If the key is longer than the hash block length, then hash the key
4679 if (keylen > hashblocklen)
4681 chash_start(type, use_base);
4682 chash_end(type, use_base, keyptr, keylen, keyhash);
4687 /* Now make the inner and outer key values */
4689 memset(innerkey, 0x36, hashblocklen);
4690 memset(outerkey, 0x5c, hashblocklen);
4692 for (i = 0; i < keylen; i++)
4694 innerkey[i] ^= keyptr[i];
4695 outerkey[i] ^= keyptr[i];
4698 /* Now do the hashes */
4700 chash_start(type, use_base);
4701 chash_mid(type, use_base, innerkey);
4702 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4704 chash_start(type, use_base);
4705 chash_mid(type, use_base, outerkey);
4706 chash_end(type, use_base, innerhash, hashlen, finalhash);
4708 /* Encode the final hash as a hex string */
4711 for (i = 0; i < hashlen; i++)
4713 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4714 *p++ = hex_digits[finalhash[i] & 0x0f];
4717 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4718 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4720 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4725 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4726 We have to save the numerical variables and restore them afterwards. */
4731 int moffset, moffsetextra, slen;
4734 const uschar *rerror;
4737 int save_expand_nmax =
4738 save_expand_strings(save_expand_nstring, save_expand_nlength);
4740 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4742 case 1: goto EXPAND_FAILED_CURLY;
4744 case 3: goto EXPAND_FAILED;
4747 /* Compile the regular expression */
4749 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4754 expand_string_message = string_sprintf("regular expression error in "
4755 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4759 /* Now run a loop to do the substitutions as often as necessary. It ends
4760 when there are no more matches. Take care over matches of the null string;
4761 do the same thing as Perl does. */
4764 slen = Ustrlen(sub[0]);
4765 moffset = moffsetextra = 0;
4770 int ovector[3*(EXPAND_MAXN+1)];
4771 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4772 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4776 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4777 is not necessarily the end. We want to repeat the match from one
4778 character further along, but leaving the basic offset the same (for
4779 copying below). We can't be at the end of the string - that was checked
4780 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4781 finished; copy the remaining string and end the loop. */
4791 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4795 /* Match - set up for expanding the replacement. */
4797 if (n == 0) n = EXPAND_MAXN + 1;
4799 for (nn = 0; nn < n*2; nn += 2)
4801 expand_nstring[expand_nmax] = subject + ovector[nn];
4802 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4806 /* Copy the characters before the match, plus the expanded insertion. */
4808 yield = string_cat(yield, &size, &ptr, subject + moffset,
4809 ovector[0] - moffset);
4810 insert = expand_string(sub[2]);
4811 if (insert == NULL) goto EXPAND_FAILED;
4812 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4814 moffset = ovector[1];
4818 /* If we have matched an empty string, first check to see if we are at
4819 the end of the subject. If so, the loop is over. Otherwise, mimic
4820 what Perl's /g options does. This turns out to be rather cunning. First
4821 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4822 string at the same point. If this fails (picked up above) we advance to
4823 the next character. */
4825 if (ovector[0] == ovector[1])
4827 if (ovector[0] == slen) break;
4828 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4832 /* All done - restore numerical variables. */
4834 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4835 save_expand_nlength);
4839 /* Handle keyed and numbered substring extraction. If the first argument
4840 consists entirely of digits, then a numerical extraction is assumed. */
4846 int field_number = 1;
4847 BOOL field_number_set = FALSE;
4848 uschar *save_lookup_value = lookup_value;
4850 int save_expand_nmax =
4851 save_expand_strings(save_expand_nstring, save_expand_nlength);
4853 /* Read the arguments */
4855 for (i = 0; i < j; i++)
4857 while (isspace(*s)) s++;
4860 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4861 if (sub[i] == NULL) goto EXPAND_FAILED;
4862 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4864 /* After removal of leading and trailing white space, the first
4865 argument must not be empty; if it consists entirely of digits
4866 (optionally preceded by a minus sign), this is a numerical
4867 extraction, and we expect 3 arguments. */
4875 while (isspace(*p)) p++;
4879 while (len > 0 && isspace(p[len-1])) len--;
4882 if (*p == 0 && !skipping)
4884 expand_string_message = US"first argument of \"extract\" must "
4894 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4898 j = 3; /* Need 3 args */
4899 field_number_set = TRUE;
4903 else goto EXPAND_FAILED_CURLY;
4906 /* Extract either the numbered or the keyed substring into $value. If
4907 skipping, just pretend the extraction failed. */
4909 lookup_value = skipping? NULL : field_number_set?
4910 expand_gettokened(field_number, sub[1], sub[2]) :
4911 expand_getkeyed(sub[0], sub[1]);
4913 /* If no string follows, $value gets substituted; otherwise there can
4914 be yes/no strings, as for lookup or if. */
4916 switch(process_yesno(
4917 skipping, /* were previously skipping */
4918 lookup_value != NULL, /* success/failure indicator */
4919 save_lookup_value, /* value to reset for string2 */
4920 &s, /* input pointer */
4921 &yield, /* output pointer */
4922 &size, /* output size */
4923 &ptr, /* output current point */
4924 US"extract")) /* condition type */
4926 case 1: goto EXPAND_FAILED; /* when all is well, the */
4927 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4930 /* All done - restore numerical variables. */
4932 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4933 save_expand_nlength);
4939 /* Handle list operations */
4947 uschar outsep[2] = { '\0', '\0' };
4948 uschar *list, *expr, *temp;
4949 uschar *save_iterate_item = iterate_item;
4950 uschar *save_lookup_value = lookup_value;
4952 while (isspace(*s)) s++;
4953 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4955 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
4956 if (list == NULL) goto EXPAND_FAILED;
4957 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4959 if (item_type == EITEM_REDUCE)
4961 while (isspace(*s)) s++;
4962 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4963 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
4964 if (temp == NULL) goto EXPAND_FAILED;
4965 lookup_value = temp;
4966 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4969 while (isspace(*s)) s++;
4970 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4974 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
4975 if scanning a "false" part). This allows us to find the end of the
4976 condition, because if the list is empty, we won't actually evaluate the
4977 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
4978 the normal internal expansion function. */
4980 if (item_type == EITEM_FILTER)
4982 temp = eval_condition(expr, NULL);
4983 if (temp != NULL) s = temp;
4987 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
4992 expand_string_message = string_sprintf("%s inside \"%s\" item",
4993 expand_string_message, name);
4997 while (isspace(*s)) s++;
5000 expand_string_message = string_sprintf("missing } at end of condition "
5001 "or expression inside \"%s\"", name);
5005 while (isspace(*s)) s++;
5008 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5013 /* If we are skipping, we can now just move on to the next item. When
5014 processing for real, we perform the iteration. */
5016 if (skipping) continue;
5017 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5019 *outsep = (uschar)sep; /* Separator as a string */
5021 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5023 if (item_type == EITEM_FILTER)
5026 if (eval_condition(expr, &condresult) == NULL)
5028 iterate_item = save_iterate_item;
5029 lookup_value = save_lookup_value;
5030 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5031 expand_string_message, name);
5034 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5035 condresult? "true":"false");
5037 temp = iterate_item; /* TRUE => include this item */
5039 continue; /* FALSE => skip this item */
5042 /* EITEM_MAP and EITEM_REDUCE */
5046 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5049 iterate_item = save_iterate_item;
5050 expand_string_message = string_sprintf("%s inside \"%s\" item",
5051 expand_string_message, name);
5054 if (item_type == EITEM_REDUCE)
5056 lookup_value = temp; /* Update the value of $value */
5057 continue; /* and continue the iteration */
5061 /* We reach here for FILTER if the condition is true, always for MAP,
5062 and never for REDUCE. The value in "temp" is to be added to the output
5063 list that is being created, ensuring that any occurrences of the
5064 separator character are doubled. Unless we are dealing with the first
5065 item of the output list, add in a space if the new item begins with the
5066 separator character, or is an empty string. */
5068 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5069 yield = string_cat(yield, &size, &ptr, US" ", 1);
5071 /* Add the string in "temp" to the output list that we are building,
5072 This is done in chunks by searching for the separator character. */
5076 size_t seglen = Ustrcspn(temp, outsep);
5077 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5079 /* If we got to the end of the string we output one character
5080 too many; backup and end the loop. Otherwise arrange to double the
5083 if (temp[seglen] == '\0') { ptr--; break; }
5084 yield = string_cat(yield, &size, &ptr, outsep, 1);
5088 /* Output a separator after the string: we will remove the redundant
5089 final one at the end. */
5091 yield = string_cat(yield, &size, &ptr, outsep, 1);
5092 } /* End of iteration over the list loop */
5094 /* REDUCE has generated no output above: output the final value of
5097 if (item_type == EITEM_REDUCE)
5099 yield = string_cat(yield, &size, &ptr, lookup_value,
5100 Ustrlen(lookup_value));
5101 lookup_value = save_lookup_value; /* Restore $value */
5104 /* FILTER and MAP generate lists: if they have generated anything, remove
5105 the redundant final separator. Even though an empty item at the end of a
5106 list does not count, this is tidier. */
5108 else if (ptr != save_ptr) ptr--;
5110 /* Restore preserved $item */
5112 iterate_item = save_iterate_item;
5117 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5118 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5119 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5120 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5122 #define EXPAND_DLFUNC_MAX_ARGS 8
5125 #ifndef EXPAND_DLFUNC
5126 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5127 "is not included in this binary";
5130 #else /* EXPAND_DLFUNC */
5133 exim_dlfunc_t *func;
5136 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5138 if ((expand_forbid & RDO_DLFUNC) != 0)
5140 expand_string_message =
5141 US"dynamically-loaded functions are not permitted";
5145 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5148 case 1: goto EXPAND_FAILED_CURLY;
5150 case 3: goto EXPAND_FAILED;
5153 /* If skipping, we don't actually do anything */
5155 if (skipping) continue;
5157 /* Look up the dynamically loaded object handle in the tree. If it isn't
5158 found, dlopen() the file and put the handle in the tree for next time. */
5160 t = tree_search(dlobj_anchor, argv[0]);
5163 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5166 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5167 argv[0], dlerror());
5168 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5171 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5172 Ustrcpy(t->name, argv[0]);
5173 t->data.ptr = handle;
5174 (void)tree_insertnode(&dlobj_anchor, t);
5177 /* Having obtained the dynamically loaded object handle, look up the
5178 function pointer. */
5180 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5183 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5184 "%s", argv[1], argv[0], dlerror());
5185 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5189 /* Call the function and work out what to do with the result. If it
5190 returns OK, we have a replacement string; if it returns DEFER then
5191 expansion has failed in a non-forced manner; if it returns FAIL then
5192 failure was forced; if it returns ERROR or any other value there's a
5193 problem, so panic slightly. In any case, assume that the function has
5194 side-effects on the store that must be preserved. */
5198 for (argc = 0; argv[argc] != NULL; argc++);
5199 status = func(&result, argc - 2, &argv[2]);
5202 if (result == NULL) result = US"";
5203 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5208 expand_string_message = result == NULL ? US"(no message)" : result;
5209 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5210 else if(status != FAIL)
5211 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5212 argv[0], argv[1], status, expand_string_message);
5216 #endif /* EXPAND_DLFUNC */
5219 /* Control reaches here if the name is not recognized as one of the more
5220 complicated expansion items. Check for the "operator" syntax (name terminated
5221 by a colon). Some of the operators have arguments, separated by _ from the
5228 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5229 if (sub == NULL) goto EXPAND_FAILED;
5232 /* Owing to an historical mis-design, an underscore may be part of the
5233 operator name, or it may introduce arguments. We therefore first scan the
5234 table of names that contain underscores. If there is no match, we cut off
5235 the arguments and then scan the main table. */
5237 c = chop_match(name, op_table_underscore,
5238 sizeof(op_table_underscore)/sizeof(uschar *));
5242 arg = Ustrchr(name, '_');
5243 if (arg != NULL) *arg = 0;
5244 c = chop_match(name, op_table_main,
5245 sizeof(op_table_main)/sizeof(uschar *));
5246 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5247 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5250 /* If we are skipping, we don't need to perform the operation at all.
5251 This matters for operations like "mask", because the data may not be
5252 in the correct format when skipping. For example, the expression may test
5253 for the existence of $sender_host_address before trying to mask it. For
5254 other operations, doing them may not fail, but it is a waste of time. */
5256 if (skipping && c >= 0) continue;
5258 /* Otherwise, switch on the operator type */
5265 unsigned long int n = Ustrtoul(sub, &t, 10);
5268 expand_string_message = string_sprintf("argument for base62 "
5269 "operator is \"%s\", which is not a decimal number", sub);
5272 t = string_base62(n);
5273 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5277 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5283 unsigned long int n = 0;
5286 uschar *t = Ustrchr(base62_chars, *tt++);
5289 expand_string_message = string_sprintf("argument for base62d "
5290 "operator is \"%s\", which is not a base %d number", sub,
5294 n = n * BASE_62 + (t - base62_chars);
5296 (void)sprintf(CS buf, "%ld", n);
5297 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5303 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5304 if (expanded == NULL)
5306 expand_string_message =
5307 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5308 expand_string_message);
5311 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5318 uschar *t = sub - 1;
5319 while (*(++t) != 0) { *t = tolower(*t); count++; }
5320 yield = string_cat(yield, &size, &ptr, sub, count);
5327 uschar *t = sub - 1;
5328 while (*(++t) != 0) { *t = toupper(*t); count++; }
5329 yield = string_cat(yield, &size, &ptr, sub, count);
5340 md5_end(&base, sub, Ustrlen(sub), digest);
5341 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5342 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5353 sha1_end(&base, sub, Ustrlen(sub), digest);
5354 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5355 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5359 /* Convert hex encoding to base64 encoding */
5369 for (enc = sub; *enc != 0; enc++)
5371 if (!isxdigit(*enc))
5373 expand_string_message = string_sprintf("\"%s\" is not a hex "
5382 expand_string_message = string_sprintf("\"%s\" contains an odd "
5383 "number of characters", sub);
5387 while ((c = *in++) != 0)
5389 if (isdigit(c)) c -= '0';
5390 else c = toupper(c) - 'A' + 10;
5402 enc = auth_b64encode(sub, out - sub);
5403 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5407 /* mask applies a mask to an IP address; for example the result of
5408 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5415 int mask, maskoffset;
5416 int type = string_is_ip_address(sub, &maskoffset);
5421 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5426 if (maskoffset == 0)
5428 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5433 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5435 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5437 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5442 /* Convert the address to binary integer(s) and apply the mask */
5444 sub[maskoffset] = 0;
5445 count = host_aton(sub, binary);
5446 host_mask(count, binary, mask);
5448 /* Convert to masked textual format and add to output. */
5450 yield = string_cat(yield, &size, &ptr, buffer,
5451 host_nmtoa(count, binary, mask, buffer, '.'));
5456 case EOP_LOCAL_PART:
5460 int start, end, domain;
5461 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5465 if (c != EOP_DOMAIN)
5467 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5468 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5470 else if (domain != 0)
5473 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5481 uschar outsep[2] = { ':', '\0' };
5482 uschar *address, *error;
5484 int start, end, domain; /* Not really used */
5486 while (isspace(*sub)) sub++;
5487 if (*sub == '>') { *outsep = *++sub; ++sub; }
5488 parse_allow_group = TRUE;
5492 uschar *p = parse_find_address_end(sub, FALSE);
5493 uschar saveend = *p;
5495 address = parse_extract_address(sub, &error, &start, &end, &domain,
5499 /* Add the address to the output list that we are building. This is
5500 done in chunks by searching for the separator character. At the
5501 start, unless we are dealing with the first address of the output
5502 list, add in a space if the new address begins with the separator
5503 character, or is an empty string. */
5505 if (address != NULL)
5507 if (ptr != save_ptr && address[0] == *outsep)
5508 yield = string_cat(yield, &size, &ptr, US" ", 1);
5512 size_t seglen = Ustrcspn(address, outsep);
5513 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5515 /* If we got to the end of the string we output one character
5518 if (address[seglen] == '\0') { ptr--; break; }
5519 yield = string_cat(yield, &size, &ptr, outsep, 1);
5520 address += seglen + 1;
5523 /* Output a separator after the string: we will remove the
5524 redundant final one at the end. */
5526 yield = string_cat(yield, &size, &ptr, outsep, 1);
5529 if (saveend == '\0') break;
5533 /* If we have generated anything, remove the redundant final
5536 if (ptr != save_ptr) ptr--;
5537 parse_allow_group = FALSE;
5542 /* quote puts a string in quotes if it is empty or contains anything
5543 other than alphamerics, underscore, dot, or hyphen.
5545 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5546 be quoted in order to be a valid local part.
5548 In both cases, newlines and carriage returns are converted into \n and \r
5552 case EOP_QUOTE_LOCAL_PART:
5555 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5556 uschar *t = sub - 1;
5560 while (!needs_quote && *(++t) != 0)
5561 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5563 else /* EOP_QUOTE_LOCAL_PART */
5565 while (!needs_quote && *(++t) != 0)
5566 needs_quote = !isalnum(*t) &&
5567 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5568 (*t != '.' || t == sub || t[1] == 0);
5573 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5578 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5579 else if (*t == '\r')
5580 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5583 if (*t == '\\' || *t == '"')
5584 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5585 yield = string_cat(yield, &size, &ptr, t, 1);
5588 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5590 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5594 /* quote_lookuptype does lookup-specific quoting */
5599 uschar *opt = Ustrchr(arg, '_');
5601 if (opt != NULL) *opt++ = 0;
5603 n = search_findtype(arg, Ustrlen(arg));
5606 expand_string_message = search_error_message;
5610 if (lookup_list[n]->quote != NULL)
5611 sub = (lookup_list[n]->quote)(sub, opt);
5612 else if (opt != NULL) sub = NULL;
5616 expand_string_message = string_sprintf(
5617 "\"%s\" unrecognized after \"${quote_%s\"",
5622 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5626 /* rx quote sticks in \ before any non-alphameric character so that
5627 the insertion works in a regular expression. */
5631 uschar *t = sub - 1;
5635 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5636 yield = string_cat(yield, &size, &ptr, t, 1);
5641 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5642 prescribed by the RFC, if there are characters that need to be encoded */
5646 uschar buffer[2048];
5647 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5648 buffer, sizeof(buffer), FALSE);
5649 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5653 /* RFC 2047 decode */
5659 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5660 headers_charset, '?', &len, &error);
5663 expand_string_message = error;
5666 yield = string_cat(yield, &size, &ptr, decoded, len);
5670 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5680 if (c > 255) c = '_';
5682 yield = string_cat(yield, &size, &ptr, buff, 1);
5687 /* escape turns all non-printing characters into escape sequences. */
5691 uschar *t = string_printing(sub);
5692 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5696 /* Handle numeric expression evaluation */
5701 uschar *save_sub = sub;
5702 uschar *error = NULL;
5703 int64_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5706 expand_string_message = string_sprintf("error in expression "
5707 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5711 sprintf(CS var_buffer, "%lld", n);
5712 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5716 /* Handle time period formating */
5720 int n = readconf_readtime(sub, 0, FALSE);
5723 expand_string_message = string_sprintf("string \"%s\" is not an "
5724 "Exim time interval in \"%s\" operator", sub, name);
5727 sprintf(CS var_buffer, "%d", n);
5728 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5732 case EOP_TIME_INTERVAL:
5735 uschar *t = read_number(&n, sub);
5736 if (*t != 0) /* Not A Number*/
5738 expand_string_message = string_sprintf("string \"%s\" is not a "
5739 "positive number in \"%s\" operator", sub, name);
5742 t = readconf_printtime(n);
5743 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5747 /* Convert string to base64 encoding */
5751 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5752 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5756 /* strlen returns the length of the string */
5761 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5762 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5766 /* length_n or l_n takes just the first n characters or the whole string,
5767 whichever is the shorter;
5769 substr_m_n, and s_m_n take n characters from offset m; negative m take
5770 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5771 takes the rest, either to the right or to the left.
5773 hash_n or h_n makes a hash of length n from the string, yielding n
5774 characters from the set a-z; hash_n_m makes a hash of length n, but
5775 uses m characters from the set a-zA-Z0-9.
5777 nhash_n returns a single number between 0 and n-1 (in text form), while
5778 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5779 between 0 and n-1 and the second between 0 and m-1. */
5799 expand_string_message = string_sprintf("missing values after %s",
5804 /* "length" has only one argument, effectively being synonymous with
5807 if (c == EOP_LENGTH || c == EOP_L)
5813 /* The others have one or two arguments; for "substr" the first may be
5814 negative. The second being negative means "not supplied". */
5819 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5822 /* Read up to two numbers, separated by underscores */
5827 if (arg != ret && *arg == '_' && pn == &value1)
5831 if (arg[1] != 0) arg++;
5833 else if (!isdigit(*arg))
5835 expand_string_message =
5836 string_sprintf("non-digit after underscore in \"%s\"", name);
5839 else *pn = (*pn)*10 + *arg++ - '0';
5843 /* Perform the required operation */
5846 (c == EOP_HASH || c == EOP_H)?
5847 compute_hash(sub, value1, value2, &len) :
5848 (c == EOP_NHASH || c == EOP_NH)?
5849 compute_nhash(sub, value1, value2, &len) :
5850 extract_substr(sub, value1, value2, &len);
5852 if (ret == NULL) goto EXPAND_FAILED;
5853 yield = string_cat(yield, &size, &ptr, ret, len);
5863 uschar **modetable[3];
5868 if ((expand_forbid & RDO_EXISTS) != 0)
5870 expand_string_message = US"Use of the stat() expansion is not permitted";
5874 if (stat(CS sub, &st) < 0)
5876 expand_string_message = string_sprintf("stat(%s) failed: %s",
5877 sub, strerror(errno));
5881 switch (mode & S_IFMT)
5883 case S_IFIFO: smode[0] = 'p'; break;
5884 case S_IFCHR: smode[0] = 'c'; break;
5885 case S_IFDIR: smode[0] = 'd'; break;
5886 case S_IFBLK: smode[0] = 'b'; break;
5887 case S_IFREG: smode[0] = '-'; break;
5888 default: smode[0] = '?'; break;
5891 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5892 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5893 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5895 for (i = 0; i < 3; i++)
5897 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5902 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5903 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5904 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5905 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5906 (long)st.st_gid, st.st_size, (long)st.st_atime,
5907 (long)st.st_mtime, (long)st.st_ctime);
5908 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5912 /* pseudo-random number less than N */
5919 max = expand_string_integer(sub, TRUE);
5920 if (expand_string_message != NULL)
5922 s = string_sprintf("%d", pseudo_random_number((int)max));
5923 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5927 /* Reverse IP, including IPv6 to dotted-nibble */
5929 case EOP_REVERSE_IP:
5931 int family, maskptr;
5932 uschar reversed[128];
5934 family = string_is_ip_address(sub, &maskptr);
5937 expand_string_message = string_sprintf(
5938 "reverse_ip() not given an IP address [%s]", sub);
5941 invert_address(reversed, sub);
5942 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
5946 /* Unknown operator */
5949 expand_string_message =
5950 string_sprintf("unknown expansion operator \"%s\"", name);
5955 /* Handle a plain name. If this is the first thing in the expansion, release
5956 the pre-allocated buffer. If the result data is known to be in a new buffer,
5957 newsize will be set to the size of that buffer, and we can just point at that
5958 store instead of copying. Many expansion strings contain just one reference,
5959 so this is a useful optimization, especially for humungous headers
5960 ($message_headers). */
5968 if (resetok) store_reset(yield);
5972 value = find_variable(name, FALSE, skipping, &newsize);
5975 expand_string_message =
5976 string_sprintf("unknown variable in \"${%s}\"", name);
5977 check_variable_error_message(name);
5980 len = Ustrlen(value);
5981 if (yield == NULL && newsize != 0)
5987 else yield = string_cat(yield, &size, &ptr, value, len);
5991 /* Else there's something wrong */
5993 expand_string_message =
5994 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5995 "in a variable reference)", name);
5999 /* If we hit the end of the string when ket_ends is set, there is a missing
6000 terminating brace. */
6002 if (ket_ends && *s == 0)
6004 expand_string_message = malformed_header?
6005 US"missing } at end of string - could be header name not terminated by colon"
6007 US"missing } at end of string";
6011 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6012 added to the string. If so, set up an empty string. Add a terminating zero. If
6013 left != NULL, return a pointer to the terminator. */
6015 if (yield == NULL) yield = store_get(1);
6017 if (left != NULL) *left = s;
6019 /* Any stacking store that was used above the final string is no longer needed.
6020 In many cases the final string will be the first one that was got and so there
6021 will be optimal store usage. */
6023 if (resetok) store_reset(yield + ptr + 1);
6026 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6028 if (skipping) debug_printf("skipping: result is not used\n");
6032 /* This is the failure exit: easiest to program with a goto. We still need
6033 to update the pointer to the terminator, for cases of nested calls with "fail".
6036 EXPAND_FAILED_CURLY:
6037 expand_string_message = malformed_header?
6038 US"missing or misplaced { or } - could be header name not terminated by colon"
6040 US"missing or misplaced { or }";
6042 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6043 that is a bad idea, because expand_string_message is in dynamic store. */
6046 if (left != NULL) *left = s;
6049 debug_printf("failed to expand: %s\n", string);
6050 debug_printf(" error message: %s\n", expand_string_message);
6051 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6057 /* This is the external function call. Do a quick check for any expansion
6058 metacharacters, and if there are none, just return the input string.
6060 Argument: the string to be expanded
6061 Returns: the expanded string, or NULL if expansion failed; if failure was
6062 due to a lookup deferring, search_find_defer will be TRUE
6066 expand_string(uschar *string)
6068 search_find_defer = FALSE;
6069 malformed_header = FALSE;
6070 return (Ustrpbrk(string, "$\\") == NULL)? string :
6071 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6076 /*************************************************
6078 *************************************************/
6080 /* Now and again we want to expand a string and be sure that the result is in a
6081 new bit of store. This function does that.
6083 Argument: the string to be expanded
6084 Returns: the expanded string, always in a new bit of store, or NULL
6088 expand_string_copy(uschar *string)
6090 uschar *yield = expand_string(string);
6091 if (yield == string) yield = string_copy(string);
6097 /*************************************************
6098 * Expand and interpret as an integer *
6099 *************************************************/
6101 /* Expand a string, and convert the result into an integer.
6104 string the string to be expanded
6105 isplus TRUE if a non-negative number is expected
6107 Returns: the integer value, or
6108 -1 for an expansion error ) in both cases, message in
6109 -2 for an integer interpretation error ) expand_string_message
6110 expand_string_message is set NULL for an OK integer
6114 expand_string_integer(uschar *string, BOOL isplus)
6117 uschar *s = expand_string(string);
6118 uschar *msg = US"invalid integer \"%s\"";
6121 /* If expansion failed, expand_string_message will be set. */
6123 if (s == NULL) return -1;
6125 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6126 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6127 systems, so we set it zero ourselves. */
6130 expand_string_message = NULL; /* Indicates no error */
6132 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6133 equal to 0. Unfortunately, people actually relied upon that, so preserve
6134 the behaviour explicitly. Stripping leading whitespace is a harmless
6135 noop change since strtol skips it anyway (provided that there is a number
6139 while (isspace(*s)) ++s;
6143 debug_printf("treating blank string as number 0\n");
6148 value = strtoll(CS s, CSS &endptr, 10);
6152 msg = US"integer expected but \"%s\" found";
6154 else if (value < 0 && isplus)
6156 msg = US"non-negative integer expected but \"%s\" found";
6160 if (tolower(*endptr) == 'k')
6162 if (value > LLONG_MAX/1024 || value < LLONG_MIN/1024) errno = ERANGE;
6166 else if (tolower(*endptr) == 'm')
6168 if (value > LLONG_MAX/(1024*1024) || value < LLONG_MIN/(1024*1024))
6170 else value *= 1024*1024;
6173 if (errno == ERANGE)
6174 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6177 while (isspace(*endptr)) endptr++;
6178 if (*endptr == 0) return (int)value;
6182 expand_string_message = string_sprintf(CS msg, s);
6187 /*************************************************
6188 **************************************************
6189 * Stand-alone test program *
6190 **************************************************
6191 *************************************************/
6197 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6199 int ovector[3*(EXPAND_MAXN+1)];
6200 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6201 ovector, sizeof(ovector)/sizeof(int));
6202 BOOL yield = n >= 0;
6203 if (n == 0) n = EXPAND_MAXN + 1;
6207 expand_nmax = (setup < 0)? 0 : setup + 1;
6208 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6210 expand_nstring[expand_nmax] = subject + ovector[nn];
6211 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6219 int main(int argc, uschar **argv)
6222 uschar buffer[1024];
6224 debug_selector = D_v;
6225 debug_file = stderr;
6226 debug_fd = fileno(debug_file);
6227 big_buffer = malloc(big_buffer_size);
6229 for (i = 1; i < argc; i++)
6231 if (argv[i][0] == '+')
6233 debug_trace_memory = 2;
6236 if (isdigit(argv[i][0]))
6237 debug_selector = Ustrtol(argv[i], NULL, 0);
6239 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6243 eldap_default_servers = argv[i];
6246 mysql_servers = argv[i];
6249 pgsql_servers = argv[i];
6253 else opt_perl_startup = argv[i];
6257 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6259 expand_nstring[1] = US"string 1....";
6260 expand_nlength[1] = 8;
6264 if (opt_perl_startup != NULL)
6267 printf("Starting Perl interpreter\n");
6268 errstr = init_perl(opt_perl_startup);
6271 printf("** error in perl_startup code: %s\n", errstr);
6272 return EXIT_FAILURE;
6275 #endif /* EXIM_PERL */
6277 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6279 void *reset_point = store_get(0);
6280 uschar *yield = expand_string(buffer);
6283 printf("%s\n", yield);
6284 store_reset(reset_point);
6288 if (search_find_defer) printf("search_find deferred\n");
6289 printf("Failed: %s\n", expand_string_message);
6290 if (expand_string_forcedfail) printf("Forced failure\n");
6302 /* End of expand.c */