1 /* $Cambridge: exim/src/src/expand.c,v 1.106 2010/06/05 23:50:18 pdp Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2009 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /* Functions for handling string expansion. */
16 /* Recursively called function */
18 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
21 #ifndef SUPPORT_CRYPTEQ
22 #define SUPPORT_CRYPTEQ
27 #include "lookups/ldap.h"
30 #ifdef SUPPORT_CRYPTEQ
35 extern char* crypt16(char*, char*);
39 /* The handling of crypt16() is a mess. I will record below the analysis of the
40 mess that was sent to me. We decided, however, to make changing this very low
41 priority, because in practice people are moving away from the crypt()
42 algorithms nowadays, so it doesn't seem worth it.
45 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
46 the first 8 characters of the password using a 20-round version of crypt
47 (standard crypt does 25 rounds). It then crypts the next 8 characters,
48 or an empty block if the password is less than 9 characters, using a
49 20-round version of crypt and the same salt as was used for the first
50 block. Charaters after the first 16 are ignored. It always generates
51 a 16-byte hash, which is expressed together with the salt as a string
52 of 24 base 64 digits. Here are some links to peruse:
54 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
55 http://seclists.org/bugtraq/1999/Mar/0076.html
57 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
58 and OSF/1. This is the same as the standard crypt if given a password
59 of 8 characters or less. If given more, it first does the same as crypt
60 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
61 using as salt the first two base 64 digits from the first hash block.
62 If the password is more than 16 characters then it crypts the 17th to 24th
63 characters using as salt the first two base 64 digits from the second hash
64 block. And so on: I've seen references to it cutting off the password at
65 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
67 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
68 http://seclists.org/bugtraq/1999/Mar/0109.html
69 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
70 TET1_html/sec.c222.html#no_id_208
72 Exim has something it calls "crypt16". It will either use a native
73 crypt16 or its own implementation. A native crypt16 will presumably
74 be the one that I called "crypt16" above. The internal "crypt16"
75 function, however, is a two-block-maximum implementation of what I called
76 "bigcrypt". The documentation matches the internal code.
78 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
79 that crypt16 and bigcrypt were different things.
81 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
82 to whatever it is using under that name. This unfortunately sets a
83 precedent for using "{crypt16}" to identify two incompatible algorithms
84 whose output can't be distinguished. With "{crypt16}" thus rendered
85 ambiguous, I suggest you deprecate it and invent two new identifiers
86 for the two algorithms.
88 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
89 of the password separately means they can be cracked separately, so
90 the double-length hash only doubles the cracking effort instead of
91 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
99 /*************************************************
100 * Local statics and tables *
101 *************************************************/
103 /* Table of item names, and corresponding switch numbers. The names must be in
104 alphabetical order. */
106 static uschar *item_table[] = {
150 /* Tables of operator names, and corresponding switch numbers. The names must be
151 in alphabetical order. There are two tables, because underscore is used in some
152 cases to introduce arguments, whereas for other it is part of the name. This is
153 an historical mis-design. */
155 static uschar *op_table_underscore[] = {
158 US"quote_local_part",
166 EOP_QUOTE_LOCAL_PART,
171 static uschar *op_table_main[] = {
205 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
238 /* Table of condition names, and corresponding switch numbers. The names must
239 be in alphabetical order. */
241 static uschar *cond_table[] = {
245 US"==", /* Backward compatibility */
274 US"match_local_part",
297 ECOND_FIRST_DELIVERY,
316 ECOND_MATCH_LOCAL_PART,
326 /* Type for main variable table */
334 /* Type for entries pointing to address/length pairs. Not currently
342 /* Types of table entry */
345 vtype_int, /* value is address of int */
346 vtype_filter_int, /* ditto, but recognized only when filtering */
347 vtype_ino, /* value is address of ino_t (not always an int) */
348 vtype_uid, /* value is address of uid_t (not always an int) */
349 vtype_gid, /* value is address of gid_t (not always an int) */
350 vtype_stringptr, /* value is address of pointer to string */
351 vtype_msgbody, /* as stringptr, but read when first required */
352 vtype_msgbody_end, /* ditto, the end of the message */
353 vtype_msgheaders, /* the message's headers, processed */
354 vtype_msgheaders_raw, /* the message's headers, unprocessed */
355 vtype_localpart, /* extract local part from string */
356 vtype_domain, /* extract domain from string */
357 vtype_recipients, /* extract recipients from recipients list */
358 /* (available only in system filters, ACLs, and */
360 vtype_todbsdin, /* value not used; generate BSD inbox tod */
361 vtype_tode, /* value not used; generate tod in epoch format */
362 vtype_todf, /* value not used; generate full tod */
363 vtype_todl, /* value not used; generate log tod */
364 vtype_todlf, /* value not used; generate log file datestamp tod */
365 vtype_todzone, /* value not used; generate time zone only */
366 vtype_todzulu, /* value not used; generate zulu tod */
367 vtype_reply, /* value not used; get reply from headers */
368 vtype_pid, /* value not used; result is pid */
369 vtype_host_lookup, /* value not used; get host name */
370 vtype_load_avg, /* value not used; result is int from os_getloadavg */
371 vtype_pspace, /* partition space; value is T/F for spool/log */
372 vtype_pinodes /* partition inodes; value is T/F for spool/log */
374 ,vtype_dkim /* Lookup of value in DKIM signature */
378 /* This table must be kept in alphabetical order. */
380 static var_entry var_table[] = {
381 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
382 they will be confused with user-creatable ACL variables. */
383 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
384 { "address_data", vtype_stringptr, &deliver_address_data },
385 { "address_file", vtype_stringptr, &address_file },
386 { "address_pipe", vtype_stringptr, &address_pipe },
387 { "authenticated_id", vtype_stringptr, &authenticated_id },
388 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
389 { "authentication_failed",vtype_int, &authentication_failed },
390 #ifdef EXPERIMENTAL_BRIGHTMAIL
391 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
392 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
393 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
394 { "bmi_deliver", vtype_int, &bmi_deliver },
396 { "body_linecount", vtype_int, &body_linecount },
397 { "body_zerocount", vtype_int, &body_zerocount },
398 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
399 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
400 { "caller_gid", vtype_gid, &real_gid },
401 { "caller_uid", vtype_uid, &real_uid },
402 { "compile_date", vtype_stringptr, &version_date },
403 { "compile_number", vtype_stringptr, &version_cnumber },
404 { "csa_status", vtype_stringptr, &csa_status },
405 #ifdef EXPERIMENTAL_DCC
406 { "dcc_header", vtype_stringptr, &dcc_header },
407 { "dcc_result", vtype_stringptr, &dcc_result },
409 #ifdef WITH_OLD_DEMIME
410 { "demime_errorlevel", vtype_int, &demime_errorlevel },
411 { "demime_reason", vtype_stringptr, &demime_reason },
414 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
415 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
416 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
417 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
418 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
419 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
420 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
421 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
422 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
423 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
424 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
425 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
426 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
427 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
428 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
429 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
430 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
431 { "dkim_signers", vtype_stringptr, &dkim_signers },
432 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
433 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
435 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
436 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
437 { "dnslist_text", vtype_stringptr, &dnslist_text },
438 { "dnslist_value", vtype_stringptr, &dnslist_value },
439 { "domain", vtype_stringptr, &deliver_domain },
440 { "domain_data", vtype_stringptr, &deliver_domain_data },
441 { "exim_gid", vtype_gid, &exim_gid },
442 { "exim_path", vtype_stringptr, &exim_path },
443 { "exim_uid", vtype_uid, &exim_uid },
444 #ifdef WITH_OLD_DEMIME
445 { "found_extension", vtype_stringptr, &found_extension },
447 { "home", vtype_stringptr, &deliver_home },
448 { "host", vtype_stringptr, &deliver_host },
449 { "host_address", vtype_stringptr, &deliver_host_address },
450 { "host_data", vtype_stringptr, &host_data },
451 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
452 { "host_lookup_failed", vtype_int, &host_lookup_failed },
453 { "inode", vtype_ino, &deliver_inode },
454 { "interface_address", vtype_stringptr, &interface_address },
455 { "interface_port", vtype_int, &interface_port },
456 { "item", vtype_stringptr, &iterate_item },
458 { "ldap_dn", vtype_stringptr, &eldap_dn },
460 { "load_average", vtype_load_avg, NULL },
461 { "local_part", vtype_stringptr, &deliver_localpart },
462 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
463 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
464 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
465 { "local_scan_data", vtype_stringptr, &local_scan_data },
466 { "local_user_gid", vtype_gid, &local_user_gid },
467 { "local_user_uid", vtype_uid, &local_user_uid },
468 { "localhost_number", vtype_int, &host_number },
469 { "log_inodes", vtype_pinodes, (void *)FALSE },
470 { "log_space", vtype_pspace, (void *)FALSE },
471 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
472 #ifdef WITH_CONTENT_SCAN
473 { "malware_name", vtype_stringptr, &malware_name },
475 { "max_received_linelength", vtype_int, &max_received_linelength },
476 { "message_age", vtype_int, &message_age },
477 { "message_body", vtype_msgbody, &message_body },
478 { "message_body_end", vtype_msgbody_end, &message_body_end },
479 { "message_body_size", vtype_int, &message_body_size },
480 { "message_exim_id", vtype_stringptr, &message_id },
481 { "message_headers", vtype_msgheaders, NULL },
482 { "message_headers_raw", vtype_msgheaders_raw, NULL },
483 { "message_id", vtype_stringptr, &message_id },
484 { "message_linecount", vtype_int, &message_linecount },
485 { "message_size", vtype_int, &message_size },
486 #ifdef WITH_CONTENT_SCAN
487 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
488 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
489 { "mime_boundary", vtype_stringptr, &mime_boundary },
490 { "mime_charset", vtype_stringptr, &mime_charset },
491 { "mime_content_description", vtype_stringptr, &mime_content_description },
492 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
493 { "mime_content_id", vtype_stringptr, &mime_content_id },
494 { "mime_content_size", vtype_int, &mime_content_size },
495 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
496 { "mime_content_type", vtype_stringptr, &mime_content_type },
497 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
498 { "mime_filename", vtype_stringptr, &mime_filename },
499 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
500 { "mime_is_multipart", vtype_int, &mime_is_multipart },
501 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
502 { "mime_part_count", vtype_int, &mime_part_count },
504 { "n0", vtype_filter_int, &filter_n[0] },
505 { "n1", vtype_filter_int, &filter_n[1] },
506 { "n2", vtype_filter_int, &filter_n[2] },
507 { "n3", vtype_filter_int, &filter_n[3] },
508 { "n4", vtype_filter_int, &filter_n[4] },
509 { "n5", vtype_filter_int, &filter_n[5] },
510 { "n6", vtype_filter_int, &filter_n[6] },
511 { "n7", vtype_filter_int, &filter_n[7] },
512 { "n8", vtype_filter_int, &filter_n[8] },
513 { "n9", vtype_filter_int, &filter_n[9] },
514 { "original_domain", vtype_stringptr, &deliver_domain_orig },
515 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
516 { "originator_gid", vtype_gid, &originator_gid },
517 { "originator_uid", vtype_uid, &originator_uid },
518 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
519 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
520 { "pid", vtype_pid, NULL },
521 { "primary_hostname", vtype_stringptr, &primary_hostname },
522 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
523 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
524 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
525 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
526 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
527 { "rcpt_count", vtype_int, &rcpt_count },
528 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
529 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
530 { "received_count", vtype_int, &received_count },
531 { "received_for", vtype_stringptr, &received_for },
532 { "received_ip_address", vtype_stringptr, &interface_address },
533 { "received_port", vtype_int, &interface_port },
534 { "received_protocol", vtype_stringptr, &received_protocol },
535 { "received_time", vtype_int, &received_time },
536 { "recipient_data", vtype_stringptr, &recipient_data },
537 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
538 { "recipients", vtype_recipients, NULL },
539 { "recipients_count", vtype_int, &recipients_count },
540 #ifdef WITH_CONTENT_SCAN
541 { "regex_match_string", vtype_stringptr, ®ex_match_string },
543 { "reply_address", vtype_reply, NULL },
544 { "return_path", vtype_stringptr, &return_path },
545 { "return_size_limit", vtype_int, &bounce_return_size_limit },
546 { "runrc", vtype_int, &runrc },
547 { "self_hostname", vtype_stringptr, &self_hostname },
548 { "sender_address", vtype_stringptr, &sender_address },
549 { "sender_address_data", vtype_stringptr, &sender_address_data },
550 { "sender_address_domain", vtype_domain, &sender_address },
551 { "sender_address_local_part", vtype_localpart, &sender_address },
552 { "sender_data", vtype_stringptr, &sender_data },
553 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
554 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
555 { "sender_host_address", vtype_stringptr, &sender_host_address },
556 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
557 { "sender_host_name", vtype_host_lookup, NULL },
558 { "sender_host_port", vtype_int, &sender_host_port },
559 { "sender_ident", vtype_stringptr, &sender_ident },
560 { "sender_rate", vtype_stringptr, &sender_rate },
561 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
562 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
563 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
564 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
565 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
566 { "sending_port", vtype_int, &sending_port },
567 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
568 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
569 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
570 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
571 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
572 { "sn0", vtype_filter_int, &filter_sn[0] },
573 { "sn1", vtype_filter_int, &filter_sn[1] },
574 { "sn2", vtype_filter_int, &filter_sn[2] },
575 { "sn3", vtype_filter_int, &filter_sn[3] },
576 { "sn4", vtype_filter_int, &filter_sn[4] },
577 { "sn5", vtype_filter_int, &filter_sn[5] },
578 { "sn6", vtype_filter_int, &filter_sn[6] },
579 { "sn7", vtype_filter_int, &filter_sn[7] },
580 { "sn8", vtype_filter_int, &filter_sn[8] },
581 { "sn9", vtype_filter_int, &filter_sn[9] },
582 #ifdef WITH_CONTENT_SCAN
583 { "spam_bar", vtype_stringptr, &spam_bar },
584 { "spam_report", vtype_stringptr, &spam_report },
585 { "spam_score", vtype_stringptr, &spam_score },
586 { "spam_score_int", vtype_stringptr, &spam_score_int },
588 #ifdef EXPERIMENTAL_SPF
589 { "spf_guess", vtype_stringptr, &spf_guess },
590 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
591 { "spf_received", vtype_stringptr, &spf_received },
592 { "spf_result", vtype_stringptr, &spf_result },
593 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
595 { "spool_directory", vtype_stringptr, &spool_directory },
596 { "spool_inodes", vtype_pinodes, (void *)TRUE },
597 { "spool_space", vtype_pspace, (void *)TRUE },
598 #ifdef EXPERIMENTAL_SRS
599 { "srs_db_address", vtype_stringptr, &srs_db_address },
600 { "srs_db_key", vtype_stringptr, &srs_db_key },
601 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
602 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
603 { "srs_recipient", vtype_stringptr, &srs_recipient },
604 { "srs_status", vtype_stringptr, &srs_status },
606 { "thisaddress", vtype_stringptr, &filter_thisaddress },
607 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
608 { "tls_cipher", vtype_stringptr, &tls_cipher },
609 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
610 { "tod_bsdinbox", vtype_todbsdin, NULL },
611 { "tod_epoch", vtype_tode, NULL },
612 { "tod_full", vtype_todf, NULL },
613 { "tod_log", vtype_todl, NULL },
614 { "tod_logfile", vtype_todlf, NULL },
615 { "tod_zone", vtype_todzone, NULL },
616 { "tod_zulu", vtype_todzulu, NULL },
617 { "value", vtype_stringptr, &lookup_value },
618 { "version_number", vtype_stringptr, &version_string },
619 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
620 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
621 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
622 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
623 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
624 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
627 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
628 static uschar var_buffer[256];
629 static BOOL malformed_header;
631 /* For textual hashes */
633 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
634 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
637 enum { HMAC_MD5, HMAC_SHA1 };
639 /* For numeric hashes */
641 static unsigned int prime[] = {
642 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
643 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
644 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
646 /* For printing modes in symbolic form */
648 static uschar *mtable_normal[] =
649 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
651 static uschar *mtable_setid[] =
652 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
654 static uschar *mtable_sticky[] =
655 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
659 /*************************************************
660 * Tables for UTF-8 support *
661 *************************************************/
663 /* Table of the number of extra characters, indexed by the first character
664 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
667 static uschar utf8_table1[] = {
668 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
669 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
670 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
671 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
673 /* These are the masks for the data bits in the first byte of a character,
674 indexed by the number of additional bytes. */
676 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
678 /* Get the next UTF-8 character, advancing the pointer. */
680 #define GETUTF8INC(c, ptr) \
682 if ((c & 0xc0) == 0xc0) \
684 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
686 c = (c & utf8_table2[a]) << s; \
690 c |= (*ptr++ & 0x3f) << s; \
695 /*************************************************
696 * Binary chop search on a table *
697 *************************************************/
699 /* This is used for matching expansion items and operators.
702 name the name that is being sought
703 table the table to search
704 table_size the number of items in the table
706 Returns: the offset in the table, or -1
710 chop_match(uschar *name, uschar **table, int table_size)
712 uschar **bot = table;
713 uschar **top = table + table_size;
717 uschar **mid = bot + (top - bot)/2;
718 int c = Ustrcmp(name, *mid);
719 if (c == 0) return mid - table;
720 if (c > 0) bot = mid + 1; else top = mid;
728 /*************************************************
729 * Check a condition string *
730 *************************************************/
732 /* This function is called to expand a string, and test the result for a "true"
733 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
734 forced fail or lookup defer. All store used by the function can be released on
738 condition the condition string
739 m1 text to be incorporated in panic error
742 Returns: TRUE if condition is met, FALSE if not
746 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
749 void *reset_point = store_get(0);
750 uschar *ss = expand_string(condition);
753 if (!expand_string_forcedfail && !search_find_defer)
754 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
755 "for %s %s: %s", condition, m1, m2, expand_string_message);
758 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
759 strcmpic(ss, US"false") != 0;
760 store_reset(reset_point);
766 /*************************************************
767 * Pseudo-random number generation *
768 *************************************************/
770 /* Pseudo-random number generation. The result is not "expected" to be
771 cryptographically strong but not so weak that someone will shoot themselves
772 in the foot using it as a nonce in some email header scheme or whatever
773 weirdness they'll twist this into. The result should ideally handle fork().
775 However, if we're stuck unable to provide this, then we'll fall back to
776 appallingly bad randomness.
778 If SUPPORT_TLS is defined and OpenSSL is used, then this will not be used.
779 The GNUTLS randomness functions found do not seem amenable to extracting
780 random numbers outside of a TLS context. Any volunteers?
784 Returns a random number in range [0, max-1]
787 #if !defined(SUPPORT_TLS) || defined(USE_GNUTLS)
789 pseudo_random_number(int max)
791 static pid_t pid = 0;
793 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
803 #ifdef HAVE_ARC4RANDOM
804 /* cryptographically strong randomness, common on *BSD platforms, not
805 so much elsewhere. Alas. */
807 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
808 #ifdef HAVE_SRANDOMDEV
809 /* uses random(4) for seeding */
812 gettimeofday(&tv, NULL);
813 srandom(tv.tv_sec | tv.tv_usec | getpid());
816 /* Poor randomness and no seeding here */
823 #ifdef HAVE_ARC4RANDOM
824 return arc4random() % max;
825 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
826 return random() % max;
828 /* This one returns a 16-bit number, definitely not crypto-strong */
829 return random_number(max);
835 /*************************************************
836 * Pick out a name from a string *
837 *************************************************/
839 /* If the name is too long, it is silently truncated.
842 name points to a buffer into which to put the name
843 max is the length of the buffer
844 s points to the first alphabetic character of the name
845 extras chars other than alphanumerics to permit
847 Returns: pointer to the first character after the name
849 Note: The test for *s != 0 in the while loop is necessary because
850 Ustrchr() yields non-NULL if the character is zero (which is not something
854 read_name(uschar *name, int max, uschar *s, uschar *extras)
857 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
859 if (ptr < max-1) name[ptr++] = *s;
868 /*************************************************
869 * Pick out the rest of a header name *
870 *************************************************/
872 /* A variable name starting $header_ (or just $h_ for those who like
873 abbreviations) might not be the complete header name because headers can
874 contain any printing characters in their names, except ':'. This function is
875 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
876 on the end, if the name was terminated by white space.
879 name points to a buffer in which the name read so far exists
880 max is the length of the buffer
881 s points to the first character after the name so far, i.e. the
882 first non-alphameric character after $header_xxxxx
884 Returns: a pointer to the first character after the header name
888 read_header_name(uschar *name, int max, uschar *s)
890 int prelen = Ustrchr(name, '_') - name + 1;
891 int ptr = Ustrlen(name) - prelen;
892 if (ptr > 0) memmove(name, name+prelen, ptr);
893 while (mac_isgraph(*s) && *s != ':')
895 if (ptr < max-1) name[ptr++] = *s;
906 /*************************************************
907 * Pick out a number from a string *
908 *************************************************/
911 n points to an integer into which to put the number
912 s points to the first digit of the number
914 Returns: a pointer to the character after the last digit
918 read_number(int *n, uschar *s)
921 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
927 /*************************************************
928 * Extract keyed subfield from a string *
929 *************************************************/
931 /* The yield is in dynamic store; NULL means that the key was not found.
934 key points to the name of the key
935 s points to the string from which to extract the subfield
937 Returns: NULL if the subfield was not found, or
938 a pointer to the subfield's data
942 expand_getkeyed(uschar *key, uschar *s)
944 int length = Ustrlen(key);
945 while (isspace(*s)) s++;
947 /* Loop to search for the key */
955 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
956 dkeylength = s - dkey;
957 while (isspace(*s)) s++;
958 if (*s == '=') while (isspace((*(++s))));
960 data = string_dequote(&s);
961 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
964 while (isspace(*s)) s++;
973 /*************************************************
974 * Extract numbered subfield from string *
975 *************************************************/
977 /* Extracts a numbered field from a string that is divided by tokens - for
978 example a line from /etc/passwd is divided by colon characters. First field is
979 numbered one. Negative arguments count from the right. Zero returns the whole
980 string. Returns NULL if there are insufficient tokens in the string
983 Modifies final argument - this is a dynamically generated string, so that's OK.
986 field number of field to be extracted,
987 first field = 1, whole string = 0, last field = -1
988 separators characters that are used to break string into tokens
989 s points to the string from which to extract the subfield
991 Returns: NULL if the field was not found,
992 a pointer to the field's data inside s (modified to add 0)
996 expand_gettokened (int field, uschar *separators, uschar *s)
1001 uschar *fieldtext = NULL;
1003 if (field == 0) return s;
1005 /* Break the line up into fields in place; for field > 0 we stop when we have
1006 done the number of fields we want. For field < 0 we continue till the end of
1007 the string, counting the number of fields. */
1009 count = (field > 0)? field : INT_MAX;
1015 /* Previous field was the last one in the string. For a positive field
1016 number, this means there are not enough fields. For a negative field number,
1017 check that there are enough, and scan back to find the one that is wanted. */
1021 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1022 if ((-field) == (INT_MAX - count - 1)) return s;
1026 while (ss[-1] != 0) ss--;
1032 /* Previous field was not last in the string; save its start and put a
1036 len = Ustrcspn(ss, separators);
1047 /*************************************************
1048 * Extract a substring from a string *
1049 *************************************************/
1051 /* Perform the ${substr or ${length expansion operations.
1054 subject the input string
1055 value1 the offset from the start of the input string to the start of
1056 the output string; if negative, count from the right.
1057 value2 the length of the output string, or negative (-1) for unset
1058 if value1 is positive, unset means "all after"
1059 if value1 is negative, unset means "all before"
1060 len set to the length of the returned string
1062 Returns: pointer to the output string, or NULL if there is an error
1066 extract_substr(uschar *subject, int value1, int value2, int *len)
1068 int sublen = Ustrlen(subject);
1070 if (value1 < 0) /* count from right */
1074 /* If the position is before the start, skip to the start, and adjust the
1075 length. If the length ends up negative, the substring is null because nothing
1076 can precede. This falls out naturally when the length is unset, meaning "all
1082 if (value2 < 0) value2 = 0;
1086 /* Otherwise an unset length => characters before value1 */
1088 else if (value2 < 0)
1095 /* For a non-negative offset, if the starting position is past the end of the
1096 string, the result will be the null string. Otherwise, an unset length means
1097 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1101 if (value1 > sublen)
1106 else if (value2 < 0) value2 = sublen;
1109 /* Cut the length down to the maximum possible for the offset value, and get
1110 the required characters. */
1112 if (value1 + value2 > sublen) value2 = sublen - value1;
1114 return subject + value1;
1120 /*************************************************
1121 * Old-style hash of a string *
1122 *************************************************/
1124 /* Perform the ${hash expansion operation.
1127 subject the input string (an expanded substring)
1128 value1 the length of the output string; if greater or equal to the
1129 length of the input string, the input string is returned
1130 value2 the number of hash characters to use, or 26 if negative
1131 len set to the length of the returned string
1133 Returns: pointer to the output string, or NULL if there is an error
1137 compute_hash(uschar *subject, int value1, int value2, int *len)
1139 int sublen = Ustrlen(subject);
1141 if (value2 < 0) value2 = 26;
1142 else if (value2 > Ustrlen(hashcodes))
1144 expand_string_message =
1145 string_sprintf("hash count \"%d\" too big", value2);
1149 /* Calculate the hash text. We know it is shorter than the original string, so
1150 can safely place it in subject[] (we know that subject is always itself an
1151 expanded substring). */
1153 if (value1 < sublen)
1158 while ((c = (subject[j])) != 0)
1160 int shift = (c + j++) & 7;
1161 subject[i] ^= (c << shift) | (c >> (8-shift));
1162 if (++i >= value1) i = 0;
1164 for (i = 0; i < value1; i++)
1165 subject[i] = hashcodes[(subject[i]) % value2];
1167 else value1 = sublen;
1176 /*************************************************
1177 * Numeric hash of a string *
1178 *************************************************/
1180 /* Perform the ${nhash expansion operation. The first characters of the
1181 string are treated as most important, and get the highest prime numbers.
1184 subject the input string
1185 value1 the maximum value of the first part of the result
1186 value2 the maximum value of the second part of the result,
1187 or negative to produce only a one-part result
1188 len set to the length of the returned string
1190 Returns: pointer to the output string, or NULL if there is an error.
1194 compute_nhash (uschar *subject, int value1, int value2, int *len)
1196 uschar *s = subject;
1198 unsigned long int total = 0; /* no overflow */
1202 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1203 total += prime[i--] * (unsigned int)(*s++);
1206 /* If value2 is unset, just compute one number */
1210 s = string_sprintf("%d", total % value1);
1213 /* Otherwise do a div/mod hash */
1217 total = total % (value1 * value2);
1218 s = string_sprintf("%d/%d", total/value2, total % value2);
1229 /*************************************************
1230 * Find the value of a header or headers *
1231 *************************************************/
1233 /* Multiple instances of the same header get concatenated, and this function
1234 can also return a concatenation of all the header lines. When concatenating
1235 specific headers that contain lists of addresses, a comma is inserted between
1236 them. Otherwise we use a straight concatenation. Because some messages can have
1237 pathologically large number of lines, there is a limit on the length that is
1238 returned. Also, to avoid massive store use which would result from using
1239 string_cat() as it copies and extends strings, we do a preliminary pass to find
1240 out exactly how much store will be needed. On "normal" messages this will be
1244 name the name of the header, without the leading $header_ or $h_,
1245 or NULL if a concatenation of all headers is required
1246 exists_only TRUE if called from a def: test; don't need to build a string;
1247 just return a string that is not "" and not "0" if the header
1249 newsize return the size of memory block that was obtained; may be NULL
1250 if exists_only is TRUE
1251 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1252 other than concatenating, will be done on the header. Also used
1253 for $message_headers_raw.
1254 charset name of charset to translate MIME words to; used only if
1255 want_raw is false; if NULL, no translation is done (this is
1256 used for $bh_ and $bheader_)
1258 Returns: NULL if the header does not exist, else a pointer to a new
1263 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1266 BOOL found = name == NULL;
1268 int len = found? 0 : Ustrlen(name);
1270 uschar *yield = NULL;
1273 /* Loop for two passes - saves code repetition */
1275 for (i = 0; i < 2; i++)
1280 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1282 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1284 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1289 if (exists_only) return US"1"; /* don't need actual string */
1291 t = h->text + len; /* text to insert */
1292 if (!want_raw) /* unless wanted raw, */
1293 while (isspace(*t)) t++; /* remove leading white space */
1294 ilen = h->slen - (t - h->text); /* length to insert */
1296 /* Unless wanted raw, remove trailing whitespace, including the
1300 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1302 /* Set comma = 1 if handling a single header and it's one of those
1303 that contains an address list, except when asked for raw headers. Only
1304 need to do this once. */
1306 if (!want_raw && name != NULL && comma == 0 &&
1307 Ustrchr("BCFRST", h->type) != NULL)
1310 /* First pass - compute total store needed; second pass - compute
1311 total store used, including this header. */
1313 size += ilen + comma + 1; /* +1 for the newline */
1315 /* Second pass - concatentate the data, up to a maximum. Note that
1316 the loop stops when size hits the limit. */
1320 if (size > header_insert_maxlen)
1322 ilen -= size - header_insert_maxlen - 1;
1325 Ustrncpy(ptr, t, ilen);
1328 /* For a non-raw header, put in the comma if needed, then add
1329 back the newline we removed above, provided there was some text in
1332 if (!want_raw && ilen > 0)
1334 if (comma != 0) *ptr++ = ',';
1342 /* At end of first pass, return NULL if no header found. Then truncate size
1343 if necessary, and get the buffer to hold the data, returning the buffer size.
1348 if (!found) return NULL;
1349 if (size > header_insert_maxlen) size = header_insert_maxlen;
1350 *newsize = size + 1;
1351 ptr = yield = store_get(*newsize);
1355 /* That's all we do for raw header expansion. */
1362 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1363 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1364 function can return an error with decoded data if the charset translation
1365 fails. If decoding fails, it returns NULL. */
1369 uschar *decoded, *error;
1370 if (ptr > yield && ptr[-1] == '\n') ptr--;
1371 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1373 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1377 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1378 " input was: %s\n", error, yield);
1380 if (decoded != NULL) yield = decoded;
1389 /*************************************************
1390 * Find value of a variable *
1391 *************************************************/
1393 /* The table of variables is kept in alphabetic order, so we can search it
1394 using a binary chop. The "choplen" variable is nothing to do with the binary
1398 name the name of the variable being sought
1399 exists_only TRUE if this is a def: test; passed on to find_header()
1400 skipping TRUE => skip any processing evaluation; this is not the same as
1401 exists_only because def: may test for values that are first
1403 newsize pointer to an int which is initially zero; if the answer is in
1404 a new memory buffer, *newsize is set to its size
1406 Returns: NULL if the variable does not exist, or
1407 a pointer to the variable's contents, or
1408 something non-NULL if exists_only is TRUE
1412 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1415 int last = var_table_size;
1417 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1418 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1419 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1420 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1421 (this gave backwards compatibility at the changeover). There may be built-in
1422 variables whose names start acl_ but they should never start in this way. This
1423 slightly messy specification is a consequence of the history, needless to say.
1425 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1426 set, in which case give an error. */
1428 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1432 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1433 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1436 /* Handle $auth<n> variables. */
1438 if (Ustrncmp(name, "auth", 4) == 0)
1441 int n = Ustrtoul(name + 4, &endptr, 10);
1442 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1443 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1446 /* For all other variables, search the table */
1448 while (last > first)
1452 int middle = (first + last)/2;
1453 int c = Ustrcmp(name, var_table[middle].name);
1455 if (c > 0) { first = middle + 1; continue; }
1456 if (c < 0) { last = middle; continue; }
1458 /* Found an existing variable. If in skipping state, the value isn't needed,
1459 and we want to avoid processing (such as looking up the host name). */
1461 if (skipping) return US"";
1463 switch (var_table[middle].type)
1465 case vtype_filter_int:
1466 if (!filter_running) return NULL;
1470 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1474 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1478 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1482 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1485 case vtype_stringptr: /* Pointer to string */
1486 s = *((uschar **)(var_table[middle].value));
1487 return (s == NULL)? US"" : s;
1490 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1493 case vtype_load_avg:
1494 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1497 case vtype_host_lookup: /* Lookup if not done so */
1498 if (sender_host_name == NULL && sender_host_address != NULL &&
1499 !host_lookup_failed && host_name_lookup() == OK)
1500 host_build_sender_fullhost();
1501 return (sender_host_name == NULL)? US"" : sender_host_name;
1503 case vtype_localpart: /* Get local part from address */
1504 s = *((uschar **)(var_table[middle].value));
1505 if (s == NULL) return US"";
1506 domain = Ustrrchr(s, '@');
1507 if (domain == NULL) return s;
1508 if (domain - s > sizeof(var_buffer) - 1)
1509 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1510 "string expansion", sizeof(var_buffer));
1511 Ustrncpy(var_buffer, s, domain - s);
1512 var_buffer[domain - s] = 0;
1515 case vtype_domain: /* Get domain from address */
1516 s = *((uschar **)(var_table[middle].value));
1517 if (s == NULL) return US"";
1518 domain = Ustrrchr(s, '@');
1519 return (domain == NULL)? US"" : domain + 1;
1521 case vtype_msgheaders:
1522 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1524 case vtype_msgheaders_raw:
1525 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1527 case vtype_msgbody: /* Pointer to msgbody string */
1528 case vtype_msgbody_end: /* Ditto, the end of the msg */
1529 ss = (uschar **)(var_table[middle].value);
1530 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1533 off_t start_offset = SPOOL_DATA_START_OFFSET;
1534 int len = message_body_visible;
1535 if (len > message_size) len = message_size;
1536 *ss = body = store_malloc(len+1);
1538 if (var_table[middle].type == vtype_msgbody_end)
1540 struct stat statbuf;
1541 if (fstat(deliver_datafile, &statbuf) == 0)
1543 start_offset = statbuf.st_size - len;
1544 if (start_offset < SPOOL_DATA_START_OFFSET)
1545 start_offset = SPOOL_DATA_START_OFFSET;
1548 lseek(deliver_datafile, start_offset, SEEK_SET);
1549 len = read(deliver_datafile, body, len);
1553 if (message_body_newlines) /* Separate loops for efficiency */
1556 { if (body[--len] == 0) body[len] = ' '; }
1561 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1565 return (*ss == NULL)? US"" : *ss;
1567 case vtype_todbsdin: /* BSD inbox time of day */
1568 return tod_stamp(tod_bsdin);
1570 case vtype_tode: /* Unix epoch time of day */
1571 return tod_stamp(tod_epoch);
1573 case vtype_todf: /* Full time of day */
1574 return tod_stamp(tod_full);
1576 case vtype_todl: /* Log format time of day */
1577 return tod_stamp(tod_log_bare); /* (without timezone) */
1579 case vtype_todzone: /* Time zone offset only */
1580 return tod_stamp(tod_zone);
1582 case vtype_todzulu: /* Zulu time */
1583 return tod_stamp(tod_zulu);
1585 case vtype_todlf: /* Log file datestamp tod */
1586 return tod_stamp(tod_log_datestamp);
1588 case vtype_reply: /* Get reply address */
1589 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1591 if (s != NULL) while (isspace(*s)) s++;
1592 if (s == NULL || *s == 0)
1594 *newsize = 0; /* For the *s==0 case */
1595 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1600 while (isspace(*s)) s++;
1601 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1602 while (t > s && isspace(t[-1])) t--;
1605 return (s == NULL)? US"" : s;
1607 /* A recipients list is available only during system message filtering,
1608 during ACL processing after DATA, and while expanding pipe commands
1609 generated from a system filter, but not elsewhere. */
1611 case vtype_recipients:
1612 if (!enable_dollar_recipients) return NULL; else
1617 s = store_get(size);
1618 for (i = 0; i < recipients_count; i++)
1620 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1621 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1622 Ustrlen(recipients_list[i].address));
1624 s[ptr] = 0; /* string_cat() leaves room */
1631 sprintf(CS var_buffer, "%d",
1632 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1639 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1640 sprintf(CS var_buffer, "%d", inodes);
1644 #ifndef DISABLE_DKIM
1646 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1652 return NULL; /* Unknown variable name */
1658 /*************************************************
1659 * Read and expand substrings *
1660 *************************************************/
1662 /* This function is called to read and expand argument substrings for various
1663 expansion items. Some have a minimum requirement that is less than the maximum;
1664 in these cases, the first non-present one is set to NULL.
1667 sub points to vector of pointers to set
1668 n maximum number of substrings
1670 sptr points to current string pointer
1671 skipping the skipping flag
1672 check_end if TRUE, check for final '}'
1673 name name of item, for error message
1675 Returns: 0 OK; string pointer updated
1676 1 curly bracketing error (too few arguments)
1677 2 too many arguments (only if check_end is set); message set
1678 3 other error (expansion failure)
1682 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1683 BOOL check_end, uschar *name)
1688 while (isspace(*s)) s++;
1689 for (i = 0; i < n; i++)
1693 if (i < m) return 1;
1697 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1698 if (sub[i] == NULL) return 3;
1699 if (*s++ != '}') return 1;
1700 while (isspace(*s)) s++;
1702 if (check_end && *s++ != '}')
1706 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1707 "(max is %d)", name, n);
1720 /*************************************************
1721 * Elaborate message for bad variable *
1722 *************************************************/
1724 /* For the "unknown variable" message, take a look at the variable's name, and
1725 give additional information about possible ACL variables. The extra information
1726 is added on to expand_string_message.
1728 Argument: the name of the variable
1733 check_variable_error_message(uschar *name)
1735 if (Ustrncmp(name, "acl_", 4) == 0)
1736 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1737 (name[4] == 'c' || name[4] == 'm')?
1739 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1740 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1742 US"user-defined ACL variables must start acl_c or acl_m");
1747 /*************************************************
1748 * Read and evaluate a condition *
1749 *************************************************/
1753 s points to the start of the condition text
1754 yield points to a BOOL to hold the result of the condition test;
1755 if NULL, we are just reading through a condition that is
1756 part of an "or" combination to check syntax, or in a state
1757 where the answer isn't required
1759 Returns: a pointer to the first character after the condition, or
1764 eval_condition(uschar *s, BOOL *yield)
1766 BOOL testfor = TRUE;
1767 BOOL tempcond, combined_cond;
1769 int i, rc, cond_type, roffset;
1771 struct stat statbuf;
1776 const uschar *rerror;
1780 while (isspace(*s)) s++;
1781 if (*s == '!') { testfor = !testfor; s++; } else break;
1784 /* Numeric comparisons are symbolic */
1786 if (*s == '=' || *s == '>' || *s == '<')
1798 /* All other conditions are named */
1800 else s = read_name(name, 256, s, US"_");
1802 /* If we haven't read a name, it means some non-alpha character is first. */
1806 expand_string_message = string_sprintf("condition name expected, "
1807 "but found \"%.16s\"", s);
1811 /* Find which condition we are dealing with, and switch on it */
1813 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1816 /* def: tests for a non-empty variable, or for the existence of a header. If
1817 yield == NULL we are in a skipping state, and don't care about the answer. */
1822 expand_string_message = US"\":\" expected after \"def\"";
1826 s = read_name(name, 256, s+1, US"_");
1828 /* Test for a header's existence. If the name contains a closing brace
1829 character, this may be a user error where the terminating colon has been
1830 omitted. Set a flag to adjust a subsequent error message in this case. */
1832 if (Ustrncmp(name, "h_", 2) == 0 ||
1833 Ustrncmp(name, "rh_", 3) == 0 ||
1834 Ustrncmp(name, "bh_", 3) == 0 ||
1835 Ustrncmp(name, "header_", 7) == 0 ||
1836 Ustrncmp(name, "rheader_", 8) == 0 ||
1837 Ustrncmp(name, "bheader_", 8) == 0)
1839 s = read_header_name(name, 256, s);
1840 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1841 if (yield != NULL) *yield =
1842 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1845 /* Test for a variable's having a non-empty value. A non-existent variable
1846 causes an expansion failure. */
1850 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1853 expand_string_message = (name[0] == 0)?
1854 string_sprintf("variable name omitted after \"def:\"") :
1855 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1856 check_variable_error_message(name);
1859 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1865 /* first_delivery tests for first delivery attempt */
1867 case ECOND_FIRST_DELIVERY:
1868 if (yield != NULL) *yield = deliver_firsttime == testfor;
1872 /* queue_running tests for any process started by a queue runner */
1874 case ECOND_QUEUE_RUNNING:
1875 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1879 /* exists: tests for file existence
1880 isip: tests for any IP address
1881 isip4: tests for an IPv4 address
1882 isip6: tests for an IPv6 address
1883 pam: does PAM authentication
1884 radius: does RADIUS authentication
1885 ldapauth: does LDAP authentication
1886 pwcheck: does Cyrus SASL pwcheck authentication
1895 case ECOND_LDAPAUTH:
1898 while (isspace(*s)) s++;
1899 if (*s != '{') goto COND_FAILED_CURLY_START;
1901 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1902 if (sub[0] == NULL) return NULL;
1903 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1905 if (yield == NULL) return s; /* No need to run the test if skipping */
1910 if ((expand_forbid & RDO_EXISTS) != 0)
1912 expand_string_message = US"File existence tests are not permitted";
1915 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1921 rc = string_is_ip_address(sub[0], NULL);
1922 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1923 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1926 /* Various authentication tests - all optionally compiled */
1930 rc = auth_call_pam(sub[0], &expand_string_message);
1933 goto COND_FAILED_NOT_COMPILED;
1934 #endif /* SUPPORT_PAM */
1937 #ifdef RADIUS_CONFIG_FILE
1938 rc = auth_call_radius(sub[0], &expand_string_message);
1941 goto COND_FAILED_NOT_COMPILED;
1942 #endif /* RADIUS_CONFIG_FILE */
1944 case ECOND_LDAPAUTH:
1947 /* Just to keep the interface the same */
1949 int old_pool = store_pool;
1950 store_pool = POOL_SEARCH;
1951 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1952 &expand_string_message, &do_cache);
1953 store_pool = old_pool;
1957 goto COND_FAILED_NOT_COMPILED;
1958 #endif /* LOOKUP_LDAP */
1961 #ifdef CYRUS_PWCHECK_SOCKET
1962 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1965 goto COND_FAILED_NOT_COMPILED;
1966 #endif /* CYRUS_PWCHECK_SOCKET */
1968 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1969 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1971 if (rc == ERROR || rc == DEFER) return NULL;
1972 *yield = (rc == OK) == testfor;
1978 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1980 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1982 However, the last two are optional. That is why the whole set is enclosed
1983 in their own set or braces. */
1985 case ECOND_SASLAUTHD:
1986 #ifndef CYRUS_SASLAUTHD_SOCKET
1987 goto COND_FAILED_NOT_COMPILED;
1989 while (isspace(*s)) s++;
1990 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1991 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1993 case 1: expand_string_message = US"too few arguments or bracketing "
1994 "error for saslauthd";
1996 case 3: return NULL;
1998 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2002 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2003 &expand_string_message);
2004 if (rc == ERROR || rc == DEFER) return NULL;
2005 *yield = (rc == OK) == testfor;
2008 #endif /* CYRUS_SASLAUTHD_SOCKET */
2011 /* symbolic operators for numeric and string comparison, and a number of
2012 other operators, all requiring two arguments.
2014 match: does a regular expression match and sets up the numerical
2015 variables if it succeeds
2016 match_address: matches in an address list
2017 match_domain: matches in a domain list
2018 match_ip: matches a host list that is restricted to IP addresses
2019 match_local_part: matches in a local part list
2020 crypteq: encrypts plaintext and compares against an encrypted text,
2021 using crypt(), crypt16(), MD5 or SHA-1
2025 case ECOND_MATCH_ADDRESS:
2026 case ECOND_MATCH_DOMAIN:
2027 case ECOND_MATCH_IP:
2028 case ECOND_MATCH_LOCAL_PART:
2031 case ECOND_NUM_L: /* Numerical comparisons */
2038 case ECOND_STR_LT: /* String comparisons */
2049 for (i = 0; i < 2; i++)
2051 while (isspace(*s)) s++;
2054 if (i == 0) goto COND_FAILED_CURLY_START;
2055 expand_string_message = string_sprintf("missing 2nd string in {} "
2056 "after \"%s\"", name);
2059 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
2060 if (sub[i] == NULL) return NULL;
2061 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2063 /* Convert to numerical if required; we know that the names of all the
2064 conditions that compare numbers do not start with a letter. This just saves
2065 checking for them individually. */
2067 if (!isalpha(name[0]) && yield != NULL)
2073 debug_printf("empty string cast to zero for numerical comparison\n");
2077 num[i] = expand_string_integer(sub[i], FALSE);
2078 if (expand_string_message != NULL) return NULL;
2083 /* Result not required */
2085 if (yield == NULL) return s;
2087 /* Do an appropriate comparison */
2093 *yield = (num[0] == num[1]) == testfor;
2097 *yield = (num[0] > num[1]) == testfor;
2101 *yield = (num[0] >= num[1]) == testfor;
2105 *yield = (num[0] < num[1]) == testfor;
2109 *yield = (num[0] <= num[1]) == testfor;
2113 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2117 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2121 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2125 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2129 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2133 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2137 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2141 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2145 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2149 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2152 case ECOND_MATCH: /* Regular expression match */
2153 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2157 expand_string_message = string_sprintf("regular expression error in "
2158 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2161 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2164 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2165 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2166 goto MATCHED_SOMETHING;
2168 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2169 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2170 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2171 goto MATCHED_SOMETHING;
2173 case ECOND_MATCH_IP: /* Match IP address in a host list */
2174 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2176 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2182 unsigned int *nullcache = NULL;
2183 check_host_block cb;
2185 cb.host_name = US"";
2186 cb.host_address = sub[0];
2188 /* If the host address starts off ::ffff: it is an IPv6 address in
2189 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2192 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2193 cb.host_address + 7 : cb.host_address;
2195 rc = match_check_list(
2196 &sub[1], /* the list */
2197 0, /* separator character */
2198 &hostlist_anchor, /* anchor pointer */
2199 &nullcache, /* cache pointer */
2200 check_host, /* function for testing */
2201 &cb, /* argument for function */
2202 MCL_HOST, /* type of check */
2203 sub[0], /* text for debugging */
2204 NULL); /* where to pass back data */
2206 goto MATCHED_SOMETHING;
2208 case ECOND_MATCH_LOCAL_PART:
2209 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2210 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2225 expand_string_message = string_sprintf("unable to complete match "
2226 "against \"%s\": %s", sub[1], search_error_message);
2232 /* Various "encrypted" comparisons. If the second string starts with
2233 "{" then an encryption type is given. Default to crypt() or crypt16()
2234 (build-time choice). */
2237 #ifndef SUPPORT_CRYPTEQ
2238 goto COND_FAILED_NOT_COMPILED;
2240 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2242 int sublen = Ustrlen(sub[1]+5);
2247 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2249 /* If the length that we are comparing against is 24, the MD5 digest
2250 is expressed as a base64 string. This is the way LDAP does it. However,
2251 some other software uses a straightforward hex representation. We assume
2252 this if the length is 32. Other lengths fail. */
2256 uschar *coded = auth_b64encode((uschar *)digest, 16);
2257 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2258 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2259 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2261 else if (sublen == 32)
2265 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2267 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2268 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2269 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2273 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2274 "fail\n crypted=%s\n", sub[1]+5);
2279 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2281 int sublen = Ustrlen(sub[1]+6);
2286 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2288 /* If the length that we are comparing against is 28, assume the SHA1
2289 digest is expressed as a base64 string. If the length is 40, assume a
2290 straightforward hex representation. Other lengths fail. */
2294 uschar *coded = auth_b64encode((uschar *)digest, 20);
2295 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2296 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2297 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2299 else if (sublen == 40)
2303 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2305 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2306 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2307 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2311 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2312 "fail\n crypted=%s\n", sub[1]+6);
2317 else /* {crypt} or {crypt16} and non-{ at start */
2322 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2327 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2332 else if (sub[1][0] == '{')
2334 expand_string_message = string_sprintf("unknown encryption mechanism "
2335 "in \"%s\"", sub[1]);
2341 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2342 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2343 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2347 #define XSTR(s) STR(s)
2348 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2349 " subject=%s\n crypted=%s\n",
2350 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2355 /* If the encrypted string contains fewer than two characters (for the
2356 salt), force failure. Otherwise we get false positives: with an empty
2357 string the yield of crypt() is an empty string! */
2359 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2360 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2363 #endif /* SUPPORT_CRYPTEQ */
2364 } /* Switch for comparison conditions */
2366 return s; /* End of comparison conditions */
2369 /* and/or: computes logical and/or of several conditions */
2373 subcondptr = (yield == NULL)? NULL : &tempcond;
2374 combined_cond = (cond_type == ECOND_AND);
2376 while (isspace(*s)) s++;
2377 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2381 while (isspace(*s)) s++;
2382 if (*s == '}') break;
2385 expand_string_message = string_sprintf("each subcondition "
2386 "inside an \"%s{...}\" condition must be in its own {}", name);
2390 s = eval_condition(s+1, subcondptr);
2393 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2394 expand_string_message, name);
2397 while (isspace(*s)) s++;
2401 expand_string_message = string_sprintf("missing } at end of condition "
2402 "inside \"%s\" group", name);
2408 if (cond_type == ECOND_AND)
2410 combined_cond &= tempcond;
2411 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2412 } /* evaluate any more */
2415 combined_cond |= tempcond;
2416 if (combined_cond) subcondptr = NULL; /* once true, don't */
2417 } /* evaluate any more */
2421 if (yield != NULL) *yield = (combined_cond == testfor);
2425 /* forall/forany: iterates a condition with different values */
2431 uschar *save_iterate_item = iterate_item;
2433 while (isspace(*s)) s++;
2434 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2435 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL));
2436 if (sub[0] == NULL) return NULL;
2437 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2439 while (isspace(*s)) s++;
2440 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2444 /* Call eval_condition once, with result discarded (as if scanning a
2445 "false" part). This allows us to find the end of the condition, because if
2446 the list it empty, we won't actually evaluate the condition for real. */
2448 s = eval_condition(sub[1], NULL);
2451 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2452 expand_string_message, name);
2455 while (isspace(*s)) s++;
2459 expand_string_message = string_sprintf("missing } at end of condition "
2460 "inside \"%s\"", name);
2464 if (yield != NULL) *yield = !testfor;
2465 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2467 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2468 if (eval_condition(sub[1], &tempcond) == NULL)
2470 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2471 expand_string_message, name);
2472 iterate_item = save_iterate_item;
2475 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2476 tempcond? "true":"false");
2478 if (yield != NULL) *yield = (tempcond == testfor);
2479 if (tempcond == (cond_type == ECOND_FORANY)) break;
2482 iterate_item = save_iterate_item;
2487 /* The bool{} expansion condition maps a string to boolean.
2488 The values supported should match those supported by the ACL condition
2489 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2490 of true/false. Note that Router "condition" rules have a different
2491 interpretation, where general data can be used and only a few values
2493 Note that readconf.c boolean matching, for boolean configuration options,
2494 only matches true/yes/false/no. */
2500 BOOL boolvalue = FALSE;
2501 while (isspace(*s)) s++;
2502 if (*s != '{') goto COND_FAILED_CURLY_START;
2503 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, US"bool"))
2505 case 1: expand_string_message = US"too few arguments or bracketing "
2509 case 3: return NULL;
2512 while (isspace(*t)) t++;
2515 debug_printf("considering bool: %s\n", len ? t : US"<empty>");
2518 else if (Ustrspn(t, "0123456789") == len)
2519 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2520 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2522 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2526 expand_string_message = string_sprintf("unrecognised boolean "
2530 if (yield != NULL) *yield = (boolvalue != 0);
2534 /* Unknown condition */
2537 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2539 } /* End switch on condition type */
2541 /* Missing braces at start and end of data */
2543 COND_FAILED_CURLY_START:
2544 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2547 COND_FAILED_CURLY_END:
2548 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2552 /* A condition requires code that is not compiled */
2554 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2555 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2556 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2557 COND_FAILED_NOT_COMPILED:
2558 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2567 /*************************************************
2568 * Save numerical variables *
2569 *************************************************/
2571 /* This function is called from items such as "if" that want to preserve and
2572 restore the numbered variables.
2575 save_expand_string points to an array of pointers to set
2576 save_expand_nlength points to an array of ints for the lengths
2578 Returns: the value of expand max to save
2582 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2585 for (i = 0; i <= expand_nmax; i++)
2587 save_expand_nstring[i] = expand_nstring[i];
2588 save_expand_nlength[i] = expand_nlength[i];
2595 /*************************************************
2596 * Restore numerical variables *
2597 *************************************************/
2599 /* This function restored saved values of numerical strings.
2602 save_expand_nmax the number of strings to restore
2603 save_expand_string points to an array of pointers
2604 save_expand_nlength points to an array of ints
2610 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2611 int *save_expand_nlength)
2614 expand_nmax = save_expand_nmax;
2615 for (i = 0; i <= expand_nmax; i++)
2617 expand_nstring[i] = save_expand_nstring[i];
2618 expand_nlength[i] = save_expand_nlength[i];
2626 /*************************************************
2627 * Handle yes/no substrings *
2628 *************************************************/
2630 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2631 alternative substrings that depend on whether or not the condition was true,
2632 or the lookup or extraction succeeded. The substrings always have to be
2633 expanded, to check their syntax, but "skipping" is set when the result is not
2634 needed - this avoids unnecessary nested lookups.
2637 skipping TRUE if we were skipping when this item was reached
2638 yes TRUE if the first string is to be used, else use the second
2639 save_lookup a value to put back into lookup_value before the 2nd expansion
2640 sptr points to the input string pointer
2641 yieldptr points to the output string pointer
2642 sizeptr points to the output string size
2643 ptrptr points to the output string pointer
2644 type "lookup" or "if" or "extract" or "run", for error message
2646 Returns: 0 OK; lookup_value has been reset to save_lookup
2648 2 expansion failed because of bracketing error
2652 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2653 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2656 uschar *s = *sptr; /* Local value */
2657 uschar *sub1, *sub2;
2659 /* If there are no following strings, we substitute the contents of $value for
2660 lookups and for extractions in the success case. For the ${if item, the string
2661 "true" is substituted. In the fail case, nothing is substituted for all three
2664 while (isspace(*s)) s++;
2669 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2673 if (yes && lookup_value != NULL)
2674 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2675 Ustrlen(lookup_value));
2676 lookup_value = save_lookup;
2682 /* The first following string must be braced. */
2684 if (*s++ != '{') goto FAILED_CURLY;
2686 /* Expand the first substring. Forced failures are noticed only if we actually
2687 want this string. Set skipping in the call in the fail case (this will always
2688 be the case if we were already skipping). */
2690 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2691 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2692 expand_string_forcedfail = FALSE;
2693 if (*s++ != '}') goto FAILED_CURLY;
2695 /* If we want the first string, add it to the output */
2698 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2700 /* If this is called from a lookup or an extract, we want to restore $value to
2701 what it was at the start of the item, so that it has this value during the
2702 second string expansion. For the call from "if" or "run" to this function,
2703 save_lookup is set to lookup_value, so that this statement does nothing. */
2705 lookup_value = save_lookup;
2707 /* There now follows either another substring, or "fail", or nothing. This
2708 time, forced failures are noticed only if we want the second string. We must
2709 set skipping in the nested call if we don't want this string, or if we were
2710 already skipping. */
2712 while (isspace(*s)) s++;
2715 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2716 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2717 expand_string_forcedfail = FALSE;
2718 if (*s++ != '}') goto FAILED_CURLY;
2720 /* If we want the second string, add it to the output */
2723 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2726 /* If there is no second string, but the word "fail" is present when the use of
2727 the second string is wanted, set a flag indicating it was a forced failure
2728 rather than a syntactic error. Swallow the terminating } in case this is nested
2729 inside another lookup or if or extract. */
2734 s = read_name(name, sizeof(name), s, US"_");
2735 if (Ustrcmp(name, "fail") == 0)
2737 if (!yes && !skipping)
2739 while (isspace(*s)) s++;
2740 if (*s++ != '}') goto FAILED_CURLY;
2741 expand_string_message =
2742 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2743 expand_string_forcedfail = TRUE;
2749 expand_string_message =
2750 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2755 /* All we have to do now is to check on the final closing brace. */
2757 while (isspace(*s)) s++;
2758 if (*s++ == '}') goto RETURN;
2760 /* Get here if there is a bracketing failure */
2765 /* Get here for other failures */
2770 /* Update the input pointer value before returning */
2780 /*************************************************
2781 * Handle MD5 or SHA-1 computation for HMAC *
2782 *************************************************/
2784 /* These are some wrapping functions that enable the HMAC code to be a bit
2785 cleaner. A good compiler will spot the tail recursion.
2788 type HMAC_MD5 or HMAC_SHA1
2789 remaining are as for the cryptographic hash functions
2795 chash_start(int type, void *base)
2797 if (type == HMAC_MD5)
2798 md5_start((md5 *)base);
2800 sha1_start((sha1 *)base);
2804 chash_mid(int type, void *base, uschar *string)
2806 if (type == HMAC_MD5)
2807 md5_mid((md5 *)base, string);
2809 sha1_mid((sha1 *)base, string);
2813 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2815 if (type == HMAC_MD5)
2816 md5_end((md5 *)base, string, length, digest);
2818 sha1_end((sha1 *)base, string, length, digest);
2825 /********************************************************
2826 * prvs: Get last three digits of days since Jan 1, 1970 *
2827 ********************************************************/
2829 /* This is needed to implement the "prvs" BATV reverse
2832 Argument: integer "days" offset to add or substract to
2833 or from the current number of days.
2835 Returns: pointer to string containing the last three
2836 digits of the number of days since Jan 1, 1970,
2837 modified by the offset argument, NULL if there
2838 was an error in the conversion.
2843 prvs_daystamp(int day_offset)
2845 uschar *days = store_get(32); /* Need at least 24 for cases */
2846 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2847 (time(NULL) + day_offset*86400)/86400);
2848 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2853 /********************************************************
2854 * prvs: perform HMAC-SHA1 computation of prvs bits *
2855 ********************************************************/
2857 /* This is needed to implement the "prvs" BATV reverse
2861 address RFC2821 Address to use
2862 key The key to use (must be less than 64 characters
2864 key_num Single-digit key number to use. Defaults to
2867 Returns: pointer to string containing the first three
2868 bytes of the final hash in hex format, NULL if
2869 there was an error in the process.
2873 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2875 uschar *hash_source, *p;
2876 int size = 0,offset = 0,i;
2878 void *use_base = &sha1_base;
2879 uschar innerhash[20];
2880 uschar finalhash[20];
2881 uschar innerkey[64];
2882 uschar outerkey[64];
2883 uschar *finalhash_hex = store_get(40);
2885 if (key_num == NULL)
2888 if (Ustrlen(key) > 64)
2891 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2892 string_cat(hash_source,&size,&offset,daystamp,3);
2893 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2894 hash_source[offset] = '\0';
2896 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2898 memset(innerkey, 0x36, 64);
2899 memset(outerkey, 0x5c, 64);
2901 for (i = 0; i < Ustrlen(key); i++)
2903 innerkey[i] ^= key[i];
2904 outerkey[i] ^= key[i];
2907 chash_start(HMAC_SHA1, use_base);
2908 chash_mid(HMAC_SHA1, use_base, innerkey);
2909 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2911 chash_start(HMAC_SHA1, use_base);
2912 chash_mid(HMAC_SHA1, use_base, outerkey);
2913 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2916 for (i = 0; i < 3; i++)
2918 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2919 *p++ = hex_digits[finalhash[i] & 0x0f];
2923 return finalhash_hex;
2929 /*************************************************
2930 * Join a file onto the output string *
2931 *************************************************/
2933 /* This is used for readfile and after a run expansion. It joins the contents
2934 of a file onto the output string, globally replacing newlines with a given
2935 string (optionally). The file is closed at the end.
2939 yield pointer to the expandable string
2940 sizep pointer to the current size
2941 ptrp pointer to the current position
2942 eol newline replacement string, or NULL
2944 Returns: new value of string pointer
2948 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2951 uschar buffer[1024];
2953 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2955 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2957 int len = Ustrlen(buffer);
2958 if (eol != NULL && buffer[len-1] == '\n') len--;
2959 yield = string_cat(yield, sizep, ptrp, buffer, len);
2960 if (buffer[len] != 0)
2961 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2964 if (yield != NULL) yield[*ptrp] = 0;
2972 /*************************************************
2973 * Evaluate numeric expression *
2974 *************************************************/
2976 /* This is a set of mutually recursive functions that evaluate an arithmetic
2977 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
2978 these functions that is called from elsewhere is eval_expr, whose interface is:
2981 sptr pointer to the pointer to the string - gets updated
2982 decimal TRUE if numbers are to be assumed decimal
2983 error pointer to where to put an error message - must be NULL on input
2984 endket TRUE if ')' must terminate - FALSE for external call
2986 Returns: on success: the value of the expression, with *error still NULL
2987 on failure: an undefined value, with *error = a message
2990 static int eval_op_or(uschar **, BOOL, uschar **);
2994 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2997 int x = eval_op_or(&s, decimal, error);
3003 *error = US"expecting closing parenthesis";
3005 while (isspace(*(++s)));
3007 else if (*s != 0) *error = US"expecting operator";
3015 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3020 while (isspace(*s)) s++;
3025 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
3027 if (tolower(*s) == 'k') { n *= 1024; s++; }
3028 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
3029 while (isspace (*s)) s++;
3034 n = eval_expr(&s, decimal, error, 1);
3038 *error = US"expecting number or opening parenthesis";
3046 static int eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3050 while (isspace(*s)) s++;
3051 if (*s == '+' || *s == '-' || *s == '~')
3054 x = eval_op_unary(&s, decimal, error);
3055 if (op == '-') x = -x;
3056 else if (op == '~') x = ~x;
3060 x = eval_number(&s, decimal, error);
3067 static int eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3070 int x = eval_op_unary(&s, decimal, error);
3073 while (*s == '*' || *s == '/' || *s == '%')
3076 int y = eval_op_unary(&s, decimal, error);
3077 if (*error != NULL) break;
3078 if (op == '*') x *= y;
3079 else if (op == '/') x /= y;
3088 static int eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3091 int x = eval_op_mult(&s, decimal, error);
3094 while (*s == '+' || *s == '-')
3097 int y = eval_op_mult(&s, decimal, error);
3098 if (*error != NULL) break;
3099 if (op == '+') x += y; else x -= y;
3107 static int eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3110 int x = eval_op_sum(&s, decimal, error);
3113 while ((*s == '<' || *s == '>') && s[1] == s[0])
3118 y = eval_op_sum(&s, decimal, error);
3119 if (*error != NULL) break;
3120 if (op == '<') x <<= y; else x >>= y;
3128 static int eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3131 int x = eval_op_shift(&s, decimal, error);
3138 y = eval_op_shift(&s, decimal, error);
3139 if (*error != NULL) break;
3148 static int eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3151 int x = eval_op_and(&s, decimal, error);
3158 y = eval_op_and(&s, decimal, error);
3159 if (*error != NULL) break;
3168 static int eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3171 int x = eval_op_xor(&s, decimal, error);
3178 y = eval_op_xor(&s, decimal, error);
3179 if (*error != NULL) break;
3189 /*************************************************
3191 *************************************************/
3193 /* Returns either an unchanged string, or the expanded string in stacking pool
3194 store. Interpreted sequences are:
3196 \... normal escaping rules
3197 $name substitutes the variable
3199 ${op:string} operates on the expanded string value
3200 ${item{arg1}{arg2}...} expands the args and then does the business
3201 some literal args are not enclosed in {}
3203 There are now far too many operators and item types to make it worth listing
3204 them here in detail any more.
3206 We use an internal routine recursively to handle embedded substrings. The
3207 external function follows. The yield is NULL if the expansion failed, and there
3208 are two cases: if something collapsed syntactically, or if "fail" was given
3209 as the action on a lookup failure. These can be distinguised by looking at the
3210 variable expand_string_forcedfail, which is TRUE in the latter case.
3212 The skipping flag is set true when expanding a substring that isn't actually
3213 going to be used (after "if" or "lookup") and it prevents lookups from
3214 happening lower down.
3216 Store usage: At start, a store block of the length of the input plus 64
3217 is obtained. This is expanded as necessary by string_cat(), which might have to
3218 get a new block, or might be able to expand the original. At the end of the
3219 function we can release any store above that portion of the yield block that
3220 was actually used. In many cases this will be optimal.
3222 However: if the first item in the expansion is a variable name or header name,
3223 we reset the store before processing it; if the result is in fresh store, we
3224 use that without copying. This is helpful for expanding strings like
3225 $message_headers which can get very long.
3227 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3228 since resetting the store at the end of the expansion will free store that was
3229 allocated by the plugin code as well as the slop after the expanded string. So
3230 we skip any resets if ${dlfunc has been used. This is an unfortunate
3231 consequence of string expansion becoming too powerful.
3234 string the string to be expanded
3235 ket_ends true if expansion is to stop at }
3236 left if not NULL, a pointer to the first character after the
3237 expansion is placed here (typically used with ket_ends)
3238 skipping TRUE for recursive calls when the value isn't actually going
3239 to be used (to allow for optimisation)
3241 Returns: NULL if expansion fails:
3242 expand_string_forcedfail is set TRUE if failure was forced
3243 expand_string_message contains a textual error message
3244 a pointer to the expanded string on success
3248 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3252 int size = Ustrlen(string)+ 64;
3254 uschar *yield = store_get(size);
3256 uschar *save_expand_nstring[EXPAND_MAXN+1];
3257 int save_expand_nlength[EXPAND_MAXN+1];
3258 BOOL resetok = TRUE;
3260 expand_string_forcedfail = FALSE;
3261 expand_string_message = US"";
3268 /* \ escapes the next character, which must exist, or else
3269 the expansion fails. There's a special escape, \N, which causes
3270 copying of the subject verbatim up to the next \N. Otherwise,
3271 the escapes are the standard set. */
3277 expand_string_message = US"\\ at end of string";
3284 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3285 yield = string_cat(yield, &size, &ptr, t, s - t);
3286 if (*s != 0) s += 2;
3292 ch[0] = string_interpret_escape(&s);
3294 yield = string_cat(yield, &size, &ptr, ch, 1);
3300 /* Anything other than $ is just copied verbatim, unless we are
3301 looking for a terminating } character. */
3303 if (ket_ends && *s == '}') break;
3307 yield = string_cat(yield, &size, &ptr, s++, 1);
3311 /* No { after the $ - must be a plain name or a number for string
3312 match variable. There has to be a fudge for variables that are the
3313 names of header fields preceded by "$header_" because header field
3314 names can contain any printing characters except space and colon.
3315 For those that don't like typing this much, "$h_" is a synonym for
3316 "$header_". A non-existent header yields a NULL value; nothing is
3319 if (isalpha((*(++s))))
3324 s = read_name(name, sizeof(name), s, US"_");
3326 /* If this is the first thing to be expanded, release the pre-allocated
3329 if (ptr == 0 && yield != NULL)
3331 if (resetok) store_reset(yield);
3338 if (Ustrncmp(name, "h_", 2) == 0 ||
3339 Ustrncmp(name, "rh_", 3) == 0 ||
3340 Ustrncmp(name, "bh_", 3) == 0 ||
3341 Ustrncmp(name, "header_", 7) == 0 ||
3342 Ustrncmp(name, "rheader_", 8) == 0 ||
3343 Ustrncmp(name, "bheader_", 8) == 0)
3345 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3346 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3347 s = read_header_name(name, sizeof(name), s);
3348 value = find_header(name, FALSE, &newsize, want_raw, charset);
3350 /* If we didn't find the header, and the header contains a closing brace
3351 character, this may be a user error where the terminating colon
3352 has been omitted. Set a flag to adjust the error message in this case.
3353 But there is no error here - nothing gets inserted. */
3357 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3366 value = find_variable(name, FALSE, skipping, &newsize);
3369 expand_string_message =
3370 string_sprintf("unknown variable name \"%s\"", name);
3371 check_variable_error_message(name);
3376 /* If the data is known to be in a new buffer, newsize will be set to the
3377 size of that buffer. If this is the first thing in an expansion string,
3378 yield will be NULL; just point it at the new store instead of copying. Many
3379 expansion strings contain just one reference, so this is a useful
3380 optimization, especially for humungous headers. */
3382 len = Ustrlen(value);
3383 if (yield == NULL && newsize != 0)
3389 else yield = string_cat(yield, &size, &ptr, value, len);
3397 s = read_number(&n, s);
3398 if (n >= 0 && n <= expand_nmax)
3399 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3404 /* Otherwise, if there's no '{' after $ it's an error. */
3408 expand_string_message = US"$ not followed by letter, digit, or {";
3412 /* After { there can be various things, but they all start with
3413 an initial word, except for a number for a string match variable. */
3415 if (isdigit((*(++s))))
3418 s = read_number(&n, s);
3421 expand_string_message = US"} expected after number";
3424 if (n >= 0 && n <= expand_nmax)
3425 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3432 expand_string_message = US"letter or digit expected after ${";
3436 /* Allow "-" in names to cater for substrings with negative
3437 arguments. Since we are checking for known names after { this is
3440 s = read_name(name, sizeof(name), s, US"_-");
3441 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3445 /* Handle conditionals - preserve the values of the numerical expansion
3446 variables in case they get changed by a regular expression match in the
3447 condition. If not, they retain their external settings. At the end
3448 of this "if" section, they get restored to their previous values. */
3454 int save_expand_nmax =
3455 save_expand_strings(save_expand_nstring, save_expand_nlength);
3457 while (isspace(*s)) s++;
3458 next_s = eval_condition(s, skipping? NULL : &cond);
3459 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3462 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3463 cond? "true" : "false");
3467 /* The handling of "yes" and "no" result strings is now in a separate
3468 function that is also used by ${lookup} and ${extract} and ${run}. */
3470 switch(process_yesno(
3471 skipping, /* were previously skipping */
3472 cond, /* success/failure indicator */
3473 lookup_value, /* value to reset for string2 */
3474 &s, /* input pointer */
3475 &yield, /* output pointer */
3476 &size, /* output size */
3477 &ptr, /* output current point */
3478 US"if")) /* condition type */
3480 case 1: goto EXPAND_FAILED; /* when all is well, the */
3481 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3484 /* Restore external setting of expansion variables for continuation
3487 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3488 save_expand_nlength);
3492 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3493 expanding an internal string that isn't actually going to be used. All we
3494 need to do is check the syntax, so don't do a lookup at all. Preserve the
3495 values of the numerical expansion variables in case they get changed by a
3496 partial lookup. If not, they retain their external settings. At the end
3497 of this "lookup" section, they get restored to their previous values. */
3501 int stype, partial, affixlen, starflags;
3502 int expand_setup = 0;
3504 uschar *key, *filename, *affix;
3505 uschar *save_lookup_value = lookup_value;
3506 int save_expand_nmax =
3507 save_expand_strings(save_expand_nstring, save_expand_nlength);
3509 if ((expand_forbid & RDO_LOOKUP) != 0)
3511 expand_string_message = US"lookup expansions are not permitted";
3515 /* Get the key we are to look up for single-key+file style lookups.
3516 Otherwise set the key NULL pro-tem. */
3518 while (isspace(*s)) s++;
3521 key = expand_string_internal(s+1, TRUE, &s, skipping);
3522 if (key == NULL) goto EXPAND_FAILED;
3523 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3524 while (isspace(*s)) s++;
3528 /* Find out the type of database */
3532 expand_string_message = US"missing lookup type";
3536 /* The type is a string that may contain special characters of various
3537 kinds. Allow everything except space or { to appear; the actual content
3538 is checked by search_findtype_partial. */
3540 while (*s != 0 && *s != '{' && !isspace(*s))
3542 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3546 while (isspace(*s)) s++;
3548 /* Now check for the individual search type and any partial or default
3549 options. Only those types that are actually in the binary are valid. */
3551 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3555 expand_string_message = search_error_message;
3559 /* Check that a key was provided for those lookup types that need it,
3560 and was not supplied for those that use the query style. */
3562 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3566 expand_string_message = string_sprintf("missing {key} for single-"
3567 "key \"%s\" lookup", name);
3575 expand_string_message = string_sprintf("a single key was given for "
3576 "lookup type \"%s\", which is not a single-key lookup type", name);
3581 /* Get the next string in brackets and expand it. It is the file name for
3582 single-key+file lookups, and the whole query otherwise. In the case of
3583 queries that also require a file name (e.g. sqlite), the file name comes
3586 if (*s != '{') goto EXPAND_FAILED_CURLY;
3587 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3588 if (filename == NULL) goto EXPAND_FAILED;
3589 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3590 while (isspace(*s)) s++;
3592 /* If this isn't a single-key+file lookup, re-arrange the variables
3593 to be appropriate for the search_ functions. For query-style lookups,
3594 there is just a "key", and no file name. For the special query-style +
3595 file types, the query (i.e. "key") starts with a file name. */
3599 while (isspace(*filename)) filename++;
3602 if (mac_islookup(stype, lookup_querystyle))
3608 if (*filename != '/')
3610 expand_string_message = string_sprintf(
3611 "absolute file name expected for \"%s\" lookup", name);
3614 while (*key != 0 && !isspace(*key)) key++;
3615 if (*key != 0) *key++ = 0;
3619 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3620 the entry was not found. Note that there is no search_close() function.
3621 Files are left open in case of re-use. At suitable places in higher logic,
3622 search_tidyup() is called to tidy all open files. This can save opening
3623 the same file several times. However, files may also get closed when
3624 others are opened, if too many are open at once. The rule is that a
3625 handle should not be used after a second search_open().
3627 Request that a partial search sets up $1 and maybe $2 by passing
3628 expand_setup containing zero. If its value changes, reset expand_nmax,
3629 since new variables will have been set. Note that at the end of this
3630 "lookup" section, the old numeric variables are restored. */
3633 lookup_value = NULL;
3636 void *handle = search_open(filename, stype, 0, NULL, NULL);
3639 expand_string_message = search_error_message;
3642 lookup_value = search_find(handle, filename, key, partial, affix,
3643 affixlen, starflags, &expand_setup);
3644 if (search_find_defer)
3646 expand_string_message =
3647 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3648 search_error_message);
3651 if (expand_setup > 0) expand_nmax = expand_setup;
3654 /* The handling of "yes" and "no" result strings is now in a separate
3655 function that is also used by ${if} and ${extract}. */
3657 switch(process_yesno(
3658 skipping, /* were previously skipping */
3659 lookup_value != NULL, /* success/failure indicator */
3660 save_lookup_value, /* value to reset for string2 */
3661 &s, /* input pointer */
3662 &yield, /* output pointer */
3663 &size, /* output size */
3664 &ptr, /* output current point */
3665 US"lookup")) /* condition type */
3667 case 1: goto EXPAND_FAILED; /* when all is well, the */
3668 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3671 /* Restore external setting of expansion variables for carrying on
3672 at this level, and continue. */
3674 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3675 save_expand_nlength);
3679 /* If Perl support is configured, handle calling embedded perl subroutines,
3680 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3681 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3682 arguments (defined below). */
3684 #define EXIM_PERL_MAX_ARGS 8
3688 expand_string_message = US"\"${perl\" encountered, but this facility "
3689 "is not included in this binary";
3692 #else /* EXIM_PERL */
3694 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3697 if ((expand_forbid & RDO_PERL) != 0)
3699 expand_string_message = US"Perl calls are not permitted";
3703 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3706 case 1: goto EXPAND_FAILED_CURLY;
3708 case 3: goto EXPAND_FAILED;
3711 /* If skipping, we don't actually do anything */
3713 if (skipping) continue;
3715 /* Start the interpreter if necessary */
3717 if (!opt_perl_started)
3720 if (opt_perl_startup == NULL)
3722 expand_string_message = US"A setting of perl_startup is needed when "
3723 "using the Perl interpreter";
3726 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3727 initerror = init_perl(opt_perl_startup);
3728 if (initerror != NULL)
3730 expand_string_message =
3731 string_sprintf("error in perl_startup code: %s\n", initerror);
3734 opt_perl_started = TRUE;
3737 /* Call the function */
3739 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3740 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3741 sub_arg[0], sub_arg + 1);
3743 /* NULL yield indicates failure; if the message pointer has been set to
3744 NULL, the yield was undef, indicating a forced failure. Otherwise the
3745 message will indicate some kind of Perl error. */
3747 if (new_yield == NULL)
3749 if (expand_string_message == NULL)
3751 expand_string_message =
3752 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3753 "failure", sub_arg[0]);
3754 expand_string_forcedfail = TRUE;
3759 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3760 set during a callback from Perl. */
3762 expand_string_forcedfail = FALSE;
3766 #endif /* EXIM_PERL */
3768 /* Transform email address to "prvs" scheme to use
3769 as BATV-signed return path */
3776 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3778 case 1: goto EXPAND_FAILED_CURLY;
3780 case 3: goto EXPAND_FAILED;
3783 /* If skipping, we don't actually do anything */
3784 if (skipping) continue;
3786 /* sub_arg[0] is the address */
3787 domain = Ustrrchr(sub_arg[0],'@');
3788 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3790 expand_string_message = US"prvs first argument must be a qualified email address";
3794 /* Calculate the hash. The second argument must be a single-digit
3795 key number, or unset. */
3797 if (sub_arg[2] != NULL &&
3798 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3800 expand_string_message = US"prvs second argument must be a single digit";
3804 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3807 expand_string_message = US"prvs hmac-sha1 conversion failed";
3811 /* Now separate the domain from the local part */
3814 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3815 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3816 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3817 string_cat(yield,&size,&ptr,p,6);
3818 string_cat(yield,&size,&ptr,US"=",1);
3819 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3820 string_cat(yield,&size,&ptr,US"@",1);
3821 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3826 /* Check a prvs-encoded address for validity */
3828 case EITEM_PRVSCHECK:
3831 int mysize = 0, myptr = 0;
3835 /* TF: Ugliness: We want to expand parameter 1 first, then set
3836 up expansion variables that are used in the expansion of
3837 parameter 2. So we clone the string for the first
3838 expansion, where we only expand parameter 1.
3840 PH: Actually, that isn't necessary. The read_subs() function is
3841 designed to work this way for the ${if and ${lookup expansions. I've
3845 /* Reset expansion variables */
3846 prvscheck_result = NULL;
3847 prvscheck_address = NULL;
3848 prvscheck_keynum = NULL;
3850 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3852 case 1: goto EXPAND_FAILED_CURLY;
3854 case 3: goto EXPAND_FAILED;
3857 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
3860 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3862 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
3863 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
3864 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
3865 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
3866 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3868 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3869 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3870 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3871 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3872 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3874 /* Set up expansion variables */
3875 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3876 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3877 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3878 prvscheck_address[myptr] = '\0';
3879 prvscheck_keynum = string_copy(key_num);
3881 /* Now expand the second argument */
3882 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3884 case 1: goto EXPAND_FAILED_CURLY;
3886 case 3: goto EXPAND_FAILED;
3889 /* Now we have the key and can check the address. */
3891 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3896 expand_string_message = US"hmac-sha1 conversion failed";
3900 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3901 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3903 if (Ustrcmp(p,hash) == 0)
3905 /* Success, valid BATV address. Now check the expiry date. */
3906 uschar *now = prvs_daystamp(0);
3907 unsigned int inow = 0,iexpire = 1;
3909 (void)sscanf(CS now,"%u",&inow);
3910 (void)sscanf(CS daystamp,"%u",&iexpire);
3912 /* When "iexpire" is < 7, a "flip" has occured.
3913 Adjust "inow" accordingly. */
3914 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3916 if (iexpire >= inow)
3918 prvscheck_result = US"1";
3919 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3923 prvscheck_result = NULL;
3924 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3929 prvscheck_result = NULL;
3930 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3933 /* Now expand the final argument. We leave this till now so that
3934 it can include $prvscheck_result. */
3936 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3938 case 1: goto EXPAND_FAILED_CURLY;
3940 case 3: goto EXPAND_FAILED;
3943 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3944 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3946 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3948 /* Reset the "internal" variables afterwards, because they are in
3949 dynamic store that will be reclaimed if the expansion succeeded. */
3951 prvscheck_address = NULL;
3952 prvscheck_keynum = NULL;
3956 /* Does not look like a prvs encoded address, return the empty string.
3957 We need to make sure all subs are expanded first, so as to skip over
3960 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3962 case 1: goto EXPAND_FAILED_CURLY;
3964 case 3: goto EXPAND_FAILED;
3971 /* Handle "readfile" to insert an entire file */
3973 case EITEM_READFILE:
3978 if ((expand_forbid & RDO_READFILE) != 0)
3980 expand_string_message = US"file insertions are not permitted";
3984 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3986 case 1: goto EXPAND_FAILED_CURLY;
3988 case 3: goto EXPAND_FAILED;
3991 /* If skipping, we don't actually do anything */
3993 if (skipping) continue;
3995 /* Open the file and read it */
3997 f = Ufopen(sub_arg[0], "rb");
4000 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4004 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4009 /* Handle "readsocket" to insert data from a Unix domain socket */
4011 case EITEM_READSOCK:
4017 struct sockaddr_un sockun; /* don't call this "sun" ! */
4021 if ((expand_forbid & RDO_READSOCK) != 0)
4023 expand_string_message = US"socket insertions are not permitted";
4027 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4028 because there may be a string for expansion on failure. */
4030 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4032 case 1: goto EXPAND_FAILED_CURLY;
4033 case 2: /* Won't occur: no end check */
4034 case 3: goto EXPAND_FAILED;
4037 /* Sort out timeout, if given */
4039 if (sub_arg[2] != NULL)
4041 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4044 expand_string_message = string_sprintf("bad time value %s",
4049 else sub_arg[3] = NULL; /* No eol if no timeout */
4051 /* If skipping, we don't actually do anything. Otherwise, arrange to
4052 connect to either an IP or a Unix socket. */
4056 /* Handle an IP (internet) domain */
4058 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4060 BOOL connected = FALSE;
4064 uschar *server_name = sub_arg[0] + 5;
4065 uschar *port_name = Ustrrchr(server_name, ':');
4067 /* Sort out the port */
4069 if (port_name == NULL)
4071 expand_string_message =
4072 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4075 *port_name++ = 0; /* Terminate server name */
4077 if (isdigit(*port_name))
4080 port = Ustrtol(port_name, &end, 0);
4081 if (end != port_name + Ustrlen(port_name))
4083 expand_string_message =
4084 string_sprintf("invalid port number %s", port_name);
4090 struct servent *service_info = getservbyname(CS port_name, "tcp");
4091 if (service_info == NULL)
4093 expand_string_message = string_sprintf("unknown port \"%s\"",
4097 port = ntohs(service_info->s_port);
4100 /* Sort out the server. */
4103 shost.address = NULL;
4107 namelen = Ustrlen(server_name);
4109 /* Anything enclosed in [] must be an IP address. */
4111 if (server_name[0] == '[' &&
4112 server_name[namelen - 1] == ']')
4114 server_name[namelen - 1] = 0;
4116 if (string_is_ip_address(server_name, NULL) == 0)
4118 expand_string_message =
4119 string_sprintf("malformed IP address \"%s\"", server_name);
4122 shost.name = shost.address = server_name;
4125 /* Otherwise check for an unadorned IP address */
4127 else if (string_is_ip_address(server_name, NULL) != 0)
4128 shost.name = shost.address = server_name;
4130 /* Otherwise lookup IP address(es) from the name */
4134 shost.name = server_name;
4135 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4136 FALSE) != HOST_FOUND)
4138 expand_string_message =
4139 string_sprintf("no IP address found for host %s", shost.name);
4144 /* Try to connect to the server - test each IP till one works */
4146 for (h = &shost; h != NULL; h = h->next)
4148 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4149 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4151 expand_string_message = string_sprintf("failed to create socket: "
4152 "%s", strerror(errno));
4156 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4165 expand_string_message = string_sprintf("failed to connect to "
4166 "socket %s: couldn't connect to any host", sub_arg[0],
4172 /* Handle a Unix domain socket */
4177 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4179 expand_string_message = string_sprintf("failed to create socket: %s",
4184 sockun.sun_family = AF_UNIX;
4185 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4188 sigalrm_seen = FALSE;
4190 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4194 expand_string_message = US "socket connect timed out";
4199 expand_string_message = string_sprintf("failed to connect to socket "
4200 "%s: %s", sub_arg[0], strerror(errno));
4205 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4207 /* Write the request string, if not empty */
4209 if (sub_arg[1][0] != 0)
4211 int len = Ustrlen(sub_arg[1]);
4212 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4214 if (write(fd, sub_arg[1], len) != len)
4216 expand_string_message = string_sprintf("request write to socket "
4217 "failed: %s", strerror(errno));
4222 /* Shut down the sending side of the socket. This helps some servers to
4223 recognise that it is their turn to do some work. Just in case some
4224 system doesn't have this function, make it conditional. */
4227 shutdown(fd, SHUT_WR);
4230 /* Now we need to read from the socket, under a timeout. The function
4231 that reads a file can be used. */
4233 f = fdopen(fd, "rb");
4234 sigalrm_seen = FALSE;
4236 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4240 /* After a timeout, we restore the pointer in the result, that is,
4241 make sure we add nothing from the socket. */
4246 expand_string_message = US "socket read timed out";
4251 /* The whole thing has worked (or we were skipping). If there is a
4252 failure string following, we need to skip it. */
4256 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
4258 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4259 while (isspace(*s)) s++;
4261 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4264 /* Come here on failure to create socket, connect socket, write to the
4265 socket, or timeout on reading. If another substring follows, expand and
4266 use it. Otherwise, those conditions give expand errors. */
4269 if (*s != '{') goto EXPAND_FAILED;
4270 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4271 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
4272 if (arg == NULL) goto EXPAND_FAILED;
4273 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4274 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4275 while (isspace(*s)) s++;
4276 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4280 /* Handle "run" to execute a program. */
4292 if ((expand_forbid & RDO_RUN) != 0)
4294 expand_string_message = US"running a command is not permitted";
4298 while (isspace(*s)) s++;
4299 if (*s != '{') goto EXPAND_FAILED_CURLY;
4300 arg = expand_string_internal(s+1, TRUE, &s, skipping);
4301 if (arg == NULL) goto EXPAND_FAILED;
4302 while (isspace(*s)) s++;
4303 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4305 if (skipping) /* Just pretend it worked when we're skipping */
4311 if (!transport_set_up_command(&argv, /* anchor for arg list */
4312 arg, /* raw command */
4313 FALSE, /* don't expand the arguments */
4314 0, /* not relevant when... */
4315 NULL, /* no transporting address */
4316 US"${run} expansion", /* for error messages */
4317 &expand_string_message)) /* where to put error message */
4322 /* Create the child process, making it a group leader. */
4324 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4328 expand_string_message =
4329 string_sprintf("couldn't create child process: %s", strerror(errno));
4333 /* Nothing is written to the standard input. */
4337 /* Wait for the process to finish, applying the timeout, and inspect its
4338 return code for serious disasters. Simple non-zero returns are passed on.
4341 if ((runrc = child_close(pid, 60)) < 0)
4345 expand_string_message = string_sprintf("command timed out");
4346 killpg(pid, SIGKILL); /* Kill the whole process group */
4349 else if (runrc == -257)
4350 expand_string_message = string_sprintf("wait() failed: %s",
4354 expand_string_message = string_sprintf("command killed by signal %d",
4360 /* Read the pipe to get the command's output into $value (which is kept
4361 in lookup_value). */
4363 f = fdopen(fd_out, "rb");
4364 lookup_value = NULL;
4365 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4369 /* Process the yes/no strings; $value may be useful in both cases */
4371 switch(process_yesno(
4372 skipping, /* were previously skipping */
4373 runrc == 0, /* success/failure indicator */
4374 lookup_value, /* value to reset for string2 */
4375 &s, /* input pointer */
4376 &yield, /* output pointer */
4377 &size, /* output size */
4378 &ptr, /* output current point */
4379 US"run")) /* condition type */
4381 case 1: goto EXPAND_FAILED; /* when all is well, the */
4382 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4388 /* Handle character translation for "tr" */
4396 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4398 case 1: goto EXPAND_FAILED_CURLY;
4400 case 3: goto EXPAND_FAILED;
4403 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4404 o2m = Ustrlen(sub[2]) - 1;
4406 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4408 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4412 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4419 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4420 expanded arguments. */
4430 int val[2] = { 0, -1 };
4433 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4434 Ensure that sub[2] is set in the ${length case. */
4437 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4440 case 1: goto EXPAND_FAILED_CURLY;
4442 case 3: goto EXPAND_FAILED;
4445 /* Juggle the arguments if there are only two of them: always move the
4446 string to the last position and make ${length{n}{str}} equivalent to
4447 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4453 if (item_type == EITEM_LENGTH)
4460 for (i = 0; i < 2; i++)
4462 if (sub[i] == NULL) continue;
4463 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4464 if (*ret != 0 || (i != 0 && val[i] < 0))
4466 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4467 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4473 (item_type == EITEM_HASH)?
4474 compute_hash(sub[2], val[0], val[1], &len) :
4475 (item_type == EITEM_NHASH)?
4476 compute_nhash(sub[2], val[0], val[1], &len) :
4477 extract_substr(sub[2], val[0], val[1], &len);
4479 if (ret == NULL) goto EXPAND_FAILED;
4480 yield = string_cat(yield, &size, &ptr, ret, len);
4484 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4485 This code originally contributed by Steve Haslam. It currently supports
4486 the use of MD5 and SHA-1 hashes.
4488 We need some workspace that is large enough to handle all the supported
4489 hash types. Use macros to set the sizes rather than be too elaborate. */
4491 #define MAX_HASHLEN 20
4492 #define MAX_HASHBLOCKLEN 64
4501 int hashlen; /* Number of octets for the hash algorithm's output */
4502 int hashblocklen; /* Number of octets the hash algorithm processes */
4504 unsigned int keylen;
4506 uschar keyhash[MAX_HASHLEN];
4507 uschar innerhash[MAX_HASHLEN];
4508 uschar finalhash[MAX_HASHLEN];
4509 uschar finalhash_hex[2*MAX_HASHLEN];
4510 uschar innerkey[MAX_HASHBLOCKLEN];
4511 uschar outerkey[MAX_HASHBLOCKLEN];
4513 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4515 case 1: goto EXPAND_FAILED_CURLY;
4517 case 3: goto EXPAND_FAILED;
4520 if (Ustrcmp(sub[0], "md5") == 0)
4523 use_base = &md5_base;
4527 else if (Ustrcmp(sub[0], "sha1") == 0)
4530 use_base = &sha1_base;
4536 expand_string_message =
4537 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4542 keylen = Ustrlen(keyptr);
4544 /* If the key is longer than the hash block length, then hash the key
4547 if (keylen > hashblocklen)
4549 chash_start(type, use_base);
4550 chash_end(type, use_base, keyptr, keylen, keyhash);
4555 /* Now make the inner and outer key values */
4557 memset(innerkey, 0x36, hashblocklen);
4558 memset(outerkey, 0x5c, hashblocklen);
4560 for (i = 0; i < keylen; i++)
4562 innerkey[i] ^= keyptr[i];
4563 outerkey[i] ^= keyptr[i];
4566 /* Now do the hashes */
4568 chash_start(type, use_base);
4569 chash_mid(type, use_base, innerkey);
4570 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4572 chash_start(type, use_base);
4573 chash_mid(type, use_base, outerkey);
4574 chash_end(type, use_base, innerhash, hashlen, finalhash);
4576 /* Encode the final hash as a hex string */
4579 for (i = 0; i < hashlen; i++)
4581 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4582 *p++ = hex_digits[finalhash[i] & 0x0f];
4585 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4586 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4588 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4593 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4594 We have to save the numerical variables and restore them afterwards. */
4599 int moffset, moffsetextra, slen;
4602 const uschar *rerror;
4605 int save_expand_nmax =
4606 save_expand_strings(save_expand_nstring, save_expand_nlength);
4608 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4610 case 1: goto EXPAND_FAILED_CURLY;
4612 case 3: goto EXPAND_FAILED;
4615 /* Compile the regular expression */
4617 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4622 expand_string_message = string_sprintf("regular expression error in "
4623 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4627 /* Now run a loop to do the substitutions as often as necessary. It ends
4628 when there are no more matches. Take care over matches of the null string;
4629 do the same thing as Perl does. */
4632 slen = Ustrlen(sub[0]);
4633 moffset = moffsetextra = 0;
4638 int ovector[3*(EXPAND_MAXN+1)];
4639 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4640 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4644 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4645 is not necessarily the end. We want to repeat the match from one
4646 character further along, but leaving the basic offset the same (for
4647 copying below). We can't be at the end of the string - that was checked
4648 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4649 finished; copy the remaining string and end the loop. */
4659 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4663 /* Match - set up for expanding the replacement. */
4665 if (n == 0) n = EXPAND_MAXN + 1;
4667 for (nn = 0; nn < n*2; nn += 2)
4669 expand_nstring[expand_nmax] = subject + ovector[nn];
4670 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4674 /* Copy the characters before the match, plus the expanded insertion. */
4676 yield = string_cat(yield, &size, &ptr, subject + moffset,
4677 ovector[0] - moffset);
4678 insert = expand_string(sub[2]);
4679 if (insert == NULL) goto EXPAND_FAILED;
4680 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4682 moffset = ovector[1];
4686 /* If we have matched an empty string, first check to see if we are at
4687 the end of the subject. If so, the loop is over. Otherwise, mimic
4688 what Perl's /g options does. This turns out to be rather cunning. First
4689 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4690 string at the same point. If this fails (picked up above) we advance to
4691 the next character. */
4693 if (ovector[0] == ovector[1])
4695 if (ovector[0] == slen) break;
4696 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4700 /* All done - restore numerical variables. */
4702 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4703 save_expand_nlength);
4707 /* Handle keyed and numbered substring extraction. If the first argument
4708 consists entirely of digits, then a numerical extraction is assumed. */
4714 int field_number = 1;
4715 BOOL field_number_set = FALSE;
4716 uschar *save_lookup_value = lookup_value;
4718 int save_expand_nmax =
4719 save_expand_strings(save_expand_nstring, save_expand_nlength);
4721 /* Read the arguments */
4723 for (i = 0; i < j; i++)
4725 while (isspace(*s)) s++;
4728 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4729 if (sub[i] == NULL) goto EXPAND_FAILED;
4730 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4732 /* After removal of leading and trailing white space, the first
4733 argument must not be empty; if it consists entirely of digits
4734 (optionally preceded by a minus sign), this is a numerical
4735 extraction, and we expect 3 arguments. */
4743 while (isspace(*p)) p++;
4747 while (len > 0 && isspace(p[len-1])) len--;
4750 if (*p == 0 && !skipping)
4752 expand_string_message = US"first argument of \"extract\" must "
4762 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4766 j = 3; /* Need 3 args */
4767 field_number_set = TRUE;
4771 else goto EXPAND_FAILED_CURLY;
4774 /* Extract either the numbered or the keyed substring into $value. If
4775 skipping, just pretend the extraction failed. */
4777 lookup_value = skipping? NULL : field_number_set?
4778 expand_gettokened(field_number, sub[1], sub[2]) :
4779 expand_getkeyed(sub[0], sub[1]);
4781 /* If no string follows, $value gets substituted; otherwise there can
4782 be yes/no strings, as for lookup or if. */
4784 switch(process_yesno(
4785 skipping, /* were previously skipping */
4786 lookup_value != NULL, /* success/failure indicator */
4787 save_lookup_value, /* value to reset for string2 */
4788 &s, /* input pointer */
4789 &yield, /* output pointer */
4790 &size, /* output size */
4791 &ptr, /* output current point */
4792 US"extract")) /* condition type */
4794 case 1: goto EXPAND_FAILED; /* when all is well, the */
4795 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4798 /* All done - restore numerical variables. */
4800 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4801 save_expand_nlength);
4807 /* Handle list operations */
4815 uschar outsep[2] = { '\0', '\0' };
4816 uschar *list, *expr, *temp;
4817 uschar *save_iterate_item = iterate_item;
4818 uschar *save_lookup_value = lookup_value;
4820 while (isspace(*s)) s++;
4821 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4823 list = expand_string_internal(s, TRUE, &s, skipping);
4824 if (list == NULL) goto EXPAND_FAILED;
4825 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4827 if (item_type == EITEM_REDUCE)
4829 while (isspace(*s)) s++;
4830 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4831 temp = expand_string_internal(s, TRUE, &s, skipping);
4832 if (temp == NULL) goto EXPAND_FAILED;
4833 lookup_value = temp;
4834 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4837 while (isspace(*s)) s++;
4838 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4842 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
4843 if scanning a "false" part). This allows us to find the end of the
4844 condition, because if the list is empty, we won't actually evaluate the
4845 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
4846 the normal internal expansion function. */
4848 if (item_type == EITEM_FILTER)
4850 temp = eval_condition(expr, NULL);
4851 if (temp != NULL) s = temp;
4855 temp = expand_string_internal(s, TRUE, &s, TRUE);
4860 expand_string_message = string_sprintf("%s inside \"%s\" item",
4861 expand_string_message, name);
4865 while (isspace(*s)) s++;
4868 expand_string_message = string_sprintf("missing } at end of condition "
4869 "or expression inside \"%s\"", name);
4873 while (isspace(*s)) s++;
4876 expand_string_message = string_sprintf("missing } at end of \"%s\"",
4881 /* If we are skipping, we can now just move on to the next item. When
4882 processing for real, we perform the iteration. */
4884 if (skipping) continue;
4885 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
4887 *outsep = (uschar)sep; /* Separator as a string */
4889 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
4891 if (item_type == EITEM_FILTER)
4894 if (eval_condition(expr, &condresult) == NULL)
4896 iterate_item = save_iterate_item;
4897 lookup_value = save_lookup_value;
4898 expand_string_message = string_sprintf("%s inside \"%s\" condition",
4899 expand_string_message, name);
4902 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
4903 condresult? "true":"false");
4905 temp = iterate_item; /* TRUE => include this item */
4907 continue; /* FALSE => skip this item */
4910 /* EITEM_MAP and EITEM_REDUCE */
4914 temp = expand_string_internal(expr, TRUE, NULL, skipping);
4917 iterate_item = save_iterate_item;
4918 expand_string_message = string_sprintf("%s inside \"%s\" item",
4919 expand_string_message, name);
4922 if (item_type == EITEM_REDUCE)
4924 lookup_value = temp; /* Update the value of $value */
4925 continue; /* and continue the iteration */
4929 /* We reach here for FILTER if the condition is true, always for MAP,
4930 and never for REDUCE. The value in "temp" is to be added to the output
4931 list that is being created, ensuring that any occurrences of the
4932 separator character are doubled. Unless we are dealing with the first
4933 item of the output list, add in a space if the new item begins with the
4934 separator character, or is an empty string. */
4936 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
4937 yield = string_cat(yield, &size, &ptr, US" ", 1);
4939 /* Add the string in "temp" to the output list that we are building,
4940 This is done in chunks by searching for the separator character. */
4944 size_t seglen = Ustrcspn(temp, outsep);
4945 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
4947 /* If we got to the end of the string we output one character
4948 too many; backup and end the loop. Otherwise arrange to double the
4951 if (temp[seglen] == '\0') { ptr--; break; }
4952 yield = string_cat(yield, &size, &ptr, outsep, 1);
4956 /* Output a separator after the string: we will remove the redundant
4957 final one at the end. */
4959 yield = string_cat(yield, &size, &ptr, outsep, 1);
4960 } /* End of iteration over the list loop */
4962 /* REDUCE has generated no output above: output the final value of
4965 if (item_type == EITEM_REDUCE)
4967 yield = string_cat(yield, &size, &ptr, lookup_value,
4968 Ustrlen(lookup_value));
4969 lookup_value = save_lookup_value; /* Restore $value */
4972 /* FILTER and MAP generate lists: if they have generated anything, remove
4973 the redundant final separator. Even though an empty item at the end of a
4974 list does not count, this is tidier. */
4976 else if (ptr != save_ptr) ptr--;
4978 /* Restore preserved $item */
4980 iterate_item = save_iterate_item;
4985 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4986 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4987 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4988 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4990 #define EXPAND_DLFUNC_MAX_ARGS 8
4993 #ifndef EXPAND_DLFUNC
4994 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4995 "is not included in this binary";
4998 #else /* EXPAND_DLFUNC */
5001 exim_dlfunc_t *func;
5004 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5006 if ((expand_forbid & RDO_DLFUNC) != 0)
5008 expand_string_message =
5009 US"dynamically-loaded functions are not permitted";
5013 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5016 case 1: goto EXPAND_FAILED_CURLY;
5018 case 3: goto EXPAND_FAILED;
5021 /* If skipping, we don't actually do anything */
5023 if (skipping) continue;
5025 /* Look up the dynamically loaded object handle in the tree. If it isn't
5026 found, dlopen() the file and put the handle in the tree for next time. */
5028 t = tree_search(dlobj_anchor, argv[0]);
5031 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5034 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5035 argv[0], dlerror());
5036 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5039 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5040 Ustrcpy(t->name, argv[0]);
5041 t->data.ptr = handle;
5042 (void)tree_insertnode(&dlobj_anchor, t);
5045 /* Having obtained the dynamically loaded object handle, look up the
5046 function pointer. */
5048 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5051 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5052 "%s", argv[1], argv[0], dlerror());
5053 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5057 /* Call the function and work out what to do with the result. If it
5058 returns OK, we have a replacement string; if it returns DEFER then
5059 expansion has failed in a non-forced manner; if it returns FAIL then
5060 failure was forced; if it returns ERROR or any other value there's a
5061 problem, so panic slightly. In any case, assume that the function has
5062 side-effects on the store that must be preserved. */
5066 for (argc = 0; argv[argc] != NULL; argc++);
5067 status = func(&result, argc - 2, &argv[2]);
5070 if (result == NULL) result = US"";
5071 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5076 expand_string_message = result == NULL ? US"(no message)" : result;
5077 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5078 else if(status != FAIL)
5079 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5080 argv[0], argv[1], status, expand_string_message);
5084 #endif /* EXPAND_DLFUNC */
5087 /* Control reaches here if the name is not recognized as one of the more
5088 complicated expansion items. Check for the "operator" syntax (name terminated
5089 by a colon). Some of the operators have arguments, separated by _ from the
5096 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
5097 if (sub == NULL) goto EXPAND_FAILED;
5100 /* Owing to an historical mis-design, an underscore may be part of the
5101 operator name, or it may introduce arguments. We therefore first scan the
5102 table of names that contain underscores. If there is no match, we cut off
5103 the arguments and then scan the main table. */
5105 c = chop_match(name, op_table_underscore,
5106 sizeof(op_table_underscore)/sizeof(uschar *));
5110 arg = Ustrchr(name, '_');
5111 if (arg != NULL) *arg = 0;
5112 c = chop_match(name, op_table_main,
5113 sizeof(op_table_main)/sizeof(uschar *));
5114 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5115 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5118 /* If we are skipping, we don't need to perform the operation at all.
5119 This matters for operations like "mask", because the data may not be
5120 in the correct format when skipping. For example, the expression may test
5121 for the existence of $sender_host_address before trying to mask it. For
5122 other operations, doing them may not fail, but it is a waste of time. */
5124 if (skipping && c >= 0) continue;
5126 /* Otherwise, switch on the operator type */
5133 unsigned long int n = Ustrtoul(sub, &t, 10);
5136 expand_string_message = string_sprintf("argument for base62 "
5137 "operator is \"%s\", which is not a decimal number", sub);
5140 t = string_base62(n);
5141 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5145 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5151 unsigned long int n = 0;
5154 uschar *t = Ustrchr(base62_chars, *tt++);
5157 expand_string_message = string_sprintf("argument for base62d "
5158 "operator is \"%s\", which is not a base %d number", sub,
5162 n = n * BASE_62 + (t - base62_chars);
5164 (void)sprintf(CS buf, "%ld", n);
5165 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5171 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
5172 if (expanded == NULL)
5174 expand_string_message =
5175 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5176 expand_string_message);
5179 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5186 uschar *t = sub - 1;
5187 while (*(++t) != 0) { *t = tolower(*t); count++; }
5188 yield = string_cat(yield, &size, &ptr, sub, count);
5195 uschar *t = sub - 1;
5196 while (*(++t) != 0) { *t = toupper(*t); count++; }
5197 yield = string_cat(yield, &size, &ptr, sub, count);
5208 md5_end(&base, sub, Ustrlen(sub), digest);
5209 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5210 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5221 sha1_end(&base, sub, Ustrlen(sub), digest);
5222 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5223 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5227 /* Convert hex encoding to base64 encoding */
5237 for (enc = sub; *enc != 0; enc++)
5239 if (!isxdigit(*enc))
5241 expand_string_message = string_sprintf("\"%s\" is not a hex "
5250 expand_string_message = string_sprintf("\"%s\" contains an odd "
5251 "number of characters", sub);
5255 while ((c = *in++) != 0)
5257 if (isdigit(c)) c -= '0';
5258 else c = toupper(c) - 'A' + 10;
5270 enc = auth_b64encode(sub, out - sub);
5271 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5275 /* mask applies a mask to an IP address; for example the result of
5276 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5283 int mask, maskoffset;
5284 int type = string_is_ip_address(sub, &maskoffset);
5289 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5294 if (maskoffset == 0)
5296 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5301 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5303 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5305 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5310 /* Convert the address to binary integer(s) and apply the mask */
5312 sub[maskoffset] = 0;
5313 count = host_aton(sub, binary);
5314 host_mask(count, binary, mask);
5316 /* Convert to masked textual format and add to output. */
5318 yield = string_cat(yield, &size, &ptr, buffer,
5319 host_nmtoa(count, binary, mask, buffer, '.'));
5324 case EOP_LOCAL_PART:
5328 int start, end, domain;
5329 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5333 if (c != EOP_DOMAIN)
5335 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5336 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5338 else if (domain != 0)
5341 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5349 uschar outsep[2] = { ':', '\0' };
5350 uschar *address, *error;
5352 int start, end, domain; /* Not really used */
5354 while (isspace(*sub)) sub++;
5355 if (*sub == '>') { *outsep = *++sub; ++sub; }
5356 parse_allow_group = TRUE;
5360 uschar *p = parse_find_address_end(sub, FALSE);
5361 uschar saveend = *p;
5363 address = parse_extract_address(sub, &error, &start, &end, &domain,
5367 /* Add the address to the output list that we are building. This is
5368 done in chunks by searching for the separator character. At the
5369 start, unless we are dealing with the first address of the output
5370 list, add in a space if the new address begins with the separator
5371 character, or is an empty string. */
5373 if (address != NULL)
5375 if (ptr != save_ptr && address[0] == *outsep)
5376 yield = string_cat(yield, &size, &ptr, US" ", 1);
5380 size_t seglen = Ustrcspn(address, outsep);
5381 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5383 /* If we got to the end of the string we output one character
5386 if (address[seglen] == '\0') { ptr--; break; }
5387 yield = string_cat(yield, &size, &ptr, outsep, 1);
5388 address += seglen + 1;
5391 /* Output a separator after the string: we will remove the
5392 redundant final one at the end. */
5394 yield = string_cat(yield, &size, &ptr, outsep, 1);
5397 if (saveend == '\0') break;
5401 /* If we have generated anything, remove the redundant final
5404 if (ptr != save_ptr) ptr--;
5405 parse_allow_group = FALSE;
5410 /* quote puts a string in quotes if it is empty or contains anything
5411 other than alphamerics, underscore, dot, or hyphen.
5413 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5414 be quoted in order to be a valid local part.
5416 In both cases, newlines and carriage returns are converted into \n and \r
5420 case EOP_QUOTE_LOCAL_PART:
5423 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5424 uschar *t = sub - 1;
5428 while (!needs_quote && *(++t) != 0)
5429 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5431 else /* EOP_QUOTE_LOCAL_PART */
5433 while (!needs_quote && *(++t) != 0)
5434 needs_quote = !isalnum(*t) &&
5435 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5436 (*t != '.' || t == sub || t[1] == 0);
5441 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5446 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5447 else if (*t == '\r')
5448 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5451 if (*t == '\\' || *t == '"')
5452 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5453 yield = string_cat(yield, &size, &ptr, t, 1);
5456 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5458 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5462 /* quote_lookuptype does lookup-specific quoting */
5467 uschar *opt = Ustrchr(arg, '_');
5469 if (opt != NULL) *opt++ = 0;
5471 n = search_findtype(arg, Ustrlen(arg));
5474 expand_string_message = search_error_message;
5478 if (lookup_list[n].quote != NULL)
5479 sub = (lookup_list[n].quote)(sub, opt);
5480 else if (opt != NULL) sub = NULL;
5484 expand_string_message = string_sprintf(
5485 "\"%s\" unrecognized after \"${quote_%s\"",
5490 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5494 /* rx quote sticks in \ before any non-alphameric character so that
5495 the insertion works in a regular expression. */
5499 uschar *t = sub - 1;
5503 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5504 yield = string_cat(yield, &size, &ptr, t, 1);
5509 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5510 prescribed by the RFC, if there are characters that need to be encoded */
5514 uschar buffer[2048];
5515 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5516 buffer, sizeof(buffer), FALSE);
5517 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5521 /* RFC 2047 decode */
5527 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5528 headers_charset, '?', &len, &error);
5531 expand_string_message = error;
5534 yield = string_cat(yield, &size, &ptr, decoded, len);
5538 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5548 if (c > 255) c = '_';
5550 yield = string_cat(yield, &size, &ptr, buff, 1);
5555 /* escape turns all non-printing characters into escape sequences. */
5559 uschar *t = string_printing(sub);
5560 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5564 /* Handle numeric expression evaluation */
5569 uschar *save_sub = sub;
5570 uschar *error = NULL;
5571 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5574 expand_string_message = string_sprintf("error in expression "
5575 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5579 sprintf(CS var_buffer, "%d", n);
5580 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5584 /* Handle time period formating */
5588 int n = readconf_readtime(sub, 0, FALSE);
5591 expand_string_message = string_sprintf("string \"%s\" is not an "
5592 "Exim time interval in \"%s\" operator", sub, name);
5595 sprintf(CS var_buffer, "%d", n);
5596 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5600 case EOP_TIME_INTERVAL:
5603 uschar *t = read_number(&n, sub);
5604 if (*t != 0) /* Not A Number*/
5606 expand_string_message = string_sprintf("string \"%s\" is not a "
5607 "positive number in \"%s\" operator", sub, name);
5610 t = readconf_printtime(n);
5611 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5615 /* Convert string to base64 encoding */
5619 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5620 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5624 /* strlen returns the length of the string */
5629 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5630 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5634 /* length_n or l_n takes just the first n characters or the whole string,
5635 whichever is the shorter;
5637 substr_m_n, and s_m_n take n characters from offset m; negative m take
5638 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5639 takes the rest, either to the right or to the left.
5641 hash_n or h_n makes a hash of length n from the string, yielding n
5642 characters from the set a-z; hash_n_m makes a hash of length n, but
5643 uses m characters from the set a-zA-Z0-9.
5645 nhash_n returns a single number between 0 and n-1 (in text form), while
5646 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5647 between 0 and n-1 and the second between 0 and m-1. */
5667 expand_string_message = string_sprintf("missing values after %s",
5672 /* "length" has only one argument, effectively being synonymous with
5675 if (c == EOP_LENGTH || c == EOP_L)
5681 /* The others have one or two arguments; for "substr" the first may be
5682 negative. The second being negative means "not supplied". */
5687 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5690 /* Read up to two numbers, separated by underscores */
5695 if (arg != ret && *arg == '_' && pn == &value1)
5699 if (arg[1] != 0) arg++;
5701 else if (!isdigit(*arg))
5703 expand_string_message =
5704 string_sprintf("non-digit after underscore in \"%s\"", name);
5707 else *pn = (*pn)*10 + *arg++ - '0';
5711 /* Perform the required operation */
5714 (c == EOP_HASH || c == EOP_H)?
5715 compute_hash(sub, value1, value2, &len) :
5716 (c == EOP_NHASH || c == EOP_NH)?
5717 compute_nhash(sub, value1, value2, &len) :
5718 extract_substr(sub, value1, value2, &len);
5720 if (ret == NULL) goto EXPAND_FAILED;
5721 yield = string_cat(yield, &size, &ptr, ret, len);
5731 uschar **modetable[3];
5736 if ((expand_forbid & RDO_EXISTS) != 0)
5738 expand_string_message = US"Use of the stat() expansion is not permitted";
5742 if (stat(CS sub, &st) < 0)
5744 expand_string_message = string_sprintf("stat(%s) failed: %s",
5745 sub, strerror(errno));
5749 switch (mode & S_IFMT)
5751 case S_IFIFO: smode[0] = 'p'; break;
5752 case S_IFCHR: smode[0] = 'c'; break;
5753 case S_IFDIR: smode[0] = 'd'; break;
5754 case S_IFBLK: smode[0] = 'b'; break;
5755 case S_IFREG: smode[0] = '-'; break;
5756 default: smode[0] = '?'; break;
5759 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5760 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5761 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5763 for (i = 0; i < 3; i++)
5765 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5770 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5771 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5772 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5773 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5774 (long)st.st_gid, st.st_size, (long)st.st_atime,
5775 (long)st.st_mtime, (long)st.st_ctime);
5776 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5780 /* pseudo-random number less than N */
5787 max = expand_string_integer(sub, TRUE);
5788 if (expand_string_message != NULL)
5790 s = string_sprintf("%d", pseudo_random_number(max));
5791 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5795 /* Reverse IP, including IPv6 to dotted-nibble */
5797 case EOP_REVERSE_IP:
5799 int family, maskptr;
5800 uschar reversed[128];
5802 family = string_is_ip_address(sub, &maskptr);
5805 expand_string_message = string_sprintf(
5806 "reverse_ip() not given an IP address [%s]", sub);
5809 invert_address(reversed, sub);
5810 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
5814 /* Unknown operator */
5817 expand_string_message =
5818 string_sprintf("unknown expansion operator \"%s\"", name);
5823 /* Handle a plain name. If this is the first thing in the expansion, release
5824 the pre-allocated buffer. If the result data is known to be in a new buffer,
5825 newsize will be set to the size of that buffer, and we can just point at that
5826 store instead of copying. Many expansion strings contain just one reference,
5827 so this is a useful optimization, especially for humungous headers
5828 ($message_headers). */
5836 if (resetok) store_reset(yield);
5840 value = find_variable(name, FALSE, skipping, &newsize);
5843 expand_string_message =
5844 string_sprintf("unknown variable in \"${%s}\"", name);
5845 check_variable_error_message(name);
5848 len = Ustrlen(value);
5849 if (yield == NULL && newsize != 0)
5855 else yield = string_cat(yield, &size, &ptr, value, len);
5859 /* Else there's something wrong */
5861 expand_string_message =
5862 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5863 "in a variable reference)", name);
5867 /* If we hit the end of the string when ket_ends is set, there is a missing
5868 terminating brace. */
5870 if (ket_ends && *s == 0)
5872 expand_string_message = malformed_header?
5873 US"missing } at end of string - could be header name not terminated by colon"
5875 US"missing } at end of string";
5879 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5880 added to the string. If so, set up an empty string. Add a terminating zero. If
5881 left != NULL, return a pointer to the terminator. */
5883 if (yield == NULL) yield = store_get(1);
5885 if (left != NULL) *left = s;
5887 /* Any stacking store that was used above the final string is no longer needed.
5888 In many cases the final string will be the first one that was got and so there
5889 will be optimal store usage. */
5891 if (resetok) store_reset(yield + ptr + 1);
5894 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5896 if (skipping) debug_printf("skipping: result is not used\n");
5900 /* This is the failure exit: easiest to program with a goto. We still need
5901 to update the pointer to the terminator, for cases of nested calls with "fail".
5904 EXPAND_FAILED_CURLY:
5905 expand_string_message = malformed_header?
5906 US"missing or misplaced { or } - could be header name not terminated by colon"
5908 US"missing or misplaced { or }";
5910 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5911 that is a bad idea, because expand_string_message is in dynamic store. */
5914 if (left != NULL) *left = s;
5917 debug_printf("failed to expand: %s\n", string);
5918 debug_printf(" error message: %s\n", expand_string_message);
5919 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5925 /* This is the external function call. Do a quick check for any expansion
5926 metacharacters, and if there are none, just return the input string.
5928 Argument: the string to be expanded
5929 Returns: the expanded string, or NULL if expansion failed; if failure was
5930 due to a lookup deferring, search_find_defer will be TRUE
5934 expand_string(uschar *string)
5936 search_find_defer = FALSE;
5937 malformed_header = FALSE;
5938 return (Ustrpbrk(string, "$\\") == NULL)? string :
5939 expand_string_internal(string, FALSE, NULL, FALSE);
5944 /*************************************************
5946 *************************************************/
5948 /* Now and again we want to expand a string and be sure that the result is in a
5949 new bit of store. This function does that.
5951 Argument: the string to be expanded
5952 Returns: the expanded string, always in a new bit of store, or NULL
5956 expand_string_copy(uschar *string)
5958 uschar *yield = expand_string(string);
5959 if (yield == string) yield = string_copy(string);
5965 /*************************************************
5966 * Expand and interpret as an integer *
5967 *************************************************/
5969 /* Expand a string, and convert the result into an integer.
5972 string the string to be expanded
5973 isplus TRUE if a non-negative number is expected
5975 Returns: the integer value, or
5976 -1 for an expansion error ) in both cases, message in
5977 -2 for an integer interpretation error ) expand_string_message
5978 expand_string_message is set NULL for an OK integer
5982 expand_string_integer(uschar *string, BOOL isplus)
5985 uschar *s = expand_string(string);
5986 uschar *msg = US"invalid integer \"%s\"";
5989 /* If expansion failed, expand_string_message will be set. */
5991 if (s == NULL) return -1;
5993 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5994 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5995 systems, so we set it zero ourselves. */
5998 expand_string_message = NULL; /* Indicates no error */
6000 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6001 equal to 0. Unfortunately, people actually relied upon that, so preserve
6002 the behaviour explicitly. Stripping leading whitespace is a harmless
6003 noop change since strtol skips it anyway (provided that there is a number
6007 while (isspace(*s)) ++s;
6011 debug_printf("treating blank string as number 0\n");
6016 value = strtol(CS s, CSS &endptr, 10);
6020 msg = US"integer expected but \"%s\" found";
6022 else if (value < 0 && isplus)
6024 msg = US"non-negative integer expected but \"%s\" found";
6028 /* Ensure we can cast this down to an int */
6029 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
6031 if (errno != ERANGE)
6033 if (tolower(*endptr) == 'k')
6035 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
6039 else if (tolower(*endptr) == 'm')
6041 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
6043 else value *= 1024*1024;
6047 if (errno == ERANGE)
6048 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6051 while (isspace(*endptr)) endptr++;
6052 if (*endptr == 0) return (int)value;
6056 expand_string_message = string_sprintf(CS msg, s);
6061 /*************************************************
6062 **************************************************
6063 * Stand-alone test program *
6064 **************************************************
6065 *************************************************/
6071 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6073 int ovector[3*(EXPAND_MAXN+1)];
6074 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6075 ovector, sizeof(ovector)/sizeof(int));
6076 BOOL yield = n >= 0;
6077 if (n == 0) n = EXPAND_MAXN + 1;
6081 expand_nmax = (setup < 0)? 0 : setup + 1;
6082 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6084 expand_nstring[expand_nmax] = subject + ovector[nn];
6085 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6093 int main(int argc, uschar **argv)
6096 uschar buffer[1024];
6098 debug_selector = D_v;
6099 debug_file = stderr;
6100 debug_fd = fileno(debug_file);
6101 big_buffer = malloc(big_buffer_size);
6103 for (i = 1; i < argc; i++)
6105 if (argv[i][0] == '+')
6107 debug_trace_memory = 2;
6110 if (isdigit(argv[i][0]))
6111 debug_selector = Ustrtol(argv[i], NULL, 0);
6113 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6117 eldap_default_servers = argv[i];
6120 mysql_servers = argv[i];
6123 pgsql_servers = argv[i];
6127 else opt_perl_startup = argv[i];
6131 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6133 expand_nstring[1] = US"string 1....";
6134 expand_nlength[1] = 8;
6138 if (opt_perl_startup != NULL)
6141 printf("Starting Perl interpreter\n");
6142 errstr = init_perl(opt_perl_startup);
6145 printf("** error in perl_startup code: %s\n", errstr);
6146 return EXIT_FAILURE;
6149 #endif /* EXIM_PERL */
6151 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6153 void *reset_point = store_get(0);
6154 uschar *yield = expand_string(buffer);
6157 printf("%s\n", yield);
6158 store_reset(reset_point);
6162 if (search_find_defer) printf("search_find deferred\n");
6163 printf("Failed: %s\n", expand_string_message);
6164 if (expand_string_forcedfail) printf("Forced failure\n");
6176 /* End of expand.c */