1 /* $Cambridge: exim/src/src/expand.c,v 1.66 2006/10/30 14:59:15 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 */
1694 if (Ustrncmp(name, "h_", 2) == 0 ||
1695 Ustrncmp(name, "rh_", 3) == 0 ||
1696 Ustrncmp(name, "bh_", 3) == 0 ||
1697 Ustrncmp(name, "header_", 7) == 0 ||
1698 Ustrncmp(name, "rheader_", 8) == 0 ||
1699 Ustrncmp(name, "bheader_", 8) == 0)
1701 s = read_header_name(name, 256, s);
1702 if (yield != NULL) *yield =
1703 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1706 /* Test for a variable's having a non-empty value. A non-existent variable
1707 causes an expansion failure. */
1711 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1714 expand_string_message = (name[0] == 0)?
1715 string_sprintf("variable name omitted after \"def:\"") :
1716 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1717 check_variable_error_message(name);
1720 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1726 /* first_delivery tests for first delivery attempt */
1728 case ECOND_FIRST_DELIVERY:
1729 if (yield != NULL) *yield = deliver_firsttime == testfor;
1733 /* queue_running tests for any process started by a queue runner */
1735 case ECOND_QUEUE_RUNNING:
1736 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1740 /* exists: tests for file existence
1741 isip: tests for any IP address
1742 isip4: tests for an IPv4 address
1743 isip6: tests for an IPv6 address
1744 pam: does PAM authentication
1745 radius: does RADIUS authentication
1746 ldapauth: does LDAP authentication
1747 pwcheck: does Cyrus SASL pwcheck authentication
1756 case ECOND_LDAPAUTH:
1759 while (isspace(*s)) s++;
1760 if (*s != '{') goto COND_FAILED_CURLY_START;
1762 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1763 if (sub[0] == NULL) return NULL;
1764 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1766 if (yield == NULL) return s; /* No need to run the test if skipping */
1771 if ((expand_forbid & RDO_EXISTS) != 0)
1773 expand_string_message = US"File existence tests are not permitted";
1776 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1782 rc = string_is_ip_address(sub[0], NULL);
1783 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1784 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1787 /* Various authentication tests - all optionally compiled */
1791 rc = auth_call_pam(sub[0], &expand_string_message);
1794 goto COND_FAILED_NOT_COMPILED;
1795 #endif /* SUPPORT_PAM */
1798 #ifdef RADIUS_CONFIG_FILE
1799 rc = auth_call_radius(sub[0], &expand_string_message);
1802 goto COND_FAILED_NOT_COMPILED;
1803 #endif /* RADIUS_CONFIG_FILE */
1805 case ECOND_LDAPAUTH:
1808 /* Just to keep the interface the same */
1810 int old_pool = store_pool;
1811 store_pool = POOL_SEARCH;
1812 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1813 &expand_string_message, &do_cache);
1814 store_pool = old_pool;
1818 goto COND_FAILED_NOT_COMPILED;
1819 #endif /* LOOKUP_LDAP */
1822 #ifdef CYRUS_PWCHECK_SOCKET
1823 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1826 goto COND_FAILED_NOT_COMPILED;
1827 #endif /* CYRUS_PWCHECK_SOCKET */
1829 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1830 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1832 if (rc == ERROR || rc == DEFER) return NULL;
1833 *yield = (rc == OK) == testfor;
1839 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1841 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1843 However, the last two are optional. That is why the whole set is enclosed
1844 in their own set or braces. */
1846 case ECOND_SASLAUTHD:
1847 #ifndef CYRUS_SASLAUTHD_SOCKET
1848 goto COND_FAILED_NOT_COMPILED;
1850 while (isspace(*s)) s++;
1851 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1852 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1854 case 1: expand_string_message = US"too few arguments or bracketing "
1855 "error for saslauthd";
1857 case 3: return NULL;
1859 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1863 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1864 &expand_string_message);
1865 if (rc == ERROR || rc == DEFER) return NULL;
1866 *yield = (rc == OK) == testfor;
1869 #endif /* CYRUS_SASLAUTHD_SOCKET */
1872 /* symbolic operators for numeric and string comparison, and a number of
1873 other operators, all requiring two arguments.
1875 match: does a regular expression match and sets up the numerical
1876 variables if it succeeds
1877 match_address: matches in an address list
1878 match_domain: matches in a domain list
1879 match_ip: matches a host list that is restricted to IP addresses
1880 match_local_part: matches in a local part list
1881 crypteq: encrypts plaintext and compares against an encrypted text,
1882 using crypt(), crypt16(), MD5 or SHA-1
1886 case ECOND_MATCH_ADDRESS:
1887 case ECOND_MATCH_DOMAIN:
1888 case ECOND_MATCH_IP:
1889 case ECOND_MATCH_LOCAL_PART:
1892 case ECOND_NUM_L: /* Numerical comparisons */
1899 case ECOND_STR_LT: /* String comparisons */
1910 for (i = 0; i < 2; i++)
1912 while (isspace(*s)) s++;
1915 if (i == 0) goto COND_FAILED_CURLY_START;
1916 expand_string_message = string_sprintf("missing 2nd string in {} "
1917 "after \"%s\"", name);
1920 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1921 if (sub[i] == NULL) return NULL;
1922 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1924 /* Convert to numerical if required; we know that the names of all the
1925 conditions that compare numbers do not start with a letter. This just saves
1926 checking for them individually. */
1928 if (!isalpha(name[0]))
1930 num[i] = expand_string_integer(sub[i], FALSE);
1931 if (expand_string_message != NULL) return NULL;
1935 /* Result not required */
1937 if (yield == NULL) return s;
1939 /* Do an appropriate comparison */
1945 *yield = (num[0] == num[1]) == testfor;
1949 *yield = (num[0] > num[1]) == testfor;
1953 *yield = (num[0] >= num[1]) == testfor;
1957 *yield = (num[0] < num[1]) == testfor;
1961 *yield = (num[0] <= num[1]) == testfor;
1965 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1969 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1973 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1977 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1981 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1985 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1989 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1993 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1997 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2001 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2004 case ECOND_MATCH: /* Regular expression match */
2005 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2009 expand_string_message = string_sprintf("regular expression error in "
2010 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2013 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2016 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2017 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2018 goto MATCHED_SOMETHING;
2020 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2021 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2022 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2023 goto MATCHED_SOMETHING;
2025 case ECOND_MATCH_IP: /* Match IP address in a host list */
2026 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2028 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2034 unsigned int *nullcache = NULL;
2035 check_host_block cb;
2037 cb.host_name = US"";
2038 cb.host_address = sub[0];
2040 /* If the host address starts off ::ffff: it is an IPv6 address in
2041 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2044 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2045 cb.host_address + 7 : cb.host_address;
2047 rc = match_check_list(
2048 &sub[1], /* the list */
2049 0, /* separator character */
2050 &hostlist_anchor, /* anchor pointer */
2051 &nullcache, /* cache pointer */
2052 check_host, /* function for testing */
2053 &cb, /* argument for function */
2054 MCL_HOST, /* type of check */
2055 sub[0], /* text for debugging */
2056 NULL); /* where to pass back data */
2058 goto MATCHED_SOMETHING;
2060 case ECOND_MATCH_LOCAL_PART:
2061 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2062 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2077 expand_string_message = string_sprintf("unable to complete match "
2078 "against \"%s\": %s", sub[1], search_error_message);
2084 /* Various "encrypted" comparisons. If the second string starts with
2085 "{" then an encryption type is given. Default to crypt() or crypt16()
2086 (build-time choice). */
2089 #ifndef SUPPORT_CRYPTEQ
2090 goto COND_FAILED_NOT_COMPILED;
2092 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2094 int sublen = Ustrlen(sub[1]+5);
2099 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2101 /* If the length that we are comparing against is 24, the MD5 digest
2102 is expressed as a base64 string. This is the way LDAP does it. However,
2103 some other software uses a straightforward hex representation. We assume
2104 this if the length is 32. Other lengths fail. */
2108 uschar *coded = auth_b64encode((uschar *)digest, 16);
2109 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2110 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2111 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2113 else if (sublen == 32)
2117 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2119 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2120 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2121 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2125 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2126 "fail\n crypted=%s\n", sub[1]+5);
2131 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2133 int sublen = Ustrlen(sub[1]+6);
2138 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2140 /* If the length that we are comparing against is 28, assume the SHA1
2141 digest is expressed as a base64 string. If the length is 40, assume a
2142 straightforward hex representation. Other lengths fail. */
2146 uschar *coded = auth_b64encode((uschar *)digest, 20);
2147 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2148 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2149 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2151 else if (sublen == 40)
2155 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2157 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2158 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2159 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2163 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2164 "fail\n crypted=%s\n", sub[1]+6);
2169 else /* {crypt} or {crypt16} and non-{ at start */
2174 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2179 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2184 else if (sub[1][0] == '{')
2186 expand_string_message = string_sprintf("unknown encryption mechanism "
2187 "in \"%s\"", sub[1]);
2193 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2194 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2195 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2199 #define XSTR(s) STR(s)
2200 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2201 " subject=%s\n crypted=%s\n",
2202 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2207 /* If the encrypted string contains fewer than two characters (for the
2208 salt), force failure. Otherwise we get false positives: with an empty
2209 string the yield of crypt() is an empty string! */
2211 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2212 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2215 #endif /* SUPPORT_CRYPTEQ */
2216 } /* Switch for comparison conditions */
2218 return s; /* End of comparison conditions */
2221 /* and/or: computes logical and/or of several conditions */
2225 subcondptr = (yield == NULL)? NULL : &tempcond;
2226 combined_cond = (cond_type == ECOND_AND);
2228 while (isspace(*s)) s++;
2229 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2233 while (isspace(*s)) s++;
2234 if (*s == '}') break;
2237 expand_string_message = string_sprintf("each subcondition "
2238 "inside an \"%s{...}\" condition must be in its own {}", name);
2242 s = eval_condition(s+1, subcondptr);
2245 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2246 expand_string_message, name);
2249 while (isspace(*s)) s++;
2253 expand_string_message = string_sprintf("missing } at end of condition "
2254 "inside \"%s\" group", name);
2260 if (cond_type == ECOND_AND)
2262 combined_cond &= tempcond;
2263 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2264 } /* evaluate any more */
2267 combined_cond |= tempcond;
2268 if (combined_cond) subcondptr = NULL; /* once true, don't */
2269 } /* evaluate any more */
2273 if (yield != NULL) *yield = (combined_cond == testfor);
2277 /* Unknown condition */
2280 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2282 } /* End switch on condition type */
2284 /* Missing braces at start and end of data */
2286 COND_FAILED_CURLY_START:
2287 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2290 COND_FAILED_CURLY_END:
2291 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2295 /* A condition requires code that is not compiled */
2297 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2298 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2299 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2300 COND_FAILED_NOT_COMPILED:
2301 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2310 /*************************************************
2311 * Save numerical variables *
2312 *************************************************/
2314 /* This function is called from items such as "if" that want to preserve and
2315 restore the numbered variables.
2318 save_expand_string points to an array of pointers to set
2319 save_expand_nlength points to an array of ints for the lengths
2321 Returns: the value of expand max to save
2325 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2328 for (i = 0; i <= expand_nmax; i++)
2330 save_expand_nstring[i] = expand_nstring[i];
2331 save_expand_nlength[i] = expand_nlength[i];
2338 /*************************************************
2339 * Restore numerical variables *
2340 *************************************************/
2342 /* This function restored saved values of numerical strings.
2345 save_expand_nmax the number of strings to restore
2346 save_expand_string points to an array of pointers
2347 save_expand_nlength points to an array of ints
2353 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2354 int *save_expand_nlength)
2357 expand_nmax = save_expand_nmax;
2358 for (i = 0; i <= expand_nmax; i++)
2360 expand_nstring[i] = save_expand_nstring[i];
2361 expand_nlength[i] = save_expand_nlength[i];
2369 /*************************************************
2370 * Handle yes/no substrings *
2371 *************************************************/
2373 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2374 alternative substrings that depend on whether or not the condition was true,
2375 or the lookup or extraction succeeded. The substrings always have to be
2376 expanded, to check their syntax, but "skipping" is set when the result is not
2377 needed - this avoids unnecessary nested lookups.
2380 skipping TRUE if we were skipping when this item was reached
2381 yes TRUE if the first string is to be used, else use the second
2382 save_lookup a value to put back into lookup_value before the 2nd expansion
2383 sptr points to the input string pointer
2384 yieldptr points to the output string pointer
2385 sizeptr points to the output string size
2386 ptrptr points to the output string pointer
2387 type "lookup" or "if" or "extract" or "run", for error message
2389 Returns: 0 OK; lookup_value has been reset to save_lookup
2391 2 expansion failed because of bracketing error
2395 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2396 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2399 uschar *s = *sptr; /* Local value */
2400 uschar *sub1, *sub2;
2402 /* If there are no following strings, we substitute the contents of $value for
2403 lookups and for extractions in the success case. For the ${if item, the string
2404 "true" is substituted. In the fail case, nothing is substituted for all three
2407 while (isspace(*s)) s++;
2412 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2416 if (yes && lookup_value != NULL)
2417 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2418 Ustrlen(lookup_value));
2419 lookup_value = save_lookup;
2425 /* The first following string must be braced. */
2427 if (*s++ != '{') goto FAILED_CURLY;
2429 /* Expand the first substring. Forced failures are noticed only if we actually
2430 want this string. Set skipping in the call in the fail case (this will always
2431 be the case if we were already skipping). */
2433 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2434 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2435 expand_string_forcedfail = FALSE;
2436 if (*s++ != '}') goto FAILED_CURLY;
2438 /* If we want the first string, add it to the output */
2441 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2443 /* If this is called from a lookup or an extract, we want to restore $value to
2444 what it was at the start of the item, so that it has this value during the
2445 second string expansion. For the call from "if" or "run" to this function,
2446 save_lookup is set to lookup_value, so that this statement does nothing. */
2448 lookup_value = save_lookup;
2450 /* There now follows either another substring, or "fail", or nothing. This
2451 time, forced failures are noticed only if we want the second string. We must
2452 set skipping in the nested call if we don't want this string, or if we were
2453 already skipping. */
2455 while (isspace(*s)) s++;
2458 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2459 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2460 expand_string_forcedfail = FALSE;
2461 if (*s++ != '}') goto FAILED_CURLY;
2463 /* If we want the second string, add it to the output */
2466 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2469 /* If there is no second string, but the word "fail" is present when the use of
2470 the second string is wanted, set a flag indicating it was a forced failure
2471 rather than a syntactic error. Swallow the terminating } in case this is nested
2472 inside another lookup or if or extract. */
2477 s = read_name(name, sizeof(name), s, US"_");
2478 if (Ustrcmp(name, "fail") == 0)
2480 if (!yes && !skipping)
2482 while (isspace(*s)) s++;
2483 if (*s++ != '}') goto FAILED_CURLY;
2484 expand_string_message =
2485 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2486 expand_string_forcedfail = TRUE;
2492 expand_string_message =
2493 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2498 /* All we have to do now is to check on the final closing brace. */
2500 while (isspace(*s)) s++;
2501 if (*s++ == '}') goto RETURN;
2503 /* Get here if there is a bracketing failure */
2508 /* Get here for other failures */
2513 /* Update the input pointer value before returning */
2523 /*************************************************
2524 * Handle MD5 or SHA-1 computation for HMAC *
2525 *************************************************/
2527 /* These are some wrapping functions that enable the HMAC code to be a bit
2528 cleaner. A good compiler will spot the tail recursion.
2531 type HMAC_MD5 or HMAC_SHA1
2532 remaining are as for the cryptographic hash functions
2538 chash_start(int type, void *base)
2540 if (type == HMAC_MD5)
2541 md5_start((md5 *)base);
2543 sha1_start((sha1 *)base);
2547 chash_mid(int type, void *base, uschar *string)
2549 if (type == HMAC_MD5)
2550 md5_mid((md5 *)base, string);
2552 sha1_mid((sha1 *)base, string);
2556 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2558 if (type == HMAC_MD5)
2559 md5_end((md5 *)base, string, length, digest);
2561 sha1_end((sha1 *)base, string, length, digest);
2568 /********************************************************
2569 * prvs: Get last three digits of days since Jan 1, 1970 *
2570 ********************************************************/
2572 /* This is needed to implement the "prvs" BATV reverse
2575 Argument: integer "days" offset to add or substract to
2576 or from the current number of days.
2578 Returns: pointer to string containing the last three
2579 digits of the number of days since Jan 1, 1970,
2580 modified by the offset argument, NULL if there
2581 was an error in the conversion.
2586 prvs_daystamp(int day_offset)
2588 uschar *days = store_get(32); /* Need at least 24 for cases */
2589 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2590 (time(NULL) + day_offset*86400)/86400);
2591 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2596 /********************************************************
2597 * prvs: perform HMAC-SHA1 computation of prvs bits *
2598 ********************************************************/
2600 /* This is needed to implement the "prvs" BATV reverse
2604 address RFC2821 Address to use
2605 key The key to use (must be less than 64 characters
2607 key_num Single-digit key number to use. Defaults to
2610 Returns: pointer to string containing the first three
2611 bytes of the final hash in hex format, NULL if
2612 there was an error in the process.
2616 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2618 uschar *hash_source, *p;
2619 int size = 0,offset = 0,i;
2621 void *use_base = &sha1_base;
2622 uschar innerhash[20];
2623 uschar finalhash[20];
2624 uschar innerkey[64];
2625 uschar outerkey[64];
2626 uschar *finalhash_hex = store_get(40);
2628 if (key_num == NULL)
2631 if (Ustrlen(key) > 64)
2634 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2635 string_cat(hash_source,&size,&offset,daystamp,3);
2636 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2637 hash_source[offset] = '\0';
2639 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2641 memset(innerkey, 0x36, 64);
2642 memset(outerkey, 0x5c, 64);
2644 for (i = 0; i < Ustrlen(key); i++)
2646 innerkey[i] ^= key[i];
2647 outerkey[i] ^= key[i];
2650 chash_start(HMAC_SHA1, use_base);
2651 chash_mid(HMAC_SHA1, use_base, innerkey);
2652 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2654 chash_start(HMAC_SHA1, use_base);
2655 chash_mid(HMAC_SHA1, use_base, outerkey);
2656 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2659 for (i = 0; i < 3; i++)
2661 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2662 *p++ = hex_digits[finalhash[i] & 0x0f];
2666 return finalhash_hex;
2672 /*************************************************
2673 * Join a file onto the output string *
2674 *************************************************/
2676 /* This is used for readfile and after a run expansion. It joins the contents
2677 of a file onto the output string, globally replacing newlines with a given
2678 string (optionally). The file is closed at the end.
2682 yield pointer to the expandable string
2683 sizep pointer to the current size
2684 ptrp pointer to the current position
2685 eol newline replacement string, or NULL
2687 Returns: new value of string pointer
2691 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2694 uschar buffer[1024];
2696 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2698 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2700 int len = Ustrlen(buffer);
2701 if (eol != NULL && buffer[len-1] == '\n') len--;
2702 yield = string_cat(yield, sizep, ptrp, buffer, len);
2703 if (buffer[len] != 0)
2704 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2707 if (yield != NULL) yield[*ptrp] = 0;
2715 /*************************************************
2716 * Evaluate numeric expression *
2717 *************************************************/
2719 /* This is a set of mutually recursive functions that evaluate a simple
2720 arithmetic expression involving only + - * / and parentheses. The only one that
2721 is called from elsewhere is eval_expr, whose interface is:
2724 sptr pointer to the pointer to the string - gets updated
2725 decimal TRUE if numbers are to be assumed decimal
2726 error pointer to where to put an error message - must be NULL on input
2727 endket TRUE if ')' must terminate - FALSE for external call
2730 Returns: on success: the value of the expression, with *error still NULL
2731 on failure: an undefined value, with *error = a message
2734 static int eval_sumterm(uschar **, BOOL, uschar **);
2737 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2740 int x = eval_sumterm(&s, decimal, error);
2743 while (*s == '+' || *s == '-')
2746 int y = eval_sumterm(&s, decimal, error);
2747 if (*error != NULL) break;
2748 if (op == '+') x += y; else x -= y;
2755 *error = US"expecting closing parenthesis";
2757 while (isspace(*(++s)));
2759 else if (*s != 0) *error = US"expecting + or -";
2768 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2773 while (isspace(*s)) s++;
2775 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2778 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2780 if (tolower(*s) == 'k') { n *= 1024; s++; }
2781 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2782 while (isspace (*s)) s++;
2787 n = eval_expr(&s, decimal, error, 1);
2791 *error = US"expecting number or opening parenthesis";
2798 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2801 int x = eval_term(&s, decimal, error);
2804 while (*s == '*' || *s == '/' || *s == '%')
2807 int y = eval_term(&s, decimal, error);
2808 if (*error != NULL) break;
2809 if (op == '*') x *= y;
2810 else if (op == '/') x /= y;
2821 /*************************************************
2823 *************************************************/
2825 /* Returns either an unchanged string, or the expanded string in stacking pool
2826 store. Interpreted sequences are:
2828 \... normal escaping rules
2829 $name substitutes the variable
2831 ${op:string} operates on the expanded string value
2832 ${item{arg1}{arg2}...} expands the args and then does the business
2833 some literal args are not enclosed in {}
2835 There are now far too many operators and item types to make it worth listing
2836 them here in detail any more.
2838 We use an internal routine recursively to handle embedded substrings. The
2839 external function follows. The yield is NULL if the expansion failed, and there
2840 are two cases: if something collapsed syntactically, or if "fail" was given
2841 as the action on a lookup failure. These can be distinguised by looking at the
2842 variable expand_string_forcedfail, which is TRUE in the latter case.
2844 The skipping flag is set true when expanding a substring that isn't actually
2845 going to be used (after "if" or "lookup") and it prevents lookups from
2846 happening lower down.
2848 Store usage: At start, a store block of the length of the input plus 64
2849 is obtained. This is expanded as necessary by string_cat(), which might have to
2850 get a new block, or might be able to expand the original. At the end of the
2851 function we can release any store above that portion of the yield block that
2852 was actually used. In many cases this will be optimal.
2854 However: if the first item in the expansion is a variable name or header name,
2855 we reset the store before processing it; if the result is in fresh store, we
2856 use that without copying. This is helpful for expanding strings like
2857 $message_headers which can get very long.
2860 string the string to be expanded
2861 ket_ends true if expansion is to stop at }
2862 left if not NULL, a pointer to the first character after the
2863 expansion is placed here (typically used with ket_ends)
2864 skipping TRUE for recursive calls when the value isn't actually going
2865 to be used (to allow for optimisation)
2867 Returns: NULL if expansion fails:
2868 expand_string_forcedfail is set TRUE if failure was forced
2869 expand_string_message contains a textual error message
2870 a pointer to the expanded string on success
2874 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2878 int size = Ustrlen(string)+ 64;
2880 uschar *yield = store_get(size);
2882 uschar *save_expand_nstring[EXPAND_MAXN+1];
2883 int save_expand_nlength[EXPAND_MAXN+1];
2885 expand_string_forcedfail = FALSE;
2886 expand_string_message = US"";
2893 /* \ escapes the next character, which must exist, or else
2894 the expansion fails. There's a special escape, \N, which causes
2895 copying of the subject verbatim up to the next \N. Otherwise,
2896 the escapes are the standard set. */
2902 expand_string_message = US"\\ at end of string";
2909 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2910 yield = string_cat(yield, &size, &ptr, t, s - t);
2911 if (*s != 0) s += 2;
2917 ch[0] = string_interpret_escape(&s);
2919 yield = string_cat(yield, &size, &ptr, ch, 1);
2925 /* Anything other than $ is just copied verbatim, unless we are
2926 looking for a terminating } character. */
2928 if (ket_ends && *s == '}') break;
2932 yield = string_cat(yield, &size, &ptr, s++, 1);
2936 /* No { after the $ - must be a plain name or a number for string
2937 match variable. There has to be a fudge for variables that are the
2938 names of header fields preceded by "$header_" because header field
2939 names can contain any printing characters except space and colon.
2940 For those that don't like typing this much, "$h_" is a synonym for
2941 "$header_". A non-existent header yields a NULL value; nothing is
2944 if (isalpha((*(++s))))
2949 s = read_name(name, sizeof(name), s, US"_");
2951 /* If this is the first thing to be expanded, release the pre-allocated
2954 if (ptr == 0 && yield != NULL)
2963 if (Ustrncmp(name, "h_", 2) == 0 ||
2964 Ustrncmp(name, "rh_", 3) == 0 ||
2965 Ustrncmp(name, "bh_", 3) == 0 ||
2966 Ustrncmp(name, "header_", 7) == 0 ||
2967 Ustrncmp(name, "rheader_", 8) == 0 ||
2968 Ustrncmp(name, "bheader_", 8) == 0)
2970 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2971 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2972 s = read_header_name(name, sizeof(name), s);
2973 value = find_header(name, FALSE, &newsize, want_raw, charset);
2975 /* If we didn't find the header, and the header contains a closing brace
2976 characters, this may be a user error where the terminating colon
2977 has been omitted. Set a flag to adjust the error message in this case.
2978 But there is no error here - nothing gets inserted. */
2982 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2991 value = find_variable(name, FALSE, skipping, &newsize);
2994 expand_string_message =
2995 string_sprintf("unknown variable name \"%s\"", name);
2996 check_variable_error_message(name);
3001 /* If the data is known to be in a new buffer, newsize will be set to the
3002 size of that buffer. If this is the first thing in an expansion string,
3003 yield will be NULL; just point it at the new store instead of copying. Many
3004 expansion strings contain just one reference, so this is a useful
3005 optimization, especially for humungous headers. */
3007 len = Ustrlen(value);
3008 if (yield == NULL && newsize != 0)
3014 else yield = string_cat(yield, &size, &ptr, value, len);
3022 s = read_number(&n, s);
3023 if (n >= 0 && n <= expand_nmax)
3024 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3029 /* Otherwise, if there's no '{' after $ it's an error. */
3033 expand_string_message = US"$ not followed by letter, digit, or {";
3037 /* After { there can be various things, but they all start with
3038 an initial word, except for a number for a string match variable. */
3040 if (isdigit((*(++s))))
3043 s = read_number(&n, s);
3046 expand_string_message = US"} expected after number";
3049 if (n >= 0 && n <= expand_nmax)
3050 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3057 expand_string_message = US"letter or digit expected after ${";
3061 /* Allow "-" in names to cater for substrings with negative
3062 arguments. Since we are checking for known names after { this is
3065 s = read_name(name, sizeof(name), s, US"_-");
3066 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3070 /* Handle conditionals - preserve the values of the numerical expansion
3071 variables in case they get changed by a regular expression match in the
3072 condition. If not, they retain their external settings. At the end
3073 of this "if" section, they get restored to their previous values. */
3079 int save_expand_nmax =
3080 save_expand_strings(save_expand_nstring, save_expand_nlength);
3082 while (isspace(*s)) s++;
3083 next_s = eval_condition(s, skipping? NULL : &cond);
3084 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3087 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3088 cond? "true" : "false");
3092 /* The handling of "yes" and "no" result strings is now in a separate
3093 function that is also used by ${lookup} and ${extract} and ${run}. */
3095 switch(process_yesno(
3096 skipping, /* were previously skipping */
3097 cond, /* success/failure indicator */
3098 lookup_value, /* value to reset for string2 */
3099 &s, /* input pointer */
3100 &yield, /* output pointer */
3101 &size, /* output size */
3102 &ptr, /* output current point */
3103 US"if")) /* condition type */
3105 case 1: goto EXPAND_FAILED; /* when all is well, the */
3106 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3109 /* Restore external setting of expansion variables for continuation
3112 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3113 save_expand_nlength);
3117 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3118 expanding an internal string that isn't actually going to be used. All we
3119 need to do is check the syntax, so don't do a lookup at all. Preserve the
3120 values of the numerical expansion variables in case they get changed by a
3121 partial lookup. If not, they retain their external settings. At the end
3122 of this "lookup" section, they get restored to their previous values. */
3126 int stype, partial, affixlen, starflags;
3127 int expand_setup = 0;
3129 uschar *key, *filename, *affix;
3130 uschar *save_lookup_value = lookup_value;
3131 int save_expand_nmax =
3132 save_expand_strings(save_expand_nstring, save_expand_nlength);
3134 if ((expand_forbid & RDO_LOOKUP) != 0)
3136 expand_string_message = US"lookup expansions are not permitted";
3140 /* Get the key we are to look up for single-key+file style lookups.
3141 Otherwise set the key NULL pro-tem. */
3143 while (isspace(*s)) s++;
3146 key = expand_string_internal(s+1, TRUE, &s, skipping);
3147 if (key == NULL) goto EXPAND_FAILED;
3148 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3149 while (isspace(*s)) s++;
3153 /* Find out the type of database */
3157 expand_string_message = US"missing lookup type";
3161 /* The type is a string that may contain special characters of various
3162 kinds. Allow everything except space or { to appear; the actual content
3163 is checked by search_findtype_partial. */
3165 while (*s != 0 && *s != '{' && !isspace(*s))
3167 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3171 while (isspace(*s)) s++;
3173 /* Now check for the individual search type and any partial or default
3174 options. Only those types that are actually in the binary are valid. */
3176 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3180 expand_string_message = search_error_message;
3184 /* Check that a key was provided for those lookup types that need it,
3185 and was not supplied for those that use the query style. */
3187 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3191 expand_string_message = string_sprintf("missing {key} for single-"
3192 "key \"%s\" lookup", name);
3200 expand_string_message = string_sprintf("a single key was given for "
3201 "lookup type \"%s\", which is not a single-key lookup type", name);
3206 /* Get the next string in brackets and expand it. It is the file name for
3207 single-key+file lookups, and the whole query otherwise. In the case of
3208 queries that also require a file name (e.g. sqlite), the file name comes
3211 if (*s != '{') goto EXPAND_FAILED_CURLY;
3212 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3213 if (filename == NULL) goto EXPAND_FAILED;
3214 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3215 while (isspace(*s)) s++;
3217 /* If this isn't a single-key+file lookup, re-arrange the variables
3218 to be appropriate for the search_ functions. For query-style lookups,
3219 there is just a "key", and no file name. For the special query-style +
3220 file types, the query (i.e. "key") starts with a file name. */
3224 while (isspace(*filename)) filename++;
3227 if (mac_islookup(stype, lookup_querystyle))
3233 if (*filename != '/')
3235 expand_string_message = string_sprintf(
3236 "absolute file name expected for \"%s\" lookup", name);
3239 while (*key != 0 && !isspace(*key)) key++;
3240 if (*key != 0) *key++ = 0;
3244 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3245 the entry was not found. Note that there is no search_close() function.
3246 Files are left open in case of re-use. At suitable places in higher logic,
3247 search_tidyup() is called to tidy all open files. This can save opening
3248 the same file several times. However, files may also get closed when
3249 others are opened, if too many are open at once. The rule is that a
3250 handle should not be used after a second search_open().
3252 Request that a partial search sets up $1 and maybe $2 by passing
3253 expand_setup containing zero. If its value changes, reset expand_nmax,
3254 since new variables will have been set. Note that at the end of this
3255 "lookup" section, the old numeric variables are restored. */
3258 lookup_value = NULL;
3261 void *handle = search_open(filename, stype, 0, NULL, NULL);
3264 expand_string_message = search_error_message;
3267 lookup_value = search_find(handle, filename, key, partial, affix,
3268 affixlen, starflags, &expand_setup);
3269 if (search_find_defer)
3271 expand_string_message =
3272 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3273 search_error_message);
3276 if (expand_setup > 0) expand_nmax = expand_setup;
3279 /* The handling of "yes" and "no" result strings is now in a separate
3280 function that is also used by ${if} and ${extract}. */
3282 switch(process_yesno(
3283 skipping, /* were previously skipping */
3284 lookup_value != NULL, /* success/failure indicator */
3285 save_lookup_value, /* value to reset for string2 */
3286 &s, /* input pointer */
3287 &yield, /* output pointer */
3288 &size, /* output size */
3289 &ptr, /* output current point */
3290 US"lookup")) /* condition type */
3292 case 1: goto EXPAND_FAILED; /* when all is well, the */
3293 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3296 /* Restore external setting of expansion variables for carrying on
3297 at this level, and continue. */
3299 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3300 save_expand_nlength);
3304 /* If Perl support is configured, handle calling embedded perl subroutines,
3305 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3306 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3307 arguments (defined below). */
3309 #define EXIM_PERL_MAX_ARGS 8
3313 expand_string_message = US"\"${perl\" encountered, but this facility "
3314 "is not included in this binary";
3317 #else /* EXIM_PERL */
3319 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3322 if ((expand_forbid & RDO_PERL) != 0)
3324 expand_string_message = US"Perl calls are not permitted";
3328 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3331 case 1: goto EXPAND_FAILED_CURLY;
3333 case 3: goto EXPAND_FAILED;
3336 /* If skipping, we don't actually do anything */
3338 if (skipping) continue;
3340 /* Start the interpreter if necessary */
3342 if (!opt_perl_started)
3345 if (opt_perl_startup == NULL)
3347 expand_string_message = US"A setting of perl_startup is needed when "
3348 "using the Perl interpreter";
3351 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3352 initerror = init_perl(opt_perl_startup);
3353 if (initerror != NULL)
3355 expand_string_message =
3356 string_sprintf("error in perl_startup code: %s\n", initerror);
3359 opt_perl_started = TRUE;
3362 /* Call the function */
3364 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3365 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3366 sub_arg[0], sub_arg + 1);
3368 /* NULL yield indicates failure; if the message pointer has been set to
3369 NULL, the yield was undef, indicating a forced failure. Otherwise the
3370 message will indicate some kind of Perl error. */
3372 if (new_yield == NULL)
3374 if (expand_string_message == NULL)
3376 expand_string_message =
3377 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3378 "failure", sub_arg[0]);
3379 expand_string_forcedfail = TRUE;
3384 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3385 set during a callback from Perl. */
3387 expand_string_forcedfail = FALSE;
3391 #endif /* EXIM_PERL */
3393 /* Transform email address to "prvs" scheme to use
3394 as BATV-signed return path */
3401 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3403 case 1: goto EXPAND_FAILED_CURLY;
3405 case 3: goto EXPAND_FAILED;
3408 /* If skipping, we don't actually do anything */
3409 if (skipping) continue;
3411 /* sub_arg[0] is the address */
3412 domain = Ustrrchr(sub_arg[0],'@');
3413 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3415 expand_string_message = US"prvs first argument must be a qualified email address";
3419 /* Calculate the hash. The second argument must be a single-digit
3420 key number, or unset. */
3422 if (sub_arg[2] != NULL &&
3423 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3425 expand_string_message = US"prvs second argument must be a single digit";
3429 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3432 expand_string_message = US"prvs hmac-sha1 conversion failed";
3436 /* Now separate the domain from the local part */
3439 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3440 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3441 string_cat(yield,&size,&ptr,US"/",1);
3442 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3443 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3444 string_cat(yield,&size,&ptr,p,6);
3445 string_cat(yield,&size,&ptr,US"@",1);
3446 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3451 /* Check a prvs-encoded address for validity */
3453 case EITEM_PRVSCHECK:
3456 int mysize = 0, myptr = 0;
3460 /* TF: Ugliness: We want to expand parameter 1 first, then set
3461 up expansion variables that are used in the expansion of
3462 parameter 2. So we clone the string for the first
3463 expansion, where we only expand parameter 1.
3465 PH: Actually, that isn't necessary. The read_subs() function is
3466 designed to work this way for the ${if and ${lookup expansions. I've
3470 /* Reset expansion variables */
3471 prvscheck_result = NULL;
3472 prvscheck_address = NULL;
3473 prvscheck_keynum = NULL;
3475 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3477 case 1: goto EXPAND_FAILED_CURLY;
3479 case 3: goto EXPAND_FAILED;
3482 re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3485 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3487 uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3488 uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3489 uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3490 uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3491 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3493 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3494 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3495 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3496 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3497 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3499 /* Set up expansion variables */
3500 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3501 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3502 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3503 prvscheck_address[myptr] = '\0';
3504 prvscheck_keynum = string_copy(key_num);
3506 /* Now expand the second argument */
3507 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3509 case 1: goto EXPAND_FAILED_CURLY;
3511 case 3: goto EXPAND_FAILED;
3514 /* Now we have the key and can check the address. */
3516 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3521 expand_string_message = US"hmac-sha1 conversion failed";
3525 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3526 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3528 if (Ustrcmp(p,hash) == 0)
3530 /* Success, valid BATV address. Now check the expiry date. */
3531 uschar *now = prvs_daystamp(0);
3532 unsigned int inow = 0,iexpire = 1;
3534 (void)sscanf(CS now,"%u",&inow);
3535 (void)sscanf(CS daystamp,"%u",&iexpire);
3537 /* When "iexpire" is < 7, a "flip" has occured.
3538 Adjust "inow" accordingly. */
3539 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3543 prvscheck_result = US"1";
3544 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3548 prvscheck_result = NULL;
3549 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3554 prvscheck_result = NULL;
3555 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3558 /* Now expand the final argument. We leave this till now so that
3559 it can include $prvscheck_result. */
3561 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3563 case 1: goto EXPAND_FAILED_CURLY;
3565 case 3: goto EXPAND_FAILED;
3568 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3569 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3571 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3573 /* Reset the "internal" variables afterwards, because they are in
3574 dynamic store that will be reclaimed if the expansion succeeded. */
3576 prvscheck_address = NULL;
3577 prvscheck_keynum = NULL;
3581 /* Does not look like a prvs encoded address, return the empty string.
3582 We need to make sure all subs are expanded first, so as to skip over
3585 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3587 case 1: goto EXPAND_FAILED_CURLY;
3589 case 3: goto EXPAND_FAILED;
3596 /* Handle "readfile" to insert an entire file */
3598 case EITEM_READFILE:
3603 if ((expand_forbid & RDO_READFILE) != 0)
3605 expand_string_message = US"file insertions are not permitted";
3609 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3611 case 1: goto EXPAND_FAILED_CURLY;
3613 case 3: goto EXPAND_FAILED;
3616 /* If skipping, we don't actually do anything */
3618 if (skipping) continue;
3620 /* Open the file and read it */
3622 f = Ufopen(sub_arg[0], "rb");
3625 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3629 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3634 /* Handle "readsocket" to insert data from a Unix domain socket */
3636 case EITEM_READSOCK:
3642 struct sockaddr_un sockun; /* don't call this "sun" ! */
3646 if ((expand_forbid & RDO_READSOCK) != 0)
3648 expand_string_message = US"socket insertions are not permitted";
3652 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3653 because there may be a string for expansion on failure. */
3655 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3657 case 1: goto EXPAND_FAILED_CURLY;
3658 case 2: /* Won't occur: no end check */
3659 case 3: goto EXPAND_FAILED;
3662 /* Sort out timeout, if given */
3664 if (sub_arg[2] != NULL)
3666 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3669 expand_string_message = string_sprintf("bad time value %s",
3674 else sub_arg[3] = NULL; /* No eol if no timeout */
3676 /* If skipping, we don't actually do anything. Otherwise, arrange to
3677 connect to either an IP or a Unix socket. */
3681 /* Handle an IP (internet) domain */
3683 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
3685 BOOL connected = FALSE;
3689 uschar *server_name = sub_arg[0] + 5;
3690 uschar *port_name = Ustrrchr(server_name, ':');
3692 /* Sort out the port */
3694 if (port_name == NULL)
3696 expand_string_message =
3697 string_sprintf("missing port for readsocket %s", sub_arg[0]);
3700 *port_name++ = 0; /* Terminate server name */
3702 if (isdigit(*port_name))
3705 port = Ustrtol(port_name, &end, 0);
3706 if (end != port_name + Ustrlen(port_name))
3708 expand_string_message =
3709 string_sprintf("invalid port number %s", port_name);
3715 struct servent *service_info = getservbyname(CS port_name, "tcp");
3716 if (service_info == NULL)
3718 expand_string_message = string_sprintf("unknown port \"%s\"",
3722 port = ntohs(service_info->s_port);
3725 /* Sort out the server. */
3728 shost.address = NULL;
3732 namelen = Ustrlen(server_name);
3734 /* Anything enclosed in [] must be an IP address. */
3736 if (server_name[0] == '[' &&
3737 server_name[namelen - 1] == ']')
3739 server_name[namelen - 1] = 0;
3741 if (string_is_ip_address(server_name, NULL) == 0)
3743 expand_string_message =
3744 string_sprintf("malformed IP address \"%s\"", server_name);
3747 shost.name = shost.address = server_name;
3750 /* Otherwise check for an unadorned IP address */
3752 else if (string_is_ip_address(server_name, NULL) != 0)
3753 shost.name = shost.address = server_name;
3755 /* Otherwise lookup IP address(es) from the name */
3759 shost.name = server_name;
3760 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
3761 FALSE) != HOST_FOUND)
3763 expand_string_message =
3764 string_sprintf("no IP address found for host %s", shost.name);
3769 /* Try to connect to the server - test each IP till one works */
3771 for (h = &shost; h != NULL; h = h->next)
3773 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
3774 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
3776 expand_string_message = string_sprintf("failed to create socket: "
3777 "%s", strerror(errno));
3781 if (ip_connect(fd, af, h->address, port, timeout) == 0)
3790 expand_string_message = string_sprintf("failed to connect to "
3791 "socket %s: couldn't connect to any host", sub_arg[0],
3797 /* Handle a Unix domain socket */
3801 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3803 expand_string_message = string_sprintf("failed to create socket: %s",
3808 sockun.sun_family = AF_UNIX;
3809 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3811 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3813 expand_string_message = string_sprintf("failed to connect to socket "
3814 "%s: %s", sub_arg[0], strerror(errno));
3819 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3821 /* Write the request string, if not empty */
3823 if (sub_arg[1][0] != 0)
3825 int len = Ustrlen(sub_arg[1]);
3826 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3828 if (write(fd, sub_arg[1], len) != len)
3830 expand_string_message = string_sprintf("request write to socket "
3831 "failed: %s", strerror(errno));
3836 /* Now we need to read from the socket, under a timeout. The function
3837 that reads a file can be used. */
3839 f = fdopen(fd, "rb");
3840 sigalrm_seen = FALSE;
3842 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3846 /* After a timeout, we restore the pointer in the result, that is,
3847 make sure we add nothing from the socket. */
3852 expand_string_message = US "socket read timed out";
3857 /* The whole thing has worked (or we were skipping). If there is a
3858 failure string following, we need to skip it. */
3862 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3864 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3865 while (isspace(*s)) s++;
3867 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3870 /* Come here on failure to create socket, connect socket, write to the
3871 socket, or timeout on reading. If another substring follows, expand and
3872 use it. Otherwise, those conditions give expand errors. */
3875 if (*s != '{') goto EXPAND_FAILED;
3876 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3877 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3878 if (arg == NULL) goto EXPAND_FAILED;
3879 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3880 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3881 while (isspace(*s)) s++;
3882 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3886 /* Handle "run" to execute a program. */
3898 if ((expand_forbid & RDO_RUN) != 0)
3900 expand_string_message = US"running a command is not permitted";
3904 while (isspace(*s)) s++;
3905 if (*s != '{') goto EXPAND_FAILED_CURLY;
3906 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3907 if (arg == NULL) goto EXPAND_FAILED;
3908 while (isspace(*s)) s++;
3909 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3911 if (skipping) /* Just pretend it worked when we're skipping */
3917 if (!transport_set_up_command(&argv, /* anchor for arg list */
3918 arg, /* raw command */
3919 FALSE, /* don't expand the arguments */
3920 0, /* not relevant when... */
3921 NULL, /* no transporting address */
3922 US"${run} expansion", /* for error messages */
3923 &expand_string_message)) /* where to put error message */
3928 /* Create the child process, making it a group leader. */
3930 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3934 expand_string_message =
3935 string_sprintf("couldn't create child process: %s", strerror(errno));
3939 /* Nothing is written to the standard input. */
3943 /* Wait for the process to finish, applying the timeout, and inspect its
3944 return code for serious disasters. Simple non-zero returns are passed on.
3947 if ((runrc = child_close(pid, 60)) < 0)
3951 expand_string_message = string_sprintf("command timed out");
3952 killpg(pid, SIGKILL); /* Kill the whole process group */
3955 else if (runrc == -257)
3956 expand_string_message = string_sprintf("wait() failed: %s",
3960 expand_string_message = string_sprintf("command killed by signal %d",
3966 /* Read the pipe to get the command's output into $value (which is kept
3967 in lookup_value). */
3969 f = fdopen(fd_out, "rb");
3970 lookup_value = NULL;
3971 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3975 /* Process the yes/no strings; $value may be useful in both cases */
3977 switch(process_yesno(
3978 skipping, /* were previously skipping */
3979 runrc == 0, /* success/failure indicator */
3980 lookup_value, /* value to reset for string2 */
3981 &s, /* input pointer */
3982 &yield, /* output pointer */
3983 &size, /* output size */
3984 &ptr, /* output current point */
3985 US"run")) /* condition type */
3987 case 1: goto EXPAND_FAILED; /* when all is well, the */
3988 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3994 /* Handle character translation for "tr" */
4002 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4004 case 1: goto EXPAND_FAILED_CURLY;
4006 case 3: goto EXPAND_FAILED;
4009 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4010 o2m = Ustrlen(sub[2]) - 1;
4012 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4014 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4018 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4025 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4026 expanded arguments. */
4036 int val[2] = { 0, -1 };
4039 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4040 Ensure that sub[2] is set in the ${length case. */
4043 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4046 case 1: goto EXPAND_FAILED_CURLY;
4048 case 3: goto EXPAND_FAILED;
4051 /* Juggle the arguments if there are only two of them: always move the
4052 string to the last position and make ${length{n}{str}} equivalent to
4053 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4059 if (item_type == EITEM_LENGTH)
4066 for (i = 0; i < 2; i++)
4068 if (sub[i] == NULL) continue;
4069 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4070 if (*ret != 0 || (i != 0 && val[i] < 0))
4072 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4073 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4079 (item_type == EITEM_HASH)?
4080 compute_hash(sub[2], val[0], val[1], &len) :
4081 (item_type == EITEM_NHASH)?
4082 compute_nhash(sub[2], val[0], val[1], &len) :
4083 extract_substr(sub[2], val[0], val[1], &len);
4085 if (ret == NULL) goto EXPAND_FAILED;
4086 yield = string_cat(yield, &size, &ptr, ret, len);
4090 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4091 This code originally contributed by Steve Haslam. It currently supports
4092 the use of MD5 and SHA-1 hashes.
4094 We need some workspace that is large enough to handle all the supported
4095 hash types. Use macros to set the sizes rather than be too elaborate. */
4097 #define MAX_HASHLEN 20
4098 #define MAX_HASHBLOCKLEN 64
4107 int hashlen; /* Number of octets for the hash algorithm's output */
4108 int hashblocklen; /* Number of octets the hash algorithm processes */
4110 unsigned int keylen;
4112 uschar keyhash[MAX_HASHLEN];
4113 uschar innerhash[MAX_HASHLEN];
4114 uschar finalhash[MAX_HASHLEN];
4115 uschar finalhash_hex[2*MAX_HASHLEN];
4116 uschar innerkey[MAX_HASHBLOCKLEN];
4117 uschar outerkey[MAX_HASHBLOCKLEN];
4119 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4121 case 1: goto EXPAND_FAILED_CURLY;
4123 case 3: goto EXPAND_FAILED;
4126 if (Ustrcmp(sub[0], "md5") == 0)
4129 use_base = &md5_base;
4133 else if (Ustrcmp(sub[0], "sha1") == 0)
4136 use_base = &sha1_base;
4142 expand_string_message =
4143 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4148 keylen = Ustrlen(keyptr);
4150 /* If the key is longer than the hash block length, then hash the key
4153 if (keylen > hashblocklen)
4155 chash_start(type, use_base);
4156 chash_end(type, use_base, keyptr, keylen, keyhash);
4161 /* Now make the inner and outer key values */
4163 memset(innerkey, 0x36, hashblocklen);
4164 memset(outerkey, 0x5c, hashblocklen);
4166 for (i = 0; i < keylen; i++)
4168 innerkey[i] ^= keyptr[i];
4169 outerkey[i] ^= keyptr[i];
4172 /* Now do the hashes */
4174 chash_start(type, use_base);
4175 chash_mid(type, use_base, innerkey);
4176 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4178 chash_start(type, use_base);
4179 chash_mid(type, use_base, outerkey);
4180 chash_end(type, use_base, innerhash, hashlen, finalhash);
4182 /* Encode the final hash as a hex string */
4185 for (i = 0; i < hashlen; i++)
4187 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4188 *p++ = hex_digits[finalhash[i] & 0x0f];
4191 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4192 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4194 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4199 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4200 We have to save the numerical variables and restore them afterwards. */
4205 int moffset, moffsetextra, slen;
4208 const uschar *rerror;
4211 int save_expand_nmax =
4212 save_expand_strings(save_expand_nstring, save_expand_nlength);
4214 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4216 case 1: goto EXPAND_FAILED_CURLY;
4218 case 3: goto EXPAND_FAILED;
4221 /* Compile the regular expression */
4223 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4228 expand_string_message = string_sprintf("regular expression error in "
4229 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4233 /* Now run a loop to do the substitutions as often as necessary. It ends
4234 when there are no more matches. Take care over matches of the null string;
4235 do the same thing as Perl does. */
4238 slen = Ustrlen(sub[0]);
4239 moffset = moffsetextra = 0;
4244 int ovector[3*(EXPAND_MAXN+1)];
4245 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4246 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4250 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4251 is not necessarily the end. We want to repeat the match from one
4252 character further along, but leaving the basic offset the same (for
4253 copying below). We can't be at the end of the string - that was checked
4254 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4255 finished; copy the remaining string and end the loop. */
4265 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4269 /* Match - set up for expanding the replacement. */
4271 if (n == 0) n = EXPAND_MAXN + 1;
4273 for (nn = 0; nn < n*2; nn += 2)
4275 expand_nstring[expand_nmax] = subject + ovector[nn];
4276 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4280 /* Copy the characters before the match, plus the expanded insertion. */
4282 yield = string_cat(yield, &size, &ptr, subject + moffset,
4283 ovector[0] - moffset);
4284 insert = expand_string(sub[2]);
4285 if (insert == NULL) goto EXPAND_FAILED;
4286 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4288 moffset = ovector[1];
4292 /* If we have matched an empty string, first check to see if we are at
4293 the end of the subject. If so, the loop is over. Otherwise, mimic
4294 what Perl's /g options does. This turns out to be rather cunning. First
4295 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4296 string at the same point. If this fails (picked up above) we advance to
4297 the next character. */
4299 if (ovector[0] == ovector[1])
4301 if (ovector[0] == slen) break;
4302 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4306 /* All done - restore numerical variables. */
4308 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4309 save_expand_nlength);
4313 /* Handle keyed and numbered substring extraction. If the first argument
4314 consists entirely of digits, then a numerical extraction is assumed. */
4320 int field_number = 1;
4321 BOOL field_number_set = FALSE;
4322 uschar *save_lookup_value = lookup_value;
4324 int save_expand_nmax =
4325 save_expand_strings(save_expand_nstring, save_expand_nlength);
4327 /* Read the arguments */
4329 for (i = 0; i < j; i++)
4331 while (isspace(*s)) s++;
4334 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4335 if (sub[i] == NULL) goto EXPAND_FAILED;
4336 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4338 /* After removal of leading and trailing white space, the first
4339 argument must not be empty; if it consists entirely of digits
4340 (optionally preceded by a minus sign), this is a numerical
4341 extraction, and we expect 3 arguments. */
4349 while (isspace(*p)) p++;
4353 while (len > 0 && isspace(p[len-1])) len--;
4358 expand_string_message = US"first argument of \"extract\" must "
4368 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4372 j = 3; /* Need 3 args */
4373 field_number_set = TRUE;
4377 else goto EXPAND_FAILED_CURLY;
4380 /* Extract either the numbered or the keyed substring into $value. If
4381 skipping, just pretend the extraction failed. */
4383 lookup_value = skipping? NULL : field_number_set?
4384 expand_gettokened(field_number, sub[1], sub[2]) :
4385 expand_getkeyed(sub[0], sub[1]);
4387 /* If no string follows, $value gets substituted; otherwise there can
4388 be yes/no strings, as for lookup or if. */
4390 switch(process_yesno(
4391 skipping, /* were previously skipping */
4392 lookup_value != NULL, /* success/failure indicator */
4393 save_lookup_value, /* value to reset for string2 */
4394 &s, /* input pointer */
4395 &yield, /* output pointer */
4396 &size, /* output size */
4397 &ptr, /* output current point */
4398 US"extract")) /* condition type */
4400 case 1: goto EXPAND_FAILED; /* when all is well, the */
4401 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4404 /* All done - restore numerical variables. */
4406 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4407 save_expand_nlength);
4413 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4414 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4415 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4416 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4418 #define EXPAND_DLFUNC_MAX_ARGS 8
4421 #ifndef EXPAND_DLFUNC
4422 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4423 "is not included in this binary";
4426 #else /* EXPAND_DLFUNC */
4429 exim_dlfunc_t *func;
4432 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4434 if ((expand_forbid & RDO_DLFUNC) != 0)
4436 expand_string_message =
4437 US"dynamically-loaded functions are not permitted";
4441 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4444 case 1: goto EXPAND_FAILED_CURLY;
4446 case 3: goto EXPAND_FAILED;
4449 /* If skipping, we don't actually do anything */
4451 if (skipping) continue;
4453 /* Look up the dynamically loaded object handle in the tree. If it isn't
4454 found, dlopen() the file and put the handle in the tree for next time. */
4456 t = tree_search(dlobj_anchor, argv[0]);
4459 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4462 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4463 argv[0], dlerror());
4464 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4467 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4468 Ustrcpy(t->name, argv[0]);
4469 t->data.ptr = handle;
4470 (void)tree_insertnode(&dlobj_anchor, t);
4473 /* Having obtained the dynamically loaded object handle, look up the
4474 function pointer. */
4476 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4479 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4480 "%s", argv[1], argv[0], dlerror());
4481 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4485 /* Call the function and work out what to do with the result. If it
4486 returns OK, we have a replacement string; if it returns DEFER then
4487 expansion has failed in a non-forced manner; if it returns FAIL then
4488 failure was forced; if it returns ERROR or any other value there's a
4489 problem, so panic slightly. */
4492 for (argc = 0; argv[argc] != NULL; argc++);
4493 status = func(&result, argc - 2, &argv[2]);
4496 if (result == NULL) result = US"";
4497 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4502 expand_string_message = result == NULL ? US"(no message)" : result;
4503 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4504 else if(status != FAIL)
4505 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4506 argv[0], argv[1], status, expand_string_message);
4510 #endif /* EXPAND_DLFUNC */
4513 /* Control reaches here if the name is not recognized as one of the more
4514 complicated expansion items. Check for the "operator" syntax (name terminated
4515 by a colon). Some of the operators have arguments, separated by _ from the
4522 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4523 if (sub == NULL) goto EXPAND_FAILED;
4526 /* Owing to an historical mis-design, an underscore may be part of the
4527 operator name, or it may introduce arguments. We therefore first scan the
4528 table of names that contain underscores. If there is no match, we cut off
4529 the arguments and then scan the main table. */
4531 c = chop_match(name, op_table_underscore,
4532 sizeof(op_table_underscore)/sizeof(uschar *));
4536 arg = Ustrchr(name, '_');
4537 if (arg != NULL) *arg = 0;
4538 c = chop_match(name, op_table_main,
4539 sizeof(op_table_main)/sizeof(uschar *));
4540 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4541 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
4544 /* If we are skipping, we don't need to perform the operation at all.
4545 This matters for operations like "mask", because the data may not be
4546 in the correct format when skipping. For example, the expression may test
4547 for the existence of $sender_host_address before trying to mask it. For
4548 other operations, doing them may not fail, but it is a waste of time. */
4550 if (skipping && c >= 0) continue;
4552 /* Otherwise, switch on the operator type */
4559 unsigned long int n = Ustrtoul(sub, &t, 10);
4562 expand_string_message = string_sprintf("argument for base62 "
4563 "operator is \"%s\", which is not a decimal number", sub);
4566 t = string_base62(n);
4567 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4571 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
4577 unsigned long int n = 0;
4580 uschar *t = Ustrchr(base62_chars, *tt++);
4583 expand_string_message = string_sprintf("argument for base62d "
4584 "operator is \"%s\", which is not a base %d number", sub,
4588 n = n * BASE_62 + (t - base62_chars);
4590 (void)sprintf(CS buf, "%ld", n);
4591 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4597 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4598 if (expanded == NULL)
4600 expand_string_message =
4601 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4602 expand_string_message);
4605 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4612 uschar *t = sub - 1;
4613 while (*(++t) != 0) { *t = tolower(*t); count++; }
4614 yield = string_cat(yield, &size, &ptr, sub, count);
4621 uschar *t = sub - 1;
4622 while (*(++t) != 0) { *t = toupper(*t); count++; }
4623 yield = string_cat(yield, &size, &ptr, sub, count);
4634 md5_end(&base, sub, Ustrlen(sub), digest);
4635 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4636 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4647 sha1_end(&base, sub, Ustrlen(sub), digest);
4648 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4649 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4653 /* Convert hex encoding to base64 encoding */
4663 for (enc = sub; *enc != 0; enc++)
4665 if (!isxdigit(*enc))
4667 expand_string_message = string_sprintf("\"%s\" is not a hex "
4676 expand_string_message = string_sprintf("\"%s\" contains an odd "
4677 "number of characters", sub);
4681 while ((c = *in++) != 0)
4683 if (isdigit(c)) c -= '0';
4684 else c = toupper(c) - 'A' + 10;
4696 enc = auth_b64encode(sub, out - sub);
4697 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4701 /* mask applies a mask to an IP address; for example the result of
4702 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4709 int mask, maskoffset;
4710 int type = string_is_ip_address(sub, &maskoffset);
4715 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4720 if (maskoffset == 0)
4722 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4727 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4729 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4731 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4736 /* Convert the address to binary integer(s) and apply the mask */
4738 sub[maskoffset] = 0;
4739 count = host_aton(sub, binary);
4740 host_mask(count, binary, mask);
4742 /* Convert to masked textual format and add to output. */
4744 yield = string_cat(yield, &size, &ptr, buffer,
4745 host_nmtoa(count, binary, mask, buffer, '.'));
4750 case EOP_LOCAL_PART:
4754 int start, end, domain;
4755 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4759 if (c != EOP_DOMAIN)
4761 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4762 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4764 else if (domain != 0)
4767 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4773 /* quote puts a string in quotes if it is empty or contains anything
4774 other than alphamerics, underscore, dot, or hyphen.
4776 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4777 be quoted in order to be a valid local part.
4779 In both cases, newlines and carriage returns are converted into \n and \r
4783 case EOP_QUOTE_LOCAL_PART:
4786 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4787 uschar *t = sub - 1;
4791 while (!needs_quote && *(++t) != 0)
4792 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4794 else /* EOP_QUOTE_LOCAL_PART */
4796 while (!needs_quote && *(++t) != 0)
4797 needs_quote = !isalnum(*t) &&
4798 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4799 (*t != '.' || t == sub || t[1] == 0);
4804 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4809 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4810 else if (*t == '\r')
4811 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4814 if (*t == '\\' || *t == '"')
4815 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4816 yield = string_cat(yield, &size, &ptr, t, 1);
4819 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4821 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4825 /* quote_lookuptype does lookup-specific quoting */
4830 uschar *opt = Ustrchr(arg, '_');
4832 if (opt != NULL) *opt++ = 0;
4834 n = search_findtype(arg, Ustrlen(arg));
4837 expand_string_message = search_error_message;
4841 if (lookup_list[n].quote != NULL)
4842 sub = (lookup_list[n].quote)(sub, opt);
4843 else if (opt != NULL) sub = NULL;
4847 expand_string_message = string_sprintf(
4848 "\"%s\" unrecognized after \"${quote_%s\"",
4853 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4857 /* rx quote sticks in \ before any non-alphameric character so that
4858 the insertion works in a regular expression. */
4862 uschar *t = sub - 1;
4866 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4867 yield = string_cat(yield, &size, &ptr, t, 1);
4872 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4873 prescribed by the RFC, if there are characters that need to be encoded */
4877 uschar buffer[2048];
4878 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4879 buffer, sizeof(buffer), FALSE);
4880 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4884 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4894 if (c > 255) c = '_';
4896 yield = string_cat(yield, &size, &ptr, buff, 1);
4901 /* escape turns all non-printing characters into escape sequences. */
4905 uschar *t = string_printing(sub);
4906 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4910 /* Handle numeric expression evaluation */
4915 uschar *save_sub = sub;
4916 uschar *error = NULL;
4917 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4920 expand_string_message = string_sprintf("error in expression "
4921 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4925 sprintf(CS var_buffer, "%d", n);
4926 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4930 /* Handle time period formating */
4934 int n = readconf_readtime(sub, 0, FALSE);
4937 expand_string_message = string_sprintf("string \"%s\" is not an "
4938 "Exim time interval in \"%s\" operator", sub, name);
4941 sprintf(CS var_buffer, "%d", n);
4942 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4946 case EOP_TIME_INTERVAL:
4949 uschar *t = read_number(&n, sub);
4950 if (*t != 0) /* Not A Number*/
4952 expand_string_message = string_sprintf("string \"%s\" is not a "
4953 "positive number in \"%s\" operator", sub, name);
4956 t = readconf_printtime(n);
4957 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4961 /* Convert string to base64 encoding */
4965 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4966 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4970 /* strlen returns the length of the string */
4975 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4976 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4980 /* length_n or l_n takes just the first n characters or the whole string,
4981 whichever is the shorter;
4983 substr_m_n, and s_m_n take n characters from offset m; negative m take
4984 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4985 takes the rest, either to the right or to the left.
4987 hash_n or h_n makes a hash of length n from the string, yielding n
4988 characters from the set a-z; hash_n_m makes a hash of length n, but
4989 uses m characters from the set a-zA-Z0-9.
4991 nhash_n returns a single number between 0 and n-1 (in text form), while
4992 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4993 between 0 and n-1 and the second between 0 and m-1. */
5013 expand_string_message = string_sprintf("missing values after %s",
5018 /* "length" has only one argument, effectively being synonymous with
5021 if (c == EOP_LENGTH || c == EOP_L)
5027 /* The others have one or two arguments; for "substr" the first may be
5028 negative. The second being negative means "not supplied". */
5033 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5036 /* Read up to two numbers, separated by underscores */
5041 if (arg != ret && *arg == '_' && pn == &value1)
5045 if (arg[1] != 0) arg++;
5047 else if (!isdigit(*arg))
5049 expand_string_message =
5050 string_sprintf("non-digit after underscore in \"%s\"", name);
5053 else *pn = (*pn)*10 + *arg++ - '0';
5057 /* Perform the required operation */
5060 (c == EOP_HASH || c == EOP_H)?
5061 compute_hash(sub, value1, value2, &len) :
5062 (c == EOP_NHASH || c == EOP_NH)?
5063 compute_nhash(sub, value1, value2, &len) :
5064 extract_substr(sub, value1, value2, &len);
5066 if (ret == NULL) goto EXPAND_FAILED;
5067 yield = string_cat(yield, &size, &ptr, ret, len);
5077 uschar **modetable[3];
5082 if ((expand_forbid & RDO_EXISTS) != 0)
5084 expand_string_message = US"Use of the stat() expansion is not permitted";
5088 if (stat(CS sub, &st) < 0)
5090 expand_string_message = string_sprintf("stat(%s) failed: %s",
5091 sub, strerror(errno));
5095 switch (mode & S_IFMT)
5097 case S_IFIFO: smode[0] = 'p'; break;
5098 case S_IFCHR: smode[0] = 'c'; break;
5099 case S_IFDIR: smode[0] = 'd'; break;
5100 case S_IFBLK: smode[0] = 'b'; break;
5101 case S_IFREG: smode[0] = '-'; break;
5102 default: smode[0] = '?'; break;
5105 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5106 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5107 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5109 for (i = 0; i < 3; i++)
5111 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5116 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5117 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5118 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5119 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5120 (long)st.st_gid, st.st_size, (long)st.st_atime,
5121 (long)st.st_mtime, (long)st.st_ctime);
5122 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5126 /* Unknown operator */
5129 expand_string_message =
5130 string_sprintf("unknown expansion operator \"%s\"", name);
5135 /* Handle a plain name. If this is the first thing in the expansion, release
5136 the pre-allocated buffer. If the result data is known to be in a new buffer,
5137 newsize will be set to the size of that buffer, and we can just point at that
5138 store instead of copying. Many expansion strings contain just one reference,
5139 so this is a useful optimization, especially for humungous headers
5140 ($message_headers). */
5152 value = find_variable(name, FALSE, skipping, &newsize);
5155 expand_string_message =
5156 string_sprintf("unknown variable in \"${%s}\"", name);
5157 check_variable_error_message(name);
5160 len = Ustrlen(value);
5161 if (yield == NULL && newsize != 0)
5167 else yield = string_cat(yield, &size, &ptr, value, len);
5171 /* Else there's something wrong */
5173 expand_string_message =
5174 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5175 "in a variable reference)", name);
5179 /* If we hit the end of the string when ket_ends is set, there is a missing
5180 terminating brace. */
5182 if (ket_ends && *s == 0)
5184 expand_string_message = malformed_header?
5185 US"missing } at end of string - could be header name not terminated by colon"
5187 US"missing } at end of string";
5191 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5192 added to the string. If so, set up an empty string. Add a terminating zero. If
5193 left != NULL, return a pointer to the terminator. */
5195 if (yield == NULL) yield = store_get(1);
5197 if (left != NULL) *left = s;
5199 /* Any stacking store that was used above the final string is no longer needed.
5200 In many cases the final string will be the first one that was got and so there
5201 will be optimal store usage. */
5203 store_reset(yield + ptr + 1);
5206 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5208 if (skipping) debug_printf("skipping: result is not used\n");
5212 /* This is the failure exit: easiest to program with a goto. We still need
5213 to update the pointer to the terminator, for cases of nested calls with "fail".
5216 EXPAND_FAILED_CURLY:
5217 expand_string_message = malformed_header?
5218 US"missing or misplaced { or } - could be header name not terminated by colon"
5220 US"missing or misplaced { or }";
5222 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5223 that is a bad idea, because expand_string_message is in dynamic store. */
5226 if (left != NULL) *left = s;
5229 debug_printf("failed to expand: %s\n", string);
5230 debug_printf(" error message: %s\n", expand_string_message);
5231 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5237 /* This is the external function call. Do a quick check for any expansion
5238 metacharacters, and if there are none, just return the input string.
5240 Argument: the string to be expanded
5241 Returns: the expanded string, or NULL if expansion failed; if failure was
5242 due to a lookup deferring, search_find_defer will be TRUE
5246 expand_string(uschar *string)
5248 search_find_defer = FALSE;
5249 malformed_header = FALSE;
5250 return (Ustrpbrk(string, "$\\") == NULL)? string :
5251 expand_string_internal(string, FALSE, NULL, FALSE);
5256 /*************************************************
5258 *************************************************/
5260 /* Now and again we want to expand a string and be sure that the result is in a
5261 new bit of store. This function does that.
5263 Argument: the string to be expanded
5264 Returns: the expanded string, always in a new bit of store, or NULL
5268 expand_string_copy(uschar *string)
5270 uschar *yield = expand_string(string);
5271 if (yield == string) yield = string_copy(string);
5277 /*************************************************
5278 * Expand and interpret as an integer *
5279 *************************************************/
5281 /* Expand a string, and convert the result into an integer.
5284 string the string to be expanded
5285 isplus TRUE if a non-negative number is expected
5287 Returns: the integer value, or
5288 -1 for an expansion error ) in both cases, message in
5289 -2 for an integer interpretation error ) expand_string_message
5290 expand_string_message is set NULL for an OK integer
5294 expand_string_integer(uschar *string, BOOL isplus)
5297 uschar *s = expand_string(string);
5298 uschar *msg = US"invalid integer \"%s\"";
5301 /* If expansion failed, expand_string_message will be set. */
5303 if (s == NULL) return -1;
5305 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5306 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5307 systems, so we set it zero ourselves. */
5310 expand_string_message = NULL; /* Indicates no error */
5311 value = strtol(CS s, CSS &endptr, 0);
5315 msg = US"integer expected but \"%s\" found";
5317 else if (value < 0 && isplus)
5319 msg = US"non-negative integer expected but \"%s\" found";
5323 /* Ensure we can cast this down to an int */
5324 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5326 if (errno != ERANGE)
5328 if (tolower(*endptr) == 'k')
5330 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5334 else if (tolower(*endptr) == 'm')
5336 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5338 else value *= 1024*1024;
5342 if (errno == ERANGE)
5343 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5346 while (isspace(*endptr)) endptr++;
5347 if (*endptr == 0) return (int)value;
5351 expand_string_message = string_sprintf(CS msg, s);
5356 /*************************************************
5357 **************************************************
5358 * Stand-alone test program *
5359 **************************************************
5360 *************************************************/
5366 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5368 int ovector[3*(EXPAND_MAXN+1)];
5369 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5370 ovector, sizeof(ovector)/sizeof(int));
5371 BOOL yield = n >= 0;
5372 if (n == 0) n = EXPAND_MAXN + 1;
5376 expand_nmax = (setup < 0)? 0 : setup + 1;
5377 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5379 expand_nstring[expand_nmax] = subject + ovector[nn];
5380 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5388 int main(int argc, uschar **argv)
5391 uschar buffer[1024];
5393 debug_selector = D_v;
5394 debug_file = stderr;
5395 debug_fd = fileno(debug_file);
5396 big_buffer = malloc(big_buffer_size);
5398 for (i = 1; i < argc; i++)
5400 if (argv[i][0] == '+')
5402 debug_trace_memory = 2;
5405 if (isdigit(argv[i][0]))
5406 debug_selector = Ustrtol(argv[i], NULL, 0);
5408 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5412 eldap_default_servers = argv[i];
5415 mysql_servers = argv[i];
5418 pgsql_servers = argv[i];
5422 else opt_perl_startup = argv[i];
5426 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5428 expand_nstring[1] = US"string 1....";
5429 expand_nlength[1] = 8;
5433 if (opt_perl_startup != NULL)
5436 printf("Starting Perl interpreter\n");
5437 errstr = init_perl(opt_perl_startup);
5440 printf("** error in perl_startup code: %s\n", errstr);
5441 return EXIT_FAILURE;
5444 #endif /* EXIM_PERL */
5446 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5448 void *reset_point = store_get(0);
5449 uschar *yield = expand_string(buffer);
5452 printf("%s\n", yield);
5453 store_reset(reset_point);
5457 if (search_find_defer) printf("search_find deferred\n");
5458 printf("Failed: %s\n", expand_string_message);
5459 if (expand_string_forcedfail) printf("Forced failure\n");
5471 /* End of expand.c */