1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
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[] = {
150 /* Tables of operator names, and corresponding switch numbers. The names must be
151 in alphabetical order. There are two tables, because underscore is used in some
152 cases to introduce arguments, whereas for other it is part of the name. This is
153 an historical mis-design. */
155 static uschar *op_table_underscore[] = {
158 US"quote_local_part",
166 EOP_QUOTE_LOCAL_PART,
171 static uschar *op_table_main[] = {
207 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
242 /* Table of condition names, and corresponding switch numbers. The names must
243 be in alphabetical order. */
245 static uschar *cond_table[] = {
249 US"==", /* Backward compatibility */
281 US"match_local_part",
305 ECOND_FIRST_DELIVERY,
326 ECOND_MATCH_LOCAL_PART,
336 /* Type for main variable table */
344 /* Type for entries pointing to address/length pairs. Not currently
352 /* Types of table entry */
355 vtype_int, /* value is address of int */
356 vtype_filter_int, /* ditto, but recognized only when filtering */
357 vtype_ino, /* value is address of ino_t (not always an int) */
358 vtype_uid, /* value is address of uid_t (not always an int) */
359 vtype_gid, /* value is address of gid_t (not always an int) */
360 vtype_bool, /* value is address of bool */
361 vtype_stringptr, /* value is address of pointer to string */
362 vtype_msgbody, /* as stringptr, but read when first required */
363 vtype_msgbody_end, /* ditto, the end of the message */
364 vtype_msgheaders, /* the message's headers, processed */
365 vtype_msgheaders_raw, /* the message's headers, unprocessed */
366 vtype_localpart, /* extract local part from string */
367 vtype_domain, /* extract domain from string */
368 vtype_recipients, /* extract recipients from recipients list */
369 /* (available only in system filters, ACLs, and */
371 vtype_todbsdin, /* value not used; generate BSD inbox tod */
372 vtype_tode, /* value not used; generate tod in epoch format */
373 vtype_todel, /* value not used; generate tod in epoch/usec format */
374 vtype_todf, /* value not used; generate full tod */
375 vtype_todl, /* value not used; generate log tod */
376 vtype_todlf, /* value not used; generate log file datestamp tod */
377 vtype_todzone, /* value not used; generate time zone only */
378 vtype_todzulu, /* value not used; generate zulu tod */
379 vtype_reply, /* value not used; get reply from headers */
380 vtype_pid, /* value not used; result is pid */
381 vtype_host_lookup, /* value not used; get host name */
382 vtype_load_avg, /* value not used; result is int from os_getloadavg */
383 vtype_pspace, /* partition space; value is T/F for spool/log */
384 vtype_pinodes /* partition inodes; value is T/F for spool/log */
386 ,vtype_dkim /* Lookup of value in DKIM signature */
390 /* This table must be kept in alphabetical order. */
392 static var_entry var_table[] = {
393 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
394 they will be confused with user-creatable ACL variables. */
395 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
396 { "address_data", vtype_stringptr, &deliver_address_data },
397 { "address_file", vtype_stringptr, &address_file },
398 { "address_pipe", vtype_stringptr, &address_pipe },
399 { "authenticated_id", vtype_stringptr, &authenticated_id },
400 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
401 { "authentication_failed",vtype_int, &authentication_failed },
402 #ifdef WITH_CONTENT_SCAN
403 { "av_failed", vtype_int, &av_failed },
405 #ifdef EXPERIMENTAL_BRIGHTMAIL
406 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
407 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
408 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
409 { "bmi_deliver", vtype_int, &bmi_deliver },
411 { "body_linecount", vtype_int, &body_linecount },
412 { "body_zerocount", vtype_int, &body_zerocount },
413 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
414 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
415 { "caller_gid", vtype_gid, &real_gid },
416 { "caller_uid", vtype_uid, &real_uid },
417 { "compile_date", vtype_stringptr, &version_date },
418 { "compile_number", vtype_stringptr, &version_cnumber },
419 { "csa_status", vtype_stringptr, &csa_status },
420 #ifdef EXPERIMENTAL_DCC
421 { "dcc_header", vtype_stringptr, &dcc_header },
422 { "dcc_result", vtype_stringptr, &dcc_result },
424 #ifdef WITH_OLD_DEMIME
425 { "demime_errorlevel", vtype_int, &demime_errorlevel },
426 { "demime_reason", vtype_stringptr, &demime_reason },
429 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
430 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
431 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
432 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
433 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
434 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
435 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
436 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
437 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
438 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
439 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
440 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
441 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
442 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
443 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
444 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
445 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
446 { "dkim_signers", vtype_stringptr, &dkim_signers },
447 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
448 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
450 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
451 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
452 { "dnslist_text", vtype_stringptr, &dnslist_text },
453 { "dnslist_value", vtype_stringptr, &dnslist_value },
454 { "domain", vtype_stringptr, &deliver_domain },
455 { "domain_data", vtype_stringptr, &deliver_domain_data },
456 { "exim_gid", vtype_gid, &exim_gid },
457 { "exim_path", vtype_stringptr, &exim_path },
458 { "exim_uid", vtype_uid, &exim_uid },
459 #ifdef WITH_OLD_DEMIME
460 { "found_extension", vtype_stringptr, &found_extension },
462 { "home", vtype_stringptr, &deliver_home },
463 { "host", vtype_stringptr, &deliver_host },
464 { "host_address", vtype_stringptr, &deliver_host_address },
465 { "host_data", vtype_stringptr, &host_data },
466 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
467 { "host_lookup_failed", vtype_int, &host_lookup_failed },
468 { "inode", vtype_ino, &deliver_inode },
469 { "interface_address", vtype_stringptr, &interface_address },
470 { "interface_port", vtype_int, &interface_port },
471 { "item", vtype_stringptr, &iterate_item },
473 { "ldap_dn", vtype_stringptr, &eldap_dn },
475 { "load_average", vtype_load_avg, NULL },
476 { "local_part", vtype_stringptr, &deliver_localpart },
477 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
478 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
479 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
480 { "local_scan_data", vtype_stringptr, &local_scan_data },
481 { "local_user_gid", vtype_gid, &local_user_gid },
482 { "local_user_uid", vtype_uid, &local_user_uid },
483 { "localhost_number", vtype_int, &host_number },
484 { "log_inodes", vtype_pinodes, (void *)FALSE },
485 { "log_space", vtype_pspace, (void *)FALSE },
486 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
487 #ifdef WITH_CONTENT_SCAN
488 { "malware_name", vtype_stringptr, &malware_name },
490 { "max_received_linelength", vtype_int, &max_received_linelength },
491 { "message_age", vtype_int, &message_age },
492 { "message_body", vtype_msgbody, &message_body },
493 { "message_body_end", vtype_msgbody_end, &message_body_end },
494 { "message_body_size", vtype_int, &message_body_size },
495 { "message_exim_id", vtype_stringptr, &message_id },
496 { "message_headers", vtype_msgheaders, NULL },
497 { "message_headers_raw", vtype_msgheaders_raw, NULL },
498 { "message_id", vtype_stringptr, &message_id },
499 { "message_linecount", vtype_int, &message_linecount },
500 { "message_size", vtype_int, &message_size },
501 #ifdef WITH_CONTENT_SCAN
502 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
503 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
504 { "mime_boundary", vtype_stringptr, &mime_boundary },
505 { "mime_charset", vtype_stringptr, &mime_charset },
506 { "mime_content_description", vtype_stringptr, &mime_content_description },
507 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
508 { "mime_content_id", vtype_stringptr, &mime_content_id },
509 { "mime_content_size", vtype_int, &mime_content_size },
510 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
511 { "mime_content_type", vtype_stringptr, &mime_content_type },
512 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
513 { "mime_filename", vtype_stringptr, &mime_filename },
514 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
515 { "mime_is_multipart", vtype_int, &mime_is_multipart },
516 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
517 { "mime_part_count", vtype_int, &mime_part_count },
519 { "n0", vtype_filter_int, &filter_n[0] },
520 { "n1", vtype_filter_int, &filter_n[1] },
521 { "n2", vtype_filter_int, &filter_n[2] },
522 { "n3", vtype_filter_int, &filter_n[3] },
523 { "n4", vtype_filter_int, &filter_n[4] },
524 { "n5", vtype_filter_int, &filter_n[5] },
525 { "n6", vtype_filter_int, &filter_n[6] },
526 { "n7", vtype_filter_int, &filter_n[7] },
527 { "n8", vtype_filter_int, &filter_n[8] },
528 { "n9", vtype_filter_int, &filter_n[9] },
529 { "original_domain", vtype_stringptr, &deliver_domain_orig },
530 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
531 { "originator_gid", vtype_gid, &originator_gid },
532 { "originator_uid", vtype_uid, &originator_uid },
533 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
534 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
535 { "pid", vtype_pid, NULL },
536 { "primary_hostname", vtype_stringptr, &primary_hostname },
537 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
538 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
539 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
540 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
541 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
542 { "rcpt_count", vtype_int, &rcpt_count },
543 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
544 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
545 { "received_count", vtype_int, &received_count },
546 { "received_for", vtype_stringptr, &received_for },
547 { "received_ip_address", vtype_stringptr, &interface_address },
548 { "received_port", vtype_int, &interface_port },
549 { "received_protocol", vtype_stringptr, &received_protocol },
550 { "received_time", vtype_int, &received_time },
551 { "recipient_data", vtype_stringptr, &recipient_data },
552 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
553 { "recipients", vtype_recipients, NULL },
554 { "recipients_count", vtype_int, &recipients_count },
555 #ifdef WITH_CONTENT_SCAN
556 { "regex_match_string", vtype_stringptr, ®ex_match_string },
558 { "reply_address", vtype_reply, NULL },
559 { "return_path", vtype_stringptr, &return_path },
560 { "return_size_limit", vtype_int, &bounce_return_size_limit },
561 { "runrc", vtype_int, &runrc },
562 { "self_hostname", vtype_stringptr, &self_hostname },
563 { "sender_address", vtype_stringptr, &sender_address },
564 { "sender_address_data", vtype_stringptr, &sender_address_data },
565 { "sender_address_domain", vtype_domain, &sender_address },
566 { "sender_address_local_part", vtype_localpart, &sender_address },
567 { "sender_data", vtype_stringptr, &sender_data },
568 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
569 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
570 { "sender_host_address", vtype_stringptr, &sender_host_address },
571 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
572 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
573 { "sender_host_name", vtype_host_lookup, NULL },
574 { "sender_host_port", vtype_int, &sender_host_port },
575 { "sender_ident", vtype_stringptr, &sender_ident },
576 { "sender_rate", vtype_stringptr, &sender_rate },
577 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
578 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
579 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
580 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
581 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
582 { "sending_port", vtype_int, &sending_port },
583 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
584 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
585 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
586 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
587 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
588 { "sn0", vtype_filter_int, &filter_sn[0] },
589 { "sn1", vtype_filter_int, &filter_sn[1] },
590 { "sn2", vtype_filter_int, &filter_sn[2] },
591 { "sn3", vtype_filter_int, &filter_sn[3] },
592 { "sn4", vtype_filter_int, &filter_sn[4] },
593 { "sn5", vtype_filter_int, &filter_sn[5] },
594 { "sn6", vtype_filter_int, &filter_sn[6] },
595 { "sn7", vtype_filter_int, &filter_sn[7] },
596 { "sn8", vtype_filter_int, &filter_sn[8] },
597 { "sn9", vtype_filter_int, &filter_sn[9] },
598 #ifdef WITH_CONTENT_SCAN
599 { "spam_bar", vtype_stringptr, &spam_bar },
600 { "spam_report", vtype_stringptr, &spam_report },
601 { "spam_score", vtype_stringptr, &spam_score },
602 { "spam_score_int", vtype_stringptr, &spam_score_int },
604 #ifdef EXPERIMENTAL_SPF
605 { "spf_guess", vtype_stringptr, &spf_guess },
606 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
607 { "spf_received", vtype_stringptr, &spf_received },
608 { "spf_result", vtype_stringptr, &spf_result },
609 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
611 { "spool_directory", vtype_stringptr, &spool_directory },
612 { "spool_inodes", vtype_pinodes, (void *)TRUE },
613 { "spool_space", vtype_pspace, (void *)TRUE },
614 #ifdef EXPERIMENTAL_SRS
615 { "srs_db_address", vtype_stringptr, &srs_db_address },
616 { "srs_db_key", vtype_stringptr, &srs_db_key },
617 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
618 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
619 { "srs_recipient", vtype_stringptr, &srs_recipient },
620 { "srs_status", vtype_stringptr, &srs_status },
622 { "thisaddress", vtype_stringptr, &filter_thisaddress },
624 /* The non-(in,out) variables are now deprecated */
625 { "tls_bits", vtype_int, &tls_in.bits },
626 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
627 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
629 { "tls_in_bits", vtype_int, &tls_in.bits },
630 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
631 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
632 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
633 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
634 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
636 { "tls_out_bits", vtype_int, &tls_out.bits },
637 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
638 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
639 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
640 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
641 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
644 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
645 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
646 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
649 { "tod_bsdinbox", vtype_todbsdin, NULL },
650 { "tod_epoch", vtype_tode, NULL },
651 { "tod_epoch_l", vtype_todel, NULL },
652 { "tod_full", vtype_todf, NULL },
653 { "tod_log", vtype_todl, NULL },
654 { "tod_logfile", vtype_todlf, NULL },
655 { "tod_zone", vtype_todzone, NULL },
656 { "tod_zulu", vtype_todzulu, NULL },
657 { "value", vtype_stringptr, &lookup_value },
658 { "version_number", vtype_stringptr, &version_string },
659 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
660 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
661 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
662 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
663 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
664 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
667 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
668 static uschar var_buffer[256];
669 static BOOL malformed_header;
671 /* For textual hashes */
673 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
674 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
677 enum { HMAC_MD5, HMAC_SHA1 };
679 /* For numeric hashes */
681 static unsigned int prime[] = {
682 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
683 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
684 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
686 /* For printing modes in symbolic form */
688 static uschar *mtable_normal[] =
689 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
691 static uschar *mtable_setid[] =
692 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
694 static uschar *mtable_sticky[] =
695 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
699 /*************************************************
700 * Tables for UTF-8 support *
701 *************************************************/
703 /* Table of the number of extra characters, indexed by the first character
704 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
707 static uschar utf8_table1[] = {
708 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
709 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
710 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
711 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
713 /* These are the masks for the data bits in the first byte of a character,
714 indexed by the number of additional bytes. */
716 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
718 /* Get the next UTF-8 character, advancing the pointer. */
720 #define GETUTF8INC(c, ptr) \
722 if ((c & 0xc0) == 0xc0) \
724 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
726 c = (c & utf8_table2[a]) << s; \
730 c |= (*ptr++ & 0x3f) << s; \
735 /*************************************************
736 * Binary chop search on a table *
737 *************************************************/
739 /* This is used for matching expansion items and operators.
742 name the name that is being sought
743 table the table to search
744 table_size the number of items in the table
746 Returns: the offset in the table, or -1
750 chop_match(uschar *name, uschar **table, int table_size)
752 uschar **bot = table;
753 uschar **top = table + table_size;
757 uschar **mid = bot + (top - bot)/2;
758 int c = Ustrcmp(name, *mid);
759 if (c == 0) return mid - table;
760 if (c > 0) bot = mid + 1; else top = mid;
768 /*************************************************
769 * Check a condition string *
770 *************************************************/
772 /* This function is called to expand a string, and test the result for a "true"
773 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
774 forced fail or lookup defer. All store used by the function can be released on
777 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
780 condition the condition string
781 m1 text to be incorporated in panic error
784 Returns: TRUE if condition is met, FALSE if not
788 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
791 void *reset_point = store_get(0);
792 uschar *ss = expand_string(condition);
795 if (!expand_string_forcedfail && !search_find_defer)
796 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
797 "for %s %s: %s", condition, m1, m2, expand_string_message);
800 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
801 strcmpic(ss, US"false") != 0;
802 store_reset(reset_point);
809 /*************************************************
810 * Pseudo-random number generation *
811 *************************************************/
813 /* Pseudo-random number generation. The result is not "expected" to be
814 cryptographically strong but not so weak that someone will shoot themselves
815 in the foot using it as a nonce in some email header scheme or whatever
816 weirdness they'll twist this into. The result should ideally handle fork().
818 However, if we're stuck unable to provide this, then we'll fall back to
819 appallingly bad randomness.
821 If SUPPORT_TLS is defined then this will not be used except as an emergency
826 Returns a random number in range [0, max-1]
830 # define vaguely_random_number vaguely_random_number_fallback
833 vaguely_random_number(int max)
836 # undef vaguely_random_number
838 static pid_t pid = 0;
840 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
850 #ifdef HAVE_ARC4RANDOM
851 /* cryptographically strong randomness, common on *BSD platforms, not
852 so much elsewhere. Alas. */
854 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
855 #ifdef HAVE_SRANDOMDEV
856 /* uses random(4) for seeding */
859 gettimeofday(&tv, NULL);
860 srandom(tv.tv_sec | tv.tv_usec | getpid());
863 /* Poor randomness and no seeding here */
870 #ifdef HAVE_ARC4RANDOM
871 return arc4random() % max;
872 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
873 return random() % max;
875 /* This one returns a 16-bit number, definitely not crypto-strong */
876 return random_number(max);
883 /*************************************************
884 * Pick out a name from a string *
885 *************************************************/
887 /* If the name is too long, it is silently truncated.
890 name points to a buffer into which to put the name
891 max is the length of the buffer
892 s points to the first alphabetic character of the name
893 extras chars other than alphanumerics to permit
895 Returns: pointer to the first character after the name
897 Note: The test for *s != 0 in the while loop is necessary because
898 Ustrchr() yields non-NULL if the character is zero (which is not something
902 read_name(uschar *name, int max, uschar *s, uschar *extras)
905 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
907 if (ptr < max-1) name[ptr++] = *s;
916 /*************************************************
917 * Pick out the rest of a header name *
918 *************************************************/
920 /* A variable name starting $header_ (or just $h_ for those who like
921 abbreviations) might not be the complete header name because headers can
922 contain any printing characters in their names, except ':'. This function is
923 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
924 on the end, if the name was terminated by white space.
927 name points to a buffer in which the name read so far exists
928 max is the length of the buffer
929 s points to the first character after the name so far, i.e. the
930 first non-alphameric character after $header_xxxxx
932 Returns: a pointer to the first character after the header name
936 read_header_name(uschar *name, int max, uschar *s)
938 int prelen = Ustrchr(name, '_') - name + 1;
939 int ptr = Ustrlen(name) - prelen;
940 if (ptr > 0) memmove(name, name+prelen, ptr);
941 while (mac_isgraph(*s) && *s != ':')
943 if (ptr < max-1) name[ptr++] = *s;
954 /*************************************************
955 * Pick out a number from a string *
956 *************************************************/
959 n points to an integer into which to put the number
960 s points to the first digit of the number
962 Returns: a pointer to the character after the last digit
966 read_number(int *n, uschar *s)
969 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
975 /*************************************************
976 * Extract keyed subfield from a string *
977 *************************************************/
979 /* The yield is in dynamic store; NULL means that the key was not found.
982 key points to the name of the key
983 s points to the string from which to extract the subfield
985 Returns: NULL if the subfield was not found, or
986 a pointer to the subfield's data
990 expand_getkeyed(uschar *key, uschar *s)
992 int length = Ustrlen(key);
993 while (isspace(*s)) s++;
995 /* Loop to search for the key */
1003 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1004 dkeylength = s - dkey;
1005 while (isspace(*s)) s++;
1006 if (*s == '=') while (isspace((*(++s))));
1008 data = string_dequote(&s);
1009 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1012 while (isspace(*s)) s++;
1021 /*************************************************
1022 * Extract numbered subfield from string *
1023 *************************************************/
1025 /* Extracts a numbered field from a string that is divided by tokens - for
1026 example a line from /etc/passwd is divided by colon characters. First field is
1027 numbered one. Negative arguments count from the right. Zero returns the whole
1028 string. Returns NULL if there are insufficient tokens in the string
1031 Modifies final argument - this is a dynamically generated string, so that's OK.
1034 field number of field to be extracted,
1035 first field = 1, whole string = 0, last field = -1
1036 separators characters that are used to break string into tokens
1037 s points to the string from which to extract the subfield
1039 Returns: NULL if the field was not found,
1040 a pointer to the field's data inside s (modified to add 0)
1044 expand_gettokened (int field, uschar *separators, uschar *s)
1049 uschar *fieldtext = NULL;
1051 if (field == 0) return s;
1053 /* Break the line up into fields in place; for field > 0 we stop when we have
1054 done the number of fields we want. For field < 0 we continue till the end of
1055 the string, counting the number of fields. */
1057 count = (field > 0)? field : INT_MAX;
1063 /* Previous field was the last one in the string. For a positive field
1064 number, this means there are not enough fields. For a negative field number,
1065 check that there are enough, and scan back to find the one that is wanted. */
1069 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1070 if ((-field) == (INT_MAX - count - 1)) return s;
1074 while (ss[-1] != 0) ss--;
1080 /* Previous field was not last in the string; save its start and put a
1084 len = Ustrcspn(ss, separators);
1095 /*************************************************
1096 * Extract a substring from a string *
1097 *************************************************/
1099 /* Perform the ${substr or ${length expansion operations.
1102 subject the input string
1103 value1 the offset from the start of the input string to the start of
1104 the output string; if negative, count from the right.
1105 value2 the length of the output string, or negative (-1) for unset
1106 if value1 is positive, unset means "all after"
1107 if value1 is negative, unset means "all before"
1108 len set to the length of the returned string
1110 Returns: pointer to the output string, or NULL if there is an error
1114 extract_substr(uschar *subject, int value1, int value2, int *len)
1116 int sublen = Ustrlen(subject);
1118 if (value1 < 0) /* count from right */
1122 /* If the position is before the start, skip to the start, and adjust the
1123 length. If the length ends up negative, the substring is null because nothing
1124 can precede. This falls out naturally when the length is unset, meaning "all
1130 if (value2 < 0) value2 = 0;
1134 /* Otherwise an unset length => characters before value1 */
1136 else if (value2 < 0)
1143 /* For a non-negative offset, if the starting position is past the end of the
1144 string, the result will be the null string. Otherwise, an unset length means
1145 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1149 if (value1 > sublen)
1154 else if (value2 < 0) value2 = sublen;
1157 /* Cut the length down to the maximum possible for the offset value, and get
1158 the required characters. */
1160 if (value1 + value2 > sublen) value2 = sublen - value1;
1162 return subject + value1;
1168 /*************************************************
1169 * Old-style hash of a string *
1170 *************************************************/
1172 /* Perform the ${hash expansion operation.
1175 subject the input string (an expanded substring)
1176 value1 the length of the output string; if greater or equal to the
1177 length of the input string, the input string is returned
1178 value2 the number of hash characters to use, or 26 if negative
1179 len set to the length of the returned string
1181 Returns: pointer to the output string, or NULL if there is an error
1185 compute_hash(uschar *subject, int value1, int value2, int *len)
1187 int sublen = Ustrlen(subject);
1189 if (value2 < 0) value2 = 26;
1190 else if (value2 > Ustrlen(hashcodes))
1192 expand_string_message =
1193 string_sprintf("hash count \"%d\" too big", value2);
1197 /* Calculate the hash text. We know it is shorter than the original string, so
1198 can safely place it in subject[] (we know that subject is always itself an
1199 expanded substring). */
1201 if (value1 < sublen)
1206 while ((c = (subject[j])) != 0)
1208 int shift = (c + j++) & 7;
1209 subject[i] ^= (c << shift) | (c >> (8-shift));
1210 if (++i >= value1) i = 0;
1212 for (i = 0; i < value1; i++)
1213 subject[i] = hashcodes[(subject[i]) % value2];
1215 else value1 = sublen;
1224 /*************************************************
1225 * Numeric hash of a string *
1226 *************************************************/
1228 /* Perform the ${nhash expansion operation. The first characters of the
1229 string are treated as most important, and get the highest prime numbers.
1232 subject the input string
1233 value1 the maximum value of the first part of the result
1234 value2 the maximum value of the second part of the result,
1235 or negative to produce only a one-part result
1236 len set to the length of the returned string
1238 Returns: pointer to the output string, or NULL if there is an error.
1242 compute_nhash (uschar *subject, int value1, int value2, int *len)
1244 uschar *s = subject;
1246 unsigned long int total = 0; /* no overflow */
1250 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1251 total += prime[i--] * (unsigned int)(*s++);
1254 /* If value2 is unset, just compute one number */
1258 s = string_sprintf("%d", total % value1);
1261 /* Otherwise do a div/mod hash */
1265 total = total % (value1 * value2);
1266 s = string_sprintf("%d/%d", total/value2, total % value2);
1277 /*************************************************
1278 * Find the value of a header or headers *
1279 *************************************************/
1281 /* Multiple instances of the same header get concatenated, and this function
1282 can also return a concatenation of all the header lines. When concatenating
1283 specific headers that contain lists of addresses, a comma is inserted between
1284 them. Otherwise we use a straight concatenation. Because some messages can have
1285 pathologically large number of lines, there is a limit on the length that is
1286 returned. Also, to avoid massive store use which would result from using
1287 string_cat() as it copies and extends strings, we do a preliminary pass to find
1288 out exactly how much store will be needed. On "normal" messages this will be
1292 name the name of the header, without the leading $header_ or $h_,
1293 or NULL if a concatenation of all headers is required
1294 exists_only TRUE if called from a def: test; don't need to build a string;
1295 just return a string that is not "" and not "0" if the header
1297 newsize return the size of memory block that was obtained; may be NULL
1298 if exists_only is TRUE
1299 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1300 other than concatenating, will be done on the header. Also used
1301 for $message_headers_raw.
1302 charset name of charset to translate MIME words to; used only if
1303 want_raw is false; if NULL, no translation is done (this is
1304 used for $bh_ and $bheader_)
1306 Returns: NULL if the header does not exist, else a pointer to a new
1311 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1314 BOOL found = name == NULL;
1316 int len = found? 0 : Ustrlen(name);
1318 uschar *yield = NULL;
1321 /* Loop for two passes - saves code repetition */
1323 for (i = 0; i < 2; i++)
1328 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1330 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1332 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1337 if (exists_only) return US"1"; /* don't need actual string */
1339 t = h->text + len; /* text to insert */
1340 if (!want_raw) /* unless wanted raw, */
1341 while (isspace(*t)) t++; /* remove leading white space */
1342 ilen = h->slen - (t - h->text); /* length to insert */
1344 /* Unless wanted raw, remove trailing whitespace, including the
1348 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1350 /* Set comma = 1 if handling a single header and it's one of those
1351 that contains an address list, except when asked for raw headers. Only
1352 need to do this once. */
1354 if (!want_raw && name != NULL && comma == 0 &&
1355 Ustrchr("BCFRST", h->type) != NULL)
1358 /* First pass - compute total store needed; second pass - compute
1359 total store used, including this header. */
1361 size += ilen + comma + 1; /* +1 for the newline */
1363 /* Second pass - concatentate the data, up to a maximum. Note that
1364 the loop stops when size hits the limit. */
1368 if (size > header_insert_maxlen)
1370 ilen -= size - header_insert_maxlen - 1;
1373 Ustrncpy(ptr, t, ilen);
1376 /* For a non-raw header, put in the comma if needed, then add
1377 back the newline we removed above, provided there was some text in
1380 if (!want_raw && ilen > 0)
1382 if (comma != 0) *ptr++ = ',';
1390 /* At end of first pass, return NULL if no header found. Then truncate size
1391 if necessary, and get the buffer to hold the data, returning the buffer size.
1396 if (!found) return NULL;
1397 if (size > header_insert_maxlen) size = header_insert_maxlen;
1398 *newsize = size + 1;
1399 ptr = yield = store_get(*newsize);
1403 /* That's all we do for raw header expansion. */
1410 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1411 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1412 function can return an error with decoded data if the charset translation
1413 fails. If decoding fails, it returns NULL. */
1417 uschar *decoded, *error;
1418 if (ptr > yield && ptr[-1] == '\n') ptr--;
1419 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1421 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1425 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1426 " input was: %s\n", error, yield);
1428 if (decoded != NULL) yield = decoded;
1437 /*************************************************
1438 * Find value of a variable *
1439 *************************************************/
1441 /* The table of variables is kept in alphabetic order, so we can search it
1442 using a binary chop. The "choplen" variable is nothing to do with the binary
1446 name the name of the variable being sought
1447 exists_only TRUE if this is a def: test; passed on to find_header()
1448 skipping TRUE => skip any processing evaluation; this is not the same as
1449 exists_only because def: may test for values that are first
1451 newsize pointer to an int which is initially zero; if the answer is in
1452 a new memory buffer, *newsize is set to its size
1454 Returns: NULL if the variable does not exist, or
1455 a pointer to the variable's contents, or
1456 something non-NULL if exists_only is TRUE
1460 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1463 int last = var_table_size;
1465 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1466 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1467 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1468 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1469 (this gave backwards compatibility at the changeover). There may be built-in
1470 variables whose names start acl_ but they should never start in this way. This
1471 slightly messy specification is a consequence of the history, needless to say.
1473 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1474 set, in which case give an error. */
1476 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1480 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1481 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1484 /* Handle $auth<n> variables. */
1486 if (Ustrncmp(name, "auth", 4) == 0)
1489 int n = Ustrtoul(name + 4, &endptr, 10);
1490 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1491 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1494 /* For all other variables, search the table */
1496 while (last > first)
1500 int middle = (first + last)/2;
1501 int c = Ustrcmp(name, var_table[middle].name);
1503 if (c > 0) { first = middle + 1; continue; }
1504 if (c < 0) { last = middle; continue; }
1506 /* Found an existing variable. If in skipping state, the value isn't needed,
1507 and we want to avoid processing (such as looking up the host name). */
1509 if (skipping) return US"";
1511 switch (var_table[middle].type)
1513 case vtype_filter_int:
1514 if (!filter_running) return NULL;
1518 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1522 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1526 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1530 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1534 sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1537 case vtype_stringptr: /* Pointer to string */
1538 s = *((uschar **)(var_table[middle].value));
1539 return (s == NULL)? US"" : s;
1542 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1545 case vtype_load_avg:
1546 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1549 case vtype_host_lookup: /* Lookup if not done so */
1550 if (sender_host_name == NULL && sender_host_address != NULL &&
1551 !host_lookup_failed && host_name_lookup() == OK)
1552 host_build_sender_fullhost();
1553 return (sender_host_name == NULL)? US"" : sender_host_name;
1555 case vtype_localpart: /* Get local part from address */
1556 s = *((uschar **)(var_table[middle].value));
1557 if (s == NULL) return US"";
1558 domain = Ustrrchr(s, '@');
1559 if (domain == NULL) return s;
1560 if (domain - s > sizeof(var_buffer) - 1)
1561 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1562 " in string expansion", sizeof(var_buffer));
1563 Ustrncpy(var_buffer, s, domain - s);
1564 var_buffer[domain - s] = 0;
1567 case vtype_domain: /* Get domain from address */
1568 s = *((uschar **)(var_table[middle].value));
1569 if (s == NULL) return US"";
1570 domain = Ustrrchr(s, '@');
1571 return (domain == NULL)? US"" : domain + 1;
1573 case vtype_msgheaders:
1574 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1576 case vtype_msgheaders_raw:
1577 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1579 case vtype_msgbody: /* Pointer to msgbody string */
1580 case vtype_msgbody_end: /* Ditto, the end of the msg */
1581 ss = (uschar **)(var_table[middle].value);
1582 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1585 off_t start_offset = SPOOL_DATA_START_OFFSET;
1586 int len = message_body_visible;
1587 if (len > message_size) len = message_size;
1588 *ss = body = store_malloc(len+1);
1590 if (var_table[middle].type == vtype_msgbody_end)
1592 struct stat statbuf;
1593 if (fstat(deliver_datafile, &statbuf) == 0)
1595 start_offset = statbuf.st_size - len;
1596 if (start_offset < SPOOL_DATA_START_OFFSET)
1597 start_offset = SPOOL_DATA_START_OFFSET;
1600 lseek(deliver_datafile, start_offset, SEEK_SET);
1601 len = read(deliver_datafile, body, len);
1605 if (message_body_newlines) /* Separate loops for efficiency */
1608 { if (body[--len] == 0) body[len] = ' '; }
1613 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1617 return (*ss == NULL)? US"" : *ss;
1619 case vtype_todbsdin: /* BSD inbox time of day */
1620 return tod_stamp(tod_bsdin);
1622 case vtype_tode: /* Unix epoch time of day */
1623 return tod_stamp(tod_epoch);
1625 case vtype_todel: /* Unix epoch/usec time of day */
1626 return tod_stamp(tod_epoch_l);
1628 case vtype_todf: /* Full time of day */
1629 return tod_stamp(tod_full);
1631 case vtype_todl: /* Log format time of day */
1632 return tod_stamp(tod_log_bare); /* (without timezone) */
1634 case vtype_todzone: /* Time zone offset only */
1635 return tod_stamp(tod_zone);
1637 case vtype_todzulu: /* Zulu time */
1638 return tod_stamp(tod_zulu);
1640 case vtype_todlf: /* Log file datestamp tod */
1641 return tod_stamp(tod_log_datestamp_daily);
1643 case vtype_reply: /* Get reply address */
1644 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1646 if (s != NULL) while (isspace(*s)) s++;
1647 if (s == NULL || *s == 0)
1649 *newsize = 0; /* For the *s==0 case */
1650 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1655 while (isspace(*s)) s++;
1656 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1657 while (t > s && isspace(t[-1])) t--;
1660 return (s == NULL)? US"" : s;
1662 /* A recipients list is available only during system message filtering,
1663 during ACL processing after DATA, and while expanding pipe commands
1664 generated from a system filter, but not elsewhere. */
1666 case vtype_recipients:
1667 if (!enable_dollar_recipients) return NULL; else
1672 s = store_get(size);
1673 for (i = 0; i < recipients_count; i++)
1675 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1676 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1677 Ustrlen(recipients_list[i].address));
1679 s[ptr] = 0; /* string_cat() leaves room */
1686 sprintf(CS var_buffer, "%d",
1687 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1694 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1695 sprintf(CS var_buffer, "%d", inodes);
1699 #ifndef DISABLE_DKIM
1701 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1707 return NULL; /* Unknown variable name */
1714 modify_variable(uschar *name, void * value)
1717 int last = var_table_size;
1719 while (last > first)
1721 int middle = (first + last)/2;
1722 int c = Ustrcmp(name, var_table[middle].name);
1724 if (c > 0) { first = middle + 1; continue; }
1725 if (c < 0) { last = middle; continue; }
1727 /* Found an existing variable; change the item it refers to */
1728 var_table[middle].value = value;
1731 return; /* Unknown variable name, fail silently */
1738 /*************************************************
1739 * Read and expand substrings *
1740 *************************************************/
1742 /* This function is called to read and expand argument substrings for various
1743 expansion items. Some have a minimum requirement that is less than the maximum;
1744 in these cases, the first non-present one is set to NULL.
1747 sub points to vector of pointers to set
1748 n maximum number of substrings
1750 sptr points to current string pointer
1751 skipping the skipping flag
1752 check_end if TRUE, check for final '}'
1753 name name of item, for error message
1755 Returns: 0 OK; string pointer updated
1756 1 curly bracketing error (too few arguments)
1757 2 too many arguments (only if check_end is set); message set
1758 3 other error (expansion failure)
1762 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1763 BOOL check_end, uschar *name)
1768 while (isspace(*s)) s++;
1769 for (i = 0; i < n; i++)
1773 if (i < m) return 1;
1777 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1778 if (sub[i] == NULL) return 3;
1779 if (*s++ != '}') return 1;
1780 while (isspace(*s)) s++;
1782 if (check_end && *s++ != '}')
1786 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1787 "(max is %d)", name, n);
1800 /*************************************************
1801 * Elaborate message for bad variable *
1802 *************************************************/
1804 /* For the "unknown variable" message, take a look at the variable's name, and
1805 give additional information about possible ACL variables. The extra information
1806 is added on to expand_string_message.
1808 Argument: the name of the variable
1813 check_variable_error_message(uschar *name)
1815 if (Ustrncmp(name, "acl_", 4) == 0)
1816 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1817 (name[4] == 'c' || name[4] == 'm')?
1819 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1820 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1822 US"user-defined ACL variables must start acl_c or acl_m");
1827 /*************************************************
1828 * Read and evaluate a condition *
1829 *************************************************/
1833 s points to the start of the condition text
1834 yield points to a BOOL to hold the result of the condition test;
1835 if NULL, we are just reading through a condition that is
1836 part of an "or" combination to check syntax, or in a state
1837 where the answer isn't required
1839 Returns: a pointer to the first character after the condition, or
1844 eval_condition(uschar *s, BOOL *yield)
1846 BOOL testfor = TRUE;
1847 BOOL tempcond, combined_cond;
1849 BOOL sub2_honour_dollar = TRUE;
1850 int i, rc, cond_type, roffset;
1851 int_eximarith_t num[2];
1852 struct stat statbuf;
1857 const uschar *rerror;
1861 while (isspace(*s)) s++;
1862 if (*s == '!') { testfor = !testfor; s++; } else break;
1865 /* Numeric comparisons are symbolic */
1867 if (*s == '=' || *s == '>' || *s == '<')
1879 /* All other conditions are named */
1881 else s = read_name(name, 256, s, US"_");
1883 /* If we haven't read a name, it means some non-alpha character is first. */
1887 expand_string_message = string_sprintf("condition name expected, "
1888 "but found \"%.16s\"", s);
1892 /* Find which condition we are dealing with, and switch on it */
1894 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1897 /* def: tests for a non-empty variable, or for the existence of a header. If
1898 yield == NULL we are in a skipping state, and don't care about the answer. */
1903 expand_string_message = US"\":\" expected after \"def\"";
1907 s = read_name(name, 256, s+1, US"_");
1909 /* Test for a header's existence. If the name contains a closing brace
1910 character, this may be a user error where the terminating colon has been
1911 omitted. Set a flag to adjust a subsequent error message in this case. */
1913 if (Ustrncmp(name, "h_", 2) == 0 ||
1914 Ustrncmp(name, "rh_", 3) == 0 ||
1915 Ustrncmp(name, "bh_", 3) == 0 ||
1916 Ustrncmp(name, "header_", 7) == 0 ||
1917 Ustrncmp(name, "rheader_", 8) == 0 ||
1918 Ustrncmp(name, "bheader_", 8) == 0)
1920 s = read_header_name(name, 256, s);
1921 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1922 if (yield != NULL) *yield =
1923 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1926 /* Test for a variable's having a non-empty value. A non-existent variable
1927 causes an expansion failure. */
1931 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1934 expand_string_message = (name[0] == 0)?
1935 string_sprintf("variable name omitted after \"def:\"") :
1936 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1937 check_variable_error_message(name);
1940 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1946 /* first_delivery tests for first delivery attempt */
1948 case ECOND_FIRST_DELIVERY:
1949 if (yield != NULL) *yield = deliver_firsttime == testfor;
1953 /* queue_running tests for any process started by a queue runner */
1955 case ECOND_QUEUE_RUNNING:
1956 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1960 /* exists: tests for file existence
1961 isip: tests for any IP address
1962 isip4: tests for an IPv4 address
1963 isip6: tests for an IPv6 address
1964 pam: does PAM authentication
1965 radius: does RADIUS authentication
1966 ldapauth: does LDAP authentication
1967 pwcheck: does Cyrus SASL pwcheck authentication
1976 case ECOND_LDAPAUTH:
1979 while (isspace(*s)) s++;
1980 if (*s != '{') goto COND_FAILED_CURLY_START;
1982 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
1983 if (sub[0] == NULL) return NULL;
1984 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1986 if (yield == NULL) return s; /* No need to run the test if skipping */
1991 if ((expand_forbid & RDO_EXISTS) != 0)
1993 expand_string_message = US"File existence tests are not permitted";
1996 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2002 rc = string_is_ip_address(sub[0], NULL);
2003 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2004 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2007 /* Various authentication tests - all optionally compiled */
2011 rc = auth_call_pam(sub[0], &expand_string_message);
2014 goto COND_FAILED_NOT_COMPILED;
2015 #endif /* SUPPORT_PAM */
2018 #ifdef RADIUS_CONFIG_FILE
2019 rc = auth_call_radius(sub[0], &expand_string_message);
2022 goto COND_FAILED_NOT_COMPILED;
2023 #endif /* RADIUS_CONFIG_FILE */
2025 case ECOND_LDAPAUTH:
2028 /* Just to keep the interface the same */
2030 int old_pool = store_pool;
2031 store_pool = POOL_SEARCH;
2032 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2033 &expand_string_message, &do_cache);
2034 store_pool = old_pool;
2038 goto COND_FAILED_NOT_COMPILED;
2039 #endif /* LOOKUP_LDAP */
2042 #ifdef CYRUS_PWCHECK_SOCKET
2043 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2046 goto COND_FAILED_NOT_COMPILED;
2047 #endif /* CYRUS_PWCHECK_SOCKET */
2049 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2050 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2052 if (rc == ERROR || rc == DEFER) return NULL;
2053 *yield = (rc == OK) == testfor;
2059 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2061 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
2063 However, the last two are optional. That is why the whole set is enclosed
2064 in their own set or braces. */
2066 case ECOND_SASLAUTHD:
2067 #ifndef CYRUS_SASLAUTHD_SOCKET
2068 goto COND_FAILED_NOT_COMPILED;
2070 while (isspace(*s)) s++;
2071 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2072 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2074 case 1: expand_string_message = US"too few arguments or bracketing "
2075 "error for saslauthd";
2077 case 3: return NULL;
2079 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2083 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2084 &expand_string_message);
2085 if (rc == ERROR || rc == DEFER) return NULL;
2086 *yield = (rc == OK) == testfor;
2089 #endif /* CYRUS_SASLAUTHD_SOCKET */
2092 /* symbolic operators for numeric and string comparison, and a number of
2093 other operators, all requiring two arguments.
2095 crypteq: encrypts plaintext and compares against an encrypted text,
2096 using crypt(), crypt16(), MD5 or SHA-1
2097 inlist/inlisti: checks if first argument is in the list of the second
2098 match: does a regular expression match and sets up the numerical
2099 variables if it succeeds
2100 match_address: matches in an address list
2101 match_domain: matches in a domain list
2102 match_ip: matches a host list that is restricted to IP addresses
2103 match_local_part: matches in a local part list
2106 case ECOND_MATCH_ADDRESS:
2107 case ECOND_MATCH_DOMAIN:
2108 case ECOND_MATCH_IP:
2109 case ECOND_MATCH_LOCAL_PART:
2110 #ifndef EXPAND_LISTMATCH_RHS
2111 sub2_honour_dollar = FALSE;
2120 case ECOND_NUM_L: /* Numerical comparisons */
2127 case ECOND_STR_LT: /* String comparisons */
2138 for (i = 0; i < 2; i++)
2140 /* Sometimes, we don't expand substrings; too many insecure configurations
2141 created using match_address{}{} and friends, where the second param
2142 includes information from untrustworthy sources. */
2143 BOOL honour_dollar = TRUE;
2144 if ((i > 0) && !sub2_honour_dollar)
2145 honour_dollar = FALSE;
2147 while (isspace(*s)) s++;
2150 if (i == 0) goto COND_FAILED_CURLY_START;
2151 expand_string_message = string_sprintf("missing 2nd string in {} "
2152 "after \"%s\"", name);
2155 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2157 if (sub[i] == NULL) return NULL;
2158 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2160 /* Convert to numerical if required; we know that the names of all the
2161 conditions that compare numbers do not start with a letter. This just saves
2162 checking for them individually. */
2164 if (!isalpha(name[0]) && yield != NULL)
2170 debug_printf("empty string cast to zero for numerical comparison\n");
2174 num[i] = expand_string_integer(sub[i], FALSE);
2175 if (expand_string_message != NULL) return NULL;
2180 /* Result not required */
2182 if (yield == NULL) return s;
2184 /* Do an appropriate comparison */
2190 *yield = (num[0] == num[1]) == testfor;
2194 *yield = (num[0] > num[1]) == testfor;
2198 *yield = (num[0] >= num[1]) == testfor;
2202 *yield = (num[0] < num[1]) == testfor;
2206 *yield = (num[0] <= num[1]) == testfor;
2210 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2214 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2218 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2222 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2226 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2230 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2234 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2238 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2242 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2246 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2249 case ECOND_MATCH: /* Regular expression match */
2250 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2254 expand_string_message = string_sprintf("regular expression error in "
2255 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2258 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2261 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2262 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2263 goto MATCHED_SOMETHING;
2265 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2266 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2267 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2268 goto MATCHED_SOMETHING;
2270 case ECOND_MATCH_IP: /* Match IP address in a host list */
2271 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2273 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2279 unsigned int *nullcache = NULL;
2280 check_host_block cb;
2282 cb.host_name = US"";
2283 cb.host_address = sub[0];
2285 /* If the host address starts off ::ffff: it is an IPv6 address in
2286 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2289 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2290 cb.host_address + 7 : cb.host_address;
2292 rc = match_check_list(
2293 &sub[1], /* the list */
2294 0, /* separator character */
2295 &hostlist_anchor, /* anchor pointer */
2296 &nullcache, /* cache pointer */
2297 check_host, /* function for testing */
2298 &cb, /* argument for function */
2299 MCL_HOST, /* type of check */
2300 sub[0], /* text for debugging */
2301 NULL); /* where to pass back data */
2303 goto MATCHED_SOMETHING;
2305 case ECOND_MATCH_LOCAL_PART:
2306 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2307 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2322 expand_string_message = string_sprintf("unable to complete match "
2323 "against \"%s\": %s", sub[1], search_error_message);
2329 /* Various "encrypted" comparisons. If the second string starts with
2330 "{" then an encryption type is given. Default to crypt() or crypt16()
2331 (build-time choice). */
2334 #ifndef SUPPORT_CRYPTEQ
2335 goto COND_FAILED_NOT_COMPILED;
2337 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2339 int sublen = Ustrlen(sub[1]+5);
2344 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2346 /* If the length that we are comparing against is 24, the MD5 digest
2347 is expressed as a base64 string. This is the way LDAP does it. However,
2348 some other software uses a straightforward hex representation. We assume
2349 this if the length is 32. Other lengths fail. */
2353 uschar *coded = auth_b64encode((uschar *)digest, 16);
2354 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2355 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2356 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2358 else if (sublen == 32)
2362 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2364 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2365 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2366 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2370 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2371 "fail\n crypted=%s\n", sub[1]+5);
2376 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2378 int sublen = Ustrlen(sub[1]+6);
2383 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2385 /* If the length that we are comparing against is 28, assume the SHA1
2386 digest is expressed as a base64 string. If the length is 40, assume a
2387 straightforward hex representation. Other lengths fail. */
2391 uschar *coded = auth_b64encode((uschar *)digest, 20);
2392 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2393 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2394 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2396 else if (sublen == 40)
2400 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2402 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2403 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2404 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2408 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2409 "fail\n crypted=%s\n", sub[1]+6);
2414 else /* {crypt} or {crypt16} and non-{ at start */
2415 /* }-for-text-editors */
2420 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2425 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2430 else if (sub[1][0] == '{')
2432 expand_string_message = string_sprintf("unknown encryption mechanism "
2433 "in \"%s\"", sub[1]);
2439 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2440 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2441 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2445 #define XSTR(s) STR(s)
2446 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2447 " subject=%s\n crypted=%s\n",
2448 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2453 /* If the encrypted string contains fewer than two characters (for the
2454 salt), force failure. Otherwise we get false positives: with an empty
2455 string the yield of crypt() is an empty string! */
2457 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2458 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2461 #endif /* SUPPORT_CRYPTEQ */
2468 uschar *save_iterate_item = iterate_item;
2469 int (*compare)(const uschar *, const uschar *);
2471 if (cond_type == ECOND_INLISTI)
2474 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2476 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2477 if (compare(sub[0], iterate_item) == 0)
2482 iterate_item = save_iterate_item;
2486 } /* Switch for comparison conditions */
2488 return s; /* End of comparison conditions */
2491 /* and/or: computes logical and/or of several conditions */
2495 subcondptr = (yield == NULL)? NULL : &tempcond;
2496 combined_cond = (cond_type == ECOND_AND);
2498 while (isspace(*s)) s++;
2499 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2503 while (isspace(*s)) s++;
2504 if (*s == '}') break;
2507 expand_string_message = string_sprintf("each subcondition "
2508 "inside an \"%s{...}\" condition must be in its own {}", name);
2512 s = eval_condition(s+1, subcondptr);
2515 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2516 expand_string_message, name);
2519 while (isspace(*s)) s++;
2523 expand_string_message = string_sprintf("missing } at end of condition "
2524 "inside \"%s\" group", name);
2530 if (cond_type == ECOND_AND)
2532 combined_cond &= tempcond;
2533 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2534 } /* evaluate any more */
2537 combined_cond |= tempcond;
2538 if (combined_cond) subcondptr = NULL; /* once true, don't */
2539 } /* evaluate any more */
2543 if (yield != NULL) *yield = (combined_cond == testfor);
2547 /* forall/forany: iterates a condition with different values */
2553 uschar *save_iterate_item = iterate_item;
2555 while (isspace(*s)) s++;
2556 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2557 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2558 if (sub[0] == NULL) return NULL;
2559 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2561 while (isspace(*s)) s++;
2562 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2566 /* Call eval_condition once, with result discarded (as if scanning a
2567 "false" part). This allows us to find the end of the condition, because if
2568 the list it empty, we won't actually evaluate the condition for real. */
2570 s = eval_condition(sub[1], NULL);
2573 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2574 expand_string_message, name);
2577 while (isspace(*s)) s++;
2581 expand_string_message = string_sprintf("missing } at end of condition "
2582 "inside \"%s\"", name);
2586 if (yield != NULL) *yield = !testfor;
2587 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2589 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2590 if (eval_condition(sub[1], &tempcond) == NULL)
2592 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2593 expand_string_message, name);
2594 iterate_item = save_iterate_item;
2597 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2598 tempcond? "true":"false");
2600 if (yield != NULL) *yield = (tempcond == testfor);
2601 if (tempcond == (cond_type == ECOND_FORANY)) break;
2604 iterate_item = save_iterate_item;
2609 /* The bool{} expansion condition maps a string to boolean.
2610 The values supported should match those supported by the ACL condition
2611 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2612 of true/false. Note that Router "condition" rules have a different
2613 interpretation, where general data can be used and only a few values
2615 Note that readconf.c boolean matching, for boolean configuration options,
2616 only matches true/yes/false/no.
2617 The bool_lax{} condition matches the Router logic, which is much more
2620 case ECOND_BOOL_LAX:
2626 BOOL boolvalue = FALSE;
2627 while (isspace(*s)) s++;
2628 if (*s != '{') goto COND_FAILED_CURLY_START;
2629 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2630 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2632 case 1: expand_string_message = string_sprintf(
2633 "too few arguments or bracketing error for %s",
2637 case 3: return NULL;
2640 while (isspace(*t)) t++;
2644 /* trailing whitespace: seems like a good idea to ignore it too */
2646 while (isspace(*t2)) t2--;
2647 if (t2 != (t + len))
2654 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2655 /* logic for the lax case from expand_check_condition(), which also does
2656 expands, and the logic is both short and stable enough that there should
2657 be no maintenance burden from replicating it. */
2660 else if (Ustrspn(t, "0123456789") == len)
2662 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2663 /* expand_check_condition only does a literal string "0" check */
2664 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2667 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2669 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2671 else if (cond_type == ECOND_BOOL_LAX)
2675 expand_string_message = string_sprintf("unrecognised boolean "
2679 if (yield != NULL) *yield = (boolvalue == testfor);
2683 /* Unknown condition */
2686 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2688 } /* End switch on condition type */
2690 /* Missing braces at start and end of data */
2692 COND_FAILED_CURLY_START:
2693 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2696 COND_FAILED_CURLY_END:
2697 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2701 /* A condition requires code that is not compiled */
2703 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2704 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2705 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2706 COND_FAILED_NOT_COMPILED:
2707 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2716 /*************************************************
2717 * Save numerical variables *
2718 *************************************************/
2720 /* This function is called from items such as "if" that want to preserve and
2721 restore the numbered variables.
2724 save_expand_string points to an array of pointers to set
2725 save_expand_nlength points to an array of ints for the lengths
2727 Returns: the value of expand max to save
2731 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2734 for (i = 0; i <= expand_nmax; i++)
2736 save_expand_nstring[i] = expand_nstring[i];
2737 save_expand_nlength[i] = expand_nlength[i];
2744 /*************************************************
2745 * Restore numerical variables *
2746 *************************************************/
2748 /* This function restored saved values of numerical strings.
2751 save_expand_nmax the number of strings to restore
2752 save_expand_string points to an array of pointers
2753 save_expand_nlength points to an array of ints
2759 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2760 int *save_expand_nlength)
2763 expand_nmax = save_expand_nmax;
2764 for (i = 0; i <= expand_nmax; i++)
2766 expand_nstring[i] = save_expand_nstring[i];
2767 expand_nlength[i] = save_expand_nlength[i];
2775 /*************************************************
2776 * Handle yes/no substrings *
2777 *************************************************/
2779 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2780 alternative substrings that depend on whether or not the condition was true,
2781 or the lookup or extraction succeeded. The substrings always have to be
2782 expanded, to check their syntax, but "skipping" is set when the result is not
2783 needed - this avoids unnecessary nested lookups.
2786 skipping TRUE if we were skipping when this item was reached
2787 yes TRUE if the first string is to be used, else use the second
2788 save_lookup a value to put back into lookup_value before the 2nd expansion
2789 sptr points to the input string pointer
2790 yieldptr points to the output string pointer
2791 sizeptr points to the output string size
2792 ptrptr points to the output string pointer
2793 type "lookup" or "if" or "extract" or "run", for error message
2795 Returns: 0 OK; lookup_value has been reset to save_lookup
2797 2 expansion failed because of bracketing error
2801 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2802 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2805 uschar *s = *sptr; /* Local value */
2806 uschar *sub1, *sub2;
2808 /* If there are no following strings, we substitute the contents of $value for
2809 lookups and for extractions in the success case. For the ${if item, the string
2810 "true" is substituted. In the fail case, nothing is substituted for all three
2813 while (isspace(*s)) s++;
2818 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2822 if (yes && lookup_value != NULL)
2823 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2824 Ustrlen(lookup_value));
2825 lookup_value = save_lookup;
2831 /* The first following string must be braced. */
2833 if (*s++ != '{') goto FAILED_CURLY;
2835 /* Expand the first substring. Forced failures are noticed only if we actually
2836 want this string. Set skipping in the call in the fail case (this will always
2837 be the case if we were already skipping). */
2839 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
2840 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2841 expand_string_forcedfail = FALSE;
2842 if (*s++ != '}') goto FAILED_CURLY;
2844 /* If we want the first string, add it to the output */
2847 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2849 /* If this is called from a lookup or an extract, we want to restore $value to
2850 what it was at the start of the item, so that it has this value during the
2851 second string expansion. For the call from "if" or "run" to this function,
2852 save_lookup is set to lookup_value, so that this statement does nothing. */
2854 lookup_value = save_lookup;
2856 /* There now follows either another substring, or "fail", or nothing. This
2857 time, forced failures are noticed only if we want the second string. We must
2858 set skipping in the nested call if we don't want this string, or if we were
2859 already skipping. */
2861 while (isspace(*s)) s++;
2864 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
2865 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2866 expand_string_forcedfail = FALSE;
2867 if (*s++ != '}') goto FAILED_CURLY;
2869 /* If we want the second string, add it to the output */
2872 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2875 /* If there is no second string, but the word "fail" is present when the use of
2876 the second string is wanted, set a flag indicating it was a forced failure
2877 rather than a syntactic error. Swallow the terminating } in case this is nested
2878 inside another lookup or if or extract. */
2883 s = read_name(name, sizeof(name), s, US"_");
2884 if (Ustrcmp(name, "fail") == 0)
2886 if (!yes && !skipping)
2888 while (isspace(*s)) s++;
2889 if (*s++ != '}') goto FAILED_CURLY;
2890 expand_string_message =
2891 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2892 expand_string_forcedfail = TRUE;
2898 expand_string_message =
2899 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2904 /* All we have to do now is to check on the final closing brace. */
2906 while (isspace(*s)) s++;
2907 if (*s++ == '}') goto RETURN;
2909 /* Get here if there is a bracketing failure */
2914 /* Get here for other failures */
2919 /* Update the input pointer value before returning */
2929 /*************************************************
2930 * Handle MD5 or SHA-1 computation for HMAC *
2931 *************************************************/
2933 /* These are some wrapping functions that enable the HMAC code to be a bit
2934 cleaner. A good compiler will spot the tail recursion.
2937 type HMAC_MD5 or HMAC_SHA1
2938 remaining are as for the cryptographic hash functions
2944 chash_start(int type, void *base)
2946 if (type == HMAC_MD5)
2947 md5_start((md5 *)base);
2949 sha1_start((sha1 *)base);
2953 chash_mid(int type, void *base, uschar *string)
2955 if (type == HMAC_MD5)
2956 md5_mid((md5 *)base, string);
2958 sha1_mid((sha1 *)base, string);
2962 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2964 if (type == HMAC_MD5)
2965 md5_end((md5 *)base, string, length, digest);
2967 sha1_end((sha1 *)base, string, length, digest);
2974 /********************************************************
2975 * prvs: Get last three digits of days since Jan 1, 1970 *
2976 ********************************************************/
2978 /* This is needed to implement the "prvs" BATV reverse
2981 Argument: integer "days" offset to add or substract to
2982 or from the current number of days.
2984 Returns: pointer to string containing the last three
2985 digits of the number of days since Jan 1, 1970,
2986 modified by the offset argument, NULL if there
2987 was an error in the conversion.
2992 prvs_daystamp(int day_offset)
2994 uschar *days = store_get(32); /* Need at least 24 for cases */
2995 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2996 (time(NULL) + day_offset*86400)/86400);
2997 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3002 /********************************************************
3003 * prvs: perform HMAC-SHA1 computation of prvs bits *
3004 ********************************************************/
3006 /* This is needed to implement the "prvs" BATV reverse
3010 address RFC2821 Address to use
3011 key The key to use (must be less than 64 characters
3013 key_num Single-digit key number to use. Defaults to
3016 Returns: pointer to string containing the first three
3017 bytes of the final hash in hex format, NULL if
3018 there was an error in the process.
3022 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3024 uschar *hash_source, *p;
3025 int size = 0,offset = 0,i;
3027 void *use_base = &sha1_base;
3028 uschar innerhash[20];
3029 uschar finalhash[20];
3030 uschar innerkey[64];
3031 uschar outerkey[64];
3032 uschar *finalhash_hex = store_get(40);
3034 if (key_num == NULL)
3037 if (Ustrlen(key) > 64)
3040 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3041 string_cat(hash_source,&size,&offset,daystamp,3);
3042 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3043 hash_source[offset] = '\0';
3045 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3047 memset(innerkey, 0x36, 64);
3048 memset(outerkey, 0x5c, 64);
3050 for (i = 0; i < Ustrlen(key); i++)
3052 innerkey[i] ^= key[i];
3053 outerkey[i] ^= key[i];
3056 chash_start(HMAC_SHA1, use_base);
3057 chash_mid(HMAC_SHA1, use_base, innerkey);
3058 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3060 chash_start(HMAC_SHA1, use_base);
3061 chash_mid(HMAC_SHA1, use_base, outerkey);
3062 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3065 for (i = 0; i < 3; i++)
3067 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3068 *p++ = hex_digits[finalhash[i] & 0x0f];
3072 return finalhash_hex;
3078 /*************************************************
3079 * Join a file onto the output string *
3080 *************************************************/
3082 /* This is used for readfile and after a run expansion. It joins the contents
3083 of a file onto the output string, globally replacing newlines with a given
3084 string (optionally). The file is closed at the end.
3088 yield pointer to the expandable string
3089 sizep pointer to the current size
3090 ptrp pointer to the current position
3091 eol newline replacement string, or NULL
3093 Returns: new value of string pointer
3097 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3100 uschar buffer[1024];
3102 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3104 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3106 int len = Ustrlen(buffer);
3107 if (eol != NULL && buffer[len-1] == '\n') len--;
3108 yield = string_cat(yield, sizep, ptrp, buffer, len);
3109 if (buffer[len] != 0)
3110 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3113 if (yield != NULL) yield[*ptrp] = 0;
3121 /*************************************************
3122 * Evaluate numeric expression *
3123 *************************************************/
3125 /* This is a set of mutually recursive functions that evaluate an arithmetic
3126 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3127 these functions that is called from elsewhere is eval_expr, whose interface is:
3130 sptr pointer to the pointer to the string - gets updated
3131 decimal TRUE if numbers are to be assumed decimal
3132 error pointer to where to put an error message - must be NULL on input
3133 endket TRUE if ')' must terminate - FALSE for external call
3135 Returns: on success: the value of the expression, with *error still NULL
3136 on failure: an undefined value, with *error = a message
3139 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3142 static int_eximarith_t
3143 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3146 int_eximarith_t x = eval_op_or(&s, decimal, error);
3152 *error = US"expecting closing parenthesis";
3154 while (isspace(*(++s)));
3156 else if (*s != 0) *error = US"expecting operator";
3163 static int_eximarith_t
3164 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3169 while (isspace(*s)) s++;
3174 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3176 switch (tolower(*s))
3179 case 'k': n *= 1024; s++; break;
3180 case 'm': n *= 1024*1024; s++; break;
3181 case 'g': n *= 1024*1024*1024; s++; break;
3183 while (isspace (*s)) s++;
3188 n = eval_expr(&s, decimal, error, 1);
3192 *error = US"expecting number or opening parenthesis";
3200 static int_eximarith_t
3201 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3205 while (isspace(*s)) s++;
3206 if (*s == '+' || *s == '-' || *s == '~')
3209 x = eval_op_unary(&s, decimal, error);
3210 if (op == '-') x = -x;
3211 else if (op == '~') x = ~x;
3215 x = eval_number(&s, decimal, error);
3222 static int_eximarith_t
3223 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3226 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3229 while (*s == '*' || *s == '/' || *s == '%')
3232 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3233 if (*error != NULL) break;
3234 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3235 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3236 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3237 * -N*M is INT_MIN will yielf INT_MIN.
3238 * Since we don't support floating point, this is somewhat simpler.
3239 * Ideally, we'd return an error, but since we overflow for all other
3240 * arithmetic, consistency suggests otherwise, but what's the correct value
3241 * to use? There is none.
3242 * The C standard guarantees overflow for unsigned arithmetic but signed
3243 * overflow invokes undefined behaviour; in practice, this is overflow
3244 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3245 * that long/longlong larger than int are available, or we could just work
3246 * with larger types. We should consider whether to guarantee 32bit eval
3247 * and 64-bit working variables, with errors returned. For now ...
3248 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3249 * can just let the other invalid results occur otherwise, as they have
3250 * until now. For this one case, we can coerce.
3252 if (y == -1 && x == LLONG_MIN && op != '*')
3255 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3256 LLONG_MIN, op, LLONG_MAX);
3266 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3282 static int_eximarith_t
3283 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3286 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3289 while (*s == '+' || *s == '-')
3292 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3293 if (*error != NULL) break;
3294 if (op == '+') x += y; else x -= y;
3302 static int_eximarith_t
3303 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3306 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3309 while ((*s == '<' || *s == '>') && s[1] == s[0])
3314 y = eval_op_sum(&s, decimal, error);
3315 if (*error != NULL) break;
3316 if (op == '<') x <<= y; else x >>= y;
3324 static int_eximarith_t
3325 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3328 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3335 y = eval_op_shift(&s, decimal, error);
3336 if (*error != NULL) break;
3345 static int_eximarith_t
3346 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3349 int_eximarith_t x = eval_op_and(&s, decimal, error);
3356 y = eval_op_and(&s, decimal, error);
3357 if (*error != NULL) break;
3366 static int_eximarith_t
3367 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3370 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3377 y = eval_op_xor(&s, decimal, error);
3378 if (*error != NULL) break;
3388 /*************************************************
3390 *************************************************/
3392 /* Returns either an unchanged string, or the expanded string in stacking pool
3393 store. Interpreted sequences are:
3395 \... normal escaping rules
3396 $name substitutes the variable
3398 ${op:string} operates on the expanded string value
3399 ${item{arg1}{arg2}...} expands the args and then does the business
3400 some literal args are not enclosed in {}
3402 There are now far too many operators and item types to make it worth listing
3403 them here in detail any more.
3405 We use an internal routine recursively to handle embedded substrings. The
3406 external function follows. The yield is NULL if the expansion failed, and there
3407 are two cases: if something collapsed syntactically, or if "fail" was given
3408 as the action on a lookup failure. These can be distinguised by looking at the
3409 variable expand_string_forcedfail, which is TRUE in the latter case.
3411 The skipping flag is set true when expanding a substring that isn't actually
3412 going to be used (after "if" or "lookup") and it prevents lookups from
3413 happening lower down.
3415 Store usage: At start, a store block of the length of the input plus 64
3416 is obtained. This is expanded as necessary by string_cat(), which might have to
3417 get a new block, or might be able to expand the original. At the end of the
3418 function we can release any store above that portion of the yield block that
3419 was actually used. In many cases this will be optimal.
3421 However: if the first item in the expansion is a variable name or header name,
3422 we reset the store before processing it; if the result is in fresh store, we
3423 use that without copying. This is helpful for expanding strings like
3424 $message_headers which can get very long.
3426 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3427 since resetting the store at the end of the expansion will free store that was
3428 allocated by the plugin code as well as the slop after the expanded string. So
3429 we skip any resets if ${dlfunc has been used. This is an unfortunate
3430 consequence of string expansion becoming too powerful.
3433 string the string to be expanded
3434 ket_ends true if expansion is to stop at }
3435 left if not NULL, a pointer to the first character after the
3436 expansion is placed here (typically used with ket_ends)
3437 skipping TRUE for recursive calls when the value isn't actually going
3438 to be used (to allow for optimisation)
3439 honour_dollar TRUE if $ is to be expanded,
3440 FALSE if it's just another character
3442 Returns: NULL if expansion fails:
3443 expand_string_forcedfail is set TRUE if failure was forced
3444 expand_string_message contains a textual error message
3445 a pointer to the expanded string on success
3449 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3450 BOOL skipping, BOOL honour_dollar)
3453 int size = Ustrlen(string)+ 64;
3455 uschar *yield = store_get(size);
3457 uschar *save_expand_nstring[EXPAND_MAXN+1];
3458 int save_expand_nlength[EXPAND_MAXN+1];
3459 BOOL resetok = TRUE;
3461 expand_string_forcedfail = FALSE;
3462 expand_string_message = US"";
3469 /* \ escapes the next character, which must exist, or else
3470 the expansion fails. There's a special escape, \N, which causes
3471 copying of the subject verbatim up to the next \N. Otherwise,
3472 the escapes are the standard set. */
3478 expand_string_message = US"\\ at end of string";
3485 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3486 yield = string_cat(yield, &size, &ptr, t, s - t);
3487 if (*s != 0) s += 2;
3493 ch[0] = string_interpret_escape(&s);
3495 yield = string_cat(yield, &size, &ptr, ch, 1);
3501 /* Anything other than $ is just copied verbatim, unless we are
3502 looking for a terminating } character. */
3504 if (ket_ends && *s == '}') break;
3506 if (*s != '$' || !honour_dollar)
3508 yield = string_cat(yield, &size, &ptr, s++, 1);
3512 /* No { after the $ - must be a plain name or a number for string
3513 match variable. There has to be a fudge for variables that are the
3514 names of header fields preceded by "$header_" because header field
3515 names can contain any printing characters except space and colon.
3516 For those that don't like typing this much, "$h_" is a synonym for
3517 "$header_". A non-existent header yields a NULL value; nothing is
3520 if (isalpha((*(++s))))
3525 s = read_name(name, sizeof(name), s, US"_");
3527 /* If this is the first thing to be expanded, release the pre-allocated
3530 if (ptr == 0 && yield != NULL)
3532 if (resetok) store_reset(yield);
3539 if (Ustrncmp(name, "h_", 2) == 0 ||
3540 Ustrncmp(name, "rh_", 3) == 0 ||
3541 Ustrncmp(name, "bh_", 3) == 0 ||
3542 Ustrncmp(name, "header_", 7) == 0 ||
3543 Ustrncmp(name, "rheader_", 8) == 0 ||
3544 Ustrncmp(name, "bheader_", 8) == 0)
3546 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3547 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3548 s = read_header_name(name, sizeof(name), s);
3549 value = find_header(name, FALSE, &newsize, want_raw, charset);
3551 /* If we didn't find the header, and the header contains a closing brace
3552 character, this may be a user error where the terminating colon
3553 has been omitted. Set a flag to adjust the error message in this case.
3554 But there is no error here - nothing gets inserted. */
3558 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3567 value = find_variable(name, FALSE, skipping, &newsize);
3570 expand_string_message =
3571 string_sprintf("unknown variable name \"%s\"", name);
3572 check_variable_error_message(name);
3577 /* If the data is known to be in a new buffer, newsize will be set to the
3578 size of that buffer. If this is the first thing in an expansion string,
3579 yield will be NULL; just point it at the new store instead of copying. Many
3580 expansion strings contain just one reference, so this is a useful
3581 optimization, especially for humungous headers. */
3583 len = Ustrlen(value);
3584 if (yield == NULL && newsize != 0)
3590 else yield = string_cat(yield, &size, &ptr, value, len);
3598 s = read_number(&n, s);
3599 if (n >= 0 && n <= expand_nmax)
3600 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3605 /* Otherwise, if there's no '{' after $ it's an error. */
3609 expand_string_message = US"$ not followed by letter, digit, or {";
3613 /* After { there can be various things, but they all start with
3614 an initial word, except for a number for a string match variable. */
3616 if (isdigit((*(++s))))
3619 s = read_number(&n, s);
3622 expand_string_message = US"} expected after number";
3625 if (n >= 0 && n <= expand_nmax)
3626 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3633 expand_string_message = US"letter or digit expected after ${";
3637 /* Allow "-" in names to cater for substrings with negative
3638 arguments. Since we are checking for known names after { this is
3641 s = read_name(name, sizeof(name), s, US"_-");
3642 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3646 /* Call an ACL from an expansion. We feed data in via $address_data.
3647 If the ACL returns acceptance we return content set by "message ="
3648 There is currently no limit on recursion; this would have us call
3649 acl_check_internal() directly and get a current level from somewhere.
3659 switch(read_subs(sub, 2, 1, &s, skipping, TRUE, US"acl"))
3661 case 1: goto EXPAND_FAILED_CURLY;
3663 case 3: goto EXPAND_FAILED;
3665 if (skipping) continue;
3668 debug_printf("expanding: acl: %s arg: %s\n", sub[0], sub[1]?sub[1]:US"<none>");
3670 deliver_address_data = sub[1];
3671 switch(rc = acl_check(ACL_WHERE_EXPANSION, NULL, sub[0], &user_msg, &log_msg))
3675 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3680 expand_string_message = string_sprintf("acl \"%s\" did not accept", sub[0]);
3685 /* Handle conditionals - preserve the values of the numerical expansion
3686 variables in case they get changed by a regular expression match in the
3687 condition. If not, they retain their external settings. At the end
3688 of this "if" section, they get restored to their previous values. */
3694 int save_expand_nmax =
3695 save_expand_strings(save_expand_nstring, save_expand_nlength);
3697 while (isspace(*s)) s++;
3698 next_s = eval_condition(s, skipping? NULL : &cond);
3699 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3702 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3703 cond? "true" : "false");
3707 /* The handling of "yes" and "no" result strings is now in a separate
3708 function that is also used by ${lookup} and ${extract} and ${run}. */
3710 switch(process_yesno(
3711 skipping, /* were previously skipping */
3712 cond, /* success/failure indicator */
3713 lookup_value, /* value to reset for string2 */
3714 &s, /* input pointer */
3715 &yield, /* output pointer */
3716 &size, /* output size */
3717 &ptr, /* output current point */
3718 US"if")) /* condition type */
3720 case 1: goto EXPAND_FAILED; /* when all is well, the */
3721 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3724 /* Restore external setting of expansion variables for continuation
3727 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3728 save_expand_nlength);
3732 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3733 expanding an internal string that isn't actually going to be used. All we
3734 need to do is check the syntax, so don't do a lookup at all. Preserve the
3735 values of the numerical expansion variables in case they get changed by a
3736 partial lookup. If not, they retain their external settings. At the end
3737 of this "lookup" section, they get restored to their previous values. */
3741 int stype, partial, affixlen, starflags;
3742 int expand_setup = 0;
3744 uschar *key, *filename, *affix;
3745 uschar *save_lookup_value = lookup_value;
3746 int save_expand_nmax =
3747 save_expand_strings(save_expand_nstring, save_expand_nlength);
3749 if ((expand_forbid & RDO_LOOKUP) != 0)
3751 expand_string_message = US"lookup expansions are not permitted";
3755 /* Get the key we are to look up for single-key+file style lookups.
3756 Otherwise set the key NULL pro-tem. */
3758 while (isspace(*s)) s++;
3761 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3762 if (key == NULL) goto EXPAND_FAILED;
3763 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3764 while (isspace(*s)) s++;
3768 /* Find out the type of database */
3772 expand_string_message = US"missing lookup type";
3776 /* The type is a string that may contain special characters of various
3777 kinds. Allow everything except space or { to appear; the actual content
3778 is checked by search_findtype_partial. */
3780 while (*s != 0 && *s != '{' && !isspace(*s))
3782 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3786 while (isspace(*s)) s++;
3788 /* Now check for the individual search type and any partial or default
3789 options. Only those types that are actually in the binary are valid. */
3791 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3795 expand_string_message = search_error_message;
3799 /* Check that a key was provided for those lookup types that need it,
3800 and was not supplied for those that use the query style. */
3802 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3806 expand_string_message = string_sprintf("missing {key} for single-"
3807 "key \"%s\" lookup", name);
3815 expand_string_message = string_sprintf("a single key was given for "
3816 "lookup type \"%s\", which is not a single-key lookup type", name);
3821 /* Get the next string in brackets and expand it. It is the file name for
3822 single-key+file lookups, and the whole query otherwise. In the case of
3823 queries that also require a file name (e.g. sqlite), the file name comes
3826 if (*s != '{') goto EXPAND_FAILED_CURLY;
3827 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3828 if (filename == NULL) goto EXPAND_FAILED;
3829 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3830 while (isspace(*s)) s++;
3832 /* If this isn't a single-key+file lookup, re-arrange the variables
3833 to be appropriate for the search_ functions. For query-style lookups,
3834 there is just a "key", and no file name. For the special query-style +
3835 file types, the query (i.e. "key") starts with a file name. */
3839 while (isspace(*filename)) filename++;
3842 if (mac_islookup(stype, lookup_querystyle))
3848 if (*filename != '/')
3850 expand_string_message = string_sprintf(
3851 "absolute file name expected for \"%s\" lookup", name);
3854 while (*key != 0 && !isspace(*key)) key++;
3855 if (*key != 0) *key++ = 0;
3859 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3860 the entry was not found. Note that there is no search_close() function.
3861 Files are left open in case of re-use. At suitable places in higher logic,
3862 search_tidyup() is called to tidy all open files. This can save opening
3863 the same file several times. However, files may also get closed when
3864 others are opened, if too many are open at once. The rule is that a
3865 handle should not be used after a second search_open().
3867 Request that a partial search sets up $1 and maybe $2 by passing
3868 expand_setup containing zero. If its value changes, reset expand_nmax,
3869 since new variables will have been set. Note that at the end of this
3870 "lookup" section, the old numeric variables are restored. */
3873 lookup_value = NULL;
3876 void *handle = search_open(filename, stype, 0, NULL, NULL);
3879 expand_string_message = search_error_message;
3882 lookup_value = search_find(handle, filename, key, partial, affix,
3883 affixlen, starflags, &expand_setup);
3884 if (search_find_defer)
3886 expand_string_message =
3887 string_sprintf("lookup of \"%s\" gave DEFER: %s",
3888 string_printing2(key, FALSE), search_error_message);
3891 if (expand_setup > 0) expand_nmax = expand_setup;
3894 /* The handling of "yes" and "no" result strings is now in a separate
3895 function that is also used by ${if} and ${extract}. */
3897 switch(process_yesno(
3898 skipping, /* were previously skipping */
3899 lookup_value != NULL, /* success/failure indicator */
3900 save_lookup_value, /* value to reset for string2 */
3901 &s, /* input pointer */
3902 &yield, /* output pointer */
3903 &size, /* output size */
3904 &ptr, /* output current point */
3905 US"lookup")) /* condition type */
3907 case 1: goto EXPAND_FAILED; /* when all is well, the */
3908 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3911 /* Restore external setting of expansion variables for carrying on
3912 at this level, and continue. */
3914 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3915 save_expand_nlength);
3919 /* If Perl support is configured, handle calling embedded perl subroutines,
3920 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3921 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3922 arguments (defined below). */
3924 #define EXIM_PERL_MAX_ARGS 8
3928 expand_string_message = US"\"${perl\" encountered, but this facility "
3929 "is not included in this binary";
3932 #else /* EXIM_PERL */
3934 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3937 if ((expand_forbid & RDO_PERL) != 0)
3939 expand_string_message = US"Perl calls are not permitted";
3943 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3946 case 1: goto EXPAND_FAILED_CURLY;
3948 case 3: goto EXPAND_FAILED;
3951 /* If skipping, we don't actually do anything */
3953 if (skipping) continue;
3955 /* Start the interpreter if necessary */
3957 if (!opt_perl_started)
3960 if (opt_perl_startup == NULL)
3962 expand_string_message = US"A setting of perl_startup is needed when "
3963 "using the Perl interpreter";
3966 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3967 initerror = init_perl(opt_perl_startup);
3968 if (initerror != NULL)
3970 expand_string_message =
3971 string_sprintf("error in perl_startup code: %s\n", initerror);
3974 opt_perl_started = TRUE;
3977 /* Call the function */
3979 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3980 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3981 sub_arg[0], sub_arg + 1);
3983 /* NULL yield indicates failure; if the message pointer has been set to
3984 NULL, the yield was undef, indicating a forced failure. Otherwise the
3985 message will indicate some kind of Perl error. */
3987 if (new_yield == NULL)
3989 if (expand_string_message == NULL)
3991 expand_string_message =
3992 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3993 "failure", sub_arg[0]);
3994 expand_string_forcedfail = TRUE;
3999 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4000 set during a callback from Perl. */
4002 expand_string_forcedfail = FALSE;
4006 #endif /* EXIM_PERL */
4008 /* Transform email address to "prvs" scheme to use
4009 as BATV-signed return path */
4016 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
4018 case 1: goto EXPAND_FAILED_CURLY;
4020 case 3: goto EXPAND_FAILED;
4023 /* If skipping, we don't actually do anything */
4024 if (skipping) continue;
4026 /* sub_arg[0] is the address */
4027 domain = Ustrrchr(sub_arg[0],'@');
4028 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4030 expand_string_message = US"prvs first argument must be a qualified email address";
4034 /* Calculate the hash. The second argument must be a single-digit
4035 key number, or unset. */
4037 if (sub_arg[2] != NULL &&
4038 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4040 expand_string_message = US"prvs second argument must be a single digit";
4044 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4047 expand_string_message = US"prvs hmac-sha1 conversion failed";
4051 /* Now separate the domain from the local part */
4054 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4055 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4056 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4057 string_cat(yield,&size,&ptr,p,6);
4058 string_cat(yield,&size,&ptr,US"=",1);
4059 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4060 string_cat(yield,&size,&ptr,US"@",1);
4061 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4066 /* Check a prvs-encoded address for validity */
4068 case EITEM_PRVSCHECK:
4071 int mysize = 0, myptr = 0;
4075 /* TF: Ugliness: We want to expand parameter 1 first, then set
4076 up expansion variables that are used in the expansion of
4077 parameter 2. So we clone the string for the first
4078 expansion, where we only expand parameter 1.
4080 PH: Actually, that isn't necessary. The read_subs() function is
4081 designed to work this way for the ${if and ${lookup expansions. I've
4085 /* Reset expansion variables */
4086 prvscheck_result = NULL;
4087 prvscheck_address = NULL;
4088 prvscheck_keynum = NULL;
4090 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4092 case 1: goto EXPAND_FAILED_CURLY;
4094 case 3: goto EXPAND_FAILED;
4097 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4100 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4102 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4103 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4104 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4105 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4106 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4108 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4109 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4110 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4111 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4112 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4114 /* Set up expansion variables */
4115 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4116 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4117 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4118 prvscheck_address[myptr] = '\0';
4119 prvscheck_keynum = string_copy(key_num);
4121 /* Now expand the second argument */
4122 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4124 case 1: goto EXPAND_FAILED_CURLY;
4126 case 3: goto EXPAND_FAILED;
4129 /* Now we have the key and can check the address. */
4131 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4136 expand_string_message = US"hmac-sha1 conversion failed";
4140 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4141 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4143 if (Ustrcmp(p,hash) == 0)
4145 /* Success, valid BATV address. Now check the expiry date. */
4146 uschar *now = prvs_daystamp(0);
4147 unsigned int inow = 0,iexpire = 1;
4149 (void)sscanf(CS now,"%u",&inow);
4150 (void)sscanf(CS daystamp,"%u",&iexpire);
4152 /* When "iexpire" is < 7, a "flip" has occured.
4153 Adjust "inow" accordingly. */
4154 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4156 if (iexpire >= inow)
4158 prvscheck_result = US"1";
4159 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4163 prvscheck_result = NULL;
4164 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4169 prvscheck_result = NULL;
4170 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4173 /* Now expand the final argument. We leave this till now so that
4174 it can include $prvscheck_result. */
4176 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4178 case 1: goto EXPAND_FAILED_CURLY;
4180 case 3: goto EXPAND_FAILED;
4183 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4184 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4186 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4188 /* Reset the "internal" variables afterwards, because they are in
4189 dynamic store that will be reclaimed if the expansion succeeded. */
4191 prvscheck_address = NULL;
4192 prvscheck_keynum = NULL;
4196 /* Does not look like a prvs encoded address, return the empty string.
4197 We need to make sure all subs are expanded first, so as to skip over
4200 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4202 case 1: goto EXPAND_FAILED_CURLY;
4204 case 3: goto EXPAND_FAILED;
4211 /* Handle "readfile" to insert an entire file */
4213 case EITEM_READFILE:
4218 if ((expand_forbid & RDO_READFILE) != 0)
4220 expand_string_message = US"file insertions are not permitted";
4224 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4226 case 1: goto EXPAND_FAILED_CURLY;
4228 case 3: goto EXPAND_FAILED;
4231 /* If skipping, we don't actually do anything */
4233 if (skipping) continue;
4235 /* Open the file and read it */
4237 f = Ufopen(sub_arg[0], "rb");
4240 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4244 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4249 /* Handle "readsocket" to insert data from a Unix domain socket */
4251 case EITEM_READSOCK:
4257 struct sockaddr_un sockun; /* don't call this "sun" ! */
4261 if ((expand_forbid & RDO_READSOCK) != 0)
4263 expand_string_message = US"socket insertions are not permitted";
4267 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4268 because there may be a string for expansion on failure. */
4270 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4272 case 1: goto EXPAND_FAILED_CURLY;
4273 case 2: /* Won't occur: no end check */
4274 case 3: goto EXPAND_FAILED;
4277 /* Sort out timeout, if given */
4279 if (sub_arg[2] != NULL)
4281 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4284 expand_string_message = string_sprintf("bad time value %s",
4289 else sub_arg[3] = NULL; /* No eol if no timeout */
4291 /* If skipping, we don't actually do anything. Otherwise, arrange to
4292 connect to either an IP or a Unix socket. */
4296 /* Handle an IP (internet) domain */
4298 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4300 BOOL connected = FALSE;
4304 uschar *server_name = sub_arg[0] + 5;
4305 uschar *port_name = Ustrrchr(server_name, ':');
4307 /* Sort out the port */
4309 if (port_name == NULL)
4311 expand_string_message =
4312 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4315 *port_name++ = 0; /* Terminate server name */
4317 if (isdigit(*port_name))
4320 port = Ustrtol(port_name, &end, 0);
4321 if (end != port_name + Ustrlen(port_name))
4323 expand_string_message =
4324 string_sprintf("invalid port number %s", port_name);
4330 struct servent *service_info = getservbyname(CS port_name, "tcp");
4331 if (service_info == NULL)
4333 expand_string_message = string_sprintf("unknown port \"%s\"",
4337 port = ntohs(service_info->s_port);
4340 /* Sort out the server. */
4343 shost.address = NULL;
4347 namelen = Ustrlen(server_name);
4349 /* Anything enclosed in [] must be an IP address. */
4351 if (server_name[0] == '[' &&
4352 server_name[namelen - 1] == ']')
4354 server_name[namelen - 1] = 0;
4356 if (string_is_ip_address(server_name, NULL) == 0)
4358 expand_string_message =
4359 string_sprintf("malformed IP address \"%s\"", server_name);
4362 shost.name = shost.address = server_name;
4365 /* Otherwise check for an unadorned IP address */
4367 else if (string_is_ip_address(server_name, NULL) != 0)
4368 shost.name = shost.address = server_name;
4370 /* Otherwise lookup IP address(es) from the name */
4374 shost.name = server_name;
4375 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4376 FALSE) != HOST_FOUND)
4378 expand_string_message =
4379 string_sprintf("no IP address found for host %s", shost.name);
4384 /* Try to connect to the server - test each IP till one works */
4386 for (h = &shost; h != NULL; h = h->next)
4388 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4389 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4391 expand_string_message = string_sprintf("failed to create socket: "
4392 "%s", strerror(errno));
4396 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4405 expand_string_message = string_sprintf("failed to connect to "
4406 "socket %s: couldn't connect to any host", sub_arg[0],
4412 /* Handle a Unix domain socket */
4417 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4419 expand_string_message = string_sprintf("failed to create socket: %s",
4424 sockun.sun_family = AF_UNIX;
4425 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4428 sigalrm_seen = FALSE;
4430 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4434 expand_string_message = US "socket connect timed out";
4439 expand_string_message = string_sprintf("failed to connect to socket "
4440 "%s: %s", sub_arg[0], strerror(errno));
4445 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4447 /* Write the request string, if not empty */
4449 if (sub_arg[1][0] != 0)
4451 int len = Ustrlen(sub_arg[1]);
4452 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4454 if (write(fd, sub_arg[1], len) != len)
4456 expand_string_message = string_sprintf("request write to socket "
4457 "failed: %s", strerror(errno));
4462 /* Shut down the sending side of the socket. This helps some servers to
4463 recognise that it is their turn to do some work. Just in case some
4464 system doesn't have this function, make it conditional. */
4467 shutdown(fd, SHUT_WR);
4470 /* Now we need to read from the socket, under a timeout. The function
4471 that reads a file can be used. */
4473 f = fdopen(fd, "rb");
4474 sigalrm_seen = FALSE;
4476 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4480 /* After a timeout, we restore the pointer in the result, that is,
4481 make sure we add nothing from the socket. */
4486 expand_string_message = US "socket read timed out";
4491 /* The whole thing has worked (or we were skipping). If there is a
4492 failure string following, we need to skip it. */
4496 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4498 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4499 while (isspace(*s)) s++;
4501 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4504 /* Come here on failure to create socket, connect socket, write to the
4505 socket, or timeout on reading. If another substring follows, expand and
4506 use it. Otherwise, those conditions give expand errors. */
4509 if (*s != '{') goto EXPAND_FAILED;
4510 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4511 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4512 if (arg == NULL) goto EXPAND_FAILED;
4513 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4514 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4515 while (isspace(*s)) s++;
4516 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4520 /* Handle "run" to execute a program. */
4532 if ((expand_forbid & RDO_RUN) != 0)
4534 expand_string_message = US"running a command is not permitted";
4538 while (isspace(*s)) s++;
4539 if (*s != '{') goto EXPAND_FAILED_CURLY;
4540 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4541 if (arg == NULL) goto EXPAND_FAILED;
4542 while (isspace(*s)) s++;
4543 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4545 if (skipping) /* Just pretend it worked when we're skipping */
4551 if (!transport_set_up_command(&argv, /* anchor for arg list */
4552 arg, /* raw command */
4553 FALSE, /* don't expand the arguments */
4554 0, /* not relevant when... */
4555 NULL, /* no transporting address */
4556 US"${run} expansion", /* for error messages */
4557 &expand_string_message)) /* where to put error message */
4562 /* Create the child process, making it a group leader. */
4564 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4568 expand_string_message =
4569 string_sprintf("couldn't create child process: %s", strerror(errno));
4573 /* Nothing is written to the standard input. */
4577 /* Read the pipe to get the command's output into $value (which is kept
4578 in lookup_value). Read during execution, so that if the output exceeds
4579 the OS pipe buffer limit, we don't block forever. */
4581 f = fdopen(fd_out, "rb");
4582 sigalrm_seen = FALSE;
4584 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4588 /* Wait for the process to finish, applying the timeout, and inspect its
4589 return code for serious disasters. Simple non-zero returns are passed on.
4592 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4594 if (sigalrm_seen == TRUE || runrc == -256)
4596 expand_string_message = string_sprintf("command timed out");
4597 killpg(pid, SIGKILL); /* Kill the whole process group */
4600 else if (runrc == -257)
4601 expand_string_message = string_sprintf("wait() failed: %s",
4605 expand_string_message = string_sprintf("command killed by signal %d",
4612 /* Process the yes/no strings; $value may be useful in both cases */
4614 switch(process_yesno(
4615 skipping, /* were previously skipping */
4616 runrc == 0, /* success/failure indicator */
4617 lookup_value, /* value to reset for string2 */
4618 &s, /* input pointer */
4619 &yield, /* output pointer */
4620 &size, /* output size */
4621 &ptr, /* output current point */
4622 US"run")) /* condition type */
4624 case 1: goto EXPAND_FAILED; /* when all is well, the */
4625 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4631 /* Handle character translation for "tr" */
4639 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4641 case 1: goto EXPAND_FAILED_CURLY;
4643 case 3: goto EXPAND_FAILED;
4646 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4647 o2m = Ustrlen(sub[2]) - 1;
4649 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4651 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4655 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4662 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4663 expanded arguments. */
4673 int val[2] = { 0, -1 };
4676 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4677 Ensure that sub[2] is set in the ${length case. */
4680 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4683 case 1: goto EXPAND_FAILED_CURLY;
4685 case 3: goto EXPAND_FAILED;
4688 /* Juggle the arguments if there are only two of them: always move the
4689 string to the last position and make ${length{n}{str}} equivalent to
4690 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4696 if (item_type == EITEM_LENGTH)
4703 for (i = 0; i < 2; i++)
4705 if (sub[i] == NULL) continue;
4706 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4707 if (*ret != 0 || (i != 0 && val[i] < 0))
4709 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4710 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4716 (item_type == EITEM_HASH)?
4717 compute_hash(sub[2], val[0], val[1], &len) :
4718 (item_type == EITEM_NHASH)?
4719 compute_nhash(sub[2], val[0], val[1], &len) :
4720 extract_substr(sub[2], val[0], val[1], &len);
4722 if (ret == NULL) goto EXPAND_FAILED;
4723 yield = string_cat(yield, &size, &ptr, ret, len);
4727 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4728 This code originally contributed by Steve Haslam. It currently supports
4729 the use of MD5 and SHA-1 hashes.
4731 We need some workspace that is large enough to handle all the supported
4732 hash types. Use macros to set the sizes rather than be too elaborate. */
4734 #define MAX_HASHLEN 20
4735 #define MAX_HASHBLOCKLEN 64
4744 int hashlen; /* Number of octets for the hash algorithm's output */
4745 int hashblocklen; /* Number of octets the hash algorithm processes */
4747 unsigned int keylen;
4749 uschar keyhash[MAX_HASHLEN];
4750 uschar innerhash[MAX_HASHLEN];
4751 uschar finalhash[MAX_HASHLEN];
4752 uschar finalhash_hex[2*MAX_HASHLEN];
4753 uschar innerkey[MAX_HASHBLOCKLEN];
4754 uschar outerkey[MAX_HASHBLOCKLEN];
4756 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4758 case 1: goto EXPAND_FAILED_CURLY;
4760 case 3: goto EXPAND_FAILED;
4763 if (Ustrcmp(sub[0], "md5") == 0)
4766 use_base = &md5_base;
4770 else if (Ustrcmp(sub[0], "sha1") == 0)
4773 use_base = &sha1_base;
4779 expand_string_message =
4780 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4785 keylen = Ustrlen(keyptr);
4787 /* If the key is longer than the hash block length, then hash the key
4790 if (keylen > hashblocklen)
4792 chash_start(type, use_base);
4793 chash_end(type, use_base, keyptr, keylen, keyhash);
4798 /* Now make the inner and outer key values */
4800 memset(innerkey, 0x36, hashblocklen);
4801 memset(outerkey, 0x5c, hashblocklen);
4803 for (i = 0; i < keylen; i++)
4805 innerkey[i] ^= keyptr[i];
4806 outerkey[i] ^= keyptr[i];
4809 /* Now do the hashes */
4811 chash_start(type, use_base);
4812 chash_mid(type, use_base, innerkey);
4813 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4815 chash_start(type, use_base);
4816 chash_mid(type, use_base, outerkey);
4817 chash_end(type, use_base, innerhash, hashlen, finalhash);
4819 /* Encode the final hash as a hex string */
4822 for (i = 0; i < hashlen; i++)
4824 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4825 *p++ = hex_digits[finalhash[i] & 0x0f];
4828 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4829 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4831 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4836 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4837 We have to save the numerical variables and restore them afterwards. */
4842 int moffset, moffsetextra, slen;
4845 const uschar *rerror;
4848 int save_expand_nmax =
4849 save_expand_strings(save_expand_nstring, save_expand_nlength);
4851 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4853 case 1: goto EXPAND_FAILED_CURLY;
4855 case 3: goto EXPAND_FAILED;
4858 /* Compile the regular expression */
4860 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4865 expand_string_message = string_sprintf("regular expression error in "
4866 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4870 /* Now run a loop to do the substitutions as often as necessary. It ends
4871 when there are no more matches. Take care over matches of the null string;
4872 do the same thing as Perl does. */
4875 slen = Ustrlen(sub[0]);
4876 moffset = moffsetextra = 0;
4881 int ovector[3*(EXPAND_MAXN+1)];
4882 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4883 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4887 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4888 is not necessarily the end. We want to repeat the match from one
4889 character further along, but leaving the basic offset the same (for
4890 copying below). We can't be at the end of the string - that was checked
4891 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4892 finished; copy the remaining string and end the loop. */
4902 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4906 /* Match - set up for expanding the replacement. */
4908 if (n == 0) n = EXPAND_MAXN + 1;
4910 for (nn = 0; nn < n*2; nn += 2)
4912 expand_nstring[expand_nmax] = subject + ovector[nn];
4913 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4917 /* Copy the characters before the match, plus the expanded insertion. */
4919 yield = string_cat(yield, &size, &ptr, subject + moffset,
4920 ovector[0] - moffset);
4921 insert = expand_string(sub[2]);
4922 if (insert == NULL) goto EXPAND_FAILED;
4923 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4925 moffset = ovector[1];
4929 /* If we have matched an empty string, first check to see if we are at
4930 the end of the subject. If so, the loop is over. Otherwise, mimic
4931 what Perl's /g options does. This turns out to be rather cunning. First
4932 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4933 string at the same point. If this fails (picked up above) we advance to
4934 the next character. */
4936 if (ovector[0] == ovector[1])
4938 if (ovector[0] == slen) break;
4939 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4943 /* All done - restore numerical variables. */
4945 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4946 save_expand_nlength);
4950 /* Handle keyed and numbered substring extraction. If the first argument
4951 consists entirely of digits, then a numerical extraction is assumed. */
4957 int field_number = 1;
4958 BOOL field_number_set = FALSE;
4959 uschar *save_lookup_value = lookup_value;
4961 int save_expand_nmax =
4962 save_expand_strings(save_expand_nstring, save_expand_nlength);
4964 /* Read the arguments */
4966 for (i = 0; i < j; i++)
4968 while (isspace(*s)) s++;
4971 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4972 if (sub[i] == NULL) goto EXPAND_FAILED;
4973 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4975 /* After removal of leading and trailing white space, the first
4976 argument must not be empty; if it consists entirely of digits
4977 (optionally preceded by a minus sign), this is a numerical
4978 extraction, and we expect 3 arguments. */
4986 while (isspace(*p)) p++;
4990 while (len > 0 && isspace(p[len-1])) len--;
4993 if (*p == 0 && !skipping)
4995 expand_string_message = US"first argument of \"extract\" must "
5005 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5009 j = 3; /* Need 3 args */
5010 field_number_set = TRUE;
5014 else goto EXPAND_FAILED_CURLY;
5017 /* Extract either the numbered or the keyed substring into $value. If
5018 skipping, just pretend the extraction failed. */
5020 lookup_value = skipping? NULL : field_number_set?
5021 expand_gettokened(field_number, sub[1], sub[2]) :
5022 expand_getkeyed(sub[0], sub[1]);
5024 /* If no string follows, $value gets substituted; otherwise there can
5025 be yes/no strings, as for lookup or if. */
5027 switch(process_yesno(
5028 skipping, /* were previously skipping */
5029 lookup_value != NULL, /* success/failure indicator */
5030 save_lookup_value, /* value to reset for string2 */
5031 &s, /* input pointer */
5032 &yield, /* output pointer */
5033 &size, /* output size */
5034 &ptr, /* output current point */
5035 US"extract")) /* condition type */
5037 case 1: goto EXPAND_FAILED; /* when all is well, the */
5038 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5041 /* All done - restore numerical variables. */
5043 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5044 save_expand_nlength);
5050 /* Handle list operations */
5058 uschar outsep[2] = { '\0', '\0' };
5059 uschar *list, *expr, *temp;
5060 uschar *save_iterate_item = iterate_item;
5061 uschar *save_lookup_value = lookup_value;
5063 while (isspace(*s)) s++;
5064 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5066 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5067 if (list == NULL) goto EXPAND_FAILED;
5068 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5070 if (item_type == EITEM_REDUCE)
5072 while (isspace(*s)) s++;
5073 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5074 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5075 if (temp == NULL) goto EXPAND_FAILED;
5076 lookup_value = temp;
5077 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5080 while (isspace(*s)) s++;
5081 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5085 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5086 if scanning a "false" part). This allows us to find the end of the
5087 condition, because if the list is empty, we won't actually evaluate the
5088 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5089 the normal internal expansion function. */
5091 if (item_type == EITEM_FILTER)
5093 temp = eval_condition(expr, NULL);
5094 if (temp != NULL) s = temp;
5098 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5103 expand_string_message = string_sprintf("%s inside \"%s\" item",
5104 expand_string_message, name);
5108 while (isspace(*s)) s++;
5111 expand_string_message = string_sprintf("missing } at end of condition "
5112 "or expression inside \"%s\"", name);
5116 while (isspace(*s)) s++;
5119 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5124 /* If we are skipping, we can now just move on to the next item. When
5125 processing for real, we perform the iteration. */
5127 if (skipping) continue;
5128 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5130 *outsep = (uschar)sep; /* Separator as a string */
5132 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5134 if (item_type == EITEM_FILTER)
5137 if (eval_condition(expr, &condresult) == NULL)
5139 iterate_item = save_iterate_item;
5140 lookup_value = save_lookup_value;
5141 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5142 expand_string_message, name);
5145 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5146 condresult? "true":"false");
5148 temp = iterate_item; /* TRUE => include this item */
5150 continue; /* FALSE => skip this item */
5153 /* EITEM_MAP and EITEM_REDUCE */
5157 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5160 iterate_item = save_iterate_item;
5161 expand_string_message = string_sprintf("%s inside \"%s\" item",
5162 expand_string_message, name);
5165 if (item_type == EITEM_REDUCE)
5167 lookup_value = temp; /* Update the value of $value */
5168 continue; /* and continue the iteration */
5172 /* We reach here for FILTER if the condition is true, always for MAP,
5173 and never for REDUCE. The value in "temp" is to be added to the output
5174 list that is being created, ensuring that any occurrences of the
5175 separator character are doubled. Unless we are dealing with the first
5176 item of the output list, add in a space if the new item begins with the
5177 separator character, or is an empty string. */
5179 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5180 yield = string_cat(yield, &size, &ptr, US" ", 1);
5182 /* Add the string in "temp" to the output list that we are building,
5183 This is done in chunks by searching for the separator character. */
5187 size_t seglen = Ustrcspn(temp, outsep);
5188 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5190 /* If we got to the end of the string we output one character
5191 too many; backup and end the loop. Otherwise arrange to double the
5194 if (temp[seglen] == '\0') { ptr--; break; }
5195 yield = string_cat(yield, &size, &ptr, outsep, 1);
5199 /* Output a separator after the string: we will remove the redundant
5200 final one at the end. */
5202 yield = string_cat(yield, &size, &ptr, outsep, 1);
5203 } /* End of iteration over the list loop */
5205 /* REDUCE has generated no output above: output the final value of
5208 if (item_type == EITEM_REDUCE)
5210 yield = string_cat(yield, &size, &ptr, lookup_value,
5211 Ustrlen(lookup_value));
5212 lookup_value = save_lookup_value; /* Restore $value */
5215 /* FILTER and MAP generate lists: if they have generated anything, remove
5216 the redundant final separator. Even though an empty item at the end of a
5217 list does not count, this is tidier. */
5219 else if (ptr != save_ptr) ptr--;
5221 /* Restore preserved $item */
5223 iterate_item = save_iterate_item;
5228 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5229 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5230 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5231 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5233 #define EXPAND_DLFUNC_MAX_ARGS 8
5236 #ifndef EXPAND_DLFUNC
5237 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5238 "is not included in this binary";
5241 #else /* EXPAND_DLFUNC */
5244 exim_dlfunc_t *func;
5247 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5249 if ((expand_forbid & RDO_DLFUNC) != 0)
5251 expand_string_message =
5252 US"dynamically-loaded functions are not permitted";
5256 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5259 case 1: goto EXPAND_FAILED_CURLY;
5261 case 3: goto EXPAND_FAILED;
5264 /* If skipping, we don't actually do anything */
5266 if (skipping) continue;
5268 /* Look up the dynamically loaded object handle in the tree. If it isn't
5269 found, dlopen() the file and put the handle in the tree for next time. */
5271 t = tree_search(dlobj_anchor, argv[0]);
5274 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5277 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5278 argv[0], dlerror());
5279 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5282 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5283 Ustrcpy(t->name, argv[0]);
5284 t->data.ptr = handle;
5285 (void)tree_insertnode(&dlobj_anchor, t);
5288 /* Having obtained the dynamically loaded object handle, look up the
5289 function pointer. */
5291 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5294 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5295 "%s", argv[1], argv[0], dlerror());
5296 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5300 /* Call the function and work out what to do with the result. If it
5301 returns OK, we have a replacement string; if it returns DEFER then
5302 expansion has failed in a non-forced manner; if it returns FAIL then
5303 failure was forced; if it returns ERROR or any other value there's a
5304 problem, so panic slightly. In any case, assume that the function has
5305 side-effects on the store that must be preserved. */
5309 for (argc = 0; argv[argc] != NULL; argc++);
5310 status = func(&result, argc - 2, &argv[2]);
5313 if (result == NULL) result = US"";
5314 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5319 expand_string_message = result == NULL ? US"(no message)" : result;
5320 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5321 else if(status != FAIL)
5322 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5323 argv[0], argv[1], status, expand_string_message);
5327 #endif /* EXPAND_DLFUNC */
5330 /* Control reaches here if the name is not recognized as one of the more
5331 complicated expansion items. Check for the "operator" syntax (name terminated
5332 by a colon). Some of the operators have arguments, separated by _ from the
5339 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5340 if (sub == NULL) goto EXPAND_FAILED;
5343 /* Owing to an historical mis-design, an underscore may be part of the
5344 operator name, or it may introduce arguments. We therefore first scan the
5345 table of names that contain underscores. If there is no match, we cut off
5346 the arguments and then scan the main table. */
5348 c = chop_match(name, op_table_underscore,
5349 sizeof(op_table_underscore)/sizeof(uschar *));
5353 arg = Ustrchr(name, '_');
5354 if (arg != NULL) *arg = 0;
5355 c = chop_match(name, op_table_main,
5356 sizeof(op_table_main)/sizeof(uschar *));
5357 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5358 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5361 /* If we are skipping, we don't need to perform the operation at all.
5362 This matters for operations like "mask", because the data may not be
5363 in the correct format when skipping. For example, the expression may test
5364 for the existence of $sender_host_address before trying to mask it. For
5365 other operations, doing them may not fail, but it is a waste of time. */
5367 if (skipping && c >= 0) continue;
5369 /* Otherwise, switch on the operator type */
5376 unsigned long int n = Ustrtoul(sub, &t, 10);
5379 expand_string_message = string_sprintf("argument for base62 "
5380 "operator is \"%s\", which is not a decimal number", sub);
5383 t = string_base62(n);
5384 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5388 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5394 unsigned long int n = 0;
5397 uschar *t = Ustrchr(base62_chars, *tt++);
5400 expand_string_message = string_sprintf("argument for base62d "
5401 "operator is \"%s\", which is not a base %d number", sub,
5405 n = n * BASE_62 + (t - base62_chars);
5407 (void)sprintf(CS buf, "%ld", n);
5408 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5414 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5415 if (expanded == NULL)
5417 expand_string_message =
5418 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5419 expand_string_message);
5422 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5429 uschar *t = sub - 1;
5430 while (*(++t) != 0) { *t = tolower(*t); count++; }
5431 yield = string_cat(yield, &size, &ptr, sub, count);
5438 uschar *t = sub - 1;
5439 while (*(++t) != 0) { *t = toupper(*t); count++; }
5440 yield = string_cat(yield, &size, &ptr, sub, count);
5451 md5_end(&base, sub, Ustrlen(sub), digest);
5452 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5453 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5464 sha1_end(&base, sub, Ustrlen(sub), digest);
5465 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5466 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5470 /* Convert hex encoding to base64 encoding */
5480 for (enc = sub; *enc != 0; enc++)
5482 if (!isxdigit(*enc))
5484 expand_string_message = string_sprintf("\"%s\" is not a hex "
5493 expand_string_message = string_sprintf("\"%s\" contains an odd "
5494 "number of characters", sub);
5498 while ((c = *in++) != 0)
5500 if (isdigit(c)) c -= '0';
5501 else c = toupper(c) - 'A' + 10;
5513 enc = auth_b64encode(sub, out - sub);
5514 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5518 /* count the number of list elements */
5527 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5528 cp = string_sprintf("%d", cnt);
5529 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5533 /* expand a named list given the name */
5534 /* handles nested named lists; requotes as colon-sep list */
5538 tree_node *t = NULL;
5542 uschar * suffix = "";
5543 BOOL needsep = FALSE;
5546 if (*sub == '+') sub++;
5547 if (arg == NULL) /* no-argument version */
5549 if (!(t = tree_search(addresslist_anchor, sub)) &&
5550 !(t = tree_search(domainlist_anchor, sub)) &&
5551 !(t = tree_search(hostlist_anchor, sub)))
5552 t = tree_search(localpartlist_anchor, sub);
5554 else switch(*arg) /* specific list-type version */
5556 case 'a': t = tree_search(addresslist_anchor, sub); suffix = "_a"; break;
5557 case 'd': t = tree_search(domainlist_anchor, sub); suffix = "_d"; break;
5558 case 'h': t = tree_search(hostlist_anchor, sub); suffix = "_h"; break;
5559 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = "_l"; break;
5561 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5567 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5569 : *arg=='a'?"address "
5570 : *arg=='d'?"domain "
5572 : *arg=='l'?"localpart "
5577 list = ((namedlist_block *)(t->data.ptr))->string;
5579 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5581 uschar * buf = US" : ";
5583 yield = string_cat(yield, &size, &ptr, buf, 3);
5587 if (*item == '+') /* list item is itself a named list */
5589 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5590 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE);
5592 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5596 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5597 while ((cp= strpbrk((const char *)item, tok)))
5599 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5600 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5602 yield = string_cat(yield, &size, &ptr, US"::", 2);
5605 else /* sep in item; should already be doubled; emit once */
5607 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5608 if (*cp == sep) cp++;
5613 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5618 /* mask applies a mask to an IP address; for example the result of
5619 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5626 int mask, maskoffset;
5627 int type = string_is_ip_address(sub, &maskoffset);
5632 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5637 if (maskoffset == 0)
5639 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5644 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5646 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5648 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5653 /* Convert the address to binary integer(s) and apply the mask */
5655 sub[maskoffset] = 0;
5656 count = host_aton(sub, binary);
5657 host_mask(count, binary, mask);
5659 /* Convert to masked textual format and add to output. */
5661 yield = string_cat(yield, &size, &ptr, buffer,
5662 host_nmtoa(count, binary, mask, buffer, '.'));
5667 case EOP_LOCAL_PART:
5671 int start, end, domain;
5672 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5676 if (c != EOP_DOMAIN)
5678 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5679 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5681 else if (domain != 0)
5684 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5692 uschar outsep[2] = { ':', '\0' };
5693 uschar *address, *error;
5695 int start, end, domain; /* Not really used */
5697 while (isspace(*sub)) sub++;
5698 if (*sub == '>') { *outsep = *++sub; ++sub; }
5699 parse_allow_group = TRUE;
5703 uschar *p = parse_find_address_end(sub, FALSE);
5704 uschar saveend = *p;
5706 address = parse_extract_address(sub, &error, &start, &end, &domain,
5710 /* Add the address to the output list that we are building. This is
5711 done in chunks by searching for the separator character. At the
5712 start, unless we are dealing with the first address of the output
5713 list, add in a space if the new address begins with the separator
5714 character, or is an empty string. */
5716 if (address != NULL)
5718 if (ptr != save_ptr && address[0] == *outsep)
5719 yield = string_cat(yield, &size, &ptr, US" ", 1);
5723 size_t seglen = Ustrcspn(address, outsep);
5724 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5726 /* If we got to the end of the string we output one character
5729 if (address[seglen] == '\0') { ptr--; break; }
5730 yield = string_cat(yield, &size, &ptr, outsep, 1);
5731 address += seglen + 1;
5734 /* Output a separator after the string: we will remove the
5735 redundant final one at the end. */
5737 yield = string_cat(yield, &size, &ptr, outsep, 1);
5740 if (saveend == '\0') break;
5744 /* If we have generated anything, remove the redundant final
5747 if (ptr != save_ptr) ptr--;
5748 parse_allow_group = FALSE;
5753 /* quote puts a string in quotes if it is empty or contains anything
5754 other than alphamerics, underscore, dot, or hyphen.
5756 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5757 be quoted in order to be a valid local part.
5759 In both cases, newlines and carriage returns are converted into \n and \r
5763 case EOP_QUOTE_LOCAL_PART:
5766 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5767 uschar *t = sub - 1;
5771 while (!needs_quote && *(++t) != 0)
5772 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5774 else /* EOP_QUOTE_LOCAL_PART */
5776 while (!needs_quote && *(++t) != 0)
5777 needs_quote = !isalnum(*t) &&
5778 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5779 (*t != '.' || t == sub || t[1] == 0);
5784 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5789 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5790 else if (*t == '\r')
5791 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5794 if (*t == '\\' || *t == '"')
5795 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5796 yield = string_cat(yield, &size, &ptr, t, 1);
5799 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5801 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5805 /* quote_lookuptype does lookup-specific quoting */
5810 uschar *opt = Ustrchr(arg, '_');
5812 if (opt != NULL) *opt++ = 0;
5814 n = search_findtype(arg, Ustrlen(arg));
5817 expand_string_message = search_error_message;
5821 if (lookup_list[n]->quote != NULL)
5822 sub = (lookup_list[n]->quote)(sub, opt);
5823 else if (opt != NULL) sub = NULL;
5827 expand_string_message = string_sprintf(
5828 "\"%s\" unrecognized after \"${quote_%s\"",
5833 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5837 /* rx quote sticks in \ before any non-alphameric character so that
5838 the insertion works in a regular expression. */
5842 uschar *t = sub - 1;
5846 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5847 yield = string_cat(yield, &size, &ptr, t, 1);
5852 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5853 prescribed by the RFC, if there are characters that need to be encoded */
5857 uschar buffer[2048];
5858 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5859 buffer, sizeof(buffer), FALSE);
5860 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5864 /* RFC 2047 decode */
5870 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5871 headers_charset, '?', &len, &error);
5874 expand_string_message = error;
5877 yield = string_cat(yield, &size, &ptr, decoded, len);
5881 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5891 if (c > 255) c = '_';
5893 yield = string_cat(yield, &size, &ptr, buff, 1);
5898 /* escape turns all non-printing characters into escape sequences. */
5902 uschar *t = string_printing(sub);
5903 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5907 /* Handle numeric expression evaluation */
5912 uschar *save_sub = sub;
5913 uschar *error = NULL;
5914 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5917 expand_string_message = string_sprintf("error in expression "
5918 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5922 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
5923 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5927 /* Handle time period formating */
5931 int n = readconf_readtime(sub, 0, FALSE);
5934 expand_string_message = string_sprintf("string \"%s\" is not an "
5935 "Exim time interval in \"%s\" operator", sub, name);
5938 sprintf(CS var_buffer, "%d", n);
5939 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5943 case EOP_TIME_INTERVAL:
5946 uschar *t = read_number(&n, sub);
5947 if (*t != 0) /* Not A Number*/
5949 expand_string_message = string_sprintf("string \"%s\" is not a "
5950 "positive number in \"%s\" operator", sub, name);
5953 t = readconf_printtime(n);
5954 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5958 /* Convert string to base64 encoding */
5962 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5963 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5967 /* strlen returns the length of the string */
5972 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5973 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5977 /* length_n or l_n takes just the first n characters or the whole string,
5978 whichever is the shorter;
5980 substr_m_n, and s_m_n take n characters from offset m; negative m take
5981 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5982 takes the rest, either to the right or to the left.
5984 hash_n or h_n makes a hash of length n from the string, yielding n
5985 characters from the set a-z; hash_n_m makes a hash of length n, but
5986 uses m characters from the set a-zA-Z0-9.
5988 nhash_n returns a single number between 0 and n-1 (in text form), while
5989 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5990 between 0 and n-1 and the second between 0 and m-1. */
6010 expand_string_message = string_sprintf("missing values after %s",
6015 /* "length" has only one argument, effectively being synonymous with
6018 if (c == EOP_LENGTH || c == EOP_L)
6024 /* The others have one or two arguments; for "substr" the first may be
6025 negative. The second being negative means "not supplied". */
6030 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6033 /* Read up to two numbers, separated by underscores */
6038 if (arg != ret && *arg == '_' && pn == &value1)
6042 if (arg[1] != 0) arg++;
6044 else if (!isdigit(*arg))
6046 expand_string_message =
6047 string_sprintf("non-digit after underscore in \"%s\"", name);
6050 else *pn = (*pn)*10 + *arg++ - '0';
6054 /* Perform the required operation */
6057 (c == EOP_HASH || c == EOP_H)?
6058 compute_hash(sub, value1, value2, &len) :
6059 (c == EOP_NHASH || c == EOP_NH)?
6060 compute_nhash(sub, value1, value2, &len) :
6061 extract_substr(sub, value1, value2, &len);
6063 if (ret == NULL) goto EXPAND_FAILED;
6064 yield = string_cat(yield, &size, &ptr, ret, len);
6074 uschar **modetable[3];
6079 if ((expand_forbid & RDO_EXISTS) != 0)
6081 expand_string_message = US"Use of the stat() expansion is not permitted";
6085 if (stat(CS sub, &st) < 0)
6087 expand_string_message = string_sprintf("stat(%s) failed: %s",
6088 sub, strerror(errno));
6092 switch (mode & S_IFMT)
6094 case S_IFIFO: smode[0] = 'p'; break;
6095 case S_IFCHR: smode[0] = 'c'; break;
6096 case S_IFDIR: smode[0] = 'd'; break;
6097 case S_IFBLK: smode[0] = 'b'; break;
6098 case S_IFREG: smode[0] = '-'; break;
6099 default: smode[0] = '?'; break;
6102 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6103 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6104 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6106 for (i = 0; i < 3; i++)
6108 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6113 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6114 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6115 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6116 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6117 (long)st.st_gid, st.st_size, (long)st.st_atime,
6118 (long)st.st_mtime, (long)st.st_ctime);
6119 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6123 /* vaguely random number less than N */
6127 int_eximarith_t max;
6130 max = expand_string_integer(sub, TRUE);
6131 if (expand_string_message != NULL)
6133 s = string_sprintf("%d", vaguely_random_number((int)max));
6134 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6138 /* Reverse IP, including IPv6 to dotted-nibble */
6140 case EOP_REVERSE_IP:
6142 int family, maskptr;
6143 uschar reversed[128];
6145 family = string_is_ip_address(sub, &maskptr);
6148 expand_string_message = string_sprintf(
6149 "reverse_ip() not given an IP address [%s]", sub);
6152 invert_address(reversed, sub);
6153 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6157 /* Unknown operator */
6160 expand_string_message =
6161 string_sprintf("unknown expansion operator \"%s\"", name);
6166 /* Handle a plain name. If this is the first thing in the expansion, release
6167 the pre-allocated buffer. If the result data is known to be in a new buffer,
6168 newsize will be set to the size of that buffer, and we can just point at that
6169 store instead of copying. Many expansion strings contain just one reference,
6170 so this is a useful optimization, especially for humungous headers
6171 ($message_headers). */
6179 if (resetok) store_reset(yield);
6183 value = find_variable(name, FALSE, skipping, &newsize);
6186 expand_string_message =
6187 string_sprintf("unknown variable in \"${%s}\"", name);
6188 check_variable_error_message(name);
6191 len = Ustrlen(value);
6192 if (yield == NULL && newsize != 0)
6198 else yield = string_cat(yield, &size, &ptr, value, len);
6202 /* Else there's something wrong */
6204 expand_string_message =
6205 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6206 "in a variable reference)", name);
6210 /* If we hit the end of the string when ket_ends is set, there is a missing
6211 terminating brace. */
6213 if (ket_ends && *s == 0)
6215 expand_string_message = malformed_header?
6216 US"missing } at end of string - could be header name not terminated by colon"
6218 US"missing } at end of string";
6222 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6223 added to the string. If so, set up an empty string. Add a terminating zero. If
6224 left != NULL, return a pointer to the terminator. */
6226 if (yield == NULL) yield = store_get(1);
6228 if (left != NULL) *left = s;
6230 /* Any stacking store that was used above the final string is no longer needed.
6231 In many cases the final string will be the first one that was got and so there
6232 will be optimal store usage. */
6234 if (resetok) store_reset(yield + ptr + 1);
6237 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6239 if (skipping) debug_printf("skipping: result is not used\n");
6243 /* This is the failure exit: easiest to program with a goto. We still need
6244 to update the pointer to the terminator, for cases of nested calls with "fail".
6247 EXPAND_FAILED_CURLY:
6248 expand_string_message = malformed_header?
6249 US"missing or misplaced { or } - could be header name not terminated by colon"
6251 US"missing or misplaced { or }";
6253 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6254 that is a bad idea, because expand_string_message is in dynamic store. */
6257 if (left != NULL) *left = s;
6260 debug_printf("failed to expand: %s\n", string);
6261 debug_printf(" error message: %s\n", expand_string_message);
6262 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6268 /* This is the external function call. Do a quick check for any expansion
6269 metacharacters, and if there are none, just return the input string.
6271 Argument: the string to be expanded
6272 Returns: the expanded string, or NULL if expansion failed; if failure was
6273 due to a lookup deferring, search_find_defer will be TRUE
6277 expand_string(uschar *string)
6279 search_find_defer = FALSE;
6280 malformed_header = FALSE;
6281 return (Ustrpbrk(string, "$\\") == NULL)? string :
6282 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6287 /*************************************************
6289 *************************************************/
6291 /* Now and again we want to expand a string and be sure that the result is in a
6292 new bit of store. This function does that.
6294 Argument: the string to be expanded
6295 Returns: the expanded string, always in a new bit of store, or NULL
6299 expand_string_copy(uschar *string)
6301 uschar *yield = expand_string(string);
6302 if (yield == string) yield = string_copy(string);
6308 /*************************************************
6309 * Expand and interpret as an integer *
6310 *************************************************/
6312 /* Expand a string, and convert the result into an integer.
6315 string the string to be expanded
6316 isplus TRUE if a non-negative number is expected
6318 Returns: the integer value, or
6319 -1 for an expansion error ) in both cases, message in
6320 -2 for an integer interpretation error ) expand_string_message
6321 expand_string_message is set NULL for an OK integer
6325 expand_string_integer(uschar *string, BOOL isplus)
6327 int_eximarith_t value;
6328 uschar *s = expand_string(string);
6329 uschar *msg = US"invalid integer \"%s\"";
6332 /* If expansion failed, expand_string_message will be set. */
6334 if (s == NULL) return -1;
6336 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6337 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6338 systems, so we set it zero ourselves. */
6341 expand_string_message = NULL; /* Indicates no error */
6343 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6344 equal to 0. Unfortunately, people actually relied upon that, so preserve
6345 the behaviour explicitly. Stripping leading whitespace is a harmless
6346 noop change since strtol skips it anyway (provided that there is a number
6350 while (isspace(*s)) ++s;
6354 debug_printf("treating blank string as number 0\n");
6359 value = strtoll(CS s, CSS &endptr, 10);
6363 msg = US"integer expected but \"%s\" found";
6365 else if (value < 0 && isplus)
6367 msg = US"non-negative integer expected but \"%s\" found";
6371 switch (tolower(*endptr))
6376 if (value > LLONG_MAX/1024 || value < LLONG_MIN/1024) errno = ERANGE;
6381 if (value > LLONG_MAX/(1024*1024) || value < LLONG_MIN/(1024*1024)) errno = ERANGE;
6382 else value *= 1024*1024;
6386 if (value > LLONG_MAX/(1024*1024*1024) || value < LLONG_MIN/(1024*1024*1024)) errno = ERANGE;
6387 else value *= 1024*1024*1024;
6391 if (errno == ERANGE)
6392 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6395 while (isspace(*endptr)) endptr++;
6396 if (*endptr == 0) return (int)value;
6400 expand_string_message = string_sprintf(CS msg, s);
6405 /*************************************************
6406 **************************************************
6407 * Stand-alone test program *
6408 **************************************************
6409 *************************************************/
6415 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6417 int ovector[3*(EXPAND_MAXN+1)];
6418 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6419 ovector, sizeof(ovector)/sizeof(int));
6420 BOOL yield = n >= 0;
6421 if (n == 0) n = EXPAND_MAXN + 1;
6425 expand_nmax = (setup < 0)? 0 : setup + 1;
6426 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6428 expand_nstring[expand_nmax] = subject + ovector[nn];
6429 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6437 int main(int argc, uschar **argv)
6440 uschar buffer[1024];
6442 debug_selector = D_v;
6443 debug_file = stderr;
6444 debug_fd = fileno(debug_file);
6445 big_buffer = malloc(big_buffer_size);
6447 for (i = 1; i < argc; i++)
6449 if (argv[i][0] == '+')
6451 debug_trace_memory = 2;
6454 if (isdigit(argv[i][0]))
6455 debug_selector = Ustrtol(argv[i], NULL, 0);
6457 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6461 eldap_default_servers = argv[i];
6464 mysql_servers = argv[i];
6467 pgsql_servers = argv[i];
6471 else opt_perl_startup = argv[i];
6475 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6477 expand_nstring[1] = US"string 1....";
6478 expand_nlength[1] = 8;
6482 if (opt_perl_startup != NULL)
6485 printf("Starting Perl interpreter\n");
6486 errstr = init_perl(opt_perl_startup);
6489 printf("** error in perl_startup code: %s\n", errstr);
6490 return EXIT_FAILURE;
6493 #endif /* EXIM_PERL */
6495 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6497 void *reset_point = store_get(0);
6498 uschar *yield = expand_string(buffer);
6501 printf("%s\n", yield);
6502 store_reset(reset_point);
6506 if (search_find_defer) printf("search_find deferred\n");
6507 printf("Failed: %s\n", expand_string_message);
6508 if (expand_string_forcedfail) printf("Forced failure\n");
6520 /* End of expand.c */