1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for handling string expansion. */
14 /* Recursively called function */
16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
19 #ifndef SUPPORT_CRYPTEQ
20 #define SUPPORT_CRYPTEQ
25 #include "lookups/ldap.h"
28 #ifdef SUPPORT_CRYPTEQ
33 extern char* crypt16(char*, char*);
37 /* The handling of crypt16() is a mess. I will record below the analysis of the
38 mess that was sent to me. We decided, however, to make changing this very low
39 priority, because in practice people are moving away from the crypt()
40 algorithms nowadays, so it doesn't seem worth it.
43 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
44 the first 8 characters of the password using a 20-round version of crypt
45 (standard crypt does 25 rounds). It then crypts the next 8 characters,
46 or an empty block if the password is less than 9 characters, using a
47 20-round version of crypt and the same salt as was used for the first
48 block. Charaters after the first 16 are ignored. It always generates
49 a 16-byte hash, which is expressed together with the salt as a string
50 of 24 base 64 digits. Here are some links to peruse:
52 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
53 http://seclists.org/bugtraq/1999/Mar/0076.html
55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
56 and OSF/1. This is the same as the standard crypt if given a password
57 of 8 characters or less. If given more, it first does the same as crypt
58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
59 using as salt the first two base 64 digits from the first hash block.
60 If the password is more than 16 characters then it crypts the 17th to 24th
61 characters using as salt the first two base 64 digits from the second hash
62 block. And so on: I've seen references to it cutting off the password at
63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
65 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
66 http://seclists.org/bugtraq/1999/Mar/0109.html
67 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
68 TET1_html/sec.c222.html#no_id_208
70 Exim has something it calls "crypt16". It will either use a native
71 crypt16 or its own implementation. A native crypt16 will presumably
72 be the one that I called "crypt16" above. The internal "crypt16"
73 function, however, is a two-block-maximum implementation of what I called
74 "bigcrypt". The documentation matches the internal code.
76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
77 that crypt16 and bigcrypt were different things.
79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
80 to whatever it is using under that name. This unfortunately sets a
81 precedent for using "{crypt16}" to identify two incompatible algorithms
82 whose output can't be distinguished. With "{crypt16}" thus rendered
83 ambiguous, I suggest you deprecate it and invent two new identifiers
84 for the two algorithms.
86 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
87 of the password separately means they can be cracked separately, so
88 the double-length hash only doubles the cracking effort instead of
89 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
97 /*************************************************
98 * Local statics and tables *
99 *************************************************/
101 /* Table of item names, and corresponding switch numbers. The names must be in
102 alphabetical order. */
104 static uschar *item_table[] = {
148 /* Tables of operator names, and corresponding switch numbers. The names must be
149 in alphabetical order. There are two tables, because underscore is used in some
150 cases to introduce arguments, whereas for other it is part of the name. This is
151 an historical mis-design. */
153 static uschar *op_table_underscore[] = {
156 US"quote_local_part",
164 EOP_QUOTE_LOCAL_PART,
169 static uschar *op_table_main[] = {
203 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
236 /* Table of condition names, and corresponding switch numbers. The names must
237 be in alphabetical order. */
239 static uschar *cond_table[] = {
243 US"==", /* Backward compatibility */
273 US"match_local_part",
297 ECOND_FIRST_DELIVERY,
316 ECOND_MATCH_LOCAL_PART,
326 /* Type for main variable table */
334 /* Type for entries pointing to address/length pairs. Not currently
342 /* Types of table entry */
345 vtype_int, /* value is address of int */
346 vtype_filter_int, /* ditto, but recognized only when filtering */
347 vtype_ino, /* value is address of ino_t (not always an int) */
348 vtype_uid, /* value is address of uid_t (not always an int) */
349 vtype_gid, /* value is address of gid_t (not always an int) */
350 vtype_stringptr, /* value is address of pointer to string */
351 vtype_msgbody, /* as stringptr, but read when first required */
352 vtype_msgbody_end, /* ditto, the end of the message */
353 vtype_msgheaders, /* the message's headers, processed */
354 vtype_msgheaders_raw, /* the message's headers, unprocessed */
355 vtype_localpart, /* extract local part from string */
356 vtype_domain, /* extract domain from string */
357 vtype_recipients, /* extract recipients from recipients list */
358 /* (available only in system filters, ACLs, and */
360 vtype_todbsdin, /* value not used; generate BSD inbox tod */
361 vtype_tode, /* value not used; generate tod in epoch format */
362 vtype_todf, /* value not used; generate full tod */
363 vtype_todl, /* value not used; generate log tod */
364 vtype_todlf, /* value not used; generate log file datestamp tod */
365 vtype_todzone, /* value not used; generate time zone only */
366 vtype_todzulu, /* value not used; generate zulu tod */
367 vtype_reply, /* value not used; get reply from headers */
368 vtype_pid, /* value not used; result is pid */
369 vtype_host_lookup, /* value not used; get host name */
370 vtype_load_avg, /* value not used; result is int from os_getloadavg */
371 vtype_pspace, /* partition space; value is T/F for spool/log */
372 vtype_pinodes /* partition inodes; value is T/F for spool/log */
374 ,vtype_dkim /* Lookup of value in DKIM signature */
378 /* This table must be kept in alphabetical order. */
380 static var_entry var_table[] = {
381 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
382 they will be confused with user-creatable ACL variables. */
383 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
384 { "address_data", vtype_stringptr, &deliver_address_data },
385 { "address_file", vtype_stringptr, &address_file },
386 { "address_pipe", vtype_stringptr, &address_pipe },
387 { "authenticated_id", vtype_stringptr, &authenticated_id },
388 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
389 { "authentication_failed",vtype_int, &authentication_failed },
390 #ifdef WITH_CONTENT_SCAN
391 { "av_failed", vtype_int, &av_failed },
393 #ifdef EXPERIMENTAL_BRIGHTMAIL
394 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
395 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
396 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
397 { "bmi_deliver", vtype_int, &bmi_deliver },
399 { "body_linecount", vtype_int, &body_linecount },
400 { "body_zerocount", vtype_int, &body_zerocount },
401 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
402 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
403 { "caller_gid", vtype_gid, &real_gid },
404 { "caller_uid", vtype_uid, &real_uid },
405 { "compile_date", vtype_stringptr, &version_date },
406 { "compile_number", vtype_stringptr, &version_cnumber },
407 { "csa_status", vtype_stringptr, &csa_status },
408 #ifdef EXPERIMENTAL_DCC
409 { "dcc_header", vtype_stringptr, &dcc_header },
410 { "dcc_result", vtype_stringptr, &dcc_result },
412 #ifdef WITH_OLD_DEMIME
413 { "demime_errorlevel", vtype_int, &demime_errorlevel },
414 { "demime_reason", vtype_stringptr, &demime_reason },
417 { "dkim_algo", vtype_dkim, (void *)DKIM_ALGO },
418 { "dkim_bodylength", vtype_dkim, (void *)DKIM_BODYLENGTH },
419 { "dkim_canon_body", vtype_dkim, (void *)DKIM_CANON_BODY },
420 { "dkim_canon_headers", vtype_dkim, (void *)DKIM_CANON_HEADERS },
421 { "dkim_copiedheaders", vtype_dkim, (void *)DKIM_COPIEDHEADERS },
422 { "dkim_created", vtype_dkim, (void *)DKIM_CREATED },
423 { "dkim_cur_signer", vtype_stringptr, &dkim_cur_signer },
424 { "dkim_domain", vtype_stringptr, &dkim_signing_domain },
425 { "dkim_expires", vtype_dkim, (void *)DKIM_EXPIRES },
426 { "dkim_headernames", vtype_dkim, (void *)DKIM_HEADERNAMES },
427 { "dkim_identity", vtype_dkim, (void *)DKIM_IDENTITY },
428 { "dkim_key_granularity",vtype_dkim, (void *)DKIM_KEY_GRANULARITY },
429 { "dkim_key_nosubdomains",vtype_dkim, (void *)DKIM_NOSUBDOMAINS },
430 { "dkim_key_notes", vtype_dkim, (void *)DKIM_KEY_NOTES },
431 { "dkim_key_srvtype", vtype_dkim, (void *)DKIM_KEY_SRVTYPE },
432 { "dkim_key_testing", vtype_dkim, (void *)DKIM_KEY_TESTING },
433 { "dkim_selector", vtype_stringptr, &dkim_signing_selector },
434 { "dkim_signers", vtype_stringptr, &dkim_signers },
435 { "dkim_verify_reason", vtype_dkim, (void *)DKIM_VERIFY_REASON },
436 { "dkim_verify_status", vtype_dkim, (void *)DKIM_VERIFY_STATUS},
438 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
439 { "dnslist_matched", vtype_stringptr, &dnslist_matched },
440 { "dnslist_text", vtype_stringptr, &dnslist_text },
441 { "dnslist_value", vtype_stringptr, &dnslist_value },
442 { "domain", vtype_stringptr, &deliver_domain },
443 { "domain_data", vtype_stringptr, &deliver_domain_data },
444 { "exim_gid", vtype_gid, &exim_gid },
445 { "exim_path", vtype_stringptr, &exim_path },
446 { "exim_uid", vtype_uid, &exim_uid },
447 #ifdef WITH_OLD_DEMIME
448 { "found_extension", vtype_stringptr, &found_extension },
450 { "home", vtype_stringptr, &deliver_home },
451 { "host", vtype_stringptr, &deliver_host },
452 { "host_address", vtype_stringptr, &deliver_host_address },
453 { "host_data", vtype_stringptr, &host_data },
454 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
455 { "host_lookup_failed", vtype_int, &host_lookup_failed },
456 { "inode", vtype_ino, &deliver_inode },
457 { "interface_address", vtype_stringptr, &interface_address },
458 { "interface_port", vtype_int, &interface_port },
459 { "item", vtype_stringptr, &iterate_item },
461 { "ldap_dn", vtype_stringptr, &eldap_dn },
463 { "load_average", vtype_load_avg, NULL },
464 { "local_part", vtype_stringptr, &deliver_localpart },
465 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
466 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
467 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
468 { "local_scan_data", vtype_stringptr, &local_scan_data },
469 { "local_user_gid", vtype_gid, &local_user_gid },
470 { "local_user_uid", vtype_uid, &local_user_uid },
471 { "localhost_number", vtype_int, &host_number },
472 { "log_inodes", vtype_pinodes, (void *)FALSE },
473 { "log_space", vtype_pspace, (void *)FALSE },
474 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
475 #ifdef WITH_CONTENT_SCAN
476 { "malware_name", vtype_stringptr, &malware_name },
478 { "max_received_linelength", vtype_int, &max_received_linelength },
479 { "message_age", vtype_int, &message_age },
480 { "message_body", vtype_msgbody, &message_body },
481 { "message_body_end", vtype_msgbody_end, &message_body_end },
482 { "message_body_size", vtype_int, &message_body_size },
483 { "message_exim_id", vtype_stringptr, &message_id },
484 { "message_headers", vtype_msgheaders, NULL },
485 { "message_headers_raw", vtype_msgheaders_raw, NULL },
486 { "message_id", vtype_stringptr, &message_id },
487 { "message_linecount", vtype_int, &message_linecount },
488 { "message_size", vtype_int, &message_size },
489 #ifdef WITH_CONTENT_SCAN
490 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
491 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
492 { "mime_boundary", vtype_stringptr, &mime_boundary },
493 { "mime_charset", vtype_stringptr, &mime_charset },
494 { "mime_content_description", vtype_stringptr, &mime_content_description },
495 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
496 { "mime_content_id", vtype_stringptr, &mime_content_id },
497 { "mime_content_size", vtype_int, &mime_content_size },
498 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
499 { "mime_content_type", vtype_stringptr, &mime_content_type },
500 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
501 { "mime_filename", vtype_stringptr, &mime_filename },
502 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
503 { "mime_is_multipart", vtype_int, &mime_is_multipart },
504 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
505 { "mime_part_count", vtype_int, &mime_part_count },
507 { "n0", vtype_filter_int, &filter_n[0] },
508 { "n1", vtype_filter_int, &filter_n[1] },
509 { "n2", vtype_filter_int, &filter_n[2] },
510 { "n3", vtype_filter_int, &filter_n[3] },
511 { "n4", vtype_filter_int, &filter_n[4] },
512 { "n5", vtype_filter_int, &filter_n[5] },
513 { "n6", vtype_filter_int, &filter_n[6] },
514 { "n7", vtype_filter_int, &filter_n[7] },
515 { "n8", vtype_filter_int, &filter_n[8] },
516 { "n9", vtype_filter_int, &filter_n[9] },
517 { "original_domain", vtype_stringptr, &deliver_domain_orig },
518 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
519 { "originator_gid", vtype_gid, &originator_gid },
520 { "originator_uid", vtype_uid, &originator_uid },
521 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
522 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
523 { "pid", vtype_pid, NULL },
524 { "primary_hostname", vtype_stringptr, &primary_hostname },
525 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
526 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
527 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
528 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
529 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
530 { "rcpt_count", vtype_int, &rcpt_count },
531 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
532 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
533 { "received_count", vtype_int, &received_count },
534 { "received_for", vtype_stringptr, &received_for },
535 { "received_ip_address", vtype_stringptr, &interface_address },
536 { "received_port", vtype_int, &interface_port },
537 { "received_protocol", vtype_stringptr, &received_protocol },
538 { "received_time", vtype_int, &received_time },
539 { "recipient_data", vtype_stringptr, &recipient_data },
540 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
541 { "recipients", vtype_recipients, NULL },
542 { "recipients_count", vtype_int, &recipients_count },
543 #ifdef WITH_CONTENT_SCAN
544 { "regex_match_string", vtype_stringptr, ®ex_match_string },
546 { "reply_address", vtype_reply, NULL },
547 { "return_path", vtype_stringptr, &return_path },
548 { "return_size_limit", vtype_int, &bounce_return_size_limit },
549 { "runrc", vtype_int, &runrc },
550 { "self_hostname", vtype_stringptr, &self_hostname },
551 { "sender_address", vtype_stringptr, &sender_address },
552 { "sender_address_data", vtype_stringptr, &sender_address_data },
553 { "sender_address_domain", vtype_domain, &sender_address },
554 { "sender_address_local_part", vtype_localpart, &sender_address },
555 { "sender_data", vtype_stringptr, &sender_data },
556 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
557 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
558 { "sender_host_address", vtype_stringptr, &sender_host_address },
559 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
560 { "sender_host_name", vtype_host_lookup, NULL },
561 { "sender_host_port", vtype_int, &sender_host_port },
562 { "sender_ident", vtype_stringptr, &sender_ident },
563 { "sender_rate", vtype_stringptr, &sender_rate },
564 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
565 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
566 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
567 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
568 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
569 { "sending_port", vtype_int, &sending_port },
570 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
571 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
572 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
573 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
574 { "smtp_notquit_reason", vtype_stringptr, &smtp_notquit_reason },
575 { "sn0", vtype_filter_int, &filter_sn[0] },
576 { "sn1", vtype_filter_int, &filter_sn[1] },
577 { "sn2", vtype_filter_int, &filter_sn[2] },
578 { "sn3", vtype_filter_int, &filter_sn[3] },
579 { "sn4", vtype_filter_int, &filter_sn[4] },
580 { "sn5", vtype_filter_int, &filter_sn[5] },
581 { "sn6", vtype_filter_int, &filter_sn[6] },
582 { "sn7", vtype_filter_int, &filter_sn[7] },
583 { "sn8", vtype_filter_int, &filter_sn[8] },
584 { "sn9", vtype_filter_int, &filter_sn[9] },
585 #ifdef WITH_CONTENT_SCAN
586 { "spam_bar", vtype_stringptr, &spam_bar },
587 { "spam_report", vtype_stringptr, &spam_report },
588 { "spam_score", vtype_stringptr, &spam_score },
589 { "spam_score_int", vtype_stringptr, &spam_score_int },
591 #ifdef EXPERIMENTAL_SPF
592 { "spf_guess", vtype_stringptr, &spf_guess },
593 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
594 { "spf_received", vtype_stringptr, &spf_received },
595 { "spf_result", vtype_stringptr, &spf_result },
596 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
598 { "spool_directory", vtype_stringptr, &spool_directory },
599 { "spool_inodes", vtype_pinodes, (void *)TRUE },
600 { "spool_space", vtype_pspace, (void *)TRUE },
601 #ifdef EXPERIMENTAL_SRS
602 { "srs_db_address", vtype_stringptr, &srs_db_address },
603 { "srs_db_key", vtype_stringptr, &srs_db_key },
604 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
605 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
606 { "srs_recipient", vtype_stringptr, &srs_recipient },
607 { "srs_status", vtype_stringptr, &srs_status },
609 { "thisaddress", vtype_stringptr, &filter_thisaddress },
610 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
611 { "tls_cipher", vtype_stringptr, &tls_cipher },
612 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
613 { "tod_bsdinbox", vtype_todbsdin, NULL },
614 { "tod_epoch", vtype_tode, NULL },
615 { "tod_full", vtype_todf, NULL },
616 { "tod_log", vtype_todl, NULL },
617 { "tod_logfile", vtype_todlf, NULL },
618 { "tod_zone", vtype_todzone, NULL },
619 { "tod_zulu", vtype_todzulu, NULL },
620 { "value", vtype_stringptr, &lookup_value },
621 { "version_number", vtype_stringptr, &version_string },
622 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
623 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
624 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
625 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
626 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
627 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
630 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
631 static uschar var_buffer[256];
632 static BOOL malformed_header;
634 /* For textual hashes */
636 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
637 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
640 enum { HMAC_MD5, HMAC_SHA1 };
642 /* For numeric hashes */
644 static unsigned int prime[] = {
645 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
646 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
647 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
649 /* For printing modes in symbolic form */
651 static uschar *mtable_normal[] =
652 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
654 static uschar *mtable_setid[] =
655 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
657 static uschar *mtable_sticky[] =
658 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
662 /*************************************************
663 * Tables for UTF-8 support *
664 *************************************************/
666 /* Table of the number of extra characters, indexed by the first character
667 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
670 static uschar utf8_table1[] = {
671 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
672 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
673 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
674 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
676 /* These are the masks for the data bits in the first byte of a character,
677 indexed by the number of additional bytes. */
679 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
681 /* Get the next UTF-8 character, advancing the pointer. */
683 #define GETUTF8INC(c, ptr) \
685 if ((c & 0xc0) == 0xc0) \
687 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
689 c = (c & utf8_table2[a]) << s; \
693 c |= (*ptr++ & 0x3f) << s; \
698 /*************************************************
699 * Binary chop search on a table *
700 *************************************************/
702 /* This is used for matching expansion items and operators.
705 name the name that is being sought
706 table the table to search
707 table_size the number of items in the table
709 Returns: the offset in the table, or -1
713 chop_match(uschar *name, uschar **table, int table_size)
715 uschar **bot = table;
716 uschar **top = table + table_size;
720 uschar **mid = bot + (top - bot)/2;
721 int c = Ustrcmp(name, *mid);
722 if (c == 0) return mid - table;
723 if (c > 0) bot = mid + 1; else top = mid;
731 /*************************************************
732 * Check a condition string *
733 *************************************************/
735 /* This function is called to expand a string, and test the result for a "true"
736 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
737 forced fail or lookup defer. All store used by the function can be released on
740 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
743 condition the condition string
744 m1 text to be incorporated in panic error
747 Returns: TRUE if condition is met, FALSE if not
751 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
754 void *reset_point = store_get(0);
755 uschar *ss = expand_string(condition);
758 if (!expand_string_forcedfail && !search_find_defer)
759 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
760 "for %s %s: %s", condition, m1, m2, expand_string_message);
763 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
764 strcmpic(ss, US"false") != 0;
765 store_reset(reset_point);
771 /*************************************************
772 * Pseudo-random number generation *
773 *************************************************/
775 /* Pseudo-random number generation. The result is not "expected" to be
776 cryptographically strong but not so weak that someone will shoot themselves
777 in the foot using it as a nonce in some email header scheme or whatever
778 weirdness they'll twist this into. The result should ideally handle fork().
780 However, if we're stuck unable to provide this, then we'll fall back to
781 appallingly bad randomness.
783 If SUPPORT_TLS is defined and OpenSSL is used, then this will not be used.
784 The GNUTLS randomness functions found do not seem amenable to extracting
785 random numbers outside of a TLS context. Any volunteers?
789 Returns a random number in range [0, max-1]
792 #if !defined(SUPPORT_TLS) || defined(USE_GNUTLS)
794 pseudo_random_number(int max)
796 static pid_t pid = 0;
798 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
808 #ifdef HAVE_ARC4RANDOM
809 /* cryptographically strong randomness, common on *BSD platforms, not
810 so much elsewhere. Alas. */
812 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
813 #ifdef HAVE_SRANDOMDEV
814 /* uses random(4) for seeding */
817 gettimeofday(&tv, NULL);
818 srandom(tv.tv_sec | tv.tv_usec | getpid());
821 /* Poor randomness and no seeding here */
828 #ifdef HAVE_ARC4RANDOM
829 return arc4random() % max;
830 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
831 return random() % max;
833 /* This one returns a 16-bit number, definitely not crypto-strong */
834 return random_number(max);
840 /*************************************************
841 * Pick out a name from a string *
842 *************************************************/
844 /* If the name is too long, it is silently truncated.
847 name points to a buffer into which to put the name
848 max is the length of the buffer
849 s points to the first alphabetic character of the name
850 extras chars other than alphanumerics to permit
852 Returns: pointer to the first character after the name
854 Note: The test for *s != 0 in the while loop is necessary because
855 Ustrchr() yields non-NULL if the character is zero (which is not something
859 read_name(uschar *name, int max, uschar *s, uschar *extras)
862 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
864 if (ptr < max-1) name[ptr++] = *s;
873 /*************************************************
874 * Pick out the rest of a header name *
875 *************************************************/
877 /* A variable name starting $header_ (or just $h_ for those who like
878 abbreviations) might not be the complete header name because headers can
879 contain any printing characters in their names, except ':'. This function is
880 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
881 on the end, if the name was terminated by white space.
884 name points to a buffer in which the name read so far exists
885 max is the length of the buffer
886 s points to the first character after the name so far, i.e. the
887 first non-alphameric character after $header_xxxxx
889 Returns: a pointer to the first character after the header name
893 read_header_name(uschar *name, int max, uschar *s)
895 int prelen = Ustrchr(name, '_') - name + 1;
896 int ptr = Ustrlen(name) - prelen;
897 if (ptr > 0) memmove(name, name+prelen, ptr);
898 while (mac_isgraph(*s) && *s != ':')
900 if (ptr < max-1) name[ptr++] = *s;
911 /*************************************************
912 * Pick out a number from a string *
913 *************************************************/
916 n points to an integer into which to put the number
917 s points to the first digit of the number
919 Returns: a pointer to the character after the last digit
923 read_number(int *n, uschar *s)
926 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
932 /*************************************************
933 * Extract keyed subfield from a string *
934 *************************************************/
936 /* The yield is in dynamic store; NULL means that the key was not found.
939 key points to the name of the key
940 s points to the string from which to extract the subfield
942 Returns: NULL if the subfield was not found, or
943 a pointer to the subfield's data
947 expand_getkeyed(uschar *key, uschar *s)
949 int length = Ustrlen(key);
950 while (isspace(*s)) s++;
952 /* Loop to search for the key */
960 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
961 dkeylength = s - dkey;
962 while (isspace(*s)) s++;
963 if (*s == '=') while (isspace((*(++s))));
965 data = string_dequote(&s);
966 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
969 while (isspace(*s)) s++;
978 /*************************************************
979 * Extract numbered subfield from string *
980 *************************************************/
982 /* Extracts a numbered field from a string that is divided by tokens - for
983 example a line from /etc/passwd is divided by colon characters. First field is
984 numbered one. Negative arguments count from the right. Zero returns the whole
985 string. Returns NULL if there are insufficient tokens in the string
988 Modifies final argument - this is a dynamically generated string, so that's OK.
991 field number of field to be extracted,
992 first field = 1, whole string = 0, last field = -1
993 separators characters that are used to break string into tokens
994 s points to the string from which to extract the subfield
996 Returns: NULL if the field was not found,
997 a pointer to the field's data inside s (modified to add 0)
1001 expand_gettokened (int field, uschar *separators, uschar *s)
1006 uschar *fieldtext = NULL;
1008 if (field == 0) return s;
1010 /* Break the line up into fields in place; for field > 0 we stop when we have
1011 done the number of fields we want. For field < 0 we continue till the end of
1012 the string, counting the number of fields. */
1014 count = (field > 0)? field : INT_MAX;
1020 /* Previous field was the last one in the string. For a positive field
1021 number, this means there are not enough fields. For a negative field number,
1022 check that there are enough, and scan back to find the one that is wanted. */
1026 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1027 if ((-field) == (INT_MAX - count - 1)) return s;
1031 while (ss[-1] != 0) ss--;
1037 /* Previous field was not last in the string; save its start and put a
1041 len = Ustrcspn(ss, separators);
1052 /*************************************************
1053 * Extract a substring from a string *
1054 *************************************************/
1056 /* Perform the ${substr or ${length expansion operations.
1059 subject the input string
1060 value1 the offset from the start of the input string to the start of
1061 the output string; if negative, count from the right.
1062 value2 the length of the output string, or negative (-1) for unset
1063 if value1 is positive, unset means "all after"
1064 if value1 is negative, unset means "all before"
1065 len set to the length of the returned string
1067 Returns: pointer to the output string, or NULL if there is an error
1071 extract_substr(uschar *subject, int value1, int value2, int *len)
1073 int sublen = Ustrlen(subject);
1075 if (value1 < 0) /* count from right */
1079 /* If the position is before the start, skip to the start, and adjust the
1080 length. If the length ends up negative, the substring is null because nothing
1081 can precede. This falls out naturally when the length is unset, meaning "all
1087 if (value2 < 0) value2 = 0;
1091 /* Otherwise an unset length => characters before value1 */
1093 else if (value2 < 0)
1100 /* For a non-negative offset, if the starting position is past the end of the
1101 string, the result will be the null string. Otherwise, an unset length means
1102 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1106 if (value1 > sublen)
1111 else if (value2 < 0) value2 = sublen;
1114 /* Cut the length down to the maximum possible for the offset value, and get
1115 the required characters. */
1117 if (value1 + value2 > sublen) value2 = sublen - value1;
1119 return subject + value1;
1125 /*************************************************
1126 * Old-style hash of a string *
1127 *************************************************/
1129 /* Perform the ${hash expansion operation.
1132 subject the input string (an expanded substring)
1133 value1 the length of the output string; if greater or equal to the
1134 length of the input string, the input string is returned
1135 value2 the number of hash characters to use, or 26 if negative
1136 len set to the length of the returned string
1138 Returns: pointer to the output string, or NULL if there is an error
1142 compute_hash(uschar *subject, int value1, int value2, int *len)
1144 int sublen = Ustrlen(subject);
1146 if (value2 < 0) value2 = 26;
1147 else if (value2 > Ustrlen(hashcodes))
1149 expand_string_message =
1150 string_sprintf("hash count \"%d\" too big", value2);
1154 /* Calculate the hash text. We know it is shorter than the original string, so
1155 can safely place it in subject[] (we know that subject is always itself an
1156 expanded substring). */
1158 if (value1 < sublen)
1163 while ((c = (subject[j])) != 0)
1165 int shift = (c + j++) & 7;
1166 subject[i] ^= (c << shift) | (c >> (8-shift));
1167 if (++i >= value1) i = 0;
1169 for (i = 0; i < value1; i++)
1170 subject[i] = hashcodes[(subject[i]) % value2];
1172 else value1 = sublen;
1181 /*************************************************
1182 * Numeric hash of a string *
1183 *************************************************/
1185 /* Perform the ${nhash expansion operation. The first characters of the
1186 string are treated as most important, and get the highest prime numbers.
1189 subject the input string
1190 value1 the maximum value of the first part of the result
1191 value2 the maximum value of the second part of the result,
1192 or negative to produce only a one-part result
1193 len set to the length of the returned string
1195 Returns: pointer to the output string, or NULL if there is an error.
1199 compute_nhash (uschar *subject, int value1, int value2, int *len)
1201 uschar *s = subject;
1203 unsigned long int total = 0; /* no overflow */
1207 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1208 total += prime[i--] * (unsigned int)(*s++);
1211 /* If value2 is unset, just compute one number */
1215 s = string_sprintf("%d", total % value1);
1218 /* Otherwise do a div/mod hash */
1222 total = total % (value1 * value2);
1223 s = string_sprintf("%d/%d", total/value2, total % value2);
1234 /*************************************************
1235 * Find the value of a header or headers *
1236 *************************************************/
1238 /* Multiple instances of the same header get concatenated, and this function
1239 can also return a concatenation of all the header lines. When concatenating
1240 specific headers that contain lists of addresses, a comma is inserted between
1241 them. Otherwise we use a straight concatenation. Because some messages can have
1242 pathologically large number of lines, there is a limit on the length that is
1243 returned. Also, to avoid massive store use which would result from using
1244 string_cat() as it copies and extends strings, we do a preliminary pass to find
1245 out exactly how much store will be needed. On "normal" messages this will be
1249 name the name of the header, without the leading $header_ or $h_,
1250 or NULL if a concatenation of all headers is required
1251 exists_only TRUE if called from a def: test; don't need to build a string;
1252 just return a string that is not "" and not "0" if the header
1254 newsize return the size of memory block that was obtained; may be NULL
1255 if exists_only is TRUE
1256 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1257 other than concatenating, will be done on the header. Also used
1258 for $message_headers_raw.
1259 charset name of charset to translate MIME words to; used only if
1260 want_raw is false; if NULL, no translation is done (this is
1261 used for $bh_ and $bheader_)
1263 Returns: NULL if the header does not exist, else a pointer to a new
1268 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1271 BOOL found = name == NULL;
1273 int len = found? 0 : Ustrlen(name);
1275 uschar *yield = NULL;
1278 /* Loop for two passes - saves code repetition */
1280 for (i = 0; i < 2; i++)
1285 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1287 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1289 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1294 if (exists_only) return US"1"; /* don't need actual string */
1296 t = h->text + len; /* text to insert */
1297 if (!want_raw) /* unless wanted raw, */
1298 while (isspace(*t)) t++; /* remove leading white space */
1299 ilen = h->slen - (t - h->text); /* length to insert */
1301 /* Unless wanted raw, remove trailing whitespace, including the
1305 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1307 /* Set comma = 1 if handling a single header and it's one of those
1308 that contains an address list, except when asked for raw headers. Only
1309 need to do this once. */
1311 if (!want_raw && name != NULL && comma == 0 &&
1312 Ustrchr("BCFRST", h->type) != NULL)
1315 /* First pass - compute total store needed; second pass - compute
1316 total store used, including this header. */
1318 size += ilen + comma + 1; /* +1 for the newline */
1320 /* Second pass - concatentate the data, up to a maximum. Note that
1321 the loop stops when size hits the limit. */
1325 if (size > header_insert_maxlen)
1327 ilen -= size - header_insert_maxlen - 1;
1330 Ustrncpy(ptr, t, ilen);
1333 /* For a non-raw header, put in the comma if needed, then add
1334 back the newline we removed above, provided there was some text in
1337 if (!want_raw && ilen > 0)
1339 if (comma != 0) *ptr++ = ',';
1347 /* At end of first pass, return NULL if no header found. Then truncate size
1348 if necessary, and get the buffer to hold the data, returning the buffer size.
1353 if (!found) return NULL;
1354 if (size > header_insert_maxlen) size = header_insert_maxlen;
1355 *newsize = size + 1;
1356 ptr = yield = store_get(*newsize);
1360 /* That's all we do for raw header expansion. */
1367 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1368 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1369 function can return an error with decoded data if the charset translation
1370 fails. If decoding fails, it returns NULL. */
1374 uschar *decoded, *error;
1375 if (ptr > yield && ptr[-1] == '\n') ptr--;
1376 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1378 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1382 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1383 " input was: %s\n", error, yield);
1385 if (decoded != NULL) yield = decoded;
1394 /*************************************************
1395 * Find value of a variable *
1396 *************************************************/
1398 /* The table of variables is kept in alphabetic order, so we can search it
1399 using a binary chop. The "choplen" variable is nothing to do with the binary
1403 name the name of the variable being sought
1404 exists_only TRUE if this is a def: test; passed on to find_header()
1405 skipping TRUE => skip any processing evaluation; this is not the same as
1406 exists_only because def: may test for values that are first
1408 newsize pointer to an int which is initially zero; if the answer is in
1409 a new memory buffer, *newsize is set to its size
1411 Returns: NULL if the variable does not exist, or
1412 a pointer to the variable's contents, or
1413 something non-NULL if exists_only is TRUE
1417 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1420 int last = var_table_size;
1422 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1423 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1424 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1425 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1426 (this gave backwards compatibility at the changeover). There may be built-in
1427 variables whose names start acl_ but they should never start in this way. This
1428 slightly messy specification is a consequence of the history, needless to say.
1430 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1431 set, in which case give an error. */
1433 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1437 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1438 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1441 /* Handle $auth<n> variables. */
1443 if (Ustrncmp(name, "auth", 4) == 0)
1446 int n = Ustrtoul(name + 4, &endptr, 10);
1447 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1448 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1451 /* For all other variables, search the table */
1453 while (last > first)
1457 int middle = (first + last)/2;
1458 int c = Ustrcmp(name, var_table[middle].name);
1460 if (c > 0) { first = middle + 1; continue; }
1461 if (c < 0) { last = middle; continue; }
1463 /* Found an existing variable. If in skipping state, the value isn't needed,
1464 and we want to avoid processing (such as looking up the host name). */
1466 if (skipping) return US"";
1468 switch (var_table[middle].type)
1470 case vtype_filter_int:
1471 if (!filter_running) return NULL;
1475 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1479 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1483 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1487 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1490 case vtype_stringptr: /* Pointer to string */
1491 s = *((uschar **)(var_table[middle].value));
1492 return (s == NULL)? US"" : s;
1495 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1498 case vtype_load_avg:
1499 sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1502 case vtype_host_lookup: /* Lookup if not done so */
1503 if (sender_host_name == NULL && sender_host_address != NULL &&
1504 !host_lookup_failed && host_name_lookup() == OK)
1505 host_build_sender_fullhost();
1506 return (sender_host_name == NULL)? US"" : sender_host_name;
1508 case vtype_localpart: /* Get local part from address */
1509 s = *((uschar **)(var_table[middle].value));
1510 if (s == NULL) return US"";
1511 domain = Ustrrchr(s, '@');
1512 if (domain == NULL) return s;
1513 if (domain - s > sizeof(var_buffer) - 1)
1514 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1515 "string expansion", sizeof(var_buffer));
1516 Ustrncpy(var_buffer, s, domain - s);
1517 var_buffer[domain - s] = 0;
1520 case vtype_domain: /* Get domain from address */
1521 s = *((uschar **)(var_table[middle].value));
1522 if (s == NULL) return US"";
1523 domain = Ustrrchr(s, '@');
1524 return (domain == NULL)? US"" : domain + 1;
1526 case vtype_msgheaders:
1527 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1529 case vtype_msgheaders_raw:
1530 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1532 case vtype_msgbody: /* Pointer to msgbody string */
1533 case vtype_msgbody_end: /* Ditto, the end of the msg */
1534 ss = (uschar **)(var_table[middle].value);
1535 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1538 off_t start_offset = SPOOL_DATA_START_OFFSET;
1539 int len = message_body_visible;
1540 if (len > message_size) len = message_size;
1541 *ss = body = store_malloc(len+1);
1543 if (var_table[middle].type == vtype_msgbody_end)
1545 struct stat statbuf;
1546 if (fstat(deliver_datafile, &statbuf) == 0)
1548 start_offset = statbuf.st_size - len;
1549 if (start_offset < SPOOL_DATA_START_OFFSET)
1550 start_offset = SPOOL_DATA_START_OFFSET;
1553 lseek(deliver_datafile, start_offset, SEEK_SET);
1554 len = read(deliver_datafile, body, len);
1558 if (message_body_newlines) /* Separate loops for efficiency */
1561 { if (body[--len] == 0) body[len] = ' '; }
1566 { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1570 return (*ss == NULL)? US"" : *ss;
1572 case vtype_todbsdin: /* BSD inbox time of day */
1573 return tod_stamp(tod_bsdin);
1575 case vtype_tode: /* Unix epoch time of day */
1576 return tod_stamp(tod_epoch);
1578 case vtype_todf: /* Full time of day */
1579 return tod_stamp(tod_full);
1581 case vtype_todl: /* Log format time of day */
1582 return tod_stamp(tod_log_bare); /* (without timezone) */
1584 case vtype_todzone: /* Time zone offset only */
1585 return tod_stamp(tod_zone);
1587 case vtype_todzulu: /* Zulu time */
1588 return tod_stamp(tod_zulu);
1590 case vtype_todlf: /* Log file datestamp tod */
1591 return tod_stamp(tod_log_datestamp_daily);
1593 case vtype_reply: /* Get reply address */
1594 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1596 if (s != NULL) while (isspace(*s)) s++;
1597 if (s == NULL || *s == 0)
1599 *newsize = 0; /* For the *s==0 case */
1600 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1605 while (isspace(*s)) s++;
1606 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1607 while (t > s && isspace(t[-1])) t--;
1610 return (s == NULL)? US"" : s;
1612 /* A recipients list is available only during system message filtering,
1613 during ACL processing after DATA, and while expanding pipe commands
1614 generated from a system filter, but not elsewhere. */
1616 case vtype_recipients:
1617 if (!enable_dollar_recipients) return NULL; else
1622 s = store_get(size);
1623 for (i = 0; i < recipients_count; i++)
1625 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1626 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1627 Ustrlen(recipients_list[i].address));
1629 s[ptr] = 0; /* string_cat() leaves room */
1636 sprintf(CS var_buffer, "%d",
1637 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1644 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1645 sprintf(CS var_buffer, "%d", inodes);
1649 #ifndef DISABLE_DKIM
1651 return dkim_exim_expand_query((int)(long)var_table[middle].value);
1657 return NULL; /* Unknown variable name */
1663 /*************************************************
1664 * Read and expand substrings *
1665 *************************************************/
1667 /* This function is called to read and expand argument substrings for various
1668 expansion items. Some have a minimum requirement that is less than the maximum;
1669 in these cases, the first non-present one is set to NULL.
1672 sub points to vector of pointers to set
1673 n maximum number of substrings
1675 sptr points to current string pointer
1676 skipping the skipping flag
1677 check_end if TRUE, check for final '}'
1678 name name of item, for error message
1680 Returns: 0 OK; string pointer updated
1681 1 curly bracketing error (too few arguments)
1682 2 too many arguments (only if check_end is set); message set
1683 3 other error (expansion failure)
1687 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1688 BOOL check_end, uschar *name)
1693 while (isspace(*s)) s++;
1694 for (i = 0; i < n; i++)
1698 if (i < m) return 1;
1702 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1703 if (sub[i] == NULL) return 3;
1704 if (*s++ != '}') return 1;
1705 while (isspace(*s)) s++;
1707 if (check_end && *s++ != '}')
1711 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1712 "(max is %d)", name, n);
1725 /*************************************************
1726 * Elaborate message for bad variable *
1727 *************************************************/
1729 /* For the "unknown variable" message, take a look at the variable's name, and
1730 give additional information about possible ACL variables. The extra information
1731 is added on to expand_string_message.
1733 Argument: the name of the variable
1738 check_variable_error_message(uschar *name)
1740 if (Ustrncmp(name, "acl_", 4) == 0)
1741 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1742 (name[4] == 'c' || name[4] == 'm')?
1744 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1745 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1747 US"user-defined ACL variables must start acl_c or acl_m");
1752 /*************************************************
1753 * Read and evaluate a condition *
1754 *************************************************/
1758 s points to the start of the condition text
1759 yield points to a BOOL to hold the result of the condition test;
1760 if NULL, we are just reading through a condition that is
1761 part of an "or" combination to check syntax, or in a state
1762 where the answer isn't required
1764 Returns: a pointer to the first character after the condition, or
1769 eval_condition(uschar *s, BOOL *yield)
1771 BOOL testfor = TRUE;
1772 BOOL tempcond, combined_cond;
1774 int i, rc, cond_type, roffset;
1776 struct stat statbuf;
1781 const uschar *rerror;
1785 while (isspace(*s)) s++;
1786 if (*s == '!') { testfor = !testfor; s++; } else break;
1789 /* Numeric comparisons are symbolic */
1791 if (*s == '=' || *s == '>' || *s == '<')
1803 /* All other conditions are named */
1805 else s = read_name(name, 256, s, US"_");
1807 /* If we haven't read a name, it means some non-alpha character is first. */
1811 expand_string_message = string_sprintf("condition name expected, "
1812 "but found \"%.16s\"", s);
1816 /* Find which condition we are dealing with, and switch on it */
1818 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1821 /* def: tests for a non-empty variable, or for the existence of a header. If
1822 yield == NULL we are in a skipping state, and don't care about the answer. */
1827 expand_string_message = US"\":\" expected after \"def\"";
1831 s = read_name(name, 256, s+1, US"_");
1833 /* Test for a header's existence. If the name contains a closing brace
1834 character, this may be a user error where the terminating colon has been
1835 omitted. Set a flag to adjust a subsequent error message in this case. */
1837 if (Ustrncmp(name, "h_", 2) == 0 ||
1838 Ustrncmp(name, "rh_", 3) == 0 ||
1839 Ustrncmp(name, "bh_", 3) == 0 ||
1840 Ustrncmp(name, "header_", 7) == 0 ||
1841 Ustrncmp(name, "rheader_", 8) == 0 ||
1842 Ustrncmp(name, "bheader_", 8) == 0)
1844 s = read_header_name(name, 256, s);
1845 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1846 if (yield != NULL) *yield =
1847 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1850 /* Test for a variable's having a non-empty value. A non-existent variable
1851 causes an expansion failure. */
1855 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1858 expand_string_message = (name[0] == 0)?
1859 string_sprintf("variable name omitted after \"def:\"") :
1860 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1861 check_variable_error_message(name);
1864 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1870 /* first_delivery tests for first delivery attempt */
1872 case ECOND_FIRST_DELIVERY:
1873 if (yield != NULL) *yield = deliver_firsttime == testfor;
1877 /* queue_running tests for any process started by a queue runner */
1879 case ECOND_QUEUE_RUNNING:
1880 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1884 /* exists: tests for file existence
1885 isip: tests for any IP address
1886 isip4: tests for an IPv4 address
1887 isip6: tests for an IPv6 address
1888 pam: does PAM authentication
1889 radius: does RADIUS authentication
1890 ldapauth: does LDAP authentication
1891 pwcheck: does Cyrus SASL pwcheck authentication
1900 case ECOND_LDAPAUTH:
1903 while (isspace(*s)) s++;
1904 if (*s != '{') goto COND_FAILED_CURLY_START;
1906 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1907 if (sub[0] == NULL) return NULL;
1908 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1910 if (yield == NULL) return s; /* No need to run the test if skipping */
1915 if ((expand_forbid & RDO_EXISTS) != 0)
1917 expand_string_message = US"File existence tests are not permitted";
1920 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1926 rc = string_is_ip_address(sub[0], NULL);
1927 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1928 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1931 /* Various authentication tests - all optionally compiled */
1935 rc = auth_call_pam(sub[0], &expand_string_message);
1938 goto COND_FAILED_NOT_COMPILED;
1939 #endif /* SUPPORT_PAM */
1942 #ifdef RADIUS_CONFIG_FILE
1943 rc = auth_call_radius(sub[0], &expand_string_message);
1946 goto COND_FAILED_NOT_COMPILED;
1947 #endif /* RADIUS_CONFIG_FILE */
1949 case ECOND_LDAPAUTH:
1952 /* Just to keep the interface the same */
1954 int old_pool = store_pool;
1955 store_pool = POOL_SEARCH;
1956 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1957 &expand_string_message, &do_cache);
1958 store_pool = old_pool;
1962 goto COND_FAILED_NOT_COMPILED;
1963 #endif /* LOOKUP_LDAP */
1966 #ifdef CYRUS_PWCHECK_SOCKET
1967 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1970 goto COND_FAILED_NOT_COMPILED;
1971 #endif /* CYRUS_PWCHECK_SOCKET */
1973 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1974 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1976 if (rc == ERROR || rc == DEFER) return NULL;
1977 *yield = (rc == OK) == testfor;
1983 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1985 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1987 However, the last two are optional. That is why the whole set is enclosed
1988 in their own set or braces. */
1990 case ECOND_SASLAUTHD:
1991 #ifndef CYRUS_SASLAUTHD_SOCKET
1992 goto COND_FAILED_NOT_COMPILED;
1994 while (isspace(*s)) s++;
1995 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1996 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1998 case 1: expand_string_message = US"too few arguments or bracketing "
1999 "error for saslauthd";
2001 case 3: return NULL;
2003 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
2007 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2008 &expand_string_message);
2009 if (rc == ERROR || rc == DEFER) return NULL;
2010 *yield = (rc == OK) == testfor;
2013 #endif /* CYRUS_SASLAUTHD_SOCKET */
2016 /* symbolic operators for numeric and string comparison, and a number of
2017 other operators, all requiring two arguments.
2019 match: does a regular expression match and sets up the numerical
2020 variables if it succeeds
2021 match_address: matches in an address list
2022 match_domain: matches in a domain list
2023 match_ip: matches a host list that is restricted to IP addresses
2024 match_local_part: matches in a local part list
2025 crypteq: encrypts plaintext and compares against an encrypted text,
2026 using crypt(), crypt16(), MD5 or SHA-1
2030 case ECOND_MATCH_ADDRESS:
2031 case ECOND_MATCH_DOMAIN:
2032 case ECOND_MATCH_IP:
2033 case ECOND_MATCH_LOCAL_PART:
2036 case ECOND_NUM_L: /* Numerical comparisons */
2043 case ECOND_STR_LT: /* String comparisons */
2054 for (i = 0; i < 2; i++)
2056 while (isspace(*s)) s++;
2059 if (i == 0) goto COND_FAILED_CURLY_START;
2060 expand_string_message = string_sprintf("missing 2nd string in {} "
2061 "after \"%s\"", name);
2064 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
2065 if (sub[i] == NULL) return NULL;
2066 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2068 /* Convert to numerical if required; we know that the names of all the
2069 conditions that compare numbers do not start with a letter. This just saves
2070 checking for them individually. */
2072 if (!isalpha(name[0]) && yield != NULL)
2078 debug_printf("empty string cast to zero for numerical comparison\n");
2082 num[i] = expand_string_integer(sub[i], FALSE);
2083 if (expand_string_message != NULL) return NULL;
2088 /* Result not required */
2090 if (yield == NULL) return s;
2092 /* Do an appropriate comparison */
2098 *yield = (num[0] == num[1]) == testfor;
2102 *yield = (num[0] > num[1]) == testfor;
2106 *yield = (num[0] >= num[1]) == testfor;
2110 *yield = (num[0] < num[1]) == testfor;
2114 *yield = (num[0] <= num[1]) == testfor;
2118 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2122 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2126 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2130 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2134 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2138 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2142 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2146 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2150 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2154 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2157 case ECOND_MATCH: /* Regular expression match */
2158 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2162 expand_string_message = string_sprintf("regular expression error in "
2163 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2166 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2169 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2170 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2171 goto MATCHED_SOMETHING;
2173 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2174 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2175 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2176 goto MATCHED_SOMETHING;
2178 case ECOND_MATCH_IP: /* Match IP address in a host list */
2179 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2181 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2187 unsigned int *nullcache = NULL;
2188 check_host_block cb;
2190 cb.host_name = US"";
2191 cb.host_address = sub[0];
2193 /* If the host address starts off ::ffff: it is an IPv6 address in
2194 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2197 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2198 cb.host_address + 7 : cb.host_address;
2200 rc = match_check_list(
2201 &sub[1], /* the list */
2202 0, /* separator character */
2203 &hostlist_anchor, /* anchor pointer */
2204 &nullcache, /* cache pointer */
2205 check_host, /* function for testing */
2206 &cb, /* argument for function */
2207 MCL_HOST, /* type of check */
2208 sub[0], /* text for debugging */
2209 NULL); /* where to pass back data */
2211 goto MATCHED_SOMETHING;
2213 case ECOND_MATCH_LOCAL_PART:
2214 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2215 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2230 expand_string_message = string_sprintf("unable to complete match "
2231 "against \"%s\": %s", sub[1], search_error_message);
2237 /* Various "encrypted" comparisons. If the second string starts with
2238 "{" then an encryption type is given. Default to crypt() or crypt16()
2239 (build-time choice). */
2242 #ifndef SUPPORT_CRYPTEQ
2243 goto COND_FAILED_NOT_COMPILED;
2245 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2247 int sublen = Ustrlen(sub[1]+5);
2252 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2254 /* If the length that we are comparing against is 24, the MD5 digest
2255 is expressed as a base64 string. This is the way LDAP does it. However,
2256 some other software uses a straightforward hex representation. We assume
2257 this if the length is 32. Other lengths fail. */
2261 uschar *coded = auth_b64encode((uschar *)digest, 16);
2262 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2263 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2264 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2266 else if (sublen == 32)
2270 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2272 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2273 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2274 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2278 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2279 "fail\n crypted=%s\n", sub[1]+5);
2284 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2286 int sublen = Ustrlen(sub[1]+6);
2291 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2293 /* If the length that we are comparing against is 28, assume the SHA1
2294 digest is expressed as a base64 string. If the length is 40, assume a
2295 straightforward hex representation. Other lengths fail. */
2299 uschar *coded = auth_b64encode((uschar *)digest, 20);
2300 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2301 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2302 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2304 else if (sublen == 40)
2308 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2310 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2311 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2312 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2316 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2317 "fail\n crypted=%s\n", sub[1]+6);
2322 else /* {crypt} or {crypt16} and non-{ at start */
2327 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2332 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2337 else if (sub[1][0] == '{')
2339 expand_string_message = string_sprintf("unknown encryption mechanism "
2340 "in \"%s\"", sub[1]);
2346 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2347 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2348 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2352 #define XSTR(s) STR(s)
2353 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2354 " subject=%s\n crypted=%s\n",
2355 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2360 /* If the encrypted string contains fewer than two characters (for the
2361 salt), force failure. Otherwise we get false positives: with an empty
2362 string the yield of crypt() is an empty string! */
2364 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2365 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2368 #endif /* SUPPORT_CRYPTEQ */
2369 } /* Switch for comparison conditions */
2371 return s; /* End of comparison conditions */
2374 /* and/or: computes logical and/or of several conditions */
2378 subcondptr = (yield == NULL)? NULL : &tempcond;
2379 combined_cond = (cond_type == ECOND_AND);
2381 while (isspace(*s)) s++;
2382 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2386 while (isspace(*s)) s++;
2387 if (*s == '}') break;
2390 expand_string_message = string_sprintf("each subcondition "
2391 "inside an \"%s{...}\" condition must be in its own {}", name);
2395 s = eval_condition(s+1, subcondptr);
2398 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2399 expand_string_message, name);
2402 while (isspace(*s)) s++;
2406 expand_string_message = string_sprintf("missing } at end of condition "
2407 "inside \"%s\" group", name);
2413 if (cond_type == ECOND_AND)
2415 combined_cond &= tempcond;
2416 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2417 } /* evaluate any more */
2420 combined_cond |= tempcond;
2421 if (combined_cond) subcondptr = NULL; /* once true, don't */
2422 } /* evaluate any more */
2426 if (yield != NULL) *yield = (combined_cond == testfor);
2430 /* forall/forany: iterates a condition with different values */
2436 uschar *save_iterate_item = iterate_item;
2438 while (isspace(*s)) s++;
2439 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2440 sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL));
2441 if (sub[0] == NULL) return NULL;
2442 if (*s++ != '}') goto COND_FAILED_CURLY_END;
2444 while (isspace(*s)) s++;
2445 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2449 /* Call eval_condition once, with result discarded (as if scanning a
2450 "false" part). This allows us to find the end of the condition, because if
2451 the list it empty, we won't actually evaluate the condition for real. */
2453 s = eval_condition(sub[1], NULL);
2456 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2457 expand_string_message, name);
2460 while (isspace(*s)) s++;
2464 expand_string_message = string_sprintf("missing } at end of condition "
2465 "inside \"%s\"", name);
2469 if (yield != NULL) *yield = !testfor;
2470 while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2472 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2473 if (eval_condition(sub[1], &tempcond) == NULL)
2475 expand_string_message = string_sprintf("%s inside \"%s\" condition",
2476 expand_string_message, name);
2477 iterate_item = save_iterate_item;
2480 DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2481 tempcond? "true":"false");
2483 if (yield != NULL) *yield = (tempcond == testfor);
2484 if (tempcond == (cond_type == ECOND_FORANY)) break;
2487 iterate_item = save_iterate_item;
2492 /* The bool{} expansion condition maps a string to boolean.
2493 The values supported should match those supported by the ACL condition
2494 (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2495 of true/false. Note that Router "condition" rules have a different
2496 interpretation, where general data can be used and only a few values
2498 Note that readconf.c boolean matching, for boolean configuration options,
2499 only matches true/yes/false/no.
2500 The bool_lax{} condition matches the Router logic, which is much more
2503 case ECOND_BOOL_LAX:
2509 BOOL boolvalue = FALSE;
2510 while (isspace(*s)) s++;
2511 if (*s != '{') goto COND_FAILED_CURLY_START;
2512 ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2513 switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2515 case 1: expand_string_message = string_sprintf(
2516 "too few arguments or bracketing error for %s",
2520 case 3: return NULL;
2523 while (isspace(*t)) t++;
2527 /* trailing whitespace: seems like a good idea to ignore it too */
2529 while (isspace(*t2)) t2--;
2530 if (t2 != (t + len))
2537 debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2538 /* logic for the lax case from expand_check_condition(), which also does
2539 expands, and the logic is both short and stable enough that there should
2540 be no maintenance burden from replicating it. */
2543 else if (Ustrspn(t, "0123456789") == len)
2545 boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2546 /* expand_check_condition only does a literal string "0" check */
2547 if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2550 else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2552 else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2554 else if (cond_type == ECOND_BOOL_LAX)
2558 expand_string_message = string_sprintf("unrecognised boolean "
2562 if (yield != NULL) *yield = (boolvalue == testfor);
2566 /* Unknown condition */
2569 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2571 } /* End switch on condition type */
2573 /* Missing braces at start and end of data */
2575 COND_FAILED_CURLY_START:
2576 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2579 COND_FAILED_CURLY_END:
2580 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2584 /* A condition requires code that is not compiled */
2586 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2587 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2588 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2589 COND_FAILED_NOT_COMPILED:
2590 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2599 /*************************************************
2600 * Save numerical variables *
2601 *************************************************/
2603 /* This function is called from items such as "if" that want to preserve and
2604 restore the numbered variables.
2607 save_expand_string points to an array of pointers to set
2608 save_expand_nlength points to an array of ints for the lengths
2610 Returns: the value of expand max to save
2614 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2617 for (i = 0; i <= expand_nmax; i++)
2619 save_expand_nstring[i] = expand_nstring[i];
2620 save_expand_nlength[i] = expand_nlength[i];
2627 /*************************************************
2628 * Restore numerical variables *
2629 *************************************************/
2631 /* This function restored saved values of numerical strings.
2634 save_expand_nmax the number of strings to restore
2635 save_expand_string points to an array of pointers
2636 save_expand_nlength points to an array of ints
2642 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2643 int *save_expand_nlength)
2646 expand_nmax = save_expand_nmax;
2647 for (i = 0; i <= expand_nmax; i++)
2649 expand_nstring[i] = save_expand_nstring[i];
2650 expand_nlength[i] = save_expand_nlength[i];
2658 /*************************************************
2659 * Handle yes/no substrings *
2660 *************************************************/
2662 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2663 alternative substrings that depend on whether or not the condition was true,
2664 or the lookup or extraction succeeded. The substrings always have to be
2665 expanded, to check their syntax, but "skipping" is set when the result is not
2666 needed - this avoids unnecessary nested lookups.
2669 skipping TRUE if we were skipping when this item was reached
2670 yes TRUE if the first string is to be used, else use the second
2671 save_lookup a value to put back into lookup_value before the 2nd expansion
2672 sptr points to the input string pointer
2673 yieldptr points to the output string pointer
2674 sizeptr points to the output string size
2675 ptrptr points to the output string pointer
2676 type "lookup" or "if" or "extract" or "run", for error message
2678 Returns: 0 OK; lookup_value has been reset to save_lookup
2680 2 expansion failed because of bracketing error
2684 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2685 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2688 uschar *s = *sptr; /* Local value */
2689 uschar *sub1, *sub2;
2691 /* If there are no following strings, we substitute the contents of $value for
2692 lookups and for extractions in the success case. For the ${if item, the string
2693 "true" is substituted. In the fail case, nothing is substituted for all three
2696 while (isspace(*s)) s++;
2701 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2705 if (yes && lookup_value != NULL)
2706 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2707 Ustrlen(lookup_value));
2708 lookup_value = save_lookup;
2714 /* The first following string must be braced. */
2716 if (*s++ != '{') goto FAILED_CURLY;
2718 /* Expand the first substring. Forced failures are noticed only if we actually
2719 want this string. Set skipping in the call in the fail case (this will always
2720 be the case if we were already skipping). */
2722 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2723 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2724 expand_string_forcedfail = FALSE;
2725 if (*s++ != '}') goto FAILED_CURLY;
2727 /* If we want the first string, add it to the output */
2730 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2732 /* If this is called from a lookup or an extract, we want to restore $value to
2733 what it was at the start of the item, so that it has this value during the
2734 second string expansion. For the call from "if" or "run" to this function,
2735 save_lookup is set to lookup_value, so that this statement does nothing. */
2737 lookup_value = save_lookup;
2739 /* There now follows either another substring, or "fail", or nothing. This
2740 time, forced failures are noticed only if we want the second string. We must
2741 set skipping in the nested call if we don't want this string, or if we were
2742 already skipping. */
2744 while (isspace(*s)) s++;
2747 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2748 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2749 expand_string_forcedfail = FALSE;
2750 if (*s++ != '}') goto FAILED_CURLY;
2752 /* If we want the second string, add it to the output */
2755 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2758 /* If there is no second string, but the word "fail" is present when the use of
2759 the second string is wanted, set a flag indicating it was a forced failure
2760 rather than a syntactic error. Swallow the terminating } in case this is nested
2761 inside another lookup or if or extract. */
2766 s = read_name(name, sizeof(name), s, US"_");
2767 if (Ustrcmp(name, "fail") == 0)
2769 if (!yes && !skipping)
2771 while (isspace(*s)) s++;
2772 if (*s++ != '}') goto FAILED_CURLY;
2773 expand_string_message =
2774 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2775 expand_string_forcedfail = TRUE;
2781 expand_string_message =
2782 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2787 /* All we have to do now is to check on the final closing brace. */
2789 while (isspace(*s)) s++;
2790 if (*s++ == '}') goto RETURN;
2792 /* Get here if there is a bracketing failure */
2797 /* Get here for other failures */
2802 /* Update the input pointer value before returning */
2812 /*************************************************
2813 * Handle MD5 or SHA-1 computation for HMAC *
2814 *************************************************/
2816 /* These are some wrapping functions that enable the HMAC code to be a bit
2817 cleaner. A good compiler will spot the tail recursion.
2820 type HMAC_MD5 or HMAC_SHA1
2821 remaining are as for the cryptographic hash functions
2827 chash_start(int type, void *base)
2829 if (type == HMAC_MD5)
2830 md5_start((md5 *)base);
2832 sha1_start((sha1 *)base);
2836 chash_mid(int type, void *base, uschar *string)
2838 if (type == HMAC_MD5)
2839 md5_mid((md5 *)base, string);
2841 sha1_mid((sha1 *)base, string);
2845 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2847 if (type == HMAC_MD5)
2848 md5_end((md5 *)base, string, length, digest);
2850 sha1_end((sha1 *)base, string, length, digest);
2857 /********************************************************
2858 * prvs: Get last three digits of days since Jan 1, 1970 *
2859 ********************************************************/
2861 /* This is needed to implement the "prvs" BATV reverse
2864 Argument: integer "days" offset to add or substract to
2865 or from the current number of days.
2867 Returns: pointer to string containing the last three
2868 digits of the number of days since Jan 1, 1970,
2869 modified by the offset argument, NULL if there
2870 was an error in the conversion.
2875 prvs_daystamp(int day_offset)
2877 uschar *days = store_get(32); /* Need at least 24 for cases */
2878 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2879 (time(NULL) + day_offset*86400)/86400);
2880 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2885 /********************************************************
2886 * prvs: perform HMAC-SHA1 computation of prvs bits *
2887 ********************************************************/
2889 /* This is needed to implement the "prvs" BATV reverse
2893 address RFC2821 Address to use
2894 key The key to use (must be less than 64 characters
2896 key_num Single-digit key number to use. Defaults to
2899 Returns: pointer to string containing the first three
2900 bytes of the final hash in hex format, NULL if
2901 there was an error in the process.
2905 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2907 uschar *hash_source, *p;
2908 int size = 0,offset = 0,i;
2910 void *use_base = &sha1_base;
2911 uschar innerhash[20];
2912 uschar finalhash[20];
2913 uschar innerkey[64];
2914 uschar outerkey[64];
2915 uschar *finalhash_hex = store_get(40);
2917 if (key_num == NULL)
2920 if (Ustrlen(key) > 64)
2923 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2924 string_cat(hash_source,&size,&offset,daystamp,3);
2925 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2926 hash_source[offset] = '\0';
2928 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2930 memset(innerkey, 0x36, 64);
2931 memset(outerkey, 0x5c, 64);
2933 for (i = 0; i < Ustrlen(key); i++)
2935 innerkey[i] ^= key[i];
2936 outerkey[i] ^= key[i];
2939 chash_start(HMAC_SHA1, use_base);
2940 chash_mid(HMAC_SHA1, use_base, innerkey);
2941 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2943 chash_start(HMAC_SHA1, use_base);
2944 chash_mid(HMAC_SHA1, use_base, outerkey);
2945 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2948 for (i = 0; i < 3; i++)
2950 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2951 *p++ = hex_digits[finalhash[i] & 0x0f];
2955 return finalhash_hex;
2961 /*************************************************
2962 * Join a file onto the output string *
2963 *************************************************/
2965 /* This is used for readfile and after a run expansion. It joins the contents
2966 of a file onto the output string, globally replacing newlines with a given
2967 string (optionally). The file is closed at the end.
2971 yield pointer to the expandable string
2972 sizep pointer to the current size
2973 ptrp pointer to the current position
2974 eol newline replacement string, or NULL
2976 Returns: new value of string pointer
2980 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2983 uschar buffer[1024];
2985 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2987 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2989 int len = Ustrlen(buffer);
2990 if (eol != NULL && buffer[len-1] == '\n') len--;
2991 yield = string_cat(yield, sizep, ptrp, buffer, len);
2992 if (buffer[len] != 0)
2993 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2996 if (yield != NULL) yield[*ptrp] = 0;
3004 /*************************************************
3005 * Evaluate numeric expression *
3006 *************************************************/
3008 /* This is a set of mutually recursive functions that evaluate an arithmetic
3009 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3010 these functions that is called from elsewhere is eval_expr, whose interface is:
3013 sptr pointer to the pointer to the string - gets updated
3014 decimal TRUE if numbers are to be assumed decimal
3015 error pointer to where to put an error message - must be NULL on input
3016 endket TRUE if ')' must terminate - FALSE for external call
3018 Returns: on success: the value of the expression, with *error still NULL
3019 on failure: an undefined value, with *error = a message
3022 static int eval_op_or(uschar **, BOOL, uschar **);
3026 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3029 int x = eval_op_or(&s, decimal, error);
3035 *error = US"expecting closing parenthesis";
3037 while (isspace(*(++s)));
3039 else if (*s != 0) *error = US"expecting operator";
3047 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3052 while (isspace(*s)) s++;
3057 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
3059 if (tolower(*s) == 'k') { n *= 1024; s++; }
3060 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
3061 while (isspace (*s)) s++;
3066 n = eval_expr(&s, decimal, error, 1);
3070 *error = US"expecting number or opening parenthesis";
3078 static int eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3082 while (isspace(*s)) s++;
3083 if (*s == '+' || *s == '-' || *s == '~')
3086 x = eval_op_unary(&s, decimal, error);
3087 if (op == '-') x = -x;
3088 else if (op == '~') x = ~x;
3092 x = eval_number(&s, decimal, error);
3099 static int eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3102 int x = eval_op_unary(&s, decimal, error);
3105 while (*s == '*' || *s == '/' || *s == '%')
3108 int y = eval_op_unary(&s, decimal, error);
3109 if (*error != NULL) break;
3110 /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3111 * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3112 * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64]. In fact, -N*-M where
3113 * -N*M is INT_MIN will yielf INT_MIN.
3114 * Since we don't support floating point, this is somewhat simpler.
3115 * Ideally, we'd return an error, but since we overflow for all other
3116 * arithmetic, consistency suggests otherwise, but what's the correct value
3117 * to use? There is none.
3118 * The C standard guarantees overflow for unsigned arithmetic but signed
3119 * overflow invokes undefined behaviour; in practice, this is overflow
3120 * except for converting INT_MIN to INT_MAX+1. We also can't guarantee
3121 * that long/longlong larger than int are available, or we could just work
3122 * with larger types. We should consider whether to guarantee 32bit eval
3123 * and 64-bit working variables, with errors returned. For now ...
3124 * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3125 * can just let the other invalid results occur otherwise, as they have
3126 * until now. For this one case, we can coerce.
3128 if (y == -1 && x == INT_MIN && op != '*')
3131 debug_printf("Integer exception dodging: %d%c-1 coerced to %d\n",
3132 INT_MIN, op, INT_MAX);
3142 *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3158 static int eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3161 int x = eval_op_mult(&s, decimal, error);
3164 while (*s == '+' || *s == '-')
3167 int y = eval_op_mult(&s, decimal, error);
3168 if (*error != NULL) break;
3169 if (op == '+') x += y; else x -= y;
3177 static int eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3180 int x = eval_op_sum(&s, decimal, error);
3183 while ((*s == '<' || *s == '>') && s[1] == s[0])
3188 y = eval_op_sum(&s, decimal, error);
3189 if (*error != NULL) break;
3190 if (op == '<') x <<= y; else x >>= y;
3198 static int eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3201 int x = eval_op_shift(&s, decimal, error);
3208 y = eval_op_shift(&s, decimal, error);
3209 if (*error != NULL) break;
3218 static int eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3221 int x = eval_op_and(&s, decimal, error);
3228 y = eval_op_and(&s, decimal, error);
3229 if (*error != NULL) break;
3238 static int eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3241 int x = eval_op_xor(&s, decimal, error);
3248 y = eval_op_xor(&s, decimal, error);
3249 if (*error != NULL) break;
3259 /*************************************************
3261 *************************************************/
3263 /* Returns either an unchanged string, or the expanded string in stacking pool
3264 store. Interpreted sequences are:
3266 \... normal escaping rules
3267 $name substitutes the variable
3269 ${op:string} operates on the expanded string value
3270 ${item{arg1}{arg2}...} expands the args and then does the business
3271 some literal args are not enclosed in {}
3273 There are now far too many operators and item types to make it worth listing
3274 them here in detail any more.
3276 We use an internal routine recursively to handle embedded substrings. The
3277 external function follows. The yield is NULL if the expansion failed, and there
3278 are two cases: if something collapsed syntactically, or if "fail" was given
3279 as the action on a lookup failure. These can be distinguised by looking at the
3280 variable expand_string_forcedfail, which is TRUE in the latter case.
3282 The skipping flag is set true when expanding a substring that isn't actually
3283 going to be used (after "if" or "lookup") and it prevents lookups from
3284 happening lower down.
3286 Store usage: At start, a store block of the length of the input plus 64
3287 is obtained. This is expanded as necessary by string_cat(), which might have to
3288 get a new block, or might be able to expand the original. At the end of the
3289 function we can release any store above that portion of the yield block that
3290 was actually used. In many cases this will be optimal.
3292 However: if the first item in the expansion is a variable name or header name,
3293 we reset the store before processing it; if the result is in fresh store, we
3294 use that without copying. This is helpful for expanding strings like
3295 $message_headers which can get very long.
3297 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3298 since resetting the store at the end of the expansion will free store that was
3299 allocated by the plugin code as well as the slop after the expanded string. So
3300 we skip any resets if ${dlfunc has been used. This is an unfortunate
3301 consequence of string expansion becoming too powerful.
3304 string the string to be expanded
3305 ket_ends true if expansion is to stop at }
3306 left if not NULL, a pointer to the first character after the
3307 expansion is placed here (typically used with ket_ends)
3308 skipping TRUE for recursive calls when the value isn't actually going
3309 to be used (to allow for optimisation)
3311 Returns: NULL if expansion fails:
3312 expand_string_forcedfail is set TRUE if failure was forced
3313 expand_string_message contains a textual error message
3314 a pointer to the expanded string on success
3318 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3322 int size = Ustrlen(string)+ 64;
3324 uschar *yield = store_get(size);
3326 uschar *save_expand_nstring[EXPAND_MAXN+1];
3327 int save_expand_nlength[EXPAND_MAXN+1];
3328 BOOL resetok = TRUE;
3330 expand_string_forcedfail = FALSE;
3331 expand_string_message = US"";
3338 /* \ escapes the next character, which must exist, or else
3339 the expansion fails. There's a special escape, \N, which causes
3340 copying of the subject verbatim up to the next \N. Otherwise,
3341 the escapes are the standard set. */
3347 expand_string_message = US"\\ at end of string";
3354 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3355 yield = string_cat(yield, &size, &ptr, t, s - t);
3356 if (*s != 0) s += 2;
3362 ch[0] = string_interpret_escape(&s);
3364 yield = string_cat(yield, &size, &ptr, ch, 1);
3370 /* Anything other than $ is just copied verbatim, unless we are
3371 looking for a terminating } character. */
3373 if (ket_ends && *s == '}') break;
3377 yield = string_cat(yield, &size, &ptr, s++, 1);
3381 /* No { after the $ - must be a plain name or a number for string
3382 match variable. There has to be a fudge for variables that are the
3383 names of header fields preceded by "$header_" because header field
3384 names can contain any printing characters except space and colon.
3385 For those that don't like typing this much, "$h_" is a synonym for
3386 "$header_". A non-existent header yields a NULL value; nothing is
3389 if (isalpha((*(++s))))
3394 s = read_name(name, sizeof(name), s, US"_");
3396 /* If this is the first thing to be expanded, release the pre-allocated
3399 if (ptr == 0 && yield != NULL)
3401 if (resetok) store_reset(yield);
3408 if (Ustrncmp(name, "h_", 2) == 0 ||
3409 Ustrncmp(name, "rh_", 3) == 0 ||
3410 Ustrncmp(name, "bh_", 3) == 0 ||
3411 Ustrncmp(name, "header_", 7) == 0 ||
3412 Ustrncmp(name, "rheader_", 8) == 0 ||
3413 Ustrncmp(name, "bheader_", 8) == 0)
3415 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3416 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3417 s = read_header_name(name, sizeof(name), s);
3418 value = find_header(name, FALSE, &newsize, want_raw, charset);
3420 /* If we didn't find the header, and the header contains a closing brace
3421 character, this may be a user error where the terminating colon
3422 has been omitted. Set a flag to adjust the error message in this case.
3423 But there is no error here - nothing gets inserted. */
3427 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3436 value = find_variable(name, FALSE, skipping, &newsize);
3439 expand_string_message =
3440 string_sprintf("unknown variable name \"%s\"", name);
3441 check_variable_error_message(name);
3446 /* If the data is known to be in a new buffer, newsize will be set to the
3447 size of that buffer. If this is the first thing in an expansion string,
3448 yield will be NULL; just point it at the new store instead of copying. Many
3449 expansion strings contain just one reference, so this is a useful
3450 optimization, especially for humungous headers. */
3452 len = Ustrlen(value);
3453 if (yield == NULL && newsize != 0)
3459 else yield = string_cat(yield, &size, &ptr, value, len);
3467 s = read_number(&n, s);
3468 if (n >= 0 && n <= expand_nmax)
3469 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3474 /* Otherwise, if there's no '{' after $ it's an error. */
3478 expand_string_message = US"$ not followed by letter, digit, or {";
3482 /* After { there can be various things, but they all start with
3483 an initial word, except for a number for a string match variable. */
3485 if (isdigit((*(++s))))
3488 s = read_number(&n, s);
3491 expand_string_message = US"} expected after number";
3494 if (n >= 0 && n <= expand_nmax)
3495 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3502 expand_string_message = US"letter or digit expected after ${";
3506 /* Allow "-" in names to cater for substrings with negative
3507 arguments. Since we are checking for known names after { this is
3510 s = read_name(name, sizeof(name), s, US"_-");
3511 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3515 /* Handle conditionals - preserve the values of the numerical expansion
3516 variables in case they get changed by a regular expression match in the
3517 condition. If not, they retain their external settings. At the end
3518 of this "if" section, they get restored to their previous values. */
3524 int save_expand_nmax =
3525 save_expand_strings(save_expand_nstring, save_expand_nlength);
3527 while (isspace(*s)) s++;
3528 next_s = eval_condition(s, skipping? NULL : &cond);
3529 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3532 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3533 cond? "true" : "false");
3537 /* The handling of "yes" and "no" result strings is now in a separate
3538 function that is also used by ${lookup} and ${extract} and ${run}. */
3540 switch(process_yesno(
3541 skipping, /* were previously skipping */
3542 cond, /* success/failure indicator */
3543 lookup_value, /* value to reset for string2 */
3544 &s, /* input pointer */
3545 &yield, /* output pointer */
3546 &size, /* output size */
3547 &ptr, /* output current point */
3548 US"if")) /* condition type */
3550 case 1: goto EXPAND_FAILED; /* when all is well, the */
3551 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3554 /* Restore external setting of expansion variables for continuation
3557 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3558 save_expand_nlength);
3562 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3563 expanding an internal string that isn't actually going to be used. All we
3564 need to do is check the syntax, so don't do a lookup at all. Preserve the
3565 values of the numerical expansion variables in case they get changed by a
3566 partial lookup. If not, they retain their external settings. At the end
3567 of this "lookup" section, they get restored to their previous values. */
3571 int stype, partial, affixlen, starflags;
3572 int expand_setup = 0;
3574 uschar *key, *filename, *affix;
3575 uschar *save_lookup_value = lookup_value;
3576 int save_expand_nmax =
3577 save_expand_strings(save_expand_nstring, save_expand_nlength);
3579 if ((expand_forbid & RDO_LOOKUP) != 0)
3581 expand_string_message = US"lookup expansions are not permitted";
3585 /* Get the key we are to look up for single-key+file style lookups.
3586 Otherwise set the key NULL pro-tem. */
3588 while (isspace(*s)) s++;
3591 key = expand_string_internal(s+1, TRUE, &s, skipping);
3592 if (key == NULL) goto EXPAND_FAILED;
3593 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3594 while (isspace(*s)) s++;
3598 /* Find out the type of database */
3602 expand_string_message = US"missing lookup type";
3606 /* The type is a string that may contain special characters of various
3607 kinds. Allow everything except space or { to appear; the actual content
3608 is checked by search_findtype_partial. */
3610 while (*s != 0 && *s != '{' && !isspace(*s))
3612 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3616 while (isspace(*s)) s++;
3618 /* Now check for the individual search type and any partial or default
3619 options. Only those types that are actually in the binary are valid. */
3621 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3625 expand_string_message = search_error_message;
3629 /* Check that a key was provided for those lookup types that need it,
3630 and was not supplied for those that use the query style. */
3632 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3636 expand_string_message = string_sprintf("missing {key} for single-"
3637 "key \"%s\" lookup", name);
3645 expand_string_message = string_sprintf("a single key was given for "
3646 "lookup type \"%s\", which is not a single-key lookup type", name);
3651 /* Get the next string in brackets and expand it. It is the file name for
3652 single-key+file lookups, and the whole query otherwise. In the case of
3653 queries that also require a file name (e.g. sqlite), the file name comes
3656 if (*s != '{') goto EXPAND_FAILED_CURLY;
3657 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3658 if (filename == NULL) goto EXPAND_FAILED;
3659 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3660 while (isspace(*s)) s++;
3662 /* If this isn't a single-key+file lookup, re-arrange the variables
3663 to be appropriate for the search_ functions. For query-style lookups,
3664 there is just a "key", and no file name. For the special query-style +
3665 file types, the query (i.e. "key") starts with a file name. */
3669 while (isspace(*filename)) filename++;
3672 if (mac_islookup(stype, lookup_querystyle))
3678 if (*filename != '/')
3680 expand_string_message = string_sprintf(
3681 "absolute file name expected for \"%s\" lookup", name);
3684 while (*key != 0 && !isspace(*key)) key++;
3685 if (*key != 0) *key++ = 0;
3689 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3690 the entry was not found. Note that there is no search_close() function.
3691 Files are left open in case of re-use. At suitable places in higher logic,
3692 search_tidyup() is called to tidy all open files. This can save opening
3693 the same file several times. However, files may also get closed when
3694 others are opened, if too many are open at once. The rule is that a
3695 handle should not be used after a second search_open().
3697 Request that a partial search sets up $1 and maybe $2 by passing
3698 expand_setup containing zero. If its value changes, reset expand_nmax,
3699 since new variables will have been set. Note that at the end of this
3700 "lookup" section, the old numeric variables are restored. */
3703 lookup_value = NULL;
3706 void *handle = search_open(filename, stype, 0, NULL, NULL);
3709 expand_string_message = search_error_message;
3712 lookup_value = search_find(handle, filename, key, partial, affix,
3713 affixlen, starflags, &expand_setup);
3714 if (search_find_defer)
3716 expand_string_message =
3717 string_sprintf("lookup of \"%s\" gave DEFER: %s",
3718 string_printing2(key, FALSE), search_error_message);
3721 if (expand_setup > 0) expand_nmax = expand_setup;
3724 /* The handling of "yes" and "no" result strings is now in a separate
3725 function that is also used by ${if} and ${extract}. */
3727 switch(process_yesno(
3728 skipping, /* were previously skipping */
3729 lookup_value != NULL, /* success/failure indicator */
3730 save_lookup_value, /* value to reset for string2 */
3731 &s, /* input pointer */
3732 &yield, /* output pointer */
3733 &size, /* output size */
3734 &ptr, /* output current point */
3735 US"lookup")) /* condition type */
3737 case 1: goto EXPAND_FAILED; /* when all is well, the */
3738 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3741 /* Restore external setting of expansion variables for carrying on
3742 at this level, and continue. */
3744 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3745 save_expand_nlength);
3749 /* If Perl support is configured, handle calling embedded perl subroutines,
3750 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3751 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3752 arguments (defined below). */
3754 #define EXIM_PERL_MAX_ARGS 8
3758 expand_string_message = US"\"${perl\" encountered, but this facility "
3759 "is not included in this binary";
3762 #else /* EXIM_PERL */
3764 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3767 if ((expand_forbid & RDO_PERL) != 0)
3769 expand_string_message = US"Perl calls are not permitted";
3773 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3776 case 1: goto EXPAND_FAILED_CURLY;
3778 case 3: goto EXPAND_FAILED;
3781 /* If skipping, we don't actually do anything */
3783 if (skipping) continue;
3785 /* Start the interpreter if necessary */
3787 if (!opt_perl_started)
3790 if (opt_perl_startup == NULL)
3792 expand_string_message = US"A setting of perl_startup is needed when "
3793 "using the Perl interpreter";
3796 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3797 initerror = init_perl(opt_perl_startup);
3798 if (initerror != NULL)
3800 expand_string_message =
3801 string_sprintf("error in perl_startup code: %s\n", initerror);
3804 opt_perl_started = TRUE;
3807 /* Call the function */
3809 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3810 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3811 sub_arg[0], sub_arg + 1);
3813 /* NULL yield indicates failure; if the message pointer has been set to
3814 NULL, the yield was undef, indicating a forced failure. Otherwise the
3815 message will indicate some kind of Perl error. */
3817 if (new_yield == NULL)
3819 if (expand_string_message == NULL)
3821 expand_string_message =
3822 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3823 "failure", sub_arg[0]);
3824 expand_string_forcedfail = TRUE;
3829 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3830 set during a callback from Perl. */
3832 expand_string_forcedfail = FALSE;
3836 #endif /* EXIM_PERL */
3838 /* Transform email address to "prvs" scheme to use
3839 as BATV-signed return path */
3846 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3848 case 1: goto EXPAND_FAILED_CURLY;
3850 case 3: goto EXPAND_FAILED;
3853 /* If skipping, we don't actually do anything */
3854 if (skipping) continue;
3856 /* sub_arg[0] is the address */
3857 domain = Ustrrchr(sub_arg[0],'@');
3858 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3860 expand_string_message = US"prvs first argument must be a qualified email address";
3864 /* Calculate the hash. The second argument must be a single-digit
3865 key number, or unset. */
3867 if (sub_arg[2] != NULL &&
3868 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3870 expand_string_message = US"prvs second argument must be a single digit";
3874 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3877 expand_string_message = US"prvs hmac-sha1 conversion failed";
3881 /* Now separate the domain from the local part */
3884 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3885 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3886 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3887 string_cat(yield,&size,&ptr,p,6);
3888 string_cat(yield,&size,&ptr,US"=",1);
3889 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3890 string_cat(yield,&size,&ptr,US"@",1);
3891 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3896 /* Check a prvs-encoded address for validity */
3898 case EITEM_PRVSCHECK:
3901 int mysize = 0, myptr = 0;
3905 /* TF: Ugliness: We want to expand parameter 1 first, then set
3906 up expansion variables that are used in the expansion of
3907 parameter 2. So we clone the string for the first
3908 expansion, where we only expand parameter 1.
3910 PH: Actually, that isn't necessary. The read_subs() function is
3911 designed to work this way for the ${if and ${lookup expansions. I've
3915 /* Reset expansion variables */
3916 prvscheck_result = NULL;
3917 prvscheck_address = NULL;
3918 prvscheck_keynum = NULL;
3920 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3922 case 1: goto EXPAND_FAILED_CURLY;
3924 case 3: goto EXPAND_FAILED;
3927 re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
3930 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3932 uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
3933 uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
3934 uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
3935 uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
3936 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3938 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3939 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3940 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3941 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3942 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3944 /* Set up expansion variables */
3945 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3946 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3947 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3948 prvscheck_address[myptr] = '\0';
3949 prvscheck_keynum = string_copy(key_num);
3951 /* Now expand the second argument */
3952 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3954 case 1: goto EXPAND_FAILED_CURLY;
3956 case 3: goto EXPAND_FAILED;
3959 /* Now we have the key and can check the address. */
3961 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3966 expand_string_message = US"hmac-sha1 conversion failed";
3970 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3971 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3973 if (Ustrcmp(p,hash) == 0)
3975 /* Success, valid BATV address. Now check the expiry date. */
3976 uschar *now = prvs_daystamp(0);
3977 unsigned int inow = 0,iexpire = 1;
3979 (void)sscanf(CS now,"%u",&inow);
3980 (void)sscanf(CS daystamp,"%u",&iexpire);
3982 /* When "iexpire" is < 7, a "flip" has occured.
3983 Adjust "inow" accordingly. */
3984 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3986 if (iexpire >= inow)
3988 prvscheck_result = US"1";
3989 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3993 prvscheck_result = NULL;
3994 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3999 prvscheck_result = NULL;
4000 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4003 /* Now expand the final argument. We leave this till now so that
4004 it can include $prvscheck_result. */
4006 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4008 case 1: goto EXPAND_FAILED_CURLY;
4010 case 3: goto EXPAND_FAILED;
4013 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4014 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4016 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4018 /* Reset the "internal" variables afterwards, because they are in
4019 dynamic store that will be reclaimed if the expansion succeeded. */
4021 prvscheck_address = NULL;
4022 prvscheck_keynum = NULL;
4026 /* Does not look like a prvs encoded address, return the empty string.
4027 We need to make sure all subs are expanded first, so as to skip over
4030 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4032 case 1: goto EXPAND_FAILED_CURLY;
4034 case 3: goto EXPAND_FAILED;
4041 /* Handle "readfile" to insert an entire file */
4043 case EITEM_READFILE:
4048 if ((expand_forbid & RDO_READFILE) != 0)
4050 expand_string_message = US"file insertions are not permitted";
4054 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4056 case 1: goto EXPAND_FAILED_CURLY;
4058 case 3: goto EXPAND_FAILED;
4061 /* If skipping, we don't actually do anything */
4063 if (skipping) continue;
4065 /* Open the file and read it */
4067 f = Ufopen(sub_arg[0], "rb");
4070 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4074 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4079 /* Handle "readsocket" to insert data from a Unix domain socket */
4081 case EITEM_READSOCK:
4087 struct sockaddr_un sockun; /* don't call this "sun" ! */
4091 if ((expand_forbid & RDO_READSOCK) != 0)
4093 expand_string_message = US"socket insertions are not permitted";
4097 /* Read up to 4 arguments, but don't do the end of item check afterwards,
4098 because there may be a string for expansion on failure. */
4100 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4102 case 1: goto EXPAND_FAILED_CURLY;
4103 case 2: /* Won't occur: no end check */
4104 case 3: goto EXPAND_FAILED;
4107 /* Sort out timeout, if given */
4109 if (sub_arg[2] != NULL)
4111 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4114 expand_string_message = string_sprintf("bad time value %s",
4119 else sub_arg[3] = NULL; /* No eol if no timeout */
4121 /* If skipping, we don't actually do anything. Otherwise, arrange to
4122 connect to either an IP or a Unix socket. */
4126 /* Handle an IP (internet) domain */
4128 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4130 BOOL connected = FALSE;
4134 uschar *server_name = sub_arg[0] + 5;
4135 uschar *port_name = Ustrrchr(server_name, ':');
4137 /* Sort out the port */
4139 if (port_name == NULL)
4141 expand_string_message =
4142 string_sprintf("missing port for readsocket %s", sub_arg[0]);
4145 *port_name++ = 0; /* Terminate server name */
4147 if (isdigit(*port_name))
4150 port = Ustrtol(port_name, &end, 0);
4151 if (end != port_name + Ustrlen(port_name))
4153 expand_string_message =
4154 string_sprintf("invalid port number %s", port_name);
4160 struct servent *service_info = getservbyname(CS port_name, "tcp");
4161 if (service_info == NULL)
4163 expand_string_message = string_sprintf("unknown port \"%s\"",
4167 port = ntohs(service_info->s_port);
4170 /* Sort out the server. */
4173 shost.address = NULL;
4177 namelen = Ustrlen(server_name);
4179 /* Anything enclosed in [] must be an IP address. */
4181 if (server_name[0] == '[' &&
4182 server_name[namelen - 1] == ']')
4184 server_name[namelen - 1] = 0;
4186 if (string_is_ip_address(server_name, NULL) == 0)
4188 expand_string_message =
4189 string_sprintf("malformed IP address \"%s\"", server_name);
4192 shost.name = shost.address = server_name;
4195 /* Otherwise check for an unadorned IP address */
4197 else if (string_is_ip_address(server_name, NULL) != 0)
4198 shost.name = shost.address = server_name;
4200 /* Otherwise lookup IP address(es) from the name */
4204 shost.name = server_name;
4205 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4206 FALSE) != HOST_FOUND)
4208 expand_string_message =
4209 string_sprintf("no IP address found for host %s", shost.name);
4214 /* Try to connect to the server - test each IP till one works */
4216 for (h = &shost; h != NULL; h = h->next)
4218 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4219 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4221 expand_string_message = string_sprintf("failed to create socket: "
4222 "%s", strerror(errno));
4226 if (ip_connect(fd, af, h->address, port, timeout) == 0)
4235 expand_string_message = string_sprintf("failed to connect to "
4236 "socket %s: couldn't connect to any host", sub_arg[0],
4242 /* Handle a Unix domain socket */
4247 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4249 expand_string_message = string_sprintf("failed to create socket: %s",
4254 sockun.sun_family = AF_UNIX;
4255 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4258 sigalrm_seen = FALSE;
4260 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4264 expand_string_message = US "socket connect timed out";
4269 expand_string_message = string_sprintf("failed to connect to socket "
4270 "%s: %s", sub_arg[0], strerror(errno));
4275 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4277 /* Write the request string, if not empty */
4279 if (sub_arg[1][0] != 0)
4281 int len = Ustrlen(sub_arg[1]);
4282 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4284 if (write(fd, sub_arg[1], len) != len)
4286 expand_string_message = string_sprintf("request write to socket "
4287 "failed: %s", strerror(errno));
4292 /* Shut down the sending side of the socket. This helps some servers to
4293 recognise that it is their turn to do some work. Just in case some
4294 system doesn't have this function, make it conditional. */
4297 shutdown(fd, SHUT_WR);
4300 /* Now we need to read from the socket, under a timeout. The function
4301 that reads a file can be used. */
4303 f = fdopen(fd, "rb");
4304 sigalrm_seen = FALSE;
4306 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4310 /* After a timeout, we restore the pointer in the result, that is,
4311 make sure we add nothing from the socket. */
4316 expand_string_message = US "socket read timed out";
4321 /* The whole thing has worked (or we were skipping). If there is a
4322 failure string following, we need to skip it. */
4326 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
4328 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4329 while (isspace(*s)) s++;
4331 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4334 /* Come here on failure to create socket, connect socket, write to the
4335 socket, or timeout on reading. If another substring follows, expand and
4336 use it. Otherwise, those conditions give expand errors. */
4339 if (*s != '{') goto EXPAND_FAILED;
4340 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4341 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
4342 if (arg == NULL) goto EXPAND_FAILED;
4343 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4344 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4345 while (isspace(*s)) s++;
4346 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4350 /* Handle "run" to execute a program. */
4362 if ((expand_forbid & RDO_RUN) != 0)
4364 expand_string_message = US"running a command is not permitted";
4368 while (isspace(*s)) s++;
4369 if (*s != '{') goto EXPAND_FAILED_CURLY;
4370 arg = expand_string_internal(s+1, TRUE, &s, skipping);
4371 if (arg == NULL) goto EXPAND_FAILED;
4372 while (isspace(*s)) s++;
4373 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4375 if (skipping) /* Just pretend it worked when we're skipping */
4381 if (!transport_set_up_command(&argv, /* anchor for arg list */
4382 arg, /* raw command */
4383 FALSE, /* don't expand the arguments */
4384 0, /* not relevant when... */
4385 NULL, /* no transporting address */
4386 US"${run} expansion", /* for error messages */
4387 &expand_string_message)) /* where to put error message */
4392 /* Create the child process, making it a group leader. */
4394 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4398 expand_string_message =
4399 string_sprintf("couldn't create child process: %s", strerror(errno));
4403 /* Nothing is written to the standard input. */
4407 /* Wait for the process to finish, applying the timeout, and inspect its
4408 return code for serious disasters. Simple non-zero returns are passed on.
4411 if ((runrc = child_close(pid, 60)) < 0)
4415 expand_string_message = string_sprintf("command timed out");
4416 killpg(pid, SIGKILL); /* Kill the whole process group */
4419 else if (runrc == -257)
4420 expand_string_message = string_sprintf("wait() failed: %s",
4424 expand_string_message = string_sprintf("command killed by signal %d",
4430 /* Read the pipe to get the command's output into $value (which is kept
4431 in lookup_value). */
4433 f = fdopen(fd_out, "rb");
4434 lookup_value = NULL;
4435 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4439 /* Process the yes/no strings; $value may be useful in both cases */
4441 switch(process_yesno(
4442 skipping, /* were previously skipping */
4443 runrc == 0, /* success/failure indicator */
4444 lookup_value, /* value to reset for string2 */
4445 &s, /* input pointer */
4446 &yield, /* output pointer */
4447 &size, /* output size */
4448 &ptr, /* output current point */
4449 US"run")) /* condition type */
4451 case 1: goto EXPAND_FAILED; /* when all is well, the */
4452 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4458 /* Handle character translation for "tr" */
4466 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4468 case 1: goto EXPAND_FAILED_CURLY;
4470 case 3: goto EXPAND_FAILED;
4473 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4474 o2m = Ustrlen(sub[2]) - 1;
4476 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4478 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4482 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4489 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4490 expanded arguments. */
4500 int val[2] = { 0, -1 };
4503 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4504 Ensure that sub[2] is set in the ${length case. */
4507 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4510 case 1: goto EXPAND_FAILED_CURLY;
4512 case 3: goto EXPAND_FAILED;
4515 /* Juggle the arguments if there are only two of them: always move the
4516 string to the last position and make ${length{n}{str}} equivalent to
4517 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4523 if (item_type == EITEM_LENGTH)
4530 for (i = 0; i < 2; i++)
4532 if (sub[i] == NULL) continue;
4533 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4534 if (*ret != 0 || (i != 0 && val[i] < 0))
4536 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4537 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4543 (item_type == EITEM_HASH)?
4544 compute_hash(sub[2], val[0], val[1], &len) :
4545 (item_type == EITEM_NHASH)?
4546 compute_nhash(sub[2], val[0], val[1], &len) :
4547 extract_substr(sub[2], val[0], val[1], &len);
4549 if (ret == NULL) goto EXPAND_FAILED;
4550 yield = string_cat(yield, &size, &ptr, ret, len);
4554 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4555 This code originally contributed by Steve Haslam. It currently supports
4556 the use of MD5 and SHA-1 hashes.
4558 We need some workspace that is large enough to handle all the supported
4559 hash types. Use macros to set the sizes rather than be too elaborate. */
4561 #define MAX_HASHLEN 20
4562 #define MAX_HASHBLOCKLEN 64
4571 int hashlen; /* Number of octets for the hash algorithm's output */
4572 int hashblocklen; /* Number of octets the hash algorithm processes */
4574 unsigned int keylen;
4576 uschar keyhash[MAX_HASHLEN];
4577 uschar innerhash[MAX_HASHLEN];
4578 uschar finalhash[MAX_HASHLEN];
4579 uschar finalhash_hex[2*MAX_HASHLEN];
4580 uschar innerkey[MAX_HASHBLOCKLEN];
4581 uschar outerkey[MAX_HASHBLOCKLEN];
4583 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4585 case 1: goto EXPAND_FAILED_CURLY;
4587 case 3: goto EXPAND_FAILED;
4590 if (Ustrcmp(sub[0], "md5") == 0)
4593 use_base = &md5_base;
4597 else if (Ustrcmp(sub[0], "sha1") == 0)
4600 use_base = &sha1_base;
4606 expand_string_message =
4607 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4612 keylen = Ustrlen(keyptr);
4614 /* If the key is longer than the hash block length, then hash the key
4617 if (keylen > hashblocklen)
4619 chash_start(type, use_base);
4620 chash_end(type, use_base, keyptr, keylen, keyhash);
4625 /* Now make the inner and outer key values */
4627 memset(innerkey, 0x36, hashblocklen);
4628 memset(outerkey, 0x5c, hashblocklen);
4630 for (i = 0; i < keylen; i++)
4632 innerkey[i] ^= keyptr[i];
4633 outerkey[i] ^= keyptr[i];
4636 /* Now do the hashes */
4638 chash_start(type, use_base);
4639 chash_mid(type, use_base, innerkey);
4640 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4642 chash_start(type, use_base);
4643 chash_mid(type, use_base, outerkey);
4644 chash_end(type, use_base, innerhash, hashlen, finalhash);
4646 /* Encode the final hash as a hex string */
4649 for (i = 0; i < hashlen; i++)
4651 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4652 *p++ = hex_digits[finalhash[i] & 0x0f];
4655 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4656 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4658 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4663 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4664 We have to save the numerical variables and restore them afterwards. */
4669 int moffset, moffsetextra, slen;
4672 const uschar *rerror;
4675 int save_expand_nmax =
4676 save_expand_strings(save_expand_nstring, save_expand_nlength);
4678 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4680 case 1: goto EXPAND_FAILED_CURLY;
4682 case 3: goto EXPAND_FAILED;
4685 /* Compile the regular expression */
4687 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4692 expand_string_message = string_sprintf("regular expression error in "
4693 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4697 /* Now run a loop to do the substitutions as often as necessary. It ends
4698 when there are no more matches. Take care over matches of the null string;
4699 do the same thing as Perl does. */
4702 slen = Ustrlen(sub[0]);
4703 moffset = moffsetextra = 0;
4708 int ovector[3*(EXPAND_MAXN+1)];
4709 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4710 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4714 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4715 is not necessarily the end. We want to repeat the match from one
4716 character further along, but leaving the basic offset the same (for
4717 copying below). We can't be at the end of the string - that was checked
4718 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4719 finished; copy the remaining string and end the loop. */
4729 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4733 /* Match - set up for expanding the replacement. */
4735 if (n == 0) n = EXPAND_MAXN + 1;
4737 for (nn = 0; nn < n*2; nn += 2)
4739 expand_nstring[expand_nmax] = subject + ovector[nn];
4740 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4744 /* Copy the characters before the match, plus the expanded insertion. */
4746 yield = string_cat(yield, &size, &ptr, subject + moffset,
4747 ovector[0] - moffset);
4748 insert = expand_string(sub[2]);
4749 if (insert == NULL) goto EXPAND_FAILED;
4750 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4752 moffset = ovector[1];
4756 /* If we have matched an empty string, first check to see if we are at
4757 the end of the subject. If so, the loop is over. Otherwise, mimic
4758 what Perl's /g options does. This turns out to be rather cunning. First
4759 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4760 string at the same point. If this fails (picked up above) we advance to
4761 the next character. */
4763 if (ovector[0] == ovector[1])
4765 if (ovector[0] == slen) break;
4766 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4770 /* All done - restore numerical variables. */
4772 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4773 save_expand_nlength);
4777 /* Handle keyed and numbered substring extraction. If the first argument
4778 consists entirely of digits, then a numerical extraction is assumed. */
4784 int field_number = 1;
4785 BOOL field_number_set = FALSE;
4786 uschar *save_lookup_value = lookup_value;
4788 int save_expand_nmax =
4789 save_expand_strings(save_expand_nstring, save_expand_nlength);
4791 /* Read the arguments */
4793 for (i = 0; i < j; i++)
4795 while (isspace(*s)) s++;
4798 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4799 if (sub[i] == NULL) goto EXPAND_FAILED;
4800 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4802 /* After removal of leading and trailing white space, the first
4803 argument must not be empty; if it consists entirely of digits
4804 (optionally preceded by a minus sign), this is a numerical
4805 extraction, and we expect 3 arguments. */
4813 while (isspace(*p)) p++;
4817 while (len > 0 && isspace(p[len-1])) len--;
4820 if (*p == 0 && !skipping)
4822 expand_string_message = US"first argument of \"extract\" must "
4832 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4836 j = 3; /* Need 3 args */
4837 field_number_set = TRUE;
4841 else goto EXPAND_FAILED_CURLY;
4844 /* Extract either the numbered or the keyed substring into $value. If
4845 skipping, just pretend the extraction failed. */
4847 lookup_value = skipping? NULL : field_number_set?
4848 expand_gettokened(field_number, sub[1], sub[2]) :
4849 expand_getkeyed(sub[0], sub[1]);
4851 /* If no string follows, $value gets substituted; otherwise there can
4852 be yes/no strings, as for lookup or if. */
4854 switch(process_yesno(
4855 skipping, /* were previously skipping */
4856 lookup_value != NULL, /* success/failure indicator */
4857 save_lookup_value, /* value to reset for string2 */
4858 &s, /* input pointer */
4859 &yield, /* output pointer */
4860 &size, /* output size */
4861 &ptr, /* output current point */
4862 US"extract")) /* condition type */
4864 case 1: goto EXPAND_FAILED; /* when all is well, the */
4865 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4868 /* All done - restore numerical variables. */
4870 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4871 save_expand_nlength);
4877 /* Handle list operations */
4885 uschar outsep[2] = { '\0', '\0' };
4886 uschar *list, *expr, *temp;
4887 uschar *save_iterate_item = iterate_item;
4888 uschar *save_lookup_value = lookup_value;
4890 while (isspace(*s)) s++;
4891 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4893 list = expand_string_internal(s, TRUE, &s, skipping);
4894 if (list == NULL) goto EXPAND_FAILED;
4895 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4897 if (item_type == EITEM_REDUCE)
4899 while (isspace(*s)) s++;
4900 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4901 temp = expand_string_internal(s, TRUE, &s, skipping);
4902 if (temp == NULL) goto EXPAND_FAILED;
4903 lookup_value = temp;
4904 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4907 while (isspace(*s)) s++;
4908 if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4912 /* For EITEM_FILTER, call eval_condition once, with result discarded (as
4913 if scanning a "false" part). This allows us to find the end of the
4914 condition, because if the list is empty, we won't actually evaluate the
4915 condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
4916 the normal internal expansion function. */
4918 if (item_type == EITEM_FILTER)
4920 temp = eval_condition(expr, NULL);
4921 if (temp != NULL) s = temp;
4925 temp = expand_string_internal(s, TRUE, &s, TRUE);
4930 expand_string_message = string_sprintf("%s inside \"%s\" item",
4931 expand_string_message, name);
4935 while (isspace(*s)) s++;
4938 expand_string_message = string_sprintf("missing } at end of condition "
4939 "or expression inside \"%s\"", name);
4943 while (isspace(*s)) s++;
4946 expand_string_message = string_sprintf("missing } at end of \"%s\"",
4951 /* If we are skipping, we can now just move on to the next item. When
4952 processing for real, we perform the iteration. */
4954 if (skipping) continue;
4955 while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
4957 *outsep = (uschar)sep; /* Separator as a string */
4959 DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
4961 if (item_type == EITEM_FILTER)
4964 if (eval_condition(expr, &condresult) == NULL)
4966 iterate_item = save_iterate_item;
4967 lookup_value = save_lookup_value;
4968 expand_string_message = string_sprintf("%s inside \"%s\" condition",
4969 expand_string_message, name);
4972 DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
4973 condresult? "true":"false");
4975 temp = iterate_item; /* TRUE => include this item */
4977 continue; /* FALSE => skip this item */
4980 /* EITEM_MAP and EITEM_REDUCE */
4984 temp = expand_string_internal(expr, TRUE, NULL, skipping);
4987 iterate_item = save_iterate_item;
4988 expand_string_message = string_sprintf("%s inside \"%s\" item",
4989 expand_string_message, name);
4992 if (item_type == EITEM_REDUCE)
4994 lookup_value = temp; /* Update the value of $value */
4995 continue; /* and continue the iteration */
4999 /* We reach here for FILTER if the condition is true, always for MAP,
5000 and never for REDUCE. The value in "temp" is to be added to the output
5001 list that is being created, ensuring that any occurrences of the
5002 separator character are doubled. Unless we are dealing with the first
5003 item of the output list, add in a space if the new item begins with the
5004 separator character, or is an empty string. */
5006 if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5007 yield = string_cat(yield, &size, &ptr, US" ", 1);
5009 /* Add the string in "temp" to the output list that we are building,
5010 This is done in chunks by searching for the separator character. */
5014 size_t seglen = Ustrcspn(temp, outsep);
5015 yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5017 /* If we got to the end of the string we output one character
5018 too many; backup and end the loop. Otherwise arrange to double the
5021 if (temp[seglen] == '\0') { ptr--; break; }
5022 yield = string_cat(yield, &size, &ptr, outsep, 1);
5026 /* Output a separator after the string: we will remove the redundant
5027 final one at the end. */
5029 yield = string_cat(yield, &size, &ptr, outsep, 1);
5030 } /* End of iteration over the list loop */
5032 /* REDUCE has generated no output above: output the final value of
5035 if (item_type == EITEM_REDUCE)
5037 yield = string_cat(yield, &size, &ptr, lookup_value,
5038 Ustrlen(lookup_value));
5039 lookup_value = save_lookup_value; /* Restore $value */
5042 /* FILTER and MAP generate lists: if they have generated anything, remove
5043 the redundant final separator. Even though an empty item at the end of a
5044 list does not count, this is tidier. */
5046 else if (ptr != save_ptr) ptr--;
5048 /* Restore preserved $item */
5050 iterate_item = save_iterate_item;
5055 /* If ${dlfunc support is configured, handle calling dynamically-loaded
5056 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5057 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5058 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5060 #define EXPAND_DLFUNC_MAX_ARGS 8
5063 #ifndef EXPAND_DLFUNC
5064 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5065 "is not included in this binary";
5068 #else /* EXPAND_DLFUNC */
5071 exim_dlfunc_t *func;
5074 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5076 if ((expand_forbid & RDO_DLFUNC) != 0)
5078 expand_string_message =
5079 US"dynamically-loaded functions are not permitted";
5083 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5086 case 1: goto EXPAND_FAILED_CURLY;
5088 case 3: goto EXPAND_FAILED;
5091 /* If skipping, we don't actually do anything */
5093 if (skipping) continue;
5095 /* Look up the dynamically loaded object handle in the tree. If it isn't
5096 found, dlopen() the file and put the handle in the tree for next time. */
5098 t = tree_search(dlobj_anchor, argv[0]);
5101 void *handle = dlopen(CS argv[0], RTLD_LAZY);
5104 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5105 argv[0], dlerror());
5106 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5109 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5110 Ustrcpy(t->name, argv[0]);
5111 t->data.ptr = handle;
5112 (void)tree_insertnode(&dlobj_anchor, t);
5115 /* Having obtained the dynamically loaded object handle, look up the
5116 function pointer. */
5118 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5121 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5122 "%s", argv[1], argv[0], dlerror());
5123 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5127 /* Call the function and work out what to do with the result. If it
5128 returns OK, we have a replacement string; if it returns DEFER then
5129 expansion has failed in a non-forced manner; if it returns FAIL then
5130 failure was forced; if it returns ERROR or any other value there's a
5131 problem, so panic slightly. In any case, assume that the function has
5132 side-effects on the store that must be preserved. */
5136 for (argc = 0; argv[argc] != NULL; argc++);
5137 status = func(&result, argc - 2, &argv[2]);
5140 if (result == NULL) result = US"";
5141 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5146 expand_string_message = result == NULL ? US"(no message)" : result;
5147 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5148 else if(status != FAIL)
5149 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5150 argv[0], argv[1], status, expand_string_message);
5154 #endif /* EXPAND_DLFUNC */
5157 /* Control reaches here if the name is not recognized as one of the more
5158 complicated expansion items. Check for the "operator" syntax (name terminated
5159 by a colon). Some of the operators have arguments, separated by _ from the
5166 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
5167 if (sub == NULL) goto EXPAND_FAILED;
5170 /* Owing to an historical mis-design, an underscore may be part of the
5171 operator name, or it may introduce arguments. We therefore first scan the
5172 table of names that contain underscores. If there is no match, we cut off
5173 the arguments and then scan the main table. */
5175 c = chop_match(name, op_table_underscore,
5176 sizeof(op_table_underscore)/sizeof(uschar *));
5180 arg = Ustrchr(name, '_');
5181 if (arg != NULL) *arg = 0;
5182 c = chop_match(name, op_table_main,
5183 sizeof(op_table_main)/sizeof(uschar *));
5184 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5185 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
5188 /* If we are skipping, we don't need to perform the operation at all.
5189 This matters for operations like "mask", because the data may not be
5190 in the correct format when skipping. For example, the expression may test
5191 for the existence of $sender_host_address before trying to mask it. For
5192 other operations, doing them may not fail, but it is a waste of time. */
5194 if (skipping && c >= 0) continue;
5196 /* Otherwise, switch on the operator type */
5203 unsigned long int n = Ustrtoul(sub, &t, 10);
5206 expand_string_message = string_sprintf("argument for base62 "
5207 "operator is \"%s\", which is not a decimal number", sub);
5210 t = string_base62(n);
5211 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5215 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5221 unsigned long int n = 0;
5224 uschar *t = Ustrchr(base62_chars, *tt++);
5227 expand_string_message = string_sprintf("argument for base62d "
5228 "operator is \"%s\", which is not a base %d number", sub,
5232 n = n * BASE_62 + (t - base62_chars);
5234 (void)sprintf(CS buf, "%ld", n);
5235 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5241 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
5242 if (expanded == NULL)
5244 expand_string_message =
5245 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5246 expand_string_message);
5249 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5256 uschar *t = sub - 1;
5257 while (*(++t) != 0) { *t = tolower(*t); count++; }
5258 yield = string_cat(yield, &size, &ptr, sub, count);
5265 uschar *t = sub - 1;
5266 while (*(++t) != 0) { *t = toupper(*t); count++; }
5267 yield = string_cat(yield, &size, &ptr, sub, count);
5278 md5_end(&base, sub, Ustrlen(sub), digest);
5279 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5280 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5291 sha1_end(&base, sub, Ustrlen(sub), digest);
5292 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5293 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5297 /* Convert hex encoding to base64 encoding */
5307 for (enc = sub; *enc != 0; enc++)
5309 if (!isxdigit(*enc))
5311 expand_string_message = string_sprintf("\"%s\" is not a hex "
5320 expand_string_message = string_sprintf("\"%s\" contains an odd "
5321 "number of characters", sub);
5325 while ((c = *in++) != 0)
5327 if (isdigit(c)) c -= '0';
5328 else c = toupper(c) - 'A' + 10;
5340 enc = auth_b64encode(sub, out - sub);
5341 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5345 /* mask applies a mask to an IP address; for example the result of
5346 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5353 int mask, maskoffset;
5354 int type = string_is_ip_address(sub, &maskoffset);
5359 expand_string_message = string_sprintf("\"%s\" is not an IP address",
5364 if (maskoffset == 0)
5366 expand_string_message = string_sprintf("missing mask value in \"%s\"",
5371 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5373 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5375 expand_string_message = string_sprintf("mask value too big in \"%s\"",
5380 /* Convert the address to binary integer(s) and apply the mask */
5382 sub[maskoffset] = 0;
5383 count = host_aton(sub, binary);
5384 host_mask(count, binary, mask);
5386 /* Convert to masked textual format and add to output. */
5388 yield = string_cat(yield, &size, &ptr, buffer,
5389 host_nmtoa(count, binary, mask, buffer, '.'));
5394 case EOP_LOCAL_PART:
5398 int start, end, domain;
5399 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5403 if (c != EOP_DOMAIN)
5405 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5406 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5408 else if (domain != 0)
5411 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5419 uschar outsep[2] = { ':', '\0' };
5420 uschar *address, *error;
5422 int start, end, domain; /* Not really used */
5424 while (isspace(*sub)) sub++;
5425 if (*sub == '>') { *outsep = *++sub; ++sub; }
5426 parse_allow_group = TRUE;
5430 uschar *p = parse_find_address_end(sub, FALSE);
5431 uschar saveend = *p;
5433 address = parse_extract_address(sub, &error, &start, &end, &domain,
5437 /* Add the address to the output list that we are building. This is
5438 done in chunks by searching for the separator character. At the
5439 start, unless we are dealing with the first address of the output
5440 list, add in a space if the new address begins with the separator
5441 character, or is an empty string. */
5443 if (address != NULL)
5445 if (ptr != save_ptr && address[0] == *outsep)
5446 yield = string_cat(yield, &size, &ptr, US" ", 1);
5450 size_t seglen = Ustrcspn(address, outsep);
5451 yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5453 /* If we got to the end of the string we output one character
5456 if (address[seglen] == '\0') { ptr--; break; }
5457 yield = string_cat(yield, &size, &ptr, outsep, 1);
5458 address += seglen + 1;
5461 /* Output a separator after the string: we will remove the
5462 redundant final one at the end. */
5464 yield = string_cat(yield, &size, &ptr, outsep, 1);
5467 if (saveend == '\0') break;
5471 /* If we have generated anything, remove the redundant final
5474 if (ptr != save_ptr) ptr--;
5475 parse_allow_group = FALSE;
5480 /* quote puts a string in quotes if it is empty or contains anything
5481 other than alphamerics, underscore, dot, or hyphen.
5483 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5484 be quoted in order to be a valid local part.
5486 In both cases, newlines and carriage returns are converted into \n and \r
5490 case EOP_QUOTE_LOCAL_PART:
5493 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
5494 uschar *t = sub - 1;
5498 while (!needs_quote && *(++t) != 0)
5499 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5501 else /* EOP_QUOTE_LOCAL_PART */
5503 while (!needs_quote && *(++t) != 0)
5504 needs_quote = !isalnum(*t) &&
5505 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5506 (*t != '.' || t == sub || t[1] == 0);
5511 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5516 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5517 else if (*t == '\r')
5518 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5521 if (*t == '\\' || *t == '"')
5522 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5523 yield = string_cat(yield, &size, &ptr, t, 1);
5526 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5528 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5532 /* quote_lookuptype does lookup-specific quoting */
5537 uschar *opt = Ustrchr(arg, '_');
5539 if (opt != NULL) *opt++ = 0;
5541 n = search_findtype(arg, Ustrlen(arg));
5544 expand_string_message = search_error_message;
5548 if (lookup_list[n]->quote != NULL)
5549 sub = (lookup_list[n]->quote)(sub, opt);
5550 else if (opt != NULL) sub = NULL;
5554 expand_string_message = string_sprintf(
5555 "\"%s\" unrecognized after \"${quote_%s\"",
5560 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5564 /* rx quote sticks in \ before any non-alphameric character so that
5565 the insertion works in a regular expression. */
5569 uschar *t = sub - 1;
5573 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5574 yield = string_cat(yield, &size, &ptr, t, 1);
5579 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5580 prescribed by the RFC, if there are characters that need to be encoded */
5584 uschar buffer[2048];
5585 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5586 buffer, sizeof(buffer), FALSE);
5587 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5591 /* RFC 2047 decode */
5597 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5598 headers_charset, '?', &len, &error);
5601 expand_string_message = error;
5604 yield = string_cat(yield, &size, &ptr, decoded, len);
5608 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5618 if (c > 255) c = '_';
5620 yield = string_cat(yield, &size, &ptr, buff, 1);
5625 /* escape turns all non-printing characters into escape sequences. */
5629 uschar *t = string_printing(sub);
5630 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5634 /* Handle numeric expression evaluation */
5639 uschar *save_sub = sub;
5640 uschar *error = NULL;
5641 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5644 expand_string_message = string_sprintf("error in expression "
5645 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5649 sprintf(CS var_buffer, "%d", n);
5650 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5654 /* Handle time period formating */
5658 int n = readconf_readtime(sub, 0, FALSE);
5661 expand_string_message = string_sprintf("string \"%s\" is not an "
5662 "Exim time interval in \"%s\" operator", sub, name);
5665 sprintf(CS var_buffer, "%d", n);
5666 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5670 case EOP_TIME_INTERVAL:
5673 uschar *t = read_number(&n, sub);
5674 if (*t != 0) /* Not A Number*/
5676 expand_string_message = string_sprintf("string \"%s\" is not a "
5677 "positive number in \"%s\" operator", sub, name);
5680 t = readconf_printtime(n);
5681 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5685 /* Convert string to base64 encoding */
5689 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5690 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5694 /* strlen returns the length of the string */
5699 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5700 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5704 /* length_n or l_n takes just the first n characters or the whole string,
5705 whichever is the shorter;
5707 substr_m_n, and s_m_n take n characters from offset m; negative m take
5708 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5709 takes the rest, either to the right or to the left.
5711 hash_n or h_n makes a hash of length n from the string, yielding n
5712 characters from the set a-z; hash_n_m makes a hash of length n, but
5713 uses m characters from the set a-zA-Z0-9.
5715 nhash_n returns a single number between 0 and n-1 (in text form), while
5716 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5717 between 0 and n-1 and the second between 0 and m-1. */
5737 expand_string_message = string_sprintf("missing values after %s",
5742 /* "length" has only one argument, effectively being synonymous with
5745 if (c == EOP_LENGTH || c == EOP_L)
5751 /* The others have one or two arguments; for "substr" the first may be
5752 negative. The second being negative means "not supplied". */
5757 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5760 /* Read up to two numbers, separated by underscores */
5765 if (arg != ret && *arg == '_' && pn == &value1)
5769 if (arg[1] != 0) arg++;
5771 else if (!isdigit(*arg))
5773 expand_string_message =
5774 string_sprintf("non-digit after underscore in \"%s\"", name);
5777 else *pn = (*pn)*10 + *arg++ - '0';
5781 /* Perform the required operation */
5784 (c == EOP_HASH || c == EOP_H)?
5785 compute_hash(sub, value1, value2, &len) :
5786 (c == EOP_NHASH || c == EOP_NH)?
5787 compute_nhash(sub, value1, value2, &len) :
5788 extract_substr(sub, value1, value2, &len);
5790 if (ret == NULL) goto EXPAND_FAILED;
5791 yield = string_cat(yield, &size, &ptr, ret, len);
5801 uschar **modetable[3];
5806 if ((expand_forbid & RDO_EXISTS) != 0)
5808 expand_string_message = US"Use of the stat() expansion is not permitted";
5812 if (stat(CS sub, &st) < 0)
5814 expand_string_message = string_sprintf("stat(%s) failed: %s",
5815 sub, strerror(errno));
5819 switch (mode & S_IFMT)
5821 case S_IFIFO: smode[0] = 'p'; break;
5822 case S_IFCHR: smode[0] = 'c'; break;
5823 case S_IFDIR: smode[0] = 'd'; break;
5824 case S_IFBLK: smode[0] = 'b'; break;
5825 case S_IFREG: smode[0] = '-'; break;
5826 default: smode[0] = '?'; break;
5829 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5830 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5831 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5833 for (i = 0; i < 3; i++)
5835 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5840 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5841 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5842 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5843 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5844 (long)st.st_gid, st.st_size, (long)st.st_atime,
5845 (long)st.st_mtime, (long)st.st_ctime);
5846 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5850 /* pseudo-random number less than N */
5857 max = expand_string_integer(sub, TRUE);
5858 if (expand_string_message != NULL)
5860 s = string_sprintf("%d", pseudo_random_number(max));
5861 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5865 /* Reverse IP, including IPv6 to dotted-nibble */
5867 case EOP_REVERSE_IP:
5869 int family, maskptr;
5870 uschar reversed[128];
5872 family = string_is_ip_address(sub, &maskptr);
5875 expand_string_message = string_sprintf(
5876 "reverse_ip() not given an IP address [%s]", sub);
5879 invert_address(reversed, sub);
5880 yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
5884 /* Unknown operator */
5887 expand_string_message =
5888 string_sprintf("unknown expansion operator \"%s\"", name);
5893 /* Handle a plain name. If this is the first thing in the expansion, release
5894 the pre-allocated buffer. If the result data is known to be in a new buffer,
5895 newsize will be set to the size of that buffer, and we can just point at that
5896 store instead of copying. Many expansion strings contain just one reference,
5897 so this is a useful optimization, especially for humungous headers
5898 ($message_headers). */
5906 if (resetok) store_reset(yield);
5910 value = find_variable(name, FALSE, skipping, &newsize);
5913 expand_string_message =
5914 string_sprintf("unknown variable in \"${%s}\"", name);
5915 check_variable_error_message(name);
5918 len = Ustrlen(value);
5919 if (yield == NULL && newsize != 0)
5925 else yield = string_cat(yield, &size, &ptr, value, len);
5929 /* Else there's something wrong */
5931 expand_string_message =
5932 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5933 "in a variable reference)", name);
5937 /* If we hit the end of the string when ket_ends is set, there is a missing
5938 terminating brace. */
5940 if (ket_ends && *s == 0)
5942 expand_string_message = malformed_header?
5943 US"missing } at end of string - could be header name not terminated by colon"
5945 US"missing } at end of string";
5949 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5950 added to the string. If so, set up an empty string. Add a terminating zero. If
5951 left != NULL, return a pointer to the terminator. */
5953 if (yield == NULL) yield = store_get(1);
5955 if (left != NULL) *left = s;
5957 /* Any stacking store that was used above the final string is no longer needed.
5958 In many cases the final string will be the first one that was got and so there
5959 will be optimal store usage. */
5961 if (resetok) store_reset(yield + ptr + 1);
5964 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5966 if (skipping) debug_printf("skipping: result is not used\n");
5970 /* This is the failure exit: easiest to program with a goto. We still need
5971 to update the pointer to the terminator, for cases of nested calls with "fail".
5974 EXPAND_FAILED_CURLY:
5975 expand_string_message = malformed_header?
5976 US"missing or misplaced { or } - could be header name not terminated by colon"
5978 US"missing or misplaced { or }";
5980 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5981 that is a bad idea, because expand_string_message is in dynamic store. */
5984 if (left != NULL) *left = s;
5987 debug_printf("failed to expand: %s\n", string);
5988 debug_printf(" error message: %s\n", expand_string_message);
5989 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5995 /* This is the external function call. Do a quick check for any expansion
5996 metacharacters, and if there are none, just return the input string.
5998 Argument: the string to be expanded
5999 Returns: the expanded string, or NULL if expansion failed; if failure was
6000 due to a lookup deferring, search_find_defer will be TRUE
6004 expand_string(uschar *string)
6006 search_find_defer = FALSE;
6007 malformed_header = FALSE;
6008 return (Ustrpbrk(string, "$\\") == NULL)? string :
6009 expand_string_internal(string, FALSE, NULL, FALSE);
6014 /*************************************************
6016 *************************************************/
6018 /* Now and again we want to expand a string and be sure that the result is in a
6019 new bit of store. This function does that.
6021 Argument: the string to be expanded
6022 Returns: the expanded string, always in a new bit of store, or NULL
6026 expand_string_copy(uschar *string)
6028 uschar *yield = expand_string(string);
6029 if (yield == string) yield = string_copy(string);
6035 /*************************************************
6036 * Expand and interpret as an integer *
6037 *************************************************/
6039 /* Expand a string, and convert the result into an integer.
6042 string the string to be expanded
6043 isplus TRUE if a non-negative number is expected
6045 Returns: the integer value, or
6046 -1 for an expansion error ) in both cases, message in
6047 -2 for an integer interpretation error ) expand_string_message
6048 expand_string_message is set NULL for an OK integer
6052 expand_string_integer(uschar *string, BOOL isplus)
6055 uschar *s = expand_string(string);
6056 uschar *msg = US"invalid integer \"%s\"";
6059 /* If expansion failed, expand_string_message will be set. */
6061 if (s == NULL) return -1;
6063 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6064 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6065 systems, so we set it zero ourselves. */
6068 expand_string_message = NULL; /* Indicates no error */
6070 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6071 equal to 0. Unfortunately, people actually relied upon that, so preserve
6072 the behaviour explicitly. Stripping leading whitespace is a harmless
6073 noop change since strtol skips it anyway (provided that there is a number
6077 while (isspace(*s)) ++s;
6081 debug_printf("treating blank string as number 0\n");
6086 value = strtol(CS s, CSS &endptr, 10);
6090 msg = US"integer expected but \"%s\" found";
6092 else if (value < 0 && isplus)
6094 msg = US"non-negative integer expected but \"%s\" found";
6098 /* Ensure we can cast this down to an int */
6099 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
6101 if (errno != ERANGE)
6103 if (tolower(*endptr) == 'k')
6105 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
6109 else if (tolower(*endptr) == 'm')
6111 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
6113 else value *= 1024*1024;
6117 if (errno == ERANGE)
6118 msg = US"absolute value of integer \"%s\" is too large (overflow)";
6121 while (isspace(*endptr)) endptr++;
6122 if (*endptr == 0) return (int)value;
6126 expand_string_message = string_sprintf(CS msg, s);
6131 /*************************************************
6132 **************************************************
6133 * Stand-alone test program *
6134 **************************************************
6135 *************************************************/
6141 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6143 int ovector[3*(EXPAND_MAXN+1)];
6144 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6145 ovector, sizeof(ovector)/sizeof(int));
6146 BOOL yield = n >= 0;
6147 if (n == 0) n = EXPAND_MAXN + 1;
6151 expand_nmax = (setup < 0)? 0 : setup + 1;
6152 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6154 expand_nstring[expand_nmax] = subject + ovector[nn];
6155 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6163 int main(int argc, uschar **argv)
6166 uschar buffer[1024];
6168 debug_selector = D_v;
6169 debug_file = stderr;
6170 debug_fd = fileno(debug_file);
6171 big_buffer = malloc(big_buffer_size);
6173 for (i = 1; i < argc; i++)
6175 if (argv[i][0] == '+')
6177 debug_trace_memory = 2;
6180 if (isdigit(argv[i][0]))
6181 debug_selector = Ustrtol(argv[i], NULL, 0);
6183 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6187 eldap_default_servers = argv[i];
6190 mysql_servers = argv[i];
6193 pgsql_servers = argv[i];
6197 else opt_perl_startup = argv[i];
6201 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6203 expand_nstring[1] = US"string 1....";
6204 expand_nlength[1] = 8;
6208 if (opt_perl_startup != NULL)
6211 printf("Starting Perl interpreter\n");
6212 errstr = init_perl(opt_perl_startup);
6215 printf("** error in perl_startup code: %s\n", errstr);
6216 return EXIT_FAILURE;
6219 #endif /* EXIM_PERL */
6221 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6223 void *reset_point = store_get(0);
6224 uschar *yield = expand_string(buffer);
6227 printf("%s\n", yield);
6228 store_reset(reset_point);
6232 if (search_find_defer) printf("search_find deferred\n");
6233 printf("Failed: %s\n", expand_string_message);
6234 if (expand_string_forcedfail) printf("Forced failure\n");
6246 /* End of expand.c */