1 /* $Cambridge: exim/src/src/expand.c,v 1.65 2006/10/24 14:32:49 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, processed */
278 vtype_msgheaders_raw, /* the message's headers, unprocessed */
279 vtype_localpart, /* extract local part from string */
280 vtype_domain, /* extract domain from string */
281 vtype_recipients, /* extract recipients from recipients list */
282 /* (enabled only during system filtering */
283 vtype_todbsdin, /* value not used; generate BSD inbox tod */
284 vtype_tode, /* value not used; generate tod in epoch format */
285 vtype_todf, /* value not used; generate full tod */
286 vtype_todl, /* value not used; generate log tod */
287 vtype_todlf, /* value not used; generate log file datestamp tod */
288 vtype_todzone, /* value not used; generate time zone only */
289 vtype_todzulu, /* value not used; generate zulu tod */
290 vtype_reply, /* value not used; get reply from headers */
291 vtype_pid, /* value not used; result is pid */
292 vtype_host_lookup, /* value not used; get host name */
293 vtype_load_avg, /* value not used; result is int from os_getloadavg */
294 vtype_pspace, /* partition space; value is T/F for spool/log */
295 vtype_pinodes /* partition inodes; value is T/F for spool/log */
296 #ifdef EXPERIMENTAL_DOMAINKEYS
297 ,vtype_dk_verify /* Serve request out of DomainKeys verification structure */
301 /* This table must be kept in alphabetical order. */
303 static var_entry var_table[] = {
304 /* WARNING: Do not invent variables whose names start acl_c or acl_m because
305 they will be confused with user-creatable ACL variables. */
306 { "acl_verify_message", vtype_stringptr, &acl_verify_message },
307 { "address_data", vtype_stringptr, &deliver_address_data },
308 { "address_file", vtype_stringptr, &address_file },
309 { "address_pipe", vtype_stringptr, &address_pipe },
310 { "authenticated_id", vtype_stringptr, &authenticated_id },
311 { "authenticated_sender",vtype_stringptr, &authenticated_sender },
312 { "authentication_failed",vtype_int, &authentication_failed },
313 #ifdef EXPERIMENTAL_BRIGHTMAIL
314 { "bmi_alt_location", vtype_stringptr, &bmi_alt_location },
315 { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
316 { "bmi_base64_verdict", vtype_stringptr, &bmi_base64_verdict },
317 { "bmi_deliver", vtype_int, &bmi_deliver },
319 { "body_linecount", vtype_int, &body_linecount },
320 { "body_zerocount", vtype_int, &body_zerocount },
321 { "bounce_recipient", vtype_stringptr, &bounce_recipient },
322 { "bounce_return_size_limit", vtype_int, &bounce_return_size_limit },
323 { "caller_gid", vtype_gid, &real_gid },
324 { "caller_uid", vtype_uid, &real_uid },
325 { "compile_date", vtype_stringptr, &version_date },
326 { "compile_number", vtype_stringptr, &version_cnumber },
327 { "csa_status", vtype_stringptr, &csa_status },
328 #ifdef WITH_OLD_DEMIME
329 { "demime_errorlevel", vtype_int, &demime_errorlevel },
330 { "demime_reason", vtype_stringptr, &demime_reason },
332 #ifdef EXPERIMENTAL_DOMAINKEYS
333 { "dk_domain", vtype_stringptr, &dk_signing_domain },
334 { "dk_is_signed", vtype_dk_verify, NULL },
335 { "dk_result", vtype_dk_verify, NULL },
336 { "dk_selector", vtype_stringptr, &dk_signing_selector },
337 { "dk_sender", vtype_dk_verify, NULL },
338 { "dk_sender_domain", vtype_dk_verify, NULL },
339 { "dk_sender_local_part",vtype_dk_verify, NULL },
340 { "dk_sender_source", vtype_dk_verify, NULL },
341 { "dk_signsall", vtype_dk_verify, NULL },
342 { "dk_status", vtype_dk_verify, NULL },
343 { "dk_testing", vtype_dk_verify, NULL },
345 { "dnslist_domain", vtype_stringptr, &dnslist_domain },
346 { "dnslist_text", vtype_stringptr, &dnslist_text },
347 { "dnslist_value", vtype_stringptr, &dnslist_value },
348 { "domain", vtype_stringptr, &deliver_domain },
349 { "domain_data", vtype_stringptr, &deliver_domain_data },
350 { "exim_gid", vtype_gid, &exim_gid },
351 { "exim_path", vtype_stringptr, &exim_path },
352 { "exim_uid", vtype_uid, &exim_uid },
353 #ifdef WITH_OLD_DEMIME
354 { "found_extension", vtype_stringptr, &found_extension },
356 { "home", vtype_stringptr, &deliver_home },
357 { "host", vtype_stringptr, &deliver_host },
358 { "host_address", vtype_stringptr, &deliver_host_address },
359 { "host_data", vtype_stringptr, &host_data },
360 { "host_lookup_deferred",vtype_int, &host_lookup_deferred },
361 { "host_lookup_failed", vtype_int, &host_lookup_failed },
362 { "inode", vtype_ino, &deliver_inode },
363 { "interface_address", vtype_stringptr, &interface_address },
364 { "interface_port", vtype_int, &interface_port },
366 { "ldap_dn", vtype_stringptr, &eldap_dn },
368 { "load_average", vtype_load_avg, NULL },
369 { "local_part", vtype_stringptr, &deliver_localpart },
370 { "local_part_data", vtype_stringptr, &deliver_localpart_data },
371 { "local_part_prefix", vtype_stringptr, &deliver_localpart_prefix },
372 { "local_part_suffix", vtype_stringptr, &deliver_localpart_suffix },
373 { "local_scan_data", vtype_stringptr, &local_scan_data },
374 { "local_user_gid", vtype_gid, &local_user_gid },
375 { "local_user_uid", vtype_uid, &local_user_uid },
376 { "localhost_number", vtype_int, &host_number },
377 { "log_inodes", vtype_pinodes, (void *)FALSE },
378 { "log_space", vtype_pspace, (void *)FALSE },
379 { "mailstore_basename", vtype_stringptr, &mailstore_basename },
380 #ifdef WITH_CONTENT_SCAN
381 { "malware_name", vtype_stringptr, &malware_name },
383 { "message_age", vtype_int, &message_age },
384 { "message_body", vtype_msgbody, &message_body },
385 { "message_body_end", vtype_msgbody_end, &message_body_end },
386 { "message_body_size", vtype_int, &message_body_size },
387 { "message_exim_id", vtype_stringptr, &message_id },
388 { "message_headers", vtype_msgheaders, NULL },
389 { "message_headers_raw", vtype_msgheaders_raw, NULL },
390 { "message_id", vtype_stringptr, &message_id },
391 { "message_linecount", vtype_int, &message_linecount },
392 { "message_size", vtype_int, &message_size },
393 #ifdef WITH_CONTENT_SCAN
394 { "mime_anomaly_level", vtype_int, &mime_anomaly_level },
395 { "mime_anomaly_text", vtype_stringptr, &mime_anomaly_text },
396 { "mime_boundary", vtype_stringptr, &mime_boundary },
397 { "mime_charset", vtype_stringptr, &mime_charset },
398 { "mime_content_description", vtype_stringptr, &mime_content_description },
399 { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
400 { "mime_content_id", vtype_stringptr, &mime_content_id },
401 { "mime_content_size", vtype_int, &mime_content_size },
402 { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
403 { "mime_content_type", vtype_stringptr, &mime_content_type },
404 { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
405 { "mime_filename", vtype_stringptr, &mime_filename },
406 { "mime_is_coverletter", vtype_int, &mime_is_coverletter },
407 { "mime_is_multipart", vtype_int, &mime_is_multipart },
408 { "mime_is_rfc822", vtype_int, &mime_is_rfc822 },
409 { "mime_part_count", vtype_int, &mime_part_count },
411 { "n0", vtype_filter_int, &filter_n[0] },
412 { "n1", vtype_filter_int, &filter_n[1] },
413 { "n2", vtype_filter_int, &filter_n[2] },
414 { "n3", vtype_filter_int, &filter_n[3] },
415 { "n4", vtype_filter_int, &filter_n[4] },
416 { "n5", vtype_filter_int, &filter_n[5] },
417 { "n6", vtype_filter_int, &filter_n[6] },
418 { "n7", vtype_filter_int, &filter_n[7] },
419 { "n8", vtype_filter_int, &filter_n[8] },
420 { "n9", vtype_filter_int, &filter_n[9] },
421 { "original_domain", vtype_stringptr, &deliver_domain_orig },
422 { "original_local_part", vtype_stringptr, &deliver_localpart_orig },
423 { "originator_gid", vtype_gid, &originator_gid },
424 { "originator_uid", vtype_uid, &originator_uid },
425 { "parent_domain", vtype_stringptr, &deliver_domain_parent },
426 { "parent_local_part", vtype_stringptr, &deliver_localpart_parent },
427 { "pid", vtype_pid, NULL },
428 { "primary_hostname", vtype_stringptr, &primary_hostname },
429 { "prvscheck_address", vtype_stringptr, &prvscheck_address },
430 { "prvscheck_keynum", vtype_stringptr, &prvscheck_keynum },
431 { "prvscheck_result", vtype_stringptr, &prvscheck_result },
432 { "qualify_domain", vtype_stringptr, &qualify_domain_sender },
433 { "qualify_recipient", vtype_stringptr, &qualify_domain_recipient },
434 { "rcpt_count", vtype_int, &rcpt_count },
435 { "rcpt_defer_count", vtype_int, &rcpt_defer_count },
436 { "rcpt_fail_count", vtype_int, &rcpt_fail_count },
437 { "received_count", vtype_int, &received_count },
438 { "received_for", vtype_stringptr, &received_for },
439 { "received_protocol", vtype_stringptr, &received_protocol },
440 { "received_time", vtype_int, &received_time },
441 { "recipient_data", vtype_stringptr, &recipient_data },
442 { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
443 { "recipients", vtype_recipients, NULL },
444 { "recipients_count", vtype_int, &recipients_count },
445 #ifdef WITH_CONTENT_SCAN
446 { "regex_match_string", vtype_stringptr, ®ex_match_string },
448 { "reply_address", vtype_reply, NULL },
449 { "return_path", vtype_stringptr, &return_path },
450 { "return_size_limit", vtype_int, &bounce_return_size_limit },
451 { "runrc", vtype_int, &runrc },
452 { "self_hostname", vtype_stringptr, &self_hostname },
453 { "sender_address", vtype_stringptr, &sender_address },
454 { "sender_address_data", vtype_stringptr, &sender_address_data },
455 { "sender_address_domain", vtype_domain, &sender_address },
456 { "sender_address_local_part", vtype_localpart, &sender_address },
457 { "sender_data", vtype_stringptr, &sender_data },
458 { "sender_fullhost", vtype_stringptr, &sender_fullhost },
459 { "sender_helo_name", vtype_stringptr, &sender_helo_name },
460 { "sender_host_address", vtype_stringptr, &sender_host_address },
461 { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
462 { "sender_host_name", vtype_host_lookup, NULL },
463 { "sender_host_port", vtype_int, &sender_host_port },
464 { "sender_ident", vtype_stringptr, &sender_ident },
465 { "sender_rate", vtype_stringptr, &sender_rate },
466 { "sender_rate_limit", vtype_stringptr, &sender_rate_limit },
467 { "sender_rate_period", vtype_stringptr, &sender_rate_period },
468 { "sender_rcvhost", vtype_stringptr, &sender_rcvhost },
469 { "sender_verify_failure",vtype_stringptr, &sender_verify_failure },
470 { "smtp_active_hostname", vtype_stringptr, &smtp_active_hostname },
471 { "smtp_command", vtype_stringptr, &smtp_cmd_buffer },
472 { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
473 { "sn0", vtype_filter_int, &filter_sn[0] },
474 { "sn1", vtype_filter_int, &filter_sn[1] },
475 { "sn2", vtype_filter_int, &filter_sn[2] },
476 { "sn3", vtype_filter_int, &filter_sn[3] },
477 { "sn4", vtype_filter_int, &filter_sn[4] },
478 { "sn5", vtype_filter_int, &filter_sn[5] },
479 { "sn6", vtype_filter_int, &filter_sn[6] },
480 { "sn7", vtype_filter_int, &filter_sn[7] },
481 { "sn8", vtype_filter_int, &filter_sn[8] },
482 { "sn9", vtype_filter_int, &filter_sn[9] },
483 #ifdef WITH_CONTENT_SCAN
484 { "spam_bar", vtype_stringptr, &spam_bar },
485 { "spam_report", vtype_stringptr, &spam_report },
486 { "spam_score", vtype_stringptr, &spam_score },
487 { "spam_score_int", vtype_stringptr, &spam_score_int },
489 #ifdef EXPERIMENTAL_SPF
490 { "spf_header_comment", vtype_stringptr, &spf_header_comment },
491 { "spf_received", vtype_stringptr, &spf_received },
492 { "spf_result", vtype_stringptr, &spf_result },
493 { "spf_smtp_comment", vtype_stringptr, &spf_smtp_comment },
495 { "spool_directory", vtype_stringptr, &spool_directory },
496 { "spool_inodes", vtype_pinodes, (void *)TRUE },
497 { "spool_space", vtype_pspace, (void *)TRUE },
498 #ifdef EXPERIMENTAL_SRS
499 { "srs_db_address", vtype_stringptr, &srs_db_address },
500 { "srs_db_key", vtype_stringptr, &srs_db_key },
501 { "srs_orig_recipient", vtype_stringptr, &srs_orig_recipient },
502 { "srs_orig_sender", vtype_stringptr, &srs_orig_sender },
503 { "srs_recipient", vtype_stringptr, &srs_recipient },
504 { "srs_status", vtype_stringptr, &srs_status },
506 { "thisaddress", vtype_stringptr, &filter_thisaddress },
507 { "tls_certificate_verified", vtype_int, &tls_certificate_verified },
508 { "tls_cipher", vtype_stringptr, &tls_cipher },
509 { "tls_peerdn", vtype_stringptr, &tls_peerdn },
510 { "tod_bsdinbox", vtype_todbsdin, NULL },
511 { "tod_epoch", vtype_tode, NULL },
512 { "tod_full", vtype_todf, NULL },
513 { "tod_log", vtype_todl, NULL },
514 { "tod_logfile", vtype_todlf, NULL },
515 { "tod_zone", vtype_todzone, NULL },
516 { "tod_zulu", vtype_todzulu, NULL },
517 { "value", vtype_stringptr, &lookup_value },
518 { "version_number", vtype_stringptr, &version_string },
519 { "warn_message_delay", vtype_stringptr, &warnmsg_delay },
520 { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
521 { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
522 { "warnmsg_delay", vtype_stringptr, &warnmsg_delay },
523 { "warnmsg_recipient", vtype_stringptr, &warnmsg_recipients },
524 { "warnmsg_recipients", vtype_stringptr, &warnmsg_recipients }
527 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
528 static uschar var_buffer[256];
529 static BOOL malformed_header;
531 /* For textual hashes */
533 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
534 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
537 enum { HMAC_MD5, HMAC_SHA1 };
539 /* For numeric hashes */
541 static unsigned int prime[] = {
542 2, 3, 5, 7, 11, 13, 17, 19, 23, 29,
543 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
544 73, 79, 83, 89, 97, 101, 103, 107, 109, 113};
546 /* For printing modes in symbolic form */
548 static uschar *mtable_normal[] =
549 { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
551 static uschar *mtable_setid[] =
552 { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
554 static uschar *mtable_sticky[] =
555 { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
559 /*************************************************
560 * Tables for UTF-8 support *
561 *************************************************/
563 /* Table of the number of extra characters, indexed by the first character
564 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
567 static uschar utf8_table1[] = {
568 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
569 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
570 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
571 3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
573 /* These are the masks for the data bits in the first byte of a character,
574 indexed by the number of additional bytes. */
576 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
578 /* Get the next UTF-8 character, advancing the pointer. */
580 #define GETUTF8INC(c, ptr) \
582 if ((c & 0xc0) == 0xc0) \
584 int a = utf8_table1[c & 0x3f]; /* Number of additional bytes */ \
586 c = (c & utf8_table2[a]) << s; \
590 c |= (*ptr++ & 0x3f) << s; \
595 /*************************************************
596 * Binary chop search on a table *
597 *************************************************/
599 /* This is used for matching expansion items and operators.
602 name the name that is being sought
603 table the table to search
604 table_size the number of items in the table
606 Returns: the offset in the table, or -1
610 chop_match(uschar *name, uschar **table, int table_size)
612 uschar **bot = table;
613 uschar **top = table + table_size;
617 uschar **mid = bot + (top - bot)/2;
618 int c = Ustrcmp(name, *mid);
619 if (c == 0) return mid - table;
620 if (c > 0) bot = mid + 1; else top = mid;
628 /*************************************************
629 * Check a condition string *
630 *************************************************/
632 /* This function is called to expand a string, and test the result for a "true"
633 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
634 forced fail or lookup defer. All store used by the function can be released on
638 condition the condition string
639 m1 text to be incorporated in panic error
642 Returns: TRUE if condition is met, FALSE if not
646 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
649 void *reset_point = store_get(0);
650 uschar *ss = expand_string(condition);
653 if (!expand_string_forcedfail && !search_find_defer)
654 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
655 "for %s %s: %s", condition, m1, m2, expand_string_message);
658 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
659 strcmpic(ss, US"false") != 0;
660 store_reset(reset_point);
666 /*************************************************
667 * Pick out a name from a string *
668 *************************************************/
670 /* If the name is too long, it is silently truncated.
673 name points to a buffer into which to put the name
674 max is the length of the buffer
675 s points to the first alphabetic character of the name
676 extras chars other than alphanumerics to permit
678 Returns: pointer to the first character after the name
680 Note: The test for *s != 0 in the while loop is necessary because
681 Ustrchr() yields non-NULL if the character is zero (which is not something
685 read_name(uschar *name, int max, uschar *s, uschar *extras)
688 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
690 if (ptr < max-1) name[ptr++] = *s;
699 /*************************************************
700 * Pick out the rest of a header name *
701 *************************************************/
703 /* A variable name starting $header_ (or just $h_ for those who like
704 abbreviations) might not be the complete header name because headers can
705 contain any printing characters in their names, except ':'. This function is
706 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
707 on the end, if the name was terminated by white space.
710 name points to a buffer in which the name read so far exists
711 max is the length of the buffer
712 s points to the first character after the name so far, i.e. the
713 first non-alphameric character after $header_xxxxx
715 Returns: a pointer to the first character after the header name
719 read_header_name(uschar *name, int max, uschar *s)
721 int prelen = Ustrchr(name, '_') - name + 1;
722 int ptr = Ustrlen(name) - prelen;
723 if (ptr > 0) memmove(name, name+prelen, ptr);
724 while (mac_isgraph(*s) && *s != ':')
726 if (ptr < max-1) name[ptr++] = *s;
737 /*************************************************
738 * Pick out a number from a string *
739 *************************************************/
742 n points to an integer into which to put the number
743 s points to the first digit of the number
745 Returns: a pointer to the character after the last digit
749 read_number(int *n, uschar *s)
752 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
758 /*************************************************
759 * Extract keyed subfield from a string *
760 *************************************************/
762 /* The yield is in dynamic store; NULL means that the key was not found.
765 key points to the name of the key
766 s points to the string from which to extract the subfield
768 Returns: NULL if the subfield was not found, or
769 a pointer to the subfield's data
773 expand_getkeyed(uschar *key, uschar *s)
775 int length = Ustrlen(key);
776 while (isspace(*s)) s++;
778 /* Loop to search for the key */
786 while (*s != 0 && *s != '=' && !isspace(*s)) s++;
787 dkeylength = s - dkey;
788 while (isspace(*s)) s++;
789 if (*s == '=') while (isspace((*(++s))));
791 data = string_dequote(&s);
792 if (length == dkeylength && strncmpic(key, dkey, length) == 0)
795 while (isspace(*s)) s++;
804 /*************************************************
805 * Extract numbered subfield from string *
806 *************************************************/
808 /* Extracts a numbered field from a string that is divided by tokens - for
809 example a line from /etc/passwd is divided by colon characters. First field is
810 numbered one. Negative arguments count from the right. Zero returns the whole
811 string. Returns NULL if there are insufficient tokens in the string
814 Modifies final argument - this is a dynamically generated string, so that's OK.
817 field number of field to be extracted,
818 first field = 1, whole string = 0, last field = -1
819 separators characters that are used to break string into tokens
820 s points to the string from which to extract the subfield
822 Returns: NULL if the field was not found,
823 a pointer to the field's data inside s (modified to add 0)
827 expand_gettokened (int field, uschar *separators, uschar *s)
832 uschar *fieldtext = NULL;
834 if (field == 0) return s;
836 /* Break the line up into fields in place; for field > 0 we stop when we have
837 done the number of fields we want. For field < 0 we continue till the end of
838 the string, counting the number of fields. */
840 count = (field > 0)? field : INT_MAX;
846 /* Previous field was the last one in the string. For a positive field
847 number, this means there are not enough fields. For a negative field number,
848 check that there are enough, and scan back to find the one that is wanted. */
852 if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
853 if ((-field) == (INT_MAX - count - 1)) return s;
857 while (ss[-1] != 0) ss--;
863 /* Previous field was not last in the string; save its start and put a
867 len = Ustrcspn(ss, separators);
878 /*************************************************
879 * Extract a substring from a string *
880 *************************************************/
882 /* Perform the ${substr or ${length expansion operations.
885 subject the input string
886 value1 the offset from the start of the input string to the start of
887 the output string; if negative, count from the right.
888 value2 the length of the output string, or negative (-1) for unset
889 if value1 is positive, unset means "all after"
890 if value1 is negative, unset means "all before"
891 len set to the length of the returned string
893 Returns: pointer to the output string, or NULL if there is an error
897 extract_substr(uschar *subject, int value1, int value2, int *len)
899 int sublen = Ustrlen(subject);
901 if (value1 < 0) /* count from right */
905 /* If the position is before the start, skip to the start, and adjust the
906 length. If the length ends up negative, the substring is null because nothing
907 can precede. This falls out naturally when the length is unset, meaning "all
913 if (value2 < 0) value2 = 0;
917 /* Otherwise an unset length => characters before value1 */
926 /* For a non-negative offset, if the starting position is past the end of the
927 string, the result will be the null string. Otherwise, an unset length means
928 "rest"; just set it to the maximum - it will be cut down below if necessary. */
937 else if (value2 < 0) value2 = sublen;
940 /* Cut the length down to the maximum possible for the offset value, and get
941 the required characters. */
943 if (value1 + value2 > sublen) value2 = sublen - value1;
945 return subject + value1;
951 /*************************************************
952 * Old-style hash of a string *
953 *************************************************/
955 /* Perform the ${hash expansion operation.
958 subject the input string (an expanded substring)
959 value1 the length of the output string; if greater or equal to the
960 length of the input string, the input string is returned
961 value2 the number of hash characters to use, or 26 if negative
962 len set to the length of the returned string
964 Returns: pointer to the output string, or NULL if there is an error
968 compute_hash(uschar *subject, int value1, int value2, int *len)
970 int sublen = Ustrlen(subject);
972 if (value2 < 0) value2 = 26;
973 else if (value2 > Ustrlen(hashcodes))
975 expand_string_message =
976 string_sprintf("hash count \"%d\" too big", value2);
980 /* Calculate the hash text. We know it is shorter than the original string, so
981 can safely place it in subject[] (we know that subject is always itself an
982 expanded substring). */
989 while ((c = (subject[j])) != 0)
991 int shift = (c + j++) & 7;
992 subject[i] ^= (c << shift) | (c >> (8-shift));
993 if (++i >= value1) i = 0;
995 for (i = 0; i < value1; i++)
996 subject[i] = hashcodes[(subject[i]) % value2];
998 else value1 = sublen;
1007 /*************************************************
1008 * Numeric hash of a string *
1009 *************************************************/
1011 /* Perform the ${nhash expansion operation. The first characters of the
1012 string are treated as most important, and get the highest prime numbers.
1015 subject the input string
1016 value1 the maximum value of the first part of the result
1017 value2 the maximum value of the second part of the result,
1018 or negative to produce only a one-part result
1019 len set to the length of the returned string
1021 Returns: pointer to the output string, or NULL if there is an error.
1025 compute_nhash (uschar *subject, int value1, int value2, int *len)
1027 uschar *s = subject;
1029 unsigned long int total = 0; /* no overflow */
1033 if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1034 total += prime[i--] * (unsigned int)(*s++);
1037 /* If value2 is unset, just compute one number */
1041 s = string_sprintf("%d", total % value1);
1044 /* Otherwise do a div/mod hash */
1048 total = total % (value1 * value2);
1049 s = string_sprintf("%d/%d", total/value2, total % value2);
1060 /*************************************************
1061 * Find the value of a header or headers *
1062 *************************************************/
1064 /* Multiple instances of the same header get concatenated, and this function
1065 can also return a concatenation of all the header lines. When concatenating
1066 specific headers that contain lists of addresses, a comma is inserted between
1067 them. Otherwise we use a straight concatenation. Because some messages can have
1068 pathologically large number of lines, there is a limit on the length that is
1069 returned. Also, to avoid massive store use which would result from using
1070 string_cat() as it copies and extends strings, we do a preliminary pass to find
1071 out exactly how much store will be needed. On "normal" messages this will be
1075 name the name of the header, without the leading $header_ or $h_,
1076 or NULL if a concatenation of all headers is required
1077 exists_only TRUE if called from a def: test; don't need to build a string;
1078 just return a string that is not "" and not "0" if the header
1080 newsize return the size of memory block that was obtained; may be NULL
1081 if exists_only is TRUE
1082 want_raw TRUE if called for $rh_ or $rheader_ variables; no processing,
1083 other than concatenating, will be done on the header. Also used
1084 for $message_headers_raw.
1085 charset name of charset to translate MIME words to; used only if
1086 want_raw is false; if NULL, no translation is done (this is
1087 used for $bh_ and $bheader_)
1089 Returns: NULL if the header does not exist, else a pointer to a new
1094 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1097 BOOL found = name == NULL;
1099 int len = found? 0 : Ustrlen(name);
1101 uschar *yield = NULL;
1104 /* Loop for two passes - saves code repetition */
1106 for (i = 0; i < 2; i++)
1111 for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1113 if (h->type != htype_old && h->text != NULL) /* NULL => Received: placeholder */
1115 if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1120 if (exists_only) return US"1"; /* don't need actual string */
1122 t = h->text + len; /* text to insert */
1123 if (!want_raw) /* unless wanted raw, */
1124 while (isspace(*t)) t++; /* remove leading white space */
1125 ilen = h->slen - (t - h->text); /* length to insert */
1127 /* Unless wanted raw, remove trailing whitespace, including the
1131 while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1133 /* Set comma = 1 if handling a single header and it's one of those
1134 that contains an address list, except when asked for raw headers. Only
1135 need to do this once. */
1137 if (!want_raw && name != NULL && comma == 0 &&
1138 Ustrchr("BCFRST", h->type) != NULL)
1141 /* First pass - compute total store needed; second pass - compute
1142 total store used, including this header. */
1144 size += ilen + comma + 1; /* +1 for the newline */
1146 /* Second pass - concatentate the data, up to a maximum. Note that
1147 the loop stops when size hits the limit. */
1151 if (size > header_insert_maxlen)
1153 ilen -= size - header_insert_maxlen - 1;
1156 Ustrncpy(ptr, t, ilen);
1159 /* For a non-raw header, put in the comma if needed, then add
1160 back the newline we removed above. */
1164 if (comma != 0 && ilen > 0) *ptr++ = ',';
1172 /* At end of first pass, return NULL if no header found. Then truncate size
1173 if necessary, and get the buffer to hold the data, returning the buffer size.
1178 if (!found) return NULL;
1179 if (size > header_insert_maxlen) size = header_insert_maxlen;
1180 *newsize = size + 1;
1181 ptr = yield = store_get(*newsize);
1185 /* That's all we do for raw header expansion. */
1192 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1193 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1194 function can return an error with decoded data if the charset translation
1195 fails. If decoding fails, it returns NULL. */
1199 uschar *decoded, *error;
1200 if (ptr > yield) ptr--;
1201 if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1203 decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1207 DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1208 " input was: %s\n", error, yield);
1210 if (decoded != NULL) yield = decoded;
1219 /*************************************************
1220 * Find value of a variable *
1221 *************************************************/
1223 /* The table of variables is kept in alphabetic order, so we can search it
1224 using a binary chop. The "choplen" variable is nothing to do with the binary
1228 name the name of the variable being sought
1229 exists_only TRUE if this is a def: test; passed on to find_header()
1230 skipping TRUE => skip any processing evaluation; this is not the same as
1231 exists_only because def: may test for values that are first
1233 newsize pointer to an int which is initially zero; if the answer is in
1234 a new memory buffer, *newsize is set to its size
1236 Returns: NULL if the variable does not exist, or
1237 a pointer to the variable's contents, or
1238 something non-NULL if exists_only is TRUE
1242 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1245 int last = var_table_size;
1247 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1248 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1249 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1250 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1251 (this gave backwards compatibility at the changeover). There may be built-in
1252 variables whose names start acl_ but they should never start in this way. This
1253 slightly messy specification is a consequence of the history, needless to say.
1255 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1256 set, in which case give an error. */
1258 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1262 tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1263 return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1266 /* Handle $auth<n> variables. */
1268 if (Ustrncmp(name, "auth", 4) == 0)
1271 int n = Ustrtoul(name + 4, &endptr, 10);
1272 if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1273 return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1276 /* For all other variables, search the table */
1278 while (last > first)
1282 int middle = (first + last)/2;
1283 int c = Ustrcmp(name, var_table[middle].name);
1285 if (c > 0) { first = middle + 1; continue; }
1286 if (c < 0) { last = middle; continue; }
1288 /* Found an existing variable. If in skipping state, the value isn't needed,
1289 and we want to avoid processing (such as looking up the host name). */
1291 if (skipping) return US"";
1293 switch (var_table[middle].type)
1295 #ifdef EXPERIMENTAL_DOMAINKEYS
1297 case vtype_dk_verify:
1298 if (dk_verify_block == NULL) return US"";
1300 if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1301 s = dk_verify_block->result_string;
1302 if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1303 s = dk_verify_block->address;
1304 if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1305 s = dk_verify_block->domain;
1306 if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1307 s = dk_verify_block->local_part;
1309 if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1310 switch(dk_verify_block->address_source) {
1311 case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1312 case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1313 case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1316 if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1317 switch(dk_verify_block->result) {
1318 case DK_EXIM_RESULT_ERR: s = US"error"; break;
1319 case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1320 case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1321 case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1322 case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1323 case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1324 case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1325 case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1328 if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1329 s = (dk_verify_block->signsall)? US"1" : US"0";
1331 if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1332 s = (dk_verify_block->testing)? US"1" : US"0";
1334 if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1335 s = (dk_verify_block->is_signed)? US"1" : US"0";
1337 return (s == NULL)? US"" : s;
1340 case vtype_filter_int:
1341 if (!filter_running) return NULL;
1345 sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1349 sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1353 sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1357 sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1360 case vtype_stringptr: /* Pointer to string */
1361 s = *((uschar **)(var_table[middle].value));
1362 return (s == NULL)? US"" : s;
1365 sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1368 case vtype_load_avg:
1369 sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1372 case vtype_host_lookup: /* Lookup if not done so */
1373 if (sender_host_name == NULL && sender_host_address != NULL &&
1374 !host_lookup_failed && host_name_lookup() == OK)
1375 host_build_sender_fullhost();
1376 return (sender_host_name == NULL)? US"" : sender_host_name;
1378 case vtype_localpart: /* Get local part from address */
1379 s = *((uschar **)(var_table[middle].value));
1380 if (s == NULL) return US"";
1381 domain = Ustrrchr(s, '@');
1382 if (domain == NULL) return s;
1383 if (domain - s > sizeof(var_buffer) - 1)
1384 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1385 "string expansion", sizeof(var_buffer));
1386 Ustrncpy(var_buffer, s, domain - s);
1387 var_buffer[domain - s] = 0;
1390 case vtype_domain: /* Get domain from address */
1391 s = *((uschar **)(var_table[middle].value));
1392 if (s == NULL) return US"";
1393 domain = Ustrrchr(s, '@');
1394 return (domain == NULL)? US"" : domain + 1;
1396 case vtype_msgheaders:
1397 return find_header(NULL, exists_only, newsize, FALSE, NULL);
1399 case vtype_msgheaders_raw:
1400 return find_header(NULL, exists_only, newsize, TRUE, NULL);
1402 case vtype_msgbody: /* Pointer to msgbody string */
1403 case vtype_msgbody_end: /* Ditto, the end of the msg */
1404 ss = (uschar **)(var_table[middle].value);
1405 if (*ss == NULL && deliver_datafile >= 0) /* Read body when needed */
1408 off_t start_offset = SPOOL_DATA_START_OFFSET;
1409 int len = message_body_visible;
1410 if (len > message_size) len = message_size;
1411 *ss = body = store_malloc(len+1);
1413 if (var_table[middle].type == vtype_msgbody_end)
1415 struct stat statbuf;
1416 if (fstat(deliver_datafile, &statbuf) == 0)
1418 start_offset = statbuf.st_size - len;
1419 if (start_offset < SPOOL_DATA_START_OFFSET)
1420 start_offset = SPOOL_DATA_START_OFFSET;
1423 lseek(deliver_datafile, start_offset, SEEK_SET);
1424 len = read(deliver_datafile, body, len);
1430 if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1434 return (*ss == NULL)? US"" : *ss;
1436 case vtype_todbsdin: /* BSD inbox time of day */
1437 return tod_stamp(tod_bsdin);
1439 case vtype_tode: /* Unix epoch time of day */
1440 return tod_stamp(tod_epoch);
1442 case vtype_todf: /* Full time of day */
1443 return tod_stamp(tod_full);
1445 case vtype_todl: /* Log format time of day */
1446 return tod_stamp(tod_log_bare); /* (without timezone) */
1448 case vtype_todzone: /* Time zone offset only */
1449 return tod_stamp(tod_zone);
1451 case vtype_todzulu: /* Zulu time */
1452 return tod_stamp(tod_zulu);
1454 case vtype_todlf: /* Log file datestamp tod */
1455 return tod_stamp(tod_log_datestamp);
1457 case vtype_reply: /* Get reply address */
1458 s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1460 if (s != NULL) while (isspace(*s)) s++;
1461 if (s == NULL || *s == 0)
1463 *newsize = 0; /* For the *s==0 case */
1464 s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1469 while (isspace(*s)) s++;
1470 for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1471 while (t > s && isspace(t[-1])) t--;
1474 return (s == NULL)? US"" : s;
1476 /* A recipients list is available only during system message filtering,
1477 during ACL processing after DATA, and while expanding pipe commands
1478 generated from a system filter, but not elsewhere. */
1480 case vtype_recipients:
1481 if (!enable_dollar_recipients) return NULL; else
1486 s = store_get(size);
1487 for (i = 0; i < recipients_count; i++)
1489 if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1490 s = string_cat(s, &size, &ptr, recipients_list[i].address,
1491 Ustrlen(recipients_list[i].address));
1493 s[ptr] = 0; /* string_cat() leaves room */
1500 sprintf(CS var_buffer, "%d",
1501 receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1508 (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1509 sprintf(CS var_buffer, "%d", inodes);
1515 return NULL; /* Unknown variable name */
1521 /*************************************************
1522 * Read and expand substrings *
1523 *************************************************/
1525 /* This function is called to read and expand argument substrings for various
1526 expansion items. Some have a minimum requirement that is less than the maximum;
1527 in these cases, the first non-present one is set to NULL.
1530 sub points to vector of pointers to set
1531 n maximum number of substrings
1533 sptr points to current string pointer
1534 skipping the skipping flag
1535 check_end if TRUE, check for final '}'
1536 name name of item, for error message
1538 Returns: 0 OK; string pointer updated
1539 1 curly bracketing error (too few arguments)
1540 2 too many arguments (only if check_end is set); message set
1541 3 other error (expansion failure)
1545 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1546 BOOL check_end, uschar *name)
1551 while (isspace(*s)) s++;
1552 for (i = 0; i < n; i++)
1556 if (i < m) return 1;
1560 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1561 if (sub[i] == NULL) return 3;
1562 if (*s++ != '}') return 1;
1563 while (isspace(*s)) s++;
1565 if (check_end && *s++ != '}')
1569 expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1570 "(max is %d)", name, n);
1583 /*************************************************
1584 * Elaborate message for bad variable *
1585 *************************************************/
1587 /* For the "unknown variable" message, take a look at the variable's name, and
1588 give additional information about possible ACL variables. The extra information
1589 is added on to expand_string_message.
1591 Argument: the name of the variable
1596 check_variable_error_message(uschar *name)
1598 if (Ustrncmp(name, "acl_", 4) == 0)
1599 expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1600 (name[4] == 'c' || name[4] == 'm')?
1602 US"6th character of a user-defined ACL variable must be a digit or underscore" :
1603 US"strict_acl_vars is set" /* Syntax is OK, it has to be this */
1605 US"user-defined ACL variables must start acl_c or acl_m");
1610 /*************************************************
1611 * Read and evaluate a condition *
1612 *************************************************/
1616 s points to the start of the condition text
1617 yield points to a BOOL to hold the result of the condition test;
1618 if NULL, we are just reading through a condition that is
1619 part of an "or" combination to check syntax, or in a state
1620 where the answer isn't required
1622 Returns: a pointer to the first character after the condition, or
1627 eval_condition(uschar *s, BOOL *yield)
1629 BOOL testfor = TRUE;
1630 BOOL tempcond, combined_cond;
1632 int i, rc, cond_type, roffset;
1634 struct stat statbuf;
1639 const uschar *rerror;
1643 while (isspace(*s)) s++;
1644 if (*s == '!') { testfor = !testfor; s++; } else break;
1647 /* Numeric comparisons are symbolic */
1649 if (*s == '=' || *s == '>' || *s == '<')
1661 /* All other conditions are named */
1663 else s = read_name(name, 256, s, US"_");
1665 /* If we haven't read a name, it means some non-alpha character is first. */
1669 expand_string_message = string_sprintf("condition name expected, "
1670 "but found \"%.16s\"", s);
1674 /* Find which condition we are dealing with, and switch on it */
1676 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1679 /* def: tests for a non-empty variable, or for the existence of a header. If
1680 yield == NULL we are in a skipping state, and don't care about the answer. */
1685 expand_string_message = US"\":\" expected after \"def\"";
1689 s = read_name(name, 256, s+1, US"_");
1691 /* Test for a header's existence */
1693 if (Ustrncmp(name, "h_", 2) == 0 ||
1694 Ustrncmp(name, "rh_", 3) == 0 ||
1695 Ustrncmp(name, "bh_", 3) == 0 ||
1696 Ustrncmp(name, "header_", 7) == 0 ||
1697 Ustrncmp(name, "rheader_", 8) == 0 ||
1698 Ustrncmp(name, "bheader_", 8) == 0)
1700 s = read_header_name(name, 256, s);
1701 if (yield != NULL) *yield =
1702 (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1705 /* Test for a variable's having a non-empty value. A non-existent variable
1706 causes an expansion failure. */
1710 uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1713 expand_string_message = (name[0] == 0)?
1714 string_sprintf("variable name omitted after \"def:\"") :
1715 string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1716 check_variable_error_message(name);
1719 if (yield != NULL) *yield = (value[0] != 0) == testfor;
1725 /* first_delivery tests for first delivery attempt */
1727 case ECOND_FIRST_DELIVERY:
1728 if (yield != NULL) *yield = deliver_firsttime == testfor;
1732 /* queue_running tests for any process started by a queue runner */
1734 case ECOND_QUEUE_RUNNING:
1735 if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1739 /* exists: tests for file existence
1740 isip: tests for any IP address
1741 isip4: tests for an IPv4 address
1742 isip6: tests for an IPv6 address
1743 pam: does PAM authentication
1744 radius: does RADIUS authentication
1745 ldapauth: does LDAP authentication
1746 pwcheck: does Cyrus SASL pwcheck authentication
1755 case ECOND_LDAPAUTH:
1758 while (isspace(*s)) s++;
1759 if (*s != '{') goto COND_FAILED_CURLY_START;
1761 sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1762 if (sub[0] == NULL) return NULL;
1763 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1765 if (yield == NULL) return s; /* No need to run the test if skipping */
1770 if ((expand_forbid & RDO_EXISTS) != 0)
1772 expand_string_message = US"File existence tests are not permitted";
1775 *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1781 rc = string_is_ip_address(sub[0], NULL);
1782 *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1783 (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1786 /* Various authentication tests - all optionally compiled */
1790 rc = auth_call_pam(sub[0], &expand_string_message);
1793 goto COND_FAILED_NOT_COMPILED;
1794 #endif /* SUPPORT_PAM */
1797 #ifdef RADIUS_CONFIG_FILE
1798 rc = auth_call_radius(sub[0], &expand_string_message);
1801 goto COND_FAILED_NOT_COMPILED;
1802 #endif /* RADIUS_CONFIG_FILE */
1804 case ECOND_LDAPAUTH:
1807 /* Just to keep the interface the same */
1809 int old_pool = store_pool;
1810 store_pool = POOL_SEARCH;
1811 rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1812 &expand_string_message, &do_cache);
1813 store_pool = old_pool;
1817 goto COND_FAILED_NOT_COMPILED;
1818 #endif /* LOOKUP_LDAP */
1821 #ifdef CYRUS_PWCHECK_SOCKET
1822 rc = auth_call_pwcheck(sub[0], &expand_string_message);
1825 goto COND_FAILED_NOT_COMPILED;
1826 #endif /* CYRUS_PWCHECK_SOCKET */
1828 #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1829 defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1831 if (rc == ERROR || rc == DEFER) return NULL;
1832 *yield = (rc == OK) == testfor;
1838 /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1840 ${if saslauthd {{username}{password}{service}{realm}} {yes}[no}}
1842 However, the last two are optional. That is why the whole set is enclosed
1843 in their own set or braces. */
1845 case ECOND_SASLAUTHD:
1846 #ifndef CYRUS_SASLAUTHD_SOCKET
1847 goto COND_FAILED_NOT_COMPILED;
1849 while (isspace(*s)) s++;
1850 if (*s++ != '{') goto COND_FAILED_CURLY_START;
1851 switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1853 case 1: expand_string_message = US"too few arguments or bracketing "
1854 "error for saslauthd";
1856 case 3: return NULL;
1858 if (sub[2] == NULL) sub[3] = NULL; /* realm if no service */
1862 rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1863 &expand_string_message);
1864 if (rc == ERROR || rc == DEFER) return NULL;
1865 *yield = (rc == OK) == testfor;
1868 #endif /* CYRUS_SASLAUTHD_SOCKET */
1871 /* symbolic operators for numeric and string comparison, and a number of
1872 other operators, all requiring two arguments.
1874 match: does a regular expression match and sets up the numerical
1875 variables if it succeeds
1876 match_address: matches in an address list
1877 match_domain: matches in a domain list
1878 match_ip: matches a host list that is restricted to IP addresses
1879 match_local_part: matches in a local part list
1880 crypteq: encrypts plaintext and compares against an encrypted text,
1881 using crypt(), crypt16(), MD5 or SHA-1
1885 case ECOND_MATCH_ADDRESS:
1886 case ECOND_MATCH_DOMAIN:
1887 case ECOND_MATCH_IP:
1888 case ECOND_MATCH_LOCAL_PART:
1891 case ECOND_NUM_L: /* Numerical comparisons */
1898 case ECOND_STR_LT: /* String comparisons */
1909 for (i = 0; i < 2; i++)
1911 while (isspace(*s)) s++;
1914 if (i == 0) goto COND_FAILED_CURLY_START;
1915 expand_string_message = string_sprintf("missing 2nd string in {} "
1916 "after \"%s\"", name);
1919 sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1920 if (sub[i] == NULL) return NULL;
1921 if (*s++ != '}') goto COND_FAILED_CURLY_END;
1923 /* Convert to numerical if required; we know that the names of all the
1924 conditions that compare numbers do not start with a letter. This just saves
1925 checking for them individually. */
1927 if (!isalpha(name[0]))
1929 num[i] = expand_string_integer(sub[i], FALSE);
1930 if (expand_string_message != NULL) return NULL;
1934 /* Result not required */
1936 if (yield == NULL) return s;
1938 /* Do an appropriate comparison */
1944 *yield = (num[0] == num[1]) == testfor;
1948 *yield = (num[0] > num[1]) == testfor;
1952 *yield = (num[0] >= num[1]) == testfor;
1956 *yield = (num[0] < num[1]) == testfor;
1960 *yield = (num[0] <= num[1]) == testfor;
1964 *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1968 *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1972 *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1976 *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1980 *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1984 *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1988 *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1992 *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1996 *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
2000 *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
2003 case ECOND_MATCH: /* Regular expression match */
2004 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2008 expand_string_message = string_sprintf("regular expression error in "
2009 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2012 *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
2015 case ECOND_MATCH_ADDRESS: /* Match in an address list */
2016 rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2017 goto MATCHED_SOMETHING;
2019 case ECOND_MATCH_DOMAIN: /* Match in a domain list */
2020 rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2021 MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2022 goto MATCHED_SOMETHING;
2024 case ECOND_MATCH_IP: /* Match IP address in a host list */
2025 if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2027 expand_string_message = string_sprintf("\"%s\" is not an IP address",
2033 unsigned int *nullcache = NULL;
2034 check_host_block cb;
2036 cb.host_name = US"";
2037 cb.host_address = sub[0];
2039 /* If the host address starts off ::ffff: it is an IPv6 address in
2040 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2043 cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2044 cb.host_address + 7 : cb.host_address;
2046 rc = match_check_list(
2047 &sub[1], /* the list */
2048 0, /* separator character */
2049 &hostlist_anchor, /* anchor pointer */
2050 &nullcache, /* cache pointer */
2051 check_host, /* function for testing */
2052 &cb, /* argument for function */
2053 MCL_HOST, /* type of check */
2054 sub[0], /* text for debugging */
2055 NULL); /* where to pass back data */
2057 goto MATCHED_SOMETHING;
2059 case ECOND_MATCH_LOCAL_PART:
2060 rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2061 MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2076 expand_string_message = string_sprintf("unable to complete match "
2077 "against \"%s\": %s", sub[1], search_error_message);
2083 /* Various "encrypted" comparisons. If the second string starts with
2084 "{" then an encryption type is given. Default to crypt() or crypt16()
2085 (build-time choice). */
2088 #ifndef SUPPORT_CRYPTEQ
2089 goto COND_FAILED_NOT_COMPILED;
2091 if (strncmpic(sub[1], US"{md5}", 5) == 0)
2093 int sublen = Ustrlen(sub[1]+5);
2098 md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2100 /* If the length that we are comparing against is 24, the MD5 digest
2101 is expressed as a base64 string. This is the way LDAP does it. However,
2102 some other software uses a straightforward hex representation. We assume
2103 this if the length is 32. Other lengths fail. */
2107 uschar *coded = auth_b64encode((uschar *)digest, 16);
2108 DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2109 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2110 *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2112 else if (sublen == 32)
2116 for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2118 DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2119 " subject=%s\n crypted=%s\n", coded, sub[1]+5);
2120 *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2124 DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2125 "fail\n crypted=%s\n", sub[1]+5);
2130 else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2132 int sublen = Ustrlen(sub[1]+6);
2137 sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2139 /* If the length that we are comparing against is 28, assume the SHA1
2140 digest is expressed as a base64 string. If the length is 40, assume a
2141 straightforward hex representation. Other lengths fail. */
2145 uschar *coded = auth_b64encode((uschar *)digest, 20);
2146 DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2147 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2148 *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2150 else if (sublen == 40)
2154 for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2156 DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2157 " subject=%s\n crypted=%s\n", coded, sub[1]+6);
2158 *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2162 DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2163 "fail\n crypted=%s\n", sub[1]+6);
2168 else /* {crypt} or {crypt16} and non-{ at start */
2173 if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2178 else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2183 else if (sub[1][0] == '{')
2185 expand_string_message = string_sprintf("unknown encryption mechanism "
2186 "in \"%s\"", sub[1]);
2192 case 0: coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2193 case 1: coded = US crypt(CS sub[0], CS sub[1]); break;
2194 default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2198 #define XSTR(s) STR(s)
2199 DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2200 " subject=%s\n crypted=%s\n",
2201 (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2206 /* If the encrypted string contains fewer than two characters (for the
2207 salt), force failure. Otherwise we get false positives: with an empty
2208 string the yield of crypt() is an empty string! */
2210 *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2211 (Ustrcmp(coded, sub[1]) == 0) == testfor;
2214 #endif /* SUPPORT_CRYPTEQ */
2215 } /* Switch for comparison conditions */
2217 return s; /* End of comparison conditions */
2220 /* and/or: computes logical and/or of several conditions */
2224 subcondptr = (yield == NULL)? NULL : &tempcond;
2225 combined_cond = (cond_type == ECOND_AND);
2227 while (isspace(*s)) s++;
2228 if (*s++ != '{') goto COND_FAILED_CURLY_START;
2232 while (isspace(*s)) s++;
2233 if (*s == '}') break;
2236 expand_string_message = string_sprintf("each subcondition "
2237 "inside an \"%s{...}\" condition must be in its own {}", name);
2241 s = eval_condition(s+1, subcondptr);
2244 expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2245 expand_string_message, name);
2248 while (isspace(*s)) s++;
2252 expand_string_message = string_sprintf("missing } at end of condition "
2253 "inside \"%s\" group", name);
2259 if (cond_type == ECOND_AND)
2261 combined_cond &= tempcond;
2262 if (!combined_cond) subcondptr = NULL; /* once false, don't */
2263 } /* evaluate any more */
2266 combined_cond |= tempcond;
2267 if (combined_cond) subcondptr = NULL; /* once true, don't */
2268 } /* evaluate any more */
2272 if (yield != NULL) *yield = (combined_cond == testfor);
2276 /* Unknown condition */
2279 expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2281 } /* End switch on condition type */
2283 /* Missing braces at start and end of data */
2285 COND_FAILED_CURLY_START:
2286 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2289 COND_FAILED_CURLY_END:
2290 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2294 /* A condition requires code that is not compiled */
2296 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2297 !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2298 !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2299 COND_FAILED_NOT_COMPILED:
2300 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2309 /*************************************************
2310 * Save numerical variables *
2311 *************************************************/
2313 /* This function is called from items such as "if" that want to preserve and
2314 restore the numbered variables.
2317 save_expand_string points to an array of pointers to set
2318 save_expand_nlength points to an array of ints for the lengths
2320 Returns: the value of expand max to save
2324 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2327 for (i = 0; i <= expand_nmax; i++)
2329 save_expand_nstring[i] = expand_nstring[i];
2330 save_expand_nlength[i] = expand_nlength[i];
2337 /*************************************************
2338 * Restore numerical variables *
2339 *************************************************/
2341 /* This function restored saved values of numerical strings.
2344 save_expand_nmax the number of strings to restore
2345 save_expand_string points to an array of pointers
2346 save_expand_nlength points to an array of ints
2352 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2353 int *save_expand_nlength)
2356 expand_nmax = save_expand_nmax;
2357 for (i = 0; i <= expand_nmax; i++)
2359 expand_nstring[i] = save_expand_nstring[i];
2360 expand_nlength[i] = save_expand_nlength[i];
2368 /*************************************************
2369 * Handle yes/no substrings *
2370 *************************************************/
2372 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2373 alternative substrings that depend on whether or not the condition was true,
2374 or the lookup or extraction succeeded. The substrings always have to be
2375 expanded, to check their syntax, but "skipping" is set when the result is not
2376 needed - this avoids unnecessary nested lookups.
2379 skipping TRUE if we were skipping when this item was reached
2380 yes TRUE if the first string is to be used, else use the second
2381 save_lookup a value to put back into lookup_value before the 2nd expansion
2382 sptr points to the input string pointer
2383 yieldptr points to the output string pointer
2384 sizeptr points to the output string size
2385 ptrptr points to the output string pointer
2386 type "lookup" or "if" or "extract" or "run", for error message
2388 Returns: 0 OK; lookup_value has been reset to save_lookup
2390 2 expansion failed because of bracketing error
2394 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2395 uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2398 uschar *s = *sptr; /* Local value */
2399 uschar *sub1, *sub2;
2401 /* If there are no following strings, we substitute the contents of $value for
2402 lookups and for extractions in the success case. For the ${if item, the string
2403 "true" is substituted. In the fail case, nothing is substituted for all three
2406 while (isspace(*s)) s++;
2411 if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2415 if (yes && lookup_value != NULL)
2416 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2417 Ustrlen(lookup_value));
2418 lookup_value = save_lookup;
2424 /* The first following string must be braced. */
2426 if (*s++ != '{') goto FAILED_CURLY;
2428 /* Expand the first substring. Forced failures are noticed only if we actually
2429 want this string. Set skipping in the call in the fail case (this will always
2430 be the case if we were already skipping). */
2432 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2433 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2434 expand_string_forcedfail = FALSE;
2435 if (*s++ != '}') goto FAILED_CURLY;
2437 /* If we want the first string, add it to the output */
2440 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2442 /* If this is called from a lookup or an extract, we want to restore $value to
2443 what it was at the start of the item, so that it has this value during the
2444 second string expansion. For the call from "if" or "run" to this function,
2445 save_lookup is set to lookup_value, so that this statement does nothing. */
2447 lookup_value = save_lookup;
2449 /* There now follows either another substring, or "fail", or nothing. This
2450 time, forced failures are noticed only if we want the second string. We must
2451 set skipping in the nested call if we don't want this string, or if we were
2452 already skipping. */
2454 while (isspace(*s)) s++;
2457 sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2458 if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2459 expand_string_forcedfail = FALSE;
2460 if (*s++ != '}') goto FAILED_CURLY;
2462 /* If we want the second string, add it to the output */
2465 *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2468 /* If there is no second string, but the word "fail" is present when the use of
2469 the second string is wanted, set a flag indicating it was a forced failure
2470 rather than a syntactic error. Swallow the terminating } in case this is nested
2471 inside another lookup or if or extract. */
2476 s = read_name(name, sizeof(name), s, US"_");
2477 if (Ustrcmp(name, "fail") == 0)
2479 if (!yes && !skipping)
2481 while (isspace(*s)) s++;
2482 if (*s++ != '}') goto FAILED_CURLY;
2483 expand_string_message =
2484 string_sprintf("\"%s\" failed and \"fail\" requested", type);
2485 expand_string_forcedfail = TRUE;
2491 expand_string_message =
2492 string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2497 /* All we have to do now is to check on the final closing brace. */
2499 while (isspace(*s)) s++;
2500 if (*s++ == '}') goto RETURN;
2502 /* Get here if there is a bracketing failure */
2507 /* Get here for other failures */
2512 /* Update the input pointer value before returning */
2522 /*************************************************
2523 * Handle MD5 or SHA-1 computation for HMAC *
2524 *************************************************/
2526 /* These are some wrapping functions that enable the HMAC code to be a bit
2527 cleaner. A good compiler will spot the tail recursion.
2530 type HMAC_MD5 or HMAC_SHA1
2531 remaining are as for the cryptographic hash functions
2537 chash_start(int type, void *base)
2539 if (type == HMAC_MD5)
2540 md5_start((md5 *)base);
2542 sha1_start((sha1 *)base);
2546 chash_mid(int type, void *base, uschar *string)
2548 if (type == HMAC_MD5)
2549 md5_mid((md5 *)base, string);
2551 sha1_mid((sha1 *)base, string);
2555 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2557 if (type == HMAC_MD5)
2558 md5_end((md5 *)base, string, length, digest);
2560 sha1_end((sha1 *)base, string, length, digest);
2567 /********************************************************
2568 * prvs: Get last three digits of days since Jan 1, 1970 *
2569 ********************************************************/
2571 /* This is needed to implement the "prvs" BATV reverse
2574 Argument: integer "days" offset to add or substract to
2575 or from the current number of days.
2577 Returns: pointer to string containing the last three
2578 digits of the number of days since Jan 1, 1970,
2579 modified by the offset argument, NULL if there
2580 was an error in the conversion.
2585 prvs_daystamp(int day_offset)
2587 uschar *days = store_get(32); /* Need at least 24 for cases */
2588 (void)string_format(days, 32, TIME_T_FMT, /* where TIME_T_FMT is %lld */
2589 (time(NULL) + day_offset*86400)/86400);
2590 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2595 /********************************************************
2596 * prvs: perform HMAC-SHA1 computation of prvs bits *
2597 ********************************************************/
2599 /* This is needed to implement the "prvs" BATV reverse
2603 address RFC2821 Address to use
2604 key The key to use (must be less than 64 characters
2606 key_num Single-digit key number to use. Defaults to
2609 Returns: pointer to string containing the first three
2610 bytes of the final hash in hex format, NULL if
2611 there was an error in the process.
2615 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2617 uschar *hash_source, *p;
2618 int size = 0,offset = 0,i;
2620 void *use_base = &sha1_base;
2621 uschar innerhash[20];
2622 uschar finalhash[20];
2623 uschar innerkey[64];
2624 uschar outerkey[64];
2625 uschar *finalhash_hex = store_get(40);
2627 if (key_num == NULL)
2630 if (Ustrlen(key) > 64)
2633 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2634 string_cat(hash_source,&size,&offset,daystamp,3);
2635 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2636 hash_source[offset] = '\0';
2638 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2640 memset(innerkey, 0x36, 64);
2641 memset(outerkey, 0x5c, 64);
2643 for (i = 0; i < Ustrlen(key); i++)
2645 innerkey[i] ^= key[i];
2646 outerkey[i] ^= key[i];
2649 chash_start(HMAC_SHA1, use_base);
2650 chash_mid(HMAC_SHA1, use_base, innerkey);
2651 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2653 chash_start(HMAC_SHA1, use_base);
2654 chash_mid(HMAC_SHA1, use_base, outerkey);
2655 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2658 for (i = 0; i < 3; i++)
2660 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2661 *p++ = hex_digits[finalhash[i] & 0x0f];
2665 return finalhash_hex;
2671 /*************************************************
2672 * Join a file onto the output string *
2673 *************************************************/
2675 /* This is used for readfile and after a run expansion. It joins the contents
2676 of a file onto the output string, globally replacing newlines with a given
2677 string (optionally). The file is closed at the end.
2681 yield pointer to the expandable string
2682 sizep pointer to the current size
2683 ptrp pointer to the current position
2684 eol newline replacement string, or NULL
2686 Returns: new value of string pointer
2690 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2693 uschar buffer[1024];
2695 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2697 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2699 int len = Ustrlen(buffer);
2700 if (eol != NULL && buffer[len-1] == '\n') len--;
2701 yield = string_cat(yield, sizep, ptrp, buffer, len);
2702 if (buffer[len] != 0)
2703 yield = string_cat(yield, sizep, ptrp, eol, eollen);
2706 if (yield != NULL) yield[*ptrp] = 0;
2714 /*************************************************
2715 * Evaluate numeric expression *
2716 *************************************************/
2718 /* This is a set of mutually recursive functions that evaluate a simple
2719 arithmetic expression involving only + - * / and parentheses. The only one that
2720 is called from elsewhere is eval_expr, whose interface is:
2723 sptr pointer to the pointer to the string - gets updated
2724 decimal TRUE if numbers are to be assumed decimal
2725 error pointer to where to put an error message - must be NULL on input
2726 endket TRUE if ')' must terminate - FALSE for external call
2729 Returns: on success: the value of the expression, with *error still NULL
2730 on failure: an undefined value, with *error = a message
2733 static int eval_sumterm(uschar **, BOOL, uschar **);
2736 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2739 int x = eval_sumterm(&s, decimal, error);
2742 while (*s == '+' || *s == '-')
2745 int y = eval_sumterm(&s, decimal, error);
2746 if (*error != NULL) break;
2747 if (op == '+') x += y; else x -= y;
2754 *error = US"expecting closing parenthesis";
2756 while (isspace(*(++s)));
2758 else if (*s != 0) *error = US"expecting + or -";
2767 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2772 while (isspace(*s)) s++;
2774 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2777 (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2779 if (tolower(*s) == 'k') { n *= 1024; s++; }
2780 else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2781 while (isspace (*s)) s++;
2786 n = eval_expr(&s, decimal, error, 1);
2790 *error = US"expecting number or opening parenthesis";
2797 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2800 int x = eval_term(&s, decimal, error);
2803 while (*s == '*' || *s == '/' || *s == '%')
2806 int y = eval_term(&s, decimal, error);
2807 if (*error != NULL) break;
2808 if (op == '*') x *= y;
2809 else if (op == '/') x /= y;
2820 /*************************************************
2822 *************************************************/
2824 /* Returns either an unchanged string, or the expanded string in stacking pool
2825 store. Interpreted sequences are:
2827 \... normal escaping rules
2828 $name substitutes the variable
2830 ${op:string} operates on the expanded string value
2831 ${item{arg1}{arg2}...} expands the args and then does the business
2832 some literal args are not enclosed in {}
2834 There are now far too many operators and item types to make it worth listing
2835 them here in detail any more.
2837 We use an internal routine recursively to handle embedded substrings. The
2838 external function follows. The yield is NULL if the expansion failed, and there
2839 are two cases: if something collapsed syntactically, or if "fail" was given
2840 as the action on a lookup failure. These can be distinguised by looking at the
2841 variable expand_string_forcedfail, which is TRUE in the latter case.
2843 The skipping flag is set true when expanding a substring that isn't actually
2844 going to be used (after "if" or "lookup") and it prevents lookups from
2845 happening lower down.
2847 Store usage: At start, a store block of the length of the input plus 64
2848 is obtained. This is expanded as necessary by string_cat(), which might have to
2849 get a new block, or might be able to expand the original. At the end of the
2850 function we can release any store above that portion of the yield block that
2851 was actually used. In many cases this will be optimal.
2853 However: if the first item in the expansion is a variable name or header name,
2854 we reset the store before processing it; if the result is in fresh store, we
2855 use that without copying. This is helpful for expanding strings like
2856 $message_headers which can get very long.
2859 string the string to be expanded
2860 ket_ends true if expansion is to stop at }
2861 left if not NULL, a pointer to the first character after the
2862 expansion is placed here (typically used with ket_ends)
2863 skipping TRUE for recursive calls when the value isn't actually going
2864 to be used (to allow for optimisation)
2866 Returns: NULL if expansion fails:
2867 expand_string_forcedfail is set TRUE if failure was forced
2868 expand_string_message contains a textual error message
2869 a pointer to the expanded string on success
2873 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2877 int size = Ustrlen(string)+ 64;
2879 uschar *yield = store_get(size);
2881 uschar *save_expand_nstring[EXPAND_MAXN+1];
2882 int save_expand_nlength[EXPAND_MAXN+1];
2884 expand_string_forcedfail = FALSE;
2885 expand_string_message = US"";
2892 /* \ escapes the next character, which must exist, or else
2893 the expansion fails. There's a special escape, \N, which causes
2894 copying of the subject verbatim up to the next \N. Otherwise,
2895 the escapes are the standard set. */
2901 expand_string_message = US"\\ at end of string";
2908 for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2909 yield = string_cat(yield, &size, &ptr, t, s - t);
2910 if (*s != 0) s += 2;
2916 ch[0] = string_interpret_escape(&s);
2918 yield = string_cat(yield, &size, &ptr, ch, 1);
2924 /* Anything other than $ is just copied verbatim, unless we are
2925 looking for a terminating } character. */
2927 if (ket_ends && *s == '}') break;
2931 yield = string_cat(yield, &size, &ptr, s++, 1);
2935 /* No { after the $ - must be a plain name or a number for string
2936 match variable. There has to be a fudge for variables that are the
2937 names of header fields preceded by "$header_" because header field
2938 names can contain any printing characters except space and colon.
2939 For those that don't like typing this much, "$h_" is a synonym for
2940 "$header_". A non-existent header yields a NULL value; nothing is
2943 if (isalpha((*(++s))))
2948 s = read_name(name, sizeof(name), s, US"_");
2950 /* If this is the first thing to be expanded, release the pre-allocated
2953 if (ptr == 0 && yield != NULL)
2962 if (Ustrncmp(name, "h_", 2) == 0 ||
2963 Ustrncmp(name, "rh_", 3) == 0 ||
2964 Ustrncmp(name, "bh_", 3) == 0 ||
2965 Ustrncmp(name, "header_", 7) == 0 ||
2966 Ustrncmp(name, "rheader_", 8) == 0 ||
2967 Ustrncmp(name, "bheader_", 8) == 0)
2969 BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2970 uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2971 s = read_header_name(name, sizeof(name), s);
2972 value = find_header(name, FALSE, &newsize, want_raw, charset);
2974 /* If we didn't find the header, and the header contains a closing brace
2975 characters, this may be a user error where the terminating colon
2976 has been omitted. Set a flag to adjust the error message in this case.
2977 But there is no error here - nothing gets inserted. */
2981 if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2990 value = find_variable(name, FALSE, skipping, &newsize);
2993 expand_string_message =
2994 string_sprintf("unknown variable name \"%s\"", name);
2995 check_variable_error_message(name);
3000 /* If the data is known to be in a new buffer, newsize will be set to the
3001 size of that buffer. If this is the first thing in an expansion string,
3002 yield will be NULL; just point it at the new store instead of copying. Many
3003 expansion strings contain just one reference, so this is a useful
3004 optimization, especially for humungous headers. */
3006 len = Ustrlen(value);
3007 if (yield == NULL && newsize != 0)
3013 else yield = string_cat(yield, &size, &ptr, value, len);
3021 s = read_number(&n, s);
3022 if (n >= 0 && n <= expand_nmax)
3023 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3028 /* Otherwise, if there's no '{' after $ it's an error. */
3032 expand_string_message = US"$ not followed by letter, digit, or {";
3036 /* After { there can be various things, but they all start with
3037 an initial word, except for a number for a string match variable. */
3039 if (isdigit((*(++s))))
3042 s = read_number(&n, s);
3045 expand_string_message = US"} expected after number";
3048 if (n >= 0 && n <= expand_nmax)
3049 yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3056 expand_string_message = US"letter or digit expected after ${";
3060 /* Allow "-" in names to cater for substrings with negative
3061 arguments. Since we are checking for known names after { this is
3064 s = read_name(name, sizeof(name), s, US"_-");
3065 item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3069 /* Handle conditionals - preserve the values of the numerical expansion
3070 variables in case they get changed by a regular expression match in the
3071 condition. If not, they retain their external settings. At the end
3072 of this "if" section, they get restored to their previous values. */
3078 int save_expand_nmax =
3079 save_expand_strings(save_expand_nstring, save_expand_nlength);
3081 while (isspace(*s)) s++;
3082 next_s = eval_condition(s, skipping? NULL : &cond);
3083 if (next_s == NULL) goto EXPAND_FAILED; /* message already set */
3086 debug_printf("condition: %.*s\n result: %s\n", (int)(next_s - s), s,
3087 cond? "true" : "false");
3091 /* The handling of "yes" and "no" result strings is now in a separate
3092 function that is also used by ${lookup} and ${extract} and ${run}. */
3094 switch(process_yesno(
3095 skipping, /* were previously skipping */
3096 cond, /* success/failure indicator */
3097 lookup_value, /* value to reset for string2 */
3098 &s, /* input pointer */
3099 &yield, /* output pointer */
3100 &size, /* output size */
3101 &ptr, /* output current point */
3102 US"if")) /* condition type */
3104 case 1: goto EXPAND_FAILED; /* when all is well, the */
3105 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3108 /* Restore external setting of expansion variables for continuation
3111 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3112 save_expand_nlength);
3116 /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3117 expanding an internal string that isn't actually going to be used. All we
3118 need to do is check the syntax, so don't do a lookup at all. Preserve the
3119 values of the numerical expansion variables in case they get changed by a
3120 partial lookup. If not, they retain their external settings. At the end
3121 of this "lookup" section, they get restored to their previous values. */
3125 int stype, partial, affixlen, starflags;
3126 int expand_setup = 0;
3128 uschar *key, *filename, *affix;
3129 uschar *save_lookup_value = lookup_value;
3130 int save_expand_nmax =
3131 save_expand_strings(save_expand_nstring, save_expand_nlength);
3133 if ((expand_forbid & RDO_LOOKUP) != 0)
3135 expand_string_message = US"lookup expansions are not permitted";
3139 /* Get the key we are to look up for single-key+file style lookups.
3140 Otherwise set the key NULL pro-tem. */
3142 while (isspace(*s)) s++;
3145 key = expand_string_internal(s+1, TRUE, &s, skipping);
3146 if (key == NULL) goto EXPAND_FAILED;
3147 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3148 while (isspace(*s)) s++;
3152 /* Find out the type of database */
3156 expand_string_message = US"missing lookup type";
3160 /* The type is a string that may contain special characters of various
3161 kinds. Allow everything except space or { to appear; the actual content
3162 is checked by search_findtype_partial. */
3164 while (*s != 0 && *s != '{' && !isspace(*s))
3166 if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3170 while (isspace(*s)) s++;
3172 /* Now check for the individual search type and any partial or default
3173 options. Only those types that are actually in the binary are valid. */
3175 stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3179 expand_string_message = search_error_message;
3183 /* Check that a key was provided for those lookup types that need it,
3184 and was not supplied for those that use the query style. */
3186 if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3190 expand_string_message = string_sprintf("missing {key} for single-"
3191 "key \"%s\" lookup", name);
3199 expand_string_message = string_sprintf("a single key was given for "
3200 "lookup type \"%s\", which is not a single-key lookup type", name);
3205 /* Get the next string in brackets and expand it. It is the file name for
3206 single-key+file lookups, and the whole query otherwise. In the case of
3207 queries that also require a file name (e.g. sqlite), the file name comes
3210 if (*s != '{') goto EXPAND_FAILED_CURLY;
3211 filename = expand_string_internal(s+1, TRUE, &s, skipping);
3212 if (filename == NULL) goto EXPAND_FAILED;
3213 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3214 while (isspace(*s)) s++;
3216 /* If this isn't a single-key+file lookup, re-arrange the variables
3217 to be appropriate for the search_ functions. For query-style lookups,
3218 there is just a "key", and no file name. For the special query-style +
3219 file types, the query (i.e. "key") starts with a file name. */
3223 while (isspace(*filename)) filename++;
3226 if (mac_islookup(stype, lookup_querystyle))
3232 if (*filename != '/')
3234 expand_string_message = string_sprintf(
3235 "absolute file name expected for \"%s\" lookup", name);
3238 while (*key != 0 && !isspace(*key)) key++;
3239 if (*key != 0) *key++ = 0;
3243 /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3244 the entry was not found. Note that there is no search_close() function.
3245 Files are left open in case of re-use. At suitable places in higher logic,
3246 search_tidyup() is called to tidy all open files. This can save opening
3247 the same file several times. However, files may also get closed when
3248 others are opened, if too many are open at once. The rule is that a
3249 handle should not be used after a second search_open().
3251 Request that a partial search sets up $1 and maybe $2 by passing
3252 expand_setup containing zero. If its value changes, reset expand_nmax,
3253 since new variables will have been set. Note that at the end of this
3254 "lookup" section, the old numeric variables are restored. */
3257 lookup_value = NULL;
3260 void *handle = search_open(filename, stype, 0, NULL, NULL);
3263 expand_string_message = search_error_message;
3266 lookup_value = search_find(handle, filename, key, partial, affix,
3267 affixlen, starflags, &expand_setup);
3268 if (search_find_defer)
3270 expand_string_message =
3271 string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3272 search_error_message);
3275 if (expand_setup > 0) expand_nmax = expand_setup;
3278 /* The handling of "yes" and "no" result strings is now in a separate
3279 function that is also used by ${if} and ${extract}. */
3281 switch(process_yesno(
3282 skipping, /* were previously skipping */
3283 lookup_value != NULL, /* success/failure indicator */
3284 save_lookup_value, /* value to reset for string2 */
3285 &s, /* input pointer */
3286 &yield, /* output pointer */
3287 &size, /* output size */
3288 &ptr, /* output current point */
3289 US"lookup")) /* condition type */
3291 case 1: goto EXPAND_FAILED; /* when all is well, the */
3292 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3295 /* Restore external setting of expansion variables for carrying on
3296 at this level, and continue. */
3298 restore_expand_strings(save_expand_nmax, save_expand_nstring,
3299 save_expand_nlength);
3303 /* If Perl support is configured, handle calling embedded perl subroutines,
3304 unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3305 or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3306 arguments (defined below). */
3308 #define EXIM_PERL_MAX_ARGS 8
3312 expand_string_message = US"\"${perl\" encountered, but this facility "
3313 "is not included in this binary";
3316 #else /* EXIM_PERL */
3318 uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3321 if ((expand_forbid & RDO_PERL) != 0)
3323 expand_string_message = US"Perl calls are not permitted";
3327 switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3330 case 1: goto EXPAND_FAILED_CURLY;
3332 case 3: goto EXPAND_FAILED;
3335 /* If skipping, we don't actually do anything */
3337 if (skipping) continue;
3339 /* Start the interpreter if necessary */
3341 if (!opt_perl_started)
3344 if (opt_perl_startup == NULL)
3346 expand_string_message = US"A setting of perl_startup is needed when "
3347 "using the Perl interpreter";
3350 DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3351 initerror = init_perl(opt_perl_startup);
3352 if (initerror != NULL)
3354 expand_string_message =
3355 string_sprintf("error in perl_startup code: %s\n", initerror);
3358 opt_perl_started = TRUE;
3361 /* Call the function */
3363 sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3364 new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3365 sub_arg[0], sub_arg + 1);
3367 /* NULL yield indicates failure; if the message pointer has been set to
3368 NULL, the yield was undef, indicating a forced failure. Otherwise the
3369 message will indicate some kind of Perl error. */
3371 if (new_yield == NULL)
3373 if (expand_string_message == NULL)
3375 expand_string_message =
3376 string_sprintf("Perl subroutine \"%s\" returned undef to force "
3377 "failure", sub_arg[0]);
3378 expand_string_forcedfail = TRUE;
3383 /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3384 set during a callback from Perl. */
3386 expand_string_forcedfail = FALSE;
3390 #endif /* EXIM_PERL */
3392 /* Transform email address to "prvs" scheme to use
3393 as BATV-signed return path */
3400 switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3402 case 1: goto EXPAND_FAILED_CURLY;
3404 case 3: goto EXPAND_FAILED;
3407 /* If skipping, we don't actually do anything */
3408 if (skipping) continue;
3410 /* sub_arg[0] is the address */
3411 domain = Ustrrchr(sub_arg[0],'@');
3412 if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3414 expand_string_message = US"prvs first argument must be a qualified email address";
3418 /* Calculate the hash. The second argument must be a single-digit
3419 key number, or unset. */
3421 if (sub_arg[2] != NULL &&
3422 (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3424 expand_string_message = US"prvs second argument must be a single digit";
3428 p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3431 expand_string_message = US"prvs hmac-sha1 conversion failed";
3435 /* Now separate the domain from the local part */
3438 yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3439 string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3440 string_cat(yield,&size,&ptr,US"/",1);
3441 string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3442 string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3443 string_cat(yield,&size,&ptr,p,6);
3444 string_cat(yield,&size,&ptr,US"@",1);
3445 string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3450 /* Check a prvs-encoded address for validity */
3452 case EITEM_PRVSCHECK:
3455 int mysize = 0, myptr = 0;
3459 /* TF: Ugliness: We want to expand parameter 1 first, then set
3460 up expansion variables that are used in the expansion of
3461 parameter 2. So we clone the string for the first
3462 expansion, where we only expand parameter 1.
3464 PH: Actually, that isn't necessary. The read_subs() function is
3465 designed to work this way for the ${if and ${lookup expansions. I've
3469 /* Reset expansion variables */
3470 prvscheck_result = NULL;
3471 prvscheck_address = NULL;
3472 prvscheck_keynum = NULL;
3474 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3476 case 1: goto EXPAND_FAILED_CURLY;
3478 case 3: goto EXPAND_FAILED;
3481 re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3484 if (regex_match_and_setup(re,sub_arg[0],0,-1))
3486 uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3487 uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3488 uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3489 uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3490 uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3492 DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3493 DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3494 DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3495 DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3496 DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3498 /* Set up expansion variables */
3499 prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3500 string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3501 string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3502 prvscheck_address[myptr] = '\0';
3503 prvscheck_keynum = string_copy(key_num);
3505 /* Now expand the second argument */
3506 switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3508 case 1: goto EXPAND_FAILED_CURLY;
3510 case 3: goto EXPAND_FAILED;
3513 /* Now we have the key and can check the address. */
3515 p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3520 expand_string_message = US"hmac-sha1 conversion failed";
3524 DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3525 DEBUG(D_expand) debug_printf("prvscheck: own hash is %s\n", p);
3527 if (Ustrcmp(p,hash) == 0)
3529 /* Success, valid BATV address. Now check the expiry date. */
3530 uschar *now = prvs_daystamp(0);
3531 unsigned int inow = 0,iexpire = 1;
3533 (void)sscanf(CS now,"%u",&inow);
3534 (void)sscanf(CS daystamp,"%u",&iexpire);
3536 /* When "iexpire" is < 7, a "flip" has occured.
3537 Adjust "inow" accordingly. */
3538 if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3542 prvscheck_result = US"1";
3543 DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3547 prvscheck_result = NULL;
3548 DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3553 prvscheck_result = NULL;
3554 DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3557 /* Now expand the final argument. We leave this till now so that
3558 it can include $prvscheck_result. */
3560 switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3562 case 1: goto EXPAND_FAILED_CURLY;
3564 case 3: goto EXPAND_FAILED;
3567 if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3568 yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3570 yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3572 /* Reset the "internal" variables afterwards, because they are in
3573 dynamic store that will be reclaimed if the expansion succeeded. */
3575 prvscheck_address = NULL;
3576 prvscheck_keynum = NULL;
3580 /* Does not look like a prvs encoded address, return the empty string.
3581 We need to make sure all subs are expanded first, so as to skip over
3584 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3586 case 1: goto EXPAND_FAILED_CURLY;
3588 case 3: goto EXPAND_FAILED;
3595 /* Handle "readfile" to insert an entire file */
3597 case EITEM_READFILE:
3602 if ((expand_forbid & RDO_READFILE) != 0)
3604 expand_string_message = US"file insertions are not permitted";
3608 switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3610 case 1: goto EXPAND_FAILED_CURLY;
3612 case 3: goto EXPAND_FAILED;
3615 /* If skipping, we don't actually do anything */
3617 if (skipping) continue;
3619 /* Open the file and read it */
3621 f = Ufopen(sub_arg[0], "rb");
3624 expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3628 yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3633 /* Handle "readsocket" to insert data from a Unix domain socket */
3635 case EITEM_READSOCK:
3641 struct sockaddr_un sockun; /* don't call this "sun" ! */
3645 if ((expand_forbid & RDO_READSOCK) != 0)
3647 expand_string_message = US"socket insertions are not permitted";
3651 /* Read up to 4 arguments, but don't do the end of item check afterwards,
3652 because there may be a string for expansion on failure. */
3654 switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3656 case 1: goto EXPAND_FAILED_CURLY;
3657 case 2: /* Won't occur: no end check */
3658 case 3: goto EXPAND_FAILED;
3661 /* Sort out timeout, if given */
3663 if (sub_arg[2] != NULL)
3665 timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3668 expand_string_message = string_sprintf("bad time value %s",
3673 else sub_arg[3] = NULL; /* No eol if no timeout */
3675 /* If skipping, we don't actually do anything. Otherwise, arrange to
3676 connect to either an IP or a Unix socket. */
3680 /* Handle an IP (internet) domain */
3682 if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
3684 BOOL connected = FALSE;
3688 uschar *server_name = sub_arg[0] + 5;
3689 uschar *port_name = Ustrrchr(server_name, ':');
3691 /* Sort out the port */
3693 if (port_name == NULL)
3695 expand_string_message =
3696 string_sprintf("missing port for readsocket %s", sub_arg[0]);
3699 *port_name++ = 0; /* Terminate server name */
3701 if (isdigit(*port_name))
3704 port = Ustrtol(port_name, &end, 0);
3705 if (end != port_name + Ustrlen(port_name))
3707 expand_string_message =
3708 string_sprintf("invalid port number %s", port_name);
3714 struct servent *service_info = getservbyname(CS port_name, "tcp");
3715 if (service_info == NULL)
3717 expand_string_message = string_sprintf("unknown port \"%s\"",
3721 port = ntohs(service_info->s_port);
3724 /* Sort out the server. */
3727 shost.address = NULL;
3731 namelen = Ustrlen(server_name);
3733 /* Anything enclosed in [] must be an IP address. */
3735 if (server_name[0] == '[' &&
3736 server_name[namelen - 1] == ']')
3738 server_name[namelen - 1] = 0;
3740 if (string_is_ip_address(server_name, NULL) == 0)
3742 expand_string_message =
3743 string_sprintf("malformed IP address \"%s\"", server_name);
3746 shost.name = shost.address = server_name;
3749 /* Otherwise check for an unadorned IP address */
3751 else if (string_is_ip_address(server_name, NULL) != 0)
3752 shost.name = shost.address = server_name;
3754 /* Otherwise lookup IP address(es) from the name */
3758 shost.name = server_name;
3759 if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
3760 FALSE) != HOST_FOUND)
3762 expand_string_message =
3763 string_sprintf("no IP address found for host %s", shost.name);
3768 /* Try to connect to the server - test each IP till one works */
3770 for (h = &shost; h != NULL; h = h->next)
3772 int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
3773 if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
3775 expand_string_message = string_sprintf("failed to create socket: "
3776 "%s", strerror(errno));
3780 if (ip_connect(fd, af, h->address, port, timeout) == 0)
3789 expand_string_message = string_sprintf("failed to connect to "
3790 "socket %s: couldn't connect to any host", sub_arg[0],
3796 /* Handle a Unix domain socket */
3800 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3802 expand_string_message = string_sprintf("failed to create socket: %s",
3807 sockun.sun_family = AF_UNIX;
3808 sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3810 if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3812 expand_string_message = string_sprintf("failed to connect to socket "
3813 "%s: %s", sub_arg[0], strerror(errno));
3818 DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3820 /* Write the request string, if not empty */
3822 if (sub_arg[1][0] != 0)
3824 int len = Ustrlen(sub_arg[1]);
3825 DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3827 if (write(fd, sub_arg[1], len) != len)
3829 expand_string_message = string_sprintf("request write to socket "
3830 "failed: %s", strerror(errno));
3835 /* Now we need to read from the socket, under a timeout. The function
3836 that reads a file can be used. */
3838 f = fdopen(fd, "rb");
3839 sigalrm_seen = FALSE;
3841 yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3845 /* After a timeout, we restore the pointer in the result, that is,
3846 make sure we add nothing from the socket. */
3851 expand_string_message = US "socket read timed out";
3856 /* The whole thing has worked (or we were skipping). If there is a
3857 failure string following, we need to skip it. */
3861 if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3863 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3864 while (isspace(*s)) s++;
3866 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3869 /* Come here on failure to create socket, connect socket, write to the
3870 socket, or timeout on reading. If another substring follows, expand and
3871 use it. Otherwise, those conditions give expand errors. */
3874 if (*s != '{') goto EXPAND_FAILED;
3875 DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3876 arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3877 if (arg == NULL) goto EXPAND_FAILED;
3878 yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3879 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3880 while (isspace(*s)) s++;
3881 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3885 /* Handle "run" to execute a program. */
3897 if ((expand_forbid & RDO_RUN) != 0)
3899 expand_string_message = US"running a command is not permitted";
3903 while (isspace(*s)) s++;
3904 if (*s != '{') goto EXPAND_FAILED_CURLY;
3905 arg = expand_string_internal(s+1, TRUE, &s, skipping);
3906 if (arg == NULL) goto EXPAND_FAILED;
3907 while (isspace(*s)) s++;
3908 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3910 if (skipping) /* Just pretend it worked when we're skipping */
3916 if (!transport_set_up_command(&argv, /* anchor for arg list */
3917 arg, /* raw command */
3918 FALSE, /* don't expand the arguments */
3919 0, /* not relevant when... */
3920 NULL, /* no transporting address */
3921 US"${run} expansion", /* for error messages */
3922 &expand_string_message)) /* where to put error message */
3927 /* Create the child process, making it a group leader. */
3929 pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3933 expand_string_message =
3934 string_sprintf("couldn't create child process: %s", strerror(errno));
3938 /* Nothing is written to the standard input. */
3942 /* Wait for the process to finish, applying the timeout, and inspect its
3943 return code for serious disasters. Simple non-zero returns are passed on.
3946 if ((runrc = child_close(pid, 60)) < 0)
3950 expand_string_message = string_sprintf("command timed out");
3951 killpg(pid, SIGKILL); /* Kill the whole process group */
3954 else if (runrc == -257)
3955 expand_string_message = string_sprintf("wait() failed: %s",
3959 expand_string_message = string_sprintf("command killed by signal %d",
3965 /* Read the pipe to get the command's output into $value (which is kept
3966 in lookup_value). */
3968 f = fdopen(fd_out, "rb");
3969 lookup_value = NULL;
3970 lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3974 /* Process the yes/no strings; $value may be useful in both cases */
3976 switch(process_yesno(
3977 skipping, /* were previously skipping */
3978 runrc == 0, /* success/failure indicator */
3979 lookup_value, /* value to reset for string2 */
3980 &s, /* input pointer */
3981 &yield, /* output pointer */
3982 &size, /* output size */
3983 &ptr, /* output current point */
3984 US"run")) /* condition type */
3986 case 1: goto EXPAND_FAILED; /* when all is well, the */
3987 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
3993 /* Handle character translation for "tr" */
4001 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4003 case 1: goto EXPAND_FAILED_CURLY;
4005 case 3: goto EXPAND_FAILED;
4008 yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4009 o2m = Ustrlen(sub[2]) - 1;
4011 if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4013 uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4017 yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4024 /* Handle "hash", "length", "nhash", and "substr" when they are given with
4025 expanded arguments. */
4035 int val[2] = { 0, -1 };
4038 /* "length" takes only 2 arguments whereas the others take 2 or 3.
4039 Ensure that sub[2] is set in the ${length case. */
4042 switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4045 case 1: goto EXPAND_FAILED_CURLY;
4047 case 3: goto EXPAND_FAILED;
4050 /* Juggle the arguments if there are only two of them: always move the
4051 string to the last position and make ${length{n}{str}} equivalent to
4052 ${substr{0}{n}{str}}. See the defaults for val[] above. */
4058 if (item_type == EITEM_LENGTH)
4065 for (i = 0; i < 2; i++)
4067 if (sub[i] == NULL) continue;
4068 val[i] = (int)Ustrtol(sub[i], &ret, 10);
4069 if (*ret != 0 || (i != 0 && val[i] < 0))
4071 expand_string_message = string_sprintf("\"%s\" is not a%s number "
4072 "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4078 (item_type == EITEM_HASH)?
4079 compute_hash(sub[2], val[0], val[1], &len) :
4080 (item_type == EITEM_NHASH)?
4081 compute_nhash(sub[2], val[0], val[1], &len) :
4082 extract_substr(sub[2], val[0], val[1], &len);
4084 if (ret == NULL) goto EXPAND_FAILED;
4085 yield = string_cat(yield, &size, &ptr, ret, len);
4089 /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4090 This code originally contributed by Steve Haslam. It currently supports
4091 the use of MD5 and SHA-1 hashes.
4093 We need some workspace that is large enough to handle all the supported
4094 hash types. Use macros to set the sizes rather than be too elaborate. */
4096 #define MAX_HASHLEN 20
4097 #define MAX_HASHBLOCKLEN 64
4106 int hashlen; /* Number of octets for the hash algorithm's output */
4107 int hashblocklen; /* Number of octets the hash algorithm processes */
4109 unsigned int keylen;
4111 uschar keyhash[MAX_HASHLEN];
4112 uschar innerhash[MAX_HASHLEN];
4113 uschar finalhash[MAX_HASHLEN];
4114 uschar finalhash_hex[2*MAX_HASHLEN];
4115 uschar innerkey[MAX_HASHBLOCKLEN];
4116 uschar outerkey[MAX_HASHBLOCKLEN];
4118 switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4120 case 1: goto EXPAND_FAILED_CURLY;
4122 case 3: goto EXPAND_FAILED;
4125 if (Ustrcmp(sub[0], "md5") == 0)
4128 use_base = &md5_base;
4132 else if (Ustrcmp(sub[0], "sha1") == 0)
4135 use_base = &sha1_base;
4141 expand_string_message =
4142 string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4147 keylen = Ustrlen(keyptr);
4149 /* If the key is longer than the hash block length, then hash the key
4152 if (keylen > hashblocklen)
4154 chash_start(type, use_base);
4155 chash_end(type, use_base, keyptr, keylen, keyhash);
4160 /* Now make the inner and outer key values */
4162 memset(innerkey, 0x36, hashblocklen);
4163 memset(outerkey, 0x5c, hashblocklen);
4165 for (i = 0; i < keylen; i++)
4167 innerkey[i] ^= keyptr[i];
4168 outerkey[i] ^= keyptr[i];
4171 /* Now do the hashes */
4173 chash_start(type, use_base);
4174 chash_mid(type, use_base, innerkey);
4175 chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4177 chash_start(type, use_base);
4178 chash_mid(type, use_base, outerkey);
4179 chash_end(type, use_base, innerhash, hashlen, finalhash);
4181 /* Encode the final hash as a hex string */
4184 for (i = 0; i < hashlen; i++)
4186 *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4187 *p++ = hex_digits[finalhash[i] & 0x0f];
4190 DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4191 (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4193 yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4198 /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4199 We have to save the numerical variables and restore them afterwards. */
4204 int moffset, moffsetextra, slen;
4207 const uschar *rerror;
4210 int save_expand_nmax =
4211 save_expand_strings(save_expand_nstring, save_expand_nlength);
4213 switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4215 case 1: goto EXPAND_FAILED_CURLY;
4217 case 3: goto EXPAND_FAILED;
4220 /* Compile the regular expression */
4222 re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4227 expand_string_message = string_sprintf("regular expression error in "
4228 "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4232 /* Now run a loop to do the substitutions as often as necessary. It ends
4233 when there are no more matches. Take care over matches of the null string;
4234 do the same thing as Perl does. */
4237 slen = Ustrlen(sub[0]);
4238 moffset = moffsetextra = 0;
4243 int ovector[3*(EXPAND_MAXN+1)];
4244 int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4245 PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4249 /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4250 is not necessarily the end. We want to repeat the match from one
4251 character further along, but leaving the basic offset the same (for
4252 copying below). We can't be at the end of the string - that was checked
4253 before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4254 finished; copy the remaining string and end the loop. */
4264 yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4268 /* Match - set up for expanding the replacement. */
4270 if (n == 0) n = EXPAND_MAXN + 1;
4272 for (nn = 0; nn < n*2; nn += 2)
4274 expand_nstring[expand_nmax] = subject + ovector[nn];
4275 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4279 /* Copy the characters before the match, plus the expanded insertion. */
4281 yield = string_cat(yield, &size, &ptr, subject + moffset,
4282 ovector[0] - moffset);
4283 insert = expand_string(sub[2]);
4284 if (insert == NULL) goto EXPAND_FAILED;
4285 yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4287 moffset = ovector[1];
4291 /* If we have matched an empty string, first check to see if we are at
4292 the end of the subject. If so, the loop is over. Otherwise, mimic
4293 what Perl's /g options does. This turns out to be rather cunning. First
4294 we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4295 string at the same point. If this fails (picked up above) we advance to
4296 the next character. */
4298 if (ovector[0] == ovector[1])
4300 if (ovector[0] == slen) break;
4301 emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4305 /* All done - restore numerical variables. */
4307 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4308 save_expand_nlength);
4312 /* Handle keyed and numbered substring extraction. If the first argument
4313 consists entirely of digits, then a numerical extraction is assumed. */
4319 int field_number = 1;
4320 BOOL field_number_set = FALSE;
4321 uschar *save_lookup_value = lookup_value;
4323 int save_expand_nmax =
4324 save_expand_strings(save_expand_nstring, save_expand_nlength);
4326 /* Read the arguments */
4328 for (i = 0; i < j; i++)
4330 while (isspace(*s)) s++;
4333 sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4334 if (sub[i] == NULL) goto EXPAND_FAILED;
4335 if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4337 /* After removal of leading and trailing white space, the first
4338 argument must not be empty; if it consists entirely of digits
4339 (optionally preceded by a minus sign), this is a numerical
4340 extraction, and we expect 3 arguments. */
4348 while (isspace(*p)) p++;
4352 while (len > 0 && isspace(p[len-1])) len--;
4357 expand_string_message = US"first argument of \"extract\" must "
4367 while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4371 j = 3; /* Need 3 args */
4372 field_number_set = TRUE;
4376 else goto EXPAND_FAILED_CURLY;
4379 /* Extract either the numbered or the keyed substring into $value. If
4380 skipping, just pretend the extraction failed. */
4382 lookup_value = skipping? NULL : field_number_set?
4383 expand_gettokened(field_number, sub[1], sub[2]) :
4384 expand_getkeyed(sub[0], sub[1]);
4386 /* If no string follows, $value gets substituted; otherwise there can
4387 be yes/no strings, as for lookup or if. */
4389 switch(process_yesno(
4390 skipping, /* were previously skipping */
4391 lookup_value != NULL, /* success/failure indicator */
4392 save_lookup_value, /* value to reset for string2 */
4393 &s, /* input pointer */
4394 &yield, /* output pointer */
4395 &size, /* output size */
4396 &ptr, /* output current point */
4397 US"extract")) /* condition type */
4399 case 1: goto EXPAND_FAILED; /* when all is well, the */
4400 case 2: goto EXPAND_FAILED_CURLY; /* returned value is 0 */
4403 /* All done - restore numerical variables. */
4405 restore_expand_strings(save_expand_nmax, save_expand_nstring,
4406 save_expand_nlength);
4412 /* If ${dlfunc support is configured, handle calling dynamically-loaded
4413 functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4414 or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4415 a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4417 #define EXPAND_DLFUNC_MAX_ARGS 8
4420 #ifndef EXPAND_DLFUNC
4421 expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4422 "is not included in this binary";
4425 #else /* EXPAND_DLFUNC */
4428 exim_dlfunc_t *func;
4431 uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4433 if ((expand_forbid & RDO_DLFUNC) != 0)
4435 expand_string_message =
4436 US"dynamically-loaded functions are not permitted";
4440 switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4443 case 1: goto EXPAND_FAILED_CURLY;
4445 case 3: goto EXPAND_FAILED;
4448 /* If skipping, we don't actually do anything */
4450 if (skipping) continue;
4452 /* Look up the dynamically loaded object handle in the tree. If it isn't
4453 found, dlopen() the file and put the handle in the tree for next time. */
4455 t = tree_search(dlobj_anchor, argv[0]);
4458 void *handle = dlopen(CS argv[0], RTLD_LAZY);
4461 expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4462 argv[0], dlerror());
4463 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4466 t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4467 Ustrcpy(t->name, argv[0]);
4468 t->data.ptr = handle;
4469 (void)tree_insertnode(&dlobj_anchor, t);
4472 /* Having obtained the dynamically loaded object handle, look up the
4473 function pointer. */
4475 func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4478 expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4479 "%s", argv[1], argv[0], dlerror());
4480 log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4484 /* Call the function and work out what to do with the result. If it
4485 returns OK, we have a replacement string; if it returns DEFER then
4486 expansion has failed in a non-forced manner; if it returns FAIL then
4487 failure was forced; if it returns ERROR or any other value there's a
4488 problem, so panic slightly. */
4491 for (argc = 0; argv[argc] != NULL; argc++);
4492 status = func(&result, argc - 2, &argv[2]);
4495 if (result == NULL) result = US"";
4496 yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4501 expand_string_message = result == NULL ? US"(no message)" : result;
4502 if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4503 else if(status != FAIL)
4504 log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4505 argv[0], argv[1], status, expand_string_message);
4509 #endif /* EXPAND_DLFUNC */
4512 /* Control reaches here if the name is not recognized as one of the more
4513 complicated expansion items. Check for the "operator" syntax (name terminated
4514 by a colon). Some of the operators have arguments, separated by _ from the
4521 uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4522 if (sub == NULL) goto EXPAND_FAILED;
4525 /* Owing to an historical mis-design, an underscore may be part of the
4526 operator name, or it may introduce arguments. We therefore first scan the
4527 table of names that contain underscores. If there is no match, we cut off
4528 the arguments and then scan the main table. */
4530 c = chop_match(name, op_table_underscore,
4531 sizeof(op_table_underscore)/sizeof(uschar *));
4535 arg = Ustrchr(name, '_');
4536 if (arg != NULL) *arg = 0;
4537 c = chop_match(name, op_table_main,
4538 sizeof(op_table_main)/sizeof(uschar *));
4539 if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4540 if (arg != NULL) *arg++ = '_'; /* Put back for error messages */
4543 /* If we are skipping, we don't need to perform the operation at all.
4544 This matters for operations like "mask", because the data may not be
4545 in the correct format when skipping. For example, the expression may test
4546 for the existence of $sender_host_address before trying to mask it. For
4547 other operations, doing them may not fail, but it is a waste of time. */
4549 if (skipping && c >= 0) continue;
4551 /* Otherwise, switch on the operator type */
4558 unsigned long int n = Ustrtoul(sub, &t, 10);
4561 expand_string_message = string_sprintf("argument for base62 "
4562 "operator is \"%s\", which is not a decimal number", sub);
4565 t = string_base62(n);
4566 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4570 /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
4576 unsigned long int n = 0;
4579 uschar *t = Ustrchr(base62_chars, *tt++);
4582 expand_string_message = string_sprintf("argument for base62d "
4583 "operator is \"%s\", which is not a base %d number", sub,
4587 n = n * BASE_62 + (t - base62_chars);
4589 (void)sprintf(CS buf, "%ld", n);
4590 yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4596 uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4597 if (expanded == NULL)
4599 expand_string_message =
4600 string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4601 expand_string_message);
4604 yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4611 uschar *t = sub - 1;
4612 while (*(++t) != 0) { *t = tolower(*t); count++; }
4613 yield = string_cat(yield, &size, &ptr, sub, count);
4620 uschar *t = sub - 1;
4621 while (*(++t) != 0) { *t = toupper(*t); count++; }
4622 yield = string_cat(yield, &size, &ptr, sub, count);
4633 md5_end(&base, sub, Ustrlen(sub), digest);
4634 for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4635 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4646 sha1_end(&base, sub, Ustrlen(sub), digest);
4647 for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4648 yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4652 /* Convert hex encoding to base64 encoding */
4662 for (enc = sub; *enc != 0; enc++)
4664 if (!isxdigit(*enc))
4666 expand_string_message = string_sprintf("\"%s\" is not a hex "
4675 expand_string_message = string_sprintf("\"%s\" contains an odd "
4676 "number of characters", sub);
4680 while ((c = *in++) != 0)
4682 if (isdigit(c)) c -= '0';
4683 else c = toupper(c) - 'A' + 10;
4695 enc = auth_b64encode(sub, out - sub);
4696 yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4700 /* mask applies a mask to an IP address; for example the result of
4701 ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4708 int mask, maskoffset;
4709 int type = string_is_ip_address(sub, &maskoffset);
4714 expand_string_message = string_sprintf("\"%s\" is not an IP address",
4719 if (maskoffset == 0)
4721 expand_string_message = string_sprintf("missing mask value in \"%s\"",
4726 mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4728 if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4730 expand_string_message = string_sprintf("mask value too big in \"%s\"",
4735 /* Convert the address to binary integer(s) and apply the mask */
4737 sub[maskoffset] = 0;
4738 count = host_aton(sub, binary);
4739 host_mask(count, binary, mask);
4741 /* Convert to masked textual format and add to output. */
4743 yield = string_cat(yield, &size, &ptr, buffer,
4744 host_nmtoa(count, binary, mask, buffer, '.'));
4749 case EOP_LOCAL_PART:
4753 int start, end, domain;
4754 uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4758 if (c != EOP_DOMAIN)
4760 if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4761 yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4763 else if (domain != 0)
4766 yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4772 /* quote puts a string in quotes if it is empty or contains anything
4773 other than alphamerics, underscore, dot, or hyphen.
4775 quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4776 be quoted in order to be a valid local part.
4778 In both cases, newlines and carriage returns are converted into \n and \r
4782 case EOP_QUOTE_LOCAL_PART:
4785 BOOL needs_quote = (*sub == 0); /* TRUE for empty string */
4786 uschar *t = sub - 1;
4790 while (!needs_quote && *(++t) != 0)
4791 needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4793 else /* EOP_QUOTE_LOCAL_PART */
4795 while (!needs_quote && *(++t) != 0)
4796 needs_quote = !isalnum(*t) &&
4797 strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4798 (*t != '.' || t == sub || t[1] == 0);
4803 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4808 yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4809 else if (*t == '\r')
4810 yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4813 if (*t == '\\' || *t == '"')
4814 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4815 yield = string_cat(yield, &size, &ptr, t, 1);
4818 yield = string_cat(yield, &size, &ptr, US"\"", 1);
4820 else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4824 /* quote_lookuptype does lookup-specific quoting */
4829 uschar *opt = Ustrchr(arg, '_');
4831 if (opt != NULL) *opt++ = 0;
4833 n = search_findtype(arg, Ustrlen(arg));
4836 expand_string_message = search_error_message;
4840 if (lookup_list[n].quote != NULL)
4841 sub = (lookup_list[n].quote)(sub, opt);
4842 else if (opt != NULL) sub = NULL;
4846 expand_string_message = string_sprintf(
4847 "\"%s\" unrecognized after \"${quote_%s\"",
4852 yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4856 /* rx quote sticks in \ before any non-alphameric character so that
4857 the insertion works in a regular expression. */
4861 uschar *t = sub - 1;
4865 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4866 yield = string_cat(yield, &size, &ptr, t, 1);
4871 /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4872 prescribed by the RFC, if there are characters that need to be encoded */
4876 uschar buffer[2048];
4877 uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4878 buffer, sizeof(buffer), FALSE);
4879 yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4883 /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4893 if (c > 255) c = '_';
4895 yield = string_cat(yield, &size, &ptr, buff, 1);
4900 /* escape turns all non-printing characters into escape sequences. */
4904 uschar *t = string_printing(sub);
4905 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4909 /* Handle numeric expression evaluation */
4914 uschar *save_sub = sub;
4915 uschar *error = NULL;
4916 int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4919 expand_string_message = string_sprintf("error in expression "
4920 "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4924 sprintf(CS var_buffer, "%d", n);
4925 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4929 /* Handle time period formating */
4933 int n = readconf_readtime(sub, 0, FALSE);
4936 expand_string_message = string_sprintf("string \"%s\" is not an "
4937 "Exim time interval in \"%s\" operator", sub, name);
4940 sprintf(CS var_buffer, "%d", n);
4941 yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4945 case EOP_TIME_INTERVAL:
4948 uschar *t = read_number(&n, sub);
4949 if (*t != 0) /* Not A Number*/
4951 expand_string_message = string_sprintf("string \"%s\" is not a "
4952 "positive number in \"%s\" operator", sub, name);
4955 t = readconf_printtime(n);
4956 yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4960 /* Convert string to base64 encoding */
4964 uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4965 yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4969 /* strlen returns the length of the string */
4974 (void)sprintf(CS buff, "%d", Ustrlen(sub));
4975 yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4979 /* length_n or l_n takes just the first n characters or the whole string,
4980 whichever is the shorter;
4982 substr_m_n, and s_m_n take n characters from offset m; negative m take
4983 from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4984 takes the rest, either to the right or to the left.
4986 hash_n or h_n makes a hash of length n from the string, yielding n
4987 characters from the set a-z; hash_n_m makes a hash of length n, but
4988 uses m characters from the set a-zA-Z0-9.
4990 nhash_n returns a single number between 0 and n-1 (in text form), while
4991 nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4992 between 0 and n-1 and the second between 0 and m-1. */
5012 expand_string_message = string_sprintf("missing values after %s",
5017 /* "length" has only one argument, effectively being synonymous with
5020 if (c == EOP_LENGTH || c == EOP_L)
5026 /* The others have one or two arguments; for "substr" the first may be
5027 negative. The second being negative means "not supplied". */
5032 if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5035 /* Read up to two numbers, separated by underscores */
5040 if (arg != ret && *arg == '_' && pn == &value1)
5044 if (arg[1] != 0) arg++;
5046 else if (!isdigit(*arg))
5048 expand_string_message =
5049 string_sprintf("non-digit after underscore in \"%s\"", name);
5052 else *pn = (*pn)*10 + *arg++ - '0';
5056 /* Perform the required operation */
5059 (c == EOP_HASH || c == EOP_H)?
5060 compute_hash(sub, value1, value2, &len) :
5061 (c == EOP_NHASH || c == EOP_NH)?
5062 compute_nhash(sub, value1, value2, &len) :
5063 extract_substr(sub, value1, value2, &len);
5065 if (ret == NULL) goto EXPAND_FAILED;
5066 yield = string_cat(yield, &size, &ptr, ret, len);
5076 uschar **modetable[3];
5081 if ((expand_forbid & RDO_EXISTS) != 0)
5083 expand_string_message = US"Use of the stat() expansion is not permitted";
5087 if (stat(CS sub, &st) < 0)
5089 expand_string_message = string_sprintf("stat(%s) failed: %s",
5090 sub, strerror(errno));
5094 switch (mode & S_IFMT)
5096 case S_IFIFO: smode[0] = 'p'; break;
5097 case S_IFCHR: smode[0] = 'c'; break;
5098 case S_IFDIR: smode[0] = 'd'; break;
5099 case S_IFBLK: smode[0] = 'b'; break;
5100 case S_IFREG: smode[0] = '-'; break;
5101 default: smode[0] = '?'; break;
5104 modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5105 modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5106 modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5108 for (i = 0; i < 3; i++)
5110 memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5115 s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5116 "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5117 (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5118 (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5119 (long)st.st_gid, st.st_size, (long)st.st_atime,
5120 (long)st.st_mtime, (long)st.st_ctime);
5121 yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5125 /* Unknown operator */
5128 expand_string_message =
5129 string_sprintf("unknown expansion operator \"%s\"", name);
5134 /* Handle a plain name. If this is the first thing in the expansion, release
5135 the pre-allocated buffer. If the result data is known to be in a new buffer,
5136 newsize will be set to the size of that buffer, and we can just point at that
5137 store instead of copying. Many expansion strings contain just one reference,
5138 so this is a useful optimization, especially for humungous headers
5139 ($message_headers). */
5151 value = find_variable(name, FALSE, skipping, &newsize);
5154 expand_string_message =
5155 string_sprintf("unknown variable in \"${%s}\"", name);
5156 check_variable_error_message(name);
5159 len = Ustrlen(value);
5160 if (yield == NULL && newsize != 0)
5166 else yield = string_cat(yield, &size, &ptr, value, len);
5170 /* Else there's something wrong */
5172 expand_string_message =
5173 string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5174 "in a variable reference)", name);
5178 /* If we hit the end of the string when ket_ends is set, there is a missing
5179 terminating brace. */
5181 if (ket_ends && *s == 0)
5183 expand_string_message = malformed_header?
5184 US"missing } at end of string - could be header name not terminated by colon"
5186 US"missing } at end of string";
5190 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5191 added to the string. If so, set up an empty string. Add a terminating zero. If
5192 left != NULL, return a pointer to the terminator. */
5194 if (yield == NULL) yield = store_get(1);
5196 if (left != NULL) *left = s;
5198 /* Any stacking store that was used above the final string is no longer needed.
5199 In many cases the final string will be the first one that was got and so there
5200 will be optimal store usage. */
5202 store_reset(yield + ptr + 1);
5205 debug_printf("expanding: %.*s\n result: %s\n", (int)(s - string), string,
5207 if (skipping) debug_printf("skipping: result is not used\n");
5211 /* This is the failure exit: easiest to program with a goto. We still need
5212 to update the pointer to the terminator, for cases of nested calls with "fail".
5215 EXPAND_FAILED_CURLY:
5216 expand_string_message = malformed_header?
5217 US"missing or misplaced { or } - could be header name not terminated by colon"
5219 US"missing or misplaced { or }";
5221 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5222 that is a bad idea, because expand_string_message is in dynamic store. */
5225 if (left != NULL) *left = s;
5228 debug_printf("failed to expand: %s\n", string);
5229 debug_printf(" error message: %s\n", expand_string_message);
5230 if (expand_string_forcedfail) debug_printf("failure was forced\n");
5236 /* This is the external function call. Do a quick check for any expansion
5237 metacharacters, and if there are none, just return the input string.
5239 Argument: the string to be expanded
5240 Returns: the expanded string, or NULL if expansion failed; if failure was
5241 due to a lookup deferring, search_find_defer will be TRUE
5245 expand_string(uschar *string)
5247 search_find_defer = FALSE;
5248 malformed_header = FALSE;
5249 return (Ustrpbrk(string, "$\\") == NULL)? string :
5250 expand_string_internal(string, FALSE, NULL, FALSE);
5255 /*************************************************
5257 *************************************************/
5259 /* Now and again we want to expand a string and be sure that the result is in a
5260 new bit of store. This function does that.
5262 Argument: the string to be expanded
5263 Returns: the expanded string, always in a new bit of store, or NULL
5267 expand_string_copy(uschar *string)
5269 uschar *yield = expand_string(string);
5270 if (yield == string) yield = string_copy(string);
5276 /*************************************************
5277 * Expand and interpret as an integer *
5278 *************************************************/
5280 /* Expand a string, and convert the result into an integer.
5283 string the string to be expanded
5284 isplus TRUE if a non-negative number is expected
5286 Returns: the integer value, or
5287 -1 for an expansion error ) in both cases, message in
5288 -2 for an integer interpretation error ) expand_string_message
5289 expand_string_message is set NULL for an OK integer
5293 expand_string_integer(uschar *string, BOOL isplus)
5296 uschar *s = expand_string(string);
5297 uschar *msg = US"invalid integer \"%s\"";
5300 /* If expansion failed, expand_string_message will be set. */
5302 if (s == NULL) return -1;
5304 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5305 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5306 systems, so we set it zero ourselves. */
5309 expand_string_message = NULL; /* Indicates no error */
5310 value = strtol(CS s, CSS &endptr, 0);
5314 msg = US"integer expected but \"%s\" found";
5316 else if (value < 0 && isplus)
5318 msg = US"non-negative integer expected but \"%s\" found";
5322 /* Ensure we can cast this down to an int */
5323 if (value > INT_MAX || value < INT_MIN) errno = ERANGE;
5325 if (errno != ERANGE)
5327 if (tolower(*endptr) == 'k')
5329 if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5333 else if (tolower(*endptr) == 'm')
5335 if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5337 else value *= 1024*1024;
5341 if (errno == ERANGE)
5342 msg = US"absolute value of integer \"%s\" is too large (overflow)";
5345 while (isspace(*endptr)) endptr++;
5346 if (*endptr == 0) return (int)value;
5350 expand_string_message = string_sprintf(CS msg, s);
5355 /*************************************************
5356 **************************************************
5357 * Stand-alone test program *
5358 **************************************************
5359 *************************************************/
5365 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5367 int ovector[3*(EXPAND_MAXN+1)];
5368 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5369 ovector, sizeof(ovector)/sizeof(int));
5370 BOOL yield = n >= 0;
5371 if (n == 0) n = EXPAND_MAXN + 1;
5375 expand_nmax = (setup < 0)? 0 : setup + 1;
5376 for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5378 expand_nstring[expand_nmax] = subject + ovector[nn];
5379 expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5387 int main(int argc, uschar **argv)
5390 uschar buffer[1024];
5392 debug_selector = D_v;
5393 debug_file = stderr;
5394 debug_fd = fileno(debug_file);
5395 big_buffer = malloc(big_buffer_size);
5397 for (i = 1; i < argc; i++)
5399 if (argv[i][0] == '+')
5401 debug_trace_memory = 2;
5404 if (isdigit(argv[i][0]))
5405 debug_selector = Ustrtol(argv[i], NULL, 0);
5407 if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5411 eldap_default_servers = argv[i];
5414 mysql_servers = argv[i];
5417 pgsql_servers = argv[i];
5421 else opt_perl_startup = argv[i];
5425 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5427 expand_nstring[1] = US"string 1....";
5428 expand_nlength[1] = 8;
5432 if (opt_perl_startup != NULL)
5435 printf("Starting Perl interpreter\n");
5436 errstr = init_perl(opt_perl_startup);
5439 printf("** error in perl_startup code: %s\n", errstr);
5440 return EXIT_FAILURE;
5443 #endif /* EXIM_PERL */
5445 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5447 void *reset_point = store_get(0);
5448 uschar *yield = expand_string(buffer);
5451 printf("%s\n", yield);
5452 store_reset(reset_point);
5456 if (search_find_defer) printf("search_find deferred\n");
5457 printf("Failed: %s\n", expand_string_message);
5458 if (expand_string_forcedfail) printf("Forced failure\n");
5470 /* End of expand.c */