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 2006
9 Copyright (C) Jeremy Allison 1992-2007
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
27 const char toupper_ascii_fast_table[128] = {
28 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf,
29 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
30 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
31 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
32 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
33 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
34 0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
35 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f
39 * Compare 2 strings up to and including the nth char.
41 * @note The comparison is case-insensitive.
43 bool strnequal(const char *s1,const char *s2,size_t n)
50 return(strncasecmp_m(s1,s2,n)==0);
54 Convert a string to "normal" form.
57 void strnorm(char *s, int case_default)
59 if (case_default == CASE_UPPER)
66 * Skip past some strings in a buffer - old version - no checks.
69 char *push_skip_string(char *buf)
71 buf += strlen(buf) + 1;
76 Skip past a string in a buffer. Buffer may not be
77 null terminated. end_ptr points to the first byte after
78 then end of the buffer.
81 char *skip_string(const char *base, size_t len, char *buf)
83 const char *end_ptr = base + len;
85 if (end_ptr < base || !base || !buf || buf >= end_ptr) {
102 Count the number of characters in a string. Normally this will
103 be the same as the number of bytes in a string for single byte strings,
104 but will be different for multibyte.
107 size_t str_charnum(const char *s)
109 size_t ret, converted_size;
110 smb_ucs2_t *tmpbuf2 = NULL;
111 if (!push_ucs2_talloc(talloc_tos(), &tmpbuf2, s, &converted_size)) {
114 ret = strlen_w(tmpbuf2);
115 TALLOC_FREE(tmpbuf2);
119 bool trim_char(char *s,char cfront,char cback)
125 /* Ignore null or empty strings. */
126 if (!s || (s[0] == '\0'))
130 while (*fp && *fp == cfront)
133 /* We ate the string. */
141 ep = fp + strlen(fp) - 1;
143 /* Attempt ascii only. Bail for mb strings. */
144 while ((ep >= fp) && (*ep == cback)) {
146 if ((ep > fp) && (((unsigned char)ep[-1]) & 0x80)) {
147 /* Could be mb... bail back to tim_string. */
155 return trim_string(s, cfront ? fs : NULL, bs);
161 /* We ate the string. */
168 memmove(s, fp, ep-fp+2);
173 Like strncpy but always null terminates. Make sure there is room!
174 The variable n should always be one less than the available size.
176 char *StrnCpy(char *dest,const char *src,size_t n)
181 smb_panic("ERROR: NULL dest in StrnCpy");
189 while (n-- && (*d = *src)) {
199 Check if a string is part of a list.
202 bool in_list(const char *s, const char *list, bool casesensitive)
212 frame = talloc_stackframe();
213 while (next_token_talloc(frame, &list, &tok,LIST_SEP)) {
215 if (strcmp(tok,s) == 0) {
220 if (strcasecmp_m(tok,s) == 0) {
231 * Internal guts of talloc_string_sub and talloc_all_string_sub.
232 * talloc version of string_sub2.
235 char *talloc_string_sub2(TALLOC_CTX *mem_ctx, const char *src,
238 bool remove_unsafe_characters,
240 bool allow_trailing_dollar)
245 ssize_t ls,lp,li,ld, i;
247 if (!insert || !pattern || !*pattern || !src) {
251 string = talloc_strdup(mem_ctx, src);
252 if (string == NULL) {
253 DEBUG(0, ("talloc_string_sub2: "
254 "talloc_strdup failed\n"));
260 in = talloc_strdup(mem_ctx, insert);
262 DEBUG(0, ("talloc_string_sub2: ENOMEM\n"));
265 ls = (ssize_t)strlen(s);
266 lp = (ssize_t)strlen(pattern);
267 li = (ssize_t)strlen(insert);
273 /* allow a trailing $
274 * (as in machine accounts) */
275 if (allow_trailing_dollar && (i == li - 1 )) {
285 if (remove_unsafe_characters) {
295 while ((p = strstr_m(s,pattern))) {
297 int offset = PTR_DIFF(s,string);
298 string = (char *)TALLOC_REALLOC(mem_ctx, string,
301 DEBUG(0, ("talloc_string_sub: out of "
306 p = string + offset + (p - s);
309 memmove(p+li,p+lp,strlen(p+lp)+1);
323 /* Same as string_sub, but returns a talloc'ed string */
325 char *talloc_string_sub(TALLOC_CTX *mem_ctx,
330 return talloc_string_sub2(mem_ctx, src, pattern, insert,
334 char *talloc_all_string_sub(TALLOC_CTX *ctx,
339 return talloc_string_sub2(ctx, src, pattern, insert,
340 false, false, false);
344 Write an octal as a string.
347 char *octal_string(int i)
351 result = talloc_strdup(talloc_tos(), "-1");
354 result = talloc_asprintf(talloc_tos(), "0%o", i);
356 SMB_ASSERT(result != NULL);
362 Truncate a string at a specified length.
365 char *string_truncate(char *s, unsigned int length)
367 if (s && strlen(s) > length)
373 /***********************************************************************
374 Return the equivalent of doing strrchr 'n' times - always going
376 ***********************************************************************/
378 char *strnrchr_m(const char *s, char c, unsigned int n)
380 smb_ucs2_t *ws = NULL;
384 size_t converted_size;
386 if (!push_ucs2_talloc(talloc_tos(), &ws, s, &converted_size)) {
387 /* Too hard to try and get right. */
390 p = strnrchr_w(ws, UCS2_CHAR(c), n);
396 if (!pull_ucs2_talloc(talloc_tos(), &s2, ws, &converted_size)) {
398 /* Too hard to try and get right. */
401 ret = discard_const_p(char, (s+strlen(s2)));
407 static bool unix_strlower(const char *src, size_t srclen, char *dest, size_t destlen)
410 smb_ucs2_t *buffer = NULL;
413 if (!convert_string_talloc(talloc_tos(), CH_UNIX, CH_UTF16LE, src, srclen,
414 (void **)(void *)&buffer, &size))
416 smb_panic("failed to create UCS2 buffer");
418 if (!strlower_w(buffer) && (dest == src)) {
422 ret = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, &size);
427 #if 0 /* Alternate function that avoid talloc calls for ASCII and non ASCII */
430 Convert a string to lower case.
432 _PUBLIC_ void strlower_m(char *s)
435 struct smb_iconv_handle *iconv_handle;
437 iconv_handle = get_iconv_handle();
442 size_t c_size, c_size2;
443 codepoint_t c = next_codepoint_handle(iconv_handle, s, &c_size);
444 c_size2 = push_codepoint_handle(iconv_handle, d, tolower_m(c));
445 if (c_size2 > c_size) {
446 DEBUG(0,("FATAL: codepoint 0x%x (0x%x) expanded from %d to %d bytes in strlower_m\n",
447 c, tolower_m(c), (int)c_size, (int)c_size2));
448 smb_panic("codepoint expansion in strlower_m\n");
459 Convert a string to lower case.
462 void strlower_m(char *s)
467 /* this is quite a common operation, so we want it to be
468 fast. We optimise for the ascii case, knowing that all our
469 supported multi-byte character sets are ascii-compatible
470 (ie. they match for the first 128 chars) */
472 while (*s && !(((unsigned char)s[0]) & 0x80)) {
473 *s = tolower_ascii((unsigned char)*s);
480 /* I assume that lowercased string takes the same number of bytes
481 * as source string even in UTF-8 encoding. (VIV) */
485 unix_strlower(s,len,s,len);
486 /* Catch mb conversion errors that may not terminate. */
492 static bool unix_strupper(const char *src, size_t srclen, char *dest, size_t destlen)
498 if (!push_ucs2_talloc(talloc_tos(), &buffer, src, &size)) {
502 if (!strupper_w(buffer) && (dest == src)) {
507 ret = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, &size);
512 #if 0 /* Alternate function that avoid talloc calls for ASCII and non ASCII */
515 Convert a string to UPPER case.
517 _PUBLIC_ void strupper_m(char *s)
520 struct smb_iconv_handle *iconv_handle;
522 iconv_handle = get_iconv_handle();
527 size_t c_size, c_size2;
528 codepoint_t c = next_codepoint_handle(iconv_handle, s, &c_size);
529 c_size2 = push_codepoint_handle(iconv_handle, d, toupper_m(c));
530 if (c_size2 > c_size) {
531 DEBUG(0,("FATAL: codepoint 0x%x (0x%x) expanded from %d to %d bytes in strupper_m\n",
532 c, toupper_m(c), (int)c_size, (int)c_size2));
533 smb_panic("codepoint expansion in strupper_m\n");
544 Convert a string to upper case.
547 void strupper_m(char *s)
552 /* this is quite a common operation, so we want it to be
553 fast. We optimise for the ascii case, knowing that all our
554 supported multi-byte character sets are ascii-compatible
555 (ie. they match for the first 128 chars) */
557 while (*s && !(((unsigned char)s[0]) & 0x80)) {
558 *s = toupper_ascii_fast((unsigned char)*s);
565 /* I assume that lowercased string takes the same number of bytes
566 * as source string even in multibyte encoding. (VIV) */
570 unix_strupper(s,len,s,len);
571 /* Catch mb conversion errors that may not terminate. */
578 Just a typesafety wrapper for snprintf into a fstring.
581 int fstr_sprintf(fstring s, const char *fmt, ...)
587 ret = vsnprintf(s, FSTRING_LEN, fmt, ap);
593 List of Strings manipulation functions
596 #define S_LIST_ABS 16 /* List Allocation Block Size */
598 /******************************************************************************
599 substitute a specific pattern in a string list
600 *****************************************************************************/
602 bool str_list_substitute(char **list, const char *pattern, const char *insert)
604 TALLOC_CTX *ctx = list;
606 ssize_t ls, lp, li, ld, i, d;
615 lp = (ssize_t)strlen(pattern);
616 li = (ssize_t)strlen(insert);
621 ls = (ssize_t)strlen(s);
623 while ((p = strstr_m(s, pattern))) {
627 t = talloc_array(ctx, char, ls +ld +1);
629 DEBUG(0,("str_list_substitute: "
630 "Unable to allocate memory"));
634 memcpy(t +d +li, p +lp, ls -d -lp +1);
641 for (i = 0; i < li; i++) {
666 #define IPSTR_LIST_SEP ","
667 #define IPSTR_LIST_CHAR ','
670 * Add ip string representation to ipstr list. Used also
671 * as part of @function ipstr_list_make
673 * @param ipstr_list pointer to string containing ip list;
674 * MUST BE already allocated and IS reallocated if necessary
675 * @param ipstr_size pointer to current size of ipstr_list (might be changed
676 * as a result of reallocation)
677 * @param ip IP address which is to be added to list
678 * @return pointer to string appended with new ip and possibly
679 * reallocated to new length
682 static char *ipstr_list_add(char **ipstr_list, const struct ip_service *service)
684 char *new_ipstr = NULL;
685 char addr_buf[INET6_ADDRSTRLEN];
688 /* arguments checking */
689 if (!ipstr_list || !service) {
693 print_sockaddr(addr_buf,
697 /* attempt to convert ip to a string and append colon separator to it */
699 if (service->ss.ss_family == AF_INET) {
701 ret = asprintf(&new_ipstr, "%s%s%s:%d", *ipstr_list,
702 IPSTR_LIST_SEP, addr_buf,
706 ret = asprintf(&new_ipstr, "%s%s[%s]:%d", *ipstr_list,
707 IPSTR_LIST_SEP, addr_buf,
710 SAFE_FREE(*ipstr_list);
712 if (service->ss.ss_family == AF_INET) {
714 ret = asprintf(&new_ipstr, "%s:%d", addr_buf,
718 ret = asprintf(&new_ipstr, "[%s]:%d", addr_buf,
725 *ipstr_list = new_ipstr;
730 * Allocate and initialise an ipstr list using ip adresses
731 * passed as arguments.
733 * @param ipstr_list pointer to string meant to be allocated and set
734 * @param ip_list array of ip addresses to place in the list
735 * @param ip_count number of addresses stored in ip_list
736 * @return pointer to allocated ip string
739 char *ipstr_list_make(char **ipstr_list,
740 const struct ip_service *ip_list,
745 /* arguments checking */
746 if (!ip_list || !ipstr_list) {
752 /* process ip addresses given as arguments */
753 for (i = 0; i < ip_count; i++) {
754 *ipstr_list = ipstr_list_add(ipstr_list, &ip_list[i]);
757 return (*ipstr_list);
762 * Parse given ip string list into array of ip addresses
763 * (as ip_service structures)
764 * e.g. [IPv6]:port,192.168.1.100:389,192.168.1.78, ...
766 * @param ipstr ip string list to be parsed
767 * @param ip_list pointer to array of ip addresses which is
768 * allocated by this function and must be freed by caller
769 * @return number of successfully parsed addresses
772 int ipstr_list_parse(const char *ipstr_list, struct ip_service **ip_list)
775 char *token_str = NULL;
779 if (!ipstr_list || !ip_list)
782 count = count_chars(ipstr_list, IPSTR_LIST_CHAR) + 1;
783 if ( (*ip_list = SMB_MALLOC_ARRAY(struct ip_service, count)) == NULL ) {
784 DEBUG(0,("ipstr_list_parse: malloc failed for %lu entries\n",
785 (unsigned long)count));
789 frame = talloc_stackframe();
790 for ( i=0; next_token_talloc(frame, &ipstr_list, &token_str,
791 IPSTR_LIST_SEP) && i<count; i++ ) {
793 char *p = strrchr(token_str, ':');
797 (*ip_list)[i].port = atoi(p+1);
800 /* convert single token to ip address */
801 if (token_str[0] == '[') {
804 p = strchr(token_str, ']');
810 if (!interpret_string_addr(&(*ip_list)[i].ss,
821 * Safely free ip string list
823 * @param ipstr_list ip string list to be freed
826 void ipstr_list_free(char* ipstr_list)
828 SAFE_FREE(ipstr_list);
831 /* read a SMB_BIG_UINT from a string */
832 uint64_t STR_TO_SMB_BIG_UINT(const char *nptr, const char **entptr)
835 uint64_t val = (uint64_t)-1;
836 const char *p = nptr;
845 while (*p && isspace(*p))
848 sscanf(p,"%"PRIu64,&val);
850 while (*p && isdigit(*p))
858 /* Convert a size specification to a count of bytes. We accept the following
860 * bytes if there is no suffix
865 * pP whatever the ISO name for petabytes is
867 * Returns 0 if the string can't be converted.
869 uint64_t conv_str_size(const char * str)
874 if (str == NULL || *str == '\0') {
878 lval = strtoull(str, &end, 10 /* base */);
880 if (end == NULL || end == str) {
888 if (strwicmp(end, "K") == 0) {
890 } else if (strwicmp(end, "M") == 0) {
891 lval *= (1024ULL * 1024ULL);
892 } else if (strwicmp(end, "G") == 0) {
893 lval *= (1024ULL * 1024ULL *
895 } else if (strwicmp(end, "T") == 0) {
896 lval *= (1024ULL * 1024ULL *
898 } else if (strwicmp(end, "P") == 0) {
899 lval *= (1024ULL * 1024ULL *
909 /* Append an sprintf'ed string. Double buffer size on demand. Usable without
910 * error checking in between. The indiation that something weird happened is
913 void sprintf_append(TALLOC_CTX *mem_ctx, char **string, ssize_t *len,
914 size_t *bufsize, const char *fmt, ...)
921 /* len<0 is an internal marker that something failed */
925 if (*string == NULL) {
929 *string = talloc_array(mem_ctx, char, *bufsize);
935 ret = vasprintf(&newstr, fmt, ap);
943 while ((*len)+ret >= *bufsize) {
946 if (*bufsize >= (1024*1024*256))
951 *string = talloc_realloc(mem_ctx, *string, char,
953 if (*string == NULL) {
958 StrnCpy((*string)+(*len), newstr, ret);
969 * asprintf into a string and strupper_m it after that.
972 int asprintf_strupper_m(char **strp, const char *fmt, ...)
979 ret = vasprintf(&result, fmt, ap);
990 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...)
996 ret = talloc_vasprintf(t, fmt, ap);
1006 char *talloc_asprintf_strlower_m(TALLOC_CTX *t, const char *fmt, ...)
1012 ret = talloc_vasprintf(t, fmt, ap);
1023 /********************************************************************
1024 Check a string for any occurrences of a specified list of invalid
1026 ********************************************************************/
1028 bool validate_net_name( const char *name,
1029 const char *invalid_chars,
1038 for ( i=0; i<max_len && name[i]; i++ ) {
1039 /* fail if strchr_m() finds one of the invalid characters */
1040 if ( name[i] && strchr_m( invalid_chars, name[i] ) ) {
1049 /*******************************************************************
1050 Add a shell escape character '\' to any character not in a known list
1051 of characters. UNIX charset format.
1052 *******************************************************************/
1054 #define INCLUDE_LIST "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_/ \t.,"
1055 #define INSIDE_DQUOTE_LIST "$`\n\"\\"
1057 char *escape_shell_string(const char *src)
1059 size_t srclen = strlen(src);
1060 char *ret = SMB_MALLOC_ARRAY(char, (srclen * 2) + 1);
1062 bool in_s_quote = false;
1063 bool in_d_quote = false;
1064 bool next_escaped = false;
1072 codepoint_t c = next_codepoint(src, &c_size);
1074 if (c == INVALID_CODEPOINT) {
1080 memcpy(dest, src, c_size);
1083 next_escaped = false;
1088 * Deal with backslash escaped state.
1089 * This only lasts for one character.
1094 next_escaped = false;
1099 * Deal with single quote state. The
1100 * only thing we care about is exiting
1113 * Deal with double quote state. The most
1114 * complex state. We must cope with \, meaning
1115 * possibly escape next char (depending what it
1116 * is), ", meaning exit this state, and possibly
1117 * add an \ escape to any unprotected character
1118 * (listed in INSIDE_DQUOTE_LIST).
1124 * Next character might be escaped.
1125 * We have to peek. Inside double
1126 * quotes only INSIDE_DQUOTE_LIST
1127 * characters are escaped by a \.
1132 c = next_codepoint(&src[1], &c_size);
1133 if (c == INVALID_CODEPOINT) {
1139 * Don't escape the next char.
1148 if (nextchar && strchr(INSIDE_DQUOTE_LIST,
1150 next_escaped = true;
1157 /* Exit double quote state. */
1164 * We know the character isn't \ or ",
1165 * so escape it if it's any of the other
1166 * possible unprotected characters.
1169 if (strchr(INSIDE_DQUOTE_LIST, (int)*src)) {
1177 * From here to the end of the loop we're
1178 * not in the single or double quote state.
1182 /* Next character must be escaped. */
1183 next_escaped = true;
1189 /* Go into single quote state. */
1196 /* Go into double quote state. */
1202 /* Check if we need to escape the character. */
1204 if (!strchr(INCLUDE_LIST, (int)*src)) {
1213 /***************************************************
1214 str_list_make, v3 version. The v4 version does not
1215 look at quoted strings with embedded blanks, so
1216 do NOT merge this function please!
1217 ***************************************************/
1219 #define S_LIST_ABS 16 /* List Allocation Block Size */
1221 char **str_list_make_v3(TALLOC_CTX *mem_ctx, const char *string,
1229 if (!string || !*string)
1232 list = talloc_array(mem_ctx, char *, S_LIST_ABS+1);
1238 s = talloc_strdup(list, string);
1240 DEBUG(0,("str_list_make: Unable to allocate memory"));
1244 if (!sep) sep = LIST_SEP;
1249 while (next_token_talloc(list, &str, &tok, sep)) {
1254 lsize += S_LIST_ABS;
1256 tmp = talloc_realloc(mem_ctx, list, char *,
1259 DEBUG(0,("str_list_make: "
1260 "Unable to allocate memory"));
1267 memset (&list[num], 0,
1268 ((sizeof(char**)) * (S_LIST_ABS +1)));
1281 char *sanitize_username(TALLOC_CTX *mem_ctx, const char *username)
1285 alpha_strcpy(tmp, username, ". _-$", sizeof(tmp));
1286 return talloc_strdup(mem_ctx, tmp);