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 */
282 US"match_local_part",
307 ECOND_FIRST_DELIVERY,
328 ECOND_MATCH_LOCAL_PART,
338 /* Type for main variable table */
346 /* Type for entries pointing to address/length pairs. Not currently
354 /* Types of table entry */
357 vtype_int, /* value is address of int */
358 vtype_filter_int, /* ditto, but recognized only when filtering */
359 vtype_ino, /* value is address of ino_t (not always an int) */
360 vtype_uid, /* value is address of uid_t (not always an int) */
361 vtype_gid, /* value is address of gid_t (not always an int) */
362 vtype_bool, /* value is address of bool */
363 vtype_stringptr, /* value is address of pointer to string */
364 vtype_msgbody, /* as stringptr, but read when first required */
365 vtype_msgbody_end, /* ditto, the end of the message */
366 vtype_msgheaders, /* the message's headers, processed */
367 vtype_msgheaders_raw, /* the message's headers, unprocessed */
368 vtype_localpart, /* extract local part from string */
369 vtype_domain, /* extract domain from string */
370 vtype_string_func, /* value is string returned by given function */
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 static uschar * fn_recipients(void);
392 /* This table must be kept in alphabetical order. */
394 static var_entry var_table[] = {
395 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
396 they will be confused with user-creatable ACL variables. */
397 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
398 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
399 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
400 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
401 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
402 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
403 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
404 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
405 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
406 { "acl_narg", vtype_int, &acl_narg },
407 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
408 { "address_data", vtype_stringptr, &deliver_address_data },
409 { "address_file", vtype_stringptr, &address_file },
410 { "address_pipe", vtype_stringptr, &address_pipe },
411 { "authenticated_id", vtype_stringptr, &authenticated_id },
412 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
413 { "authentication_failed",vtype_int, &authentication_failed },
414 #ifdef WITH_CONTENT_SCAN
415 { "av_failed", vtype_int, &av_failed },
417 #ifdef EXPERIMENTAL_BRIGHTMAIL
418 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
419 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
420 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
421 { "bmi_deliver", vtype_int, &bmi_deliver },
423 { "body_linecount", vtype_int, &body_linecount },
424 { "body_zerocount", vtype_int, &body_zerocount },
425 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
426 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
427 { "caller_gid", vtype_gid, &real_gid },
428 { "caller_uid", vtype_uid, &real_uid },
429 { "compile_date", vtype_stringptr, &version_date },
430 { "compile_number", vtype_stringptr, &version_cnumber },
431 { "csa_status", vtype_stringptr, &csa_status },
432 #ifdef EXPERIMENTAL_DCC
433 { "dcc_header", vtype_stringptr, &dcc_header },
434 { "dcc_result", vtype_stringptr, &dcc_result },
436 #ifdef WITH_OLD_DEMIME
437 { "demime_errorlevel", vtype_int, &demime_errorlevel },
438 { "demime_reason", vtype_stringptr, &demime_reason },
441 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
442 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
443 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
444 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
445 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
446 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
447 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
448 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
449 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
450 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
451 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
452 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
453 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
454 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
455 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
456 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
457 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
458 { "dkim_signers", vtype_stringptr, &dkim_signers },
459 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
460 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
462 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
463 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
464 { "dnslist_text", vtype_stringptr, &dnslist_text },
465 { "dnslist_value", vtype_stringptr, &dnslist_value },
466 { "domain", vtype_stringptr, &deliver_domain },
467 { "domain_data", vtype_stringptr, &deliver_domain_data },
468 { "exim_gid", vtype_gid, &exim_gid },
469 { "exim_path", vtype_stringptr, &exim_path },
470 { "exim_uid", vtype_uid, &exim_uid },
471 #ifdef WITH_OLD_DEMIME
472 { "found_extension", vtype_stringptr, &found_extension },
474 { "headers_added", vtype_string_func, &fn_hdrs_added },
475 { "home", vtype_stringptr, &deliver_home },
476 { "host", vtype_stringptr, &deliver_host },
477 { "host_address", vtype_stringptr, &deliver_host_address },
478 { "host_data", vtype_stringptr, &host_data },
479 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
480 { "host_lookup_failed", vtype_int, &host_lookup_failed },
481 { "inode", vtype_ino, &deliver_inode },
482 { "interface_address", vtype_stringptr, &interface_address },
483 { "interface_port", vtype_int, &interface_port },
484 { "item", vtype_stringptr, &iterate_item },
486 { "ldap_dn", vtype_stringptr, &eldap_dn },
488 { "load_average", vtype_load_avg, NULL },
489 { "local_part", vtype_stringptr, &deliver_localpart },
490 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
491 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
492 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
493 { "local_scan_data", vtype_stringptr, &local_scan_data },
494 { "local_user_gid", vtype_gid, &local_user_gid },
495 { "local_user_uid", vtype_uid, &local_user_uid },
496 { "localhost_number", vtype_int, &host_number },
497 { "log_inodes", vtype_pinodes, (void *)FALSE },
498 { "log_space", vtype_pspace, (void *)FALSE },
499 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
500 #ifdef WITH_CONTENT_SCAN
501 { "malware_name", vtype_stringptr, &malware_name },
503 { "max_received_linelength", vtype_int, &max_received_linelength },
504 { "message_age", vtype_int, &message_age },
505 { "message_body", vtype_msgbody, &message_body },
506 { "message_body_end", vtype_msgbody_end, &message_body_end },
507 { "message_body_size", vtype_int, &message_body_size },
508 { "message_exim_id", vtype_stringptr, &message_id },
509 { "message_headers", vtype_msgheaders, NULL },
510 { "message_headers_raw", vtype_msgheaders_raw, NULL },
511 { "message_id", vtype_stringptr, &message_id },
512 { "message_linecount", vtype_int, &message_linecount },
513 { "message_size", vtype_int, &message_size },
514 #ifdef WITH_CONTENT_SCAN
515 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
516 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
517 { "mime_boundary", vtype_stringptr, &mime_boundary },
518 { "mime_charset", vtype_stringptr, &mime_charset },
519 { "mime_content_description", vtype_stringptr, &mime_content_description },
520 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
521 { "mime_content_id", vtype_stringptr, &mime_content_id },
522 { "mime_content_size", vtype_int, &mime_content_size },
523 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
524 { "mime_content_type", vtype_stringptr, &mime_content_type },
525 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
526 { "mime_filename", vtype_stringptr, &mime_filename },
527 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
528 { "mime_is_multipart", vtype_int, &mime_is_multipart },
529 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
530 { "mime_part_count", vtype_int, &mime_part_count },
532 { "n0", vtype_filter_int, &filter_n[0] },
533 { "n1", vtype_filter_int, &filter_n[1] },
534 { "n2", vtype_filter_int, &filter_n[2] },
535 { "n3", vtype_filter_int, &filter_n[3] },
536 { "n4", vtype_filter_int, &filter_n[4] },
537 { "n5", vtype_filter_int, &filter_n[5] },
538 { "n6", vtype_filter_int, &filter_n[6] },
539 { "n7", vtype_filter_int, &filter_n[7] },
540 { "n8", vtype_filter_int, &filter_n[8] },
541 { "n9", vtype_filter_int, &filter_n[9] },
542 { "original_domain", vtype_stringptr, &deliver_domain_orig },
543 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
544 { "originator_gid", vtype_gid, &originator_gid },
545 { "originator_uid", vtype_uid, &originator_uid },
546 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
547 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
548 { "pid", vtype_pid, NULL },
549 { "primary_hostname", vtype_stringptr, &primary_hostname },
550 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
551 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
552 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
553 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
554 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
555 { "rcpt_count", vtype_int, &rcpt_count },
556 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
557 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
558 { "received_count", vtype_int, &received_count },
559 { "received_for", vtype_stringptr, &received_for },
560 { "received_ip_address", vtype_stringptr, &interface_address },
561 { "received_port", vtype_int, &interface_port },
562 { "received_protocol", vtype_stringptr, &received_protocol },
563 { "received_time", vtype_int, &received_time },
564 { "recipient_data", vtype_stringptr, &recipient_data },
565 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
566 { "recipients", vtype_string_func, &fn_recipients },
567 { "recipients_count", vtype_int, &recipients_count },
568 #ifdef WITH_CONTENT_SCAN
569 { "regex_match_string", vtype_stringptr, ®ex_match_string },
571 { "reply_address", vtype_reply, NULL },
572 { "return_path", vtype_stringptr, &return_path },
573 { "return_size_limit", vtype_int, &bounce_return_size_limit },
574 { "runrc", vtype_int, &runrc },
575 { "self_hostname", vtype_stringptr, &self_hostname },
576 { "sender_address", vtype_stringptr, &sender_address },
577 { "sender_address_data", vtype_stringptr, &sender_address_data },
578 { "sender_address_domain", vtype_domain, &sender_address },
579 { "sender_address_local_part", vtype_localpart, &sender_address },
580 { "sender_data", vtype_stringptr, &sender_data },
581 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
582 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
583 { "sender_host_address", vtype_stringptr, &sender_host_address },
584 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
585 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
586 { "sender_host_name", vtype_host_lookup, NULL },
587 { "sender_host_port", vtype_int, &sender_host_port },
588 { "sender_ident", vtype_stringptr, &sender_ident },
589 { "sender_rate", vtype_stringptr, &sender_rate },
590 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
591 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
592 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
593 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
594 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
595 { "sending_port", vtype_int, &sending_port },
596 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
597 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
598 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
599 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
600 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
601 { "sn0", vtype_filter_int, &filter_sn[0] },
602 { "sn1", vtype_filter_int, &filter_sn[1] },
603 { "sn2", vtype_filter_int, &filter_sn[2] },
604 { "sn3", vtype_filter_int, &filter_sn[3] },
605 { "sn4", vtype_filter_int, &filter_sn[4] },
606 { "sn5", vtype_filter_int, &filter_sn[5] },
607 { "sn6", vtype_filter_int, &filter_sn[6] },
608 { "sn7", vtype_filter_int, &filter_sn[7] },
609 { "sn8", vtype_filter_int, &filter_sn[8] },
610 { "sn9", vtype_filter_int, &filter_sn[9] },
611 #ifdef WITH_CONTENT_SCAN
612 { "spam_bar", vtype_stringptr, &spam_bar },
613 { "spam_report", vtype_stringptr, &spam_report },
614 { "spam_score", vtype_stringptr, &spam_score },
615 { "spam_score_int", vtype_stringptr, &spam_score_int },
617 #ifdef EXPERIMENTAL_SPF
618 { "spf_guess", vtype_stringptr, &spf_guess },
619 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
620 { "spf_received", vtype_stringptr, &spf_received },
621 { "spf_result", vtype_stringptr, &spf_result },
622 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
624 { "spool_directory", vtype_stringptr, &spool_directory },
625 { "spool_inodes", vtype_pinodes, (void *)TRUE },
626 { "spool_space", vtype_pspace, (void *)TRUE },
627 #ifdef EXPERIMENTAL_SRS
628 { "srs_db_address", vtype_stringptr, &srs_db_address },
629 { "srs_db_key", vtype_stringptr, &srs_db_key },
630 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
631 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
632 { "srs_recipient", vtype_stringptr, &srs_recipient },
633 { "srs_status", vtype_stringptr, &srs_status },
635 { "thisaddress", vtype_stringptr, &filter_thisaddress },
637 /* The non-(in,out) variables are now deprecated */
638 { "tls_bits", vtype_int, &tls_in.bits },
639 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
640 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
642 { "tls_in_bits", vtype_int, &tls_in.bits },
643 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
644 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
645 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
646 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
647 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
649 { "tls_out_bits", vtype_int, &tls_out.bits },
650 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
651 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
652 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
653 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
654 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
657 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
658 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
659 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
662 { "tod_bsdinbox", vtype_todbsdin, NULL },
663 { "tod_epoch", vtype_tode, NULL },
664 { "tod_epoch_l", vtype_todel, NULL },
665 { "tod_full", vtype_todf, NULL },
666 { "tod_log", vtype_todl, NULL },
667 { "tod_logfile", vtype_todlf, NULL },
668 { "tod_zone", vtype_todzone, NULL },
669 { "tod_zulu", vtype_todzulu, NULL },
670 { "value", vtype_stringptr, &lookup_value },
671 { "version_number", vtype_stringptr, &version_string },
672 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
673 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
674 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
675 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
676 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
677 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
680 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
681 static uschar var_buffer[256];
682 static BOOL malformed_header;
684 /* For textual hashes */
686 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
687 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
690 enum { HMAC_MD5, HMAC_SHA1 };
692 /* For numeric hashes */
694 static unsigned int prime[] = {
695 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
696 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
697 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
699 /* For printing modes in symbolic form */
701 static uschar *mtable_normal[] =
702 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
704 static uschar *mtable_setid[] =
705 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
707 static uschar *mtable_sticky[] =
708 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
712 /*************************************************
713 * Tables for UTF-8 support *
714 *************************************************/
716 /* Table of the number of extra characters, indexed by the first character
717 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
720 static uschar utf8_table1[] = {
721 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
722 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
723 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
724 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
726 /* These are the masks for the data bits in the first byte of a character,
727 indexed by the number of additional bytes. */
729 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
731 /* Get the next UTF-8 character, advancing the pointer. */
733 #define GETUTF8INC(c, ptr) \
735 if ((c & 0xc0) == 0xc0) \
737 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
739 c = (c & utf8_table2[a]) << s; \
743 c |= (*ptr++ & 0x3f) << s; \
748 /*************************************************
749 * Binary chop search on a table *
750 *************************************************/
752 /* This is used for matching expansion items and operators.
755 name the name that is being sought
756 table the table to search
757 table_size the number of items in the table
759 Returns: the offset in the table, or -1
763 chop_match(uschar *name, uschar **table, int table_size)
765 uschar **bot = table;
766 uschar **top = table + table_size;
770 uschar **mid = bot + (top - bot)/2;
771 int c = Ustrcmp(name, *mid);
772 if (c == 0) return mid - table;
773 if (c > 0) bot = mid + 1; else top = mid;
781 /*************************************************
782 * Check a condition string *
783 *************************************************/
785 /* This function is called to expand a string, and test the result for a "true"
786 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
787 forced fail or lookup defer. All store used by the function can be released on
790 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
793 condition the condition string
794 m1 text to be incorporated in panic error
797 Returns: TRUE if condition is met, FALSE if not
801 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
804 void *reset_point = store_get(0);
805 uschar *ss = expand_string(condition);
808 if (!expand_string_forcedfail && !search_find_defer)
809 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
810 "for %s %s: %s", condition, m1, m2, expand_string_message);
813 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
814 strcmpic(ss, US"false") != 0;
815 store_reset(reset_point);
822 /*************************************************
823 * Pseudo-random number generation *
824 *************************************************/
826 /* Pseudo-random number generation. The result is not "expected" to be
827 cryptographically strong but not so weak that someone will shoot themselves
828 in the foot using it as a nonce in some email header scheme or whatever
829 weirdness they'll twist this into. The result should ideally handle fork().
831 However, if we're stuck unable to provide this, then we'll fall back to
832 appallingly bad randomness.
834 If SUPPORT_TLS is defined then this will not be used except as an emergency
839 Returns a random number in range [0, max-1]
843 # define vaguely_random_number vaguely_random_number_fallback
846 vaguely_random_number(int max)
849 # undef vaguely_random_number
851 static pid_t pid = 0;
853 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
863 #ifdef HAVE_ARC4RANDOM
864 /* cryptographically strong randomness, common on *BSD platforms, not
865 so much elsewhere. Alas. */
867 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
868 #ifdef HAVE_SRANDOMDEV
869 /* uses random(4) for seeding */
872 gettimeofday(&tv, NULL);
873 srandom(tv.tv_sec | tv.tv_usec | getpid());
876 /* Poor randomness and no seeding here */
883 #ifdef HAVE_ARC4RANDOM
884 return arc4random() % max;
885 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
886 return random() % max;
888 /* This one returns a 16-bit number, definitely not crypto-strong */
889 return random_number(max);
896 /*************************************************
897 * Pick out a name from a string *
898 *************************************************/
900 /* If the name is too long, it is silently truncated.
903 name points to a buffer into which to put the name
904 max is the length of the buffer
905 s points to the first alphabetic character of the name
906 extras chars other than alphanumerics to permit
908 Returns: pointer to the first character after the name
910 Note: The test for *s != 0 in the while loop is necessary because
911 Ustrchr() yields non-NULL if the character is zero (which is not something
915 read_name(uschar *name, int max, uschar *s, uschar *extras)
918 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
920 if (ptr < max-1) name[ptr++] = *s;
929 /*************************************************
930 * Pick out the rest of a header name *
931 *************************************************/
933 /* A variable name starting $header_ (or just $h_ for those who like
934 abbreviations) might not be the complete header name because headers can
935 contain any printing characters in their names, except ':'. This function is
936 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
937 on the end, if the name was terminated by white space.
940 name points to a buffer in which the name read so far exists
941 max is the length of the buffer
942 s points to the first character after the name so far, i.e. the
943 first non-alphameric character after $header_xxxxx
945 Returns: a pointer to the first character after the header name
949 read_header_name(uschar *name, int max, uschar *s)
951 int prelen = Ustrchr(name, '_') - name + 1;
952 int ptr = Ustrlen(name) - prelen;
953 if (ptr > 0) memmove(name, name+prelen, ptr);
954 while (mac_isgraph(*s) && *s != ':')
956 if (ptr < max-1) name[ptr++] = *s;
967 /*************************************************
968 * Pick out a number from a string *
969 *************************************************/
972 n points to an integer into which to put the number
973 s points to the first digit of the number
975 Returns: a pointer to the character after the last digit
979 read_number(int *n, uschar *s)
982 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
988 /*************************************************
989 * Extract keyed subfield from a string *
990 *************************************************/
992 /* The yield is in dynamic store; NULL means that the key was not found.
995 key points to the name of the key
996 s points to the string from which to extract the subfield
998 Returns: NULL if the subfield was not found, or
999 a pointer to the subfield's data
1003 expand_getkeyed(uschar *key, uschar *s)
1005 int length = Ustrlen(key);
1006 while (isspace(*s)) s++;
1008 /* Loop to search for the key */
1016 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1017 dkeylength = s - dkey;
1018 while (isspace(*s)) s++;
1019 if (*s == '=') while (isspace((*(++s))));
1021 data = string_dequote(&s);
1022 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1025 while (isspace(*s)) s++;
1034 /*************************************************
1035 * Extract numbered subfield from string *
1036 *************************************************/
1038 /* Extracts a numbered field from a string that is divided by tokens - for
1039 example a line from /etc/passwd is divided by colon characters. First field is
1040 numbered one. Negative arguments count from the right. Zero returns the whole
1041 string. Returns NULL if there are insufficient tokens in the string
1044 Modifies final argument - this is a dynamically generated string, so that's OK.
1047 field number of field to be extracted,
1048 first field = 1, whole string = 0, last field = -1
1049 separators characters that are used to break string into tokens
1050 s points to the string from which to extract the subfield
1052 Returns: NULL if the field was not found,
1053 a pointer to the field's data inside s (modified to add 0)
1057 expand_gettokened (int field, uschar *separators, uschar *s)
1062 uschar *fieldtext = NULL;
1064 if (field == 0) return s;
1066 /* Break the line up into fields in place; for field > 0 we stop when we have
1067 done the number of fields we want. For field < 0 we continue till the end of
1068 the string, counting the number of fields. */
1070 count = (field > 0)? field : INT_MAX;
1076 /* Previous field was the last one in the string. For a positive field
1077 number, this means there are not enough fields. For a negative field number,
1078 check that there are enough, and scan back to find the one that is wanted. */
1082 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1083 if ((-field) == (INT_MAX - count - 1)) return s;
1087 while (ss[-1] != 0) ss--;
1093 /* Previous field was not last in the string; save its start and put a
1097 len = Ustrcspn(ss, separators);
1108 /*************************************************
1109 * Extract a substring from a string *
1110 *************************************************/
1112 /* Perform the ${substr or ${length expansion operations.
1115 subject the input string
1116 value1 the offset from the start of the input string to the start of
1117 the output string; if negative, count from the right.
1118 value2 the length of the output string, or negative (-1) for unset
1119 if value1 is positive, unset means "all after"
1120 if value1 is negative, unset means "all before"
1121 len set to the length of the returned string
1123 Returns: pointer to the output string, or NULL if there is an error
1127 extract_substr(uschar *subject, int value1, int value2, int *len)
1129 int sublen = Ustrlen(subject);
1131 if (value1 < 0) /* count from right */
1135 /* If the position is before the start, skip to the start, and adjust the
1136 length. If the length ends up negative, the substring is null because nothing
1137 can precede. This falls out naturally when the length is unset, meaning "all
1143 if (value2 < 0) value2 = 0;
1147 /* Otherwise an unset length => characters before value1 */
1149 else if (value2 < 0)
1156 /* For a non-negative offset, if the starting position is past the end of the
1157 string, the result will be the null string. Otherwise, an unset length means
1158 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1162 if (value1 > sublen)
1167 else if (value2 < 0) value2 = sublen;
1170 /* Cut the length down to the maximum possible for the offset value, and get
1171 the required characters. */
1173 if (value1 + value2 > sublen) value2 = sublen - value1;
1175 return subject + value1;
1181 /*************************************************
1182 * Old-style hash of a string *
1183 *************************************************/
1185 /* Perform the ${hash expansion operation.
1188 subject the input string (an expanded substring)
1189 value1 the length of the output string; if greater or equal to the
1190 length of the input string, the input string is returned
1191 value2 the number of hash characters to use, or 26 if negative
1192 len set to the length of the returned string
1194 Returns: pointer to the output string, or NULL if there is an error
1198 compute_hash(uschar *subject, int value1, int value2, int *len)
1200 int sublen = Ustrlen(subject);
1202 if (value2 < 0) value2 = 26;
1203 else if (value2 > Ustrlen(hashcodes))
1205 expand_string_message =
1206 string_sprintf("hash count \"%d\" too big", value2);
1210 /* Calculate the hash text. We know it is shorter than the original string, so
1211 can safely place it in subject[] (we know that subject is always itself an
1212 expanded substring). */
1214 if (value1 < sublen)
1219 while ((c = (subject[j])) != 0)
1221 int shift = (c + j++) & 7;
1222 subject[i] ^= (c << shift) | (c >> (8-shift));
1223 if (++i >= value1) i = 0;
1225 for (i = 0; i < value1; i++)
1226 subject[i] = hashcodes[(subject[i]) % value2];
1228 else value1 = sublen;
1237 /*************************************************
1238 * Numeric hash of a string *
1239 *************************************************/
1241 /* Perform the ${nhash expansion operation. The first characters of the
1242 string are treated as most important, and get the highest prime numbers.
1245 subject the input string
1246 value1 the maximum value of the first part of the result
1247 value2 the maximum value of the second part of the result,
1248 or negative to produce only a one-part result
1249 len set to the length of the returned string
1251 Returns: pointer to the output string, or NULL if there is an error.
1255 compute_nhash (uschar *subject, int value1, int value2, int *len)
1257 uschar *s = subject;
1259 unsigned long int total = 0; /* no overflow */
1263 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1264 total += prime[i--] * (unsigned int)(*s++);
1267 /* If value2 is unset, just compute one number */
1271 s = string_sprintf("%d", total % value1);
1274 /* Otherwise do a div/mod hash */
1278 total = total % (value1 * value2);
1279 s = string_sprintf("%d/%d", total/value2, total % value2);
1290 /*************************************************
1291 * Find the value of a header or headers *
1292 *************************************************/
1294 /* Multiple instances of the same header get concatenated, and this function
1295 can also return a concatenation of all the header lines. When concatenating
1296 specific headers that contain lists of addresses, a comma is inserted between
1297 them. Otherwise we use a straight concatenation. Because some messages can have
1298 pathologically large number of lines, there is a limit on the length that is
1299 returned. Also, to avoid massive store use which would result from using
1300 string_cat() as it copies and extends strings, we do a preliminary pass to find
1301 out exactly how much store will be needed. On "normal" messages this will be
1305 name the name of the header, without the leading $header_ or $h_,
1306 or NULL if a concatenation of all headers is required
1307 exists_only TRUE if called from a def: test; don't need to build a string;
1308 just return a string that is not "" and not "0" if the header
1310 newsize return the size of memory block that was obtained; may be NULL
1311 if exists_only is TRUE
1312 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1313 other than concatenating, will be done on the header. Also used
1314 for $message_headers_raw.
1315 charset name of charset to translate MIME words to; used only if
1316 want_raw is false; if NULL, no translation is done (this is
1317 used for $bh_ and $bheader_)
1319 Returns: NULL if the header does not exist, else a pointer to a new
1324 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1327 BOOL found = name == NULL;
1329 int len = found? 0 : Ustrlen(name);
1331 uschar *yield = NULL;
1334 /* Loop for two passes - saves code repetition */
1336 for (i = 0; i < 2; i++)
1341 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1343 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1345 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1350 if (exists_only) return US"1"; /* don't need actual string */
1352 t = h->text + len; /* text to insert */
1353 if (!want_raw) /* unless wanted raw, */
1354 while (isspace(*t)) t++; /* remove leading white space */
1355 ilen = h->slen - (t - h->text); /* length to insert */
1357 /* Unless wanted raw, remove trailing whitespace, including the
1361 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1363 /* Set comma = 1 if handling a single header and it's one of those
1364 that contains an address list, except when asked for raw headers. Only
1365 need to do this once. */
1367 if (!want_raw && name != NULL && comma == 0 &&
1368 Ustrchr("BCFRST", h->type) != NULL)
1371 /* First pass - compute total store needed; second pass - compute
1372 total store used, including this header. */
1374 size += ilen + comma + 1; /* +1 for the newline */
1376 /* Second pass - concatentate the data, up to a maximum. Note that
1377 the loop stops when size hits the limit. */
1381 if (size > header_insert_maxlen)
1383 ilen -= size - header_insert_maxlen - 1;
1386 Ustrncpy(ptr, t, ilen);
1389 /* For a non-raw header, put in the comma if needed, then add
1390 back the newline we removed above, provided there was some text in
1393 if (!want_raw && ilen > 0)
1395 if (comma != 0) *ptr++ = ',';
1403 /* At end of first pass, return NULL if no header found. Then truncate size
1404 if necessary, and get the buffer to hold the data, returning the buffer size.
1409 if (!found) return NULL;
1410 if (size > header_insert_maxlen) size = header_insert_maxlen;
1411 *newsize = size + 1;
1412 ptr = yield = store_get(*newsize);
1416 /* That's all we do for raw header expansion. */
1423 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1424 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1425 function can return an error with decoded data if the charset translation
1426 fails. If decoding fails, it returns NULL. */
1430 uschar *decoded, *error;
1431 if (ptr > yield && ptr[-1] == '\n') ptr--;
1432 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1434 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1438 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1439 " input was: %s\n", error, yield);
1441 if (decoded != NULL) yield = decoded;
1450 /*************************************************
1451 * Return list of recipients *
1452 *************************************************/
1453 /* A recipients list is available only during system message filtering,
1454 during ACL processing after DATA, and while expanding pipe commands
1455 generated from a system filter, but not elsewhere. */
1460 if (!enable_dollar_recipients) return NULL; else
1465 uschar * s = store_get(size);
1466 for (i = 0; i < recipients_count; i++)
1468 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1469 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1470 Ustrlen(recipients_list[i].address));
1472 s[ptr] = 0; /* string_cat() leaves room */
1478 /*************************************************
1479 * Find value of a variable *
1480 *************************************************/
1482 /* The table of variables is kept in alphabetic order, so we can search it
1483 using a binary chop. The "choplen" variable is nothing to do with the binary
1487 name the name of the variable being sought
1488 exists_only TRUE if this is a def: test; passed on to find_header()
1489 skipping TRUE => skip any processing evaluation; this is not the same as
1490 exists_only because def: may test for values that are first
1492 newsize pointer to an int which is initially zero; if the answer is in
1493 a new memory buffer, *newsize is set to its size
1495 Returns: NULL if the variable does not exist, or
1496 a pointer to the variable's contents, or
1497 something non-NULL if exists_only is TRUE
1501 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1504 int last = var_table_size;
1506 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1507 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1508 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1509 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1510 (this gave backwards compatibility at the changeover). There may be built-in
1511 variables whose names start acl_ but they should never start in this way. This
1512 slightly messy specification is a consequence of the history, needless to say.
1514 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1515 set, in which case give an error. */
1517 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1521 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1522 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1525 /* Handle $auth<n> variables. */
1527 if (Ustrncmp(name, "auth", 4) == 0)
1530 int n = Ustrtoul(name + 4, &endptr, 10);
1531 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1532 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1535 /* For all other variables, search the table */
1537 while (last > first)
1541 int middle = (first + last)/2;
1542 int c = Ustrcmp(name, var_table[middle].name);
1544 if (c > 0) { first = middle + 1; continue; }
1545 if (c < 0) { last = middle; continue; }
1547 /* Found an existing variable. If in skipping state, the value isn't needed,
1548 and we want to avoid processing (such as looking up the host name). */
1550 if (skipping) return US"";
1552 switch (var_table[middle].type)
1554 case vtype_filter_int:
1555 if (!filter_running) return NULL;
1559 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1563 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1567 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1571 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1575 sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1578 case vtype_stringptr: /* Pointer to string */
1579 s = *((uschar **)(var_table[middle].value));
1580 return (s == NULL)? US"" : s;
1583 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1586 case vtype_load_avg:
1587 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1590 case vtype_host_lookup: /* Lookup if not done so */
1591 if (sender_host_name == NULL && sender_host_address != NULL &&
1592 !host_lookup_failed && host_name_lookup() == OK)
1593 host_build_sender_fullhost();
1594 return (sender_host_name == NULL)? US"" : sender_host_name;
1596 case vtype_localpart: /* Get local part from address */
1597 s = *((uschar **)(var_table[middle].value));
1598 if (s == NULL) return US"";
1599 domain = Ustrrchr(s, '@');
1600 if (domain == NULL) return s;
1601 if (domain - s > sizeof(var_buffer) - 1)
1602 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1603 " in string expansion", sizeof(var_buffer));
1604 Ustrncpy(var_buffer, s, domain - s);
1605 var_buffer[domain - s] = 0;
1608 case vtype_domain: /* Get domain from address */
1609 s = *((uschar **)(var_table[middle].value));
1610 if (s == NULL) return US"";
1611 domain = Ustrrchr(s, '@');
1612 return (domain == NULL)? US"" : domain + 1;
1614 case vtype_msgheaders:
1615 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1617 case vtype_msgheaders_raw:
1618 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1620 case vtype_msgbody: /* Pointer to msgbody string */
1621 case vtype_msgbody_end: /* Ditto, the end of the msg */
1622 ss = (uschar **)(var_table[middle].value);
1623 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1626 off_t start_offset = SPOOL_DATA_START_OFFSET;
1627 int len = message_body_visible;
1628 if (len > message_size) len = message_size;
1629 *ss = body = store_malloc(len+1);
1631 if (var_table[middle].type == vtype_msgbody_end)
1633 struct stat statbuf;
1634 if (fstat(deliver_datafile, &statbuf) == 0)
1636 start_offset = statbuf.st_size - len;
1637 if (start_offset < SPOOL_DATA_START_OFFSET)
1638 start_offset = SPOOL_DATA_START_OFFSET;
1641 lseek(deliver_datafile, start_offset, SEEK_SET);
1642 len = read(deliver_datafile, body, len);
1646 if (message_body_newlines) /* Separate loops for efficiency */
1649 { if (body[--len] == 0) body[len] = ' '; }
1654 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1658 return (*ss == NULL)? US"" : *ss;
1660 case vtype_todbsdin: /* BSD inbox time of day */
1661 return tod_stamp(tod_bsdin);
1663 case vtype_tode: /* Unix epoch time of day */
1664 return tod_stamp(tod_epoch);
1666 case vtype_todel: /* Unix epoch/usec time of day */
1667 return tod_stamp(tod_epoch_l);
1669 case vtype_todf: /* Full time of day */
1670 return tod_stamp(tod_full);
1672 case vtype_todl: /* Log format time of day */
1673 return tod_stamp(tod_log_bare); /* (without timezone) */
1675 case vtype_todzone: /* Time zone offset only */
1676 return tod_stamp(tod_zone);
1678 case vtype_todzulu: /* Zulu time */
1679 return tod_stamp(tod_zulu);
1681 case vtype_todlf: /* Log file datestamp tod */
1682 return tod_stamp(tod_log_datestamp_daily);
1684 case vtype_reply: /* Get reply address */
1685 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1687 if (s != NULL) while (isspace(*s)) s++;
1688 if (s == NULL || *s == 0)
1690 *newsize = 0; /* For the *s==0 case */
1691 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1696 while (isspace(*s)) s++;
1697 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1698 while (t > s && isspace(t[-1])) t--;
1701 return (s == NULL)? US"" : s;
1703 case vtype_string_func:
1705 uschar * (*fn)() = var_table[middle].value;
1712 sprintf(CS var_buffer, "%d",
1713 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1720 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1721 sprintf(CS var_buffer, "%d", inodes);
1725 #ifndef DISABLE_DKIM
1727 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1733 return NULL; /* Unknown variable name */
1740 modify_variable(uschar *name, void * value)
1743 int last = var_table_size;
1745 while (last > first)
1747 int middle = (first + last)/2;
1748 int c = Ustrcmp(name, var_table[middle].name);
1750 if (c > 0) { first = middle + 1; continue; }
1751 if (c < 0) { last = middle; continue; }
1753 /* Found an existing variable; change the item it refers to */
1754 var_table[middle].value = value;
1757 return; /* Unknown variable name, fail silently */
1764 /*************************************************
1765 * Read and expand substrings *
1766 *************************************************/
1768 /* This function is called to read and expand argument substrings for various
1769 expansion items. Some have a minimum requirement that is less than the maximum;
1770 in these cases, the first non-present one is set to NULL.
1773 sub points to vector of pointers to set
1774 n maximum number of substrings
1776 sptr points to current string pointer
1777 skipping the skipping flag
1778 check_end if TRUE, check for final '}'
1779 name name of item, for error message
1781 Returns: 0 OK; string pointer updated
1782 1 curly bracketing error (too few arguments)
1783 2 too many arguments (only if check_end is set); message set
1784 3 other error (expansion failure)
1788 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1789 BOOL check_end, uschar *name)
1794 while (isspace(*s)) s++;
1795 for (i = 0; i < n; i++)
1799 if (i < m) return 1;
1803 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1804 if (sub[i] == NULL) return 3;
1805 if (*s++ != '}') return 1;
1806 while (isspace(*s)) s++;
1808 if (check_end && *s++ != '}')
1812 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1813 "(max is %d)", name, n);
1826 /*************************************************
1827 * Elaborate message for bad variable *
1828 *************************************************/
1830 /* For the "unknown variable" message, take a look at the variable's name, and
1831 give additional information about possible ACL variables. The extra information
1832 is added on to expand_string_message.
1834 Argument: the name of the variable
1839 check_variable_error_message(uschar *name)
1841 if (Ustrncmp(name, "acl_", 4) == 0)
1842 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1843 (name[4] == 'c' || name[4] == 'm')?
1845 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1846 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1848 US"user-defined ACL variables must start acl_c or acl_m");
1854 Load args from sub array to globals, and call acl_check().
1856 Returns: OK access is granted by an ACCEPT verb
1857 DISCARD access is granted by a DISCARD verb
1858 FAIL access is denied
1859 FAIL_DROP access is denied; drop the connection
1860 DEFER can't tell at the moment
1864 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
1867 uschar *dummy_log_msg;
1869 for (i = 1; i < nsub && sub[i]; i++)
1870 acl_arg[i-1] = sub[i];
1873 acl_arg[i++ - 1] = NULL;
1876 debug_printf("expanding: acl: %s arg: %s%s\n",
1878 acl_narg>0 ? sub[1] : US"<none>",
1879 acl_narg>1 ? " +more" : "");
1881 return acl_check(ACL_WHERE_EXPANSION, NULL, sub[0], user_msgp, &dummy_log_msg);
1887 /*************************************************
1888 * Read and evaluate a condition *
1889 *************************************************/
1893 s points to the start of the condition text
1894 yield points to a BOOL to hold the result of the condition test;
1895 if NULL, we are just reading through a condition that is
1896 part of an "or" combination to check syntax, or in a state
1897 where the answer isn't required
1899 Returns: a pointer to the first character after the condition, or
1904 eval_condition(uschar *s, BOOL *yield)
1906 BOOL testfor = TRUE;
1907 BOOL tempcond, combined_cond;
1909 BOOL sub2_honour_dollar = TRUE;
1910 int i, rc, cond_type, roffset;
1911 int_eximarith_t num[2];
1912 struct stat statbuf;
1917 const uschar *rerror;
1921 while (isspace(*s)) s++;
1922 if (*s == '!') { testfor = !testfor; s++; } else break;
1925 /* Numeric comparisons are symbolic */
1927 if (*s == '=' || *s == '>' || *s == '<')
1939 /* All other conditions are named */
1941 else s = read_name(name, 256, s, US"_");
1943 /* If we haven't read a name, it means some non-alpha character is first. */
1947 expand_string_message = string_sprintf("condition name expected, "
1948 "but found \"%.16s\"", s);
1952 /* Find which condition we are dealing with, and switch on it */
1954 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1957 /* def: tests for a non-empty variable, or for the existence of a header. If
1958 yield == NULL we are in a skipping state, and don't care about the answer. */
1963 expand_string_message = US"\":\" expected after \"def\"";
1967 s = read_name(name, 256, s+1, US"_");
1969 /* Test for a header's existence. If the name contains a closing brace
1970 character, this may be a user error where the terminating colon has been
1971 omitted. Set a flag to adjust a subsequent error message in this case. */
1973 if (Ustrncmp(name, "h_", 2) == 0 ||
1974 Ustrncmp(name, "rh_", 3) == 0 ||
1975 Ustrncmp(name, "bh_", 3) == 0 ||
1976 Ustrncmp(name, "header_", 7) == 0 ||
1977 Ustrncmp(name, "rheader_", 8) == 0 ||
1978 Ustrncmp(name, "bheader_", 8) == 0)
1980 s = read_header_name(name, 256, s);
1981 /* {-for-text-editors */
1982 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1983 if (yield != NULL) *yield =
1984 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1987 /* Test for a variable's having a non-empty value. A non-existent variable
1988 causes an expansion failure. */
1992 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1995 expand_string_message = (name[0] == 0)?
1996 string_sprintf("variable name omitted after \"def:\"") :
1997 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1998 check_variable_error_message(name);
2001 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2007 /* first_delivery tests for first delivery attempt */
2009 case ECOND_FIRST_DELIVERY:
2010 if (yield != NULL) *yield = deliver_firsttime == testfor;
2014 /* queue_running tests for any process started by a queue runner */
2016 case ECOND_QUEUE_RUNNING:
2017 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2021 /* exists: tests for file existence
2022 isip: tests for any IP address
2023 isip4: tests for an IPv4 address
2024 isip6: tests for an IPv6 address
2025 pam: does PAM authentication
2026 radius: does RADIUS authentication
2027 ldapauth: does LDAP authentication
2028 pwcheck: does Cyrus SASL pwcheck authentication
2037 case ECOND_LDAPAUTH:
2040 while (isspace(*s)) s++;
2041 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2043 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
2044 if (sub[0] == NULL) return NULL;
2045 /* {-for-text-editors */
2046 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2048 if (yield == NULL) return s; /* No need to run the test if skipping */
2053 if ((expand_forbid & RDO_EXISTS) != 0)
2055 expand_string_message = US"File existence tests are not permitted";
2058 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2064 rc = string_is_ip_address(sub[0], NULL);
2065 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2066 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2069 /* Various authentication tests - all optionally compiled */
2073 rc = auth_call_pam(sub[0], &expand_string_message);
2076 goto COND_FAILED_NOT_COMPILED;
2077 #endif /* SUPPORT_PAM */
2080 #ifdef RADIUS_CONFIG_FILE
2081 rc = auth_call_radius(sub[0], &expand_string_message);
2084 goto COND_FAILED_NOT_COMPILED;
2085 #endif /* RADIUS_CONFIG_FILE */
2087 case ECOND_LDAPAUTH:
2090 /* Just to keep the interface the same */
2092 int old_pool = store_pool;
2093 store_pool = POOL_SEARCH;
2094 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2095 &expand_string_message, &do_cache);
2096 store_pool = old_pool;
2100 goto COND_FAILED_NOT_COMPILED;
2101 #endif /* LOOKUP_LDAP */
2104 #ifdef CYRUS_PWCHECK_SOCKET
2105 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2108 goto COND_FAILED_NOT_COMPILED;
2109 #endif /* CYRUS_PWCHECK_SOCKET */
2111 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2112 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2114 if (rc == ERROR || rc == DEFER) return NULL;
2115 *yield = (rc == OK) == testfor;
2121 /* call ACL (in a conditional context). Accept true, deny false.
2122 Defer is a forced-fail. Anything set by message= goes to $value.
2123 Up to ten parameters are used; we use the braces round the name+args
2124 like the saslauthd condition does, to permit a variable number of args.
2125 See also the expansion-item version EITEM_ACL and the traditional
2126 acl modifier ACLC_ACL.
2130 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2138 while (isspace(*s)) s++;
2139 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2141 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2142 &s, yield == NULL, TRUE, US"acl"))
2144 case 1: expand_string_message = US"too few arguments or bracketing "
2147 case 3: return NULL;
2150 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2155 lookup_value = NULL;
2158 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2159 lookup_value[ptr] = '\0';
2161 *yield = cond == testfor;
2165 expand_string_forcedfail = TRUE;
2167 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2174 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2176 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
2178 However, the last two are optional. That is why the whole set is enclosed
2179 in their own set of braces. */
2181 case ECOND_SASLAUTHD:
2182 #ifndef CYRUS_SASLAUTHD_SOCKET
2183 goto COND_FAILED_NOT_COMPILED;
2185 while (isspace(*s)) s++;
2186 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2187 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2189 case 1: expand_string_message = US"too few arguments or bracketing "
2190 "error for saslauthd";
2192 case 3: return NULL;
2194 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2198 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2199 &expand_string_message);
2200 if (rc == ERROR || rc == DEFER) return NULL;
2201 *yield = (rc == OK) == testfor;
2204 #endif /* CYRUS_SASLAUTHD_SOCKET */
2207 /* symbolic operators for numeric and string comparison, and a number of
2208 other operators, all requiring two arguments.
2210 crypteq: encrypts plaintext and compares against an encrypted text,
2211 using crypt(), crypt16(), MD5 or SHA-1
2212 inlist/inlisti: checks if first argument is in the list of the second
2213 match: does a regular expression match and sets up the numerical
2214 variables if it succeeds
2215 match_address: matches in an address list
2216 match_domain: matches in a domain list
2217 match_ip: matches a host list that is restricted to IP addresses
2218 match_local_part: matches in a local part list
2221 case ECOND_MATCH_ADDRESS:
2222 case ECOND_MATCH_DOMAIN:
2223 case ECOND_MATCH_IP:
2224 case ECOND_MATCH_LOCAL_PART:
2225 #ifndef EXPAND_LISTMATCH_RHS
2226 sub2_honour_dollar = FALSE;
2235 case ECOND_NUM_L: /* Numerical comparisons */
2242 case ECOND_STR_LT: /* String comparisons */
2253 for (i = 0; i < 2; i++)
2255 /* Sometimes, we don't expand substrings; too many insecure configurations
2256 created using match_address{}{} and friends, where the second param
2257 includes information from untrustworthy sources. */
2258 BOOL honour_dollar = TRUE;
2259 if ((i > 0) && !sub2_honour_dollar)
2260 honour_dollar = FALSE;
2262 while (isspace(*s)) s++;
2265 if (i == 0) goto COND_FAILED_CURLY_START;
2266 expand_string_message = string_sprintf("missing 2nd string in {} "
2267 "after \"%s\"", name);
2270 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2272 if (sub[i] == NULL) return NULL;
2273 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2275 /* Convert to numerical if required; we know that the names of all the
2276 conditions that compare numbers do not start with a letter. This just saves
2277 checking for them individually. */
2279 if (!isalpha(name[0]) && yield != NULL)
2285 debug_printf("empty string cast to zero for numerical comparison\n");
2289 num[i] = expand_string_integer(sub[i], FALSE);
2290 if (expand_string_message != NULL) return NULL;
2295 /* Result not required */
2297 if (yield == NULL) return s;
2299 /* Do an appropriate comparison */
2305 tempcond = (num[0] == num[1]);
2309 tempcond = (num[0] > num[1]);
2313 tempcond = (num[0] >= num[1]);
2317 tempcond = (num[0] < num[1]);
2321 tempcond = (num[0] <= num[1]);
2325 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2329 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2333 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2337 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2341 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2345 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2349 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2353 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2357 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2361 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2364 case ECOND_MATCH: /* Regular expression match */
2365 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2369 expand_string_message = string_sprintf("regular expression error in "
2370 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2373 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2376 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2377 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2378 goto MATCHED_SOMETHING;
2380 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2381 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2382 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2383 goto MATCHED_SOMETHING;
2385 case ECOND_MATCH_IP: /* Match IP address in a host list */
2386 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2388 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2394 unsigned int *nullcache = NULL;
2395 check_host_block cb;
2397 cb.host_name = US"";
2398 cb.host_address = sub[0];
2400 /* If the host address starts off ::ffff: it is an IPv6 address in
2401 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2404 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2405 cb.host_address + 7 : cb.host_address;
2407 rc = match_check_list(
2408 &sub[1], /* the list */
2409 0, /* separator character */
2410 &hostlist_anchor, /* anchor pointer */
2411 &nullcache, /* cache pointer */
2412 check_host, /* function for testing */
2413 &cb, /* argument for function */
2414 MCL_HOST, /* type of check */
2415 sub[0], /* text for debugging */
2416 NULL); /* where to pass back data */
2418 goto MATCHED_SOMETHING;
2420 case ECOND_MATCH_LOCAL_PART:
2421 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2422 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2437 expand_string_message = string_sprintf("unable to complete match "
2438 "against \"%s\": %s", sub[1], search_error_message);
2444 /* Various "encrypted" comparisons. If the second string starts with
2445 "{" then an encryption type is given. Default to crypt() or crypt16()
2446 (build-time choice). */
2447 /* }-for-text-editors */
2450 #ifndef SUPPORT_CRYPTEQ
2451 goto COND_FAILED_NOT_COMPILED;
2453 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2455 int sublen = Ustrlen(sub[1]+5);
2460 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2462 /* If the length that we are comparing against is 24, the MD5 digest
2463 is expressed as a base64 string. This is the way LDAP does it. However,
2464 some other software uses a straightforward hex representation. We assume
2465 this if the length is 32. Other lengths fail. */
2469 uschar *coded = auth_b64encode((uschar *)digest, 16);
2470 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2471 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2472 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2474 else if (sublen == 32)
2478 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2480 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2481 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2482 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2486 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2487 "fail\n crypted=%s\n", sub[1]+5);
2492 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2494 int sublen = Ustrlen(sub[1]+6);
2499 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2501 /* If the length that we are comparing against is 28, assume the SHA1
2502 digest is expressed as a base64 string. If the length is 40, assume a
2503 straightforward hex representation. Other lengths fail. */
2507 uschar *coded = auth_b64encode((uschar *)digest, 20);
2508 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2509 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2510 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2512 else if (sublen == 40)
2516 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2518 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2519 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2520 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2524 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2525 "fail\n crypted=%s\n", sub[1]+6);
2530 else /* {crypt} or {crypt16} and non-{ at start */
2531 /* }-for-text-editors */
2536 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2541 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2546 else if (sub[1][0] == '{') /* }-for-text-editors */
2548 expand_string_message = string_sprintf("unknown encryption mechanism "
2549 "in \"%s\"", sub[1]);
2555 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2556 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2557 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2561 #define XSTR(s) STR(s)
2562 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2563 " subject=%s\n crypted=%s\n",
2564 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2569 /* If the encrypted string contains fewer than two characters (for the
2570 salt), force failure. Otherwise we get false positives: with an empty
2571 string the yield of crypt() is an empty string! */
2573 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2574 (Ustrcmp(coded, sub[1]) == 0);
2577 #endif /* SUPPORT_CRYPTEQ */
2583 uschar *save_iterate_item = iterate_item;
2584 int (*compare)(const uschar *, const uschar *);
2587 if (cond_type == ECOND_INLISTI)
2590 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2592 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2593 if (compare(sub[0], iterate_item) == 0)
2598 iterate_item = save_iterate_item;
2601 } /* Switch for comparison conditions */
2603 *yield = tempcond == testfor;
2604 return s; /* End of comparison conditions */
2607 /* and/or: computes logical and/or of several conditions */
2611 subcondptr = (yield == NULL)? NULL : &tempcond;
2612 combined_cond = (cond_type == ECOND_AND);
2614 while (isspace(*s)) s++;
2615 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2619 while (isspace(*s)) s++;
2620 /* {-for-text-editors */
2621 if (*s == '}') break;
2622 if (*s != '{') /* }-for-text-editors */
2624 expand_string_message = string_sprintf("each subcondition "
2625 "inside an \"%s{...}\" condition must be in its own {}", name);
2629 s = eval_condition(s+1, subcondptr);
2632 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2633 expand_string_message, name);
2636 while (isspace(*s)) s++;
2638 /* {-for-text-editors */
2641 /* {-for-text-editors */
2642 expand_string_message = string_sprintf("missing } at end of condition "
2643 "inside \"%s\" group", name);
2649 if (cond_type == ECOND_AND)
2651 combined_cond &= tempcond;
2652 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2653 } /* evaluate any more */
2656 combined_cond |= tempcond;
2657 if (combined_cond) subcondptr = NULL; /* once true, don't */
2658 } /* evaluate any more */
2662 if (yield != NULL) *yield = (combined_cond == testfor);
2666 /* forall/forany: iterates a condition with different values */
2672 uschar *save_iterate_item = iterate_item;
2674 while (isspace(*s)) s++;
2675 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2676 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2677 if (sub[0] == NULL) return NULL;
2678 /* {-for-text-editors */
2679 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2681 while (isspace(*s)) s++;
2682 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2686 /* Call eval_condition once, with result discarded (as if scanning a
2687 "false" part). This allows us to find the end of the condition, because if
2688 the list it empty, we won't actually evaluate the condition for real. */
2690 s = eval_condition(sub[1], NULL);
2693 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2694 expand_string_message, name);
2697 while (isspace(*s)) s++;
2699 /* {-for-text-editors */
2702 /* {-for-text-editors */
2703 expand_string_message = string_sprintf("missing } at end of condition "
2704 "inside \"%s\"", name);
2708 if (yield != NULL) *yield = !testfor;
2709 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2711 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2712 if (eval_condition(sub[1], &tempcond) == NULL)
2714 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2715 expand_string_message, name);
2716 iterate_item = save_iterate_item;
2719 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2720 tempcond? "true":"false");
2722 if (yield != NULL) *yield = (tempcond == testfor);
2723 if (tempcond == (cond_type == ECOND_FORANY)) break;
2726 iterate_item = save_iterate_item;
2731 /* The bool{} expansion condition maps a string to boolean.
2732 The values supported should match those supported by the ACL condition
2733 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2734 of true/false. Note that Router "condition" rules have a different
2735 interpretation, where general data can be used and only a few values
2737 Note that readconf.c boolean matching, for boolean configuration options,
2738 only matches true/yes/false/no.
2739 The bool_lax{} condition matches the Router logic, which is much more
2742 case ECOND_BOOL_LAX:
2748 BOOL boolvalue = FALSE;
2749 while (isspace(*s)) s++;
2750 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2751 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2752 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2754 case 1: expand_string_message = string_sprintf(
2755 "too few arguments or bracketing error for %s",
2759 case 3: return NULL;
2762 while (isspace(*t)) t++;
2766 /* trailing whitespace: seems like a good idea to ignore it too */
2768 while (isspace(*t2)) t2--;
2769 if (t2 != (t + len))
2776 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2777 /* logic for the lax case from expand_check_condition(), which also does
2778 expands, and the logic is both short and stable enough that there should
2779 be no maintenance burden from replicating it. */
2782 else if (Ustrspn(t, "0123456789") == len)
2784 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2785 /* expand_check_condition only does a literal string "0" check */
2786 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2789 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2791 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2793 else if (cond_type == ECOND_BOOL_LAX)
2797 expand_string_message = string_sprintf("unrecognised boolean "
2801 if (yield != NULL) *yield = (boolvalue == testfor);
2805 /* Unknown condition */
2808 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2810 } /* End switch on condition type */
2812 /* Missing braces at start and end of data */
2814 COND_FAILED_CURLY_START:
2815 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2818 COND_FAILED_CURLY_END:
2819 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2823 /* A condition requires code that is not compiled */
2825 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2826 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2827 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2828 COND_FAILED_NOT_COMPILED:
2829 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2838 /*************************************************
2839 * Save numerical variables *
2840 *************************************************/
2842 /* This function is called from items such as "if" that want to preserve and
2843 restore the numbered variables.
2846 save_expand_string points to an array of pointers to set
2847 save_expand_nlength points to an array of ints for the lengths
2849 Returns: the value of expand max to save
2853 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2856 for (i = 0; i <= expand_nmax; i++)
2858 save_expand_nstring[i] = expand_nstring[i];
2859 save_expand_nlength[i] = expand_nlength[i];
2866 /*************************************************
2867 * Restore numerical variables *
2868 *************************************************/
2870 /* This function restored saved values of numerical strings.
2873 save_expand_nmax the number of strings to restore
2874 save_expand_string points to an array of pointers
2875 save_expand_nlength points to an array of ints
2881 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2882 int *save_expand_nlength)
2885 expand_nmax = save_expand_nmax;
2886 for (i = 0; i <= expand_nmax; i++)
2888 expand_nstring[i] = save_expand_nstring[i];
2889 expand_nlength[i] = save_expand_nlength[i];
2897 /*************************************************
2898 * Handle yes/no substrings *
2899 *************************************************/
2901 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2902 alternative substrings that depend on whether or not the condition was true,
2903 or the lookup or extraction succeeded. The substrings always have to be
2904 expanded, to check their syntax, but "skipping" is set when the result is not
2905 needed - this avoids unnecessary nested lookups.
2908 skipping TRUE if we were skipping when this item was reached
2909 yes TRUE if the first string is to be used, else use the second
2910 save_lookup a value to put back into lookup_value before the 2nd expansion
2911 sptr points to the input string pointer
2912 yieldptr points to the output string pointer
2913 sizeptr points to the output string size
2914 ptrptr points to the output string pointer
2915 type "lookup" or "if" or "extract" or "run", for error message
2917 Returns: 0 OK; lookup_value has been reset to save_lookup
2919 2 expansion failed because of bracketing error
2923 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2924 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2927 uschar *s = *sptr; /* Local value */
2928 uschar *sub1, *sub2;
2930 /* If there are no following strings, we substitute the contents of $value for
2931 lookups and for extractions in the success case. For the ${if item, the string
2932 "true" is substituted. In the fail case, nothing is substituted for all three
2935 while (isspace(*s)) s++;
2940 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2944 if (yes && lookup_value != NULL)
2945 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2946 Ustrlen(lookup_value));
2947 lookup_value = save_lookup;
2953 /* The first following string must be braced. */
2955 if (*s++ != '{') goto FAILED_CURLY;
2957 /* Expand the first substring. Forced failures are noticed only if we actually
2958 want this string. Set skipping in the call in the fail case (this will always
2959 be the case if we were already skipping). */
2961 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
2962 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2963 expand_string_forcedfail = FALSE;
2964 if (*s++ != '}') goto FAILED_CURLY;
2966 /* If we want the first string, add it to the output */
2969 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2971 /* If this is called from a lookup or an extract, we want to restore $value to
2972 what it was at the start of the item, so that it has this value during the
2973 second string expansion. For the call from "if" or "run" to this function,
2974 save_lookup is set to lookup_value, so that this statement does nothing. */
2976 lookup_value = save_lookup;
2978 /* There now follows either another substring, or "fail", or nothing. This
2979 time, forced failures are noticed only if we want the second string. We must
2980 set skipping in the nested call if we don't want this string, or if we were
2981 already skipping. */
2983 while (isspace(*s)) s++;
2986 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
2987 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2988 expand_string_forcedfail = FALSE;
2989 if (*s++ != '}') goto FAILED_CURLY;
2991 /* If we want the second string, add it to the output */
2994 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2997 /* If there is no second string, but the word "fail" is present when the use of
2998 the second string is wanted, set a flag indicating it was a forced failure
2999 rather than a syntactic error. Swallow the terminating } in case this is nested
3000 inside another lookup or if or extract. */
3005 s = read_name(name, sizeof(name), s, US"_");
3006 if (Ustrcmp(name, "fail") == 0)
3008 if (!yes && !skipping)
3010 while (isspace(*s)) s++;
3011 if (*s++ != '}') goto FAILED_CURLY;
3012 expand_string_message =
3013 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3014 expand_string_forcedfail = TRUE;
3020 expand_string_message =
3021 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3026 /* All we have to do now is to check on the final closing brace. */
3028 while (isspace(*s)) s++;
3029 if (*s++ == '}') goto RETURN;
3031 /* Get here if there is a bracketing failure */
3036 /* Get here for other failures */
3041 /* Update the input pointer value before returning */
3051 /*************************************************
3052 * Handle MD5 or SHA-1 computation for HMAC *
3053 *************************************************/
3055 /* These are some wrapping functions that enable the HMAC code to be a bit
3056 cleaner. A good compiler will spot the tail recursion.
3059 type HMAC_MD5 or HMAC_SHA1
3060 remaining are as for the cryptographic hash functions
3066 chash_start(int type, void *base)
3068 if (type == HMAC_MD5)
3069 md5_start((md5 *)base);
3071 sha1_start((sha1 *)base);
3075 chash_mid(int type, void *base, uschar *string)
3077 if (type == HMAC_MD5)
3078 md5_mid((md5 *)base, string);
3080 sha1_mid((sha1 *)base, string);
3084 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3086 if (type == HMAC_MD5)
3087 md5_end((md5 *)base, string, length, digest);
3089 sha1_end((sha1 *)base, string, length, digest);
3096 /********************************************************
3097 * prvs: Get last three digits of days since Jan 1, 1970 *
3098 ********************************************************/
3100 /* This is needed to implement the "prvs" BATV reverse
3103 Argument: integer "days" offset to add or substract to
3104 or from the current number of days.
3106 Returns: pointer to string containing the last three
3107 digits of the number of days since Jan 1, 1970,
3108 modified by the offset argument, NULL if there
3109 was an error in the conversion.
3114 prvs_daystamp(int day_offset)
3116 uschar *days = store_get(32); /* Need at least 24 for cases */
3117 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3118 (time(NULL) + day_offset*86400)/86400);
3119 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3124 /********************************************************
3125 * prvs: perform HMAC-SHA1 computation of prvs bits *
3126 ********************************************************/
3128 /* This is needed to implement the "prvs" BATV reverse
3132 address RFC2821 Address to use
3133 key The key to use (must be less than 64 characters
3135 key_num Single-digit key number to use. Defaults to
3138 Returns: pointer to string containing the first three
3139 bytes of the final hash in hex format, NULL if
3140 there was an error in the process.
3144 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3146 uschar *hash_source, *p;
3147 int size = 0,offset = 0,i;
3149 void *use_base = &sha1_base;
3150 uschar innerhash[20];
3151 uschar finalhash[20];
3152 uschar innerkey[64];
3153 uschar outerkey[64];
3154 uschar *finalhash_hex = store_get(40);
3156 if (key_num == NULL)
3159 if (Ustrlen(key) > 64)
3162 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3163 string_cat(hash_source,&size,&offset,daystamp,3);
3164 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3165 hash_source[offset] = '\0';
3167 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3169 memset(innerkey, 0x36, 64);
3170 memset(outerkey, 0x5c, 64);
3172 for (i = 0; i < Ustrlen(key); i++)
3174 innerkey[i] ^= key[i];
3175 outerkey[i] ^= key[i];
3178 chash_start(HMAC_SHA1, use_base);
3179 chash_mid(HMAC_SHA1, use_base, innerkey);
3180 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3182 chash_start(HMAC_SHA1, use_base);
3183 chash_mid(HMAC_SHA1, use_base, outerkey);
3184 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3187 for (i = 0; i < 3; i++)
3189 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3190 *p++ = hex_digits[finalhash[i] & 0x0f];
3194 return finalhash_hex;
3200 /*************************************************
3201 * Join a file onto the output string *
3202 *************************************************/
3204 /* This is used for readfile and after a run expansion. It joins the contents
3205 of a file onto the output string, globally replacing newlines with a given
3206 string (optionally). The file is closed at the end.
3210 yield pointer to the expandable string
3211 sizep pointer to the current size
3212 ptrp pointer to the current position
3213 eol newline replacement string, or NULL
3215 Returns: new value of string pointer
3219 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3222 uschar buffer[1024];
3224 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3226 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3228 int len = Ustrlen(buffer);
3229 if (eol != NULL && buffer[len-1] == '\n') len--;
3230 yield = string_cat(yield, sizep, ptrp, buffer, len);
3231 if (buffer[len] != 0)
3232 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3235 if (yield != NULL) yield[*ptrp] = 0;
3243 /*************************************************
3244 * Evaluate numeric expression *
3245 *************************************************/
3247 /* This is a set of mutually recursive functions that evaluate an arithmetic
3248 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3249 these functions that is called from elsewhere is eval_expr, whose interface is:
3252 sptr pointer to the pointer to the string - gets updated
3253 decimal TRUE if numbers are to be assumed decimal
3254 error pointer to where to put an error message - must be NULL on input
3255 endket TRUE if ')' must terminate - FALSE for external call
3257 Returns: on success: the value of the expression, with *error still NULL
3258 on failure: an undefined value, with *error = a message
3261 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3264 static int_eximarith_t
3265 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3268 int_eximarith_t x = eval_op_or(&s, decimal, error);
3274 *error = US"expecting closing parenthesis";
3276 while (isspace(*(++s)));
3278 else if (*s != 0) *error = US"expecting operator";
3285 static int_eximarith_t
3286 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3291 while (isspace(*s)) s++;
3296 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3298 switch (tolower(*s))
3301 case 'k': n *= 1024; s++; break;
3302 case 'm': n *= 1024*1024; s++; break;
3303 case 'g': n *= 1024*1024*1024; s++; break;
3305 while (isspace (*s)) s++;
3310 n = eval_expr(&s, decimal, error, 1);
3314 *error = US"expecting number or opening parenthesis";
3322 static int_eximarith_t
3323 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3327 while (isspace(*s)) s++;
3328 if (*s == '+' || *s == '-' || *s == '~')
3331 x = eval_op_unary(&s, decimal, error);
3332 if (op == '-') x = -x;
3333 else if (op == '~') x = ~x;
3337 x = eval_number(&s, decimal, error);
3344 static int_eximarith_t
3345 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3348 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3351 while (*s == '*' || *s == '/' || *s == '%')
3354 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3355 if (*error != NULL) break;
3356 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3357 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3358 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3359 * -N*M is INT_MIN will yielf INT_MIN.
3360 * Since we don't support floating point, this is somewhat simpler.
3361 * Ideally, we'd return an error, but since we overflow for all other
3362 * arithmetic, consistency suggests otherwise, but what's the correct value
3363 * to use? There is none.
3364 * The C standard guarantees overflow for unsigned arithmetic but signed
3365 * overflow invokes undefined behaviour; in practice, this is overflow
3366 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3367 * that long/longlong larger than int are available, or we could just work
3368 * with larger types. We should consider whether to guarantee 32bit eval
3369 * and 64-bit working variables, with errors returned. For now ...
3370 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3371 * can just let the other invalid results occur otherwise, as they have
3372 * until now. For this one case, we can coerce.
3374 if (y == -1 && x == LLONG_MIN && op != '*')
3377 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3378 LLONG_MIN, op, LLONG_MAX);
3388 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3404 static int_eximarith_t
3405 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3408 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3411 while (*s == '+' || *s == '-')
3414 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3415 if (*error != NULL) break;
3416 if (op == '+') x += y; else x -= y;
3424 static int_eximarith_t
3425 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3428 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3431 while ((*s == '<' || *s == '>') && s[1] == s[0])
3436 y = eval_op_sum(&s, decimal, error);
3437 if (*error != NULL) break;
3438 if (op == '<') x <<= y; else x >>= y;
3446 static int_eximarith_t
3447 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3450 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3457 y = eval_op_shift(&s, decimal, error);
3458 if (*error != NULL) break;
3467 static int_eximarith_t
3468 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3471 int_eximarith_t x = eval_op_and(&s, decimal, error);
3478 y = eval_op_and(&s, decimal, error);
3479 if (*error != NULL) break;
3488 static int_eximarith_t
3489 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3492 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3499 y = eval_op_xor(&s, decimal, error);
3500 if (*error != NULL) break;
3510 /*************************************************
3512 *************************************************/
3514 /* Returns either an unchanged string, or the expanded string in stacking pool
3515 store. Interpreted sequences are:
3517 \... normal escaping rules
3518 $name substitutes the variable
3520 ${op:string} operates on the expanded string value
3521 ${item{arg1}{arg2}...} expands the args and then does the business
3522 some literal args are not enclosed in {}
3524 There are now far too many operators and item types to make it worth listing
3525 them here in detail any more.
3527 We use an internal routine recursively to handle embedded substrings. The
3528 external function follows. The yield is NULL if the expansion failed, and there
3529 are two cases: if something collapsed syntactically, or if "fail" was given
3530 as the action on a lookup failure. These can be distinguised by looking at the
3531 variable expand_string_forcedfail, which is TRUE in the latter case.
3533 The skipping flag is set true when expanding a substring that isn't actually
3534 going to be used (after "if" or "lookup") and it prevents lookups from
3535 happening lower down.
3537 Store usage: At start, a store block of the length of the input plus 64
3538 is obtained. This is expanded as necessary by string_cat(), which might have to
3539 get a new block, or might be able to expand the original. At the end of the
3540 function we can release any store above that portion of the yield block that
3541 was actually used. In many cases this will be optimal.
3543 However: if the first item in the expansion is a variable name or header name,
3544 we reset the store before processing it; if the result is in fresh store, we
3545 use that without copying. This is helpful for expanding strings like
3546 $message_headers which can get very long.
3548 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3549 since resetting the store at the end of the expansion will free store that was
3550 allocated by the plugin code as well as the slop after the expanded string. So
3551 we skip any resets if ${dlfunc has been used. This is an unfortunate
3552 consequence of string expansion becoming too powerful.
3555 string the string to be expanded
3556 ket_ends true if expansion is to stop at }
3557 left if not NULL, a pointer to the first character after the
3558 expansion is placed here (typically used with ket_ends)
3559 skipping TRUE for recursive calls when the value isn't actually going
3560 to be used (to allow for optimisation)
3561 honour_dollar TRUE if $ is to be expanded,
3562 FALSE if it's just another character
3564 Returns: NULL if expansion fails:
3565 expand_string_forcedfail is set TRUE if failure was forced
3566 expand_string_message contains a textual error message
3567 a pointer to the expanded string on success
3571 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3572 BOOL skipping, BOOL honour_dollar)
3575 int size = Ustrlen(string)+ 64;
3577 uschar *yield = store_get(size);
3579 uschar *save_expand_nstring[EXPAND_MAXN+1];
3580 int save_expand_nlength[EXPAND_MAXN+1];
3581 BOOL resetok = TRUE;
3583 expand_string_forcedfail = FALSE;
3584 expand_string_message = US"";
3591 /* \ escapes the next character, which must exist, or else
3592 the expansion fails. There's a special escape, \N, which causes
3593 copying of the subject verbatim up to the next \N. Otherwise,
3594 the escapes are the standard set. */
3600 expand_string_message = US"\\ at end of string";
3607 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3608 yield = string_cat(yield, &size, &ptr, t, s - t);
3609 if (*s != 0) s += 2;
3615 ch[0] = string_interpret_escape(&s);
3617 yield = string_cat(yield, &size, &ptr, ch, 1);
3623 /* Anything other than $ is just copied verbatim, unless we are
3624 looking for a terminating } character. */
3626 if (ket_ends && *s == '}') break;
3628 if (*s != '$' || !honour_dollar)
3630 yield = string_cat(yield, &size, &ptr, s++, 1);
3634 /* No { after the $ - must be a plain name or a number for string
3635 match variable. There has to be a fudge for variables that are the
3636 names of header fields preceded by "$header_" because header field
3637 names can contain any printing characters except space and colon.
3638 For those that don't like typing this much, "$h_" is a synonym for
3639 "$header_". A non-existent header yields a NULL value; nothing is
3642 if (isalpha((*(++s))))
3647 s = read_name(name, sizeof(name), s, US"_");
3649 /* If this is the first thing to be expanded, release the pre-allocated
3652 if (ptr == 0 && yield != NULL)
3654 if (resetok) store_reset(yield);
3661 if (Ustrncmp(name, "h_", 2) == 0 ||
3662 Ustrncmp(name, "rh_", 3) == 0 ||
3663 Ustrncmp(name, "bh_", 3) == 0 ||
3664 Ustrncmp(name, "header_", 7) == 0 ||
3665 Ustrncmp(name, "rheader_", 8) == 0 ||
3666 Ustrncmp(name, "bheader_", 8) == 0)
3668 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3669 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3670 s = read_header_name(name, sizeof(name), s);
3671 value = find_header(name, FALSE, &newsize, want_raw, charset);
3673 /* If we didn't find the header, and the header contains a closing brace
3674 character, this may be a user error where the terminating colon
3675 has been omitted. Set a flag to adjust the error message in this case.
3676 But there is no error here - nothing gets inserted. */
3680 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3689 value = find_variable(name, FALSE, skipping, &newsize);
3692 expand_string_message =
3693 string_sprintf("unknown variable name \"%s\"", name);
3694 check_variable_error_message(name);
3699 /* If the data is known to be in a new buffer, newsize will be set to the
3700 size of that buffer. If this is the first thing in an expansion string,
3701 yield will be NULL; just point it at the new store instead of copying. Many
3702 expansion strings contain just one reference, so this is a useful
3703 optimization, especially for humungous headers. */
3705 len = Ustrlen(value);
3706 if (yield == NULL && newsize != 0)
3712 else yield = string_cat(yield, &size, &ptr, value, len);
3720 s = read_number(&n, s);
3721 if (n >= 0 && n <= expand_nmax)
3722 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3727 /* Otherwise, if there's no '{' after $ it's an error. */
3731 expand_string_message = US"$ not followed by letter, digit, or {";
3735 /* After { there can be various things, but they all start with
3736 an initial word, except for a number for a string match variable. */
3738 if (isdigit((*(++s))))
3741 s = read_number(&n, s);
3744 expand_string_message = US"} expected after number";
3747 if (n >= 0 && n <= expand_nmax)
3748 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3755 expand_string_message = US"letter or digit expected after ${";
3759 /* Allow "-" in names to cater for substrings with negative
3760 arguments. Since we are checking for known names after { this is
3763 s = read_name(name, sizeof(name), s, US"_-");
3764 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3768 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3769 If the ACL returns accept or reject we return content set by "message ="
3770 There is currently no limit on recursion; this would have us call
3771 acl_check_internal() directly and get a current level from somewhere.
3772 See also the acl expansion condition ECOND_ACL and the traditional
3773 acl modifier ACLC_ACL.
3777 /* ${acl {name} {arg1}{arg2}...} */
3779 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3782 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl"))
3784 case 1: goto EXPAND_FAILED_CURLY;
3786 case 3: goto EXPAND_FAILED;
3788 if (skipping) continue;
3790 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3795 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3799 expand_string_forcedfail = TRUE;
3801 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3806 /* Handle conditionals - preserve the values of the numerical expansion
3807 variables in case they get changed by a regular expression match in the
3808 condition. If not, they retain their external settings. At the end
3809 of this "if" section, they get restored to their previous values. */
3815 int save_expand_nmax =
3816 save_expand_strings(save_expand_nstring, save_expand_nlength);
3818 while (isspace(*s)) s++;
3819 next_s = eval_condition(s, skipping? NULL : &cond);
3820 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3823 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3824 cond? "true" : "false");
3828 /* The handling of "yes" and "no" result strings is now in a separate
3829 function that is also used by ${lookup} and ${extract} and ${run}. */
3831 switch(process_yesno(
3832 skipping, /* were previously skipping */
3833 cond, /* success/failure indicator */
3834 lookup_value, /* value to reset for string2 */
3835 &s, /* input pointer */
3836 &yield, /* output pointer */
3837 &size, /* output size */
3838 &ptr, /* output current point */
3839 US"if")) /* condition type */
3841 case 1: goto EXPAND_FAILED; /* when all is well, the */
3842 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3845 /* Restore external setting of expansion variables for continuation
3848 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3849 save_expand_nlength);
3853 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3854 expanding an internal string that isn't actually going to be used. All we
3855 need to do is check the syntax, so don't do a lookup at all. Preserve the
3856 values of the numerical expansion variables in case they get changed by a
3857 partial lookup. If not, they retain their external settings. At the end
3858 of this "lookup" section, they get restored to their previous values. */
3862 int stype, partial, affixlen, starflags;
3863 int expand_setup = 0;
3865 uschar *key, *filename, *affix;
3866 uschar *save_lookup_value = lookup_value;
3867 int save_expand_nmax =
3868 save_expand_strings(save_expand_nstring, save_expand_nlength);
3870 if ((expand_forbid & RDO_LOOKUP) != 0)
3872 expand_string_message = US"lookup expansions are not permitted";
3876 /* Get the key we are to look up for single-key+file style lookups.
3877 Otherwise set the key NULL pro-tem. */
3879 while (isspace(*s)) s++;
3882 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3883 if (key == NULL) goto EXPAND_FAILED;
3884 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3885 while (isspace(*s)) s++;
3889 /* Find out the type of database */
3893 expand_string_message = US"missing lookup type";
3897 /* The type is a string that may contain special characters of various
3898 kinds. Allow everything except space or { to appear; the actual content
3899 is checked by search_findtype_partial. */
3901 while (*s != 0 && *s != '{' && !isspace(*s))
3903 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3907 while (isspace(*s)) s++;
3909 /* Now check for the individual search type and any partial or default
3910 options. Only those types that are actually in the binary are valid. */
3912 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3916 expand_string_message = search_error_message;
3920 /* Check that a key was provided for those lookup types that need it,
3921 and was not supplied for those that use the query style. */
3923 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3927 expand_string_message = string_sprintf("missing {key} for single-"
3928 "key \"%s\" lookup", name);
3936 expand_string_message = string_sprintf("a single key was given for "
3937 "lookup type \"%s\", which is not a single-key lookup type", name);
3942 /* Get the next string in brackets and expand it. It is the file name for
3943 single-key+file lookups, and the whole query otherwise. In the case of
3944 queries that also require a file name (e.g. sqlite), the file name comes
3947 if (*s != '{') goto EXPAND_FAILED_CURLY;
3948 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3949 if (filename == NULL) goto EXPAND_FAILED;
3950 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3951 while (isspace(*s)) s++;
3953 /* If this isn't a single-key+file lookup, re-arrange the variables
3954 to be appropriate for the search_ functions. For query-style lookups,
3955 there is just a "key", and no file name. For the special query-style +
3956 file types, the query (i.e. "key") starts with a file name. */
3960 while (isspace(*filename)) filename++;
3963 if (mac_islookup(stype, lookup_querystyle))
3969 if (*filename != '/')
3971 expand_string_message = string_sprintf(
3972 "absolute file name expected for \"%s\" lookup", name);
3975 while (*key != 0 && !isspace(*key)) key++;
3976 if (*key != 0) *key++ = 0;
3980 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3981 the entry was not found. Note that there is no search_close() function.
3982 Files are left open in case of re-use. At suitable places in higher logic,
3983 search_tidyup() is called to tidy all open files. This can save opening
3984 the same file several times. However, files may also get closed when
3985 others are opened, if too many are open at once. The rule is that a
3986 handle should not be used after a second search_open().
3988 Request that a partial search sets up $1 and maybe $2 by passing
3989 expand_setup containing zero. If its value changes, reset expand_nmax,
3990 since new variables will have been set. Note that at the end of this
3991 "lookup" section, the old numeric variables are restored. */
3994 lookup_value = NULL;
3997 void *handle = search_open(filename, stype, 0, NULL, NULL);
4000 expand_string_message = search_error_message;
4003 lookup_value = search_find(handle, filename, key, partial, affix,
4004 affixlen, starflags, &expand_setup);
4005 if (search_find_defer)
4007 expand_string_message =
4008 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4009 string_printing2(key, FALSE), search_error_message);
4012 if (expand_setup > 0) expand_nmax = expand_setup;
4015 /* The handling of "yes" and "no" result strings is now in a separate
4016 function that is also used by ${if} and ${extract}. */
4018 switch(process_yesno(
4019 skipping, /* were previously skipping */
4020 lookup_value != NULL, /* success/failure indicator */
4021 save_lookup_value, /* value to reset for string2 */
4022 &s, /* input pointer */
4023 &yield, /* output pointer */
4024 &size, /* output size */
4025 &ptr, /* output current point */
4026 US"lookup")) /* condition type */
4028 case 1: goto EXPAND_FAILED; /* when all is well, the */
4029 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4032 /* Restore external setting of expansion variables for carrying on
4033 at this level, and continue. */
4035 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4036 save_expand_nlength);
4040 /* If Perl support is configured, handle calling embedded perl subroutines,
4041 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4042 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4043 arguments (defined below). */
4045 #define EXIM_PERL_MAX_ARGS 8
4049 expand_string_message = US"\"${perl\" encountered, but this facility "
4050 "is not included in this binary";
4053 #else /* EXIM_PERL */
4055 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4058 if ((expand_forbid & RDO_PERL) != 0)
4060 expand_string_message = US"Perl calls are not permitted";
4064 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4067 case 1: goto EXPAND_FAILED_CURLY;
4069 case 3: goto EXPAND_FAILED;
4072 /* If skipping, we don't actually do anything */
4074 if (skipping) continue;
4076 /* Start the interpreter if necessary */
4078 if (!opt_perl_started)
4081 if (opt_perl_startup == NULL)
4083 expand_string_message = US"A setting of perl_startup is needed when "
4084 "using the Perl interpreter";
4087 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4088 initerror = init_perl(opt_perl_startup);
4089 if (initerror != NULL)
4091 expand_string_message =
4092 string_sprintf("error in perl_startup code: %s\n", initerror);
4095 opt_perl_started = TRUE;
4098 /* Call the function */
4100 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4101 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4102 sub_arg[0], sub_arg + 1);
4104 /* NULL yield indicates failure; if the message pointer has been set to
4105 NULL, the yield was undef, indicating a forced failure. Otherwise the
4106 message will indicate some kind of Perl error. */
4108 if (new_yield == NULL)
4110 if (expand_string_message == NULL)
4112 expand_string_message =
4113 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4114 "failure", sub_arg[0]);
4115 expand_string_forcedfail = TRUE;
4120 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4121 set during a callback from Perl. */
4123 expand_string_forcedfail = FALSE;
4127 #endif /* EXIM_PERL */
4129 /* Transform email address to "prvs" scheme to use
4130 as BATV-signed return path */
4137 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
4139 case 1: goto EXPAND_FAILED_CURLY;
4141 case 3: goto EXPAND_FAILED;
4144 /* If skipping, we don't actually do anything */
4145 if (skipping) continue;
4147 /* sub_arg[0] is the address */
4148 domain = Ustrrchr(sub_arg[0],'@');
4149 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4151 expand_string_message = US"prvs first argument must be a qualified email address";
4155 /* Calculate the hash. The second argument must be a single-digit
4156 key number, or unset. */
4158 if (sub_arg[2] != NULL &&
4159 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4161 expand_string_message = US"prvs second argument must be a single digit";
4165 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4168 expand_string_message = US"prvs hmac-sha1 conversion failed";
4172 /* Now separate the domain from the local part */
4175 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4176 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4177 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4178 string_cat(yield,&size,&ptr,p,6);
4179 string_cat(yield,&size,&ptr,US"=",1);
4180 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4181 string_cat(yield,&size,&ptr,US"@",1);
4182 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4187 /* Check a prvs-encoded address for validity */
4189 case EITEM_PRVSCHECK:
4192 int mysize = 0, myptr = 0;
4196 /* TF: Ugliness: We want to expand parameter 1 first, then set
4197 up expansion variables that are used in the expansion of
4198 parameter 2. So we clone the string for the first
4199 expansion, where we only expand parameter 1.
4201 PH: Actually, that isn't necessary. The read_subs() function is
4202 designed to work this way for the ${if and ${lookup expansions. I've
4206 /* Reset expansion variables */
4207 prvscheck_result = NULL;
4208 prvscheck_address = NULL;
4209 prvscheck_keynum = NULL;
4211 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4213 case 1: goto EXPAND_FAILED_CURLY;
4215 case 3: goto EXPAND_FAILED;
4218 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4221 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4223 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4224 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4225 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4226 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4227 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4229 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4230 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4231 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4232 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4233 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4235 /* Set up expansion variables */
4236 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4237 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4238 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4239 prvscheck_address[myptr] = '\0';
4240 prvscheck_keynum = string_copy(key_num);
4242 /* Now expand the second argument */
4243 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4245 case 1: goto EXPAND_FAILED_CURLY;
4247 case 3: goto EXPAND_FAILED;
4250 /* Now we have the key and can check the address. */
4252 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4257 expand_string_message = US"hmac-sha1 conversion failed";
4261 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4262 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4264 if (Ustrcmp(p,hash) == 0)
4266 /* Success, valid BATV address. Now check the expiry date. */
4267 uschar *now = prvs_daystamp(0);
4268 unsigned int inow = 0,iexpire = 1;
4270 (void)sscanf(CS now,"%u",&inow);
4271 (void)sscanf(CS daystamp,"%u",&iexpire);
4273 /* When "iexpire" is < 7, a "flip" has occured.
4274 Adjust "inow" accordingly. */
4275 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4277 if (iexpire >= inow)
4279 prvscheck_result = US"1";
4280 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4284 prvscheck_result = NULL;
4285 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4290 prvscheck_result = NULL;
4291 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4294 /* Now expand the final argument. We leave this till now so that
4295 it can include $prvscheck_result. */
4297 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4299 case 1: goto EXPAND_FAILED_CURLY;
4301 case 3: goto EXPAND_FAILED;
4304 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4305 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4307 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4309 /* Reset the "internal" variables afterwards, because they are in
4310 dynamic store that will be reclaimed if the expansion succeeded. */
4312 prvscheck_address = NULL;
4313 prvscheck_keynum = NULL;
4317 /* Does not look like a prvs encoded address, return the empty string.
4318 We need to make sure all subs are expanded first, so as to skip over
4321 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4323 case 1: goto EXPAND_FAILED_CURLY;
4325 case 3: goto EXPAND_FAILED;
4332 /* Handle "readfile" to insert an entire file */
4334 case EITEM_READFILE:
4339 if ((expand_forbid & RDO_READFILE) != 0)
4341 expand_string_message = US"file insertions are not permitted";
4345 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4347 case 1: goto EXPAND_FAILED_CURLY;
4349 case 3: goto EXPAND_FAILED;
4352 /* If skipping, we don't actually do anything */
4354 if (skipping) continue;
4356 /* Open the file and read it */
4358 f = Ufopen(sub_arg[0], "rb");
4361 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4365 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4370 /* Handle "readsocket" to insert data from a Unix domain socket */
4372 case EITEM_READSOCK:
4378 struct sockaddr_un sockun; /* don't call this "sun" ! */
4382 if ((expand_forbid & RDO_READSOCK) != 0)
4384 expand_string_message = US"socket insertions are not permitted";
4388 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4389 because there may be a string for expansion on failure. */
4391 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4393 case 1: goto EXPAND_FAILED_CURLY;
4394 case 2: /* Won't occur: no end check */
4395 case 3: goto EXPAND_FAILED;
4398 /* Sort out timeout, if given */
4400 if (sub_arg[2] != NULL)
4402 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4405 expand_string_message = string_sprintf("bad time value %s",
4410 else sub_arg[3] = NULL; /* No eol if no timeout */
4412 /* If skipping, we don't actually do anything. Otherwise, arrange to
4413 connect to either an IP or a Unix socket. */
4417 /* Handle an IP (internet) domain */
4419 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4421 BOOL connected = FALSE;
4425 uschar *server_name = sub_arg[0] + 5;
4426 uschar *port_name = Ustrrchr(server_name, ':');
4428 /* Sort out the port */
4430 if (port_name == NULL)
4432 expand_string_message =
4433 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4436 *port_name++ = 0; /* Terminate server name */
4438 if (isdigit(*port_name))
4441 port = Ustrtol(port_name, &end, 0);
4442 if (end != port_name + Ustrlen(port_name))
4444 expand_string_message =
4445 string_sprintf("invalid port number %s", port_name);
4451 struct servent *service_info = getservbyname(CS port_name, "tcp");
4452 if (service_info == NULL)
4454 expand_string_message = string_sprintf("unknown port \"%s\"",
4458 port = ntohs(service_info->s_port);
4461 /* Sort out the server. */
4464 shost.address = NULL;
4468 namelen = Ustrlen(server_name);
4470 /* Anything enclosed in [] must be an IP address. */
4472 if (server_name[0] == '[' &&
4473 server_name[namelen - 1] == ']')
4475 server_name[namelen - 1] = 0;
4477 if (string_is_ip_address(server_name, NULL) == 0)
4479 expand_string_message =
4480 string_sprintf("malformed IP address \"%s\"", server_name);
4483 shost.name = shost.address = server_name;
4486 /* Otherwise check for an unadorned IP address */
4488 else if (string_is_ip_address(server_name, NULL) != 0)
4489 shost.name = shost.address = server_name;
4491 /* Otherwise lookup IP address(es) from the name */
4495 shost.name = server_name;
4496 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4497 FALSE) != HOST_FOUND)
4499 expand_string_message =
4500 string_sprintf("no IP address found for host %s", shost.name);
4505 /* Try to connect to the server - test each IP till one works */
4507 for (h = &shost; h != NULL; h = h->next)
4509 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4510 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4512 expand_string_message = string_sprintf("failed to create socket: "
4513 "%s", strerror(errno));
4517 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4526 expand_string_message = string_sprintf("failed to connect to "
4527 "socket %s: couldn't connect to any host", sub_arg[0],
4533 /* Handle a Unix domain socket */
4538 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4540 expand_string_message = string_sprintf("failed to create socket: %s",
4545 sockun.sun_family = AF_UNIX;
4546 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4549 sigalrm_seen = FALSE;
4551 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4555 expand_string_message = US "socket connect timed out";
4560 expand_string_message = string_sprintf("failed to connect to socket "
4561 "%s: %s", sub_arg[0], strerror(errno));
4566 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4568 /* Write the request string, if not empty */
4570 if (sub_arg[1][0] != 0)
4572 int len = Ustrlen(sub_arg[1]);
4573 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4575 if (write(fd, sub_arg[1], len) != len)
4577 expand_string_message = string_sprintf("request write to socket "
4578 "failed: %s", strerror(errno));
4583 /* Shut down the sending side of the socket. This helps some servers to
4584 recognise that it is their turn to do some work. Just in case some
4585 system doesn't have this function, make it conditional. */
4588 shutdown(fd, SHUT_WR);
4591 /* Now we need to read from the socket, under a timeout. The function
4592 that reads a file can be used. */
4594 f = fdopen(fd, "rb");
4595 sigalrm_seen = FALSE;
4597 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4601 /* After a timeout, we restore the pointer in the result, that is,
4602 make sure we add nothing from the socket. */
4607 expand_string_message = US "socket read timed out";
4612 /* The whole thing has worked (or we were skipping). If there is a
4613 failure string following, we need to skip it. */
4617 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4619 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4620 while (isspace(*s)) s++;
4622 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4625 /* Come here on failure to create socket, connect socket, write to the
4626 socket, or timeout on reading. If another substring follows, expand and
4627 use it. Otherwise, those conditions give expand errors. */
4630 if (*s != '{') goto EXPAND_FAILED;
4631 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4632 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4633 if (arg == NULL) goto EXPAND_FAILED;
4634 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4635 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4636 while (isspace(*s)) s++;
4637 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4641 /* Handle "run" to execute a program. */
4653 if ((expand_forbid & RDO_RUN) != 0)
4655 expand_string_message = US"running a command is not permitted";
4659 while (isspace(*s)) s++;
4660 if (*s != '{') goto EXPAND_FAILED_CURLY;
4661 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4662 if (arg == NULL) goto EXPAND_FAILED;
4663 while (isspace(*s)) s++;
4664 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4666 if (skipping) /* Just pretend it worked when we're skipping */
4672 if (!transport_set_up_command(&argv, /* anchor for arg list */
4673 arg, /* raw command */
4674 FALSE, /* don't expand the arguments */
4675 0, /* not relevant when... */
4676 NULL, /* no transporting address */
4677 US"${run} expansion", /* for error messages */
4678 &expand_string_message)) /* where to put error message */
4683 /* Create the child process, making it a group leader. */
4685 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4689 expand_string_message =
4690 string_sprintf("couldn't create child process: %s", strerror(errno));
4694 /* Nothing is written to the standard input. */
4698 /* Read the pipe to get the command's output into $value (which is kept
4699 in lookup_value). Read during execution, so that if the output exceeds
4700 the OS pipe buffer limit, we don't block forever. */
4702 f = fdopen(fd_out, "rb");
4703 sigalrm_seen = FALSE;
4705 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4709 /* Wait for the process to finish, applying the timeout, and inspect its
4710 return code for serious disasters. Simple non-zero returns are passed on.
4713 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4715 if (sigalrm_seen == TRUE || runrc == -256)
4717 expand_string_message = string_sprintf("command timed out");
4718 killpg(pid, SIGKILL); /* Kill the whole process group */
4721 else if (runrc == -257)
4722 expand_string_message = string_sprintf("wait() failed: %s",
4726 expand_string_message = string_sprintf("command killed by signal %d",
4733 /* Process the yes/no strings; $value may be useful in both cases */
4735 switch(process_yesno(
4736 skipping, /* were previously skipping */
4737 runrc == 0, /* success/failure indicator */
4738 lookup_value, /* value to reset for string2 */
4739 &s, /* input pointer */
4740 &yield, /* output pointer */
4741 &size, /* output size */
4742 &ptr, /* output current point */
4743 US"run")) /* condition type */
4745 case 1: goto EXPAND_FAILED; /* when all is well, the */
4746 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4752 /* Handle character translation for "tr" */
4760 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4762 case 1: goto EXPAND_FAILED_CURLY;
4764 case 3: goto EXPAND_FAILED;
4767 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4768 o2m = Ustrlen(sub[2]) - 1;
4770 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4772 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4776 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4783 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4784 expanded arguments. */
4794 int val[2] = { 0, -1 };
4797 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4798 Ensure that sub[2] is set in the ${length case. */
4801 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4804 case 1: goto EXPAND_FAILED_CURLY;
4806 case 3: goto EXPAND_FAILED;
4809 /* Juggle the arguments if there are only two of them: always move the
4810 string to the last position and make ${length{n}{str}} equivalent to
4811 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4817 if (item_type == EITEM_LENGTH)
4824 for (i = 0; i < 2; i++)
4826 if (sub[i] == NULL) continue;
4827 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4828 if (*ret != 0 || (i != 0 && val[i] < 0))
4830 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4831 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4837 (item_type == EITEM_HASH)?
4838 compute_hash(sub[2], val[0], val[1], &len) :
4839 (item_type == EITEM_NHASH)?
4840 compute_nhash(sub[2], val[0], val[1], &len) :
4841 extract_substr(sub[2], val[0], val[1], &len);
4843 if (ret == NULL) goto EXPAND_FAILED;
4844 yield = string_cat(yield, &size, &ptr, ret, len);
4848 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4849 This code originally contributed by Steve Haslam. It currently supports
4850 the use of MD5 and SHA-1 hashes.
4852 We need some workspace that is large enough to handle all the supported
4853 hash types. Use macros to set the sizes rather than be too elaborate. */
4855 #define MAX_HASHLEN 20
4856 #define MAX_HASHBLOCKLEN 64
4865 int hashlen; /* Number of octets for the hash algorithm's output */
4866 int hashblocklen; /* Number of octets the hash algorithm processes */
4868 unsigned int keylen;
4870 uschar keyhash[MAX_HASHLEN];
4871 uschar innerhash[MAX_HASHLEN];
4872 uschar finalhash[MAX_HASHLEN];
4873 uschar finalhash_hex[2*MAX_HASHLEN];
4874 uschar innerkey[MAX_HASHBLOCKLEN];
4875 uschar outerkey[MAX_HASHBLOCKLEN];
4877 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4879 case 1: goto EXPAND_FAILED_CURLY;
4881 case 3: goto EXPAND_FAILED;
4884 if (Ustrcmp(sub[0], "md5") == 0)
4887 use_base = &md5_base;
4891 else if (Ustrcmp(sub[0], "sha1") == 0)
4894 use_base = &sha1_base;
4900 expand_string_message =
4901 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4906 keylen = Ustrlen(keyptr);
4908 /* If the key is longer than the hash block length, then hash the key
4911 if (keylen > hashblocklen)
4913 chash_start(type, use_base);
4914 chash_end(type, use_base, keyptr, keylen, keyhash);
4919 /* Now make the inner and outer key values */
4921 memset(innerkey, 0x36, hashblocklen);
4922 memset(outerkey, 0x5c, hashblocklen);
4924 for (i = 0; i < keylen; i++)
4926 innerkey[i] ^= keyptr[i];
4927 outerkey[i] ^= keyptr[i];
4930 /* Now do the hashes */
4932 chash_start(type, use_base);
4933 chash_mid(type, use_base, innerkey);
4934 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4936 chash_start(type, use_base);
4937 chash_mid(type, use_base, outerkey);
4938 chash_end(type, use_base, innerhash, hashlen, finalhash);
4940 /* Encode the final hash as a hex string */
4943 for (i = 0; i < hashlen; i++)
4945 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4946 *p++ = hex_digits[finalhash[i] & 0x0f];
4949 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4950 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4952 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4957 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4958 We have to save the numerical variables and restore them afterwards. */
4963 int moffset, moffsetextra, slen;
4966 const uschar *rerror;
4969 int save_expand_nmax =
4970 save_expand_strings(save_expand_nstring, save_expand_nlength);
4972 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4974 case 1: goto EXPAND_FAILED_CURLY;
4976 case 3: goto EXPAND_FAILED;
4979 /* Compile the regular expression */
4981 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4986 expand_string_message = string_sprintf("regular expression error in "
4987 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4991 /* Now run a loop to do the substitutions as often as necessary. It ends
4992 when there are no more matches. Take care over matches of the null string;
4993 do the same thing as Perl does. */
4996 slen = Ustrlen(sub[0]);
4997 moffset = moffsetextra = 0;
5002 int ovector[3*(EXPAND_MAXN+1)];
5003 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5004 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5008 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5009 is not necessarily the end. We want to repeat the match from one
5010 character further along, but leaving the basic offset the same (for
5011 copying below). We can't be at the end of the string - that was checked
5012 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5013 finished; copy the remaining string and end the loop. */
5023 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5027 /* Match - set up for expanding the replacement. */
5029 if (n == 0) n = EXPAND_MAXN + 1;
5031 for (nn = 0; nn < n*2; nn += 2)
5033 expand_nstring[expand_nmax] = subject + ovector[nn];
5034 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5038 /* Copy the characters before the match, plus the expanded insertion. */
5040 yield = string_cat(yield, &size, &ptr, subject + moffset,
5041 ovector[0] - moffset);
5042 insert = expand_string(sub[2]);
5043 if (insert == NULL) goto EXPAND_FAILED;
5044 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5046 moffset = ovector[1];
5050 /* If we have matched an empty string, first check to see if we are at
5051 the end of the subject. If so, the loop is over. Otherwise, mimic
5052 what Perl's /g options does. This turns out to be rather cunning. First
5053 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5054 string at the same point. If this fails (picked up above) we advance to
5055 the next character. */
5057 if (ovector[0] == ovector[1])
5059 if (ovector[0] == slen) break;
5060 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5064 /* All done - restore numerical variables. */
5066 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5067 save_expand_nlength);
5071 /* Handle keyed and numbered substring extraction. If the first argument
5072 consists entirely of digits, then a numerical extraction is assumed. */
5078 int field_number = 1;
5079 BOOL field_number_set = FALSE;
5080 uschar *save_lookup_value = lookup_value;
5082 int save_expand_nmax =
5083 save_expand_strings(save_expand_nstring, save_expand_nlength);
5085 /* Read the arguments */
5087 for (i = 0; i < j; i++)
5089 while (isspace(*s)) s++;
5092 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5093 if (sub[i] == NULL) goto EXPAND_FAILED;
5094 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5096 /* After removal of leading and trailing white space, the first
5097 argument must not be empty; if it consists entirely of digits
5098 (optionally preceded by a minus sign), this is a numerical
5099 extraction, and we expect 3 arguments. */
5107 while (isspace(*p)) p++;
5111 while (len > 0 && isspace(p[len-1])) len--;
5114 if (*p == 0 && !skipping)
5116 expand_string_message = US"first argument of \"extract\" must "
5126 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5130 j = 3; /* Need 3 args */
5131 field_number_set = TRUE;
5135 else goto EXPAND_FAILED_CURLY;
5138 /* Extract either the numbered or the keyed substring into $value. If
5139 skipping, just pretend the extraction failed. */
5141 lookup_value = skipping? NULL : field_number_set?
5142 expand_gettokened(field_number, sub[1], sub[2]) :
5143 expand_getkeyed(sub[0], sub[1]);
5145 /* If no string follows, $value gets substituted; otherwise there can
5146 be yes/no strings, as for lookup or if. */
5148 switch(process_yesno(
5149 skipping, /* were previously skipping */
5150 lookup_value != NULL, /* success/failure indicator */
5151 save_lookup_value, /* value to reset for string2 */
5152 &s, /* input pointer */
5153 &yield, /* output pointer */
5154 &size, /* output size */
5155 &ptr, /* output current point */
5156 US"extract")) /* condition type */
5158 case 1: goto EXPAND_FAILED; /* when all is well, the */
5159 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5162 /* All done - restore numerical variables. */
5164 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5165 save_expand_nlength);
5171 /* Handle list operations */
5179 uschar outsep[2] = { '\0', '\0' };
5180 uschar *list, *expr, *temp;
5181 uschar *save_iterate_item = iterate_item;
5182 uschar *save_lookup_value = lookup_value;
5184 while (isspace(*s)) s++;
5185 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5187 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5188 if (list == NULL) goto EXPAND_FAILED;
5189 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5191 if (item_type == EITEM_REDUCE)
5193 while (isspace(*s)) s++;
5194 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5195 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5196 if (temp == NULL) goto EXPAND_FAILED;
5197 lookup_value = temp;
5198 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5201 while (isspace(*s)) s++;
5202 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5206 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5207 if scanning a "false" part). This allows us to find the end of the
5208 condition, because if the list is empty, we won't actually evaluate the
5209 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5210 the normal internal expansion function. */
5212 if (item_type == EITEM_FILTER)
5214 temp = eval_condition(expr, NULL);
5215 if (temp != NULL) s = temp;
5219 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5224 expand_string_message = string_sprintf("%s inside \"%s\" item",
5225 expand_string_message, name);
5229 while (isspace(*s)) s++;
5232 expand_string_message = string_sprintf("missing } at end of condition "
5233 "or expression inside \"%s\"", name);
5237 while (isspace(*s)) s++;
5240 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5245 /* If we are skipping, we can now just move on to the next item. When
5246 processing for real, we perform the iteration. */
5248 if (skipping) continue;
5249 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5251 *outsep = (uschar)sep; /* Separator as a string */
5253 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5255 if (item_type == EITEM_FILTER)
5258 if (eval_condition(expr, &condresult) == NULL)
5260 iterate_item = save_iterate_item;
5261 lookup_value = save_lookup_value;
5262 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5263 expand_string_message, name);
5266 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5267 condresult? "true":"false");
5269 temp = iterate_item; /* TRUE => include this item */
5271 continue; /* FALSE => skip this item */
5274 /* EITEM_MAP and EITEM_REDUCE */
5278 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5281 iterate_item = save_iterate_item;
5282 expand_string_message = string_sprintf("%s inside \"%s\" item",
5283 expand_string_message, name);
5286 if (item_type == EITEM_REDUCE)
5288 lookup_value = temp; /* Update the value of $value */
5289 continue; /* and continue the iteration */
5293 /* We reach here for FILTER if the condition is true, always for MAP,
5294 and never for REDUCE. The value in "temp" is to be added to the output
5295 list that is being created, ensuring that any occurrences of the
5296 separator character are doubled. Unless we are dealing with the first
5297 item of the output list, add in a space if the new item begins with the
5298 separator character, or is an empty string. */
5300 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5301 yield = string_cat(yield, &size, &ptr, US" ", 1);
5303 /* Add the string in "temp" to the output list that we are building,
5304 This is done in chunks by searching for the separator character. */
5308 size_t seglen = Ustrcspn(temp, outsep);
5309 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5311 /* If we got to the end of the string we output one character
5312 too many; backup and end the loop. Otherwise arrange to double the
5315 if (temp[seglen] == '\0') { ptr--; break; }
5316 yield = string_cat(yield, &size, &ptr, outsep, 1);
5320 /* Output a separator after the string: we will remove the redundant
5321 final one at the end. */
5323 yield = string_cat(yield, &size, &ptr, outsep, 1);
5324 } /* End of iteration over the list loop */
5326 /* REDUCE has generated no output above: output the final value of
5329 if (item_type == EITEM_REDUCE)
5331 yield = string_cat(yield, &size, &ptr, lookup_value,
5332 Ustrlen(lookup_value));
5333 lookup_value = save_lookup_value; /* Restore $value */
5336 /* FILTER and MAP generate lists: if they have generated anything, remove
5337 the redundant final separator. Even though an empty item at the end of a
5338 list does not count, this is tidier. */
5340 else if (ptr != save_ptr) ptr--;
5342 /* Restore preserved $item */
5344 iterate_item = save_iterate_item;
5349 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5350 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5351 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5352 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5354 #define EXPAND_DLFUNC_MAX_ARGS 8
5357 #ifndef EXPAND_DLFUNC
5358 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5359 "is not included in this binary";
5362 #else /* EXPAND_DLFUNC */
5365 exim_dlfunc_t *func;
5368 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5370 if ((expand_forbid & RDO_DLFUNC) != 0)
5372 expand_string_message =
5373 US"dynamically-loaded functions are not permitted";
5377 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5380 case 1: goto EXPAND_FAILED_CURLY;
5382 case 3: goto EXPAND_FAILED;
5385 /* If skipping, we don't actually do anything */
5387 if (skipping) continue;
5389 /* Look up the dynamically loaded object handle in the tree. If it isn't
5390 found, dlopen() the file and put the handle in the tree for next time. */
5392 t = tree_search(dlobj_anchor, argv[0]);
5395 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5398 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5399 argv[0], dlerror());
5400 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5403 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5404 Ustrcpy(t->name, argv[0]);
5405 t->data.ptr = handle;
5406 (void)tree_insertnode(&dlobj_anchor, t);
5409 /* Having obtained the dynamically loaded object handle, look up the
5410 function pointer. */
5412 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5415 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5416 "%s", argv[1], argv[0], dlerror());
5417 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5421 /* Call the function and work out what to do with the result. If it
5422 returns OK, we have a replacement string; if it returns DEFER then
5423 expansion has failed in a non-forced manner; if it returns FAIL then
5424 failure was forced; if it returns ERROR or any other value there's a
5425 problem, so panic slightly. In any case, assume that the function has
5426 side-effects on the store that must be preserved. */
5430 for (argc = 0; argv[argc] != NULL; argc++);
5431 status = func(&result, argc - 2, &argv[2]);
5434 if (result == NULL) result = US"";
5435 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5440 expand_string_message = result == NULL ? US"(no message)" : result;
5441 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5442 else if(status != FAIL)
5443 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5444 argv[0], argv[1], status, expand_string_message);
5448 #endif /* EXPAND_DLFUNC */
5451 /* Control reaches here if the name is not recognized as one of the more
5452 complicated expansion items. Check for the "operator" syntax (name terminated
5453 by a colon). Some of the operators have arguments, separated by _ from the
5460 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5461 if (sub == NULL) goto EXPAND_FAILED;
5464 /* Owing to an historical mis-design, an underscore may be part of the
5465 operator name, or it may introduce arguments. We therefore first scan the
5466 table of names that contain underscores. If there is no match, we cut off
5467 the arguments and then scan the main table. */
5469 c = chop_match(name, op_table_underscore,
5470 sizeof(op_table_underscore)/sizeof(uschar *));
5474 arg = Ustrchr(name, '_');
5475 if (arg != NULL) *arg = 0;
5476 c = chop_match(name, op_table_main,
5477 sizeof(op_table_main)/sizeof(uschar *));
5478 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5479 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5482 /* If we are skipping, we don't need to perform the operation at all.
5483 This matters for operations like "mask", because the data may not be
5484 in the correct format when skipping. For example, the expression may test
5485 for the existence of $sender_host_address before trying to mask it. For
5486 other operations, doing them may not fail, but it is a waste of time. */
5488 if (skipping && c >= 0) continue;
5490 /* Otherwise, switch on the operator type */
5497 unsigned long int n = Ustrtoul(sub, &t, 10);
5500 expand_string_message = string_sprintf("argument for base62 "
5501 "operator is \"%s\", which is not a decimal number", sub);
5504 t = string_base62(n);
5505 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5509 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5515 unsigned long int n = 0;
5518 uschar *t = Ustrchr(base62_chars, *tt++);
5521 expand_string_message = string_sprintf("argument for base62d "
5522 "operator is \"%s\", which is not a base %d number", sub,
5526 n = n * BASE_62 + (t - base62_chars);
5528 (void)sprintf(CS buf, "%ld", n);
5529 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5535 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5536 if (expanded == NULL)
5538 expand_string_message =
5539 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5540 expand_string_message);
5543 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5550 uschar *t = sub - 1;
5551 while (*(++t) != 0) { *t = tolower(*t); count++; }
5552 yield = string_cat(yield, &size, &ptr, sub, count);
5559 uschar *t = sub - 1;
5560 while (*(++t) != 0) { *t = toupper(*t); count++; }
5561 yield = string_cat(yield, &size, &ptr, sub, count);
5572 md5_end(&base, sub, Ustrlen(sub), digest);
5573 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5574 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5585 sha1_end(&base, sub, Ustrlen(sub), digest);
5586 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5587 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5591 /* Convert hex encoding to base64 encoding */
5601 for (enc = sub; *enc != 0; enc++)
5603 if (!isxdigit(*enc))
5605 expand_string_message = string_sprintf("\"%s\" is not a hex "
5614 expand_string_message = string_sprintf("\"%s\" contains an odd "
5615 "number of characters", sub);
5619 while ((c = *in++) != 0)
5621 if (isdigit(c)) c -= '0';
5622 else c = toupper(c) - 'A' + 10;
5634 enc = auth_b64encode(sub, out - sub);
5635 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5639 /* count the number of list elements */
5648 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5649 cp = string_sprintf("%d", cnt);
5650 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5654 /* expand a named list given the name */
5655 /* handles nested named lists; requotes as colon-sep list */
5659 tree_node *t = NULL;
5663 uschar * suffix = "";
5664 BOOL needsep = FALSE;
5667 if (*sub == '+') sub++;
5668 if (arg == NULL) /* no-argument version */
5670 if (!(t = tree_search(addresslist_anchor, sub)) &&
5671 !(t = tree_search(domainlist_anchor, sub)) &&
5672 !(t = tree_search(hostlist_anchor, sub)))
5673 t = tree_search(localpartlist_anchor, sub);
5675 else switch(*arg) /* specific list-type version */
5677 case 'a': t = tree_search(addresslist_anchor, sub); suffix = "_a"; break;
5678 case 'd': t = tree_search(domainlist_anchor, sub); suffix = "_d"; break;
5679 case 'h': t = tree_search(hostlist_anchor, sub); suffix = "_h"; break;
5680 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = "_l"; break;
5682 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5688 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5690 : *arg=='a'?"address "
5691 : *arg=='d'?"domain "
5693 : *arg=='l'?"localpart "
5698 list = ((namedlist_block *)(t->data.ptr))->string;
5700 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5702 uschar * buf = US" : ";
5704 yield = string_cat(yield, &size, &ptr, buf, 3);
5708 if (*item == '+') /* list item is itself a named list */
5710 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5711 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE);
5713 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5717 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5718 while ((cp= strpbrk((const char *)item, tok)))
5720 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5721 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5723 yield = string_cat(yield, &size, &ptr, US"::", 2);
5726 else /* sep in item; should already be doubled; emit once */
5728 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5729 if (*cp == sep) cp++;
5734 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5739 /* mask applies a mask to an IP address; for example the result of
5740 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5747 int mask, maskoffset;
5748 int type = string_is_ip_address(sub, &maskoffset);
5753 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5758 if (maskoffset == 0)
5760 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5765 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5767 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5769 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5774 /* Convert the address to binary integer(s) and apply the mask */
5776 sub[maskoffset] = 0;
5777 count = host_aton(sub, binary);
5778 host_mask(count, binary, mask);
5780 /* Convert to masked textual format and add to output. */
5782 yield = string_cat(yield, &size, &ptr, buffer,
5783 host_nmtoa(count, binary, mask, buffer, '.'));
5788 case EOP_LOCAL_PART:
5792 int start, end, domain;
5793 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5797 if (c != EOP_DOMAIN)
5799 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5800 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5802 else if (domain != 0)
5805 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5813 uschar outsep[2] = { ':', '\0' };
5814 uschar *address, *error;
5816 int start, end, domain; /* Not really used */
5818 while (isspace(*sub)) sub++;
5819 if (*sub == '>') { *outsep = *++sub; ++sub; }
5820 parse_allow_group = TRUE;
5824 uschar *p = parse_find_address_end(sub, FALSE);
5825 uschar saveend = *p;
5827 address = parse_extract_address(sub, &error, &start, &end, &domain,
5831 /* Add the address to the output list that we are building. This is
5832 done in chunks by searching for the separator character. At the
5833 start, unless we are dealing with the first address of the output
5834 list, add in a space if the new address begins with the separator
5835 character, or is an empty string. */
5837 if (address != NULL)
5839 if (ptr != save_ptr && address[0] == *outsep)
5840 yield = string_cat(yield, &size, &ptr, US" ", 1);
5844 size_t seglen = Ustrcspn(address, outsep);
5845 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5847 /* If we got to the end of the string we output one character
5850 if (address[seglen] == '\0') { ptr--; break; }
5851 yield = string_cat(yield, &size, &ptr, outsep, 1);
5852 address += seglen + 1;
5855 /* Output a separator after the string: we will remove the
5856 redundant final one at the end. */
5858 yield = string_cat(yield, &size, &ptr, outsep, 1);
5861 if (saveend == '\0') break;
5865 /* If we have generated anything, remove the redundant final
5868 if (ptr != save_ptr) ptr--;
5869 parse_allow_group = FALSE;
5874 /* quote puts a string in quotes if it is empty or contains anything
5875 other than alphamerics, underscore, dot, or hyphen.
5877 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5878 be quoted in order to be a valid local part.
5880 In both cases, newlines and carriage returns are converted into \n and \r
5884 case EOP_QUOTE_LOCAL_PART:
5887 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5888 uschar *t = sub - 1;
5892 while (!needs_quote && *(++t) != 0)
5893 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5895 else /* EOP_QUOTE_LOCAL_PART */
5897 while (!needs_quote && *(++t) != 0)
5898 needs_quote = !isalnum(*t) &&
5899 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5900 (*t != '.' || t == sub || t[1] == 0);
5905 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5910 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5911 else if (*t == '\r')
5912 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5915 if (*t == '\\' || *t == '"')
5916 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5917 yield = string_cat(yield, &size, &ptr, t, 1);
5920 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5922 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5926 /* quote_lookuptype does lookup-specific quoting */
5931 uschar *opt = Ustrchr(arg, '_');
5933 if (opt != NULL) *opt++ = 0;
5935 n = search_findtype(arg, Ustrlen(arg));
5938 expand_string_message = search_error_message;
5942 if (lookup_list[n]->quote != NULL)
5943 sub = (lookup_list[n]->quote)(sub, opt);
5944 else if (opt != NULL) sub = NULL;
5948 expand_string_message = string_sprintf(
5949 "\"%s\" unrecognized after \"${quote_%s\"",
5954 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5958 /* rx quote sticks in \ before any non-alphameric character so that
5959 the insertion works in a regular expression. */
5963 uschar *t = sub - 1;
5967 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5968 yield = string_cat(yield, &size, &ptr, t, 1);
5973 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5974 prescribed by the RFC, if there are characters that need to be encoded */
5978 uschar buffer[2048];
5979 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5980 buffer, sizeof(buffer), FALSE);
5981 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5985 /* RFC 2047 decode */
5991 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5992 headers_charset, '?', &len, &error);
5995 expand_string_message = error;
5998 yield = string_cat(yield, &size, &ptr, decoded, len);
6002 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6012 if (c > 255) c = '_';
6014 yield = string_cat(yield, &size, &ptr, buff, 1);
6019 /* escape turns all non-printing characters into escape sequences. */
6023 uschar *t = string_printing(sub);
6024 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6028 /* Handle numeric expression evaluation */
6033 uschar *save_sub = sub;
6034 uschar *error = NULL;
6035 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6038 expand_string_message = string_sprintf("error in expression "
6039 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6043 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6044 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6048 /* Handle time period formating */
6052 int n = readconf_readtime(sub, 0, FALSE);
6055 expand_string_message = string_sprintf("string \"%s\" is not an "
6056 "Exim time interval in \"%s\" operator", sub, name);
6059 sprintf(CS var_buffer, "%d", n);
6060 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6064 case EOP_TIME_INTERVAL:
6067 uschar *t = read_number(&n, sub);
6068 if (*t != 0) /* Not A Number*/
6070 expand_string_message = string_sprintf("string \"%s\" is not a "
6071 "positive number in \"%s\" operator", sub, name);
6074 t = readconf_printtime(n);
6075 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6079 /* Convert string to base64 encoding */
6083 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6084 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6088 /* strlen returns the length of the string */
6093 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6094 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6098 /* length_n or l_n takes just the first n characters or the whole string,
6099 whichever is the shorter;
6101 substr_m_n, and s_m_n take n characters from offset m; negative m take
6102 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6103 takes the rest, either to the right or to the left.
6105 hash_n or h_n makes a hash of length n from the string, yielding n
6106 characters from the set a-z; hash_n_m makes a hash of length n, but
6107 uses m characters from the set a-zA-Z0-9.
6109 nhash_n returns a single number between 0 and n-1 (in text form), while
6110 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6111 between 0 and n-1 and the second between 0 and m-1. */
6131 expand_string_message = string_sprintf("missing values after %s",
6136 /* "length" has only one argument, effectively being synonymous with
6139 if (c == EOP_LENGTH || c == EOP_L)
6145 /* The others have one or two arguments; for "substr" the first may be
6146 negative. The second being negative means "not supplied". */
6151 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6154 /* Read up to two numbers, separated by underscores */
6159 if (arg != ret && *arg == '_' && pn == &value1)
6163 if (arg[1] != 0) arg++;
6165 else if (!isdigit(*arg))
6167 expand_string_message =
6168 string_sprintf("non-digit after underscore in \"%s\"", name);
6171 else *pn = (*pn)*10 + *arg++ - '0';
6175 /* Perform the required operation */
6178 (c == EOP_HASH || c == EOP_H)?
6179 compute_hash(sub, value1, value2, &len) :
6180 (c == EOP_NHASH || c == EOP_NH)?
6181 compute_nhash(sub, value1, value2, &len) :
6182 extract_substr(sub, value1, value2, &len);
6184 if (ret == NULL) goto EXPAND_FAILED;
6185 yield = string_cat(yield, &size, &ptr, ret, len);
6195 uschar **modetable[3];
6200 if ((expand_forbid & RDO_EXISTS) != 0)
6202 expand_string_message = US"Use of the stat() expansion is not permitted";
6206 if (stat(CS sub, &st) < 0)
6208 expand_string_message = string_sprintf("stat(%s) failed: %s",
6209 sub, strerror(errno));
6213 switch (mode & S_IFMT)
6215 case S_IFIFO: smode[0] = 'p'; break;
6216 case S_IFCHR: smode[0] = 'c'; break;
6217 case S_IFDIR: smode[0] = 'd'; break;
6218 case S_IFBLK: smode[0] = 'b'; break;
6219 case S_IFREG: smode[0] = '-'; break;
6220 default: smode[0] = '?'; break;
6223 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6224 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6225 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6227 for (i = 0; i < 3; i++)
6229 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6234 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6235 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6236 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6237 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6238 (long)st.st_gid, st.st_size, (long)st.st_atime,
6239 (long)st.st_mtime, (long)st.st_ctime);
6240 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6244 /* vaguely random number less than N */
6248 int_eximarith_t max;
6251 max = expand_string_integer(sub, TRUE);
6252 if (expand_string_message != NULL)
6254 s = string_sprintf("%d", vaguely_random_number((int)max));
6255 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6259 /* Reverse IP, including IPv6 to dotted-nibble */
6261 case EOP_REVERSE_IP:
6263 int family, maskptr;
6264 uschar reversed[128];
6266 family = string_is_ip_address(sub, &maskptr);
6269 expand_string_message = string_sprintf(
6270 "reverse_ip() not given an IP address [%s]", sub);
6273 invert_address(reversed, sub);
6274 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6278 /* Unknown operator */
6281 expand_string_message =
6282 string_sprintf("unknown expansion operator \"%s\"", name);
6287 /* Handle a plain name. If this is the first thing in the expansion, release
6288 the pre-allocated buffer. If the result data is known to be in a new buffer,
6289 newsize will be set to the size of that buffer, and we can just point at that
6290 store instead of copying. Many expansion strings contain just one reference,
6291 so this is a useful optimization, especially for humungous headers
6292 ($message_headers). */
6300 if (resetok) store_reset(yield);
6304 value = find_variable(name, FALSE, skipping, &newsize);
6307 expand_string_message =
6308 string_sprintf("unknown variable in \"${%s}\"", name);
6309 check_variable_error_message(name);
6312 len = Ustrlen(value);
6313 if (yield == NULL && newsize != 0)
6319 else yield = string_cat(yield, &size, &ptr, value, len);
6323 /* Else there's something wrong */
6325 expand_string_message =
6326 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6327 "in a variable reference)", name);
6331 /* If we hit the end of the string when ket_ends is set, there is a missing
6332 terminating brace. */
6334 if (ket_ends && *s == 0)
6336 expand_string_message = malformed_header?
6337 US"missing } at end of string - could be header name not terminated by colon"
6339 US"missing } at end of string";
6343 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6344 added to the string. If so, set up an empty string. Add a terminating zero. If
6345 left != NULL, return a pointer to the terminator. */
6347 if (yield == NULL) yield = store_get(1);
6349 if (left != NULL) *left = s;
6351 /* Any stacking store that was used above the final string is no longer needed.
6352 In many cases the final string will be the first one that was got and so there
6353 will be optimal store usage. */
6355 if (resetok) store_reset(yield + ptr + 1);
6358 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6360 if (skipping) debug_printf("skipping: result is not used\n");
6364 /* This is the failure exit: easiest to program with a goto. We still need
6365 to update the pointer to the terminator, for cases of nested calls with "fail".
6368 EXPAND_FAILED_CURLY:
6369 expand_string_message = malformed_header?
6370 US"missing or misplaced { or } - could be header name not terminated by colon"
6372 US"missing or misplaced { or }";
6374 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6375 that is a bad idea, because expand_string_message is in dynamic store. */
6378 if (left != NULL) *left = s;
6381 debug_printf("failed to expand: %s\n", string);
6382 debug_printf(" error message: %s\n", expand_string_message);
6383 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6389 /* This is the external function call. Do a quick check for any expansion
6390 metacharacters, and if there are none, just return the input string.
6392 Argument: the string to be expanded
6393 Returns: the expanded string, or NULL if expansion failed; if failure was
6394 due to a lookup deferring, search_find_defer will be TRUE
6398 expand_string(uschar *string)
6400 search_find_defer = FALSE;
6401 malformed_header = FALSE;
6402 return (Ustrpbrk(string, "$\\") == NULL)? string :
6403 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6408 /*************************************************
6410 *************************************************/
6412 /* Now and again we want to expand a string and be sure that the result is in a
6413 new bit of store. This function does that.
6415 Argument: the string to be expanded
6416 Returns: the expanded string, always in a new bit of store, or NULL
6420 expand_string_copy(uschar *string)
6422 uschar *yield = expand_string(string);
6423 if (yield == string) yield = string_copy(string);
6429 /*************************************************
6430 * Expand and interpret as an integer *
6431 *************************************************/
6433 /* Expand a string, and convert the result into an integer.
6436 string the string to be expanded
6437 isplus TRUE if a non-negative number is expected
6439 Returns: the integer value, or
6440 -1 for an expansion error ) in both cases, message in
6441 -2 for an integer interpretation error ) expand_string_message
6442 expand_string_message is set NULL for an OK integer
6446 expand_string_integer(uschar *string, BOOL isplus)
6448 int_eximarith_t value;
6449 uschar *s = expand_string(string);
6450 uschar *msg = US"invalid integer \"%s\"";
6453 /* If expansion failed, expand_string_message will be set. */
6455 if (s == NULL) return -1;
6457 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6458 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6459 systems, so we set it zero ourselves. */
6462 expand_string_message = NULL; /* Indicates no error */
6464 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6465 equal to 0. Unfortunately, people actually relied upon that, so preserve
6466 the behaviour explicitly. Stripping leading whitespace is a harmless
6467 noop change since strtol skips it anyway (provided that there is a number
6471 while (isspace(*s)) ++s;
6475 debug_printf("treating blank string as number 0\n");
6480 value = strtoll(CS s, CSS &endptr, 10);
6484 msg = US"integer expected but \"%s\" found";
6486 else if (value < 0 && isplus)
6488 msg = US"non-negative integer expected but \"%s\" found";
6492 switch (tolower(*endptr))
6497 if (value > LLONG_MAX/1024 || value < LLONG_MIN/1024) errno = ERANGE;
6502 if (value > LLONG_MAX/(1024*1024) || value < LLONG_MIN/(1024*1024)) errno = ERANGE;
6503 else value *= 1024*1024;
6507 if (value > LLONG_MAX/(1024*1024*1024) || value < LLONG_MIN/(1024*1024*1024)) errno = ERANGE;
6508 else value *= 1024*1024*1024;
6512 if (errno == ERANGE)
6513 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6516 while (isspace(*endptr)) endptr++;
6517 if (*endptr == 0) return (int)value;
6521 expand_string_message = string_sprintf(CS msg, s);
6526 /*************************************************
6527 **************************************************
6528 * Stand-alone test program *
6529 **************************************************
6530 *************************************************/
6536 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6538 int ovector[3*(EXPAND_MAXN+1)];
6539 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6540 ovector, sizeof(ovector)/sizeof(int));
6541 BOOL yield = n >= 0;
6542 if (n == 0) n = EXPAND_MAXN + 1;
6546 expand_nmax = (setup < 0)? 0 : setup + 1;
6547 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6549 expand_nstring[expand_nmax] = subject + ovector[nn];
6550 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6558 int main(int argc, uschar **argv)
6561 uschar buffer[1024];
6563 debug_selector = D_v;
6564 debug_file = stderr;
6565 debug_fd = fileno(debug_file);
6566 big_buffer = malloc(big_buffer_size);
6568 for (i = 1; i < argc; i++)
6570 if (argv[i][0] == '+')
6572 debug_trace_memory = 2;
6575 if (isdigit(argv[i][0]))
6576 debug_selector = Ustrtol(argv[i], NULL, 0);
6578 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6582 eldap_default_servers = argv[i];
6585 mysql_servers = argv[i];
6588 pgsql_servers = argv[i];
6592 else opt_perl_startup = argv[i];
6596 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6598 expand_nstring[1] = US"string 1....";
6599 expand_nlength[1] = 8;
6603 if (opt_perl_startup != NULL)
6606 printf("Starting Perl interpreter\n");
6607 errstr = init_perl(opt_perl_startup);
6610 printf("** error in perl_startup code: %s\n", errstr);
6611 return EXIT_FAILURE;
6614 #endif /* EXIM_PERL */
6616 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6618 void *reset_point = store_get(0);
6619 uschar *yield = expand_string(buffer);
6622 printf("%s\n", yield);
6623 store_reset(reset_point);
6627 if (search_find_defer) printf("search_find deferred\n");
6628 printf("Failed: %s\n", expand_string_message);
6629 if (expand_string_forcedfail) printf("Forced failure\n");
6641 /* End of expand.c */