1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, BOOL);
19 #ifndef SUPPORT_CRYPTEQ
20 #define SUPPORT_CRYPTEQ
25 #include "lookups/ldap.h"
28 #ifdef SUPPORT_CRYPTEQ
33 extern char* crypt16(char*, char*);
37 /* The handling of crypt16() is a mess. I will record below the analysis of the
38 mess that was sent to me. We decided, however, to make changing this very low
39 priority, because in practice people are moving away from the crypt()
40 algorithms nowadays, so it doesn't seem worth it.
43 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
44 the first 8 characters of the password using a 20-round version of crypt
45 (standard crypt does 25 rounds). It then crypts the next 8 characters,
46 or an empty block if the password is less than 9 characters, using a
47 20-round version of crypt and the same salt as was used for the first
48 block. Charaters after the first 16 are ignored. It always generates
49 a 16-byte hash, which is expressed together with the salt as a string
50 of 24 base 64 digits. Here are some links to peruse:
52 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
53 http://seclists.org/bugtraq/1999/Mar/0076.html
55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
56 and OSF/1. This is the same as the standard crypt if given a password
57 of 8 characters or less. If given more, it first does the same as crypt
58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
59 using as salt the first two base 64 digits from the first hash block.
60 If the password is more than 16 characters then it crypts the 17th to 24th
61 characters using as salt the first two base 64 digits from the second hash
62 block. And so on: I've seen references to it cutting off the password at
63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0109.html
67 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
68 TET1_html/sec.c222.html#no_id_208
70 Exim has something it calls "crypt16". It will either use a native
71 crypt16 or its own implementation. A native crypt16 will presumably
72 be the one that I called "crypt16" above. The internal "crypt16"
73 function, however, is a two-block-maximum implementation of what I called
74 "bigcrypt". The documentation matches the internal code.
76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
77 that crypt16 and bigcrypt were different things.
79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
80 to whatever it is using under that name. This unfortunately sets a
81 precedent for using "{crypt16}" to identify two incompatible algorithms
82 whose output can't be distinguished. With "{crypt16}" thus rendered
83 ambiguous, I suggest you deprecate it and invent two new identifiers
84 for the two algorithms.
86 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
87 of the password separately means they can be cracked separately, so
88 the double-length hash only doubles the cracking effort instead of
89 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
150 /* Tables of operator names, and corresponding switch numbers. The names must be
151 in alphabetical order. There are two tables, because underscore is used in some
152 cases to introduce arguments, whereas for other it is part of the name. This is
153 an historical mis-design. */
155 static uschar *op_table_underscore[] = {
158 US"quote_local_part",
166 EOP_QUOTE_LOCAL_PART,
171 static uschar *op_table_main[] = {
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
1803 Returns: 0 OK; string pointer updated
1804 1 curly bracketing error (too few arguments)
1805 2 too many arguments (only if check_end is set); message set
1806 3 other error (expansion failure)
1810 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1811 BOOL check_end, uschar *name)
1816 while (isspace(*s)) s++;
1817 for (i = 0; i < n; i++)
1821 if (i < m) return 1;
1825 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1826 if (sub[i] == NULL) return 3;
1827 if (*s++ != '}') return 1;
1828 while (isspace(*s)) s++;
1830 if (check_end && *s++ != '}')
1834 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1835 "(max is %d)", name, n);
1848 /*************************************************
1849 * Elaborate message for bad variable *
1850 *************************************************/
1852 /* For the "unknown variable" message, take a look at the variable's name, and
1853 give additional information about possible ACL variables. The extra information
1854 is added on to expand_string_message.
1856 Argument: the name of the variable
1861 check_variable_error_message(uschar *name)
1863 if (Ustrncmp(name, "acl_", 4) == 0)
1864 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1865 (name[4] == 'c' || name[4] == 'm')?
1867 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1868 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1870 US"user-defined ACL variables must start acl_c or acl_m");
1876 Load args from sub array to globals, and call acl_check().
1877 Sub array will be corrupted on return.
1879 Returns: OK access is granted by an ACCEPT verb
1880 DISCARD access is granted by a DISCARD verb
1881 FAIL access is denied
1882 FAIL_DROP access is denied; drop the connection
1883 DEFER can't tell at the moment
1887 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
1891 int sav_narg = acl_narg;
1893 extern int acl_where;
1895 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
1896 for (i = 0; i < nsub && sub[i+1]; i++)
1899 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
1900 sub[i+1] = tmp; /* stash the old args using our caller's storage */
1905 sub[i+1] = acl_arg[i];
1906 acl_arg[i++] = NULL;
1910 debug_printf("expanding: acl: %s arg: %s%s\n",
1912 acl_narg>0 ? acl_arg[0] : US"<none>",
1913 acl_narg>1 ? " +more" : "");
1915 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
1917 for (i = 0; i < nsub; i++)
1918 acl_arg[i] = sub[i+1]; /* restore old args */
1919 acl_narg = sav_narg;
1927 /*************************************************
1928 * Read and evaluate a condition *
1929 *************************************************/
1933 s points to the start of the condition text
1934 yield points to a BOOL to hold the result of the condition test;
1935 if NULL, we are just reading through a condition that is
1936 part of an "or" combination to check syntax, or in a state
1937 where the answer isn't required
1939 Returns: a pointer to the first character after the condition, or
1944 eval_condition(uschar *s, BOOL *yield)
1946 BOOL testfor = TRUE;
1947 BOOL tempcond, combined_cond;
1949 BOOL sub2_honour_dollar = TRUE;
1950 int i, rc, cond_type, roffset;
1951 int_eximarith_t num[2];
1952 struct stat statbuf;
1957 const uschar *rerror;
1961 while (isspace(*s)) s++;
1962 if (*s == '!') { testfor = !testfor; s++; } else break;
1965 /* Numeric comparisons are symbolic */
1967 if (*s == '=' || *s == '>' || *s == '<')
1979 /* All other conditions are named */
1981 else s = read_name(name, 256, s, US"_");
1983 /* If we haven't read a name, it means some non-alpha character is first. */
1987 expand_string_message = string_sprintf("condition name expected, "
1988 "but found \"%.16s\"", s);
1992 /* Find which condition we are dealing with, and switch on it */
1994 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1997 /* def: tests for a non-empty variable, or for the existence of a header. If
1998 yield == NULL we are in a skipping state, and don't care about the answer. */
2003 expand_string_message = US"\":\" expected after \"def\"";
2007 s = read_name(name, 256, s+1, US"_");
2009 /* Test for a header's existence. If the name contains a closing brace
2010 character, this may be a user error where the terminating colon has been
2011 omitted. Set a flag to adjust a subsequent error message in this case. */
2013 if (Ustrncmp(name, "h_", 2) == 0 ||
2014 Ustrncmp(name, "rh_", 3) == 0 ||
2015 Ustrncmp(name, "bh_", 3) == 0 ||
2016 Ustrncmp(name, "header_", 7) == 0 ||
2017 Ustrncmp(name, "rheader_", 8) == 0 ||
2018 Ustrncmp(name, "bheader_", 8) == 0)
2020 s = read_header_name(name, 256, s);
2021 /* {-for-text-editors */
2022 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2023 if (yield != NULL) *yield =
2024 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2027 /* Test for a variable's having a non-empty value. A non-existent variable
2028 causes an expansion failure. */
2032 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2035 expand_string_message = (name[0] == 0)?
2036 string_sprintf("variable name omitted after \"def:\"") :
2037 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2038 check_variable_error_message(name);
2041 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2047 /* first_delivery tests for first delivery attempt */
2049 case ECOND_FIRST_DELIVERY:
2050 if (yield != NULL) *yield = deliver_firsttime == testfor;
2054 /* queue_running tests for any process started by a queue runner */
2056 case ECOND_QUEUE_RUNNING:
2057 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2061 /* exists: tests for file existence
2062 isip: tests for any IP address
2063 isip4: tests for an IPv4 address
2064 isip6: tests for an IPv6 address
2065 pam: does PAM authentication
2066 radius: does RADIUS authentication
2067 ldapauth: does LDAP authentication
2068 pwcheck: does Cyrus SASL pwcheck authentication
2077 case ECOND_LDAPAUTH:
2080 while (isspace(*s)) s++;
2081 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2083 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
2084 if (sub[0] == NULL) return NULL;
2085 /* {-for-text-editors */
2086 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2088 if (yield == NULL) return s; /* No need to run the test if skipping */
2093 if ((expand_forbid & RDO_EXISTS) != 0)
2095 expand_string_message = US"File existence tests are not permitted";
2098 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2104 rc = string_is_ip_address(sub[0], NULL);
2105 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2106 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2109 /* Various authentication tests - all optionally compiled */
2113 rc = auth_call_pam(sub[0], &expand_string_message);
2116 goto COND_FAILED_NOT_COMPILED;
2117 #endif /* SUPPORT_PAM */
2120 #ifdef RADIUS_CONFIG_FILE
2121 rc = auth_call_radius(sub[0], &expand_string_message);
2124 goto COND_FAILED_NOT_COMPILED;
2125 #endif /* RADIUS_CONFIG_FILE */
2127 case ECOND_LDAPAUTH:
2130 /* Just to keep the interface the same */
2132 int old_pool = store_pool;
2133 store_pool = POOL_SEARCH;
2134 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2135 &expand_string_message, &do_cache);
2136 store_pool = old_pool;
2140 goto COND_FAILED_NOT_COMPILED;
2141 #endif /* LOOKUP_LDAP */
2144 #ifdef CYRUS_PWCHECK_SOCKET
2145 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2148 goto COND_FAILED_NOT_COMPILED;
2149 #endif /* CYRUS_PWCHECK_SOCKET */
2151 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2152 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2154 if (rc == ERROR || rc == DEFER) return NULL;
2155 *yield = (rc == OK) == testfor;
2161 /* call ACL (in a conditional context). Accept true, deny false.
2162 Defer is a forced-fail. Anything set by message= goes to $value.
2163 Up to ten parameters are used; we use the braces round the name+args
2164 like the saslauthd condition does, to permit a variable number of args.
2165 See also the expansion-item version EITEM_ACL and the traditional
2166 acl modifier ACLC_ACL.
2170 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2177 while (isspace(*s)) s++;
2178 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2180 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2181 &s, yield == NULL, TRUE, US"acl"))
2183 case 1: expand_string_message = US"too few arguments or bracketing "
2186 case 3: return NULL;
2189 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2194 lookup_value = NULL;
2197 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2198 lookup_value[ptr] = '\0';
2200 *yield = cond == testfor;
2204 expand_string_forcedfail = TRUE;
2206 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2213 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2215 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
2217 However, the last two are optional. That is why the whole set is enclosed
2218 in their own set of braces. */
2220 case ECOND_SASLAUTHD:
2221 #ifndef CYRUS_SASLAUTHD_SOCKET
2222 goto COND_FAILED_NOT_COMPILED;
2224 while (isspace(*s)) s++;
2225 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2226 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2228 case 1: expand_string_message = US"too few arguments or bracketing "
2229 "error for saslauthd";
2231 case 3: return NULL;
2233 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2237 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2238 &expand_string_message);
2239 if (rc == ERROR || rc == DEFER) return NULL;
2240 *yield = (rc == OK) == testfor;
2243 #endif /* CYRUS_SASLAUTHD_SOCKET */
2246 /* symbolic operators for numeric and string comparison, and a number of
2247 other operators, all requiring two arguments.
2249 crypteq: encrypts plaintext and compares against an encrypted text,
2250 using crypt(), crypt16(), MD5 or SHA-1
2251 inlist/inlisti: checks if first argument is in the list of the second
2252 match: does a regular expression match and sets up the numerical
2253 variables if it succeeds
2254 match_address: matches in an address list
2255 match_domain: matches in a domain list
2256 match_ip: matches a host list that is restricted to IP addresses
2257 match_local_part: matches in a local part list
2260 case ECOND_MATCH_ADDRESS:
2261 case ECOND_MATCH_DOMAIN:
2262 case ECOND_MATCH_IP:
2263 case ECOND_MATCH_LOCAL_PART:
2264 #ifndef EXPAND_LISTMATCH_RHS
2265 sub2_honour_dollar = FALSE;
2274 case ECOND_NUM_L: /* Numerical comparisons */
2281 case ECOND_STR_LT: /* String comparisons */
2292 for (i = 0; i < 2; i++)
2294 /* Sometimes, we don't expand substrings; too many insecure configurations
2295 created using match_address{}{} and friends, where the second param
2296 includes information from untrustworthy sources. */
2297 BOOL honour_dollar = TRUE;
2298 if ((i > 0) && !sub2_honour_dollar)
2299 honour_dollar = FALSE;
2301 while (isspace(*s)) s++;
2304 if (i == 0) goto COND_FAILED_CURLY_START;
2305 expand_string_message = string_sprintf("missing 2nd string in {} "
2306 "after \"%s\"", name);
2309 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2311 if (sub[i] == NULL) return NULL;
2312 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2314 /* Convert to numerical if required; we know that the names of all the
2315 conditions that compare numbers do not start with a letter. This just saves
2316 checking for them individually. */
2318 if (!isalpha(name[0]) && yield != NULL)
2324 debug_printf("empty string cast to zero for numerical comparison\n");
2328 num[i] = expand_string_integer(sub[i], FALSE);
2329 if (expand_string_message != NULL) return NULL;
2334 /* Result not required */
2336 if (yield == NULL) return s;
2338 /* Do an appropriate comparison */
2344 tempcond = (num[0] == num[1]);
2348 tempcond = (num[0] > num[1]);
2352 tempcond = (num[0] >= num[1]);
2356 tempcond = (num[0] < num[1]);
2360 tempcond = (num[0] <= num[1]);
2364 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2368 tempcond = (strcmpic(sub[0], sub[1]) < 0);
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);
2403 case ECOND_MATCH: /* Regular expression match */
2404 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2408 expand_string_message = string_sprintf("regular expression error in "
2409 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2412 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2415 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2416 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2417 goto MATCHED_SOMETHING;
2419 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2420 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2421 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2422 goto MATCHED_SOMETHING;
2424 case ECOND_MATCH_IP: /* Match IP address in a host list */
2425 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2427 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2433 unsigned int *nullcache = NULL;
2434 check_host_block cb;
2436 cb.host_name = US"";
2437 cb.host_address = sub[0];
2439 /* If the host address starts off ::ffff: it is an IPv6 address in
2440 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2443 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2444 cb.host_address + 7 : cb.host_address;
2446 rc = match_check_list(
2447 &sub[1], /* the list */
2448 0, /* separator character */
2449 &hostlist_anchor, /* anchor pointer */
2450 &nullcache, /* cache pointer */
2451 check_host, /* function for testing */
2452 &cb, /* argument for function */
2453 MCL_HOST, /* type of check */
2454 sub[0], /* text for debugging */
2455 NULL); /* where to pass back data */
2457 goto MATCHED_SOMETHING;
2459 case ECOND_MATCH_LOCAL_PART:
2460 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2461 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2476 expand_string_message = string_sprintf("unable to complete match "
2477 "against \"%s\": %s", sub[1], search_error_message);
2483 /* Various "encrypted" comparisons. If the second string starts with
2484 "{" then an encryption type is given. Default to crypt() or crypt16()
2485 (build-time choice). */
2486 /* }-for-text-editors */
2489 #ifndef SUPPORT_CRYPTEQ
2490 goto COND_FAILED_NOT_COMPILED;
2492 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2494 int sublen = Ustrlen(sub[1]+5);
2499 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2501 /* If the length that we are comparing against is 24, the MD5 digest
2502 is expressed as a base64 string. This is the way LDAP does it. However,
2503 some other software uses a straightforward hex representation. We assume
2504 this if the length is 32. Other lengths fail. */
2508 uschar *coded = auth_b64encode((uschar *)digest, 16);
2509 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2510 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2511 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2513 else if (sublen == 32)
2517 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2519 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2520 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2521 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2525 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2526 "fail\n crypted=%s\n", sub[1]+5);
2531 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2533 int sublen = Ustrlen(sub[1]+6);
2538 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2540 /* If the length that we are comparing against is 28, assume the SHA1
2541 digest is expressed as a base64 string. If the length is 40, assume a
2542 straightforward hex representation. Other lengths fail. */
2546 uschar *coded = auth_b64encode((uschar *)digest, 20);
2547 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2548 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2549 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2551 else if (sublen == 40)
2555 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2557 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2558 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2559 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2563 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2564 "fail\n crypted=%s\n", sub[1]+6);
2569 else /* {crypt} or {crypt16} and non-{ at start */
2570 /* }-for-text-editors */
2575 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2580 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2585 else if (sub[1][0] == '{') /* }-for-text-editors */
2587 expand_string_message = string_sprintf("unknown encryption mechanism "
2588 "in \"%s\"", sub[1]);
2594 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2595 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2596 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2600 #define XSTR(s) STR(s)
2601 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2602 " subject=%s\n crypted=%s\n",
2603 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2608 /* If the encrypted string contains fewer than two characters (for the
2609 salt), force failure. Otherwise we get false positives: with an empty
2610 string the yield of crypt() is an empty string! */
2612 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2613 (Ustrcmp(coded, sub[1]) == 0);
2616 #endif /* SUPPORT_CRYPTEQ */
2622 uschar *save_iterate_item = iterate_item;
2623 int (*compare)(const uschar *, const uschar *);
2626 if (cond_type == ECOND_INLISTI)
2629 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2631 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2632 if (compare(sub[0], iterate_item) == 0)
2637 iterate_item = save_iterate_item;
2640 } /* Switch for comparison conditions */
2642 *yield = tempcond == testfor;
2643 return s; /* End of comparison conditions */
2646 /* and/or: computes logical and/or of several conditions */
2650 subcondptr = (yield == NULL)? NULL : &tempcond;
2651 combined_cond = (cond_type == ECOND_AND);
2653 while (isspace(*s)) s++;
2654 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2658 while (isspace(*s)) s++;
2659 /* {-for-text-editors */
2660 if (*s == '}') break;
2661 if (*s != '{') /* }-for-text-editors */
2663 expand_string_message = string_sprintf("each subcondition "
2664 "inside an \"%s{...}\" condition must be in its own {}", name);
2668 s = eval_condition(s+1, subcondptr);
2671 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2672 expand_string_message, name);
2675 while (isspace(*s)) s++;
2677 /* {-for-text-editors */
2680 /* {-for-text-editors */
2681 expand_string_message = string_sprintf("missing } at end of condition "
2682 "inside \"%s\" group", name);
2688 if (cond_type == ECOND_AND)
2690 combined_cond &= tempcond;
2691 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2692 } /* evaluate any more */
2695 combined_cond |= tempcond;
2696 if (combined_cond) subcondptr = NULL; /* once true, don't */
2697 } /* evaluate any more */
2701 if (yield != NULL) *yield = (combined_cond == testfor);
2705 /* forall/forany: iterates a condition with different values */
2711 uschar *save_iterate_item = iterate_item;
2713 while (isspace(*s)) s++;
2714 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2715 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2716 if (sub[0] == NULL) return NULL;
2717 /* {-for-text-editors */
2718 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2720 while (isspace(*s)) s++;
2721 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2725 /* Call eval_condition once, with result discarded (as if scanning a
2726 "false" part). This allows us to find the end of the condition, because if
2727 the list it empty, we won't actually evaluate the condition for real. */
2729 s = eval_condition(sub[1], NULL);
2732 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2733 expand_string_message, name);
2736 while (isspace(*s)) s++;
2738 /* {-for-text-editors */
2741 /* {-for-text-editors */
2742 expand_string_message = string_sprintf("missing } at end of condition "
2743 "inside \"%s\"", name);
2747 if (yield != NULL) *yield = !testfor;
2748 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2750 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2751 if (eval_condition(sub[1], &tempcond) == NULL)
2753 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2754 expand_string_message, name);
2755 iterate_item = save_iterate_item;
2758 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2759 tempcond? "true":"false");
2761 if (yield != NULL) *yield = (tempcond == testfor);
2762 if (tempcond == (cond_type == ECOND_FORANY)) break;
2765 iterate_item = save_iterate_item;
2770 /* The bool{} expansion condition maps a string to boolean.
2771 The values supported should match those supported by the ACL condition
2772 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2773 of true/false. Note that Router "condition" rules have a different
2774 interpretation, where general data can be used and only a few values
2776 Note that readconf.c boolean matching, for boolean configuration options,
2777 only matches true/yes/false/no.
2778 The bool_lax{} condition matches the Router logic, which is much more
2781 case ECOND_BOOL_LAX:
2787 BOOL boolvalue = FALSE;
2788 while (isspace(*s)) s++;
2789 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2790 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2791 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2793 case 1: expand_string_message = string_sprintf(
2794 "too few arguments or bracketing error for %s",
2798 case 3: return NULL;
2801 while (isspace(*t)) t++;
2805 /* trailing whitespace: seems like a good idea to ignore it too */
2807 while (isspace(*t2)) t2--;
2808 if (t2 != (t + len))
2815 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2816 /* logic for the lax case from expand_check_condition(), which also does
2817 expands, and the logic is both short and stable enough that there should
2818 be no maintenance burden from replicating it. */
2821 else if (Ustrspn(t, "0123456789") == len)
2823 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2824 /* expand_check_condition only does a literal string "0" check */
2825 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2828 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2830 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2832 else if (cond_type == ECOND_BOOL_LAX)
2836 expand_string_message = string_sprintf("unrecognised boolean "
2840 if (yield != NULL) *yield = (boolvalue == testfor);
2844 /* Unknown condition */
2847 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2849 } /* End switch on condition type */
2851 /* Missing braces at start and end of data */
2853 COND_FAILED_CURLY_START:
2854 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2857 COND_FAILED_CURLY_END:
2858 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2862 /* A condition requires code that is not compiled */
2864 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2865 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2866 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2867 COND_FAILED_NOT_COMPILED:
2868 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2877 /*************************************************
2878 * Save numerical variables *
2879 *************************************************/
2881 /* This function is called from items such as "if" that want to preserve and
2882 restore the numbered variables.
2885 save_expand_string points to an array of pointers to set
2886 save_expand_nlength points to an array of ints for the lengths
2888 Returns: the value of expand max to save
2892 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2895 for (i = 0; i <= expand_nmax; i++)
2897 save_expand_nstring[i] = expand_nstring[i];
2898 save_expand_nlength[i] = expand_nlength[i];
2905 /*************************************************
2906 * Restore numerical variables *
2907 *************************************************/
2909 /* This function restored saved values of numerical strings.
2912 save_expand_nmax the number of strings to restore
2913 save_expand_string points to an array of pointers
2914 save_expand_nlength points to an array of ints
2920 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2921 int *save_expand_nlength)
2924 expand_nmax = save_expand_nmax;
2925 for (i = 0; i <= expand_nmax; i++)
2927 expand_nstring[i] = save_expand_nstring[i];
2928 expand_nlength[i] = save_expand_nlength[i];
2936 /*************************************************
2937 * Handle yes/no substrings *
2938 *************************************************/
2940 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2941 alternative substrings that depend on whether or not the condition was true,
2942 or the lookup or extraction succeeded. The substrings always have to be
2943 expanded, to check their syntax, but "skipping" is set when the result is not
2944 needed - this avoids unnecessary nested lookups.
2947 skipping TRUE if we were skipping when this item was reached
2948 yes TRUE if the first string is to be used, else use the second
2949 save_lookup a value to put back into lookup_value before the 2nd expansion
2950 sptr points to the input string pointer
2951 yieldptr points to the output string pointer
2952 sizeptr points to the output string size
2953 ptrptr points to the output string pointer
2954 type "lookup" or "if" or "extract" or "run", for error message
2956 Returns: 0 OK; lookup_value has been reset to save_lookup
2958 2 expansion failed because of bracketing error
2962 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2963 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2966 uschar *s = *sptr; /* Local value */
2967 uschar *sub1, *sub2;
2969 /* If there are no following strings, we substitute the contents of $value for
2970 lookups and for extractions in the success case. For the ${if item, the string
2971 "true" is substituted. In the fail case, nothing is substituted for all three
2974 while (isspace(*s)) s++;
2979 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2983 if (yes && lookup_value != NULL)
2984 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2985 Ustrlen(lookup_value));
2986 lookup_value = save_lookup;
2992 /* The first following string must be braced. */
2994 if (*s++ != '{') goto FAILED_CURLY;
2996 /* Expand the first substring. Forced failures are noticed only if we actually
2997 want this string. Set skipping in the call in the fail case (this will always
2998 be the case if we were already skipping). */
3000 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
3001 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3002 expand_string_forcedfail = FALSE;
3003 if (*s++ != '}') goto FAILED_CURLY;
3005 /* If we want the first string, add it to the output */
3008 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3010 /* If this is called from a lookup or an extract, we want to restore $value to
3011 what it was at the start of the item, so that it has this value during the
3012 second string expansion. For the call from "if" or "run" to this function,
3013 save_lookup is set to lookup_value, so that this statement does nothing. */
3015 lookup_value = save_lookup;
3017 /* There now follows either another substring, or "fail", or nothing. This
3018 time, forced failures are noticed only if we want the second string. We must
3019 set skipping in the nested call if we don't want this string, or if we were
3020 already skipping. */
3022 while (isspace(*s)) s++;
3025 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
3026 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3027 expand_string_forcedfail = FALSE;
3028 if (*s++ != '}') goto FAILED_CURLY;
3030 /* If we want the second string, add it to the output */
3033 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3036 /* If there is no second string, but the word "fail" is present when the use of
3037 the second string is wanted, set a flag indicating it was a forced failure
3038 rather than a syntactic error. Swallow the terminating } in case this is nested
3039 inside another lookup or if or extract. */
3044 s = read_name(name, sizeof(name), s, US"_");
3045 if (Ustrcmp(name, "fail") == 0)
3047 if (!yes && !skipping)
3049 while (isspace(*s)) s++;
3050 if (*s++ != '}') goto FAILED_CURLY;
3051 expand_string_message =
3052 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3053 expand_string_forcedfail = TRUE;
3059 expand_string_message =
3060 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3065 /* All we have to do now is to check on the final closing brace. */
3067 while (isspace(*s)) s++;
3068 if (*s++ == '}') goto RETURN;
3070 /* Get here if there is a bracketing failure */
3075 /* Get here for other failures */
3080 /* Update the input pointer value before returning */
3090 /*************************************************
3091 * Handle MD5 or SHA-1 computation for HMAC *
3092 *************************************************/
3094 /* These are some wrapping functions that enable the HMAC code to be a bit
3095 cleaner. A good compiler will spot the tail recursion.
3098 type HMAC_MD5 or HMAC_SHA1
3099 remaining are as for the cryptographic hash functions
3105 chash_start(int type, void *base)
3107 if (type == HMAC_MD5)
3108 md5_start((md5 *)base);
3110 sha1_start((sha1 *)base);
3114 chash_mid(int type, void *base, uschar *string)
3116 if (type == HMAC_MD5)
3117 md5_mid((md5 *)base, string);
3119 sha1_mid((sha1 *)base, string);
3123 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3125 if (type == HMAC_MD5)
3126 md5_end((md5 *)base, string, length, digest);
3128 sha1_end((sha1 *)base, string, length, digest);
3135 /********************************************************
3136 * prvs: Get last three digits of days since Jan 1, 1970 *
3137 ********************************************************/
3139 /* This is needed to implement the "prvs" BATV reverse
3142 Argument: integer "days" offset to add or substract to
3143 or from the current number of days.
3145 Returns: pointer to string containing the last three
3146 digits of the number of days since Jan 1, 1970,
3147 modified by the offset argument, NULL if there
3148 was an error in the conversion.
3153 prvs_daystamp(int day_offset)
3155 uschar *days = store_get(32); /* Need at least 24 for cases */
3156 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3157 (time(NULL) + day_offset*86400)/86400);
3158 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3163 /********************************************************
3164 * prvs: perform HMAC-SHA1 computation of prvs bits *
3165 ********************************************************/
3167 /* This is needed to implement the "prvs" BATV reverse
3171 address RFC2821 Address to use
3172 key The key to use (must be less than 64 characters
3174 key_num Single-digit key number to use. Defaults to
3177 Returns: pointer to string containing the first three
3178 bytes of the final hash in hex format, NULL if
3179 there was an error in the process.
3183 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3185 uschar *hash_source, *p;
3186 int size = 0,offset = 0,i;
3188 void *use_base = &sha1_base;
3189 uschar innerhash[20];
3190 uschar finalhash[20];
3191 uschar innerkey[64];
3192 uschar outerkey[64];
3193 uschar *finalhash_hex = store_get(40);
3195 if (key_num == NULL)
3198 if (Ustrlen(key) > 64)
3201 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3202 string_cat(hash_source,&size,&offset,daystamp,3);
3203 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3204 hash_source[offset] = '\0';
3206 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3208 memset(innerkey, 0x36, 64);
3209 memset(outerkey, 0x5c, 64);
3211 for (i = 0; i < Ustrlen(key); i++)
3213 innerkey[i] ^= key[i];
3214 outerkey[i] ^= key[i];
3217 chash_start(HMAC_SHA1, use_base);
3218 chash_mid(HMAC_SHA1, use_base, innerkey);
3219 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3221 chash_start(HMAC_SHA1, use_base);
3222 chash_mid(HMAC_SHA1, use_base, outerkey);
3223 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3226 for (i = 0; i < 3; i++)
3228 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3229 *p++ = hex_digits[finalhash[i] & 0x0f];
3233 return finalhash_hex;
3239 /*************************************************
3240 * Join a file onto the output string *
3241 *************************************************/
3243 /* This is used for readfile and after a run expansion. It joins the contents
3244 of a file onto the output string, globally replacing newlines with a given
3245 string (optionally). The file is closed at the end.
3249 yield pointer to the expandable string
3250 sizep pointer to the current size
3251 ptrp pointer to the current position
3252 eol newline replacement string, or NULL
3254 Returns: new value of string pointer
3258 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3261 uschar buffer[1024];
3263 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3265 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3267 int len = Ustrlen(buffer);
3268 if (eol != NULL && buffer[len-1] == '\n') len--;
3269 yield = string_cat(yield, sizep, ptrp, buffer, len);
3270 if (buffer[len] != 0)
3271 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3274 if (yield != NULL) yield[*ptrp] = 0;
3282 /*************************************************
3283 * Evaluate numeric expression *
3284 *************************************************/
3286 /* This is a set of mutually recursive functions that evaluate an arithmetic
3287 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3288 these functions that is called from elsewhere is eval_expr, whose interface is:
3291 sptr pointer to the pointer to the string - gets updated
3292 decimal TRUE if numbers are to be assumed decimal
3293 error pointer to where to put an error message - must be NULL on input
3294 endket TRUE if ')' must terminate - FALSE for external call
3296 Returns: on success: the value of the expression, with *error still NULL
3297 on failure: an undefined value, with *error = a message
3300 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3303 static int_eximarith_t
3304 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3307 int_eximarith_t x = eval_op_or(&s, decimal, error);
3313 *error = US"expecting closing parenthesis";
3315 while (isspace(*(++s)));
3317 else if (*s != 0) *error = US"expecting operator";
3324 static int_eximarith_t
3325 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3330 while (isspace(*s)) s++;
3335 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3337 switch (tolower(*s))
3340 case 'k': n *= 1024; s++; break;
3341 case 'm': n *= 1024*1024; s++; break;
3342 case 'g': n *= 1024*1024*1024; s++; break;
3344 while (isspace (*s)) s++;
3349 n = eval_expr(&s, decimal, error, 1);
3353 *error = US"expecting number or opening parenthesis";
3361 static int_eximarith_t
3362 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3366 while (isspace(*s)) s++;
3367 if (*s == '+' || *s == '-' || *s == '~')
3370 x = eval_op_unary(&s, decimal, error);
3371 if (op == '-') x = -x;
3372 else if (op == '~') x = ~x;
3376 x = eval_number(&s, decimal, error);
3383 static int_eximarith_t
3384 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3387 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3390 while (*s == '*' || *s == '/' || *s == '%')
3393 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3394 if (*error != NULL) break;
3395 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3396 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3397 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3398 * -N*M is INT_MIN will yielf INT_MIN.
3399 * Since we don't support floating point, this is somewhat simpler.
3400 * Ideally, we'd return an error, but since we overflow for all other
3401 * arithmetic, consistency suggests otherwise, but what's the correct value
3402 * to use? There is none.
3403 * The C standard guarantees overflow for unsigned arithmetic but signed
3404 * overflow invokes undefined behaviour; in practice, this is overflow
3405 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3406 * that long/longlong larger than int are available, or we could just work
3407 * with larger types. We should consider whether to guarantee 32bit eval
3408 * and 64-bit working variables, with errors returned. For now ...
3409 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3410 * can just let the other invalid results occur otherwise, as they have
3411 * until now. For this one case, we can coerce.
3413 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3416 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3417 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3427 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3443 static int_eximarith_t
3444 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3447 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3450 while (*s == '+' || *s == '-')
3453 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3454 if (*error != NULL) break;
3455 if (op == '+') x += y; else x -= y;
3463 static int_eximarith_t
3464 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3467 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3470 while ((*s == '<' || *s == '>') && s[1] == s[0])
3475 y = eval_op_sum(&s, decimal, error);
3476 if (*error != NULL) break;
3477 if (op == '<') x <<= y; else x >>= y;
3485 static int_eximarith_t
3486 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3489 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3496 y = eval_op_shift(&s, decimal, error);
3497 if (*error != NULL) break;
3506 static int_eximarith_t
3507 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3510 int_eximarith_t x = eval_op_and(&s, decimal, error);
3517 y = eval_op_and(&s, decimal, error);
3518 if (*error != NULL) break;
3527 static int_eximarith_t
3528 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3531 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3538 y = eval_op_xor(&s, decimal, error);
3539 if (*error != NULL) break;
3549 /*************************************************
3551 *************************************************/
3553 /* Returns either an unchanged string, or the expanded string in stacking pool
3554 store. Interpreted sequences are:
3556 \... normal escaping rules
3557 $name substitutes the variable
3559 ${op:string} operates on the expanded string value
3560 ${item{arg1}{arg2}...} expands the args and then does the business
3561 some literal args are not enclosed in {}
3563 There are now far too many operators and item types to make it worth listing
3564 them here in detail any more.
3566 We use an internal routine recursively to handle embedded substrings. The
3567 external function follows. The yield is NULL if the expansion failed, and there
3568 are two cases: if something collapsed syntactically, or if "fail" was given
3569 as the action on a lookup failure. These can be distinguised by looking at the
3570 variable expand_string_forcedfail, which is TRUE in the latter case.
3572 The skipping flag is set true when expanding a substring that isn't actually
3573 going to be used (after "if" or "lookup") and it prevents lookups from
3574 happening lower down.
3576 Store usage: At start, a store block of the length of the input plus 64
3577 is obtained. This is expanded as necessary by string_cat(), which might have to
3578 get a new block, or might be able to expand the original. At the end of the
3579 function we can release any store above that portion of the yield block that
3580 was actually used. In many cases this will be optimal.
3582 However: if the first item in the expansion is a variable name or header name,
3583 we reset the store before processing it; if the result is in fresh store, we
3584 use that without copying. This is helpful for expanding strings like
3585 $message_headers which can get very long.
3587 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3588 since resetting the store at the end of the expansion will free store that was
3589 allocated by the plugin code as well as the slop after the expanded string. So
3590 we skip any resets if ${dlfunc has been used. The same applies for ${acl. This
3591 is an unfortunate consequence of string expansion becoming too powerful.
3594 string the string to be expanded
3595 ket_ends true if expansion is to stop at }
3596 left if not NULL, a pointer to the first character after the
3597 expansion is placed here (typically used with ket_ends)
3598 skipping TRUE for recursive calls when the value isn't actually going
3599 to be used (to allow for optimisation)
3600 honour_dollar TRUE if $ is to be expanded,
3601 FALSE if it's just another character
3603 Returns: NULL if expansion fails:
3604 expand_string_forcedfail is set TRUE if failure was forced
3605 expand_string_message contains a textual error message
3606 a pointer to the expanded string on success
3610 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3611 BOOL skipping, BOOL honour_dollar)
3614 int size = Ustrlen(string)+ 64;
3616 uschar *yield = store_get(size);
3618 uschar *save_expand_nstring[EXPAND_MAXN+1];
3619 int save_expand_nlength[EXPAND_MAXN+1];
3620 BOOL resetok = TRUE;
3622 expand_string_forcedfail = FALSE;
3623 expand_string_message = US"";
3630 /* \ escapes the next character, which must exist, or else
3631 the expansion fails. There's a special escape, \N, which causes
3632 copying of the subject verbatim up to the next \N. Otherwise,
3633 the escapes are the standard set. */
3639 expand_string_message = US"\\ at end of string";
3646 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3647 yield = string_cat(yield, &size, &ptr, t, s - t);
3648 if (*s != 0) s += 2;
3654 ch[0] = string_interpret_escape(&s);
3656 yield = string_cat(yield, &size, &ptr, ch, 1);
3662 /* Anything other than $ is just copied verbatim, unless we are
3663 looking for a terminating } character. */
3665 if (ket_ends && *s == '}') break;
3667 if (*s != '$' || !honour_dollar)
3669 yield = string_cat(yield, &size, &ptr, s++, 1);
3673 /* No { after the $ - must be a plain name or a number for string
3674 match variable. There has to be a fudge for variables that are the
3675 names of header fields preceded by "$header_" because header field
3676 names can contain any printing characters except space and colon.
3677 For those that don't like typing this much, "$h_" is a synonym for
3678 "$header_". A non-existent header yields a NULL value; nothing is
3681 if (isalpha((*(++s))))
3686 s = read_name(name, sizeof(name), s, US"_");
3688 /* If this is the first thing to be expanded, release the pre-allocated
3691 if (ptr == 0 && yield != NULL)
3693 if (resetok) store_reset(yield);
3700 if (Ustrncmp(name, "h_", 2) == 0 ||
3701 Ustrncmp(name, "rh_", 3) == 0 ||
3702 Ustrncmp(name, "bh_", 3) == 0 ||
3703 Ustrncmp(name, "header_", 7) == 0 ||
3704 Ustrncmp(name, "rheader_", 8) == 0 ||
3705 Ustrncmp(name, "bheader_", 8) == 0)
3707 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3708 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3709 s = read_header_name(name, sizeof(name), s);
3710 value = find_header(name, FALSE, &newsize, want_raw, charset);
3712 /* If we didn't find the header, and the header contains a closing brace
3713 character, this may be a user error where the terminating colon
3714 has been omitted. Set a flag to adjust the error message in this case.
3715 But there is no error here - nothing gets inserted. */
3719 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3728 value = find_variable(name, FALSE, skipping, &newsize);
3731 expand_string_message =
3732 string_sprintf("unknown variable name \"%s\"", name);
3733 check_variable_error_message(name);
3738 /* If the data is known to be in a new buffer, newsize will be set to the
3739 size of that buffer. If this is the first thing in an expansion string,
3740 yield will be NULL; just point it at the new store instead of copying. Many
3741 expansion strings contain just one reference, so this is a useful
3742 optimization, especially for humungous headers. */
3744 len = Ustrlen(value);
3745 if (yield == NULL && newsize != 0)
3751 else yield = string_cat(yield, &size, &ptr, value, len);
3759 s = read_number(&n, s);
3760 if (n >= 0 && n <= expand_nmax)
3761 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3766 /* Otherwise, if there's no '{' after $ it's an error. */
3770 expand_string_message = US"$ not followed by letter, digit, or {";
3774 /* After { there can be various things, but they all start with
3775 an initial word, except for a number for a string match variable. */
3777 if (isdigit((*(++s))))
3780 s = read_number(&n, s);
3783 expand_string_message = US"} expected after number";
3786 if (n >= 0 && n <= expand_nmax)
3787 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3794 expand_string_message = US"letter or digit expected after ${";
3798 /* Allow "-" in names to cater for substrings with negative
3799 arguments. Since we are checking for known names after { this is
3802 s = read_name(name, sizeof(name), s, US"_-");
3803 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3807 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3808 If the ACL returns accept or reject we return content set by "message ="
3809 There is currently no limit on recursion; this would have us call
3810 acl_check_internal() directly and get a current level from somewhere.
3811 See also the acl expansion condition ECOND_ACL and the traditional
3812 acl modifier ACLC_ACL.
3813 Assume that the function has side-effects on the store that must be preserved.
3817 /* ${acl {name} {arg1}{arg2}...} */
3819 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3822 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl"))
3824 case 1: goto EXPAND_FAILED_CURLY;
3826 case 3: goto EXPAND_FAILED;
3828 if (skipping) continue;
3831 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3836 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3840 expand_string_forcedfail = TRUE;
3842 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3847 /* Handle conditionals - preserve the values of the numerical expansion
3848 variables in case they get changed by a regular expression match in the
3849 condition. If not, they retain their external settings. At the end
3850 of this "if" section, they get restored to their previous values. */
3856 int save_expand_nmax =
3857 save_expand_strings(save_expand_nstring, save_expand_nlength);
3859 while (isspace(*s)) s++;
3860 next_s = eval_condition(s, skipping? NULL : &cond);
3861 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3864 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3865 cond? "true" : "false");
3869 /* The handling of "yes" and "no" result strings is now in a separate
3870 function that is also used by ${lookup} and ${extract} and ${run}. */
3872 switch(process_yesno(
3873 skipping, /* were previously skipping */
3874 cond, /* success/failure indicator */
3875 lookup_value, /* value to reset for string2 */
3876 &s, /* input pointer */
3877 &yield, /* output pointer */
3878 &size, /* output size */
3879 &ptr, /* output current point */
3880 US"if")) /* condition type */
3882 case 1: goto EXPAND_FAILED; /* when all is well, the */
3883 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3886 /* Restore external setting of expansion variables for continuation
3889 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3890 save_expand_nlength);
3894 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3895 expanding an internal string that isn't actually going to be used. All we
3896 need to do is check the syntax, so don't do a lookup at all. Preserve the
3897 values of the numerical expansion variables in case they get changed by a
3898 partial lookup. If not, they retain their external settings. At the end
3899 of this "lookup" section, they get restored to their previous values. */
3903 int stype, partial, affixlen, starflags;
3904 int expand_setup = 0;
3906 uschar *key, *filename, *affix;
3907 uschar *save_lookup_value = lookup_value;
3908 int save_expand_nmax =
3909 save_expand_strings(save_expand_nstring, save_expand_nlength);
3911 if ((expand_forbid & RDO_LOOKUP) != 0)
3913 expand_string_message = US"lookup expansions are not permitted";
3917 /* Get the key we are to look up for single-key+file style lookups.
3918 Otherwise set the key NULL pro-tem. */
3920 while (isspace(*s)) s++;
3923 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3924 if (key == NULL) goto EXPAND_FAILED;
3925 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3926 while (isspace(*s)) s++;
3930 /* Find out the type of database */
3934 expand_string_message = US"missing lookup type";
3938 /* The type is a string that may contain special characters of various
3939 kinds. Allow everything except space or { to appear; the actual content
3940 is checked by search_findtype_partial. */
3942 while (*s != 0 && *s != '{' && !isspace(*s))
3944 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3948 while (isspace(*s)) s++;
3950 /* Now check for the individual search type and any partial or default
3951 options. Only those types that are actually in the binary are valid. */
3953 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3957 expand_string_message = search_error_message;
3961 /* Check that a key was provided for those lookup types that need it,
3962 and was not supplied for those that use the query style. */
3964 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3968 expand_string_message = string_sprintf("missing {key} for single-"
3969 "key \"%s\" lookup", name);
3977 expand_string_message = string_sprintf("a single key was given for "
3978 "lookup type \"%s\", which is not a single-key lookup type", name);
3983 /* Get the next string in brackets and expand it. It is the file name for
3984 single-key+file lookups, and the whole query otherwise. In the case of
3985 queries that also require a file name (e.g. sqlite), the file name comes
3988 if (*s != '{') goto EXPAND_FAILED_CURLY;
3989 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3990 if (filename == NULL) goto EXPAND_FAILED;
3991 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3992 while (isspace(*s)) s++;
3994 /* If this isn't a single-key+file lookup, re-arrange the variables
3995 to be appropriate for the search_ functions. For query-style lookups,
3996 there is just a "key", and no file name. For the special query-style +
3997 file types, the query (i.e. "key") starts with a file name. */
4001 while (isspace(*filename)) filename++;
4004 if (mac_islookup(stype, lookup_querystyle))
4010 if (*filename != '/')
4012 expand_string_message = string_sprintf(
4013 "absolute file name expected for \"%s\" lookup", name);
4016 while (*key != 0 && !isspace(*key)) key++;
4017 if (*key != 0) *key++ = 0;
4021 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4022 the entry was not found. Note that there is no search_close() function.
4023 Files are left open in case of re-use. At suitable places in higher logic,
4024 search_tidyup() is called to tidy all open files. This can save opening
4025 the same file several times. However, files may also get closed when
4026 others are opened, if too many are open at once. The rule is that a
4027 handle should not be used after a second search_open().
4029 Request that a partial search sets up $1 and maybe $2 by passing
4030 expand_setup containing zero. If its value changes, reset expand_nmax,
4031 since new variables will have been set. Note that at the end of this
4032 "lookup" section, the old numeric variables are restored. */
4035 lookup_value = NULL;
4038 void *handle = search_open(filename, stype, 0, NULL, NULL);
4041 expand_string_message = search_error_message;
4044 lookup_value = search_find(handle, filename, key, partial, affix,
4045 affixlen, starflags, &expand_setup);
4046 if (search_find_defer)
4048 expand_string_message =
4049 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4050 string_printing2(key, FALSE), search_error_message);
4053 if (expand_setup > 0) expand_nmax = expand_setup;
4056 /* The handling of "yes" and "no" result strings is now in a separate
4057 function that is also used by ${if} and ${extract}. */
4059 switch(process_yesno(
4060 skipping, /* were previously skipping */
4061 lookup_value != NULL, /* success/failure indicator */
4062 save_lookup_value, /* value to reset for string2 */
4063 &s, /* input pointer */
4064 &yield, /* output pointer */
4065 &size, /* output size */
4066 &ptr, /* output current point */
4067 US"lookup")) /* condition type */
4069 case 1: goto EXPAND_FAILED; /* when all is well, the */
4070 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4073 /* Restore external setting of expansion variables for carrying on
4074 at this level, and continue. */
4076 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4077 save_expand_nlength);
4081 /* If Perl support is configured, handle calling embedded perl subroutines,
4082 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4083 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4084 arguments (defined below). */
4086 #define EXIM_PERL_MAX_ARGS 8
4090 expand_string_message = US"\"${perl\" encountered, but this facility "
4091 "is not included in this binary";
4094 #else /* EXIM_PERL */
4096 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4099 if ((expand_forbid & RDO_PERL) != 0)
4101 expand_string_message = US"Perl calls are not permitted";
4105 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4108 case 1: goto EXPAND_FAILED_CURLY;
4110 case 3: goto EXPAND_FAILED;
4113 /* If skipping, we don't actually do anything */
4115 if (skipping) continue;
4117 /* Start the interpreter if necessary */
4119 if (!opt_perl_started)
4122 if (opt_perl_startup == NULL)
4124 expand_string_message = US"A setting of perl_startup is needed when "
4125 "using the Perl interpreter";
4128 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4129 initerror = init_perl(opt_perl_startup);
4130 if (initerror != NULL)
4132 expand_string_message =
4133 string_sprintf("error in perl_startup code: %s\n", initerror);
4136 opt_perl_started = TRUE;
4139 /* Call the function */
4141 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4142 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4143 sub_arg[0], sub_arg + 1);
4145 /* NULL yield indicates failure; if the message pointer has been set to
4146 NULL, the yield was undef, indicating a forced failure. Otherwise the
4147 message will indicate some kind of Perl error. */
4149 if (new_yield == NULL)
4151 if (expand_string_message == NULL)
4153 expand_string_message =
4154 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4155 "failure", sub_arg[0]);
4156 expand_string_forcedfail = TRUE;
4161 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4162 set during a callback from Perl. */
4164 expand_string_forcedfail = FALSE;
4168 #endif /* EXIM_PERL */
4170 /* Transform email address to "prvs" scheme to use
4171 as BATV-signed return path */
4178 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
4180 case 1: goto EXPAND_FAILED_CURLY;
4182 case 3: goto EXPAND_FAILED;
4185 /* If skipping, we don't actually do anything */
4186 if (skipping) continue;
4188 /* sub_arg[0] is the address */
4189 domain = Ustrrchr(sub_arg[0],'@');
4190 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4192 expand_string_message = US"prvs first argument must be a qualified email address";
4196 /* Calculate the hash. The second argument must be a single-digit
4197 key number, or unset. */
4199 if (sub_arg[2] != NULL &&
4200 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4202 expand_string_message = US"prvs second argument must be a single digit";
4206 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4209 expand_string_message = US"prvs hmac-sha1 conversion failed";
4213 /* Now separate the domain from the local part */
4216 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4217 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4218 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4219 string_cat(yield,&size,&ptr,p,6);
4220 string_cat(yield,&size,&ptr,US"=",1);
4221 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4222 string_cat(yield,&size,&ptr,US"@",1);
4223 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4228 /* Check a prvs-encoded address for validity */
4230 case EITEM_PRVSCHECK:
4233 int mysize = 0, myptr = 0;
4237 /* TF: Ugliness: We want to expand parameter 1 first, then set
4238 up expansion variables that are used in the expansion of
4239 parameter 2. So we clone the string for the first
4240 expansion, where we only expand parameter 1.
4242 PH: Actually, that isn't necessary. The read_subs() function is
4243 designed to work this way for the ${if and ${lookup expansions. I've
4247 /* Reset expansion variables */
4248 prvscheck_result = NULL;
4249 prvscheck_address = NULL;
4250 prvscheck_keynum = NULL;
4252 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4254 case 1: goto EXPAND_FAILED_CURLY;
4256 case 3: goto EXPAND_FAILED;
4259 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4262 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4264 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4265 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4266 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4267 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4268 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4270 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4271 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4272 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4273 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4274 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4276 /* Set up expansion variables */
4277 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4278 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4279 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4280 prvscheck_address[myptr] = '\0';
4281 prvscheck_keynum = string_copy(key_num);
4283 /* Now expand the second argument */
4284 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4286 case 1: goto EXPAND_FAILED_CURLY;
4288 case 3: goto EXPAND_FAILED;
4291 /* Now we have the key and can check the address. */
4293 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4298 expand_string_message = US"hmac-sha1 conversion failed";
4302 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4303 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4305 if (Ustrcmp(p,hash) == 0)
4307 /* Success, valid BATV address. Now check the expiry date. */
4308 uschar *now = prvs_daystamp(0);
4309 unsigned int inow = 0,iexpire = 1;
4311 (void)sscanf(CS now,"%u",&inow);
4312 (void)sscanf(CS daystamp,"%u",&iexpire);
4314 /* When "iexpire" is < 7, a "flip" has occured.
4315 Adjust "inow" accordingly. */
4316 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4318 if (iexpire >= inow)
4320 prvscheck_result = US"1";
4321 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4325 prvscheck_result = NULL;
4326 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4331 prvscheck_result = NULL;
4332 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4335 /* Now expand the final argument. We leave this till now so that
4336 it can include $prvscheck_result. */
4338 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4340 case 1: goto EXPAND_FAILED_CURLY;
4342 case 3: goto EXPAND_FAILED;
4345 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4346 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4348 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4350 /* Reset the "internal" variables afterwards, because they are in
4351 dynamic store that will be reclaimed if the expansion succeeded. */
4353 prvscheck_address = NULL;
4354 prvscheck_keynum = NULL;
4358 /* Does not look like a prvs encoded address, return the empty string.
4359 We need to make sure all subs are expanded first, so as to skip over
4362 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4364 case 1: goto EXPAND_FAILED_CURLY;
4366 case 3: goto EXPAND_FAILED;
4373 /* Handle "readfile" to insert an entire file */
4375 case EITEM_READFILE:
4380 if ((expand_forbid & RDO_READFILE) != 0)
4382 expand_string_message = US"file insertions are not permitted";
4386 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4388 case 1: goto EXPAND_FAILED_CURLY;
4390 case 3: goto EXPAND_FAILED;
4393 /* If skipping, we don't actually do anything */
4395 if (skipping) continue;
4397 /* Open the file and read it */
4399 f = Ufopen(sub_arg[0], "rb");
4402 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4406 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4411 /* Handle "readsocket" to insert data from a Unix domain socket */
4413 case EITEM_READSOCK:
4419 struct sockaddr_un sockun; /* don't call this "sun" ! */
4423 if ((expand_forbid & RDO_READSOCK) != 0)
4425 expand_string_message = US"socket insertions are not permitted";
4429 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4430 because there may be a string for expansion on failure. */
4432 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4434 case 1: goto EXPAND_FAILED_CURLY;
4435 case 2: /* Won't occur: no end check */
4436 case 3: goto EXPAND_FAILED;
4439 /* Sort out timeout, if given */
4441 if (sub_arg[2] != NULL)
4443 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4446 expand_string_message = string_sprintf("bad time value %s",
4451 else sub_arg[3] = NULL; /* No eol if no timeout */
4453 /* If skipping, we don't actually do anything. Otherwise, arrange to
4454 connect to either an IP or a Unix socket. */
4458 /* Handle an IP (internet) domain */
4460 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4462 BOOL connected = FALSE;
4466 uschar *server_name = sub_arg[0] + 5;
4467 uschar *port_name = Ustrrchr(server_name, ':');
4469 /* Sort out the port */
4471 if (port_name == NULL)
4473 expand_string_message =
4474 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4477 *port_name++ = 0; /* Terminate server name */
4479 if (isdigit(*port_name))
4482 port = Ustrtol(port_name, &end, 0);
4483 if (end != port_name + Ustrlen(port_name))
4485 expand_string_message =
4486 string_sprintf("invalid port number %s", port_name);
4492 struct servent *service_info = getservbyname(CS port_name, "tcp");
4493 if (service_info == NULL)
4495 expand_string_message = string_sprintf("unknown port \"%s\"",
4499 port = ntohs(service_info->s_port);
4502 /* Sort out the server. */
4505 shost.address = NULL;
4509 namelen = Ustrlen(server_name);
4511 /* Anything enclosed in [] must be an IP address. */
4513 if (server_name[0] == '[' &&
4514 server_name[namelen - 1] == ']')
4516 server_name[namelen - 1] = 0;
4518 if (string_is_ip_address(server_name, NULL) == 0)
4520 expand_string_message =
4521 string_sprintf("malformed IP address \"%s\"", server_name);
4524 shost.name = shost.address = server_name;
4527 /* Otherwise check for an unadorned IP address */
4529 else if (string_is_ip_address(server_name, NULL) != 0)
4530 shost.name = shost.address = server_name;
4532 /* Otherwise lookup IP address(es) from the name */
4536 shost.name = server_name;
4537 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4538 FALSE) != HOST_FOUND)
4540 expand_string_message =
4541 string_sprintf("no IP address found for host %s", shost.name);
4546 /* Try to connect to the server - test each IP till one works */
4548 for (h = &shost; h != NULL; h = h->next)
4550 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4551 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4553 expand_string_message = string_sprintf("failed to create socket: "
4554 "%s", strerror(errno));
4558 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4567 expand_string_message = string_sprintf("failed to connect to "
4568 "socket %s: couldn't connect to any host", sub_arg[0],
4574 /* Handle a Unix domain socket */
4579 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4581 expand_string_message = string_sprintf("failed to create socket: %s",
4586 sockun.sun_family = AF_UNIX;
4587 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4590 sigalrm_seen = FALSE;
4592 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4596 expand_string_message = US "socket connect timed out";
4601 expand_string_message = string_sprintf("failed to connect to socket "
4602 "%s: %s", sub_arg[0], strerror(errno));
4607 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4609 /* Write the request string, if not empty */
4611 if (sub_arg[1][0] != 0)
4613 int len = Ustrlen(sub_arg[1]);
4614 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4616 if (write(fd, sub_arg[1], len) != len)
4618 expand_string_message = string_sprintf("request write to socket "
4619 "failed: %s", strerror(errno));
4624 /* Shut down the sending side of the socket. This helps some servers to
4625 recognise that it is their turn to do some work. Just in case some
4626 system doesn't have this function, make it conditional. */
4629 shutdown(fd, SHUT_WR);
4632 /* Now we need to read from the socket, under a timeout. The function
4633 that reads a file can be used. */
4635 f = fdopen(fd, "rb");
4636 sigalrm_seen = FALSE;
4638 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4642 /* After a timeout, we restore the pointer in the result, that is,
4643 make sure we add nothing from the socket. */
4648 expand_string_message = US "socket read timed out";
4653 /* The whole thing has worked (or we were skipping). If there is a
4654 failure string following, we need to skip it. */
4658 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4660 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4661 while (isspace(*s)) s++;
4663 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4666 /* Come here on failure to create socket, connect socket, write to the
4667 socket, or timeout on reading. If another substring follows, expand and
4668 use it. Otherwise, those conditions give expand errors. */
4671 if (*s != '{') goto EXPAND_FAILED;
4672 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4673 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4674 if (arg == NULL) goto EXPAND_FAILED;
4675 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4676 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4677 while (isspace(*s)) s++;
4678 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4682 /* Handle "run" to execute a program. */
4694 if ((expand_forbid & RDO_RUN) != 0)
4696 expand_string_message = US"running a command is not permitted";
4700 while (isspace(*s)) s++;
4701 if (*s != '{') goto EXPAND_FAILED_CURLY;
4702 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4703 if (arg == NULL) goto EXPAND_FAILED;
4704 while (isspace(*s)) s++;
4705 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4707 if (skipping) /* Just pretend it worked when we're skipping */
4713 if (!transport_set_up_command(&argv, /* anchor for arg list */
4714 arg, /* raw command */
4715 FALSE, /* don't expand the arguments */
4716 0, /* not relevant when... */
4717 NULL, /* no transporting address */
4718 US"${run} expansion", /* for error messages */
4719 &expand_string_message)) /* where to put error message */
4724 /* Create the child process, making it a group leader. */
4726 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4730 expand_string_message =
4731 string_sprintf("couldn't create child process: %s", strerror(errno));
4735 /* Nothing is written to the standard input. */
4739 /* Read the pipe to get the command's output into $value (which is kept
4740 in lookup_value). Read during execution, so that if the output exceeds
4741 the OS pipe buffer limit, we don't block forever. */
4743 f = fdopen(fd_out, "rb");
4744 sigalrm_seen = FALSE;
4746 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4750 /* Wait for the process to finish, applying the timeout, and inspect its
4751 return code for serious disasters. Simple non-zero returns are passed on.
4754 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4756 if (sigalrm_seen == TRUE || runrc == -256)
4758 expand_string_message = string_sprintf("command timed out");
4759 killpg(pid, SIGKILL); /* Kill the whole process group */
4762 else if (runrc == -257)
4763 expand_string_message = string_sprintf("wait() failed: %s",
4767 expand_string_message = string_sprintf("command killed by signal %d",
4774 /* Process the yes/no strings; $value may be useful in both cases */
4776 switch(process_yesno(
4777 skipping, /* were previously skipping */
4778 runrc == 0, /* success/failure indicator */
4779 lookup_value, /* value to reset for string2 */
4780 &s, /* input pointer */
4781 &yield, /* output pointer */
4782 &size, /* output size */
4783 &ptr, /* output current point */
4784 US"run")) /* condition type */
4786 case 1: goto EXPAND_FAILED; /* when all is well, the */
4787 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4793 /* Handle character translation for "tr" */
4801 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4803 case 1: goto EXPAND_FAILED_CURLY;
4805 case 3: goto EXPAND_FAILED;
4808 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4809 o2m = Ustrlen(sub[2]) - 1;
4811 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4813 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4817 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4824 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4825 expanded arguments. */
4835 int val[2] = { 0, -1 };
4838 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4839 Ensure that sub[2] is set in the ${length case. */
4842 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4845 case 1: goto EXPAND_FAILED_CURLY;
4847 case 3: goto EXPAND_FAILED;
4850 /* Juggle the arguments if there are only two of them: always move the
4851 string to the last position and make ${length{n}{str}} equivalent to
4852 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4858 if (item_type == EITEM_LENGTH)
4865 for (i = 0; i < 2; i++)
4867 if (sub[i] == NULL) continue;
4868 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4869 if (*ret != 0 || (i != 0 && val[i] < 0))
4871 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4872 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4878 (item_type == EITEM_HASH)?
4879 compute_hash(sub[2], val[0], val[1], &len) :
4880 (item_type == EITEM_NHASH)?
4881 compute_nhash(sub[2], val[0], val[1], &len) :
4882 extract_substr(sub[2], val[0], val[1], &len);
4884 if (ret == NULL) goto EXPAND_FAILED;
4885 yield = string_cat(yield, &size, &ptr, ret, len);
4889 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4890 This code originally contributed by Steve Haslam. It currently supports
4891 the use of MD5 and SHA-1 hashes.
4893 We need some workspace that is large enough to handle all the supported
4894 hash types. Use macros to set the sizes rather than be too elaborate. */
4896 #define MAX_HASHLEN 20
4897 #define MAX_HASHBLOCKLEN 64
4906 int hashlen; /* Number of octets for the hash algorithm's output */
4907 int hashblocklen; /* Number of octets the hash algorithm processes */
4909 unsigned int keylen;
4911 uschar keyhash[MAX_HASHLEN];
4912 uschar innerhash[MAX_HASHLEN];
4913 uschar finalhash[MAX_HASHLEN];
4914 uschar finalhash_hex[2*MAX_HASHLEN];
4915 uschar innerkey[MAX_HASHBLOCKLEN];
4916 uschar outerkey[MAX_HASHBLOCKLEN];
4918 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4920 case 1: goto EXPAND_FAILED_CURLY;
4922 case 3: goto EXPAND_FAILED;
4925 if (Ustrcmp(sub[0], "md5") == 0)
4928 use_base = &md5_base;
4932 else if (Ustrcmp(sub[0], "sha1") == 0)
4935 use_base = &sha1_base;
4941 expand_string_message =
4942 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4947 keylen = Ustrlen(keyptr);
4949 /* If the key is longer than the hash block length, then hash the key
4952 if (keylen > hashblocklen)
4954 chash_start(type, use_base);
4955 chash_end(type, use_base, keyptr, keylen, keyhash);
4960 /* Now make the inner and outer key values */
4962 memset(innerkey, 0x36, hashblocklen);
4963 memset(outerkey, 0x5c, hashblocklen);
4965 for (i = 0; i < keylen; i++)
4967 innerkey[i] ^= keyptr[i];
4968 outerkey[i] ^= keyptr[i];
4971 /* Now do the hashes */
4973 chash_start(type, use_base);
4974 chash_mid(type, use_base, innerkey);
4975 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4977 chash_start(type, use_base);
4978 chash_mid(type, use_base, outerkey);
4979 chash_end(type, use_base, innerhash, hashlen, finalhash);
4981 /* Encode the final hash as a hex string */
4984 for (i = 0; i < hashlen; i++)
4986 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4987 *p++ = hex_digits[finalhash[i] & 0x0f];
4990 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4991 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4993 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4998 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4999 We have to save the numerical variables and restore them afterwards. */
5004 int moffset, moffsetextra, slen;
5007 const uschar *rerror;
5010 int save_expand_nmax =
5011 save_expand_strings(save_expand_nstring, save_expand_nlength);
5013 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
5015 case 1: goto EXPAND_FAILED_CURLY;
5017 case 3: goto EXPAND_FAILED;
5020 /* Compile the regular expression */
5022 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5027 expand_string_message = string_sprintf("regular expression error in "
5028 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5032 /* Now run a loop to do the substitutions as often as necessary. It ends
5033 when there are no more matches. Take care over matches of the null string;
5034 do the same thing as Perl does. */
5037 slen = Ustrlen(sub[0]);
5038 moffset = moffsetextra = 0;
5043 int ovector[3*(EXPAND_MAXN+1)];
5044 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5045 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5049 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5050 is not necessarily the end. We want to repeat the match from one
5051 character further along, but leaving the basic offset the same (for
5052 copying below). We can't be at the end of the string - that was checked
5053 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5054 finished; copy the remaining string and end the loop. */
5064 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5068 /* Match - set up for expanding the replacement. */
5070 if (n == 0) n = EXPAND_MAXN + 1;
5072 for (nn = 0; nn < n*2; nn += 2)
5074 expand_nstring[expand_nmax] = subject + ovector[nn];
5075 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5079 /* Copy the characters before the match, plus the expanded insertion. */
5081 yield = string_cat(yield, &size, &ptr, subject + moffset,
5082 ovector[0] - moffset);
5083 insert = expand_string(sub[2]);
5084 if (insert == NULL) goto EXPAND_FAILED;
5085 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5087 moffset = ovector[1];
5091 /* If we have matched an empty string, first check to see if we are at
5092 the end of the subject. If so, the loop is over. Otherwise, mimic
5093 what Perl's /g options does. This turns out to be rather cunning. First
5094 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5095 string at the same point. If this fails (picked up above) we advance to
5096 the next character. */
5098 if (ovector[0] == ovector[1])
5100 if (ovector[0] == slen) break;
5101 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5105 /* All done - restore numerical variables. */
5107 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5108 save_expand_nlength);
5112 /* Handle keyed and numbered substring extraction. If the first argument
5113 consists entirely of digits, then a numerical extraction is assumed. */
5119 int field_number = 1;
5120 BOOL field_number_set = FALSE;
5121 uschar *save_lookup_value = lookup_value;
5123 int save_expand_nmax =
5124 save_expand_strings(save_expand_nstring, save_expand_nlength);
5126 /* Read the arguments */
5128 for (i = 0; i < j; i++)
5130 while (isspace(*s)) s++;
5133 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5134 if (sub[i] == NULL) goto EXPAND_FAILED;
5135 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5137 /* After removal of leading and trailing white space, the first
5138 argument must not be empty; if it consists entirely of digits
5139 (optionally preceded by a minus sign), this is a numerical
5140 extraction, and we expect 3 arguments. */
5148 while (isspace(*p)) p++;
5152 while (len > 0 && isspace(p[len-1])) len--;
5155 if (*p == 0 && !skipping)
5157 expand_string_message = US"first argument of \"extract\" must "
5167 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5171 j = 3; /* Need 3 args */
5172 field_number_set = TRUE;
5176 else goto EXPAND_FAILED_CURLY;
5179 /* Extract either the numbered or the keyed substring into $value. If
5180 skipping, just pretend the extraction failed. */
5182 lookup_value = skipping? NULL : field_number_set?
5183 expand_gettokened(field_number, sub[1], sub[2]) :
5184 expand_getkeyed(sub[0], sub[1]);
5186 /* If no string follows, $value gets substituted; otherwise there can
5187 be yes/no strings, as for lookup or if. */
5189 switch(process_yesno(
5190 skipping, /* were previously skipping */
5191 lookup_value != NULL, /* success/failure indicator */
5192 save_lookup_value, /* value to reset for string2 */
5193 &s, /* input pointer */
5194 &yield, /* output pointer */
5195 &size, /* output size */
5196 &ptr, /* output current point */
5197 US"extract")) /* condition type */
5199 case 1: goto EXPAND_FAILED; /* when all is well, the */
5200 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5203 /* All done - restore numerical variables. */
5205 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5206 save_expand_nlength);
5212 /* Handle list operations */
5220 uschar outsep[2] = { '\0', '\0' };
5221 uschar *list, *expr, *temp;
5222 uschar *save_iterate_item = iterate_item;
5223 uschar *save_lookup_value = lookup_value;
5225 while (isspace(*s)) s++;
5226 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5228 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5229 if (list == NULL) goto EXPAND_FAILED;
5230 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5232 if (item_type == EITEM_REDUCE)
5234 while (isspace(*s)) s++;
5235 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5236 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5237 if (temp == NULL) goto EXPAND_FAILED;
5238 lookup_value = temp;
5239 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5242 while (isspace(*s)) s++;
5243 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5247 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5248 if scanning a "false" part). This allows us to find the end of the
5249 condition, because if the list is empty, we won't actually evaluate the
5250 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5251 the normal internal expansion function. */
5253 if (item_type == EITEM_FILTER)
5255 temp = eval_condition(expr, NULL);
5256 if (temp != NULL) s = temp;
5260 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5265 expand_string_message = string_sprintf("%s inside \"%s\" item",
5266 expand_string_message, name);
5270 while (isspace(*s)) s++;
5273 expand_string_message = string_sprintf("missing } at end of condition "
5274 "or expression inside \"%s\"", name);
5278 while (isspace(*s)) s++;
5281 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5286 /* If we are skipping, we can now just move on to the next item. When
5287 processing for real, we perform the iteration. */
5289 if (skipping) continue;
5290 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5292 *outsep = (uschar)sep; /* Separator as a string */
5294 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5296 if (item_type == EITEM_FILTER)
5299 if (eval_condition(expr, &condresult) == NULL)
5301 iterate_item = save_iterate_item;
5302 lookup_value = save_lookup_value;
5303 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5304 expand_string_message, name);
5307 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5308 condresult? "true":"false");
5310 temp = iterate_item; /* TRUE => include this item */
5312 continue; /* FALSE => skip this item */
5315 /* EITEM_MAP and EITEM_REDUCE */
5319 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5322 iterate_item = save_iterate_item;
5323 expand_string_message = string_sprintf("%s inside \"%s\" item",
5324 expand_string_message, name);
5327 if (item_type == EITEM_REDUCE)
5329 lookup_value = temp; /* Update the value of $value */
5330 continue; /* and continue the iteration */
5334 /* We reach here for FILTER if the condition is true, always for MAP,
5335 and never for REDUCE. The value in "temp" is to be added to the output
5336 list that is being created, ensuring that any occurrences of the
5337 separator character are doubled. Unless we are dealing with the first
5338 item of the output list, add in a space if the new item begins with the
5339 separator character, or is an empty string. */
5341 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5342 yield = string_cat(yield, &size, &ptr, US" ", 1);
5344 /* Add the string in "temp" to the output list that we are building,
5345 This is done in chunks by searching for the separator character. */
5349 size_t seglen = Ustrcspn(temp, outsep);
5350 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5352 /* If we got to the end of the string we output one character
5353 too many; backup and end the loop. Otherwise arrange to double the
5356 if (temp[seglen] == '\0') { ptr--; break; }
5357 yield = string_cat(yield, &size, &ptr, outsep, 1);
5361 /* Output a separator after the string: we will remove the redundant
5362 final one at the end. */
5364 yield = string_cat(yield, &size, &ptr, outsep, 1);
5365 } /* End of iteration over the list loop */
5367 /* REDUCE has generated no output above: output the final value of
5370 if (item_type == EITEM_REDUCE)
5372 yield = string_cat(yield, &size, &ptr, lookup_value,
5373 Ustrlen(lookup_value));
5374 lookup_value = save_lookup_value; /* Restore $value */
5377 /* FILTER and MAP generate lists: if they have generated anything, remove
5378 the redundant final separator. Even though an empty item at the end of a
5379 list does not count, this is tidier. */
5381 else if (ptr != save_ptr) ptr--;
5383 /* Restore preserved $item */
5385 iterate_item = save_iterate_item;
5390 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5391 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5392 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5393 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5395 #define EXPAND_DLFUNC_MAX_ARGS 8
5398 #ifndef EXPAND_DLFUNC
5399 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5400 "is not included in this binary";
5403 #else /* EXPAND_DLFUNC */
5406 exim_dlfunc_t *func;
5409 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5411 if ((expand_forbid & RDO_DLFUNC) != 0)
5413 expand_string_message =
5414 US"dynamically-loaded functions are not permitted";
5418 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5421 case 1: goto EXPAND_FAILED_CURLY;
5423 case 3: goto EXPAND_FAILED;
5426 /* If skipping, we don't actually do anything */
5428 if (skipping) continue;
5430 /* Look up the dynamically loaded object handle in the tree. If it isn't
5431 found, dlopen() the file and put the handle in the tree for next time. */
5433 t = tree_search(dlobj_anchor, argv[0]);
5436 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5439 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5440 argv[0], dlerror());
5441 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5444 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5445 Ustrcpy(t->name, argv[0]);
5446 t->data.ptr = handle;
5447 (void)tree_insertnode(&dlobj_anchor, t);
5450 /* Having obtained the dynamically loaded object handle, look up the
5451 function pointer. */
5453 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5456 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5457 "%s", argv[1], argv[0], dlerror());
5458 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5462 /* Call the function and work out what to do with the result. If it
5463 returns OK, we have a replacement string; if it returns DEFER then
5464 expansion has failed in a non-forced manner; if it returns FAIL then
5465 failure was forced; if it returns ERROR or any other value there's a
5466 problem, so panic slightly. In any case, assume that the function has
5467 side-effects on the store that must be preserved. */
5471 for (argc = 0; argv[argc] != NULL; argc++);
5472 status = func(&result, argc - 2, &argv[2]);
5475 if (result == NULL) result = US"";
5476 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5481 expand_string_message = result == NULL ? US"(no message)" : result;
5482 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5483 else if(status != FAIL)
5484 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5485 argv[0], argv[1], status, expand_string_message);
5489 #endif /* EXPAND_DLFUNC */
5492 /* Control reaches here if the name is not recognized as one of the more
5493 complicated expansion items. Check for the "operator" syntax (name terminated
5494 by a colon). Some of the operators have arguments, separated by _ from the
5501 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5502 if (sub == NULL) goto EXPAND_FAILED;
5505 /* Owing to an historical mis-design, an underscore may be part of the
5506 operator name, or it may introduce arguments. We therefore first scan the
5507 table of names that contain underscores. If there is no match, we cut off
5508 the arguments and then scan the main table. */
5510 c = chop_match(name, op_table_underscore,
5511 sizeof(op_table_underscore)/sizeof(uschar *));
5515 arg = Ustrchr(name, '_');
5516 if (arg != NULL) *arg = 0;
5517 c = chop_match(name, op_table_main,
5518 sizeof(op_table_main)/sizeof(uschar *));
5519 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5520 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5523 /* If we are skipping, we don't need to perform the operation at all.
5524 This matters for operations like "mask", because the data may not be
5525 in the correct format when skipping. For example, the expression may test
5526 for the existence of $sender_host_address before trying to mask it. For
5527 other operations, doing them may not fail, but it is a waste of time. */
5529 if (skipping && c >= 0) continue;
5531 /* Otherwise, switch on the operator type */
5538 unsigned long int n = Ustrtoul(sub, &t, 10);
5541 expand_string_message = string_sprintf("argument for base62 "
5542 "operator is \"%s\", which is not a decimal number", sub);
5545 t = string_base62(n);
5546 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5550 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5556 unsigned long int n = 0;
5559 uschar *t = Ustrchr(base62_chars, *tt++);
5562 expand_string_message = string_sprintf("argument for base62d "
5563 "operator is \"%s\", which is not a base %d number", sub,
5567 n = n * BASE_62 + (t - base62_chars);
5569 (void)sprintf(CS buf, "%ld", n);
5570 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5576 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5577 if (expanded == NULL)
5579 expand_string_message =
5580 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5581 expand_string_message);
5584 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5591 uschar *t = sub - 1;
5592 while (*(++t) != 0) { *t = tolower(*t); count++; }
5593 yield = string_cat(yield, &size, &ptr, sub, count);
5600 uschar *t = sub - 1;
5601 while (*(++t) != 0) { *t = toupper(*t); count++; }
5602 yield = string_cat(yield, &size, &ptr, sub, count);
5613 md5_end(&base, sub, Ustrlen(sub), digest);
5614 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5615 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5626 sha1_end(&base, sub, Ustrlen(sub), digest);
5627 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5628 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5632 /* Convert hex encoding to base64 encoding */
5642 for (enc = sub; *enc != 0; enc++)
5644 if (!isxdigit(*enc))
5646 expand_string_message = string_sprintf("\"%s\" is not a hex "
5655 expand_string_message = string_sprintf("\"%s\" contains an odd "
5656 "number of characters", sub);
5660 while ((c = *in++) != 0)
5662 if (isdigit(c)) c -= '0';
5663 else c = toupper(c) - 'A' + 10;
5675 enc = auth_b64encode(sub, out - sub);
5676 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5680 /* Convert octets outside 0x21..0x7E to \xXX form */
5684 uschar *t = sub - 1;
5687 if (*t < 0x21 || 0x7E < *t)
5688 yield = string_cat(yield, &size, &ptr,
5689 string_sprintf("\\x%02x", *t), 4);
5691 yield = string_cat(yield, &size, &ptr, t, 1);
5696 /* count the number of list elements */
5705 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5706 cp = string_sprintf("%d", cnt);
5707 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5711 /* expand a named list given the name */
5712 /* handles nested named lists; requotes as colon-sep list */
5716 tree_node *t = NULL;
5720 uschar * suffix = US"";
5721 BOOL needsep = FALSE;
5724 if (*sub == '+') sub++;
5725 if (arg == NULL) /* no-argument version */
5727 if (!(t = tree_search(addresslist_anchor, sub)) &&
5728 !(t = tree_search(domainlist_anchor, sub)) &&
5729 !(t = tree_search(hostlist_anchor, sub)))
5730 t = tree_search(localpartlist_anchor, sub);
5732 else switch(*arg) /* specific list-type version */
5734 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
5735 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
5736 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
5737 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
5739 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5745 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5747 : *arg=='a'?"address "
5748 : *arg=='d'?"domain "
5750 : *arg=='l'?"localpart "
5755 list = ((namedlist_block *)(t->data.ptr))->string;
5757 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5759 uschar * buf = US" : ";
5761 yield = string_cat(yield, &size, &ptr, buf, 3);
5765 if (*item == '+') /* list item is itself a named list */
5767 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5768 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE);
5770 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5774 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5775 while ((cp= strpbrk((const char *)item, tok)))
5777 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5778 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5780 yield = string_cat(yield, &size, &ptr, US"::", 2);
5781 item = (uschar *)cp;
5783 else /* sep in item; should already be doubled; emit once */
5785 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5786 if (*cp == sep) cp++;
5787 item = (uschar *)cp;
5791 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5796 /* mask applies a mask to an IP address; for example the result of
5797 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5804 int mask, maskoffset;
5805 int type = string_is_ip_address(sub, &maskoffset);
5810 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5815 if (maskoffset == 0)
5817 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5822 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5824 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5826 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5831 /* Convert the address to binary integer(s) and apply the mask */
5833 sub[maskoffset] = 0;
5834 count = host_aton(sub, binary);
5835 host_mask(count, binary, mask);
5837 /* Convert to masked textual format and add to output. */
5839 yield = string_cat(yield, &size, &ptr, buffer,
5840 host_nmtoa(count, binary, mask, buffer, '.'));
5845 case EOP_LOCAL_PART:
5849 int start, end, domain;
5850 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5854 if (c != EOP_DOMAIN)
5856 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5857 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5859 else if (domain != 0)
5862 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5870 uschar outsep[2] = { ':', '\0' };
5871 uschar *address, *error;
5873 int start, end, domain; /* Not really used */
5875 while (isspace(*sub)) sub++;
5876 if (*sub == '>') { *outsep = *++sub; ++sub; }
5877 parse_allow_group = TRUE;
5881 uschar *p = parse_find_address_end(sub, FALSE);
5882 uschar saveend = *p;
5884 address = parse_extract_address(sub, &error, &start, &end, &domain,
5888 /* Add the address to the output list that we are building. This is
5889 done in chunks by searching for the separator character. At the
5890 start, unless we are dealing with the first address of the output
5891 list, add in a space if the new address begins with the separator
5892 character, or is an empty string. */
5894 if (address != NULL)
5896 if (ptr != save_ptr && address[0] == *outsep)
5897 yield = string_cat(yield, &size, &ptr, US" ", 1);
5901 size_t seglen = Ustrcspn(address, outsep);
5902 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5904 /* If we got to the end of the string we output one character
5907 if (address[seglen] == '\0') { ptr--; break; }
5908 yield = string_cat(yield, &size, &ptr, outsep, 1);
5909 address += seglen + 1;
5912 /* Output a separator after the string: we will remove the
5913 redundant final one at the end. */
5915 yield = string_cat(yield, &size, &ptr, outsep, 1);
5918 if (saveend == '\0') break;
5922 /* If we have generated anything, remove the redundant final
5925 if (ptr != save_ptr) ptr--;
5926 parse_allow_group = FALSE;
5931 /* quote puts a string in quotes if it is empty or contains anything
5932 other than alphamerics, underscore, dot, or hyphen.
5934 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5935 be quoted in order to be a valid local part.
5937 In both cases, newlines and carriage returns are converted into \n and \r
5941 case EOP_QUOTE_LOCAL_PART:
5944 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5945 uschar *t = sub - 1;
5949 while (!needs_quote && *(++t) != 0)
5950 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5952 else /* EOP_QUOTE_LOCAL_PART */
5954 while (!needs_quote && *(++t) != 0)
5955 needs_quote = !isalnum(*t) &&
5956 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5957 (*t != '.' || t == sub || t[1] == 0);
5962 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5967 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5968 else if (*t == '\r')
5969 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5972 if (*t == '\\' || *t == '"')
5973 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5974 yield = string_cat(yield, &size, &ptr, t, 1);
5977 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5979 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5983 /* quote_lookuptype does lookup-specific quoting */
5988 uschar *opt = Ustrchr(arg, '_');
5990 if (opt != NULL) *opt++ = 0;
5992 n = search_findtype(arg, Ustrlen(arg));
5995 expand_string_message = search_error_message;
5999 if (lookup_list[n]->quote != NULL)
6000 sub = (lookup_list[n]->quote)(sub, opt);
6001 else if (opt != NULL) sub = NULL;
6005 expand_string_message = string_sprintf(
6006 "\"%s\" unrecognized after \"${quote_%s\"",
6011 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6015 /* rx quote sticks in \ before any non-alphameric character so that
6016 the insertion works in a regular expression. */
6020 uschar *t = sub - 1;
6024 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6025 yield = string_cat(yield, &size, &ptr, t, 1);
6030 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6031 prescribed by the RFC, if there are characters that need to be encoded */
6035 uschar buffer[2048];
6036 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6037 buffer, sizeof(buffer), FALSE);
6038 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6042 /* RFC 2047 decode */
6048 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6049 headers_charset, '?', &len, &error);
6052 expand_string_message = error;
6055 yield = string_cat(yield, &size, &ptr, decoded, len);
6059 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6069 if (c > 255) c = '_';
6071 yield = string_cat(yield, &size, &ptr, buff, 1);
6076 /* escape turns all non-printing characters into escape sequences. */
6080 uschar *t = string_printing(sub);
6081 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6085 /* Handle numeric expression evaluation */
6090 uschar *save_sub = sub;
6091 uschar *error = NULL;
6092 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6095 expand_string_message = string_sprintf("error in expression "
6096 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6100 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6101 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6105 /* Handle time period formating */
6109 int n = readconf_readtime(sub, 0, FALSE);
6112 expand_string_message = string_sprintf("string \"%s\" is not an "
6113 "Exim time interval in \"%s\" operator", sub, name);
6116 sprintf(CS var_buffer, "%d", n);
6117 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6121 case EOP_TIME_INTERVAL:
6124 uschar *t = read_number(&n, sub);
6125 if (*t != 0) /* Not A Number*/
6127 expand_string_message = string_sprintf("string \"%s\" is not a "
6128 "positive number in \"%s\" operator", sub, name);
6131 t = readconf_printtime(n);
6132 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6136 /* Convert string to base64 encoding */
6140 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6141 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6145 /* strlen returns the length of the string */
6150 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6151 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6155 /* length_n or l_n takes just the first n characters or the whole string,
6156 whichever is the shorter;
6158 substr_m_n, and s_m_n take n characters from offset m; negative m take
6159 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6160 takes the rest, either to the right or to the left.
6162 hash_n or h_n makes a hash of length n from the string, yielding n
6163 characters from the set a-z; hash_n_m makes a hash of length n, but
6164 uses m characters from the set a-zA-Z0-9.
6166 nhash_n returns a single number between 0 and n-1 (in text form), while
6167 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6168 between 0 and n-1 and the second between 0 and m-1. */
6188 expand_string_message = string_sprintf("missing values after %s",
6193 /* "length" has only one argument, effectively being synonymous with
6196 if (c == EOP_LENGTH || c == EOP_L)
6202 /* The others have one or two arguments; for "substr" the first may be
6203 negative. The second being negative means "not supplied". */
6208 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6211 /* Read up to two numbers, separated by underscores */
6216 if (arg != ret && *arg == '_' && pn == &value1)
6220 if (arg[1] != 0) arg++;
6222 else if (!isdigit(*arg))
6224 expand_string_message =
6225 string_sprintf("non-digit after underscore in \"%s\"", name);
6228 else *pn = (*pn)*10 + *arg++ - '0';
6232 /* Perform the required operation */
6235 (c == EOP_HASH || c == EOP_H)?
6236 compute_hash(sub, value1, value2, &len) :
6237 (c == EOP_NHASH || c == EOP_NH)?
6238 compute_nhash(sub, value1, value2, &len) :
6239 extract_substr(sub, value1, value2, &len);
6241 if (ret == NULL) goto EXPAND_FAILED;
6242 yield = string_cat(yield, &size, &ptr, ret, len);
6252 uschar **modetable[3];
6257 if ((expand_forbid & RDO_EXISTS) != 0)
6259 expand_string_message = US"Use of the stat() expansion is not permitted";
6263 if (stat(CS sub, &st) < 0)
6265 expand_string_message = string_sprintf("stat(%s) failed: %s",
6266 sub, strerror(errno));
6270 switch (mode & S_IFMT)
6272 case S_IFIFO: smode[0] = 'p'; break;
6273 case S_IFCHR: smode[0] = 'c'; break;
6274 case S_IFDIR: smode[0] = 'd'; break;
6275 case S_IFBLK: smode[0] = 'b'; break;
6276 case S_IFREG: smode[0] = '-'; break;
6277 default: smode[0] = '?'; break;
6280 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6281 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6282 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6284 for (i = 0; i < 3; i++)
6286 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6291 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6292 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6293 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6294 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6295 (long)st.st_gid, st.st_size, (long)st.st_atime,
6296 (long)st.st_mtime, (long)st.st_ctime);
6297 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6301 /* vaguely random number less than N */
6305 int_eximarith_t max;
6308 max = expand_string_integer(sub, TRUE);
6309 if (expand_string_message != NULL)
6311 s = string_sprintf("%d", vaguely_random_number((int)max));
6312 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6316 /* Reverse IP, including IPv6 to dotted-nibble */
6318 case EOP_REVERSE_IP:
6320 int family, maskptr;
6321 uschar reversed[128];
6323 family = string_is_ip_address(sub, &maskptr);
6326 expand_string_message = string_sprintf(
6327 "reverse_ip() not given an IP address [%s]", sub);
6330 invert_address(reversed, sub);
6331 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6335 /* Unknown operator */
6338 expand_string_message =
6339 string_sprintf("unknown expansion operator \"%s\"", name);
6344 /* Handle a plain name. If this is the first thing in the expansion, release
6345 the pre-allocated buffer. If the result data is known to be in a new buffer,
6346 newsize will be set to the size of that buffer, and we can just point at that
6347 store instead of copying. Many expansion strings contain just one reference,
6348 so this is a useful optimization, especially for humungous headers
6349 ($message_headers). */
6357 if (resetok) store_reset(yield);
6361 value = find_variable(name, FALSE, skipping, &newsize);
6364 expand_string_message =
6365 string_sprintf("unknown variable in \"${%s}\"", name);
6366 check_variable_error_message(name);
6369 len = Ustrlen(value);
6370 if (yield == NULL && newsize != 0)
6376 else yield = string_cat(yield, &size, &ptr, value, len);
6380 /* Else there's something wrong */
6382 expand_string_message =
6383 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6384 "in a variable reference)", name);
6388 /* If we hit the end of the string when ket_ends is set, there is a missing
6389 terminating brace. */
6391 if (ket_ends && *s == 0)
6393 expand_string_message = malformed_header?
6394 US"missing } at end of string - could be header name not terminated by colon"
6396 US"missing } at end of string";
6400 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6401 added to the string. If so, set up an empty string. Add a terminating zero. If
6402 left != NULL, return a pointer to the terminator. */
6404 if (yield == NULL) yield = store_get(1);
6406 if (left != NULL) *left = s;
6408 /* Any stacking store that was used above the final string is no longer needed.
6409 In many cases the final string will be the first one that was got and so there
6410 will be optimal store usage. */
6412 if (resetok) store_reset(yield + ptr + 1);
6415 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6417 if (skipping) debug_printf("skipping: result is not used\n");
6421 /* This is the failure exit: easiest to program with a goto. We still need
6422 to update the pointer to the terminator, for cases of nested calls with "fail".
6425 EXPAND_FAILED_CURLY:
6426 expand_string_message = malformed_header?
6427 US"missing or misplaced { or } - could be header name not terminated by colon"
6429 US"missing or misplaced { or }";
6431 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6432 that is a bad idea, because expand_string_message is in dynamic store. */
6435 if (left != NULL) *left = s;
6438 debug_printf("failed to expand: %s\n", string);
6439 debug_printf(" error message: %s\n", expand_string_message);
6440 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6446 /* This is the external function call. Do a quick check for any expansion
6447 metacharacters, and if there are none, just return the input string.
6449 Argument: the string to be expanded
6450 Returns: the expanded string, or NULL if expansion failed; if failure was
6451 due to a lookup deferring, search_find_defer will be TRUE
6455 expand_string(uschar *string)
6457 search_find_defer = FALSE;
6458 malformed_header = FALSE;
6459 return (Ustrpbrk(string, "$\\") == NULL)? string :
6460 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6465 /*************************************************
6467 *************************************************/
6469 /* Now and again we want to expand a string and be sure that the result is in a
6470 new bit of store. This function does that.
6472 Argument: the string to be expanded
6473 Returns: the expanded string, always in a new bit of store, or NULL
6477 expand_string_copy(uschar *string)
6479 uschar *yield = expand_string(string);
6480 if (yield == string) yield = string_copy(string);
6486 /*************************************************
6487 * Expand and interpret as an integer *
6488 *************************************************/
6490 /* Expand a string, and convert the result into an integer.
6493 string the string to be expanded
6494 isplus TRUE if a non-negative number is expected
6496 Returns: the integer value, or
6497 -1 for an expansion error ) in both cases, message in
6498 -2 for an integer interpretation error ) expand_string_message
6499 expand_string_message is set NULL for an OK integer
6503 expand_string_integer(uschar *string, BOOL isplus)
6505 int_eximarith_t value;
6506 uschar *s = expand_string(string);
6507 uschar *msg = US"invalid integer \"%s\"";
6510 /* If expansion failed, expand_string_message will be set. */
6512 if (s == NULL) return -1;
6514 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6515 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6516 systems, so we set it zero ourselves. */
6519 expand_string_message = NULL; /* Indicates no error */
6521 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6522 equal to 0. Unfortunately, people actually relied upon that, so preserve
6523 the behaviour explicitly. Stripping leading whitespace is a harmless
6524 noop change since strtol skips it anyway (provided that there is a number
6528 while (isspace(*s)) ++s;
6532 debug_printf("treating blank string as number 0\n");
6537 value = strtoll(CS s, CSS &endptr, 10);
6541 msg = US"integer expected but \"%s\" found";
6543 else if (value < 0 && isplus)
6545 msg = US"non-negative integer expected but \"%s\" found";
6549 switch (tolower(*endptr))
6554 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
6559 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
6560 else value *= 1024*1024;
6564 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
6565 else value *= 1024*1024*1024;
6569 if (errno == ERANGE)
6570 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6573 while (isspace(*endptr)) endptr++;
6574 if (*endptr == 0) return value;
6578 expand_string_message = string_sprintf(CS msg, s);
6583 /*************************************************
6584 **************************************************
6585 * Stand-alone test program *
6586 **************************************************
6587 *************************************************/
6593 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6595 int ovector[3*(EXPAND_MAXN+1)];
6596 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6597 ovector, sizeof(ovector)/sizeof(int));
6598 BOOL yield = n >= 0;
6599 if (n == 0) n = EXPAND_MAXN + 1;
6603 expand_nmax = (setup < 0)? 0 : setup + 1;
6604 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6606 expand_nstring[expand_nmax] = subject + ovector[nn];
6607 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6615 int main(int argc, uschar **argv)
6618 uschar buffer[1024];
6620 debug_selector = D_v;
6621 debug_file = stderr;
6622 debug_fd = fileno(debug_file);
6623 big_buffer = malloc(big_buffer_size);
6625 for (i = 1; i < argc; i++)
6627 if (argv[i][0] == '+')
6629 debug_trace_memory = 2;
6632 if (isdigit(argv[i][0]))
6633 debug_selector = Ustrtol(argv[i], NULL, 0);
6635 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6639 eldap_default_servers = argv[i];
6642 mysql_servers = argv[i];
6645 pgsql_servers = argv[i];
6647 #ifdef EXPERIMENTAL_REDIS
6648 redis_servers = argv[i];
6652 else opt_perl_startup = argv[i];
6656 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6658 expand_nstring[1] = US"string 1....";
6659 expand_nlength[1] = 8;
6663 if (opt_perl_startup != NULL)
6666 printf("Starting Perl interpreter\n");
6667 errstr = init_perl(opt_perl_startup);
6670 printf("** error in perl_startup code: %s\n", errstr);
6671 return EXIT_FAILURE;
6674 #endif /* EXIM_PERL */
6676 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6678 void *reset_point = store_get(0);
6679 uschar *yield = expand_string(buffer);
6682 printf("%s\n", yield);
6683 store_reset(reset_point);
6687 if (search_find_defer) printf("search_find deferred\n");
6688 printf("Failed: %s\n", expand_string_message);
6689 if (expand_string_forcedfail) printf("Forced failure\n");
6701 /* End of expand.c */