1 /* $Cambridge: exim/src/src/expand.c,v 1.104 2009/10/16 09:10:40 tom Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2007 */
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",
165 EOP_QUOTE_LOCAL_PART,
169 static uschar *op_table_main[] = {
203 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
236 /* Table of condition names, and corresponding switch numbers. The names must
237 be in alphabetical order. */
239 static uschar *cond_table[] = {
243 US"==", /* Backward compatibility */
272 US"match_local_part",
295 ECOND_FIRST_DELIVERY,
314 ECOND_MATCH_LOCAL_PART,
324 /* Type for main variable table */
332 /* Type for entries pointing to address/length pairs. Not currently
340 /* Types of table entry */
343 vtype_int, /* value is address of int */
344 vtype_filter_int, /* ditto, but recognized only when filtering */
345 vtype_ino, /* value is address of ino_t (not always an int) */
346 vtype_uid, /* value is address of uid_t (not always an int) */
347 vtype_gid, /* value is address of gid_t (not always an int) */
348 vtype_stringptr, /* value is address of pointer to string */
349 vtype_msgbody, /* as stringptr, but read when first required */
350 vtype_msgbody_end, /* ditto, the end of the message */
351 vtype_msgheaders, /* the message's headers, processed */
352 vtype_msgheaders_raw, /* the message's headers, unprocessed */
353 vtype_localpart, /* extract local part from string */
354 vtype_domain, /* extract domain from string */
355 vtype_recipients, /* extract recipients from recipients list */
356 /* (available only in system filters, ACLs, and */
358 vtype_todbsdin, /* value not used; generate BSD inbox tod */
359 vtype_tode, /* value not used; generate tod in epoch format */
360 vtype_todf, /* value not used; generate full tod */
361 vtype_todl, /* value not used; generate log tod */
362 vtype_todlf, /* value not used; generate log file datestamp tod */
363 vtype_todzone, /* value not used; generate time zone only */
364 vtype_todzulu, /* value not used; generate zulu tod */
365 vtype_reply, /* value not used; get reply from headers */
366 vtype_pid, /* value not used; result is pid */
367 vtype_host_lookup, /* value not used; get host name */
368 vtype_load_avg, /* value not used; result is int from os_getloadavg */
369 vtype_pspace, /* partition space; value is T/F for spool/log */
370 vtype_pinodes /* partition inodes; value is T/F for spool/log */
372 ,vtype_dkim /* Lookup of value in DKIM signature */
376 /* This table must be kept in alphabetical order. */
378 static var_entry var_table[] = {
379 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
380 they will be confused with user-creatable ACL variables. */
381 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
382 { "address_data", vtype_stringptr, &deliver_address_data },
383 { "address_file", vtype_stringptr, &address_file },
384 { "address_pipe", vtype_stringptr, &address_pipe },
385 { "authenticated_id", vtype_stringptr, &authenticated_id },
386 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
387 { "authentication_failed",vtype_int, &authentication_failed },
388 #ifdef EXPERIMENTAL_BRIGHTMAIL
389 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
390 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
391 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
392 { "bmi_deliver", vtype_int, &bmi_deliver },
394 { "body_linecount", vtype_int, &body_linecount },
395 { "body_zerocount", vtype_int, &body_zerocount },
396 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
397 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
398 { "caller_gid", vtype_gid, &real_gid },
399 { "caller_uid", vtype_uid, &real_uid },
400 { "compile_date", vtype_stringptr, &version_date },
401 { "compile_number", vtype_stringptr, &version_cnumber },
402 { "csa_status", vtype_stringptr, &csa_status },
403 #ifdef EXPERIMENTAL_DCC
404 { "dcc_header", vtype_stringptr, &dcc_header },
405 { "dcc_result", vtype_stringptr, &dcc_result },
407 #ifdef WITH_OLD_DEMIME
408 { "demime_errorlevel", vtype_int, &demime_errorlevel },
409 { "demime_reason", vtype_stringptr, &demime_reason },
412 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
413 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
414 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
415 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
416 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
417 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
418 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
419 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
420 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
421 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
422 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
423 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
424 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
425 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
426 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
427 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
428 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
429 { "dkim_signers", vtype_stringptr, &dkim_signers },
430 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
431 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
433 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
434 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
435 { "dnslist_text", vtype_stringptr, &dnslist_text },
436 { "dnslist_value", vtype_stringptr, &dnslist_value },
437 { "domain", vtype_stringptr, &deliver_domain },
438 { "domain_data", vtype_stringptr, &deliver_domain_data },
439 { "exim_gid", vtype_gid, &exim_gid },
440 { "exim_path", vtype_stringptr, &exim_path },
441 { "exim_uid", vtype_uid, &exim_uid },
442 #ifdef WITH_OLD_DEMIME
443 { "found_extension", vtype_stringptr, &found_extension },
445 { "home", vtype_stringptr, &deliver_home },
446 { "host", vtype_stringptr, &deliver_host },
447 { "host_address", vtype_stringptr, &deliver_host_address },
448 { "host_data", vtype_stringptr, &host_data },
449 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
450 { "host_lookup_failed", vtype_int, &host_lookup_failed },
451 { "inode", vtype_ino, &deliver_inode },
452 { "interface_address", vtype_stringptr, &interface_address },
453 { "interface_port", vtype_int, &interface_port },
454 { "item", vtype_stringptr, &iterate_item },
456 { "ldap_dn", vtype_stringptr, &eldap_dn },
458 { "load_average", vtype_load_avg, NULL },
459 { "local_part", vtype_stringptr, &deliver_localpart },
460 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
461 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
462 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
463 { "local_scan_data", vtype_stringptr, &local_scan_data },
464 { "local_user_gid", vtype_gid, &local_user_gid },
465 { "local_user_uid", vtype_uid, &local_user_uid },
466 { "localhost_number", vtype_int, &host_number },
467 { "log_inodes", vtype_pinodes, (void *)FALSE },
468 { "log_space", vtype_pspace, (void *)FALSE },
469 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
470 #ifdef WITH_CONTENT_SCAN
471 { "malware_name", vtype_stringptr, &malware_name },
473 { "max_received_linelength", vtype_int, &max_received_linelength },
474 { "message_age", vtype_int, &message_age },
475 { "message_body", vtype_msgbody, &message_body },
476 { "message_body_end", vtype_msgbody_end, &message_body_end },
477 { "message_body_size", vtype_int, &message_body_size },
478 { "message_exim_id", vtype_stringptr, &message_id },
479 { "message_headers", vtype_msgheaders, NULL },
480 { "message_headers_raw", vtype_msgheaders_raw, NULL },
481 { "message_id", vtype_stringptr, &message_id },
482 { "message_linecount", vtype_int, &message_linecount },
483 { "message_size", vtype_int, &message_size },
484 #ifdef WITH_CONTENT_SCAN
485 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
486 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
487 { "mime_boundary", vtype_stringptr, &mime_boundary },
488 { "mime_charset", vtype_stringptr, &mime_charset },
489 { "mime_content_description", vtype_stringptr, &mime_content_description },
490 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
491 { "mime_content_id", vtype_stringptr, &mime_content_id },
492 { "mime_content_size", vtype_int, &mime_content_size },
493 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
494 { "mime_content_type", vtype_stringptr, &mime_content_type },
495 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
496 { "mime_filename", vtype_stringptr, &mime_filename },
497 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
498 { "mime_is_multipart", vtype_int, &mime_is_multipart },
499 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
500 { "mime_part_count", vtype_int, &mime_part_count },
502 { "n0", vtype_filter_int, &filter_n[0] },
503 { "n1", vtype_filter_int, &filter_n[1] },
504 { "n2", vtype_filter_int, &filter_n[2] },
505 { "n3", vtype_filter_int, &filter_n[3] },
506 { "n4", vtype_filter_int, &filter_n[4] },
507 { "n5", vtype_filter_int, &filter_n[5] },
508 { "n6", vtype_filter_int, &filter_n[6] },
509 { "n7", vtype_filter_int, &filter_n[7] },
510 { "n8", vtype_filter_int, &filter_n[8] },
511 { "n9", vtype_filter_int, &filter_n[9] },
512 { "original_domain", vtype_stringptr, &deliver_domain_orig },
513 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
514 { "originator_gid", vtype_gid, &originator_gid },
515 { "originator_uid", vtype_uid, &originator_uid },
516 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
517 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
518 { "pid", vtype_pid, NULL },
519 { "primary_hostname", vtype_stringptr, &primary_hostname },
520 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
521 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
522 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
523 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
524 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
525 { "rcpt_count", vtype_int, &rcpt_count },
526 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
527 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
528 { "received_count", vtype_int, &received_count },
529 { "received_for", vtype_stringptr, &received_for },
530 { "received_ip_address", vtype_stringptr, &interface_address },
531 { "received_port", vtype_int, &interface_port },
532 { "received_protocol", vtype_stringptr, &received_protocol },
533 { "received_time", vtype_int, &received_time },
534 { "recipient_data", vtype_stringptr, &recipient_data },
535 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
536 { "recipients", vtype_recipients, NULL },
537 { "recipients_count", vtype_int, &recipients_count },
538 #ifdef WITH_CONTENT_SCAN
539 { "regex_match_string", vtype_stringptr, ®ex_match_string },
541 { "reply_address", vtype_reply, NULL },
542 { "return_path", vtype_stringptr, &return_path },
543 { "return_size_limit", vtype_int, &bounce_return_size_limit },
544 { "runrc", vtype_int, &runrc },
545 { "self_hostname", vtype_stringptr, &self_hostname },
546 { "sender_address", vtype_stringptr, &sender_address },
547 { "sender_address_data", vtype_stringptr, &sender_address_data },
548 { "sender_address_domain", vtype_domain, &sender_address },
549 { "sender_address_local_part", vtype_localpart, &sender_address },
550 { "sender_data", vtype_stringptr, &sender_data },
551 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
552 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
553 { "sender_host_address", vtype_stringptr, &sender_host_address },
554 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
555 { "sender_host_name", vtype_host_lookup, NULL },
556 { "sender_host_port", vtype_int, &sender_host_port },
557 { "sender_ident", vtype_stringptr, &sender_ident },
558 { "sender_rate", vtype_stringptr, &sender_rate },
559 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
560 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
561 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
562 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
563 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
564 { "sending_port", vtype_int, &sending_port },
565 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
566 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
567 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
568 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
569 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
570 { "sn0", vtype_filter_int, &filter_sn[0] },
571 { "sn1", vtype_filter_int, &filter_sn[1] },
572 { "sn2", vtype_filter_int, &filter_sn[2] },
573 { "sn3", vtype_filter_int, &filter_sn[3] },
574 { "sn4", vtype_filter_int, &filter_sn[4] },
575 { "sn5", vtype_filter_int, &filter_sn[5] },
576 { "sn6", vtype_filter_int, &filter_sn[6] },
577 { "sn7", vtype_filter_int, &filter_sn[7] },
578 { "sn8", vtype_filter_int, &filter_sn[8] },
579 { "sn9", vtype_filter_int, &filter_sn[9] },
580 #ifdef WITH_CONTENT_SCAN
581 { "spam_bar", vtype_stringptr, &spam_bar },
582 { "spam_report", vtype_stringptr, &spam_report },
583 { "spam_score", vtype_stringptr, &spam_score },
584 { "spam_score_int", vtype_stringptr, &spam_score_int },
586 #ifdef EXPERIMENTAL_SPF
587 { "spf_guess", vtype_stringptr, &spf_guess },
588 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
589 { "spf_received", vtype_stringptr, &spf_received },
590 { "spf_result", vtype_stringptr, &spf_result },
591 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
593 { "spool_directory", vtype_stringptr, &spool_directory },
594 { "spool_inodes", vtype_pinodes, (void *)TRUE },
595 { "spool_space", vtype_pspace, (void *)TRUE },
596 #ifdef EXPERIMENTAL_SRS
597 { "srs_db_address", vtype_stringptr, &srs_db_address },
598 { "srs_db_key", vtype_stringptr, &srs_db_key },
599 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
600 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
601 { "srs_recipient", vtype_stringptr, &srs_recipient },
602 { "srs_status", vtype_stringptr, &srs_status },
604 { "thisaddress", vtype_stringptr, &filter_thisaddress },
605 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
606 { "tls_cipher", vtype_stringptr, &tls_cipher },
607 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
608 { "tod_bsdinbox", vtype_todbsdin, NULL },
609 { "tod_epoch", vtype_tode, NULL },
610 { "tod_full", vtype_todf, NULL },
611 { "tod_log", vtype_todl, NULL },
612 { "tod_logfile", vtype_todlf, NULL },
613 { "tod_zone", vtype_todzone, NULL },
614 { "tod_zulu", vtype_todzulu, NULL },
615 { "value", vtype_stringptr, &lookup_value },
616 { "version_number", vtype_stringptr, &version_string },
617 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
618 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
619 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
620 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
621 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
622 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
625 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
626 static uschar var_buffer[256];
627 static BOOL malformed_header;
629 /* For textual hashes */
631 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
632 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
635 enum { HMAC_MD5, HMAC_SHA1 };
637 /* For numeric hashes */
639 static unsigned int prime[] = {
640 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
641 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
642 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
644 /* For printing modes in symbolic form */
646 static uschar *mtable_normal[] =
647 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
649 static uschar *mtable_setid[] =
650 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
652 static uschar *mtable_sticky[] =
653 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
657 /*************************************************
658 * Tables for UTF-8 support *
659 *************************************************/
661 /* Table of the number of extra characters, indexed by the first character
662 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
665 static uschar utf8_table1[] = {
666 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
667 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
668 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
669 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
671 /* These are the masks for the data bits in the first byte of a character,
672 indexed by the number of additional bytes. */
674 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
676 /* Get the next UTF-8 character, advancing the pointer. */
678 #define GETUTF8INC(c, ptr) \
680 if ((c & 0xc0) == 0xc0) \
682 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
684 c = (c & utf8_table2[a]) << s; \
688 c |= (*ptr++ & 0x3f) << s; \
693 /*************************************************
694 * Binary chop search on a table *
695 *************************************************/
697 /* This is used for matching expansion items and operators.
700 name the name that is being sought
701 table the table to search
702 table_size the number of items in the table
704 Returns: the offset in the table, or -1
708 chop_match(uschar *name, uschar **table, int table_size)
710 uschar **bot = table;
711 uschar **top = table + table_size;
715 uschar **mid = bot + (top - bot)/2;
716 int c = Ustrcmp(name, *mid);
717 if (c == 0) return mid - table;
718 if (c > 0) bot = mid + 1; else top = mid;
726 /*************************************************
727 * Check a condition string *
728 *************************************************/
730 /* This function is called to expand a string, and test the result for a "true"
731 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
732 forced fail or lookup defer. All store used by the function can be released on
736 condition the condition string
737 m1 text to be incorporated in panic error
740 Returns: TRUE if condition is met, FALSE if not
744 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
747 void *reset_point = store_get(0);
748 uschar *ss = expand_string(condition);
751 if (!expand_string_forcedfail && !search_find_defer)
752 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
753 "for %s %s: %s", condition, m1, m2, expand_string_message);
756 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
757 strcmpic(ss, US"false") != 0;
758 store_reset(reset_point);
764 /*************************************************
765 * Pseudo-random number generation *
766 *************************************************/
768 /* Pseudo-random number generation. The result is not "expected" to be
769 cryptographically strong but not so weak that someone will shoot themselves
770 in the foot using it as a nonce in some email header scheme or whatever
771 weirdness they'll twist this into. The result should ideally handle fork().
773 However, if we're stuck unable to provide this, then we'll fall back to
774 appallingly bad randomness.
776 If SUPPORT_TLS is defined and OpenSSL is used, then this will not be used.
777 The GNUTLS randomness functions found do not seem amenable to extracting
778 random numbers outside of a TLS context. Any volunteers?
782 Returns a random number in range [0, max-1]
785 #if !defined(SUPPORT_TLS) || defined(USE_GNUTLS)
787 pseudo_random_number(int max)
789 static pid_t pid = 0;
791 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
801 #ifdef HAVE_ARC4RANDOM
802 /* cryptographically strong randomness, common on *BSD platforms, not
803 so much elsewhere. Alas. */
805 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
806 #ifdef HAVE_SRANDOMDEV
807 /* uses random(4) for seeding */
810 gettimeofday(&tv, NULL);
811 srandom(tv.tv_sec | tv.tv_usec | getpid());
814 /* Poor randomness and no seeding here */
821 #ifdef HAVE_ARC4RANDOM
822 return arc4random() % max;
823 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
824 return random() % max;
826 /* This one returns a 16-bit number, definitely not crypto-strong */
827 return random_number(max);
833 /*************************************************
834 * Pick out a name from a string *
835 *************************************************/
837 /* If the name is too long, it is silently truncated.
840 name points to a buffer into which to put the name
841 max is the length of the buffer
842 s points to the first alphabetic character of the name
843 extras chars other than alphanumerics to permit
845 Returns: pointer to the first character after the name
847 Note: The test for *s != 0 in the while loop is necessary because
848 Ustrchr() yields non-NULL if the character is zero (which is not something
852 read_name(uschar *name, int max, uschar *s, uschar *extras)
855 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
857 if (ptr < max-1) name[ptr++] = *s;
866 /*************************************************
867 * Pick out the rest of a header name *
868 *************************************************/
870 /* A variable name starting $header_ (or just $h_ for those who like
871 abbreviations) might not be the complete header name because headers can
872 contain any printing characters in their names, except ':'. This function is
873 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
874 on the end, if the name was terminated by white space.
877 name points to a buffer in which the name read so far exists
878 max is the length of the buffer
879 s points to the first character after the name so far, i.e. the
880 first non-alphameric character after $header_xxxxx
882 Returns: a pointer to the first character after the header name
886 read_header_name(uschar *name, int max, uschar *s)
888 int prelen = Ustrchr(name, '_') - name + 1;
889 int ptr = Ustrlen(name) - prelen;
890 if (ptr > 0) memmove(name, name+prelen, ptr);
891 while (mac_isgraph(*s) && *s != ':')
893 if (ptr < max-1) name[ptr++] = *s;
904 /*************************************************
905 * Pick out a number from a string *
906 *************************************************/
909 n points to an integer into which to put the number
910 s points to the first digit of the number
912 Returns: a pointer to the character after the last digit
916 read_number(int *n, uschar *s)
919 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
925 /*************************************************
926 * Extract keyed subfield from a string *
927 *************************************************/
929 /* The yield is in dynamic store; NULL means that the key was not found.
932 key points to the name of the key
933 s points to the string from which to extract the subfield
935 Returns: NULL if the subfield was not found, or
936 a pointer to the subfield's data
940 expand_getkeyed(uschar *key, uschar *s)
942 int length = Ustrlen(key);
943 while (isspace(*s)) s++;
945 /* Loop to search for the key */
953 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
954 dkeylength = s - dkey;
955 while (isspace(*s)) s++;
956 if (*s == '=') while (isspace((*(++s))));
958 data = string_dequote(&s);
959 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
962 while (isspace(*s)) s++;
971 /*************************************************
972 * Extract numbered subfield from string *
973 *************************************************/
975 /* Extracts a numbered field from a string that is divided by tokens - for
976 example a line from /etc/passwd is divided by colon characters. First field is
977 numbered one. Negative arguments count from the right. Zero returns the whole
978 string. Returns NULL if there are insufficient tokens in the string
981 Modifies final argument - this is a dynamically generated string, so that's OK.
984 field number of field to be extracted,
985 first field = 1, whole string = 0, last field = -1
986 separators characters that are used to break string into tokens
987 s points to the string from which to extract the subfield
989 Returns: NULL if the field was not found,
990 a pointer to the field's data inside s (modified to add 0)
994 expand_gettokened (int field, uschar *separators, uschar *s)
999 uschar *fieldtext = NULL;
1001 if (field == 0) return s;
1003 /* Break the line up into fields in place; for field > 0 we stop when we have
1004 done the number of fields we want. For field < 0 we continue till the end of
1005 the string, counting the number of fields. */
1007 count = (field > 0)? field : INT_MAX;
1013 /* Previous field was the last one in the string. For a positive field
1014 number, this means there are not enough fields. For a negative field number,
1015 check that there are enough, and scan back to find the one that is wanted. */
1019 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1020 if ((-field) == (INT_MAX - count - 1)) return s;
1024 while (ss[-1] != 0) ss--;
1030 /* Previous field was not last in the string; save its start and put a
1034 len = Ustrcspn(ss, separators);
1045 /*************************************************
1046 * Extract a substring from a string *
1047 *************************************************/
1049 /* Perform the ${substr or ${length expansion operations.
1052 subject the input string
1053 value1 the offset from the start of the input string to the start of
1054 the output string; if negative, count from the right.
1055 value2 the length of the output string, or negative (-1) for unset
1056 if value1 is positive, unset means "all after"
1057 if value1 is negative, unset means "all before"
1058 len set to the length of the returned string
1060 Returns: pointer to the output string, or NULL if there is an error
1064 extract_substr(uschar *subject, int value1, int value2, int *len)
1066 int sublen = Ustrlen(subject);
1068 if (value1 < 0) /* count from right */
1072 /* If the position is before the start, skip to the start, and adjust the
1073 length. If the length ends up negative, the substring is null because nothing
1074 can precede. This falls out naturally when the length is unset, meaning "all
1080 if (value2 < 0) value2 = 0;
1084 /* Otherwise an unset length => characters before value1 */
1086 else if (value2 < 0)
1093 /* For a non-negative offset, if the starting position is past the end of the
1094 string, the result will be the null string. Otherwise, an unset length means
1095 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1099 if (value1 > sublen)
1104 else if (value2 < 0) value2 = sublen;
1107 /* Cut the length down to the maximum possible for the offset value, and get
1108 the required characters. */
1110 if (value1 + value2 > sublen) value2 = sublen - value1;
1112 return subject + value1;
1118 /*************************************************
1119 * Old-style hash of a string *
1120 *************************************************/
1122 /* Perform the ${hash expansion operation.
1125 subject the input string (an expanded substring)
1126 value1 the length of the output string; if greater or equal to the
1127 length of the input string, the input string is returned
1128 value2 the number of hash characters to use, or 26 if negative
1129 len set to the length of the returned string
1131 Returns: pointer to the output string, or NULL if there is an error
1135 compute_hash(uschar *subject, int value1, int value2, int *len)
1137 int sublen = Ustrlen(subject);
1139 if (value2 < 0) value2 = 26;
1140 else if (value2 > Ustrlen(hashcodes))
1142 expand_string_message =
1143 string_sprintf("hash count \"%d\" too big", value2);
1147 /* Calculate the hash text. We know it is shorter than the original string, so
1148 can safely place it in subject[] (we know that subject is always itself an
1149 expanded substring). */
1151 if (value1 < sublen)
1156 while ((c = (subject[j])) != 0)
1158 int shift = (c + j++) & 7;
1159 subject[i] ^= (c << shift) | (c >> (8-shift));
1160 if (++i >= value1) i = 0;
1162 for (i = 0; i < value1; i++)
1163 subject[i] = hashcodes[(subject[i]) % value2];
1165 else value1 = sublen;
1174 /*************************************************
1175 * Numeric hash of a string *
1176 *************************************************/
1178 /* Perform the ${nhash expansion operation. The first characters of the
1179 string are treated as most important, and get the highest prime numbers.
1182 subject the input string
1183 value1 the maximum value of the first part of the result
1184 value2 the maximum value of the second part of the result,
1185 or negative to produce only a one-part result
1186 len set to the length of the returned string
1188 Returns: pointer to the output string, or NULL if there is an error.
1192 compute_nhash (uschar *subject, int value1, int value2, int *len)
1194 uschar *s = subject;
1196 unsigned long int total = 0; /* no overflow */
1200 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1201 total += prime[i--] * (unsigned int)(*s++);
1204 /* If value2 is unset, just compute one number */
1208 s = string_sprintf("%d", total % value1);
1211 /* Otherwise do a div/mod hash */
1215 total = total % (value1 * value2);
1216 s = string_sprintf("%d/%d", total/value2, total % value2);
1227 /*************************************************
1228 * Find the value of a header or headers *
1229 *************************************************/
1231 /* Multiple instances of the same header get concatenated, and this function
1232 can also return a concatenation of all the header lines. When concatenating
1233 specific headers that contain lists of addresses, a comma is inserted between
1234 them. Otherwise we use a straight concatenation. Because some messages can have
1235 pathologically large number of lines, there is a limit on the length that is
1236 returned. Also, to avoid massive store use which would result from using
1237 string_cat() as it copies and extends strings, we do a preliminary pass to find
1238 out exactly how much store will be needed. On "normal" messages this will be
1242 name the name of the header, without the leading $header_ or $h_,
1243 or NULL if a concatenation of all headers is required
1244 exists_only TRUE if called from a def: test; don't need to build a string;
1245 just return a string that is not "" and not "0" if the header
1247 newsize return the size of memory block that was obtained; may be NULL
1248 if exists_only is TRUE
1249 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1250 other than concatenating, will be done on the header. Also used
1251 for $message_headers_raw.
1252 charset name of charset to translate MIME words to; used only if
1253 want_raw is false; if NULL, no translation is done (this is
1254 used for $bh_ and $bheader_)
1256 Returns: NULL if the header does not exist, else a pointer to a new
1261 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1264 BOOL found = name == NULL;
1266 int len = found? 0 : Ustrlen(name);
1268 uschar *yield = NULL;
1271 /* Loop for two passes - saves code repetition */
1273 for (i = 0; i < 2; i++)
1278 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1280 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1282 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1287 if (exists_only) return US"1"; /* don't need actual string */
1289 t = h->text + len; /* text to insert */
1290 if (!want_raw) /* unless wanted raw, */
1291 while (isspace(*t)) t++; /* remove leading white space */
1292 ilen = h->slen - (t - h->text); /* length to insert */
1294 /* Unless wanted raw, remove trailing whitespace, including the
1298 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1300 /* Set comma = 1 if handling a single header and it's one of those
1301 that contains an address list, except when asked for raw headers. Only
1302 need to do this once. */
1304 if (!want_raw && name != NULL && comma == 0 &&
1305 Ustrchr("BCFRST", h->type) != NULL)
1308 /* First pass - compute total store needed; second pass - compute
1309 total store used, including this header. */
1311 size += ilen + comma + 1; /* +1 for the newline */
1313 /* Second pass - concatentate the data, up to a maximum. Note that
1314 the loop stops when size hits the limit. */
1318 if (size > header_insert_maxlen)
1320 ilen -= size - header_insert_maxlen - 1;
1323 Ustrncpy(ptr, t, ilen);
1326 /* For a non-raw header, put in the comma if needed, then add
1327 back the newline we removed above, provided there was some text in
1330 if (!want_raw && ilen > 0)
1332 if (comma != 0) *ptr++ = ',';
1340 /* At end of first pass, return NULL if no header found. Then truncate size
1341 if necessary, and get the buffer to hold the data, returning the buffer size.
1346 if (!found) return NULL;
1347 if (size > header_insert_maxlen) size = header_insert_maxlen;
1348 *newsize = size + 1;
1349 ptr = yield = store_get(*newsize);
1353 /* That's all we do for raw header expansion. */
1360 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1361 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1362 function can return an error with decoded data if the charset translation
1363 fails. If decoding fails, it returns NULL. */
1367 uschar *decoded, *error;
1368 if (ptr > yield && ptr[-1] == '\n') ptr--;
1369 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1371 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1375 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1376 " input was: %s\n", error, yield);
1378 if (decoded != NULL) yield = decoded;
1387 /*************************************************
1388 * Find value of a variable *
1389 *************************************************/
1391 /* The table of variables is kept in alphabetic order, so we can search it
1392 using a binary chop. The "choplen" variable is nothing to do with the binary
1396 name the name of the variable being sought
1397 exists_only TRUE if this is a def: test; passed on to find_header()
1398 skipping TRUE => skip any processing evaluation; this is not the same as
1399 exists_only because def: may test for values that are first
1401 newsize pointer to an int which is initially zero; if the answer is in
1402 a new memory buffer, *newsize is set to its size
1404 Returns: NULL if the variable does not exist, or
1405 a pointer to the variable's contents, or
1406 something non-NULL if exists_only is TRUE
1410 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1413 int last = var_table_size;
1415 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1416 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1417 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1418 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1419 (this gave backwards compatibility at the changeover). There may be built-in
1420 variables whose names start acl_ but they should never start in this way. This
1421 slightly messy specification is a consequence of the history, needless to say.
1423 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1424 set, in which case give an error. */
1426 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1430 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1431 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1434 /* Handle $auth<n> variables. */
1436 if (Ustrncmp(name, "auth", 4) == 0)
1439 int n = Ustrtoul(name + 4, &endptr, 10);
1440 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1441 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1444 /* For all other variables, search the table */
1446 while (last > first)
1450 int middle = (first + last)/2;
1451 int c = Ustrcmp(name, var_table[middle].name);
1453 if (c > 0) { first = middle + 1; continue; }
1454 if (c < 0) { last = middle; continue; }
1456 /* Found an existing variable. If in skipping state, the value isn't needed,
1457 and we want to avoid processing (such as looking up the host name). */
1459 if (skipping) return US"";
1461 switch (var_table[middle].type)
1463 case vtype_filter_int:
1464 if (!filter_running) return NULL;
1468 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1472 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1476 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1480 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1483 case vtype_stringptr: /* Pointer to string */
1484 s = *((uschar **)(var_table[middle].value));
1485 return (s == NULL)? US"" : s;
1488 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1491 case vtype_load_avg:
1492 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1495 case vtype_host_lookup: /* Lookup if not done so */
1496 if (sender_host_name == NULL && sender_host_address != NULL &&
1497 !host_lookup_failed && host_name_lookup() == OK)
1498 host_build_sender_fullhost();
1499 return (sender_host_name == NULL)? US"" : sender_host_name;
1501 case vtype_localpart: /* Get local part from address */
1502 s = *((uschar **)(var_table[middle].value));
1503 if (s == NULL) return US"";
1504 domain = Ustrrchr(s, '@');
1505 if (domain == NULL) return s;
1506 if (domain - s > sizeof(var_buffer) - 1)
1507 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1508 "string expansion", sizeof(var_buffer));
1509 Ustrncpy(var_buffer, s, domain - s);
1510 var_buffer[domain - s] = 0;
1513 case vtype_domain: /* Get domain from address */
1514 s = *((uschar **)(var_table[middle].value));
1515 if (s == NULL) return US"";
1516 domain = Ustrrchr(s, '@');
1517 return (domain == NULL)? US"" : domain + 1;
1519 case vtype_msgheaders:
1520 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1522 case vtype_msgheaders_raw:
1523 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1525 case vtype_msgbody: /* Pointer to msgbody string */
1526 case vtype_msgbody_end: /* Ditto, the end of the msg */
1527 ss = (uschar **)(var_table[middle].value);
1528 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1531 off_t start_offset = SPOOL_DATA_START_OFFSET;
1532 int len = message_body_visible;
1533 if (len > message_size) len = message_size;
1534 *ss = body = store_malloc(len+1);
1536 if (var_table[middle].type == vtype_msgbody_end)
1538 struct stat statbuf;
1539 if (fstat(deliver_datafile, &statbuf) == 0)
1541 start_offset = statbuf.st_size - len;
1542 if (start_offset < SPOOL_DATA_START_OFFSET)
1543 start_offset = SPOOL_DATA_START_OFFSET;
1546 lseek(deliver_datafile, start_offset, SEEK_SET);
1547 len = read(deliver_datafile, body, len);
1551 if (message_body_newlines) /* Separate loops for efficiency */
1554 { if (body[--len] == 0) body[len] = ' '; }
1559 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1563 return (*ss == NULL)? US"" : *ss;
1565 case vtype_todbsdin: /* BSD inbox time of day */
1566 return tod_stamp(tod_bsdin);
1568 case vtype_tode: /* Unix epoch time of day */
1569 return tod_stamp(tod_epoch);
1571 case vtype_todf: /* Full time of day */
1572 return tod_stamp(tod_full);
1574 case vtype_todl: /* Log format time of day */
1575 return tod_stamp(tod_log_bare); /* (without timezone) */
1577 case vtype_todzone: /* Time zone offset only */
1578 return tod_stamp(tod_zone);
1580 case vtype_todzulu: /* Zulu time */
1581 return tod_stamp(tod_zulu);
1583 case vtype_todlf: /* Log file datestamp tod */
1584 return tod_stamp(tod_log_datestamp);
1586 case vtype_reply: /* Get reply address */
1587 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1589 if (s != NULL) while (isspace(*s)) s++;
1590 if (s == NULL || *s == 0)
1592 *newsize = 0; /* For the *s==0 case */
1593 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1598 while (isspace(*s)) s++;
1599 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1600 while (t > s && isspace(t[-1])) t--;
1603 return (s == NULL)? US"" : s;
1605 /* A recipients list is available only during system message filtering,
1606 during ACL processing after DATA, and while expanding pipe commands
1607 generated from a system filter, but not elsewhere. */
1609 case vtype_recipients:
1610 if (!enable_dollar_recipients) return NULL; else
1615 s = store_get(size);
1616 for (i = 0; i < recipients_count; i++)
1618 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1619 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1620 Ustrlen(recipients_list[i].address));
1622 s[ptr] = 0; /* string_cat() leaves room */
1629 sprintf(CS var_buffer, "%d",
1630 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1637 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1638 sprintf(CS var_buffer, "%d", inodes);
1642 #ifndef DISABLE_DKIM
1644 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1650 return NULL; /* Unknown variable name */
1656 /*************************************************
1657 * Read and expand substrings *
1658 *************************************************/
1660 /* This function is called to read and expand argument substrings for various
1661 expansion items. Some have a minimum requirement that is less than the maximum;
1662 in these cases, the first non-present one is set to NULL.
1665 sub points to vector of pointers to set
1666 n maximum number of substrings
1668 sptr points to current string pointer
1669 skipping the skipping flag
1670 check_end if TRUE, check for final '}'
1671 name name of item, for error message
1673 Returns: 0 OK; string pointer updated
1674 1 curly bracketing error (too few arguments)
1675 2 too many arguments (only if check_end is set); message set
1676 3 other error (expansion failure)
1680 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1681 BOOL check_end, uschar *name)
1686 while (isspace(*s)) s++;
1687 for (i = 0; i < n; i++)
1691 if (i < m) return 1;
1695 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1696 if (sub[i] == NULL) return 3;
1697 if (*s++ != '}') return 1;
1698 while (isspace(*s)) s++;
1700 if (check_end && *s++ != '}')
1704 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1705 "(max is %d)", name, n);
1718 /*************************************************
1719 * Elaborate message for bad variable *
1720 *************************************************/
1722 /* For the "unknown variable" message, take a look at the variable's name, and
1723 give additional information about possible ACL variables. The extra information
1724 is added on to expand_string_message.
1726 Argument: the name of the variable
1731 check_variable_error_message(uschar *name)
1733 if (Ustrncmp(name, "acl_", 4) == 0)
1734 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1735 (name[4] == 'c' || name[4] == 'm')?
1737 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1738 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1740 US"user-defined ACL variables must start acl_c or acl_m");
1745 /*************************************************
1746 * Read and evaluate a condition *
1747 *************************************************/
1751 s points to the start of the condition text
1752 yield points to a BOOL to hold the result of the condition test;
1753 if NULL, we are just reading through a condition that is
1754 part of an "or" combination to check syntax, or in a state
1755 where the answer isn't required
1757 Returns: a pointer to the first character after the condition, or
1762 eval_condition(uschar *s, BOOL *yield)
1764 BOOL testfor = TRUE;
1765 BOOL tempcond, combined_cond;
1767 int i, rc, cond_type, roffset;
1769 struct stat statbuf;
1774 const uschar *rerror;
1778 while (isspace(*s)) s++;
1779 if (*s == '!') { testfor = !testfor; s++; } else break;
1782 /* Numeric comparisons are symbolic */
1784 if (*s == '=' || *s == '>' || *s == '<')
1796 /* All other conditions are named */
1798 else s = read_name(name, 256, s, US"_");
1800 /* If we haven't read a name, it means some non-alpha character is first. */
1804 expand_string_message = string_sprintf("condition name expected, "
1805 "but found \"%.16s\"", s);
1809 /* Find which condition we are dealing with, and switch on it */
1811 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1814 /* def: tests for a non-empty variable, or for the existence of a header. If
1815 yield == NULL we are in a skipping state, and don't care about the answer. */
1820 expand_string_message = US"\":\" expected after \"def\"";
1824 s = read_name(name, 256, s+1, US"_");
1826 /* Test for a header's existence. If the name contains a closing brace
1827 character, this may be a user error where the terminating colon has been
1828 omitted. Set a flag to adjust a subsequent error message in this case. */
1830 if (Ustrncmp(name, "h_", 2) == 0 ||
1831 Ustrncmp(name, "rh_", 3) == 0 ||
1832 Ustrncmp(name, "bh_", 3) == 0 ||
1833 Ustrncmp(name, "header_", 7) == 0 ||
1834 Ustrncmp(name, "rheader_", 8) == 0 ||
1835 Ustrncmp(name, "bheader_", 8) == 0)
1837 s = read_header_name(name, 256, s);
1838 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1839 if (yield != NULL) *yield =
1840 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1843 /* Test for a variable's having a non-empty value. A non-existent variable
1844 causes an expansion failure. */
1848 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1851 expand_string_message = (name[0] == 0)?
1852 string_sprintf("variable name omitted after \"def:\"") :
1853 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1854 check_variable_error_message(name);
1857 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1863 /* first_delivery tests for first delivery attempt */
1865 case ECOND_FIRST_DELIVERY:
1866 if (yield != NULL) *yield = deliver_firsttime == testfor;
1870 /* queue_running tests for any process started by a queue runner */
1872 case ECOND_QUEUE_RUNNING:
1873 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1877 /* exists: tests for file existence
1878 isip: tests for any IP address
1879 isip4: tests for an IPv4 address
1880 isip6: tests for an IPv6 address
1881 pam: does PAM authentication
1882 radius: does RADIUS authentication
1883 ldapauth: does LDAP authentication
1884 pwcheck: does Cyrus SASL pwcheck authentication
1893 case ECOND_LDAPAUTH:
1896 while (isspace(*s)) s++;
1897 if (*s != '{') goto COND_FAILED_CURLY_START;
1899 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1900 if (sub[0] == NULL) return NULL;
1901 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1903 if (yield == NULL) return s; /* No need to run the test if skipping */
1908 if ((expand_forbid & RDO_EXISTS) != 0)
1910 expand_string_message = US"File existence tests are not permitted";
1913 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1919 rc = string_is_ip_address(sub[0], NULL);
1920 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1921 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1924 /* Various authentication tests - all optionally compiled */
1928 rc = auth_call_pam(sub[0], &expand_string_message);
1931 goto COND_FAILED_NOT_COMPILED;
1932 #endif /* SUPPORT_PAM */
1935 #ifdef RADIUS_CONFIG_FILE
1936 rc = auth_call_radius(sub[0], &expand_string_message);
1939 goto COND_FAILED_NOT_COMPILED;
1940 #endif /* RADIUS_CONFIG_FILE */
1942 case ECOND_LDAPAUTH:
1945 /* Just to keep the interface the same */
1947 int old_pool = store_pool;
1948 store_pool = POOL_SEARCH;
1949 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1950 &expand_string_message, &do_cache);
1951 store_pool = old_pool;
1955 goto COND_FAILED_NOT_COMPILED;
1956 #endif /* LOOKUP_LDAP */
1959 #ifdef CYRUS_PWCHECK_SOCKET
1960 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1963 goto COND_FAILED_NOT_COMPILED;
1964 #endif /* CYRUS_PWCHECK_SOCKET */
1966 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1967 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1969 if (rc == ERROR || rc == DEFER) return NULL;
1970 *yield = (rc == OK) == testfor;
1976 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1978 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1980 However, the last two are optional. That is why the whole set is enclosed
1981 in their own set or braces. */
1983 case ECOND_SASLAUTHD:
1984 #ifndef CYRUS_SASLAUTHD_SOCKET
1985 goto COND_FAILED_NOT_COMPILED;
1987 while (isspace(*s)) s++;
1988 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1989 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1991 case 1: expand_string_message = US"too few arguments or bracketing "
1992 "error for saslauthd";
1994 case 3: return NULL;
1996 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2000 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2001 &expand_string_message);
2002 if (rc == ERROR || rc == DEFER) return NULL;
2003 *yield = (rc == OK) == testfor;
2006 #endif /* CYRUS_SASLAUTHD_SOCKET */
2009 /* symbolic operators for numeric and string comparison, and a number of
2010 other operators, all requiring two arguments.
2012 match: does a regular expression match and sets up the numerical
2013 variables if it succeeds
2014 match_address: matches in an address list
2015 match_domain: matches in a domain list
2016 match_ip: matches a host list that is restricted to IP addresses
2017 match_local_part: matches in a local part list
2018 crypteq: encrypts plaintext and compares against an encrypted text,
2019 using crypt(), crypt16(), MD5 or SHA-1
2023 case ECOND_MATCH_ADDRESS:
2024 case ECOND_MATCH_DOMAIN:
2025 case ECOND_MATCH_IP:
2026 case ECOND_MATCH_LOCAL_PART:
2029 case ECOND_NUM_L: /* Numerical comparisons */
2036 case ECOND_STR_LT: /* String comparisons */
2047 for (i = 0; i < 2; i++)
2049 while (isspace(*s)) s++;
2052 if (i == 0) goto COND_FAILED_CURLY_START;
2053 expand_string_message = string_sprintf("missing 2nd string in {} "
2054 "after \"%s\"", name);
2057 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
2058 if (sub[i] == NULL) return NULL;
2059 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2061 /* Convert to numerical if required; we know that the names of all the
2062 conditions that compare numbers do not start with a letter. This just saves
2063 checking for them individually. */
2065 if (!isalpha(name[0]) && yield != NULL)
2071 debug_printf("empty string cast to zero for numerical comparison\n");
2075 num[i] = expand_string_integer(sub[i], FALSE);
2076 if (expand_string_message != NULL) return NULL;
2081 /* Result not required */
2083 if (yield == NULL) return s;
2085 /* Do an appropriate comparison */
2091 *yield = (num[0] == num[1]) == testfor;
2095 *yield = (num[0] > num[1]) == testfor;
2099 *yield = (num[0] >= num[1]) == testfor;
2103 *yield = (num[0] < num[1]) == testfor;
2107 *yield = (num[0] <= num[1]) == testfor;
2111 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2115 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2119 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2123 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2127 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2131 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2135 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2139 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2143 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2147 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2150 case ECOND_MATCH: /* Regular expression match */
2151 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2155 expand_string_message = string_sprintf("regular expression error in "
2156 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2159 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2162 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2163 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2164 goto MATCHED_SOMETHING;
2166 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2167 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2168 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2169 goto MATCHED_SOMETHING;
2171 case ECOND_MATCH_IP: /* Match IP address in a host list */
2172 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2174 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2180 unsigned int *nullcache = NULL;
2181 check_host_block cb;
2183 cb.host_name = US"";
2184 cb.host_address = sub[0];
2186 /* If the host address starts off ::ffff: it is an IPv6 address in
2187 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2190 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2191 cb.host_address + 7 : cb.host_address;
2193 rc = match_check_list(
2194 &sub[1], /* the list */
2195 0, /* separator character */
2196 &hostlist_anchor, /* anchor pointer */
2197 &nullcache, /* cache pointer */
2198 check_host, /* function for testing */
2199 &cb, /* argument for function */
2200 MCL_HOST, /* type of check */
2201 sub[0], /* text for debugging */
2202 NULL); /* where to pass back data */
2204 goto MATCHED_SOMETHING;
2206 case ECOND_MATCH_LOCAL_PART:
2207 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2208 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2223 expand_string_message = string_sprintf("unable to complete match "
2224 "against \"%s\": %s", sub[1], search_error_message);
2230 /* Various "encrypted" comparisons. If the second string starts with
2231 "{" then an encryption type is given. Default to crypt() or crypt16()
2232 (build-time choice). */
2235 #ifndef SUPPORT_CRYPTEQ
2236 goto COND_FAILED_NOT_COMPILED;
2238 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2240 int sublen = Ustrlen(sub[1]+5);
2245 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2247 /* If the length that we are comparing against is 24, the MD5 digest
2248 is expressed as a base64 string. This is the way LDAP does it. However,
2249 some other software uses a straightforward hex representation. We assume
2250 this if the length is 32. Other lengths fail. */
2254 uschar *coded = auth_b64encode((uschar *)digest, 16);
2255 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2256 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2257 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2259 else if (sublen == 32)
2263 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2265 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2266 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2267 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2271 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2272 "fail\n crypted=%s\n", sub[1]+5);
2277 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2279 int sublen = Ustrlen(sub[1]+6);
2284 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2286 /* If the length that we are comparing against is 28, assume the SHA1
2287 digest is expressed as a base64 string. If the length is 40, assume a
2288 straightforward hex representation. Other lengths fail. */
2292 uschar *coded = auth_b64encode((uschar *)digest, 20);
2293 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2294 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2295 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2297 else if (sublen == 40)
2301 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2303 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2304 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2305 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2309 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2310 "fail\n crypted=%s\n", sub[1]+6);
2315 else /* {crypt} or {crypt16} and non-{ at start */
2320 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2325 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2330 else if (sub[1][0] == '{')
2332 expand_string_message = string_sprintf("unknown encryption mechanism "
2333 "in \"%s\"", sub[1]);
2339 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2340 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2341 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2345 #define XSTR(s) STR(s)
2346 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2347 " subject=%s\n crypted=%s\n",
2348 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2353 /* If the encrypted string contains fewer than two characters (for the
2354 salt), force failure. Otherwise we get false positives: with an empty
2355 string the yield of crypt() is an empty string! */
2357 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2358 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2361 #endif /* SUPPORT_CRYPTEQ */
2362 } /* Switch for comparison conditions */
2364 return s; /* End of comparison conditions */
2367 /* and/or: computes logical and/or of several conditions */
2371 subcondptr = (yield == NULL)? NULL : &tempcond;
2372 combined_cond = (cond_type == ECOND_AND);
2374 while (isspace(*s)) s++;
2375 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2379 while (isspace(*s)) s++;
2380 if (*s == '}') break;
2383 expand_string_message = string_sprintf("each subcondition "
2384 "inside an \"%s{...}\" condition must be in its own {}", name);
2388 s = eval_condition(s+1, subcondptr);
2391 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2392 expand_string_message, name);
2395 while (isspace(*s)) s++;
2399 expand_string_message = string_sprintf("missing } at end of condition "
2400 "inside \"%s\" group", name);
2406 if (cond_type == ECOND_AND)
2408 combined_cond &= tempcond;
2409 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2410 } /* evaluate any more */
2413 combined_cond |= tempcond;
2414 if (combined_cond) subcondptr = NULL; /* once true, don't */
2415 } /* evaluate any more */
2419 if (yield != NULL) *yield = (combined_cond == testfor);
2423 /* forall/forany: iterates a condition with different values */
2429 uschar *save_iterate_item = iterate_item;
2431 while (isspace(*s)) s++;
2432 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2433 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL));
2434 if (sub[0] == NULL) return NULL;
2435 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2437 while (isspace(*s)) s++;
2438 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2442 /* Call eval_condition once, with result discarded (as if scanning a
2443 "false" part). This allows us to find the end of the condition, because if
2444 the list it empty, we won't actually evaluate the condition for real. */
2446 s = eval_condition(sub[1], NULL);
2449 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2450 expand_string_message, name);
2453 while (isspace(*s)) s++;
2457 expand_string_message = string_sprintf("missing } at end of condition "
2458 "inside \"%s\"", name);
2462 if (yield != NULL) *yield = !testfor;
2463 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2465 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2466 if (eval_condition(sub[1], &tempcond) == NULL)
2468 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2469 expand_string_message, name);
2470 iterate_item = save_iterate_item;
2473 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2474 tempcond? "true":"false");
2476 if (yield != NULL) *yield = (tempcond == testfor);
2477 if (tempcond == (cond_type == ECOND_FORANY)) break;
2480 iterate_item = save_iterate_item;
2485 /* The bool{} expansion condition maps a string to boolean.
2486 The values supported should match those supported by the ACL condition
2487 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2488 of true/false. Note that Router "condition" rules have a different
2489 interpretation, where general data can be used and only a few values
2491 Note that readconf.c boolean matching, for boolean configuration options,
2492 only matches true/yes/false/no. */
2498 BOOL boolvalue = FALSE;
2499 while (isspace(*s)) s++;
2500 if (*s != '{') goto COND_FAILED_CURLY_START;
2501 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, US"bool"))
2503 case 1: expand_string_message = US"too few arguments or bracketing "
2507 case 3: return NULL;
2510 while (isspace(*t)) t++;
2513 debug_printf("considering bool: %s\n", len ? t : US"<empty>");
2516 else if (Ustrspn(t, "0123456789") == len)
2517 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2518 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2520 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2524 expand_string_message = string_sprintf("unrecognised boolean "
2528 if (yield != NULL) *yield = (boolvalue != 0);
2532 /* Unknown condition */
2535 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2537 } /* End switch on condition type */
2539 /* Missing braces at start and end of data */
2541 COND_FAILED_CURLY_START:
2542 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2545 COND_FAILED_CURLY_END:
2546 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2550 /* A condition requires code that is not compiled */
2552 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2553 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2554 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2555 COND_FAILED_NOT_COMPILED:
2556 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2565 /*************************************************
2566 * Save numerical variables *
2567 *************************************************/
2569 /* This function is called from items such as "if" that want to preserve and
2570 restore the numbered variables.
2573 save_expand_string points to an array of pointers to set
2574 save_expand_nlength points to an array of ints for the lengths
2576 Returns: the value of expand max to save
2580 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2583 for (i = 0; i <= expand_nmax; i++)
2585 save_expand_nstring[i] = expand_nstring[i];
2586 save_expand_nlength[i] = expand_nlength[i];
2593 /*************************************************
2594 * Restore numerical variables *
2595 *************************************************/
2597 /* This function restored saved values of numerical strings.
2600 save_expand_nmax the number of strings to restore
2601 save_expand_string points to an array of pointers
2602 save_expand_nlength points to an array of ints
2608 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2609 int *save_expand_nlength)
2612 expand_nmax = save_expand_nmax;
2613 for (i = 0; i <= expand_nmax; i++)
2615 expand_nstring[i] = save_expand_nstring[i];
2616 expand_nlength[i] = save_expand_nlength[i];
2624 /*************************************************
2625 * Handle yes/no substrings *
2626 *************************************************/
2628 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2629 alternative substrings that depend on whether or not the condition was true,
2630 or the lookup or extraction succeeded. The substrings always have to be
2631 expanded, to check their syntax, but "skipping" is set when the result is not
2632 needed - this avoids unnecessary nested lookups.
2635 skipping TRUE if we were skipping when this item was reached
2636 yes TRUE if the first string is to be used, else use the second
2637 save_lookup a value to put back into lookup_value before the 2nd expansion
2638 sptr points to the input string pointer
2639 yieldptr points to the output string pointer
2640 sizeptr points to the output string size
2641 ptrptr points to the output string pointer
2642 type "lookup" or "if" or "extract" or "run", for error message
2644 Returns: 0 OK; lookup_value has been reset to save_lookup
2646 2 expansion failed because of bracketing error
2650 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2651 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2654 uschar *s = *sptr; /* Local value */
2655 uschar *sub1, *sub2;
2657 /* If there are no following strings, we substitute the contents of $value for
2658 lookups and for extractions in the success case. For the ${if item, the string
2659 "true" is substituted. In the fail case, nothing is substituted for all three
2662 while (isspace(*s)) s++;
2667 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2671 if (yes && lookup_value != NULL)
2672 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2673 Ustrlen(lookup_value));
2674 lookup_value = save_lookup;
2680 /* The first following string must be braced. */
2682 if (*s++ != '{') goto FAILED_CURLY;
2684 /* Expand the first substring. Forced failures are noticed only if we actually
2685 want this string. Set skipping in the call in the fail case (this will always
2686 be the case if we were already skipping). */
2688 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2689 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2690 expand_string_forcedfail = FALSE;
2691 if (*s++ != '}') goto FAILED_CURLY;
2693 /* If we want the first string, add it to the output */
2696 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2698 /* If this is called from a lookup or an extract, we want to restore $value to
2699 what it was at the start of the item, so that it has this value during the
2700 second string expansion. For the call from "if" or "run" to this function,
2701 save_lookup is set to lookup_value, so that this statement does nothing. */
2703 lookup_value = save_lookup;
2705 /* There now follows either another substring, or "fail", or nothing. This
2706 time, forced failures are noticed only if we want the second string. We must
2707 set skipping in the nested call if we don't want this string, or if we were
2708 already skipping. */
2710 while (isspace(*s)) s++;
2713 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2714 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2715 expand_string_forcedfail = FALSE;
2716 if (*s++ != '}') goto FAILED_CURLY;
2718 /* If we want the second string, add it to the output */
2721 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2724 /* If there is no second string, but the word "fail" is present when the use of
2725 the second string is wanted, set a flag indicating it was a forced failure
2726 rather than a syntactic error. Swallow the terminating } in case this is nested
2727 inside another lookup or if or extract. */
2732 s = read_name(name, sizeof(name), s, US"_");
2733 if (Ustrcmp(name, "fail") == 0)
2735 if (!yes && !skipping)
2737 while (isspace(*s)) s++;
2738 if (*s++ != '}') goto FAILED_CURLY;
2739 expand_string_message =
2740 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2741 expand_string_forcedfail = TRUE;
2747 expand_string_message =
2748 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2753 /* All we have to do now is to check on the final closing brace. */
2755 while (isspace(*s)) s++;
2756 if (*s++ == '}') goto RETURN;
2758 /* Get here if there is a bracketing failure */
2763 /* Get here for other failures */
2768 /* Update the input pointer value before returning */
2778 /*************************************************
2779 * Handle MD5 or SHA-1 computation for HMAC *
2780 *************************************************/
2782 /* These are some wrapping functions that enable the HMAC code to be a bit
2783 cleaner. A good compiler will spot the tail recursion.
2786 type HMAC_MD5 or HMAC_SHA1
2787 remaining are as for the cryptographic hash functions
2793 chash_start(int type, void *base)
2795 if (type == HMAC_MD5)
2796 md5_start((md5 *)base);
2798 sha1_start((sha1 *)base);
2802 chash_mid(int type, void *base, uschar *string)
2804 if (type == HMAC_MD5)
2805 md5_mid((md5 *)base, string);
2807 sha1_mid((sha1 *)base, string);
2811 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2813 if (type == HMAC_MD5)
2814 md5_end((md5 *)base, string, length, digest);
2816 sha1_end((sha1 *)base, string, length, digest);
2823 /********************************************************
2824 * prvs: Get last three digits of days since Jan 1, 1970 *
2825 ********************************************************/
2827 /* This is needed to implement the "prvs" BATV reverse
2830 Argument: integer "days" offset to add or substract to
2831 or from the current number of days.
2833 Returns: pointer to string containing the last three
2834 digits of the number of days since Jan 1, 1970,
2835 modified by the offset argument, NULL if there
2836 was an error in the conversion.
2841 prvs_daystamp(int day_offset)
2843 uschar *days = store_get(32); /* Need at least 24 for cases */
2844 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2845 (time(NULL) + day_offset*86400)/86400);
2846 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2851 /********************************************************
2852 * prvs: perform HMAC-SHA1 computation of prvs bits *
2853 ********************************************************/
2855 /* This is needed to implement the "prvs" BATV reverse
2859 address RFC2821 Address to use
2860 key The key to use (must be less than 64 characters
2862 key_num Single-digit key number to use. Defaults to
2865 Returns: pointer to string containing the first three
2866 bytes of the final hash in hex format, NULL if
2867 there was an error in the process.
2871 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2873 uschar *hash_source, *p;
2874 int size = 0,offset = 0,i;
2876 void *use_base = &sha1_base;
2877 uschar innerhash[20];
2878 uschar finalhash[20];
2879 uschar innerkey[64];
2880 uschar outerkey[64];
2881 uschar *finalhash_hex = store_get(40);
2883 if (key_num == NULL)
2886 if (Ustrlen(key) > 64)
2889 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2890 string_cat(hash_source,&size,&offset,daystamp,3);
2891 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2892 hash_source[offset] = '\0';
2894 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2896 memset(innerkey, 0x36, 64);
2897 memset(outerkey, 0x5c, 64);
2899 for (i = 0; i < Ustrlen(key); i++)
2901 innerkey[i] ^= key[i];
2902 outerkey[i] ^= key[i];
2905 chash_start(HMAC_SHA1, use_base);
2906 chash_mid(HMAC_SHA1, use_base, innerkey);
2907 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2909 chash_start(HMAC_SHA1, use_base);
2910 chash_mid(HMAC_SHA1, use_base, outerkey);
2911 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2914 for (i = 0; i < 3; i++)
2916 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2917 *p++ = hex_digits[finalhash[i] & 0x0f];
2921 return finalhash_hex;
2927 /*************************************************
2928 * Join a file onto the output string *
2929 *************************************************/
2931 /* This is used for readfile and after a run expansion. It joins the contents
2932 of a file onto the output string, globally replacing newlines with a given
2933 string (optionally). The file is closed at the end.
2937 yield pointer to the expandable string
2938 sizep pointer to the current size
2939 ptrp pointer to the current position
2940 eol newline replacement string, or NULL
2942 Returns: new value of string pointer
2946 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2949 uschar buffer[1024];
2951 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2953 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2955 int len = Ustrlen(buffer);
2956 if (eol != NULL && buffer[len-1] == '\n') len--;
2957 yield = string_cat(yield, sizep, ptrp, buffer, len);
2958 if (buffer[len] != 0)
2959 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2962 if (yield != NULL) yield[*ptrp] = 0;
2970 /*************************************************
2971 * Evaluate numeric expression *
2972 *************************************************/
2974 /* This is a set of mutually recursive functions that evaluate an arithmetic
2975 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
2976 these functions that is called from elsewhere is eval_expr, whose interface is:
2979 sptr pointer to the pointer to the string - gets updated
2980 decimal TRUE if numbers are to be assumed decimal
2981 error pointer to where to put an error message - must be NULL on input
2982 endket TRUE if ')' must terminate - FALSE for external call
2984 Returns: on success: the value of the expression, with *error still NULL
2985 on failure: an undefined value, with *error = a message
2988 static int eval_op_or(uschar **, BOOL, uschar **);
2992 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2995 int x = eval_op_or(&s, decimal, error);
3001 *error = US"expecting closing parenthesis";
3003 while (isspace(*(++s)));
3005 else if (*s != 0) *error = US"expecting operator";
3013 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3018 while (isspace(*s)) s++;
3023 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
3025 if (tolower(*s) == 'k') { n *= 1024; s++; }
3026 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
3027 while (isspace (*s)) s++;
3032 n = eval_expr(&s, decimal, error, 1);
3036 *error = US"expecting number or opening parenthesis";
3044 static int eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3048 while (isspace(*s)) s++;
3049 if (*s == '+' || *s == '-' || *s == '~')
3052 x = eval_op_unary(&s, decimal, error);
3053 if (op == '-') x = -x;
3054 else if (op == '~') x = ~x;
3058 x = eval_number(&s, decimal, error);
3065 static int eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3068 int x = eval_op_unary(&s, decimal, error);
3071 while (*s == '*' || *s == '/' || *s == '%')
3074 int y = eval_op_unary(&s, decimal, error);
3075 if (*error != NULL) break;
3076 if (op == '*') x *= y;
3077 else if (op == '/') x /= y;
3086 static int eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3089 int x = eval_op_mult(&s, decimal, error);
3092 while (*s == '+' || *s == '-')
3095 int y = eval_op_mult(&s, decimal, error);
3096 if (*error != NULL) break;
3097 if (op == '+') x += y; else x -= y;
3105 static int eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3108 int x = eval_op_sum(&s, decimal, error);
3111 while ((*s == '<' || *s == '>') && s[1] == s[0])
3116 y = eval_op_sum(&s, decimal, error);
3117 if (*error != NULL) break;
3118 if (op == '<') x <<= y; else x >>= y;
3126 static int eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3129 int x = eval_op_shift(&s, decimal, error);
3136 y = eval_op_shift(&s, decimal, error);
3137 if (*error != NULL) break;
3146 static int eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3149 int x = eval_op_and(&s, decimal, error);
3156 y = eval_op_and(&s, decimal, error);
3157 if (*error != NULL) break;
3166 static int eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3169 int x = eval_op_xor(&s, decimal, error);
3176 y = eval_op_xor(&s, decimal, error);
3177 if (*error != NULL) break;
3187 /*************************************************
3189 *************************************************/
3191 /* Returns either an unchanged string, or the expanded string in stacking pool
3192 store. Interpreted sequences are:
3194 \... normal escaping rules
3195 $name substitutes the variable
3197 ${op:string} operates on the expanded string value
3198 ${item{arg1}{arg2}...} expands the args and then does the business
3199 some literal args are not enclosed in {}
3201 There are now far too many operators and item types to make it worth listing
3202 them here in detail any more.
3204 We use an internal routine recursively to handle embedded substrings. The
3205 external function follows. The yield is NULL if the expansion failed, and there
3206 are two cases: if something collapsed syntactically, or if "fail" was given
3207 as the action on a lookup failure. These can be distinguised by looking at the
3208 variable expand_string_forcedfail, which is TRUE in the latter case.
3210 The skipping flag is set true when expanding a substring that isn't actually
3211 going to be used (after "if" or "lookup") and it prevents lookups from
3212 happening lower down.
3214 Store usage: At start, a store block of the length of the input plus 64
3215 is obtained. This is expanded as necessary by string_cat(), which might have to
3216 get a new block, or might be able to expand the original. At the end of the
3217 function we can release any store above that portion of the yield block that
3218 was actually used. In many cases this will be optimal.
3220 However: if the first item in the expansion is a variable name or header name,
3221 we reset the store before processing it; if the result is in fresh store, we
3222 use that without copying. This is helpful for expanding strings like
3223 $message_headers which can get very long.
3225 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3226 since resetting the store at the end of the expansion will free store that was
3227 allocated by the plugin code as well as the slop after the expanded string. So
3228 we skip any resets if ${dlfunc has been used. This is an unfortunate
3229 consequence of string expansion becoming too powerful.
3232 string the string to be expanded
3233 ket_ends true if expansion is to stop at }
3234 left if not NULL, a pointer to the first character after the
3235 expansion is placed here (typically used with ket_ends)
3236 skipping TRUE for recursive calls when the value isn't actually going
3237 to be used (to allow for optimisation)
3239 Returns: NULL if expansion fails:
3240 expand_string_forcedfail is set TRUE if failure was forced
3241 expand_string_message contains a textual error message
3242 a pointer to the expanded string on success
3246 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3250 int size = Ustrlen(string)+ 64;
3252 uschar *yield = store_get(size);
3254 uschar *save_expand_nstring[EXPAND_MAXN+1];
3255 int save_expand_nlength[EXPAND_MAXN+1];
3256 BOOL resetok = TRUE;
3258 expand_string_forcedfail = FALSE;
3259 expand_string_message = US"";
3266 /* \ escapes the next character, which must exist, or else
3267 the expansion fails. There's a special escape, \N, which causes
3268 copying of the subject verbatim up to the next \N. Otherwise,
3269 the escapes are the standard set. */
3275 expand_string_message = US"\\ at end of string";
3282 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3283 yield = string_cat(yield, &size, &ptr, t, s - t);
3284 if (*s != 0) s += 2;
3290 ch[0] = string_interpret_escape(&s);
3292 yield = string_cat(yield, &size, &ptr, ch, 1);
3298 /* Anything other than $ is just copied verbatim, unless we are
3299 looking for a terminating } character. */
3301 if (ket_ends && *s == '}') break;
3305 yield = string_cat(yield, &size, &ptr, s++, 1);
3309 /* No { after the $ - must be a plain name or a number for string
3310 match variable. There has to be a fudge for variables that are the
3311 names of header fields preceded by "$header_" because header field
3312 names can contain any printing characters except space and colon.
3313 For those that don't like typing this much, "$h_" is a synonym for
3314 "$header_". A non-existent header yields a NULL value; nothing is
3317 if (isalpha((*(++s))))
3322 s = read_name(name, sizeof(name), s, US"_");
3324 /* If this is the first thing to be expanded, release the pre-allocated
3327 if (ptr == 0 && yield != NULL)
3329 if (resetok) store_reset(yield);
3336 if (Ustrncmp(name, "h_", 2) == 0 ||
3337 Ustrncmp(name, "rh_", 3) == 0 ||
3338 Ustrncmp(name, "bh_", 3) == 0 ||
3339 Ustrncmp(name, "header_", 7) == 0 ||
3340 Ustrncmp(name, "rheader_", 8) == 0 ||
3341 Ustrncmp(name, "bheader_", 8) == 0)
3343 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3344 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3345 s = read_header_name(name, sizeof(name), s);
3346 value = find_header(name, FALSE, &newsize, want_raw, charset);
3348 /* If we didn't find the header, and the header contains a closing brace
3349 character, this may be a user error where the terminating colon
3350 has been omitted. Set a flag to adjust the error message in this case.
3351 But there is no error here - nothing gets inserted. */
3355 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3364 value = find_variable(name, FALSE, skipping, &newsize);
3367 expand_string_message =
3368 string_sprintf("unknown variable name \"%s\"", name);
3369 check_variable_error_message(name);
3374 /* If the data is known to be in a new buffer, newsize will be set to the
3375 size of that buffer. If this is the first thing in an expansion string,
3376 yield will be NULL; just point it at the new store instead of copying. Many
3377 expansion strings contain just one reference, so this is a useful
3378 optimization, especially for humungous headers. */
3380 len = Ustrlen(value);
3381 if (yield == NULL && newsize != 0)
3387 else yield = string_cat(yield, &size, &ptr, value, len);
3395 s = read_number(&n, s);
3396 if (n >= 0 && n <= expand_nmax)
3397 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3402 /* Otherwise, if there's no '{' after $ it's an error. */
3406 expand_string_message = US"$ not followed by letter, digit, or {";
3410 /* After { there can be various things, but they all start with
3411 an initial word, except for a number for a string match variable. */
3413 if (isdigit((*(++s))))
3416 s = read_number(&n, s);
3419 expand_string_message = US"} expected after number";
3422 if (n >= 0 && n <= expand_nmax)
3423 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3430 expand_string_message = US"letter or digit expected after ${";
3434 /* Allow "-" in names to cater for substrings with negative
3435 arguments. Since we are checking for known names after { this is
3438 s = read_name(name, sizeof(name), s, US"_-");
3439 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3443 /* Handle conditionals - preserve the values of the numerical expansion
3444 variables in case they get changed by a regular expression match in the
3445 condition. If not, they retain their external settings. At the end
3446 of this "if" section, they get restored to their previous values. */
3452 int save_expand_nmax =
3453 save_expand_strings(save_expand_nstring, save_expand_nlength);
3455 while (isspace(*s)) s++;
3456 next_s = eval_condition(s, skipping? NULL : &cond);
3457 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3460 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3461 cond? "true" : "false");
3465 /* The handling of "yes" and "no" result strings is now in a separate
3466 function that is also used by ${lookup} and ${extract} and ${run}. */
3468 switch(process_yesno(
3469 skipping, /* were previously skipping */
3470 cond, /* success/failure indicator */
3471 lookup_value, /* value to reset for string2 */
3472 &s, /* input pointer */
3473 &yield, /* output pointer */
3474 &size, /* output size */
3475 &ptr, /* output current point */
3476 US"if")) /* condition type */
3478 case 1: goto EXPAND_FAILED; /* when all is well, the */
3479 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3482 /* Restore external setting of expansion variables for continuation
3485 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3486 save_expand_nlength);
3490 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3491 expanding an internal string that isn't actually going to be used. All we
3492 need to do is check the syntax, so don't do a lookup at all. Preserve the
3493 values of the numerical expansion variables in case they get changed by a
3494 partial lookup. If not, they retain their external settings. At the end
3495 of this "lookup" section, they get restored to their previous values. */
3499 int stype, partial, affixlen, starflags;
3500 int expand_setup = 0;
3502 uschar *key, *filename, *affix;
3503 uschar *save_lookup_value = lookup_value;
3504 int save_expand_nmax =
3505 save_expand_strings(save_expand_nstring, save_expand_nlength);
3507 if ((expand_forbid & RDO_LOOKUP) != 0)
3509 expand_string_message = US"lookup expansions are not permitted";
3513 /* Get the key we are to look up for single-key+file style lookups.
3514 Otherwise set the key NULL pro-tem. */
3516 while (isspace(*s)) s++;
3519 key = expand_string_internal(s+1, TRUE, &s, skipping);
3520 if (key == NULL) goto EXPAND_FAILED;
3521 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3522 while (isspace(*s)) s++;
3526 /* Find out the type of database */
3530 expand_string_message = US"missing lookup type";
3534 /* The type is a string that may contain special characters of various
3535 kinds. Allow everything except space or { to appear; the actual content
3536 is checked by search_findtype_partial. */
3538 while (*s != 0 && *s != '{' && !isspace(*s))
3540 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3544 while (isspace(*s)) s++;
3546 /* Now check for the individual search type and any partial or default
3547 options. Only those types that are actually in the binary are valid. */
3549 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3553 expand_string_message = search_error_message;
3557 /* Check that a key was provided for those lookup types that need it,
3558 and was not supplied for those that use the query style. */
3560 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3564 expand_string_message = string_sprintf("missing {key} for single-"
3565 "key \"%s\" lookup", name);
3573 expand_string_message = string_sprintf("a single key was given for "
3574 "lookup type \"%s\", which is not a single-key lookup type", name);
3579 /* Get the next string in brackets and expand it. It is the file name for
3580 single-key+file lookups, and the whole query otherwise. In the case of
3581 queries that also require a file name (e.g. sqlite), the file name comes
3584 if (*s != '{') goto EXPAND_FAILED_CURLY;
3585 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3586 if (filename == NULL) goto EXPAND_FAILED;
3587 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3588 while (isspace(*s)) s++;
3590 /* If this isn't a single-key+file lookup, re-arrange the variables
3591 to be appropriate for the search_ functions. For query-style lookups,
3592 there is just a "key", and no file name. For the special query-style +
3593 file types, the query (i.e. "key") starts with a file name. */
3597 while (isspace(*filename)) filename++;
3600 if (mac_islookup(stype, lookup_querystyle))
3606 if (*filename != '/')
3608 expand_string_message = string_sprintf(
3609 "absolute file name expected for \"%s\" lookup", name);
3612 while (*key != 0 && !isspace(*key)) key++;
3613 if (*key != 0) *key++ = 0;
3617 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3618 the entry was not found. Note that there is no search_close() function.
3619 Files are left open in case of re-use. At suitable places in higher logic,
3620 search_tidyup() is called to tidy all open files. This can save opening
3621 the same file several times. However, files may also get closed when
3622 others are opened, if too many are open at once. The rule is that a
3623 handle should not be used after a second search_open().
3625 Request that a partial search sets up $1 and maybe $2 by passing
3626 expand_setup containing zero. If its value changes, reset expand_nmax,
3627 since new variables will have been set. Note that at the end of this
3628 "lookup" section, the old numeric variables are restored. */
3631 lookup_value = NULL;
3634 void *handle = search_open(filename, stype, 0, NULL, NULL);
3637 expand_string_message = search_error_message;
3640 lookup_value = search_find(handle, filename, key, partial, affix,
3641 affixlen, starflags, &expand_setup);
3642 if (search_find_defer)
3644 expand_string_message =
3645 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3646 search_error_message);
3649 if (expand_setup > 0) expand_nmax = expand_setup;
3652 /* The handling of "yes" and "no" result strings is now in a separate
3653 function that is also used by ${if} and ${extract}. */
3655 switch(process_yesno(
3656 skipping, /* were previously skipping */
3657 lookup_value != NULL, /* success/failure indicator */
3658 save_lookup_value, /* value to reset for string2 */
3659 &s, /* input pointer */
3660 &yield, /* output pointer */
3661 &size, /* output size */
3662 &ptr, /* output current point */
3663 US"lookup")) /* condition type */
3665 case 1: goto EXPAND_FAILED; /* when all is well, the */
3666 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3669 /* Restore external setting of expansion variables for carrying on
3670 at this level, and continue. */
3672 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3673 save_expand_nlength);
3677 /* If Perl support is configured, handle calling embedded perl subroutines,
3678 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3679 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3680 arguments (defined below). */
3682 #define EXIM_PERL_MAX_ARGS 8
3686 expand_string_message = US"\"${perl\" encountered, but this facility "
3687 "is not included in this binary";
3690 #else /* EXIM_PERL */
3692 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3695 if ((expand_forbid & RDO_PERL) != 0)
3697 expand_string_message = US"Perl calls are not permitted";
3701 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3704 case 1: goto EXPAND_FAILED_CURLY;
3706 case 3: goto EXPAND_FAILED;
3709 /* If skipping, we don't actually do anything */
3711 if (skipping) continue;
3713 /* Start the interpreter if necessary */
3715 if (!opt_perl_started)
3718 if (opt_perl_startup == NULL)
3720 expand_string_message = US"A setting of perl_startup is needed when "
3721 "using the Perl interpreter";
3724 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3725 initerror = init_perl(opt_perl_startup);
3726 if (initerror != NULL)
3728 expand_string_message =
3729 string_sprintf("error in perl_startup code: %s\n", initerror);
3732 opt_perl_started = TRUE;
3735 /* Call the function */
3737 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3738 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3739 sub_arg[0], sub_arg + 1);
3741 /* NULL yield indicates failure; if the message pointer has been set to
3742 NULL, the yield was undef, indicating a forced failure. Otherwise the
3743 message will indicate some kind of Perl error. */
3745 if (new_yield == NULL)
3747 if (expand_string_message == NULL)
3749 expand_string_message =
3750 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3751 "failure", sub_arg[0]);
3752 expand_string_forcedfail = TRUE;
3757 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3758 set during a callback from Perl. */
3760 expand_string_forcedfail = FALSE;
3764 #endif /* EXIM_PERL */
3766 /* Transform email address to "prvs" scheme to use
3767 as BATV-signed return path */
3774 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3776 case 1: goto EXPAND_FAILED_CURLY;
3778 case 3: goto EXPAND_FAILED;
3781 /* If skipping, we don't actually do anything */
3782 if (skipping) continue;
3784 /* sub_arg[0] is the address */
3785 domain = Ustrrchr(sub_arg[0],'@');
3786 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3788 expand_string_message = US"prvs first argument must be a qualified email address";
3792 /* Calculate the hash. The second argument must be a single-digit
3793 key number, or unset. */
3795 if (sub_arg[2] != NULL &&
3796 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3798 expand_string_message = US"prvs second argument must be a single digit";
3802 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3805 expand_string_message = US"prvs hmac-sha1 conversion failed";
3809 /* Now separate the domain from the local part */
3812 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3813 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3814 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3815 string_cat(yield,&size,&ptr,p,6);
3816 string_cat(yield,&size,&ptr,US"=",1);
3817 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3818 string_cat(yield,&size,&ptr,US"@",1);
3819 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3824 /* Check a prvs-encoded address for validity */
3826 case EITEM_PRVSCHECK:
3829 int mysize = 0, myptr = 0;
3833 /* TF: Ugliness: We want to expand parameter 1 first, then set
3834 up expansion variables that are used in the expansion of
3835 parameter 2. So we clone the string for the first
3836 expansion, where we only expand parameter 1.
3838 PH: Actually, that isn't necessary. The read_subs() function is
3839 designed to work this way for the ${if and ${lookup expansions. I've
3843 /* Reset expansion variables */
3844 prvscheck_result = NULL;
3845 prvscheck_address = NULL;
3846 prvscheck_keynum = NULL;
3848 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3850 case 1: goto EXPAND_FAILED_CURLY;
3852 case 3: goto EXPAND_FAILED;
3855 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
3858 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3860 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
3861 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
3862 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
3863 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
3864 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3866 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3867 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3868 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3869 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3870 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3872 /* Set up expansion variables */
3873 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3874 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3875 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3876 prvscheck_address[myptr] = '\0';
3877 prvscheck_keynum = string_copy(key_num);
3879 /* Now expand the second argument */
3880 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3882 case 1: goto EXPAND_FAILED_CURLY;
3884 case 3: goto EXPAND_FAILED;
3887 /* Now we have the key and can check the address. */
3889 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3894 expand_string_message = US"hmac-sha1 conversion failed";
3898 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3899 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3901 if (Ustrcmp(p,hash) == 0)
3903 /* Success, valid BATV address. Now check the expiry date. */
3904 uschar *now = prvs_daystamp(0);
3905 unsigned int inow = 0,iexpire = 1;
3907 (void)sscanf(CS now,"%u",&inow);
3908 (void)sscanf(CS daystamp,"%u",&iexpire);
3910 /* When "iexpire" is < 7, a "flip" has occured.
3911 Adjust "inow" accordingly. */
3912 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3914 if (iexpire >= inow)
3916 prvscheck_result = US"1";
3917 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3921 prvscheck_result = NULL;
3922 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3927 prvscheck_result = NULL;
3928 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3931 /* Now expand the final argument. We leave this till now so that
3932 it can include $prvscheck_result. */
3934 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3936 case 1: goto EXPAND_FAILED_CURLY;
3938 case 3: goto EXPAND_FAILED;
3941 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3942 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3944 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3946 /* Reset the "internal" variables afterwards, because they are in
3947 dynamic store that will be reclaimed if the expansion succeeded. */
3949 prvscheck_address = NULL;
3950 prvscheck_keynum = NULL;
3954 /* Does not look like a prvs encoded address, return the empty string.
3955 We need to make sure all subs are expanded first, so as to skip over
3958 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3960 case 1: goto EXPAND_FAILED_CURLY;
3962 case 3: goto EXPAND_FAILED;
3969 /* Handle "readfile" to insert an entire file */
3971 case EITEM_READFILE:
3976 if ((expand_forbid & RDO_READFILE) != 0)
3978 expand_string_message = US"file insertions are not permitted";
3982 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3984 case 1: goto EXPAND_FAILED_CURLY;
3986 case 3: goto EXPAND_FAILED;
3989 /* If skipping, we don't actually do anything */
3991 if (skipping) continue;
3993 /* Open the file and read it */
3995 f = Ufopen(sub_arg[0], "rb");
3998 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4002 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4007 /* Handle "readsocket" to insert data from a Unix domain socket */
4009 case EITEM_READSOCK:
4015 struct sockaddr_un sockun; /* don't call this "sun" ! */
4019 if ((expand_forbid & RDO_READSOCK) != 0)
4021 expand_string_message = US"socket insertions are not permitted";
4025 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4026 because there may be a string for expansion on failure. */
4028 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4030 case 1: goto EXPAND_FAILED_CURLY;
4031 case 2: /* Won't occur: no end check */
4032 case 3: goto EXPAND_FAILED;
4035 /* Sort out timeout, if given */
4037 if (sub_arg[2] != NULL)
4039 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4042 expand_string_message = string_sprintf("bad time value %s",
4047 else sub_arg[3] = NULL; /* No eol if no timeout */
4049 /* If skipping, we don't actually do anything. Otherwise, arrange to
4050 connect to either an IP or a Unix socket. */
4054 /* Handle an IP (internet) domain */
4056 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4058 BOOL connected = FALSE;
4062 uschar *server_name = sub_arg[0] + 5;
4063 uschar *port_name = Ustrrchr(server_name, ':');
4065 /* Sort out the port */
4067 if (port_name == NULL)
4069 expand_string_message =
4070 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4073 *port_name++ = 0; /* Terminate server name */
4075 if (isdigit(*port_name))
4078 port = Ustrtol(port_name, &end, 0);
4079 if (end != port_name + Ustrlen(port_name))
4081 expand_string_message =
4082 string_sprintf("invalid port number %s", port_name);
4088 struct servent *service_info = getservbyname(CS port_name, "tcp");
4089 if (service_info == NULL)
4091 expand_string_message = string_sprintf("unknown port \"%s\"",
4095 port = ntohs(service_info->s_port);
4098 /* Sort out the server. */
4101 shost.address = NULL;
4105 namelen = Ustrlen(server_name);
4107 /* Anything enclosed in [] must be an IP address. */
4109 if (server_name[0] == '[' &&
4110 server_name[namelen - 1] == ']')
4112 server_name[namelen - 1] = 0;
4114 if (string_is_ip_address(server_name, NULL) == 0)
4116 expand_string_message =
4117 string_sprintf("malformed IP address \"%s\"", server_name);
4120 shost.name = shost.address = server_name;
4123 /* Otherwise check for an unadorned IP address */
4125 else if (string_is_ip_address(server_name, NULL) != 0)
4126 shost.name = shost.address = server_name;
4128 /* Otherwise lookup IP address(es) from the name */
4132 shost.name = server_name;
4133 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4134 FALSE) != HOST_FOUND)
4136 expand_string_message =
4137 string_sprintf("no IP address found for host %s", shost.name);
4142 /* Try to connect to the server - test each IP till one works */
4144 for (h = &shost; h != NULL; h = h->next)
4146 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4147 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4149 expand_string_message = string_sprintf("failed to create socket: "
4150 "%s", strerror(errno));
4154 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4163 expand_string_message = string_sprintf("failed to connect to "
4164 "socket %s: couldn't connect to any host", sub_arg[0],
4170 /* Handle a Unix domain socket */
4175 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4177 expand_string_message = string_sprintf("failed to create socket: %s",
4182 sockun.sun_family = AF_UNIX;
4183 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4186 sigalrm_seen = FALSE;
4188 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4192 expand_string_message = US "socket connect timed out";
4197 expand_string_message = string_sprintf("failed to connect to socket "
4198 "%s: %s", sub_arg[0], strerror(errno));
4203 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4205 /* Write the request string, if not empty */
4207 if (sub_arg[1][0] != 0)
4209 int len = Ustrlen(sub_arg[1]);
4210 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4212 if (write(fd, sub_arg[1], len) != len)
4214 expand_string_message = string_sprintf("request write to socket "
4215 "failed: %s", strerror(errno));
4220 /* Shut down the sending side of the socket. This helps some servers to
4221 recognise that it is their turn to do some work. Just in case some
4222 system doesn't have this function, make it conditional. */
4225 shutdown(fd, SHUT_WR);
4228 /* Now we need to read from the socket, under a timeout. The function
4229 that reads a file can be used. */
4231 f = fdopen(fd, "rb");
4232 sigalrm_seen = FALSE;
4234 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4238 /* After a timeout, we restore the pointer in the result, that is,
4239 make sure we add nothing from the socket. */
4244 expand_string_message = US "socket read timed out";
4249 /* The whole thing has worked (or we were skipping). If there is a
4250 failure string following, we need to skip it. */
4254 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
4256 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4257 while (isspace(*s)) s++;
4259 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4262 /* Come here on failure to create socket, connect socket, write to the
4263 socket, or timeout on reading. If another substring follows, expand and
4264 use it. Otherwise, those conditions give expand errors. */
4267 if (*s != '{') goto EXPAND_FAILED;
4268 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4269 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
4270 if (arg == NULL) goto EXPAND_FAILED;
4271 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4272 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4273 while (isspace(*s)) s++;
4274 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4278 /* Handle "run" to execute a program. */
4290 if ((expand_forbid & RDO_RUN) != 0)
4292 expand_string_message = US"running a command is not permitted";
4296 while (isspace(*s)) s++;
4297 if (*s != '{') goto EXPAND_FAILED_CURLY;
4298 arg = expand_string_internal(s+1, TRUE, &s, skipping);
4299 if (arg == NULL) goto EXPAND_FAILED;
4300 while (isspace(*s)) s++;
4301 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4303 if (skipping) /* Just pretend it worked when we're skipping */
4309 if (!transport_set_up_command(&argv, /* anchor for arg list */
4310 arg, /* raw command */
4311 FALSE, /* don't expand the arguments */
4312 0, /* not relevant when... */
4313 NULL, /* no transporting address */
4314 US"${run} expansion", /* for error messages */
4315 &expand_string_message)) /* where to put error message */
4320 /* Create the child process, making it a group leader. */
4322 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4326 expand_string_message =
4327 string_sprintf("couldn't create child process: %s", strerror(errno));
4331 /* Nothing is written to the standard input. */
4335 /* Wait for the process to finish, applying the timeout, and inspect its
4336 return code for serious disasters. Simple non-zero returns are passed on.
4339 if ((runrc = child_close(pid, 60)) < 0)
4343 expand_string_message = string_sprintf("command timed out");
4344 killpg(pid, SIGKILL); /* Kill the whole process group */
4347 else if (runrc == -257)
4348 expand_string_message = string_sprintf("wait() failed: %s",
4352 expand_string_message = string_sprintf("command killed by signal %d",
4358 /* Read the pipe to get the command's output into $value (which is kept
4359 in lookup_value). */
4361 f = fdopen(fd_out, "rb");
4362 lookup_value = NULL;
4363 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4367 /* Process the yes/no strings; $value may be useful in both cases */
4369 switch(process_yesno(
4370 skipping, /* were previously skipping */
4371 runrc == 0, /* success/failure indicator */
4372 lookup_value, /* value to reset for string2 */
4373 &s, /* input pointer */
4374 &yield, /* output pointer */
4375 &size, /* output size */
4376 &ptr, /* output current point */
4377 US"run")) /* condition type */
4379 case 1: goto EXPAND_FAILED; /* when all is well, the */
4380 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4386 /* Handle character translation for "tr" */
4394 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4396 case 1: goto EXPAND_FAILED_CURLY;
4398 case 3: goto EXPAND_FAILED;
4401 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4402 o2m = Ustrlen(sub[2]) - 1;
4404 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4406 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4410 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4417 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4418 expanded arguments. */
4428 int val[2] = { 0, -1 };
4431 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4432 Ensure that sub[2] is set in the ${length case. */
4435 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4438 case 1: goto EXPAND_FAILED_CURLY;
4440 case 3: goto EXPAND_FAILED;
4443 /* Juggle the arguments if there are only two of them: always move the
4444 string to the last position and make ${length{n}{str}} equivalent to
4445 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4451 if (item_type == EITEM_LENGTH)
4458 for (i = 0; i < 2; i++)
4460 if (sub[i] == NULL) continue;
4461 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4462 if (*ret != 0 || (i != 0 && val[i] < 0))
4464 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4465 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4471 (item_type == EITEM_HASH)?
4472 compute_hash(sub[2], val[0], val[1], &len) :
4473 (item_type == EITEM_NHASH)?
4474 compute_nhash(sub[2], val[0], val[1], &len) :
4475 extract_substr(sub[2], val[0], val[1], &len);
4477 if (ret == NULL) goto EXPAND_FAILED;
4478 yield = string_cat(yield, &size, &ptr, ret, len);
4482 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4483 This code originally contributed by Steve Haslam. It currently supports
4484 the use of MD5 and SHA-1 hashes.
4486 We need some workspace that is large enough to handle all the supported
4487 hash types. Use macros to set the sizes rather than be too elaborate. */
4489 #define MAX_HASHLEN 20
4490 #define MAX_HASHBLOCKLEN 64
4499 int hashlen; /* Number of octets for the hash algorithm's output */
4500 int hashblocklen; /* Number of octets the hash algorithm processes */
4502 unsigned int keylen;
4504 uschar keyhash[MAX_HASHLEN];
4505 uschar innerhash[MAX_HASHLEN];
4506 uschar finalhash[MAX_HASHLEN];
4507 uschar finalhash_hex[2*MAX_HASHLEN];
4508 uschar innerkey[MAX_HASHBLOCKLEN];
4509 uschar outerkey[MAX_HASHBLOCKLEN];
4511 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4513 case 1: goto EXPAND_FAILED_CURLY;
4515 case 3: goto EXPAND_FAILED;
4518 if (Ustrcmp(sub[0], "md5") == 0)
4521 use_base = &md5_base;
4525 else if (Ustrcmp(sub[0], "sha1") == 0)
4528 use_base = &sha1_base;
4534 expand_string_message =
4535 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4540 keylen = Ustrlen(keyptr);
4542 /* If the key is longer than the hash block length, then hash the key
4545 if (keylen > hashblocklen)
4547 chash_start(type, use_base);
4548 chash_end(type, use_base, keyptr, keylen, keyhash);
4553 /* Now make the inner and outer key values */
4555 memset(innerkey, 0x36, hashblocklen);
4556 memset(outerkey, 0x5c, hashblocklen);
4558 for (i = 0; i < keylen; i++)
4560 innerkey[i] ^= keyptr[i];
4561 outerkey[i] ^= keyptr[i];
4564 /* Now do the hashes */
4566 chash_start(type, use_base);
4567 chash_mid(type, use_base, innerkey);
4568 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4570 chash_start(type, use_base);
4571 chash_mid(type, use_base, outerkey);
4572 chash_end(type, use_base, innerhash, hashlen, finalhash);
4574 /* Encode the final hash as a hex string */
4577 for (i = 0; i < hashlen; i++)
4579 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4580 *p++ = hex_digits[finalhash[i] & 0x0f];
4583 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4584 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4586 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4591 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4592 We have to save the numerical variables and restore them afterwards. */
4597 int moffset, moffsetextra, slen;
4600 const uschar *rerror;
4603 int save_expand_nmax =
4604 save_expand_strings(save_expand_nstring, save_expand_nlength);
4606 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4608 case 1: goto EXPAND_FAILED_CURLY;
4610 case 3: goto EXPAND_FAILED;
4613 /* Compile the regular expression */
4615 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4620 expand_string_message = string_sprintf("regular expression error in "
4621 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4625 /* Now run a loop to do the substitutions as often as necessary. It ends
4626 when there are no more matches. Take care over matches of the null string;
4627 do the same thing as Perl does. */
4630 slen = Ustrlen(sub[0]);
4631 moffset = moffsetextra = 0;
4636 int ovector[3*(EXPAND_MAXN+1)];
4637 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4638 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4642 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4643 is not necessarily the end. We want to repeat the match from one
4644 character further along, but leaving the basic offset the same (for
4645 copying below). We can't be at the end of the string - that was checked
4646 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4647 finished; copy the remaining string and end the loop. */
4657 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4661 /* Match - set up for expanding the replacement. */
4663 if (n == 0) n = EXPAND_MAXN + 1;
4665 for (nn = 0; nn < n*2; nn += 2)
4667 expand_nstring[expand_nmax] = subject + ovector[nn];
4668 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4672 /* Copy the characters before the match, plus the expanded insertion. */
4674 yield = string_cat(yield, &size, &ptr, subject + moffset,
4675 ovector[0] - moffset);
4676 insert = expand_string(sub[2]);
4677 if (insert == NULL) goto EXPAND_FAILED;
4678 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4680 moffset = ovector[1];
4684 /* If we have matched an empty string, first check to see if we are at
4685 the end of the subject. If so, the loop is over. Otherwise, mimic
4686 what Perl's /g options does. This turns out to be rather cunning. First
4687 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4688 string at the same point. If this fails (picked up above) we advance to
4689 the next character. */
4691 if (ovector[0] == ovector[1])
4693 if (ovector[0] == slen) break;
4694 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4698 /* All done - restore numerical variables. */
4700 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4701 save_expand_nlength);
4705 /* Handle keyed and numbered substring extraction. If the first argument
4706 consists entirely of digits, then a numerical extraction is assumed. */
4712 int field_number = 1;
4713 BOOL field_number_set = FALSE;
4714 uschar *save_lookup_value = lookup_value;
4716 int save_expand_nmax =
4717 save_expand_strings(save_expand_nstring, save_expand_nlength);
4719 /* Read the arguments */
4721 for (i = 0; i < j; i++)
4723 while (isspace(*s)) s++;
4726 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4727 if (sub[i] == NULL) goto EXPAND_FAILED;
4728 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4730 /* After removal of leading and trailing white space, the first
4731 argument must not be empty; if it consists entirely of digits
4732 (optionally preceded by a minus sign), this is a numerical
4733 extraction, and we expect 3 arguments. */
4741 while (isspace(*p)) p++;
4745 while (len > 0 && isspace(p[len-1])) len--;
4748 if (*p == 0 && !skipping)
4750 expand_string_message = US"first argument of \"extract\" must "
4760 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4764 j = 3; /* Need 3 args */
4765 field_number_set = TRUE;
4769 else goto EXPAND_FAILED_CURLY;
4772 /* Extract either the numbered or the keyed substring into $value. If
4773 skipping, just pretend the extraction failed. */
4775 lookup_value = skipping? NULL : field_number_set?
4776 expand_gettokened(field_number, sub[1], sub[2]) :
4777 expand_getkeyed(sub[0], sub[1]);
4779 /* If no string follows, $value gets substituted; otherwise there can
4780 be yes/no strings, as for lookup or if. */
4782 switch(process_yesno(
4783 skipping, /* were previously skipping */
4784 lookup_value != NULL, /* success/failure indicator */
4785 save_lookup_value, /* value to reset for string2 */
4786 &s, /* input pointer */
4787 &yield, /* output pointer */
4788 &size, /* output size */
4789 &ptr, /* output current point */
4790 US"extract")) /* condition type */
4792 case 1: goto EXPAND_FAILED; /* when all is well, the */
4793 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4796 /* All done - restore numerical variables. */
4798 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4799 save_expand_nlength);
4805 /* Handle list operations */
4813 uschar outsep[2] = { '\0', '\0' };
4814 uschar *list, *expr, *temp;
4815 uschar *save_iterate_item = iterate_item;
4816 uschar *save_lookup_value = lookup_value;
4818 while (isspace(*s)) s++;
4819 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4821 list = expand_string_internal(s, TRUE, &s, skipping);
4822 if (list == NULL) goto EXPAND_FAILED;
4823 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4825 if (item_type == EITEM_REDUCE)
4827 while (isspace(*s)) s++;
4828 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4829 temp = expand_string_internal(s, TRUE, &s, skipping);
4830 if (temp == NULL) goto EXPAND_FAILED;
4831 lookup_value = temp;
4832 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4835 while (isspace(*s)) s++;
4836 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4840 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
4841 if scanning a "false" part). This allows us to find the end of the
4842 condition, because if the list is empty, we won't actually evaluate the
4843 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
4844 the normal internal expansion function. */
4846 if (item_type == EITEM_FILTER)
4848 temp = eval_condition(expr, NULL);
4849 if (temp != NULL) s = temp;
4853 temp = expand_string_internal(s, TRUE, &s, TRUE);
4858 expand_string_message = string_sprintf("%s inside \"%s\" item",
4859 expand_string_message, name);
4863 while (isspace(*s)) s++;
4866 expand_string_message = string_sprintf("missing } at end of condition "
4867 "or expression inside \"%s\"", name);
4871 while (isspace(*s)) s++;
4874 expand_string_message = string_sprintf("missing } at end of \"%s\"",
4879 /* If we are skipping, we can now just move on to the next item. When
4880 processing for real, we perform the iteration. */
4882 if (skipping) continue;
4883 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
4885 *outsep = (uschar)sep; /* Separator as a string */
4887 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
4889 if (item_type == EITEM_FILTER)
4892 if (eval_condition(expr, &condresult) == NULL)
4894 iterate_item = save_iterate_item;
4895 lookup_value = save_lookup_value;
4896 expand_string_message = string_sprintf("%s inside \"%s\" condition",
4897 expand_string_message, name);
4900 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
4901 condresult? "true":"false");
4903 temp = iterate_item; /* TRUE => include this item */
4905 continue; /* FALSE => skip this item */
4908 /* EITEM_MAP and EITEM_REDUCE */
4912 temp = expand_string_internal(expr, TRUE, NULL, skipping);
4915 iterate_item = save_iterate_item;
4916 expand_string_message = string_sprintf("%s inside \"%s\" item",
4917 expand_string_message, name);
4920 if (item_type == EITEM_REDUCE)
4922 lookup_value = temp; /* Update the value of $value */
4923 continue; /* and continue the iteration */
4927 /* We reach here for FILTER if the condition is true, always for MAP,
4928 and never for REDUCE. The value in "temp" is to be added to the output
4929 list that is being created, ensuring that any occurrences of the
4930 separator character are doubled. Unless we are dealing with the first
4931 item of the output list, add in a space if the new item begins with the
4932 separator character, or is an empty string. */
4934 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
4935 yield = string_cat(yield, &size, &ptr, US" ", 1);
4937 /* Add the string in "temp" to the output list that we are building,
4938 This is done in chunks by searching for the separator character. */
4942 size_t seglen = Ustrcspn(temp, outsep);
4943 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
4945 /* If we got to the end of the string we output one character
4946 too many; backup and end the loop. Otherwise arrange to double the
4949 if (temp[seglen] == '\0') { ptr--; break; }
4950 yield = string_cat(yield, &size, &ptr, outsep, 1);
4954 /* Output a separator after the string: we will remove the redundant
4955 final one at the end. */
4957 yield = string_cat(yield, &size, &ptr, outsep, 1);
4958 } /* End of iteration over the list loop */
4960 /* REDUCE has generated no output above: output the final value of
4963 if (item_type == EITEM_REDUCE)
4965 yield = string_cat(yield, &size, &ptr, lookup_value,
4966 Ustrlen(lookup_value));
4967 lookup_value = save_lookup_value; /* Restore $value */
4970 /* FILTER and MAP generate lists: if they have generated anything, remove
4971 the redundant final separator. Even though an empty item at the end of a
4972 list does not count, this is tidier. */
4974 else if (ptr != save_ptr) ptr--;
4976 /* Restore preserved $item */
4978 iterate_item = save_iterate_item;
4983 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4984 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4985 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4986 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4988 #define EXPAND_DLFUNC_MAX_ARGS 8
4991 #ifndef EXPAND_DLFUNC
4992 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4993 "is not included in this binary";
4996 #else /* EXPAND_DLFUNC */
4999 exim_dlfunc_t *func;
5002 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5004 if ((expand_forbid & RDO_DLFUNC) != 0)
5006 expand_string_message =
5007 US"dynamically-loaded functions are not permitted";
5011 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5014 case 1: goto EXPAND_FAILED_CURLY;
5016 case 3: goto EXPAND_FAILED;
5019 /* If skipping, we don't actually do anything */
5021 if (skipping) continue;
5023 /* Look up the dynamically loaded object handle in the tree. If it isn't
5024 found, dlopen() the file and put the handle in the tree for next time. */
5026 t = tree_search(dlobj_anchor, argv[0]);
5029 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5032 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5033 argv[0], dlerror());
5034 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5037 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5038 Ustrcpy(t->name, argv[0]);
5039 t->data.ptr = handle;
5040 (void)tree_insertnode(&dlobj_anchor, t);
5043 /* Having obtained the dynamically loaded object handle, look up the
5044 function pointer. */
5046 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5049 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5050 "%s", argv[1], argv[0], dlerror());
5051 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5055 /* Call the function and work out what to do with the result. If it
5056 returns OK, we have a replacement string; if it returns DEFER then
5057 expansion has failed in a non-forced manner; if it returns FAIL then
5058 failure was forced; if it returns ERROR or any other value there's a
5059 problem, so panic slightly. In any case, assume that the function has
5060 side-effects on the store that must be preserved. */
5064 for (argc = 0; argv[argc] != NULL; argc++);
5065 status = func(&result, argc - 2, &argv[2]);
5068 if (result == NULL) result = US"";
5069 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5074 expand_string_message = result == NULL ? US"(no message)" : result;
5075 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5076 else if(status != FAIL)
5077 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5078 argv[0], argv[1], status, expand_string_message);
5082 #endif /* EXPAND_DLFUNC */
5085 /* Control reaches here if the name is not recognized as one of the more
5086 complicated expansion items. Check for the "operator" syntax (name terminated
5087 by a colon). Some of the operators have arguments, separated by _ from the
5094 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
5095 if (sub == NULL) goto EXPAND_FAILED;
5098 /* Owing to an historical mis-design, an underscore may be part of the
5099 operator name, or it may introduce arguments. We therefore first scan the
5100 table of names that contain underscores. If there is no match, we cut off
5101 the arguments and then scan the main table. */
5103 c = chop_match(name, op_table_underscore,
5104 sizeof(op_table_underscore)/sizeof(uschar *));
5108 arg = Ustrchr(name, '_');
5109 if (arg != NULL) *arg = 0;
5110 c = chop_match(name, op_table_main,
5111 sizeof(op_table_main)/sizeof(uschar *));
5112 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5113 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5116 /* If we are skipping, we don't need to perform the operation at all.
5117 This matters for operations like "mask", because the data may not be
5118 in the correct format when skipping. For example, the expression may test
5119 for the existence of $sender_host_address before trying to mask it. For
5120 other operations, doing them may not fail, but it is a waste of time. */
5122 if (skipping && c >= 0) continue;
5124 /* Otherwise, switch on the operator type */
5131 unsigned long int n = Ustrtoul(sub, &t, 10);
5134 expand_string_message = string_sprintf("argument for base62 "
5135 "operator is \"%s\", which is not a decimal number", sub);
5138 t = string_base62(n);
5139 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5143 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5149 unsigned long int n = 0;
5152 uschar *t = Ustrchr(base62_chars, *tt++);
5155 expand_string_message = string_sprintf("argument for base62d "
5156 "operator is \"%s\", which is not a base %d number", sub,
5160 n = n * BASE_62 + (t - base62_chars);
5162 (void)sprintf(CS buf, "%ld", n);
5163 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5169 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
5170 if (expanded == NULL)
5172 expand_string_message =
5173 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5174 expand_string_message);
5177 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5184 uschar *t = sub - 1;
5185 while (*(++t) != 0) { *t = tolower(*t); count++; }
5186 yield = string_cat(yield, &size, &ptr, sub, count);
5193 uschar *t = sub - 1;
5194 while (*(++t) != 0) { *t = toupper(*t); count++; }
5195 yield = string_cat(yield, &size, &ptr, sub, count);
5206 md5_end(&base, sub, Ustrlen(sub), digest);
5207 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5208 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5219 sha1_end(&base, sub, Ustrlen(sub), digest);
5220 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5221 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5225 /* Convert hex encoding to base64 encoding */
5235 for (enc = sub; *enc != 0; enc++)
5237 if (!isxdigit(*enc))
5239 expand_string_message = string_sprintf("\"%s\" is not a hex "
5248 expand_string_message = string_sprintf("\"%s\" contains an odd "
5249 "number of characters", sub);
5253 while ((c = *in++) != 0)
5255 if (isdigit(c)) c -= '0';
5256 else c = toupper(c) - 'A' + 10;
5268 enc = auth_b64encode(sub, out - sub);
5269 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5273 /* mask applies a mask to an IP address; for example the result of
5274 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5281 int mask, maskoffset;
5282 int type = string_is_ip_address(sub, &maskoffset);
5287 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5292 if (maskoffset == 0)
5294 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5299 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5301 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5303 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5308 /* Convert the address to binary integer(s) and apply the mask */
5310 sub[maskoffset] = 0;
5311 count = host_aton(sub, binary);
5312 host_mask(count, binary, mask);
5314 /* Convert to masked textual format and add to output. */
5316 yield = string_cat(yield, &size, &ptr, buffer,
5317 host_nmtoa(count, binary, mask, buffer, '.'));
5322 case EOP_LOCAL_PART:
5326 int start, end, domain;
5327 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5331 if (c != EOP_DOMAIN)
5333 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5334 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5336 else if (domain != 0)
5339 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5347 uschar outsep[2] = { ':', '\0' };
5348 uschar *address, *error;
5350 int start, end, domain; /* Not really used */
5352 while (isspace(*sub)) sub++;
5353 if (*sub == '>') { *outsep = *++sub; ++sub; }
5354 parse_allow_group = TRUE;
5358 uschar *p = parse_find_address_end(sub, FALSE);
5359 uschar saveend = *p;
5361 address = parse_extract_address(sub, &error, &start, &end, &domain,
5365 /* Add the address to the output list that we are building. This is
5366 done in chunks by searching for the separator character. At the
5367 start, unless we are dealing with the first address of the output
5368 list, add in a space if the new address begins with the separator
5369 character, or is an empty string. */
5371 if (address != NULL)
5373 if (ptr != save_ptr && address[0] == *outsep)
5374 yield = string_cat(yield, &size, &ptr, US" ", 1);
5378 size_t seglen = Ustrcspn(address, outsep);
5379 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5381 /* If we got to the end of the string we output one character
5384 if (address[seglen] == '\0') { ptr--; break; }
5385 yield = string_cat(yield, &size, &ptr, outsep, 1);
5386 address += seglen + 1;
5389 /* Output a separator after the string: we will remove the
5390 redundant final one at the end. */
5392 yield = string_cat(yield, &size, &ptr, outsep, 1);
5395 if (saveend == '\0') break;
5399 /* If we have generated anything, remove the redundant final
5402 if (ptr != save_ptr) ptr--;
5403 parse_allow_group = FALSE;
5408 /* quote puts a string in quotes if it is empty or contains anything
5409 other than alphamerics, underscore, dot, or hyphen.
5411 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5412 be quoted in order to be a valid local part.
5414 In both cases, newlines and carriage returns are converted into \n and \r
5418 case EOP_QUOTE_LOCAL_PART:
5421 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5422 uschar *t = sub - 1;
5426 while (!needs_quote && *(++t) != 0)
5427 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5429 else /* EOP_QUOTE_LOCAL_PART */
5431 while (!needs_quote && *(++t) != 0)
5432 needs_quote = !isalnum(*t) &&
5433 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5434 (*t != '.' || t == sub || t[1] == 0);
5439 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5444 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5445 else if (*t == '\r')
5446 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5449 if (*t == '\\' || *t == '"')
5450 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5451 yield = string_cat(yield, &size, &ptr, t, 1);
5454 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5456 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5460 /* quote_lookuptype does lookup-specific quoting */
5465 uschar *opt = Ustrchr(arg, '_');
5467 if (opt != NULL) *opt++ = 0;
5469 n = search_findtype(arg, Ustrlen(arg));
5472 expand_string_message = search_error_message;
5476 if (lookup_list[n].quote != NULL)
5477 sub = (lookup_list[n].quote)(sub, opt);
5478 else if (opt != NULL) sub = NULL;
5482 expand_string_message = string_sprintf(
5483 "\"%s\" unrecognized after \"${quote_%s\"",
5488 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5492 /* rx quote sticks in \ before any non-alphameric character so that
5493 the insertion works in a regular expression. */
5497 uschar *t = sub - 1;
5501 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5502 yield = string_cat(yield, &size, &ptr, t, 1);
5507 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5508 prescribed by the RFC, if there are characters that need to be encoded */
5512 uschar buffer[2048];
5513 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5514 buffer, sizeof(buffer), FALSE);
5515 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5519 /* RFC 2047 decode */
5525 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5526 headers_charset, '?', &len, &error);
5529 expand_string_message = error;
5532 yield = string_cat(yield, &size, &ptr, decoded, len);
5536 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5546 if (c > 255) c = '_';
5548 yield = string_cat(yield, &size, &ptr, buff, 1);
5553 /* escape turns all non-printing characters into escape sequences. */
5557 uschar *t = string_printing(sub);
5558 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5562 /* Handle numeric expression evaluation */
5567 uschar *save_sub = sub;
5568 uschar *error = NULL;
5569 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5572 expand_string_message = string_sprintf("error in expression "
5573 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5577 sprintf(CS var_buffer, "%d", n);
5578 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5582 /* Handle time period formating */
5586 int n = readconf_readtime(sub, 0, FALSE);
5589 expand_string_message = string_sprintf("string \"%s\" is not an "
5590 "Exim time interval in \"%s\" operator", sub, name);
5593 sprintf(CS var_buffer, "%d", n);
5594 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5598 case EOP_TIME_INTERVAL:
5601 uschar *t = read_number(&n, sub);
5602 if (*t != 0) /* Not A Number*/
5604 expand_string_message = string_sprintf("string \"%s\" is not a "
5605 "positive number in \"%s\" operator", sub, name);
5608 t = readconf_printtime(n);
5609 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5613 /* Convert string to base64 encoding */
5617 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5618 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5622 /* strlen returns the length of the string */
5627 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5628 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5632 /* length_n or l_n takes just the first n characters or the whole string,
5633 whichever is the shorter;
5635 substr_m_n, and s_m_n take n characters from offset m; negative m take
5636 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5637 takes the rest, either to the right or to the left.
5639 hash_n or h_n makes a hash of length n from the string, yielding n
5640 characters from the set a-z; hash_n_m makes a hash of length n, but
5641 uses m characters from the set a-zA-Z0-9.
5643 nhash_n returns a single number between 0 and n-1 (in text form), while
5644 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5645 between 0 and n-1 and the second between 0 and m-1. */
5665 expand_string_message = string_sprintf("missing values after %s",
5670 /* "length" has only one argument, effectively being synonymous with
5673 if (c == EOP_LENGTH || c == EOP_L)
5679 /* The others have one or two arguments; for "substr" the first may be
5680 negative. The second being negative means "not supplied". */
5685 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5688 /* Read up to two numbers, separated by underscores */
5693 if (arg != ret && *arg == '_' && pn == &value1)
5697 if (arg[1] != 0) arg++;
5699 else if (!isdigit(*arg))
5701 expand_string_message =
5702 string_sprintf("non-digit after underscore in \"%s\"", name);
5705 else *pn = (*pn)*10 + *arg++ - '0';
5709 /* Perform the required operation */
5712 (c == EOP_HASH || c == EOP_H)?
5713 compute_hash(sub, value1, value2, &len) :
5714 (c == EOP_NHASH || c == EOP_NH)?
5715 compute_nhash(sub, value1, value2, &len) :
5716 extract_substr(sub, value1, value2, &len);
5718 if (ret == NULL) goto EXPAND_FAILED;
5719 yield = string_cat(yield, &size, &ptr, ret, len);
5729 uschar **modetable[3];
5734 if ((expand_forbid & RDO_EXISTS) != 0)
5736 expand_string_message = US"Use of the stat() expansion is not permitted";
5740 if (stat(CS sub, &st) < 0)
5742 expand_string_message = string_sprintf("stat(%s) failed: %s",
5743 sub, strerror(errno));
5747 switch (mode & S_IFMT)
5749 case S_IFIFO: smode[0] = 'p'; break;
5750 case S_IFCHR: smode[0] = 'c'; break;
5751 case S_IFDIR: smode[0] = 'd'; break;
5752 case S_IFBLK: smode[0] = 'b'; break;
5753 case S_IFREG: smode[0] = '-'; break;
5754 default: smode[0] = '?'; break;
5757 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5758 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5759 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5761 for (i = 0; i < 3; i++)
5763 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5768 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5769 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5770 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5771 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5772 (long)st.st_gid, st.st_size, (long)st.st_atime,
5773 (long)st.st_mtime, (long)st.st_ctime);
5774 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5778 /* pseudo-random number less than N */
5785 max = expand_string_integer(sub, TRUE);
5786 if (expand_string_message != NULL)
5788 s = string_sprintf("%d", pseudo_random_number(max));
5789 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5793 /* Unknown operator */
5796 expand_string_message =
5797 string_sprintf("unknown expansion operator \"%s\"", name);
5802 /* Handle a plain name. If this is the first thing in the expansion, release
5803 the pre-allocated buffer. If the result data is known to be in a new buffer,
5804 newsize will be set to the size of that buffer, and we can just point at that
5805 store instead of copying. Many expansion strings contain just one reference,
5806 so this is a useful optimization, especially for humungous headers
5807 ($message_headers). */
5815 if (resetok) store_reset(yield);
5819 value = find_variable(name, FALSE, skipping, &newsize);
5822 expand_string_message =
5823 string_sprintf("unknown variable in \"${%s}\"", name);
5824 check_variable_error_message(name);
5827 len = Ustrlen(value);
5828 if (yield == NULL && newsize != 0)
5834 else yield = string_cat(yield, &size, &ptr, value, len);
5838 /* Else there's something wrong */
5840 expand_string_message =
5841 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5842 "in a variable reference)", name);
5846 /* If we hit the end of the string when ket_ends is set, there is a missing
5847 terminating brace. */
5849 if (ket_ends && *s == 0)
5851 expand_string_message = malformed_header?
5852 US"missing } at end of string - could be header name not terminated by colon"
5854 US"missing } at end of string";
5858 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5859 added to the string. If so, set up an empty string. Add a terminating zero. If
5860 left != NULL, return a pointer to the terminator. */
5862 if (yield == NULL) yield = store_get(1);
5864 if (left != NULL) *left = s;
5866 /* Any stacking store that was used above the final string is no longer needed.
5867 In many cases the final string will be the first one that was got and so there
5868 will be optimal store usage. */
5870 if (resetok) store_reset(yield + ptr + 1);
5873 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5875 if (skipping) debug_printf("skipping: result is not used\n");
5879 /* This is the failure exit: easiest to program with a goto. We still need
5880 to update the pointer to the terminator, for cases of nested calls with "fail".
5883 EXPAND_FAILED_CURLY:
5884 expand_string_message = malformed_header?
5885 US"missing or misplaced { or } - could be header name not terminated by colon"
5887 US"missing or misplaced { or }";
5889 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5890 that is a bad idea, because expand_string_message is in dynamic store. */
5893 if (left != NULL) *left = s;
5896 debug_printf("failed to expand: %s\n", string);
5897 debug_printf(" error message: %s\n", expand_string_message);
5898 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5904 /* This is the external function call. Do a quick check for any expansion
5905 metacharacters, and if there are none, just return the input string.
5907 Argument: the string to be expanded
5908 Returns: the expanded string, or NULL if expansion failed; if failure was
5909 due to a lookup deferring, search_find_defer will be TRUE
5913 expand_string(uschar *string)
5915 search_find_defer = FALSE;
5916 malformed_header = FALSE;
5917 return (Ustrpbrk(string, "$\\") == NULL)? string :
5918 expand_string_internal(string, FALSE, NULL, FALSE);
5923 /*************************************************
5925 *************************************************/
5927 /* Now and again we want to expand a string and be sure that the result is in a
5928 new bit of store. This function does that.
5930 Argument: the string to be expanded
5931 Returns: the expanded string, always in a new bit of store, or NULL
5935 expand_string_copy(uschar *string)
5937 uschar *yield = expand_string(string);
5938 if (yield == string) yield = string_copy(string);
5944 /*************************************************
5945 * Expand and interpret as an integer *
5946 *************************************************/
5948 /* Expand a string, and convert the result into an integer.
5951 string the string to be expanded
5952 isplus TRUE if a non-negative number is expected
5954 Returns: the integer value, or
5955 -1 for an expansion error ) in both cases, message in
5956 -2 for an integer interpretation error ) expand_string_message
5957 expand_string_message is set NULL for an OK integer
5961 expand_string_integer(uschar *string, BOOL isplus)
5964 uschar *s = expand_string(string);
5965 uschar *msg = US"invalid integer \"%s\"";
5968 /* If expansion failed, expand_string_message will be set. */
5970 if (s == NULL) return -1;
5972 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5973 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5974 systems, so we set it zero ourselves. */
5977 expand_string_message = NULL; /* Indicates no error */
5979 /* Before Exim 4.64, strings consisting entirely of whitespace compared
5980 equal to 0. Unfortunately, people actually relied upon that, so preserve
5981 the behaviour explicitly. Stripping leading whitespace is a harmless
5982 noop change since strtol skips it anyway (provided that there is a number
5986 while (isspace(*s)) ++s;
5990 debug_printf("treating blank string as number 0\n");
5995 value = strtol(CS s, CSS &endptr, 10);
5999 msg = US"integer expected but \"%s\" found";
6001 else if (value < 0 && isplus)
6003 msg = US"non-negative integer expected but \"%s\" found";
6007 /* Ensure we can cast this down to an int */
6008 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
6010 if (errno != ERANGE)
6012 if (tolower(*endptr) == 'k')
6014 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
6018 else if (tolower(*endptr) == 'm')
6020 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
6022 else value *= 1024*1024;
6026 if (errno == ERANGE)
6027 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6030 while (isspace(*endptr)) endptr++;
6031 if (*endptr == 0) return (int)value;
6035 expand_string_message = string_sprintf(CS msg, s);
6040 /*************************************************
6041 **************************************************
6042 * Stand-alone test program *
6043 **************************************************
6044 *************************************************/
6050 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6052 int ovector[3*(EXPAND_MAXN+1)];
6053 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6054 ovector, sizeof(ovector)/sizeof(int));
6055 BOOL yield = n >= 0;
6056 if (n == 0) n = EXPAND_MAXN + 1;
6060 expand_nmax = (setup < 0)? 0 : setup + 1;
6061 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6063 expand_nstring[expand_nmax] = subject + ovector[nn];
6064 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6072 int main(int argc, uschar **argv)
6075 uschar buffer[1024];
6077 debug_selector = D_v;
6078 debug_file = stderr;
6079 debug_fd = fileno(debug_file);
6080 big_buffer = malloc(big_buffer_size);
6082 for (i = 1; i < argc; i++)
6084 if (argv[i][0] == '+')
6086 debug_trace_memory = 2;
6089 if (isdigit(argv[i][0]))
6090 debug_selector = Ustrtol(argv[i], NULL, 0);
6092 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6096 eldap_default_servers = argv[i];
6099 mysql_servers = argv[i];
6102 pgsql_servers = argv[i];
6106 else opt_perl_startup = argv[i];
6110 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6112 expand_nstring[1] = US"string 1....";
6113 expand_nlength[1] = 8;
6117 if (opt_perl_startup != NULL)
6120 printf("Starting Perl interpreter\n");
6121 errstr = init_perl(opt_perl_startup);
6124 printf("** error in perl_startup code: %s\n", errstr);
6125 return EXIT_FAILURE;
6128 #endif /* EXIM_PERL */
6130 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6132 void *reset_point = store_get(0);
6133 uschar *yield = expand_string(buffer);
6136 printf("%s\n", yield);
6137 store_reset(reset_point);
6141 if (search_find_defer) printf("search_find deferred\n");
6142 printf("Failed: %s\n", expand_string_message);
6143 if (expand_string_forcedfail) printf("Forced failure\n");
6155 /* End of expand.c */