1 /* $Cambridge: exim/src/src/expand.c,v 1.18 2005/03/22 16:52:06 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[] = {
84 /* Tables of operator names, and corresponding switch numbers. The names must be
85 in alphabetical order. There are two tables, because underscore is used in some
86 cases to introduce arguments, whereas for other it is part of the name. This is
87 an historical mis-design. */
89 static uschar *op_table_underscore[] = {
101 static uschar *op_table_main[] = {
132 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
162 /* Table of condition names, and corresponding switch numbers. The names must
163 be in alphabetical order. */
165 static uschar *cond_table[] = {
169 US"==", /* Backward compatibility */
194 US"match_local_part",
216 ECOND_FIRST_DELIVERY,
232 ECOND_MATCH_LOCAL_PART,
242 /* Type for main variable table */
250 /* Type for entries pointing to address/length pairs. Not currently
258 /* Types of table entry */
261 vtype_int, /* value is address of int */
262 vtype_filter_int, /* ditto, but recognized only when filtering */
263 vtype_ino, /* value is address of ino_t (not always an int) */
264 vtype_uid, /* value is address of uid_t (not always an int) */
265 vtype_gid, /* value is address of gid_t (not always an int) */
266 vtype_stringptr, /* value is address of pointer to string */
267 vtype_msgbody, /* as stringptr, but read when first required */
268 vtype_msgbody_end, /* ditto, the end of the message */
269 vtype_msgheaders, /* the message's headers */
270 vtype_localpart, /* extract local part from string */
271 vtype_domain, /* extract domain from string */
272 vtype_recipients, /* extract recipients from recipients list */
273 /* (enabled only during system filtering */
274 vtype_todbsdin, /* value not used; generate BSD inbox tod */
275 vtype_tode, /* value not used; generate tod in epoch format */
276 vtype_todf, /* value not used; generate full tod */
277 vtype_todl, /* value not used; generate log tod */
278 vtype_todlf, /* value not used; generate log file datestamp tod */
279 vtype_todzone, /* value not used; generate time zone only */
280 vtype_todzulu, /* value not used; generate zulu tod */
281 vtype_reply, /* value not used; get reply from headers */
282 vtype_pid, /* value not used; result is pid */
283 vtype_host_lookup, /* value not used; get host name */
284 vtype_load_avg, /* value not used; result is int from os_getloadavg */
285 vtype_pspace, /* partition space; value is T/F for spool/log */
286 vtype_pinodes /* partition inodes; value is T/F for spool/log */
287 #ifdef EXPERIMENTAL_DOMAINKEYS
288 ,vtype_dk_verify /* Serve request out of DomainKeys verification structure */
292 /* This table must be kept in alphabetical order. */
294 static var_entry var_table[] = {
295 { "acl_c0", vtype_stringptr, &acl_var[0] },
296 { "acl_c1", vtype_stringptr, &acl_var[1] },
297 { "acl_c2", vtype_stringptr, &acl_var[2] },
298 { "acl_c3", vtype_stringptr, &acl_var[3] },
299 { "acl_c4", vtype_stringptr, &acl_var[4] },
300 { "acl_c5", vtype_stringptr, &acl_var[5] },
301 { "acl_c6", vtype_stringptr, &acl_var[6] },
302 { "acl_c7", vtype_stringptr, &acl_var[7] },
303 { "acl_c8", vtype_stringptr, &acl_var[8] },
304 { "acl_c9", vtype_stringptr, &acl_var[9] },
305 { "acl_m0", vtype_stringptr, &acl_var[10] },
306 { "acl_m1", vtype_stringptr, &acl_var[11] },
307 { "acl_m2", vtype_stringptr, &acl_var[12] },
308 { "acl_m3", vtype_stringptr, &acl_var[13] },
309 { "acl_m4", vtype_stringptr, &acl_var[14] },
310 { "acl_m5", vtype_stringptr, &acl_var[15] },
311 { "acl_m6", vtype_stringptr, &acl_var[16] },
312 { "acl_m7", vtype_stringptr, &acl_var[17] },
313 { "acl_m8", vtype_stringptr, &acl_var[18] },
314 { "acl_m9", vtype_stringptr, &acl_var[19] },
315 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
316 { "address_data", vtype_stringptr, &deliver_address_data },
317 { "address_file", vtype_stringptr, &address_file },
318 { "address_pipe", vtype_stringptr, &address_pipe },
319 { "authenticated_id", vtype_stringptr, &authenticated_id },
320 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
321 { "authentication_failed",vtype_int, &authentication_failed },
322 #ifdef EXPERIMENTAL_BRIGHTMAIL
323 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
324 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
325 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
326 { "bmi_deliver", vtype_int, &bmi_deliver },
328 { "body_linecount", vtype_int, &body_linecount },
329 { "body_zerocount", vtype_int, &body_zerocount },
330 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
331 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
332 { "caller_gid", vtype_gid, &real_gid },
333 { "caller_uid", vtype_uid, &real_uid },
334 { "compile_date", vtype_stringptr, &version_date },
335 { "compile_number", vtype_stringptr, &version_cnumber },
336 #ifdef WITH_OLD_DEMIME
337 { "demime_errorlevel", vtype_int, &demime_errorlevel },
338 { "demime_reason", vtype_stringptr, &demime_reason },
340 #ifdef EXPERIMENTAL_DOMAINKEYS
341 { "dk_domain", vtype_stringptr, &dk_signing_domain },
342 { "dk_is_signed", vtype_dk_verify, NULL },
343 { "dk_result", vtype_dk_verify, NULL },
344 { "dk_selector", vtype_stringptr, &dk_signing_selector },
345 { "dk_sender", vtype_dk_verify, NULL },
346 { "dk_sender_domain", vtype_dk_verify, NULL },
347 { "dk_sender_local_part",vtype_dk_verify, NULL },
348 { "dk_sender_source", vtype_dk_verify, NULL },
349 { "dk_signsall", vtype_dk_verify, NULL },
350 { "dk_status", vtype_dk_verify, NULL },
351 { "dk_testing", vtype_dk_verify, NULL },
353 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
354 { "dnslist_text", vtype_stringptr, &dnslist_text },
355 { "dnslist_value", vtype_stringptr, &dnslist_value },
356 { "domain", vtype_stringptr, &deliver_domain },
357 { "domain_data", vtype_stringptr, &deliver_domain_data },
358 { "exim_gid", vtype_gid, &exim_gid },
359 { "exim_path", vtype_stringptr, &exim_path },
360 { "exim_uid", vtype_uid, &exim_uid },
361 #ifdef WITH_OLD_DEMIME
362 { "found_extension", vtype_stringptr, &found_extension },
364 { "home", vtype_stringptr, &deliver_home },
365 { "host", vtype_stringptr, &deliver_host },
366 { "host_address", vtype_stringptr, &deliver_host_address },
367 { "host_data", vtype_stringptr, &host_data },
368 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
369 { "host_lookup_failed", vtype_int, &host_lookup_failed },
370 { "inode", vtype_ino, &deliver_inode },
371 { "interface_address", vtype_stringptr, &interface_address },
372 { "interface_port", vtype_int, &interface_port },
374 { "ldap_dn", vtype_stringptr, &eldap_dn },
376 { "load_average", vtype_load_avg, NULL },
377 { "local_part", vtype_stringptr, &deliver_localpart },
378 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
379 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
380 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
381 { "local_scan_data", vtype_stringptr, &local_scan_data },
382 { "local_user_gid", vtype_gid, &local_user_gid },
383 { "local_user_uid", vtype_uid, &local_user_uid },
384 { "localhost_number", vtype_int, &host_number },
385 { "log_inodes", vtype_pinodes, (void *)FALSE },
386 { "log_space", vtype_pspace, (void *)FALSE },
387 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
388 #ifdef WITH_CONTENT_SCAN
389 { "malware_name", vtype_stringptr, &malware_name },
391 { "message_age", vtype_int, &message_age },
392 { "message_body", vtype_msgbody, &message_body },
393 { "message_body_end", vtype_msgbody_end, &message_body_end },
394 { "message_body_size", vtype_int, &message_body_size },
395 { "message_headers", vtype_msgheaders, NULL },
396 { "message_id", vtype_stringptr, &message_id },
397 { "message_size", vtype_int, &message_size },
398 #ifdef WITH_CONTENT_SCAN
399 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
400 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
401 { "mime_boundary", vtype_stringptr, &mime_boundary },
402 { "mime_charset", vtype_stringptr, &mime_charset },
403 { "mime_content_description", vtype_stringptr, &mime_content_description },
404 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
405 { "mime_content_id", vtype_stringptr, &mime_content_id },
406 { "mime_content_size", vtype_int, &mime_content_size },
407 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
408 { "mime_content_type", vtype_stringptr, &mime_content_type },
409 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
410 { "mime_filename", vtype_stringptr, &mime_filename },
411 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
412 { "mime_is_multipart", vtype_int, &mime_is_multipart },
413 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
414 { "mime_part_count", vtype_int, &mime_part_count },
416 { "n0", vtype_filter_int, &filter_n[0] },
417 { "n1", vtype_filter_int, &filter_n[1] },
418 { "n2", vtype_filter_int, &filter_n[2] },
419 { "n3", vtype_filter_int, &filter_n[3] },
420 { "n4", vtype_filter_int, &filter_n[4] },
421 { "n5", vtype_filter_int, &filter_n[5] },
422 { "n6", vtype_filter_int, &filter_n[6] },
423 { "n7", vtype_filter_int, &filter_n[7] },
424 { "n8", vtype_filter_int, &filter_n[8] },
425 { "n9", vtype_filter_int, &filter_n[9] },
426 { "original_domain", vtype_stringptr, &deliver_domain_orig },
427 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
428 { "originator_gid", vtype_gid, &originator_gid },
429 { "originator_uid", vtype_uid, &originator_uid },
430 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
431 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
432 { "pid", vtype_pid, NULL },
433 { "primary_hostname", vtype_stringptr, &primary_hostname },
434 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
435 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
436 { "rcpt_count", vtype_int, &rcpt_count },
437 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
438 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
439 { "received_count", vtype_int, &received_count },
440 { "received_for", vtype_stringptr, &received_for },
441 { "received_protocol", vtype_stringptr, &received_protocol },
442 { "received_time", vtype_int, &received_time },
443 { "recipient_data", vtype_stringptr, &recipient_data },
444 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
445 { "recipients", vtype_recipients, NULL },
446 { "recipients_count", vtype_int, &recipients_count },
447 #ifdef WITH_CONTENT_SCAN
448 { "regex_match_string", vtype_stringptr, ®ex_match_string },
450 { "reply_address", vtype_reply, NULL },
451 { "return_path", vtype_stringptr, &return_path },
452 { "return_size_limit", vtype_int, &bounce_return_size_limit },
453 { "runrc", vtype_int, &runrc },
454 { "self_hostname", vtype_stringptr, &self_hostname },
455 { "sender_address", vtype_stringptr, &sender_address },
456 { "sender_address_data", vtype_stringptr, &sender_address_data },
457 { "sender_address_domain", vtype_domain, &sender_address },
458 { "sender_address_local_part", vtype_localpart, &sender_address },
459 { "sender_data", vtype_stringptr, &sender_data },
460 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
461 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
462 { "sender_host_address", vtype_stringptr, &sender_host_address },
463 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
464 { "sender_host_name", vtype_host_lookup, NULL },
465 { "sender_host_port", vtype_int, &sender_host_port },
466 { "sender_ident", vtype_stringptr, &sender_ident },
467 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
468 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
469 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
470 { "smtp_command_argument", vtype_stringptr, &smtp_command_argument },
471 { "sn0", vtype_filter_int, &filter_sn[0] },
472 { "sn1", vtype_filter_int, &filter_sn[1] },
473 { "sn2", vtype_filter_int, &filter_sn[2] },
474 { "sn3", vtype_filter_int, &filter_sn[3] },
475 { "sn4", vtype_filter_int, &filter_sn[4] },
476 { "sn5", vtype_filter_int, &filter_sn[5] },
477 { "sn6", vtype_filter_int, &filter_sn[6] },
478 { "sn7", vtype_filter_int, &filter_sn[7] },
479 { "sn8", vtype_filter_int, &filter_sn[8] },
480 { "sn9", vtype_filter_int, &filter_sn[9] },
481 #ifdef WITH_CONTENT_SCAN
482 { "spam_bar", vtype_stringptr, &spam_bar },
483 { "spam_report", vtype_stringptr, &spam_report },
484 { "spam_score", vtype_stringptr, &spam_score },
485 { "spam_score_int", vtype_stringptr, &spam_score_int },
487 #ifdef EXPERIMENTAL_SPF
488 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
489 { "spf_received", vtype_stringptr, &spf_received },
490 { "spf_result", vtype_stringptr, &spf_result },
491 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
493 { "spool_directory", vtype_stringptr, &spool_directory },
494 { "spool_inodes", vtype_pinodes, (void *)TRUE },
495 { "spool_space", vtype_pspace, (void *)TRUE },
496 #ifdef EXPERIMENTAL_SRS
497 { "srs_db_address", vtype_stringptr, &srs_db_address },
498 { "srs_db_key", vtype_stringptr, &srs_db_key },
499 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
500 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
501 { "srs_recipient", vtype_stringptr, &srs_recipient },
502 { "srs_status", vtype_stringptr, &srs_status },
504 { "thisaddress", vtype_stringptr, &filter_thisaddress },
505 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
506 { "tls_cipher", vtype_stringptr, &tls_cipher },
507 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
508 { "tod_bsdinbox", vtype_todbsdin, NULL },
509 { "tod_epoch", vtype_tode, NULL },
510 { "tod_full", vtype_todf, NULL },
511 { "tod_log", vtype_todl, NULL },
512 { "tod_logfile", vtype_todlf, NULL },
513 { "tod_zone", vtype_todzone, NULL },
514 { "tod_zulu", vtype_todzulu, NULL },
515 { "value", vtype_stringptr, &lookup_value },
516 { "version_number", vtype_stringptr, &version_string },
517 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
518 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
519 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
520 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
521 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
522 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
525 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
526 static uschar var_buffer[256];
527 static BOOL malformed_header;
529 /* For textual hashes */
531 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
532 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
535 enum { HMAC_MD5, HMAC_SHA1 };
537 /* For numeric hashes */
539 static unsigned int prime[] = {
540 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
541 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
542 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
544 /* For printing modes in symbolic form */
546 static uschar *mtable_normal[] =
547 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
549 static uschar *mtable_setid[] =
550 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
552 static uschar *mtable_sticky[] =
553 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
557 /*************************************************
558 * Tables for UTF-8 support *
559 *************************************************/
561 /* Table of the number of extra characters, indexed by the first character
562 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
565 static uschar utf8_table1[] = {
566 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
567 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
568 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
569 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
571 /* These are the masks for the data bits in the first byte of a character,
572 indexed by the number of additional bytes. */
574 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
576 /* Get the next UTF-8 character, advancing the pointer. */
578 #define GETUTF8INC(c, ptr) \
580 if ((c & 0xc0) == 0xc0) \
582 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
584 c = (c & utf8_table2[a]) << s; \
588 c |= (*ptr++ & 0x3f) << s; \
593 /*************************************************
594 * Binary chop search on a table *
595 *************************************************/
597 /* This is used for matching expansion items and operators.
600 name the name that is being sought
601 table the table to search
602 table_size the number of items in the table
604 Returns: the offset in the table, or -1
608 chop_match(uschar *name, uschar **table, int table_size)
610 uschar **bot = table;
611 uschar **top = table + table_size;
615 uschar **mid = bot + (top - bot)/2;
616 int c = Ustrcmp(name, *mid);
617 if (c == 0) return mid - table;
618 if (c > 0) bot = mid + 1; else top = mid;
626 /*************************************************
627 * Check a condition string *
628 *************************************************/
630 /* This function is called to expand a string, and test the result for a "true"
631 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
632 forced fail or lookup defer. All store used by the function can be released on
636 condition the condition string
637 m1 text to be incorporated in panic error
640 Returns: TRUE if condition is met, FALSE if not
644 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
647 void *reset_point = store_get(0);
648 uschar *ss = expand_string(condition);
651 if (!expand_string_forcedfail && !search_find_defer)
652 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
653 "for %s %s: %s", condition, m1, m2, expand_string_message);
656 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
657 strcmpic(ss, US"false") != 0;
658 store_reset(reset_point);
664 /*************************************************
665 * Pick out a name from a string *
666 *************************************************/
668 /* If the name is too long, it is silently truncated.
671 name points to a buffer into which to put the name
672 max is the length of the buffer
673 s points to the first alphabetic character of the name
674 extras chars other than alphanumerics to permit
676 Returns: pointer to the first character after the name
678 Note: The test for *s != 0 in the while loop is necessary because
679 Ustrchr() yields non-NULL if the character is zero (which is not something
683 read_name(uschar *name, int max, uschar *s, uschar *extras)
686 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
688 if (ptr < max-1) name[ptr++] = *s;
697 /*************************************************
698 * Pick out the rest of a header name *
699 *************************************************/
701 /* A variable name starting $header_ (or just $h_ for those who like
702 abbreviations) might not be the complete header name because headers can
703 contain any printing characters in their names, except ':'. This function is
704 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
705 on the end, if the name was terminated by white space.
708 name points to a buffer in which the name read so far exists
709 max is the length of the buffer
710 s points to the first character after the name so far, i.e. the
711 first non-alphameric character after $header_xxxxx
713 Returns: a pointer to the first character after the header name
717 read_header_name(uschar *name, int max, uschar *s)
719 int prelen = Ustrchr(name, '_') - name + 1;
720 int ptr = Ustrlen(name) - prelen;
721 if (ptr > 0) memmove(name, name+prelen, ptr);
722 while (mac_isgraph(*s) && *s != ':')
724 if (ptr < max-1) name[ptr++] = *s;
735 /*************************************************
736 * Pick out a number from a string *
737 *************************************************/
740 n points to an integer into which to put the number
741 s points to the first digit of the number
743 Returns: a pointer to the character after the last digit
747 read_number(int *n, uschar *s)
750 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
756 /*************************************************
757 * Extract keyed subfield from a string *
758 *************************************************/
760 /* The yield is in dynamic store; NULL means that the key was not found.
763 key points to the name of the key
764 s points to the string from which to extract the subfield
766 Returns: NULL if the subfield was not found, or
767 a pointer to the subfield's data
771 expand_getkeyed(uschar *key, uschar *s)
773 int length = Ustrlen(key);
774 while (isspace(*s)) s++;
776 /* Loop to search for the key */
784 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
785 dkeylength = s - dkey;
786 while (isspace(*s)) s++;
787 if (*s == '=') while (isspace((*(++s))));
789 data = string_dequote(&s);
790 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
793 while (isspace(*s)) s++;
802 /*************************************************
803 * Extract numbered subfield from string *
804 *************************************************/
806 /* Extracts a numbered field from a string that is divided by tokens - for
807 example a line from /etc/passwd is divided by colon characters. First field is
808 numbered one. Negative arguments count from the right. Zero returns the whole
809 string. Returns NULL if there are insufficient tokens in the string
812 Modifies final argument - this is a dynamically generated string, so that's OK.
815 field number of field to be extracted,
816 first field = 1, whole string = 0, last field = -1
817 separators characters that are used to break string into tokens
818 s points to the string from which to extract the subfield
820 Returns: NULL if the field was not found,
821 a pointer to the field's data inside s (modified to add 0)
825 expand_gettokened (int field, uschar *separators, uschar *s)
830 uschar *fieldtext = NULL;
832 if (field == 0) return s;
834 /* Break the line up into fields in place; for field > 0 we stop when we have
835 done the number of fields we want. For field < 0 we continue till the end of
836 the string, counting the number of fields. */
838 count = (field > 0)? field : INT_MAX;
844 /* Previous field was the last one in the string. For a positive field
845 number, this means there are not enough fields. For a negative field number,
846 check that there are enough, and scan back to find the one that is wanted. */
850 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
851 if ((-field) == (INT_MAX - count - 1)) return s;
855 while (ss[-1] != 0) ss--;
861 /* Previous field was not last in the string; save its start and put a
865 len = Ustrcspn(ss, separators);
876 /*************************************************
877 * Extract a substring from a string *
878 *************************************************/
880 /* Perform the ${substr or ${length expansion operations.
883 subject the input string
884 value1 the offset from the start of the input string to the start of
885 the output string; if negative, count from the right.
886 value2 the length of the output string, or negative (-1) for unset
887 if value1 is positive, unset means "all after"
888 if value1 is negative, unset means "all before"
889 len set to the length of the returned string
891 Returns: pointer to the output string, or NULL if there is an error
895 extract_substr(uschar *subject, int value1, int value2, int *len)
897 int sublen = Ustrlen(subject);
899 if (value1 < 0) /* count from right */
903 /* If the position is before the start, skip to the start, and adjust the
904 length. If the length ends up negative, the substring is null because nothing
905 can precede. This falls out naturally when the length is unset, meaning "all
911 if (value2 < 0) value2 = 0;
915 /* Otherwise an unset length => characters before value1 */
924 /* For a non-negative offset, if the starting position is past the end of the
925 string, the result will be the null string. Otherwise, an unset length means
926 "rest"; just set it to the maximum - it will be cut down below if necessary. */
935 else if (value2 < 0) value2 = sublen;
938 /* Cut the length down to the maximum possible for the offset value, and get
939 the required characters. */
941 if (value1 + value2 > sublen) value2 = sublen - value1;
943 return subject + value1;
949 /*************************************************
950 * Old-style hash of a string *
951 *************************************************/
953 /* Perform the ${hash expansion operation.
956 subject the input string (an expanded substring)
957 value1 the length of the output string; if greater or equal to the
958 length of the input string, the input string is returned
959 value2 the number of hash characters to use, or 26 if negative
960 len set to the length of the returned string
962 Returns: pointer to the output string, or NULL if there is an error
966 compute_hash(uschar *subject, int value1, int value2, int *len)
968 int sublen = Ustrlen(subject);
970 if (value2 < 0) value2 = 26;
971 else if (value2 > Ustrlen(hashcodes))
973 expand_string_message =
974 string_sprintf("hash count \"%d\" too big", value2);
978 /* Calculate the hash text. We know it is shorter than the original string, so
979 can safely place it in subject[] (we know that subject is always itself an
980 expanded substring). */
987 while ((c = (subject[j])) != 0)
989 int shift = (c + j++) & 7;
990 subject[i] ^= (c << shift) | (c >> (8-shift));
991 if (++i >= value1) i = 0;
993 for (i = 0; i < value1; i++)
994 subject[i] = hashcodes[(subject[i]) % value2];
996 else value1 = sublen;
1005 /*************************************************
1006 * Numeric hash of a string *
1007 *************************************************/
1009 /* Perform the ${nhash expansion operation. The first characters of the
1010 string are treated as most important, and get the highest prime numbers.
1013 subject the input string
1014 value1 the maximum value of the first part of the result
1015 value2 the maximum value of the second part of the result,
1016 or negative to produce only a one-part result
1017 len set to the length of the returned string
1019 Returns: pointer to the output string, or NULL if there is an error.
1023 compute_nhash (uschar *subject, int value1, int value2, int *len)
1025 uschar *s = subject;
1027 unsigned long int total = 0; /* no overflow */
1031 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1032 total += prime[i--] * (unsigned int)(*s++);
1035 /* If value2 is unset, just compute one number */
1039 s = string_sprintf("%d", total % value1);
1042 /* Otherwise do a div/mod hash */
1046 total = total % (value1 * value2);
1047 s = string_sprintf("%d/%d", total/value2, total % value2);
1058 /*************************************************
1059 * Find the value of a header or headers *
1060 *************************************************/
1062 /* Multiple instances of the same header get concatenated, and this function
1063 can also return a concatenation of all the header lines. When concatenating
1064 specific headers that contain lists of addresses, a comma is inserted between
1065 them. Otherwise we use a straight concatenation. Because some messages can have
1066 pathologically large number of lines, there is a limit on the length that is
1067 returned. Also, to avoid massive store use which would result from using
1068 string_cat() as it copies and extends strings, we do a preliminary pass to find
1069 out exactly how much store will be needed. On "normal" messages this will be
1073 name the name of the header, without the leading $header_ or $h_,
1074 or NULL if a concatenation of all headers is required
1075 exists_only TRUE if called from a def: test; don't need to build a string;
1076 just return a string that is not "" and not "0" if the header
1078 newsize return the size of memory block that was obtained; may be NULL
1079 if exists_only is TRUE
1080 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1081 other than concatenating, will be done on the header
1082 charset name of charset to translate MIME words to; used only if
1083 want_raw is false; if NULL, no translation is done (this is
1084 used for $bh_ and $bheader_)
1086 Returns: NULL if the header does not exist, else a pointer to a new
1091 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1094 BOOL found = name == NULL;
1096 int len = found? 0 : Ustrlen(name);
1098 uschar *yield = NULL;
1101 /* Loop for two passes - saves code repetition */
1103 for (i = 0; i < 2; i++)
1108 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1110 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1112 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1117 if (exists_only) return US"1"; /* don't need actual string */
1119 t = h->text + len; /* text to insert */
1120 if (!want_raw) /* unless wanted raw, */
1121 while (isspace(*t)) t++; /* remove leading white space */
1122 ilen = h->slen - (t - h->text); /* length to insert */
1124 /* Set comma = 1 if handling a single header and it's one of those
1125 that contains an address list, except when asked for raw headers. Only
1126 need to do this once. */
1128 if (!want_raw && name != NULL && comma == 0 &&
1129 Ustrchr("BCFRST", h->type) != NULL)
1132 /* First pass - compute total store needed; second pass - compute
1133 total store used, including this header. */
1135 size += ilen + comma;
1137 /* Second pass - concatentate the data, up to a maximum. Note that
1138 the loop stops when size hits the limit. */
1142 if (size > header_insert_maxlen)
1144 ilen -= size - header_insert_maxlen;
1147 Ustrncpy(ptr, t, ilen);
1149 if (comma != 0 && ilen > 0)
1159 /* At end of first pass, truncate size if necessary, and get the buffer
1160 to hold the data, returning the buffer size. */
1164 if (!found) return NULL;
1165 if (size > header_insert_maxlen) size = header_insert_maxlen;
1166 *newsize = size + 1;
1167 ptr = yield = store_get(*newsize);
1171 /* Remove a redundant added comma if present */
1173 if (comma != 0 && ptr > yield) ptr -= 2;
1175 /* That's all we do for raw header expansion. */
1182 /* Otherwise, we remove trailing whitespace, including newlines. Then we do RFC
1183 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1184 function can return an error with decoded data if the charset translation
1185 fails. If decoding fails, it returns NULL. */
1189 uschar *decoded, *error;
1190 while (ptr > yield && isspace(ptr[-1])) ptr--;
1192 decoded = rfc2047_decode2(yield, TRUE, charset, '?', NULL, newsize, &error);
1195 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1196 " input was: %s\n", error, yield);
1198 if (decoded != NULL) yield = decoded;
1207 /*************************************************
1208 * Find value of a variable *
1209 *************************************************/
1211 /* The table of variables is kept in alphabetic order, so we can search it
1212 using a binary chop. The "choplen" variable is nothing to do with the binary
1216 name the name of the variable being sought
1217 exists_only TRUE if this is a def: test; passed on to find_header()
1218 skipping TRUE => skip any processing evaluation; this is not the same as
1219 exists_only because def: may test for values that are first
1221 newsize pointer to an int which is initially zero; if the answer is in
1222 a new memory buffer, *newsize is set to its size
1224 Returns: NULL if the variable does not exist, or
1225 a pointer to the variable's contents, or
1226 something non-NULL if exists_only is TRUE
1230 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1233 int last = var_table_size;
1235 while (last > first)
1239 int middle = (first + last)/2;
1240 int c = Ustrcmp(name, var_table[middle].name);
1242 if (c > 0) { first = middle + 1; continue; }
1243 if (c < 0) { last = middle; continue; }
1245 /* Found an existing variable. If in skipping state, the value isn't needed,
1246 and we want to avoid processing (such as looking up up the host name). */
1248 if (skipping) return US"";
1250 switch (var_table[middle].type)
1252 case vtype_filter_int:
1253 if (!filter_running) return NULL;
1256 #ifdef EXPERIMENTAL_DOMAINKEYS
1258 case vtype_dk_verify:
1259 if (dk_verify_block == NULL) return US"";
1261 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1262 s = dk_verify_block->result_string;
1263 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1264 s = dk_verify_block->address;
1265 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1266 s = dk_verify_block->domain;
1267 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1268 s = dk_verify_block->local_part;
1270 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1271 switch(dk_verify_block->address_source) {
1272 case DK_EXIM_ADDRESS_NONE: s = "0"; break;
1273 case DK_EXIM_ADDRESS_FROM_FROM: s = "from"; break;
1274 case DK_EXIM_ADDRESS_FROM_SENDER: s = "sender"; break;
1277 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1278 switch(dk_verify_block->result) {
1279 case DK_EXIM_RESULT_ERR: s = "error"; break;
1280 case DK_EXIM_RESULT_BAD_FORMAT: s = "bad format"; break;
1281 case DK_EXIM_RESULT_NO_KEY: s = "no key"; break;
1282 case DK_EXIM_RESULT_NO_SIGNATURE: s = "no signature"; break;
1283 case DK_EXIM_RESULT_REVOKED: s = "revoked"; break;
1284 case DK_EXIM_RESULT_NON_PARTICIPANT: s = "non-participant"; break;
1285 case DK_EXIM_RESULT_GOOD: s = "good"; break;
1286 case DK_EXIM_RESULT_BAD: s = "bad"; break;
1289 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1290 s = (dk_verify_block->signsall)? "1" : "0";
1292 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1293 s = (dk_verify_block->testing)? "1" : "0";
1295 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1296 s = (dk_verify_block->is_signed)? "1" : "0";
1298 return (s == NULL)? US"" : s;
1302 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1306 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1310 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1314 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1317 case vtype_stringptr: /* Pointer to string */
1318 s = *((uschar **)(var_table[middle].value));
1319 return (s == NULL)? US"" : s;
1322 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1325 case vtype_load_avg:
1326 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1329 case vtype_host_lookup: /* Lookup if not done so */
1330 if (sender_host_name == NULL && sender_host_address != NULL &&
1331 !host_lookup_failed && host_name_lookup() == OK)
1332 host_build_sender_fullhost();
1333 return (sender_host_name == NULL)? US"" : sender_host_name;
1335 case vtype_localpart: /* Get local part from address */
1336 s = *((uschar **)(var_table[middle].value));
1337 if (s == NULL) return US"";
1338 domain = Ustrrchr(s, '@');
1339 if (domain == NULL) return s;
1340 if (domain - s > sizeof(var_buffer) - 1)
1341 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1342 "string expansion", sizeof(var_buffer));
1343 Ustrncpy(var_buffer, s, domain - s);
1344 var_buffer[domain - s] = 0;
1347 case vtype_domain: /* Get domain from address */
1348 s = *((uschar **)(var_table[middle].value));
1349 if (s == NULL) return US"";
1350 domain = Ustrrchr(s, '@');
1351 return (domain == NULL)? US"" : domain + 1;
1353 case vtype_msgheaders:
1354 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1356 case vtype_msgbody: /* Pointer to msgbody string */
1357 case vtype_msgbody_end: /* Ditto, the end of the msg */
1358 ss = (uschar **)(var_table[middle].value);
1359 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1362 int start_offset = SPOOL_DATA_START_OFFSET;
1363 int len = message_body_visible;
1364 if (len > message_size) len = message_size;
1365 *ss = body = store_malloc(len+1);
1367 if (var_table[middle].type == vtype_msgbody_end)
1369 struct stat statbuf;
1370 if (fstat(deliver_datafile, &statbuf) == 0)
1372 start_offset = statbuf.st_size - len;
1373 if (start_offset < SPOOL_DATA_START_OFFSET)
1374 start_offset = SPOOL_DATA_START_OFFSET;
1377 lseek(deliver_datafile, start_offset, SEEK_SET);
1378 len = read(deliver_datafile, body, len);
1384 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1388 return (*ss == NULL)? US"" : *ss;
1390 case vtype_todbsdin: /* BSD inbox time of day */
1391 return tod_stamp(tod_bsdin);
1393 case vtype_tode: /* Unix epoch time of day */
1394 return tod_stamp(tod_epoch);
1396 case vtype_todf: /* Full time of day */
1397 return tod_stamp(tod_full);
1399 case vtype_todl: /* Log format time of day */
1400 return tod_stamp(tod_log_bare); /* (without timezone) */
1402 case vtype_todzone: /* Time zone offset only */
1403 return tod_stamp(tod_zone);
1405 case vtype_todzulu: /* Zulu time */
1406 return tod_stamp(tod_zulu);
1408 case vtype_todlf: /* Log file datestamp tod */
1409 return tod_stamp(tod_log_datestamp);
1411 case vtype_reply: /* Get reply address */
1412 s = find_header(US"reply-to:", exists_only, newsize, FALSE,
1414 if (s == NULL || *s == 0)
1415 s = find_header(US"from:", exists_only, newsize, FALSE, headers_charset);
1416 return (s == NULL)? US"" : s;
1418 /* A recipients list is available only during system message filtering,
1419 during ACL processing after DATA, and while expanding pipe commands
1420 generated from a system filter, but not elsewhere. */
1422 case vtype_recipients:
1423 if (!enable_dollar_recipients) return NULL; else
1428 s = store_get(size);
1429 for (i = 0; i < recipients_count; i++)
1431 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1432 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1433 Ustrlen(recipients_list[i].address));
1435 s[ptr] = 0; /* string_cat() leaves room */
1442 sprintf(CS var_buffer, "%d",
1443 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1450 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1451 sprintf(CS var_buffer, "%d", inodes);
1457 return NULL; /* Unknown variable name */
1463 /*************************************************
1464 * Read and expand substrings *
1465 *************************************************/
1467 /* This function is called to read and expand argument substrings for various
1468 expansion items. Some have a minimum requirement that is less than the maximum;
1469 in these cases, the first non-present one is set to NULL.
1472 sub points to vector of pointers to set
1473 n maximum number of substrings
1475 sptr points to current string pointer
1476 skipping the skipping flag
1477 check_end if TRUE, check for final '}'
1478 name name of item, for error message
1480 Returns: 0 OK; string pointer updated
1481 1 curly bracketing error (too few arguments)
1482 2 too many arguments (only if check_end is set); message set
1483 3 other error (expansion failure)
1487 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1488 BOOL check_end, uschar *name)
1493 while (isspace(*s)) s++;
1494 for (i = 0; i < n; i++)
1498 if (i < m) return 1;
1502 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1503 if (sub[i] == NULL) return 3;
1504 if (*s++ != '}') return 1;
1505 while (isspace(*s)) s++;
1507 if (check_end && *s++ != '}')
1511 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1512 "(max is %d)", name, n);
1525 /*************************************************
1526 * Read and evaluate a condition *
1527 *************************************************/
1531 s points to the start of the condition text
1532 yield points to a BOOL to hold the result of the condition test;
1533 if NULL, we are just reading through a condition that is
1534 part of an "or" combination to check syntax, or in a state
1535 where the answer isn't required
1537 Returns: a pointer to the first character after the condition, or
1542 eval_condition(uschar *s, BOOL *yield)
1544 BOOL testfor = TRUE;
1545 BOOL tempcond, combined_cond;
1547 int i, rc, cond_type, roffset;
1549 struct stat statbuf;
1554 const uschar *rerror;
1558 while (isspace(*s)) s++;
1559 if (*s == '!') { testfor = !testfor; s++; } else break;
1562 /* Numeric comparisons are symbolic */
1564 if (*s == '=' || *s == '>' || *s == '<')
1576 /* All other conditions are named */
1578 else s = read_name(name, 256, s, US"_");
1580 /* If we haven't read a name, it means some non-alpha character is first. */
1584 expand_string_message = string_sprintf("condition name expected, "
1585 "but found \"%.16s\"", s);
1589 /* Find which condition we are dealing with, and switch on it */
1591 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1594 /* def: tests for a non-zero or non-NULL variable, or for an existing
1600 expand_string_message = US"\":\" expected after \"def\"";
1604 s = read_name(name, 256, s+1, US"_");
1606 /* Test for a header's existence */
1608 if (Ustrncmp(name, "h_", 2) == 0 ||
1609 Ustrncmp(name, "rh_", 3) == 0 ||
1610 Ustrncmp(name, "bh_", 3) == 0 ||
1611 Ustrncmp(name, "header_", 7) == 0 ||
1612 Ustrncmp(name, "rheader_", 8) == 0 ||
1613 Ustrncmp(name, "bheader_", 8) == 0)
1615 s = read_header_name(name, 256, s);
1616 if (yield != NULL) *yield =
1617 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1620 /* Test for a variable's having a non-empty value. If yield == NULL we
1621 are in a skipping state, and don't care about the answer. */
1625 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1628 expand_string_message = (name[0] == 0)?
1629 string_sprintf("variable name omitted after \"def:\"") :
1630 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1634 *yield = (value[0] != 0 && Ustrcmp(value, "0") != 0) == testfor;
1640 /* first_delivery tests for first delivery attempt */
1642 case ECOND_FIRST_DELIVERY:
1643 if (yield != NULL) *yield = deliver_firsttime == testfor;
1647 /* queue_running tests for any process started by a queue runner */
1649 case ECOND_QUEUE_RUNNING:
1650 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1654 /* exists: tests for file existence
1655 isip: tests for any IP address
1656 isip4: tests for an IPv4 address
1657 isip6: tests for an IPv6 address
1658 pam: does PAM authentication
1659 radius: does RADIUS authentication
1660 ldapauth: does LDAP authentication
1661 pwcheck: does Cyrus SASL pwcheck authentication
1670 case ECOND_LDAPAUTH:
1673 while (isspace(*s)) s++;
1674 if (*s != '{') goto COND_FAILED_CURLY_START;
1676 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1677 if (sub[0] == NULL) return NULL;
1678 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1680 if (yield == NULL) return s; /* No need to run the test if skipping */
1685 if ((expand_forbid & RDO_EXISTS) != 0)
1687 expand_string_message = US"File existence tests are not permitted";
1690 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1696 rc = string_is_ip_address(sub[0], NULL);
1697 *yield = ((cond_type == ECOND_ISIP)? (rc > 0) :
1698 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1701 /* Various authentication tests - all optionally compiled */
1705 rc = auth_call_pam(sub[0], &expand_string_message);
1708 goto COND_FAILED_NOT_COMPILED;
1709 #endif /* SUPPORT_PAM */
1712 #ifdef RADIUS_CONFIG_FILE
1713 rc = auth_call_radius(sub[0], &expand_string_message);
1716 goto COND_FAILED_NOT_COMPILED;
1717 #endif /* RADIUS_CONFIG_FILE */
1719 case ECOND_LDAPAUTH:
1722 /* Just to keep the interface the same */
1724 int old_pool = store_pool;
1725 store_pool = POOL_SEARCH;
1726 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1727 &expand_string_message, &do_cache);
1728 store_pool = old_pool;
1732 goto COND_FAILED_NOT_COMPILED;
1733 #endif /* LOOKUP_LDAP */
1736 #ifdef CYRUS_PWCHECK_SOCKET
1737 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1740 goto COND_FAILED_NOT_COMPILED;
1741 #endif /* CYRUS_PWCHECK_SOCKET */
1743 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1744 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1746 if (rc == ERROR || rc == DEFER) return NULL;
1747 *yield = (rc == OK) == testfor;
1753 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1755 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1757 However, the last two are optional. That is why the whole set is enclosed
1758 in their own set or braces. */
1760 case ECOND_SASLAUTHD:
1761 #ifndef CYRUS_SASLAUTHD_SOCKET
1762 goto COND_FAILED_NOT_COMPILED;
1764 while (isspace(*s)) s++;
1765 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1766 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1768 case 1: expand_string_message = US"too few arguments or bracketing "
1769 "error for saslauthd";
1771 case 3: return NULL;
1773 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1777 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1778 &expand_string_message);
1779 if (rc == ERROR || rc == DEFER) return NULL;
1780 *yield = (rc == OK) == testfor;
1783 #endif /* CYRUS_SASLAUTHD_SOCKET */
1786 /* symbolic operators for numeric and string comparison, and a number of
1787 other operators, all requiring two arguments.
1789 match: does a regular expression match and sets up the numerical
1790 variables if it succeeds
1791 match_address: matches in an address list
1792 match_domain: matches in a domain list
1793 match_local_part: matches in a local part list
1794 crypteq: encrypts plaintext and compares against an encrypted text,
1795 using crypt(), crypt16(), MD5 or SHA-1
1799 case ECOND_MATCH_ADDRESS:
1800 case ECOND_MATCH_DOMAIN:
1801 case ECOND_MATCH_LOCAL_PART:
1804 case ECOND_NUM_L: /* Numerical comparisons */
1811 case ECOND_STR_LT: /* String comparisons */
1822 for (i = 0; i < 2; i++)
1824 while (isspace(*s)) s++;
1827 if (i == 0) goto COND_FAILED_CURLY_START;
1828 expand_string_message = string_sprintf("missing 2nd string in {} "
1829 "after \"%s\"", name);
1832 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1833 if (sub[i] == NULL) return NULL;
1834 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1836 /* Convert to numerical if required; we know that the names of all the
1837 conditions that compare numbers do not start with a letter. This just saves
1838 checking for them individually. */
1840 if (!isalpha(name[0]))
1843 num[i] = (int)Ustrtol((const uschar *)sub[i], &endptr, 10);
1844 if (tolower(*endptr) == 'k')
1849 else if (tolower(*endptr) == 'm')
1851 num[i] *= 1024*1024;
1854 while (isspace(*endptr)) endptr++;
1857 expand_string_message = string_sprintf("\"%s\" is not a number",
1864 /* Result not required */
1866 if (yield == NULL) return s;
1868 /* Do an appropriate comparison */
1874 *yield = (num[0] == num[1]) == testfor;
1878 *yield = (num[0] > num[1]) == testfor;
1882 *yield = (num[0] >= num[1]) == testfor;
1886 *yield = (num[0] < num[1]) == testfor;
1890 *yield = (num[0] <= num[1]) == testfor;
1894 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1898 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1902 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1906 *yield = (strcmpic(sub[0], sub[1]) <= 0) == 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;
1933 case ECOND_MATCH: /* Regular expression match */
1934 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1938 expand_string_message = string_sprintf("regular expression error in "
1939 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1942 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1945 case ECOND_MATCH_ADDRESS: /* Match in an address list */
1946 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1947 goto MATCHED_SOMETHING;
1949 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
1950 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1951 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1952 goto MATCHED_SOMETHING;
1954 case ECOND_MATCH_LOCAL_PART:
1955 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
1956 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
1971 expand_string_message = string_sprintf("unable to complete match "
1972 "against \"%s\": %s", sub[1], search_error_message);
1978 /* Various "encrypted" comparisons. If the second string starts with
1979 "{" then an encryption type is given. Default to crypt() or crypt16()
1980 (build-time choice). */
1983 #ifndef SUPPORT_CRYPTEQ
1984 goto COND_FAILED_NOT_COMPILED;
1986 if (strncmpic(sub[1], US"{md5}", 5) == 0)
1988 int sublen = Ustrlen(sub[1]+5);
1993 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
1995 /* If the length that we are comparing against is 24, the MD5 digest
1996 is expressed as a base64 string. This is the way LDAP does it. However,
1997 some other software uses a straightforward hex representation. We assume
1998 this if the length is 32. Other lengths fail. */
2002 uschar *coded = auth_b64encode((uschar *)digest, 16);
2003 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2004 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2005 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2007 else if (sublen == 32)
2011 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2013 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2014 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2015 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2019 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2020 "fail\n crypted=%s\n", sub[1]+5);
2025 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2027 int sublen = Ustrlen(sub[1]+6);
2032 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2034 /* If the length that we are comparing against is 28, assume the SHA1
2035 digest is expressed as a base64 string. If the length is 40, assume a
2036 straightforward hex representation. Other lengths fail. */
2040 uschar *coded = auth_b64encode((uschar *)digest, 20);
2041 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2042 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2043 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2045 else if (sublen == 40)
2049 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2051 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2052 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2053 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2057 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2058 "fail\n crypted=%s\n", sub[1]+6);
2063 else /* {crypt} or {crypt16} and non-{ at start */
2068 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2073 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2078 else if (sub[1][0] == '{')
2080 expand_string_message = string_sprintf("unknown encryption mechanism "
2081 "in \"%s\"", sub[1]);
2087 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2088 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2089 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2093 #define XSTR(s) STR(s)
2094 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2095 " subject=%s\n crypted=%s\n",
2096 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2101 /* If the encrypted string contains fewer than two characters (for the
2102 salt), force failure. Otherwise we get false positives: with an empty
2103 string the yield of crypt() is an empty string! */
2105 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2106 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2109 #endif /* SUPPORT_CRYPTEQ */
2110 } /* Switch for comparison conditions */
2112 return s; /* End of comparison conditions */
2115 /* and/or: computes logical and/or of several conditions */
2119 subcondptr = (yield == NULL)? NULL : &tempcond;
2120 combined_cond = (cond_type == ECOND_AND);
2122 while (isspace(*s)) s++;
2123 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2127 while (isspace(*s)) s++;
2128 if (*s == '}') break;
2131 expand_string_message = string_sprintf("each subcondition "
2132 "inside an \"%s{...}\" condition must be in its own {}", name);
2136 s = eval_condition(s+1, subcondptr);
2139 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2140 expand_string_message, name);
2143 while (isspace(*s)) s++;
2147 expand_string_message = string_sprintf("missing } at end of condition "
2148 "inside \"%s\" group", name);
2154 if (cond_type == ECOND_AND)
2156 combined_cond &= tempcond;
2157 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2158 } /* evaluate any more */
2161 combined_cond |= tempcond;
2162 if (combined_cond) subcondptr = NULL; /* once true, don't */
2163 } /* evaluate any more */
2167 if (yield != NULL) *yield = (combined_cond == testfor);
2171 /* Unknown condition */
2174 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2176 } /* End switch on condition type */
2178 /* Missing braces at start and end of data */
2180 COND_FAILED_CURLY_START:
2181 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2184 COND_FAILED_CURLY_END:
2185 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2189 /* A condition requires code that is not compiled */
2191 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2192 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2193 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2194 COND_FAILED_NOT_COMPILED:
2195 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2204 /*************************************************
2205 * Save numerical variables *
2206 *************************************************/
2208 /* This function is called from items such as "if" that want to preserve and
2209 restore the numbered variables.
2212 save_expand_string points to an array of pointers to set
2213 save_expand_nlength points to an array of ints for the lengths
2215 Returns: the value of expand max to save
2219 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2222 for (i = 0; i <= expand_nmax; i++)
2224 save_expand_nstring[i] = expand_nstring[i];
2225 save_expand_nlength[i] = expand_nlength[i];
2232 /*************************************************
2233 * Restore numerical variables *
2234 *************************************************/
2236 /* This function restored saved values of numerical strings.
2239 save_expand_nmax the number of strings to restore
2240 save_expand_string points to an array of pointers
2241 save_expand_nlength points to an array of ints
2247 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2248 int *save_expand_nlength)
2251 expand_nmax = save_expand_nmax;
2252 for (i = 0; i <= expand_nmax; i++)
2254 expand_nstring[i] = save_expand_nstring[i];
2255 expand_nlength[i] = save_expand_nlength[i];
2263 /*************************************************
2264 * Handle yes/no substrings *
2265 *************************************************/
2267 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2268 alternative substrings that depend on whether or not the condition was true,
2269 or the lookup or extraction succeeded. The substrings always have to be
2270 expanded, to check their syntax, but "skipping" is set when the result is not
2271 needed - this avoids unnecessary nested lookups.
2274 skipping TRUE if we were skipping when this item was reached
2275 yes TRUE if the first string is to be used, else use the second
2276 save_lookup a value to put back into lookup_value before the 2nd expansion
2277 sptr points to the input string pointer
2278 yieldptr points to the output string pointer
2279 sizeptr points to the output string size
2280 ptrptr points to the output string pointer
2281 type "lookup" or "if" or "extract" or "run", for error message
2283 Returns: 0 OK; lookup_value has been reset to save_lookup
2285 2 expansion failed because of bracketing error
2289 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2290 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2293 uschar *s = *sptr; /* Local value */
2294 uschar *sub1, *sub2;
2296 /* If there are no following strings, we substitute the contents of $value for
2297 lookups and for extractions in the success case. For the ${if item, the string
2298 "true" is substituted. In the fail case, nothing is substituted for all three
2301 while (isspace(*s)) s++;
2306 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2310 if (yes && lookup_value != NULL)
2311 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2312 Ustrlen(lookup_value));
2313 lookup_value = save_lookup;
2319 /* Expand the first substring. Forced failures are noticed only if we actually
2320 want this string. Set skipping in the call in the fail case (this will always
2321 be the case if we were already skipping). */
2323 sub1 = expand_string_internal(s+1, TRUE, &s, !yes);
2324 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2325 expand_string_forcedfail = FALSE;
2326 if (*s++ != '}') goto FAILED_CURLY;
2328 /* If we want the first string, add it to the output */
2331 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2333 /* If this is called from a lookup or an extract, we want to restore $value to
2334 what it was at the start of the item, so that it has this value during the
2335 second string expansion. For the call from "if" to this function, save_lookup
2336 is set to lookup_value, so that this statement does nothing. */
2338 lookup_value = save_lookup;
2340 /* There now follows either another substring, or "fail", or nothing. This
2341 time, forced failures are noticed only if we want the second string. We must
2342 set skipping in the nested call if we don't want this string, or if we were
2343 already skipping. */
2345 while (isspace(*s)) s++;
2348 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2349 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2350 expand_string_forcedfail = FALSE;
2351 if (*s++ != '}') goto FAILED_CURLY;
2353 /* If we want the second string, add it to the output */
2356 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2359 /* If there is no second string, but the word "fail" is present when the use of
2360 the second string is wanted, set a flag indicating it was a forced failure
2361 rather than a syntactic error. Swallow the terminating } in case this is nested
2362 inside another lookup or if or extract. */
2367 s = read_name(name, sizeof(name), s, US"_");
2368 if (Ustrcmp(name, "fail") == 0)
2370 if (!yes && !skipping)
2372 while (isspace(*s)) s++;
2373 if (*s++ != '}') goto FAILED_CURLY;
2374 expand_string_message =
2375 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2376 expand_string_forcedfail = TRUE;
2382 expand_string_message =
2383 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2388 /* All we have to do now is to check on the final closing brace. */
2390 while (isspace(*s)) s++;
2391 if (*s++ == '}') goto RETURN;
2393 /* Get here if there is a bracketing failure */
2398 /* Get here for other failures */
2403 /* Update the input pointer value before returning */
2415 /*************************************************
2416 * Handle MD5 or SHA-1 computation for HMAC *
2417 *************************************************/
2419 /* These are some wrapping functions that enable the HMAC code to be a bit
2420 cleaner. A good compiler will spot the tail recursion.
2423 type HMAC_MD5 or HMAC_SHA1
2424 remaining are as for the cryptographic hash functions
2430 chash_start(int type, void *base)
2432 if (type == HMAC_MD5)
2433 md5_start((md5 *)base);
2435 sha1_start((sha1 *)base);
2439 chash_mid(int type, void *base, uschar *string)
2441 if (type == HMAC_MD5)
2442 md5_mid((md5 *)base, string);
2444 sha1_mid((sha1 *)base, string);
2448 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2450 if (type == HMAC_MD5)
2451 md5_end((md5 *)base, string, length, digest);
2453 sha1_end((sha1 *)base, string, length, digest);
2460 /*************************************************
2461 * Join a file onto the output string *
2462 *************************************************/
2464 /* This is used for readfile and after a run expansion. It joins the contents
2465 of a file onto the output string, globally replacing newlines with a given
2466 string (optionally). The file is closed at the end.
2470 yield pointer to the expandable string
2471 sizep pointer to the current size
2472 ptrp pointer to the current position
2473 eol newline replacement string, or NULL
2475 Returns: new value of string pointer
2479 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2482 uschar buffer[1024];
2484 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2486 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2488 int len = Ustrlen(buffer);
2489 if (eol != NULL && buffer[len-1] == '\n') len--;
2490 yield = string_cat(yield, sizep, ptrp, buffer, len);
2491 if (buffer[len] != 0)
2492 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2495 if (yield != NULL) yield[*ptrp] = 0;
2503 /*************************************************
2504 * Evaluate numeric expression *
2505 *************************************************/
2507 /* This is a set of mutually recursive functions that evaluate a simple
2508 arithmetic expression involving only + - * / and parentheses. The only one that
2509 is called from elsewhere is eval_expr, whose interface is:
2512 sptr pointer to the pointer to the string - gets updated
2513 decimal TRUE if numbers are to be assumed decimal
2514 error pointer to where to put an error message - must be NULL on input
2515 endket TRUE if ')' must terminate - FALSE for external call
2518 Returns: on success: the value of the expression, with *error still NULL
2519 on failure: an undefined value, with *error = a message
2522 static int eval_sumterm(uschar **, BOOL, uschar **);
2525 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2528 int x = eval_sumterm(&s, decimal, error);
2531 while (*s == '+' || *s == '-')
2534 int y = eval_sumterm(&s, decimal, error);
2535 if (*error != NULL) break;
2536 if (op == '+') x += y; else x -= y;
2543 *error = US"expecting closing parenthesis";
2545 while (isspace(*(++s)));
2547 else if (*s != 0) *error = US"expecting + or -";
2556 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2561 while (isspace(*s)) s++;
2563 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2566 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2568 if (tolower(*s) == 'k') { n *= 1024; s++; }
2569 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2570 while (isspace (*s)) s++;
2575 n = eval_expr(&s, decimal, error, 1);
2579 *error = US"expecting number or opening parenthesis";
2586 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2589 int x = eval_term(&s, decimal, error);
2592 while (*s == '*' || *s == '/')
2595 int y = eval_term(&s, decimal, error);
2596 if (*error != NULL) break;
2597 if (op == '*') x *= y; else x /= y;
2607 /*************************************************
2609 *************************************************/
2611 /* Returns either an unchanged string, or the expanded string in stacking pool
2612 store. Interpreted sequences are:
2614 \... normal escaping rules
2615 $name substitutes the variable
2617 ${op:string} operates on the expanded string value
2618 ${item{arg1}{arg2}...} expands the args and then does the business
2619 some literal args are not enclosed in {}
2621 There are now far too many operators and item types to make it worth listing
2622 them here in detail any more.
2624 We use an internal routine recursively to handle embedded substrings. The
2625 external function follows. The yield is NULL if the expansion failed, and there
2626 are two cases: if something collapsed syntactically, or if "fail" was given
2627 as the action on a lookup failure. These can be distinguised by looking at the
2628 variable expand_string_forcedfail, which is TRUE in the latter case.
2630 The skipping flag is set true when expanding a substring that isn't actually
2631 going to be used (after "if" or "lookup") and it prevents lookups from
2632 happening lower down.
2634 Store usage: At start, a store block of the length of the input plus 64
2635 is obtained. This is expanded as necessary by string_cat(), which might have to
2636 get a new block, or might be able to expand the original. At the end of the
2637 function we can release any store above that portion of the yield block that
2638 was actually used. In many cases this will be optimal.
2640 However: if the first item in the expansion is a variable name or header name,
2641 we reset the store before processing it; if the result is in fresh store, we
2642 use that without copying. This is helpful for expanding strings like
2643 $message_headers which can get very long.
2646 string the string to be expanded
2647 ket_ends true if expansion is to stop at }
2648 left if not NULL, a pointer to the first character after the
2649 expansion is placed here (typically used with ket_ends)
2650 skipping TRUE for recursive calls when the value isn't actually going
2651 to be used (to allow for optimisation)
2653 Returns: NULL if expansion fails:
2654 expand_string_forcedfail is set TRUE if failure was forced
2655 expand_string_message contains a textual error message
2656 a pointer to the expanded string on success
2660 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2664 int size = Ustrlen(string)+ 64;
2666 uschar *yield = store_get(size);
2668 uschar *save_expand_nstring[EXPAND_MAXN+1];
2669 int save_expand_nlength[EXPAND_MAXN+1];
2671 expand_string_forcedfail = FALSE;
2672 expand_string_message = US"";
2679 /* \ escapes the next character, which must exist, or else
2680 the expansion fails. There's a special escape, \N, which causes
2681 copying of the subject verbatim up to the next \N. Otherwise,
2682 the escapes are the standard set. */
2688 expand_string_message = US"\\ at end of string";
2695 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2696 yield = string_cat(yield, &size, &ptr, t, s - t);
2697 if (*s != 0) s += 2;
2703 ch[0] = string_interpret_escape(&s);
2705 yield = string_cat(yield, &size, &ptr, ch, 1);
2711 /* Anything other than $ is just copied verbatim, unless we are
2712 looking for a terminating } character. */
2714 if (ket_ends && *s == '}') break;
2718 yield = string_cat(yield, &size, &ptr, s++, 1);
2722 /* No { after the $ - must be a plain name or a number for string
2723 match variable. There has to be a fudge for variables that are the
2724 names of header fields preceded by "$header_" because header field
2725 names can contain any printing characters except space and colon.
2726 For those that don't like typing this much, "$h_" is a synonym for
2727 "$header_". A non-existent header yields a NULL value; nothing is
2730 if (isalpha((*(++s))))
2735 s = read_name(name, sizeof(name), s, US"_");
2737 /* If this is the first thing to be expanded, release the pre-allocated
2740 if (ptr == 0 && yield != NULL)
2749 if (Ustrncmp(name, "h_", 2) == 0 ||
2750 Ustrncmp(name, "rh_", 3) == 0 ||
2751 Ustrncmp(name, "bh_", 3) == 0 ||
2752 Ustrncmp(name, "header_", 7) == 0 ||
2753 Ustrncmp(name, "rheader_", 8) == 0 ||
2754 Ustrncmp(name, "bheader_", 8) == 0)
2756 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2757 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2758 s = read_header_name(name, sizeof(name), s);
2759 value = find_header(name, FALSE, &newsize, want_raw, charset);
2761 /* If we didn't find the header, and the header contains a closing brace
2762 characters, this may be a user error where the terminating colon
2763 has been omitted. Set a flag to adjust the error message in this case.
2764 But there is no error here - nothing gets inserted. */
2768 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2777 value = find_variable(name, FALSE, skipping, &newsize);
2780 expand_string_message =
2781 string_sprintf("unknown variable name \"%s\"", name);
2786 /* If the data is known to be in a new buffer, newsize will be set to the
2787 size of that buffer. If this is the first thing in an expansion string,
2788 yield will be NULL; just point it at the new store instead of copying. Many
2789 expansion strings contain just one reference, so this is a useful
2790 optimization, especially for humungous headers. */
2792 len = Ustrlen(value);
2793 if (yield == NULL && newsize != 0)
2799 else yield = string_cat(yield, &size, &ptr, value, len);
2807 s = read_number(&n, s);
2808 if (n >= 0 && n <= expand_nmax)
2809 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2814 /* Otherwise, if there's no '{' after $ it's an error. */
2818 expand_string_message = US"$ not followed by letter, digit, or {";
2822 /* After { there can be various things, but they all start with
2823 an initial word, except for a number for a string match variable. */
2825 if (isdigit((*(++s))))
2828 s = read_number(&n, s);
2831 expand_string_message = US"} expected after number";
2834 if (n >= 0 && n <= expand_nmax)
2835 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2842 expand_string_message = US"letter or digit expected after ${";
2846 /* Allow "-" in names to cater for substrings with negative
2847 arguments. Since we are checking for known names after { this is
2850 s = read_name(name, sizeof(name), s, US"_-");
2851 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
2855 /* Handle conditionals - preserve the values of the numerical expansion
2856 variables in case they get changed by a regular expression match in the
2857 condition. If not, they retain their external settings. At the end
2858 of this "if" section, they get restored to their previous values. */
2864 int save_expand_nmax =
2865 save_expand_strings(save_expand_nstring, save_expand_nlength);
2867 while (isspace(*s)) s++;
2868 next_s = eval_condition(s, skipping? NULL : &cond);
2869 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
2872 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
2873 cond? "true" : "false");
2877 /* The handling of "yes" and "no" result strings is now in a separate
2878 function that is also used by ${lookup} and ${extract} and ${run}. */
2880 switch(process_yesno(
2881 skipping, /* were previously skipping */
2882 cond, /* success/failure indicator */
2883 lookup_value, /* value to reset for string2 */
2884 &s, /* input pointer */
2885 &yield, /* output pointer */
2886 &size, /* output size */
2887 &ptr, /* output current point */
2888 US"if")) /* condition type */
2890 case 1: goto EXPAND_FAILED; /* when all is well, the */
2891 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
2894 /* Restore external setting of expansion variables for continuation
2897 restore_expand_strings(save_expand_nmax, save_expand_nstring,
2898 save_expand_nlength);
2902 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
2903 expanding an internal string that isn't actually going to be used. All we
2904 need to do is check the syntax, so don't do a lookup at all. Preserve the
2905 values of the numerical expansion variables in case they get changed by a
2906 partial lookup. If not, they retain their external settings. At the end
2907 of this "lookup" section, they get restored to their previous values. */
2911 int stype, partial, affixlen, starflags;
2912 int expand_setup = 0;
2914 uschar *key, *filename, *affix;
2915 uschar *save_lookup_value = lookup_value;
2916 int save_expand_nmax =
2917 save_expand_strings(save_expand_nstring, save_expand_nlength);
2919 if ((expand_forbid & RDO_LOOKUP) != 0)
2921 expand_string_message = US"lookup expansions are not permitted";
2925 /* Get the key we are to look up for single-key+file style lookups.
2926 Otherwise set the key NULL pro-tem. */
2928 while (isspace(*s)) s++;
2931 key = expand_string_internal(s+1, TRUE, &s, skipping);
2932 if (key == NULL) goto EXPAND_FAILED;
2933 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
2934 while (isspace(*s)) s++;
2938 /* Find out the type of database */
2942 expand_string_message = US"missing lookup type";
2946 /* The type is a string that may contain special characters of various
2947 kinds. Allow everything except space or { to appear; the actual content
2948 is checked by search_findtype_partial. */
2950 while (*s != 0 && *s != '{' && !isspace(*s))
2952 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
2956 while (isspace(*s)) s++;
2958 /* Now check for the individual search type and any partial or default
2959 options. Only those types that are actually in the binary are valid. */
2961 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
2965 expand_string_message = search_error_message;
2969 /* Check that a key was provided for those lookup types that need it,
2970 and was not supplied for those that use the query style. */
2972 if (!mac_islookup(stype, lookup_querystyle))
2976 expand_string_message = string_sprintf("missing {key} for single-"
2977 "key \"%s\" lookup", name);
2985 expand_string_message = string_sprintf("a single key was given for "
2986 "lookup type \"%s\", which is not a single-key lookup type", name);
2991 /* Get the next string in brackets and expand it. It is the file name for
2992 single-key+file lookups, and the whole query otherwise. */
2994 if (*s != '{') goto EXPAND_FAILED_CURLY;
2995 filename = expand_string_internal(s+1, TRUE, &s, skipping);
2996 if (filename == NULL) goto EXPAND_FAILED;
2997 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
2998 while (isspace(*s)) s++;
3000 /* If this isn't a single-key+file lookup, re-arrange the variables
3001 to be appropriate for the search_ functions. */
3009 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3010 the entry was not found. Note that there is no search_close() function.
3011 Files are left open in case of re-use. At suitable places in higher logic,
3012 search_tidyup() is called to tidy all open files. This can save opening
3013 the same file several times. However, files may also get closed when
3014 others are opened, if too many are open at once. The rule is that a
3015 handle should not be used after a second search_open().
3017 Request that a partial search sets up $1 and maybe $2 by passing
3018 expand_setup containing zero. If its value changes, reset expand_nmax,
3019 since new variables will have been set. Note that at the end of this
3020 "lookup" section, the old numeric variables are restored. */
3023 lookup_value = NULL;
3026 void *handle = search_open(filename, stype, 0, NULL, NULL);
3029 expand_string_message = search_error_message;
3032 lookup_value = search_find(handle, filename, key, partial, affix,
3033 affixlen, starflags, &expand_setup);
3034 if (search_find_defer)
3036 expand_string_message =
3037 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3038 search_error_message);
3041 if (expand_setup > 0) expand_nmax = expand_setup;
3044 /* The handling of "yes" and "no" result strings is now in a separate
3045 function that is also used by ${if} and ${extract}. */
3047 switch(process_yesno(
3048 skipping, /* were previously skipping */
3049 lookup_value != NULL, /* success/failure indicator */
3050 save_lookup_value, /* value to reset for string2 */
3051 &s, /* input pointer */
3052 &yield, /* output pointer */
3053 &size, /* output size */
3054 &ptr, /* output current point */
3055 US"lookup")) /* condition type */
3057 case 1: goto EXPAND_FAILED; /* when all is well, the */
3058 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3061 /* Restore external setting of expansion variables for carrying on
3062 at this level, and continue. */
3064 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3065 save_expand_nlength);
3069 /* If Perl support is configured, handle calling embedded perl subroutines,
3070 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3071 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3072 arguments (defined below). */
3074 #define EXIM_PERL_MAX_ARGS 8
3078 expand_string_message = US"\"${perl\" encountered, but this facility "
3079 "is not included in this binary";
3082 #else /* EXIM_PERL */
3084 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3087 if ((expand_forbid & RDO_PERL) != 0)
3089 expand_string_message = US"Perl calls are not permitted";
3093 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3096 case 1: goto EXPAND_FAILED_CURLY;
3098 case 3: goto EXPAND_FAILED;
3101 /* If skipping, we don't actually do anything */
3103 if (skipping) continue;
3105 /* Start the interpreter if necessary */
3107 if (!opt_perl_started)
3110 if (opt_perl_startup == NULL)
3112 expand_string_message = US"A setting of perl_startup is needed when "
3113 "using the Perl interpreter";
3116 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3117 initerror = init_perl(opt_perl_startup);
3118 if (initerror != NULL)
3120 expand_string_message =
3121 string_sprintf("error in perl_startup code: %s\n", initerror);
3124 opt_perl_started = TRUE;
3127 /* Call the function */
3129 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3130 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3131 sub_arg[0], sub_arg + 1);
3133 /* NULL yield indicates failure; if the message pointer has been set to
3134 NULL, the yield was undef, indicating a forced failure. Otherwise the
3135 message will indicate some kind of Perl error. */
3137 if (new_yield == NULL)
3139 if (expand_string_message == NULL)
3141 expand_string_message =
3142 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3143 "failure", sub_arg[0]);
3144 expand_string_forcedfail = TRUE;
3149 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3150 set during a callback from Perl. */
3152 expand_string_forcedfail = FALSE;
3156 #endif /* EXIM_PERL */
3158 /* Handle "readfile" to insert an entire file */
3160 case EITEM_READFILE:
3165 if ((expand_forbid & RDO_READFILE) != 0)
3167 expand_string_message = US"file insertions are not permitted";
3171 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3173 case 1: goto EXPAND_FAILED_CURLY;
3175 case 3: goto EXPAND_FAILED;
3178 /* If skipping, we don't actually do anything */
3180 if (skipping) continue;
3182 /* Open the file and read it */
3184 f = Ufopen(sub_arg[0], "rb");
3187 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3191 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3196 /* Handle "readsocket" to insert data from a Unix domain socket */
3198 case EITEM_READSOCK:
3204 struct sockaddr_un sockun; /* don't call this "sun" ! */
3208 if ((expand_forbid & RDO_READSOCK) != 0)
3210 expand_string_message = US"socket insertions are not permitted";
3214 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3215 because there may be a string for expansion on failure. */
3217 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3219 case 1: goto EXPAND_FAILED_CURLY;
3220 case 2: /* Won't occur: no end check */
3221 case 3: goto EXPAND_FAILED;
3224 /* Sort out timeout, if given */
3226 if (sub_arg[2] != NULL)
3228 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3231 expand_string_message = string_sprintf("bad time value %s",
3236 else sub_arg[3] = NULL; /* No eol if no timeout */
3238 /* If skipping, we don't actually do anything */
3242 /* Make a connection to the socket */
3244 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3246 expand_string_message = string_sprintf("failed to create socket: %s",
3251 sockun.sun_family = AF_UNIX;
3252 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3254 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3256 expand_string_message = string_sprintf("failed to connect to socket "
3257 "%s: %s", sub_arg[0], strerror(errno));
3260 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3262 /* Write the request string, if not empty */
3264 if (sub_arg[1][0] != 0)
3266 int len = Ustrlen(sub_arg[1]);
3267 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3269 if (write(fd, sub_arg[1], len) != len)
3271 expand_string_message = string_sprintf("request write to socket "
3272 "failed: %s", strerror(errno));
3277 /* Now we need to read from the socket, under a timeout. The function
3278 that reads a file can be used. */
3280 f = fdopen(fd, "rb");
3281 sigalrm_seen = FALSE;
3283 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3287 /* After a timeout, we restore the pointer in the result, that is,
3288 make sure we add nothing from the socket. */
3293 expand_string_message = US"socket read timed out";
3298 /* The whole thing has worked (or we were skipping). If there is a
3299 failure string following, we need to skip it. */
3303 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3305 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3306 while (isspace(*s)) s++;
3308 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3311 /* Come here on failure to create socket, connect socket, write to the
3312 socket, or timeout on reading. If another substring follows, expand and
3313 use it. Otherwise, those conditions give expand errors. */
3316 if (*s != '{') goto EXPAND_FAILED;
3317 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3318 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3319 if (arg == NULL) goto EXPAND_FAILED;
3320 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3321 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3322 while (isspace(*s)) s++;
3323 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3327 /* Handle "run" to execute a program. */
3332 uschar *old_lookup_value = NULL;
3340 if ((expand_forbid & RDO_RUN) != 0)
3342 expand_string_message = US"running a command is not permitted";
3346 while (isspace(*s)) s++;
3347 if (*s != '{') goto EXPAND_FAILED_CURLY;
3348 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3349 if (arg == NULL) goto EXPAND_FAILED;
3350 while (isspace(*s)) s++;
3351 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3353 if (skipping) /* Just pretend it worked when we're skipping */
3359 if (!transport_set_up_command(&argv, /* anchor for arg list */
3360 arg, /* raw command */
3361 FALSE, /* don't expand the arguments */
3362 0, /* not relevant when... */
3363 NULL, /* no transporting address */
3364 US"${run} expansion", /* for error messages */
3365 &expand_string_message)) /* where to put error message */
3370 /* Create the child process, making it a group leader. */
3372 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3376 expand_string_message =
3377 string_sprintf("couldn't create child process: %s", strerror(errno));
3381 /* Nothing is written to the standard input. */
3385 /* Wait for the process to finish, applying the timeout, and inspect its
3386 return code for serious disasters. Simple non-zero returns are passed on.
3389 if ((runrc = child_close(pid, 60)) < 0)
3393 expand_string_message = string_sprintf("command timed out");
3394 killpg(pid, SIGKILL); /* Kill the whole process group */
3397 else if (runrc == -257)
3398 expand_string_message = string_sprintf("wait() failed: %s",
3402 expand_string_message = string_sprintf("command killed by signal %d",
3408 /* Read the pipe to get the command's output into $value (which is kept
3409 in lookup_value). */
3411 f = fdopen(fd_out, "rb");
3412 old_lookup_value = lookup_value;
3413 lookup_value = NULL;
3414 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3418 /* Process the yes/no strings */
3420 switch(process_yesno(
3421 skipping, /* were previously skipping */
3422 runrc == 0, /* success/failure indicator */
3423 old_lookup_value, /* value to reset for string2 */
3424 &s, /* input pointer */
3425 &yield, /* output pointer */
3426 &size, /* output size */
3427 &ptr, /* output current point */
3428 US"run")) /* condition type */
3430 case 1: goto EXPAND_FAILED; /* when all is well, the */
3431 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3437 /* Handle character translation for "tr" */
3445 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3447 case 1: goto EXPAND_FAILED_CURLY;
3449 case 3: goto EXPAND_FAILED;
3452 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3453 o2m = Ustrlen(sub[2]) - 1;
3455 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3457 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3461 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3468 /* Handle "hash", "length", "nhash", and "substr" when they are given with
3469 expanded arguments. */
3479 int val[2] = { 0, -1 };
3482 /* "length" takes only 2 arguments whereas the others take 2 or 3.
3483 Ensure that sub[2] is set in the ${length case. */
3486 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
3489 case 1: goto EXPAND_FAILED_CURLY;
3491 case 3: goto EXPAND_FAILED;
3494 /* Juggle the arguments if there are only two of them: always move the
3495 string to the last position and make ${length{n}{str}} equivalent to
3496 ${substr{0}{n}{str}}. See the defaults for val[] above. */
3502 if (item_type == EITEM_LENGTH)
3509 for (i = 0; i < 2; i++)
3511 if (sub[i] == NULL) continue;
3512 val[i] = (int)Ustrtol(sub[i], &ret, 10);
3513 if (*ret != 0 || (i != 0 && val[i] < 0))
3515 expand_string_message = string_sprintf("\"%s\" is not a%s number "
3516 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
3522 (item_type == EITEM_HASH)?
3523 compute_hash(sub[2], val[0], val[1], &len) :
3524 (item_type == EITEM_NHASH)?
3525 compute_nhash(sub[2], val[0], val[1], &len) :
3526 extract_substr(sub[2], val[0], val[1], &len);
3528 if (ret == NULL) goto EXPAND_FAILED;
3529 yield = string_cat(yield, &size, &ptr, ret, len);
3533 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
3534 This code originally contributed by Steve Haslam. It currently supports
3535 the use of MD5 and SHA-1 hashes.
3537 We need some workspace that is large enough to handle all the supported
3538 hash types. Use macros to set the sizes rather than be too elaborate. */
3540 #define MAX_HASHLEN 20
3541 #define MAX_HASHBLOCKLEN 64
3550 int hashlen; /* Number of octets for the hash algorithm's output */
3551 int hashblocklen; /* Number of octets the hash algorithm processes */
3553 unsigned int keylen;
3555 uschar keyhash[MAX_HASHLEN];
3556 uschar innerhash[MAX_HASHLEN];
3557 uschar finalhash[MAX_HASHLEN];
3558 uschar finalhash_hex[2*MAX_HASHLEN];
3559 uschar innerkey[MAX_HASHBLOCKLEN];
3560 uschar outerkey[MAX_HASHBLOCKLEN];
3562 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
3564 case 1: goto EXPAND_FAILED_CURLY;
3566 case 3: goto EXPAND_FAILED;
3569 if (Ustrcmp(sub[0], "md5") == 0)
3572 use_base = &md5_base;
3576 else if (Ustrcmp(sub[0], "sha1") == 0)
3579 use_base = &sha1_base;
3585 expand_string_message =
3586 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
3591 keylen = Ustrlen(keyptr);
3593 /* If the key is longer than the hash block length, then hash the key
3596 if (keylen > hashblocklen)
3598 chash_start(type, use_base);
3599 chash_end(type, use_base, keyptr, keylen, keyhash);
3604 /* Now make the inner and outer key values */
3606 memset(innerkey, 0x36, hashblocklen);
3607 memset(outerkey, 0x5c, hashblocklen);
3609 for (i = 0; i < keylen; i++)
3611 innerkey[i] ^= keyptr[i];
3612 outerkey[i] ^= keyptr[i];
3615 /* Now do the hashes */
3617 chash_start(type, use_base);
3618 chash_mid(type, use_base, innerkey);
3619 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
3621 chash_start(type, use_base);
3622 chash_mid(type, use_base, outerkey);
3623 chash_end(type, use_base, innerhash, hashlen, finalhash);
3625 /* Encode the final hash as a hex string */
3628 for (i = 0; i < hashlen; i++)
3630 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3631 *p++ = hex_digits[finalhash[i] & 0x0f];
3634 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
3635 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
3637 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
3642 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
3643 We have to save the numerical variables and restore them afterwards. */
3648 int moffset, moffsetextra, slen;
3651 const uschar *rerror;
3654 int save_expand_nmax =
3655 save_expand_strings(save_expand_nstring, save_expand_nlength);
3657 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
3659 case 1: goto EXPAND_FAILED_CURLY;
3661 case 3: goto EXPAND_FAILED;
3664 /* Compile the regular expression */
3666 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
3671 expand_string_message = string_sprintf("regular expression error in "
3672 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
3676 /* Now run a loop to do the substitutions as often as necessary. It ends
3677 when there are no more matches. Take care over matches of the null string;
3678 do the same thing as Perl does. */
3681 slen = Ustrlen(sub[0]);
3682 moffset = moffsetextra = 0;
3687 int ovector[3*(EXPAND_MAXN+1)];
3688 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
3689 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
3693 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
3694 is not necessarily the end. We want to repeat the match from one
3695 character further along, but leaving the basic offset the same (for
3696 copying below). We can't be at the end of the string - that was checked
3697 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
3698 finished; copy the remaining string and end the loop. */
3708 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
3712 /* Match - set up for expanding the replacement. */
3714 if (n == 0) n = EXPAND_MAXN + 1;
3716 for (nn = 0; nn < n*2; nn += 2)
3718 expand_nstring[expand_nmax] = subject + ovector[nn];
3719 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
3723 /* Copy the characters before the match, plus the expanded insertion. */
3725 yield = string_cat(yield, &size, &ptr, subject + moffset,
3726 ovector[0] - moffset);
3727 insert = expand_string(sub[2]);
3728 if (insert == NULL) goto EXPAND_FAILED;
3729 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
3731 moffset = ovector[1];
3735 /* If we have matched an empty string, first check to see if we are at
3736 the end of the subject. If so, the loop is over. Otherwise, mimic
3737 what Perl's /g options does. This turns out to be rather cunning. First
3738 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
3739 string at the same point. If this fails (picked up above) we advance to
3740 the next character. */
3742 if (ovector[0] == ovector[1])
3744 if (ovector[0] == slen) break;
3745 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
3749 /* All done - restore numerical variables. */
3751 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3752 save_expand_nlength);
3756 /* Handle keyed and numbered substring extraction. If the first argument
3757 consists entirely of digits, then a numerical extraction is assumed. */
3763 int field_number = 1;
3764 BOOL field_number_set = FALSE;
3765 uschar *save_lookup_value = lookup_value;
3767 int save_expand_nmax =
3768 save_expand_strings(save_expand_nstring, save_expand_nlength);
3770 /* Read the arguments */
3772 for (i = 0; i < j; i++)
3774 while (isspace(*s)) s++;
3777 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
3778 if (sub[i] == NULL) goto EXPAND_FAILED;
3779 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3781 /* After removal of leading and trailing white space, the first
3782 argument must not be empty; if it consists entirely of digits
3783 (optionally preceded by a minus sign), this is a numerical
3784 extraction, and we expect 3 arguments. */
3792 while (isspace(*p)) p++;
3796 while (len > 0 && isspace(p[len-1])) len--;
3801 expand_string_message = US"first argument of \"expand\" must not "
3811 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
3815 j = 3; /* Need 3 args */
3816 field_number_set = TRUE;
3820 else goto EXPAND_FAILED_CURLY;
3823 /* Extract either the numbered or the keyed substring into $value. If
3824 skipping, just pretend the extraction failed. */
3826 lookup_value = skipping? NULL : field_number_set?
3827 expand_gettokened(field_number, sub[1], sub[2]) :
3828 expand_getkeyed(sub[0], sub[1]);
3830 /* If no string follows, $value gets substituted; otherwise there can
3831 be yes/no strings, as for lookup or if. */
3833 switch(process_yesno(
3834 skipping, /* were previously skipping */
3835 lookup_value != NULL, /* success/failure indicator */
3836 save_lookup_value, /* value to reset for string2 */
3837 &s, /* input pointer */
3838 &yield, /* output pointer */
3839 &size, /* output size */
3840 &ptr, /* output current point */
3841 US"extract")) /* condition type */
3843 case 1: goto EXPAND_FAILED; /* when all is well, the */
3844 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3847 /* All done - restore numerical variables. */
3849 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3850 save_expand_nlength);
3856 /* If ${dlfunc support is configured, handle calling dynamically-loaded
3857 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
3858 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
3859 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
3861 #define EXPAND_DLFUNC_MAX_ARGS 8
3864 #ifndef EXPAND_DLFUNC
3865 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
3866 "is not included in this binary";
3869 #else /* EXPAND_DLFUNC */
3872 exim_dlfunc_t *func;
3875 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
3877 if ((expand_forbid & RDO_DLFUNC) != 0)
3879 expand_string_message =
3880 US"dynamically-loaded functions are not permitted";
3884 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
3887 case 1: goto EXPAND_FAILED_CURLY;
3889 case 3: goto EXPAND_FAILED;
3892 /* If skipping, we don't actually do anything */
3894 if (skipping) continue;
3896 /* Look up the dynamically loaded object handle in the tree. If it isn't
3897 found, dlopen() the file and put the handle in the tree for next time. */
3899 t = tree_search(dlobj_anchor, argv[0]);
3902 void *handle = dlopen(CS argv[0], RTLD_LAZY);
3905 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
3906 argv[0], dlerror());
3907 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
3910 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
3911 Ustrcpy(t->name, argv[0]);
3912 t->data.ptr = handle;
3913 (void)tree_insertnode(&dlobj_anchor, t);
3916 /* Having obtained the dynamically loaded object handle, look up the
3917 function pointer. */
3919 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
3922 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
3923 "%s", argv[1], argv[0], dlerror());
3924 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
3928 /* Call the function and work out what to do with the result. If it
3929 returns OK, we have a replacement string; if it returns DEFER then
3930 expansion has failed in a non-forced manner; if it returns FAIL then
3931 failure was forced; if it returns ERROR or any other value there's a
3932 problem, so panic slightly. */
3935 for (argc = 0; argv[argc] != NULL; argc++);
3936 status = func(&result, argc - 2, &argv[2]);
3939 if (result == NULL) result = US"";
3940 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
3945 expand_string_message = result == NULL ? US"(no message)" : result;
3946 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
3947 else if(status != FAIL)
3948 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
3949 argv[0], argv[1], status, expand_string_message);
3953 #endif /* EXPAND_DLFUNC */
3956 /* Control reaches here if the name is not recognized as one of the more
3957 complicated expansion items. Check for the "operator" syntax (name terminated
3958 by a colon). Some of the operators have arguments, separated by _ from the
3965 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
3966 if (sub == NULL) goto EXPAND_FAILED;
3969 /* Owing to an historical mis-design, an underscore may be part of the
3970 operator name, or it may introduce arguments. We therefore first scan the
3971 table of names that contain underscores. If there is no match, we cut off
3972 the arguments and then scan the main table. */
3974 c = chop_match(name, op_table_underscore,
3975 sizeof(op_table_underscore)/sizeof(uschar *));
3979 arg = Ustrchr(name, '_');
3980 if (arg != NULL) *arg = 0;
3981 c = chop_match(name, op_table_main,
3982 sizeof(op_table_main)/sizeof(uschar *));
3983 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
3984 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
3987 /* If we are skipping, we don't need to perform the operation at all.
3988 This matters for operations like "mask", because the data may not be
3989 in the correct format when skipping. For example, the expression may test
3990 for the existence of $sender_host_address before trying to mask it. For
3991 other operations, doing them may not fail, but it is a waste of time. */
3993 if (skipping && c >= 0) continue;
3995 /* Otherwise, switch on the operator type */
4002 unsigned long int n = Ustrtoul(sub, &t, 10);
4005 expand_string_message = string_sprintf("argument for base62 "
4006 "operator is \"%s\", which is not a decimal number", sub);
4009 t = string_base62(n);
4010 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4018 unsigned long int n = 0;
4021 uschar *t = Ustrchr(base62_chars, *tt++);
4024 expand_string_message = string_sprintf("argument for base62d "
4025 "operator is \"%s\", which is not a base 62 number", sub);
4028 n = n * 62 + (t - base62_chars);
4030 (void)sprintf(CS buf, "%ld", n);
4031 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4037 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4038 if (expanded == NULL)
4040 expand_string_message =
4041 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4042 expand_string_message);
4045 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4052 uschar *t = sub - 1;
4053 while (*(++t) != 0) { *t = tolower(*t); count++; }
4054 yield = string_cat(yield, &size, &ptr, sub, count);
4061 uschar *t = sub - 1;
4062 while (*(++t) != 0) { *t = toupper(*t); count++; }
4063 yield = string_cat(yield, &size, &ptr, sub, count);
4074 md5_end(&base, sub, Ustrlen(sub), digest);
4075 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4076 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4087 sha1_end(&base, sub, Ustrlen(sub), digest);
4088 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4089 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4093 /* Convert hex encoding to base64 encoding */
4103 for (enc = sub; *enc != 0; enc++)
4105 if (!isxdigit(*enc))
4107 expand_string_message = string_sprintf("\"%s\" is not a hex "
4116 expand_string_message = string_sprintf("\"%s\" contains an odd "
4117 "number of characters", sub);
4121 while ((c = *in++) != 0)
4123 if (isdigit(c)) c -= '0';
4124 else c = toupper(c) - 'A' + 10;
4136 enc = auth_b64encode(sub, out - sub);
4137 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4141 /* mask applies a mask to an IP address; for example the result of
4142 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4149 int mask, maskoffset;
4150 int type = string_is_ip_address(sub, &maskoffset);
4155 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4160 if (maskoffset == 0)
4162 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4167 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4169 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4171 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4176 /* Convert the address to binary integer(s) and apply the mask */
4178 sub[maskoffset] = 0;
4179 count = host_aton(sub, binary);
4180 host_mask(count, binary, mask);
4182 /* Convert to masked textual format and add to output. */
4184 yield = string_cat(yield, &size, &ptr, buffer,
4185 host_nmtoa(count, binary, mask, buffer, '.'));
4190 case EOP_LOCAL_PART:
4194 int start, end, domain;
4195 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4199 if (c != EOP_DOMAIN)
4201 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4202 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4204 else if (domain != 0)
4207 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4213 /* quote puts a string in quotes if it is empty or contains anything
4214 other than alphamerics, underscore, dot, or hyphen.
4216 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4217 be quoted in order to be a valid local part.
4219 In both cases, newlines and carriage returns are converted into \n and \r
4223 case EOP_QUOTE_LOCAL_PART:
4226 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4227 uschar *t = sub - 1;
4231 while (!needs_quote && *(++t) != 0)
4232 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4234 else /* EOP_QUOTE_LOCAL_PART */
4236 while (!needs_quote && *(++t) != 0)
4237 needs_quote = !isalnum(*t) &&
4238 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4239 (*t != '.' || t == sub || t[1] == 0);
4244 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4249 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4250 else if (*t == '\r')
4251 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4254 if (*t == '\\' || *t == '"')
4255 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4256 yield = string_cat(yield, &size, &ptr, t, 1);
4259 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4261 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4265 /* quote_lookuptype does lookup-specific quoting */
4270 uschar *opt = Ustrchr(arg, '_');
4272 if (opt != NULL) *opt++ = 0;
4274 n = search_findtype(arg, Ustrlen(arg));
4277 expand_string_message = search_error_message;
4281 if (lookup_list[n].quote != NULL)
4282 sub = (lookup_list[n].quote)(sub, opt);
4283 else if (opt != NULL) sub = NULL;
4287 expand_string_message = string_sprintf(
4288 "\"%s\" unrecognized after \"${quote_%s\"",
4293 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4297 /* rx quote sticks in \ before any non-alphameric character so that
4298 the insertion works in a regular expression. */
4302 uschar *t = sub - 1;
4306 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4307 yield = string_cat(yield, &size, &ptr, t, 1);
4312 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4313 prescribed by the RFC, if there are characters that need to be encoded */
4317 uschar buffer[2048];
4318 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4319 buffer, sizeof(buffer));
4320 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4324 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4334 if (c > 255) c = '_';
4336 yield = string_cat(yield, &size, &ptr, buff, 1);
4341 /* escape turns all non-printing characters into escape sequences. */
4345 uschar *t = string_printing(sub);
4346 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4350 /* Handle numeric expression evaluation */
4355 uschar *save_sub = sub;
4356 uschar *error = NULL;
4357 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4360 expand_string_message = string_sprintf("error in expression "
4361 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4365 sprintf(CS var_buffer, "%d", n);
4366 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4370 /* Handle time period formating */
4372 case EOP_TIME_INTERVAL:
4375 uschar *t = read_number(&n, sub);
4376 if (*t != 0) /* Not A Number*/
4378 expand_string_message = string_sprintf("string \"%s\" is not a "
4379 "positive number in \"%s\" operator", sub, name);
4382 t = readconf_printtime(n);
4383 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4387 /* Convert string to base64 encoding */
4391 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4392 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4396 /* strlen returns the length of the string */
4401 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4402 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4406 /* length_n or l_n takes just the first n characters or the whole string,
4407 whichever is the shorter;
4409 substr_m_n, and s_m_n take n characters from offset m; negative m take
4410 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4411 takes the rest, either to the right or to the left.
4413 hash_n or h_n makes a hash of length n from the string, yielding n
4414 characters from the set a-z; hash_n_m makes a hash of length n, but
4415 uses m characters from the set a-zA-Z0-9.
4417 nhash_n returns a single number between 0 and n-1 (in text form), while
4418 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4419 between 0 and n-1 and the second between 0 and m-1. */
4439 expand_string_message = string_sprintf("missing values after %s",
4444 /* "length" has only one argument, effectively being synonymous with
4447 if (c == EOP_LENGTH || c == EOP_L)
4453 /* The others have one or two arguments; for "substr" the first may be
4454 negative. The second being negative means "not supplied". */
4459 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
4462 /* Read up to two numbers, separated by underscores */
4467 if (arg != ret && *arg == '_' && pn == &value1)
4471 if (arg[1] != 0) arg++;
4473 else if (!isdigit(*arg))
4475 expand_string_message =
4476 string_sprintf("non-digit after underscore in \"%s\"", name);
4479 else *pn = (*pn)*10 + *arg++ - '0';
4483 /* Perform the required operation */
4486 (c == EOP_HASH || c == EOP_H)?
4487 compute_hash(sub, value1, value2, &len) :
4488 (c == EOP_NHASH || c == EOP_NH)?
4489 compute_nhash(sub, value1, value2, &len) :
4490 extract_substr(sub, value1, value2, &len);
4492 if (ret == NULL) goto EXPAND_FAILED;
4493 yield = string_cat(yield, &size, &ptr, ret, len);
4503 uschar **modetable[3];
4508 if (stat(CS sub, &st) < 0)
4510 expand_string_message = string_sprintf("stat(%s) failed: %s",
4511 sub, strerror(errno));
4515 switch (mode & S_IFMT)
4517 case S_IFIFO: smode[0] = 'p'; break;
4518 case S_IFCHR: smode[0] = 'c'; break;
4519 case S_IFDIR: smode[0] = 'd'; break;
4520 case S_IFBLK: smode[0] = 'b'; break;
4521 case S_IFREG: smode[0] = '-'; break;
4522 default: smode[0] = '?'; break;
4525 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
4526 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
4527 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
4529 for (i = 0; i < 3; i++)
4531 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
4536 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
4537 "uid=%ld gid=%ld size=%ld atime=%ld mtime=%ld ctime=%ld",
4538 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
4539 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
4540 (long)st.st_gid, (long)st.st_size, (long)st.st_atime,
4541 (long)st.st_mtime, (long)st.st_ctime);
4542 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
4546 /* Unknown operator */
4549 expand_string_message =
4550 string_sprintf("unknown expansion operator \"%s\"", name);
4555 /* Handle a plain name. If this is the first thing in the expansion, release
4556 the pre-allocated buffer. If the result data is known to be in a new buffer,
4557 newsize will be set to the size of that buffer, and we can just point at that
4558 store instead of copying. Many expansion strings contain just one reference,
4559 so this is a useful optimization, especially for humungous headers
4560 ($message_headers). */
4572 value = find_variable(name, FALSE, skipping, &newsize);
4575 expand_string_message =
4576 string_sprintf("unknown variable in \"${%s}\"", name);
4579 len = Ustrlen(value);
4580 if (yield == NULL && newsize != 0)
4586 else yield = string_cat(yield, &size, &ptr, value, len);
4590 /* Else there's something wrong */
4592 expand_string_message =
4593 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
4594 "in a variable reference)", name);
4598 /* If we hit the end of the string when ket_ends is set, there is a missing
4599 terminating brace. */
4601 if (ket_ends && *s == 0)
4603 expand_string_message = malformed_header?
4604 US"missing } at end of string - could be header name not terminated by colon"
4606 US"missing } at end of string";
4610 /* Expansion succeeded; yield may still be NULL here if nothing was actually
4611 added to the string. If so, set up an empty string. Add a terminating zero. If
4612 left != NULL, return a pointer to the terminator. */
4614 if (yield == NULL) yield = store_get(1);
4616 if (left != NULL) *left = s;
4618 /* Any stacking store that was used above the final string is no longer needed.
4619 In many cases the final string will be the first one that was got and so there
4620 will be optimal store usage. */
4622 store_reset(yield + ptr + 1);
4625 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
4627 if (skipping) debug_printf("skipping: result is not used\n");
4631 /* This is the failure exit: easiest to program with a goto. We still need
4632 to update the pointer to the terminator, for cases of nested calls with "fail".
4635 EXPAND_FAILED_CURLY:
4636 expand_string_message = malformed_header?
4637 US"missing or misplaced { or } - could be header name not terminated by colon"
4639 US"missing or misplaced { or }";
4641 /* At one point, Exim reset the store to yield (if yield was not NULL), but
4642 that is a bad idea, because expand_string_message is in dynamic store. */
4645 if (left != NULL) *left = s;
4648 debug_printf("failed to expand: %s\n", string);
4649 debug_printf(" error message: %s\n", expand_string_message);
4650 if (expand_string_forcedfail) debug_printf("failure was forced\n");
4656 /* This is the external function call. Do a quick check for any expansion
4657 metacharacters, and if there are none, just return the input string.
4659 Argument: the string to be expanded
4660 Returns: the expanded string, or NULL if expansion failed; if failure was
4661 due to a lookup deferring, search_find_defer will be TRUE
4665 expand_string(uschar *string)
4667 search_find_defer = FALSE;
4668 malformed_header = FALSE;
4669 return (Ustrpbrk(string, "$\\") == NULL)? string :
4670 expand_string_internal(string, FALSE, NULL, FALSE);
4675 /*************************************************
4677 *************************************************/
4679 /* Now and again we want to expand a string and be sure that the result is in a
4680 new bit of store. This function does that.
4682 Argument: the string to be expanded
4683 Returns: the expanded string, always in a new bit of store, or NULL
4687 expand_string_copy(uschar *string)
4689 uschar *yield = expand_string(string);
4690 if (yield == string) yield = string_copy(string);
4696 /*************************************************
4697 * Expand and interpret as an integer *
4698 *************************************************/
4700 /* Expand a string, and convert the result into an integer.
4702 Argument: the string to be expanded
4704 Returns: the integer value, or
4705 -1 for an expansion error ) in both cases, message in
4706 -2 for an integer interpretation error ) expand_string_message
4711 expand_string_integer(uschar *string)
4714 uschar *s = expand_string(string);
4715 uschar *msg = US"invalid integer \"%s\"";
4718 if (s == NULL) return -1;
4720 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
4721 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
4722 systems, so we set it zero ourselves. */
4725 value = strtol(CS s, CSS &endptr, 0);
4729 msg = US"integer expected but \"%s\" found";
4733 /* Ensure we can cast this down to an int */
4734 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
4736 if (errno != ERANGE)
4738 if (tolower(*endptr) == 'k')
4740 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
4744 else if (tolower(*endptr) == 'm')
4746 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
4748 else value *= 1024*1024;
4752 if (errno == ERANGE)
4753 msg = US"absolute value of integer \"%s\" is too large (overflow)";
4756 while (isspace(*endptr)) endptr++;
4757 if (*endptr == 0) return (int)value;
4761 expand_string_message = string_sprintf(CS msg, s);
4767 /*************************************************
4768 **************************************************
4769 * Stand-alone test program *
4770 **************************************************
4771 *************************************************/
4777 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
4779 int ovector[3*(EXPAND_MAXN+1)];
4780 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
4781 ovector, sizeof(ovector)/sizeof(int));
4782 BOOL yield = n >= 0;
4783 if (n == 0) n = EXPAND_MAXN + 1;
4787 expand_nmax = (setup < 0)? 0 : setup + 1;
4788 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
4790 expand_nstring[expand_nmax] = subject + ovector[nn];
4791 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4799 int main(int argc, uschar **argv)
4802 uschar buffer[1024];
4804 debug_selector = D_v;
4805 debug_file = stderr;
4806 debug_fd = fileno(debug_file);
4807 big_buffer = malloc(big_buffer_size);
4809 for (i = 1; i < argc; i++)
4811 if (argv[i][0] == '+')
4813 debug_trace_memory = 2;
4816 if (isdigit(argv[i][0]))
4817 debug_selector = Ustrtol(argv[i], NULL, 0);
4819 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
4823 eldap_default_servers = argv[i];
4826 mysql_servers = argv[i];
4829 pgsql_servers = argv[i];
4833 else opt_perl_startup = argv[i];
4837 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
4839 expand_nstring[1] = US"string 1....";
4840 expand_nlength[1] = 8;
4844 if (opt_perl_startup != NULL)
4847 printf("Starting Perl interpreter\n");
4848 errstr = init_perl(opt_perl_startup);
4851 printf("** error in perl_startup code: %s\n", errstr);
4852 return EXIT_FAILURE;
4855 #endif /* EXIM_PERL */
4857 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
4859 void *reset_point = store_get(0);
4860 uschar *yield = expand_string(buffer);
4863 printf("%s\n", yield);
4864 store_reset(reset_point);
4868 if (search_find_defer) printf("search_find deferred\n");
4869 printf("Failed: %s\n", expand_string_message);
4870 if (expand_string_forcedfail) printf("Forced failure\n");
4882 /* End of expand.c */