1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, BOOL);
19 #ifndef SUPPORT_CRYPTEQ
20 #define SUPPORT_CRYPTEQ
25 #include "lookups/ldap.h"
28 #ifdef SUPPORT_CRYPTEQ
33 extern char* crypt16(char*, char*);
37 /* The handling of crypt16() is a mess. I will record below the analysis of the
38 mess that was sent to me. We decided, however, to make changing this very low
39 priority, because in practice people are moving away from the crypt()
40 algorithms nowadays, so it doesn't seem worth it.
43 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
44 the first 8 characters of the password using a 20-round version of crypt
45 (standard crypt does 25 rounds). It then crypts the next 8 characters,
46 or an empty block if the password is less than 9 characters, using a
47 20-round version of crypt and the same salt as was used for the first
48 block. Charaters after the first 16 are ignored. It always generates
49 a 16-byte hash, which is expressed together with the salt as a string
50 of 24 base 64 digits. Here are some links to peruse:
52 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
53 http://seclists.org/bugtraq/1999/Mar/0076.html
55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
56 and OSF/1. This is the same as the standard crypt if given a password
57 of 8 characters or less. If given more, it first does the same as crypt
58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
59 using as salt the first two base 64 digits from the first hash block.
60 If the password is more than 16 characters then it crypts the 17th to 24th
61 characters using as salt the first two base 64 digits from the second hash
62 block. And so on: I've seen references to it cutting off the password at
63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0109.html
67 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
68 TET1_html/sec.c222.html#no_id_208
70 Exim has something it calls "crypt16". It will either use a native
71 crypt16 or its own implementation. A native crypt16 will presumably
72 be the one that I called "crypt16" above. The internal "crypt16"
73 function, however, is a two-block-maximum implementation of what I called
74 "bigcrypt". The documentation matches the internal code.
76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
77 that crypt16 and bigcrypt were different things.
79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
80 to whatever it is using under that name. This unfortunately sets a
81 precedent for using "{crypt16}" to identify two incompatible algorithms
82 whose output can't be distinguished. With "{crypt16}" thus rendered
83 ambiguous, I suggest you deprecate it and invent two new identifiers
84 for the two algorithms.
86 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
87 of the password separately means they can be cracked separately, so
88 the double-length hash only doubles the cracking effort instead of
89 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
150 /* Tables of operator names, and corresponding switch numbers. The names must be
151 in alphabetical order. There are two tables, because underscore is used in some
152 cases to introduce arguments, whereas for other it is part of the name. This is
153 an historical mis-design. */
155 static uschar *op_table_underscore[] = {
158 US"quote_local_part",
166 EOP_QUOTE_LOCAL_PART,
171 static uschar *op_table_main[] = {
207 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
242 /* Table of condition names, and corresponding switch numbers. The names must
243 be in alphabetical order. */
245 static uschar *cond_table[] = {
249 US"==", /* Backward compatibility */
281 US"match_local_part",
305 ECOND_FIRST_DELIVERY,
326 ECOND_MATCH_LOCAL_PART,
336 /* Type for main variable table */
344 /* Type for entries pointing to address/length pairs. Not currently
352 /* Types of table entry */
355 vtype_int, /* value is address of int */
356 vtype_filter_int, /* ditto, but recognized only when filtering */
357 vtype_ino, /* value is address of ino_t (not always an int) */
358 vtype_uid, /* value is address of uid_t (not always an int) */
359 vtype_gid, /* value is address of gid_t (not always an int) */
360 vtype_bool, /* value is address of bool */
361 vtype_stringptr, /* value is address of pointer to string */
362 vtype_msgbody, /* as stringptr, but read when first required */
363 vtype_msgbody_end, /* ditto, the end of the message */
364 vtype_msgheaders, /* the message's headers, processed */
365 vtype_msgheaders_raw, /* the message's headers, unprocessed */
366 vtype_localpart, /* extract local part from string */
367 vtype_domain, /* extract domain from string */
368 vtype_recipients, /* extract recipients from recipients list */
369 /* (available only in system filters, ACLs, and */
371 vtype_todbsdin, /* value not used; generate BSD inbox tod */
372 vtype_tode, /* value not used; generate tod in epoch format */
373 vtype_todel, /* value not used; generate tod in epoch/usec format */
374 vtype_todf, /* value not used; generate full tod */
375 vtype_todl, /* value not used; generate log tod */
376 vtype_todlf, /* value not used; generate log file datestamp tod */
377 vtype_todzone, /* value not used; generate time zone only */
378 vtype_todzulu, /* value not used; generate zulu tod */
379 vtype_reply, /* value not used; get reply from headers */
380 vtype_pid, /* value not used; result is pid */
381 vtype_host_lookup, /* value not used; get host name */
382 vtype_load_avg, /* value not used; result is int from os_getloadavg */
383 vtype_pspace, /* partition space; value is T/F for spool/log */
384 vtype_pinodes /* partition inodes; value is T/F for spool/log */
386 ,vtype_dkim /* Lookup of value in DKIM signature */
390 /* This table must be kept in alphabetical order. */
392 static var_entry var_table[] = {
393 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
394 they will be confused with user-creatable ACL variables. */
395 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
396 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
397 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
398 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
399 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
400 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
401 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
402 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
403 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
404 { "acl_narg", vtype_int, &acl_narg },
405 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
406 { "address_data", vtype_stringptr, &deliver_address_data },
407 { "address_file", vtype_stringptr, &address_file },
408 { "address_pipe", vtype_stringptr, &address_pipe },
409 { "authenticated_id", vtype_stringptr, &authenticated_id },
410 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
411 { "authentication_failed",vtype_int, &authentication_failed },
412 #ifdef WITH_CONTENT_SCAN
413 { "av_failed", vtype_int, &av_failed },
415 #ifdef EXPERIMENTAL_BRIGHTMAIL
416 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
417 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
418 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
419 { "bmi_deliver", vtype_int, &bmi_deliver },
421 { "body_linecount", vtype_int, &body_linecount },
422 { "body_zerocount", vtype_int, &body_zerocount },
423 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
424 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
425 { "caller_gid", vtype_gid, &real_gid },
426 { "caller_uid", vtype_uid, &real_uid },
427 { "compile_date", vtype_stringptr, &version_date },
428 { "compile_number", vtype_stringptr, &version_cnumber },
429 { "csa_status", vtype_stringptr, &csa_status },
430 #ifdef EXPERIMENTAL_DCC
431 { "dcc_header", vtype_stringptr, &dcc_header },
432 { "dcc_result", vtype_stringptr, &dcc_result },
434 #ifdef WITH_OLD_DEMIME
435 { "demime_errorlevel", vtype_int, &demime_errorlevel },
436 { "demime_reason", vtype_stringptr, &demime_reason },
439 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
440 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
441 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
442 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
443 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
444 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
445 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
446 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
447 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
448 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
449 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
450 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
451 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
452 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
453 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
454 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
455 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
456 { "dkim_signers", vtype_stringptr, &dkim_signers },
457 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
458 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
460 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
461 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
462 { "dnslist_text", vtype_stringptr, &dnslist_text },
463 { "dnslist_value", vtype_stringptr, &dnslist_value },
464 { "domain", vtype_stringptr, &deliver_domain },
465 { "domain_data", vtype_stringptr, &deliver_domain_data },
466 { "exim_gid", vtype_gid, &exim_gid },
467 { "exim_path", vtype_stringptr, &exim_path },
468 { "exim_uid", vtype_uid, &exim_uid },
469 #ifdef WITH_OLD_DEMIME
470 { "found_extension", vtype_stringptr, &found_extension },
472 { "home", vtype_stringptr, &deliver_home },
473 { "host", vtype_stringptr, &deliver_host },
474 { "host_address", vtype_stringptr, &deliver_host_address },
475 { "host_data", vtype_stringptr, &host_data },
476 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
477 { "host_lookup_failed", vtype_int, &host_lookup_failed },
478 { "inode", vtype_ino, &deliver_inode },
479 { "interface_address", vtype_stringptr, &interface_address },
480 { "interface_port", vtype_int, &interface_port },
481 { "item", vtype_stringptr, &iterate_item },
483 { "ldap_dn", vtype_stringptr, &eldap_dn },
485 { "load_average", vtype_load_avg, NULL },
486 { "local_part", vtype_stringptr, &deliver_localpart },
487 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
488 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
489 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
490 { "local_scan_data", vtype_stringptr, &local_scan_data },
491 { "local_user_gid", vtype_gid, &local_user_gid },
492 { "local_user_uid", vtype_uid, &local_user_uid },
493 { "localhost_number", vtype_int, &host_number },
494 { "log_inodes", vtype_pinodes, (void *)FALSE },
495 { "log_space", vtype_pspace, (void *)FALSE },
496 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
497 #ifdef WITH_CONTENT_SCAN
498 { "malware_name", vtype_stringptr, &malware_name },
500 { "max_received_linelength", vtype_int, &max_received_linelength },
501 { "message_age", vtype_int, &message_age },
502 { "message_body", vtype_msgbody, &message_body },
503 { "message_body_end", vtype_msgbody_end, &message_body_end },
504 { "message_body_size", vtype_int, &message_body_size },
505 { "message_exim_id", vtype_stringptr, &message_id },
506 { "message_headers", vtype_msgheaders, NULL },
507 { "message_headers_raw", vtype_msgheaders_raw, NULL },
508 { "message_id", vtype_stringptr, &message_id },
509 { "message_linecount", vtype_int, &message_linecount },
510 { "message_size", vtype_int, &message_size },
511 #ifdef WITH_CONTENT_SCAN
512 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
513 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
514 { "mime_boundary", vtype_stringptr, &mime_boundary },
515 { "mime_charset", vtype_stringptr, &mime_charset },
516 { "mime_content_description", vtype_stringptr, &mime_content_description },
517 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
518 { "mime_content_id", vtype_stringptr, &mime_content_id },
519 { "mime_content_size", vtype_int, &mime_content_size },
520 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
521 { "mime_content_type", vtype_stringptr, &mime_content_type },
522 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
523 { "mime_filename", vtype_stringptr, &mime_filename },
524 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
525 { "mime_is_multipart", vtype_int, &mime_is_multipart },
526 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
527 { "mime_part_count", vtype_int, &mime_part_count },
529 { "n0", vtype_filter_int, &filter_n[0] },
530 { "n1", vtype_filter_int, &filter_n[1] },
531 { "n2", vtype_filter_int, &filter_n[2] },
532 { "n3", vtype_filter_int, &filter_n[3] },
533 { "n4", vtype_filter_int, &filter_n[4] },
534 { "n5", vtype_filter_int, &filter_n[5] },
535 { "n6", vtype_filter_int, &filter_n[6] },
536 { "n7", vtype_filter_int, &filter_n[7] },
537 { "n8", vtype_filter_int, &filter_n[8] },
538 { "n9", vtype_filter_int, &filter_n[9] },
539 { "original_domain", vtype_stringptr, &deliver_domain_orig },
540 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
541 { "originator_gid", vtype_gid, &originator_gid },
542 { "originator_uid", vtype_uid, &originator_uid },
543 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
544 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
545 { "pid", vtype_pid, NULL },
546 { "primary_hostname", vtype_stringptr, &primary_hostname },
547 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
548 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
549 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
550 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
551 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
552 { "rcpt_count", vtype_int, &rcpt_count },
553 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
554 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
555 { "received_count", vtype_int, &received_count },
556 { "received_for", vtype_stringptr, &received_for },
557 { "received_ip_address", vtype_stringptr, &interface_address },
558 { "received_port", vtype_int, &interface_port },
559 { "received_protocol", vtype_stringptr, &received_protocol },
560 { "received_time", vtype_int, &received_time },
561 { "recipient_data", vtype_stringptr, &recipient_data },
562 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
563 { "recipients", vtype_recipients, NULL },
564 { "recipients_count", vtype_int, &recipients_count },
565 #ifdef WITH_CONTENT_SCAN
566 { "regex_match_string", vtype_stringptr, ®ex_match_string },
568 { "reply_address", vtype_reply, NULL },
569 { "return_path", vtype_stringptr, &return_path },
570 { "return_size_limit", vtype_int, &bounce_return_size_limit },
571 { "runrc", vtype_int, &runrc },
572 { "self_hostname", vtype_stringptr, &self_hostname },
573 { "sender_address", vtype_stringptr, &sender_address },
574 { "sender_address_data", vtype_stringptr, &sender_address_data },
575 { "sender_address_domain", vtype_domain, &sender_address },
576 { "sender_address_local_part", vtype_localpart, &sender_address },
577 { "sender_data", vtype_stringptr, &sender_data },
578 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
579 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
580 { "sender_host_address", vtype_stringptr, &sender_host_address },
581 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
582 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
583 { "sender_host_name", vtype_host_lookup, NULL },
584 { "sender_host_port", vtype_int, &sender_host_port },
585 { "sender_ident", vtype_stringptr, &sender_ident },
586 { "sender_rate", vtype_stringptr, &sender_rate },
587 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
588 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
589 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
590 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
591 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
592 { "sending_port", vtype_int, &sending_port },
593 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
594 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
595 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
596 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
597 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
598 { "sn0", vtype_filter_int, &filter_sn[0] },
599 { "sn1", vtype_filter_int, &filter_sn[1] },
600 { "sn2", vtype_filter_int, &filter_sn[2] },
601 { "sn3", vtype_filter_int, &filter_sn[3] },
602 { "sn4", vtype_filter_int, &filter_sn[4] },
603 { "sn5", vtype_filter_int, &filter_sn[5] },
604 { "sn6", vtype_filter_int, &filter_sn[6] },
605 { "sn7", vtype_filter_int, &filter_sn[7] },
606 { "sn8", vtype_filter_int, &filter_sn[8] },
607 { "sn9", vtype_filter_int, &filter_sn[9] },
608 #ifdef WITH_CONTENT_SCAN
609 { "spam_bar", vtype_stringptr, &spam_bar },
610 { "spam_report", vtype_stringptr, &spam_report },
611 { "spam_score", vtype_stringptr, &spam_score },
612 { "spam_score_int", vtype_stringptr, &spam_score_int },
614 #ifdef EXPERIMENTAL_SPF
615 { "spf_guess", vtype_stringptr, &spf_guess },
616 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
617 { "spf_received", vtype_stringptr, &spf_received },
618 { "spf_result", vtype_stringptr, &spf_result },
619 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
621 { "spool_directory", vtype_stringptr, &spool_directory },
622 { "spool_inodes", vtype_pinodes, (void *)TRUE },
623 { "spool_space", vtype_pspace, (void *)TRUE },
624 #ifdef EXPERIMENTAL_SRS
625 { "srs_db_address", vtype_stringptr, &srs_db_address },
626 { "srs_db_key", vtype_stringptr, &srs_db_key },
627 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
628 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
629 { "srs_recipient", vtype_stringptr, &srs_recipient },
630 { "srs_status", vtype_stringptr, &srs_status },
632 { "thisaddress", vtype_stringptr, &filter_thisaddress },
634 /* The non-(in,out) variables are now deprecated */
635 { "tls_bits", vtype_int, &tls_in.bits },
636 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
637 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
639 { "tls_in_bits", vtype_int, &tls_in.bits },
640 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
641 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
642 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
643 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
644 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
646 { "tls_out_bits", vtype_int, &tls_out.bits },
647 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
648 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
649 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
650 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
651 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
654 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
655 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
656 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
659 { "tod_bsdinbox", vtype_todbsdin, NULL },
660 { "tod_epoch", vtype_tode, NULL },
661 { "tod_epoch_l", vtype_todel, NULL },
662 { "tod_full", vtype_todf, NULL },
663 { "tod_log", vtype_todl, NULL },
664 { "tod_logfile", vtype_todlf, NULL },
665 { "tod_zone", vtype_todzone, NULL },
666 { "tod_zulu", vtype_todzulu, NULL },
667 { "value", vtype_stringptr, &lookup_value },
668 { "version_number", vtype_stringptr, &version_string },
669 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
670 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
671 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
672 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
673 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
674 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
677 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
678 static uschar var_buffer[256];
679 static BOOL malformed_header;
681 /* For textual hashes */
683 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
684 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
687 enum { HMAC_MD5, HMAC_SHA1 };
689 /* For numeric hashes */
691 static unsigned int prime[] = {
692 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
693 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
694 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
696 /* For printing modes in symbolic form */
698 static uschar *mtable_normal[] =
699 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
701 static uschar *mtable_setid[] =
702 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
704 static uschar *mtable_sticky[] =
705 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
709 /*************************************************
710 * Tables for UTF-8 support *
711 *************************************************/
713 /* Table of the number of extra characters, indexed by the first character
714 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
717 static uschar utf8_table1[] = {
718 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
719 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
720 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
721 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
723 /* These are the masks for the data bits in the first byte of a character,
724 indexed by the number of additional bytes. */
726 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
728 /* Get the next UTF-8 character, advancing the pointer. */
730 #define GETUTF8INC(c, ptr) \
732 if ((c & 0xc0) == 0xc0) \
734 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
736 c = (c & utf8_table2[a]) << s; \
740 c |= (*ptr++ & 0x3f) << s; \
745 /*************************************************
746 * Binary chop search on a table *
747 *************************************************/
749 /* This is used for matching expansion items and operators.
752 name the name that is being sought
753 table the table to search
754 table_size the number of items in the table
756 Returns: the offset in the table, or -1
760 chop_match(uschar *name, uschar **table, int table_size)
762 uschar **bot = table;
763 uschar **top = table + table_size;
767 uschar **mid = bot + (top - bot)/2;
768 int c = Ustrcmp(name, *mid);
769 if (c == 0) return mid - table;
770 if (c > 0) bot = mid + 1; else top = mid;
778 /*************************************************
779 * Check a condition string *
780 *************************************************/
782 /* This function is called to expand a string, and test the result for a "true"
783 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
784 forced fail or lookup defer. All store used by the function can be released on
787 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
790 condition the condition string
791 m1 text to be incorporated in panic error
794 Returns: TRUE if condition is met, FALSE if not
798 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
801 void *reset_point = store_get(0);
802 uschar *ss = expand_string(condition);
805 if (!expand_string_forcedfail && !search_find_defer)
806 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
807 "for %s %s: %s", condition, m1, m2, expand_string_message);
810 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
811 strcmpic(ss, US"false") != 0;
812 store_reset(reset_point);
819 /*************************************************
820 * Pseudo-random number generation *
821 *************************************************/
823 /* Pseudo-random number generation. The result is not "expected" to be
824 cryptographically strong but not so weak that someone will shoot themselves
825 in the foot using it as a nonce in some email header scheme or whatever
826 weirdness they'll twist this into. The result should ideally handle fork().
828 However, if we're stuck unable to provide this, then we'll fall back to
829 appallingly bad randomness.
831 If SUPPORT_TLS is defined then this will not be used except as an emergency
836 Returns a random number in range [0, max-1]
840 # define vaguely_random_number vaguely_random_number_fallback
843 vaguely_random_number(int max)
846 # undef vaguely_random_number
848 static pid_t pid = 0;
850 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
860 #ifdef HAVE_ARC4RANDOM
861 /* cryptographically strong randomness, common on *BSD platforms, not
862 so much elsewhere. Alas. */
864 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
865 #ifdef HAVE_SRANDOMDEV
866 /* uses random(4) for seeding */
869 gettimeofday(&tv, NULL);
870 srandom(tv.tv_sec | tv.tv_usec | getpid());
873 /* Poor randomness and no seeding here */
880 #ifdef HAVE_ARC4RANDOM
881 return arc4random() % max;
882 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
883 return random() % max;
885 /* This one returns a 16-bit number, definitely not crypto-strong */
886 return random_number(max);
893 /*************************************************
894 * Pick out a name from a string *
895 *************************************************/
897 /* If the name is too long, it is silently truncated.
900 name points to a buffer into which to put the name
901 max is the length of the buffer
902 s points to the first alphabetic character of the name
903 extras chars other than alphanumerics to permit
905 Returns: pointer to the first character after the name
907 Note: The test for *s != 0 in the while loop is necessary because
908 Ustrchr() yields non-NULL if the character is zero (which is not something
912 read_name(uschar *name, int max, uschar *s, uschar *extras)
915 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
917 if (ptr < max-1) name[ptr++] = *s;
926 /*************************************************
927 * Pick out the rest of a header name *
928 *************************************************/
930 /* A variable name starting $header_ (or just $h_ for those who like
931 abbreviations) might not be the complete header name because headers can
932 contain any printing characters in their names, except ':'. This function is
933 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
934 on the end, if the name was terminated by white space.
937 name points to a buffer in which the name read so far exists
938 max is the length of the buffer
939 s points to the first character after the name so far, i.e. the
940 first non-alphameric character after $header_xxxxx
942 Returns: a pointer to the first character after the header name
946 read_header_name(uschar *name, int max, uschar *s)
948 int prelen = Ustrchr(name, '_') - name + 1;
949 int ptr = Ustrlen(name) - prelen;
950 if (ptr > 0) memmove(name, name+prelen, ptr);
951 while (mac_isgraph(*s) && *s != ':')
953 if (ptr < max-1) name[ptr++] = *s;
964 /*************************************************
965 * Pick out a number from a string *
966 *************************************************/
969 n points to an integer into which to put the number
970 s points to the first digit of the number
972 Returns: a pointer to the character after the last digit
976 read_number(int *n, uschar *s)
979 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
985 /*************************************************
986 * Extract keyed subfield from a string *
987 *************************************************/
989 /* The yield is in dynamic store; NULL means that the key was not found.
992 key points to the name of the key
993 s points to the string from which to extract the subfield
995 Returns: NULL if the subfield was not found, or
996 a pointer to the subfield's data
1000 expand_getkeyed(uschar *key, uschar *s)
1002 int length = Ustrlen(key);
1003 while (isspace(*s)) s++;
1005 /* Loop to search for the key */
1013 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1014 dkeylength = s - dkey;
1015 while (isspace(*s)) s++;
1016 if (*s == '=') while (isspace((*(++s))));
1018 data = string_dequote(&s);
1019 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1022 while (isspace(*s)) s++;
1031 /*************************************************
1032 * Extract numbered subfield from string *
1033 *************************************************/
1035 /* Extracts a numbered field from a string that is divided by tokens - for
1036 example a line from /etc/passwd is divided by colon characters. First field is
1037 numbered one. Negative arguments count from the right. Zero returns the whole
1038 string. Returns NULL if there are insufficient tokens in the string
1041 Modifies final argument - this is a dynamically generated string, so that's OK.
1044 field number of field to be extracted,
1045 first field = 1, whole string = 0, last field = -1
1046 separators characters that are used to break string into tokens
1047 s points to the string from which to extract the subfield
1049 Returns: NULL if the field was not found,
1050 a pointer to the field's data inside s (modified to add 0)
1054 expand_gettokened (int field, uschar *separators, uschar *s)
1059 uschar *fieldtext = NULL;
1061 if (field == 0) return s;
1063 /* Break the line up into fields in place; for field > 0 we stop when we have
1064 done the number of fields we want. For field < 0 we continue till the end of
1065 the string, counting the number of fields. */
1067 count = (field > 0)? field : INT_MAX;
1073 /* Previous field was the last one in the string. For a positive field
1074 number, this means there are not enough fields. For a negative field number,
1075 check that there are enough, and scan back to find the one that is wanted. */
1079 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1080 if ((-field) == (INT_MAX - count - 1)) return s;
1084 while (ss[-1] != 0) ss--;
1090 /* Previous field was not last in the string; save its start and put a
1094 len = Ustrcspn(ss, separators);
1105 /*************************************************
1106 * Extract a substring from a string *
1107 *************************************************/
1109 /* Perform the ${substr or ${length expansion operations.
1112 subject the input string
1113 value1 the offset from the start of the input string to the start of
1114 the output string; if negative, count from the right.
1115 value2 the length of the output string, or negative (-1) for unset
1116 if value1 is positive, unset means "all after"
1117 if value1 is negative, unset means "all before"
1118 len set to the length of the returned string
1120 Returns: pointer to the output string, or NULL if there is an error
1124 extract_substr(uschar *subject, int value1, int value2, int *len)
1126 int sublen = Ustrlen(subject);
1128 if (value1 < 0) /* count from right */
1132 /* If the position is before the start, skip to the start, and adjust the
1133 length. If the length ends up negative, the substring is null because nothing
1134 can precede. This falls out naturally when the length is unset, meaning "all
1140 if (value2 < 0) value2 = 0;
1144 /* Otherwise an unset length => characters before value1 */
1146 else if (value2 < 0)
1153 /* For a non-negative offset, if the starting position is past the end of the
1154 string, the result will be the null string. Otherwise, an unset length means
1155 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1159 if (value1 > sublen)
1164 else if (value2 < 0) value2 = sublen;
1167 /* Cut the length down to the maximum possible for the offset value, and get
1168 the required characters. */
1170 if (value1 + value2 > sublen) value2 = sublen - value1;
1172 return subject + value1;
1178 /*************************************************
1179 * Old-style hash of a string *
1180 *************************************************/
1182 /* Perform the ${hash expansion operation.
1185 subject the input string (an expanded substring)
1186 value1 the length of the output string; if greater or equal to the
1187 length of the input string, the input string is returned
1188 value2 the number of hash characters to use, or 26 if negative
1189 len set to the length of the returned string
1191 Returns: pointer to the output string, or NULL if there is an error
1195 compute_hash(uschar *subject, int value1, int value2, int *len)
1197 int sublen = Ustrlen(subject);
1199 if (value2 < 0) value2 = 26;
1200 else if (value2 > Ustrlen(hashcodes))
1202 expand_string_message =
1203 string_sprintf("hash count \"%d\" too big", value2);
1207 /* Calculate the hash text. We know it is shorter than the original string, so
1208 can safely place it in subject[] (we know that subject is always itself an
1209 expanded substring). */
1211 if (value1 < sublen)
1216 while ((c = (subject[j])) != 0)
1218 int shift = (c + j++) & 7;
1219 subject[i] ^= (c << shift) | (c >> (8-shift));
1220 if (++i >= value1) i = 0;
1222 for (i = 0; i < value1; i++)
1223 subject[i] = hashcodes[(subject[i]) % value2];
1225 else value1 = sublen;
1234 /*************************************************
1235 * Numeric hash of a string *
1236 *************************************************/
1238 /* Perform the ${nhash expansion operation. The first characters of the
1239 string are treated as most important, and get the highest prime numbers.
1242 subject the input string
1243 value1 the maximum value of the first part of the result
1244 value2 the maximum value of the second part of the result,
1245 or negative to produce only a one-part result
1246 len set to the length of the returned string
1248 Returns: pointer to the output string, or NULL if there is an error.
1252 compute_nhash (uschar *subject, int value1, int value2, int *len)
1254 uschar *s = subject;
1256 unsigned long int total = 0; /* no overflow */
1260 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1261 total += prime[i--] * (unsigned int)(*s++);
1264 /* If value2 is unset, just compute one number */
1268 s = string_sprintf("%d", total % value1);
1271 /* Otherwise do a div/mod hash */
1275 total = total % (value1 * value2);
1276 s = string_sprintf("%d/%d", total/value2, total % value2);
1287 /*************************************************
1288 * Find the value of a header or headers *
1289 *************************************************/
1291 /* Multiple instances of the same header get concatenated, and this function
1292 can also return a concatenation of all the header lines. When concatenating
1293 specific headers that contain lists of addresses, a comma is inserted between
1294 them. Otherwise we use a straight concatenation. Because some messages can have
1295 pathologically large number of lines, there is a limit on the length that is
1296 returned. Also, to avoid massive store use which would result from using
1297 string_cat() as it copies and extends strings, we do a preliminary pass to find
1298 out exactly how much store will be needed. On "normal" messages this will be
1302 name the name of the header, without the leading $header_ or $h_,
1303 or NULL if a concatenation of all headers is required
1304 exists_only TRUE if called from a def: test; don't need to build a string;
1305 just return a string that is not "" and not "0" if the header
1307 newsize return the size of memory block that was obtained; may be NULL
1308 if exists_only is TRUE
1309 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1310 other than concatenating, will be done on the header. Also used
1311 for $message_headers_raw.
1312 charset name of charset to translate MIME words to; used only if
1313 want_raw is false; if NULL, no translation is done (this is
1314 used for $bh_ and $bheader_)
1316 Returns: NULL if the header does not exist, else a pointer to a new
1321 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1324 BOOL found = name == NULL;
1326 int len = found? 0 : Ustrlen(name);
1328 uschar *yield = NULL;
1331 /* Loop for two passes - saves code repetition */
1333 for (i = 0; i < 2; i++)
1338 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1340 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1342 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1347 if (exists_only) return US"1"; /* don't need actual string */
1349 t = h->text + len; /* text to insert */
1350 if (!want_raw) /* unless wanted raw, */
1351 while (isspace(*t)) t++; /* remove leading white space */
1352 ilen = h->slen - (t - h->text); /* length to insert */
1354 /* Unless wanted raw, remove trailing whitespace, including the
1358 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1360 /* Set comma = 1 if handling a single header and it's one of those
1361 that contains an address list, except when asked for raw headers. Only
1362 need to do this once. */
1364 if (!want_raw && name != NULL && comma == 0 &&
1365 Ustrchr("BCFRST", h->type) != NULL)
1368 /* First pass - compute total store needed; second pass - compute
1369 total store used, including this header. */
1371 size += ilen + comma + 1; /* +1 for the newline */
1373 /* Second pass - concatentate the data, up to a maximum. Note that
1374 the loop stops when size hits the limit. */
1378 if (size > header_insert_maxlen)
1380 ilen -= size - header_insert_maxlen - 1;
1383 Ustrncpy(ptr, t, ilen);
1386 /* For a non-raw header, put in the comma if needed, then add
1387 back the newline we removed above, provided there was some text in
1390 if (!want_raw && ilen > 0)
1392 if (comma != 0) *ptr++ = ',';
1400 /* At end of first pass, return NULL if no header found. Then truncate size
1401 if necessary, and get the buffer to hold the data, returning the buffer size.
1406 if (!found) return NULL;
1407 if (size > header_insert_maxlen) size = header_insert_maxlen;
1408 *newsize = size + 1;
1409 ptr = yield = store_get(*newsize);
1413 /* That's all we do for raw header expansion. */
1420 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1421 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1422 function can return an error with decoded data if the charset translation
1423 fails. If decoding fails, it returns NULL. */
1427 uschar *decoded, *error;
1428 if (ptr > yield && ptr[-1] == '\n') ptr--;
1429 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1431 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1435 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1436 " input was: %s\n", error, yield);
1438 if (decoded != NULL) yield = decoded;
1447 /*************************************************
1448 * Find value of a variable *
1449 *************************************************/
1451 /* The table of variables is kept in alphabetic order, so we can search it
1452 using a binary chop. The "choplen" variable is nothing to do with the binary
1456 name the name of the variable being sought
1457 exists_only TRUE if this is a def: test; passed on to find_header()
1458 skipping TRUE => skip any processing evaluation; this is not the same as
1459 exists_only because def: may test for values that are first
1461 newsize pointer to an int which is initially zero; if the answer is in
1462 a new memory buffer, *newsize is set to its size
1464 Returns: NULL if the variable does not exist, or
1465 a pointer to the variable's contents, or
1466 something non-NULL if exists_only is TRUE
1470 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1473 int last = var_table_size;
1475 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1476 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1477 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1478 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1479 (this gave backwards compatibility at the changeover). There may be built-in
1480 variables whose names start acl_ but they should never start in this way. This
1481 slightly messy specification is a consequence of the history, needless to say.
1483 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1484 set, in which case give an error. */
1486 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1490 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1491 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1494 /* Handle $auth<n> variables. */
1496 if (Ustrncmp(name, "auth", 4) == 0)
1499 int n = Ustrtoul(name + 4, &endptr, 10);
1500 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1501 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1504 /* For all other variables, search the table */
1506 while (last > first)
1510 int middle = (first + last)/2;
1511 int c = Ustrcmp(name, var_table[middle].name);
1513 if (c > 0) { first = middle + 1; continue; }
1514 if (c < 0) { last = middle; continue; }
1516 /* Found an existing variable. If in skipping state, the value isn't needed,
1517 and we want to avoid processing (such as looking up the host name). */
1519 if (skipping) return US"";
1521 switch (var_table[middle].type)
1523 case vtype_filter_int:
1524 if (!filter_running) return NULL;
1528 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1532 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1536 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1540 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1544 sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1547 case vtype_stringptr: /* Pointer to string */
1548 s = *((uschar **)(var_table[middle].value));
1549 return (s == NULL)? US"" : s;
1552 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1555 case vtype_load_avg:
1556 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1559 case vtype_host_lookup: /* Lookup if not done so */
1560 if (sender_host_name == NULL && sender_host_address != NULL &&
1561 !host_lookup_failed && host_name_lookup() == OK)
1562 host_build_sender_fullhost();
1563 return (sender_host_name == NULL)? US"" : sender_host_name;
1565 case vtype_localpart: /* Get local part from address */
1566 s = *((uschar **)(var_table[middle].value));
1567 if (s == NULL) return US"";
1568 domain = Ustrrchr(s, '@');
1569 if (domain == NULL) return s;
1570 if (domain - s > sizeof(var_buffer) - 1)
1571 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1572 " in string expansion", sizeof(var_buffer));
1573 Ustrncpy(var_buffer, s, domain - s);
1574 var_buffer[domain - s] = 0;
1577 case vtype_domain: /* Get domain from address */
1578 s = *((uschar **)(var_table[middle].value));
1579 if (s == NULL) return US"";
1580 domain = Ustrrchr(s, '@');
1581 return (domain == NULL)? US"" : domain + 1;
1583 case vtype_msgheaders:
1584 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1586 case vtype_msgheaders_raw:
1587 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1589 case vtype_msgbody: /* Pointer to msgbody string */
1590 case vtype_msgbody_end: /* Ditto, the end of the msg */
1591 ss = (uschar **)(var_table[middle].value);
1592 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1595 off_t start_offset = SPOOL_DATA_START_OFFSET;
1596 int len = message_body_visible;
1597 if (len > message_size) len = message_size;
1598 *ss = body = store_malloc(len+1);
1600 if (var_table[middle].type == vtype_msgbody_end)
1602 struct stat statbuf;
1603 if (fstat(deliver_datafile, &statbuf) == 0)
1605 start_offset = statbuf.st_size - len;
1606 if (start_offset < SPOOL_DATA_START_OFFSET)
1607 start_offset = SPOOL_DATA_START_OFFSET;
1610 lseek(deliver_datafile, start_offset, SEEK_SET);
1611 len = read(deliver_datafile, body, len);
1615 if (message_body_newlines) /* Separate loops for efficiency */
1618 { if (body[--len] == 0) body[len] = ' '; }
1623 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1627 return (*ss == NULL)? US"" : *ss;
1629 case vtype_todbsdin: /* BSD inbox time of day */
1630 return tod_stamp(tod_bsdin);
1632 case vtype_tode: /* Unix epoch time of day */
1633 return tod_stamp(tod_epoch);
1635 case vtype_todel: /* Unix epoch/usec time of day */
1636 return tod_stamp(tod_epoch_l);
1638 case vtype_todf: /* Full time of day */
1639 return tod_stamp(tod_full);
1641 case vtype_todl: /* Log format time of day */
1642 return tod_stamp(tod_log_bare); /* (without timezone) */
1644 case vtype_todzone: /* Time zone offset only */
1645 return tod_stamp(tod_zone);
1647 case vtype_todzulu: /* Zulu time */
1648 return tod_stamp(tod_zulu);
1650 case vtype_todlf: /* Log file datestamp tod */
1651 return tod_stamp(tod_log_datestamp_daily);
1653 case vtype_reply: /* Get reply address */
1654 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1656 if (s != NULL) while (isspace(*s)) s++;
1657 if (s == NULL || *s == 0)
1659 *newsize = 0; /* For the *s==0 case */
1660 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1665 while (isspace(*s)) s++;
1666 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1667 while (t > s && isspace(t[-1])) t--;
1670 return (s == NULL)? US"" : s;
1672 /* A recipients list is available only during system message filtering,
1673 during ACL processing after DATA, and while expanding pipe commands
1674 generated from a system filter, but not elsewhere. */
1676 case vtype_recipients:
1677 if (!enable_dollar_recipients) return NULL; else
1682 s = store_get(size);
1683 for (i = 0; i < recipients_count; i++)
1685 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1686 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1687 Ustrlen(recipients_list[i].address));
1689 s[ptr] = 0; /* string_cat() leaves room */
1696 sprintf(CS var_buffer, "%d",
1697 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1704 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1705 sprintf(CS var_buffer, "%d", inodes);
1709 #ifndef DISABLE_DKIM
1711 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1717 return NULL; /* Unknown variable name */
1724 modify_variable(uschar *name, void * value)
1727 int last = var_table_size;
1729 while (last > first)
1731 int middle = (first + last)/2;
1732 int c = Ustrcmp(name, var_table[middle].name);
1734 if (c > 0) { first = middle + 1; continue; }
1735 if (c < 0) { last = middle; continue; }
1737 /* Found an existing variable; change the item it refers to */
1738 var_table[middle].value = value;
1741 return; /* Unknown variable name, fail silently */
1748 /*************************************************
1749 * Read and expand substrings *
1750 *************************************************/
1752 /* This function is called to read and expand argument substrings for various
1753 expansion items. Some have a minimum requirement that is less than the maximum;
1754 in these cases, the first non-present one is set to NULL.
1757 sub points to vector of pointers to set
1758 n maximum number of substrings
1760 sptr points to current string pointer
1761 skipping the skipping flag
1762 check_end if TRUE, check for final '}'
1763 name name of item, for error message
1765 Returns: 0 OK; string pointer updated
1766 1 curly bracketing error (too few arguments)
1767 2 too many arguments (only if check_end is set); message set
1768 3 other error (expansion failure)
1772 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1773 BOOL check_end, uschar *name)
1778 while (isspace(*s)) s++;
1779 for (i = 0; i < n; i++)
1783 if (i < m) return 1;
1787 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1788 if (sub[i] == NULL) return 3;
1789 if (*s++ != '}') return 1;
1790 while (isspace(*s)) s++;
1792 if (check_end && *s++ != '}')
1796 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1797 "(max is %d)", name, n);
1810 /*************************************************
1811 * Elaborate message for bad variable *
1812 *************************************************/
1814 /* For the "unknown variable" message, take a look at the variable's name, and
1815 give additional information about possible ACL variables. The extra information
1816 is added on to expand_string_message.
1818 Argument: the name of the variable
1823 check_variable_error_message(uschar *name)
1825 if (Ustrncmp(name, "acl_", 4) == 0)
1826 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1827 (name[4] == 'c' || name[4] == 'm')?
1829 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1830 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1832 US"user-defined ACL variables must start acl_c or acl_m");
1837 /*************************************************
1838 * Read and evaluate a condition *
1839 *************************************************/
1843 s points to the start of the condition text
1844 yield points to a BOOL to hold the result of the condition test;
1845 if NULL, we are just reading through a condition that is
1846 part of an "or" combination to check syntax, or in a state
1847 where the answer isn't required
1849 Returns: a pointer to the first character after the condition, or
1854 eval_condition(uschar *s, BOOL *yield)
1856 BOOL testfor = TRUE;
1857 BOOL tempcond, combined_cond;
1859 BOOL sub2_honour_dollar = TRUE;
1860 int i, rc, cond_type, roffset;
1861 int_eximarith_t num[2];
1862 struct stat statbuf;
1867 const uschar *rerror;
1871 while (isspace(*s)) s++;
1872 if (*s == '!') { testfor = !testfor; s++; } else break;
1875 /* Numeric comparisons are symbolic */
1877 if (*s == '=' || *s == '>' || *s == '<')
1889 /* All other conditions are named */
1891 else s = read_name(name, 256, s, US"_");
1893 /* If we haven't read a name, it means some non-alpha character is first. */
1897 expand_string_message = string_sprintf("condition name expected, "
1898 "but found \"%.16s\"", s);
1902 /* Find which condition we are dealing with, and switch on it */
1904 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1907 /* def: tests for a non-empty variable, or for the existence of a header. If
1908 yield == NULL we are in a skipping state, and don't care about the answer. */
1913 expand_string_message = US"\":\" expected after \"def\"";
1917 s = read_name(name, 256, s+1, US"_");
1919 /* Test for a header's existence. If the name contains a closing brace
1920 character, this may be a user error where the terminating colon has been
1921 omitted. Set a flag to adjust a subsequent error message in this case. */
1923 if (Ustrncmp(name, "h_", 2) == 0 ||
1924 Ustrncmp(name, "rh_", 3) == 0 ||
1925 Ustrncmp(name, "bh_", 3) == 0 ||
1926 Ustrncmp(name, "header_", 7) == 0 ||
1927 Ustrncmp(name, "rheader_", 8) == 0 ||
1928 Ustrncmp(name, "bheader_", 8) == 0)
1930 s = read_header_name(name, 256, s);
1931 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1932 if (yield != NULL) *yield =
1933 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1936 /* Test for a variable's having a non-empty value. A non-existent variable
1937 causes an expansion failure. */
1941 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1944 expand_string_message = (name[0] == 0)?
1945 string_sprintf("variable name omitted after \"def:\"") :
1946 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1947 check_variable_error_message(name);
1950 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1956 /* first_delivery tests for first delivery attempt */
1958 case ECOND_FIRST_DELIVERY:
1959 if (yield != NULL) *yield = deliver_firsttime == testfor;
1963 /* queue_running tests for any process started by a queue runner */
1965 case ECOND_QUEUE_RUNNING:
1966 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1970 /* exists: tests for file existence
1971 isip: tests for any IP address
1972 isip4: tests for an IPv4 address
1973 isip6: tests for an IPv6 address
1974 pam: does PAM authentication
1975 radius: does RADIUS authentication
1976 ldapauth: does LDAP authentication
1977 pwcheck: does Cyrus SASL pwcheck authentication
1986 case ECOND_LDAPAUTH:
1989 while (isspace(*s)) s++;
1990 if (*s != '{') goto COND_FAILED_CURLY_START;
1992 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
1993 if (sub[0] == NULL) return NULL;
1994 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1996 if (yield == NULL) return s; /* No need to run the test if skipping */
2001 if ((expand_forbid & RDO_EXISTS) != 0)
2003 expand_string_message = US"File existence tests are not permitted";
2006 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2012 rc = string_is_ip_address(sub[0], NULL);
2013 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2014 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2017 /* Various authentication tests - all optionally compiled */
2021 rc = auth_call_pam(sub[0], &expand_string_message);
2024 goto COND_FAILED_NOT_COMPILED;
2025 #endif /* SUPPORT_PAM */
2028 #ifdef RADIUS_CONFIG_FILE
2029 rc = auth_call_radius(sub[0], &expand_string_message);
2032 goto COND_FAILED_NOT_COMPILED;
2033 #endif /* RADIUS_CONFIG_FILE */
2035 case ECOND_LDAPAUTH:
2038 /* Just to keep the interface the same */
2040 int old_pool = store_pool;
2041 store_pool = POOL_SEARCH;
2042 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2043 &expand_string_message, &do_cache);
2044 store_pool = old_pool;
2048 goto COND_FAILED_NOT_COMPILED;
2049 #endif /* LOOKUP_LDAP */
2052 #ifdef CYRUS_PWCHECK_SOCKET
2053 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2056 goto COND_FAILED_NOT_COMPILED;
2057 #endif /* CYRUS_PWCHECK_SOCKET */
2059 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2060 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2062 if (rc == ERROR || rc == DEFER) return NULL;
2063 *yield = (rc == OK) == testfor;
2069 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2071 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
2073 However, the last two are optional. That is why the whole set is enclosed
2074 in their own set or braces. */
2076 case ECOND_SASLAUTHD:
2077 #ifndef CYRUS_SASLAUTHD_SOCKET
2078 goto COND_FAILED_NOT_COMPILED;
2080 while (isspace(*s)) s++;
2081 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2082 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2084 case 1: expand_string_message = US"too few arguments or bracketing "
2085 "error for saslauthd";
2087 case 3: return NULL;
2089 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2093 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2094 &expand_string_message);
2095 if (rc == ERROR || rc == DEFER) return NULL;
2096 *yield = (rc == OK) == testfor;
2099 #endif /* CYRUS_SASLAUTHD_SOCKET */
2102 /* symbolic operators for numeric and string comparison, and a number of
2103 other operators, all requiring two arguments.
2105 crypteq: encrypts plaintext and compares against an encrypted text,
2106 using crypt(), crypt16(), MD5 or SHA-1
2107 inlist/inlisti: checks if first argument is in the list of the second
2108 match: does a regular expression match and sets up the numerical
2109 variables if it succeeds
2110 match_address: matches in an address list
2111 match_domain: matches in a domain list
2112 match_ip: matches a host list that is restricted to IP addresses
2113 match_local_part: matches in a local part list
2116 case ECOND_MATCH_ADDRESS:
2117 case ECOND_MATCH_DOMAIN:
2118 case ECOND_MATCH_IP:
2119 case ECOND_MATCH_LOCAL_PART:
2120 #ifndef EXPAND_LISTMATCH_RHS
2121 sub2_honour_dollar = FALSE;
2130 case ECOND_NUM_L: /* Numerical comparisons */
2137 case ECOND_STR_LT: /* String comparisons */
2148 for (i = 0; i < 2; i++)
2150 /* Sometimes, we don't expand substrings; too many insecure configurations
2151 created using match_address{}{} and friends, where the second param
2152 includes information from untrustworthy sources. */
2153 BOOL honour_dollar = TRUE;
2154 if ((i > 0) && !sub2_honour_dollar)
2155 honour_dollar = FALSE;
2157 while (isspace(*s)) s++;
2160 if (i == 0) goto COND_FAILED_CURLY_START;
2161 expand_string_message = string_sprintf("missing 2nd string in {} "
2162 "after \"%s\"", name);
2165 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2167 if (sub[i] == NULL) return NULL;
2168 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2170 /* Convert to numerical if required; we know that the names of all the
2171 conditions that compare numbers do not start with a letter. This just saves
2172 checking for them individually. */
2174 if (!isalpha(name[0]) && yield != NULL)
2180 debug_printf("empty string cast to zero for numerical comparison\n");
2184 num[i] = expand_string_integer(sub[i], FALSE);
2185 if (expand_string_message != NULL) return NULL;
2190 /* Result not required */
2192 if (yield == NULL) return s;
2194 /* Do an appropriate comparison */
2200 *yield = (num[0] == num[1]) == testfor;
2204 *yield = (num[0] > num[1]) == testfor;
2208 *yield = (num[0] >= num[1]) == testfor;
2212 *yield = (num[0] < num[1]) == testfor;
2216 *yield = (num[0] <= num[1]) == testfor;
2220 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2224 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2228 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2232 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2236 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2240 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2244 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2248 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2252 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2256 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2259 case ECOND_MATCH: /* Regular expression match */
2260 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2264 expand_string_message = string_sprintf("regular expression error in "
2265 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2268 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2271 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2272 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2273 goto MATCHED_SOMETHING;
2275 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2276 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2277 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2278 goto MATCHED_SOMETHING;
2280 case ECOND_MATCH_IP: /* Match IP address in a host list */
2281 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2283 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2289 unsigned int *nullcache = NULL;
2290 check_host_block cb;
2292 cb.host_name = US"";
2293 cb.host_address = sub[0];
2295 /* If the host address starts off ::ffff: it is an IPv6 address in
2296 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2299 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2300 cb.host_address + 7 : cb.host_address;
2302 rc = match_check_list(
2303 &sub[1], /* the list */
2304 0, /* separator character */
2305 &hostlist_anchor, /* anchor pointer */
2306 &nullcache, /* cache pointer */
2307 check_host, /* function for testing */
2308 &cb, /* argument for function */
2309 MCL_HOST, /* type of check */
2310 sub[0], /* text for debugging */
2311 NULL); /* where to pass back data */
2313 goto MATCHED_SOMETHING;
2315 case ECOND_MATCH_LOCAL_PART:
2316 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2317 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2332 expand_string_message = string_sprintf("unable to complete match "
2333 "against \"%s\": %s", sub[1], search_error_message);
2339 /* Various "encrypted" comparisons. If the second string starts with
2340 "{" then an encryption type is given. Default to crypt() or crypt16()
2341 (build-time choice). */
2344 #ifndef SUPPORT_CRYPTEQ
2345 goto COND_FAILED_NOT_COMPILED;
2347 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2349 int sublen = Ustrlen(sub[1]+5);
2354 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2356 /* If the length that we are comparing against is 24, the MD5 digest
2357 is expressed as a base64 string. This is the way LDAP does it. However,
2358 some other software uses a straightforward hex representation. We assume
2359 this if the length is 32. Other lengths fail. */
2363 uschar *coded = auth_b64encode((uschar *)digest, 16);
2364 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2365 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2366 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2368 else if (sublen == 32)
2372 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2374 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2375 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2376 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2380 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2381 "fail\n crypted=%s\n", sub[1]+5);
2386 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2388 int sublen = Ustrlen(sub[1]+6);
2393 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2395 /* If the length that we are comparing against is 28, assume the SHA1
2396 digest is expressed as a base64 string. If the length is 40, assume a
2397 straightforward hex representation. Other lengths fail. */
2401 uschar *coded = auth_b64encode((uschar *)digest, 20);
2402 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2403 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2404 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2406 else if (sublen == 40)
2410 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2412 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2413 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2414 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2418 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2419 "fail\n crypted=%s\n", sub[1]+6);
2424 else /* {crypt} or {crypt16} and non-{ at start */
2425 /* }-for-text-editors */
2430 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2435 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2440 else if (sub[1][0] == '{')
2442 expand_string_message = string_sprintf("unknown encryption mechanism "
2443 "in \"%s\"", sub[1]);
2449 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2450 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2451 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2455 #define XSTR(s) STR(s)
2456 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2457 " subject=%s\n crypted=%s\n",
2458 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2463 /* If the encrypted string contains fewer than two characters (for the
2464 salt), force failure. Otherwise we get false positives: with an empty
2465 string the yield of crypt() is an empty string! */
2467 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2468 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2471 #endif /* SUPPORT_CRYPTEQ */
2478 uschar *save_iterate_item = iterate_item;
2479 int (*compare)(const uschar *, const uschar *);
2481 if (cond_type == ECOND_INLISTI)
2484 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2486 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2487 if (compare(sub[0], iterate_item) == 0)
2492 iterate_item = save_iterate_item;
2496 } /* Switch for comparison conditions */
2498 return s; /* End of comparison conditions */
2501 /* and/or: computes logical and/or of several conditions */
2505 subcondptr = (yield == NULL)? NULL : &tempcond;
2506 combined_cond = (cond_type == ECOND_AND);
2508 while (isspace(*s)) s++;
2509 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2513 while (isspace(*s)) s++;
2514 if (*s == '}') break;
2517 expand_string_message = string_sprintf("each subcondition "
2518 "inside an \"%s{...}\" condition must be in its own {}", name);
2522 s = eval_condition(s+1, subcondptr);
2525 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2526 expand_string_message, name);
2529 while (isspace(*s)) s++;
2533 expand_string_message = string_sprintf("missing } at end of condition "
2534 "inside \"%s\" group", name);
2540 if (cond_type == ECOND_AND)
2542 combined_cond &= tempcond;
2543 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2544 } /* evaluate any more */
2547 combined_cond |= tempcond;
2548 if (combined_cond) subcondptr = NULL; /* once true, don't */
2549 } /* evaluate any more */
2553 if (yield != NULL) *yield = (combined_cond == testfor);
2557 /* forall/forany: iterates a condition with different values */
2563 uschar *save_iterate_item = iterate_item;
2565 while (isspace(*s)) s++;
2566 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2567 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2568 if (sub[0] == NULL) return NULL;
2569 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2571 while (isspace(*s)) s++;
2572 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2576 /* Call eval_condition once, with result discarded (as if scanning a
2577 "false" part). This allows us to find the end of the condition, because if
2578 the list it empty, we won't actually evaluate the condition for real. */
2580 s = eval_condition(sub[1], NULL);
2583 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2584 expand_string_message, name);
2587 while (isspace(*s)) s++;
2591 expand_string_message = string_sprintf("missing } at end of condition "
2592 "inside \"%s\"", name);
2596 if (yield != NULL) *yield = !testfor;
2597 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2599 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2600 if (eval_condition(sub[1], &tempcond) == NULL)
2602 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2603 expand_string_message, name);
2604 iterate_item = save_iterate_item;
2607 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2608 tempcond? "true":"false");
2610 if (yield != NULL) *yield = (tempcond == testfor);
2611 if (tempcond == (cond_type == ECOND_FORANY)) break;
2614 iterate_item = save_iterate_item;
2619 /* The bool{} expansion condition maps a string to boolean.
2620 The values supported should match those supported by the ACL condition
2621 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2622 of true/false. Note that Router "condition" rules have a different
2623 interpretation, where general data can be used and only a few values
2625 Note that readconf.c boolean matching, for boolean configuration options,
2626 only matches true/yes/false/no.
2627 The bool_lax{} condition matches the Router logic, which is much more
2630 case ECOND_BOOL_LAX:
2636 BOOL boolvalue = FALSE;
2637 while (isspace(*s)) s++;
2638 if (*s != '{') goto COND_FAILED_CURLY_START;
2639 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2640 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2642 case 1: expand_string_message = string_sprintf(
2643 "too few arguments or bracketing error for %s",
2647 case 3: return NULL;
2650 while (isspace(*t)) t++;
2654 /* trailing whitespace: seems like a good idea to ignore it too */
2656 while (isspace(*t2)) t2--;
2657 if (t2 != (t + len))
2664 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2665 /* logic for the lax case from expand_check_condition(), which also does
2666 expands, and the logic is both short and stable enough that there should
2667 be no maintenance burden from replicating it. */
2670 else if (Ustrspn(t, "0123456789") == len)
2672 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2673 /* expand_check_condition only does a literal string "0" check */
2674 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2677 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2679 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2681 else if (cond_type == ECOND_BOOL_LAX)
2685 expand_string_message = string_sprintf("unrecognised boolean "
2689 if (yield != NULL) *yield = (boolvalue == testfor);
2693 /* Unknown condition */
2696 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2698 } /* End switch on condition type */
2700 /* Missing braces at start and end of data */
2702 COND_FAILED_CURLY_START:
2703 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2706 COND_FAILED_CURLY_END:
2707 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2711 /* A condition requires code that is not compiled */
2713 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2714 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2715 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2716 COND_FAILED_NOT_COMPILED:
2717 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2726 /*************************************************
2727 * Save numerical variables *
2728 *************************************************/
2730 /* This function is called from items such as "if" that want to preserve and
2731 restore the numbered variables.
2734 save_expand_string points to an array of pointers to set
2735 save_expand_nlength points to an array of ints for the lengths
2737 Returns: the value of expand max to save
2741 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2744 for (i = 0; i <= expand_nmax; i++)
2746 save_expand_nstring[i] = expand_nstring[i];
2747 save_expand_nlength[i] = expand_nlength[i];
2754 /*************************************************
2755 * Restore numerical variables *
2756 *************************************************/
2758 /* This function restored saved values of numerical strings.
2761 save_expand_nmax the number of strings to restore
2762 save_expand_string points to an array of pointers
2763 save_expand_nlength points to an array of ints
2769 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2770 int *save_expand_nlength)
2773 expand_nmax = save_expand_nmax;
2774 for (i = 0; i <= expand_nmax; i++)
2776 expand_nstring[i] = save_expand_nstring[i];
2777 expand_nlength[i] = save_expand_nlength[i];
2785 /*************************************************
2786 * Handle yes/no substrings *
2787 *************************************************/
2789 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2790 alternative substrings that depend on whether or not the condition was true,
2791 or the lookup or extraction succeeded. The substrings always have to be
2792 expanded, to check their syntax, but "skipping" is set when the result is not
2793 needed - this avoids unnecessary nested lookups.
2796 skipping TRUE if we were skipping when this item was reached
2797 yes TRUE if the first string is to be used, else use the second
2798 save_lookup a value to put back into lookup_value before the 2nd expansion
2799 sptr points to the input string pointer
2800 yieldptr points to the output string pointer
2801 sizeptr points to the output string size
2802 ptrptr points to the output string pointer
2803 type "lookup" or "if" or "extract" or "run", for error message
2805 Returns: 0 OK; lookup_value has been reset to save_lookup
2807 2 expansion failed because of bracketing error
2811 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2812 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2815 uschar *s = *sptr; /* Local value */
2816 uschar *sub1, *sub2;
2818 /* If there are no following strings, we substitute the contents of $value for
2819 lookups and for extractions in the success case. For the ${if item, the string
2820 "true" is substituted. In the fail case, nothing is substituted for all three
2823 while (isspace(*s)) s++;
2828 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2832 if (yes && lookup_value != NULL)
2833 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2834 Ustrlen(lookup_value));
2835 lookup_value = save_lookup;
2841 /* The first following string must be braced. */
2843 if (*s++ != '{') goto FAILED_CURLY;
2845 /* Expand the first substring. Forced failures are noticed only if we actually
2846 want this string. Set skipping in the call in the fail case (this will always
2847 be the case if we were already skipping). */
2849 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
2850 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2851 expand_string_forcedfail = FALSE;
2852 if (*s++ != '}') goto FAILED_CURLY;
2854 /* If we want the first string, add it to the output */
2857 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2859 /* If this is called from a lookup or an extract, we want to restore $value to
2860 what it was at the start of the item, so that it has this value during the
2861 second string expansion. For the call from "if" or "run" to this function,
2862 save_lookup is set to lookup_value, so that this statement does nothing. */
2864 lookup_value = save_lookup;
2866 /* There now follows either another substring, or "fail", or nothing. This
2867 time, forced failures are noticed only if we want the second string. We must
2868 set skipping in the nested call if we don't want this string, or if we were
2869 already skipping. */
2871 while (isspace(*s)) s++;
2874 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
2875 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2876 expand_string_forcedfail = FALSE;
2877 if (*s++ != '}') goto FAILED_CURLY;
2879 /* If we want the second string, add it to the output */
2882 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2885 /* If there is no second string, but the word "fail" is present when the use of
2886 the second string is wanted, set a flag indicating it was a forced failure
2887 rather than a syntactic error. Swallow the terminating } in case this is nested
2888 inside another lookup or if or extract. */
2893 s = read_name(name, sizeof(name), s, US"_");
2894 if (Ustrcmp(name, "fail") == 0)
2896 if (!yes && !skipping)
2898 while (isspace(*s)) s++;
2899 if (*s++ != '}') goto FAILED_CURLY;
2900 expand_string_message =
2901 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2902 expand_string_forcedfail = TRUE;
2908 expand_string_message =
2909 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2914 /* All we have to do now is to check on the final closing brace. */
2916 while (isspace(*s)) s++;
2917 if (*s++ == '}') goto RETURN;
2919 /* Get here if there is a bracketing failure */
2924 /* Get here for other failures */
2929 /* Update the input pointer value before returning */
2939 /*************************************************
2940 * Handle MD5 or SHA-1 computation for HMAC *
2941 *************************************************/
2943 /* These are some wrapping functions that enable the HMAC code to be a bit
2944 cleaner. A good compiler will spot the tail recursion.
2947 type HMAC_MD5 or HMAC_SHA1
2948 remaining are as for the cryptographic hash functions
2954 chash_start(int type, void *base)
2956 if (type == HMAC_MD5)
2957 md5_start((md5 *)base);
2959 sha1_start((sha1 *)base);
2963 chash_mid(int type, void *base, uschar *string)
2965 if (type == HMAC_MD5)
2966 md5_mid((md5 *)base, string);
2968 sha1_mid((sha1 *)base, string);
2972 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2974 if (type == HMAC_MD5)
2975 md5_end((md5 *)base, string, length, digest);
2977 sha1_end((sha1 *)base, string, length, digest);
2984 /********************************************************
2985 * prvs: Get last three digits of days since Jan 1, 1970 *
2986 ********************************************************/
2988 /* This is needed to implement the "prvs" BATV reverse
2991 Argument: integer "days" offset to add or substract to
2992 or from the current number of days.
2994 Returns: pointer to string containing the last three
2995 digits of the number of days since Jan 1, 1970,
2996 modified by the offset argument, NULL if there
2997 was an error in the conversion.
3002 prvs_daystamp(int day_offset)
3004 uschar *days = store_get(32); /* Need at least 24 for cases */
3005 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3006 (time(NULL) + day_offset*86400)/86400);
3007 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3012 /********************************************************
3013 * prvs: perform HMAC-SHA1 computation of prvs bits *
3014 ********************************************************/
3016 /* This is needed to implement the "prvs" BATV reverse
3020 address RFC2821 Address to use
3021 key The key to use (must be less than 64 characters
3023 key_num Single-digit key number to use. Defaults to
3026 Returns: pointer to string containing the first three
3027 bytes of the final hash in hex format, NULL if
3028 there was an error in the process.
3032 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3034 uschar *hash_source, *p;
3035 int size = 0,offset = 0,i;
3037 void *use_base = &sha1_base;
3038 uschar innerhash[20];
3039 uschar finalhash[20];
3040 uschar innerkey[64];
3041 uschar outerkey[64];
3042 uschar *finalhash_hex = store_get(40);
3044 if (key_num == NULL)
3047 if (Ustrlen(key) > 64)
3050 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3051 string_cat(hash_source,&size,&offset,daystamp,3);
3052 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3053 hash_source[offset] = '\0';
3055 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3057 memset(innerkey, 0x36, 64);
3058 memset(outerkey, 0x5c, 64);
3060 for (i = 0; i < Ustrlen(key); i++)
3062 innerkey[i] ^= key[i];
3063 outerkey[i] ^= key[i];
3066 chash_start(HMAC_SHA1, use_base);
3067 chash_mid(HMAC_SHA1, use_base, innerkey);
3068 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3070 chash_start(HMAC_SHA1, use_base);
3071 chash_mid(HMAC_SHA1, use_base, outerkey);
3072 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3075 for (i = 0; i < 3; i++)
3077 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3078 *p++ = hex_digits[finalhash[i] & 0x0f];
3082 return finalhash_hex;
3088 /*************************************************
3089 * Join a file onto the output string *
3090 *************************************************/
3092 /* This is used for readfile and after a run expansion. It joins the contents
3093 of a file onto the output string, globally replacing newlines with a given
3094 string (optionally). The file is closed at the end.
3098 yield pointer to the expandable string
3099 sizep pointer to the current size
3100 ptrp pointer to the current position
3101 eol newline replacement string, or NULL
3103 Returns: new value of string pointer
3107 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3110 uschar buffer[1024];
3112 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3114 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3116 int len = Ustrlen(buffer);
3117 if (eol != NULL && buffer[len-1] == '\n') len--;
3118 yield = string_cat(yield, sizep, ptrp, buffer, len);
3119 if (buffer[len] != 0)
3120 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3123 if (yield != NULL) yield[*ptrp] = 0;
3131 /*************************************************
3132 * Evaluate numeric expression *
3133 *************************************************/
3135 /* This is a set of mutually recursive functions that evaluate an arithmetic
3136 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3137 these functions that is called from elsewhere is eval_expr, whose interface is:
3140 sptr pointer to the pointer to the string - gets updated
3141 decimal TRUE if numbers are to be assumed decimal
3142 error pointer to where to put an error message - must be NULL on input
3143 endket TRUE if ')' must terminate - FALSE for external call
3145 Returns: on success: the value of the expression, with *error still NULL
3146 on failure: an undefined value, with *error = a message
3149 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3152 static int_eximarith_t
3153 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3156 int_eximarith_t x = eval_op_or(&s, decimal, error);
3162 *error = US"expecting closing parenthesis";
3164 while (isspace(*(++s)));
3166 else if (*s != 0) *error = US"expecting operator";
3173 static int_eximarith_t
3174 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3179 while (isspace(*s)) s++;
3184 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3186 switch (tolower(*s))
3189 case 'k': n *= 1024; s++; break;
3190 case 'm': n *= 1024*1024; s++; break;
3191 case 'g': n *= 1024*1024*1024; s++; break;
3193 while (isspace (*s)) s++;
3198 n = eval_expr(&s, decimal, error, 1);
3202 *error = US"expecting number or opening parenthesis";
3210 static int_eximarith_t
3211 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3215 while (isspace(*s)) s++;
3216 if (*s == '+' || *s == '-' || *s == '~')
3219 x = eval_op_unary(&s, decimal, error);
3220 if (op == '-') x = -x;
3221 else if (op == '~') x = ~x;
3225 x = eval_number(&s, decimal, error);
3232 static int_eximarith_t
3233 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3236 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3239 while (*s == '*' || *s == '/' || *s == '%')
3242 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3243 if (*error != NULL) break;
3244 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3245 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3246 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3247 * -N*M is INT_MIN will yielf INT_MIN.
3248 * Since we don't support floating point, this is somewhat simpler.
3249 * Ideally, we'd return an error, but since we overflow for all other
3250 * arithmetic, consistency suggests otherwise, but what's the correct value
3251 * to use? There is none.
3252 * The C standard guarantees overflow for unsigned arithmetic but signed
3253 * overflow invokes undefined behaviour; in practice, this is overflow
3254 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3255 * that long/longlong larger than int are available, or we could just work
3256 * with larger types. We should consider whether to guarantee 32bit eval
3257 * and 64-bit working variables, with errors returned. For now ...
3258 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3259 * can just let the other invalid results occur otherwise, as they have
3260 * until now. For this one case, we can coerce.
3262 if (y == -1 && x == LLONG_MIN && op != '*')
3265 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3266 LLONG_MIN, op, LLONG_MAX);
3276 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3292 static int_eximarith_t
3293 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3296 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3299 while (*s == '+' || *s == '-')
3302 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3303 if (*error != NULL) break;
3304 if (op == '+') x += y; else x -= y;
3312 static int_eximarith_t
3313 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3316 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3319 while ((*s == '<' || *s == '>') && s[1] == s[0])
3324 y = eval_op_sum(&s, decimal, error);
3325 if (*error != NULL) break;
3326 if (op == '<') x <<= y; else x >>= y;
3334 static int_eximarith_t
3335 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3338 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3345 y = eval_op_shift(&s, decimal, error);
3346 if (*error != NULL) break;
3355 static int_eximarith_t
3356 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3359 int_eximarith_t x = eval_op_and(&s, decimal, error);
3366 y = eval_op_and(&s, decimal, error);
3367 if (*error != NULL) break;
3376 static int_eximarith_t
3377 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3380 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3387 y = eval_op_xor(&s, decimal, error);
3388 if (*error != NULL) break;
3398 /*************************************************
3400 *************************************************/
3402 /* Returns either an unchanged string, or the expanded string in stacking pool
3403 store. Interpreted sequences are:
3405 \... normal escaping rules
3406 $name substitutes the variable
3408 ${op:string} operates on the expanded string value
3409 ${item{arg1}{arg2}...} expands the args and then does the business
3410 some literal args are not enclosed in {}
3412 There are now far too many operators and item types to make it worth listing
3413 them here in detail any more.
3415 We use an internal routine recursively to handle embedded substrings. The
3416 external function follows. The yield is NULL if the expansion failed, and there
3417 are two cases: if something collapsed syntactically, or if "fail" was given
3418 as the action on a lookup failure. These can be distinguised by looking at the
3419 variable expand_string_forcedfail, which is TRUE in the latter case.
3421 The skipping flag is set true when expanding a substring that isn't actually
3422 going to be used (after "if" or "lookup") and it prevents lookups from
3423 happening lower down.
3425 Store usage: At start, a store block of the length of the input plus 64
3426 is obtained. This is expanded as necessary by string_cat(), which might have to
3427 get a new block, or might be able to expand the original. At the end of the
3428 function we can release any store above that portion of the yield block that
3429 was actually used. In many cases this will be optimal.
3431 However: if the first item in the expansion is a variable name or header name,
3432 we reset the store before processing it; if the result is in fresh store, we
3433 use that without copying. This is helpful for expanding strings like
3434 $message_headers which can get very long.
3436 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3437 since resetting the store at the end of the expansion will free store that was
3438 allocated by the plugin code as well as the slop after the expanded string. So
3439 we skip any resets if ${dlfunc has been used. This is an unfortunate
3440 consequence of string expansion becoming too powerful.
3443 string the string to be expanded
3444 ket_ends true if expansion is to stop at }
3445 left if not NULL, a pointer to the first character after the
3446 expansion is placed here (typically used with ket_ends)
3447 skipping TRUE for recursive calls when the value isn't actually going
3448 to be used (to allow for optimisation)
3449 honour_dollar TRUE if $ is to be expanded,
3450 FALSE if it's just another character
3452 Returns: NULL if expansion fails:
3453 expand_string_forcedfail is set TRUE if failure was forced
3454 expand_string_message contains a textual error message
3455 a pointer to the expanded string on success
3459 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3460 BOOL skipping, BOOL honour_dollar)
3463 int size = Ustrlen(string)+ 64;
3465 uschar *yield = store_get(size);
3467 uschar *save_expand_nstring[EXPAND_MAXN+1];
3468 int save_expand_nlength[EXPAND_MAXN+1];
3469 BOOL resetok = TRUE;
3471 expand_string_forcedfail = FALSE;
3472 expand_string_message = US"";
3479 /* \ escapes the next character, which must exist, or else
3480 the expansion fails. There's a special escape, \N, which causes
3481 copying of the subject verbatim up to the next \N. Otherwise,
3482 the escapes are the standard set. */
3488 expand_string_message = US"\\ at end of string";
3495 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3496 yield = string_cat(yield, &size, &ptr, t, s - t);
3497 if (*s != 0) s += 2;
3503 ch[0] = string_interpret_escape(&s);
3505 yield = string_cat(yield, &size, &ptr, ch, 1);
3511 /* Anything other than $ is just copied verbatim, unless we are
3512 looking for a terminating } character. */
3514 if (ket_ends && *s == '}') break;
3516 if (*s != '$' || !honour_dollar)
3518 yield = string_cat(yield, &size, &ptr, s++, 1);
3522 /* No { after the $ - must be a plain name or a number for string
3523 match variable. There has to be a fudge for variables that are the
3524 names of header fields preceded by "$header_" because header field
3525 names can contain any printing characters except space and colon.
3526 For those that don't like typing this much, "$h_" is a synonym for
3527 "$header_". A non-existent header yields a NULL value; nothing is
3530 if (isalpha((*(++s))))
3535 s = read_name(name, sizeof(name), s, US"_");
3537 /* If this is the first thing to be expanded, release the pre-allocated
3540 if (ptr == 0 && yield != NULL)
3542 if (resetok) store_reset(yield);
3549 if (Ustrncmp(name, "h_", 2) == 0 ||
3550 Ustrncmp(name, "rh_", 3) == 0 ||
3551 Ustrncmp(name, "bh_", 3) == 0 ||
3552 Ustrncmp(name, "header_", 7) == 0 ||
3553 Ustrncmp(name, "rheader_", 8) == 0 ||
3554 Ustrncmp(name, "bheader_", 8) == 0)
3556 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3557 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3558 s = read_header_name(name, sizeof(name), s);
3559 value = find_header(name, FALSE, &newsize, want_raw, charset);
3561 /* If we didn't find the header, and the header contains a closing brace
3562 character, this may be a user error where the terminating colon
3563 has been omitted. Set a flag to adjust the error message in this case.
3564 But there is no error here - nothing gets inserted. */
3568 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3577 value = find_variable(name, FALSE, skipping, &newsize);
3580 expand_string_message =
3581 string_sprintf("unknown variable name \"%s\"", name);
3582 check_variable_error_message(name);
3587 /* If the data is known to be in a new buffer, newsize will be set to the
3588 size of that buffer. If this is the first thing in an expansion string,
3589 yield will be NULL; just point it at the new store instead of copying. Many
3590 expansion strings contain just one reference, so this is a useful
3591 optimization, especially for humungous headers. */
3593 len = Ustrlen(value);
3594 if (yield == NULL && newsize != 0)
3600 else yield = string_cat(yield, &size, &ptr, value, len);
3608 s = read_number(&n, s);
3609 if (n >= 0 && n <= expand_nmax)
3610 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3615 /* Otherwise, if there's no '{' after $ it's an error. */
3619 expand_string_message = US"$ not followed by letter, digit, or {";
3623 /* After { there can be various things, but they all start with
3624 an initial word, except for a number for a string match variable. */
3626 if (isdigit((*(++s))))
3629 s = read_number(&n, s);
3632 expand_string_message = US"} expected after number";
3635 if (n >= 0 && n <= expand_nmax)
3636 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3643 expand_string_message = US"letter or digit expected after ${";
3647 /* Allow "-" in names to cater for substrings with negative
3648 arguments. Since we are checking for known names after { this is
3651 s = read_name(name, sizeof(name), s, US"_-");
3652 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3656 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3657 If the ACL returns acceptance we return content set by "message ="
3658 There is currently no limit on recursion; this would have us call
3659 acl_check_internal() directly and get a current level from somewhere.
3665 uschar *sub[10]; /* name + arg1-arg9, must match number of acl_arg[] */
3669 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl"))
3671 case 1: goto EXPAND_FAILED_CURLY;
3673 case 3: goto EXPAND_FAILED;
3675 if (skipping) continue;
3677 for (rc = 1; rc < sizeof(sub)/sizeof(*sub) && sub[rc]; rc++)
3678 acl_arg[rc-1] = sub[rc];
3680 while (rc < sizeof(sub)/sizeof(*sub))
3681 acl_arg[rc++ - 1] = NULL;
3684 debug_printf("expanding: acl: %s arg: %s%s\n",
3686 acl_narg>0 ? sub[1] : US"<none>",
3687 acl_narg>1 ? " +more" : "");
3689 switch(rc = acl_check(ACL_WHERE_EXPANSION, NULL, sub[0], &user_msg, &log_msg))
3693 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3698 expand_string_message = string_sprintf("acl \"%s\" did not accept", sub[0]);
3703 /* Handle conditionals - preserve the values of the numerical expansion
3704 variables in case they get changed by a regular expression match in the
3705 condition. If not, they retain their external settings. At the end
3706 of this "if" section, they get restored to their previous values. */
3712 int save_expand_nmax =
3713 save_expand_strings(save_expand_nstring, save_expand_nlength);
3715 while (isspace(*s)) s++;
3716 next_s = eval_condition(s, skipping? NULL : &cond);
3717 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3720 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3721 cond? "true" : "false");
3725 /* The handling of "yes" and "no" result strings is now in a separate
3726 function that is also used by ${lookup} and ${extract} and ${run}. */
3728 switch(process_yesno(
3729 skipping, /* were previously skipping */
3730 cond, /* success/failure indicator */
3731 lookup_value, /* value to reset for string2 */
3732 &s, /* input pointer */
3733 &yield, /* output pointer */
3734 &size, /* output size */
3735 &ptr, /* output current point */
3736 US"if")) /* condition type */
3738 case 1: goto EXPAND_FAILED; /* when all is well, the */
3739 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3742 /* Restore external setting of expansion variables for continuation
3745 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3746 save_expand_nlength);
3750 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3751 expanding an internal string that isn't actually going to be used. All we
3752 need to do is check the syntax, so don't do a lookup at all. Preserve the
3753 values of the numerical expansion variables in case they get changed by a
3754 partial lookup. If not, they retain their external settings. At the end
3755 of this "lookup" section, they get restored to their previous values. */
3759 int stype, partial, affixlen, starflags;
3760 int expand_setup = 0;
3762 uschar *key, *filename, *affix;
3763 uschar *save_lookup_value = lookup_value;
3764 int save_expand_nmax =
3765 save_expand_strings(save_expand_nstring, save_expand_nlength);
3767 if ((expand_forbid & RDO_LOOKUP) != 0)
3769 expand_string_message = US"lookup expansions are not permitted";
3773 /* Get the key we are to look up for single-key+file style lookups.
3774 Otherwise set the key NULL pro-tem. */
3776 while (isspace(*s)) s++;
3779 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3780 if (key == NULL) goto EXPAND_FAILED;
3781 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3782 while (isspace(*s)) s++;
3786 /* Find out the type of database */
3790 expand_string_message = US"missing lookup type";
3794 /* The type is a string that may contain special characters of various
3795 kinds. Allow everything except space or { to appear; the actual content
3796 is checked by search_findtype_partial. */
3798 while (*s != 0 && *s != '{' && !isspace(*s))
3800 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3804 while (isspace(*s)) s++;
3806 /* Now check for the individual search type and any partial or default
3807 options. Only those types that are actually in the binary are valid. */
3809 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3813 expand_string_message = search_error_message;
3817 /* Check that a key was provided for those lookup types that need it,
3818 and was not supplied for those that use the query style. */
3820 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3824 expand_string_message = string_sprintf("missing {key} for single-"
3825 "key \"%s\" lookup", name);
3833 expand_string_message = string_sprintf("a single key was given for "
3834 "lookup type \"%s\", which is not a single-key lookup type", name);
3839 /* Get the next string in brackets and expand it. It is the file name for
3840 single-key+file lookups, and the whole query otherwise. In the case of
3841 queries that also require a file name (e.g. sqlite), the file name comes
3844 if (*s != '{') goto EXPAND_FAILED_CURLY;
3845 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3846 if (filename == NULL) goto EXPAND_FAILED;
3847 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3848 while (isspace(*s)) s++;
3850 /* If this isn't a single-key+file lookup, re-arrange the variables
3851 to be appropriate for the search_ functions. For query-style lookups,
3852 there is just a "key", and no file name. For the special query-style +
3853 file types, the query (i.e. "key") starts with a file name. */
3857 while (isspace(*filename)) filename++;
3860 if (mac_islookup(stype, lookup_querystyle))
3866 if (*filename != '/')
3868 expand_string_message = string_sprintf(
3869 "absolute file name expected for \"%s\" lookup", name);
3872 while (*key != 0 && !isspace(*key)) key++;
3873 if (*key != 0) *key++ = 0;
3877 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3878 the entry was not found. Note that there is no search_close() function.
3879 Files are left open in case of re-use. At suitable places in higher logic,
3880 search_tidyup() is called to tidy all open files. This can save opening
3881 the same file several times. However, files may also get closed when
3882 others are opened, if too many are open at once. The rule is that a
3883 handle should not be used after a second search_open().
3885 Request that a partial search sets up $1 and maybe $2 by passing
3886 expand_setup containing zero. If its value changes, reset expand_nmax,
3887 since new variables will have been set. Note that at the end of this
3888 "lookup" section, the old numeric variables are restored. */
3891 lookup_value = NULL;
3894 void *handle = search_open(filename, stype, 0, NULL, NULL);
3897 expand_string_message = search_error_message;
3900 lookup_value = search_find(handle, filename, key, partial, affix,
3901 affixlen, starflags, &expand_setup);
3902 if (search_find_defer)
3904 expand_string_message =
3905 string_sprintf("lookup of \"%s\" gave DEFER: %s",
3906 string_printing2(key, FALSE), search_error_message);
3909 if (expand_setup > 0) expand_nmax = expand_setup;
3912 /* The handling of "yes" and "no" result strings is now in a separate
3913 function that is also used by ${if} and ${extract}. */
3915 switch(process_yesno(
3916 skipping, /* were previously skipping */
3917 lookup_value != NULL, /* success/failure indicator */
3918 save_lookup_value, /* value to reset for string2 */
3919 &s, /* input pointer */
3920 &yield, /* output pointer */
3921 &size, /* output size */
3922 &ptr, /* output current point */
3923 US"lookup")) /* condition type */
3925 case 1: goto EXPAND_FAILED; /* when all is well, the */
3926 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3929 /* Restore external setting of expansion variables for carrying on
3930 at this level, and continue. */
3932 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3933 save_expand_nlength);
3937 /* If Perl support is configured, handle calling embedded perl subroutines,
3938 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3939 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3940 arguments (defined below). */
3942 #define EXIM_PERL_MAX_ARGS 8
3946 expand_string_message = US"\"${perl\" encountered, but this facility "
3947 "is not included in this binary";
3950 #else /* EXIM_PERL */
3952 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3955 if ((expand_forbid & RDO_PERL) != 0)
3957 expand_string_message = US"Perl calls are not permitted";
3961 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3964 case 1: goto EXPAND_FAILED_CURLY;
3966 case 3: goto EXPAND_FAILED;
3969 /* If skipping, we don't actually do anything */
3971 if (skipping) continue;
3973 /* Start the interpreter if necessary */
3975 if (!opt_perl_started)
3978 if (opt_perl_startup == NULL)
3980 expand_string_message = US"A setting of perl_startup is needed when "
3981 "using the Perl interpreter";
3984 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3985 initerror = init_perl(opt_perl_startup);
3986 if (initerror != NULL)
3988 expand_string_message =
3989 string_sprintf("error in perl_startup code: %s\n", initerror);
3992 opt_perl_started = TRUE;
3995 /* Call the function */
3997 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3998 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3999 sub_arg[0], sub_arg + 1);
4001 /* NULL yield indicates failure; if the message pointer has been set to
4002 NULL, the yield was undef, indicating a forced failure. Otherwise the
4003 message will indicate some kind of Perl error. */
4005 if (new_yield == NULL)
4007 if (expand_string_message == NULL)
4009 expand_string_message =
4010 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4011 "failure", sub_arg[0]);
4012 expand_string_forcedfail = TRUE;
4017 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4018 set during a callback from Perl. */
4020 expand_string_forcedfail = FALSE;
4024 #endif /* EXIM_PERL */
4026 /* Transform email address to "prvs" scheme to use
4027 as BATV-signed return path */
4034 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
4036 case 1: goto EXPAND_FAILED_CURLY;
4038 case 3: goto EXPAND_FAILED;
4041 /* If skipping, we don't actually do anything */
4042 if (skipping) continue;
4044 /* sub_arg[0] is the address */
4045 domain = Ustrrchr(sub_arg[0],'@');
4046 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4048 expand_string_message = US"prvs first argument must be a qualified email address";
4052 /* Calculate the hash. The second argument must be a single-digit
4053 key number, or unset. */
4055 if (sub_arg[2] != NULL &&
4056 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4058 expand_string_message = US"prvs second argument must be a single digit";
4062 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4065 expand_string_message = US"prvs hmac-sha1 conversion failed";
4069 /* Now separate the domain from the local part */
4072 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4073 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4074 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4075 string_cat(yield,&size,&ptr,p,6);
4076 string_cat(yield,&size,&ptr,US"=",1);
4077 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4078 string_cat(yield,&size,&ptr,US"@",1);
4079 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4084 /* Check a prvs-encoded address for validity */
4086 case EITEM_PRVSCHECK:
4089 int mysize = 0, myptr = 0;
4093 /* TF: Ugliness: We want to expand parameter 1 first, then set
4094 up expansion variables that are used in the expansion of
4095 parameter 2. So we clone the string for the first
4096 expansion, where we only expand parameter 1.
4098 PH: Actually, that isn't necessary. The read_subs() function is
4099 designed to work this way for the ${if and ${lookup expansions. I've
4103 /* Reset expansion variables */
4104 prvscheck_result = NULL;
4105 prvscheck_address = NULL;
4106 prvscheck_keynum = NULL;
4108 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4110 case 1: goto EXPAND_FAILED_CURLY;
4112 case 3: goto EXPAND_FAILED;
4115 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4118 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4120 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4121 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4122 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4123 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4124 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4126 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4127 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4128 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4129 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4130 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4132 /* Set up expansion variables */
4133 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4134 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4135 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4136 prvscheck_address[myptr] = '\0';
4137 prvscheck_keynum = string_copy(key_num);
4139 /* Now expand the second argument */
4140 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4142 case 1: goto EXPAND_FAILED_CURLY;
4144 case 3: goto EXPAND_FAILED;
4147 /* Now we have the key and can check the address. */
4149 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4154 expand_string_message = US"hmac-sha1 conversion failed";
4158 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4159 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4161 if (Ustrcmp(p,hash) == 0)
4163 /* Success, valid BATV address. Now check the expiry date. */
4164 uschar *now = prvs_daystamp(0);
4165 unsigned int inow = 0,iexpire = 1;
4167 (void)sscanf(CS now,"%u",&inow);
4168 (void)sscanf(CS daystamp,"%u",&iexpire);
4170 /* When "iexpire" is < 7, a "flip" has occured.
4171 Adjust "inow" accordingly. */
4172 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4174 if (iexpire >= inow)
4176 prvscheck_result = US"1";
4177 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4181 prvscheck_result = NULL;
4182 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4187 prvscheck_result = NULL;
4188 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4191 /* Now expand the final argument. We leave this till now so that
4192 it can include $prvscheck_result. */
4194 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4196 case 1: goto EXPAND_FAILED_CURLY;
4198 case 3: goto EXPAND_FAILED;
4201 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4202 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4204 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4206 /* Reset the "internal" variables afterwards, because they are in
4207 dynamic store that will be reclaimed if the expansion succeeded. */
4209 prvscheck_address = NULL;
4210 prvscheck_keynum = NULL;
4214 /* Does not look like a prvs encoded address, return the empty string.
4215 We need to make sure all subs are expanded first, so as to skip over
4218 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4220 case 1: goto EXPAND_FAILED_CURLY;
4222 case 3: goto EXPAND_FAILED;
4229 /* Handle "readfile" to insert an entire file */
4231 case EITEM_READFILE:
4236 if ((expand_forbid & RDO_READFILE) != 0)
4238 expand_string_message = US"file insertions are not permitted";
4242 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4244 case 1: goto EXPAND_FAILED_CURLY;
4246 case 3: goto EXPAND_FAILED;
4249 /* If skipping, we don't actually do anything */
4251 if (skipping) continue;
4253 /* Open the file and read it */
4255 f = Ufopen(sub_arg[0], "rb");
4258 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4262 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4267 /* Handle "readsocket" to insert data from a Unix domain socket */
4269 case EITEM_READSOCK:
4275 struct sockaddr_un sockun; /* don't call this "sun" ! */
4279 if ((expand_forbid & RDO_READSOCK) != 0)
4281 expand_string_message = US"socket insertions are not permitted";
4285 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4286 because there may be a string for expansion on failure. */
4288 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4290 case 1: goto EXPAND_FAILED_CURLY;
4291 case 2: /* Won't occur: no end check */
4292 case 3: goto EXPAND_FAILED;
4295 /* Sort out timeout, if given */
4297 if (sub_arg[2] != NULL)
4299 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4302 expand_string_message = string_sprintf("bad time value %s",
4307 else sub_arg[3] = NULL; /* No eol if no timeout */
4309 /* If skipping, we don't actually do anything. Otherwise, arrange to
4310 connect to either an IP or a Unix socket. */
4314 /* Handle an IP (internet) domain */
4316 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4318 BOOL connected = FALSE;
4322 uschar *server_name = sub_arg[0] + 5;
4323 uschar *port_name = Ustrrchr(server_name, ':');
4325 /* Sort out the port */
4327 if (port_name == NULL)
4329 expand_string_message =
4330 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4333 *port_name++ = 0; /* Terminate server name */
4335 if (isdigit(*port_name))
4338 port = Ustrtol(port_name, &end, 0);
4339 if (end != port_name + Ustrlen(port_name))
4341 expand_string_message =
4342 string_sprintf("invalid port number %s", port_name);
4348 struct servent *service_info = getservbyname(CS port_name, "tcp");
4349 if (service_info == NULL)
4351 expand_string_message = string_sprintf("unknown port \"%s\"",
4355 port = ntohs(service_info->s_port);
4358 /* Sort out the server. */
4361 shost.address = NULL;
4365 namelen = Ustrlen(server_name);
4367 /* Anything enclosed in [] must be an IP address. */
4369 if (server_name[0] == '[' &&
4370 server_name[namelen - 1] == ']')
4372 server_name[namelen - 1] = 0;
4374 if (string_is_ip_address(server_name, NULL) == 0)
4376 expand_string_message =
4377 string_sprintf("malformed IP address \"%s\"", server_name);
4380 shost.name = shost.address = server_name;
4383 /* Otherwise check for an unadorned IP address */
4385 else if (string_is_ip_address(server_name, NULL) != 0)
4386 shost.name = shost.address = server_name;
4388 /* Otherwise lookup IP address(es) from the name */
4392 shost.name = server_name;
4393 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4394 FALSE) != HOST_FOUND)
4396 expand_string_message =
4397 string_sprintf("no IP address found for host %s", shost.name);
4402 /* Try to connect to the server - test each IP till one works */
4404 for (h = &shost; h != NULL; h = h->next)
4406 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4407 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4409 expand_string_message = string_sprintf("failed to create socket: "
4410 "%s", strerror(errno));
4414 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4423 expand_string_message = string_sprintf("failed to connect to "
4424 "socket %s: couldn't connect to any host", sub_arg[0],
4430 /* Handle a Unix domain socket */
4435 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4437 expand_string_message = string_sprintf("failed to create socket: %s",
4442 sockun.sun_family = AF_UNIX;
4443 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4446 sigalrm_seen = FALSE;
4448 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4452 expand_string_message = US "socket connect timed out";
4457 expand_string_message = string_sprintf("failed to connect to socket "
4458 "%s: %s", sub_arg[0], strerror(errno));
4463 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4465 /* Write the request string, if not empty */
4467 if (sub_arg[1][0] != 0)
4469 int len = Ustrlen(sub_arg[1]);
4470 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4472 if (write(fd, sub_arg[1], len) != len)
4474 expand_string_message = string_sprintf("request write to socket "
4475 "failed: %s", strerror(errno));
4480 /* Shut down the sending side of the socket. This helps some servers to
4481 recognise that it is their turn to do some work. Just in case some
4482 system doesn't have this function, make it conditional. */
4485 shutdown(fd, SHUT_WR);
4488 /* Now we need to read from the socket, under a timeout. The function
4489 that reads a file can be used. */
4491 f = fdopen(fd, "rb");
4492 sigalrm_seen = FALSE;
4494 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4498 /* After a timeout, we restore the pointer in the result, that is,
4499 make sure we add nothing from the socket. */
4504 expand_string_message = US "socket read timed out";
4509 /* The whole thing has worked (or we were skipping). If there is a
4510 failure string following, we need to skip it. */
4514 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4516 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4517 while (isspace(*s)) s++;
4519 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4522 /* Come here on failure to create socket, connect socket, write to the
4523 socket, or timeout on reading. If another substring follows, expand and
4524 use it. Otherwise, those conditions give expand errors. */
4527 if (*s != '{') goto EXPAND_FAILED;
4528 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4529 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4530 if (arg == NULL) goto EXPAND_FAILED;
4531 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4532 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4533 while (isspace(*s)) s++;
4534 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4538 /* Handle "run" to execute a program. */
4550 if ((expand_forbid & RDO_RUN) != 0)
4552 expand_string_message = US"running a command is not permitted";
4556 while (isspace(*s)) s++;
4557 if (*s != '{') goto EXPAND_FAILED_CURLY;
4558 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4559 if (arg == NULL) goto EXPAND_FAILED;
4560 while (isspace(*s)) s++;
4561 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4563 if (skipping) /* Just pretend it worked when we're skipping */
4569 if (!transport_set_up_command(&argv, /* anchor for arg list */
4570 arg, /* raw command */
4571 FALSE, /* don't expand the arguments */
4572 0, /* not relevant when... */
4573 NULL, /* no transporting address */
4574 US"${run} expansion", /* for error messages */
4575 &expand_string_message)) /* where to put error message */
4580 /* Create the child process, making it a group leader. */
4582 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4586 expand_string_message =
4587 string_sprintf("couldn't create child process: %s", strerror(errno));
4591 /* Nothing is written to the standard input. */
4595 /* Read the pipe to get the command's output into $value (which is kept
4596 in lookup_value). Read during execution, so that if the output exceeds
4597 the OS pipe buffer limit, we don't block forever. */
4599 f = fdopen(fd_out, "rb");
4600 sigalrm_seen = FALSE;
4602 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4606 /* Wait for the process to finish, applying the timeout, and inspect its
4607 return code for serious disasters. Simple non-zero returns are passed on.
4610 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4612 if (sigalrm_seen == TRUE || runrc == -256)
4614 expand_string_message = string_sprintf("command timed out");
4615 killpg(pid, SIGKILL); /* Kill the whole process group */
4618 else if (runrc == -257)
4619 expand_string_message = string_sprintf("wait() failed: %s",
4623 expand_string_message = string_sprintf("command killed by signal %d",
4630 /* Process the yes/no strings; $value may be useful in both cases */
4632 switch(process_yesno(
4633 skipping, /* were previously skipping */
4634 runrc == 0, /* success/failure indicator */
4635 lookup_value, /* value to reset for string2 */
4636 &s, /* input pointer */
4637 &yield, /* output pointer */
4638 &size, /* output size */
4639 &ptr, /* output current point */
4640 US"run")) /* condition type */
4642 case 1: goto EXPAND_FAILED; /* when all is well, the */
4643 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4649 /* Handle character translation for "tr" */
4657 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4659 case 1: goto EXPAND_FAILED_CURLY;
4661 case 3: goto EXPAND_FAILED;
4664 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4665 o2m = Ustrlen(sub[2]) - 1;
4667 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4669 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4673 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4680 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4681 expanded arguments. */
4691 int val[2] = { 0, -1 };
4694 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4695 Ensure that sub[2] is set in the ${length case. */
4698 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4701 case 1: goto EXPAND_FAILED_CURLY;
4703 case 3: goto EXPAND_FAILED;
4706 /* Juggle the arguments if there are only two of them: always move the
4707 string to the last position and make ${length{n}{str}} equivalent to
4708 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4714 if (item_type == EITEM_LENGTH)
4721 for (i = 0; i < 2; i++)
4723 if (sub[i] == NULL) continue;
4724 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4725 if (*ret != 0 || (i != 0 && val[i] < 0))
4727 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4728 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4734 (item_type == EITEM_HASH)?
4735 compute_hash(sub[2], val[0], val[1], &len) :
4736 (item_type == EITEM_NHASH)?
4737 compute_nhash(sub[2], val[0], val[1], &len) :
4738 extract_substr(sub[2], val[0], val[1], &len);
4740 if (ret == NULL) goto EXPAND_FAILED;
4741 yield = string_cat(yield, &size, &ptr, ret, len);
4745 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4746 This code originally contributed by Steve Haslam. It currently supports
4747 the use of MD5 and SHA-1 hashes.
4749 We need some workspace that is large enough to handle all the supported
4750 hash types. Use macros to set the sizes rather than be too elaborate. */
4752 #define MAX_HASHLEN 20
4753 #define MAX_HASHBLOCKLEN 64
4762 int hashlen; /* Number of octets for the hash algorithm's output */
4763 int hashblocklen; /* Number of octets the hash algorithm processes */
4765 unsigned int keylen;
4767 uschar keyhash[MAX_HASHLEN];
4768 uschar innerhash[MAX_HASHLEN];
4769 uschar finalhash[MAX_HASHLEN];
4770 uschar finalhash_hex[2*MAX_HASHLEN];
4771 uschar innerkey[MAX_HASHBLOCKLEN];
4772 uschar outerkey[MAX_HASHBLOCKLEN];
4774 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4776 case 1: goto EXPAND_FAILED_CURLY;
4778 case 3: goto EXPAND_FAILED;
4781 if (Ustrcmp(sub[0], "md5") == 0)
4784 use_base = &md5_base;
4788 else if (Ustrcmp(sub[0], "sha1") == 0)
4791 use_base = &sha1_base;
4797 expand_string_message =
4798 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4803 keylen = Ustrlen(keyptr);
4805 /* If the key is longer than the hash block length, then hash the key
4808 if (keylen > hashblocklen)
4810 chash_start(type, use_base);
4811 chash_end(type, use_base, keyptr, keylen, keyhash);
4816 /* Now make the inner and outer key values */
4818 memset(innerkey, 0x36, hashblocklen);
4819 memset(outerkey, 0x5c, hashblocklen);
4821 for (i = 0; i < keylen; i++)
4823 innerkey[i] ^= keyptr[i];
4824 outerkey[i] ^= keyptr[i];
4827 /* Now do the hashes */
4829 chash_start(type, use_base);
4830 chash_mid(type, use_base, innerkey);
4831 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4833 chash_start(type, use_base);
4834 chash_mid(type, use_base, outerkey);
4835 chash_end(type, use_base, innerhash, hashlen, finalhash);
4837 /* Encode the final hash as a hex string */
4840 for (i = 0; i < hashlen; i++)
4842 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4843 *p++ = hex_digits[finalhash[i] & 0x0f];
4846 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4847 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4849 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4854 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4855 We have to save the numerical variables and restore them afterwards. */
4860 int moffset, moffsetextra, slen;
4863 const uschar *rerror;
4866 int save_expand_nmax =
4867 save_expand_strings(save_expand_nstring, save_expand_nlength);
4869 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4871 case 1: goto EXPAND_FAILED_CURLY;
4873 case 3: goto EXPAND_FAILED;
4876 /* Compile the regular expression */
4878 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4883 expand_string_message = string_sprintf("regular expression error in "
4884 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4888 /* Now run a loop to do the substitutions as often as necessary. It ends
4889 when there are no more matches. Take care over matches of the null string;
4890 do the same thing as Perl does. */
4893 slen = Ustrlen(sub[0]);
4894 moffset = moffsetextra = 0;
4899 int ovector[3*(EXPAND_MAXN+1)];
4900 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4901 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4905 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4906 is not necessarily the end. We want to repeat the match from one
4907 character further along, but leaving the basic offset the same (for
4908 copying below). We can't be at the end of the string - that was checked
4909 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4910 finished; copy the remaining string and end the loop. */
4920 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4924 /* Match - set up for expanding the replacement. */
4926 if (n == 0) n = EXPAND_MAXN + 1;
4928 for (nn = 0; nn < n*2; nn += 2)
4930 expand_nstring[expand_nmax] = subject + ovector[nn];
4931 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4935 /* Copy the characters before the match, plus the expanded insertion. */
4937 yield = string_cat(yield, &size, &ptr, subject + moffset,
4938 ovector[0] - moffset);
4939 insert = expand_string(sub[2]);
4940 if (insert == NULL) goto EXPAND_FAILED;
4941 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4943 moffset = ovector[1];
4947 /* If we have matched an empty string, first check to see if we are at
4948 the end of the subject. If so, the loop is over. Otherwise, mimic
4949 what Perl's /g options does. This turns out to be rather cunning. First
4950 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4951 string at the same point. If this fails (picked up above) we advance to
4952 the next character. */
4954 if (ovector[0] == ovector[1])
4956 if (ovector[0] == slen) break;
4957 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4961 /* All done - restore numerical variables. */
4963 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4964 save_expand_nlength);
4968 /* Handle keyed and numbered substring extraction. If the first argument
4969 consists entirely of digits, then a numerical extraction is assumed. */
4975 int field_number = 1;
4976 BOOL field_number_set = FALSE;
4977 uschar *save_lookup_value = lookup_value;
4979 int save_expand_nmax =
4980 save_expand_strings(save_expand_nstring, save_expand_nlength);
4982 /* Read the arguments */
4984 for (i = 0; i < j; i++)
4986 while (isspace(*s)) s++;
4989 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4990 if (sub[i] == NULL) goto EXPAND_FAILED;
4991 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4993 /* After removal of leading and trailing white space, the first
4994 argument must not be empty; if it consists entirely of digits
4995 (optionally preceded by a minus sign), this is a numerical
4996 extraction, and we expect 3 arguments. */
5004 while (isspace(*p)) p++;
5008 while (len > 0 && isspace(p[len-1])) len--;
5011 if (*p == 0 && !skipping)
5013 expand_string_message = US"first argument of \"extract\" must "
5023 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5027 j = 3; /* Need 3 args */
5028 field_number_set = TRUE;
5032 else goto EXPAND_FAILED_CURLY;
5035 /* Extract either the numbered or the keyed substring into $value. If
5036 skipping, just pretend the extraction failed. */
5038 lookup_value = skipping? NULL : field_number_set?
5039 expand_gettokened(field_number, sub[1], sub[2]) :
5040 expand_getkeyed(sub[0], sub[1]);
5042 /* If no string follows, $value gets substituted; otherwise there can
5043 be yes/no strings, as for lookup or if. */
5045 switch(process_yesno(
5046 skipping, /* were previously skipping */
5047 lookup_value != NULL, /* success/failure indicator */
5048 save_lookup_value, /* value to reset for string2 */
5049 &s, /* input pointer */
5050 &yield, /* output pointer */
5051 &size, /* output size */
5052 &ptr, /* output current point */
5053 US"extract")) /* condition type */
5055 case 1: goto EXPAND_FAILED; /* when all is well, the */
5056 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5059 /* All done - restore numerical variables. */
5061 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5062 save_expand_nlength);
5068 /* Handle list operations */
5076 uschar outsep[2] = { '\0', '\0' };
5077 uschar *list, *expr, *temp;
5078 uschar *save_iterate_item = iterate_item;
5079 uschar *save_lookup_value = lookup_value;
5081 while (isspace(*s)) s++;
5082 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5084 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5085 if (list == NULL) goto EXPAND_FAILED;
5086 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5088 if (item_type == EITEM_REDUCE)
5090 while (isspace(*s)) s++;
5091 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5092 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5093 if (temp == NULL) goto EXPAND_FAILED;
5094 lookup_value = temp;
5095 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5098 while (isspace(*s)) s++;
5099 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5103 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5104 if scanning a "false" part). This allows us to find the end of the
5105 condition, because if the list is empty, we won't actually evaluate the
5106 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5107 the normal internal expansion function. */
5109 if (item_type == EITEM_FILTER)
5111 temp = eval_condition(expr, NULL);
5112 if (temp != NULL) s = temp;
5116 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5121 expand_string_message = string_sprintf("%s inside \"%s\" item",
5122 expand_string_message, name);
5126 while (isspace(*s)) s++;
5129 expand_string_message = string_sprintf("missing } at end of condition "
5130 "or expression inside \"%s\"", name);
5134 while (isspace(*s)) s++;
5137 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5142 /* If we are skipping, we can now just move on to the next item. When
5143 processing for real, we perform the iteration. */
5145 if (skipping) continue;
5146 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5148 *outsep = (uschar)sep; /* Separator as a string */
5150 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5152 if (item_type == EITEM_FILTER)
5155 if (eval_condition(expr, &condresult) == NULL)
5157 iterate_item = save_iterate_item;
5158 lookup_value = save_lookup_value;
5159 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5160 expand_string_message, name);
5163 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5164 condresult? "true":"false");
5166 temp = iterate_item; /* TRUE => include this item */
5168 continue; /* FALSE => skip this item */
5171 /* EITEM_MAP and EITEM_REDUCE */
5175 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5178 iterate_item = save_iterate_item;
5179 expand_string_message = string_sprintf("%s inside \"%s\" item",
5180 expand_string_message, name);
5183 if (item_type == EITEM_REDUCE)
5185 lookup_value = temp; /* Update the value of $value */
5186 continue; /* and continue the iteration */
5190 /* We reach here for FILTER if the condition is true, always for MAP,
5191 and never for REDUCE. The value in "temp" is to be added to the output
5192 list that is being created, ensuring that any occurrences of the
5193 separator character are doubled. Unless we are dealing with the first
5194 item of the output list, add in a space if the new item begins with the
5195 separator character, or is an empty string. */
5197 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5198 yield = string_cat(yield, &size, &ptr, US" ", 1);
5200 /* Add the string in "temp" to the output list that we are building,
5201 This is done in chunks by searching for the separator character. */
5205 size_t seglen = Ustrcspn(temp, outsep);
5206 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5208 /* If we got to the end of the string we output one character
5209 too many; backup and end the loop. Otherwise arrange to double the
5212 if (temp[seglen] == '\0') { ptr--; break; }
5213 yield = string_cat(yield, &size, &ptr, outsep, 1);
5217 /* Output a separator after the string: we will remove the redundant
5218 final one at the end. */
5220 yield = string_cat(yield, &size, &ptr, outsep, 1);
5221 } /* End of iteration over the list loop */
5223 /* REDUCE has generated no output above: output the final value of
5226 if (item_type == EITEM_REDUCE)
5228 yield = string_cat(yield, &size, &ptr, lookup_value,
5229 Ustrlen(lookup_value));
5230 lookup_value = save_lookup_value; /* Restore $value */
5233 /* FILTER and MAP generate lists: if they have generated anything, remove
5234 the redundant final separator. Even though an empty item at the end of a
5235 list does not count, this is tidier. */
5237 else if (ptr != save_ptr) ptr--;
5239 /* Restore preserved $item */
5241 iterate_item = save_iterate_item;
5246 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5247 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5248 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5249 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5251 #define EXPAND_DLFUNC_MAX_ARGS 8
5254 #ifndef EXPAND_DLFUNC
5255 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5256 "is not included in this binary";
5259 #else /* EXPAND_DLFUNC */
5262 exim_dlfunc_t *func;
5265 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5267 if ((expand_forbid & RDO_DLFUNC) != 0)
5269 expand_string_message =
5270 US"dynamically-loaded functions are not permitted";
5274 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5277 case 1: goto EXPAND_FAILED_CURLY;
5279 case 3: goto EXPAND_FAILED;
5282 /* If skipping, we don't actually do anything */
5284 if (skipping) continue;
5286 /* Look up the dynamically loaded object handle in the tree. If it isn't
5287 found, dlopen() the file and put the handle in the tree for next time. */
5289 t = tree_search(dlobj_anchor, argv[0]);
5292 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5295 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5296 argv[0], dlerror());
5297 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5300 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5301 Ustrcpy(t->name, argv[0]);
5302 t->data.ptr = handle;
5303 (void)tree_insertnode(&dlobj_anchor, t);
5306 /* Having obtained the dynamically loaded object handle, look up the
5307 function pointer. */
5309 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5312 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5313 "%s", argv[1], argv[0], dlerror());
5314 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5318 /* Call the function and work out what to do with the result. If it
5319 returns OK, we have a replacement string; if it returns DEFER then
5320 expansion has failed in a non-forced manner; if it returns FAIL then
5321 failure was forced; if it returns ERROR or any other value there's a
5322 problem, so panic slightly. In any case, assume that the function has
5323 side-effects on the store that must be preserved. */
5327 for (argc = 0; argv[argc] != NULL; argc++);
5328 status = func(&result, argc - 2, &argv[2]);
5331 if (result == NULL) result = US"";
5332 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5337 expand_string_message = result == NULL ? US"(no message)" : result;
5338 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5339 else if(status != FAIL)
5340 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5341 argv[0], argv[1], status, expand_string_message);
5345 #endif /* EXPAND_DLFUNC */
5348 /* Control reaches here if the name is not recognized as one of the more
5349 complicated expansion items. Check for the "operator" syntax (name terminated
5350 by a colon). Some of the operators have arguments, separated by _ from the
5357 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5358 if (sub == NULL) goto EXPAND_FAILED;
5361 /* Owing to an historical mis-design, an underscore may be part of the
5362 operator name, or it may introduce arguments. We therefore first scan the
5363 table of names that contain underscores. If there is no match, we cut off
5364 the arguments and then scan the main table. */
5366 c = chop_match(name, op_table_underscore,
5367 sizeof(op_table_underscore)/sizeof(uschar *));
5371 arg = Ustrchr(name, '_');
5372 if (arg != NULL) *arg = 0;
5373 c = chop_match(name, op_table_main,
5374 sizeof(op_table_main)/sizeof(uschar *));
5375 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5376 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5379 /* If we are skipping, we don't need to perform the operation at all.
5380 This matters for operations like "mask", because the data may not be
5381 in the correct format when skipping. For example, the expression may test
5382 for the existence of $sender_host_address before trying to mask it. For
5383 other operations, doing them may not fail, but it is a waste of time. */
5385 if (skipping && c >= 0) continue;
5387 /* Otherwise, switch on the operator type */
5394 unsigned long int n = Ustrtoul(sub, &t, 10);
5397 expand_string_message = string_sprintf("argument for base62 "
5398 "operator is \"%s\", which is not a decimal number", sub);
5401 t = string_base62(n);
5402 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5406 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5412 unsigned long int n = 0;
5415 uschar *t = Ustrchr(base62_chars, *tt++);
5418 expand_string_message = string_sprintf("argument for base62d "
5419 "operator is \"%s\", which is not a base %d number", sub,
5423 n = n * BASE_62 + (t - base62_chars);
5425 (void)sprintf(CS buf, "%ld", n);
5426 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5432 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5433 if (expanded == NULL)
5435 expand_string_message =
5436 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5437 expand_string_message);
5440 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5447 uschar *t = sub - 1;
5448 while (*(++t) != 0) { *t = tolower(*t); count++; }
5449 yield = string_cat(yield, &size, &ptr, sub, count);
5456 uschar *t = sub - 1;
5457 while (*(++t) != 0) { *t = toupper(*t); count++; }
5458 yield = string_cat(yield, &size, &ptr, sub, count);
5469 md5_end(&base, sub, Ustrlen(sub), digest);
5470 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5471 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5482 sha1_end(&base, sub, Ustrlen(sub), digest);
5483 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5484 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5488 /* Convert hex encoding to base64 encoding */
5498 for (enc = sub; *enc != 0; enc++)
5500 if (!isxdigit(*enc))
5502 expand_string_message = string_sprintf("\"%s\" is not a hex "
5511 expand_string_message = string_sprintf("\"%s\" contains an odd "
5512 "number of characters", sub);
5516 while ((c = *in++) != 0)
5518 if (isdigit(c)) c -= '0';
5519 else c = toupper(c) - 'A' + 10;
5531 enc = auth_b64encode(sub, out - sub);
5532 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5536 /* count the number of list elements */
5545 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5546 cp = string_sprintf("%d", cnt);
5547 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5551 /* expand a named list given the name */
5552 /* handles nested named lists; requotes as colon-sep list */
5556 tree_node *t = NULL;
5560 uschar * suffix = "";
5561 BOOL needsep = FALSE;
5564 if (*sub == '+') sub++;
5565 if (arg == NULL) /* no-argument version */
5567 if (!(t = tree_search(addresslist_anchor, sub)) &&
5568 !(t = tree_search(domainlist_anchor, sub)) &&
5569 !(t = tree_search(hostlist_anchor, sub)))
5570 t = tree_search(localpartlist_anchor, sub);
5572 else switch(*arg) /* specific list-type version */
5574 case 'a': t = tree_search(addresslist_anchor, sub); suffix = "_a"; break;
5575 case 'd': t = tree_search(domainlist_anchor, sub); suffix = "_d"; break;
5576 case 'h': t = tree_search(hostlist_anchor, sub); suffix = "_h"; break;
5577 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = "_l"; break;
5579 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5585 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5587 : *arg=='a'?"address "
5588 : *arg=='d'?"domain "
5590 : *arg=='l'?"localpart "
5595 list = ((namedlist_block *)(t->data.ptr))->string;
5597 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5599 uschar * buf = US" : ";
5601 yield = string_cat(yield, &size, &ptr, buf, 3);
5605 if (*item == '+') /* list item is itself a named list */
5607 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5608 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE);
5610 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5614 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5615 while ((cp= strpbrk((const char *)item, tok)))
5617 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5618 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5620 yield = string_cat(yield, &size, &ptr, US"::", 2);
5623 else /* sep in item; should already be doubled; emit once */
5625 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5626 if (*cp == sep) cp++;
5631 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5636 /* mask applies a mask to an IP address; for example the result of
5637 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5644 int mask, maskoffset;
5645 int type = string_is_ip_address(sub, &maskoffset);
5650 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5655 if (maskoffset == 0)
5657 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5662 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5664 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5666 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5671 /* Convert the address to binary integer(s) and apply the mask */
5673 sub[maskoffset] = 0;
5674 count = host_aton(sub, binary);
5675 host_mask(count, binary, mask);
5677 /* Convert to masked textual format and add to output. */
5679 yield = string_cat(yield, &size, &ptr, buffer,
5680 host_nmtoa(count, binary, mask, buffer, '.'));
5685 case EOP_LOCAL_PART:
5689 int start, end, domain;
5690 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5694 if (c != EOP_DOMAIN)
5696 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5697 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5699 else if (domain != 0)
5702 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5710 uschar outsep[2] = { ':', '\0' };
5711 uschar *address, *error;
5713 int start, end, domain; /* Not really used */
5715 while (isspace(*sub)) sub++;
5716 if (*sub == '>') { *outsep = *++sub; ++sub; }
5717 parse_allow_group = TRUE;
5721 uschar *p = parse_find_address_end(sub, FALSE);
5722 uschar saveend = *p;
5724 address = parse_extract_address(sub, &error, &start, &end, &domain,
5728 /* Add the address to the output list that we are building. This is
5729 done in chunks by searching for the separator character. At the
5730 start, unless we are dealing with the first address of the output
5731 list, add in a space if the new address begins with the separator
5732 character, or is an empty string. */
5734 if (address != NULL)
5736 if (ptr != save_ptr && address[0] == *outsep)
5737 yield = string_cat(yield, &size, &ptr, US" ", 1);
5741 size_t seglen = Ustrcspn(address, outsep);
5742 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5744 /* If we got to the end of the string we output one character
5747 if (address[seglen] == '\0') { ptr--; break; }
5748 yield = string_cat(yield, &size, &ptr, outsep, 1);
5749 address += seglen + 1;
5752 /* Output a separator after the string: we will remove the
5753 redundant final one at the end. */
5755 yield = string_cat(yield, &size, &ptr, outsep, 1);
5758 if (saveend == '\0') break;
5762 /* If we have generated anything, remove the redundant final
5765 if (ptr != save_ptr) ptr--;
5766 parse_allow_group = FALSE;
5771 /* quote puts a string in quotes if it is empty or contains anything
5772 other than alphamerics, underscore, dot, or hyphen.
5774 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5775 be quoted in order to be a valid local part.
5777 In both cases, newlines and carriage returns are converted into \n and \r
5781 case EOP_QUOTE_LOCAL_PART:
5784 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5785 uschar *t = sub - 1;
5789 while (!needs_quote && *(++t) != 0)
5790 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5792 else /* EOP_QUOTE_LOCAL_PART */
5794 while (!needs_quote && *(++t) != 0)
5795 needs_quote = !isalnum(*t) &&
5796 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5797 (*t != '.' || t == sub || t[1] == 0);
5802 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5807 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5808 else if (*t == '\r')
5809 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5812 if (*t == '\\' || *t == '"')
5813 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5814 yield = string_cat(yield, &size, &ptr, t, 1);
5817 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5819 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5823 /* quote_lookuptype does lookup-specific quoting */
5828 uschar *opt = Ustrchr(arg, '_');
5830 if (opt != NULL) *opt++ = 0;
5832 n = search_findtype(arg, Ustrlen(arg));
5835 expand_string_message = search_error_message;
5839 if (lookup_list[n]->quote != NULL)
5840 sub = (lookup_list[n]->quote)(sub, opt);
5841 else if (opt != NULL) sub = NULL;
5845 expand_string_message = string_sprintf(
5846 "\"%s\" unrecognized after \"${quote_%s\"",
5851 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5855 /* rx quote sticks in \ before any non-alphameric character so that
5856 the insertion works in a regular expression. */
5860 uschar *t = sub - 1;
5864 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5865 yield = string_cat(yield, &size, &ptr, t, 1);
5870 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5871 prescribed by the RFC, if there are characters that need to be encoded */
5875 uschar buffer[2048];
5876 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5877 buffer, sizeof(buffer), FALSE);
5878 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5882 /* RFC 2047 decode */
5888 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5889 headers_charset, '?', &len, &error);
5892 expand_string_message = error;
5895 yield = string_cat(yield, &size, &ptr, decoded, len);
5899 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5909 if (c > 255) c = '_';
5911 yield = string_cat(yield, &size, &ptr, buff, 1);
5916 /* escape turns all non-printing characters into escape sequences. */
5920 uschar *t = string_printing(sub);
5921 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5925 /* Handle numeric expression evaluation */
5930 uschar *save_sub = sub;
5931 uschar *error = NULL;
5932 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5935 expand_string_message = string_sprintf("error in expression "
5936 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5940 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
5941 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5945 /* Handle time period formating */
5949 int n = readconf_readtime(sub, 0, FALSE);
5952 expand_string_message = string_sprintf("string \"%s\" is not an "
5953 "Exim time interval in \"%s\" operator", sub, name);
5956 sprintf(CS var_buffer, "%d", n);
5957 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5961 case EOP_TIME_INTERVAL:
5964 uschar *t = read_number(&n, sub);
5965 if (*t != 0) /* Not A Number*/
5967 expand_string_message = string_sprintf("string \"%s\" is not a "
5968 "positive number in \"%s\" operator", sub, name);
5971 t = readconf_printtime(n);
5972 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5976 /* Convert string to base64 encoding */
5980 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5981 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5985 /* strlen returns the length of the string */
5990 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5991 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5995 /* length_n or l_n takes just the first n characters or the whole string,
5996 whichever is the shorter;
5998 substr_m_n, and s_m_n take n characters from offset m; negative m take
5999 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6000 takes the rest, either to the right or to the left.
6002 hash_n or h_n makes a hash of length n from the string, yielding n
6003 characters from the set a-z; hash_n_m makes a hash of length n, but
6004 uses m characters from the set a-zA-Z0-9.
6006 nhash_n returns a single number between 0 and n-1 (in text form), while
6007 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6008 between 0 and n-1 and the second between 0 and m-1. */
6028 expand_string_message = string_sprintf("missing values after %s",
6033 /* "length" has only one argument, effectively being synonymous with
6036 if (c == EOP_LENGTH || c == EOP_L)
6042 /* The others have one or two arguments; for "substr" the first may be
6043 negative. The second being negative means "not supplied". */
6048 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6051 /* Read up to two numbers, separated by underscores */
6056 if (arg != ret && *arg == '_' && pn == &value1)
6060 if (arg[1] != 0) arg++;
6062 else if (!isdigit(*arg))
6064 expand_string_message =
6065 string_sprintf("non-digit after underscore in \"%s\"", name);
6068 else *pn = (*pn)*10 + *arg++ - '0';
6072 /* Perform the required operation */
6075 (c == EOP_HASH || c == EOP_H)?
6076 compute_hash(sub, value1, value2, &len) :
6077 (c == EOP_NHASH || c == EOP_NH)?
6078 compute_nhash(sub, value1, value2, &len) :
6079 extract_substr(sub, value1, value2, &len);
6081 if (ret == NULL) goto EXPAND_FAILED;
6082 yield = string_cat(yield, &size, &ptr, ret, len);
6092 uschar **modetable[3];
6097 if ((expand_forbid & RDO_EXISTS) != 0)
6099 expand_string_message = US"Use of the stat() expansion is not permitted";
6103 if (stat(CS sub, &st) < 0)
6105 expand_string_message = string_sprintf("stat(%s) failed: %s",
6106 sub, strerror(errno));
6110 switch (mode & S_IFMT)
6112 case S_IFIFO: smode[0] = 'p'; break;
6113 case S_IFCHR: smode[0] = 'c'; break;
6114 case S_IFDIR: smode[0] = 'd'; break;
6115 case S_IFBLK: smode[0] = 'b'; break;
6116 case S_IFREG: smode[0] = '-'; break;
6117 default: smode[0] = '?'; break;
6120 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6121 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6122 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6124 for (i = 0; i < 3; i++)
6126 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6131 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6132 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6133 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6134 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6135 (long)st.st_gid, st.st_size, (long)st.st_atime,
6136 (long)st.st_mtime, (long)st.st_ctime);
6137 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6141 /* vaguely random number less than N */
6145 int_eximarith_t max;
6148 max = expand_string_integer(sub, TRUE);
6149 if (expand_string_message != NULL)
6151 s = string_sprintf("%d", vaguely_random_number((int)max));
6152 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6156 /* Reverse IP, including IPv6 to dotted-nibble */
6158 case EOP_REVERSE_IP:
6160 int family, maskptr;
6161 uschar reversed[128];
6163 family = string_is_ip_address(sub, &maskptr);
6166 expand_string_message = string_sprintf(
6167 "reverse_ip() not given an IP address [%s]", sub);
6170 invert_address(reversed, sub);
6171 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6175 /* Unknown operator */
6178 expand_string_message =
6179 string_sprintf("unknown expansion operator \"%s\"", name);
6184 /* Handle a plain name. If this is the first thing in the expansion, release
6185 the pre-allocated buffer. If the result data is known to be in a new buffer,
6186 newsize will be set to the size of that buffer, and we can just point at that
6187 store instead of copying. Many expansion strings contain just one reference,
6188 so this is a useful optimization, especially for humungous headers
6189 ($message_headers). */
6197 if (resetok) store_reset(yield);
6201 value = find_variable(name, FALSE, skipping, &newsize);
6204 expand_string_message =
6205 string_sprintf("unknown variable in \"${%s}\"", name);
6206 check_variable_error_message(name);
6209 len = Ustrlen(value);
6210 if (yield == NULL && newsize != 0)
6216 else yield = string_cat(yield, &size, &ptr, value, len);
6220 /* Else there's something wrong */
6222 expand_string_message =
6223 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6224 "in a variable reference)", name);
6228 /* If we hit the end of the string when ket_ends is set, there is a missing
6229 terminating brace. */
6231 if (ket_ends && *s == 0)
6233 expand_string_message = malformed_header?
6234 US"missing } at end of string - could be header name not terminated by colon"
6236 US"missing } at end of string";
6240 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6241 added to the string. If so, set up an empty string. Add a terminating zero. If
6242 left != NULL, return a pointer to the terminator. */
6244 if (yield == NULL) yield = store_get(1);
6246 if (left != NULL) *left = s;
6248 /* Any stacking store that was used above the final string is no longer needed.
6249 In many cases the final string will be the first one that was got and so there
6250 will be optimal store usage. */
6252 if (resetok) store_reset(yield + ptr + 1);
6255 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6257 if (skipping) debug_printf("skipping: result is not used\n");
6261 /* This is the failure exit: easiest to program with a goto. We still need
6262 to update the pointer to the terminator, for cases of nested calls with "fail".
6265 EXPAND_FAILED_CURLY:
6266 expand_string_message = malformed_header?
6267 US"missing or misplaced { or } - could be header name not terminated by colon"
6269 US"missing or misplaced { or }";
6271 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6272 that is a bad idea, because expand_string_message is in dynamic store. */
6275 if (left != NULL) *left = s;
6278 debug_printf("failed to expand: %s\n", string);
6279 debug_printf(" error message: %s\n", expand_string_message);
6280 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6286 /* This is the external function call. Do a quick check for any expansion
6287 metacharacters, and if there are none, just return the input string.
6289 Argument: the string to be expanded
6290 Returns: the expanded string, or NULL if expansion failed; if failure was
6291 due to a lookup deferring, search_find_defer will be TRUE
6295 expand_string(uschar *string)
6297 search_find_defer = FALSE;
6298 malformed_header = FALSE;
6299 return (Ustrpbrk(string, "$\\") == NULL)? string :
6300 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6305 /*************************************************
6307 *************************************************/
6309 /* Now and again we want to expand a string and be sure that the result is in a
6310 new bit of store. This function does that.
6312 Argument: the string to be expanded
6313 Returns: the expanded string, always in a new bit of store, or NULL
6317 expand_string_copy(uschar *string)
6319 uschar *yield = expand_string(string);
6320 if (yield == string) yield = string_copy(string);
6326 /*************************************************
6327 * Expand and interpret as an integer *
6328 *************************************************/
6330 /* Expand a string, and convert the result into an integer.
6333 string the string to be expanded
6334 isplus TRUE if a non-negative number is expected
6336 Returns: the integer value, or
6337 -1 for an expansion error ) in both cases, message in
6338 -2 for an integer interpretation error ) expand_string_message
6339 expand_string_message is set NULL for an OK integer
6343 expand_string_integer(uschar *string, BOOL isplus)
6345 int_eximarith_t value;
6346 uschar *s = expand_string(string);
6347 uschar *msg = US"invalid integer \"%s\"";
6350 /* If expansion failed, expand_string_message will be set. */
6352 if (s == NULL) return -1;
6354 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6355 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6356 systems, so we set it zero ourselves. */
6359 expand_string_message = NULL; /* Indicates no error */
6361 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6362 equal to 0. Unfortunately, people actually relied upon that, so preserve
6363 the behaviour explicitly. Stripping leading whitespace is a harmless
6364 noop change since strtol skips it anyway (provided that there is a number
6368 while (isspace(*s)) ++s;
6372 debug_printf("treating blank string as number 0\n");
6377 value = strtoll(CS s, CSS &endptr, 10);
6381 msg = US"integer expected but \"%s\" found";
6383 else if (value < 0 && isplus)
6385 msg = US"non-negative integer expected but \"%s\" found";
6389 switch (tolower(*endptr))
6394 if (value > LLONG_MAX/1024 || value < LLONG_MIN/1024) errno = ERANGE;
6399 if (value > LLONG_MAX/(1024*1024) || value < LLONG_MIN/(1024*1024)) errno = ERANGE;
6400 else value *= 1024*1024;
6404 if (value > LLONG_MAX/(1024*1024*1024) || value < LLONG_MIN/(1024*1024*1024)) errno = ERANGE;
6405 else value *= 1024*1024*1024;
6409 if (errno == ERANGE)
6410 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6413 while (isspace(*endptr)) endptr++;
6414 if (*endptr == 0) return (int)value;
6418 expand_string_message = string_sprintf(CS msg, s);
6423 /*************************************************
6424 **************************************************
6425 * Stand-alone test program *
6426 **************************************************
6427 *************************************************/
6433 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6435 int ovector[3*(EXPAND_MAXN+1)];
6436 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6437 ovector, sizeof(ovector)/sizeof(int));
6438 BOOL yield = n >= 0;
6439 if (n == 0) n = EXPAND_MAXN + 1;
6443 expand_nmax = (setup < 0)? 0 : setup + 1;
6444 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6446 expand_nstring[expand_nmax] = subject + ovector[nn];
6447 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6455 int main(int argc, uschar **argv)
6458 uschar buffer[1024];
6460 debug_selector = D_v;
6461 debug_file = stderr;
6462 debug_fd = fileno(debug_file);
6463 big_buffer = malloc(big_buffer_size);
6465 for (i = 1; i < argc; i++)
6467 if (argv[i][0] == '+')
6469 debug_trace_memory = 2;
6472 if (isdigit(argv[i][0]))
6473 debug_selector = Ustrtol(argv[i], NULL, 0);
6475 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6479 eldap_default_servers = argv[i];
6482 mysql_servers = argv[i];
6485 pgsql_servers = argv[i];
6489 else opt_perl_startup = argv[i];
6493 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6495 expand_nstring[1] = US"string 1....";
6496 expand_nlength[1] = 8;
6500 if (opt_perl_startup != NULL)
6503 printf("Starting Perl interpreter\n");
6504 errstr = init_perl(opt_perl_startup);
6507 printf("** error in perl_startup code: %s\n", errstr);
6508 return EXIT_FAILURE;
6511 #endif /* EXIM_PERL */
6513 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6515 void *reset_point = store_get(0);
6516 uschar *yield = expand_string(buffer);
6519 printf("%s\n", yield);
6520 store_reset(reset_point);
6524 if (search_find_defer) printf("search_find deferred\n");
6525 printf("Failed: %s\n", expand_string_message);
6526 if (expand_string_forcedfail) printf("Forced failure\n");
6538 /* End of expand.c */