2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2001-2002
6 Copyright (C) Simo Sorce 2001-2011
7 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
8 Copyright (C) James J Myers 2003
9 Copyright (C) Volker Lendecke 2010
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 "system/network.h"
27 #include "system/filesys.h"
28 #include "system/locale.h"
29 #include "system/shmem.h"
30 #include "system/passwd.h"
41 * @brief Misc utility functions
45 Find a suitable temporary directory. The result should be copied immediately
46 as it may be overwritten by a subsequent call.
48 _PUBLIC_ const char *tmpdir(void)
51 if ((p = getenv("TMPDIR")))
58 Create a tmp file, open it and immediately unlink it.
59 If dir is NULL uses tmpdir()
60 Returns the file descriptor or -1 on error.
62 int create_unlink_tmp(const char *dir)
72 fname = talloc_asprintf(talloc_tos(), "%s/listenerlock_XXXXXX", dir);
77 mask = umask(S_IRWXO | S_IRWXG);
84 if (unlink(fname) == -1) {
85 int sys_errno = errno;
97 Check if a file exists - call vfs_file_exist for samba files.
99 _PUBLIC_ bool file_exist(const char *fname)
103 if (stat(fname, &st) != 0) {
107 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
111 Check a files mod time.
114 _PUBLIC_ time_t file_modtime(const char *fname)
118 if (stat(fname,&st) != 0)
125 Check file permissions.
128 _PUBLIC_ bool file_check_permissions(const char *fname,
142 ret = stat(fname, pst);
144 DEBUG(0, ("stat failed on file '%s': %s\n",
145 fname, strerror(errno)));
149 if (pst->st_uid != uid && !uwrap_enabled()) {
150 DEBUG(0, ("invalid ownership of file '%s': "
151 "owned by uid %u, should be %u\n",
152 fname, (unsigned int)pst->st_uid,
157 if ((pst->st_mode & 0777) != file_perms) {
158 DEBUG(0, ("invalid permissions on file "
159 "'%s': has 0%o should be 0%o\n", fname,
160 (unsigned int)(pst->st_mode & 0777),
161 (unsigned int)file_perms));
169 Check if a directory exists.
172 _PUBLIC_ bool directory_exist(const char *dname)
177 if (stat(dname,&st) != 0) {
181 ret = S_ISDIR(st.st_mode);
188 * Try to create the specified directory if it didn't exist.
190 * @retval true if the directory already existed and has the right permissions
191 * or was successfully created.
193 _PUBLIC_ bool directory_create_or_exist(const char *dname,
200 ret = lstat(dname, &st);
204 if (errno != ENOENT) {
205 DEBUG(0, ("lstat failed on directory %s: %s\n",
206 dname, strerror(errno)));
210 /* Create directory */
211 old_umask = umask(0);
212 ret = mkdir(dname, dir_perms);
213 if (ret == -1 && errno != EEXIST) {
214 DEBUG(0, ("mkdir failed on directory "
222 ret = lstat(dname, &st);
224 DEBUG(0, ("lstat failed on created directory %s: %s\n",
225 dname, strerror(errno)));
234 * @brief Try to create a specified directory if it doesn't exist.
236 * The function creates a directory with the given uid and permissions if it
237 * doesn't exist. If it exists it makes sure the uid and permissions are
238 * correct and it will fail if they are different.
240 * @param[in] dname The directory to create.
242 * @param[in] uid The uid the directory needs to belong too.
244 * @param[in] dir_perms The expected permissions of the directory.
246 * @return True on success, false on error.
248 _PUBLIC_ bool directory_create_or_exist_strict(const char *dname,
256 ok = directory_create_or_exist(dname, uid, dir_perms);
261 rc = lstat(dname, &st);
263 DEBUG(0, ("lstat failed on created directory %s: %s\n",
264 dname, strerror(errno)));
268 /* Check ownership and permission on existing directory */
269 if (!S_ISDIR(st.st_mode)) {
270 DEBUG(0, ("directory %s isn't a directory\n",
274 if (st.st_uid != uid && !uwrap_enabled()) {
275 DEBUG(0, ("invalid ownership on directory "
279 if ((st.st_mode & 0777) != dir_perms) {
280 DEBUG(0, ("invalid permissions on directory "
281 "'%s': has 0%o should be 0%o\n", dname,
282 (unsigned int)(st.st_mode & 0777), (unsigned int)dir_perms));
291 Sleep for a specified number of milliseconds.
294 _PUBLIC_ void smb_msleep(unsigned int t)
296 #if defined(HAVE_NANOSLEEP)
301 ts.tv_nsec = 1000000*(t%1000);
305 ret = nanosleep(&ts, &ts);
306 } while (ret < 0 && errno == EINTR && (ts.tv_sec > 0 || ts.tv_nsec > 0));
308 unsigned int tdiff=0;
309 struct timeval tval,t1,t2;
316 tval.tv_sec = (t-tdiff)/1000;
317 tval.tv_usec = 1000*((t-tdiff)%1000);
319 /* Never wait for more than 1 sec. */
320 if (tval.tv_sec > 1) {
327 select(0,&fds,NULL,NULL,&tval);
330 if (t2.tv_sec < t1.tv_sec) {
331 /* Someone adjusted time... */
335 tdiff = usec_time_diff(&t2,&t1)/1000;
341 Get my own name, return in talloc'ed storage.
344 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
347 char hostname[HOST_NAME_MAX];
349 /* get my host name */
350 if (gethostname(hostname, sizeof(hostname)) == -1) {
351 DEBUG(0,("gethostname failed\n"));
355 /* Ensure null termination. */
356 hostname[sizeof(hostname)-1] = '\0';
358 /* split off any parts after an initial . */
359 p = strchr_m(hostname, '.');
364 return talloc_strdup(ctx, hostname);
368 Check if a process exists. Does this work on all unixes?
371 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
373 /* Doing kill with a non-positive pid causes messages to be
374 * sent to places we don't want. */
378 return(kill(pid,0) == 0 || errno != ESRCH);
382 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
383 is dealt with in posix.c
386 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
391 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
394 lock.l_whence = SEEK_SET;
395 lock.l_start = offset;
399 ret = fcntl(fd,op,&lock);
401 if (ret == -1 && errno != 0)
402 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
407 (lock.l_type != F_UNLCK) &&
409 (lock.l_pid != getpid())) {
410 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
414 /* it must be not locked or locked by me */
418 /* a lock set or unset */
420 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
421 (double)offset,(double)count,op,type,strerror(errno)));
425 /* everything went OK */
426 DEBUG(8,("fcntl_lock: Lock call successful\n"));
431 struct debug_channel_level {
436 static void debugadd_channel_cb(const char *buf, void *private_data)
438 struct debug_channel_level *dcl =
439 (struct debug_channel_level *)private_data;
441 DEBUGADDC(dcl->channel, dcl->level,("%s", buf));
444 static void debugadd_cb(const char *buf, void *private_data)
446 int *plevel = (int *)private_data;
447 DEBUGADD(*plevel, ("%s", buf));
450 void print_asc_cb(const uint8_t *buf, int len,
451 void (*cb)(const char *buf, void *private_data),
458 for (i=0; i<len; i++) {
459 s[0] = isprint(buf[i]) ? buf[i] : '.';
464 void print_asc(int level, const uint8_t *buf,int len)
466 print_asc_cb(buf, len, debugadd_cb, &level);
470 * Write dump of binary data to a callback
472 void dump_data_cb(const uint8_t *buf, int len,
473 bool omit_zero_bytes,
474 void (*cb)(const char *buf, void *private_data),
478 static const uint8_t empty[16] = { 0, };
479 bool skipped = false;
487 if ((omit_zero_bytes == true) &&
490 (memcmp(&buf[i], &empty, 16) == 0))
497 snprintf(tmp, sizeof(tmp), "[%04X] ", i);
498 cb(tmp, private_data);
502 snprintf(tmp, sizeof(tmp), "%02X ", (int)buf[i]);
503 cb(tmp, private_data);
506 cb(" ", private_data);
510 print_asc_cb(&buf[i-16], 8, cb, private_data);
511 cb(" ", private_data);
512 print_asc_cb(&buf[i-8], 8, cb, private_data);
513 cb("\n", private_data);
515 if ((omit_zero_bytes == true) &&
517 (memcmp(&buf[i], &empty, 16) == 0)) {
519 cb("skipping zero buffer bytes\n",
530 cb(" ", private_data);
532 cb(" ", private_data);
535 cb(" ", private_data);
538 print_asc_cb(&buf[i-(i%16)], n, cb, private_data);
539 cb(" ", private_data);
542 print_asc_cb(&buf[i-n], n, cb, private_data);
544 cb("\n", private_data);
550 * Write dump of binary data to the log file.
552 * The data is only written if the log level is at least level.
554 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
556 if (!DEBUGLVL(level)) {
559 dump_data_cb(buf, len, false, debugadd_cb, &level);
563 * Write dump of binary data to the log file.
565 * The data is only written if the log level is at least level for
566 * debug class dbgc_class.
568 _PUBLIC_ void dump_data_dbgc(int dbgc_class, int level, const uint8_t *buf, int len)
570 struct debug_channel_level dcl = { dbgc_class, level };
572 if (!DEBUGLVLC(dbgc_class, level)) {
575 dump_data_cb(buf, len, false, debugadd_channel_cb, &dcl);
579 * Write dump of binary data to the log file.
581 * The data is only written if the log level is at least level.
582 * 16 zero bytes in a row are omitted
584 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
586 if (!DEBUGLVL(level)) {
589 dump_data_cb(buf, len, true, debugadd_cb, &level);
592 static void fprintf_cb(const char *buf, void *private_data)
594 FILE *f = (FILE *)private_data;
595 fprintf(f, "%s", buf);
598 void dump_data_file(const uint8_t *buf, int len, bool omit_zero_bytes,
601 dump_data_cb(buf, len, omit_zero_bytes, fprintf_cb, f);
605 malloc that aborts with smb_panic on fail or zero size.
608 _PUBLIC_ void *smb_xmalloc(size_t size)
612 smb_panic("smb_xmalloc: called with zero size.\n");
613 if ((p = malloc(size)) == NULL)
614 smb_panic("smb_xmalloc: malloc fail.\n");
619 Memdup with smb_panic on fail.
622 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
625 p2 = smb_xmalloc(size);
631 strdup that aborts on malloc fail.
634 char *smb_xstrdup(const char *s)
636 #if defined(PARANOID_MALLOC_CHECKER)
643 #define strdup rep_strdup
646 char *s1 = strdup(s);
647 #if defined(PARANOID_MALLOC_CHECKER)
651 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
654 smb_panic("smb_xstrdup: malloc failed");
661 strndup that aborts on malloc fail.
664 char *smb_xstrndup(const char *s, size_t n)
666 #if defined(PARANOID_MALLOC_CHECKER)
672 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
674 #define strndup rep_strndup
677 char *s1 = strndup(s, n);
678 #if defined(PARANOID_MALLOC_CHECKER)
682 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
685 smb_panic("smb_xstrndup: malloc failed");
693 Like strdup but for memory.
696 _PUBLIC_ void *smb_memdup(const void *p, size_t size)
709 * Write a password to the log file.
711 * @note Only actually does something if DEBUG_PASSWORD was defined during
714 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
716 #ifdef DEBUG_PASSWORD
717 DEBUG(11, ("%s", msg));
718 if (data != NULL && len > 0)
720 dump_data(11, data, len);
727 * see if a range of memory is all zero. A NULL pointer is considered
730 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
733 if (!ptr) return true;
734 for (i=0;i<size;i++) {
735 if (ptr[i]) return false;
741 realloc an array, checking for integer overflow in the array size
743 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
745 #define MAX_MALLOC_SIZE 0x7fffffff
747 count >= MAX_MALLOC_SIZE/el_size) {
753 return malloc(el_size * count);
755 return realloc(ptr, el_size * count);
758 /****************************************************************************
760 ****************************************************************************/
762 void *malloc_array(size_t el_size, unsigned int count)
764 return realloc_array(NULL, el_size, count, false);
767 /****************************************************************************
769 ****************************************************************************/
771 void *memalign_array(size_t el_size, size_t align, unsigned int count)
773 if (count*el_size >= MAX_MALLOC_SIZE) {
777 return memalign(align, el_size*count);
780 /****************************************************************************
782 ****************************************************************************/
784 void *calloc_array(size_t size, size_t nmemb)
786 if (nmemb >= MAX_MALLOC_SIZE/size) {
789 if (size == 0 || nmemb == 0) {
792 return calloc(nmemb, size);
796 Trim the specified elements off the front and back of a string.
798 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
805 /* Ignore null or empty strings. */
806 if (!s || (s[0] == '\0'))
809 front_len = front? strlen(front) : 0;
810 back_len = back? strlen(back) : 0;
815 while (len && strncmp(s, front, front_len)==0) {
816 /* Must use memmove here as src & dest can
817 * easily overlap. Found by valgrind. JRA. */
818 memmove(s, s+front_len, (len-front_len)+1);
825 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
826 s[len-back_len]='\0';
835 Find the number of 'c' chars in a string
837 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
842 if (*s == c) count++;
850 * Routine to get hex characters and turn them into a byte array.
851 * the array can be variable length.
852 * - "0xnn" or "0Xnn" is specially catered for.
853 * - The first non-hex-digit character (apart from possibly leading "0x"
854 * finishes the conversion and skips the rest of the input.
855 * - A single hex-digit character at the end of the string is skipped.
857 * valid examples: "0A5D15"; "0x123456"
859 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
862 size_t num_chars = 0;
863 uint8_t lonybble, hinybble;
864 const char *hexchars = "0123456789ABCDEF";
865 char *p1 = NULL, *p2 = NULL;
867 /* skip leading 0x prefix */
868 if (strncasecmp(strhex, "0x", 2) == 0) {
869 i += 2; /* skip two chars */
872 for (; i+1 < strhex_len && strhex[i] != 0 && strhex[i+1] != 0; i++) {
873 p1 = strchr(hexchars, toupper((unsigned char)strhex[i]));
878 i++; /* next hex digit */
880 p2 = strchr(hexchars, toupper((unsigned char)strhex[i]));
885 /* get the two nybbles */
886 hinybble = PTR_DIFF(p1, hexchars);
887 lonybble = PTR_DIFF(p2, hexchars);
889 if (num_chars >= p_len) {
893 p[num_chars] = (hinybble << 4) | lonybble;
903 * Parse a hex string and return a data blob.
905 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
907 DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
909 ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
917 * Print a buf in hex. Assumes dst is at least (srclen*2)+1 large.
919 _PUBLIC_ void hex_encode_buf(char *dst, const uint8_t *src, size_t srclen)
922 for (i=0; i<srclen; i++) {
923 snprintf(dst + i*2, 3, "%02X", src[i]);
926 * Ensure 0-termination for 0-length buffers
928 dst[srclen*2] = '\0';
932 * Routine to print a buffer as HEX digits, into an allocated string.
934 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
938 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
939 hex_buffer = *out_hex_buffer;
940 hex_encode_buf(hex_buffer, buff_in, len);
944 * talloc version of hex_encode()
946 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
950 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
954 hex_encode_buf(hex_buffer, buff_in, len);
955 talloc_set_name_const(hex_buffer, hex_buffer);
960 varient of strcmp() that handles NULL ptrs
962 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
967 if (s1 == NULL || s2 == NULL) {
970 return strcmp(s1, s2);
975 return the number of bytes occupied by a buffer in ASCII format
976 the result includes the null termination
979 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
983 len = strnlen(src, n);
992 Set a boolean variable from the text value stored in the passed string.
993 Returns true in success, false if the passed string does not correctly
997 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
999 if (strwicmp(boolean_string, "yes") == 0 ||
1000 strwicmp(boolean_string, "true") == 0 ||
1001 strwicmp(boolean_string, "on") == 0 ||
1002 strwicmp(boolean_string, "1") == 0) {
1005 } else if (strwicmp(boolean_string, "no") == 0 ||
1006 strwicmp(boolean_string, "false") == 0 ||
1007 strwicmp(boolean_string, "off") == 0 ||
1008 strwicmp(boolean_string, "0") == 0) {
1016 return the number of bytes occupied by a buffer in CH_UTF16 format
1017 the result includes the null termination
1019 _PUBLIC_ size_t utf16_len(const void *buf)
1023 for (len = 0; SVAL(buf,len); len += 2) ;
1029 return the number of bytes occupied by a buffer in CH_UTF16 format
1030 the result includes the null termination
1031 limited by 'n' bytes
1033 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
1037 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
1048 * @brief String utilities.
1051 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
1058 const char *saved_s;
1070 /* default to simple separators */
1075 /* find the first non sep char, if left-trimming is requested */
1077 while (*s && strchr_m(sep,*s)) {
1087 /* When restarting we need to go from here. */
1090 /* Work out the length needed. */
1091 for (quoted = false; *s &&
1092 (quoted || !strchr_m(sep,*s)); s++) {
1100 /* We started with len = 1 so we have space for the nul. */
1101 *pp_buff = talloc_array(ctx, char, len);
1106 /* copy over the token */
1109 for (quoted = false; *s &&
1110 (quoted || !strchr_m(sep,*s)); s++) {
1118 *ptr = (*s) ? s+1 : s;
1124 bool next_token_talloc(TALLOC_CTX *ctx,
1129 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
1133 * Get the next token from a string, return false if none found. Handles
1134 * double-quotes. This version does not trim leading separator characters
1135 * before looking for a token.
1138 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
1143 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);
1147 * Get the next token from a string, return False if none found.
1148 * Handles double-quotes.
1150 * Based on a routine by GJC@VILLAGE.COM.
1151 * Extensively modified by Andrew.Tridgell@anu.edu.au
1153 _PUBLIC_ bool next_token(const char **ptr,char *buff, const char *sep, size_t bufsize)
1164 /* default to simple separators */
1168 /* find the first non sep char */
1169 while (*s && strchr_m(sep,*s))
1176 /* copy over the token */
1177 for (quoted = false; len < bufsize && *s && (quoted || !strchr_m(sep,*s)); s++) {
1186 *ptr = (*s) ? s+1 : s;
1192 struct anonymous_shared_header {
1199 /* Map a shared memory buffer of at least nelem counters. */
1200 void *anonymous_shared_allocate(size_t orig_bufsz)
1204 size_t pagesz = getpagesize();
1206 size_t bufsz = orig_bufsz;
1207 struct anonymous_shared_header *hdr;
1209 bufsz += sizeof(*hdr);
1211 /* round up to full pages */
1212 pagecnt = bufsz / pagesz;
1213 if (bufsz % pagesz) {
1216 bufsz = pagesz * pagecnt;
1218 if (orig_bufsz >= bufsz) {
1226 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED,
1227 -1 /* fd */, 0 /* offset */);
1233 fd = open("/dev/zero", O_RDWR);
1238 buf = mmap(NULL, bufsz, PROT_READ|PROT_WRITE, MAP_FILE|MAP_SHARED,
1239 fd, 0 /* offset */);
1240 saved_errno = errno;
1242 errno = saved_errno;
1246 if (buf == MAP_FAILED) {
1250 hdr = (struct anonymous_shared_header *)buf;
1251 hdr->u.length = bufsz;
1253 ptr = (void *)(&hdr[1]);
1258 void *anonymous_shared_resize(void *ptr, size_t new_size, bool maymove)
1262 size_t pagesz = getpagesize();
1265 struct anonymous_shared_header *hdr;
1273 hdr = (struct anonymous_shared_header *)ptr;
1275 if (hdr->u.length > (new_size + sizeof(*hdr))) {
1280 bufsz = new_size + sizeof(*hdr);
1282 /* round up to full pages */
1283 pagecnt = bufsz / pagesz;
1284 if (bufsz % pagesz) {
1287 bufsz = pagesz * pagecnt;
1289 if (new_size >= bufsz) {
1295 if (bufsz <= hdr->u.length) {
1300 flags = MREMAP_MAYMOVE;
1303 buf = mremap(hdr, hdr->u.length, bufsz, flags);
1305 if (buf == MAP_FAILED) {
1310 hdr = (struct anonymous_shared_header *)buf;
1311 hdr->u.length = bufsz;
1313 ptr = (void *)(&hdr[1]);
1322 void anonymous_shared_free(void *ptr)
1324 struct anonymous_shared_header *hdr;
1330 hdr = (struct anonymous_shared_header *)ptr;
1334 munmap(hdr, hdr->u.length);
1338 /* used when you want a debugger started at a particular point in the
1339 code. Mostly useful in code that runs as a child process, where
1340 normal gdb attach is harder to organise.
1342 void samba_start_debugger(void)
1345 if (asprintf(&cmd, "xterm -e \"gdb --pid %u\"&", getpid()) == -1) {
1348 if (system(cmd) == -1) {