2 Unix SMB/CIFS implementation.
3 Samba utility functions
5 Copyright (C) Andrew Tridgell 1992-2001
6 Copyright (C) Simo Sorce 2001-2002
7 Copyright (C) Martin Pool 2003
8 Copyright (C) James Peach 2005
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "libcli/raw/smb.h"
26 #include "system/locale.h"
30 * @brief String utilities.
35 Trim the specified elements off the front and back of a string.
37 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
44 /* Ignore null or empty strings. */
45 if (!s || (s[0] == '\0'))
48 front_len = front? strlen(front) : 0;
49 back_len = back? strlen(back) : 0;
54 while (len && strncmp(s, front, front_len)==0) {
55 /* Must use memmove here as src & dest can
56 * easily overlap. Found by valgrind. JRA. */
57 memmove(s, s+front_len, (len-front_len)+1);
64 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
74 Find the number of 'c' chars in a string
76 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
91 Safe string copy into a known length string. maxlength does not
92 include the terminating zero.
94 _PUBLIC_ char *safe_strcpy(char *dest,const char *src, size_t maxlength)
99 DEBUG(0,("ERROR: NULL dest in safe_strcpy\n"));
104 /* We intentionally write out at the extremity of the destination
105 * string. If the destination is too short (e.g. pstrcpy into mallocd
106 * or fstring) then this should cause an error under a memory
108 dest[maxlength] = '\0';
109 if (PTR_DIFF(&len, dest) > 0) { /* check if destination is on the stack, ok if so */
110 log_suspicious_usage("safe_strcpy", src);
121 if (len > maxlength) {
122 DEBUG(0,("ERROR: string overflow by %u (%u - %u) in safe_strcpy [%.50s]\n",
123 (uint_t)(len-maxlength), (unsigned)len, (unsigned)maxlength, src));
127 memmove(dest, src, len);
133 Safe string cat into a string. maxlength does not
134 include the terminating zero.
136 _PUBLIC_ char *safe_strcat(char *dest, const char *src, size_t maxlength)
138 size_t src_len, dest_len;
141 DEBUG(0,("ERROR: NULL dest in safe_strcat\n"));
149 if (PTR_DIFF(&src_len, dest) > 0) { /* check if destination is on the stack, ok if so */
150 log_suspicious_usage("safe_strcat", src);
153 src_len = strlen(src);
154 dest_len = strlen(dest);
156 if (src_len + dest_len > maxlength) {
157 DEBUG(0,("ERROR: string overflow by %d in safe_strcat [%.50s]\n",
158 (int)(src_len + dest_len - maxlength), src));
159 if (maxlength > dest_len) {
160 memcpy(&dest[dest_len], src, maxlength - dest_len);
166 memcpy(&dest[dest_len], src, src_len);
167 dest[dest_len + src_len] = 0;
172 Routine to get hex characters and turn them into a 16 byte array.
173 the array can be variable length, and any non-hex-numeric
174 characters are skipped. "0xnn" or "0Xnn" is specially catered
177 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
181 _PUBLIC_ size_t strhex_to_str(char *p, size_t len, const char *strhex)
184 size_t num_chars = 0;
185 uint8_t lonybble, hinybble;
186 const char *hexchars = "0123456789ABCDEF";
187 char *p1 = NULL, *p2 = NULL;
189 for (i = 0; i < len && strhex[i] != 0; i++) {
190 if (strncasecmp(hexchars, "0x", 2) == 0) {
191 i++; /* skip two chars */
195 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
198 i++; /* next hex digit */
200 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
203 /* get the two nybbles */
204 hinybble = PTR_DIFF(p1, hexchars);
205 lonybble = PTR_DIFF(p2, hexchars);
207 p[num_chars] = (hinybble << 4) | lonybble;
217 * Parse a hex string and return a data blob.
219 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(const char *strhex)
221 DATA_BLOB ret_blob = data_blob(NULL, strlen(strhex)/2+1);
223 ret_blob.length = strhex_to_str((char *)ret_blob.data,
232 * Routine to print a buffer as HEX digits, into an allocated string.
234 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
239 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
240 hex_buffer = *out_hex_buffer;
242 for (i = 0; i < len; i++)
243 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
247 * talloc version of hex_encode()
249 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
254 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
256 for (i = 0; i < len; i++)
257 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
263 Substitute a string for a pattern in another string. Make sure there is
266 This routine looks for pattern in s and replaces it with
267 insert. It may do multiple replacements.
269 Any of " ; ' $ or ` in the insert string are replaced with _
270 if len==0 then the string cannot be extended. This is different from the old
271 use of len==0 which was for no length checks to be done.
274 _PUBLIC_ void string_sub(char *s, const char *pattern, const char *insert, size_t len)
277 ssize_t ls, lp, li, i;
279 if (!insert || !pattern || !*pattern || !s)
282 ls = (ssize_t)strlen(s);
283 lp = (ssize_t)strlen(pattern);
284 li = (ssize_t)strlen(insert);
287 len = ls + 1; /* len is number of *bytes* */
289 while (lp <= ls && (p = strstr(s, pattern))) {
290 if (ls + (li-lp) >= len) {
291 DEBUG(0,("ERROR: string overflow by %d in string_sub(%.50s, %d)\n",
292 (int)(ls + (li-lp) - len),
297 memmove(p+li,p+lp,strlen(p+lp)+1);
321 * Talloc'ed version of string_sub
323 _PUBLIC_ char *string_sub_talloc(TALLOC_CTX *mem_ctx, const char *s,
324 const char *pattern, const char *insert)
328 size_t len, alloc_len;
330 if (insert == NULL || pattern == NULL || !*pattern || s == NULL)
333 /* determine length needed */
336 for (p = strstr(s, pattern); p != NULL;
337 p = strstr(p+strlen(pattern), pattern)) {
338 len += strlen(insert) - strlen(pattern);
341 alloc_len = MAX(len, strlen(s))+1;
342 ret = talloc_array(mem_ctx, char, alloc_len);
345 strncpy(ret, s, alloc_len);
346 string_sub(ret, pattern, insert, alloc_len);
348 ret = talloc_realloc(mem_ctx, ret, char, len+1);
352 SMB_ASSERT(ret[len] == '\0');
358 Similar to string_sub() but allows for any character to be substituted.
360 if len==0 then the string cannot be extended. This is different from the old
361 use of len==0 which was for no length checks to be done.
364 _PUBLIC_ void all_string_sub(char *s,const char *pattern,const char *insert, size_t len)
369 if (!insert || !pattern || !s)
372 ls = (ssize_t)strlen(s);
373 lp = (ssize_t)strlen(pattern);
374 li = (ssize_t)strlen(insert);
380 len = ls + 1; /* len is number of *bytes* */
382 while (lp <= ls && (p = strstr(s,pattern))) {
383 if (ls + (li-lp) >= len) {
384 DEBUG(0,("ERROR: string overflow by %d in all_string_sub(%.50s, %d)\n",
385 (int)(ls + (li-lp) - len),
390 memmove(p+li,p+lp,strlen(p+lp)+1);
392 memcpy(p, insert, li);
401 Unescape a URL encoded string, in place.
404 _PUBLIC_ void rfc1738_unescape(char *buf)
408 while ((p=strchr(p,'+')))
413 while (p && *p && (p=strchr(p,'%'))) {
417 if (c1 >= '0' && c1 <= '9')
419 else if (c1 >= 'A' && c1 <= 'F')
421 else if (c1 >= 'a' && c1 <= 'f')
423 else {p++; continue;}
425 if (c2 >= '0' && c2 <= '9')
427 else if (c2 >= 'A' && c2 <= 'F')
429 else if (c2 >= 'a' && c2 <= 'f')
431 else {p++; continue;}
435 memmove(p+1, p+3, strlen(p+3)+1);
441 size_t valgrind_strlen(const char *s)
444 for(count = 0; *s++; count++)
452 format a string into length-prefixed dotted domain format, as used in NBT
453 and in some ADS structures
455 _PUBLIC_ const char *str_format_nbt_domain(TALLOC_CTX *mem_ctx, const char *s)
460 return talloc_strdup(mem_ctx, "");
462 ret = talloc_array(mem_ctx, char, strlen(s)+2);
467 memcpy(ret+1, s, strlen(s)+1);
470 for (i=0;ret[i];i++) {
472 char *p = strchr(ret+i+1, '.');
474 ret[i] = p-(ret+i+1);
476 ret[i] = strlen(ret+i+1);
485 * Add a string to an array of strings.
487 * num should be a pointer to an integer that holds the current
488 * number of elements in strings. It will be updated by this function.
490 _PUBLIC_ bool add_string_to_array(TALLOC_CTX *mem_ctx,
491 const char *str, const char ***strings, int *num)
493 char *dup_str = talloc_strdup(mem_ctx, str);
495 *strings = talloc_realloc(mem_ctx,
497 const char *, ((*num)+1));
499 if ((*strings == NULL) || (dup_str == NULL))
502 (*strings)[*num] = dup_str;
511 varient of strcmp() that handles NULL ptrs
513 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
518 if (s1 == NULL || s2 == NULL) {
521 return strcmp(s1, s2);
526 return the number of bytes occupied by a buffer in ASCII format
527 the result includes the null termination
530 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
534 len = strnlen(src, n);
544 Return a string representing a CIFS attribute for a file.
546 _PUBLIC_ char *attrib_string(TALLOC_CTX *mem_ctx, uint32_t attrib)
553 {'V', FILE_ATTRIBUTE_VOLUME},
554 {'D', FILE_ATTRIBUTE_DIRECTORY},
555 {'A', FILE_ATTRIBUTE_ARCHIVE},
556 {'H', FILE_ATTRIBUTE_HIDDEN},
557 {'S', FILE_ATTRIBUTE_SYSTEM},
558 {'N', FILE_ATTRIBUTE_NORMAL},
559 {'R', FILE_ATTRIBUTE_READONLY},
560 {'d', FILE_ATTRIBUTE_DEVICE},
561 {'t', FILE_ATTRIBUTE_TEMPORARY},
562 {'s', FILE_ATTRIBUTE_SPARSE},
563 {'r', FILE_ATTRIBUTE_REPARSE_POINT},
564 {'c', FILE_ATTRIBUTE_COMPRESSED},
565 {'o', FILE_ATTRIBUTE_OFFLINE},
566 {'n', FILE_ATTRIBUTE_NONINDEXED},
567 {'e', FILE_ATTRIBUTE_ENCRYPTED}
571 ret = talloc_array(mem_ctx, char, ARRAY_SIZE(attr_strs)+1);
576 for (len=i=0; i<ARRAY_SIZE(attr_strs); i++) {
577 if (attrib & attr_strs[i].attr) {
578 ret[len++] = attr_strs[i].c;
588 Set a boolean variable from the text value stored in the passed string.
589 Returns true in success, false if the passed string does not correctly
593 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
595 if (strwicmp(boolean_string, "yes") == 0 ||
596 strwicmp(boolean_string, "true") == 0 ||
597 strwicmp(boolean_string, "on") == 0 ||
598 strwicmp(boolean_string, "1") == 0) {
601 } else if (strwicmp(boolean_string, "no") == 0 ||
602 strwicmp(boolean_string, "false") == 0 ||
603 strwicmp(boolean_string, "off") == 0 ||
604 strwicmp(boolean_string, "0") == 0) {
612 * Parse a string containing a boolean value.
614 * val will be set to the read value.
616 * @retval true if a boolean value was parsed, false otherwise.
618 _PUBLIC_ bool conv_str_bool(const char * str, bool * val)
623 if (str == NULL || *str == '\0') {
627 lval = strtol(str, &end, 10 /* base */);
628 if (end == NULL || *end != '\0' || end == str) {
629 return set_boolean(str, val);
632 *val = (lval) ? true : false;
637 * Convert a size specification like 16K into an integral number of bytes.
639 _PUBLIC_ bool conv_str_size(const char * str, uint64_t * val)
642 unsigned long long lval;
644 if (str == NULL || *str == '\0') {
648 lval = strtoull(str, &end, 10 /* base */);
649 if (end == NULL || end == str) {
654 if (strwicmp(end, "K") == 0) {
656 } else if (strwicmp(end, "M") == 0) {
657 lval *= (1024ULL * 1024ULL);
658 } else if (strwicmp(end, "G") == 0) {
659 lval *= (1024ULL * 1024ULL * 1024ULL);
660 } else if (strwicmp(end, "T") == 0) {
661 lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL);
662 } else if (strwicmp(end, "P") == 0) {
663 lval *= (1024ULL * 1024ULL * 1024ULL * 1024ULL * 1024ULL);
669 *val = (uint64_t)lval;
674 * Parse a uint64_t value from a string
676 * val will be set to the value read.
678 * @retval true if parsing was successful, false otherwise
680 _PUBLIC_ bool conv_str_u64(const char * str, uint64_t * val)
683 unsigned long long lval;
685 if (str == NULL || *str == '\0') {
689 lval = strtoull(str, &end, 10 /* base */);
690 if (end == NULL || *end != '\0' || end == str) {
694 *val = (uint64_t)lval;
699 return the number of bytes occupied by a buffer in CH_UTF16 format
700 the result includes the null termination
702 _PUBLIC_ size_t utf16_len(const void *buf)
706 for (len = 0; SVAL(buf,len); len += 2) ;
712 return the number of bytes occupied by a buffer in CH_UTF16 format
713 the result includes the null termination
716 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
720 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
729 _PUBLIC_ size_t ucs2_align(const void *base_ptr, const void *p, int flags)
731 if (flags & (STR_NOALIGN|STR_ASCII))
733 return PTR_DIFF(p, base_ptr) & 1;
737 Do a case-insensitive, whitespace-ignoring string compare.
739 _PUBLIC_ int strwicmp(const char *psz1, const char *psz2)
741 /* if BOTH strings are NULL, return TRUE, if ONE is NULL return */
742 /* appropriate value. */
745 else if (psz1 == NULL)
747 else if (psz2 == NULL)
750 /* sync the strings on first non-whitespace */
752 while (isspace((int)*psz1))
754 while (isspace((int)*psz2))
756 if (toupper((unsigned char)*psz1) != toupper((unsigned char)*psz2)
763 return (*psz1 - *psz2);
769 _PUBLIC_ void string_replace(char *s, char oldc, char newc)
772 if (*s == oldc) *s = newc;
780 * @note The comparison is case-insensitive.
782 _PUBLIC_ bool strequal(const char *s1, const char *s2)
789 return strcasecmp(s1,s2) == 0;