1 /* $Cambridge: exim/src/src/expand.c,v 1.12 2005/01/25 14:16:33 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[] = {
86 /* Tables of operator names, and corresponding switch numbers. The names must be
87 in alphabetical order. There are two tables, because underscore is used in some
88 cases to introduce arguments, whereas for other it is part of the name. This is
89 an historical mis-design. */
91 static uschar *op_table_underscore[] = {
100 EOP_QUOTE_LOCAL_PART,
103 static uschar *op_table_main[] = {
134 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
164 /* Table of condition names, and corresponding switch numbers. The names must
165 be in alphabetical order. */
167 static uschar *cond_table[] = {
171 US"==", /* Backward compatibility */
196 US"match_local_part",
218 ECOND_FIRST_DELIVERY,
234 ECOND_MATCH_LOCAL_PART,
244 /* Type for main variable table */
252 /* Type for entries pointing to address/length pairs. Not currently
260 /* Types of table entry */
263 vtype_int, /* value is address of int */
264 vtype_filter_int, /* ditto, but recognized only when filtering */
265 vtype_ino, /* value is address of ino_t (not always an int) */
266 vtype_uid, /* value is address of uid_t (not always an int) */
267 vtype_gid, /* value is address of gid_t (not always an int) */
268 vtype_stringptr, /* value is address of pointer to string */
269 vtype_msgbody, /* as stringptr, but read when first required */
270 vtype_msgbody_end, /* ditto, the end of the message */
271 vtype_msgheaders, /* the message's headers */
272 vtype_localpart, /* extract local part from string */
273 vtype_domain, /* extract domain from string */
274 vtype_recipients, /* extract recipients from recipients list */
275 /* (enabled only during system filtering */
276 vtype_todbsdin, /* value not used; generate BSD inbox tod */
277 vtype_tode, /* value not used; generate tod in epoch format */
278 vtype_todf, /* value not used; generate full tod */
279 vtype_todl, /* value not used; generate log tod */
280 vtype_todlf, /* value not used; generate log file datestamp tod */
281 vtype_todzone, /* value not used; generate time zone only */
282 vtype_todzulu, /* value not used; generate zulu tod */
283 vtype_reply, /* value not used; get reply from headers */
284 vtype_pid, /* value not used; result is pid */
285 vtype_host_lookup, /* value not used; get host name */
286 vtype_load_avg, /* value not used; result is int from os_getloadavg */
287 vtype_pspace, /* partition space; value is T/F for spool/log */
288 vtype_pinodes /* partition inodes; value is T/F for spool/log */
291 /* This table must be kept in alphabetical order. */
293 static var_entry var_table[] = {
294 { "acl_c0", vtype_stringptr, &acl_var[0] },
295 { "acl_c1", vtype_stringptr, &acl_var[1] },
296 { "acl_c2", vtype_stringptr, &acl_var[2] },
297 { "acl_c3", vtype_stringptr, &acl_var[3] },
298 { "acl_c4", vtype_stringptr, &acl_var[4] },
299 { "acl_c5", vtype_stringptr, &acl_var[5] },
300 { "acl_c6", vtype_stringptr, &acl_var[6] },
301 { "acl_c7", vtype_stringptr, &acl_var[7] },
302 { "acl_c8", vtype_stringptr, &acl_var[8] },
303 { "acl_c9", vtype_stringptr, &acl_var[9] },
304 { "acl_m0", vtype_stringptr, &acl_var[10] },
305 { "acl_m1", vtype_stringptr, &acl_var[11] },
306 { "acl_m2", vtype_stringptr, &acl_var[12] },
307 { "acl_m3", vtype_stringptr, &acl_var[13] },
308 { "acl_m4", vtype_stringptr, &acl_var[14] },
309 { "acl_m5", vtype_stringptr, &acl_var[15] },
310 { "acl_m6", vtype_stringptr, &acl_var[16] },
311 { "acl_m7", vtype_stringptr, &acl_var[17] },
312 { "acl_m8", vtype_stringptr, &acl_var[18] },
313 { "acl_m9", vtype_stringptr, &acl_var[19] },
314 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
315 { "address_data", vtype_stringptr, &deliver_address_data },
316 { "address_file", vtype_stringptr, &address_file },
317 { "address_pipe", vtype_stringptr, &address_pipe },
318 { "authenticated_id", vtype_stringptr, &authenticated_id },
319 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
320 { "authentication_failed",vtype_int, &authentication_failed },
321 #ifdef EXPERIMENTAL_BRIGHTMAIL
322 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
323 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
324 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
325 { "bmi_deliver", vtype_int, &bmi_deliver },
327 { "body_linecount", vtype_int, &body_linecount },
328 { "body_zerocount", vtype_int, &body_zerocount },
329 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
330 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
331 { "caller_gid", vtype_gid, &real_gid },
332 { "caller_uid", vtype_uid, &real_uid },
333 { "compile_date", vtype_stringptr, &version_date },
334 { "compile_number", vtype_stringptr, &version_cnumber },
335 #ifdef WITH_OLD_DEMIME
336 { "demime_errorlevel", vtype_int, &demime_errorlevel },
337 { "demime_reason", vtype_stringptr, &demime_reason },
339 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
340 { "dnslist_text", vtype_stringptr, &dnslist_text },
341 { "dnslist_value", vtype_stringptr, &dnslist_value },
342 { "domain", vtype_stringptr, &deliver_domain },
343 { "domain_data", vtype_stringptr, &deliver_domain_data },
344 { "exim_gid", vtype_gid, &exim_gid },
345 { "exim_path", vtype_stringptr, &exim_path },
346 { "exim_uid", vtype_uid, &exim_uid },
347 #ifdef WITH_OLD_DEMIME
348 { "found_extension", vtype_stringptr, &found_extension },
350 { "home", vtype_stringptr, &deliver_home },
351 { "host", vtype_stringptr, &deliver_host },
352 { "host_address", vtype_stringptr, &deliver_host_address },
353 { "host_data", vtype_stringptr, &host_data },
354 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
355 { "host_lookup_failed", vtype_int, &host_lookup_failed },
356 { "inode", vtype_ino, &deliver_inode },
357 { "interface_address", vtype_stringptr, &interface_address },
358 { "interface_port", vtype_int, &interface_port },
360 { "ldap_dn", vtype_stringptr, &eldap_dn },
362 { "load_average", vtype_load_avg, NULL },
363 { "local_part", vtype_stringptr, &deliver_localpart },
364 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
365 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
366 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
367 { "local_scan_data", vtype_stringptr, &local_scan_data },
368 { "local_user_gid", vtype_gid, &local_user_gid },
369 { "local_user_uid", vtype_uid, &local_user_uid },
370 { "localhost_number", vtype_int, &host_number },
371 { "log_inodes", vtype_pinodes, (void *)FALSE },
372 { "log_space", vtype_pspace, (void *)FALSE },
373 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
374 #ifdef WITH_CONTENT_SCAN
375 { "malware_name", vtype_stringptr, &malware_name },
377 { "message_age", vtype_int, &message_age },
378 { "message_body", vtype_msgbody, &message_body },
379 { "message_body_end", vtype_msgbody_end, &message_body_end },
380 { "message_body_size", vtype_int, &message_body_size },
381 { "message_headers", vtype_msgheaders, NULL },
382 { "message_id", vtype_stringptr, &message_id },
383 { "message_size", vtype_int, &message_size },
384 #ifdef WITH_CONTENT_SCAN
385 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
386 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
387 { "mime_boundary", vtype_stringptr, &mime_boundary },
388 { "mime_charset", vtype_stringptr, &mime_charset },
389 { "mime_content_description", vtype_stringptr, &mime_content_description },
390 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
391 { "mime_content_id", vtype_stringptr, &mime_content_id },
392 { "mime_content_size", vtype_int, &mime_content_size },
393 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
394 { "mime_content_type", vtype_stringptr, &mime_content_type },
395 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
396 { "mime_filename", vtype_stringptr, &mime_filename },
397 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
398 { "mime_is_multipart", vtype_int, &mime_is_multipart },
399 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
400 { "mime_part_count", vtype_int, &mime_part_count },
402 { "n0", vtype_filter_int, &filter_n[0] },
403 { "n1", vtype_filter_int, &filter_n[1] },
404 { "n2", vtype_filter_int, &filter_n[2] },
405 { "n3", vtype_filter_int, &filter_n[3] },
406 { "n4", vtype_filter_int, &filter_n[4] },
407 { "n5", vtype_filter_int, &filter_n[5] },
408 { "n6", vtype_filter_int, &filter_n[6] },
409 { "n7", vtype_filter_int, &filter_n[7] },
410 { "n8", vtype_filter_int, &filter_n[8] },
411 { "n9", vtype_filter_int, &filter_n[9] },
412 { "original_domain", vtype_stringptr, &deliver_domain_orig },
413 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
414 { "originator_gid", vtype_gid, &originator_gid },
415 { "originator_uid", vtype_uid, &originator_uid },
416 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
417 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
418 { "pid", vtype_pid, NULL },
419 { "primary_hostname", vtype_stringptr, &primary_hostname },
420 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
421 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
422 { "rcpt_count", vtype_int, &rcpt_count },
423 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
424 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
425 { "received_count", vtype_int, &received_count },
426 { "received_for", vtype_stringptr, &received_for },
427 { "received_protocol", vtype_stringptr, &received_protocol },
428 { "recipient_data", vtype_stringptr, &recipient_data },
429 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
430 { "recipients", vtype_recipients, NULL },
431 { "recipients_count", vtype_int, &recipients_count },
432 #ifdef WITH_CONTENT_SCAN
433 { "regex_match_string", vtype_stringptr, ®ex_match_string },
435 { "reply_address", vtype_reply, NULL },
436 { "return_path", vtype_stringptr, &return_path },
437 { "return_size_limit", vtype_int, &bounce_return_size_limit },
438 { "runrc", vtype_int, &runrc },
439 { "self_hostname", vtype_stringptr, &self_hostname },
440 { "sender_address", vtype_stringptr, &sender_address },
441 { "sender_address_data", vtype_stringptr, &sender_address_data },
442 { "sender_address_domain", vtype_domain, &sender_address },
443 { "sender_address_local_part", vtype_localpart, &sender_address },
444 { "sender_data", vtype_stringptr, &sender_data },
445 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
446 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
447 { "sender_host_address", vtype_stringptr, &sender_host_address },
448 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
449 { "sender_host_name", vtype_host_lookup, NULL },
450 { "sender_host_port", vtype_int, &sender_host_port },
451 { "sender_ident", vtype_stringptr, &sender_ident },
452 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
453 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
454 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
455 { "smtp_command_argument", vtype_stringptr, &smtp_command_argument },
456 { "sn0", vtype_filter_int, &filter_sn[0] },
457 { "sn1", vtype_filter_int, &filter_sn[1] },
458 { "sn2", vtype_filter_int, &filter_sn[2] },
459 { "sn3", vtype_filter_int, &filter_sn[3] },
460 { "sn4", vtype_filter_int, &filter_sn[4] },
461 { "sn5", vtype_filter_int, &filter_sn[5] },
462 { "sn6", vtype_filter_int, &filter_sn[6] },
463 { "sn7", vtype_filter_int, &filter_sn[7] },
464 { "sn8", vtype_filter_int, &filter_sn[8] },
465 { "sn9", vtype_filter_int, &filter_sn[9] },
466 #ifdef WITH_CONTENT_SCAN
467 { "spam_bar", vtype_stringptr, &spam_bar },
468 { "spam_report", vtype_stringptr, &spam_report },
469 { "spam_score", vtype_stringptr, &spam_score },
470 { "spam_score_int", vtype_stringptr, &spam_score_int },
472 #ifdef EXPERIMENTAL_SPF
473 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
474 { "spf_received", vtype_stringptr, &spf_received },
475 { "spf_result", vtype_stringptr, &spf_result },
476 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
478 { "spool_directory", vtype_stringptr, &spool_directory },
479 { "spool_inodes", vtype_pinodes, (void *)TRUE },
480 { "spool_space", vtype_pspace, (void *)TRUE },
481 #ifdef EXPERIMENTAL_SRS
482 { "srs_db_address", vtype_stringptr, &srs_db_address },
483 { "srs_db_key", vtype_stringptr, &srs_db_key },
484 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
485 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
486 { "srs_recipient", vtype_stringptr, &srs_recipient },
487 { "srs_status", vtype_stringptr, &srs_status },
489 { "thisaddress", vtype_stringptr, &filter_thisaddress },
490 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
491 { "tls_cipher", vtype_stringptr, &tls_cipher },
492 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
493 { "tod_bsdinbox", vtype_todbsdin, NULL },
494 { "tod_epoch", vtype_tode, NULL },
495 { "tod_full", vtype_todf, NULL },
496 { "tod_log", vtype_todl, NULL },
497 { "tod_logfile", vtype_todlf, NULL },
498 { "tod_zone", vtype_todzone, NULL },
499 { "tod_zulu", vtype_todzulu, NULL },
500 { "value", vtype_stringptr, &lookup_value },
501 { "version_number", vtype_stringptr, &version_string },
502 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
503 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
504 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
505 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
506 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
507 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
510 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
511 static uschar var_buffer[256];
512 static BOOL malformed_header;
514 /* For textual hashes */
516 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
517 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
520 enum { HMAC_MD5, HMAC_SHA1 };
522 /* For numeric hashes */
524 static unsigned int prime[] = {
525 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
526 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
527 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
529 /* For printing modes in symbolic form */
531 static uschar *mtable_normal[] =
532 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
534 static uschar *mtable_setid[] =
535 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
537 static uschar *mtable_sticky[] =
538 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
542 /*************************************************
543 * Tables for UTF-8 support *
544 *************************************************/
546 /* Table of the number of extra characters, indexed by the first character
547 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
550 static uschar utf8_table1[] = {
551 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
552 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
553 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
554 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
556 /* These are the masks for the data bits in the first byte of a character,
557 indexed by the number of additional bytes. */
559 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
561 /* Get the next UTF-8 character, advancing the pointer. */
563 #define GETUTF8INC(c, ptr) \
565 if ((c & 0xc0) == 0xc0) \
567 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
569 c = (c & utf8_table2[a]) << s; \
573 c |= (*ptr++ & 0x3f) << s; \
578 /*************************************************
579 * Binary chop search on a table *
580 *************************************************/
582 /* This is used for matching expansion items and operators.
585 name the name that is being sought
586 table the table to search
587 table_size the number of items in the table
589 Returns: the offset in the table, or -1
593 chop_match(uschar *name, uschar **table, int table_size)
595 uschar **bot = table;
596 uschar **top = table + table_size;
600 uschar **mid = bot + (top - bot)/2;
601 int c = Ustrcmp(name, *mid);
602 if (c == 0) return mid - table;
603 if (c > 0) bot = mid + 1; else top = mid;
611 /*************************************************
612 * Check a condition string *
613 *************************************************/
615 /* This function is called to expand a string, and test the result for a "true"
616 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
617 forced fail or lookup defer. All store used by the function can be released on
621 condition the condition string
622 m1 text to be incorporated in panic error
625 Returns: TRUE if condition is met, FALSE if not
629 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
632 void *reset_point = store_get(0);
633 uschar *ss = expand_string(condition);
636 if (!expand_string_forcedfail && !search_find_defer)
637 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
638 "for %s %s: %s", condition, m1, m2, expand_string_message);
641 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
642 strcmpic(ss, US"false") != 0;
643 store_reset(reset_point);
649 /*************************************************
650 * Pick out a name from a string *
651 *************************************************/
653 /* If the name is too long, it is silently truncated.
656 name points to a buffer into which to put the name
657 max is the length of the buffer
658 s points to the first alphabetic character of the name
659 extras chars other than alphanumerics to permit
661 Returns: pointer to the first character after the name
663 Note: The test for *s != 0 in the while loop is necessary because
664 Ustrchr() yields non-NULL if the character is zero (which is not something
668 read_name(uschar *name, int max, uschar *s, uschar *extras)
671 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
673 if (ptr < max-1) name[ptr++] = *s;
682 /*************************************************
683 * Pick out the rest of a header name *
684 *************************************************/
686 /* A variable name starting $header_ (or just $h_ for those who like
687 abbreviations) might not be the complete header name because headers can
688 contain any printing characters in their names, except ':'. This function is
689 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
690 on the end, if the name was terminated by white space.
693 name points to a buffer in which the name read so far exists
694 max is the length of the buffer
695 s points to the first character after the name so far, i.e. the
696 first non-alphameric character after $header_xxxxx
698 Returns: a pointer to the first character after the header name
702 read_header_name(uschar *name, int max, uschar *s)
704 int prelen = Ustrchr(name, '_') - name + 1;
705 int ptr = Ustrlen(name) - prelen;
706 if (ptr > 0) memmove(name, name+prelen, ptr);
707 while (mac_isgraph(*s) && *s != ':')
709 if (ptr < max-1) name[ptr++] = *s;
720 /*************************************************
721 * Pick out a number from a string *
722 *************************************************/
725 n points to an integer into which to put the number
726 s points to the first digit of the number
728 Returns: a pointer to the character after the last digit
732 read_number(int *n, uschar *s)
735 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
741 /*************************************************
742 * Extract keyed subfield from a string *
743 *************************************************/
745 /* The yield is in dynamic store; NULL means that the key was not found.
748 key points to the name of the key
749 s points to the string from which to extract the subfield
751 Returns: NULL if the subfield was not found, or
752 a pointer to the subfield's data
756 expand_getkeyed(uschar *key, uschar *s)
758 int length = Ustrlen(key);
759 while (isspace(*s)) s++;
761 /* Loop to search for the key */
769 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
770 dkeylength = s - dkey;
771 while (isspace(*s)) s++;
772 if (*s == '=') while (isspace((*(++s))));
774 data = string_dequote(&s);
775 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
778 while (isspace(*s)) s++;
787 /*************************************************
788 * Extract numbered subfield from string *
789 *************************************************/
791 /* Extracts a numbered field from a string that is divided by tokens - for
792 example a line from /etc/passwd is divided by colon characters. First field is
793 numbered one. Negative arguments count from the right. Zero returns the whole
794 string. Returns NULL if there are insufficient tokens in the string
797 Modifies final argument - this is a dynamically generated string, so that's OK.
800 field number of field to be extracted,
801 first field = 1, whole string = 0, last field = -1
802 separators characters that are used to break string into tokens
803 s points to the string from which to extract the subfield
805 Returns: NULL if the field was not found,
806 a pointer to the field's data inside s (modified to add 0)
810 expand_gettokened (int field, uschar *separators, uschar *s)
815 uschar *fieldtext = NULL;
817 if (field == 0) return s;
819 /* Break the line up into fields in place; for field > 0 we stop when we have
820 done the number of fields we want. For field < 0 we continue till the end of
821 the string, counting the number of fields. */
823 count = (field > 0)? field : INT_MAX;
829 /* Previous field was the last one in the string. For a positive field
830 number, this means there are not enough fields. For a negative field number,
831 check that there are enough, and scan back to find the one that is wanted. */
835 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
836 if ((-field) == (INT_MAX - count - 1)) return s;
840 while (ss[-1] != 0) ss--;
846 /* Previous field was not last in the string; save its start and put a
850 len = Ustrcspn(ss, separators);
861 /*************************************************
862 * Extract a substring from a string *
863 *************************************************/
865 /* Perform the ${substr or ${length expansion operations.
868 subject the input string
869 value1 the offset from the start of the input string to the start of
870 the output string; if negative, count from the right.
871 value2 the length of the output string, or negative (-1) for unset
872 if value1 is positive, unset means "all after"
873 if value1 is negative, unset means "all before"
874 len set to the length of the returned string
876 Returns: pointer to the output string, or NULL if there is an error
880 extract_substr(uschar *subject, int value1, int value2, int *len)
882 int sublen = Ustrlen(subject);
884 if (value1 < 0) /* count from right */
888 /* If the position is before the start, skip to the start, and adjust the
889 length. If the length ends up negative, the substring is null because nothing
890 can precede. This falls out naturally when the length is unset, meaning "all
896 if (value2 < 0) value2 = 0;
900 /* Otherwise an unset length => characters before value1 */
909 /* For a non-negative offset, if the starting position is past the end of the
910 string, the result will be the null string. Otherwise, an unset length means
911 "rest"; just set it to the maximum - it will be cut down below if necessary. */
920 else if (value2 < 0) value2 = sublen;
923 /* Cut the length down to the maximum possible for the offset value, and get
924 the required characters. */
926 if (value1 + value2 > sublen) value2 = sublen - value1;
928 return subject + value1;
934 /*************************************************
935 * Old-style hash of a string *
936 *************************************************/
938 /* Perform the ${hash expansion operation.
941 subject the input string (an expanded substring)
942 value1 the length of the output string; if greater or equal to the
943 length of the input string, the input string is returned
944 value2 the number of hash characters to use, or 26 if negative
945 len set to the length of the returned string
947 Returns: pointer to the output string, or NULL if there is an error
951 compute_hash(uschar *subject, int value1, int value2, int *len)
953 int sublen = Ustrlen(subject);
955 if (value2 < 0) value2 = 26;
956 else if (value2 > Ustrlen(hashcodes))
958 expand_string_message =
959 string_sprintf("hash count \"%d\" too big", value2);
963 /* Calculate the hash text. We know it is shorter than the original string, so
964 can safely place it in subject[] (we know that subject is always itself an
965 expanded substring). */
972 while ((c = (subject[j])) != 0)
974 int shift = (c + j++) & 7;
975 subject[i] ^= (c << shift) | (c >> (8-shift));
976 if (++i >= value1) i = 0;
978 for (i = 0; i < value1; i++)
979 subject[i] = hashcodes[(subject[i]) % value2];
981 else value1 = sublen;
990 /*************************************************
991 * Numeric hash of a string *
992 *************************************************/
994 /* Perform the ${nhash expansion operation. The first characters of the
995 string are treated as most important, and get the highest prime numbers.
998 subject the input string
999 value1 the maximum value of the first part of the result
1000 value2 the maximum value of the second part of the result,
1001 or negative to produce only a one-part result
1002 len set to the length of the returned string
1004 Returns: pointer to the output string, or NULL if there is an error.
1008 compute_nhash (uschar *subject, int value1, int value2, int *len)
1010 uschar *s = subject;
1012 unsigned long int total = 0; /* no overflow */
1016 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1017 total += prime[i--] * (unsigned int)(*s++);
1020 /* If value2 is unset, just compute one number */
1024 s = string_sprintf("%d", total % value1);
1027 /* Otherwise do a div/mod hash */
1031 total = total % (value1 * value2);
1032 s = string_sprintf("%d/%d", total/value2, total % value2);
1043 /*************************************************
1044 * Find the value of a header or headers *
1045 *************************************************/
1047 /* Multiple instances of the same header get concatenated, and this function
1048 can also return a concatenation of all the header lines. When concatenating
1049 specific headers that contain lists of addresses, a comma is inserted between
1050 them. Otherwise we use a straight concatenation. Because some messages can have
1051 pathologically large number of lines, there is a limit on the length that is
1052 returned. Also, to avoid massive store use which would result from using
1053 string_cat() as it copies and extends strings, we do a preliminary pass to find
1054 out exactly how much store will be needed. On "normal" messages this will be
1058 name the name of the header, without the leading $header_ or $h_,
1059 or NULL if a concatenation of all headers is required
1060 exists_only TRUE if called from a def: test; don't need to build a string;
1061 just return a string that is not "" and not "0" if the header
1063 newsize return the size of memory block that was obtained; may be NULL
1064 if exists_only is TRUE
1065 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1066 other than concatenating, will be done on the header
1067 charset name of charset to translate MIME words to; used only if
1068 want_raw is false; if NULL, no translation is done (this is
1069 used for $bh_ and $bheader_)
1071 Returns: NULL if the header does not exist, else a pointer to a new
1076 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1079 BOOL found = name == NULL;
1081 int len = found? 0 : Ustrlen(name);
1083 uschar *yield = NULL;
1086 /* Loop for two passes - saves code repetition */
1088 for (i = 0; i < 2; i++)
1093 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1095 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1097 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1102 if (exists_only) return US"1"; /* don't need actual string */
1104 t = h->text + len; /* text to insert */
1105 if (!want_raw) /* unless wanted raw, */
1106 while (isspace(*t)) t++; /* remove leading white space */
1107 ilen = h->slen - (t - h->text); /* length to insert */
1109 /* Set comma = 1 if handling a single header and it's one of those
1110 that contains an address list, except when asked for raw headers. Only
1111 need to do this once. */
1113 if (!want_raw && name != NULL && comma == 0 &&
1114 Ustrchr("BCFRST", h->type) != NULL)
1117 /* First pass - compute total store needed; second pass - compute
1118 total store used, including this header. */
1120 size += ilen + comma;
1122 /* Second pass - concatentate the data, up to a maximum. Note that
1123 the loop stops when size hits the limit. */
1127 if (size > header_insert_maxlen)
1129 ilen -= size - header_insert_maxlen;
1132 Ustrncpy(ptr, t, ilen);
1134 if (comma != 0 && ilen > 0)
1144 /* At end of first pass, truncate size if necessary, and get the buffer
1145 to hold the data, returning the buffer size. */
1149 if (!found) return NULL;
1150 if (size > header_insert_maxlen) size = header_insert_maxlen;
1151 *newsize = size + 1;
1152 ptr = yield = store_get(*newsize);
1156 /* Remove a redundant added comma if present */
1158 if (comma != 0 && ptr > yield) ptr -= 2;
1160 /* That's all we do for raw header expansion. */
1167 /* Otherwise, we remove trailing whitespace, including newlines. Then we do RFC
1168 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1169 function can return an error with decoded data if the charset translation
1170 fails. If decoding fails, it returns NULL. */
1174 uschar *decoded, *error;
1175 while (ptr > yield && isspace(ptr[-1])) ptr--;
1177 decoded = rfc2047_decode2(yield, TRUE, charset, '?', NULL, newsize, &error);
1180 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1181 " input was: %s\n", error, yield);
1183 if (decoded != NULL) yield = decoded;
1192 /*************************************************
1193 * Find value of a variable *
1194 *************************************************/
1196 /* The table of variables is kept in alphabetic order, so we can search it
1197 using a binary chop. The "choplen" variable is nothing to do with the binary
1201 name the name of the variable being sought
1202 exists_only TRUE if this is a def: test; passed on to find_header()
1203 skipping TRUE => skip any processing evaluation; this is not the same as
1204 exists_only because def: may test for values that are first
1206 newsize pointer to an int which is initially zero; if the answer is in
1207 a new memory buffer, *newsize is set to its size
1209 Returns: NULL if the variable does not exist, or
1210 a pointer to the variable's contents, or
1211 something non-NULL if exists_only is TRUE
1215 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1218 int last = var_table_size;
1220 while (last > first)
1224 int middle = (first + last)/2;
1225 int c = Ustrcmp(name, var_table[middle].name);
1227 if (c > 0) { first = middle + 1; continue; }
1228 if (c < 0) { last = middle; continue; }
1230 /* Found an existing variable. If in skipping state, the value isn't needed,
1231 and we want to avoid processing (such as looking up up the host name). */
1233 if (skipping) return US"";
1235 switch (var_table[middle].type)
1237 case vtype_filter_int:
1238 if (!filter_running) return NULL;
1242 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1246 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1250 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1254 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1257 case vtype_stringptr: /* Pointer to string */
1258 s = *((uschar **)(var_table[middle].value));
1259 return (s == NULL)? US"" : s;
1262 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1265 case vtype_load_avg:
1266 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1269 case vtype_host_lookup: /* Lookup if not done so */
1270 if (sender_host_name == NULL && sender_host_address != NULL &&
1271 !host_lookup_failed && host_name_lookup() == OK)
1272 host_build_sender_fullhost();
1273 return (sender_host_name == NULL)? US"" : sender_host_name;
1275 case vtype_localpart: /* Get local part from address */
1276 s = *((uschar **)(var_table[middle].value));
1277 if (s == NULL) return US"";
1278 domain = Ustrrchr(s, '@');
1279 if (domain == NULL) return s;
1280 if (domain - s > sizeof(var_buffer) - 1)
1281 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1282 "string expansion", sizeof(var_buffer));
1283 Ustrncpy(var_buffer, s, domain - s);
1284 var_buffer[domain - s] = 0;
1287 case vtype_domain: /* Get domain from address */
1288 s = *((uschar **)(var_table[middle].value));
1289 if (s == NULL) return US"";
1290 domain = Ustrrchr(s, '@');
1291 return (domain == NULL)? US"" : domain + 1;
1293 case vtype_msgheaders:
1294 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1296 case vtype_msgbody: /* Pointer to msgbody string */
1297 case vtype_msgbody_end: /* Ditto, the end of the msg */
1298 ss = (uschar **)(var_table[middle].value);
1299 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1302 int start_offset = SPOOL_DATA_START_OFFSET;
1303 int len = message_body_visible;
1304 if (len > message_size) len = message_size;
1305 *ss = body = store_malloc(len+1);
1307 if (var_table[middle].type == vtype_msgbody_end)
1309 struct stat statbuf;
1310 if (fstat(deliver_datafile, &statbuf) == 0)
1312 start_offset = statbuf.st_size - len;
1313 if (start_offset < SPOOL_DATA_START_OFFSET)
1314 start_offset = SPOOL_DATA_START_OFFSET;
1317 lseek(deliver_datafile, start_offset, SEEK_SET);
1318 len = read(deliver_datafile, body, len);
1324 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1328 return (*ss == NULL)? US"" : *ss;
1330 case vtype_todbsdin: /* BSD inbox time of day */
1331 return tod_stamp(tod_bsdin);
1333 case vtype_tode: /* Unix epoch time of day */
1334 return tod_stamp(tod_epoch);
1336 case vtype_todf: /* Full time of day */
1337 return tod_stamp(tod_full);
1339 case vtype_todl: /* Log format time of day */
1340 return tod_stamp(tod_log_bare); /* (without timezone) */
1342 case vtype_todzone: /* Time zone offset only */
1343 return tod_stamp(tod_zone);
1345 case vtype_todzulu: /* Zulu time */
1346 return tod_stamp(tod_zulu);
1348 case vtype_todlf: /* Log file datestamp tod */
1349 return tod_stamp(tod_log_datestamp);
1351 case vtype_reply: /* Get reply address */
1352 s = find_header(US"reply-to:", exists_only, newsize, FALSE,
1354 if (s == NULL || *s == 0)
1355 s = find_header(US"from:", exists_only, newsize, FALSE, headers_charset);
1356 return (s == NULL)? US"" : s;
1358 /* A recipients list is available only during system message filtering,
1359 during ACL processing after DATA, and while expanding pipe commands
1360 generated from a system filter, but not elsewhere. */
1362 case vtype_recipients:
1363 if (!enable_dollar_recipients) return NULL; else
1368 s = store_get(size);
1369 for (i = 0; i < recipients_count; i++)
1371 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1372 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1373 Ustrlen(recipients_list[i].address));
1375 s[ptr] = 0; /* string_cat() leaves room */
1382 sprintf(CS var_buffer, "%d",
1383 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1390 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1391 sprintf(CS var_buffer, "%d", inodes);
1397 return NULL; /* Unknown variable name */
1403 /*************************************************
1404 * Read and expand substrings *
1405 *************************************************/
1407 /* This function is called to read and expand argument substrings for various
1408 expansion items. Some have a minimum requirement that is less than the maximum;
1409 in these cases, the first non-present one is set to NULL.
1412 sub points to vector of pointers to set
1413 n maximum number of substrings
1415 sptr points to current string pointer
1416 skipping the skipping flag
1417 check_end if TRUE, check for final '}'
1418 name name of item, for error message
1420 Returns: 0 OK; string pointer updated
1421 1 curly bracketing error (too few arguments)
1422 2 too many arguments (only if check_end is set); message set
1423 3 other error (expansion failure)
1427 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1428 BOOL check_end, uschar *name)
1433 while (isspace(*s)) s++;
1434 for (i = 0; i < n; i++)
1438 if (i < m) return 1;
1442 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1443 if (sub[i] == NULL) return 3;
1444 if (*s++ != '}') return 1;
1445 while (isspace(*s)) s++;
1447 if (check_end && *s++ != '}')
1451 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1452 "(max is %d)", name, n);
1465 /*************************************************
1466 * Read and evaluate a condition *
1467 *************************************************/
1471 s points to the start of the condition text
1472 yield points to a BOOL to hold the result of the condition test;
1473 if NULL, we are just reading through a condition that is
1474 part of an "or" combination to check syntax, or in a state
1475 where the answer isn't required
1477 Returns: a pointer to the first character after the condition, or
1482 eval_condition(uschar *s, BOOL *yield)
1484 BOOL testfor = TRUE;
1485 BOOL tempcond, combined_cond;
1487 int i, rc, cond_type, roffset;
1489 struct stat statbuf;
1494 const uschar *rerror;
1498 while (isspace(*s)) s++;
1499 if (*s == '!') { testfor = !testfor; s++; } else break;
1502 /* Numeric comparisons are symbolic */
1504 if (*s == '=' || *s == '>' || *s == '<')
1516 /* All other conditions are named */
1518 else s = read_name(name, 256, s, US"_");
1520 /* If we haven't read a name, it means some non-alpha character is first. */
1524 expand_string_message = string_sprintf("condition name expected, "
1525 "but found \"%.16s\"", s);
1529 /* Find which condition we are dealing with, and switch on it */
1531 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1534 /* def: tests for a non-zero or non-NULL variable, or for an existing
1540 expand_string_message = US"\":\" expected after \"def\"";
1544 s = read_name(name, 256, s+1, US"_");
1546 /* Test for a header's existence */
1548 if (Ustrncmp(name, "h_", 2) == 0 ||
1549 Ustrncmp(name, "rh_", 3) == 0 ||
1550 Ustrncmp(name, "bh_", 3) == 0 ||
1551 Ustrncmp(name, "header_", 7) == 0 ||
1552 Ustrncmp(name, "rheader_", 8) == 0 ||
1553 Ustrncmp(name, "bheader_", 8) == 0)
1555 s = read_header_name(name, 256, s);
1556 if (yield != NULL) *yield =
1557 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1560 /* Test for a variable's having a non-empty value. If yield == NULL we
1561 are in a skipping state, and don't care about the answer. */
1565 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1568 expand_string_message = (name[0] == 0)?
1569 string_sprintf("variable name omitted after \"def:\"") :
1570 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1574 *yield = (value[0] != 0 && Ustrcmp(value, "0") != 0) == testfor;
1580 /* first_delivery tests for first delivery attempt */
1582 case ECOND_FIRST_DELIVERY:
1583 if (yield != NULL) *yield = deliver_firsttime == testfor;
1587 /* queue_running tests for any process started by a queue runner */
1589 case ECOND_QUEUE_RUNNING:
1590 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1594 /* exists: tests for file existence
1595 isip: tests for any IP address
1596 isip4: tests for an IPv4 address
1597 isip6: tests for an IPv6 address
1598 pam: does PAM authentication
1599 radius: does RADIUS authentication
1600 ldapauth: does LDAP authentication
1601 pwcheck: does Cyrus SASL pwcheck authentication
1610 case ECOND_LDAPAUTH:
1613 while (isspace(*s)) s++;
1614 if (*s != '{') goto COND_FAILED_CURLY_START;
1616 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1617 if (sub[0] == NULL) return NULL;
1618 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1620 if (yield == NULL) return s; /* No need to run the test if skipping */
1625 if ((expand_forbid & RDO_EXISTS) != 0)
1627 expand_string_message = US"File existence tests are not permitted";
1630 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1636 rc = string_is_ip_address(sub[0], NULL);
1637 *yield = ((cond_type == ECOND_ISIP)? (rc > 0) :
1638 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1641 /* Various authentication tests - all optionally compiled */
1645 rc = auth_call_pam(sub[0], &expand_string_message);
1648 goto COND_FAILED_NOT_COMPILED;
1649 #endif /* SUPPORT_PAM */
1652 #ifdef RADIUS_CONFIG_FILE
1653 rc = auth_call_radius(sub[0], &expand_string_message);
1656 goto COND_FAILED_NOT_COMPILED;
1657 #endif /* RADIUS_CONFIG_FILE */
1659 case ECOND_LDAPAUTH:
1662 /* Just to keep the interface the same */
1664 int old_pool = store_pool;
1665 store_pool = POOL_SEARCH;
1666 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1667 &expand_string_message, &do_cache);
1668 store_pool = old_pool;
1672 goto COND_FAILED_NOT_COMPILED;
1673 #endif /* LOOKUP_LDAP */
1676 #ifdef CYRUS_PWCHECK_SOCKET
1677 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1680 goto COND_FAILED_NOT_COMPILED;
1681 #endif /* CYRUS_PWCHECK_SOCKET */
1683 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1684 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1686 if (rc == ERROR || rc == DEFER) return NULL;
1687 *yield = (rc == OK) == testfor;
1693 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1695 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1697 However, the last two are optional. That is why the whole set is enclosed
1698 in their own set or braces. */
1700 case ECOND_SASLAUTHD:
1701 #ifndef CYRUS_SASLAUTHD_SOCKET
1702 goto COND_FAILED_NOT_COMPILED;
1704 while (isspace(*s)) s++;
1705 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1706 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1708 case 1: expand_string_message = US"too few arguments or bracketing "
1709 "error for saslauthd";
1711 case 3: return NULL;
1713 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1717 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1718 &expand_string_message);
1719 if (rc == ERROR || rc == DEFER) return NULL;
1720 *yield = (rc == OK) == testfor;
1723 #endif /* CYRUS_SASLAUTHD_SOCKET */
1726 /* symbolic operators for numeric and string comparison, and a number of
1727 other operators, all requiring two arguments.
1729 match: does a regular expression match and sets up the numerical
1730 variables if it succeeds
1731 match_address: matches in an address list
1732 match_domain: matches in a domain list
1733 match_local_part: matches in a local part list
1734 crypteq: encrypts plaintext and compares against an encrypted text,
1735 using crypt(), crypt16(), MD5 or SHA-1
1739 case ECOND_MATCH_ADDRESS:
1740 case ECOND_MATCH_DOMAIN:
1741 case ECOND_MATCH_LOCAL_PART:
1744 case ECOND_NUM_L: /* Numerical comparisons */
1751 case ECOND_STR_LT: /* String comparisons */
1762 for (i = 0; i < 2; i++)
1764 while (isspace(*s)) s++;
1767 if (i == 0) goto COND_FAILED_CURLY_START;
1768 expand_string_message = string_sprintf("missing 2nd string in {} "
1769 "after \"%s\"", name);
1772 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1773 if (sub[i] == NULL) return NULL;
1774 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1776 /* Convert to numerical if required; we know that the names of all the
1777 conditions that compare numbers do not start with a letter. This just saves
1778 checking for them individually. */
1780 if (!isalpha(name[0]))
1783 num[i] = (int)Ustrtol((const uschar *)sub[i], &endptr, 10);
1784 if (tolower(*endptr) == 'k')
1789 else if (tolower(*endptr) == 'm')
1791 num[i] *= 1024*1024;
1794 while (isspace(*endptr)) endptr++;
1797 expand_string_message = string_sprintf("\"%s\" is not a number",
1804 /* Result not required */
1806 if (yield == NULL) return s;
1808 /* Do an appropriate comparison */
1814 *yield = (num[0] == num[1]) == testfor;
1818 *yield = (num[0] > num[1]) == testfor;
1822 *yield = (num[0] >= num[1]) == testfor;
1826 *yield = (num[0] < num[1]) == testfor;
1830 *yield = (num[0] <= num[1]) == testfor;
1834 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1838 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1842 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1846 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1850 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1854 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1858 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1862 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1866 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
1870 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
1873 case ECOND_MATCH: /* Regular expression match */
1874 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1878 expand_string_message = string_sprintf("regular expression error in "
1879 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1882 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1885 case ECOND_MATCH_ADDRESS: /* Match in an address list */
1886 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1887 goto MATCHED_SOMETHING;
1889 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
1890 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1891 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1892 goto MATCHED_SOMETHING;
1894 case ECOND_MATCH_LOCAL_PART:
1895 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
1896 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
1911 expand_string_message = string_sprintf("unable to complete match "
1912 "against \"%s\": %s", sub[1], search_error_message);
1918 /* Various "encrypted" comparisons. If the second string starts with
1919 "{" then an encryption type is given. Default to crypt() or crypt16()
1920 (build-time choice). */
1923 #ifndef SUPPORT_CRYPTEQ
1924 goto COND_FAILED_NOT_COMPILED;
1926 if (strncmpic(sub[1], US"{md5}", 5) == 0)
1928 int sublen = Ustrlen(sub[1]+5);
1933 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
1935 /* If the length that we are comparing against is 24, the MD5 digest
1936 is expressed as a base64 string. This is the way LDAP does it. However,
1937 some other software uses a straightforward hex representation. We assume
1938 this if the length is 32. Other lengths fail. */
1942 uschar *coded = auth_b64encode((uschar *)digest, 16);
1943 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
1944 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
1945 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
1947 else if (sublen == 32)
1951 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
1953 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
1954 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
1955 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
1959 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
1960 "fail\n crypted=%s\n", sub[1]+5);
1965 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
1967 int sublen = Ustrlen(sub[1]+6);
1972 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
1974 /* If the length that we are comparing against is 28, assume the SHA1
1975 digest is expressed as a base64 string. If the length is 40, assume a
1976 straightforward hex representation. Other lengths fail. */
1980 uschar *coded = auth_b64encode((uschar *)digest, 20);
1981 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
1982 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
1983 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
1985 else if (sublen == 40)
1989 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
1991 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
1992 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
1993 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
1997 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
1998 "fail\n crypted=%s\n", sub[1]+6);
2003 else /* {crypt} or {crypt16} and non-{ at start */
2008 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2013 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2018 else if (sub[1][0] == '{')
2020 expand_string_message = string_sprintf("unknown encryption mechanism "
2021 "in \"%s\"", sub[1]);
2027 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2028 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2029 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2033 #define XSTR(s) STR(s)
2034 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2035 " subject=%s\n crypted=%s\n",
2036 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2041 /* If the encrypted string contains fewer than two characters (for the
2042 salt), force failure. Otherwise we get false positives: with an empty
2043 string the yield of crypt() is an empty string! */
2045 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2046 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2049 #endif /* SUPPORT_CRYPTEQ */
2050 } /* Switch for comparison conditions */
2052 return s; /* End of comparison conditions */
2055 /* and/or: computes logical and/or of several conditions */
2059 subcondptr = (yield == NULL)? NULL : &tempcond;
2060 combined_cond = (cond_type == ECOND_AND);
2062 while (isspace(*s)) s++;
2063 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2067 while (isspace(*s)) s++;
2068 if (*s == '}') break;
2071 expand_string_message = string_sprintf("each subcondition "
2072 "inside an \"%s{...}\" condition must be in its own {}", name);
2076 s = eval_condition(s+1, subcondptr);
2079 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2080 expand_string_message, name);
2083 while (isspace(*s)) s++;
2087 expand_string_message = string_sprintf("missing } at end of condition "
2088 "inside \"%s\" group", name);
2094 if (cond_type == ECOND_AND)
2096 combined_cond &= tempcond;
2097 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2098 } /* evaluate any more */
2101 combined_cond |= tempcond;
2102 if (combined_cond) subcondptr = NULL; /* once true, don't */
2103 } /* evaluate any more */
2107 if (yield != NULL) *yield = (combined_cond == testfor);
2111 /* Unknown condition */
2114 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2116 } /* End switch on condition type */
2118 /* Missing braces at start and end of data */
2120 COND_FAILED_CURLY_START:
2121 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2124 COND_FAILED_CURLY_END:
2125 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2129 /* A condition requires code that is not compiled */
2131 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2132 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2133 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2134 COND_FAILED_NOT_COMPILED:
2135 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2144 /*************************************************
2145 * Save numerical variables *
2146 *************************************************/
2148 /* This function is called from items such as "if" that want to preserve and
2149 restore the numbered variables.
2152 save_expand_string points to an array of pointers to set
2153 save_expand_nlength points to an array of ints for the lengths
2155 Returns: the value of expand max to save
2159 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2162 for (i = 0; i <= expand_nmax; i++)
2164 save_expand_nstring[i] = expand_nstring[i];
2165 save_expand_nlength[i] = expand_nlength[i];
2172 /*************************************************
2173 * Restore numerical variables *
2174 *************************************************/
2176 /* This function restored saved values of numerical strings.
2179 save_expand_nmax the number of strings to restore
2180 save_expand_string points to an array of pointers
2181 save_expand_nlength points to an array of ints
2187 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2188 int *save_expand_nlength)
2191 expand_nmax = save_expand_nmax;
2192 for (i = 0; i <= expand_nmax; i++)
2194 expand_nstring[i] = save_expand_nstring[i];
2195 expand_nlength[i] = save_expand_nlength[i];
2203 /*************************************************
2204 * Handle yes/no substrings *
2205 *************************************************/
2207 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2208 alternative substrings that depend on whether or not the condition was true,
2209 or the lookup or extraction succeeded. The substrings always have to be
2210 expanded, to check their syntax, but "skipping" is set when the result is not
2211 needed - this avoids unnecessary nested lookups.
2214 skipping TRUE if we were skipping when this item was reached
2215 yes TRUE if the first string is to be used, else use the second
2216 save_lookup a value to put back into lookup_value before the 2nd expansion
2217 sptr points to the input string pointer
2218 yieldptr points to the output string pointer
2219 sizeptr points to the output string size
2220 ptrptr points to the output string pointer
2221 type "lookup" or "if" or "extract" or "run", for error message
2223 Returns: 0 OK; lookup_value has been reset to save_lookup
2225 2 expansion failed because of bracketing error
2229 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2230 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2233 uschar *s = *sptr; /* Local value */
2234 uschar *sub1, *sub2;
2236 /* If there are no following strings, we substitute the contents of $value for
2237 lookups and for extractions in the success case. For the ${if item, the string
2238 "true" is substituted. In the fail case, nothing is substituted for all three
2241 while (isspace(*s)) s++;
2246 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2250 if (yes && lookup_value != NULL)
2251 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2252 Ustrlen(lookup_value));
2253 lookup_value = save_lookup;
2259 /* Expand the first substring. Forced failures are noticed only if we actually
2260 want this string. Set skipping in the call in the fail case (this will always
2261 be the case if we were already skipping). */
2263 sub1 = expand_string_internal(s+1, TRUE, &s, !yes);
2264 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2265 expand_string_forcedfail = FALSE;
2266 if (*s++ != '}') goto FAILED_CURLY;
2268 /* If we want the first string, add it to the output */
2271 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2273 /* If this is called from a lookup or an extract, we want to restore $value to
2274 what it was at the start of the item, so that it has this value during the
2275 second string expansion. For the call from "if" to this function, save_lookup
2276 is set to lookup_value, so that this statement does nothing. */
2278 lookup_value = save_lookup;
2280 /* There now follows either another substring, or "fail", or nothing. This
2281 time, forced failures are noticed only if we want the second string. We must
2282 set skipping in the nested call if we don't want this string, or if we were
2283 already skipping. */
2285 while (isspace(*s)) s++;
2288 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2289 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2290 expand_string_forcedfail = FALSE;
2291 if (*s++ != '}') goto FAILED_CURLY;
2293 /* If we want the second string, add it to the output */
2296 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2299 /* If there is no second string, but the word "fail" is present when the use of
2300 the second string is wanted, set a flag indicating it was a forced failure
2301 rather than a syntactic error. Swallow the terminating } in case this is nested
2302 inside another lookup or if or extract. */
2307 s = read_name(name, sizeof(name), s, US"_");
2308 if (Ustrcmp(name, "fail") == 0)
2310 if (!yes && !skipping)
2312 while (isspace(*s)) s++;
2313 if (*s++ != '}') goto FAILED_CURLY;
2314 expand_string_message =
2315 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2316 expand_string_forcedfail = TRUE;
2322 expand_string_message =
2323 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2328 /* All we have to do now is to check on the final closing brace. */
2330 while (isspace(*s)) s++;
2331 if (*s++ == '}') goto RETURN;
2333 /* Get here if there is a bracketing failure */
2338 /* Get here for other failures */
2343 /* Update the input pointer value before returning */
2355 /*************************************************
2356 * Handle MD5 or SHA-1 computation for HMAC *
2357 *************************************************/
2359 /* These are some wrapping functions that enable the HMAC code to be a bit
2360 cleaner. A good compiler will spot the tail recursion.
2363 type HMAC_MD5 or HMAC_SHA1
2364 remaining are as for the cryptographic hash functions
2370 chash_start(int type, void *base)
2372 if (type == HMAC_MD5)
2373 md5_start((md5 *)base);
2375 sha1_start((sha1 *)base);
2379 chash_mid(int type, void *base, uschar *string)
2381 if (type == HMAC_MD5)
2382 md5_mid((md5 *)base, string);
2384 sha1_mid((sha1 *)base, string);
2388 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2390 if (type == HMAC_MD5)
2391 md5_end((md5 *)base, string, length, digest);
2393 sha1_end((sha1 *)base, string, length, digest);
2400 /*************************************************
2401 * Join a file onto the output string *
2402 *************************************************/
2404 /* This is used for readfile and after a run expansion. It joins the contents
2405 of a file onto the output string, globally replacing newlines with a given
2406 string (optionally). The file is closed at the end.
2410 yield pointer to the expandable string
2411 sizep pointer to the current size
2412 ptrp pointer to the current position
2413 eol newline replacement string, or NULL
2415 Returns: new value of string pointer
2419 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2422 uschar buffer[1024];
2424 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2426 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2428 int len = Ustrlen(buffer);
2429 if (eol != NULL && buffer[len-1] == '\n') len--;
2430 yield = string_cat(yield, sizep, ptrp, buffer, len);
2431 if (buffer[len] != 0)
2432 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2435 if (yield != NULL) yield[*ptrp] = 0;
2443 /*************************************************
2444 * Evaluate numeric expression *
2445 *************************************************/
2447 /* This is a set of mutually recursive functions that evaluate a simple
2448 arithmetic expression involving only + - * / and parentheses. The only one that
2449 is called from elsewhere is eval_expr, whose interface is:
2452 sptr pointer to the pointer to the string - gets updated
2453 decimal TRUE if numbers are to be assumed decimal
2454 error pointer to where to put an error message - must be NULL on input
2455 endket TRUE if ')' must terminate - FALSE for external call
2458 Returns: on success: the value of the expression, with *error still NULL
2459 on failure: an undefined value, with *error = a message
2462 static int eval_sumterm(uschar **, BOOL, uschar **);
2465 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2468 int x = eval_sumterm(&s, decimal, error);
2471 while (*s == '+' || *s == '-')
2474 int y = eval_sumterm(&s, decimal, error);
2475 if (*error != NULL) break;
2476 if (op == '+') x += y; else x -= y;
2483 *error = US"expecting closing parenthesis";
2485 while (isspace(*(++s)));
2487 else if (*s != 0) *error = US"expecting + or -";
2496 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2501 while (isspace(*s)) s++;
2503 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2506 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2508 if (tolower(*s) == 'k') { n *= 1024; s++; }
2509 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2510 while (isspace (*s)) s++;
2515 n = eval_expr(&s, decimal, error, 1);
2519 *error = US"expecting number or opening parenthesis";
2526 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2529 int x = eval_term(&s, decimal, error);
2532 while (*s == '*' || *s == '/')
2535 int y = eval_term(&s, decimal, error);
2536 if (*error != NULL) break;
2537 if (op == '*') x *= y; else x /= y;
2547 /*************************************************
2549 *************************************************/
2551 /* Returns either an unchanged string, or the expanded string in stacking pool
2552 store. Interpreted sequences are:
2554 \... normal escaping rules
2555 $name substitutes the variable
2557 ${op:string} operates on the expanded string value
2558 ${item{arg1}{arg2}...} expands the args and then does the business
2559 some literal args are not enclosed in {}
2561 There are now far too many operators and item types to make it worth listing
2562 them here in detail any more.
2564 We use an internal routine recursively to handle embedded substrings. The
2565 external function follows. The yield is NULL if the expansion failed, and there
2566 are two cases: if something collapsed syntactically, or if "fail" was given
2567 as the action on a lookup failure. These can be distinguised by looking at the
2568 variable expand_string_forcedfail, which is TRUE in the latter case.
2570 The skipping flag is set true when expanding a substring that isn't actually
2571 going to be used (after "if" or "lookup") and it prevents lookups from
2572 happening lower down.
2574 Store usage: At start, a store block of the length of the input plus 64
2575 is obtained. This is expanded as necessary by string_cat(), which might have to
2576 get a new block, or might be able to expand the original. At the end of the
2577 function we can release any store above that portion of the yield block that
2578 was actually used. In many cases this will be optimal.
2580 However: if the first item in the expansion is a variable name or header name,
2581 we reset the store before processing it; if the result is in fresh store, we
2582 use that without copying. This is helpful for expanding strings like
2583 $message_headers which can get very long.
2586 string the string to be expanded
2587 ket_ends true if expansion is to stop at }
2588 left if not NULL, a pointer to the first character after the
2589 expansion is placed here (typically used with ket_ends)
2590 skipping TRUE for recursive calls when the value isn't actually going
2591 to be used (to allow for optimisation)
2593 Returns: NULL if expansion fails:
2594 expand_string_forcedfail is set TRUE if failure was forced
2595 expand_string_message contains a textual error message
2596 a pointer to the expanded string on success
2600 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2604 int size = Ustrlen(string)+ 64;
2606 uschar *yield = store_get(size);
2608 uschar *save_expand_nstring[EXPAND_MAXN+1];
2609 int save_expand_nlength[EXPAND_MAXN+1];
2611 expand_string_forcedfail = FALSE;
2612 expand_string_message = US"";
2619 /* \ escapes the next character, which must exist, or else
2620 the expansion fails. There's a special escape, \N, which causes
2621 copying of the subject verbatim up to the next \N. Otherwise,
2622 the escapes are the standard set. */
2628 expand_string_message = US"\\ at end of string";
2635 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2636 yield = string_cat(yield, &size, &ptr, t, s - t);
2637 if (*s != 0) s += 2;
2643 ch[0] = string_interpret_escape(&s);
2645 yield = string_cat(yield, &size, &ptr, ch, 1);
2651 /* Anything other than $ is just copied verbatim, unless we are
2652 looking for a terminating } character. */
2654 if (ket_ends && *s == '}') break;
2658 yield = string_cat(yield, &size, &ptr, s++, 1);
2662 /* No { after the $ - must be a plain name or a number for string
2663 match variable. There has to be a fudge for variables that are the
2664 names of header fields preceded by "$header_" because header field
2665 names can contain any printing characters except space and colon.
2666 For those that don't like typing this much, "$h_" is a synonym for
2667 "$header_". A non-existent header yields a NULL value; nothing is
2670 if (isalpha((*(++s))))
2675 s = read_name(name, sizeof(name), s, US"_");
2677 /* If this is the first thing to be expanded, release the pre-allocated
2680 if (ptr == 0 && yield != NULL)
2689 if (Ustrncmp(name, "h_", 2) == 0 ||
2690 Ustrncmp(name, "rh_", 3) == 0 ||
2691 Ustrncmp(name, "bh_", 3) == 0 ||
2692 Ustrncmp(name, "header_", 7) == 0 ||
2693 Ustrncmp(name, "rheader_", 8) == 0 ||
2694 Ustrncmp(name, "bheader_", 8) == 0)
2696 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2697 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2698 s = read_header_name(name, sizeof(name), s);
2699 value = find_header(name, FALSE, &newsize, want_raw, charset);
2701 /* If we didn't find the header, and the header contains a closing brace
2702 characters, this may be a user error where the terminating colon
2703 has been omitted. Set a flag to adjust the error message in this case.
2704 But there is no error here - nothing gets inserted. */
2708 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2717 value = find_variable(name, FALSE, skipping, &newsize);
2720 expand_string_message =
2721 string_sprintf("unknown variable name \"%s\"", name);
2726 /* If the data is known to be in a new buffer, newsize will be set to the
2727 size of that buffer. If this is the first thing in an expansion string,
2728 yield will be NULL; just point it at the new store instead of copying. Many
2729 expansion strings contain just one reference, so this is a useful
2730 optimization, especially for humungous headers. */
2732 len = Ustrlen(value);
2733 if (yield == NULL && newsize != 0)
2739 else yield = string_cat(yield, &size, &ptr, value, len);
2747 s = read_number(&n, s);
2748 if (n >= 0 && n <= expand_nmax)
2749 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2754 /* Otherwise, if there's no '{' after $ it's an error. */
2758 expand_string_message = US"$ not followed by letter, digit, or {";
2762 /* After { there can be various things, but they all start with
2763 an initial word, except for a number for a string match variable. */
2765 if (isdigit((*(++s))))
2768 s = read_number(&n, s);
2771 expand_string_message = US"} expected after number";
2774 if (n >= 0 && n <= expand_nmax)
2775 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2782 expand_string_message = US"letter or digit expected after ${";
2786 /* Allow "-" in names to cater for substrings with negative
2787 arguments. Since we are checking for known names after { this is
2790 s = read_name(name, sizeof(name), s, US"_-");
2791 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
2795 /* Handle conditionals - preserve the values of the numerical expansion
2796 variables in case they get changed by a regular expression match in the
2797 condition. If not, they retain their external settings. At the end
2798 of this "if" section, they get restored to their previous values. */
2804 int save_expand_nmax =
2805 save_expand_strings(save_expand_nstring, save_expand_nlength);
2807 while (isspace(*s)) s++;
2808 next_s = eval_condition(s, skipping? NULL : &cond);
2809 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
2812 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
2813 cond? "true" : "false");
2817 /* The handling of "yes" and "no" result strings is now in a separate
2818 function that is also used by ${lookup} and ${extract} and ${run}. */
2820 switch(process_yesno(
2821 skipping, /* were previously skipping */
2822 cond, /* success/failure indicator */
2823 lookup_value, /* value to reset for string2 */
2824 &s, /* input pointer */
2825 &yield, /* output pointer */
2826 &size, /* output size */
2827 &ptr, /* output current point */
2828 US"if")) /* condition type */
2830 case 1: goto EXPAND_FAILED; /* when all is well, the */
2831 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
2834 /* Restore external setting of expansion variables for continuation
2837 restore_expand_strings(save_expand_nmax, save_expand_nstring,
2838 save_expand_nlength);
2842 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
2843 expanding an internal string that isn't actually going to be used. All we
2844 need to do is check the syntax, so don't do a lookup at all. Preserve the
2845 values of the numerical expansion variables in case they get changed by a
2846 partial lookup. If not, they retain their external settings. At the end
2847 of this "lookup" section, they get restored to their previous values. */
2851 int stype, partial, affixlen, starflags;
2852 int expand_setup = 0;
2854 uschar *key, *filename, *affix;
2855 uschar *save_lookup_value = lookup_value;
2856 int save_expand_nmax =
2857 save_expand_strings(save_expand_nstring, save_expand_nlength);
2859 if ((expand_forbid & RDO_LOOKUP) != 0)
2861 expand_string_message = US"lookup expansions are not permitted";
2865 /* Get the key we are to look up for single-key+file style lookups.
2866 Otherwise set the key NULL pro-tem. */
2868 while (isspace(*s)) s++;
2871 key = expand_string_internal(s+1, TRUE, &s, skipping);
2872 if (key == NULL) goto EXPAND_FAILED;
2873 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
2874 while (isspace(*s)) s++;
2878 /* Find out the type of database */
2882 expand_string_message = US"missing lookup type";
2886 /* The type is a string that may contain special characters of various
2887 kinds. Allow everything except space or { to appear; the actual content
2888 is checked by search_findtype_partial. */
2890 while (*s != 0 && *s != '{' && !isspace(*s))
2892 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
2896 while (isspace(*s)) s++;
2898 /* Now check for the individual search type and any partial or default
2899 options. Only those types that are actually in the binary are valid. */
2901 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
2905 expand_string_message = search_error_message;
2909 /* Check that a key was provided for those lookup types that need it,
2910 and was not supplied for those that use the query style. */
2912 if (!mac_islookup(stype, lookup_querystyle))
2916 expand_string_message = string_sprintf("missing {key} for single-"
2917 "key \"%s\" lookup", name);
2925 expand_string_message = string_sprintf("a single key was given for "
2926 "lookup type \"%s\", which is not a single-key lookup type", name);
2931 /* Get the next string in brackets and expand it. It is the file name for
2932 single-key+file lookups, and the whole query otherwise. */
2934 if (*s != '{') goto EXPAND_FAILED_CURLY;
2935 filename = expand_string_internal(s+1, TRUE, &s, skipping);
2936 if (filename == NULL) goto EXPAND_FAILED;
2937 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
2938 while (isspace(*s)) s++;
2940 /* If this isn't a single-key+file lookup, re-arrange the variables
2941 to be appropriate for the search_ functions. */
2949 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
2950 the entry was not found. Note that there is no search_close() function.
2951 Files are left open in case of re-use. At suitable places in higher logic,
2952 search_tidyup() is called to tidy all open files. This can save opening
2953 the same file several times. However, files may also get closed when
2954 others are opened, if too many are open at once. The rule is that a
2955 handle should not be used after a second search_open().
2957 Request that a partial search sets up $1 and maybe $2 by passing
2958 expand_setup containing zero. If its value changes, reset expand_nmax,
2959 since new variables will have been set. Note that at the end of this
2960 "lookup" section, the old numeric variables are restored. */
2963 lookup_value = NULL;
2966 void *handle = search_open(filename, stype, 0, NULL, NULL);
2969 expand_string_message = search_error_message;
2972 lookup_value = search_find(handle, filename, key, partial, affix,
2973 affixlen, starflags, &expand_setup);
2974 if (search_find_defer)
2976 expand_string_message =
2977 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
2978 search_error_message);
2981 if (expand_setup > 0) expand_nmax = expand_setup;
2984 /* The handling of "yes" and "no" result strings is now in a separate
2985 function that is also used by ${if} and ${extract}. */
2987 switch(process_yesno(
2988 skipping, /* were previously skipping */
2989 lookup_value != NULL, /* success/failure indicator */
2990 save_lookup_value, /* value to reset for string2 */
2991 &s, /* input pointer */
2992 &yield, /* output pointer */
2993 &size, /* output size */
2994 &ptr, /* output current point */
2995 US"lookup")) /* condition type */
2997 case 1: goto EXPAND_FAILED; /* when all is well, the */
2998 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3001 /* Restore external setting of expansion variables for carrying on
3002 at this level, and continue. */
3004 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3005 save_expand_nlength);
3009 /* If Perl support is configured, handle calling embedded perl subroutines,
3010 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3011 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3012 arguments (defined below). */
3015 #define EXIM_PERL_MAX_ARGS 8
3019 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3022 if ((expand_forbid & RDO_PERL) != 0)
3024 expand_string_message = US"Perl calls are not permitted";
3028 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3031 case 1: goto EXPAND_FAILED_CURLY;
3033 case 3: goto EXPAND_FAILED;
3036 /* If skipping, we don't actually do anything */
3038 if (skipping) continue;
3040 /* Start the interpreter if necessary */
3042 if (!opt_perl_started)
3045 if (opt_perl_startup == NULL)
3047 expand_string_message = US"A setting of perl_startup is needed when "
3048 "using the Perl interpreter";
3051 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3052 initerror = init_perl(opt_perl_startup);
3053 if (initerror != NULL)
3055 expand_string_message =
3056 string_sprintf("error in perl_startup code: %s\n", initerror);
3059 opt_perl_started = TRUE;
3062 /* Call the function */
3064 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3065 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3066 sub_arg[0], sub_arg + 1);
3068 /* NULL yield indicates failure; if the message pointer has been set to
3069 NULL, the yield was undef, indicating a forced failure. Otherwise the
3070 message will indicate some kind of Perl error. */
3072 if (new_yield == NULL)
3074 if (expand_string_message == NULL)
3076 expand_string_message =
3077 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3078 "failure", sub_arg[0]);
3079 expand_string_forcedfail = TRUE;
3084 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3085 set during a callback from Perl. */
3087 expand_string_forcedfail = FALSE;
3091 #endif /* EXIM_PERL */
3093 /* Handle "readfile" to insert an entire file */
3095 case EITEM_READFILE:
3100 if ((expand_forbid & RDO_READFILE) != 0)
3102 expand_string_message = US"file insertions are not permitted";
3106 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3108 case 1: goto EXPAND_FAILED_CURLY;
3110 case 3: goto EXPAND_FAILED;
3113 /* If skipping, we don't actually do anything */
3115 if (skipping) continue;
3117 /* Open the file and read it */
3119 f = Ufopen(sub_arg[0], "rb");
3122 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3126 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3131 /* Handle "readsocket" to insert data from a Unix domain socket */
3133 case EITEM_READSOCK:
3139 struct sockaddr_un sockun; /* don't call this "sun" ! */
3143 if ((expand_forbid & RDO_READSOCK) != 0)
3145 expand_string_message = US"socket insertions are not permitted";
3149 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3150 because there may be a string for expansion on failure. */
3152 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3154 case 1: goto EXPAND_FAILED_CURLY;
3155 case 2: /* Won't occur: no end check */
3156 case 3: goto EXPAND_FAILED;
3159 /* Sort out timeout, if given */
3161 if (sub_arg[2] != NULL)
3163 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3166 expand_string_message = string_sprintf("bad time value %s",
3171 else sub_arg[3] = NULL; /* No eol if no timeout */
3173 /* If skipping, we don't actually do anything */
3177 /* Make a connection to the socket */
3179 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3181 expand_string_message = string_sprintf("failed to create socket: %s",
3186 sockun.sun_family = AF_UNIX;
3187 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3189 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3191 expand_string_message = string_sprintf("failed to connect to socket "
3192 "%s: %s", sub_arg[0], strerror(errno));
3195 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3197 /* Write the request string, if not empty */
3199 if (sub_arg[1][0] != 0)
3201 int len = Ustrlen(sub_arg[1]);
3202 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3204 if (write(fd, sub_arg[1], len) != len)
3206 expand_string_message = string_sprintf("request write to socket "
3207 "failed: %s", strerror(errno));
3212 /* Now we need to read from the socket, under a timeout. The function
3213 that reads a file can be used. */
3215 f = fdopen(fd, "rb");
3216 sigalrm_seen = FALSE;
3218 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3222 /* After a timeout, we restore the pointer in the result, that is,
3223 make sure we add nothing from the socket. */
3228 expand_string_message = US"socket read timed out";
3233 /* The whole thing has worked (or we were skipping). If there is a
3234 failure string following, we need to skip it. */
3238 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3240 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3241 while (isspace(*s)) s++;
3243 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3246 /* Come here on failure to create socket, connect socket, write to the
3247 socket, or timeout on reading. If another substring follows, expand and
3248 use it. Otherwise, those conditions give expand errors. */
3251 if (*s != '{') goto EXPAND_FAILED;
3252 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3253 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3254 if (arg == NULL) goto EXPAND_FAILED;
3255 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3256 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3257 while (isspace(*s)) s++;
3258 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3262 /* Handle "run" to execute a program. */
3267 uschar *old_lookup_value = NULL;
3275 if ((expand_forbid & RDO_RUN) != 0)
3277 expand_string_message = US"running a command is not permitted";
3281 while (isspace(*s)) s++;
3282 if (*s != '{') goto EXPAND_FAILED_CURLY;
3283 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3284 if (arg == NULL) goto EXPAND_FAILED;
3285 while (isspace(*s)) s++;
3286 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3288 if (skipping) /* Just pretend it worked when we're skipping */
3294 if (!transport_set_up_command(&argv, /* anchor for arg list */
3295 arg, /* raw command */
3296 FALSE, /* don't expand the arguments */
3297 0, /* not relevant when... */
3298 NULL, /* no transporting address */
3299 US"${run} expansion", /* for error messages */
3300 &expand_string_message)) /* where to put error message */
3305 /* Create the child process, making it a group leader. */
3307 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3311 expand_string_message =
3312 string_sprintf("couldn't create child process: %s", strerror(errno));
3316 /* Nothing is written to the standard input. */
3320 /* Wait for the process to finish, applying the timeout, and inspect its
3321 return code for serious disasters. Simple non-zero returns are passed on.
3324 if ((runrc = child_close(pid, 60)) < 0)
3328 expand_string_message = string_sprintf("command timed out");
3329 killpg(pid, SIGKILL); /* Kill the whole process group */
3332 else if (runrc == -257)
3333 expand_string_message = string_sprintf("wait() failed: %s",
3337 expand_string_message = string_sprintf("command killed by signal %d",
3343 /* Read the pipe to get the command's output into $value (which is kept
3344 in lookup_value). */
3346 f = fdopen(fd_out, "rb");
3347 old_lookup_value = lookup_value;
3348 lookup_value = NULL;
3349 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3353 /* Process the yes/no strings */
3355 switch(process_yesno(
3356 skipping, /* were previously skipping */
3357 runrc == 0, /* success/failure indicator */
3358 old_lookup_value, /* value to reset for string2 */
3359 &s, /* input pointer */
3360 &yield, /* output pointer */
3361 &size, /* output size */
3362 &ptr, /* output current point */
3363 US"run")) /* condition type */
3365 case 1: goto EXPAND_FAILED; /* when all is well, the */
3366 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3372 /* Handle character translation for "tr" */
3380 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3382 case 1: goto EXPAND_FAILED_CURLY;
3384 case 3: goto EXPAND_FAILED;
3387 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3388 o2m = Ustrlen(sub[2]) - 1;
3390 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3392 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3396 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3403 /* Handle "hash", "length", "nhash", and "substr" when they are given with
3404 expanded arguments. */
3414 int val[2] = { 0, -1 };
3417 /* "length" takes only 2 arguments whereas the others take 2 or 3.
3418 Ensure that sub[2] is set in the ${length case. */
3421 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
3424 case 1: goto EXPAND_FAILED_CURLY;
3426 case 3: goto EXPAND_FAILED;
3429 /* Juggle the arguments if there are only two of them: always move the
3430 string to the last position and make ${length{n}{str}} equivalent to
3431 ${substr{0}{n}{str}}. See the defaults for val[] above. */
3437 if (item_type == EITEM_LENGTH)
3444 for (i = 0; i < 2; i++)
3446 if (sub[i] == NULL) continue;
3447 val[i] = (int)Ustrtol(sub[i], &ret, 10);
3448 if (*ret != 0 || (i != 0 && val[i] < 0))
3450 expand_string_message = string_sprintf("\"%s\" is not a%s number "
3451 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
3457 (item_type == EITEM_HASH)?
3458 compute_hash(sub[2], val[0], val[1], &len) :
3459 (item_type == EITEM_NHASH)?
3460 compute_nhash(sub[2], val[0], val[1], &len) :
3461 extract_substr(sub[2], val[0], val[1], &len);
3463 if (ret == NULL) goto EXPAND_FAILED;
3464 yield = string_cat(yield, &size, &ptr, ret, len);
3468 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
3469 This code originally contributed by Steve Haslam. It currently supports
3470 the use of MD5 and SHA-1 hashes.
3472 We need some workspace that is large enough to handle all the supported
3473 hash types. Use macros to set the sizes rather than be too elaborate. */
3475 #define MAX_HASHLEN 20
3476 #define MAX_HASHBLOCKLEN 64
3485 int hashlen; /* Number of octets for the hash algorithm's output */
3486 int hashblocklen; /* Number of octets the hash algorithm processes */
3488 unsigned int keylen;
3490 uschar keyhash[MAX_HASHLEN];
3491 uschar innerhash[MAX_HASHLEN];
3492 uschar finalhash[MAX_HASHLEN];
3493 uschar finalhash_hex[2*MAX_HASHLEN];
3494 uschar innerkey[MAX_HASHBLOCKLEN];
3495 uschar outerkey[MAX_HASHBLOCKLEN];
3497 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
3499 case 1: goto EXPAND_FAILED_CURLY;
3501 case 3: goto EXPAND_FAILED;
3504 if (Ustrcmp(sub[0], "md5") == 0)
3507 use_base = &md5_base;
3511 else if (Ustrcmp(sub[0], "sha1") == 0)
3514 use_base = &sha1_base;
3520 expand_string_message =
3521 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
3526 keylen = Ustrlen(keyptr);
3528 /* If the key is longer than the hash block length, then hash the key
3531 if (keylen > hashblocklen)
3533 chash_start(type, use_base);
3534 chash_end(type, use_base, keyptr, keylen, keyhash);
3539 /* Now make the inner and outer key values */
3541 memset(innerkey, 0x36, hashblocklen);
3542 memset(outerkey, 0x5c, hashblocklen);
3544 for (i = 0; i < keylen; i++)
3546 innerkey[i] ^= keyptr[i];
3547 outerkey[i] ^= keyptr[i];
3550 /* Now do the hashes */
3552 chash_start(type, use_base);
3553 chash_mid(type, use_base, innerkey);
3554 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
3556 chash_start(type, use_base);
3557 chash_mid(type, use_base, outerkey);
3558 chash_end(type, use_base, innerhash, hashlen, finalhash);
3560 /* Encode the final hash as a hex string */
3563 for (i = 0; i < hashlen; i++)
3565 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3566 *p++ = hex_digits[finalhash[i] & 0x0f];
3569 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
3570 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
3572 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
3577 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
3578 We have to save the numerical variables and restore them afterwards. */
3583 int moffset, moffsetextra, slen;
3586 const uschar *rerror;
3589 int save_expand_nmax =
3590 save_expand_strings(save_expand_nstring, save_expand_nlength);
3592 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
3594 case 1: goto EXPAND_FAILED_CURLY;
3596 case 3: goto EXPAND_FAILED;
3599 /* Compile the regular expression */
3601 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
3606 expand_string_message = string_sprintf("regular expression error in "
3607 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
3611 /* Now run a loop to do the substitutions as often as necessary. It ends
3612 when there are no more matches. Take care over matches of the null string;
3613 do the same thing as Perl does. */
3616 slen = Ustrlen(sub[0]);
3617 moffset = moffsetextra = 0;
3622 int ovector[3*(EXPAND_MAXN+1)];
3623 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
3624 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
3628 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
3629 is not necessarily the end. We want to repeat the match from one
3630 character further along, but leaving the basic offset the same (for
3631 copying below). We can't be at the end of the string - that was checked
3632 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
3633 finished; copy the remaining string and end the loop. */
3643 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
3647 /* Match - set up for expanding the replacement. */
3649 if (n == 0) n = EXPAND_MAXN + 1;
3651 for (nn = 0; nn < n*2; nn += 2)
3653 expand_nstring[expand_nmax] = subject + ovector[nn];
3654 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
3658 /* Copy the characters before the match, plus the expanded insertion. */
3660 yield = string_cat(yield, &size, &ptr, subject + moffset,
3661 ovector[0] - moffset);
3662 insert = expand_string(sub[2]);
3663 if (insert == NULL) goto EXPAND_FAILED;
3664 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
3666 moffset = ovector[1];
3670 /* If we have matched an empty string, first check to see if we are at
3671 the end of the subject. If so, the loop is over. Otherwise, mimic
3672 what Perl's /g options does. This turns out to be rather cunning. First
3673 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
3674 string at the same point. If this fails (picked up above) we advance to
3675 the next character. */
3677 if (ovector[0] == ovector[1])
3679 if (ovector[0] == slen) break;
3680 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
3684 /* All done - restore numerical variables. */
3686 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3687 save_expand_nlength);
3691 /* Handle keyed and numbered substring extraction. If the first argument
3692 consists entirely of digits, then a numerical extraction is assumed. */
3698 int field_number = 1;
3699 BOOL field_number_set = FALSE;
3700 uschar *save_lookup_value = lookup_value;
3702 int save_expand_nmax =
3703 save_expand_strings(save_expand_nstring, save_expand_nlength);
3705 /* Read the arguments */
3707 for (i = 0; i < j; i++)
3709 while (isspace(*s)) s++;
3712 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
3713 if (sub[i] == NULL) goto EXPAND_FAILED;
3714 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3716 /* After removal of leading and trailing white space, the first
3717 argument must not be empty; if it consists entirely of digits
3718 (optionally preceded by a minus sign), this is a numerical
3719 extraction, and we expect 3 arguments. */
3727 while (isspace(*p)) p++;
3731 while (len > 0 && isspace(p[len-1])) len--;
3736 expand_string_message = US"first argument of \"expand\" must not "
3746 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
3750 j = 3; /* Need 3 args */
3751 field_number_set = TRUE;
3755 else goto EXPAND_FAILED_CURLY;
3758 /* Extract either the numbered or the keyed substring into $value. If
3759 skipping, just pretend the extraction failed. */
3761 lookup_value = skipping? NULL : field_number_set?
3762 expand_gettokened(field_number, sub[1], sub[2]) :
3763 expand_getkeyed(sub[0], sub[1]);
3765 /* If no string follows, $value gets substituted; otherwise there can
3766 be yes/no strings, as for lookup or if. */
3768 switch(process_yesno(
3769 skipping, /* were previously skipping */
3770 lookup_value != NULL, /* success/failure indicator */
3771 save_lookup_value, /* value to reset for string2 */
3772 &s, /* input pointer */
3773 &yield, /* output pointer */
3774 &size, /* output size */
3775 &ptr, /* output current point */
3776 US"extract")) /* condition type */
3778 case 1: goto EXPAND_FAILED; /* when all is well, the */
3779 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3782 /* All done - restore numerical variables. */
3784 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3785 save_expand_nlength);
3791 /* Control reaches here if the name is not recognized as one of the more
3792 complicated expansion items. Check for the "operator" syntax (name terminated
3793 by a colon). Some of the operators have arguments, separated by _ from the
3800 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
3801 if (sub == NULL) goto EXPAND_FAILED;
3804 /* Owing to an historical mis-design, an underscore may be part of the
3805 operator name, or it may introduce arguments. We therefore first scan the
3806 table of names that contain underscores. If there is no match, we cut off
3807 the arguments and then scan the main table. */
3809 c = chop_match(name, op_table_underscore,
3810 sizeof(op_table_underscore)/sizeof(uschar *));
3814 arg = Ustrchr(name, '_');
3815 if (arg != NULL) *arg = 0;
3816 c = chop_match(name, op_table_main,
3817 sizeof(op_table_main)/sizeof(uschar *));
3818 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
3819 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
3822 /* If we are skipping, we don't need to perform the operation at all.
3823 This matters for operations like "mask", because the data may not be
3824 in the correct format when skipping. For example, the expression may test
3825 for the existence of $sender_host_address before trying to mask it. For
3826 other operations, doing them may not fail, but it is a waste of time. */
3828 if (skipping && c >= 0) continue;
3830 /* Otherwise, switch on the operator type */
3837 unsigned long int n = Ustrtoul(sub, &t, 10);
3840 expand_string_message = string_sprintf("argument for base62 "
3841 "operator is \"%s\", which is not a decimal number", sub);
3844 t = string_base62(n);
3845 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
3853 unsigned long int n = 0;
3856 uschar *t = Ustrchr(base62_chars, *tt++);
3859 expand_string_message = string_sprintf("argument for base62d "
3860 "operator is \"%s\", which is not a base 62 number", sub);
3863 n = n * 62 + (t - base62_chars);
3865 (void)sprintf(CS buf, "%ld", n);
3866 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
3872 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
3873 if (expanded == NULL)
3875 expand_string_message =
3876 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
3877 expand_string_message);
3880 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
3887 uschar *t = sub - 1;
3888 while (*(++t) != 0) { *t = tolower(*t); count++; }
3889 yield = string_cat(yield, &size, &ptr, sub, count);
3896 uschar *t = sub - 1;
3897 while (*(++t) != 0) { *t = toupper(*t); count++; }
3898 yield = string_cat(yield, &size, &ptr, sub, count);
3909 md5_end(&base, sub, Ustrlen(sub), digest);
3910 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
3911 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
3922 sha1_end(&base, sub, Ustrlen(sub), digest);
3923 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
3924 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
3928 /* Convert hex encoding to base64 encoding */
3938 for (enc = sub; *enc != 0; enc++)
3940 if (!isxdigit(*enc))
3942 expand_string_message = string_sprintf("\"%s\" is not a hex "
3951 expand_string_message = string_sprintf("\"%s\" contains an odd "
3952 "number of characters", sub);
3956 while ((c = *in++) != 0)
3958 if (isdigit(c)) c -= '0';
3959 else c = toupper(c) - 'A' + 10;
3971 enc = auth_b64encode(sub, out - sub);
3972 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
3976 /* mask applies a mask to an IP address; for example the result of
3977 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
3984 int mask, maskoffset;
3985 int type = string_is_ip_address(sub, &maskoffset);
3990 expand_string_message = string_sprintf("\"%s\" is not an IP address",
3995 if (maskoffset == 0)
3997 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4002 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4004 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4006 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4011 /* Convert the address to binary integer(s) and apply the mask */
4013 sub[maskoffset] = 0;
4014 count = host_aton(sub, binary);
4015 host_mask(count, binary, mask);
4017 /* Convert to masked textual format and add to output. */
4019 yield = string_cat(yield, &size, &ptr, buffer,
4020 host_nmtoa(count, binary, mask, buffer, '.'));
4025 case EOP_LOCAL_PART:
4029 int start, end, domain;
4030 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4034 if (c != EOP_DOMAIN)
4036 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4037 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4039 else if (domain != 0)
4042 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4048 /* quote puts a string in quotes if it is empty or contains anything
4049 other than alphamerics, underscore, dot, or hyphen.
4051 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4052 be quoted in order to be a valid local part.
4054 In both cases, newlines and carriage returns are converted into \n and \r
4058 case EOP_QUOTE_LOCAL_PART:
4061 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4062 uschar *t = sub - 1;
4066 while (!needs_quote && *(++t) != 0)
4067 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4069 else /* EOP_QUOTE_LOCAL_PART */
4071 while (!needs_quote && *(++t) != 0)
4072 needs_quote = !isalnum(*t) &&
4073 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4074 (*t != '.' || t == sub || t[1] == 0);
4079 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4084 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4085 else if (*t == '\r')
4086 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4089 if (*t == '\\' || *t == '"')
4090 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4091 yield = string_cat(yield, &size, &ptr, t, 1);
4094 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4096 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4100 /* quote_lookuptype does lookup-specific quoting */
4105 uschar *opt = Ustrchr(arg, '_');
4107 if (opt != NULL) *opt++ = 0;
4109 n = search_findtype(arg, Ustrlen(arg));
4112 expand_string_message = search_error_message;
4116 if (lookup_list[n].quote != NULL)
4117 sub = (lookup_list[n].quote)(sub, opt);
4118 else if (opt != NULL) sub = NULL;
4122 expand_string_message = string_sprintf(
4123 "\"%s\" unrecognized after \"${quote_%s\"",
4128 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4132 /* rx quote sticks in \ before any non-alphameric character so that
4133 the insertion works in a regular expression. */
4137 uschar *t = sub - 1;
4141 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4142 yield = string_cat(yield, &size, &ptr, t, 1);
4147 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4148 prescribed by the RFC, if there are characters that need to be encoded */
4152 uschar buffer[2048];
4153 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4154 buffer, sizeof(buffer));
4155 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4159 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4169 if (c > 255) c = '_';
4171 yield = string_cat(yield, &size, &ptr, buff, 1);
4176 /* escape turns all non-printing characters into escape sequences. */
4180 uschar *t = string_printing(sub);
4181 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4185 /* Handle numeric expression evaluation */
4190 uschar *save_sub = sub;
4191 uschar *error = NULL;
4192 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4195 expand_string_message = string_sprintf("error in expression "
4196 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4200 sprintf(CS var_buffer, "%d", n);
4201 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4205 /* Handle time period formating */
4207 case EOP_TIME_INTERVAL:
4210 uschar *t = read_number(&n, sub);
4211 if (*t != 0) /* Not A Number*/
4213 expand_string_message = string_sprintf("string \"%s\" is not a "
4214 "positive number in \"%s\" operator", sub, name);
4217 t = readconf_printtime(n);
4218 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4222 /* Convert string to base64 encoding */
4226 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4227 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4231 /* strlen returns the length of the string */
4236 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4237 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4241 /* length_n or l_n takes just the first n characters or the whole string,
4242 whichever is the shorter;
4244 substr_m_n, and s_m_n take n characters from offset m; negative m take
4245 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4246 takes the rest, either to the right or to the left.
4248 hash_n or h_n makes a hash of length n from the string, yielding n
4249 characters from the set a-z; hash_n_m makes a hash of length n, but
4250 uses m characters from the set a-zA-Z0-9.
4252 nhash_n returns a single number between 0 and n-1 (in text form), while
4253 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4254 between 0 and n-1 and the second between 0 and m-1. */
4274 expand_string_message = string_sprintf("missing values after %s",
4279 /* "length" has only one argument, effectively being synonymous with
4282 if (c == EOP_LENGTH || c == EOP_L)
4288 /* The others have one or two arguments; for "substr" the first may be
4289 negative. The second being negative means "not supplied". */
4294 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
4297 /* Read up to two numbers, separated by underscores */
4302 if (arg != ret && *arg == '_' && pn == &value1)
4306 if (arg[1] != 0) arg++;
4308 else if (!isdigit(*arg))
4310 expand_string_message =
4311 string_sprintf("non-digit after underscore in \"%s\"", name);
4314 else *pn = (*pn)*10 + *arg++ - '0';
4318 /* Perform the required operation */
4321 (c == EOP_HASH || c == EOP_H)?
4322 compute_hash(sub, value1, value2, &len) :
4323 (c == EOP_NHASH || c == EOP_NH)?
4324 compute_nhash(sub, value1, value2, &len) :
4325 extract_substr(sub, value1, value2, &len);
4327 if (ret == NULL) goto EXPAND_FAILED;
4328 yield = string_cat(yield, &size, &ptr, ret, len);
4338 uschar **modetable[3];
4343 if (stat(CS sub, &st) < 0)
4345 expand_string_message = string_sprintf("stat(%s) failed: %s",
4346 sub, strerror(errno));
4350 switch (mode & S_IFMT)
4352 case S_IFIFO: smode[0] = 'p'; break;
4353 case S_IFCHR: smode[0] = 'c'; break;
4354 case S_IFDIR: smode[0] = 'd'; break;
4355 case S_IFBLK: smode[0] = 'b'; break;
4356 case S_IFREG: smode[0] = '-'; break;
4357 default: smode[0] = '?'; break;
4360 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
4361 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
4362 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
4364 for (i = 0; i < 3; i++)
4366 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
4371 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
4372 "uid=%ld gid=%ld size=%ld atime=%ld mtime=%ld ctime=%ld",
4373 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
4374 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
4375 (long)st.st_gid, (long)st.st_size, (long)st.st_atime,
4376 (long)st.st_mtime, (long)st.st_ctime);
4377 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
4381 /* Unknown operator */
4384 expand_string_message =
4385 string_sprintf("unknown expansion operator \"%s\"", name);
4390 /* Handle a plain name. If this is the first thing in the expansion, release
4391 the pre-allocated buffer. If the result data is known to be in a new buffer,
4392 newsize will be set to the size of that buffer, and we can just point at that
4393 store instead of copying. Many expansion strings contain just one reference,
4394 so this is a useful optimization, especially for humungous headers
4395 ($message_headers). */
4407 value = find_variable(name, FALSE, skipping, &newsize);
4410 expand_string_message =
4411 string_sprintf("unknown variable in \"${%s}\"", name);
4414 len = Ustrlen(value);
4415 if (yield == NULL && newsize != 0)
4421 else yield = string_cat(yield, &size, &ptr, value, len);
4425 /* Else there's something wrong */
4427 expand_string_message =
4428 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
4429 "in a variable reference)", name);
4433 /* If we hit the end of the string when ket_ends is set, there is a missing
4434 terminating brace. */
4436 if (ket_ends && *s == 0)
4438 expand_string_message = malformed_header?
4439 US"missing } at end of string - could be header name not terminated by colon"
4441 US"missing } at end of string";
4445 /* Expansion succeeded; yield may still be NULL here if nothing was actually
4446 added to the string. If so, set up an empty string. Add a terminating zero. If
4447 left != NULL, return a pointer to the terminator. */
4449 if (yield == NULL) yield = store_get(1);
4451 if (left != NULL) *left = s;
4453 /* Any stacking store that was used above the final string is no longer needed.
4454 In many cases the final string will be the first one that was got and so there
4455 will be optimal store usage. */
4457 store_reset(yield + ptr + 1);
4460 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
4462 if (skipping) debug_printf("skipping: result is not used\n");
4466 /* This is the failure exit: easiest to program with a goto. We still need
4467 to update the pointer to the terminator, for cases of nested calls with "fail".
4470 EXPAND_FAILED_CURLY:
4471 expand_string_message = malformed_header?
4472 US"missing or misplaced { or } - could be header name not terminated by colon"
4474 US"missing or misplaced { or }";
4476 /* At one point, Exim reset the store to yield (if yield was not NULL), but
4477 that is a bad idea, because expand_string_message is in dynamic store. */
4480 if (left != NULL) *left = s;
4483 debug_printf("failed to expand: %s\n", string);
4484 debug_printf(" error message: %s\n", expand_string_message);
4485 if (expand_string_forcedfail) debug_printf("failure was forced\n");
4491 /* This is the external function call. Do a quick check for any expansion
4492 metacharacters, and if there are none, just return the input string.
4494 Argument: the string to be expanded
4495 Returns: the expanded string, or NULL if expansion failed; if failure was
4496 due to a lookup deferring, search_find_defer will be TRUE
4500 expand_string(uschar *string)
4502 search_find_defer = FALSE;
4503 malformed_header = FALSE;
4504 return (Ustrpbrk(string, "$\\") == NULL)? string :
4505 expand_string_internal(string, FALSE, NULL, FALSE);
4510 /*************************************************
4512 *************************************************/
4514 /* Now and again we want to expand a string and be sure that the result is in a
4515 new bit of store. This function does that.
4517 Argument: the string to be expanded
4518 Returns: the expanded string, always in a new bit of store, or NULL
4522 expand_string_copy(uschar *string)
4524 uschar *yield = expand_string(string);
4525 if (yield == string) yield = string_copy(string);
4531 /*************************************************
4532 * Expand and interpret as an integer *
4533 *************************************************/
4535 /* Expand a string, and convert the result into an integer.
4537 Argument: the string to be expanded
4539 Returns: the integer value, or
4540 -1 for an expansion error ) in both cases, message in
4541 -2 for an integer interpretation error ) expand_string_message
4546 expand_string_integer(uschar *string)
4549 uschar *s = expand_string(string);
4550 uschar *msg = US"invalid integer \"%s\"";
4553 if (s == NULL) return -1;
4555 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
4556 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
4557 systems, so we set it zero ourselves. */
4560 value = strtol(CS s, CSS &endptr, 0);
4564 msg = US"integer expected but \"%s\" found";
4568 /* Ensure we can cast this down to an int */
4569 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
4571 if (errno != ERANGE)
4573 if (tolower(*endptr) == 'k')
4575 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
4579 else if (tolower(*endptr) == 'm')
4581 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
4583 else value *= 1024*1024;
4587 if (errno == ERANGE)
4588 msg = US"absolute value of integer \"%s\" is too large (overflow)";
4591 while (isspace(*endptr)) endptr++;
4592 if (*endptr == 0) return (int)value;
4596 expand_string_message = string_sprintf(CS msg, s);
4602 /*************************************************
4603 **************************************************
4604 * Stand-alone test program *
4605 **************************************************
4606 *************************************************/
4612 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
4614 int ovector[3*(EXPAND_MAXN+1)];
4615 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
4616 ovector, sizeof(ovector)/sizeof(int));
4617 BOOL yield = n >= 0;
4618 if (n == 0) n = EXPAND_MAXN + 1;
4622 expand_nmax = (setup < 0)? 0 : setup + 1;
4623 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
4625 expand_nstring[expand_nmax] = subject + ovector[nn];
4626 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4634 int main(int argc, uschar **argv)
4637 uschar buffer[1024];
4639 debug_selector = D_v;
4640 debug_file = stderr;
4641 debug_fd = fileno(debug_file);
4642 big_buffer = malloc(big_buffer_size);
4644 for (i = 1; i < argc; i++)
4646 if (argv[i][0] == '+')
4648 debug_trace_memory = 2;
4651 if (isdigit(argv[i][0]))
4652 debug_selector = Ustrtol(argv[i], NULL, 0);
4654 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
4658 eldap_default_servers = argv[i];
4661 mysql_servers = argv[i];
4664 pgsql_servers = argv[i];
4668 else opt_perl_startup = argv[i];
4672 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
4674 expand_nstring[1] = US"string 1....";
4675 expand_nlength[1] = 8;
4679 if (opt_perl_startup != NULL)
4682 printf("Starting Perl interpreter\n");
4683 errstr = init_perl(opt_perl_startup);
4686 printf("** error in perl_startup code: %s\n", errstr);
4687 return EXIT_FAILURE;
4690 #endif /* EXIM_PERL */
4692 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
4694 void *reset_point = store_get(0);
4695 uschar *yield = expand_string(buffer);
4698 printf("%s\n", yield);
4699 store_reset(reset_point);
4703 if (search_find_defer) printf("search_find deferred\n");
4704 printf("Failed: %s\n", expand_string_message);
4705 if (expand_string_forcedfail) printf("Forced failure\n");
4717 /* End of expand.c */