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_recipients, /* extract recipients from recipients list */
371 /* (available only in system filters, ACLs, and */
373 vtype_todbsdin, /* value not used; generate BSD inbox tod */
374 vtype_tode, /* value not used; generate tod in epoch format */
375 vtype_todel, /* value not used; generate tod in epoch/usec format */
376 vtype_todf, /* value not used; generate full tod */
377 vtype_todl, /* value not used; generate log tod */
378 vtype_todlf, /* value not used; generate log file datestamp tod */
379 vtype_todzone, /* value not used; generate time zone only */
380 vtype_todzulu, /* value not used; generate zulu tod */
381 vtype_reply, /* value not used; get reply from headers */
382 vtype_pid, /* value not used; result is pid */
383 vtype_host_lookup, /* value not used; get host name */
384 vtype_load_avg, /* value not used; result is int from os_getloadavg */
385 vtype_pspace, /* partition space; value is T/F for spool/log */
386 vtype_pinodes /* partition inodes; value is T/F for spool/log */
388 ,vtype_dkim /* Lookup of value in DKIM signature */
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 { "home", vtype_stringptr, &deliver_home },
475 { "host", vtype_stringptr, &deliver_host },
476 { "host_address", vtype_stringptr, &deliver_host_address },
477 { "host_data", vtype_stringptr, &host_data },
478 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
479 { "host_lookup_failed", vtype_int, &host_lookup_failed },
480 { "inode", vtype_ino, &deliver_inode },
481 { "interface_address", vtype_stringptr, &interface_address },
482 { "interface_port", vtype_int, &interface_port },
483 { "item", vtype_stringptr, &iterate_item },
485 { "ldap_dn", vtype_stringptr, &eldap_dn },
487 { "load_average", vtype_load_avg, NULL },
488 { "local_part", vtype_stringptr, &deliver_localpart },
489 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
490 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
491 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
492 { "local_scan_data", vtype_stringptr, &local_scan_data },
493 { "local_user_gid", vtype_gid, &local_user_gid },
494 { "local_user_uid", vtype_uid, &local_user_uid },
495 { "localhost_number", vtype_int, &host_number },
496 { "log_inodes", vtype_pinodes, (void *)FALSE },
497 { "log_space", vtype_pspace, (void *)FALSE },
498 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
499 #ifdef WITH_CONTENT_SCAN
500 { "malware_name", vtype_stringptr, &malware_name },
502 { "max_received_linelength", vtype_int, &max_received_linelength },
503 { "message_age", vtype_int, &message_age },
504 { "message_body", vtype_msgbody, &message_body },
505 { "message_body_end", vtype_msgbody_end, &message_body_end },
506 { "message_body_size", vtype_int, &message_body_size },
507 { "message_exim_id", vtype_stringptr, &message_id },
508 { "message_headers", vtype_msgheaders, NULL },
509 { "message_headers_raw", vtype_msgheaders_raw, NULL },
510 { "message_id", vtype_stringptr, &message_id },
511 { "message_linecount", vtype_int, &message_linecount },
512 { "message_size", vtype_int, &message_size },
513 #ifdef WITH_CONTENT_SCAN
514 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
515 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
516 { "mime_boundary", vtype_stringptr, &mime_boundary },
517 { "mime_charset", vtype_stringptr, &mime_charset },
518 { "mime_content_description", vtype_stringptr, &mime_content_description },
519 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
520 { "mime_content_id", vtype_stringptr, &mime_content_id },
521 { "mime_content_size", vtype_int, &mime_content_size },
522 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
523 { "mime_content_type", vtype_stringptr, &mime_content_type },
524 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
525 { "mime_filename", vtype_stringptr, &mime_filename },
526 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
527 { "mime_is_multipart", vtype_int, &mime_is_multipart },
528 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
529 { "mime_part_count", vtype_int, &mime_part_count },
531 { "n0", vtype_filter_int, &filter_n[0] },
532 { "n1", vtype_filter_int, &filter_n[1] },
533 { "n2", vtype_filter_int, &filter_n[2] },
534 { "n3", vtype_filter_int, &filter_n[3] },
535 { "n4", vtype_filter_int, &filter_n[4] },
536 { "n5", vtype_filter_int, &filter_n[5] },
537 { "n6", vtype_filter_int, &filter_n[6] },
538 { "n7", vtype_filter_int, &filter_n[7] },
539 { "n8", vtype_filter_int, &filter_n[8] },
540 { "n9", vtype_filter_int, &filter_n[9] },
541 { "original_domain", vtype_stringptr, &deliver_domain_orig },
542 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
543 { "originator_gid", vtype_gid, &originator_gid },
544 { "originator_uid", vtype_uid, &originator_uid },
545 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
546 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
547 { "pid", vtype_pid, NULL },
548 { "primary_hostname", vtype_stringptr, &primary_hostname },
549 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
550 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
551 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
552 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
553 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
554 { "rcpt_count", vtype_int, &rcpt_count },
555 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
556 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
557 { "received_count", vtype_int, &received_count },
558 { "received_for", vtype_stringptr, &received_for },
559 { "received_ip_address", vtype_stringptr, &interface_address },
560 { "received_port", vtype_int, &interface_port },
561 { "received_protocol", vtype_stringptr, &received_protocol },
562 { "received_time", vtype_int, &received_time },
563 { "recipient_data", vtype_stringptr, &recipient_data },
564 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
565 { "recipients", vtype_recipients, NULL },
566 { "recipients_count", vtype_int, &recipients_count },
567 #ifdef WITH_CONTENT_SCAN
568 { "regex_match_string", vtype_stringptr, ®ex_match_string },
570 { "reply_address", vtype_reply, NULL },
571 { "return_path", vtype_stringptr, &return_path },
572 { "return_size_limit", vtype_int, &bounce_return_size_limit },
573 { "runrc", vtype_int, &runrc },
574 { "self_hostname", vtype_stringptr, &self_hostname },
575 { "sender_address", vtype_stringptr, &sender_address },
576 { "sender_address_data", vtype_stringptr, &sender_address_data },
577 { "sender_address_domain", vtype_domain, &sender_address },
578 { "sender_address_local_part", vtype_localpart, &sender_address },
579 { "sender_data", vtype_stringptr, &sender_data },
580 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
581 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
582 { "sender_host_address", vtype_stringptr, &sender_host_address },
583 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
584 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
585 { "sender_host_name", vtype_host_lookup, NULL },
586 { "sender_host_port", vtype_int, &sender_host_port },
587 { "sender_ident", vtype_stringptr, &sender_ident },
588 { "sender_rate", vtype_stringptr, &sender_rate },
589 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
590 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
591 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
592 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
593 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
594 { "sending_port", vtype_int, &sending_port },
595 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
596 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
597 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
598 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
599 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
600 { "sn0", vtype_filter_int, &filter_sn[0] },
601 { "sn1", vtype_filter_int, &filter_sn[1] },
602 { "sn2", vtype_filter_int, &filter_sn[2] },
603 { "sn3", vtype_filter_int, &filter_sn[3] },
604 { "sn4", vtype_filter_int, &filter_sn[4] },
605 { "sn5", vtype_filter_int, &filter_sn[5] },
606 { "sn6", vtype_filter_int, &filter_sn[6] },
607 { "sn7", vtype_filter_int, &filter_sn[7] },
608 { "sn8", vtype_filter_int, &filter_sn[8] },
609 { "sn9", vtype_filter_int, &filter_sn[9] },
610 #ifdef WITH_CONTENT_SCAN
611 { "spam_bar", vtype_stringptr, &spam_bar },
612 { "spam_report", vtype_stringptr, &spam_report },
613 { "spam_score", vtype_stringptr, &spam_score },
614 { "spam_score_int", vtype_stringptr, &spam_score_int },
616 #ifdef EXPERIMENTAL_SPF
617 { "spf_guess", vtype_stringptr, &spf_guess },
618 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
619 { "spf_received", vtype_stringptr, &spf_received },
620 { "spf_result", vtype_stringptr, &spf_result },
621 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
623 { "spool_directory", vtype_stringptr, &spool_directory },
624 { "spool_inodes", vtype_pinodes, (void *)TRUE },
625 { "spool_space", vtype_pspace, (void *)TRUE },
626 #ifdef EXPERIMENTAL_SRS
627 { "srs_db_address", vtype_stringptr, &srs_db_address },
628 { "srs_db_key", vtype_stringptr, &srs_db_key },
629 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
630 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
631 { "srs_recipient", vtype_stringptr, &srs_recipient },
632 { "srs_status", vtype_stringptr, &srs_status },
634 { "thisaddress", vtype_stringptr, &filter_thisaddress },
636 /* The non-(in,out) variables are now deprecated */
637 { "tls_bits", vtype_int, &tls_in.bits },
638 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
639 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
641 { "tls_in_bits", vtype_int, &tls_in.bits },
642 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
643 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
644 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
645 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
646 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
648 { "tls_out_bits", vtype_int, &tls_out.bits },
649 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
650 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
651 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
652 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
653 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
656 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
657 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
658 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
661 { "tod_bsdinbox", vtype_todbsdin, NULL },
662 { "tod_epoch", vtype_tode, NULL },
663 { "tod_epoch_l", vtype_todel, NULL },
664 { "tod_full", vtype_todf, NULL },
665 { "tod_log", vtype_todl, NULL },
666 { "tod_logfile", vtype_todlf, NULL },
667 { "tod_zone", vtype_todzone, NULL },
668 { "tod_zulu", vtype_todzulu, NULL },
669 { "value", vtype_stringptr, &lookup_value },
670 { "version_number", vtype_stringptr, &version_string },
671 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
672 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
673 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
674 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
675 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
676 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
679 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
680 static uschar var_buffer[256];
681 static BOOL malformed_header;
683 /* For textual hashes */
685 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
686 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
689 enum { HMAC_MD5, HMAC_SHA1 };
691 /* For numeric hashes */
693 static unsigned int prime[] = {
694 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
695 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
696 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
698 /* For printing modes in symbolic form */
700 static uschar *mtable_normal[] =
701 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
703 static uschar *mtable_setid[] =
704 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
706 static uschar *mtable_sticky[] =
707 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
711 /*************************************************
712 * Tables for UTF-8 support *
713 *************************************************/
715 /* Table of the number of extra characters, indexed by the first character
716 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
719 static uschar utf8_table1[] = {
720 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
721 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
722 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
723 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
725 /* These are the masks for the data bits in the first byte of a character,
726 indexed by the number of additional bytes. */
728 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
730 /* Get the next UTF-8 character, advancing the pointer. */
732 #define GETUTF8INC(c, ptr) \
734 if ((c & 0xc0) == 0xc0) \
736 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
738 c = (c & utf8_table2[a]) << s; \
742 c |= (*ptr++ & 0x3f) << s; \
747 /*************************************************
748 * Binary chop search on a table *
749 *************************************************/
751 /* This is used for matching expansion items and operators.
754 name the name that is being sought
755 table the table to search
756 table_size the number of items in the table
758 Returns: the offset in the table, or -1
762 chop_match(uschar *name, uschar **table, int table_size)
764 uschar **bot = table;
765 uschar **top = table + table_size;
769 uschar **mid = bot + (top - bot)/2;
770 int c = Ustrcmp(name, *mid);
771 if (c == 0) return mid - table;
772 if (c > 0) bot = mid + 1; else top = mid;
780 /*************************************************
781 * Check a condition string *
782 *************************************************/
784 /* This function is called to expand a string, and test the result for a "true"
785 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
786 forced fail or lookup defer. All store used by the function can be released on
789 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
792 condition the condition string
793 m1 text to be incorporated in panic error
796 Returns: TRUE if condition is met, FALSE if not
800 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
803 void *reset_point = store_get(0);
804 uschar *ss = expand_string(condition);
807 if (!expand_string_forcedfail && !search_find_defer)
808 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
809 "for %s %s: %s", condition, m1, m2, expand_string_message);
812 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
813 strcmpic(ss, US"false") != 0;
814 store_reset(reset_point);
821 /*************************************************
822 * Pseudo-random number generation *
823 *************************************************/
825 /* Pseudo-random number generation. The result is not "expected" to be
826 cryptographically strong but not so weak that someone will shoot themselves
827 in the foot using it as a nonce in some email header scheme or whatever
828 weirdness they'll twist this into. The result should ideally handle fork().
830 However, if we're stuck unable to provide this, then we'll fall back to
831 appallingly bad randomness.
833 If SUPPORT_TLS is defined then this will not be used except as an emergency
838 Returns a random number in range [0, max-1]
842 # define vaguely_random_number vaguely_random_number_fallback
845 vaguely_random_number(int max)
848 # undef vaguely_random_number
850 static pid_t pid = 0;
852 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
862 #ifdef HAVE_ARC4RANDOM
863 /* cryptographically strong randomness, common on *BSD platforms, not
864 so much elsewhere. Alas. */
866 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
867 #ifdef HAVE_SRANDOMDEV
868 /* uses random(4) for seeding */
871 gettimeofday(&tv, NULL);
872 srandom(tv.tv_sec | tv.tv_usec | getpid());
875 /* Poor randomness and no seeding here */
882 #ifdef HAVE_ARC4RANDOM
883 return arc4random() % max;
884 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
885 return random() % max;
887 /* This one returns a 16-bit number, definitely not crypto-strong */
888 return random_number(max);
895 /*************************************************
896 * Pick out a name from a string *
897 *************************************************/
899 /* If the name is too long, it is silently truncated.
902 name points to a buffer into which to put the name
903 max is the length of the buffer
904 s points to the first alphabetic character of the name
905 extras chars other than alphanumerics to permit
907 Returns: pointer to the first character after the name
909 Note: The test for *s != 0 in the while loop is necessary because
910 Ustrchr() yields non-NULL if the character is zero (which is not something
914 read_name(uschar *name, int max, uschar *s, uschar *extras)
917 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
919 if (ptr < max-1) name[ptr++] = *s;
928 /*************************************************
929 * Pick out the rest of a header name *
930 *************************************************/
932 /* A variable name starting $header_ (or just $h_ for those who like
933 abbreviations) might not be the complete header name because headers can
934 contain any printing characters in their names, except ':'. This function is
935 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
936 on the end, if the name was terminated by white space.
939 name points to a buffer in which the name read so far exists
940 max is the length of the buffer
941 s points to the first character after the name so far, i.e. the
942 first non-alphameric character after $header_xxxxx
944 Returns: a pointer to the first character after the header name
948 read_header_name(uschar *name, int max, uschar *s)
950 int prelen = Ustrchr(name, '_') - name + 1;
951 int ptr = Ustrlen(name) - prelen;
952 if (ptr > 0) memmove(name, name+prelen, ptr);
953 while (mac_isgraph(*s) && *s != ':')
955 if (ptr < max-1) name[ptr++] = *s;
966 /*************************************************
967 * Pick out a number from a string *
968 *************************************************/
971 n points to an integer into which to put the number
972 s points to the first digit of the number
974 Returns: a pointer to the character after the last digit
978 read_number(int *n, uschar *s)
981 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
987 /*************************************************
988 * Extract keyed subfield from a string *
989 *************************************************/
991 /* The yield is in dynamic store; NULL means that the key was not found.
994 key points to the name of the key
995 s points to the string from which to extract the subfield
997 Returns: NULL if the subfield was not found, or
998 a pointer to the subfield's data
1002 expand_getkeyed(uschar *key, uschar *s)
1004 int length = Ustrlen(key);
1005 while (isspace(*s)) s++;
1007 /* Loop to search for the key */
1015 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1016 dkeylength = s - dkey;
1017 while (isspace(*s)) s++;
1018 if (*s == '=') while (isspace((*(++s))));
1020 data = string_dequote(&s);
1021 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1024 while (isspace(*s)) s++;
1033 /*************************************************
1034 * Extract numbered subfield from string *
1035 *************************************************/
1037 /* Extracts a numbered field from a string that is divided by tokens - for
1038 example a line from /etc/passwd is divided by colon characters. First field is
1039 numbered one. Negative arguments count from the right. Zero returns the whole
1040 string. Returns NULL if there are insufficient tokens in the string
1043 Modifies final argument - this is a dynamically generated string, so that's OK.
1046 field number of field to be extracted,
1047 first field = 1, whole string = 0, last field = -1
1048 separators characters that are used to break string into tokens
1049 s points to the string from which to extract the subfield
1051 Returns: NULL if the field was not found,
1052 a pointer to the field's data inside s (modified to add 0)
1056 expand_gettokened (int field, uschar *separators, uschar *s)
1061 uschar *fieldtext = NULL;
1063 if (field == 0) return s;
1065 /* Break the line up into fields in place; for field > 0 we stop when we have
1066 done the number of fields we want. For field < 0 we continue till the end of
1067 the string, counting the number of fields. */
1069 count = (field > 0)? field : INT_MAX;
1075 /* Previous field was the last one in the string. For a positive field
1076 number, this means there are not enough fields. For a negative field number,
1077 check that there are enough, and scan back to find the one that is wanted. */
1081 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1082 if ((-field) == (INT_MAX - count - 1)) return s;
1086 while (ss[-1] != 0) ss--;
1092 /* Previous field was not last in the string; save its start and put a
1096 len = Ustrcspn(ss, separators);
1107 /*************************************************
1108 * Extract a substring from a string *
1109 *************************************************/
1111 /* Perform the ${substr or ${length expansion operations.
1114 subject the input string
1115 value1 the offset from the start of the input string to the start of
1116 the output string; if negative, count from the right.
1117 value2 the length of the output string, or negative (-1) for unset
1118 if value1 is positive, unset means "all after"
1119 if value1 is negative, unset means "all before"
1120 len set to the length of the returned string
1122 Returns: pointer to the output string, or NULL if there is an error
1126 extract_substr(uschar *subject, int value1, int value2, int *len)
1128 int sublen = Ustrlen(subject);
1130 if (value1 < 0) /* count from right */
1134 /* If the position is before the start, skip to the start, and adjust the
1135 length. If the length ends up negative, the substring is null because nothing
1136 can precede. This falls out naturally when the length is unset, meaning "all
1142 if (value2 < 0) value2 = 0;
1146 /* Otherwise an unset length => characters before value1 */
1148 else if (value2 < 0)
1155 /* For a non-negative offset, if the starting position is past the end of the
1156 string, the result will be the null string. Otherwise, an unset length means
1157 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1161 if (value1 > sublen)
1166 else if (value2 < 0) value2 = sublen;
1169 /* Cut the length down to the maximum possible for the offset value, and get
1170 the required characters. */
1172 if (value1 + value2 > sublen) value2 = sublen - value1;
1174 return subject + value1;
1180 /*************************************************
1181 * Old-style hash of a string *
1182 *************************************************/
1184 /* Perform the ${hash expansion operation.
1187 subject the input string (an expanded substring)
1188 value1 the length of the output string; if greater or equal to the
1189 length of the input string, the input string is returned
1190 value2 the number of hash characters to use, or 26 if negative
1191 len set to the length of the returned string
1193 Returns: pointer to the output string, or NULL if there is an error
1197 compute_hash(uschar *subject, int value1, int value2, int *len)
1199 int sublen = Ustrlen(subject);
1201 if (value2 < 0) value2 = 26;
1202 else if (value2 > Ustrlen(hashcodes))
1204 expand_string_message =
1205 string_sprintf("hash count \"%d\" too big", value2);
1209 /* Calculate the hash text. We know it is shorter than the original string, so
1210 can safely place it in subject[] (we know that subject is always itself an
1211 expanded substring). */
1213 if (value1 < sublen)
1218 while ((c = (subject[j])) != 0)
1220 int shift = (c + j++) & 7;
1221 subject[i] ^= (c << shift) | (c >> (8-shift));
1222 if (++i >= value1) i = 0;
1224 for (i = 0; i < value1; i++)
1225 subject[i] = hashcodes[(subject[i]) % value2];
1227 else value1 = sublen;
1236 /*************************************************
1237 * Numeric hash of a string *
1238 *************************************************/
1240 /* Perform the ${nhash expansion operation. The first characters of the
1241 string are treated as most important, and get the highest prime numbers.
1244 subject the input string
1245 value1 the maximum value of the first part of the result
1246 value2 the maximum value of the second part of the result,
1247 or negative to produce only a one-part result
1248 len set to the length of the returned string
1250 Returns: pointer to the output string, or NULL if there is an error.
1254 compute_nhash (uschar *subject, int value1, int value2, int *len)
1256 uschar *s = subject;
1258 unsigned long int total = 0; /* no overflow */
1262 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1263 total += prime[i--] * (unsigned int)(*s++);
1266 /* If value2 is unset, just compute one number */
1270 s = string_sprintf("%d", total % value1);
1273 /* Otherwise do a div/mod hash */
1277 total = total % (value1 * value2);
1278 s = string_sprintf("%d/%d", total/value2, total % value2);
1289 /*************************************************
1290 * Find the value of a header or headers *
1291 *************************************************/
1293 /* Multiple instances of the same header get concatenated, and this function
1294 can also return a concatenation of all the header lines. When concatenating
1295 specific headers that contain lists of addresses, a comma is inserted between
1296 them. Otherwise we use a straight concatenation. Because some messages can have
1297 pathologically large number of lines, there is a limit on the length that is
1298 returned. Also, to avoid massive store use which would result from using
1299 string_cat() as it copies and extends strings, we do a preliminary pass to find
1300 out exactly how much store will be needed. On "normal" messages this will be
1304 name the name of the header, without the leading $header_ or $h_,
1305 or NULL if a concatenation of all headers is required
1306 exists_only TRUE if called from a def: test; don't need to build a string;
1307 just return a string that is not "" and not "0" if the header
1309 newsize return the size of memory block that was obtained; may be NULL
1310 if exists_only is TRUE
1311 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1312 other than concatenating, will be done on the header. Also used
1313 for $message_headers_raw.
1314 charset name of charset to translate MIME words to; used only if
1315 want_raw is false; if NULL, no translation is done (this is
1316 used for $bh_ and $bheader_)
1318 Returns: NULL if the header does not exist, else a pointer to a new
1323 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1326 BOOL found = name == NULL;
1328 int len = found? 0 : Ustrlen(name);
1330 uschar *yield = NULL;
1333 /* Loop for two passes - saves code repetition */
1335 for (i = 0; i < 2; i++)
1340 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1342 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1344 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1349 if (exists_only) return US"1"; /* don't need actual string */
1351 t = h->text + len; /* text to insert */
1352 if (!want_raw) /* unless wanted raw, */
1353 while (isspace(*t)) t++; /* remove leading white space */
1354 ilen = h->slen - (t - h->text); /* length to insert */
1356 /* Unless wanted raw, remove trailing whitespace, including the
1360 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1362 /* Set comma = 1 if handling a single header and it's one of those
1363 that contains an address list, except when asked for raw headers. Only
1364 need to do this once. */
1366 if (!want_raw && name != NULL && comma == 0 &&
1367 Ustrchr("BCFRST", h->type) != NULL)
1370 /* First pass - compute total store needed; second pass - compute
1371 total store used, including this header. */
1373 size += ilen + comma + 1; /* +1 for the newline */
1375 /* Second pass - concatentate the data, up to a maximum. Note that
1376 the loop stops when size hits the limit. */
1380 if (size > header_insert_maxlen)
1382 ilen -= size - header_insert_maxlen - 1;
1385 Ustrncpy(ptr, t, ilen);
1388 /* For a non-raw header, put in the comma if needed, then add
1389 back the newline we removed above, provided there was some text in
1392 if (!want_raw && ilen > 0)
1394 if (comma != 0) *ptr++ = ',';
1402 /* At end of first pass, return NULL if no header found. Then truncate size
1403 if necessary, and get the buffer to hold the data, returning the buffer size.
1408 if (!found) return NULL;
1409 if (size > header_insert_maxlen) size = header_insert_maxlen;
1410 *newsize = size + 1;
1411 ptr = yield = store_get(*newsize);
1415 /* That's all we do for raw header expansion. */
1422 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1423 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1424 function can return an error with decoded data if the charset translation
1425 fails. If decoding fails, it returns NULL. */
1429 uschar *decoded, *error;
1430 if (ptr > yield && ptr[-1] == '\n') ptr--;
1431 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1433 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1437 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1438 " input was: %s\n", error, yield);
1440 if (decoded != NULL) yield = decoded;
1449 /*************************************************
1450 * Find value of a variable *
1451 *************************************************/
1453 /* The table of variables is kept in alphabetic order, so we can search it
1454 using a binary chop. The "choplen" variable is nothing to do with the binary
1458 name the name of the variable being sought
1459 exists_only TRUE if this is a def: test; passed on to find_header()
1460 skipping TRUE => skip any processing evaluation; this is not the same as
1461 exists_only because def: may test for values that are first
1463 newsize pointer to an int which is initially zero; if the answer is in
1464 a new memory buffer, *newsize is set to its size
1466 Returns: NULL if the variable does not exist, or
1467 a pointer to the variable's contents, or
1468 something non-NULL if exists_only is TRUE
1472 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1475 int last = var_table_size;
1477 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1478 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1479 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1480 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1481 (this gave backwards compatibility at the changeover). There may be built-in
1482 variables whose names start acl_ but they should never start in this way. This
1483 slightly messy specification is a consequence of the history, needless to say.
1485 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1486 set, in which case give an error. */
1488 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1492 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1493 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1496 /* Handle $auth<n> variables. */
1498 if (Ustrncmp(name, "auth", 4) == 0)
1501 int n = Ustrtoul(name + 4, &endptr, 10);
1502 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1503 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1506 /* For all other variables, search the table */
1508 while (last > first)
1512 int middle = (first + last)/2;
1513 int c = Ustrcmp(name, var_table[middle].name);
1515 if (c > 0) { first = middle + 1; continue; }
1516 if (c < 0) { last = middle; continue; }
1518 /* Found an existing variable. If in skipping state, the value isn't needed,
1519 and we want to avoid processing (such as looking up the host name). */
1521 if (skipping) return US"";
1523 switch (var_table[middle].type)
1525 case vtype_filter_int:
1526 if (!filter_running) return NULL;
1530 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1534 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1538 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1542 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1546 sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1549 case vtype_stringptr: /* Pointer to string */
1550 s = *((uschar **)(var_table[middle].value));
1551 return (s == NULL)? US"" : s;
1554 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1557 case vtype_load_avg:
1558 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1561 case vtype_host_lookup: /* Lookup if not done so */
1562 if (sender_host_name == NULL && sender_host_address != NULL &&
1563 !host_lookup_failed && host_name_lookup() == OK)
1564 host_build_sender_fullhost();
1565 return (sender_host_name == NULL)? US"" : sender_host_name;
1567 case vtype_localpart: /* Get local part from address */
1568 s = *((uschar **)(var_table[middle].value));
1569 if (s == NULL) return US"";
1570 domain = Ustrrchr(s, '@');
1571 if (domain == NULL) return s;
1572 if (domain - s > sizeof(var_buffer) - 1)
1573 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1574 " in string expansion", sizeof(var_buffer));
1575 Ustrncpy(var_buffer, s, domain - s);
1576 var_buffer[domain - s] = 0;
1579 case vtype_domain: /* Get domain from address */
1580 s = *((uschar **)(var_table[middle].value));
1581 if (s == NULL) return US"";
1582 domain = Ustrrchr(s, '@');
1583 return (domain == NULL)? US"" : domain + 1;
1585 case vtype_msgheaders:
1586 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1588 case vtype_msgheaders_raw:
1589 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1591 case vtype_msgbody: /* Pointer to msgbody string */
1592 case vtype_msgbody_end: /* Ditto, the end of the msg */
1593 ss = (uschar **)(var_table[middle].value);
1594 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1597 off_t start_offset = SPOOL_DATA_START_OFFSET;
1598 int len = message_body_visible;
1599 if (len > message_size) len = message_size;
1600 *ss = body = store_malloc(len+1);
1602 if (var_table[middle].type == vtype_msgbody_end)
1604 struct stat statbuf;
1605 if (fstat(deliver_datafile, &statbuf) == 0)
1607 start_offset = statbuf.st_size - len;
1608 if (start_offset < SPOOL_DATA_START_OFFSET)
1609 start_offset = SPOOL_DATA_START_OFFSET;
1612 lseek(deliver_datafile, start_offset, SEEK_SET);
1613 len = read(deliver_datafile, body, len);
1617 if (message_body_newlines) /* Separate loops for efficiency */
1620 { if (body[--len] == 0) body[len] = ' '; }
1625 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1629 return (*ss == NULL)? US"" : *ss;
1631 case vtype_todbsdin: /* BSD inbox time of day */
1632 return tod_stamp(tod_bsdin);
1634 case vtype_tode: /* Unix epoch time of day */
1635 return tod_stamp(tod_epoch);
1637 case vtype_todel: /* Unix epoch/usec time of day */
1638 return tod_stamp(tod_epoch_l);
1640 case vtype_todf: /* Full time of day */
1641 return tod_stamp(tod_full);
1643 case vtype_todl: /* Log format time of day */
1644 return tod_stamp(tod_log_bare); /* (without timezone) */
1646 case vtype_todzone: /* Time zone offset only */
1647 return tod_stamp(tod_zone);
1649 case vtype_todzulu: /* Zulu time */
1650 return tod_stamp(tod_zulu);
1652 case vtype_todlf: /* Log file datestamp tod */
1653 return tod_stamp(tod_log_datestamp_daily);
1655 case vtype_reply: /* Get reply address */
1656 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1658 if (s != NULL) while (isspace(*s)) s++;
1659 if (s == NULL || *s == 0)
1661 *newsize = 0; /* For the *s==0 case */
1662 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1667 while (isspace(*s)) s++;
1668 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1669 while (t > s && isspace(t[-1])) t--;
1672 return (s == NULL)? US"" : s;
1674 /* A recipients list is available only during system message filtering,
1675 during ACL processing after DATA, and while expanding pipe commands
1676 generated from a system filter, but not elsewhere. */
1678 case vtype_recipients:
1679 if (!enable_dollar_recipients) return NULL; else
1684 s = store_get(size);
1685 for (i = 0; i < recipients_count; i++)
1687 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1688 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1689 Ustrlen(recipients_list[i].address));
1691 s[ptr] = 0; /* string_cat() leaves room */
1698 sprintf(CS var_buffer, "%d",
1699 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1706 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1707 sprintf(CS var_buffer, "%d", inodes);
1711 #ifndef DISABLE_DKIM
1713 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1719 return NULL; /* Unknown variable name */
1726 modify_variable(uschar *name, void * value)
1729 int last = var_table_size;
1731 while (last > first)
1733 int middle = (first + last)/2;
1734 int c = Ustrcmp(name, var_table[middle].name);
1736 if (c > 0) { first = middle + 1; continue; }
1737 if (c < 0) { last = middle; continue; }
1739 /* Found an existing variable; change the item it refers to */
1740 var_table[middle].value = value;
1743 return; /* Unknown variable name, fail silently */
1750 /*************************************************
1751 * Read and expand substrings *
1752 *************************************************/
1754 /* This function is called to read and expand argument substrings for various
1755 expansion items. Some have a minimum requirement that is less than the maximum;
1756 in these cases, the first non-present one is set to NULL.
1759 sub points to vector of pointers to set
1760 n maximum number of substrings
1762 sptr points to current string pointer
1763 skipping the skipping flag
1764 check_end if TRUE, check for final '}'
1765 name name of item, for error message
1767 Returns: 0 OK; string pointer updated
1768 1 curly bracketing error (too few arguments)
1769 2 too many arguments (only if check_end is set); message set
1770 3 other error (expansion failure)
1774 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1775 BOOL check_end, uschar *name)
1780 while (isspace(*s)) s++;
1781 for (i = 0; i < n; i++)
1785 if (i < m) return 1;
1789 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1790 if (sub[i] == NULL) return 3;
1791 if (*s++ != '}') return 1;
1792 while (isspace(*s)) s++;
1794 if (check_end && *s++ != '}')
1798 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1799 "(max is %d)", name, n);
1812 /*************************************************
1813 * Elaborate message for bad variable *
1814 *************************************************/
1816 /* For the "unknown variable" message, take a look at the variable's name, and
1817 give additional information about possible ACL variables. The extra information
1818 is added on to expand_string_message.
1820 Argument: the name of the variable
1825 check_variable_error_message(uschar *name)
1827 if (Ustrncmp(name, "acl_", 4) == 0)
1828 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1829 (name[4] == 'c' || name[4] == 'm')?
1831 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1832 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1834 US"user-defined ACL variables must start acl_c or acl_m");
1839 /*************************************************
1840 * Read and evaluate a condition *
1841 *************************************************/
1845 s points to the start of the condition text
1846 yield points to a BOOL to hold the result of the condition test;
1847 if NULL, we are just reading through a condition that is
1848 part of an "or" combination to check syntax, or in a state
1849 where the answer isn't required
1851 Returns: a pointer to the first character after the condition, or
1856 eval_condition(uschar *s, BOOL *yield)
1858 BOOL testfor = TRUE;
1859 BOOL tempcond, combined_cond;
1861 BOOL sub2_honour_dollar = TRUE;
1862 int i, rc, cond_type, roffset;
1863 int_eximarith_t num[2];
1864 struct stat statbuf;
1869 const uschar *rerror;
1873 while (isspace(*s)) s++;
1874 if (*s == '!') { testfor = !testfor; s++; } else break;
1877 /* Numeric comparisons are symbolic */
1879 if (*s == '=' || *s == '>' || *s == '<')
1891 /* All other conditions are named */
1893 else s = read_name(name, 256, s, US"_");
1895 /* If we haven't read a name, it means some non-alpha character is first. */
1899 expand_string_message = string_sprintf("condition name expected, "
1900 "but found \"%.16s\"", s);
1904 /* Find which condition we are dealing with, and switch on it */
1906 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1909 /* def: tests for a non-empty variable, or for the existence of a header. If
1910 yield == NULL we are in a skipping state, and don't care about the answer. */
1915 expand_string_message = US"\":\" expected after \"def\"";
1919 s = read_name(name, 256, s+1, US"_");
1921 /* Test for a header's existence. If the name contains a closing brace
1922 character, this may be a user error where the terminating colon has been
1923 omitted. Set a flag to adjust a subsequent error message in this case. */
1925 if (Ustrncmp(name, "h_", 2) == 0 ||
1926 Ustrncmp(name, "rh_", 3) == 0 ||
1927 Ustrncmp(name, "bh_", 3) == 0 ||
1928 Ustrncmp(name, "header_", 7) == 0 ||
1929 Ustrncmp(name, "rheader_", 8) == 0 ||
1930 Ustrncmp(name, "bheader_", 8) == 0)
1932 s = read_header_name(name, 256, s);
1933 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1934 if (yield != NULL) *yield =
1935 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1938 /* Test for a variable's having a non-empty value. A non-existent variable
1939 causes an expansion failure. */
1943 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1946 expand_string_message = (name[0] == 0)?
1947 string_sprintf("variable name omitted after \"def:\"") :
1948 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1949 check_variable_error_message(name);
1952 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1958 /* first_delivery tests for first delivery attempt */
1960 case ECOND_FIRST_DELIVERY:
1961 if (yield != NULL) *yield = deliver_firsttime == testfor;
1965 /* queue_running tests for any process started by a queue runner */
1967 case ECOND_QUEUE_RUNNING:
1968 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1972 /* exists: tests for file existence
1973 isip: tests for any IP address
1974 isip4: tests for an IPv4 address
1975 isip6: tests for an IPv6 address
1976 pam: does PAM authentication
1977 radius: does RADIUS authentication
1978 ldapauth: does LDAP authentication
1979 pwcheck: does Cyrus SASL pwcheck authentication
1988 case ECOND_LDAPAUTH:
1991 while (isspace(*s)) s++;
1992 if (*s != '{') goto COND_FAILED_CURLY_START;
1994 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
1995 if (sub[0] == NULL) return NULL;
1996 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1998 if (yield == NULL) return s; /* No need to run the test if skipping */
2003 if ((expand_forbid & RDO_EXISTS) != 0)
2005 expand_string_message = US"File existence tests are not permitted";
2008 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2014 rc = string_is_ip_address(sub[0], NULL);
2015 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2016 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2019 /* Various authentication tests - all optionally compiled */
2023 rc = auth_call_pam(sub[0], &expand_string_message);
2026 goto COND_FAILED_NOT_COMPILED;
2027 #endif /* SUPPORT_PAM */
2030 #ifdef RADIUS_CONFIG_FILE
2031 rc = auth_call_radius(sub[0], &expand_string_message);
2034 goto COND_FAILED_NOT_COMPILED;
2035 #endif /* RADIUS_CONFIG_FILE */
2037 case ECOND_LDAPAUTH:
2040 /* Just to keep the interface the same */
2042 int old_pool = store_pool;
2043 store_pool = POOL_SEARCH;
2044 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2045 &expand_string_message, &do_cache);
2046 store_pool = old_pool;
2050 goto COND_FAILED_NOT_COMPILED;
2051 #endif /* LOOKUP_LDAP */
2054 #ifdef CYRUS_PWCHECK_SOCKET
2055 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2058 goto COND_FAILED_NOT_COMPILED;
2059 #endif /* CYRUS_PWCHECK_SOCKET */
2061 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2062 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2064 if (rc == ERROR || rc == DEFER) return NULL;
2065 *yield = (rc == OK) == testfor;
2071 /* call ACL (in a conditional context). Accept true, deny false.
2072 Defer is a forced-fail. Anything set by message= goes to $value.
2073 See also the expansion-item version EITEM_ACL. */
2076 /* ${if acl {name arg1 arg2...} {yes}{no}}
2084 while (isspace(*s)) s++;
2085 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2086 if (!(nameargs = expand_string_internal(s, TRUE, &s, FALSE, FALSE)) return NULL;
2087 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2089 switch(acl_check_args(ACL_WHERE_EXPANSION, NULL, nameargs, &user_msg, &log_msg))
2095 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2096 if (yield != NULL) *yield = cond;
2100 expand_string_forcedfail = TRUE;
2102 expand_string_message = string_sprintf("error from acl \"%s\"", nameargs);
2109 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2111 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
2113 However, the last two are optional. That is why the whole set is enclosed
2114 in their own set of braces. */
2116 case ECOND_SASLAUTHD:
2117 #ifndef CYRUS_SASLAUTHD_SOCKET
2118 goto COND_FAILED_NOT_COMPILED;
2120 while (isspace(*s)) s++;
2121 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2122 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2124 case 1: expand_string_message = US"too few arguments or bracketing "
2125 "error for saslauthd";
2127 case 3: return NULL;
2129 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2133 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2134 &expand_string_message);
2135 if (rc == ERROR || rc == DEFER) return NULL;
2136 *yield = (rc == OK) == testfor;
2139 #endif /* CYRUS_SASLAUTHD_SOCKET */
2142 /* symbolic operators for numeric and string comparison, and a number of
2143 other operators, all requiring two arguments.
2145 crypteq: encrypts plaintext and compares against an encrypted text,
2146 using crypt(), crypt16(), MD5 or SHA-1
2147 inlist/inlisti: checks if first argument is in the list of the second
2148 match: does a regular expression match and sets up the numerical
2149 variables if it succeeds
2150 match_address: matches in an address list
2151 match_domain: matches in a domain list
2152 match_ip: matches a host list that is restricted to IP addresses
2153 match_local_part: matches in a local part list
2156 case ECOND_MATCH_ADDRESS:
2157 case ECOND_MATCH_DOMAIN:
2158 case ECOND_MATCH_IP:
2159 case ECOND_MATCH_LOCAL_PART:
2160 #ifndef EXPAND_LISTMATCH_RHS
2161 sub2_honour_dollar = FALSE;
2170 case ECOND_NUM_L: /* Numerical comparisons */
2177 case ECOND_STR_LT: /* String comparisons */
2188 for (i = 0; i < 2; i++)
2190 /* Sometimes, we don't expand substrings; too many insecure configurations
2191 created using match_address{}{} and friends, where the second param
2192 includes information from untrustworthy sources. */
2193 BOOL honour_dollar = TRUE;
2194 if ((i > 0) && !sub2_honour_dollar)
2195 honour_dollar = FALSE;
2197 while (isspace(*s)) s++;
2200 if (i == 0) goto COND_FAILED_CURLY_START;
2201 expand_string_message = string_sprintf("missing 2nd string in {} "
2202 "after \"%s\"", name);
2205 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2207 if (sub[i] == NULL) return NULL;
2208 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2210 /* Convert to numerical if required; we know that the names of all the
2211 conditions that compare numbers do not start with a letter. This just saves
2212 checking for them individually. */
2214 if (!isalpha(name[0]) && yield != NULL)
2220 debug_printf("empty string cast to zero for numerical comparison\n");
2224 num[i] = expand_string_integer(sub[i], FALSE);
2225 if (expand_string_message != NULL) return NULL;
2230 /* Result not required */
2232 if (yield == NULL) return s;
2234 /* Do an appropriate comparison */
2240 *yield = (num[0] == num[1]) == testfor;
2244 *yield = (num[0] > num[1]) == testfor;
2248 *yield = (num[0] >= num[1]) == testfor;
2252 *yield = (num[0] < num[1]) == testfor;
2256 *yield = (num[0] <= num[1]) == testfor;
2260 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2264 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2268 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2272 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2276 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2280 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2284 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2288 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2292 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2296 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2299 case ECOND_MATCH: /* Regular expression match */
2300 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2304 expand_string_message = string_sprintf("regular expression error in "
2305 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2308 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2311 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2312 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2313 goto MATCHED_SOMETHING;
2315 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2316 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2317 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2318 goto MATCHED_SOMETHING;
2320 case ECOND_MATCH_IP: /* Match IP address in a host list */
2321 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2323 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2329 unsigned int *nullcache = NULL;
2330 check_host_block cb;
2332 cb.host_name = US"";
2333 cb.host_address = sub[0];
2335 /* If the host address starts off ::ffff: it is an IPv6 address in
2336 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2339 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2340 cb.host_address + 7 : cb.host_address;
2342 rc = match_check_list(
2343 &sub[1], /* the list */
2344 0, /* separator character */
2345 &hostlist_anchor, /* anchor pointer */
2346 &nullcache, /* cache pointer */
2347 check_host, /* function for testing */
2348 &cb, /* argument for function */
2349 MCL_HOST, /* type of check */
2350 sub[0], /* text for debugging */
2351 NULL); /* where to pass back data */
2353 goto MATCHED_SOMETHING;
2355 case ECOND_MATCH_LOCAL_PART:
2356 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2357 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2372 expand_string_message = string_sprintf("unable to complete match "
2373 "against \"%s\": %s", sub[1], search_error_message);
2379 /* Various "encrypted" comparisons. If the second string starts with
2380 "{" then an encryption type is given. Default to crypt() or crypt16()
2381 (build-time choice). */
2384 #ifndef SUPPORT_CRYPTEQ
2385 goto COND_FAILED_NOT_COMPILED;
2387 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2389 int sublen = Ustrlen(sub[1]+5);
2394 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2396 /* If the length that we are comparing against is 24, the MD5 digest
2397 is expressed as a base64 string. This is the way LDAP does it. However,
2398 some other software uses a straightforward hex representation. We assume
2399 this if the length is 32. Other lengths fail. */
2403 uschar *coded = auth_b64encode((uschar *)digest, 16);
2404 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2405 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2406 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2408 else if (sublen == 32)
2412 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2414 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2415 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2416 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2420 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2421 "fail\n crypted=%s\n", sub[1]+5);
2426 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2428 int sublen = Ustrlen(sub[1]+6);
2433 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2435 /* If the length that we are comparing against is 28, assume the SHA1
2436 digest is expressed as a base64 string. If the length is 40, assume a
2437 straightforward hex representation. Other lengths fail. */
2441 uschar *coded = auth_b64encode((uschar *)digest, 20);
2442 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2443 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2444 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2446 else if (sublen == 40)
2450 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2452 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2453 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2454 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2458 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2459 "fail\n crypted=%s\n", sub[1]+6);
2464 else /* {crypt} or {crypt16} and non-{ at start */
2465 /* }-for-text-editors */
2470 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2475 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2480 else if (sub[1][0] == '{')
2482 expand_string_message = string_sprintf("unknown encryption mechanism "
2483 "in \"%s\"", sub[1]);
2489 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2490 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2491 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2495 #define XSTR(s) STR(s)
2496 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2497 " subject=%s\n crypted=%s\n",
2498 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2503 /* If the encrypted string contains fewer than two characters (for the
2504 salt), force failure. Otherwise we get false positives: with an empty
2505 string the yield of crypt() is an empty string! */
2507 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2508 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2511 #endif /* SUPPORT_CRYPTEQ */
2518 uschar *save_iterate_item = iterate_item;
2519 int (*compare)(const uschar *, const uschar *);
2521 if (cond_type == ECOND_INLISTI)
2524 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2526 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2527 if (compare(sub[0], iterate_item) == 0)
2532 iterate_item = save_iterate_item;
2536 } /* Switch for comparison conditions */
2538 return s; /* End of comparison conditions */
2541 /* and/or: computes logical and/or of several conditions */
2545 subcondptr = (yield == NULL)? NULL : &tempcond;
2546 combined_cond = (cond_type == ECOND_AND);
2548 while (isspace(*s)) s++;
2549 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2553 while (isspace(*s)) s++;
2554 if (*s == '}') break;
2557 expand_string_message = string_sprintf("each subcondition "
2558 "inside an \"%s{...}\" condition must be in its own {}", name);
2562 s = eval_condition(s+1, subcondptr);
2565 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2566 expand_string_message, name);
2569 while (isspace(*s)) s++;
2573 expand_string_message = string_sprintf("missing } at end of condition "
2574 "inside \"%s\" group", name);
2580 if (cond_type == ECOND_AND)
2582 combined_cond &= tempcond;
2583 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2584 } /* evaluate any more */
2587 combined_cond |= tempcond;
2588 if (combined_cond) subcondptr = NULL; /* once true, don't */
2589 } /* evaluate any more */
2593 if (yield != NULL) *yield = (combined_cond == testfor);
2597 /* forall/forany: iterates a condition with different values */
2603 uschar *save_iterate_item = iterate_item;
2605 while (isspace(*s)) s++;
2606 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2607 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2608 if (sub[0] == NULL) return NULL;
2609 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2611 while (isspace(*s)) s++;
2612 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2616 /* Call eval_condition once, with result discarded (as if scanning a
2617 "false" part). This allows us to find the end of the condition, because if
2618 the list it empty, we won't actually evaluate the condition for real. */
2620 s = eval_condition(sub[1], NULL);
2623 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2624 expand_string_message, name);
2627 while (isspace(*s)) s++;
2631 expand_string_message = string_sprintf("missing } at end of condition "
2632 "inside \"%s\"", name);
2636 if (yield != NULL) *yield = !testfor;
2637 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2639 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2640 if (eval_condition(sub[1], &tempcond) == NULL)
2642 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2643 expand_string_message, name);
2644 iterate_item = save_iterate_item;
2647 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2648 tempcond? "true":"false");
2650 if (yield != NULL) *yield = (tempcond == testfor);
2651 if (tempcond == (cond_type == ECOND_FORANY)) break;
2654 iterate_item = save_iterate_item;
2659 /* The bool{} expansion condition maps a string to boolean.
2660 The values supported should match those supported by the ACL condition
2661 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2662 of true/false. Note that Router "condition" rules have a different
2663 interpretation, where general data can be used and only a few values
2665 Note that readconf.c boolean matching, for boolean configuration options,
2666 only matches true/yes/false/no.
2667 The bool_lax{} condition matches the Router logic, which is much more
2670 case ECOND_BOOL_LAX:
2676 BOOL boolvalue = FALSE;
2677 while (isspace(*s)) s++;
2678 if (*s != '{') goto COND_FAILED_CURLY_START;
2679 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2680 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2682 case 1: expand_string_message = string_sprintf(
2683 "too few arguments or bracketing error for %s",
2687 case 3: return NULL;
2690 while (isspace(*t)) t++;
2694 /* trailing whitespace: seems like a good idea to ignore it too */
2696 while (isspace(*t2)) t2--;
2697 if (t2 != (t + len))
2704 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2705 /* logic for the lax case from expand_check_condition(), which also does
2706 expands, and the logic is both short and stable enough that there should
2707 be no maintenance burden from replicating it. */
2710 else if (Ustrspn(t, "0123456789") == len)
2712 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2713 /* expand_check_condition only does a literal string "0" check */
2714 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2717 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2719 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2721 else if (cond_type == ECOND_BOOL_LAX)
2725 expand_string_message = string_sprintf("unrecognised boolean "
2729 if (yield != NULL) *yield = (boolvalue == testfor);
2733 /* Unknown condition */
2736 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2738 } /* End switch on condition type */
2740 /* Missing braces at start and end of data */
2742 COND_FAILED_CURLY_START:
2743 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2746 COND_FAILED_CURLY_END:
2747 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2751 /* A condition requires code that is not compiled */
2753 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2754 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2755 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2756 COND_FAILED_NOT_COMPILED:
2757 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2766 /*************************************************
2767 * Save numerical variables *
2768 *************************************************/
2770 /* This function is called from items such as "if" that want to preserve and
2771 restore the numbered variables.
2774 save_expand_string points to an array of pointers to set
2775 save_expand_nlength points to an array of ints for the lengths
2777 Returns: the value of expand max to save
2781 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2784 for (i = 0; i <= expand_nmax; i++)
2786 save_expand_nstring[i] = expand_nstring[i];
2787 save_expand_nlength[i] = expand_nlength[i];
2794 /*************************************************
2795 * Restore numerical variables *
2796 *************************************************/
2798 /* This function restored saved values of numerical strings.
2801 save_expand_nmax the number of strings to restore
2802 save_expand_string points to an array of pointers
2803 save_expand_nlength points to an array of ints
2809 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2810 int *save_expand_nlength)
2813 expand_nmax = save_expand_nmax;
2814 for (i = 0; i <= expand_nmax; i++)
2816 expand_nstring[i] = save_expand_nstring[i];
2817 expand_nlength[i] = save_expand_nlength[i];
2825 /*************************************************
2826 * Handle yes/no substrings *
2827 *************************************************/
2829 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2830 alternative substrings that depend on whether or not the condition was true,
2831 or the lookup or extraction succeeded. The substrings always have to be
2832 expanded, to check their syntax, but "skipping" is set when the result is not
2833 needed - this avoids unnecessary nested lookups.
2836 skipping TRUE if we were skipping when this item was reached
2837 yes TRUE if the first string is to be used, else use the second
2838 save_lookup a value to put back into lookup_value before the 2nd expansion
2839 sptr points to the input string pointer
2840 yieldptr points to the output string pointer
2841 sizeptr points to the output string size
2842 ptrptr points to the output string pointer
2843 type "lookup" or "if" or "extract" or "run", for error message
2845 Returns: 0 OK; lookup_value has been reset to save_lookup
2847 2 expansion failed because of bracketing error
2851 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2852 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2855 uschar *s = *sptr; /* Local value */
2856 uschar *sub1, *sub2;
2858 /* If there are no following strings, we substitute the contents of $value for
2859 lookups and for extractions in the success case. For the ${if item, the string
2860 "true" is substituted. In the fail case, nothing is substituted for all three
2863 while (isspace(*s)) s++;
2868 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2872 if (yes && lookup_value != NULL)
2873 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2874 Ustrlen(lookup_value));
2875 lookup_value = save_lookup;
2881 /* The first following string must be braced. */
2883 if (*s++ != '{') goto FAILED_CURLY;
2885 /* Expand the first substring. Forced failures are noticed only if we actually
2886 want this string. Set skipping in the call in the fail case (this will always
2887 be the case if we were already skipping). */
2889 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
2890 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2891 expand_string_forcedfail = FALSE;
2892 if (*s++ != '}') goto FAILED_CURLY;
2894 /* If we want the first string, add it to the output */
2897 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2899 /* If this is called from a lookup or an extract, we want to restore $value to
2900 what it was at the start of the item, so that it has this value during the
2901 second string expansion. For the call from "if" or "run" to this function,
2902 save_lookup is set to lookup_value, so that this statement does nothing. */
2904 lookup_value = save_lookup;
2906 /* There now follows either another substring, or "fail", or nothing. This
2907 time, forced failures are noticed only if we want the second string. We must
2908 set skipping in the nested call if we don't want this string, or if we were
2909 already skipping. */
2911 while (isspace(*s)) s++;
2914 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
2915 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2916 expand_string_forcedfail = FALSE;
2917 if (*s++ != '}') goto FAILED_CURLY;
2919 /* If we want the second string, add it to the output */
2922 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2925 /* If there is no second string, but the word "fail" is present when the use of
2926 the second string is wanted, set a flag indicating it was a forced failure
2927 rather than a syntactic error. Swallow the terminating } in case this is nested
2928 inside another lookup or if or extract. */
2933 s = read_name(name, sizeof(name), s, US"_");
2934 if (Ustrcmp(name, "fail") == 0)
2936 if (!yes && !skipping)
2938 while (isspace(*s)) s++;
2939 if (*s++ != '}') goto FAILED_CURLY;
2940 expand_string_message =
2941 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2942 expand_string_forcedfail = TRUE;
2948 expand_string_message =
2949 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2954 /* All we have to do now is to check on the final closing brace. */
2956 while (isspace(*s)) s++;
2957 if (*s++ == '}') goto RETURN;
2959 /* Get here if there is a bracketing failure */
2964 /* Get here for other failures */
2969 /* Update the input pointer value before returning */
2979 /*************************************************
2980 * Handle MD5 or SHA-1 computation for HMAC *
2981 *************************************************/
2983 /* These are some wrapping functions that enable the HMAC code to be a bit
2984 cleaner. A good compiler will spot the tail recursion.
2987 type HMAC_MD5 or HMAC_SHA1
2988 remaining are as for the cryptographic hash functions
2994 chash_start(int type, void *base)
2996 if (type == HMAC_MD5)
2997 md5_start((md5 *)base);
2999 sha1_start((sha1 *)base);
3003 chash_mid(int type, void *base, uschar *string)
3005 if (type == HMAC_MD5)
3006 md5_mid((md5 *)base, string);
3008 sha1_mid((sha1 *)base, string);
3012 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3014 if (type == HMAC_MD5)
3015 md5_end((md5 *)base, string, length, digest);
3017 sha1_end((sha1 *)base, string, length, digest);
3024 /********************************************************
3025 * prvs: Get last three digits of days since Jan 1, 1970 *
3026 ********************************************************/
3028 /* This is needed to implement the "prvs" BATV reverse
3031 Argument: integer "days" offset to add or substract to
3032 or from the current number of days.
3034 Returns: pointer to string containing the last three
3035 digits of the number of days since Jan 1, 1970,
3036 modified by the offset argument, NULL if there
3037 was an error in the conversion.
3042 prvs_daystamp(int day_offset)
3044 uschar *days = store_get(32); /* Need at least 24 for cases */
3045 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3046 (time(NULL) + day_offset*86400)/86400);
3047 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3052 /********************************************************
3053 * prvs: perform HMAC-SHA1 computation of prvs bits *
3054 ********************************************************/
3056 /* This is needed to implement the "prvs" BATV reverse
3060 address RFC2821 Address to use
3061 key The key to use (must be less than 64 characters
3063 key_num Single-digit key number to use. Defaults to
3066 Returns: pointer to string containing the first three
3067 bytes of the final hash in hex format, NULL if
3068 there was an error in the process.
3072 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3074 uschar *hash_source, *p;
3075 int size = 0,offset = 0,i;
3077 void *use_base = &sha1_base;
3078 uschar innerhash[20];
3079 uschar finalhash[20];
3080 uschar innerkey[64];
3081 uschar outerkey[64];
3082 uschar *finalhash_hex = store_get(40);
3084 if (key_num == NULL)
3087 if (Ustrlen(key) > 64)
3090 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3091 string_cat(hash_source,&size,&offset,daystamp,3);
3092 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3093 hash_source[offset] = '\0';
3095 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3097 memset(innerkey, 0x36, 64);
3098 memset(outerkey, 0x5c, 64);
3100 for (i = 0; i < Ustrlen(key); i++)
3102 innerkey[i] ^= key[i];
3103 outerkey[i] ^= key[i];
3106 chash_start(HMAC_SHA1, use_base);
3107 chash_mid(HMAC_SHA1, use_base, innerkey);
3108 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3110 chash_start(HMAC_SHA1, use_base);
3111 chash_mid(HMAC_SHA1, use_base, outerkey);
3112 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3115 for (i = 0; i < 3; i++)
3117 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3118 *p++ = hex_digits[finalhash[i] & 0x0f];
3122 return finalhash_hex;
3128 /*************************************************
3129 * Join a file onto the output string *
3130 *************************************************/
3132 /* This is used for readfile and after a run expansion. It joins the contents
3133 of a file onto the output string, globally replacing newlines with a given
3134 string (optionally). The file is closed at the end.
3138 yield pointer to the expandable string
3139 sizep pointer to the current size
3140 ptrp pointer to the current position
3141 eol newline replacement string, or NULL
3143 Returns: new value of string pointer
3147 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3150 uschar buffer[1024];
3152 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3154 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3156 int len = Ustrlen(buffer);
3157 if (eol != NULL && buffer[len-1] == '\n') len--;
3158 yield = string_cat(yield, sizep, ptrp, buffer, len);
3159 if (buffer[len] != 0)
3160 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3163 if (yield != NULL) yield[*ptrp] = 0;
3171 /*************************************************
3172 * Evaluate numeric expression *
3173 *************************************************/
3175 /* This is a set of mutually recursive functions that evaluate an arithmetic
3176 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3177 these functions that is called from elsewhere is eval_expr, whose interface is:
3180 sptr pointer to the pointer to the string - gets updated
3181 decimal TRUE if numbers are to be assumed decimal
3182 error pointer to where to put an error message - must be NULL on input
3183 endket TRUE if ')' must terminate - FALSE for external call
3185 Returns: on success: the value of the expression, with *error still NULL
3186 on failure: an undefined value, with *error = a message
3189 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3192 static int_eximarith_t
3193 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3196 int_eximarith_t x = eval_op_or(&s, decimal, error);
3202 *error = US"expecting closing parenthesis";
3204 while (isspace(*(++s)));
3206 else if (*s != 0) *error = US"expecting operator";
3213 static int_eximarith_t
3214 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3219 while (isspace(*s)) s++;
3224 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3226 switch (tolower(*s))
3229 case 'k': n *= 1024; s++; break;
3230 case 'm': n *= 1024*1024; s++; break;
3231 case 'g': n *= 1024*1024*1024; s++; break;
3233 while (isspace (*s)) s++;
3238 n = eval_expr(&s, decimal, error, 1);
3242 *error = US"expecting number or opening parenthesis";
3250 static int_eximarith_t
3251 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3255 while (isspace(*s)) s++;
3256 if (*s == '+' || *s == '-' || *s == '~')
3259 x = eval_op_unary(&s, decimal, error);
3260 if (op == '-') x = -x;
3261 else if (op == '~') x = ~x;
3265 x = eval_number(&s, decimal, error);
3272 static int_eximarith_t
3273 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3276 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3279 while (*s == '*' || *s == '/' || *s == '%')
3282 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3283 if (*error != NULL) break;
3284 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3285 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3286 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3287 * -N*M is INT_MIN will yielf INT_MIN.
3288 * Since we don't support floating point, this is somewhat simpler.
3289 * Ideally, we'd return an error, but since we overflow for all other
3290 * arithmetic, consistency suggests otherwise, but what's the correct value
3291 * to use? There is none.
3292 * The C standard guarantees overflow for unsigned arithmetic but signed
3293 * overflow invokes undefined behaviour; in practice, this is overflow
3294 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3295 * that long/longlong larger than int are available, or we could just work
3296 * with larger types. We should consider whether to guarantee 32bit eval
3297 * and 64-bit working variables, with errors returned. For now ...
3298 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3299 * can just let the other invalid results occur otherwise, as they have
3300 * until now. For this one case, we can coerce.
3302 if (y == -1 && x == LLONG_MIN && op != '*')
3305 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3306 LLONG_MIN, op, LLONG_MAX);
3316 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3332 static int_eximarith_t
3333 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3336 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3339 while (*s == '+' || *s == '-')
3342 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3343 if (*error != NULL) break;
3344 if (op == '+') x += y; else x -= y;
3352 static int_eximarith_t
3353 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3356 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3359 while ((*s == '<' || *s == '>') && s[1] == s[0])
3364 y = eval_op_sum(&s, decimal, error);
3365 if (*error != NULL) break;
3366 if (op == '<') x <<= y; else x >>= y;
3374 static int_eximarith_t
3375 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3378 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3385 y = eval_op_shift(&s, decimal, error);
3386 if (*error != NULL) break;
3395 static int_eximarith_t
3396 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3399 int_eximarith_t x = eval_op_and(&s, decimal, error);
3406 y = eval_op_and(&s, decimal, error);
3407 if (*error != NULL) break;
3416 static int_eximarith_t
3417 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3420 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3427 y = eval_op_xor(&s, decimal, error);
3428 if (*error != NULL) break;
3438 /*************************************************
3440 *************************************************/
3442 /* Returns either an unchanged string, or the expanded string in stacking pool
3443 store. Interpreted sequences are:
3445 \... normal escaping rules
3446 $name substitutes the variable
3448 ${op:string} operates on the expanded string value
3449 ${item{arg1}{arg2}...} expands the args and then does the business
3450 some literal args are not enclosed in {}
3452 There are now far too many operators and item types to make it worth listing
3453 them here in detail any more.
3455 We use an internal routine recursively to handle embedded substrings. The
3456 external function follows. The yield is NULL if the expansion failed, and there
3457 are two cases: if something collapsed syntactically, or if "fail" was given
3458 as the action on a lookup failure. These can be distinguised by looking at the
3459 variable expand_string_forcedfail, which is TRUE in the latter case.
3461 The skipping flag is set true when expanding a substring that isn't actually
3462 going to be used (after "if" or "lookup") and it prevents lookups from
3463 happening lower down.
3465 Store usage: At start, a store block of the length of the input plus 64
3466 is obtained. This is expanded as necessary by string_cat(), which might have to
3467 get a new block, or might be able to expand the original. At the end of the
3468 function we can release any store above that portion of the yield block that
3469 was actually used. In many cases this will be optimal.
3471 However: if the first item in the expansion is a variable name or header name,
3472 we reset the store before processing it; if the result is in fresh store, we
3473 use that without copying. This is helpful for expanding strings like
3474 $message_headers which can get very long.
3476 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3477 since resetting the store at the end of the expansion will free store that was
3478 allocated by the plugin code as well as the slop after the expanded string. So
3479 we skip any resets if ${dlfunc has been used. This is an unfortunate
3480 consequence of string expansion becoming too powerful.
3483 string the string to be expanded
3484 ket_ends true if expansion is to stop at }
3485 left if not NULL, a pointer to the first character after the
3486 expansion is placed here (typically used with ket_ends)
3487 skipping TRUE for recursive calls when the value isn't actually going
3488 to be used (to allow for optimisation)
3489 honour_dollar TRUE if $ is to be expanded,
3490 FALSE if it's just another character
3492 Returns: NULL if expansion fails:
3493 expand_string_forcedfail is set TRUE if failure was forced
3494 expand_string_message contains a textual error message
3495 a pointer to the expanded string on success
3499 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3500 BOOL skipping, BOOL honour_dollar)
3503 int size = Ustrlen(string)+ 64;
3505 uschar *yield = store_get(size);
3507 uschar *save_expand_nstring[EXPAND_MAXN+1];
3508 int save_expand_nlength[EXPAND_MAXN+1];
3509 BOOL resetok = TRUE;
3511 expand_string_forcedfail = FALSE;
3512 expand_string_message = US"";
3519 /* \ escapes the next character, which must exist, or else
3520 the expansion fails. There's a special escape, \N, which causes
3521 copying of the subject verbatim up to the next \N. Otherwise,
3522 the escapes are the standard set. */
3528 expand_string_message = US"\\ at end of string";
3535 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3536 yield = string_cat(yield, &size, &ptr, t, s - t);
3537 if (*s != 0) s += 2;
3543 ch[0] = string_interpret_escape(&s);
3545 yield = string_cat(yield, &size, &ptr, ch, 1);
3551 /* Anything other than $ is just copied verbatim, unless we are
3552 looking for a terminating } character. */
3554 if (ket_ends && *s == '}') break;
3556 if (*s != '$' || !honour_dollar)
3558 yield = string_cat(yield, &size, &ptr, s++, 1);
3562 /* No { after the $ - must be a plain name or a number for string
3563 match variable. There has to be a fudge for variables that are the
3564 names of header fields preceded by "$header_" because header field
3565 names can contain any printing characters except space and colon.
3566 For those that don't like typing this much, "$h_" is a synonym for
3567 "$header_". A non-existent header yields a NULL value; nothing is
3570 if (isalpha((*(++s))))
3575 s = read_name(name, sizeof(name), s, US"_");
3577 /* If this is the first thing to be expanded, release the pre-allocated
3580 if (ptr == 0 && yield != NULL)
3582 if (resetok) store_reset(yield);
3589 if (Ustrncmp(name, "h_", 2) == 0 ||
3590 Ustrncmp(name, "rh_", 3) == 0 ||
3591 Ustrncmp(name, "bh_", 3) == 0 ||
3592 Ustrncmp(name, "header_", 7) == 0 ||
3593 Ustrncmp(name, "rheader_", 8) == 0 ||
3594 Ustrncmp(name, "bheader_", 8) == 0)
3596 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3597 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3598 s = read_header_name(name, sizeof(name), s);
3599 value = find_header(name, FALSE, &newsize, want_raw, charset);
3601 /* If we didn't find the header, and the header contains a closing brace
3602 character, this may be a user error where the terminating colon
3603 has been omitted. Set a flag to adjust the error message in this case.
3604 But there is no error here - nothing gets inserted. */
3608 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3617 value = find_variable(name, FALSE, skipping, &newsize);
3620 expand_string_message =
3621 string_sprintf("unknown variable name \"%s\"", name);
3622 check_variable_error_message(name);
3627 /* If the data is known to be in a new buffer, newsize will be set to the
3628 size of that buffer. If this is the first thing in an expansion string,
3629 yield will be NULL; just point it at the new store instead of copying. Many
3630 expansion strings contain just one reference, so this is a useful
3631 optimization, especially for humungous headers. */
3633 len = Ustrlen(value);
3634 if (yield == NULL && newsize != 0)
3640 else yield = string_cat(yield, &size, &ptr, value, len);
3648 s = read_number(&n, s);
3649 if (n >= 0 && n <= expand_nmax)
3650 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3655 /* Otherwise, if there's no '{' after $ it's an error. */
3659 expand_string_message = US"$ not followed by letter, digit, or {";
3663 /* After { there can be various things, but they all start with
3664 an initial word, except for a number for a string match variable. */
3666 if (isdigit((*(++s))))
3669 s = read_number(&n, s);
3672 expand_string_message = US"} expected after number";
3675 if (n >= 0 && n <= expand_nmax)
3676 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3683 expand_string_message = US"letter or digit expected after ${";
3687 /* Allow "-" in names to cater for substrings with negative
3688 arguments. Since we are checking for known names after { this is
3691 s = read_name(name, sizeof(name), s, US"_-");
3692 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3696 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3697 If the ACL returns accept or reject we return content set by "message ="
3698 There is currently no limit on recursion; this would have us call
3699 acl_check_internal() directly and get a current level from somewhere.
3703 /* ${acl {name} {arg1}{arg2}...} */
3706 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3710 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl"))
3712 case 1: goto EXPAND_FAILED_CURLY;
3714 case 3: goto EXPAND_FAILED;
3716 if (skipping) continue;
3718 for (i = 1; i < sizeof(sub)/sizeof(*sub) && sub[i]; i++)
3719 acl_arg[i-1] = sub[i];
3721 while (i < sizeof(sub)/sizeof(*sub))
3722 acl_arg[i++ - 1] = NULL;
3725 debug_printf("expanding: acl: %s arg: %s%s\n",
3727 acl_narg>0 ? sub[1] : US"<none>",
3728 acl_narg>1 ? " +more" : "");
3730 switch(acl_check(ACL_WHERE_EXPANSION, NULL, sub[0], &user_msg, &log_msg))
3735 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3739 expand_string_forcedfail = TRUE;
3741 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3746 /* Handle conditionals - preserve the values of the numerical expansion
3747 variables in case they get changed by a regular expression match in the
3748 condition. If not, they retain their external settings. At the end
3749 of this "if" section, they get restored to their previous values. */
3755 int save_expand_nmax =
3756 save_expand_strings(save_expand_nstring, save_expand_nlength);
3758 while (isspace(*s)) s++;
3759 next_s = eval_condition(s, skipping? NULL : &cond);
3760 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3763 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3764 cond? "true" : "false");
3768 /* The handling of "yes" and "no" result strings is now in a separate
3769 function that is also used by ${lookup} and ${extract} and ${run}. */
3771 switch(process_yesno(
3772 skipping, /* were previously skipping */
3773 cond, /* success/failure indicator */
3774 lookup_value, /* value to reset for string2 */
3775 &s, /* input pointer */
3776 &yield, /* output pointer */
3777 &size, /* output size */
3778 &ptr, /* output current point */
3779 US"if")) /* condition type */
3781 case 1: goto EXPAND_FAILED; /* when all is well, the */
3782 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3785 /* Restore external setting of expansion variables for continuation
3788 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3789 save_expand_nlength);
3793 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3794 expanding an internal string that isn't actually going to be used. All we
3795 need to do is check the syntax, so don't do a lookup at all. Preserve the
3796 values of the numerical expansion variables in case they get changed by a
3797 partial lookup. If not, they retain their external settings. At the end
3798 of this "lookup" section, they get restored to their previous values. */
3802 int stype, partial, affixlen, starflags;
3803 int expand_setup = 0;
3805 uschar *key, *filename, *affix;
3806 uschar *save_lookup_value = lookup_value;
3807 int save_expand_nmax =
3808 save_expand_strings(save_expand_nstring, save_expand_nlength);
3810 if ((expand_forbid & RDO_LOOKUP) != 0)
3812 expand_string_message = US"lookup expansions are not permitted";
3816 /* Get the key we are to look up for single-key+file style lookups.
3817 Otherwise set the key NULL pro-tem. */
3819 while (isspace(*s)) s++;
3822 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3823 if (key == NULL) goto EXPAND_FAILED;
3824 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3825 while (isspace(*s)) s++;
3829 /* Find out the type of database */
3833 expand_string_message = US"missing lookup type";
3837 /* The type is a string that may contain special characters of various
3838 kinds. Allow everything except space or { to appear; the actual content
3839 is checked by search_findtype_partial. */
3841 while (*s != 0 && *s != '{' && !isspace(*s))
3843 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3847 while (isspace(*s)) s++;
3849 /* Now check for the individual search type and any partial or default
3850 options. Only those types that are actually in the binary are valid. */
3852 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3856 expand_string_message = search_error_message;
3860 /* Check that a key was provided for those lookup types that need it,
3861 and was not supplied for those that use the query style. */
3863 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3867 expand_string_message = string_sprintf("missing {key} for single-"
3868 "key \"%s\" lookup", name);
3876 expand_string_message = string_sprintf("a single key was given for "
3877 "lookup type \"%s\", which is not a single-key lookup type", name);
3882 /* Get the next string in brackets and expand it. It is the file name for
3883 single-key+file lookups, and the whole query otherwise. In the case of
3884 queries that also require a file name (e.g. sqlite), the file name comes
3887 if (*s != '{') goto EXPAND_FAILED_CURLY;
3888 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3889 if (filename == NULL) goto EXPAND_FAILED;
3890 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3891 while (isspace(*s)) s++;
3893 /* If this isn't a single-key+file lookup, re-arrange the variables
3894 to be appropriate for the search_ functions. For query-style lookups,
3895 there is just a "key", and no file name. For the special query-style +
3896 file types, the query (i.e. "key") starts with a file name. */
3900 while (isspace(*filename)) filename++;
3903 if (mac_islookup(stype, lookup_querystyle))
3909 if (*filename != '/')
3911 expand_string_message = string_sprintf(
3912 "absolute file name expected for \"%s\" lookup", name);
3915 while (*key != 0 && !isspace(*key)) key++;
3916 if (*key != 0) *key++ = 0;
3920 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3921 the entry was not found. Note that there is no search_close() function.
3922 Files are left open in case of re-use. At suitable places in higher logic,
3923 search_tidyup() is called to tidy all open files. This can save opening
3924 the same file several times. However, files may also get closed when
3925 others are opened, if too many are open at once. The rule is that a
3926 handle should not be used after a second search_open().
3928 Request that a partial search sets up $1 and maybe $2 by passing
3929 expand_setup containing zero. If its value changes, reset expand_nmax,
3930 since new variables will have been set. Note that at the end of this
3931 "lookup" section, the old numeric variables are restored. */
3934 lookup_value = NULL;
3937 void *handle = search_open(filename, stype, 0, NULL, NULL);
3940 expand_string_message = search_error_message;
3943 lookup_value = search_find(handle, filename, key, partial, affix,
3944 affixlen, starflags, &expand_setup);
3945 if (search_find_defer)
3947 expand_string_message =
3948 string_sprintf("lookup of \"%s\" gave DEFER: %s",
3949 string_printing2(key, FALSE), search_error_message);
3952 if (expand_setup > 0) expand_nmax = expand_setup;
3955 /* The handling of "yes" and "no" result strings is now in a separate
3956 function that is also used by ${if} and ${extract}. */
3958 switch(process_yesno(
3959 skipping, /* were previously skipping */
3960 lookup_value != NULL, /* success/failure indicator */
3961 save_lookup_value, /* value to reset for string2 */
3962 &s, /* input pointer */
3963 &yield, /* output pointer */
3964 &size, /* output size */
3965 &ptr, /* output current point */
3966 US"lookup")) /* condition type */
3968 case 1: goto EXPAND_FAILED; /* when all is well, the */
3969 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3972 /* Restore external setting of expansion variables for carrying on
3973 at this level, and continue. */
3975 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3976 save_expand_nlength);
3980 /* If Perl support is configured, handle calling embedded perl subroutines,
3981 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3982 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3983 arguments (defined below). */
3985 #define EXIM_PERL_MAX_ARGS 8
3989 expand_string_message = US"\"${perl\" encountered, but this facility "
3990 "is not included in this binary";
3993 #else /* EXIM_PERL */
3995 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3998 if ((expand_forbid & RDO_PERL) != 0)
4000 expand_string_message = US"Perl calls are not permitted";
4004 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4007 case 1: goto EXPAND_FAILED_CURLY;
4009 case 3: goto EXPAND_FAILED;
4012 /* If skipping, we don't actually do anything */
4014 if (skipping) continue;
4016 /* Start the interpreter if necessary */
4018 if (!opt_perl_started)
4021 if (opt_perl_startup == NULL)
4023 expand_string_message = US"A setting of perl_startup is needed when "
4024 "using the Perl interpreter";
4027 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4028 initerror = init_perl(opt_perl_startup);
4029 if (initerror != NULL)
4031 expand_string_message =
4032 string_sprintf("error in perl_startup code: %s\n", initerror);
4035 opt_perl_started = TRUE;
4038 /* Call the function */
4040 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4041 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4042 sub_arg[0], sub_arg + 1);
4044 /* NULL yield indicates failure; if the message pointer has been set to
4045 NULL, the yield was undef, indicating a forced failure. Otherwise the
4046 message will indicate some kind of Perl error. */
4048 if (new_yield == NULL)
4050 if (expand_string_message == NULL)
4052 expand_string_message =
4053 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4054 "failure", sub_arg[0]);
4055 expand_string_forcedfail = TRUE;
4060 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4061 set during a callback from Perl. */
4063 expand_string_forcedfail = FALSE;
4067 #endif /* EXIM_PERL */
4069 /* Transform email address to "prvs" scheme to use
4070 as BATV-signed return path */
4077 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
4079 case 1: goto EXPAND_FAILED_CURLY;
4081 case 3: goto EXPAND_FAILED;
4084 /* If skipping, we don't actually do anything */
4085 if (skipping) continue;
4087 /* sub_arg[0] is the address */
4088 domain = Ustrrchr(sub_arg[0],'@');
4089 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4091 expand_string_message = US"prvs first argument must be a qualified email address";
4095 /* Calculate the hash. The second argument must be a single-digit
4096 key number, or unset. */
4098 if (sub_arg[2] != NULL &&
4099 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4101 expand_string_message = US"prvs second argument must be a single digit";
4105 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4108 expand_string_message = US"prvs hmac-sha1 conversion failed";
4112 /* Now separate the domain from the local part */
4115 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4116 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4117 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4118 string_cat(yield,&size,&ptr,p,6);
4119 string_cat(yield,&size,&ptr,US"=",1);
4120 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4121 string_cat(yield,&size,&ptr,US"@",1);
4122 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4127 /* Check a prvs-encoded address for validity */
4129 case EITEM_PRVSCHECK:
4132 int mysize = 0, myptr = 0;
4136 /* TF: Ugliness: We want to expand parameter 1 first, then set
4137 up expansion variables that are used in the expansion of
4138 parameter 2. So we clone the string for the first
4139 expansion, where we only expand parameter 1.
4141 PH: Actually, that isn't necessary. The read_subs() function is
4142 designed to work this way for the ${if and ${lookup expansions. I've
4146 /* Reset expansion variables */
4147 prvscheck_result = NULL;
4148 prvscheck_address = NULL;
4149 prvscheck_keynum = NULL;
4151 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4153 case 1: goto EXPAND_FAILED_CURLY;
4155 case 3: goto EXPAND_FAILED;
4158 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4161 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4163 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4164 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4165 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4166 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4167 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4169 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4170 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4171 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4172 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4173 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4175 /* Set up expansion variables */
4176 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4177 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4178 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4179 prvscheck_address[myptr] = '\0';
4180 prvscheck_keynum = string_copy(key_num);
4182 /* Now expand the second argument */
4183 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4185 case 1: goto EXPAND_FAILED_CURLY;
4187 case 3: goto EXPAND_FAILED;
4190 /* Now we have the key and can check the address. */
4192 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4197 expand_string_message = US"hmac-sha1 conversion failed";
4201 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4202 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4204 if (Ustrcmp(p,hash) == 0)
4206 /* Success, valid BATV address. Now check the expiry date. */
4207 uschar *now = prvs_daystamp(0);
4208 unsigned int inow = 0,iexpire = 1;
4210 (void)sscanf(CS now,"%u",&inow);
4211 (void)sscanf(CS daystamp,"%u",&iexpire);
4213 /* When "iexpire" is < 7, a "flip" has occured.
4214 Adjust "inow" accordingly. */
4215 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4217 if (iexpire >= inow)
4219 prvscheck_result = US"1";
4220 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4224 prvscheck_result = NULL;
4225 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4230 prvscheck_result = NULL;
4231 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4234 /* Now expand the final argument. We leave this till now so that
4235 it can include $prvscheck_result. */
4237 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4239 case 1: goto EXPAND_FAILED_CURLY;
4241 case 3: goto EXPAND_FAILED;
4244 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4245 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4247 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4249 /* Reset the "internal" variables afterwards, because they are in
4250 dynamic store that will be reclaimed if the expansion succeeded. */
4252 prvscheck_address = NULL;
4253 prvscheck_keynum = NULL;
4257 /* Does not look like a prvs encoded address, return the empty string.
4258 We need to make sure all subs are expanded first, so as to skip over
4261 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4263 case 1: goto EXPAND_FAILED_CURLY;
4265 case 3: goto EXPAND_FAILED;
4272 /* Handle "readfile" to insert an entire file */
4274 case EITEM_READFILE:
4279 if ((expand_forbid & RDO_READFILE) != 0)
4281 expand_string_message = US"file insertions are not permitted";
4285 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4287 case 1: goto EXPAND_FAILED_CURLY;
4289 case 3: goto EXPAND_FAILED;
4292 /* If skipping, we don't actually do anything */
4294 if (skipping) continue;
4296 /* Open the file and read it */
4298 f = Ufopen(sub_arg[0], "rb");
4301 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4305 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4310 /* Handle "readsocket" to insert data from a Unix domain socket */
4312 case EITEM_READSOCK:
4318 struct sockaddr_un sockun; /* don't call this "sun" ! */
4322 if ((expand_forbid & RDO_READSOCK) != 0)
4324 expand_string_message = US"socket insertions are not permitted";
4328 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4329 because there may be a string for expansion on failure. */
4331 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4333 case 1: goto EXPAND_FAILED_CURLY;
4334 case 2: /* Won't occur: no end check */
4335 case 3: goto EXPAND_FAILED;
4338 /* Sort out timeout, if given */
4340 if (sub_arg[2] != NULL)
4342 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4345 expand_string_message = string_sprintf("bad time value %s",
4350 else sub_arg[3] = NULL; /* No eol if no timeout */
4352 /* If skipping, we don't actually do anything. Otherwise, arrange to
4353 connect to either an IP or a Unix socket. */
4357 /* Handle an IP (internet) domain */
4359 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4361 BOOL connected = FALSE;
4365 uschar *server_name = sub_arg[0] + 5;
4366 uschar *port_name = Ustrrchr(server_name, ':');
4368 /* Sort out the port */
4370 if (port_name == NULL)
4372 expand_string_message =
4373 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4376 *port_name++ = 0; /* Terminate server name */
4378 if (isdigit(*port_name))
4381 port = Ustrtol(port_name, &end, 0);
4382 if (end != port_name + Ustrlen(port_name))
4384 expand_string_message =
4385 string_sprintf("invalid port number %s", port_name);
4391 struct servent *service_info = getservbyname(CS port_name, "tcp");
4392 if (service_info == NULL)
4394 expand_string_message = string_sprintf("unknown port \"%s\"",
4398 port = ntohs(service_info->s_port);
4401 /* Sort out the server. */
4404 shost.address = NULL;
4408 namelen = Ustrlen(server_name);
4410 /* Anything enclosed in [] must be an IP address. */
4412 if (server_name[0] == '[' &&
4413 server_name[namelen - 1] == ']')
4415 server_name[namelen - 1] = 0;
4417 if (string_is_ip_address(server_name, NULL) == 0)
4419 expand_string_message =
4420 string_sprintf("malformed IP address \"%s\"", server_name);
4423 shost.name = shost.address = server_name;
4426 /* Otherwise check for an unadorned IP address */
4428 else if (string_is_ip_address(server_name, NULL) != 0)
4429 shost.name = shost.address = server_name;
4431 /* Otherwise lookup IP address(es) from the name */
4435 shost.name = server_name;
4436 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4437 FALSE) != HOST_FOUND)
4439 expand_string_message =
4440 string_sprintf("no IP address found for host %s", shost.name);
4445 /* Try to connect to the server - test each IP till one works */
4447 for (h = &shost; h != NULL; h = h->next)
4449 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4450 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4452 expand_string_message = string_sprintf("failed to create socket: "
4453 "%s", strerror(errno));
4457 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4466 expand_string_message = string_sprintf("failed to connect to "
4467 "socket %s: couldn't connect to any host", sub_arg[0],
4473 /* Handle a Unix domain socket */
4478 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4480 expand_string_message = string_sprintf("failed to create socket: %s",
4485 sockun.sun_family = AF_UNIX;
4486 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4489 sigalrm_seen = FALSE;
4491 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4495 expand_string_message = US "socket connect timed out";
4500 expand_string_message = string_sprintf("failed to connect to socket "
4501 "%s: %s", sub_arg[0], strerror(errno));
4506 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4508 /* Write the request string, if not empty */
4510 if (sub_arg[1][0] != 0)
4512 int len = Ustrlen(sub_arg[1]);
4513 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4515 if (write(fd, sub_arg[1], len) != len)
4517 expand_string_message = string_sprintf("request write to socket "
4518 "failed: %s", strerror(errno));
4523 /* Shut down the sending side of the socket. This helps some servers to
4524 recognise that it is their turn to do some work. Just in case some
4525 system doesn't have this function, make it conditional. */
4528 shutdown(fd, SHUT_WR);
4531 /* Now we need to read from the socket, under a timeout. The function
4532 that reads a file can be used. */
4534 f = fdopen(fd, "rb");
4535 sigalrm_seen = FALSE;
4537 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4541 /* After a timeout, we restore the pointer in the result, that is,
4542 make sure we add nothing from the socket. */
4547 expand_string_message = US "socket read timed out";
4552 /* The whole thing has worked (or we were skipping). If there is a
4553 failure string following, we need to skip it. */
4557 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4559 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4560 while (isspace(*s)) s++;
4562 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4565 /* Come here on failure to create socket, connect socket, write to the
4566 socket, or timeout on reading. If another substring follows, expand and
4567 use it. Otherwise, those conditions give expand errors. */
4570 if (*s != '{') goto EXPAND_FAILED;
4571 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4572 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4573 if (arg == NULL) goto EXPAND_FAILED;
4574 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4575 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4576 while (isspace(*s)) s++;
4577 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4581 /* Handle "run" to execute a program. */
4593 if ((expand_forbid & RDO_RUN) != 0)
4595 expand_string_message = US"running a command is not permitted";
4599 while (isspace(*s)) s++;
4600 if (*s != '{') goto EXPAND_FAILED_CURLY;
4601 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4602 if (arg == NULL) goto EXPAND_FAILED;
4603 while (isspace(*s)) s++;
4604 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4606 if (skipping) /* Just pretend it worked when we're skipping */
4612 if (!transport_set_up_command(&argv, /* anchor for arg list */
4613 arg, /* raw command */
4614 FALSE, /* don't expand the arguments */
4615 0, /* not relevant when... */
4616 NULL, /* no transporting address */
4617 US"${run} expansion", /* for error messages */
4618 &expand_string_message)) /* where to put error message */
4623 /* Create the child process, making it a group leader. */
4625 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4629 expand_string_message =
4630 string_sprintf("couldn't create child process: %s", strerror(errno));
4634 /* Nothing is written to the standard input. */
4638 /* Read the pipe to get the command's output into $value (which is kept
4639 in lookup_value). Read during execution, so that if the output exceeds
4640 the OS pipe buffer limit, we don't block forever. */
4642 f = fdopen(fd_out, "rb");
4643 sigalrm_seen = FALSE;
4645 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4649 /* Wait for the process to finish, applying the timeout, and inspect its
4650 return code for serious disasters. Simple non-zero returns are passed on.
4653 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4655 if (sigalrm_seen == TRUE || runrc == -256)
4657 expand_string_message = string_sprintf("command timed out");
4658 killpg(pid, SIGKILL); /* Kill the whole process group */
4661 else if (runrc == -257)
4662 expand_string_message = string_sprintf("wait() failed: %s",
4666 expand_string_message = string_sprintf("command killed by signal %d",
4673 /* Process the yes/no strings; $value may be useful in both cases */
4675 switch(process_yesno(
4676 skipping, /* were previously skipping */
4677 runrc == 0, /* success/failure indicator */
4678 lookup_value, /* value to reset for string2 */
4679 &s, /* input pointer */
4680 &yield, /* output pointer */
4681 &size, /* output size */
4682 &ptr, /* output current point */
4683 US"run")) /* condition type */
4685 case 1: goto EXPAND_FAILED; /* when all is well, the */
4686 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4692 /* Handle character translation for "tr" */
4700 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4702 case 1: goto EXPAND_FAILED_CURLY;
4704 case 3: goto EXPAND_FAILED;
4707 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4708 o2m = Ustrlen(sub[2]) - 1;
4710 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4712 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4716 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4723 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4724 expanded arguments. */
4734 int val[2] = { 0, -1 };
4737 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4738 Ensure that sub[2] is set in the ${length case. */
4741 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4744 case 1: goto EXPAND_FAILED_CURLY;
4746 case 3: goto EXPAND_FAILED;
4749 /* Juggle the arguments if there are only two of them: always move the
4750 string to the last position and make ${length{n}{str}} equivalent to
4751 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4757 if (item_type == EITEM_LENGTH)
4764 for (i = 0; i < 2; i++)
4766 if (sub[i] == NULL) continue;
4767 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4768 if (*ret != 0 || (i != 0 && val[i] < 0))
4770 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4771 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4777 (item_type == EITEM_HASH)?
4778 compute_hash(sub[2], val[0], val[1], &len) :
4779 (item_type == EITEM_NHASH)?
4780 compute_nhash(sub[2], val[0], val[1], &len) :
4781 extract_substr(sub[2], val[0], val[1], &len);
4783 if (ret == NULL) goto EXPAND_FAILED;
4784 yield = string_cat(yield, &size, &ptr, ret, len);
4788 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4789 This code originally contributed by Steve Haslam. It currently supports
4790 the use of MD5 and SHA-1 hashes.
4792 We need some workspace that is large enough to handle all the supported
4793 hash types. Use macros to set the sizes rather than be too elaborate. */
4795 #define MAX_HASHLEN 20
4796 #define MAX_HASHBLOCKLEN 64
4805 int hashlen; /* Number of octets for the hash algorithm's output */
4806 int hashblocklen; /* Number of octets the hash algorithm processes */
4808 unsigned int keylen;
4810 uschar keyhash[MAX_HASHLEN];
4811 uschar innerhash[MAX_HASHLEN];
4812 uschar finalhash[MAX_HASHLEN];
4813 uschar finalhash_hex[2*MAX_HASHLEN];
4814 uschar innerkey[MAX_HASHBLOCKLEN];
4815 uschar outerkey[MAX_HASHBLOCKLEN];
4817 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4819 case 1: goto EXPAND_FAILED_CURLY;
4821 case 3: goto EXPAND_FAILED;
4824 if (Ustrcmp(sub[0], "md5") == 0)
4827 use_base = &md5_base;
4831 else if (Ustrcmp(sub[0], "sha1") == 0)
4834 use_base = &sha1_base;
4840 expand_string_message =
4841 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4846 keylen = Ustrlen(keyptr);
4848 /* If the key is longer than the hash block length, then hash the key
4851 if (keylen > hashblocklen)
4853 chash_start(type, use_base);
4854 chash_end(type, use_base, keyptr, keylen, keyhash);
4859 /* Now make the inner and outer key values */
4861 memset(innerkey, 0x36, hashblocklen);
4862 memset(outerkey, 0x5c, hashblocklen);
4864 for (i = 0; i < keylen; i++)
4866 innerkey[i] ^= keyptr[i];
4867 outerkey[i] ^= keyptr[i];
4870 /* Now do the hashes */
4872 chash_start(type, use_base);
4873 chash_mid(type, use_base, innerkey);
4874 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4876 chash_start(type, use_base);
4877 chash_mid(type, use_base, outerkey);
4878 chash_end(type, use_base, innerhash, hashlen, finalhash);
4880 /* Encode the final hash as a hex string */
4883 for (i = 0; i < hashlen; i++)
4885 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4886 *p++ = hex_digits[finalhash[i] & 0x0f];
4889 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4890 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4892 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4897 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4898 We have to save the numerical variables and restore them afterwards. */
4903 int moffset, moffsetextra, slen;
4906 const uschar *rerror;
4909 int save_expand_nmax =
4910 save_expand_strings(save_expand_nstring, save_expand_nlength);
4912 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4914 case 1: goto EXPAND_FAILED_CURLY;
4916 case 3: goto EXPAND_FAILED;
4919 /* Compile the regular expression */
4921 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4926 expand_string_message = string_sprintf("regular expression error in "
4927 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4931 /* Now run a loop to do the substitutions as often as necessary. It ends
4932 when there are no more matches. Take care over matches of the null string;
4933 do the same thing as Perl does. */
4936 slen = Ustrlen(sub[0]);
4937 moffset = moffsetextra = 0;
4942 int ovector[3*(EXPAND_MAXN+1)];
4943 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4944 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4948 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4949 is not necessarily the end. We want to repeat the match from one
4950 character further along, but leaving the basic offset the same (for
4951 copying below). We can't be at the end of the string - that was checked
4952 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4953 finished; copy the remaining string and end the loop. */
4963 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4967 /* Match - set up for expanding the replacement. */
4969 if (n == 0) n = EXPAND_MAXN + 1;
4971 for (nn = 0; nn < n*2; nn += 2)
4973 expand_nstring[expand_nmax] = subject + ovector[nn];
4974 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4978 /* Copy the characters before the match, plus the expanded insertion. */
4980 yield = string_cat(yield, &size, &ptr, subject + moffset,
4981 ovector[0] - moffset);
4982 insert = expand_string(sub[2]);
4983 if (insert == NULL) goto EXPAND_FAILED;
4984 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4986 moffset = ovector[1];
4990 /* If we have matched an empty string, first check to see if we are at
4991 the end of the subject. If so, the loop is over. Otherwise, mimic
4992 what Perl's /g options does. This turns out to be rather cunning. First
4993 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4994 string at the same point. If this fails (picked up above) we advance to
4995 the next character. */
4997 if (ovector[0] == ovector[1])
4999 if (ovector[0] == slen) break;
5000 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5004 /* All done - restore numerical variables. */
5006 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5007 save_expand_nlength);
5011 /* Handle keyed and numbered substring extraction. If the first argument
5012 consists entirely of digits, then a numerical extraction is assumed. */
5018 int field_number = 1;
5019 BOOL field_number_set = FALSE;
5020 uschar *save_lookup_value = lookup_value;
5022 int save_expand_nmax =
5023 save_expand_strings(save_expand_nstring, save_expand_nlength);
5025 /* Read the arguments */
5027 for (i = 0; i < j; i++)
5029 while (isspace(*s)) s++;
5032 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5033 if (sub[i] == NULL) goto EXPAND_FAILED;
5034 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5036 /* After removal of leading and trailing white space, the first
5037 argument must not be empty; if it consists entirely of digits
5038 (optionally preceded by a minus sign), this is a numerical
5039 extraction, and we expect 3 arguments. */
5047 while (isspace(*p)) p++;
5051 while (len > 0 && isspace(p[len-1])) len--;
5054 if (*p == 0 && !skipping)
5056 expand_string_message = US"first argument of \"extract\" must "
5066 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5070 j = 3; /* Need 3 args */
5071 field_number_set = TRUE;
5075 else goto EXPAND_FAILED_CURLY;
5078 /* Extract either the numbered or the keyed substring into $value. If
5079 skipping, just pretend the extraction failed. */
5081 lookup_value = skipping? NULL : field_number_set?
5082 expand_gettokened(field_number, sub[1], sub[2]) :
5083 expand_getkeyed(sub[0], sub[1]);
5085 /* If no string follows, $value gets substituted; otherwise there can
5086 be yes/no strings, as for lookup or if. */
5088 switch(process_yesno(
5089 skipping, /* were previously skipping */
5090 lookup_value != NULL, /* success/failure indicator */
5091 save_lookup_value, /* value to reset for string2 */
5092 &s, /* input pointer */
5093 &yield, /* output pointer */
5094 &size, /* output size */
5095 &ptr, /* output current point */
5096 US"extract")) /* condition type */
5098 case 1: goto EXPAND_FAILED; /* when all is well, the */
5099 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5102 /* All done - restore numerical variables. */
5104 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5105 save_expand_nlength);
5111 /* Handle list operations */
5119 uschar outsep[2] = { '\0', '\0' };
5120 uschar *list, *expr, *temp;
5121 uschar *save_iterate_item = iterate_item;
5122 uschar *save_lookup_value = lookup_value;
5124 while (isspace(*s)) s++;
5125 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5127 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5128 if (list == NULL) goto EXPAND_FAILED;
5129 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5131 if (item_type == EITEM_REDUCE)
5133 while (isspace(*s)) s++;
5134 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5135 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5136 if (temp == NULL) goto EXPAND_FAILED;
5137 lookup_value = temp;
5138 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5141 while (isspace(*s)) s++;
5142 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5146 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5147 if scanning a "false" part). This allows us to find the end of the
5148 condition, because if the list is empty, we won't actually evaluate the
5149 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5150 the normal internal expansion function. */
5152 if (item_type == EITEM_FILTER)
5154 temp = eval_condition(expr, NULL);
5155 if (temp != NULL) s = temp;
5159 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5164 expand_string_message = string_sprintf("%s inside \"%s\" item",
5165 expand_string_message, name);
5169 while (isspace(*s)) s++;
5172 expand_string_message = string_sprintf("missing } at end of condition "
5173 "or expression inside \"%s\"", name);
5177 while (isspace(*s)) s++;
5180 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5185 /* If we are skipping, we can now just move on to the next item. When
5186 processing for real, we perform the iteration. */
5188 if (skipping) continue;
5189 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5191 *outsep = (uschar)sep; /* Separator as a string */
5193 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5195 if (item_type == EITEM_FILTER)
5198 if (eval_condition(expr, &condresult) == NULL)
5200 iterate_item = save_iterate_item;
5201 lookup_value = save_lookup_value;
5202 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5203 expand_string_message, name);
5206 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5207 condresult? "true":"false");
5209 temp = iterate_item; /* TRUE => include this item */
5211 continue; /* FALSE => skip this item */
5214 /* EITEM_MAP and EITEM_REDUCE */
5218 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5221 iterate_item = save_iterate_item;
5222 expand_string_message = string_sprintf("%s inside \"%s\" item",
5223 expand_string_message, name);
5226 if (item_type == EITEM_REDUCE)
5228 lookup_value = temp; /* Update the value of $value */
5229 continue; /* and continue the iteration */
5233 /* We reach here for FILTER if the condition is true, always for MAP,
5234 and never for REDUCE. The value in "temp" is to be added to the output
5235 list that is being created, ensuring that any occurrences of the
5236 separator character are doubled. Unless we are dealing with the first
5237 item of the output list, add in a space if the new item begins with the
5238 separator character, or is an empty string. */
5240 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5241 yield = string_cat(yield, &size, &ptr, US" ", 1);
5243 /* Add the string in "temp" to the output list that we are building,
5244 This is done in chunks by searching for the separator character. */
5248 size_t seglen = Ustrcspn(temp, outsep);
5249 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5251 /* If we got to the end of the string we output one character
5252 too many; backup and end the loop. Otherwise arrange to double the
5255 if (temp[seglen] == '\0') { ptr--; break; }
5256 yield = string_cat(yield, &size, &ptr, outsep, 1);
5260 /* Output a separator after the string: we will remove the redundant
5261 final one at the end. */
5263 yield = string_cat(yield, &size, &ptr, outsep, 1);
5264 } /* End of iteration over the list loop */
5266 /* REDUCE has generated no output above: output the final value of
5269 if (item_type == EITEM_REDUCE)
5271 yield = string_cat(yield, &size, &ptr, lookup_value,
5272 Ustrlen(lookup_value));
5273 lookup_value = save_lookup_value; /* Restore $value */
5276 /* FILTER and MAP generate lists: if they have generated anything, remove
5277 the redundant final separator. Even though an empty item at the end of a
5278 list does not count, this is tidier. */
5280 else if (ptr != save_ptr) ptr--;
5282 /* Restore preserved $item */
5284 iterate_item = save_iterate_item;
5289 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5290 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5291 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5292 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5294 #define EXPAND_DLFUNC_MAX_ARGS 8
5297 #ifndef EXPAND_DLFUNC
5298 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5299 "is not included in this binary";
5302 #else /* EXPAND_DLFUNC */
5305 exim_dlfunc_t *func;
5308 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5310 if ((expand_forbid & RDO_DLFUNC) != 0)
5312 expand_string_message =
5313 US"dynamically-loaded functions are not permitted";
5317 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5320 case 1: goto EXPAND_FAILED_CURLY;
5322 case 3: goto EXPAND_FAILED;
5325 /* If skipping, we don't actually do anything */
5327 if (skipping) continue;
5329 /* Look up the dynamically loaded object handle in the tree. If it isn't
5330 found, dlopen() the file and put the handle in the tree for next time. */
5332 t = tree_search(dlobj_anchor, argv[0]);
5335 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5338 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5339 argv[0], dlerror());
5340 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5343 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5344 Ustrcpy(t->name, argv[0]);
5345 t->data.ptr = handle;
5346 (void)tree_insertnode(&dlobj_anchor, t);
5349 /* Having obtained the dynamically loaded object handle, look up the
5350 function pointer. */
5352 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5355 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5356 "%s", argv[1], argv[0], dlerror());
5357 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5361 /* Call the function and work out what to do with the result. If it
5362 returns OK, we have a replacement string; if it returns DEFER then
5363 expansion has failed in a non-forced manner; if it returns FAIL then
5364 failure was forced; if it returns ERROR or any other value there's a
5365 problem, so panic slightly. In any case, assume that the function has
5366 side-effects on the store that must be preserved. */
5370 for (argc = 0; argv[argc] != NULL; argc++);
5371 status = func(&result, argc - 2, &argv[2]);
5374 if (result == NULL) result = US"";
5375 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5380 expand_string_message = result == NULL ? US"(no message)" : result;
5381 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5382 else if(status != FAIL)
5383 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5384 argv[0], argv[1], status, expand_string_message);
5388 #endif /* EXPAND_DLFUNC */
5391 /* Control reaches here if the name is not recognized as one of the more
5392 complicated expansion items. Check for the "operator" syntax (name terminated
5393 by a colon). Some of the operators have arguments, separated by _ from the
5400 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5401 if (sub == NULL) goto EXPAND_FAILED;
5404 /* Owing to an historical mis-design, an underscore may be part of the
5405 operator name, or it may introduce arguments. We therefore first scan the
5406 table of names that contain underscores. If there is no match, we cut off
5407 the arguments and then scan the main table. */
5409 c = chop_match(name, op_table_underscore,
5410 sizeof(op_table_underscore)/sizeof(uschar *));
5414 arg = Ustrchr(name, '_');
5415 if (arg != NULL) *arg = 0;
5416 c = chop_match(name, op_table_main,
5417 sizeof(op_table_main)/sizeof(uschar *));
5418 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5419 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5422 /* If we are skipping, we don't need to perform the operation at all.
5423 This matters for operations like "mask", because the data may not be
5424 in the correct format when skipping. For example, the expression may test
5425 for the existence of $sender_host_address before trying to mask it. For
5426 other operations, doing them may not fail, but it is a waste of time. */
5428 if (skipping && c >= 0) continue;
5430 /* Otherwise, switch on the operator type */
5437 unsigned long int n = Ustrtoul(sub, &t, 10);
5440 expand_string_message = string_sprintf("argument for base62 "
5441 "operator is \"%s\", which is not a decimal number", sub);
5444 t = string_base62(n);
5445 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5449 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5455 unsigned long int n = 0;
5458 uschar *t = Ustrchr(base62_chars, *tt++);
5461 expand_string_message = string_sprintf("argument for base62d "
5462 "operator is \"%s\", which is not a base %d number", sub,
5466 n = n * BASE_62 + (t - base62_chars);
5468 (void)sprintf(CS buf, "%ld", n);
5469 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5475 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5476 if (expanded == NULL)
5478 expand_string_message =
5479 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5480 expand_string_message);
5483 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5490 uschar *t = sub - 1;
5491 while (*(++t) != 0) { *t = tolower(*t); count++; }
5492 yield = string_cat(yield, &size, &ptr, sub, count);
5499 uschar *t = sub - 1;
5500 while (*(++t) != 0) { *t = toupper(*t); count++; }
5501 yield = string_cat(yield, &size, &ptr, sub, count);
5512 md5_end(&base, sub, Ustrlen(sub), digest);
5513 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5514 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5525 sha1_end(&base, sub, Ustrlen(sub), digest);
5526 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5527 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5531 /* Convert hex encoding to base64 encoding */
5541 for (enc = sub; *enc != 0; enc++)
5543 if (!isxdigit(*enc))
5545 expand_string_message = string_sprintf("\"%s\" is not a hex "
5554 expand_string_message = string_sprintf("\"%s\" contains an odd "
5555 "number of characters", sub);
5559 while ((c = *in++) != 0)
5561 if (isdigit(c)) c -= '0';
5562 else c = toupper(c) - 'A' + 10;
5574 enc = auth_b64encode(sub, out - sub);
5575 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5579 /* count the number of list elements */
5588 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5589 cp = string_sprintf("%d", cnt);
5590 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5594 /* expand a named list given the name */
5595 /* handles nested named lists; requotes as colon-sep list */
5599 tree_node *t = NULL;
5603 uschar * suffix = "";
5604 BOOL needsep = FALSE;
5607 if (*sub == '+') sub++;
5608 if (arg == NULL) /* no-argument version */
5610 if (!(t = tree_search(addresslist_anchor, sub)) &&
5611 !(t = tree_search(domainlist_anchor, sub)) &&
5612 !(t = tree_search(hostlist_anchor, sub)))
5613 t = tree_search(localpartlist_anchor, sub);
5615 else switch(*arg) /* specific list-type version */
5617 case 'a': t = tree_search(addresslist_anchor, sub); suffix = "_a"; break;
5618 case 'd': t = tree_search(domainlist_anchor, sub); suffix = "_d"; break;
5619 case 'h': t = tree_search(hostlist_anchor, sub); suffix = "_h"; break;
5620 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = "_l"; break;
5622 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5628 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5630 : *arg=='a'?"address "
5631 : *arg=='d'?"domain "
5633 : *arg=='l'?"localpart "
5638 list = ((namedlist_block *)(t->data.ptr))->string;
5640 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5642 uschar * buf = US" : ";
5644 yield = string_cat(yield, &size, &ptr, buf, 3);
5648 if (*item == '+') /* list item is itself a named list */
5650 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5651 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE);
5653 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5657 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5658 while ((cp= strpbrk((const char *)item, tok)))
5660 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5661 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5663 yield = string_cat(yield, &size, &ptr, US"::", 2);
5666 else /* sep in item; should already be doubled; emit once */
5668 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5669 if (*cp == sep) cp++;
5674 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5679 /* mask applies a mask to an IP address; for example the result of
5680 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5687 int mask, maskoffset;
5688 int type = string_is_ip_address(sub, &maskoffset);
5693 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5698 if (maskoffset == 0)
5700 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5705 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5707 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5709 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5714 /* Convert the address to binary integer(s) and apply the mask */
5716 sub[maskoffset] = 0;
5717 count = host_aton(sub, binary);
5718 host_mask(count, binary, mask);
5720 /* Convert to masked textual format and add to output. */
5722 yield = string_cat(yield, &size, &ptr, buffer,
5723 host_nmtoa(count, binary, mask, buffer, '.'));
5728 case EOP_LOCAL_PART:
5732 int start, end, domain;
5733 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5737 if (c != EOP_DOMAIN)
5739 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5740 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5742 else if (domain != 0)
5745 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5753 uschar outsep[2] = { ':', '\0' };
5754 uschar *address, *error;
5756 int start, end, domain; /* Not really used */
5758 while (isspace(*sub)) sub++;
5759 if (*sub == '>') { *outsep = *++sub; ++sub; }
5760 parse_allow_group = TRUE;
5764 uschar *p = parse_find_address_end(sub, FALSE);
5765 uschar saveend = *p;
5767 address = parse_extract_address(sub, &error, &start, &end, &domain,
5771 /* Add the address to the output list that we are building. This is
5772 done in chunks by searching for the separator character. At the
5773 start, unless we are dealing with the first address of the output
5774 list, add in a space if the new address begins with the separator
5775 character, or is an empty string. */
5777 if (address != NULL)
5779 if (ptr != save_ptr && address[0] == *outsep)
5780 yield = string_cat(yield, &size, &ptr, US" ", 1);
5784 size_t seglen = Ustrcspn(address, outsep);
5785 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5787 /* If we got to the end of the string we output one character
5790 if (address[seglen] == '\0') { ptr--; break; }
5791 yield = string_cat(yield, &size, &ptr, outsep, 1);
5792 address += seglen + 1;
5795 /* Output a separator after the string: we will remove the
5796 redundant final one at the end. */
5798 yield = string_cat(yield, &size, &ptr, outsep, 1);
5801 if (saveend == '\0') break;
5805 /* If we have generated anything, remove the redundant final
5808 if (ptr != save_ptr) ptr--;
5809 parse_allow_group = FALSE;
5814 /* quote puts a string in quotes if it is empty or contains anything
5815 other than alphamerics, underscore, dot, or hyphen.
5817 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5818 be quoted in order to be a valid local part.
5820 In both cases, newlines and carriage returns are converted into \n and \r
5824 case EOP_QUOTE_LOCAL_PART:
5827 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5828 uschar *t = sub - 1;
5832 while (!needs_quote && *(++t) != 0)
5833 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5835 else /* EOP_QUOTE_LOCAL_PART */
5837 while (!needs_quote && *(++t) != 0)
5838 needs_quote = !isalnum(*t) &&
5839 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5840 (*t != '.' || t == sub || t[1] == 0);
5845 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5850 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5851 else if (*t == '\r')
5852 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5855 if (*t == '\\' || *t == '"')
5856 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5857 yield = string_cat(yield, &size, &ptr, t, 1);
5860 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5862 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5866 /* quote_lookuptype does lookup-specific quoting */
5871 uschar *opt = Ustrchr(arg, '_');
5873 if (opt != NULL) *opt++ = 0;
5875 n = search_findtype(arg, Ustrlen(arg));
5878 expand_string_message = search_error_message;
5882 if (lookup_list[n]->quote != NULL)
5883 sub = (lookup_list[n]->quote)(sub, opt);
5884 else if (opt != NULL) sub = NULL;
5888 expand_string_message = string_sprintf(
5889 "\"%s\" unrecognized after \"${quote_%s\"",
5894 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5898 /* rx quote sticks in \ before any non-alphameric character so that
5899 the insertion works in a regular expression. */
5903 uschar *t = sub - 1;
5907 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5908 yield = string_cat(yield, &size, &ptr, t, 1);
5913 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5914 prescribed by the RFC, if there are characters that need to be encoded */
5918 uschar buffer[2048];
5919 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5920 buffer, sizeof(buffer), FALSE);
5921 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5925 /* RFC 2047 decode */
5931 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5932 headers_charset, '?', &len, &error);
5935 expand_string_message = error;
5938 yield = string_cat(yield, &size, &ptr, decoded, len);
5942 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5952 if (c > 255) c = '_';
5954 yield = string_cat(yield, &size, &ptr, buff, 1);
5959 /* escape turns all non-printing characters into escape sequences. */
5963 uschar *t = string_printing(sub);
5964 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5968 /* Handle numeric expression evaluation */
5973 uschar *save_sub = sub;
5974 uschar *error = NULL;
5975 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5978 expand_string_message = string_sprintf("error in expression "
5979 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5983 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
5984 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5988 /* Handle time period formating */
5992 int n = readconf_readtime(sub, 0, FALSE);
5995 expand_string_message = string_sprintf("string \"%s\" is not an "
5996 "Exim time interval in \"%s\" operator", sub, name);
5999 sprintf(CS var_buffer, "%d", n);
6000 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6004 case EOP_TIME_INTERVAL:
6007 uschar *t = read_number(&n, sub);
6008 if (*t != 0) /* Not A Number*/
6010 expand_string_message = string_sprintf("string \"%s\" is not a "
6011 "positive number in \"%s\" operator", sub, name);
6014 t = readconf_printtime(n);
6015 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6019 /* Convert string to base64 encoding */
6023 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6024 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6028 /* strlen returns the length of the string */
6033 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6034 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6038 /* length_n or l_n takes just the first n characters or the whole string,
6039 whichever is the shorter;
6041 substr_m_n, and s_m_n take n characters from offset m; negative m take
6042 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6043 takes the rest, either to the right or to the left.
6045 hash_n or h_n makes a hash of length n from the string, yielding n
6046 characters from the set a-z; hash_n_m makes a hash of length n, but
6047 uses m characters from the set a-zA-Z0-9.
6049 nhash_n returns a single number between 0 and n-1 (in text form), while
6050 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6051 between 0 and n-1 and the second between 0 and m-1. */
6071 expand_string_message = string_sprintf("missing values after %s",
6076 /* "length" has only one argument, effectively being synonymous with
6079 if (c == EOP_LENGTH || c == EOP_L)
6085 /* The others have one or two arguments; for "substr" the first may be
6086 negative. The second being negative means "not supplied". */
6091 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6094 /* Read up to two numbers, separated by underscores */
6099 if (arg != ret && *arg == '_' && pn == &value1)
6103 if (arg[1] != 0) arg++;
6105 else if (!isdigit(*arg))
6107 expand_string_message =
6108 string_sprintf("non-digit after underscore in \"%s\"", name);
6111 else *pn = (*pn)*10 + *arg++ - '0';
6115 /* Perform the required operation */
6118 (c == EOP_HASH || c == EOP_H)?
6119 compute_hash(sub, value1, value2, &len) :
6120 (c == EOP_NHASH || c == EOP_NH)?
6121 compute_nhash(sub, value1, value2, &len) :
6122 extract_substr(sub, value1, value2, &len);
6124 if (ret == NULL) goto EXPAND_FAILED;
6125 yield = string_cat(yield, &size, &ptr, ret, len);
6135 uschar **modetable[3];
6140 if ((expand_forbid & RDO_EXISTS) != 0)
6142 expand_string_message = US"Use of the stat() expansion is not permitted";
6146 if (stat(CS sub, &st) < 0)
6148 expand_string_message = string_sprintf("stat(%s) failed: %s",
6149 sub, strerror(errno));
6153 switch (mode & S_IFMT)
6155 case S_IFIFO: smode[0] = 'p'; break;
6156 case S_IFCHR: smode[0] = 'c'; break;
6157 case S_IFDIR: smode[0] = 'd'; break;
6158 case S_IFBLK: smode[0] = 'b'; break;
6159 case S_IFREG: smode[0] = '-'; break;
6160 default: smode[0] = '?'; break;
6163 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6164 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6165 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6167 for (i = 0; i < 3; i++)
6169 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6174 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6175 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6176 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6177 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6178 (long)st.st_gid, st.st_size, (long)st.st_atime,
6179 (long)st.st_mtime, (long)st.st_ctime);
6180 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6184 /* vaguely random number less than N */
6188 int_eximarith_t max;
6191 max = expand_string_integer(sub, TRUE);
6192 if (expand_string_message != NULL)
6194 s = string_sprintf("%d", vaguely_random_number((int)max));
6195 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6199 /* Reverse IP, including IPv6 to dotted-nibble */
6201 case EOP_REVERSE_IP:
6203 int family, maskptr;
6204 uschar reversed[128];
6206 family = string_is_ip_address(sub, &maskptr);
6209 expand_string_message = string_sprintf(
6210 "reverse_ip() not given an IP address [%s]", sub);
6213 invert_address(reversed, sub);
6214 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6218 /* Unknown operator */
6221 expand_string_message =
6222 string_sprintf("unknown expansion operator \"%s\"", name);
6227 /* Handle a plain name. If this is the first thing in the expansion, release
6228 the pre-allocated buffer. If the result data is known to be in a new buffer,
6229 newsize will be set to the size of that buffer, and we can just point at that
6230 store instead of copying. Many expansion strings contain just one reference,
6231 so this is a useful optimization, especially for humungous headers
6232 ($message_headers). */
6240 if (resetok) store_reset(yield);
6244 value = find_variable(name, FALSE, skipping, &newsize);
6247 expand_string_message =
6248 string_sprintf("unknown variable in \"${%s}\"", name);
6249 check_variable_error_message(name);
6252 len = Ustrlen(value);
6253 if (yield == NULL && newsize != 0)
6259 else yield = string_cat(yield, &size, &ptr, value, len);
6263 /* Else there's something wrong */
6265 expand_string_message =
6266 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6267 "in a variable reference)", name);
6271 /* If we hit the end of the string when ket_ends is set, there is a missing
6272 terminating brace. */
6274 if (ket_ends && *s == 0)
6276 expand_string_message = malformed_header?
6277 US"missing } at end of string - could be header name not terminated by colon"
6279 US"missing } at end of string";
6283 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6284 added to the string. If so, set up an empty string. Add a terminating zero. If
6285 left != NULL, return a pointer to the terminator. */
6287 if (yield == NULL) yield = store_get(1);
6289 if (left != NULL) *left = s;
6291 /* Any stacking store that was used above the final string is no longer needed.
6292 In many cases the final string will be the first one that was got and so there
6293 will be optimal store usage. */
6295 if (resetok) store_reset(yield + ptr + 1);
6298 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6300 if (skipping) debug_printf("skipping: result is not used\n");
6304 /* This is the failure exit: easiest to program with a goto. We still need
6305 to update the pointer to the terminator, for cases of nested calls with "fail".
6308 EXPAND_FAILED_CURLY:
6309 expand_string_message = malformed_header?
6310 US"missing or misplaced { or } - could be header name not terminated by colon"
6312 US"missing or misplaced { or }";
6314 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6315 that is a bad idea, because expand_string_message is in dynamic store. */
6318 if (left != NULL) *left = s;
6321 debug_printf("failed to expand: %s\n", string);
6322 debug_printf(" error message: %s\n", expand_string_message);
6323 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6329 /* This is the external function call. Do a quick check for any expansion
6330 metacharacters, and if there are none, just return the input string.
6332 Argument: the string to be expanded
6333 Returns: the expanded string, or NULL if expansion failed; if failure was
6334 due to a lookup deferring, search_find_defer will be TRUE
6338 expand_string(uschar *string)
6340 search_find_defer = FALSE;
6341 malformed_header = FALSE;
6342 return (Ustrpbrk(string, "$\\") == NULL)? string :
6343 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6348 /*************************************************
6350 *************************************************/
6352 /* Now and again we want to expand a string and be sure that the result is in a
6353 new bit of store. This function does that.
6355 Argument: the string to be expanded
6356 Returns: the expanded string, always in a new bit of store, or NULL
6360 expand_string_copy(uschar *string)
6362 uschar *yield = expand_string(string);
6363 if (yield == string) yield = string_copy(string);
6369 /*************************************************
6370 * Expand and interpret as an integer *
6371 *************************************************/
6373 /* Expand a string, and convert the result into an integer.
6376 string the string to be expanded
6377 isplus TRUE if a non-negative number is expected
6379 Returns: the integer value, or
6380 -1 for an expansion error ) in both cases, message in
6381 -2 for an integer interpretation error ) expand_string_message
6382 expand_string_message is set NULL for an OK integer
6386 expand_string_integer(uschar *string, BOOL isplus)
6388 int_eximarith_t value;
6389 uschar *s = expand_string(string);
6390 uschar *msg = US"invalid integer \"%s\"";
6393 /* If expansion failed, expand_string_message will be set. */
6395 if (s == NULL) return -1;
6397 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6398 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6399 systems, so we set it zero ourselves. */
6402 expand_string_message = NULL; /* Indicates no error */
6404 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6405 equal to 0. Unfortunately, people actually relied upon that, so preserve
6406 the behaviour explicitly. Stripping leading whitespace is a harmless
6407 noop change since strtol skips it anyway (provided that there is a number
6411 while (isspace(*s)) ++s;
6415 debug_printf("treating blank string as number 0\n");
6420 value = strtoll(CS s, CSS &endptr, 10);
6424 msg = US"integer expected but \"%s\" found";
6426 else if (value < 0 && isplus)
6428 msg = US"non-negative integer expected but \"%s\" found";
6432 switch (tolower(*endptr))
6437 if (value > LLONG_MAX/1024 || value < LLONG_MIN/1024) errno = ERANGE;
6442 if (value > LLONG_MAX/(1024*1024) || value < LLONG_MIN/(1024*1024)) errno = ERANGE;
6443 else value *= 1024*1024;
6447 if (value > LLONG_MAX/(1024*1024*1024) || value < LLONG_MIN/(1024*1024*1024)) errno = ERANGE;
6448 else value *= 1024*1024*1024;
6452 if (errno == ERANGE)
6453 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6456 while (isspace(*endptr)) endptr++;
6457 if (*endptr == 0) return (int)value;
6461 expand_string_message = string_sprintf(CS msg, s);
6466 /*************************************************
6467 **************************************************
6468 * Stand-alone test program *
6469 **************************************************
6470 *************************************************/
6476 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6478 int ovector[3*(EXPAND_MAXN+1)];
6479 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6480 ovector, sizeof(ovector)/sizeof(int));
6481 BOOL yield = n >= 0;
6482 if (n == 0) n = EXPAND_MAXN + 1;
6486 expand_nmax = (setup < 0)? 0 : setup + 1;
6487 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6489 expand_nstring[expand_nmax] = subject + ovector[nn];
6490 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6498 int main(int argc, uschar **argv)
6501 uschar buffer[1024];
6503 debug_selector = D_v;
6504 debug_file = stderr;
6505 debug_fd = fileno(debug_file);
6506 big_buffer = malloc(big_buffer_size);
6508 for (i = 1; i < argc; i++)
6510 if (argv[i][0] == '+')
6512 debug_trace_memory = 2;
6515 if (isdigit(argv[i][0]))
6516 debug_selector = Ustrtol(argv[i], NULL, 0);
6518 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6522 eldap_default_servers = argv[i];
6525 mysql_servers = argv[i];
6528 pgsql_servers = argv[i];
6532 else opt_perl_startup = argv[i];
6536 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6538 expand_nstring[1] = US"string 1....";
6539 expand_nlength[1] = 8;
6543 if (opt_perl_startup != NULL)
6546 printf("Starting Perl interpreter\n");
6547 errstr = init_perl(opt_perl_startup);
6550 printf("** error in perl_startup code: %s\n", errstr);
6551 return EXIT_FAILURE;
6554 #endif /* EXIM_PERL */
6556 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6558 void *reset_point = store_get(0);
6559 uschar *yield = expand_string(buffer);
6562 printf("%s\n", yield);
6563 store_reset(reset_point);
6567 if (search_find_defer) printf("search_find deferred\n");
6568 printf("Failed: %s\n", expand_string_message);
6569 if (expand_string_forcedfail) printf("Forced failure\n");
6581 /* End of expand.c */