1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, BOOL);
19 #ifndef SUPPORT_CRYPTEQ
20 #define SUPPORT_CRYPTEQ
25 #include "lookups/ldap.h"
28 #ifdef SUPPORT_CRYPTEQ
33 extern char* crypt16(char*, char*);
37 /* The handling of crypt16() is a mess. I will record below the analysis of the
38 mess that was sent to me. We decided, however, to make changing this very low
39 priority, because in practice people are moving away from the crypt()
40 algorithms nowadays, so it doesn't seem worth it.
43 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
44 the first 8 characters of the password using a 20-round version of crypt
45 (standard crypt does 25 rounds). It then crypts the next 8 characters,
46 or an empty block if the password is less than 9 characters, using a
47 20-round version of crypt and the same salt as was used for the first
48 block. Charaters after the first 16 are ignored. It always generates
49 a 16-byte hash, which is expressed together with the salt as a string
50 of 24 base 64 digits. Here are some links to peruse:
52 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
53 http://seclists.org/bugtraq/1999/Mar/0076.html
55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
56 and OSF/1. This is the same as the standard crypt if given a password
57 of 8 characters or less. If given more, it first does the same as crypt
58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
59 using as salt the first two base 64 digits from the first hash block.
60 If the password is more than 16 characters then it crypts the 17th to 24th
61 characters using as salt the first two base 64 digits from the second hash
62 block. And so on: I've seen references to it cutting off the password at
63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0109.html
67 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
68 TET1_html/sec.c222.html#no_id_208
70 Exim has something it calls "crypt16". It will either use a native
71 crypt16 or its own implementation. A native crypt16 will presumably
72 be the one that I called "crypt16" above. The internal "crypt16"
73 function, however, is a two-block-maximum implementation of what I called
74 "bigcrypt". The documentation matches the internal code.
76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
77 that crypt16 and bigcrypt were different things.
79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
80 to whatever it is using under that name. This unfortunately sets a
81 precedent for using "{crypt16}" to identify two incompatible algorithms
82 whose output can't be distinguished. With "{crypt16}" thus rendered
83 ambiguous, I suggest you deprecate it and invent two new identifiers
84 for the two algorithms.
86 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
87 of the password separately means they can be cracked separately, so
88 the double-length hash only doubles the cracking effort instead of
89 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
150 /* Tables of operator names, and corresponding switch numbers. The names must be
151 in alphabetical order. There are two tables, because underscore is used in some
152 cases to introduce arguments, whereas for other it is part of the name. This is
153 an historical mis-design. */
155 static uschar *op_table_underscore[] = {
158 US"quote_local_part",
166 EOP_QUOTE_LOCAL_PART,
171 static uschar *op_table_main[] = {
207 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
242 /* Table of condition names, and corresponding switch numbers. The names must
243 be in alphabetical order. */
245 static uschar *cond_table[] = {
249 US"==", /* Backward compatibility */
282 US"match_local_part",
307 ECOND_FIRST_DELIVERY,
328 ECOND_MATCH_LOCAL_PART,
338 /* Type for main variable table */
346 /* Type for entries pointing to address/length pairs. Not currently
354 /* Types of table entry */
357 vtype_int, /* value is address of int */
358 vtype_filter_int, /* ditto, but recognized only when filtering */
359 vtype_ino, /* value is address of ino_t (not always an int) */
360 vtype_uid, /* value is address of uid_t (not always an int) */
361 vtype_gid, /* value is address of gid_t (not always an int) */
362 vtype_bool, /* value is address of bool */
363 vtype_stringptr, /* value is address of pointer to string */
364 vtype_msgbody, /* as stringptr, but read when first required */
365 vtype_msgbody_end, /* ditto, the end of the message */
366 vtype_msgheaders, /* the message's headers, processed */
367 vtype_msgheaders_raw, /* the message's headers, unprocessed */
368 vtype_localpart, /* extract local part from string */
369 vtype_domain, /* extract domain from string */
370 vtype_string_func, /* value is string returned by given function */
371 vtype_todbsdin, /* value not used; generate BSD inbox tod */
372 vtype_tode, /* value not used; generate tod in epoch format */
373 vtype_todel, /* value not used; generate tod in epoch/usec format */
374 vtype_todf, /* value not used; generate full tod */
375 vtype_todl, /* value not used; generate log tod */
376 vtype_todlf, /* value not used; generate log file datestamp tod */
377 vtype_todzone, /* value not used; generate time zone only */
378 vtype_todzulu, /* value not used; generate zulu tod */
379 vtype_reply, /* value not used; get reply from headers */
380 vtype_pid, /* value not used; result is pid */
381 vtype_host_lookup, /* value not used; get host name */
382 vtype_load_avg, /* value not used; result is int from os_getloadavg */
383 vtype_pspace, /* partition space; value is T/F for spool/log */
384 vtype_pinodes /* partition inodes; value is T/F for spool/log */
386 ,vtype_dkim /* Lookup of value in DKIM signature */
390 static uschar * fn_recipients(void);
392 /* This table must be kept in alphabetical order. */
394 static var_entry var_table[] = {
395 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
396 they will be confused with user-creatable ACL variables. */
397 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
398 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
399 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
400 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
401 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
402 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
403 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
404 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
405 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
406 { "acl_narg", vtype_int, &acl_narg },
407 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
408 { "address_data", vtype_stringptr, &deliver_address_data },
409 { "address_file", vtype_stringptr, &address_file },
410 { "address_pipe", vtype_stringptr, &address_pipe },
411 { "authenticated_id", vtype_stringptr, &authenticated_id },
412 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
413 { "authentication_failed",vtype_int, &authentication_failed },
414 #ifdef WITH_CONTENT_SCAN
415 { "av_failed", vtype_int, &av_failed },
417 #ifdef EXPERIMENTAL_BRIGHTMAIL
418 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
419 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
420 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
421 { "bmi_deliver", vtype_int, &bmi_deliver },
423 { "body_linecount", vtype_int, &body_linecount },
424 { "body_zerocount", vtype_int, &body_zerocount },
425 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
426 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
427 { "caller_gid", vtype_gid, &real_gid },
428 { "caller_uid", vtype_uid, &real_uid },
429 { "compile_date", vtype_stringptr, &version_date },
430 { "compile_number", vtype_stringptr, &version_cnumber },
431 { "csa_status", vtype_stringptr, &csa_status },
432 #ifdef EXPERIMENTAL_DCC
433 { "dcc_header", vtype_stringptr, &dcc_header },
434 { "dcc_result", vtype_stringptr, &dcc_result },
436 #ifdef WITH_OLD_DEMIME
437 { "demime_errorlevel", vtype_int, &demime_errorlevel },
438 { "demime_reason", vtype_stringptr, &demime_reason },
441 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
442 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
443 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
444 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
445 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
446 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
447 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
448 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
449 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
450 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
451 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
452 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
453 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
454 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
455 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
456 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
457 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
458 { "dkim_signers", vtype_stringptr, &dkim_signers },
459 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
460 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
462 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
463 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
464 { "dnslist_text", vtype_stringptr, &dnslist_text },
465 { "dnslist_value", vtype_stringptr, &dnslist_value },
466 { "domain", vtype_stringptr, &deliver_domain },
467 { "domain_data", vtype_stringptr, &deliver_domain_data },
468 { "exim_gid", vtype_gid, &exim_gid },
469 { "exim_path", vtype_stringptr, &exim_path },
470 { "exim_uid", vtype_uid, &exim_uid },
471 #ifdef WITH_OLD_DEMIME
472 { "found_extension", vtype_stringptr, &found_extension },
474 { "headers_added", vtype_string_func, &fn_hdrs_added },
475 { "home", vtype_stringptr, &deliver_home },
476 { "host", vtype_stringptr, &deliver_host },
477 { "host_address", vtype_stringptr, &deliver_host_address },
478 { "host_data", vtype_stringptr, &host_data },
479 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
480 { "host_lookup_failed", vtype_int, &host_lookup_failed },
481 { "inode", vtype_ino, &deliver_inode },
482 { "interface_address", vtype_stringptr, &interface_address },
483 { "interface_port", vtype_int, &interface_port },
484 { "item", vtype_stringptr, &iterate_item },
486 { "ldap_dn", vtype_stringptr, &eldap_dn },
488 { "load_average", vtype_load_avg, NULL },
489 { "local_part", vtype_stringptr, &deliver_localpart },
490 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
491 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
492 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
493 { "local_scan_data", vtype_stringptr, &local_scan_data },
494 { "local_user_gid", vtype_gid, &local_user_gid },
495 { "local_user_uid", vtype_uid, &local_user_uid },
496 { "localhost_number", vtype_int, &host_number },
497 { "log_inodes", vtype_pinodes, (void *)FALSE },
498 { "log_space", vtype_pspace, (void *)FALSE },
499 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
500 #ifdef WITH_CONTENT_SCAN
501 { "malware_name", vtype_stringptr, &malware_name },
503 { "max_received_linelength", vtype_int, &max_received_linelength },
504 { "message_age", vtype_int, &message_age },
505 { "message_body", vtype_msgbody, &message_body },
506 { "message_body_end", vtype_msgbody_end, &message_body_end },
507 { "message_body_size", vtype_int, &message_body_size },
508 { "message_exim_id", vtype_stringptr, &message_id },
509 { "message_headers", vtype_msgheaders, NULL },
510 { "message_headers_raw", vtype_msgheaders_raw, NULL },
511 { "message_id", vtype_stringptr, &message_id },
512 { "message_linecount", vtype_int, &message_linecount },
513 { "message_size", vtype_int, &message_size },
514 #ifdef WITH_CONTENT_SCAN
515 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
516 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
517 { "mime_boundary", vtype_stringptr, &mime_boundary },
518 { "mime_charset", vtype_stringptr, &mime_charset },
519 { "mime_content_description", vtype_stringptr, &mime_content_description },
520 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
521 { "mime_content_id", vtype_stringptr, &mime_content_id },
522 { "mime_content_size", vtype_int, &mime_content_size },
523 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
524 { "mime_content_type", vtype_stringptr, &mime_content_type },
525 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
526 { "mime_filename", vtype_stringptr, &mime_filename },
527 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
528 { "mime_is_multipart", vtype_int, &mime_is_multipart },
529 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
530 { "mime_part_count", vtype_int, &mime_part_count },
532 { "n0", vtype_filter_int, &filter_n[0] },
533 { "n1", vtype_filter_int, &filter_n[1] },
534 { "n2", vtype_filter_int, &filter_n[2] },
535 { "n3", vtype_filter_int, &filter_n[3] },
536 { "n4", vtype_filter_int, &filter_n[4] },
537 { "n5", vtype_filter_int, &filter_n[5] },
538 { "n6", vtype_filter_int, &filter_n[6] },
539 { "n7", vtype_filter_int, &filter_n[7] },
540 { "n8", vtype_filter_int, &filter_n[8] },
541 { "n9", vtype_filter_int, &filter_n[9] },
542 { "original_domain", vtype_stringptr, &deliver_domain_orig },
543 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
544 { "originator_gid", vtype_gid, &originator_gid },
545 { "originator_uid", vtype_uid, &originator_uid },
546 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
547 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
548 { "pid", vtype_pid, NULL },
549 { "primary_hostname", vtype_stringptr, &primary_hostname },
550 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
551 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
552 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
553 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
554 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
555 { "rcpt_count", vtype_int, &rcpt_count },
556 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
557 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
558 { "received_count", vtype_int, &received_count },
559 { "received_for", vtype_stringptr, &received_for },
560 { "received_ip_address", vtype_stringptr, &interface_address },
561 { "received_port", vtype_int, &interface_port },
562 { "received_protocol", vtype_stringptr, &received_protocol },
563 { "received_time", vtype_int, &received_time },
564 { "recipient_data", vtype_stringptr, &recipient_data },
565 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
566 { "recipients", vtype_string_func, &fn_recipients },
567 { "recipients_count", vtype_int, &recipients_count },
568 #ifdef WITH_CONTENT_SCAN
569 { "regex_match_string", vtype_stringptr, ®ex_match_string },
571 { "reply_address", vtype_reply, NULL },
572 { "return_path", vtype_stringptr, &return_path },
573 { "return_size_limit", vtype_int, &bounce_return_size_limit },
574 { "runrc", vtype_int, &runrc },
575 { "self_hostname", vtype_stringptr, &self_hostname },
576 { "sender_address", vtype_stringptr, &sender_address },
577 { "sender_address_data", vtype_stringptr, &sender_address_data },
578 { "sender_address_domain", vtype_domain, &sender_address },
579 { "sender_address_local_part", vtype_localpart, &sender_address },
580 { "sender_data", vtype_stringptr, &sender_data },
581 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
582 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
583 { "sender_host_address", vtype_stringptr, &sender_host_address },
584 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
585 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
586 { "sender_host_name", vtype_host_lookup, NULL },
587 { "sender_host_port", vtype_int, &sender_host_port },
588 { "sender_ident", vtype_stringptr, &sender_ident },
589 { "sender_rate", vtype_stringptr, &sender_rate },
590 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
591 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
592 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
593 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
594 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
595 { "sending_port", vtype_int, &sending_port },
596 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
597 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
598 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
599 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
600 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
601 { "sn0", vtype_filter_int, &filter_sn[0] },
602 { "sn1", vtype_filter_int, &filter_sn[1] },
603 { "sn2", vtype_filter_int, &filter_sn[2] },
604 { "sn3", vtype_filter_int, &filter_sn[3] },
605 { "sn4", vtype_filter_int, &filter_sn[4] },
606 { "sn5", vtype_filter_int, &filter_sn[5] },
607 { "sn6", vtype_filter_int, &filter_sn[6] },
608 { "sn7", vtype_filter_int, &filter_sn[7] },
609 { "sn8", vtype_filter_int, &filter_sn[8] },
610 { "sn9", vtype_filter_int, &filter_sn[9] },
611 #ifdef WITH_CONTENT_SCAN
612 { "spam_bar", vtype_stringptr, &spam_bar },
613 { "spam_report", vtype_stringptr, &spam_report },
614 { "spam_score", vtype_stringptr, &spam_score },
615 { "spam_score_int", vtype_stringptr, &spam_score_int },
617 #ifdef EXPERIMENTAL_SPF
618 { "spf_guess", vtype_stringptr, &spf_guess },
619 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
620 { "spf_received", vtype_stringptr, &spf_received },
621 { "spf_result", vtype_stringptr, &spf_result },
622 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
624 { "spool_directory", vtype_stringptr, &spool_directory },
625 { "spool_inodes", vtype_pinodes, (void *)TRUE },
626 { "spool_space", vtype_pspace, (void *)TRUE },
627 #ifdef EXPERIMENTAL_SRS
628 { "srs_db_address", vtype_stringptr, &srs_db_address },
629 { "srs_db_key", vtype_stringptr, &srs_db_key },
630 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
631 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
632 { "srs_recipient", vtype_stringptr, &srs_recipient },
633 { "srs_status", vtype_stringptr, &srs_status },
635 { "thisaddress", vtype_stringptr, &filter_thisaddress },
637 /* The non-(in,out) variables are now deprecated */
638 { "tls_bits", vtype_int, &tls_in.bits },
639 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
640 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
642 { "tls_in_bits", vtype_int, &tls_in.bits },
643 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
644 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
645 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
646 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
647 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
649 { "tls_out_bits", vtype_int, &tls_out.bits },
650 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
651 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
652 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
653 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
654 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
657 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
658 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
659 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
662 { "tod_bsdinbox", vtype_todbsdin, NULL },
663 { "tod_epoch", vtype_tode, NULL },
664 { "tod_epoch_l", vtype_todel, NULL },
665 { "tod_full", vtype_todf, NULL },
666 { "tod_log", vtype_todl, NULL },
667 { "tod_logfile", vtype_todlf, NULL },
668 { "tod_zone", vtype_todzone, NULL },
669 { "tod_zulu", vtype_todzulu, NULL },
670 { "value", vtype_stringptr, &lookup_value },
671 { "version_number", vtype_stringptr, &version_string },
672 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
673 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
674 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
675 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
676 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
677 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
680 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
681 static uschar var_buffer[256];
682 static BOOL malformed_header;
684 /* For textual hashes */
686 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
687 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
690 enum { HMAC_MD5, HMAC_SHA1 };
692 /* For numeric hashes */
694 static unsigned int prime[] = {
695 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
696 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
697 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
699 /* For printing modes in symbolic form */
701 static uschar *mtable_normal[] =
702 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
704 static uschar *mtable_setid[] =
705 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
707 static uschar *mtable_sticky[] =
708 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
712 /*************************************************
713 * Tables for UTF-8 support *
714 *************************************************/
716 /* Table of the number of extra characters, indexed by the first character
717 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
720 static uschar utf8_table1[] = {
721 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
722 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
723 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
724 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
726 /* These are the masks for the data bits in the first byte of a character,
727 indexed by the number of additional bytes. */
729 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
731 /* Get the next UTF-8 character, advancing the pointer. */
733 #define GETUTF8INC(c, ptr) \
735 if ((c & 0xc0) == 0xc0) \
737 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
739 c = (c & utf8_table2[a]) << s; \
743 c |= (*ptr++ & 0x3f) << s; \
748 /*************************************************
749 * Binary chop search on a table *
750 *************************************************/
752 /* This is used for matching expansion items and operators.
755 name the name that is being sought
756 table the table to search
757 table_size the number of items in the table
759 Returns: the offset in the table, or -1
763 chop_match(uschar *name, uschar **table, int table_size)
765 uschar **bot = table;
766 uschar **top = table + table_size;
770 uschar **mid = bot + (top - bot)/2;
771 int c = Ustrcmp(name, *mid);
772 if (c == 0) return mid - table;
773 if (c > 0) bot = mid + 1; else top = mid;
781 /*************************************************
782 * Check a condition string *
783 *************************************************/
785 /* This function is called to expand a string, and test the result for a "true"
786 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
787 forced fail or lookup defer.
789 We used to release all store used, but this is not not safe due
790 to ${dlfunc } and ${acl }. In any case expand_string_internal()
791 is reasonably careful to release what it can.
793 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
796 condition the condition string
797 m1 text to be incorporated in panic error
800 Returns: TRUE if condition is met, FALSE if not
804 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
807 uschar *ss = expand_string(condition);
810 if (!expand_string_forcedfail && !search_find_defer)
811 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
812 "for %s %s: %s", condition, m1, m2, expand_string_message);
815 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
816 strcmpic(ss, US"false") != 0;
823 /*************************************************
824 * Pseudo-random number generation *
825 *************************************************/
827 /* Pseudo-random number generation. The result is not "expected" to be
828 cryptographically strong but not so weak that someone will shoot themselves
829 in the foot using it as a nonce in some email header scheme or whatever
830 weirdness they'll twist this into. The result should ideally handle fork().
832 However, if we're stuck unable to provide this, then we'll fall back to
833 appallingly bad randomness.
835 If SUPPORT_TLS is defined then this will not be used except as an emergency
840 Returns a random number in range [0, max-1]
844 # define vaguely_random_number vaguely_random_number_fallback
847 vaguely_random_number(int max)
850 # undef vaguely_random_number
852 static pid_t pid = 0;
854 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
864 #ifdef HAVE_ARC4RANDOM
865 /* cryptographically strong randomness, common on *BSD platforms, not
866 so much elsewhere. Alas. */
868 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
869 #ifdef HAVE_SRANDOMDEV
870 /* uses random(4) for seeding */
873 gettimeofday(&tv, NULL);
874 srandom(tv.tv_sec | tv.tv_usec | getpid());
877 /* Poor randomness and no seeding here */
884 #ifdef HAVE_ARC4RANDOM
885 return arc4random() % max;
886 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
887 return random() % max;
889 /* This one returns a 16-bit number, definitely not crypto-strong */
890 return random_number(max);
897 /*************************************************
898 * Pick out a name from a string *
899 *************************************************/
901 /* If the name is too long, it is silently truncated.
904 name points to a buffer into which to put the name
905 max is the length of the buffer
906 s points to the first alphabetic character of the name
907 extras chars other than alphanumerics to permit
909 Returns: pointer to the first character after the name
911 Note: The test for *s != 0 in the while loop is necessary because
912 Ustrchr() yields non-NULL if the character is zero (which is not something
916 read_name(uschar *name, int max, uschar *s, uschar *extras)
919 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
921 if (ptr < max-1) name[ptr++] = *s;
930 /*************************************************
931 * Pick out the rest of a header name *
932 *************************************************/
934 /* A variable name starting $header_ (or just $h_ for those who like
935 abbreviations) might not be the complete header name because headers can
936 contain any printing characters in their names, except ':'. This function is
937 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
938 on the end, if the name was terminated by white space.
941 name points to a buffer in which the name read so far exists
942 max is the length of the buffer
943 s points to the first character after the name so far, i.e. the
944 first non-alphameric character after $header_xxxxx
946 Returns: a pointer to the first character after the header name
950 read_header_name(uschar *name, int max, uschar *s)
952 int prelen = Ustrchr(name, '_') - name + 1;
953 int ptr = Ustrlen(name) - prelen;
954 if (ptr > 0) memmove(name, name+prelen, ptr);
955 while (mac_isgraph(*s) && *s != ':')
957 if (ptr < max-1) name[ptr++] = *s;
968 /*************************************************
969 * Pick out a number from a string *
970 *************************************************/
973 n points to an integer into which to put the number
974 s points to the first digit of the number
976 Returns: a pointer to the character after the last digit
980 read_number(int *n, uschar *s)
983 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
989 /*************************************************
990 * Extract keyed subfield from a string *
991 *************************************************/
993 /* The yield is in dynamic store; NULL means that the key was not found.
996 key points to the name of the key
997 s points to the string from which to extract the subfield
999 Returns: NULL if the subfield was not found, or
1000 a pointer to the subfield's data
1004 expand_getkeyed(uschar *key, uschar *s)
1006 int length = Ustrlen(key);
1007 while (isspace(*s)) s++;
1009 /* Loop to search for the key */
1017 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1018 dkeylength = s - dkey;
1019 while (isspace(*s)) s++;
1020 if (*s == '=') while (isspace((*(++s))));
1022 data = string_dequote(&s);
1023 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1026 while (isspace(*s)) s++;
1035 /*************************************************
1036 * Extract numbered subfield from string *
1037 *************************************************/
1039 /* Extracts a numbered field from a string that is divided by tokens - for
1040 example a line from /etc/passwd is divided by colon characters. First field is
1041 numbered one. Negative arguments count from the right. Zero returns the whole
1042 string. Returns NULL if there are insufficient tokens in the string
1045 Modifies final argument - this is a dynamically generated string, so that's OK.
1048 field number of field to be extracted,
1049 first field = 1, whole string = 0, last field = -1
1050 separators characters that are used to break string into tokens
1051 s points to the string from which to extract the subfield
1053 Returns: NULL if the field was not found,
1054 a pointer to the field's data inside s (modified to add 0)
1058 expand_gettokened (int field, uschar *separators, uschar *s)
1063 uschar *fieldtext = NULL;
1065 if (field == 0) return s;
1067 /* Break the line up into fields in place; for field > 0 we stop when we have
1068 done the number of fields we want. For field < 0 we continue till the end of
1069 the string, counting the number of fields. */
1071 count = (field > 0)? field : INT_MAX;
1077 /* Previous field was the last one in the string. For a positive field
1078 number, this means there are not enough fields. For a negative field number,
1079 check that there are enough, and scan back to find the one that is wanted. */
1083 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1084 if ((-field) == (INT_MAX - count - 1)) return s;
1088 while (ss[-1] != 0) ss--;
1094 /* Previous field was not last in the string; save its start and put a
1098 len = Ustrcspn(ss, separators);
1109 /*************************************************
1110 * Extract a substring from a string *
1111 *************************************************/
1113 /* Perform the ${substr or ${length expansion operations.
1116 subject the input string
1117 value1 the offset from the start of the input string to the start of
1118 the output string; if negative, count from the right.
1119 value2 the length of the output string, or negative (-1) for unset
1120 if value1 is positive, unset means "all after"
1121 if value1 is negative, unset means "all before"
1122 len set to the length of the returned string
1124 Returns: pointer to the output string, or NULL if there is an error
1128 extract_substr(uschar *subject, int value1, int value2, int *len)
1130 int sublen = Ustrlen(subject);
1132 if (value1 < 0) /* count from right */
1136 /* If the position is before the start, skip to the start, and adjust the
1137 length. If the length ends up negative, the substring is null because nothing
1138 can precede. This falls out naturally when the length is unset, meaning "all
1144 if (value2 < 0) value2 = 0;
1148 /* Otherwise an unset length => characters before value1 */
1150 else if (value2 < 0)
1157 /* For a non-negative offset, if the starting position is past the end of the
1158 string, the result will be the null string. Otherwise, an unset length means
1159 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1163 if (value1 > sublen)
1168 else if (value2 < 0) value2 = sublen;
1171 /* Cut the length down to the maximum possible for the offset value, and get
1172 the required characters. */
1174 if (value1 + value2 > sublen) value2 = sublen - value1;
1176 return subject + value1;
1182 /*************************************************
1183 * Old-style hash of a string *
1184 *************************************************/
1186 /* Perform the ${hash expansion operation.
1189 subject the input string (an expanded substring)
1190 value1 the length of the output string; if greater or equal to the
1191 length of the input string, the input string is returned
1192 value2 the number of hash characters to use, or 26 if negative
1193 len set to the length of the returned string
1195 Returns: pointer to the output string, or NULL if there is an error
1199 compute_hash(uschar *subject, int value1, int value2, int *len)
1201 int sublen = Ustrlen(subject);
1203 if (value2 < 0) value2 = 26;
1204 else if (value2 > Ustrlen(hashcodes))
1206 expand_string_message =
1207 string_sprintf("hash count \"%d\" too big", value2);
1211 /* Calculate the hash text. We know it is shorter than the original string, so
1212 can safely place it in subject[] (we know that subject is always itself an
1213 expanded substring). */
1215 if (value1 < sublen)
1220 while ((c = (subject[j])) != 0)
1222 int shift = (c + j++) & 7;
1223 subject[i] ^= (c << shift) | (c >> (8-shift));
1224 if (++i >= value1) i = 0;
1226 for (i = 0; i < value1; i++)
1227 subject[i] = hashcodes[(subject[i]) % value2];
1229 else value1 = sublen;
1238 /*************************************************
1239 * Numeric hash of a string *
1240 *************************************************/
1242 /* Perform the ${nhash expansion operation. The first characters of the
1243 string are treated as most important, and get the highest prime numbers.
1246 subject the input string
1247 value1 the maximum value of the first part of the result
1248 value2 the maximum value of the second part of the result,
1249 or negative to produce only a one-part result
1250 len set to the length of the returned string
1252 Returns: pointer to the output string, or NULL if there is an error.
1256 compute_nhash (uschar *subject, int value1, int value2, int *len)
1258 uschar *s = subject;
1260 unsigned long int total = 0; /* no overflow */
1264 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1265 total += prime[i--] * (unsigned int)(*s++);
1268 /* If value2 is unset, just compute one number */
1272 s = string_sprintf("%d", total % value1);
1275 /* Otherwise do a div/mod hash */
1279 total = total % (value1 * value2);
1280 s = string_sprintf("%d/%d", total/value2, total % value2);
1291 /*************************************************
1292 * Find the value of a header or headers *
1293 *************************************************/
1295 /* Multiple instances of the same header get concatenated, and this function
1296 can also return a concatenation of all the header lines. When concatenating
1297 specific headers that contain lists of addresses, a comma is inserted between
1298 them. Otherwise we use a straight concatenation. Because some messages can have
1299 pathologically large number of lines, there is a limit on the length that is
1300 returned. Also, to avoid massive store use which would result from using
1301 string_cat() as it copies and extends strings, we do a preliminary pass to find
1302 out exactly how much store will be needed. On "normal" messages this will be
1306 name the name of the header, without the leading $header_ or $h_,
1307 or NULL if a concatenation of all headers is required
1308 exists_only TRUE if called from a def: test; don't need to build a string;
1309 just return a string that is not "" and not "0" if the header
1311 newsize return the size of memory block that was obtained; may be NULL
1312 if exists_only is TRUE
1313 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1314 other than concatenating, will be done on the header. Also used
1315 for $message_headers_raw.
1316 charset name of charset to translate MIME words to; used only if
1317 want_raw is false; if NULL, no translation is done (this is
1318 used for $bh_ and $bheader_)
1320 Returns: NULL if the header does not exist, else a pointer to a new
1325 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1328 BOOL found = name == NULL;
1330 int len = found? 0 : Ustrlen(name);
1332 uschar *yield = NULL;
1335 /* Loop for two passes - saves code repetition */
1337 for (i = 0; i < 2; i++)
1342 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1344 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1346 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1351 if (exists_only) return US"1"; /* don't need actual string */
1353 t = h->text + len; /* text to insert */
1354 if (!want_raw) /* unless wanted raw, */
1355 while (isspace(*t)) t++; /* remove leading white space */
1356 ilen = h->slen - (t - h->text); /* length to insert */
1358 /* Unless wanted raw, remove trailing whitespace, including the
1362 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1364 /* Set comma = 1 if handling a single header and it's one of those
1365 that contains an address list, except when asked for raw headers. Only
1366 need to do this once. */
1368 if (!want_raw && name != NULL && comma == 0 &&
1369 Ustrchr("BCFRST", h->type) != NULL)
1372 /* First pass - compute total store needed; second pass - compute
1373 total store used, including this header. */
1375 size += ilen + comma + 1; /* +1 for the newline */
1377 /* Second pass - concatentate the data, up to a maximum. Note that
1378 the loop stops when size hits the limit. */
1382 if (size > header_insert_maxlen)
1384 ilen -= size - header_insert_maxlen - 1;
1387 Ustrncpy(ptr, t, ilen);
1390 /* For a non-raw header, put in the comma if needed, then add
1391 back the newline we removed above, provided there was some text in
1394 if (!want_raw && ilen > 0)
1396 if (comma != 0) *ptr++ = ',';
1404 /* At end of first pass, return NULL if no header found. Then truncate size
1405 if necessary, and get the buffer to hold the data, returning the buffer size.
1410 if (!found) return NULL;
1411 if (size > header_insert_maxlen) size = header_insert_maxlen;
1412 *newsize = size + 1;
1413 ptr = yield = store_get(*newsize);
1417 /* That's all we do for raw header expansion. */
1424 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1425 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1426 function can return an error with decoded data if the charset translation
1427 fails. If decoding fails, it returns NULL. */
1431 uschar *decoded, *error;
1432 if (ptr > yield && ptr[-1] == '\n') ptr--;
1433 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1435 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1439 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1440 " input was: %s\n", error, yield);
1442 if (decoded != NULL) yield = decoded;
1451 /*************************************************
1452 * Return list of recipients *
1453 *************************************************/
1454 /* A recipients list is available only during system message filtering,
1455 during ACL processing after DATA, and while expanding pipe commands
1456 generated from a system filter, but not elsewhere. */
1461 if (!enable_dollar_recipients) return NULL; else
1466 uschar * s = store_get(size);
1467 for (i = 0; i < recipients_count; i++)
1469 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1470 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1471 Ustrlen(recipients_list[i].address));
1473 s[ptr] = 0; /* string_cat() leaves room */
1479 /*************************************************
1480 * Find value of a variable *
1481 *************************************************/
1483 /* The table of variables is kept in alphabetic order, so we can search it
1484 using a binary chop. The "choplen" variable is nothing to do with the binary
1488 name the name of the variable being sought
1489 exists_only TRUE if this is a def: test; passed on to find_header()
1490 skipping TRUE => skip any processing evaluation; this is not the same as
1491 exists_only because def: may test for values that are first
1493 newsize pointer to an int which is initially zero; if the answer is in
1494 a new memory buffer, *newsize is set to its size
1496 Returns: NULL if the variable does not exist, or
1497 a pointer to the variable's contents, or
1498 something non-NULL if exists_only is TRUE
1502 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1505 int last = var_table_size;
1507 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1508 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1509 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1510 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1511 (this gave backwards compatibility at the changeover). There may be built-in
1512 variables whose names start acl_ but they should never start in this way. This
1513 slightly messy specification is a consequence of the history, needless to say.
1515 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1516 set, in which case give an error. */
1518 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1522 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1523 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1526 /* Handle $auth<n> variables. */
1528 if (Ustrncmp(name, "auth", 4) == 0)
1531 int n = Ustrtoul(name + 4, &endptr, 10);
1532 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1533 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1536 /* For all other variables, search the table */
1538 while (last > first)
1542 int middle = (first + last)/2;
1543 int c = Ustrcmp(name, var_table[middle].name);
1545 if (c > 0) { first = middle + 1; continue; }
1546 if (c < 0) { last = middle; continue; }
1548 /* Found an existing variable. If in skipping state, the value isn't needed,
1549 and we want to avoid processing (such as looking up the host name). */
1551 if (skipping) return US"";
1553 switch (var_table[middle].type)
1555 case vtype_filter_int:
1556 if (!filter_running) return NULL;
1560 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1564 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1568 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1572 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1576 sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1579 case vtype_stringptr: /* Pointer to string */
1580 s = *((uschar **)(var_table[middle].value));
1581 return (s == NULL)? US"" : s;
1584 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1587 case vtype_load_avg:
1588 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1591 case vtype_host_lookup: /* Lookup if not done so */
1592 if (sender_host_name == NULL && sender_host_address != NULL &&
1593 !host_lookup_failed && host_name_lookup() == OK)
1594 host_build_sender_fullhost();
1595 return (sender_host_name == NULL)? US"" : sender_host_name;
1597 case vtype_localpart: /* Get local part from address */
1598 s = *((uschar **)(var_table[middle].value));
1599 if (s == NULL) return US"";
1600 domain = Ustrrchr(s, '@');
1601 if (domain == NULL) return s;
1602 if (domain - s > sizeof(var_buffer) - 1)
1603 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1604 " in string expansion", sizeof(var_buffer));
1605 Ustrncpy(var_buffer, s, domain - s);
1606 var_buffer[domain - s] = 0;
1609 case vtype_domain: /* Get domain from address */
1610 s = *((uschar **)(var_table[middle].value));
1611 if (s == NULL) return US"";
1612 domain = Ustrrchr(s, '@');
1613 return (domain == NULL)? US"" : domain + 1;
1615 case vtype_msgheaders:
1616 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1618 case vtype_msgheaders_raw:
1619 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1621 case vtype_msgbody: /* Pointer to msgbody string */
1622 case vtype_msgbody_end: /* Ditto, the end of the msg */
1623 ss = (uschar **)(var_table[middle].value);
1624 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1627 off_t start_offset = SPOOL_DATA_START_OFFSET;
1628 int len = message_body_visible;
1629 if (len > message_size) len = message_size;
1630 *ss = body = store_malloc(len+1);
1632 if (var_table[middle].type == vtype_msgbody_end)
1634 struct stat statbuf;
1635 if (fstat(deliver_datafile, &statbuf) == 0)
1637 start_offset = statbuf.st_size - len;
1638 if (start_offset < SPOOL_DATA_START_OFFSET)
1639 start_offset = SPOOL_DATA_START_OFFSET;
1642 lseek(deliver_datafile, start_offset, SEEK_SET);
1643 len = read(deliver_datafile, body, len);
1647 if (message_body_newlines) /* Separate loops for efficiency */
1650 { if (body[--len] == 0) body[len] = ' '; }
1655 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1659 return (*ss == NULL)? US"" : *ss;
1661 case vtype_todbsdin: /* BSD inbox time of day */
1662 return tod_stamp(tod_bsdin);
1664 case vtype_tode: /* Unix epoch time of day */
1665 return tod_stamp(tod_epoch);
1667 case vtype_todel: /* Unix epoch/usec time of day */
1668 return tod_stamp(tod_epoch_l);
1670 case vtype_todf: /* Full time of day */
1671 return tod_stamp(tod_full);
1673 case vtype_todl: /* Log format time of day */
1674 return tod_stamp(tod_log_bare); /* (without timezone) */
1676 case vtype_todzone: /* Time zone offset only */
1677 return tod_stamp(tod_zone);
1679 case vtype_todzulu: /* Zulu time */
1680 return tod_stamp(tod_zulu);
1682 case vtype_todlf: /* Log file datestamp tod */
1683 return tod_stamp(tod_log_datestamp_daily);
1685 case vtype_reply: /* Get reply address */
1686 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1688 if (s != NULL) while (isspace(*s)) s++;
1689 if (s == NULL || *s == 0)
1691 *newsize = 0; /* For the *s==0 case */
1692 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1697 while (isspace(*s)) s++;
1698 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1699 while (t > s && isspace(t[-1])) t--;
1702 return (s == NULL)? US"" : s;
1704 case vtype_string_func:
1706 uschar * (*fn)() = var_table[middle].value;
1713 sprintf(CS var_buffer, "%d",
1714 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1721 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1722 sprintf(CS var_buffer, "%d", inodes);
1726 #ifndef DISABLE_DKIM
1728 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1734 return NULL; /* Unknown variable name */
1741 modify_variable(uschar *name, void * value)
1744 int last = var_table_size;
1746 while (last > first)
1748 int middle = (first + last)/2;
1749 int c = Ustrcmp(name, var_table[middle].name);
1751 if (c > 0) { first = middle + 1; continue; }
1752 if (c < 0) { last = middle; continue; }
1754 /* Found an existing variable; change the item it refers to */
1755 var_table[middle].value = value;
1758 return; /* Unknown variable name, fail silently */
1765 /*************************************************
1766 * Read and expand substrings *
1767 *************************************************/
1769 /* This function is called to read and expand argument substrings for various
1770 expansion items. Some have a minimum requirement that is less than the maximum;
1771 in these cases, the first non-present one is set to NULL.
1774 sub points to vector of pointers to set
1775 n maximum number of substrings
1777 sptr points to current string pointer
1778 skipping the skipping flag
1779 check_end if TRUE, check for final '}'
1780 name name of item, for error message
1782 Returns: 0 OK; string pointer updated
1783 1 curly bracketing error (too few arguments)
1784 2 too many arguments (only if check_end is set); message set
1785 3 other error (expansion failure)
1789 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1790 BOOL check_end, uschar *name)
1795 while (isspace(*s)) s++;
1796 for (i = 0; i < n; i++)
1800 if (i < m) return 1;
1804 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1805 if (sub[i] == NULL) return 3;
1806 if (*s++ != '}') return 1;
1807 while (isspace(*s)) s++;
1809 if (check_end && *s++ != '}')
1813 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1814 "(max is %d)", name, n);
1827 /*************************************************
1828 * Elaborate message for bad variable *
1829 *************************************************/
1831 /* For the "unknown variable" message, take a look at the variable's name, and
1832 give additional information about possible ACL variables. The extra information
1833 is added on to expand_string_message.
1835 Argument: the name of the variable
1840 check_variable_error_message(uschar *name)
1842 if (Ustrncmp(name, "acl_", 4) == 0)
1843 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1844 (name[4] == 'c' || name[4] == 'm')?
1846 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1847 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1849 US"user-defined ACL variables must start acl_c or acl_m");
1855 Load args from sub array to globals, and call acl_check().
1856 Sub array will be corrupted on return.
1858 Returns: OK access is granted by an ACCEPT verb
1859 DISCARD access is granted by a DISCARD verb
1860 FAIL access is denied
1861 FAIL_DROP access is denied; drop the connection
1862 DEFER can't tell at the moment
1866 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
1870 int sav_narg = acl_narg;
1873 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
1874 for (i = 0; i < nsub && sub[i+1]; i++)
1877 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
1878 sub[i+1] = tmp; /* stash the old args using our caller's storage */
1883 sub[i+1] = acl_arg[i];
1884 acl_arg[i++] = NULL;
1888 debug_printf("expanding: acl: %s arg: %s%s\n",
1890 acl_narg>0 ? sub[1] : US"<none>",
1891 acl_narg>1 ? " +more" : "");
1893 ret = acl_check(ACL_WHERE_EXPANSION, NULL, sub[0], user_msgp, &tmp);
1895 for (i = 0; i < nsub; i++)
1896 acl_arg[i] = sub[i+1]; /* restore old args */
1897 acl_narg = sav_narg;
1905 /*************************************************
1906 * Read and evaluate a condition *
1907 *************************************************/
1911 s points to the start of the condition text
1912 yield points to a BOOL to hold the result of the condition test;
1913 if NULL, we are just reading through a condition that is
1914 part of an "or" combination to check syntax, or in a state
1915 where the answer isn't required
1917 Returns: a pointer to the first character after the condition, or
1922 eval_condition(uschar *s, BOOL *yield)
1924 BOOL testfor = TRUE;
1925 BOOL tempcond, combined_cond;
1927 BOOL sub2_honour_dollar = TRUE;
1928 int i, rc, cond_type, roffset;
1929 int_eximarith_t num[2];
1930 struct stat statbuf;
1935 const uschar *rerror;
1939 while (isspace(*s)) s++;
1940 if (*s == '!') { testfor = !testfor; s++; } else break;
1943 /* Numeric comparisons are symbolic */
1945 if (*s == '=' || *s == '>' || *s == '<')
1957 /* All other conditions are named */
1959 else s = read_name(name, 256, s, US"_");
1961 /* If we haven't read a name, it means some non-alpha character is first. */
1965 expand_string_message = string_sprintf("condition name expected, "
1966 "but found \"%.16s\"", s);
1970 /* Find which condition we are dealing with, and switch on it */
1972 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1975 /* def: tests for a non-empty variable, or for the existence of a header. If
1976 yield == NULL we are in a skipping state, and don't care about the answer. */
1981 expand_string_message = US"\":\" expected after \"def\"";
1985 s = read_name(name, 256, s+1, US"_");
1987 /* Test for a header's existence. If the name contains a closing brace
1988 character, this may be a user error where the terminating colon has been
1989 omitted. Set a flag to adjust a subsequent error message in this case. */
1991 if (Ustrncmp(name, "h_", 2) == 0 ||
1992 Ustrncmp(name, "rh_", 3) == 0 ||
1993 Ustrncmp(name, "bh_", 3) == 0 ||
1994 Ustrncmp(name, "header_", 7) == 0 ||
1995 Ustrncmp(name, "rheader_", 8) == 0 ||
1996 Ustrncmp(name, "bheader_", 8) == 0)
1998 s = read_header_name(name, 256, s);
1999 /* {-for-text-editors */
2000 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2001 if (yield != NULL) *yield =
2002 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2005 /* Test for a variable's having a non-empty value. A non-existent variable
2006 causes an expansion failure. */
2010 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2013 expand_string_message = (name[0] == 0)?
2014 string_sprintf("variable name omitted after \"def:\"") :
2015 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2016 check_variable_error_message(name);
2019 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2025 /* first_delivery tests for first delivery attempt */
2027 case ECOND_FIRST_DELIVERY:
2028 if (yield != NULL) *yield = deliver_firsttime == testfor;
2032 /* queue_running tests for any process started by a queue runner */
2034 case ECOND_QUEUE_RUNNING:
2035 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2039 /* exists: tests for file existence
2040 isip: tests for any IP address
2041 isip4: tests for an IPv4 address
2042 isip6: tests for an IPv6 address
2043 pam: does PAM authentication
2044 radius: does RADIUS authentication
2045 ldapauth: does LDAP authentication
2046 pwcheck: does Cyrus SASL pwcheck authentication
2055 case ECOND_LDAPAUTH:
2058 while (isspace(*s)) s++;
2059 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2061 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
2062 if (sub[0] == NULL) return NULL;
2063 /* {-for-text-editors */
2064 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2066 if (yield == NULL) return s; /* No need to run the test if skipping */
2071 if ((expand_forbid & RDO_EXISTS) != 0)
2073 expand_string_message = US"File existence tests are not permitted";
2076 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2082 rc = string_is_ip_address(sub[0], NULL);
2083 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2084 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2087 /* Various authentication tests - all optionally compiled */
2091 rc = auth_call_pam(sub[0], &expand_string_message);
2094 goto COND_FAILED_NOT_COMPILED;
2095 #endif /* SUPPORT_PAM */
2098 #ifdef RADIUS_CONFIG_FILE
2099 rc = auth_call_radius(sub[0], &expand_string_message);
2102 goto COND_FAILED_NOT_COMPILED;
2103 #endif /* RADIUS_CONFIG_FILE */
2105 case ECOND_LDAPAUTH:
2108 /* Just to keep the interface the same */
2110 int old_pool = store_pool;
2111 store_pool = POOL_SEARCH;
2112 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2113 &expand_string_message, &do_cache);
2114 store_pool = old_pool;
2118 goto COND_FAILED_NOT_COMPILED;
2119 #endif /* LOOKUP_LDAP */
2122 #ifdef CYRUS_PWCHECK_SOCKET
2123 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2126 goto COND_FAILED_NOT_COMPILED;
2127 #endif /* CYRUS_PWCHECK_SOCKET */
2129 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2130 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2132 if (rc == ERROR || rc == DEFER) return NULL;
2133 *yield = (rc == OK) == testfor;
2139 /* call ACL (in a conditional context). Accept true, deny false.
2140 Defer is a forced-fail. Anything set by message= goes to $value.
2141 Up to ten parameters are used; we use the braces round the name+args
2142 like the saslauthd condition does, to permit a variable number of args.
2143 See also the expansion-item version EITEM_ACL and the traditional
2144 acl modifier ACLC_ACL.
2148 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2155 while (isspace(*s)) s++;
2156 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2158 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2159 &s, yield == NULL, TRUE, US"acl"))
2161 case 1: expand_string_message = US"too few arguments or bracketing "
2164 case 3: return NULL;
2167 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2172 lookup_value = NULL;
2175 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2176 lookup_value[ptr] = '\0';
2178 *yield = cond == testfor;
2182 expand_string_forcedfail = TRUE;
2184 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2191 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2193 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
2195 However, the last two are optional. That is why the whole set is enclosed
2196 in their own set of braces. */
2198 case ECOND_SASLAUTHD:
2199 #ifndef CYRUS_SASLAUTHD_SOCKET
2200 goto COND_FAILED_NOT_COMPILED;
2202 while (isspace(*s)) s++;
2203 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2204 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2206 case 1: expand_string_message = US"too few arguments or bracketing "
2207 "error for saslauthd";
2209 case 3: return NULL;
2211 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2215 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2216 &expand_string_message);
2217 if (rc == ERROR || rc == DEFER) return NULL;
2218 *yield = (rc == OK) == testfor;
2221 #endif /* CYRUS_SASLAUTHD_SOCKET */
2224 /* symbolic operators for numeric and string comparison, and a number of
2225 other operators, all requiring two arguments.
2227 crypteq: encrypts plaintext and compares against an encrypted text,
2228 using crypt(), crypt16(), MD5 or SHA-1
2229 inlist/inlisti: checks if first argument is in the list of the second
2230 match: does a regular expression match and sets up the numerical
2231 variables if it succeeds
2232 match_address: matches in an address list
2233 match_domain: matches in a domain list
2234 match_ip: matches a host list that is restricted to IP addresses
2235 match_local_part: matches in a local part list
2238 case ECOND_MATCH_ADDRESS:
2239 case ECOND_MATCH_DOMAIN:
2240 case ECOND_MATCH_IP:
2241 case ECOND_MATCH_LOCAL_PART:
2242 #ifndef EXPAND_LISTMATCH_RHS
2243 sub2_honour_dollar = FALSE;
2252 case ECOND_NUM_L: /* Numerical comparisons */
2259 case ECOND_STR_LT: /* String comparisons */
2270 for (i = 0; i < 2; i++)
2272 /* Sometimes, we don't expand substrings; too many insecure configurations
2273 created using match_address{}{} and friends, where the second param
2274 includes information from untrustworthy sources. */
2275 BOOL honour_dollar = TRUE;
2276 if ((i > 0) && !sub2_honour_dollar)
2277 honour_dollar = FALSE;
2279 while (isspace(*s)) s++;
2282 if (i == 0) goto COND_FAILED_CURLY_START;
2283 expand_string_message = string_sprintf("missing 2nd string in {} "
2284 "after \"%s\"", name);
2287 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2289 if (sub[i] == NULL) return NULL;
2290 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2292 /* Convert to numerical if required; we know that the names of all the
2293 conditions that compare numbers do not start with a letter. This just saves
2294 checking for them individually. */
2296 if (!isalpha(name[0]) && yield != NULL)
2302 debug_printf("empty string cast to zero for numerical comparison\n");
2306 num[i] = expand_string_integer(sub[i], FALSE);
2307 if (expand_string_message != NULL) return NULL;
2312 /* Result not required */
2314 if (yield == NULL) return s;
2316 /* Do an appropriate comparison */
2322 tempcond = (num[0] == num[1]);
2326 tempcond = (num[0] > num[1]);
2330 tempcond = (num[0] >= num[1]);
2334 tempcond = (num[0] < num[1]);
2338 tempcond = (num[0] <= num[1]);
2342 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2346 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2350 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2354 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2358 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2362 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2366 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2370 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2374 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2378 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2381 case ECOND_MATCH: /* Regular expression match */
2382 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2386 expand_string_message = string_sprintf("regular expression error in "
2387 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2390 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2393 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2394 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2395 goto MATCHED_SOMETHING;
2397 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2398 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2399 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2400 goto MATCHED_SOMETHING;
2402 case ECOND_MATCH_IP: /* Match IP address in a host list */
2403 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2405 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2411 unsigned int *nullcache = NULL;
2412 check_host_block cb;
2414 cb.host_name = US"";
2415 cb.host_address = sub[0];
2417 /* If the host address starts off ::ffff: it is an IPv6 address in
2418 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2421 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2422 cb.host_address + 7 : cb.host_address;
2424 rc = match_check_list(
2425 &sub[1], /* the list */
2426 0, /* separator character */
2427 &hostlist_anchor, /* anchor pointer */
2428 &nullcache, /* cache pointer */
2429 check_host, /* function for testing */
2430 &cb, /* argument for function */
2431 MCL_HOST, /* type of check */
2432 sub[0], /* text for debugging */
2433 NULL); /* where to pass back data */
2435 goto MATCHED_SOMETHING;
2437 case ECOND_MATCH_LOCAL_PART:
2438 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2439 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2454 expand_string_message = string_sprintf("unable to complete match "
2455 "against \"%s\": %s", sub[1], search_error_message);
2461 /* Various "encrypted" comparisons. If the second string starts with
2462 "{" then an encryption type is given. Default to crypt() or crypt16()
2463 (build-time choice). */
2464 /* }-for-text-editors */
2467 #ifndef SUPPORT_CRYPTEQ
2468 goto COND_FAILED_NOT_COMPILED;
2470 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2472 int sublen = Ustrlen(sub[1]+5);
2477 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2479 /* If the length that we are comparing against is 24, the MD5 digest
2480 is expressed as a base64 string. This is the way LDAP does it. However,
2481 some other software uses a straightforward hex representation. We assume
2482 this if the length is 32. Other lengths fail. */
2486 uschar *coded = auth_b64encode((uschar *)digest, 16);
2487 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2488 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2489 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2491 else if (sublen == 32)
2495 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2497 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2498 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2499 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2503 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2504 "fail\n crypted=%s\n", sub[1]+5);
2509 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2511 int sublen = Ustrlen(sub[1]+6);
2516 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2518 /* If the length that we are comparing against is 28, assume the SHA1
2519 digest is expressed as a base64 string. If the length is 40, assume a
2520 straightforward hex representation. Other lengths fail. */
2524 uschar *coded = auth_b64encode((uschar *)digest, 20);
2525 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2526 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2527 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2529 else if (sublen == 40)
2533 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2535 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2536 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2537 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2541 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2542 "fail\n crypted=%s\n", sub[1]+6);
2547 else /* {crypt} or {crypt16} and non-{ at start */
2548 /* }-for-text-editors */
2553 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2558 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2563 else if (sub[1][0] == '{') /* }-for-text-editors */
2565 expand_string_message = string_sprintf("unknown encryption mechanism "
2566 "in \"%s\"", sub[1]);
2572 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2573 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2574 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2578 #define XSTR(s) STR(s)
2579 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2580 " subject=%s\n crypted=%s\n",
2581 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2586 /* If the encrypted string contains fewer than two characters (for the
2587 salt), force failure. Otherwise we get false positives: with an empty
2588 string the yield of crypt() is an empty string! */
2590 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2591 (Ustrcmp(coded, sub[1]) == 0);
2594 #endif /* SUPPORT_CRYPTEQ */
2600 uschar *save_iterate_item = iterate_item;
2601 int (*compare)(const uschar *, const uschar *);
2604 if (cond_type == ECOND_INLISTI)
2607 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2609 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2610 if (compare(sub[0], iterate_item) == 0)
2615 iterate_item = save_iterate_item;
2618 } /* Switch for comparison conditions */
2620 *yield = tempcond == testfor;
2621 return s; /* End of comparison conditions */
2624 /* and/or: computes logical and/or of several conditions */
2628 subcondptr = (yield == NULL)? NULL : &tempcond;
2629 combined_cond = (cond_type == ECOND_AND);
2631 while (isspace(*s)) s++;
2632 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2636 while (isspace(*s)) s++;
2637 /* {-for-text-editors */
2638 if (*s == '}') break;
2639 if (*s != '{') /* }-for-text-editors */
2641 expand_string_message = string_sprintf("each subcondition "
2642 "inside an \"%s{...}\" condition must be in its own {}", name);
2646 s = eval_condition(s+1, subcondptr);
2649 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2650 expand_string_message, name);
2653 while (isspace(*s)) s++;
2655 /* {-for-text-editors */
2658 /* {-for-text-editors */
2659 expand_string_message = string_sprintf("missing } at end of condition "
2660 "inside \"%s\" group", name);
2666 if (cond_type == ECOND_AND)
2668 combined_cond &= tempcond;
2669 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2670 } /* evaluate any more */
2673 combined_cond |= tempcond;
2674 if (combined_cond) subcondptr = NULL; /* once true, don't */
2675 } /* evaluate any more */
2679 if (yield != NULL) *yield = (combined_cond == testfor);
2683 /* forall/forany: iterates a condition with different values */
2689 uschar *save_iterate_item = iterate_item;
2691 while (isspace(*s)) s++;
2692 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2693 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2694 if (sub[0] == NULL) return NULL;
2695 /* {-for-text-editors */
2696 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2698 while (isspace(*s)) s++;
2699 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2703 /* Call eval_condition once, with result discarded (as if scanning a
2704 "false" part). This allows us to find the end of the condition, because if
2705 the list it empty, we won't actually evaluate the condition for real. */
2707 s = eval_condition(sub[1], NULL);
2710 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2711 expand_string_message, name);
2714 while (isspace(*s)) s++;
2716 /* {-for-text-editors */
2719 /* {-for-text-editors */
2720 expand_string_message = string_sprintf("missing } at end of condition "
2721 "inside \"%s\"", name);
2725 if (yield != NULL) *yield = !testfor;
2726 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2728 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2729 if (eval_condition(sub[1], &tempcond) == NULL)
2731 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2732 expand_string_message, name);
2733 iterate_item = save_iterate_item;
2736 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2737 tempcond? "true":"false");
2739 if (yield != NULL) *yield = (tempcond == testfor);
2740 if (tempcond == (cond_type == ECOND_FORANY)) break;
2743 iterate_item = save_iterate_item;
2748 /* The bool{} expansion condition maps a string to boolean.
2749 The values supported should match those supported by the ACL condition
2750 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2751 of true/false. Note that Router "condition" rules have a different
2752 interpretation, where general data can be used and only a few values
2754 Note that readconf.c boolean matching, for boolean configuration options,
2755 only matches true/yes/false/no.
2756 The bool_lax{} condition matches the Router logic, which is much more
2759 case ECOND_BOOL_LAX:
2765 BOOL boolvalue = FALSE;
2766 while (isspace(*s)) s++;
2767 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2768 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2769 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2771 case 1: expand_string_message = string_sprintf(
2772 "too few arguments or bracketing error for %s",
2776 case 3: return NULL;
2779 while (isspace(*t)) t++;
2783 /* trailing whitespace: seems like a good idea to ignore it too */
2785 while (isspace(*t2)) t2--;
2786 if (t2 != (t + len))
2793 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2794 /* logic for the lax case from expand_check_condition(), which also does
2795 expands, and the logic is both short and stable enough that there should
2796 be no maintenance burden from replicating it. */
2799 else if (Ustrspn(t, "0123456789") == len)
2801 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2802 /* expand_check_condition only does a literal string "0" check */
2803 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2806 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2808 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2810 else if (cond_type == ECOND_BOOL_LAX)
2814 expand_string_message = string_sprintf("unrecognised boolean "
2818 if (yield != NULL) *yield = (boolvalue == testfor);
2822 /* Unknown condition */
2825 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2827 } /* End switch on condition type */
2829 /* Missing braces at start and end of data */
2831 COND_FAILED_CURLY_START:
2832 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2835 COND_FAILED_CURLY_END:
2836 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2840 /* A condition requires code that is not compiled */
2842 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2843 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2844 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2845 COND_FAILED_NOT_COMPILED:
2846 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2855 /*************************************************
2856 * Save numerical variables *
2857 *************************************************/
2859 /* This function is called from items such as "if" that want to preserve and
2860 restore the numbered variables.
2863 save_expand_string points to an array of pointers to set
2864 save_expand_nlength points to an array of ints for the lengths
2866 Returns: the value of expand max to save
2870 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2873 for (i = 0; i <= expand_nmax; i++)
2875 save_expand_nstring[i] = expand_nstring[i];
2876 save_expand_nlength[i] = expand_nlength[i];
2883 /*************************************************
2884 * Restore numerical variables *
2885 *************************************************/
2887 /* This function restored saved values of numerical strings.
2890 save_expand_nmax the number of strings to restore
2891 save_expand_string points to an array of pointers
2892 save_expand_nlength points to an array of ints
2898 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2899 int *save_expand_nlength)
2902 expand_nmax = save_expand_nmax;
2903 for (i = 0; i <= expand_nmax; i++)
2905 expand_nstring[i] = save_expand_nstring[i];
2906 expand_nlength[i] = save_expand_nlength[i];
2914 /*************************************************
2915 * Handle yes/no substrings *
2916 *************************************************/
2918 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2919 alternative substrings that depend on whether or not the condition was true,
2920 or the lookup or extraction succeeded. The substrings always have to be
2921 expanded, to check their syntax, but "skipping" is set when the result is not
2922 needed - this avoids unnecessary nested lookups.
2925 skipping TRUE if we were skipping when this item was reached
2926 yes TRUE if the first string is to be used, else use the second
2927 save_lookup a value to put back into lookup_value before the 2nd expansion
2928 sptr points to the input string pointer
2929 yieldptr points to the output string pointer
2930 sizeptr points to the output string size
2931 ptrptr points to the output string pointer
2932 type "lookup" or "if" or "extract" or "run", for error message
2934 Returns: 0 OK; lookup_value has been reset to save_lookup
2936 2 expansion failed because of bracketing error
2940 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2941 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2944 uschar *s = *sptr; /* Local value */
2945 uschar *sub1, *sub2;
2947 /* If there are no following strings, we substitute the contents of $value for
2948 lookups and for extractions in the success case. For the ${if item, the string
2949 "true" is substituted. In the fail case, nothing is substituted for all three
2952 while (isspace(*s)) s++;
2957 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2961 if (yes && lookup_value != NULL)
2962 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2963 Ustrlen(lookup_value));
2964 lookup_value = save_lookup;
2970 /* The first following string must be braced. */
2972 if (*s++ != '{') goto FAILED_CURLY;
2974 /* Expand the first substring. Forced failures are noticed only if we actually
2975 want this string. Set skipping in the call in the fail case (this will always
2976 be the case if we were already skipping). */
2978 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
2979 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2980 expand_string_forcedfail = FALSE;
2981 if (*s++ != '}') goto FAILED_CURLY;
2983 /* If we want the first string, add it to the output */
2986 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2988 /* If this is called from a lookup or an extract, we want to restore $value to
2989 what it was at the start of the item, so that it has this value during the
2990 second string expansion. For the call from "if" or "run" to this function,
2991 save_lookup is set to lookup_value, so that this statement does nothing. */
2993 lookup_value = save_lookup;
2995 /* There now follows either another substring, or "fail", or nothing. This
2996 time, forced failures are noticed only if we want the second string. We must
2997 set skipping in the nested call if we don't want this string, or if we were
2998 already skipping. */
3000 while (isspace(*s)) s++;
3003 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
3004 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3005 expand_string_forcedfail = FALSE;
3006 if (*s++ != '}') goto FAILED_CURLY;
3008 /* If we want the second string, add it to the output */
3011 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3014 /* If there is no second string, but the word "fail" is present when the use of
3015 the second string is wanted, set a flag indicating it was a forced failure
3016 rather than a syntactic error. Swallow the terminating } in case this is nested
3017 inside another lookup or if or extract. */
3022 s = read_name(name, sizeof(name), s, US"_");
3023 if (Ustrcmp(name, "fail") == 0)
3025 if (!yes && !skipping)
3027 while (isspace(*s)) s++;
3028 if (*s++ != '}') goto FAILED_CURLY;
3029 expand_string_message =
3030 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3031 expand_string_forcedfail = TRUE;
3037 expand_string_message =
3038 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3043 /* All we have to do now is to check on the final closing brace. */
3045 while (isspace(*s)) s++;
3046 if (*s++ == '}') goto RETURN;
3048 /* Get here if there is a bracketing failure */
3053 /* Get here for other failures */
3058 /* Update the input pointer value before returning */
3068 /*************************************************
3069 * Handle MD5 or SHA-1 computation for HMAC *
3070 *************************************************/
3072 /* These are some wrapping functions that enable the HMAC code to be a bit
3073 cleaner. A good compiler will spot the tail recursion.
3076 type HMAC_MD5 or HMAC_SHA1
3077 remaining are as for the cryptographic hash functions
3083 chash_start(int type, void *base)
3085 if (type == HMAC_MD5)
3086 md5_start((md5 *)base);
3088 sha1_start((sha1 *)base);
3092 chash_mid(int type, void *base, uschar *string)
3094 if (type == HMAC_MD5)
3095 md5_mid((md5 *)base, string);
3097 sha1_mid((sha1 *)base, string);
3101 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3103 if (type == HMAC_MD5)
3104 md5_end((md5 *)base, string, length, digest);
3106 sha1_end((sha1 *)base, string, length, digest);
3113 /********************************************************
3114 * prvs: Get last three digits of days since Jan 1, 1970 *
3115 ********************************************************/
3117 /* This is needed to implement the "prvs" BATV reverse
3120 Argument: integer "days" offset to add or substract to
3121 or from the current number of days.
3123 Returns: pointer to string containing the last three
3124 digits of the number of days since Jan 1, 1970,
3125 modified by the offset argument, NULL if there
3126 was an error in the conversion.
3131 prvs_daystamp(int day_offset)
3133 uschar *days = store_get(32); /* Need at least 24 for cases */
3134 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3135 (time(NULL) + day_offset*86400)/86400);
3136 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3141 /********************************************************
3142 * prvs: perform HMAC-SHA1 computation of prvs bits *
3143 ********************************************************/
3145 /* This is needed to implement the "prvs" BATV reverse
3149 address RFC2821 Address to use
3150 key The key to use (must be less than 64 characters
3152 key_num Single-digit key number to use. Defaults to
3155 Returns: pointer to string containing the first three
3156 bytes of the final hash in hex format, NULL if
3157 there was an error in the process.
3161 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3163 uschar *hash_source, *p;
3164 int size = 0,offset = 0,i;
3166 void *use_base = &sha1_base;
3167 uschar innerhash[20];
3168 uschar finalhash[20];
3169 uschar innerkey[64];
3170 uschar outerkey[64];
3171 uschar *finalhash_hex = store_get(40);
3173 if (key_num == NULL)
3176 if (Ustrlen(key) > 64)
3179 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3180 string_cat(hash_source,&size,&offset,daystamp,3);
3181 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3182 hash_source[offset] = '\0';
3184 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3186 memset(innerkey, 0x36, 64);
3187 memset(outerkey, 0x5c, 64);
3189 for (i = 0; i < Ustrlen(key); i++)
3191 innerkey[i] ^= key[i];
3192 outerkey[i] ^= key[i];
3195 chash_start(HMAC_SHA1, use_base);
3196 chash_mid(HMAC_SHA1, use_base, innerkey);
3197 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3199 chash_start(HMAC_SHA1, use_base);
3200 chash_mid(HMAC_SHA1, use_base, outerkey);
3201 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3204 for (i = 0; i < 3; i++)
3206 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3207 *p++ = hex_digits[finalhash[i] & 0x0f];
3211 return finalhash_hex;
3217 /*************************************************
3218 * Join a file onto the output string *
3219 *************************************************/
3221 /* This is used for readfile and after a run expansion. It joins the contents
3222 of a file onto the output string, globally replacing newlines with a given
3223 string (optionally). The file is closed at the end.
3227 yield pointer to the expandable string
3228 sizep pointer to the current size
3229 ptrp pointer to the current position
3230 eol newline replacement string, or NULL
3232 Returns: new value of string pointer
3236 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3239 uschar buffer[1024];
3241 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3243 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3245 int len = Ustrlen(buffer);
3246 if (eol != NULL && buffer[len-1] == '\n') len--;
3247 yield = string_cat(yield, sizep, ptrp, buffer, len);
3248 if (buffer[len] != 0)
3249 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3252 if (yield != NULL) yield[*ptrp] = 0;
3260 /*************************************************
3261 * Evaluate numeric expression *
3262 *************************************************/
3264 /* This is a set of mutually recursive functions that evaluate an arithmetic
3265 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3266 these functions that is called from elsewhere is eval_expr, whose interface is:
3269 sptr pointer to the pointer to the string - gets updated
3270 decimal TRUE if numbers are to be assumed decimal
3271 error pointer to where to put an error message - must be NULL on input
3272 endket TRUE if ')' must terminate - FALSE for external call
3274 Returns: on success: the value of the expression, with *error still NULL
3275 on failure: an undefined value, with *error = a message
3278 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3281 static int_eximarith_t
3282 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3285 int_eximarith_t x = eval_op_or(&s, decimal, error);
3291 *error = US"expecting closing parenthesis";
3293 while (isspace(*(++s)));
3295 else if (*s != 0) *error = US"expecting operator";
3302 static int_eximarith_t
3303 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3308 while (isspace(*s)) s++;
3313 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3315 switch (tolower(*s))
3318 case 'k': n *= 1024; s++; break;
3319 case 'm': n *= 1024*1024; s++; break;
3320 case 'g': n *= 1024*1024*1024; s++; break;
3322 while (isspace (*s)) s++;
3327 n = eval_expr(&s, decimal, error, 1);
3331 *error = US"expecting number or opening parenthesis";
3339 static int_eximarith_t
3340 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3344 while (isspace(*s)) s++;
3345 if (*s == '+' || *s == '-' || *s == '~')
3348 x = eval_op_unary(&s, decimal, error);
3349 if (op == '-') x = -x;
3350 else if (op == '~') x = ~x;
3354 x = eval_number(&s, decimal, error);
3361 static int_eximarith_t
3362 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3365 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3368 while (*s == '*' || *s == '/' || *s == '%')
3371 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3372 if (*error != NULL) break;
3373 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3374 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3375 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3376 * -N*M is INT_MIN will yielf INT_MIN.
3377 * Since we don't support floating point, this is somewhat simpler.
3378 * Ideally, we'd return an error, but since we overflow for all other
3379 * arithmetic, consistency suggests otherwise, but what's the correct value
3380 * to use? There is none.
3381 * The C standard guarantees overflow for unsigned arithmetic but signed
3382 * overflow invokes undefined behaviour; in practice, this is overflow
3383 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3384 * that long/longlong larger than int are available, or we could just work
3385 * with larger types. We should consider whether to guarantee 32bit eval
3386 * and 64-bit working variables, with errors returned. For now ...
3387 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3388 * can just let the other invalid results occur otherwise, as they have
3389 * until now. For this one case, we can coerce.
3391 if (y == -1 && x == LLONG_MIN && op != '*')
3394 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3395 LLONG_MIN, op, LLONG_MAX);
3405 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3421 static int_eximarith_t
3422 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3425 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3428 while (*s == '+' || *s == '-')
3431 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3432 if (*error != NULL) break;
3433 if (op == '+') x += y; else x -= y;
3441 static int_eximarith_t
3442 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3445 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3448 while ((*s == '<' || *s == '>') && s[1] == s[0])
3453 y = eval_op_sum(&s, decimal, error);
3454 if (*error != NULL) break;
3455 if (op == '<') x <<= y; else x >>= y;
3463 static int_eximarith_t
3464 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3467 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3474 y = eval_op_shift(&s, decimal, error);
3475 if (*error != NULL) break;
3484 static int_eximarith_t
3485 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3488 int_eximarith_t x = eval_op_and(&s, decimal, error);
3495 y = eval_op_and(&s, decimal, error);
3496 if (*error != NULL) break;
3505 static int_eximarith_t
3506 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3509 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3516 y = eval_op_xor(&s, decimal, error);
3517 if (*error != NULL) break;
3527 /*************************************************
3529 *************************************************/
3531 /* Returns either an unchanged string, or the expanded string in stacking pool
3532 store. Interpreted sequences are:
3534 \... normal escaping rules
3535 $name substitutes the variable
3537 ${op:string} operates on the expanded string value
3538 ${item{arg1}{arg2}...} expands the args and then does the business
3539 some literal args are not enclosed in {}
3541 There are now far too many operators and item types to make it worth listing
3542 them here in detail any more.
3544 We use an internal routine recursively to handle embedded substrings. The
3545 external function follows. The yield is NULL if the expansion failed, and there
3546 are two cases: if something collapsed syntactically, or if "fail" was given
3547 as the action on a lookup failure. These can be distinguised by looking at the
3548 variable expand_string_forcedfail, which is TRUE in the latter case.
3550 The skipping flag is set true when expanding a substring that isn't actually
3551 going to be used (after "if" or "lookup") and it prevents lookups from
3552 happening lower down.
3554 Store usage: At start, a store block of the length of the input plus 64
3555 is obtained. This is expanded as necessary by string_cat(), which might have to
3556 get a new block, or might be able to expand the original. At the end of the
3557 function we can release any store above that portion of the yield block that
3558 was actually used. In many cases this will be optimal.
3560 However: if the first item in the expansion is a variable name or header name,
3561 we reset the store before processing it; if the result is in fresh store, we
3562 use that without copying. This is helpful for expanding strings like
3563 $message_headers which can get very long.
3565 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3566 since resetting the store at the end of the expansion will free store that was
3567 allocated by the plugin code as well as the slop after the expanded string. So
3568 we skip any resets if ${dlfunc has been used. The same applies for ${acl. This
3569 is an unfortunate consequence of string expansion becoming too powerful.
3572 string the string to be expanded
3573 ket_ends true if expansion is to stop at }
3574 left if not NULL, a pointer to the first character after the
3575 expansion is placed here (typically used with ket_ends)
3576 skipping TRUE for recursive calls when the value isn't actually going
3577 to be used (to allow for optimisation)
3578 honour_dollar TRUE if $ is to be expanded,
3579 FALSE if it's just another character
3581 Returns: NULL if expansion fails:
3582 expand_string_forcedfail is set TRUE if failure was forced
3583 expand_string_message contains a textual error message
3584 a pointer to the expanded string on success
3588 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3589 BOOL skipping, BOOL honour_dollar)
3592 int size = Ustrlen(string)+ 64;
3594 uschar *yield = store_get(size);
3596 uschar *save_expand_nstring[EXPAND_MAXN+1];
3597 int save_expand_nlength[EXPAND_MAXN+1];
3598 BOOL resetok = TRUE;
3600 expand_string_forcedfail = FALSE;
3601 expand_string_message = US"";
3608 /* \ escapes the next character, which must exist, or else
3609 the expansion fails. There's a special escape, \N, which causes
3610 copying of the subject verbatim up to the next \N. Otherwise,
3611 the escapes are the standard set. */
3617 expand_string_message = US"\\ at end of string";
3624 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3625 yield = string_cat(yield, &size, &ptr, t, s - t);
3626 if (*s != 0) s += 2;
3632 ch[0] = string_interpret_escape(&s);
3634 yield = string_cat(yield, &size, &ptr, ch, 1);
3640 /* Anything other than $ is just copied verbatim, unless we are
3641 looking for a terminating } character. */
3643 if (ket_ends && *s == '}') break;
3645 if (*s != '$' || !honour_dollar)
3647 yield = string_cat(yield, &size, &ptr, s++, 1);
3651 /* No { after the $ - must be a plain name or a number for string
3652 match variable. There has to be a fudge for variables that are the
3653 names of header fields preceded by "$header_" because header field
3654 names can contain any printing characters except space and colon.
3655 For those that don't like typing this much, "$h_" is a synonym for
3656 "$header_". A non-existent header yields a NULL value; nothing is
3659 if (isalpha((*(++s))))
3664 s = read_name(name, sizeof(name), s, US"_");
3666 /* If this is the first thing to be expanded, release the pre-allocated
3669 if (ptr == 0 && yield != NULL)
3671 if (resetok) store_reset(yield);
3678 if (Ustrncmp(name, "h_", 2) == 0 ||
3679 Ustrncmp(name, "rh_", 3) == 0 ||
3680 Ustrncmp(name, "bh_", 3) == 0 ||
3681 Ustrncmp(name, "header_", 7) == 0 ||
3682 Ustrncmp(name, "rheader_", 8) == 0 ||
3683 Ustrncmp(name, "bheader_", 8) == 0)
3685 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3686 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3687 s = read_header_name(name, sizeof(name), s);
3688 value = find_header(name, FALSE, &newsize, want_raw, charset);
3690 /* If we didn't find the header, and the header contains a closing brace
3691 character, this may be a user error where the terminating colon
3692 has been omitted. Set a flag to adjust the error message in this case.
3693 But there is no error here - nothing gets inserted. */
3697 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3706 value = find_variable(name, FALSE, skipping, &newsize);
3709 expand_string_message =
3710 string_sprintf("unknown variable name \"%s\"", name);
3711 check_variable_error_message(name);
3716 /* If the data is known to be in a new buffer, newsize will be set to the
3717 size of that buffer. If this is the first thing in an expansion string,
3718 yield will be NULL; just point it at the new store instead of copying. Many
3719 expansion strings contain just one reference, so this is a useful
3720 optimization, especially for humungous headers. */
3722 len = Ustrlen(value);
3723 if (yield == NULL && newsize != 0)
3729 else yield = string_cat(yield, &size, &ptr, value, len);
3737 s = read_number(&n, s);
3738 if (n >= 0 && n <= expand_nmax)
3739 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3744 /* Otherwise, if there's no '{' after $ it's an error. */
3748 expand_string_message = US"$ not followed by letter, digit, or {";
3752 /* After { there can be various things, but they all start with
3753 an initial word, except for a number for a string match variable. */
3755 if (isdigit((*(++s))))
3758 s = read_number(&n, s);
3761 expand_string_message = US"} expected after number";
3764 if (n >= 0 && n <= expand_nmax)
3765 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3772 expand_string_message = US"letter or digit expected after ${";
3776 /* Allow "-" in names to cater for substrings with negative
3777 arguments. Since we are checking for known names after { this is
3780 s = read_name(name, sizeof(name), s, US"_-");
3781 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3785 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3786 If the ACL returns accept or reject we return content set by "message ="
3787 There is currently no limit on recursion; this would have us call
3788 acl_check_internal() directly and get a current level from somewhere.
3789 See also the acl expansion condition ECOND_ACL and the traditional
3790 acl modifier ACLC_ACL.
3791 Assume that the function has side-effects on the store that must be preserved.
3795 /* ${acl {name} {arg1}{arg2}...} */
3797 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3800 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl"))
3802 case 1: goto EXPAND_FAILED_CURLY;
3804 case 3: goto EXPAND_FAILED;
3806 if (skipping) continue;
3809 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3814 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3818 expand_string_forcedfail = TRUE;
3820 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3825 /* Handle conditionals - preserve the values of the numerical expansion
3826 variables in case they get changed by a regular expression match in the
3827 condition. If not, they retain their external settings. At the end
3828 of this "if" section, they get restored to their previous values. */
3834 int save_expand_nmax =
3835 save_expand_strings(save_expand_nstring, save_expand_nlength);
3837 while (isspace(*s)) s++;
3838 next_s = eval_condition(s, skipping? NULL : &cond);
3839 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3842 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3843 cond? "true" : "false");
3847 /* The handling of "yes" and "no" result strings is now in a separate
3848 function that is also used by ${lookup} and ${extract} and ${run}. */
3850 switch(process_yesno(
3851 skipping, /* were previously skipping */
3852 cond, /* success/failure indicator */
3853 lookup_value, /* value to reset for string2 */
3854 &s, /* input pointer */
3855 &yield, /* output pointer */
3856 &size, /* output size */
3857 &ptr, /* output current point */
3858 US"if")) /* condition type */
3860 case 1: goto EXPAND_FAILED; /* when all is well, the */
3861 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3864 /* Restore external setting of expansion variables for continuation
3867 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3868 save_expand_nlength);
3872 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3873 expanding an internal string that isn't actually going to be used. All we
3874 need to do is check the syntax, so don't do a lookup at all. Preserve the
3875 values of the numerical expansion variables in case they get changed by a
3876 partial lookup. If not, they retain their external settings. At the end
3877 of this "lookup" section, they get restored to their previous values. */
3881 int stype, partial, affixlen, starflags;
3882 int expand_setup = 0;
3884 uschar *key, *filename, *affix;
3885 uschar *save_lookup_value = lookup_value;
3886 int save_expand_nmax =
3887 save_expand_strings(save_expand_nstring, save_expand_nlength);
3889 if ((expand_forbid & RDO_LOOKUP) != 0)
3891 expand_string_message = US"lookup expansions are not permitted";
3895 /* Get the key we are to look up for single-key+file style lookups.
3896 Otherwise set the key NULL pro-tem. */
3898 while (isspace(*s)) s++;
3901 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3902 if (key == NULL) goto EXPAND_FAILED;
3903 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3904 while (isspace(*s)) s++;
3908 /* Find out the type of database */
3912 expand_string_message = US"missing lookup type";
3916 /* The type is a string that may contain special characters of various
3917 kinds. Allow everything except space or { to appear; the actual content
3918 is checked by search_findtype_partial. */
3920 while (*s != 0 && *s != '{' && !isspace(*s))
3922 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3926 while (isspace(*s)) s++;
3928 /* Now check for the individual search type and any partial or default
3929 options. Only those types that are actually in the binary are valid. */
3931 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3935 expand_string_message = search_error_message;
3939 /* Check that a key was provided for those lookup types that need it,
3940 and was not supplied for those that use the query style. */
3942 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3946 expand_string_message = string_sprintf("missing {key} for single-"
3947 "key \"%s\" lookup", name);
3955 expand_string_message = string_sprintf("a single key was given for "
3956 "lookup type \"%s\", which is not a single-key lookup type", name);
3961 /* Get the next string in brackets and expand it. It is the file name for
3962 single-key+file lookups, and the whole query otherwise. In the case of
3963 queries that also require a file name (e.g. sqlite), the file name comes
3966 if (*s != '{') goto EXPAND_FAILED_CURLY;
3967 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3968 if (filename == NULL) goto EXPAND_FAILED;
3969 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3970 while (isspace(*s)) s++;
3972 /* If this isn't a single-key+file lookup, re-arrange the variables
3973 to be appropriate for the search_ functions. For query-style lookups,
3974 there is just a "key", and no file name. For the special query-style +
3975 file types, the query (i.e. "key") starts with a file name. */
3979 while (isspace(*filename)) filename++;
3982 if (mac_islookup(stype, lookup_querystyle))
3988 if (*filename != '/')
3990 expand_string_message = string_sprintf(
3991 "absolute file name expected for \"%s\" lookup", name);
3994 while (*key != 0 && !isspace(*key)) key++;
3995 if (*key != 0) *key++ = 0;
3999 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4000 the entry was not found. Note that there is no search_close() function.
4001 Files are left open in case of re-use. At suitable places in higher logic,
4002 search_tidyup() is called to tidy all open files. This can save opening
4003 the same file several times. However, files may also get closed when
4004 others are opened, if too many are open at once. The rule is that a
4005 handle should not be used after a second search_open().
4007 Request that a partial search sets up $1 and maybe $2 by passing
4008 expand_setup containing zero. If its value changes, reset expand_nmax,
4009 since new variables will have been set. Note that at the end of this
4010 "lookup" section, the old numeric variables are restored. */
4013 lookup_value = NULL;
4016 void *handle = search_open(filename, stype, 0, NULL, NULL);
4019 expand_string_message = search_error_message;
4022 lookup_value = search_find(handle, filename, key, partial, affix,
4023 affixlen, starflags, &expand_setup);
4024 if (search_find_defer)
4026 expand_string_message =
4027 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4028 string_printing2(key, FALSE), search_error_message);
4031 if (expand_setup > 0) expand_nmax = expand_setup;
4034 /* The handling of "yes" and "no" result strings is now in a separate
4035 function that is also used by ${if} and ${extract}. */
4037 switch(process_yesno(
4038 skipping, /* were previously skipping */
4039 lookup_value != NULL, /* success/failure indicator */
4040 save_lookup_value, /* value to reset for string2 */
4041 &s, /* input pointer */
4042 &yield, /* output pointer */
4043 &size, /* output size */
4044 &ptr, /* output current point */
4045 US"lookup")) /* condition type */
4047 case 1: goto EXPAND_FAILED; /* when all is well, the */
4048 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4051 /* Restore external setting of expansion variables for carrying on
4052 at this level, and continue. */
4054 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4055 save_expand_nlength);
4059 /* If Perl support is configured, handle calling embedded perl subroutines,
4060 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4061 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4062 arguments (defined below). */
4064 #define EXIM_PERL_MAX_ARGS 8
4068 expand_string_message = US"\"${perl\" encountered, but this facility "
4069 "is not included in this binary";
4072 #else /* EXIM_PERL */
4074 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4077 if ((expand_forbid & RDO_PERL) != 0)
4079 expand_string_message = US"Perl calls are not permitted";
4083 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4086 case 1: goto EXPAND_FAILED_CURLY;
4088 case 3: goto EXPAND_FAILED;
4091 /* If skipping, we don't actually do anything */
4093 if (skipping) continue;
4095 /* Start the interpreter if necessary */
4097 if (!opt_perl_started)
4100 if (opt_perl_startup == NULL)
4102 expand_string_message = US"A setting of perl_startup is needed when "
4103 "using the Perl interpreter";
4106 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4107 initerror = init_perl(opt_perl_startup);
4108 if (initerror != NULL)
4110 expand_string_message =
4111 string_sprintf("error in perl_startup code: %s\n", initerror);
4114 opt_perl_started = TRUE;
4117 /* Call the function */
4119 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4120 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4121 sub_arg[0], sub_arg + 1);
4123 /* NULL yield indicates failure; if the message pointer has been set to
4124 NULL, the yield was undef, indicating a forced failure. Otherwise the
4125 message will indicate some kind of Perl error. */
4127 if (new_yield == NULL)
4129 if (expand_string_message == NULL)
4131 expand_string_message =
4132 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4133 "failure", sub_arg[0]);
4134 expand_string_forcedfail = TRUE;
4139 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4140 set during a callback from Perl. */
4142 expand_string_forcedfail = FALSE;
4146 #endif /* EXIM_PERL */
4148 /* Transform email address to "prvs" scheme to use
4149 as BATV-signed return path */
4156 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
4158 case 1: goto EXPAND_FAILED_CURLY;
4160 case 3: goto EXPAND_FAILED;
4163 /* If skipping, we don't actually do anything */
4164 if (skipping) continue;
4166 /* sub_arg[0] is the address */
4167 domain = Ustrrchr(sub_arg[0],'@');
4168 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4170 expand_string_message = US"prvs first argument must be a qualified email address";
4174 /* Calculate the hash. The second argument must be a single-digit
4175 key number, or unset. */
4177 if (sub_arg[2] != NULL &&
4178 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4180 expand_string_message = US"prvs second argument must be a single digit";
4184 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4187 expand_string_message = US"prvs hmac-sha1 conversion failed";
4191 /* Now separate the domain from the local part */
4194 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4195 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4196 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4197 string_cat(yield,&size,&ptr,p,6);
4198 string_cat(yield,&size,&ptr,US"=",1);
4199 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4200 string_cat(yield,&size,&ptr,US"@",1);
4201 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4206 /* Check a prvs-encoded address for validity */
4208 case EITEM_PRVSCHECK:
4211 int mysize = 0, myptr = 0;
4215 /* TF: Ugliness: We want to expand parameter 1 first, then set
4216 up expansion variables that are used in the expansion of
4217 parameter 2. So we clone the string for the first
4218 expansion, where we only expand parameter 1.
4220 PH: Actually, that isn't necessary. The read_subs() function is
4221 designed to work this way for the ${if and ${lookup expansions. I've
4225 /* Reset expansion variables */
4226 prvscheck_result = NULL;
4227 prvscheck_address = NULL;
4228 prvscheck_keynum = NULL;
4230 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4232 case 1: goto EXPAND_FAILED_CURLY;
4234 case 3: goto EXPAND_FAILED;
4237 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4240 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4242 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4243 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4244 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4245 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4246 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4248 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4249 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4250 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4251 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4252 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4254 /* Set up expansion variables */
4255 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4256 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4257 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4258 prvscheck_address[myptr] = '\0';
4259 prvscheck_keynum = string_copy(key_num);
4261 /* Now expand the second argument */
4262 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4264 case 1: goto EXPAND_FAILED_CURLY;
4266 case 3: goto EXPAND_FAILED;
4269 /* Now we have the key and can check the address. */
4271 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4276 expand_string_message = US"hmac-sha1 conversion failed";
4280 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4281 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4283 if (Ustrcmp(p,hash) == 0)
4285 /* Success, valid BATV address. Now check the expiry date. */
4286 uschar *now = prvs_daystamp(0);
4287 unsigned int inow = 0,iexpire = 1;
4289 (void)sscanf(CS now,"%u",&inow);
4290 (void)sscanf(CS daystamp,"%u",&iexpire);
4292 /* When "iexpire" is < 7, a "flip" has occured.
4293 Adjust "inow" accordingly. */
4294 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4296 if (iexpire >= inow)
4298 prvscheck_result = US"1";
4299 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4303 prvscheck_result = NULL;
4304 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4309 prvscheck_result = NULL;
4310 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4313 /* Now expand the final argument. We leave this till now so that
4314 it can include $prvscheck_result. */
4316 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4318 case 1: goto EXPAND_FAILED_CURLY;
4320 case 3: goto EXPAND_FAILED;
4323 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4324 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4326 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4328 /* Reset the "internal" variables afterwards, because they are in
4329 dynamic store that will be reclaimed if the expansion succeeded. */
4331 prvscheck_address = NULL;
4332 prvscheck_keynum = NULL;
4336 /* Does not look like a prvs encoded address, return the empty string.
4337 We need to make sure all subs are expanded first, so as to skip over
4340 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4342 case 1: goto EXPAND_FAILED_CURLY;
4344 case 3: goto EXPAND_FAILED;
4351 /* Handle "readfile" to insert an entire file */
4353 case EITEM_READFILE:
4358 if ((expand_forbid & RDO_READFILE) != 0)
4360 expand_string_message = US"file insertions are not permitted";
4364 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4366 case 1: goto EXPAND_FAILED_CURLY;
4368 case 3: goto EXPAND_FAILED;
4371 /* If skipping, we don't actually do anything */
4373 if (skipping) continue;
4375 /* Open the file and read it */
4377 f = Ufopen(sub_arg[0], "rb");
4380 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4384 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4389 /* Handle "readsocket" to insert data from a Unix domain socket */
4391 case EITEM_READSOCK:
4397 struct sockaddr_un sockun; /* don't call this "sun" ! */
4401 if ((expand_forbid & RDO_READSOCK) != 0)
4403 expand_string_message = US"socket insertions are not permitted";
4407 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4408 because there may be a string for expansion on failure. */
4410 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4412 case 1: goto EXPAND_FAILED_CURLY;
4413 case 2: /* Won't occur: no end check */
4414 case 3: goto EXPAND_FAILED;
4417 /* Sort out timeout, if given */
4419 if (sub_arg[2] != NULL)
4421 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4424 expand_string_message = string_sprintf("bad time value %s",
4429 else sub_arg[3] = NULL; /* No eol if no timeout */
4431 /* If skipping, we don't actually do anything. Otherwise, arrange to
4432 connect to either an IP or a Unix socket. */
4436 /* Handle an IP (internet) domain */
4438 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4440 BOOL connected = FALSE;
4444 uschar *server_name = sub_arg[0] + 5;
4445 uschar *port_name = Ustrrchr(server_name, ':');
4447 /* Sort out the port */
4449 if (port_name == NULL)
4451 expand_string_message =
4452 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4455 *port_name++ = 0; /* Terminate server name */
4457 if (isdigit(*port_name))
4460 port = Ustrtol(port_name, &end, 0);
4461 if (end != port_name + Ustrlen(port_name))
4463 expand_string_message =
4464 string_sprintf("invalid port number %s", port_name);
4470 struct servent *service_info = getservbyname(CS port_name, "tcp");
4471 if (service_info == NULL)
4473 expand_string_message = string_sprintf("unknown port \"%s\"",
4477 port = ntohs(service_info->s_port);
4480 /* Sort out the server. */
4483 shost.address = NULL;
4487 namelen = Ustrlen(server_name);
4489 /* Anything enclosed in [] must be an IP address. */
4491 if (server_name[0] == '[' &&
4492 server_name[namelen - 1] == ']')
4494 server_name[namelen - 1] = 0;
4496 if (string_is_ip_address(server_name, NULL) == 0)
4498 expand_string_message =
4499 string_sprintf("malformed IP address \"%s\"", server_name);
4502 shost.name = shost.address = server_name;
4505 /* Otherwise check for an unadorned IP address */
4507 else if (string_is_ip_address(server_name, NULL) != 0)
4508 shost.name = shost.address = server_name;
4510 /* Otherwise lookup IP address(es) from the name */
4514 shost.name = server_name;
4515 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4516 FALSE) != HOST_FOUND)
4518 expand_string_message =
4519 string_sprintf("no IP address found for host %s", shost.name);
4524 /* Try to connect to the server - test each IP till one works */
4526 for (h = &shost; h != NULL; h = h->next)
4528 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4529 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4531 expand_string_message = string_sprintf("failed to create socket: "
4532 "%s", strerror(errno));
4536 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4545 expand_string_message = string_sprintf("failed to connect to "
4546 "socket %s: couldn't connect to any host", sub_arg[0],
4552 /* Handle a Unix domain socket */
4557 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4559 expand_string_message = string_sprintf("failed to create socket: %s",
4564 sockun.sun_family = AF_UNIX;
4565 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4568 sigalrm_seen = FALSE;
4570 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4574 expand_string_message = US "socket connect timed out";
4579 expand_string_message = string_sprintf("failed to connect to socket "
4580 "%s: %s", sub_arg[0], strerror(errno));
4585 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4587 /* Write the request string, if not empty */
4589 if (sub_arg[1][0] != 0)
4591 int len = Ustrlen(sub_arg[1]);
4592 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4594 if (write(fd, sub_arg[1], len) != len)
4596 expand_string_message = string_sprintf("request write to socket "
4597 "failed: %s", strerror(errno));
4602 /* Shut down the sending side of the socket. This helps some servers to
4603 recognise that it is their turn to do some work. Just in case some
4604 system doesn't have this function, make it conditional. */
4607 shutdown(fd, SHUT_WR);
4610 /* Now we need to read from the socket, under a timeout. The function
4611 that reads a file can be used. */
4613 f = fdopen(fd, "rb");
4614 sigalrm_seen = FALSE;
4616 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4620 /* After a timeout, we restore the pointer in the result, that is,
4621 make sure we add nothing from the socket. */
4626 expand_string_message = US "socket read timed out";
4631 /* The whole thing has worked (or we were skipping). If there is a
4632 failure string following, we need to skip it. */
4636 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4638 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4639 while (isspace(*s)) s++;
4641 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4644 /* Come here on failure to create socket, connect socket, write to the
4645 socket, or timeout on reading. If another substring follows, expand and
4646 use it. Otherwise, those conditions give expand errors. */
4649 if (*s != '{') goto EXPAND_FAILED;
4650 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4651 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4652 if (arg == NULL) goto EXPAND_FAILED;
4653 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4654 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4655 while (isspace(*s)) s++;
4656 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4660 /* Handle "run" to execute a program. */
4672 if ((expand_forbid & RDO_RUN) != 0)
4674 expand_string_message = US"running a command is not permitted";
4678 while (isspace(*s)) s++;
4679 if (*s != '{') goto EXPAND_FAILED_CURLY;
4680 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4681 if (arg == NULL) goto EXPAND_FAILED;
4682 while (isspace(*s)) s++;
4683 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4685 if (skipping) /* Just pretend it worked when we're skipping */
4691 if (!transport_set_up_command(&argv, /* anchor for arg list */
4692 arg, /* raw command */
4693 FALSE, /* don't expand the arguments */
4694 0, /* not relevant when... */
4695 NULL, /* no transporting address */
4696 US"${run} expansion", /* for error messages */
4697 &expand_string_message)) /* where to put error message */
4702 /* Create the child process, making it a group leader. */
4704 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4708 expand_string_message =
4709 string_sprintf("couldn't create child process: %s", strerror(errno));
4713 /* Nothing is written to the standard input. */
4717 /* Read the pipe to get the command's output into $value (which is kept
4718 in lookup_value). Read during execution, so that if the output exceeds
4719 the OS pipe buffer limit, we don't block forever. */
4721 f = fdopen(fd_out, "rb");
4722 sigalrm_seen = FALSE;
4724 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4728 /* Wait for the process to finish, applying the timeout, and inspect its
4729 return code for serious disasters. Simple non-zero returns are passed on.
4732 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4734 if (sigalrm_seen == TRUE || runrc == -256)
4736 expand_string_message = string_sprintf("command timed out");
4737 killpg(pid, SIGKILL); /* Kill the whole process group */
4740 else if (runrc == -257)
4741 expand_string_message = string_sprintf("wait() failed: %s",
4745 expand_string_message = string_sprintf("command killed by signal %d",
4752 /* Process the yes/no strings; $value may be useful in both cases */
4754 switch(process_yesno(
4755 skipping, /* were previously skipping */
4756 runrc == 0, /* success/failure indicator */
4757 lookup_value, /* value to reset for string2 */
4758 &s, /* input pointer */
4759 &yield, /* output pointer */
4760 &size, /* output size */
4761 &ptr, /* output current point */
4762 US"run")) /* condition type */
4764 case 1: goto EXPAND_FAILED; /* when all is well, the */
4765 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4771 /* Handle character translation for "tr" */
4779 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4781 case 1: goto EXPAND_FAILED_CURLY;
4783 case 3: goto EXPAND_FAILED;
4786 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4787 o2m = Ustrlen(sub[2]) - 1;
4789 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4791 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4795 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4802 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4803 expanded arguments. */
4813 int val[2] = { 0, -1 };
4816 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4817 Ensure that sub[2] is set in the ${length case. */
4820 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4823 case 1: goto EXPAND_FAILED_CURLY;
4825 case 3: goto EXPAND_FAILED;
4828 /* Juggle the arguments if there are only two of them: always move the
4829 string to the last position and make ${length{n}{str}} equivalent to
4830 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4836 if (item_type == EITEM_LENGTH)
4843 for (i = 0; i < 2; i++)
4845 if (sub[i] == NULL) continue;
4846 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4847 if (*ret != 0 || (i != 0 && val[i] < 0))
4849 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4850 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4856 (item_type == EITEM_HASH)?
4857 compute_hash(sub[2], val[0], val[1], &len) :
4858 (item_type == EITEM_NHASH)?
4859 compute_nhash(sub[2], val[0], val[1], &len) :
4860 extract_substr(sub[2], val[0], val[1], &len);
4862 if (ret == NULL) goto EXPAND_FAILED;
4863 yield = string_cat(yield, &size, &ptr, ret, len);
4867 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4868 This code originally contributed by Steve Haslam. It currently supports
4869 the use of MD5 and SHA-1 hashes.
4871 We need some workspace that is large enough to handle all the supported
4872 hash types. Use macros to set the sizes rather than be too elaborate. */
4874 #define MAX_HASHLEN 20
4875 #define MAX_HASHBLOCKLEN 64
4884 int hashlen; /* Number of octets for the hash algorithm's output */
4885 int hashblocklen; /* Number of octets the hash algorithm processes */
4887 unsigned int keylen;
4889 uschar keyhash[MAX_HASHLEN];
4890 uschar innerhash[MAX_HASHLEN];
4891 uschar finalhash[MAX_HASHLEN];
4892 uschar finalhash_hex[2*MAX_HASHLEN];
4893 uschar innerkey[MAX_HASHBLOCKLEN];
4894 uschar outerkey[MAX_HASHBLOCKLEN];
4896 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4898 case 1: goto EXPAND_FAILED_CURLY;
4900 case 3: goto EXPAND_FAILED;
4903 if (Ustrcmp(sub[0], "md5") == 0)
4906 use_base = &md5_base;
4910 else if (Ustrcmp(sub[0], "sha1") == 0)
4913 use_base = &sha1_base;
4919 expand_string_message =
4920 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4925 keylen = Ustrlen(keyptr);
4927 /* If the key is longer than the hash block length, then hash the key
4930 if (keylen > hashblocklen)
4932 chash_start(type, use_base);
4933 chash_end(type, use_base, keyptr, keylen, keyhash);
4938 /* Now make the inner and outer key values */
4940 memset(innerkey, 0x36, hashblocklen);
4941 memset(outerkey, 0x5c, hashblocklen);
4943 for (i = 0; i < keylen; i++)
4945 innerkey[i] ^= keyptr[i];
4946 outerkey[i] ^= keyptr[i];
4949 /* Now do the hashes */
4951 chash_start(type, use_base);
4952 chash_mid(type, use_base, innerkey);
4953 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4955 chash_start(type, use_base);
4956 chash_mid(type, use_base, outerkey);
4957 chash_end(type, use_base, innerhash, hashlen, finalhash);
4959 /* Encode the final hash as a hex string */
4962 for (i = 0; i < hashlen; i++)
4964 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4965 *p++ = hex_digits[finalhash[i] & 0x0f];
4968 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4969 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4971 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4976 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4977 We have to save the numerical variables and restore them afterwards. */
4982 int moffset, moffsetextra, slen;
4985 const uschar *rerror;
4988 int save_expand_nmax =
4989 save_expand_strings(save_expand_nstring, save_expand_nlength);
4991 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4993 case 1: goto EXPAND_FAILED_CURLY;
4995 case 3: goto EXPAND_FAILED;
4998 /* Compile the regular expression */
5000 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5005 expand_string_message = string_sprintf("regular expression error in "
5006 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5010 /* Now run a loop to do the substitutions as often as necessary. It ends
5011 when there are no more matches. Take care over matches of the null string;
5012 do the same thing as Perl does. */
5015 slen = Ustrlen(sub[0]);
5016 moffset = moffsetextra = 0;
5021 int ovector[3*(EXPAND_MAXN+1)];
5022 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5023 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5027 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5028 is not necessarily the end. We want to repeat the match from one
5029 character further along, but leaving the basic offset the same (for
5030 copying below). We can't be at the end of the string - that was checked
5031 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5032 finished; copy the remaining string and end the loop. */
5042 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5046 /* Match - set up for expanding the replacement. */
5048 if (n == 0) n = EXPAND_MAXN + 1;
5050 for (nn = 0; nn < n*2; nn += 2)
5052 expand_nstring[expand_nmax] = subject + ovector[nn];
5053 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5057 /* Copy the characters before the match, plus the expanded insertion. */
5059 yield = string_cat(yield, &size, &ptr, subject + moffset,
5060 ovector[0] - moffset);
5061 insert = expand_string(sub[2]);
5062 if (insert == NULL) goto EXPAND_FAILED;
5063 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5065 moffset = ovector[1];
5069 /* If we have matched an empty string, first check to see if we are at
5070 the end of the subject. If so, the loop is over. Otherwise, mimic
5071 what Perl's /g options does. This turns out to be rather cunning. First
5072 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5073 string at the same point. If this fails (picked up above) we advance to
5074 the next character. */
5076 if (ovector[0] == ovector[1])
5078 if (ovector[0] == slen) break;
5079 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5083 /* All done - restore numerical variables. */
5085 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5086 save_expand_nlength);
5090 /* Handle keyed and numbered substring extraction. If the first argument
5091 consists entirely of digits, then a numerical extraction is assumed. */
5097 int field_number = 1;
5098 BOOL field_number_set = FALSE;
5099 uschar *save_lookup_value = lookup_value;
5101 int save_expand_nmax =
5102 save_expand_strings(save_expand_nstring, save_expand_nlength);
5104 /* Read the arguments */
5106 for (i = 0; i < j; i++)
5108 while (isspace(*s)) s++;
5111 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5112 if (sub[i] == NULL) goto EXPAND_FAILED;
5113 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5115 /* After removal of leading and trailing white space, the first
5116 argument must not be empty; if it consists entirely of digits
5117 (optionally preceded by a minus sign), this is a numerical
5118 extraction, and we expect 3 arguments. */
5126 while (isspace(*p)) p++;
5130 while (len > 0 && isspace(p[len-1])) len--;
5133 if (*p == 0 && !skipping)
5135 expand_string_message = US"first argument of \"extract\" must "
5145 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5149 j = 3; /* Need 3 args */
5150 field_number_set = TRUE;
5154 else goto EXPAND_FAILED_CURLY;
5157 /* Extract either the numbered or the keyed substring into $value. If
5158 skipping, just pretend the extraction failed. */
5160 lookup_value = skipping? NULL : field_number_set?
5161 expand_gettokened(field_number, sub[1], sub[2]) :
5162 expand_getkeyed(sub[0], sub[1]);
5164 /* If no string follows, $value gets substituted; otherwise there can
5165 be yes/no strings, as for lookup or if. */
5167 switch(process_yesno(
5168 skipping, /* were previously skipping */
5169 lookup_value != NULL, /* success/failure indicator */
5170 save_lookup_value, /* value to reset for string2 */
5171 &s, /* input pointer */
5172 &yield, /* output pointer */
5173 &size, /* output size */
5174 &ptr, /* output current point */
5175 US"extract")) /* condition type */
5177 case 1: goto EXPAND_FAILED; /* when all is well, the */
5178 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5181 /* All done - restore numerical variables. */
5183 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5184 save_expand_nlength);
5190 /* Handle list operations */
5198 uschar outsep[2] = { '\0', '\0' };
5199 uschar *list, *expr, *temp;
5200 uschar *save_iterate_item = iterate_item;
5201 uschar *save_lookup_value = lookup_value;
5203 while (isspace(*s)) s++;
5204 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5206 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5207 if (list == NULL) goto EXPAND_FAILED;
5208 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5210 if (item_type == EITEM_REDUCE)
5212 while (isspace(*s)) s++;
5213 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5214 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5215 if (temp == NULL) goto EXPAND_FAILED;
5216 lookup_value = temp;
5217 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5220 while (isspace(*s)) s++;
5221 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5225 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5226 if scanning a "false" part). This allows us to find the end of the
5227 condition, because if the list is empty, we won't actually evaluate the
5228 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5229 the normal internal expansion function. */
5231 if (item_type == EITEM_FILTER)
5233 temp = eval_condition(expr, NULL);
5234 if (temp != NULL) s = temp;
5238 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5243 expand_string_message = string_sprintf("%s inside \"%s\" item",
5244 expand_string_message, name);
5248 while (isspace(*s)) s++;
5251 expand_string_message = string_sprintf("missing } at end of condition "
5252 "or expression inside \"%s\"", name);
5256 while (isspace(*s)) s++;
5259 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5264 /* If we are skipping, we can now just move on to the next item. When
5265 processing for real, we perform the iteration. */
5267 if (skipping) continue;
5268 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5270 *outsep = (uschar)sep; /* Separator as a string */
5272 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5274 if (item_type == EITEM_FILTER)
5277 if (eval_condition(expr, &condresult) == NULL)
5279 iterate_item = save_iterate_item;
5280 lookup_value = save_lookup_value;
5281 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5282 expand_string_message, name);
5285 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5286 condresult? "true":"false");
5288 temp = iterate_item; /* TRUE => include this item */
5290 continue; /* FALSE => skip this item */
5293 /* EITEM_MAP and EITEM_REDUCE */
5297 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5300 iterate_item = save_iterate_item;
5301 expand_string_message = string_sprintf("%s inside \"%s\" item",
5302 expand_string_message, name);
5305 if (item_type == EITEM_REDUCE)
5307 lookup_value = temp; /* Update the value of $value */
5308 continue; /* and continue the iteration */
5312 /* We reach here for FILTER if the condition is true, always for MAP,
5313 and never for REDUCE. The value in "temp" is to be added to the output
5314 list that is being created, ensuring that any occurrences of the
5315 separator character are doubled. Unless we are dealing with the first
5316 item of the output list, add in a space if the new item begins with the
5317 separator character, or is an empty string. */
5319 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5320 yield = string_cat(yield, &size, &ptr, US" ", 1);
5322 /* Add the string in "temp" to the output list that we are building,
5323 This is done in chunks by searching for the separator character. */
5327 size_t seglen = Ustrcspn(temp, outsep);
5328 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5330 /* If we got to the end of the string we output one character
5331 too many; backup and end the loop. Otherwise arrange to double the
5334 if (temp[seglen] == '\0') { ptr--; break; }
5335 yield = string_cat(yield, &size, &ptr, outsep, 1);
5339 /* Output a separator after the string: we will remove the redundant
5340 final one at the end. */
5342 yield = string_cat(yield, &size, &ptr, outsep, 1);
5343 } /* End of iteration over the list loop */
5345 /* REDUCE has generated no output above: output the final value of
5348 if (item_type == EITEM_REDUCE)
5350 yield = string_cat(yield, &size, &ptr, lookup_value,
5351 Ustrlen(lookup_value));
5352 lookup_value = save_lookup_value; /* Restore $value */
5355 /* FILTER and MAP generate lists: if they have generated anything, remove
5356 the redundant final separator. Even though an empty item at the end of a
5357 list does not count, this is tidier. */
5359 else if (ptr != save_ptr) ptr--;
5361 /* Restore preserved $item */
5363 iterate_item = save_iterate_item;
5368 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5369 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5370 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5371 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5373 #define EXPAND_DLFUNC_MAX_ARGS 8
5376 #ifndef EXPAND_DLFUNC
5377 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5378 "is not included in this binary";
5381 #else /* EXPAND_DLFUNC */
5384 exim_dlfunc_t *func;
5387 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5389 if ((expand_forbid & RDO_DLFUNC) != 0)
5391 expand_string_message =
5392 US"dynamically-loaded functions are not permitted";
5396 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5399 case 1: goto EXPAND_FAILED_CURLY;
5401 case 3: goto EXPAND_FAILED;
5404 /* If skipping, we don't actually do anything */
5406 if (skipping) continue;
5408 /* Look up the dynamically loaded object handle in the tree. If it isn't
5409 found, dlopen() the file and put the handle in the tree for next time. */
5411 t = tree_search(dlobj_anchor, argv[0]);
5414 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5417 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5418 argv[0], dlerror());
5419 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5422 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5423 Ustrcpy(t->name, argv[0]);
5424 t->data.ptr = handle;
5425 (void)tree_insertnode(&dlobj_anchor, t);
5428 /* Having obtained the dynamically loaded object handle, look up the
5429 function pointer. */
5431 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5434 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5435 "%s", argv[1], argv[0], dlerror());
5436 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5440 /* Call the function and work out what to do with the result. If it
5441 returns OK, we have a replacement string; if it returns DEFER then
5442 expansion has failed in a non-forced manner; if it returns FAIL then
5443 failure was forced; if it returns ERROR or any other value there's a
5444 problem, so panic slightly. In any case, assume that the function has
5445 side-effects on the store that must be preserved. */
5449 for (argc = 0; argv[argc] != NULL; argc++);
5450 status = func(&result, argc - 2, &argv[2]);
5453 if (result == NULL) result = US"";
5454 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5459 expand_string_message = result == NULL ? US"(no message)" : result;
5460 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5461 else if(status != FAIL)
5462 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5463 argv[0], argv[1], status, expand_string_message);
5467 #endif /* EXPAND_DLFUNC */
5470 /* Control reaches here if the name is not recognized as one of the more
5471 complicated expansion items. Check for the "operator" syntax (name terminated
5472 by a colon). Some of the operators have arguments, separated by _ from the
5479 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5480 if (sub == NULL) goto EXPAND_FAILED;
5483 /* Owing to an historical mis-design, an underscore may be part of the
5484 operator name, or it may introduce arguments. We therefore first scan the
5485 table of names that contain underscores. If there is no match, we cut off
5486 the arguments and then scan the main table. */
5488 c = chop_match(name, op_table_underscore,
5489 sizeof(op_table_underscore)/sizeof(uschar *));
5493 arg = Ustrchr(name, '_');
5494 if (arg != NULL) *arg = 0;
5495 c = chop_match(name, op_table_main,
5496 sizeof(op_table_main)/sizeof(uschar *));
5497 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5498 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5501 /* If we are skipping, we don't need to perform the operation at all.
5502 This matters for operations like "mask", because the data may not be
5503 in the correct format when skipping. For example, the expression may test
5504 for the existence of $sender_host_address before trying to mask it. For
5505 other operations, doing them may not fail, but it is a waste of time. */
5507 if (skipping && c >= 0) continue;
5509 /* Otherwise, switch on the operator type */
5516 unsigned long int n = Ustrtoul(sub, &t, 10);
5519 expand_string_message = string_sprintf("argument for base62 "
5520 "operator is \"%s\", which is not a decimal number", sub);
5523 t = string_base62(n);
5524 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5528 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5534 unsigned long int n = 0;
5537 uschar *t = Ustrchr(base62_chars, *tt++);
5540 expand_string_message = string_sprintf("argument for base62d "
5541 "operator is \"%s\", which is not a base %d number", sub,
5545 n = n * BASE_62 + (t - base62_chars);
5547 (void)sprintf(CS buf, "%ld", n);
5548 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5554 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5555 if (expanded == NULL)
5557 expand_string_message =
5558 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5559 expand_string_message);
5562 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5569 uschar *t = sub - 1;
5570 while (*(++t) != 0) { *t = tolower(*t); count++; }
5571 yield = string_cat(yield, &size, &ptr, sub, count);
5578 uschar *t = sub - 1;
5579 while (*(++t) != 0) { *t = toupper(*t); count++; }
5580 yield = string_cat(yield, &size, &ptr, sub, count);
5591 md5_end(&base, sub, Ustrlen(sub), digest);
5592 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5593 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5604 sha1_end(&base, sub, Ustrlen(sub), digest);
5605 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5606 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5610 /* Convert hex encoding to base64 encoding */
5620 for (enc = sub; *enc != 0; enc++)
5622 if (!isxdigit(*enc))
5624 expand_string_message = string_sprintf("\"%s\" is not a hex "
5633 expand_string_message = string_sprintf("\"%s\" contains an odd "
5634 "number of characters", sub);
5638 while ((c = *in++) != 0)
5640 if (isdigit(c)) c -= '0';
5641 else c = toupper(c) - 'A' + 10;
5653 enc = auth_b64encode(sub, out - sub);
5654 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5658 /* count the number of list elements */
5667 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5668 cp = string_sprintf("%d", cnt);
5669 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5673 /* expand a named list given the name */
5674 /* handles nested named lists; requotes as colon-sep list */
5678 tree_node *t = NULL;
5682 uschar * suffix = US"";
5683 BOOL needsep = FALSE;
5686 if (*sub == '+') sub++;
5687 if (arg == NULL) /* no-argument version */
5689 if (!(t = tree_search(addresslist_anchor, sub)) &&
5690 !(t = tree_search(domainlist_anchor, sub)) &&
5691 !(t = tree_search(hostlist_anchor, sub)))
5692 t = tree_search(localpartlist_anchor, sub);
5694 else switch(*arg) /* specific list-type version */
5696 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
5697 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
5698 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
5699 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
5701 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5707 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5709 : *arg=='a'?"address "
5710 : *arg=='d'?"domain "
5712 : *arg=='l'?"localpart "
5717 list = ((namedlist_block *)(t->data.ptr))->string;
5719 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5721 uschar * buf = US" : ";
5723 yield = string_cat(yield, &size, &ptr, buf, 3);
5727 if (*item == '+') /* list item is itself a named list */
5729 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5730 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE);
5732 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5736 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5737 while ((cp= strpbrk((const char *)item, tok)))
5739 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5740 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5742 yield = string_cat(yield, &size, &ptr, US"::", 2);
5743 item = (uschar *)cp;
5745 else /* sep in item; should already be doubled; emit once */
5747 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5748 if (*cp == sep) cp++;
5749 item = (uschar *)cp;
5753 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5758 /* mask applies a mask to an IP address; for example the result of
5759 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5766 int mask, maskoffset;
5767 int type = string_is_ip_address(sub, &maskoffset);
5772 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5777 if (maskoffset == 0)
5779 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5784 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5786 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5788 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5793 /* Convert the address to binary integer(s) and apply the mask */
5795 sub[maskoffset] = 0;
5796 count = host_aton(sub, binary);
5797 host_mask(count, binary, mask);
5799 /* Convert to masked textual format and add to output. */
5801 yield = string_cat(yield, &size, &ptr, buffer,
5802 host_nmtoa(count, binary, mask, buffer, '.'));
5807 case EOP_LOCAL_PART:
5811 int start, end, domain;
5812 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5816 if (c != EOP_DOMAIN)
5818 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5819 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5821 else if (domain != 0)
5824 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5832 uschar outsep[2] = { ':', '\0' };
5833 uschar *address, *error;
5835 int start, end, domain; /* Not really used */
5837 while (isspace(*sub)) sub++;
5838 if (*sub == '>') { *outsep = *++sub; ++sub; }
5839 parse_allow_group = TRUE;
5843 uschar *p = parse_find_address_end(sub, FALSE);
5844 uschar saveend = *p;
5846 address = parse_extract_address(sub, &error, &start, &end, &domain,
5850 /* Add the address to the output list that we are building. This is
5851 done in chunks by searching for the separator character. At the
5852 start, unless we are dealing with the first address of the output
5853 list, add in a space if the new address begins with the separator
5854 character, or is an empty string. */
5856 if (address != NULL)
5858 if (ptr != save_ptr && address[0] == *outsep)
5859 yield = string_cat(yield, &size, &ptr, US" ", 1);
5863 size_t seglen = Ustrcspn(address, outsep);
5864 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5866 /* If we got to the end of the string we output one character
5869 if (address[seglen] == '\0') { ptr--; break; }
5870 yield = string_cat(yield, &size, &ptr, outsep, 1);
5871 address += seglen + 1;
5874 /* Output a separator after the string: we will remove the
5875 redundant final one at the end. */
5877 yield = string_cat(yield, &size, &ptr, outsep, 1);
5880 if (saveend == '\0') break;
5884 /* If we have generated anything, remove the redundant final
5887 if (ptr != save_ptr) ptr--;
5888 parse_allow_group = FALSE;
5893 /* quote puts a string in quotes if it is empty or contains anything
5894 other than alphamerics, underscore, dot, or hyphen.
5896 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5897 be quoted in order to be a valid local part.
5899 In both cases, newlines and carriage returns are converted into \n and \r
5903 case EOP_QUOTE_LOCAL_PART:
5906 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5907 uschar *t = sub - 1;
5911 while (!needs_quote && *(++t) != 0)
5912 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5914 else /* EOP_QUOTE_LOCAL_PART */
5916 while (!needs_quote && *(++t) != 0)
5917 needs_quote = !isalnum(*t) &&
5918 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5919 (*t != '.' || t == sub || t[1] == 0);
5924 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5929 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5930 else if (*t == '\r')
5931 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5934 if (*t == '\\' || *t == '"')
5935 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5936 yield = string_cat(yield, &size, &ptr, t, 1);
5939 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5941 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5945 /* quote_lookuptype does lookup-specific quoting */
5950 uschar *opt = Ustrchr(arg, '_');
5952 if (opt != NULL) *opt++ = 0;
5954 n = search_findtype(arg, Ustrlen(arg));
5957 expand_string_message = search_error_message;
5961 if (lookup_list[n]->quote != NULL)
5962 sub = (lookup_list[n]->quote)(sub, opt);
5963 else if (opt != NULL) sub = NULL;
5967 expand_string_message = string_sprintf(
5968 "\"%s\" unrecognized after \"${quote_%s\"",
5973 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5977 /* rx quote sticks in \ before any non-alphameric character so that
5978 the insertion works in a regular expression. */
5982 uschar *t = sub - 1;
5986 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5987 yield = string_cat(yield, &size, &ptr, t, 1);
5992 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5993 prescribed by the RFC, if there are characters that need to be encoded */
5997 uschar buffer[2048];
5998 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5999 buffer, sizeof(buffer), FALSE);
6000 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6004 /* RFC 2047 decode */
6010 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6011 headers_charset, '?', &len, &error);
6014 expand_string_message = error;
6017 yield = string_cat(yield, &size, &ptr, decoded, len);
6021 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6031 if (c > 255) c = '_';
6033 yield = string_cat(yield, &size, &ptr, buff, 1);
6038 /* escape turns all non-printing characters into escape sequences. */
6042 uschar *t = string_printing(sub);
6043 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6047 /* Handle numeric expression evaluation */
6052 uschar *save_sub = sub;
6053 uschar *error = NULL;
6054 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6057 expand_string_message = string_sprintf("error in expression "
6058 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6062 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6063 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6067 /* Handle time period formating */
6071 int n = readconf_readtime(sub, 0, FALSE);
6074 expand_string_message = string_sprintf("string \"%s\" is not an "
6075 "Exim time interval in \"%s\" operator", sub, name);
6078 sprintf(CS var_buffer, "%d", n);
6079 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6083 case EOP_TIME_INTERVAL:
6086 uschar *t = read_number(&n, sub);
6087 if (*t != 0) /* Not A Number*/
6089 expand_string_message = string_sprintf("string \"%s\" is not a "
6090 "positive number in \"%s\" operator", sub, name);
6093 t = readconf_printtime(n);
6094 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6098 /* Convert string to base64 encoding */
6102 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6103 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6107 /* strlen returns the length of the string */
6112 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6113 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6117 /* length_n or l_n takes just the first n characters or the whole string,
6118 whichever is the shorter;
6120 substr_m_n, and s_m_n take n characters from offset m; negative m take
6121 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6122 takes the rest, either to the right or to the left.
6124 hash_n or h_n makes a hash of length n from the string, yielding n
6125 characters from the set a-z; hash_n_m makes a hash of length n, but
6126 uses m characters from the set a-zA-Z0-9.
6128 nhash_n returns a single number between 0 and n-1 (in text form), while
6129 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6130 between 0 and n-1 and the second between 0 and m-1. */
6150 expand_string_message = string_sprintf("missing values after %s",
6155 /* "length" has only one argument, effectively being synonymous with
6158 if (c == EOP_LENGTH || c == EOP_L)
6164 /* The others have one or two arguments; for "substr" the first may be
6165 negative. The second being negative means "not supplied". */
6170 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6173 /* Read up to two numbers, separated by underscores */
6178 if (arg != ret && *arg == '_' && pn == &value1)
6182 if (arg[1] != 0) arg++;
6184 else if (!isdigit(*arg))
6186 expand_string_message =
6187 string_sprintf("non-digit after underscore in \"%s\"", name);
6190 else *pn = (*pn)*10 + *arg++ - '0';
6194 /* Perform the required operation */
6197 (c == EOP_HASH || c == EOP_H)?
6198 compute_hash(sub, value1, value2, &len) :
6199 (c == EOP_NHASH || c == EOP_NH)?
6200 compute_nhash(sub, value1, value2, &len) :
6201 extract_substr(sub, value1, value2, &len);
6203 if (ret == NULL) goto EXPAND_FAILED;
6204 yield = string_cat(yield, &size, &ptr, ret, len);
6214 uschar **modetable[3];
6219 if ((expand_forbid & RDO_EXISTS) != 0)
6221 expand_string_message = US"Use of the stat() expansion is not permitted";
6225 if (stat(CS sub, &st) < 0)
6227 expand_string_message = string_sprintf("stat(%s) failed: %s",
6228 sub, strerror(errno));
6232 switch (mode & S_IFMT)
6234 case S_IFIFO: smode[0] = 'p'; break;
6235 case S_IFCHR: smode[0] = 'c'; break;
6236 case S_IFDIR: smode[0] = 'd'; break;
6237 case S_IFBLK: smode[0] = 'b'; break;
6238 case S_IFREG: smode[0] = '-'; break;
6239 default: smode[0] = '?'; break;
6242 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6243 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6244 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6246 for (i = 0; i < 3; i++)
6248 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6253 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6254 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6255 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6256 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6257 (long)st.st_gid, st.st_size, (long)st.st_atime,
6258 (long)st.st_mtime, (long)st.st_ctime);
6259 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6263 /* vaguely random number less than N */
6267 int_eximarith_t max;
6270 max = expand_string_integer(sub, TRUE);
6271 if (expand_string_message != NULL)
6273 s = string_sprintf("%d", vaguely_random_number((int)max));
6274 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6278 /* Reverse IP, including IPv6 to dotted-nibble */
6280 case EOP_REVERSE_IP:
6282 int family, maskptr;
6283 uschar reversed[128];
6285 family = string_is_ip_address(sub, &maskptr);
6288 expand_string_message = string_sprintf(
6289 "reverse_ip() not given an IP address [%s]", sub);
6292 invert_address(reversed, sub);
6293 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6297 /* Unknown operator */
6300 expand_string_message =
6301 string_sprintf("unknown expansion operator \"%s\"", name);
6306 /* Handle a plain name. If this is the first thing in the expansion, release
6307 the pre-allocated buffer. If the result data is known to be in a new buffer,
6308 newsize will be set to the size of that buffer, and we can just point at that
6309 store instead of copying. Many expansion strings contain just one reference,
6310 so this is a useful optimization, especially for humungous headers
6311 ($message_headers). */
6319 if (resetok) store_reset(yield);
6323 value = find_variable(name, FALSE, skipping, &newsize);
6326 expand_string_message =
6327 string_sprintf("unknown variable in \"${%s}\"", name);
6328 check_variable_error_message(name);
6331 len = Ustrlen(value);
6332 if (yield == NULL && newsize != 0)
6338 else yield = string_cat(yield, &size, &ptr, value, len);
6342 /* Else there's something wrong */
6344 expand_string_message =
6345 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6346 "in a variable reference)", name);
6350 /* If we hit the end of the string when ket_ends is set, there is a missing
6351 terminating brace. */
6353 if (ket_ends && *s == 0)
6355 expand_string_message = malformed_header?
6356 US"missing } at end of string - could be header name not terminated by colon"
6358 US"missing } at end of string";
6362 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6363 added to the string. If so, set up an empty string. Add a terminating zero. If
6364 left != NULL, return a pointer to the terminator. */
6366 if (yield == NULL) yield = store_get(1);
6368 if (left != NULL) *left = s;
6370 /* Any stacking store that was used above the final string is no longer needed.
6371 In many cases the final string will be the first one that was got and so there
6372 will be optimal store usage. */
6374 if (resetok) store_reset(yield + ptr + 1);
6377 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6379 if (skipping) debug_printf("skipping: result is not used\n");
6383 /* This is the failure exit: easiest to program with a goto. We still need
6384 to update the pointer to the terminator, for cases of nested calls with "fail".
6387 EXPAND_FAILED_CURLY:
6388 expand_string_message = malformed_header?
6389 US"missing or misplaced { or } - could be header name not terminated by colon"
6391 US"missing or misplaced { or }";
6393 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6394 that is a bad idea, because expand_string_message is in dynamic store. */
6397 if (left != NULL) *left = s;
6400 debug_printf("failed to expand: %s\n", string);
6401 debug_printf(" error message: %s\n", expand_string_message);
6402 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6408 /* This is the external function call. Do a quick check for any expansion
6409 metacharacters, and if there are none, just return the input string.
6411 Argument: the string to be expanded
6412 Returns: the expanded string, or NULL if expansion failed; if failure was
6413 due to a lookup deferring, search_find_defer will be TRUE
6417 expand_string(uschar *string)
6419 search_find_defer = FALSE;
6420 malformed_header = FALSE;
6421 return (Ustrpbrk(string, "$\\") == NULL)? string :
6422 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6427 /*************************************************
6429 *************************************************/
6431 /* Now and again we want to expand a string and be sure that the result is in a
6432 new bit of store. This function does that.
6434 Argument: the string to be expanded
6435 Returns: the expanded string, always in a new bit of store, or NULL
6439 expand_string_copy(uschar *string)
6441 uschar *yield = expand_string(string);
6442 if (yield == string) yield = string_copy(string);
6448 /*************************************************
6449 * Expand and interpret as an integer *
6450 *************************************************/
6452 /* Expand a string, and convert the result into an integer.
6455 string the string to be expanded
6456 isplus TRUE if a non-negative number is expected
6458 Returns: the integer value, or
6459 -1 for an expansion error ) in both cases, message in
6460 -2 for an integer interpretation error ) expand_string_message
6461 expand_string_message is set NULL for an OK integer
6465 expand_string_integer(uschar *string, BOOL isplus)
6467 int_eximarith_t value;
6468 uschar *s = expand_string(string);
6469 uschar *msg = US"invalid integer \"%s\"";
6472 /* If expansion failed, expand_string_message will be set. */
6474 if (s == NULL) return -1;
6476 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6477 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6478 systems, so we set it zero ourselves. */
6481 expand_string_message = NULL; /* Indicates no error */
6483 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6484 equal to 0. Unfortunately, people actually relied upon that, so preserve
6485 the behaviour explicitly. Stripping leading whitespace is a harmless
6486 noop change since strtol skips it anyway (provided that there is a number
6490 while (isspace(*s)) ++s;
6494 debug_printf("treating blank string as number 0\n");
6499 value = strtoll(CS s, CSS &endptr, 10);
6503 msg = US"integer expected but \"%s\" found";
6505 else if (value < 0 && isplus)
6507 msg = US"non-negative integer expected but \"%s\" found";
6511 switch (tolower(*endptr))
6516 if (value > LLONG_MAX/1024 || value < LLONG_MIN/1024) errno = ERANGE;
6521 if (value > LLONG_MAX/(1024*1024) || value < LLONG_MIN/(1024*1024)) errno = ERANGE;
6522 else value *= 1024*1024;
6526 if (value > LLONG_MAX/(1024*1024*1024) || value < LLONG_MIN/(1024*1024*1024)) errno = ERANGE;
6527 else value *= 1024*1024*1024;
6531 if (errno == ERANGE)
6532 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6535 while (isspace(*endptr)) endptr++;
6536 if (*endptr == 0) return (int)value;
6540 expand_string_message = string_sprintf(CS msg, s);
6545 /*************************************************
6546 **************************************************
6547 * Stand-alone test program *
6548 **************************************************
6549 *************************************************/
6555 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6557 int ovector[3*(EXPAND_MAXN+1)];
6558 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6559 ovector, sizeof(ovector)/sizeof(int));
6560 BOOL yield = n >= 0;
6561 if (n == 0) n = EXPAND_MAXN + 1;
6565 expand_nmax = (setup < 0)? 0 : setup + 1;
6566 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6568 expand_nstring[expand_nmax] = subject + ovector[nn];
6569 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6577 int main(int argc, uschar **argv)
6580 uschar buffer[1024];
6582 debug_selector = D_v;
6583 debug_file = stderr;
6584 debug_fd = fileno(debug_file);
6585 big_buffer = malloc(big_buffer_size);
6587 for (i = 1; i < argc; i++)
6589 if (argv[i][0] == '+')
6591 debug_trace_memory = 2;
6594 if (isdigit(argv[i][0]))
6595 debug_selector = Ustrtol(argv[i], NULL, 0);
6597 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6601 eldap_default_servers = argv[i];
6604 mysql_servers = argv[i];
6607 pgsql_servers = argv[i];
6611 else opt_perl_startup = argv[i];
6615 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6617 expand_nstring[1] = US"string 1....";
6618 expand_nlength[1] = 8;
6622 if (opt_perl_startup != NULL)
6625 printf("Starting Perl interpreter\n");
6626 errstr = init_perl(opt_perl_startup);
6629 printf("** error in perl_startup code: %s\n", errstr);
6630 return EXIT_FAILURE;
6633 #endif /* EXIM_PERL */
6635 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6637 void *reset_point = store_get(0);
6638 uschar *yield = expand_string(buffer);
6641 printf("%s\n", yield);
6642 store_reset(reset_point);
6646 if (search_find_defer) printf("search_find deferred\n");
6647 printf("Failed: %s\n", expand_string_message);
6648 if (expand_string_forcedfail) printf("Forced failure\n");
6660 /* End of expand.c */