1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2013 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, BOOL, BOOL *);
19 #ifndef SUPPORT_CRYPTEQ
20 #define SUPPORT_CRYPTEQ
25 #include "lookups/ldap.h"
28 #ifdef SUPPORT_CRYPTEQ
33 extern char* crypt16(char*, char*);
37 /* The handling of crypt16() is a mess. I will record below the analysis of the
38 mess that was sent to me. We decided, however, to make changing this very low
39 priority, because in practice people are moving away from the crypt()
40 algorithms nowadays, so it doesn't seem worth it.
43 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
44 the first 8 characters of the password using a 20-round version of crypt
45 (standard crypt does 25 rounds). It then crypts the next 8 characters,
46 or an empty block if the password is less than 9 characters, using a
47 20-round version of crypt and the same salt as was used for the first
48 block. Charaters after the first 16 are ignored. It always generates
49 a 16-byte hash, which is expressed together with the salt as a string
50 of 24 base 64 digits. Here are some links to peruse:
52 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
53 http://seclists.org/bugtraq/1999/Mar/0076.html
55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
56 and OSF/1. This is the same as the standard crypt if given a password
57 of 8 characters or less. If given more, it first does the same as crypt
58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
59 using as salt the first two base 64 digits from the first hash block.
60 If the password is more than 16 characters then it crypts the 17th to 24th
61 characters using as salt the first two base 64 digits from the second hash
62 block. And so on: I've seen references to it cutting off the password at
63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0109.html
67 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
68 TET1_html/sec.c222.html#no_id_208
70 Exim has something it calls "crypt16". It will either use a native
71 crypt16 or its own implementation. A native crypt16 will presumably
72 be the one that I called "crypt16" above. The internal "crypt16"
73 function, however, is a two-block-maximum implementation of what I called
74 "bigcrypt". The documentation matches the internal code.
76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
77 that crypt16 and bigcrypt were different things.
79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
80 to whatever it is using under that name. This unfortunately sets a
81 precedent for using "{crypt16}" to identify two incompatible algorithms
82 whose output can't be distinguished. With "{crypt16}" thus rendered
83 ambiguous, I suggest you deprecate it and invent two new identifiers
84 for the two algorithms.
86 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
87 of the password separately means they can be cracked separately, so
88 the double-length hash only doubles the cracking effort instead of
89 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
152 /* Tables of operator names, and corresponding switch numbers. The names must be
153 in alphabetical order. There are two tables, because underscore is used in some
154 cases to introduce arguments, whereas for other it is part of the name. This is
155 an historical mis-design. */
157 static uschar *op_table_underscore[] = {
160 US"quote_local_part",
168 EOP_QUOTE_LOCAL_PART,
173 static uschar *op_table_main[] = {
211 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
248 /* Table of condition names, and corresponding switch numbers. The names must
249 be in alphabetical order. */
251 static uschar *cond_table[] = {
255 US"==", /* Backward compatibility */
288 US"match_local_part",
313 ECOND_FIRST_DELIVERY,
334 ECOND_MATCH_LOCAL_PART,
344 /* Type for main variable table */
352 /* Type for entries pointing to address/length pairs. Not currently
360 /* Types of table entry */
363 vtype_int, /* value is address of int */
364 vtype_filter_int, /* ditto, but recognized only when filtering */
365 vtype_ino, /* value is address of ino_t (not always an int) */
366 vtype_uid, /* value is address of uid_t (not always an int) */
367 vtype_gid, /* value is address of gid_t (not always an int) */
368 vtype_bool, /* value is address of bool */
369 vtype_stringptr, /* value is address of pointer to string */
370 vtype_msgbody, /* as stringptr, but read when first required */
371 vtype_msgbody_end, /* ditto, the end of the message */
372 vtype_msgheaders, /* the message's headers, processed */
373 vtype_msgheaders_raw, /* the message's headers, unprocessed */
374 vtype_localpart, /* extract local part from string */
375 vtype_domain, /* extract domain from string */
376 vtype_string_func, /* value is string returned by given function */
377 vtype_todbsdin, /* value not used; generate BSD inbox tod */
378 vtype_tode, /* value not used; generate tod in epoch format */
379 vtype_todel, /* value not used; generate tod in epoch/usec format */
380 vtype_todf, /* value not used; generate full tod */
381 vtype_todl, /* value not used; generate log tod */
382 vtype_todlf, /* value not used; generate log file datestamp tod */
383 vtype_todzone, /* value not used; generate time zone only */
384 vtype_todzulu, /* value not used; generate zulu tod */
385 vtype_reply, /* value not used; get reply from headers */
386 vtype_pid, /* value not used; result is pid */
387 vtype_host_lookup, /* value not used; get host name */
388 vtype_load_avg, /* value not used; result is int from os_getloadavg */
389 vtype_pspace, /* partition space; value is T/F for spool/log */
390 vtype_pinodes /* partition inodes; value is T/F for spool/log */
392 ,vtype_dkim /* Lookup of value in DKIM signature */
396 static uschar * fn_recipients(void);
398 /* This table must be kept in alphabetical order. */
400 static var_entry var_table[] = {
401 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
402 they will be confused with user-creatable ACL variables. */
403 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
404 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
405 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
406 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
407 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
408 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
409 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
410 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
411 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
412 { "acl_narg", vtype_int, &acl_narg },
413 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
414 { "address_data", vtype_stringptr, &deliver_address_data },
415 { "address_file", vtype_stringptr, &address_file },
416 { "address_pipe", vtype_stringptr, &address_pipe },
417 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
418 { "authenticated_id", vtype_stringptr, &authenticated_id },
419 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
420 { "authentication_failed",vtype_int, &authentication_failed },
421 #ifdef WITH_CONTENT_SCAN
422 { "av_failed", vtype_int, &av_failed },
424 #ifdef EXPERIMENTAL_BRIGHTMAIL
425 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
426 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
427 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
428 { "bmi_deliver", vtype_int, &bmi_deliver },
430 { "body_linecount", vtype_int, &body_linecount },
431 { "body_zerocount", vtype_int, &body_zerocount },
432 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
433 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
434 { "caller_gid", vtype_gid, &real_gid },
435 { "caller_uid", vtype_uid, &real_uid },
436 { "compile_date", vtype_stringptr, &version_date },
437 { "compile_number", vtype_stringptr, &version_cnumber },
438 { "csa_status", vtype_stringptr, &csa_status },
439 #ifdef EXPERIMENTAL_DCC
440 { "dcc_header", vtype_stringptr, &dcc_header },
441 { "dcc_result", vtype_stringptr, &dcc_result },
443 #ifdef WITH_OLD_DEMIME
444 { "demime_errorlevel", vtype_int, &demime_errorlevel },
445 { "demime_reason", vtype_stringptr, &demime_reason },
448 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
449 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
450 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
451 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
452 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
453 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
454 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
455 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
456 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
457 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
458 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
459 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
460 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
461 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
462 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
463 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
464 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
465 { "dkim_signers", vtype_stringptr, &dkim_signers },
466 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
467 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
469 #ifdef EXPERIMENTAL_DMARC
470 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
471 { "dmarc_status", vtype_stringptr, &dmarc_status },
472 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
473 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
475 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
476 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
477 { "dnslist_text", vtype_stringptr, &dnslist_text },
478 { "dnslist_value", vtype_stringptr, &dnslist_value },
479 { "domain", vtype_stringptr, &deliver_domain },
480 { "domain_data", vtype_stringptr, &deliver_domain_data },
481 { "exim_gid", vtype_gid, &exim_gid },
482 { "exim_path", vtype_stringptr, &exim_path },
483 { "exim_uid", vtype_uid, &exim_uid },
484 #ifdef WITH_OLD_DEMIME
485 { "found_extension", vtype_stringptr, &found_extension },
487 { "headers_added", vtype_string_func, &fn_hdrs_added },
488 { "home", vtype_stringptr, &deliver_home },
489 { "host", vtype_stringptr, &deliver_host },
490 { "host_address", vtype_stringptr, &deliver_host_address },
491 { "host_data", vtype_stringptr, &host_data },
492 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
493 { "host_lookup_failed", vtype_int, &host_lookup_failed },
494 { "inode", vtype_ino, &deliver_inode },
495 { "interface_address", vtype_stringptr, &interface_address },
496 { "interface_port", vtype_int, &interface_port },
497 { "item", vtype_stringptr, &iterate_item },
499 { "ldap_dn", vtype_stringptr, &eldap_dn },
501 { "load_average", vtype_load_avg, NULL },
502 { "local_part", vtype_stringptr, &deliver_localpart },
503 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
504 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
505 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
506 { "local_scan_data", vtype_stringptr, &local_scan_data },
507 { "local_user_gid", vtype_gid, &local_user_gid },
508 { "local_user_uid", vtype_uid, &local_user_uid },
509 { "localhost_number", vtype_int, &host_number },
510 { "log_inodes", vtype_pinodes, (void *)FALSE },
511 { "log_space", vtype_pspace, (void *)FALSE },
512 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
513 #ifdef WITH_CONTENT_SCAN
514 { "malware_name", vtype_stringptr, &malware_name },
516 { "max_received_linelength", vtype_int, &max_received_linelength },
517 { "message_age", vtype_int, &message_age },
518 { "message_body", vtype_msgbody, &message_body },
519 { "message_body_end", vtype_msgbody_end, &message_body_end },
520 { "message_body_size", vtype_int, &message_body_size },
521 { "message_exim_id", vtype_stringptr, &message_id },
522 { "message_headers", vtype_msgheaders, NULL },
523 { "message_headers_raw", vtype_msgheaders_raw, NULL },
524 { "message_id", vtype_stringptr, &message_id },
525 { "message_linecount", vtype_int, &message_linecount },
526 { "message_size", vtype_int, &message_size },
527 #ifdef WITH_CONTENT_SCAN
528 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
529 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
530 { "mime_boundary", vtype_stringptr, &mime_boundary },
531 { "mime_charset", vtype_stringptr, &mime_charset },
532 { "mime_content_description", vtype_stringptr, &mime_content_description },
533 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
534 { "mime_content_id", vtype_stringptr, &mime_content_id },
535 { "mime_content_size", vtype_int, &mime_content_size },
536 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
537 { "mime_content_type", vtype_stringptr, &mime_content_type },
538 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
539 { "mime_filename", vtype_stringptr, &mime_filename },
540 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
541 { "mime_is_multipart", vtype_int, &mime_is_multipart },
542 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
543 { "mime_part_count", vtype_int, &mime_part_count },
545 { "n0", vtype_filter_int, &filter_n[0] },
546 { "n1", vtype_filter_int, &filter_n[1] },
547 { "n2", vtype_filter_int, &filter_n[2] },
548 { "n3", vtype_filter_int, &filter_n[3] },
549 { "n4", vtype_filter_int, &filter_n[4] },
550 { "n5", vtype_filter_int, &filter_n[5] },
551 { "n6", vtype_filter_int, &filter_n[6] },
552 { "n7", vtype_filter_int, &filter_n[7] },
553 { "n8", vtype_filter_int, &filter_n[8] },
554 { "n9", vtype_filter_int, &filter_n[9] },
555 { "original_domain", vtype_stringptr, &deliver_domain_orig },
556 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
557 { "originator_gid", vtype_gid, &originator_gid },
558 { "originator_uid", vtype_uid, &originator_uid },
559 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
560 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
561 { "pid", vtype_pid, NULL },
562 { "primary_hostname", vtype_stringptr, &primary_hostname },
563 #ifdef EXPERIMENTAL_PROXY
564 { "proxy_host_address", vtype_stringptr, &proxy_host_address },
565 { "proxy_host_port", vtype_int, &proxy_host_port },
566 { "proxy_session", vtype_bool, &proxy_session },
568 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
569 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
570 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
571 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
572 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
573 { "rcpt_count", vtype_int, &rcpt_count },
574 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
575 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
576 { "received_count", vtype_int, &received_count },
577 { "received_for", vtype_stringptr, &received_for },
578 { "received_ip_address", vtype_stringptr, &interface_address },
579 { "received_port", vtype_int, &interface_port },
580 { "received_protocol", vtype_stringptr, &received_protocol },
581 { "received_time", vtype_int, &received_time },
582 { "recipient_data", vtype_stringptr, &recipient_data },
583 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
584 { "recipients", vtype_string_func, &fn_recipients },
585 { "recipients_count", vtype_int, &recipients_count },
586 #ifdef WITH_CONTENT_SCAN
587 { "regex_match_string", vtype_stringptr, ®ex_match_string },
589 { "reply_address", vtype_reply, NULL },
590 { "return_path", vtype_stringptr, &return_path },
591 { "return_size_limit", vtype_int, &bounce_return_size_limit },
592 { "router_name", vtype_stringptr, &router_name },
593 { "runrc", vtype_int, &runrc },
594 { "self_hostname", vtype_stringptr, &self_hostname },
595 { "sender_address", vtype_stringptr, &sender_address },
596 { "sender_address_data", vtype_stringptr, &sender_address_data },
597 { "sender_address_domain", vtype_domain, &sender_address },
598 { "sender_address_local_part", vtype_localpart, &sender_address },
599 { "sender_data", vtype_stringptr, &sender_data },
600 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
601 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
602 { "sender_host_address", vtype_stringptr, &sender_host_address },
603 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
604 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
605 { "sender_host_name", vtype_host_lookup, NULL },
606 { "sender_host_port", vtype_int, &sender_host_port },
607 { "sender_ident", vtype_stringptr, &sender_ident },
608 { "sender_rate", vtype_stringptr, &sender_rate },
609 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
610 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
611 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
612 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
613 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
614 { "sending_port", vtype_int, &sending_port },
615 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
616 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
617 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
618 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
619 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
620 { "sn0", vtype_filter_int, &filter_sn[0] },
621 { "sn1", vtype_filter_int, &filter_sn[1] },
622 { "sn2", vtype_filter_int, &filter_sn[2] },
623 { "sn3", vtype_filter_int, &filter_sn[3] },
624 { "sn4", vtype_filter_int, &filter_sn[4] },
625 { "sn5", vtype_filter_int, &filter_sn[5] },
626 { "sn6", vtype_filter_int, &filter_sn[6] },
627 { "sn7", vtype_filter_int, &filter_sn[7] },
628 { "sn8", vtype_filter_int, &filter_sn[8] },
629 { "sn9", vtype_filter_int, &filter_sn[9] },
630 #ifdef WITH_CONTENT_SCAN
631 { "spam_bar", vtype_stringptr, &spam_bar },
632 { "spam_report", vtype_stringptr, &spam_report },
633 { "spam_score", vtype_stringptr, &spam_score },
634 { "spam_score_int", vtype_stringptr, &spam_score_int },
636 #ifdef EXPERIMENTAL_SPF
637 { "spf_guess", vtype_stringptr, &spf_guess },
638 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
639 { "spf_received", vtype_stringptr, &spf_received },
640 { "spf_result", vtype_stringptr, &spf_result },
641 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
643 { "spool_directory", vtype_stringptr, &spool_directory },
644 { "spool_inodes", vtype_pinodes, (void *)TRUE },
645 { "spool_space", vtype_pspace, (void *)TRUE },
646 #ifdef EXPERIMENTAL_SRS
647 { "srs_db_address", vtype_stringptr, &srs_db_address },
648 { "srs_db_key", vtype_stringptr, &srs_db_key },
649 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
650 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
651 { "srs_recipient", vtype_stringptr, &srs_recipient },
652 { "srs_status", vtype_stringptr, &srs_status },
654 { "thisaddress", vtype_stringptr, &filter_thisaddress },
656 /* The non-(in,out) variables are now deprecated */
657 { "tls_bits", vtype_int, &tls_in.bits },
658 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
659 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
661 { "tls_in_bits", vtype_int, &tls_in.bits },
662 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
663 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
664 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
665 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
666 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
668 { "tls_out_bits", vtype_int, &tls_out.bits },
669 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
670 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
671 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
672 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
673 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
676 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
677 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
678 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
681 { "tod_bsdinbox", vtype_todbsdin, NULL },
682 { "tod_epoch", vtype_tode, NULL },
683 { "tod_epoch_l", vtype_todel, NULL },
684 { "tod_full", vtype_todf, NULL },
685 { "tod_log", vtype_todl, NULL },
686 { "tod_logfile", vtype_todlf, NULL },
687 { "tod_zone", vtype_todzone, NULL },
688 { "tod_zulu", vtype_todzulu, NULL },
689 #ifdef EXPERIMENTAL_TPDA
690 { "tpda_defer_errno", vtype_int, &tpda_defer_errno },
691 { "tpda_defer_errstr", vtype_stringptr, &tpda_defer_errstr },
692 { "tpda_delivery_confirmation", vtype_stringptr, &tpda_delivery_confirmation },
693 { "tpda_delivery_domain", vtype_stringptr, &tpda_delivery_domain },
694 { "tpda_delivery_fqdn", vtype_stringptr, &tpda_delivery_fqdn },
695 { "tpda_delivery_ip", vtype_stringptr, &tpda_delivery_ip },
696 { "tpda_delivery_local_part",vtype_stringptr,&tpda_delivery_local_part },
697 { "tpda_delivery_port", vtype_int, &tpda_delivery_port },
699 { "transport_name", vtype_stringptr, &transport_name },
700 { "value", vtype_stringptr, &lookup_value },
701 { "version_number", vtype_stringptr, &version_string },
702 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
703 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
704 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
705 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
706 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
707 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
710 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
711 static uschar var_buffer[256];
712 static BOOL malformed_header;
714 /* For textual hashes */
716 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
717 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
720 enum { HMAC_MD5, HMAC_SHA1 };
722 /* For numeric hashes */
724 static unsigned int prime[] = {
725 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
726 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
727 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
729 /* For printing modes in symbolic form */
731 static uschar *mtable_normal[] =
732 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
734 static uschar *mtable_setid[] =
735 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
737 static uschar *mtable_sticky[] =
738 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
742 /*************************************************
743 * Tables for UTF-8 support *
744 *************************************************/
746 /* Table of the number of extra characters, indexed by the first character
747 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
750 static uschar utf8_table1[] = {
751 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
752 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
753 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
754 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
756 /* These are the masks for the data bits in the first byte of a character,
757 indexed by the number of additional bytes. */
759 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
761 /* Get the next UTF-8 character, advancing the pointer. */
763 #define GETUTF8INC(c, ptr) \
765 if ((c & 0xc0) == 0xc0) \
767 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
769 c = (c & utf8_table2[a]) << s; \
773 c |= (*ptr++ & 0x3f) << s; \
778 /*************************************************
779 * Binary chop search on a table *
780 *************************************************/
782 /* This is used for matching expansion items and operators.
785 name the name that is being sought
786 table the table to search
787 table_size the number of items in the table
789 Returns: the offset in the table, or -1
793 chop_match(uschar *name, uschar **table, int table_size)
795 uschar **bot = table;
796 uschar **top = table + table_size;
800 uschar **mid = bot + (top - bot)/2;
801 int c = Ustrcmp(name, *mid);
802 if (c == 0) return mid - table;
803 if (c > 0) bot = mid + 1; else top = mid;
811 /*************************************************
812 * Check a condition string *
813 *************************************************/
815 /* This function is called to expand a string, and test the result for a "true"
816 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
817 forced fail or lookup defer.
819 We used to release all store used, but this is not not safe due
820 to ${dlfunc } and ${acl }. In any case expand_string_internal()
821 is reasonably careful to release what it can.
823 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
826 condition the condition string
827 m1 text to be incorporated in panic error
830 Returns: TRUE if condition is met, FALSE if not
834 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
837 uschar *ss = expand_string(condition);
840 if (!expand_string_forcedfail && !search_find_defer)
841 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
842 "for %s %s: %s", condition, m1, m2, expand_string_message);
845 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
846 strcmpic(ss, US"false") != 0;
853 /*************************************************
854 * Pseudo-random number generation *
855 *************************************************/
857 /* Pseudo-random number generation. The result is not "expected" to be
858 cryptographically strong but not so weak that someone will shoot themselves
859 in the foot using it as a nonce in some email header scheme or whatever
860 weirdness they'll twist this into. The result should ideally handle fork().
862 However, if we're stuck unable to provide this, then we'll fall back to
863 appallingly bad randomness.
865 If SUPPORT_TLS is defined then this will not be used except as an emergency
870 Returns a random number in range [0, max-1]
874 # define vaguely_random_number vaguely_random_number_fallback
877 vaguely_random_number(int max)
880 # undef vaguely_random_number
882 static pid_t pid = 0;
884 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
894 #ifdef HAVE_ARC4RANDOM
895 /* cryptographically strong randomness, common on *BSD platforms, not
896 so much elsewhere. Alas. */
898 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
899 #ifdef HAVE_SRANDOMDEV
900 /* uses random(4) for seeding */
903 gettimeofday(&tv, NULL);
904 srandom(tv.tv_sec | tv.tv_usec | getpid());
907 /* Poor randomness and no seeding here */
914 #ifdef HAVE_ARC4RANDOM
915 return arc4random() % max;
916 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
917 return random() % max;
919 /* This one returns a 16-bit number, definitely not crypto-strong */
920 return random_number(max);
927 /*************************************************
928 * Pick out a name from a string *
929 *************************************************/
931 /* If the name is too long, it is silently truncated.
934 name points to a buffer into which to put the name
935 max is the length of the buffer
936 s points to the first alphabetic character of the name
937 extras chars other than alphanumerics to permit
939 Returns: pointer to the first character after the name
941 Note: The test for *s != 0 in the while loop is necessary because
942 Ustrchr() yields non-NULL if the character is zero (which is not something
946 read_name(uschar *name, int max, uschar *s, uschar *extras)
949 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
951 if (ptr < max-1) name[ptr++] = *s;
960 /*************************************************
961 * Pick out the rest of a header name *
962 *************************************************/
964 /* A variable name starting $header_ (or just $h_ for those who like
965 abbreviations) might not be the complete header name because headers can
966 contain any printing characters in their names, except ':'. This function is
967 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
968 on the end, if the name was terminated by white space.
971 name points to a buffer in which the name read so far exists
972 max is the length of the buffer
973 s points to the first character after the name so far, i.e. the
974 first non-alphameric character after $header_xxxxx
976 Returns: a pointer to the first character after the header name
980 read_header_name(uschar *name, int max, uschar *s)
982 int prelen = Ustrchr(name, '_') - name + 1;
983 int ptr = Ustrlen(name) - prelen;
984 if (ptr > 0) memmove(name, name+prelen, ptr);
985 while (mac_isgraph(*s) && *s != ':')
987 if (ptr < max-1) name[ptr++] = *s;
998 /*************************************************
999 * Pick out a number from a string *
1000 *************************************************/
1003 n points to an integer into which to put the number
1004 s points to the first digit of the number
1006 Returns: a pointer to the character after the last digit
1010 read_number(int *n, uschar *s)
1013 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1019 /*************************************************
1020 * Extract keyed subfield from a string *
1021 *************************************************/
1023 /* The yield is in dynamic store; NULL means that the key was not found.
1026 key points to the name of the key
1027 s points to the string from which to extract the subfield
1029 Returns: NULL if the subfield was not found, or
1030 a pointer to the subfield's data
1034 expand_getkeyed(uschar *key, uschar *s)
1036 int length = Ustrlen(key);
1037 while (isspace(*s)) s++;
1039 /* Loop to search for the key */
1047 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1048 dkeylength = s - dkey;
1049 while (isspace(*s)) s++;
1050 if (*s == '=') while (isspace((*(++s))));
1052 data = string_dequote(&s);
1053 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1056 while (isspace(*s)) s++;
1065 /*************************************************
1066 * Extract numbered subfield from string *
1067 *************************************************/
1069 /* Extracts a numbered field from a string that is divided by tokens - for
1070 example a line from /etc/passwd is divided by colon characters. First field is
1071 numbered one. Negative arguments count from the right. Zero returns the whole
1072 string. Returns NULL if there are insufficient tokens in the string
1075 Modifies final argument - this is a dynamically generated string, so that's OK.
1078 field number of field to be extracted,
1079 first field = 1, whole string = 0, last field = -1
1080 separators characters that are used to break string into tokens
1081 s points to the string from which to extract the subfield
1083 Returns: NULL if the field was not found,
1084 a pointer to the field's data inside s (modified to add 0)
1088 expand_gettokened (int field, uschar *separators, uschar *s)
1093 uschar *fieldtext = NULL;
1095 if (field == 0) return s;
1097 /* Break the line up into fields in place; for field > 0 we stop when we have
1098 done the number of fields we want. For field < 0 we continue till the end of
1099 the string, counting the number of fields. */
1101 count = (field > 0)? field : INT_MAX;
1107 /* Previous field was the last one in the string. For a positive field
1108 number, this means there are not enough fields. For a negative field number,
1109 check that there are enough, and scan back to find the one that is wanted. */
1113 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1114 if ((-field) == (INT_MAX - count - 1)) return s;
1118 while (ss[-1] != 0) ss--;
1124 /* Previous field was not last in the string; save its start and put a
1128 len = Ustrcspn(ss, separators);
1139 expand_getlistele (int field, uschar *list)
1141 uschar * tlist= list;
1147 for(field++; string_nextinlist(&tlist, &sep, &dummy, 1); ) field++;
1150 if(field==0) return NULL;
1151 while(--field>0 && (string_nextinlist(&list, &sep, &dummy, 1))) ;
1152 return string_nextinlist(&list, &sep, NULL, 0);
1155 /*************************************************
1156 * Extract a substring from a string *
1157 *************************************************/
1159 /* Perform the ${substr or ${length expansion operations.
1162 subject the input string
1163 value1 the offset from the start of the input string to the start of
1164 the output string; if negative, count from the right.
1165 value2 the length of the output string, or negative (-1) for unset
1166 if value1 is positive, unset means "all after"
1167 if value1 is negative, unset means "all before"
1168 len set to the length of the returned string
1170 Returns: pointer to the output string, or NULL if there is an error
1174 extract_substr(uschar *subject, int value1, int value2, int *len)
1176 int sublen = Ustrlen(subject);
1178 if (value1 < 0) /* count from right */
1182 /* If the position is before the start, skip to the start, and adjust the
1183 length. If the length ends up negative, the substring is null because nothing
1184 can precede. This falls out naturally when the length is unset, meaning "all
1190 if (value2 < 0) value2 = 0;
1194 /* Otherwise an unset length => characters before value1 */
1196 else if (value2 < 0)
1203 /* For a non-negative offset, if the starting position is past the end of the
1204 string, the result will be the null string. Otherwise, an unset length means
1205 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1209 if (value1 > sublen)
1214 else if (value2 < 0) value2 = sublen;
1217 /* Cut the length down to the maximum possible for the offset value, and get
1218 the required characters. */
1220 if (value1 + value2 > sublen) value2 = sublen - value1;
1222 return subject + value1;
1228 /*************************************************
1229 * Old-style hash of a string *
1230 *************************************************/
1232 /* Perform the ${hash expansion operation.
1235 subject the input string (an expanded substring)
1236 value1 the length of the output string; if greater or equal to the
1237 length of the input string, the input string is returned
1238 value2 the number of hash characters to use, or 26 if negative
1239 len set to the length of the returned string
1241 Returns: pointer to the output string, or NULL if there is an error
1245 compute_hash(uschar *subject, int value1, int value2, int *len)
1247 int sublen = Ustrlen(subject);
1249 if (value2 < 0) value2 = 26;
1250 else if (value2 > Ustrlen(hashcodes))
1252 expand_string_message =
1253 string_sprintf("hash count \"%d\" too big", value2);
1257 /* Calculate the hash text. We know it is shorter than the original string, so
1258 can safely place it in subject[] (we know that subject is always itself an
1259 expanded substring). */
1261 if (value1 < sublen)
1266 while ((c = (subject[j])) != 0)
1268 int shift = (c + j++) & 7;
1269 subject[i] ^= (c << shift) | (c >> (8-shift));
1270 if (++i >= value1) i = 0;
1272 for (i = 0; i < value1; i++)
1273 subject[i] = hashcodes[(subject[i]) % value2];
1275 else value1 = sublen;
1284 /*************************************************
1285 * Numeric hash of a string *
1286 *************************************************/
1288 /* Perform the ${nhash expansion operation. The first characters of the
1289 string are treated as most important, and get the highest prime numbers.
1292 subject the input string
1293 value1 the maximum value of the first part of the result
1294 value2 the maximum value of the second part of the result,
1295 or negative to produce only a one-part result
1296 len set to the length of the returned string
1298 Returns: pointer to the output string, or NULL if there is an error.
1302 compute_nhash (uschar *subject, int value1, int value2, int *len)
1304 uschar *s = subject;
1306 unsigned long int total = 0; /* no overflow */
1310 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1311 total += prime[i--] * (unsigned int)(*s++);
1314 /* If value2 is unset, just compute one number */
1318 s = string_sprintf("%d", total % value1);
1321 /* Otherwise do a div/mod hash */
1325 total = total % (value1 * value2);
1326 s = string_sprintf("%d/%d", total/value2, total % value2);
1337 /*************************************************
1338 * Find the value of a header or headers *
1339 *************************************************/
1341 /* Multiple instances of the same header get concatenated, and this function
1342 can also return a concatenation of all the header lines. When concatenating
1343 specific headers that contain lists of addresses, a comma is inserted between
1344 them. Otherwise we use a straight concatenation. Because some messages can have
1345 pathologically large number of lines, there is a limit on the length that is
1346 returned. Also, to avoid massive store use which would result from using
1347 string_cat() as it copies and extends strings, we do a preliminary pass to find
1348 out exactly how much store will be needed. On "normal" messages this will be
1352 name the name of the header, without the leading $header_ or $h_,
1353 or NULL if a concatenation of all headers is required
1354 exists_only TRUE if called from a def: test; don't need to build a string;
1355 just return a string that is not "" and not "0" if the header
1357 newsize return the size of memory block that was obtained; may be NULL
1358 if exists_only is TRUE
1359 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1360 other than concatenating, will be done on the header. Also used
1361 for $message_headers_raw.
1362 charset name of charset to translate MIME words to; used only if
1363 want_raw is false; if NULL, no translation is done (this is
1364 used for $bh_ and $bheader_)
1366 Returns: NULL if the header does not exist, else a pointer to a new
1371 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1374 BOOL found = name == NULL;
1376 int len = found? 0 : Ustrlen(name);
1378 uschar *yield = NULL;
1381 /* Loop for two passes - saves code repetition */
1383 for (i = 0; i < 2; i++)
1388 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1390 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1392 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1397 if (exists_only) return US"1"; /* don't need actual string */
1399 t = h->text + len; /* text to insert */
1400 if (!want_raw) /* unless wanted raw, */
1401 while (isspace(*t)) t++; /* remove leading white space */
1402 ilen = h->slen - (t - h->text); /* length to insert */
1404 /* Unless wanted raw, remove trailing whitespace, including the
1408 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1410 /* Set comma = 1 if handling a single header and it's one of those
1411 that contains an address list, except when asked for raw headers. Only
1412 need to do this once. */
1414 if (!want_raw && name != NULL && comma == 0 &&
1415 Ustrchr("BCFRST", h->type) != NULL)
1418 /* First pass - compute total store needed; second pass - compute
1419 total store used, including this header. */
1421 size += ilen + comma + 1; /* +1 for the newline */
1423 /* Second pass - concatentate the data, up to a maximum. Note that
1424 the loop stops when size hits the limit. */
1428 if (size > header_insert_maxlen)
1430 ilen -= size - header_insert_maxlen - 1;
1433 Ustrncpy(ptr, t, ilen);
1436 /* For a non-raw header, put in the comma if needed, then add
1437 back the newline we removed above, provided there was some text in
1440 if (!want_raw && ilen > 0)
1442 if (comma != 0) *ptr++ = ',';
1450 /* At end of first pass, return NULL if no header found. Then truncate size
1451 if necessary, and get the buffer to hold the data, returning the buffer size.
1456 if (!found) return NULL;
1457 if (size > header_insert_maxlen) size = header_insert_maxlen;
1458 *newsize = size + 1;
1459 ptr = yield = store_get(*newsize);
1463 /* That's all we do for raw header expansion. */
1470 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1471 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1472 function can return an error with decoded data if the charset translation
1473 fails. If decoding fails, it returns NULL. */
1477 uschar *decoded, *error;
1478 if (ptr > yield && ptr[-1] == '\n') ptr--;
1479 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1481 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1485 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1486 " input was: %s\n", error, yield);
1488 if (decoded != NULL) yield = decoded;
1497 /*************************************************
1498 * Return list of recipients *
1499 *************************************************/
1500 /* A recipients list is available only during system message filtering,
1501 during ACL processing after DATA, and while expanding pipe commands
1502 generated from a system filter, but not elsewhere. */
1507 if (!enable_dollar_recipients) return NULL; else
1512 uschar * s = store_get(size);
1513 for (i = 0; i < recipients_count; i++)
1515 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1516 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1517 Ustrlen(recipients_list[i].address));
1519 s[ptr] = 0; /* string_cat() leaves room */
1525 /*************************************************
1526 * Find value of a variable *
1527 *************************************************/
1529 /* The table of variables is kept in alphabetic order, so we can search it
1530 using a binary chop. The "choplen" variable is nothing to do with the binary
1534 name the name of the variable being sought
1535 exists_only TRUE if this is a def: test; passed on to find_header()
1536 skipping TRUE => skip any processing evaluation; this is not the same as
1537 exists_only because def: may test for values that are first
1539 newsize pointer to an int which is initially zero; if the answer is in
1540 a new memory buffer, *newsize is set to its size
1542 Returns: NULL if the variable does not exist, or
1543 a pointer to the variable's contents, or
1544 something non-NULL if exists_only is TRUE
1548 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1551 int last = var_table_size;
1553 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1554 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1555 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1556 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1557 (this gave backwards compatibility at the changeover). There may be built-in
1558 variables whose names start acl_ but they should never start in this way. This
1559 slightly messy specification is a consequence of the history, needless to say.
1561 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1562 set, in which case give an error. */
1564 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1568 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1569 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1572 /* Handle $auth<n> variables. */
1574 if (Ustrncmp(name, "auth", 4) == 0)
1577 int n = Ustrtoul(name + 4, &endptr, 10);
1578 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1579 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1582 /* For all other variables, search the table */
1584 while (last > first)
1588 int middle = (first + last)/2;
1589 int c = Ustrcmp(name, var_table[middle].name);
1591 if (c > 0) { first = middle + 1; continue; }
1592 if (c < 0) { last = middle; continue; }
1594 /* Found an existing variable. If in skipping state, the value isn't needed,
1595 and we want to avoid processing (such as looking up the host name). */
1597 if (skipping) return US"";
1599 switch (var_table[middle].type)
1601 case vtype_filter_int:
1602 if (!filter_running) return NULL;
1606 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1610 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1614 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1618 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1622 sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1625 case vtype_stringptr: /* Pointer to string */
1626 s = *((uschar **)(var_table[middle].value));
1627 return (s == NULL)? US"" : s;
1630 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1633 case vtype_load_avg:
1634 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1637 case vtype_host_lookup: /* Lookup if not done so */
1638 if (sender_host_name == NULL && sender_host_address != NULL &&
1639 !host_lookup_failed && host_name_lookup() == OK)
1640 host_build_sender_fullhost();
1641 return (sender_host_name == NULL)? US"" : sender_host_name;
1643 case vtype_localpart: /* Get local part from address */
1644 s = *((uschar **)(var_table[middle].value));
1645 if (s == NULL) return US"";
1646 domain = Ustrrchr(s, '@');
1647 if (domain == NULL) return s;
1648 if (domain - s > sizeof(var_buffer) - 1)
1649 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1650 " in string expansion", sizeof(var_buffer));
1651 Ustrncpy(var_buffer, s, domain - s);
1652 var_buffer[domain - s] = 0;
1655 case vtype_domain: /* Get domain from address */
1656 s = *((uschar **)(var_table[middle].value));
1657 if (s == NULL) return US"";
1658 domain = Ustrrchr(s, '@');
1659 return (domain == NULL)? US"" : domain + 1;
1661 case vtype_msgheaders:
1662 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1664 case vtype_msgheaders_raw:
1665 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1667 case vtype_msgbody: /* Pointer to msgbody string */
1668 case vtype_msgbody_end: /* Ditto, the end of the msg */
1669 ss = (uschar **)(var_table[middle].value);
1670 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1673 off_t start_offset = SPOOL_DATA_START_OFFSET;
1674 int len = message_body_visible;
1675 if (len > message_size) len = message_size;
1676 *ss = body = store_malloc(len+1);
1678 if (var_table[middle].type == vtype_msgbody_end)
1680 struct stat statbuf;
1681 if (fstat(deliver_datafile, &statbuf) == 0)
1683 start_offset = statbuf.st_size - len;
1684 if (start_offset < SPOOL_DATA_START_OFFSET)
1685 start_offset = SPOOL_DATA_START_OFFSET;
1688 lseek(deliver_datafile, start_offset, SEEK_SET);
1689 len = read(deliver_datafile, body, len);
1693 if (message_body_newlines) /* Separate loops for efficiency */
1696 { if (body[--len] == 0) body[len] = ' '; }
1701 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1705 return (*ss == NULL)? US"" : *ss;
1707 case vtype_todbsdin: /* BSD inbox time of day */
1708 return tod_stamp(tod_bsdin);
1710 case vtype_tode: /* Unix epoch time of day */
1711 return tod_stamp(tod_epoch);
1713 case vtype_todel: /* Unix epoch/usec time of day */
1714 return tod_stamp(tod_epoch_l);
1716 case vtype_todf: /* Full time of day */
1717 return tod_stamp(tod_full);
1719 case vtype_todl: /* Log format time of day */
1720 return tod_stamp(tod_log_bare); /* (without timezone) */
1722 case vtype_todzone: /* Time zone offset only */
1723 return tod_stamp(tod_zone);
1725 case vtype_todzulu: /* Zulu time */
1726 return tod_stamp(tod_zulu);
1728 case vtype_todlf: /* Log file datestamp tod */
1729 return tod_stamp(tod_log_datestamp_daily);
1731 case vtype_reply: /* Get reply address */
1732 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1734 if (s != NULL) while (isspace(*s)) s++;
1735 if (s == NULL || *s == 0)
1737 *newsize = 0; /* For the *s==0 case */
1738 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1743 while (isspace(*s)) s++;
1744 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1745 while (t > s && isspace(t[-1])) t--;
1748 return (s == NULL)? US"" : s;
1750 case vtype_string_func:
1752 uschar * (*fn)() = var_table[middle].value;
1759 sprintf(CS var_buffer, "%d",
1760 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1767 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1768 sprintf(CS var_buffer, "%d", inodes);
1772 #ifndef DISABLE_DKIM
1774 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1780 return NULL; /* Unknown variable name */
1787 modify_variable(uschar *name, void * value)
1790 int last = var_table_size;
1792 while (last > first)
1794 int middle = (first + last)/2;
1795 int c = Ustrcmp(name, var_table[middle].name);
1797 if (c > 0) { first = middle + 1; continue; }
1798 if (c < 0) { last = middle; continue; }
1800 /* Found an existing variable; change the item it refers to */
1801 var_table[middle].value = value;
1804 return; /* Unknown variable name, fail silently */
1811 /*************************************************
1812 * Read and expand substrings *
1813 *************************************************/
1815 /* This function is called to read and expand argument substrings for various
1816 expansion items. Some have a minimum requirement that is less than the maximum;
1817 in these cases, the first non-present one is set to NULL.
1820 sub points to vector of pointers to set
1821 n maximum number of substrings
1823 sptr points to current string pointer
1824 skipping the skipping flag
1825 check_end if TRUE, check for final '}'
1826 name name of item, for error message
1827 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
1830 Returns: 0 OK; string pointer updated
1831 1 curly bracketing error (too few arguments)
1832 2 too many arguments (only if check_end is set); message set
1833 3 other error (expansion failure)
1837 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1838 BOOL check_end, uschar *name, BOOL *resetok)
1843 while (isspace(*s)) s++;
1844 for (i = 0; i < n; i++)
1848 if (i < m) return 1;
1852 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, resetok);
1853 if (sub[i] == NULL) return 3;
1854 if (*s++ != '}') return 1;
1855 while (isspace(*s)) s++;
1857 if (check_end && *s++ != '}')
1861 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1862 "(max is %d)", name, n);
1875 /*************************************************
1876 * Elaborate message for bad variable *
1877 *************************************************/
1879 /* For the "unknown variable" message, take a look at the variable's name, and
1880 give additional information about possible ACL variables. The extra information
1881 is added on to expand_string_message.
1883 Argument: the name of the variable
1888 check_variable_error_message(uschar *name)
1890 if (Ustrncmp(name, "acl_", 4) == 0)
1891 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1892 (name[4] == 'c' || name[4] == 'm')?
1894 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1895 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1897 US"user-defined ACL variables must start acl_c or acl_m");
1903 Load args from sub array to globals, and call acl_check().
1904 Sub array will be corrupted on return.
1906 Returns: OK access is granted by an ACCEPT verb
1907 DISCARD access is granted by a DISCARD verb
1908 FAIL access is denied
1909 FAIL_DROP access is denied; drop the connection
1910 DEFER can't tell at the moment
1914 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
1918 int sav_narg = acl_narg;
1920 extern int acl_where;
1922 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
1923 for (i = 0; i < nsub && sub[i+1]; i++)
1926 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
1927 sub[i+1] = tmp; /* stash the old args using our caller's storage */
1932 sub[i+1] = acl_arg[i];
1933 acl_arg[i++] = NULL;
1937 debug_printf("expanding: acl: %s arg: %s%s\n",
1939 acl_narg>0 ? acl_arg[0] : US"<none>",
1940 acl_narg>1 ? " +more" : "");
1942 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
1944 for (i = 0; i < nsub; i++)
1945 acl_arg[i] = sub[i+1]; /* restore old args */
1946 acl_narg = sav_narg;
1954 /*************************************************
1955 * Read and evaluate a condition *
1956 *************************************************/
1960 s points to the start of the condition text
1961 resetok points to a BOOL which is written false if it is unsafe to
1962 free memory. Certain condition types (acl) may have side-effect
1963 allocation which must be preserved.
1964 yield points to a BOOL to hold the result of the condition test;
1965 if NULL, we are just reading through a condition that is
1966 part of an "or" combination to check syntax, or in a state
1967 where the answer isn't required
1969 Returns: a pointer to the first character after the condition, or
1974 eval_condition(uschar *s, BOOL *resetok, BOOL *yield)
1976 BOOL testfor = TRUE;
1977 BOOL tempcond, combined_cond;
1979 BOOL sub2_honour_dollar = TRUE;
1980 int i, rc, cond_type, roffset;
1981 int_eximarith_t num[2];
1982 struct stat statbuf;
1987 const uschar *rerror;
1991 while (isspace(*s)) s++;
1992 if (*s == '!') { testfor = !testfor; s++; } else break;
1995 /* Numeric comparisons are symbolic */
1997 if (*s == '=' || *s == '>' || *s == '<')
2009 /* All other conditions are named */
2011 else s = read_name(name, 256, s, US"_");
2013 /* If we haven't read a name, it means some non-alpha character is first. */
2017 expand_string_message = string_sprintf("condition name expected, "
2018 "but found \"%.16s\"", s);
2022 /* Find which condition we are dealing with, and switch on it */
2024 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
2027 /* def: tests for a non-empty variable, or for the existence of a header. If
2028 yield == NULL we are in a skipping state, and don't care about the answer. */
2033 expand_string_message = US"\":\" expected after \"def\"";
2037 s = read_name(name, 256, s+1, US"_");
2039 /* Test for a header's existence. If the name contains a closing brace
2040 character, this may be a user error where the terminating colon has been
2041 omitted. Set a flag to adjust a subsequent error message in this case. */
2043 if (Ustrncmp(name, "h_", 2) == 0 ||
2044 Ustrncmp(name, "rh_", 3) == 0 ||
2045 Ustrncmp(name, "bh_", 3) == 0 ||
2046 Ustrncmp(name, "header_", 7) == 0 ||
2047 Ustrncmp(name, "rheader_", 8) == 0 ||
2048 Ustrncmp(name, "bheader_", 8) == 0)
2050 s = read_header_name(name, 256, s);
2051 /* {-for-text-editors */
2052 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2053 if (yield != NULL) *yield =
2054 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2057 /* Test for a variable's having a non-empty value. A non-existent variable
2058 causes an expansion failure. */
2062 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2065 expand_string_message = (name[0] == 0)?
2066 string_sprintf("variable name omitted after \"def:\"") :
2067 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2068 check_variable_error_message(name);
2071 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2077 /* first_delivery tests for first delivery attempt */
2079 case ECOND_FIRST_DELIVERY:
2080 if (yield != NULL) *yield = deliver_firsttime == testfor;
2084 /* queue_running tests for any process started by a queue runner */
2086 case ECOND_QUEUE_RUNNING:
2087 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2091 /* exists: tests for file existence
2092 isip: tests for any IP address
2093 isip4: tests for an IPv4 address
2094 isip6: tests for an IPv6 address
2095 pam: does PAM authentication
2096 radius: does RADIUS authentication
2097 ldapauth: does LDAP authentication
2098 pwcheck: does Cyrus SASL pwcheck authentication
2107 case ECOND_LDAPAUTH:
2110 while (isspace(*s)) s++;
2111 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2113 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE, resetok);
2114 if (sub[0] == NULL) return NULL;
2115 /* {-for-text-editors */
2116 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2118 if (yield == NULL) return s; /* No need to run the test if skipping */
2123 if ((expand_forbid & RDO_EXISTS) != 0)
2125 expand_string_message = US"File existence tests are not permitted";
2128 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2134 rc = string_is_ip_address(sub[0], NULL);
2135 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2136 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2139 /* Various authentication tests - all optionally compiled */
2143 rc = auth_call_pam(sub[0], &expand_string_message);
2146 goto COND_FAILED_NOT_COMPILED;
2147 #endif /* SUPPORT_PAM */
2150 #ifdef RADIUS_CONFIG_FILE
2151 rc = auth_call_radius(sub[0], &expand_string_message);
2154 goto COND_FAILED_NOT_COMPILED;
2155 #endif /* RADIUS_CONFIG_FILE */
2157 case ECOND_LDAPAUTH:
2160 /* Just to keep the interface the same */
2162 int old_pool = store_pool;
2163 store_pool = POOL_SEARCH;
2164 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2165 &expand_string_message, &do_cache);
2166 store_pool = old_pool;
2170 goto COND_FAILED_NOT_COMPILED;
2171 #endif /* LOOKUP_LDAP */
2174 #ifdef CYRUS_PWCHECK_SOCKET
2175 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2178 goto COND_FAILED_NOT_COMPILED;
2179 #endif /* CYRUS_PWCHECK_SOCKET */
2181 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2182 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2184 if (rc == ERROR || rc == DEFER) return NULL;
2185 *yield = (rc == OK) == testfor;
2191 /* call ACL (in a conditional context). Accept true, deny false.
2192 Defer is a forced-fail. Anything set by message= goes to $value.
2193 Up to ten parameters are used; we use the braces round the name+args
2194 like the saslauthd condition does, to permit a variable number of args.
2195 See also the expansion-item version EITEM_ACL and the traditional
2196 acl modifier ACLC_ACL.
2197 Since the ACL may allocate new global variables, tell our caller to not
2202 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2209 while (isspace(*s)) s++;
2210 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2212 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2213 &s, yield == NULL, TRUE, US"acl", resetok))
2215 case 1: expand_string_message = US"too few arguments or bracketing "
2218 case 3: return NULL;
2222 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2227 lookup_value = NULL;
2230 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2231 lookup_value[ptr] = '\0';
2233 *yield = cond == testfor;
2237 expand_string_forcedfail = TRUE;
2239 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2246 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2248 ${if saslauthd {{username}{password}{service}{realm}} {yes}{no}}
2250 However, the last two are optional. That is why the whole set is enclosed
2251 in their own set of braces. */
2253 case ECOND_SASLAUTHD:
2254 #ifndef CYRUS_SASLAUTHD_SOCKET
2255 goto COND_FAILED_NOT_COMPILED;
2257 while (isspace(*s)) s++;
2258 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2259 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd", resetok))
2261 case 1: expand_string_message = US"too few arguments or bracketing "
2262 "error for saslauthd";
2264 case 3: return NULL;
2266 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2270 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2271 &expand_string_message);
2272 if (rc == ERROR || rc == DEFER) return NULL;
2273 *yield = (rc == OK) == testfor;
2276 #endif /* CYRUS_SASLAUTHD_SOCKET */
2279 /* symbolic operators for numeric and string comparison, and a number of
2280 other operators, all requiring two arguments.
2282 crypteq: encrypts plaintext and compares against an encrypted text,
2283 using crypt(), crypt16(), MD5 or SHA-1
2284 inlist/inlisti: checks if first argument is in the list of the second
2285 match: does a regular expression match and sets up the numerical
2286 variables if it succeeds
2287 match_address: matches in an address list
2288 match_domain: matches in a domain list
2289 match_ip: matches a host list that is restricted to IP addresses
2290 match_local_part: matches in a local part list
2293 case ECOND_MATCH_ADDRESS:
2294 case ECOND_MATCH_DOMAIN:
2295 case ECOND_MATCH_IP:
2296 case ECOND_MATCH_LOCAL_PART:
2297 #ifndef EXPAND_LISTMATCH_RHS
2298 sub2_honour_dollar = FALSE;
2307 case ECOND_NUM_L: /* Numerical comparisons */
2314 case ECOND_STR_LT: /* String comparisons */
2325 for (i = 0; i < 2; i++)
2327 /* Sometimes, we don't expand substrings; too many insecure configurations
2328 created using match_address{}{} and friends, where the second param
2329 includes information from untrustworthy sources. */
2330 BOOL honour_dollar = TRUE;
2331 if ((i > 0) && !sub2_honour_dollar)
2332 honour_dollar = FALSE;
2334 while (isspace(*s)) s++;
2337 if (i == 0) goto COND_FAILED_CURLY_START;
2338 expand_string_message = string_sprintf("missing 2nd string in {} "
2339 "after \"%s\"", name);
2342 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2343 honour_dollar, resetok);
2344 if (sub[i] == NULL) return NULL;
2345 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2347 /* Convert to numerical if required; we know that the names of all the
2348 conditions that compare numbers do not start with a letter. This just saves
2349 checking for them individually. */
2351 if (!isalpha(name[0]) && yield != NULL)
2357 debug_printf("empty string cast to zero for numerical comparison\n");
2361 num[i] = expand_string_integer(sub[i], FALSE);
2362 if (expand_string_message != NULL) return NULL;
2367 /* Result not required */
2369 if (yield == NULL) return s;
2371 /* Do an appropriate comparison */
2377 tempcond = (num[0] == num[1]);
2381 tempcond = (num[0] > num[1]);
2385 tempcond = (num[0] >= num[1]);
2389 tempcond = (num[0] < num[1]);
2393 tempcond = (num[0] <= num[1]);
2397 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2401 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2405 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2409 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2413 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2417 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2421 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2425 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2429 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2433 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2436 case ECOND_MATCH: /* Regular expression match */
2437 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2441 expand_string_message = string_sprintf("regular expression error in "
2442 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2445 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2448 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2449 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2450 goto MATCHED_SOMETHING;
2452 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2453 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2454 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2455 goto MATCHED_SOMETHING;
2457 case ECOND_MATCH_IP: /* Match IP address in a host list */
2458 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2460 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2466 unsigned int *nullcache = NULL;
2467 check_host_block cb;
2469 cb.host_name = US"";
2470 cb.host_address = sub[0];
2472 /* If the host address starts off ::ffff: it is an IPv6 address in
2473 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2476 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2477 cb.host_address + 7 : cb.host_address;
2479 rc = match_check_list(
2480 &sub[1], /* the list */
2481 0, /* separator character */
2482 &hostlist_anchor, /* anchor pointer */
2483 &nullcache, /* cache pointer */
2484 check_host, /* function for testing */
2485 &cb, /* argument for function */
2486 MCL_HOST, /* type of check */
2487 sub[0], /* text for debugging */
2488 NULL); /* where to pass back data */
2490 goto MATCHED_SOMETHING;
2492 case ECOND_MATCH_LOCAL_PART:
2493 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2494 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2509 expand_string_message = string_sprintf("unable to complete match "
2510 "against \"%s\": %s", sub[1], search_error_message);
2516 /* Various "encrypted" comparisons. If the second string starts with
2517 "{" then an encryption type is given. Default to crypt() or crypt16()
2518 (build-time choice). */
2519 /* }-for-text-editors */
2522 #ifndef SUPPORT_CRYPTEQ
2523 goto COND_FAILED_NOT_COMPILED;
2525 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2527 int sublen = Ustrlen(sub[1]+5);
2532 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2534 /* If the length that we are comparing against is 24, the MD5 digest
2535 is expressed as a base64 string. This is the way LDAP does it. However,
2536 some other software uses a straightforward hex representation. We assume
2537 this if the length is 32. Other lengths fail. */
2541 uschar *coded = auth_b64encode((uschar *)digest, 16);
2542 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2543 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2544 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2546 else if (sublen == 32)
2550 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2552 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2553 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2554 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2558 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2559 "fail\n crypted=%s\n", sub[1]+5);
2564 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2566 int sublen = Ustrlen(sub[1]+6);
2571 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2573 /* If the length that we are comparing against is 28, assume the SHA1
2574 digest is expressed as a base64 string. If the length is 40, assume a
2575 straightforward hex representation. Other lengths fail. */
2579 uschar *coded = auth_b64encode((uschar *)digest, 20);
2580 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2581 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2582 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2584 else if (sublen == 40)
2588 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2590 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2591 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2592 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2596 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2597 "fail\n crypted=%s\n", sub[1]+6);
2602 else /* {crypt} or {crypt16} and non-{ at start */
2603 /* }-for-text-editors */
2608 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2613 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2618 else if (sub[1][0] == '{') /* }-for-text-editors */
2620 expand_string_message = string_sprintf("unknown encryption mechanism "
2621 "in \"%s\"", sub[1]);
2627 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2628 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2629 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2633 #define XSTR(s) STR(s)
2634 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2635 " subject=%s\n crypted=%s\n",
2636 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2641 /* If the encrypted string contains fewer than two characters (for the
2642 salt), force failure. Otherwise we get false positives: with an empty
2643 string the yield of crypt() is an empty string! */
2645 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2646 (Ustrcmp(coded, sub[1]) == 0);
2649 #endif /* SUPPORT_CRYPTEQ */
2655 uschar *save_iterate_item = iterate_item;
2656 int (*compare)(const uschar *, const uschar *);
2659 if (cond_type == ECOND_INLISTI)
2662 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2664 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2665 if (compare(sub[0], iterate_item) == 0)
2670 iterate_item = save_iterate_item;
2673 } /* Switch for comparison conditions */
2675 *yield = tempcond == testfor;
2676 return s; /* End of comparison conditions */
2679 /* and/or: computes logical and/or of several conditions */
2683 subcondptr = (yield == NULL)? NULL : &tempcond;
2684 combined_cond = (cond_type == ECOND_AND);
2686 while (isspace(*s)) s++;
2687 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2691 while (isspace(*s)) s++;
2692 /* {-for-text-editors */
2693 if (*s == '}') break;
2694 if (*s != '{') /* }-for-text-editors */
2696 expand_string_message = string_sprintf("each subcondition "
2697 "inside an \"%s{...}\" condition must be in its own {}", name);
2701 if (!(s = eval_condition(s+1, resetok, subcondptr)))
2703 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2704 expand_string_message, name);
2707 while (isspace(*s)) s++;
2709 /* {-for-text-editors */
2712 /* {-for-text-editors */
2713 expand_string_message = string_sprintf("missing } at end of condition "
2714 "inside \"%s\" group", name);
2720 if (cond_type == ECOND_AND)
2722 combined_cond &= tempcond;
2723 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2724 } /* evaluate any more */
2727 combined_cond |= tempcond;
2728 if (combined_cond) subcondptr = NULL; /* once true, don't */
2729 } /* evaluate any more */
2733 if (yield != NULL) *yield = (combined_cond == testfor);
2737 /* forall/forany: iterates a condition with different values */
2743 uschar *save_iterate_item = iterate_item;
2745 while (isspace(*s)) s++;
2746 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2747 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE, resetok);
2748 if (sub[0] == NULL) return NULL;
2749 /* {-for-text-editors */
2750 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2752 while (isspace(*s)) s++;
2753 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2757 /* Call eval_condition once, with result discarded (as if scanning a
2758 "false" part). This allows us to find the end of the condition, because if
2759 the list it empty, we won't actually evaluate the condition for real. */
2761 if (!(s = eval_condition(sub[1], resetok, NULL)))
2763 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2764 expand_string_message, name);
2767 while (isspace(*s)) s++;
2769 /* {-for-text-editors */
2772 /* {-for-text-editors */
2773 expand_string_message = string_sprintf("missing } at end of condition "
2774 "inside \"%s\"", name);
2778 if (yield != NULL) *yield = !testfor;
2779 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2781 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2782 if (!eval_condition(sub[1], resetok, &tempcond))
2784 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2785 expand_string_message, name);
2786 iterate_item = save_iterate_item;
2789 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2790 tempcond? "true":"false");
2792 if (yield != NULL) *yield = (tempcond == testfor);
2793 if (tempcond == (cond_type == ECOND_FORANY)) break;
2796 iterate_item = save_iterate_item;
2801 /* The bool{} expansion condition maps a string to boolean.
2802 The values supported should match those supported by the ACL condition
2803 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2804 of true/false. Note that Router "condition" rules have a different
2805 interpretation, where general data can be used and only a few values
2807 Note that readconf.c boolean matching, for boolean configuration options,
2808 only matches true/yes/false/no.
2809 The bool_lax{} condition matches the Router logic, which is much more
2812 case ECOND_BOOL_LAX:
2818 BOOL boolvalue = FALSE;
2819 while (isspace(*s)) s++;
2820 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2821 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2822 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname, resetok))
2824 case 1: expand_string_message = string_sprintf(
2825 "too few arguments or bracketing error for %s",
2829 case 3: return NULL;
2832 while (isspace(*t)) t++;
2836 /* trailing whitespace: seems like a good idea to ignore it too */
2838 while (isspace(*t2)) t2--;
2839 if (t2 != (t + len))
2846 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2847 /* logic for the lax case from expand_check_condition(), which also does
2848 expands, and the logic is both short and stable enough that there should
2849 be no maintenance burden from replicating it. */
2853 ? Ustrspn(t+1, "0123456789") == len-1
2854 : Ustrspn(t, "0123456789") == len)
2856 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2857 /* expand_check_condition only does a literal string "0" check */
2858 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2861 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2863 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2865 else if (cond_type == ECOND_BOOL_LAX)
2869 expand_string_message = string_sprintf("unrecognised boolean "
2873 if (yield != NULL) *yield = (boolvalue == testfor);
2877 /* Unknown condition */
2880 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2882 } /* End switch on condition type */
2884 /* Missing braces at start and end of data */
2886 COND_FAILED_CURLY_START:
2887 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2890 COND_FAILED_CURLY_END:
2891 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2895 /* A condition requires code that is not compiled */
2897 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2898 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2899 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2900 COND_FAILED_NOT_COMPILED:
2901 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2910 /*************************************************
2911 * Save numerical variables *
2912 *************************************************/
2914 /* This function is called from items such as "if" that want to preserve and
2915 restore the numbered variables.
2918 save_expand_string points to an array of pointers to set
2919 save_expand_nlength points to an array of ints for the lengths
2921 Returns: the value of expand max to save
2925 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2928 for (i = 0; i <= expand_nmax; i++)
2930 save_expand_nstring[i] = expand_nstring[i];
2931 save_expand_nlength[i] = expand_nlength[i];
2938 /*************************************************
2939 * Restore numerical variables *
2940 *************************************************/
2942 /* This function restored saved values of numerical strings.
2945 save_expand_nmax the number of strings to restore
2946 save_expand_string points to an array of pointers
2947 save_expand_nlength points to an array of ints
2953 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2954 int *save_expand_nlength)
2957 expand_nmax = save_expand_nmax;
2958 for (i = 0; i <= expand_nmax; i++)
2960 expand_nstring[i] = save_expand_nstring[i];
2961 expand_nlength[i] = save_expand_nlength[i];
2969 /*************************************************
2970 * Handle yes/no substrings *
2971 *************************************************/
2973 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2974 alternative substrings that depend on whether or not the condition was true,
2975 or the lookup or extraction succeeded. The substrings always have to be
2976 expanded, to check their syntax, but "skipping" is set when the result is not
2977 needed - this avoids unnecessary nested lookups.
2980 skipping TRUE if we were skipping when this item was reached
2981 yes TRUE if the first string is to be used, else use the second
2982 save_lookup a value to put back into lookup_value before the 2nd expansion
2983 sptr points to the input string pointer
2984 yieldptr points to the output string pointer
2985 sizeptr points to the output string size
2986 ptrptr points to the output string pointer
2987 type "lookup" or "if" or "extract" or "run", for error message
2988 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2991 Returns: 0 OK; lookup_value has been reset to save_lookup
2993 2 expansion failed because of bracketing error
2997 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2998 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
3001 uschar *s = *sptr; /* Local value */
3002 uschar *sub1, *sub2;
3004 /* If there are no following strings, we substitute the contents of $value for
3005 lookups and for extractions in the success case. For the ${if item, the string
3006 "true" is substituted. In the fail case, nothing is substituted for all three
3009 while (isspace(*s)) s++;
3014 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3018 if (yes && lookup_value != NULL)
3019 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3020 Ustrlen(lookup_value));
3021 lookup_value = save_lookup;
3027 /* The first following string must be braced. */
3029 if (*s++ != '{') goto FAILED_CURLY;
3031 /* Expand the first substring. Forced failures are noticed only if we actually
3032 want this string. Set skipping in the call in the fail case (this will always
3033 be the case if we were already skipping). */
3035 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3036 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3037 expand_string_forcedfail = FALSE;
3038 if (*s++ != '}') goto FAILED_CURLY;
3040 /* If we want the first string, add it to the output */
3043 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3045 /* If this is called from a lookup or an extract, we want to restore $value to
3046 what it was at the start of the item, so that it has this value during the
3047 second string expansion. For the call from "if" or "run" to this function,
3048 save_lookup is set to lookup_value, so that this statement does nothing. */
3050 lookup_value = save_lookup;
3052 /* There now follows either another substring, or "fail", or nothing. This
3053 time, forced failures are noticed only if we want the second string. We must
3054 set skipping in the nested call if we don't want this string, or if we were
3055 already skipping. */
3057 while (isspace(*s)) s++;
3060 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3061 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3062 expand_string_forcedfail = FALSE;
3063 if (*s++ != '}') goto FAILED_CURLY;
3065 /* If we want the second string, add it to the output */
3068 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3071 /* If there is no second string, but the word "fail" is present when the use of
3072 the second string is wanted, set a flag indicating it was a forced failure
3073 rather than a syntactic error. Swallow the terminating } in case this is nested
3074 inside another lookup or if or extract. */
3079 s = read_name(name, sizeof(name), s, US"_");
3080 if (Ustrcmp(name, "fail") == 0)
3082 if (!yes && !skipping)
3084 while (isspace(*s)) s++;
3085 if (*s++ != '}') goto FAILED_CURLY;
3086 expand_string_message =
3087 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3088 expand_string_forcedfail = TRUE;
3094 expand_string_message =
3095 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3100 /* All we have to do now is to check on the final closing brace. */
3102 while (isspace(*s)) s++;
3103 if (*s++ == '}') goto RETURN;
3105 /* Get here if there is a bracketing failure */
3110 /* Get here for other failures */
3115 /* Update the input pointer value before returning */
3125 /*************************************************
3126 * Handle MD5 or SHA-1 computation for HMAC *
3127 *************************************************/
3129 /* These are some wrapping functions that enable the HMAC code to be a bit
3130 cleaner. A good compiler will spot the tail recursion.
3133 type HMAC_MD5 or HMAC_SHA1
3134 remaining are as for the cryptographic hash functions
3140 chash_start(int type, void *base)
3142 if (type == HMAC_MD5)
3143 md5_start((md5 *)base);
3145 sha1_start((sha1 *)base);
3149 chash_mid(int type, void *base, uschar *string)
3151 if (type == HMAC_MD5)
3152 md5_mid((md5 *)base, string);
3154 sha1_mid((sha1 *)base, string);
3158 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3160 if (type == HMAC_MD5)
3161 md5_end((md5 *)base, string, length, digest);
3163 sha1_end((sha1 *)base, string, length, digest);
3170 /********************************************************
3171 * prvs: Get last three digits of days since Jan 1, 1970 *
3172 ********************************************************/
3174 /* This is needed to implement the "prvs" BATV reverse
3177 Argument: integer "days" offset to add or substract to
3178 or from the current number of days.
3180 Returns: pointer to string containing the last three
3181 digits of the number of days since Jan 1, 1970,
3182 modified by the offset argument, NULL if there
3183 was an error in the conversion.
3188 prvs_daystamp(int day_offset)
3190 uschar *days = store_get(32); /* Need at least 24 for cases */
3191 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3192 (time(NULL) + day_offset*86400)/86400);
3193 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3198 /********************************************************
3199 * prvs: perform HMAC-SHA1 computation of prvs bits *
3200 ********************************************************/
3202 /* This is needed to implement the "prvs" BATV reverse
3206 address RFC2821 Address to use
3207 key The key to use (must be less than 64 characters
3209 key_num Single-digit key number to use. Defaults to
3212 Returns: pointer to string containing the first three
3213 bytes of the final hash in hex format, NULL if
3214 there was an error in the process.
3218 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3220 uschar *hash_source, *p;
3221 int size = 0,offset = 0,i;
3223 void *use_base = &sha1_base;
3224 uschar innerhash[20];
3225 uschar finalhash[20];
3226 uschar innerkey[64];
3227 uschar outerkey[64];
3228 uschar *finalhash_hex = store_get(40);
3230 if (key_num == NULL)
3233 if (Ustrlen(key) > 64)
3236 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3237 string_cat(hash_source,&size,&offset,daystamp,3);
3238 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3239 hash_source[offset] = '\0';
3241 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3243 memset(innerkey, 0x36, 64);
3244 memset(outerkey, 0x5c, 64);
3246 for (i = 0; i < Ustrlen(key); i++)
3248 innerkey[i] ^= key[i];
3249 outerkey[i] ^= key[i];
3252 chash_start(HMAC_SHA1, use_base);
3253 chash_mid(HMAC_SHA1, use_base, innerkey);
3254 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3256 chash_start(HMAC_SHA1, use_base);
3257 chash_mid(HMAC_SHA1, use_base, outerkey);
3258 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3261 for (i = 0; i < 3; i++)
3263 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3264 *p++ = hex_digits[finalhash[i] & 0x0f];
3268 return finalhash_hex;
3274 /*************************************************
3275 * Join a file onto the output string *
3276 *************************************************/
3278 /* This is used for readfile and after a run expansion. It joins the contents
3279 of a file onto the output string, globally replacing newlines with a given
3280 string (optionally). The file is closed at the end.
3284 yield pointer to the expandable string
3285 sizep pointer to the current size
3286 ptrp pointer to the current position
3287 eol newline replacement string, or NULL
3289 Returns: new value of string pointer
3293 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3296 uschar buffer[1024];
3298 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3300 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3302 int len = Ustrlen(buffer);
3303 if (eol != NULL && buffer[len-1] == '\n') len--;
3304 yield = string_cat(yield, sizep, ptrp, buffer, len);
3305 if (buffer[len] != 0)
3306 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3309 if (yield != NULL) yield[*ptrp] = 0;
3317 /*************************************************
3318 * Evaluate numeric expression *
3319 *************************************************/
3321 /* This is a set of mutually recursive functions that evaluate an arithmetic
3322 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3323 these functions that is called from elsewhere is eval_expr, whose interface is:
3326 sptr pointer to the pointer to the string - gets updated
3327 decimal TRUE if numbers are to be assumed decimal
3328 error pointer to where to put an error message - must be NULL on input
3329 endket TRUE if ')' must terminate - FALSE for external call
3331 Returns: on success: the value of the expression, with *error still NULL
3332 on failure: an undefined value, with *error = a message
3335 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3338 static int_eximarith_t
3339 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3342 int_eximarith_t x = eval_op_or(&s, decimal, error);
3348 *error = US"expecting closing parenthesis";
3350 while (isspace(*(++s)));
3352 else if (*s != 0) *error = US"expecting operator";
3359 static int_eximarith_t
3360 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3365 while (isspace(*s)) s++;
3370 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3372 switch (tolower(*s))
3375 case 'k': n *= 1024; s++; break;
3376 case 'm': n *= 1024*1024; s++; break;
3377 case 'g': n *= 1024*1024*1024; s++; break;
3379 while (isspace (*s)) s++;
3384 n = eval_expr(&s, decimal, error, 1);
3388 *error = US"expecting number or opening parenthesis";
3396 static int_eximarith_t
3397 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3401 while (isspace(*s)) s++;
3402 if (*s == '+' || *s == '-' || *s == '~')
3405 x = eval_op_unary(&s, decimal, error);
3406 if (op == '-') x = -x;
3407 else if (op == '~') x = ~x;
3411 x = eval_number(&s, decimal, error);
3418 static int_eximarith_t
3419 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3422 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3425 while (*s == '*' || *s == '/' || *s == '%')
3428 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3429 if (*error != NULL) break;
3430 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3431 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3432 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3433 * -N*M is INT_MIN will yielf INT_MIN.
3434 * Since we don't support floating point, this is somewhat simpler.
3435 * Ideally, we'd return an error, but since we overflow for all other
3436 * arithmetic, consistency suggests otherwise, but what's the correct value
3437 * to use? There is none.
3438 * The C standard guarantees overflow for unsigned arithmetic but signed
3439 * overflow invokes undefined behaviour; in practice, this is overflow
3440 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3441 * that long/longlong larger than int are available, or we could just work
3442 * with larger types. We should consider whether to guarantee 32bit eval
3443 * and 64-bit working variables, with errors returned. For now ...
3444 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3445 * can just let the other invalid results occur otherwise, as they have
3446 * until now. For this one case, we can coerce.
3448 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3451 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3452 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3462 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3478 static int_eximarith_t
3479 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3482 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3485 while (*s == '+' || *s == '-')
3488 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3489 if (*error != NULL) break;
3490 if (op == '+') x += y; else x -= y;
3498 static int_eximarith_t
3499 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3502 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3505 while ((*s == '<' || *s == '>') && s[1] == s[0])
3510 y = eval_op_sum(&s, decimal, error);
3511 if (*error != NULL) break;
3512 if (op == '<') x <<= y; else x >>= y;
3520 static int_eximarith_t
3521 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3524 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3531 y = eval_op_shift(&s, decimal, error);
3532 if (*error != NULL) break;
3541 static int_eximarith_t
3542 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3545 int_eximarith_t x = eval_op_and(&s, decimal, error);
3552 y = eval_op_and(&s, decimal, error);
3553 if (*error != NULL) break;
3562 static int_eximarith_t
3563 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3566 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3573 y = eval_op_xor(&s, decimal, error);
3574 if (*error != NULL) break;
3584 /*************************************************
3586 *************************************************/
3588 /* Returns either an unchanged string, or the expanded string in stacking pool
3589 store. Interpreted sequences are:
3591 \... normal escaping rules
3592 $name substitutes the variable
3594 ${op:string} operates on the expanded string value
3595 ${item{arg1}{arg2}...} expands the args and then does the business
3596 some literal args are not enclosed in {}
3598 There are now far too many operators and item types to make it worth listing
3599 them here in detail any more.
3601 We use an internal routine recursively to handle embedded substrings. The
3602 external function follows. The yield is NULL if the expansion failed, and there
3603 are two cases: if something collapsed syntactically, or if "fail" was given
3604 as the action on a lookup failure. These can be distinguised by looking at the
3605 variable expand_string_forcedfail, which is TRUE in the latter case.
3607 The skipping flag is set true when expanding a substring that isn't actually
3608 going to be used (after "if" or "lookup") and it prevents lookups from
3609 happening lower down.
3611 Store usage: At start, a store block of the length of the input plus 64
3612 is obtained. This is expanded as necessary by string_cat(), which might have to
3613 get a new block, or might be able to expand the original. At the end of the
3614 function we can release any store above that portion of the yield block that
3615 was actually used. In many cases this will be optimal.
3617 However: if the first item in the expansion is a variable name or header name,
3618 we reset the store before processing it; if the result is in fresh store, we
3619 use that without copying. This is helpful for expanding strings like
3620 $message_headers which can get very long.
3622 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3623 since resetting the store at the end of the expansion will free store that was
3624 allocated by the plugin code as well as the slop after the expanded string. So
3625 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3626 and, given the acl condition, ${if }. This is an unfortunate consequence of
3627 string expansion becoming too powerful.
3630 string the string to be expanded
3631 ket_ends true if expansion is to stop at }
3632 left if not NULL, a pointer to the first character after the
3633 expansion is placed here (typically used with ket_ends)
3634 skipping TRUE for recursive calls when the value isn't actually going
3635 to be used (to allow for optimisation)
3636 honour_dollar TRUE if $ is to be expanded,
3637 FALSE if it's just another character
3638 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3641 Returns: NULL if expansion fails:
3642 expand_string_forcedfail is set TRUE if failure was forced
3643 expand_string_message contains a textual error message
3644 a pointer to the expanded string on success
3648 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3649 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3652 int size = Ustrlen(string)+ 64;
3654 uschar *yield = store_get(size);
3656 uschar *save_expand_nstring[EXPAND_MAXN+1];
3657 int save_expand_nlength[EXPAND_MAXN+1];
3658 BOOL resetok = TRUE;
3660 expand_string_forcedfail = FALSE;
3661 expand_string_message = US"";
3668 /* \ escapes the next character, which must exist, or else
3669 the expansion fails. There's a special escape, \N, which causes
3670 copying of the subject verbatim up to the next \N. Otherwise,
3671 the escapes are the standard set. */
3677 expand_string_message = US"\\ at end of string";
3684 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3685 yield = string_cat(yield, &size, &ptr, t, s - t);
3686 if (*s != 0) s += 2;
3692 ch[0] = string_interpret_escape(&s);
3694 yield = string_cat(yield, &size, &ptr, ch, 1);
3701 /* Anything other than $ is just copied verbatim, unless we are
3702 looking for a terminating } character. */
3705 if (ket_ends && *s == '}') break;
3707 if (*s != '$' || !honour_dollar)
3709 yield = string_cat(yield, &size, &ptr, s++, 1);
3713 /* No { after the $ - must be a plain name or a number for string
3714 match variable. There has to be a fudge for variables that are the
3715 names of header fields preceded by "$header_" because header field
3716 names can contain any printing characters except space and colon.
3717 For those that don't like typing this much, "$h_" is a synonym for
3718 "$header_". A non-existent header yields a NULL value; nothing is
3721 if (isalpha((*(++s))))
3726 s = read_name(name, sizeof(name), s, US"_");
3728 /* If this is the first thing to be expanded, release the pre-allocated
3731 if (ptr == 0 && yield != NULL)
3733 if (resetok) store_reset(yield);
3740 if (Ustrncmp(name, "h_", 2) == 0 ||
3741 Ustrncmp(name, "rh_", 3) == 0 ||
3742 Ustrncmp(name, "bh_", 3) == 0 ||
3743 Ustrncmp(name, "header_", 7) == 0 ||
3744 Ustrncmp(name, "rheader_", 8) == 0 ||
3745 Ustrncmp(name, "bheader_", 8) == 0)
3747 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3748 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3749 s = read_header_name(name, sizeof(name), s);
3750 value = find_header(name, FALSE, &newsize, want_raw, charset);
3752 /* If we didn't find the header, and the header contains a closing brace
3753 character, this may be a user error where the terminating colon
3754 has been omitted. Set a flag to adjust the error message in this case.
3755 But there is no error here - nothing gets inserted. */
3759 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3768 value = find_variable(name, FALSE, skipping, &newsize);
3771 expand_string_message =
3772 string_sprintf("unknown variable name \"%s\"", name);
3773 check_variable_error_message(name);
3778 /* If the data is known to be in a new buffer, newsize will be set to the
3779 size of that buffer. If this is the first thing in an expansion string,
3780 yield will be NULL; just point it at the new store instead of copying. Many
3781 expansion strings contain just one reference, so this is a useful
3782 optimization, especially for humungous headers. */
3784 len = Ustrlen(value);
3785 if (yield == NULL && newsize != 0)
3791 else yield = string_cat(yield, &size, &ptr, value, len);
3799 s = read_number(&n, s);
3800 if (n >= 0 && n <= expand_nmax)
3801 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3806 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3808 if (*s != '{') /*}*/
3810 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3814 /* After { there can be various things, but they all start with
3815 an initial word, except for a number for a string match variable. */
3817 if (isdigit((*(++s))))
3820 s = read_number(&n, s); /*{*/
3823 expand_string_message = US"} expected after number";
3826 if (n >= 0 && n <= expand_nmax)
3827 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3834 expand_string_message = US"letter or digit expected after ${"; /*}*/
3838 /* Allow "-" in names to cater for substrings with negative
3839 arguments. Since we are checking for known names after { this is
3842 s = read_name(name, sizeof(name), s, US"_-");
3843 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3847 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3848 If the ACL returns accept or reject we return content set by "message ="
3849 There is currently no limit on recursion; this would have us call
3850 acl_check_internal() directly and get a current level from somewhere.
3851 See also the acl expansion condition ECOND_ACL and the traditional
3852 acl modifier ACLC_ACL.
3853 Assume that the function has side-effects on the store that must be preserved.
3857 /* ${acl {name} {arg1}{arg2}...} */
3859 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3862 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
3864 case 1: goto EXPAND_FAILED_CURLY;
3866 case 3: goto EXPAND_FAILED;
3868 if (skipping) continue;
3871 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3876 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3880 expand_string_forcedfail = TRUE;
3882 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3887 /* Handle conditionals - preserve the values of the numerical expansion
3888 variables in case they get changed by a regular expression match in the
3889 condition. If not, they retain their external settings. At the end
3890 of this "if" section, they get restored to their previous values. */
3896 int save_expand_nmax =
3897 save_expand_strings(save_expand_nstring, save_expand_nlength);
3899 while (isspace(*s)) s++;
3900 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
3901 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3904 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3905 cond? "true" : "false");
3909 /* The handling of "yes" and "no" result strings is now in a separate
3910 function that is also used by ${lookup} and ${extract} and ${run}. */
3912 switch(process_yesno(
3913 skipping, /* were previously skipping */
3914 cond, /* success/failure indicator */
3915 lookup_value, /* value to reset for string2 */
3916 &s, /* input pointer */
3917 &yield, /* output pointer */
3918 &size, /* output size */
3919 &ptr, /* output current point */
3920 US"if", /* condition type */
3923 case 1: goto EXPAND_FAILED; /* when all is well, the */
3924 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3927 /* Restore external setting of expansion variables for continuation
3930 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3931 save_expand_nlength);
3935 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3936 expanding an internal string that isn't actually going to be used. All we
3937 need to do is check the syntax, so don't do a lookup at all. Preserve the
3938 values of the numerical expansion variables in case they get changed by a
3939 partial lookup. If not, they retain their external settings. At the end
3940 of this "lookup" section, they get restored to their previous values. */
3944 int stype, partial, affixlen, starflags;
3945 int expand_setup = 0;
3947 uschar *key, *filename, *affix;
3948 uschar *save_lookup_value = lookup_value;
3949 int save_expand_nmax =
3950 save_expand_strings(save_expand_nstring, save_expand_nlength);
3952 if ((expand_forbid & RDO_LOOKUP) != 0)
3954 expand_string_message = US"lookup expansions are not permitted";
3958 /* Get the key we are to look up for single-key+file style lookups.
3959 Otherwise set the key NULL pro-tem. */
3961 while (isspace(*s)) s++;
3962 if (*s == '{') /*}*/
3964 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
3965 if (key == NULL) goto EXPAND_FAILED; /*{*/
3966 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3967 while (isspace(*s)) s++;
3971 /* Find out the type of database */
3975 expand_string_message = US"missing lookup type";
3979 /* The type is a string that may contain special characters of various
3980 kinds. Allow everything except space or { to appear; the actual content
3981 is checked by search_findtype_partial. */ /*}*/
3983 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
3985 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3989 while (isspace(*s)) s++;
3991 /* Now check for the individual search type and any partial or default
3992 options. Only those types that are actually in the binary are valid. */
3994 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3998 expand_string_message = search_error_message;
4002 /* Check that a key was provided for those lookup types that need it,
4003 and was not supplied for those that use the query style. */
4005 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4009 expand_string_message = string_sprintf("missing {key} for single-"
4010 "key \"%s\" lookup", name);
4018 expand_string_message = string_sprintf("a single key was given for "
4019 "lookup type \"%s\", which is not a single-key lookup type", name);
4024 /* Get the next string in brackets and expand it. It is the file name for
4025 single-key+file lookups, and the whole query otherwise. In the case of
4026 queries that also require a file name (e.g. sqlite), the file name comes
4029 if (*s != '{') goto EXPAND_FAILED_CURLY;
4030 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4031 if (filename == NULL) goto EXPAND_FAILED;
4032 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4033 while (isspace(*s)) s++;
4035 /* If this isn't a single-key+file lookup, re-arrange the variables
4036 to be appropriate for the search_ functions. For query-style lookups,
4037 there is just a "key", and no file name. For the special query-style +
4038 file types, the query (i.e. "key") starts with a file name. */
4042 while (isspace(*filename)) filename++;
4045 if (mac_islookup(stype, lookup_querystyle))
4051 if (*filename != '/')
4053 expand_string_message = string_sprintf(
4054 "absolute file name expected for \"%s\" lookup", name);
4057 while (*key != 0 && !isspace(*key)) key++;
4058 if (*key != 0) *key++ = 0;
4062 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4063 the entry was not found. Note that there is no search_close() function.
4064 Files are left open in case of re-use. At suitable places in higher logic,
4065 search_tidyup() is called to tidy all open files. This can save opening
4066 the same file several times. However, files may also get closed when
4067 others are opened, if too many are open at once. The rule is that a
4068 handle should not be used after a second search_open().
4070 Request that a partial search sets up $1 and maybe $2 by passing
4071 expand_setup containing zero. If its value changes, reset expand_nmax,
4072 since new variables will have been set. Note that at the end of this
4073 "lookup" section, the old numeric variables are restored. */
4076 lookup_value = NULL;
4079 void *handle = search_open(filename, stype, 0, NULL, NULL);
4082 expand_string_message = search_error_message;
4085 lookup_value = search_find(handle, filename, key, partial, affix,
4086 affixlen, starflags, &expand_setup);
4087 if (search_find_defer)
4089 expand_string_message =
4090 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4091 string_printing2(key, FALSE), search_error_message);
4094 if (expand_setup > 0) expand_nmax = expand_setup;
4097 /* The handling of "yes" and "no" result strings is now in a separate
4098 function that is also used by ${if} and ${extract}. */
4100 switch(process_yesno(
4101 skipping, /* were previously skipping */
4102 lookup_value != NULL, /* success/failure indicator */
4103 save_lookup_value, /* value to reset for string2 */
4104 &s, /* input pointer */
4105 &yield, /* output pointer */
4106 &size, /* output size */
4107 &ptr, /* output current point */
4108 US"lookup", /* condition type */
4111 case 1: goto EXPAND_FAILED; /* when all is well, the */
4112 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4115 /* Restore external setting of expansion variables for carrying on
4116 at this level, and continue. */
4118 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4119 save_expand_nlength);
4123 /* If Perl support is configured, handle calling embedded perl subroutines,
4124 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4125 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4126 arguments (defined below). */
4128 #define EXIM_PERL_MAX_ARGS 8
4132 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4133 "is not included in this binary";
4136 #else /* EXIM_PERL */
4138 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4141 if ((expand_forbid & RDO_PERL) != 0)
4143 expand_string_message = US"Perl calls are not permitted";
4147 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4148 US"perl", &resetok))
4150 case 1: goto EXPAND_FAILED_CURLY;
4152 case 3: goto EXPAND_FAILED;
4155 /* If skipping, we don't actually do anything */
4157 if (skipping) continue;
4159 /* Start the interpreter if necessary */
4161 if (!opt_perl_started)
4164 if (opt_perl_startup == NULL)
4166 expand_string_message = US"A setting of perl_startup is needed when "
4167 "using the Perl interpreter";
4170 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4171 initerror = init_perl(opt_perl_startup);
4172 if (initerror != NULL)
4174 expand_string_message =
4175 string_sprintf("error in perl_startup code: %s\n", initerror);
4178 opt_perl_started = TRUE;
4181 /* Call the function */
4183 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4184 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4185 sub_arg[0], sub_arg + 1);
4187 /* NULL yield indicates failure; if the message pointer has been set to
4188 NULL, the yield was undef, indicating a forced failure. Otherwise the
4189 message will indicate some kind of Perl error. */
4191 if (new_yield == NULL)
4193 if (expand_string_message == NULL)
4195 expand_string_message =
4196 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4197 "failure", sub_arg[0]);
4198 expand_string_forcedfail = TRUE;
4203 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4204 set during a callback from Perl. */
4206 expand_string_forcedfail = FALSE;
4210 #endif /* EXIM_PERL */
4212 /* Transform email address to "prvs" scheme to use
4213 as BATV-signed return path */
4220 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4222 case 1: goto EXPAND_FAILED_CURLY;
4224 case 3: goto EXPAND_FAILED;
4227 /* If skipping, we don't actually do anything */
4228 if (skipping) continue;
4230 /* sub_arg[0] is the address */
4231 domain = Ustrrchr(sub_arg[0],'@');
4232 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4234 expand_string_message = US"prvs first argument must be a qualified email address";
4238 /* Calculate the hash. The second argument must be a single-digit
4239 key number, or unset. */
4241 if (sub_arg[2] != NULL &&
4242 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4244 expand_string_message = US"prvs second argument must be a single digit";
4248 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4251 expand_string_message = US"prvs hmac-sha1 conversion failed";
4255 /* Now separate the domain from the local part */
4258 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4259 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4260 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4261 string_cat(yield,&size,&ptr,p,6);
4262 string_cat(yield,&size,&ptr,US"=",1);
4263 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4264 string_cat(yield,&size,&ptr,US"@",1);
4265 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4270 /* Check a prvs-encoded address for validity */
4272 case EITEM_PRVSCHECK:
4275 int mysize = 0, myptr = 0;
4279 /* TF: Ugliness: We want to expand parameter 1 first, then set
4280 up expansion variables that are used in the expansion of
4281 parameter 2. So we clone the string for the first
4282 expansion, where we only expand parameter 1.
4284 PH: Actually, that isn't necessary. The read_subs() function is
4285 designed to work this way for the ${if and ${lookup expansions. I've
4289 /* Reset expansion variables */
4290 prvscheck_result = NULL;
4291 prvscheck_address = NULL;
4292 prvscheck_keynum = NULL;
4294 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4296 case 1: goto EXPAND_FAILED_CURLY;
4298 case 3: goto EXPAND_FAILED;
4301 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4304 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4306 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4307 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4308 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4309 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4310 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4312 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4313 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4314 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4315 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4316 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4318 /* Set up expansion variables */
4319 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4320 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4321 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4322 prvscheck_address[myptr] = '\0';
4323 prvscheck_keynum = string_copy(key_num);
4325 /* Now expand the second argument */
4326 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4328 case 1: goto EXPAND_FAILED_CURLY;
4330 case 3: goto EXPAND_FAILED;
4333 /* Now we have the key and can check the address. */
4335 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4340 expand_string_message = US"hmac-sha1 conversion failed";
4344 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4345 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4347 if (Ustrcmp(p,hash) == 0)
4349 /* Success, valid BATV address. Now check the expiry date. */
4350 uschar *now = prvs_daystamp(0);
4351 unsigned int inow = 0,iexpire = 1;
4353 (void)sscanf(CS now,"%u",&inow);
4354 (void)sscanf(CS daystamp,"%u",&iexpire);
4356 /* When "iexpire" is < 7, a "flip" has occured.
4357 Adjust "inow" accordingly. */
4358 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4360 if (iexpire >= inow)
4362 prvscheck_result = US"1";
4363 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4367 prvscheck_result = NULL;
4368 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4373 prvscheck_result = NULL;
4374 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4377 /* Now expand the final argument. We leave this till now so that
4378 it can include $prvscheck_result. */
4380 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4382 case 1: goto EXPAND_FAILED_CURLY;
4384 case 3: goto EXPAND_FAILED;
4387 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4388 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4390 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4392 /* Reset the "internal" variables afterwards, because they are in
4393 dynamic store that will be reclaimed if the expansion succeeded. */
4395 prvscheck_address = NULL;
4396 prvscheck_keynum = NULL;
4400 /* Does not look like a prvs encoded address, return the empty string.
4401 We need to make sure all subs are expanded first, so as to skip over
4404 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4406 case 1: goto EXPAND_FAILED_CURLY;
4408 case 3: goto EXPAND_FAILED;
4415 /* Handle "readfile" to insert an entire file */
4417 case EITEM_READFILE:
4422 if ((expand_forbid & RDO_READFILE) != 0)
4424 expand_string_message = US"file insertions are not permitted";
4428 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4430 case 1: goto EXPAND_FAILED_CURLY;
4432 case 3: goto EXPAND_FAILED;
4435 /* If skipping, we don't actually do anything */
4437 if (skipping) continue;
4439 /* Open the file and read it */
4441 f = Ufopen(sub_arg[0], "rb");
4444 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4448 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4453 /* Handle "readsocket" to insert data from a Unix domain socket */
4455 case EITEM_READSOCK:
4461 struct sockaddr_un sockun; /* don't call this "sun" ! */
4465 if ((expand_forbid & RDO_READSOCK) != 0)
4467 expand_string_message = US"socket insertions are not permitted";
4471 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4472 because there may be a string for expansion on failure. */
4474 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4476 case 1: goto EXPAND_FAILED_CURLY;
4477 case 2: /* Won't occur: no end check */
4478 case 3: goto EXPAND_FAILED;
4481 /* Sort out timeout, if given */
4483 if (sub_arg[2] != NULL)
4485 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4488 expand_string_message = string_sprintf("bad time value %s",
4493 else sub_arg[3] = NULL; /* No eol if no timeout */
4495 /* If skipping, we don't actually do anything. Otherwise, arrange to
4496 connect to either an IP or a Unix socket. */
4500 /* Handle an IP (internet) domain */
4502 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4505 uschar *server_name = sub_arg[0] + 5;
4506 uschar *port_name = Ustrrchr(server_name, ':');
4508 /* Sort out the port */
4510 if (port_name == NULL)
4512 expand_string_message =
4513 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4516 *port_name++ = 0; /* Terminate server name */
4518 if (isdigit(*port_name))
4521 port = Ustrtol(port_name, &end, 0);
4522 if (end != port_name + Ustrlen(port_name))
4524 expand_string_message =
4525 string_sprintf("invalid port number %s", port_name);
4531 struct servent *service_info = getservbyname(CS port_name, "tcp");
4532 if (service_info == NULL)
4534 expand_string_message = string_sprintf("unknown port \"%s\"",
4538 port = ntohs(service_info->s_port);
4541 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4542 timeout, NULL, &expand_string_message)) < 0)
4546 /* Handle a Unix domain socket */
4551 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4553 expand_string_message = string_sprintf("failed to create socket: %s",
4558 sockun.sun_family = AF_UNIX;
4559 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4562 sigalrm_seen = FALSE;
4564 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4568 expand_string_message = US "socket connect timed out";
4573 expand_string_message = string_sprintf("failed to connect to socket "
4574 "%s: %s", sub_arg[0], strerror(errno));
4579 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4581 /* Write the request string, if not empty */
4583 if (sub_arg[1][0] != 0)
4585 int len = Ustrlen(sub_arg[1]);
4586 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4588 if (write(fd, sub_arg[1], len) != len)
4590 expand_string_message = string_sprintf("request write to socket "
4591 "failed: %s", strerror(errno));
4596 /* Shut down the sending side of the socket. This helps some servers to
4597 recognise that it is their turn to do some work. Just in case some
4598 system doesn't have this function, make it conditional. */
4601 shutdown(fd, SHUT_WR);
4604 /* Now we need to read from the socket, under a timeout. The function
4605 that reads a file can be used. */
4607 f = fdopen(fd, "rb");
4608 sigalrm_seen = FALSE;
4610 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4614 /* After a timeout, we restore the pointer in the result, that is,
4615 make sure we add nothing from the socket. */
4620 expand_string_message = US "socket read timed out";
4625 /* The whole thing has worked (or we were skipping). If there is a
4626 failure string following, we need to skip it. */
4630 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4632 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4633 while (isspace(*s)) s++;
4635 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4638 /* Come here on failure to create socket, connect socket, write to the
4639 socket, or timeout on reading. If another substring follows, expand and
4640 use it. Otherwise, those conditions give expand errors. */
4643 if (*s != '{') goto EXPAND_FAILED;
4644 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4645 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4646 if (arg == NULL) goto EXPAND_FAILED;
4647 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4648 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4649 while (isspace(*s)) s++;
4650 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4654 /* Handle "run" to execute a program. */
4666 if ((expand_forbid & RDO_RUN) != 0)
4668 expand_string_message = US"running a command is not permitted";
4672 while (isspace(*s)) s++;
4673 if (*s != '{') goto EXPAND_FAILED_CURLY;
4674 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4675 if (arg == NULL) goto EXPAND_FAILED;
4676 while (isspace(*s)) s++;
4677 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4679 if (skipping) /* Just pretend it worked when we're skipping */
4685 if (!transport_set_up_command(&argv, /* anchor for arg list */
4686 arg, /* raw command */
4687 FALSE, /* don't expand the arguments */
4688 0, /* not relevant when... */
4689 NULL, /* no transporting address */
4690 US"${run} expansion", /* for error messages */
4691 &expand_string_message)) /* where to put error message */
4696 /* Create the child process, making it a group leader. */
4698 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4702 expand_string_message =
4703 string_sprintf("couldn't create child process: %s", strerror(errno));
4707 /* Nothing is written to the standard input. */
4711 /* Read the pipe to get the command's output into $value (which is kept
4712 in lookup_value). Read during execution, so that if the output exceeds
4713 the OS pipe buffer limit, we don't block forever. */
4715 f = fdopen(fd_out, "rb");
4716 sigalrm_seen = FALSE;
4718 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4722 /* Wait for the process to finish, applying the timeout, and inspect its
4723 return code for serious disasters. Simple non-zero returns are passed on.
4726 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4728 if (sigalrm_seen == TRUE || runrc == -256)
4730 expand_string_message = string_sprintf("command timed out");
4731 killpg(pid, SIGKILL); /* Kill the whole process group */
4734 else if (runrc == -257)
4735 expand_string_message = string_sprintf("wait() failed: %s",
4739 expand_string_message = string_sprintf("command killed by signal %d",
4746 /* Process the yes/no strings; $value may be useful in both cases */
4748 switch(process_yesno(
4749 skipping, /* were previously skipping */
4750 runrc == 0, /* success/failure indicator */
4751 lookup_value, /* value to reset for string2 */
4752 &s, /* input pointer */
4753 &yield, /* output pointer */
4754 &size, /* output size */
4755 &ptr, /* output current point */
4756 US"run", /* condition type */
4759 case 1: goto EXPAND_FAILED; /* when all is well, the */
4760 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4766 /* Handle character translation for "tr" */
4774 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4776 case 1: goto EXPAND_FAILED_CURLY;
4778 case 3: goto EXPAND_FAILED;
4781 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4782 o2m = Ustrlen(sub[2]) - 1;
4784 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4786 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4790 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4797 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4798 expanded arguments. */
4808 int val[2] = { 0, -1 };
4811 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4812 Ensure that sub[2] is set in the ${length } case. */
4815 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4816 TRUE, name, &resetok))
4818 case 1: goto EXPAND_FAILED_CURLY;
4820 case 3: goto EXPAND_FAILED;
4823 /* Juggle the arguments if there are only two of them: always move the
4824 string to the last position and make ${length{n}{str}} equivalent to
4825 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4831 if (item_type == EITEM_LENGTH)
4838 for (i = 0; i < 2; i++)
4840 if (sub[i] == NULL) continue;
4841 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4842 if (*ret != 0 || (i != 0 && val[i] < 0))
4844 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4845 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4851 (item_type == EITEM_HASH)?
4852 compute_hash(sub[2], val[0], val[1], &len) :
4853 (item_type == EITEM_NHASH)?
4854 compute_nhash(sub[2], val[0], val[1], &len) :
4855 extract_substr(sub[2], val[0], val[1], &len);
4857 if (ret == NULL) goto EXPAND_FAILED;
4858 yield = string_cat(yield, &size, &ptr, ret, len);
4862 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4863 This code originally contributed by Steve Haslam. It currently supports
4864 the use of MD5 and SHA-1 hashes.
4866 We need some workspace that is large enough to handle all the supported
4867 hash types. Use macros to set the sizes rather than be too elaborate. */
4869 #define MAX_HASHLEN 20
4870 #define MAX_HASHBLOCKLEN 64
4879 int hashlen; /* Number of octets for the hash algorithm's output */
4880 int hashblocklen; /* Number of octets the hash algorithm processes */
4882 unsigned int keylen;
4884 uschar keyhash[MAX_HASHLEN];
4885 uschar innerhash[MAX_HASHLEN];
4886 uschar finalhash[MAX_HASHLEN];
4887 uschar finalhash_hex[2*MAX_HASHLEN];
4888 uschar innerkey[MAX_HASHBLOCKLEN];
4889 uschar outerkey[MAX_HASHBLOCKLEN];
4891 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
4893 case 1: goto EXPAND_FAILED_CURLY;
4895 case 3: goto EXPAND_FAILED;
4898 if (Ustrcmp(sub[0], "md5") == 0)
4901 use_base = &md5_base;
4905 else if (Ustrcmp(sub[0], "sha1") == 0)
4908 use_base = &sha1_base;
4914 expand_string_message =
4915 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4920 keylen = Ustrlen(keyptr);
4922 /* If the key is longer than the hash block length, then hash the key
4925 if (keylen > hashblocklen)
4927 chash_start(type, use_base);
4928 chash_end(type, use_base, keyptr, keylen, keyhash);
4933 /* Now make the inner and outer key values */
4935 memset(innerkey, 0x36, hashblocklen);
4936 memset(outerkey, 0x5c, hashblocklen);
4938 for (i = 0; i < keylen; i++)
4940 innerkey[i] ^= keyptr[i];
4941 outerkey[i] ^= keyptr[i];
4944 /* Now do the hashes */
4946 chash_start(type, use_base);
4947 chash_mid(type, use_base, innerkey);
4948 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4950 chash_start(type, use_base);
4951 chash_mid(type, use_base, outerkey);
4952 chash_end(type, use_base, innerhash, hashlen, finalhash);
4954 /* Encode the final hash as a hex string */
4957 for (i = 0; i < hashlen; i++)
4959 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4960 *p++ = hex_digits[finalhash[i] & 0x0f];
4963 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4964 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4966 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4971 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4972 We have to save the numerical variables and restore them afterwards. */
4977 int moffset, moffsetextra, slen;
4980 const uschar *rerror;
4983 int save_expand_nmax =
4984 save_expand_strings(save_expand_nstring, save_expand_nlength);
4986 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
4988 case 1: goto EXPAND_FAILED_CURLY;
4990 case 3: goto EXPAND_FAILED;
4993 /* Compile the regular expression */
4995 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5000 expand_string_message = string_sprintf("regular expression error in "
5001 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5005 /* Now run a loop to do the substitutions as often as necessary. It ends
5006 when there are no more matches. Take care over matches of the null string;
5007 do the same thing as Perl does. */
5010 slen = Ustrlen(sub[0]);
5011 moffset = moffsetextra = 0;
5016 int ovector[3*(EXPAND_MAXN+1)];
5017 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5018 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5022 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5023 is not necessarily the end. We want to repeat the match from one
5024 character further along, but leaving the basic offset the same (for
5025 copying below). We can't be at the end of the string - that was checked
5026 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5027 finished; copy the remaining string and end the loop. */
5037 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5041 /* Match - set up for expanding the replacement. */
5043 if (n == 0) n = EXPAND_MAXN + 1;
5045 for (nn = 0; nn < n*2; nn += 2)
5047 expand_nstring[expand_nmax] = subject + ovector[nn];
5048 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5052 /* Copy the characters before the match, plus the expanded insertion. */
5054 yield = string_cat(yield, &size, &ptr, subject + moffset,
5055 ovector[0] - moffset);
5056 insert = expand_string(sub[2]);
5057 if (insert == NULL) goto EXPAND_FAILED;
5058 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5060 moffset = ovector[1];
5064 /* If we have matched an empty string, first check to see if we are at
5065 the end of the subject. If so, the loop is over. Otherwise, mimic
5066 what Perl's /g options does. This turns out to be rather cunning. First
5067 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5068 string at the same point. If this fails (picked up above) we advance to
5069 the next character. */
5071 if (ovector[0] == ovector[1])
5073 if (ovector[0] == slen) break;
5074 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5078 /* All done - restore numerical variables. */
5080 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5081 save_expand_nlength);
5085 /* Handle keyed and numbered substring extraction. If the first argument
5086 consists entirely of digits, then a numerical extraction is assumed. */
5092 int field_number = 1;
5093 BOOL field_number_set = FALSE;
5094 uschar *save_lookup_value = lookup_value;
5096 int save_expand_nmax =
5097 save_expand_strings(save_expand_nstring, save_expand_nlength);
5099 /* Read the arguments */
5101 for (i = 0; i < j; i++)
5103 while (isspace(*s)) s++;
5104 if (*s == '{') /*}*/
5106 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5107 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5108 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5110 /* After removal of leading and trailing white space, the first
5111 argument must not be empty; if it consists entirely of digits
5112 (optionally preceded by a minus sign), this is a numerical
5113 extraction, and we expect 3 arguments. */
5121 while (isspace(*p)) p++;
5125 while (len > 0 && isspace(p[len-1])) len--;
5128 if (*p == 0 && !skipping)
5130 expand_string_message = US"first argument of \"extract\" must "
5140 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5144 j = 3; /* Need 3 args */
5145 field_number_set = TRUE;
5149 else goto EXPAND_FAILED_CURLY;
5152 /* Extract either the numbered or the keyed substring into $value. If
5153 skipping, just pretend the extraction failed. */
5155 lookup_value = skipping? NULL : field_number_set?
5156 expand_gettokened(field_number, sub[1], sub[2]) :
5157 expand_getkeyed(sub[0], sub[1]);
5159 /* If no string follows, $value gets substituted; otherwise there can
5160 be yes/no strings, as for lookup or if. */
5162 switch(process_yesno(
5163 skipping, /* were previously skipping */
5164 lookup_value != NULL, /* success/failure indicator */
5165 save_lookup_value, /* value to reset for string2 */
5166 &s, /* input pointer */
5167 &yield, /* output pointer */
5168 &size, /* output size */
5169 &ptr, /* output current point */
5170 US"extract", /* condition type */
5173 case 1: goto EXPAND_FAILED; /* when all is well, the */
5174 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5177 /* All done - restore numerical variables. */
5179 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5180 save_expand_nlength);
5185 /* return the Nth item from a list */
5187 case EITEM_LISTEXTRACT:
5190 int field_number = 1;
5191 uschar *save_lookup_value = lookup_value;
5193 int save_expand_nmax =
5194 save_expand_strings(save_expand_nstring, save_expand_nlength);
5196 /* Read the field & list arguments */
5198 for (i = 0; i < 2; i++)
5200 while (isspace(*s)) s++;
5201 if (*s != '{') /*}*/
5202 goto EXPAND_FAILED_CURLY;
5204 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5205 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5206 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5208 /* After removal of leading and trailing white space, the first
5209 argument must be numeric and nonempty. */
5217 while (isspace(*p)) p++;
5221 while (len > 0 && isspace(p[len-1])) len--;
5224 if (!*p && !skipping)
5226 expand_string_message = US"first argument of \"listextract\" must "
5236 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5239 expand_string_message = US"first argument of \"listextract\" must "
5247 /* Extract the numbered element into $value. If
5248 skipping, just pretend the extraction failed. */
5250 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5252 /* If no string follows, $value gets substituted; otherwise there can
5253 be yes/no strings, as for lookup or if. */
5255 switch(process_yesno(
5256 skipping, /* were previously skipping */
5257 lookup_value != NULL, /* success/failure indicator */
5258 save_lookup_value, /* value to reset for string2 */
5259 &s, /* input pointer */
5260 &yield, /* output pointer */
5261 &size, /* output size */
5262 &ptr, /* output current point */
5263 US"extract", /* condition type */
5266 case 1: goto EXPAND_FAILED; /* when all is well, the */
5267 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5270 /* All done - restore numerical variables. */
5272 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5273 save_expand_nlength);
5278 /* Handle list operations */
5286 uschar outsep[2] = { '\0', '\0' };
5287 uschar *list, *expr, *temp;
5288 uschar *save_iterate_item = iterate_item;
5289 uschar *save_lookup_value = lookup_value;
5291 while (isspace(*s)) s++;
5292 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5294 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5295 if (list == NULL) goto EXPAND_FAILED;
5296 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5298 if (item_type == EITEM_REDUCE)
5300 while (isspace(*s)) s++;
5301 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5302 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5303 if (temp == NULL) goto EXPAND_FAILED;
5304 lookup_value = temp;
5305 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5308 while (isspace(*s)) s++;
5309 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5313 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5314 if scanning a "false" part). This allows us to find the end of the
5315 condition, because if the list is empty, we won't actually evaluate the
5316 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5317 the normal internal expansion function. */
5319 if (item_type == EITEM_FILTER)
5321 temp = eval_condition(expr, &resetok, NULL);
5322 if (temp != NULL) s = temp;
5326 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5331 expand_string_message = string_sprintf("%s inside \"%s\" item",
5332 expand_string_message, name);
5336 while (isspace(*s)) s++;
5339 expand_string_message = string_sprintf("missing } at end of condition "
5340 "or expression inside \"%s\"", name);
5344 while (isspace(*s)) s++; /*{*/
5347 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5352 /* If we are skipping, we can now just move on to the next item. When
5353 processing for real, we perform the iteration. */
5355 if (skipping) continue;
5356 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5358 *outsep = (uschar)sep; /* Separator as a string */
5360 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5362 if (item_type == EITEM_FILTER)
5365 if (eval_condition(expr, &resetok, &condresult) == NULL)
5367 iterate_item = save_iterate_item;
5368 lookup_value = save_lookup_value;
5369 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5370 expand_string_message, name);
5373 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5374 condresult? "true":"false");
5376 temp = iterate_item; /* TRUE => include this item */
5378 continue; /* FALSE => skip this item */
5381 /* EITEM_MAP and EITEM_REDUCE */
5385 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5388 iterate_item = save_iterate_item;
5389 expand_string_message = string_sprintf("%s inside \"%s\" item",
5390 expand_string_message, name);
5393 if (item_type == EITEM_REDUCE)
5395 lookup_value = temp; /* Update the value of $value */
5396 continue; /* and continue the iteration */
5400 /* We reach here for FILTER if the condition is true, always for MAP,
5401 and never for REDUCE. The value in "temp" is to be added to the output
5402 list that is being created, ensuring that any occurrences of the
5403 separator character are doubled. Unless we are dealing with the first
5404 item of the output list, add in a space if the new item begins with the
5405 separator character, or is an empty string. */
5407 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5408 yield = string_cat(yield, &size, &ptr, US" ", 1);
5410 /* Add the string in "temp" to the output list that we are building,
5411 This is done in chunks by searching for the separator character. */
5415 size_t seglen = Ustrcspn(temp, outsep);
5416 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5418 /* If we got to the end of the string we output one character
5419 too many; backup and end the loop. Otherwise arrange to double the
5422 if (temp[seglen] == '\0') { ptr--; break; }
5423 yield = string_cat(yield, &size, &ptr, outsep, 1);
5427 /* Output a separator after the string: we will remove the redundant
5428 final one at the end. */
5430 yield = string_cat(yield, &size, &ptr, outsep, 1);
5431 } /* End of iteration over the list loop */
5433 /* REDUCE has generated no output above: output the final value of
5436 if (item_type == EITEM_REDUCE)
5438 yield = string_cat(yield, &size, &ptr, lookup_value,
5439 Ustrlen(lookup_value));
5440 lookup_value = save_lookup_value; /* Restore $value */
5443 /* FILTER and MAP generate lists: if they have generated anything, remove
5444 the redundant final separator. Even though an empty item at the end of a
5445 list does not count, this is tidier. */
5447 else if (ptr != save_ptr) ptr--;
5449 /* Restore preserved $item */
5451 iterate_item = save_iterate_item;
5456 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5457 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5458 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5459 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5461 #define EXPAND_DLFUNC_MAX_ARGS 8
5464 #ifndef EXPAND_DLFUNC
5465 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5466 "is not included in this binary";
5469 #else /* EXPAND_DLFUNC */
5472 exim_dlfunc_t *func;
5475 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5477 if ((expand_forbid & RDO_DLFUNC) != 0)
5479 expand_string_message =
5480 US"dynamically-loaded functions are not permitted";
5484 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5485 TRUE, US"dlfunc", &resetok))
5487 case 1: goto EXPAND_FAILED_CURLY;
5489 case 3: goto EXPAND_FAILED;
5492 /* If skipping, we don't actually do anything */
5494 if (skipping) continue;
5496 /* Look up the dynamically loaded object handle in the tree. If it isn't
5497 found, dlopen() the file and put the handle in the tree for next time. */
5499 t = tree_search(dlobj_anchor, argv[0]);
5502 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5505 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5506 argv[0], dlerror());
5507 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5510 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5511 Ustrcpy(t->name, argv[0]);
5512 t->data.ptr = handle;
5513 (void)tree_insertnode(&dlobj_anchor, t);
5516 /* Having obtained the dynamically loaded object handle, look up the
5517 function pointer. */
5519 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5522 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5523 "%s", argv[1], argv[0], dlerror());
5524 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5528 /* Call the function and work out what to do with the result. If it
5529 returns OK, we have a replacement string; if it returns DEFER then
5530 expansion has failed in a non-forced manner; if it returns FAIL then
5531 failure was forced; if it returns ERROR or any other value there's a
5532 problem, so panic slightly. In any case, assume that the function has
5533 side-effects on the store that must be preserved. */
5537 for (argc = 0; argv[argc] != NULL; argc++);
5538 status = func(&result, argc - 2, &argv[2]);
5541 if (result == NULL) result = US"";
5542 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5547 expand_string_message = result == NULL ? US"(no message)" : result;
5548 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5549 else if(status != FAIL)
5550 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5551 argv[0], argv[1], status, expand_string_message);
5555 #endif /* EXPAND_DLFUNC */
5556 } /* EITEM_* switch */
5558 /* Control reaches here if the name is not recognized as one of the more
5559 complicated expansion items. Check for the "operator" syntax (name terminated
5560 by a colon). Some of the operators have arguments, separated by _ from the
5567 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5568 if (sub == NULL) goto EXPAND_FAILED;
5571 /* Owing to an historical mis-design, an underscore may be part of the
5572 operator name, or it may introduce arguments. We therefore first scan the
5573 table of names that contain underscores. If there is no match, we cut off
5574 the arguments and then scan the main table. */
5576 c = chop_match(name, op_table_underscore,
5577 sizeof(op_table_underscore)/sizeof(uschar *));
5581 arg = Ustrchr(name, '_');
5582 if (arg != NULL) *arg = 0;
5583 c = chop_match(name, op_table_main,
5584 sizeof(op_table_main)/sizeof(uschar *));
5585 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5586 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5589 /* If we are skipping, we don't need to perform the operation at all.
5590 This matters for operations like "mask", because the data may not be
5591 in the correct format when skipping. For example, the expression may test
5592 for the existence of $sender_host_address before trying to mask it. For
5593 other operations, doing them may not fail, but it is a waste of time. */
5595 if (skipping && c >= 0) continue;
5597 /* Otherwise, switch on the operator type */
5604 unsigned long int n = Ustrtoul(sub, &t, 10);
5607 expand_string_message = string_sprintf("argument for base62 "
5608 "operator is \"%s\", which is not a decimal number", sub);
5611 t = string_base62(n);
5612 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5616 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5622 unsigned long int n = 0;
5625 uschar *t = Ustrchr(base62_chars, *tt++);
5628 expand_string_message = string_sprintf("argument for base62d "
5629 "operator is \"%s\", which is not a base %d number", sub,
5633 n = n * BASE_62 + (t - base62_chars);
5635 (void)sprintf(CS buf, "%ld", n);
5636 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5642 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
5643 if (expanded == NULL)
5645 expand_string_message =
5646 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5647 expand_string_message);
5650 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5657 uschar *t = sub - 1;
5658 while (*(++t) != 0) { *t = tolower(*t); count++; }
5659 yield = string_cat(yield, &size, &ptr, sub, count);
5666 uschar *t = sub - 1;
5667 while (*(++t) != 0) { *t = toupper(*t); count++; }
5668 yield = string_cat(yield, &size, &ptr, sub, count);
5679 md5_end(&base, sub, Ustrlen(sub), digest);
5680 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5681 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5692 sha1_end(&base, sub, Ustrlen(sub), digest);
5693 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5694 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5698 /* Convert hex encoding to base64 encoding */
5708 for (enc = sub; *enc != 0; enc++)
5710 if (!isxdigit(*enc))
5712 expand_string_message = string_sprintf("\"%s\" is not a hex "
5721 expand_string_message = string_sprintf("\"%s\" contains an odd "
5722 "number of characters", sub);
5726 while ((c = *in++) != 0)
5728 if (isdigit(c)) c -= '0';
5729 else c = toupper(c) - 'A' + 10;
5741 enc = auth_b64encode(sub, out - sub);
5742 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5746 /* Convert octets outside 0x21..0x7E to \xXX form */
5750 uschar *t = sub - 1;
5753 if (*t < 0x21 || 0x7E < *t)
5754 yield = string_cat(yield, &size, &ptr,
5755 string_sprintf("\\x%02x", *t), 4);
5757 yield = string_cat(yield, &size, &ptr, t, 1);
5762 /* count the number of list elements */
5771 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5772 cp = string_sprintf("%d", cnt);
5773 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5777 /* expand a named list given the name */
5778 /* handles nested named lists; requotes as colon-sep list */
5782 tree_node *t = NULL;
5786 uschar * suffix = US"";
5787 BOOL needsep = FALSE;
5790 if (*sub == '+') sub++;
5791 if (arg == NULL) /* no-argument version */
5793 if (!(t = tree_search(addresslist_anchor, sub)) &&
5794 !(t = tree_search(domainlist_anchor, sub)) &&
5795 !(t = tree_search(hostlist_anchor, sub)))
5796 t = tree_search(localpartlist_anchor, sub);
5798 else switch(*arg) /* specific list-type version */
5800 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
5801 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
5802 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
5803 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
5805 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5811 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5813 : *arg=='a'?"address "
5814 : *arg=='d'?"domain "
5816 : *arg=='l'?"localpart "
5821 list = ((namedlist_block *)(t->data.ptr))->string;
5823 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5825 uschar * buf = US" : ";
5827 yield = string_cat(yield, &size, &ptr, buf, 3);
5831 if (*item == '+') /* list item is itself a named list */
5833 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5834 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
5836 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5840 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5841 while ((cp= strpbrk((const char *)item, tok)))
5843 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5844 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5846 yield = string_cat(yield, &size, &ptr, US"::", 2);
5847 item = (uschar *)cp;
5849 else /* sep in item; should already be doubled; emit once */
5851 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5852 if (*cp == sep) cp++;
5853 item = (uschar *)cp;
5857 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5862 /* mask applies a mask to an IP address; for example the result of
5863 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5870 int mask, maskoffset;
5871 int type = string_is_ip_address(sub, &maskoffset);
5876 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5881 if (maskoffset == 0)
5883 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5888 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5890 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5892 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5897 /* Convert the address to binary integer(s) and apply the mask */
5899 sub[maskoffset] = 0;
5900 count = host_aton(sub, binary);
5901 host_mask(count, binary, mask);
5903 /* Convert to masked textual format and add to output. */
5905 yield = string_cat(yield, &size, &ptr, buffer,
5906 host_nmtoa(count, binary, mask, buffer, '.'));
5911 case EOP_LOCAL_PART:
5915 int start, end, domain;
5916 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5920 if (c != EOP_DOMAIN)
5922 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5923 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5925 else if (domain != 0)
5928 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5936 uschar outsep[2] = { ':', '\0' };
5937 uschar *address, *error;
5939 int start, end, domain; /* Not really used */
5941 while (isspace(*sub)) sub++;
5942 if (*sub == '>') { *outsep = *++sub; ++sub; }
5943 parse_allow_group = TRUE;
5947 uschar *p = parse_find_address_end(sub, FALSE);
5948 uschar saveend = *p;
5950 address = parse_extract_address(sub, &error, &start, &end, &domain,
5954 /* Add the address to the output list that we are building. This is
5955 done in chunks by searching for the separator character. At the
5956 start, unless we are dealing with the first address of the output
5957 list, add in a space if the new address begins with the separator
5958 character, or is an empty string. */
5960 if (address != NULL)
5962 if (ptr != save_ptr && address[0] == *outsep)
5963 yield = string_cat(yield, &size, &ptr, US" ", 1);
5967 size_t seglen = Ustrcspn(address, outsep);
5968 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5970 /* If we got to the end of the string we output one character
5973 if (address[seglen] == '\0') { ptr--; break; }
5974 yield = string_cat(yield, &size, &ptr, outsep, 1);
5975 address += seglen + 1;
5978 /* Output a separator after the string: we will remove the
5979 redundant final one at the end. */
5981 yield = string_cat(yield, &size, &ptr, outsep, 1);
5984 if (saveend == '\0') break;
5988 /* If we have generated anything, remove the redundant final
5991 if (ptr != save_ptr) ptr--;
5992 parse_allow_group = FALSE;
5997 /* quote puts a string in quotes if it is empty or contains anything
5998 other than alphamerics, underscore, dot, or hyphen.
6000 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
6001 be quoted in order to be a valid local part.
6003 In both cases, newlines and carriage returns are converted into \n and \r
6007 case EOP_QUOTE_LOCAL_PART:
6010 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6011 uschar *t = sub - 1;
6015 while (!needs_quote && *(++t) != 0)
6016 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6018 else /* EOP_QUOTE_LOCAL_PART */
6020 while (!needs_quote && *(++t) != 0)
6021 needs_quote = !isalnum(*t) &&
6022 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6023 (*t != '.' || t == sub || t[1] == 0);
6028 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6033 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6034 else if (*t == '\r')
6035 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6038 if (*t == '\\' || *t == '"')
6039 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6040 yield = string_cat(yield, &size, &ptr, t, 1);
6043 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6045 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6049 /* quote_lookuptype does lookup-specific quoting */
6054 uschar *opt = Ustrchr(arg, '_');
6056 if (opt != NULL) *opt++ = 0;
6058 n = search_findtype(arg, Ustrlen(arg));
6061 expand_string_message = search_error_message;
6065 if (lookup_list[n]->quote != NULL)
6066 sub = (lookup_list[n]->quote)(sub, opt);
6067 else if (opt != NULL) sub = NULL;
6071 expand_string_message = string_sprintf(
6072 "\"%s\" unrecognized after \"${quote_%s\"",
6077 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6081 /* rx quote sticks in \ before any non-alphameric character so that
6082 the insertion works in a regular expression. */
6086 uschar *t = sub - 1;
6090 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6091 yield = string_cat(yield, &size, &ptr, t, 1);
6096 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6097 prescribed by the RFC, if there are characters that need to be encoded */
6101 uschar buffer[2048];
6102 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6103 buffer, sizeof(buffer), FALSE);
6104 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6108 /* RFC 2047 decode */
6114 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6115 headers_charset, '?', &len, &error);
6118 expand_string_message = error;
6121 yield = string_cat(yield, &size, &ptr, decoded, len);
6125 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6135 if (c > 255) c = '_';
6137 yield = string_cat(yield, &size, &ptr, buff, 1);
6142 /* replace illegal UTF-8 sequences by replacement character */
6144 #define UTF8_REPLACEMENT_CHAR US"?"
6148 int seq_len, index = 0;
6150 uschar seq_buff[4]; /* accumulate utf-8 here */
6162 if ((c & 0xc0) != 0x80)
6164 /* wrong continuation byte; invalidate all bytes */
6165 complete = 1; /* error */
6169 codepoint = (codepoint << 6) | (c & 0x3f);
6170 seq_buff[index++] = c;
6171 if (--bytes_left == 0) /* codepoint complete */
6173 if(codepoint > 0x10FFFF) /* is it too large? */
6174 complete = -1; /* error */
6176 { /* finished; output utf-8 sequence */
6177 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6183 else /* no bytes left: new sequence */
6185 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6187 yield = string_cat(yield, &size, &ptr, &c, 1);
6190 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6192 if(c == 0xc0 || c == 0xc1) /* 0xc0 and 0xc1 are illegal */
6197 codepoint = c & 0x1f;
6200 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6203 codepoint = c & 0x0f;
6205 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6208 codepoint = c & 0x07;
6210 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6213 seq_buff[index++] = c;
6214 seq_len = bytes_left + 1;
6215 } /* if(bytes_left) */
6219 bytes_left = index = 0;
6220 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6222 if ((complete == 1) && ((c & 0x80) == 0))
6223 { /* ASCII character follows incomplete sequence */
6224 yield = string_cat(yield, &size, &ptr, &c, 1);
6230 /* escape turns all non-printing characters into escape sequences. */
6234 uschar *t = string_printing(sub);
6235 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6239 /* Handle numeric expression evaluation */
6244 uschar *save_sub = sub;
6245 uschar *error = NULL;
6246 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6249 expand_string_message = string_sprintf("error in expression "
6250 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6254 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6255 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6259 /* Handle time period formating */
6263 int n = readconf_readtime(sub, 0, FALSE);
6266 expand_string_message = string_sprintf("string \"%s\" is not an "
6267 "Exim time interval in \"%s\" operator", sub, name);
6270 sprintf(CS var_buffer, "%d", n);
6271 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6275 case EOP_TIME_INTERVAL:
6278 uschar *t = read_number(&n, sub);
6279 if (*t != 0) /* Not A Number*/
6281 expand_string_message = string_sprintf("string \"%s\" is not a "
6282 "positive number in \"%s\" operator", sub, name);
6285 t = readconf_printtime(n);
6286 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6290 /* Convert string to base64 encoding */
6294 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6295 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6299 /* strlen returns the length of the string */
6304 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6305 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6309 /* length_n or l_n takes just the first n characters or the whole string,
6310 whichever is the shorter;
6312 substr_m_n, and s_m_n take n characters from offset m; negative m take
6313 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6314 takes the rest, either to the right or to the left.
6316 hash_n or h_n makes a hash of length n from the string, yielding n
6317 characters from the set a-z; hash_n_m makes a hash of length n, but
6318 uses m characters from the set a-zA-Z0-9.
6320 nhash_n returns a single number between 0 and n-1 (in text form), while
6321 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6322 between 0 and n-1 and the second between 0 and m-1. */
6342 expand_string_message = string_sprintf("missing values after %s",
6347 /* "length" has only one argument, effectively being synonymous with
6350 if (c == EOP_LENGTH || c == EOP_L)
6356 /* The others have one or two arguments; for "substr" the first may be
6357 negative. The second being negative means "not supplied". */
6362 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6365 /* Read up to two numbers, separated by underscores */
6370 if (arg != ret && *arg == '_' && pn == &value1)
6374 if (arg[1] != 0) arg++;
6376 else if (!isdigit(*arg))
6378 expand_string_message =
6379 string_sprintf("non-digit after underscore in \"%s\"", name);
6382 else *pn = (*pn)*10 + *arg++ - '0';
6386 /* Perform the required operation */
6389 (c == EOP_HASH || c == EOP_H)?
6390 compute_hash(sub, value1, value2, &len) :
6391 (c == EOP_NHASH || c == EOP_NH)?
6392 compute_nhash(sub, value1, value2, &len) :
6393 extract_substr(sub, value1, value2, &len);
6395 if (ret == NULL) goto EXPAND_FAILED;
6396 yield = string_cat(yield, &size, &ptr, ret, len);
6406 uschar **modetable[3];
6411 if ((expand_forbid & RDO_EXISTS) != 0)
6413 expand_string_message = US"Use of the stat() expansion is not permitted";
6417 if (stat(CS sub, &st) < 0)
6419 expand_string_message = string_sprintf("stat(%s) failed: %s",
6420 sub, strerror(errno));
6424 switch (mode & S_IFMT)
6426 case S_IFIFO: smode[0] = 'p'; break;
6427 case S_IFCHR: smode[0] = 'c'; break;
6428 case S_IFDIR: smode[0] = 'd'; break;
6429 case S_IFBLK: smode[0] = 'b'; break;
6430 case S_IFREG: smode[0] = '-'; break;
6431 default: smode[0] = '?'; break;
6434 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6435 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6436 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6438 for (i = 0; i < 3; i++)
6440 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6445 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6446 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6447 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6448 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6449 (long)st.st_gid, st.st_size, (long)st.st_atime,
6450 (long)st.st_mtime, (long)st.st_ctime);
6451 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6455 /* vaguely random number less than N */
6459 int_eximarith_t max;
6462 max = expand_string_integer(sub, TRUE);
6463 if (expand_string_message != NULL)
6465 s = string_sprintf("%d", vaguely_random_number((int)max));
6466 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6470 /* Reverse IP, including IPv6 to dotted-nibble */
6472 case EOP_REVERSE_IP:
6474 int family, maskptr;
6475 uschar reversed[128];
6477 family = string_is_ip_address(sub, &maskptr);
6480 expand_string_message = string_sprintf(
6481 "reverse_ip() not given an IP address [%s]", sub);
6484 invert_address(reversed, sub);
6485 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6489 /* Unknown operator */
6492 expand_string_message =
6493 string_sprintf("unknown expansion operator \"%s\"", name);
6498 /* Handle a plain name. If this is the first thing in the expansion, release
6499 the pre-allocated buffer. If the result data is known to be in a new buffer,
6500 newsize will be set to the size of that buffer, and we can just point at that
6501 store instead of copying. Many expansion strings contain just one reference,
6502 so this is a useful optimization, especially for humungous headers
6503 ($message_headers). */
6511 if (resetok) store_reset(yield);
6515 value = find_variable(name, FALSE, skipping, &newsize);
6518 expand_string_message =
6519 string_sprintf("unknown variable in \"${%s}\"", name);
6520 check_variable_error_message(name);
6523 len = Ustrlen(value);
6524 if (yield == NULL && newsize != 0)
6530 else yield = string_cat(yield, &size, &ptr, value, len);
6534 /* Else there's something wrong */
6536 expand_string_message =
6537 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6538 "in a variable reference)", name);
6542 /* If we hit the end of the string when ket_ends is set, there is a missing
6543 terminating brace. */
6545 if (ket_ends && *s == 0)
6547 expand_string_message = malformed_header?
6548 US"missing } at end of string - could be header name not terminated by colon"
6550 US"missing } at end of string";
6554 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6555 added to the string. If so, set up an empty string. Add a terminating zero. If
6556 left != NULL, return a pointer to the terminator. */
6558 if (yield == NULL) yield = store_get(1);
6560 if (left != NULL) *left = s;
6562 /* Any stacking store that was used above the final string is no longer needed.
6563 In many cases the final string will be the first one that was got and so there
6564 will be optimal store usage. */
6566 if (resetok) store_reset(yield + ptr + 1);
6567 else if (resetok_p) *resetok_p = FALSE;
6571 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6573 if (skipping) debug_printf("skipping: result is not used\n");
6577 /* This is the failure exit: easiest to program with a goto. We still need
6578 to update the pointer to the terminator, for cases of nested calls with "fail".
6581 EXPAND_FAILED_CURLY:
6582 expand_string_message = malformed_header?
6583 US"missing or misplaced { or } - could be header name not terminated by colon"
6585 US"missing or misplaced { or }";
6587 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6588 that is a bad idea, because expand_string_message is in dynamic store. */
6591 if (left != NULL) *left = s;
6594 debug_printf("failed to expand: %s\n", string);
6595 debug_printf(" error message: %s\n", expand_string_message);
6596 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6598 if (resetok_p) *resetok_p = resetok;
6603 /* This is the external function call. Do a quick check for any expansion
6604 metacharacters, and if there are none, just return the input string.
6606 Argument: the string to be expanded
6607 Returns: the expanded string, or NULL if expansion failed; if failure was
6608 due to a lookup deferring, search_find_defer will be TRUE
6612 expand_string(uschar *string)
6614 search_find_defer = FALSE;
6615 malformed_header = FALSE;
6616 return (Ustrpbrk(string, "$\\") == NULL)? string :
6617 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
6622 /*************************************************
6624 *************************************************/
6626 /* Now and again we want to expand a string and be sure that the result is in a
6627 new bit of store. This function does that.
6629 Argument: the string to be expanded
6630 Returns: the expanded string, always in a new bit of store, or NULL
6634 expand_string_copy(uschar *string)
6636 uschar *yield = expand_string(string);
6637 if (yield == string) yield = string_copy(string);
6643 /*************************************************
6644 * Expand and interpret as an integer *
6645 *************************************************/
6647 /* Expand a string, and convert the result into an integer.
6650 string the string to be expanded
6651 isplus TRUE if a non-negative number is expected
6653 Returns: the integer value, or
6654 -1 for an expansion error ) in both cases, message in
6655 -2 for an integer interpretation error ) expand_string_message
6656 expand_string_message is set NULL for an OK integer
6660 expand_string_integer(uschar *string, BOOL isplus)
6662 int_eximarith_t value;
6663 uschar *s = expand_string(string);
6664 uschar *msg = US"invalid integer \"%s\"";
6667 /* If expansion failed, expand_string_message will be set. */
6669 if (s == NULL) return -1;
6671 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6672 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6673 systems, so we set it zero ourselves. */
6676 expand_string_message = NULL; /* Indicates no error */
6678 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6679 equal to 0. Unfortunately, people actually relied upon that, so preserve
6680 the behaviour explicitly. Stripping leading whitespace is a harmless
6681 noop change since strtol skips it anyway (provided that there is a number
6685 while (isspace(*s)) ++s;
6689 debug_printf("treating blank string as number 0\n");
6694 value = strtoll(CS s, CSS &endptr, 10);
6698 msg = US"integer expected but \"%s\" found";
6700 else if (value < 0 && isplus)
6702 msg = US"non-negative integer expected but \"%s\" found";
6706 switch (tolower(*endptr))
6711 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
6716 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
6717 else value *= 1024*1024;
6721 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
6722 else value *= 1024*1024*1024;
6726 if (errno == ERANGE)
6727 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6730 while (isspace(*endptr)) endptr++;
6731 if (*endptr == 0) return value;
6735 expand_string_message = string_sprintf(CS msg, s);
6740 /*************************************************
6741 **************************************************
6742 * Stand-alone test program *
6743 **************************************************
6744 *************************************************/
6750 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6752 int ovector[3*(EXPAND_MAXN+1)];
6753 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6754 ovector, sizeof(ovector)/sizeof(int));
6755 BOOL yield = n >= 0;
6756 if (n == 0) n = EXPAND_MAXN + 1;
6760 expand_nmax = (setup < 0)? 0 : setup + 1;
6761 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6763 expand_nstring[expand_nmax] = subject + ovector[nn];
6764 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6772 int main(int argc, uschar **argv)
6775 uschar buffer[1024];
6777 debug_selector = D_v;
6778 debug_file = stderr;
6779 debug_fd = fileno(debug_file);
6780 big_buffer = malloc(big_buffer_size);
6782 for (i = 1; i < argc; i++)
6784 if (argv[i][0] == '+')
6786 debug_trace_memory = 2;
6789 if (isdigit(argv[i][0]))
6790 debug_selector = Ustrtol(argv[i], NULL, 0);
6792 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6796 eldap_default_servers = argv[i];
6799 mysql_servers = argv[i];
6802 pgsql_servers = argv[i];
6804 #ifdef EXPERIMENTAL_REDIS
6805 redis_servers = argv[i];
6809 else opt_perl_startup = argv[i];
6813 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6815 expand_nstring[1] = US"string 1....";
6816 expand_nlength[1] = 8;
6820 if (opt_perl_startup != NULL)
6823 printf("Starting Perl interpreter\n");
6824 errstr = init_perl(opt_perl_startup);
6827 printf("** error in perl_startup code: %s\n", errstr);
6828 return EXIT_FAILURE;
6831 #endif /* EXIM_PERL */
6833 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6835 void *reset_point = store_get(0);
6836 uschar *yield = expand_string(buffer);
6839 printf("%s\n", yield);
6840 store_reset(reset_point);
6844 if (search_find_defer) printf("search_find deferred\n");
6845 printf("Failed: %s\n", expand_string_message);
6846 if (expand_string_forcedfail) printf("Forced failure\n");
6861 /* End of expand.c */