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[] = {
148 /* Tables of operator names, and corresponding switch numbers. The names must be
149 in alphabetical order. There are two tables, because underscore is used in some
150 cases to introduce arguments, whereas for other it is part of the name. This is
151 an historical mis-design. */
153 static uschar *op_table_underscore[] = {
156 US"quote_local_part",
164 EOP_QUOTE_LOCAL_PART,
169 static uschar *op_table_main[] = {
203 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
236 /* Table of condition names, and corresponding switch numbers. The names must
237 be in alphabetical order. */
239 static uschar *cond_table[] = {
243 US"==", /* Backward compatibility */
275 US"match_local_part",
299 ECOND_FIRST_DELIVERY,
320 ECOND_MATCH_LOCAL_PART,
330 /* Type for main variable table */
338 /* Type for entries pointing to address/length pairs. Not currently
346 /* Types of table entry */
349 vtype_int, /* value is address of int */
350 vtype_filter_int, /* ditto, but recognized only when filtering */
351 vtype_ino, /* value is address of ino_t (not always an int) */
352 vtype_uid, /* value is address of uid_t (not always an int) */
353 vtype_gid, /* value is address of gid_t (not always an int) */
354 vtype_stringptr, /* value is address of pointer to string */
355 vtype_msgbody, /* as stringptr, but read when first required */
356 vtype_msgbody_end, /* ditto, the end of the message */
357 vtype_msgheaders, /* the message's headers, processed */
358 vtype_msgheaders_raw, /* the message's headers, unprocessed */
359 vtype_localpart, /* extract local part from string */
360 vtype_domain, /* extract domain from string */
361 vtype_recipients, /* extract recipients from recipients list */
362 /* (available only in system filters, ACLs, and */
364 vtype_todbsdin, /* value not used; generate BSD inbox tod */
365 vtype_tode, /* value not used; generate tod in epoch format */
366 vtype_todel, /* value not used; generate tod in epoch/usec format */
367 vtype_todf, /* value not used; generate full tod */
368 vtype_todl, /* value not used; generate log tod */
369 vtype_todlf, /* value not used; generate log file datestamp tod */
370 vtype_todzone, /* value not used; generate time zone only */
371 vtype_todzulu, /* value not used; generate zulu tod */
372 vtype_reply, /* value not used; get reply from headers */
373 vtype_pid, /* value not used; result is pid */
374 vtype_host_lookup, /* value not used; get host name */
375 vtype_load_avg, /* value not used; result is int from os_getloadavg */
376 vtype_pspace, /* partition space; value is T/F for spool/log */
377 vtype_pinodes /* partition inodes; value is T/F for spool/log */
379 ,vtype_dkim /* Lookup of value in DKIM signature */
383 /* This table must be kept in alphabetical order. */
385 static var_entry var_table[] = {
386 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
387 they will be confused with user-creatable ACL variables. */
388 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
389 { "address_data", vtype_stringptr, &deliver_address_data },
390 { "address_file", vtype_stringptr, &address_file },
391 { "address_pipe", vtype_stringptr, &address_pipe },
392 { "authenticated_id", vtype_stringptr, &authenticated_id },
393 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
394 { "authentication_failed",vtype_int, &authentication_failed },
395 #ifdef WITH_CONTENT_SCAN
396 { "av_failed", vtype_int, &av_failed },
398 #ifdef EXPERIMENTAL_BRIGHTMAIL
399 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
400 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
401 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
402 { "bmi_deliver", vtype_int, &bmi_deliver },
404 { "body_linecount", vtype_int, &body_linecount },
405 { "body_zerocount", vtype_int, &body_zerocount },
406 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
407 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
408 { "caller_gid", vtype_gid, &real_gid },
409 { "caller_uid", vtype_uid, &real_uid },
410 { "compile_date", vtype_stringptr, &version_date },
411 { "compile_number", vtype_stringptr, &version_cnumber },
412 { "csa_status", vtype_stringptr, &csa_status },
413 #ifdef EXPERIMENTAL_DCC
414 { "dcc_header", vtype_stringptr, &dcc_header },
415 { "dcc_result", vtype_stringptr, &dcc_result },
417 #ifdef WITH_OLD_DEMIME
418 { "demime_errorlevel", vtype_int, &demime_errorlevel },
419 { "demime_reason", vtype_stringptr, &demime_reason },
422 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
423 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
424 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
425 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
426 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
427 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
428 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
429 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
430 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
431 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
432 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
433 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
434 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
435 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
436 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
437 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
438 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
439 { "dkim_signers", vtype_stringptr, &dkim_signers },
440 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
441 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
443 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
444 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
445 { "dnslist_text", vtype_stringptr, &dnslist_text },
446 { "dnslist_value", vtype_stringptr, &dnslist_value },
447 { "domain", vtype_stringptr, &deliver_domain },
448 { "domain_data", vtype_stringptr, &deliver_domain_data },
449 { "exim_gid", vtype_gid, &exim_gid },
450 { "exim_path", vtype_stringptr, &exim_path },
451 { "exim_uid", vtype_uid, &exim_uid },
452 #ifdef WITH_OLD_DEMIME
453 { "found_extension", vtype_stringptr, &found_extension },
455 { "home", vtype_stringptr, &deliver_home },
456 { "host", vtype_stringptr, &deliver_host },
457 { "host_address", vtype_stringptr, &deliver_host_address },
458 { "host_data", vtype_stringptr, &host_data },
459 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
460 { "host_lookup_failed", vtype_int, &host_lookup_failed },
461 { "inode", vtype_ino, &deliver_inode },
462 { "interface_address", vtype_stringptr, &interface_address },
463 { "interface_port", vtype_int, &interface_port },
464 { "item", vtype_stringptr, &iterate_item },
466 { "ldap_dn", vtype_stringptr, &eldap_dn },
468 { "load_average", vtype_load_avg, NULL },
469 { "local_part", vtype_stringptr, &deliver_localpart },
470 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
471 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
472 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
473 { "local_scan_data", vtype_stringptr, &local_scan_data },
474 { "local_user_gid", vtype_gid, &local_user_gid },
475 { "local_user_uid", vtype_uid, &local_user_uid },
476 { "localhost_number", vtype_int, &host_number },
477 { "log_inodes", vtype_pinodes, (void *)FALSE },
478 { "log_space", vtype_pspace, (void *)FALSE },
479 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
480 #ifdef WITH_CONTENT_SCAN
481 { "malware_name", vtype_stringptr, &malware_name },
483 { "max_received_linelength", vtype_int, &max_received_linelength },
484 { "message_age", vtype_int, &message_age },
485 { "message_body", vtype_msgbody, &message_body },
486 { "message_body_end", vtype_msgbody_end, &message_body_end },
487 { "message_body_size", vtype_int, &message_body_size },
488 { "message_exim_id", vtype_stringptr, &message_id },
489 { "message_headers", vtype_msgheaders, NULL },
490 { "message_headers_raw", vtype_msgheaders_raw, NULL },
491 { "message_id", vtype_stringptr, &message_id },
492 { "message_linecount", vtype_int, &message_linecount },
493 { "message_size", vtype_int, &message_size },
494 #ifdef WITH_CONTENT_SCAN
495 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
496 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
497 { "mime_boundary", vtype_stringptr, &mime_boundary },
498 { "mime_charset", vtype_stringptr, &mime_charset },
499 { "mime_content_description", vtype_stringptr, &mime_content_description },
500 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
501 { "mime_content_id", vtype_stringptr, &mime_content_id },
502 { "mime_content_size", vtype_int, &mime_content_size },
503 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
504 { "mime_content_type", vtype_stringptr, &mime_content_type },
505 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
506 { "mime_filename", vtype_stringptr, &mime_filename },
507 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
508 { "mime_is_multipart", vtype_int, &mime_is_multipart },
509 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
510 { "mime_part_count", vtype_int, &mime_part_count },
512 { "n0", vtype_filter_int, &filter_n[0] },
513 { "n1", vtype_filter_int, &filter_n[1] },
514 { "n2", vtype_filter_int, &filter_n[2] },
515 { "n3", vtype_filter_int, &filter_n[3] },
516 { "n4", vtype_filter_int, &filter_n[4] },
517 { "n5", vtype_filter_int, &filter_n[5] },
518 { "n6", vtype_filter_int, &filter_n[6] },
519 { "n7", vtype_filter_int, &filter_n[7] },
520 { "n8", vtype_filter_int, &filter_n[8] },
521 { "n9", vtype_filter_int, &filter_n[9] },
522 { "original_domain", vtype_stringptr, &deliver_domain_orig },
523 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
524 { "originator_gid", vtype_gid, &originator_gid },
525 { "originator_uid", vtype_uid, &originator_uid },
526 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
527 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
528 { "pid", vtype_pid, NULL },
529 { "primary_hostname", vtype_stringptr, &primary_hostname },
530 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
531 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
532 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
533 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
534 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
535 { "rcpt_count", vtype_int, &rcpt_count },
536 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
537 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
538 { "received_count", vtype_int, &received_count },
539 { "received_for", vtype_stringptr, &received_for },
540 { "received_ip_address", vtype_stringptr, &interface_address },
541 { "received_port", vtype_int, &interface_port },
542 { "received_protocol", vtype_stringptr, &received_protocol },
543 { "received_time", vtype_int, &received_time },
544 { "recipient_data", vtype_stringptr, &recipient_data },
545 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
546 { "recipients", vtype_recipients, NULL },
547 { "recipients_count", vtype_int, &recipients_count },
548 #ifdef WITH_CONTENT_SCAN
549 { "regex_match_string", vtype_stringptr, ®ex_match_string },
551 { "reply_address", vtype_reply, NULL },
552 { "return_path", vtype_stringptr, &return_path },
553 { "return_size_limit", vtype_int, &bounce_return_size_limit },
554 { "runrc", vtype_int, &runrc },
555 { "self_hostname", vtype_stringptr, &self_hostname },
556 { "sender_address", vtype_stringptr, &sender_address },
557 { "sender_address_data", vtype_stringptr, &sender_address_data },
558 { "sender_address_domain", vtype_domain, &sender_address },
559 { "sender_address_local_part", vtype_localpart, &sender_address },
560 { "sender_data", vtype_stringptr, &sender_data },
561 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
562 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
563 { "sender_host_address", vtype_stringptr, &sender_host_address },
564 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
565 { "sender_host_name", vtype_host_lookup, NULL },
566 { "sender_host_port", vtype_int, &sender_host_port },
567 { "sender_ident", vtype_stringptr, &sender_ident },
568 { "sender_rate", vtype_stringptr, &sender_rate },
569 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
570 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
571 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
572 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
573 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
574 { "sending_port", vtype_int, &sending_port },
575 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
576 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
577 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
578 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
579 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
580 { "sn0", vtype_filter_int, &filter_sn[0] },
581 { "sn1", vtype_filter_int, &filter_sn[1] },
582 { "sn2", vtype_filter_int, &filter_sn[2] },
583 { "sn3", vtype_filter_int, &filter_sn[3] },
584 { "sn4", vtype_filter_int, &filter_sn[4] },
585 { "sn5", vtype_filter_int, &filter_sn[5] },
586 { "sn6", vtype_filter_int, &filter_sn[6] },
587 { "sn7", vtype_filter_int, &filter_sn[7] },
588 { "sn8", vtype_filter_int, &filter_sn[8] },
589 { "sn9", vtype_filter_int, &filter_sn[9] },
590 #ifdef WITH_CONTENT_SCAN
591 { "spam_bar", vtype_stringptr, &spam_bar },
592 { "spam_report", vtype_stringptr, &spam_report },
593 { "spam_score", vtype_stringptr, &spam_score },
594 { "spam_score_int", vtype_stringptr, &spam_score_int },
596 #ifdef EXPERIMENTAL_SPF
597 { "spf_guess", vtype_stringptr, &spf_guess },
598 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
599 { "spf_received", vtype_stringptr, &spf_received },
600 { "spf_result", vtype_stringptr, &spf_result },
601 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
603 { "spool_directory", vtype_stringptr, &spool_directory },
604 { "spool_inodes", vtype_pinodes, (void *)TRUE },
605 { "spool_space", vtype_pspace, (void *)TRUE },
606 #ifdef EXPERIMENTAL_SRS
607 { "srs_db_address", vtype_stringptr, &srs_db_address },
608 { "srs_db_key", vtype_stringptr, &srs_db_key },
609 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
610 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
611 { "srs_recipient", vtype_stringptr, &srs_recipient },
612 { "srs_status", vtype_stringptr, &srs_status },
614 { "thisaddress", vtype_stringptr, &filter_thisaddress },
616 /* The non-(in,out) variables are now deprecated */
617 { "tls_bits", vtype_int, &tls_in.bits },
618 { "tls_certificate_verified", vtype_int, &tls_in.certificate_verified },
619 { "tls_cipher", vtype_stringptr, &tls_in.cipher },
621 { "tls_in_bits", vtype_int, &tls_in.bits },
622 { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
623 { "tls_in_cipher", vtype_stringptr, &tls_in.cipher },
624 { "tls_in_peerdn", vtype_stringptr, &tls_in.peerdn },
625 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
626 { "tls_in_sni", vtype_stringptr, &tls_in.sni },
628 { "tls_out_bits", vtype_int, &tls_out.bits },
629 { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
630 { "tls_out_cipher", vtype_stringptr, &tls_out.cipher },
631 { "tls_out_peerdn", vtype_stringptr, &tls_out.peerdn },
632 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
633 { "tls_out_sni", vtype_stringptr, &tls_out.sni },
636 { "tls_peerdn", vtype_stringptr, &tls_in.peerdn }, /* mind the alphabetical order! */
637 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
638 { "tls_sni", vtype_stringptr, &tls_in.sni }, /* mind the alphabetical order! */
641 { "tod_bsdinbox", vtype_todbsdin, NULL },
642 { "tod_epoch", vtype_tode, NULL },
643 { "tod_epoch_l", vtype_todel, NULL },
644 { "tod_full", vtype_todf, NULL },
645 { "tod_log", vtype_todl, NULL },
646 { "tod_logfile", vtype_todlf, NULL },
647 { "tod_zone", vtype_todzone, NULL },
648 { "tod_zulu", vtype_todzulu, NULL },
649 { "value", vtype_stringptr, &lookup_value },
650 { "version_number", vtype_stringptr, &version_string },
651 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
652 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
653 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
654 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
655 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
656 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
659 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
660 static uschar var_buffer[256];
661 static BOOL malformed_header;
663 /* For textual hashes */
665 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
666 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
669 enum { HMAC_MD5, HMAC_SHA1 };
671 /* For numeric hashes */
673 static unsigned int prime[] = {
674 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
675 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
676 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
678 /* For printing modes in symbolic form */
680 static uschar *mtable_normal[] =
681 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
683 static uschar *mtable_setid[] =
684 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
686 static uschar *mtable_sticky[] =
687 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
691 /*************************************************
692 * Tables for UTF-8 support *
693 *************************************************/
695 /* Table of the number of extra characters, indexed by the first character
696 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
699 static uschar utf8_table1[] = {
700 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
701 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
702 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
703 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
705 /* These are the masks for the data bits in the first byte of a character,
706 indexed by the number of additional bytes. */
708 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
710 /* Get the next UTF-8 character, advancing the pointer. */
712 #define GETUTF8INC(c, ptr) \
714 if ((c & 0xc0) == 0xc0) \
716 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
718 c = (c & utf8_table2[a]) << s; \
722 c |= (*ptr++ & 0x3f) << s; \
727 /*************************************************
728 * Binary chop search on a table *
729 *************************************************/
731 /* This is used for matching expansion items and operators.
734 name the name that is being sought
735 table the table to search
736 table_size the number of items in the table
738 Returns: the offset in the table, or -1
742 chop_match(uschar *name, uschar **table, int table_size)
744 uschar **bot = table;
745 uschar **top = table + table_size;
749 uschar **mid = bot + (top - bot)/2;
750 int c = Ustrcmp(name, *mid);
751 if (c == 0) return mid - table;
752 if (c > 0) bot = mid + 1; else top = mid;
760 /*************************************************
761 * Check a condition string *
762 *************************************************/
764 /* This function is called to expand a string, and test the result for a "true"
765 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
766 forced fail or lookup defer. All store used by the function can be released on
769 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
772 condition the condition string
773 m1 text to be incorporated in panic error
776 Returns: TRUE if condition is met, FALSE if not
780 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
783 void *reset_point = store_get(0);
784 uschar *ss = expand_string(condition);
787 if (!expand_string_forcedfail && !search_find_defer)
788 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
789 "for %s %s: %s", condition, m1, m2, expand_string_message);
792 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
793 strcmpic(ss, US"false") != 0;
794 store_reset(reset_point);
801 /*************************************************
802 * Pseudo-random number generation *
803 *************************************************/
805 /* Pseudo-random number generation. The result is not "expected" to be
806 cryptographically strong but not so weak that someone will shoot themselves
807 in the foot using it as a nonce in some email header scheme or whatever
808 weirdness they'll twist this into. The result should ideally handle fork().
810 However, if we're stuck unable to provide this, then we'll fall back to
811 appallingly bad randomness.
813 If SUPPORT_TLS is defined then this will not be used except as an emergency
818 Returns a random number in range [0, max-1]
822 # define vaguely_random_number vaguely_random_number_fallback
825 vaguely_random_number(int max)
828 # undef vaguely_random_number
830 static pid_t pid = 0;
832 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
842 #ifdef HAVE_ARC4RANDOM
843 /* cryptographically strong randomness, common on *BSD platforms, not
844 so much elsewhere. Alas. */
846 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
847 #ifdef HAVE_SRANDOMDEV
848 /* uses random(4) for seeding */
851 gettimeofday(&tv, NULL);
852 srandom(tv.tv_sec | tv.tv_usec | getpid());
855 /* Poor randomness and no seeding here */
862 #ifdef HAVE_ARC4RANDOM
863 return arc4random() % max;
864 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
865 return random() % max;
867 /* This one returns a 16-bit number, definitely not crypto-strong */
868 return random_number(max);
875 /*************************************************
876 * Pick out a name from a string *
877 *************************************************/
879 /* If the name is too long, it is silently truncated.
882 name points to a buffer into which to put the name
883 max is the length of the buffer
884 s points to the first alphabetic character of the name
885 extras chars other than alphanumerics to permit
887 Returns: pointer to the first character after the name
889 Note: The test for *s != 0 in the while loop is necessary because
890 Ustrchr() yields non-NULL if the character is zero (which is not something
894 read_name(uschar *name, int max, uschar *s, uschar *extras)
897 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
899 if (ptr < max-1) name[ptr++] = *s;
908 /*************************************************
909 * Pick out the rest of a header name *
910 *************************************************/
912 /* A variable name starting $header_ (or just $h_ for those who like
913 abbreviations) might not be the complete header name because headers can
914 contain any printing characters in their names, except ':'. This function is
915 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
916 on the end, if the name was terminated by white space.
919 name points to a buffer in which the name read so far exists
920 max is the length of the buffer
921 s points to the first character after the name so far, i.e. the
922 first non-alphameric character after $header_xxxxx
924 Returns: a pointer to the first character after the header name
928 read_header_name(uschar *name, int max, uschar *s)
930 int prelen = Ustrchr(name, '_') - name + 1;
931 int ptr = Ustrlen(name) - prelen;
932 if (ptr > 0) memmove(name, name+prelen, ptr);
933 while (mac_isgraph(*s) && *s != ':')
935 if (ptr < max-1) name[ptr++] = *s;
946 /*************************************************
947 * Pick out a number from a string *
948 *************************************************/
951 n points to an integer into which to put the number
952 s points to the first digit of the number
954 Returns: a pointer to the character after the last digit
958 read_number(int *n, uschar *s)
961 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
967 /*************************************************
968 * Extract keyed subfield from a string *
969 *************************************************/
971 /* The yield is in dynamic store; NULL means that the key was not found.
974 key points to the name of the key
975 s points to the string from which to extract the subfield
977 Returns: NULL if the subfield was not found, or
978 a pointer to the subfield's data
982 expand_getkeyed(uschar *key, uschar *s)
984 int length = Ustrlen(key);
985 while (isspace(*s)) s++;
987 /* Loop to search for the key */
995 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
996 dkeylength = s - dkey;
997 while (isspace(*s)) s++;
998 if (*s == '=') while (isspace((*(++s))));
1000 data = string_dequote(&s);
1001 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1004 while (isspace(*s)) s++;
1013 /*************************************************
1014 * Extract numbered subfield from string *
1015 *************************************************/
1017 /* Extracts a numbered field from a string that is divided by tokens - for
1018 example a line from /etc/passwd is divided by colon characters. First field is
1019 numbered one. Negative arguments count from the right. Zero returns the whole
1020 string. Returns NULL if there are insufficient tokens in the string
1023 Modifies final argument - this is a dynamically generated string, so that's OK.
1026 field number of field to be extracted,
1027 first field = 1, whole string = 0, last field = -1
1028 separators characters that are used to break string into tokens
1029 s points to the string from which to extract the subfield
1031 Returns: NULL if the field was not found,
1032 a pointer to the field's data inside s (modified to add 0)
1036 expand_gettokened (int field, uschar *separators, uschar *s)
1041 uschar *fieldtext = NULL;
1043 if (field == 0) return s;
1045 /* Break the line up into fields in place; for field > 0 we stop when we have
1046 done the number of fields we want. For field < 0 we continue till the end of
1047 the string, counting the number of fields. */
1049 count = (field > 0)? field : INT_MAX;
1055 /* Previous field was the last one in the string. For a positive field
1056 number, this means there are not enough fields. For a negative field number,
1057 check that there are enough, and scan back to find the one that is wanted. */
1061 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1062 if ((-field) == (INT_MAX - count - 1)) return s;
1066 while (ss[-1] != 0) ss--;
1072 /* Previous field was not last in the string; save its start and put a
1076 len = Ustrcspn(ss, separators);
1087 /*************************************************
1088 * Extract a substring from a string *
1089 *************************************************/
1091 /* Perform the ${substr or ${length expansion operations.
1094 subject the input string
1095 value1 the offset from the start of the input string to the start of
1096 the output string; if negative, count from the right.
1097 value2 the length of the output string, or negative (-1) for unset
1098 if value1 is positive, unset means "all after"
1099 if value1 is negative, unset means "all before"
1100 len set to the length of the returned string
1102 Returns: pointer to the output string, or NULL if there is an error
1106 extract_substr(uschar *subject, int value1, int value2, int *len)
1108 int sublen = Ustrlen(subject);
1110 if (value1 < 0) /* count from right */
1114 /* If the position is before the start, skip to the start, and adjust the
1115 length. If the length ends up negative, the substring is null because nothing
1116 can precede. This falls out naturally when the length is unset, meaning "all
1122 if (value2 < 0) value2 = 0;
1126 /* Otherwise an unset length => characters before value1 */
1128 else if (value2 < 0)
1135 /* For a non-negative offset, if the starting position is past the end of the
1136 string, the result will be the null string. Otherwise, an unset length means
1137 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1141 if (value1 > sublen)
1146 else if (value2 < 0) value2 = sublen;
1149 /* Cut the length down to the maximum possible for the offset value, and get
1150 the required characters. */
1152 if (value1 + value2 > sublen) value2 = sublen - value1;
1154 return subject + value1;
1160 /*************************************************
1161 * Old-style hash of a string *
1162 *************************************************/
1164 /* Perform the ${hash expansion operation.
1167 subject the input string (an expanded substring)
1168 value1 the length of the output string; if greater or equal to the
1169 length of the input string, the input string is returned
1170 value2 the number of hash characters to use, or 26 if negative
1171 len set to the length of the returned string
1173 Returns: pointer to the output string, or NULL if there is an error
1177 compute_hash(uschar *subject, int value1, int value2, int *len)
1179 int sublen = Ustrlen(subject);
1181 if (value2 < 0) value2 = 26;
1182 else if (value2 > Ustrlen(hashcodes))
1184 expand_string_message =
1185 string_sprintf("hash count \"%d\" too big", value2);
1189 /* Calculate the hash text. We know it is shorter than the original string, so
1190 can safely place it in subject[] (we know that subject is always itself an
1191 expanded substring). */
1193 if (value1 < sublen)
1198 while ((c = (subject[j])) != 0)
1200 int shift = (c + j++) & 7;
1201 subject[i] ^= (c << shift) | (c >> (8-shift));
1202 if (++i >= value1) i = 0;
1204 for (i = 0; i < value1; i++)
1205 subject[i] = hashcodes[(subject[i]) % value2];
1207 else value1 = sublen;
1216 /*************************************************
1217 * Numeric hash of a string *
1218 *************************************************/
1220 /* Perform the ${nhash expansion operation. The first characters of the
1221 string are treated as most important, and get the highest prime numbers.
1224 subject the input string
1225 value1 the maximum value of the first part of the result
1226 value2 the maximum value of the second part of the result,
1227 or negative to produce only a one-part result
1228 len set to the length of the returned string
1230 Returns: pointer to the output string, or NULL if there is an error.
1234 compute_nhash (uschar *subject, int value1, int value2, int *len)
1236 uschar *s = subject;
1238 unsigned long int total = 0; /* no overflow */
1242 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1243 total += prime[i--] * (unsigned int)(*s++);
1246 /* If value2 is unset, just compute one number */
1250 s = string_sprintf("%d", total % value1);
1253 /* Otherwise do a div/mod hash */
1257 total = total % (value1 * value2);
1258 s = string_sprintf("%d/%d", total/value2, total % value2);
1269 /*************************************************
1270 * Find the value of a header or headers *
1271 *************************************************/
1273 /* Multiple instances of the same header get concatenated, and this function
1274 can also return a concatenation of all the header lines. When concatenating
1275 specific headers that contain lists of addresses, a comma is inserted between
1276 them. Otherwise we use a straight concatenation. Because some messages can have
1277 pathologically large number of lines, there is a limit on the length that is
1278 returned. Also, to avoid massive store use which would result from using
1279 string_cat() as it copies and extends strings, we do a preliminary pass to find
1280 out exactly how much store will be needed. On "normal" messages this will be
1284 name the name of the header, without the leading $header_ or $h_,
1285 or NULL if a concatenation of all headers is required
1286 exists_only TRUE if called from a def: test; don't need to build a string;
1287 just return a string that is not "" and not "0" if the header
1289 newsize return the size of memory block that was obtained; may be NULL
1290 if exists_only is TRUE
1291 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1292 other than concatenating, will be done on the header. Also used
1293 for $message_headers_raw.
1294 charset name of charset to translate MIME words to; used only if
1295 want_raw is false; if NULL, no translation is done (this is
1296 used for $bh_ and $bheader_)
1298 Returns: NULL if the header does not exist, else a pointer to a new
1303 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1306 BOOL found = name == NULL;
1308 int len = found? 0 : Ustrlen(name);
1310 uschar *yield = NULL;
1313 /* Loop for two passes - saves code repetition */
1315 for (i = 0; i < 2; i++)
1320 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1322 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1324 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1329 if (exists_only) return US"1"; /* don't need actual string */
1331 t = h->text + len; /* text to insert */
1332 if (!want_raw) /* unless wanted raw, */
1333 while (isspace(*t)) t++; /* remove leading white space */
1334 ilen = h->slen - (t - h->text); /* length to insert */
1336 /* Unless wanted raw, remove trailing whitespace, including the
1340 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1342 /* Set comma = 1 if handling a single header and it's one of those
1343 that contains an address list, except when asked for raw headers. Only
1344 need to do this once. */
1346 if (!want_raw && name != NULL && comma == 0 &&
1347 Ustrchr("BCFRST", h->type) != NULL)
1350 /* First pass - compute total store needed; second pass - compute
1351 total store used, including this header. */
1353 size += ilen + comma + 1; /* +1 for the newline */
1355 /* Second pass - concatentate the data, up to a maximum. Note that
1356 the loop stops when size hits the limit. */
1360 if (size > header_insert_maxlen)
1362 ilen -= size - header_insert_maxlen - 1;
1365 Ustrncpy(ptr, t, ilen);
1368 /* For a non-raw header, put in the comma if needed, then add
1369 back the newline we removed above, provided there was some text in
1372 if (!want_raw && ilen > 0)
1374 if (comma != 0) *ptr++ = ',';
1382 /* At end of first pass, return NULL if no header found. Then truncate size
1383 if necessary, and get the buffer to hold the data, returning the buffer size.
1388 if (!found) return NULL;
1389 if (size > header_insert_maxlen) size = header_insert_maxlen;
1390 *newsize = size + 1;
1391 ptr = yield = store_get(*newsize);
1395 /* That's all we do for raw header expansion. */
1402 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1403 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1404 function can return an error with decoded data if the charset translation
1405 fails. If decoding fails, it returns NULL. */
1409 uschar *decoded, *error;
1410 if (ptr > yield && ptr[-1] == '\n') ptr--;
1411 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1413 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1417 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1418 " input was: %s\n", error, yield);
1420 if (decoded != NULL) yield = decoded;
1429 /*************************************************
1430 * Find value of a variable *
1431 *************************************************/
1433 /* The table of variables is kept in alphabetic order, so we can search it
1434 using a binary chop. The "choplen" variable is nothing to do with the binary
1438 name the name of the variable being sought
1439 exists_only TRUE if this is a def: test; passed on to find_header()
1440 skipping TRUE => skip any processing evaluation; this is not the same as
1441 exists_only because def: may test for values that are first
1443 newsize pointer to an int which is initially zero; if the answer is in
1444 a new memory buffer, *newsize is set to its size
1446 Returns: NULL if the variable does not exist, or
1447 a pointer to the variable's contents, or
1448 something non-NULL if exists_only is TRUE
1452 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1455 int last = var_table_size;
1457 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1458 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1459 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1460 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1461 (this gave backwards compatibility at the changeover). There may be built-in
1462 variables whose names start acl_ but they should never start in this way. This
1463 slightly messy specification is a consequence of the history, needless to say.
1465 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1466 set, in which case give an error. */
1468 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1472 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1473 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1476 /* Handle $auth<n> variables. */
1478 if (Ustrncmp(name, "auth", 4) == 0)
1481 int n = Ustrtoul(name + 4, &endptr, 10);
1482 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1483 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1486 /* For all other variables, search the table */
1488 while (last > first)
1492 int middle = (first + last)/2;
1493 int c = Ustrcmp(name, var_table[middle].name);
1495 if (c > 0) { first = middle + 1; continue; }
1496 if (c < 0) { last = middle; continue; }
1498 /* Found an existing variable. If in skipping state, the value isn't needed,
1499 and we want to avoid processing (such as looking up the host name). */
1501 if (skipping) return US"";
1503 switch (var_table[middle].type)
1505 case vtype_filter_int:
1506 if (!filter_running) return NULL;
1510 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1514 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1518 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1522 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1525 case vtype_stringptr: /* Pointer to string */
1526 s = *((uschar **)(var_table[middle].value));
1527 return (s == NULL)? US"" : s;
1530 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1533 case vtype_load_avg:
1534 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1537 case vtype_host_lookup: /* Lookup if not done so */
1538 if (sender_host_name == NULL && sender_host_address != NULL &&
1539 !host_lookup_failed && host_name_lookup() == OK)
1540 host_build_sender_fullhost();
1541 return (sender_host_name == NULL)? US"" : sender_host_name;
1543 case vtype_localpart: /* Get local part from address */
1544 s = *((uschar **)(var_table[middle].value));
1545 if (s == NULL) return US"";
1546 domain = Ustrrchr(s, '@');
1547 if (domain == NULL) return s;
1548 if (domain - s > sizeof(var_buffer) - 1)
1549 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1550 " in string expansion", sizeof(var_buffer));
1551 Ustrncpy(var_buffer, s, domain - s);
1552 var_buffer[domain - s] = 0;
1555 case vtype_domain: /* Get domain from address */
1556 s = *((uschar **)(var_table[middle].value));
1557 if (s == NULL) return US"";
1558 domain = Ustrrchr(s, '@');
1559 return (domain == NULL)? US"" : domain + 1;
1561 case vtype_msgheaders:
1562 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1564 case vtype_msgheaders_raw:
1565 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1567 case vtype_msgbody: /* Pointer to msgbody string */
1568 case vtype_msgbody_end: /* Ditto, the end of the msg */
1569 ss = (uschar **)(var_table[middle].value);
1570 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1573 off_t start_offset = SPOOL_DATA_START_OFFSET;
1574 int len = message_body_visible;
1575 if (len > message_size) len = message_size;
1576 *ss = body = store_malloc(len+1);
1578 if (var_table[middle].type == vtype_msgbody_end)
1580 struct stat statbuf;
1581 if (fstat(deliver_datafile, &statbuf) == 0)
1583 start_offset = statbuf.st_size - len;
1584 if (start_offset < SPOOL_DATA_START_OFFSET)
1585 start_offset = SPOOL_DATA_START_OFFSET;
1588 lseek(deliver_datafile, start_offset, SEEK_SET);
1589 len = read(deliver_datafile, body, len);
1593 if (message_body_newlines) /* Separate loops for efficiency */
1596 { if (body[--len] == 0) body[len] = ' '; }
1601 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1605 return (*ss == NULL)? US"" : *ss;
1607 case vtype_todbsdin: /* BSD inbox time of day */
1608 return tod_stamp(tod_bsdin);
1610 case vtype_tode: /* Unix epoch time of day */
1611 return tod_stamp(tod_epoch);
1613 case vtype_todel: /* Unix epoch/usec time of day */
1614 return tod_stamp(tod_epoch_l);
1616 case vtype_todf: /* Full time of day */
1617 return tod_stamp(tod_full);
1619 case vtype_todl: /* Log format time of day */
1620 return tod_stamp(tod_log_bare); /* (without timezone) */
1622 case vtype_todzone: /* Time zone offset only */
1623 return tod_stamp(tod_zone);
1625 case vtype_todzulu: /* Zulu time */
1626 return tod_stamp(tod_zulu);
1628 case vtype_todlf: /* Log file datestamp tod */
1629 return tod_stamp(tod_log_datestamp_daily);
1631 case vtype_reply: /* Get reply address */
1632 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1634 if (s != NULL) while (isspace(*s)) s++;
1635 if (s == NULL || *s == 0)
1637 *newsize = 0; /* For the *s==0 case */
1638 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1643 while (isspace(*s)) s++;
1644 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1645 while (t > s && isspace(t[-1])) t--;
1648 return (s == NULL)? US"" : s;
1650 /* A recipients list is available only during system message filtering,
1651 during ACL processing after DATA, and while expanding pipe commands
1652 generated from a system filter, but not elsewhere. */
1654 case vtype_recipients:
1655 if (!enable_dollar_recipients) return NULL; else
1660 s = store_get(size);
1661 for (i = 0; i < recipients_count; i++)
1663 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1664 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1665 Ustrlen(recipients_list[i].address));
1667 s[ptr] = 0; /* string_cat() leaves room */
1674 sprintf(CS var_buffer, "%d",
1675 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1682 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1683 sprintf(CS var_buffer, "%d", inodes);
1687 #ifndef DISABLE_DKIM
1689 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1695 return NULL; /* Unknown variable name */
1702 modify_variable(uschar *name, void * value)
1705 int last = var_table_size;
1707 while (last > first)
1709 int middle = (first + last)/2;
1710 int c = Ustrcmp(name, var_table[middle].name);
1712 if (c > 0) { first = middle + 1; continue; }
1713 if (c < 0) { last = middle; continue; }
1715 /* Found an existing variable; change the item it refers to */
1716 var_table[middle].value = value;
1719 return; /* Unknown variable name, fail silently */
1726 /*************************************************
1727 * Read and expand substrings *
1728 *************************************************/
1730 /* This function is called to read and expand argument substrings for various
1731 expansion items. Some have a minimum requirement that is less than the maximum;
1732 in these cases, the first non-present one is set to NULL.
1735 sub points to vector of pointers to set
1736 n maximum number of substrings
1738 sptr points to current string pointer
1739 skipping the skipping flag
1740 check_end if TRUE, check for final '}'
1741 name name of item, for error message
1743 Returns: 0 OK; string pointer updated
1744 1 curly bracketing error (too few arguments)
1745 2 too many arguments (only if check_end is set); message set
1746 3 other error (expansion failure)
1750 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1751 BOOL check_end, uschar *name)
1756 while (isspace(*s)) s++;
1757 for (i = 0; i < n; i++)
1761 if (i < m) return 1;
1765 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1766 if (sub[i] == NULL) return 3;
1767 if (*s++ != '}') return 1;
1768 while (isspace(*s)) s++;
1770 if (check_end && *s++ != '}')
1774 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1775 "(max is %d)", name, n);
1788 /*************************************************
1789 * Elaborate message for bad variable *
1790 *************************************************/
1792 /* For the "unknown variable" message, take a look at the variable's name, and
1793 give additional information about possible ACL variables. The extra information
1794 is added on to expand_string_message.
1796 Argument: the name of the variable
1801 check_variable_error_message(uschar *name)
1803 if (Ustrncmp(name, "acl_", 4) == 0)
1804 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1805 (name[4] == 'c' || name[4] == 'm')?
1807 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1808 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1810 US"user-defined ACL variables must start acl_c or acl_m");
1815 /*************************************************
1816 * Read and evaluate a condition *
1817 *************************************************/
1821 s points to the start of the condition text
1822 yield points to a BOOL to hold the result of the condition test;
1823 if NULL, we are just reading through a condition that is
1824 part of an "or" combination to check syntax, or in a state
1825 where the answer isn't required
1827 Returns: a pointer to the first character after the condition, or
1832 eval_condition(uschar *s, BOOL *yield)
1834 BOOL testfor = TRUE;
1835 BOOL tempcond, combined_cond;
1837 BOOL sub2_honour_dollar = TRUE;
1838 int i, rc, cond_type, roffset;
1839 int_eximarith_t num[2];
1840 struct stat statbuf;
1845 const uschar *rerror;
1849 while (isspace(*s)) s++;
1850 if (*s == '!') { testfor = !testfor; s++; } else break;
1853 /* Numeric comparisons are symbolic */
1855 if (*s == '=' || *s == '>' || *s == '<')
1867 /* All other conditions are named */
1869 else s = read_name(name, 256, s, US"_");
1871 /* If we haven't read a name, it means some non-alpha character is first. */
1875 expand_string_message = string_sprintf("condition name expected, "
1876 "but found \"%.16s\"", s);
1880 /* Find which condition we are dealing with, and switch on it */
1882 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1885 /* def: tests for a non-empty variable, or for the existence of a header. If
1886 yield == NULL we are in a skipping state, and don't care about the answer. */
1891 expand_string_message = US"\":\" expected after \"def\"";
1895 s = read_name(name, 256, s+1, US"_");
1897 /* Test for a header's existence. If the name contains a closing brace
1898 character, this may be a user error where the terminating colon has been
1899 omitted. Set a flag to adjust a subsequent error message in this case. */
1901 if (Ustrncmp(name, "h_", 2) == 0 ||
1902 Ustrncmp(name, "rh_", 3) == 0 ||
1903 Ustrncmp(name, "bh_", 3) == 0 ||
1904 Ustrncmp(name, "header_", 7) == 0 ||
1905 Ustrncmp(name, "rheader_", 8) == 0 ||
1906 Ustrncmp(name, "bheader_", 8) == 0)
1908 s = read_header_name(name, 256, s);
1909 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1910 if (yield != NULL) *yield =
1911 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1914 /* Test for a variable's having a non-empty value. A non-existent variable
1915 causes an expansion failure. */
1919 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1922 expand_string_message = (name[0] == 0)?
1923 string_sprintf("variable name omitted after \"def:\"") :
1924 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1925 check_variable_error_message(name);
1928 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1934 /* first_delivery tests for first delivery attempt */
1936 case ECOND_FIRST_DELIVERY:
1937 if (yield != NULL) *yield = deliver_firsttime == testfor;
1941 /* queue_running tests for any process started by a queue runner */
1943 case ECOND_QUEUE_RUNNING:
1944 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1948 /* exists: tests for file existence
1949 isip: tests for any IP address
1950 isip4: tests for an IPv4 address
1951 isip6: tests for an IPv6 address
1952 pam: does PAM authentication
1953 radius: does RADIUS authentication
1954 ldapauth: does LDAP authentication
1955 pwcheck: does Cyrus SASL pwcheck authentication
1964 case ECOND_LDAPAUTH:
1967 while (isspace(*s)) s++;
1968 if (*s != '{') goto COND_FAILED_CURLY_START;
1970 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
1971 if (sub[0] == NULL) return NULL;
1972 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1974 if (yield == NULL) return s; /* No need to run the test if skipping */
1979 if ((expand_forbid & RDO_EXISTS) != 0)
1981 expand_string_message = US"File existence tests are not permitted";
1984 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1990 rc = string_is_ip_address(sub[0], NULL);
1991 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1992 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1995 /* Various authentication tests - all optionally compiled */
1999 rc = auth_call_pam(sub[0], &expand_string_message);
2002 goto COND_FAILED_NOT_COMPILED;
2003 #endif /* SUPPORT_PAM */
2006 #ifdef RADIUS_CONFIG_FILE
2007 rc = auth_call_radius(sub[0], &expand_string_message);
2010 goto COND_FAILED_NOT_COMPILED;
2011 #endif /* RADIUS_CONFIG_FILE */
2013 case ECOND_LDAPAUTH:
2016 /* Just to keep the interface the same */
2018 int old_pool = store_pool;
2019 store_pool = POOL_SEARCH;
2020 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2021 &expand_string_message, &do_cache);
2022 store_pool = old_pool;
2026 goto COND_FAILED_NOT_COMPILED;
2027 #endif /* LOOKUP_LDAP */
2030 #ifdef CYRUS_PWCHECK_SOCKET
2031 rc = auth_call_pwcheck(sub[0], &expand_string_message);
2034 goto COND_FAILED_NOT_COMPILED;
2035 #endif /* CYRUS_PWCHECK_SOCKET */
2037 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2038 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2040 if (rc == ERROR || rc == DEFER) return NULL;
2041 *yield = (rc == OK) == testfor;
2047 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2049 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
2051 However, the last two are optional. That is why the whole set is enclosed
2052 in their own set or braces. */
2054 case ECOND_SASLAUTHD:
2055 #ifndef CYRUS_SASLAUTHD_SOCKET
2056 goto COND_FAILED_NOT_COMPILED;
2058 while (isspace(*s)) s++;
2059 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2060 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2062 case 1: expand_string_message = US"too few arguments or bracketing "
2063 "error for saslauthd";
2065 case 3: return NULL;
2067 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2071 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2072 &expand_string_message);
2073 if (rc == ERROR || rc == DEFER) return NULL;
2074 *yield = (rc == OK) == testfor;
2077 #endif /* CYRUS_SASLAUTHD_SOCKET */
2080 /* symbolic operators for numeric and string comparison, and a number of
2081 other operators, all requiring two arguments.
2083 crypteq: encrypts plaintext and compares against an encrypted text,
2084 using crypt(), crypt16(), MD5 or SHA-1
2085 inlist/inlisti: checks if first argument is in the list of the second
2086 match: does a regular expression match and sets up the numerical
2087 variables if it succeeds
2088 match_address: matches in an address list
2089 match_domain: matches in a domain list
2090 match_ip: matches a host list that is restricted to IP addresses
2091 match_local_part: matches in a local part list
2094 case ECOND_MATCH_ADDRESS:
2095 case ECOND_MATCH_DOMAIN:
2096 case ECOND_MATCH_IP:
2097 case ECOND_MATCH_LOCAL_PART:
2098 #ifndef EXPAND_LISTMATCH_RHS
2099 sub2_honour_dollar = FALSE;
2108 case ECOND_NUM_L: /* Numerical comparisons */
2115 case ECOND_STR_LT: /* String comparisons */
2126 for (i = 0; i < 2; i++)
2128 /* Sometimes, we don't expand substrings; too many insecure configurations
2129 created using match_address{}{} and friends, where the second param
2130 includes information from untrustworthy sources. */
2131 BOOL honour_dollar = TRUE;
2132 if ((i > 0) && !sub2_honour_dollar)
2133 honour_dollar = FALSE;
2135 while (isspace(*s)) s++;
2138 if (i == 0) goto COND_FAILED_CURLY_START;
2139 expand_string_message = string_sprintf("missing 2nd string in {} "
2140 "after \"%s\"", name);
2143 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2145 if (sub[i] == NULL) return NULL;
2146 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2148 /* Convert to numerical if required; we know that the names of all the
2149 conditions that compare numbers do not start with a letter. This just saves
2150 checking for them individually. */
2152 if (!isalpha(name[0]) && yield != NULL)
2158 debug_printf("empty string cast to zero for numerical comparison\n");
2162 num[i] = expand_string_integer(sub[i], FALSE);
2163 if (expand_string_message != NULL) return NULL;
2168 /* Result not required */
2170 if (yield == NULL) return s;
2172 /* Do an appropriate comparison */
2178 *yield = (num[0] == num[1]) == testfor;
2182 *yield = (num[0] > num[1]) == testfor;
2186 *yield = (num[0] >= num[1]) == testfor;
2190 *yield = (num[0] < num[1]) == testfor;
2194 *yield = (num[0] <= num[1]) == testfor;
2198 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2202 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2206 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2210 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2214 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2218 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2222 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2226 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2230 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2234 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2237 case ECOND_MATCH: /* Regular expression match */
2238 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2242 expand_string_message = string_sprintf("regular expression error in "
2243 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2246 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2249 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2250 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2251 goto MATCHED_SOMETHING;
2253 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2254 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2255 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2256 goto MATCHED_SOMETHING;
2258 case ECOND_MATCH_IP: /* Match IP address in a host list */
2259 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2261 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2267 unsigned int *nullcache = NULL;
2268 check_host_block cb;
2270 cb.host_name = US"";
2271 cb.host_address = sub[0];
2273 /* If the host address starts off ::ffff: it is an IPv6 address in
2274 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2277 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2278 cb.host_address + 7 : cb.host_address;
2280 rc = match_check_list(
2281 &sub[1], /* the list */
2282 0, /* separator character */
2283 &hostlist_anchor, /* anchor pointer */
2284 &nullcache, /* cache pointer */
2285 check_host, /* function for testing */
2286 &cb, /* argument for function */
2287 MCL_HOST, /* type of check */
2288 sub[0], /* text for debugging */
2289 NULL); /* where to pass back data */
2291 goto MATCHED_SOMETHING;
2293 case ECOND_MATCH_LOCAL_PART:
2294 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2295 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2310 expand_string_message = string_sprintf("unable to complete match "
2311 "against \"%s\": %s", sub[1], search_error_message);
2317 /* Various "encrypted" comparisons. If the second string starts with
2318 "{" then an encryption type is given. Default to crypt() or crypt16()
2319 (build-time choice). */
2322 #ifndef SUPPORT_CRYPTEQ
2323 goto COND_FAILED_NOT_COMPILED;
2325 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2327 int sublen = Ustrlen(sub[1]+5);
2332 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2334 /* If the length that we are comparing against is 24, the MD5 digest
2335 is expressed as a base64 string. This is the way LDAP does it. However,
2336 some other software uses a straightforward hex representation. We assume
2337 this if the length is 32. Other lengths fail. */
2341 uschar *coded = auth_b64encode((uschar *)digest, 16);
2342 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2343 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2344 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2346 else if (sublen == 32)
2350 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2352 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2353 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2354 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2358 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2359 "fail\n crypted=%s\n", sub[1]+5);
2364 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2366 int sublen = Ustrlen(sub[1]+6);
2371 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2373 /* If the length that we are comparing against is 28, assume the SHA1
2374 digest is expressed as a base64 string. If the length is 40, assume a
2375 straightforward hex representation. Other lengths fail. */
2379 uschar *coded = auth_b64encode((uschar *)digest, 20);
2380 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2381 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2382 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2384 else if (sublen == 40)
2388 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2390 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2391 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2392 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2396 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2397 "fail\n crypted=%s\n", sub[1]+6);
2402 else /* {crypt} or {crypt16} and non-{ at start */
2403 /* }-for-text-editors */
2408 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2413 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2418 else if (sub[1][0] == '{')
2420 expand_string_message = string_sprintf("unknown encryption mechanism "
2421 "in \"%s\"", sub[1]);
2427 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2428 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2429 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2433 #define XSTR(s) STR(s)
2434 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2435 " subject=%s\n crypted=%s\n",
2436 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2441 /* If the encrypted string contains fewer than two characters (for the
2442 salt), force failure. Otherwise we get false positives: with an empty
2443 string the yield of crypt() is an empty string! */
2445 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2446 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2449 #endif /* SUPPORT_CRYPTEQ */
2456 uschar *save_iterate_item = iterate_item;
2457 int (*compare)(const uschar *, const uschar *);
2459 if (cond_type == ECOND_INLISTI)
2462 compare = (int (*)(const uschar *, const uschar *)) strcmp;
2464 while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2465 if (compare(sub[0], iterate_item) == 0)
2470 iterate_item = save_iterate_item;
2474 } /* Switch for comparison conditions */
2476 return s; /* End of comparison conditions */
2479 /* and/or: computes logical and/or of several conditions */
2483 subcondptr = (yield == NULL)? NULL : &tempcond;
2484 combined_cond = (cond_type == ECOND_AND);
2486 while (isspace(*s)) s++;
2487 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2491 while (isspace(*s)) s++;
2492 if (*s == '}') break;
2495 expand_string_message = string_sprintf("each subcondition "
2496 "inside an \"%s{...}\" condition must be in its own {}", name);
2500 s = eval_condition(s+1, subcondptr);
2503 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2504 expand_string_message, name);
2507 while (isspace(*s)) s++;
2511 expand_string_message = string_sprintf("missing } at end of condition "
2512 "inside \"%s\" group", name);
2518 if (cond_type == ECOND_AND)
2520 combined_cond &= tempcond;
2521 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2522 } /* evaluate any more */
2525 combined_cond |= tempcond;
2526 if (combined_cond) subcondptr = NULL; /* once true, don't */
2527 } /* evaluate any more */
2531 if (yield != NULL) *yield = (combined_cond == testfor);
2535 /* forall/forany: iterates a condition with different values */
2541 uschar *save_iterate_item = iterate_item;
2543 while (isspace(*s)) s++;
2544 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2545 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2546 if (sub[0] == NULL) return NULL;
2547 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2549 while (isspace(*s)) s++;
2550 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2554 /* Call eval_condition once, with result discarded (as if scanning a
2555 "false" part). This allows us to find the end of the condition, because if
2556 the list it empty, we won't actually evaluate the condition for real. */
2558 s = eval_condition(sub[1], NULL);
2561 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2562 expand_string_message, name);
2565 while (isspace(*s)) s++;
2569 expand_string_message = string_sprintf("missing } at end of condition "
2570 "inside \"%s\"", name);
2574 if (yield != NULL) *yield = !testfor;
2575 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2577 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2578 if (eval_condition(sub[1], &tempcond) == NULL)
2580 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2581 expand_string_message, name);
2582 iterate_item = save_iterate_item;
2585 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2586 tempcond? "true":"false");
2588 if (yield != NULL) *yield = (tempcond == testfor);
2589 if (tempcond == (cond_type == ECOND_FORANY)) break;
2592 iterate_item = save_iterate_item;
2597 /* The bool{} expansion condition maps a string to boolean.
2598 The values supported should match those supported by the ACL condition
2599 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2600 of true/false. Note that Router "condition" rules have a different
2601 interpretation, where general data can be used and only a few values
2603 Note that readconf.c boolean matching, for boolean configuration options,
2604 only matches true/yes/false/no.
2605 The bool_lax{} condition matches the Router logic, which is much more
2608 case ECOND_BOOL_LAX:
2614 BOOL boolvalue = FALSE;
2615 while (isspace(*s)) s++;
2616 if (*s != '{') goto COND_FAILED_CURLY_START;
2617 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2618 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2620 case 1: expand_string_message = string_sprintf(
2621 "too few arguments or bracketing error for %s",
2625 case 3: return NULL;
2628 while (isspace(*t)) t++;
2632 /* trailing whitespace: seems like a good idea to ignore it too */
2634 while (isspace(*t2)) t2--;
2635 if (t2 != (t + len))
2642 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2643 /* logic for the lax case from expand_check_condition(), which also does
2644 expands, and the logic is both short and stable enough that there should
2645 be no maintenance burden from replicating it. */
2648 else if (Ustrspn(t, "0123456789") == len)
2650 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2651 /* expand_check_condition only does a literal string "0" check */
2652 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2655 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2657 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2659 else if (cond_type == ECOND_BOOL_LAX)
2663 expand_string_message = string_sprintf("unrecognised boolean "
2667 if (yield != NULL) *yield = (boolvalue == testfor);
2671 /* Unknown condition */
2674 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2676 } /* End switch on condition type */
2678 /* Missing braces at start and end of data */
2680 COND_FAILED_CURLY_START:
2681 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2684 COND_FAILED_CURLY_END:
2685 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2689 /* A condition requires code that is not compiled */
2691 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2692 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2693 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2694 COND_FAILED_NOT_COMPILED:
2695 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2704 /*************************************************
2705 * Save numerical variables *
2706 *************************************************/
2708 /* This function is called from items such as "if" that want to preserve and
2709 restore the numbered variables.
2712 save_expand_string points to an array of pointers to set
2713 save_expand_nlength points to an array of ints for the lengths
2715 Returns: the value of expand max to save
2719 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2722 for (i = 0; i <= expand_nmax; i++)
2724 save_expand_nstring[i] = expand_nstring[i];
2725 save_expand_nlength[i] = expand_nlength[i];
2732 /*************************************************
2733 * Restore numerical variables *
2734 *************************************************/
2736 /* This function restored saved values of numerical strings.
2739 save_expand_nmax the number of strings to restore
2740 save_expand_string points to an array of pointers
2741 save_expand_nlength points to an array of ints
2747 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2748 int *save_expand_nlength)
2751 expand_nmax = save_expand_nmax;
2752 for (i = 0; i <= expand_nmax; i++)
2754 expand_nstring[i] = save_expand_nstring[i];
2755 expand_nlength[i] = save_expand_nlength[i];
2763 /*************************************************
2764 * Handle yes/no substrings *
2765 *************************************************/
2767 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2768 alternative substrings that depend on whether or not the condition was true,
2769 or the lookup or extraction succeeded. The substrings always have to be
2770 expanded, to check their syntax, but "skipping" is set when the result is not
2771 needed - this avoids unnecessary nested lookups.
2774 skipping TRUE if we were skipping when this item was reached
2775 yes TRUE if the first string is to be used, else use the second
2776 save_lookup a value to put back into lookup_value before the 2nd expansion
2777 sptr points to the input string pointer
2778 yieldptr points to the output string pointer
2779 sizeptr points to the output string size
2780 ptrptr points to the output string pointer
2781 type "lookup" or "if" or "extract" or "run", for error message
2783 Returns: 0 OK; lookup_value has been reset to save_lookup
2785 2 expansion failed because of bracketing error
2789 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2790 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2793 uschar *s = *sptr; /* Local value */
2794 uschar *sub1, *sub2;
2796 /* If there are no following strings, we substitute the contents of $value for
2797 lookups and for extractions in the success case. For the ${if item, the string
2798 "true" is substituted. In the fail case, nothing is substituted for all three
2801 while (isspace(*s)) s++;
2806 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2810 if (yes && lookup_value != NULL)
2811 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2812 Ustrlen(lookup_value));
2813 lookup_value = save_lookup;
2819 /* The first following string must be braced. */
2821 if (*s++ != '{') goto FAILED_CURLY;
2823 /* Expand the first substring. Forced failures are noticed only if we actually
2824 want this string. Set skipping in the call in the fail case (this will always
2825 be the case if we were already skipping). */
2827 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
2828 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2829 expand_string_forcedfail = FALSE;
2830 if (*s++ != '}') goto FAILED_CURLY;
2832 /* If we want the first string, add it to the output */
2835 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2837 /* If this is called from a lookup or an extract, we want to restore $value to
2838 what it was at the start of the item, so that it has this value during the
2839 second string expansion. For the call from "if" or "run" to this function,
2840 save_lookup is set to lookup_value, so that this statement does nothing. */
2842 lookup_value = save_lookup;
2844 /* There now follows either another substring, or "fail", or nothing. This
2845 time, forced failures are noticed only if we want the second string. We must
2846 set skipping in the nested call if we don't want this string, or if we were
2847 already skipping. */
2849 while (isspace(*s)) s++;
2852 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
2853 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2854 expand_string_forcedfail = FALSE;
2855 if (*s++ != '}') goto FAILED_CURLY;
2857 /* If we want the second string, add it to the output */
2860 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2863 /* If there is no second string, but the word "fail" is present when the use of
2864 the second string is wanted, set a flag indicating it was a forced failure
2865 rather than a syntactic error. Swallow the terminating } in case this is nested
2866 inside another lookup or if or extract. */
2871 s = read_name(name, sizeof(name), s, US"_");
2872 if (Ustrcmp(name, "fail") == 0)
2874 if (!yes && !skipping)
2876 while (isspace(*s)) s++;
2877 if (*s++ != '}') goto FAILED_CURLY;
2878 expand_string_message =
2879 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2880 expand_string_forcedfail = TRUE;
2886 expand_string_message =
2887 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2892 /* All we have to do now is to check on the final closing brace. */
2894 while (isspace(*s)) s++;
2895 if (*s++ == '}') goto RETURN;
2897 /* Get here if there is a bracketing failure */
2902 /* Get here for other failures */
2907 /* Update the input pointer value before returning */
2917 /*************************************************
2918 * Handle MD5 or SHA-1 computation for HMAC *
2919 *************************************************/
2921 /* These are some wrapping functions that enable the HMAC code to be a bit
2922 cleaner. A good compiler will spot the tail recursion.
2925 type HMAC_MD5 or HMAC_SHA1
2926 remaining are as for the cryptographic hash functions
2932 chash_start(int type, void *base)
2934 if (type == HMAC_MD5)
2935 md5_start((md5 *)base);
2937 sha1_start((sha1 *)base);
2941 chash_mid(int type, void *base, uschar *string)
2943 if (type == HMAC_MD5)
2944 md5_mid((md5 *)base, string);
2946 sha1_mid((sha1 *)base, string);
2950 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2952 if (type == HMAC_MD5)
2953 md5_end((md5 *)base, string, length, digest);
2955 sha1_end((sha1 *)base, string, length, digest);
2962 /********************************************************
2963 * prvs: Get last three digits of days since Jan 1, 1970 *
2964 ********************************************************/
2966 /* This is needed to implement the "prvs" BATV reverse
2969 Argument: integer "days" offset to add or substract to
2970 or from the current number of days.
2972 Returns: pointer to string containing the last three
2973 digits of the number of days since Jan 1, 1970,
2974 modified by the offset argument, NULL if there
2975 was an error in the conversion.
2980 prvs_daystamp(int day_offset)
2982 uschar *days = store_get(32); /* Need at least 24 for cases */
2983 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2984 (time(NULL) + day_offset*86400)/86400);
2985 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2990 /********************************************************
2991 * prvs: perform HMAC-SHA1 computation of prvs bits *
2992 ********************************************************/
2994 /* This is needed to implement the "prvs" BATV reverse
2998 address RFC2821 Address to use
2999 key The key to use (must be less than 64 characters
3001 key_num Single-digit key number to use. Defaults to
3004 Returns: pointer to string containing the first three
3005 bytes of the final hash in hex format, NULL if
3006 there was an error in the process.
3010 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3012 uschar *hash_source, *p;
3013 int size = 0,offset = 0,i;
3015 void *use_base = &sha1_base;
3016 uschar innerhash[20];
3017 uschar finalhash[20];
3018 uschar innerkey[64];
3019 uschar outerkey[64];
3020 uschar *finalhash_hex = store_get(40);
3022 if (key_num == NULL)
3025 if (Ustrlen(key) > 64)
3028 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3029 string_cat(hash_source,&size,&offset,daystamp,3);
3030 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3031 hash_source[offset] = '\0';
3033 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3035 memset(innerkey, 0x36, 64);
3036 memset(outerkey, 0x5c, 64);
3038 for (i = 0; i < Ustrlen(key); i++)
3040 innerkey[i] ^= key[i];
3041 outerkey[i] ^= key[i];
3044 chash_start(HMAC_SHA1, use_base);
3045 chash_mid(HMAC_SHA1, use_base, innerkey);
3046 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3048 chash_start(HMAC_SHA1, use_base);
3049 chash_mid(HMAC_SHA1, use_base, outerkey);
3050 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3053 for (i = 0; i < 3; i++)
3055 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3056 *p++ = hex_digits[finalhash[i] & 0x0f];
3060 return finalhash_hex;
3066 /*************************************************
3067 * Join a file onto the output string *
3068 *************************************************/
3070 /* This is used for readfile and after a run expansion. It joins the contents
3071 of a file onto the output string, globally replacing newlines with a given
3072 string (optionally). The file is closed at the end.
3076 yield pointer to the expandable string
3077 sizep pointer to the current size
3078 ptrp pointer to the current position
3079 eol newline replacement string, or NULL
3081 Returns: new value of string pointer
3085 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3088 uschar buffer[1024];
3090 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3092 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3094 int len = Ustrlen(buffer);
3095 if (eol != NULL && buffer[len-1] == '\n') len--;
3096 yield = string_cat(yield, sizep, ptrp, buffer, len);
3097 if (buffer[len] != 0)
3098 yield = string_cat(yield, sizep, ptrp, eol, eollen);
3101 if (yield != NULL) yield[*ptrp] = 0;
3109 /*************************************************
3110 * Evaluate numeric expression *
3111 *************************************************/
3113 /* This is a set of mutually recursive functions that evaluate an arithmetic
3114 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3115 these functions that is called from elsewhere is eval_expr, whose interface is:
3118 sptr pointer to the pointer to the string - gets updated
3119 decimal TRUE if numbers are to be assumed decimal
3120 error pointer to where to put an error message - must be NULL on input
3121 endket TRUE if ')' must terminate - FALSE for external call
3123 Returns: on success: the value of the expression, with *error still NULL
3124 on failure: an undefined value, with *error = a message
3127 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3130 static int_eximarith_t
3131 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3134 int_eximarith_t x = eval_op_or(&s, decimal, error);
3140 *error = US"expecting closing parenthesis";
3142 while (isspace(*(++s)));
3144 else if (*s != 0) *error = US"expecting operator";
3151 static int_eximarith_t
3152 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3157 while (isspace(*s)) s++;
3162 (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3164 switch (tolower(*s))
3167 case 'k': n *= 1024; s++; break;
3168 case 'm': n *= 1024*1024; s++; break;
3169 case 'g': n *= 1024*1024*1024; s++; break;
3171 while (isspace (*s)) s++;
3176 n = eval_expr(&s, decimal, error, 1);
3180 *error = US"expecting number or opening parenthesis";
3188 static int_eximarith_t
3189 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3193 while (isspace(*s)) s++;
3194 if (*s == '+' || *s == '-' || *s == '~')
3197 x = eval_op_unary(&s, decimal, error);
3198 if (op == '-') x = -x;
3199 else if (op == '~') x = ~x;
3203 x = eval_number(&s, decimal, error);
3210 static int_eximarith_t
3211 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3214 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3217 while (*s == '*' || *s == '/' || *s == '%')
3220 int_eximarith_t y = eval_op_unary(&s, decimal, error);
3221 if (*error != NULL) break;
3222 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3223 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3224 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3225 * -N*M is INT_MIN will yielf INT_MIN.
3226 * Since we don't support floating point, this is somewhat simpler.
3227 * Ideally, we'd return an error, but since we overflow for all other
3228 * arithmetic, consistency suggests otherwise, but what's the correct value
3229 * to use? There is none.
3230 * The C standard guarantees overflow for unsigned arithmetic but signed
3231 * overflow invokes undefined behaviour; in practice, this is overflow
3232 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3233 * that long/longlong larger than int are available, or we could just work
3234 * with larger types. We should consider whether to guarantee 32bit eval
3235 * and 64-bit working variables, with errors returned. For now ...
3236 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3237 * can just let the other invalid results occur otherwise, as they have
3238 * until now. For this one case, we can coerce.
3240 if (y == -1 && x == LLONG_MIN && op != '*')
3243 debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3244 LLONG_MIN, op, LLONG_MAX);
3254 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3270 static int_eximarith_t
3271 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3274 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3277 while (*s == '+' || *s == '-')
3280 int_eximarith_t y = eval_op_mult(&s, decimal, error);
3281 if (*error != NULL) break;
3282 if (op == '+') x += y; else x -= y;
3290 static int_eximarith_t
3291 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3294 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3297 while ((*s == '<' || *s == '>') && s[1] == s[0])
3302 y = eval_op_sum(&s, decimal, error);
3303 if (*error != NULL) break;
3304 if (op == '<') x <<= y; else x >>= y;
3312 static int_eximarith_t
3313 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3316 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3323 y = eval_op_shift(&s, decimal, error);
3324 if (*error != NULL) break;
3333 static int_eximarith_t
3334 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3337 int_eximarith_t x = eval_op_and(&s, decimal, error);
3344 y = eval_op_and(&s, decimal, error);
3345 if (*error != NULL) break;
3354 static int_eximarith_t
3355 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3358 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3365 y = eval_op_xor(&s, decimal, error);
3366 if (*error != NULL) break;
3376 /*************************************************
3378 *************************************************/
3380 /* Returns either an unchanged string, or the expanded string in stacking pool
3381 store. Interpreted sequences are:
3383 \... normal escaping rules
3384 $name substitutes the variable
3386 ${op:string} operates on the expanded string value
3387 ${item{arg1}{arg2}...} expands the args and then does the business
3388 some literal args are not enclosed in {}
3390 There are now far too many operators and item types to make it worth listing
3391 them here in detail any more.
3393 We use an internal routine recursively to handle embedded substrings. The
3394 external function follows. The yield is NULL if the expansion failed, and there
3395 are two cases: if something collapsed syntactically, or if "fail" was given
3396 as the action on a lookup failure. These can be distinguised by looking at the
3397 variable expand_string_forcedfail, which is TRUE in the latter case.
3399 The skipping flag is set true when expanding a substring that isn't actually
3400 going to be used (after "if" or "lookup") and it prevents lookups from
3401 happening lower down.
3403 Store usage: At start, a store block of the length of the input plus 64
3404 is obtained. This is expanded as necessary by string_cat(), which might have to
3405 get a new block, or might be able to expand the original. At the end of the
3406 function we can release any store above that portion of the yield block that
3407 was actually used. In many cases this will be optimal.
3409 However: if the first item in the expansion is a variable name or header name,
3410 we reset the store before processing it; if the result is in fresh store, we
3411 use that without copying. This is helpful for expanding strings like
3412 $message_headers which can get very long.
3414 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3415 since resetting the store at the end of the expansion will free store that was
3416 allocated by the plugin code as well as the slop after the expanded string. So
3417 we skip any resets if ${dlfunc has been used. This is an unfortunate
3418 consequence of string expansion becoming too powerful.
3421 string the string to be expanded
3422 ket_ends true if expansion is to stop at }
3423 left if not NULL, a pointer to the first character after the
3424 expansion is placed here (typically used with ket_ends)
3425 skipping TRUE for recursive calls when the value isn't actually going
3426 to be used (to allow for optimisation)
3427 honour_dollar TRUE if $ is to be expanded,
3428 FALSE if it's just another character
3430 Returns: NULL if expansion fails:
3431 expand_string_forcedfail is set TRUE if failure was forced
3432 expand_string_message contains a textual error message
3433 a pointer to the expanded string on success
3437 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3438 BOOL skipping, BOOL honour_dollar)
3441 int size = Ustrlen(string)+ 64;
3443 uschar *yield = store_get(size);
3445 uschar *save_expand_nstring[EXPAND_MAXN+1];
3446 int save_expand_nlength[EXPAND_MAXN+1];
3447 BOOL resetok = TRUE;
3449 expand_string_forcedfail = FALSE;
3450 expand_string_message = US"";
3457 /* \ escapes the next character, which must exist, or else
3458 the expansion fails. There's a special escape, \N, which causes
3459 copying of the subject verbatim up to the next \N. Otherwise,
3460 the escapes are the standard set. */
3466 expand_string_message = US"\\ at end of string";
3473 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3474 yield = string_cat(yield, &size, &ptr, t, s - t);
3475 if (*s != 0) s += 2;
3481 ch[0] = string_interpret_escape(&s);
3483 yield = string_cat(yield, &size, &ptr, ch, 1);
3489 /* Anything other than $ is just copied verbatim, unless we are
3490 looking for a terminating } character. */
3492 if (ket_ends && *s == '}') break;
3494 if (*s != '$' || !honour_dollar)
3496 yield = string_cat(yield, &size, &ptr, s++, 1);
3500 /* No { after the $ - must be a plain name or a number for string
3501 match variable. There has to be a fudge for variables that are the
3502 names of header fields preceded by "$header_" because header field
3503 names can contain any printing characters except space and colon.
3504 For those that don't like typing this much, "$h_" is a synonym for
3505 "$header_". A non-existent header yields a NULL value; nothing is
3508 if (isalpha((*(++s))))
3513 s = read_name(name, sizeof(name), s, US"_");
3515 /* If this is the first thing to be expanded, release the pre-allocated
3518 if (ptr == 0 && yield != NULL)
3520 if (resetok) store_reset(yield);
3527 if (Ustrncmp(name, "h_", 2) == 0 ||
3528 Ustrncmp(name, "rh_", 3) == 0 ||
3529 Ustrncmp(name, "bh_", 3) == 0 ||
3530 Ustrncmp(name, "header_", 7) == 0 ||
3531 Ustrncmp(name, "rheader_", 8) == 0 ||
3532 Ustrncmp(name, "bheader_", 8) == 0)
3534 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3535 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3536 s = read_header_name(name, sizeof(name), s);
3537 value = find_header(name, FALSE, &newsize, want_raw, charset);
3539 /* If we didn't find the header, and the header contains a closing brace
3540 character, this may be a user error where the terminating colon
3541 has been omitted. Set a flag to adjust the error message in this case.
3542 But there is no error here - nothing gets inserted. */
3546 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3555 value = find_variable(name, FALSE, skipping, &newsize);
3558 expand_string_message =
3559 string_sprintf("unknown variable name \"%s\"", name);
3560 check_variable_error_message(name);
3565 /* If the data is known to be in a new buffer, newsize will be set to the
3566 size of that buffer. If this is the first thing in an expansion string,
3567 yield will be NULL; just point it at the new store instead of copying. Many
3568 expansion strings contain just one reference, so this is a useful
3569 optimization, especially for humungous headers. */
3571 len = Ustrlen(value);
3572 if (yield == NULL && newsize != 0)
3578 else yield = string_cat(yield, &size, &ptr, value, len);
3586 s = read_number(&n, s);
3587 if (n >= 0 && n <= expand_nmax)
3588 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3593 /* Otherwise, if there's no '{' after $ it's an error. */
3597 expand_string_message = US"$ not followed by letter, digit, or {";
3601 /* After { there can be various things, but they all start with
3602 an initial word, except for a number for a string match variable. */
3604 if (isdigit((*(++s))))
3607 s = read_number(&n, s);
3610 expand_string_message = US"} expected after number";
3613 if (n >= 0 && n <= expand_nmax)
3614 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3621 expand_string_message = US"letter or digit expected after ${";
3625 /* Allow "-" in names to cater for substrings with negative
3626 arguments. Since we are checking for known names after { this is
3629 s = read_name(name, sizeof(name), s, US"_-");
3630 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3634 /* Handle conditionals - preserve the values of the numerical expansion
3635 variables in case they get changed by a regular expression match in the
3636 condition. If not, they retain their external settings. At the end
3637 of this "if" section, they get restored to their previous values. */
3643 int save_expand_nmax =
3644 save_expand_strings(save_expand_nstring, save_expand_nlength);
3646 while (isspace(*s)) s++;
3647 next_s = eval_condition(s, skipping? NULL : &cond);
3648 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3651 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3652 cond? "true" : "false");
3656 /* The handling of "yes" and "no" result strings is now in a separate
3657 function that is also used by ${lookup} and ${extract} and ${run}. */
3659 switch(process_yesno(
3660 skipping, /* were previously skipping */
3661 cond, /* success/failure indicator */
3662 lookup_value, /* value to reset for string2 */
3663 &s, /* input pointer */
3664 &yield, /* output pointer */
3665 &size, /* output size */
3666 &ptr, /* output current point */
3667 US"if")) /* condition type */
3669 case 1: goto EXPAND_FAILED; /* when all is well, the */
3670 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3673 /* Restore external setting of expansion variables for continuation
3676 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3677 save_expand_nlength);
3681 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3682 expanding an internal string that isn't actually going to be used. All we
3683 need to do is check the syntax, so don't do a lookup at all. Preserve the
3684 values of the numerical expansion variables in case they get changed by a
3685 partial lookup. If not, they retain their external settings. At the end
3686 of this "lookup" section, they get restored to their previous values. */
3690 int stype, partial, affixlen, starflags;
3691 int expand_setup = 0;
3693 uschar *key, *filename, *affix;
3694 uschar *save_lookup_value = lookup_value;
3695 int save_expand_nmax =
3696 save_expand_strings(save_expand_nstring, save_expand_nlength);
3698 if ((expand_forbid & RDO_LOOKUP) != 0)
3700 expand_string_message = US"lookup expansions are not permitted";
3704 /* Get the key we are to look up for single-key+file style lookups.
3705 Otherwise set the key NULL pro-tem. */
3707 while (isspace(*s)) s++;
3710 key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3711 if (key == NULL) goto EXPAND_FAILED;
3712 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3713 while (isspace(*s)) s++;
3717 /* Find out the type of database */
3721 expand_string_message = US"missing lookup type";
3725 /* The type is a string that may contain special characters of various
3726 kinds. Allow everything except space or { to appear; the actual content
3727 is checked by search_findtype_partial. */
3729 while (*s != 0 && *s != '{' && !isspace(*s))
3731 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3735 while (isspace(*s)) s++;
3737 /* Now check for the individual search type and any partial or default
3738 options. Only those types that are actually in the binary are valid. */
3740 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3744 expand_string_message = search_error_message;
3748 /* Check that a key was provided for those lookup types that need it,
3749 and was not supplied for those that use the query style. */
3751 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3755 expand_string_message = string_sprintf("missing {key} for single-"
3756 "key \"%s\" lookup", name);
3764 expand_string_message = string_sprintf("a single key was given for "
3765 "lookup type \"%s\", which is not a single-key lookup type", name);
3770 /* Get the next string in brackets and expand it. It is the file name for
3771 single-key+file lookups, and the whole query otherwise. In the case of
3772 queries that also require a file name (e.g. sqlite), the file name comes
3775 if (*s != '{') goto EXPAND_FAILED_CURLY;
3776 filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3777 if (filename == NULL) goto EXPAND_FAILED;
3778 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3779 while (isspace(*s)) s++;
3781 /* If this isn't a single-key+file lookup, re-arrange the variables
3782 to be appropriate for the search_ functions. For query-style lookups,
3783 there is just a "key", and no file name. For the special query-style +
3784 file types, the query (i.e. "key") starts with a file name. */
3788 while (isspace(*filename)) filename++;
3791 if (mac_islookup(stype, lookup_querystyle))
3797 if (*filename != '/')
3799 expand_string_message = string_sprintf(
3800 "absolute file name expected for \"%s\" lookup", name);
3803 while (*key != 0 && !isspace(*key)) key++;
3804 if (*key != 0) *key++ = 0;
3808 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3809 the entry was not found. Note that there is no search_close() function.
3810 Files are left open in case of re-use. At suitable places in higher logic,
3811 search_tidyup() is called to tidy all open files. This can save opening
3812 the same file several times. However, files may also get closed when
3813 others are opened, if too many are open at once. The rule is that a
3814 handle should not be used after a second search_open().
3816 Request that a partial search sets up $1 and maybe $2 by passing
3817 expand_setup containing zero. If its value changes, reset expand_nmax,
3818 since new variables will have been set. Note that at the end of this
3819 "lookup" section, the old numeric variables are restored. */
3822 lookup_value = NULL;
3825 void *handle = search_open(filename, stype, 0, NULL, NULL);
3828 expand_string_message = search_error_message;
3831 lookup_value = search_find(handle, filename, key, partial, affix,
3832 affixlen, starflags, &expand_setup);
3833 if (search_find_defer)
3835 expand_string_message =
3836 string_sprintf("lookup of \"%s\" gave DEFER: %s",
3837 string_printing2(key, FALSE), search_error_message);
3840 if (expand_setup > 0) expand_nmax = expand_setup;
3843 /* The handling of "yes" and "no" result strings is now in a separate
3844 function that is also used by ${if} and ${extract}. */
3846 switch(process_yesno(
3847 skipping, /* were previously skipping */
3848 lookup_value != NULL, /* success/failure indicator */
3849 save_lookup_value, /* value to reset for string2 */
3850 &s, /* input pointer */
3851 &yield, /* output pointer */
3852 &size, /* output size */
3853 &ptr, /* output current point */
3854 US"lookup")) /* condition type */
3856 case 1: goto EXPAND_FAILED; /* when all is well, the */
3857 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3860 /* Restore external setting of expansion variables for carrying on
3861 at this level, and continue. */
3863 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3864 save_expand_nlength);
3868 /* If Perl support is configured, handle calling embedded perl subroutines,
3869 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3870 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3871 arguments (defined below). */
3873 #define EXIM_PERL_MAX_ARGS 8
3877 expand_string_message = US"\"${perl\" encountered, but this facility "
3878 "is not included in this binary";
3881 #else /* EXIM_PERL */
3883 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3886 if ((expand_forbid & RDO_PERL) != 0)
3888 expand_string_message = US"Perl calls are not permitted";
3892 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3895 case 1: goto EXPAND_FAILED_CURLY;
3897 case 3: goto EXPAND_FAILED;
3900 /* If skipping, we don't actually do anything */
3902 if (skipping) continue;
3904 /* Start the interpreter if necessary */
3906 if (!opt_perl_started)
3909 if (opt_perl_startup == NULL)
3911 expand_string_message = US"A setting of perl_startup is needed when "
3912 "using the Perl interpreter";
3915 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3916 initerror = init_perl(opt_perl_startup);
3917 if (initerror != NULL)
3919 expand_string_message =
3920 string_sprintf("error in perl_startup code: %s\n", initerror);
3923 opt_perl_started = TRUE;
3926 /* Call the function */
3928 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3929 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3930 sub_arg[0], sub_arg + 1);
3932 /* NULL yield indicates failure; if the message pointer has been set to
3933 NULL, the yield was undef, indicating a forced failure. Otherwise the
3934 message will indicate some kind of Perl error. */
3936 if (new_yield == NULL)
3938 if (expand_string_message == NULL)
3940 expand_string_message =
3941 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3942 "failure", sub_arg[0]);
3943 expand_string_forcedfail = TRUE;
3948 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3949 set during a callback from Perl. */
3951 expand_string_forcedfail = FALSE;
3955 #endif /* EXIM_PERL */
3957 /* Transform email address to "prvs" scheme to use
3958 as BATV-signed return path */
3965 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3967 case 1: goto EXPAND_FAILED_CURLY;
3969 case 3: goto EXPAND_FAILED;
3972 /* If skipping, we don't actually do anything */
3973 if (skipping) continue;
3975 /* sub_arg[0] is the address */
3976 domain = Ustrrchr(sub_arg[0],'@');
3977 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3979 expand_string_message = US"prvs first argument must be a qualified email address";
3983 /* Calculate the hash. The second argument must be a single-digit
3984 key number, or unset. */
3986 if (sub_arg[2] != NULL &&
3987 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3989 expand_string_message = US"prvs second argument must be a single digit";
3993 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3996 expand_string_message = US"prvs hmac-sha1 conversion failed";
4000 /* Now separate the domain from the local part */
4003 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4004 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4005 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4006 string_cat(yield,&size,&ptr,p,6);
4007 string_cat(yield,&size,&ptr,US"=",1);
4008 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4009 string_cat(yield,&size,&ptr,US"@",1);
4010 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4015 /* Check a prvs-encoded address for validity */
4017 case EITEM_PRVSCHECK:
4020 int mysize = 0, myptr = 0;
4024 /* TF: Ugliness: We want to expand parameter 1 first, then set
4025 up expansion variables that are used in the expansion of
4026 parameter 2. So we clone the string for the first
4027 expansion, where we only expand parameter 1.
4029 PH: Actually, that isn't necessary. The read_subs() function is
4030 designed to work this way for the ${if and ${lookup expansions. I've
4034 /* Reset expansion variables */
4035 prvscheck_result = NULL;
4036 prvscheck_address = NULL;
4037 prvscheck_keynum = NULL;
4039 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4041 case 1: goto EXPAND_FAILED_CURLY;
4043 case 3: goto EXPAND_FAILED;
4046 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4049 if (regex_match_and_setup(re,sub_arg[0],0,-1))
4051 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4052 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4053 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4054 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4055 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4057 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4058 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4059 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4060 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4061 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4063 /* Set up expansion variables */
4064 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4065 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4066 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4067 prvscheck_address[myptr] = '\0';
4068 prvscheck_keynum = string_copy(key_num);
4070 /* Now expand the second argument */
4071 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4073 case 1: goto EXPAND_FAILED_CURLY;
4075 case 3: goto EXPAND_FAILED;
4078 /* Now we have the key and can check the address. */
4080 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4085 expand_string_message = US"hmac-sha1 conversion failed";
4089 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4090 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
4092 if (Ustrcmp(p,hash) == 0)
4094 /* Success, valid BATV address. Now check the expiry date. */
4095 uschar *now = prvs_daystamp(0);
4096 unsigned int inow = 0,iexpire = 1;
4098 (void)sscanf(CS now,"%u",&inow);
4099 (void)sscanf(CS daystamp,"%u",&iexpire);
4101 /* When "iexpire" is < 7, a "flip" has occured.
4102 Adjust "inow" accordingly. */
4103 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4105 if (iexpire >= inow)
4107 prvscheck_result = US"1";
4108 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4112 prvscheck_result = NULL;
4113 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4118 prvscheck_result = NULL;
4119 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4122 /* Now expand the final argument. We leave this till now so that
4123 it can include $prvscheck_result. */
4125 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4127 case 1: goto EXPAND_FAILED_CURLY;
4129 case 3: goto EXPAND_FAILED;
4132 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4133 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4135 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4137 /* Reset the "internal" variables afterwards, because they are in
4138 dynamic store that will be reclaimed if the expansion succeeded. */
4140 prvscheck_address = NULL;
4141 prvscheck_keynum = NULL;
4145 /* Does not look like a prvs encoded address, return the empty string.
4146 We need to make sure all subs are expanded first, so as to skip over
4149 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4151 case 1: goto EXPAND_FAILED_CURLY;
4153 case 3: goto EXPAND_FAILED;
4160 /* Handle "readfile" to insert an entire file */
4162 case EITEM_READFILE:
4167 if ((expand_forbid & RDO_READFILE) != 0)
4169 expand_string_message = US"file insertions are not permitted";
4173 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4175 case 1: goto EXPAND_FAILED_CURLY;
4177 case 3: goto EXPAND_FAILED;
4180 /* If skipping, we don't actually do anything */
4182 if (skipping) continue;
4184 /* Open the file and read it */
4186 f = Ufopen(sub_arg[0], "rb");
4189 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4193 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4198 /* Handle "readsocket" to insert data from a Unix domain socket */
4200 case EITEM_READSOCK:
4206 struct sockaddr_un sockun; /* don't call this "sun" ! */
4210 if ((expand_forbid & RDO_READSOCK) != 0)
4212 expand_string_message = US"socket insertions are not permitted";
4216 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4217 because there may be a string for expansion on failure. */
4219 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4221 case 1: goto EXPAND_FAILED_CURLY;
4222 case 2: /* Won't occur: no end check */
4223 case 3: goto EXPAND_FAILED;
4226 /* Sort out timeout, if given */
4228 if (sub_arg[2] != NULL)
4230 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4233 expand_string_message = string_sprintf("bad time value %s",
4238 else sub_arg[3] = NULL; /* No eol if no timeout */
4240 /* If skipping, we don't actually do anything. Otherwise, arrange to
4241 connect to either an IP or a Unix socket. */
4245 /* Handle an IP (internet) domain */
4247 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4249 BOOL connected = FALSE;
4253 uschar *server_name = sub_arg[0] + 5;
4254 uschar *port_name = Ustrrchr(server_name, ':');
4256 /* Sort out the port */
4258 if (port_name == NULL)
4260 expand_string_message =
4261 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4264 *port_name++ = 0; /* Terminate server name */
4266 if (isdigit(*port_name))
4269 port = Ustrtol(port_name, &end, 0);
4270 if (end != port_name + Ustrlen(port_name))
4272 expand_string_message =
4273 string_sprintf("invalid port number %s", port_name);
4279 struct servent *service_info = getservbyname(CS port_name, "tcp");
4280 if (service_info == NULL)
4282 expand_string_message = string_sprintf("unknown port \"%s\"",
4286 port = ntohs(service_info->s_port);
4289 /* Sort out the server. */
4292 shost.address = NULL;
4296 namelen = Ustrlen(server_name);
4298 /* Anything enclosed in [] must be an IP address. */
4300 if (server_name[0] == '[' &&
4301 server_name[namelen - 1] == ']')
4303 server_name[namelen - 1] = 0;
4305 if (string_is_ip_address(server_name, NULL) == 0)
4307 expand_string_message =
4308 string_sprintf("malformed IP address \"%s\"", server_name);
4311 shost.name = shost.address = server_name;
4314 /* Otherwise check for an unadorned IP address */
4316 else if (string_is_ip_address(server_name, NULL) != 0)
4317 shost.name = shost.address = server_name;
4319 /* Otherwise lookup IP address(es) from the name */
4323 shost.name = server_name;
4324 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4325 FALSE) != HOST_FOUND)
4327 expand_string_message =
4328 string_sprintf("no IP address found for host %s", shost.name);
4333 /* Try to connect to the server - test each IP till one works */
4335 for (h = &shost; h != NULL; h = h->next)
4337 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4338 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4340 expand_string_message = string_sprintf("failed to create socket: "
4341 "%s", strerror(errno));
4345 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4354 expand_string_message = string_sprintf("failed to connect to "
4355 "socket %s: couldn't connect to any host", sub_arg[0],
4361 /* Handle a Unix domain socket */
4366 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4368 expand_string_message = string_sprintf("failed to create socket: %s",
4373 sockun.sun_family = AF_UNIX;
4374 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4377 sigalrm_seen = FALSE;
4379 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4383 expand_string_message = US "socket connect timed out";
4388 expand_string_message = string_sprintf("failed to connect to socket "
4389 "%s: %s", sub_arg[0], strerror(errno));
4394 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4396 /* Write the request string, if not empty */
4398 if (sub_arg[1][0] != 0)
4400 int len = Ustrlen(sub_arg[1]);
4401 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4403 if (write(fd, sub_arg[1], len) != len)
4405 expand_string_message = string_sprintf("request write to socket "
4406 "failed: %s", strerror(errno));
4411 /* Shut down the sending side of the socket. This helps some servers to
4412 recognise that it is their turn to do some work. Just in case some
4413 system doesn't have this function, make it conditional. */
4416 shutdown(fd, SHUT_WR);
4419 /* Now we need to read from the socket, under a timeout. The function
4420 that reads a file can be used. */
4422 f = fdopen(fd, "rb");
4423 sigalrm_seen = FALSE;
4425 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4429 /* After a timeout, we restore the pointer in the result, that is,
4430 make sure we add nothing from the socket. */
4435 expand_string_message = US "socket read timed out";
4440 /* The whole thing has worked (or we were skipping). If there is a
4441 failure string following, we need to skip it. */
4445 if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4447 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4448 while (isspace(*s)) s++;
4450 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4453 /* Come here on failure to create socket, connect socket, write to the
4454 socket, or timeout on reading. If another substring follows, expand and
4455 use it. Otherwise, those conditions give expand errors. */
4458 if (*s != '{') goto EXPAND_FAILED;
4459 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4460 arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4461 if (arg == NULL) goto EXPAND_FAILED;
4462 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4463 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4464 while (isspace(*s)) s++;
4465 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4469 /* Handle "run" to execute a program. */
4481 if ((expand_forbid & RDO_RUN) != 0)
4483 expand_string_message = US"running a command is not permitted";
4487 while (isspace(*s)) s++;
4488 if (*s != '{') goto EXPAND_FAILED_CURLY;
4489 arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4490 if (arg == NULL) goto EXPAND_FAILED;
4491 while (isspace(*s)) s++;
4492 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4494 if (skipping) /* Just pretend it worked when we're skipping */
4500 if (!transport_set_up_command(&argv, /* anchor for arg list */
4501 arg, /* raw command */
4502 FALSE, /* don't expand the arguments */
4503 0, /* not relevant when... */
4504 NULL, /* no transporting address */
4505 US"${run} expansion", /* for error messages */
4506 &expand_string_message)) /* where to put error message */
4511 /* Create the child process, making it a group leader. */
4513 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4517 expand_string_message =
4518 string_sprintf("couldn't create child process: %s", strerror(errno));
4522 /* Nothing is written to the standard input. */
4526 /* Read the pipe to get the command's output into $value (which is kept
4527 in lookup_value). Read during execution, so that if the output exceeds
4528 the OS pipe buffer limit, we don't block forever. */
4530 f = fdopen(fd_out, "rb");
4531 sigalrm_seen = FALSE;
4533 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4537 /* Wait for the process to finish, applying the timeout, and inspect its
4538 return code for serious disasters. Simple non-zero returns are passed on.
4541 if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4543 if (sigalrm_seen == TRUE || runrc == -256)
4545 expand_string_message = string_sprintf("command timed out");
4546 killpg(pid, SIGKILL); /* Kill the whole process group */
4549 else if (runrc == -257)
4550 expand_string_message = string_sprintf("wait() failed: %s",
4554 expand_string_message = string_sprintf("command killed by signal %d",
4561 /* Process the yes/no strings; $value may be useful in both cases */
4563 switch(process_yesno(
4564 skipping, /* were previously skipping */
4565 runrc == 0, /* success/failure indicator */
4566 lookup_value, /* value to reset for string2 */
4567 &s, /* input pointer */
4568 &yield, /* output pointer */
4569 &size, /* output size */
4570 &ptr, /* output current point */
4571 US"run")) /* condition type */
4573 case 1: goto EXPAND_FAILED; /* when all is well, the */
4574 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4580 /* Handle character translation for "tr" */
4588 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4590 case 1: goto EXPAND_FAILED_CURLY;
4592 case 3: goto EXPAND_FAILED;
4595 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4596 o2m = Ustrlen(sub[2]) - 1;
4598 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4600 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4604 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4611 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4612 expanded arguments. */
4622 int val[2] = { 0, -1 };
4625 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4626 Ensure that sub[2] is set in the ${length case. */
4629 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4632 case 1: goto EXPAND_FAILED_CURLY;
4634 case 3: goto EXPAND_FAILED;
4637 /* Juggle the arguments if there are only two of them: always move the
4638 string to the last position and make ${length{n}{str}} equivalent to
4639 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4645 if (item_type == EITEM_LENGTH)
4652 for (i = 0; i < 2; i++)
4654 if (sub[i] == NULL) continue;
4655 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4656 if (*ret != 0 || (i != 0 && val[i] < 0))
4658 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4659 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4665 (item_type == EITEM_HASH)?
4666 compute_hash(sub[2], val[0], val[1], &len) :
4667 (item_type == EITEM_NHASH)?
4668 compute_nhash(sub[2], val[0], val[1], &len) :
4669 extract_substr(sub[2], val[0], val[1], &len);
4671 if (ret == NULL) goto EXPAND_FAILED;
4672 yield = string_cat(yield, &size, &ptr, ret, len);
4676 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4677 This code originally contributed by Steve Haslam. It currently supports
4678 the use of MD5 and SHA-1 hashes.
4680 We need some workspace that is large enough to handle all the supported
4681 hash types. Use macros to set the sizes rather than be too elaborate. */
4683 #define MAX_HASHLEN 20
4684 #define MAX_HASHBLOCKLEN 64
4693 int hashlen; /* Number of octets for the hash algorithm's output */
4694 int hashblocklen; /* Number of octets the hash algorithm processes */
4696 unsigned int keylen;
4698 uschar keyhash[MAX_HASHLEN];
4699 uschar innerhash[MAX_HASHLEN];
4700 uschar finalhash[MAX_HASHLEN];
4701 uschar finalhash_hex[2*MAX_HASHLEN];
4702 uschar innerkey[MAX_HASHBLOCKLEN];
4703 uschar outerkey[MAX_HASHBLOCKLEN];
4705 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4707 case 1: goto EXPAND_FAILED_CURLY;
4709 case 3: goto EXPAND_FAILED;
4712 if (Ustrcmp(sub[0], "md5") == 0)
4715 use_base = &md5_base;
4719 else if (Ustrcmp(sub[0], "sha1") == 0)
4722 use_base = &sha1_base;
4728 expand_string_message =
4729 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4734 keylen = Ustrlen(keyptr);
4736 /* If the key is longer than the hash block length, then hash the key
4739 if (keylen > hashblocklen)
4741 chash_start(type, use_base);
4742 chash_end(type, use_base, keyptr, keylen, keyhash);
4747 /* Now make the inner and outer key values */
4749 memset(innerkey, 0x36, hashblocklen);
4750 memset(outerkey, 0x5c, hashblocklen);
4752 for (i = 0; i < keylen; i++)
4754 innerkey[i] ^= keyptr[i];
4755 outerkey[i] ^= keyptr[i];
4758 /* Now do the hashes */
4760 chash_start(type, use_base);
4761 chash_mid(type, use_base, innerkey);
4762 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4764 chash_start(type, use_base);
4765 chash_mid(type, use_base, outerkey);
4766 chash_end(type, use_base, innerhash, hashlen, finalhash);
4768 /* Encode the final hash as a hex string */
4771 for (i = 0; i < hashlen; i++)
4773 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4774 *p++ = hex_digits[finalhash[i] & 0x0f];
4777 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4778 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4780 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4785 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4786 We have to save the numerical variables and restore them afterwards. */
4791 int moffset, moffsetextra, slen;
4794 const uschar *rerror;
4797 int save_expand_nmax =
4798 save_expand_strings(save_expand_nstring, save_expand_nlength);
4800 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4802 case 1: goto EXPAND_FAILED_CURLY;
4804 case 3: goto EXPAND_FAILED;
4807 /* Compile the regular expression */
4809 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4814 expand_string_message = string_sprintf("regular expression error in "
4815 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4819 /* Now run a loop to do the substitutions as often as necessary. It ends
4820 when there are no more matches. Take care over matches of the null string;
4821 do the same thing as Perl does. */
4824 slen = Ustrlen(sub[0]);
4825 moffset = moffsetextra = 0;
4830 int ovector[3*(EXPAND_MAXN+1)];
4831 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4832 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4836 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4837 is not necessarily the end. We want to repeat the match from one
4838 character further along, but leaving the basic offset the same (for
4839 copying below). We can't be at the end of the string - that was checked
4840 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4841 finished; copy the remaining string and end the loop. */
4851 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4855 /* Match - set up for expanding the replacement. */
4857 if (n == 0) n = EXPAND_MAXN + 1;
4859 for (nn = 0; nn < n*2; nn += 2)
4861 expand_nstring[expand_nmax] = subject + ovector[nn];
4862 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4866 /* Copy the characters before the match, plus the expanded insertion. */
4868 yield = string_cat(yield, &size, &ptr, subject + moffset,
4869 ovector[0] - moffset);
4870 insert = expand_string(sub[2]);
4871 if (insert == NULL) goto EXPAND_FAILED;
4872 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4874 moffset = ovector[1];
4878 /* If we have matched an empty string, first check to see if we are at
4879 the end of the subject. If so, the loop is over. Otherwise, mimic
4880 what Perl's /g options does. This turns out to be rather cunning. First
4881 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4882 string at the same point. If this fails (picked up above) we advance to
4883 the next character. */
4885 if (ovector[0] == ovector[1])
4887 if (ovector[0] == slen) break;
4888 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4892 /* All done - restore numerical variables. */
4894 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4895 save_expand_nlength);
4899 /* Handle keyed and numbered substring extraction. If the first argument
4900 consists entirely of digits, then a numerical extraction is assumed. */
4906 int field_number = 1;
4907 BOOL field_number_set = FALSE;
4908 uschar *save_lookup_value = lookup_value;
4910 int save_expand_nmax =
4911 save_expand_strings(save_expand_nstring, save_expand_nlength);
4913 /* Read the arguments */
4915 for (i = 0; i < j; i++)
4917 while (isspace(*s)) s++;
4920 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4921 if (sub[i] == NULL) goto EXPAND_FAILED;
4922 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4924 /* After removal of leading and trailing white space, the first
4925 argument must not be empty; if it consists entirely of digits
4926 (optionally preceded by a minus sign), this is a numerical
4927 extraction, and we expect 3 arguments. */
4935 while (isspace(*p)) p++;
4939 while (len > 0 && isspace(p[len-1])) len--;
4942 if (*p == 0 && !skipping)
4944 expand_string_message = US"first argument of \"extract\" must "
4954 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4958 j = 3; /* Need 3 args */
4959 field_number_set = TRUE;
4963 else goto EXPAND_FAILED_CURLY;
4966 /* Extract either the numbered or the keyed substring into $value. If
4967 skipping, just pretend the extraction failed. */
4969 lookup_value = skipping? NULL : field_number_set?
4970 expand_gettokened(field_number, sub[1], sub[2]) :
4971 expand_getkeyed(sub[0], sub[1]);
4973 /* If no string follows, $value gets substituted; otherwise there can
4974 be yes/no strings, as for lookup or if. */
4976 switch(process_yesno(
4977 skipping, /* were previously skipping */
4978 lookup_value != NULL, /* success/failure indicator */
4979 save_lookup_value, /* value to reset for string2 */
4980 &s, /* input pointer */
4981 &yield, /* output pointer */
4982 &size, /* output size */
4983 &ptr, /* output current point */
4984 US"extract")) /* condition type */
4986 case 1: goto EXPAND_FAILED; /* when all is well, the */
4987 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4990 /* All done - restore numerical variables. */
4992 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4993 save_expand_nlength);
4999 /* Handle list operations */
5007 uschar outsep[2] = { '\0', '\0' };
5008 uschar *list, *expr, *temp;
5009 uschar *save_iterate_item = iterate_item;
5010 uschar *save_lookup_value = lookup_value;
5012 while (isspace(*s)) s++;
5013 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5015 list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5016 if (list == NULL) goto EXPAND_FAILED;
5017 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5019 if (item_type == EITEM_REDUCE)
5021 while (isspace(*s)) s++;
5022 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5023 temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5024 if (temp == NULL) goto EXPAND_FAILED;
5025 lookup_value = temp;
5026 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5029 while (isspace(*s)) s++;
5030 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5034 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5035 if scanning a "false" part). This allows us to find the end of the
5036 condition, because if the list is empty, we won't actually evaluate the
5037 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5038 the normal internal expansion function. */
5040 if (item_type == EITEM_FILTER)
5042 temp = eval_condition(expr, NULL);
5043 if (temp != NULL) s = temp;
5047 temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5052 expand_string_message = string_sprintf("%s inside \"%s\" item",
5053 expand_string_message, name);
5057 while (isspace(*s)) s++;
5060 expand_string_message = string_sprintf("missing } at end of condition "
5061 "or expression inside \"%s\"", name);
5065 while (isspace(*s)) s++;
5068 expand_string_message = string_sprintf("missing } at end of \"%s\"",
5073 /* If we are skipping, we can now just move on to the next item. When
5074 processing for real, we perform the iteration. */
5076 if (skipping) continue;
5077 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5079 *outsep = (uschar)sep; /* Separator as a string */
5081 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5083 if (item_type == EITEM_FILTER)
5086 if (eval_condition(expr, &condresult) == NULL)
5088 iterate_item = save_iterate_item;
5089 lookup_value = save_lookup_value;
5090 expand_string_message = string_sprintf("%s inside \"%s\" condition",
5091 expand_string_message, name);
5094 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5095 condresult? "true":"false");
5097 temp = iterate_item; /* TRUE => include this item */
5099 continue; /* FALSE => skip this item */
5102 /* EITEM_MAP and EITEM_REDUCE */
5106 temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5109 iterate_item = save_iterate_item;
5110 expand_string_message = string_sprintf("%s inside \"%s\" item",
5111 expand_string_message, name);
5114 if (item_type == EITEM_REDUCE)
5116 lookup_value = temp; /* Update the value of $value */
5117 continue; /* and continue the iteration */
5121 /* We reach here for FILTER if the condition is true, always for MAP,
5122 and never for REDUCE. The value in "temp" is to be added to the output
5123 list that is being created, ensuring that any occurrences of the
5124 separator character are doubled. Unless we are dealing with the first
5125 item of the output list, add in a space if the new item begins with the
5126 separator character, or is an empty string. */
5128 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5129 yield = string_cat(yield, &size, &ptr, US" ", 1);
5131 /* Add the string in "temp" to the output list that we are building,
5132 This is done in chunks by searching for the separator character. */
5136 size_t seglen = Ustrcspn(temp, outsep);
5137 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5139 /* If we got to the end of the string we output one character
5140 too many; backup and end the loop. Otherwise arrange to double the
5143 if (temp[seglen] == '\0') { ptr--; break; }
5144 yield = string_cat(yield, &size, &ptr, outsep, 1);
5148 /* Output a separator after the string: we will remove the redundant
5149 final one at the end. */
5151 yield = string_cat(yield, &size, &ptr, outsep, 1);
5152 } /* End of iteration over the list loop */
5154 /* REDUCE has generated no output above: output the final value of
5157 if (item_type == EITEM_REDUCE)
5159 yield = string_cat(yield, &size, &ptr, lookup_value,
5160 Ustrlen(lookup_value));
5161 lookup_value = save_lookup_value; /* Restore $value */
5164 /* FILTER and MAP generate lists: if they have generated anything, remove
5165 the redundant final separator. Even though an empty item at the end of a
5166 list does not count, this is tidier. */
5168 else if (ptr != save_ptr) ptr--;
5170 /* Restore preserved $item */
5172 iterate_item = save_iterate_item;
5177 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5178 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5179 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5180 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5182 #define EXPAND_DLFUNC_MAX_ARGS 8
5185 #ifndef EXPAND_DLFUNC
5186 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5187 "is not included in this binary";
5190 #else /* EXPAND_DLFUNC */
5193 exim_dlfunc_t *func;
5196 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5198 if ((expand_forbid & RDO_DLFUNC) != 0)
5200 expand_string_message =
5201 US"dynamically-loaded functions are not permitted";
5205 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5208 case 1: goto EXPAND_FAILED_CURLY;
5210 case 3: goto EXPAND_FAILED;
5213 /* If skipping, we don't actually do anything */
5215 if (skipping) continue;
5217 /* Look up the dynamically loaded object handle in the tree. If it isn't
5218 found, dlopen() the file and put the handle in the tree for next time. */
5220 t = tree_search(dlobj_anchor, argv[0]);
5223 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5226 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5227 argv[0], dlerror());
5228 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5231 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5232 Ustrcpy(t->name, argv[0]);
5233 t->data.ptr = handle;
5234 (void)tree_insertnode(&dlobj_anchor, t);
5237 /* Having obtained the dynamically loaded object handle, look up the
5238 function pointer. */
5240 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5243 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5244 "%s", argv[1], argv[0], dlerror());
5245 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5249 /* Call the function and work out what to do with the result. If it
5250 returns OK, we have a replacement string; if it returns DEFER then
5251 expansion has failed in a non-forced manner; if it returns FAIL then
5252 failure was forced; if it returns ERROR or any other value there's a
5253 problem, so panic slightly. In any case, assume that the function has
5254 side-effects on the store that must be preserved. */
5258 for (argc = 0; argv[argc] != NULL; argc++);
5259 status = func(&result, argc - 2, &argv[2]);
5262 if (result == NULL) result = US"";
5263 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5268 expand_string_message = result == NULL ? US"(no message)" : result;
5269 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5270 else if(status != FAIL)
5271 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5272 argv[0], argv[1], status, expand_string_message);
5276 #endif /* EXPAND_DLFUNC */
5279 /* Control reaches here if the name is not recognized as one of the more
5280 complicated expansion items. Check for the "operator" syntax (name terminated
5281 by a colon). Some of the operators have arguments, separated by _ from the
5288 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5289 if (sub == NULL) goto EXPAND_FAILED;
5292 /* Owing to an historical mis-design, an underscore may be part of the
5293 operator name, or it may introduce arguments. We therefore first scan the
5294 table of names that contain underscores. If there is no match, we cut off
5295 the arguments and then scan the main table. */
5297 c = chop_match(name, op_table_underscore,
5298 sizeof(op_table_underscore)/sizeof(uschar *));
5302 arg = Ustrchr(name, '_');
5303 if (arg != NULL) *arg = 0;
5304 c = chop_match(name, op_table_main,
5305 sizeof(op_table_main)/sizeof(uschar *));
5306 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5307 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5310 /* If we are skipping, we don't need to perform the operation at all.
5311 This matters for operations like "mask", because the data may not be
5312 in the correct format when skipping. For example, the expression may test
5313 for the existence of $sender_host_address before trying to mask it. For
5314 other operations, doing them may not fail, but it is a waste of time. */
5316 if (skipping && c >= 0) continue;
5318 /* Otherwise, switch on the operator type */
5325 unsigned long int n = Ustrtoul(sub, &t, 10);
5328 expand_string_message = string_sprintf("argument for base62 "
5329 "operator is \"%s\", which is not a decimal number", sub);
5332 t = string_base62(n);
5333 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5337 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5343 unsigned long int n = 0;
5346 uschar *t = Ustrchr(base62_chars, *tt++);
5349 expand_string_message = string_sprintf("argument for base62d "
5350 "operator is \"%s\", which is not a base %d number", sub,
5354 n = n * BASE_62 + (t - base62_chars);
5356 (void)sprintf(CS buf, "%ld", n);
5357 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5363 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5364 if (expanded == NULL)
5366 expand_string_message =
5367 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5368 expand_string_message);
5371 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5378 uschar *t = sub - 1;
5379 while (*(++t) != 0) { *t = tolower(*t); count++; }
5380 yield = string_cat(yield, &size, &ptr, sub, count);
5387 uschar *t = sub - 1;
5388 while (*(++t) != 0) { *t = toupper(*t); count++; }
5389 yield = string_cat(yield, &size, &ptr, sub, count);
5400 md5_end(&base, sub, Ustrlen(sub), digest);
5401 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5402 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5413 sha1_end(&base, sub, Ustrlen(sub), digest);
5414 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5415 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5419 /* Convert hex encoding to base64 encoding */
5429 for (enc = sub; *enc != 0; enc++)
5431 if (!isxdigit(*enc))
5433 expand_string_message = string_sprintf("\"%s\" is not a hex "
5442 expand_string_message = string_sprintf("\"%s\" contains an odd "
5443 "number of characters", sub);
5447 while ((c = *in++) != 0)
5449 if (isdigit(c)) c -= '0';
5450 else c = toupper(c) - 'A' + 10;
5462 enc = auth_b64encode(sub, out - sub);
5463 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5467 /* mask applies a mask to an IP address; for example the result of
5468 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5475 int mask, maskoffset;
5476 int type = string_is_ip_address(sub, &maskoffset);
5481 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5486 if (maskoffset == 0)
5488 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5493 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5495 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5497 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5502 /* Convert the address to binary integer(s) and apply the mask */
5504 sub[maskoffset] = 0;
5505 count = host_aton(sub, binary);
5506 host_mask(count, binary, mask);
5508 /* Convert to masked textual format and add to output. */
5510 yield = string_cat(yield, &size, &ptr, buffer,
5511 host_nmtoa(count, binary, mask, buffer, '.'));
5516 case EOP_LOCAL_PART:
5520 int start, end, domain;
5521 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5525 if (c != EOP_DOMAIN)
5527 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5528 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5530 else if (domain != 0)
5533 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5541 uschar outsep[2] = { ':', '\0' };
5542 uschar *address, *error;
5544 int start, end, domain; /* Not really used */
5546 while (isspace(*sub)) sub++;
5547 if (*sub == '>') { *outsep = *++sub; ++sub; }
5548 parse_allow_group = TRUE;
5552 uschar *p = parse_find_address_end(sub, FALSE);
5553 uschar saveend = *p;
5555 address = parse_extract_address(sub, &error, &start, &end, &domain,
5559 /* Add the address to the output list that we are building. This is
5560 done in chunks by searching for the separator character. At the
5561 start, unless we are dealing with the first address of the output
5562 list, add in a space if the new address begins with the separator
5563 character, or is an empty string. */
5565 if (address != NULL)
5567 if (ptr != save_ptr && address[0] == *outsep)
5568 yield = string_cat(yield, &size, &ptr, US" ", 1);
5572 size_t seglen = Ustrcspn(address, outsep);
5573 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5575 /* If we got to the end of the string we output one character
5578 if (address[seglen] == '\0') { ptr--; break; }
5579 yield = string_cat(yield, &size, &ptr, outsep, 1);
5580 address += seglen + 1;
5583 /* Output a separator after the string: we will remove the
5584 redundant final one at the end. */
5586 yield = string_cat(yield, &size, &ptr, outsep, 1);
5589 if (saveend == '\0') break;
5593 /* If we have generated anything, remove the redundant final
5596 if (ptr != save_ptr) ptr--;
5597 parse_allow_group = FALSE;
5602 /* quote puts a string in quotes if it is empty or contains anything
5603 other than alphamerics, underscore, dot, or hyphen.
5605 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5606 be quoted in order to be a valid local part.
5608 In both cases, newlines and carriage returns are converted into \n and \r
5612 case EOP_QUOTE_LOCAL_PART:
5615 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5616 uschar *t = sub - 1;
5620 while (!needs_quote && *(++t) != 0)
5621 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5623 else /* EOP_QUOTE_LOCAL_PART */
5625 while (!needs_quote && *(++t) != 0)
5626 needs_quote = !isalnum(*t) &&
5627 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5628 (*t != '.' || t == sub || t[1] == 0);
5633 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5638 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5639 else if (*t == '\r')
5640 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5643 if (*t == '\\' || *t == '"')
5644 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5645 yield = string_cat(yield, &size, &ptr, t, 1);
5648 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5650 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5654 /* quote_lookuptype does lookup-specific quoting */
5659 uschar *opt = Ustrchr(arg, '_');
5661 if (opt != NULL) *opt++ = 0;
5663 n = search_findtype(arg, Ustrlen(arg));
5666 expand_string_message = search_error_message;
5670 if (lookup_list[n]->quote != NULL)
5671 sub = (lookup_list[n]->quote)(sub, opt);
5672 else if (opt != NULL) sub = NULL;
5676 expand_string_message = string_sprintf(
5677 "\"%s\" unrecognized after \"${quote_%s\"",
5682 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5686 /* rx quote sticks in \ before any non-alphameric character so that
5687 the insertion works in a regular expression. */
5691 uschar *t = sub - 1;
5695 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5696 yield = string_cat(yield, &size, &ptr, t, 1);
5701 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5702 prescribed by the RFC, if there are characters that need to be encoded */
5706 uschar buffer[2048];
5707 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5708 buffer, sizeof(buffer), FALSE);
5709 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5713 /* RFC 2047 decode */
5719 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5720 headers_charset, '?', &len, &error);
5723 expand_string_message = error;
5726 yield = string_cat(yield, &size, &ptr, decoded, len);
5730 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5740 if (c > 255) c = '_';
5742 yield = string_cat(yield, &size, &ptr, buff, 1);
5747 /* escape turns all non-printing characters into escape sequences. */
5751 uschar *t = string_printing(sub);
5752 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5756 /* Handle numeric expression evaluation */
5761 uschar *save_sub = sub;
5762 uschar *error = NULL;
5763 int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5766 expand_string_message = string_sprintf("error in expression "
5767 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5771 sprintf(CS var_buffer, PR_EXIM_ARITH, n);
5772 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5776 /* Handle time period formating */
5780 int n = readconf_readtime(sub, 0, FALSE);
5783 expand_string_message = string_sprintf("string \"%s\" is not an "
5784 "Exim time interval in \"%s\" operator", sub, name);
5787 sprintf(CS var_buffer, "%d", n);
5788 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5792 case EOP_TIME_INTERVAL:
5795 uschar *t = read_number(&n, sub);
5796 if (*t != 0) /* Not A Number*/
5798 expand_string_message = string_sprintf("string \"%s\" is not a "
5799 "positive number in \"%s\" operator", sub, name);
5802 t = readconf_printtime(n);
5803 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5807 /* Convert string to base64 encoding */
5811 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5812 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5816 /* strlen returns the length of the string */
5821 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5822 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5826 /* length_n or l_n takes just the first n characters or the whole string,
5827 whichever is the shorter;
5829 substr_m_n, and s_m_n take n characters from offset m; negative m take
5830 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5831 takes the rest, either to the right or to the left.
5833 hash_n or h_n makes a hash of length n from the string, yielding n
5834 characters from the set a-z; hash_n_m makes a hash of length n, but
5835 uses m characters from the set a-zA-Z0-9.
5837 nhash_n returns a single number between 0 and n-1 (in text form), while
5838 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5839 between 0 and n-1 and the second between 0 and m-1. */
5859 expand_string_message = string_sprintf("missing values after %s",
5864 /* "length" has only one argument, effectively being synonymous with
5867 if (c == EOP_LENGTH || c == EOP_L)
5873 /* The others have one or two arguments; for "substr" the first may be
5874 negative. The second being negative means "not supplied". */
5879 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5882 /* Read up to two numbers, separated by underscores */
5887 if (arg != ret && *arg == '_' && pn == &value1)
5891 if (arg[1] != 0) arg++;
5893 else if (!isdigit(*arg))
5895 expand_string_message =
5896 string_sprintf("non-digit after underscore in \"%s\"", name);
5899 else *pn = (*pn)*10 + *arg++ - '0';
5903 /* Perform the required operation */
5906 (c == EOP_HASH || c == EOP_H)?
5907 compute_hash(sub, value1, value2, &len) :
5908 (c == EOP_NHASH || c == EOP_NH)?
5909 compute_nhash(sub, value1, value2, &len) :
5910 extract_substr(sub, value1, value2, &len);
5912 if (ret == NULL) goto EXPAND_FAILED;
5913 yield = string_cat(yield, &size, &ptr, ret, len);
5923 uschar **modetable[3];
5928 if ((expand_forbid & RDO_EXISTS) != 0)
5930 expand_string_message = US"Use of the stat() expansion is not permitted";
5934 if (stat(CS sub, &st) < 0)
5936 expand_string_message = string_sprintf("stat(%s) failed: %s",
5937 sub, strerror(errno));
5941 switch (mode & S_IFMT)
5943 case S_IFIFO: smode[0] = 'p'; break;
5944 case S_IFCHR: smode[0] = 'c'; break;
5945 case S_IFDIR: smode[0] = 'd'; break;
5946 case S_IFBLK: smode[0] = 'b'; break;
5947 case S_IFREG: smode[0] = '-'; break;
5948 default: smode[0] = '?'; break;
5951 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5952 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5953 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5955 for (i = 0; i < 3; i++)
5957 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5962 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5963 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5964 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5965 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5966 (long)st.st_gid, st.st_size, (long)st.st_atime,
5967 (long)st.st_mtime, (long)st.st_ctime);
5968 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5972 /* vaguely random number less than N */
5976 int_eximarith_t max;
5979 max = expand_string_integer(sub, TRUE);
5980 if (expand_string_message != NULL)
5982 s = string_sprintf("%d", vaguely_random_number((int)max));
5983 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5987 /* Reverse IP, including IPv6 to dotted-nibble */
5989 case EOP_REVERSE_IP:
5991 int family, maskptr;
5992 uschar reversed[128];
5994 family = string_is_ip_address(sub, &maskptr);
5997 expand_string_message = string_sprintf(
5998 "reverse_ip() not given an IP address [%s]", sub);
6001 invert_address(reversed, sub);
6002 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6006 /* Unknown operator */
6009 expand_string_message =
6010 string_sprintf("unknown expansion operator \"%s\"", name);
6015 /* Handle a plain name. If this is the first thing in the expansion, release
6016 the pre-allocated buffer. If the result data is known to be in a new buffer,
6017 newsize will be set to the size of that buffer, and we can just point at that
6018 store instead of copying. Many expansion strings contain just one reference,
6019 so this is a useful optimization, especially for humungous headers
6020 ($message_headers). */
6028 if (resetok) store_reset(yield);
6032 value = find_variable(name, FALSE, skipping, &newsize);
6035 expand_string_message =
6036 string_sprintf("unknown variable in \"${%s}\"", name);
6037 check_variable_error_message(name);
6040 len = Ustrlen(value);
6041 if (yield == NULL && newsize != 0)
6047 else yield = string_cat(yield, &size, &ptr, value, len);
6051 /* Else there's something wrong */
6053 expand_string_message =
6054 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6055 "in a variable reference)", name);
6059 /* If we hit the end of the string when ket_ends is set, there is a missing
6060 terminating brace. */
6062 if (ket_ends && *s == 0)
6064 expand_string_message = malformed_header?
6065 US"missing } at end of string - could be header name not terminated by colon"
6067 US"missing } at end of string";
6071 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6072 added to the string. If so, set up an empty string. Add a terminating zero. If
6073 left != NULL, return a pointer to the terminator. */
6075 if (yield == NULL) yield = store_get(1);
6077 if (left != NULL) *left = s;
6079 /* Any stacking store that was used above the final string is no longer needed.
6080 In many cases the final string will be the first one that was got and so there
6081 will be optimal store usage. */
6083 if (resetok) store_reset(yield + ptr + 1);
6086 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
6088 if (skipping) debug_printf("skipping: result is not used\n");
6092 /* This is the failure exit: easiest to program with a goto. We still need
6093 to update the pointer to the terminator, for cases of nested calls with "fail".
6096 EXPAND_FAILED_CURLY:
6097 expand_string_message = malformed_header?
6098 US"missing or misplaced { or } - could be header name not terminated by colon"
6100 US"missing or misplaced { or }";
6102 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6103 that is a bad idea, because expand_string_message is in dynamic store. */
6106 if (left != NULL) *left = s;
6109 debug_printf("failed to expand: %s\n", string);
6110 debug_printf(" error message: %s\n", expand_string_message);
6111 if (expand_string_forcedfail) debug_printf("failure was forced\n");
6117 /* This is the external function call. Do a quick check for any expansion
6118 metacharacters, and if there are none, just return the input string.
6120 Argument: the string to be expanded
6121 Returns: the expanded string, or NULL if expansion failed; if failure was
6122 due to a lookup deferring, search_find_defer will be TRUE
6126 expand_string(uschar *string)
6128 search_find_defer = FALSE;
6129 malformed_header = FALSE;
6130 return (Ustrpbrk(string, "$\\") == NULL)? string :
6131 expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6136 /*************************************************
6138 *************************************************/
6140 /* Now and again we want to expand a string and be sure that the result is in a
6141 new bit of store. This function does that.
6143 Argument: the string to be expanded
6144 Returns: the expanded string, always in a new bit of store, or NULL
6148 expand_string_copy(uschar *string)
6150 uschar *yield = expand_string(string);
6151 if (yield == string) yield = string_copy(string);
6157 /*************************************************
6158 * Expand and interpret as an integer *
6159 *************************************************/
6161 /* Expand a string, and convert the result into an integer.
6164 string the string to be expanded
6165 isplus TRUE if a non-negative number is expected
6167 Returns: the integer value, or
6168 -1 for an expansion error ) in both cases, message in
6169 -2 for an integer interpretation error ) expand_string_message
6170 expand_string_message is set NULL for an OK integer
6174 expand_string_integer(uschar *string, BOOL isplus)
6176 int_eximarith_t value;
6177 uschar *s = expand_string(string);
6178 uschar *msg = US"invalid integer \"%s\"";
6181 /* If expansion failed, expand_string_message will be set. */
6183 if (s == NULL) return -1;
6185 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6186 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6187 systems, so we set it zero ourselves. */
6190 expand_string_message = NULL; /* Indicates no error */
6192 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6193 equal to 0. Unfortunately, people actually relied upon that, so preserve
6194 the behaviour explicitly. Stripping leading whitespace is a harmless
6195 noop change since strtol skips it anyway (provided that there is a number
6199 while (isspace(*s)) ++s;
6203 debug_printf("treating blank string as number 0\n");
6208 value = strtoll(CS s, CSS &endptr, 10);
6212 msg = US"integer expected but \"%s\" found";
6214 else if (value < 0 && isplus)
6216 msg = US"non-negative integer expected but \"%s\" found";
6220 if (tolower(*endptr) == 'k')
6222 if (value > LLONG_MAX/1024 || value < LLONG_MIN/1024) errno = ERANGE;
6226 else if (tolower(*endptr) == 'm')
6228 if (value > LLONG_MAX/(1024*1024) || value < LLONG_MIN/(1024*1024))
6230 else value *= 1024*1024;
6233 if (errno == ERANGE)
6234 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6237 while (isspace(*endptr)) endptr++;
6238 if (*endptr == 0) return (int)value;
6242 expand_string_message = string_sprintf(CS msg, s);
6247 /*************************************************
6248 **************************************************
6249 * Stand-alone test program *
6250 **************************************************
6251 *************************************************/
6257 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6259 int ovector[3*(EXPAND_MAXN+1)];
6260 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6261 ovector, sizeof(ovector)/sizeof(int));
6262 BOOL yield = n >= 0;
6263 if (n == 0) n = EXPAND_MAXN + 1;
6267 expand_nmax = (setup < 0)? 0 : setup + 1;
6268 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6270 expand_nstring[expand_nmax] = subject + ovector[nn];
6271 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6279 int main(int argc, uschar **argv)
6282 uschar buffer[1024];
6284 debug_selector = D_v;
6285 debug_file = stderr;
6286 debug_fd = fileno(debug_file);
6287 big_buffer = malloc(big_buffer_size);
6289 for (i = 1; i < argc; i++)
6291 if (argv[i][0] == '+')
6293 debug_trace_memory = 2;
6296 if (isdigit(argv[i][0]))
6297 debug_selector = Ustrtol(argv[i], NULL, 0);
6299 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6303 eldap_default_servers = argv[i];
6306 mysql_servers = argv[i];
6309 pgsql_servers = argv[i];
6313 else opt_perl_startup = argv[i];
6317 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6319 expand_nstring[1] = US"string 1....";
6320 expand_nlength[1] = 8;
6324 if (opt_perl_startup != NULL)
6327 printf("Starting Perl interpreter\n");
6328 errstr = init_perl(opt_perl_startup);
6331 printf("** error in perl_startup code: %s\n", errstr);
6332 return EXIT_FAILURE;
6335 #endif /* EXIM_PERL */
6337 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6339 void *reset_point = store_get(0);
6340 uschar *yield = expand_string(buffer);
6343 printf("%s\n", yield);
6344 store_reset(reset_point);
6348 if (search_find_defer) printf("search_find deferred\n");
6349 printf("Failed: %s\n", expand_string_message);
6350 if (expand_string_forcedfail) printf("Forced failure\n");
6362 /* End of expand.c */