1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* Miscellaneous string-handling functions. Some are not required for
10 utilities and tests, and are cut out by the COMPILE_UTILITY macro. */
17 #ifndef COMPILE_UTILITY
18 /*************************************************
19 * Test for IP address *
20 *************************************************/
22 /* This used just to be a regular expression, but with IPv6 things are a bit
23 more complicated. If the address contains a colon, it is assumed to be a v6
24 address (assuming HAVE_IPV6 is set). If a mask is permitted and one is present,
25 and maskptr is not NULL, its offset is placed there.
29 maskptr NULL if no mask is permitted to follow
30 otherwise, points to an int where the offset of '/' is placed
31 if there is no / followed by trailing digits, *maskptr is set 0
33 Returns: 0 if the string is not a textual representation of an IP address
34 4 if it is an IPv4 address
35 6 if it is an IPv6 address
39 string_is_ip_address(const uschar *s, int *maskptr)
43 /* If an optional mask is permitted, check for it. If found, pass back the
48 const uschar *ss = s + Ustrlen(s);
50 if (s != ss && isdigit(*(--ss)))
52 while (ss > s && isdigit(ss[-1])) ss--;
53 if (ss > s && *(--ss) == '/') *maskptr = ss - s;
57 /* A colon anywhere in the string => IPv6 address */
59 if (Ustrchr(s, ':') != NULL)
61 BOOL had_double_colon = FALSE;
66 /* An IPv6 address must start with hex digit or double colon. A single
69 if (*s == ':' && *(++s) != ':') return 0;
71 /* Now read up to 8 components consisting of up to 4 hex digits each. There
72 may be one and only one appearance of double colon, which implies any number
73 of binary zero bits. The number of preceding components is held in count. */
75 for (int count = 0; count < 8; count++)
77 /* If the end of the string is reached before reading 8 components, the
78 address is valid provided a double colon has been read. This also applies
79 if we hit the / that introduces a mask or the % that introduces the
80 interface specifier (scope id) of a link-local address. */
82 if (*s == 0 || *s == '%' || *s == '/') return had_double_colon ? yield : 0;
84 /* If a component starts with an additional colon, we have hit a double
85 colon. This is permitted to appear once only, and counts as at least
86 one component. The final component may be of this form. */
90 if (had_double_colon) return 0;
91 had_double_colon = TRUE;
96 /* If the remainder of the string contains a dot but no colons, we
97 can expect a trailing IPv4 address. This is valid if either there has
98 been no double-colon and this is the 7th component (with the IPv4 address
99 being the 7th & 8th components), OR if there has been a double-colon
100 and fewer than 6 components. */
102 if (Ustrchr(s, ':') == NULL && Ustrchr(s, '.') != NULL)
104 if ((!had_double_colon && count != 6) ||
105 (had_double_colon && count > 6)) return 0;
111 /* Check for at least one and not more than 4 hex digits for this
114 if (!isxdigit(*s++)) return 0;
115 if (isxdigit(*s) && isxdigit(*(++s)) && isxdigit(*(++s))) s++;
117 /* If the component is terminated by colon and there is more to
118 follow, skip over the colon. If there is no more to follow the address is
121 if (*s == ':' && *(++s) == 0) return 0;
124 /* If about to handle a trailing IPv4 address, drop through. Otherwise
125 all is well if we are at the end of the string or at the mask or at a percent
126 sign, which introduces the interface specifier (scope id) of a link local
130 return (*s == 0 || *s == '%' ||
131 (*s == '/' && maskptr != NULL && *maskptr != 0))? yield : 0;
134 /* Test for IPv4 address, which may be the tail-end of an IPv6 address. */
136 for (int i = 0; i < 4; i++)
141 if (i != 0 && *s++ != '.') return 0;
142 n = strtol(CCS s, CSS &end, 10);
143 if (n > 255 || n < 0 || end <= s || end > s+3) return 0;
147 return !*s || (*s == '/' && maskptr && *maskptr != 0) ? yield : 0;
149 #endif /* COMPILE_UTILITY */
152 /*************************************************
153 * Format message size *
154 *************************************************/
156 /* Convert a message size in bytes to printing form, rounding
157 according to the magnitude of the number. A value of zero causes
158 a string of spaces to be returned.
161 size the message size in bytes
162 buffer where to put the answer
164 Returns: pointer to the buffer
165 a string of exactly 5 characters is normally returned
169 string_format_size(int size, uschar *buffer)
171 if (size == 0) Ustrcpy(buffer, US" ");
172 else if (size < 1024) sprintf(CS buffer, "%5d", size);
173 else if (size < 10*1024)
174 sprintf(CS buffer, "%4.1fK", (double)size / 1024.0);
175 else if (size < 1024*1024)
176 sprintf(CS buffer, "%4dK", (size + 512)/1024);
177 else if (size < 10*1024*1024)
178 sprintf(CS buffer, "%4.1fM", (double)size / (1024.0 * 1024.0));
180 sprintf(CS buffer, "%4dM", (size + 512 * 1024)/(1024*1024));
186 #ifndef COMPILE_UTILITY
187 /*************************************************
188 * Convert a number to base 62 format *
189 *************************************************/
191 /* Convert a long integer into an ASCII base 62 string. For Cygwin the value of
192 BASE_62 is actually 36. Always return exactly 6 characters plus zero, in a
195 Argument: a long integer
196 Returns: pointer to base 62 string
200 string_base62(unsigned long int value)
202 static uschar yield[7];
203 uschar *p = yield + sizeof(yield) - 1;
207 *(--p) = base62_chars[value % BASE_62];
212 #endif /* COMPILE_UTILITY */
216 /*************************************************
217 * Interpret escape sequence *
218 *************************************************/
220 /* This function is called from several places where escape sequences are to be
221 interpreted in strings.
224 pp points a pointer to the initiating "\" in the string;
225 the pointer gets updated to point to the final character
226 If the backslash is the last character in the string, it
228 Returns: the value of the character escape
232 string_interpret_escape(const uschar **pp)
234 #ifdef COMPILE_UTILITY
235 const uschar *hex_digits= CUS"0123456789abcdef";
238 const uschar *p = *pp;
240 if (ch == '\0') return **pp;
241 if (isdigit(ch) && ch != '8' && ch != '9')
244 if (isdigit(p[1]) && p[1] != '8' && p[1] != '9')
246 ch = ch * 8 + *(++p) - '0';
247 if (isdigit(p[1]) && p[1] != '8' && p[1] != '9')
248 ch = ch * 8 + *(++p) - '0';
253 case 'b': ch = '\b'; break;
254 case 'f': ch = '\f'; break;
255 case 'n': ch = '\n'; break;
256 case 'r': ch = '\r'; break;
257 case 't': ch = '\t'; break;
258 case 'v': ch = '\v'; break;
264 Ustrchr(hex_digits, tolower(*(++p))) - hex_digits;
265 if (isxdigit(p[1])) ch = ch * 16 +
266 Ustrchr(hex_digits, tolower(*(++p))) - hex_digits;
276 #ifndef COMPILE_UTILITY
277 /*************************************************
278 * Ensure string is printable *
279 *************************************************/
281 /* This function is called for critical strings. It checks for any
282 non-printing characters, and if any are found, it makes a new copy
283 of the string with suitable escape sequences. It is most often called by the
284 macro string_printing(), which sets flags to 0.
288 flags Bit 0: convert tabs. Bit 1: convert spaces.
290 Returns: string with non-printers encoded as printing sequences
294 string_printing2(const uschar *s, int flags)
296 int nonprintcount = 0;
305 || flags & SP_TAB && c == '\t'
306 || flags & SP_SPACE && c == ' '
311 if (nonprintcount == 0) return s;
313 /* Get a new block of store guaranteed big enough to hold the
316 tt = ss = store_get(length + nonprintcount * 3 + 1, s);
318 /* Copy everything, escaping non printers. */
324 && (!(flags & SP_TAB) || c != '\t')
325 && (!(flags & SP_SPACE) || c != ' ')
333 case '\n': *tt++ = 'n'; break;
334 case '\r': *tt++ = 'r'; break;
335 case '\b': *tt++ = 'b'; break;
336 case '\v': *tt++ = 'v'; break;
337 case '\f': *tt++ = 'f'; break;
338 case '\t': *tt++ = 't'; break;
339 default: sprintf(CS tt, "%03o", *t); tt += 3; break;
347 #endif /* COMPILE_UTILITY */
349 /*************************************************
350 * Undo printing escapes in string *
351 *************************************************/
353 /* This function is the reverse of string_printing2. It searches for
354 backslash characters and if any are found, it makes a new copy of the
355 string with escape sequences parsed. Otherwise it returns the original
361 Returns: string with printing escapes parsed back
365 string_unprinting(uschar *s)
367 uschar *p, *q, *r, *ss;
370 p = Ustrchr(s, '\\');
373 len = Ustrlen(s) + 1;
374 ss = store_get(len, s);
388 *q++ = string_interpret_escape((const uschar **)&p);
393 r = Ustrchr(p, '\\');
419 #if (defined(HAVE_LOCAL_SCAN) || defined(EXPAND_DLFUNC)) \
420 && !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
421 /*************************************************
422 * Copy and save string *
423 *************************************************/
426 Argument: string to copy
427 Returns: copy of string in new store with the same taint status
431 string_copy_function(const uschar * s)
433 return string_copy_taint(s, s);
436 /* As above, but explicitly specifying the result taint status
440 string_copy_taint_function(const uschar * s, const void * proto_mem)
442 return string_copy_taint(s, proto_mem);
447 /*************************************************
448 * Copy and save string, given length *
449 *************************************************/
451 /* It is assumed the data contains no zeros. A zero is added
456 n number of characters
458 Returns: copy of string in new store
462 string_copyn_function(const uschar * s, int n)
464 return string_copyn(s, n);
469 /*************************************************
470 * Copy and save string in malloc'd store *
471 *************************************************/
473 /* This function assumes that memcpy() is faster than strcpy().
475 Argument: string to copy
476 Returns: copy of string in new store
480 string_copy_malloc(const uschar * s)
482 int len = Ustrlen(s) + 1;
483 uschar * ss = store_malloc(len);
490 /*************************************************
491 * Copy string if long, inserting newlines *
492 *************************************************/
494 /* If the given string is longer than 75 characters, it is copied, and within
495 the copy, certain space characters are converted into newlines.
497 Argument: pointer to the string
498 Returns: pointer to the possibly altered string
502 string_split_message(uschar * msg)
506 if (!msg || Ustrlen(msg) <= 75) return msg;
507 s = ss = msg = string_copy(msg);
512 while (i < 75 && *ss && *ss != '\n') ss++, i++;
524 if (t[-1] == ':') { tt = t; break; }
529 if (!tt) /* Can't split behind - try ahead */
534 if (*t == ' ' || *t == '\n')
540 if (!tt) break; /* Can't find anywhere to split */
551 /*************************************************
552 * Copy returned DNS domain name, de-escaping *
553 *************************************************/
555 /* If a domain name contains top-bit characters, some resolvers return
556 the fully qualified name with those characters turned into escapes. The
557 convention is a backslash followed by _decimal_ digits. We convert these
558 back into the original binary values. This will be relevant when
559 allow_utf8_domains is set true and UTF-8 characters are used in domain
560 names. Backslash can also be used to escape other characters, though we
561 shouldn't come across them in domain names.
563 Argument: the domain name string
564 Returns: copy of string in new store, de-escaped
568 string_copy_dnsdomain(uschar * s)
571 uschar * ss = yield = store_get(Ustrlen(s) + 1, GET_TAINTED); /* always treat as tainted */
577 else if (isdigit(s[1]))
579 *ss++ = (s[1] - '0')*100 + (s[2] - '0')*10 + s[3] - '0';
591 #ifndef COMPILE_UTILITY
592 /*************************************************
593 * Copy space-terminated or quoted string *
594 *************************************************/
596 /* This function copies from a string until its end, or until whitespace is
597 encountered, unless the string begins with a double quote, in which case the
598 terminating quote is sought, and escaping within the string is done. The length
599 of a de-quoted string can be no longer than the original, since escaping always
600 turns n characters into 1 character.
602 Argument: pointer to the pointer to the first character, which gets updated
603 Returns: the new string
607 string_dequote(const uschar ** sptr)
609 const uschar * s = * sptr;
612 /* First find the end of the string */
615 while (*s && !isspace(*s)) s++;
619 while (*s && *s != '\"')
621 if (*s == '\\') (void)string_interpret_escape(&s);
627 /* Get enough store to copy into */
629 t = yield = store_get(s - *sptr + 1, *sptr);
635 while (*s && !isspace(*s)) *t++ = *s++;
639 while (*s && *s != '\"')
641 *t++ = *s == '\\' ? string_interpret_escape(&s) : *s;
647 /* Update the pointer and return the terminated copy */
653 #endif /* COMPILE_UTILITY */
657 /*************************************************
658 * Format a string and save it *
659 *************************************************/
661 /* The formatting is done by string_vformat, which checks the length of
662 everything. Taint is taken from the worst of the arguments.
665 format a printf() format - deliberately char * rather than uschar *
666 because it will most usually be a literal string
667 func caller, for debug
668 line caller, for debug
669 ... arguments for format
671 Returns: pointer to fresh piece of store containing sprintf'ed string
675 string_sprintf_trc(const char * format, const uschar * func, unsigned line, ...)
677 #ifdef COMPILE_UTILITY
678 uschar buffer[STRING_SPRINTF_BUFFER_SIZE];
679 gstring gs = { .size = STRING_SPRINTF_BUFFER_SIZE, .ptr = 0, .s = buffer };
684 unsigned flags = SVFMT_REBUFFER|SVFMT_EXTEND;
689 g = string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
694 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
695 "string_sprintf expansion was longer than %d; format string was (%s)\n"
696 " called from %s %d\n",
697 STRING_SPRINTF_BUFFER_SIZE, format, func, line);
699 #ifdef COMPILE_UTILITY
700 return string_copyn(g->s, g->ptr);
702 gstring_release_unused(g);
703 return string_from_gstring(g);
709 /*************************************************
710 * Case-independent strncmp() function *
711 *************************************************/
717 n number of characters to compare
719 Returns: < 0, = 0, or > 0, according to the comparison
723 strncmpic(const uschar * s, const uschar * t, int n)
727 int c = tolower(*s++) - tolower(*t++);
734 /*************************************************
735 * Case-independent strcmp() function *
736 *************************************************/
743 Returns: < 0, = 0, or > 0, according to the comparison
747 strcmpic(const uschar * s, const uschar * t)
751 int c = tolower(*s++) - tolower(*t++);
752 if (c != 0) return c;
758 /*************************************************
759 * Case-independent strstr() function *
760 *************************************************/
762 /* The third argument specifies whether whitespace is required
763 to follow the matched string.
767 t substring to search for
768 space_follows if TRUE, match only if whitespace follows
770 Returns: pointer to substring in string, or NULL if not found
774 strstric_c(const uschar * s, const uschar * t, BOOL space_follows)
776 const uschar * p = t;
777 const uschar * yield = NULL;
778 int cl = tolower(*p);
779 int cu = toupper(*p);
783 if (*s == cl || *s == cu)
785 if (!yield) yield = s;
788 if (!space_follows || s[1] == ' ' || s[1] == '\n' ) return yield;
809 strstric(uschar * s, uschar * t, BOOL space_follows)
811 return US strstric_c(s, t, space_follows);
815 #ifdef COMPILE_UTILITY
816 /* Dummy version for this function; it should never be called */
818 gstring_grow(gstring * g, int count)
826 #ifndef COMPILE_UTILITY
827 /*************************************************
828 * Get next string from separated list *
829 *************************************************/
831 /* Leading and trailing space is removed from each item. The separator in the
832 list is controlled by the int pointed to by the separator argument as follows:
834 If the value is > 0 it is used as the separator. This is typically used for
835 sublists such as slash-separated options. The value is always a printing
838 (If the value is actually > UCHAR_MAX there is only one item in the list.
839 This is used for some cases when called via functions that sometimes
840 plough through lists, and sometimes are given single items.)
842 If the value is <= 0, the string is inspected for a leading <x, where x is an
843 ispunct() or an iscntrl() character. If found, x is used as the separator. If
846 (a) if separator == 0, ':' is used
847 (b) if separator <0, -separator is used
849 In all cases the value of the separator that is used is written back to the
850 int so that it is used on subsequent calls as we progress through the list.
852 A literal ispunct() separator can be represented in an item by doubling, but
853 there is no way to include an iscntrl() separator as part of the data.
856 listptr points to a pointer to the current start of the list; the
857 pointer gets updated to point after the end of the next item
858 separator a pointer to the separator character in an int (see above)
859 buffer where to put a copy of the next string in the list; or
860 NULL if the next string is returned in new memory
861 Note that if the list is tainted then a provided buffer must be
862 also (else we trap, with a message referencing the callsite).
863 If we do the allocation, taint is handled there.
864 buflen when buffer is not NULL, the size of buffer; otherwise ignored
866 func caller, for debug
867 line caller, for debug
869 Returns: pointer to buffer, containing the next substring,
870 or NULL if no more substrings
874 string_nextinlist_trc(const uschar ** listptr, int * separator, uschar * buffer,
875 int buflen, const uschar * func, int line)
877 int sep = *separator;
878 const uschar * s = *listptr;
883 /* This allows for a fixed specified separator to be an iscntrl() character,
884 but at the time of implementation, this is never the case. However, it's best
885 to be conservative. */
887 while (isspace(*s) && *s != sep) s++;
889 /* A change of separator is permitted, so look for a leading '<' followed by an
890 allowed character. */
894 if (*s == '<' && (ispunct(s[1]) || iscntrl(s[1])))
898 while (isspace(*s) && *s != sep) s++;
901 sep = sep ? -sep : ':';
905 /* An empty string has no list elements */
907 if (!*s) return NULL;
909 /* Note whether whether or not the separator is an iscntrl() character. */
911 sep_is_special = iscntrl(sep);
913 /* Handle the case when a buffer is provided. */
914 /*XXX need to also deal with qouted-requirements mismatch */
919 if (is_tainted(s) && !is_tainted(buffer))
920 die_tainted(US"string_nextinlist", func, line);
923 if (*s == sep && (*(++s) != sep || sep_is_special)) break;
924 if (p < buflen - 1) buffer[p++] = *s;
926 while (p > 0 && isspace(buffer[p-1])) p--;
930 /* Handle the case when a buffer is not provided. */
936 /* We know that *s != 0 at this point. However, it might be pointing to a
937 separator, which could indicate an empty string, or (if an ispunct()
938 character) could be doubled to indicate a separator character as data at the
939 start of a string. Avoid getting working memory for an empty item. */
942 if (*++s != sep || sep_is_special)
945 return string_copy(US"");
948 /* Not an empty string; the first character is guaranteed to be a data
954 for (ss = s + 1; *ss && *ss != sep; ) ss++;
955 g = string_catn(g, s, ss-s);
957 if (!*s || *++s != sep || sep_is_special) break;
960 /* Trim trailing spaces from the returned string */
962 /* while (g->ptr > 0 && isspace(g->s[g->ptr-1])) g->ptr--; */
963 while ( g->ptr > 0 && isspace(g->s[g->ptr-1])
964 && (g->ptr == 1 || g->s[g->ptr-2] != '\\') )
966 buffer = string_from_gstring(g);
967 gstring_release_unused_trc(g, CCS func, line);
970 /* Update the current pointer and return the new string */
977 static const uschar *
978 Ustrnchr(const uschar * s, int c, unsigned * len)
983 if (!*s) return NULL;
996 /************************************************
997 * Add element to separated list *
998 ************************************************/
999 /* This function is used to build a list, returning an allocated null-terminated
1000 growable string. The given element has any embedded separator characters
1003 Despite having the same growable-string interface as string_cat() the list is
1004 always returned null-terminated.
1007 list expanding-string for the list that is being built, or NULL
1008 if this is a new list that has no contents yet
1009 sep list separator character
1010 ele new element to be appended to the list
1012 Returns: pointer to the start of the list, changed if copied for expansion.
1016 string_append_listele(gstring * list, uschar sep, const uschar * ele)
1020 if (list && list->ptr)
1021 list = string_catn(list, &sep, 1);
1023 while((sp = Ustrchr(ele, sep)))
1025 list = string_catn(list, ele, sp-ele+1);
1026 list = string_catn(list, &sep, 1);
1029 list = string_cat(list, ele);
1030 (void) string_from_gstring(list);
1036 string_append_listele_n(gstring * list, uschar sep, const uschar * ele,
1041 if (list && list->ptr)
1042 list = string_catn(list, &sep, 1);
1044 while((sp = Ustrnchr(ele, sep, &len)))
1046 list = string_catn(list, ele, sp-ele+1);
1047 list = string_catn(list, &sep, 1);
1051 list = string_catn(list, ele, len);
1052 (void) string_from_gstring(list);
1058 /* A slightly-bogus listmaker utility; the separator is a string so
1059 can be multiple chars - there is no checking for the element content
1060 containing any of the separator. */
1063 string_append2_listele_n(gstring * list, const uschar * sepstr,
1064 const uschar * ele, unsigned len)
1066 if (list && list->ptr)
1067 list = string_cat(list, sepstr);
1069 list = string_catn(list, ele, len);
1070 (void) string_from_gstring(list);
1076 /************************************************/
1077 /* Add more space to a growable-string. The caller should check
1078 first if growth is required. The gstring struct is modified on
1079 return; specifically, the string-base-pointer may have been changed.
1082 g the growable-string
1083 count amount needed for g->ptr to increase by
1087 gstring_grow(gstring * g, int count)
1090 int oldsize = g->size;
1092 /* Mostly, string_cat() is used to build small strings of a few hundred
1093 characters at most. There are times, however, when the strings are very much
1094 longer (for example, a lookup that returns a vast number of alias addresses).
1095 To try to keep things reasonable, we use increments whose size depends on the
1096 existing length of the string. */
1098 unsigned inc = oldsize < 4096 ? 127 : 1023;
1100 if (g->ptr < 0 || g->ptr > g->size || g->size >= INT_MAX/2)
1101 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1102 "internal error in gstring_grow (ptr %d size %d)", g->ptr, g->size);
1104 if (count <= 0) return;
1106 if (count >= INT_MAX/2 - g->ptr)
1107 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1108 "internal error in gstring_grow (ptr %d count %d)", g->ptr, count);
1110 g->size = (p + count + inc + 1) & ~inc; /* one for a NUL */
1112 /* Try to extend an existing allocation. If the result of calling
1113 store_extend() is false, either there isn't room in the current memory block,
1114 or this string is not the top item on the dynamic store stack. We then have
1115 to get a new chunk of store and copy the old string. When building large
1116 strings, it is helpful to call store_release() on the old string, to release
1117 memory blocks that have become empty. (The block will be freed if the string
1118 is at its start.) However, we can do this only if we know that the old string
1119 was the last item on the dynamic memory stack. This is the case if it matches
1122 if (!store_extend(g->s, oldsize, g->size))
1123 g->s = store_newblock(g->s, g->size, p);
1128 /*************************************************
1129 * Add chars to string *
1130 *************************************************/
1131 /* This function is used when building up strings of unknown length. Room is
1132 always left for a terminating zero to be added to the string that is being
1133 built. This function does not require the string that is being added to be NUL
1134 terminated, because the number of characters to add is given explicitly. It is
1135 sometimes called to extract parts of other strings.
1138 g growable-string that is being built, or NULL if not assigned yet
1139 s points to characters to add
1140 count count of characters to add; must not exceed the length of s, if s
1143 Returns: growable string, changed if copied for expansion.
1144 Note that a NUL is not added, though space is left for one. This is
1145 because string_cat() is often called multiple times to build up a
1146 string - there's no point adding the NUL till the end.
1147 NULL is a possible return.
1150 /* coverity[+alloc] */
1153 string_catn(gstring * g, const uschar * s, int count)
1158 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1159 "internal error in string_catn (count %d)", count);
1160 if (count == 0) return g;
1162 /*debug_printf("string_catn '%.*s'\n", count, s);*/
1165 unsigned inc = count < 4096 ? 127 : 1023;
1166 unsigned size = ((count + inc) & ~inc) + 1; /* round up requested count */
1167 g = string_get_tainted(size, s);
1169 else if (is_incompatible(g->s, s))
1171 /* debug_printf("rebuf A\n"); */
1172 gstring_rebuffer(g, s);
1175 if (g->ptr < 0 || g->ptr > g->size)
1176 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1177 "internal error in string_catn (ptr %d size %d)", g->ptr, g->size);
1180 if (count >= g->size - p)
1181 gstring_grow(g, count);
1183 /* Because we always specify the exact number of characters to copy, we can
1184 use memcpy(), which is likely to be more efficient than strncopy() because the
1185 latter has to check for zero bytes. */
1187 memcpy(g->s + p, s, count);
1194 string_cat(gstring * g, const uschar * s)
1196 return string_catn(g, s, Ustrlen(s));
1201 /*************************************************
1202 * Append strings to another string *
1203 *************************************************/
1205 /* This function can be used to build a string from many other strings.
1206 It calls string_cat() to do the dirty work.
1209 g growable-string that is being built, or NULL if not yet assigned
1210 count the number of strings to append
1211 ... "count" uschar* arguments, which must be valid zero-terminated
1214 Returns: growable string, changed if copied for expansion.
1215 The string is not zero-terminated - see string_cat() above.
1218 __inline__ gstring *
1219 string_append(gstring * g, int count, ...)
1223 va_start(ap, count);
1226 uschar * t = va_arg(ap, uschar *);
1227 g = string_cat(g, t);
1237 /*************************************************
1238 * Format a string with length checks *
1239 *************************************************/
1241 /* This function is used to format a string with checking of the length of the
1242 output for all conversions. It protects Exim from absent-mindedness when
1243 calling functions like debug_printf and string_sprintf, and elsewhere. There
1244 are two different entry points to what is actually the same function, depending
1245 on whether the variable length list of data arguments are given explicitly or
1248 The formats are the usual printf() ones, with some omissions (never used) and
1249 three additions for strings: %S forces lower case, %T forces upper case, and
1250 %#s or %#S prints nothing for a NULL string. Without the # "NULL" is printed
1251 (useful in debugging). There is also the addition of %D and %M, which insert
1252 the date in the form used for datestamped log files.
1255 buffer a buffer in which to put the formatted string
1256 buflen the length of the buffer
1257 format the format string - deliberately char * and not uschar *
1258 ... or ap variable list of supplementary arguments
1260 Returns: TRUE if the result fitted in the buffer
1264 string_format_trc(uschar * buffer, int buflen,
1265 const uschar * func, unsigned line, const char * format, ...)
1267 gstring g = { .size = buflen, .ptr = 0, .s = buffer }, * gp;
1269 va_start(ap, format);
1270 gp = string_vformat_trc(&g, func, line, STRING_SPRINTF_BUFFER_SIZE,
1280 /* Build or append to a growing-string, sprintf-style.
1284 func called-from function name, for debug
1285 line called-from file line number, for debug
1286 limit maximum string size
1288 format printf-like format string
1289 ap variable-args pointer
1292 SVFMT_EXTEND buffer can be created or exteded as needed
1293 SVFMT_REBUFFER buffer can be recopied to tainted mem as needed
1294 SVFMT_TAINT_NOCHK do not check inputs for taint
1296 If the "extend" flag is true, the string passed in can be NULL,
1297 empty, or non-empty. Growing is subject to an overall limit given
1298 by the limit argument.
1300 If the "extend" flag is false, the string passed in may not be NULL,
1301 will not be grown, and is usable in the original place after return.
1302 The return value can be NULL to signify overflow.
1304 Returns the possibly-new (if copy for growth or taint-handling was needed)
1305 string, not nul-terminated.
1309 string_vformat_trc(gstring * g, const uschar * func, unsigned line,
1310 unsigned size_limit, unsigned flags, const char * format, va_list ap)
1312 enum ltypes { L_NORMAL=1, L_SHORT=2, L_LONG=3, L_LONGLONG=4, L_LONGDOUBLE=5, L_SIZE=6 };
1314 int width, precision, off, lim, need;
1315 const char * fp = format; /* Deliberately not unsigned */
1317 string_datestamp_offset = -1; /* Datestamp not inserted */
1318 string_datestamp_length = 0; /* Datestamp not inserted */
1319 string_datestamp_type = 0; /* Datestamp not inserted */
1321 #ifdef COMPILE_UTILITY
1322 assert(!(flags & SVFMT_EXTEND));
1326 /* Ensure we have a string, to save on checking later */
1327 if (!g) g = string_get(16);
1329 if (!(flags & SVFMT_TAINT_NOCHK) && is_incompatible(g->s, format))
1331 #ifndef MACRO_PREDEF
1332 if (!(flags & SVFMT_REBUFFER))
1333 die_tainted(US"string_vformat", func, line);
1335 /* debug_printf("rebuf B\n"); */
1336 gstring_rebuffer(g, format);
1338 #endif /*!COMPILE_UTILITY*/
1340 lim = g->size - 1; /* leave one for a nul */
1341 off = g->ptr; /* remember initial offset in gstring */
1343 /* Scan the format and handle the insertions */
1347 int length = L_NORMAL;
1350 const char *null = "NULL"; /* ) These variables */
1351 const char *item_start, *s; /* ) are deliberately */
1352 char newformat[16]; /* ) not unsigned */
1353 char * gp = CS g->s + g->ptr; /* ) */
1355 /* Non-% characters just get copied verbatim */
1359 /* Avoid string_copyn() due to COMPILE_UTILITY */
1360 if ((need = g->ptr + 1) > lim)
1362 if (!(flags & SVFMT_EXTEND) || need > size_limit) return NULL;
1366 g->s[g->ptr++] = (uschar) *fp++;
1370 /* Deal with % characters. Pick off the width and precision, for checking
1371 strings, skipping over the flag and modifier characters. */
1374 width = precision = -1;
1376 if (strchr("-+ #0", *(++fp)) != NULL)
1378 if (*fp == '#') null = "";
1382 if (isdigit((uschar)*fp))
1384 width = *fp++ - '0';
1385 while (isdigit((uschar)*fp)) width = width * 10 + *fp++ - '0';
1387 else if (*fp == '*')
1389 width = va_arg(ap, int);
1396 precision = va_arg(ap, int);
1400 for (precision = 0; isdigit((uschar)*fp); fp++)
1401 precision = precision*10 + *fp - '0';
1403 /* Skip over 'h', 'L', 'l', 'll' and 'z', remembering the item length */
1406 { fp++; length = L_SHORT; }
1407 else if (*fp == 'L')
1408 { fp++; length = L_LONGDOUBLE; }
1409 else if (*fp == 'l')
1411 { fp += 2; length = L_LONGLONG; }
1413 { fp++; length = L_LONG; }
1414 else if (*fp == 'z')
1415 { fp++; length = L_SIZE; }
1417 /* Handle each specific format type. */
1422 nptr = va_arg(ap, int *);
1423 *nptr = g->ptr - off;
1431 width = length > L_LONG ? 24 : 12;
1432 if ((need = g->ptr + width) > lim)
1434 if (!(flags & SVFMT_EXTEND) || need >= size_limit) return NULL;
1435 gstring_grow(g, width);
1437 gp = CS g->s + g->ptr;
1439 strncpy(newformat, item_start, fp - item_start);
1440 newformat[fp - item_start] = 0;
1442 /* Short int is promoted to int when passing through ..., so we must use
1443 int for va_arg(). */
1449 g->ptr += sprintf(gp, newformat, va_arg(ap, int)); break;
1451 g->ptr += sprintf(gp, newformat, va_arg(ap, long int)); break;
1453 g->ptr += sprintf(gp, newformat, va_arg(ap, LONGLONG_T)); break;
1455 g->ptr += sprintf(gp, newformat, va_arg(ap, size_t)); break;
1462 if ((need = g->ptr + 24) > lim)
1464 if (!(flags & SVFMT_EXTEND || need >= size_limit)) return NULL;
1465 gstring_grow(g, 24);
1467 gp = CS g->s + g->ptr;
1469 /* sprintf() saying "(nil)" for a null pointer seems unreliable.
1470 Handle it explicitly. */
1471 if ((ptr = va_arg(ap, void *)))
1473 strncpy(newformat, item_start, fp - item_start);
1474 newformat[fp - item_start] = 0;
1475 g->ptr += sprintf(gp, newformat, ptr);
1478 g->ptr += sprintf(gp, "(nil)");
1482 /* %f format is inherently insecure if the numbers that it may be
1483 handed are unknown (e.g. 1e300). However, in Exim, %f is used for
1484 printing load averages, and these are actually stored as integers
1485 (load average * 1000) so the size of the numbers is constrained.
1486 It is also used for formatting sending rates, where the simplicity
1487 of the format prevents overflow. */
1494 if (precision < 0) precision = 6;
1495 if ((need = g->ptr + precision + 8) > lim)
1497 if (!(flags & SVFMT_EXTEND || need >= size_limit)) return NULL;
1498 gstring_grow(g, precision+8);
1500 gp = CS g->s + g->ptr;
1502 strncpy(newformat, item_start, fp - item_start);
1503 newformat[fp-item_start] = 0;
1504 if (length == L_LONGDOUBLE)
1505 g->ptr += sprintf(gp, newformat, va_arg(ap, long double));
1507 g->ptr += sprintf(gp, newformat, va_arg(ap, double));
1513 if ((need = g->ptr + 1) > lim)
1515 if (!(flags & SVFMT_EXTEND || need >= size_limit)) return NULL;
1519 g->s[g->ptr++] = (uschar) '%';
1523 if ((need = g->ptr + 1) > lim)
1525 if (!(flags & SVFMT_EXTEND || need >= size_limit)) return NULL;
1529 g->s[g->ptr++] = (uschar) va_arg(ap, int);
1532 case 'D': /* Insert daily datestamp for log file names */
1533 s = CS tod_stamp(tod_log_datestamp_daily);
1534 string_datestamp_offset = g->ptr; /* Passed back via global */
1535 string_datestamp_length = Ustrlen(s); /* Passed back via global */
1536 string_datestamp_type = tod_log_datestamp_daily;
1537 slen = string_datestamp_length;
1540 case 'M': /* Insert monthly datestamp for log file names */
1541 s = CS tod_stamp(tod_log_datestamp_monthly);
1542 string_datestamp_offset = g->ptr; /* Passed back via global */
1543 string_datestamp_length = Ustrlen(s); /* Passed back via global */
1544 string_datestamp_type = tod_log_datestamp_monthly;
1545 slen = string_datestamp_length;
1549 case 'S': /* Forces *lower* case */
1550 case 'T': /* Forces *upper* case */
1551 s = va_arg(ap, char *);
1556 if (!(flags & SVFMT_TAINT_NOCHK) && is_incompatible(g->s, s))
1557 if (flags & SVFMT_REBUFFER)
1559 /* debug_printf("%s %d: untainted workarea, tainted %%s :- rebuffer\n", __FUNCTION__, __LINE__); */
1560 gstring_rebuffer(g, s);
1561 gp = CS g->s + g->ptr;
1563 #ifndef MACRO_PREDEF
1565 die_tainted(US"string_vformat", func, line);
1568 INSERT_STRING: /* Come to from %D or %M above */
1571 BOOL truncated = FALSE;
1573 /* If the width is specified, check that there is a precision
1574 set; if not, set it to the width to prevent overruns of long
1579 if (precision < 0) precision = width;
1582 /* If a width is not specified and the precision is specified, set
1583 the width to the precision, or the string length if shorted. */
1585 else if (precision >= 0)
1586 width = precision < slen ? precision : slen;
1588 /* If neither are specified, set them both to the string length. */
1591 width = precision = slen;
1593 if ((need = g->ptr + width) >= size_limit || !(flags & SVFMT_EXTEND))
1595 if (g->ptr == lim) return NULL;
1599 width = precision = lim - g->ptr - 1;
1600 if (width < 0) width = 0;
1601 if (precision < 0) precision = 0;
1604 else if (need > lim)
1606 gstring_grow(g, width);
1608 gp = CS g->s + g->ptr;
1611 g->ptr += sprintf(gp, "%*.*s", width, precision, s);
1613 while (*gp) { *gp = tolower(*gp); gp++; }
1614 else if (fp[-1] == 'T')
1615 while (*gp) { *gp = toupper(*gp); gp++; }
1617 if (truncated) return NULL;
1621 /* Some things are never used in Exim; also catches junk. */
1624 strncpy(newformat, item_start, fp - item_start);
1625 newformat[fp-item_start] = 0;
1626 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "string_format: unsupported type "
1627 "in \"%s\" in \"%s\"", newformat, format);
1632 if (g->ptr > g->size)
1633 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1634 "string_format internal error: caller %s %d", func, line);
1640 #ifndef COMPILE_UTILITY
1641 /*************************************************
1642 * Generate an "open failed" message *
1643 *************************************************/
1645 /* This function creates a message after failure to open a file. It includes a
1646 string supplied as data, adds the strerror() text, and if the failure was
1647 "Permission denied", reads and includes the euid and egid.
1650 format a text format string - deliberately not uschar *
1651 func caller, for debug
1652 line caller, for debug
1653 ... arguments for the format string
1655 Returns: a message, in dynamic store
1659 string_open_failed_trc(const uschar * func, unsigned line,
1660 const char * format, ...)
1663 gstring * g = string_get(1024);
1665 g = string_catn(g, US"failed to open ", 15);
1667 /* Use the checked formatting routine to ensure that the buffer
1668 does not overflow. It should not, since this is called only for internally
1669 specified messages. If it does, the message just gets truncated, and there
1670 doesn't seem much we can do about that. */
1672 va_start(ap, format);
1673 (void) string_vformat_trc(g, func, line, STRING_SPRINTF_BUFFER_SIZE,
1674 SVFMT_REBUFFER, format, ap);
1677 g = string_catn(g, US": ", 2);
1678 g = string_cat(g, US strerror(errno));
1680 if (errno == EACCES)
1682 int save_errno = errno;
1683 g = string_fmt_append(g, " (euid=%ld egid=%ld)",
1684 (long int)geteuid(), (long int)getegid());
1687 gstring_release_unused(g);
1688 return string_from_gstring(g);
1695 /* qsort(3), currently used to sort the environment variables
1696 for -bP environment output, needs a function to compare two pointers to string
1697 pointers. Here it is. */
1700 string_compare_by_pointer(const void *a, const void *b)
1702 return Ustrcmp(* CUSS a, * CUSS b);
1704 #endif /* COMPILE_UTILITY */
1709 /*************************************************
1710 **************************************************
1711 * Stand-alone test program *
1712 **************************************************
1713 *************************************************/
1720 printf("Testing is_ip_address\n");
1723 while (fgets(CS buffer, sizeof(buffer), stdin) != NULL)
1726 buffer[Ustrlen(buffer) - 1] = 0;
1727 printf("%d\n", string_is_ip_address(buffer, NULL));
1728 printf("%d %d %s\n", string_is_ip_address(buffer, &offset), offset, buffer);
1731 printf("Testing string_nextinlist\n");
1733 while (fgets(CS buffer, sizeof(buffer), stdin) != NULL)
1735 uschar *list = buffer;
1743 sep1 = sep2 = list[1];
1750 uschar *item1 = string_nextinlist(&lp1, &sep1, item, sizeof(item));
1751 uschar *item2 = string_nextinlist(&lp2, &sep2, NULL, 0);
1753 if (item1 == NULL && item2 == NULL) break;
1754 if (item == NULL || item2 == NULL || Ustrcmp(item1, item2) != 0)
1756 printf("***ERROR\nitem1=\"%s\"\nitem2=\"%s\"\n",
1757 (item1 == NULL)? "NULL" : CS item1,
1758 (item2 == NULL)? "NULL" : CS item2);
1761 else printf(" \"%s\"\n", CS item1);
1765 /* This is a horrible lash-up, but it serves its purpose. */
1767 printf("Testing string_format\n");
1769 while (fgets(CS buffer, sizeof(buffer), stdin) != NULL)
1772 long long llargs[3];
1782 buffer[Ustrlen(buffer) - 1] = 0;
1784 s = Ustrchr(buffer, ',');
1785 if (s == NULL) s = buffer + Ustrlen(buffer);
1787 Ustrncpy(format, buffer, s - buffer);
1788 format[s-buffer] = 0;
1795 s = Ustrchr(ss, ',');
1796 if (s == NULL) s = ss + Ustrlen(ss);
1800 Ustrncpy(outbuf, ss, s-ss);
1801 if (Ustrchr(outbuf, '.') != NULL)
1804 dargs[n++] = Ustrtod(outbuf, NULL);
1806 else if (Ustrstr(outbuf, "ll") != NULL)
1809 llargs[n++] = strtoull(CS outbuf, NULL, 10);
1813 args[n++] = (void *)Uatoi(outbuf);
1817 else if (Ustrcmp(ss, "*") == 0)
1819 args[n++] = (void *)(&count);
1825 uschar *sss = malloc(s - ss + 1);
1826 Ustrncpy(sss, ss, s-ss);
1833 if (!dflag && !llflag)
1834 printf("%s\n", string_format(outbuf, sizeof(outbuf), CS format,
1835 args[0], args[1], args[2])? "True" : "False");
1838 printf("%s\n", string_format(outbuf, sizeof(outbuf), CS format,
1839 dargs[0], dargs[1], dargs[2])? "True" : "False");
1841 else printf("%s\n", string_format(outbuf, sizeof(outbuf), CS format,
1842 llargs[0], llargs[1], llargs[2])? "True" : "False");
1844 printf("%s\n", CS outbuf);
1845 if (countset) printf("count=%d\n", count);
1852 /* End of string.c */