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, 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[] = {
208 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
244 /* Table of condition names, and corresponding switch numbers. The names must
245 be in alphabetical order. */
247 static uschar *cond_table[] = {
251 US"==", /* Backward compatibility */
284 US"match_local_part",
309 ECOND_FIRST_DELIVERY,
330 ECOND_MATCH_LOCAL_PART,
340 /* Type for main variable table */
348 /* Type for entries pointing to address/length pairs. Not currently
356 /* Types of table entry */
359 vtype_int, /* value is address of int */
360 vtype_filter_int, /* ditto, but recognized only when filtering */
361 vtype_ino, /* value is address of ino_t (not always an int) */
362 vtype_uid, /* value is address of uid_t (not always an int) */
363 vtype_gid, /* value is address of gid_t (not always an int) */
364 vtype_bool, /* value is address of bool */
365 vtype_stringptr, /* value is address of pointer to string */
366 vtype_msgbody, /* as stringptr, but read when first required */
367 vtype_msgbody_end, /* ditto, the end of the message */
368 vtype_msgheaders, /* the message's headers, processed */
369 vtype_msgheaders_raw, /* the message's headers, unprocessed */
370 vtype_localpart, /* extract local part from string */
371 vtype_domain, /* extract domain from string */
372 vtype_string_func, /* value is string returned by given function */
373 vtype_todbsdin, /* value not used; generate BSD inbox tod */
374 vtype_tode, /* value not used; generate tod in epoch format */
375 vtype_todel, /* value not used; generate tod in epoch/usec format */
376 vtype_todf, /* value not used; generate full tod */
377 vtype_todl, /* value not used; generate log tod */
378 vtype_todlf, /* value not used; generate log file datestamp tod */
379 vtype_todzone, /* value not used; generate time zone only */
380 vtype_todzulu, /* value not used; generate zulu tod */
381 vtype_reply, /* value not used; get reply from headers */
382 vtype_pid, /* value not used; result is pid */
383 vtype_host_lookup, /* value not used; get host name */
384 vtype_load_avg, /* value not used; result is int from os_getloadavg */
385 vtype_pspace, /* partition space; value is T/F for spool/log */
386 vtype_pinodes /* partition inodes; value is T/F for spool/log */
388 ,vtype_dkim /* Lookup of value in DKIM signature */
392 static uschar * fn_recipients(void);
394 /* This table must be kept in alphabetical order. */
396 static var_entry var_table[] = {
397 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
398 they will be confused with user-creatable ACL variables. */
399 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
400 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
401 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
402 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
403 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
404 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
405 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
406 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
407 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
408 { "acl_narg", vtype_int, &acl_narg },
409 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
410 { "address_data", vtype_stringptr, &deliver_address_data },
411 { "address_file", vtype_stringptr, &address_file },
412 { "address_pipe", vtype_stringptr, &address_pipe },
413 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
414 { "authenticated_id", vtype_stringptr, &authenticated_id },
415 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
416 { "authentication_failed",vtype_int, &authentication_failed },
417 #ifdef WITH_CONTENT_SCAN
418 { "av_failed", vtype_int, &av_failed },
420 #ifdef EXPERIMENTAL_BRIGHTMAIL
421 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
422 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
423 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
424 { "bmi_deliver", vtype_int, &bmi_deliver },
426 { "body_linecount", vtype_int, &body_linecount },
427 { "body_zerocount", vtype_int, &body_zerocount },
428 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
429 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
430 { "caller_gid", vtype_gid, &real_gid },
431 { "caller_uid", vtype_uid, &real_uid },
432 { "compile_date", vtype_stringptr, &version_date },
433 { "compile_number", vtype_stringptr, &version_cnumber },
434 { "csa_status", vtype_stringptr, &csa_status },
435 #ifdef EXPERIMENTAL_DCC
436 { "dcc_header", vtype_stringptr, &dcc_header },
437 { "dcc_result", vtype_stringptr, &dcc_result },
439 #ifdef WITH_OLD_DEMIME
440 { "demime_errorlevel", vtype_int, &demime_errorlevel },
441 { "demime_reason", vtype_stringptr, &demime_reason },
444 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
445 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
446 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
447 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
448 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
449 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
450 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
451 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
452 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
453 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
454 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
455 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
456 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
457 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
458 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
459 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
460 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
461 { "dkim_signers", vtype_stringptr, &dkim_signers },
462 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
463 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
465 #ifdef EXPERIMENTAL_DMARC
466 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
467 { "dmarc_status", vtype_stringptr, &dmarc_status },
468 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
469 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
471 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
472 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
473 { "dnslist_text", vtype_stringptr, &dnslist_text },
474 { "dnslist_value", vtype_stringptr, &dnslist_value },
475 { "domain", vtype_stringptr, &deliver_domain },
476 { "domain_data", vtype_stringptr, &deliver_domain_data },
477 { "exim_gid", vtype_gid, &exim_gid },
478 { "exim_path", vtype_stringptr, &exim_path },
479 { "exim_uid", vtype_uid, &exim_uid },
480 #ifdef WITH_OLD_DEMIME
481 { "found_extension", vtype_stringptr, &found_extension },
483 { "headers_added", vtype_string_func, &fn_hdrs_added },
484 { "home", vtype_stringptr, &deliver_home },
485 { "host", vtype_stringptr, &deliver_host },
486 { "host_address", vtype_stringptr, &deliver_host_address },
487 { "host_data", vtype_stringptr, &host_data },
488 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
489 { "host_lookup_failed", vtype_int, &host_lookup_failed },
490 { "inode", vtype_ino, &deliver_inode },
491 { "interface_address", vtype_stringptr, &interface_address },
492 { "interface_port", vtype_int, &interface_port },
493 { "item", vtype_stringptr, &iterate_item },
495 { "ldap_dn", vtype_stringptr, &eldap_dn },
497 { "load_average", vtype_load_avg, NULL },
498 { "local_part", vtype_stringptr, &deliver_localpart },
499 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
500 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
501 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
502 { "local_scan_data", vtype_stringptr, &local_scan_data },
503 { "local_user_gid", vtype_gid, &local_user_gid },
504 { "local_user_uid", vtype_uid, &local_user_uid },
505 { "localhost_number", vtype_int, &host_number },
506 { "log_inodes", vtype_pinodes, (void *)FALSE },
507 { "log_space", vtype_pspace, (void *)FALSE },
508 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
509 #ifdef WITH_CONTENT_SCAN
510 { "malware_name", vtype_stringptr, &malware_name },
512 { "max_received_linelength", vtype_int, &max_received_linelength },
513 { "message_age", vtype_int, &message_age },
514 { "message_body", vtype_msgbody, &message_body },
515 { "message_body_end", vtype_msgbody_end, &message_body_end },
516 { "message_body_size", vtype_int, &message_body_size },
517 { "message_exim_id", vtype_stringptr, &message_id },
518 { "message_headers", vtype_msgheaders, NULL },
519 { "message_headers_raw", vtype_msgheaders_raw, NULL },
520 { "message_id", vtype_stringptr, &message_id },
521 { "message_linecount", vtype_int, &message_linecount },
522 { "message_size", vtype_int, &message_size },
523 #ifdef WITH_CONTENT_SCAN
524 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
525 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
526 { "mime_boundary", vtype_stringptr, &mime_boundary },
527 { "mime_charset", vtype_stringptr, &mime_charset },
528 { "mime_content_description", vtype_stringptr, &mime_content_description },
529 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
530 { "mime_content_id", vtype_stringptr, &mime_content_id },
531 { "mime_content_size", vtype_int, &mime_content_size },
532 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
533 { "mime_content_type", vtype_stringptr, &mime_content_type },
534 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
535 { "mime_filename", vtype_stringptr, &mime_filename },
536 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
537 { "mime_is_multipart", vtype_int, &mime_is_multipart },
538 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
539 { "mime_part_count", vtype_int, &mime_part_count },
541 { "n0", vtype_filter_int, &filter_n[0] },
542 { "n1", vtype_filter_int, &filter_n[1] },
543 { "n2", vtype_filter_int, &filter_n[2] },
544 { "n3", vtype_filter_int, &filter_n[3] },
545 { "n4", vtype_filter_int, &filter_n[4] },
546 { "n5", vtype_filter_int, &filter_n[5] },
547 { "n6", vtype_filter_int, &filter_n[6] },
548 { "n7", vtype_filter_int, &filter_n[7] },
549 { "n8", vtype_filter_int, &filter_n[8] },
550 { "n9", vtype_filter_int, &filter_n[9] },
551 { "original_domain", vtype_stringptr, &deliver_domain_orig },
552 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
553 { "originator_gid", vtype_gid, &originator_gid },
554 { "originator_uid", vtype_uid, &originator_uid },
555 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
556 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
557 { "pid", vtype_pid, NULL },
558 { "primary_hostname", vtype_stringptr, &primary_hostname },
559 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
560 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
561 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
562 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
563 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
564 { "rcpt_count", vtype_int, &rcpt_count },
565 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
566 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
567 { "received_count", vtype_int, &received_count },
568 { "received_for", vtype_stringptr, &received_for },
569 { "received_ip_address", vtype_stringptr, &interface_address },
570 { "received_port", vtype_int, &interface_port },
571 { "received_protocol", vtype_stringptr, &received_protocol },
572 { "received_time", vtype_int, &received_time },
573 { "recipient_data", vtype_stringptr, &recipient_data },
574 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
575 { "recipients", vtype_string_func, &fn_recipients },
576 { "recipients_count", vtype_int, &recipients_count },
577 #ifdef WITH_CONTENT_SCAN
578 { "regex_match_string", vtype_stringptr, ®ex_match_string },
580 { "reply_address", vtype_reply, NULL },
581 { "return_path", vtype_stringptr, &return_path },
582 { "return_size_limit", vtype_int, &bounce_return_size_limit },
583 { "router_name", vtype_stringptr, &router_name },
584 { "runrc", vtype_int, &runrc },
585 { "self_hostname", vtype_stringptr, &self_hostname },
586 { "sender_address", vtype_stringptr, &sender_address },
587 { "sender_address_data", vtype_stringptr, &sender_address_data },
588 { "sender_address_domain", vtype_domain, &sender_address },
589 { "sender_address_local_part", vtype_localpart, &sender_address },
590 { "sender_data", vtype_stringptr, &sender_data },
591 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
592 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
593 { "sender_host_address", vtype_stringptr, &sender_host_address },
594 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
595 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
596 { "sender_host_name", vtype_host_lookup, NULL },
597 { "sender_host_port", vtype_int, &sender_host_port },
598 { "sender_ident", vtype_stringptr, &sender_ident },
599 { "sender_rate", vtype_stringptr, &sender_rate },
600 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
601 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
602 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
603 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
604 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
605 { "sending_port", vtype_int, &sending_port },
606 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
607 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
608 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
609 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
610 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
611 { "sn0", vtype_filter_int, &filter_sn[0] },
612 { "sn1", vtype_filter_int, &filter_sn[1] },
613 { "sn2", vtype_filter_int, &filter_sn[2] },
614 { "sn3", vtype_filter_int, &filter_sn[3] },
615 { "sn4", vtype_filter_int, &filter_sn[4] },
616 { "sn5", vtype_filter_int, &filter_sn[5] },
617 { "sn6", vtype_filter_int, &filter_sn[6] },
618 { "sn7", vtype_filter_int, &filter_sn[7] },
619 { "sn8", vtype_filter_int, &filter_sn[8] },
620 { "sn9", vtype_filter_int, &filter_sn[9] },
621 #ifdef WITH_CONTENT_SCAN
622 { "spam_bar", vtype_stringptr, &spam_bar },
623 { "spam_report", vtype_stringptr, &spam_report },
624 { "spam_score", vtype_stringptr, &spam_score },
625 { "spam_score_int", vtype_stringptr, &spam_score_int },
627 #ifdef EXPERIMENTAL_SPF
628 { "spf_guess", vtype_stringptr, &spf_guess },
629 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
630 { "spf_received", vtype_stringptr, &spf_received },
631 { "spf_result", vtype_stringptr, &spf_result },
632 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
634 { "spool_directory", vtype_stringptr, &spool_directory },
635 { "spool_inodes", vtype_pinodes, (void *)TRUE },
636 { "spool_space", vtype_pspace, (void *)TRUE },
637 #ifdef EXPERIMENTAL_SRS
638 { "srs_db_address", vtype_stringptr, &srs_db_address },
639 { "srs_db_key", vtype_stringptr, &srs_db_key },
640 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
641 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
642 { "srs_recipient", vtype_stringptr, &srs_recipient },
643 { "srs_status", vtype_stringptr, &srs_status },
645 { "thisaddress", vtype_stringptr, &filter_thisaddress },
647 /* The non-(in,out) variables are now deprecated */
648 { "tls_bits", vtype_int, &tls_in.bits },
649 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
650 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
652 { "tls_in_bits", vtype_int, &tls_in.bits },
653 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
654 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
655 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
656 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
657 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
659 { "tls_out_bits", vtype_int, &tls_out.bits },
660 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
661 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
662 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
663 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
664 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
667 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
668 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
669 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
672 { "tod_bsdinbox", vtype_todbsdin, NULL },
673 { "tod_epoch", vtype_tode, NULL },
674 { "tod_epoch_l", vtype_todel, NULL },
675 { "tod_full", vtype_todf, NULL },
676 { "tod_log", vtype_todl, NULL },
677 { "tod_logfile", vtype_todlf, NULL },
678 { "tod_zone", vtype_todzone, NULL },
679 { "tod_zulu", vtype_todzulu, NULL },
680 #ifdef EXPERIMENTAL_TPDA
681 { "tpda_defer_errno", vtype_int, &tpda_defer_errno },
682 { "tpda_defer_errstr", vtype_stringptr, &tpda_defer_errstr },
683 { "tpda_delivery_confirmation", vtype_stringptr, &tpda_delivery_confirmation },
684 { "tpda_delivery_domain", vtype_stringptr, &tpda_delivery_domain },
685 { "tpda_delivery_fqdn", vtype_stringptr, &tpda_delivery_fqdn },
686 { "tpda_delivery_ip", vtype_stringptr, &tpda_delivery_ip },
687 { "tpda_delivery_local_part",vtype_stringptr,&tpda_delivery_local_part },
688 { "tpda_delivery_port", vtype_int, &tpda_delivery_port },
690 { "transport_name", vtype_stringptr, &transport_name },
691 { "value", vtype_stringptr, &lookup_value },
692 { "version_number", vtype_stringptr, &version_string },
693 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
694 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
695 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
696 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
697 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
698 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
701 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
702 static uschar var_buffer[256];
703 static BOOL malformed_header;
705 /* For textual hashes */
707 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
708 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
711 enum { HMAC_MD5, HMAC_SHA1 };
713 /* For numeric hashes */
715 static unsigned int prime[] = {
716 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
717 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
718 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
720 /* For printing modes in symbolic form */
722 static uschar *mtable_normal[] =
723 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
725 static uschar *mtable_setid[] =
726 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
728 static uschar *mtable_sticky[] =
729 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
733 /*************************************************
734 * Tables for UTF-8 support *
735 *************************************************/
737 /* Table of the number of extra characters, indexed by the first character
738 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
741 static uschar utf8_table1[] = {
742 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
743 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
744 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
745 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
747 /* These are the masks for the data bits in the first byte of a character,
748 indexed by the number of additional bytes. */
750 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
752 /* Get the next UTF-8 character, advancing the pointer. */
754 #define GETUTF8INC(c, ptr) \
756 if ((c & 0xc0) == 0xc0) \
758 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
760 c = (c & utf8_table2[a]) << s; \
764 c |= (*ptr++ & 0x3f) << s; \
769 /*************************************************
770 * Binary chop search on a table *
771 *************************************************/
773 /* This is used for matching expansion items and operators.
776 name the name that is being sought
777 table the table to search
778 table_size the number of items in the table
780 Returns: the offset in the table, or -1
784 chop_match(uschar *name, uschar **table, int table_size)
786 uschar **bot = table;
787 uschar **top = table + table_size;
791 uschar **mid = bot + (top - bot)/2;
792 int c = Ustrcmp(name, *mid);
793 if (c == 0) return mid - table;
794 if (c > 0) bot = mid + 1; else top = mid;
802 /*************************************************
803 * Check a condition string *
804 *************************************************/
806 /* This function is called to expand a string, and test the result for a "true"
807 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
808 forced fail or lookup defer.
810 We used to release all store used, but this is not not safe due
811 to ${dlfunc } and ${acl }. In any case expand_string_internal()
812 is reasonably careful to release what it can.
814 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
817 condition the condition string
818 m1 text to be incorporated in panic error
821 Returns: TRUE if condition is met, FALSE if not
825 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
828 uschar *ss = expand_string(condition);
831 if (!expand_string_forcedfail && !search_find_defer)
832 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
833 "for %s %s: %s", condition, m1, m2, expand_string_message);
836 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
837 strcmpic(ss, US"false") != 0;
844 /*************************************************
845 * Pseudo-random number generation *
846 *************************************************/
848 /* Pseudo-random number generation. The result is not "expected" to be
849 cryptographically strong but not so weak that someone will shoot themselves
850 in the foot using it as a nonce in some email header scheme or whatever
851 weirdness they'll twist this into. The result should ideally handle fork().
853 However, if we're stuck unable to provide this, then we'll fall back to
854 appallingly bad randomness.
856 If SUPPORT_TLS is defined then this will not be used except as an emergency
861 Returns a random number in range [0, max-1]
865 # define vaguely_random_number vaguely_random_number_fallback
868 vaguely_random_number(int max)
871 # undef vaguely_random_number
873 static pid_t pid = 0;
875 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
885 #ifdef HAVE_ARC4RANDOM
886 /* cryptographically strong randomness, common on *BSD platforms, not
887 so much elsewhere. Alas. */
889 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
890 #ifdef HAVE_SRANDOMDEV
891 /* uses random(4) for seeding */
894 gettimeofday(&tv, NULL);
895 srandom(tv.tv_sec | tv.tv_usec | getpid());
898 /* Poor randomness and no seeding here */
905 #ifdef HAVE_ARC4RANDOM
906 return arc4random() % max;
907 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
908 return random() % max;
910 /* This one returns a 16-bit number, definitely not crypto-strong */
911 return random_number(max);
918 /*************************************************
919 * Pick out a name from a string *
920 *************************************************/
922 /* If the name is too long, it is silently truncated.
925 name points to a buffer into which to put the name
926 max is the length of the buffer
927 s points to the first alphabetic character of the name
928 extras chars other than alphanumerics to permit
930 Returns: pointer to the first character after the name
932 Note: The test for *s != 0 in the while loop is necessary because
933 Ustrchr() yields non-NULL if the character is zero (which is not something
937 read_name(uschar *name, int max, uschar *s, uschar *extras)
940 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
942 if (ptr < max-1) name[ptr++] = *s;
951 /*************************************************
952 * Pick out the rest of a header name *
953 *************************************************/
955 /* A variable name starting $header_ (or just $h_ for those who like
956 abbreviations) might not be the complete header name because headers can
957 contain any printing characters in their names, except ':'. This function is
958 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
959 on the end, if the name was terminated by white space.
962 name points to a buffer in which the name read so far exists
963 max is the length of the buffer
964 s points to the first character after the name so far, i.e. the
965 first non-alphameric character after $header_xxxxx
967 Returns: a pointer to the first character after the header name
971 read_header_name(uschar *name, int max, uschar *s)
973 int prelen = Ustrchr(name, '_') - name + 1;
974 int ptr = Ustrlen(name) - prelen;
975 if (ptr > 0) memmove(name, name+prelen, ptr);
976 while (mac_isgraph(*s) && *s != ':')
978 if (ptr < max-1) name[ptr++] = *s;
989 /*************************************************
990 * Pick out a number from a string *
991 *************************************************/
994 n points to an integer into which to put the number
995 s points to the first digit of the number
997 Returns: a pointer to the character after the last digit
1001 read_number(int *n, uschar *s)
1004 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1010 /*************************************************
1011 * Extract keyed subfield from a string *
1012 *************************************************/
1014 /* The yield is in dynamic store; NULL means that the key was not found.
1017 key points to the name of the key
1018 s points to the string from which to extract the subfield
1020 Returns: NULL if the subfield was not found, or
1021 a pointer to the subfield's data
1025 expand_getkeyed(uschar *key, uschar *s)
1027 int length = Ustrlen(key);
1028 while (isspace(*s)) s++;
1030 /* Loop to search for the key */
1038 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1039 dkeylength = s - dkey;
1040 while (isspace(*s)) s++;
1041 if (*s == '=') while (isspace((*(++s))));
1043 data = string_dequote(&s);
1044 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1047 while (isspace(*s)) s++;
1056 /*************************************************
1057 * Extract numbered subfield from string *
1058 *************************************************/
1060 /* Extracts a numbered field from a string that is divided by tokens - for
1061 example a line from /etc/passwd is divided by colon characters. First field is
1062 numbered one. Negative arguments count from the right. Zero returns the whole
1063 string. Returns NULL if there are insufficient tokens in the string
1066 Modifies final argument - this is a dynamically generated string, so that's OK.
1069 field number of field to be extracted,
1070 first field = 1, whole string = 0, last field = -1
1071 separators characters that are used to break string into tokens
1072 s points to the string from which to extract the subfield
1074 Returns: NULL if the field was not found,
1075 a pointer to the field's data inside s (modified to add 0)
1079 expand_gettokened (int field, uschar *separators, uschar *s)
1084 uschar *fieldtext = NULL;
1086 if (field == 0) return s;
1088 /* Break the line up into fields in place; for field > 0 we stop when we have
1089 done the number of fields we want. For field < 0 we continue till the end of
1090 the string, counting the number of fields. */
1092 count = (field > 0)? field : INT_MAX;
1098 /* Previous field was the last one in the string. For a positive field
1099 number, this means there are not enough fields. For a negative field number,
1100 check that there are enough, and scan back to find the one that is wanted. */
1104 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1105 if ((-field) == (INT_MAX - count - 1)) return s;
1109 while (ss[-1] != 0) ss--;
1115 /* Previous field was not last in the string; save its start and put a
1119 len = Ustrcspn(ss, separators);
1130 /*************************************************
1131 * Extract a substring from a string *
1132 *************************************************/
1134 /* Perform the ${substr or ${length expansion operations.
1137 subject the input string
1138 value1 the offset from the start of the input string to the start of
1139 the output string; if negative, count from the right.
1140 value2 the length of the output string, or negative (-1) for unset
1141 if value1 is positive, unset means "all after"
1142 if value1 is negative, unset means "all before"
1143 len set to the length of the returned string
1145 Returns: pointer to the output string, or NULL if there is an error
1149 extract_substr(uschar *subject, int value1, int value2, int *len)
1151 int sublen = Ustrlen(subject);
1153 if (value1 < 0) /* count from right */
1157 /* If the position is before the start, skip to the start, and adjust the
1158 length. If the length ends up negative, the substring is null because nothing
1159 can precede. This falls out naturally when the length is unset, meaning "all
1165 if (value2 < 0) value2 = 0;
1169 /* Otherwise an unset length => characters before value1 */
1171 else if (value2 < 0)
1178 /* For a non-negative offset, if the starting position is past the end of the
1179 string, the result will be the null string. Otherwise, an unset length means
1180 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1184 if (value1 > sublen)
1189 else if (value2 < 0) value2 = sublen;
1192 /* Cut the length down to the maximum possible for the offset value, and get
1193 the required characters. */
1195 if (value1 + value2 > sublen) value2 = sublen - value1;
1197 return subject + value1;
1203 /*************************************************
1204 * Old-style hash of a string *
1205 *************************************************/
1207 /* Perform the ${hash expansion operation.
1210 subject the input string (an expanded substring)
1211 value1 the length of the output string; if greater or equal to the
1212 length of the input string, the input string is returned
1213 value2 the number of hash characters to use, or 26 if negative
1214 len set to the length of the returned string
1216 Returns: pointer to the output string, or NULL if there is an error
1220 compute_hash(uschar *subject, int value1, int value2, int *len)
1222 int sublen = Ustrlen(subject);
1224 if (value2 < 0) value2 = 26;
1225 else if (value2 > Ustrlen(hashcodes))
1227 expand_string_message =
1228 string_sprintf("hash count \"%d\" too big", value2);
1232 /* Calculate the hash text. We know it is shorter than the original string, so
1233 can safely place it in subject[] (we know that subject is always itself an
1234 expanded substring). */
1236 if (value1 < sublen)
1241 while ((c = (subject[j])) != 0)
1243 int shift = (c + j++) & 7;
1244 subject[i] ^= (c << shift) | (c >> (8-shift));
1245 if (++i >= value1) i = 0;
1247 for (i = 0; i < value1; i++)
1248 subject[i] = hashcodes[(subject[i]) % value2];
1250 else value1 = sublen;
1259 /*************************************************
1260 * Numeric hash of a string *
1261 *************************************************/
1263 /* Perform the ${nhash expansion operation. The first characters of the
1264 string are treated as most important, and get the highest prime numbers.
1267 subject the input string
1268 value1 the maximum value of the first part of the result
1269 value2 the maximum value of the second part of the result,
1270 or negative to produce only a one-part result
1271 len set to the length of the returned string
1273 Returns: pointer to the output string, or NULL if there is an error.
1277 compute_nhash (uschar *subject, int value1, int value2, int *len)
1279 uschar *s = subject;
1281 unsigned long int total = 0; /* no overflow */
1285 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1286 total += prime[i--] * (unsigned int)(*s++);
1289 /* If value2 is unset, just compute one number */
1293 s = string_sprintf("%d", total % value1);
1296 /* Otherwise do a div/mod hash */
1300 total = total % (value1 * value2);
1301 s = string_sprintf("%d/%d", total/value2, total % value2);
1312 /*************************************************
1313 * Find the value of a header or headers *
1314 *************************************************/
1316 /* Multiple instances of the same header get concatenated, and this function
1317 can also return a concatenation of all the header lines. When concatenating
1318 specific headers that contain lists of addresses, a comma is inserted between
1319 them. Otherwise we use a straight concatenation. Because some messages can have
1320 pathologically large number of lines, there is a limit on the length that is
1321 returned. Also, to avoid massive store use which would result from using
1322 string_cat() as it copies and extends strings, we do a preliminary pass to find
1323 out exactly how much store will be needed. On "normal" messages this will be
1327 name the name of the header, without the leading $header_ or $h_,
1328 or NULL if a concatenation of all headers is required
1329 exists_only TRUE if called from a def: test; don't need to build a string;
1330 just return a string that is not "" and not "0" if the header
1332 newsize return the size of memory block that was obtained; may be NULL
1333 if exists_only is TRUE
1334 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1335 other than concatenating, will be done on the header. Also used
1336 for $message_headers_raw.
1337 charset name of charset to translate MIME words to; used only if
1338 want_raw is false; if NULL, no translation is done (this is
1339 used for $bh_ and $bheader_)
1341 Returns: NULL if the header does not exist, else a pointer to a new
1346 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1349 BOOL found = name == NULL;
1351 int len = found? 0 : Ustrlen(name);
1353 uschar *yield = NULL;
1356 /* Loop for two passes - saves code repetition */
1358 for (i = 0; i < 2; i++)
1363 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1365 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1367 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1372 if (exists_only) return US"1"; /* don't need actual string */
1374 t = h->text + len; /* text to insert */
1375 if (!want_raw) /* unless wanted raw, */
1376 while (isspace(*t)) t++; /* remove leading white space */
1377 ilen = h->slen - (t - h->text); /* length to insert */
1379 /* Unless wanted raw, remove trailing whitespace, including the
1383 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1385 /* Set comma = 1 if handling a single header and it's one of those
1386 that contains an address list, except when asked for raw headers. Only
1387 need to do this once. */
1389 if (!want_raw && name != NULL && comma == 0 &&
1390 Ustrchr("BCFRST", h->type) != NULL)
1393 /* First pass - compute total store needed; second pass - compute
1394 total store used, including this header. */
1396 size += ilen + comma + 1; /* +1 for the newline */
1398 /* Second pass - concatentate the data, up to a maximum. Note that
1399 the loop stops when size hits the limit. */
1403 if (size > header_insert_maxlen)
1405 ilen -= size - header_insert_maxlen - 1;
1408 Ustrncpy(ptr, t, ilen);
1411 /* For a non-raw header, put in the comma if needed, then add
1412 back the newline we removed above, provided there was some text in
1415 if (!want_raw && ilen > 0)
1417 if (comma != 0) *ptr++ = ',';
1425 /* At end of first pass, return NULL if no header found. Then truncate size
1426 if necessary, and get the buffer to hold the data, returning the buffer size.
1431 if (!found) return NULL;
1432 if (size > header_insert_maxlen) size = header_insert_maxlen;
1433 *newsize = size + 1;
1434 ptr = yield = store_get(*newsize);
1438 /* That's all we do for raw header expansion. */
1445 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1446 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1447 function can return an error with decoded data if the charset translation
1448 fails. If decoding fails, it returns NULL. */
1452 uschar *decoded, *error;
1453 if (ptr > yield && ptr[-1] == '\n') ptr--;
1454 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1456 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1460 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1461 " input was: %s\n", error, yield);
1463 if (decoded != NULL) yield = decoded;
1472 /*************************************************
1473 * Return list of recipients *
1474 *************************************************/
1475 /* A recipients list is available only during system message filtering,
1476 during ACL processing after DATA, and while expanding pipe commands
1477 generated from a system filter, but not elsewhere. */
1482 if (!enable_dollar_recipients) return NULL; else
1487 uschar * s = store_get(size);
1488 for (i = 0; i < recipients_count; i++)
1490 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1491 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1492 Ustrlen(recipients_list[i].address));
1494 s[ptr] = 0; /* string_cat() leaves room */
1500 /*************************************************
1501 * Find value of a variable *
1502 *************************************************/
1504 /* The table of variables is kept in alphabetic order, so we can search it
1505 using a binary chop. The "choplen" variable is nothing to do with the binary
1509 name the name of the variable being sought
1510 exists_only TRUE if this is a def: test; passed on to find_header()
1511 skipping TRUE => skip any processing evaluation; this is not the same as
1512 exists_only because def: may test for values that are first
1514 newsize pointer to an int which is initially zero; if the answer is in
1515 a new memory buffer, *newsize is set to its size
1517 Returns: NULL if the variable does not exist, or
1518 a pointer to the variable's contents, or
1519 something non-NULL if exists_only is TRUE
1523 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1526 int last = var_table_size;
1528 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1529 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1530 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1531 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1532 (this gave backwards compatibility at the changeover). There may be built-in
1533 variables whose names start acl_ but they should never start in this way. This
1534 slightly messy specification is a consequence of the history, needless to say.
1536 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1537 set, in which case give an error. */
1539 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1543 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1544 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1547 /* Handle $auth<n> variables. */
1549 if (Ustrncmp(name, "auth", 4) == 0)
1552 int n = Ustrtoul(name + 4, &endptr, 10);
1553 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1554 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1557 /* For all other variables, search the table */
1559 while (last > first)
1563 int middle = (first + last)/2;
1564 int c = Ustrcmp(name, var_table[middle].name);
1566 if (c > 0) { first = middle + 1; continue; }
1567 if (c < 0) { last = middle; continue; }
1569 /* Found an existing variable. If in skipping state, the value isn't needed,
1570 and we want to avoid processing (such as looking up the host name). */
1572 if (skipping) return US"";
1574 switch (var_table[middle].type)
1576 case vtype_filter_int:
1577 if (!filter_running) return NULL;
1581 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1585 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1589 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1593 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1597 sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1600 case vtype_stringptr: /* Pointer to string */
1601 s = *((uschar **)(var_table[middle].value));
1602 return (s == NULL)? US"" : s;
1605 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1608 case vtype_load_avg:
1609 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1612 case vtype_host_lookup: /* Lookup if not done so */
1613 if (sender_host_name == NULL && sender_host_address != NULL &&
1614 !host_lookup_failed && host_name_lookup() == OK)
1615 host_build_sender_fullhost();
1616 return (sender_host_name == NULL)? US"" : sender_host_name;
1618 case vtype_localpart: /* Get local part from address */
1619 s = *((uschar **)(var_table[middle].value));
1620 if (s == NULL) return US"";
1621 domain = Ustrrchr(s, '@');
1622 if (domain == NULL) return s;
1623 if (domain - s > sizeof(var_buffer) - 1)
1624 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1625 " in string expansion", sizeof(var_buffer));
1626 Ustrncpy(var_buffer, s, domain - s);
1627 var_buffer[domain - s] = 0;
1630 case vtype_domain: /* Get domain from address */
1631 s = *((uschar **)(var_table[middle].value));
1632 if (s == NULL) return US"";
1633 domain = Ustrrchr(s, '@');
1634 return (domain == NULL)? US"" : domain + 1;
1636 case vtype_msgheaders:
1637 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1639 case vtype_msgheaders_raw:
1640 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1642 case vtype_msgbody: /* Pointer to msgbody string */
1643 case vtype_msgbody_end: /* Ditto, the end of the msg */
1644 ss = (uschar **)(var_table[middle].value);
1645 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1648 off_t start_offset = SPOOL_DATA_START_OFFSET;
1649 int len = message_body_visible;
1650 if (len > message_size) len = message_size;
1651 *ss = body = store_malloc(len+1);
1653 if (var_table[middle].type == vtype_msgbody_end)
1655 struct stat statbuf;
1656 if (fstat(deliver_datafile, &statbuf) == 0)
1658 start_offset = statbuf.st_size - len;
1659 if (start_offset < SPOOL_DATA_START_OFFSET)
1660 start_offset = SPOOL_DATA_START_OFFSET;
1663 lseek(deliver_datafile, start_offset, SEEK_SET);
1664 len = read(deliver_datafile, body, len);
1668 if (message_body_newlines) /* Separate loops for efficiency */
1671 { if (body[--len] == 0) body[len] = ' '; }
1676 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1680 return (*ss == NULL)? US"" : *ss;
1682 case vtype_todbsdin: /* BSD inbox time of day */
1683 return tod_stamp(tod_bsdin);
1685 case vtype_tode: /* Unix epoch time of day */
1686 return tod_stamp(tod_epoch);
1688 case vtype_todel: /* Unix epoch/usec time of day */
1689 return tod_stamp(tod_epoch_l);
1691 case vtype_todf: /* Full time of day */
1692 return tod_stamp(tod_full);
1694 case vtype_todl: /* Log format time of day */
1695 return tod_stamp(tod_log_bare); /* (without timezone) */
1697 case vtype_todzone: /* Time zone offset only */
1698 return tod_stamp(tod_zone);
1700 case vtype_todzulu: /* Zulu time */
1701 return tod_stamp(tod_zulu);
1703 case vtype_todlf: /* Log file datestamp tod */
1704 return tod_stamp(tod_log_datestamp_daily);
1706 case vtype_reply: /* Get reply address */
1707 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1709 if (s != NULL) while (isspace(*s)) s++;
1710 if (s == NULL || *s == 0)
1712 *newsize = 0; /* For the *s==0 case */
1713 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1718 while (isspace(*s)) s++;
1719 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1720 while (t > s && isspace(t[-1])) t--;
1723 return (s == NULL)? US"" : s;
1725 case vtype_string_func:
1727 uschar * (*fn)() = var_table[middle].value;
1734 sprintf(CS var_buffer, "%d",
1735 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1742 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1743 sprintf(CS var_buffer, "%d", inodes);
1747 #ifndef DISABLE_DKIM
1749 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1755 return NULL; /* Unknown variable name */
1762 modify_variable(uschar *name, void * value)
1765 int last = var_table_size;
1767 while (last > first)
1769 int middle = (first + last)/2;
1770 int c = Ustrcmp(name, var_table[middle].name);
1772 if (c > 0) { first = middle + 1; continue; }
1773 if (c < 0) { last = middle; continue; }
1775 /* Found an existing variable; change the item it refers to */
1776 var_table[middle].value = value;
1779 return; /* Unknown variable name, fail silently */
1786 /*************************************************
1787 * Read and expand substrings *
1788 *************************************************/
1790 /* This function is called to read and expand argument substrings for various
1791 expansion items. Some have a minimum requirement that is less than the maximum;
1792 in these cases, the first non-present one is set to NULL.
1795 sub points to vector of pointers to set
1796 n maximum number of substrings
1798 sptr points to current string pointer
1799 skipping the skipping flag
1800 check_end if TRUE, check for final '}'
1801 name name of item, for error message
1802 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1805 Returns: 0 OK; string pointer updated
1806 1 curly bracketing error (too few arguments)
1807 2 too many arguments (only if check_end is set); message set
1808 3 other error (expansion failure)
1812 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1813 BOOL check_end, uschar *name, BOOL *resetok)
1818 while (isspace(*s)) s++;
1819 for (i = 0; i < n; i++)
1823 if (i < m) return 1;
1827 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1828 if (sub[i] == NULL) return 3;
1829 if (*s++ != '}') return 1;
1830 while (isspace(*s)) s++;
1832 if (check_end && *s++ != '}')
1836 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1837 "(max is %d)", name, n);
1850 /*************************************************
1851 * Elaborate message for bad variable *
1852 *************************************************/
1854 /* For the "unknown variable" message, take a look at the variable's name, and
1855 give additional information about possible ACL variables. The extra information
1856 is added on to expand_string_message.
1858 Argument: the name of the variable
1863 check_variable_error_message(uschar *name)
1865 if (Ustrncmp(name, "acl_", 4) == 0)
1866 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1867 (name[4] == 'c' || name[4] == 'm')?
1869 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1870 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1872 US"user-defined ACL variables must start acl_c or acl_m");
1878 Load args from sub array to globals, and call acl_check().
1879 Sub array will be corrupted on return.
1881 Returns: OK access is granted by an ACCEPT verb
1882 DISCARD access is granted by a DISCARD verb
1883 FAIL access is denied
1884 FAIL_DROP access is denied; drop the connection
1885 DEFER can't tell at the moment
1889 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
1893 int sav_narg = acl_narg;
1895 extern int acl_where;
1897 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
1898 for (i = 0; i < nsub && sub[i+1]; i++)
1901 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
1902 sub[i+1] = tmp; /* stash the old args using our caller's storage */
1907 sub[i+1] = acl_arg[i];
1908 acl_arg[i++] = NULL;
1912 debug_printf("expanding: acl: %s arg: %s%s\n",
1914 acl_narg>0 ? acl_arg[0] : US"<none>",
1915 acl_narg>1 ? " +more" : "");
1917 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
1919 for (i = 0; i < nsub; i++)
1920 acl_arg[i] = sub[i+1]; /* restore old args */
1921 acl_narg = sav_narg;
1929 /*************************************************
1930 * Read and evaluate a condition *
1931 *************************************************/
1935 s points to the start of the condition text
1936 resetok points to a BOOL which is written false if it is unsafe to
1937 free memory. Certain condition types (acl) may have side-effect
1938 allocation which must be preserved.
1939 yield points to a BOOL to hold the result of the condition test;
1940 if NULL, we are just reading through a condition that is
1941 part of an "or" combination to check syntax, or in a state
1942 where the answer isn't required
1944 Returns: a pointer to the first character after the condition, or
1949 eval_condition(uschar *s, BOOL *resetok, BOOL *yield)
1951 BOOL testfor = TRUE;
1952 BOOL tempcond, combined_cond;
1954 BOOL sub2_honour_dollar = TRUE;
1955 int i, rc, cond_type, roffset;
1956 int_eximarith_t num[2];
1957 struct stat statbuf;
1962 const uschar *rerror;
1966 while (isspace(*s)) s++;
1967 if (*s == '!') { testfor = !testfor; s++; } else break;
1970 /* Numeric comparisons are symbolic */
1972 if (*s == '=' || *s == '>' || *s == '<')
1984 /* All other conditions are named */
1986 else s = read_name(name, 256, s, US"_");
1988 /* If we haven't read a name, it means some non-alpha character is first. */
1992 expand_string_message = string_sprintf("condition name expected, "
1993 "but found \"%.16s\"", s);
1997 /* Find which condition we are dealing with, and switch on it */
1999 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
2002 /* def: tests for a non-empty variable, or for the existence of a header. If
2003 yield == NULL we are in a skipping state, and don't care about the answer. */
2008 expand_string_message = US"\":\" expected after \"def\"";
2012 s = read_name(name, 256, s+1, US"_");
2014 /* Test for a header's existence. If the name contains a closing brace
2015 character, this may be a user error where the terminating colon has been
2016 omitted. Set a flag to adjust a subsequent error message in this case. */
2018 if (Ustrncmp(name, "h_", 2) == 0 ||
2019 Ustrncmp(name, "rh_", 3) == 0 ||
2020 Ustrncmp(name, "bh_", 3) == 0 ||
2021 Ustrncmp(name, "header_", 7) == 0 ||
2022 Ustrncmp(name, "rheader_", 8) == 0 ||
2023 Ustrncmp(name, "bheader_", 8) == 0)
2025 s = read_header_name(name, 256, s);
2026 /* {-for-text-editors */
2027 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2028 if (yield != NULL) *yield =
2029 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2032 /* Test for a variable's having a non-empty value. A non-existent variable
2033 causes an expansion failure. */
2037 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2040 expand_string_message = (name[0] == 0)?
2041 string_sprintf("variable name omitted after \"def:\"") :
2042 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2043 check_variable_error_message(name);
2046 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2052 /* first_delivery tests for first delivery attempt */
2054 case ECOND_FIRST_DELIVERY:
2055 if (yield != NULL) *yield = deliver_firsttime == testfor;
2059 /* queue_running tests for any process started by a queue runner */
2061 case ECOND_QUEUE_RUNNING:
2062 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2066 /* exists: tests for file existence
2067 isip: tests for any IP address
2068 isip4: tests for an IPv4 address
2069 isip6: tests for an IPv6 address
2070 pam: does PAM authentication
2071 radius: does RADIUS authentication
2072 ldapauth: does LDAP authentication
2073 pwcheck: does Cyrus SASL pwcheck authentication
2082 case ECOND_LDAPAUTH:
2085 while (isspace(*s)) s++;
2086 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2088 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2089 if (sub[0] == NULL) return NULL;
2090 /* {-for-text-editors */
2091 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2093 if (yield == NULL) return s; /* No need to run the test if skipping */
2098 if ((expand_forbid & RDO_EXISTS) != 0)
2100 expand_string_message = US"File existence tests are not permitted";
2103 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2109 rc = string_is_ip_address(sub[0], NULL);
2110 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2111 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2114 /* Various authentication tests - all optionally compiled */
2118 rc = auth_call_pam(sub[0], &expand_string_message);
2121 goto COND_FAILED_NOT_COMPILED;
2122 #endif /* SUPPORT_PAM */
2125 #ifdef RADIUS_CONFIG_FILE
2126 rc = auth_call_radius(sub[0], &expand_string_message);
2129 goto COND_FAILED_NOT_COMPILED;
2130 #endif /* RADIUS_CONFIG_FILE */
2132 case ECOND_LDAPAUTH:
2135 /* Just to keep the interface the same */
2137 int old_pool = store_pool;
2138 store_pool = POOL_SEARCH;
2139 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2140 &expand_string_message, &do_cache);
2141 store_pool = old_pool;
2145 goto COND_FAILED_NOT_COMPILED;
2146 #endif /* LOOKUP_LDAP */
2149 #ifdef CYRUS_PWCHECK_SOCKET
2150 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2153 goto COND_FAILED_NOT_COMPILED;
2154 #endif /* CYRUS_PWCHECK_SOCKET */
2156 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2157 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2159 if (rc == ERROR || rc == DEFER) return NULL;
2160 *yield = (rc == OK) == testfor;
2166 /* call ACL (in a conditional context). Accept true, deny false.
2167 Defer is a forced-fail. Anything set by message= goes to $value.
2168 Up to ten parameters are used; we use the braces round the name+args
2169 like the saslauthd condition does, to permit a variable number of args.
2170 See also the expansion-item version EITEM_ACL and the traditional
2171 acl modifier ACLC_ACL.
2172 Since the ACL may allocate new global variables, tell our caller to not
2177 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2184 while (isspace(*s)) s++;
2185 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2187 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2188 &s, yield == NULL, TRUE, US"acl", resetok))
2190 case 1: expand_string_message = US"too few arguments or bracketing "
2193 case 3: return NULL;
2197 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2202 lookup_value = NULL;
2205 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2206 lookup_value[ptr] = '\0';
2208 *yield = cond == testfor;
2212 expand_string_forcedfail = TRUE;
2214 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2221 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2223 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2225 However, the last two are optional. That is why the whole set is enclosed
2226 in their own set of braces. */
2228 case ECOND_SASLAUTHD:
2229 #ifndef CYRUS_SASLAUTHD_SOCKET
2230 goto COND_FAILED_NOT_COMPILED;
2232 while (isspace(*s)) s++;
2233 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2234 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd", resetok))
2236 case 1: expand_string_message = US"too few arguments or bracketing "
2237 "error for saslauthd";
2239 case 3: return NULL;
2241 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2245 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2246 &expand_string_message);
2247 if (rc == ERROR || rc == DEFER) return NULL;
2248 *yield = (rc == OK) == testfor;
2251 #endif /* CYRUS_SASLAUTHD_SOCKET */
2254 /* symbolic operators for numeric and string comparison, and a number of
2255 other operators, all requiring two arguments.
2257 crypteq: encrypts plaintext and compares against an encrypted text,
2258 using crypt(), crypt16(), MD5 or SHA-1
2259 inlist/inlisti: checks if first argument is in the list of the second
2260 match: does a regular expression match and sets up the numerical
2261 variables if it succeeds
2262 match_address: matches in an address list
2263 match_domain: matches in a domain list
2264 match_ip: matches a host list that is restricted to IP addresses
2265 match_local_part: matches in a local part list
2268 case ECOND_MATCH_ADDRESS:
2269 case ECOND_MATCH_DOMAIN:
2270 case ECOND_MATCH_IP:
2271 case ECOND_MATCH_LOCAL_PART:
2272 #ifndef EXPAND_LISTMATCH_RHS
2273 sub2_honour_dollar = FALSE;
2282 case ECOND_NUM_L: /* Numerical comparisons */
2289 case ECOND_STR_LT: /* String comparisons */
2300 for (i = 0; i < 2; i++)
2302 /* Sometimes, we don't expand substrings; too many insecure configurations
2303 created using match_address{}{} and friends, where the second param
2304 includes information from untrustworthy sources. */
2305 BOOL honour_dollar = TRUE;
2306 if ((i > 0) && !sub2_honour_dollar)
2307 honour_dollar = FALSE;
2309 while (isspace(*s)) s++;
2312 if (i == 0) goto COND_FAILED_CURLY_START;
2313 expand_string_message = string_sprintf("missing 2nd string in {} "
2314 "after \"%s\"", name);
2317 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2318 honour_dollar, resetok);
2319 if (sub[i] == NULL) return NULL;
2320 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2322 /* Convert to numerical if required; we know that the names of all the
2323 conditions that compare numbers do not start with a letter. This just saves
2324 checking for them individually. */
2326 if (!isalpha(name[0]) && yield != NULL)
2332 debug_printf("empty string cast to zero for numerical comparison\n");
2336 num[i] = expand_string_integer(sub[i], FALSE);
2337 if (expand_string_message != NULL) return NULL;
2342 /* Result not required */
2344 if (yield == NULL) return s;
2346 /* Do an appropriate comparison */
2352 tempcond = (num[0] == num[1]);
2356 tempcond = (num[0] > num[1]);
2360 tempcond = (num[0] >= num[1]);
2364 tempcond = (num[0] < num[1]);
2368 tempcond = (num[0] <= num[1]);
2372 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2376 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2380 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2384 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2388 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2392 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2396 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2400 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2404 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2408 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2411 case ECOND_MATCH: /* Regular expression match */
2412 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2416 expand_string_message = string_sprintf("regular expression error in "
2417 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2420 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2423 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2424 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2425 goto MATCHED_SOMETHING;
2427 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2428 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2429 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2430 goto MATCHED_SOMETHING;
2432 case ECOND_MATCH_IP: /* Match IP address in a host list */
2433 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2435 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2441 unsigned int *nullcache = NULL;
2442 check_host_block cb;
2444 cb.host_name = US"";
2445 cb.host_address = sub[0];
2447 /* If the host address starts off ::ffff: it is an IPv6 address in
2448 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2451 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2452 cb.host_address + 7 : cb.host_address;
2454 rc = match_check_list(
2455 &sub[1], /* the list */
2456 0, /* separator character */
2457 &hostlist_anchor, /* anchor pointer */
2458 &nullcache, /* cache pointer */
2459 check_host, /* function for testing */
2460 &cb, /* argument for function */
2461 MCL_HOST, /* type of check */
2462 sub[0], /* text for debugging */
2463 NULL); /* where to pass back data */
2465 goto MATCHED_SOMETHING;
2467 case ECOND_MATCH_LOCAL_PART:
2468 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2469 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2484 expand_string_message = string_sprintf("unable to complete match "
2485 "against \"%s\": %s", sub[1], search_error_message);
2491 /* Various "encrypted" comparisons. If the second string starts with
2492 "{" then an encryption type is given. Default to crypt() or crypt16()
2493 (build-time choice). */
2494 /* }-for-text-editors */
2497 #ifndef SUPPORT_CRYPTEQ
2498 goto COND_FAILED_NOT_COMPILED;
2500 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2502 int sublen = Ustrlen(sub[1]+5);
2507 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2509 /* If the length that we are comparing against is 24, the MD5 digest
2510 is expressed as a base64 string. This is the way LDAP does it. However,
2511 some other software uses a straightforward hex representation. We assume
2512 this if the length is 32. Other lengths fail. */
2516 uschar *coded = auth_b64encode((uschar *)digest, 16);
2517 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2518 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2519 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2521 else if (sublen == 32)
2525 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2527 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2528 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2529 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2533 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2534 "fail\n crypted=%s\n", sub[1]+5);
2539 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2541 int sublen = Ustrlen(sub[1]+6);
2546 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2548 /* If the length that we are comparing against is 28, assume the SHA1
2549 digest is expressed as a base64 string. If the length is 40, assume a
2550 straightforward hex representation. Other lengths fail. */
2554 uschar *coded = auth_b64encode((uschar *)digest, 20);
2555 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2556 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2557 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2559 else if (sublen == 40)
2563 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2565 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2566 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2567 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2571 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2572 "fail\n crypted=%s\n", sub[1]+6);
2577 else /* {crypt} or {crypt16} and non-{ at start */
2578 /* }-for-text-editors */
2583 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2588 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2593 else if (sub[1][0] == '{') /* }-for-text-editors */
2595 expand_string_message = string_sprintf("unknown encryption mechanism "
2596 "in \"%s\"", sub[1]);
2602 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2603 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2604 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2608 #define XSTR(s) STR(s)
2609 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2610 " subject=%s\n crypted=%s\n",
2611 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2616 /* If the encrypted string contains fewer than two characters (for the
2617 salt), force failure. Otherwise we get false positives: with an empty
2618 string the yield of crypt() is an empty string! */
2620 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2621 (Ustrcmp(coded, sub[1]) == 0);
2624 #endif /* SUPPORT_CRYPTEQ */
2630 uschar *save_iterate_item = iterate_item;
2631 int (*compare)(const uschar *, const uschar *);
2634 if (cond_type == ECOND_INLISTI)
2637 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2639 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2640 if (compare(sub[0], iterate_item) == 0)
2645 iterate_item = save_iterate_item;
2648 } /* Switch for comparison conditions */
2650 *yield = tempcond == testfor;
2651 return s; /* End of comparison conditions */
2654 /* and/or: computes logical and/or of several conditions */
2658 subcondptr = (yield == NULL)? NULL : &tempcond;
2659 combined_cond = (cond_type == ECOND_AND);
2661 while (isspace(*s)) s++;
2662 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2666 while (isspace(*s)) s++;
2667 /* {-for-text-editors */
2668 if (*s == '}') break;
2669 if (*s != '{') /* }-for-text-editors */
2671 expand_string_message = string_sprintf("each subcondition "
2672 "inside an \"%s{...}\" condition must be in its own {}", name);
2676 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2678 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2679 expand_string_message, name);
2682 while (isspace(*s)) s++;
2684 /* {-for-text-editors */
2687 /* {-for-text-editors */
2688 expand_string_message = string_sprintf("missing } at end of condition "
2689 "inside \"%s\" group", name);
2695 if (cond_type == ECOND_AND)
2697 combined_cond &= tempcond;
2698 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2699 } /* evaluate any more */
2702 combined_cond |= tempcond;
2703 if (combined_cond) subcondptr = NULL; /* once true, don't */
2704 } /* evaluate any more */
2708 if (yield != NULL) *yield = (combined_cond == testfor);
2712 /* forall/forany: iterates a condition with different values */
2718 uschar *save_iterate_item = iterate_item;
2720 while (isspace(*s)) s++;
2721 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2722 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2723 if (sub[0] == NULL) return NULL;
2724 /* {-for-text-editors */
2725 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2727 while (isspace(*s)) s++;
2728 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2732 /* Call eval_condition once, with result discarded (as if scanning a
2733 "false" part). This allows us to find the end of the condition, because if
2734 the list it empty, we won't actually evaluate the condition for real. */
2736 if (!(s = eval_condition(sub[1], resetok, NULL)))
2738 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2739 expand_string_message, name);
2742 while (isspace(*s)) s++;
2744 /* {-for-text-editors */
2747 /* {-for-text-editors */
2748 expand_string_message = string_sprintf("missing } at end of condition "
2749 "inside \"%s\"", name);
2753 if (yield != NULL) *yield = !testfor;
2754 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2756 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2757 if (!eval_condition(sub[1], resetok, &tempcond))
2759 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2760 expand_string_message, name);
2761 iterate_item = save_iterate_item;
2764 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2765 tempcond? "true":"false");
2767 if (yield != NULL) *yield = (tempcond == testfor);
2768 if (tempcond == (cond_type == ECOND_FORANY)) break;
2771 iterate_item = save_iterate_item;
2776 /* The bool{} expansion condition maps a string to boolean.
2777 The values supported should match those supported by the ACL condition
2778 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2779 of true/false. Note that Router "condition" rules have a different
2780 interpretation, where general data can be used and only a few values
2782 Note that readconf.c boolean matching, for boolean configuration options,
2783 only matches true/yes/false/no.
2784 The bool_lax{} condition matches the Router logic, which is much more
2787 case ECOND_BOOL_LAX:
2793 BOOL boolvalue = FALSE;
2794 while (isspace(*s)) s++;
2795 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2796 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2797 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2799 case 1: expand_string_message = string_sprintf(
2800 "too few arguments or bracketing error for %s",
2804 case 3: return NULL;
2807 while (isspace(*t)) t++;
2811 /* trailing whitespace: seems like a good idea to ignore it too */
2813 while (isspace(*t2)) t2--;
2814 if (t2 != (t + len))
2821 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2822 /* logic for the lax case from expand_check_condition(), which also does
2823 expands, and the logic is both short and stable enough that there should
2824 be no maintenance burden from replicating it. */
2827 else if (Ustrspn(t, "0123456789") == len)
2829 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2830 /* expand_check_condition only does a literal string "0" check */
2831 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2834 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2836 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2838 else if (cond_type == ECOND_BOOL_LAX)
2842 expand_string_message = string_sprintf("unrecognised boolean "
2846 if (yield != NULL) *yield = (boolvalue == testfor);
2850 /* Unknown condition */
2853 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2855 } /* End switch on condition type */
2857 /* Missing braces at start and end of data */
2859 COND_FAILED_CURLY_START:
2860 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2863 COND_FAILED_CURLY_END:
2864 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2868 /* A condition requires code that is not compiled */
2870 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2871 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2872 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2873 COND_FAILED_NOT_COMPILED:
2874 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2883 /*************************************************
2884 * Save numerical variables *
2885 *************************************************/
2887 /* This function is called from items such as "if" that want to preserve and
2888 restore the numbered variables.
2891 save_expand_string points to an array of pointers to set
2892 save_expand_nlength points to an array of ints for the lengths
2894 Returns: the value of expand max to save
2898 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2901 for (i = 0; i <= expand_nmax; i++)
2903 save_expand_nstring[i] = expand_nstring[i];
2904 save_expand_nlength[i] = expand_nlength[i];
2911 /*************************************************
2912 * Restore numerical variables *
2913 *************************************************/
2915 /* This function restored saved values of numerical strings.
2918 save_expand_nmax the number of strings to restore
2919 save_expand_string points to an array of pointers
2920 save_expand_nlength points to an array of ints
2926 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2927 int *save_expand_nlength)
2930 expand_nmax = save_expand_nmax;
2931 for (i = 0; i <= expand_nmax; i++)
2933 expand_nstring[i] = save_expand_nstring[i];
2934 expand_nlength[i] = save_expand_nlength[i];
2942 /*************************************************
2943 * Handle yes/no substrings *
2944 *************************************************/
2946 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2947 alternative substrings that depend on whether or not the condition was true,
2948 or the lookup or extraction succeeded. The substrings always have to be
2949 expanded, to check their syntax, but "skipping" is set when the result is not
2950 needed - this avoids unnecessary nested lookups.
2953 skipping TRUE if we were skipping when this item was reached
2954 yes TRUE if the first string is to be used, else use the second
2955 save_lookup a value to put back into lookup_value before the 2nd expansion
2956 sptr points to the input string pointer
2957 yieldptr points to the output string pointer
2958 sizeptr points to the output string size
2959 ptrptr points to the output string pointer
2960 type "lookup" or "if" or "extract" or "run", for error message
2961 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2964 Returns: 0 OK; lookup_value has been reset to save_lookup
2966 2 expansion failed because of bracketing error
2970 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2971 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
2974 uschar *s = *sptr; /* Local value */
2975 uschar *sub1, *sub2;
2977 /* If there are no following strings, we substitute the contents of $value for
2978 lookups and for extractions in the success case. For the ${if item, the string
2979 "true" is substituted. In the fail case, nothing is substituted for all three
2982 while (isspace(*s)) s++;
2987 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2991 if (yes && lookup_value != NULL)
2992 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2993 Ustrlen(lookup_value));
2994 lookup_value = save_lookup;
3000 /* The first following string must be braced. */
3002 if (*s++ != '{') goto FAILED_CURLY;
3004 /* Expand the first substring. Forced failures are noticed only if we actually
3005 want this string. Set skipping in the call in the fail case (this will always
3006 be the case if we were already skipping). */
3008 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3009 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3010 expand_string_forcedfail = FALSE;
3011 if (*s++ != '}') goto FAILED_CURLY;
3013 /* If we want the first string, add it to the output */
3016 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3018 /* If this is called from a lookup or an extract, we want to restore $value to
3019 what it was at the start of the item, so that it has this value during the
3020 second string expansion. For the call from "if" or "run" to this function,
3021 save_lookup is set to lookup_value, so that this statement does nothing. */
3023 lookup_value = save_lookup;
3025 /* There now follows either another substring, or "fail", or nothing. This
3026 time, forced failures are noticed only if we want the second string. We must
3027 set skipping in the nested call if we don't want this string, or if we were
3028 already skipping. */
3030 while (isspace(*s)) s++;
3033 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3034 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3035 expand_string_forcedfail = FALSE;
3036 if (*s++ != '}') goto FAILED_CURLY;
3038 /* If we want the second string, add it to the output */
3041 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3044 /* If there is no second string, but the word "fail" is present when the use of
3045 the second string is wanted, set a flag indicating it was a forced failure
3046 rather than a syntactic error. Swallow the terminating } in case this is nested
3047 inside another lookup or if or extract. */
3052 s = read_name(name, sizeof(name), s, US"_");
3053 if (Ustrcmp(name, "fail") == 0)
3055 if (!yes && !skipping)
3057 while (isspace(*s)) s++;
3058 if (*s++ != '}') goto FAILED_CURLY;
3059 expand_string_message =
3060 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3061 expand_string_forcedfail = TRUE;
3067 expand_string_message =
3068 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3073 /* All we have to do now is to check on the final closing brace. */
3075 while (isspace(*s)) s++;
3076 if (*s++ == '}') goto RETURN;
3078 /* Get here if there is a bracketing failure */
3083 /* Get here for other failures */
3088 /* Update the input pointer value before returning */
3098 /*************************************************
3099 * Handle MD5 or SHA-1 computation for HMAC *
3100 *************************************************/
3102 /* These are some wrapping functions that enable the HMAC code to be a bit
3103 cleaner. A good compiler will spot the tail recursion.
3106 type HMAC_MD5 or HMAC_SHA1
3107 remaining are as for the cryptographic hash functions
3113 chash_start(int type, void *base)
3115 if (type == HMAC_MD5)
3116 md5_start((md5 *)base);
3118 sha1_start((sha1 *)base);
3122 chash_mid(int type, void *base, uschar *string)
3124 if (type == HMAC_MD5)
3125 md5_mid((md5 *)base, string);
3127 sha1_mid((sha1 *)base, string);
3131 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3133 if (type == HMAC_MD5)
3134 md5_end((md5 *)base, string, length, digest);
3136 sha1_end((sha1 *)base, string, length, digest);
3143 /********************************************************
3144 * prvs: Get last three digits of days since Jan 1, 1970 *
3145 ********************************************************/
3147 /* This is needed to implement the "prvs" BATV reverse
3150 Argument: integer "days" offset to add or substract to
3151 or from the current number of days.
3153 Returns: pointer to string containing the last three
3154 digits of the number of days since Jan 1, 1970,
3155 modified by the offset argument, NULL if there
3156 was an error in the conversion.
3161 prvs_daystamp(int day_offset)
3163 uschar *days = store_get(32); /* Need at least 24 for cases */
3164 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3165 (time(NULL) + day_offset*86400)/86400);
3166 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3171 /********************************************************
3172 * prvs: perform HMAC-SHA1 computation of prvs bits *
3173 ********************************************************/
3175 /* This is needed to implement the "prvs" BATV reverse
3179 address RFC2821 Address to use
3180 key The key to use (must be less than 64 characters
3182 key_num Single-digit key number to use. Defaults to
3185 Returns: pointer to string containing the first three
3186 bytes of the final hash in hex format, NULL if
3187 there was an error in the process.
3191 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3193 uschar *hash_source, *p;
3194 int size = 0,offset = 0,i;
3196 void *use_base = &sha1_base;
3197 uschar innerhash[20];
3198 uschar finalhash[20];
3199 uschar innerkey[64];
3200 uschar outerkey[64];
3201 uschar *finalhash_hex = store_get(40);
3203 if (key_num == NULL)
3206 if (Ustrlen(key) > 64)
3209 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3210 string_cat(hash_source,&size,&offset,daystamp,3);
3211 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3212 hash_source[offset] = '\0';
3214 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3216 memset(innerkey, 0x36, 64);
3217 memset(outerkey, 0x5c, 64);
3219 for (i = 0; i < Ustrlen(key); i++)
3221 innerkey[i] ^= key[i];
3222 outerkey[i] ^= key[i];
3225 chash_start(HMAC_SHA1, use_base);
3226 chash_mid(HMAC_SHA1, use_base, innerkey);
3227 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3229 chash_start(HMAC_SHA1, use_base);
3230 chash_mid(HMAC_SHA1, use_base, outerkey);
3231 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3234 for (i = 0; i < 3; i++)
3236 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3237 *p++ = hex_digits[finalhash[i] & 0x0f];
3241 return finalhash_hex;
3247 /*************************************************
3248 * Join a file onto the output string *
3249 *************************************************/
3251 /* This is used for readfile and after a run expansion. It joins the contents
3252 of a file onto the output string, globally replacing newlines with a given
3253 string (optionally). The file is closed at the end.
3257 yield pointer to the expandable string
3258 sizep pointer to the current size
3259 ptrp pointer to the current position
3260 eol newline replacement string, or NULL
3262 Returns: new value of string pointer
3266 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3269 uschar buffer[1024];
3271 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3273 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3275 int len = Ustrlen(buffer);
3276 if (eol != NULL && buffer[len-1] == '\n') len--;
3277 yield = string_cat(yield, sizep, ptrp, buffer, len);
3278 if (buffer[len] != 0)
3279 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3282 if (yield != NULL) yield[*ptrp] = 0;
3290 /*************************************************
3291 * Evaluate numeric expression *
3292 *************************************************/
3294 /* This is a set of mutually recursive functions that evaluate an arithmetic
3295 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3296 these functions that is called from elsewhere is eval_expr, whose interface is:
3299 sptr pointer to the pointer to the string - gets updated
3300 decimal TRUE if numbers are to be assumed decimal
3301 error pointer to where to put an error message - must be NULL on input
3302 endket TRUE if ')' must terminate - FALSE for external call
3304 Returns: on success: the value of the expression, with *error still NULL
3305 on failure: an undefined value, with *error = a message
3308 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3311 static int_eximarith_t
3312 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3315 int_eximarith_t x = eval_op_or(&s, decimal, error);
3321 *error = US"expecting closing parenthesis";
3323 while (isspace(*(++s)));
3325 else if (*s != 0) *error = US"expecting operator";
3332 static int_eximarith_t
3333 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3338 while (isspace(*s)) s++;
3343 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3345 switch (tolower(*s))
3348 case 'k': n *= 1024; s++; break;
3349 case 'm': n *= 1024*1024; s++; break;
3350 case 'g': n *= 1024*1024*1024; s++; break;
3352 while (isspace (*s)) s++;
3357 n = eval_expr(&s, decimal, error, 1);
3361 *error = US"expecting number or opening parenthesis";
3369 static int_eximarith_t
3370 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3374 while (isspace(*s)) s++;
3375 if (*s == '+' || *s == '-' || *s == '~')
3378 x = eval_op_unary(&s, decimal, error);
3379 if (op == '-') x = -x;
3380 else if (op == '~') x = ~x;
3384 x = eval_number(&s, decimal, error);
3391 static int_eximarith_t
3392 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3395 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3398 while (*s == '*' || *s == '/' || *s == '%')
3401 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3402 if (*error != NULL) break;
3403 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3404 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3405 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3406 * -N*M is INT_MIN will yielf INT_MIN.
3407 * Since we don't support floating point, this is somewhat simpler.
3408 * Ideally, we'd return an error, but since we overflow for all other
3409 * arithmetic, consistency suggests otherwise, but what's the correct value
3410 * to use? There is none.
3411 * The C standard guarantees overflow for unsigned arithmetic but signed
3412 * overflow invokes undefined behaviour; in practice, this is overflow
3413 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3414 * that long/longlong larger than int are available, or we could just work
3415 * with larger types. We should consider whether to guarantee 32bit eval
3416 * and 64-bit working variables, with errors returned. For now ...
3417 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3418 * can just let the other invalid results occur otherwise, as they have
3419 * until now. For this one case, we can coerce.
3421 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3424 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3425 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3435 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3451 static int_eximarith_t
3452 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3455 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3458 while (*s == '+' || *s == '-')
3461 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3462 if (*error != NULL) break;
3463 if (op == '+') x += y; else x -= y;
3471 static int_eximarith_t
3472 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3475 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3478 while ((*s == '<' || *s == '>') && s[1] == s[0])
3483 y = eval_op_sum(&s, decimal, error);
3484 if (*error != NULL) break;
3485 if (op == '<') x <<= y; else x >>= y;
3493 static int_eximarith_t
3494 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3497 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3504 y = eval_op_shift(&s, decimal, error);
3505 if (*error != NULL) break;
3514 static int_eximarith_t
3515 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3518 int_eximarith_t x = eval_op_and(&s, decimal, error);
3525 y = eval_op_and(&s, decimal, error);
3526 if (*error != NULL) break;
3535 static int_eximarith_t
3536 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3539 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3546 y = eval_op_xor(&s, decimal, error);
3547 if (*error != NULL) break;
3557 /*************************************************
3559 *************************************************/
3561 /* Returns either an unchanged string, or the expanded string in stacking pool
3562 store. Interpreted sequences are:
3564 \... normal escaping rules
3565 $name substitutes the variable
3567 ${op:string} operates on the expanded string value
3568 ${item{arg1}{arg2}...} expands the args and then does the business
3569 some literal args are not enclosed in {}
3571 There are now far too many operators and item types to make it worth listing
3572 them here in detail any more.
3574 We use an internal routine recursively to handle embedded substrings. The
3575 external function follows. The yield is NULL if the expansion failed, and there
3576 are two cases: if something collapsed syntactically, or if "fail" was given
3577 as the action on a lookup failure. These can be distinguised by looking at the
3578 variable expand_string_forcedfail, which is TRUE in the latter case.
3580 The skipping flag is set true when expanding a substring that isn't actually
3581 going to be used (after "if" or "lookup") and it prevents lookups from
3582 happening lower down.
3584 Store usage: At start, a store block of the length of the input plus 64
3585 is obtained. This is expanded as necessary by string_cat(), which might have to
3586 get a new block, or might be able to expand the original. At the end of the
3587 function we can release any store above that portion of the yield block that
3588 was actually used. In many cases this will be optimal.
3590 However: if the first item in the expansion is a variable name or header name,
3591 we reset the store before processing it; if the result is in fresh store, we
3592 use that without copying. This is helpful for expanding strings like
3593 $message_headers which can get very long.
3595 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3596 since resetting the store at the end of the expansion will free store that was
3597 allocated by the plugin code as well as the slop after the expanded string. So
3598 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3599 and, given the acl condition, ${if }. This is an unfortunate consequence of
3600 string expansion becoming too powerful.
3603 string the string to be expanded
3604 ket_ends true if expansion is to stop at }
3605 left if not NULL, a pointer to the first character after the
3606 expansion is placed here (typically used with ket_ends)
3607 skipping TRUE for recursive calls when the value isn't actually going
3608 to be used (to allow for optimisation)
3609 honour_dollar TRUE if $ is to be expanded,
3610 FALSE if it's just another character
3611 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3614 Returns: NULL if expansion fails:
3615 expand_string_forcedfail is set TRUE if failure was forced
3616 expand_string_message contains a textual error message
3617 a pointer to the expanded string on success
3621 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3622 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3625 int size = Ustrlen(string)+ 64;
3627 uschar *yield = store_get(size);
3629 uschar *save_expand_nstring[EXPAND_MAXN+1];
3630 int save_expand_nlength[EXPAND_MAXN+1];
3631 BOOL resetok = TRUE;
3633 expand_string_forcedfail = FALSE;
3634 expand_string_message = US"";
3641 /* \ escapes the next character, which must exist, or else
3642 the expansion fails. There's a special escape, \N, which causes
3643 copying of the subject verbatim up to the next \N. Otherwise,
3644 the escapes are the standard set. */
3650 expand_string_message = US"\\ at end of string";
3657 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3658 yield = string_cat(yield, &size, &ptr, t, s - t);
3659 if (*s != 0) s += 2;
3665 ch[0] = string_interpret_escape(&s);
3667 yield = string_cat(yield, &size, &ptr, ch, 1);
3674 /* Anything other than $ is just copied verbatim, unless we are
3675 looking for a terminating } character. */
3678 if (ket_ends && *s == '}') break;
3680 if (*s != '$' || !honour_dollar)
3682 yield = string_cat(yield, &size, &ptr, s++, 1);
3686 /* No { after the $ - must be a plain name or a number for string
3687 match variable. There has to be a fudge for variables that are the
3688 names of header fields preceded by "$header_" because header field
3689 names can contain any printing characters except space and colon.
3690 For those that don't like typing this much, "$h_" is a synonym for
3691 "$header_". A non-existent header yields a NULL value; nothing is
3694 if (isalpha((*(++s))))
3699 s = read_name(name, sizeof(name), s, US"_");
3701 /* If this is the first thing to be expanded, release the pre-allocated
3704 if (ptr == 0 && yield != NULL)
3706 if (resetok) store_reset(yield);
3713 if (Ustrncmp(name, "h_", 2) == 0 ||
3714 Ustrncmp(name, "rh_", 3) == 0 ||
3715 Ustrncmp(name, "bh_", 3) == 0 ||
3716 Ustrncmp(name, "header_", 7) == 0 ||
3717 Ustrncmp(name, "rheader_", 8) == 0 ||
3718 Ustrncmp(name, "bheader_", 8) == 0)
3720 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3721 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3722 s = read_header_name(name, sizeof(name), s);
3723 value = find_header(name, FALSE, &newsize, want_raw, charset);
3725 /* If we didn't find the header, and the header contains a closing brace
3726 character, this may be a user error where the terminating colon
3727 has been omitted. Set a flag to adjust the error message in this case.
3728 But there is no error here - nothing gets inserted. */
3732 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3741 value = find_variable(name, FALSE, skipping, &newsize);
3744 expand_string_message =
3745 string_sprintf("unknown variable name \"%s\"", name);
3746 check_variable_error_message(name);
3751 /* If the data is known to be in a new buffer, newsize will be set to the
3752 size of that buffer. If this is the first thing in an expansion string,
3753 yield will be NULL; just point it at the new store instead of copying. Many
3754 expansion strings contain just one reference, so this is a useful
3755 optimization, especially for humungous headers. */
3757 len = Ustrlen(value);
3758 if (yield == NULL && newsize != 0)
3764 else yield = string_cat(yield, &size, &ptr, value, len);
3772 s = read_number(&n, s);
3773 if (n >= 0 && n <= expand_nmax)
3774 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3779 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3781 if (*s != '{') /*}*/
3783 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3787 /* After { there can be various things, but they all start with
3788 an initial word, except for a number for a string match variable. */
3790 if (isdigit((*(++s))))
3793 s = read_number(&n, s); /*{*/
3796 expand_string_message = US"} expected after number";
3799 if (n >= 0 && n <= expand_nmax)
3800 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3807 expand_string_message = US"letter or digit expected after ${"; /*}*/
3811 /* Allow "-" in names to cater for substrings with negative
3812 arguments. Since we are checking for known names after { this is
3815 s = read_name(name, sizeof(name), s, US"_-");
3816 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3820 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3821 If the ACL returns accept or reject we return content set by "message ="
3822 There is currently no limit on recursion; this would have us call
3823 acl_check_internal() directly and get a current level from somewhere.
3824 See also the acl expansion condition ECOND_ACL and the traditional
3825 acl modifier ACLC_ACL.
3826 Assume that the function has side-effects on the store that must be preserved.
3830 /* ${acl {name} {arg1}{arg2}...} */
3832 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3835 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
3837 case 1: goto EXPAND_FAILED_CURLY;
3839 case 3: goto EXPAND_FAILED;
3841 if (skipping) continue;
3844 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3849 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3853 expand_string_forcedfail = TRUE;
3855 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3860 /* Handle conditionals - preserve the values of the numerical expansion
3861 variables in case they get changed by a regular expression match in the
3862 condition. If not, they retain their external settings. At the end
3863 of this "if" section, they get restored to their previous values. */
3869 int save_expand_nmax =
3870 save_expand_strings(save_expand_nstring, save_expand_nlength);
3872 while (isspace(*s)) s++;
3873 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
3874 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3877 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3878 cond? "true" : "false");
3882 /* The handling of "yes" and "no" result strings is now in a separate
3883 function that is also used by ${lookup} and ${extract} and ${run}. */
3885 switch(process_yesno(
3886 skipping, /* were previously skipping */
3887 cond, /* success/failure indicator */
3888 lookup_value, /* value to reset for string2 */
3889 &s, /* input pointer */
3890 &yield, /* output pointer */
3891 &size, /* output size */
3892 &ptr, /* output current point */
3893 US"if", /* condition type */
3896 case 1: goto EXPAND_FAILED; /* when all is well, the */
3897 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3900 /* Restore external setting of expansion variables for continuation
3903 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3904 save_expand_nlength);
3908 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3909 expanding an internal string that isn't actually going to be used. All we
3910 need to do is check the syntax, so don't do a lookup at all. Preserve the
3911 values of the numerical expansion variables in case they get changed by a
3912 partial lookup. If not, they retain their external settings. At the end
3913 of this "lookup" section, they get restored to their previous values. */
3917 int stype, partial, affixlen, starflags;
3918 int expand_setup = 0;
3920 uschar *key, *filename, *affix;
3921 uschar *save_lookup_value = lookup_value;
3922 int save_expand_nmax =
3923 save_expand_strings(save_expand_nstring, save_expand_nlength);
3925 if ((expand_forbid & RDO_LOOKUP) != 0)
3927 expand_string_message = US"lookup expansions are not permitted";
3931 /* Get the key we are to look up for single-key+file style lookups.
3932 Otherwise set the key NULL pro-tem. */
3934 while (isspace(*s)) s++;
3935 if (*s == '{') /*}*/
3937 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
3938 if (key == NULL) goto EXPAND_FAILED; /*{*/
3939 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3940 while (isspace(*s)) s++;
3944 /* Find out the type of database */
3948 expand_string_message = US"missing lookup type";
3952 /* The type is a string that may contain special characters of various
3953 kinds. Allow everything except space or { to appear; the actual content
3954 is checked by search_findtype_partial. */ /*}*/
3956 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
3958 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3962 while (isspace(*s)) s++;
3964 /* Now check for the individual search type and any partial or default
3965 options. Only those types that are actually in the binary are valid. */
3967 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3971 expand_string_message = search_error_message;
3975 /* Check that a key was provided for those lookup types that need it,
3976 and was not supplied for those that use the query style. */
3978 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3982 expand_string_message = string_sprintf("missing {key} for single-"
3983 "key \"%s\" lookup", name);
3991 expand_string_message = string_sprintf("a single key was given for "
3992 "lookup type \"%s\", which is not a single-key lookup type", name);
3997 /* Get the next string in brackets and expand it. It is the file name for
3998 single-key+file lookups, and the whole query otherwise. In the case of
3999 queries that also require a file name (e.g. sqlite), the file name comes
4002 if (*s != '{') goto EXPAND_FAILED_CURLY;
4003 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4004 if (filename == NULL) goto EXPAND_FAILED;
4005 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4006 while (isspace(*s)) s++;
4008 /* If this isn't a single-key+file lookup, re-arrange the variables
4009 to be appropriate for the search_ functions. For query-style lookups,
4010 there is just a "key", and no file name. For the special query-style +
4011 file types, the query (i.e. "key") starts with a file name. */
4015 while (isspace(*filename)) filename++;
4018 if (mac_islookup(stype, lookup_querystyle))
4024 if (*filename != '/')
4026 expand_string_message = string_sprintf(
4027 "absolute file name expected for \"%s\" lookup", name);
4030 while (*key != 0 && !isspace(*key)) key++;
4031 if (*key != 0) *key++ = 0;
4035 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4036 the entry was not found. Note that there is no search_close() function.
4037 Files are left open in case of re-use. At suitable places in higher logic,
4038 search_tidyup() is called to tidy all open files. This can save opening
4039 the same file several times. However, files may also get closed when
4040 others are opened, if too many are open at once. The rule is that a
4041 handle should not be used after a second search_open().
4043 Request that a partial search sets up $1 and maybe $2 by passing
4044 expand_setup containing zero. If its value changes, reset expand_nmax,
4045 since new variables will have been set. Note that at the end of this
4046 "lookup" section, the old numeric variables are restored. */
4049 lookup_value = NULL;
4052 void *handle = search_open(filename, stype, 0, NULL, NULL);
4055 expand_string_message = search_error_message;
4058 lookup_value = search_find(handle, filename, key, partial, affix,
4059 affixlen, starflags, &expand_setup);
4060 if (search_find_defer)
4062 expand_string_message =
4063 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4064 string_printing2(key, FALSE), search_error_message);
4067 if (expand_setup > 0) expand_nmax = expand_setup;
4070 /* The handling of "yes" and "no" result strings is now in a separate
4071 function that is also used by ${if} and ${extract}. */
4073 switch(process_yesno(
4074 skipping, /* were previously skipping */
4075 lookup_value != NULL, /* success/failure indicator */
4076 save_lookup_value, /* value to reset for string2 */
4077 &s, /* input pointer */
4078 &yield, /* output pointer */
4079 &size, /* output size */
4080 &ptr, /* output current point */
4081 US"lookup", /* condition type */
4084 case 1: goto EXPAND_FAILED; /* when all is well, the */
4085 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4088 /* Restore external setting of expansion variables for carrying on
4089 at this level, and continue. */
4091 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4092 save_expand_nlength);
4096 /* If Perl support is configured, handle calling embedded perl subroutines,
4097 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4098 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4099 arguments (defined below). */
4101 #define EXIM_PERL_MAX_ARGS 8
4105 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4106 "is not included in this binary";
4109 #else /* EXIM_PERL */
4111 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4114 if ((expand_forbid & RDO_PERL) != 0)
4116 expand_string_message = US"Perl calls are not permitted";
4120 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4121 US"perl", &resetok))
4123 case 1: goto EXPAND_FAILED_CURLY;
4125 case 3: goto EXPAND_FAILED;
4128 /* If skipping, we don't actually do anything */
4130 if (skipping) continue;
4132 /* Start the interpreter if necessary */
4134 if (!opt_perl_started)
4137 if (opt_perl_startup == NULL)
4139 expand_string_message = US"A setting of perl_startup is needed when "
4140 "using the Perl interpreter";
4143 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4144 initerror = init_perl(opt_perl_startup);
4145 if (initerror != NULL)
4147 expand_string_message =
4148 string_sprintf("error in perl_startup code: %s\n", initerror);
4151 opt_perl_started = TRUE;
4154 /* Call the function */
4156 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4157 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4158 sub_arg[0], sub_arg + 1);
4160 /* NULL yield indicates failure; if the message pointer has been set to
4161 NULL, the yield was undef, indicating a forced failure. Otherwise the
4162 message will indicate some kind of Perl error. */
4164 if (new_yield == NULL)
4166 if (expand_string_message == NULL)
4168 expand_string_message =
4169 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4170 "failure", sub_arg[0]);
4171 expand_string_forcedfail = TRUE;
4176 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4177 set during a callback from Perl. */
4179 expand_string_forcedfail = FALSE;
4183 #endif /* EXIM_PERL */
4185 /* Transform email address to "prvs" scheme to use
4186 as BATV-signed return path */
4193 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4195 case 1: goto EXPAND_FAILED_CURLY;
4197 case 3: goto EXPAND_FAILED;
4200 /* If skipping, we don't actually do anything */
4201 if (skipping) continue;
4203 /* sub_arg[0] is the address */
4204 domain = Ustrrchr(sub_arg[0],'@');
4205 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4207 expand_string_message = US"prvs first argument must be a qualified email address";
4211 /* Calculate the hash. The second argument must be a single-digit
4212 key number, or unset. */
4214 if (sub_arg[2] != NULL &&
4215 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4217 expand_string_message = US"prvs second argument must be a single digit";
4221 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4224 expand_string_message = US"prvs hmac-sha1 conversion failed";
4228 /* Now separate the domain from the local part */
4231 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4232 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4233 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4234 string_cat(yield,&size,&ptr,p,6);
4235 string_cat(yield,&size,&ptr,US"=",1);
4236 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4237 string_cat(yield,&size,&ptr,US"@",1);
4238 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4243 /* Check a prvs-encoded address for validity */
4245 case EITEM_PRVSCHECK:
4248 int mysize = 0, myptr = 0;
4252 /* TF: Ugliness: We want to expand parameter 1 first, then set
4253 up expansion variables that are used in the expansion of
4254 parameter 2. So we clone the string for the first
4255 expansion, where we only expand parameter 1.
4257 PH: Actually, that isn't necessary. The read_subs() function is
4258 designed to work this way for the ${if and ${lookup expansions. I've
4262 /* Reset expansion variables */
4263 prvscheck_result = NULL;
4264 prvscheck_address = NULL;
4265 prvscheck_keynum = NULL;
4267 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4269 case 1: goto EXPAND_FAILED_CURLY;
4271 case 3: goto EXPAND_FAILED;
4274 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4277 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4279 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4280 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4281 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4282 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4283 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4285 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4286 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4287 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4288 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4289 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4291 /* Set up expansion variables */
4292 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4293 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4294 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4295 prvscheck_address[myptr] = '\0';
4296 prvscheck_keynum = string_copy(key_num);
4298 /* Now expand the second argument */
4299 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4301 case 1: goto EXPAND_FAILED_CURLY;
4303 case 3: goto EXPAND_FAILED;
4306 /* Now we have the key and can check the address. */
4308 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4313 expand_string_message = US"hmac-sha1 conversion failed";
4317 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4318 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4320 if (Ustrcmp(p,hash) == 0)
4322 /* Success, valid BATV address. Now check the expiry date. */
4323 uschar *now = prvs_daystamp(0);
4324 unsigned int inow = 0,iexpire = 1;
4326 (void)sscanf(CS now,"%u",&inow);
4327 (void)sscanf(CS daystamp,"%u",&iexpire);
4329 /* When "iexpire" is < 7, a "flip" has occured.
4330 Adjust "inow" accordingly. */
4331 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4333 if (iexpire >= inow)
4335 prvscheck_result = US"1";
4336 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4340 prvscheck_result = NULL;
4341 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4346 prvscheck_result = NULL;
4347 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4350 /* Now expand the final argument. We leave this till now so that
4351 it can include $prvscheck_result. */
4353 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4355 case 1: goto EXPAND_FAILED_CURLY;
4357 case 3: goto EXPAND_FAILED;
4360 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4361 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4363 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4365 /* Reset the "internal" variables afterwards, because they are in
4366 dynamic store that will be reclaimed if the expansion succeeded. */
4368 prvscheck_address = NULL;
4369 prvscheck_keynum = NULL;
4373 /* Does not look like a prvs encoded address, return the empty string.
4374 We need to make sure all subs are expanded first, so as to skip over
4377 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4379 case 1: goto EXPAND_FAILED_CURLY;
4381 case 3: goto EXPAND_FAILED;
4388 /* Handle "readfile" to insert an entire file */
4390 case EITEM_READFILE:
4395 if ((expand_forbid & RDO_READFILE) != 0)
4397 expand_string_message = US"file insertions are not permitted";
4401 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4403 case 1: goto EXPAND_FAILED_CURLY;
4405 case 3: goto EXPAND_FAILED;
4408 /* If skipping, we don't actually do anything */
4410 if (skipping) continue;
4412 /* Open the file and read it */
4414 f = Ufopen(sub_arg[0], "rb");
4417 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4421 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4426 /* Handle "readsocket" to insert data from a Unix domain socket */
4428 case EITEM_READSOCK:
4434 struct sockaddr_un sockun; /* don't call this "sun" ! */
4438 if ((expand_forbid & RDO_READSOCK) != 0)
4440 expand_string_message = US"socket insertions are not permitted";
4444 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4445 because there may be a string for expansion on failure. */
4447 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4449 case 1: goto EXPAND_FAILED_CURLY;
4450 case 2: /* Won't occur: no end check */
4451 case 3: goto EXPAND_FAILED;
4454 /* Sort out timeout, if given */
4456 if (sub_arg[2] != NULL)
4458 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4461 expand_string_message = string_sprintf("bad time value %s",
4466 else sub_arg[3] = NULL; /* No eol if no timeout */
4468 /* If skipping, we don't actually do anything. Otherwise, arrange to
4469 connect to either an IP or a Unix socket. */
4473 /* Handle an IP (internet) domain */
4475 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4477 BOOL connected = FALSE;
4481 uschar *server_name = sub_arg[0] + 5;
4482 uschar *port_name = Ustrrchr(server_name, ':');
4484 /* Sort out the port */
4486 if (port_name == NULL)
4488 expand_string_message =
4489 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4492 *port_name++ = 0; /* Terminate server name */
4494 if (isdigit(*port_name))
4497 port = Ustrtol(port_name, &end, 0);
4498 if (end != port_name + Ustrlen(port_name))
4500 expand_string_message =
4501 string_sprintf("invalid port number %s", port_name);
4507 struct servent *service_info = getservbyname(CS port_name, "tcp");
4508 if (service_info == NULL)
4510 expand_string_message = string_sprintf("unknown port \"%s\"",
4514 port = ntohs(service_info->s_port);
4517 /* Sort out the server. */
4520 shost.address = NULL;
4524 namelen = Ustrlen(server_name);
4526 /* Anything enclosed in [] must be an IP address. */
4528 if (server_name[0] == '[' &&
4529 server_name[namelen - 1] == ']')
4531 server_name[namelen - 1] = 0;
4533 if (string_is_ip_address(server_name, NULL) == 0)
4535 expand_string_message =
4536 string_sprintf("malformed IP address \"%s\"", server_name);
4539 shost.name = shost.address = server_name;
4542 /* Otherwise check for an unadorned IP address */
4544 else if (string_is_ip_address(server_name, NULL) != 0)
4545 shost.name = shost.address = server_name;
4547 /* Otherwise lookup IP address(es) from the name */
4551 shost.name = server_name;
4552 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4553 FALSE) != HOST_FOUND)
4555 expand_string_message =
4556 string_sprintf("no IP address found for host %s", shost.name);
4561 /* Try to connect to the server - test each IP till one works */
4563 for (h = &shost; h != NULL; h = h->next)
4565 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4566 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4568 expand_string_message = string_sprintf("failed to create socket: "
4569 "%s", strerror(errno));
4573 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4582 expand_string_message = string_sprintf("failed to connect to "
4583 "socket %s: couldn't connect to any host", sub_arg[0],
4589 /* Handle a Unix domain socket */
4594 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4596 expand_string_message = string_sprintf("failed to create socket: %s",
4601 sockun.sun_family = AF_UNIX;
4602 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4605 sigalrm_seen = FALSE;
4607 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4611 expand_string_message = US "socket connect timed out";
4616 expand_string_message = string_sprintf("failed to connect to socket "
4617 "%s: %s", sub_arg[0], strerror(errno));
4622 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4624 /* Write the request string, if not empty */
4626 if (sub_arg[1][0] != 0)
4628 int len = Ustrlen(sub_arg[1]);
4629 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4631 if (write(fd, sub_arg[1], len) != len)
4633 expand_string_message = string_sprintf("request write to socket "
4634 "failed: %s", strerror(errno));
4639 /* Shut down the sending side of the socket. This helps some servers to
4640 recognise that it is their turn to do some work. Just in case some
4641 system doesn't have this function, make it conditional. */
4644 shutdown(fd, SHUT_WR);
4647 /* Now we need to read from the socket, under a timeout. The function
4648 that reads a file can be used. */
4650 f = fdopen(fd, "rb");
4651 sigalrm_seen = FALSE;
4653 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4657 /* After a timeout, we restore the pointer in the result, that is,
4658 make sure we add nothing from the socket. */
4663 expand_string_message = US "socket read timed out";
4668 /* The whole thing has worked (or we were skipping). If there is a
4669 failure string following, we need to skip it. */
4673 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4675 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4676 while (isspace(*s)) s++;
4678 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4681 /* Come here on failure to create socket, connect socket, write to the
4682 socket, or timeout on reading. If another substring follows, expand and
4683 use it. Otherwise, those conditions give expand errors. */
4686 if (*s != '{') goto EXPAND_FAILED;
4687 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4688 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4689 if (arg == NULL) goto EXPAND_FAILED;
4690 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4691 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4692 while (isspace(*s)) s++;
4693 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4697 /* Handle "run" to execute a program. */
4709 if ((expand_forbid & RDO_RUN) != 0)
4711 expand_string_message = US"running a command is not permitted";
4715 while (isspace(*s)) s++;
4716 if (*s != '{') goto EXPAND_FAILED_CURLY;
4717 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4718 if (arg == NULL) goto EXPAND_FAILED;
4719 while (isspace(*s)) s++;
4720 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4722 if (skipping) /* Just pretend it worked when we're skipping */
4728 if (!transport_set_up_command(&argv, /* anchor for arg list */
4729 arg, /* raw command */
4730 FALSE, /* don't expand the arguments */
4731 0, /* not relevant when... */
4732 NULL, /* no transporting address */
4733 US"${run} expansion", /* for error messages */
4734 &expand_string_message)) /* where to put error message */
4739 /* Create the child process, making it a group leader. */
4741 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4745 expand_string_message =
4746 string_sprintf("couldn't create child process: %s", strerror(errno));
4750 /* Nothing is written to the standard input. */
4754 /* Read the pipe to get the command's output into $value (which is kept
4755 in lookup_value). Read during execution, so that if the output exceeds
4756 the OS pipe buffer limit, we don't block forever. */
4758 f = fdopen(fd_out, "rb");
4759 sigalrm_seen = FALSE;
4761 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4765 /* Wait for the process to finish, applying the timeout, and inspect its
4766 return code for serious disasters. Simple non-zero returns are passed on.
4769 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4771 if (sigalrm_seen == TRUE || runrc == -256)
4773 expand_string_message = string_sprintf("command timed out");
4774 killpg(pid, SIGKILL); /* Kill the whole process group */
4777 else if (runrc == -257)
4778 expand_string_message = string_sprintf("wait() failed: %s",
4782 expand_string_message = string_sprintf("command killed by signal %d",
4789 /* Process the yes/no strings; $value may be useful in both cases */
4791 switch(process_yesno(
4792 skipping, /* were previously skipping */
4793 runrc == 0, /* success/failure indicator */
4794 lookup_value, /* value to reset for string2 */
4795 &s, /* input pointer */
4796 &yield, /* output pointer */
4797 &size, /* output size */
4798 &ptr, /* output current point */
4799 US"run", /* condition type */
4802 case 1: goto EXPAND_FAILED; /* when all is well, the */
4803 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4809 /* Handle character translation for "tr" */
4817 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4819 case 1: goto EXPAND_FAILED_CURLY;
4821 case 3: goto EXPAND_FAILED;
4824 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4825 o2m = Ustrlen(sub[2]) - 1;
4827 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4829 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4833 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4840 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4841 expanded arguments. */
4851 int val[2] = { 0, -1 };
4854 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4855 Ensure that sub[2] is set in the ${length } case. */
4858 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4859 TRUE, name, &resetok))
4861 case 1: goto EXPAND_FAILED_CURLY;
4863 case 3: goto EXPAND_FAILED;
4866 /* Juggle the arguments if there are only two of them: always move the
4867 string to the last position and make ${length{n}{str}} equivalent to
4868 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4874 if (item_type == EITEM_LENGTH)
4881 for (i = 0; i < 2; i++)
4883 if (sub[i] == NULL) continue;
4884 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4885 if (*ret != 0 || (i != 0 && val[i] < 0))
4887 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4888 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4894 (item_type == EITEM_HASH)?
4895 compute_hash(sub[2], val[0], val[1], &len) :
4896 (item_type == EITEM_NHASH)?
4897 compute_nhash(sub[2], val[0], val[1], &len) :
4898 extract_substr(sub[2], val[0], val[1], &len);
4900 if (ret == NULL) goto EXPAND_FAILED;
4901 yield = string_cat(yield, &size, &ptr, ret, len);
4905 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4906 This code originally contributed by Steve Haslam. It currently supports
4907 the use of MD5 and SHA-1 hashes.
4909 We need some workspace that is large enough to handle all the supported
4910 hash types. Use macros to set the sizes rather than be too elaborate. */
4912 #define MAX_HASHLEN 20
4913 #define MAX_HASHBLOCKLEN 64
4922 int hashlen; /* Number of octets for the hash algorithm's output */
4923 int hashblocklen; /* Number of octets the hash algorithm processes */
4925 unsigned int keylen;
4927 uschar keyhash[MAX_HASHLEN];
4928 uschar innerhash[MAX_HASHLEN];
4929 uschar finalhash[MAX_HASHLEN];
4930 uschar finalhash_hex[2*MAX_HASHLEN];
4931 uschar innerkey[MAX_HASHBLOCKLEN];
4932 uschar outerkey[MAX_HASHBLOCKLEN];
4934 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
4936 case 1: goto EXPAND_FAILED_CURLY;
4938 case 3: goto EXPAND_FAILED;
4941 if (Ustrcmp(sub[0], "md5") == 0)
4944 use_base = &md5_base;
4948 else if (Ustrcmp(sub[0], "sha1") == 0)
4951 use_base = &sha1_base;
4957 expand_string_message =
4958 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4963 keylen = Ustrlen(keyptr);
4965 /* If the key is longer than the hash block length, then hash the key
4968 if (keylen > hashblocklen)
4970 chash_start(type, use_base);
4971 chash_end(type, use_base, keyptr, keylen, keyhash);
4976 /* Now make the inner and outer key values */
4978 memset(innerkey, 0x36, hashblocklen);
4979 memset(outerkey, 0x5c, hashblocklen);
4981 for (i = 0; i < keylen; i++)
4983 innerkey[i] ^= keyptr[i];
4984 outerkey[i] ^= keyptr[i];
4987 /* Now do the hashes */
4989 chash_start(type, use_base);
4990 chash_mid(type, use_base, innerkey);
4991 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4993 chash_start(type, use_base);
4994 chash_mid(type, use_base, outerkey);
4995 chash_end(type, use_base, innerhash, hashlen, finalhash);
4997 /* Encode the final hash as a hex string */
5000 for (i = 0; i < hashlen; i++)
5002 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5003 *p++ = hex_digits[finalhash[i] & 0x0f];
5006 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5007 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5009 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5014 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5015 We have to save the numerical variables and restore them afterwards. */
5020 int moffset, moffsetextra, slen;
5023 const uschar *rerror;
5026 int save_expand_nmax =
5027 save_expand_strings(save_expand_nstring, save_expand_nlength);
5029 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5031 case 1: goto EXPAND_FAILED_CURLY;
5033 case 3: goto EXPAND_FAILED;
5036 /* Compile the regular expression */
5038 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5043 expand_string_message = string_sprintf("regular expression error in "
5044 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5048 /* Now run a loop to do the substitutions as often as necessary. It ends
5049 when there are no more matches. Take care over matches of the null string;
5050 do the same thing as Perl does. */
5053 slen = Ustrlen(sub[0]);
5054 moffset = moffsetextra = 0;
5059 int ovector[3*(EXPAND_MAXN+1)];
5060 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5061 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5065 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5066 is not necessarily the end. We want to repeat the match from one
5067 character further along, but leaving the basic offset the same (for
5068 copying below). We can't be at the end of the string - that was checked
5069 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5070 finished; copy the remaining string and end the loop. */
5080 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5084 /* Match - set up for expanding the replacement. */
5086 if (n == 0) n = EXPAND_MAXN + 1;
5088 for (nn = 0; nn < n*2; nn += 2)
5090 expand_nstring[expand_nmax] = subject + ovector[nn];
5091 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5095 /* Copy the characters before the match, plus the expanded insertion. */
5097 yield = string_cat(yield, &size, &ptr, subject + moffset,
5098 ovector[0] - moffset);
5099 insert = expand_string(sub[2]);
5100 if (insert == NULL) goto EXPAND_FAILED;
5101 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5103 moffset = ovector[1];
5107 /* If we have matched an empty string, first check to see if we are at
5108 the end of the subject. If so, the loop is over. Otherwise, mimic
5109 what Perl's /g options does. This turns out to be rather cunning. First
5110 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5111 string at the same point. If this fails (picked up above) we advance to
5112 the next character. */
5114 if (ovector[0] == ovector[1])
5116 if (ovector[0] == slen) break;
5117 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5121 /* All done - restore numerical variables. */
5123 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5124 save_expand_nlength);
5128 /* Handle keyed and numbered substring extraction. If the first argument
5129 consists entirely of digits, then a numerical extraction is assumed. */
5135 int field_number = 1;
5136 BOOL field_number_set = FALSE;
5137 uschar *save_lookup_value = lookup_value;
5139 int save_expand_nmax =
5140 save_expand_strings(save_expand_nstring, save_expand_nlength);
5142 /* Read the arguments */
5144 for (i = 0; i < j; i++)
5146 while (isspace(*s)) s++;
5149 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5150 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5151 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5153 /* After removal of leading and trailing white space, the first
5154 argument must not be empty; if it consists entirely of digits
5155 (optionally preceded by a minus sign), this is a numerical
5156 extraction, and we expect 3 arguments. */
5164 while (isspace(*p)) p++;
5168 while (len > 0 && isspace(p[len-1])) len--;
5171 if (*p == 0 && !skipping)
5173 expand_string_message = US"first argument of \"extract\" must "
5183 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5187 j = 3; /* Need 3 args */
5188 field_number_set = TRUE;
5192 else goto EXPAND_FAILED_CURLY;
5195 /* Extract either the numbered or the keyed substring into $value. If
5196 skipping, just pretend the extraction failed. */
5198 lookup_value = skipping? NULL : field_number_set?
5199 expand_gettokened(field_number, sub[1], sub[2]) :
5200 expand_getkeyed(sub[0], sub[1]);
5202 /* If no string follows, $value gets substituted; otherwise there can
5203 be yes/no strings, as for lookup or if. */
5205 switch(process_yesno(
5206 skipping, /* were previously skipping */
5207 lookup_value != NULL, /* success/failure indicator */
5208 save_lookup_value, /* value to reset for string2 */
5209 &s, /* input pointer */
5210 &yield, /* output pointer */
5211 &size, /* output size */
5212 &ptr, /* output current point */
5213 US"extract", /* condition type */
5216 case 1: goto EXPAND_FAILED; /* when all is well, the */
5217 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5220 /* All done - restore numerical variables. */
5222 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5223 save_expand_nlength);
5228 /* Handle list operations */
5236 uschar outsep[2] = { '\0', '\0' };
5237 uschar *list, *expr, *temp;
5238 uschar *save_iterate_item = iterate_item;
5239 uschar *save_lookup_value = lookup_value;
5242 while (isspace(*s)) s++;
5243 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5245 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5246 if (list == NULL) goto EXPAND_FAILED;
5247 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5249 if (item_type == EITEM_REDUCE)
5251 while (isspace(*s)) s++;
5252 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5253 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5254 if (temp == NULL) goto EXPAND_FAILED;
5255 lookup_value = temp;
5256 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5259 while (isspace(*s)) s++;
5260 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5264 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5265 if scanning a "false" part). This allows us to find the end of the
5266 condition, because if the list is empty, we won't actually evaluate the
5267 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5268 the normal internal expansion function. */
5270 if (item_type == EITEM_FILTER)
5272 temp = eval_condition(expr, &resetok, NULL);
5273 if (temp != NULL) s = temp;
5277 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5282 expand_string_message = string_sprintf("%s inside \"%s\" item",
5283 expand_string_message, name);
5287 while (isspace(*s)) s++;
5290 expand_string_message = string_sprintf("missing } at end of condition "
5291 "or expression inside \"%s\"", name);
5295 while (isspace(*s)) s++; /*{*/
5298 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5303 /* If we are skipping, we can now just move on to the next item. When
5304 processing for real, we perform the iteration. */
5306 if (skipping) continue;
5307 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5309 *outsep = (uschar)sep; /* Separator as a string */
5311 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5313 if (item_type == EITEM_FILTER)
5316 if (eval_condition(expr, &resetok, &condresult) == NULL)
5318 iterate_item = save_iterate_item;
5319 lookup_value = save_lookup_value;
5320 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5321 expand_string_message, name);
5324 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5325 condresult? "true":"false");
5327 temp = iterate_item; /* TRUE => include this item */
5329 continue; /* FALSE => skip this item */
5332 /* EITEM_MAP and EITEM_REDUCE */
5336 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5339 iterate_item = save_iterate_item;
5340 expand_string_message = string_sprintf("%s inside \"%s\" item",
5341 expand_string_message, name);
5344 if (item_type == EITEM_REDUCE)
5346 lookup_value = temp; /* Update the value of $value */
5347 continue; /* and continue the iteration */
5351 /* We reach here for FILTER if the condition is true, always for MAP,
5352 and never for REDUCE. The value in "temp" is to be added to the output
5353 list that is being created, ensuring that any occurrences of the
5354 separator character are doubled. Unless we are dealing with the first
5355 item of the output list, add in a space if the new item begins with the
5356 separator character, or is an empty string. */
5358 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5359 yield = string_cat(yield, &size, &ptr, US" ", 1);
5361 /* Add the string in "temp" to the output list that we are building,
5362 This is done in chunks by searching for the separator character. */
5366 size_t seglen = Ustrcspn(temp, outsep);
5367 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5369 /* If we got to the end of the string we output one character
5370 too many; backup and end the loop. Otherwise arrange to double the
5373 if (temp[seglen] == '\0') { ptr--; break; }
5374 yield = string_cat(yield, &size, &ptr, outsep, 1);
5378 /* Output a separator after the string: we will remove the redundant
5379 final one at the end. */
5381 yield = string_cat(yield, &size, &ptr, outsep, 1);
5382 } /* End of iteration over the list loop */
5384 /* REDUCE has generated no output above: output the final value of
5387 if (item_type == EITEM_REDUCE)
5389 yield = string_cat(yield, &size, &ptr, lookup_value,
5390 Ustrlen(lookup_value));
5391 lookup_value = save_lookup_value; /* Restore $value */
5394 /* FILTER and MAP generate lists: if they have generated anything, remove
5395 the redundant final separator. Even though an empty item at the end of a
5396 list does not count, this is tidier. */
5398 else if (ptr != save_ptr) ptr--;
5400 /* Restore preserved $item */
5402 iterate_item = save_iterate_item;
5407 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5408 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5409 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5410 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5412 #define EXPAND_DLFUNC_MAX_ARGS 8
5415 #ifndef EXPAND_DLFUNC
5416 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5417 "is not included in this binary";
5420 #else /* EXPAND_DLFUNC */
5423 exim_dlfunc_t *func;
5426 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5428 if ((expand_forbid & RDO_DLFUNC) != 0)
5430 expand_string_message =
5431 US"dynamically-loaded functions are not permitted";
5435 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5436 TRUE, US"dlfunc", &resetok))
5438 case 1: goto EXPAND_FAILED_CURLY;
5440 case 3: goto EXPAND_FAILED;
5443 /* If skipping, we don't actually do anything */
5445 if (skipping) continue;
5447 /* Look up the dynamically loaded object handle in the tree. If it isn't
5448 found, dlopen() the file and put the handle in the tree for next time. */
5450 t = tree_search(dlobj_anchor, argv[0]);
5453 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5456 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5457 argv[0], dlerror());
5458 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5461 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5462 Ustrcpy(t->name, argv[0]);
5463 t->data.ptr = handle;
5464 (void)tree_insertnode(&dlobj_anchor, t);
5467 /* Having obtained the dynamically loaded object handle, look up the
5468 function pointer. */
5470 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5473 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5474 "%s", argv[1], argv[0], dlerror());
5475 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5479 /* Call the function and work out what to do with the result. If it
5480 returns OK, we have a replacement string; if it returns DEFER then
5481 expansion has failed in a non-forced manner; if it returns FAIL then
5482 failure was forced; if it returns ERROR or any other value there's a
5483 problem, so panic slightly. In any case, assume that the function has
5484 side-effects on the store that must be preserved. */
5488 for (argc = 0; argv[argc] != NULL; argc++);
5489 status = func(&result, argc - 2, &argv[2]);
5492 if (result == NULL) result = US"";
5493 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5498 expand_string_message = result == NULL ? US"(no message)" : result;
5499 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5500 else if(status != FAIL)
5501 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5502 argv[0], argv[1], status, expand_string_message);
5506 #endif /* EXPAND_DLFUNC */
5507 } /* EITEM_* switch */
5509 /* Control reaches here if the name is not recognized as one of the more
5510 complicated expansion items. Check for the "operator" syntax (name terminated
5511 by a colon). Some of the operators have arguments, separated by _ from the
5518 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5519 if (sub == NULL) goto EXPAND_FAILED;
5522 /* Owing to an historical mis-design, an underscore may be part of the
5523 operator name, or it may introduce arguments. We therefore first scan the
5524 table of names that contain underscores. If there is no match, we cut off
5525 the arguments and then scan the main table. */
5527 c = chop_match(name, op_table_underscore,
5528 sizeof(op_table_underscore)/sizeof(uschar *));
5532 arg = Ustrchr(name, '_');
5533 if (arg != NULL) *arg = 0;
5534 c = chop_match(name, op_table_main,
5535 sizeof(op_table_main)/sizeof(uschar *));
5536 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5537 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5540 /* If we are skipping, we don't need to perform the operation at all.
5541 This matters for operations like "mask", because the data may not be
5542 in the correct format when skipping. For example, the expression may test
5543 for the existence of $sender_host_address before trying to mask it. For
5544 other operations, doing them may not fail, but it is a waste of time. */
5546 if (skipping && c >= 0) continue;
5548 /* Otherwise, switch on the operator type */
5555 unsigned long int n = Ustrtoul(sub, &t, 10);
5558 expand_string_message = string_sprintf("argument for base62 "
5559 "operator is \"%s\", which is not a decimal number", sub);
5562 t = string_base62(n);
5563 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5567 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5573 unsigned long int n = 0;
5576 uschar *t = Ustrchr(base62_chars, *tt++);
5579 expand_string_message = string_sprintf("argument for base62d "
5580 "operator is \"%s\", which is not a base %d number", sub,
5584 n = n * BASE_62 + (t - base62_chars);
5586 (void)sprintf(CS buf, "%ld", n);
5587 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5593 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
5594 if (expanded == NULL)
5596 expand_string_message =
5597 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5598 expand_string_message);
5601 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5608 uschar *t = sub - 1;
5609 while (*(++t) != 0) { *t = tolower(*t); count++; }
5610 yield = string_cat(yield, &size, &ptr, sub, count);
5617 uschar *t = sub - 1;
5618 while (*(++t) != 0) { *t = toupper(*t); count++; }
5619 yield = string_cat(yield, &size, &ptr, sub, count);
5630 md5_end(&base, sub, Ustrlen(sub), digest);
5631 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5632 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5643 sha1_end(&base, sub, Ustrlen(sub), digest);
5644 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5645 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5649 /* Convert hex encoding to base64 encoding */
5659 for (enc = sub; *enc != 0; enc++)
5661 if (!isxdigit(*enc))
5663 expand_string_message = string_sprintf("\"%s\" is not a hex "
5672 expand_string_message = string_sprintf("\"%s\" contains an odd "
5673 "number of characters", sub);
5677 while ((c = *in++) != 0)
5679 if (isdigit(c)) c -= '0';
5680 else c = toupper(c) - 'A' + 10;
5692 enc = auth_b64encode(sub, out - sub);
5693 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5697 /* Convert octets outside 0x21..0x7E to \xXX form */
5701 uschar *t = sub - 1;
5704 if (*t < 0x21 || 0x7E < *t)
5705 yield = string_cat(yield, &size, &ptr,
5706 string_sprintf("\\x%02x", *t), 4);
5708 yield = string_cat(yield, &size, &ptr, t, 1);
5713 /* count the number of list elements */
5722 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5723 cp = string_sprintf("%d", cnt);
5724 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5728 /* expand a named list given the name */
5729 /* handles nested named lists; requotes as colon-sep list */
5733 tree_node *t = NULL;
5737 uschar * suffix = US"";
5738 BOOL needsep = FALSE;
5741 if (*sub == '+') sub++;
5742 if (arg == NULL) /* no-argument version */
5744 if (!(t = tree_search(addresslist_anchor, sub)) &&
5745 !(t = tree_search(domainlist_anchor, sub)) &&
5746 !(t = tree_search(hostlist_anchor, sub)))
5747 t = tree_search(localpartlist_anchor, sub);
5749 else switch(*arg) /* specific list-type version */
5751 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
5752 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
5753 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
5754 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
5756 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5762 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5764 : *arg=='a'?"address "
5765 : *arg=='d'?"domain "
5767 : *arg=='l'?"localpart "
5772 list = ((namedlist_block *)(t->data.ptr))->string;
5774 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5776 uschar * buf = US" : ";
5778 yield = string_cat(yield, &size, &ptr, buf, 3);
5782 if (*item == '+') /* list item is itself a named list */
5784 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5785 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
5787 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5791 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5792 while ((cp= strpbrk((const char *)item, tok)))
5794 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5795 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5797 yield = string_cat(yield, &size, &ptr, US"::", 2);
5798 item = (uschar *)cp;
5800 else /* sep in item; should already be doubled; emit once */
5802 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5803 if (*cp == sep) cp++;
5804 item = (uschar *)cp;
5808 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5813 /* mask applies a mask to an IP address; for example the result of
5814 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5821 int mask, maskoffset;
5822 int type = string_is_ip_address(sub, &maskoffset);
5827 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5832 if (maskoffset == 0)
5834 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5839 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5841 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5843 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5848 /* Convert the address to binary integer(s) and apply the mask */
5850 sub[maskoffset] = 0;
5851 count = host_aton(sub, binary);
5852 host_mask(count, binary, mask);
5854 /* Convert to masked textual format and add to output. */
5856 yield = string_cat(yield, &size, &ptr, buffer,
5857 host_nmtoa(count, binary, mask, buffer, '.'));
5862 case EOP_LOCAL_PART:
5866 int start, end, domain;
5867 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5871 if (c != EOP_DOMAIN)
5873 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5874 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5876 else if (domain != 0)
5879 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5887 uschar outsep[2] = { ':', '\0' };
5888 uschar *address, *error;
5890 int start, end, domain; /* Not really used */
5892 while (isspace(*sub)) sub++;
5893 if (*sub == '>') { *outsep = *++sub; ++sub; }
5894 parse_allow_group = TRUE;
5898 uschar *p = parse_find_address_end(sub, FALSE);
5899 uschar saveend = *p;
5901 address = parse_extract_address(sub, &error, &start, &end, &domain,
5905 /* Add the address to the output list that we are building. This is
5906 done in chunks by searching for the separator character. At the
5907 start, unless we are dealing with the first address of the output
5908 list, add in a space if the new address begins with the separator
5909 character, or is an empty string. */
5911 if (address != NULL)
5913 if (ptr != save_ptr && address[0] == *outsep)
5914 yield = string_cat(yield, &size, &ptr, US" ", 1);
5918 size_t seglen = Ustrcspn(address, outsep);
5919 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5921 /* If we got to the end of the string we output one character
5924 if (address[seglen] == '\0') { ptr--; break; }
5925 yield = string_cat(yield, &size, &ptr, outsep, 1);
5926 address += seglen + 1;
5929 /* Output a separator after the string: we will remove the
5930 redundant final one at the end. */
5932 yield = string_cat(yield, &size, &ptr, outsep, 1);
5935 if (saveend == '\0') break;
5939 /* If we have generated anything, remove the redundant final
5942 if (ptr != save_ptr) ptr--;
5943 parse_allow_group = FALSE;
5948 /* quote puts a string in quotes if it is empty or contains anything
5949 other than alphamerics, underscore, dot, or hyphen.
5951 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5952 be quoted in order to be a valid local part.
5954 In both cases, newlines and carriage returns are converted into \n and \r
5958 case EOP_QUOTE_LOCAL_PART:
5961 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5962 uschar *t = sub - 1;
5966 while (!needs_quote && *(++t) != 0)
5967 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5969 else /* EOP_QUOTE_LOCAL_PART */
5971 while (!needs_quote && *(++t) != 0)
5972 needs_quote = !isalnum(*t) &&
5973 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5974 (*t != '.' || t == sub || t[1] == 0);
5979 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5984 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5985 else if (*t == '\r')
5986 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5989 if (*t == '\\' || *t == '"')
5990 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5991 yield = string_cat(yield, &size, &ptr, t, 1);
5994 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5996 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6000 /* quote_lookuptype does lookup-specific quoting */
6005 uschar *opt = Ustrchr(arg, '_');
6007 if (opt != NULL) *opt++ = 0;
6009 n = search_findtype(arg, Ustrlen(arg));
6012 expand_string_message = search_error_message;
6016 if (lookup_list[n]->quote != NULL)
6017 sub = (lookup_list[n]->quote)(sub, opt);
6018 else if (opt != NULL) sub = NULL;
6022 expand_string_message = string_sprintf(
6023 "\"%s\" unrecognized after \"${quote_%s\"",
6028 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6032 /* rx quote sticks in \ before any non-alphameric character so that
6033 the insertion works in a regular expression. */
6037 uschar *t = sub - 1;
6041 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6042 yield = string_cat(yield, &size, &ptr, t, 1);
6047 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6048 prescribed by the RFC, if there are characters that need to be encoded */
6052 uschar buffer[2048];
6053 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6054 buffer, sizeof(buffer), FALSE);
6055 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6059 /* RFC 2047 decode */
6065 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6066 headers_charset, '?', &len, &error);
6069 expand_string_message = error;
6072 yield = string_cat(yield, &size, &ptr, decoded, len);
6076 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6086 if (c > 255) c = '_';
6088 yield = string_cat(yield, &size, &ptr, buff, 1);
6093 /* escape turns all non-printing characters into escape sequences. */
6097 uschar *t = string_printing(sub);
6098 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6102 /* Handle numeric expression evaluation */
6107 uschar *save_sub = sub;
6108 uschar *error = NULL;
6109 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6112 expand_string_message = string_sprintf("error in expression "
6113 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6117 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6118 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6122 /* Handle time period formating */
6126 int n = readconf_readtime(sub, 0, FALSE);
6129 expand_string_message = string_sprintf("string \"%s\" is not an "
6130 "Exim time interval in \"%s\" operator", sub, name);
6133 sprintf(CS var_buffer, "%d", n);
6134 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6138 case EOP_TIME_INTERVAL:
6141 uschar *t = read_number(&n, sub);
6142 if (*t != 0) /* Not A Number*/
6144 expand_string_message = string_sprintf("string \"%s\" is not a "
6145 "positive number in \"%s\" operator", sub, name);
6148 t = readconf_printtime(n);
6149 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6153 /* Convert string to base64 encoding */
6157 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6158 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6162 /* strlen returns the length of the string */
6167 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6168 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6172 /* length_n or l_n takes just the first n characters or the whole string,
6173 whichever is the shorter;
6175 substr_m_n, and s_m_n take n characters from offset m; negative m take
6176 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6177 takes the rest, either to the right or to the left.
6179 hash_n or h_n makes a hash of length n from the string, yielding n
6180 characters from the set a-z; hash_n_m makes a hash of length n, but
6181 uses m characters from the set a-zA-Z0-9.
6183 nhash_n returns a single number between 0 and n-1 (in text form), while
6184 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6185 between 0 and n-1 and the second between 0 and m-1. */
6205 expand_string_message = string_sprintf("missing values after %s",
6210 /* "length" has only one argument, effectively being synonymous with
6213 if (c == EOP_LENGTH || c == EOP_L)
6219 /* The others have one or two arguments; for "substr" the first may be
6220 negative. The second being negative means "not supplied". */
6225 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6228 /* Read up to two numbers, separated by underscores */
6233 if (arg != ret && *arg == '_' && pn == &value1)
6237 if (arg[1] != 0) arg++;
6239 else if (!isdigit(*arg))
6241 expand_string_message =
6242 string_sprintf("non-digit after underscore in \"%s\"", name);
6245 else *pn = (*pn)*10 + *arg++ - '0';
6249 /* Perform the required operation */
6252 (c == EOP_HASH || c == EOP_H)?
6253 compute_hash(sub, value1, value2, &len) :
6254 (c == EOP_NHASH || c == EOP_NH)?
6255 compute_nhash(sub, value1, value2, &len) :
6256 extract_substr(sub, value1, value2, &len);
6258 if (ret == NULL) goto EXPAND_FAILED;
6259 yield = string_cat(yield, &size, &ptr, ret, len);
6269 uschar **modetable[3];
6274 if ((expand_forbid & RDO_EXISTS) != 0)
6276 expand_string_message = US"Use of the stat() expansion is not permitted";
6280 if (stat(CS sub, &st) < 0)
6282 expand_string_message = string_sprintf("stat(%s) failed: %s",
6283 sub, strerror(errno));
6287 switch (mode & S_IFMT)
6289 case S_IFIFO: smode[0] = 'p'; break;
6290 case S_IFCHR: smode[0] = 'c'; break;
6291 case S_IFDIR: smode[0] = 'd'; break;
6292 case S_IFBLK: smode[0] = 'b'; break;
6293 case S_IFREG: smode[0] = '-'; break;
6294 default: smode[0] = '?'; break;
6297 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6298 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6299 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6301 for (i = 0; i < 3; i++)
6303 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6308 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6309 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6310 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6311 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6312 (long)st.st_gid, st.st_size, (long)st.st_atime,
6313 (long)st.st_mtime, (long)st.st_ctime);
6314 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6318 /* vaguely random number less than N */
6322 int_eximarith_t max;
6325 max = expand_string_integer(sub, TRUE);
6326 if (expand_string_message != NULL)
6328 s = string_sprintf("%d", vaguely_random_number((int)max));
6329 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6333 /* Reverse IP, including IPv6 to dotted-nibble */
6335 case EOP_REVERSE_IP:
6337 int family, maskptr;
6338 uschar reversed[128];
6340 family = string_is_ip_address(sub, &maskptr);
6343 expand_string_message = string_sprintf(
6344 "reverse_ip() not given an IP address [%s]", sub);
6347 invert_address(reversed, sub);
6348 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6352 /* Unknown operator */
6355 expand_string_message =
6356 string_sprintf("unknown expansion operator \"%s\"", name);
6361 /* Handle a plain name. If this is the first thing in the expansion, release
6362 the pre-allocated buffer. If the result data is known to be in a new buffer,
6363 newsize will be set to the size of that buffer, and we can just point at that
6364 store instead of copying. Many expansion strings contain just one reference,
6365 so this is a useful optimization, especially for humungous headers
6366 ($message_headers). */
6374 if (resetok) store_reset(yield);
6378 value = find_variable(name, FALSE, skipping, &newsize);
6381 expand_string_message =
6382 string_sprintf("unknown variable in \"${%s}\"", name);
6383 check_variable_error_message(name);
6386 len = Ustrlen(value);
6387 if (yield == NULL && newsize != 0)
6393 else yield = string_cat(yield, &size, &ptr, value, len);
6397 /* Else there's something wrong */
6399 expand_string_message =
6400 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6401 "in a variable reference)", name);
6405 /* If we hit the end of the string when ket_ends is set, there is a missing
6406 terminating brace. */
6408 if (ket_ends && *s == 0)
6410 expand_string_message = malformed_header?
6411 US"missing } at end of string - could be header name not terminated by colon"
6413 US"missing } at end of string";
6417 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6418 added to the string. If so, set up an empty string. Add a terminating zero. If
6419 left != NULL, return a pointer to the terminator. */
6421 if (yield == NULL) yield = store_get(1);
6423 if (left != NULL) *left = s;
6425 /* Any stacking store that was used above the final string is no longer needed.
6426 In many cases the final string will be the first one that was got and so there
6427 will be optimal store usage. */
6429 if (resetok) store_reset(yield + ptr + 1);
6430 else if (resetok_p) *resetok_p = FALSE;
6434 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6436 if (skipping) debug_printf("skipping: result is not used\n");
6440 /* This is the failure exit: easiest to program with a goto. We still need
6441 to update the pointer to the terminator, for cases of nested calls with "fail".
6444 EXPAND_FAILED_CURLY:
6445 expand_string_message = malformed_header?
6446 US"missing or misplaced { or } - could be header name not terminated by colon"
6448 US"missing or misplaced { or }";
6450 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6451 that is a bad idea, because expand_string_message is in dynamic store. */
6454 if (left != NULL) *left = s;
6457 debug_printf("failed to expand: %s\n", string);
6458 debug_printf(" error message: %s\n", expand_string_message);
6459 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6461 if (resetok_p) *resetok_p = resetok;
6466 /* This is the external function call. Do a quick check for any expansion
6467 metacharacters, and if there are none, just return the input string.
6469 Argument: the string to be expanded
6470 Returns: the expanded string, or NULL if expansion failed; if failure was
6471 due to a lookup deferring, search_find_defer will be TRUE
6475 expand_string(uschar *string)
6477 search_find_defer = FALSE;
6478 malformed_header = FALSE;
6479 return (Ustrpbrk(string, "$\\") == NULL)? string :
6480 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
6485 /*************************************************
6487 *************************************************/
6489 /* Now and again we want to expand a string and be sure that the result is in a
6490 new bit of store. This function does that.
6492 Argument: the string to be expanded
6493 Returns: the expanded string, always in a new bit of store, or NULL
6497 expand_string_copy(uschar *string)
6499 uschar *yield = expand_string(string);
6500 if (yield == string) yield = string_copy(string);
6506 /*************************************************
6507 * Expand and interpret as an integer *
6508 *************************************************/
6510 /* Expand a string, and convert the result into an integer.
6513 string the string to be expanded
6514 isplus TRUE if a non-negative number is expected
6516 Returns: the integer value, or
6517 -1 for an expansion error ) in both cases, message in
6518 -2 for an integer interpretation error ) expand_string_message
6519 expand_string_message is set NULL for an OK integer
6523 expand_string_integer(uschar *string, BOOL isplus)
6525 int_eximarith_t value;
6526 uschar *s = expand_string(string);
6527 uschar *msg = US"invalid integer \"%s\"";
6530 /* If expansion failed, expand_string_message will be set. */
6532 if (s == NULL) return -1;
6534 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6535 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6536 systems, so we set it zero ourselves. */
6539 expand_string_message = NULL; /* Indicates no error */
6541 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6542 equal to 0. Unfortunately, people actually relied upon that, so preserve
6543 the behaviour explicitly. Stripping leading whitespace is a harmless
6544 noop change since strtol skips it anyway (provided that there is a number
6548 while (isspace(*s)) ++s;
6552 debug_printf("treating blank string as number 0\n");
6557 value = strtoll(CS s, CSS &endptr, 10);
6561 msg = US"integer expected but \"%s\" found";
6563 else if (value < 0 && isplus)
6565 msg = US"non-negative integer expected but \"%s\" found";
6569 switch (tolower(*endptr))
6574 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
6579 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
6580 else value *= 1024*1024;
6584 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
6585 else value *= 1024*1024*1024;
6589 if (errno == ERANGE)
6590 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6593 while (isspace(*endptr)) endptr++;
6594 if (*endptr == 0) return value;
6598 expand_string_message = string_sprintf(CS msg, s);
6603 /*************************************************
6604 **************************************************
6605 * Stand-alone test program *
6606 **************************************************
6607 *************************************************/
6613 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6615 int ovector[3*(EXPAND_MAXN+1)];
6616 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6617 ovector, sizeof(ovector)/sizeof(int));
6618 BOOL yield = n >= 0;
6619 if (n == 0) n = EXPAND_MAXN + 1;
6623 expand_nmax = (setup < 0)? 0 : setup + 1;
6624 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6626 expand_nstring[expand_nmax] = subject + ovector[nn];
6627 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6635 int main(int argc, uschar **argv)
6638 uschar buffer[1024];
6640 debug_selector = D_v;
6641 debug_file = stderr;
6642 debug_fd = fileno(debug_file);
6643 big_buffer = malloc(big_buffer_size);
6645 for (i = 1; i < argc; i++)
6647 if (argv[i][0] == '+')
6649 debug_trace_memory = 2;
6652 if (isdigit(argv[i][0]))
6653 debug_selector = Ustrtol(argv[i], NULL, 0);
6655 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6659 eldap_default_servers = argv[i];
6662 mysql_servers = argv[i];
6665 pgsql_servers = argv[i];
6667 #ifdef EXPERIMENTAL_REDIS
6668 redis_servers = argv[i];
6672 else opt_perl_startup = argv[i];
6676 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6678 expand_nstring[1] = US"string 1....";
6679 expand_nlength[1] = 8;
6683 if (opt_perl_startup != NULL)
6686 printf("Starting Perl interpreter\n");
6687 errstr = init_perl(opt_perl_startup);
6690 printf("** error in perl_startup code: %s\n", errstr);
6691 return EXIT_FAILURE;
6694 #endif /* EXIM_PERL */
6696 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6698 void *reset_point = store_get(0);
6699 uschar *yield = expand_string(buffer);
6702 printf("%s\n", yield);
6703 store_reset(reset_point);
6707 if (search_find_defer) printf("search_find deferred\n");
6708 printf("Failed: %s\n", expand_string_message);
6709 if (expand_string_forcedfail) printf("Forced failure\n");
6721 /* End of expand.c */