1 /* $Cambridge: exim/src/src/expand.c,v 1.17 2005/03/22 14:11:54 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 { "recipient_data", vtype_stringptr, &recipient_data },
443 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
444 { "recipients", vtype_recipients, NULL },
445 { "recipients_count", vtype_int, &recipients_count },
446 #ifdef WITH_CONTENT_SCAN
447 { "regex_match_string", vtype_stringptr, ®ex_match_string },
449 { "reply_address", vtype_reply, NULL },
450 { "return_path", vtype_stringptr, &return_path },
451 { "return_size_limit", vtype_int, &bounce_return_size_limit },
452 { "runrc", vtype_int, &runrc },
453 { "self_hostname", vtype_stringptr, &self_hostname },
454 { "sender_address", vtype_stringptr, &sender_address },
455 { "sender_address_data", vtype_stringptr, &sender_address_data },
456 { "sender_address_domain", vtype_domain, &sender_address },
457 { "sender_address_local_part", vtype_localpart, &sender_address },
458 { "sender_data", vtype_stringptr, &sender_data },
459 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
460 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
461 { "sender_host_address", vtype_stringptr, &sender_host_address },
462 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
463 { "sender_host_name", vtype_host_lookup, NULL },
464 { "sender_host_port", vtype_int, &sender_host_port },
465 { "sender_ident", vtype_stringptr, &sender_ident },
466 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
467 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
468 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
469 { "smtp_command_argument", vtype_stringptr, &smtp_command_argument },
470 { "sn0", vtype_filter_int, &filter_sn[0] },
471 { "sn1", vtype_filter_int, &filter_sn[1] },
472 { "sn2", vtype_filter_int, &filter_sn[2] },
473 { "sn3", vtype_filter_int, &filter_sn[3] },
474 { "sn4", vtype_filter_int, &filter_sn[4] },
475 { "sn5", vtype_filter_int, &filter_sn[5] },
476 { "sn6", vtype_filter_int, &filter_sn[6] },
477 { "sn7", vtype_filter_int, &filter_sn[7] },
478 { "sn8", vtype_filter_int, &filter_sn[8] },
479 { "sn9", vtype_filter_int, &filter_sn[9] },
480 #ifdef WITH_CONTENT_SCAN
481 { "spam_bar", vtype_stringptr, &spam_bar },
482 { "spam_report", vtype_stringptr, &spam_report },
483 { "spam_score", vtype_stringptr, &spam_score },
484 { "spam_score_int", vtype_stringptr, &spam_score_int },
486 #ifdef EXPERIMENTAL_SPF
487 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
488 { "spf_received", vtype_stringptr, &spf_received },
489 { "spf_result", vtype_stringptr, &spf_result },
490 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
492 { "spool_directory", vtype_stringptr, &spool_directory },
493 { "spool_inodes", vtype_pinodes, (void *)TRUE },
494 { "spool_space", vtype_pspace, (void *)TRUE },
495 #ifdef EXPERIMENTAL_SRS
496 { "srs_db_address", vtype_stringptr, &srs_db_address },
497 { "srs_db_key", vtype_stringptr, &srs_db_key },
498 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
499 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
500 { "srs_recipient", vtype_stringptr, &srs_recipient },
501 { "srs_status", vtype_stringptr, &srs_status },
503 { "thisaddress", vtype_stringptr, &filter_thisaddress },
504 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
505 { "tls_cipher", vtype_stringptr, &tls_cipher },
506 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
507 { "tod_bsdinbox", vtype_todbsdin, NULL },
508 { "tod_epoch", vtype_tode, NULL },
509 { "tod_full", vtype_todf, NULL },
510 { "tod_log", vtype_todl, NULL },
511 { "tod_logfile", vtype_todlf, NULL },
512 { "tod_zone", vtype_todzone, NULL },
513 { "tod_zulu", vtype_todzulu, NULL },
514 { "value", vtype_stringptr, &lookup_value },
515 { "version_number", vtype_stringptr, &version_string },
516 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
517 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
518 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
519 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
520 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
521 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
524 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
525 static uschar var_buffer[256];
526 static BOOL malformed_header;
528 /* For textual hashes */
530 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
531 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
534 enum { HMAC_MD5, HMAC_SHA1 };
536 /* For numeric hashes */
538 static unsigned int prime[] = {
539 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
540 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
541 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
543 /* For printing modes in symbolic form */
545 static uschar *mtable_normal[] =
546 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
548 static uschar *mtable_setid[] =
549 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
551 static uschar *mtable_sticky[] =
552 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
556 /*************************************************
557 * Tables for UTF-8 support *
558 *************************************************/
560 /* Table of the number of extra characters, indexed by the first character
561 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
564 static uschar utf8_table1[] = {
565 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
566 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
567 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
568 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
570 /* These are the masks for the data bits in the first byte of a character,
571 indexed by the number of additional bytes. */
573 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
575 /* Get the next UTF-8 character, advancing the pointer. */
577 #define GETUTF8INC(c, ptr) \
579 if ((c & 0xc0) == 0xc0) \
581 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
583 c = (c & utf8_table2[a]) << s; \
587 c |= (*ptr++ & 0x3f) << s; \
592 /*************************************************
593 * Binary chop search on a table *
594 *************************************************/
596 /* This is used for matching expansion items and operators.
599 name the name that is being sought
600 table the table to search
601 table_size the number of items in the table
603 Returns: the offset in the table, or -1
607 chop_match(uschar *name, uschar **table, int table_size)
609 uschar **bot = table;
610 uschar **top = table + table_size;
614 uschar **mid = bot + (top - bot)/2;
615 int c = Ustrcmp(name, *mid);
616 if (c == 0) return mid - table;
617 if (c > 0) bot = mid + 1; else top = mid;
625 /*************************************************
626 * Check a condition string *
627 *************************************************/
629 /* This function is called to expand a string, and test the result for a "true"
630 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
631 forced fail or lookup defer. All store used by the function can be released on
635 condition the condition string
636 m1 text to be incorporated in panic error
639 Returns: TRUE if condition is met, FALSE if not
643 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
646 void *reset_point = store_get(0);
647 uschar *ss = expand_string(condition);
650 if (!expand_string_forcedfail && !search_find_defer)
651 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
652 "for %s %s: %s", condition, m1, m2, expand_string_message);
655 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
656 strcmpic(ss, US"false") != 0;
657 store_reset(reset_point);
663 /*************************************************
664 * Pick out a name from a string *
665 *************************************************/
667 /* If the name is too long, it is silently truncated.
670 name points to a buffer into which to put the name
671 max is the length of the buffer
672 s points to the first alphabetic character of the name
673 extras chars other than alphanumerics to permit
675 Returns: pointer to the first character after the name
677 Note: The test for *s != 0 in the while loop is necessary because
678 Ustrchr() yields non-NULL if the character is zero (which is not something
682 read_name(uschar *name, int max, uschar *s, uschar *extras)
685 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
687 if (ptr < max-1) name[ptr++] = *s;
696 /*************************************************
697 * Pick out the rest of a header name *
698 *************************************************/
700 /* A variable name starting $header_ (or just $h_ for those who like
701 abbreviations) might not be the complete header name because headers can
702 contain any printing characters in their names, except ':'. This function is
703 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
704 on the end, if the name was terminated by white space.
707 name points to a buffer in which the name read so far exists
708 max is the length of the buffer
709 s points to the first character after the name so far, i.e. the
710 first non-alphameric character after $header_xxxxx
712 Returns: a pointer to the first character after the header name
716 read_header_name(uschar *name, int max, uschar *s)
718 int prelen = Ustrchr(name, '_') - name + 1;
719 int ptr = Ustrlen(name) - prelen;
720 if (ptr > 0) memmove(name, name+prelen, ptr);
721 while (mac_isgraph(*s) && *s != ':')
723 if (ptr < max-1) name[ptr++] = *s;
734 /*************************************************
735 * Pick out a number from a string *
736 *************************************************/
739 n points to an integer into which to put the number
740 s points to the first digit of the number
742 Returns: a pointer to the character after the last digit
746 read_number(int *n, uschar *s)
749 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
755 /*************************************************
756 * Extract keyed subfield from a string *
757 *************************************************/
759 /* The yield is in dynamic store; NULL means that the key was not found.
762 key points to the name of the key
763 s points to the string from which to extract the subfield
765 Returns: NULL if the subfield was not found, or
766 a pointer to the subfield's data
770 expand_getkeyed(uschar *key, uschar *s)
772 int length = Ustrlen(key);
773 while (isspace(*s)) s++;
775 /* Loop to search for the key */
783 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
784 dkeylength = s - dkey;
785 while (isspace(*s)) s++;
786 if (*s == '=') while (isspace((*(++s))));
788 data = string_dequote(&s);
789 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
792 while (isspace(*s)) s++;
801 /*************************************************
802 * Extract numbered subfield from string *
803 *************************************************/
805 /* Extracts a numbered field from a string that is divided by tokens - for
806 example a line from /etc/passwd is divided by colon characters. First field is
807 numbered one. Negative arguments count from the right. Zero returns the whole
808 string. Returns NULL if there are insufficient tokens in the string
811 Modifies final argument - this is a dynamically generated string, so that's OK.
814 field number of field to be extracted,
815 first field = 1, whole string = 0, last field = -1
816 separators characters that are used to break string into tokens
817 s points to the string from which to extract the subfield
819 Returns: NULL if the field was not found,
820 a pointer to the field's data inside s (modified to add 0)
824 expand_gettokened (int field, uschar *separators, uschar *s)
829 uschar *fieldtext = NULL;
831 if (field == 0) return s;
833 /* Break the line up into fields in place; for field > 0 we stop when we have
834 done the number of fields we want. For field < 0 we continue till the end of
835 the string, counting the number of fields. */
837 count = (field > 0)? field : INT_MAX;
843 /* Previous field was the last one in the string. For a positive field
844 number, this means there are not enough fields. For a negative field number,
845 check that there are enough, and scan back to find the one that is wanted. */
849 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
850 if ((-field) == (INT_MAX - count - 1)) return s;
854 while (ss[-1] != 0) ss--;
860 /* Previous field was not last in the string; save its start and put a
864 len = Ustrcspn(ss, separators);
875 /*************************************************
876 * Extract a substring from a string *
877 *************************************************/
879 /* Perform the ${substr or ${length expansion operations.
882 subject the input string
883 value1 the offset from the start of the input string to the start of
884 the output string; if negative, count from the right.
885 value2 the length of the output string, or negative (-1) for unset
886 if value1 is positive, unset means "all after"
887 if value1 is negative, unset means "all before"
888 len set to the length of the returned string
890 Returns: pointer to the output string, or NULL if there is an error
894 extract_substr(uschar *subject, int value1, int value2, int *len)
896 int sublen = Ustrlen(subject);
898 if (value1 < 0) /* count from right */
902 /* If the position is before the start, skip to the start, and adjust the
903 length. If the length ends up negative, the substring is null because nothing
904 can precede. This falls out naturally when the length is unset, meaning "all
910 if (value2 < 0) value2 = 0;
914 /* Otherwise an unset length => characters before value1 */
923 /* For a non-negative offset, if the starting position is past the end of the
924 string, the result will be the null string. Otherwise, an unset length means
925 "rest"; just set it to the maximum - it will be cut down below if necessary. */
934 else if (value2 < 0) value2 = sublen;
937 /* Cut the length down to the maximum possible for the offset value, and get
938 the required characters. */
940 if (value1 + value2 > sublen) value2 = sublen - value1;
942 return subject + value1;
948 /*************************************************
949 * Old-style hash of a string *
950 *************************************************/
952 /* Perform the ${hash expansion operation.
955 subject the input string (an expanded substring)
956 value1 the length of the output string; if greater or equal to the
957 length of the input string, the input string is returned
958 value2 the number of hash characters to use, or 26 if negative
959 len set to the length of the returned string
961 Returns: pointer to the output string, or NULL if there is an error
965 compute_hash(uschar *subject, int value1, int value2, int *len)
967 int sublen = Ustrlen(subject);
969 if (value2 < 0) value2 = 26;
970 else if (value2 > Ustrlen(hashcodes))
972 expand_string_message =
973 string_sprintf("hash count \"%d\" too big", value2);
977 /* Calculate the hash text. We know it is shorter than the original string, so
978 can safely place it in subject[] (we know that subject is always itself an
979 expanded substring). */
986 while ((c = (subject[j])) != 0)
988 int shift = (c + j++) & 7;
989 subject[i] ^= (c << shift) | (c >> (8-shift));
990 if (++i >= value1) i = 0;
992 for (i = 0; i < value1; i++)
993 subject[i] = hashcodes[(subject[i]) % value2];
995 else value1 = sublen;
1004 /*************************************************
1005 * Numeric hash of a string *
1006 *************************************************/
1008 /* Perform the ${nhash expansion operation. The first characters of the
1009 string are treated as most important, and get the highest prime numbers.
1012 subject the input string
1013 value1 the maximum value of the first part of the result
1014 value2 the maximum value of the second part of the result,
1015 or negative to produce only a one-part result
1016 len set to the length of the returned string
1018 Returns: pointer to the output string, or NULL if there is an error.
1022 compute_nhash (uschar *subject, int value1, int value2, int *len)
1024 uschar *s = subject;
1026 unsigned long int total = 0; /* no overflow */
1030 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1031 total += prime[i--] * (unsigned int)(*s++);
1034 /* If value2 is unset, just compute one number */
1038 s = string_sprintf("%d", total % value1);
1041 /* Otherwise do a div/mod hash */
1045 total = total % (value1 * value2);
1046 s = string_sprintf("%d/%d", total/value2, total % value2);
1057 /*************************************************
1058 * Find the value of a header or headers *
1059 *************************************************/
1061 /* Multiple instances of the same header get concatenated, and this function
1062 can also return a concatenation of all the header lines. When concatenating
1063 specific headers that contain lists of addresses, a comma is inserted between
1064 them. Otherwise we use a straight concatenation. Because some messages can have
1065 pathologically large number of lines, there is a limit on the length that is
1066 returned. Also, to avoid massive store use which would result from using
1067 string_cat() as it copies and extends strings, we do a preliminary pass to find
1068 out exactly how much store will be needed. On "normal" messages this will be
1072 name the name of the header, without the leading $header_ or $h_,
1073 or NULL if a concatenation of all headers is required
1074 exists_only TRUE if called from a def: test; don't need to build a string;
1075 just return a string that is not "" and not "0" if the header
1077 newsize return the size of memory block that was obtained; may be NULL
1078 if exists_only is TRUE
1079 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1080 other than concatenating, will be done on the header
1081 charset name of charset to translate MIME words to; used only if
1082 want_raw is false; if NULL, no translation is done (this is
1083 used for $bh_ and $bheader_)
1085 Returns: NULL if the header does not exist, else a pointer to a new
1090 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1093 BOOL found = name == NULL;
1095 int len = found? 0 : Ustrlen(name);
1097 uschar *yield = NULL;
1100 /* Loop for two passes - saves code repetition */
1102 for (i = 0; i < 2; i++)
1107 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1109 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1111 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1116 if (exists_only) return US"1"; /* don't need actual string */
1118 t = h->text + len; /* text to insert */
1119 if (!want_raw) /* unless wanted raw, */
1120 while (isspace(*t)) t++; /* remove leading white space */
1121 ilen = h->slen - (t - h->text); /* length to insert */
1123 /* Set comma = 1 if handling a single header and it's one of those
1124 that contains an address list, except when asked for raw headers. Only
1125 need to do this once. */
1127 if (!want_raw && name != NULL && comma == 0 &&
1128 Ustrchr("BCFRST", h->type) != NULL)
1131 /* First pass - compute total store needed; second pass - compute
1132 total store used, including this header. */
1134 size += ilen + comma;
1136 /* Second pass - concatentate the data, up to a maximum. Note that
1137 the loop stops when size hits the limit. */
1141 if (size > header_insert_maxlen)
1143 ilen -= size - header_insert_maxlen;
1146 Ustrncpy(ptr, t, ilen);
1148 if (comma != 0 && ilen > 0)
1158 /* At end of first pass, truncate size if necessary, and get the buffer
1159 to hold the data, returning the buffer size. */
1163 if (!found) return NULL;
1164 if (size > header_insert_maxlen) size = header_insert_maxlen;
1165 *newsize = size + 1;
1166 ptr = yield = store_get(*newsize);
1170 /* Remove a redundant added comma if present */
1172 if (comma != 0 && ptr > yield) ptr -= 2;
1174 /* That's all we do for raw header expansion. */
1181 /* Otherwise, we remove trailing whitespace, including newlines. Then we do RFC
1182 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1183 function can return an error with decoded data if the charset translation
1184 fails. If decoding fails, it returns NULL. */
1188 uschar *decoded, *error;
1189 while (ptr > yield && isspace(ptr[-1])) ptr--;
1191 decoded = rfc2047_decode2(yield, TRUE, charset, '?', NULL, newsize, &error);
1194 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1195 " input was: %s\n", error, yield);
1197 if (decoded != NULL) yield = decoded;
1206 /*************************************************
1207 * Find value of a variable *
1208 *************************************************/
1210 /* The table of variables is kept in alphabetic order, so we can search it
1211 using a binary chop. The "choplen" variable is nothing to do with the binary
1215 name the name of the variable being sought
1216 exists_only TRUE if this is a def: test; passed on to find_header()
1217 skipping TRUE => skip any processing evaluation; this is not the same as
1218 exists_only because def: may test for values that are first
1220 newsize pointer to an int which is initially zero; if the answer is in
1221 a new memory buffer, *newsize is set to its size
1223 Returns: NULL if the variable does not exist, or
1224 a pointer to the variable's contents, or
1225 something non-NULL if exists_only is TRUE
1229 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1232 int last = var_table_size;
1234 while (last > first)
1238 int middle = (first + last)/2;
1239 int c = Ustrcmp(name, var_table[middle].name);
1241 if (c > 0) { first = middle + 1; continue; }
1242 if (c < 0) { last = middle; continue; }
1244 /* Found an existing variable. If in skipping state, the value isn't needed,
1245 and we want to avoid processing (such as looking up up the host name). */
1247 if (skipping) return US"";
1249 switch (var_table[middle].type)
1251 case vtype_filter_int:
1252 if (!filter_running) return NULL;
1255 #ifdef EXPERIMENTAL_DOMAINKEYS
1257 case vtype_dk_verify:
1258 if (dk_verify_block == NULL) return US"";
1260 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1261 s = dk_verify_block->result_string;
1262 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1263 s = dk_verify_block->address;
1264 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1265 s = dk_verify_block->domain;
1266 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1267 s = dk_verify_block->local_part;
1269 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1270 switch(dk_verify_block->address_source) {
1271 case DK_EXIM_ADDRESS_NONE: s = "0"; break;
1272 case DK_EXIM_ADDRESS_FROM_FROM: s = "from"; break;
1273 case DK_EXIM_ADDRESS_FROM_SENDER: s = "sender"; break;
1276 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1277 switch(dk_verify_block->result) {
1278 case DK_EXIM_RESULT_ERR: s = "error"; break;
1279 case DK_EXIM_RESULT_BAD_FORMAT: s = "bad format"; break;
1280 case DK_EXIM_RESULT_NO_KEY: s = "no key"; break;
1281 case DK_EXIM_RESULT_NO_SIGNATURE: s = "no signature"; break;
1282 case DK_EXIM_RESULT_REVOKED: s = "revoked"; break;
1283 case DK_EXIM_RESULT_NON_PARTICIPANT: s = "non-participant"; break;
1284 case DK_EXIM_RESULT_GOOD: s = "good"; break;
1285 case DK_EXIM_RESULT_BAD: s = "bad"; break;
1288 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1289 s = (dk_verify_block->signsall)? "1" : "0";
1291 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1292 s = (dk_verify_block->testing)? "1" : "0";
1294 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1295 s = (dk_verify_block->is_signed)? "1" : "0";
1297 return (s == NULL)? US"" : s;
1301 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1305 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1309 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1313 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1316 case vtype_stringptr: /* Pointer to string */
1317 s = *((uschar **)(var_table[middle].value));
1318 return (s == NULL)? US"" : s;
1321 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1324 case vtype_load_avg:
1325 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1328 case vtype_host_lookup: /* Lookup if not done so */
1329 if (sender_host_name == NULL && sender_host_address != NULL &&
1330 !host_lookup_failed && host_name_lookup() == OK)
1331 host_build_sender_fullhost();
1332 return (sender_host_name == NULL)? US"" : sender_host_name;
1334 case vtype_localpart: /* Get local part from address */
1335 s = *((uschar **)(var_table[middle].value));
1336 if (s == NULL) return US"";
1337 domain = Ustrrchr(s, '@');
1338 if (domain == NULL) return s;
1339 if (domain - s > sizeof(var_buffer) - 1)
1340 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1341 "string expansion", sizeof(var_buffer));
1342 Ustrncpy(var_buffer, s, domain - s);
1343 var_buffer[domain - s] = 0;
1346 case vtype_domain: /* Get domain from address */
1347 s = *((uschar **)(var_table[middle].value));
1348 if (s == NULL) return US"";
1349 domain = Ustrrchr(s, '@');
1350 return (domain == NULL)? US"" : domain + 1;
1352 case vtype_msgheaders:
1353 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1355 case vtype_msgbody: /* Pointer to msgbody string */
1356 case vtype_msgbody_end: /* Ditto, the end of the msg */
1357 ss = (uschar **)(var_table[middle].value);
1358 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1361 int start_offset = SPOOL_DATA_START_OFFSET;
1362 int len = message_body_visible;
1363 if (len > message_size) len = message_size;
1364 *ss = body = store_malloc(len+1);
1366 if (var_table[middle].type == vtype_msgbody_end)
1368 struct stat statbuf;
1369 if (fstat(deliver_datafile, &statbuf) == 0)
1371 start_offset = statbuf.st_size - len;
1372 if (start_offset < SPOOL_DATA_START_OFFSET)
1373 start_offset = SPOOL_DATA_START_OFFSET;
1376 lseek(deliver_datafile, start_offset, SEEK_SET);
1377 len = read(deliver_datafile, body, len);
1383 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1387 return (*ss == NULL)? US"" : *ss;
1389 case vtype_todbsdin: /* BSD inbox time of day */
1390 return tod_stamp(tod_bsdin);
1392 case vtype_tode: /* Unix epoch time of day */
1393 return tod_stamp(tod_epoch);
1395 case vtype_todf: /* Full time of day */
1396 return tod_stamp(tod_full);
1398 case vtype_todl: /* Log format time of day */
1399 return tod_stamp(tod_log_bare); /* (without timezone) */
1401 case vtype_todzone: /* Time zone offset only */
1402 return tod_stamp(tod_zone);
1404 case vtype_todzulu: /* Zulu time */
1405 return tod_stamp(tod_zulu);
1407 case vtype_todlf: /* Log file datestamp tod */
1408 return tod_stamp(tod_log_datestamp);
1410 case vtype_reply: /* Get reply address */
1411 s = find_header(US"reply-to:", exists_only, newsize, FALSE,
1413 if (s == NULL || *s == 0)
1414 s = find_header(US"from:", exists_only, newsize, FALSE, headers_charset);
1415 return (s == NULL)? US"" : s;
1417 /* A recipients list is available only during system message filtering,
1418 during ACL processing after DATA, and while expanding pipe commands
1419 generated from a system filter, but not elsewhere. */
1421 case vtype_recipients:
1422 if (!enable_dollar_recipients) return NULL; else
1427 s = store_get(size);
1428 for (i = 0; i < recipients_count; i++)
1430 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1431 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1432 Ustrlen(recipients_list[i].address));
1434 s[ptr] = 0; /* string_cat() leaves room */
1441 sprintf(CS var_buffer, "%d",
1442 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1449 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1450 sprintf(CS var_buffer, "%d", inodes);
1456 return NULL; /* Unknown variable name */
1462 /*************************************************
1463 * Read and expand substrings *
1464 *************************************************/
1466 /* This function is called to read and expand argument substrings for various
1467 expansion items. Some have a minimum requirement that is less than the maximum;
1468 in these cases, the first non-present one is set to NULL.
1471 sub points to vector of pointers to set
1472 n maximum number of substrings
1474 sptr points to current string pointer
1475 skipping the skipping flag
1476 check_end if TRUE, check for final '}'
1477 name name of item, for error message
1479 Returns: 0 OK; string pointer updated
1480 1 curly bracketing error (too few arguments)
1481 2 too many arguments (only if check_end is set); message set
1482 3 other error (expansion failure)
1486 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1487 BOOL check_end, uschar *name)
1492 while (isspace(*s)) s++;
1493 for (i = 0; i < n; i++)
1497 if (i < m) return 1;
1501 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1502 if (sub[i] == NULL) return 3;
1503 if (*s++ != '}') return 1;
1504 while (isspace(*s)) s++;
1506 if (check_end && *s++ != '}')
1510 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1511 "(max is %d)", name, n);
1524 /*************************************************
1525 * Read and evaluate a condition *
1526 *************************************************/
1530 s points to the start of the condition text
1531 yield points to a BOOL to hold the result of the condition test;
1532 if NULL, we are just reading through a condition that is
1533 part of an "or" combination to check syntax, or in a state
1534 where the answer isn't required
1536 Returns: a pointer to the first character after the condition, or
1541 eval_condition(uschar *s, BOOL *yield)
1543 BOOL testfor = TRUE;
1544 BOOL tempcond, combined_cond;
1546 int i, rc, cond_type, roffset;
1548 struct stat statbuf;
1553 const uschar *rerror;
1557 while (isspace(*s)) s++;
1558 if (*s == '!') { testfor = !testfor; s++; } else break;
1561 /* Numeric comparisons are symbolic */
1563 if (*s == '=' || *s == '>' || *s == '<')
1575 /* All other conditions are named */
1577 else s = read_name(name, 256, s, US"_");
1579 /* If we haven't read a name, it means some non-alpha character is first. */
1583 expand_string_message = string_sprintf("condition name expected, "
1584 "but found \"%.16s\"", s);
1588 /* Find which condition we are dealing with, and switch on it */
1590 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1593 /* def: tests for a non-zero or non-NULL variable, or for an existing
1599 expand_string_message = US"\":\" expected after \"def\"";
1603 s = read_name(name, 256, s+1, US"_");
1605 /* Test for a header's existence */
1607 if (Ustrncmp(name, "h_", 2) == 0 ||
1608 Ustrncmp(name, "rh_", 3) == 0 ||
1609 Ustrncmp(name, "bh_", 3) == 0 ||
1610 Ustrncmp(name, "header_", 7) == 0 ||
1611 Ustrncmp(name, "rheader_", 8) == 0 ||
1612 Ustrncmp(name, "bheader_", 8) == 0)
1614 s = read_header_name(name, 256, s);
1615 if (yield != NULL) *yield =
1616 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1619 /* Test for a variable's having a non-empty value. If yield == NULL we
1620 are in a skipping state, and don't care about the answer. */
1624 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1627 expand_string_message = (name[0] == 0)?
1628 string_sprintf("variable name omitted after \"def:\"") :
1629 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1633 *yield = (value[0] != 0 && Ustrcmp(value, "0") != 0) == testfor;
1639 /* first_delivery tests for first delivery attempt */
1641 case ECOND_FIRST_DELIVERY:
1642 if (yield != NULL) *yield = deliver_firsttime == testfor;
1646 /* queue_running tests for any process started by a queue runner */
1648 case ECOND_QUEUE_RUNNING:
1649 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1653 /* exists: tests for file existence
1654 isip: tests for any IP address
1655 isip4: tests for an IPv4 address
1656 isip6: tests for an IPv6 address
1657 pam: does PAM authentication
1658 radius: does RADIUS authentication
1659 ldapauth: does LDAP authentication
1660 pwcheck: does Cyrus SASL pwcheck authentication
1669 case ECOND_LDAPAUTH:
1672 while (isspace(*s)) s++;
1673 if (*s != '{') goto COND_FAILED_CURLY_START;
1675 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1676 if (sub[0] == NULL) return NULL;
1677 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1679 if (yield == NULL) return s; /* No need to run the test if skipping */
1684 if ((expand_forbid & RDO_EXISTS) != 0)
1686 expand_string_message = US"File existence tests are not permitted";
1689 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1695 rc = string_is_ip_address(sub[0], NULL);
1696 *yield = ((cond_type == ECOND_ISIP)? (rc > 0) :
1697 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1700 /* Various authentication tests - all optionally compiled */
1704 rc = auth_call_pam(sub[0], &expand_string_message);
1707 goto COND_FAILED_NOT_COMPILED;
1708 #endif /* SUPPORT_PAM */
1711 #ifdef RADIUS_CONFIG_FILE
1712 rc = auth_call_radius(sub[0], &expand_string_message);
1715 goto COND_FAILED_NOT_COMPILED;
1716 #endif /* RADIUS_CONFIG_FILE */
1718 case ECOND_LDAPAUTH:
1721 /* Just to keep the interface the same */
1723 int old_pool = store_pool;
1724 store_pool = POOL_SEARCH;
1725 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1726 &expand_string_message, &do_cache);
1727 store_pool = old_pool;
1731 goto COND_FAILED_NOT_COMPILED;
1732 #endif /* LOOKUP_LDAP */
1735 #ifdef CYRUS_PWCHECK_SOCKET
1736 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1739 goto COND_FAILED_NOT_COMPILED;
1740 #endif /* CYRUS_PWCHECK_SOCKET */
1742 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1743 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1745 if (rc == ERROR || rc == DEFER) return NULL;
1746 *yield = (rc == OK) == testfor;
1752 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1754 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1756 However, the last two are optional. That is why the whole set is enclosed
1757 in their own set or braces. */
1759 case ECOND_SASLAUTHD:
1760 #ifndef CYRUS_SASLAUTHD_SOCKET
1761 goto COND_FAILED_NOT_COMPILED;
1763 while (isspace(*s)) s++;
1764 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1765 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1767 case 1: expand_string_message = US"too few arguments or bracketing "
1768 "error for saslauthd";
1770 case 3: return NULL;
1772 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1776 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1777 &expand_string_message);
1778 if (rc == ERROR || rc == DEFER) return NULL;
1779 *yield = (rc == OK) == testfor;
1782 #endif /* CYRUS_SASLAUTHD_SOCKET */
1785 /* symbolic operators for numeric and string comparison, and a number of
1786 other operators, all requiring two arguments.
1788 match: does a regular expression match and sets up the numerical
1789 variables if it succeeds
1790 match_address: matches in an address list
1791 match_domain: matches in a domain list
1792 match_local_part: matches in a local part list
1793 crypteq: encrypts plaintext and compares against an encrypted text,
1794 using crypt(), crypt16(), MD5 or SHA-1
1798 case ECOND_MATCH_ADDRESS:
1799 case ECOND_MATCH_DOMAIN:
1800 case ECOND_MATCH_LOCAL_PART:
1803 case ECOND_NUM_L: /* Numerical comparisons */
1810 case ECOND_STR_LT: /* String comparisons */
1821 for (i = 0; i < 2; i++)
1823 while (isspace(*s)) s++;
1826 if (i == 0) goto COND_FAILED_CURLY_START;
1827 expand_string_message = string_sprintf("missing 2nd string in {} "
1828 "after \"%s\"", name);
1831 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1832 if (sub[i] == NULL) return NULL;
1833 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1835 /* Convert to numerical if required; we know that the names of all the
1836 conditions that compare numbers do not start with a letter. This just saves
1837 checking for them individually. */
1839 if (!isalpha(name[0]))
1842 num[i] = (int)Ustrtol((const uschar *)sub[i], &endptr, 10);
1843 if (tolower(*endptr) == 'k')
1848 else if (tolower(*endptr) == 'm')
1850 num[i] *= 1024*1024;
1853 while (isspace(*endptr)) endptr++;
1856 expand_string_message = string_sprintf("\"%s\" is not a number",
1863 /* Result not required */
1865 if (yield == NULL) return s;
1867 /* Do an appropriate comparison */
1873 *yield = (num[0] == num[1]) == testfor;
1877 *yield = (num[0] > num[1]) == testfor;
1881 *yield = (num[0] >= num[1]) == testfor;
1885 *yield = (num[0] < num[1]) == testfor;
1889 *yield = (num[0] <= num[1]) == testfor;
1893 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1897 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1901 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1905 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1909 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1913 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1917 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1921 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1925 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
1929 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
1932 case ECOND_MATCH: /* Regular expression match */
1933 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1937 expand_string_message = string_sprintf("regular expression error in "
1938 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1941 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1944 case ECOND_MATCH_ADDRESS: /* Match in an address list */
1945 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1946 goto MATCHED_SOMETHING;
1948 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
1949 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1950 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1951 goto MATCHED_SOMETHING;
1953 case ECOND_MATCH_LOCAL_PART:
1954 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
1955 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
1970 expand_string_message = string_sprintf("unable to complete match "
1971 "against \"%s\": %s", sub[1], search_error_message);
1977 /* Various "encrypted" comparisons. If the second string starts with
1978 "{" then an encryption type is given. Default to crypt() or crypt16()
1979 (build-time choice). */
1982 #ifndef SUPPORT_CRYPTEQ
1983 goto COND_FAILED_NOT_COMPILED;
1985 if (strncmpic(sub[1], US"{md5}", 5) == 0)
1987 int sublen = Ustrlen(sub[1]+5);
1992 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
1994 /* If the length that we are comparing against is 24, the MD5 digest
1995 is expressed as a base64 string. This is the way LDAP does it. However,
1996 some other software uses a straightforward hex representation. We assume
1997 this if the length is 32. Other lengths fail. */
2001 uschar *coded = auth_b64encode((uschar *)digest, 16);
2002 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2003 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2004 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2006 else if (sublen == 32)
2010 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2012 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2013 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2014 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2018 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2019 "fail\n crypted=%s\n", sub[1]+5);
2024 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2026 int sublen = Ustrlen(sub[1]+6);
2031 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2033 /* If the length that we are comparing against is 28, assume the SHA1
2034 digest is expressed as a base64 string. If the length is 40, assume a
2035 straightforward hex representation. Other lengths fail. */
2039 uschar *coded = auth_b64encode((uschar *)digest, 20);
2040 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2041 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2042 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2044 else if (sublen == 40)
2048 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2050 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2051 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2052 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2056 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2057 "fail\n crypted=%s\n", sub[1]+6);
2062 else /* {crypt} or {crypt16} and non-{ at start */
2067 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2072 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2077 else if (sub[1][0] == '{')
2079 expand_string_message = string_sprintf("unknown encryption mechanism "
2080 "in \"%s\"", sub[1]);
2086 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2087 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2088 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2092 #define XSTR(s) STR(s)
2093 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2094 " subject=%s\n crypted=%s\n",
2095 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2100 /* If the encrypted string contains fewer than two characters (for the
2101 salt), force failure. Otherwise we get false positives: with an empty
2102 string the yield of crypt() is an empty string! */
2104 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2105 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2108 #endif /* SUPPORT_CRYPTEQ */
2109 } /* Switch for comparison conditions */
2111 return s; /* End of comparison conditions */
2114 /* and/or: computes logical and/or of several conditions */
2118 subcondptr = (yield == NULL)? NULL : &tempcond;
2119 combined_cond = (cond_type == ECOND_AND);
2121 while (isspace(*s)) s++;
2122 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2126 while (isspace(*s)) s++;
2127 if (*s == '}') break;
2130 expand_string_message = string_sprintf("each subcondition "
2131 "inside an \"%s{...}\" condition must be in its own {}", name);
2135 s = eval_condition(s+1, subcondptr);
2138 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2139 expand_string_message, name);
2142 while (isspace(*s)) s++;
2146 expand_string_message = string_sprintf("missing } at end of condition "
2147 "inside \"%s\" group", name);
2153 if (cond_type == ECOND_AND)
2155 combined_cond &= tempcond;
2156 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2157 } /* evaluate any more */
2160 combined_cond |= tempcond;
2161 if (combined_cond) subcondptr = NULL; /* once true, don't */
2162 } /* evaluate any more */
2166 if (yield != NULL) *yield = (combined_cond == testfor);
2170 /* Unknown condition */
2173 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2175 } /* End switch on condition type */
2177 /* Missing braces at start and end of data */
2179 COND_FAILED_CURLY_START:
2180 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2183 COND_FAILED_CURLY_END:
2184 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2188 /* A condition requires code that is not compiled */
2190 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2191 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2192 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2193 COND_FAILED_NOT_COMPILED:
2194 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2203 /*************************************************
2204 * Save numerical variables *
2205 *************************************************/
2207 /* This function is called from items such as "if" that want to preserve and
2208 restore the numbered variables.
2211 save_expand_string points to an array of pointers to set
2212 save_expand_nlength points to an array of ints for the lengths
2214 Returns: the value of expand max to save
2218 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2221 for (i = 0; i <= expand_nmax; i++)
2223 save_expand_nstring[i] = expand_nstring[i];
2224 save_expand_nlength[i] = expand_nlength[i];
2231 /*************************************************
2232 * Restore numerical variables *
2233 *************************************************/
2235 /* This function restored saved values of numerical strings.
2238 save_expand_nmax the number of strings to restore
2239 save_expand_string points to an array of pointers
2240 save_expand_nlength points to an array of ints
2246 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2247 int *save_expand_nlength)
2250 expand_nmax = save_expand_nmax;
2251 for (i = 0; i <= expand_nmax; i++)
2253 expand_nstring[i] = save_expand_nstring[i];
2254 expand_nlength[i] = save_expand_nlength[i];
2262 /*************************************************
2263 * Handle yes/no substrings *
2264 *************************************************/
2266 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2267 alternative substrings that depend on whether or not the condition was true,
2268 or the lookup or extraction succeeded. The substrings always have to be
2269 expanded, to check their syntax, but "skipping" is set when the result is not
2270 needed - this avoids unnecessary nested lookups.
2273 skipping TRUE if we were skipping when this item was reached
2274 yes TRUE if the first string is to be used, else use the second
2275 save_lookup a value to put back into lookup_value before the 2nd expansion
2276 sptr points to the input string pointer
2277 yieldptr points to the output string pointer
2278 sizeptr points to the output string size
2279 ptrptr points to the output string pointer
2280 type "lookup" or "if" or "extract" or "run", for error message
2282 Returns: 0 OK; lookup_value has been reset to save_lookup
2284 2 expansion failed because of bracketing error
2288 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2289 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2292 uschar *s = *sptr; /* Local value */
2293 uschar *sub1, *sub2;
2295 /* If there are no following strings, we substitute the contents of $value for
2296 lookups and for extractions in the success case. For the ${if item, the string
2297 "true" is substituted. In the fail case, nothing is substituted for all three
2300 while (isspace(*s)) s++;
2305 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2309 if (yes && lookup_value != NULL)
2310 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2311 Ustrlen(lookup_value));
2312 lookup_value = save_lookup;
2318 /* Expand the first substring. Forced failures are noticed only if we actually
2319 want this string. Set skipping in the call in the fail case (this will always
2320 be the case if we were already skipping). */
2322 sub1 = expand_string_internal(s+1, TRUE, &s, !yes);
2323 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2324 expand_string_forcedfail = FALSE;
2325 if (*s++ != '}') goto FAILED_CURLY;
2327 /* If we want the first string, add it to the output */
2330 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2332 /* If this is called from a lookup or an extract, we want to restore $value to
2333 what it was at the start of the item, so that it has this value during the
2334 second string expansion. For the call from "if" to this function, save_lookup
2335 is set to lookup_value, so that this statement does nothing. */
2337 lookup_value = save_lookup;
2339 /* There now follows either another substring, or "fail", or nothing. This
2340 time, forced failures are noticed only if we want the second string. We must
2341 set skipping in the nested call if we don't want this string, or if we were
2342 already skipping. */
2344 while (isspace(*s)) s++;
2347 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2348 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2349 expand_string_forcedfail = FALSE;
2350 if (*s++ != '}') goto FAILED_CURLY;
2352 /* If we want the second string, add it to the output */
2355 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2358 /* If there is no second string, but the word "fail" is present when the use of
2359 the second string is wanted, set a flag indicating it was a forced failure
2360 rather than a syntactic error. Swallow the terminating } in case this is nested
2361 inside another lookup or if or extract. */
2366 s = read_name(name, sizeof(name), s, US"_");
2367 if (Ustrcmp(name, "fail") == 0)
2369 if (!yes && !skipping)
2371 while (isspace(*s)) s++;
2372 if (*s++ != '}') goto FAILED_CURLY;
2373 expand_string_message =
2374 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2375 expand_string_forcedfail = TRUE;
2381 expand_string_message =
2382 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2387 /* All we have to do now is to check on the final closing brace. */
2389 while (isspace(*s)) s++;
2390 if (*s++ == '}') goto RETURN;
2392 /* Get here if there is a bracketing failure */
2397 /* Get here for other failures */
2402 /* Update the input pointer value before returning */
2414 /*************************************************
2415 * Handle MD5 or SHA-1 computation for HMAC *
2416 *************************************************/
2418 /* These are some wrapping functions that enable the HMAC code to be a bit
2419 cleaner. A good compiler will spot the tail recursion.
2422 type HMAC_MD5 or HMAC_SHA1
2423 remaining are as for the cryptographic hash functions
2429 chash_start(int type, void *base)
2431 if (type == HMAC_MD5)
2432 md5_start((md5 *)base);
2434 sha1_start((sha1 *)base);
2438 chash_mid(int type, void *base, uschar *string)
2440 if (type == HMAC_MD5)
2441 md5_mid((md5 *)base, string);
2443 sha1_mid((sha1 *)base, string);
2447 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2449 if (type == HMAC_MD5)
2450 md5_end((md5 *)base, string, length, digest);
2452 sha1_end((sha1 *)base, string, length, digest);
2459 /*************************************************
2460 * Join a file onto the output string *
2461 *************************************************/
2463 /* This is used for readfile and after a run expansion. It joins the contents
2464 of a file onto the output string, globally replacing newlines with a given
2465 string (optionally). The file is closed at the end.
2469 yield pointer to the expandable string
2470 sizep pointer to the current size
2471 ptrp pointer to the current position
2472 eol newline replacement string, or NULL
2474 Returns: new value of string pointer
2478 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2481 uschar buffer[1024];
2483 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2485 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2487 int len = Ustrlen(buffer);
2488 if (eol != NULL && buffer[len-1] == '\n') len--;
2489 yield = string_cat(yield, sizep, ptrp, buffer, len);
2490 if (buffer[len] != 0)
2491 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2494 if (yield != NULL) yield[*ptrp] = 0;
2502 /*************************************************
2503 * Evaluate numeric expression *
2504 *************************************************/
2506 /* This is a set of mutually recursive functions that evaluate a simple
2507 arithmetic expression involving only + - * / and parentheses. The only one that
2508 is called from elsewhere is eval_expr, whose interface is:
2511 sptr pointer to the pointer to the string - gets updated
2512 decimal TRUE if numbers are to be assumed decimal
2513 error pointer to where to put an error message - must be NULL on input
2514 endket TRUE if ')' must terminate - FALSE for external call
2517 Returns: on success: the value of the expression, with *error still NULL
2518 on failure: an undefined value, with *error = a message
2521 static int eval_sumterm(uschar **, BOOL, uschar **);
2524 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2527 int x = eval_sumterm(&s, decimal, error);
2530 while (*s == '+' || *s == '-')
2533 int y = eval_sumterm(&s, decimal, error);
2534 if (*error != NULL) break;
2535 if (op == '+') x += y; else x -= y;
2542 *error = US"expecting closing parenthesis";
2544 while (isspace(*(++s)));
2546 else if (*s != 0) *error = US"expecting + or -";
2555 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2560 while (isspace(*s)) s++;
2562 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2565 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2567 if (tolower(*s) == 'k') { n *= 1024; s++; }
2568 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2569 while (isspace (*s)) s++;
2574 n = eval_expr(&s, decimal, error, 1);
2578 *error = US"expecting number or opening parenthesis";
2585 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2588 int x = eval_term(&s, decimal, error);
2591 while (*s == '*' || *s == '/')
2594 int y = eval_term(&s, decimal, error);
2595 if (*error != NULL) break;
2596 if (op == '*') x *= y; else x /= y;
2606 /*************************************************
2608 *************************************************/
2610 /* Returns either an unchanged string, or the expanded string in stacking pool
2611 store. Interpreted sequences are:
2613 \... normal escaping rules
2614 $name substitutes the variable
2616 ${op:string} operates on the expanded string value
2617 ${item{arg1}{arg2}...} expands the args and then does the business
2618 some literal args are not enclosed in {}
2620 There are now far too many operators and item types to make it worth listing
2621 them here in detail any more.
2623 We use an internal routine recursively to handle embedded substrings. The
2624 external function follows. The yield is NULL if the expansion failed, and there
2625 are two cases: if something collapsed syntactically, or if "fail" was given
2626 as the action on a lookup failure. These can be distinguised by looking at the
2627 variable expand_string_forcedfail, which is TRUE in the latter case.
2629 The skipping flag is set true when expanding a substring that isn't actually
2630 going to be used (after "if" or "lookup") and it prevents lookups from
2631 happening lower down.
2633 Store usage: At start, a store block of the length of the input plus 64
2634 is obtained. This is expanded as necessary by string_cat(), which might have to
2635 get a new block, or might be able to expand the original. At the end of the
2636 function we can release any store above that portion of the yield block that
2637 was actually used. In many cases this will be optimal.
2639 However: if the first item in the expansion is a variable name or header name,
2640 we reset the store before processing it; if the result is in fresh store, we
2641 use that without copying. This is helpful for expanding strings like
2642 $message_headers which can get very long.
2645 string the string to be expanded
2646 ket_ends true if expansion is to stop at }
2647 left if not NULL, a pointer to the first character after the
2648 expansion is placed here (typically used with ket_ends)
2649 skipping TRUE for recursive calls when the value isn't actually going
2650 to be used (to allow for optimisation)
2652 Returns: NULL if expansion fails:
2653 expand_string_forcedfail is set TRUE if failure was forced
2654 expand_string_message contains a textual error message
2655 a pointer to the expanded string on success
2659 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2663 int size = Ustrlen(string)+ 64;
2665 uschar *yield = store_get(size);
2667 uschar *save_expand_nstring[EXPAND_MAXN+1];
2668 int save_expand_nlength[EXPAND_MAXN+1];
2670 expand_string_forcedfail = FALSE;
2671 expand_string_message = US"";
2678 /* \ escapes the next character, which must exist, or else
2679 the expansion fails. There's a special escape, \N, which causes
2680 copying of the subject verbatim up to the next \N. Otherwise,
2681 the escapes are the standard set. */
2687 expand_string_message = US"\\ at end of string";
2694 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2695 yield = string_cat(yield, &size, &ptr, t, s - t);
2696 if (*s != 0) s += 2;
2702 ch[0] = string_interpret_escape(&s);
2704 yield = string_cat(yield, &size, &ptr, ch, 1);
2710 /* Anything other than $ is just copied verbatim, unless we are
2711 looking for a terminating } character. */
2713 if (ket_ends && *s == '}') break;
2717 yield = string_cat(yield, &size, &ptr, s++, 1);
2721 /* No { after the $ - must be a plain name or a number for string
2722 match variable. There has to be a fudge for variables that are the
2723 names of header fields preceded by "$header_" because header field
2724 names can contain any printing characters except space and colon.
2725 For those that don't like typing this much, "$h_" is a synonym for
2726 "$header_". A non-existent header yields a NULL value; nothing is
2729 if (isalpha((*(++s))))
2734 s = read_name(name, sizeof(name), s, US"_");
2736 /* If this is the first thing to be expanded, release the pre-allocated
2739 if (ptr == 0 && yield != NULL)
2748 if (Ustrncmp(name, "h_", 2) == 0 ||
2749 Ustrncmp(name, "rh_", 3) == 0 ||
2750 Ustrncmp(name, "bh_", 3) == 0 ||
2751 Ustrncmp(name, "header_", 7) == 0 ||
2752 Ustrncmp(name, "rheader_", 8) == 0 ||
2753 Ustrncmp(name, "bheader_", 8) == 0)
2755 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2756 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2757 s = read_header_name(name, sizeof(name), s);
2758 value = find_header(name, FALSE, &newsize, want_raw, charset);
2760 /* If we didn't find the header, and the header contains a closing brace
2761 characters, this may be a user error where the terminating colon
2762 has been omitted. Set a flag to adjust the error message in this case.
2763 But there is no error here - nothing gets inserted. */
2767 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2776 value = find_variable(name, FALSE, skipping, &newsize);
2779 expand_string_message =
2780 string_sprintf("unknown variable name \"%s\"", name);
2785 /* If the data is known to be in a new buffer, newsize will be set to the
2786 size of that buffer. If this is the first thing in an expansion string,
2787 yield will be NULL; just point it at the new store instead of copying. Many
2788 expansion strings contain just one reference, so this is a useful
2789 optimization, especially for humungous headers. */
2791 len = Ustrlen(value);
2792 if (yield == NULL && newsize != 0)
2798 else yield = string_cat(yield, &size, &ptr, value, len);
2806 s = read_number(&n, s);
2807 if (n >= 0 && n <= expand_nmax)
2808 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2813 /* Otherwise, if there's no '{' after $ it's an error. */
2817 expand_string_message = US"$ not followed by letter, digit, or {";
2821 /* After { there can be various things, but they all start with
2822 an initial word, except for a number for a string match variable. */
2824 if (isdigit((*(++s))))
2827 s = read_number(&n, s);
2830 expand_string_message = US"} expected after number";
2833 if (n >= 0 && n <= expand_nmax)
2834 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2841 expand_string_message = US"letter or digit expected after ${";
2845 /* Allow "-" in names to cater for substrings with negative
2846 arguments. Since we are checking for known names after { this is
2849 s = read_name(name, sizeof(name), s, US"_-");
2850 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
2854 /* Handle conditionals - preserve the values of the numerical expansion
2855 variables in case they get changed by a regular expression match in the
2856 condition. If not, they retain their external settings. At the end
2857 of this "if" section, they get restored to their previous values. */
2863 int save_expand_nmax =
2864 save_expand_strings(save_expand_nstring, save_expand_nlength);
2866 while (isspace(*s)) s++;
2867 next_s = eval_condition(s, skipping? NULL : &cond);
2868 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
2871 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
2872 cond? "true" : "false");
2876 /* The handling of "yes" and "no" result strings is now in a separate
2877 function that is also used by ${lookup} and ${extract} and ${run}. */
2879 switch(process_yesno(
2880 skipping, /* were previously skipping */
2881 cond, /* success/failure indicator */
2882 lookup_value, /* value to reset for string2 */
2883 &s, /* input pointer */
2884 &yield, /* output pointer */
2885 &size, /* output size */
2886 &ptr, /* output current point */
2887 US"if")) /* condition type */
2889 case 1: goto EXPAND_FAILED; /* when all is well, the */
2890 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
2893 /* Restore external setting of expansion variables for continuation
2896 restore_expand_strings(save_expand_nmax, save_expand_nstring,
2897 save_expand_nlength);
2901 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
2902 expanding an internal string that isn't actually going to be used. All we
2903 need to do is check the syntax, so don't do a lookup at all. Preserve the
2904 values of the numerical expansion variables in case they get changed by a
2905 partial lookup. If not, they retain their external settings. At the end
2906 of this "lookup" section, they get restored to their previous values. */
2910 int stype, partial, affixlen, starflags;
2911 int expand_setup = 0;
2913 uschar *key, *filename, *affix;
2914 uschar *save_lookup_value = lookup_value;
2915 int save_expand_nmax =
2916 save_expand_strings(save_expand_nstring, save_expand_nlength);
2918 if ((expand_forbid & RDO_LOOKUP) != 0)
2920 expand_string_message = US"lookup expansions are not permitted";
2924 /* Get the key we are to look up for single-key+file style lookups.
2925 Otherwise set the key NULL pro-tem. */
2927 while (isspace(*s)) s++;
2930 key = expand_string_internal(s+1, TRUE, &s, skipping);
2931 if (key == NULL) goto EXPAND_FAILED;
2932 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
2933 while (isspace(*s)) s++;
2937 /* Find out the type of database */
2941 expand_string_message = US"missing lookup type";
2945 /* The type is a string that may contain special characters of various
2946 kinds. Allow everything except space or { to appear; the actual content
2947 is checked by search_findtype_partial. */
2949 while (*s != 0 && *s != '{' && !isspace(*s))
2951 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
2955 while (isspace(*s)) s++;
2957 /* Now check for the individual search type and any partial or default
2958 options. Only those types that are actually in the binary are valid. */
2960 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
2964 expand_string_message = search_error_message;
2968 /* Check that a key was provided for those lookup types that need it,
2969 and was not supplied for those that use the query style. */
2971 if (!mac_islookup(stype, lookup_querystyle))
2975 expand_string_message = string_sprintf("missing {key} for single-"
2976 "key \"%s\" lookup", name);
2984 expand_string_message = string_sprintf("a single key was given for "
2985 "lookup type \"%s\", which is not a single-key lookup type", name);
2990 /* Get the next string in brackets and expand it. It is the file name for
2991 single-key+file lookups, and the whole query otherwise. */
2993 if (*s != '{') goto EXPAND_FAILED_CURLY;
2994 filename = expand_string_internal(s+1, TRUE, &s, skipping);
2995 if (filename == NULL) goto EXPAND_FAILED;
2996 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
2997 while (isspace(*s)) s++;
2999 /* If this isn't a single-key+file lookup, re-arrange the variables
3000 to be appropriate for the search_ functions. */
3008 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3009 the entry was not found. Note that there is no search_close() function.
3010 Files are left open in case of re-use. At suitable places in higher logic,
3011 search_tidyup() is called to tidy all open files. This can save opening
3012 the same file several times. However, files may also get closed when
3013 others are opened, if too many are open at once. The rule is that a
3014 handle should not be used after a second search_open().
3016 Request that a partial search sets up $1 and maybe $2 by passing
3017 expand_setup containing zero. If its value changes, reset expand_nmax,
3018 since new variables will have been set. Note that at the end of this
3019 "lookup" section, the old numeric variables are restored. */
3022 lookup_value = NULL;
3025 void *handle = search_open(filename, stype, 0, NULL, NULL);
3028 expand_string_message = search_error_message;
3031 lookup_value = search_find(handle, filename, key, partial, affix,
3032 affixlen, starflags, &expand_setup);
3033 if (search_find_defer)
3035 expand_string_message =
3036 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3037 search_error_message);
3040 if (expand_setup > 0) expand_nmax = expand_setup;
3043 /* The handling of "yes" and "no" result strings is now in a separate
3044 function that is also used by ${if} and ${extract}. */
3046 switch(process_yesno(
3047 skipping, /* were previously skipping */
3048 lookup_value != NULL, /* success/failure indicator */
3049 save_lookup_value, /* value to reset for string2 */
3050 &s, /* input pointer */
3051 &yield, /* output pointer */
3052 &size, /* output size */
3053 &ptr, /* output current point */
3054 US"lookup")) /* condition type */
3056 case 1: goto EXPAND_FAILED; /* when all is well, the */
3057 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3060 /* Restore external setting of expansion variables for carrying on
3061 at this level, and continue. */
3063 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3064 save_expand_nlength);
3068 /* If Perl support is configured, handle calling embedded perl subroutines,
3069 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3070 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3071 arguments (defined below). */
3073 #define EXIM_PERL_MAX_ARGS 8
3077 expand_string_message = US"\"${perl\" encountered, but this facility "
3078 "is not included in this binary";
3081 #else /* EXIM_PERL */
3083 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3086 if ((expand_forbid & RDO_PERL) != 0)
3088 expand_string_message = US"Perl calls are not permitted";
3092 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3095 case 1: goto EXPAND_FAILED_CURLY;
3097 case 3: goto EXPAND_FAILED;
3100 /* If skipping, we don't actually do anything */
3102 if (skipping) continue;
3104 /* Start the interpreter if necessary */
3106 if (!opt_perl_started)
3109 if (opt_perl_startup == NULL)
3111 expand_string_message = US"A setting of perl_startup is needed when "
3112 "using the Perl interpreter";
3115 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3116 initerror = init_perl(opt_perl_startup);
3117 if (initerror != NULL)
3119 expand_string_message =
3120 string_sprintf("error in perl_startup code: %s\n", initerror);
3123 opt_perl_started = TRUE;
3126 /* Call the function */
3128 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3129 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3130 sub_arg[0], sub_arg + 1);
3132 /* NULL yield indicates failure; if the message pointer has been set to
3133 NULL, the yield was undef, indicating a forced failure. Otherwise the
3134 message will indicate some kind of Perl error. */
3136 if (new_yield == NULL)
3138 if (expand_string_message == NULL)
3140 expand_string_message =
3141 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3142 "failure", sub_arg[0]);
3143 expand_string_forcedfail = TRUE;
3148 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3149 set during a callback from Perl. */
3151 expand_string_forcedfail = FALSE;
3155 #endif /* EXIM_PERL */
3157 /* Handle "readfile" to insert an entire file */
3159 case EITEM_READFILE:
3164 if ((expand_forbid & RDO_READFILE) != 0)
3166 expand_string_message = US"file insertions are not permitted";
3170 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3172 case 1: goto EXPAND_FAILED_CURLY;
3174 case 3: goto EXPAND_FAILED;
3177 /* If skipping, we don't actually do anything */
3179 if (skipping) continue;
3181 /* Open the file and read it */
3183 f = Ufopen(sub_arg[0], "rb");
3186 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3190 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3195 /* Handle "readsocket" to insert data from a Unix domain socket */
3197 case EITEM_READSOCK:
3203 struct sockaddr_un sockun; /* don't call this "sun" ! */
3207 if ((expand_forbid & RDO_READSOCK) != 0)
3209 expand_string_message = US"socket insertions are not permitted";
3213 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3214 because there may be a string for expansion on failure. */
3216 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3218 case 1: goto EXPAND_FAILED_CURLY;
3219 case 2: /* Won't occur: no end check */
3220 case 3: goto EXPAND_FAILED;
3223 /* Sort out timeout, if given */
3225 if (sub_arg[2] != NULL)
3227 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3230 expand_string_message = string_sprintf("bad time value %s",
3235 else sub_arg[3] = NULL; /* No eol if no timeout */
3237 /* If skipping, we don't actually do anything */
3241 /* Make a connection to the socket */
3243 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3245 expand_string_message = string_sprintf("failed to create socket: %s",
3250 sockun.sun_family = AF_UNIX;
3251 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3253 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3255 expand_string_message = string_sprintf("failed to connect to socket "
3256 "%s: %s", sub_arg[0], strerror(errno));
3259 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3261 /* Write the request string, if not empty */
3263 if (sub_arg[1][0] != 0)
3265 int len = Ustrlen(sub_arg[1]);
3266 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3268 if (write(fd, sub_arg[1], len) != len)
3270 expand_string_message = string_sprintf("request write to socket "
3271 "failed: %s", strerror(errno));
3276 /* Now we need to read from the socket, under a timeout. The function
3277 that reads a file can be used. */
3279 f = fdopen(fd, "rb");
3280 sigalrm_seen = FALSE;
3282 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3286 /* After a timeout, we restore the pointer in the result, that is,
3287 make sure we add nothing from the socket. */
3292 expand_string_message = US"socket read timed out";
3297 /* The whole thing has worked (or we were skipping). If there is a
3298 failure string following, we need to skip it. */
3302 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3304 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3305 while (isspace(*s)) s++;
3307 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3310 /* Come here on failure to create socket, connect socket, write to the
3311 socket, or timeout on reading. If another substring follows, expand and
3312 use it. Otherwise, those conditions give expand errors. */
3315 if (*s != '{') goto EXPAND_FAILED;
3316 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3317 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3318 if (arg == NULL) goto EXPAND_FAILED;
3319 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3320 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3321 while (isspace(*s)) s++;
3322 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3326 /* Handle "run" to execute a program. */
3331 uschar *old_lookup_value = NULL;
3339 if ((expand_forbid & RDO_RUN) != 0)
3341 expand_string_message = US"running a command is not permitted";
3345 while (isspace(*s)) s++;
3346 if (*s != '{') goto EXPAND_FAILED_CURLY;
3347 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3348 if (arg == NULL) goto EXPAND_FAILED;
3349 while (isspace(*s)) s++;
3350 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3352 if (skipping) /* Just pretend it worked when we're skipping */
3358 if (!transport_set_up_command(&argv, /* anchor for arg list */
3359 arg, /* raw command */
3360 FALSE, /* don't expand the arguments */
3361 0, /* not relevant when... */
3362 NULL, /* no transporting address */
3363 US"${run} expansion", /* for error messages */
3364 &expand_string_message)) /* where to put error message */
3369 /* Create the child process, making it a group leader. */
3371 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3375 expand_string_message =
3376 string_sprintf("couldn't create child process: %s", strerror(errno));
3380 /* Nothing is written to the standard input. */
3384 /* Wait for the process to finish, applying the timeout, and inspect its
3385 return code for serious disasters. Simple non-zero returns are passed on.
3388 if ((runrc = child_close(pid, 60)) < 0)
3392 expand_string_message = string_sprintf("command timed out");
3393 killpg(pid, SIGKILL); /* Kill the whole process group */
3396 else if (runrc == -257)
3397 expand_string_message = string_sprintf("wait() failed: %s",
3401 expand_string_message = string_sprintf("command killed by signal %d",
3407 /* Read the pipe to get the command's output into $value (which is kept
3408 in lookup_value). */
3410 f = fdopen(fd_out, "rb");
3411 old_lookup_value = lookup_value;
3412 lookup_value = NULL;
3413 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3417 /* Process the yes/no strings */
3419 switch(process_yesno(
3420 skipping, /* were previously skipping */
3421 runrc == 0, /* success/failure indicator */
3422 old_lookup_value, /* value to reset for string2 */
3423 &s, /* input pointer */
3424 &yield, /* output pointer */
3425 &size, /* output size */
3426 &ptr, /* output current point */
3427 US"run")) /* condition type */
3429 case 1: goto EXPAND_FAILED; /* when all is well, the */
3430 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3436 /* Handle character translation for "tr" */
3444 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3446 case 1: goto EXPAND_FAILED_CURLY;
3448 case 3: goto EXPAND_FAILED;
3451 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3452 o2m = Ustrlen(sub[2]) - 1;
3454 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3456 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3460 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3467 /* Handle "hash", "length", "nhash", and "substr" when they are given with
3468 expanded arguments. */
3478 int val[2] = { 0, -1 };
3481 /* "length" takes only 2 arguments whereas the others take 2 or 3.
3482 Ensure that sub[2] is set in the ${length case. */
3485 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
3488 case 1: goto EXPAND_FAILED_CURLY;
3490 case 3: goto EXPAND_FAILED;
3493 /* Juggle the arguments if there are only two of them: always move the
3494 string to the last position and make ${length{n}{str}} equivalent to
3495 ${substr{0}{n}{str}}. See the defaults for val[] above. */
3501 if (item_type == EITEM_LENGTH)
3508 for (i = 0; i < 2; i++)
3510 if (sub[i] == NULL) continue;
3511 val[i] = (int)Ustrtol(sub[i], &ret, 10);
3512 if (*ret != 0 || (i != 0 && val[i] < 0))
3514 expand_string_message = string_sprintf("\"%s\" is not a%s number "
3515 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
3521 (item_type == EITEM_HASH)?
3522 compute_hash(sub[2], val[0], val[1], &len) :
3523 (item_type == EITEM_NHASH)?
3524 compute_nhash(sub[2], val[0], val[1], &len) :
3525 extract_substr(sub[2], val[0], val[1], &len);
3527 if (ret == NULL) goto EXPAND_FAILED;
3528 yield = string_cat(yield, &size, &ptr, ret, len);
3532 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
3533 This code originally contributed by Steve Haslam. It currently supports
3534 the use of MD5 and SHA-1 hashes.
3536 We need some workspace that is large enough to handle all the supported
3537 hash types. Use macros to set the sizes rather than be too elaborate. */
3539 #define MAX_HASHLEN 20
3540 #define MAX_HASHBLOCKLEN 64
3549 int hashlen; /* Number of octets for the hash algorithm's output */
3550 int hashblocklen; /* Number of octets the hash algorithm processes */
3552 unsigned int keylen;
3554 uschar keyhash[MAX_HASHLEN];
3555 uschar innerhash[MAX_HASHLEN];
3556 uschar finalhash[MAX_HASHLEN];
3557 uschar finalhash_hex[2*MAX_HASHLEN];
3558 uschar innerkey[MAX_HASHBLOCKLEN];
3559 uschar outerkey[MAX_HASHBLOCKLEN];
3561 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
3563 case 1: goto EXPAND_FAILED_CURLY;
3565 case 3: goto EXPAND_FAILED;
3568 if (Ustrcmp(sub[0], "md5") == 0)
3571 use_base = &md5_base;
3575 else if (Ustrcmp(sub[0], "sha1") == 0)
3578 use_base = &sha1_base;
3584 expand_string_message =
3585 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
3590 keylen = Ustrlen(keyptr);
3592 /* If the key is longer than the hash block length, then hash the key
3595 if (keylen > hashblocklen)
3597 chash_start(type, use_base);
3598 chash_end(type, use_base, keyptr, keylen, keyhash);
3603 /* Now make the inner and outer key values */
3605 memset(innerkey, 0x36, hashblocklen);
3606 memset(outerkey, 0x5c, hashblocklen);
3608 for (i = 0; i < keylen; i++)
3610 innerkey[i] ^= keyptr[i];
3611 outerkey[i] ^= keyptr[i];
3614 /* Now do the hashes */
3616 chash_start(type, use_base);
3617 chash_mid(type, use_base, innerkey);
3618 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
3620 chash_start(type, use_base);
3621 chash_mid(type, use_base, outerkey);
3622 chash_end(type, use_base, innerhash, hashlen, finalhash);
3624 /* Encode the final hash as a hex string */
3627 for (i = 0; i < hashlen; i++)
3629 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3630 *p++ = hex_digits[finalhash[i] & 0x0f];
3633 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
3634 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
3636 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
3641 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
3642 We have to save the numerical variables and restore them afterwards. */
3647 int moffset, moffsetextra, slen;
3650 const uschar *rerror;
3653 int save_expand_nmax =
3654 save_expand_strings(save_expand_nstring, save_expand_nlength);
3656 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
3658 case 1: goto EXPAND_FAILED_CURLY;
3660 case 3: goto EXPAND_FAILED;
3663 /* Compile the regular expression */
3665 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
3670 expand_string_message = string_sprintf("regular expression error in "
3671 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
3675 /* Now run a loop to do the substitutions as often as necessary. It ends
3676 when there are no more matches. Take care over matches of the null string;
3677 do the same thing as Perl does. */
3680 slen = Ustrlen(sub[0]);
3681 moffset = moffsetextra = 0;
3686 int ovector[3*(EXPAND_MAXN+1)];
3687 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
3688 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
3692 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
3693 is not necessarily the end. We want to repeat the match from one
3694 character further along, but leaving the basic offset the same (for
3695 copying below). We can't be at the end of the string - that was checked
3696 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
3697 finished; copy the remaining string and end the loop. */
3707 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
3711 /* Match - set up for expanding the replacement. */
3713 if (n == 0) n = EXPAND_MAXN + 1;
3715 for (nn = 0; nn < n*2; nn += 2)
3717 expand_nstring[expand_nmax] = subject + ovector[nn];
3718 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
3722 /* Copy the characters before the match, plus the expanded insertion. */
3724 yield = string_cat(yield, &size, &ptr, subject + moffset,
3725 ovector[0] - moffset);
3726 insert = expand_string(sub[2]);
3727 if (insert == NULL) goto EXPAND_FAILED;
3728 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
3730 moffset = ovector[1];
3734 /* If we have matched an empty string, first check to see if we are at
3735 the end of the subject. If so, the loop is over. Otherwise, mimic
3736 what Perl's /g options does. This turns out to be rather cunning. First
3737 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
3738 string at the same point. If this fails (picked up above) we advance to
3739 the next character. */
3741 if (ovector[0] == ovector[1])
3743 if (ovector[0] == slen) break;
3744 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
3748 /* All done - restore numerical variables. */
3750 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3751 save_expand_nlength);
3755 /* Handle keyed and numbered substring extraction. If the first argument
3756 consists entirely of digits, then a numerical extraction is assumed. */
3762 int field_number = 1;
3763 BOOL field_number_set = FALSE;
3764 uschar *save_lookup_value = lookup_value;
3766 int save_expand_nmax =
3767 save_expand_strings(save_expand_nstring, save_expand_nlength);
3769 /* Read the arguments */
3771 for (i = 0; i < j; i++)
3773 while (isspace(*s)) s++;
3776 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
3777 if (sub[i] == NULL) goto EXPAND_FAILED;
3778 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3780 /* After removal of leading and trailing white space, the first
3781 argument must not be empty; if it consists entirely of digits
3782 (optionally preceded by a minus sign), this is a numerical
3783 extraction, and we expect 3 arguments. */
3791 while (isspace(*p)) p++;
3795 while (len > 0 && isspace(p[len-1])) len--;
3800 expand_string_message = US"first argument of \"expand\" must not "
3810 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
3814 j = 3; /* Need 3 args */
3815 field_number_set = TRUE;
3819 else goto EXPAND_FAILED_CURLY;
3822 /* Extract either the numbered or the keyed substring into $value. If
3823 skipping, just pretend the extraction failed. */
3825 lookup_value = skipping? NULL : field_number_set?
3826 expand_gettokened(field_number, sub[1], sub[2]) :
3827 expand_getkeyed(sub[0], sub[1]);
3829 /* If no string follows, $value gets substituted; otherwise there can
3830 be yes/no strings, as for lookup or if. */
3832 switch(process_yesno(
3833 skipping, /* were previously skipping */
3834 lookup_value != NULL, /* success/failure indicator */
3835 save_lookup_value, /* value to reset for string2 */
3836 &s, /* input pointer */
3837 &yield, /* output pointer */
3838 &size, /* output size */
3839 &ptr, /* output current point */
3840 US"extract")) /* condition type */
3842 case 1: goto EXPAND_FAILED; /* when all is well, the */
3843 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3846 /* All done - restore numerical variables. */
3848 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3849 save_expand_nlength);
3855 /* If ${dlfunc support is configured, handle calling dynamically-loaded
3856 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
3857 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
3858 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
3860 #define EXPAND_DLFUNC_MAX_ARGS 8
3863 #ifndef EXPAND_DLFUNC
3864 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
3865 "is not included in this binary";
3868 #else /* EXPAND_DLFUNC */
3871 exim_dlfunc_t *func;
3874 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
3876 if ((expand_forbid & RDO_DLFUNC) != 0)
3878 expand_string_message =
3879 US"dynamically-loaded functions are not permitted";
3883 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
3886 case 1: goto EXPAND_FAILED_CURLY;
3888 case 3: goto EXPAND_FAILED;
3891 /* If skipping, we don't actually do anything */
3893 if (skipping) continue;
3895 /* Look up the dynamically loaded object handle in the tree. If it isn't
3896 found, dlopen() the file and put the handle in the tree for next time. */
3898 t = tree_search(dlobj_anchor, argv[0]);
3901 void *handle = dlopen(CS argv[0], RTLD_LAZY);
3904 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
3905 argv[0], dlerror());
3906 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
3909 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
3910 Ustrcpy(t->name, argv[0]);
3911 t->data.ptr = handle;
3912 (void)tree_insertnode(&dlobj_anchor, t);
3915 /* Having obtained the dynamically loaded object handle, look up the
3916 function pointer. */
3918 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
3921 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
3922 "%s", argv[1], argv[0], dlerror());
3923 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
3927 /* Call the function and work out what to do with the result. If it
3928 returns OK, we have a replacement string; if it returns DEFER then
3929 expansion has failed in a non-forced manner; if it returns FAIL then
3930 failure was forced; if it returns ERROR or any other value there's a
3931 problem, so panic slightly. */
3934 for (argc = 0; argv[argc] != NULL; argc++);
3935 status = func(&result, argc - 2, &argv[2]);
3938 if (result == NULL) result = US"";
3939 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
3944 expand_string_message = result == NULL ? US"(no message)" : result;
3945 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
3946 else if(status != FAIL)
3947 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
3948 argv[0], argv[1], status, expand_string_message);
3952 #endif /* EXPAND_DLFUNC */
3955 /* Control reaches here if the name is not recognized as one of the more
3956 complicated expansion items. Check for the "operator" syntax (name terminated
3957 by a colon). Some of the operators have arguments, separated by _ from the
3964 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
3965 if (sub == NULL) goto EXPAND_FAILED;
3968 /* Owing to an historical mis-design, an underscore may be part of the
3969 operator name, or it may introduce arguments. We therefore first scan the
3970 table of names that contain underscores. If there is no match, we cut off
3971 the arguments and then scan the main table. */
3973 c = chop_match(name, op_table_underscore,
3974 sizeof(op_table_underscore)/sizeof(uschar *));
3978 arg = Ustrchr(name, '_');
3979 if (arg != NULL) *arg = 0;
3980 c = chop_match(name, op_table_main,
3981 sizeof(op_table_main)/sizeof(uschar *));
3982 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
3983 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
3986 /* If we are skipping, we don't need to perform the operation at all.
3987 This matters for operations like "mask", because the data may not be
3988 in the correct format when skipping. For example, the expression may test
3989 for the existence of $sender_host_address before trying to mask it. For
3990 other operations, doing them may not fail, but it is a waste of time. */
3992 if (skipping && c >= 0) continue;
3994 /* Otherwise, switch on the operator type */
4001 unsigned long int n = Ustrtoul(sub, &t, 10);
4004 expand_string_message = string_sprintf("argument for base62 "
4005 "operator is \"%s\", which is not a decimal number", sub);
4008 t = string_base62(n);
4009 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4017 unsigned long int n = 0;
4020 uschar *t = Ustrchr(base62_chars, *tt++);
4023 expand_string_message = string_sprintf("argument for base62d "
4024 "operator is \"%s\", which is not a base 62 number", sub);
4027 n = n * 62 + (t - base62_chars);
4029 (void)sprintf(CS buf, "%ld", n);
4030 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4036 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4037 if (expanded == NULL)
4039 expand_string_message =
4040 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4041 expand_string_message);
4044 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4051 uschar *t = sub - 1;
4052 while (*(++t) != 0) { *t = tolower(*t); count++; }
4053 yield = string_cat(yield, &size, &ptr, sub, count);
4060 uschar *t = sub - 1;
4061 while (*(++t) != 0) { *t = toupper(*t); count++; }
4062 yield = string_cat(yield, &size, &ptr, sub, count);
4073 md5_end(&base, sub, Ustrlen(sub), digest);
4074 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4075 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4086 sha1_end(&base, sub, Ustrlen(sub), digest);
4087 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4088 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4092 /* Convert hex encoding to base64 encoding */
4102 for (enc = sub; *enc != 0; enc++)
4104 if (!isxdigit(*enc))
4106 expand_string_message = string_sprintf("\"%s\" is not a hex "
4115 expand_string_message = string_sprintf("\"%s\" contains an odd "
4116 "number of characters", sub);
4120 while ((c = *in++) != 0)
4122 if (isdigit(c)) c -= '0';
4123 else c = toupper(c) - 'A' + 10;
4135 enc = auth_b64encode(sub, out - sub);
4136 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4140 /* mask applies a mask to an IP address; for example the result of
4141 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4148 int mask, maskoffset;
4149 int type = string_is_ip_address(sub, &maskoffset);
4154 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4159 if (maskoffset == 0)
4161 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4166 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4168 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4170 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4175 /* Convert the address to binary integer(s) and apply the mask */
4177 sub[maskoffset] = 0;
4178 count = host_aton(sub, binary);
4179 host_mask(count, binary, mask);
4181 /* Convert to masked textual format and add to output. */
4183 yield = string_cat(yield, &size, &ptr, buffer,
4184 host_nmtoa(count, binary, mask, buffer, '.'));
4189 case EOP_LOCAL_PART:
4193 int start, end, domain;
4194 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4198 if (c != EOP_DOMAIN)
4200 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4201 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4203 else if (domain != 0)
4206 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4212 /* quote puts a string in quotes if it is empty or contains anything
4213 other than alphamerics, underscore, dot, or hyphen.
4215 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4216 be quoted in order to be a valid local part.
4218 In both cases, newlines and carriage returns are converted into \n and \r
4222 case EOP_QUOTE_LOCAL_PART:
4225 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4226 uschar *t = sub - 1;
4230 while (!needs_quote && *(++t) != 0)
4231 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4233 else /* EOP_QUOTE_LOCAL_PART */
4235 while (!needs_quote && *(++t) != 0)
4236 needs_quote = !isalnum(*t) &&
4237 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4238 (*t != '.' || t == sub || t[1] == 0);
4243 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4248 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4249 else if (*t == '\r')
4250 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4253 if (*t == '\\' || *t == '"')
4254 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4255 yield = string_cat(yield, &size, &ptr, t, 1);
4258 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4260 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4264 /* quote_lookuptype does lookup-specific quoting */
4269 uschar *opt = Ustrchr(arg, '_');
4271 if (opt != NULL) *opt++ = 0;
4273 n = search_findtype(arg, Ustrlen(arg));
4276 expand_string_message = search_error_message;
4280 if (lookup_list[n].quote != NULL)
4281 sub = (lookup_list[n].quote)(sub, opt);
4282 else if (opt != NULL) sub = NULL;
4286 expand_string_message = string_sprintf(
4287 "\"%s\" unrecognized after \"${quote_%s\"",
4292 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4296 /* rx quote sticks in \ before any non-alphameric character so that
4297 the insertion works in a regular expression. */
4301 uschar *t = sub - 1;
4305 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4306 yield = string_cat(yield, &size, &ptr, t, 1);
4311 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4312 prescribed by the RFC, if there are characters that need to be encoded */
4316 uschar buffer[2048];
4317 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4318 buffer, sizeof(buffer));
4319 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4323 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4333 if (c > 255) c = '_';
4335 yield = string_cat(yield, &size, &ptr, buff, 1);
4340 /* escape turns all non-printing characters into escape sequences. */
4344 uschar *t = string_printing(sub);
4345 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4349 /* Handle numeric expression evaluation */
4354 uschar *save_sub = sub;
4355 uschar *error = NULL;
4356 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4359 expand_string_message = string_sprintf("error in expression "
4360 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4364 sprintf(CS var_buffer, "%d", n);
4365 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4369 /* Handle time period formating */
4371 case EOP_TIME_INTERVAL:
4374 uschar *t = read_number(&n, sub);
4375 if (*t != 0) /* Not A Number*/
4377 expand_string_message = string_sprintf("string \"%s\" is not a "
4378 "positive number in \"%s\" operator", sub, name);
4381 t = readconf_printtime(n);
4382 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4386 /* Convert string to base64 encoding */
4390 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4391 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4395 /* strlen returns the length of the string */
4400 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4401 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4405 /* length_n or l_n takes just the first n characters or the whole string,
4406 whichever is the shorter;
4408 substr_m_n, and s_m_n take n characters from offset m; negative m take
4409 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4410 takes the rest, either to the right or to the left.
4412 hash_n or h_n makes a hash of length n from the string, yielding n
4413 characters from the set a-z; hash_n_m makes a hash of length n, but
4414 uses m characters from the set a-zA-Z0-9.
4416 nhash_n returns a single number between 0 and n-1 (in text form), while
4417 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4418 between 0 and n-1 and the second between 0 and m-1. */
4438 expand_string_message = string_sprintf("missing values after %s",
4443 /* "length" has only one argument, effectively being synonymous with
4446 if (c == EOP_LENGTH || c == EOP_L)
4452 /* The others have one or two arguments; for "substr" the first may be
4453 negative. The second being negative means "not supplied". */
4458 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
4461 /* Read up to two numbers, separated by underscores */
4466 if (arg != ret && *arg == '_' && pn == &value1)
4470 if (arg[1] != 0) arg++;
4472 else if (!isdigit(*arg))
4474 expand_string_message =
4475 string_sprintf("non-digit after underscore in \"%s\"", name);
4478 else *pn = (*pn)*10 + *arg++ - '0';
4482 /* Perform the required operation */
4485 (c == EOP_HASH || c == EOP_H)?
4486 compute_hash(sub, value1, value2, &len) :
4487 (c == EOP_NHASH || c == EOP_NH)?
4488 compute_nhash(sub, value1, value2, &len) :
4489 extract_substr(sub, value1, value2, &len);
4491 if (ret == NULL) goto EXPAND_FAILED;
4492 yield = string_cat(yield, &size, &ptr, ret, len);
4502 uschar **modetable[3];
4507 if (stat(CS sub, &st) < 0)
4509 expand_string_message = string_sprintf("stat(%s) failed: %s",
4510 sub, strerror(errno));
4514 switch (mode & S_IFMT)
4516 case S_IFIFO: smode[0] = 'p'; break;
4517 case S_IFCHR: smode[0] = 'c'; break;
4518 case S_IFDIR: smode[0] = 'd'; break;
4519 case S_IFBLK: smode[0] = 'b'; break;
4520 case S_IFREG: smode[0] = '-'; break;
4521 default: smode[0] = '?'; break;
4524 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
4525 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
4526 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
4528 for (i = 0; i < 3; i++)
4530 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
4535 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
4536 "uid=%ld gid=%ld size=%ld atime=%ld mtime=%ld ctime=%ld",
4537 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
4538 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
4539 (long)st.st_gid, (long)st.st_size, (long)st.st_atime,
4540 (long)st.st_mtime, (long)st.st_ctime);
4541 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
4545 /* Unknown operator */
4548 expand_string_message =
4549 string_sprintf("unknown expansion operator \"%s\"", name);
4554 /* Handle a plain name. If this is the first thing in the expansion, release
4555 the pre-allocated buffer. If the result data is known to be in a new buffer,
4556 newsize will be set to the size of that buffer, and we can just point at that
4557 store instead of copying. Many expansion strings contain just one reference,
4558 so this is a useful optimization, especially for humungous headers
4559 ($message_headers). */
4571 value = find_variable(name, FALSE, skipping, &newsize);
4574 expand_string_message =
4575 string_sprintf("unknown variable in \"${%s}\"", name);
4578 len = Ustrlen(value);
4579 if (yield == NULL && newsize != 0)
4585 else yield = string_cat(yield, &size, &ptr, value, len);
4589 /* Else there's something wrong */
4591 expand_string_message =
4592 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
4593 "in a variable reference)", name);
4597 /* If we hit the end of the string when ket_ends is set, there is a missing
4598 terminating brace. */
4600 if (ket_ends && *s == 0)
4602 expand_string_message = malformed_header?
4603 US"missing } at end of string - could be header name not terminated by colon"
4605 US"missing } at end of string";
4609 /* Expansion succeeded; yield may still be NULL here if nothing was actually
4610 added to the string. If so, set up an empty string. Add a terminating zero. If
4611 left != NULL, return a pointer to the terminator. */
4613 if (yield == NULL) yield = store_get(1);
4615 if (left != NULL) *left = s;
4617 /* Any stacking store that was used above the final string is no longer needed.
4618 In many cases the final string will be the first one that was got and so there
4619 will be optimal store usage. */
4621 store_reset(yield + ptr + 1);
4624 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
4626 if (skipping) debug_printf("skipping: result is not used\n");
4630 /* This is the failure exit: easiest to program with a goto. We still need
4631 to update the pointer to the terminator, for cases of nested calls with "fail".
4634 EXPAND_FAILED_CURLY:
4635 expand_string_message = malformed_header?
4636 US"missing or misplaced { or } - could be header name not terminated by colon"
4638 US"missing or misplaced { or }";
4640 /* At one point, Exim reset the store to yield (if yield was not NULL), but
4641 that is a bad idea, because expand_string_message is in dynamic store. */
4644 if (left != NULL) *left = s;
4647 debug_printf("failed to expand: %s\n", string);
4648 debug_printf(" error message: %s\n", expand_string_message);
4649 if (expand_string_forcedfail) debug_printf("failure was forced\n");
4655 /* This is the external function call. Do a quick check for any expansion
4656 metacharacters, and if there are none, just return the input string.
4658 Argument: the string to be expanded
4659 Returns: the expanded string, or NULL if expansion failed; if failure was
4660 due to a lookup deferring, search_find_defer will be TRUE
4664 expand_string(uschar *string)
4666 search_find_defer = FALSE;
4667 malformed_header = FALSE;
4668 return (Ustrpbrk(string, "$\\") == NULL)? string :
4669 expand_string_internal(string, FALSE, NULL, FALSE);
4674 /*************************************************
4676 *************************************************/
4678 /* Now and again we want to expand a string and be sure that the result is in a
4679 new bit of store. This function does that.
4681 Argument: the string to be expanded
4682 Returns: the expanded string, always in a new bit of store, or NULL
4686 expand_string_copy(uschar *string)
4688 uschar *yield = expand_string(string);
4689 if (yield == string) yield = string_copy(string);
4695 /*************************************************
4696 * Expand and interpret as an integer *
4697 *************************************************/
4699 /* Expand a string, and convert the result into an integer.
4701 Argument: the string to be expanded
4703 Returns: the integer value, or
4704 -1 for an expansion error ) in both cases, message in
4705 -2 for an integer interpretation error ) expand_string_message
4710 expand_string_integer(uschar *string)
4713 uschar *s = expand_string(string);
4714 uschar *msg = US"invalid integer \"%s\"";
4717 if (s == NULL) return -1;
4719 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
4720 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
4721 systems, so we set it zero ourselves. */
4724 value = strtol(CS s, CSS &endptr, 0);
4728 msg = US"integer expected but \"%s\" found";
4732 /* Ensure we can cast this down to an int */
4733 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
4735 if (errno != ERANGE)
4737 if (tolower(*endptr) == 'k')
4739 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
4743 else if (tolower(*endptr) == 'm')
4745 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
4747 else value *= 1024*1024;
4751 if (errno == ERANGE)
4752 msg = US"absolute value of integer \"%s\" is too large (overflow)";
4755 while (isspace(*endptr)) endptr++;
4756 if (*endptr == 0) return (int)value;
4760 expand_string_message = string_sprintf(CS msg, s);
4766 /*************************************************
4767 **************************************************
4768 * Stand-alone test program *
4769 **************************************************
4770 *************************************************/
4776 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
4778 int ovector[3*(EXPAND_MAXN+1)];
4779 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
4780 ovector, sizeof(ovector)/sizeof(int));
4781 BOOL yield = n >= 0;
4782 if (n == 0) n = EXPAND_MAXN + 1;
4786 expand_nmax = (setup < 0)? 0 : setup + 1;
4787 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
4789 expand_nstring[expand_nmax] = subject + ovector[nn];
4790 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4798 int main(int argc, uschar **argv)
4801 uschar buffer[1024];
4803 debug_selector = D_v;
4804 debug_file = stderr;
4805 debug_fd = fileno(debug_file);
4806 big_buffer = malloc(big_buffer_size);
4808 for (i = 1; i < argc; i++)
4810 if (argv[i][0] == '+')
4812 debug_trace_memory = 2;
4815 if (isdigit(argv[i][0]))
4816 debug_selector = Ustrtol(argv[i], NULL, 0);
4818 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
4822 eldap_default_servers = argv[i];
4825 mysql_servers = argv[i];
4828 pgsql_servers = argv[i];
4832 else opt_perl_startup = argv[i];
4836 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
4838 expand_nstring[1] = US"string 1....";
4839 expand_nlength[1] = 8;
4843 if (opt_perl_startup != NULL)
4846 printf("Starting Perl interpreter\n");
4847 errstr = init_perl(opt_perl_startup);
4850 printf("** error in perl_startup code: %s\n", errstr);
4851 return EXIT_FAILURE;
4854 #endif /* EXIM_PERL */
4856 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
4858 void *reset_point = store_get(0);
4859 uschar *yield = expand_string(buffer);
4862 printf("%s\n", yield);
4863 store_reset(reset_point);
4867 if (search_find_defer) printf("search_find deferred\n");
4868 printf("Failed: %s\n", expand_string_message);
4869 if (expand_string_forcedfail) printf("Forced failure\n");
4881 /* End of expand.c */