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/>.
26 #include "lib/param/loadparm.h"
28 const char toupper_ascii_fast_table
[128] = {
29 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf,
30 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
31 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
32 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
33 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
34 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
35 0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
36 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f
40 * Compare 2 strings up to and including the nth char.
42 * @note The comparison is case-insensitive.
44 bool strnequal(const char *s1
,const char *s2
,size_t n
)
51 return(strncasecmp_m(s1
,s2
,n
)==0);
55 Convert a string to "normal" form.
58 bool strnorm(char *s
, int case_default
)
60 if (case_default
== CASE_UPPER
)
64 return true; /* FIXME - return strlower_m value later. */
68 * Skip past some strings in a buffer - old version - no checks.
71 char *push_skip_string(char *buf
)
73 buf
+= strlen(buf
) + 1;
78 Skip past a string in a buffer. Buffer may not be
79 null terminated. end_ptr points to the first byte after
80 then end of the buffer.
83 char *skip_string(const char *base
, size_t len
, char *buf
)
85 const char *end_ptr
= base
+ len
;
87 if (end_ptr
< base
|| !base
|| !buf
|| buf
>= end_ptr
) {
104 Count the number of characters in a string. Normally this will
105 be the same as the number of bytes in a string for single byte strings,
106 but will be different for multibyte.
109 size_t str_charnum(const char *s
)
111 size_t ret
, converted_size
;
112 smb_ucs2_t
*tmpbuf2
= NULL
;
113 if (!push_ucs2_talloc(talloc_tos(), &tmpbuf2
, s
, &converted_size
)) {
116 ret
= strlen_w(tmpbuf2
);
117 TALLOC_FREE(tmpbuf2
);
121 bool trim_char(char *s
,char cfront
,char cback
)
127 /* Ignore null or empty strings. */
128 if (!s
|| (s
[0] == '\0'))
132 while (*fp
&& *fp
== cfront
)
135 /* We ate the string. */
143 ep
= fp
+ strlen(fp
) - 1;
145 /* Attempt ascii only. Bail for mb strings. */
146 while ((ep
>= fp
) && (*ep
== cback
)) {
148 if ((ep
> fp
) && (((unsigned char)ep
[-1]) & 0x80)) {
149 /* Could be mb... bail back to tim_string. */
157 return trim_string(s
, cfront
? fs
: NULL
, bs
);
163 /* We ate the string. */
170 memmove(s
, fp
, ep
-fp
+2);
175 Like strncpy but always null terminates. Make sure there is room!
176 The variable n should always be one less than the available size.
178 char *StrnCpy(char *dest
,const char *src
,size_t n
)
183 smb_panic("ERROR: NULL dest in StrnCpy");
191 while (n
-- && (*d
= *src
)) {
201 Check if a string is part of a list.
204 bool in_list(const char *s
, const char *list
, bool casesensitive
)
214 frame
= talloc_stackframe();
215 while (next_token_talloc(frame
, &list
, &tok
,LIST_SEP
)) {
217 if (strcmp(tok
,s
) == 0) {
222 if (strcasecmp_m(tok
,s
) == 0) {
233 * Internal guts of talloc_string_sub and talloc_all_string_sub.
234 * talloc version of string_sub2.
237 char *talloc_string_sub2(TALLOC_CTX
*mem_ctx
, const char *src
,
240 bool remove_unsafe_characters
,
242 bool allow_trailing_dollar
)
247 ssize_t ls
,lp
,li
,ld
, i
;
249 if (!insert
|| !pattern
|| !*pattern
|| !src
) {
253 string
= talloc_strdup(mem_ctx
, src
);
254 if (string
== NULL
) {
255 DEBUG(0, ("talloc_string_sub2: "
256 "talloc_strdup failed\n"));
262 in
= talloc_strdup(mem_ctx
, insert
);
264 DEBUG(0, ("talloc_string_sub2: ENOMEM\n"));
267 ls
= (ssize_t
)strlen(s
);
268 lp
= (ssize_t
)strlen(pattern
);
269 li
= (ssize_t
)strlen(insert
);
275 /* allow a trailing $
276 * (as in machine accounts) */
277 if (allow_trailing_dollar
&& (i
== li
- 1 )) {
287 if (remove_unsafe_characters
) {
297 while ((p
= strstr_m(s
,pattern
))) {
299 int offset
= PTR_DIFF(s
,string
);
300 string
= (char *)TALLOC_REALLOC(mem_ctx
, string
,
303 DEBUG(0, ("talloc_string_sub: out of "
308 p
= string
+ offset
+ (p
- s
);
311 memmove(p
+li
,p
+lp
,strlen(p
+lp
)+1);
325 /* Same as string_sub, but returns a talloc'ed string */
327 char *talloc_string_sub(TALLOC_CTX
*mem_ctx
,
332 return talloc_string_sub2(mem_ctx
, src
, pattern
, insert
,
336 char *talloc_all_string_sub(TALLOC_CTX
*ctx
,
341 return talloc_string_sub2(ctx
, src
, pattern
, insert
,
342 false, false, false);
346 Write an octal as a string.
349 char *octal_string(int i
)
353 result
= talloc_strdup(talloc_tos(), "-1");
356 result
= talloc_asprintf(talloc_tos(), "0%o", i
);
358 SMB_ASSERT(result
!= NULL
);
364 Truncate a string at a specified length.
367 char *string_truncate(char *s
, unsigned int length
)
369 if (s
&& strlen(s
) > length
)
375 /***********************************************************************
376 Return the equivalent of doing strrchr 'n' times - always going
378 ***********************************************************************/
380 char *strnrchr_m(const char *s
, char c
, unsigned int n
)
382 smb_ucs2_t
*ws
= NULL
;
386 size_t converted_size
;
388 if (!push_ucs2_talloc(talloc_tos(), &ws
, s
, &converted_size
)) {
389 /* Too hard to try and get right. */
392 p
= strnrchr_w(ws
, UCS2_CHAR(c
), n
);
398 if (!pull_ucs2_talloc(talloc_tos(), &s2
, ws
, &converted_size
)) {
400 /* Too hard to try and get right. */
403 ret
= discard_const_p(char, (s
+strlen(s2
)));
409 static bool unix_strlower(const char *src
, size_t srclen
, char *dest
, size_t destlen
)
412 smb_ucs2_t
*buffer
= NULL
;
415 if (!convert_string_talloc(talloc_tos(), CH_UNIX
, CH_UTF16LE
, src
, srclen
,
416 (void **)(void *)&buffer
, &size
))
418 smb_panic("failed to create UCS2 buffer");
419 /* NOTREACHED. Yet. */
422 if (!strlower_w(buffer
) && (dest
== src
)) {
426 ret
= convert_string(CH_UTF16LE
, CH_UNIX
, buffer
, size
, dest
, destlen
, &size
);
431 #if 0 /* Alternate function that avoid talloc calls for ASCII and non ASCII */
434 Convert a string to lower case.
436 _PUBLIC_
void strlower_m(char *s
)
439 struct smb_iconv_handle
*iconv_handle
;
441 iconv_handle
= get_iconv_handle();
446 size_t c_size
, c_size2
;
447 codepoint_t c
= next_codepoint_handle(iconv_handle
, s
, &c_size
);
448 c_size2
= push_codepoint_handle(iconv_handle
, d
, tolower_m(c
));
449 if (c_size2
> c_size
) {
450 DEBUG(0,("FATAL: codepoint 0x%x (0x%x) expanded from %d to %d bytes in strlower_m\n",
451 c
, tolower_m(c
), (int)c_size
, (int)c_size2
));
452 smb_panic("codepoint expansion in strlower_m\n");
463 Convert a string to lower case.
466 bool strlower_m(char *s
)
472 /* this is quite a common operation, so we want it to be
473 fast. We optimise for the ascii case, knowing that all our
474 supported multi-byte character sets are ascii-compatible
475 (ie. they match for the first 128 chars) */
477 while (*s
&& !(((unsigned char)s
[0]) & 0x80)) {
478 *s
= tolower_m((unsigned char)*s
);
485 /* I assume that lowercased string takes the same number of bytes
486 * as source string even in UTF-8 encoding. (VIV) */
490 ret
= unix_strlower(s
,len
,s
,len
);
491 /* Catch mb conversion errors that may not terminate. */
500 static bool unix_strupper(const char *src
, size_t srclen
, char *dest
, size_t destlen
)
506 if (!push_ucs2_talloc(talloc_tos(), &buffer
, src
, &size
)) {
510 if (!strupper_w(buffer
) && (dest
== src
)) {
515 ret
= convert_string(CH_UTF16LE
, CH_UNIX
, buffer
, size
, dest
, destlen
, &size
);
520 #if 0 /* Alternate function that avoid talloc calls for ASCII and non ASCII */
523 Convert a string to UPPER case.
525 _PUBLIC_
void strupper_m(char *s
)
528 struct smb_iconv_handle
*iconv_handle
;
530 iconv_handle
= get_iconv_handle();
535 size_t c_size
, c_size2
;
536 codepoint_t c
= next_codepoint_handle(iconv_handle
, s
, &c_size
);
537 c_size2
= push_codepoint_handle(iconv_handle
, d
, toupper_m(c
));
538 if (c_size2
> c_size
) {
539 DEBUG(0,("FATAL: codepoint 0x%x (0x%x) expanded from %d to %d bytes in strupper_m\n",
540 c
, toupper_m(c
), (int)c_size
, (int)c_size2
));
541 smb_panic("codepoint expansion in strupper_m\n");
552 Convert a string to upper case.
555 bool strupper_m(char *s
)
561 /* this is quite a common operation, so we want it to be
562 fast. We optimise for the ascii case, knowing that all our
563 supported multi-byte character sets are ascii-compatible
564 (ie. they match for the first 128 chars) */
566 while (*s
&& !(((unsigned char)s
[0]) & 0x80)) {
567 *s
= toupper_ascii_fast((unsigned char)*s
);
574 /* I assume that lowercased string takes the same number of bytes
575 * as source string even in multibyte encoding. (VIV) */
579 ret
= unix_strupper(s
,len
,s
,len
);
580 /* Catch mb conversion errors that may not terminate. */
589 Just a typesafety wrapper for snprintf into a fstring.
592 int fstr_sprintf(fstring s
, const char *fmt
, ...)
598 ret
= vsnprintf(s
, FSTRING_LEN
, fmt
, ap
);
604 List of Strings manipulation functions
607 #define S_LIST_ABS 16 /* List Allocation Block Size */
609 /******************************************************************************
610 substitute a specific pattern in a string list
611 *****************************************************************************/
613 bool str_list_substitute(char **list
, const char *pattern
, const char *insert
)
615 TALLOC_CTX
*ctx
= list
;
617 ssize_t ls
, lp
, li
, ld
, i
, d
;
626 lp
= (ssize_t
)strlen(pattern
);
627 li
= (ssize_t
)strlen(insert
);
632 ls
= (ssize_t
)strlen(s
);
634 while ((p
= strstr_m(s
, pattern
))) {
638 t
= talloc_array(ctx
, char, ls
+ld
+1);
640 DEBUG(0,("str_list_substitute: "
641 "Unable to allocate memory"));
645 memcpy(t
+d
+li
, p
+lp
, ls
-d
-lp
+1);
652 for (i
= 0; i
< li
; i
++) {
677 #define IPSTR_LIST_SEP ","
678 #define IPSTR_LIST_CHAR ','
681 * Add ip string representation to ipstr list. Used also
682 * as part of @function ipstr_list_make
684 * @param ipstr_list pointer to string containing ip list;
685 * MUST BE already allocated and IS reallocated if necessary
686 * @param ipstr_size pointer to current size of ipstr_list (might be changed
687 * as a result of reallocation)
688 * @param ip IP address which is to be added to list
689 * @return pointer to string appended with new ip and possibly
690 * reallocated to new length
693 static char *ipstr_list_add(char **ipstr_list
, const struct ip_service
*service
)
695 char *new_ipstr
= NULL
;
696 char addr_buf
[INET6_ADDRSTRLEN
];
699 /* arguments checking */
700 if (!ipstr_list
|| !service
) {
704 print_sockaddr(addr_buf
,
708 /* attempt to convert ip to a string and append colon separator to it */
710 if (service
->ss
.ss_family
== AF_INET
) {
712 ret
= asprintf(&new_ipstr
, "%s%s%s:%d", *ipstr_list
,
713 IPSTR_LIST_SEP
, addr_buf
,
717 ret
= asprintf(&new_ipstr
, "%s%s[%s]:%d", *ipstr_list
,
718 IPSTR_LIST_SEP
, addr_buf
,
721 SAFE_FREE(*ipstr_list
);
723 if (service
->ss
.ss_family
== AF_INET
) {
725 ret
= asprintf(&new_ipstr
, "%s:%d", addr_buf
,
729 ret
= asprintf(&new_ipstr
, "[%s]:%d", addr_buf
,
736 *ipstr_list
= new_ipstr
;
741 * Allocate and initialise an ipstr list using ip adresses
742 * passed as arguments.
744 * @param ipstr_list pointer to string meant to be allocated and set
745 * @param ip_list array of ip addresses to place in the list
746 * @param ip_count number of addresses stored in ip_list
747 * @return pointer to allocated ip string
750 char *ipstr_list_make(char **ipstr_list
,
751 const struct ip_service
*ip_list
,
756 /* arguments checking */
757 if (!ip_list
|| !ipstr_list
) {
763 /* process ip addresses given as arguments */
764 for (i
= 0; i
< ip_count
; i
++) {
765 *ipstr_list
= ipstr_list_add(ipstr_list
, &ip_list
[i
]);
768 return (*ipstr_list
);
773 * Parse given ip string list into array of ip addresses
774 * (as ip_service structures)
775 * e.g. [IPv6]:port,192.168.1.100:389,192.168.1.78, ...
777 * @param ipstr ip string list to be parsed
778 * @param ip_list pointer to array of ip addresses which is
779 * allocated by this function and must be freed by caller
780 * @return number of successfully parsed addresses
783 int ipstr_list_parse(const char *ipstr_list
, struct ip_service
**ip_list
)
786 char *token_str
= NULL
;
790 if (!ipstr_list
|| !ip_list
)
793 count
= count_chars(ipstr_list
, IPSTR_LIST_CHAR
) + 1;
794 if ( (*ip_list
= SMB_MALLOC_ARRAY(struct ip_service
, count
)) == NULL
) {
795 DEBUG(0,("ipstr_list_parse: malloc failed for %lu entries\n",
796 (unsigned long)count
));
800 frame
= talloc_stackframe();
801 for ( i
=0; next_token_talloc(frame
, &ipstr_list
, &token_str
,
802 IPSTR_LIST_SEP
) && i
<count
; i
++ ) {
804 char *p
= strrchr(token_str
, ':');
808 (*ip_list
)[i
].port
= atoi(p
+1);
811 /* convert single token to ip address */
812 if (token_str
[0] == '[') {
815 p
= strchr(token_str
, ']');
821 if (!interpret_string_addr(&(*ip_list
)[i
].ss
,
832 * Safely free ip string list
834 * @param ipstr_list ip string list to be freed
837 void ipstr_list_free(char* ipstr_list
)
839 SAFE_FREE(ipstr_list
);
842 /* read a SMB_BIG_UINT from a string */
843 uint64_t STR_TO_SMB_BIG_UINT(const char *nptr
, const char **entptr
)
846 uint64_t val
= (uint64_t)-1;
847 const char *p
= nptr
;
856 while (*p
&& isspace(*p
))
859 sscanf(p
,"%"PRIu64
,&val
);
861 while (*p
&& isdigit(*p
))
869 /* Convert a size specification to a count of bytes. We accept the following
871 * bytes if there is no suffix
876 * pP whatever the ISO name for petabytes is
878 * Returns 0 if the string can't be converted.
880 uint64_t conv_str_size(const char * str
)
885 if (str
== NULL
|| *str
== '\0') {
889 lval
= strtoull(str
, &end
, 10 /* base */);
891 if (end
== NULL
|| end
== str
) {
899 if (strwicmp(end
, "K") == 0) {
901 } else if (strwicmp(end
, "M") == 0) {
902 lval
*= (1024ULL * 1024ULL);
903 } else if (strwicmp(end
, "G") == 0) {
904 lval
*= (1024ULL * 1024ULL *
906 } else if (strwicmp(end
, "T") == 0) {
907 lval
*= (1024ULL * 1024ULL *
909 } else if (strwicmp(end
, "P") == 0) {
910 lval
*= (1024ULL * 1024ULL *
920 /* Append an sprintf'ed string. Double buffer size on demand. Usable without
921 * error checking in between. The indiation that something weird happened is
924 void sprintf_append(TALLOC_CTX
*mem_ctx
, char **string
, ssize_t
*len
,
925 size_t *bufsize
, const char *fmt
, ...)
932 /* len<0 is an internal marker that something failed */
936 if (*string
== NULL
) {
940 *string
= talloc_array(mem_ctx
, char, *bufsize
);
946 ret
= vasprintf(&newstr
, fmt
, ap
);
954 while ((*len
)+ret
>= *bufsize
) {
957 if (*bufsize
>= (1024*1024*256))
962 *string
= talloc_realloc(mem_ctx
, *string
, char,
964 if (*string
== NULL
) {
969 StrnCpy((*string
)+(*len
), newstr
, ret
);
980 * asprintf into a string and strupper_m it after that.
983 int asprintf_strupper_m(char **strp
, const char *fmt
, ...)
990 ret
= vasprintf(&result
, fmt
, ap
);
996 if (!strupper_m(result
)) {
1005 char *talloc_asprintf_strupper_m(TALLOC_CTX
*t
, const char *fmt
, ...)
1011 ret
= talloc_vasprintf(t
, fmt
, ap
);
1017 if (!strupper_m(ret
)) {
1024 char *talloc_asprintf_strlower_m(TALLOC_CTX
*t
, const char *fmt
, ...)
1030 ret
= talloc_vasprintf(t
, fmt
, ap
);
1041 /********************************************************************
1042 Check a string for any occurrences of a specified list of invalid
1044 ********************************************************************/
1046 bool validate_net_name( const char *name
,
1047 const char *invalid_chars
,
1056 for ( i
=0; i
<max_len
&& name
[i
]; i
++ ) {
1057 /* fail if strchr_m() finds one of the invalid characters */
1058 if ( name
[i
] && strchr_m( invalid_chars
, name
[i
] ) ) {
1067 /*******************************************************************
1068 Add a shell escape character '\' to any character not in a known list
1069 of characters. UNIX charset format.
1070 *******************************************************************/
1072 #define INCLUDE_LIST "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_/ \t.,"
1073 #define INSIDE_DQUOTE_LIST "$`\n\"\\"
1075 char *escape_shell_string(const char *src
)
1077 size_t srclen
= strlen(src
);
1078 char *ret
= SMB_MALLOC_ARRAY(char, (srclen
* 2) + 1);
1080 bool in_s_quote
= false;
1081 bool in_d_quote
= false;
1082 bool next_escaped
= false;
1090 codepoint_t c
= next_codepoint(src
, &c_size
);
1092 if (c
== INVALID_CODEPOINT
) {
1098 memcpy(dest
, src
, c_size
);
1101 next_escaped
= false;
1106 * Deal with backslash escaped state.
1107 * This only lasts for one character.
1112 next_escaped
= false;
1117 * Deal with single quote state. The
1118 * only thing we care about is exiting
1131 * Deal with double quote state. The most
1132 * complex state. We must cope with \, meaning
1133 * possibly escape next char (depending what it
1134 * is), ", meaning exit this state, and possibly
1135 * add an \ escape to any unprotected character
1136 * (listed in INSIDE_DQUOTE_LIST).
1142 * Next character might be escaped.
1143 * We have to peek. Inside double
1144 * quotes only INSIDE_DQUOTE_LIST
1145 * characters are escaped by a \.
1150 c
= next_codepoint(&src
[1], &c_size
);
1151 if (c
== INVALID_CODEPOINT
) {
1157 * Don't escape the next char.
1166 if (nextchar
&& strchr(INSIDE_DQUOTE_LIST
,
1168 next_escaped
= true;
1175 /* Exit double quote state. */
1182 * We know the character isn't \ or ",
1183 * so escape it if it's any of the other
1184 * possible unprotected characters.
1187 if (strchr(INSIDE_DQUOTE_LIST
, (int)*src
)) {
1195 * From here to the end of the loop we're
1196 * not in the single or double quote state.
1200 /* Next character must be escaped. */
1201 next_escaped
= true;
1207 /* Go into single quote state. */
1214 /* Go into double quote state. */
1220 /* Check if we need to escape the character. */
1222 if (!strchr(INCLUDE_LIST
, (int)*src
)) {
1231 /***************************************************
1232 str_list_make, v3 version. The v4 version does not
1233 look at quoted strings with embedded blanks, so
1234 do NOT merge this function please!
1235 ***************************************************/
1237 #define S_LIST_ABS 16 /* List Allocation Block Size */
1239 char **str_list_make_v3(TALLOC_CTX
*mem_ctx
, const char *string
,
1247 if (!string
|| !*string
)
1250 list
= talloc_array(mem_ctx
, char *, S_LIST_ABS
+1);
1256 s
= talloc_strdup(list
, string
);
1258 DEBUG(0,("str_list_make: Unable to allocate memory"));
1262 if (!sep
) sep
= LIST_SEP
;
1267 while (next_token_talloc(list
, &str
, &tok
, sep
)) {
1272 lsize
+= S_LIST_ABS
;
1274 tmp
= talloc_realloc(mem_ctx
, list
, char *,
1277 DEBUG(0,("str_list_make: "
1278 "Unable to allocate memory"));
1285 memset (&list
[num
], 0,
1286 ((sizeof(char**)) * (S_LIST_ABS
+1)));