1 /* $Cambridge: exim/src/src/expand.c,v 1.79 2007/01/31 11:30:08 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2007 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /* Functions for handling string expansion. */
16 /* Recursively called function */
18 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
21 #ifndef SUPPORT_CRYPTEQ
22 #define SUPPORT_CRYPTEQ
27 #include "lookups/ldap.h"
30 #ifdef SUPPORT_CRYPTEQ
35 extern char* crypt16(char*, char*);
39 /* The handling of crypt16() is a mess. I will record below the analysis of the
40 mess that was sent to me. We decided, however, to make changing this very low
41 priority, because in practice people are moving away from the crypt()
42 algorithms nowadays, so it doesn't seem worth it.
45 There is an algorithm named "crypt16" in Ultrix and Tru64. It crypts
46 the first 8 characters of the password using a 20-round version of crypt
47 (standard crypt does 25 rounds). It then crypts the next 8 characters,
48 or an empty block if the password is less than 9 characters, using a
49 20-round version of crypt and the same salt as was used for the first
50 block. Charaters after the first 16 are ignored. It always generates
51 a 16-byte hash, which is expressed together with the salt as a string
52 of 24 base 64 digits. Here are some links to peruse:
54 http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
55 http://seclists.org/bugtraq/1999/Mar/0076.html
57 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
58 and OSF/1. This is the same as the standard crypt if given a password
59 of 8 characters or less. If given more, it first does the same as crypt
60 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
61 using as salt the first two base 64 digits from the first hash block.
62 If the password is more than 16 characters then it crypts the 17th to 24th
63 characters using as salt the first two base 64 digits from the second hash
64 block. And so on: I've seen references to it cutting off the password at
65 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks). Some links:
67 http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
68 http://seclists.org/bugtraq/1999/Mar/0109.html
69 http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
70 TET1_html/sec.c222.html#no_id_208
72 Exim has something it calls "crypt16". It will either use a native
73 crypt16 or its own implementation. A native crypt16 will presumably
74 be the one that I called "crypt16" above. The internal "crypt16"
75 function, however, is a two-block-maximum implementation of what I called
76 "bigcrypt". The documentation matches the internal code.
78 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
79 that crypt16 and bigcrypt were different things.
81 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
82 to whatever it is using under that name. This unfortunately sets a
83 precedent for using "{crypt16}" to identify two incompatible algorithms
84 whose output can't be distinguished. With "{crypt16}" thus rendered
85 ambiguous, I suggest you deprecate it and invent two new identifiers
86 for the two algorithms.
88 Both crypt16 and bigcrypt are very poor algorithms, btw. Hashing parts
89 of the password separately means they can be cracked separately, so
90 the double-length hash only doubles the cracking effort instead of
91 squaring it. I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
99 /*************************************************
100 * Local statics and tables *
101 *************************************************/
103 /* Table of item names, and corresponding switch numbers. The names must be in
104 alphabetical order. */
106 static uschar *item_table[] = {
144 /* Tables of operator names, and corresponding switch numbers. The names must be
145 in alphabetical order. There are two tables, because underscore is used in some
146 cases to introduce arguments, whereas for other it is part of the name. This is
147 an historical mis-design. */
149 static uschar *op_table_underscore[] = {
152 US"quote_local_part",
159 EOP_QUOTE_LOCAL_PART,
163 static uschar *op_table_main[] = {
195 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
226 /* Table of condition names, and corresponding switch numbers. The names must
227 be in alphabetical order. */
229 static uschar *cond_table[] = {
233 US"==", /* Backward compatibility */
259 US"match_local_part",
281 ECOND_FIRST_DELIVERY,
298 ECOND_MATCH_LOCAL_PART,
308 /* Type for main variable table */
316 /* Type for entries pointing to address/length pairs. Not currently
324 /* Types of table entry */
327 vtype_int, /* value is address of int */
328 vtype_filter_int, /* ditto, but recognized only when filtering */
329 vtype_ino, /* value is address of ino_t (not always an int) */
330 vtype_uid, /* value is address of uid_t (not always an int) */
331 vtype_gid, /* value is address of gid_t (not always an int) */
332 vtype_stringptr, /* value is address of pointer to string */
333 vtype_msgbody, /* as stringptr, but read when first required */
334 vtype_msgbody_end, /* ditto, the end of the message */
335 vtype_msgheaders, /* the message's headers, processed */
336 vtype_msgheaders_raw, /* the message's headers, unprocessed */
337 vtype_localpart, /* extract local part from string */
338 vtype_domain, /* extract domain from string */
339 vtype_recipients, /* extract recipients from recipients list */
340 /* (enabled only during system filtering */
341 vtype_todbsdin, /* value not used; generate BSD inbox tod */
342 vtype_tode, /* value not used; generate tod in epoch format */
343 vtype_todf, /* value not used; generate full tod */
344 vtype_todl, /* value not used; generate log tod */
345 vtype_todlf, /* value not used; generate log file datestamp tod */
346 vtype_todzone, /* value not used; generate time zone only */
347 vtype_todzulu, /* value not used; generate zulu tod */
348 vtype_reply, /* value not used; get reply from headers */
349 vtype_pid, /* value not used; result is pid */
350 vtype_host_lookup, /* value not used; get host name */
351 vtype_load_avg, /* value not used; result is int from os_getloadavg */
352 vtype_pspace, /* partition space; value is T/F for spool/log */
353 vtype_pinodes /* partition inodes; value is T/F for spool/log */
354 #ifdef EXPERIMENTAL_DOMAINKEYS
355 ,vtype_dk_verify /* Serve request out of DomainKeys verification structure */
359 /* This table must be kept in alphabetical order. */
361 static var_entry var_table[] = {
362 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
363 they will be confused with user-creatable ACL variables. */
364 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
365 { "address_data", vtype_stringptr, &deliver_address_data },
366 { "address_file", vtype_stringptr, &address_file },
367 { "address_pipe", vtype_stringptr, &address_pipe },
368 { "authenticated_id", vtype_stringptr, &authenticated_id },
369 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
370 { "authentication_failed",vtype_int, &authentication_failed },
371 #ifdef EXPERIMENTAL_BRIGHTMAIL
372 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
373 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
374 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
375 { "bmi_deliver", vtype_int, &bmi_deliver },
377 { "body_linecount", vtype_int, &body_linecount },
378 { "body_zerocount", vtype_int, &body_zerocount },
379 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
380 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
381 { "caller_gid", vtype_gid, &real_gid },
382 { "caller_uid", vtype_uid, &real_uid },
383 { "compile_date", vtype_stringptr, &version_date },
384 { "compile_number", vtype_stringptr, &version_cnumber },
385 { "csa_status", vtype_stringptr, &csa_status },
386 #ifdef WITH_OLD_DEMIME
387 { "demime_errorlevel", vtype_int, &demime_errorlevel },
388 { "demime_reason", vtype_stringptr, &demime_reason },
390 #ifdef EXPERIMENTAL_DOMAINKEYS
391 { "dk_domain", vtype_stringptr, &dk_signing_domain },
392 { "dk_is_signed", vtype_dk_verify, NULL },
393 { "dk_result", vtype_dk_verify, NULL },
394 { "dk_selector", vtype_stringptr, &dk_signing_selector },
395 { "dk_sender", vtype_dk_verify, NULL },
396 { "dk_sender_domain", vtype_dk_verify, NULL },
397 { "dk_sender_local_part",vtype_dk_verify, NULL },
398 { "dk_sender_source", vtype_dk_verify, NULL },
399 { "dk_signsall", vtype_dk_verify, NULL },
400 { "dk_status", vtype_dk_verify, NULL },
401 { "dk_testing", vtype_dk_verify, NULL },
403 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
404 { "dnslist_text", vtype_stringptr, &dnslist_text },
405 { "dnslist_value", vtype_stringptr, &dnslist_value },
406 { "domain", vtype_stringptr, &deliver_domain },
407 { "domain_data", vtype_stringptr, &deliver_domain_data },
408 { "exim_gid", vtype_gid, &exim_gid },
409 { "exim_path", vtype_stringptr, &exim_path },
410 { "exim_uid", vtype_uid, &exim_uid },
411 #ifdef WITH_OLD_DEMIME
412 { "found_extension", vtype_stringptr, &found_extension },
414 { "home", vtype_stringptr, &deliver_home },
415 { "host", vtype_stringptr, &deliver_host },
416 { "host_address", vtype_stringptr, &deliver_host_address },
417 { "host_data", vtype_stringptr, &host_data },
418 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
419 { "host_lookup_failed", vtype_int, &host_lookup_failed },
420 { "inode", vtype_ino, &deliver_inode },
421 { "interface_address", vtype_stringptr, &interface_address },
422 { "interface_port", vtype_int, &interface_port },
424 { "ldap_dn", vtype_stringptr, &eldap_dn },
426 { "load_average", vtype_load_avg, NULL },
427 { "local_part", vtype_stringptr, &deliver_localpart },
428 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
429 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
430 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
431 { "local_scan_data", vtype_stringptr, &local_scan_data },
432 { "local_user_gid", vtype_gid, &local_user_gid },
433 { "local_user_uid", vtype_uid, &local_user_uid },
434 { "localhost_number", vtype_int, &host_number },
435 { "log_inodes", vtype_pinodes, (void *)FALSE },
436 { "log_space", vtype_pspace, (void *)FALSE },
437 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
438 #ifdef WITH_CONTENT_SCAN
439 { "malware_name", vtype_stringptr, &malware_name },
441 { "message_age", vtype_int, &message_age },
442 { "message_body", vtype_msgbody, &message_body },
443 { "message_body_end", vtype_msgbody_end, &message_body_end },
444 { "message_body_size", vtype_int, &message_body_size },
445 { "message_exim_id", vtype_stringptr, &message_id },
446 { "message_headers", vtype_msgheaders, NULL },
447 { "message_headers_raw", vtype_msgheaders_raw, NULL },
448 { "message_id", vtype_stringptr, &message_id },
449 { "message_linecount", vtype_int, &message_linecount },
450 { "message_size", vtype_int, &message_size },
451 #ifdef WITH_CONTENT_SCAN
452 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
453 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
454 { "mime_boundary", vtype_stringptr, &mime_boundary },
455 { "mime_charset", vtype_stringptr, &mime_charset },
456 { "mime_content_description", vtype_stringptr, &mime_content_description },
457 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
458 { "mime_content_id", vtype_stringptr, &mime_content_id },
459 { "mime_content_size", vtype_int, &mime_content_size },
460 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
461 { "mime_content_type", vtype_stringptr, &mime_content_type },
462 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
463 { "mime_filename", vtype_stringptr, &mime_filename },
464 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
465 { "mime_is_multipart", vtype_int, &mime_is_multipart },
466 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
467 { "mime_part_count", vtype_int, &mime_part_count },
469 { "n0", vtype_filter_int, &filter_n[0] },
470 { "n1", vtype_filter_int, &filter_n[1] },
471 { "n2", vtype_filter_int, &filter_n[2] },
472 { "n3", vtype_filter_int, &filter_n[3] },
473 { "n4", vtype_filter_int, &filter_n[4] },
474 { "n5", vtype_filter_int, &filter_n[5] },
475 { "n6", vtype_filter_int, &filter_n[6] },
476 { "n7", vtype_filter_int, &filter_n[7] },
477 { "n8", vtype_filter_int, &filter_n[8] },
478 { "n9", vtype_filter_int, &filter_n[9] },
479 { "original_domain", vtype_stringptr, &deliver_domain_orig },
480 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
481 { "originator_gid", vtype_gid, &originator_gid },
482 { "originator_uid", vtype_uid, &originator_uid },
483 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
484 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
485 { "pid", vtype_pid, NULL },
486 { "primary_hostname", vtype_stringptr, &primary_hostname },
487 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
488 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
489 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
490 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
491 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
492 { "rcpt_count", vtype_int, &rcpt_count },
493 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
494 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
495 { "received_count", vtype_int, &received_count },
496 { "received_for", vtype_stringptr, &received_for },
497 { "received_ip_address", vtype_stringptr, &interface_address },
498 { "received_port", vtype_int, &interface_port },
499 { "received_protocol", vtype_stringptr, &received_protocol },
500 { "received_time", vtype_int, &received_time },
501 { "recipient_data", vtype_stringptr, &recipient_data },
502 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
503 { "recipients", vtype_recipients, NULL },
504 { "recipients_count", vtype_int, &recipients_count },
505 #ifdef WITH_CONTENT_SCAN
506 { "regex_match_string", vtype_stringptr, ®ex_match_string },
508 { "reply_address", vtype_reply, NULL },
509 { "return_path", vtype_stringptr, &return_path },
510 { "return_size_limit", vtype_int, &bounce_return_size_limit },
511 { "runrc", vtype_int, &runrc },
512 { "self_hostname", vtype_stringptr, &self_hostname },
513 { "sender_address", vtype_stringptr, &sender_address },
514 { "sender_address_data", vtype_stringptr, &sender_address_data },
515 { "sender_address_domain", vtype_domain, &sender_address },
516 { "sender_address_local_part", vtype_localpart, &sender_address },
517 { "sender_data", vtype_stringptr, &sender_data },
518 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
519 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
520 { "sender_host_address", vtype_stringptr, &sender_host_address },
521 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
522 { "sender_host_name", vtype_host_lookup, NULL },
523 { "sender_host_port", vtype_int, &sender_host_port },
524 { "sender_ident", vtype_stringptr, &sender_ident },
525 { "sender_rate", vtype_stringptr, &sender_rate },
526 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
527 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
528 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
529 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
530 { "sending_ip_address", vtype_stringptr, &sending_ip_address },
531 { "sending_port", vtype_int, &sending_port },
532 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
533 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
534 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
535 { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
536 { "sn0", vtype_filter_int, &filter_sn[0] },
537 { "sn1", vtype_filter_int, &filter_sn[1] },
538 { "sn2", vtype_filter_int, &filter_sn[2] },
539 { "sn3", vtype_filter_int, &filter_sn[3] },
540 { "sn4", vtype_filter_int, &filter_sn[4] },
541 { "sn5", vtype_filter_int, &filter_sn[5] },
542 { "sn6", vtype_filter_int, &filter_sn[6] },
543 { "sn7", vtype_filter_int, &filter_sn[7] },
544 { "sn8", vtype_filter_int, &filter_sn[8] },
545 { "sn9", vtype_filter_int, &filter_sn[9] },
546 #ifdef WITH_CONTENT_SCAN
547 { "spam_bar", vtype_stringptr, &spam_bar },
548 { "spam_report", vtype_stringptr, &spam_report },
549 { "spam_score", vtype_stringptr, &spam_score },
550 { "spam_score_int", vtype_stringptr, &spam_score_int },
552 #ifdef EXPERIMENTAL_SPF
553 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
554 { "spf_received", vtype_stringptr, &spf_received },
555 { "spf_result", vtype_stringptr, &spf_result },
556 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
558 { "spool_directory", vtype_stringptr, &spool_directory },
559 { "spool_inodes", vtype_pinodes, (void *)TRUE },
560 { "spool_space", vtype_pspace, (void *)TRUE },
561 #ifdef EXPERIMENTAL_SRS
562 { "srs_db_address", vtype_stringptr, &srs_db_address },
563 { "srs_db_key", vtype_stringptr, &srs_db_key },
564 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
565 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
566 { "srs_recipient", vtype_stringptr, &srs_recipient },
567 { "srs_status", vtype_stringptr, &srs_status },
569 { "thisaddress", vtype_stringptr, &filter_thisaddress },
570 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
571 { "tls_cipher", vtype_stringptr, &tls_cipher },
572 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
573 { "tod_bsdinbox", vtype_todbsdin, NULL },
574 { "tod_epoch", vtype_tode, NULL },
575 { "tod_full", vtype_todf, NULL },
576 { "tod_log", vtype_todl, NULL },
577 { "tod_logfile", vtype_todlf, NULL },
578 { "tod_zone", vtype_todzone, NULL },
579 { "tod_zulu", vtype_todzulu, NULL },
580 { "value", vtype_stringptr, &lookup_value },
581 { "version_number", vtype_stringptr, &version_string },
582 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
583 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
584 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
585 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
586 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
587 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
590 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
591 static uschar var_buffer[256];
592 static BOOL malformed_header;
594 /* For textual hashes */
596 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
597 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
600 enum { HMAC_MD5, HMAC_SHA1 };
602 /* For numeric hashes */
604 static unsigned int prime[] = {
605 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
606 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
607 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
609 /* For printing modes in symbolic form */
611 static uschar *mtable_normal[] =
612 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
614 static uschar *mtable_setid[] =
615 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
617 static uschar *mtable_sticky[] =
618 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
622 /*************************************************
623 * Tables for UTF-8 support *
624 *************************************************/
626 /* Table of the number of extra characters, indexed by the first character
627 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
630 static uschar utf8_table1[] = {
631 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
632 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
633 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
634 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
636 /* These are the masks for the data bits in the first byte of a character,
637 indexed by the number of additional bytes. */
639 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
641 /* Get the next UTF-8 character, advancing the pointer. */
643 #define GETUTF8INC(c, ptr) \
645 if ((c & 0xc0) == 0xc0) \
647 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
649 c = (c & utf8_table2[a]) << s; \
653 c |= (*ptr++ & 0x3f) << s; \
658 /*************************************************
659 * Binary chop search on a table *
660 *************************************************/
662 /* This is used for matching expansion items and operators.
665 name the name that is being sought
666 table the table to search
667 table_size the number of items in the table
669 Returns: the offset in the table, or -1
673 chop_match(uschar *name, uschar **table, int table_size)
675 uschar **bot = table;
676 uschar **top = table + table_size;
680 uschar **mid = bot + (top - bot)/2;
681 int c = Ustrcmp(name, *mid);
682 if (c == 0) return mid - table;
683 if (c > 0) bot = mid + 1; else top = mid;
691 /*************************************************
692 * Check a condition string *
693 *************************************************/
695 /* This function is called to expand a string, and test the result for a "true"
696 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
697 forced fail or lookup defer. All store used by the function can be released on
701 condition the condition string
702 m1 text to be incorporated in panic error
705 Returns: TRUE if condition is met, FALSE if not
709 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
712 void *reset_point = store_get(0);
713 uschar *ss = expand_string(condition);
716 if (!expand_string_forcedfail && !search_find_defer)
717 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
718 "for %s %s: %s", condition, m1, m2, expand_string_message);
721 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
722 strcmpic(ss, US"false") != 0;
723 store_reset(reset_point);
729 /*************************************************
730 * Pick out a name from a string *
731 *************************************************/
733 /* If the name is too long, it is silently truncated.
736 name points to a buffer into which to put the name
737 max is the length of the buffer
738 s points to the first alphabetic character of the name
739 extras chars other than alphanumerics to permit
741 Returns: pointer to the first character after the name
743 Note: The test for *s != 0 in the while loop is necessary because
744 Ustrchr() yields non-NULL if the character is zero (which is not something
748 read_name(uschar *name, int max, uschar *s, uschar *extras)
751 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
753 if (ptr < max-1) name[ptr++] = *s;
762 /*************************************************
763 * Pick out the rest of a header name *
764 *************************************************/
766 /* A variable name starting $header_ (or just $h_ for those who like
767 abbreviations) might not be the complete header name because headers can
768 contain any printing characters in their names, except ':'. This function is
769 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
770 on the end, if the name was terminated by white space.
773 name points to a buffer in which the name read so far exists
774 max is the length of the buffer
775 s points to the first character after the name so far, i.e. the
776 first non-alphameric character after $header_xxxxx
778 Returns: a pointer to the first character after the header name
782 read_header_name(uschar *name, int max, uschar *s)
784 int prelen = Ustrchr(name, '_') - name + 1;
785 int ptr = Ustrlen(name) - prelen;
786 if (ptr > 0) memmove(name, name+prelen, ptr);
787 while (mac_isgraph(*s) && *s != ':')
789 if (ptr < max-1) name[ptr++] = *s;
800 /*************************************************
801 * Pick out a number from a string *
802 *************************************************/
805 n points to an integer into which to put the number
806 s points to the first digit of the number
808 Returns: a pointer to the character after the last digit
812 read_number(int *n, uschar *s)
815 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
821 /*************************************************
822 * Extract keyed subfield from a string *
823 *************************************************/
825 /* The yield is in dynamic store; NULL means that the key was not found.
828 key points to the name of the key
829 s points to the string from which to extract the subfield
831 Returns: NULL if the subfield was not found, or
832 a pointer to the subfield's data
836 expand_getkeyed(uschar *key, uschar *s)
838 int length = Ustrlen(key);
839 while (isspace(*s)) s++;
841 /* Loop to search for the key */
849 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
850 dkeylength = s - dkey;
851 while (isspace(*s)) s++;
852 if (*s == '=') while (isspace((*(++s))));
854 data = string_dequote(&s);
855 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
858 while (isspace(*s)) s++;
867 /*************************************************
868 * Extract numbered subfield from string *
869 *************************************************/
871 /* Extracts a numbered field from a string that is divided by tokens - for
872 example a line from /etc/passwd is divided by colon characters. First field is
873 numbered one. Negative arguments count from the right. Zero returns the whole
874 string. Returns NULL if there are insufficient tokens in the string
877 Modifies final argument - this is a dynamically generated string, so that's OK.
880 field number of field to be extracted,
881 first field = 1, whole string = 0, last field = -1
882 separators characters that are used to break string into tokens
883 s points to the string from which to extract the subfield
885 Returns: NULL if the field was not found,
886 a pointer to the field's data inside s (modified to add 0)
890 expand_gettokened (int field, uschar *separators, uschar *s)
895 uschar *fieldtext = NULL;
897 if (field == 0) return s;
899 /* Break the line up into fields in place; for field > 0 we stop when we have
900 done the number of fields we want. For field < 0 we continue till the end of
901 the string, counting the number of fields. */
903 count = (field > 0)? field : INT_MAX;
909 /* Previous field was the last one in the string. For a positive field
910 number, this means there are not enough fields. For a negative field number,
911 check that there are enough, and scan back to find the one that is wanted. */
915 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
916 if ((-field) == (INT_MAX - count - 1)) return s;
920 while (ss[-1] != 0) ss--;
926 /* Previous field was not last in the string; save its start and put a
930 len = Ustrcspn(ss, separators);
941 /*************************************************
942 * Extract a substring from a string *
943 *************************************************/
945 /* Perform the ${substr or ${length expansion operations.
948 subject the input string
949 value1 the offset from the start of the input string to the start of
950 the output string; if negative, count from the right.
951 value2 the length of the output string, or negative (-1) for unset
952 if value1 is positive, unset means "all after"
953 if value1 is negative, unset means "all before"
954 len set to the length of the returned string
956 Returns: pointer to the output string, or NULL if there is an error
960 extract_substr(uschar *subject, int value1, int value2, int *len)
962 int sublen = Ustrlen(subject);
964 if (value1 < 0) /* count from right */
968 /* If the position is before the start, skip to the start, and adjust the
969 length. If the length ends up negative, the substring is null because nothing
970 can precede. This falls out naturally when the length is unset, meaning "all
976 if (value2 < 0) value2 = 0;
980 /* Otherwise an unset length => characters before value1 */
989 /* For a non-negative offset, if the starting position is past the end of the
990 string, the result will be the null string. Otherwise, an unset length means
991 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1000 else if (value2 < 0) value2 = sublen;
1003 /* Cut the length down to the maximum possible for the offset value, and get
1004 the required characters. */
1006 if (value1 + value2 > sublen) value2 = sublen - value1;
1008 return subject + value1;
1014 /*************************************************
1015 * Old-style hash of a string *
1016 *************************************************/
1018 /* Perform the ${hash expansion operation.
1021 subject the input string (an expanded substring)
1022 value1 the length of the output string; if greater or equal to the
1023 length of the input string, the input string is returned
1024 value2 the number of hash characters to use, or 26 if negative
1025 len set to the length of the returned string
1027 Returns: pointer to the output string, or NULL if there is an error
1031 compute_hash(uschar *subject, int value1, int value2, int *len)
1033 int sublen = Ustrlen(subject);
1035 if (value2 < 0) value2 = 26;
1036 else if (value2 > Ustrlen(hashcodes))
1038 expand_string_message =
1039 string_sprintf("hash count \"%d\" too big", value2);
1043 /* Calculate the hash text. We know it is shorter than the original string, so
1044 can safely place it in subject[] (we know that subject is always itself an
1045 expanded substring). */
1047 if (value1 < sublen)
1052 while ((c = (subject[j])) != 0)
1054 int shift = (c + j++) & 7;
1055 subject[i] ^= (c << shift) | (c >> (8-shift));
1056 if (++i >= value1) i = 0;
1058 for (i = 0; i < value1; i++)
1059 subject[i] = hashcodes[(subject[i]) % value2];
1061 else value1 = sublen;
1070 /*************************************************
1071 * Numeric hash of a string *
1072 *************************************************/
1074 /* Perform the ${nhash expansion operation. The first characters of the
1075 string are treated as most important, and get the highest prime numbers.
1078 subject the input string
1079 value1 the maximum value of the first part of the result
1080 value2 the maximum value of the second part of the result,
1081 or negative to produce only a one-part result
1082 len set to the length of the returned string
1084 Returns: pointer to the output string, or NULL if there is an error.
1088 compute_nhash (uschar *subject, int value1, int value2, int *len)
1090 uschar *s = subject;
1092 unsigned long int total = 0; /* no overflow */
1096 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1097 total += prime[i--] * (unsigned int)(*s++);
1100 /* If value2 is unset, just compute one number */
1104 s = string_sprintf("%d", total % value1);
1107 /* Otherwise do a div/mod hash */
1111 total = total % (value1 * value2);
1112 s = string_sprintf("%d/%d", total/value2, total % value2);
1123 /*************************************************
1124 * Find the value of a header or headers *
1125 *************************************************/
1127 /* Multiple instances of the same header get concatenated, and this function
1128 can also return a concatenation of all the header lines. When concatenating
1129 specific headers that contain lists of addresses, a comma is inserted between
1130 them. Otherwise we use a straight concatenation. Because some messages can have
1131 pathologically large number of lines, there is a limit on the length that is
1132 returned. Also, to avoid massive store use which would result from using
1133 string_cat() as it copies and extends strings, we do a preliminary pass to find
1134 out exactly how much store will be needed. On "normal" messages this will be
1138 name the name of the header, without the leading $header_ or $h_,
1139 or NULL if a concatenation of all headers is required
1140 exists_only TRUE if called from a def: test; don't need to build a string;
1141 just return a string that is not "" and not "0" if the header
1143 newsize return the size of memory block that was obtained; may be NULL
1144 if exists_only is TRUE
1145 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1146 other than concatenating, will be done on the header. Also used
1147 for $message_headers_raw.
1148 charset name of charset to translate MIME words to; used only if
1149 want_raw is false; if NULL, no translation is done (this is
1150 used for $bh_ and $bheader_)
1152 Returns: NULL if the header does not exist, else a pointer to a new
1157 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1160 BOOL found = name == NULL;
1162 int len = found? 0 : Ustrlen(name);
1164 uschar *yield = NULL;
1167 /* Loop for two passes - saves code repetition */
1169 for (i = 0; i < 2; i++)
1174 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1176 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1178 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1183 if (exists_only) return US"1"; /* don't need actual string */
1185 t = h->text + len; /* text to insert */
1186 if (!want_raw) /* unless wanted raw, */
1187 while (isspace(*t)) t++; /* remove leading white space */
1188 ilen = h->slen - (t - h->text); /* length to insert */
1190 /* Unless wanted raw, remove trailing whitespace, including the
1194 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1196 /* Set comma = 1 if handling a single header and it's one of those
1197 that contains an address list, except when asked for raw headers. Only
1198 need to do this once. */
1200 if (!want_raw && name != NULL && comma == 0 &&
1201 Ustrchr("BCFRST", h->type) != NULL)
1204 /* First pass - compute total store needed; second pass - compute
1205 total store used, including this header. */
1207 size += ilen + comma + 1; /* +1 for the newline */
1209 /* Second pass - concatentate the data, up to a maximum. Note that
1210 the loop stops when size hits the limit. */
1214 if (size > header_insert_maxlen)
1216 ilen -= size - header_insert_maxlen - 1;
1219 Ustrncpy(ptr, t, ilen);
1222 /* For a non-raw header, put in the comma if needed, then add
1223 back the newline we removed above, provided there was some text in
1226 if (!want_raw && ilen > 0)
1228 if (comma != 0) *ptr++ = ',';
1236 /* At end of first pass, return NULL if no header found. Then truncate size
1237 if necessary, and get the buffer to hold the data, returning the buffer size.
1242 if (!found) return NULL;
1243 if (size > header_insert_maxlen) size = header_insert_maxlen;
1244 *newsize = size + 1;
1245 ptr = yield = store_get(*newsize);
1249 /* That's all we do for raw header expansion. */
1256 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1257 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1258 function can return an error with decoded data if the charset translation
1259 fails. If decoding fails, it returns NULL. */
1263 uschar *decoded, *error;
1264 if (ptr > yield && ptr[-1] == '\n') ptr--;
1265 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1267 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1271 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1272 " input was: %s\n", error, yield);
1274 if (decoded != NULL) yield = decoded;
1283 /*************************************************
1284 * Find value of a variable *
1285 *************************************************/
1287 /* The table of variables is kept in alphabetic order, so we can search it
1288 using a binary chop. The "choplen" variable is nothing to do with the binary
1292 name the name of the variable being sought
1293 exists_only TRUE if this is a def: test; passed on to find_header()
1294 skipping TRUE => skip any processing evaluation; this is not the same as
1295 exists_only because def: may test for values that are first
1297 newsize pointer to an int which is initially zero; if the answer is in
1298 a new memory buffer, *newsize is set to its size
1300 Returns: NULL if the variable does not exist, or
1301 a pointer to the variable's contents, or
1302 something non-NULL if exists_only is TRUE
1306 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1309 int last = var_table_size;
1311 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1312 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1313 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1314 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1315 (this gave backwards compatibility at the changeover). There may be built-in
1316 variables whose names start acl_ but they should never start in this way. This
1317 slightly messy specification is a consequence of the history, needless to say.
1319 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1320 set, in which case give an error. */
1322 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1326 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1327 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1330 /* Handle $auth<n> variables. */
1332 if (Ustrncmp(name, "auth", 4) == 0)
1335 int n = Ustrtoul(name + 4, &endptr, 10);
1336 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1337 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1340 /* For all other variables, search the table */
1342 while (last > first)
1346 int middle = (first + last)/2;
1347 int c = Ustrcmp(name, var_table[middle].name);
1349 if (c > 0) { first = middle + 1; continue; }
1350 if (c < 0) { last = middle; continue; }
1352 /* Found an existing variable. If in skipping state, the value isn't needed,
1353 and we want to avoid processing (such as looking up the host name). */
1355 if (skipping) return US"";
1357 switch (var_table[middle].type)
1359 #ifdef EXPERIMENTAL_DOMAINKEYS
1361 case vtype_dk_verify:
1362 if (dk_verify_block == NULL) return US"";
1364 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1365 s = dk_verify_block->result_string;
1366 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1367 s = dk_verify_block->address;
1368 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1369 s = dk_verify_block->domain;
1370 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1371 s = dk_verify_block->local_part;
1373 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1374 switch(dk_verify_block->address_source) {
1375 case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1376 case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1377 case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1380 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1381 switch(dk_verify_block->result) {
1382 case DK_EXIM_RESULT_ERR: s = US"error"; break;
1383 case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1384 case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1385 case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1386 case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1387 case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1388 case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1389 case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1392 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1393 s = (dk_verify_block->signsall)? US"1" : US"0";
1395 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1396 s = (dk_verify_block->testing)? US"1" : US"0";
1398 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1399 s = (dk_verify_block->is_signed)? US"1" : US"0";
1401 return (s == NULL)? US"" : s;
1404 case vtype_filter_int:
1405 if (!filter_running) return NULL;
1409 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1413 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1417 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1421 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1424 case vtype_stringptr: /* Pointer to string */
1425 s = *((uschar **)(var_table[middle].value));
1426 return (s == NULL)? US"" : s;
1429 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1432 case vtype_load_avg:
1433 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1436 case vtype_host_lookup: /* Lookup if not done so */
1437 if (sender_host_name == NULL && sender_host_address != NULL &&
1438 !host_lookup_failed && host_name_lookup() == OK)
1439 host_build_sender_fullhost();
1440 return (sender_host_name == NULL)? US"" : sender_host_name;
1442 case vtype_localpart: /* Get local part from address */
1443 s = *((uschar **)(var_table[middle].value));
1444 if (s == NULL) return US"";
1445 domain = Ustrrchr(s, '@');
1446 if (domain == NULL) return s;
1447 if (domain - s > sizeof(var_buffer) - 1)
1448 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1449 "string expansion", sizeof(var_buffer));
1450 Ustrncpy(var_buffer, s, domain - s);
1451 var_buffer[domain - s] = 0;
1454 case vtype_domain: /* Get domain from address */
1455 s = *((uschar **)(var_table[middle].value));
1456 if (s == NULL) return US"";
1457 domain = Ustrrchr(s, '@');
1458 return (domain == NULL)? US"" : domain + 1;
1460 case vtype_msgheaders:
1461 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1463 case vtype_msgheaders_raw:
1464 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1466 case vtype_msgbody: /* Pointer to msgbody string */
1467 case vtype_msgbody_end: /* Ditto, the end of the msg */
1468 ss = (uschar **)(var_table[middle].value);
1469 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1472 off_t start_offset = SPOOL_DATA_START_OFFSET;
1473 int len = message_body_visible;
1474 if (len > message_size) len = message_size;
1475 *ss = body = store_malloc(len+1);
1477 if (var_table[middle].type == vtype_msgbody_end)
1479 struct stat statbuf;
1480 if (fstat(deliver_datafile, &statbuf) == 0)
1482 start_offset = statbuf.st_size - len;
1483 if (start_offset < SPOOL_DATA_START_OFFSET)
1484 start_offset = SPOOL_DATA_START_OFFSET;
1487 lseek(deliver_datafile, start_offset, SEEK_SET);
1488 len = read(deliver_datafile, body, len);
1494 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1498 return (*ss == NULL)? US"" : *ss;
1500 case vtype_todbsdin: /* BSD inbox time of day */
1501 return tod_stamp(tod_bsdin);
1503 case vtype_tode: /* Unix epoch time of day */
1504 return tod_stamp(tod_epoch);
1506 case vtype_todf: /* Full time of day */
1507 return tod_stamp(tod_full);
1509 case vtype_todl: /* Log format time of day */
1510 return tod_stamp(tod_log_bare); /* (without timezone) */
1512 case vtype_todzone: /* Time zone offset only */
1513 return tod_stamp(tod_zone);
1515 case vtype_todzulu: /* Zulu time */
1516 return tod_stamp(tod_zulu);
1518 case vtype_todlf: /* Log file datestamp tod */
1519 return tod_stamp(tod_log_datestamp);
1521 case vtype_reply: /* Get reply address */
1522 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1524 if (s != NULL) while (isspace(*s)) s++;
1525 if (s == NULL || *s == 0)
1527 *newsize = 0; /* For the *s==0 case */
1528 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1533 while (isspace(*s)) s++;
1534 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1535 while (t > s && isspace(t[-1])) t--;
1538 return (s == NULL)? US"" : s;
1540 /* A recipients list is available only during system message filtering,
1541 during ACL processing after DATA, and while expanding pipe commands
1542 generated from a system filter, but not elsewhere. */
1544 case vtype_recipients:
1545 if (!enable_dollar_recipients) return NULL; else
1550 s = store_get(size);
1551 for (i = 0; i < recipients_count; i++)
1553 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1554 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1555 Ustrlen(recipients_list[i].address));
1557 s[ptr] = 0; /* string_cat() leaves room */
1564 sprintf(CS var_buffer, "%d",
1565 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1572 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1573 sprintf(CS var_buffer, "%d", inodes);
1579 return NULL; /* Unknown variable name */
1585 /*************************************************
1586 * Read and expand substrings *
1587 *************************************************/
1589 /* This function is called to read and expand argument substrings for various
1590 expansion items. Some have a minimum requirement that is less than the maximum;
1591 in these cases, the first non-present one is set to NULL.
1594 sub points to vector of pointers to set
1595 n maximum number of substrings
1597 sptr points to current string pointer
1598 skipping the skipping flag
1599 check_end if TRUE, check for final '}'
1600 name name of item, for error message
1602 Returns: 0 OK; string pointer updated
1603 1 curly bracketing error (too few arguments)
1604 2 too many arguments (only if check_end is set); message set
1605 3 other error (expansion failure)
1609 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1610 BOOL check_end, uschar *name)
1615 while (isspace(*s)) s++;
1616 for (i = 0; i < n; i++)
1620 if (i < m) return 1;
1624 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1625 if (sub[i] == NULL) return 3;
1626 if (*s++ != '}') return 1;
1627 while (isspace(*s)) s++;
1629 if (check_end && *s++ != '}')
1633 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1634 "(max is %d)", name, n);
1647 /*************************************************
1648 * Elaborate message for bad variable *
1649 *************************************************/
1651 /* For the "unknown variable" message, take a look at the variable's name, and
1652 give additional information about possible ACL variables. The extra information
1653 is added on to expand_string_message.
1655 Argument: the name of the variable
1660 check_variable_error_message(uschar *name)
1662 if (Ustrncmp(name, "acl_", 4) == 0)
1663 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1664 (name[4] == 'c' || name[4] == 'm')?
1666 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1667 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1669 US"user-defined ACL variables must start acl_c or acl_m");
1674 /*************************************************
1675 * Read and evaluate a condition *
1676 *************************************************/
1680 s points to the start of the condition text
1681 yield points to a BOOL to hold the result of the condition test;
1682 if NULL, we are just reading through a condition that is
1683 part of an "or" combination to check syntax, or in a state
1684 where the answer isn't required
1686 Returns: a pointer to the first character after the condition, or
1691 eval_condition(uschar *s, BOOL *yield)
1693 BOOL testfor = TRUE;
1694 BOOL tempcond, combined_cond;
1696 int i, rc, cond_type, roffset;
1698 struct stat statbuf;
1703 const uschar *rerror;
1707 while (isspace(*s)) s++;
1708 if (*s == '!') { testfor = !testfor; s++; } else break;
1711 /* Numeric comparisons are symbolic */
1713 if (*s == '=' || *s == '>' || *s == '<')
1725 /* All other conditions are named */
1727 else s = read_name(name, 256, s, US"_");
1729 /* If we haven't read a name, it means some non-alpha character is first. */
1733 expand_string_message = string_sprintf("condition name expected, "
1734 "but found \"%.16s\"", s);
1738 /* Find which condition we are dealing with, and switch on it */
1740 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1743 /* def: tests for a non-empty variable, or for the existence of a header. If
1744 yield == NULL we are in a skipping state, and don't care about the answer. */
1749 expand_string_message = US"\":\" expected after \"def\"";
1753 s = read_name(name, 256, s+1, US"_");
1755 /* Test for a header's existence. If the name contains a closing brace
1756 character, this may be a user error where the terminating colon has been
1757 omitted. Set a flag to adjust a subsequent error message in this case. */
1759 if (Ustrncmp(name, "h_", 2) == 0 ||
1760 Ustrncmp(name, "rh_", 3) == 0 ||
1761 Ustrncmp(name, "bh_", 3) == 0 ||
1762 Ustrncmp(name, "header_", 7) == 0 ||
1763 Ustrncmp(name, "rheader_", 8) == 0 ||
1764 Ustrncmp(name, "bheader_", 8) == 0)
1766 s = read_header_name(name, 256, s);
1767 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1768 if (yield != NULL) *yield =
1769 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1772 /* Test for a variable's having a non-empty value. A non-existent variable
1773 causes an expansion failure. */
1777 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1780 expand_string_message = (name[0] == 0)?
1781 string_sprintf("variable name omitted after \"def:\"") :
1782 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1783 check_variable_error_message(name);
1786 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1792 /* first_delivery tests for first delivery attempt */
1794 case ECOND_FIRST_DELIVERY:
1795 if (yield != NULL) *yield = deliver_firsttime == testfor;
1799 /* queue_running tests for any process started by a queue runner */
1801 case ECOND_QUEUE_RUNNING:
1802 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1806 /* exists: tests for file existence
1807 isip: tests for any IP address
1808 isip4: tests for an IPv4 address
1809 isip6: tests for an IPv6 address
1810 pam: does PAM authentication
1811 radius: does RADIUS authentication
1812 ldapauth: does LDAP authentication
1813 pwcheck: does Cyrus SASL pwcheck authentication
1822 case ECOND_LDAPAUTH:
1825 while (isspace(*s)) s++;
1826 if (*s != '{') goto COND_FAILED_CURLY_START;
1828 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1829 if (sub[0] == NULL) return NULL;
1830 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1832 if (yield == NULL) return s; /* No need to run the test if skipping */
1837 if ((expand_forbid & RDO_EXISTS) != 0)
1839 expand_string_message = US"File existence tests are not permitted";
1842 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1848 rc = string_is_ip_address(sub[0], NULL);
1849 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1850 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1853 /* Various authentication tests - all optionally compiled */
1857 rc = auth_call_pam(sub[0], &expand_string_message);
1860 goto COND_FAILED_NOT_COMPILED;
1861 #endif /* SUPPORT_PAM */
1864 #ifdef RADIUS_CONFIG_FILE
1865 rc = auth_call_radius(sub[0], &expand_string_message);
1868 goto COND_FAILED_NOT_COMPILED;
1869 #endif /* RADIUS_CONFIG_FILE */
1871 case ECOND_LDAPAUTH:
1874 /* Just to keep the interface the same */
1876 int old_pool = store_pool;
1877 store_pool = POOL_SEARCH;
1878 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1879 &expand_string_message, &do_cache);
1880 store_pool = old_pool;
1884 goto COND_FAILED_NOT_COMPILED;
1885 #endif /* LOOKUP_LDAP */
1888 #ifdef CYRUS_PWCHECK_SOCKET
1889 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1892 goto COND_FAILED_NOT_COMPILED;
1893 #endif /* CYRUS_PWCHECK_SOCKET */
1895 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1896 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1898 if (rc == ERROR || rc == DEFER) return NULL;
1899 *yield = (rc == OK) == testfor;
1905 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1907 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1909 However, the last two are optional. That is why the whole set is enclosed
1910 in their own set or braces. */
1912 case ECOND_SASLAUTHD:
1913 #ifndef CYRUS_SASLAUTHD_SOCKET
1914 goto COND_FAILED_NOT_COMPILED;
1916 while (isspace(*s)) s++;
1917 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1918 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1920 case 1: expand_string_message = US"too few arguments or bracketing "
1921 "error for saslauthd";
1923 case 3: return NULL;
1925 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1929 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1930 &expand_string_message);
1931 if (rc == ERROR || rc == DEFER) return NULL;
1932 *yield = (rc == OK) == testfor;
1935 #endif /* CYRUS_SASLAUTHD_SOCKET */
1938 /* symbolic operators for numeric and string comparison, and a number of
1939 other operators, all requiring two arguments.
1941 match: does a regular expression match and sets up the numerical
1942 variables if it succeeds
1943 match_address: matches in an address list
1944 match_domain: matches in a domain list
1945 match_ip: matches a host list that is restricted to IP addresses
1946 match_local_part: matches in a local part list
1947 crypteq: encrypts plaintext and compares against an encrypted text,
1948 using crypt(), crypt16(), MD5 or SHA-1
1952 case ECOND_MATCH_ADDRESS:
1953 case ECOND_MATCH_DOMAIN:
1954 case ECOND_MATCH_IP:
1955 case ECOND_MATCH_LOCAL_PART:
1958 case ECOND_NUM_L: /* Numerical comparisons */
1965 case ECOND_STR_LT: /* String comparisons */
1976 for (i = 0; i < 2; i++)
1978 while (isspace(*s)) s++;
1981 if (i == 0) goto COND_FAILED_CURLY_START;
1982 expand_string_message = string_sprintf("missing 2nd string in {} "
1983 "after \"%s\"", name);
1986 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1987 if (sub[i] == NULL) return NULL;
1988 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1990 /* Convert to numerical if required; we know that the names of all the
1991 conditions that compare numbers do not start with a letter. This just saves
1992 checking for them individually. */
1994 if (!isalpha(name[0]) && yield != NULL)
2000 debug_printf("empty string cast to zero for numerical comparison\n");
2004 num[i] = expand_string_integer(sub[i], FALSE);
2005 if (expand_string_message != NULL) return NULL;
2010 /* Result not required */
2012 if (yield == NULL) return s;
2014 /* Do an appropriate comparison */
2020 *yield = (num[0] == num[1]) == testfor;
2024 *yield = (num[0] > num[1]) == testfor;
2028 *yield = (num[0] >= num[1]) == testfor;
2032 *yield = (num[0] < num[1]) == testfor;
2036 *yield = (num[0] <= num[1]) == testfor;
2040 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
2044 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
2048 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
2052 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
2056 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
2060 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
2064 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
2068 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2072 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2076 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2079 case ECOND_MATCH: /* Regular expression match */
2080 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2084 expand_string_message = string_sprintf("regular expression error in "
2085 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2088 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2091 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2092 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2093 goto MATCHED_SOMETHING;
2095 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2096 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2097 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2098 goto MATCHED_SOMETHING;
2100 case ECOND_MATCH_IP: /* Match IP address in a host list */
2101 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2103 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2109 unsigned int *nullcache = NULL;
2110 check_host_block cb;
2112 cb.host_name = US"";
2113 cb.host_address = sub[0];
2115 /* If the host address starts off ::ffff: it is an IPv6 address in
2116 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2119 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2120 cb.host_address + 7 : cb.host_address;
2122 rc = match_check_list(
2123 &sub[1], /* the list */
2124 0, /* separator character */
2125 &hostlist_anchor, /* anchor pointer */
2126 &nullcache, /* cache pointer */
2127 check_host, /* function for testing */
2128 &cb, /* argument for function */
2129 MCL_HOST, /* type of check */
2130 sub[0], /* text for debugging */
2131 NULL); /* where to pass back data */
2133 goto MATCHED_SOMETHING;
2135 case ECOND_MATCH_LOCAL_PART:
2136 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2137 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2152 expand_string_message = string_sprintf("unable to complete match "
2153 "against \"%s\": %s", sub[1], search_error_message);
2159 /* Various "encrypted" comparisons. If the second string starts with
2160 "{" then an encryption type is given. Default to crypt() or crypt16()
2161 (build-time choice). */
2164 #ifndef SUPPORT_CRYPTEQ
2165 goto COND_FAILED_NOT_COMPILED;
2167 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2169 int sublen = Ustrlen(sub[1]+5);
2174 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2176 /* If the length that we are comparing against is 24, the MD5 digest
2177 is expressed as a base64 string. This is the way LDAP does it. However,
2178 some other software uses a straightforward hex representation. We assume
2179 this if the length is 32. Other lengths fail. */
2183 uschar *coded = auth_b64encode((uschar *)digest, 16);
2184 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2185 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2186 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2188 else if (sublen == 32)
2192 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2194 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2195 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2196 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2200 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2201 "fail\n crypted=%s\n", sub[1]+5);
2206 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2208 int sublen = Ustrlen(sub[1]+6);
2213 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2215 /* If the length that we are comparing against is 28, assume the SHA1
2216 digest is expressed as a base64 string. If the length is 40, assume a
2217 straightforward hex representation. Other lengths fail. */
2221 uschar *coded = auth_b64encode((uschar *)digest, 20);
2222 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2223 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2224 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2226 else if (sublen == 40)
2230 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2232 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2233 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2234 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2238 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2239 "fail\n crypted=%s\n", sub[1]+6);
2244 else /* {crypt} or {crypt16} and non-{ at start */
2249 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2254 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2259 else if (sub[1][0] == '{')
2261 expand_string_message = string_sprintf("unknown encryption mechanism "
2262 "in \"%s\"", sub[1]);
2268 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2269 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2270 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2274 #define XSTR(s) STR(s)
2275 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2276 " subject=%s\n crypted=%s\n",
2277 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2282 /* If the encrypted string contains fewer than two characters (for the
2283 salt), force failure. Otherwise we get false positives: with an empty
2284 string the yield of crypt() is an empty string! */
2286 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2287 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2290 #endif /* SUPPORT_CRYPTEQ */
2291 } /* Switch for comparison conditions */
2293 return s; /* End of comparison conditions */
2296 /* and/or: computes logical and/or of several conditions */
2300 subcondptr = (yield == NULL)? NULL : &tempcond;
2301 combined_cond = (cond_type == ECOND_AND);
2303 while (isspace(*s)) s++;
2304 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2308 while (isspace(*s)) s++;
2309 if (*s == '}') break;
2312 expand_string_message = string_sprintf("each subcondition "
2313 "inside an \"%s{...}\" condition must be in its own {}", name);
2317 s = eval_condition(s+1, subcondptr);
2320 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2321 expand_string_message, name);
2324 while (isspace(*s)) s++;
2328 expand_string_message = string_sprintf("missing } at end of condition "
2329 "inside \"%s\" group", name);
2335 if (cond_type == ECOND_AND)
2337 combined_cond &= tempcond;
2338 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2339 } /* evaluate any more */
2342 combined_cond |= tempcond;
2343 if (combined_cond) subcondptr = NULL; /* once true, don't */
2344 } /* evaluate any more */
2348 if (yield != NULL) *yield = (combined_cond == testfor);
2352 /* Unknown condition */
2355 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2357 } /* End switch on condition type */
2359 /* Missing braces at start and end of data */
2361 COND_FAILED_CURLY_START:
2362 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2365 COND_FAILED_CURLY_END:
2366 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2370 /* A condition requires code that is not compiled */
2372 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2373 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2374 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2375 COND_FAILED_NOT_COMPILED:
2376 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2385 /*************************************************
2386 * Save numerical variables *
2387 *************************************************/
2389 /* This function is called from items such as "if" that want to preserve and
2390 restore the numbered variables.
2393 save_expand_string points to an array of pointers to set
2394 save_expand_nlength points to an array of ints for the lengths
2396 Returns: the value of expand max to save
2400 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2403 for (i = 0; i <= expand_nmax; i++)
2405 save_expand_nstring[i] = expand_nstring[i];
2406 save_expand_nlength[i] = expand_nlength[i];
2413 /*************************************************
2414 * Restore numerical variables *
2415 *************************************************/
2417 /* This function restored saved values of numerical strings.
2420 save_expand_nmax the number of strings to restore
2421 save_expand_string points to an array of pointers
2422 save_expand_nlength points to an array of ints
2428 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2429 int *save_expand_nlength)
2432 expand_nmax = save_expand_nmax;
2433 for (i = 0; i <= expand_nmax; i++)
2435 expand_nstring[i] = save_expand_nstring[i];
2436 expand_nlength[i] = save_expand_nlength[i];
2444 /*************************************************
2445 * Handle yes/no substrings *
2446 *************************************************/
2448 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2449 alternative substrings that depend on whether or not the condition was true,
2450 or the lookup or extraction succeeded. The substrings always have to be
2451 expanded, to check their syntax, but "skipping" is set when the result is not
2452 needed - this avoids unnecessary nested lookups.
2455 skipping TRUE if we were skipping when this item was reached
2456 yes TRUE if the first string is to be used, else use the second
2457 save_lookup a value to put back into lookup_value before the 2nd expansion
2458 sptr points to the input string pointer
2459 yieldptr points to the output string pointer
2460 sizeptr points to the output string size
2461 ptrptr points to the output string pointer
2462 type "lookup" or "if" or "extract" or "run", for error message
2464 Returns: 0 OK; lookup_value has been reset to save_lookup
2466 2 expansion failed because of bracketing error
2470 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2471 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2474 uschar *s = *sptr; /* Local value */
2475 uschar *sub1, *sub2;
2477 /* If there are no following strings, we substitute the contents of $value for
2478 lookups and for extractions in the success case. For the ${if item, the string
2479 "true" is substituted. In the fail case, nothing is substituted for all three
2482 while (isspace(*s)) s++;
2487 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2491 if (yes && lookup_value != NULL)
2492 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2493 Ustrlen(lookup_value));
2494 lookup_value = save_lookup;
2500 /* The first following string must be braced. */
2502 if (*s++ != '{') goto FAILED_CURLY;
2504 /* Expand the first substring. Forced failures are noticed only if we actually
2505 want this string. Set skipping in the call in the fail case (this will always
2506 be the case if we were already skipping). */
2508 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2509 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2510 expand_string_forcedfail = FALSE;
2511 if (*s++ != '}') goto FAILED_CURLY;
2513 /* If we want the first string, add it to the output */
2516 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2518 /* If this is called from a lookup or an extract, we want to restore $value to
2519 what it was at the start of the item, so that it has this value during the
2520 second string expansion. For the call from "if" or "run" to this function,
2521 save_lookup is set to lookup_value, so that this statement does nothing. */
2523 lookup_value = save_lookup;
2525 /* There now follows either another substring, or "fail", or nothing. This
2526 time, forced failures are noticed only if we want the second string. We must
2527 set skipping in the nested call if we don't want this string, or if we were
2528 already skipping. */
2530 while (isspace(*s)) s++;
2533 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2534 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2535 expand_string_forcedfail = FALSE;
2536 if (*s++ != '}') goto FAILED_CURLY;
2538 /* If we want the second string, add it to the output */
2541 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2544 /* If there is no second string, but the word "fail" is present when the use of
2545 the second string is wanted, set a flag indicating it was a forced failure
2546 rather than a syntactic error. Swallow the terminating } in case this is nested
2547 inside another lookup or if or extract. */
2552 s = read_name(name, sizeof(name), s, US"_");
2553 if (Ustrcmp(name, "fail") == 0)
2555 if (!yes && !skipping)
2557 while (isspace(*s)) s++;
2558 if (*s++ != '}') goto FAILED_CURLY;
2559 expand_string_message =
2560 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2561 expand_string_forcedfail = TRUE;
2567 expand_string_message =
2568 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2573 /* All we have to do now is to check on the final closing brace. */
2575 while (isspace(*s)) s++;
2576 if (*s++ == '}') goto RETURN;
2578 /* Get here if there is a bracketing failure */
2583 /* Get here for other failures */
2588 /* Update the input pointer value before returning */
2598 /*************************************************
2599 * Handle MD5 or SHA-1 computation for HMAC *
2600 *************************************************/
2602 /* These are some wrapping functions that enable the HMAC code to be a bit
2603 cleaner. A good compiler will spot the tail recursion.
2606 type HMAC_MD5 or HMAC_SHA1
2607 remaining are as for the cryptographic hash functions
2613 chash_start(int type, void *base)
2615 if (type == HMAC_MD5)
2616 md5_start((md5 *)base);
2618 sha1_start((sha1 *)base);
2622 chash_mid(int type, void *base, uschar *string)
2624 if (type == HMAC_MD5)
2625 md5_mid((md5 *)base, string);
2627 sha1_mid((sha1 *)base, string);
2631 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2633 if (type == HMAC_MD5)
2634 md5_end((md5 *)base, string, length, digest);
2636 sha1_end((sha1 *)base, string, length, digest);
2643 /********************************************************
2644 * prvs: Get last three digits of days since Jan 1, 1970 *
2645 ********************************************************/
2647 /* This is needed to implement the "prvs" BATV reverse
2650 Argument: integer "days" offset to add or substract to
2651 or from the current number of days.
2653 Returns: pointer to string containing the last three
2654 digits of the number of days since Jan 1, 1970,
2655 modified by the offset argument, NULL if there
2656 was an error in the conversion.
2661 prvs_daystamp(int day_offset)
2663 uschar *days = store_get(32); /* Need at least 24 for cases */
2664 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2665 (time(NULL) + day_offset*86400)/86400);
2666 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2671 /********************************************************
2672 * prvs: perform HMAC-SHA1 computation of prvs bits *
2673 ********************************************************/
2675 /* This is needed to implement the "prvs" BATV reverse
2679 address RFC2821 Address to use
2680 key The key to use (must be less than 64 characters
2682 key_num Single-digit key number to use. Defaults to
2685 Returns: pointer to string containing the first three
2686 bytes of the final hash in hex format, NULL if
2687 there was an error in the process.
2691 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2693 uschar *hash_source, *p;
2694 int size = 0,offset = 0,i;
2696 void *use_base = &sha1_base;
2697 uschar innerhash[20];
2698 uschar finalhash[20];
2699 uschar innerkey[64];
2700 uschar outerkey[64];
2701 uschar *finalhash_hex = store_get(40);
2703 if (key_num == NULL)
2706 if (Ustrlen(key) > 64)
2709 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2710 string_cat(hash_source,&size,&offset,daystamp,3);
2711 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2712 hash_source[offset] = '\0';
2714 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2716 memset(innerkey, 0x36, 64);
2717 memset(outerkey, 0x5c, 64);
2719 for (i = 0; i < Ustrlen(key); i++)
2721 innerkey[i] ^= key[i];
2722 outerkey[i] ^= key[i];
2725 chash_start(HMAC_SHA1, use_base);
2726 chash_mid(HMAC_SHA1, use_base, innerkey);
2727 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2729 chash_start(HMAC_SHA1, use_base);
2730 chash_mid(HMAC_SHA1, use_base, outerkey);
2731 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2734 for (i = 0; i < 3; i++)
2736 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2737 *p++ = hex_digits[finalhash[i] & 0x0f];
2741 return finalhash_hex;
2747 /*************************************************
2748 * Join a file onto the output string *
2749 *************************************************/
2751 /* This is used for readfile and after a run expansion. It joins the contents
2752 of a file onto the output string, globally replacing newlines with a given
2753 string (optionally). The file is closed at the end.
2757 yield pointer to the expandable string
2758 sizep pointer to the current size
2759 ptrp pointer to the current position
2760 eol newline replacement string, or NULL
2762 Returns: new value of string pointer
2766 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2769 uschar buffer[1024];
2771 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2773 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2775 int len = Ustrlen(buffer);
2776 if (eol != NULL && buffer[len-1] == '\n') len--;
2777 yield = string_cat(yield, sizep, ptrp, buffer, len);
2778 if (buffer[len] != 0)
2779 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2782 if (yield != NULL) yield[*ptrp] = 0;
2790 /*************************************************
2791 * Evaluate numeric expression *
2792 *************************************************/
2794 /* This is a set of mutually recursive functions that evaluate an arithmetic
2795 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
2796 these functions that is called from elsewhere is eval_expr, whose interface is:
2799 sptr pointer to the pointer to the string - gets updated
2800 decimal TRUE if numbers are to be assumed decimal
2801 error pointer to where to put an error message - must be NULL on input
2802 endket TRUE if ')' must terminate - FALSE for external call
2804 Returns: on success: the value of the expression, with *error still NULL
2805 on failure: an undefined value, with *error = a message
2808 static int eval_op_or(uschar **, BOOL, uschar **);
2812 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2815 int x = eval_op_or(&s, decimal, error);
2821 *error = US"expecting closing parenthesis";
2823 while (isspace(*(++s)));
2825 else if (*s != 0) *error = US"expecting operator";
2833 eval_number(uschar **sptr, BOOL decimal, uschar **error)
2838 while (isspace(*s)) s++;
2843 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2845 if (tolower(*s) == 'k') { n *= 1024; s++; }
2846 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2847 while (isspace (*s)) s++;
2852 n = eval_expr(&s, decimal, error, 1);
2856 *error = US"expecting number or opening parenthesis";
2864 static int eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
2868 while (isspace(*s)) s++;
2869 if (*s == '+' || *s == '-' || *s == '~')
2872 x = eval_op_unary(&s, decimal, error);
2873 if (op == '-') x = -x;
2874 else if (op == '~') x = ~x;
2878 x = eval_number(&s, decimal, error);
2885 static int eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
2888 int x = eval_op_unary(&s, decimal, error);
2891 while (*s == '*' || *s == '/' || *s == '%')
2894 int y = eval_op_unary(&s, decimal, error);
2895 if (*error != NULL) break;
2896 if (op == '*') x *= y;
2897 else if (op == '/') x /= y;
2906 static int eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
2909 int x = eval_op_mult(&s, decimal, error);
2912 while (*s == '+' || *s == '-')
2915 int y = eval_op_mult(&s, decimal, error);
2916 if (*error != NULL) break;
2917 if (op == '+') x += y; else x -= y;
2925 static int eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
2928 int x = eval_op_sum(&s, decimal, error);
2931 while ((*s == '<' || *s == '>') && s[1] == s[0])
2936 y = eval_op_sum(&s, decimal, error);
2937 if (*error != NULL) break;
2938 if (op == '<') x <<= y; else x >>= y;
2946 static int eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
2949 int x = eval_op_shift(&s, decimal, error);
2956 y = eval_op_shift(&s, decimal, error);
2957 if (*error != NULL) break;
2966 static int eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
2969 int x = eval_op_and(&s, decimal, error);
2976 y = eval_op_and(&s, decimal, error);
2977 if (*error != NULL) break;
2986 static int eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
2989 int x = eval_op_xor(&s, decimal, error);
2996 y = eval_op_xor(&s, decimal, error);
2997 if (*error != NULL) break;
3007 /*************************************************
3009 *************************************************/
3011 /* Returns either an unchanged string, or the expanded string in stacking pool
3012 store. Interpreted sequences are:
3014 \... normal escaping rules
3015 $name substitutes the variable
3017 ${op:string} operates on the expanded string value
3018 ${item{arg1}{arg2}...} expands the args and then does the business
3019 some literal args are not enclosed in {}
3021 There are now far too many operators and item types to make it worth listing
3022 them here in detail any more.
3024 We use an internal routine recursively to handle embedded substrings. The
3025 external function follows. The yield is NULL if the expansion failed, and there
3026 are two cases: if something collapsed syntactically, or if "fail" was given
3027 as the action on a lookup failure. These can be distinguised by looking at the
3028 variable expand_string_forcedfail, which is TRUE in the latter case.
3030 The skipping flag is set true when expanding a substring that isn't actually
3031 going to be used (after "if" or "lookup") and it prevents lookups from
3032 happening lower down.
3034 Store usage: At start, a store block of the length of the input plus 64
3035 is obtained. This is expanded as necessary by string_cat(), which might have to
3036 get a new block, or might be able to expand the original. At the end of the
3037 function we can release any store above that portion of the yield block that
3038 was actually used. In many cases this will be optimal.
3040 However: if the first item in the expansion is a variable name or header name,
3041 we reset the store before processing it; if the result is in fresh store, we
3042 use that without copying. This is helpful for expanding strings like
3043 $message_headers which can get very long.
3046 string the string to be expanded
3047 ket_ends true if expansion is to stop at }
3048 left if not NULL, a pointer to the first character after the
3049 expansion is placed here (typically used with ket_ends)
3050 skipping TRUE for recursive calls when the value isn't actually going
3051 to be used (to allow for optimisation)
3053 Returns: NULL if expansion fails:
3054 expand_string_forcedfail is set TRUE if failure was forced
3055 expand_string_message contains a textual error message
3056 a pointer to the expanded string on success
3060 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3064 int size = Ustrlen(string)+ 64;
3066 uschar *yield = store_get(size);
3068 uschar *save_expand_nstring[EXPAND_MAXN+1];
3069 int save_expand_nlength[EXPAND_MAXN+1];
3071 expand_string_forcedfail = FALSE;
3072 expand_string_message = US"";
3079 /* \ escapes the next character, which must exist, or else
3080 the expansion fails. There's a special escape, \N, which causes
3081 copying of the subject verbatim up to the next \N. Otherwise,
3082 the escapes are the standard set. */
3088 expand_string_message = US"\\ at end of string";
3095 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3096 yield = string_cat(yield, &size, &ptr, t, s - t);
3097 if (*s != 0) s += 2;
3103 ch[0] = string_interpret_escape(&s);
3105 yield = string_cat(yield, &size, &ptr, ch, 1);
3111 /* Anything other than $ is just copied verbatim, unless we are
3112 looking for a terminating } character. */
3114 if (ket_ends && *s == '}') break;
3118 yield = string_cat(yield, &size, &ptr, s++, 1);
3122 /* No { after the $ - must be a plain name or a number for string
3123 match variable. There has to be a fudge for variables that are the
3124 names of header fields preceded by "$header_" because header field
3125 names can contain any printing characters except space and colon.
3126 For those that don't like typing this much, "$h_" is a synonym for
3127 "$header_". A non-existent header yields a NULL value; nothing is
3130 if (isalpha((*(++s))))
3135 s = read_name(name, sizeof(name), s, US"_");
3137 /* If this is the first thing to be expanded, release the pre-allocated
3140 if (ptr == 0 && yield != NULL)
3149 if (Ustrncmp(name, "h_", 2) == 0 ||
3150 Ustrncmp(name, "rh_", 3) == 0 ||
3151 Ustrncmp(name, "bh_", 3) == 0 ||
3152 Ustrncmp(name, "header_", 7) == 0 ||
3153 Ustrncmp(name, "rheader_", 8) == 0 ||
3154 Ustrncmp(name, "bheader_", 8) == 0)
3156 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3157 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3158 s = read_header_name(name, sizeof(name), s);
3159 value = find_header(name, FALSE, &newsize, want_raw, charset);
3161 /* If we didn't find the header, and the header contains a closing brace
3162 character, this may be a user error where the terminating colon
3163 has been omitted. Set a flag to adjust the error message in this case.
3164 But there is no error here - nothing gets inserted. */
3168 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3177 value = find_variable(name, FALSE, skipping, &newsize);
3180 expand_string_message =
3181 string_sprintf("unknown variable name \"%s\"", name);
3182 check_variable_error_message(name);
3187 /* If the data is known to be in a new buffer, newsize will be set to the
3188 size of that buffer. If this is the first thing in an expansion string,
3189 yield will be NULL; just point it at the new store instead of copying. Many
3190 expansion strings contain just one reference, so this is a useful
3191 optimization, especially for humungous headers. */
3193 len = Ustrlen(value);
3194 if (yield == NULL && newsize != 0)
3200 else yield = string_cat(yield, &size, &ptr, value, len);
3208 s = read_number(&n, s);
3209 if (n >= 0 && n <= expand_nmax)
3210 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3215 /* Otherwise, if there's no '{' after $ it's an error. */
3219 expand_string_message = US"$ not followed by letter, digit, or {";
3223 /* After { there can be various things, but they all start with
3224 an initial word, except for a number for a string match variable. */
3226 if (isdigit((*(++s))))
3229 s = read_number(&n, s);
3232 expand_string_message = US"} expected after number";
3235 if (n >= 0 && n <= expand_nmax)
3236 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3243 expand_string_message = US"letter or digit expected after ${";
3247 /* Allow "-" in names to cater for substrings with negative
3248 arguments. Since we are checking for known names after { this is
3251 s = read_name(name, sizeof(name), s, US"_-");
3252 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3256 /* Handle conditionals - preserve the values of the numerical expansion
3257 variables in case they get changed by a regular expression match in the
3258 condition. If not, they retain their external settings. At the end
3259 of this "if" section, they get restored to their previous values. */
3265 int save_expand_nmax =
3266 save_expand_strings(save_expand_nstring, save_expand_nlength);
3268 while (isspace(*s)) s++;
3269 next_s = eval_condition(s, skipping? NULL : &cond);
3270 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3273 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3274 cond? "true" : "false");
3278 /* The handling of "yes" and "no" result strings is now in a separate
3279 function that is also used by ${lookup} and ${extract} and ${run}. */
3281 switch(process_yesno(
3282 skipping, /* were previously skipping */
3283 cond, /* success/failure indicator */
3284 lookup_value, /* value to reset for string2 */
3285 &s, /* input pointer */
3286 &yield, /* output pointer */
3287 &size, /* output size */
3288 &ptr, /* output current point */
3289 US"if")) /* condition type */
3291 case 1: goto EXPAND_FAILED; /* when all is well, the */
3292 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3295 /* Restore external setting of expansion variables for continuation
3298 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3299 save_expand_nlength);
3303 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3304 expanding an internal string that isn't actually going to be used. All we
3305 need to do is check the syntax, so don't do a lookup at all. Preserve the
3306 values of the numerical expansion variables in case they get changed by a
3307 partial lookup. If not, they retain their external settings. At the end
3308 of this "lookup" section, they get restored to their previous values. */
3312 int stype, partial, affixlen, starflags;
3313 int expand_setup = 0;
3315 uschar *key, *filename, *affix;
3316 uschar *save_lookup_value = lookup_value;
3317 int save_expand_nmax =
3318 save_expand_strings(save_expand_nstring, save_expand_nlength);
3320 if ((expand_forbid & RDO_LOOKUP) != 0)
3322 expand_string_message = US"lookup expansions are not permitted";
3326 /* Get the key we are to look up for single-key+file style lookups.
3327 Otherwise set the key NULL pro-tem. */
3329 while (isspace(*s)) s++;
3332 key = expand_string_internal(s+1, TRUE, &s, skipping);
3333 if (key == NULL) goto EXPAND_FAILED;
3334 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3335 while (isspace(*s)) s++;
3339 /* Find out the type of database */
3343 expand_string_message = US"missing lookup type";
3347 /* The type is a string that may contain special characters of various
3348 kinds. Allow everything except space or { to appear; the actual content
3349 is checked by search_findtype_partial. */
3351 while (*s != 0 && *s != '{' && !isspace(*s))
3353 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3357 while (isspace(*s)) s++;
3359 /* Now check for the individual search type and any partial or default
3360 options. Only those types that are actually in the binary are valid. */
3362 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3366 expand_string_message = search_error_message;
3370 /* Check that a key was provided for those lookup types that need it,
3371 and was not supplied for those that use the query style. */
3373 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3377 expand_string_message = string_sprintf("missing {key} for single-"
3378 "key \"%s\" lookup", name);
3386 expand_string_message = string_sprintf("a single key was given for "
3387 "lookup type \"%s\", which is not a single-key lookup type", name);
3392 /* Get the next string in brackets and expand it. It is the file name for
3393 single-key+file lookups, and the whole query otherwise. In the case of
3394 queries that also require a file name (e.g. sqlite), the file name comes
3397 if (*s != '{') goto EXPAND_FAILED_CURLY;
3398 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3399 if (filename == NULL) goto EXPAND_FAILED;
3400 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3401 while (isspace(*s)) s++;
3403 /* If this isn't a single-key+file lookup, re-arrange the variables
3404 to be appropriate for the search_ functions. For query-style lookups,
3405 there is just a "key", and no file name. For the special query-style +
3406 file types, the query (i.e. "key") starts with a file name. */
3410 while (isspace(*filename)) filename++;
3413 if (mac_islookup(stype, lookup_querystyle))
3419 if (*filename != '/')
3421 expand_string_message = string_sprintf(
3422 "absolute file name expected for \"%s\" lookup", name);
3425 while (*key != 0 && !isspace(*key)) key++;
3426 if (*key != 0) *key++ = 0;
3430 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3431 the entry was not found. Note that there is no search_close() function.
3432 Files are left open in case of re-use. At suitable places in higher logic,
3433 search_tidyup() is called to tidy all open files. This can save opening
3434 the same file several times. However, files may also get closed when
3435 others are opened, if too many are open at once. The rule is that a
3436 handle should not be used after a second search_open().
3438 Request that a partial search sets up $1 and maybe $2 by passing
3439 expand_setup containing zero. If its value changes, reset expand_nmax,
3440 since new variables will have been set. Note that at the end of this
3441 "lookup" section, the old numeric variables are restored. */
3444 lookup_value = NULL;
3447 void *handle = search_open(filename, stype, 0, NULL, NULL);
3450 expand_string_message = search_error_message;
3453 lookup_value = search_find(handle, filename, key, partial, affix,
3454 affixlen, starflags, &expand_setup);
3455 if (search_find_defer)
3457 expand_string_message =
3458 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3459 search_error_message);
3462 if (expand_setup > 0) expand_nmax = expand_setup;
3465 /* The handling of "yes" and "no" result strings is now in a separate
3466 function that is also used by ${if} and ${extract}. */
3468 switch(process_yesno(
3469 skipping, /* were previously skipping */
3470 lookup_value != NULL, /* success/failure indicator */
3471 save_lookup_value, /* value to reset for string2 */
3472 &s, /* input pointer */
3473 &yield, /* output pointer */
3474 &size, /* output size */
3475 &ptr, /* output current point */
3476 US"lookup")) /* condition type */
3478 case 1: goto EXPAND_FAILED; /* when all is well, the */
3479 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3482 /* Restore external setting of expansion variables for carrying on
3483 at this level, and continue. */
3485 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3486 save_expand_nlength);
3490 /* If Perl support is configured, handle calling embedded perl subroutines,
3491 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3492 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3493 arguments (defined below). */
3495 #define EXIM_PERL_MAX_ARGS 8
3499 expand_string_message = US"\"${perl\" encountered, but this facility "
3500 "is not included in this binary";
3503 #else /* EXIM_PERL */
3505 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3508 if ((expand_forbid & RDO_PERL) != 0)
3510 expand_string_message = US"Perl calls are not permitted";
3514 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3517 case 1: goto EXPAND_FAILED_CURLY;
3519 case 3: goto EXPAND_FAILED;
3522 /* If skipping, we don't actually do anything */
3524 if (skipping) continue;
3526 /* Start the interpreter if necessary */
3528 if (!opt_perl_started)
3531 if (opt_perl_startup == NULL)
3533 expand_string_message = US"A setting of perl_startup is needed when "
3534 "using the Perl interpreter";
3537 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3538 initerror = init_perl(opt_perl_startup);
3539 if (initerror != NULL)
3541 expand_string_message =
3542 string_sprintf("error in perl_startup code: %s\n", initerror);
3545 opt_perl_started = TRUE;
3548 /* Call the function */
3550 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3551 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3552 sub_arg[0], sub_arg + 1);
3554 /* NULL yield indicates failure; if the message pointer has been set to
3555 NULL, the yield was undef, indicating a forced failure. Otherwise the
3556 message will indicate some kind of Perl error. */
3558 if (new_yield == NULL)
3560 if (expand_string_message == NULL)
3562 expand_string_message =
3563 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3564 "failure", sub_arg[0]);
3565 expand_string_forcedfail = TRUE;
3570 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3571 set during a callback from Perl. */
3573 expand_string_forcedfail = FALSE;
3577 #endif /* EXIM_PERL */
3579 /* Transform email address to "prvs" scheme to use
3580 as BATV-signed return path */
3587 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3589 case 1: goto EXPAND_FAILED_CURLY;
3591 case 3: goto EXPAND_FAILED;
3594 /* If skipping, we don't actually do anything */
3595 if (skipping) continue;
3597 /* sub_arg[0] is the address */
3598 domain = Ustrrchr(sub_arg[0],'@');
3599 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3601 expand_string_message = US"prvs first argument must be a qualified email address";
3605 /* Calculate the hash. The second argument must be a single-digit
3606 key number, or unset. */
3608 if (sub_arg[2] != NULL &&
3609 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3611 expand_string_message = US"prvs second argument must be a single digit";
3615 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3618 expand_string_message = US"prvs hmac-sha1 conversion failed";
3622 /* Now separate the domain from the local part */
3625 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3626 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3627 string_cat(yield,&size,&ptr,US"/",1);
3628 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3629 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3630 string_cat(yield,&size,&ptr,p,6);
3631 string_cat(yield,&size,&ptr,US"@",1);
3632 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3637 /* Check a prvs-encoded address for validity */
3639 case EITEM_PRVSCHECK:
3642 int mysize = 0, myptr = 0;
3646 /* TF: Ugliness: We want to expand parameter 1 first, then set
3647 up expansion variables that are used in the expansion of
3648 parameter 2. So we clone the string for the first
3649 expansion, where we only expand parameter 1.
3651 PH: Actually, that isn't necessary. The read_subs() function is
3652 designed to work this way for the ${if and ${lookup expansions. I've
3656 /* Reset expansion variables */
3657 prvscheck_result = NULL;
3658 prvscheck_address = NULL;
3659 prvscheck_keynum = NULL;
3661 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3663 case 1: goto EXPAND_FAILED_CURLY;
3665 case 3: goto EXPAND_FAILED;
3668 re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3671 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3673 uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3674 uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3675 uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3676 uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3677 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3679 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3680 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3681 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3682 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3683 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3685 /* Set up expansion variables */
3686 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3687 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3688 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3689 prvscheck_address[myptr] = '\0';
3690 prvscheck_keynum = string_copy(key_num);
3692 /* Now expand the second argument */
3693 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3695 case 1: goto EXPAND_FAILED_CURLY;
3697 case 3: goto EXPAND_FAILED;
3700 /* Now we have the key and can check the address. */
3702 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3707 expand_string_message = US"hmac-sha1 conversion failed";
3711 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3712 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3714 if (Ustrcmp(p,hash) == 0)
3716 /* Success, valid BATV address. Now check the expiry date. */
3717 uschar *now = prvs_daystamp(0);
3718 unsigned int inow = 0,iexpire = 1;
3720 (void)sscanf(CS now,"%u",&inow);
3721 (void)sscanf(CS daystamp,"%u",&iexpire);
3723 /* When "iexpire" is < 7, a "flip" has occured.
3724 Adjust "inow" accordingly. */
3725 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3729 prvscheck_result = US"1";
3730 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3734 prvscheck_result = NULL;
3735 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3740 prvscheck_result = NULL;
3741 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3744 /* Now expand the final argument. We leave this till now so that
3745 it can include $prvscheck_result. */
3747 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3749 case 1: goto EXPAND_FAILED_CURLY;
3751 case 3: goto EXPAND_FAILED;
3754 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3755 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3757 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3759 /* Reset the "internal" variables afterwards, because they are in
3760 dynamic store that will be reclaimed if the expansion succeeded. */
3762 prvscheck_address = NULL;
3763 prvscheck_keynum = NULL;
3767 /* Does not look like a prvs encoded address, return the empty string.
3768 We need to make sure all subs are expanded first, so as to skip over
3771 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3773 case 1: goto EXPAND_FAILED_CURLY;
3775 case 3: goto EXPAND_FAILED;
3782 /* Handle "readfile" to insert an entire file */
3784 case EITEM_READFILE:
3789 if ((expand_forbid & RDO_READFILE) != 0)
3791 expand_string_message = US"file insertions are not permitted";
3795 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3797 case 1: goto EXPAND_FAILED_CURLY;
3799 case 3: goto EXPAND_FAILED;
3802 /* If skipping, we don't actually do anything */
3804 if (skipping) continue;
3806 /* Open the file and read it */
3808 f = Ufopen(sub_arg[0], "rb");
3811 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3815 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3820 /* Handle "readsocket" to insert data from a Unix domain socket */
3822 case EITEM_READSOCK:
3828 struct sockaddr_un sockun; /* don't call this "sun" ! */
3832 if ((expand_forbid & RDO_READSOCK) != 0)
3834 expand_string_message = US"socket insertions are not permitted";
3838 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3839 because there may be a string for expansion on failure. */
3841 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3843 case 1: goto EXPAND_FAILED_CURLY;
3844 case 2: /* Won't occur: no end check */
3845 case 3: goto EXPAND_FAILED;
3848 /* Sort out timeout, if given */
3850 if (sub_arg[2] != NULL)
3852 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3855 expand_string_message = string_sprintf("bad time value %s",
3860 else sub_arg[3] = NULL; /* No eol if no timeout */
3862 /* If skipping, we don't actually do anything. Otherwise, arrange to
3863 connect to either an IP or a Unix socket. */
3867 /* Handle an IP (internet) domain */
3869 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
3871 BOOL connected = FALSE;
3875 uschar *server_name = sub_arg[0] + 5;
3876 uschar *port_name = Ustrrchr(server_name, ':');
3878 /* Sort out the port */
3880 if (port_name == NULL)
3882 expand_string_message =
3883 string_sprintf("missing port for readsocket %s", sub_arg[0]);
3886 *port_name++ = 0; /* Terminate server name */
3888 if (isdigit(*port_name))
3891 port = Ustrtol(port_name, &end, 0);
3892 if (end != port_name + Ustrlen(port_name))
3894 expand_string_message =
3895 string_sprintf("invalid port number %s", port_name);
3901 struct servent *service_info = getservbyname(CS port_name, "tcp");
3902 if (service_info == NULL)
3904 expand_string_message = string_sprintf("unknown port \"%s\"",
3908 port = ntohs(service_info->s_port);
3911 /* Sort out the server. */
3914 shost.address = NULL;
3918 namelen = Ustrlen(server_name);
3920 /* Anything enclosed in [] must be an IP address. */
3922 if (server_name[0] == '[' &&
3923 server_name[namelen - 1] == ']')
3925 server_name[namelen - 1] = 0;
3927 if (string_is_ip_address(server_name, NULL) == 0)
3929 expand_string_message =
3930 string_sprintf("malformed IP address \"%s\"", server_name);
3933 shost.name = shost.address = server_name;
3936 /* Otherwise check for an unadorned IP address */
3938 else if (string_is_ip_address(server_name, NULL) != 0)
3939 shost.name = shost.address = server_name;
3941 /* Otherwise lookup IP address(es) from the name */
3945 shost.name = server_name;
3946 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
3947 FALSE) != HOST_FOUND)
3949 expand_string_message =
3950 string_sprintf("no IP address found for host %s", shost.name);
3955 /* Try to connect to the server - test each IP till one works */
3957 for (h = &shost; h != NULL; h = h->next)
3959 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
3960 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
3962 expand_string_message = string_sprintf("failed to create socket: "
3963 "%s", strerror(errno));
3967 if (ip_connect(fd, af, h->address, port, timeout) == 0)
3976 expand_string_message = string_sprintf("failed to connect to "
3977 "socket %s: couldn't connect to any host", sub_arg[0],
3983 /* Handle a Unix domain socket */
3988 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3990 expand_string_message = string_sprintf("failed to create socket: %s",
3995 sockun.sun_family = AF_UNIX;
3996 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3999 sigalrm_seen = FALSE;
4001 rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4005 expand_string_message = US "socket connect timed out";
4010 expand_string_message = string_sprintf("failed to connect to socket "
4011 "%s: %s", sub_arg[0], strerror(errno));
4016 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4018 /* Write the request string, if not empty */
4020 if (sub_arg[1][0] != 0)
4022 int len = Ustrlen(sub_arg[1]);
4023 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4025 if (write(fd, sub_arg[1], len) != len)
4027 expand_string_message = string_sprintf("request write to socket "
4028 "failed: %s", strerror(errno));
4033 /* Shut down the sending side of the socket. This helps some servers to
4034 recognise that it is their turn to do some work. Just in case some
4035 system doesn't have this function, make it conditional. */
4038 shutdown(fd, SHUT_WR);
4041 /* Now we need to read from the socket, under a timeout. The function
4042 that reads a file can be used. */
4044 f = fdopen(fd, "rb");
4045 sigalrm_seen = FALSE;
4047 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4051 /* After a timeout, we restore the pointer in the result, that is,
4052 make sure we add nothing from the socket. */
4057 expand_string_message = US "socket read timed out";
4062 /* The whole thing has worked (or we were skipping). If there is a
4063 failure string following, we need to skip it. */
4067 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
4069 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4070 while (isspace(*s)) s++;
4072 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4075 /* Come here on failure to create socket, connect socket, write to the
4076 socket, or timeout on reading. If another substring follows, expand and
4077 use it. Otherwise, those conditions give expand errors. */
4080 if (*s != '{') goto EXPAND_FAILED;
4081 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4082 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
4083 if (arg == NULL) goto EXPAND_FAILED;
4084 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4085 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4086 while (isspace(*s)) s++;
4087 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4091 /* Handle "run" to execute a program. */
4103 if ((expand_forbid & RDO_RUN) != 0)
4105 expand_string_message = US"running a command is not permitted";
4109 while (isspace(*s)) s++;
4110 if (*s != '{') goto EXPAND_FAILED_CURLY;
4111 arg = expand_string_internal(s+1, TRUE, &s, skipping);
4112 if (arg == NULL) goto EXPAND_FAILED;
4113 while (isspace(*s)) s++;
4114 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4116 if (skipping) /* Just pretend it worked when we're skipping */
4122 if (!transport_set_up_command(&argv, /* anchor for arg list */
4123 arg, /* raw command */
4124 FALSE, /* don't expand the arguments */
4125 0, /* not relevant when... */
4126 NULL, /* no transporting address */
4127 US"${run} expansion", /* for error messages */
4128 &expand_string_message)) /* where to put error message */
4133 /* Create the child process, making it a group leader. */
4135 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4139 expand_string_message =
4140 string_sprintf("couldn't create child process: %s", strerror(errno));
4144 /* Nothing is written to the standard input. */
4148 /* Wait for the process to finish, applying the timeout, and inspect its
4149 return code for serious disasters. Simple non-zero returns are passed on.
4152 if ((runrc = child_close(pid, 60)) < 0)
4156 expand_string_message = string_sprintf("command timed out");
4157 killpg(pid, SIGKILL); /* Kill the whole process group */
4160 else if (runrc == -257)
4161 expand_string_message = string_sprintf("wait() failed: %s",
4165 expand_string_message = string_sprintf("command killed by signal %d",
4171 /* Read the pipe to get the command's output into $value (which is kept
4172 in lookup_value). */
4174 f = fdopen(fd_out, "rb");
4175 lookup_value = NULL;
4176 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4180 /* Process the yes/no strings; $value may be useful in both cases */
4182 switch(process_yesno(
4183 skipping, /* were previously skipping */
4184 runrc == 0, /* success/failure indicator */
4185 lookup_value, /* value to reset for string2 */
4186 &s, /* input pointer */
4187 &yield, /* output pointer */
4188 &size, /* output size */
4189 &ptr, /* output current point */
4190 US"run")) /* condition type */
4192 case 1: goto EXPAND_FAILED; /* when all is well, the */
4193 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4199 /* Handle character translation for "tr" */
4207 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4209 case 1: goto EXPAND_FAILED_CURLY;
4211 case 3: goto EXPAND_FAILED;
4214 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4215 o2m = Ustrlen(sub[2]) - 1;
4217 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4219 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4223 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4230 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4231 expanded arguments. */
4241 int val[2] = { 0, -1 };
4244 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4245 Ensure that sub[2] is set in the ${length case. */
4248 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4251 case 1: goto EXPAND_FAILED_CURLY;
4253 case 3: goto EXPAND_FAILED;
4256 /* Juggle the arguments if there are only two of them: always move the
4257 string to the last position and make ${length{n}{str}} equivalent to
4258 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4264 if (item_type == EITEM_LENGTH)
4271 for (i = 0; i < 2; i++)
4273 if (sub[i] == NULL) continue;
4274 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4275 if (*ret != 0 || (i != 0 && val[i] < 0))
4277 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4278 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4284 (item_type == EITEM_HASH)?
4285 compute_hash(sub[2], val[0], val[1], &len) :
4286 (item_type == EITEM_NHASH)?
4287 compute_nhash(sub[2], val[0], val[1], &len) :
4288 extract_substr(sub[2], val[0], val[1], &len);
4290 if (ret == NULL) goto EXPAND_FAILED;
4291 yield = string_cat(yield, &size, &ptr, ret, len);
4295 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4296 This code originally contributed by Steve Haslam. It currently supports
4297 the use of MD5 and SHA-1 hashes.
4299 We need some workspace that is large enough to handle all the supported
4300 hash types. Use macros to set the sizes rather than be too elaborate. */
4302 #define MAX_HASHLEN 20
4303 #define MAX_HASHBLOCKLEN 64
4312 int hashlen; /* Number of octets for the hash algorithm's output */
4313 int hashblocklen; /* Number of octets the hash algorithm processes */
4315 unsigned int keylen;
4317 uschar keyhash[MAX_HASHLEN];
4318 uschar innerhash[MAX_HASHLEN];
4319 uschar finalhash[MAX_HASHLEN];
4320 uschar finalhash_hex[2*MAX_HASHLEN];
4321 uschar innerkey[MAX_HASHBLOCKLEN];
4322 uschar outerkey[MAX_HASHBLOCKLEN];
4324 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4326 case 1: goto EXPAND_FAILED_CURLY;
4328 case 3: goto EXPAND_FAILED;
4331 if (Ustrcmp(sub[0], "md5") == 0)
4334 use_base = &md5_base;
4338 else if (Ustrcmp(sub[0], "sha1") == 0)
4341 use_base = &sha1_base;
4347 expand_string_message =
4348 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4353 keylen = Ustrlen(keyptr);
4355 /* If the key is longer than the hash block length, then hash the key
4358 if (keylen > hashblocklen)
4360 chash_start(type, use_base);
4361 chash_end(type, use_base, keyptr, keylen, keyhash);
4366 /* Now make the inner and outer key values */
4368 memset(innerkey, 0x36, hashblocklen);
4369 memset(outerkey, 0x5c, hashblocklen);
4371 for (i = 0; i < keylen; i++)
4373 innerkey[i] ^= keyptr[i];
4374 outerkey[i] ^= keyptr[i];
4377 /* Now do the hashes */
4379 chash_start(type, use_base);
4380 chash_mid(type, use_base, innerkey);
4381 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4383 chash_start(type, use_base);
4384 chash_mid(type, use_base, outerkey);
4385 chash_end(type, use_base, innerhash, hashlen, finalhash);
4387 /* Encode the final hash as a hex string */
4390 for (i = 0; i < hashlen; i++)
4392 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4393 *p++ = hex_digits[finalhash[i] & 0x0f];
4396 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4397 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4399 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4404 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4405 We have to save the numerical variables and restore them afterwards. */
4410 int moffset, moffsetextra, slen;
4413 const uschar *rerror;
4416 int save_expand_nmax =
4417 save_expand_strings(save_expand_nstring, save_expand_nlength);
4419 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4421 case 1: goto EXPAND_FAILED_CURLY;
4423 case 3: goto EXPAND_FAILED;
4426 /* Compile the regular expression */
4428 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4433 expand_string_message = string_sprintf("regular expression error in "
4434 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4438 /* Now run a loop to do the substitutions as often as necessary. It ends
4439 when there are no more matches. Take care over matches of the null string;
4440 do the same thing as Perl does. */
4443 slen = Ustrlen(sub[0]);
4444 moffset = moffsetextra = 0;
4449 int ovector[3*(EXPAND_MAXN+1)];
4450 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4451 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4455 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4456 is not necessarily the end. We want to repeat the match from one
4457 character further along, but leaving the basic offset the same (for
4458 copying below). We can't be at the end of the string - that was checked
4459 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4460 finished; copy the remaining string and end the loop. */
4470 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4474 /* Match - set up for expanding the replacement. */
4476 if (n == 0) n = EXPAND_MAXN + 1;
4478 for (nn = 0; nn < n*2; nn += 2)
4480 expand_nstring[expand_nmax] = subject + ovector[nn];
4481 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4485 /* Copy the characters before the match, plus the expanded insertion. */
4487 yield = string_cat(yield, &size, &ptr, subject + moffset,
4488 ovector[0] - moffset);
4489 insert = expand_string(sub[2]);
4490 if (insert == NULL) goto EXPAND_FAILED;
4491 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4493 moffset = ovector[1];
4497 /* If we have matched an empty string, first check to see if we are at
4498 the end of the subject. If so, the loop is over. Otherwise, mimic
4499 what Perl's /g options does. This turns out to be rather cunning. First
4500 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4501 string at the same point. If this fails (picked up above) we advance to
4502 the next character. */
4504 if (ovector[0] == ovector[1])
4506 if (ovector[0] == slen) break;
4507 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4511 /* All done - restore numerical variables. */
4513 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4514 save_expand_nlength);
4518 /* Handle keyed and numbered substring extraction. If the first argument
4519 consists entirely of digits, then a numerical extraction is assumed. */
4525 int field_number = 1;
4526 BOOL field_number_set = FALSE;
4527 uschar *save_lookup_value = lookup_value;
4529 int save_expand_nmax =
4530 save_expand_strings(save_expand_nstring, save_expand_nlength);
4532 /* Read the arguments */
4534 for (i = 0; i < j; i++)
4536 while (isspace(*s)) s++;
4539 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4540 if (sub[i] == NULL) goto EXPAND_FAILED;
4541 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4543 /* After removal of leading and trailing white space, the first
4544 argument must not be empty; if it consists entirely of digits
4545 (optionally preceded by a minus sign), this is a numerical
4546 extraction, and we expect 3 arguments. */
4554 while (isspace(*p)) p++;
4558 while (len > 0 && isspace(p[len-1])) len--;
4563 expand_string_message = US"first argument of \"extract\" must "
4573 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4577 j = 3; /* Need 3 args */
4578 field_number_set = TRUE;
4582 else goto EXPAND_FAILED_CURLY;
4585 /* Extract either the numbered or the keyed substring into $value. If
4586 skipping, just pretend the extraction failed. */
4588 lookup_value = skipping? NULL : field_number_set?
4589 expand_gettokened(field_number, sub[1], sub[2]) :
4590 expand_getkeyed(sub[0], sub[1]);
4592 /* If no string follows, $value gets substituted; otherwise there can
4593 be yes/no strings, as for lookup or if. */
4595 switch(process_yesno(
4596 skipping, /* were previously skipping */
4597 lookup_value != NULL, /* success/failure indicator */
4598 save_lookup_value, /* value to reset for string2 */
4599 &s, /* input pointer */
4600 &yield, /* output pointer */
4601 &size, /* output size */
4602 &ptr, /* output current point */
4603 US"extract")) /* condition type */
4605 case 1: goto EXPAND_FAILED; /* when all is well, the */
4606 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4609 /* All done - restore numerical variables. */
4611 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4612 save_expand_nlength);
4618 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4619 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4620 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4621 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4623 #define EXPAND_DLFUNC_MAX_ARGS 8
4626 #ifndef EXPAND_DLFUNC
4627 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4628 "is not included in this binary";
4631 #else /* EXPAND_DLFUNC */
4634 exim_dlfunc_t *func;
4637 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4639 if ((expand_forbid & RDO_DLFUNC) != 0)
4641 expand_string_message =
4642 US"dynamically-loaded functions are not permitted";
4646 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4649 case 1: goto EXPAND_FAILED_CURLY;
4651 case 3: goto EXPAND_FAILED;
4654 /* If skipping, we don't actually do anything */
4656 if (skipping) continue;
4658 /* Look up the dynamically loaded object handle in the tree. If it isn't
4659 found, dlopen() the file and put the handle in the tree for next time. */
4661 t = tree_search(dlobj_anchor, argv[0]);
4664 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4667 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4668 argv[0], dlerror());
4669 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4672 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4673 Ustrcpy(t->name, argv[0]);
4674 t->data.ptr = handle;
4675 (void)tree_insertnode(&dlobj_anchor, t);
4678 /* Having obtained the dynamically loaded object handle, look up the
4679 function pointer. */
4681 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4684 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4685 "%s", argv[1], argv[0], dlerror());
4686 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4690 /* Call the function and work out what to do with the result. If it
4691 returns OK, we have a replacement string; if it returns DEFER then
4692 expansion has failed in a non-forced manner; if it returns FAIL then
4693 failure was forced; if it returns ERROR or any other value there's a
4694 problem, so panic slightly. */
4697 for (argc = 0; argv[argc] != NULL; argc++);
4698 status = func(&result, argc - 2, &argv[2]);
4701 if (result == NULL) result = US"";
4702 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4707 expand_string_message = result == NULL ? US"(no message)" : result;
4708 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4709 else if(status != FAIL)
4710 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4711 argv[0], argv[1], status, expand_string_message);
4715 #endif /* EXPAND_DLFUNC */
4718 /* Control reaches here if the name is not recognized as one of the more
4719 complicated expansion items. Check for the "operator" syntax (name terminated
4720 by a colon). Some of the operators have arguments, separated by _ from the
4727 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4728 if (sub == NULL) goto EXPAND_FAILED;
4731 /* Owing to an historical mis-design, an underscore may be part of the
4732 operator name, or it may introduce arguments. We therefore first scan the
4733 table of names that contain underscores. If there is no match, we cut off
4734 the arguments and then scan the main table. */
4736 c = chop_match(name, op_table_underscore,
4737 sizeof(op_table_underscore)/sizeof(uschar *));
4741 arg = Ustrchr(name, '_');
4742 if (arg != NULL) *arg = 0;
4743 c = chop_match(name, op_table_main,
4744 sizeof(op_table_main)/sizeof(uschar *));
4745 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4746 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
4749 /* If we are skipping, we don't need to perform the operation at all.
4750 This matters for operations like "mask", because the data may not be
4751 in the correct format when skipping. For example, the expression may test
4752 for the existence of $sender_host_address before trying to mask it. For
4753 other operations, doing them may not fail, but it is a waste of time. */
4755 if (skipping && c >= 0) continue;
4757 /* Otherwise, switch on the operator type */
4764 unsigned long int n = Ustrtoul(sub, &t, 10);
4767 expand_string_message = string_sprintf("argument for base62 "
4768 "operator is \"%s\", which is not a decimal number", sub);
4771 t = string_base62(n);
4772 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4776 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
4782 unsigned long int n = 0;
4785 uschar *t = Ustrchr(base62_chars, *tt++);
4788 expand_string_message = string_sprintf("argument for base62d "
4789 "operator is \"%s\", which is not a base %d number", sub,
4793 n = n * BASE_62 + (t - base62_chars);
4795 (void)sprintf(CS buf, "%ld", n);
4796 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4802 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4803 if (expanded == NULL)
4805 expand_string_message =
4806 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4807 expand_string_message);
4810 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4817 uschar *t = sub - 1;
4818 while (*(++t) != 0) { *t = tolower(*t); count++; }
4819 yield = string_cat(yield, &size, &ptr, sub, count);
4826 uschar *t = sub - 1;
4827 while (*(++t) != 0) { *t = toupper(*t); count++; }
4828 yield = string_cat(yield, &size, &ptr, sub, count);
4839 md5_end(&base, sub, Ustrlen(sub), digest);
4840 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4841 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4852 sha1_end(&base, sub, Ustrlen(sub), digest);
4853 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4854 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4858 /* Convert hex encoding to base64 encoding */
4868 for (enc = sub; *enc != 0; enc++)
4870 if (!isxdigit(*enc))
4872 expand_string_message = string_sprintf("\"%s\" is not a hex "
4881 expand_string_message = string_sprintf("\"%s\" contains an odd "
4882 "number of characters", sub);
4886 while ((c = *in++) != 0)
4888 if (isdigit(c)) c -= '0';
4889 else c = toupper(c) - 'A' + 10;
4901 enc = auth_b64encode(sub, out - sub);
4902 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4906 /* mask applies a mask to an IP address; for example the result of
4907 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4914 int mask, maskoffset;
4915 int type = string_is_ip_address(sub, &maskoffset);
4920 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4925 if (maskoffset == 0)
4927 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4932 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4934 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4936 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4941 /* Convert the address to binary integer(s) and apply the mask */
4943 sub[maskoffset] = 0;
4944 count = host_aton(sub, binary);
4945 host_mask(count, binary, mask);
4947 /* Convert to masked textual format and add to output. */
4949 yield = string_cat(yield, &size, &ptr, buffer,
4950 host_nmtoa(count, binary, mask, buffer, '.'));
4955 case EOP_LOCAL_PART:
4959 int start, end, domain;
4960 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4964 if (c != EOP_DOMAIN)
4966 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4967 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4969 else if (domain != 0)
4972 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4978 /* quote puts a string in quotes if it is empty or contains anything
4979 other than alphamerics, underscore, dot, or hyphen.
4981 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4982 be quoted in order to be a valid local part.
4984 In both cases, newlines and carriage returns are converted into \n and \r
4988 case EOP_QUOTE_LOCAL_PART:
4991 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4992 uschar *t = sub - 1;
4996 while (!needs_quote && *(++t) != 0)
4997 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4999 else /* EOP_QUOTE_LOCAL_PART */
5001 while (!needs_quote && *(++t) != 0)
5002 needs_quote = !isalnum(*t) &&
5003 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5004 (*t != '.' || t == sub || t[1] == 0);
5009 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5014 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5015 else if (*t == '\r')
5016 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5019 if (*t == '\\' || *t == '"')
5020 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5021 yield = string_cat(yield, &size, &ptr, t, 1);
5024 yield = string_cat(yield, &size, &ptr, US"\"", 1);
5026 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5030 /* quote_lookuptype does lookup-specific quoting */
5035 uschar *opt = Ustrchr(arg, '_');
5037 if (opt != NULL) *opt++ = 0;
5039 n = search_findtype(arg, Ustrlen(arg));
5042 expand_string_message = search_error_message;
5046 if (lookup_list[n].quote != NULL)
5047 sub = (lookup_list[n].quote)(sub, opt);
5048 else if (opt != NULL) sub = NULL;
5052 expand_string_message = string_sprintf(
5053 "\"%s\" unrecognized after \"${quote_%s\"",
5058 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5062 /* rx quote sticks in \ before any non-alphameric character so that
5063 the insertion works in a regular expression. */
5067 uschar *t = sub - 1;
5071 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5072 yield = string_cat(yield, &size, &ptr, t, 1);
5077 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5078 prescribed by the RFC, if there are characters that need to be encoded */
5082 uschar buffer[2048];
5083 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5084 buffer, sizeof(buffer), FALSE);
5085 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5089 /* RFC 2047 decode */
5095 uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5096 headers_charset, '?', &len, &error);
5099 expand_string_message = error;
5102 yield = string_cat(yield, &size, &ptr, decoded, len);
5106 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5116 if (c > 255) c = '_';
5118 yield = string_cat(yield, &size, &ptr, buff, 1);
5123 /* escape turns all non-printing characters into escape sequences. */
5127 uschar *t = string_printing(sub);
5128 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5132 /* Handle numeric expression evaluation */
5137 uschar *save_sub = sub;
5138 uschar *error = NULL;
5139 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5142 expand_string_message = string_sprintf("error in expression "
5143 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5147 sprintf(CS var_buffer, "%d", n);
5148 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5152 /* Handle time period formating */
5156 int n = readconf_readtime(sub, 0, FALSE);
5159 expand_string_message = string_sprintf("string \"%s\" is not an "
5160 "Exim time interval in \"%s\" operator", sub, name);
5163 sprintf(CS var_buffer, "%d", n);
5164 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5168 case EOP_TIME_INTERVAL:
5171 uschar *t = read_number(&n, sub);
5172 if (*t != 0) /* Not A Number*/
5174 expand_string_message = string_sprintf("string \"%s\" is not a "
5175 "positive number in \"%s\" operator", sub, name);
5178 t = readconf_printtime(n);
5179 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5183 /* Convert string to base64 encoding */
5187 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5188 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5192 /* strlen returns the length of the string */
5197 (void)sprintf(CS buff, "%d", Ustrlen(sub));
5198 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5202 /* length_n or l_n takes just the first n characters or the whole string,
5203 whichever is the shorter;
5205 substr_m_n, and s_m_n take n characters from offset m; negative m take
5206 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5207 takes the rest, either to the right or to the left.
5209 hash_n or h_n makes a hash of length n from the string, yielding n
5210 characters from the set a-z; hash_n_m makes a hash of length n, but
5211 uses m characters from the set a-zA-Z0-9.
5213 nhash_n returns a single number between 0 and n-1 (in text form), while
5214 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5215 between 0 and n-1 and the second between 0 and m-1. */
5235 expand_string_message = string_sprintf("missing values after %s",
5240 /* "length" has only one argument, effectively being synonymous with
5243 if (c == EOP_LENGTH || c == EOP_L)
5249 /* The others have one or two arguments; for "substr" the first may be
5250 negative. The second being negative means "not supplied". */
5255 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5258 /* Read up to two numbers, separated by underscores */
5263 if (arg != ret && *arg == '_' && pn == &value1)
5267 if (arg[1] != 0) arg++;
5269 else if (!isdigit(*arg))
5271 expand_string_message =
5272 string_sprintf("non-digit after underscore in \"%s\"", name);
5275 else *pn = (*pn)*10 + *arg++ - '0';
5279 /* Perform the required operation */
5282 (c == EOP_HASH || c == EOP_H)?
5283 compute_hash(sub, value1, value2, &len) :
5284 (c == EOP_NHASH || c == EOP_NH)?
5285 compute_nhash(sub, value1, value2, &len) :
5286 extract_substr(sub, value1, value2, &len);
5288 if (ret == NULL) goto EXPAND_FAILED;
5289 yield = string_cat(yield, &size, &ptr, ret, len);
5299 uschar **modetable[3];
5304 if ((expand_forbid & RDO_EXISTS) != 0)
5306 expand_string_message = US"Use of the stat() expansion is not permitted";
5310 if (stat(CS sub, &st) < 0)
5312 expand_string_message = string_sprintf("stat(%s) failed: %s",
5313 sub, strerror(errno));
5317 switch (mode & S_IFMT)
5319 case S_IFIFO: smode[0] = 'p'; break;
5320 case S_IFCHR: smode[0] = 'c'; break;
5321 case S_IFDIR: smode[0] = 'd'; break;
5322 case S_IFBLK: smode[0] = 'b'; break;
5323 case S_IFREG: smode[0] = '-'; break;
5324 default: smode[0] = '?'; break;
5327 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5328 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5329 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5331 for (i = 0; i < 3; i++)
5333 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5338 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5339 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5340 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5341 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5342 (long)st.st_gid, st.st_size, (long)st.st_atime,
5343 (long)st.st_mtime, (long)st.st_ctime);
5344 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5348 /* Unknown operator */
5351 expand_string_message =
5352 string_sprintf("unknown expansion operator \"%s\"", name);
5357 /* Handle a plain name. If this is the first thing in the expansion, release
5358 the pre-allocated buffer. If the result data is known to be in a new buffer,
5359 newsize will be set to the size of that buffer, and we can just point at that
5360 store instead of copying. Many expansion strings contain just one reference,
5361 so this is a useful optimization, especially for humungous headers
5362 ($message_headers). */
5374 value = find_variable(name, FALSE, skipping, &newsize);
5377 expand_string_message =
5378 string_sprintf("unknown variable in \"${%s}\"", name);
5379 check_variable_error_message(name);
5382 len = Ustrlen(value);
5383 if (yield == NULL && newsize != 0)
5389 else yield = string_cat(yield, &size, &ptr, value, len);
5393 /* Else there's something wrong */
5395 expand_string_message =
5396 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5397 "in a variable reference)", name);
5401 /* If we hit the end of the string when ket_ends is set, there is a missing
5402 terminating brace. */
5404 if (ket_ends && *s == 0)
5406 expand_string_message = malformed_header?
5407 US"missing } at end of string - could be header name not terminated by colon"
5409 US"missing } at end of string";
5413 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5414 added to the string. If so, set up an empty string. Add a terminating zero. If
5415 left != NULL, return a pointer to the terminator. */
5417 if (yield == NULL) yield = store_get(1);
5419 if (left != NULL) *left = s;
5421 /* Any stacking store that was used above the final string is no longer needed.
5422 In many cases the final string will be the first one that was got and so there
5423 will be optimal store usage. */
5425 store_reset(yield + ptr + 1);
5428 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5430 if (skipping) debug_printf("skipping: result is not used\n");
5434 /* This is the failure exit: easiest to program with a goto. We still need
5435 to update the pointer to the terminator, for cases of nested calls with "fail".
5438 EXPAND_FAILED_CURLY:
5439 expand_string_message = malformed_header?
5440 US"missing or misplaced { or } - could be header name not terminated by colon"
5442 US"missing or misplaced { or }";
5444 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5445 that is a bad idea, because expand_string_message is in dynamic store. */
5448 if (left != NULL) *left = s;
5451 debug_printf("failed to expand: %s\n", string);
5452 debug_printf(" error message: %s\n", expand_string_message);
5453 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5459 /* This is the external function call. Do a quick check for any expansion
5460 metacharacters, and if there are none, just return the input string.
5462 Argument: the string to be expanded
5463 Returns: the expanded string, or NULL if expansion failed; if failure was
5464 due to a lookup deferring, search_find_defer will be TRUE
5468 expand_string(uschar *string)
5470 search_find_defer = FALSE;
5471 malformed_header = FALSE;
5472 return (Ustrpbrk(string, "$\\") == NULL)? string :
5473 expand_string_internal(string, FALSE, NULL, FALSE);
5478 /*************************************************
5480 *************************************************/
5482 /* Now and again we want to expand a string and be sure that the result is in a
5483 new bit of store. This function does that.
5485 Argument: the string to be expanded
5486 Returns: the expanded string, always in a new bit of store, or NULL
5490 expand_string_copy(uschar *string)
5492 uschar *yield = expand_string(string);
5493 if (yield == string) yield = string_copy(string);
5499 /*************************************************
5500 * Expand and interpret as an integer *
5501 *************************************************/
5503 /* Expand a string, and convert the result into an integer.
5506 string the string to be expanded
5507 isplus TRUE if a non-negative number is expected
5509 Returns: the integer value, or
5510 -1 for an expansion error ) in both cases, message in
5511 -2 for an integer interpretation error ) expand_string_message
5512 expand_string_message is set NULL for an OK integer
5516 expand_string_integer(uschar *string, BOOL isplus)
5519 uschar *s = expand_string(string);
5520 uschar *msg = US"invalid integer \"%s\"";
5523 /* If expansion failed, expand_string_message will be set. */
5525 if (s == NULL) return -1;
5527 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5528 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5529 systems, so we set it zero ourselves. */
5532 expand_string_message = NULL; /* Indicates no error */
5533 value = strtol(CS s, CSS &endptr, 10);
5537 msg = US"integer expected but \"%s\" found";
5539 else if (value < 0 && isplus)
5541 msg = US"non-negative integer expected but \"%s\" found";
5545 /* Ensure we can cast this down to an int */
5546 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5548 if (errno != ERANGE)
5550 if (tolower(*endptr) == 'k')
5552 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5556 else if (tolower(*endptr) == 'm')
5558 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5560 else value *= 1024*1024;
5564 if (errno == ERANGE)
5565 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5568 while (isspace(*endptr)) endptr++;
5569 if (*endptr == 0) return (int)value;
5573 expand_string_message = string_sprintf(CS msg, s);
5578 /*************************************************
5579 **************************************************
5580 * Stand-alone test program *
5581 **************************************************
5582 *************************************************/
5588 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5590 int ovector[3*(EXPAND_MAXN+1)];
5591 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5592 ovector, sizeof(ovector)/sizeof(int));
5593 BOOL yield = n >= 0;
5594 if (n == 0) n = EXPAND_MAXN + 1;
5598 expand_nmax = (setup < 0)? 0 : setup + 1;
5599 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5601 expand_nstring[expand_nmax] = subject + ovector[nn];
5602 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5610 int main(int argc, uschar **argv)
5613 uschar buffer[1024];
5615 debug_selector = D_v;
5616 debug_file = stderr;
5617 debug_fd = fileno(debug_file);
5618 big_buffer = malloc(big_buffer_size);
5620 for (i = 1; i < argc; i++)
5622 if (argv[i][0] == '+')
5624 debug_trace_memory = 2;
5627 if (isdigit(argv[i][0]))
5628 debug_selector = Ustrtol(argv[i], NULL, 0);
5630 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5634 eldap_default_servers = argv[i];
5637 mysql_servers = argv[i];
5640 pgsql_servers = argv[i];
5644 else opt_perl_startup = argv[i];
5648 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5650 expand_nstring[1] = US"string 1....";
5651 expand_nlength[1] = 8;
5655 if (opt_perl_startup != NULL)
5658 printf("Starting Perl interpreter\n");
5659 errstr = init_perl(opt_perl_startup);
5662 printf("** error in perl_startup code: %s\n", errstr);
5663 return EXIT_FAILURE;
5666 #endif /* EXIM_PERL */
5668 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5670 void *reset_point = store_get(0);
5671 uschar *yield = expand_string(buffer);
5674 printf("%s\n", yield);
5675 store_reset(reset_point);
5679 if (search_find_defer) printf("search_find deferred\n");
5680 printf("Failed: %s\n", expand_string_message);
5681 if (expand_string_forcedfail) printf("Forced failure\n");
5693 /* End of expand.c */