added a uid_wrapper library
[Samba/aatanasov.git] / lib / util / util.c
blobdea140148fa52e2e1d7561e5b25dc4202c1f9f11
1 /*
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
7 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
8 Copyright (C) James J Myers 2003
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/>.
24 #include "includes.h"
25 #include "system/network.h"
26 #include "system/filesys.h"
27 #include "system/locale.h"
28 #undef malloc
29 #undef strcasecmp
30 #undef strncasecmp
31 #undef strdup
32 #undef realloc
34 /**
35 * @file
36 * @brief Misc utility functions
39 /**
40 Find a suitable temporary directory. The result should be copied immediately
41 as it may be overwritten by a subsequent call.
42 **/
43 _PUBLIC_ const char *tmpdir(void)
45 char *p;
46 if ((p = getenv("TMPDIR")))
47 return p;
48 return "/tmp";
52 /**
53 Check if a file exists - call vfs_file_exist for samba files.
54 **/
55 _PUBLIC_ bool file_exist(const char *fname)
57 struct stat st;
59 if (stat(fname, &st) != 0) {
60 return false;
63 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
66 /**
67 Check a files mod time.
68 **/
70 _PUBLIC_ time_t file_modtime(const char *fname)
72 struct stat st;
74 if (stat(fname,&st) != 0)
75 return(0);
77 return(st.st_mtime);
80 /**
81 Check if a directory exists.
82 **/
84 _PUBLIC_ bool directory_exist(const char *dname)
86 struct stat st;
87 bool ret;
89 if (stat(dname,&st) != 0) {
90 return false;
93 ret = S_ISDIR(st.st_mode);
94 if(!ret)
95 errno = ENOTDIR;
96 return ret;
99 /**
100 * Try to create the specified directory if it didn't exist.
102 * @retval true if the directory already existed and has the right permissions
103 * or was successfully created.
105 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
106 mode_t dir_perms)
108 mode_t old_umask;
109 struct stat st;
111 old_umask = umask(0);
112 if (lstat(dname, &st) == -1) {
113 if (errno == ENOENT) {
114 /* Create directory */
115 if (mkdir(dname, dir_perms) == -1) {
116 DEBUG(0, ("error creating directory "
117 "%s: %s\n", dname,
118 strerror(errno)));
119 umask(old_umask);
120 return false;
122 } else {
123 DEBUG(0, ("lstat failed on directory %s: %s\n",
124 dname, strerror(errno)));
125 umask(old_umask);
126 return false;
128 } else {
129 /* Check ownership and permission on existing directory */
130 if (!S_ISDIR(st.st_mode)) {
131 DEBUG(0, ("directory %s isn't a directory\n",
132 dname));
133 umask(old_umask);
134 return false;
136 if ((st.st_uid != uid) ||
137 ((st.st_mode & 0777) != dir_perms)) {
138 #ifndef UID_WRAPPER_REPLACE
139 DEBUG(0, ("invalid permissions on directory "
140 "%s\n", dname));
141 umask(old_umask);
142 return false;
143 #endif
146 return true;
151 Sleep for a specified number of milliseconds.
154 _PUBLIC_ void msleep(unsigned int t)
156 struct timeval tval;
158 tval.tv_sec = t/1000;
159 tval.tv_usec = 1000*(t%1000);
160 /* this should be the real select - do NOT replace
161 with sys_select() */
162 select(0,NULL,NULL,NULL,&tval);
166 Get my own name, return in talloc'ed storage.
169 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
171 char *p;
172 char hostname[HOST_NAME_MAX];
174 /* get my host name */
175 if (gethostname(hostname, sizeof(hostname)) == -1) {
176 DEBUG(0,("gethostname failed\n"));
177 return NULL;
180 /* Ensure null termination. */
181 hostname[sizeof(hostname)-1] = '\0';
183 /* split off any parts after an initial . */
184 p = strchr_m(hostname, '.');
185 if (p) {
186 *p = 0;
189 return talloc_strdup(ctx, hostname);
193 Check if a process exists. Does this work on all unixes?
196 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
198 /* Doing kill with a non-positive pid causes messages to be
199 * sent to places we don't want. */
200 SMB_ASSERT(pid > 0);
201 return(kill(pid,0) == 0 || errno != ESRCH);
205 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
206 is dealt with in posix.c
209 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
211 struct flock lock;
212 int ret;
214 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
216 lock.l_type = type;
217 lock.l_whence = SEEK_SET;
218 lock.l_start = offset;
219 lock.l_len = count;
220 lock.l_pid = 0;
222 ret = fcntl(fd,op,&lock);
224 if (ret == -1 && errno != 0)
225 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
227 /* a lock query */
228 if (op == F_GETLK) {
229 if ((ret != -1) &&
230 (lock.l_type != F_UNLCK) &&
231 (lock.l_pid != 0) &&
232 (lock.l_pid != getpid())) {
233 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
234 return true;
237 /* it must be not locked or locked by me */
238 return false;
241 /* a lock set or unset */
242 if (ret == -1) {
243 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
244 (double)offset,(double)count,op,type,strerror(errno)));
245 return false;
248 /* everything went OK */
249 DEBUG(8,("fcntl_lock: Lock call successful\n"));
251 return true;
254 void print_asc(int level, const uint8_t *buf,int len)
256 int i;
257 for (i=0;i<len;i++)
258 DEBUGADD(level,("%c", isprint(buf[i])?buf[i]:'.'));
262 * Write dump of binary data to the log file.
264 * The data is only written if the log level is at least level.
266 static void _dump_data(int level, const uint8_t *buf, int len,
267 bool omit_zero_bytes)
269 int i=0;
270 static const uint8_t empty[16] = { 0, };
271 bool skipped = false;
273 if (len<=0) return;
275 if (!DEBUGLVL(level)) return;
277 for (i=0;i<len;) {
279 if (i%16 == 0) {
280 if ((omit_zero_bytes == true) &&
281 (i > 0) &&
282 (len > i+16) &&
283 (memcmp(&buf[i], &empty, 16) == 0))
285 i +=16;
286 continue;
289 if (i<len) {
290 DEBUGADD(level,("[%04X] ",i));
294 DEBUGADD(level,("%02X ",(int)buf[i]));
295 i++;
296 if (i%8 == 0) DEBUGADD(level,(" "));
297 if (i%16 == 0) {
299 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
300 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
302 if ((omit_zero_bytes == true) &&
303 (len > i+16) &&
304 (memcmp(&buf[i], &empty, 16) == 0)) {
305 if (!skipped) {
306 DEBUGADD(level,("skipping zero buffer bytes\n"));
307 skipped = true;
313 if (i%16) {
314 int n;
315 n = 16 - (i%16);
316 DEBUGADD(level,(" "));
317 if (n>8) DEBUGADD(level,(" "));
318 while (n--) DEBUGADD(level,(" "));
319 n = MIN(8,i%16);
320 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
321 n = (i%16) - n;
322 if (n>0) print_asc(level,&buf[i-n],n);
323 DEBUGADD(level,("\n"));
329 * Write dump of binary data to the log file.
331 * The data is only written if the log level is at least level.
333 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
335 _dump_data(level, buf, len, false);
339 * Write dump of binary data to the log file.
341 * The data is only written if the log level is at least level.
342 * 16 zero bytes in a row are ommited
344 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
346 _dump_data(level, buf, len, true);
351 malloc that aborts with smb_panic on fail or zero size.
354 _PUBLIC_ void *smb_xmalloc(size_t size)
356 void *p;
357 if (size == 0)
358 smb_panic("smb_xmalloc: called with zero size.\n");
359 if ((p = malloc(size)) == NULL)
360 smb_panic("smb_xmalloc: malloc fail.\n");
361 return p;
365 Memdup with smb_panic on fail.
368 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
370 void *p2;
371 p2 = smb_xmalloc(size);
372 memcpy(p2, p, size);
373 return p2;
377 strdup that aborts on malloc fail.
380 char *smb_xstrdup(const char *s)
382 #if defined(PARANOID_MALLOC_CHECKER)
383 #ifdef strdup
384 #undef strdup
385 #endif
386 #endif
388 #ifndef HAVE_STRDUP
389 #define strdup rep_strdup
390 #endif
392 char *s1 = strdup(s);
393 #if defined(PARANOID_MALLOC_CHECKER)
394 #ifdef strdup
395 #undef strdup
396 #endif
397 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
398 #endif
399 if (!s1) {
400 smb_panic("smb_xstrdup: malloc failed");
402 return s1;
407 strndup that aborts on malloc fail.
410 char *smb_xstrndup(const char *s, size_t n)
412 #if defined(PARANOID_MALLOC_CHECKER)
413 #ifdef strndup
414 #undef strndup
415 #endif
416 #endif
418 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
419 #undef HAVE_STRNDUP
420 #define strndup rep_strndup
421 #endif
423 char *s1 = strndup(s, n);
424 #if defined(PARANOID_MALLOC_CHECKER)
425 #ifdef strndup
426 #undef strndup
427 #endif
428 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
429 #endif
430 if (!s1) {
431 smb_panic("smb_xstrndup: malloc failed");
433 return s1;
439 Like strdup but for memory.
442 _PUBLIC_ void *memdup(const void *p, size_t size)
444 void *p2;
445 if (size == 0)
446 return NULL;
447 p2 = malloc(size);
448 if (!p2)
449 return NULL;
450 memcpy(p2, p, size);
451 return p2;
455 * Write a password to the log file.
457 * @note Only actually does something if DEBUG_PASSWORD was defined during
458 * compile-time.
460 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
462 #ifdef DEBUG_PASSWORD
463 DEBUG(11, ("%s", msg));
464 if (data != NULL && len > 0)
466 dump_data(11, data, len);
468 #endif
473 * see if a range of memory is all zero. A NULL pointer is considered
474 * to be all zero
476 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
478 int i;
479 if (!ptr) return true;
480 for (i=0;i<size;i++) {
481 if (ptr[i]) return false;
483 return true;
487 realloc an array, checking for integer overflow in the array size
489 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
491 #define MAX_MALLOC_SIZE 0x7fffffff
492 if (count == 0 ||
493 count >= MAX_MALLOC_SIZE/el_size) {
494 if (free_on_fail)
495 SAFE_FREE(ptr);
496 return NULL;
498 if (!ptr) {
499 return malloc(el_size * count);
501 return realloc(ptr, el_size * count);
504 /****************************************************************************
505 Type-safe malloc.
506 ****************************************************************************/
508 void *malloc_array(size_t el_size, unsigned int count)
510 return realloc_array(NULL, el_size, count, false);
514 Trim the specified elements off the front and back of a string.
516 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
518 bool ret = false;
519 size_t front_len;
520 size_t back_len;
521 size_t len;
523 /* Ignore null or empty strings. */
524 if (!s || (s[0] == '\0'))
525 return false;
527 front_len = front? strlen(front) : 0;
528 back_len = back? strlen(back) : 0;
530 len = strlen(s);
532 if (front_len) {
533 while (len && strncmp(s, front, front_len)==0) {
534 /* Must use memmove here as src & dest can
535 * easily overlap. Found by valgrind. JRA. */
536 memmove(s, s+front_len, (len-front_len)+1);
537 len -= front_len;
538 ret=true;
542 if (back_len) {
543 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
544 s[len-back_len]='\0';
545 len -= back_len;
546 ret=true;
549 return ret;
553 Find the number of 'c' chars in a string
555 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
557 size_t count = 0;
559 while (*s) {
560 if (*s == c) count++;
561 s ++;
564 return count;
568 Routine to get hex characters and turn them into a 16 byte array.
569 the array can be variable length, and any non-hex-numeric
570 characters are skipped. "0xnn" or "0Xnn" is specially catered
571 for.
573 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
577 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
579 size_t i;
580 size_t num_chars = 0;
581 uint8_t lonybble, hinybble;
582 const char *hexchars = "0123456789ABCDEF";
583 char *p1 = NULL, *p2 = NULL;
585 for (i = 0; i < strhex_len && strhex[i] != 0; i++) {
586 if (strncasecmp(hexchars, "0x", 2) == 0) {
587 i++; /* skip two chars */
588 continue;
591 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
592 break;
594 i++; /* next hex digit */
596 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
597 break;
599 /* get the two nybbles */
600 hinybble = PTR_DIFF(p1, hexchars);
601 lonybble = PTR_DIFF(p2, hexchars);
603 if (num_chars >= p_len) {
604 break;
607 p[num_chars] = (hinybble << 4) | lonybble;
608 num_chars++;
610 p1 = NULL;
611 p2 = NULL;
613 return num_chars;
616 /**
617 * Parse a hex string and return a data blob.
619 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
621 DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
623 ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
624 strhex,
625 strlen(strhex));
627 return ret_blob;
632 * Routine to print a buffer as HEX digits, into an allocated string.
634 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
636 int i;
637 char *hex_buffer;
639 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
640 hex_buffer = *out_hex_buffer;
642 for (i = 0; i < len; i++)
643 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
647 * talloc version of hex_encode()
649 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
651 int i;
652 char *hex_buffer;
654 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
655 if (!hex_buffer) {
656 return NULL;
659 for (i = 0; i < len; i++)
660 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
662 talloc_set_name_const(hex_buffer, hex_buffer);
663 return hex_buffer;
667 Unescape a URL encoded string, in place.
670 _PUBLIC_ void rfc1738_unescape(char *buf)
672 char *p=buf;
674 while ((p=strchr(p,'+')))
675 *p = ' ';
677 p = buf;
679 while (p && *p && (p=strchr(p,'%'))) {
680 int c1 = p[1];
681 int c2 = p[2];
683 if (c1 >= '0' && c1 <= '9')
684 c1 = c1 - '0';
685 else if (c1 >= 'A' && c1 <= 'F')
686 c1 = 10 + c1 - 'A';
687 else if (c1 >= 'a' && c1 <= 'f')
688 c1 = 10 + c1 - 'a';
689 else {p++; continue;}
691 if (c2 >= '0' && c2 <= '9')
692 c2 = c2 - '0';
693 else if (c2 >= 'A' && c2 <= 'F')
694 c2 = 10 + c2 - 'A';
695 else if (c2 >= 'a' && c2 <= 'f')
696 c2 = 10 + c2 - 'a';
697 else {p++; continue;}
699 *p = (c1<<4) | c2;
701 memmove(p+1, p+3, strlen(p+3)+1);
702 p++;
707 varient of strcmp() that handles NULL ptrs
709 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
711 if (s1 == s2) {
712 return 0;
714 if (s1 == NULL || s2 == NULL) {
715 return s1?-1:1;
717 return strcmp(s1, s2);
722 return the number of bytes occupied by a buffer in ASCII format
723 the result includes the null termination
724 limited by 'n' bytes
726 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
728 size_t len;
730 len = strnlen(src, n);
731 if (len+1 <= n) {
732 len += 1;
735 return len;
739 Set a boolean variable from the text value stored in the passed string.
740 Returns true in success, false if the passed string does not correctly
741 represent a boolean.
744 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
746 if (strwicmp(boolean_string, "yes") == 0 ||
747 strwicmp(boolean_string, "true") == 0 ||
748 strwicmp(boolean_string, "on") == 0 ||
749 strwicmp(boolean_string, "1") == 0) {
750 *boolean = true;
751 return true;
752 } else if (strwicmp(boolean_string, "no") == 0 ||
753 strwicmp(boolean_string, "false") == 0 ||
754 strwicmp(boolean_string, "off") == 0 ||
755 strwicmp(boolean_string, "0") == 0) {
756 *boolean = false;
757 return true;
759 return false;
763 return the number of bytes occupied by a buffer in CH_UTF16 format
764 the result includes the null termination
766 _PUBLIC_ size_t utf16_len(const void *buf)
768 size_t len;
770 for (len = 0; SVAL(buf,len); len += 2) ;
772 return len + 2;
776 return the number of bytes occupied by a buffer in CH_UTF16 format
777 the result includes the null termination
778 limited by 'n' bytes
780 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
782 size_t len;
784 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
786 if (len+2 <= n) {
787 len += 2;
790 return len;
794 * @file
795 * @brief String utilities.
798 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
799 const char **ptr,
800 char **pp_buff,
801 const char *sep,
802 bool ltrim)
804 char *s;
805 char *saved_s;
806 char *pbuf;
807 bool quoted;
808 size_t len=1;
810 *pp_buff = NULL;
811 if (!ptr) {
812 return(false);
815 s = (char *)*ptr;
817 /* default to simple separators */
818 if (!sep) {
819 sep = " \t\n\r";
822 /* find the first non sep char, if left-trimming is requested */
823 if (ltrim) {
824 while (*s && strchr_m(sep,*s)) {
825 s++;
829 /* nothing left? */
830 if (!*s) {
831 return false;
834 /* When restarting we need to go from here. */
835 saved_s = s;
837 /* Work out the length needed. */
838 for (quoted = false; *s &&
839 (quoted || !strchr_m(sep,*s)); s++) {
840 if (*s == '\"') {
841 quoted = !quoted;
842 } else {
843 len++;
847 /* We started with len = 1 so we have space for the nul. */
848 *pp_buff = talloc_array(ctx, char, len);
849 if (!*pp_buff) {
850 return false;
853 /* copy over the token */
854 pbuf = *pp_buff;
855 s = saved_s;
856 for (quoted = false; *s &&
857 (quoted || !strchr_m(sep,*s)); s++) {
858 if ( *s == '\"' ) {
859 quoted = !quoted;
860 } else {
861 *pbuf++ = *s;
865 *ptr = (*s) ? s+1 : s;
866 *pbuf = 0;
868 return true;
871 bool next_token_talloc(TALLOC_CTX *ctx,
872 const char **ptr,
873 char **pp_buff,
874 const char *sep)
876 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
880 * Get the next token from a string, return false if none found. Handles
881 * double-quotes. This version does not trim leading separator characters
882 * before looking for a token.
885 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
886 const char **ptr,
887 char **pp_buff,
888 const char *sep)
890 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);