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 2 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, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "dynconfig.h"
27 #include "system/network.h"
28 #include "system/iconv.h"
29 #include "system/filesys.h"
31 /***************************************************************************
32 Find a suitable temporary directory. The result should be copied immediately
33 as it may be overwritten by a subsequent call.
34 ****************************************************************************/
35 const char *tmpdir(void)
38 if ((p = getenv("TMPDIR")))
44 /*******************************************************************
45 Check if a file exists - call vfs_file_exist for samba files.
46 ********************************************************************/
47 BOOL file_exist(const char *fname)
51 if (stat(fname, &st) != 0) {
55 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
58 /*******************************************************************
59 Check a files mod time.
60 ********************************************************************/
62 time_t file_modtime(const char *fname)
66 if (stat(fname,&st) != 0)
72 /*******************************************************************
73 Check if a directory exists.
74 ********************************************************************/
76 BOOL directory_exist(const char *dname)
81 if (stat(dname,&st) != 0) {
85 ret = S_ISDIR(st.st_mode);
91 BOOL directory_create_or_exist(const char *dname, uid_t uid,
98 if (lstat(dname, &st) == -1) {
99 if (errno == ENOENT) {
100 /* Create directory */
101 if (mkdir(dname, dir_perms) == -1) {
102 DEBUG(0, ("error creating directory "
109 DEBUG(0, ("lstat failed on directory %s: %s\n",
110 dname, strerror(errno)));
115 /* Check ownership and permission on existing directory */
116 if (!S_ISDIR(st.st_mode)) {
117 DEBUG(0, ("directory %s isn't a directory\n",
122 if ((st.st_uid != uid) ||
123 ((st.st_mode & 0777) != dir_perms)) {
124 DEBUG(0, ("invalid permissions on directory "
134 /*******************************************************************
135 Returns the size in bytes of the named file.
136 ********************************************************************/
137 off_t get_file_size(char *file_name)
141 if(stat(file_name,&buf) != 0)
146 /*******************************************************************
147 Close the low 3 fd's and open dev/null in their place.
148 ********************************************************************/
149 void close_low_fds(BOOL stderr_too)
161 /* try and use up these file descriptors, so silly
162 library routines writing to stdout etc won't cause havoc */
164 if (i == 2 && !stderr_too)
167 fd = open("/dev/null",O_RDWR,0);
169 fd = open("/dev/null",O_WRONLY,0);
171 DEBUG(0,("Can't open /dev/null\n"));
175 DEBUG(0,("Didn't get file descriptor %d\n",i));
182 /****************************************************************************
183 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
187 ****************************************************************************/
189 int set_blocking(int fd, BOOL set)
193 #define FLAG_TO_SET O_NONBLOCK
196 #define FLAG_TO_SET O_NDELAY
198 #define FLAG_TO_SET FNDELAY
202 if((val = fcntl(fd, F_GETFL, 0)) == -1)
204 if(set) /* Turn blocking on - ie. clear nonblock flag */
208 return fcntl( fd, F_SETFL, val);
213 /*******************************************************************
214 Sleep for a specified number of milliseconds.
215 ********************************************************************/
217 void msleep(uint_t t)
221 tval.tv_sec = t/1000;
222 tval.tv_usec = 1000*(t%1000);
223 /* this should be the real select - do NOT replace
225 select(0,NULL,NULL,NULL,&tval);
228 /****************************************************************************
229 Become a daemon, discarding the controlling terminal.
230 ****************************************************************************/
232 void become_daemon(BOOL Fork)
240 /* detach from the terminal */
243 #elif defined(TIOCNOTTY)
245 int i = open("/dev/tty", O_RDWR, 0);
247 ioctl(i, (int) TIOCNOTTY, (char *)0);
251 #endif /* HAVE_SETSID */
253 /* Close fd's 0,1,2. Needed if started by rsh */
254 close_low_fds(False); /* Don't close stderr, let the debug system
255 attach it to the logfile */
259 /****************************************************************************
260 Free memory, checks for NULL.
261 Use directly SAFE_FREE()
262 Exists only because we need to pass a function pointer somewhere --SSS
263 ****************************************************************************/
265 void safe_free(void *p)
272 see if a string matches either our primary or one of our secondary
273 netbios aliases. do a case insensitive match
275 BOOL is_myname(const char *name)
277 const char **aliases;
280 if (strcasecmp(name, lp_netbios_name()) == 0) {
284 aliases = lp_netbios_aliases();
285 for (i=0; aliases && aliases[i]; i++) {
286 if (strcasecmp(name, aliases[i]) == 0) {
295 /****************************************************************************
296 Get my own name, return in malloc'ed storage.
297 ****************************************************************************/
299 char* get_myname(void)
302 const int host_name_max = 255;
305 hostname = malloc(host_name_max+1);
308 /* get my host name */
309 if (gethostname(hostname, host_name_max+1) == -1) {
310 DEBUG(0,("gethostname failed\n"));
314 /* Ensure null termination. */
315 hostname[host_name_max] = '\0';
317 /* split off any parts after an initial . */
318 p = strchr_m(hostname,'.');
326 /****************************************************************************
327 Return true if a string could be a pure IP address.
328 ****************************************************************************/
330 BOOL is_ipaddress(const char *str)
332 BOOL pure_address = True;
335 for (i=0; pure_address && str[i]; i++)
336 if (!(isdigit((int)str[i]) || str[i] == '.'))
337 pure_address = False;
339 /* Check that a pure number is not misinterpreted as an IP */
340 pure_address = pure_address && (strchr_m(str, '.') != NULL);
345 /****************************************************************************
346 Interpret an internet address or name into an IP address in 4 byte form.
347 ****************************************************************************/
348 uint32_t interpret_addr(const char *str)
353 if (str == NULL || *str == 0 ||
354 strcmp(str,"0.0.0.0") == 0) {
357 if (strcmp(str,"255.255.255.255") == 0) {
360 /* recognise 'localhost' as a special name. This fixes problems with
361 some hosts that don't have localhost in /etc/hosts */
362 if (strcasecmp(str,"localhost") == 0) {
366 /* if it's in the form of an IP address then get the lib to interpret it */
367 if (is_ipaddress(str)) {
368 res = inet_addr(str);
370 /* otherwise assume it's a network name of some sort and use
372 if ((hp = sys_gethostbyname(str)) == 0) {
373 DEBUG(3,("sys_gethostbyname: Unknown host. %s\n",str));
377 if(hp->h_addr == NULL) {
378 DEBUG(3,("sys_gethostbyname: host address is invalid for host %s\n",str));
381 memcpy((char *)&res,(char *)hp->h_addr, 4);
384 if (res == (uint32_t)-1)
390 /*******************************************************************
391 A convenient addition to interpret_addr().
392 ******************************************************************/
393 struct ipv4_addr interpret_addr2(const char *str)
395 struct ipv4_addr ret;
396 uint32_t a = interpret_addr(str);
401 /*******************************************************************
402 Check if an IP is the 0.0.0.0.
403 ******************************************************************/
405 BOOL is_zero_ip(struct ipv4_addr ip)
410 /*******************************************************************
411 Set an IP to 0.0.0.0.
412 ******************************************************************/
414 void zero_ip(struct ipv4_addr *ip)
416 *ip = sys_inet_makeaddr(0,0);
421 /*******************************************************************
422 Are two IPs on the same subnet?
423 ********************************************************************/
425 BOOL same_net(struct ipv4_addr ip1,struct ipv4_addr ip2,struct ipv4_addr mask)
427 uint32_t net1,net2,nmask;
429 nmask = ntohl(mask.addr);
430 net1 = ntohl(ip1.addr);
431 net2 = ntohl(ip2.addr);
433 return((net1 & nmask) == (net2 & nmask));
437 /****************************************************************************
438 Check if a process exists. Does this work on all unixes?
439 ****************************************************************************/
441 BOOL process_exists(pid_t pid)
443 /* Doing kill with a non-positive pid causes messages to be
444 * sent to places we don't want. */
446 return(kill(pid,0) == 0 || errno != ESRCH);
449 /****************************************************************************
450 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
451 is dealt with in posix.c
452 ****************************************************************************/
454 BOOL fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
459 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
462 lock.l_whence = SEEK_SET;
463 lock.l_start = offset;
467 ret = fcntl(fd,op,&lock);
469 if (ret == -1 && errno != 0)
470 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
475 (lock.l_type != F_UNLCK) &&
477 (lock.l_pid != getpid())) {
478 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
482 /* it must be not locked or locked by me */
486 /* a lock set or unset */
488 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
489 (double)offset,(double)count,op,type,strerror(errno)));
493 /* everything went OK */
494 DEBUG(8,("fcntl_lock: Lock call successful\n"));
500 static void print_asc(int level, const uint8_t *buf,int len)
504 DEBUGADD(level,("%c", isprint(buf[i])?buf[i]:'.'));
507 void dump_data(int level, const uint8_t *buf,int len)
512 if (!DEBUGLVL(level)) return;
514 DEBUGADD(level,("[%03X] ",i));
516 DEBUGADD(level,("%02X ",(int)buf[i]));
518 if (i%8 == 0) DEBUGADD(level,(" "));
520 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
521 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
522 if (i<len) DEBUGADD(level,("[%03X] ",i));
528 DEBUGADD(level,(" "));
529 if (n>8) DEBUGADD(level,(" "));
530 while (n--) DEBUGADD(level,(" "));
532 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
534 if (n>0) print_asc(level,&buf[i-n],n);
535 DEBUGADD(level,("\n"));
539 /*****************************************************************
540 malloc that aborts with smb_panic on fail or zero size.
541 *****************************************************************/
543 void *smb_xmalloc(size_t size)
547 smb_panic("smb_xmalloc: called with zero size.\n");
548 if ((p = malloc(size)) == NULL)
549 smb_panic("smb_xmalloc: malloc fail.\n");
554 Memdup with smb_panic on fail.
557 void *smb_xmemdup(const void *p, size_t size)
560 p2 = smb_xmalloc(size);
566 strdup that aborts on malloc fail.
569 char *smb_xstrdup(const char *s)
571 char *s1 = strdup(s);
573 smb_panic("smb_xstrdup: malloc fail\n");
578 /*****************************************************************
579 Like strdup but for memory.
580 *****************************************************************/
582 void *memdup(const void *p, size_t size)
594 /*****************************************************************
595 Get local hostname and cache result.
596 *****************************************************************/
598 char *myhostname(TALLOC_CTX *mem_ctx)
601 myname = get_myname();
602 ret = talloc_strdup(mem_ctx, myname);
608 /**********************************************************************
609 Converts a name to a fully qalified domain name.
610 ***********************************************************************/
612 char *name_to_fqdn(TALLOC_CTX *mem_ctx, const char *name)
614 struct hostent *hp = sys_gethostbyname(name);
615 if ( hp && hp->h_name && *hp->h_name ) {
616 DEBUG(10,("name_to_fqdn: lookup for %s -> %s.\n", name, hp->h_name));
617 return talloc_strdup(mem_ctx, hp->h_name);
619 DEBUG(10,("name_to_fqdn: lookup for %s failed.\n", name));
620 return talloc_strdup(mem_ctx, name);
625 /*****************************************************************
626 A useful function for returning a path in the Samba lock directory.
627 *****************************************************************/
628 char *lock_path(TALLOC_CTX* mem_ctx, const char *name)
634 if (name[0] == 0 || name[0] == '/' || strstr(name, ":/")) {
635 return talloc_strdup(mem_ctx, name);
638 dname = talloc_strdup(mem_ctx, lp_lockdir());
639 trim_string(dname,"","/");
641 if (!directory_exist(dname)) {
645 fname = talloc_asprintf(mem_ctx, "%s/%s", dname, name);
653 /*****************************************************************
654 A useful function for returning a path in the Samba piddir directory.
655 *****************************************************************/
656 char *pid_path(TALLOC_CTX* mem_ctx, const char *name)
660 dname = talloc_strdup(mem_ctx, lp_piddir());
661 trim_string(dname,"","/");
663 if (!directory_exist(dname)) {
667 fname = talloc_asprintf(mem_ctx, "%s/%s", dname, name);
676 * @brief Returns an absolute path to a file in the Samba lib directory.
678 * @param name File to find, relative to LIBDIR.
680 * @retval Pointer to a talloc'ed string containing the full path.
683 char *lib_path(TALLOC_CTX* mem_ctx, const char *name)
686 fname = talloc_asprintf(mem_ctx, "%s/%s", dyn_LIBDIR, name);
691 * @brief Returns an absolute path to a file in the Samba private directory.
693 * @param name File to find, relative to PRIVATEDIR.
694 * if name is not relative, then use it as-is
696 * @retval Pointer to a talloc'ed string containing the full path.
698 char *private_path(TALLOC_CTX* mem_ctx, const char *name)
704 if (name[0] == 0 || name[0] == '/' || strstr(name, ":/")) {
705 return talloc_strdup(mem_ctx, name);
707 fname = talloc_asprintf(mem_ctx, "%s/%s", lp_private_dir(), name);
712 return a path in the smbd.tmp directory, where all temporary file
713 for smbd go. If NULL is passed for name then return the directory
716 char *smbd_tmp_path(TALLOC_CTX *mem_ctx, const char *name)
720 dname = pid_path(mem_ctx, "smbd.tmp");
721 if (!directory_exist(dname)) {
729 fname = talloc_asprintf(mem_ctx, "%s/%s", dname, name);
735 char *modules_path(TALLOC_CTX* mem_ctx, const char *name)
737 return talloc_asprintf(mem_ctx, "%s/%s", dyn_MODULESDIR, name);
740 init_module_fn *load_samba_modules(TALLOC_CTX *mem_ctx, const char *subsystem)
742 char *path = modules_path(mem_ctx, subsystem);
745 ret = load_modules(mem_ctx, path);
752 void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
754 #ifdef DEBUG_PASSWORD
755 DEBUG(11, ("%s", msg));
756 if (data != NULL && len > 0)
758 dump_data(11, data, len);
764 /* see if a range of memory is all zero. A NULL pointer is considered
766 BOOL all_zero(const uint8_t *ptr, uint_t size)
769 if (!ptr) return True;
770 for (i=0;i<size;i++) {
771 if (ptr[i]) return False;
777 realloc an array, checking for integer overflow in the array size
779 void *realloc_array(void *ptr, size_t el_size, unsigned count)
781 #define MAX_MALLOC_SIZE 0x7fffffff
783 count >= MAX_MALLOC_SIZE/el_size) {
787 return malloc(el_size * count);
789 return realloc(ptr, el_size * count);