1 /* $Cambridge: exim/src/src/expand.c,v 1.68 2006/10/31 14:26:34 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /* Functions for handling string expansion. */
17 #ifndef SUPPORT_CRYPTEQ
18 #define SUPPORT_CRYPTEQ
22 #ifdef SUPPORT_CRYPTEQ
27 extern char* crypt16(char*, char*);
32 #include "lookups/ldap.h"
37 /* Recursively called function */
39 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
43 /*************************************************
44 * Local statics and tables *
45 *************************************************/
47 /* Table of item names, and corresponding switch numbers. The names must be in
48 alphabetical order. */
50 static uschar *item_table[] = {
88 /* Tables of operator names, and corresponding switch numbers. The names must be
89 in alphabetical order. There are two tables, because underscore is used in some
90 cases to introduce arguments, whereas for other it is part of the name. This is
91 an historical mis-design. */
93 static uschar *op_table_underscore[] = {
103 EOP_QUOTE_LOCAL_PART,
107 static uschar *op_table_main[] = {
138 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
168 /* Table of condition names, and corresponding switch numbers. The names must
169 be in alphabetical order. */
171 static uschar *cond_table[] = {
175 US"==", /* Backward compatibility */
201 US"match_local_part",
223 ECOND_FIRST_DELIVERY,
240 ECOND_MATCH_LOCAL_PART,
250 /* Type for main variable table */
258 /* Type for entries pointing to address/length pairs. Not currently
266 /* Types of table entry */
269 vtype_int, /* value is address of int */
270 vtype_filter_int, /* ditto, but recognized only when filtering */
271 vtype_ino, /* value is address of ino_t (not always an int) */
272 vtype_uid, /* value is address of uid_t (not always an int) */
273 vtype_gid, /* value is address of gid_t (not always an int) */
274 vtype_stringptr, /* value is address of pointer to string */
275 vtype_msgbody, /* as stringptr, but read when first required */
276 vtype_msgbody_end, /* ditto, the end of the message */
277 vtype_msgheaders, /* the message's headers, processed */
278 vtype_msgheaders_raw, /* the message's headers, unprocessed */
279 vtype_localpart, /* extract local part from string */
280 vtype_domain, /* extract domain from string */
281 vtype_recipients, /* extract recipients from recipients list */
282 /* (enabled only during system filtering */
283 vtype_todbsdin, /* value not used; generate BSD inbox tod */
284 vtype_tode, /* value not used; generate tod in epoch format */
285 vtype_todf, /* value not used; generate full tod */
286 vtype_todl, /* value not used; generate log tod */
287 vtype_todlf, /* value not used; generate log file datestamp tod */
288 vtype_todzone, /* value not used; generate time zone only */
289 vtype_todzulu, /* value not used; generate zulu tod */
290 vtype_reply, /* value not used; get reply from headers */
291 vtype_pid, /* value not used; result is pid */
292 vtype_host_lookup, /* value not used; get host name */
293 vtype_load_avg, /* value not used; result is int from os_getloadavg */
294 vtype_pspace, /* partition space; value is T/F for spool/log */
295 vtype_pinodes /* partition inodes; value is T/F for spool/log */
296 #ifdef EXPERIMENTAL_DOMAINKEYS
297 ,vtype_dk_verify /* Serve request out of DomainKeys verification structure */
301 /* This table must be kept in alphabetical order. */
303 static var_entry var_table[] = {
304 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
305 they will be confused with user-creatable ACL variables. */
306 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
307 { "address_data", vtype_stringptr, &deliver_address_data },
308 { "address_file", vtype_stringptr, &address_file },
309 { "address_pipe", vtype_stringptr, &address_pipe },
310 { "authenticated_id", vtype_stringptr, &authenticated_id },
311 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
312 { "authentication_failed",vtype_int, &authentication_failed },
313 #ifdef EXPERIMENTAL_BRIGHTMAIL
314 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
315 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
316 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
317 { "bmi_deliver", vtype_int, &bmi_deliver },
319 { "body_linecount", vtype_int, &body_linecount },
320 { "body_zerocount", vtype_int, &body_zerocount },
321 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
322 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
323 { "caller_gid", vtype_gid, &real_gid },
324 { "caller_uid", vtype_uid, &real_uid },
325 { "compile_date", vtype_stringptr, &version_date },
326 { "compile_number", vtype_stringptr, &version_cnumber },
327 { "csa_status", vtype_stringptr, &csa_status },
328 #ifdef WITH_OLD_DEMIME
329 { "demime_errorlevel", vtype_int, &demime_errorlevel },
330 { "demime_reason", vtype_stringptr, &demime_reason },
332 #ifdef EXPERIMENTAL_DOMAINKEYS
333 { "dk_domain", vtype_stringptr, &dk_signing_domain },
334 { "dk_is_signed", vtype_dk_verify, NULL },
335 { "dk_result", vtype_dk_verify, NULL },
336 { "dk_selector", vtype_stringptr, &dk_signing_selector },
337 { "dk_sender", vtype_dk_verify, NULL },
338 { "dk_sender_domain", vtype_dk_verify, NULL },
339 { "dk_sender_local_part",vtype_dk_verify, NULL },
340 { "dk_sender_source", vtype_dk_verify, NULL },
341 { "dk_signsall", vtype_dk_verify, NULL },
342 { "dk_status", vtype_dk_verify, NULL },
343 { "dk_testing", vtype_dk_verify, NULL },
345 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
346 { "dnslist_text", vtype_stringptr, &dnslist_text },
347 { "dnslist_value", vtype_stringptr, &dnslist_value },
348 { "domain", vtype_stringptr, &deliver_domain },
349 { "domain_data", vtype_stringptr, &deliver_domain_data },
350 { "exim_gid", vtype_gid, &exim_gid },
351 { "exim_path", vtype_stringptr, &exim_path },
352 { "exim_uid", vtype_uid, &exim_uid },
353 #ifdef WITH_OLD_DEMIME
354 { "found_extension", vtype_stringptr, &found_extension },
356 { "home", vtype_stringptr, &deliver_home },
357 { "host", vtype_stringptr, &deliver_host },
358 { "host_address", vtype_stringptr, &deliver_host_address },
359 { "host_data", vtype_stringptr, &host_data },
360 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
361 { "host_lookup_failed", vtype_int, &host_lookup_failed },
362 { "inode", vtype_ino, &deliver_inode },
363 { "interface_address", vtype_stringptr, &interface_address },
364 { "interface_port", vtype_int, &interface_port },
366 { "ldap_dn", vtype_stringptr, &eldap_dn },
368 { "load_average", vtype_load_avg, NULL },
369 { "local_part", vtype_stringptr, &deliver_localpart },
370 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
371 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
372 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
373 { "local_scan_data", vtype_stringptr, &local_scan_data },
374 { "local_user_gid", vtype_gid, &local_user_gid },
375 { "local_user_uid", vtype_uid, &local_user_uid },
376 { "localhost_number", vtype_int, &host_number },
377 { "log_inodes", vtype_pinodes, (void *)FALSE },
378 { "log_space", vtype_pspace, (void *)FALSE },
379 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
380 #ifdef WITH_CONTENT_SCAN
381 { "malware_name", vtype_stringptr, &malware_name },
383 { "message_age", vtype_int, &message_age },
384 { "message_body", vtype_msgbody, &message_body },
385 { "message_body_end", vtype_msgbody_end, &message_body_end },
386 { "message_body_size", vtype_int, &message_body_size },
387 { "message_exim_id", vtype_stringptr, &message_id },
388 { "message_headers", vtype_msgheaders, NULL },
389 { "message_headers_raw", vtype_msgheaders_raw, NULL },
390 { "message_id", vtype_stringptr, &message_id },
391 { "message_linecount", vtype_int, &message_linecount },
392 { "message_size", vtype_int, &message_size },
393 #ifdef WITH_CONTENT_SCAN
394 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
395 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
396 { "mime_boundary", vtype_stringptr, &mime_boundary },
397 { "mime_charset", vtype_stringptr, &mime_charset },
398 { "mime_content_description", vtype_stringptr, &mime_content_description },
399 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
400 { "mime_content_id", vtype_stringptr, &mime_content_id },
401 { "mime_content_size", vtype_int, &mime_content_size },
402 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
403 { "mime_content_type", vtype_stringptr, &mime_content_type },
404 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
405 { "mime_filename", vtype_stringptr, &mime_filename },
406 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
407 { "mime_is_multipart", vtype_int, &mime_is_multipart },
408 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
409 { "mime_part_count", vtype_int, &mime_part_count },
411 { "n0", vtype_filter_int, &filter_n[0] },
412 { "n1", vtype_filter_int, &filter_n[1] },
413 { "n2", vtype_filter_int, &filter_n[2] },
414 { "n3", vtype_filter_int, &filter_n[3] },
415 { "n4", vtype_filter_int, &filter_n[4] },
416 { "n5", vtype_filter_int, &filter_n[5] },
417 { "n6", vtype_filter_int, &filter_n[6] },
418 { "n7", vtype_filter_int, &filter_n[7] },
419 { "n8", vtype_filter_int, &filter_n[8] },
420 { "n9", vtype_filter_int, &filter_n[9] },
421 { "original_domain", vtype_stringptr, &deliver_domain_orig },
422 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
423 { "originator_gid", vtype_gid, &originator_gid },
424 { "originator_uid", vtype_uid, &originator_uid },
425 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
426 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
427 { "pid", vtype_pid, NULL },
428 { "primary_hostname", vtype_stringptr, &primary_hostname },
429 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
430 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
431 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
432 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
433 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
434 { "rcpt_count", vtype_int, &rcpt_count },
435 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
436 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
437 { "received_count", vtype_int, &received_count },
438 { "received_for", vtype_stringptr, &received_for },
439 { "received_protocol", vtype_stringptr, &received_protocol },
440 { "received_time", vtype_int, &received_time },
441 { "recipient_data", vtype_stringptr, &recipient_data },
442 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
443 { "recipients", vtype_recipients, NULL },
444 { "recipients_count", vtype_int, &recipients_count },
445 #ifdef WITH_CONTENT_SCAN
446 { "regex_match_string", vtype_stringptr, ®ex_match_string },
448 { "reply_address", vtype_reply, NULL },
449 { "return_path", vtype_stringptr, &return_path },
450 { "return_size_limit", vtype_int, &bounce_return_size_limit },
451 { "runrc", vtype_int, &runrc },
452 { "self_hostname", vtype_stringptr, &self_hostname },
453 { "sender_address", vtype_stringptr, &sender_address },
454 { "sender_address_data", vtype_stringptr, &sender_address_data },
455 { "sender_address_domain", vtype_domain, &sender_address },
456 { "sender_address_local_part", vtype_localpart, &sender_address },
457 { "sender_data", vtype_stringptr, &sender_data },
458 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
459 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
460 { "sender_host_address", vtype_stringptr, &sender_host_address },
461 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
462 { "sender_host_name", vtype_host_lookup, NULL },
463 { "sender_host_port", vtype_int, &sender_host_port },
464 { "sender_ident", vtype_stringptr, &sender_ident },
465 { "sender_rate", vtype_stringptr, &sender_rate },
466 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
467 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
468 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
469 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
470 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
471 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
472 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
473 { "sn0", vtype_filter_int, &filter_sn[0] },
474 { "sn1", vtype_filter_int, &filter_sn[1] },
475 { "sn2", vtype_filter_int, &filter_sn[2] },
476 { "sn3", vtype_filter_int, &filter_sn[3] },
477 { "sn4", vtype_filter_int, &filter_sn[4] },
478 { "sn5", vtype_filter_int, &filter_sn[5] },
479 { "sn6", vtype_filter_int, &filter_sn[6] },
480 { "sn7", vtype_filter_int, &filter_sn[7] },
481 { "sn8", vtype_filter_int, &filter_sn[8] },
482 { "sn9", vtype_filter_int, &filter_sn[9] },
483 #ifdef WITH_CONTENT_SCAN
484 { "spam_bar", vtype_stringptr, &spam_bar },
485 { "spam_report", vtype_stringptr, &spam_report },
486 { "spam_score", vtype_stringptr, &spam_score },
487 { "spam_score_int", vtype_stringptr, &spam_score_int },
489 #ifdef EXPERIMENTAL_SPF
490 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
491 { "spf_received", vtype_stringptr, &spf_received },
492 { "spf_result", vtype_stringptr, &spf_result },
493 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
495 { "spool_directory", vtype_stringptr, &spool_directory },
496 { "spool_inodes", vtype_pinodes, (void *)TRUE },
497 { "spool_space", vtype_pspace, (void *)TRUE },
498 #ifdef EXPERIMENTAL_SRS
499 { "srs_db_address", vtype_stringptr, &srs_db_address },
500 { "srs_db_key", vtype_stringptr, &srs_db_key },
501 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
502 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
503 { "srs_recipient", vtype_stringptr, &srs_recipient },
504 { "srs_status", vtype_stringptr, &srs_status },
506 { "thisaddress", vtype_stringptr, &filter_thisaddress },
507 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
508 { "tls_cipher", vtype_stringptr, &tls_cipher },
509 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
510 { "tod_bsdinbox", vtype_todbsdin, NULL },
511 { "tod_epoch", vtype_tode, NULL },
512 { "tod_full", vtype_todf, NULL },
513 { "tod_log", vtype_todl, NULL },
514 { "tod_logfile", vtype_todlf, NULL },
515 { "tod_zone", vtype_todzone, NULL },
516 { "tod_zulu", vtype_todzulu, NULL },
517 { "value", vtype_stringptr, &lookup_value },
518 { "version_number", vtype_stringptr, &version_string },
519 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
520 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
521 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
522 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
523 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
524 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
527 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
528 static uschar var_buffer[256];
529 static BOOL malformed_header;
531 /* For textual hashes */
533 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
534 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
537 enum { HMAC_MD5, HMAC_SHA1 };
539 /* For numeric hashes */
541 static unsigned int prime[] = {
542 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
543 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
544 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
546 /* For printing modes in symbolic form */
548 static uschar *mtable_normal[] =
549 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
551 static uschar *mtable_setid[] =
552 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
554 static uschar *mtable_sticky[] =
555 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
559 /*************************************************
560 * Tables for UTF-8 support *
561 *************************************************/
563 /* Table of the number of extra characters, indexed by the first character
564 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
567 static uschar utf8_table1[] = {
568 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
569 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
570 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
571 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
573 /* These are the masks for the data bits in the first byte of a character,
574 indexed by the number of additional bytes. */
576 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
578 /* Get the next UTF-8 character, advancing the pointer. */
580 #define GETUTF8INC(c, ptr) \
582 if ((c & 0xc0) == 0xc0) \
584 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
586 c = (c & utf8_table2[a]) << s; \
590 c |= (*ptr++ & 0x3f) << s; \
595 /*************************************************
596 * Binary chop search on a table *
597 *************************************************/
599 /* This is used for matching expansion items and operators.
602 name the name that is being sought
603 table the table to search
604 table_size the number of items in the table
606 Returns: the offset in the table, or -1
610 chop_match(uschar *name, uschar **table, int table_size)
612 uschar **bot = table;
613 uschar **top = table + table_size;
617 uschar **mid = bot + (top - bot)/2;
618 int c = Ustrcmp(name, *mid);
619 if (c == 0) return mid - table;
620 if (c > 0) bot = mid + 1; else top = mid;
628 /*************************************************
629 * Check a condition string *
630 *************************************************/
632 /* This function is called to expand a string, and test the result for a "true"
633 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
634 forced fail or lookup defer. All store used by the function can be released on
638 condition the condition string
639 m1 text to be incorporated in panic error
642 Returns: TRUE if condition is met, FALSE if not
646 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
649 void *reset_point = store_get(0);
650 uschar *ss = expand_string(condition);
653 if (!expand_string_forcedfail && !search_find_defer)
654 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
655 "for %s %s: %s", condition, m1, m2, expand_string_message);
658 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
659 strcmpic(ss, US"false") != 0;
660 store_reset(reset_point);
666 /*************************************************
667 * Pick out a name from a string *
668 *************************************************/
670 /* If the name is too long, it is silently truncated.
673 name points to a buffer into which to put the name
674 max is the length of the buffer
675 s points to the first alphabetic character of the name
676 extras chars other than alphanumerics to permit
678 Returns: pointer to the first character after the name
680 Note: The test for *s != 0 in the while loop is necessary because
681 Ustrchr() yields non-NULL if the character is zero (which is not something
685 read_name(uschar *name, int max, uschar *s, uschar *extras)
688 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
690 if (ptr < max-1) name[ptr++] = *s;
699 /*************************************************
700 * Pick out the rest of a header name *
701 *************************************************/
703 /* A variable name starting $header_ (or just $h_ for those who like
704 abbreviations) might not be the complete header name because headers can
705 contain any printing characters in their names, except ':'. This function is
706 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
707 on the end, if the name was terminated by white space.
710 name points to a buffer in which the name read so far exists
711 max is the length of the buffer
712 s points to the first character after the name so far, i.e. the
713 first non-alphameric character after $header_xxxxx
715 Returns: a pointer to the first character after the header name
719 read_header_name(uschar *name, int max, uschar *s)
721 int prelen = Ustrchr(name, '_') - name + 1;
722 int ptr = Ustrlen(name) - prelen;
723 if (ptr > 0) memmove(name, name+prelen, ptr);
724 while (mac_isgraph(*s) && *s != ':')
726 if (ptr < max-1) name[ptr++] = *s;
737 /*************************************************
738 * Pick out a number from a string *
739 *************************************************/
742 n points to an integer into which to put the number
743 s points to the first digit of the number
745 Returns: a pointer to the character after the last digit
749 read_number(int *n, uschar *s)
752 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
758 /*************************************************
759 * Extract keyed subfield from a string *
760 *************************************************/
762 /* The yield is in dynamic store; NULL means that the key was not found.
765 key points to the name of the key
766 s points to the string from which to extract the subfield
768 Returns: NULL if the subfield was not found, or
769 a pointer to the subfield's data
773 expand_getkeyed(uschar *key, uschar *s)
775 int length = Ustrlen(key);
776 while (isspace(*s)) s++;
778 /* Loop to search for the key */
786 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
787 dkeylength = s - dkey;
788 while (isspace(*s)) s++;
789 if (*s == '=') while (isspace((*(++s))));
791 data = string_dequote(&s);
792 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
795 while (isspace(*s)) s++;
804 /*************************************************
805 * Extract numbered subfield from string *
806 *************************************************/
808 /* Extracts a numbered field from a string that is divided by tokens - for
809 example a line from /etc/passwd is divided by colon characters. First field is
810 numbered one. Negative arguments count from the right. Zero returns the whole
811 string. Returns NULL if there are insufficient tokens in the string
814 Modifies final argument - this is a dynamically generated string, so that's OK.
817 field number of field to be extracted,
818 first field = 1, whole string = 0, last field = -1
819 separators characters that are used to break string into tokens
820 s points to the string from which to extract the subfield
822 Returns: NULL if the field was not found,
823 a pointer to the field's data inside s (modified to add 0)
827 expand_gettokened (int field, uschar *separators, uschar *s)
832 uschar *fieldtext = NULL;
834 if (field == 0) return s;
836 /* Break the line up into fields in place; for field > 0 we stop when we have
837 done the number of fields we want. For field < 0 we continue till the end of
838 the string, counting the number of fields. */
840 count = (field > 0)? field : INT_MAX;
846 /* Previous field was the last one in the string. For a positive field
847 number, this means there are not enough fields. For a negative field number,
848 check that there are enough, and scan back to find the one that is wanted. */
852 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
853 if ((-field) == (INT_MAX - count - 1)) return s;
857 while (ss[-1] != 0) ss--;
863 /* Previous field was not last in the string; save its start and put a
867 len = Ustrcspn(ss, separators);
878 /*************************************************
879 * Extract a substring from a string *
880 *************************************************/
882 /* Perform the ${substr or ${length expansion operations.
885 subject the input string
886 value1 the offset from the start of the input string to the start of
887 the output string; if negative, count from the right.
888 value2 the length of the output string, or negative (-1) for unset
889 if value1 is positive, unset means "all after"
890 if value1 is negative, unset means "all before"
891 len set to the length of the returned string
893 Returns: pointer to the output string, or NULL if there is an error
897 extract_substr(uschar *subject, int value1, int value2, int *len)
899 int sublen = Ustrlen(subject);
901 if (value1 < 0) /* count from right */
905 /* If the position is before the start, skip to the start, and adjust the
906 length. If the length ends up negative, the substring is null because nothing
907 can precede. This falls out naturally when the length is unset, meaning "all
913 if (value2 < 0) value2 = 0;
917 /* Otherwise an unset length => characters before value1 */
926 /* For a non-negative offset, if the starting position is past the end of the
927 string, the result will be the null string. Otherwise, an unset length means
928 "rest"; just set it to the maximum - it will be cut down below if necessary. */
937 else if (value2 < 0) value2 = sublen;
940 /* Cut the length down to the maximum possible for the offset value, and get
941 the required characters. */
943 if (value1 + value2 > sublen) value2 = sublen - value1;
945 return subject + value1;
951 /*************************************************
952 * Old-style hash of a string *
953 *************************************************/
955 /* Perform the ${hash expansion operation.
958 subject the input string (an expanded substring)
959 value1 the length of the output string; if greater or equal to the
960 length of the input string, the input string is returned
961 value2 the number of hash characters to use, or 26 if negative
962 len set to the length of the returned string
964 Returns: pointer to the output string, or NULL if there is an error
968 compute_hash(uschar *subject, int value1, int value2, int *len)
970 int sublen = Ustrlen(subject);
972 if (value2 < 0) value2 = 26;
973 else if (value2 > Ustrlen(hashcodes))
975 expand_string_message =
976 string_sprintf("hash count \"%d\" too big", value2);
980 /* Calculate the hash text. We know it is shorter than the original string, so
981 can safely place it in subject[] (we know that subject is always itself an
982 expanded substring). */
989 while ((c = (subject[j])) != 0)
991 int shift = (c + j++) & 7;
992 subject[i] ^= (c << shift) | (c >> (8-shift));
993 if (++i >= value1) i = 0;
995 for (i = 0; i < value1; i++)
996 subject[i] = hashcodes[(subject[i]) % value2];
998 else value1 = sublen;
1007 /*************************************************
1008 * Numeric hash of a string *
1009 *************************************************/
1011 /* Perform the ${nhash expansion operation. The first characters of the
1012 string are treated as most important, and get the highest prime numbers.
1015 subject the input string
1016 value1 the maximum value of the first part of the result
1017 value2 the maximum value of the second part of the result,
1018 or negative to produce only a one-part result
1019 len set to the length of the returned string
1021 Returns: pointer to the output string, or NULL if there is an error.
1025 compute_nhash (uschar *subject, int value1, int value2, int *len)
1027 uschar *s = subject;
1029 unsigned long int total = 0; /* no overflow */
1033 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1034 total += prime[i--] * (unsigned int)(*s++);
1037 /* If value2 is unset, just compute one number */
1041 s = string_sprintf("%d", total % value1);
1044 /* Otherwise do a div/mod hash */
1048 total = total % (value1 * value2);
1049 s = string_sprintf("%d/%d", total/value2, total % value2);
1060 /*************************************************
1061 * Find the value of a header or headers *
1062 *************************************************/
1064 /* Multiple instances of the same header get concatenated, and this function
1065 can also return a concatenation of all the header lines. When concatenating
1066 specific headers that contain lists of addresses, a comma is inserted between
1067 them. Otherwise we use a straight concatenation. Because some messages can have
1068 pathologically large number of lines, there is a limit on the length that is
1069 returned. Also, to avoid massive store use which would result from using
1070 string_cat() as it copies and extends strings, we do a preliminary pass to find
1071 out exactly how much store will be needed. On "normal" messages this will be
1075 name the name of the header, without the leading $header_ or $h_,
1076 or NULL if a concatenation of all headers is required
1077 exists_only TRUE if called from a def: test; don't need to build a string;
1078 just return a string that is not "" and not "0" if the header
1080 newsize return the size of memory block that was obtained; may be NULL
1081 if exists_only is TRUE
1082 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1083 other than concatenating, will be done on the header. Also used
1084 for $message_headers_raw.
1085 charset name of charset to translate MIME words to; used only if
1086 want_raw is false; if NULL, no translation is done (this is
1087 used for $bh_ and $bheader_)
1089 Returns: NULL if the header does not exist, else a pointer to a new
1094 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1097 BOOL found = name == NULL;
1099 int len = found? 0 : Ustrlen(name);
1101 uschar *yield = NULL;
1104 /* Loop for two passes - saves code repetition */
1106 for (i = 0; i < 2; i++)
1111 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1113 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1115 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1120 if (exists_only) return US"1"; /* don't need actual string */
1122 t = h->text + len; /* text to insert */
1123 if (!want_raw) /* unless wanted raw, */
1124 while (isspace(*t)) t++; /* remove leading white space */
1125 ilen = h->slen - (t - h->text); /* length to insert */
1127 /* Unless wanted raw, remove trailing whitespace, including the
1131 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1133 /* Set comma = 1 if handling a single header and it's one of those
1134 that contains an address list, except when asked for raw headers. Only
1135 need to do this once. */
1137 if (!want_raw && name != NULL && comma == 0 &&
1138 Ustrchr("BCFRST", h->type) != NULL)
1141 /* First pass - compute total store needed; second pass - compute
1142 total store used, including this header. */
1144 size += ilen + comma + 1; /* +1 for the newline */
1146 /* Second pass - concatentate the data, up to a maximum. Note that
1147 the loop stops when size hits the limit. */
1151 if (size > header_insert_maxlen)
1153 ilen -= size - header_insert_maxlen - 1;
1156 Ustrncpy(ptr, t, ilen);
1159 /* For a non-raw header, put in the comma if needed, then add
1160 back the newline we removed above, provided there was some text in
1163 if (!want_raw && ilen > 0)
1165 if (comma != 0) *ptr++ = ',';
1173 /* At end of first pass, return NULL if no header found. Then truncate size
1174 if necessary, and get the buffer to hold the data, returning the buffer size.
1179 if (!found) return NULL;
1180 if (size > header_insert_maxlen) size = header_insert_maxlen;
1181 *newsize = size + 1;
1182 ptr = yield = store_get(*newsize);
1186 /* That's all we do for raw header expansion. */
1193 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1194 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1195 function can return an error with decoded data if the charset translation
1196 fails. If decoding fails, it returns NULL. */
1200 uschar *decoded, *error;
1201 if (ptr > yield && ptr[-1] == '\n') ptr--;
1202 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1204 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1208 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1209 " input was: %s\n", error, yield);
1211 if (decoded != NULL) yield = decoded;
1220 /*************************************************
1221 * Find value of a variable *
1222 *************************************************/
1224 /* The table of variables is kept in alphabetic order, so we can search it
1225 using a binary chop. The "choplen" variable is nothing to do with the binary
1229 name the name of the variable being sought
1230 exists_only TRUE if this is a def: test; passed on to find_header()
1231 skipping TRUE => skip any processing evaluation; this is not the same as
1232 exists_only because def: may test for values that are first
1234 newsize pointer to an int which is initially zero; if the answer is in
1235 a new memory buffer, *newsize is set to its size
1237 Returns: NULL if the variable does not exist, or
1238 a pointer to the variable's contents, or
1239 something non-NULL if exists_only is TRUE
1243 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1246 int last = var_table_size;
1248 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1249 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1250 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1251 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1252 (this gave backwards compatibility at the changeover). There may be built-in
1253 variables whose names start acl_ but they should never start in this way. This
1254 slightly messy specification is a consequence of the history, needless to say.
1256 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1257 set, in which case give an error. */
1259 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1263 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1264 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1267 /* Handle $auth<n> variables. */
1269 if (Ustrncmp(name, "auth", 4) == 0)
1272 int n = Ustrtoul(name + 4, &endptr, 10);
1273 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1274 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1277 /* For all other variables, search the table */
1279 while (last > first)
1283 int middle = (first + last)/2;
1284 int c = Ustrcmp(name, var_table[middle].name);
1286 if (c > 0) { first = middle + 1; continue; }
1287 if (c < 0) { last = middle; continue; }
1289 /* Found an existing variable. If in skipping state, the value isn't needed,
1290 and we want to avoid processing (such as looking up the host name). */
1292 if (skipping) return US"";
1294 switch (var_table[middle].type)
1296 #ifdef EXPERIMENTAL_DOMAINKEYS
1298 case vtype_dk_verify:
1299 if (dk_verify_block == NULL) return US"";
1301 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1302 s = dk_verify_block->result_string;
1303 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1304 s = dk_verify_block->address;
1305 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1306 s = dk_verify_block->domain;
1307 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1308 s = dk_verify_block->local_part;
1310 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1311 switch(dk_verify_block->address_source) {
1312 case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1313 case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1314 case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1317 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1318 switch(dk_verify_block->result) {
1319 case DK_EXIM_RESULT_ERR: s = US"error"; break;
1320 case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1321 case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1322 case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1323 case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1324 case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1325 case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1326 case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1329 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1330 s = (dk_verify_block->signsall)? US"1" : US"0";
1332 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1333 s = (dk_verify_block->testing)? US"1" : US"0";
1335 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1336 s = (dk_verify_block->is_signed)? US"1" : US"0";
1338 return (s == NULL)? US"" : s;
1341 case vtype_filter_int:
1342 if (!filter_running) return NULL;
1346 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1350 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1354 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1358 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1361 case vtype_stringptr: /* Pointer to string */
1362 s = *((uschar **)(var_table[middle].value));
1363 return (s == NULL)? US"" : s;
1366 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1369 case vtype_load_avg:
1370 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1373 case vtype_host_lookup: /* Lookup if not done so */
1374 if (sender_host_name == NULL && sender_host_address != NULL &&
1375 !host_lookup_failed && host_name_lookup() == OK)
1376 host_build_sender_fullhost();
1377 return (sender_host_name == NULL)? US"" : sender_host_name;
1379 case vtype_localpart: /* Get local part from address */
1380 s = *((uschar **)(var_table[middle].value));
1381 if (s == NULL) return US"";
1382 domain = Ustrrchr(s, '@');
1383 if (domain == NULL) return s;
1384 if (domain - s > sizeof(var_buffer) - 1)
1385 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1386 "string expansion", sizeof(var_buffer));
1387 Ustrncpy(var_buffer, s, domain - s);
1388 var_buffer[domain - s] = 0;
1391 case vtype_domain: /* Get domain from address */
1392 s = *((uschar **)(var_table[middle].value));
1393 if (s == NULL) return US"";
1394 domain = Ustrrchr(s, '@');
1395 return (domain == NULL)? US"" : domain + 1;
1397 case vtype_msgheaders:
1398 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1400 case vtype_msgheaders_raw:
1401 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1403 case vtype_msgbody: /* Pointer to msgbody string */
1404 case vtype_msgbody_end: /* Ditto, the end of the msg */
1405 ss = (uschar **)(var_table[middle].value);
1406 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1409 off_t start_offset = SPOOL_DATA_START_OFFSET;
1410 int len = message_body_visible;
1411 if (len > message_size) len = message_size;
1412 *ss = body = store_malloc(len+1);
1414 if (var_table[middle].type == vtype_msgbody_end)
1416 struct stat statbuf;
1417 if (fstat(deliver_datafile, &statbuf) == 0)
1419 start_offset = statbuf.st_size - len;
1420 if (start_offset < SPOOL_DATA_START_OFFSET)
1421 start_offset = SPOOL_DATA_START_OFFSET;
1424 lseek(deliver_datafile, start_offset, SEEK_SET);
1425 len = read(deliver_datafile, body, len);
1431 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1435 return (*ss == NULL)? US"" : *ss;
1437 case vtype_todbsdin: /* BSD inbox time of day */
1438 return tod_stamp(tod_bsdin);
1440 case vtype_tode: /* Unix epoch time of day */
1441 return tod_stamp(tod_epoch);
1443 case vtype_todf: /* Full time of day */
1444 return tod_stamp(tod_full);
1446 case vtype_todl: /* Log format time of day */
1447 return tod_stamp(tod_log_bare); /* (without timezone) */
1449 case vtype_todzone: /* Time zone offset only */
1450 return tod_stamp(tod_zone);
1452 case vtype_todzulu: /* Zulu time */
1453 return tod_stamp(tod_zulu);
1455 case vtype_todlf: /* Log file datestamp tod */
1456 return tod_stamp(tod_log_datestamp);
1458 case vtype_reply: /* Get reply address */
1459 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1461 if (s != NULL) while (isspace(*s)) s++;
1462 if (s == NULL || *s == 0)
1464 *newsize = 0; /* For the *s==0 case */
1465 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1470 while (isspace(*s)) s++;
1471 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1472 while (t > s && isspace(t[-1])) t--;
1475 return (s == NULL)? US"" : s;
1477 /* A recipients list is available only during system message filtering,
1478 during ACL processing after DATA, and while expanding pipe commands
1479 generated from a system filter, but not elsewhere. */
1481 case vtype_recipients:
1482 if (!enable_dollar_recipients) return NULL; else
1487 s = store_get(size);
1488 for (i = 0; i < recipients_count; i++)
1490 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1491 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1492 Ustrlen(recipients_list[i].address));
1494 s[ptr] = 0; /* string_cat() leaves room */
1501 sprintf(CS var_buffer, "%d",
1502 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1509 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1510 sprintf(CS var_buffer, "%d", inodes);
1516 return NULL; /* Unknown variable name */
1522 /*************************************************
1523 * Read and expand substrings *
1524 *************************************************/
1526 /* This function is called to read and expand argument substrings for various
1527 expansion items. Some have a minimum requirement that is less than the maximum;
1528 in these cases, the first non-present one is set to NULL.
1531 sub points to vector of pointers to set
1532 n maximum number of substrings
1534 sptr points to current string pointer
1535 skipping the skipping flag
1536 check_end if TRUE, check for final '}'
1537 name name of item, for error message
1539 Returns: 0 OK; string pointer updated
1540 1 curly bracketing error (too few arguments)
1541 2 too many arguments (only if check_end is set); message set
1542 3 other error (expansion failure)
1546 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1547 BOOL check_end, uschar *name)
1552 while (isspace(*s)) s++;
1553 for (i = 0; i < n; i++)
1557 if (i < m) return 1;
1561 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1562 if (sub[i] == NULL) return 3;
1563 if (*s++ != '}') return 1;
1564 while (isspace(*s)) s++;
1566 if (check_end && *s++ != '}')
1570 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1571 "(max is %d)", name, n);
1584 /*************************************************
1585 * Elaborate message for bad variable *
1586 *************************************************/
1588 /* For the "unknown variable" message, take a look at the variable's name, and
1589 give additional information about possible ACL variables. The extra information
1590 is added on to expand_string_message.
1592 Argument: the name of the variable
1597 check_variable_error_message(uschar *name)
1599 if (Ustrncmp(name, "acl_", 4) == 0)
1600 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1601 (name[4] == 'c' || name[4] == 'm')?
1603 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1604 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1606 US"user-defined ACL variables must start acl_c or acl_m");
1611 /*************************************************
1612 * Read and evaluate a condition *
1613 *************************************************/
1617 s points to the start of the condition text
1618 yield points to a BOOL to hold the result of the condition test;
1619 if NULL, we are just reading through a condition that is
1620 part of an "or" combination to check syntax, or in a state
1621 where the answer isn't required
1623 Returns: a pointer to the first character after the condition, or
1628 eval_condition(uschar *s, BOOL *yield)
1630 BOOL testfor = TRUE;
1631 BOOL tempcond, combined_cond;
1633 int i, rc, cond_type, roffset;
1635 struct stat statbuf;
1640 const uschar *rerror;
1644 while (isspace(*s)) s++;
1645 if (*s == '!') { testfor = !testfor; s++; } else break;
1648 /* Numeric comparisons are symbolic */
1650 if (*s == '=' || *s == '>' || *s == '<')
1662 /* All other conditions are named */
1664 else s = read_name(name, 256, s, US"_");
1666 /* If we haven't read a name, it means some non-alpha character is first. */
1670 expand_string_message = string_sprintf("condition name expected, "
1671 "but found \"%.16s\"", s);
1675 /* Find which condition we are dealing with, and switch on it */
1677 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1680 /* def: tests for a non-empty variable, or for the existence of a header. If
1681 yield == NULL we are in a skipping state, and don't care about the answer. */
1686 expand_string_message = US"\":\" expected after \"def\"";
1690 s = read_name(name, 256, s+1, US"_");
1692 /* Test for a header's existence. If the name contains a closing brace
1693 character, this may be a user error where the terminating colon has been
1694 omitted. Set a flag to adjust a subsequent error message in this case. */
1696 if (Ustrncmp(name, "h_", 2) == 0 ||
1697 Ustrncmp(name, "rh_", 3) == 0 ||
1698 Ustrncmp(name, "bh_", 3) == 0 ||
1699 Ustrncmp(name, "header_", 7) == 0 ||
1700 Ustrncmp(name, "rheader_", 8) == 0 ||
1701 Ustrncmp(name, "bheader_", 8) == 0)
1703 s = read_header_name(name, 256, s);
1704 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
1705 if (yield != NULL) *yield =
1706 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1709 /* Test for a variable's having a non-empty value. A non-existent variable
1710 causes an expansion failure. */
1714 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1717 expand_string_message = (name[0] == 0)?
1718 string_sprintf("variable name omitted after \"def:\"") :
1719 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1720 check_variable_error_message(name);
1723 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1729 /* first_delivery tests for first delivery attempt */
1731 case ECOND_FIRST_DELIVERY:
1732 if (yield != NULL) *yield = deliver_firsttime == testfor;
1736 /* queue_running tests for any process started by a queue runner */
1738 case ECOND_QUEUE_RUNNING:
1739 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1743 /* exists: tests for file existence
1744 isip: tests for any IP address
1745 isip4: tests for an IPv4 address
1746 isip6: tests for an IPv6 address
1747 pam: does PAM authentication
1748 radius: does RADIUS authentication
1749 ldapauth: does LDAP authentication
1750 pwcheck: does Cyrus SASL pwcheck authentication
1759 case ECOND_LDAPAUTH:
1762 while (isspace(*s)) s++;
1763 if (*s != '{') goto COND_FAILED_CURLY_START;
1765 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1766 if (sub[0] == NULL) return NULL;
1767 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1769 if (yield == NULL) return s; /* No need to run the test if skipping */
1774 if ((expand_forbid & RDO_EXISTS) != 0)
1776 expand_string_message = US"File existence tests are not permitted";
1779 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1785 rc = string_is_ip_address(sub[0], NULL);
1786 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1787 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1790 /* Various authentication tests - all optionally compiled */
1794 rc = auth_call_pam(sub[0], &expand_string_message);
1797 goto COND_FAILED_NOT_COMPILED;
1798 #endif /* SUPPORT_PAM */
1801 #ifdef RADIUS_CONFIG_FILE
1802 rc = auth_call_radius(sub[0], &expand_string_message);
1805 goto COND_FAILED_NOT_COMPILED;
1806 #endif /* RADIUS_CONFIG_FILE */
1808 case ECOND_LDAPAUTH:
1811 /* Just to keep the interface the same */
1813 int old_pool = store_pool;
1814 store_pool = POOL_SEARCH;
1815 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1816 &expand_string_message, &do_cache);
1817 store_pool = old_pool;
1821 goto COND_FAILED_NOT_COMPILED;
1822 #endif /* LOOKUP_LDAP */
1825 #ifdef CYRUS_PWCHECK_SOCKET
1826 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1829 goto COND_FAILED_NOT_COMPILED;
1830 #endif /* CYRUS_PWCHECK_SOCKET */
1832 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1833 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1835 if (rc == ERROR || rc == DEFER) return NULL;
1836 *yield = (rc == OK) == testfor;
1842 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1844 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1846 However, the last two are optional. That is why the whole set is enclosed
1847 in their own set or braces. */
1849 case ECOND_SASLAUTHD:
1850 #ifndef CYRUS_SASLAUTHD_SOCKET
1851 goto COND_FAILED_NOT_COMPILED;
1853 while (isspace(*s)) s++;
1854 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1855 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1857 case 1: expand_string_message = US"too few arguments or bracketing "
1858 "error for saslauthd";
1860 case 3: return NULL;
1862 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1866 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1867 &expand_string_message);
1868 if (rc == ERROR || rc == DEFER) return NULL;
1869 *yield = (rc == OK) == testfor;
1872 #endif /* CYRUS_SASLAUTHD_SOCKET */
1875 /* symbolic operators for numeric and string comparison, and a number of
1876 other operators, all requiring two arguments.
1878 match: does a regular expression match and sets up the numerical
1879 variables if it succeeds
1880 match_address: matches in an address list
1881 match_domain: matches in a domain list
1882 match_ip: matches a host list that is restricted to IP addresses
1883 match_local_part: matches in a local part list
1884 crypteq: encrypts plaintext and compares against an encrypted text,
1885 using crypt(), crypt16(), MD5 or SHA-1
1889 case ECOND_MATCH_ADDRESS:
1890 case ECOND_MATCH_DOMAIN:
1891 case ECOND_MATCH_IP:
1892 case ECOND_MATCH_LOCAL_PART:
1895 case ECOND_NUM_L: /* Numerical comparisons */
1902 case ECOND_STR_LT: /* String comparisons */
1913 for (i = 0; i < 2; i++)
1915 while (isspace(*s)) s++;
1918 if (i == 0) goto COND_FAILED_CURLY_START;
1919 expand_string_message = string_sprintf("missing 2nd string in {} "
1920 "after \"%s\"", name);
1923 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1924 if (sub[i] == NULL) return NULL;
1925 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1927 /* Convert to numerical if required; we know that the names of all the
1928 conditions that compare numbers do not start with a letter. This just saves
1929 checking for them individually. */
1931 if (!isalpha(name[0]))
1933 num[i] = expand_string_integer(sub[i], FALSE);
1934 if (expand_string_message != NULL) return NULL;
1938 /* Result not required */
1940 if (yield == NULL) return s;
1942 /* Do an appropriate comparison */
1948 *yield = (num[0] == num[1]) == testfor;
1952 *yield = (num[0] > num[1]) == testfor;
1956 *yield = (num[0] >= num[1]) == testfor;
1960 *yield = (num[0] < num[1]) == testfor;
1964 *yield = (num[0] <= num[1]) == testfor;
1968 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1972 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1976 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1980 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1984 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1988 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1992 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1996 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
2000 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2004 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2007 case ECOND_MATCH: /* Regular expression match */
2008 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2012 expand_string_message = string_sprintf("regular expression error in "
2013 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2016 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2019 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2020 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2021 goto MATCHED_SOMETHING;
2023 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2024 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2025 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2026 goto MATCHED_SOMETHING;
2028 case ECOND_MATCH_IP: /* Match IP address in a host list */
2029 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2031 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2037 unsigned int *nullcache = NULL;
2038 check_host_block cb;
2040 cb.host_name = US"";
2041 cb.host_address = sub[0];
2043 /* If the host address starts off ::ffff: it is an IPv6 address in
2044 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2047 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2048 cb.host_address + 7 : cb.host_address;
2050 rc = match_check_list(
2051 &sub[1], /* the list */
2052 0, /* separator character */
2053 &hostlist_anchor, /* anchor pointer */
2054 &nullcache, /* cache pointer */
2055 check_host, /* function for testing */
2056 &cb, /* argument for function */
2057 MCL_HOST, /* type of check */
2058 sub[0], /* text for debugging */
2059 NULL); /* where to pass back data */
2061 goto MATCHED_SOMETHING;
2063 case ECOND_MATCH_LOCAL_PART:
2064 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2065 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2080 expand_string_message = string_sprintf("unable to complete match "
2081 "against \"%s\": %s", sub[1], search_error_message);
2087 /* Various "encrypted" comparisons. If the second string starts with
2088 "{" then an encryption type is given. Default to crypt() or crypt16()
2089 (build-time choice). */
2092 #ifndef SUPPORT_CRYPTEQ
2093 goto COND_FAILED_NOT_COMPILED;
2095 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2097 int sublen = Ustrlen(sub[1]+5);
2102 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2104 /* If the length that we are comparing against is 24, the MD5 digest
2105 is expressed as a base64 string. This is the way LDAP does it. However,
2106 some other software uses a straightforward hex representation. We assume
2107 this if the length is 32. Other lengths fail. */
2111 uschar *coded = auth_b64encode((uschar *)digest, 16);
2112 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2113 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2114 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2116 else if (sublen == 32)
2120 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2122 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2123 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2124 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2128 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2129 "fail\n crypted=%s\n", sub[1]+5);
2134 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2136 int sublen = Ustrlen(sub[1]+6);
2141 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2143 /* If the length that we are comparing against is 28, assume the SHA1
2144 digest is expressed as a base64 string. If the length is 40, assume a
2145 straightforward hex representation. Other lengths fail. */
2149 uschar *coded = auth_b64encode((uschar *)digest, 20);
2150 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2151 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2152 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2154 else if (sublen == 40)
2158 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2160 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2161 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2162 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2166 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2167 "fail\n crypted=%s\n", sub[1]+6);
2172 else /* {crypt} or {crypt16} and non-{ at start */
2177 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2182 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2187 else if (sub[1][0] == '{')
2189 expand_string_message = string_sprintf("unknown encryption mechanism "
2190 "in \"%s\"", sub[1]);
2196 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2197 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2198 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2202 #define XSTR(s) STR(s)
2203 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2204 " subject=%s\n crypted=%s\n",
2205 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2210 /* If the encrypted string contains fewer than two characters (for the
2211 salt), force failure. Otherwise we get false positives: with an empty
2212 string the yield of crypt() is an empty string! */
2214 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2215 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2218 #endif /* SUPPORT_CRYPTEQ */
2219 } /* Switch for comparison conditions */
2221 return s; /* End of comparison conditions */
2224 /* and/or: computes logical and/or of several conditions */
2228 subcondptr = (yield == NULL)? NULL : &tempcond;
2229 combined_cond = (cond_type == ECOND_AND);
2231 while (isspace(*s)) s++;
2232 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2236 while (isspace(*s)) s++;
2237 if (*s == '}') break;
2240 expand_string_message = string_sprintf("each subcondition "
2241 "inside an \"%s{...}\" condition must be in its own {}", name);
2245 s = eval_condition(s+1, subcondptr);
2248 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2249 expand_string_message, name);
2252 while (isspace(*s)) s++;
2256 expand_string_message = string_sprintf("missing } at end of condition "
2257 "inside \"%s\" group", name);
2263 if (cond_type == ECOND_AND)
2265 combined_cond &= tempcond;
2266 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2267 } /* evaluate any more */
2270 combined_cond |= tempcond;
2271 if (combined_cond) subcondptr = NULL; /* once true, don't */
2272 } /* evaluate any more */
2276 if (yield != NULL) *yield = (combined_cond == testfor);
2280 /* Unknown condition */
2283 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2285 } /* End switch on condition type */
2287 /* Missing braces at start and end of data */
2289 COND_FAILED_CURLY_START:
2290 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2293 COND_FAILED_CURLY_END:
2294 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2298 /* A condition requires code that is not compiled */
2300 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2301 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2302 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2303 COND_FAILED_NOT_COMPILED:
2304 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2313 /*************************************************
2314 * Save numerical variables *
2315 *************************************************/
2317 /* This function is called from items such as "if" that want to preserve and
2318 restore the numbered variables.
2321 save_expand_string points to an array of pointers to set
2322 save_expand_nlength points to an array of ints for the lengths
2324 Returns: the value of expand max to save
2328 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2331 for (i = 0; i <= expand_nmax; i++)
2333 save_expand_nstring[i] = expand_nstring[i];
2334 save_expand_nlength[i] = expand_nlength[i];
2341 /*************************************************
2342 * Restore numerical variables *
2343 *************************************************/
2345 /* This function restored saved values of numerical strings.
2348 save_expand_nmax the number of strings to restore
2349 save_expand_string points to an array of pointers
2350 save_expand_nlength points to an array of ints
2356 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2357 int *save_expand_nlength)
2360 expand_nmax = save_expand_nmax;
2361 for (i = 0; i <= expand_nmax; i++)
2363 expand_nstring[i] = save_expand_nstring[i];
2364 expand_nlength[i] = save_expand_nlength[i];
2372 /*************************************************
2373 * Handle yes/no substrings *
2374 *************************************************/
2376 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2377 alternative substrings that depend on whether or not the condition was true,
2378 or the lookup or extraction succeeded. The substrings always have to be
2379 expanded, to check their syntax, but "skipping" is set when the result is not
2380 needed - this avoids unnecessary nested lookups.
2383 skipping TRUE if we were skipping when this item was reached
2384 yes TRUE if the first string is to be used, else use the second
2385 save_lookup a value to put back into lookup_value before the 2nd expansion
2386 sptr points to the input string pointer
2387 yieldptr points to the output string pointer
2388 sizeptr points to the output string size
2389 ptrptr points to the output string pointer
2390 type "lookup" or "if" or "extract" or "run", for error message
2392 Returns: 0 OK; lookup_value has been reset to save_lookup
2394 2 expansion failed because of bracketing error
2398 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2399 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2402 uschar *s = *sptr; /* Local value */
2403 uschar *sub1, *sub2;
2405 /* If there are no following strings, we substitute the contents of $value for
2406 lookups and for extractions in the success case. For the ${if item, the string
2407 "true" is substituted. In the fail case, nothing is substituted for all three
2410 while (isspace(*s)) s++;
2415 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2419 if (yes && lookup_value != NULL)
2420 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2421 Ustrlen(lookup_value));
2422 lookup_value = save_lookup;
2428 /* The first following string must be braced. */
2430 if (*s++ != '{') goto FAILED_CURLY;
2432 /* Expand the first substring. Forced failures are noticed only if we actually
2433 want this string. Set skipping in the call in the fail case (this will always
2434 be the case if we were already skipping). */
2436 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2437 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2438 expand_string_forcedfail = FALSE;
2439 if (*s++ != '}') goto FAILED_CURLY;
2441 /* If we want the first string, add it to the output */
2444 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2446 /* If this is called from a lookup or an extract, we want to restore $value to
2447 what it was at the start of the item, so that it has this value during the
2448 second string expansion. For the call from "if" or "run" to this function,
2449 save_lookup is set to lookup_value, so that this statement does nothing. */
2451 lookup_value = save_lookup;
2453 /* There now follows either another substring, or "fail", or nothing. This
2454 time, forced failures are noticed only if we want the second string. We must
2455 set skipping in the nested call if we don't want this string, or if we were
2456 already skipping. */
2458 while (isspace(*s)) s++;
2461 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2462 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2463 expand_string_forcedfail = FALSE;
2464 if (*s++ != '}') goto FAILED_CURLY;
2466 /* If we want the second string, add it to the output */
2469 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2472 /* If there is no second string, but the word "fail" is present when the use of
2473 the second string is wanted, set a flag indicating it was a forced failure
2474 rather than a syntactic error. Swallow the terminating } in case this is nested
2475 inside another lookup or if or extract. */
2480 s = read_name(name, sizeof(name), s, US"_");
2481 if (Ustrcmp(name, "fail") == 0)
2483 if (!yes && !skipping)
2485 while (isspace(*s)) s++;
2486 if (*s++ != '}') goto FAILED_CURLY;
2487 expand_string_message =
2488 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2489 expand_string_forcedfail = TRUE;
2495 expand_string_message =
2496 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2501 /* All we have to do now is to check on the final closing brace. */
2503 while (isspace(*s)) s++;
2504 if (*s++ == '}') goto RETURN;
2506 /* Get here if there is a bracketing failure */
2511 /* Get here for other failures */
2516 /* Update the input pointer value before returning */
2526 /*************************************************
2527 * Handle MD5 or SHA-1 computation for HMAC *
2528 *************************************************/
2530 /* These are some wrapping functions that enable the HMAC code to be a bit
2531 cleaner. A good compiler will spot the tail recursion.
2534 type HMAC_MD5 or HMAC_SHA1
2535 remaining are as for the cryptographic hash functions
2541 chash_start(int type, void *base)
2543 if (type == HMAC_MD5)
2544 md5_start((md5 *)base);
2546 sha1_start((sha1 *)base);
2550 chash_mid(int type, void *base, uschar *string)
2552 if (type == HMAC_MD5)
2553 md5_mid((md5 *)base, string);
2555 sha1_mid((sha1 *)base, string);
2559 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2561 if (type == HMAC_MD5)
2562 md5_end((md5 *)base, string, length, digest);
2564 sha1_end((sha1 *)base, string, length, digest);
2571 /********************************************************
2572 * prvs: Get last three digits of days since Jan 1, 1970 *
2573 ********************************************************/
2575 /* This is needed to implement the "prvs" BATV reverse
2578 Argument: integer "days" offset to add or substract to
2579 or from the current number of days.
2581 Returns: pointer to string containing the last three
2582 digits of the number of days since Jan 1, 1970,
2583 modified by the offset argument, NULL if there
2584 was an error in the conversion.
2589 prvs_daystamp(int day_offset)
2591 uschar *days = store_get(32); /* Need at least 24 for cases */
2592 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2593 (time(NULL) + day_offset*86400)/86400);
2594 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2599 /********************************************************
2600 * prvs: perform HMAC-SHA1 computation of prvs bits *
2601 ********************************************************/
2603 /* This is needed to implement the "prvs" BATV reverse
2607 address RFC2821 Address to use
2608 key The key to use (must be less than 64 characters
2610 key_num Single-digit key number to use. Defaults to
2613 Returns: pointer to string containing the first three
2614 bytes of the final hash in hex format, NULL if
2615 there was an error in the process.
2619 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2621 uschar *hash_source, *p;
2622 int size = 0,offset = 0,i;
2624 void *use_base = &sha1_base;
2625 uschar innerhash[20];
2626 uschar finalhash[20];
2627 uschar innerkey[64];
2628 uschar outerkey[64];
2629 uschar *finalhash_hex = store_get(40);
2631 if (key_num == NULL)
2634 if (Ustrlen(key) > 64)
2637 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2638 string_cat(hash_source,&size,&offset,daystamp,3);
2639 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2640 hash_source[offset] = '\0';
2642 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2644 memset(innerkey, 0x36, 64);
2645 memset(outerkey, 0x5c, 64);
2647 for (i = 0; i < Ustrlen(key); i++)
2649 innerkey[i] ^= key[i];
2650 outerkey[i] ^= key[i];
2653 chash_start(HMAC_SHA1, use_base);
2654 chash_mid(HMAC_SHA1, use_base, innerkey);
2655 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2657 chash_start(HMAC_SHA1, use_base);
2658 chash_mid(HMAC_SHA1, use_base, outerkey);
2659 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2662 for (i = 0; i < 3; i++)
2664 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2665 *p++ = hex_digits[finalhash[i] & 0x0f];
2669 return finalhash_hex;
2675 /*************************************************
2676 * Join a file onto the output string *
2677 *************************************************/
2679 /* This is used for readfile and after a run expansion. It joins the contents
2680 of a file onto the output string, globally replacing newlines with a given
2681 string (optionally). The file is closed at the end.
2685 yield pointer to the expandable string
2686 sizep pointer to the current size
2687 ptrp pointer to the current position
2688 eol newline replacement string, or NULL
2690 Returns: new value of string pointer
2694 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2697 uschar buffer[1024];
2699 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2701 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2703 int len = Ustrlen(buffer);
2704 if (eol != NULL && buffer[len-1] == '\n') len--;
2705 yield = string_cat(yield, sizep, ptrp, buffer, len);
2706 if (buffer[len] != 0)
2707 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2710 if (yield != NULL) yield[*ptrp] = 0;
2718 /*************************************************
2719 * Evaluate numeric expression *
2720 *************************************************/
2722 /* This is a set of mutually recursive functions that evaluate a simple
2723 arithmetic expression involving only + - * / and parentheses. The only one that
2724 is called from elsewhere is eval_expr, whose interface is:
2727 sptr pointer to the pointer to the string - gets updated
2728 decimal TRUE if numbers are to be assumed decimal
2729 error pointer to where to put an error message - must be NULL on input
2730 endket TRUE if ')' must terminate - FALSE for external call
2733 Returns: on success: the value of the expression, with *error still NULL
2734 on failure: an undefined value, with *error = a message
2737 static int eval_sumterm(uschar **, BOOL, uschar **);
2740 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2743 int x = eval_sumterm(&s, decimal, error);
2746 while (*s == '+' || *s == '-')
2749 int y = eval_sumterm(&s, decimal, error);
2750 if (*error != NULL) break;
2751 if (op == '+') x += y; else x -= y;
2758 *error = US"expecting closing parenthesis";
2760 while (isspace(*(++s)));
2762 else if (*s != 0) *error = US"expecting + or -";
2771 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2776 while (isspace(*s)) s++;
2778 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2781 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2783 if (tolower(*s) == 'k') { n *= 1024; s++; }
2784 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2785 while (isspace (*s)) s++;
2790 n = eval_expr(&s, decimal, error, 1);
2794 *error = US"expecting number or opening parenthesis";
2801 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2804 int x = eval_term(&s, decimal, error);
2807 while (*s == '*' || *s == '/' || *s == '%')
2810 int y = eval_term(&s, decimal, error);
2811 if (*error != NULL) break;
2812 if (op == '*') x *= y;
2813 else if (op == '/') x /= y;
2824 /*************************************************
2826 *************************************************/
2828 /* Returns either an unchanged string, or the expanded string in stacking pool
2829 store. Interpreted sequences are:
2831 \... normal escaping rules
2832 $name substitutes the variable
2834 ${op:string} operates on the expanded string value
2835 ${item{arg1}{arg2}...} expands the args and then does the business
2836 some literal args are not enclosed in {}
2838 There are now far too many operators and item types to make it worth listing
2839 them here in detail any more.
2841 We use an internal routine recursively to handle embedded substrings. The
2842 external function follows. The yield is NULL if the expansion failed, and there
2843 are two cases: if something collapsed syntactically, or if "fail" was given
2844 as the action on a lookup failure. These can be distinguised by looking at the
2845 variable expand_string_forcedfail, which is TRUE in the latter case.
2847 The skipping flag is set true when expanding a substring that isn't actually
2848 going to be used (after "if" or "lookup") and it prevents lookups from
2849 happening lower down.
2851 Store usage: At start, a store block of the length of the input plus 64
2852 is obtained. This is expanded as necessary by string_cat(), which might have to
2853 get a new block, or might be able to expand the original. At the end of the
2854 function we can release any store above that portion of the yield block that
2855 was actually used. In many cases this will be optimal.
2857 However: if the first item in the expansion is a variable name or header name,
2858 we reset the store before processing it; if the result is in fresh store, we
2859 use that without copying. This is helpful for expanding strings like
2860 $message_headers which can get very long.
2863 string the string to be expanded
2864 ket_ends true if expansion is to stop at }
2865 left if not NULL, a pointer to the first character after the
2866 expansion is placed here (typically used with ket_ends)
2867 skipping TRUE for recursive calls when the value isn't actually going
2868 to be used (to allow for optimisation)
2870 Returns: NULL if expansion fails:
2871 expand_string_forcedfail is set TRUE if failure was forced
2872 expand_string_message contains a textual error message
2873 a pointer to the expanded string on success
2877 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2881 int size = Ustrlen(string)+ 64;
2883 uschar *yield = store_get(size);
2885 uschar *save_expand_nstring[EXPAND_MAXN+1];
2886 int save_expand_nlength[EXPAND_MAXN+1];
2888 expand_string_forcedfail = FALSE;
2889 expand_string_message = US"";
2896 /* \ escapes the next character, which must exist, or else
2897 the expansion fails. There's a special escape, \N, which causes
2898 copying of the subject verbatim up to the next \N. Otherwise,
2899 the escapes are the standard set. */
2905 expand_string_message = US"\\ at end of string";
2912 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2913 yield = string_cat(yield, &size, &ptr, t, s - t);
2914 if (*s != 0) s += 2;
2920 ch[0] = string_interpret_escape(&s);
2922 yield = string_cat(yield, &size, &ptr, ch, 1);
2928 /* Anything other than $ is just copied verbatim, unless we are
2929 looking for a terminating } character. */
2931 if (ket_ends && *s == '}') break;
2935 yield = string_cat(yield, &size, &ptr, s++, 1);
2939 /* No { after the $ - must be a plain name or a number for string
2940 match variable. There has to be a fudge for variables that are the
2941 names of header fields preceded by "$header_" because header field
2942 names can contain any printing characters except space and colon.
2943 For those that don't like typing this much, "$h_" is a synonym for
2944 "$header_". A non-existent header yields a NULL value; nothing is
2947 if (isalpha((*(++s))))
2952 s = read_name(name, sizeof(name), s, US"_");
2954 /* If this is the first thing to be expanded, release the pre-allocated
2957 if (ptr == 0 && yield != NULL)
2966 if (Ustrncmp(name, "h_", 2) == 0 ||
2967 Ustrncmp(name, "rh_", 3) == 0 ||
2968 Ustrncmp(name, "bh_", 3) == 0 ||
2969 Ustrncmp(name, "header_", 7) == 0 ||
2970 Ustrncmp(name, "rheader_", 8) == 0 ||
2971 Ustrncmp(name, "bheader_", 8) == 0)
2973 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2974 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2975 s = read_header_name(name, sizeof(name), s);
2976 value = find_header(name, FALSE, &newsize, want_raw, charset);
2978 /* If we didn't find the header, and the header contains a closing brace
2979 character, this may be a user error where the terminating colon
2980 has been omitted. Set a flag to adjust the error message in this case.
2981 But there is no error here - nothing gets inserted. */
2985 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2994 value = find_variable(name, FALSE, skipping, &newsize);
2997 expand_string_message =
2998 string_sprintf("unknown variable name \"%s\"", name);
2999 check_variable_error_message(name);
3004 /* If the data is known to be in a new buffer, newsize will be set to the
3005 size of that buffer. If this is the first thing in an expansion string,
3006 yield will be NULL; just point it at the new store instead of copying. Many
3007 expansion strings contain just one reference, so this is a useful
3008 optimization, especially for humungous headers. */
3010 len = Ustrlen(value);
3011 if (yield == NULL && newsize != 0)
3017 else yield = string_cat(yield, &size, &ptr, value, len);
3025 s = read_number(&n, s);
3026 if (n >= 0 && n <= expand_nmax)
3027 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3032 /* Otherwise, if there's no '{' after $ it's an error. */
3036 expand_string_message = US"$ not followed by letter, digit, or {";
3040 /* After { there can be various things, but they all start with
3041 an initial word, except for a number for a string match variable. */
3043 if (isdigit((*(++s))))
3046 s = read_number(&n, s);
3049 expand_string_message = US"} expected after number";
3052 if (n >= 0 && n <= expand_nmax)
3053 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3060 expand_string_message = US"letter or digit expected after ${";
3064 /* Allow "-" in names to cater for substrings with negative
3065 arguments. Since we are checking for known names after { this is
3068 s = read_name(name, sizeof(name), s, US"_-");
3069 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3073 /* Handle conditionals - preserve the values of the numerical expansion
3074 variables in case they get changed by a regular expression match in the
3075 condition. If not, they retain their external settings. At the end
3076 of this "if" section, they get restored to their previous values. */
3082 int save_expand_nmax =
3083 save_expand_strings(save_expand_nstring, save_expand_nlength);
3085 while (isspace(*s)) s++;
3086 next_s = eval_condition(s, skipping? NULL : &cond);
3087 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3090 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3091 cond? "true" : "false");
3095 /* The handling of "yes" and "no" result strings is now in a separate
3096 function that is also used by ${lookup} and ${extract} and ${run}. */
3098 switch(process_yesno(
3099 skipping, /* were previously skipping */
3100 cond, /* success/failure indicator */
3101 lookup_value, /* value to reset for string2 */
3102 &s, /* input pointer */
3103 &yield, /* output pointer */
3104 &size, /* output size */
3105 &ptr, /* output current point */
3106 US"if")) /* condition type */
3108 case 1: goto EXPAND_FAILED; /* when all is well, the */
3109 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3112 /* Restore external setting of expansion variables for continuation
3115 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3116 save_expand_nlength);
3120 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3121 expanding an internal string that isn't actually going to be used. All we
3122 need to do is check the syntax, so don't do a lookup at all. Preserve the
3123 values of the numerical expansion variables in case they get changed by a
3124 partial lookup. If not, they retain their external settings. At the end
3125 of this "lookup" section, they get restored to their previous values. */
3129 int stype, partial, affixlen, starflags;
3130 int expand_setup = 0;
3132 uschar *key, *filename, *affix;
3133 uschar *save_lookup_value = lookup_value;
3134 int save_expand_nmax =
3135 save_expand_strings(save_expand_nstring, save_expand_nlength);
3137 if ((expand_forbid & RDO_LOOKUP) != 0)
3139 expand_string_message = US"lookup expansions are not permitted";
3143 /* Get the key we are to look up for single-key+file style lookups.
3144 Otherwise set the key NULL pro-tem. */
3146 while (isspace(*s)) s++;
3149 key = expand_string_internal(s+1, TRUE, &s, skipping);
3150 if (key == NULL) goto EXPAND_FAILED;
3151 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3152 while (isspace(*s)) s++;
3156 /* Find out the type of database */
3160 expand_string_message = US"missing lookup type";
3164 /* The type is a string that may contain special characters of various
3165 kinds. Allow everything except space or { to appear; the actual content
3166 is checked by search_findtype_partial. */
3168 while (*s != 0 && *s != '{' && !isspace(*s))
3170 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3174 while (isspace(*s)) s++;
3176 /* Now check for the individual search type and any partial or default
3177 options. Only those types that are actually in the binary are valid. */
3179 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3183 expand_string_message = search_error_message;
3187 /* Check that a key was provided for those lookup types that need it,
3188 and was not supplied for those that use the query style. */
3190 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3194 expand_string_message = string_sprintf("missing {key} for single-"
3195 "key \"%s\" lookup", name);
3203 expand_string_message = string_sprintf("a single key was given for "
3204 "lookup type \"%s\", which is not a single-key lookup type", name);
3209 /* Get the next string in brackets and expand it. It is the file name for
3210 single-key+file lookups, and the whole query otherwise. In the case of
3211 queries that also require a file name (e.g. sqlite), the file name comes
3214 if (*s != '{') goto EXPAND_FAILED_CURLY;
3215 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3216 if (filename == NULL) goto EXPAND_FAILED;
3217 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3218 while (isspace(*s)) s++;
3220 /* If this isn't a single-key+file lookup, re-arrange the variables
3221 to be appropriate for the search_ functions. For query-style lookups,
3222 there is just a "key", and no file name. For the special query-style +
3223 file types, the query (i.e. "key") starts with a file name. */
3227 while (isspace(*filename)) filename++;
3230 if (mac_islookup(stype, lookup_querystyle))
3236 if (*filename != '/')
3238 expand_string_message = string_sprintf(
3239 "absolute file name expected for \"%s\" lookup", name);
3242 while (*key != 0 && !isspace(*key)) key++;
3243 if (*key != 0) *key++ = 0;
3247 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3248 the entry was not found. Note that there is no search_close() function.
3249 Files are left open in case of re-use. At suitable places in higher logic,
3250 search_tidyup() is called to tidy all open files. This can save opening
3251 the same file several times. However, files may also get closed when
3252 others are opened, if too many are open at once. The rule is that a
3253 handle should not be used after a second search_open().
3255 Request that a partial search sets up $1 and maybe $2 by passing
3256 expand_setup containing zero. If its value changes, reset expand_nmax,
3257 since new variables will have been set. Note that at the end of this
3258 "lookup" section, the old numeric variables are restored. */
3261 lookup_value = NULL;
3264 void *handle = search_open(filename, stype, 0, NULL, NULL);
3267 expand_string_message = search_error_message;
3270 lookup_value = search_find(handle, filename, key, partial, affix,
3271 affixlen, starflags, &expand_setup);
3272 if (search_find_defer)
3274 expand_string_message =
3275 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3276 search_error_message);
3279 if (expand_setup > 0) expand_nmax = expand_setup;
3282 /* The handling of "yes" and "no" result strings is now in a separate
3283 function that is also used by ${if} and ${extract}. */
3285 switch(process_yesno(
3286 skipping, /* were previously skipping */
3287 lookup_value != NULL, /* success/failure indicator */
3288 save_lookup_value, /* value to reset for string2 */
3289 &s, /* input pointer */
3290 &yield, /* output pointer */
3291 &size, /* output size */
3292 &ptr, /* output current point */
3293 US"lookup")) /* condition type */
3295 case 1: goto EXPAND_FAILED; /* when all is well, the */
3296 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3299 /* Restore external setting of expansion variables for carrying on
3300 at this level, and continue. */
3302 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3303 save_expand_nlength);
3307 /* If Perl support is configured, handle calling embedded perl subroutines,
3308 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3309 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3310 arguments (defined below). */
3312 #define EXIM_PERL_MAX_ARGS 8
3316 expand_string_message = US"\"${perl\" encountered, but this facility "
3317 "is not included in this binary";
3320 #else /* EXIM_PERL */
3322 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3325 if ((expand_forbid & RDO_PERL) != 0)
3327 expand_string_message = US"Perl calls are not permitted";
3331 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3334 case 1: goto EXPAND_FAILED_CURLY;
3336 case 3: goto EXPAND_FAILED;
3339 /* If skipping, we don't actually do anything */
3341 if (skipping) continue;
3343 /* Start the interpreter if necessary */
3345 if (!opt_perl_started)
3348 if (opt_perl_startup == NULL)
3350 expand_string_message = US"A setting of perl_startup is needed when "
3351 "using the Perl interpreter";
3354 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3355 initerror = init_perl(opt_perl_startup);
3356 if (initerror != NULL)
3358 expand_string_message =
3359 string_sprintf("error in perl_startup code: %s\n", initerror);
3362 opt_perl_started = TRUE;
3365 /* Call the function */
3367 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3368 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3369 sub_arg[0], sub_arg + 1);
3371 /* NULL yield indicates failure; if the message pointer has been set to
3372 NULL, the yield was undef, indicating a forced failure. Otherwise the
3373 message will indicate some kind of Perl error. */
3375 if (new_yield == NULL)
3377 if (expand_string_message == NULL)
3379 expand_string_message =
3380 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3381 "failure", sub_arg[0]);
3382 expand_string_forcedfail = TRUE;
3387 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3388 set during a callback from Perl. */
3390 expand_string_forcedfail = FALSE;
3394 #endif /* EXIM_PERL */
3396 /* Transform email address to "prvs" scheme to use
3397 as BATV-signed return path */
3404 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3406 case 1: goto EXPAND_FAILED_CURLY;
3408 case 3: goto EXPAND_FAILED;
3411 /* If skipping, we don't actually do anything */
3412 if (skipping) continue;
3414 /* sub_arg[0] is the address */
3415 domain = Ustrrchr(sub_arg[0],'@');
3416 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3418 expand_string_message = US"prvs first argument must be a qualified email address";
3422 /* Calculate the hash. The second argument must be a single-digit
3423 key number, or unset. */
3425 if (sub_arg[2] != NULL &&
3426 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3428 expand_string_message = US"prvs second argument must be a single digit";
3432 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3435 expand_string_message = US"prvs hmac-sha1 conversion failed";
3439 /* Now separate the domain from the local part */
3442 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3443 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3444 string_cat(yield,&size,&ptr,US"/",1);
3445 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3446 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3447 string_cat(yield,&size,&ptr,p,6);
3448 string_cat(yield,&size,&ptr,US"@",1);
3449 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3454 /* Check a prvs-encoded address for validity */
3456 case EITEM_PRVSCHECK:
3459 int mysize = 0, myptr = 0;
3463 /* TF: Ugliness: We want to expand parameter 1 first, then set
3464 up expansion variables that are used in the expansion of
3465 parameter 2. So we clone the string for the first
3466 expansion, where we only expand parameter 1.
3468 PH: Actually, that isn't necessary. The read_subs() function is
3469 designed to work this way for the ${if and ${lookup expansions. I've
3473 /* Reset expansion variables */
3474 prvscheck_result = NULL;
3475 prvscheck_address = NULL;
3476 prvscheck_keynum = NULL;
3478 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3480 case 1: goto EXPAND_FAILED_CURLY;
3482 case 3: goto EXPAND_FAILED;
3485 re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3488 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3490 uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3491 uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3492 uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3493 uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3494 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3496 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3497 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3498 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3499 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3500 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3502 /* Set up expansion variables */
3503 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3504 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3505 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3506 prvscheck_address[myptr] = '\0';
3507 prvscheck_keynum = string_copy(key_num);
3509 /* Now expand the second argument */
3510 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3512 case 1: goto EXPAND_FAILED_CURLY;
3514 case 3: goto EXPAND_FAILED;
3517 /* Now we have the key and can check the address. */
3519 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3524 expand_string_message = US"hmac-sha1 conversion failed";
3528 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3529 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3531 if (Ustrcmp(p,hash) == 0)
3533 /* Success, valid BATV address. Now check the expiry date. */
3534 uschar *now = prvs_daystamp(0);
3535 unsigned int inow = 0,iexpire = 1;
3537 (void)sscanf(CS now,"%u",&inow);
3538 (void)sscanf(CS daystamp,"%u",&iexpire);
3540 /* When "iexpire" is < 7, a "flip" has occured.
3541 Adjust "inow" accordingly. */
3542 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3546 prvscheck_result = US"1";
3547 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3551 prvscheck_result = NULL;
3552 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3557 prvscheck_result = NULL;
3558 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3561 /* Now expand the final argument. We leave this till now so that
3562 it can include $prvscheck_result. */
3564 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3566 case 1: goto EXPAND_FAILED_CURLY;
3568 case 3: goto EXPAND_FAILED;
3571 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3572 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3574 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3576 /* Reset the "internal" variables afterwards, because they are in
3577 dynamic store that will be reclaimed if the expansion succeeded. */
3579 prvscheck_address = NULL;
3580 prvscheck_keynum = NULL;
3584 /* Does not look like a prvs encoded address, return the empty string.
3585 We need to make sure all subs are expanded first, so as to skip over
3588 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3590 case 1: goto EXPAND_FAILED_CURLY;
3592 case 3: goto EXPAND_FAILED;
3599 /* Handle "readfile" to insert an entire file */
3601 case EITEM_READFILE:
3606 if ((expand_forbid & RDO_READFILE) != 0)
3608 expand_string_message = US"file insertions are not permitted";
3612 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3614 case 1: goto EXPAND_FAILED_CURLY;
3616 case 3: goto EXPAND_FAILED;
3619 /* If skipping, we don't actually do anything */
3621 if (skipping) continue;
3623 /* Open the file and read it */
3625 f = Ufopen(sub_arg[0], "rb");
3628 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3632 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3637 /* Handle "readsocket" to insert data from a Unix domain socket */
3639 case EITEM_READSOCK:
3645 struct sockaddr_un sockun; /* don't call this "sun" ! */
3649 if ((expand_forbid & RDO_READSOCK) != 0)
3651 expand_string_message = US"socket insertions are not permitted";
3655 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3656 because there may be a string for expansion on failure. */
3658 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3660 case 1: goto EXPAND_FAILED_CURLY;
3661 case 2: /* Won't occur: no end check */
3662 case 3: goto EXPAND_FAILED;
3665 /* Sort out timeout, if given */
3667 if (sub_arg[2] != NULL)
3669 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3672 expand_string_message = string_sprintf("bad time value %s",
3677 else sub_arg[3] = NULL; /* No eol if no timeout */
3679 /* If skipping, we don't actually do anything. Otherwise, arrange to
3680 connect to either an IP or a Unix socket. */
3684 /* Handle an IP (internet) domain */
3686 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
3688 BOOL connected = FALSE;
3692 uschar *server_name = sub_arg[0] + 5;
3693 uschar *port_name = Ustrrchr(server_name, ':');
3695 /* Sort out the port */
3697 if (port_name == NULL)
3699 expand_string_message =
3700 string_sprintf("missing port for readsocket %s", sub_arg[0]);
3703 *port_name++ = 0; /* Terminate server name */
3705 if (isdigit(*port_name))
3708 port = Ustrtol(port_name, &end, 0);
3709 if (end != port_name + Ustrlen(port_name))
3711 expand_string_message =
3712 string_sprintf("invalid port number %s", port_name);
3718 struct servent *service_info = getservbyname(CS port_name, "tcp");
3719 if (service_info == NULL)
3721 expand_string_message = string_sprintf("unknown port \"%s\"",
3725 port = ntohs(service_info->s_port);
3728 /* Sort out the server. */
3731 shost.address = NULL;
3735 namelen = Ustrlen(server_name);
3737 /* Anything enclosed in [] must be an IP address. */
3739 if (server_name[0] == '[' &&
3740 server_name[namelen - 1] == ']')
3742 server_name[namelen - 1] = 0;
3744 if (string_is_ip_address(server_name, NULL) == 0)
3746 expand_string_message =
3747 string_sprintf("malformed IP address \"%s\"", server_name);
3750 shost.name = shost.address = server_name;
3753 /* Otherwise check for an unadorned IP address */
3755 else if (string_is_ip_address(server_name, NULL) != 0)
3756 shost.name = shost.address = server_name;
3758 /* Otherwise lookup IP address(es) from the name */
3762 shost.name = server_name;
3763 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
3764 FALSE) != HOST_FOUND)
3766 expand_string_message =
3767 string_sprintf("no IP address found for host %s", shost.name);
3772 /* Try to connect to the server - test each IP till one works */
3774 for (h = &shost; h != NULL; h = h->next)
3776 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
3777 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
3779 expand_string_message = string_sprintf("failed to create socket: "
3780 "%s", strerror(errno));
3784 if (ip_connect(fd, af, h->address, port, timeout) == 0)
3793 expand_string_message = string_sprintf("failed to connect to "
3794 "socket %s: couldn't connect to any host", sub_arg[0],
3800 /* Handle a Unix domain socket */
3804 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3806 expand_string_message = string_sprintf("failed to create socket: %s",
3811 sockun.sun_family = AF_UNIX;
3812 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3814 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3816 expand_string_message = string_sprintf("failed to connect to socket "
3817 "%s: %s", sub_arg[0], strerror(errno));
3822 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3824 /* Write the request string, if not empty */
3826 if (sub_arg[1][0] != 0)
3828 int len = Ustrlen(sub_arg[1]);
3829 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3831 if (write(fd, sub_arg[1], len) != len)
3833 expand_string_message = string_sprintf("request write to socket "
3834 "failed: %s", strerror(errno));
3839 /* Shut down the sending side of the socket. This helps some servers to
3840 recognise that it is their turn to do some work. Just in case some
3841 system doesn't have this function, make it conditional. */
3844 shutdown(fd, SHUT_WR);
3847 /* Now we need to read from the socket, under a timeout. The function
3848 that reads a file can be used. */
3850 f = fdopen(fd, "rb");
3851 sigalrm_seen = FALSE;
3853 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3857 /* After a timeout, we restore the pointer in the result, that is,
3858 make sure we add nothing from the socket. */
3863 expand_string_message = US "socket read timed out";
3868 /* The whole thing has worked (or we were skipping). If there is a
3869 failure string following, we need to skip it. */
3873 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3875 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3876 while (isspace(*s)) s++;
3878 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3881 /* Come here on failure to create socket, connect socket, write to the
3882 socket, or timeout on reading. If another substring follows, expand and
3883 use it. Otherwise, those conditions give expand errors. */
3886 if (*s != '{') goto EXPAND_FAILED;
3887 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3888 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3889 if (arg == NULL) goto EXPAND_FAILED;
3890 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3891 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3892 while (isspace(*s)) s++;
3893 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3897 /* Handle "run" to execute a program. */
3909 if ((expand_forbid & RDO_RUN) != 0)
3911 expand_string_message = US"running a command is not permitted";
3915 while (isspace(*s)) s++;
3916 if (*s != '{') goto EXPAND_FAILED_CURLY;
3917 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3918 if (arg == NULL) goto EXPAND_FAILED;
3919 while (isspace(*s)) s++;
3920 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3922 if (skipping) /* Just pretend it worked when we're skipping */
3928 if (!transport_set_up_command(&argv, /* anchor for arg list */
3929 arg, /* raw command */
3930 FALSE, /* don't expand the arguments */
3931 0, /* not relevant when... */
3932 NULL, /* no transporting address */
3933 US"${run} expansion", /* for error messages */
3934 &expand_string_message)) /* where to put error message */
3939 /* Create the child process, making it a group leader. */
3941 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3945 expand_string_message =
3946 string_sprintf("couldn't create child process: %s", strerror(errno));
3950 /* Nothing is written to the standard input. */
3954 /* Wait for the process to finish, applying the timeout, and inspect its
3955 return code for serious disasters. Simple non-zero returns are passed on.
3958 if ((runrc = child_close(pid, 60)) < 0)
3962 expand_string_message = string_sprintf("command timed out");
3963 killpg(pid, SIGKILL); /* Kill the whole process group */
3966 else if (runrc == -257)
3967 expand_string_message = string_sprintf("wait() failed: %s",
3971 expand_string_message = string_sprintf("command killed by signal %d",
3977 /* Read the pipe to get the command's output into $value (which is kept
3978 in lookup_value). */
3980 f = fdopen(fd_out, "rb");
3981 lookup_value = NULL;
3982 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3986 /* Process the yes/no strings; $value may be useful in both cases */
3988 switch(process_yesno(
3989 skipping, /* were previously skipping */
3990 runrc == 0, /* success/failure indicator */
3991 lookup_value, /* value to reset for string2 */
3992 &s, /* input pointer */
3993 &yield, /* output pointer */
3994 &size, /* output size */
3995 &ptr, /* output current point */
3996 US"run")) /* condition type */
3998 case 1: goto EXPAND_FAILED; /* when all is well, the */
3999 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4005 /* Handle character translation for "tr" */
4013 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4015 case 1: goto EXPAND_FAILED_CURLY;
4017 case 3: goto EXPAND_FAILED;
4020 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4021 o2m = Ustrlen(sub[2]) - 1;
4023 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4025 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4029 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4036 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4037 expanded arguments. */
4047 int val[2] = { 0, -1 };
4050 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4051 Ensure that sub[2] is set in the ${length case. */
4054 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4057 case 1: goto EXPAND_FAILED_CURLY;
4059 case 3: goto EXPAND_FAILED;
4062 /* Juggle the arguments if there are only two of them: always move the
4063 string to the last position and make ${length{n}{str}} equivalent to
4064 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4070 if (item_type == EITEM_LENGTH)
4077 for (i = 0; i < 2; i++)
4079 if (sub[i] == NULL) continue;
4080 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4081 if (*ret != 0 || (i != 0 && val[i] < 0))
4083 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4084 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4090 (item_type == EITEM_HASH)?
4091 compute_hash(sub[2], val[0], val[1], &len) :
4092 (item_type == EITEM_NHASH)?
4093 compute_nhash(sub[2], val[0], val[1], &len) :
4094 extract_substr(sub[2], val[0], val[1], &len);
4096 if (ret == NULL) goto EXPAND_FAILED;
4097 yield = string_cat(yield, &size, &ptr, ret, len);
4101 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4102 This code originally contributed by Steve Haslam. It currently supports
4103 the use of MD5 and SHA-1 hashes.
4105 We need some workspace that is large enough to handle all the supported
4106 hash types. Use macros to set the sizes rather than be too elaborate. */
4108 #define MAX_HASHLEN 20
4109 #define MAX_HASHBLOCKLEN 64
4118 int hashlen; /* Number of octets for the hash algorithm's output */
4119 int hashblocklen; /* Number of octets the hash algorithm processes */
4121 unsigned int keylen;
4123 uschar keyhash[MAX_HASHLEN];
4124 uschar innerhash[MAX_HASHLEN];
4125 uschar finalhash[MAX_HASHLEN];
4126 uschar finalhash_hex[2*MAX_HASHLEN];
4127 uschar innerkey[MAX_HASHBLOCKLEN];
4128 uschar outerkey[MAX_HASHBLOCKLEN];
4130 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4132 case 1: goto EXPAND_FAILED_CURLY;
4134 case 3: goto EXPAND_FAILED;
4137 if (Ustrcmp(sub[0], "md5") == 0)
4140 use_base = &md5_base;
4144 else if (Ustrcmp(sub[0], "sha1") == 0)
4147 use_base = &sha1_base;
4153 expand_string_message =
4154 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4159 keylen = Ustrlen(keyptr);
4161 /* If the key is longer than the hash block length, then hash the key
4164 if (keylen > hashblocklen)
4166 chash_start(type, use_base);
4167 chash_end(type, use_base, keyptr, keylen, keyhash);
4172 /* Now make the inner and outer key values */
4174 memset(innerkey, 0x36, hashblocklen);
4175 memset(outerkey, 0x5c, hashblocklen);
4177 for (i = 0; i < keylen; i++)
4179 innerkey[i] ^= keyptr[i];
4180 outerkey[i] ^= keyptr[i];
4183 /* Now do the hashes */
4185 chash_start(type, use_base);
4186 chash_mid(type, use_base, innerkey);
4187 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4189 chash_start(type, use_base);
4190 chash_mid(type, use_base, outerkey);
4191 chash_end(type, use_base, innerhash, hashlen, finalhash);
4193 /* Encode the final hash as a hex string */
4196 for (i = 0; i < hashlen; i++)
4198 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4199 *p++ = hex_digits[finalhash[i] & 0x0f];
4202 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4203 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4205 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4210 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4211 We have to save the numerical variables and restore them afterwards. */
4216 int moffset, moffsetextra, slen;
4219 const uschar *rerror;
4222 int save_expand_nmax =
4223 save_expand_strings(save_expand_nstring, save_expand_nlength);
4225 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4227 case 1: goto EXPAND_FAILED_CURLY;
4229 case 3: goto EXPAND_FAILED;
4232 /* Compile the regular expression */
4234 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4239 expand_string_message = string_sprintf("regular expression error in "
4240 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4244 /* Now run a loop to do the substitutions as often as necessary. It ends
4245 when there are no more matches. Take care over matches of the null string;
4246 do the same thing as Perl does. */
4249 slen = Ustrlen(sub[0]);
4250 moffset = moffsetextra = 0;
4255 int ovector[3*(EXPAND_MAXN+1)];
4256 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4257 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4261 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4262 is not necessarily the end. We want to repeat the match from one
4263 character further along, but leaving the basic offset the same (for
4264 copying below). We can't be at the end of the string - that was checked
4265 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4266 finished; copy the remaining string and end the loop. */
4276 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4280 /* Match - set up for expanding the replacement. */
4282 if (n == 0) n = EXPAND_MAXN + 1;
4284 for (nn = 0; nn < n*2; nn += 2)
4286 expand_nstring[expand_nmax] = subject + ovector[nn];
4287 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4291 /* Copy the characters before the match, plus the expanded insertion. */
4293 yield = string_cat(yield, &size, &ptr, subject + moffset,
4294 ovector[0] - moffset);
4295 insert = expand_string(sub[2]);
4296 if (insert == NULL) goto EXPAND_FAILED;
4297 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4299 moffset = ovector[1];
4303 /* If we have matched an empty string, first check to see if we are at
4304 the end of the subject. If so, the loop is over. Otherwise, mimic
4305 what Perl's /g options does. This turns out to be rather cunning. First
4306 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4307 string at the same point. If this fails (picked up above) we advance to
4308 the next character. */
4310 if (ovector[0] == ovector[1])
4312 if (ovector[0] == slen) break;
4313 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4317 /* All done - restore numerical variables. */
4319 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4320 save_expand_nlength);
4324 /* Handle keyed and numbered substring extraction. If the first argument
4325 consists entirely of digits, then a numerical extraction is assumed. */
4331 int field_number = 1;
4332 BOOL field_number_set = FALSE;
4333 uschar *save_lookup_value = lookup_value;
4335 int save_expand_nmax =
4336 save_expand_strings(save_expand_nstring, save_expand_nlength);
4338 /* Read the arguments */
4340 for (i = 0; i < j; i++)
4342 while (isspace(*s)) s++;
4345 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4346 if (sub[i] == NULL) goto EXPAND_FAILED;
4347 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4349 /* After removal of leading and trailing white space, the first
4350 argument must not be empty; if it consists entirely of digits
4351 (optionally preceded by a minus sign), this is a numerical
4352 extraction, and we expect 3 arguments. */
4360 while (isspace(*p)) p++;
4364 while (len > 0 && isspace(p[len-1])) len--;
4369 expand_string_message = US"first argument of \"extract\" must "
4379 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4383 j = 3; /* Need 3 args */
4384 field_number_set = TRUE;
4388 else goto EXPAND_FAILED_CURLY;
4391 /* Extract either the numbered or the keyed substring into $value. If
4392 skipping, just pretend the extraction failed. */
4394 lookup_value = skipping? NULL : field_number_set?
4395 expand_gettokened(field_number, sub[1], sub[2]) :
4396 expand_getkeyed(sub[0], sub[1]);
4398 /* If no string follows, $value gets substituted; otherwise there can
4399 be yes/no strings, as for lookup or if. */
4401 switch(process_yesno(
4402 skipping, /* were previously skipping */
4403 lookup_value != NULL, /* success/failure indicator */
4404 save_lookup_value, /* value to reset for string2 */
4405 &s, /* input pointer */
4406 &yield, /* output pointer */
4407 &size, /* output size */
4408 &ptr, /* output current point */
4409 US"extract")) /* condition type */
4411 case 1: goto EXPAND_FAILED; /* when all is well, the */
4412 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4415 /* All done - restore numerical variables. */
4417 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4418 save_expand_nlength);
4424 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4425 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4426 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4427 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4429 #define EXPAND_DLFUNC_MAX_ARGS 8
4432 #ifndef EXPAND_DLFUNC
4433 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4434 "is not included in this binary";
4437 #else /* EXPAND_DLFUNC */
4440 exim_dlfunc_t *func;
4443 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4445 if ((expand_forbid & RDO_DLFUNC) != 0)
4447 expand_string_message =
4448 US"dynamically-loaded functions are not permitted";
4452 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4455 case 1: goto EXPAND_FAILED_CURLY;
4457 case 3: goto EXPAND_FAILED;
4460 /* If skipping, we don't actually do anything */
4462 if (skipping) continue;
4464 /* Look up the dynamically loaded object handle in the tree. If it isn't
4465 found, dlopen() the file and put the handle in the tree for next time. */
4467 t = tree_search(dlobj_anchor, argv[0]);
4470 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4473 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4474 argv[0], dlerror());
4475 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4478 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4479 Ustrcpy(t->name, argv[0]);
4480 t->data.ptr = handle;
4481 (void)tree_insertnode(&dlobj_anchor, t);
4484 /* Having obtained the dynamically loaded object handle, look up the
4485 function pointer. */
4487 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4490 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4491 "%s", argv[1], argv[0], dlerror());
4492 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4496 /* Call the function and work out what to do with the result. If it
4497 returns OK, we have a replacement string; if it returns DEFER then
4498 expansion has failed in a non-forced manner; if it returns FAIL then
4499 failure was forced; if it returns ERROR or any other value there's a
4500 problem, so panic slightly. */
4503 for (argc = 0; argv[argc] != NULL; argc++);
4504 status = func(&result, argc - 2, &argv[2]);
4507 if (result == NULL) result = US"";
4508 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4513 expand_string_message = result == NULL ? US"(no message)" : result;
4514 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4515 else if(status != FAIL)
4516 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4517 argv[0], argv[1], status, expand_string_message);
4521 #endif /* EXPAND_DLFUNC */
4524 /* Control reaches here if the name is not recognized as one of the more
4525 complicated expansion items. Check for the "operator" syntax (name terminated
4526 by a colon). Some of the operators have arguments, separated by _ from the
4533 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4534 if (sub == NULL) goto EXPAND_FAILED;
4537 /* Owing to an historical mis-design, an underscore may be part of the
4538 operator name, or it may introduce arguments. We therefore first scan the
4539 table of names that contain underscores. If there is no match, we cut off
4540 the arguments and then scan the main table. */
4542 c = chop_match(name, op_table_underscore,
4543 sizeof(op_table_underscore)/sizeof(uschar *));
4547 arg = Ustrchr(name, '_');
4548 if (arg != NULL) *arg = 0;
4549 c = chop_match(name, op_table_main,
4550 sizeof(op_table_main)/sizeof(uschar *));
4551 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4552 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
4555 /* If we are skipping, we don't need to perform the operation at all.
4556 This matters for operations like "mask", because the data may not be
4557 in the correct format when skipping. For example, the expression may test
4558 for the existence of $sender_host_address before trying to mask it. For
4559 other operations, doing them may not fail, but it is a waste of time. */
4561 if (skipping && c >= 0) continue;
4563 /* Otherwise, switch on the operator type */
4570 unsigned long int n = Ustrtoul(sub, &t, 10);
4573 expand_string_message = string_sprintf("argument for base62 "
4574 "operator is \"%s\", which is not a decimal number", sub);
4577 t = string_base62(n);
4578 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4582 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
4588 unsigned long int n = 0;
4591 uschar *t = Ustrchr(base62_chars, *tt++);
4594 expand_string_message = string_sprintf("argument for base62d "
4595 "operator is \"%s\", which is not a base %d number", sub,
4599 n = n * BASE_62 + (t - base62_chars);
4601 (void)sprintf(CS buf, "%ld", n);
4602 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4608 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4609 if (expanded == NULL)
4611 expand_string_message =
4612 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4613 expand_string_message);
4616 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4623 uschar *t = sub - 1;
4624 while (*(++t) != 0) { *t = tolower(*t); count++; }
4625 yield = string_cat(yield, &size, &ptr, sub, count);
4632 uschar *t = sub - 1;
4633 while (*(++t) != 0) { *t = toupper(*t); count++; }
4634 yield = string_cat(yield, &size, &ptr, sub, count);
4645 md5_end(&base, sub, Ustrlen(sub), digest);
4646 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4647 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4658 sha1_end(&base, sub, Ustrlen(sub), digest);
4659 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4660 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4664 /* Convert hex encoding to base64 encoding */
4674 for (enc = sub; *enc != 0; enc++)
4676 if (!isxdigit(*enc))
4678 expand_string_message = string_sprintf("\"%s\" is not a hex "
4687 expand_string_message = string_sprintf("\"%s\" contains an odd "
4688 "number of characters", sub);
4692 while ((c = *in++) != 0)
4694 if (isdigit(c)) c -= '0';
4695 else c = toupper(c) - 'A' + 10;
4707 enc = auth_b64encode(sub, out - sub);
4708 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4712 /* mask applies a mask to an IP address; for example the result of
4713 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4720 int mask, maskoffset;
4721 int type = string_is_ip_address(sub, &maskoffset);
4726 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4731 if (maskoffset == 0)
4733 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4738 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4740 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4742 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4747 /* Convert the address to binary integer(s) and apply the mask */
4749 sub[maskoffset] = 0;
4750 count = host_aton(sub, binary);
4751 host_mask(count, binary, mask);
4753 /* Convert to masked textual format and add to output. */
4755 yield = string_cat(yield, &size, &ptr, buffer,
4756 host_nmtoa(count, binary, mask, buffer, '.'));
4761 case EOP_LOCAL_PART:
4765 int start, end, domain;
4766 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4770 if (c != EOP_DOMAIN)
4772 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4773 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4775 else if (domain != 0)
4778 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4784 /* quote puts a string in quotes if it is empty or contains anything
4785 other than alphamerics, underscore, dot, or hyphen.
4787 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4788 be quoted in order to be a valid local part.
4790 In both cases, newlines and carriage returns are converted into \n and \r
4794 case EOP_QUOTE_LOCAL_PART:
4797 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4798 uschar *t = sub - 1;
4802 while (!needs_quote && *(++t) != 0)
4803 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4805 else /* EOP_QUOTE_LOCAL_PART */
4807 while (!needs_quote && *(++t) != 0)
4808 needs_quote = !isalnum(*t) &&
4809 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4810 (*t != '.' || t == sub || t[1] == 0);
4815 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4820 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4821 else if (*t == '\r')
4822 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4825 if (*t == '\\' || *t == '"')
4826 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4827 yield = string_cat(yield, &size, &ptr, t, 1);
4830 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4832 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4836 /* quote_lookuptype does lookup-specific quoting */
4841 uschar *opt = Ustrchr(arg, '_');
4843 if (opt != NULL) *opt++ = 0;
4845 n = search_findtype(arg, Ustrlen(arg));
4848 expand_string_message = search_error_message;
4852 if (lookup_list[n].quote != NULL)
4853 sub = (lookup_list[n].quote)(sub, opt);
4854 else if (opt != NULL) sub = NULL;
4858 expand_string_message = string_sprintf(
4859 "\"%s\" unrecognized after \"${quote_%s\"",
4864 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4868 /* rx quote sticks in \ before any non-alphameric character so that
4869 the insertion works in a regular expression. */
4873 uschar *t = sub - 1;
4877 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4878 yield = string_cat(yield, &size, &ptr, t, 1);
4883 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4884 prescribed by the RFC, if there are characters that need to be encoded */
4888 uschar buffer[2048];
4889 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4890 buffer, sizeof(buffer), FALSE);
4891 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4895 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4905 if (c > 255) c = '_';
4907 yield = string_cat(yield, &size, &ptr, buff, 1);
4912 /* escape turns all non-printing characters into escape sequences. */
4916 uschar *t = string_printing(sub);
4917 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4921 /* Handle numeric expression evaluation */
4926 uschar *save_sub = sub;
4927 uschar *error = NULL;
4928 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4931 expand_string_message = string_sprintf("error in expression "
4932 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4936 sprintf(CS var_buffer, "%d", n);
4937 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4941 /* Handle time period formating */
4945 int n = readconf_readtime(sub, 0, FALSE);
4948 expand_string_message = string_sprintf("string \"%s\" is not an "
4949 "Exim time interval in \"%s\" operator", sub, name);
4952 sprintf(CS var_buffer, "%d", n);
4953 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4957 case EOP_TIME_INTERVAL:
4960 uschar *t = read_number(&n, sub);
4961 if (*t != 0) /* Not A Number*/
4963 expand_string_message = string_sprintf("string \"%s\" is not a "
4964 "positive number in \"%s\" operator", sub, name);
4967 t = readconf_printtime(n);
4968 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4972 /* Convert string to base64 encoding */
4976 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4977 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4981 /* strlen returns the length of the string */
4986 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4987 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4991 /* length_n or l_n takes just the first n characters or the whole string,
4992 whichever is the shorter;
4994 substr_m_n, and s_m_n take n characters from offset m; negative m take
4995 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4996 takes the rest, either to the right or to the left.
4998 hash_n or h_n makes a hash of length n from the string, yielding n
4999 characters from the set a-z; hash_n_m makes a hash of length n, but
5000 uses m characters from the set a-zA-Z0-9.
5002 nhash_n returns a single number between 0 and n-1 (in text form), while
5003 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5004 between 0 and n-1 and the second between 0 and m-1. */
5024 expand_string_message = string_sprintf("missing values after %s",
5029 /* "length" has only one argument, effectively being synonymous with
5032 if (c == EOP_LENGTH || c == EOP_L)
5038 /* The others have one or two arguments; for "substr" the first may be
5039 negative. The second being negative means "not supplied". */
5044 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5047 /* Read up to two numbers, separated by underscores */
5052 if (arg != ret && *arg == '_' && pn == &value1)
5056 if (arg[1] != 0) arg++;
5058 else if (!isdigit(*arg))
5060 expand_string_message =
5061 string_sprintf("non-digit after underscore in \"%s\"", name);
5064 else *pn = (*pn)*10 + *arg++ - '0';
5068 /* Perform the required operation */
5071 (c == EOP_HASH || c == EOP_H)?
5072 compute_hash(sub, value1, value2, &len) :
5073 (c == EOP_NHASH || c == EOP_NH)?
5074 compute_nhash(sub, value1, value2, &len) :
5075 extract_substr(sub, value1, value2, &len);
5077 if (ret == NULL) goto EXPAND_FAILED;
5078 yield = string_cat(yield, &size, &ptr, ret, len);
5088 uschar **modetable[3];
5093 if ((expand_forbid & RDO_EXISTS) != 0)
5095 expand_string_message = US"Use of the stat() expansion is not permitted";
5099 if (stat(CS sub, &st) < 0)
5101 expand_string_message = string_sprintf("stat(%s) failed: %s",
5102 sub, strerror(errno));
5106 switch (mode & S_IFMT)
5108 case S_IFIFO: smode[0] = 'p'; break;
5109 case S_IFCHR: smode[0] = 'c'; break;
5110 case S_IFDIR: smode[0] = 'd'; break;
5111 case S_IFBLK: smode[0] = 'b'; break;
5112 case S_IFREG: smode[0] = '-'; break;
5113 default: smode[0] = '?'; break;
5116 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5117 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5118 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5120 for (i = 0; i < 3; i++)
5122 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5127 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5128 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5129 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5130 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5131 (long)st.st_gid, st.st_size, (long)st.st_atime,
5132 (long)st.st_mtime, (long)st.st_ctime);
5133 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5137 /* Unknown operator */
5140 expand_string_message =
5141 string_sprintf("unknown expansion operator \"%s\"", name);
5146 /* Handle a plain name. If this is the first thing in the expansion, release
5147 the pre-allocated buffer. If the result data is known to be in a new buffer,
5148 newsize will be set to the size of that buffer, and we can just point at that
5149 store instead of copying. Many expansion strings contain just one reference,
5150 so this is a useful optimization, especially for humungous headers
5151 ($message_headers). */
5163 value = find_variable(name, FALSE, skipping, &newsize);
5166 expand_string_message =
5167 string_sprintf("unknown variable in \"${%s}\"", name);
5168 check_variable_error_message(name);
5171 len = Ustrlen(value);
5172 if (yield == NULL && newsize != 0)
5178 else yield = string_cat(yield, &size, &ptr, value, len);
5182 /* Else there's something wrong */
5184 expand_string_message =
5185 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5186 "in a variable reference)", name);
5190 /* If we hit the end of the string when ket_ends is set, there is a missing
5191 terminating brace. */
5193 if (ket_ends && *s == 0)
5195 expand_string_message = malformed_header?
5196 US"missing } at end of string - could be header name not terminated by colon"
5198 US"missing } at end of string";
5202 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5203 added to the string. If so, set up an empty string. Add a terminating zero. If
5204 left != NULL, return a pointer to the terminator. */
5206 if (yield == NULL) yield = store_get(1);
5208 if (left != NULL) *left = s;
5210 /* Any stacking store that was used above the final string is no longer needed.
5211 In many cases the final string will be the first one that was got and so there
5212 will be optimal store usage. */
5214 store_reset(yield + ptr + 1);
5217 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5219 if (skipping) debug_printf("skipping: result is not used\n");
5223 /* This is the failure exit: easiest to program with a goto. We still need
5224 to update the pointer to the terminator, for cases of nested calls with "fail".
5227 EXPAND_FAILED_CURLY:
5228 expand_string_message = malformed_header?
5229 US"missing or misplaced { or } - could be header name not terminated by colon"
5231 US"missing or misplaced { or }";
5233 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5234 that is a bad idea, because expand_string_message is in dynamic store. */
5237 if (left != NULL) *left = s;
5240 debug_printf("failed to expand: %s\n", string);
5241 debug_printf(" error message: %s\n", expand_string_message);
5242 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5248 /* This is the external function call. Do a quick check for any expansion
5249 metacharacters, and if there are none, just return the input string.
5251 Argument: the string to be expanded
5252 Returns: the expanded string, or NULL if expansion failed; if failure was
5253 due to a lookup deferring, search_find_defer will be TRUE
5257 expand_string(uschar *string)
5259 search_find_defer = FALSE;
5260 malformed_header = FALSE;
5261 return (Ustrpbrk(string, "$\\") == NULL)? string :
5262 expand_string_internal(string, FALSE, NULL, FALSE);
5267 /*************************************************
5269 *************************************************/
5271 /* Now and again we want to expand a string and be sure that the result is in a
5272 new bit of store. This function does that.
5274 Argument: the string to be expanded
5275 Returns: the expanded string, always in a new bit of store, or NULL
5279 expand_string_copy(uschar *string)
5281 uschar *yield = expand_string(string);
5282 if (yield == string) yield = string_copy(string);
5288 /*************************************************
5289 * Expand and interpret as an integer *
5290 *************************************************/
5292 /* Expand a string, and convert the result into an integer.
5295 string the string to be expanded
5296 isplus TRUE if a non-negative number is expected
5298 Returns: the integer value, or
5299 -1 for an expansion error ) in both cases, message in
5300 -2 for an integer interpretation error ) expand_string_message
5301 expand_string_message is set NULL for an OK integer
5305 expand_string_integer(uschar *string, BOOL isplus)
5308 uschar *s = expand_string(string);
5309 uschar *msg = US"invalid integer \"%s\"";
5312 /* If expansion failed, expand_string_message will be set. */
5314 if (s == NULL) return -1;
5316 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5317 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5318 systems, so we set it zero ourselves. */
5321 expand_string_message = NULL; /* Indicates no error */
5322 value = strtol(CS s, CSS &endptr, 0);
5326 msg = US"integer expected but \"%s\" found";
5328 else if (value < 0 && isplus)
5330 msg = US"non-negative integer expected but \"%s\" found";
5334 /* Ensure we can cast this down to an int */
5335 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5337 if (errno != ERANGE)
5339 if (tolower(*endptr) == 'k')
5341 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5345 else if (tolower(*endptr) == 'm')
5347 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5349 else value *= 1024*1024;
5353 if (errno == ERANGE)
5354 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5357 while (isspace(*endptr)) endptr++;
5358 if (*endptr == 0) return (int)value;
5362 expand_string_message = string_sprintf(CS msg, s);
5367 /*************************************************
5368 **************************************************
5369 * Stand-alone test program *
5370 **************************************************
5371 *************************************************/
5377 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5379 int ovector[3*(EXPAND_MAXN+1)];
5380 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5381 ovector, sizeof(ovector)/sizeof(int));
5382 BOOL yield = n >= 0;
5383 if (n == 0) n = EXPAND_MAXN + 1;
5387 expand_nmax = (setup < 0)? 0 : setup + 1;
5388 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5390 expand_nstring[expand_nmax] = subject + ovector[nn];
5391 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5399 int main(int argc, uschar **argv)
5402 uschar buffer[1024];
5404 debug_selector = D_v;
5405 debug_file = stderr;
5406 debug_fd = fileno(debug_file);
5407 big_buffer = malloc(big_buffer_size);
5409 for (i = 1; i < argc; i++)
5411 if (argv[i][0] == '+')
5413 debug_trace_memory = 2;
5416 if (isdigit(argv[i][0]))
5417 debug_selector = Ustrtol(argv[i], NULL, 0);
5419 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5423 eldap_default_servers = argv[i];
5426 mysql_servers = argv[i];
5429 pgsql_servers = argv[i];
5433 else opt_perl_startup = argv[i];
5437 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5439 expand_nstring[1] = US"string 1....";
5440 expand_nlength[1] = 8;
5444 if (opt_perl_startup != NULL)
5447 printf("Starting Perl interpreter\n");
5448 errstr = init_perl(opt_perl_startup);
5451 printf("** error in perl_startup code: %s\n", errstr);
5452 return EXIT_FAILURE;
5455 #endif /* EXIM_PERL */
5457 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5459 void *reset_point = store_get(0);
5460 uschar *yield = expand_string(buffer);
5463 printf("%s\n", yield);
5464 store_reset(reset_point);
5468 if (search_find_defer) printf("search_find deferred\n");
5469 printf("Failed: %s\n", expand_string_message);
5470 if (expand_string_forcedfail) printf("Forced failure\n");
5482 /* End of expand.c */