1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, BOOL, BOOL *);
19 #ifndef SUPPORT_CRYPTEQ
20 #define SUPPORT_CRYPTEQ
25 #include "lookups/ldap.h"
28 #ifdef SUPPORT_CRYPTEQ
33 extern char* crypt16(char*, char*);
37 /* The handling of crypt16() is a mess. I will record below the analysis of the
38 mess that was sent to me. We decided, however, to make changing this very low
39 priority, because in practice people are moving away from the crypt()
40 algorithms nowadays, so it doesn't seem worth it.
43 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
44 the first 8 characters of the password using a 20-round version of crypt
45 (standard crypt does 25 rounds). It then crypts the next 8 characters,
46 or an empty block if the password is less than 9 characters, using a
47 20-round version of crypt and the same salt as was used for the first
48 block. Charaters after the first 16 are ignored. It always generates
49 a 16-byte hash, which is expressed together with the salt as a string
50 of 24 base 64 digits. Here are some links to peruse:
52 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
53 http://seclists.org/bugtraq/1999/Mar/0076.html
55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
56 and OSF/1. This is the same as the standard crypt if given a password
57 of 8 characters or less. If given more, it first does the same as crypt
58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
59 using as salt the first two base 64 digits from the first hash block.
60 If the password is more than 16 characters then it crypts the 17th to 24th
61 characters using as salt the first two base 64 digits from the second hash
62 block. And so on: I've seen references to it cutting off the password at
63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0109.html
67 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
68 TET1_html/sec.c222.html#no_id_208
70 Exim has something it calls "crypt16". It will either use a native
71 crypt16 or its own implementation. A native crypt16 will presumably
72 be the one that I called "crypt16" above. The internal "crypt16"
73 function, however, is a two-block-maximum implementation of what I called
74 "bigcrypt". The documentation matches the internal code.
76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
77 that crypt16 and bigcrypt were different things.
79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
80 to whatever it is using under that name. This unfortunately sets a
81 precedent for using "{crypt16}" to identify two incompatible algorithms
82 whose output can't be distinguished. With "{crypt16}" thus rendered
83 ambiguous, I suggest you deprecate it and invent two new identifiers
84 for the two algorithms.
86 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
87 of the password separately means they can be cracked separately, so
88 the double-length hash only doubles the cracking effort instead of
89 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 # define nelements(arr) (sizeof(arr) / sizeof(*arr))
100 /*************************************************
101 * Local statics and tables *
102 *************************************************/
104 /* Table of item names, and corresponding switch numbers. The names must be in
105 alphabetical order. */
107 static uschar *item_table[] = {
157 /* Tables of operator names, and corresponding switch numbers. The names must be
158 in alphabetical order. There are two tables, because underscore is used in some
159 cases to introduce arguments, whereas for other it is part of the name. This is
160 an historical mis-design. */
162 static uschar *op_table_underscore[] = {
165 US"quote_local_part",
173 EOP_QUOTE_LOCAL_PART,
178 static uschar *op_table_main[] = {
216 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
253 /* Table of condition names, and corresponding switch numbers. The names must
254 be in alphabetical order. */
256 static uschar *cond_table[] = {
260 US"==", /* Backward compatibility */
293 US"match_local_part",
318 ECOND_FIRST_DELIVERY,
339 ECOND_MATCH_LOCAL_PART,
349 /* Type for main variable table */
357 /* Type for entries pointing to address/length pairs. Not currently
365 /* Types of table entry */
368 vtype_int, /* value is address of int */
369 vtype_filter_int, /* ditto, but recognized only when filtering */
370 vtype_ino, /* value is address of ino_t (not always an int) */
371 vtype_uid, /* value is address of uid_t (not always an int) */
372 vtype_gid, /* value is address of gid_t (not always an int) */
373 vtype_bool, /* value is address of bool */
374 vtype_stringptr, /* value is address of pointer to string */
375 vtype_msgbody, /* as stringptr, but read when first required */
376 vtype_msgbody_end, /* ditto, the end of the message */
377 vtype_msgheaders, /* the message's headers, processed */
378 vtype_msgheaders_raw, /* the message's headers, unprocessed */
379 vtype_localpart, /* extract local part from string */
380 vtype_domain, /* extract domain from string */
381 vtype_string_func, /* value is string returned by given function */
382 vtype_todbsdin, /* value not used; generate BSD inbox tod */
383 vtype_tode, /* value not used; generate tod in epoch format */
384 vtype_todel, /* value not used; generate tod in epoch/usec format */
385 vtype_todf, /* value not used; generate full tod */
386 vtype_todl, /* value not used; generate log tod */
387 vtype_todlf, /* value not used; generate log file datestamp tod */
388 vtype_todzone, /* value not used; generate time zone only */
389 vtype_todzulu, /* value not used; generate zulu tod */
390 vtype_reply, /* value not used; get reply from headers */
391 vtype_pid, /* value not used; result is pid */
392 vtype_host_lookup, /* value not used; get host name */
393 vtype_load_avg, /* value not used; result is int from os_getloadavg */
394 vtype_pspace, /* partition space; value is T/F for spool/log */
395 vtype_pinodes, /* partition inodes; value is T/F for spool/log */
396 vtype_cert /* SSL certificate */
398 ,vtype_dkim /* Lookup of value in DKIM signature */
402 static uschar * fn_recipients(void);
404 /* This table must be kept in alphabetical order. */
406 static var_entry var_table[] = {
407 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
408 they will be confused with user-creatable ACL variables. */
409 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
410 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
411 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
412 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
413 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
414 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
415 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
416 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
417 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
418 { "acl_narg", vtype_int, &acl_narg },
419 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
420 { "address_data", vtype_stringptr, &deliver_address_data },
421 { "address_file", vtype_stringptr, &address_file },
422 { "address_pipe", vtype_stringptr, &address_pipe },
423 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
424 { "authenticated_id", vtype_stringptr, &authenticated_id },
425 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
426 { "authentication_failed",vtype_int, &authentication_failed },
427 #ifdef WITH_CONTENT_SCAN
428 { "av_failed", vtype_int, &av_failed },
430 #ifdef EXPERIMENTAL_BRIGHTMAIL
431 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
432 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
433 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
434 { "bmi_deliver", vtype_int, &bmi_deliver },
436 { "body_linecount", vtype_int, &body_linecount },
437 { "body_zerocount", vtype_int, &body_zerocount },
438 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
439 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
440 { "caller_gid", vtype_gid, &real_gid },
441 { "caller_uid", vtype_uid, &real_uid },
442 { "compile_date", vtype_stringptr, &version_date },
443 { "compile_number", vtype_stringptr, &version_cnumber },
444 { "csa_status", vtype_stringptr, &csa_status },
445 #ifdef EXPERIMENTAL_DCC
446 { "dcc_header", vtype_stringptr, &dcc_header },
447 { "dcc_result", vtype_stringptr, &dcc_result },
449 #ifdef WITH_OLD_DEMIME
450 { "demime_errorlevel", vtype_int, &demime_errorlevel },
451 { "demime_reason", vtype_stringptr, &demime_reason },
454 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
455 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
456 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
457 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
458 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
459 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
460 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
461 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
462 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
463 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
464 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
465 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
466 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
467 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
468 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
469 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
470 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
471 { "dkim_signers", vtype_stringptr, &dkim_signers },
472 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
473 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
475 #ifdef EXPERIMENTAL_DMARC
476 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
477 { "dmarc_domain_policy", vtype_stringptr, &dmarc_domain_policy },
478 { "dmarc_status", vtype_stringptr, &dmarc_status },
479 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
480 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
482 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
483 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
484 { "dnslist_text", vtype_stringptr, &dnslist_text },
485 { "dnslist_value", vtype_stringptr, &dnslist_value },
486 { "domain", vtype_stringptr, &deliver_domain },
487 { "domain_data", vtype_stringptr, &deliver_domain_data },
488 { "exim_gid", vtype_gid, &exim_gid },
489 { "exim_path", vtype_stringptr, &exim_path },
490 { "exim_uid", vtype_uid, &exim_uid },
491 #ifdef WITH_OLD_DEMIME
492 { "found_extension", vtype_stringptr, &found_extension },
494 { "headers_added", vtype_string_func, &fn_hdrs_added },
495 { "home", vtype_stringptr, &deliver_home },
496 { "host", vtype_stringptr, &deliver_host },
497 { "host_address", vtype_stringptr, &deliver_host_address },
498 { "host_data", vtype_stringptr, &host_data },
499 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
500 { "host_lookup_failed", vtype_int, &host_lookup_failed },
501 { "inode", vtype_ino, &deliver_inode },
502 { "interface_address", vtype_stringptr, &interface_address },
503 { "interface_port", vtype_int, &interface_port },
504 { "item", vtype_stringptr, &iterate_item },
506 { "ldap_dn", vtype_stringptr, &eldap_dn },
508 { "load_average", vtype_load_avg, NULL },
509 { "local_part", vtype_stringptr, &deliver_localpart },
510 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
511 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
512 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
513 { "local_scan_data", vtype_stringptr, &local_scan_data },
514 { "local_user_gid", vtype_gid, &local_user_gid },
515 { "local_user_uid", vtype_uid, &local_user_uid },
516 { "localhost_number", vtype_int, &host_number },
517 { "log_inodes", vtype_pinodes, (void *)FALSE },
518 { "log_space", vtype_pspace, (void *)FALSE },
519 { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
520 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
521 #ifdef WITH_CONTENT_SCAN
522 { "malware_name", vtype_stringptr, &malware_name },
524 { "max_received_linelength", vtype_int, &max_received_linelength },
525 { "message_age", vtype_int, &message_age },
526 { "message_body", vtype_msgbody, &message_body },
527 { "message_body_end", vtype_msgbody_end, &message_body_end },
528 { "message_body_size", vtype_int, &message_body_size },
529 { "message_exim_id", vtype_stringptr, &message_id },
530 { "message_headers", vtype_msgheaders, NULL },
531 { "message_headers_raw", vtype_msgheaders_raw, NULL },
532 { "message_id", vtype_stringptr, &message_id },
533 { "message_linecount", vtype_int, &message_linecount },
534 { "message_size", vtype_int, &message_size },
535 #ifdef WITH_CONTENT_SCAN
536 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
537 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
538 { "mime_boundary", vtype_stringptr, &mime_boundary },
539 { "mime_charset", vtype_stringptr, &mime_charset },
540 { "mime_content_description", vtype_stringptr, &mime_content_description },
541 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
542 { "mime_content_id", vtype_stringptr, &mime_content_id },
543 { "mime_content_size", vtype_int, &mime_content_size },
544 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
545 { "mime_content_type", vtype_stringptr, &mime_content_type },
546 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
547 { "mime_filename", vtype_stringptr, &mime_filename },
548 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
549 { "mime_is_multipart", vtype_int, &mime_is_multipart },
550 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
551 { "mime_part_count", vtype_int, &mime_part_count },
553 { "n0", vtype_filter_int, &filter_n[0] },
554 { "n1", vtype_filter_int, &filter_n[1] },
555 { "n2", vtype_filter_int, &filter_n[2] },
556 { "n3", vtype_filter_int, &filter_n[3] },
557 { "n4", vtype_filter_int, &filter_n[4] },
558 { "n5", vtype_filter_int, &filter_n[5] },
559 { "n6", vtype_filter_int, &filter_n[6] },
560 { "n7", vtype_filter_int, &filter_n[7] },
561 { "n8", vtype_filter_int, &filter_n[8] },
562 { "n9", vtype_filter_int, &filter_n[9] },
563 { "original_domain", vtype_stringptr, &deliver_domain_orig },
564 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
565 { "originator_gid", vtype_gid, &originator_gid },
566 { "originator_uid", vtype_uid, &originator_uid },
567 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
568 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
569 { "pid", vtype_pid, NULL },
570 { "primary_hostname", vtype_stringptr, &primary_hostname },
571 #ifdef EXPERIMENTAL_PROXY
572 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
573 { "proxy_host_port", vtype_int, &proxy_host_port },
574 { "proxy_session", vtype_bool, &proxy_session },
575 { "proxy_target_address",vtype_stringptr, &proxy_target_address },
576 { "proxy_target_port", vtype_int, &proxy_target_port },
578 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
579 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
580 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
581 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
582 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
583 { "rcpt_count", vtype_int, &rcpt_count },
584 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
585 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
586 { "received_count", vtype_int, &received_count },
587 { "received_for", vtype_stringptr, &received_for },
588 { "received_ip_address", vtype_stringptr, &interface_address },
589 { "received_port", vtype_int, &interface_port },
590 { "received_protocol", vtype_stringptr, &received_protocol },
591 { "received_time", vtype_int, &received_time },
592 { "recipient_data", vtype_stringptr, &recipient_data },
593 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
594 { "recipients", vtype_string_func, &fn_recipients },
595 { "recipients_count", vtype_int, &recipients_count },
596 #ifdef WITH_CONTENT_SCAN
597 { "regex_match_string", vtype_stringptr, ®ex_match_string },
599 { "reply_address", vtype_reply, NULL },
600 { "return_path", vtype_stringptr, &return_path },
601 { "return_size_limit", vtype_int, &bounce_return_size_limit },
602 { "router_name", vtype_stringptr, &router_name },
603 { "runrc", vtype_int, &runrc },
604 { "self_hostname", vtype_stringptr, &self_hostname },
605 { "sender_address", vtype_stringptr, &sender_address },
606 { "sender_address_data", vtype_stringptr, &sender_address_data },
607 { "sender_address_domain", vtype_domain, &sender_address },
608 { "sender_address_local_part", vtype_localpart, &sender_address },
609 { "sender_data", vtype_stringptr, &sender_data },
610 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
611 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
612 { "sender_host_address", vtype_stringptr, &sender_host_address },
613 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
614 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
615 { "sender_host_name", vtype_host_lookup, NULL },
616 { "sender_host_port", vtype_int, &sender_host_port },
617 { "sender_ident", vtype_stringptr, &sender_ident },
618 { "sender_rate", vtype_stringptr, &sender_rate },
619 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
620 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
621 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
622 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
623 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
624 { "sending_port", vtype_int, &sending_port },
625 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
626 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
627 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
628 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
629 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
630 { "sn0", vtype_filter_int, &filter_sn[0] },
631 { "sn1", vtype_filter_int, &filter_sn[1] },
632 { "sn2", vtype_filter_int, &filter_sn[2] },
633 { "sn3", vtype_filter_int, &filter_sn[3] },
634 { "sn4", vtype_filter_int, &filter_sn[4] },
635 { "sn5", vtype_filter_int, &filter_sn[5] },
636 { "sn6", vtype_filter_int, &filter_sn[6] },
637 { "sn7", vtype_filter_int, &filter_sn[7] },
638 { "sn8", vtype_filter_int, &filter_sn[8] },
639 { "sn9", vtype_filter_int, &filter_sn[9] },
640 #ifdef WITH_CONTENT_SCAN
641 { "spam_bar", vtype_stringptr, &spam_bar },
642 { "spam_report", vtype_stringptr, &spam_report },
643 { "spam_score", vtype_stringptr, &spam_score },
644 { "spam_score_int", vtype_stringptr, &spam_score_int },
646 #ifdef EXPERIMENTAL_SPF
647 { "spf_guess", vtype_stringptr, &spf_guess },
648 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
649 { "spf_received", vtype_stringptr, &spf_received },
650 { "spf_result", vtype_stringptr, &spf_result },
651 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
653 { "spool_directory", vtype_stringptr, &spool_directory },
654 { "spool_inodes", vtype_pinodes, (void *)TRUE },
655 { "spool_space", vtype_pspace, (void *)TRUE },
656 #ifdef EXPERIMENTAL_SRS
657 { "srs_db_address", vtype_stringptr, &srs_db_address },
658 { "srs_db_key", vtype_stringptr, &srs_db_key },
659 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
660 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
661 { "srs_recipient", vtype_stringptr, &srs_recipient },
662 { "srs_status", vtype_stringptr, &srs_status },
664 { "thisaddress", vtype_stringptr, &filter_thisaddress },
666 /* The non-(in,out) variables are now deprecated */
667 { "tls_bits", vtype_int, &tls_in.bits },
668 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
669 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
671 { "tls_in_bits", vtype_int, &tls_in.bits },
672 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
673 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
674 { "tls_in_ourcert", vtype_cert, &tls_in.ourcert },
675 { "tls_in_peercert", vtype_cert, &tls_in.peercert },
676 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
677 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
678 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
680 { "tls_out_bits", vtype_int, &tls_out.bits },
681 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
682 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
683 { "tls_out_ourcert", vtype_cert, &tls_out.ourcert },
684 { "tls_out_peercert", vtype_cert, &tls_out.peercert },
685 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
686 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
687 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
690 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
691 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
692 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
695 { "tod_bsdinbox", vtype_todbsdin, NULL },
696 { "tod_epoch", vtype_tode, NULL },
697 { "tod_epoch_l", vtype_todel, NULL },
698 { "tod_full", vtype_todf, NULL },
699 { "tod_log", vtype_todl, NULL },
700 { "tod_logfile", vtype_todlf, NULL },
701 { "tod_zone", vtype_todzone, NULL },
702 { "tod_zulu", vtype_todzulu, NULL },
703 #ifdef EXPERIMENTAL_TPDA
704 { "tpda_defer_errno", vtype_int, &tpda_defer_errno },
705 { "tpda_defer_errstr", vtype_stringptr, &tpda_defer_errstr },
706 { "tpda_delivery_confirmation", vtype_stringptr, &tpda_delivery_confirmation },
707 { "tpda_delivery_domain", vtype_stringptr, &tpda_delivery_domain },
708 { "tpda_delivery_fqdn", vtype_stringptr, &tpda_delivery_fqdn },
709 { "tpda_delivery_ip", vtype_stringptr, &tpda_delivery_ip },
710 { "tpda_delivery_local_part",vtype_stringptr,&tpda_delivery_local_part },
711 { "tpda_delivery_port", vtype_int, &tpda_delivery_port },
713 { "transport_name", vtype_stringptr, &transport_name },
714 { "value", vtype_stringptr, &lookup_value },
715 { "version_number", vtype_stringptr, &version_string },
716 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
717 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
718 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
719 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
720 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
721 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
724 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
725 static uschar var_buffer[256];
726 static BOOL malformed_header;
728 /* For textual hashes */
730 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
731 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
734 enum { HMAC_MD5, HMAC_SHA1 };
736 /* For numeric hashes */
738 static unsigned int prime[] = {
739 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
740 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
741 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
743 /* For printing modes in symbolic form */
745 static uschar *mtable_normal[] =
746 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
748 static uschar *mtable_setid[] =
749 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
751 static uschar *mtable_sticky[] =
752 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
756 /*************************************************
757 * Tables for UTF-8 support *
758 *************************************************/
760 /* Table of the number of extra characters, indexed by the first character
761 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
764 static uschar utf8_table1[] = {
765 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
766 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
767 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
768 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
770 /* These are the masks for the data bits in the first byte of a character,
771 indexed by the number of additional bytes. */
773 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
775 /* Get the next UTF-8 character, advancing the pointer. */
777 #define GETUTF8INC(c, ptr) \
779 if ((c & 0xc0) == 0xc0) \
781 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
783 c = (c & utf8_table2[a]) << s; \
787 c |= (*ptr++ & 0x3f) << s; \
792 /*************************************************
793 * Binary chop search on a table *
794 *************************************************/
796 /* This is used for matching expansion items and operators.
799 name the name that is being sought
800 table the table to search
801 table_size the number of items in the table
803 Returns: the offset in the table, or -1
807 chop_match(uschar *name, uschar **table, int table_size)
809 uschar **bot = table;
810 uschar **top = table + table_size;
814 uschar **mid = bot + (top - bot)/2;
815 int c = Ustrcmp(name, *mid);
816 if (c == 0) return mid - table;
817 if (c > 0) bot = mid + 1; else top = mid;
825 /*************************************************
826 * Check a condition string *
827 *************************************************/
829 /* This function is called to expand a string, and test the result for a "true"
830 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
831 forced fail or lookup defer.
833 We used to release all store used, but this is not not safe due
834 to ${dlfunc } and ${acl }. In any case expand_string_internal()
835 is reasonably careful to release what it can.
837 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
840 condition the condition string
841 m1 text to be incorporated in panic error
844 Returns: TRUE if condition is met, FALSE if not
848 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
851 uschar *ss = expand_string(condition);
854 if (!expand_string_forcedfail && !search_find_defer)
855 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
856 "for %s %s: %s", condition, m1, m2, expand_string_message);
859 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
860 strcmpic(ss, US"false") != 0;
867 /*************************************************
868 * Pseudo-random number generation *
869 *************************************************/
871 /* Pseudo-random number generation. The result is not "expected" to be
872 cryptographically strong but not so weak that someone will shoot themselves
873 in the foot using it as a nonce in some email header scheme or whatever
874 weirdness they'll twist this into. The result should ideally handle fork().
876 However, if we're stuck unable to provide this, then we'll fall back to
877 appallingly bad randomness.
879 If SUPPORT_TLS is defined then this will not be used except as an emergency
884 Returns a random number in range [0, max-1]
888 # define vaguely_random_number vaguely_random_number_fallback
891 vaguely_random_number(int max)
894 # undef vaguely_random_number
896 static pid_t pid = 0;
898 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
908 #ifdef HAVE_ARC4RANDOM
909 /* cryptographically strong randomness, common on *BSD platforms, not
910 so much elsewhere. Alas. */
912 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
913 #ifdef HAVE_SRANDOMDEV
914 /* uses random(4) for seeding */
917 gettimeofday(&tv, NULL);
918 srandom(tv.tv_sec | tv.tv_usec | getpid());
921 /* Poor randomness and no seeding here */
928 #ifdef HAVE_ARC4RANDOM
929 return arc4random() % max;
930 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
931 return random() % max;
933 /* This one returns a 16-bit number, definitely not crypto-strong */
934 return random_number(max);
941 /*************************************************
942 * Pick out a name from a string *
943 *************************************************/
945 /* If the name is too long, it is silently truncated.
948 name points to a buffer into which to put the name
949 max is the length of the buffer
950 s points to the first alphabetic character of the name
951 extras chars other than alphanumerics to permit
953 Returns: pointer to the first character after the name
955 Note: The test for *s != 0 in the while loop is necessary because
956 Ustrchr() yields non-NULL if the character is zero (which is not something
960 read_name(uschar *name, int max, uschar *s, uschar *extras)
963 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
965 if (ptr < max-1) name[ptr++] = *s;
974 /*************************************************
975 * Pick out the rest of a header name *
976 *************************************************/
978 /* A variable name starting $header_ (or just $h_ for those who like
979 abbreviations) might not be the complete header name because headers can
980 contain any printing characters in their names, except ':'. This function is
981 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
982 on the end, if the name was terminated by white space.
985 name points to a buffer in which the name read so far exists
986 max is the length of the buffer
987 s points to the first character after the name so far, i.e. the
988 first non-alphameric character after $header_xxxxx
990 Returns: a pointer to the first character after the header name
994 read_header_name(uschar *name, int max, uschar *s)
996 int prelen = Ustrchr(name, '_') - name + 1;
997 int ptr = Ustrlen(name) - prelen;
998 if (ptr > 0) memmove(name, name+prelen, ptr);
999 while (mac_isgraph(*s) && *s != ':')
1001 if (ptr < max-1) name[ptr++] = *s;
1012 /*************************************************
1013 * Pick out a number from a string *
1014 *************************************************/
1017 n points to an integer into which to put the number
1018 s points to the first digit of the number
1020 Returns: a pointer to the character after the last digit
1024 read_number(int *n, uschar *s)
1027 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1033 /*************************************************
1034 * Extract keyed subfield from a string *
1035 *************************************************/
1037 /* The yield is in dynamic store; NULL means that the key was not found.
1040 key points to the name of the key
1041 s points to the string from which to extract the subfield
1043 Returns: NULL if the subfield was not found, or
1044 a pointer to the subfield's data
1048 expand_getkeyed(uschar *key, uschar *s)
1050 int length = Ustrlen(key);
1051 while (isspace(*s)) s++;
1053 /* Loop to search for the key */
1061 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1062 dkeylength = s - dkey;
1063 while (isspace(*s)) s++;
1064 if (*s == '=') while (isspace((*(++s))));
1066 data = string_dequote(&s);
1067 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1070 while (isspace(*s)) s++;
1079 find_var_ent(uschar * name)
1082 int last = var_table_size;
1084 while (last > first)
1086 int middle = (first + last)/2;
1087 int c = Ustrcmp(name, var_table[middle].name);
1089 if (c > 0) { first = middle + 1; continue; }
1090 if (c < 0) { last = middle; continue; }
1091 return &var_table[middle];
1096 /*************************************************
1097 * Extract numbered subfield from string *
1098 *************************************************/
1100 /* Extracts a numbered field from a string that is divided by tokens - for
1101 example a line from /etc/passwd is divided by colon characters. First field is
1102 numbered one. Negative arguments count from the right. Zero returns the whole
1103 string. Returns NULL if there are insufficient tokens in the string
1106 Modifies final argument - this is a dynamically generated string, so that's OK.
1109 field number of field to be extracted,
1110 first field = 1, whole string = 0, last field = -1
1111 separators characters that are used to break string into tokens
1112 s points to the string from which to extract the subfield
1114 Returns: NULL if the field was not found,
1115 a pointer to the field's data inside s (modified to add 0)
1119 expand_gettokened (int field, uschar *separators, uschar *s)
1124 uschar *fieldtext = NULL;
1126 if (field == 0) return s;
1128 /* Break the line up into fields in place; for field > 0 we stop when we have
1129 done the number of fields we want. For field < 0 we continue till the end of
1130 the string, counting the number of fields. */
1132 count = (field > 0)? field : INT_MAX;
1138 /* Previous field was the last one in the string. For a positive field
1139 number, this means there are not enough fields. For a negative field number,
1140 check that there are enough, and scan back to find the one that is wanted. */
1144 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1145 if ((-field) == (INT_MAX - count - 1)) return s;
1149 while (ss[-1] != 0) ss--;
1155 /* Previous field was not last in the string; save its start and put a
1159 len = Ustrcspn(ss, separators);
1170 expand_getlistele(int field, uschar * list)
1172 uschar * tlist= list;
1178 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1181 if(field==0) return NULL;
1182 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1183 return string_nextinlist(&list, &sep, NULL, 0);
1187 /* Certificate fields, by name. Worry about by-OID later */
1193 uschar * (*getfn)(void * cert);
1195 static certfield certfields[] =
1196 { /* linear search; no special order */
1197 { US"version", &tls_cert_version },
1198 { US"serial_number", &tls_cert_serial_number },
1199 { US"subject", &tls_cert_subject },
1200 { US"notbefore", &tls_cert_not_before },
1201 { US"notafter", &tls_cert_not_after },
1202 { US"issuer", &tls_cert_issuer },
1203 { US"signature", &tls_cert_signature },
1204 { US"signature_algorithm", &tls_cert_signature_algorithm },
1205 { US"subject_altname", &tls_cert_subject_altname },
1206 { US"ocsp_uri", &tls_cert_ocsp_uri },
1207 { US"crl_uri", &tls_cert_crl_uri },
1211 expand_getcertele(uschar * field, uschar * certvar)
1216 if (!(vp = find_var_ent(certvar)))
1218 expand_string_message =
1219 string_sprintf("no variable named \"%s\"", certvar);
1220 return NULL; /* Unknown variable name */
1222 /* NB this stops us passing certs around in variable. Might
1223 want to do that in future */
1224 if (vp->type != vtype_cert)
1226 expand_string_message =
1227 string_sprintf("\"%s\" is not a certificate", certvar);
1228 return NULL; /* Unknown variable name */
1230 if (!*(void **)vp->value)
1233 if (*field >= '0' && *field <= '9')
1234 return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1236 for(cp = certfields;
1237 cp < certfields + nelements(certfields);
1239 if (Ustrcmp(cp->name, field) == 0)
1240 return (*cp->getfn)( *(void **)vp->value );
1242 expand_string_message =
1243 string_sprintf("bad field selector \"%s\" for certextract", field);
1246 #endif /*SUPPORT_TLS*/
1248 /*************************************************
1249 * Extract a substring from a string *
1250 *************************************************/
1252 /* Perform the ${substr or ${length expansion operations.
1255 subject the input string
1256 value1 the offset from the start of the input string to the start of
1257 the output string; if negative, count from the right.
1258 value2 the length of the output string, or negative (-1) for unset
1259 if value1 is positive, unset means "all after"
1260 if value1 is negative, unset means "all before"
1261 len set to the length of the returned string
1263 Returns: pointer to the output string, or NULL if there is an error
1267 extract_substr(uschar *subject, int value1, int value2, int *len)
1269 int sublen = Ustrlen(subject);
1271 if (value1 < 0) /* count from right */
1275 /* If the position is before the start, skip to the start, and adjust the
1276 length. If the length ends up negative, the substring is null because nothing
1277 can precede. This falls out naturally when the length is unset, meaning "all
1283 if (value2 < 0) value2 = 0;
1287 /* Otherwise an unset length => characters before value1 */
1289 else if (value2 < 0)
1296 /* For a non-negative offset, if the starting position is past the end of the
1297 string, the result will be the null string. Otherwise, an unset length means
1298 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1302 if (value1 > sublen)
1307 else if (value2 < 0) value2 = sublen;
1310 /* Cut the length down to the maximum possible for the offset value, and get
1311 the required characters. */
1313 if (value1 + value2 > sublen) value2 = sublen - value1;
1315 return subject + value1;
1321 /*************************************************
1322 * Old-style hash of a string *
1323 *************************************************/
1325 /* Perform the ${hash expansion operation.
1328 subject the input string (an expanded substring)
1329 value1 the length of the output string; if greater or equal to the
1330 length of the input string, the input string is returned
1331 value2 the number of hash characters to use, or 26 if negative
1332 len set to the length of the returned string
1334 Returns: pointer to the output string, or NULL if there is an error
1338 compute_hash(uschar *subject, int value1, int value2, int *len)
1340 int sublen = Ustrlen(subject);
1342 if (value2 < 0) value2 = 26;
1343 else if (value2 > Ustrlen(hashcodes))
1345 expand_string_message =
1346 string_sprintf("hash count \"%d\" too big", value2);
1350 /* Calculate the hash text. We know it is shorter than the original string, so
1351 can safely place it in subject[] (we know that subject is always itself an
1352 expanded substring). */
1354 if (value1 < sublen)
1359 while ((c = (subject[j])) != 0)
1361 int shift = (c + j++) & 7;
1362 subject[i] ^= (c << shift) | (c >> (8-shift));
1363 if (++i >= value1) i = 0;
1365 for (i = 0; i < value1; i++)
1366 subject[i] = hashcodes[(subject[i]) % value2];
1368 else value1 = sublen;
1377 /*************************************************
1378 * Numeric hash of a string *
1379 *************************************************/
1381 /* Perform the ${nhash expansion operation. The first characters of the
1382 string are treated as most important, and get the highest prime numbers.
1385 subject the input string
1386 value1 the maximum value of the first part of the result
1387 value2 the maximum value of the second part of the result,
1388 or negative to produce only a one-part result
1389 len set to the length of the returned string
1391 Returns: pointer to the output string, or NULL if there is an error.
1395 compute_nhash (uschar *subject, int value1, int value2, int *len)
1397 uschar *s = subject;
1399 unsigned long int total = 0; /* no overflow */
1403 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1404 total += prime[i--] * (unsigned int)(*s++);
1407 /* If value2 is unset, just compute one number */
1411 s = string_sprintf("%d", total % value1);
1414 /* Otherwise do a div/mod hash */
1418 total = total % (value1 * value2);
1419 s = string_sprintf("%d/%d", total/value2, total % value2);
1430 /*************************************************
1431 * Find the value of a header or headers *
1432 *************************************************/
1434 /* Multiple instances of the same header get concatenated, and this function
1435 can also return a concatenation of all the header lines. When concatenating
1436 specific headers that contain lists of addresses, a comma is inserted between
1437 them. Otherwise we use a straight concatenation. Because some messages can have
1438 pathologically large number of lines, there is a limit on the length that is
1439 returned. Also, to avoid massive store use which would result from using
1440 string_cat() as it copies and extends strings, we do a preliminary pass to find
1441 out exactly how much store will be needed. On "normal" messages this will be
1445 name the name of the header, without the leading $header_ or $h_,
1446 or NULL if a concatenation of all headers is required
1447 exists_only TRUE if called from a def: test; don't need to build a string;
1448 just return a string that is not "" and not "0" if the header
1450 newsize return the size of memory block that was obtained; may be NULL
1451 if exists_only is TRUE
1452 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1453 other than concatenating, will be done on the header. Also used
1454 for $message_headers_raw.
1455 charset name of charset to translate MIME words to; used only if
1456 want_raw is false; if NULL, no translation is done (this is
1457 used for $bh_ and $bheader_)
1459 Returns: NULL if the header does not exist, else a pointer to a new
1464 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1467 BOOL found = name == NULL;
1469 int len = found? 0 : Ustrlen(name);
1471 uschar *yield = NULL;
1474 /* Loop for two passes - saves code repetition */
1476 for (i = 0; i < 2; i++)
1481 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1483 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1485 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1490 if (exists_only) return US"1"; /* don't need actual string */
1492 t = h->text + len; /* text to insert */
1493 if (!want_raw) /* unless wanted raw, */
1494 while (isspace(*t)) t++; /* remove leading white space */
1495 ilen = h->slen - (t - h->text); /* length to insert */
1497 /* Unless wanted raw, remove trailing whitespace, including the
1501 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1503 /* Set comma = 1 if handling a single header and it's one of those
1504 that contains an address list, except when asked for raw headers. Only
1505 need to do this once. */
1507 if (!want_raw && name != NULL && comma == 0 &&
1508 Ustrchr("BCFRST", h->type) != NULL)
1511 /* First pass - compute total store needed; second pass - compute
1512 total store used, including this header. */
1514 size += ilen + comma + 1; /* +1 for the newline */
1516 /* Second pass - concatentate the data, up to a maximum. Note that
1517 the loop stops when size hits the limit. */
1521 if (size > header_insert_maxlen)
1523 ilen -= size - header_insert_maxlen - 1;
1526 Ustrncpy(ptr, t, ilen);
1529 /* For a non-raw header, put in the comma if needed, then add
1530 back the newline we removed above, provided there was some text in
1533 if (!want_raw && ilen > 0)
1535 if (comma != 0) *ptr++ = ',';
1543 /* At end of first pass, return NULL if no header found. Then truncate size
1544 if necessary, and get the buffer to hold the data, returning the buffer size.
1549 if (!found) return NULL;
1550 if (size > header_insert_maxlen) size = header_insert_maxlen;
1551 *newsize = size + 1;
1552 ptr = yield = store_get(*newsize);
1556 /* That's all we do for raw header expansion. */
1563 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1564 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1565 function can return an error with decoded data if the charset translation
1566 fails. If decoding fails, it returns NULL. */
1570 uschar *decoded, *error;
1571 if (ptr > yield && ptr[-1] == '\n') ptr--;
1572 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1574 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1578 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1579 " input was: %s\n", error, yield);
1581 if (decoded != NULL) yield = decoded;
1590 /*************************************************
1591 * Return list of recipients *
1592 *************************************************/
1593 /* A recipients list is available only during system message filtering,
1594 during ACL processing after DATA, and while expanding pipe commands
1595 generated from a system filter, but not elsewhere. */
1600 if (!enable_dollar_recipients) return NULL; else
1605 uschar * s = store_get(size);
1606 for (i = 0; i < recipients_count; i++)
1608 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1609 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1610 Ustrlen(recipients_list[i].address));
1612 s[ptr] = 0; /* string_cat() leaves room */
1618 /*************************************************
1619 * Find value of a variable *
1620 *************************************************/
1622 /* The table of variables is kept in alphabetic order, so we can search it
1623 using a binary chop. The "choplen" variable is nothing to do with the binary
1627 name the name of the variable being sought
1628 exists_only TRUE if this is a def: test; passed on to find_header()
1629 skipping TRUE => skip any processing evaluation; this is not the same as
1630 exists_only because def: may test for values that are first
1632 newsize pointer to an int which is initially zero; if the answer is in
1633 a new memory buffer, *newsize is set to its size
1635 Returns: NULL if the variable does not exist, or
1636 a pointer to the variable's contents, or
1637 something non-NULL if exists_only is TRUE
1641 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1648 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1649 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1650 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1651 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1652 (this gave backwards compatibility at the changeover). There may be built-in
1653 variables whose names start acl_ but they should never start in this way. This
1654 slightly messy specification is a consequence of the history, needless to say.
1656 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1657 set, in which case give an error. */
1659 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1663 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1664 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1667 /* Handle $auth<n> variables. */
1669 if (Ustrncmp(name, "auth", 4) == 0)
1672 int n = Ustrtoul(name + 4, &endptr, 10);
1673 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1674 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1677 /* For all other variables, search the table */
1679 if (!(vp = find_var_ent(name)))
1680 return NULL; /* Unknown variable name */
1682 /* Found an existing variable. If in skipping state, the value isn't needed,
1683 and we want to avoid processing (such as looking up the host name). */
1691 case vtype_filter_int:
1692 if (!filter_running) return NULL;
1696 sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1700 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1704 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1708 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1712 sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1715 case vtype_stringptr: /* Pointer to string */
1716 s = *((uschar **)(val));
1717 return (s == NULL)? US"" : s;
1720 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1723 case vtype_load_avg:
1724 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1727 case vtype_host_lookup: /* Lookup if not done so */
1728 if (sender_host_name == NULL && sender_host_address != NULL &&
1729 !host_lookup_failed && host_name_lookup() == OK)
1730 host_build_sender_fullhost();
1731 return (sender_host_name == NULL)? US"" : sender_host_name;
1733 case vtype_localpart: /* Get local part from address */
1734 s = *((uschar **)(val));
1735 if (s == NULL) return US"";
1736 domain = Ustrrchr(s, '@');
1737 if (domain == NULL) return s;
1738 if (domain - s > sizeof(var_buffer) - 1)
1739 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1740 " in string expansion", sizeof(var_buffer));
1741 Ustrncpy(var_buffer, s, domain - s);
1742 var_buffer[domain - s] = 0;
1745 case vtype_domain: /* Get domain from address */
1746 s = *((uschar **)(val));
1747 if (s == NULL) return US"";
1748 domain = Ustrrchr(s, '@');
1749 return (domain == NULL)? US"" : domain + 1;
1751 case vtype_msgheaders:
1752 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1754 case vtype_msgheaders_raw:
1755 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1757 case vtype_msgbody: /* Pointer to msgbody string */
1758 case vtype_msgbody_end: /* Ditto, the end of the msg */
1759 ss = (uschar **)(val);
1760 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1763 off_t start_offset = SPOOL_DATA_START_OFFSET;
1764 int len = message_body_visible;
1765 if (len > message_size) len = message_size;
1766 *ss = body = store_malloc(len+1);
1768 if (vp->type == vtype_msgbody_end)
1770 struct stat statbuf;
1771 if (fstat(deliver_datafile, &statbuf) == 0)
1773 start_offset = statbuf.st_size - len;
1774 if (start_offset < SPOOL_DATA_START_OFFSET)
1775 start_offset = SPOOL_DATA_START_OFFSET;
1778 lseek(deliver_datafile, start_offset, SEEK_SET);
1779 len = read(deliver_datafile, body, len);
1783 if (message_body_newlines) /* Separate loops for efficiency */
1786 { if (body[--len] == 0) body[len] = ' '; }
1791 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1795 return (*ss == NULL)? US"" : *ss;
1797 case vtype_todbsdin: /* BSD inbox time of day */
1798 return tod_stamp(tod_bsdin);
1800 case vtype_tode: /* Unix epoch time of day */
1801 return tod_stamp(tod_epoch);
1803 case vtype_todel: /* Unix epoch/usec time of day */
1804 return tod_stamp(tod_epoch_l);
1806 case vtype_todf: /* Full time of day */
1807 return tod_stamp(tod_full);
1809 case vtype_todl: /* Log format time of day */
1810 return tod_stamp(tod_log_bare); /* (without timezone) */
1812 case vtype_todzone: /* Time zone offset only */
1813 return tod_stamp(tod_zone);
1815 case vtype_todzulu: /* Zulu time */
1816 return tod_stamp(tod_zulu);
1818 case vtype_todlf: /* Log file datestamp tod */
1819 return tod_stamp(tod_log_datestamp_daily);
1821 case vtype_reply: /* Get reply address */
1822 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1824 if (s != NULL) while (isspace(*s)) s++;
1825 if (s == NULL || *s == 0)
1827 *newsize = 0; /* For the *s==0 case */
1828 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1833 while (isspace(*s)) s++;
1834 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1835 while (t > s && isspace(t[-1])) t--;
1838 return (s == NULL)? US"" : s;
1840 case vtype_string_func:
1842 uschar * (*fn)() = val;
1849 sprintf(CS var_buffer, "%d",
1850 receive_statvfs(val == (void *)TRUE, &inodes));
1857 (void) receive_statvfs(val == (void *)TRUE, &inodes);
1858 sprintf(CS var_buffer, "%d", inodes);
1863 return *(void **)val ? US"<cert>" : US"";
1865 #ifndef DISABLE_DKIM
1867 return dkim_exim_expand_query((int)(long)val);
1877 modify_variable(uschar *name, void * value)
1880 if ((vp = find_var_ent(name))) vp->value = value;
1881 return; /* Unknown variable name, fail silently */
1888 /*************************************************
1889 * Read and expand substrings *
1890 *************************************************/
1892 /* This function is called to read and expand argument substrings for various
1893 expansion items. Some have a minimum requirement that is less than the maximum;
1894 in these cases, the first non-present one is set to NULL.
1897 sub points to vector of pointers to set
1898 n maximum number of substrings
1900 sptr points to current string pointer
1901 skipping the skipping flag
1902 check_end if TRUE, check for final '}'
1903 name name of item, for error message
1904 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1907 Returns: 0 OK; string pointer updated
1908 1 curly bracketing error (too few arguments)
1909 2 too many arguments (only if check_end is set); message set
1910 3 other error (expansion failure)
1914 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1915 BOOL check_end, uschar *name, BOOL *resetok)
1920 while (isspace(*s)) s++;
1921 for (i = 0; i < n; i++)
1925 if (i < m) return 1;
1929 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1930 if (sub[i] == NULL) return 3;
1931 if (*s++ != '}') return 1;
1932 while (isspace(*s)) s++;
1934 if (check_end && *s++ != '}')
1938 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1939 "(max is %d)", name, n);
1952 /*************************************************
1953 * Elaborate message for bad variable *
1954 *************************************************/
1956 /* For the "unknown variable" message, take a look at the variable's name, and
1957 give additional information about possible ACL variables. The extra information
1958 is added on to expand_string_message.
1960 Argument: the name of the variable
1965 check_variable_error_message(uschar *name)
1967 if (Ustrncmp(name, "acl_", 4) == 0)
1968 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1969 (name[4] == 'c' || name[4] == 'm')?
1971 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1972 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1974 US"user-defined ACL variables must start acl_c or acl_m");
1980 Load args from sub array to globals, and call acl_check().
1981 Sub array will be corrupted on return.
1983 Returns: OK access is granted by an ACCEPT verb
1984 DISCARD access is granted by a DISCARD verb
1985 FAIL access is denied
1986 FAIL_DROP access is denied; drop the connection
1987 DEFER can't tell at the moment
1991 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
1995 int sav_narg = acl_narg;
1997 extern int acl_where;
1999 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
2000 for (i = 0; i < nsub && sub[i+1]; i++)
2003 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
2004 sub[i+1] = tmp; /* stash the old args using our caller's storage */
2009 sub[i+1] = acl_arg[i];
2010 acl_arg[i++] = NULL;
2014 debug_printf("expanding: acl: %s arg: %s%s\n",
2016 acl_narg>0 ? acl_arg[0] : US"<none>",
2017 acl_narg>1 ? " +more" : "");
2019 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
2021 for (i = 0; i < nsub; i++)
2022 acl_arg[i] = sub[i+1]; /* restore old args */
2023 acl_narg = sav_narg;
2031 /*************************************************
2032 * Read and evaluate a condition *
2033 *************************************************/
2037 s points to the start of the condition text
2038 resetok points to a BOOL which is written false if it is unsafe to
2039 free memory. Certain condition types (acl) may have side-effect
2040 allocation which must be preserved.
2041 yield points to a BOOL to hold the result of the condition test;
2042 if NULL, we are just reading through a condition that is
2043 part of an "or" combination to check syntax, or in a state
2044 where the answer isn't required
2046 Returns: a pointer to the first character after the condition, or
2051 eval_condition(uschar *s, BOOL *resetok, BOOL *yield)
2053 BOOL testfor = TRUE;
2054 BOOL tempcond, combined_cond;
2056 BOOL sub2_honour_dollar = TRUE;
2057 int i, rc, cond_type, roffset;
2058 int_eximarith_t num[2];
2059 struct stat statbuf;
2064 const uschar *rerror;
2068 while (isspace(*s)) s++;
2069 if (*s == '!') { testfor = !testfor; s++; } else break;
2072 /* Numeric comparisons are symbolic */
2074 if (*s == '=' || *s == '>' || *s == '<')
2086 /* All other conditions are named */
2088 else s = read_name(name, 256, s, US"_");
2090 /* If we haven't read a name, it means some non-alpha character is first. */
2094 expand_string_message = string_sprintf("condition name expected, "
2095 "but found \"%.16s\"", s);
2099 /* Find which condition we are dealing with, and switch on it */
2101 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
2104 /* def: tests for a non-empty variable, or for the existence of a header. If
2105 yield == NULL we are in a skipping state, and don't care about the answer. */
2110 expand_string_message = US"\":\" expected after \"def\"";
2114 s = read_name(name, 256, s+1, US"_");
2116 /* Test for a header's existence. If the name contains a closing brace
2117 character, this may be a user error where the terminating colon has been
2118 omitted. Set a flag to adjust a subsequent error message in this case. */
2120 if (Ustrncmp(name, "h_", 2) == 0 ||
2121 Ustrncmp(name, "rh_", 3) == 0 ||
2122 Ustrncmp(name, "bh_", 3) == 0 ||
2123 Ustrncmp(name, "header_", 7) == 0 ||
2124 Ustrncmp(name, "rheader_", 8) == 0 ||
2125 Ustrncmp(name, "bheader_", 8) == 0)
2127 s = read_header_name(name, 256, s);
2128 /* {-for-text-editors */
2129 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2130 if (yield != NULL) *yield =
2131 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2134 /* Test for a variable's having a non-empty value. A non-existent variable
2135 causes an expansion failure. */
2139 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2142 expand_string_message = (name[0] == 0)?
2143 string_sprintf("variable name omitted after \"def:\"") :
2144 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2145 check_variable_error_message(name);
2148 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2154 /* first_delivery tests for first delivery attempt */
2156 case ECOND_FIRST_DELIVERY:
2157 if (yield != NULL) *yield = deliver_firsttime == testfor;
2161 /* queue_running tests for any process started by a queue runner */
2163 case ECOND_QUEUE_RUNNING:
2164 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2168 /* exists: tests for file existence
2169 isip: tests for any IP address
2170 isip4: tests for an IPv4 address
2171 isip6: tests for an IPv6 address
2172 pam: does PAM authentication
2173 radius: does RADIUS authentication
2174 ldapauth: does LDAP authentication
2175 pwcheck: does Cyrus SASL pwcheck authentication
2184 case ECOND_LDAPAUTH:
2187 while (isspace(*s)) s++;
2188 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2190 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2191 if (sub[0] == NULL) return NULL;
2192 /* {-for-text-editors */
2193 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2195 if (yield == NULL) return s; /* No need to run the test if skipping */
2200 if ((expand_forbid & RDO_EXISTS) != 0)
2202 expand_string_message = US"File existence tests are not permitted";
2205 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2211 rc = string_is_ip_address(sub[0], NULL);
2212 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2213 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2216 /* Various authentication tests - all optionally compiled */
2220 rc = auth_call_pam(sub[0], &expand_string_message);
2223 goto COND_FAILED_NOT_COMPILED;
2224 #endif /* SUPPORT_PAM */
2227 #ifdef RADIUS_CONFIG_FILE
2228 rc = auth_call_radius(sub[0], &expand_string_message);
2231 goto COND_FAILED_NOT_COMPILED;
2232 #endif /* RADIUS_CONFIG_FILE */
2234 case ECOND_LDAPAUTH:
2237 /* Just to keep the interface the same */
2239 int old_pool = store_pool;
2240 store_pool = POOL_SEARCH;
2241 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2242 &expand_string_message, &do_cache);
2243 store_pool = old_pool;
2247 goto COND_FAILED_NOT_COMPILED;
2248 #endif /* LOOKUP_LDAP */
2251 #ifdef CYRUS_PWCHECK_SOCKET
2252 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2255 goto COND_FAILED_NOT_COMPILED;
2256 #endif /* CYRUS_PWCHECK_SOCKET */
2258 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2259 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2261 if (rc == ERROR || rc == DEFER) return NULL;
2262 *yield = (rc == OK) == testfor;
2268 /* call ACL (in a conditional context). Accept true, deny false.
2269 Defer is a forced-fail. Anything set by message= goes to $value.
2270 Up to ten parameters are used; we use the braces round the name+args
2271 like the saslauthd condition does, to permit a variable number of args.
2272 See also the expansion-item version EITEM_ACL and the traditional
2273 acl modifier ACLC_ACL.
2274 Since the ACL may allocate new global variables, tell our caller to not
2279 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2286 while (isspace(*s)) s++;
2287 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2289 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2290 &s, yield == NULL, TRUE, US"acl", resetok))
2292 case 1: expand_string_message = US"too few arguments or bracketing "
2295 case 3: return NULL;
2299 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2304 lookup_value = NULL;
2307 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2308 lookup_value[ptr] = '\0';
2310 *yield = cond == testfor;
2314 expand_string_forcedfail = TRUE;
2316 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2323 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2325 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2327 However, the last two are optional. That is why the whole set is enclosed
2328 in their own set of braces. */
2330 case ECOND_SASLAUTHD:
2331 #ifndef CYRUS_SASLAUTHD_SOCKET
2332 goto COND_FAILED_NOT_COMPILED;
2334 while (isspace(*s)) s++;
2335 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2336 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd", resetok))
2338 case 1: expand_string_message = US"too few arguments or bracketing "
2339 "error for saslauthd";
2341 case 3: return NULL;
2343 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2347 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2348 &expand_string_message);
2349 if (rc == ERROR || rc == DEFER) return NULL;
2350 *yield = (rc == OK) == testfor;
2353 #endif /* CYRUS_SASLAUTHD_SOCKET */
2356 /* symbolic operators for numeric and string comparison, and a number of
2357 other operators, all requiring two arguments.
2359 crypteq: encrypts plaintext and compares against an encrypted text,
2360 using crypt(), crypt16(), MD5 or SHA-1
2361 inlist/inlisti: checks if first argument is in the list of the second
2362 match: does a regular expression match and sets up the numerical
2363 variables if it succeeds
2364 match_address: matches in an address list
2365 match_domain: matches in a domain list
2366 match_ip: matches a host list that is restricted to IP addresses
2367 match_local_part: matches in a local part list
2370 case ECOND_MATCH_ADDRESS:
2371 case ECOND_MATCH_DOMAIN:
2372 case ECOND_MATCH_IP:
2373 case ECOND_MATCH_LOCAL_PART:
2374 #ifndef EXPAND_LISTMATCH_RHS
2375 sub2_honour_dollar = FALSE;
2384 case ECOND_NUM_L: /* Numerical comparisons */
2391 case ECOND_STR_LT: /* String comparisons */
2402 for (i = 0; i < 2; i++)
2404 /* Sometimes, we don't expand substrings; too many insecure configurations
2405 created using match_address{}{} and friends, where the second param
2406 includes information from untrustworthy sources. */
2407 BOOL honour_dollar = TRUE;
2408 if ((i > 0) && !sub2_honour_dollar)
2409 honour_dollar = FALSE;
2411 while (isspace(*s)) s++;
2414 if (i == 0) goto COND_FAILED_CURLY_START;
2415 expand_string_message = string_sprintf("missing 2nd string in {} "
2416 "after \"%s\"", name);
2419 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2420 honour_dollar, resetok);
2421 if (sub[i] == NULL) return NULL;
2422 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2424 /* Convert to numerical if required; we know that the names of all the
2425 conditions that compare numbers do not start with a letter. This just saves
2426 checking for them individually. */
2428 if (!isalpha(name[0]) && yield != NULL)
2434 debug_printf("empty string cast to zero for numerical comparison\n");
2438 num[i] = expand_string_integer(sub[i], FALSE);
2439 if (expand_string_message != NULL) return NULL;
2444 /* Result not required */
2446 if (yield == NULL) return s;
2448 /* Do an appropriate comparison */
2454 tempcond = (num[0] == num[1]);
2458 tempcond = (num[0] > num[1]);
2462 tempcond = (num[0] >= num[1]);
2466 tempcond = (num[0] < num[1]);
2470 tempcond = (num[0] <= num[1]);
2474 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2478 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2482 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2486 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2490 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2494 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2498 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2502 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2506 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2510 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2513 case ECOND_MATCH: /* Regular expression match */
2514 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2518 expand_string_message = string_sprintf("regular expression error in "
2519 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2522 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2525 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2526 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2527 goto MATCHED_SOMETHING;
2529 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2530 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2531 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2532 goto MATCHED_SOMETHING;
2534 case ECOND_MATCH_IP: /* Match IP address in a host list */
2535 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2537 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2543 unsigned int *nullcache = NULL;
2544 check_host_block cb;
2546 cb.host_name = US"";
2547 cb.host_address = sub[0];
2549 /* If the host address starts off ::ffff: it is an IPv6 address in
2550 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2553 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2554 cb.host_address + 7 : cb.host_address;
2556 rc = match_check_list(
2557 &sub[1], /* the list */
2558 0, /* separator character */
2559 &hostlist_anchor, /* anchor pointer */
2560 &nullcache, /* cache pointer */
2561 check_host, /* function for testing */
2562 &cb, /* argument for function */
2563 MCL_HOST, /* type of check */
2564 sub[0], /* text for debugging */
2565 NULL); /* where to pass back data */
2567 goto MATCHED_SOMETHING;
2569 case ECOND_MATCH_LOCAL_PART:
2570 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2571 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2586 expand_string_message = string_sprintf("unable to complete match "
2587 "against \"%s\": %s", sub[1], search_error_message);
2593 /* Various "encrypted" comparisons. If the second string starts with
2594 "{" then an encryption type is given. Default to crypt() or crypt16()
2595 (build-time choice). */
2596 /* }-for-text-editors */
2599 #ifndef SUPPORT_CRYPTEQ
2600 goto COND_FAILED_NOT_COMPILED;
2602 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2604 int sublen = Ustrlen(sub[1]+5);
2609 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2611 /* If the length that we are comparing against is 24, the MD5 digest
2612 is expressed as a base64 string. This is the way LDAP does it. However,
2613 some other software uses a straightforward hex representation. We assume
2614 this if the length is 32. Other lengths fail. */
2618 uschar *coded = auth_b64encode((uschar *)digest, 16);
2619 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2620 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2621 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2623 else if (sublen == 32)
2627 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2629 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2630 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2631 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2635 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2636 "fail\n crypted=%s\n", sub[1]+5);
2641 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2643 int sublen = Ustrlen(sub[1]+6);
2648 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2650 /* If the length that we are comparing against is 28, assume the SHA1
2651 digest is expressed as a base64 string. If the length is 40, assume a
2652 straightforward hex representation. Other lengths fail. */
2656 uschar *coded = auth_b64encode((uschar *)digest, 20);
2657 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2658 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2659 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2661 else if (sublen == 40)
2665 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2667 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2668 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2669 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2673 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2674 "fail\n crypted=%s\n", sub[1]+6);
2679 else /* {crypt} or {crypt16} and non-{ at start */
2680 /* }-for-text-editors */
2685 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2690 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2695 else if (sub[1][0] == '{') /* }-for-text-editors */
2697 expand_string_message = string_sprintf("unknown encryption mechanism "
2698 "in \"%s\"", sub[1]);
2704 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2705 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2706 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2710 #define XSTR(s) STR(s)
2711 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2712 " subject=%s\n crypted=%s\n",
2713 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2718 /* If the encrypted string contains fewer than two characters (for the
2719 salt), force failure. Otherwise we get false positives: with an empty
2720 string the yield of crypt() is an empty string! */
2722 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2723 (Ustrcmp(coded, sub[1]) == 0);
2726 #endif /* SUPPORT_CRYPTEQ */
2732 uschar *save_iterate_item = iterate_item;
2733 int (*compare)(const uschar *, const uschar *);
2736 if (cond_type == ECOND_INLISTI)
2739 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2741 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2742 if (compare(sub[0], iterate_item) == 0)
2747 iterate_item = save_iterate_item;
2750 } /* Switch for comparison conditions */
2752 *yield = tempcond == testfor;
2753 return s; /* End of comparison conditions */
2756 /* and/or: computes logical and/or of several conditions */
2760 subcondptr = (yield == NULL)? NULL : &tempcond;
2761 combined_cond = (cond_type == ECOND_AND);
2763 while (isspace(*s)) s++;
2764 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2768 while (isspace(*s)) s++;
2769 /* {-for-text-editors */
2770 if (*s == '}') break;
2771 if (*s != '{') /* }-for-text-editors */
2773 expand_string_message = string_sprintf("each subcondition "
2774 "inside an \"%s{...}\" condition must be in its own {}", name);
2778 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2780 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2781 expand_string_message, name);
2784 while (isspace(*s)) s++;
2786 /* {-for-text-editors */
2789 /* {-for-text-editors */
2790 expand_string_message = string_sprintf("missing } at end of condition "
2791 "inside \"%s\" group", name);
2797 if (cond_type == ECOND_AND)
2799 combined_cond &= tempcond;
2800 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2801 } /* evaluate any more */
2804 combined_cond |= tempcond;
2805 if (combined_cond) subcondptr = NULL; /* once true, don't */
2806 } /* evaluate any more */
2810 if (yield != NULL) *yield = (combined_cond == testfor);
2814 /* forall/forany: iterates a condition with different values */
2820 uschar *save_iterate_item = iterate_item;
2822 while (isspace(*s)) s++;
2823 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2824 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2825 if (sub[0] == NULL) return NULL;
2826 /* {-for-text-editors */
2827 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2829 while (isspace(*s)) s++;
2830 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2834 /* Call eval_condition once, with result discarded (as if scanning a
2835 "false" part). This allows us to find the end of the condition, because if
2836 the list it empty, we won't actually evaluate the condition for real. */
2838 if (!(s = eval_condition(sub[1], resetok, NULL)))
2840 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2841 expand_string_message, name);
2844 while (isspace(*s)) s++;
2846 /* {-for-text-editors */
2849 /* {-for-text-editors */
2850 expand_string_message = string_sprintf("missing } at end of condition "
2851 "inside \"%s\"", name);
2855 if (yield != NULL) *yield = !testfor;
2856 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2858 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2859 if (!eval_condition(sub[1], resetok, &tempcond))
2861 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2862 expand_string_message, name);
2863 iterate_item = save_iterate_item;
2866 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2867 tempcond? "true":"false");
2869 if (yield != NULL) *yield = (tempcond == testfor);
2870 if (tempcond == (cond_type == ECOND_FORANY)) break;
2873 iterate_item = save_iterate_item;
2878 /* The bool{} expansion condition maps a string to boolean.
2879 The values supported should match those supported by the ACL condition
2880 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2881 of true/false. Note that Router "condition" rules have a different
2882 interpretation, where general data can be used and only a few values
2884 Note that readconf.c boolean matching, for boolean configuration options,
2885 only matches true/yes/false/no.
2886 The bool_lax{} condition matches the Router logic, which is much more
2889 case ECOND_BOOL_LAX:
2895 BOOL boolvalue = FALSE;
2896 while (isspace(*s)) s++;
2897 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2898 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2899 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2901 case 1: expand_string_message = string_sprintf(
2902 "too few arguments or bracketing error for %s",
2906 case 3: return NULL;
2909 while (isspace(*t)) t++;
2913 /* trailing whitespace: seems like a good idea to ignore it too */
2915 while (isspace(*t2)) t2--;
2916 if (t2 != (t + len))
2923 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2924 /* logic for the lax case from expand_check_condition(), which also does
2925 expands, and the logic is both short and stable enough that there should
2926 be no maintenance burden from replicating it. */
2930 ? Ustrspn(t+1, "0123456789") == len-1
2931 : Ustrspn(t, "0123456789") == len)
2933 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2934 /* expand_check_condition only does a literal string "0" check */
2935 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2938 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2940 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2942 else if (cond_type == ECOND_BOOL_LAX)
2946 expand_string_message = string_sprintf("unrecognised boolean "
2950 if (yield != NULL) *yield = (boolvalue == testfor);
2954 /* Unknown condition */
2957 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2959 } /* End switch on condition type */
2961 /* Missing braces at start and end of data */
2963 COND_FAILED_CURLY_START:
2964 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2967 COND_FAILED_CURLY_END:
2968 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2972 /* A condition requires code that is not compiled */
2974 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2975 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2976 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2977 COND_FAILED_NOT_COMPILED:
2978 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2987 /*************************************************
2988 * Save numerical variables *
2989 *************************************************/
2991 /* This function is called from items such as "if" that want to preserve and
2992 restore the numbered variables.
2995 save_expand_string points to an array of pointers to set
2996 save_expand_nlength points to an array of ints for the lengths
2998 Returns: the value of expand max to save
3002 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
3005 for (i = 0; i <= expand_nmax; i++)
3007 save_expand_nstring[i] = expand_nstring[i];
3008 save_expand_nlength[i] = expand_nlength[i];
3015 /*************************************************
3016 * Restore numerical variables *
3017 *************************************************/
3019 /* This function restored saved values of numerical strings.
3022 save_expand_nmax the number of strings to restore
3023 save_expand_string points to an array of pointers
3024 save_expand_nlength points to an array of ints
3030 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
3031 int *save_expand_nlength)
3034 expand_nmax = save_expand_nmax;
3035 for (i = 0; i <= expand_nmax; i++)
3037 expand_nstring[i] = save_expand_nstring[i];
3038 expand_nlength[i] = save_expand_nlength[i];
3046 /*************************************************
3047 * Handle yes/no substrings *
3048 *************************************************/
3050 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3051 alternative substrings that depend on whether or not the condition was true,
3052 or the lookup or extraction succeeded. The substrings always have to be
3053 expanded, to check their syntax, but "skipping" is set when the result is not
3054 needed - this avoids unnecessary nested lookups.
3057 skipping TRUE if we were skipping when this item was reached
3058 yes TRUE if the first string is to be used, else use the second
3059 save_lookup a value to put back into lookup_value before the 2nd expansion
3060 sptr points to the input string pointer
3061 yieldptr points to the output string pointer
3062 sizeptr points to the output string size
3063 ptrptr points to the output string pointer
3064 type "lookup" or "if" or "extract" or "run", for error message
3065 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
3068 Returns: 0 OK; lookup_value has been reset to save_lookup
3070 2 expansion failed because of bracketing error
3074 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
3075 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3078 uschar *s = *sptr; /* Local value */
3079 uschar *sub1, *sub2;
3081 /* If there are no following strings, we substitute the contents of $value for
3082 lookups and for extractions in the success case. For the ${if item, the string
3083 "true" is substituted. In the fail case, nothing is substituted for all three
3086 while (isspace(*s)) s++;
3091 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3095 if (yes && lookup_value != NULL)
3096 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3097 Ustrlen(lookup_value));
3098 lookup_value = save_lookup;
3104 /* The first following string must be braced. */
3106 if (*s++ != '{') goto FAILED_CURLY;
3108 /* Expand the first substring. Forced failures are noticed only if we actually
3109 want this string. Set skipping in the call in the fail case (this will always
3110 be the case if we were already skipping). */
3112 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3113 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3114 expand_string_forcedfail = FALSE;
3115 if (*s++ != '}') goto FAILED_CURLY;
3117 /* If we want the first string, add it to the output */
3120 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3122 /* If this is called from a lookup or an extract, we want to restore $value to
3123 what it was at the start of the item, so that it has this value during the
3124 second string expansion. For the call from "if" or "run" to this function,
3125 save_lookup is set to lookup_value, so that this statement does nothing. */
3127 lookup_value = save_lookup;
3129 /* There now follows either another substring, or "fail", or nothing. This
3130 time, forced failures are noticed only if we want the second string. We must
3131 set skipping in the nested call if we don't want this string, or if we were
3132 already skipping. */
3134 while (isspace(*s)) s++;
3137 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3138 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3139 expand_string_forcedfail = FALSE;
3140 if (*s++ != '}') goto FAILED_CURLY;
3142 /* If we want the second string, add it to the output */
3145 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3148 /* If there is no second string, but the word "fail" is present when the use of
3149 the second string is wanted, set a flag indicating it was a forced failure
3150 rather than a syntactic error. Swallow the terminating } in case this is nested
3151 inside another lookup or if or extract. */
3156 s = read_name(name, sizeof(name), s, US"_");
3157 if (Ustrcmp(name, "fail") == 0)
3159 if (!yes && !skipping)
3161 while (isspace(*s)) s++;
3162 if (*s++ != '}') goto FAILED_CURLY;
3163 expand_string_message =
3164 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3165 expand_string_forcedfail = TRUE;
3171 expand_string_message =
3172 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3177 /* All we have to do now is to check on the final closing brace. */
3179 while (isspace(*s)) s++;
3180 if (*s++ == '}') goto RETURN;
3182 /* Get here if there is a bracketing failure */
3187 /* Get here for other failures */
3192 /* Update the input pointer value before returning */
3202 /*************************************************
3203 * Handle MD5 or SHA-1 computation for HMAC *
3204 *************************************************/
3206 /* These are some wrapping functions that enable the HMAC code to be a bit
3207 cleaner. A good compiler will spot the tail recursion.
3210 type HMAC_MD5 or HMAC_SHA1
3211 remaining are as for the cryptographic hash functions
3217 chash_start(int type, void *base)
3219 if (type == HMAC_MD5)
3220 md5_start((md5 *)base);
3222 sha1_start((sha1 *)base);
3226 chash_mid(int type, void *base, uschar *string)
3228 if (type == HMAC_MD5)
3229 md5_mid((md5 *)base, string);
3231 sha1_mid((sha1 *)base, string);
3235 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3237 if (type == HMAC_MD5)
3238 md5_end((md5 *)base, string, length, digest);
3240 sha1_end((sha1 *)base, string, length, digest);
3247 /********************************************************
3248 * prvs: Get last three digits of days since Jan 1, 1970 *
3249 ********************************************************/
3251 /* This is needed to implement the "prvs" BATV reverse
3254 Argument: integer "days" offset to add or substract to
3255 or from the current number of days.
3257 Returns: pointer to string containing the last three
3258 digits of the number of days since Jan 1, 1970,
3259 modified by the offset argument, NULL if there
3260 was an error in the conversion.
3265 prvs_daystamp(int day_offset)
3267 uschar *days = store_get(32); /* Need at least 24 for cases */
3268 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3269 (time(NULL) + day_offset*86400)/86400);
3270 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3275 /********************************************************
3276 * prvs: perform HMAC-SHA1 computation of prvs bits *
3277 ********************************************************/
3279 /* This is needed to implement the "prvs" BATV reverse
3283 address RFC2821 Address to use
3284 key The key to use (must be less than 64 characters
3286 key_num Single-digit key number to use. Defaults to
3289 Returns: pointer to string containing the first three
3290 bytes of the final hash in hex format, NULL if
3291 there was an error in the process.
3295 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3297 uschar *hash_source, *p;
3298 int size = 0,offset = 0,i;
3300 void *use_base = &sha1_base;
3301 uschar innerhash[20];
3302 uschar finalhash[20];
3303 uschar innerkey[64];
3304 uschar outerkey[64];
3305 uschar *finalhash_hex = store_get(40);
3307 if (key_num == NULL)
3310 if (Ustrlen(key) > 64)
3313 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3314 string_cat(hash_source,&size,&offset,daystamp,3);
3315 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3316 hash_source[offset] = '\0';
3318 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3320 memset(innerkey, 0x36, 64);
3321 memset(outerkey, 0x5c, 64);
3323 for (i = 0; i < Ustrlen(key); i++)
3325 innerkey[i] ^= key[i];
3326 outerkey[i] ^= key[i];
3329 chash_start(HMAC_SHA1, use_base);
3330 chash_mid(HMAC_SHA1, use_base, innerkey);
3331 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3333 chash_start(HMAC_SHA1, use_base);
3334 chash_mid(HMAC_SHA1, use_base, outerkey);
3335 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3338 for (i = 0; i < 3; i++)
3340 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3341 *p++ = hex_digits[finalhash[i] & 0x0f];
3345 return finalhash_hex;
3351 /*************************************************
3352 * Join a file onto the output string *
3353 *************************************************/
3355 /* This is used for readfile and after a run expansion. It joins the contents
3356 of a file onto the output string, globally replacing newlines with a given
3357 string (optionally). The file is closed at the end.
3361 yield pointer to the expandable string
3362 sizep pointer to the current size
3363 ptrp pointer to the current position
3364 eol newline replacement string, or NULL
3366 Returns: new value of string pointer
3370 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3373 uschar buffer[1024];
3375 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3377 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3379 int len = Ustrlen(buffer);
3380 if (eol != NULL && buffer[len-1] == '\n') len--;
3381 yield = string_cat(yield, sizep, ptrp, buffer, len);
3382 if (buffer[len] != 0)
3383 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3386 if (yield != NULL) yield[*ptrp] = 0;
3394 /*************************************************
3395 * Evaluate numeric expression *
3396 *************************************************/
3398 /* This is a set of mutually recursive functions that evaluate an arithmetic
3399 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3400 these functions that is called from elsewhere is eval_expr, whose interface is:
3403 sptr pointer to the pointer to the string - gets updated
3404 decimal TRUE if numbers are to be assumed decimal
3405 error pointer to where to put an error message - must be NULL on input
3406 endket TRUE if ')' must terminate - FALSE for external call
3408 Returns: on success: the value of the expression, with *error still NULL
3409 on failure: an undefined value, with *error = a message
3412 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3415 static int_eximarith_t
3416 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3419 int_eximarith_t x = eval_op_or(&s, decimal, error);
3425 *error = US"expecting closing parenthesis";
3427 while (isspace(*(++s)));
3429 else if (*s != 0) *error = US"expecting operator";
3436 static int_eximarith_t
3437 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3442 while (isspace(*s)) s++;
3447 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3449 switch (tolower(*s))
3452 case 'k': n *= 1024; s++; break;
3453 case 'm': n *= 1024*1024; s++; break;
3454 case 'g': n *= 1024*1024*1024; s++; break;
3456 while (isspace (*s)) s++;
3461 n = eval_expr(&s, decimal, error, 1);
3465 *error = US"expecting number or opening parenthesis";
3473 static int_eximarith_t
3474 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3478 while (isspace(*s)) s++;
3479 if (*s == '+' || *s == '-' || *s == '~')
3482 x = eval_op_unary(&s, decimal, error);
3483 if (op == '-') x = -x;
3484 else if (op == '~') x = ~x;
3488 x = eval_number(&s, decimal, error);
3495 static int_eximarith_t
3496 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3499 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3502 while (*s == '*' || *s == '/' || *s == '%')
3505 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3506 if (*error != NULL) break;
3507 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3508 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3509 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3510 * -N*M is INT_MIN will yielf INT_MIN.
3511 * Since we don't support floating point, this is somewhat simpler.
3512 * Ideally, we'd return an error, but since we overflow for all other
3513 * arithmetic, consistency suggests otherwise, but what's the correct value
3514 * to use? There is none.
3515 * The C standard guarantees overflow for unsigned arithmetic but signed
3516 * overflow invokes undefined behaviour; in practice, this is overflow
3517 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3518 * that long/longlong larger than int are available, or we could just work
3519 * with larger types. We should consider whether to guarantee 32bit eval
3520 * and 64-bit working variables, with errors returned. For now ...
3521 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3522 * can just let the other invalid results occur otherwise, as they have
3523 * until now. For this one case, we can coerce.
3525 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3528 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3529 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3539 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3555 static int_eximarith_t
3556 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3559 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3562 while (*s == '+' || *s == '-')
3565 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3566 if (*error != NULL) break;
3567 if (op == '+') x += y; else x -= y;
3575 static int_eximarith_t
3576 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3579 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3582 while ((*s == '<' || *s == '>') && s[1] == s[0])
3587 y = eval_op_sum(&s, decimal, error);
3588 if (*error != NULL) break;
3589 if (op == '<') x <<= y; else x >>= y;
3597 static int_eximarith_t
3598 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3601 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3608 y = eval_op_shift(&s, decimal, error);
3609 if (*error != NULL) break;
3618 static int_eximarith_t
3619 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3622 int_eximarith_t x = eval_op_and(&s, decimal, error);
3629 y = eval_op_and(&s, decimal, error);
3630 if (*error != NULL) break;
3639 static int_eximarith_t
3640 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3643 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3650 y = eval_op_xor(&s, decimal, error);
3651 if (*error != NULL) break;
3661 /*************************************************
3663 *************************************************/
3665 /* Returns either an unchanged string, or the expanded string in stacking pool
3666 store. Interpreted sequences are:
3668 \... normal escaping rules
3669 $name substitutes the variable
3671 ${op:string} operates on the expanded string value
3672 ${item{arg1}{arg2}...} expands the args and then does the business
3673 some literal args are not enclosed in {}
3675 There are now far too many operators and item types to make it worth listing
3676 them here in detail any more.
3678 We use an internal routine recursively to handle embedded substrings. The
3679 external function follows. The yield is NULL if the expansion failed, and there
3680 are two cases: if something collapsed syntactically, or if "fail" was given
3681 as the action on a lookup failure. These can be distinguised by looking at the
3682 variable expand_string_forcedfail, which is TRUE in the latter case.
3684 The skipping flag is set true when expanding a substring that isn't actually
3685 going to be used (after "if" or "lookup") and it prevents lookups from
3686 happening lower down.
3688 Store usage: At start, a store block of the length of the input plus 64
3689 is obtained. This is expanded as necessary by string_cat(), which might have to
3690 get a new block, or might be able to expand the original. At the end of the
3691 function we can release any store above that portion of the yield block that
3692 was actually used. In many cases this will be optimal.
3694 However: if the first item in the expansion is a variable name or header name,
3695 we reset the store before processing it; if the result is in fresh store, we
3696 use that without copying. This is helpful for expanding strings like
3697 $message_headers which can get very long.
3699 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3700 since resetting the store at the end of the expansion will free store that was
3701 allocated by the plugin code as well as the slop after the expanded string. So
3702 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3703 and, given the acl condition, ${if }. This is an unfortunate consequence of
3704 string expansion becoming too powerful.
3707 string the string to be expanded
3708 ket_ends true if expansion is to stop at }
3709 left if not NULL, a pointer to the first character after the
3710 expansion is placed here (typically used with ket_ends)
3711 skipping TRUE for recursive calls when the value isn't actually going
3712 to be used (to allow for optimisation)
3713 honour_dollar TRUE if $ is to be expanded,
3714 FALSE if it's just another character
3715 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3718 Returns: NULL if expansion fails:
3719 expand_string_forcedfail is set TRUE if failure was forced
3720 expand_string_message contains a textual error message
3721 a pointer to the expanded string on success
3725 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3726 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3729 int size = Ustrlen(string)+ 64;
3731 uschar *yield = store_get(size);
3733 uschar *save_expand_nstring[EXPAND_MAXN+1];
3734 int save_expand_nlength[EXPAND_MAXN+1];
3735 BOOL resetok = TRUE;
3737 expand_string_forcedfail = FALSE;
3738 expand_string_message = US"";
3745 /* \ escapes the next character, which must exist, or else
3746 the expansion fails. There's a special escape, \N, which causes
3747 copying of the subject verbatim up to the next \N. Otherwise,
3748 the escapes are the standard set. */
3754 expand_string_message = US"\\ at end of string";
3761 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3762 yield = string_cat(yield, &size, &ptr, t, s - t);
3763 if (*s != 0) s += 2;
3769 ch[0] = string_interpret_escape(&s);
3771 yield = string_cat(yield, &size, &ptr, ch, 1);
3778 /* Anything other than $ is just copied verbatim, unless we are
3779 looking for a terminating } character. */
3782 if (ket_ends && *s == '}') break;
3784 if (*s != '$' || !honour_dollar)
3786 yield = string_cat(yield, &size, &ptr, s++, 1);
3790 /* No { after the $ - must be a plain name or a number for string
3791 match variable. There has to be a fudge for variables that are the
3792 names of header fields preceded by "$header_" because header field
3793 names can contain any printing characters except space and colon.
3794 For those that don't like typing this much, "$h_" is a synonym for
3795 "$header_". A non-existent header yields a NULL value; nothing is
3798 if (isalpha((*(++s))))
3803 s = read_name(name, sizeof(name), s, US"_");
3805 /* If this is the first thing to be expanded, release the pre-allocated
3808 if (ptr == 0 && yield != NULL)
3810 if (resetok) store_reset(yield);
3817 if (Ustrncmp(name, "h_", 2) == 0 ||
3818 Ustrncmp(name, "rh_", 3) == 0 ||
3819 Ustrncmp(name, "bh_", 3) == 0 ||
3820 Ustrncmp(name, "header_", 7) == 0 ||
3821 Ustrncmp(name, "rheader_", 8) == 0 ||
3822 Ustrncmp(name, "bheader_", 8) == 0)
3824 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3825 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3826 s = read_header_name(name, sizeof(name), s);
3827 value = find_header(name, FALSE, &newsize, want_raw, charset);
3829 /* If we didn't find the header, and the header contains a closing brace
3830 character, this may be a user error where the terminating colon
3831 has been omitted. Set a flag to adjust the error message in this case.
3832 But there is no error here - nothing gets inserted. */
3836 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3845 value = find_variable(name, FALSE, skipping, &newsize);
3848 expand_string_message =
3849 string_sprintf("unknown variable name \"%s\"", name);
3850 check_variable_error_message(name);
3855 /* If the data is known to be in a new buffer, newsize will be set to the
3856 size of that buffer. If this is the first thing in an expansion string,
3857 yield will be NULL; just point it at the new store instead of copying. Many
3858 expansion strings contain just one reference, so this is a useful
3859 optimization, especially for humungous headers. */
3861 len = Ustrlen(value);
3862 if (yield == NULL && newsize != 0)
3868 else yield = string_cat(yield, &size, &ptr, value, len);
3876 s = read_number(&n, s);
3877 if (n >= 0 && n <= expand_nmax)
3878 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3883 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3885 if (*s != '{') /*}*/
3887 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3891 /* After { there can be various things, but they all start with
3892 an initial word, except for a number for a string match variable. */
3894 if (isdigit((*(++s))))
3897 s = read_number(&n, s); /*{*/
3900 expand_string_message = US"} expected after number";
3903 if (n >= 0 && n <= expand_nmax)
3904 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3911 expand_string_message = US"letter or digit expected after ${"; /*}*/
3915 /* Allow "-" in names to cater for substrings with negative
3916 arguments. Since we are checking for known names after { this is
3919 s = read_name(name, sizeof(name), s, US"_-");
3920 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3924 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3925 If the ACL returns accept or reject we return content set by "message ="
3926 There is currently no limit on recursion; this would have us call
3927 acl_check_internal() directly and get a current level from somewhere.
3928 See also the acl expansion condition ECOND_ACL and the traditional
3929 acl modifier ACLC_ACL.
3930 Assume that the function has side-effects on the store that must be preserved.
3934 /* ${acl {name} {arg1}{arg2}...} */
3936 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3939 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
3941 case 1: goto EXPAND_FAILED_CURLY;
3943 case 3: goto EXPAND_FAILED;
3945 if (skipping) continue;
3948 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3953 debug_printf("acl expansion yield: %s\n", user_msg);
3955 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3959 expand_string_forcedfail = TRUE;
3961 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3966 /* Handle conditionals - preserve the values of the numerical expansion
3967 variables in case they get changed by a regular expression match in the
3968 condition. If not, they retain their external settings. At the end
3969 of this "if" section, they get restored to their previous values. */
3975 int save_expand_nmax =
3976 save_expand_strings(save_expand_nstring, save_expand_nlength);
3978 while (isspace(*s)) s++;
3979 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
3980 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3983 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3984 cond? "true" : "false");
3988 /* The handling of "yes" and "no" result strings is now in a separate
3989 function that is also used by ${lookup} and ${extract} and ${run}. */
3991 switch(process_yesno(
3992 skipping, /* were previously skipping */
3993 cond, /* success/failure indicator */
3994 lookup_value, /* value to reset for string2 */
3995 &s, /* input pointer */
3996 &yield, /* output pointer */
3997 &size, /* output size */
3998 &ptr, /* output current point */
3999 US"if", /* condition type */
4002 case 1: goto EXPAND_FAILED; /* when all is well, the */
4003 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4006 /* Restore external setting of expansion variables for continuation
4009 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4010 save_expand_nlength);
4014 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4015 expanding an internal string that isn't actually going to be used. All we
4016 need to do is check the syntax, so don't do a lookup at all. Preserve the
4017 values of the numerical expansion variables in case they get changed by a
4018 partial lookup. If not, they retain their external settings. At the end
4019 of this "lookup" section, they get restored to their previous values. */
4023 int stype, partial, affixlen, starflags;
4024 int expand_setup = 0;
4026 uschar *key, *filename, *affix;
4027 uschar *save_lookup_value = lookup_value;
4028 int save_expand_nmax =
4029 save_expand_strings(save_expand_nstring, save_expand_nlength);
4031 if ((expand_forbid & RDO_LOOKUP) != 0)
4033 expand_string_message = US"lookup expansions are not permitted";
4037 /* Get the key we are to look up for single-key+file style lookups.
4038 Otherwise set the key NULL pro-tem. */
4040 while (isspace(*s)) s++;
4041 if (*s == '{') /*}*/
4043 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4044 if (key == NULL) goto EXPAND_FAILED; /*{*/
4045 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4046 while (isspace(*s)) s++;
4050 /* Find out the type of database */
4054 expand_string_message = US"missing lookup type";
4058 /* The type is a string that may contain special characters of various
4059 kinds. Allow everything except space or { to appear; the actual content
4060 is checked by search_findtype_partial. */ /*}*/
4062 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
4064 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
4068 while (isspace(*s)) s++;
4070 /* Now check for the individual search type and any partial or default
4071 options. Only those types that are actually in the binary are valid. */
4073 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
4077 expand_string_message = search_error_message;
4081 /* Check that a key was provided for those lookup types that need it,
4082 and was not supplied for those that use the query style. */
4084 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4088 expand_string_message = string_sprintf("missing {key} for single-"
4089 "key \"%s\" lookup", name);
4097 expand_string_message = string_sprintf("a single key was given for "
4098 "lookup type \"%s\", which is not a single-key lookup type", name);
4103 /* Get the next string in brackets and expand it. It is the file name for
4104 single-key+file lookups, and the whole query otherwise. In the case of
4105 queries that also require a file name (e.g. sqlite), the file name comes
4108 if (*s != '{') goto EXPAND_FAILED_CURLY;
4109 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4110 if (filename == NULL) goto EXPAND_FAILED;
4111 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4112 while (isspace(*s)) s++;
4114 /* If this isn't a single-key+file lookup, re-arrange the variables
4115 to be appropriate for the search_ functions. For query-style lookups,
4116 there is just a "key", and no file name. For the special query-style +
4117 file types, the query (i.e. "key") starts with a file name. */
4121 while (isspace(*filename)) filename++;
4124 if (mac_islookup(stype, lookup_querystyle))
4130 if (*filename != '/')
4132 expand_string_message = string_sprintf(
4133 "absolute file name expected for \"%s\" lookup", name);
4136 while (*key != 0 && !isspace(*key)) key++;
4137 if (*key != 0) *key++ = 0;
4141 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4142 the entry was not found. Note that there is no search_close() function.
4143 Files are left open in case of re-use. At suitable places in higher logic,
4144 search_tidyup() is called to tidy all open files. This can save opening
4145 the same file several times. However, files may also get closed when
4146 others are opened, if too many are open at once. The rule is that a
4147 handle should not be used after a second search_open().
4149 Request that a partial search sets up $1 and maybe $2 by passing
4150 expand_setup containing zero. If its value changes, reset expand_nmax,
4151 since new variables will have been set. Note that at the end of this
4152 "lookup" section, the old numeric variables are restored. */
4155 lookup_value = NULL;
4158 void *handle = search_open(filename, stype, 0, NULL, NULL);
4161 expand_string_message = search_error_message;
4164 lookup_value = search_find(handle, filename, key, partial, affix,
4165 affixlen, starflags, &expand_setup);
4166 if (search_find_defer)
4168 expand_string_message =
4169 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4170 string_printing2(key, FALSE), search_error_message);
4173 if (expand_setup > 0) expand_nmax = expand_setup;
4176 /* The handling of "yes" and "no" result strings is now in a separate
4177 function that is also used by ${if} and ${extract}. */
4179 switch(process_yesno(
4180 skipping, /* were previously skipping */
4181 lookup_value != NULL, /* success/failure indicator */
4182 save_lookup_value, /* value to reset for string2 */
4183 &s, /* input pointer */
4184 &yield, /* output pointer */
4185 &size, /* output size */
4186 &ptr, /* output current point */
4187 US"lookup", /* condition type */
4190 case 1: goto EXPAND_FAILED; /* when all is well, the */
4191 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4194 /* Restore external setting of expansion variables for carrying on
4195 at this level, and continue. */
4197 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4198 save_expand_nlength);
4202 /* If Perl support is configured, handle calling embedded perl subroutines,
4203 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4204 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4205 arguments (defined below). */
4207 #define EXIM_PERL_MAX_ARGS 8
4211 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4212 "is not included in this binary";
4215 #else /* EXIM_PERL */
4217 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4220 if ((expand_forbid & RDO_PERL) != 0)
4222 expand_string_message = US"Perl calls are not permitted";
4226 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4227 US"perl", &resetok))
4229 case 1: goto EXPAND_FAILED_CURLY;
4231 case 3: goto EXPAND_FAILED;
4234 /* If skipping, we don't actually do anything */
4236 if (skipping) continue;
4238 /* Start the interpreter if necessary */
4240 if (!opt_perl_started)
4243 if (opt_perl_startup == NULL)
4245 expand_string_message = US"A setting of perl_startup is needed when "
4246 "using the Perl interpreter";
4249 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4250 initerror = init_perl(opt_perl_startup);
4251 if (initerror != NULL)
4253 expand_string_message =
4254 string_sprintf("error in perl_startup code: %s\n", initerror);
4257 opt_perl_started = TRUE;
4260 /* Call the function */
4262 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4263 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4264 sub_arg[0], sub_arg + 1);
4266 /* NULL yield indicates failure; if the message pointer has been set to
4267 NULL, the yield was undef, indicating a forced failure. Otherwise the
4268 message will indicate some kind of Perl error. */
4270 if (new_yield == NULL)
4272 if (expand_string_message == NULL)
4274 expand_string_message =
4275 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4276 "failure", sub_arg[0]);
4277 expand_string_forcedfail = TRUE;
4282 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4283 set during a callback from Perl. */
4285 expand_string_forcedfail = FALSE;
4289 #endif /* EXIM_PERL */
4291 /* Transform email address to "prvs" scheme to use
4292 as BATV-signed return path */
4299 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4301 case 1: goto EXPAND_FAILED_CURLY;
4303 case 3: goto EXPAND_FAILED;
4306 /* If skipping, we don't actually do anything */
4307 if (skipping) continue;
4309 /* sub_arg[0] is the address */
4310 domain = Ustrrchr(sub_arg[0],'@');
4311 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4313 expand_string_message = US"prvs first argument must be a qualified email address";
4317 /* Calculate the hash. The second argument must be a single-digit
4318 key number, or unset. */
4320 if (sub_arg[2] != NULL &&
4321 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4323 expand_string_message = US"prvs second argument must be a single digit";
4327 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4330 expand_string_message = US"prvs hmac-sha1 conversion failed";
4334 /* Now separate the domain from the local part */
4337 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4338 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4339 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4340 string_cat(yield,&size,&ptr,p,6);
4341 string_cat(yield,&size,&ptr,US"=",1);
4342 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4343 string_cat(yield,&size,&ptr,US"@",1);
4344 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4349 /* Check a prvs-encoded address for validity */
4351 case EITEM_PRVSCHECK:
4354 int mysize = 0, myptr = 0;
4358 /* TF: Ugliness: We want to expand parameter 1 first, then set
4359 up expansion variables that are used in the expansion of
4360 parameter 2. So we clone the string for the first
4361 expansion, where we only expand parameter 1.
4363 PH: Actually, that isn't necessary. The read_subs() function is
4364 designed to work this way for the ${if and ${lookup expansions. I've
4368 /* Reset expansion variables */
4369 prvscheck_result = NULL;
4370 prvscheck_address = NULL;
4371 prvscheck_keynum = NULL;
4373 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4375 case 1: goto EXPAND_FAILED_CURLY;
4377 case 3: goto EXPAND_FAILED;
4380 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4383 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4385 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4386 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4387 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4388 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4389 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4391 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4392 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4393 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4394 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4395 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4397 /* Set up expansion variables */
4398 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4399 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4400 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4401 prvscheck_address[myptr] = '\0';
4402 prvscheck_keynum = string_copy(key_num);
4404 /* Now expand the second argument */
4405 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4407 case 1: goto EXPAND_FAILED_CURLY;
4409 case 3: goto EXPAND_FAILED;
4412 /* Now we have the key and can check the address. */
4414 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4419 expand_string_message = US"hmac-sha1 conversion failed";
4423 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4424 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4426 if (Ustrcmp(p,hash) == 0)
4428 /* Success, valid BATV address. Now check the expiry date. */
4429 uschar *now = prvs_daystamp(0);
4430 unsigned int inow = 0,iexpire = 1;
4432 (void)sscanf(CS now,"%u",&inow);
4433 (void)sscanf(CS daystamp,"%u",&iexpire);
4435 /* When "iexpire" is < 7, a "flip" has occured.
4436 Adjust "inow" accordingly. */
4437 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4439 if (iexpire >= inow)
4441 prvscheck_result = US"1";
4442 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4446 prvscheck_result = NULL;
4447 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4452 prvscheck_result = NULL;
4453 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4456 /* Now expand the final argument. We leave this till now so that
4457 it can include $prvscheck_result. */
4459 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4461 case 1: goto EXPAND_FAILED_CURLY;
4463 case 3: goto EXPAND_FAILED;
4466 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4467 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4469 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4471 /* Reset the "internal" variables afterwards, because they are in
4472 dynamic store that will be reclaimed if the expansion succeeded. */
4474 prvscheck_address = NULL;
4475 prvscheck_keynum = NULL;
4479 /* Does not look like a prvs encoded address, return the empty string.
4480 We need to make sure all subs are expanded first, so as to skip over
4483 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4485 case 1: goto EXPAND_FAILED_CURLY;
4487 case 3: goto EXPAND_FAILED;
4494 /* Handle "readfile" to insert an entire file */
4496 case EITEM_READFILE:
4501 if ((expand_forbid & RDO_READFILE) != 0)
4503 expand_string_message = US"file insertions are not permitted";
4507 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4509 case 1: goto EXPAND_FAILED_CURLY;
4511 case 3: goto EXPAND_FAILED;
4514 /* If skipping, we don't actually do anything */
4516 if (skipping) continue;
4518 /* Open the file and read it */
4520 f = Ufopen(sub_arg[0], "rb");
4523 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4527 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4532 /* Handle "readsocket" to insert data from a Unix domain socket */
4534 case EITEM_READSOCK:
4540 struct sockaddr_un sockun; /* don't call this "sun" ! */
4544 if ((expand_forbid & RDO_READSOCK) != 0)
4546 expand_string_message = US"socket insertions are not permitted";
4550 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4551 because there may be a string for expansion on failure. */
4553 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4555 case 1: goto EXPAND_FAILED_CURLY;
4556 case 2: /* Won't occur: no end check */
4557 case 3: goto EXPAND_FAILED;
4560 /* Sort out timeout, if given */
4562 if (sub_arg[2] != NULL)
4564 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4567 expand_string_message = string_sprintf("bad time value %s",
4572 else sub_arg[3] = NULL; /* No eol if no timeout */
4574 /* If skipping, we don't actually do anything. Otherwise, arrange to
4575 connect to either an IP or a Unix socket. */
4579 /* Handle an IP (internet) domain */
4581 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4584 uschar *server_name = sub_arg[0] + 5;
4585 uschar *port_name = Ustrrchr(server_name, ':');
4587 /* Sort out the port */
4589 if (port_name == NULL)
4591 expand_string_message =
4592 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4595 *port_name++ = 0; /* Terminate server name */
4597 if (isdigit(*port_name))
4600 port = Ustrtol(port_name, &end, 0);
4601 if (end != port_name + Ustrlen(port_name))
4603 expand_string_message =
4604 string_sprintf("invalid port number %s", port_name);
4610 struct servent *service_info = getservbyname(CS port_name, "tcp");
4611 if (service_info == NULL)
4613 expand_string_message = string_sprintf("unknown port \"%s\"",
4617 port = ntohs(service_info->s_port);
4620 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4621 timeout, NULL, &expand_string_message)) < 0)
4625 /* Handle a Unix domain socket */
4630 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4632 expand_string_message = string_sprintf("failed to create socket: %s",
4637 sockun.sun_family = AF_UNIX;
4638 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4641 sigalrm_seen = FALSE;
4643 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4647 expand_string_message = US "socket connect timed out";
4652 expand_string_message = string_sprintf("failed to connect to socket "
4653 "%s: %s", sub_arg[0], strerror(errno));
4658 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4660 /* Write the request string, if not empty */
4662 if (sub_arg[1][0] != 0)
4664 int len = Ustrlen(sub_arg[1]);
4665 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4667 if (write(fd, sub_arg[1], len) != len)
4669 expand_string_message = string_sprintf("request write to socket "
4670 "failed: %s", strerror(errno));
4675 /* Shut down the sending side of the socket. This helps some servers to
4676 recognise that it is their turn to do some work. Just in case some
4677 system doesn't have this function, make it conditional. */
4680 shutdown(fd, SHUT_WR);
4683 /* Now we need to read from the socket, under a timeout. The function
4684 that reads a file can be used. */
4686 f = fdopen(fd, "rb");
4687 sigalrm_seen = FALSE;
4689 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4693 /* After a timeout, we restore the pointer in the result, that is,
4694 make sure we add nothing from the socket. */
4699 expand_string_message = US "socket read timed out";
4704 /* The whole thing has worked (or we were skipping). If there is a
4705 failure string following, we need to skip it. */
4709 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4711 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4712 while (isspace(*s)) s++;
4714 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4717 /* Come here on failure to create socket, connect socket, write to the
4718 socket, or timeout on reading. If another substring follows, expand and
4719 use it. Otherwise, those conditions give expand errors. */
4722 if (*s != '{') goto EXPAND_FAILED;
4723 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4724 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4725 if (arg == NULL) goto EXPAND_FAILED;
4726 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4727 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4728 while (isspace(*s)) s++;
4729 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4733 /* Handle "run" to execute a program. */
4745 if ((expand_forbid & RDO_RUN) != 0)
4747 expand_string_message = US"running a command is not permitted";
4751 while (isspace(*s)) s++;
4752 if (*s != '{') goto EXPAND_FAILED_CURLY;
4753 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4754 if (arg == NULL) goto EXPAND_FAILED;
4755 while (isspace(*s)) s++;
4756 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4758 if (skipping) /* Just pretend it worked when we're skipping */
4764 if (!transport_set_up_command(&argv, /* anchor for arg list */
4765 arg, /* raw command */
4766 FALSE, /* don't expand the arguments */
4767 0, /* not relevant when... */
4768 NULL, /* no transporting address */
4769 US"${run} expansion", /* for error messages */
4770 &expand_string_message)) /* where to put error message */
4775 /* Create the child process, making it a group leader. */
4777 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4781 expand_string_message =
4782 string_sprintf("couldn't create child process: %s", strerror(errno));
4786 /* Nothing is written to the standard input. */
4790 /* Read the pipe to get the command's output into $value (which is kept
4791 in lookup_value). Read during execution, so that if the output exceeds
4792 the OS pipe buffer limit, we don't block forever. */
4794 f = fdopen(fd_out, "rb");
4795 sigalrm_seen = FALSE;
4797 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4801 /* Wait for the process to finish, applying the timeout, and inspect its
4802 return code for serious disasters. Simple non-zero returns are passed on.
4805 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4807 if (sigalrm_seen == TRUE || runrc == -256)
4809 expand_string_message = string_sprintf("command timed out");
4810 killpg(pid, SIGKILL); /* Kill the whole process group */
4813 else if (runrc == -257)
4814 expand_string_message = string_sprintf("wait() failed: %s",
4818 expand_string_message = string_sprintf("command killed by signal %d",
4825 /* Process the yes/no strings; $value may be useful in both cases */
4827 switch(process_yesno(
4828 skipping, /* were previously skipping */
4829 runrc == 0, /* success/failure indicator */
4830 lookup_value, /* value to reset for string2 */
4831 &s, /* input pointer */
4832 &yield, /* output pointer */
4833 &size, /* output size */
4834 &ptr, /* output current point */
4835 US"run", /* condition type */
4838 case 1: goto EXPAND_FAILED; /* when all is well, the */
4839 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4845 /* Handle character translation for "tr" */
4853 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4855 case 1: goto EXPAND_FAILED_CURLY;
4857 case 3: goto EXPAND_FAILED;
4860 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4861 o2m = Ustrlen(sub[2]) - 1;
4863 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4865 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4869 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4876 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4877 expanded arguments. */
4887 int val[2] = { 0, -1 };
4890 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4891 Ensure that sub[2] is set in the ${length } case. */
4894 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4895 TRUE, name, &resetok))
4897 case 1: goto EXPAND_FAILED_CURLY;
4899 case 3: goto EXPAND_FAILED;
4902 /* Juggle the arguments if there are only two of them: always move the
4903 string to the last position and make ${length{n}{str}} equivalent to
4904 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4910 if (item_type == EITEM_LENGTH)
4917 for (i = 0; i < 2; i++)
4919 if (sub[i] == NULL) continue;
4920 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4921 if (*ret != 0 || (i != 0 && val[i] < 0))
4923 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4924 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4930 (item_type == EITEM_HASH)?
4931 compute_hash(sub[2], val[0], val[1], &len) :
4932 (item_type == EITEM_NHASH)?
4933 compute_nhash(sub[2], val[0], val[1], &len) :
4934 extract_substr(sub[2], val[0], val[1], &len);
4936 if (ret == NULL) goto EXPAND_FAILED;
4937 yield = string_cat(yield, &size, &ptr, ret, len);
4941 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4942 This code originally contributed by Steve Haslam. It currently supports
4943 the use of MD5 and SHA-1 hashes.
4945 We need some workspace that is large enough to handle all the supported
4946 hash types. Use macros to set the sizes rather than be too elaborate. */
4948 #define MAX_HASHLEN 20
4949 #define MAX_HASHBLOCKLEN 64
4958 int hashlen; /* Number of octets for the hash algorithm's output */
4959 int hashblocklen; /* Number of octets the hash algorithm processes */
4961 unsigned int keylen;
4963 uschar keyhash[MAX_HASHLEN];
4964 uschar innerhash[MAX_HASHLEN];
4965 uschar finalhash[MAX_HASHLEN];
4966 uschar finalhash_hex[2*MAX_HASHLEN];
4967 uschar innerkey[MAX_HASHBLOCKLEN];
4968 uschar outerkey[MAX_HASHBLOCKLEN];
4970 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
4972 case 1: goto EXPAND_FAILED_CURLY;
4974 case 3: goto EXPAND_FAILED;
4977 if (Ustrcmp(sub[0], "md5") == 0)
4980 use_base = &md5_base;
4984 else if (Ustrcmp(sub[0], "sha1") == 0)
4987 use_base = &sha1_base;
4993 expand_string_message =
4994 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4999 keylen = Ustrlen(keyptr);
5001 /* If the key is longer than the hash block length, then hash the key
5004 if (keylen > hashblocklen)
5006 chash_start(type, use_base);
5007 chash_end(type, use_base, keyptr, keylen, keyhash);
5012 /* Now make the inner and outer key values */
5014 memset(innerkey, 0x36, hashblocklen);
5015 memset(outerkey, 0x5c, hashblocklen);
5017 for (i = 0; i < keylen; i++)
5019 innerkey[i] ^= keyptr[i];
5020 outerkey[i] ^= keyptr[i];
5023 /* Now do the hashes */
5025 chash_start(type, use_base);
5026 chash_mid(type, use_base, innerkey);
5027 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5029 chash_start(type, use_base);
5030 chash_mid(type, use_base, outerkey);
5031 chash_end(type, use_base, innerhash, hashlen, finalhash);
5033 /* Encode the final hash as a hex string */
5036 for (i = 0; i < hashlen; i++)
5038 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5039 *p++ = hex_digits[finalhash[i] & 0x0f];
5042 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
5043 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
5045 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
5050 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5051 We have to save the numerical variables and restore them afterwards. */
5056 int moffset, moffsetextra, slen;
5059 const uschar *rerror;
5062 int save_expand_nmax =
5063 save_expand_strings(save_expand_nstring, save_expand_nlength);
5065 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
5067 case 1: goto EXPAND_FAILED_CURLY;
5069 case 3: goto EXPAND_FAILED;
5072 /* Compile the regular expression */
5074 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5079 expand_string_message = string_sprintf("regular expression error in "
5080 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5084 /* Now run a loop to do the substitutions as often as necessary. It ends
5085 when there are no more matches. Take care over matches of the null string;
5086 do the same thing as Perl does. */
5089 slen = Ustrlen(sub[0]);
5090 moffset = moffsetextra = 0;
5095 int ovector[3*(EXPAND_MAXN+1)];
5096 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5097 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5101 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5102 is not necessarily the end. We want to repeat the match from one
5103 character further along, but leaving the basic offset the same (for
5104 copying below). We can't be at the end of the string - that was checked
5105 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5106 finished; copy the remaining string and end the loop. */
5116 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5120 /* Match - set up for expanding the replacement. */
5122 if (n == 0) n = EXPAND_MAXN + 1;
5124 for (nn = 0; nn < n*2; nn += 2)
5126 expand_nstring[expand_nmax] = subject + ovector[nn];
5127 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5131 /* Copy the characters before the match, plus the expanded insertion. */
5133 yield = string_cat(yield, &size, &ptr, subject + moffset,
5134 ovector[0] - moffset);
5135 insert = expand_string(sub[2]);
5136 if (insert == NULL) goto EXPAND_FAILED;
5137 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5139 moffset = ovector[1];
5143 /* If we have matched an empty string, first check to see if we are at
5144 the end of the subject. If so, the loop is over. Otherwise, mimic
5145 what Perl's /g options does. This turns out to be rather cunning. First
5146 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5147 string at the same point. If this fails (picked up above) we advance to
5148 the next character. */
5150 if (ovector[0] == ovector[1])
5152 if (ovector[0] == slen) break;
5153 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5157 /* All done - restore numerical variables. */
5159 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5160 save_expand_nlength);
5164 /* Handle keyed and numbered substring extraction. If the first argument
5165 consists entirely of digits, then a numerical extraction is assumed. */
5171 int field_number = 1;
5172 BOOL field_number_set = FALSE;
5173 uschar *save_lookup_value = lookup_value;
5175 int save_expand_nmax =
5176 save_expand_strings(save_expand_nstring, save_expand_nlength);
5178 /* Read the arguments */
5180 for (i = 0; i < j; i++)
5182 while (isspace(*s)) s++;
5183 if (*s == '{') /*}*/
5185 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5186 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5187 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5189 /* After removal of leading and trailing white space, the first
5190 argument must not be empty; if it consists entirely of digits
5191 (optionally preceded by a minus sign), this is a numerical
5192 extraction, and we expect 3 arguments. */
5200 while (isspace(*p)) p++;
5204 while (len > 0 && isspace(p[len-1])) len--;
5207 if (*p == 0 && !skipping)
5209 expand_string_message = US"first argument of \"extract\" must "
5219 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5223 j = 3; /* Need 3 args */
5224 field_number_set = TRUE;
5228 else goto EXPAND_FAILED_CURLY;
5231 /* Extract either the numbered or the keyed substring into $value. If
5232 skipping, just pretend the extraction failed. */
5234 lookup_value = skipping? NULL : field_number_set?
5235 expand_gettokened(field_number, sub[1], sub[2]) :
5236 expand_getkeyed(sub[0], sub[1]);
5238 /* If no string follows, $value gets substituted; otherwise there can
5239 be yes/no strings, as for lookup or if. */
5241 switch(process_yesno(
5242 skipping, /* were previously skipping */
5243 lookup_value != NULL, /* success/failure indicator */
5244 save_lookup_value, /* value to reset for string2 */
5245 &s, /* input pointer */
5246 &yield, /* output pointer */
5247 &size, /* output size */
5248 &ptr, /* output current point */
5249 US"extract", /* condition type */
5252 case 1: goto EXPAND_FAILED; /* when all is well, the */
5253 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5256 /* All done - restore numerical variables. */
5258 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5259 save_expand_nlength);
5264 /* return the Nth item from a list */
5266 case EITEM_LISTEXTRACT:
5269 int field_number = 1;
5270 uschar *save_lookup_value = lookup_value;
5272 int save_expand_nmax =
5273 save_expand_strings(save_expand_nstring, save_expand_nlength);
5275 /* Read the field & list arguments */
5277 for (i = 0; i < 2; i++)
5279 while (isspace(*s)) s++;
5280 if (*s != '{') /*}*/
5281 goto EXPAND_FAILED_CURLY;
5283 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5284 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5285 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5287 /* After removal of leading and trailing white space, the first
5288 argument must be numeric and nonempty. */
5296 while (isspace(*p)) p++;
5300 while (len > 0 && isspace(p[len-1])) len--;
5303 if (!*p && !skipping)
5305 expand_string_message = US"first argument of \"listextract\" must "
5315 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5318 expand_string_message = US"first argument of \"listextract\" must "
5326 /* Extract the numbered element into $value. If
5327 skipping, just pretend the extraction failed. */
5329 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5331 /* If no string follows, $value gets substituted; otherwise there can
5332 be yes/no strings, as for lookup or if. */
5334 switch(process_yesno(
5335 skipping, /* were previously skipping */
5336 lookup_value != NULL, /* success/failure indicator */
5337 save_lookup_value, /* value to reset for string2 */
5338 &s, /* input pointer */
5339 &yield, /* output pointer */
5340 &size, /* output size */
5341 &ptr, /* output current point */
5342 US"extract", /* condition type */
5345 case 1: goto EXPAND_FAILED; /* when all is well, the */
5346 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5349 /* All done - restore numerical variables. */
5351 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5352 save_expand_nlength);
5358 case EITEM_CERTEXTRACT:
5361 int field_number = 1;
5362 uschar *save_lookup_value = lookup_value;
5364 int save_expand_nmax =
5365 save_expand_strings(save_expand_nstring, save_expand_nlength);
5367 /* Read the field argument */
5368 while (isspace(*s)) s++;
5369 if (*s != '{') /*}*/
5370 goto EXPAND_FAILED_CURLY;
5371 sub[0] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5372 if (!sub[0]) goto EXPAND_FAILED; /*{*/
5373 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5374 /* strip spaces fore & aft */
5380 while (isspace(*p)) p++;
5384 while (len > 0 && isspace(p[len-1])) len--;
5388 /* inspect the cert argument */
5389 while (isspace(*s)) s++;
5390 if (*s != '{') /*}*/
5391 goto EXPAND_FAILED_CURLY;
5394 expand_string_message = US"second argument of \"certextract\" must "
5395 "be a certificate variable";
5398 sub[1] = expand_string_internal(s+1, TRUE, &s, skipping, FALSE, &resetok);
5399 if (!sub[1]) goto EXPAND_FAILED; /*{*/
5400 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5403 lookup_value = NULL;
5406 lookup_value = expand_getcertele(sub[0], sub[1]);
5407 if (*expand_string_message) goto EXPAND_FAILED;
5409 switch(process_yesno(
5410 skipping, /* were previously skipping */
5411 lookup_value != NULL, /* success/failure indicator */
5412 save_lookup_value, /* value to reset for string2 */
5413 &s, /* input pointer */
5414 &yield, /* output pointer */
5415 &size, /* output size */
5416 &ptr, /* output current point */
5417 US"extract", /* condition type */
5420 case 1: goto EXPAND_FAILED; /* when all is well, the */
5421 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5424 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5425 save_expand_nlength);
5428 #endif /*SUPPORT_TLS*/
5430 /* Handle list operations */
5438 uschar outsep[2] = { '\0', '\0' };
5439 uschar *list, *expr, *temp;
5440 uschar *save_iterate_item = iterate_item;
5441 uschar *save_lookup_value = lookup_value;
5443 while (isspace(*s)) s++;
5444 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5446 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5447 if (list == NULL) goto EXPAND_FAILED;
5448 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5450 if (item_type == EITEM_REDUCE)
5452 while (isspace(*s)) s++;
5453 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5454 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5455 if (temp == NULL) goto EXPAND_FAILED;
5456 lookup_value = temp;
5457 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5460 while (isspace(*s)) s++;
5461 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5465 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5466 if scanning a "false" part). This allows us to find the end of the
5467 condition, because if the list is empty, we won't actually evaluate the
5468 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5469 the normal internal expansion function. */
5471 if (item_type == EITEM_FILTER)
5473 temp = eval_condition(expr, &resetok, NULL);
5474 if (temp != NULL) s = temp;
5478 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5483 expand_string_message = string_sprintf("%s inside \"%s\" item",
5484 expand_string_message, name);
5488 while (isspace(*s)) s++;
5491 expand_string_message = string_sprintf("missing } at end of condition "
5492 "or expression inside \"%s\"", name);
5496 while (isspace(*s)) s++; /*{*/
5499 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5504 /* If we are skipping, we can now just move on to the next item. When
5505 processing for real, we perform the iteration. */
5507 if (skipping) continue;
5508 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5510 *outsep = (uschar)sep; /* Separator as a string */
5512 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5514 if (item_type == EITEM_FILTER)
5517 if (eval_condition(expr, &resetok, &condresult) == NULL)
5519 iterate_item = save_iterate_item;
5520 lookup_value = save_lookup_value;
5521 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5522 expand_string_message, name);
5525 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5526 condresult? "true":"false");
5528 temp = iterate_item; /* TRUE => include this item */
5530 continue; /* FALSE => skip this item */
5533 /* EITEM_MAP and EITEM_REDUCE */
5537 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5540 iterate_item = save_iterate_item;
5541 expand_string_message = string_sprintf("%s inside \"%s\" item",
5542 expand_string_message, name);
5545 if (item_type == EITEM_REDUCE)
5547 lookup_value = temp; /* Update the value of $value */
5548 continue; /* and continue the iteration */
5552 /* We reach here for FILTER if the condition is true, always for MAP,
5553 and never for REDUCE. The value in "temp" is to be added to the output
5554 list that is being created, ensuring that any occurrences of the
5555 separator character are doubled. Unless we are dealing with the first
5556 item of the output list, add in a space if the new item begins with the
5557 separator character, or is an empty string. */
5559 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5560 yield = string_cat(yield, &size, &ptr, US" ", 1);
5562 /* Add the string in "temp" to the output list that we are building,
5563 This is done in chunks by searching for the separator character. */
5567 size_t seglen = Ustrcspn(temp, outsep);
5568 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5570 /* If we got to the end of the string we output one character
5571 too many; backup and end the loop. Otherwise arrange to double the
5574 if (temp[seglen] == '\0') { ptr--; break; }
5575 yield = string_cat(yield, &size, &ptr, outsep, 1);
5579 /* Output a separator after the string: we will remove the redundant
5580 final one at the end. */
5582 yield = string_cat(yield, &size, &ptr, outsep, 1);
5583 } /* End of iteration over the list loop */
5585 /* REDUCE has generated no output above: output the final value of
5588 if (item_type == EITEM_REDUCE)
5590 yield = string_cat(yield, &size, &ptr, lookup_value,
5591 Ustrlen(lookup_value));
5592 lookup_value = save_lookup_value; /* Restore $value */
5595 /* FILTER and MAP generate lists: if they have generated anything, remove
5596 the redundant final separator. Even though an empty item at the end of a
5597 list does not count, this is tidier. */
5599 else if (ptr != save_ptr) ptr--;
5601 /* Restore preserved $item */
5603 iterate_item = save_iterate_item;
5608 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5609 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5610 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5611 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5613 #define EXPAND_DLFUNC_MAX_ARGS 8
5616 #ifndef EXPAND_DLFUNC
5617 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5618 "is not included in this binary";
5621 #else /* EXPAND_DLFUNC */
5624 exim_dlfunc_t *func;
5627 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5629 if ((expand_forbid & RDO_DLFUNC) != 0)
5631 expand_string_message =
5632 US"dynamically-loaded functions are not permitted";
5636 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5637 TRUE, US"dlfunc", &resetok))
5639 case 1: goto EXPAND_FAILED_CURLY;
5641 case 3: goto EXPAND_FAILED;
5644 /* If skipping, we don't actually do anything */
5646 if (skipping) continue;
5648 /* Look up the dynamically loaded object handle in the tree. If it isn't
5649 found, dlopen() the file and put the handle in the tree for next time. */
5651 t = tree_search(dlobj_anchor, argv[0]);
5654 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5657 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5658 argv[0], dlerror());
5659 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5662 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5663 Ustrcpy(t->name, argv[0]);
5664 t->data.ptr = handle;
5665 (void)tree_insertnode(&dlobj_anchor, t);
5668 /* Having obtained the dynamically loaded object handle, look up the
5669 function pointer. */
5671 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5674 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5675 "%s", argv[1], argv[0], dlerror());
5676 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5680 /* Call the function and work out what to do with the result. If it
5681 returns OK, we have a replacement string; if it returns DEFER then
5682 expansion has failed in a non-forced manner; if it returns FAIL then
5683 failure was forced; if it returns ERROR or any other value there's a
5684 problem, so panic slightly. In any case, assume that the function has
5685 side-effects on the store that must be preserved. */
5689 for (argc = 0; argv[argc] != NULL; argc++);
5690 status = func(&result, argc - 2, &argv[2]);
5693 if (result == NULL) result = US"";
5694 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5699 expand_string_message = result == NULL ? US"(no message)" : result;
5700 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5701 else if(status != FAIL)
5702 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5703 argv[0], argv[1], status, expand_string_message);
5707 #endif /* EXPAND_DLFUNC */
5708 } /* EITEM_* switch */
5710 /* Control reaches here if the name is not recognized as one of the more
5711 complicated expansion items. Check for the "operator" syntax (name terminated
5712 by a colon). Some of the operators have arguments, separated by _ from the
5719 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5720 if (sub == NULL) goto EXPAND_FAILED;
5723 /* Owing to an historical mis-design, an underscore may be part of the
5724 operator name, or it may introduce arguments. We therefore first scan the
5725 table of names that contain underscores. If there is no match, we cut off
5726 the arguments and then scan the main table. */
5728 c = chop_match(name, op_table_underscore,
5729 sizeof(op_table_underscore)/sizeof(uschar *));
5733 arg = Ustrchr(name, '_');
5734 if (arg != NULL) *arg = 0;
5735 c = chop_match(name, op_table_main,
5736 sizeof(op_table_main)/sizeof(uschar *));
5737 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5738 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5741 /* If we are skipping, we don't need to perform the operation at all.
5742 This matters for operations like "mask", because the data may not be
5743 in the correct format when skipping. For example, the expression may test
5744 for the existence of $sender_host_address before trying to mask it. For
5745 other operations, doing them may not fail, but it is a waste of time. */
5747 if (skipping && c >= 0) continue;
5749 /* Otherwise, switch on the operator type */
5756 unsigned long int n = Ustrtoul(sub, &t, 10);
5759 expand_string_message = string_sprintf("argument for base62 "
5760 "operator is \"%s\", which is not a decimal number", sub);
5763 t = string_base62(n);
5764 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5768 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5774 unsigned long int n = 0;
5777 uschar *t = Ustrchr(base62_chars, *tt++);
5780 expand_string_message = string_sprintf("argument for base62d "
5781 "operator is \"%s\", which is not a base %d number", sub,
5785 n = n * BASE_62 + (t - base62_chars);
5787 (void)sprintf(CS buf, "%ld", n);
5788 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5794 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
5795 if (expanded == NULL)
5797 expand_string_message =
5798 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5799 expand_string_message);
5802 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5809 uschar *t = sub - 1;
5810 while (*(++t) != 0) { *t = tolower(*t); count++; }
5811 yield = string_cat(yield, &size, &ptr, sub, count);
5818 uschar *t = sub - 1;
5819 while (*(++t) != 0) { *t = toupper(*t); count++; }
5820 yield = string_cat(yield, &size, &ptr, sub, count);
5831 md5_end(&base, sub, Ustrlen(sub), digest);
5832 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5833 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5844 sha1_end(&base, sub, Ustrlen(sub), digest);
5845 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5846 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5850 /* Convert hex encoding to base64 encoding */
5860 for (enc = sub; *enc != 0; enc++)
5862 if (!isxdigit(*enc))
5864 expand_string_message = string_sprintf("\"%s\" is not a hex "
5873 expand_string_message = string_sprintf("\"%s\" contains an odd "
5874 "number of characters", sub);
5878 while ((c = *in++) != 0)
5880 if (isdigit(c)) c -= '0';
5881 else c = toupper(c) - 'A' + 10;
5893 enc = auth_b64encode(sub, out - sub);
5894 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5898 /* Convert octets outside 0x21..0x7E to \xXX form */
5902 uschar *t = sub - 1;
5905 if (*t < 0x21 || 0x7E < *t)
5906 yield = string_cat(yield, &size, &ptr,
5907 string_sprintf("\\x%02x", *t), 4);
5909 yield = string_cat(yield, &size, &ptr, t, 1);
5914 /* count the number of list elements */
5923 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5924 cp = string_sprintf("%d", cnt);
5925 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5929 /* expand a named list given the name */
5930 /* handles nested named lists; requotes as colon-sep list */
5934 tree_node *t = NULL;
5938 uschar * suffix = US"";
5939 BOOL needsep = FALSE;
5942 if (*sub == '+') sub++;
5943 if (arg == NULL) /* no-argument version */
5945 if (!(t = tree_search(addresslist_anchor, sub)) &&
5946 !(t = tree_search(domainlist_anchor, sub)) &&
5947 !(t = tree_search(hostlist_anchor, sub)))
5948 t = tree_search(localpartlist_anchor, sub);
5950 else switch(*arg) /* specific list-type version */
5952 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
5953 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
5954 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
5955 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
5957 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5963 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5965 : *arg=='a'?"address "
5966 : *arg=='d'?"domain "
5968 : *arg=='l'?"localpart "
5973 list = ((namedlist_block *)(t->data.ptr))->string;
5975 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5977 uschar * buf = US" : ";
5979 yield = string_cat(yield, &size, &ptr, buf, 3);
5983 if (*item == '+') /* list item is itself a named list */
5985 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5986 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
5988 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5992 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5993 while ((cp= strpbrk((const char *)item, tok)))
5995 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5996 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5998 yield = string_cat(yield, &size, &ptr, US"::", 2);
5999 item = (uschar *)cp;
6001 else /* sep in item; should already be doubled; emit once */
6003 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
6004 if (*cp == sep) cp++;
6005 item = (uschar *)cp;
6009 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
6014 /* mask applies a mask to an IP address; for example the result of
6015 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
6022 int mask, maskoffset;
6023 int type = string_is_ip_address(sub, &maskoffset);
6028 expand_string_message = string_sprintf("\"%s\" is not an IP address",
6033 if (maskoffset == 0)
6035 expand_string_message = string_sprintf("missing mask value in \"%s\"",
6040 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
6042 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
6044 expand_string_message = string_sprintf("mask value too big in \"%s\"",
6049 /* Convert the address to binary integer(s) and apply the mask */
6051 sub[maskoffset] = 0;
6052 count = host_aton(sub, binary);
6053 host_mask(count, binary, mask);
6055 /* Convert to masked textual format and add to output. */
6057 yield = string_cat(yield, &size, &ptr, buffer,
6058 host_nmtoa(count, binary, mask, buffer, '.'));
6063 case EOP_LOCAL_PART:
6067 int start, end, domain;
6068 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
6072 if (c != EOP_DOMAIN)
6074 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
6075 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
6077 else if (domain != 0)
6080 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
6088 uschar outsep[2] = { ':', '\0' };
6089 uschar *address, *error;
6091 int start, end, domain; /* Not really used */
6093 while (isspace(*sub)) sub++;
6094 if (*sub == '>') { *outsep = *++sub; ++sub; }
6095 parse_allow_group = TRUE;
6099 uschar *p = parse_find_address_end(sub, FALSE);
6100 uschar saveend = *p;
6102 address = parse_extract_address(sub, &error, &start, &end, &domain,
6106 /* Add the address to the output list that we are building. This is
6107 done in chunks by searching for the separator character. At the
6108 start, unless we are dealing with the first address of the output
6109 list, add in a space if the new address begins with the separator
6110 character, or is an empty string. */
6112 if (address != NULL)
6114 if (ptr != save_ptr && address[0] == *outsep)
6115 yield = string_cat(yield, &size, &ptr, US" ", 1);
6119 size_t seglen = Ustrcspn(address, outsep);
6120 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
6122 /* If we got to the end of the string we output one character
6125 if (address[seglen] == '\0') { ptr--; break; }
6126 yield = string_cat(yield, &size, &ptr, outsep, 1);
6127 address += seglen + 1;
6130 /* Output a separator after the string: we will remove the
6131 redundant final one at the end. */
6133 yield = string_cat(yield, &size, &ptr, outsep, 1);
6136 if (saveend == '\0') break;
6140 /* If we have generated anything, remove the redundant final
6143 if (ptr != save_ptr) ptr--;
6144 parse_allow_group = FALSE;
6149 /* quote puts a string in quotes if it is empty or contains anything
6150 other than alphamerics, underscore, dot, or hyphen.
6152 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6153 be quoted in order to be a valid local part.
6155 In both cases, newlines and carriage returns are converted into \n and \r
6159 case EOP_QUOTE_LOCAL_PART:
6162 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6163 uschar *t = sub - 1;
6167 while (!needs_quote && *(++t) != 0)
6168 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6170 else /* EOP_QUOTE_LOCAL_PART */
6172 while (!needs_quote && *(++t) != 0)
6173 needs_quote = !isalnum(*t) &&
6174 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6175 (*t != '.' || t == sub || t[1] == 0);
6180 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6185 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6186 else if (*t == '\r')
6187 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6190 if (*t == '\\' || *t == '"')
6191 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6192 yield = string_cat(yield, &size, &ptr, t, 1);
6195 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6197 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6201 /* quote_lookuptype does lookup-specific quoting */
6206 uschar *opt = Ustrchr(arg, '_');
6208 if (opt != NULL) *opt++ = 0;
6210 n = search_findtype(arg, Ustrlen(arg));
6213 expand_string_message = search_error_message;
6217 if (lookup_list[n]->quote != NULL)
6218 sub = (lookup_list[n]->quote)(sub, opt);
6219 else if (opt != NULL) sub = NULL;
6223 expand_string_message = string_sprintf(
6224 "\"%s\" unrecognized after \"${quote_%s\"",
6229 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6233 /* rx quote sticks in \ before any non-alphameric character so that
6234 the insertion works in a regular expression. */
6238 uschar *t = sub - 1;
6242 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6243 yield = string_cat(yield, &size, &ptr, t, 1);
6248 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6249 prescribed by the RFC, if there are characters that need to be encoded */
6253 uschar buffer[2048];
6254 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6255 buffer, sizeof(buffer), FALSE);
6256 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6260 /* RFC 2047 decode */
6266 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6267 headers_charset, '?', &len, &error);
6270 expand_string_message = error;
6273 yield = string_cat(yield, &size, &ptr, decoded, len);
6277 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6287 if (c > 255) c = '_';
6289 yield = string_cat(yield, &size, &ptr, buff, 1);
6294 /* replace illegal UTF-8 sequences by replacement character */
6296 #define UTF8_REPLACEMENT_CHAR US"?"
6300 int seq_len, index = 0;
6302 uschar seq_buff[4]; /* accumulate utf-8 here */
6314 if ((c & 0xc0) != 0x80)
6316 /* wrong continuation byte; invalidate all bytes */
6317 complete = 1; /* error */
6321 codepoint = (codepoint << 6) | (c & 0x3f);
6322 seq_buff[index++] = c;
6323 if (--bytes_left == 0) /* codepoint complete */
6325 if(codepoint > 0x10FFFF) /* is it too large? */
6326 complete = -1; /* error */
6328 { /* finished; output utf-8 sequence */
6329 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6335 else /* no bytes left: new sequence */
6337 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6339 yield = string_cat(yield, &size, &ptr, &c, 1);
6342 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6344 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6349 codepoint = c & 0x1f;
6352 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6355 codepoint = c & 0x0f;
6357 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6360 codepoint = c & 0x07;
6362 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6365 seq_buff[index++] = c;
6366 seq_len = bytes_left + 1;
6367 } /* if(bytes_left) */
6371 bytes_left = index = 0;
6372 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6374 if ((complete == 1) && ((c & 0x80) == 0))
6375 { /* ASCII character follows incomplete sequence */
6376 yield = string_cat(yield, &size, &ptr, &c, 1);
6382 /* escape turns all non-printing characters into escape sequences. */
6386 uschar *t = string_printing(sub);
6387 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6391 /* Handle numeric expression evaluation */
6396 uschar *save_sub = sub;
6397 uschar *error = NULL;
6398 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6401 expand_string_message = string_sprintf("error in expression "
6402 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6406 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6407 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6411 /* Handle time period formating */
6415 int n = readconf_readtime(sub, 0, FALSE);
6418 expand_string_message = string_sprintf("string \"%s\" is not an "
6419 "Exim time interval in \"%s\" operator", sub, name);
6422 sprintf(CS var_buffer, "%d", n);
6423 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6427 case EOP_TIME_INTERVAL:
6430 uschar *t = read_number(&n, sub);
6431 if (*t != 0) /* Not A Number*/
6433 expand_string_message = string_sprintf("string \"%s\" is not a "
6434 "positive number in \"%s\" operator", sub, name);
6437 t = readconf_printtime(n);
6438 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6442 /* Convert string to base64 encoding */
6446 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6447 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6451 /* strlen returns the length of the string */
6456 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6457 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6461 /* length_n or l_n takes just the first n characters or the whole string,
6462 whichever is the shorter;
6464 substr_m_n, and s_m_n take n characters from offset m; negative m take
6465 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6466 takes the rest, either to the right or to the left.
6468 hash_n or h_n makes a hash of length n from the string, yielding n
6469 characters from the set a-z; hash_n_m makes a hash of length n, but
6470 uses m characters from the set a-zA-Z0-9.
6472 nhash_n returns a single number between 0 and n-1 (in text form), while
6473 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6474 between 0 and n-1 and the second between 0 and m-1. */
6494 expand_string_message = string_sprintf("missing values after %s",
6499 /* "length" has only one argument, effectively being synonymous with
6502 if (c == EOP_LENGTH || c == EOP_L)
6508 /* The others have one or two arguments; for "substr" the first may be
6509 negative. The second being negative means "not supplied". */
6514 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6517 /* Read up to two numbers, separated by underscores */
6522 if (arg != ret && *arg == '_' && pn == &value1)
6526 if (arg[1] != 0) arg++;
6528 else if (!isdigit(*arg))
6530 expand_string_message =
6531 string_sprintf("non-digit after underscore in \"%s\"", name);
6534 else *pn = (*pn)*10 + *arg++ - '0';
6538 /* Perform the required operation */
6541 (c == EOP_HASH || c == EOP_H)?
6542 compute_hash(sub, value1, value2, &len) :
6543 (c == EOP_NHASH || c == EOP_NH)?
6544 compute_nhash(sub, value1, value2, &len) :
6545 extract_substr(sub, value1, value2, &len);
6547 if (ret == NULL) goto EXPAND_FAILED;
6548 yield = string_cat(yield, &size, &ptr, ret, len);
6558 uschar **modetable[3];
6563 if ((expand_forbid & RDO_EXISTS) != 0)
6565 expand_string_message = US"Use of the stat() expansion is not permitted";
6569 if (stat(CS sub, &st) < 0)
6571 expand_string_message = string_sprintf("stat(%s) failed: %s",
6572 sub, strerror(errno));
6576 switch (mode & S_IFMT)
6578 case S_IFIFO: smode[0] = 'p'; break;
6579 case S_IFCHR: smode[0] = 'c'; break;
6580 case S_IFDIR: smode[0] = 'd'; break;
6581 case S_IFBLK: smode[0] = 'b'; break;
6582 case S_IFREG: smode[0] = '-'; break;
6583 default: smode[0] = '?'; break;
6586 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6587 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6588 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6590 for (i = 0; i < 3; i++)
6592 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6597 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6598 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6599 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6600 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6601 (long)st.st_gid, st.st_size, (long)st.st_atime,
6602 (long)st.st_mtime, (long)st.st_ctime);
6603 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6607 /* vaguely random number less than N */
6611 int_eximarith_t max;
6614 max = expand_string_integer(sub, TRUE);
6615 if (expand_string_message != NULL)
6617 s = string_sprintf("%d", vaguely_random_number((int)max));
6618 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6622 /* Reverse IP, including IPv6 to dotted-nibble */
6624 case EOP_REVERSE_IP:
6626 int family, maskptr;
6627 uschar reversed[128];
6629 family = string_is_ip_address(sub, &maskptr);
6632 expand_string_message = string_sprintf(
6633 "reverse_ip() not given an IP address [%s]", sub);
6636 invert_address(reversed, sub);
6637 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6641 /* Unknown operator */
6644 expand_string_message =
6645 string_sprintf("unknown expansion operator \"%s\"", name);
6650 /* Handle a plain name. If this is the first thing in the expansion, release
6651 the pre-allocated buffer. If the result data is known to be in a new buffer,
6652 newsize will be set to the size of that buffer, and we can just point at that
6653 store instead of copying. Many expansion strings contain just one reference,
6654 so this is a useful optimization, especially for humungous headers
6655 ($message_headers). */
6663 if (resetok) store_reset(yield);
6667 value = find_variable(name, FALSE, skipping, &newsize);
6670 expand_string_message =
6671 string_sprintf("unknown variable in \"${%s}\"", name);
6672 check_variable_error_message(name);
6675 len = Ustrlen(value);
6676 if (yield == NULL && newsize != 0)
6682 else yield = string_cat(yield, &size, &ptr, value, len);
6686 /* Else there's something wrong */
6688 expand_string_message =
6689 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6690 "in a variable reference)", name);
6694 /* If we hit the end of the string when ket_ends is set, there is a missing
6695 terminating brace. */
6697 if (ket_ends && *s == 0)
6699 expand_string_message = malformed_header?
6700 US"missing } at end of string - could be header name not terminated by colon"
6702 US"missing } at end of string";
6706 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6707 added to the string. If so, set up an empty string. Add a terminating zero. If
6708 left != NULL, return a pointer to the terminator. */
6710 if (yield == NULL) yield = store_get(1);
6712 if (left != NULL) *left = s;
6714 /* Any stacking store that was used above the final string is no longer needed.
6715 In many cases the final string will be the first one that was got and so there
6716 will be optimal store usage. */
6718 if (resetok) store_reset(yield + ptr + 1);
6719 else if (resetok_p) *resetok_p = FALSE;
6723 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6725 if (skipping) debug_printf("skipping: result is not used\n");
6729 /* This is the failure exit: easiest to program with a goto. We still need
6730 to update the pointer to the terminator, for cases of nested calls with "fail".
6733 EXPAND_FAILED_CURLY:
6734 expand_string_message = malformed_header?
6735 US"missing or misplaced { or } - could be header name not terminated by colon"
6737 US"missing or misplaced { or }";
6739 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6740 that is a bad idea, because expand_string_message is in dynamic store. */
6743 if (left != NULL) *left = s;
6746 debug_printf("failed to expand: %s\n", string);
6747 debug_printf(" error message: %s\n", expand_string_message);
6748 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6750 if (resetok_p) *resetok_p = resetok;
6755 /* This is the external function call. Do a quick check for any expansion
6756 metacharacters, and if there are none, just return the input string.
6758 Argument: the string to be expanded
6759 Returns: the expanded string, or NULL if expansion failed; if failure was
6760 due to a lookup deferring, search_find_defer will be TRUE
6764 expand_string(uschar *string)
6766 search_find_defer = FALSE;
6767 malformed_header = FALSE;
6768 return (Ustrpbrk(string, "$\\") == NULL)? string :
6769 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
6774 /*************************************************
6776 *************************************************/
6778 /* Now and again we want to expand a string and be sure that the result is in a
6779 new bit of store. This function does that.
6781 Argument: the string to be expanded
6782 Returns: the expanded string, always in a new bit of store, or NULL
6786 expand_string_copy(uschar *string)
6788 uschar *yield = expand_string(string);
6789 if (yield == string) yield = string_copy(string);
6795 /*************************************************
6796 * Expand and interpret as an integer *
6797 *************************************************/
6799 /* Expand a string, and convert the result into an integer.
6802 string the string to be expanded
6803 isplus TRUE if a non-negative number is expected
6805 Returns: the integer value, or
6806 -1 for an expansion error ) in both cases, message in
6807 -2 for an integer interpretation error ) expand_string_message
6808 expand_string_message is set NULL for an OK integer
6812 expand_string_integer(uschar *string, BOOL isplus)
6814 int_eximarith_t value;
6815 uschar *s = expand_string(string);
6816 uschar *msg = US"invalid integer \"%s\"";
6819 /* If expansion failed, expand_string_message will be set. */
6821 if (s == NULL) return -1;
6823 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6824 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6825 systems, so we set it zero ourselves. */
6828 expand_string_message = NULL; /* Indicates no error */
6830 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6831 equal to 0. Unfortunately, people actually relied upon that, so preserve
6832 the behaviour explicitly. Stripping leading whitespace is a harmless
6833 noop change since strtol skips it anyway (provided that there is a number
6837 while (isspace(*s)) ++s;
6841 debug_printf("treating blank string as number 0\n");
6846 value = strtoll(CS s, CSS &endptr, 10);
6850 msg = US"integer expected but \"%s\" found";
6852 else if (value < 0 && isplus)
6854 msg = US"non-negative integer expected but \"%s\" found";
6858 switch (tolower(*endptr))
6863 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
6868 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
6869 else value *= 1024*1024;
6873 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
6874 else value *= 1024*1024*1024;
6878 if (errno == ERANGE)
6879 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6882 while (isspace(*endptr)) endptr++;
6883 if (*endptr == 0) return value;
6887 expand_string_message = string_sprintf(CS msg, s);
6892 /*************************************************
6893 **************************************************
6894 * Stand-alone test program *
6895 **************************************************
6896 *************************************************/
6902 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6904 int ovector[3*(EXPAND_MAXN+1)];
6905 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6906 ovector, sizeof(ovector)/sizeof(int));
6907 BOOL yield = n >= 0;
6908 if (n == 0) n = EXPAND_MAXN + 1;
6912 expand_nmax = (setup < 0)? 0 : setup + 1;
6913 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6915 expand_nstring[expand_nmax] = subject + ovector[nn];
6916 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6924 int main(int argc, uschar **argv)
6927 uschar buffer[1024];
6929 debug_selector = D_v;
6930 debug_file = stderr;
6931 debug_fd = fileno(debug_file);
6932 big_buffer = malloc(big_buffer_size);
6934 for (i = 1; i < argc; i++)
6936 if (argv[i][0] == '+')
6938 debug_trace_memory = 2;
6941 if (isdigit(argv[i][0]))
6942 debug_selector = Ustrtol(argv[i], NULL, 0);
6944 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6948 eldap_default_servers = argv[i];
6951 mysql_servers = argv[i];
6954 pgsql_servers = argv[i];
6956 #ifdef EXPERIMENTAL_REDIS
6957 redis_servers = argv[i];
6961 else opt_perl_startup = argv[i];
6965 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6967 expand_nstring[1] = US"string 1....";
6968 expand_nlength[1] = 8;
6972 if (opt_perl_startup != NULL)
6975 printf("Starting Perl interpreter\n");
6976 errstr = init_perl(opt_perl_startup);
6979 printf("** error in perl_startup code: %s\n", errstr);
6980 return EXIT_FAILURE;
6983 #endif /* EXIM_PERL */
6985 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6987 void *reset_point = store_get(0);
6988 uschar *yield = expand_string(buffer);
6991 printf("%s\n", yield);
6992 store_reset(reset_point);
6996 if (search_find_defer) printf("search_find deferred\n");
6997 printf("Failed: %s\n", expand_string_message);
6998 if (expand_string_forcedfail) printf("Forced failure\n");
7013 /* End of expand.c */