1 /* $Cambridge: exim/src/src/expand.c,v 1.61 2006/09/19 11:28:45 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
11 /* Functions for handling string expansion. */
17 #ifndef SUPPORT_CRYPTEQ
18 #define SUPPORT_CRYPTEQ
22 #ifdef SUPPORT_CRYPTEQ
27 extern char* crypt16(char*, char*);
32 #include "lookups/ldap.h"
37 /* Recursively called function */
39 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
43 /*************************************************
44 * Local statics and tables *
45 *************************************************/
47 /* Table of item names, and corresponding switch numbers. The names must be in
48 alphabetical order. */
50 static uschar *item_table[] = {
88 /* Tables of operator names, and corresponding switch numbers. The names must be
89 in alphabetical order. There are two tables, because underscore is used in some
90 cases to introduce arguments, whereas for other it is part of the name. This is
91 an historical mis-design. */
93 static uschar *op_table_underscore[] = {
103 EOP_QUOTE_LOCAL_PART,
107 static uschar *op_table_main[] = {
138 EOP_ADDRESS = sizeof(op_table_underscore)/sizeof(uschar *),
168 /* Table of condition names, and corresponding switch numbers. The names must
169 be in alphabetical order. */
171 static uschar *cond_table[] = {
175 US"==", /* Backward compatibility */
201 US"match_local_part",
223 ECOND_FIRST_DELIVERY,
240 ECOND_MATCH_LOCAL_PART,
250 /* Type for main variable table */
258 /* Type for entries pointing to address/length pairs. Not currently
266 /* Types of table entry */
269 vtype_int, /* value is address of int */
270 vtype_filter_int, /* ditto, but recognized only when filtering */
271 vtype_ino, /* value is address of ino_t (not always an int) */
272 vtype_uid, /* value is address of uid_t (not always an int) */
273 vtype_gid, /* value is address of gid_t (not always an int) */
274 vtype_stringptr, /* value is address of pointer to string */
275 vtype_msgbody, /* as stringptr, but read when first required */
276 vtype_msgbody_end, /* ditto, the end of the message */
277 vtype_msgheaders, /* the message's headers */
278 vtype_localpart, /* extract local part from string */
279 vtype_domain, /* extract domain from string */
280 vtype_recipients, /* extract recipients from recipients list */
281 /* (enabled only during system filtering */
282 vtype_todbsdin, /* value not used; generate BSD inbox tod */
283 vtype_tode, /* value not used; generate tod in epoch format */
284 vtype_todf, /* value not used; generate full tod */
285 vtype_todl, /* value not used; generate log tod */
286 vtype_todlf, /* value not used; generate log file datestamp tod */
287 vtype_todzone, /* value not used; generate time zone only */
288 vtype_todzulu, /* value not used; generate zulu tod */
289 vtype_reply, /* value not used; get reply from headers */
290 vtype_pid, /* value not used; result is pid */
291 vtype_host_lookup, /* value not used; get host name */
292 vtype_load_avg, /* value not used; result is int from os_getloadavg */
293 vtype_pspace, /* partition space; value is T/F for spool/log */
294 vtype_pinodes /* partition inodes; value is T/F for spool/log */
295 #ifdef EXPERIMENTAL_DOMAINKEYS
296 ,vtype_dk_verify /* Serve request out of DomainKeys verification structure */
300 /* This table must be kept in alphabetical order. */
302 static var_entry var_table[] = {
303 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
304 they will be confused with user-creatable ACL variables. */
305 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
306 { "address_data", vtype_stringptr, &deliver_address_data },
307 { "address_file", vtype_stringptr, &address_file },
308 { "address_pipe", vtype_stringptr, &address_pipe },
309 { "authenticated_id", vtype_stringptr, &authenticated_id },
310 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
311 { "authentication_failed",vtype_int, &authentication_failed },
312 #ifdef EXPERIMENTAL_BRIGHTMAIL
313 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
314 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
315 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
316 { "bmi_deliver", vtype_int, &bmi_deliver },
318 { "body_linecount", vtype_int, &body_linecount },
319 { "body_zerocount", vtype_int, &body_zerocount },
320 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
321 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
322 { "caller_gid", vtype_gid, &real_gid },
323 { "caller_uid", vtype_uid, &real_uid },
324 { "compile_date", vtype_stringptr, &version_date },
325 { "compile_number", vtype_stringptr, &version_cnumber },
326 { "csa_status", vtype_stringptr, &csa_status },
327 #ifdef WITH_OLD_DEMIME
328 { "demime_errorlevel", vtype_int, &demime_errorlevel },
329 { "demime_reason", vtype_stringptr, &demime_reason },
331 #ifdef EXPERIMENTAL_DOMAINKEYS
332 { "dk_domain", vtype_stringptr, &dk_signing_domain },
333 { "dk_is_signed", vtype_dk_verify, NULL },
334 { "dk_result", vtype_dk_verify, NULL },
335 { "dk_selector", vtype_stringptr, &dk_signing_selector },
336 { "dk_sender", vtype_dk_verify, NULL },
337 { "dk_sender_domain", vtype_dk_verify, NULL },
338 { "dk_sender_local_part",vtype_dk_verify, NULL },
339 { "dk_sender_source", vtype_dk_verify, NULL },
340 { "dk_signsall", vtype_dk_verify, NULL },
341 { "dk_status", vtype_dk_verify, NULL },
342 { "dk_testing", vtype_dk_verify, NULL },
344 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
345 { "dnslist_text", vtype_stringptr, &dnslist_text },
346 { "dnslist_value", vtype_stringptr, &dnslist_value },
347 { "domain", vtype_stringptr, &deliver_domain },
348 { "domain_data", vtype_stringptr, &deliver_domain_data },
349 { "exim_gid", vtype_gid, &exim_gid },
350 { "exim_path", vtype_stringptr, &exim_path },
351 { "exim_uid", vtype_uid, &exim_uid },
352 #ifdef WITH_OLD_DEMIME
353 { "found_extension", vtype_stringptr, &found_extension },
355 { "home", vtype_stringptr, &deliver_home },
356 { "host", vtype_stringptr, &deliver_host },
357 { "host_address", vtype_stringptr, &deliver_host_address },
358 { "host_data", vtype_stringptr, &host_data },
359 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
360 { "host_lookup_failed", vtype_int, &host_lookup_failed },
361 { "inode", vtype_ino, &deliver_inode },
362 { "interface_address", vtype_stringptr, &interface_address },
363 { "interface_port", vtype_int, &interface_port },
365 { "ldap_dn", vtype_stringptr, &eldap_dn },
367 { "load_average", vtype_load_avg, NULL },
368 { "local_part", vtype_stringptr, &deliver_localpart },
369 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
370 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
371 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
372 { "local_scan_data", vtype_stringptr, &local_scan_data },
373 { "local_user_gid", vtype_gid, &local_user_gid },
374 { "local_user_uid", vtype_uid, &local_user_uid },
375 { "localhost_number", vtype_int, &host_number },
376 { "log_inodes", vtype_pinodes, (void *)FALSE },
377 { "log_space", vtype_pspace, (void *)FALSE },
378 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
379 #ifdef WITH_CONTENT_SCAN
380 { "malware_name", vtype_stringptr, &malware_name },
382 { "message_age", vtype_int, &message_age },
383 { "message_body", vtype_msgbody, &message_body },
384 { "message_body_end", vtype_msgbody_end, &message_body_end },
385 { "message_body_size", vtype_int, &message_body_size },
386 { "message_exim_id", vtype_stringptr, &message_id },
387 { "message_headers", vtype_msgheaders, NULL },
388 { "message_id", vtype_stringptr, &message_id },
389 { "message_linecount", vtype_int, &message_linecount },
390 { "message_size", vtype_int, &message_size },
391 #ifdef WITH_CONTENT_SCAN
392 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
393 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
394 { "mime_boundary", vtype_stringptr, &mime_boundary },
395 { "mime_charset", vtype_stringptr, &mime_charset },
396 { "mime_content_description", vtype_stringptr, &mime_content_description },
397 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
398 { "mime_content_id", vtype_stringptr, &mime_content_id },
399 { "mime_content_size", vtype_int, &mime_content_size },
400 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
401 { "mime_content_type", vtype_stringptr, &mime_content_type },
402 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
403 { "mime_filename", vtype_stringptr, &mime_filename },
404 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
405 { "mime_is_multipart", vtype_int, &mime_is_multipart },
406 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
407 { "mime_part_count", vtype_int, &mime_part_count },
409 { "n0", vtype_filter_int, &filter_n[0] },
410 { "n1", vtype_filter_int, &filter_n[1] },
411 { "n2", vtype_filter_int, &filter_n[2] },
412 { "n3", vtype_filter_int, &filter_n[3] },
413 { "n4", vtype_filter_int, &filter_n[4] },
414 { "n5", vtype_filter_int, &filter_n[5] },
415 { "n6", vtype_filter_int, &filter_n[6] },
416 { "n7", vtype_filter_int, &filter_n[7] },
417 { "n8", vtype_filter_int, &filter_n[8] },
418 { "n9", vtype_filter_int, &filter_n[9] },
419 { "original_domain", vtype_stringptr, &deliver_domain_orig },
420 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
421 { "originator_gid", vtype_gid, &originator_gid },
422 { "originator_uid", vtype_uid, &originator_uid },
423 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
424 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
425 { "pid", vtype_pid, NULL },
426 { "primary_hostname", vtype_stringptr, &primary_hostname },
427 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
428 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
429 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
430 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
431 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
432 { "rcpt_count", vtype_int, &rcpt_count },
433 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
434 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
435 { "received_count", vtype_int, &received_count },
436 { "received_for", vtype_stringptr, &received_for },
437 { "received_protocol", vtype_stringptr, &received_protocol },
438 { "received_time", vtype_int, &received_time },
439 { "recipient_data", vtype_stringptr, &recipient_data },
440 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
441 { "recipients", vtype_recipients, NULL },
442 { "recipients_count", vtype_int, &recipients_count },
443 #ifdef WITH_CONTENT_SCAN
444 { "regex_match_string", vtype_stringptr, ®ex_match_string },
446 { "reply_address", vtype_reply, NULL },
447 { "return_path", vtype_stringptr, &return_path },
448 { "return_size_limit", vtype_int, &bounce_return_size_limit },
449 { "runrc", vtype_int, &runrc },
450 { "self_hostname", vtype_stringptr, &self_hostname },
451 { "sender_address", vtype_stringptr, &sender_address },
452 { "sender_address_data", vtype_stringptr, &sender_address_data },
453 { "sender_address_domain", vtype_domain, &sender_address },
454 { "sender_address_local_part", vtype_localpart, &sender_address },
455 { "sender_data", vtype_stringptr, &sender_data },
456 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
457 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
458 { "sender_host_address", vtype_stringptr, &sender_host_address },
459 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
460 { "sender_host_name", vtype_host_lookup, NULL },
461 { "sender_host_port", vtype_int, &sender_host_port },
462 { "sender_ident", vtype_stringptr, &sender_ident },
463 { "sender_rate", vtype_stringptr, &sender_rate },
464 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
465 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
466 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
467 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
468 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
469 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
470 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
471 { "sn0", vtype_filter_int, &filter_sn[0] },
472 { "sn1", vtype_filter_int, &filter_sn[1] },
473 { "sn2", vtype_filter_int, &filter_sn[2] },
474 { "sn3", vtype_filter_int, &filter_sn[3] },
475 { "sn4", vtype_filter_int, &filter_sn[4] },
476 { "sn5", vtype_filter_int, &filter_sn[5] },
477 { "sn6", vtype_filter_int, &filter_sn[6] },
478 { "sn7", vtype_filter_int, &filter_sn[7] },
479 { "sn8", vtype_filter_int, &filter_sn[8] },
480 { "sn9", vtype_filter_int, &filter_sn[9] },
481 #ifdef WITH_CONTENT_SCAN
482 { "spam_bar", vtype_stringptr, &spam_bar },
483 { "spam_report", vtype_stringptr, &spam_report },
484 { "spam_score", vtype_stringptr, &spam_score },
485 { "spam_score_int", vtype_stringptr, &spam_score_int },
487 #ifdef EXPERIMENTAL_SPF
488 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
489 { "spf_received", vtype_stringptr, &spf_received },
490 { "spf_result", vtype_stringptr, &spf_result },
491 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
493 { "spool_directory", vtype_stringptr, &spool_directory },
494 { "spool_inodes", vtype_pinodes, (void *)TRUE },
495 { "spool_space", vtype_pspace, (void *)TRUE },
496 #ifdef EXPERIMENTAL_SRS
497 { "srs_db_address", vtype_stringptr, &srs_db_address },
498 { "srs_db_key", vtype_stringptr, &srs_db_key },
499 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
500 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
501 { "srs_recipient", vtype_stringptr, &srs_recipient },
502 { "srs_status", vtype_stringptr, &srs_status },
504 { "thisaddress", vtype_stringptr, &filter_thisaddress },
505 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
506 { "tls_cipher", vtype_stringptr, &tls_cipher },
507 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
508 { "tod_bsdinbox", vtype_todbsdin, NULL },
509 { "tod_epoch", vtype_tode, NULL },
510 { "tod_full", vtype_todf, NULL },
511 { "tod_log", vtype_todl, NULL },
512 { "tod_logfile", vtype_todlf, NULL },
513 { "tod_zone", vtype_todzone, NULL },
514 { "tod_zulu", vtype_todzulu, NULL },
515 { "value", vtype_stringptr, &lookup_value },
516 { "version_number", vtype_stringptr, &version_string },
517 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
518 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
519 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
520 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
521 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
522 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
525 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
526 static uschar var_buffer[256];
527 static BOOL malformed_header;
529 /* For textual hashes */
531 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
532 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
535 enum { HMAC_MD5, HMAC_SHA1 };
537 /* For numeric hashes */
539 static unsigned int prime[] = {
540 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
541 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
542 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
544 /* For printing modes in symbolic form */
546 static uschar *mtable_normal[] =
547 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
549 static uschar *mtable_setid[] =
550 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
552 static uschar *mtable_sticky[] =
553 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
557 /*************************************************
558 * Tables for UTF-8 support *
559 *************************************************/
561 /* Table of the number of extra characters, indexed by the first character
562 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
565 static uschar utf8_table1[] = {
566 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
567 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
568 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
569 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
571 /* These are the masks for the data bits in the first byte of a character,
572 indexed by the number of additional bytes. */
574 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
576 /* Get the next UTF-8 character, advancing the pointer. */
578 #define GETUTF8INC(c, ptr) \
580 if ((c & 0xc0) == 0xc0) \
582 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
584 c = (c & utf8_table2[a]) << s; \
588 c |= (*ptr++ & 0x3f) << s; \
593 /*************************************************
594 * Binary chop search on a table *
595 *************************************************/
597 /* This is used for matching expansion items and operators.
600 name the name that is being sought
601 table the table to search
602 table_size the number of items in the table
604 Returns: the offset in the table, or -1
608 chop_match(uschar *name, uschar **table, int table_size)
610 uschar **bot = table;
611 uschar **top = table + table_size;
615 uschar **mid = bot + (top - bot)/2;
616 int c = Ustrcmp(name, *mid);
617 if (c == 0) return mid - table;
618 if (c > 0) bot = mid + 1; else top = mid;
626 /*************************************************
627 * Check a condition string *
628 *************************************************/
630 /* This function is called to expand a string, and test the result for a "true"
631 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
632 forced fail or lookup defer. All store used by the function can be released on
636 condition the condition string
637 m1 text to be incorporated in panic error
640 Returns: TRUE if condition is met, FALSE if not
644 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
647 void *reset_point = store_get(0);
648 uschar *ss = expand_string(condition);
651 if (!expand_string_forcedfail && !search_find_defer)
652 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
653 "for %s %s: %s", condition, m1, m2, expand_string_message);
656 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
657 strcmpic(ss, US"false") != 0;
658 store_reset(reset_point);
664 /*************************************************
665 * Pick out a name from a string *
666 *************************************************/
668 /* If the name is too long, it is silently truncated.
671 name points to a buffer into which to put the name
672 max is the length of the buffer
673 s points to the first alphabetic character of the name
674 extras chars other than alphanumerics to permit
676 Returns: pointer to the first character after the name
678 Note: The test for *s != 0 in the while loop is necessary because
679 Ustrchr() yields non-NULL if the character is zero (which is not something
683 read_name(uschar *name, int max, uschar *s, uschar *extras)
686 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
688 if (ptr < max-1) name[ptr++] = *s;
697 /*************************************************
698 * Pick out the rest of a header name *
699 *************************************************/
701 /* A variable name starting $header_ (or just $h_ for those who like
702 abbreviations) might not be the complete header name because headers can
703 contain any printing characters in their names, except ':'. This function is
704 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
705 on the end, if the name was terminated by white space.
708 name points to a buffer in which the name read so far exists
709 max is the length of the buffer
710 s points to the first character after the name so far, i.e. the
711 first non-alphameric character after $header_xxxxx
713 Returns: a pointer to the first character after the header name
717 read_header_name(uschar *name, int max, uschar *s)
719 int prelen = Ustrchr(name, '_') - name + 1;
720 int ptr = Ustrlen(name) - prelen;
721 if (ptr > 0) memmove(name, name+prelen, ptr);
722 while (mac_isgraph(*s) && *s != ':')
724 if (ptr < max-1) name[ptr++] = *s;
735 /*************************************************
736 * Pick out a number from a string *
737 *************************************************/
740 n points to an integer into which to put the number
741 s points to the first digit of the number
743 Returns: a pointer to the character after the last digit
747 read_number(int *n, uschar *s)
750 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
756 /*************************************************
757 * Extract keyed subfield from a string *
758 *************************************************/
760 /* The yield is in dynamic store; NULL means that the key was not found.
763 key points to the name of the key
764 s points to the string from which to extract the subfield
766 Returns: NULL if the subfield was not found, or
767 a pointer to the subfield's data
771 expand_getkeyed(uschar *key, uschar *s)
773 int length = Ustrlen(key);
774 while (isspace(*s)) s++;
776 /* Loop to search for the key */
784 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
785 dkeylength = s - dkey;
786 while (isspace(*s)) s++;
787 if (*s == '=') while (isspace((*(++s))));
789 data = string_dequote(&s);
790 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
793 while (isspace(*s)) s++;
802 /*************************************************
803 * Extract numbered subfield from string *
804 *************************************************/
806 /* Extracts a numbered field from a string that is divided by tokens - for
807 example a line from /etc/passwd is divided by colon characters. First field is
808 numbered one. Negative arguments count from the right. Zero returns the whole
809 string. Returns NULL if there are insufficient tokens in the string
812 Modifies final argument - this is a dynamically generated string, so that's OK.
815 field number of field to be extracted,
816 first field = 1, whole string = 0, last field = -1
817 separators characters that are used to break string into tokens
818 s points to the string from which to extract the subfield
820 Returns: NULL if the field was not found,
821 a pointer to the field's data inside s (modified to add 0)
825 expand_gettokened (int field, uschar *separators, uschar *s)
830 uschar *fieldtext = NULL;
832 if (field == 0) return s;
834 /* Break the line up into fields in place; for field > 0 we stop when we have
835 done the number of fields we want. For field < 0 we continue till the end of
836 the string, counting the number of fields. */
838 count = (field > 0)? field : INT_MAX;
844 /* Previous field was the last one in the string. For a positive field
845 number, this means there are not enough fields. For a negative field number,
846 check that there are enough, and scan back to find the one that is wanted. */
850 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
851 if ((-field) == (INT_MAX - count - 1)) return s;
855 while (ss[-1] != 0) ss--;
861 /* Previous field was not last in the string; save its start and put a
865 len = Ustrcspn(ss, separators);
876 /*************************************************
877 * Extract a substring from a string *
878 *************************************************/
880 /* Perform the ${substr or ${length expansion operations.
883 subject the input string
884 value1 the offset from the start of the input string to the start of
885 the output string; if negative, count from the right.
886 value2 the length of the output string, or negative (-1) for unset
887 if value1 is positive, unset means "all after"
888 if value1 is negative, unset means "all before"
889 len set to the length of the returned string
891 Returns: pointer to the output string, or NULL if there is an error
895 extract_substr(uschar *subject, int value1, int value2, int *len)
897 int sublen = Ustrlen(subject);
899 if (value1 < 0) /* count from right */
903 /* If the position is before the start, skip to the start, and adjust the
904 length. If the length ends up negative, the substring is null because nothing
905 can precede. This falls out naturally when the length is unset, meaning "all
911 if (value2 < 0) value2 = 0;
915 /* Otherwise an unset length => characters before value1 */
924 /* For a non-negative offset, if the starting position is past the end of the
925 string, the result will be the null string. Otherwise, an unset length means
926 "rest"; just set it to the maximum - it will be cut down below if necessary. */
935 else if (value2 < 0) value2 = sublen;
938 /* Cut the length down to the maximum possible for the offset value, and get
939 the required characters. */
941 if (value1 + value2 > sublen) value2 = sublen - value1;
943 return subject + value1;
949 /*************************************************
950 * Old-style hash of a string *
951 *************************************************/
953 /* Perform the ${hash expansion operation.
956 subject the input string (an expanded substring)
957 value1 the length of the output string; if greater or equal to the
958 length of the input string, the input string is returned
959 value2 the number of hash characters to use, or 26 if negative
960 len set to the length of the returned string
962 Returns: pointer to the output string, or NULL if there is an error
966 compute_hash(uschar *subject, int value1, int value2, int *len)
968 int sublen = Ustrlen(subject);
970 if (value2 < 0) value2 = 26;
971 else if (value2 > Ustrlen(hashcodes))
973 expand_string_message =
974 string_sprintf("hash count \"%d\" too big", value2);
978 /* Calculate the hash text. We know it is shorter than the original string, so
979 can safely place it in subject[] (we know that subject is always itself an
980 expanded substring). */
987 while ((c = (subject[j])) != 0)
989 int shift = (c + j++) & 7;
990 subject[i] ^= (c << shift) | (c >> (8-shift));
991 if (++i >= value1) i = 0;
993 for (i = 0; i < value1; i++)
994 subject[i] = hashcodes[(subject[i]) % value2];
996 else value1 = sublen;
1005 /*************************************************
1006 * Numeric hash of a string *
1007 *************************************************/
1009 /* Perform the ${nhash expansion operation. The first characters of the
1010 string are treated as most important, and get the highest prime numbers.
1013 subject the input string
1014 value1 the maximum value of the first part of the result
1015 value2 the maximum value of the second part of the result,
1016 or negative to produce only a one-part result
1017 len set to the length of the returned string
1019 Returns: pointer to the output string, or NULL if there is an error.
1023 compute_nhash (uschar *subject, int value1, int value2, int *len)
1025 uschar *s = subject;
1027 unsigned long int total = 0; /* no overflow */
1031 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1032 total += prime[i--] * (unsigned int)(*s++);
1035 /* If value2 is unset, just compute one number */
1039 s = string_sprintf("%d", total % value1);
1042 /* Otherwise do a div/mod hash */
1046 total = total % (value1 * value2);
1047 s = string_sprintf("%d/%d", total/value2, total % value2);
1058 /*************************************************
1059 * Find the value of a header or headers *
1060 *************************************************/
1062 /* Multiple instances of the same header get concatenated, and this function
1063 can also return a concatenation of all the header lines. When concatenating
1064 specific headers that contain lists of addresses, a comma is inserted between
1065 them. Otherwise we use a straight concatenation. Because some messages can have
1066 pathologically large number of lines, there is a limit on the length that is
1067 returned. Also, to avoid massive store use which would result from using
1068 string_cat() as it copies and extends strings, we do a preliminary pass to find
1069 out exactly how much store will be needed. On "normal" messages this will be
1073 name the name of the header, without the leading $header_ or $h_,
1074 or NULL if a concatenation of all headers is required
1075 exists_only TRUE if called from a def: test; don't need to build a string;
1076 just return a string that is not "" and not "0" if the header
1078 newsize return the size of memory block that was obtained; may be NULL
1079 if exists_only is TRUE
1080 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1081 other than concatenating, will be done on the header
1082 charset name of charset to translate MIME words to; used only if
1083 want_raw is false; if NULL, no translation is done (this is
1084 used for $bh_ and $bheader_)
1086 Returns: NULL if the header does not exist, else a pointer to a new
1091 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1094 BOOL found = name == NULL;
1096 int len = found? 0 : Ustrlen(name);
1098 uschar *yield = NULL;
1101 /* Loop for two passes - saves code repetition */
1103 for (i = 0; i < 2; i++)
1108 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1110 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1112 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1117 if (exists_only) return US"1"; /* don't need actual string */
1119 t = h->text + len; /* text to insert */
1120 if (!want_raw) /* unless wanted raw, */
1121 while (isspace(*t)) t++; /* remove leading white space */
1122 ilen = h->slen - (t - h->text); /* length to insert */
1124 /* Set comma = 1 if handling a single header and it's one of those
1125 that contains an address list, except when asked for raw headers. Only
1126 need to do this once. */
1128 if (!want_raw && name != NULL && comma == 0 &&
1129 Ustrchr("BCFRST", h->type) != NULL)
1132 /* First pass - compute total store needed; second pass - compute
1133 total store used, including this header. */
1135 size += ilen + comma;
1137 /* Second pass - concatentate the data, up to a maximum. Note that
1138 the loop stops when size hits the limit. */
1142 if (size > header_insert_maxlen)
1144 ilen -= size - header_insert_maxlen;
1147 Ustrncpy(ptr, t, ilen);
1149 if (comma != 0 && ilen > 0)
1159 /* At end of first pass, truncate size if necessary, and get the buffer
1160 to hold the data, returning the buffer size. */
1164 if (!found) return NULL;
1165 if (size > header_insert_maxlen) size = header_insert_maxlen;
1166 *newsize = size + 1;
1167 ptr = yield = store_get(*newsize);
1171 /* Remove a redundant added comma if present */
1173 if (comma != 0 && ptr > yield) ptr -= 2;
1175 /* That's all we do for raw header expansion. */
1182 /* Otherwise, we remove trailing whitespace, including newlines. Then we do RFC
1183 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1184 function can return an error with decoded data if the charset translation
1185 fails. If decoding fails, it returns NULL. */
1189 uschar *decoded, *error;
1190 while (ptr > yield && isspace(ptr[-1])) ptr--;
1192 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1196 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1197 " input was: %s\n", error, yield);
1199 if (decoded != NULL) yield = decoded;
1208 /*************************************************
1209 * Find value of a variable *
1210 *************************************************/
1212 /* The table of variables is kept in alphabetic order, so we can search it
1213 using a binary chop. The "choplen" variable is nothing to do with the binary
1217 name the name of the variable being sought
1218 exists_only TRUE if this is a def: test; passed on to find_header()
1219 skipping TRUE => skip any processing evaluation; this is not the same as
1220 exists_only because def: may test for values that are first
1222 newsize pointer to an int which is initially zero; if the answer is in
1223 a new memory buffer, *newsize is set to its size
1225 Returns: NULL if the variable does not exist, or
1226 a pointer to the variable's contents, or
1227 something non-NULL if exists_only is TRUE
1231 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1234 int last = var_table_size;
1236 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1237 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1238 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1239 characters are acl_c or acl_m (this gave backwards compatibility at the
1240 changeover). There may be built-in variables whose names start acl_ but they
1241 should never start acl_c or acl_m. This slightly messy specification is a
1242 consequence of the history, needless to say.
1244 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1245 set, in which case give an error. */
1247 if (Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0)
1250 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1251 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1254 /* Handle $auth<n> variables. */
1256 if (Ustrncmp(name, "auth", 4) == 0)
1259 int n = Ustrtoul(name + 4, &endptr, 10);
1260 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1261 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1264 /* For all other variables, search the table */
1266 while (last > first)
1270 int middle = (first + last)/2;
1271 int c = Ustrcmp(name, var_table[middle].name);
1273 if (c > 0) { first = middle + 1; continue; }
1274 if (c < 0) { last = middle; continue; }
1276 /* Found an existing variable. If in skipping state, the value isn't needed,
1277 and we want to avoid processing (such as looking up the host name). */
1279 if (skipping) return US"";
1281 switch (var_table[middle].type)
1283 #ifdef EXPERIMENTAL_DOMAINKEYS
1285 case vtype_dk_verify:
1286 if (dk_verify_block == NULL) return US"";
1288 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1289 s = dk_verify_block->result_string;
1290 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1291 s = dk_verify_block->address;
1292 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1293 s = dk_verify_block->domain;
1294 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1295 s = dk_verify_block->local_part;
1297 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1298 switch(dk_verify_block->address_source) {
1299 case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1300 case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1301 case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1304 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1305 switch(dk_verify_block->result) {
1306 case DK_EXIM_RESULT_ERR: s = US"error"; break;
1307 case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1308 case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1309 case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1310 case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1311 case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1312 case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1313 case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1316 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1317 s = (dk_verify_block->signsall)? US"1" : US"0";
1319 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1320 s = (dk_verify_block->testing)? US"1" : US"0";
1322 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1323 s = (dk_verify_block->is_signed)? US"1" : US"0";
1325 return (s == NULL)? US"" : s;
1328 case vtype_filter_int:
1329 if (!filter_running) return NULL;
1333 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1337 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1341 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1345 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1348 case vtype_stringptr: /* Pointer to string */
1349 s = *((uschar **)(var_table[middle].value));
1350 return (s == NULL)? US"" : s;
1353 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1356 case vtype_load_avg:
1357 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1360 case vtype_host_lookup: /* Lookup if not done so */
1361 if (sender_host_name == NULL && sender_host_address != NULL &&
1362 !host_lookup_failed && host_name_lookup() == OK)
1363 host_build_sender_fullhost();
1364 return (sender_host_name == NULL)? US"" : sender_host_name;
1366 case vtype_localpart: /* Get local part from address */
1367 s = *((uschar **)(var_table[middle].value));
1368 if (s == NULL) return US"";
1369 domain = Ustrrchr(s, '@');
1370 if (domain == NULL) return s;
1371 if (domain - s > sizeof(var_buffer) - 1)
1372 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1373 "string expansion", sizeof(var_buffer));
1374 Ustrncpy(var_buffer, s, domain - s);
1375 var_buffer[domain - s] = 0;
1378 case vtype_domain: /* Get domain from address */
1379 s = *((uschar **)(var_table[middle].value));
1380 if (s == NULL) return US"";
1381 domain = Ustrrchr(s, '@');
1382 return (domain == NULL)? US"" : domain + 1;
1384 case vtype_msgheaders:
1385 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1387 case vtype_msgbody: /* Pointer to msgbody string */
1388 case vtype_msgbody_end: /* Ditto, the end of the msg */
1389 ss = (uschar **)(var_table[middle].value);
1390 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1393 off_t start_offset = SPOOL_DATA_START_OFFSET;
1394 int len = message_body_visible;
1395 if (len > message_size) len = message_size;
1396 *ss = body = store_malloc(len+1);
1398 if (var_table[middle].type == vtype_msgbody_end)
1400 struct stat statbuf;
1401 if (fstat(deliver_datafile, &statbuf) == 0)
1403 start_offset = statbuf.st_size - len;
1404 if (start_offset < SPOOL_DATA_START_OFFSET)
1405 start_offset = SPOOL_DATA_START_OFFSET;
1408 lseek(deliver_datafile, start_offset, SEEK_SET);
1409 len = read(deliver_datafile, body, len);
1415 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1419 return (*ss == NULL)? US"" : *ss;
1421 case vtype_todbsdin: /* BSD inbox time of day */
1422 return tod_stamp(tod_bsdin);
1424 case vtype_tode: /* Unix epoch time of day */
1425 return tod_stamp(tod_epoch);
1427 case vtype_todf: /* Full time of day */
1428 return tod_stamp(tod_full);
1430 case vtype_todl: /* Log format time of day */
1431 return tod_stamp(tod_log_bare); /* (without timezone) */
1433 case vtype_todzone: /* Time zone offset only */
1434 return tod_stamp(tod_zone);
1436 case vtype_todzulu: /* Zulu time */
1437 return tod_stamp(tod_zulu);
1439 case vtype_todlf: /* Log file datestamp tod */
1440 return tod_stamp(tod_log_datestamp);
1442 case vtype_reply: /* Get reply address */
1443 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1445 if (s != NULL) while (isspace(*s)) s++;
1446 if (s == NULL || *s == 0)
1448 *newsize = 0; /* For the *s==0 case */
1449 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1454 while (isspace(*s)) s++;
1455 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1456 while (t > s && isspace(t[-1])) t--;
1459 return (s == NULL)? US"" : s;
1461 /* A recipients list is available only during system message filtering,
1462 during ACL processing after DATA, and while expanding pipe commands
1463 generated from a system filter, but not elsewhere. */
1465 case vtype_recipients:
1466 if (!enable_dollar_recipients) return NULL; else
1471 s = store_get(size);
1472 for (i = 0; i < recipients_count; i++)
1474 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1475 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1476 Ustrlen(recipients_list[i].address));
1478 s[ptr] = 0; /* string_cat() leaves room */
1485 sprintf(CS var_buffer, "%d",
1486 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1493 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1494 sprintf(CS var_buffer, "%d", inodes);
1500 return NULL; /* Unknown variable name */
1506 /*************************************************
1507 * Read and expand substrings *
1508 *************************************************/
1510 /* This function is called to read and expand argument substrings for various
1511 expansion items. Some have a minimum requirement that is less than the maximum;
1512 in these cases, the first non-present one is set to NULL.
1515 sub points to vector of pointers to set
1516 n maximum number of substrings
1518 sptr points to current string pointer
1519 skipping the skipping flag
1520 check_end if TRUE, check for final '}'
1521 name name of item, for error message
1523 Returns: 0 OK; string pointer updated
1524 1 curly bracketing error (too few arguments)
1525 2 too many arguments (only if check_end is set); message set
1526 3 other error (expansion failure)
1530 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1531 BOOL check_end, uschar *name)
1536 while (isspace(*s)) s++;
1537 for (i = 0; i < n; i++)
1541 if (i < m) return 1;
1545 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1546 if (sub[i] == NULL) return 3;
1547 if (*s++ != '}') return 1;
1548 while (isspace(*s)) s++;
1550 if (check_end && *s++ != '}')
1554 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1555 "(max is %d)", name, n);
1568 /*************************************************
1569 * Read and evaluate a condition *
1570 *************************************************/
1574 s points to the start of the condition text
1575 yield points to a BOOL to hold the result of the condition test;
1576 if NULL, we are just reading through a condition that is
1577 part of an "or" combination to check syntax, or in a state
1578 where the answer isn't required
1580 Returns: a pointer to the first character after the condition, or
1585 eval_condition(uschar *s, BOOL *yield)
1587 BOOL testfor = TRUE;
1588 BOOL tempcond, combined_cond;
1590 int i, rc, cond_type, roffset;
1592 struct stat statbuf;
1597 const uschar *rerror;
1601 while (isspace(*s)) s++;
1602 if (*s == '!') { testfor = !testfor; s++; } else break;
1605 /* Numeric comparisons are symbolic */
1607 if (*s == '=' || *s == '>' || *s == '<')
1619 /* All other conditions are named */
1621 else s = read_name(name, 256, s, US"_");
1623 /* If we haven't read a name, it means some non-alpha character is first. */
1627 expand_string_message = string_sprintf("condition name expected, "
1628 "but found \"%.16s\"", s);
1632 /* Find which condition we are dealing with, and switch on it */
1634 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1637 /* def: tests for a non-empty variable, or for the existence of a header. If
1638 yield == NULL we are in a skipping state, and don't care about the answer. */
1643 expand_string_message = US"\":\" expected after \"def\"";
1647 s = read_name(name, 256, s+1, US"_");
1649 /* Test for a header's existence */
1651 if (Ustrncmp(name, "h_", 2) == 0 ||
1652 Ustrncmp(name, "rh_", 3) == 0 ||
1653 Ustrncmp(name, "bh_", 3) == 0 ||
1654 Ustrncmp(name, "header_", 7) == 0 ||
1655 Ustrncmp(name, "rheader_", 8) == 0 ||
1656 Ustrncmp(name, "bheader_", 8) == 0)
1658 s = read_header_name(name, 256, s);
1659 if (yield != NULL) *yield =
1660 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1663 /* Test for a variable's having a non-empty value. A non-existent variable
1664 causes an expansion failure. */
1668 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1671 expand_string_message = (name[0] == 0)?
1672 string_sprintf("variable name omitted after \"def:\"") :
1673 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1675 if (strict_acl_vars &&
1676 Ustrncmp(name, "acl_", 4) == 0 &&
1677 (name[4] == 'c' || name[4] == 'm'))
1678 expand_string_message = string_sprintf("%s (strict_acl_vars is set)",
1679 expand_string_message);
1683 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1689 /* first_delivery tests for first delivery attempt */
1691 case ECOND_FIRST_DELIVERY:
1692 if (yield != NULL) *yield = deliver_firsttime == testfor;
1696 /* queue_running tests for any process started by a queue runner */
1698 case ECOND_QUEUE_RUNNING:
1699 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1703 /* exists: tests for file existence
1704 isip: tests for any IP address
1705 isip4: tests for an IPv4 address
1706 isip6: tests for an IPv6 address
1707 pam: does PAM authentication
1708 radius: does RADIUS authentication
1709 ldapauth: does LDAP authentication
1710 pwcheck: does Cyrus SASL pwcheck authentication
1719 case ECOND_LDAPAUTH:
1722 while (isspace(*s)) s++;
1723 if (*s != '{') goto COND_FAILED_CURLY_START;
1725 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1726 if (sub[0] == NULL) return NULL;
1727 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1729 if (yield == NULL) return s; /* No need to run the test if skipping */
1734 if ((expand_forbid & RDO_EXISTS) != 0)
1736 expand_string_message = US"File existence tests are not permitted";
1739 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1745 rc = string_is_ip_address(sub[0], NULL);
1746 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1747 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1750 /* Various authentication tests - all optionally compiled */
1754 rc = auth_call_pam(sub[0], &expand_string_message);
1757 goto COND_FAILED_NOT_COMPILED;
1758 #endif /* SUPPORT_PAM */
1761 #ifdef RADIUS_CONFIG_FILE
1762 rc = auth_call_radius(sub[0], &expand_string_message);
1765 goto COND_FAILED_NOT_COMPILED;
1766 #endif /* RADIUS_CONFIG_FILE */
1768 case ECOND_LDAPAUTH:
1771 /* Just to keep the interface the same */
1773 int old_pool = store_pool;
1774 store_pool = POOL_SEARCH;
1775 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1776 &expand_string_message, &do_cache);
1777 store_pool = old_pool;
1781 goto COND_FAILED_NOT_COMPILED;
1782 #endif /* LOOKUP_LDAP */
1785 #ifdef CYRUS_PWCHECK_SOCKET
1786 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1789 goto COND_FAILED_NOT_COMPILED;
1790 #endif /* CYRUS_PWCHECK_SOCKET */
1792 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1793 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1795 if (rc == ERROR || rc == DEFER) return NULL;
1796 *yield = (rc == OK) == testfor;
1802 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1804 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1806 However, the last two are optional. That is why the whole set is enclosed
1807 in their own set or braces. */
1809 case ECOND_SASLAUTHD:
1810 #ifndef CYRUS_SASLAUTHD_SOCKET
1811 goto COND_FAILED_NOT_COMPILED;
1813 while (isspace(*s)) s++;
1814 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1815 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1817 case 1: expand_string_message = US"too few arguments or bracketing "
1818 "error for saslauthd";
1820 case 3: return NULL;
1822 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1826 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1827 &expand_string_message);
1828 if (rc == ERROR || rc == DEFER) return NULL;
1829 *yield = (rc == OK) == testfor;
1832 #endif /* CYRUS_SASLAUTHD_SOCKET */
1835 /* symbolic operators for numeric and string comparison, and a number of
1836 other operators, all requiring two arguments.
1838 match: does a regular expression match and sets up the numerical
1839 variables if it succeeds
1840 match_address: matches in an address list
1841 match_domain: matches in a domain list
1842 match_ip: matches a host list that is restricted to IP addresses
1843 match_local_part: matches in a local part list
1844 crypteq: encrypts plaintext and compares against an encrypted text,
1845 using crypt(), crypt16(), MD5 or SHA-1
1849 case ECOND_MATCH_ADDRESS:
1850 case ECOND_MATCH_DOMAIN:
1851 case ECOND_MATCH_IP:
1852 case ECOND_MATCH_LOCAL_PART:
1855 case ECOND_NUM_L: /* Numerical comparisons */
1862 case ECOND_STR_LT: /* String comparisons */
1873 for (i = 0; i < 2; i++)
1875 while (isspace(*s)) s++;
1878 if (i == 0) goto COND_FAILED_CURLY_START;
1879 expand_string_message = string_sprintf("missing 2nd string in {} "
1880 "after \"%s\"", name);
1883 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1884 if (sub[i] == NULL) return NULL;
1885 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1887 /* Convert to numerical if required; we know that the names of all the
1888 conditions that compare numbers do not start with a letter. This just saves
1889 checking for them individually. */
1891 if (!isalpha(name[0]))
1893 num[i] = expand_string_integer(sub[i], FALSE);
1894 if (expand_string_message != NULL) return NULL;
1898 /* Result not required */
1900 if (yield == NULL) return s;
1902 /* Do an appropriate comparison */
1908 *yield = (num[0] == num[1]) == testfor;
1912 *yield = (num[0] > num[1]) == testfor;
1916 *yield = (num[0] >= num[1]) == testfor;
1920 *yield = (num[0] < num[1]) == testfor;
1924 *yield = (num[0] <= num[1]) == testfor;
1928 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1932 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1936 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1940 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1944 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1948 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1952 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1956 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1960 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
1964 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
1967 case ECOND_MATCH: /* Regular expression match */
1968 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1972 expand_string_message = string_sprintf("regular expression error in "
1973 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1976 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1979 case ECOND_MATCH_ADDRESS: /* Match in an address list */
1980 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1981 goto MATCHED_SOMETHING;
1983 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
1984 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1985 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1986 goto MATCHED_SOMETHING;
1988 case ECOND_MATCH_IP: /* Match IP address in a host list */
1989 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
1991 expand_string_message = string_sprintf("\"%s\" is not an IP address",
1997 unsigned int *nullcache = NULL;
1998 check_host_block cb;
2000 cb.host_name = US"";
2001 cb.host_address = sub[0];
2003 /* If the host address starts off ::ffff: it is an IPv6 address in
2004 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2007 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2008 cb.host_address + 7 : cb.host_address;
2010 rc = match_check_list(
2011 &sub[1], /* the list */
2012 0, /* separator character */
2013 &hostlist_anchor, /* anchor pointer */
2014 &nullcache, /* cache pointer */
2015 check_host, /* function for testing */
2016 &cb, /* argument for function */
2017 MCL_HOST, /* type of check */
2018 sub[0], /* text for debugging */
2019 NULL); /* where to pass back data */
2021 goto MATCHED_SOMETHING;
2023 case ECOND_MATCH_LOCAL_PART:
2024 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2025 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2040 expand_string_message = string_sprintf("unable to complete match "
2041 "against \"%s\": %s", sub[1], search_error_message);
2047 /* Various "encrypted" comparisons. If the second string starts with
2048 "{" then an encryption type is given. Default to crypt() or crypt16()
2049 (build-time choice). */
2052 #ifndef SUPPORT_CRYPTEQ
2053 goto COND_FAILED_NOT_COMPILED;
2055 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2057 int sublen = Ustrlen(sub[1]+5);
2062 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2064 /* If the length that we are comparing against is 24, the MD5 digest
2065 is expressed as a base64 string. This is the way LDAP does it. However,
2066 some other software uses a straightforward hex representation. We assume
2067 this if the length is 32. Other lengths fail. */
2071 uschar *coded = auth_b64encode((uschar *)digest, 16);
2072 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2073 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2074 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2076 else if (sublen == 32)
2080 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2082 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2083 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2084 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2088 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2089 "fail\n crypted=%s\n", sub[1]+5);
2094 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2096 int sublen = Ustrlen(sub[1]+6);
2101 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2103 /* If the length that we are comparing against is 28, assume the SHA1
2104 digest is expressed as a base64 string. If the length is 40, assume a
2105 straightforward hex representation. Other lengths fail. */
2109 uschar *coded = auth_b64encode((uschar *)digest, 20);
2110 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2111 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2112 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2114 else if (sublen == 40)
2118 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2120 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2121 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2122 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2126 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2127 "fail\n crypted=%s\n", sub[1]+6);
2132 else /* {crypt} or {crypt16} and non-{ at start */
2137 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2142 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2147 else if (sub[1][0] == '{')
2149 expand_string_message = string_sprintf("unknown encryption mechanism "
2150 "in \"%s\"", sub[1]);
2156 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2157 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2158 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2162 #define XSTR(s) STR(s)
2163 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2164 " subject=%s\n crypted=%s\n",
2165 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2170 /* If the encrypted string contains fewer than two characters (for the
2171 salt), force failure. Otherwise we get false positives: with an empty
2172 string the yield of crypt() is an empty string! */
2174 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2175 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2178 #endif /* SUPPORT_CRYPTEQ */
2179 } /* Switch for comparison conditions */
2181 return s; /* End of comparison conditions */
2184 /* and/or: computes logical and/or of several conditions */
2188 subcondptr = (yield == NULL)? NULL : &tempcond;
2189 combined_cond = (cond_type == ECOND_AND);
2191 while (isspace(*s)) s++;
2192 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2196 while (isspace(*s)) s++;
2197 if (*s == '}') break;
2200 expand_string_message = string_sprintf("each subcondition "
2201 "inside an \"%s{...}\" condition must be in its own {}", name);
2205 s = eval_condition(s+1, subcondptr);
2208 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2209 expand_string_message, name);
2212 while (isspace(*s)) s++;
2216 expand_string_message = string_sprintf("missing } at end of condition "
2217 "inside \"%s\" group", name);
2223 if (cond_type == ECOND_AND)
2225 combined_cond &= tempcond;
2226 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2227 } /* evaluate any more */
2230 combined_cond |= tempcond;
2231 if (combined_cond) subcondptr = NULL; /* once true, don't */
2232 } /* evaluate any more */
2236 if (yield != NULL) *yield = (combined_cond == testfor);
2240 /* Unknown condition */
2243 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2245 } /* End switch on condition type */
2247 /* Missing braces at start and end of data */
2249 COND_FAILED_CURLY_START:
2250 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2253 COND_FAILED_CURLY_END:
2254 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2258 /* A condition requires code that is not compiled */
2260 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2261 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2262 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2263 COND_FAILED_NOT_COMPILED:
2264 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2273 /*************************************************
2274 * Save numerical variables *
2275 *************************************************/
2277 /* This function is called from items such as "if" that want to preserve and
2278 restore the numbered variables.
2281 save_expand_string points to an array of pointers to set
2282 save_expand_nlength points to an array of ints for the lengths
2284 Returns: the value of expand max to save
2288 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2291 for (i = 0; i <= expand_nmax; i++)
2293 save_expand_nstring[i] = expand_nstring[i];
2294 save_expand_nlength[i] = expand_nlength[i];
2301 /*************************************************
2302 * Restore numerical variables *
2303 *************************************************/
2305 /* This function restored saved values of numerical strings.
2308 save_expand_nmax the number of strings to restore
2309 save_expand_string points to an array of pointers
2310 save_expand_nlength points to an array of ints
2316 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2317 int *save_expand_nlength)
2320 expand_nmax = save_expand_nmax;
2321 for (i = 0; i <= expand_nmax; i++)
2323 expand_nstring[i] = save_expand_nstring[i];
2324 expand_nlength[i] = save_expand_nlength[i];
2332 /*************************************************
2333 * Handle yes/no substrings *
2334 *************************************************/
2336 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2337 alternative substrings that depend on whether or not the condition was true,
2338 or the lookup or extraction succeeded. The substrings always have to be
2339 expanded, to check their syntax, but "skipping" is set when the result is not
2340 needed - this avoids unnecessary nested lookups.
2343 skipping TRUE if we were skipping when this item was reached
2344 yes TRUE if the first string is to be used, else use the second
2345 save_lookup a value to put back into lookup_value before the 2nd expansion
2346 sptr points to the input string pointer
2347 yieldptr points to the output string pointer
2348 sizeptr points to the output string size
2349 ptrptr points to the output string pointer
2350 type "lookup" or "if" or "extract" or "run", for error message
2352 Returns: 0 OK; lookup_value has been reset to save_lookup
2354 2 expansion failed because of bracketing error
2358 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2359 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2362 uschar *s = *sptr; /* Local value */
2363 uschar *sub1, *sub2;
2365 /* If there are no following strings, we substitute the contents of $value for
2366 lookups and for extractions in the success case. For the ${if item, the string
2367 "true" is substituted. In the fail case, nothing is substituted for all three
2370 while (isspace(*s)) s++;
2375 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2379 if (yes && lookup_value != NULL)
2380 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2381 Ustrlen(lookup_value));
2382 lookup_value = save_lookup;
2388 /* The first following string must be braced. */
2390 if (*s++ != '{') goto FAILED_CURLY;
2392 /* Expand the first substring. Forced failures are noticed only if we actually
2393 want this string. Set skipping in the call in the fail case (this will always
2394 be the case if we were already skipping). */
2396 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2397 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2398 expand_string_forcedfail = FALSE;
2399 if (*s++ != '}') goto FAILED_CURLY;
2401 /* If we want the first string, add it to the output */
2404 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2406 /* If this is called from a lookup or an extract, we want to restore $value to
2407 what it was at the start of the item, so that it has this value during the
2408 second string expansion. For the call from "if" or "run" to this function,
2409 save_lookup is set to lookup_value, so that this statement does nothing. */
2411 lookup_value = save_lookup;
2413 /* There now follows either another substring, or "fail", or nothing. This
2414 time, forced failures are noticed only if we want the second string. We must
2415 set skipping in the nested call if we don't want this string, or if we were
2416 already skipping. */
2418 while (isspace(*s)) s++;
2421 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2422 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2423 expand_string_forcedfail = FALSE;
2424 if (*s++ != '}') goto FAILED_CURLY;
2426 /* If we want the second string, add it to the output */
2429 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2432 /* If there is no second string, but the word "fail" is present when the use of
2433 the second string is wanted, set a flag indicating it was a forced failure
2434 rather than a syntactic error. Swallow the terminating } in case this is nested
2435 inside another lookup or if or extract. */
2440 s = read_name(name, sizeof(name), s, US"_");
2441 if (Ustrcmp(name, "fail") == 0)
2443 if (!yes && !skipping)
2445 while (isspace(*s)) s++;
2446 if (*s++ != '}') goto FAILED_CURLY;
2447 expand_string_message =
2448 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2449 expand_string_forcedfail = TRUE;
2455 expand_string_message =
2456 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2461 /* All we have to do now is to check on the final closing brace. */
2463 while (isspace(*s)) s++;
2464 if (*s++ == '}') goto RETURN;
2466 /* Get here if there is a bracketing failure */
2471 /* Get here for other failures */
2476 /* Update the input pointer value before returning */
2486 /*************************************************
2487 * Handle MD5 or SHA-1 computation for HMAC *
2488 *************************************************/
2490 /* These are some wrapping functions that enable the HMAC code to be a bit
2491 cleaner. A good compiler will spot the tail recursion.
2494 type HMAC_MD5 or HMAC_SHA1
2495 remaining are as for the cryptographic hash functions
2501 chash_start(int type, void *base)
2503 if (type == HMAC_MD5)
2504 md5_start((md5 *)base);
2506 sha1_start((sha1 *)base);
2510 chash_mid(int type, void *base, uschar *string)
2512 if (type == HMAC_MD5)
2513 md5_mid((md5 *)base, string);
2515 sha1_mid((sha1 *)base, string);
2519 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2521 if (type == HMAC_MD5)
2522 md5_end((md5 *)base, string, length, digest);
2524 sha1_end((sha1 *)base, string, length, digest);
2531 /********************************************************
2532 * prvs: Get last three digits of days since Jan 1, 1970 *
2533 ********************************************************/
2535 /* This is needed to implement the "prvs" BATV reverse
2538 Argument: integer "days" offset to add or substract to
2539 or from the current number of days.
2541 Returns: pointer to string containing the last three
2542 digits of the number of days since Jan 1, 1970,
2543 modified by the offset argument, NULL if there
2544 was an error in the conversion.
2549 prvs_daystamp(int day_offset)
2551 uschar *days = store_get(32); /* Need at least 24 for cases */
2552 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2553 (time(NULL) + day_offset*86400)/86400);
2554 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2559 /********************************************************
2560 * prvs: perform HMAC-SHA1 computation of prvs bits *
2561 ********************************************************/
2563 /* This is needed to implement the "prvs" BATV reverse
2567 address RFC2821 Address to use
2568 key The key to use (must be less than 64 characters
2570 key_num Single-digit key number to use. Defaults to
2573 Returns: pointer to string containing the first three
2574 bytes of the final hash in hex format, NULL if
2575 there was an error in the process.
2579 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2581 uschar *hash_source, *p;
2582 int size = 0,offset = 0,i;
2584 void *use_base = &sha1_base;
2585 uschar innerhash[20];
2586 uschar finalhash[20];
2587 uschar innerkey[64];
2588 uschar outerkey[64];
2589 uschar *finalhash_hex = store_get(40);
2591 if (key_num == NULL)
2594 if (Ustrlen(key) > 64)
2597 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2598 string_cat(hash_source,&size,&offset,daystamp,3);
2599 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2600 hash_source[offset] = '\0';
2602 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2604 memset(innerkey, 0x36, 64);
2605 memset(outerkey, 0x5c, 64);
2607 for (i = 0; i < Ustrlen(key); i++)
2609 innerkey[i] ^= key[i];
2610 outerkey[i] ^= key[i];
2613 chash_start(HMAC_SHA1, use_base);
2614 chash_mid(HMAC_SHA1, use_base, innerkey);
2615 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2617 chash_start(HMAC_SHA1, use_base);
2618 chash_mid(HMAC_SHA1, use_base, outerkey);
2619 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2622 for (i = 0; i < 3; i++)
2624 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2625 *p++ = hex_digits[finalhash[i] & 0x0f];
2629 return finalhash_hex;
2635 /*************************************************
2636 * Join a file onto the output string *
2637 *************************************************/
2639 /* This is used for readfile and after a run expansion. It joins the contents
2640 of a file onto the output string, globally replacing newlines with a given
2641 string (optionally). The file is closed at the end.
2645 yield pointer to the expandable string
2646 sizep pointer to the current size
2647 ptrp pointer to the current position
2648 eol newline replacement string, or NULL
2650 Returns: new value of string pointer
2654 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2657 uschar buffer[1024];
2659 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2661 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2663 int len = Ustrlen(buffer);
2664 if (eol != NULL && buffer[len-1] == '\n') len--;
2665 yield = string_cat(yield, sizep, ptrp, buffer, len);
2666 if (buffer[len] != 0)
2667 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2670 if (yield != NULL) yield[*ptrp] = 0;
2678 /*************************************************
2679 * Evaluate numeric expression *
2680 *************************************************/
2682 /* This is a set of mutually recursive functions that evaluate a simple
2683 arithmetic expression involving only + - * / and parentheses. The only one that
2684 is called from elsewhere is eval_expr, whose interface is:
2687 sptr pointer to the pointer to the string - gets updated
2688 decimal TRUE if numbers are to be assumed decimal
2689 error pointer to where to put an error message - must be NULL on input
2690 endket TRUE if ')' must terminate - FALSE for external call
2693 Returns: on success: the value of the expression, with *error still NULL
2694 on failure: an undefined value, with *error = a message
2697 static int eval_sumterm(uschar **, BOOL, uschar **);
2700 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2703 int x = eval_sumterm(&s, decimal, error);
2706 while (*s == '+' || *s == '-')
2709 int y = eval_sumterm(&s, decimal, error);
2710 if (*error != NULL) break;
2711 if (op == '+') x += y; else x -= y;
2718 *error = US"expecting closing parenthesis";
2720 while (isspace(*(++s)));
2722 else if (*s != 0) *error = US"expecting + or -";
2731 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2736 while (isspace(*s)) s++;
2738 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2741 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2743 if (tolower(*s) == 'k') { n *= 1024; s++; }
2744 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2745 while (isspace (*s)) s++;
2750 n = eval_expr(&s, decimal, error, 1);
2754 *error = US"expecting number or opening parenthesis";
2761 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2764 int x = eval_term(&s, decimal, error);
2767 while (*s == '*' || *s == '/' || *s == '%')
2770 int y = eval_term(&s, decimal, error);
2771 if (*error != NULL) break;
2772 if (op == '*') x *= y;
2773 else if (op == '/') x /= y;
2784 /*************************************************
2786 *************************************************/
2788 /* Returns either an unchanged string, or the expanded string in stacking pool
2789 store. Interpreted sequences are:
2791 \... normal escaping rules
2792 $name substitutes the variable
2794 ${op:string} operates on the expanded string value
2795 ${item{arg1}{arg2}...} expands the args and then does the business
2796 some literal args are not enclosed in {}
2798 There are now far too many operators and item types to make it worth listing
2799 them here in detail any more.
2801 We use an internal routine recursively to handle embedded substrings. The
2802 external function follows. The yield is NULL if the expansion failed, and there
2803 are two cases: if something collapsed syntactically, or if "fail" was given
2804 as the action on a lookup failure. These can be distinguised by looking at the
2805 variable expand_string_forcedfail, which is TRUE in the latter case.
2807 The skipping flag is set true when expanding a substring that isn't actually
2808 going to be used (after "if" or "lookup") and it prevents lookups from
2809 happening lower down.
2811 Store usage: At start, a store block of the length of the input plus 64
2812 is obtained. This is expanded as necessary by string_cat(), which might have to
2813 get a new block, or might be able to expand the original. At the end of the
2814 function we can release any store above that portion of the yield block that
2815 was actually used. In many cases this will be optimal.
2817 However: if the first item in the expansion is a variable name or header name,
2818 we reset the store before processing it; if the result is in fresh store, we
2819 use that without copying. This is helpful for expanding strings like
2820 $message_headers which can get very long.
2823 string the string to be expanded
2824 ket_ends true if expansion is to stop at }
2825 left if not NULL, a pointer to the first character after the
2826 expansion is placed here (typically used with ket_ends)
2827 skipping TRUE for recursive calls when the value isn't actually going
2828 to be used (to allow for optimisation)
2830 Returns: NULL if expansion fails:
2831 expand_string_forcedfail is set TRUE if failure was forced
2832 expand_string_message contains a textual error message
2833 a pointer to the expanded string on success
2837 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2841 int size = Ustrlen(string)+ 64;
2843 uschar *yield = store_get(size);
2845 uschar *save_expand_nstring[EXPAND_MAXN+1];
2846 int save_expand_nlength[EXPAND_MAXN+1];
2848 expand_string_forcedfail = FALSE;
2849 expand_string_message = US"";
2856 /* \ escapes the next character, which must exist, or else
2857 the expansion fails. There's a special escape, \N, which causes
2858 copying of the subject verbatim up to the next \N. Otherwise,
2859 the escapes are the standard set. */
2865 expand_string_message = US"\\ at end of string";
2872 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2873 yield = string_cat(yield, &size, &ptr, t, s - t);
2874 if (*s != 0) s += 2;
2880 ch[0] = string_interpret_escape(&s);
2882 yield = string_cat(yield, &size, &ptr, ch, 1);
2888 /* Anything other than $ is just copied verbatim, unless we are
2889 looking for a terminating } character. */
2891 if (ket_ends && *s == '}') break;
2895 yield = string_cat(yield, &size, &ptr, s++, 1);
2899 /* No { after the $ - must be a plain name or a number for string
2900 match variable. There has to be a fudge for variables that are the
2901 names of header fields preceded by "$header_" because header field
2902 names can contain any printing characters except space and colon.
2903 For those that don't like typing this much, "$h_" is a synonym for
2904 "$header_". A non-existent header yields a NULL value; nothing is
2907 if (isalpha((*(++s))))
2912 s = read_name(name, sizeof(name), s, US"_");
2914 /* If this is the first thing to be expanded, release the pre-allocated
2917 if (ptr == 0 && yield != NULL)
2926 if (Ustrncmp(name, "h_", 2) == 0 ||
2927 Ustrncmp(name, "rh_", 3) == 0 ||
2928 Ustrncmp(name, "bh_", 3) == 0 ||
2929 Ustrncmp(name, "header_", 7) == 0 ||
2930 Ustrncmp(name, "rheader_", 8) == 0 ||
2931 Ustrncmp(name, "bheader_", 8) == 0)
2933 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2934 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2935 s = read_header_name(name, sizeof(name), s);
2936 value = find_header(name, FALSE, &newsize, want_raw, charset);
2938 /* If we didn't find the header, and the header contains a closing brace
2939 characters, this may be a user error where the terminating colon
2940 has been omitted. Set a flag to adjust the error message in this case.
2941 But there is no error here - nothing gets inserted. */
2945 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2954 value = find_variable(name, FALSE, skipping, &newsize);
2957 expand_string_message =
2958 string_sprintf("unknown variable name \"%s\"", name);
2960 if (strict_acl_vars &&
2961 Ustrncmp(name, "acl_", 4) == 0 &&
2962 (name[4] == 'c' || name[4] == 'm'))
2963 expand_string_message = string_sprintf("%s (strict_acl_vars is set)",
2964 expand_string_message);
2970 /* If the data is known to be in a new buffer, newsize will be set to the
2971 size of that buffer. If this is the first thing in an expansion string,
2972 yield will be NULL; just point it at the new store instead of copying. Many
2973 expansion strings contain just one reference, so this is a useful
2974 optimization, especially for humungous headers. */
2976 len = Ustrlen(value);
2977 if (yield == NULL && newsize != 0)
2983 else yield = string_cat(yield, &size, &ptr, value, len);
2991 s = read_number(&n, s);
2992 if (n >= 0 && n <= expand_nmax)
2993 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2998 /* Otherwise, if there's no '{' after $ it's an error. */
3002 expand_string_message = US"$ not followed by letter, digit, or {";
3006 /* After { there can be various things, but they all start with
3007 an initial word, except for a number for a string match variable. */
3009 if (isdigit((*(++s))))
3012 s = read_number(&n, s);
3015 expand_string_message = US"} expected after number";
3018 if (n >= 0 && n <= expand_nmax)
3019 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3026 expand_string_message = US"letter or digit expected after ${";
3030 /* Allow "-" in names to cater for substrings with negative
3031 arguments. Since we are checking for known names after { this is
3034 s = read_name(name, sizeof(name), s, US"_-");
3035 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3039 /* Handle conditionals - preserve the values of the numerical expansion
3040 variables in case they get changed by a regular expression match in the
3041 condition. If not, they retain their external settings. At the end
3042 of this "if" section, they get restored to their previous values. */
3048 int save_expand_nmax =
3049 save_expand_strings(save_expand_nstring, save_expand_nlength);
3051 while (isspace(*s)) s++;
3052 next_s = eval_condition(s, skipping? NULL : &cond);
3053 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3056 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3057 cond? "true" : "false");
3061 /* The handling of "yes" and "no" result strings is now in a separate
3062 function that is also used by ${lookup} and ${extract} and ${run}. */
3064 switch(process_yesno(
3065 skipping, /* were previously skipping */
3066 cond, /* success/failure indicator */
3067 lookup_value, /* value to reset for string2 */
3068 &s, /* input pointer */
3069 &yield, /* output pointer */
3070 &size, /* output size */
3071 &ptr, /* output current point */
3072 US"if")) /* condition type */
3074 case 1: goto EXPAND_FAILED; /* when all is well, the */
3075 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3078 /* Restore external setting of expansion variables for continuation
3081 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3082 save_expand_nlength);
3086 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3087 expanding an internal string that isn't actually going to be used. All we
3088 need to do is check the syntax, so don't do a lookup at all. Preserve the
3089 values of the numerical expansion variables in case they get changed by a
3090 partial lookup. If not, they retain their external settings. At the end
3091 of this "lookup" section, they get restored to their previous values. */
3095 int stype, partial, affixlen, starflags;
3096 int expand_setup = 0;
3098 uschar *key, *filename, *affix;
3099 uschar *save_lookup_value = lookup_value;
3100 int save_expand_nmax =
3101 save_expand_strings(save_expand_nstring, save_expand_nlength);
3103 if ((expand_forbid & RDO_LOOKUP) != 0)
3105 expand_string_message = US"lookup expansions are not permitted";
3109 /* Get the key we are to look up for single-key+file style lookups.
3110 Otherwise set the key NULL pro-tem. */
3112 while (isspace(*s)) s++;
3115 key = expand_string_internal(s+1, TRUE, &s, skipping);
3116 if (key == NULL) goto EXPAND_FAILED;
3117 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3118 while (isspace(*s)) s++;
3122 /* Find out the type of database */
3126 expand_string_message = US"missing lookup type";
3130 /* The type is a string that may contain special characters of various
3131 kinds. Allow everything except space or { to appear; the actual content
3132 is checked by search_findtype_partial. */
3134 while (*s != 0 && *s != '{' && !isspace(*s))
3136 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3140 while (isspace(*s)) s++;
3142 /* Now check for the individual search type and any partial or default
3143 options. Only those types that are actually in the binary are valid. */
3145 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3149 expand_string_message = search_error_message;
3153 /* Check that a key was provided for those lookup types that need it,
3154 and was not supplied for those that use the query style. */
3156 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3160 expand_string_message = string_sprintf("missing {key} for single-"
3161 "key \"%s\" lookup", name);
3169 expand_string_message = string_sprintf("a single key was given for "
3170 "lookup type \"%s\", which is not a single-key lookup type", name);
3175 /* Get the next string in brackets and expand it. It is the file name for
3176 single-key+file lookups, and the whole query otherwise. In the case of
3177 queries that also require a file name (e.g. sqlite), the file name comes
3180 if (*s != '{') goto EXPAND_FAILED_CURLY;
3181 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3182 if (filename == NULL) goto EXPAND_FAILED;
3183 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3184 while (isspace(*s)) s++;
3186 /* If this isn't a single-key+file lookup, re-arrange the variables
3187 to be appropriate for the search_ functions. For query-style lookups,
3188 there is just a "key", and no file name. For the special query-style +
3189 file types, the query (i.e. "key") starts with a file name. */
3193 while (isspace(*filename)) filename++;
3196 if (mac_islookup(stype, lookup_querystyle))
3202 if (*filename != '/')
3204 expand_string_message = string_sprintf(
3205 "absolute file name expected for \"%s\" lookup", name);
3208 while (*key != 0 && !isspace(*key)) key++;
3209 if (*key != 0) *key++ = 0;
3213 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3214 the entry was not found. Note that there is no search_close() function.
3215 Files are left open in case of re-use. At suitable places in higher logic,
3216 search_tidyup() is called to tidy all open files. This can save opening
3217 the same file several times. However, files may also get closed when
3218 others are opened, if too many are open at once. The rule is that a
3219 handle should not be used after a second search_open().
3221 Request that a partial search sets up $1 and maybe $2 by passing
3222 expand_setup containing zero. If its value changes, reset expand_nmax,
3223 since new variables will have been set. Note that at the end of this
3224 "lookup" section, the old numeric variables are restored. */
3227 lookup_value = NULL;
3230 void *handle = search_open(filename, stype, 0, NULL, NULL);
3233 expand_string_message = search_error_message;
3236 lookup_value = search_find(handle, filename, key, partial, affix,
3237 affixlen, starflags, &expand_setup);
3238 if (search_find_defer)
3240 expand_string_message =
3241 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3242 search_error_message);
3245 if (expand_setup > 0) expand_nmax = expand_setup;
3248 /* The handling of "yes" and "no" result strings is now in a separate
3249 function that is also used by ${if} and ${extract}. */
3251 switch(process_yesno(
3252 skipping, /* were previously skipping */
3253 lookup_value != NULL, /* success/failure indicator */
3254 save_lookup_value, /* value to reset for string2 */
3255 &s, /* input pointer */
3256 &yield, /* output pointer */
3257 &size, /* output size */
3258 &ptr, /* output current point */
3259 US"lookup")) /* condition type */
3261 case 1: goto EXPAND_FAILED; /* when all is well, the */
3262 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3265 /* Restore external setting of expansion variables for carrying on
3266 at this level, and continue. */
3268 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3269 save_expand_nlength);
3273 /* If Perl support is configured, handle calling embedded perl subroutines,
3274 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3275 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3276 arguments (defined below). */
3278 #define EXIM_PERL_MAX_ARGS 8
3282 expand_string_message = US"\"${perl\" encountered, but this facility "
3283 "is not included in this binary";
3286 #else /* EXIM_PERL */
3288 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3291 if ((expand_forbid & RDO_PERL) != 0)
3293 expand_string_message = US"Perl calls are not permitted";
3297 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3300 case 1: goto EXPAND_FAILED_CURLY;
3302 case 3: goto EXPAND_FAILED;
3305 /* If skipping, we don't actually do anything */
3307 if (skipping) continue;
3309 /* Start the interpreter if necessary */
3311 if (!opt_perl_started)
3314 if (opt_perl_startup == NULL)
3316 expand_string_message = US"A setting of perl_startup is needed when "
3317 "using the Perl interpreter";
3320 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3321 initerror = init_perl(opt_perl_startup);
3322 if (initerror != NULL)
3324 expand_string_message =
3325 string_sprintf("error in perl_startup code: %s\n", initerror);
3328 opt_perl_started = TRUE;
3331 /* Call the function */
3333 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3334 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3335 sub_arg[0], sub_arg + 1);
3337 /* NULL yield indicates failure; if the message pointer has been set to
3338 NULL, the yield was undef, indicating a forced failure. Otherwise the
3339 message will indicate some kind of Perl error. */
3341 if (new_yield == NULL)
3343 if (expand_string_message == NULL)
3345 expand_string_message =
3346 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3347 "failure", sub_arg[0]);
3348 expand_string_forcedfail = TRUE;
3353 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3354 set during a callback from Perl. */
3356 expand_string_forcedfail = FALSE;
3360 #endif /* EXIM_PERL */
3362 /* Transform email address to "prvs" scheme to use
3363 as BATV-signed return path */
3370 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3372 case 1: goto EXPAND_FAILED_CURLY;
3374 case 3: goto EXPAND_FAILED;
3377 /* If skipping, we don't actually do anything */
3378 if (skipping) continue;
3380 /* sub_arg[0] is the address */
3381 domain = Ustrrchr(sub_arg[0],'@');
3382 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3384 expand_string_message = US"prvs first argument must be a qualified email address";
3388 /* Calculate the hash. The second argument must be a single-digit
3389 key number, or unset. */
3391 if (sub_arg[2] != NULL &&
3392 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3394 expand_string_message = US"prvs second argument must be a single digit";
3398 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3401 expand_string_message = US"prvs hmac-sha1 conversion failed";
3405 /* Now separate the domain from the local part */
3408 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3409 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3410 string_cat(yield,&size,&ptr,US"/",1);
3411 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3412 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3413 string_cat(yield,&size,&ptr,p,6);
3414 string_cat(yield,&size,&ptr,US"@",1);
3415 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3420 /* Check a prvs-encoded address for validity */
3422 case EITEM_PRVSCHECK:
3425 int mysize = 0, myptr = 0;
3429 /* TF: Ugliness: We want to expand parameter 1 first, then set
3430 up expansion variables that are used in the expansion of
3431 parameter 2. So we clone the string for the first
3432 expansion, where we only expand parameter 1.
3434 PH: Actually, that isn't necessary. The read_subs() function is
3435 designed to work this way for the ${if and ${lookup expansions. I've
3439 /* Reset expansion variables */
3440 prvscheck_result = NULL;
3441 prvscheck_address = NULL;
3442 prvscheck_keynum = NULL;
3444 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3446 case 1: goto EXPAND_FAILED_CURLY;
3448 case 3: goto EXPAND_FAILED;
3451 re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3454 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3456 uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3457 uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3458 uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3459 uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3460 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3462 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3463 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3464 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3465 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3466 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3468 /* Set up expansion variables */
3469 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3470 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3471 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3472 prvscheck_address[myptr] = '\0';
3473 prvscheck_keynum = string_copy(key_num);
3475 /* Now expand the second argument */
3476 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3478 case 1: goto EXPAND_FAILED_CURLY;
3480 case 3: goto EXPAND_FAILED;
3483 /* Now we have the key and can check the address. */
3485 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3490 expand_string_message = US"hmac-sha1 conversion failed";
3494 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3495 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3497 if (Ustrcmp(p,hash) == 0)
3499 /* Success, valid BATV address. Now check the expiry date. */
3500 uschar *now = prvs_daystamp(0);
3501 unsigned int inow = 0,iexpire = 1;
3503 (void)sscanf(CS now,"%u",&inow);
3504 (void)sscanf(CS daystamp,"%u",&iexpire);
3506 /* When "iexpire" is < 7, a "flip" has occured.
3507 Adjust "inow" accordingly. */
3508 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3512 prvscheck_result = US"1";
3513 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3517 prvscheck_result = NULL;
3518 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3523 prvscheck_result = NULL;
3524 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3527 /* Now expand the final argument. We leave this till now so that
3528 it can include $prvscheck_result. */
3530 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3532 case 1: goto EXPAND_FAILED_CURLY;
3534 case 3: goto EXPAND_FAILED;
3537 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3538 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3540 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3542 /* Reset the "internal" variables afterwards, because they are in
3543 dynamic store that will be reclaimed if the expansion succeeded. */
3545 prvscheck_address = NULL;
3546 prvscheck_keynum = NULL;
3550 /* Does not look like a prvs encoded address, return the empty string.
3551 We need to make sure all subs are expanded first, so as to skip over
3554 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3556 case 1: goto EXPAND_FAILED_CURLY;
3558 case 3: goto EXPAND_FAILED;
3565 /* Handle "readfile" to insert an entire file */
3567 case EITEM_READFILE:
3572 if ((expand_forbid & RDO_READFILE) != 0)
3574 expand_string_message = US"file insertions are not permitted";
3578 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3580 case 1: goto EXPAND_FAILED_CURLY;
3582 case 3: goto EXPAND_FAILED;
3585 /* If skipping, we don't actually do anything */
3587 if (skipping) continue;
3589 /* Open the file and read it */
3591 f = Ufopen(sub_arg[0], "rb");
3594 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3598 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3603 /* Handle "readsocket" to insert data from a Unix domain socket */
3605 case EITEM_READSOCK:
3611 struct sockaddr_un sockun; /* don't call this "sun" ! */
3615 if ((expand_forbid & RDO_READSOCK) != 0)
3617 expand_string_message = US"socket insertions are not permitted";
3621 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3622 because there may be a string for expansion on failure. */
3624 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3626 case 1: goto EXPAND_FAILED_CURLY;
3627 case 2: /* Won't occur: no end check */
3628 case 3: goto EXPAND_FAILED;
3631 /* Sort out timeout, if given */
3633 if (sub_arg[2] != NULL)
3635 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3638 expand_string_message = string_sprintf("bad time value %s",
3643 else sub_arg[3] = NULL; /* No eol if no timeout */
3645 /* If skipping, we don't actually do anything. Otherwise, arrange to
3646 connect to either an IP or a Unix socket. */
3650 /* Handle an IP (internet) domain */
3652 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
3654 BOOL connected = FALSE;
3658 uschar *server_name = sub_arg[0] + 5;
3659 uschar *port_name = Ustrrchr(server_name, ':');
3661 /* Sort out the port */
3663 if (port_name == NULL)
3665 expand_string_message =
3666 string_sprintf("missing port for readsocket %s", sub_arg[0]);
3669 *port_name++ = 0; /* Terminate server name */
3671 if (isdigit(*port_name))
3674 port = Ustrtol(port_name, &end, 0);
3675 if (end != port_name + Ustrlen(port_name))
3677 expand_string_message =
3678 string_sprintf("invalid port number %s", port_name);
3684 struct servent *service_info = getservbyname(CS port_name, "tcp");
3685 if (service_info == NULL)
3687 expand_string_message = string_sprintf("unknown port \"%s\"",
3691 port = ntohs(service_info->s_port);
3694 /* Sort out the server. */
3697 shost.address = NULL;
3701 namelen = Ustrlen(server_name);
3703 /* Anything enclosed in [] must be an IP address. */
3705 if (server_name[0] == '[' &&
3706 server_name[namelen - 1] == ']')
3708 server_name[namelen - 1] = 0;
3710 if (string_is_ip_address(server_name, NULL) == 0)
3712 expand_string_message =
3713 string_sprintf("malformed IP address \"%s\"", server_name);
3716 shost.name = shost.address = server_name;
3719 /* Otherwise check for an unadorned IP address */
3721 else if (string_is_ip_address(server_name, NULL) != 0)
3722 shost.name = shost.address = server_name;
3724 /* Otherwise lookup IP address(es) from the name */
3728 shost.name = server_name;
3729 if (host_find_byname(&shost, NULL, NULL, FALSE) != HOST_FOUND)
3731 expand_string_message =
3732 string_sprintf("no IP address found for host %s", shost.name);
3737 /* Try to connect to the server - test each IP till one works */
3739 for (h = &shost; h != NULL; h = h->next)
3741 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
3742 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
3744 expand_string_message = string_sprintf("failed to create socket: "
3745 "%s", strerror(errno));
3749 if (ip_connect(fd, af, h->address, port, timeout) == 0)
3758 expand_string_message = string_sprintf("failed to connect to "
3759 "socket %s: couldn't connect to any host", sub_arg[0],
3765 /* Handle a Unix domain socket */
3769 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3771 expand_string_message = string_sprintf("failed to create socket: %s",
3776 sockun.sun_family = AF_UNIX;
3777 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3779 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3781 expand_string_message = string_sprintf("failed to connect to socket "
3782 "%s: %s", sub_arg[0], strerror(errno));
3787 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3789 /* Write the request string, if not empty */
3791 if (sub_arg[1][0] != 0)
3793 int len = Ustrlen(sub_arg[1]);
3794 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3796 if (write(fd, sub_arg[1], len) != len)
3798 expand_string_message = string_sprintf("request write to socket "
3799 "failed: %s", strerror(errno));
3804 /* Now we need to read from the socket, under a timeout. The function
3805 that reads a file can be used. */
3807 f = fdopen(fd, "rb");
3808 sigalrm_seen = FALSE;
3810 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3814 /* After a timeout, we restore the pointer in the result, that is,
3815 make sure we add nothing from the socket. */
3820 expand_string_message = US "socket read timed out";
3825 /* The whole thing has worked (or we were skipping). If there is a
3826 failure string following, we need to skip it. */
3830 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3832 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3833 while (isspace(*s)) s++;
3835 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3838 /* Come here on failure to create socket, connect socket, write to the
3839 socket, or timeout on reading. If another substring follows, expand and
3840 use it. Otherwise, those conditions give expand errors. */
3843 if (*s != '{') goto EXPAND_FAILED;
3844 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3845 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3846 if (arg == NULL) goto EXPAND_FAILED;
3847 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3848 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3849 while (isspace(*s)) s++;
3850 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3854 /* Handle "run" to execute a program. */
3866 if ((expand_forbid & RDO_RUN) != 0)
3868 expand_string_message = US"running a command is not permitted";
3872 while (isspace(*s)) s++;
3873 if (*s != '{') goto EXPAND_FAILED_CURLY;
3874 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3875 if (arg == NULL) goto EXPAND_FAILED;
3876 while (isspace(*s)) s++;
3877 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3879 if (skipping) /* Just pretend it worked when we're skipping */
3885 if (!transport_set_up_command(&argv, /* anchor for arg list */
3886 arg, /* raw command */
3887 FALSE, /* don't expand the arguments */
3888 0, /* not relevant when... */
3889 NULL, /* no transporting address */
3890 US"${run} expansion", /* for error messages */
3891 &expand_string_message)) /* where to put error message */
3896 /* Create the child process, making it a group leader. */
3898 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3902 expand_string_message =
3903 string_sprintf("couldn't create child process: %s", strerror(errno));
3907 /* Nothing is written to the standard input. */
3911 /* Wait for the process to finish, applying the timeout, and inspect its
3912 return code for serious disasters. Simple non-zero returns are passed on.
3915 if ((runrc = child_close(pid, 60)) < 0)
3919 expand_string_message = string_sprintf("command timed out");
3920 killpg(pid, SIGKILL); /* Kill the whole process group */
3923 else if (runrc == -257)
3924 expand_string_message = string_sprintf("wait() failed: %s",
3928 expand_string_message = string_sprintf("command killed by signal %d",
3934 /* Read the pipe to get the command's output into $value (which is kept
3935 in lookup_value). */
3937 f = fdopen(fd_out, "rb");
3938 lookup_value = NULL;
3939 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3943 /* Process the yes/no strings; $value may be useful in both cases */
3945 switch(process_yesno(
3946 skipping, /* were previously skipping */
3947 runrc == 0, /* success/failure indicator */
3948 lookup_value, /* value to reset for string2 */
3949 &s, /* input pointer */
3950 &yield, /* output pointer */
3951 &size, /* output size */
3952 &ptr, /* output current point */
3953 US"run")) /* condition type */
3955 case 1: goto EXPAND_FAILED; /* when all is well, the */
3956 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3962 /* Handle character translation for "tr" */
3970 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3972 case 1: goto EXPAND_FAILED_CURLY;
3974 case 3: goto EXPAND_FAILED;
3977 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3978 o2m = Ustrlen(sub[2]) - 1;
3980 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3982 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3986 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3993 /* Handle "hash", "length", "nhash", and "substr" when they are given with
3994 expanded arguments. */
4004 int val[2] = { 0, -1 };
4007 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4008 Ensure that sub[2] is set in the ${length case. */
4011 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4014 case 1: goto EXPAND_FAILED_CURLY;
4016 case 3: goto EXPAND_FAILED;
4019 /* Juggle the arguments if there are only two of them: always move the
4020 string to the last position and make ${length{n}{str}} equivalent to
4021 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4027 if (item_type == EITEM_LENGTH)
4034 for (i = 0; i < 2; i++)
4036 if (sub[i] == NULL) continue;
4037 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4038 if (*ret != 0 || (i != 0 && val[i] < 0))
4040 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4041 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4047 (item_type == EITEM_HASH)?
4048 compute_hash(sub[2], val[0], val[1], &len) :
4049 (item_type == EITEM_NHASH)?
4050 compute_nhash(sub[2], val[0], val[1], &len) :
4051 extract_substr(sub[2], val[0], val[1], &len);
4053 if (ret == NULL) goto EXPAND_FAILED;
4054 yield = string_cat(yield, &size, &ptr, ret, len);
4058 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4059 This code originally contributed by Steve Haslam. It currently supports
4060 the use of MD5 and SHA-1 hashes.
4062 We need some workspace that is large enough to handle all the supported
4063 hash types. Use macros to set the sizes rather than be too elaborate. */
4065 #define MAX_HASHLEN 20
4066 #define MAX_HASHBLOCKLEN 64
4075 int hashlen; /* Number of octets for the hash algorithm's output */
4076 int hashblocklen; /* Number of octets the hash algorithm processes */
4078 unsigned int keylen;
4080 uschar keyhash[MAX_HASHLEN];
4081 uschar innerhash[MAX_HASHLEN];
4082 uschar finalhash[MAX_HASHLEN];
4083 uschar finalhash_hex[2*MAX_HASHLEN];
4084 uschar innerkey[MAX_HASHBLOCKLEN];
4085 uschar outerkey[MAX_HASHBLOCKLEN];
4087 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4089 case 1: goto EXPAND_FAILED_CURLY;
4091 case 3: goto EXPAND_FAILED;
4094 if (Ustrcmp(sub[0], "md5") == 0)
4097 use_base = &md5_base;
4101 else if (Ustrcmp(sub[0], "sha1") == 0)
4104 use_base = &sha1_base;
4110 expand_string_message =
4111 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4116 keylen = Ustrlen(keyptr);
4118 /* If the key is longer than the hash block length, then hash the key
4121 if (keylen > hashblocklen)
4123 chash_start(type, use_base);
4124 chash_end(type, use_base, keyptr, keylen, keyhash);
4129 /* Now make the inner and outer key values */
4131 memset(innerkey, 0x36, hashblocklen);
4132 memset(outerkey, 0x5c, hashblocklen);
4134 for (i = 0; i < keylen; i++)
4136 innerkey[i] ^= keyptr[i];
4137 outerkey[i] ^= keyptr[i];
4140 /* Now do the hashes */
4142 chash_start(type, use_base);
4143 chash_mid(type, use_base, innerkey);
4144 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4146 chash_start(type, use_base);
4147 chash_mid(type, use_base, outerkey);
4148 chash_end(type, use_base, innerhash, hashlen, finalhash);
4150 /* Encode the final hash as a hex string */
4153 for (i = 0; i < hashlen; i++)
4155 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4156 *p++ = hex_digits[finalhash[i] & 0x0f];
4159 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4160 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4162 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4167 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4168 We have to save the numerical variables and restore them afterwards. */
4173 int moffset, moffsetextra, slen;
4176 const uschar *rerror;
4179 int save_expand_nmax =
4180 save_expand_strings(save_expand_nstring, save_expand_nlength);
4182 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4184 case 1: goto EXPAND_FAILED_CURLY;
4186 case 3: goto EXPAND_FAILED;
4189 /* Compile the regular expression */
4191 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4196 expand_string_message = string_sprintf("regular expression error in "
4197 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4201 /* Now run a loop to do the substitutions as often as necessary. It ends
4202 when there are no more matches. Take care over matches of the null string;
4203 do the same thing as Perl does. */
4206 slen = Ustrlen(sub[0]);
4207 moffset = moffsetextra = 0;
4212 int ovector[3*(EXPAND_MAXN+1)];
4213 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4214 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4218 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4219 is not necessarily the end. We want to repeat the match from one
4220 character further along, but leaving the basic offset the same (for
4221 copying below). We can't be at the end of the string - that was checked
4222 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4223 finished; copy the remaining string and end the loop. */
4233 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4237 /* Match - set up for expanding the replacement. */
4239 if (n == 0) n = EXPAND_MAXN + 1;
4241 for (nn = 0; nn < n*2; nn += 2)
4243 expand_nstring[expand_nmax] = subject + ovector[nn];
4244 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4248 /* Copy the characters before the match, plus the expanded insertion. */
4250 yield = string_cat(yield, &size, &ptr, subject + moffset,
4251 ovector[0] - moffset);
4252 insert = expand_string(sub[2]);
4253 if (insert == NULL) goto EXPAND_FAILED;
4254 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4256 moffset = ovector[1];
4260 /* If we have matched an empty string, first check to see if we are at
4261 the end of the subject. If so, the loop is over. Otherwise, mimic
4262 what Perl's /g options does. This turns out to be rather cunning. First
4263 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4264 string at the same point. If this fails (picked up above) we advance to
4265 the next character. */
4267 if (ovector[0] == ovector[1])
4269 if (ovector[0] == slen) break;
4270 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4274 /* All done - restore numerical variables. */
4276 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4277 save_expand_nlength);
4281 /* Handle keyed and numbered substring extraction. If the first argument
4282 consists entirely of digits, then a numerical extraction is assumed. */
4288 int field_number = 1;
4289 BOOL field_number_set = FALSE;
4290 uschar *save_lookup_value = lookup_value;
4292 int save_expand_nmax =
4293 save_expand_strings(save_expand_nstring, save_expand_nlength);
4295 /* Read the arguments */
4297 for (i = 0; i < j; i++)
4299 while (isspace(*s)) s++;
4302 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4303 if (sub[i] == NULL) goto EXPAND_FAILED;
4304 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4306 /* After removal of leading and trailing white space, the first
4307 argument must not be empty; if it consists entirely of digits
4308 (optionally preceded by a minus sign), this is a numerical
4309 extraction, and we expect 3 arguments. */
4317 while (isspace(*p)) p++;
4321 while (len > 0 && isspace(p[len-1])) len--;
4326 expand_string_message = US"first argument of \"extract\" must "
4336 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4340 j = 3; /* Need 3 args */
4341 field_number_set = TRUE;
4345 else goto EXPAND_FAILED_CURLY;
4348 /* Extract either the numbered or the keyed substring into $value. If
4349 skipping, just pretend the extraction failed. */
4351 lookup_value = skipping? NULL : field_number_set?
4352 expand_gettokened(field_number, sub[1], sub[2]) :
4353 expand_getkeyed(sub[0], sub[1]);
4355 /* If no string follows, $value gets substituted; otherwise there can
4356 be yes/no strings, as for lookup or if. */
4358 switch(process_yesno(
4359 skipping, /* were previously skipping */
4360 lookup_value != NULL, /* success/failure indicator */
4361 save_lookup_value, /* value to reset for string2 */
4362 &s, /* input pointer */
4363 &yield, /* output pointer */
4364 &size, /* output size */
4365 &ptr, /* output current point */
4366 US"extract")) /* condition type */
4368 case 1: goto EXPAND_FAILED; /* when all is well, the */
4369 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4372 /* All done - restore numerical variables. */
4374 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4375 save_expand_nlength);
4381 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4382 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4383 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4384 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4386 #define EXPAND_DLFUNC_MAX_ARGS 8
4389 #ifndef EXPAND_DLFUNC
4390 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4391 "is not included in this binary";
4394 #else /* EXPAND_DLFUNC */
4397 exim_dlfunc_t *func;
4400 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4402 if ((expand_forbid & RDO_DLFUNC) != 0)
4404 expand_string_message =
4405 US"dynamically-loaded functions are not permitted";
4409 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4412 case 1: goto EXPAND_FAILED_CURLY;
4414 case 3: goto EXPAND_FAILED;
4417 /* If skipping, we don't actually do anything */
4419 if (skipping) continue;
4421 /* Look up the dynamically loaded object handle in the tree. If it isn't
4422 found, dlopen() the file and put the handle in the tree for next time. */
4424 t = tree_search(dlobj_anchor, argv[0]);
4427 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4430 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4431 argv[0], dlerror());
4432 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4435 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4436 Ustrcpy(t->name, argv[0]);
4437 t->data.ptr = handle;
4438 (void)tree_insertnode(&dlobj_anchor, t);
4441 /* Having obtained the dynamically loaded object handle, look up the
4442 function pointer. */
4444 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4447 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4448 "%s", argv[1], argv[0], dlerror());
4449 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4453 /* Call the function and work out what to do with the result. If it
4454 returns OK, we have a replacement string; if it returns DEFER then
4455 expansion has failed in a non-forced manner; if it returns FAIL then
4456 failure was forced; if it returns ERROR or any other value there's a
4457 problem, so panic slightly. */
4460 for (argc = 0; argv[argc] != NULL; argc++);
4461 status = func(&result, argc - 2, &argv[2]);
4464 if (result == NULL) result = US"";
4465 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4470 expand_string_message = result == NULL ? US"(no message)" : result;
4471 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4472 else if(status != FAIL)
4473 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4474 argv[0], argv[1], status, expand_string_message);
4478 #endif /* EXPAND_DLFUNC */
4481 /* Control reaches here if the name is not recognized as one of the more
4482 complicated expansion items. Check for the "operator" syntax (name terminated
4483 by a colon). Some of the operators have arguments, separated by _ from the
4490 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4491 if (sub == NULL) goto EXPAND_FAILED;
4494 /* Owing to an historical mis-design, an underscore may be part of the
4495 operator name, or it may introduce arguments. We therefore first scan the
4496 table of names that contain underscores. If there is no match, we cut off
4497 the arguments and then scan the main table. */
4499 c = chop_match(name, op_table_underscore,
4500 sizeof(op_table_underscore)/sizeof(uschar *));
4504 arg = Ustrchr(name, '_');
4505 if (arg != NULL) *arg = 0;
4506 c = chop_match(name, op_table_main,
4507 sizeof(op_table_main)/sizeof(uschar *));
4508 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4509 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
4512 /* If we are skipping, we don't need to perform the operation at all.
4513 This matters for operations like "mask", because the data may not be
4514 in the correct format when skipping. For example, the expression may test
4515 for the existence of $sender_host_address before trying to mask it. For
4516 other operations, doing them may not fail, but it is a waste of time. */
4518 if (skipping && c >= 0) continue;
4520 /* Otherwise, switch on the operator type */
4527 unsigned long int n = Ustrtoul(sub, &t, 10);
4530 expand_string_message = string_sprintf("argument for base62 "
4531 "operator is \"%s\", which is not a decimal number", sub);
4534 t = string_base62(n);
4535 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4539 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
4545 unsigned long int n = 0;
4548 uschar *t = Ustrchr(base62_chars, *tt++);
4551 expand_string_message = string_sprintf("argument for base62d "
4552 "operator is \"%s\", which is not a base %d number", sub,
4556 n = n * BASE_62 + (t - base62_chars);
4558 (void)sprintf(CS buf, "%ld", n);
4559 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4565 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4566 if (expanded == NULL)
4568 expand_string_message =
4569 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4570 expand_string_message);
4573 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4580 uschar *t = sub - 1;
4581 while (*(++t) != 0) { *t = tolower(*t); count++; }
4582 yield = string_cat(yield, &size, &ptr, sub, count);
4589 uschar *t = sub - 1;
4590 while (*(++t) != 0) { *t = toupper(*t); count++; }
4591 yield = string_cat(yield, &size, &ptr, sub, count);
4602 md5_end(&base, sub, Ustrlen(sub), digest);
4603 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4604 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4615 sha1_end(&base, sub, Ustrlen(sub), digest);
4616 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4617 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4621 /* Convert hex encoding to base64 encoding */
4631 for (enc = sub; *enc != 0; enc++)
4633 if (!isxdigit(*enc))
4635 expand_string_message = string_sprintf("\"%s\" is not a hex "
4644 expand_string_message = string_sprintf("\"%s\" contains an odd "
4645 "number of characters", sub);
4649 while ((c = *in++) != 0)
4651 if (isdigit(c)) c -= '0';
4652 else c = toupper(c) - 'A' + 10;
4664 enc = auth_b64encode(sub, out - sub);
4665 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4669 /* mask applies a mask to an IP address; for example the result of
4670 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4677 int mask, maskoffset;
4678 int type = string_is_ip_address(sub, &maskoffset);
4683 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4688 if (maskoffset == 0)
4690 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4695 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4697 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4699 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4704 /* Convert the address to binary integer(s) and apply the mask */
4706 sub[maskoffset] = 0;
4707 count = host_aton(sub, binary);
4708 host_mask(count, binary, mask);
4710 /* Convert to masked textual format and add to output. */
4712 yield = string_cat(yield, &size, &ptr, buffer,
4713 host_nmtoa(count, binary, mask, buffer, '.'));
4718 case EOP_LOCAL_PART:
4722 int start, end, domain;
4723 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4727 if (c != EOP_DOMAIN)
4729 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4730 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4732 else if (domain != 0)
4735 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4741 /* quote puts a string in quotes if it is empty or contains anything
4742 other than alphamerics, underscore, dot, or hyphen.
4744 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4745 be quoted in order to be a valid local part.
4747 In both cases, newlines and carriage returns are converted into \n and \r
4751 case EOP_QUOTE_LOCAL_PART:
4754 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4755 uschar *t = sub - 1;
4759 while (!needs_quote && *(++t) != 0)
4760 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4762 else /* EOP_QUOTE_LOCAL_PART */
4764 while (!needs_quote && *(++t) != 0)
4765 needs_quote = !isalnum(*t) &&
4766 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4767 (*t != '.' || t == sub || t[1] == 0);
4772 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4777 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4778 else if (*t == '\r')
4779 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4782 if (*t == '\\' || *t == '"')
4783 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4784 yield = string_cat(yield, &size, &ptr, t, 1);
4787 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4789 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4793 /* quote_lookuptype does lookup-specific quoting */
4798 uschar *opt = Ustrchr(arg, '_');
4800 if (opt != NULL) *opt++ = 0;
4802 n = search_findtype(arg, Ustrlen(arg));
4805 expand_string_message = search_error_message;
4809 if (lookup_list[n].quote != NULL)
4810 sub = (lookup_list[n].quote)(sub, opt);
4811 else if (opt != NULL) sub = NULL;
4815 expand_string_message = string_sprintf(
4816 "\"%s\" unrecognized after \"${quote_%s\"",
4821 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4825 /* rx quote sticks in \ before any non-alphameric character so that
4826 the insertion works in a regular expression. */
4830 uschar *t = sub - 1;
4834 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4835 yield = string_cat(yield, &size, &ptr, t, 1);
4840 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4841 prescribed by the RFC, if there are characters that need to be encoded */
4845 uschar buffer[2048];
4846 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4847 buffer, sizeof(buffer), FALSE);
4848 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4852 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4862 if (c > 255) c = '_';
4864 yield = string_cat(yield, &size, &ptr, buff, 1);
4869 /* escape turns all non-printing characters into escape sequences. */
4873 uschar *t = string_printing(sub);
4874 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4878 /* Handle numeric expression evaluation */
4883 uschar *save_sub = sub;
4884 uschar *error = NULL;
4885 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4888 expand_string_message = string_sprintf("error in expression "
4889 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4893 sprintf(CS var_buffer, "%d", n);
4894 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4898 /* Handle time period formating */
4902 int n = readconf_readtime(sub, 0, FALSE);
4905 expand_string_message = string_sprintf("string \"%s\" is not an "
4906 "Exim time interval in \"%s\" operator", sub, name);
4909 sprintf(CS var_buffer, "%d", n);
4910 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4914 case EOP_TIME_INTERVAL:
4917 uschar *t = read_number(&n, sub);
4918 if (*t != 0) /* Not A Number*/
4920 expand_string_message = string_sprintf("string \"%s\" is not a "
4921 "positive number in \"%s\" operator", sub, name);
4924 t = readconf_printtime(n);
4925 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4929 /* Convert string to base64 encoding */
4933 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4934 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4938 /* strlen returns the length of the string */
4943 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4944 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4948 /* length_n or l_n takes just the first n characters or the whole string,
4949 whichever is the shorter;
4951 substr_m_n, and s_m_n take n characters from offset m; negative m take
4952 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4953 takes the rest, either to the right or to the left.
4955 hash_n or h_n makes a hash of length n from the string, yielding n
4956 characters from the set a-z; hash_n_m makes a hash of length n, but
4957 uses m characters from the set a-zA-Z0-9.
4959 nhash_n returns a single number between 0 and n-1 (in text form), while
4960 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4961 between 0 and n-1 and the second between 0 and m-1. */
4981 expand_string_message = string_sprintf("missing values after %s",
4986 /* "length" has only one argument, effectively being synonymous with
4989 if (c == EOP_LENGTH || c == EOP_L)
4995 /* The others have one or two arguments; for "substr" the first may be
4996 negative. The second being negative means "not supplied". */
5001 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5004 /* Read up to two numbers, separated by underscores */
5009 if (arg != ret && *arg == '_' && pn == &value1)
5013 if (arg[1] != 0) arg++;
5015 else if (!isdigit(*arg))
5017 expand_string_message =
5018 string_sprintf("non-digit after underscore in \"%s\"", name);
5021 else *pn = (*pn)*10 + *arg++ - '0';
5025 /* Perform the required operation */
5028 (c == EOP_HASH || c == EOP_H)?
5029 compute_hash(sub, value1, value2, &len) :
5030 (c == EOP_NHASH || c == EOP_NH)?
5031 compute_nhash(sub, value1, value2, &len) :
5032 extract_substr(sub, value1, value2, &len);
5034 if (ret == NULL) goto EXPAND_FAILED;
5035 yield = string_cat(yield, &size, &ptr, ret, len);
5045 uschar **modetable[3];
5050 if ((expand_forbid & RDO_EXISTS) != 0)
5052 expand_string_message = US"Use of the stat() expansion is not permitted";
5056 if (stat(CS sub, &st) < 0)
5058 expand_string_message = string_sprintf("stat(%s) failed: %s",
5059 sub, strerror(errno));
5063 switch (mode & S_IFMT)
5065 case S_IFIFO: smode[0] = 'p'; break;
5066 case S_IFCHR: smode[0] = 'c'; break;
5067 case S_IFDIR: smode[0] = 'd'; break;
5068 case S_IFBLK: smode[0] = 'b'; break;
5069 case S_IFREG: smode[0] = '-'; break;
5070 default: smode[0] = '?'; break;
5073 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5074 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5075 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5077 for (i = 0; i < 3; i++)
5079 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5084 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5085 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5086 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5087 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5088 (long)st.st_gid, st.st_size, (long)st.st_atime,
5089 (long)st.st_mtime, (long)st.st_ctime);
5090 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5094 /* Unknown operator */
5097 expand_string_message =
5098 string_sprintf("unknown expansion operator \"%s\"", name);
5103 /* Handle a plain name. If this is the first thing in the expansion, release
5104 the pre-allocated buffer. If the result data is known to be in a new buffer,
5105 newsize will be set to the size of that buffer, and we can just point at that
5106 store instead of copying. Many expansion strings contain just one reference,
5107 so this is a useful optimization, especially for humungous headers
5108 ($message_headers). */
5120 value = find_variable(name, FALSE, skipping, &newsize);
5123 expand_string_message =
5124 string_sprintf("unknown variable in \"${%s}\"", name);
5126 if (strict_acl_vars &&
5127 Ustrncmp(name, "acl_", 4) == 0 &&
5128 (name[4] == 'c' || name[4] == 'm'))
5129 expand_string_message = string_sprintf("%s (strict_acl_vars is set)",
5130 expand_string_message);
5134 len = Ustrlen(value);
5135 if (yield == NULL && newsize != 0)
5141 else yield = string_cat(yield, &size, &ptr, value, len);
5145 /* Else there's something wrong */
5147 expand_string_message =
5148 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5149 "in a variable reference)", name);
5153 /* If we hit the end of the string when ket_ends is set, there is a missing
5154 terminating brace. */
5156 if (ket_ends && *s == 0)
5158 expand_string_message = malformed_header?
5159 US"missing } at end of string - could be header name not terminated by colon"
5161 US"missing } at end of string";
5165 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5166 added to the string. If so, set up an empty string. Add a terminating zero. If
5167 left != NULL, return a pointer to the terminator. */
5169 if (yield == NULL) yield = store_get(1);
5171 if (left != NULL) *left = s;
5173 /* Any stacking store that was used above the final string is no longer needed.
5174 In many cases the final string will be the first one that was got and so there
5175 will be optimal store usage. */
5177 store_reset(yield + ptr + 1);
5180 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5182 if (skipping) debug_printf("skipping: result is not used\n");
5186 /* This is the failure exit: easiest to program with a goto. We still need
5187 to update the pointer to the terminator, for cases of nested calls with "fail".
5190 EXPAND_FAILED_CURLY:
5191 expand_string_message = malformed_header?
5192 US"missing or misplaced { or } - could be header name not terminated by colon"
5194 US"missing or misplaced { or }";
5196 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5197 that is a bad idea, because expand_string_message is in dynamic store. */
5200 if (left != NULL) *left = s;
5203 debug_printf("failed to expand: %s\n", string);
5204 debug_printf(" error message: %s\n", expand_string_message);
5205 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5211 /* This is the external function call. Do a quick check for any expansion
5212 metacharacters, and if there are none, just return the input string.
5214 Argument: the string to be expanded
5215 Returns: the expanded string, or NULL if expansion failed; if failure was
5216 due to a lookup deferring, search_find_defer will be TRUE
5220 expand_string(uschar *string)
5222 search_find_defer = FALSE;
5223 malformed_header = FALSE;
5224 return (Ustrpbrk(string, "$\\") == NULL)? string :
5225 expand_string_internal(string, FALSE, NULL, FALSE);
5230 /*************************************************
5232 *************************************************/
5234 /* Now and again we want to expand a string and be sure that the result is in a
5235 new bit of store. This function does that.
5237 Argument: the string to be expanded
5238 Returns: the expanded string, always in a new bit of store, or NULL
5242 expand_string_copy(uschar *string)
5244 uschar *yield = expand_string(string);
5245 if (yield == string) yield = string_copy(string);
5251 /*************************************************
5252 * Expand and interpret as an integer *
5253 *************************************************/
5255 /* Expand a string, and convert the result into an integer.
5258 string the string to be expanded
5259 isplus TRUE if a non-negative number is expected
5261 Returns: the integer value, or
5262 -1 for an expansion error ) in both cases, message in
5263 -2 for an integer interpretation error ) expand_string_message
5264 expand_string_message is set NULL for an OK integer
5268 expand_string_integer(uschar *string, BOOL isplus)
5271 uschar *s = expand_string(string);
5272 uschar *msg = US"invalid integer \"%s\"";
5275 /* If expansion failed, expand_string_message will be set. */
5277 if (s == NULL) return -1;
5279 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5280 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5281 systems, so we set it zero ourselves. */
5284 expand_string_message = NULL; /* Indicates no error */
5285 value = strtol(CS s, CSS &endptr, 0);
5289 msg = US"integer expected but \"%s\" found";
5291 else if (value < 0 && isplus)
5293 msg = US"non-negative integer expected but \"%s\" found";
5297 /* Ensure we can cast this down to an int */
5298 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5300 if (errno != ERANGE)
5302 if (tolower(*endptr) == 'k')
5304 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5308 else if (tolower(*endptr) == 'm')
5310 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5312 else value *= 1024*1024;
5316 if (errno == ERANGE)
5317 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5320 while (isspace(*endptr)) endptr++;
5321 if (*endptr == 0) return (int)value;
5325 expand_string_message = string_sprintf(CS msg, s);
5330 /*************************************************
5331 **************************************************
5332 * Stand-alone test program *
5333 **************************************************
5334 *************************************************/
5340 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5342 int ovector[3*(EXPAND_MAXN+1)];
5343 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5344 ovector, sizeof(ovector)/sizeof(int));
5345 BOOL yield = n >= 0;
5346 if (n == 0) n = EXPAND_MAXN + 1;
5350 expand_nmax = (setup < 0)? 0 : setup + 1;
5351 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5353 expand_nstring[expand_nmax] = subject + ovector[nn];
5354 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5362 int main(int argc, uschar **argv)
5365 uschar buffer[1024];
5367 debug_selector = D_v;
5368 debug_file = stderr;
5369 debug_fd = fileno(debug_file);
5370 big_buffer = malloc(big_buffer_size);
5372 for (i = 1; i < argc; i++)
5374 if (argv[i][0] == '+')
5376 debug_trace_memory = 2;
5379 if (isdigit(argv[i][0]))
5380 debug_selector = Ustrtol(argv[i], NULL, 0);
5382 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5386 eldap_default_servers = argv[i];
5389 mysql_servers = argv[i];
5392 pgsql_servers = argv[i];
5396 else opt_perl_startup = argv[i];
5400 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5402 expand_nstring[1] = US"string 1....";
5403 expand_nlength[1] = 8;
5407 if (opt_perl_startup != NULL)
5410 printf("Starting Perl interpreter\n");
5411 errstr = init_perl(opt_perl_startup);
5414 printf("** error in perl_startup code: %s\n", errstr);
5415 return EXIT_FAILURE;
5418 #endif /* EXIM_PERL */
5420 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5422 void *reset_point = store_get(0);
5423 uschar *yield = expand_string(buffer);
5426 printf("%s\n", yield);
5427 store_reset(reset_point);
5431 if (search_find_defer) printf("search_find deferred\n");
5432 printf("Failed: %s\n", expand_string_message);
5433 if (expand_string_forcedfail) printf("Forced failure\n");
5445 /* End of expand.c */