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. */
2852 else if (Ustrspn(t, "0123456789") == len)
2854 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2855 /* expand_check_condition only does a literal string "0" check */
2856 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2859 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2861 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2863 else if (cond_type == ECOND_BOOL_LAX)
2867 expand_string_message = string_sprintf("unrecognised boolean "
2871 if (yield != NULL) *yield = (boolvalue == testfor);
2875 /* Unknown condition */
2878 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2880 } /* End switch on condition type */
2882 /* Missing braces at start and end of data */
2884 COND_FAILED_CURLY_START:
2885 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2888 COND_FAILED_CURLY_END:
2889 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2893 /* A condition requires code that is not compiled */
2895 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2896 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2897 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2898 COND_FAILED_NOT_COMPILED:
2899 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2908 /*************************************************
2909 * Save numerical variables *
2910 *************************************************/
2912 /* This function is called from items such as "if" that want to preserve and
2913 restore the numbered variables.
2916 save_expand_string points to an array of pointers to set
2917 save_expand_nlength points to an array of ints for the lengths
2919 Returns: the value of expand max to save
2923 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2926 for (i = 0; i <= expand_nmax; i++)
2928 save_expand_nstring[i] = expand_nstring[i];
2929 save_expand_nlength[i] = expand_nlength[i];
2936 /*************************************************
2937 * Restore numerical variables *
2938 *************************************************/
2940 /* This function restored saved values of numerical strings.
2943 save_expand_nmax the number of strings to restore
2944 save_expand_string points to an array of pointers
2945 save_expand_nlength points to an array of ints
2951 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2952 int *save_expand_nlength)
2955 expand_nmax = save_expand_nmax;
2956 for (i = 0; i <= expand_nmax; i++)
2958 expand_nstring[i] = save_expand_nstring[i];
2959 expand_nlength[i] = save_expand_nlength[i];
2967 /*************************************************
2968 * Handle yes/no substrings *
2969 *************************************************/
2971 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2972 alternative substrings that depend on whether or not the condition was true,
2973 or the lookup or extraction succeeded. The substrings always have to be
2974 expanded, to check their syntax, but "skipping" is set when the result is not
2975 needed - this avoids unnecessary nested lookups.
2978 skipping TRUE if we were skipping when this item was reached
2979 yes TRUE if the first string is to be used, else use the second
2980 save_lookup a value to put back into lookup_value before the 2nd expansion
2981 sptr points to the input string pointer
2982 yieldptr points to the output string pointer
2983 sizeptr points to the output string size
2984 ptrptr points to the output string pointer
2985 type "lookup" or "if" or "extract" or "run", for error message
2986 resetok if not NULL, pointer to flag - write FALSE if unsafe to reset
2989 Returns: 0 OK; lookup_value has been reset to save_lookup
2991 2 expansion failed because of bracketing error
2995 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2996 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type, BOOL *resetok)
2999 uschar *s = *sptr; /* Local value */
3000 uschar *sub1, *sub2;
3002 /* If there are no following strings, we substitute the contents of $value for
3003 lookups and for extractions in the success case. For the ${if item, the string
3004 "true" is substituted. In the fail case, nothing is substituted for all three
3007 while (isspace(*s)) s++;
3012 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
3016 if (yes && lookup_value != NULL)
3017 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
3018 Ustrlen(lookup_value));
3019 lookup_value = save_lookup;
3025 /* The first following string must be braced. */
3027 if (*s++ != '{') goto FAILED_CURLY;
3029 /* Expand the first substring. Forced failures are noticed only if we actually
3030 want this string. Set skipping in the call in the fail case (this will always
3031 be the case if we were already skipping). */
3033 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE, resetok);
3034 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3035 expand_string_forcedfail = FALSE;
3036 if (*s++ != '}') goto FAILED_CURLY;
3038 /* If we want the first string, add it to the output */
3041 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3043 /* If this is called from a lookup or an extract, we want to restore $value to
3044 what it was at the start of the item, so that it has this value during the
3045 second string expansion. For the call from "if" or "run" to this function,
3046 save_lookup is set to lookup_value, so that this statement does nothing. */
3048 lookup_value = save_lookup;
3050 /* There now follows either another substring, or "fail", or nothing. This
3051 time, forced failures are noticed only if we want the second string. We must
3052 set skipping in the nested call if we don't want this string, or if we were
3053 already skipping. */
3055 while (isspace(*s)) s++;
3058 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE, resetok);
3059 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3060 expand_string_forcedfail = FALSE;
3061 if (*s++ != '}') goto FAILED_CURLY;
3063 /* If we want the second string, add it to the output */
3066 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3069 /* If there is no second string, but the word "fail" is present when the use of
3070 the second string is wanted, set a flag indicating it was a forced failure
3071 rather than a syntactic error. Swallow the terminating } in case this is nested
3072 inside another lookup or if or extract. */
3077 s = read_name(name, sizeof(name), s, US"_");
3078 if (Ustrcmp(name, "fail") == 0)
3080 if (!yes && !skipping)
3082 while (isspace(*s)) s++;
3083 if (*s++ != '}') goto FAILED_CURLY;
3084 expand_string_message =
3085 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3086 expand_string_forcedfail = TRUE;
3092 expand_string_message =
3093 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3098 /* All we have to do now is to check on the final closing brace. */
3100 while (isspace(*s)) s++;
3101 if (*s++ == '}') goto RETURN;
3103 /* Get here if there is a bracketing failure */
3108 /* Get here for other failures */
3113 /* Update the input pointer value before returning */
3123 /*************************************************
3124 * Handle MD5 or SHA-1 computation for HMAC *
3125 *************************************************/
3127 /* These are some wrapping functions that enable the HMAC code to be a bit
3128 cleaner. A good compiler will spot the tail recursion.
3131 type HMAC_MD5 or HMAC_SHA1
3132 remaining are as for the cryptographic hash functions
3138 chash_start(int type, void *base)
3140 if (type == HMAC_MD5)
3141 md5_start((md5 *)base);
3143 sha1_start((sha1 *)base);
3147 chash_mid(int type, void *base, uschar *string)
3149 if (type == HMAC_MD5)
3150 md5_mid((md5 *)base, string);
3152 sha1_mid((sha1 *)base, string);
3156 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3158 if (type == HMAC_MD5)
3159 md5_end((md5 *)base, string, length, digest);
3161 sha1_end((sha1 *)base, string, length, digest);
3168 /********************************************************
3169 * prvs: Get last three digits of days since Jan 1, 1970 *
3170 ********************************************************/
3172 /* This is needed to implement the "prvs" BATV reverse
3175 Argument: integer "days" offset to add or substract to
3176 or from the current number of days.
3178 Returns: pointer to string containing the last three
3179 digits of the number of days since Jan 1, 1970,
3180 modified by the offset argument, NULL if there
3181 was an error in the conversion.
3186 prvs_daystamp(int day_offset)
3188 uschar *days = store_get(32); /* Need at least 24 for cases */
3189 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3190 (time(NULL) + day_offset*86400)/86400);
3191 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3196 /********************************************************
3197 * prvs: perform HMAC-SHA1 computation of prvs bits *
3198 ********************************************************/
3200 /* This is needed to implement the "prvs" BATV reverse
3204 address RFC2821 Address to use
3205 key The key to use (must be less than 64 characters
3207 key_num Single-digit key number to use. Defaults to
3210 Returns: pointer to string containing the first three
3211 bytes of the final hash in hex format, NULL if
3212 there was an error in the process.
3216 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3218 uschar *hash_source, *p;
3219 int size = 0,offset = 0,i;
3221 void *use_base = &sha1_base;
3222 uschar innerhash[20];
3223 uschar finalhash[20];
3224 uschar innerkey[64];
3225 uschar outerkey[64];
3226 uschar *finalhash_hex = store_get(40);
3228 if (key_num == NULL)
3231 if (Ustrlen(key) > 64)
3234 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3235 string_cat(hash_source,&size,&offset,daystamp,3);
3236 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3237 hash_source[offset] = '\0';
3239 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3241 memset(innerkey, 0x36, 64);
3242 memset(outerkey, 0x5c, 64);
3244 for (i = 0; i < Ustrlen(key); i++)
3246 innerkey[i] ^= key[i];
3247 outerkey[i] ^= key[i];
3250 chash_start(HMAC_SHA1, use_base);
3251 chash_mid(HMAC_SHA1, use_base, innerkey);
3252 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3254 chash_start(HMAC_SHA1, use_base);
3255 chash_mid(HMAC_SHA1, use_base, outerkey);
3256 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3259 for (i = 0; i < 3; i++)
3261 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3262 *p++ = hex_digits[finalhash[i] & 0x0f];
3266 return finalhash_hex;
3272 /*************************************************
3273 * Join a file onto the output string *
3274 *************************************************/
3276 /* This is used for readfile and after a run expansion. It joins the contents
3277 of a file onto the output string, globally replacing newlines with a given
3278 string (optionally). The file is closed at the end.
3282 yield pointer to the expandable string
3283 sizep pointer to the current size
3284 ptrp pointer to the current position
3285 eol newline replacement string, or NULL
3287 Returns: new value of string pointer
3291 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3294 uschar buffer[1024];
3296 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3298 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3300 int len = Ustrlen(buffer);
3301 if (eol != NULL && buffer[len-1] == '\n') len--;
3302 yield = string_cat(yield, sizep, ptrp, buffer, len);
3303 if (buffer[len] != 0)
3304 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3307 if (yield != NULL) yield[*ptrp] = 0;
3315 /*************************************************
3316 * Evaluate numeric expression *
3317 *************************************************/
3319 /* This is a set of mutually recursive functions that evaluate an arithmetic
3320 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3321 these functions that is called from elsewhere is eval_expr, whose interface is:
3324 sptr pointer to the pointer to the string - gets updated
3325 decimal TRUE if numbers are to be assumed decimal
3326 error pointer to where to put an error message - must be NULL on input
3327 endket TRUE if ')' must terminate - FALSE for external call
3329 Returns: on success: the value of the expression, with *error still NULL
3330 on failure: an undefined value, with *error = a message
3333 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3336 static int_eximarith_t
3337 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3340 int_eximarith_t x = eval_op_or(&s, decimal, error);
3346 *error = US"expecting closing parenthesis";
3348 while (isspace(*(++s)));
3350 else if (*s != 0) *error = US"expecting operator";
3357 static int_eximarith_t
3358 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3363 while (isspace(*s)) s++;
3368 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3370 switch (tolower(*s))
3373 case 'k': n *= 1024; s++; break;
3374 case 'm': n *= 1024*1024; s++; break;
3375 case 'g': n *= 1024*1024*1024; s++; break;
3377 while (isspace (*s)) s++;
3382 n = eval_expr(&s, decimal, error, 1);
3386 *error = US"expecting number or opening parenthesis";
3394 static int_eximarith_t
3395 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3399 while (isspace(*s)) s++;
3400 if (*s == '+' || *s == '-' || *s == '~')
3403 x = eval_op_unary(&s, decimal, error);
3404 if (op == '-') x = -x;
3405 else if (op == '~') x = ~x;
3409 x = eval_number(&s, decimal, error);
3416 static int_eximarith_t
3417 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3420 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3423 while (*s == '*' || *s == '/' || *s == '%')
3426 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3427 if (*error != NULL) break;
3428 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3429 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3430 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3431 * -N*M is INT_MIN will yielf INT_MIN.
3432 * Since we don't support floating point, this is somewhat simpler.
3433 * Ideally, we'd return an error, but since we overflow for all other
3434 * arithmetic, consistency suggests otherwise, but what's the correct value
3435 * to use? There is none.
3436 * The C standard guarantees overflow for unsigned arithmetic but signed
3437 * overflow invokes undefined behaviour; in practice, this is overflow
3438 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3439 * that long/longlong larger than int are available, or we could just work
3440 * with larger types. We should consider whether to guarantee 32bit eval
3441 * and 64-bit working variables, with errors returned. For now ...
3442 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3443 * can just let the other invalid results occur otherwise, as they have
3444 * until now. For this one case, we can coerce.
3446 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3449 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3450 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3460 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3476 static int_eximarith_t
3477 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3480 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3483 while (*s == '+' || *s == '-')
3486 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3487 if (*error != NULL) break;
3488 if (op == '+') x += y; else x -= y;
3496 static int_eximarith_t
3497 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3500 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3503 while ((*s == '<' || *s == '>') && s[1] == s[0])
3508 y = eval_op_sum(&s, decimal, error);
3509 if (*error != NULL) break;
3510 if (op == '<') x <<= y; else x >>= y;
3518 static int_eximarith_t
3519 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3522 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3529 y = eval_op_shift(&s, decimal, error);
3530 if (*error != NULL) break;
3539 static int_eximarith_t
3540 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3543 int_eximarith_t x = eval_op_and(&s, decimal, error);
3550 y = eval_op_and(&s, decimal, error);
3551 if (*error != NULL) break;
3560 static int_eximarith_t
3561 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3564 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3571 y = eval_op_xor(&s, decimal, error);
3572 if (*error != NULL) break;
3582 /*************************************************
3584 *************************************************/
3586 /* Returns either an unchanged string, or the expanded string in stacking pool
3587 store. Interpreted sequences are:
3589 \... normal escaping rules
3590 $name substitutes the variable
3592 ${op:string} operates on the expanded string value
3593 ${item{arg1}{arg2}...} expands the args and then does the business
3594 some literal args are not enclosed in {}
3596 There are now far too many operators and item types to make it worth listing
3597 them here in detail any more.
3599 We use an internal routine recursively to handle embedded substrings. The
3600 external function follows. The yield is NULL if the expansion failed, and there
3601 are two cases: if something collapsed syntactically, or if "fail" was given
3602 as the action on a lookup failure. These can be distinguised by looking at the
3603 variable expand_string_forcedfail, which is TRUE in the latter case.
3605 The skipping flag is set true when expanding a substring that isn't actually
3606 going to be used (after "if" or "lookup") and it prevents lookups from
3607 happening lower down.
3609 Store usage: At start, a store block of the length of the input plus 64
3610 is obtained. This is expanded as necessary by string_cat(), which might have to
3611 get a new block, or might be able to expand the original. At the end of the
3612 function we can release any store above that portion of the yield block that
3613 was actually used. In many cases this will be optimal.
3615 However: if the first item in the expansion is a variable name or header name,
3616 we reset the store before processing it; if the result is in fresh store, we
3617 use that without copying. This is helpful for expanding strings like
3618 $message_headers which can get very long.
3620 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3621 since resetting the store at the end of the expansion will free store that was
3622 allocated by the plugin code as well as the slop after the expanded string. So
3623 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
3624 and, given the acl condition, ${if }. This is an unfortunate consequence of
3625 string expansion becoming too powerful.
3628 string the string to be expanded
3629 ket_ends true if expansion is to stop at }
3630 left if not NULL, a pointer to the first character after the
3631 expansion is placed here (typically used with ket_ends)
3632 skipping TRUE for recursive calls when the value isn't actually going
3633 to be used (to allow for optimisation)
3634 honour_dollar TRUE if $ is to be expanded,
3635 FALSE if it's just another character
3636 resetok_p if not NULL, pointer to flag - write FALSE if unsafe to reset
3639 Returns: NULL if expansion fails:
3640 expand_string_forcedfail is set TRUE if failure was forced
3641 expand_string_message contains a textual error message
3642 a pointer to the expanded string on success
3646 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3647 BOOL skipping, BOOL honour_dollar, BOOL *resetok_p)
3650 int size = Ustrlen(string)+ 64;
3652 uschar *yield = store_get(size);
3654 uschar *save_expand_nstring[EXPAND_MAXN+1];
3655 int save_expand_nlength[EXPAND_MAXN+1];
3656 BOOL resetok = TRUE;
3658 expand_string_forcedfail = FALSE;
3659 expand_string_message = US"";
3666 /* \ escapes the next character, which must exist, or else
3667 the expansion fails. There's a special escape, \N, which causes
3668 copying of the subject verbatim up to the next \N. Otherwise,
3669 the escapes are the standard set. */
3675 expand_string_message = US"\\ at end of string";
3682 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3683 yield = string_cat(yield, &size, &ptr, t, s - t);
3684 if (*s != 0) s += 2;
3690 ch[0] = string_interpret_escape(&s);
3692 yield = string_cat(yield, &size, &ptr, ch, 1);
3699 /* Anything other than $ is just copied verbatim, unless we are
3700 looking for a terminating } character. */
3703 if (ket_ends && *s == '}') break;
3705 if (*s != '$' || !honour_dollar)
3707 yield = string_cat(yield, &size, &ptr, s++, 1);
3711 /* No { after the $ - must be a plain name or a number for string
3712 match variable. There has to be a fudge for variables that are the
3713 names of header fields preceded by "$header_" because header field
3714 names can contain any printing characters except space and colon.
3715 For those that don't like typing this much, "$h_" is a synonym for
3716 "$header_". A non-existent header yields a NULL value; nothing is
3719 if (isalpha((*(++s))))
3724 s = read_name(name, sizeof(name), s, US"_");
3726 /* If this is the first thing to be expanded, release the pre-allocated
3729 if (ptr == 0 && yield != NULL)
3731 if (resetok) store_reset(yield);
3738 if (Ustrncmp(name, "h_", 2) == 0 ||
3739 Ustrncmp(name, "rh_", 3) == 0 ||
3740 Ustrncmp(name, "bh_", 3) == 0 ||
3741 Ustrncmp(name, "header_", 7) == 0 ||
3742 Ustrncmp(name, "rheader_", 8) == 0 ||
3743 Ustrncmp(name, "bheader_", 8) == 0)
3745 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3746 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3747 s = read_header_name(name, sizeof(name), s);
3748 value = find_header(name, FALSE, &newsize, want_raw, charset);
3750 /* If we didn't find the header, and the header contains a closing brace
3751 character, this may be a user error where the terminating colon
3752 has been omitted. Set a flag to adjust the error message in this case.
3753 But there is no error here - nothing gets inserted. */
3757 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3766 value = find_variable(name, FALSE, skipping, &newsize);
3769 expand_string_message =
3770 string_sprintf("unknown variable name \"%s\"", name);
3771 check_variable_error_message(name);
3776 /* If the data is known to be in a new buffer, newsize will be set to the
3777 size of that buffer. If this is the first thing in an expansion string,
3778 yield will be NULL; just point it at the new store instead of copying. Many
3779 expansion strings contain just one reference, so this is a useful
3780 optimization, especially for humungous headers. */
3782 len = Ustrlen(value);
3783 if (yield == NULL && newsize != 0)
3789 else yield = string_cat(yield, &size, &ptr, value, len);
3797 s = read_number(&n, s);
3798 if (n >= 0 && n <= expand_nmax)
3799 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3804 /* Otherwise, if there's no '{' after $ it's an error. */ /*}*/
3806 if (*s != '{') /*}*/
3808 expand_string_message = US"$ not followed by letter, digit, or {"; /*}*/
3812 /* After { there can be various things, but they all start with
3813 an initial word, except for a number for a string match variable. */
3815 if (isdigit((*(++s))))
3818 s = read_number(&n, s); /*{*/
3821 expand_string_message = US"} expected after number";
3824 if (n >= 0 && n <= expand_nmax)
3825 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3832 expand_string_message = US"letter or digit expected after ${"; /*}*/
3836 /* Allow "-" in names to cater for substrings with negative
3837 arguments. Since we are checking for known names after { this is
3840 s = read_name(name, sizeof(name), s, US"_-");
3841 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3845 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3846 If the ACL returns accept or reject we return content set by "message ="
3847 There is currently no limit on recursion; this would have us call
3848 acl_check_internal() directly and get a current level from somewhere.
3849 See also the acl expansion condition ECOND_ACL and the traditional
3850 acl modifier ACLC_ACL.
3851 Assume that the function has side-effects on the store that must be preserved.
3855 /* ${acl {name} {arg1}{arg2}...} */
3857 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3860 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl", &resetok))
3862 case 1: goto EXPAND_FAILED_CURLY;
3864 case 3: goto EXPAND_FAILED;
3866 if (skipping) continue;
3869 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3874 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3878 expand_string_forcedfail = TRUE;
3880 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3885 /* Handle conditionals - preserve the values of the numerical expansion
3886 variables in case they get changed by a regular expression match in the
3887 condition. If not, they retain their external settings. At the end
3888 of this "if" section, they get restored to their previous values. */
3894 int save_expand_nmax =
3895 save_expand_strings(save_expand_nstring, save_expand_nlength);
3897 while (isspace(*s)) s++;
3898 next_s = eval_condition(s, &resetok, skipping? NULL : &cond);
3899 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3902 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3903 cond? "true" : "false");
3907 /* The handling of "yes" and "no" result strings is now in a separate
3908 function that is also used by ${lookup} and ${extract} and ${run}. */
3910 switch(process_yesno(
3911 skipping, /* were previously skipping */
3912 cond, /* success/failure indicator */
3913 lookup_value, /* value to reset for string2 */
3914 &s, /* input pointer */
3915 &yield, /* output pointer */
3916 &size, /* output size */
3917 &ptr, /* output current point */
3918 US"if", /* condition type */
3921 case 1: goto EXPAND_FAILED; /* when all is well, the */
3922 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3925 /* Restore external setting of expansion variables for continuation
3928 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3929 save_expand_nlength);
3933 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3934 expanding an internal string that isn't actually going to be used. All we
3935 need to do is check the syntax, so don't do a lookup at all. Preserve the
3936 values of the numerical expansion variables in case they get changed by a
3937 partial lookup. If not, they retain their external settings. At the end
3938 of this "lookup" section, they get restored to their previous values. */
3942 int stype, partial, affixlen, starflags;
3943 int expand_setup = 0;
3945 uschar *key, *filename, *affix;
3946 uschar *save_lookup_value = lookup_value;
3947 int save_expand_nmax =
3948 save_expand_strings(save_expand_nstring, save_expand_nlength);
3950 if ((expand_forbid & RDO_LOOKUP) != 0)
3952 expand_string_message = US"lookup expansions are not permitted";
3956 /* Get the key we are to look up for single-key+file style lookups.
3957 Otherwise set the key NULL pro-tem. */
3959 while (isspace(*s)) s++;
3960 if (*s == '{') /*}*/
3962 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
3963 if (key == NULL) goto EXPAND_FAILED; /*{*/
3964 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3965 while (isspace(*s)) s++;
3969 /* Find out the type of database */
3973 expand_string_message = US"missing lookup type";
3977 /* The type is a string that may contain special characters of various
3978 kinds. Allow everything except space or { to appear; the actual content
3979 is checked by search_findtype_partial. */ /*}*/
3981 while (*s != 0 && *s != '{' && !isspace(*s)) /*}*/
3983 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3987 while (isspace(*s)) s++;
3989 /* Now check for the individual search type and any partial or default
3990 options. Only those types that are actually in the binary are valid. */
3992 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3996 expand_string_message = search_error_message;
4000 /* Check that a key was provided for those lookup types that need it,
4001 and was not supplied for those that use the query style. */
4003 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
4007 expand_string_message = string_sprintf("missing {key} for single-"
4008 "key \"%s\" lookup", name);
4016 expand_string_message = string_sprintf("a single key was given for "
4017 "lookup type \"%s\", which is not a single-key lookup type", name);
4022 /* Get the next string in brackets and expand it. It is the file name for
4023 single-key+file lookups, and the whole query otherwise. In the case of
4024 queries that also require a file name (e.g. sqlite), the file name comes
4027 if (*s != '{') goto EXPAND_FAILED_CURLY;
4028 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4029 if (filename == NULL) goto EXPAND_FAILED;
4030 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4031 while (isspace(*s)) s++;
4033 /* If this isn't a single-key+file lookup, re-arrange the variables
4034 to be appropriate for the search_ functions. For query-style lookups,
4035 there is just a "key", and no file name. For the special query-style +
4036 file types, the query (i.e. "key") starts with a file name. */
4040 while (isspace(*filename)) filename++;
4043 if (mac_islookup(stype, lookup_querystyle))
4049 if (*filename != '/')
4051 expand_string_message = string_sprintf(
4052 "absolute file name expected for \"%s\" lookup", name);
4055 while (*key != 0 && !isspace(*key)) key++;
4056 if (*key != 0) *key++ = 0;
4060 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4061 the entry was not found. Note that there is no search_close() function.
4062 Files are left open in case of re-use. At suitable places in higher logic,
4063 search_tidyup() is called to tidy all open files. This can save opening
4064 the same file several times. However, files may also get closed when
4065 others are opened, if too many are open at once. The rule is that a
4066 handle should not be used after a second search_open().
4068 Request that a partial search sets up $1 and maybe $2 by passing
4069 expand_setup containing zero. If its value changes, reset expand_nmax,
4070 since new variables will have been set. Note that at the end of this
4071 "lookup" section, the old numeric variables are restored. */
4074 lookup_value = NULL;
4077 void *handle = search_open(filename, stype, 0, NULL, NULL);
4080 expand_string_message = search_error_message;
4083 lookup_value = search_find(handle, filename, key, partial, affix,
4084 affixlen, starflags, &expand_setup);
4085 if (search_find_defer)
4087 expand_string_message =
4088 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4089 string_printing2(key, FALSE), search_error_message);
4092 if (expand_setup > 0) expand_nmax = expand_setup;
4095 /* The handling of "yes" and "no" result strings is now in a separate
4096 function that is also used by ${if} and ${extract}. */
4098 switch(process_yesno(
4099 skipping, /* were previously skipping */
4100 lookup_value != NULL, /* success/failure indicator */
4101 save_lookup_value, /* value to reset for string2 */
4102 &s, /* input pointer */
4103 &yield, /* output pointer */
4104 &size, /* output size */
4105 &ptr, /* output current point */
4106 US"lookup", /* condition type */
4109 case 1: goto EXPAND_FAILED; /* when all is well, the */
4110 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4113 /* Restore external setting of expansion variables for carrying on
4114 at this level, and continue. */
4116 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4117 save_expand_nlength);
4121 /* If Perl support is configured, handle calling embedded perl subroutines,
4122 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4123 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4124 arguments (defined below). */
4126 #define EXIM_PERL_MAX_ARGS 8
4130 expand_string_message = US"\"${perl\" encountered, but this facility " /*}*/
4131 "is not included in this binary";
4134 #else /* EXIM_PERL */
4136 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4139 if ((expand_forbid & RDO_PERL) != 0)
4141 expand_string_message = US"Perl calls are not permitted";
4145 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4146 US"perl", &resetok))
4148 case 1: goto EXPAND_FAILED_CURLY;
4150 case 3: goto EXPAND_FAILED;
4153 /* If skipping, we don't actually do anything */
4155 if (skipping) continue;
4157 /* Start the interpreter if necessary */
4159 if (!opt_perl_started)
4162 if (opt_perl_startup == NULL)
4164 expand_string_message = US"A setting of perl_startup is needed when "
4165 "using the Perl interpreter";
4168 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4169 initerror = init_perl(opt_perl_startup);
4170 if (initerror != NULL)
4172 expand_string_message =
4173 string_sprintf("error in perl_startup code: %s\n", initerror);
4176 opt_perl_started = TRUE;
4179 /* Call the function */
4181 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4182 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4183 sub_arg[0], sub_arg + 1);
4185 /* NULL yield indicates failure; if the message pointer has been set to
4186 NULL, the yield was undef, indicating a forced failure. Otherwise the
4187 message will indicate some kind of Perl error. */
4189 if (new_yield == NULL)
4191 if (expand_string_message == NULL)
4193 expand_string_message =
4194 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4195 "failure", sub_arg[0]);
4196 expand_string_forcedfail = TRUE;
4201 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4202 set during a callback from Perl. */
4204 expand_string_forcedfail = FALSE;
4208 #endif /* EXIM_PERL */
4210 /* Transform email address to "prvs" scheme to use
4211 as BATV-signed return path */
4218 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs", &resetok))
4220 case 1: goto EXPAND_FAILED_CURLY;
4222 case 3: goto EXPAND_FAILED;
4225 /* If skipping, we don't actually do anything */
4226 if (skipping) continue;
4228 /* sub_arg[0] is the address */
4229 domain = Ustrrchr(sub_arg[0],'@');
4230 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4232 expand_string_message = US"prvs first argument must be a qualified email address";
4236 /* Calculate the hash. The second argument must be a single-digit
4237 key number, or unset. */
4239 if (sub_arg[2] != NULL &&
4240 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4242 expand_string_message = US"prvs second argument must be a single digit";
4246 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4249 expand_string_message = US"prvs hmac-sha1 conversion failed";
4253 /* Now separate the domain from the local part */
4256 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4257 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4258 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4259 string_cat(yield,&size,&ptr,p,6);
4260 string_cat(yield,&size,&ptr,US"=",1);
4261 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4262 string_cat(yield,&size,&ptr,US"@",1);
4263 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4268 /* Check a prvs-encoded address for validity */
4270 case EITEM_PRVSCHECK:
4273 int mysize = 0, myptr = 0;
4277 /* TF: Ugliness: We want to expand parameter 1 first, then set
4278 up expansion variables that are used in the expansion of
4279 parameter 2. So we clone the string for the first
4280 expansion, where we only expand parameter 1.
4282 PH: Actually, that isn't necessary. The read_subs() function is
4283 designed to work this way for the ${if and ${lookup expansions. I've
4287 /* Reset expansion variables */
4288 prvscheck_result = NULL;
4289 prvscheck_address = NULL;
4290 prvscheck_keynum = NULL;
4292 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4294 case 1: goto EXPAND_FAILED_CURLY;
4296 case 3: goto EXPAND_FAILED;
4299 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4302 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4304 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4305 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4306 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4307 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4308 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4310 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4311 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4312 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4313 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4314 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4316 /* Set up expansion variables */
4317 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4318 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4319 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4320 prvscheck_address[myptr] = '\0';
4321 prvscheck_keynum = string_copy(key_num);
4323 /* Now expand the second argument */
4324 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs", &resetok))
4326 case 1: goto EXPAND_FAILED_CURLY;
4328 case 3: goto EXPAND_FAILED;
4331 /* Now we have the key and can check the address. */
4333 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4338 expand_string_message = US"hmac-sha1 conversion failed";
4342 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4343 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4345 if (Ustrcmp(p,hash) == 0)
4347 /* Success, valid BATV address. Now check the expiry date. */
4348 uschar *now = prvs_daystamp(0);
4349 unsigned int inow = 0,iexpire = 1;
4351 (void)sscanf(CS now,"%u",&inow);
4352 (void)sscanf(CS daystamp,"%u",&iexpire);
4354 /* When "iexpire" is < 7, a "flip" has occured.
4355 Adjust "inow" accordingly. */
4356 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4358 if (iexpire >= inow)
4360 prvscheck_result = US"1";
4361 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4365 prvscheck_result = NULL;
4366 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4371 prvscheck_result = NULL;
4372 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4375 /* Now expand the final argument. We leave this till now so that
4376 it can include $prvscheck_result. */
4378 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs", &resetok))
4380 case 1: goto EXPAND_FAILED_CURLY;
4382 case 3: goto EXPAND_FAILED;
4385 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4386 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4388 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4390 /* Reset the "internal" variables afterwards, because they are in
4391 dynamic store that will be reclaimed if the expansion succeeded. */
4393 prvscheck_address = NULL;
4394 prvscheck_keynum = NULL;
4398 /* Does not look like a prvs encoded address, return the empty string.
4399 We need to make sure all subs are expanded first, so as to skip over
4402 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs", &resetok))
4404 case 1: goto EXPAND_FAILED_CURLY;
4406 case 3: goto EXPAND_FAILED;
4413 /* Handle "readfile" to insert an entire file */
4415 case EITEM_READFILE:
4420 if ((expand_forbid & RDO_READFILE) != 0)
4422 expand_string_message = US"file insertions are not permitted";
4426 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile", &resetok))
4428 case 1: goto EXPAND_FAILED_CURLY;
4430 case 3: goto EXPAND_FAILED;
4433 /* If skipping, we don't actually do anything */
4435 if (skipping) continue;
4437 /* Open the file and read it */
4439 f = Ufopen(sub_arg[0], "rb");
4442 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4446 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4451 /* Handle "readsocket" to insert data from a Unix domain socket */
4453 case EITEM_READSOCK:
4459 struct sockaddr_un sockun; /* don't call this "sun" ! */
4463 if ((expand_forbid & RDO_READSOCK) != 0)
4465 expand_string_message = US"socket insertions are not permitted";
4469 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4470 because there may be a string for expansion on failure. */
4472 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket", &resetok))
4474 case 1: goto EXPAND_FAILED_CURLY;
4475 case 2: /* Won't occur: no end check */
4476 case 3: goto EXPAND_FAILED;
4479 /* Sort out timeout, if given */
4481 if (sub_arg[2] != NULL)
4483 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4486 expand_string_message = string_sprintf("bad time value %s",
4491 else sub_arg[3] = NULL; /* No eol if no timeout */
4493 /* If skipping, we don't actually do anything. Otherwise, arrange to
4494 connect to either an IP or a Unix socket. */
4498 /* Handle an IP (internet) domain */
4500 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4503 uschar *server_name = sub_arg[0] + 5;
4504 uschar *port_name = Ustrrchr(server_name, ':');
4506 /* Sort out the port */
4508 if (port_name == NULL)
4510 expand_string_message =
4511 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4514 *port_name++ = 0; /* Terminate server name */
4516 if (isdigit(*port_name))
4519 port = Ustrtol(port_name, &end, 0);
4520 if (end != port_name + Ustrlen(port_name))
4522 expand_string_message =
4523 string_sprintf("invalid port number %s", port_name);
4529 struct servent *service_info = getservbyname(CS port_name, "tcp");
4530 if (service_info == NULL)
4532 expand_string_message = string_sprintf("unknown port \"%s\"",
4536 port = ntohs(service_info->s_port);
4539 if ((fd = ip_connectedsocket(SOCK_STREAM, server_name, port, port,
4540 timeout, NULL, &expand_string_message)) < 0)
4544 /* Handle a Unix domain socket */
4549 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4551 expand_string_message = string_sprintf("failed to create socket: %s",
4556 sockun.sun_family = AF_UNIX;
4557 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4560 sigalrm_seen = FALSE;
4562 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4566 expand_string_message = US "socket connect timed out";
4571 expand_string_message = string_sprintf("failed to connect to socket "
4572 "%s: %s", sub_arg[0], strerror(errno));
4577 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4579 /* Write the request string, if not empty */
4581 if (sub_arg[1][0] != 0)
4583 int len = Ustrlen(sub_arg[1]);
4584 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4586 if (write(fd, sub_arg[1], len) != len)
4588 expand_string_message = string_sprintf("request write to socket "
4589 "failed: %s", strerror(errno));
4594 /* Shut down the sending side of the socket. This helps some servers to
4595 recognise that it is their turn to do some work. Just in case some
4596 system doesn't have this function, make it conditional. */
4599 shutdown(fd, SHUT_WR);
4602 /* Now we need to read from the socket, under a timeout. The function
4603 that reads a file can be used. */
4605 f = fdopen(fd, "rb");
4606 sigalrm_seen = FALSE;
4608 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4612 /* After a timeout, we restore the pointer in the result, that is,
4613 make sure we add nothing from the socket. */
4618 expand_string_message = US "socket read timed out";
4623 /* The whole thing has worked (or we were skipping). If there is a
4624 failure string following, we need to skip it. */
4628 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE, &resetok) == NULL)
4630 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4631 while (isspace(*s)) s++;
4633 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4636 /* Come here on failure to create socket, connect socket, write to the
4637 socket, or timeout on reading. If another substring follows, expand and
4638 use it. Otherwise, those conditions give expand errors. */
4641 if (*s != '{') goto EXPAND_FAILED;
4642 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4643 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE, &resetok);
4644 if (arg == NULL) goto EXPAND_FAILED;
4645 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4646 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4647 while (isspace(*s)) s++;
4648 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4652 /* Handle "run" to execute a program. */
4664 if ((expand_forbid & RDO_RUN) != 0)
4666 expand_string_message = US"running a command is not permitted";
4670 while (isspace(*s)) s++;
4671 if (*s != '{') goto EXPAND_FAILED_CURLY;
4672 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
4673 if (arg == NULL) goto EXPAND_FAILED;
4674 while (isspace(*s)) s++;
4675 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4677 if (skipping) /* Just pretend it worked when we're skipping */
4683 if (!transport_set_up_command(&argv, /* anchor for arg list */
4684 arg, /* raw command */
4685 FALSE, /* don't expand the arguments */
4686 0, /* not relevant when... */
4687 NULL, /* no transporting address */
4688 US"${run} expansion", /* for error messages */
4689 &expand_string_message)) /* where to put error message */
4694 /* Create the child process, making it a group leader. */
4696 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4700 expand_string_message =
4701 string_sprintf("couldn't create child process: %s", strerror(errno));
4705 /* Nothing is written to the standard input. */
4709 /* Read the pipe to get the command's output into $value (which is kept
4710 in lookup_value). Read during execution, so that if the output exceeds
4711 the OS pipe buffer limit, we don't block forever. */
4713 f = fdopen(fd_out, "rb");
4714 sigalrm_seen = FALSE;
4716 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4720 /* Wait for the process to finish, applying the timeout, and inspect its
4721 return code for serious disasters. Simple non-zero returns are passed on.
4724 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4726 if (sigalrm_seen == TRUE || runrc == -256)
4728 expand_string_message = string_sprintf("command timed out");
4729 killpg(pid, SIGKILL); /* Kill the whole process group */
4732 else if (runrc == -257)
4733 expand_string_message = string_sprintf("wait() failed: %s",
4737 expand_string_message = string_sprintf("command killed by signal %d",
4744 /* Process the yes/no strings; $value may be useful in both cases */
4746 switch(process_yesno(
4747 skipping, /* were previously skipping */
4748 runrc == 0, /* success/failure indicator */
4749 lookup_value, /* value to reset for string2 */
4750 &s, /* input pointer */
4751 &yield, /* output pointer */
4752 &size, /* output size */
4753 &ptr, /* output current point */
4754 US"run", /* condition type */
4757 case 1: goto EXPAND_FAILED; /* when all is well, the */
4758 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4764 /* Handle character translation for "tr" */
4772 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr", &resetok))
4774 case 1: goto EXPAND_FAILED_CURLY;
4776 case 3: goto EXPAND_FAILED;
4779 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4780 o2m = Ustrlen(sub[2]) - 1;
4782 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4784 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4788 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4795 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4796 expanded arguments. */
4806 int val[2] = { 0, -1 };
4809 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4810 Ensure that sub[2] is set in the ${length } case. */
4813 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4814 TRUE, name, &resetok))
4816 case 1: goto EXPAND_FAILED_CURLY;
4818 case 3: goto EXPAND_FAILED;
4821 /* Juggle the arguments if there are only two of them: always move the
4822 string to the last position and make ${length{n}{str}} equivalent to
4823 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4829 if (item_type == EITEM_LENGTH)
4836 for (i = 0; i < 2; i++)
4838 if (sub[i] == NULL) continue;
4839 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4840 if (*ret != 0 || (i != 0 && val[i] < 0))
4842 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4843 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4849 (item_type == EITEM_HASH)?
4850 compute_hash(sub[2], val[0], val[1], &len) :
4851 (item_type == EITEM_NHASH)?
4852 compute_nhash(sub[2], val[0], val[1], &len) :
4853 extract_substr(sub[2], val[0], val[1], &len);
4855 if (ret == NULL) goto EXPAND_FAILED;
4856 yield = string_cat(yield, &size, &ptr, ret, len);
4860 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4861 This code originally contributed by Steve Haslam. It currently supports
4862 the use of MD5 and SHA-1 hashes.
4864 We need some workspace that is large enough to handle all the supported
4865 hash types. Use macros to set the sizes rather than be too elaborate. */
4867 #define MAX_HASHLEN 20
4868 #define MAX_HASHBLOCKLEN 64
4877 int hashlen; /* Number of octets for the hash algorithm's output */
4878 int hashblocklen; /* Number of octets the hash algorithm processes */
4880 unsigned int keylen;
4882 uschar keyhash[MAX_HASHLEN];
4883 uschar innerhash[MAX_HASHLEN];
4884 uschar finalhash[MAX_HASHLEN];
4885 uschar finalhash_hex[2*MAX_HASHLEN];
4886 uschar innerkey[MAX_HASHBLOCKLEN];
4887 uschar outerkey[MAX_HASHBLOCKLEN];
4889 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name, &resetok))
4891 case 1: goto EXPAND_FAILED_CURLY;
4893 case 3: goto EXPAND_FAILED;
4896 if (Ustrcmp(sub[0], "md5") == 0)
4899 use_base = &md5_base;
4903 else if (Ustrcmp(sub[0], "sha1") == 0)
4906 use_base = &sha1_base;
4912 expand_string_message =
4913 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4918 keylen = Ustrlen(keyptr);
4920 /* If the key is longer than the hash block length, then hash the key
4923 if (keylen > hashblocklen)
4925 chash_start(type, use_base);
4926 chash_end(type, use_base, keyptr, keylen, keyhash);
4931 /* Now make the inner and outer key values */
4933 memset(innerkey, 0x36, hashblocklen);
4934 memset(outerkey, 0x5c, hashblocklen);
4936 for (i = 0; i < keylen; i++)
4938 innerkey[i] ^= keyptr[i];
4939 outerkey[i] ^= keyptr[i];
4942 /* Now do the hashes */
4944 chash_start(type, use_base);
4945 chash_mid(type, use_base, innerkey);
4946 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4948 chash_start(type, use_base);
4949 chash_mid(type, use_base, outerkey);
4950 chash_end(type, use_base, innerhash, hashlen, finalhash);
4952 /* Encode the final hash as a hex string */
4955 for (i = 0; i < hashlen; i++)
4957 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4958 *p++ = hex_digits[finalhash[i] & 0x0f];
4961 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4962 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4964 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4969 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4970 We have to save the numerical variables and restore them afterwards. */
4975 int moffset, moffsetextra, slen;
4978 const uschar *rerror;
4981 int save_expand_nmax =
4982 save_expand_strings(save_expand_nstring, save_expand_nlength);
4984 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg", &resetok))
4986 case 1: goto EXPAND_FAILED_CURLY;
4988 case 3: goto EXPAND_FAILED;
4991 /* Compile the regular expression */
4993 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4998 expand_string_message = string_sprintf("regular expression error in "
4999 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5003 /* Now run a loop to do the substitutions as often as necessary. It ends
5004 when there are no more matches. Take care over matches of the null string;
5005 do the same thing as Perl does. */
5008 slen = Ustrlen(sub[0]);
5009 moffset = moffsetextra = 0;
5014 int ovector[3*(EXPAND_MAXN+1)];
5015 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5016 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5020 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5021 is not necessarily the end. We want to repeat the match from one
5022 character further along, but leaving the basic offset the same (for
5023 copying below). We can't be at the end of the string - that was checked
5024 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5025 finished; copy the remaining string and end the loop. */
5035 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5039 /* Match - set up for expanding the replacement. */
5041 if (n == 0) n = EXPAND_MAXN + 1;
5043 for (nn = 0; nn < n*2; nn += 2)
5045 expand_nstring[expand_nmax] = subject + ovector[nn];
5046 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5050 /* Copy the characters before the match, plus the expanded insertion. */
5052 yield = string_cat(yield, &size, &ptr, subject + moffset,
5053 ovector[0] - moffset);
5054 insert = expand_string(sub[2]);
5055 if (insert == NULL) goto EXPAND_FAILED;
5056 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5058 moffset = ovector[1];
5062 /* If we have matched an empty string, first check to see if we are at
5063 the end of the subject. If so, the loop is over. Otherwise, mimic
5064 what Perl's /g options does. This turns out to be rather cunning. First
5065 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5066 string at the same point. If this fails (picked up above) we advance to
5067 the next character. */
5069 if (ovector[0] == ovector[1])
5071 if (ovector[0] == slen) break;
5072 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5076 /* All done - restore numerical variables. */
5078 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5079 save_expand_nlength);
5083 /* Handle keyed and numbered substring extraction. If the first argument
5084 consists entirely of digits, then a numerical extraction is assumed. */
5090 int field_number = 1;
5091 BOOL field_number_set = FALSE;
5092 uschar *save_lookup_value = lookup_value;
5094 int save_expand_nmax =
5095 save_expand_strings(save_expand_nstring, save_expand_nlength);
5097 /* Read the arguments */
5099 for (i = 0; i < j; i++)
5101 while (isspace(*s)) s++;
5102 if (*s == '{') /*}*/
5104 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5105 if (sub[i] == NULL) goto EXPAND_FAILED; /*{*/
5106 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5108 /* After removal of leading and trailing white space, the first
5109 argument must not be empty; if it consists entirely of digits
5110 (optionally preceded by a minus sign), this is a numerical
5111 extraction, and we expect 3 arguments. */
5119 while (isspace(*p)) p++;
5123 while (len > 0 && isspace(p[len-1])) len--;
5126 if (*p == 0 && !skipping)
5128 expand_string_message = US"first argument of \"extract\" must "
5138 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5142 j = 3; /* Need 3 args */
5143 field_number_set = TRUE;
5147 else goto EXPAND_FAILED_CURLY;
5150 /* Extract either the numbered or the keyed substring into $value. If
5151 skipping, just pretend the extraction failed. */
5153 lookup_value = skipping? NULL : field_number_set?
5154 expand_gettokened(field_number, sub[1], sub[2]) :
5155 expand_getkeyed(sub[0], sub[1]);
5157 /* If no string follows, $value gets substituted; otherwise there can
5158 be yes/no strings, as for lookup or if. */
5160 switch(process_yesno(
5161 skipping, /* were previously skipping */
5162 lookup_value != NULL, /* success/failure indicator */
5163 save_lookup_value, /* value to reset for string2 */
5164 &s, /* input pointer */
5165 &yield, /* output pointer */
5166 &size, /* output size */
5167 &ptr, /* output current point */
5168 US"extract", /* condition type */
5171 case 1: goto EXPAND_FAILED; /* when all is well, the */
5172 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5175 /* All done - restore numerical variables. */
5177 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5178 save_expand_nlength);
5183 /* return the Nth item from a list */
5185 case EITEM_LISTEXTRACT:
5188 int field_number = 1;
5189 uschar *save_lookup_value = lookup_value;
5191 int save_expand_nmax =
5192 save_expand_strings(save_expand_nstring, save_expand_nlength);
5194 /* Read the field & list arguments */
5196 for (i = 0; i < 2; i++)
5198 while (isspace(*s)) s++;
5199 if (*s != '{') /*}*/
5200 goto EXPAND_FAILED_CURLY;
5202 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5203 if (!sub[i]) goto EXPAND_FAILED; /*{*/
5204 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5206 /* After removal of leading and trailing white space, the first
5207 argument must be numeric and nonempty. */
5215 while (isspace(*p)) p++;
5219 while (len > 0 && isspace(p[len-1])) len--;
5222 if (!*p && !skipping)
5224 expand_string_message = US"first argument of \"listextract\" must "
5234 while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
5237 expand_string_message = US"first argument of \"listextract\" must "
5245 /* Extract the numbered element into $value. If
5246 skipping, just pretend the extraction failed. */
5248 lookup_value = skipping? NULL : expand_getlistele(field_number, sub[1]);
5250 /* If no string follows, $value gets substituted; otherwise there can
5251 be yes/no strings, as for lookup or if. */
5253 switch(process_yesno(
5254 skipping, /* were previously skipping */
5255 lookup_value != NULL, /* success/failure indicator */
5256 save_lookup_value, /* value to reset for string2 */
5257 &s, /* input pointer */
5258 &yield, /* output pointer */
5259 &size, /* output size */
5260 &ptr, /* output current point */
5261 US"extract", /* condition type */
5264 case 1: goto EXPAND_FAILED; /* when all is well, the */
5265 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5268 /* All done - restore numerical variables. */
5270 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5271 save_expand_nlength);
5276 /* Handle list operations */
5284 uschar outsep[2] = { '\0', '\0' };
5285 uschar *list, *expr, *temp;
5286 uschar *save_iterate_item = iterate_item;
5287 uschar *save_lookup_value = lookup_value;
5289 while (isspace(*s)) s++;
5290 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5292 list = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5293 if (list == NULL) goto EXPAND_FAILED;
5294 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5296 if (item_type == EITEM_REDUCE)
5298 while (isspace(*s)) s++;
5299 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5300 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE, &resetok);
5301 if (temp == NULL) goto EXPAND_FAILED;
5302 lookup_value = temp;
5303 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5306 while (isspace(*s)) s++;
5307 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5311 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5312 if scanning a "false" part). This allows us to find the end of the
5313 condition, because if the list is empty, we won't actually evaluate the
5314 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5315 the normal internal expansion function. */
5317 if (item_type == EITEM_FILTER)
5319 temp = eval_condition(expr, &resetok, NULL);
5320 if (temp != NULL) s = temp;
5324 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE, &resetok);
5329 expand_string_message = string_sprintf("%s inside \"%s\" item",
5330 expand_string_message, name);
5334 while (isspace(*s)) s++;
5337 expand_string_message = string_sprintf("missing } at end of condition "
5338 "or expression inside \"%s\"", name);
5342 while (isspace(*s)) s++; /*{*/
5345 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5350 /* If we are skipping, we can now just move on to the next item. When
5351 processing for real, we perform the iteration. */
5353 if (skipping) continue;
5354 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5356 *outsep = (uschar)sep; /* Separator as a string */
5358 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5360 if (item_type == EITEM_FILTER)
5363 if (eval_condition(expr, &resetok, &condresult) == NULL)
5365 iterate_item = save_iterate_item;
5366 lookup_value = save_lookup_value;
5367 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5368 expand_string_message, name);
5371 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5372 condresult? "true":"false");
5374 temp = iterate_item; /* TRUE => include this item */
5376 continue; /* FALSE => skip this item */
5379 /* EITEM_MAP and EITEM_REDUCE */
5383 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE, &resetok);
5386 iterate_item = save_iterate_item;
5387 expand_string_message = string_sprintf("%s inside \"%s\" item",
5388 expand_string_message, name);
5391 if (item_type == EITEM_REDUCE)
5393 lookup_value = temp; /* Update the value of $value */
5394 continue; /* and continue the iteration */
5398 /* We reach here for FILTER if the condition is true, always for MAP,
5399 and never for REDUCE. The value in "temp" is to be added to the output
5400 list that is being created, ensuring that any occurrences of the
5401 separator character are doubled. Unless we are dealing with the first
5402 item of the output list, add in a space if the new item begins with the
5403 separator character, or is an empty string. */
5405 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5406 yield = string_cat(yield, &size, &ptr, US" ", 1);
5408 /* Add the string in "temp" to the output list that we are building,
5409 This is done in chunks by searching for the separator character. */
5413 size_t seglen = Ustrcspn(temp, outsep);
5414 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5416 /* If we got to the end of the string we output one character
5417 too many; backup and end the loop. Otherwise arrange to double the
5420 if (temp[seglen] == '\0') { ptr--; break; }
5421 yield = string_cat(yield, &size, &ptr, outsep, 1);
5425 /* Output a separator after the string: we will remove the redundant
5426 final one at the end. */
5428 yield = string_cat(yield, &size, &ptr, outsep, 1);
5429 } /* End of iteration over the list loop */
5431 /* REDUCE has generated no output above: output the final value of
5434 if (item_type == EITEM_REDUCE)
5436 yield = string_cat(yield, &size, &ptr, lookup_value,
5437 Ustrlen(lookup_value));
5438 lookup_value = save_lookup_value; /* Restore $value */
5441 /* FILTER and MAP generate lists: if they have generated anything, remove
5442 the redundant final separator. Even though an empty item at the end of a
5443 list does not count, this is tidier. */
5445 else if (ptr != save_ptr) ptr--;
5447 /* Restore preserved $item */
5449 iterate_item = save_iterate_item;
5454 /* If ${dlfunc } support is configured, handle calling dynamically-loaded
5455 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5456 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5457 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5459 #define EXPAND_DLFUNC_MAX_ARGS 8
5462 #ifndef EXPAND_DLFUNC
5463 expand_string_message = US"\"${dlfunc\" encountered, but this facility " /*}*/
5464 "is not included in this binary";
5467 #else /* EXPAND_DLFUNC */
5470 exim_dlfunc_t *func;
5473 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5475 if ((expand_forbid & RDO_DLFUNC) != 0)
5477 expand_string_message =
5478 US"dynamically-loaded functions are not permitted";
5482 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5483 TRUE, US"dlfunc", &resetok))
5485 case 1: goto EXPAND_FAILED_CURLY;
5487 case 3: goto EXPAND_FAILED;
5490 /* If skipping, we don't actually do anything */
5492 if (skipping) continue;
5494 /* Look up the dynamically loaded object handle in the tree. If it isn't
5495 found, dlopen() the file and put the handle in the tree for next time. */
5497 t = tree_search(dlobj_anchor, argv[0]);
5500 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5503 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5504 argv[0], dlerror());
5505 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5508 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5509 Ustrcpy(t->name, argv[0]);
5510 t->data.ptr = handle;
5511 (void)tree_insertnode(&dlobj_anchor, t);
5514 /* Having obtained the dynamically loaded object handle, look up the
5515 function pointer. */
5517 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5520 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5521 "%s", argv[1], argv[0], dlerror());
5522 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5526 /* Call the function and work out what to do with the result. If it
5527 returns OK, we have a replacement string; if it returns DEFER then
5528 expansion has failed in a non-forced manner; if it returns FAIL then
5529 failure was forced; if it returns ERROR or any other value there's a
5530 problem, so panic slightly. In any case, assume that the function has
5531 side-effects on the store that must be preserved. */
5535 for (argc = 0; argv[argc] != NULL; argc++);
5536 status = func(&result, argc - 2, &argv[2]);
5539 if (result == NULL) result = US"";
5540 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5545 expand_string_message = result == NULL ? US"(no message)" : result;
5546 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5547 else if(status != FAIL)
5548 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5549 argv[0], argv[1], status, expand_string_message);
5553 #endif /* EXPAND_DLFUNC */
5554 } /* EITEM_* switch */
5556 /* Control reaches here if the name is not recognized as one of the more
5557 complicated expansion items. Check for the "operator" syntax (name terminated
5558 by a colon). Some of the operators have arguments, separated by _ from the
5565 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE, &resetok);
5566 if (sub == NULL) goto EXPAND_FAILED;
5569 /* Owing to an historical mis-design, an underscore may be part of the
5570 operator name, or it may introduce arguments. We therefore first scan the
5571 table of names that contain underscores. If there is no match, we cut off
5572 the arguments and then scan the main table. */
5574 c = chop_match(name, op_table_underscore,
5575 sizeof(op_table_underscore)/sizeof(uschar *));
5579 arg = Ustrchr(name, '_');
5580 if (arg != NULL) *arg = 0;
5581 c = chop_match(name, op_table_main,
5582 sizeof(op_table_main)/sizeof(uschar *));
5583 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5584 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5587 /* If we are skipping, we don't need to perform the operation at all.
5588 This matters for operations like "mask", because the data may not be
5589 in the correct format when skipping. For example, the expression may test
5590 for the existence of $sender_host_address before trying to mask it. For
5591 other operations, doing them may not fail, but it is a waste of time. */
5593 if (skipping && c >= 0) continue;
5595 /* Otherwise, switch on the operator type */
5602 unsigned long int n = Ustrtoul(sub, &t, 10);
5605 expand_string_message = string_sprintf("argument for base62 "
5606 "operator is \"%s\", which is not a decimal number", sub);
5609 t = string_base62(n);
5610 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5614 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5620 unsigned long int n = 0;
5623 uschar *t = Ustrchr(base62_chars, *tt++);
5626 expand_string_message = string_sprintf("argument for base62d "
5627 "operator is \"%s\", which is not a base %d number", sub,
5631 n = n * BASE_62 + (t - base62_chars);
5633 (void)sprintf(CS buf, "%ld", n);
5634 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5640 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE, &resetok);
5641 if (expanded == NULL)
5643 expand_string_message =
5644 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5645 expand_string_message);
5648 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5655 uschar *t = sub - 1;
5656 while (*(++t) != 0) { *t = tolower(*t); count++; }
5657 yield = string_cat(yield, &size, &ptr, sub, count);
5664 uschar *t = sub - 1;
5665 while (*(++t) != 0) { *t = toupper(*t); count++; }
5666 yield = string_cat(yield, &size, &ptr, sub, count);
5677 md5_end(&base, sub, Ustrlen(sub), digest);
5678 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5679 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5690 sha1_end(&base, sub, Ustrlen(sub), digest);
5691 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5692 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5696 /* Convert hex encoding to base64 encoding */
5706 for (enc = sub; *enc != 0; enc++)
5708 if (!isxdigit(*enc))
5710 expand_string_message = string_sprintf("\"%s\" is not a hex "
5719 expand_string_message = string_sprintf("\"%s\" contains an odd "
5720 "number of characters", sub);
5724 while ((c = *in++) != 0)
5726 if (isdigit(c)) c -= '0';
5727 else c = toupper(c) - 'A' + 10;
5739 enc = auth_b64encode(sub, out - sub);
5740 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5744 /* Convert octets outside 0x21..0x7E to \xXX form */
5748 uschar *t = sub - 1;
5751 if (*t < 0x21 || 0x7E < *t)
5752 yield = string_cat(yield, &size, &ptr,
5753 string_sprintf("\\x%02x", *t), 4);
5755 yield = string_cat(yield, &size, &ptr, t, 1);
5760 /* count the number of list elements */
5769 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5770 cp = string_sprintf("%d", cnt);
5771 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5775 /* expand a named list given the name */
5776 /* handles nested named lists; requotes as colon-sep list */
5780 tree_node *t = NULL;
5784 uschar * suffix = US"";
5785 BOOL needsep = FALSE;
5788 if (*sub == '+') sub++;
5789 if (arg == NULL) /* no-argument version */
5791 if (!(t = tree_search(addresslist_anchor, sub)) &&
5792 !(t = tree_search(domainlist_anchor, sub)) &&
5793 !(t = tree_search(hostlist_anchor, sub)))
5794 t = tree_search(localpartlist_anchor, sub);
5796 else switch(*arg) /* specific list-type version */
5798 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
5799 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
5800 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
5801 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
5803 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5809 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5811 : *arg=='a'?"address "
5812 : *arg=='d'?"domain "
5814 : *arg=='l'?"localpart "
5819 list = ((namedlist_block *)(t->data.ptr))->string;
5821 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5823 uschar * buf = US" : ";
5825 yield = string_cat(yield, &size, &ptr, buf, 3);
5829 if (*item == '+') /* list item is itself a named list */
5831 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5832 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE, &resetok);
5834 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5838 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5839 while ((cp= strpbrk((const char *)item, tok)))
5841 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5842 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5844 yield = string_cat(yield, &size, &ptr, US"::", 2);
5845 item = (uschar *)cp;
5847 else /* sep in item; should already be doubled; emit once */
5849 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5850 if (*cp == sep) cp++;
5851 item = (uschar *)cp;
5855 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5860 /* mask applies a mask to an IP address; for example the result of
5861 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5868 int mask, maskoffset;
5869 int type = string_is_ip_address(sub, &maskoffset);
5874 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5879 if (maskoffset == 0)
5881 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5886 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5888 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5890 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5895 /* Convert the address to binary integer(s) and apply the mask */
5897 sub[maskoffset] = 0;
5898 count = host_aton(sub, binary);
5899 host_mask(count, binary, mask);
5901 /* Convert to masked textual format and add to output. */
5903 yield = string_cat(yield, &size, &ptr, buffer,
5904 host_nmtoa(count, binary, mask, buffer, '.'));
5909 case EOP_LOCAL_PART:
5913 int start, end, domain;
5914 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5918 if (c != EOP_DOMAIN)
5920 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5921 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5923 else if (domain != 0)
5926 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5934 uschar outsep[2] = { ':', '\0' };
5935 uschar *address, *error;
5937 int start, end, domain; /* Not really used */
5939 while (isspace(*sub)) sub++;
5940 if (*sub == '>') { *outsep = *++sub; ++sub; }
5941 parse_allow_group = TRUE;
5945 uschar *p = parse_find_address_end(sub, FALSE);
5946 uschar saveend = *p;
5948 address = parse_extract_address(sub, &error, &start, &end, &domain,
5952 /* Add the address to the output list that we are building. This is
5953 done in chunks by searching for the separator character. At the
5954 start, unless we are dealing with the first address of the output
5955 list, add in a space if the new address begins with the separator
5956 character, or is an empty string. */
5958 if (address != NULL)
5960 if (ptr != save_ptr && address[0] == *outsep)
5961 yield = string_cat(yield, &size, &ptr, US" ", 1);
5965 size_t seglen = Ustrcspn(address, outsep);
5966 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5968 /* If we got to the end of the string we output one character
5971 if (address[seglen] == '\0') { ptr--; break; }
5972 yield = string_cat(yield, &size, &ptr, outsep, 1);
5973 address += seglen + 1;
5976 /* Output a separator after the string: we will remove the
5977 redundant final one at the end. */
5979 yield = string_cat(yield, &size, &ptr, outsep, 1);
5982 if (saveend == '\0') break;
5986 /* If we have generated anything, remove the redundant final
5989 if (ptr != save_ptr) ptr--;
5990 parse_allow_group = FALSE;
5995 /* quote puts a string in quotes if it is empty or contains anything
5996 other than alphamerics, underscore, dot, or hyphen.
5998 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5999 be quoted in order to be a valid local part.
6001 In both cases, newlines and carriage returns are converted into \n and \r
6005 case EOP_QUOTE_LOCAL_PART:
6008 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
6009 uschar *t = sub - 1;
6013 while (!needs_quote && *(++t) != 0)
6014 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
6016 else /* EOP_QUOTE_LOCAL_PART */
6018 while (!needs_quote && *(++t) != 0)
6019 needs_quote = !isalnum(*t) &&
6020 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
6021 (*t != '.' || t == sub || t[1] == 0);
6026 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6031 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
6032 else if (*t == '\r')
6033 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
6036 if (*t == '\\' || *t == '"')
6037 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6038 yield = string_cat(yield, &size, &ptr, t, 1);
6041 yield = string_cat(yield, &size, &ptr, US"\"", 1);
6043 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6047 /* quote_lookuptype does lookup-specific quoting */
6052 uschar *opt = Ustrchr(arg, '_');
6054 if (opt != NULL) *opt++ = 0;
6056 n = search_findtype(arg, Ustrlen(arg));
6059 expand_string_message = search_error_message;
6063 if (lookup_list[n]->quote != NULL)
6064 sub = (lookup_list[n]->quote)(sub, opt);
6065 else if (opt != NULL) sub = NULL;
6069 expand_string_message = string_sprintf(
6070 "\"%s\" unrecognized after \"${quote_%s\"",
6075 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6079 /* rx quote sticks in \ before any non-alphameric character so that
6080 the insertion works in a regular expression. */
6084 uschar *t = sub - 1;
6088 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6089 yield = string_cat(yield, &size, &ptr, t, 1);
6094 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6095 prescribed by the RFC, if there are characters that need to be encoded */
6099 uschar buffer[2048];
6100 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6101 buffer, sizeof(buffer), FALSE);
6102 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6106 /* RFC 2047 decode */
6112 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6113 headers_charset, '?', &len, &error);
6116 expand_string_message = error;
6119 yield = string_cat(yield, &size, &ptr, decoded, len);
6123 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6133 if (c > 255) c = '_';
6135 yield = string_cat(yield, &size, &ptr, buff, 1);
6140 /* replace illegal UTF-8 sequences by replacement character */
6142 #define UTF8_REPLACEMENT_CHAR US"?"
6146 int seq_len, index = 0;
6148 uschar seq_buff[4]; /* accumulate utf-8 here */
6160 if ((c & 0xc0) != 0x80)
6162 /* wrong continuation byte; invalidate all bytes */
6163 complete = 1; /* error */
6167 codepoint = (codepoint << 6) | (c & 0x3f);
6168 seq_buff[index++] = c;
6169 if (--bytes_left == 0) /* codepoint complete */
6171 if(codepoint > 0x10FFFF) /* is it too large? */
6172 complete = -1; /* error */
6174 { /* finished; output utf-8 sequence */
6175 yield = string_cat(yield, &size, &ptr, seq_buff, seq_len);
6181 else /* no bytes left: new sequence */
6183 if((c & 0x80) == 0) /* 1-byte sequence, US-ASCII, keep it */
6185 yield = string_cat(yield, &size, &ptr, &c, 1);
6188 if((c & 0xe0) == 0xc0) /* 2-byte sequence */
6191 codepoint = c & 0x1f;
6193 else if((c & 0xf0) == 0xe0) /* 3-byte sequence */
6196 codepoint = c & 0x0f;
6198 else if((c & 0xf8) == 0xf0) /* 4-byte sequence */
6201 codepoint = c & 0x07;
6203 else /* invalid or too long (RFC3629 allows only 4 bytes) */
6206 seq_buff[index++] = c;
6207 seq_len = bytes_left + 1;
6208 } /* if(bytes_left) */
6212 bytes_left = index = 0;
6213 yield = string_cat(yield, &size, &ptr, UTF8_REPLACEMENT_CHAR, 1);
6215 if ((complete == 1) && ((c & 0x80) == 0))
6216 { /* ASCII character follows incomplete sequence */
6217 yield = string_cat(yield, &size, &ptr, &c, 1);
6223 /* escape turns all non-printing characters into escape sequences. */
6227 uschar *t = string_printing(sub);
6228 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6232 /* Handle numeric expression evaluation */
6237 uschar *save_sub = sub;
6238 uschar *error = NULL;
6239 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6242 expand_string_message = string_sprintf("error in expression "
6243 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6247 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6248 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6252 /* Handle time period formating */
6256 int n = readconf_readtime(sub, 0, FALSE);
6259 expand_string_message = string_sprintf("string \"%s\" is not an "
6260 "Exim time interval in \"%s\" operator", sub, name);
6263 sprintf(CS var_buffer, "%d", n);
6264 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6268 case EOP_TIME_INTERVAL:
6271 uschar *t = read_number(&n, sub);
6272 if (*t != 0) /* Not A Number*/
6274 expand_string_message = string_sprintf("string \"%s\" is not a "
6275 "positive number in \"%s\" operator", sub, name);
6278 t = readconf_printtime(n);
6279 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6283 /* Convert string to base64 encoding */
6287 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6288 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6292 /* strlen returns the length of the string */
6297 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6298 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6302 /* length_n or l_n takes just the first n characters or the whole string,
6303 whichever is the shorter;
6305 substr_m_n, and s_m_n take n characters from offset m; negative m take
6306 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6307 takes the rest, either to the right or to the left.
6309 hash_n or h_n makes a hash of length n from the string, yielding n
6310 characters from the set a-z; hash_n_m makes a hash of length n, but
6311 uses m characters from the set a-zA-Z0-9.
6313 nhash_n returns a single number between 0 and n-1 (in text form), while
6314 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6315 between 0 and n-1 and the second between 0 and m-1. */
6335 expand_string_message = string_sprintf("missing values after %s",
6340 /* "length" has only one argument, effectively being synonymous with
6343 if (c == EOP_LENGTH || c == EOP_L)
6349 /* The others have one or two arguments; for "substr" the first may be
6350 negative. The second being negative means "not supplied". */
6355 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6358 /* Read up to two numbers, separated by underscores */
6363 if (arg != ret && *arg == '_' && pn == &value1)
6367 if (arg[1] != 0) arg++;
6369 else if (!isdigit(*arg))
6371 expand_string_message =
6372 string_sprintf("non-digit after underscore in \"%s\"", name);
6375 else *pn = (*pn)*10 + *arg++ - '0';
6379 /* Perform the required operation */
6382 (c == EOP_HASH || c == EOP_H)?
6383 compute_hash(sub, value1, value2, &len) :
6384 (c == EOP_NHASH || c == EOP_NH)?
6385 compute_nhash(sub, value1, value2, &len) :
6386 extract_substr(sub, value1, value2, &len);
6388 if (ret == NULL) goto EXPAND_FAILED;
6389 yield = string_cat(yield, &size, &ptr, ret, len);
6399 uschar **modetable[3];
6404 if ((expand_forbid & RDO_EXISTS) != 0)
6406 expand_string_message = US"Use of the stat() expansion is not permitted";
6410 if (stat(CS sub, &st) < 0)
6412 expand_string_message = string_sprintf("stat(%s) failed: %s",
6413 sub, strerror(errno));
6417 switch (mode & S_IFMT)
6419 case S_IFIFO: smode[0] = 'p'; break;
6420 case S_IFCHR: smode[0] = 'c'; break;
6421 case S_IFDIR: smode[0] = 'd'; break;
6422 case S_IFBLK: smode[0] = 'b'; break;
6423 case S_IFREG: smode[0] = '-'; break;
6424 default: smode[0] = '?'; break;
6427 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6428 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6429 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6431 for (i = 0; i < 3; i++)
6433 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6438 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6439 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6440 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6441 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6442 (long)st.st_gid, st.st_size, (long)st.st_atime,
6443 (long)st.st_mtime, (long)st.st_ctime);
6444 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6448 /* vaguely random number less than N */
6452 int_eximarith_t max;
6455 max = expand_string_integer(sub, TRUE);
6456 if (expand_string_message != NULL)
6458 s = string_sprintf("%d", vaguely_random_number((int)max));
6459 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6463 /* Reverse IP, including IPv6 to dotted-nibble */
6465 case EOP_REVERSE_IP:
6467 int family, maskptr;
6468 uschar reversed[128];
6470 family = string_is_ip_address(sub, &maskptr);
6473 expand_string_message = string_sprintf(
6474 "reverse_ip() not given an IP address [%s]", sub);
6477 invert_address(reversed, sub);
6478 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6482 /* Unknown operator */
6485 expand_string_message =
6486 string_sprintf("unknown expansion operator \"%s\"", name);
6491 /* Handle a plain name. If this is the first thing in the expansion, release
6492 the pre-allocated buffer. If the result data is known to be in a new buffer,
6493 newsize will be set to the size of that buffer, and we can just point at that
6494 store instead of copying. Many expansion strings contain just one reference,
6495 so this is a useful optimization, especially for humungous headers
6496 ($message_headers). */
6504 if (resetok) store_reset(yield);
6508 value = find_variable(name, FALSE, skipping, &newsize);
6511 expand_string_message =
6512 string_sprintf("unknown variable in \"${%s}\"", name);
6513 check_variable_error_message(name);
6516 len = Ustrlen(value);
6517 if (yield == NULL && newsize != 0)
6523 else yield = string_cat(yield, &size, &ptr, value, len);
6527 /* Else there's something wrong */
6529 expand_string_message =
6530 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6531 "in a variable reference)", name);
6535 /* If we hit the end of the string when ket_ends is set, there is a missing
6536 terminating brace. */
6538 if (ket_ends && *s == 0)
6540 expand_string_message = malformed_header?
6541 US"missing } at end of string - could be header name not terminated by colon"
6543 US"missing } at end of string";
6547 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6548 added to the string. If so, set up an empty string. Add a terminating zero. If
6549 left != NULL, return a pointer to the terminator. */
6551 if (yield == NULL) yield = store_get(1);
6553 if (left != NULL) *left = s;
6555 /* Any stacking store that was used above the final string is no longer needed.
6556 In many cases the final string will be the first one that was got and so there
6557 will be optimal store usage. */
6559 if (resetok) store_reset(yield + ptr + 1);
6560 else if (resetok_p) *resetok_p = FALSE;
6564 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6566 if (skipping) debug_printf("skipping: result is not used\n");
6570 /* This is the failure exit: easiest to program with a goto. We still need
6571 to update the pointer to the terminator, for cases of nested calls with "fail".
6574 EXPAND_FAILED_CURLY:
6575 expand_string_message = malformed_header?
6576 US"missing or misplaced { or } - could be header name not terminated by colon"
6578 US"missing or misplaced { or }";
6580 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6581 that is a bad idea, because expand_string_message is in dynamic store. */
6584 if (left != NULL) *left = s;
6587 debug_printf("failed to expand: %s\n", string);
6588 debug_printf(" error message: %s\n", expand_string_message);
6589 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6591 if (resetok_p) *resetok_p = resetok;
6596 /* This is the external function call. Do a quick check for any expansion
6597 metacharacters, and if there are none, just return the input string.
6599 Argument: the string to be expanded
6600 Returns: the expanded string, or NULL if expansion failed; if failure was
6601 due to a lookup deferring, search_find_defer will be TRUE
6605 expand_string(uschar *string)
6607 search_find_defer = FALSE;
6608 malformed_header = FALSE;
6609 return (Ustrpbrk(string, "$\\") == NULL)? string :
6610 expand_string_internal(string, FALSE, NULL, FALSE, TRUE, NULL);
6615 /*************************************************
6617 *************************************************/
6619 /* Now and again we want to expand a string and be sure that the result is in a
6620 new bit of store. This function does that.
6622 Argument: the string to be expanded
6623 Returns: the expanded string, always in a new bit of store, or NULL
6627 expand_string_copy(uschar *string)
6629 uschar *yield = expand_string(string);
6630 if (yield == string) yield = string_copy(string);
6636 /*************************************************
6637 * Expand and interpret as an integer *
6638 *************************************************/
6640 /* Expand a string, and convert the result into an integer.
6643 string the string to be expanded
6644 isplus TRUE if a non-negative number is expected
6646 Returns: the integer value, or
6647 -1 for an expansion error ) in both cases, message in
6648 -2 for an integer interpretation error ) expand_string_message
6649 expand_string_message is set NULL for an OK integer
6653 expand_string_integer(uschar *string, BOOL isplus)
6655 int_eximarith_t value;
6656 uschar *s = expand_string(string);
6657 uschar *msg = US"invalid integer \"%s\"";
6660 /* If expansion failed, expand_string_message will be set. */
6662 if (s == NULL) return -1;
6664 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6665 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6666 systems, so we set it zero ourselves. */
6669 expand_string_message = NULL; /* Indicates no error */
6671 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6672 equal to 0. Unfortunately, people actually relied upon that, so preserve
6673 the behaviour explicitly. Stripping leading whitespace is a harmless
6674 noop change since strtol skips it anyway (provided that there is a number
6678 while (isspace(*s)) ++s;
6682 debug_printf("treating blank string as number 0\n");
6687 value = strtoll(CS s, CSS &endptr, 10);
6691 msg = US"integer expected but \"%s\" found";
6693 else if (value < 0 && isplus)
6695 msg = US"non-negative integer expected but \"%s\" found";
6699 switch (tolower(*endptr))
6704 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
6709 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
6710 else value *= 1024*1024;
6714 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
6715 else value *= 1024*1024*1024;
6719 if (errno == ERANGE)
6720 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6723 while (isspace(*endptr)) endptr++;
6724 if (*endptr == 0) return value;
6728 expand_string_message = string_sprintf(CS msg, s);
6733 /*************************************************
6734 **************************************************
6735 * Stand-alone test program *
6736 **************************************************
6737 *************************************************/
6743 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6745 int ovector[3*(EXPAND_MAXN+1)];
6746 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6747 ovector, sizeof(ovector)/sizeof(int));
6748 BOOL yield = n >= 0;
6749 if (n == 0) n = EXPAND_MAXN + 1;
6753 expand_nmax = (setup < 0)? 0 : setup + 1;
6754 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6756 expand_nstring[expand_nmax] = subject + ovector[nn];
6757 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6765 int main(int argc, uschar **argv)
6768 uschar buffer[1024];
6770 debug_selector = D_v;
6771 debug_file = stderr;
6772 debug_fd = fileno(debug_file);
6773 big_buffer = malloc(big_buffer_size);
6775 for (i = 1; i < argc; i++)
6777 if (argv[i][0] == '+')
6779 debug_trace_memory = 2;
6782 if (isdigit(argv[i][0]))
6783 debug_selector = Ustrtol(argv[i], NULL, 0);
6785 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6789 eldap_default_servers = argv[i];
6792 mysql_servers = argv[i];
6795 pgsql_servers = argv[i];
6797 #ifdef EXPERIMENTAL_REDIS
6798 redis_servers = argv[i];
6802 else opt_perl_startup = argv[i];
6806 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6808 expand_nstring[1] = US"string 1....";
6809 expand_nlength[1] = 8;
6813 if (opt_perl_startup != NULL)
6816 printf("Starting Perl interpreter\n");
6817 errstr = init_perl(opt_perl_startup);
6820 printf("** error in perl_startup code: %s\n", errstr);
6821 return EXIT_FAILURE;
6824 #endif /* EXIM_PERL */
6826 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6828 void *reset_point = store_get(0);
6829 uschar *yield = expand_string(buffer);
6832 printf("%s\n", yield);
6833 store_reset(reset_point);
6837 if (search_find_defer) printf("search_find deferred\n");
6838 printf("Failed: %s\n", expand_string_message);
6839 if (expand_string_forcedfail) printf("Forced failure\n");
6854 /* End of expand.c */