1 /* $Cambridge: exim/src/src/expand.c,v 1.38 2005/08/01 14:00:35 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)
1430 s = find_header(US"from:", exists_only, newsize, FALSE, headers_charset);
1431 return (s == NULL)? US"" : s;
1433 /* A recipients list is available only during system message filtering,
1434 during ACL processing after DATA, and while expanding pipe commands
1435 generated from a system filter, but not elsewhere. */
1437 case vtype_recipients:
1438 if (!enable_dollar_recipients) return NULL; else
1443 s = store_get(size);
1444 for (i = 0; i < recipients_count; i++)
1446 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1447 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1448 Ustrlen(recipients_list[i].address));
1450 s[ptr] = 0; /* string_cat() leaves room */
1457 sprintf(CS var_buffer, "%d",
1458 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1465 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1466 sprintf(CS var_buffer, "%d", inodes);
1472 return NULL; /* Unknown variable name */
1478 /*************************************************
1479 * Read and expand substrings *
1480 *************************************************/
1482 /* This function is called to read and expand argument substrings for various
1483 expansion items. Some have a minimum requirement that is less than the maximum;
1484 in these cases, the first non-present one is set to NULL.
1487 sub points to vector of pointers to set
1488 n maximum number of substrings
1490 sptr points to current string pointer
1491 skipping the skipping flag
1492 check_end if TRUE, check for final '}'
1493 name name of item, for error message
1495 Returns: 0 OK; string pointer updated
1496 1 curly bracketing error (too few arguments)
1497 2 too many arguments (only if check_end is set); message set
1498 3 other error (expansion failure)
1502 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1503 BOOL check_end, uschar *name)
1508 while (isspace(*s)) s++;
1509 for (i = 0; i < n; i++)
1513 if (i < m) return 1;
1517 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1518 if (sub[i] == NULL) return 3;
1519 if (*s++ != '}') return 1;
1520 while (isspace(*s)) s++;
1522 if (check_end && *s++ != '}')
1526 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1527 "(max is %d)", name, n);
1540 /*************************************************
1541 * Read and evaluate a condition *
1542 *************************************************/
1546 s points to the start of the condition text
1547 yield points to a BOOL to hold the result of the condition test;
1548 if NULL, we are just reading through a condition that is
1549 part of an "or" combination to check syntax, or in a state
1550 where the answer isn't required
1552 Returns: a pointer to the first character after the condition, or
1557 eval_condition(uschar *s, BOOL *yield)
1559 BOOL testfor = TRUE;
1560 BOOL tempcond, combined_cond;
1562 int i, rc, cond_type, roffset;
1564 struct stat statbuf;
1569 const uschar *rerror;
1573 while (isspace(*s)) s++;
1574 if (*s == '!') { testfor = !testfor; s++; } else break;
1577 /* Numeric comparisons are symbolic */
1579 if (*s == '=' || *s == '>' || *s == '<')
1591 /* All other conditions are named */
1593 else s = read_name(name, 256, s, US"_");
1595 /* If we haven't read a name, it means some non-alpha character is first. */
1599 expand_string_message = string_sprintf("condition name expected, "
1600 "but found \"%.16s\"", s);
1604 /* Find which condition we are dealing with, and switch on it */
1606 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1609 /* def: tests for a non-empty variable, or for the existence of a header. If
1610 yield == NULL we are in a skipping state, and don't care about the answer. */
1615 expand_string_message = US"\":\" expected after \"def\"";
1619 s = read_name(name, 256, s+1, US"_");
1621 /* Test for a header's existence */
1623 if (Ustrncmp(name, "h_", 2) == 0 ||
1624 Ustrncmp(name, "rh_", 3) == 0 ||
1625 Ustrncmp(name, "bh_", 3) == 0 ||
1626 Ustrncmp(name, "header_", 7) == 0 ||
1627 Ustrncmp(name, "rheader_", 8) == 0 ||
1628 Ustrncmp(name, "bheader_", 8) == 0)
1630 s = read_header_name(name, 256, s);
1631 if (yield != NULL) *yield =
1632 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1635 /* Test for a variable's having a non-empty value. A non-existent variable
1636 causes an expansion failure. */
1640 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1643 expand_string_message = (name[0] == 0)?
1644 string_sprintf("variable name omitted after \"def:\"") :
1645 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1648 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1654 /* first_delivery tests for first delivery attempt */
1656 case ECOND_FIRST_DELIVERY:
1657 if (yield != NULL) *yield = deliver_firsttime == testfor;
1661 /* queue_running tests for any process started by a queue runner */
1663 case ECOND_QUEUE_RUNNING:
1664 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1668 /* exists: tests for file existence
1669 isip: tests for any IP address
1670 isip4: tests for an IPv4 address
1671 isip6: tests for an IPv6 address
1672 pam: does PAM authentication
1673 radius: does RADIUS authentication
1674 ldapauth: does LDAP authentication
1675 pwcheck: does Cyrus SASL pwcheck authentication
1684 case ECOND_LDAPAUTH:
1687 while (isspace(*s)) s++;
1688 if (*s != '{') goto COND_FAILED_CURLY_START;
1690 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1691 if (sub[0] == NULL) return NULL;
1692 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1694 if (yield == NULL) return s; /* No need to run the test if skipping */
1699 if ((expand_forbid & RDO_EXISTS) != 0)
1701 expand_string_message = US"File existence tests are not permitted";
1704 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1710 rc = string_is_ip_address(sub[0], NULL);
1711 *yield = ((cond_type == ECOND_ISIP)? (rc > 0) :
1712 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1715 /* Various authentication tests - all optionally compiled */
1719 rc = auth_call_pam(sub[0], &expand_string_message);
1722 goto COND_FAILED_NOT_COMPILED;
1723 #endif /* SUPPORT_PAM */
1726 #ifdef RADIUS_CONFIG_FILE
1727 rc = auth_call_radius(sub[0], &expand_string_message);
1730 goto COND_FAILED_NOT_COMPILED;
1731 #endif /* RADIUS_CONFIG_FILE */
1733 case ECOND_LDAPAUTH:
1736 /* Just to keep the interface the same */
1738 int old_pool = store_pool;
1739 store_pool = POOL_SEARCH;
1740 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1741 &expand_string_message, &do_cache);
1742 store_pool = old_pool;
1746 goto COND_FAILED_NOT_COMPILED;
1747 #endif /* LOOKUP_LDAP */
1750 #ifdef CYRUS_PWCHECK_SOCKET
1751 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1754 goto COND_FAILED_NOT_COMPILED;
1755 #endif /* CYRUS_PWCHECK_SOCKET */
1757 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1758 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1760 if (rc == ERROR || rc == DEFER) return NULL;
1761 *yield = (rc == OK) == testfor;
1767 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1769 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1771 However, the last two are optional. That is why the whole set is enclosed
1772 in their own set or braces. */
1774 case ECOND_SASLAUTHD:
1775 #ifndef CYRUS_SASLAUTHD_SOCKET
1776 goto COND_FAILED_NOT_COMPILED;
1778 while (isspace(*s)) s++;
1779 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1780 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1782 case 1: expand_string_message = US"too few arguments or bracketing "
1783 "error for saslauthd";
1785 case 3: return NULL;
1787 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1791 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1792 &expand_string_message);
1793 if (rc == ERROR || rc == DEFER) return NULL;
1794 *yield = (rc == OK) == testfor;
1797 #endif /* CYRUS_SASLAUTHD_SOCKET */
1800 /* symbolic operators for numeric and string comparison, and a number of
1801 other operators, all requiring two arguments.
1803 match: does a regular expression match and sets up the numerical
1804 variables if it succeeds
1805 match_address: matches in an address list
1806 match_domain: matches in a domain list
1807 match_ip: matches a host list that is restricted to IP addresses
1808 match_local_part: matches in a local part list
1809 crypteq: encrypts plaintext and compares against an encrypted text,
1810 using crypt(), crypt16(), MD5 or SHA-1
1814 case ECOND_MATCH_ADDRESS:
1815 case ECOND_MATCH_DOMAIN:
1816 case ECOND_MATCH_IP:
1817 case ECOND_MATCH_LOCAL_PART:
1820 case ECOND_NUM_L: /* Numerical comparisons */
1827 case ECOND_STR_LT: /* String comparisons */
1838 for (i = 0; i < 2; i++)
1840 while (isspace(*s)) s++;
1843 if (i == 0) goto COND_FAILED_CURLY_START;
1844 expand_string_message = string_sprintf("missing 2nd string in {} "
1845 "after \"%s\"", name);
1848 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1849 if (sub[i] == NULL) return NULL;
1850 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1852 /* Convert to numerical if required; we know that the names of all the
1853 conditions that compare numbers do not start with a letter. This just saves
1854 checking for them individually. */
1856 if (!isalpha(name[0]))
1859 num[i] = (int)Ustrtol((const uschar *)sub[i], &endptr, 10);
1860 if (tolower(*endptr) == 'k')
1865 else if (tolower(*endptr) == 'm')
1867 num[i] *= 1024*1024;
1870 while (isspace(*endptr)) endptr++;
1873 expand_string_message = string_sprintf("\"%s\" is not a number",
1880 /* Result not required */
1882 if (yield == NULL) return s;
1884 /* Do an appropriate comparison */
1890 *yield = (num[0] == num[1]) == testfor;
1894 *yield = (num[0] > num[1]) == testfor;
1898 *yield = (num[0] >= num[1]) == testfor;
1902 *yield = (num[0] < num[1]) == testfor;
1906 *yield = (num[0] <= num[1]) == testfor;
1910 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1914 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1918 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1922 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1926 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1930 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1934 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1938 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1942 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
1946 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
1949 case ECOND_MATCH: /* Regular expression match */
1950 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1954 expand_string_message = string_sprintf("regular expression error in "
1955 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1958 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1961 case ECOND_MATCH_ADDRESS: /* Match in an address list */
1962 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1963 goto MATCHED_SOMETHING;
1965 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
1966 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1967 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1968 goto MATCHED_SOMETHING;
1970 case ECOND_MATCH_IP: /* Match IP address in a host list */
1971 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) <= 0)
1973 expand_string_message = string_sprintf("\"%s\" is not an IP address",
1979 unsigned int *nullcache = NULL;
1980 check_host_block cb;
1982 cb.host_name = US"";
1983 cb.host_address = sub[0];
1985 /* If the host address starts off ::ffff: it is an IPv6 address in
1986 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
1989 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
1990 cb.host_address + 7 : cb.host_address;
1992 rc = match_check_list(
1993 &sub[1], /* the list */
1994 0, /* separator character */
1995 &hostlist_anchor, /* anchor pointer */
1996 &nullcache, /* cache pointer */
1997 check_host, /* function for testing */
1998 &cb, /* argument for function */
1999 MCL_HOST, /* type of check */
2000 sub[0], /* text for debugging */
2001 NULL); /* where to pass back data */
2003 goto MATCHED_SOMETHING;
2005 case ECOND_MATCH_LOCAL_PART:
2006 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2007 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2022 expand_string_message = string_sprintf("unable to complete match "
2023 "against \"%s\": %s", sub[1], search_error_message);
2029 /* Various "encrypted" comparisons. If the second string starts with
2030 "{" then an encryption type is given. Default to crypt() or crypt16()
2031 (build-time choice). */
2034 #ifndef SUPPORT_CRYPTEQ
2035 goto COND_FAILED_NOT_COMPILED;
2037 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2039 int sublen = Ustrlen(sub[1]+5);
2044 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2046 /* If the length that we are comparing against is 24, the MD5 digest
2047 is expressed as a base64 string. This is the way LDAP does it. However,
2048 some other software uses a straightforward hex representation. We assume
2049 this if the length is 32. Other lengths fail. */
2053 uschar *coded = auth_b64encode((uschar *)digest, 16);
2054 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2055 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2056 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2058 else if (sublen == 32)
2062 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2064 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2065 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2066 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2070 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2071 "fail\n crypted=%s\n", sub[1]+5);
2076 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2078 int sublen = Ustrlen(sub[1]+6);
2083 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2085 /* If the length that we are comparing against is 28, assume the SHA1
2086 digest is expressed as a base64 string. If the length is 40, assume a
2087 straightforward hex representation. Other lengths fail. */
2091 uschar *coded = auth_b64encode((uschar *)digest, 20);
2092 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2093 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2094 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2096 else if (sublen == 40)
2100 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2102 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2103 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2104 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2108 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2109 "fail\n crypted=%s\n", sub[1]+6);
2114 else /* {crypt} or {crypt16} and non-{ at start */
2119 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2124 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2129 else if (sub[1][0] == '{')
2131 expand_string_message = string_sprintf("unknown encryption mechanism "
2132 "in \"%s\"", sub[1]);
2138 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2139 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2140 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2144 #define XSTR(s) STR(s)
2145 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2146 " subject=%s\n crypted=%s\n",
2147 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2152 /* If the encrypted string contains fewer than two characters (for the
2153 salt), force failure. Otherwise we get false positives: with an empty
2154 string the yield of crypt() is an empty string! */
2156 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2157 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2160 #endif /* SUPPORT_CRYPTEQ */
2161 } /* Switch for comparison conditions */
2163 return s; /* End of comparison conditions */
2166 /* and/or: computes logical and/or of several conditions */
2170 subcondptr = (yield == NULL)? NULL : &tempcond;
2171 combined_cond = (cond_type == ECOND_AND);
2173 while (isspace(*s)) s++;
2174 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2178 while (isspace(*s)) s++;
2179 if (*s == '}') break;
2182 expand_string_message = string_sprintf("each subcondition "
2183 "inside an \"%s{...}\" condition must be in its own {}", name);
2187 s = eval_condition(s+1, subcondptr);
2190 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2191 expand_string_message, name);
2194 while (isspace(*s)) s++;
2198 expand_string_message = string_sprintf("missing } at end of condition "
2199 "inside \"%s\" group", name);
2205 if (cond_type == ECOND_AND)
2207 combined_cond &= tempcond;
2208 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2209 } /* evaluate any more */
2212 combined_cond |= tempcond;
2213 if (combined_cond) subcondptr = NULL; /* once true, don't */
2214 } /* evaluate any more */
2218 if (yield != NULL) *yield = (combined_cond == testfor);
2222 /* Unknown condition */
2225 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2227 } /* End switch on condition type */
2229 /* Missing braces at start and end of data */
2231 COND_FAILED_CURLY_START:
2232 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2235 COND_FAILED_CURLY_END:
2236 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2240 /* A condition requires code that is not compiled */
2242 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2243 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2244 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2245 COND_FAILED_NOT_COMPILED:
2246 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2255 /*************************************************
2256 * Save numerical variables *
2257 *************************************************/
2259 /* This function is called from items such as "if" that want to preserve and
2260 restore the numbered variables.
2263 save_expand_string points to an array of pointers to set
2264 save_expand_nlength points to an array of ints for the lengths
2266 Returns: the value of expand max to save
2270 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2273 for (i = 0; i <= expand_nmax; i++)
2275 save_expand_nstring[i] = expand_nstring[i];
2276 save_expand_nlength[i] = expand_nlength[i];
2283 /*************************************************
2284 * Restore numerical variables *
2285 *************************************************/
2287 /* This function restored saved values of numerical strings.
2290 save_expand_nmax the number of strings to restore
2291 save_expand_string points to an array of pointers
2292 save_expand_nlength points to an array of ints
2298 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2299 int *save_expand_nlength)
2302 expand_nmax = save_expand_nmax;
2303 for (i = 0; i <= expand_nmax; i++)
2305 expand_nstring[i] = save_expand_nstring[i];
2306 expand_nlength[i] = save_expand_nlength[i];
2314 /*************************************************
2315 * Handle yes/no substrings *
2316 *************************************************/
2318 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2319 alternative substrings that depend on whether or not the condition was true,
2320 or the lookup or extraction succeeded. The substrings always have to be
2321 expanded, to check their syntax, but "skipping" is set when the result is not
2322 needed - this avoids unnecessary nested lookups.
2325 skipping TRUE if we were skipping when this item was reached
2326 yes TRUE if the first string is to be used, else use the second
2327 save_lookup a value to put back into lookup_value before the 2nd expansion
2328 sptr points to the input string pointer
2329 yieldptr points to the output string pointer
2330 sizeptr points to the output string size
2331 ptrptr points to the output string pointer
2332 type "lookup" or "if" or "extract" or "run", for error message
2334 Returns: 0 OK; lookup_value has been reset to save_lookup
2336 2 expansion failed because of bracketing error
2340 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2341 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2344 uschar *s = *sptr; /* Local value */
2345 uschar *sub1, *sub2;
2347 /* If there are no following strings, we substitute the contents of $value for
2348 lookups and for extractions in the success case. For the ${if item, the string
2349 "true" is substituted. In the fail case, nothing is substituted for all three
2352 while (isspace(*s)) s++;
2357 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2361 if (yes && lookup_value != NULL)
2362 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2363 Ustrlen(lookup_value));
2364 lookup_value = save_lookup;
2370 /* The first following string must be braced. */
2372 if (*s++ != '{') goto FAILED_CURLY;
2374 /* Expand the first substring. Forced failures are noticed only if we actually
2375 want this string. Set skipping in the call in the fail case (this will always
2376 be the case if we were already skipping). */
2378 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2379 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2380 expand_string_forcedfail = FALSE;
2381 if (*s++ != '}') goto FAILED_CURLY;
2383 /* If we want the first string, add it to the output */
2386 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2388 /* If this is called from a lookup or an extract, we want to restore $value to
2389 what it was at the start of the item, so that it has this value during the
2390 second string expansion. For the call from "if" or "run" to this function,
2391 save_lookup is set to lookup_value, so that this statement does nothing. */
2393 lookup_value = save_lookup;
2395 /* There now follows either another substring, or "fail", or nothing. This
2396 time, forced failures are noticed only if we want the second string. We must
2397 set skipping in the nested call if we don't want this string, or if we were
2398 already skipping. */
2400 while (isspace(*s)) s++;
2403 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2404 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2405 expand_string_forcedfail = FALSE;
2406 if (*s++ != '}') goto FAILED_CURLY;
2408 /* If we want the second string, add it to the output */
2411 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2414 /* If there is no second string, but the word "fail" is present when the use of
2415 the second string is wanted, set a flag indicating it was a forced failure
2416 rather than a syntactic error. Swallow the terminating } in case this is nested
2417 inside another lookup or if or extract. */
2422 s = read_name(name, sizeof(name), s, US"_");
2423 if (Ustrcmp(name, "fail") == 0)
2425 if (!yes && !skipping)
2427 while (isspace(*s)) s++;
2428 if (*s++ != '}') goto FAILED_CURLY;
2429 expand_string_message =
2430 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2431 expand_string_forcedfail = TRUE;
2437 expand_string_message =
2438 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2443 /* All we have to do now is to check on the final closing brace. */
2445 while (isspace(*s)) s++;
2446 if (*s++ == '}') goto RETURN;
2448 /* Get here if there is a bracketing failure */
2453 /* Get here for other failures */
2458 /* Update the input pointer value before returning */
2468 /*************************************************
2469 * Handle MD5 or SHA-1 computation for HMAC *
2470 *************************************************/
2472 /* These are some wrapping functions that enable the HMAC code to be a bit
2473 cleaner. A good compiler will spot the tail recursion.
2476 type HMAC_MD5 or HMAC_SHA1
2477 remaining are as for the cryptographic hash functions
2483 chash_start(int type, void *base)
2485 if (type == HMAC_MD5)
2486 md5_start((md5 *)base);
2488 sha1_start((sha1 *)base);
2492 chash_mid(int type, void *base, uschar *string)
2494 if (type == HMAC_MD5)
2495 md5_mid((md5 *)base, string);
2497 sha1_mid((sha1 *)base, string);
2501 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2503 if (type == HMAC_MD5)
2504 md5_end((md5 *)base, string, length, digest);
2506 sha1_end((sha1 *)base, string, length, digest);
2513 /********************************************************
2514 * prvs: Get last three digits of days since Jan 1, 1970 *
2515 ********************************************************/
2517 /* This is needed to implement the "prvs" BATV reverse
2520 Argument: integer "days" offset to add or substract to
2521 or from the current number of days.
2523 Returns: pointer to string containing the last three
2524 digits of the number of days since Jan 1, 1970,
2525 modified by the offset argument, NULL if there
2526 was an error in the conversion.
2531 prvs_daystamp(int day_offset)
2533 uschar *days = store_get(16);
2534 (void)string_format(days, 16, TIME_T_FMT,
2535 (time(NULL) + day_offset*86400)/86400);
2536 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2541 /********************************************************
2542 * prvs: perform HMAC-SHA1 computation of prvs bits *
2543 ********************************************************/
2545 /* This is needed to implement the "prvs" BATV reverse
2549 address RFC2821 Address to use
2550 key The key to use (must be less than 64 characters
2552 key_num Single-digit key number to use. Defaults to
2555 Returns: pointer to string containing the first three
2556 bytes of the final hash in hex format, NULL if
2557 there was an error in the process.
2561 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2563 uschar *hash_source, *p;
2564 int size = 0,offset = 0,i;
2566 void *use_base = &sha1_base;
2567 uschar innerhash[20];
2568 uschar finalhash[20];
2569 uschar innerkey[64];
2570 uschar outerkey[64];
2571 uschar *finalhash_hex = store_get(40);
2573 if (key_num == NULL)
2576 if (Ustrlen(key) > 64)
2579 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2580 string_cat(hash_source,&size,&offset,daystamp,3);
2581 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2582 hash_source[offset] = '\0';
2584 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2586 memset(innerkey, 0x36, 64);
2587 memset(outerkey, 0x5c, 64);
2589 for (i = 0; i < Ustrlen(key); i++)
2591 innerkey[i] ^= key[i];
2592 outerkey[i] ^= key[i];
2595 chash_start(HMAC_SHA1, use_base);
2596 chash_mid(HMAC_SHA1, use_base, innerkey);
2597 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2599 chash_start(HMAC_SHA1, use_base);
2600 chash_mid(HMAC_SHA1, use_base, outerkey);
2601 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2604 for (i = 0; i < 3; i++)
2606 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2607 *p++ = hex_digits[finalhash[i] & 0x0f];
2611 return finalhash_hex;
2617 /*************************************************
2618 * Join a file onto the output string *
2619 *************************************************/
2621 /* This is used for readfile and after a run expansion. It joins the contents
2622 of a file onto the output string, globally replacing newlines with a given
2623 string (optionally). The file is closed at the end.
2627 yield pointer to the expandable string
2628 sizep pointer to the current size
2629 ptrp pointer to the current position
2630 eol newline replacement string, or NULL
2632 Returns: new value of string pointer
2636 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2639 uschar buffer[1024];
2641 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2643 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2645 int len = Ustrlen(buffer);
2646 if (eol != NULL && buffer[len-1] == '\n') len--;
2647 yield = string_cat(yield, sizep, ptrp, buffer, len);
2648 if (buffer[len] != 0)
2649 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2652 if (yield != NULL) yield[*ptrp] = 0;
2660 /*************************************************
2661 * Evaluate numeric expression *
2662 *************************************************/
2664 /* This is a set of mutually recursive functions that evaluate a simple
2665 arithmetic expression involving only + - * / and parentheses. The only one that
2666 is called from elsewhere is eval_expr, whose interface is:
2669 sptr pointer to the pointer to the string - gets updated
2670 decimal TRUE if numbers are to be assumed decimal
2671 error pointer to where to put an error message - must be NULL on input
2672 endket TRUE if ')' must terminate - FALSE for external call
2675 Returns: on success: the value of the expression, with *error still NULL
2676 on failure: an undefined value, with *error = a message
2679 static int eval_sumterm(uschar **, BOOL, uschar **);
2682 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2685 int x = eval_sumterm(&s, decimal, error);
2688 while (*s == '+' || *s == '-')
2691 int y = eval_sumterm(&s, decimal, error);
2692 if (*error != NULL) break;
2693 if (op == '+') x += y; else x -= y;
2700 *error = US"expecting closing parenthesis";
2702 while (isspace(*(++s)));
2704 else if (*s != 0) *error = US"expecting + or -";
2713 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2718 while (isspace(*s)) s++;
2720 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2723 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2725 if (tolower(*s) == 'k') { n *= 1024; s++; }
2726 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2727 while (isspace (*s)) s++;
2732 n = eval_expr(&s, decimal, error, 1);
2736 *error = US"expecting number or opening parenthesis";
2743 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2746 int x = eval_term(&s, decimal, error);
2749 while (*s == '*' || *s == '/')
2752 int y = eval_term(&s, decimal, error);
2753 if (*error != NULL) break;
2754 if (op == '*') x *= y; else x /= y;
2764 /*************************************************
2766 *************************************************/
2768 /* Returns either an unchanged string, or the expanded string in stacking pool
2769 store. Interpreted sequences are:
2771 \... normal escaping rules
2772 $name substitutes the variable
2774 ${op:string} operates on the expanded string value
2775 ${item{arg1}{arg2}...} expands the args and then does the business
2776 some literal args are not enclosed in {}
2778 There are now far too many operators and item types to make it worth listing
2779 them here in detail any more.
2781 We use an internal routine recursively to handle embedded substrings. The
2782 external function follows. The yield is NULL if the expansion failed, and there
2783 are two cases: if something collapsed syntactically, or if "fail" was given
2784 as the action on a lookup failure. These can be distinguised by looking at the
2785 variable expand_string_forcedfail, which is TRUE in the latter case.
2787 The skipping flag is set true when expanding a substring that isn't actually
2788 going to be used (after "if" or "lookup") and it prevents lookups from
2789 happening lower down.
2791 Store usage: At start, a store block of the length of the input plus 64
2792 is obtained. This is expanded as necessary by string_cat(), which might have to
2793 get a new block, or might be able to expand the original. At the end of the
2794 function we can release any store above that portion of the yield block that
2795 was actually used. In many cases this will be optimal.
2797 However: if the first item in the expansion is a variable name or header name,
2798 we reset the store before processing it; if the result is in fresh store, we
2799 use that without copying. This is helpful for expanding strings like
2800 $message_headers which can get very long.
2803 string the string to be expanded
2804 ket_ends true if expansion is to stop at }
2805 left if not NULL, a pointer to the first character after the
2806 expansion is placed here (typically used with ket_ends)
2807 skipping TRUE for recursive calls when the value isn't actually going
2808 to be used (to allow for optimisation)
2810 Returns: NULL if expansion fails:
2811 expand_string_forcedfail is set TRUE if failure was forced
2812 expand_string_message contains a textual error message
2813 a pointer to the expanded string on success
2817 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2821 int size = Ustrlen(string)+ 64;
2823 uschar *yield = store_get(size);
2825 uschar *save_expand_nstring[EXPAND_MAXN+1];
2826 int save_expand_nlength[EXPAND_MAXN+1];
2828 expand_string_forcedfail = FALSE;
2829 expand_string_message = US"";
2836 /* \ escapes the next character, which must exist, or else
2837 the expansion fails. There's a special escape, \N, which causes
2838 copying of the subject verbatim up to the next \N. Otherwise,
2839 the escapes are the standard set. */
2845 expand_string_message = US"\\ at end of string";
2852 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2853 yield = string_cat(yield, &size, &ptr, t, s - t);
2854 if (*s != 0) s += 2;
2860 ch[0] = string_interpret_escape(&s);
2862 yield = string_cat(yield, &size, &ptr, ch, 1);
2868 /* Anything other than $ is just copied verbatim, unless we are
2869 looking for a terminating } character. */
2871 if (ket_ends && *s == '}') break;
2875 yield = string_cat(yield, &size, &ptr, s++, 1);
2879 /* No { after the $ - must be a plain name or a number for string
2880 match variable. There has to be a fudge for variables that are the
2881 names of header fields preceded by "$header_" because header field
2882 names can contain any printing characters except space and colon.
2883 For those that don't like typing this much, "$h_" is a synonym for
2884 "$header_". A non-existent header yields a NULL value; nothing is
2887 if (isalpha((*(++s))))
2892 s = read_name(name, sizeof(name), s, US"_");
2894 /* If this is the first thing to be expanded, release the pre-allocated
2897 if (ptr == 0 && yield != NULL)
2906 if (Ustrncmp(name, "h_", 2) == 0 ||
2907 Ustrncmp(name, "rh_", 3) == 0 ||
2908 Ustrncmp(name, "bh_", 3) == 0 ||
2909 Ustrncmp(name, "header_", 7) == 0 ||
2910 Ustrncmp(name, "rheader_", 8) == 0 ||
2911 Ustrncmp(name, "bheader_", 8) == 0)
2913 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2914 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2915 s = read_header_name(name, sizeof(name), s);
2916 value = find_header(name, FALSE, &newsize, want_raw, charset);
2918 /* If we didn't find the header, and the header contains a closing brace
2919 characters, this may be a user error where the terminating colon
2920 has been omitted. Set a flag to adjust the error message in this case.
2921 But there is no error here - nothing gets inserted. */
2925 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2934 value = find_variable(name, FALSE, skipping, &newsize);
2937 expand_string_message =
2938 string_sprintf("unknown variable name \"%s\"", name);
2943 /* If the data is known to be in a new buffer, newsize will be set to the
2944 size of that buffer. If this is the first thing in an expansion string,
2945 yield will be NULL; just point it at the new store instead of copying. Many
2946 expansion strings contain just one reference, so this is a useful
2947 optimization, especially for humungous headers. */
2949 len = Ustrlen(value);
2950 if (yield == NULL && newsize != 0)
2956 else yield = string_cat(yield, &size, &ptr, value, len);
2964 s = read_number(&n, s);
2965 if (n >= 0 && n <= expand_nmax)
2966 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2971 /* Otherwise, if there's no '{' after $ it's an error. */
2975 expand_string_message = US"$ not followed by letter, digit, or {";
2979 /* After { there can be various things, but they all start with
2980 an initial word, except for a number for a string match variable. */
2982 if (isdigit((*(++s))))
2985 s = read_number(&n, s);
2988 expand_string_message = US"} expected after number";
2991 if (n >= 0 && n <= expand_nmax)
2992 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2999 expand_string_message = US"letter or digit expected after ${";
3003 /* Allow "-" in names to cater for substrings with negative
3004 arguments. Since we are checking for known names after { this is
3007 s = read_name(name, sizeof(name), s, US"_-");
3008 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3012 /* Handle conditionals - preserve the values of the numerical expansion
3013 variables in case they get changed by a regular expression match in the
3014 condition. If not, they retain their external settings. At the end
3015 of this "if" section, they get restored to their previous values. */
3021 int save_expand_nmax =
3022 save_expand_strings(save_expand_nstring, save_expand_nlength);
3024 while (isspace(*s)) s++;
3025 next_s = eval_condition(s, skipping? NULL : &cond);
3026 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3029 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3030 cond? "true" : "false");
3034 /* The handling of "yes" and "no" result strings is now in a separate
3035 function that is also used by ${lookup} and ${extract} and ${run}. */
3037 switch(process_yesno(
3038 skipping, /* were previously skipping */
3039 cond, /* success/failure indicator */
3040 lookup_value, /* value to reset for string2 */
3041 &s, /* input pointer */
3042 &yield, /* output pointer */
3043 &size, /* output size */
3044 &ptr, /* output current point */
3045 US"if")) /* condition type */
3047 case 1: goto EXPAND_FAILED; /* when all is well, the */
3048 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3051 /* Restore external setting of expansion variables for continuation
3054 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3055 save_expand_nlength);
3059 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3060 expanding an internal string that isn't actually going to be used. All we
3061 need to do is check the syntax, so don't do a lookup at all. Preserve the
3062 values of the numerical expansion variables in case they get changed by a
3063 partial lookup. If not, they retain their external settings. At the end
3064 of this "lookup" section, they get restored to their previous values. */
3068 int stype, partial, affixlen, starflags;
3069 int expand_setup = 0;
3071 uschar *key, *filename, *affix;
3072 uschar *save_lookup_value = lookup_value;
3073 int save_expand_nmax =
3074 save_expand_strings(save_expand_nstring, save_expand_nlength);
3076 if ((expand_forbid & RDO_LOOKUP) != 0)
3078 expand_string_message = US"lookup expansions are not permitted";
3082 /* Get the key we are to look up for single-key+file style lookups.
3083 Otherwise set the key NULL pro-tem. */
3085 while (isspace(*s)) s++;
3088 key = expand_string_internal(s+1, TRUE, &s, skipping);
3089 if (key == NULL) goto EXPAND_FAILED;
3090 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3091 while (isspace(*s)) s++;
3095 /* Find out the type of database */
3099 expand_string_message = US"missing lookup type";
3103 /* The type is a string that may contain special characters of various
3104 kinds. Allow everything except space or { to appear; the actual content
3105 is checked by search_findtype_partial. */
3107 while (*s != 0 && *s != '{' && !isspace(*s))
3109 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3113 while (isspace(*s)) s++;
3115 /* Now check for the individual search type and any partial or default
3116 options. Only those types that are actually in the binary are valid. */
3118 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3122 expand_string_message = search_error_message;
3126 /* Check that a key was provided for those lookup types that need it,
3127 and was not supplied for those that use the query style. */
3129 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3133 expand_string_message = string_sprintf("missing {key} for single-"
3134 "key \"%s\" lookup", name);
3142 expand_string_message = string_sprintf("a single key was given for "
3143 "lookup type \"%s\", which is not a single-key lookup type", name);
3148 /* Get the next string in brackets and expand it. It is the file name for
3149 single-key+file lookups, and the whole query otherwise. In the case of
3150 queries that also require a file name (e.g. sqlite), the file name comes
3153 if (*s != '{') goto EXPAND_FAILED_CURLY;
3154 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3155 if (filename == NULL) goto EXPAND_FAILED;
3156 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3157 while (isspace(*s)) s++;
3159 /* If this isn't a single-key+file lookup, re-arrange the variables
3160 to be appropriate for the search_ functions. For query-style lookups,
3161 there is just a "key", and no file name. For the special query-style +
3162 file types, the query (i.e. "key") starts with a file name. */
3166 while (isspace(*filename)) filename++;
3169 if (mac_islookup(stype, lookup_querystyle))
3175 if (*filename != '/')
3177 expand_string_message = string_sprintf(
3178 "absolute file name expected for \"%s\" lookup", name);
3181 while (*key != 0 && !isspace(*key)) key++;
3182 if (*key != 0) *key++ = 0;
3186 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3187 the entry was not found. Note that there is no search_close() function.
3188 Files are left open in case of re-use. At suitable places in higher logic,
3189 search_tidyup() is called to tidy all open files. This can save opening
3190 the same file several times. However, files may also get closed when
3191 others are opened, if too many are open at once. The rule is that a
3192 handle should not be used after a second search_open().
3194 Request that a partial search sets up $1 and maybe $2 by passing
3195 expand_setup containing zero. If its value changes, reset expand_nmax,
3196 since new variables will have been set. Note that at the end of this
3197 "lookup" section, the old numeric variables are restored. */
3200 lookup_value = NULL;
3203 void *handle = search_open(filename, stype, 0, NULL, NULL);
3206 expand_string_message = search_error_message;
3209 lookup_value = search_find(handle, filename, key, partial, affix,
3210 affixlen, starflags, &expand_setup);
3211 if (search_find_defer)
3213 expand_string_message =
3214 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3215 search_error_message);
3218 if (expand_setup > 0) expand_nmax = expand_setup;
3221 /* The handling of "yes" and "no" result strings is now in a separate
3222 function that is also used by ${if} and ${extract}. */
3224 switch(process_yesno(
3225 skipping, /* were previously skipping */
3226 lookup_value != NULL, /* success/failure indicator */
3227 save_lookup_value, /* value to reset for string2 */
3228 &s, /* input pointer */
3229 &yield, /* output pointer */
3230 &size, /* output size */
3231 &ptr, /* output current point */
3232 US"lookup")) /* condition type */
3234 case 1: goto EXPAND_FAILED; /* when all is well, the */
3235 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3238 /* Restore external setting of expansion variables for carrying on
3239 at this level, and continue. */
3241 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3242 save_expand_nlength);
3246 /* If Perl support is configured, handle calling embedded perl subroutines,
3247 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3248 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3249 arguments (defined below). */
3251 #define EXIM_PERL_MAX_ARGS 8
3255 expand_string_message = US"\"${perl\" encountered, but this facility "
3256 "is not included in this binary";
3259 #else /* EXIM_PERL */
3261 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3264 if ((expand_forbid & RDO_PERL) != 0)
3266 expand_string_message = US"Perl calls are not permitted";
3270 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3273 case 1: goto EXPAND_FAILED_CURLY;
3275 case 3: goto EXPAND_FAILED;
3278 /* If skipping, we don't actually do anything */
3280 if (skipping) continue;
3282 /* Start the interpreter if necessary */
3284 if (!opt_perl_started)
3287 if (opt_perl_startup == NULL)
3289 expand_string_message = US"A setting of perl_startup is needed when "
3290 "using the Perl interpreter";
3293 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3294 initerror = init_perl(opt_perl_startup);
3295 if (initerror != NULL)
3297 expand_string_message =
3298 string_sprintf("error in perl_startup code: %s\n", initerror);
3301 opt_perl_started = TRUE;
3304 /* Call the function */
3306 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3307 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3308 sub_arg[0], sub_arg + 1);
3310 /* NULL yield indicates failure; if the message pointer has been set to
3311 NULL, the yield was undef, indicating a forced failure. Otherwise the
3312 message will indicate some kind of Perl error. */
3314 if (new_yield == NULL)
3316 if (expand_string_message == NULL)
3318 expand_string_message =
3319 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3320 "failure", sub_arg[0]);
3321 expand_string_forcedfail = TRUE;
3326 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3327 set during a callback from Perl. */
3329 expand_string_forcedfail = FALSE;
3333 #endif /* EXIM_PERL */
3335 /* Transform email address to "prvs" scheme to use
3336 as BATV-signed return path */
3343 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3345 case 1: goto EXPAND_FAILED_CURLY;
3347 case 3: goto EXPAND_FAILED;
3350 /* If skipping, we don't actually do anything */
3351 if (skipping) continue;
3353 /* sub_arg[0] is the address */
3354 domain = Ustrrchr(sub_arg[0],'@');
3355 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3357 expand_string_message = US"first parameter must be a qualified email address";
3361 /* Calculate the hash */
3362 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3365 expand_string_message = US"hmac-sha1 conversion failed";
3369 /* Now separate the domain from the local part */
3372 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3373 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3374 string_cat(yield,&size,&ptr,US"/",1);
3375 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3376 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3377 string_cat(yield,&size,&ptr,p,6);
3378 string_cat(yield,&size,&ptr,US"@",1);
3379 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3384 /* Check a prvs-encoded address for validity */
3386 case EITEM_PRVSCHECK:
3389 int mysize = 0, myptr = 0;
3392 /* Ugliness: We want to expand parameter 1 first, then set
3393 up expansion variables that are used in the expansion of
3394 parameter 2. So we clone the string for the first
3395 expansion, where we only expand paramter 1. */
3396 uschar *s_backup = string_copy(s);
3398 /* Reset expansion variables */
3399 prvscheck_result = NULL;
3400 prvscheck_address = NULL;
3401 prvscheck_keynum = NULL;
3403 switch(read_subs(sub_arg, 1, 1, &s_backup, skipping, FALSE, US"prvs"))
3405 case 1: goto EXPAND_FAILED_CURLY;
3407 case 3: goto EXPAND_FAILED;
3410 re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3413 if (regex_match_and_setup(re,sub_arg[0],0,-1)) {
3414 uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3415 uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3416 uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3417 uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3418 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3420 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3421 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3422 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3423 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3424 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3426 /* Set up expansion variables */
3427 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3428 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3429 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3430 prvscheck_address[myptr] = '\0';
3431 prvscheck_keynum = string_copy(key_num);
3433 /* Now re-expand all arguments in the usual manner */
3434 switch(read_subs(sub_arg, 3, 3, &s, skipping, TRUE, US"prvs"))
3436 case 1: goto EXPAND_FAILED_CURLY;
3438 case 3: goto EXPAND_FAILED;
3441 if (*sub_arg[2] == '\0')
3442 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3444 yield = string_cat(yield,&size,&ptr,sub_arg[2],Ustrlen(sub_arg[2]));
3446 /* Now we have the key and can check the address. */
3447 p = prvs_hmac_sha1(prvscheck_address, sub_arg[1], prvscheck_keynum, daystamp);
3450 expand_string_message = US"hmac-sha1 conversion failed";
3454 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3455 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3456 if (Ustrcmp(p,hash) == 0)
3458 /* Success, valid BATV address. Now check the expiry date. */
3459 uschar *now = prvs_daystamp(0);
3460 unsigned int inow = 0,iexpire = 1;
3462 (void)sscanf(CS now,"%u",&inow);
3463 (void)sscanf(CS daystamp,"%u",&iexpire);
3465 /* When "iexpire" is < 7, a "flip" has occured.
3466 Adjust "inow" accordingly. */
3467 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3471 prvscheck_result = US"1";
3472 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3476 prvscheck_result = NULL;
3477 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3482 prvscheck_result = NULL;
3483 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3488 /* Does not look like a prvs encoded address, return the empty string.
3489 We need to make sure all subs are expanded first. */
3490 switch(read_subs(sub_arg, 3, 3, &s, skipping, TRUE, US"prvs"))
3492 case 1: goto EXPAND_FAILED_CURLY;
3494 case 3: goto EXPAND_FAILED;
3501 /* Handle "readfile" to insert an entire file */
3503 case EITEM_READFILE:
3508 if ((expand_forbid & RDO_READFILE) != 0)
3510 expand_string_message = US"file insertions are not permitted";
3514 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3516 case 1: goto EXPAND_FAILED_CURLY;
3518 case 3: goto EXPAND_FAILED;
3521 /* If skipping, we don't actually do anything */
3523 if (skipping) continue;
3525 /* Open the file and read it */
3527 f = Ufopen(sub_arg[0], "rb");
3530 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3534 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3539 /* Handle "readsocket" to insert data from a Unix domain socket */
3541 case EITEM_READSOCK:
3547 struct sockaddr_un sockun; /* don't call this "sun" ! */
3551 if ((expand_forbid & RDO_READSOCK) != 0)
3553 expand_string_message = US"socket insertions are not permitted";
3557 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3558 because there may be a string for expansion on failure. */
3560 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3562 case 1: goto EXPAND_FAILED_CURLY;
3563 case 2: /* Won't occur: no end check */
3564 case 3: goto EXPAND_FAILED;
3567 /* Sort out timeout, if given */
3569 if (sub_arg[2] != NULL)
3571 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3574 expand_string_message = string_sprintf("bad time value %s",
3579 else sub_arg[3] = NULL; /* No eol if no timeout */
3581 /* If skipping, we don't actually do anything */
3585 /* Make a connection to the socket */
3587 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3589 expand_string_message = string_sprintf("failed to create socket: %s",
3594 sockun.sun_family = AF_UNIX;
3595 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3597 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3599 expand_string_message = string_sprintf("failed to connect to socket "
3600 "%s: %s", sub_arg[0], strerror(errno));
3603 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3605 /* Write the request string, if not empty */
3607 if (sub_arg[1][0] != 0)
3609 int len = Ustrlen(sub_arg[1]);
3610 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3612 if (write(fd, sub_arg[1], len) != len)
3614 expand_string_message = string_sprintf("request write to socket "
3615 "failed: %s", strerror(errno));
3620 /* Now we need to read from the socket, under a timeout. The function
3621 that reads a file can be used. */
3623 f = fdopen(fd, "rb");
3624 sigalrm_seen = FALSE;
3626 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3630 /* After a timeout, we restore the pointer in the result, that is,
3631 make sure we add nothing from the socket. */
3636 expand_string_message = US"socket read timed out";
3641 /* The whole thing has worked (or we were skipping). If there is a
3642 failure string following, we need to skip it. */
3646 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3648 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3649 while (isspace(*s)) s++;
3651 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3654 /* Come here on failure to create socket, connect socket, write to the
3655 socket, or timeout on reading. If another substring follows, expand and
3656 use it. Otherwise, those conditions give expand errors. */
3659 if (*s != '{') goto EXPAND_FAILED;
3660 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3661 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3662 if (arg == NULL) goto EXPAND_FAILED;
3663 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3664 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3665 while (isspace(*s)) s++;
3666 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3670 /* Handle "run" to execute a program. */
3682 if ((expand_forbid & RDO_RUN) != 0)
3684 expand_string_message = US"running a command is not permitted";
3688 while (isspace(*s)) s++;
3689 if (*s != '{') goto EXPAND_FAILED_CURLY;
3690 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3691 if (arg == NULL) goto EXPAND_FAILED;
3692 while (isspace(*s)) s++;
3693 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3695 if (skipping) /* Just pretend it worked when we're skipping */
3701 if (!transport_set_up_command(&argv, /* anchor for arg list */
3702 arg, /* raw command */
3703 FALSE, /* don't expand the arguments */
3704 0, /* not relevant when... */
3705 NULL, /* no transporting address */
3706 US"${run} expansion", /* for error messages */
3707 &expand_string_message)) /* where to put error message */
3712 /* Create the child process, making it a group leader. */
3714 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3718 expand_string_message =
3719 string_sprintf("couldn't create child process: %s", strerror(errno));
3723 /* Nothing is written to the standard input. */
3727 /* Wait for the process to finish, applying the timeout, and inspect its
3728 return code for serious disasters. Simple non-zero returns are passed on.
3731 if ((runrc = child_close(pid, 60)) < 0)
3735 expand_string_message = string_sprintf("command timed out");
3736 killpg(pid, SIGKILL); /* Kill the whole process group */
3739 else if (runrc == -257)
3740 expand_string_message = string_sprintf("wait() failed: %s",
3744 expand_string_message = string_sprintf("command killed by signal %d",
3750 /* Read the pipe to get the command's output into $value (which is kept
3751 in lookup_value). */
3753 f = fdopen(fd_out, "rb");
3754 lookup_value = NULL;
3755 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3759 /* Process the yes/no strings; $value may be useful in both cases */
3761 switch(process_yesno(
3762 skipping, /* were previously skipping */
3763 runrc == 0, /* success/failure indicator */
3764 lookup_value, /* value to reset for string2 */
3765 &s, /* input pointer */
3766 &yield, /* output pointer */
3767 &size, /* output size */
3768 &ptr, /* output current point */
3769 US"run")) /* condition type */
3771 case 1: goto EXPAND_FAILED; /* when all is well, the */
3772 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3778 /* Handle character translation for "tr" */
3786 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3788 case 1: goto EXPAND_FAILED_CURLY;
3790 case 3: goto EXPAND_FAILED;
3793 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3794 o2m = Ustrlen(sub[2]) - 1;
3796 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3798 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3802 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3809 /* Handle "hash", "length", "nhash", and "substr" when they are given with
3810 expanded arguments. */
3820 int val[2] = { 0, -1 };
3823 /* "length" takes only 2 arguments whereas the others take 2 or 3.
3824 Ensure that sub[2] is set in the ${length case. */
3827 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
3830 case 1: goto EXPAND_FAILED_CURLY;
3832 case 3: goto EXPAND_FAILED;
3835 /* Juggle the arguments if there are only two of them: always move the
3836 string to the last position and make ${length{n}{str}} equivalent to
3837 ${substr{0}{n}{str}}. See the defaults for val[] above. */
3843 if (item_type == EITEM_LENGTH)
3850 for (i = 0; i < 2; i++)
3852 if (sub[i] == NULL) continue;
3853 val[i] = (int)Ustrtol(sub[i], &ret, 10);
3854 if (*ret != 0 || (i != 0 && val[i] < 0))
3856 expand_string_message = string_sprintf("\"%s\" is not a%s number "
3857 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
3863 (item_type == EITEM_HASH)?
3864 compute_hash(sub[2], val[0], val[1], &len) :
3865 (item_type == EITEM_NHASH)?
3866 compute_nhash(sub[2], val[0], val[1], &len) :
3867 extract_substr(sub[2], val[0], val[1], &len);
3869 if (ret == NULL) goto EXPAND_FAILED;
3870 yield = string_cat(yield, &size, &ptr, ret, len);
3874 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
3875 This code originally contributed by Steve Haslam. It currently supports
3876 the use of MD5 and SHA-1 hashes.
3878 We need some workspace that is large enough to handle all the supported
3879 hash types. Use macros to set the sizes rather than be too elaborate. */
3881 #define MAX_HASHLEN 20
3882 #define MAX_HASHBLOCKLEN 64
3891 int hashlen; /* Number of octets for the hash algorithm's output */
3892 int hashblocklen; /* Number of octets the hash algorithm processes */
3894 unsigned int keylen;
3896 uschar keyhash[MAX_HASHLEN];
3897 uschar innerhash[MAX_HASHLEN];
3898 uschar finalhash[MAX_HASHLEN];
3899 uschar finalhash_hex[2*MAX_HASHLEN];
3900 uschar innerkey[MAX_HASHBLOCKLEN];
3901 uschar outerkey[MAX_HASHBLOCKLEN];
3903 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
3905 case 1: goto EXPAND_FAILED_CURLY;
3907 case 3: goto EXPAND_FAILED;
3910 if (Ustrcmp(sub[0], "md5") == 0)
3913 use_base = &md5_base;
3917 else if (Ustrcmp(sub[0], "sha1") == 0)
3920 use_base = &sha1_base;
3926 expand_string_message =
3927 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
3932 keylen = Ustrlen(keyptr);
3934 /* If the key is longer than the hash block length, then hash the key
3937 if (keylen > hashblocklen)
3939 chash_start(type, use_base);
3940 chash_end(type, use_base, keyptr, keylen, keyhash);
3945 /* Now make the inner and outer key values */
3947 memset(innerkey, 0x36, hashblocklen);
3948 memset(outerkey, 0x5c, hashblocklen);
3950 for (i = 0; i < keylen; i++)
3952 innerkey[i] ^= keyptr[i];
3953 outerkey[i] ^= keyptr[i];
3956 /* Now do the hashes */
3958 chash_start(type, use_base);
3959 chash_mid(type, use_base, innerkey);
3960 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
3962 chash_start(type, use_base);
3963 chash_mid(type, use_base, outerkey);
3964 chash_end(type, use_base, innerhash, hashlen, finalhash);
3966 /* Encode the final hash as a hex string */
3969 for (i = 0; i < hashlen; i++)
3971 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3972 *p++ = hex_digits[finalhash[i] & 0x0f];
3975 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
3976 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
3978 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
3983 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
3984 We have to save the numerical variables and restore them afterwards. */
3989 int moffset, moffsetextra, slen;
3992 const uschar *rerror;
3995 int save_expand_nmax =
3996 save_expand_strings(save_expand_nstring, save_expand_nlength);
3998 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4000 case 1: goto EXPAND_FAILED_CURLY;
4002 case 3: goto EXPAND_FAILED;
4005 /* Compile the regular expression */
4007 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4012 expand_string_message = string_sprintf("regular expression error in "
4013 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4017 /* Now run a loop to do the substitutions as often as necessary. It ends
4018 when there are no more matches. Take care over matches of the null string;
4019 do the same thing as Perl does. */
4022 slen = Ustrlen(sub[0]);
4023 moffset = moffsetextra = 0;
4028 int ovector[3*(EXPAND_MAXN+1)];
4029 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4030 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4034 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4035 is not necessarily the end. We want to repeat the match from one
4036 character further along, but leaving the basic offset the same (for
4037 copying below). We can't be at the end of the string - that was checked
4038 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4039 finished; copy the remaining string and end the loop. */
4049 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4053 /* Match - set up for expanding the replacement. */
4055 if (n == 0) n = EXPAND_MAXN + 1;
4057 for (nn = 0; nn < n*2; nn += 2)
4059 expand_nstring[expand_nmax] = subject + ovector[nn];
4060 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4064 /* Copy the characters before the match, plus the expanded insertion. */
4066 yield = string_cat(yield, &size, &ptr, subject + moffset,
4067 ovector[0] - moffset);
4068 insert = expand_string(sub[2]);
4069 if (insert == NULL) goto EXPAND_FAILED;
4070 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4072 moffset = ovector[1];
4076 /* If we have matched an empty string, first check to see if we are at
4077 the end of the subject. If so, the loop is over. Otherwise, mimic
4078 what Perl's /g options does. This turns out to be rather cunning. First
4079 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4080 string at the same point. If this fails (picked up above) we advance to
4081 the next character. */
4083 if (ovector[0] == ovector[1])
4085 if (ovector[0] == slen) break;
4086 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4090 /* All done - restore numerical variables. */
4092 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4093 save_expand_nlength);
4097 /* Handle keyed and numbered substring extraction. If the first argument
4098 consists entirely of digits, then a numerical extraction is assumed. */
4104 int field_number = 1;
4105 BOOL field_number_set = FALSE;
4106 uschar *save_lookup_value = lookup_value;
4108 int save_expand_nmax =
4109 save_expand_strings(save_expand_nstring, save_expand_nlength);
4111 /* Read the arguments */
4113 for (i = 0; i < j; i++)
4115 while (isspace(*s)) s++;
4118 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4119 if (sub[i] == NULL) goto EXPAND_FAILED;
4120 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4122 /* After removal of leading and trailing white space, the first
4123 argument must not be empty; if it consists entirely of digits
4124 (optionally preceded by a minus sign), this is a numerical
4125 extraction, and we expect 3 arguments. */
4133 while (isspace(*p)) p++;
4137 while (len > 0 && isspace(p[len-1])) len--;
4142 expand_string_message = US"first argument of \"extract\" must "
4152 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4156 j = 3; /* Need 3 args */
4157 field_number_set = TRUE;
4161 else goto EXPAND_FAILED_CURLY;
4164 /* Extract either the numbered or the keyed substring into $value. If
4165 skipping, just pretend the extraction failed. */
4167 lookup_value = skipping? NULL : field_number_set?
4168 expand_gettokened(field_number, sub[1], sub[2]) :
4169 expand_getkeyed(sub[0], sub[1]);
4171 /* If no string follows, $value gets substituted; otherwise there can
4172 be yes/no strings, as for lookup or if. */
4174 switch(process_yesno(
4175 skipping, /* were previously skipping */
4176 lookup_value != NULL, /* success/failure indicator */
4177 save_lookup_value, /* value to reset for string2 */
4178 &s, /* input pointer */
4179 &yield, /* output pointer */
4180 &size, /* output size */
4181 &ptr, /* output current point */
4182 US"extract")) /* condition type */
4184 case 1: goto EXPAND_FAILED; /* when all is well, the */
4185 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4188 /* All done - restore numerical variables. */
4190 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4191 save_expand_nlength);
4197 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4198 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4199 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4200 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4202 #define EXPAND_DLFUNC_MAX_ARGS 8
4205 #ifndef EXPAND_DLFUNC
4206 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4207 "is not included in this binary";
4210 #else /* EXPAND_DLFUNC */
4213 exim_dlfunc_t *func;
4216 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4218 if ((expand_forbid & RDO_DLFUNC) != 0)
4220 expand_string_message =
4221 US"dynamically-loaded functions are not permitted";
4225 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4228 case 1: goto EXPAND_FAILED_CURLY;
4230 case 3: goto EXPAND_FAILED;
4233 /* If skipping, we don't actually do anything */
4235 if (skipping) continue;
4237 /* Look up the dynamically loaded object handle in the tree. If it isn't
4238 found, dlopen() the file and put the handle in the tree for next time. */
4240 t = tree_search(dlobj_anchor, argv[0]);
4243 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4246 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4247 argv[0], dlerror());
4248 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4251 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4252 Ustrcpy(t->name, argv[0]);
4253 t->data.ptr = handle;
4254 (void)tree_insertnode(&dlobj_anchor, t);
4257 /* Having obtained the dynamically loaded object handle, look up the
4258 function pointer. */
4260 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4263 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4264 "%s", argv[1], argv[0], dlerror());
4265 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4269 /* Call the function and work out what to do with the result. If it
4270 returns OK, we have a replacement string; if it returns DEFER then
4271 expansion has failed in a non-forced manner; if it returns FAIL then
4272 failure was forced; if it returns ERROR or any other value there's a
4273 problem, so panic slightly. */
4276 for (argc = 0; argv[argc] != NULL; argc++);
4277 status = func(&result, argc - 2, &argv[2]);
4280 if (result == NULL) result = US"";
4281 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4286 expand_string_message = result == NULL ? US"(no message)" : result;
4287 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4288 else if(status != FAIL)
4289 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4290 argv[0], argv[1], status, expand_string_message);
4294 #endif /* EXPAND_DLFUNC */
4297 /* Control reaches here if the name is not recognized as one of the more
4298 complicated expansion items. Check for the "operator" syntax (name terminated
4299 by a colon). Some of the operators have arguments, separated by _ from the
4306 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4307 if (sub == NULL) goto EXPAND_FAILED;
4310 /* Owing to an historical mis-design, an underscore may be part of the
4311 operator name, or it may introduce arguments. We therefore first scan the
4312 table of names that contain underscores. If there is no match, we cut off
4313 the arguments and then scan the main table. */
4315 c = chop_match(name, op_table_underscore,
4316 sizeof(op_table_underscore)/sizeof(uschar *));
4320 arg = Ustrchr(name, '_');
4321 if (arg != NULL) *arg = 0;
4322 c = chop_match(name, op_table_main,
4323 sizeof(op_table_main)/sizeof(uschar *));
4324 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4325 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
4328 /* If we are skipping, we don't need to perform the operation at all.
4329 This matters for operations like "mask", because the data may not be
4330 in the correct format when skipping. For example, the expression may test
4331 for the existence of $sender_host_address before trying to mask it. For
4332 other operations, doing them may not fail, but it is a waste of time. */
4334 if (skipping && c >= 0) continue;
4336 /* Otherwise, switch on the operator type */
4343 unsigned long int n = Ustrtoul(sub, &t, 10);
4346 expand_string_message = string_sprintf("argument for base62 "
4347 "operator is \"%s\", which is not a decimal number", sub);
4350 t = string_base62(n);
4351 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4359 unsigned long int n = 0;
4362 uschar *t = Ustrchr(base62_chars, *tt++);
4365 expand_string_message = string_sprintf("argument for base62d "
4366 "operator is \"%s\", which is not a base 62 number", sub);
4369 n = n * 62 + (t - base62_chars);
4371 (void)sprintf(CS buf, "%ld", n);
4372 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4378 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4379 if (expanded == NULL)
4381 expand_string_message =
4382 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4383 expand_string_message);
4386 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4393 uschar *t = sub - 1;
4394 while (*(++t) != 0) { *t = tolower(*t); count++; }
4395 yield = string_cat(yield, &size, &ptr, sub, count);
4402 uschar *t = sub - 1;
4403 while (*(++t) != 0) { *t = toupper(*t); count++; }
4404 yield = string_cat(yield, &size, &ptr, sub, count);
4415 md5_end(&base, sub, Ustrlen(sub), digest);
4416 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4417 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4428 sha1_end(&base, sub, Ustrlen(sub), digest);
4429 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4430 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4434 /* Convert hex encoding to base64 encoding */
4444 for (enc = sub; *enc != 0; enc++)
4446 if (!isxdigit(*enc))
4448 expand_string_message = string_sprintf("\"%s\" is not a hex "
4457 expand_string_message = string_sprintf("\"%s\" contains an odd "
4458 "number of characters", sub);
4462 while ((c = *in++) != 0)
4464 if (isdigit(c)) c -= '0';
4465 else c = toupper(c) - 'A' + 10;
4477 enc = auth_b64encode(sub, out - sub);
4478 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4482 /* mask applies a mask to an IP address; for example the result of
4483 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4490 int mask, maskoffset;
4491 int type = string_is_ip_address(sub, &maskoffset);
4496 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4501 if (maskoffset == 0)
4503 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4508 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4510 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4512 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4517 /* Convert the address to binary integer(s) and apply the mask */
4519 sub[maskoffset] = 0;
4520 count = host_aton(sub, binary);
4521 host_mask(count, binary, mask);
4523 /* Convert to masked textual format and add to output. */
4525 yield = string_cat(yield, &size, &ptr, buffer,
4526 host_nmtoa(count, binary, mask, buffer, '.'));
4531 case EOP_LOCAL_PART:
4535 int start, end, domain;
4536 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4540 if (c != EOP_DOMAIN)
4542 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4543 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4545 else if (domain != 0)
4548 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4554 /* quote puts a string in quotes if it is empty or contains anything
4555 other than alphamerics, underscore, dot, or hyphen.
4557 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4558 be quoted in order to be a valid local part.
4560 In both cases, newlines and carriage returns are converted into \n and \r
4564 case EOP_QUOTE_LOCAL_PART:
4567 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4568 uschar *t = sub - 1;
4572 while (!needs_quote && *(++t) != 0)
4573 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4575 else /* EOP_QUOTE_LOCAL_PART */
4577 while (!needs_quote && *(++t) != 0)
4578 needs_quote = !isalnum(*t) &&
4579 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4580 (*t != '.' || t == sub || t[1] == 0);
4585 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4590 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4591 else if (*t == '\r')
4592 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4595 if (*t == '\\' || *t == '"')
4596 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4597 yield = string_cat(yield, &size, &ptr, t, 1);
4600 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4602 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4606 /* quote_lookuptype does lookup-specific quoting */
4611 uschar *opt = Ustrchr(arg, '_');
4613 if (opt != NULL) *opt++ = 0;
4615 n = search_findtype(arg, Ustrlen(arg));
4618 expand_string_message = search_error_message;
4622 if (lookup_list[n].quote != NULL)
4623 sub = (lookup_list[n].quote)(sub, opt);
4624 else if (opt != NULL) sub = NULL;
4628 expand_string_message = string_sprintf(
4629 "\"%s\" unrecognized after \"${quote_%s\"",
4634 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4638 /* rx quote sticks in \ before any non-alphameric character so that
4639 the insertion works in a regular expression. */
4643 uschar *t = sub - 1;
4647 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4648 yield = string_cat(yield, &size, &ptr, t, 1);
4653 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4654 prescribed by the RFC, if there are characters that need to be encoded */
4658 uschar buffer[2048];
4659 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4660 buffer, sizeof(buffer));
4661 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4665 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4675 if (c > 255) c = '_';
4677 yield = string_cat(yield, &size, &ptr, buff, 1);
4682 /* escape turns all non-printing characters into escape sequences. */
4686 uschar *t = string_printing(sub);
4687 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4691 /* Handle numeric expression evaluation */
4696 uschar *save_sub = sub;
4697 uschar *error = NULL;
4698 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4701 expand_string_message = string_sprintf("error in expression "
4702 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4706 sprintf(CS var_buffer, "%d", n);
4707 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4711 /* Handle time period formating */
4713 case EOP_TIME_INTERVAL:
4716 uschar *t = read_number(&n, sub);
4717 if (*t != 0) /* Not A Number*/
4719 expand_string_message = string_sprintf("string \"%s\" is not a "
4720 "positive number in \"%s\" operator", sub, name);
4723 t = readconf_printtime(n);
4724 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4728 /* Convert string to base64 encoding */
4732 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4733 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4737 /* strlen returns the length of the string */
4742 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4743 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4747 /* length_n or l_n takes just the first n characters or the whole string,
4748 whichever is the shorter;
4750 substr_m_n, and s_m_n take n characters from offset m; negative m take
4751 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4752 takes the rest, either to the right or to the left.
4754 hash_n or h_n makes a hash of length n from the string, yielding n
4755 characters from the set a-z; hash_n_m makes a hash of length n, but
4756 uses m characters from the set a-zA-Z0-9.
4758 nhash_n returns a single number between 0 and n-1 (in text form), while
4759 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4760 between 0 and n-1 and the second between 0 and m-1. */
4780 expand_string_message = string_sprintf("missing values after %s",
4785 /* "length" has only one argument, effectively being synonymous with
4788 if (c == EOP_LENGTH || c == EOP_L)
4794 /* The others have one or two arguments; for "substr" the first may be
4795 negative. The second being negative means "not supplied". */
4800 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
4803 /* Read up to two numbers, separated by underscores */
4808 if (arg != ret && *arg == '_' && pn == &value1)
4812 if (arg[1] != 0) arg++;
4814 else if (!isdigit(*arg))
4816 expand_string_message =
4817 string_sprintf("non-digit after underscore in \"%s\"", name);
4820 else *pn = (*pn)*10 + *arg++ - '0';
4824 /* Perform the required operation */
4827 (c == EOP_HASH || c == EOP_H)?
4828 compute_hash(sub, value1, value2, &len) :
4829 (c == EOP_NHASH || c == EOP_NH)?
4830 compute_nhash(sub, value1, value2, &len) :
4831 extract_substr(sub, value1, value2, &len);
4833 if (ret == NULL) goto EXPAND_FAILED;
4834 yield = string_cat(yield, &size, &ptr, ret, len);
4844 uschar **modetable[3];
4849 if (stat(CS sub, &st) < 0)
4851 expand_string_message = string_sprintf("stat(%s) failed: %s",
4852 sub, strerror(errno));
4856 switch (mode & S_IFMT)
4858 case S_IFIFO: smode[0] = 'p'; break;
4859 case S_IFCHR: smode[0] = 'c'; break;
4860 case S_IFDIR: smode[0] = 'd'; break;
4861 case S_IFBLK: smode[0] = 'b'; break;
4862 case S_IFREG: smode[0] = '-'; break;
4863 default: smode[0] = '?'; break;
4866 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
4867 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
4868 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
4870 for (i = 0; i < 3; i++)
4872 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
4877 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
4878 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
4879 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
4880 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
4881 (long)st.st_gid, st.st_size, (long)st.st_atime,
4882 (long)st.st_mtime, (long)st.st_ctime);
4883 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
4887 /* Unknown operator */
4890 expand_string_message =
4891 string_sprintf("unknown expansion operator \"%s\"", name);
4896 /* Handle a plain name. If this is the first thing in the expansion, release
4897 the pre-allocated buffer. If the result data is known to be in a new buffer,
4898 newsize will be set to the size of that buffer, and we can just point at that
4899 store instead of copying. Many expansion strings contain just one reference,
4900 so this is a useful optimization, especially for humungous headers
4901 ($message_headers). */
4913 value = find_variable(name, FALSE, skipping, &newsize);
4916 expand_string_message =
4917 string_sprintf("unknown variable in \"${%s}\"", name);
4920 len = Ustrlen(value);
4921 if (yield == NULL && newsize != 0)
4927 else yield = string_cat(yield, &size, &ptr, value, len);
4931 /* Else there's something wrong */
4933 expand_string_message =
4934 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
4935 "in a variable reference)", name);
4939 /* If we hit the end of the string when ket_ends is set, there is a missing
4940 terminating brace. */
4942 if (ket_ends && *s == 0)
4944 expand_string_message = malformed_header?
4945 US"missing } at end of string - could be header name not terminated by colon"
4947 US"missing } at end of string";
4951 /* Expansion succeeded; yield may still be NULL here if nothing was actually
4952 added to the string. If so, set up an empty string. Add a terminating zero. If
4953 left != NULL, return a pointer to the terminator. */
4955 if (yield == NULL) yield = store_get(1);
4957 if (left != NULL) *left = s;
4959 /* Any stacking store that was used above the final string is no longer needed.
4960 In many cases the final string will be the first one that was got and so there
4961 will be optimal store usage. */
4963 store_reset(yield + ptr + 1);
4966 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
4968 if (skipping) debug_printf("skipping: result is not used\n");
4972 /* This is the failure exit: easiest to program with a goto. We still need
4973 to update the pointer to the terminator, for cases of nested calls with "fail".
4976 EXPAND_FAILED_CURLY:
4977 expand_string_message = malformed_header?
4978 US"missing or misplaced { or } - could be header name not terminated by colon"
4980 US"missing or misplaced { or }";
4982 /* At one point, Exim reset the store to yield (if yield was not NULL), but
4983 that is a bad idea, because expand_string_message is in dynamic store. */
4986 if (left != NULL) *left = s;
4989 debug_printf("failed to expand: %s\n", string);
4990 debug_printf(" error message: %s\n", expand_string_message);
4991 if (expand_string_forcedfail) debug_printf("failure was forced\n");
4997 /* This is the external function call. Do a quick check for any expansion
4998 metacharacters, and if there are none, just return the input string.
5000 Argument: the string to be expanded
5001 Returns: the expanded string, or NULL if expansion failed; if failure was
5002 due to a lookup deferring, search_find_defer will be TRUE
5006 expand_string(uschar *string)
5008 search_find_defer = FALSE;
5009 malformed_header = FALSE;
5010 return (Ustrpbrk(string, "$\\") == NULL)? string :
5011 expand_string_internal(string, FALSE, NULL, FALSE);
5016 /*************************************************
5018 *************************************************/
5020 /* Now and again we want to expand a string and be sure that the result is in a
5021 new bit of store. This function does that.
5023 Argument: the string to be expanded
5024 Returns: the expanded string, always in a new bit of store, or NULL
5028 expand_string_copy(uschar *string)
5030 uschar *yield = expand_string(string);
5031 if (yield == string) yield = string_copy(string);
5037 /*************************************************
5038 * Expand and interpret as an integer *
5039 *************************************************/
5041 /* Expand a string, and convert the result into an integer.
5043 Argument: the string to be expanded
5045 Returns: the integer value, or
5046 -1 for an expansion error ) in both cases, message in
5047 -2 for an integer interpretation error ) expand_string_message
5052 expand_string_integer(uschar *string)
5055 uschar *s = expand_string(string);
5056 uschar *msg = US"invalid integer \"%s\"";
5059 if (s == NULL) return -1;
5061 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5062 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5063 systems, so we set it zero ourselves. */
5066 value = strtol(CS s, CSS &endptr, 0);
5070 msg = US"integer expected but \"%s\" found";
5074 /* Ensure we can cast this down to an int */
5075 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5077 if (errno != ERANGE)
5079 if (tolower(*endptr) == 'k')
5081 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5085 else if (tolower(*endptr) == 'm')
5087 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5089 else value *= 1024*1024;
5093 if (errno == ERANGE)
5094 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5097 while (isspace(*endptr)) endptr++;
5098 if (*endptr == 0) return (int)value;
5102 expand_string_message = string_sprintf(CS msg, s);
5107 /*************************************************
5108 **************************************************
5109 * Stand-alone test program *
5110 **************************************************
5111 *************************************************/
5117 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5119 int ovector[3*(EXPAND_MAXN+1)];
5120 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5121 ovector, sizeof(ovector)/sizeof(int));
5122 BOOL yield = n >= 0;
5123 if (n == 0) n = EXPAND_MAXN + 1;
5127 expand_nmax = (setup < 0)? 0 : setup + 1;
5128 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5130 expand_nstring[expand_nmax] = subject + ovector[nn];
5131 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5139 int main(int argc, uschar **argv)
5142 uschar buffer[1024];
5144 debug_selector = D_v;
5145 debug_file = stderr;
5146 debug_fd = fileno(debug_file);
5147 big_buffer = malloc(big_buffer_size);
5149 for (i = 1; i < argc; i++)
5151 if (argv[i][0] == '+')
5153 debug_trace_memory = 2;
5156 if (isdigit(argv[i][0]))
5157 debug_selector = Ustrtol(argv[i], NULL, 0);
5159 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5163 eldap_default_servers = argv[i];
5166 mysql_servers = argv[i];
5169 pgsql_servers = argv[i];
5173 else opt_perl_startup = argv[i];
5177 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5179 expand_nstring[1] = US"string 1....";
5180 expand_nlength[1] = 8;
5184 if (opt_perl_startup != NULL)
5187 printf("Starting Perl interpreter\n");
5188 errstr = init_perl(opt_perl_startup);
5191 printf("** error in perl_startup code: %s\n", errstr);
5192 return EXIT_FAILURE;
5195 #endif /* EXIM_PERL */
5197 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5199 void *reset_point = store_get(0);
5200 uschar *yield = expand_string(buffer);
5203 printf("%s\n", yield);
5204 store_reset(reset_point);
5208 if (search_find_defer) printf("search_find deferred\n");
5209 printf("Failed: %s\n", expand_string_message);
5210 if (expand_string_forcedfail) printf("Forced failure\n");
5222 /* End of expand.c */