1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, BOOL);
19 #ifndef SUPPORT_CRYPTEQ
20 #define SUPPORT_CRYPTEQ
25 #include "lookups/ldap.h"
28 #ifdef SUPPORT_CRYPTEQ
33 extern char* crypt16(char*, char*);
37 /* The handling of crypt16() is a mess. I will record below the analysis of the
38 mess that was sent to me. We decided, however, to make changing this very low
39 priority, because in practice people are moving away from the crypt()
40 algorithms nowadays, so it doesn't seem worth it.
43 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
44 the first 8 characters of the password using a 20-round version of crypt
45 (standard crypt does 25 rounds). It then crypts the next 8 characters,
46 or an empty block if the password is less than 9 characters, using a
47 20-round version of crypt and the same salt as was used for the first
48 block. Charaters after the first 16 are ignored. It always generates
49 a 16-byte hash, which is expressed together with the salt as a string
50 of 24 base 64 digits. Here are some links to peruse:
52 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
53 http://seclists.org/bugtraq/1999/Mar/0076.html
55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
56 and OSF/1. This is the same as the standard crypt if given a password
57 of 8 characters or less. If given more, it first does the same as crypt
58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
59 using as salt the first two base 64 digits from the first hash block.
60 If the password is more than 16 characters then it crypts the 17th to 24th
61 characters using as salt the first two base 64 digits from the second hash
62 block. And so on: I've seen references to it cutting off the password at
63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0109.html
67 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
68 TET1_html/sec.c222.html#no_id_208
70 Exim has something it calls "crypt16". It will either use a native
71 crypt16 or its own implementation. A native crypt16 will presumably
72 be the one that I called "crypt16" above. The internal "crypt16"
73 function, however, is a two-block-maximum implementation of what I called
74 "bigcrypt". The documentation matches the internal code.
76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
77 that crypt16 and bigcrypt were different things.
79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
80 to whatever it is using under that name. This unfortunately sets a
81 precedent for using "{crypt16}" to identify two incompatible algorithms
82 whose output can't be distinguished. With "{crypt16}" thus rendered
83 ambiguous, I suggest you deprecate it and invent two new identifiers
84 for the two algorithms.
86 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
87 of the password separately means they can be cracked separately, so
88 the double-length hash only doubles the cracking effort instead of
89 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
150 /* Tables of operator names, and corresponding switch numbers. The names must be
151 in alphabetical order. There are two tables, because underscore is used in some
152 cases to introduce arguments, whereas for other it is part of the name. This is
153 an historical mis-design. */
155 static uschar *op_table_underscore[] = {
158 US"quote_local_part",
166 EOP_QUOTE_LOCAL_PART,
171 static uschar *op_table_main[] = {
208 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
244 /* Table of condition names, and corresponding switch numbers. The names must
245 be in alphabetical order. */
247 static uschar *cond_table[] = {
251 US"==", /* Backward compatibility */
284 US"match_local_part",
309 ECOND_FIRST_DELIVERY,
330 ECOND_MATCH_LOCAL_PART,
340 /* Type for main variable table */
348 /* Type for entries pointing to address/length pairs. Not currently
356 /* Types of table entry */
359 vtype_int, /* value is address of int */
360 vtype_filter_int, /* ditto, but recognized only when filtering */
361 vtype_ino, /* value is address of ino_t (not always an int) */
362 vtype_uid, /* value is address of uid_t (not always an int) */
363 vtype_gid, /* value is address of gid_t (not always an int) */
364 vtype_bool, /* value is address of bool */
365 vtype_stringptr, /* value is address of pointer to string */
366 vtype_msgbody, /* as stringptr, but read when first required */
367 vtype_msgbody_end, /* ditto, the end of the message */
368 vtype_msgheaders, /* the message's headers, processed */
369 vtype_msgheaders_raw, /* the message's headers, unprocessed */
370 vtype_localpart, /* extract local part from string */
371 vtype_domain, /* extract domain from string */
372 vtype_string_func, /* value is string returned by given function */
373 vtype_todbsdin, /* value not used; generate BSD inbox tod */
374 vtype_tode, /* value not used; generate tod in epoch format */
375 vtype_todel, /* value not used; generate tod in epoch/usec format */
376 vtype_todf, /* value not used; generate full tod */
377 vtype_todl, /* value not used; generate log tod */
378 vtype_todlf, /* value not used; generate log file datestamp tod */
379 vtype_todzone, /* value not used; generate time zone only */
380 vtype_todzulu, /* value not used; generate zulu tod */
381 vtype_reply, /* value not used; get reply from headers */
382 vtype_pid, /* value not used; result is pid */
383 vtype_host_lookup, /* value not used; get host name */
384 vtype_load_avg, /* value not used; result is int from os_getloadavg */
385 vtype_pspace, /* partition space; value is T/F for spool/log */
386 vtype_pinodes /* partition inodes; value is T/F for spool/log */
388 ,vtype_dkim /* Lookup of value in DKIM signature */
392 static uschar * fn_recipients(void);
394 /* This table must be kept in alphabetical order. */
396 static var_entry var_table[] = {
397 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
398 they will be confused with user-creatable ACL variables. */
399 { "acl_arg1", vtype_stringptr, &acl_arg[0] },
400 { "acl_arg2", vtype_stringptr, &acl_arg[1] },
401 { "acl_arg3", vtype_stringptr, &acl_arg[2] },
402 { "acl_arg4", vtype_stringptr, &acl_arg[3] },
403 { "acl_arg5", vtype_stringptr, &acl_arg[4] },
404 { "acl_arg6", vtype_stringptr, &acl_arg[5] },
405 { "acl_arg7", vtype_stringptr, &acl_arg[6] },
406 { "acl_arg8", vtype_stringptr, &acl_arg[7] },
407 { "acl_arg9", vtype_stringptr, &acl_arg[8] },
408 { "acl_narg", vtype_int, &acl_narg },
409 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
410 { "address_data", vtype_stringptr, &deliver_address_data },
411 { "address_file", vtype_stringptr, &address_file },
412 { "address_pipe", vtype_stringptr, &address_pipe },
413 { "authenticated_fail_id",vtype_stringptr, &authenticated_fail_id },
414 { "authenticated_id", vtype_stringptr, &authenticated_id },
415 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
416 { "authentication_failed",vtype_int, &authentication_failed },
417 #ifdef WITH_CONTENT_SCAN
418 { "av_failed", vtype_int, &av_failed },
420 #ifdef EXPERIMENTAL_BRIGHTMAIL
421 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
422 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
423 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
424 { "bmi_deliver", vtype_int, &bmi_deliver },
426 { "body_linecount", vtype_int, &body_linecount },
427 { "body_zerocount", vtype_int, &body_zerocount },
428 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
429 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
430 { "caller_gid", vtype_gid, &real_gid },
431 { "caller_uid", vtype_uid, &real_uid },
432 { "compile_date", vtype_stringptr, &version_date },
433 { "compile_number", vtype_stringptr, &version_cnumber },
434 { "csa_status", vtype_stringptr, &csa_status },
435 #ifdef EXPERIMENTAL_DCC
436 { "dcc_header", vtype_stringptr, &dcc_header },
437 { "dcc_result", vtype_stringptr, &dcc_result },
439 #ifdef WITH_OLD_DEMIME
440 { "demime_errorlevel", vtype_int, &demime_errorlevel },
441 { "demime_reason", vtype_stringptr, &demime_reason },
444 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
445 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
446 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
447 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
448 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
449 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
450 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
451 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
452 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
453 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
454 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
455 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
456 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
457 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
458 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
459 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
460 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
461 { "dkim_signers", vtype_stringptr, &dkim_signers },
462 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
463 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
465 #ifdef EXPERIMENTAL_DMARC
466 { "dmarc_ar_header", vtype_stringptr, &dmarc_ar_header },
467 { "dmarc_status", vtype_stringptr, &dmarc_status },
468 { "dmarc_status_text", vtype_stringptr, &dmarc_status_text },
469 { "dmarc_used_domain", vtype_stringptr, &dmarc_used_domain },
471 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
472 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
473 { "dnslist_text", vtype_stringptr, &dnslist_text },
474 { "dnslist_value", vtype_stringptr, &dnslist_value },
475 { "domain", vtype_stringptr, &deliver_domain },
476 { "domain_data", vtype_stringptr, &deliver_domain_data },
477 { "exim_gid", vtype_gid, &exim_gid },
478 { "exim_path", vtype_stringptr, &exim_path },
479 { "exim_uid", vtype_uid, &exim_uid },
480 #ifdef WITH_OLD_DEMIME
481 { "found_extension", vtype_stringptr, &found_extension },
483 { "headers_added", vtype_string_func, &fn_hdrs_added },
484 { "home", vtype_stringptr, &deliver_home },
485 { "host", vtype_stringptr, &deliver_host },
486 { "host_address", vtype_stringptr, &deliver_host_address },
487 { "host_data", vtype_stringptr, &host_data },
488 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
489 { "host_lookup_failed", vtype_int, &host_lookup_failed },
490 { "initial_cwd", vtype_stringptr, &initial_cwd },
491 { "inode", vtype_ino, &deliver_inode },
492 { "interface_address", vtype_stringptr, &interface_address },
493 { "interface_port", vtype_int, &interface_port },
494 { "item", vtype_stringptr, &iterate_item },
496 { "ldap_dn", vtype_stringptr, &eldap_dn },
498 { "load_average", vtype_load_avg, NULL },
499 { "local_part", vtype_stringptr, &deliver_localpart },
500 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
501 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
502 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
503 { "local_scan_data", vtype_stringptr, &local_scan_data },
504 { "local_user_gid", vtype_gid, &local_user_gid },
505 { "local_user_uid", vtype_uid, &local_user_uid },
506 { "localhost_number", vtype_int, &host_number },
507 { "log_inodes", vtype_pinodes, (void *)FALSE },
508 { "log_space", vtype_pspace, (void *)FALSE },
509 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
510 #ifdef WITH_CONTENT_SCAN
511 { "malware_name", vtype_stringptr, &malware_name },
513 { "max_received_linelength", vtype_int, &max_received_linelength },
514 { "message_age", vtype_int, &message_age },
515 { "message_body", vtype_msgbody, &message_body },
516 { "message_body_end", vtype_msgbody_end, &message_body_end },
517 { "message_body_size", vtype_int, &message_body_size },
518 { "message_exim_id", vtype_stringptr, &message_id },
519 { "message_headers", vtype_msgheaders, NULL },
520 { "message_headers_raw", vtype_msgheaders_raw, NULL },
521 { "message_id", vtype_stringptr, &message_id },
522 { "message_linecount", vtype_int, &message_linecount },
523 { "message_size", vtype_int, &message_size },
524 #ifdef WITH_CONTENT_SCAN
525 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
526 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
527 { "mime_boundary", vtype_stringptr, &mime_boundary },
528 { "mime_charset", vtype_stringptr, &mime_charset },
529 { "mime_content_description", vtype_stringptr, &mime_content_description },
530 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
531 { "mime_content_id", vtype_stringptr, &mime_content_id },
532 { "mime_content_size", vtype_int, &mime_content_size },
533 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
534 { "mime_content_type", vtype_stringptr, &mime_content_type },
535 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
536 { "mime_filename", vtype_stringptr, &mime_filename },
537 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
538 { "mime_is_multipart", vtype_int, &mime_is_multipart },
539 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
540 { "mime_part_count", vtype_int, &mime_part_count },
542 { "n0", vtype_filter_int, &filter_n[0] },
543 { "n1", vtype_filter_int, &filter_n[1] },
544 { "n2", vtype_filter_int, &filter_n[2] },
545 { "n3", vtype_filter_int, &filter_n[3] },
546 { "n4", vtype_filter_int, &filter_n[4] },
547 { "n5", vtype_filter_int, &filter_n[5] },
548 { "n6", vtype_filter_int, &filter_n[6] },
549 { "n7", vtype_filter_int, &filter_n[7] },
550 { "n8", vtype_filter_int, &filter_n[8] },
551 { "n9", vtype_filter_int, &filter_n[9] },
552 { "original_domain", vtype_stringptr, &deliver_domain_orig },
553 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
554 { "originator_gid", vtype_gid, &originator_gid },
555 { "originator_uid", vtype_uid, &originator_uid },
556 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
557 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
558 { "pid", vtype_pid, NULL },
559 { "primary_hostname", vtype_stringptr, &primary_hostname },
560 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
561 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
562 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
563 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
564 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
565 { "rcpt_count", vtype_int, &rcpt_count },
566 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
567 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
568 { "received_count", vtype_int, &received_count },
569 { "received_for", vtype_stringptr, &received_for },
570 { "received_ip_address", vtype_stringptr, &interface_address },
571 { "received_port", vtype_int, &interface_port },
572 { "received_protocol", vtype_stringptr, &received_protocol },
573 { "received_time", vtype_int, &received_time },
574 { "recipient_data", vtype_stringptr, &recipient_data },
575 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
576 { "recipients", vtype_string_func, &fn_recipients },
577 { "recipients_count", vtype_int, &recipients_count },
578 #ifdef WITH_CONTENT_SCAN
579 { "regex_match_string", vtype_stringptr, ®ex_match_string },
581 { "reply_address", vtype_reply, NULL },
582 { "return_path", vtype_stringptr, &return_path },
583 { "return_size_limit", vtype_int, &bounce_return_size_limit },
584 { "router_name", vtype_stringptr, &router_name },
585 { "runrc", vtype_int, &runrc },
586 { "self_hostname", vtype_stringptr, &self_hostname },
587 { "sender_address", vtype_stringptr, &sender_address },
588 { "sender_address_data", vtype_stringptr, &sender_address_data },
589 { "sender_address_domain", vtype_domain, &sender_address },
590 { "sender_address_local_part", vtype_localpart, &sender_address },
591 { "sender_data", vtype_stringptr, &sender_data },
592 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
593 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
594 { "sender_host_address", vtype_stringptr, &sender_host_address },
595 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
596 { "sender_host_dnssec", vtype_bool, &sender_host_dnssec },
597 { "sender_host_name", vtype_host_lookup, NULL },
598 { "sender_host_port", vtype_int, &sender_host_port },
599 { "sender_ident", vtype_stringptr, &sender_ident },
600 { "sender_rate", vtype_stringptr, &sender_rate },
601 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
602 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
603 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
604 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
605 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
606 { "sending_port", vtype_int, &sending_port },
607 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
608 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
609 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
610 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
611 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
612 { "sn0", vtype_filter_int, &filter_sn[0] },
613 { "sn1", vtype_filter_int, &filter_sn[1] },
614 { "sn2", vtype_filter_int, &filter_sn[2] },
615 { "sn3", vtype_filter_int, &filter_sn[3] },
616 { "sn4", vtype_filter_int, &filter_sn[4] },
617 { "sn5", vtype_filter_int, &filter_sn[5] },
618 { "sn6", vtype_filter_int, &filter_sn[6] },
619 { "sn7", vtype_filter_int, &filter_sn[7] },
620 { "sn8", vtype_filter_int, &filter_sn[8] },
621 { "sn9", vtype_filter_int, &filter_sn[9] },
622 #ifdef WITH_CONTENT_SCAN
623 { "spam_bar", vtype_stringptr, &spam_bar },
624 { "spam_report", vtype_stringptr, &spam_report },
625 { "spam_score", vtype_stringptr, &spam_score },
626 { "spam_score_int", vtype_stringptr, &spam_score_int },
628 #ifdef EXPERIMENTAL_SPF
629 { "spf_guess", vtype_stringptr, &spf_guess },
630 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
631 { "spf_received", vtype_stringptr, &spf_received },
632 { "spf_result", vtype_stringptr, &spf_result },
633 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
635 { "spool_directory", vtype_stringptr, &spool_directory },
636 { "spool_inodes", vtype_pinodes, (void *)TRUE },
637 { "spool_space", vtype_pspace, (void *)TRUE },
638 #ifdef EXPERIMENTAL_SRS
639 { "srs_db_address", vtype_stringptr, &srs_db_address },
640 { "srs_db_key", vtype_stringptr, &srs_db_key },
641 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
642 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
643 { "srs_recipient", vtype_stringptr, &srs_recipient },
644 { "srs_status", vtype_stringptr, &srs_status },
646 { "thisaddress", vtype_stringptr, &filter_thisaddress },
648 /* The non-(in,out) variables are now deprecated */
649 { "tls_bits", vtype_int, &tls_in.bits },
650 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
651 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
653 { "tls_in_bits", vtype_int, &tls_in.bits },
654 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
655 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
656 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
657 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
658 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
660 { "tls_out_bits", vtype_int, &tls_out.bits },
661 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
662 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
663 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
664 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
665 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
668 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
669 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
670 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
673 { "tod_bsdinbox", vtype_todbsdin, NULL },
674 { "tod_epoch", vtype_tode, NULL },
675 { "tod_epoch_l", vtype_todel, NULL },
676 { "tod_full", vtype_todf, NULL },
677 { "tod_log", vtype_todl, NULL },
678 { "tod_logfile", vtype_todlf, NULL },
679 { "tod_zone", vtype_todzone, NULL },
680 { "tod_zulu", vtype_todzulu, NULL },
681 #ifdef EXPERIMENTAL_TPDA
682 { "tpda_defer_errno", vtype_int, &tpda_defer_errno },
683 { "tpda_defer_errstr", vtype_stringptr, &tpda_defer_errstr },
684 { "tpda_delivery_confirmation", vtype_stringptr, &tpda_delivery_confirmation },
685 { "tpda_delivery_domain", vtype_stringptr, &tpda_delivery_domain },
686 { "tpda_delivery_fqdn", vtype_stringptr, &tpda_delivery_fqdn },
687 { "tpda_delivery_ip", vtype_stringptr, &tpda_delivery_ip },
688 { "tpda_delivery_local_part",vtype_stringptr,&tpda_delivery_local_part },
689 { "tpda_delivery_port", vtype_int, &tpda_delivery_port },
691 { "transport_name", vtype_stringptr, &transport_name },
692 { "value", vtype_stringptr, &lookup_value },
693 { "version_number", vtype_stringptr, &version_string },
694 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
695 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
696 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
697 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
698 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
699 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
702 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
703 static uschar var_buffer[256];
704 static BOOL malformed_header;
706 /* For textual hashes */
708 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
709 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
712 enum { HMAC_MD5, HMAC_SHA1 };
714 /* For numeric hashes */
716 static unsigned int prime[] = {
717 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
718 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
719 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
721 /* For printing modes in symbolic form */
723 static uschar *mtable_normal[] =
724 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
726 static uschar *mtable_setid[] =
727 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
729 static uschar *mtable_sticky[] =
730 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
734 /*************************************************
735 * Tables for UTF-8 support *
736 *************************************************/
738 /* Table of the number of extra characters, indexed by the first character
739 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
742 static uschar utf8_table1[] = {
743 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
744 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
745 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
746 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
748 /* These are the masks for the data bits in the first byte of a character,
749 indexed by the number of additional bytes. */
751 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
753 /* Get the next UTF-8 character, advancing the pointer. */
755 #define GETUTF8INC(c, ptr) \
757 if ((c & 0xc0) == 0xc0) \
759 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
761 c = (c & utf8_table2[a]) << s; \
765 c |= (*ptr++ & 0x3f) << s; \
770 /*************************************************
771 * Binary chop search on a table *
772 *************************************************/
774 /* This is used for matching expansion items and operators.
777 name the name that is being sought
778 table the table to search
779 table_size the number of items in the table
781 Returns: the offset in the table, or -1
785 chop_match(uschar *name, uschar **table, int table_size)
787 uschar **bot = table;
788 uschar **top = table + table_size;
792 uschar **mid = bot + (top - bot)/2;
793 int c = Ustrcmp(name, *mid);
794 if (c == 0) return mid - table;
795 if (c > 0) bot = mid + 1; else top = mid;
803 /*************************************************
804 * Check a condition string *
805 *************************************************/
807 /* This function is called to expand a string, and test the result for a "true"
808 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
809 forced fail or lookup defer.
811 We used to release all store used, but this is not not safe due
812 to ${dlfunc } and ${acl }. In any case expand_string_internal()
813 is reasonably careful to release what it can.
815 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
818 condition the condition string
819 m1 text to be incorporated in panic error
822 Returns: TRUE if condition is met, FALSE if not
826 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
829 uschar *ss = expand_string(condition);
832 if (!expand_string_forcedfail && !search_find_defer)
833 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
834 "for %s %s: %s", condition, m1, m2, expand_string_message);
837 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
838 strcmpic(ss, US"false") != 0;
845 /*************************************************
846 * Pseudo-random number generation *
847 *************************************************/
849 /* Pseudo-random number generation. The result is not "expected" to be
850 cryptographically strong but not so weak that someone will shoot themselves
851 in the foot using it as a nonce in some email header scheme or whatever
852 weirdness they'll twist this into. The result should ideally handle fork().
854 However, if we're stuck unable to provide this, then we'll fall back to
855 appallingly bad randomness.
857 If SUPPORT_TLS is defined then this will not be used except as an emergency
862 Returns a random number in range [0, max-1]
866 # define vaguely_random_number vaguely_random_number_fallback
869 vaguely_random_number(int max)
872 # undef vaguely_random_number
874 static pid_t pid = 0;
876 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
886 #ifdef HAVE_ARC4RANDOM
887 /* cryptographically strong randomness, common on *BSD platforms, not
888 so much elsewhere. Alas. */
890 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
891 #ifdef HAVE_SRANDOMDEV
892 /* uses random(4) for seeding */
895 gettimeofday(&tv, NULL);
896 srandom(tv.tv_sec | tv.tv_usec | getpid());
899 /* Poor randomness and no seeding here */
906 #ifdef HAVE_ARC4RANDOM
907 return arc4random() % max;
908 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
909 return random() % max;
911 /* This one returns a 16-bit number, definitely not crypto-strong */
912 return random_number(max);
919 /*************************************************
920 * Pick out a name from a string *
921 *************************************************/
923 /* If the name is too long, it is silently truncated.
926 name points to a buffer into which to put the name
927 max is the length of the buffer
928 s points to the first alphabetic character of the name
929 extras chars other than alphanumerics to permit
931 Returns: pointer to the first character after the name
933 Note: The test for *s != 0 in the while loop is necessary because
934 Ustrchr() yields non-NULL if the character is zero (which is not something
938 read_name(uschar *name, int max, uschar *s, uschar *extras)
941 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
943 if (ptr < max-1) name[ptr++] = *s;
952 /*************************************************
953 * Pick out the rest of a header name *
954 *************************************************/
956 /* A variable name starting $header_ (or just $h_ for those who like
957 abbreviations) might not be the complete header name because headers can
958 contain any printing characters in their names, except ':'. This function is
959 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
960 on the end, if the name was terminated by white space.
963 name points to a buffer in which the name read so far exists
964 max is the length of the buffer
965 s points to the first character after the name so far, i.e. the
966 first non-alphameric character after $header_xxxxx
968 Returns: a pointer to the first character after the header name
972 read_header_name(uschar *name, int max, uschar *s)
974 int prelen = Ustrchr(name, '_') - name + 1;
975 int ptr = Ustrlen(name) - prelen;
976 if (ptr > 0) memmove(name, name+prelen, ptr);
977 while (mac_isgraph(*s) && *s != ':')
979 if (ptr < max-1) name[ptr++] = *s;
990 /*************************************************
991 * Pick out a number from a string *
992 *************************************************/
995 n points to an integer into which to put the number
996 s points to the first digit of the number
998 Returns: a pointer to the character after the last digit
1002 read_number(int *n, uschar *s)
1005 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1011 /*************************************************
1012 * Extract keyed subfield from a string *
1013 *************************************************/
1015 /* The yield is in dynamic store; NULL means that the key was not found.
1018 key points to the name of the key
1019 s points to the string from which to extract the subfield
1021 Returns: NULL if the subfield was not found, or
1022 a pointer to the subfield's data
1026 expand_getkeyed(uschar *key, uschar *s)
1028 int length = Ustrlen(key);
1029 while (isspace(*s)) s++;
1031 /* Loop to search for the key */
1039 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1040 dkeylength = s - dkey;
1041 while (isspace(*s)) s++;
1042 if (*s == '=') while (isspace((*(++s))));
1044 data = string_dequote(&s);
1045 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1048 while (isspace(*s)) s++;
1057 /*************************************************
1058 * Extract numbered subfield from string *
1059 *************************************************/
1061 /* Extracts a numbered field from a string that is divided by tokens - for
1062 example a line from /etc/passwd is divided by colon characters. First field is
1063 numbered one. Negative arguments count from the right. Zero returns the whole
1064 string. Returns NULL if there are insufficient tokens in the string
1067 Modifies final argument - this is a dynamically generated string, so that's OK.
1070 field number of field to be extracted,
1071 first field = 1, whole string = 0, last field = -1
1072 separators characters that are used to break string into tokens
1073 s points to the string from which to extract the subfield
1075 Returns: NULL if the field was not found,
1076 a pointer to the field's data inside s (modified to add 0)
1080 expand_gettokened (int field, uschar *separators, uschar *s)
1085 uschar *fieldtext = NULL;
1087 if (field == 0) return s;
1089 /* Break the line up into fields in place; for field > 0 we stop when we have
1090 done the number of fields we want. For field < 0 we continue till the end of
1091 the string, counting the number of fields. */
1093 count = (field > 0)? field : INT_MAX;
1099 /* Previous field was the last one in the string. For a positive field
1100 number, this means there are not enough fields. For a negative field number,
1101 check that there are enough, and scan back to find the one that is wanted. */
1105 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1106 if ((-field) == (INT_MAX - count - 1)) return s;
1110 while (ss[-1] != 0) ss--;
1116 /* Previous field was not last in the string; save its start and put a
1120 len = Ustrcspn(ss, separators);
1131 /*************************************************
1132 * Extract a substring from a string *
1133 *************************************************/
1135 /* Perform the ${substr or ${length expansion operations.
1138 subject the input string
1139 value1 the offset from the start of the input string to the start of
1140 the output string; if negative, count from the right.
1141 value2 the length of the output string, or negative (-1) for unset
1142 if value1 is positive, unset means "all after"
1143 if value1 is negative, unset means "all before"
1144 len set to the length of the returned string
1146 Returns: pointer to the output string, or NULL if there is an error
1150 extract_substr(uschar *subject, int value1, int value2, int *len)
1152 int sublen = Ustrlen(subject);
1154 if (value1 < 0) /* count from right */
1158 /* If the position is before the start, skip to the start, and adjust the
1159 length. If the length ends up negative, the substring is null because nothing
1160 can precede. This falls out naturally when the length is unset, meaning "all
1166 if (value2 < 0) value2 = 0;
1170 /* Otherwise an unset length => characters before value1 */
1172 else if (value2 < 0)
1179 /* For a non-negative offset, if the starting position is past the end of the
1180 string, the result will be the null string. Otherwise, an unset length means
1181 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1185 if (value1 > sublen)
1190 else if (value2 < 0) value2 = sublen;
1193 /* Cut the length down to the maximum possible for the offset value, and get
1194 the required characters. */
1196 if (value1 + value2 > sublen) value2 = sublen - value1;
1198 return subject + value1;
1204 /*************************************************
1205 * Old-style hash of a string *
1206 *************************************************/
1208 /* Perform the ${hash expansion operation.
1211 subject the input string (an expanded substring)
1212 value1 the length of the output string; if greater or equal to the
1213 length of the input string, the input string is returned
1214 value2 the number of hash characters to use, or 26 if negative
1215 len set to the length of the returned string
1217 Returns: pointer to the output string, or NULL if there is an error
1221 compute_hash(uschar *subject, int value1, int value2, int *len)
1223 int sublen = Ustrlen(subject);
1225 if (value2 < 0) value2 = 26;
1226 else if (value2 > Ustrlen(hashcodes))
1228 expand_string_message =
1229 string_sprintf("hash count \"%d\" too big", value2);
1233 /* Calculate the hash text. We know it is shorter than the original string, so
1234 can safely place it in subject[] (we know that subject is always itself an
1235 expanded substring). */
1237 if (value1 < sublen)
1242 while ((c = (subject[j])) != 0)
1244 int shift = (c + j++) & 7;
1245 subject[i] ^= (c << shift) | (c >> (8-shift));
1246 if (++i >= value1) i = 0;
1248 for (i = 0; i < value1; i++)
1249 subject[i] = hashcodes[(subject[i]) % value2];
1251 else value1 = sublen;
1260 /*************************************************
1261 * Numeric hash of a string *
1262 *************************************************/
1264 /* Perform the ${nhash expansion operation. The first characters of the
1265 string are treated as most important, and get the highest prime numbers.
1268 subject the input string
1269 value1 the maximum value of the first part of the result
1270 value2 the maximum value of the second part of the result,
1271 or negative to produce only a one-part result
1272 len set to the length of the returned string
1274 Returns: pointer to the output string, or NULL if there is an error.
1278 compute_nhash (uschar *subject, int value1, int value2, int *len)
1280 uschar *s = subject;
1282 unsigned long int total = 0; /* no overflow */
1286 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1287 total += prime[i--] * (unsigned int)(*s++);
1290 /* If value2 is unset, just compute one number */
1294 s = string_sprintf("%d", total % value1);
1297 /* Otherwise do a div/mod hash */
1301 total = total % (value1 * value2);
1302 s = string_sprintf("%d/%d", total/value2, total % value2);
1313 /*************************************************
1314 * Find the value of a header or headers *
1315 *************************************************/
1317 /* Multiple instances of the same header get concatenated, and this function
1318 can also return a concatenation of all the header lines. When concatenating
1319 specific headers that contain lists of addresses, a comma is inserted between
1320 them. Otherwise we use a straight concatenation. Because some messages can have
1321 pathologically large number of lines, there is a limit on the length that is
1322 returned. Also, to avoid massive store use which would result from using
1323 string_cat() as it copies and extends strings, we do a preliminary pass to find
1324 out exactly how much store will be needed. On "normal" messages this will be
1328 name the name of the header, without the leading $header_ or $h_,
1329 or NULL if a concatenation of all headers is required
1330 exists_only TRUE if called from a def: test; don't need to build a string;
1331 just return a string that is not "" and not "0" if the header
1333 newsize return the size of memory block that was obtained; may be NULL
1334 if exists_only is TRUE
1335 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1336 other than concatenating, will be done on the header. Also used
1337 for $message_headers_raw.
1338 charset name of charset to translate MIME words to; used only if
1339 want_raw is false; if NULL, no translation is done (this is
1340 used for $bh_ and $bheader_)
1342 Returns: NULL if the header does not exist, else a pointer to a new
1347 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1350 BOOL found = name == NULL;
1352 int len = found? 0 : Ustrlen(name);
1354 uschar *yield = NULL;
1357 /* Loop for two passes - saves code repetition */
1359 for (i = 0; i < 2; i++)
1364 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1366 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1368 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1373 if (exists_only) return US"1"; /* don't need actual string */
1375 t = h->text + len; /* text to insert */
1376 if (!want_raw) /* unless wanted raw, */
1377 while (isspace(*t)) t++; /* remove leading white space */
1378 ilen = h->slen - (t - h->text); /* length to insert */
1380 /* Unless wanted raw, remove trailing whitespace, including the
1384 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1386 /* Set comma = 1 if handling a single header and it's one of those
1387 that contains an address list, except when asked for raw headers. Only
1388 need to do this once. */
1390 if (!want_raw && name != NULL && comma == 0 &&
1391 Ustrchr("BCFRST", h->type) != NULL)
1394 /* First pass - compute total store needed; second pass - compute
1395 total store used, including this header. */
1397 size += ilen + comma + 1; /* +1 for the newline */
1399 /* Second pass - concatentate the data, up to a maximum. Note that
1400 the loop stops when size hits the limit. */
1404 if (size > header_insert_maxlen)
1406 ilen -= size - header_insert_maxlen - 1;
1409 Ustrncpy(ptr, t, ilen);
1412 /* For a non-raw header, put in the comma if needed, then add
1413 back the newline we removed above, provided there was some text in
1416 if (!want_raw && ilen > 0)
1418 if (comma != 0) *ptr++ = ',';
1426 /* At end of first pass, return NULL if no header found. Then truncate size
1427 if necessary, and get the buffer to hold the data, returning the buffer size.
1432 if (!found) return NULL;
1433 if (size > header_insert_maxlen) size = header_insert_maxlen;
1434 *newsize = size + 1;
1435 ptr = yield = store_get(*newsize);
1439 /* That's all we do for raw header expansion. */
1446 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1447 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1448 function can return an error with decoded data if the charset translation
1449 fails. If decoding fails, it returns NULL. */
1453 uschar *decoded, *error;
1454 if (ptr > yield && ptr[-1] == '\n') ptr--;
1455 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1457 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1461 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1462 " input was: %s\n", error, yield);
1464 if (decoded != NULL) yield = decoded;
1473 /*************************************************
1474 * Return list of recipients *
1475 *************************************************/
1476 /* A recipients list is available only during system message filtering,
1477 during ACL processing after DATA, and while expanding pipe commands
1478 generated from a system filter, but not elsewhere. */
1483 if (!enable_dollar_recipients) return NULL; else
1488 uschar * s = store_get(size);
1489 for (i = 0; i < recipients_count; i++)
1491 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1492 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1493 Ustrlen(recipients_list[i].address));
1495 s[ptr] = 0; /* string_cat() leaves room */
1501 /*************************************************
1502 * Find value of a variable *
1503 *************************************************/
1505 /* The table of variables is kept in alphabetic order, so we can search it
1506 using a binary chop. The "choplen" variable is nothing to do with the binary
1510 name the name of the variable being sought
1511 exists_only TRUE if this is a def: test; passed on to find_header()
1512 skipping TRUE => skip any processing evaluation; this is not the same as
1513 exists_only because def: may test for values that are first
1515 newsize pointer to an int which is initially zero; if the answer is in
1516 a new memory buffer, *newsize is set to its size
1518 Returns: NULL if the variable does not exist, or
1519 a pointer to the variable's contents, or
1520 something non-NULL if exists_only is TRUE
1524 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1527 int last = var_table_size;
1529 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1530 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1531 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1532 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1533 (this gave backwards compatibility at the changeover). There may be built-in
1534 variables whose names start acl_ but they should never start in this way. This
1535 slightly messy specification is a consequence of the history, needless to say.
1537 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1538 set, in which case give an error. */
1540 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1544 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1545 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1548 /* Handle $auth<n> variables. */
1550 if (Ustrncmp(name, "auth", 4) == 0)
1553 int n = Ustrtoul(name + 4, &endptr, 10);
1554 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1555 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1558 /* For all other variables, search the table */
1560 while (last > first)
1564 int middle = (first + last)/2;
1565 int c = Ustrcmp(name, var_table[middle].name);
1567 if (c > 0) { first = middle + 1; continue; }
1568 if (c < 0) { last = middle; continue; }
1570 /* Found an existing variable. If in skipping state, the value isn't needed,
1571 and we want to avoid processing (such as looking up the host name). */
1573 if (skipping) return US"";
1575 switch (var_table[middle].type)
1577 case vtype_filter_int:
1578 if (!filter_running) return NULL;
1582 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1586 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1590 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1594 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1598 sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1601 case vtype_stringptr: /* Pointer to string */
1602 s = *((uschar **)(var_table[middle].value));
1603 return (s == NULL)? US"" : s;
1606 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1609 case vtype_load_avg:
1610 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1613 case vtype_host_lookup: /* Lookup if not done so */
1614 if (sender_host_name == NULL && sender_host_address != NULL &&
1615 !host_lookup_failed && host_name_lookup() == OK)
1616 host_build_sender_fullhost();
1617 return (sender_host_name == NULL)? US"" : sender_host_name;
1619 case vtype_localpart: /* Get local part from address */
1620 s = *((uschar **)(var_table[middle].value));
1621 if (s == NULL) return US"";
1622 domain = Ustrrchr(s, '@');
1623 if (domain == NULL) return s;
1624 if (domain - s > sizeof(var_buffer) - 1)
1625 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1626 " in string expansion", sizeof(var_buffer));
1627 Ustrncpy(var_buffer, s, domain - s);
1628 var_buffer[domain - s] = 0;
1631 case vtype_domain: /* Get domain from address */
1632 s = *((uschar **)(var_table[middle].value));
1633 if (s == NULL) return US"";
1634 domain = Ustrrchr(s, '@');
1635 return (domain == NULL)? US"" : domain + 1;
1637 case vtype_msgheaders:
1638 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1640 case vtype_msgheaders_raw:
1641 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1643 case vtype_msgbody: /* Pointer to msgbody string */
1644 case vtype_msgbody_end: /* Ditto, the end of the msg */
1645 ss = (uschar **)(var_table[middle].value);
1646 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1649 off_t start_offset = SPOOL_DATA_START_OFFSET;
1650 int len = message_body_visible;
1651 if (len > message_size) len = message_size;
1652 *ss = body = store_malloc(len+1);
1654 if (var_table[middle].type == vtype_msgbody_end)
1656 struct stat statbuf;
1657 if (fstat(deliver_datafile, &statbuf) == 0)
1659 start_offset = statbuf.st_size - len;
1660 if (start_offset < SPOOL_DATA_START_OFFSET)
1661 start_offset = SPOOL_DATA_START_OFFSET;
1664 lseek(deliver_datafile, start_offset, SEEK_SET);
1665 len = read(deliver_datafile, body, len);
1669 if (message_body_newlines) /* Separate loops for efficiency */
1672 { if (body[--len] == 0) body[len] = ' '; }
1677 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1681 return (*ss == NULL)? US"" : *ss;
1683 case vtype_todbsdin: /* BSD inbox time of day */
1684 return tod_stamp(tod_bsdin);
1686 case vtype_tode: /* Unix epoch time of day */
1687 return tod_stamp(tod_epoch);
1689 case vtype_todel: /* Unix epoch/usec time of day */
1690 return tod_stamp(tod_epoch_l);
1692 case vtype_todf: /* Full time of day */
1693 return tod_stamp(tod_full);
1695 case vtype_todl: /* Log format time of day */
1696 return tod_stamp(tod_log_bare); /* (without timezone) */
1698 case vtype_todzone: /* Time zone offset only */
1699 return tod_stamp(tod_zone);
1701 case vtype_todzulu: /* Zulu time */
1702 return tod_stamp(tod_zulu);
1704 case vtype_todlf: /* Log file datestamp tod */
1705 return tod_stamp(tod_log_datestamp_daily);
1707 case vtype_reply: /* Get reply address */
1708 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1710 if (s != NULL) while (isspace(*s)) s++;
1711 if (s == NULL || *s == 0)
1713 *newsize = 0; /* For the *s==0 case */
1714 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1719 while (isspace(*s)) s++;
1720 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1721 while (t > s && isspace(t[-1])) t--;
1724 return (s == NULL)? US"" : s;
1726 case vtype_string_func:
1728 uschar * (*fn)() = var_table[middle].value;
1735 sprintf(CS var_buffer, "%d",
1736 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1743 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1744 sprintf(CS var_buffer, "%d", inodes);
1748 #ifndef DISABLE_DKIM
1750 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1756 return NULL; /* Unknown variable name */
1763 modify_variable(uschar *name, void * value)
1766 int last = var_table_size;
1768 while (last > first)
1770 int middle = (first + last)/2;
1771 int c = Ustrcmp(name, var_table[middle].name);
1773 if (c > 0) { first = middle + 1; continue; }
1774 if (c < 0) { last = middle; continue; }
1776 /* Found an existing variable; change the item it refers to */
1777 var_table[middle].value = value;
1780 return; /* Unknown variable name, fail silently */
1787 /*************************************************
1788 * Read and expand substrings *
1789 *************************************************/
1791 /* This function is called to read and expand argument substrings for various
1792 expansion items. Some have a minimum requirement that is less than the maximum;
1793 in these cases, the first non-present one is set to NULL.
1796 sub points to vector of pointers to set
1797 n maximum number of substrings
1799 sptr points to current string pointer
1800 skipping the skipping flag
1801 check_end if TRUE, check for final '}'
1802 name name of item, for error message
1804 Returns: 0 OK; string pointer updated
1805 1 curly bracketing error (too few arguments)
1806 2 too many arguments (only if check_end is set); message set
1807 3 other error (expansion failure)
1811 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1812 BOOL check_end, uschar *name)
1817 while (isspace(*s)) s++;
1818 for (i = 0; i < n; i++)
1822 if (i < m) return 1;
1826 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1827 if (sub[i] == NULL) return 3;
1828 if (*s++ != '}') return 1;
1829 while (isspace(*s)) s++;
1831 if (check_end && *s++ != '}')
1835 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1836 "(max is %d)", name, n);
1849 /*************************************************
1850 * Elaborate message for bad variable *
1851 *************************************************/
1853 /* For the "unknown variable" message, take a look at the variable's name, and
1854 give additional information about possible ACL variables. The extra information
1855 is added on to expand_string_message.
1857 Argument: the name of the variable
1862 check_variable_error_message(uschar *name)
1864 if (Ustrncmp(name, "acl_", 4) == 0)
1865 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1866 (name[4] == 'c' || name[4] == 'm')?
1868 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1869 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1871 US"user-defined ACL variables must start acl_c or acl_m");
1877 Load args from sub array to globals, and call acl_check().
1878 Sub array will be corrupted on return.
1880 Returns: OK access is granted by an ACCEPT verb
1881 DISCARD access is granted by a DISCARD verb
1882 FAIL access is denied
1883 FAIL_DROP access is denied; drop the connection
1884 DEFER can't tell at the moment
1888 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
1892 int sav_narg = acl_narg;
1894 extern int acl_where;
1896 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
1897 for (i = 0; i < nsub && sub[i+1]; i++)
1900 acl_arg[i] = sub[i+1]; /* place callers args in the globals */
1901 sub[i+1] = tmp; /* stash the old args using our caller's storage */
1906 sub[i+1] = acl_arg[i];
1907 acl_arg[i++] = NULL;
1911 debug_printf("expanding: acl: %s arg: %s%s\n",
1913 acl_narg>0 ? acl_arg[0] : US"<none>",
1914 acl_narg>1 ? " +more" : "");
1916 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
1918 for (i = 0; i < nsub; i++)
1919 acl_arg[i] = sub[i+1]; /* restore old args */
1920 acl_narg = sav_narg;
1928 /*************************************************
1929 * Read and evaluate a condition *
1930 *************************************************/
1934 s points to the start of the condition text
1935 yield points to a BOOL to hold the result of the condition test;
1936 if NULL, we are just reading through a condition that is
1937 part of an "or" combination to check syntax, or in a state
1938 where the answer isn't required
1940 Returns: a pointer to the first character after the condition, or
1945 eval_condition(uschar *s, BOOL *yield)
1947 BOOL testfor = TRUE;
1948 BOOL tempcond, combined_cond;
1950 BOOL sub2_honour_dollar = TRUE;
1951 int i, rc, cond_type, roffset;
1952 int_eximarith_t num[2];
1953 struct stat statbuf;
1958 const uschar *rerror;
1962 while (isspace(*s)) s++;
1963 if (*s == '!') { testfor = !testfor; s++; } else break;
1966 /* Numeric comparisons are symbolic */
1968 if (*s == '=' || *s == '>' || *s == '<')
1980 /* All other conditions are named */
1982 else s = read_name(name, 256, s, US"_");
1984 /* If we haven't read a name, it means some non-alpha character is first. */
1988 expand_string_message = string_sprintf("condition name expected, "
1989 "but found \"%.16s\"", s);
1993 /* Find which condition we are dealing with, and switch on it */
1995 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1998 /* def: tests for a non-empty variable, or for the existence of a header. If
1999 yield == NULL we are in a skipping state, and don't care about the answer. */
2004 expand_string_message = US"\":\" expected after \"def\"";
2008 s = read_name(name, 256, s+1, US"_");
2010 /* Test for a header's existence. If the name contains a closing brace
2011 character, this may be a user error where the terminating colon has been
2012 omitted. Set a flag to adjust a subsequent error message in this case. */
2014 if (Ustrncmp(name, "h_", 2) == 0 ||
2015 Ustrncmp(name, "rh_", 3) == 0 ||
2016 Ustrncmp(name, "bh_", 3) == 0 ||
2017 Ustrncmp(name, "header_", 7) == 0 ||
2018 Ustrncmp(name, "rheader_", 8) == 0 ||
2019 Ustrncmp(name, "bheader_", 8) == 0)
2021 s = read_header_name(name, 256, s);
2022 /* {-for-text-editors */
2023 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2024 if (yield != NULL) *yield =
2025 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2028 /* Test for a variable's having a non-empty value. A non-existent variable
2029 causes an expansion failure. */
2033 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2036 expand_string_message = (name[0] == 0)?
2037 string_sprintf("variable name omitted after \"def:\"") :
2038 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2039 check_variable_error_message(name);
2042 if (yield != NULL) *yield = (value[0] != 0) == testfor;
2048 /* first_delivery tests for first delivery attempt */
2050 case ECOND_FIRST_DELIVERY:
2051 if (yield != NULL) *yield = deliver_firsttime == testfor;
2055 /* queue_running tests for any process started by a queue runner */
2057 case ECOND_QUEUE_RUNNING:
2058 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2062 /* exists: tests for file existence
2063 isip: tests for any IP address
2064 isip4: tests for an IPv4 address
2065 isip6: tests for an IPv6 address
2066 pam: does PAM authentication
2067 radius: does RADIUS authentication
2068 ldapauth: does LDAP authentication
2069 pwcheck: does Cyrus SASL pwcheck authentication
2078 case ECOND_LDAPAUTH:
2081 while (isspace(*s)) s++;
2082 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2084 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
2085 if (sub[0] == NULL) return NULL;
2086 /* {-for-text-editors */
2087 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2089 if (yield == NULL) return s; /* No need to run the test if skipping */
2094 if ((expand_forbid & RDO_EXISTS) != 0)
2096 expand_string_message = US"File existence tests are not permitted";
2099 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2105 rc = string_is_ip_address(sub[0], NULL);
2106 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2107 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2110 /* Various authentication tests - all optionally compiled */
2114 rc = auth_call_pam(sub[0], &expand_string_message);
2117 goto COND_FAILED_NOT_COMPILED;
2118 #endif /* SUPPORT_PAM */
2121 #ifdef RADIUS_CONFIG_FILE
2122 rc = auth_call_radius(sub[0], &expand_string_message);
2125 goto COND_FAILED_NOT_COMPILED;
2126 #endif /* RADIUS_CONFIG_FILE */
2128 case ECOND_LDAPAUTH:
2131 /* Just to keep the interface the same */
2133 int old_pool = store_pool;
2134 store_pool = POOL_SEARCH;
2135 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2136 &expand_string_message, &do_cache);
2137 store_pool = old_pool;
2141 goto COND_FAILED_NOT_COMPILED;
2142 #endif /* LOOKUP_LDAP */
2145 #ifdef CYRUS_PWCHECK_SOCKET
2146 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2149 goto COND_FAILED_NOT_COMPILED;
2150 #endif /* CYRUS_PWCHECK_SOCKET */
2152 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2153 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2155 if (rc == ERROR || rc == DEFER) return NULL;
2156 *yield = (rc == OK) == testfor;
2162 /* call ACL (in a conditional context). Accept true, deny false.
2163 Defer is a forced-fail. Anything set by message= goes to $value.
2164 Up to ten parameters are used; we use the braces round the name+args
2165 like the saslauthd condition does, to permit a variable number of args.
2166 See also the expansion-item version EITEM_ACL and the traditional
2167 acl modifier ACLC_ACL.
2171 /* ${if acl {{name}{arg1}{arg2}...} {yes}{no}} */
2178 while (isspace(*s)) s++;
2179 if (*s++ != '{') goto COND_FAILED_CURLY_START; /*}*/
2181 switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2182 &s, yield == NULL, TRUE, US"acl"))
2184 case 1: expand_string_message = US"too few arguments or bracketing "
2187 case 3: return NULL;
2190 if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2195 lookup_value = NULL;
2198 lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2199 lookup_value[ptr] = '\0';
2201 *yield = cond == testfor;
2205 expand_string_forcedfail = TRUE;
2207 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2214 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2216 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
2218 However, the last two are optional. That is why the whole set is enclosed
2219 in their own set of braces. */
2221 case ECOND_SASLAUTHD:
2222 #ifndef CYRUS_SASLAUTHD_SOCKET
2223 goto COND_FAILED_NOT_COMPILED;
2225 while (isspace(*s)) s++;
2226 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2227 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2229 case 1: expand_string_message = US"too few arguments or bracketing "
2230 "error for saslauthd";
2232 case 3: return NULL;
2234 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2238 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2239 &expand_string_message);
2240 if (rc == ERROR || rc == DEFER) return NULL;
2241 *yield = (rc == OK) == testfor;
2244 #endif /* CYRUS_SASLAUTHD_SOCKET */
2247 /* symbolic operators for numeric and string comparison, and a number of
2248 other operators, all requiring two arguments.
2250 crypteq: encrypts plaintext and compares against an encrypted text,
2251 using crypt(), crypt16(), MD5 or SHA-1
2252 inlist/inlisti: checks if first argument is in the list of the second
2253 match: does a regular expression match and sets up the numerical
2254 variables if it succeeds
2255 match_address: matches in an address list
2256 match_domain: matches in a domain list
2257 match_ip: matches a host list that is restricted to IP addresses
2258 match_local_part: matches in a local part list
2261 case ECOND_MATCH_ADDRESS:
2262 case ECOND_MATCH_DOMAIN:
2263 case ECOND_MATCH_IP:
2264 case ECOND_MATCH_LOCAL_PART:
2265 #ifndef EXPAND_LISTMATCH_RHS
2266 sub2_honour_dollar = FALSE;
2275 case ECOND_NUM_L: /* Numerical comparisons */
2282 case ECOND_STR_LT: /* String comparisons */
2293 for (i = 0; i < 2; i++)
2295 /* Sometimes, we don't expand substrings; too many insecure configurations
2296 created using match_address{}{} and friends, where the second param
2297 includes information from untrustworthy sources. */
2298 BOOL honour_dollar = TRUE;
2299 if ((i > 0) && !sub2_honour_dollar)
2300 honour_dollar = FALSE;
2302 while (isspace(*s)) s++;
2305 if (i == 0) goto COND_FAILED_CURLY_START;
2306 expand_string_message = string_sprintf("missing 2nd string in {} "
2307 "after \"%s\"", name);
2310 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2312 if (sub[i] == NULL) return NULL;
2313 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2315 /* Convert to numerical if required; we know that the names of all the
2316 conditions that compare numbers do not start with a letter. This just saves
2317 checking for them individually. */
2319 if (!isalpha(name[0]) && yield != NULL)
2325 debug_printf("empty string cast to zero for numerical comparison\n");
2329 num[i] = expand_string_integer(sub[i], FALSE);
2330 if (expand_string_message != NULL) return NULL;
2335 /* Result not required */
2337 if (yield == NULL) return s;
2339 /* Do an appropriate comparison */
2345 tempcond = (num[0] == num[1]);
2349 tempcond = (num[0] > num[1]);
2353 tempcond = (num[0] >= num[1]);
2357 tempcond = (num[0] < num[1]);
2361 tempcond = (num[0] <= num[1]);
2365 tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2369 tempcond = (strcmpic(sub[0], sub[1]) < 0);
2373 tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2377 tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2381 tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2385 tempcond = (strcmpic(sub[0], sub[1]) == 0);
2389 tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2393 tempcond = (strcmpic(sub[0], sub[1]) > 0);
2397 tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2401 tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2404 case ECOND_MATCH: /* Regular expression match */
2405 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2409 expand_string_message = string_sprintf("regular expression error in "
2410 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2413 tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2416 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2417 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2418 goto MATCHED_SOMETHING;
2420 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2421 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2422 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2423 goto MATCHED_SOMETHING;
2425 case ECOND_MATCH_IP: /* Match IP address in a host list */
2426 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2428 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2434 unsigned int *nullcache = NULL;
2435 check_host_block cb;
2437 cb.host_name = US"";
2438 cb.host_address = sub[0];
2440 /* If the host address starts off ::ffff: it is an IPv6 address in
2441 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2444 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2445 cb.host_address + 7 : cb.host_address;
2447 rc = match_check_list(
2448 &sub[1], /* the list */
2449 0, /* separator character */
2450 &hostlist_anchor, /* anchor pointer */
2451 &nullcache, /* cache pointer */
2452 check_host, /* function for testing */
2453 &cb, /* argument for function */
2454 MCL_HOST, /* type of check */
2455 sub[0], /* text for debugging */
2456 NULL); /* where to pass back data */
2458 goto MATCHED_SOMETHING;
2460 case ECOND_MATCH_LOCAL_PART:
2461 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2462 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2477 expand_string_message = string_sprintf("unable to complete match "
2478 "against \"%s\": %s", sub[1], search_error_message);
2484 /* Various "encrypted" comparisons. If the second string starts with
2485 "{" then an encryption type is given. Default to crypt() or crypt16()
2486 (build-time choice). */
2487 /* }-for-text-editors */
2490 #ifndef SUPPORT_CRYPTEQ
2491 goto COND_FAILED_NOT_COMPILED;
2493 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2495 int sublen = Ustrlen(sub[1]+5);
2500 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2502 /* If the length that we are comparing against is 24, the MD5 digest
2503 is expressed as a base64 string. This is the way LDAP does it. However,
2504 some other software uses a straightforward hex representation. We assume
2505 this if the length is 32. Other lengths fail. */
2509 uschar *coded = auth_b64encode((uschar *)digest, 16);
2510 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2511 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2512 tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2514 else if (sublen == 32)
2518 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2520 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2521 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2522 tempcond = (strcmpic(coded, sub[1]+5) == 0);
2526 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2527 "fail\n crypted=%s\n", sub[1]+5);
2532 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2534 int sublen = Ustrlen(sub[1]+6);
2539 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2541 /* If the length that we are comparing against is 28, assume the SHA1
2542 digest is expressed as a base64 string. If the length is 40, assume a
2543 straightforward hex representation. Other lengths fail. */
2547 uschar *coded = auth_b64encode((uschar *)digest, 20);
2548 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2549 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2550 tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2552 else if (sublen == 40)
2556 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2558 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2559 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2560 tempcond = (strcmpic(coded, sub[1]+6) == 0);
2564 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2565 "fail\n crypted=%s\n", sub[1]+6);
2570 else /* {crypt} or {crypt16} and non-{ at start */
2571 /* }-for-text-editors */
2576 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2581 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2586 else if (sub[1][0] == '{') /* }-for-text-editors */
2588 expand_string_message = string_sprintf("unknown encryption mechanism "
2589 "in \"%s\"", sub[1]);
2595 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2596 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2597 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2601 #define XSTR(s) STR(s)
2602 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2603 " subject=%s\n crypted=%s\n",
2604 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2609 /* If the encrypted string contains fewer than two characters (for the
2610 salt), force failure. Otherwise we get false positives: with an empty
2611 string the yield of crypt() is an empty string! */
2613 tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2614 (Ustrcmp(coded, sub[1]) == 0);
2617 #endif /* SUPPORT_CRYPTEQ */
2623 uschar *save_iterate_item = iterate_item;
2624 int (*compare)(const uschar *, const uschar *);
2627 if (cond_type == ECOND_INLISTI)
2630 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2632 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2633 if (compare(sub[0], iterate_item) == 0)
2638 iterate_item = save_iterate_item;
2641 } /* Switch for comparison conditions */
2643 *yield = tempcond == testfor;
2644 return s; /* End of comparison conditions */
2647 /* and/or: computes logical and/or of several conditions */
2651 subcondptr = (yield == NULL)? NULL : &tempcond;
2652 combined_cond = (cond_type == ECOND_AND);
2654 while (isspace(*s)) s++;
2655 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2659 while (isspace(*s)) s++;
2660 /* {-for-text-editors */
2661 if (*s == '}') break;
2662 if (*s != '{') /* }-for-text-editors */
2664 expand_string_message = string_sprintf("each subcondition "
2665 "inside an \"%s{...}\" condition must be in its own {}", name);
2669 s = eval_condition(s+1, subcondptr);
2672 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2673 expand_string_message, name);
2676 while (isspace(*s)) s++;
2678 /* {-for-text-editors */
2681 /* {-for-text-editors */
2682 expand_string_message = string_sprintf("missing } at end of condition "
2683 "inside \"%s\" group", name);
2689 if (cond_type == ECOND_AND)
2691 combined_cond &= tempcond;
2692 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2693 } /* evaluate any more */
2696 combined_cond |= tempcond;
2697 if (combined_cond) subcondptr = NULL; /* once true, don't */
2698 } /* evaluate any more */
2702 if (yield != NULL) *yield = (combined_cond == testfor);
2706 /* forall/forany: iterates a condition with different values */
2712 uschar *save_iterate_item = iterate_item;
2714 while (isspace(*s)) s++;
2715 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2716 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2717 if (sub[0] == NULL) return NULL;
2718 /* {-for-text-editors */
2719 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2721 while (isspace(*s)) s++;
2722 if (*s++ != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2726 /* Call eval_condition once, with result discarded (as if scanning a
2727 "false" part). This allows us to find the end of the condition, because if
2728 the list it empty, we won't actually evaluate the condition for real. */
2730 s = eval_condition(sub[1], NULL);
2733 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2734 expand_string_message, name);
2737 while (isspace(*s)) s++;
2739 /* {-for-text-editors */
2742 /* {-for-text-editors */
2743 expand_string_message = string_sprintf("missing } at end of condition "
2744 "inside \"%s\"", name);
2748 if (yield != NULL) *yield = !testfor;
2749 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2751 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2752 if (eval_condition(sub[1], &tempcond) == NULL)
2754 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2755 expand_string_message, name);
2756 iterate_item = save_iterate_item;
2759 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2760 tempcond? "true":"false");
2762 if (yield != NULL) *yield = (tempcond == testfor);
2763 if (tempcond == (cond_type == ECOND_FORANY)) break;
2766 iterate_item = save_iterate_item;
2771 /* The bool{} expansion condition maps a string to boolean.
2772 The values supported should match those supported by the ACL condition
2773 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2774 of true/false. Note that Router "condition" rules have a different
2775 interpretation, where general data can be used and only a few values
2777 Note that readconf.c boolean matching, for boolean configuration options,
2778 only matches true/yes/false/no.
2779 The bool_lax{} condition matches the Router logic, which is much more
2782 case ECOND_BOOL_LAX:
2788 BOOL boolvalue = FALSE;
2789 while (isspace(*s)) s++;
2790 if (*s != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2791 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2792 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2794 case 1: expand_string_message = string_sprintf(
2795 "too few arguments or bracketing error for %s",
2799 case 3: return NULL;
2802 while (isspace(*t)) t++;
2806 /* trailing whitespace: seems like a good idea to ignore it too */
2808 while (isspace(*t2)) t2--;
2809 if (t2 != (t + len))
2816 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2817 /* logic for the lax case from expand_check_condition(), which also does
2818 expands, and the logic is both short and stable enough that there should
2819 be no maintenance burden from replicating it. */
2822 else if (Ustrspn(t, "0123456789") == len)
2824 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2825 /* expand_check_condition only does a literal string "0" check */
2826 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2829 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2831 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2833 else if (cond_type == ECOND_BOOL_LAX)
2837 expand_string_message = string_sprintf("unrecognised boolean "
2841 if (yield != NULL) *yield = (boolvalue == testfor);
2845 /* Unknown condition */
2848 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2850 } /* End switch on condition type */
2852 /* Missing braces at start and end of data */
2854 COND_FAILED_CURLY_START:
2855 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2858 COND_FAILED_CURLY_END:
2859 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2863 /* A condition requires code that is not compiled */
2865 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2866 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2867 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2868 COND_FAILED_NOT_COMPILED:
2869 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2878 /*************************************************
2879 * Save numerical variables *
2880 *************************************************/
2882 /* This function is called from items such as "if" that want to preserve and
2883 restore the numbered variables.
2886 save_expand_string points to an array of pointers to set
2887 save_expand_nlength points to an array of ints for the lengths
2889 Returns: the value of expand max to save
2893 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2896 for (i = 0; i <= expand_nmax; i++)
2898 save_expand_nstring[i] = expand_nstring[i];
2899 save_expand_nlength[i] = expand_nlength[i];
2906 /*************************************************
2907 * Restore numerical variables *
2908 *************************************************/
2910 /* This function restored saved values of numerical strings.
2913 save_expand_nmax the number of strings to restore
2914 save_expand_string points to an array of pointers
2915 save_expand_nlength points to an array of ints
2921 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2922 int *save_expand_nlength)
2925 expand_nmax = save_expand_nmax;
2926 for (i = 0; i <= expand_nmax; i++)
2928 expand_nstring[i] = save_expand_nstring[i];
2929 expand_nlength[i] = save_expand_nlength[i];
2937 /*************************************************
2938 * Handle yes/no substrings *
2939 *************************************************/
2941 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2942 alternative substrings that depend on whether or not the condition was true,
2943 or the lookup or extraction succeeded. The substrings always have to be
2944 expanded, to check their syntax, but "skipping" is set when the result is not
2945 needed - this avoids unnecessary nested lookups.
2948 skipping TRUE if we were skipping when this item was reached
2949 yes TRUE if the first string is to be used, else use the second
2950 save_lookup a value to put back into lookup_value before the 2nd expansion
2951 sptr points to the input string pointer
2952 yieldptr points to the output string pointer
2953 sizeptr points to the output string size
2954 ptrptr points to the output string pointer
2955 type "lookup" or "if" or "extract" or "run", for error message
2957 Returns: 0 OK; lookup_value has been reset to save_lookup
2959 2 expansion failed because of bracketing error
2963 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2964 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2967 uschar *s = *sptr; /* Local value */
2968 uschar *sub1, *sub2;
2970 /* If there are no following strings, we substitute the contents of $value for
2971 lookups and for extractions in the success case. For the ${if item, the string
2972 "true" is substituted. In the fail case, nothing is substituted for all three
2975 while (isspace(*s)) s++;
2980 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2984 if (yes && lookup_value != NULL)
2985 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2986 Ustrlen(lookup_value));
2987 lookup_value = save_lookup;
2993 /* The first following string must be braced. */
2995 if (*s++ != '{') goto FAILED_CURLY;
2997 /* Expand the first substring. Forced failures are noticed only if we actually
2998 want this string. Set skipping in the call in the fail case (this will always
2999 be the case if we were already skipping). */
3001 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
3002 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3003 expand_string_forcedfail = FALSE;
3004 if (*s++ != '}') goto FAILED_CURLY;
3006 /* If we want the first string, add it to the output */
3009 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3011 /* If this is called from a lookup or an extract, we want to restore $value to
3012 what it was at the start of the item, so that it has this value during the
3013 second string expansion. For the call from "if" or "run" to this function,
3014 save_lookup is set to lookup_value, so that this statement does nothing. */
3016 lookup_value = save_lookup;
3018 /* There now follows either another substring, or "fail", or nothing. This
3019 time, forced failures are noticed only if we want the second string. We must
3020 set skipping in the nested call if we don't want this string, or if we were
3021 already skipping. */
3023 while (isspace(*s)) s++;
3026 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
3027 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3028 expand_string_forcedfail = FALSE;
3029 if (*s++ != '}') goto FAILED_CURLY;
3031 /* If we want the second string, add it to the output */
3034 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3037 /* If there is no second string, but the word "fail" is present when the use of
3038 the second string is wanted, set a flag indicating it was a forced failure
3039 rather than a syntactic error. Swallow the terminating } in case this is nested
3040 inside another lookup or if or extract. */
3045 s = read_name(name, sizeof(name), s, US"_");
3046 if (Ustrcmp(name, "fail") == 0)
3048 if (!yes && !skipping)
3050 while (isspace(*s)) s++;
3051 if (*s++ != '}') goto FAILED_CURLY;
3052 expand_string_message =
3053 string_sprintf("\"%s\" failed and \"fail\" requested", type);
3054 expand_string_forcedfail = TRUE;
3060 expand_string_message =
3061 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3066 /* All we have to do now is to check on the final closing brace. */
3068 while (isspace(*s)) s++;
3069 if (*s++ == '}') goto RETURN;
3071 /* Get here if there is a bracketing failure */
3076 /* Get here for other failures */
3081 /* Update the input pointer value before returning */
3091 /*************************************************
3092 * Handle MD5 or SHA-1 computation for HMAC *
3093 *************************************************/
3095 /* These are some wrapping functions that enable the HMAC code to be a bit
3096 cleaner. A good compiler will spot the tail recursion.
3099 type HMAC_MD5 or HMAC_SHA1
3100 remaining are as for the cryptographic hash functions
3106 chash_start(int type, void *base)
3108 if (type == HMAC_MD5)
3109 md5_start((md5 *)base);
3111 sha1_start((sha1 *)base);
3115 chash_mid(int type, void *base, uschar *string)
3117 if (type == HMAC_MD5)
3118 md5_mid((md5 *)base, string);
3120 sha1_mid((sha1 *)base, string);
3124 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3126 if (type == HMAC_MD5)
3127 md5_end((md5 *)base, string, length, digest);
3129 sha1_end((sha1 *)base, string, length, digest);
3136 /********************************************************
3137 * prvs: Get last three digits of days since Jan 1, 1970 *
3138 ********************************************************/
3140 /* This is needed to implement the "prvs" BATV reverse
3143 Argument: integer "days" offset to add or substract to
3144 or from the current number of days.
3146 Returns: pointer to string containing the last three
3147 digits of the number of days since Jan 1, 1970,
3148 modified by the offset argument, NULL if there
3149 was an error in the conversion.
3154 prvs_daystamp(int day_offset)
3156 uschar *days = store_get(32); /* Need at least 24 for cases */
3157 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
3158 (time(NULL) + day_offset*86400)/86400);
3159 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3164 /********************************************************
3165 * prvs: perform HMAC-SHA1 computation of prvs bits *
3166 ********************************************************/
3168 /* This is needed to implement the "prvs" BATV reverse
3172 address RFC2821 Address to use
3173 key The key to use (must be less than 64 characters
3175 key_num Single-digit key number to use. Defaults to
3178 Returns: pointer to string containing the first three
3179 bytes of the final hash in hex format, NULL if
3180 there was an error in the process.
3184 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3186 uschar *hash_source, *p;
3187 int size = 0,offset = 0,i;
3189 void *use_base = &sha1_base;
3190 uschar innerhash[20];
3191 uschar finalhash[20];
3192 uschar innerkey[64];
3193 uschar outerkey[64];
3194 uschar *finalhash_hex = store_get(40);
3196 if (key_num == NULL)
3199 if (Ustrlen(key) > 64)
3202 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3203 string_cat(hash_source,&size,&offset,daystamp,3);
3204 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3205 hash_source[offset] = '\0';
3207 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3209 memset(innerkey, 0x36, 64);
3210 memset(outerkey, 0x5c, 64);
3212 for (i = 0; i < Ustrlen(key); i++)
3214 innerkey[i] ^= key[i];
3215 outerkey[i] ^= key[i];
3218 chash_start(HMAC_SHA1, use_base);
3219 chash_mid(HMAC_SHA1, use_base, innerkey);
3220 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3222 chash_start(HMAC_SHA1, use_base);
3223 chash_mid(HMAC_SHA1, use_base, outerkey);
3224 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3227 for (i = 0; i < 3; i++)
3229 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3230 *p++ = hex_digits[finalhash[i] & 0x0f];
3234 return finalhash_hex;
3240 /*************************************************
3241 * Join a file onto the output string *
3242 *************************************************/
3244 /* This is used for readfile and after a run expansion. It joins the contents
3245 of a file onto the output string, globally replacing newlines with a given
3246 string (optionally). The file is closed at the end.
3250 yield pointer to the expandable string
3251 sizep pointer to the current size
3252 ptrp pointer to the current position
3253 eol newline replacement string, or NULL
3255 Returns: new value of string pointer
3259 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3262 uschar buffer[1024];
3264 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3266 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3268 int len = Ustrlen(buffer);
3269 if (eol != NULL && buffer[len-1] == '\n') len--;
3270 yield = string_cat(yield, sizep, ptrp, buffer, len);
3271 if (buffer[len] != 0)
3272 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3275 if (yield != NULL) yield[*ptrp] = 0;
3283 /*************************************************
3284 * Evaluate numeric expression *
3285 *************************************************/
3287 /* This is a set of mutually recursive functions that evaluate an arithmetic
3288 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3289 these functions that is called from elsewhere is eval_expr, whose interface is:
3292 sptr pointer to the pointer to the string - gets updated
3293 decimal TRUE if numbers are to be assumed decimal
3294 error pointer to where to put an error message - must be NULL on input
3295 endket TRUE if ')' must terminate - FALSE for external call
3297 Returns: on success: the value of the expression, with *error still NULL
3298 on failure: an undefined value, with *error = a message
3301 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3304 static int_eximarith_t
3305 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3308 int_eximarith_t x = eval_op_or(&s, decimal, error);
3314 *error = US"expecting closing parenthesis";
3316 while (isspace(*(++s)));
3318 else if (*s != 0) *error = US"expecting operator";
3325 static int_eximarith_t
3326 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3331 while (isspace(*s)) s++;
3336 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3338 switch (tolower(*s))
3341 case 'k': n *= 1024; s++; break;
3342 case 'm': n *= 1024*1024; s++; break;
3343 case 'g': n *= 1024*1024*1024; s++; break;
3345 while (isspace (*s)) s++;
3350 n = eval_expr(&s, decimal, error, 1);
3354 *error = US"expecting number or opening parenthesis";
3362 static int_eximarith_t
3363 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3367 while (isspace(*s)) s++;
3368 if (*s == '+' || *s == '-' || *s == '~')
3371 x = eval_op_unary(&s, decimal, error);
3372 if (op == '-') x = -x;
3373 else if (op == '~') x = ~x;
3377 x = eval_number(&s, decimal, error);
3384 static int_eximarith_t
3385 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3388 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3391 while (*s == '*' || *s == '/' || *s == '%')
3394 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3395 if (*error != NULL) break;
3396 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3397 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3398 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3399 * -N*M is INT_MIN will yielf INT_MIN.
3400 * Since we don't support floating point, this is somewhat simpler.
3401 * Ideally, we'd return an error, but since we overflow for all other
3402 * arithmetic, consistency suggests otherwise, but what's the correct value
3403 * to use? There is none.
3404 * The C standard guarantees overflow for unsigned arithmetic but signed
3405 * overflow invokes undefined behaviour; in practice, this is overflow
3406 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3407 * that long/longlong larger than int are available, or we could just work
3408 * with larger types. We should consider whether to guarantee 32bit eval
3409 * and 64-bit working variables, with errors returned. For now ...
3410 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3411 * can just let the other invalid results occur otherwise, as they have
3412 * until now. For this one case, we can coerce.
3414 if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3417 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3418 EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3428 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3444 static int_eximarith_t
3445 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3448 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3451 while (*s == '+' || *s == '-')
3454 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3455 if (*error != NULL) break;
3456 if (op == '+') x += y; else x -= y;
3464 static int_eximarith_t
3465 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3468 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3471 while ((*s == '<' || *s == '>') && s[1] == s[0])
3476 y = eval_op_sum(&s, decimal, error);
3477 if (*error != NULL) break;
3478 if (op == '<') x <<= y; else x >>= y;
3486 static int_eximarith_t
3487 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3490 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3497 y = eval_op_shift(&s, decimal, error);
3498 if (*error != NULL) break;
3507 static int_eximarith_t
3508 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3511 int_eximarith_t x = eval_op_and(&s, decimal, error);
3518 y = eval_op_and(&s, decimal, error);
3519 if (*error != NULL) break;
3528 static int_eximarith_t
3529 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3532 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3539 y = eval_op_xor(&s, decimal, error);
3540 if (*error != NULL) break;
3550 /*************************************************
3552 *************************************************/
3554 /* Returns either an unchanged string, or the expanded string in stacking pool
3555 store. Interpreted sequences are:
3557 \... normal escaping rules
3558 $name substitutes the variable
3560 ${op:string} operates on the expanded string value
3561 ${item{arg1}{arg2}...} expands the args and then does the business
3562 some literal args are not enclosed in {}
3564 There are now far too many operators and item types to make it worth listing
3565 them here in detail any more.
3567 We use an internal routine recursively to handle embedded substrings. The
3568 external function follows. The yield is NULL if the expansion failed, and there
3569 are two cases: if something collapsed syntactically, or if "fail" was given
3570 as the action on a lookup failure. These can be distinguised by looking at the
3571 variable expand_string_forcedfail, which is TRUE in the latter case.
3573 The skipping flag is set true when expanding a substring that isn't actually
3574 going to be used (after "if" or "lookup") and it prevents lookups from
3575 happening lower down.
3577 Store usage: At start, a store block of the length of the input plus 64
3578 is obtained. This is expanded as necessary by string_cat(), which might have to
3579 get a new block, or might be able to expand the original. At the end of the
3580 function we can release any store above that portion of the yield block that
3581 was actually used. In many cases this will be optimal.
3583 However: if the first item in the expansion is a variable name or header name,
3584 we reset the store before processing it; if the result is in fresh store, we
3585 use that without copying. This is helpful for expanding strings like
3586 $message_headers which can get very long.
3588 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3589 since resetting the store at the end of the expansion will free store that was
3590 allocated by the plugin code as well as the slop after the expanded string. So
3591 we skip any resets if ${dlfunc has been used. The same applies for ${acl. This
3592 is an unfortunate consequence of string expansion becoming too powerful.
3595 string the string to be expanded
3596 ket_ends true if expansion is to stop at }
3597 left if not NULL, a pointer to the first character after the
3598 expansion is placed here (typically used with ket_ends)
3599 skipping TRUE for recursive calls when the value isn't actually going
3600 to be used (to allow for optimisation)
3601 honour_dollar TRUE if $ is to be expanded,
3602 FALSE if it's just another character
3604 Returns: NULL if expansion fails:
3605 expand_string_forcedfail is set TRUE if failure was forced
3606 expand_string_message contains a textual error message
3607 a pointer to the expanded string on success
3611 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3612 BOOL skipping, BOOL honour_dollar)
3615 int size = Ustrlen(string)+ 64;
3617 uschar *yield = store_get(size);
3619 uschar *save_expand_nstring[EXPAND_MAXN+1];
3620 int save_expand_nlength[EXPAND_MAXN+1];
3621 BOOL resetok = TRUE;
3623 expand_string_forcedfail = FALSE;
3624 expand_string_message = US"";
3631 /* \ escapes the next character, which must exist, or else
3632 the expansion fails. There's a special escape, \N, which causes
3633 copying of the subject verbatim up to the next \N. Otherwise,
3634 the escapes are the standard set. */
3640 expand_string_message = US"\\ at end of string";
3647 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3648 yield = string_cat(yield, &size, &ptr, t, s - t);
3649 if (*s != 0) s += 2;
3655 ch[0] = string_interpret_escape(&s);
3657 yield = string_cat(yield, &size, &ptr, ch, 1);
3663 /* Anything other than $ is just copied verbatim, unless we are
3664 looking for a terminating } character. */
3666 if (ket_ends && *s == '}') break;
3668 if (*s != '$' || !honour_dollar)
3670 yield = string_cat(yield, &size, &ptr, s++, 1);
3674 /* No { after the $ - must be a plain name or a number for string
3675 match variable. There has to be a fudge for variables that are the
3676 names of header fields preceded by "$header_" because header field
3677 names can contain any printing characters except space and colon.
3678 For those that don't like typing this much, "$h_" is a synonym for
3679 "$header_". A non-existent header yields a NULL value; nothing is
3682 if (isalpha((*(++s))))
3687 s = read_name(name, sizeof(name), s, US"_");
3689 /* If this is the first thing to be expanded, release the pre-allocated
3692 if (ptr == 0 && yield != NULL)
3694 if (resetok) store_reset(yield);
3701 if (Ustrncmp(name, "h_", 2) == 0 ||
3702 Ustrncmp(name, "rh_", 3) == 0 ||
3703 Ustrncmp(name, "bh_", 3) == 0 ||
3704 Ustrncmp(name, "header_", 7) == 0 ||
3705 Ustrncmp(name, "rheader_", 8) == 0 ||
3706 Ustrncmp(name, "bheader_", 8) == 0)
3708 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3709 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3710 s = read_header_name(name, sizeof(name), s);
3711 value = find_header(name, FALSE, &newsize, want_raw, charset);
3713 /* If we didn't find the header, and the header contains a closing brace
3714 character, this may be a user error where the terminating colon
3715 has been omitted. Set a flag to adjust the error message in this case.
3716 But there is no error here - nothing gets inserted. */
3720 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3729 value = find_variable(name, FALSE, skipping, &newsize);
3732 expand_string_message =
3733 string_sprintf("unknown variable name \"%s\"", name);
3734 check_variable_error_message(name);
3739 /* If the data is known to be in a new buffer, newsize will be set to the
3740 size of that buffer. If this is the first thing in an expansion string,
3741 yield will be NULL; just point it at the new store instead of copying. Many
3742 expansion strings contain just one reference, so this is a useful
3743 optimization, especially for humungous headers. */
3745 len = Ustrlen(value);
3746 if (yield == NULL && newsize != 0)
3752 else yield = string_cat(yield, &size, &ptr, value, len);
3760 s = read_number(&n, s);
3761 if (n >= 0 && n <= expand_nmax)
3762 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3767 /* Otherwise, if there's no '{' after $ it's an error. */
3771 expand_string_message = US"$ not followed by letter, digit, or {";
3775 /* After { there can be various things, but they all start with
3776 an initial word, except for a number for a string match variable. */
3778 if (isdigit((*(++s))))
3781 s = read_number(&n, s);
3784 expand_string_message = US"} expected after number";
3787 if (n >= 0 && n <= expand_nmax)
3788 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3795 expand_string_message = US"letter or digit expected after ${";
3799 /* Allow "-" in names to cater for substrings with negative
3800 arguments. Since we are checking for known names after { this is
3803 s = read_name(name, sizeof(name), s, US"_-");
3804 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3808 /* Call an ACL from an expansion. We feed data in via $acl_arg1 - $acl_arg9.
3809 If the ACL returns accept or reject we return content set by "message ="
3810 There is currently no limit on recursion; this would have us call
3811 acl_check_internal() directly and get a current level from somewhere.
3812 See also the acl expansion condition ECOND_ACL and the traditional
3813 acl modifier ACLC_ACL.
3814 Assume that the function has side-effects on the store that must be preserved.
3818 /* ${acl {name} {arg1}{arg2}...} */
3820 uschar *sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
3823 switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl"))
3825 case 1: goto EXPAND_FAILED_CURLY;
3827 case 3: goto EXPAND_FAILED;
3829 if (skipping) continue;
3832 switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3837 yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3841 expand_string_forcedfail = TRUE;
3843 expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3848 /* Handle conditionals - preserve the values of the numerical expansion
3849 variables in case they get changed by a regular expression match in the
3850 condition. If not, they retain their external settings. At the end
3851 of this "if" section, they get restored to their previous values. */
3857 int save_expand_nmax =
3858 save_expand_strings(save_expand_nstring, save_expand_nlength);
3860 while (isspace(*s)) s++;
3861 next_s = eval_condition(s, skipping? NULL : &cond);
3862 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3865 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3866 cond? "true" : "false");
3870 /* The handling of "yes" and "no" result strings is now in a separate
3871 function that is also used by ${lookup} and ${extract} and ${run}. */
3873 switch(process_yesno(
3874 skipping, /* were previously skipping */
3875 cond, /* success/failure indicator */
3876 lookup_value, /* value to reset for string2 */
3877 &s, /* input pointer */
3878 &yield, /* output pointer */
3879 &size, /* output size */
3880 &ptr, /* output current point */
3881 US"if")) /* condition type */
3883 case 1: goto EXPAND_FAILED; /* when all is well, the */
3884 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3887 /* Restore external setting of expansion variables for continuation
3890 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3891 save_expand_nlength);
3895 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3896 expanding an internal string that isn't actually going to be used. All we
3897 need to do is check the syntax, so don't do a lookup at all. Preserve the
3898 values of the numerical expansion variables in case they get changed by a
3899 partial lookup. If not, they retain their external settings. At the end
3900 of this "lookup" section, they get restored to their previous values. */
3904 int stype, partial, affixlen, starflags;
3905 int expand_setup = 0;
3907 uschar *key, *filename, *affix;
3908 uschar *save_lookup_value = lookup_value;
3909 int save_expand_nmax =
3910 save_expand_strings(save_expand_nstring, save_expand_nlength);
3912 if ((expand_forbid & RDO_LOOKUP) != 0)
3914 expand_string_message = US"lookup expansions are not permitted";
3918 /* Get the key we are to look up for single-key+file style lookups.
3919 Otherwise set the key NULL pro-tem. */
3921 while (isspace(*s)) s++;
3924 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3925 if (key == NULL) goto EXPAND_FAILED;
3926 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3927 while (isspace(*s)) s++;
3931 /* Find out the type of database */
3935 expand_string_message = US"missing lookup type";
3939 /* The type is a string that may contain special characters of various
3940 kinds. Allow everything except space or { to appear; the actual content
3941 is checked by search_findtype_partial. */
3943 while (*s != 0 && *s != '{' && !isspace(*s))
3945 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3949 while (isspace(*s)) s++;
3951 /* Now check for the individual search type and any partial or default
3952 options. Only those types that are actually in the binary are valid. */
3954 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3958 expand_string_message = search_error_message;
3962 /* Check that a key was provided for those lookup types that need it,
3963 and was not supplied for those that use the query style. */
3965 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3969 expand_string_message = string_sprintf("missing {key} for single-"
3970 "key \"%s\" lookup", name);
3978 expand_string_message = string_sprintf("a single key was given for "
3979 "lookup type \"%s\", which is not a single-key lookup type", name);
3984 /* Get the next string in brackets and expand it. It is the file name for
3985 single-key+file lookups, and the whole query otherwise. In the case of
3986 queries that also require a file name (e.g. sqlite), the file name comes
3989 if (*s != '{') goto EXPAND_FAILED_CURLY;
3990 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3991 if (filename == NULL) goto EXPAND_FAILED;
3992 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3993 while (isspace(*s)) s++;
3995 /* If this isn't a single-key+file lookup, re-arrange the variables
3996 to be appropriate for the search_ functions. For query-style lookups,
3997 there is just a "key", and no file name. For the special query-style +
3998 file types, the query (i.e. "key") starts with a file name. */
4002 while (isspace(*filename)) filename++;
4005 if (mac_islookup(stype, lookup_querystyle))
4011 if (*filename != '/')
4013 expand_string_message = string_sprintf(
4014 "absolute file name expected for \"%s\" lookup", name);
4017 while (*key != 0 && !isspace(*key)) key++;
4018 if (*key != 0) *key++ = 0;
4022 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4023 the entry was not found. Note that there is no search_close() function.
4024 Files are left open in case of re-use. At suitable places in higher logic,
4025 search_tidyup() is called to tidy all open files. This can save opening
4026 the same file several times. However, files may also get closed when
4027 others are opened, if too many are open at once. The rule is that a
4028 handle should not be used after a second search_open().
4030 Request that a partial search sets up $1 and maybe $2 by passing
4031 expand_setup containing zero. If its value changes, reset expand_nmax,
4032 since new variables will have been set. Note that at the end of this
4033 "lookup" section, the old numeric variables are restored. */
4036 lookup_value = NULL;
4039 void *handle = search_open(filename, stype, 0, NULL, NULL);
4042 expand_string_message = search_error_message;
4045 lookup_value = search_find(handle, filename, key, partial, affix,
4046 affixlen, starflags, &expand_setup);
4047 if (search_find_defer)
4049 expand_string_message =
4050 string_sprintf("lookup of \"%s\" gave DEFER: %s",
4051 string_printing2(key, FALSE), search_error_message);
4054 if (expand_setup > 0) expand_nmax = expand_setup;
4057 /* The handling of "yes" and "no" result strings is now in a separate
4058 function that is also used by ${if} and ${extract}. */
4060 switch(process_yesno(
4061 skipping, /* were previously skipping */
4062 lookup_value != NULL, /* success/failure indicator */
4063 save_lookup_value, /* value to reset for string2 */
4064 &s, /* input pointer */
4065 &yield, /* output pointer */
4066 &size, /* output size */
4067 &ptr, /* output current point */
4068 US"lookup")) /* condition type */
4070 case 1: goto EXPAND_FAILED; /* when all is well, the */
4071 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4074 /* Restore external setting of expansion variables for carrying on
4075 at this level, and continue. */
4077 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4078 save_expand_nlength);
4082 /* If Perl support is configured, handle calling embedded perl subroutines,
4083 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4084 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4085 arguments (defined below). */
4087 #define EXIM_PERL_MAX_ARGS 8
4091 expand_string_message = US"\"${perl\" encountered, but this facility "
4092 "is not included in this binary";
4095 #else /* EXIM_PERL */
4097 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4100 if ((expand_forbid & RDO_PERL) != 0)
4102 expand_string_message = US"Perl calls are not permitted";
4106 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4109 case 1: goto EXPAND_FAILED_CURLY;
4111 case 3: goto EXPAND_FAILED;
4114 /* If skipping, we don't actually do anything */
4116 if (skipping) continue;
4118 /* Start the interpreter if necessary */
4120 if (!opt_perl_started)
4123 if (opt_perl_startup == NULL)
4125 expand_string_message = US"A setting of perl_startup is needed when "
4126 "using the Perl interpreter";
4129 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4130 initerror = init_perl(opt_perl_startup);
4131 if (initerror != NULL)
4133 expand_string_message =
4134 string_sprintf("error in perl_startup code: %s\n", initerror);
4137 opt_perl_started = TRUE;
4140 /* Call the function */
4142 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4143 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4144 sub_arg[0], sub_arg + 1);
4146 /* NULL yield indicates failure; if the message pointer has been set to
4147 NULL, the yield was undef, indicating a forced failure. Otherwise the
4148 message will indicate some kind of Perl error. */
4150 if (new_yield == NULL)
4152 if (expand_string_message == NULL)
4154 expand_string_message =
4155 string_sprintf("Perl subroutine \"%s\" returned undef to force "
4156 "failure", sub_arg[0]);
4157 expand_string_forcedfail = TRUE;
4162 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4163 set during a callback from Perl. */
4165 expand_string_forcedfail = FALSE;
4169 #endif /* EXIM_PERL */
4171 /* Transform email address to "prvs" scheme to use
4172 as BATV-signed return path */
4179 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
4181 case 1: goto EXPAND_FAILED_CURLY;
4183 case 3: goto EXPAND_FAILED;
4186 /* If skipping, we don't actually do anything */
4187 if (skipping) continue;
4189 /* sub_arg[0] is the address */
4190 domain = Ustrrchr(sub_arg[0],'@');
4191 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4193 expand_string_message = US"prvs first argument must be a qualified email address";
4197 /* Calculate the hash. The second argument must be a single-digit
4198 key number, or unset. */
4200 if (sub_arg[2] != NULL &&
4201 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4203 expand_string_message = US"prvs second argument must be a single digit";
4207 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4210 expand_string_message = US"prvs hmac-sha1 conversion failed";
4214 /* Now separate the domain from the local part */
4217 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4218 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4219 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4220 string_cat(yield,&size,&ptr,p,6);
4221 string_cat(yield,&size,&ptr,US"=",1);
4222 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4223 string_cat(yield,&size,&ptr,US"@",1);
4224 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4229 /* Check a prvs-encoded address for validity */
4231 case EITEM_PRVSCHECK:
4234 int mysize = 0, myptr = 0;
4238 /* TF: Ugliness: We want to expand parameter 1 first, then set
4239 up expansion variables that are used in the expansion of
4240 parameter 2. So we clone the string for the first
4241 expansion, where we only expand parameter 1.
4243 PH: Actually, that isn't necessary. The read_subs() function is
4244 designed to work this way for the ${if and ${lookup expansions. I've
4248 /* Reset expansion variables */
4249 prvscheck_result = NULL;
4250 prvscheck_address = NULL;
4251 prvscheck_keynum = NULL;
4253 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4255 case 1: goto EXPAND_FAILED_CURLY;
4257 case 3: goto EXPAND_FAILED;
4260 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4263 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4265 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4266 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4267 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4268 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4269 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4271 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4272 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4273 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4274 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4275 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4277 /* Set up expansion variables */
4278 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4279 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4280 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4281 prvscheck_address[myptr] = '\0';
4282 prvscheck_keynum = string_copy(key_num);
4284 /* Now expand the second argument */
4285 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4287 case 1: goto EXPAND_FAILED_CURLY;
4289 case 3: goto EXPAND_FAILED;
4292 /* Now we have the key and can check the address. */
4294 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4299 expand_string_message = US"hmac-sha1 conversion failed";
4303 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4304 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4306 if (Ustrcmp(p,hash) == 0)
4308 /* Success, valid BATV address. Now check the expiry date. */
4309 uschar *now = prvs_daystamp(0);
4310 unsigned int inow = 0,iexpire = 1;
4312 (void)sscanf(CS now,"%u",&inow);
4313 (void)sscanf(CS daystamp,"%u",&iexpire);
4315 /* When "iexpire" is < 7, a "flip" has occured.
4316 Adjust "inow" accordingly. */
4317 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4319 if (iexpire >= inow)
4321 prvscheck_result = US"1";
4322 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4326 prvscheck_result = NULL;
4327 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4332 prvscheck_result = NULL;
4333 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4336 /* Now expand the final argument. We leave this till now so that
4337 it can include $prvscheck_result. */
4339 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4341 case 1: goto EXPAND_FAILED_CURLY;
4343 case 3: goto EXPAND_FAILED;
4346 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4347 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4349 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4351 /* Reset the "internal" variables afterwards, because they are in
4352 dynamic store that will be reclaimed if the expansion succeeded. */
4354 prvscheck_address = NULL;
4355 prvscheck_keynum = NULL;
4359 /* Does not look like a prvs encoded address, return the empty string.
4360 We need to make sure all subs are expanded first, so as to skip over
4363 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4365 case 1: goto EXPAND_FAILED_CURLY;
4367 case 3: goto EXPAND_FAILED;
4374 /* Handle "readfile" to insert an entire file */
4376 case EITEM_READFILE:
4381 if ((expand_forbid & RDO_READFILE) != 0)
4383 expand_string_message = US"file insertions are not permitted";
4387 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4389 case 1: goto EXPAND_FAILED_CURLY;
4391 case 3: goto EXPAND_FAILED;
4394 /* If skipping, we don't actually do anything */
4396 if (skipping) continue;
4398 /* Open the file and read it */
4400 f = Ufopen(sub_arg[0], "rb");
4403 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4407 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4412 /* Handle "readsocket" to insert data from a Unix domain socket */
4414 case EITEM_READSOCK:
4420 struct sockaddr_un sockun; /* don't call this "sun" ! */
4424 if ((expand_forbid & RDO_READSOCK) != 0)
4426 expand_string_message = US"socket insertions are not permitted";
4430 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4431 because there may be a string for expansion on failure. */
4433 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4435 case 1: goto EXPAND_FAILED_CURLY;
4436 case 2: /* Won't occur: no end check */
4437 case 3: goto EXPAND_FAILED;
4440 /* Sort out timeout, if given */
4442 if (sub_arg[2] != NULL)
4444 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4447 expand_string_message = string_sprintf("bad time value %s",
4452 else sub_arg[3] = NULL; /* No eol if no timeout */
4454 /* If skipping, we don't actually do anything. Otherwise, arrange to
4455 connect to either an IP or a Unix socket. */
4459 /* Handle an IP (internet) domain */
4461 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4463 BOOL connected = FALSE;
4467 uschar *server_name = sub_arg[0] + 5;
4468 uschar *port_name = Ustrrchr(server_name, ':');
4470 /* Sort out the port */
4472 if (port_name == NULL)
4474 expand_string_message =
4475 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4478 *port_name++ = 0; /* Terminate server name */
4480 if (isdigit(*port_name))
4483 port = Ustrtol(port_name, &end, 0);
4484 if (end != port_name + Ustrlen(port_name))
4486 expand_string_message =
4487 string_sprintf("invalid port number %s", port_name);
4493 struct servent *service_info = getservbyname(CS port_name, "tcp");
4494 if (service_info == NULL)
4496 expand_string_message = string_sprintf("unknown port \"%s\"",
4500 port = ntohs(service_info->s_port);
4503 /* Sort out the server. */
4506 shost.address = NULL;
4510 namelen = Ustrlen(server_name);
4512 /* Anything enclosed in [] must be an IP address. */
4514 if (server_name[0] == '[' &&
4515 server_name[namelen - 1] == ']')
4517 server_name[namelen - 1] = 0;
4519 if (string_is_ip_address(server_name, NULL) == 0)
4521 expand_string_message =
4522 string_sprintf("malformed IP address \"%s\"", server_name);
4525 shost.name = shost.address = server_name;
4528 /* Otherwise check for an unadorned IP address */
4530 else if (string_is_ip_address(server_name, NULL) != 0)
4531 shost.name = shost.address = server_name;
4533 /* Otherwise lookup IP address(es) from the name */
4537 shost.name = server_name;
4538 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4539 FALSE) != HOST_FOUND)
4541 expand_string_message =
4542 string_sprintf("no IP address found for host %s", shost.name);
4547 /* Try to connect to the server - test each IP till one works */
4549 for (h = &shost; h != NULL; h = h->next)
4551 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4552 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4554 expand_string_message = string_sprintf("failed to create socket: "
4555 "%s", strerror(errno));
4559 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4568 expand_string_message = string_sprintf("failed to connect to "
4569 "socket %s: couldn't connect to any host", sub_arg[0],
4575 /* Handle a Unix domain socket */
4580 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4582 expand_string_message = string_sprintf("failed to create socket: %s",
4587 sockun.sun_family = AF_UNIX;
4588 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4591 sigalrm_seen = FALSE;
4593 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4597 expand_string_message = US "socket connect timed out";
4602 expand_string_message = string_sprintf("failed to connect to socket "
4603 "%s: %s", sub_arg[0], strerror(errno));
4608 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4610 /* Write the request string, if not empty */
4612 if (sub_arg[1][0] != 0)
4614 int len = Ustrlen(sub_arg[1]);
4615 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4617 if (write(fd, sub_arg[1], len) != len)
4619 expand_string_message = string_sprintf("request write to socket "
4620 "failed: %s", strerror(errno));
4625 /* Shut down the sending side of the socket. This helps some servers to
4626 recognise that it is their turn to do some work. Just in case some
4627 system doesn't have this function, make it conditional. */
4630 shutdown(fd, SHUT_WR);
4633 /* Now we need to read from the socket, under a timeout. The function
4634 that reads a file can be used. */
4636 f = fdopen(fd, "rb");
4637 sigalrm_seen = FALSE;
4639 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4643 /* After a timeout, we restore the pointer in the result, that is,
4644 make sure we add nothing from the socket. */
4649 expand_string_message = US "socket read timed out";
4654 /* The whole thing has worked (or we were skipping). If there is a
4655 failure string following, we need to skip it. */
4659 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4661 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4662 while (isspace(*s)) s++;
4664 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4667 /* Come here on failure to create socket, connect socket, write to the
4668 socket, or timeout on reading. If another substring follows, expand and
4669 use it. Otherwise, those conditions give expand errors. */
4672 if (*s != '{') goto EXPAND_FAILED;
4673 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4674 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4675 if (arg == NULL) goto EXPAND_FAILED;
4676 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4677 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4678 while (isspace(*s)) s++;
4679 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4683 /* Handle "run" to execute a program. */
4695 if ((expand_forbid & RDO_RUN) != 0)
4697 expand_string_message = US"running a command is not permitted";
4701 while (isspace(*s)) s++;
4702 if (*s != '{') goto EXPAND_FAILED_CURLY;
4703 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4704 if (arg == NULL) goto EXPAND_FAILED;
4705 while (isspace(*s)) s++;
4706 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4708 if (skipping) /* Just pretend it worked when we're skipping */
4714 if (!transport_set_up_command(&argv, /* anchor for arg list */
4715 arg, /* raw command */
4716 FALSE, /* don't expand the arguments */
4717 0, /* not relevant when... */
4718 NULL, /* no transporting address */
4719 US"${run} expansion", /* for error messages */
4720 &expand_string_message)) /* where to put error message */
4725 /* Create the child process, making it a group leader. */
4727 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4731 expand_string_message =
4732 string_sprintf("couldn't create child process: %s", strerror(errno));
4736 /* Nothing is written to the standard input. */
4740 /* Read the pipe to get the command's output into $value (which is kept
4741 in lookup_value). Read during execution, so that if the output exceeds
4742 the OS pipe buffer limit, we don't block forever. */
4744 f = fdopen(fd_out, "rb");
4745 sigalrm_seen = FALSE;
4747 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4751 /* Wait for the process to finish, applying the timeout, and inspect its
4752 return code for serious disasters. Simple non-zero returns are passed on.
4755 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4757 if (sigalrm_seen == TRUE || runrc == -256)
4759 expand_string_message = string_sprintf("command timed out");
4760 killpg(pid, SIGKILL); /* Kill the whole process group */
4763 else if (runrc == -257)
4764 expand_string_message = string_sprintf("wait() failed: %s",
4768 expand_string_message = string_sprintf("command killed by signal %d",
4775 /* Process the yes/no strings; $value may be useful in both cases */
4777 switch(process_yesno(
4778 skipping, /* were previously skipping */
4779 runrc == 0, /* success/failure indicator */
4780 lookup_value, /* value to reset for string2 */
4781 &s, /* input pointer */
4782 &yield, /* output pointer */
4783 &size, /* output size */
4784 &ptr, /* output current point */
4785 US"run")) /* condition type */
4787 case 1: goto EXPAND_FAILED; /* when all is well, the */
4788 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4794 /* Handle character translation for "tr" */
4802 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4804 case 1: goto EXPAND_FAILED_CURLY;
4806 case 3: goto EXPAND_FAILED;
4809 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4810 o2m = Ustrlen(sub[2]) - 1;
4812 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4814 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4818 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4825 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4826 expanded arguments. */
4836 int val[2] = { 0, -1 };
4839 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4840 Ensure that sub[2] is set in the ${length case. */
4843 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4846 case 1: goto EXPAND_FAILED_CURLY;
4848 case 3: goto EXPAND_FAILED;
4851 /* Juggle the arguments if there are only two of them: always move the
4852 string to the last position and make ${length{n}{str}} equivalent to
4853 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4859 if (item_type == EITEM_LENGTH)
4866 for (i = 0; i < 2; i++)
4868 if (sub[i] == NULL) continue;
4869 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4870 if (*ret != 0 || (i != 0 && val[i] < 0))
4872 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4873 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4879 (item_type == EITEM_HASH)?
4880 compute_hash(sub[2], val[0], val[1], &len) :
4881 (item_type == EITEM_NHASH)?
4882 compute_nhash(sub[2], val[0], val[1], &len) :
4883 extract_substr(sub[2], val[0], val[1], &len);
4885 if (ret == NULL) goto EXPAND_FAILED;
4886 yield = string_cat(yield, &size, &ptr, ret, len);
4890 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4891 This code originally contributed by Steve Haslam. It currently supports
4892 the use of MD5 and SHA-1 hashes.
4894 We need some workspace that is large enough to handle all the supported
4895 hash types. Use macros to set the sizes rather than be too elaborate. */
4897 #define MAX_HASHLEN 20
4898 #define MAX_HASHBLOCKLEN 64
4907 int hashlen; /* Number of octets for the hash algorithm's output */
4908 int hashblocklen; /* Number of octets the hash algorithm processes */
4910 unsigned int keylen;
4912 uschar keyhash[MAX_HASHLEN];
4913 uschar innerhash[MAX_HASHLEN];
4914 uschar finalhash[MAX_HASHLEN];
4915 uschar finalhash_hex[2*MAX_HASHLEN];
4916 uschar innerkey[MAX_HASHBLOCKLEN];
4917 uschar outerkey[MAX_HASHBLOCKLEN];
4919 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4921 case 1: goto EXPAND_FAILED_CURLY;
4923 case 3: goto EXPAND_FAILED;
4926 if (Ustrcmp(sub[0], "md5") == 0)
4929 use_base = &md5_base;
4933 else if (Ustrcmp(sub[0], "sha1") == 0)
4936 use_base = &sha1_base;
4942 expand_string_message =
4943 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4948 keylen = Ustrlen(keyptr);
4950 /* If the key is longer than the hash block length, then hash the key
4953 if (keylen > hashblocklen)
4955 chash_start(type, use_base);
4956 chash_end(type, use_base, keyptr, keylen, keyhash);
4961 /* Now make the inner and outer key values */
4963 memset(innerkey, 0x36, hashblocklen);
4964 memset(outerkey, 0x5c, hashblocklen);
4966 for (i = 0; i < keylen; i++)
4968 innerkey[i] ^= keyptr[i];
4969 outerkey[i] ^= keyptr[i];
4972 /* Now do the hashes */
4974 chash_start(type, use_base);
4975 chash_mid(type, use_base, innerkey);
4976 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4978 chash_start(type, use_base);
4979 chash_mid(type, use_base, outerkey);
4980 chash_end(type, use_base, innerhash, hashlen, finalhash);
4982 /* Encode the final hash as a hex string */
4985 for (i = 0; i < hashlen; i++)
4987 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4988 *p++ = hex_digits[finalhash[i] & 0x0f];
4991 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4992 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4994 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4999 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5000 We have to save the numerical variables and restore them afterwards. */
5005 int moffset, moffsetextra, slen;
5008 const uschar *rerror;
5011 int save_expand_nmax =
5012 save_expand_strings(save_expand_nstring, save_expand_nlength);
5014 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
5016 case 1: goto EXPAND_FAILED_CURLY;
5018 case 3: goto EXPAND_FAILED;
5021 /* Compile the regular expression */
5023 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5028 expand_string_message = string_sprintf("regular expression error in "
5029 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5033 /* Now run a loop to do the substitutions as often as necessary. It ends
5034 when there are no more matches. Take care over matches of the null string;
5035 do the same thing as Perl does. */
5038 slen = Ustrlen(sub[0]);
5039 moffset = moffsetextra = 0;
5044 int ovector[3*(EXPAND_MAXN+1)];
5045 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5046 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5050 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5051 is not necessarily the end. We want to repeat the match from one
5052 character further along, but leaving the basic offset the same (for
5053 copying below). We can't be at the end of the string - that was checked
5054 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5055 finished; copy the remaining string and end the loop. */
5065 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5069 /* Match - set up for expanding the replacement. */
5071 if (n == 0) n = EXPAND_MAXN + 1;
5073 for (nn = 0; nn < n*2; nn += 2)
5075 expand_nstring[expand_nmax] = subject + ovector[nn];
5076 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5080 /* Copy the characters before the match, plus the expanded insertion. */
5082 yield = string_cat(yield, &size, &ptr, subject + moffset,
5083 ovector[0] - moffset);
5084 insert = expand_string(sub[2]);
5085 if (insert == NULL) goto EXPAND_FAILED;
5086 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5088 moffset = ovector[1];
5092 /* If we have matched an empty string, first check to see if we are at
5093 the end of the subject. If so, the loop is over. Otherwise, mimic
5094 what Perl's /g options does. This turns out to be rather cunning. First
5095 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5096 string at the same point. If this fails (picked up above) we advance to
5097 the next character. */
5099 if (ovector[0] == ovector[1])
5101 if (ovector[0] == slen) break;
5102 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5106 /* All done - restore numerical variables. */
5108 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5109 save_expand_nlength);
5113 /* Handle keyed and numbered substring extraction. If the first argument
5114 consists entirely of digits, then a numerical extraction is assumed. */
5120 int field_number = 1;
5121 BOOL field_number_set = FALSE;
5122 uschar *save_lookup_value = lookup_value;
5124 int save_expand_nmax =
5125 save_expand_strings(save_expand_nstring, save_expand_nlength);
5127 /* Read the arguments */
5129 for (i = 0; i < j; i++)
5131 while (isspace(*s)) s++;
5134 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5135 if (sub[i] == NULL) goto EXPAND_FAILED;
5136 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5138 /* After removal of leading and trailing white space, the first
5139 argument must not be empty; if it consists entirely of digits
5140 (optionally preceded by a minus sign), this is a numerical
5141 extraction, and we expect 3 arguments. */
5149 while (isspace(*p)) p++;
5153 while (len > 0 && isspace(p[len-1])) len--;
5156 if (*p == 0 && !skipping)
5158 expand_string_message = US"first argument of \"extract\" must "
5168 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5172 j = 3; /* Need 3 args */
5173 field_number_set = TRUE;
5177 else goto EXPAND_FAILED_CURLY;
5180 /* Extract either the numbered or the keyed substring into $value. If
5181 skipping, just pretend the extraction failed. */
5183 lookup_value = skipping? NULL : field_number_set?
5184 expand_gettokened(field_number, sub[1], sub[2]) :
5185 expand_getkeyed(sub[0], sub[1]);
5187 /* If no string follows, $value gets substituted; otherwise there can
5188 be yes/no strings, as for lookup or if. */
5190 switch(process_yesno(
5191 skipping, /* were previously skipping */
5192 lookup_value != NULL, /* success/failure indicator */
5193 save_lookup_value, /* value to reset for string2 */
5194 &s, /* input pointer */
5195 &yield, /* output pointer */
5196 &size, /* output size */
5197 &ptr, /* output current point */
5198 US"extract")) /* condition type */
5200 case 1: goto EXPAND_FAILED; /* when all is well, the */
5201 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
5204 /* All done - restore numerical variables. */
5206 restore_expand_strings(save_expand_nmax, save_expand_nstring,
5207 save_expand_nlength);
5213 /* Handle list operations */
5221 uschar outsep[2] = { '\0', '\0' };
5222 uschar *list, *expr, *temp;
5223 uschar *save_iterate_item = iterate_item;
5224 uschar *save_lookup_value = lookup_value;
5226 while (isspace(*s)) s++;
5227 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5229 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5230 if (list == NULL) goto EXPAND_FAILED;
5231 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5233 if (item_type == EITEM_REDUCE)
5235 while (isspace(*s)) s++;
5236 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5237 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5238 if (temp == NULL) goto EXPAND_FAILED;
5239 lookup_value = temp;
5240 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5243 while (isspace(*s)) s++;
5244 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5248 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5249 if scanning a "false" part). This allows us to find the end of the
5250 condition, because if the list is empty, we won't actually evaluate the
5251 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5252 the normal internal expansion function. */
5254 if (item_type == EITEM_FILTER)
5256 temp = eval_condition(expr, NULL);
5257 if (temp != NULL) s = temp;
5261 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5266 expand_string_message = string_sprintf("%s inside \"%s\" item",
5267 expand_string_message, name);
5271 while (isspace(*s)) s++;
5274 expand_string_message = string_sprintf("missing } at end of condition "
5275 "or expression inside \"%s\"", name);
5279 while (isspace(*s)) s++;
5282 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5287 /* If we are skipping, we can now just move on to the next item. When
5288 processing for real, we perform the iteration. */
5290 if (skipping) continue;
5291 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5293 *outsep = (uschar)sep; /* Separator as a string */
5295 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5297 if (item_type == EITEM_FILTER)
5300 if (eval_condition(expr, &condresult) == NULL)
5302 iterate_item = save_iterate_item;
5303 lookup_value = save_lookup_value;
5304 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5305 expand_string_message, name);
5308 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5309 condresult? "true":"false");
5311 temp = iterate_item; /* TRUE => include this item */
5313 continue; /* FALSE => skip this item */
5316 /* EITEM_MAP and EITEM_REDUCE */
5320 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5323 iterate_item = save_iterate_item;
5324 expand_string_message = string_sprintf("%s inside \"%s\" item",
5325 expand_string_message, name);
5328 if (item_type == EITEM_REDUCE)
5330 lookup_value = temp; /* Update the value of $value */
5331 continue; /* and continue the iteration */
5335 /* We reach here for FILTER if the condition is true, always for MAP,
5336 and never for REDUCE. The value in "temp" is to be added to the output
5337 list that is being created, ensuring that any occurrences of the
5338 separator character are doubled. Unless we are dealing with the first
5339 item of the output list, add in a space if the new item begins with the
5340 separator character, or is an empty string. */
5342 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5343 yield = string_cat(yield, &size, &ptr, US" ", 1);
5345 /* Add the string in "temp" to the output list that we are building,
5346 This is done in chunks by searching for the separator character. */
5350 size_t seglen = Ustrcspn(temp, outsep);
5351 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5353 /* If we got to the end of the string we output one character
5354 too many; backup and end the loop. Otherwise arrange to double the
5357 if (temp[seglen] == '\0') { ptr--; break; }
5358 yield = string_cat(yield, &size, &ptr, outsep, 1);
5362 /* Output a separator after the string: we will remove the redundant
5363 final one at the end. */
5365 yield = string_cat(yield, &size, &ptr, outsep, 1);
5366 } /* End of iteration over the list loop */
5368 /* REDUCE has generated no output above: output the final value of
5371 if (item_type == EITEM_REDUCE)
5373 yield = string_cat(yield, &size, &ptr, lookup_value,
5374 Ustrlen(lookup_value));
5375 lookup_value = save_lookup_value; /* Restore $value */
5378 /* FILTER and MAP generate lists: if they have generated anything, remove
5379 the redundant final separator. Even though an empty item at the end of a
5380 list does not count, this is tidier. */
5382 else if (ptr != save_ptr) ptr--;
5384 /* Restore preserved $item */
5386 iterate_item = save_iterate_item;
5391 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5392 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5393 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5394 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5396 #define EXPAND_DLFUNC_MAX_ARGS 8
5399 #ifndef EXPAND_DLFUNC
5400 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5401 "is not included in this binary";
5404 #else /* EXPAND_DLFUNC */
5407 exim_dlfunc_t *func;
5410 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5412 if ((expand_forbid & RDO_DLFUNC) != 0)
5414 expand_string_message =
5415 US"dynamically-loaded functions are not permitted";
5419 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5422 case 1: goto EXPAND_FAILED_CURLY;
5424 case 3: goto EXPAND_FAILED;
5427 /* If skipping, we don't actually do anything */
5429 if (skipping) continue;
5431 /* Look up the dynamically loaded object handle in the tree. If it isn't
5432 found, dlopen() the file and put the handle in the tree for next time. */
5434 t = tree_search(dlobj_anchor, argv[0]);
5437 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5440 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5441 argv[0], dlerror());
5442 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5445 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5446 Ustrcpy(t->name, argv[0]);
5447 t->data.ptr = handle;
5448 (void)tree_insertnode(&dlobj_anchor, t);
5451 /* Having obtained the dynamically loaded object handle, look up the
5452 function pointer. */
5454 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5457 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5458 "%s", argv[1], argv[0], dlerror());
5459 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5463 /* Call the function and work out what to do with the result. If it
5464 returns OK, we have a replacement string; if it returns DEFER then
5465 expansion has failed in a non-forced manner; if it returns FAIL then
5466 failure was forced; if it returns ERROR or any other value there's a
5467 problem, so panic slightly. In any case, assume that the function has
5468 side-effects on the store that must be preserved. */
5472 for (argc = 0; argv[argc] != NULL; argc++);
5473 status = func(&result, argc - 2, &argv[2]);
5476 if (result == NULL) result = US"";
5477 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5482 expand_string_message = result == NULL ? US"(no message)" : result;
5483 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5484 else if(status != FAIL)
5485 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5486 argv[0], argv[1], status, expand_string_message);
5490 #endif /* EXPAND_DLFUNC */
5493 /* Control reaches here if the name is not recognized as one of the more
5494 complicated expansion items. Check for the "operator" syntax (name terminated
5495 by a colon). Some of the operators have arguments, separated by _ from the
5502 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5503 if (sub == NULL) goto EXPAND_FAILED;
5506 /* Owing to an historical mis-design, an underscore may be part of the
5507 operator name, or it may introduce arguments. We therefore first scan the
5508 table of names that contain underscores. If there is no match, we cut off
5509 the arguments and then scan the main table. */
5511 c = chop_match(name, op_table_underscore,
5512 sizeof(op_table_underscore)/sizeof(uschar *));
5516 arg = Ustrchr(name, '_');
5517 if (arg != NULL) *arg = 0;
5518 c = chop_match(name, op_table_main,
5519 sizeof(op_table_main)/sizeof(uschar *));
5520 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5521 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5524 /* If we are skipping, we don't need to perform the operation at all.
5525 This matters for operations like "mask", because the data may not be
5526 in the correct format when skipping. For example, the expression may test
5527 for the existence of $sender_host_address before trying to mask it. For
5528 other operations, doing them may not fail, but it is a waste of time. */
5530 if (skipping && c >= 0) continue;
5532 /* Otherwise, switch on the operator type */
5539 unsigned long int n = Ustrtoul(sub, &t, 10);
5542 expand_string_message = string_sprintf("argument for base62 "
5543 "operator is \"%s\", which is not a decimal number", sub);
5546 t = string_base62(n);
5547 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5551 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5557 unsigned long int n = 0;
5560 uschar *t = Ustrchr(base62_chars, *tt++);
5563 expand_string_message = string_sprintf("argument for base62d "
5564 "operator is \"%s\", which is not a base %d number", sub,
5568 n = n * BASE_62 + (t - base62_chars);
5570 (void)sprintf(CS buf, "%ld", n);
5571 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5577 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5578 if (expanded == NULL)
5580 expand_string_message =
5581 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5582 expand_string_message);
5585 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5592 uschar *t = sub - 1;
5593 while (*(++t) != 0) { *t = tolower(*t); count++; }
5594 yield = string_cat(yield, &size, &ptr, sub, count);
5601 uschar *t = sub - 1;
5602 while (*(++t) != 0) { *t = toupper(*t); count++; }
5603 yield = string_cat(yield, &size, &ptr, sub, count);
5614 md5_end(&base, sub, Ustrlen(sub), digest);
5615 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5616 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5627 sha1_end(&base, sub, Ustrlen(sub), digest);
5628 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5629 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5633 /* Convert hex encoding to base64 encoding */
5643 for (enc = sub; *enc != 0; enc++)
5645 if (!isxdigit(*enc))
5647 expand_string_message = string_sprintf("\"%s\" is not a hex "
5656 expand_string_message = string_sprintf("\"%s\" contains an odd "
5657 "number of characters", sub);
5661 while ((c = *in++) != 0)
5663 if (isdigit(c)) c -= '0';
5664 else c = toupper(c) - 'A' + 10;
5676 enc = auth_b64encode(sub, out - sub);
5677 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5681 /* Convert octets outside 0x21..0x7E to \xXX form */
5685 uschar *t = sub - 1;
5688 if (*t < 0x21 || 0x7E < *t)
5689 yield = string_cat(yield, &size, &ptr,
5690 string_sprintf("\\x%02x", *t), 4);
5692 yield = string_cat(yield, &size, &ptr, t, 1);
5697 /* count the number of list elements */
5706 while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5707 cp = string_sprintf("%d", cnt);
5708 yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5712 /* expand a named list given the name */
5713 /* handles nested named lists; requotes as colon-sep list */
5717 tree_node *t = NULL;
5721 uschar * suffix = US"";
5722 BOOL needsep = FALSE;
5725 if (*sub == '+') sub++;
5726 if (arg == NULL) /* no-argument version */
5728 if (!(t = tree_search(addresslist_anchor, sub)) &&
5729 !(t = tree_search(domainlist_anchor, sub)) &&
5730 !(t = tree_search(hostlist_anchor, sub)))
5731 t = tree_search(localpartlist_anchor, sub);
5733 else switch(*arg) /* specific list-type version */
5735 case 'a': t = tree_search(addresslist_anchor, sub); suffix = US"_a"; break;
5736 case 'd': t = tree_search(domainlist_anchor, sub); suffix = US"_d"; break;
5737 case 'h': t = tree_search(hostlist_anchor, sub); suffix = US"_h"; break;
5738 case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
5740 expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5746 expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5748 : *arg=='a'?"address "
5749 : *arg=='d'?"domain "
5751 : *arg=='l'?"localpart "
5756 list = ((namedlist_block *)(t->data.ptr))->string;
5758 while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5760 uschar * buf = US" : ";
5762 yield = string_cat(yield, &size, &ptr, buf, 3);
5766 if (*item == '+') /* list item is itself a named list */
5768 uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5769 item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE);
5771 else if (sep != ':') /* item from non-colon-sep list, re-quote for colon list-separator */
5775 tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5776 while ((cp= strpbrk((const char *)item, tok)))
5778 yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5779 if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5781 yield = string_cat(yield, &size, &ptr, US"::", 2);
5782 item = (uschar *)cp;
5784 else /* sep in item; should already be doubled; emit once */
5786 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5787 if (*cp == sep) cp++;
5788 item = (uschar *)cp;
5792 yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5797 /* mask applies a mask to an IP address; for example the result of
5798 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5805 int mask, maskoffset;
5806 int type = string_is_ip_address(sub, &maskoffset);
5811 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5816 if (maskoffset == 0)
5818 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5823 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5825 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5827 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5832 /* Convert the address to binary integer(s) and apply the mask */
5834 sub[maskoffset] = 0;
5835 count = host_aton(sub, binary);
5836 host_mask(count, binary, mask);
5838 /* Convert to masked textual format and add to output. */
5840 yield = string_cat(yield, &size, &ptr, buffer,
5841 host_nmtoa(count, binary, mask, buffer, '.'));
5846 case EOP_LOCAL_PART:
5850 int start, end, domain;
5851 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5855 if (c != EOP_DOMAIN)
5857 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5858 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5860 else if (domain != 0)
5863 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5871 uschar outsep[2] = { ':', '\0' };
5872 uschar *address, *error;
5874 int start, end, domain; /* Not really used */
5876 while (isspace(*sub)) sub++;
5877 if (*sub == '>') { *outsep = *++sub; ++sub; }
5878 parse_allow_group = TRUE;
5882 uschar *p = parse_find_address_end(sub, FALSE);
5883 uschar saveend = *p;
5885 address = parse_extract_address(sub, &error, &start, &end, &domain,
5889 /* Add the address to the output list that we are building. This is
5890 done in chunks by searching for the separator character. At the
5891 start, unless we are dealing with the first address of the output
5892 list, add in a space if the new address begins with the separator
5893 character, or is an empty string. */
5895 if (address != NULL)
5897 if (ptr != save_ptr && address[0] == *outsep)
5898 yield = string_cat(yield, &size, &ptr, US" ", 1);
5902 size_t seglen = Ustrcspn(address, outsep);
5903 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5905 /* If we got to the end of the string we output one character
5908 if (address[seglen] == '\0') { ptr--; break; }
5909 yield = string_cat(yield, &size, &ptr, outsep, 1);
5910 address += seglen + 1;
5913 /* Output a separator after the string: we will remove the
5914 redundant final one at the end. */
5916 yield = string_cat(yield, &size, &ptr, outsep, 1);
5919 if (saveend == '\0') break;
5923 /* If we have generated anything, remove the redundant final
5926 if (ptr != save_ptr) ptr--;
5927 parse_allow_group = FALSE;
5932 /* quote puts a string in quotes if it is empty or contains anything
5933 other than alphamerics, underscore, dot, or hyphen.
5935 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5936 be quoted in order to be a valid local part.
5938 In both cases, newlines and carriage returns are converted into \n and \r
5942 case EOP_QUOTE_LOCAL_PART:
5945 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5946 uschar *t = sub - 1;
5950 while (!needs_quote && *(++t) != 0)
5951 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5953 else /* EOP_QUOTE_LOCAL_PART */
5955 while (!needs_quote && *(++t) != 0)
5956 needs_quote = !isalnum(*t) &&
5957 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5958 (*t != '.' || t == sub || t[1] == 0);
5963 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5968 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5969 else if (*t == '\r')
5970 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5973 if (*t == '\\' || *t == '"')
5974 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5975 yield = string_cat(yield, &size, &ptr, t, 1);
5978 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5980 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5984 /* quote_lookuptype does lookup-specific quoting */
5989 uschar *opt = Ustrchr(arg, '_');
5991 if (opt != NULL) *opt++ = 0;
5993 n = search_findtype(arg, Ustrlen(arg));
5996 expand_string_message = search_error_message;
6000 if (lookup_list[n]->quote != NULL)
6001 sub = (lookup_list[n]->quote)(sub, opt);
6002 else if (opt != NULL) sub = NULL;
6006 expand_string_message = string_sprintf(
6007 "\"%s\" unrecognized after \"${quote_%s\"",
6012 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6016 /* rx quote sticks in \ before any non-alphameric character so that
6017 the insertion works in a regular expression. */
6021 uschar *t = sub - 1;
6025 yield = string_cat(yield, &size, &ptr, US"\\", 1);
6026 yield = string_cat(yield, &size, &ptr, t, 1);
6031 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6032 prescribed by the RFC, if there are characters that need to be encoded */
6036 uschar buffer[2048];
6037 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6038 buffer, sizeof(buffer), FALSE);
6039 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6043 /* RFC 2047 decode */
6049 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6050 headers_charset, '?', &len, &error);
6053 expand_string_message = error;
6056 yield = string_cat(yield, &size, &ptr, decoded, len);
6060 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6070 if (c > 255) c = '_';
6072 yield = string_cat(yield, &size, &ptr, buff, 1);
6077 /* escape turns all non-printing characters into escape sequences. */
6081 uschar *t = string_printing(sub);
6082 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6086 /* Handle numeric expression evaluation */
6091 uschar *save_sub = sub;
6092 uschar *error = NULL;
6093 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6096 expand_string_message = string_sprintf("error in expression "
6097 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6101 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6102 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6106 /* Handle time period formating */
6110 int n = readconf_readtime(sub, 0, FALSE);
6113 expand_string_message = string_sprintf("string \"%s\" is not an "
6114 "Exim time interval in \"%s\" operator", sub, name);
6117 sprintf(CS var_buffer, "%d", n);
6118 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6122 case EOP_TIME_INTERVAL:
6125 uschar *t = read_number(&n, sub);
6126 if (*t != 0) /* Not A Number*/
6128 expand_string_message = string_sprintf("string \"%s\" is not a "
6129 "positive number in \"%s\" operator", sub, name);
6132 t = readconf_printtime(n);
6133 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6137 /* Convert string to base64 encoding */
6141 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6142 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6146 /* strlen returns the length of the string */
6151 (void)sprintf(CS buff, "%d", Ustrlen(sub));
6152 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6156 /* length_n or l_n takes just the first n characters or the whole string,
6157 whichever is the shorter;
6159 substr_m_n, and s_m_n take n characters from offset m; negative m take
6160 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6161 takes the rest, either to the right or to the left.
6163 hash_n or h_n makes a hash of length n from the string, yielding n
6164 characters from the set a-z; hash_n_m makes a hash of length n, but
6165 uses m characters from the set a-zA-Z0-9.
6167 nhash_n returns a single number between 0 and n-1 (in text form), while
6168 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6169 between 0 and n-1 and the second between 0 and m-1. */
6189 expand_string_message = string_sprintf("missing values after %s",
6194 /* "length" has only one argument, effectively being synonymous with
6197 if (c == EOP_LENGTH || c == EOP_L)
6203 /* The others have one or two arguments; for "substr" the first may be
6204 negative. The second being negative means "not supplied". */
6209 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6212 /* Read up to two numbers, separated by underscores */
6217 if (arg != ret && *arg == '_' && pn == &value1)
6221 if (arg[1] != 0) arg++;
6223 else if (!isdigit(*arg))
6225 expand_string_message =
6226 string_sprintf("non-digit after underscore in \"%s\"", name);
6229 else *pn = (*pn)*10 + *arg++ - '0';
6233 /* Perform the required operation */
6236 (c == EOP_HASH || c == EOP_H)?
6237 compute_hash(sub, value1, value2, &len) :
6238 (c == EOP_NHASH || c == EOP_NH)?
6239 compute_nhash(sub, value1, value2, &len) :
6240 extract_substr(sub, value1, value2, &len);
6242 if (ret == NULL) goto EXPAND_FAILED;
6243 yield = string_cat(yield, &size, &ptr, ret, len);
6253 uschar **modetable[3];
6258 if ((expand_forbid & RDO_EXISTS) != 0)
6260 expand_string_message = US"Use of the stat() expansion is not permitted";
6264 if (stat(CS sub, &st) < 0)
6266 expand_string_message = string_sprintf("stat(%s) failed: %s",
6267 sub, strerror(errno));
6271 switch (mode & S_IFMT)
6273 case S_IFIFO: smode[0] = 'p'; break;
6274 case S_IFCHR: smode[0] = 'c'; break;
6275 case S_IFDIR: smode[0] = 'd'; break;
6276 case S_IFBLK: smode[0] = 'b'; break;
6277 case S_IFREG: smode[0] = '-'; break;
6278 default: smode[0] = '?'; break;
6281 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6282 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6283 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6285 for (i = 0; i < 3; i++)
6287 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6292 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6293 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6294 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6295 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6296 (long)st.st_gid, st.st_size, (long)st.st_atime,
6297 (long)st.st_mtime, (long)st.st_ctime);
6298 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6302 /* vaguely random number less than N */
6306 int_eximarith_t max;
6309 max = expand_string_integer(sub, TRUE);
6310 if (expand_string_message != NULL)
6312 s = string_sprintf("%d", vaguely_random_number((int)max));
6313 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6317 /* Reverse IP, including IPv6 to dotted-nibble */
6319 case EOP_REVERSE_IP:
6321 int family, maskptr;
6322 uschar reversed[128];
6324 family = string_is_ip_address(sub, &maskptr);
6327 expand_string_message = string_sprintf(
6328 "reverse_ip() not given an IP address [%s]", sub);
6331 invert_address(reversed, sub);
6332 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6336 /* Unknown operator */
6339 expand_string_message =
6340 string_sprintf("unknown expansion operator \"%s\"", name);
6345 /* Handle a plain name. If this is the first thing in the expansion, release
6346 the pre-allocated buffer. If the result data is known to be in a new buffer,
6347 newsize will be set to the size of that buffer, and we can just point at that
6348 store instead of copying. Many expansion strings contain just one reference,
6349 so this is a useful optimization, especially for humungous headers
6350 ($message_headers). */
6358 if (resetok) store_reset(yield);
6362 value = find_variable(name, FALSE, skipping, &newsize);
6365 expand_string_message =
6366 string_sprintf("unknown variable in \"${%s}\"", name);
6367 check_variable_error_message(name);
6370 len = Ustrlen(value);
6371 if (yield == NULL && newsize != 0)
6377 else yield = string_cat(yield, &size, &ptr, value, len);
6381 /* Else there's something wrong */
6383 expand_string_message =
6384 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6385 "in a variable reference)", name);
6389 /* If we hit the end of the string when ket_ends is set, there is a missing
6390 terminating brace. */
6392 if (ket_ends && *s == 0)
6394 expand_string_message = malformed_header?
6395 US"missing } at end of string - could be header name not terminated by colon"
6397 US"missing } at end of string";
6401 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6402 added to the string. If so, set up an empty string. Add a terminating zero. If
6403 left != NULL, return a pointer to the terminator. */
6405 if (yield == NULL) yield = store_get(1);
6407 if (left != NULL) *left = s;
6409 /* Any stacking store that was used above the final string is no longer needed.
6410 In many cases the final string will be the first one that was got and so there
6411 will be optimal store usage. */
6413 if (resetok) store_reset(yield + ptr + 1);
6416 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6418 if (skipping) debug_printf("skipping: result is not used\n");
6422 /* This is the failure exit: easiest to program with a goto. We still need
6423 to update the pointer to the terminator, for cases of nested calls with "fail".
6426 EXPAND_FAILED_CURLY:
6427 expand_string_message = malformed_header?
6428 US"missing or misplaced { or } - could be header name not terminated by colon"
6430 US"missing or misplaced { or }";
6432 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6433 that is a bad idea, because expand_string_message is in dynamic store. */
6436 if (left != NULL) *left = s;
6439 debug_printf("failed to expand: %s\n", string);
6440 debug_printf(" error message: %s\n", expand_string_message);
6441 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6447 /* This is the external function call. Do a quick check for any expansion
6448 metacharacters, and if there are none, just return the input string.
6450 Argument: the string to be expanded
6451 Returns: the expanded string, or NULL if expansion failed; if failure was
6452 due to a lookup deferring, search_find_defer will be TRUE
6456 expand_string(uschar *string)
6458 search_find_defer = FALSE;
6459 malformed_header = FALSE;
6460 return (Ustrpbrk(string, "$\\") == NULL)? string :
6461 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6466 /*************************************************
6468 *************************************************/
6470 /* Now and again we want to expand a string and be sure that the result is in a
6471 new bit of store. This function does that.
6473 Argument: the string to be expanded
6474 Returns: the expanded string, always in a new bit of store, or NULL
6478 expand_string_copy(uschar *string)
6480 uschar *yield = expand_string(string);
6481 if (yield == string) yield = string_copy(string);
6487 /*************************************************
6488 * Expand and interpret as an integer *
6489 *************************************************/
6491 /* Expand a string, and convert the result into an integer.
6494 string the string to be expanded
6495 isplus TRUE if a non-negative number is expected
6497 Returns: the integer value, or
6498 -1 for an expansion error ) in both cases, message in
6499 -2 for an integer interpretation error ) expand_string_message
6500 expand_string_message is set NULL for an OK integer
6504 expand_string_integer(uschar *string, BOOL isplus)
6506 int_eximarith_t value;
6507 uschar *s = expand_string(string);
6508 uschar *msg = US"invalid integer \"%s\"";
6511 /* If expansion failed, expand_string_message will be set. */
6513 if (s == NULL) return -1;
6515 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6516 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6517 systems, so we set it zero ourselves. */
6520 expand_string_message = NULL; /* Indicates no error */
6522 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6523 equal to 0. Unfortunately, people actually relied upon that, so preserve
6524 the behaviour explicitly. Stripping leading whitespace is a harmless
6525 noop change since strtol skips it anyway (provided that there is a number
6529 while (isspace(*s)) ++s;
6533 debug_printf("treating blank string as number 0\n");
6538 value = strtoll(CS s, CSS &endptr, 10);
6542 msg = US"integer expected but \"%s\" found";
6544 else if (value < 0 && isplus)
6546 msg = US"non-negative integer expected but \"%s\" found";
6550 switch (tolower(*endptr))
6555 if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
6560 if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
6561 else value *= 1024*1024;
6565 if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
6566 else value *= 1024*1024*1024;
6570 if (errno == ERANGE)
6571 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6574 while (isspace(*endptr)) endptr++;
6575 if (*endptr == 0) return value;
6579 expand_string_message = string_sprintf(CS msg, s);
6584 /*************************************************
6585 **************************************************
6586 * Stand-alone test program *
6587 **************************************************
6588 *************************************************/
6594 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6596 int ovector[3*(EXPAND_MAXN+1)];
6597 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6598 ovector, sizeof(ovector)/sizeof(int));
6599 BOOL yield = n >= 0;
6600 if (n == 0) n = EXPAND_MAXN + 1;
6604 expand_nmax = (setup < 0)? 0 : setup + 1;
6605 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6607 expand_nstring[expand_nmax] = subject + ovector[nn];
6608 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6616 int main(int argc, uschar **argv)
6619 uschar buffer[1024];
6621 debug_selector = D_v;
6622 debug_file = stderr;
6623 debug_fd = fileno(debug_file);
6624 big_buffer = malloc(big_buffer_size);
6626 for (i = 1; i < argc; i++)
6628 if (argv[i][0] == '+')
6630 debug_trace_memory = 2;
6633 if (isdigit(argv[i][0]))
6634 debug_selector = Ustrtol(argv[i], NULL, 0);
6636 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6640 eldap_default_servers = argv[i];
6643 mysql_servers = argv[i];
6646 pgsql_servers = argv[i];
6648 #ifdef EXPERIMENTAL_REDIS
6649 redis_servers = argv[i];
6653 else opt_perl_startup = argv[i];
6657 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6659 expand_nstring[1] = US"string 1....";
6660 expand_nlength[1] = 8;
6664 if (opt_perl_startup != NULL)
6667 printf("Starting Perl interpreter\n");
6668 errstr = init_perl(opt_perl_startup);
6671 printf("** error in perl_startup code: %s\n", errstr);
6672 return EXIT_FAILURE;
6675 #endif /* EXIM_PERL */
6677 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6679 void *reset_point = store_get(0);
6680 uschar *yield = expand_string(buffer);
6683 printf("%s\n", yield);
6684 store_reset(reset_point);
6688 if (search_find_defer) printf("search_find deferred\n");
6689 printf("Failed: %s\n", expand_string_message);
6690 if (expand_string_forcedfail) printf("Forced failure\n");
6702 /* End of expand.c */