1 /* $Cambridge: exim/src/src/expand.c,v 1.40 2005/08/08 09:57:29 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2005 */
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[] = {
102 EOP_QUOTE_LOCAL_PART,
105 static uschar *op_table_main[] = {
136 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
166 /* Table of condition names, and corresponding switch numbers. The names must
167 be in alphabetical order. */
169 static uschar *cond_table[] = {
173 US"==", /* Backward compatibility */
199 US"match_local_part",
221 ECOND_FIRST_DELIVERY,
238 ECOND_MATCH_LOCAL_PART,
248 /* Type for main variable table */
256 /* Type for entries pointing to address/length pairs. Not currently
264 /* Types of table entry */
267 vtype_int, /* value is address of int */
268 vtype_filter_int, /* ditto, but recognized only when filtering */
269 vtype_ino, /* value is address of ino_t (not always an int) */
270 vtype_uid, /* value is address of uid_t (not always an int) */
271 vtype_gid, /* value is address of gid_t (not always an int) */
272 vtype_stringptr, /* value is address of pointer to string */
273 vtype_msgbody, /* as stringptr, but read when first required */
274 vtype_msgbody_end, /* ditto, the end of the message */
275 vtype_msgheaders, /* the message's headers */
276 vtype_localpart, /* extract local part from string */
277 vtype_domain, /* extract domain from string */
278 vtype_recipients, /* extract recipients from recipients list */
279 /* (enabled only during system filtering */
280 vtype_todbsdin, /* value not used; generate BSD inbox tod */
281 vtype_tode, /* value not used; generate tod in epoch format */
282 vtype_todf, /* value not used; generate full tod */
283 vtype_todl, /* value not used; generate log tod */
284 vtype_todlf, /* value not used; generate log file datestamp tod */
285 vtype_todzone, /* value not used; generate time zone only */
286 vtype_todzulu, /* value not used; generate zulu tod */
287 vtype_reply, /* value not used; get reply from headers */
288 vtype_pid, /* value not used; result is pid */
289 vtype_host_lookup, /* value not used; get host name */
290 vtype_load_avg, /* value not used; result is int from os_getloadavg */
291 vtype_pspace, /* partition space; value is T/F for spool/log */
292 vtype_pinodes /* partition inodes; value is T/F for spool/log */
293 #ifdef EXPERIMENTAL_DOMAINKEYS
294 ,vtype_dk_verify /* Serve request out of DomainKeys verification structure */
298 /* This table must be kept in alphabetical order. */
300 static var_entry var_table[] = {
301 { "acl_c0", vtype_stringptr, &acl_var[0] },
302 { "acl_c1", vtype_stringptr, &acl_var[1] },
303 { "acl_c2", vtype_stringptr, &acl_var[2] },
304 { "acl_c3", vtype_stringptr, &acl_var[3] },
305 { "acl_c4", vtype_stringptr, &acl_var[4] },
306 { "acl_c5", vtype_stringptr, &acl_var[5] },
307 { "acl_c6", vtype_stringptr, &acl_var[6] },
308 { "acl_c7", vtype_stringptr, &acl_var[7] },
309 { "acl_c8", vtype_stringptr, &acl_var[8] },
310 { "acl_c9", vtype_stringptr, &acl_var[9] },
311 { "acl_m0", vtype_stringptr, &acl_var[10] },
312 { "acl_m1", vtype_stringptr, &acl_var[11] },
313 { "acl_m2", vtype_stringptr, &acl_var[12] },
314 { "acl_m3", vtype_stringptr, &acl_var[13] },
315 { "acl_m4", vtype_stringptr, &acl_var[14] },
316 { "acl_m5", vtype_stringptr, &acl_var[15] },
317 { "acl_m6", vtype_stringptr, &acl_var[16] },
318 { "acl_m7", vtype_stringptr, &acl_var[17] },
319 { "acl_m8", vtype_stringptr, &acl_var[18] },
320 { "acl_m9", vtype_stringptr, &acl_var[19] },
321 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
322 { "address_data", vtype_stringptr, &deliver_address_data },
323 { "address_file", vtype_stringptr, &address_file },
324 { "address_pipe", vtype_stringptr, &address_pipe },
325 { "authenticated_id", vtype_stringptr, &authenticated_id },
326 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
327 { "authentication_failed",vtype_int, &authentication_failed },
328 #ifdef EXPERIMENTAL_BRIGHTMAIL
329 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
330 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
331 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
332 { "bmi_deliver", vtype_int, &bmi_deliver },
334 { "body_linecount", vtype_int, &body_linecount },
335 { "body_zerocount", vtype_int, &body_zerocount },
336 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
337 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
338 { "caller_gid", vtype_gid, &real_gid },
339 { "caller_uid", vtype_uid, &real_uid },
340 { "compile_date", vtype_stringptr, &version_date },
341 { "compile_number", vtype_stringptr, &version_cnumber },
342 { "csa_status", vtype_stringptr, &csa_status },
343 #ifdef WITH_OLD_DEMIME
344 { "demime_errorlevel", vtype_int, &demime_errorlevel },
345 { "demime_reason", vtype_stringptr, &demime_reason },
347 #ifdef EXPERIMENTAL_DOMAINKEYS
348 { "dk_domain", vtype_stringptr, &dk_signing_domain },
349 { "dk_is_signed", vtype_dk_verify, NULL },
350 { "dk_result", vtype_dk_verify, NULL },
351 { "dk_selector", vtype_stringptr, &dk_signing_selector },
352 { "dk_sender", vtype_dk_verify, NULL },
353 { "dk_sender_domain", vtype_dk_verify, NULL },
354 { "dk_sender_local_part",vtype_dk_verify, NULL },
355 { "dk_sender_source", vtype_dk_verify, NULL },
356 { "dk_signsall", vtype_dk_verify, NULL },
357 { "dk_status", vtype_dk_verify, NULL },
358 { "dk_testing", vtype_dk_verify, NULL },
360 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
361 { "dnslist_text", vtype_stringptr, &dnslist_text },
362 { "dnslist_value", vtype_stringptr, &dnslist_value },
363 { "domain", vtype_stringptr, &deliver_domain },
364 { "domain_data", vtype_stringptr, &deliver_domain_data },
365 { "exim_gid", vtype_gid, &exim_gid },
366 { "exim_path", vtype_stringptr, &exim_path },
367 { "exim_uid", vtype_uid, &exim_uid },
368 #ifdef WITH_OLD_DEMIME
369 { "found_extension", vtype_stringptr, &found_extension },
371 { "home", vtype_stringptr, &deliver_home },
372 { "host", vtype_stringptr, &deliver_host },
373 { "host_address", vtype_stringptr, &deliver_host_address },
374 { "host_data", vtype_stringptr, &host_data },
375 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
376 { "host_lookup_failed", vtype_int, &host_lookup_failed },
377 { "inode", vtype_ino, &deliver_inode },
378 { "interface_address", vtype_stringptr, &interface_address },
379 { "interface_port", vtype_int, &interface_port },
381 { "ldap_dn", vtype_stringptr, &eldap_dn },
383 { "load_average", vtype_load_avg, NULL },
384 { "local_part", vtype_stringptr, &deliver_localpart },
385 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
386 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
387 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
388 { "local_scan_data", vtype_stringptr, &local_scan_data },
389 { "local_user_gid", vtype_gid, &local_user_gid },
390 { "local_user_uid", vtype_uid, &local_user_uid },
391 { "localhost_number", vtype_int, &host_number },
392 { "log_inodes", vtype_pinodes, (void *)FALSE },
393 { "log_space", vtype_pspace, (void *)FALSE },
394 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
395 #ifdef WITH_CONTENT_SCAN
396 { "malware_name", vtype_stringptr, &malware_name },
398 { "message_age", vtype_int, &message_age },
399 { "message_body", vtype_msgbody, &message_body },
400 { "message_body_end", vtype_msgbody_end, &message_body_end },
401 { "message_body_size", vtype_int, &message_body_size },
402 { "message_exim_id", vtype_stringptr, &message_id },
403 { "message_headers", vtype_msgheaders, NULL },
404 { "message_id", vtype_stringptr, &message_id },
405 { "message_linecount", vtype_int, &message_linecount },
406 { "message_size", vtype_int, &message_size },
407 #ifdef WITH_CONTENT_SCAN
408 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
409 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
410 { "mime_boundary", vtype_stringptr, &mime_boundary },
411 { "mime_charset", vtype_stringptr, &mime_charset },
412 { "mime_content_description", vtype_stringptr, &mime_content_description },
413 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
414 { "mime_content_id", vtype_stringptr, &mime_content_id },
415 { "mime_content_size", vtype_int, &mime_content_size },
416 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
417 { "mime_content_type", vtype_stringptr, &mime_content_type },
418 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
419 { "mime_filename", vtype_stringptr, &mime_filename },
420 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
421 { "mime_is_multipart", vtype_int, &mime_is_multipart },
422 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
423 { "mime_part_count", vtype_int, &mime_part_count },
425 { "n0", vtype_filter_int, &filter_n[0] },
426 { "n1", vtype_filter_int, &filter_n[1] },
427 { "n2", vtype_filter_int, &filter_n[2] },
428 { "n3", vtype_filter_int, &filter_n[3] },
429 { "n4", vtype_filter_int, &filter_n[4] },
430 { "n5", vtype_filter_int, &filter_n[5] },
431 { "n6", vtype_filter_int, &filter_n[6] },
432 { "n7", vtype_filter_int, &filter_n[7] },
433 { "n8", vtype_filter_int, &filter_n[8] },
434 { "n9", vtype_filter_int, &filter_n[9] },
435 { "original_domain", vtype_stringptr, &deliver_domain_orig },
436 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
437 { "originator_gid", vtype_gid, &originator_gid },
438 { "originator_uid", vtype_uid, &originator_uid },
439 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
440 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
441 { "pid", vtype_pid, NULL },
442 { "primary_hostname", vtype_stringptr, &primary_hostname },
443 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
444 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
445 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
446 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
447 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
448 { "rcpt_count", vtype_int, &rcpt_count },
449 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
450 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
451 { "received_count", vtype_int, &received_count },
452 { "received_for", vtype_stringptr, &received_for },
453 { "received_protocol", vtype_stringptr, &received_protocol },
454 { "received_time", vtype_int, &received_time },
455 { "recipient_data", vtype_stringptr, &recipient_data },
456 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
457 { "recipients", vtype_recipients, NULL },
458 { "recipients_count", vtype_int, &recipients_count },
459 #ifdef WITH_CONTENT_SCAN
460 { "regex_match_string", vtype_stringptr, ®ex_match_string },
462 { "reply_address", vtype_reply, NULL },
463 { "return_path", vtype_stringptr, &return_path },
464 { "return_size_limit", vtype_int, &bounce_return_size_limit },
465 { "runrc", vtype_int, &runrc },
466 { "self_hostname", vtype_stringptr, &self_hostname },
467 { "sender_address", vtype_stringptr, &sender_address },
468 { "sender_address_data", vtype_stringptr, &sender_address_data },
469 { "sender_address_domain", vtype_domain, &sender_address },
470 { "sender_address_local_part", vtype_localpart, &sender_address },
471 { "sender_data", vtype_stringptr, &sender_data },
472 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
473 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
474 { "sender_host_address", vtype_stringptr, &sender_host_address },
475 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
476 { "sender_host_name", vtype_host_lookup, NULL },
477 { "sender_host_port", vtype_int, &sender_host_port },
478 { "sender_ident", vtype_stringptr, &sender_ident },
479 { "sender_rate", vtype_stringptr, &sender_rate },
480 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
481 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
482 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
483 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
484 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
485 { "smtp_command_argument", vtype_stringptr, &smtp_command_argument },
486 { "sn0", vtype_filter_int, &filter_sn[0] },
487 { "sn1", vtype_filter_int, &filter_sn[1] },
488 { "sn2", vtype_filter_int, &filter_sn[2] },
489 { "sn3", vtype_filter_int, &filter_sn[3] },
490 { "sn4", vtype_filter_int, &filter_sn[4] },
491 { "sn5", vtype_filter_int, &filter_sn[5] },
492 { "sn6", vtype_filter_int, &filter_sn[6] },
493 { "sn7", vtype_filter_int, &filter_sn[7] },
494 { "sn8", vtype_filter_int, &filter_sn[8] },
495 { "sn9", vtype_filter_int, &filter_sn[9] },
496 #ifdef WITH_CONTENT_SCAN
497 { "spam_bar", vtype_stringptr, &spam_bar },
498 { "spam_report", vtype_stringptr, &spam_report },
499 { "spam_score", vtype_stringptr, &spam_score },
500 { "spam_score_int", vtype_stringptr, &spam_score_int },
502 #ifdef EXPERIMENTAL_SPF
503 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
504 { "spf_received", vtype_stringptr, &spf_received },
505 { "spf_result", vtype_stringptr, &spf_result },
506 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
508 { "spool_directory", vtype_stringptr, &spool_directory },
509 { "spool_inodes", vtype_pinodes, (void *)TRUE },
510 { "spool_space", vtype_pspace, (void *)TRUE },
511 #ifdef EXPERIMENTAL_SRS
512 { "srs_db_address", vtype_stringptr, &srs_db_address },
513 { "srs_db_key", vtype_stringptr, &srs_db_key },
514 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
515 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
516 { "srs_recipient", vtype_stringptr, &srs_recipient },
517 { "srs_status", vtype_stringptr, &srs_status },
519 { "thisaddress", vtype_stringptr, &filter_thisaddress },
520 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
521 { "tls_cipher", vtype_stringptr, &tls_cipher },
522 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
523 { "tod_bsdinbox", vtype_todbsdin, NULL },
524 { "tod_epoch", vtype_tode, NULL },
525 { "tod_full", vtype_todf, NULL },
526 { "tod_log", vtype_todl, NULL },
527 { "tod_logfile", vtype_todlf, NULL },
528 { "tod_zone", vtype_todzone, NULL },
529 { "tod_zulu", vtype_todzulu, NULL },
530 { "value", vtype_stringptr, &lookup_value },
531 { "version_number", vtype_stringptr, &version_string },
532 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
533 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
534 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
535 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
536 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
537 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
540 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
541 static uschar var_buffer[256];
542 static BOOL malformed_header;
544 /* For textual hashes */
546 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
547 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
550 enum { HMAC_MD5, HMAC_SHA1 };
552 /* For numeric hashes */
554 static unsigned int prime[] = {
555 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
556 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
557 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
559 /* For printing modes in symbolic form */
561 static uschar *mtable_normal[] =
562 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
564 static uschar *mtable_setid[] =
565 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
567 static uschar *mtable_sticky[] =
568 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
572 /*************************************************
573 * Tables for UTF-8 support *
574 *************************************************/
576 /* Table of the number of extra characters, indexed by the first character
577 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
580 static uschar utf8_table1[] = {
581 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
582 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
583 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
584 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
586 /* These are the masks for the data bits in the first byte of a character,
587 indexed by the number of additional bytes. */
589 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
591 /* Get the next UTF-8 character, advancing the pointer. */
593 #define GETUTF8INC(c, ptr) \
595 if ((c & 0xc0) == 0xc0) \
597 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
599 c = (c & utf8_table2[a]) << s; \
603 c |= (*ptr++ & 0x3f) << s; \
608 /*************************************************
609 * Binary chop search on a table *
610 *************************************************/
612 /* This is used for matching expansion items and operators.
615 name the name that is being sought
616 table the table to search
617 table_size the number of items in the table
619 Returns: the offset in the table, or -1
623 chop_match(uschar *name, uschar **table, int table_size)
625 uschar **bot = table;
626 uschar **top = table + table_size;
630 uschar **mid = bot + (top - bot)/2;
631 int c = Ustrcmp(name, *mid);
632 if (c == 0) return mid - table;
633 if (c > 0) bot = mid + 1; else top = mid;
641 /*************************************************
642 * Check a condition string *
643 *************************************************/
645 /* This function is called to expand a string, and test the result for a "true"
646 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
647 forced fail or lookup defer. All store used by the function can be released on
651 condition the condition string
652 m1 text to be incorporated in panic error
655 Returns: TRUE if condition is met, FALSE if not
659 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
662 void *reset_point = store_get(0);
663 uschar *ss = expand_string(condition);
666 if (!expand_string_forcedfail && !search_find_defer)
667 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
668 "for %s %s: %s", condition, m1, m2, expand_string_message);
671 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
672 strcmpic(ss, US"false") != 0;
673 store_reset(reset_point);
679 /*************************************************
680 * Pick out a name from a string *
681 *************************************************/
683 /* If the name is too long, it is silently truncated.
686 name points to a buffer into which to put the name
687 max is the length of the buffer
688 s points to the first alphabetic character of the name
689 extras chars other than alphanumerics to permit
691 Returns: pointer to the first character after the name
693 Note: The test for *s != 0 in the while loop is necessary because
694 Ustrchr() yields non-NULL if the character is zero (which is not something
698 read_name(uschar *name, int max, uschar *s, uschar *extras)
701 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
703 if (ptr < max-1) name[ptr++] = *s;
712 /*************************************************
713 * Pick out the rest of a header name *
714 *************************************************/
716 /* A variable name starting $header_ (or just $h_ for those who like
717 abbreviations) might not be the complete header name because headers can
718 contain any printing characters in their names, except ':'. This function is
719 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
720 on the end, if the name was terminated by white space.
723 name points to a buffer in which the name read so far exists
724 max is the length of the buffer
725 s points to the first character after the name so far, i.e. the
726 first non-alphameric character after $header_xxxxx
728 Returns: a pointer to the first character after the header name
732 read_header_name(uschar *name, int max, uschar *s)
734 int prelen = Ustrchr(name, '_') - name + 1;
735 int ptr = Ustrlen(name) - prelen;
736 if (ptr > 0) memmove(name, name+prelen, ptr);
737 while (mac_isgraph(*s) && *s != ':')
739 if (ptr < max-1) name[ptr++] = *s;
750 /*************************************************
751 * Pick out a number from a string *
752 *************************************************/
755 n points to an integer into which to put the number
756 s points to the first digit of the number
758 Returns: a pointer to the character after the last digit
762 read_number(int *n, uschar *s)
765 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
771 /*************************************************
772 * Extract keyed subfield from a string *
773 *************************************************/
775 /* The yield is in dynamic store; NULL means that the key was not found.
778 key points to the name of the key
779 s points to the string from which to extract the subfield
781 Returns: NULL if the subfield was not found, or
782 a pointer to the subfield's data
786 expand_getkeyed(uschar *key, uschar *s)
788 int length = Ustrlen(key);
789 while (isspace(*s)) s++;
791 /* Loop to search for the key */
799 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
800 dkeylength = s - dkey;
801 while (isspace(*s)) s++;
802 if (*s == '=') while (isspace((*(++s))));
804 data = string_dequote(&s);
805 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
808 while (isspace(*s)) s++;
817 /*************************************************
818 * Extract numbered subfield from string *
819 *************************************************/
821 /* Extracts a numbered field from a string that is divided by tokens - for
822 example a line from /etc/passwd is divided by colon characters. First field is
823 numbered one. Negative arguments count from the right. Zero returns the whole
824 string. Returns NULL if there are insufficient tokens in the string
827 Modifies final argument - this is a dynamically generated string, so that's OK.
830 field number of field to be extracted,
831 first field = 1, whole string = 0, last field = -1
832 separators characters that are used to break string into tokens
833 s points to the string from which to extract the subfield
835 Returns: NULL if the field was not found,
836 a pointer to the field's data inside s (modified to add 0)
840 expand_gettokened (int field, uschar *separators, uschar *s)
845 uschar *fieldtext = NULL;
847 if (field == 0) return s;
849 /* Break the line up into fields in place; for field > 0 we stop when we have
850 done the number of fields we want. For field < 0 we continue till the end of
851 the string, counting the number of fields. */
853 count = (field > 0)? field : INT_MAX;
859 /* Previous field was the last one in the string. For a positive field
860 number, this means there are not enough fields. For a negative field number,
861 check that there are enough, and scan back to find the one that is wanted. */
865 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
866 if ((-field) == (INT_MAX - count - 1)) return s;
870 while (ss[-1] != 0) ss--;
876 /* Previous field was not last in the string; save its start and put a
880 len = Ustrcspn(ss, separators);
891 /*************************************************
892 * Extract a substring from a string *
893 *************************************************/
895 /* Perform the ${substr or ${length expansion operations.
898 subject the input string
899 value1 the offset from the start of the input string to the start of
900 the output string; if negative, count from the right.
901 value2 the length of the output string, or negative (-1) for unset
902 if value1 is positive, unset means "all after"
903 if value1 is negative, unset means "all before"
904 len set to the length of the returned string
906 Returns: pointer to the output string, or NULL if there is an error
910 extract_substr(uschar *subject, int value1, int value2, int *len)
912 int sublen = Ustrlen(subject);
914 if (value1 < 0) /* count from right */
918 /* If the position is before the start, skip to the start, and adjust the
919 length. If the length ends up negative, the substring is null because nothing
920 can precede. This falls out naturally when the length is unset, meaning "all
926 if (value2 < 0) value2 = 0;
930 /* Otherwise an unset length => characters before value1 */
939 /* For a non-negative offset, if the starting position is past the end of the
940 string, the result will be the null string. Otherwise, an unset length means
941 "rest"; just set it to the maximum - it will be cut down below if necessary. */
950 else if (value2 < 0) value2 = sublen;
953 /* Cut the length down to the maximum possible for the offset value, and get
954 the required characters. */
956 if (value1 + value2 > sublen) value2 = sublen - value1;
958 return subject + value1;
964 /*************************************************
965 * Old-style hash of a string *
966 *************************************************/
968 /* Perform the ${hash expansion operation.
971 subject the input string (an expanded substring)
972 value1 the length of the output string; if greater or equal to the
973 length of the input string, the input string is returned
974 value2 the number of hash characters to use, or 26 if negative
975 len set to the length of the returned string
977 Returns: pointer to the output string, or NULL if there is an error
981 compute_hash(uschar *subject, int value1, int value2, int *len)
983 int sublen = Ustrlen(subject);
985 if (value2 < 0) value2 = 26;
986 else if (value2 > Ustrlen(hashcodes))
988 expand_string_message =
989 string_sprintf("hash count \"%d\" too big", value2);
993 /* Calculate the hash text. We know it is shorter than the original string, so
994 can safely place it in subject[] (we know that subject is always itself an
995 expanded substring). */
1002 while ((c = (subject[j])) != 0)
1004 int shift = (c + j++) & 7;
1005 subject[i] ^= (c << shift) | (c >> (8-shift));
1006 if (++i >= value1) i = 0;
1008 for (i = 0; i < value1; i++)
1009 subject[i] = hashcodes[(subject[i]) % value2];
1011 else value1 = sublen;
1020 /*************************************************
1021 * Numeric hash of a string *
1022 *************************************************/
1024 /* Perform the ${nhash expansion operation. The first characters of the
1025 string are treated as most important, and get the highest prime numbers.
1028 subject the input string
1029 value1 the maximum value of the first part of the result
1030 value2 the maximum value of the second part of the result,
1031 or negative to produce only a one-part result
1032 len set to the length of the returned string
1034 Returns: pointer to the output string, or NULL if there is an error.
1038 compute_nhash (uschar *subject, int value1, int value2, int *len)
1040 uschar *s = subject;
1042 unsigned long int total = 0; /* no overflow */
1046 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1047 total += prime[i--] * (unsigned int)(*s++);
1050 /* If value2 is unset, just compute one number */
1054 s = string_sprintf("%d", total % value1);
1057 /* Otherwise do a div/mod hash */
1061 total = total % (value1 * value2);
1062 s = string_sprintf("%d/%d", total/value2, total % value2);
1073 /*************************************************
1074 * Find the value of a header or headers *
1075 *************************************************/
1077 /* Multiple instances of the same header get concatenated, and this function
1078 can also return a concatenation of all the header lines. When concatenating
1079 specific headers that contain lists of addresses, a comma is inserted between
1080 them. Otherwise we use a straight concatenation. Because some messages can have
1081 pathologically large number of lines, there is a limit on the length that is
1082 returned. Also, to avoid massive store use which would result from using
1083 string_cat() as it copies and extends strings, we do a preliminary pass to find
1084 out exactly how much store will be needed. On "normal" messages this will be
1088 name the name of the header, without the leading $header_ or $h_,
1089 or NULL if a concatenation of all headers is required
1090 exists_only TRUE if called from a def: test; don't need to build a string;
1091 just return a string that is not "" and not "0" if the header
1093 newsize return the size of memory block that was obtained; may be NULL
1094 if exists_only is TRUE
1095 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1096 other than concatenating, will be done on the header
1097 charset name of charset to translate MIME words to; used only if
1098 want_raw is false; if NULL, no translation is done (this is
1099 used for $bh_ and $bheader_)
1101 Returns: NULL if the header does not exist, else a pointer to a new
1106 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1109 BOOL found = name == NULL;
1111 int len = found? 0 : Ustrlen(name);
1113 uschar *yield = NULL;
1116 /* Loop for two passes - saves code repetition */
1118 for (i = 0; i < 2; i++)
1123 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1125 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1127 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1132 if (exists_only) return US"1"; /* don't need actual string */
1134 t = h->text + len; /* text to insert */
1135 if (!want_raw) /* unless wanted raw, */
1136 while (isspace(*t)) t++; /* remove leading white space */
1137 ilen = h->slen - (t - h->text); /* length to insert */
1139 /* Set comma = 1 if handling a single header and it's one of those
1140 that contains an address list, except when asked for raw headers. Only
1141 need to do this once. */
1143 if (!want_raw && name != NULL && comma == 0 &&
1144 Ustrchr("BCFRST", h->type) != NULL)
1147 /* First pass - compute total store needed; second pass - compute
1148 total store used, including this header. */
1150 size += ilen + comma;
1152 /* Second pass - concatentate the data, up to a maximum. Note that
1153 the loop stops when size hits the limit. */
1157 if (size > header_insert_maxlen)
1159 ilen -= size - header_insert_maxlen;
1162 Ustrncpy(ptr, t, ilen);
1164 if (comma != 0 && ilen > 0)
1174 /* At end of first pass, truncate size if necessary, and get the buffer
1175 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 /* Remove a redundant added comma if present */
1188 if (comma != 0 && ptr > yield) ptr -= 2;
1190 /* That's all we do for raw header expansion. */
1197 /* Otherwise, we remove trailing whitespace, including newlines. Then we do RFC
1198 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1199 function can return an error with decoded data if the charset translation
1200 fails. If decoding fails, it returns NULL. */
1204 uschar *decoded, *error;
1205 while (ptr > yield && isspace(ptr[-1])) ptr--;
1207 decoded = rfc2047_decode2(yield, TRUE, charset, '?', NULL, newsize, &error);
1210 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1211 " input was: %s\n", error, yield);
1213 if (decoded != NULL) yield = decoded;
1222 /*************************************************
1223 * Find value of a variable *
1224 *************************************************/
1226 /* The table of variables is kept in alphabetic order, so we can search it
1227 using a binary chop. The "choplen" variable is nothing to do with the binary
1231 name the name of the variable being sought
1232 exists_only TRUE if this is a def: test; passed on to find_header()
1233 skipping TRUE => skip any processing evaluation; this is not the same as
1234 exists_only because def: may test for values that are first
1236 newsize pointer to an int which is initially zero; if the answer is in
1237 a new memory buffer, *newsize is set to its size
1239 Returns: NULL if the variable does not exist, or
1240 a pointer to the variable's contents, or
1241 something non-NULL if exists_only is TRUE
1245 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1248 int last = var_table_size;
1250 while (last > first)
1254 int middle = (first + last)/2;
1255 int c = Ustrcmp(name, var_table[middle].name);
1257 if (c > 0) { first = middle + 1; continue; }
1258 if (c < 0) { last = middle; continue; }
1260 /* Found an existing variable. If in skipping state, the value isn't needed,
1261 and we want to avoid processing (such as looking up up the host name). */
1263 if (skipping) return US"";
1265 switch (var_table[middle].type)
1267 #ifdef EXPERIMENTAL_DOMAINKEYS
1269 case vtype_dk_verify:
1270 if (dk_verify_block == NULL) return US"";
1272 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1273 s = dk_verify_block->result_string;
1274 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1275 s = dk_verify_block->address;
1276 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1277 s = dk_verify_block->domain;
1278 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1279 s = dk_verify_block->local_part;
1281 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1282 switch(dk_verify_block->address_source) {
1283 case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1284 case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1285 case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1288 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1289 switch(dk_verify_block->result) {
1290 case DK_EXIM_RESULT_ERR: s = US"error"; break;
1291 case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1292 case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1293 case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1294 case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1295 case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1296 case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1297 case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1300 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1301 s = (dk_verify_block->signsall)? US"1" : US"0";
1303 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1304 s = (dk_verify_block->testing)? US"1" : US"0";
1306 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1307 s = (dk_verify_block->is_signed)? US"1" : US"0";
1309 return (s == NULL)? US"" : s;
1312 case vtype_filter_int:
1313 if (!filter_running) return NULL;
1317 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1321 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1325 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1329 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1332 case vtype_stringptr: /* Pointer to string */
1333 s = *((uschar **)(var_table[middle].value));
1334 return (s == NULL)? US"" : s;
1337 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1340 case vtype_load_avg:
1341 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1344 case vtype_host_lookup: /* Lookup if not done so */
1345 if (sender_host_name == NULL && sender_host_address != NULL &&
1346 !host_lookup_failed && host_name_lookup() == OK)
1347 host_build_sender_fullhost();
1348 return (sender_host_name == NULL)? US"" : sender_host_name;
1350 case vtype_localpart: /* Get local part from address */
1351 s = *((uschar **)(var_table[middle].value));
1352 if (s == NULL) return US"";
1353 domain = Ustrrchr(s, '@');
1354 if (domain == NULL) return s;
1355 if (domain - s > sizeof(var_buffer) - 1)
1356 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1357 "string expansion", sizeof(var_buffer));
1358 Ustrncpy(var_buffer, s, domain - s);
1359 var_buffer[domain - s] = 0;
1362 case vtype_domain: /* Get domain from address */
1363 s = *((uschar **)(var_table[middle].value));
1364 if (s == NULL) return US"";
1365 domain = Ustrrchr(s, '@');
1366 return (domain == NULL)? US"" : domain + 1;
1368 case vtype_msgheaders:
1369 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1371 case vtype_msgbody: /* Pointer to msgbody string */
1372 case vtype_msgbody_end: /* Ditto, the end of the msg */
1373 ss = (uschar **)(var_table[middle].value);
1374 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1377 off_t start_offset = SPOOL_DATA_START_OFFSET;
1378 int len = message_body_visible;
1379 if (len > message_size) len = message_size;
1380 *ss = body = store_malloc(len+1);
1382 if (var_table[middle].type == vtype_msgbody_end)
1384 struct stat statbuf;
1385 if (fstat(deliver_datafile, &statbuf) == 0)
1387 start_offset = statbuf.st_size - len;
1388 if (start_offset < SPOOL_DATA_START_OFFSET)
1389 start_offset = SPOOL_DATA_START_OFFSET;
1392 lseek(deliver_datafile, start_offset, SEEK_SET);
1393 len = read(deliver_datafile, body, len);
1399 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1403 return (*ss == NULL)? US"" : *ss;
1405 case vtype_todbsdin: /* BSD inbox time of day */
1406 return tod_stamp(tod_bsdin);
1408 case vtype_tode: /* Unix epoch time of day */
1409 return tod_stamp(tod_epoch);
1411 case vtype_todf: /* Full time of day */
1412 return tod_stamp(tod_full);
1414 case vtype_todl: /* Log format time of day */
1415 return tod_stamp(tod_log_bare); /* (without timezone) */
1417 case vtype_todzone: /* Time zone offset only */
1418 return tod_stamp(tod_zone);
1420 case vtype_todzulu: /* Zulu time */
1421 return tod_stamp(tod_zulu);
1423 case vtype_todlf: /* Log file datestamp tod */
1424 return tod_stamp(tod_log_datestamp);
1426 case vtype_reply: /* Get reply address */
1427 s = find_header(US"reply-to:", exists_only, newsize, FALSE,
1429 if (s == NULL || *s == 0)
1431 *newsize = 0; /* For the *s==0 case */
1432 s = find_header(US"from:", exists_only, newsize, FALSE, headers_charset);
1434 return (s == NULL)? US"" : s;
1436 /* A recipients list is available only during system message filtering,
1437 during ACL processing after DATA, and while expanding pipe commands
1438 generated from a system filter, but not elsewhere. */
1440 case vtype_recipients:
1441 if (!enable_dollar_recipients) return NULL; else
1446 s = store_get(size);
1447 for (i = 0; i < recipients_count; i++)
1449 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1450 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1451 Ustrlen(recipients_list[i].address));
1453 s[ptr] = 0; /* string_cat() leaves room */
1460 sprintf(CS var_buffer, "%d",
1461 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1468 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1469 sprintf(CS var_buffer, "%d", inodes);
1475 return NULL; /* Unknown variable name */
1481 /*************************************************
1482 * Read and expand substrings *
1483 *************************************************/
1485 /* This function is called to read and expand argument substrings for various
1486 expansion items. Some have a minimum requirement that is less than the maximum;
1487 in these cases, the first non-present one is set to NULL.
1490 sub points to vector of pointers to set
1491 n maximum number of substrings
1493 sptr points to current string pointer
1494 skipping the skipping flag
1495 check_end if TRUE, check for final '}'
1496 name name of item, for error message
1498 Returns: 0 OK; string pointer updated
1499 1 curly bracketing error (too few arguments)
1500 2 too many arguments (only if check_end is set); message set
1501 3 other error (expansion failure)
1505 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1506 BOOL check_end, uschar *name)
1511 while (isspace(*s)) s++;
1512 for (i = 0; i < n; i++)
1516 if (i < m) return 1;
1520 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1521 if (sub[i] == NULL) return 3;
1522 if (*s++ != '}') return 1;
1523 while (isspace(*s)) s++;
1525 if (check_end && *s++ != '}')
1529 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1530 "(max is %d)", name, n);
1543 /*************************************************
1544 * Read and evaluate a condition *
1545 *************************************************/
1549 s points to the start of the condition text
1550 yield points to a BOOL to hold the result of the condition test;
1551 if NULL, we are just reading through a condition that is
1552 part of an "or" combination to check syntax, or in a state
1553 where the answer isn't required
1555 Returns: a pointer to the first character after the condition, or
1560 eval_condition(uschar *s, BOOL *yield)
1562 BOOL testfor = TRUE;
1563 BOOL tempcond, combined_cond;
1565 int i, rc, cond_type, roffset;
1567 struct stat statbuf;
1572 const uschar *rerror;
1576 while (isspace(*s)) s++;
1577 if (*s == '!') { testfor = !testfor; s++; } else break;
1580 /* Numeric comparisons are symbolic */
1582 if (*s == '=' || *s == '>' || *s == '<')
1594 /* All other conditions are named */
1596 else s = read_name(name, 256, s, US"_");
1598 /* If we haven't read a name, it means some non-alpha character is first. */
1602 expand_string_message = string_sprintf("condition name expected, "
1603 "but found \"%.16s\"", s);
1607 /* Find which condition we are dealing with, and switch on it */
1609 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1612 /* def: tests for a non-empty variable, or for the existence of a header. If
1613 yield == NULL we are in a skipping state, and don't care about the answer. */
1618 expand_string_message = US"\":\" expected after \"def\"";
1622 s = read_name(name, 256, s+1, US"_");
1624 /* Test for a header's existence */
1626 if (Ustrncmp(name, "h_", 2) == 0 ||
1627 Ustrncmp(name, "rh_", 3) == 0 ||
1628 Ustrncmp(name, "bh_", 3) == 0 ||
1629 Ustrncmp(name, "header_", 7) == 0 ||
1630 Ustrncmp(name, "rheader_", 8) == 0 ||
1631 Ustrncmp(name, "bheader_", 8) == 0)
1633 s = read_header_name(name, 256, s);
1634 if (yield != NULL) *yield =
1635 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1638 /* Test for a variable's having a non-empty value. A non-existent variable
1639 causes an expansion failure. */
1643 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1646 expand_string_message = (name[0] == 0)?
1647 string_sprintf("variable name omitted after \"def:\"") :
1648 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1651 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1657 /* first_delivery tests for first delivery attempt */
1659 case ECOND_FIRST_DELIVERY:
1660 if (yield != NULL) *yield = deliver_firsttime == testfor;
1664 /* queue_running tests for any process started by a queue runner */
1666 case ECOND_QUEUE_RUNNING:
1667 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1671 /* exists: tests for file existence
1672 isip: tests for any IP address
1673 isip4: tests for an IPv4 address
1674 isip6: tests for an IPv6 address
1675 pam: does PAM authentication
1676 radius: does RADIUS authentication
1677 ldapauth: does LDAP authentication
1678 pwcheck: does Cyrus SASL pwcheck authentication
1687 case ECOND_LDAPAUTH:
1690 while (isspace(*s)) s++;
1691 if (*s != '{') goto COND_FAILED_CURLY_START;
1693 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1694 if (sub[0] == NULL) return NULL;
1695 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1697 if (yield == NULL) return s; /* No need to run the test if skipping */
1702 if ((expand_forbid & RDO_EXISTS) != 0)
1704 expand_string_message = US"File existence tests are not permitted";
1707 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1713 rc = string_is_ip_address(sub[0], NULL);
1714 *yield = ((cond_type == ECOND_ISIP)? (rc > 0) :
1715 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1718 /* Various authentication tests - all optionally compiled */
1722 rc = auth_call_pam(sub[0], &expand_string_message);
1725 goto COND_FAILED_NOT_COMPILED;
1726 #endif /* SUPPORT_PAM */
1729 #ifdef RADIUS_CONFIG_FILE
1730 rc = auth_call_radius(sub[0], &expand_string_message);
1733 goto COND_FAILED_NOT_COMPILED;
1734 #endif /* RADIUS_CONFIG_FILE */
1736 case ECOND_LDAPAUTH:
1739 /* Just to keep the interface the same */
1741 int old_pool = store_pool;
1742 store_pool = POOL_SEARCH;
1743 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1744 &expand_string_message, &do_cache);
1745 store_pool = old_pool;
1749 goto COND_FAILED_NOT_COMPILED;
1750 #endif /* LOOKUP_LDAP */
1753 #ifdef CYRUS_PWCHECK_SOCKET
1754 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1757 goto COND_FAILED_NOT_COMPILED;
1758 #endif /* CYRUS_PWCHECK_SOCKET */
1760 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1761 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1763 if (rc == ERROR || rc == DEFER) return NULL;
1764 *yield = (rc == OK) == testfor;
1770 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1772 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1774 However, the last two are optional. That is why the whole set is enclosed
1775 in their own set or braces. */
1777 case ECOND_SASLAUTHD:
1778 #ifndef CYRUS_SASLAUTHD_SOCKET
1779 goto COND_FAILED_NOT_COMPILED;
1781 while (isspace(*s)) s++;
1782 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1783 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1785 case 1: expand_string_message = US"too few arguments or bracketing "
1786 "error for saslauthd";
1788 case 3: return NULL;
1790 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1794 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1795 &expand_string_message);
1796 if (rc == ERROR || rc == DEFER) return NULL;
1797 *yield = (rc == OK) == testfor;
1800 #endif /* CYRUS_SASLAUTHD_SOCKET */
1803 /* symbolic operators for numeric and string comparison, and a number of
1804 other operators, all requiring two arguments.
1806 match: does a regular expression match and sets up the numerical
1807 variables if it succeeds
1808 match_address: matches in an address list
1809 match_domain: matches in a domain list
1810 match_ip: matches a host list that is restricted to IP addresses
1811 match_local_part: matches in a local part list
1812 crypteq: encrypts plaintext and compares against an encrypted text,
1813 using crypt(), crypt16(), MD5 or SHA-1
1817 case ECOND_MATCH_ADDRESS:
1818 case ECOND_MATCH_DOMAIN:
1819 case ECOND_MATCH_IP:
1820 case ECOND_MATCH_LOCAL_PART:
1823 case ECOND_NUM_L: /* Numerical comparisons */
1830 case ECOND_STR_LT: /* String comparisons */
1841 for (i = 0; i < 2; i++)
1843 while (isspace(*s)) s++;
1846 if (i == 0) goto COND_FAILED_CURLY_START;
1847 expand_string_message = string_sprintf("missing 2nd string in {} "
1848 "after \"%s\"", name);
1851 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1852 if (sub[i] == NULL) return NULL;
1853 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1855 /* Convert to numerical if required; we know that the names of all the
1856 conditions that compare numbers do not start with a letter. This just saves
1857 checking for them individually. */
1859 if (!isalpha(name[0]))
1862 num[i] = (int)Ustrtol((const uschar *)sub[i], &endptr, 10);
1863 if (tolower(*endptr) == 'k')
1868 else if (tolower(*endptr) == 'm')
1870 num[i] *= 1024*1024;
1873 while (isspace(*endptr)) endptr++;
1876 expand_string_message = string_sprintf("\"%s\" is not a number",
1883 /* Result not required */
1885 if (yield == NULL) return s;
1887 /* Do an appropriate comparison */
1893 *yield = (num[0] == num[1]) == testfor;
1897 *yield = (num[0] > num[1]) == testfor;
1901 *yield = (num[0] >= num[1]) == testfor;
1905 *yield = (num[0] < num[1]) == testfor;
1909 *yield = (num[0] <= num[1]) == testfor;
1913 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1917 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1921 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1925 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1929 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1933 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1937 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1941 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1945 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
1949 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
1952 case ECOND_MATCH: /* Regular expression match */
1953 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1957 expand_string_message = string_sprintf("regular expression error in "
1958 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1961 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1964 case ECOND_MATCH_ADDRESS: /* Match in an address list */
1965 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1966 goto MATCHED_SOMETHING;
1968 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
1969 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1970 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1971 goto MATCHED_SOMETHING;
1973 case ECOND_MATCH_IP: /* Match IP address in a host list */
1974 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) <= 0)
1976 expand_string_message = string_sprintf("\"%s\" is not an IP address",
1982 unsigned int *nullcache = NULL;
1983 check_host_block cb;
1985 cb.host_name = US"";
1986 cb.host_address = sub[0];
1988 /* If the host address starts off ::ffff: it is an IPv6 address in
1989 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
1992 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
1993 cb.host_address + 7 : cb.host_address;
1995 rc = match_check_list(
1996 &sub[1], /* the list */
1997 0, /* separator character */
1998 &hostlist_anchor, /* anchor pointer */
1999 &nullcache, /* cache pointer */
2000 check_host, /* function for testing */
2001 &cb, /* argument for function */
2002 MCL_HOST, /* type of check */
2003 sub[0], /* text for debugging */
2004 NULL); /* where to pass back data */
2006 goto MATCHED_SOMETHING;
2008 case ECOND_MATCH_LOCAL_PART:
2009 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2010 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2025 expand_string_message = string_sprintf("unable to complete match "
2026 "against \"%s\": %s", sub[1], search_error_message);
2032 /* Various "encrypted" comparisons. If the second string starts with
2033 "{" then an encryption type is given. Default to crypt() or crypt16()
2034 (build-time choice). */
2037 #ifndef SUPPORT_CRYPTEQ
2038 goto COND_FAILED_NOT_COMPILED;
2040 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2042 int sublen = Ustrlen(sub[1]+5);
2047 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2049 /* If the length that we are comparing against is 24, the MD5 digest
2050 is expressed as a base64 string. This is the way LDAP does it. However,
2051 some other software uses a straightforward hex representation. We assume
2052 this if the length is 32. Other lengths fail. */
2056 uschar *coded = auth_b64encode((uschar *)digest, 16);
2057 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2058 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2059 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2061 else if (sublen == 32)
2065 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2067 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2068 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2069 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2073 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2074 "fail\n crypted=%s\n", sub[1]+5);
2079 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2081 int sublen = Ustrlen(sub[1]+6);
2086 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2088 /* If the length that we are comparing against is 28, assume the SHA1
2089 digest is expressed as a base64 string. If the length is 40, assume a
2090 straightforward hex representation. Other lengths fail. */
2094 uschar *coded = auth_b64encode((uschar *)digest, 20);
2095 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2096 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2097 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2099 else if (sublen == 40)
2103 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2105 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2106 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2107 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2111 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2112 "fail\n crypted=%s\n", sub[1]+6);
2117 else /* {crypt} or {crypt16} and non-{ at start */
2122 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2127 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2132 else if (sub[1][0] == '{')
2134 expand_string_message = string_sprintf("unknown encryption mechanism "
2135 "in \"%s\"", sub[1]);
2141 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2142 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2143 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2147 #define XSTR(s) STR(s)
2148 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2149 " subject=%s\n crypted=%s\n",
2150 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2155 /* If the encrypted string contains fewer than two characters (for the
2156 salt), force failure. Otherwise we get false positives: with an empty
2157 string the yield of crypt() is an empty string! */
2159 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2160 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2163 #endif /* SUPPORT_CRYPTEQ */
2164 } /* Switch for comparison conditions */
2166 return s; /* End of comparison conditions */
2169 /* and/or: computes logical and/or of several conditions */
2173 subcondptr = (yield == NULL)? NULL : &tempcond;
2174 combined_cond = (cond_type == ECOND_AND);
2176 while (isspace(*s)) s++;
2177 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2181 while (isspace(*s)) s++;
2182 if (*s == '}') break;
2185 expand_string_message = string_sprintf("each subcondition "
2186 "inside an \"%s{...}\" condition must be in its own {}", name);
2190 s = eval_condition(s+1, subcondptr);
2193 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2194 expand_string_message, name);
2197 while (isspace(*s)) s++;
2201 expand_string_message = string_sprintf("missing } at end of condition "
2202 "inside \"%s\" group", name);
2208 if (cond_type == ECOND_AND)
2210 combined_cond &= tempcond;
2211 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2212 } /* evaluate any more */
2215 combined_cond |= tempcond;
2216 if (combined_cond) subcondptr = NULL; /* once true, don't */
2217 } /* evaluate any more */
2221 if (yield != NULL) *yield = (combined_cond == testfor);
2225 /* Unknown condition */
2228 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2230 } /* End switch on condition type */
2232 /* Missing braces at start and end of data */
2234 COND_FAILED_CURLY_START:
2235 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2238 COND_FAILED_CURLY_END:
2239 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2243 /* A condition requires code that is not compiled */
2245 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2246 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2247 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2248 COND_FAILED_NOT_COMPILED:
2249 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2258 /*************************************************
2259 * Save numerical variables *
2260 *************************************************/
2262 /* This function is called from items such as "if" that want to preserve and
2263 restore the numbered variables.
2266 save_expand_string points to an array of pointers to set
2267 save_expand_nlength points to an array of ints for the lengths
2269 Returns: the value of expand max to save
2273 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2276 for (i = 0; i <= expand_nmax; i++)
2278 save_expand_nstring[i] = expand_nstring[i];
2279 save_expand_nlength[i] = expand_nlength[i];
2286 /*************************************************
2287 * Restore numerical variables *
2288 *************************************************/
2290 /* This function restored saved values of numerical strings.
2293 save_expand_nmax the number of strings to restore
2294 save_expand_string points to an array of pointers
2295 save_expand_nlength points to an array of ints
2301 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2302 int *save_expand_nlength)
2305 expand_nmax = save_expand_nmax;
2306 for (i = 0; i <= expand_nmax; i++)
2308 expand_nstring[i] = save_expand_nstring[i];
2309 expand_nlength[i] = save_expand_nlength[i];
2317 /*************************************************
2318 * Handle yes/no substrings *
2319 *************************************************/
2321 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2322 alternative substrings that depend on whether or not the condition was true,
2323 or the lookup or extraction succeeded. The substrings always have to be
2324 expanded, to check their syntax, but "skipping" is set when the result is not
2325 needed - this avoids unnecessary nested lookups.
2328 skipping TRUE if we were skipping when this item was reached
2329 yes TRUE if the first string is to be used, else use the second
2330 save_lookup a value to put back into lookup_value before the 2nd expansion
2331 sptr points to the input string pointer
2332 yieldptr points to the output string pointer
2333 sizeptr points to the output string size
2334 ptrptr points to the output string pointer
2335 type "lookup" or "if" or "extract" or "run", for error message
2337 Returns: 0 OK; lookup_value has been reset to save_lookup
2339 2 expansion failed because of bracketing error
2343 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2344 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2347 uschar *s = *sptr; /* Local value */
2348 uschar *sub1, *sub2;
2350 /* If there are no following strings, we substitute the contents of $value for
2351 lookups and for extractions in the success case. For the ${if item, the string
2352 "true" is substituted. In the fail case, nothing is substituted for all three
2355 while (isspace(*s)) s++;
2360 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2364 if (yes && lookup_value != NULL)
2365 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2366 Ustrlen(lookup_value));
2367 lookup_value = save_lookup;
2373 /* The first following string must be braced. */
2375 if (*s++ != '{') goto FAILED_CURLY;
2377 /* Expand the first substring. Forced failures are noticed only if we actually
2378 want this string. Set skipping in the call in the fail case (this will always
2379 be the case if we were already skipping). */
2381 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2382 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2383 expand_string_forcedfail = FALSE;
2384 if (*s++ != '}') goto FAILED_CURLY;
2386 /* If we want the first string, add it to the output */
2389 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2391 /* If this is called from a lookup or an extract, we want to restore $value to
2392 what it was at the start of the item, so that it has this value during the
2393 second string expansion. For the call from "if" or "run" to this function,
2394 save_lookup is set to lookup_value, so that this statement does nothing. */
2396 lookup_value = save_lookup;
2398 /* There now follows either another substring, or "fail", or nothing. This
2399 time, forced failures are noticed only if we want the second string. We must
2400 set skipping in the nested call if we don't want this string, or if we were
2401 already skipping. */
2403 while (isspace(*s)) s++;
2406 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2407 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2408 expand_string_forcedfail = FALSE;
2409 if (*s++ != '}') goto FAILED_CURLY;
2411 /* If we want the second string, add it to the output */
2414 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2417 /* If there is no second string, but the word "fail" is present when the use of
2418 the second string is wanted, set a flag indicating it was a forced failure
2419 rather than a syntactic error. Swallow the terminating } in case this is nested
2420 inside another lookup or if or extract. */
2425 s = read_name(name, sizeof(name), s, US"_");
2426 if (Ustrcmp(name, "fail") == 0)
2428 if (!yes && !skipping)
2430 while (isspace(*s)) s++;
2431 if (*s++ != '}') goto FAILED_CURLY;
2432 expand_string_message =
2433 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2434 expand_string_forcedfail = TRUE;
2440 expand_string_message =
2441 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2446 /* All we have to do now is to check on the final closing brace. */
2448 while (isspace(*s)) s++;
2449 if (*s++ == '}') goto RETURN;
2451 /* Get here if there is a bracketing failure */
2456 /* Get here for other failures */
2461 /* Update the input pointer value before returning */
2471 /*************************************************
2472 * Handle MD5 or SHA-1 computation for HMAC *
2473 *************************************************/
2475 /* These are some wrapping functions that enable the HMAC code to be a bit
2476 cleaner. A good compiler will spot the tail recursion.
2479 type HMAC_MD5 or HMAC_SHA1
2480 remaining are as for the cryptographic hash functions
2486 chash_start(int type, void *base)
2488 if (type == HMAC_MD5)
2489 md5_start((md5 *)base);
2491 sha1_start((sha1 *)base);
2495 chash_mid(int type, void *base, uschar *string)
2497 if (type == HMAC_MD5)
2498 md5_mid((md5 *)base, string);
2500 sha1_mid((sha1 *)base, string);
2504 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2506 if (type == HMAC_MD5)
2507 md5_end((md5 *)base, string, length, digest);
2509 sha1_end((sha1 *)base, string, length, digest);
2516 /********************************************************
2517 * prvs: Get last three digits of days since Jan 1, 1970 *
2518 ********************************************************/
2520 /* This is needed to implement the "prvs" BATV reverse
2523 Argument: integer "days" offset to add or substract to
2524 or from the current number of days.
2526 Returns: pointer to string containing the last three
2527 digits of the number of days since Jan 1, 1970,
2528 modified by the offset argument, NULL if there
2529 was an error in the conversion.
2534 prvs_daystamp(int day_offset)
2536 uschar *days = store_get(16);
2537 (void)string_format(days, 16, TIME_T_FMT,
2538 (time(NULL) + day_offset*86400)/86400);
2539 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2544 /********************************************************
2545 * prvs: perform HMAC-SHA1 computation of prvs bits *
2546 ********************************************************/
2548 /* This is needed to implement the "prvs" BATV reverse
2552 address RFC2821 Address to use
2553 key The key to use (must be less than 64 characters
2555 key_num Single-digit key number to use. Defaults to
2558 Returns: pointer to string containing the first three
2559 bytes of the final hash in hex format, NULL if
2560 there was an error in the process.
2564 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2566 uschar *hash_source, *p;
2567 int size = 0,offset = 0,i;
2569 void *use_base = &sha1_base;
2570 uschar innerhash[20];
2571 uschar finalhash[20];
2572 uschar innerkey[64];
2573 uschar outerkey[64];
2574 uschar *finalhash_hex = store_get(40);
2576 if (key_num == NULL)
2579 if (Ustrlen(key) > 64)
2582 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2583 string_cat(hash_source,&size,&offset,daystamp,3);
2584 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2585 hash_source[offset] = '\0';
2587 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2589 memset(innerkey, 0x36, 64);
2590 memset(outerkey, 0x5c, 64);
2592 for (i = 0; i < Ustrlen(key); i++)
2594 innerkey[i] ^= key[i];
2595 outerkey[i] ^= key[i];
2598 chash_start(HMAC_SHA1, use_base);
2599 chash_mid(HMAC_SHA1, use_base, innerkey);
2600 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2602 chash_start(HMAC_SHA1, use_base);
2603 chash_mid(HMAC_SHA1, use_base, outerkey);
2604 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2607 for (i = 0; i < 3; i++)
2609 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2610 *p++ = hex_digits[finalhash[i] & 0x0f];
2614 return finalhash_hex;
2620 /*************************************************
2621 * Join a file onto the output string *
2622 *************************************************/
2624 /* This is used for readfile and after a run expansion. It joins the contents
2625 of a file onto the output string, globally replacing newlines with a given
2626 string (optionally). The file is closed at the end.
2630 yield pointer to the expandable string
2631 sizep pointer to the current size
2632 ptrp pointer to the current position
2633 eol newline replacement string, or NULL
2635 Returns: new value of string pointer
2639 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2642 uschar buffer[1024];
2644 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2646 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2648 int len = Ustrlen(buffer);
2649 if (eol != NULL && buffer[len-1] == '\n') len--;
2650 yield = string_cat(yield, sizep, ptrp, buffer, len);
2651 if (buffer[len] != 0)
2652 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2655 if (yield != NULL) yield[*ptrp] = 0;
2663 /*************************************************
2664 * Evaluate numeric expression *
2665 *************************************************/
2667 /* This is a set of mutually recursive functions that evaluate a simple
2668 arithmetic expression involving only + - * / and parentheses. The only one that
2669 is called from elsewhere is eval_expr, whose interface is:
2672 sptr pointer to the pointer to the string - gets updated
2673 decimal TRUE if numbers are to be assumed decimal
2674 error pointer to where to put an error message - must be NULL on input
2675 endket TRUE if ')' must terminate - FALSE for external call
2678 Returns: on success: the value of the expression, with *error still NULL
2679 on failure: an undefined value, with *error = a message
2682 static int eval_sumterm(uschar **, BOOL, uschar **);
2685 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2688 int x = eval_sumterm(&s, decimal, error);
2691 while (*s == '+' || *s == '-')
2694 int y = eval_sumterm(&s, decimal, error);
2695 if (*error != NULL) break;
2696 if (op == '+') x += y; else x -= y;
2703 *error = US"expecting closing parenthesis";
2705 while (isspace(*(++s)));
2707 else if (*s != 0) *error = US"expecting + or -";
2716 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2721 while (isspace(*s)) s++;
2723 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2726 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2728 if (tolower(*s) == 'k') { n *= 1024; s++; }
2729 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2730 while (isspace (*s)) s++;
2735 n = eval_expr(&s, decimal, error, 1);
2739 *error = US"expecting number or opening parenthesis";
2746 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2749 int x = eval_term(&s, decimal, error);
2752 while (*s == '*' || *s == '/')
2755 int y = eval_term(&s, decimal, error);
2756 if (*error != NULL) break;
2757 if (op == '*') x *= y; else x /= y;
2767 /*************************************************
2769 *************************************************/
2771 /* Returns either an unchanged string, or the expanded string in stacking pool
2772 store. Interpreted sequences are:
2774 \... normal escaping rules
2775 $name substitutes the variable
2777 ${op:string} operates on the expanded string value
2778 ${item{arg1}{arg2}...} expands the args and then does the business
2779 some literal args are not enclosed in {}
2781 There are now far too many operators and item types to make it worth listing
2782 them here in detail any more.
2784 We use an internal routine recursively to handle embedded substrings. The
2785 external function follows. The yield is NULL if the expansion failed, and there
2786 are two cases: if something collapsed syntactically, or if "fail" was given
2787 as the action on a lookup failure. These can be distinguised by looking at the
2788 variable expand_string_forcedfail, which is TRUE in the latter case.
2790 The skipping flag is set true when expanding a substring that isn't actually
2791 going to be used (after "if" or "lookup") and it prevents lookups from
2792 happening lower down.
2794 Store usage: At start, a store block of the length of the input plus 64
2795 is obtained. This is expanded as necessary by string_cat(), which might have to
2796 get a new block, or might be able to expand the original. At the end of the
2797 function we can release any store above that portion of the yield block that
2798 was actually used. In many cases this will be optimal.
2800 However: if the first item in the expansion is a variable name or header name,
2801 we reset the store before processing it; if the result is in fresh store, we
2802 use that without copying. This is helpful for expanding strings like
2803 $message_headers which can get very long.
2806 string the string to be expanded
2807 ket_ends true if expansion is to stop at }
2808 left if not NULL, a pointer to the first character after the
2809 expansion is placed here (typically used with ket_ends)
2810 skipping TRUE for recursive calls when the value isn't actually going
2811 to be used (to allow for optimisation)
2813 Returns: NULL if expansion fails:
2814 expand_string_forcedfail is set TRUE if failure was forced
2815 expand_string_message contains a textual error message
2816 a pointer to the expanded string on success
2820 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2824 int size = Ustrlen(string)+ 64;
2826 uschar *yield = store_get(size);
2828 uschar *save_expand_nstring[EXPAND_MAXN+1];
2829 int save_expand_nlength[EXPAND_MAXN+1];
2831 expand_string_forcedfail = FALSE;
2832 expand_string_message = US"";
2839 /* \ escapes the next character, which must exist, or else
2840 the expansion fails. There's a special escape, \N, which causes
2841 copying of the subject verbatim up to the next \N. Otherwise,
2842 the escapes are the standard set. */
2848 expand_string_message = US"\\ at end of string";
2855 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2856 yield = string_cat(yield, &size, &ptr, t, s - t);
2857 if (*s != 0) s += 2;
2863 ch[0] = string_interpret_escape(&s);
2865 yield = string_cat(yield, &size, &ptr, ch, 1);
2871 /* Anything other than $ is just copied verbatim, unless we are
2872 looking for a terminating } character. */
2874 if (ket_ends && *s == '}') break;
2878 yield = string_cat(yield, &size, &ptr, s++, 1);
2882 /* No { after the $ - must be a plain name or a number for string
2883 match variable. There has to be a fudge for variables that are the
2884 names of header fields preceded by "$header_" because header field
2885 names can contain any printing characters except space and colon.
2886 For those that don't like typing this much, "$h_" is a synonym for
2887 "$header_". A non-existent header yields a NULL value; nothing is
2890 if (isalpha((*(++s))))
2895 s = read_name(name, sizeof(name), s, US"_");
2897 /* If this is the first thing to be expanded, release the pre-allocated
2900 if (ptr == 0 && yield != NULL)
2909 if (Ustrncmp(name, "h_", 2) == 0 ||
2910 Ustrncmp(name, "rh_", 3) == 0 ||
2911 Ustrncmp(name, "bh_", 3) == 0 ||
2912 Ustrncmp(name, "header_", 7) == 0 ||
2913 Ustrncmp(name, "rheader_", 8) == 0 ||
2914 Ustrncmp(name, "bheader_", 8) == 0)
2916 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2917 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2918 s = read_header_name(name, sizeof(name), s);
2919 value = find_header(name, FALSE, &newsize, want_raw, charset);
2921 /* If we didn't find the header, and the header contains a closing brace
2922 characters, this may be a user error where the terminating colon
2923 has been omitted. Set a flag to adjust the error message in this case.
2924 But there is no error here - nothing gets inserted. */
2928 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2937 value = find_variable(name, FALSE, skipping, &newsize);
2940 expand_string_message =
2941 string_sprintf("unknown variable name \"%s\"", name);
2946 /* If the data is known to be in a new buffer, newsize will be set to the
2947 size of that buffer. If this is the first thing in an expansion string,
2948 yield will be NULL; just point it at the new store instead of copying. Many
2949 expansion strings contain just one reference, so this is a useful
2950 optimization, especially for humungous headers. */
2952 len = Ustrlen(value);
2953 if (yield == NULL && newsize != 0)
2959 else yield = string_cat(yield, &size, &ptr, value, len);
2967 s = read_number(&n, s);
2968 if (n >= 0 && n <= expand_nmax)
2969 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2974 /* Otherwise, if there's no '{' after $ it's an error. */
2978 expand_string_message = US"$ not followed by letter, digit, or {";
2982 /* After { there can be various things, but they all start with
2983 an initial word, except for a number for a string match variable. */
2985 if (isdigit((*(++s))))
2988 s = read_number(&n, s);
2991 expand_string_message = US"} expected after number";
2994 if (n >= 0 && n <= expand_nmax)
2995 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3002 expand_string_message = US"letter or digit expected after ${";
3006 /* Allow "-" in names to cater for substrings with negative
3007 arguments. Since we are checking for known names after { this is
3010 s = read_name(name, sizeof(name), s, US"_-");
3011 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3015 /* Handle conditionals - preserve the values of the numerical expansion
3016 variables in case they get changed by a regular expression match in the
3017 condition. If not, they retain their external settings. At the end
3018 of this "if" section, they get restored to their previous values. */
3024 int save_expand_nmax =
3025 save_expand_strings(save_expand_nstring, save_expand_nlength);
3027 while (isspace(*s)) s++;
3028 next_s = eval_condition(s, skipping? NULL : &cond);
3029 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3032 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3033 cond? "true" : "false");
3037 /* The handling of "yes" and "no" result strings is now in a separate
3038 function that is also used by ${lookup} and ${extract} and ${run}. */
3040 switch(process_yesno(
3041 skipping, /* were previously skipping */
3042 cond, /* success/failure indicator */
3043 lookup_value, /* value to reset for string2 */
3044 &s, /* input pointer */
3045 &yield, /* output pointer */
3046 &size, /* output size */
3047 &ptr, /* output current point */
3048 US"if")) /* condition type */
3050 case 1: goto EXPAND_FAILED; /* when all is well, the */
3051 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3054 /* Restore external setting of expansion variables for continuation
3057 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3058 save_expand_nlength);
3062 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3063 expanding an internal string that isn't actually going to be used. All we
3064 need to do is check the syntax, so don't do a lookup at all. Preserve the
3065 values of the numerical expansion variables in case they get changed by a
3066 partial lookup. If not, they retain their external settings. At the end
3067 of this "lookup" section, they get restored to their previous values. */
3071 int stype, partial, affixlen, starflags;
3072 int expand_setup = 0;
3074 uschar *key, *filename, *affix;
3075 uschar *save_lookup_value = lookup_value;
3076 int save_expand_nmax =
3077 save_expand_strings(save_expand_nstring, save_expand_nlength);
3079 if ((expand_forbid & RDO_LOOKUP) != 0)
3081 expand_string_message = US"lookup expansions are not permitted";
3085 /* Get the key we are to look up for single-key+file style lookups.
3086 Otherwise set the key NULL pro-tem. */
3088 while (isspace(*s)) s++;
3091 key = expand_string_internal(s+1, TRUE, &s, skipping);
3092 if (key == NULL) goto EXPAND_FAILED;
3093 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3094 while (isspace(*s)) s++;
3098 /* Find out the type of database */
3102 expand_string_message = US"missing lookup type";
3106 /* The type is a string that may contain special characters of various
3107 kinds. Allow everything except space or { to appear; the actual content
3108 is checked by search_findtype_partial. */
3110 while (*s != 0 && *s != '{' && !isspace(*s))
3112 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3116 while (isspace(*s)) s++;
3118 /* Now check for the individual search type and any partial or default
3119 options. Only those types that are actually in the binary are valid. */
3121 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3125 expand_string_message = search_error_message;
3129 /* Check that a key was provided for those lookup types that need it,
3130 and was not supplied for those that use the query style. */
3132 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3136 expand_string_message = string_sprintf("missing {key} for single-"
3137 "key \"%s\" lookup", name);
3145 expand_string_message = string_sprintf("a single key was given for "
3146 "lookup type \"%s\", which is not a single-key lookup type", name);
3151 /* Get the next string in brackets and expand it. It is the file name for
3152 single-key+file lookups, and the whole query otherwise. In the case of
3153 queries that also require a file name (e.g. sqlite), the file name comes
3156 if (*s != '{') goto EXPAND_FAILED_CURLY;
3157 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3158 if (filename == NULL) goto EXPAND_FAILED;
3159 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3160 while (isspace(*s)) s++;
3162 /* If this isn't a single-key+file lookup, re-arrange the variables
3163 to be appropriate for the search_ functions. For query-style lookups,
3164 there is just a "key", and no file name. For the special query-style +
3165 file types, the query (i.e. "key") starts with a file name. */
3169 while (isspace(*filename)) filename++;
3172 if (mac_islookup(stype, lookup_querystyle))
3178 if (*filename != '/')
3180 expand_string_message = string_sprintf(
3181 "absolute file name expected for \"%s\" lookup", name);
3184 while (*key != 0 && !isspace(*key)) key++;
3185 if (*key != 0) *key++ = 0;
3189 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3190 the entry was not found. Note that there is no search_close() function.
3191 Files are left open in case of re-use. At suitable places in higher logic,
3192 search_tidyup() is called to tidy all open files. This can save opening
3193 the same file several times. However, files may also get closed when
3194 others are opened, if too many are open at once. The rule is that a
3195 handle should not be used after a second search_open().
3197 Request that a partial search sets up $1 and maybe $2 by passing
3198 expand_setup containing zero. If its value changes, reset expand_nmax,
3199 since new variables will have been set. Note that at the end of this
3200 "lookup" section, the old numeric variables are restored. */
3203 lookup_value = NULL;
3206 void *handle = search_open(filename, stype, 0, NULL, NULL);
3209 expand_string_message = search_error_message;
3212 lookup_value = search_find(handle, filename, key, partial, affix,
3213 affixlen, starflags, &expand_setup);
3214 if (search_find_defer)
3216 expand_string_message =
3217 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3218 search_error_message);
3221 if (expand_setup > 0) expand_nmax = expand_setup;
3224 /* The handling of "yes" and "no" result strings is now in a separate
3225 function that is also used by ${if} and ${extract}. */
3227 switch(process_yesno(
3228 skipping, /* were previously skipping */
3229 lookup_value != NULL, /* success/failure indicator */
3230 save_lookup_value, /* value to reset for string2 */
3231 &s, /* input pointer */
3232 &yield, /* output pointer */
3233 &size, /* output size */
3234 &ptr, /* output current point */
3235 US"lookup")) /* condition type */
3237 case 1: goto EXPAND_FAILED; /* when all is well, the */
3238 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3241 /* Restore external setting of expansion variables for carrying on
3242 at this level, and continue. */
3244 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3245 save_expand_nlength);
3249 /* If Perl support is configured, handle calling embedded perl subroutines,
3250 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3251 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3252 arguments (defined below). */
3254 #define EXIM_PERL_MAX_ARGS 8
3258 expand_string_message = US"\"${perl\" encountered, but this facility "
3259 "is not included in this binary";
3262 #else /* EXIM_PERL */
3264 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3267 if ((expand_forbid & RDO_PERL) != 0)
3269 expand_string_message = US"Perl calls are not permitted";
3273 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3276 case 1: goto EXPAND_FAILED_CURLY;
3278 case 3: goto EXPAND_FAILED;
3281 /* If skipping, we don't actually do anything */
3283 if (skipping) continue;
3285 /* Start the interpreter if necessary */
3287 if (!opt_perl_started)
3290 if (opt_perl_startup == NULL)
3292 expand_string_message = US"A setting of perl_startup is needed when "
3293 "using the Perl interpreter";
3296 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3297 initerror = init_perl(opt_perl_startup);
3298 if (initerror != NULL)
3300 expand_string_message =
3301 string_sprintf("error in perl_startup code: %s\n", initerror);
3304 opt_perl_started = TRUE;
3307 /* Call the function */
3309 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3310 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3311 sub_arg[0], sub_arg + 1);
3313 /* NULL yield indicates failure; if the message pointer has been set to
3314 NULL, the yield was undef, indicating a forced failure. Otherwise the
3315 message will indicate some kind of Perl error. */
3317 if (new_yield == NULL)
3319 if (expand_string_message == NULL)
3321 expand_string_message =
3322 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3323 "failure", sub_arg[0]);
3324 expand_string_forcedfail = TRUE;
3329 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3330 set during a callback from Perl. */
3332 expand_string_forcedfail = FALSE;
3336 #endif /* EXIM_PERL */
3338 /* Transform email address to "prvs" scheme to use
3339 as BATV-signed return path */
3346 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3348 case 1: goto EXPAND_FAILED_CURLY;
3350 case 3: goto EXPAND_FAILED;
3353 /* If skipping, we don't actually do anything */
3354 if (skipping) continue;
3356 /* sub_arg[0] is the address */
3357 domain = Ustrrchr(sub_arg[0],'@');
3358 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3360 expand_string_message = US"first parameter must be a qualified email address";
3364 /* Calculate the hash */
3365 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3368 expand_string_message = US"hmac-sha1 conversion failed";
3372 /* Now separate the domain from the local part */
3375 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3376 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3377 string_cat(yield,&size,&ptr,US"/",1);
3378 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3379 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3380 string_cat(yield,&size,&ptr,p,6);
3381 string_cat(yield,&size,&ptr,US"@",1);
3382 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3387 /* Check a prvs-encoded address for validity */
3389 case EITEM_PRVSCHECK:
3392 int mysize = 0, myptr = 0;
3395 /* Ugliness: We want to expand parameter 1 first, then set
3396 up expansion variables that are used in the expansion of
3397 parameter 2. So we clone the string for the first
3398 expansion, where we only expand paramter 1. */
3399 uschar *s_backup = string_copy(s);
3401 /* Reset expansion variables */
3402 prvscheck_result = NULL;
3403 prvscheck_address = NULL;
3404 prvscheck_keynum = NULL;
3406 switch(read_subs(sub_arg, 1, 1, &s_backup, skipping, FALSE, US"prvs"))
3408 case 1: goto EXPAND_FAILED_CURLY;
3410 case 3: goto EXPAND_FAILED;
3413 re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3416 if (regex_match_and_setup(re,sub_arg[0],0,-1)) {
3417 uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3418 uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3419 uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3420 uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3421 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3423 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3424 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3425 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3426 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3427 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3429 /* Set up expansion variables */
3430 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3431 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3432 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3433 prvscheck_address[myptr] = '\0';
3434 prvscheck_keynum = string_copy(key_num);
3436 /* Now re-expand all arguments in the usual manner */
3437 switch(read_subs(sub_arg, 3, 3, &s, skipping, TRUE, US"prvs"))
3439 case 1: goto EXPAND_FAILED_CURLY;
3441 case 3: goto EXPAND_FAILED;
3444 if (*sub_arg[2] == '\0')
3445 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3447 yield = string_cat(yield,&size,&ptr,sub_arg[2],Ustrlen(sub_arg[2]));
3449 /* Now we have the key and can check the address. */
3450 p = prvs_hmac_sha1(prvscheck_address, sub_arg[1], prvscheck_keynum, daystamp);
3453 expand_string_message = US"hmac-sha1 conversion failed";
3457 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3458 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3459 if (Ustrcmp(p,hash) == 0)
3461 /* Success, valid BATV address. Now check the expiry date. */
3462 uschar *now = prvs_daystamp(0);
3463 unsigned int inow = 0,iexpire = 1;
3465 (void)sscanf(CS now,"%u",&inow);
3466 (void)sscanf(CS daystamp,"%u",&iexpire);
3468 /* When "iexpire" is < 7, a "flip" has occured.
3469 Adjust "inow" accordingly. */
3470 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3474 prvscheck_result = US"1";
3475 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3479 prvscheck_result = NULL;
3480 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3485 prvscheck_result = NULL;
3486 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3491 /* Does not look like a prvs encoded address, return the empty string.
3492 We need to make sure all subs are expanded first. */
3493 switch(read_subs(sub_arg, 3, 3, &s, skipping, TRUE, US"prvs"))
3495 case 1: goto EXPAND_FAILED_CURLY;
3497 case 3: goto EXPAND_FAILED;
3504 /* Handle "readfile" to insert an entire file */
3506 case EITEM_READFILE:
3511 if ((expand_forbid & RDO_READFILE) != 0)
3513 expand_string_message = US"file insertions are not permitted";
3517 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3519 case 1: goto EXPAND_FAILED_CURLY;
3521 case 3: goto EXPAND_FAILED;
3524 /* If skipping, we don't actually do anything */
3526 if (skipping) continue;
3528 /* Open the file and read it */
3530 f = Ufopen(sub_arg[0], "rb");
3533 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3537 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3542 /* Handle "readsocket" to insert data from a Unix domain socket */
3544 case EITEM_READSOCK:
3550 struct sockaddr_un sockun; /* don't call this "sun" ! */
3554 if ((expand_forbid & RDO_READSOCK) != 0)
3556 expand_string_message = US"socket insertions are not permitted";
3560 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3561 because there may be a string for expansion on failure. */
3563 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3565 case 1: goto EXPAND_FAILED_CURLY;
3566 case 2: /* Won't occur: no end check */
3567 case 3: goto EXPAND_FAILED;
3570 /* Sort out timeout, if given */
3572 if (sub_arg[2] != NULL)
3574 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3577 expand_string_message = string_sprintf("bad time value %s",
3582 else sub_arg[3] = NULL; /* No eol if no timeout */
3584 /* If skipping, we don't actually do anything */
3588 /* Make a connection to the socket */
3590 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3592 expand_string_message = string_sprintf("failed to create socket: %s",
3597 sockun.sun_family = AF_UNIX;
3598 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3600 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3602 expand_string_message = string_sprintf("failed to connect to socket "
3603 "%s: %s", sub_arg[0], strerror(errno));
3606 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3608 /* Write the request string, if not empty */
3610 if (sub_arg[1][0] != 0)
3612 int len = Ustrlen(sub_arg[1]);
3613 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3615 if (write(fd, sub_arg[1], len) != len)
3617 expand_string_message = string_sprintf("request write to socket "
3618 "failed: %s", strerror(errno));
3623 /* Now we need to read from the socket, under a timeout. The function
3624 that reads a file can be used. */
3626 f = fdopen(fd, "rb");
3627 sigalrm_seen = FALSE;
3629 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3633 /* After a timeout, we restore the pointer in the result, that is,
3634 make sure we add nothing from the socket. */
3639 expand_string_message = US"socket read timed out";
3644 /* The whole thing has worked (or we were skipping). If there is a
3645 failure string following, we need to skip it. */
3649 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3651 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3652 while (isspace(*s)) s++;
3654 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3657 /* Come here on failure to create socket, connect socket, write to the
3658 socket, or timeout on reading. If another substring follows, expand and
3659 use it. Otherwise, those conditions give expand errors. */
3662 if (*s != '{') goto EXPAND_FAILED;
3663 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3664 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3665 if (arg == NULL) goto EXPAND_FAILED;
3666 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3667 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3668 while (isspace(*s)) s++;
3669 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3673 /* Handle "run" to execute a program. */
3685 if ((expand_forbid & RDO_RUN) != 0)
3687 expand_string_message = US"running a command is not permitted";
3691 while (isspace(*s)) s++;
3692 if (*s != '{') goto EXPAND_FAILED_CURLY;
3693 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3694 if (arg == NULL) goto EXPAND_FAILED;
3695 while (isspace(*s)) s++;
3696 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3698 if (skipping) /* Just pretend it worked when we're skipping */
3704 if (!transport_set_up_command(&argv, /* anchor for arg list */
3705 arg, /* raw command */
3706 FALSE, /* don't expand the arguments */
3707 0, /* not relevant when... */
3708 NULL, /* no transporting address */
3709 US"${run} expansion", /* for error messages */
3710 &expand_string_message)) /* where to put error message */
3715 /* Create the child process, making it a group leader. */
3717 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3721 expand_string_message =
3722 string_sprintf("couldn't create child process: %s", strerror(errno));
3726 /* Nothing is written to the standard input. */
3730 /* Wait for the process to finish, applying the timeout, and inspect its
3731 return code for serious disasters. Simple non-zero returns are passed on.
3734 if ((runrc = child_close(pid, 60)) < 0)
3738 expand_string_message = string_sprintf("command timed out");
3739 killpg(pid, SIGKILL); /* Kill the whole process group */
3742 else if (runrc == -257)
3743 expand_string_message = string_sprintf("wait() failed: %s",
3747 expand_string_message = string_sprintf("command killed by signal %d",
3753 /* Read the pipe to get the command's output into $value (which is kept
3754 in lookup_value). */
3756 f = fdopen(fd_out, "rb");
3757 lookup_value = NULL;
3758 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3762 /* Process the yes/no strings; $value may be useful in both cases */
3764 switch(process_yesno(
3765 skipping, /* were previously skipping */
3766 runrc == 0, /* success/failure indicator */
3767 lookup_value, /* value to reset for string2 */
3768 &s, /* input pointer */
3769 &yield, /* output pointer */
3770 &size, /* output size */
3771 &ptr, /* output current point */
3772 US"run")) /* condition type */
3774 case 1: goto EXPAND_FAILED; /* when all is well, the */
3775 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3781 /* Handle character translation for "tr" */
3789 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3791 case 1: goto EXPAND_FAILED_CURLY;
3793 case 3: goto EXPAND_FAILED;
3796 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3797 o2m = Ustrlen(sub[2]) - 1;
3799 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3801 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3805 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3812 /* Handle "hash", "length", "nhash", and "substr" when they are given with
3813 expanded arguments. */
3823 int val[2] = { 0, -1 };
3826 /* "length" takes only 2 arguments whereas the others take 2 or 3.
3827 Ensure that sub[2] is set in the ${length case. */
3830 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
3833 case 1: goto EXPAND_FAILED_CURLY;
3835 case 3: goto EXPAND_FAILED;
3838 /* Juggle the arguments if there are only two of them: always move the
3839 string to the last position and make ${length{n}{str}} equivalent to
3840 ${substr{0}{n}{str}}. See the defaults for val[] above. */
3846 if (item_type == EITEM_LENGTH)
3853 for (i = 0; i < 2; i++)
3855 if (sub[i] == NULL) continue;
3856 val[i] = (int)Ustrtol(sub[i], &ret, 10);
3857 if (*ret != 0 || (i != 0 && val[i] < 0))
3859 expand_string_message = string_sprintf("\"%s\" is not a%s number "
3860 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
3866 (item_type == EITEM_HASH)?
3867 compute_hash(sub[2], val[0], val[1], &len) :
3868 (item_type == EITEM_NHASH)?
3869 compute_nhash(sub[2], val[0], val[1], &len) :
3870 extract_substr(sub[2], val[0], val[1], &len);
3872 if (ret == NULL) goto EXPAND_FAILED;
3873 yield = string_cat(yield, &size, &ptr, ret, len);
3877 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
3878 This code originally contributed by Steve Haslam. It currently supports
3879 the use of MD5 and SHA-1 hashes.
3881 We need some workspace that is large enough to handle all the supported
3882 hash types. Use macros to set the sizes rather than be too elaborate. */
3884 #define MAX_HASHLEN 20
3885 #define MAX_HASHBLOCKLEN 64
3894 int hashlen; /* Number of octets for the hash algorithm's output */
3895 int hashblocklen; /* Number of octets the hash algorithm processes */
3897 unsigned int keylen;
3899 uschar keyhash[MAX_HASHLEN];
3900 uschar innerhash[MAX_HASHLEN];
3901 uschar finalhash[MAX_HASHLEN];
3902 uschar finalhash_hex[2*MAX_HASHLEN];
3903 uschar innerkey[MAX_HASHBLOCKLEN];
3904 uschar outerkey[MAX_HASHBLOCKLEN];
3906 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
3908 case 1: goto EXPAND_FAILED_CURLY;
3910 case 3: goto EXPAND_FAILED;
3913 if (Ustrcmp(sub[0], "md5") == 0)
3916 use_base = &md5_base;
3920 else if (Ustrcmp(sub[0], "sha1") == 0)
3923 use_base = &sha1_base;
3929 expand_string_message =
3930 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
3935 keylen = Ustrlen(keyptr);
3937 /* If the key is longer than the hash block length, then hash the key
3940 if (keylen > hashblocklen)
3942 chash_start(type, use_base);
3943 chash_end(type, use_base, keyptr, keylen, keyhash);
3948 /* Now make the inner and outer key values */
3950 memset(innerkey, 0x36, hashblocklen);
3951 memset(outerkey, 0x5c, hashblocklen);
3953 for (i = 0; i < keylen; i++)
3955 innerkey[i] ^= keyptr[i];
3956 outerkey[i] ^= keyptr[i];
3959 /* Now do the hashes */
3961 chash_start(type, use_base);
3962 chash_mid(type, use_base, innerkey);
3963 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
3965 chash_start(type, use_base);
3966 chash_mid(type, use_base, outerkey);
3967 chash_end(type, use_base, innerhash, hashlen, finalhash);
3969 /* Encode the final hash as a hex string */
3972 for (i = 0; i < hashlen; i++)
3974 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3975 *p++ = hex_digits[finalhash[i] & 0x0f];
3978 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
3979 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
3981 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
3986 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
3987 We have to save the numerical variables and restore them afterwards. */
3992 int moffset, moffsetextra, slen;
3995 const uschar *rerror;
3998 int save_expand_nmax =
3999 save_expand_strings(save_expand_nstring, save_expand_nlength);
4001 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4003 case 1: goto EXPAND_FAILED_CURLY;
4005 case 3: goto EXPAND_FAILED;
4008 /* Compile the regular expression */
4010 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4015 expand_string_message = string_sprintf("regular expression error in "
4016 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4020 /* Now run a loop to do the substitutions as often as necessary. It ends
4021 when there are no more matches. Take care over matches of the null string;
4022 do the same thing as Perl does. */
4025 slen = Ustrlen(sub[0]);
4026 moffset = moffsetextra = 0;
4031 int ovector[3*(EXPAND_MAXN+1)];
4032 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4033 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4037 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4038 is not necessarily the end. We want to repeat the match from one
4039 character further along, but leaving the basic offset the same (for
4040 copying below). We can't be at the end of the string - that was checked
4041 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4042 finished; copy the remaining string and end the loop. */
4052 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4056 /* Match - set up for expanding the replacement. */
4058 if (n == 0) n = EXPAND_MAXN + 1;
4060 for (nn = 0; nn < n*2; nn += 2)
4062 expand_nstring[expand_nmax] = subject + ovector[nn];
4063 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4067 /* Copy the characters before the match, plus the expanded insertion. */
4069 yield = string_cat(yield, &size, &ptr, subject + moffset,
4070 ovector[0] - moffset);
4071 insert = expand_string(sub[2]);
4072 if (insert == NULL) goto EXPAND_FAILED;
4073 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4075 moffset = ovector[1];
4079 /* If we have matched an empty string, first check to see if we are at
4080 the end of the subject. If so, the loop is over. Otherwise, mimic
4081 what Perl's /g options does. This turns out to be rather cunning. First
4082 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4083 string at the same point. If this fails (picked up above) we advance to
4084 the next character. */
4086 if (ovector[0] == ovector[1])
4088 if (ovector[0] == slen) break;
4089 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4093 /* All done - restore numerical variables. */
4095 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4096 save_expand_nlength);
4100 /* Handle keyed and numbered substring extraction. If the first argument
4101 consists entirely of digits, then a numerical extraction is assumed. */
4107 int field_number = 1;
4108 BOOL field_number_set = FALSE;
4109 uschar *save_lookup_value = lookup_value;
4111 int save_expand_nmax =
4112 save_expand_strings(save_expand_nstring, save_expand_nlength);
4114 /* Read the arguments */
4116 for (i = 0; i < j; i++)
4118 while (isspace(*s)) s++;
4121 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4122 if (sub[i] == NULL) goto EXPAND_FAILED;
4123 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4125 /* After removal of leading and trailing white space, the first
4126 argument must not be empty; if it consists entirely of digits
4127 (optionally preceded by a minus sign), this is a numerical
4128 extraction, and we expect 3 arguments. */
4136 while (isspace(*p)) p++;
4140 while (len > 0 && isspace(p[len-1])) len--;
4145 expand_string_message = US"first argument of \"extract\" must "
4155 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4159 j = 3; /* Need 3 args */
4160 field_number_set = TRUE;
4164 else goto EXPAND_FAILED_CURLY;
4167 /* Extract either the numbered or the keyed substring into $value. If
4168 skipping, just pretend the extraction failed. */
4170 lookup_value = skipping? NULL : field_number_set?
4171 expand_gettokened(field_number, sub[1], sub[2]) :
4172 expand_getkeyed(sub[0], sub[1]);
4174 /* If no string follows, $value gets substituted; otherwise there can
4175 be yes/no strings, as for lookup or if. */
4177 switch(process_yesno(
4178 skipping, /* were previously skipping */
4179 lookup_value != NULL, /* success/failure indicator */
4180 save_lookup_value, /* value to reset for string2 */
4181 &s, /* input pointer */
4182 &yield, /* output pointer */
4183 &size, /* output size */
4184 &ptr, /* output current point */
4185 US"extract")) /* condition type */
4187 case 1: goto EXPAND_FAILED; /* when all is well, the */
4188 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4191 /* All done - restore numerical variables. */
4193 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4194 save_expand_nlength);
4200 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4201 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4202 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4203 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4205 #define EXPAND_DLFUNC_MAX_ARGS 8
4208 #ifndef EXPAND_DLFUNC
4209 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4210 "is not included in this binary";
4213 #else /* EXPAND_DLFUNC */
4216 exim_dlfunc_t *func;
4219 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4221 if ((expand_forbid & RDO_DLFUNC) != 0)
4223 expand_string_message =
4224 US"dynamically-loaded functions are not permitted";
4228 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4231 case 1: goto EXPAND_FAILED_CURLY;
4233 case 3: goto EXPAND_FAILED;
4236 /* If skipping, we don't actually do anything */
4238 if (skipping) continue;
4240 /* Look up the dynamically loaded object handle in the tree. If it isn't
4241 found, dlopen() the file and put the handle in the tree for next time. */
4243 t = tree_search(dlobj_anchor, argv[0]);
4246 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4249 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4250 argv[0], dlerror());
4251 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4254 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4255 Ustrcpy(t->name, argv[0]);
4256 t->data.ptr = handle;
4257 (void)tree_insertnode(&dlobj_anchor, t);
4260 /* Having obtained the dynamically loaded object handle, look up the
4261 function pointer. */
4263 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4266 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4267 "%s", argv[1], argv[0], dlerror());
4268 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4272 /* Call the function and work out what to do with the result. If it
4273 returns OK, we have a replacement string; if it returns DEFER then
4274 expansion has failed in a non-forced manner; if it returns FAIL then
4275 failure was forced; if it returns ERROR or any other value there's a
4276 problem, so panic slightly. */
4279 for (argc = 0; argv[argc] != NULL; argc++);
4280 status = func(&result, argc - 2, &argv[2]);
4283 if (result == NULL) result = US"";
4284 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4289 expand_string_message = result == NULL ? US"(no message)" : result;
4290 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4291 else if(status != FAIL)
4292 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4293 argv[0], argv[1], status, expand_string_message);
4297 #endif /* EXPAND_DLFUNC */
4300 /* Control reaches here if the name is not recognized as one of the more
4301 complicated expansion items. Check for the "operator" syntax (name terminated
4302 by a colon). Some of the operators have arguments, separated by _ from the
4309 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4310 if (sub == NULL) goto EXPAND_FAILED;
4313 /* Owing to an historical mis-design, an underscore may be part of the
4314 operator name, or it may introduce arguments. We therefore first scan the
4315 table of names that contain underscores. If there is no match, we cut off
4316 the arguments and then scan the main table. */
4318 c = chop_match(name, op_table_underscore,
4319 sizeof(op_table_underscore)/sizeof(uschar *));
4323 arg = Ustrchr(name, '_');
4324 if (arg != NULL) *arg = 0;
4325 c = chop_match(name, op_table_main,
4326 sizeof(op_table_main)/sizeof(uschar *));
4327 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4328 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
4331 /* If we are skipping, we don't need to perform the operation at all.
4332 This matters for operations like "mask", because the data may not be
4333 in the correct format when skipping. For example, the expression may test
4334 for the existence of $sender_host_address before trying to mask it. For
4335 other operations, doing them may not fail, but it is a waste of time. */
4337 if (skipping && c >= 0) continue;
4339 /* Otherwise, switch on the operator type */
4346 unsigned long int n = Ustrtoul(sub, &t, 10);
4349 expand_string_message = string_sprintf("argument for base62 "
4350 "operator is \"%s\", which is not a decimal number", sub);
4353 t = string_base62(n);
4354 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4362 unsigned long int n = 0;
4365 uschar *t = Ustrchr(base62_chars, *tt++);
4368 expand_string_message = string_sprintf("argument for base62d "
4369 "operator is \"%s\", which is not a base 62 number", sub);
4372 n = n * 62 + (t - base62_chars);
4374 (void)sprintf(CS buf, "%ld", n);
4375 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4381 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4382 if (expanded == NULL)
4384 expand_string_message =
4385 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4386 expand_string_message);
4389 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4396 uschar *t = sub - 1;
4397 while (*(++t) != 0) { *t = tolower(*t); count++; }
4398 yield = string_cat(yield, &size, &ptr, sub, count);
4405 uschar *t = sub - 1;
4406 while (*(++t) != 0) { *t = toupper(*t); count++; }
4407 yield = string_cat(yield, &size, &ptr, sub, count);
4418 md5_end(&base, sub, Ustrlen(sub), digest);
4419 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4420 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4431 sha1_end(&base, sub, Ustrlen(sub), digest);
4432 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4433 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4437 /* Convert hex encoding to base64 encoding */
4447 for (enc = sub; *enc != 0; enc++)
4449 if (!isxdigit(*enc))
4451 expand_string_message = string_sprintf("\"%s\" is not a hex "
4460 expand_string_message = string_sprintf("\"%s\" contains an odd "
4461 "number of characters", sub);
4465 while ((c = *in++) != 0)
4467 if (isdigit(c)) c -= '0';
4468 else c = toupper(c) - 'A' + 10;
4480 enc = auth_b64encode(sub, out - sub);
4481 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4485 /* mask applies a mask to an IP address; for example the result of
4486 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4493 int mask, maskoffset;
4494 int type = string_is_ip_address(sub, &maskoffset);
4499 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4504 if (maskoffset == 0)
4506 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4511 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4513 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4515 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4520 /* Convert the address to binary integer(s) and apply the mask */
4522 sub[maskoffset] = 0;
4523 count = host_aton(sub, binary);
4524 host_mask(count, binary, mask);
4526 /* Convert to masked textual format and add to output. */
4528 yield = string_cat(yield, &size, &ptr, buffer,
4529 host_nmtoa(count, binary, mask, buffer, '.'));
4534 case EOP_LOCAL_PART:
4538 int start, end, domain;
4539 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4543 if (c != EOP_DOMAIN)
4545 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4546 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4548 else if (domain != 0)
4551 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4557 /* quote puts a string in quotes if it is empty or contains anything
4558 other than alphamerics, underscore, dot, or hyphen.
4560 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4561 be quoted in order to be a valid local part.
4563 In both cases, newlines and carriage returns are converted into \n and \r
4567 case EOP_QUOTE_LOCAL_PART:
4570 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4571 uschar *t = sub - 1;
4575 while (!needs_quote && *(++t) != 0)
4576 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4578 else /* EOP_QUOTE_LOCAL_PART */
4580 while (!needs_quote && *(++t) != 0)
4581 needs_quote = !isalnum(*t) &&
4582 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4583 (*t != '.' || t == sub || t[1] == 0);
4588 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4593 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4594 else if (*t == '\r')
4595 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4598 if (*t == '\\' || *t == '"')
4599 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4600 yield = string_cat(yield, &size, &ptr, t, 1);
4603 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4605 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4609 /* quote_lookuptype does lookup-specific quoting */
4614 uschar *opt = Ustrchr(arg, '_');
4616 if (opt != NULL) *opt++ = 0;
4618 n = search_findtype(arg, Ustrlen(arg));
4621 expand_string_message = search_error_message;
4625 if (lookup_list[n].quote != NULL)
4626 sub = (lookup_list[n].quote)(sub, opt);
4627 else if (opt != NULL) sub = NULL;
4631 expand_string_message = string_sprintf(
4632 "\"%s\" unrecognized after \"${quote_%s\"",
4637 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4641 /* rx quote sticks in \ before any non-alphameric character so that
4642 the insertion works in a regular expression. */
4646 uschar *t = sub - 1;
4650 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4651 yield = string_cat(yield, &size, &ptr, t, 1);
4656 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4657 prescribed by the RFC, if there are characters that need to be encoded */
4661 uschar buffer[2048];
4662 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4663 buffer, sizeof(buffer));
4664 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4668 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4678 if (c > 255) c = '_';
4680 yield = string_cat(yield, &size, &ptr, buff, 1);
4685 /* escape turns all non-printing characters into escape sequences. */
4689 uschar *t = string_printing(sub);
4690 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4694 /* Handle numeric expression evaluation */
4699 uschar *save_sub = sub;
4700 uschar *error = NULL;
4701 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4704 expand_string_message = string_sprintf("error in expression "
4705 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4709 sprintf(CS var_buffer, "%d", n);
4710 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4714 /* Handle time period formating */
4716 case EOP_TIME_INTERVAL:
4719 uschar *t = read_number(&n, sub);
4720 if (*t != 0) /* Not A Number*/
4722 expand_string_message = string_sprintf("string \"%s\" is not a "
4723 "positive number in \"%s\" operator", sub, name);
4726 t = readconf_printtime(n);
4727 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4731 /* Convert string to base64 encoding */
4735 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4736 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4740 /* strlen returns the length of the string */
4745 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4746 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4750 /* length_n or l_n takes just the first n characters or the whole string,
4751 whichever is the shorter;
4753 substr_m_n, and s_m_n take n characters from offset m; negative m take
4754 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4755 takes the rest, either to the right or to the left.
4757 hash_n or h_n makes a hash of length n from the string, yielding n
4758 characters from the set a-z; hash_n_m makes a hash of length n, but
4759 uses m characters from the set a-zA-Z0-9.
4761 nhash_n returns a single number between 0 and n-1 (in text form), while
4762 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4763 between 0 and n-1 and the second between 0 and m-1. */
4783 expand_string_message = string_sprintf("missing values after %s",
4788 /* "length" has only one argument, effectively being synonymous with
4791 if (c == EOP_LENGTH || c == EOP_L)
4797 /* The others have one or two arguments; for "substr" the first may be
4798 negative. The second being negative means "not supplied". */
4803 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
4806 /* Read up to two numbers, separated by underscores */
4811 if (arg != ret && *arg == '_' && pn == &value1)
4815 if (arg[1] != 0) arg++;
4817 else if (!isdigit(*arg))
4819 expand_string_message =
4820 string_sprintf("non-digit after underscore in \"%s\"", name);
4823 else *pn = (*pn)*10 + *arg++ - '0';
4827 /* Perform the required operation */
4830 (c == EOP_HASH || c == EOP_H)?
4831 compute_hash(sub, value1, value2, &len) :
4832 (c == EOP_NHASH || c == EOP_NH)?
4833 compute_nhash(sub, value1, value2, &len) :
4834 extract_substr(sub, value1, value2, &len);
4836 if (ret == NULL) goto EXPAND_FAILED;
4837 yield = string_cat(yield, &size, &ptr, ret, len);
4847 uschar **modetable[3];
4852 if ((expand_forbid & RDO_EXISTS) != 0)
4854 expand_string_message = US"Use of the stat() expansion is not permitted";
4858 if (stat(CS sub, &st) < 0)
4860 expand_string_message = string_sprintf("stat(%s) failed: %s",
4861 sub, strerror(errno));
4865 switch (mode & S_IFMT)
4867 case S_IFIFO: smode[0] = 'p'; break;
4868 case S_IFCHR: smode[0] = 'c'; break;
4869 case S_IFDIR: smode[0] = 'd'; break;
4870 case S_IFBLK: smode[0] = 'b'; break;
4871 case S_IFREG: smode[0] = '-'; break;
4872 default: smode[0] = '?'; break;
4875 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
4876 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
4877 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
4879 for (i = 0; i < 3; i++)
4881 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
4886 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
4887 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
4888 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
4889 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
4890 (long)st.st_gid, st.st_size, (long)st.st_atime,
4891 (long)st.st_mtime, (long)st.st_ctime);
4892 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
4896 /* Unknown operator */
4899 expand_string_message =
4900 string_sprintf("unknown expansion operator \"%s\"", name);
4905 /* Handle a plain name. If this is the first thing in the expansion, release
4906 the pre-allocated buffer. If the result data is known to be in a new buffer,
4907 newsize will be set to the size of that buffer, and we can just point at that
4908 store instead of copying. Many expansion strings contain just one reference,
4909 so this is a useful optimization, especially for humungous headers
4910 ($message_headers). */
4922 value = find_variable(name, FALSE, skipping, &newsize);
4925 expand_string_message =
4926 string_sprintf("unknown variable in \"${%s}\"", name);
4929 len = Ustrlen(value);
4930 if (yield == NULL && newsize != 0)
4936 else yield = string_cat(yield, &size, &ptr, value, len);
4940 /* Else there's something wrong */
4942 expand_string_message =
4943 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
4944 "in a variable reference)", name);
4948 /* If we hit the end of the string when ket_ends is set, there is a missing
4949 terminating brace. */
4951 if (ket_ends && *s == 0)
4953 expand_string_message = malformed_header?
4954 US"missing } at end of string - could be header name not terminated by colon"
4956 US"missing } at end of string";
4960 /* Expansion succeeded; yield may still be NULL here if nothing was actually
4961 added to the string. If so, set up an empty string. Add a terminating zero. If
4962 left != NULL, return a pointer to the terminator. */
4964 if (yield == NULL) yield = store_get(1);
4966 if (left != NULL) *left = s;
4968 /* Any stacking store that was used above the final string is no longer needed.
4969 In many cases the final string will be the first one that was got and so there
4970 will be optimal store usage. */
4972 store_reset(yield + ptr + 1);
4975 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
4977 if (skipping) debug_printf("skipping: result is not used\n");
4981 /* This is the failure exit: easiest to program with a goto. We still need
4982 to update the pointer to the terminator, for cases of nested calls with "fail".
4985 EXPAND_FAILED_CURLY:
4986 expand_string_message = malformed_header?
4987 US"missing or misplaced { or } - could be header name not terminated by colon"
4989 US"missing or misplaced { or }";
4991 /* At one point, Exim reset the store to yield (if yield was not NULL), but
4992 that is a bad idea, because expand_string_message is in dynamic store. */
4995 if (left != NULL) *left = s;
4998 debug_printf("failed to expand: %s\n", string);
4999 debug_printf(" error message: %s\n", expand_string_message);
5000 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5006 /* This is the external function call. Do a quick check for any expansion
5007 metacharacters, and if there are none, just return the input string.
5009 Argument: the string to be expanded
5010 Returns: the expanded string, or NULL if expansion failed; if failure was
5011 due to a lookup deferring, search_find_defer will be TRUE
5015 expand_string(uschar *string)
5017 search_find_defer = FALSE;
5018 malformed_header = FALSE;
5019 return (Ustrpbrk(string, "$\\") == NULL)? string :
5020 expand_string_internal(string, FALSE, NULL, FALSE);
5025 /*************************************************
5027 *************************************************/
5029 /* Now and again we want to expand a string and be sure that the result is in a
5030 new bit of store. This function does that.
5032 Argument: the string to be expanded
5033 Returns: the expanded string, always in a new bit of store, or NULL
5037 expand_string_copy(uschar *string)
5039 uschar *yield = expand_string(string);
5040 if (yield == string) yield = string_copy(string);
5046 /*************************************************
5047 * Expand and interpret as an integer *
5048 *************************************************/
5050 /* Expand a string, and convert the result into an integer.
5052 Argument: the string to be expanded
5054 Returns: the integer value, or
5055 -1 for an expansion error ) in both cases, message in
5056 -2 for an integer interpretation error ) expand_string_message
5061 expand_string_integer(uschar *string)
5064 uschar *s = expand_string(string);
5065 uschar *msg = US"invalid integer \"%s\"";
5068 if (s == NULL) return -1;
5070 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5071 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5072 systems, so we set it zero ourselves. */
5075 value = strtol(CS s, CSS &endptr, 0);
5079 msg = US"integer expected but \"%s\" found";
5083 /* Ensure we can cast this down to an int */
5084 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5086 if (errno != ERANGE)
5088 if (tolower(*endptr) == 'k')
5090 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5094 else if (tolower(*endptr) == 'm')
5096 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5098 else value *= 1024*1024;
5102 if (errno == ERANGE)
5103 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5106 while (isspace(*endptr)) endptr++;
5107 if (*endptr == 0) return (int)value;
5111 expand_string_message = string_sprintf(CS msg, s);
5116 /*************************************************
5117 **************************************************
5118 * Stand-alone test program *
5119 **************************************************
5120 *************************************************/
5126 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5128 int ovector[3*(EXPAND_MAXN+1)];
5129 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5130 ovector, sizeof(ovector)/sizeof(int));
5131 BOOL yield = n >= 0;
5132 if (n == 0) n = EXPAND_MAXN + 1;
5136 expand_nmax = (setup < 0)? 0 : setup + 1;
5137 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5139 expand_nstring[expand_nmax] = subject + ovector[nn];
5140 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5148 int main(int argc, uschar **argv)
5151 uschar buffer[1024];
5153 debug_selector = D_v;
5154 debug_file = stderr;
5155 debug_fd = fileno(debug_file);
5156 big_buffer = malloc(big_buffer_size);
5158 for (i = 1; i < argc; i++)
5160 if (argv[i][0] == '+')
5162 debug_trace_memory = 2;
5165 if (isdigit(argv[i][0]))
5166 debug_selector = Ustrtol(argv[i], NULL, 0);
5168 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5172 eldap_default_servers = argv[i];
5175 mysql_servers = argv[i];
5178 pgsql_servers = argv[i];
5182 else opt_perl_startup = argv[i];
5186 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5188 expand_nstring[1] = US"string 1....";
5189 expand_nlength[1] = 8;
5193 if (opt_perl_startup != NULL)
5196 printf("Starting Perl interpreter\n");
5197 errstr = init_perl(opt_perl_startup);
5200 printf("** error in perl_startup code: %s\n", errstr);
5201 return EXIT_FAILURE;
5204 #endif /* EXIM_PERL */
5206 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5208 void *reset_point = store_get(0);
5209 uschar *yield = expand_string(buffer);
5212 printf("%s\n", yield);
5213 store_reset(reset_point);
5217 if (search_find_defer) printf("search_find deferred\n");
5218 printf("Failed: %s\n", expand_string_message);
5219 if (expand_string_forcedfail) printf("Forced failure\n");
5231 /* End of expand.c */