2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2001-2007
6 Copyright (C) Simo Sorce 2001
7 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
8 Copyright (C) James Peach 2006
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/>.
26 extern char *global_clobber_region_function;
27 extern unsigned int global_clobber_region_line;
29 /* Max allowable allococation - 256mb - 0x10000000 */
30 #define MAX_ALLOC_SIZE (1024*1024*256)
32 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
33 #ifdef WITH_NISPLUS_HOME
34 #ifdef BROKEN_NISPLUS_INCLUDE_FILES
36 * The following lines are needed due to buggy include files
37 * in Solaris 2.6 which define GROUP in both /usr/include/sys/acl.h and
38 * also in /usr/include/rpcsvc/nis.h. The definitions conflict. JRA.
39 * Also GROUP_OBJ is defined as 0x4 in /usr/include/sys/acl.h and as
40 * an enum in /usr/include/rpcsvc/nis.h.
47 #if defined(GROUP_OBJ)
51 #endif /* BROKEN_NISPLUS_INCLUDE_FILES */
53 #include <rpcsvc/nis.h>
55 #endif /* WITH_NISPLUS_HOME */
56 #endif /* HAVE_NETGROUP && WITH_AUTOMOUNT */
58 enum protocol_types Protocol = PROTOCOL_COREPLUS;
60 /* this is used by the chaining code */
63 static enum remote_arch_types ra_type = RA_UNKNOWN;
65 /***********************************************************************
66 Definitions for all names.
67 ***********************************************************************/
69 static char *smb_myname;
70 static char *smb_myworkgroup;
71 static char *smb_scope;
72 static int smb_num_netbios_names;
73 static char **smb_my_netbios_names;
75 /***********************************************************************
76 Allocate and set myname. Ensure upper case.
77 ***********************************************************************/
79 bool set_global_myname(const char *myname)
81 SAFE_FREE(smb_myname);
82 smb_myname = SMB_STRDUP(myname);
85 strupper_m(smb_myname);
89 const char *global_myname(void)
94 /***********************************************************************
95 Allocate and set myworkgroup. Ensure upper case.
96 ***********************************************************************/
98 bool set_global_myworkgroup(const char *myworkgroup)
100 SAFE_FREE(smb_myworkgroup);
101 smb_myworkgroup = SMB_STRDUP(myworkgroup);
102 if (!smb_myworkgroup)
104 strupper_m(smb_myworkgroup);
108 const char *lp_workgroup(void)
110 return smb_myworkgroup;
113 /***********************************************************************
114 Allocate and set scope. Ensure upper case.
115 ***********************************************************************/
117 bool set_global_scope(const char *scope)
119 SAFE_FREE(smb_scope);
120 smb_scope = SMB_STRDUP(scope);
123 strupper_m(smb_scope);
127 /*********************************************************************
128 Ensure scope is never null string.
129 *********************************************************************/
131 const char *global_scope(void)
134 set_global_scope("");
138 static void free_netbios_names_array(void)
142 for (i = 0; i < smb_num_netbios_names; i++)
143 SAFE_FREE(smb_my_netbios_names[i]);
145 SAFE_FREE(smb_my_netbios_names);
146 smb_num_netbios_names = 0;
149 static bool allocate_my_netbios_names_array(size_t number)
151 free_netbios_names_array();
153 smb_num_netbios_names = number + 1;
154 smb_my_netbios_names = SMB_MALLOC_ARRAY( char *, smb_num_netbios_names );
156 if (!smb_my_netbios_names)
159 memset(smb_my_netbios_names, '\0', sizeof(char *) * smb_num_netbios_names);
163 static bool set_my_netbios_names(const char *name, int i)
165 SAFE_FREE(smb_my_netbios_names[i]);
167 smb_my_netbios_names[i] = SMB_STRDUP(name);
168 if (!smb_my_netbios_names[i])
170 strupper_m(smb_my_netbios_names[i]);
174 /***********************************************************************
175 Free memory allocated to global objects
176 ***********************************************************************/
178 void gfree_names(void)
180 SAFE_FREE( smb_myname );
181 SAFE_FREE( smb_myworkgroup );
182 SAFE_FREE( smb_scope );
183 free_netbios_names_array();
184 free_local_machine_name();
187 void gfree_all( void )
197 const char *my_netbios_names(int i)
199 return smb_my_netbios_names[i];
202 bool set_netbios_aliases(const char **str_array)
206 /* Work out the max number of netbios aliases that we have */
207 for( namecount=0; str_array && (str_array[namecount] != NULL); namecount++ )
210 if ( global_myname() && *global_myname())
213 /* Allocate space for the netbios aliases */
214 if (!allocate_my_netbios_names_array(namecount))
217 /* Use the global_myname string first */
219 if ( global_myname() && *global_myname()) {
220 set_my_netbios_names( global_myname(), namecount );
226 for ( i = 0; str_array[i] != NULL; i++) {
228 bool duplicate = False;
230 /* Look for duplicates */
231 for( n=0; n<namecount; n++ ) {
232 if( strequal( str_array[i], my_netbios_names(n) ) ) {
238 if (!set_my_netbios_names(str_array[i], namecount))
247 /****************************************************************************
248 Common name initialization code.
249 ****************************************************************************/
251 bool init_names(void)
255 if (global_myname() == NULL || *global_myname() == '\0') {
256 if (!set_global_myname(myhostname())) {
257 DEBUG( 0, ( "init_structs: malloc fail.\n" ) );
262 if (!set_netbios_aliases(lp_netbios_aliases())) {
263 DEBUG( 0, ( "init_structs: malloc fail.\n" ) );
267 set_local_machine_name(global_myname(),false);
269 DEBUG( 5, ("Netbios name list:-\n") );
270 for( n=0; my_netbios_names(n); n++ ) {
271 DEBUGADD( 5, ("my_netbios_names[%d]=\"%s\"\n",
272 n, my_netbios_names(n) ) );
278 /**************************************************************************n
279 Code to cope with username/password auth options from the commandline.
280 Used mainly in client tools.
281 ****************************************************************************/
283 struct user_auth_info *user_auth_info_init(TALLOC_CTX *mem_ctx)
285 struct user_auth_info *result;
287 result = TALLOC_ZERO_P(mem_ctx, struct user_auth_info);
288 if (result == NULL) {
292 result->signing_state = Undefined;
296 const char *get_cmdline_auth_info_username(struct user_auth_info *auth_info)
298 if (!auth_info->username) {
301 return auth_info->username;
304 void set_cmdline_auth_info_username(struct user_auth_info *auth_info,
305 const char *username)
307 TALLOC_FREE(auth_info->username);
308 auth_info->username = talloc_strdup(auth_info, username);
309 if (!auth_info->username) {
314 const char *get_cmdline_auth_info_password(struct user_auth_info *auth_info)
316 if (!auth_info->password) {
319 return auth_info->password;
322 void set_cmdline_auth_info_password(struct user_auth_info *auth_info,
323 const char *password)
325 TALLOC_FREE(auth_info->password);
326 auth_info->password = talloc_strdup(auth_info, password);
327 if (!auth_info->password) {
330 auth_info->got_pass = true;
333 bool set_cmdline_auth_info_signing_state(struct user_auth_info *auth_info,
336 auth_info->signing_state = -1;
337 if (strequal(arg, "off") || strequal(arg, "no") ||
338 strequal(arg, "false")) {
339 auth_info->signing_state = false;
340 } else if (strequal(arg, "on") || strequal(arg, "yes") ||
341 strequal(arg, "true") || strequal(arg, "auto")) {
342 auth_info->signing_state = true;
343 } else if (strequal(arg, "force") || strequal(arg, "required") ||
344 strequal(arg, "forced")) {
345 auth_info->signing_state = Required;
352 int get_cmdline_auth_info_signing_state(struct user_auth_info *auth_info)
354 return auth_info->signing_state;
357 void set_cmdline_auth_info_use_kerberos(struct user_auth_info *auth_info,
360 auth_info->use_kerberos = b;
363 bool get_cmdline_auth_info_use_kerberos(struct user_auth_info *auth_info)
365 return auth_info->use_kerberos;
368 /* This should only be used by lib/popt_common.c JRA */
369 void set_cmdline_auth_info_use_krb5_ticket(struct user_auth_info *auth_info)
371 auth_info->use_kerberos = true;
372 auth_info->got_pass = true;
375 /* This should only be used by lib/popt_common.c JRA */
376 void set_cmdline_auth_info_smb_encrypt(struct user_auth_info *auth_info)
378 auth_info->smb_encrypt = true;
381 void set_cmdline_auth_info_use_machine_account(struct user_auth_info *auth_info)
383 auth_info->use_machine_account = true;
386 bool get_cmdline_auth_info_got_pass(struct user_auth_info *auth_info)
388 return auth_info->got_pass;
391 bool get_cmdline_auth_info_smb_encrypt(struct user_auth_info *auth_info)
393 return auth_info->smb_encrypt;
396 bool get_cmdline_auth_info_use_machine_account(struct user_auth_info *auth_info)
398 return auth_info->use_machine_account;
401 struct user_auth_info *get_cmdline_auth_info_copy(TALLOC_CTX *mem_ctx,
402 struct user_auth_info *src)
404 struct user_auth_info *result;
406 result = user_auth_info_init(mem_ctx);
407 if (result == NULL) {
413 result->username = talloc_strdup(
414 result, get_cmdline_auth_info_username(src));
415 result->password = talloc_strdup(
416 result, get_cmdline_auth_info_password(src));
417 if ((result->username == NULL) || (result->password == NULL)) {
425 bool set_cmdline_auth_info_machine_account_creds(struct user_auth_info *auth_info)
428 char *account = NULL;
430 if (!get_cmdline_auth_info_use_machine_account(auth_info)) {
434 if (!secrets_init()) {
435 d_printf("ERROR: Unable to open secrets database\n");
439 if (asprintf(&account, "%s$@%s", global_myname(), lp_realm()) < 0) {
443 pass = secrets_fetch_machine_password(lp_workgroup(), NULL, NULL);
445 d_printf("ERROR: Unable to fetch machine password for "
447 account, lp_workgroup());
452 set_cmdline_auth_info_username(auth_info, account);
453 set_cmdline_auth_info_password(auth_info, pass);
461 /****************************************************************************
462 Add a gid to an array of gids if it's not already there.
463 ****************************************************************************/
465 bool add_gid_to_array_unique(TALLOC_CTX *mem_ctx, gid_t gid,
466 gid_t **gids, size_t *num_gids)
470 if ((*num_gids != 0) && (*gids == NULL)) {
472 * A former call to this routine has failed to allocate memory
477 for (i=0; i<*num_gids; i++) {
478 if ((*gids)[i] == gid) {
483 *gids = TALLOC_REALLOC_ARRAY(mem_ctx, *gids, gid_t, *num_gids+1);
489 (*gids)[*num_gids] = gid;
494 /****************************************************************************
495 Like atoi but gets the value up to the separator character.
496 ****************************************************************************/
498 static const char *Atoic(const char *p, int *n, const char *c)
500 if (!isdigit((int)*p)) {
501 DEBUG(5, ("Atoic: malformed number\n"));
507 while ((*p) && isdigit((int)*p))
510 if (strchr_m(c, *p) == NULL) {
511 DEBUG(5, ("Atoic: no separator characters (%s) not found\n", c));
518 /*************************************************************************
519 Reads a list of numbers.
520 *************************************************************************/
522 const char *get_numlist(const char *p, uint32 **num, int *count)
526 if (num == NULL || count == NULL)
532 while ((p = Atoic(p, &val, ":,")) != NULL && (*p) != ':') {
533 *num = SMB_REALLOC_ARRAY((*num), uint32, (*count)+1);
537 (*num)[(*count)] = val;
545 /*******************************************************************
546 Check if a file exists - call vfs_file_exist for samba files.
547 ********************************************************************/
549 bool file_exist_stat(const char *fname,SMB_STRUCT_STAT *sbuf)
555 if (sys_stat(fname,sbuf) != 0)
558 return((S_ISREG(sbuf->st_mode)) || (S_ISFIFO(sbuf->st_mode)));
561 /*******************************************************************
562 Check if a unix domain socket exists - call vfs_file_exist for samba files.
563 ********************************************************************/
565 bool socket_exist(const char *fname)
568 if (sys_stat(fname,&st) != 0)
571 return S_ISSOCK(st.st_mode);
574 /*******************************************************************
575 Check if a directory exists.
576 ********************************************************************/
578 bool directory_exist_stat(char *dname,SMB_STRUCT_STAT *st)
586 if (sys_stat(dname,st) != 0)
589 ret = S_ISDIR(st->st_mode);
595 /*******************************************************************
596 Returns the size in bytes of the named file.
597 ********************************************************************/
599 SMB_OFF_T get_file_size(char *file_name)
603 if(sys_stat(file_name,&buf) != 0)
604 return (SMB_OFF_T)-1;
608 /*******************************************************************
609 Return a string representing an attribute for a file.
610 ********************************************************************/
612 char *attrib_string(uint16 mode)
618 if (mode & aVOLID) fstrcat(attrstr,"V");
619 if (mode & aDIR) fstrcat(attrstr,"D");
620 if (mode & aARCH) fstrcat(attrstr,"A");
621 if (mode & aHIDDEN) fstrcat(attrstr,"H");
622 if (mode & aSYSTEM) fstrcat(attrstr,"S");
623 if (mode & aRONLY) fstrcat(attrstr,"R");
625 return talloc_strdup(talloc_tos(), attrstr);
628 /*******************************************************************
629 Show a smb message structure.
630 ********************************************************************/
632 void show_msg(char *buf)
640 DEBUG(5,("size=%d\nsmb_com=0x%x\nsmb_rcls=%d\nsmb_reh=%d\nsmb_err=%d\nsmb_flg=%d\nsmb_flg2=%d\n",
642 (int)CVAL(buf,smb_com),
643 (int)CVAL(buf,smb_rcls),
644 (int)CVAL(buf,smb_reh),
645 (int)SVAL(buf,smb_err),
646 (int)CVAL(buf,smb_flg),
647 (int)SVAL(buf,smb_flg2)));
648 DEBUGADD(5,("smb_tid=%d\nsmb_pid=%d\nsmb_uid=%d\nsmb_mid=%d\n",
649 (int)SVAL(buf,smb_tid),
650 (int)SVAL(buf,smb_pid),
651 (int)SVAL(buf,smb_uid),
652 (int)SVAL(buf,smb_mid)));
653 DEBUGADD(5,("smt_wct=%d\n",(int)CVAL(buf,smb_wct)));
655 for (i=0;i<(int)CVAL(buf,smb_wct);i++)
656 DEBUGADD(5,("smb_vwv[%2d]=%5d (0x%X)\n",i,
657 SVAL(buf,smb_vwv+2*i),SVAL(buf,smb_vwv+2*i)));
659 bcc = (int)SVAL(buf,smb_vwv+2*(CVAL(buf,smb_wct)));
661 DEBUGADD(5,("smb_bcc=%d\n",bcc));
669 dump_data(10, (uint8 *)smb_buf(buf), bcc);
672 /*******************************************************************
673 Set the length and marker of an encrypted smb packet.
674 ********************************************************************/
676 void smb_set_enclen(char *buf,int len,uint16 enc_ctx_num)
678 _smb_setlen(buf,len);
682 SSVAL(buf,6,enc_ctx_num);
685 /*******************************************************************
686 Set the length and marker of an smb packet.
687 ********************************************************************/
689 void smb_setlen(char *buf,int len)
691 _smb_setlen(buf,len);
699 /*******************************************************************
700 Setup only the byte count for a smb message.
701 ********************************************************************/
703 int set_message_bcc(char *buf,int num_bytes)
705 int num_words = CVAL(buf,smb_wct);
706 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
707 _smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
708 return (smb_size + num_words*2 + num_bytes);
711 /*******************************************************************
712 Add a data blob to the end of a smb_buf, adjusting bcc and smb_len.
713 Return the bytes added
714 ********************************************************************/
716 ssize_t message_push_blob(uint8 **outbuf, DATA_BLOB blob)
718 size_t newlen = smb_len(*outbuf) + 4 + blob.length;
721 if (!(tmp = TALLOC_REALLOC_ARRAY(NULL, *outbuf, uint8, newlen))) {
722 DEBUG(0, ("talloc failed\n"));
727 memcpy(tmp + smb_len(tmp) + 4, blob.data, blob.length);
728 set_message_bcc((char *)tmp, smb_buflen(tmp) + blob.length);
732 /*******************************************************************
733 Reduce a file name, removing .. elements.
734 ********************************************************************/
736 static char *dos_clean_name(TALLOC_CTX *ctx, const char *s)
741 DEBUG(3,("dos_clean_name [%s]\n",s));
743 /* remove any double slashes */
744 str = talloc_all_string_sub(ctx, s, "\\\\", "\\");
749 /* Remove leading .\\ characters */
750 if(strncmp(str, ".\\", 2) == 0) {
751 trim_string(str, ".\\", NULL);
753 str = talloc_strdup(ctx, ".\\");
760 while ((p = strstr_m(str,"\\..\\")) != NULL) {
766 if ((p=strrchr_m(str,'\\')) != NULL) {
771 str = talloc_asprintf(ctx,
780 trim_string(str,NULL,"\\..");
781 return talloc_all_string_sub(ctx, str, "\\.\\", "\\");
784 /*******************************************************************
785 Reduce a file name, removing .. elements.
786 ********************************************************************/
788 char *unix_clean_name(TALLOC_CTX *ctx, const char *s)
793 DEBUG(3,("unix_clean_name [%s]\n",s));
795 /* remove any double slashes */
796 str = talloc_all_string_sub(ctx, s, "//","/");
801 /* Remove leading ./ characters */
802 if(strncmp(str, "./", 2) == 0) {
803 trim_string(str, "./", NULL);
805 str = talloc_strdup(ctx, "./");
812 while ((p = strstr_m(str,"/../")) != NULL) {
818 if ((p=strrchr_m(str,'/')) != NULL) {
823 str = talloc_asprintf(ctx,
832 trim_string(str,NULL,"/..");
833 return talloc_all_string_sub(ctx, str, "/./", "/");
836 char *clean_name(TALLOC_CTX *ctx, const char *s)
838 char *str = dos_clean_name(ctx, s);
842 return unix_clean_name(ctx, str);
845 /*******************************************************************
846 Close the low 3 fd's and open dev/null in their place.
847 ********************************************************************/
849 void close_low_fds(bool stderr_too)
861 /* try and use up these file descriptors, so silly
862 library routines writing to stdout etc won't cause havoc */
864 if (i == 2 && !stderr_too)
867 fd = sys_open("/dev/null",O_RDWR,0);
869 fd = sys_open("/dev/null",O_WRONLY,0);
871 DEBUG(0,("Can't open /dev/null\n"));
875 DEBUG(0,("Didn't get file descriptor %d\n",i));
882 /*******************************************************************
883 Write data into an fd at a given offset. Ignore seek errors.
884 ********************************************************************/
886 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, SMB_OFF_T pos)
891 if (pos == (SMB_OFF_T)-1) {
892 return write_data(fd, buffer, N);
894 #if defined(HAVE_PWRITE) || defined(HAVE_PRWITE64)
896 ret = sys_pwrite(fd,buffer + total,N - total, pos);
897 if (ret == -1 && errno == ESPIPE) {
898 return write_data(fd, buffer + total,N - total);
901 DEBUG(0,("write_data_at_offset: write failure. Error = %s\n", strerror(errno) ));
910 return (ssize_t)total;
912 /* Use lseek and write_data. */
913 if (sys_lseek(fd, pos, SEEK_SET) == -1) {
914 if (errno != ESPIPE) {
918 return write_data(fd, buffer, N);
922 /*******************************************************************
923 Sleep for a specified number of milliseconds.
924 ********************************************************************/
926 void smb_msleep(unsigned int t)
928 #if defined(HAVE_NANOSLEEP)
929 struct timespec tval;
932 tval.tv_sec = t/1000;
933 tval.tv_nsec = 1000000*(t%1000);
937 ret = nanosleep(&tval, &tval);
938 } while (ret < 0 && errno == EINTR && (tval.tv_sec > 0 || tval.tv_nsec > 0));
940 unsigned int tdiff=0;
941 struct timeval tval,t1,t2;
948 tval.tv_sec = (t-tdiff)/1000;
949 tval.tv_usec = 1000*((t-tdiff)%1000);
951 /* Never wait for more than 1 sec. */
952 if (tval.tv_sec > 1) {
959 sys_select_intr(0,&fds,NULL,NULL,&tval);
962 if (t2.tv_sec < t1.tv_sec) {
963 /* Someone adjusted time... */
967 tdiff = TvalDiff(&t1,&t2);
972 /****************************************************************************
973 Become a daemon, discarding the controlling terminal.
974 ****************************************************************************/
976 void become_daemon(bool Fork, bool no_process_group)
984 /* detach from the terminal */
986 if (!no_process_group) setsid();
987 #elif defined(TIOCNOTTY)
988 if (!no_process_group) {
989 int i = sys_open("/dev/tty", O_RDWR, 0);
991 ioctl(i, (int) TIOCNOTTY, (char *)0);
995 #endif /* HAVE_SETSID */
997 /* Close fd's 0,1,2. Needed if started by rsh */
998 close_low_fds(False); /* Don't close stderr, let the debug system
999 attach it to the logfile */
1002 bool reinit_after_fork(struct messaging_context *msg_ctx,
1003 bool parent_longlived)
1007 /* Reset the state of the random
1008 * number generation system, so
1009 * children do not get the same random
1010 * numbers as each other */
1011 set_need_random_reseed();
1013 /* tdb needs special fork handling */
1014 if (tdb_reopen_all(parent_longlived ? 1 : 0) == -1) {
1015 DEBUG(0,("tdb_reopen_all failed.\n"));
1020 * For clustering, we need to re-init our ctdbd connection after the
1023 status = messaging_reinit(msg_ctx);
1024 if (!NT_STATUS_IS_OK(status)) {
1025 DEBUG(0,("messaging_reinit() failed: %s\n",
1026 nt_errstr(status)));
1033 /****************************************************************************
1034 Put up a yes/no prompt.
1035 ****************************************************************************/
1037 bool yesno(const char *p)
1042 if (!fgets(ans,sizeof(ans)-1,stdin))
1045 if (*ans == 'y' || *ans == 'Y')
1051 #if defined(PARANOID_MALLOC_CHECKER)
1053 /****************************************************************************
1054 Internal malloc wrapper. Externally visible.
1055 ****************************************************************************/
1057 void *malloc_(size_t size)
1063 return malloc(size);
1064 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
1067 /****************************************************************************
1068 Internal calloc wrapper. Not externally visible.
1069 ****************************************************************************/
1071 static void *calloc_(size_t count, size_t size)
1073 if (size == 0 || count == 0) {
1077 return calloc(count, size);
1078 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
1081 /****************************************************************************
1082 Internal realloc wrapper. Not externally visible.
1083 ****************************************************************************/
1085 static void *realloc_(void *ptr, size_t size)
1088 return realloc(ptr, size);
1089 #define realloc(p,s) __ERROR_DONT_USE_RELLOC_DIRECTLY
1092 #endif /* PARANOID_MALLOC_CHECKER */
1094 /****************************************************************************
1096 ****************************************************************************/
1098 void *memalign_array(size_t el_size, size_t align, unsigned int count)
1100 if (count >= MAX_ALLOC_SIZE/el_size) {
1104 return sys_memalign(align, el_size*count);
1107 /****************************************************************************
1109 ****************************************************************************/
1111 void *calloc_array(size_t size, size_t nmemb)
1113 if (nmemb >= MAX_ALLOC_SIZE/size) {
1116 if (size == 0 || nmemb == 0) {
1119 #if defined(PARANOID_MALLOC_CHECKER)
1120 return calloc_(nmemb, size);
1122 return calloc(nmemb, size);
1126 /****************************************************************************
1127 Expand a pointer to be a particular size.
1128 Note that this version of Realloc has an extra parameter that decides
1129 whether to free the passed in storage on allocation failure or if the
1132 This is designed for use in the typical idiom of :
1134 p = SMB_REALLOC(p, size)
1139 and not to have to keep track of the old 'p' contents to free later, nor
1140 to worry if the size parameter was zero. In the case where NULL is returned
1141 we guarentee that p has been freed.
1143 If free later semantics are desired, then pass 'free_old_on_error' as False which
1144 guarentees that the old contents are not freed on error, even if size == 0. To use
1147 tmp = SMB_REALLOC_KEEP_OLD_ON_ERROR(p, size);
1155 Changes were instigated by Coverity error checking. JRA.
1156 ****************************************************************************/
1158 void *Realloc(void *p, size_t size, bool free_old_on_error)
1163 if (free_old_on_error) {
1166 DEBUG(2,("Realloc asked for 0 bytes\n"));
1170 #if defined(PARANOID_MALLOC_CHECKER)
1172 ret = (void *)malloc_(size);
1174 ret = (void *)realloc_(p,size);
1178 ret = (void *)malloc(size);
1180 ret = (void *)realloc(p,size);
1185 if (free_old_on_error && p) {
1188 DEBUG(0,("Memory allocation error: failed to expand to %d bytes\n",(int)size));
1194 /****************************************************************************
1195 (Hopefully) efficient array append.
1196 ****************************************************************************/
1198 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
1199 void *element, void *_array, uint32 *num_elements,
1200 ssize_t *array_size)
1202 void **array = (void **)_array;
1204 if (*array_size < 0) {
1208 if (*array == NULL) {
1209 if (*array_size == 0) {
1213 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
1217 *array = TALLOC(mem_ctx, element_size * (*array_size));
1218 if (*array == NULL) {
1223 if (*num_elements == *array_size) {
1226 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
1230 *array = TALLOC_REALLOC(mem_ctx, *array,
1231 element_size * (*array_size));
1233 if (*array == NULL) {
1238 memcpy((char *)(*array) + element_size*(*num_elements),
1239 element, element_size);
1249 /****************************************************************************
1250 Get my own name and IP.
1251 ****************************************************************************/
1253 char *talloc_get_myname(TALLOC_CTX *ctx)
1256 char hostname[HOST_NAME_MAX];
1260 /* get my host name */
1261 if (gethostname(hostname, sizeof(hostname)) == -1) {
1262 DEBUG(0,("gethostname failed\n"));
1266 /* Ensure null termination. */
1267 hostname[sizeof(hostname)-1] = '\0';
1269 /* split off any parts after an initial . */
1270 p = strchr_m(hostname,'.');
1275 return talloc_strdup(ctx, hostname);
1278 /****************************************************************************
1279 Get my own domain name, or "" if we have none.
1280 ****************************************************************************/
1282 char *get_mydnsdomname(TALLOC_CTX *ctx)
1284 const char *domname;
1287 domname = get_mydnsfullname();
1292 p = strchr_m(domname, '.');
1295 return talloc_strdup(ctx, p);
1297 return talloc_strdup(ctx, "");
1301 /****************************************************************************
1302 Interpret a protocol description string, with a default.
1303 ****************************************************************************/
1305 int interpret_protocol(const char *str,int def)
1307 if (strequal(str,"NT1"))
1308 return(PROTOCOL_NT1);
1309 if (strequal(str,"LANMAN2"))
1310 return(PROTOCOL_LANMAN2);
1311 if (strequal(str,"LANMAN1"))
1312 return(PROTOCOL_LANMAN1);
1313 if (strequal(str,"CORE"))
1314 return(PROTOCOL_CORE);
1315 if (strequal(str,"COREPLUS"))
1316 return(PROTOCOL_COREPLUS);
1317 if (strequal(str,"CORE+"))
1318 return(PROTOCOL_COREPLUS);
1320 DEBUG(0,("Unrecognised protocol level %s\n",str));
1326 #if (defined(HAVE_NETGROUP) && defined(WITH_AUTOMOUNT))
1327 /******************************************************************
1328 Remove any mount options such as -rsize=2048,wsize=2048 etc.
1329 Based on a fix from <Thomas.Hepper@icem.de>.
1330 Returns a malloc'ed string.
1331 *******************************************************************/
1333 static char *strip_mount_options(TALLOC_CTX *ctx, const char *str)
1336 const char *p = str;
1337 while(*p && !isspace(*p))
1339 while(*p && isspace(*p))
1342 return talloc_strdup(ctx, p);
1348 /*******************************************************************
1349 Patch from jkf@soton.ac.uk
1350 Split Luke's automount_server into YP lookup and string splitter
1351 so can easily implement automount_path().
1352 Returns a malloc'ed string.
1353 *******************************************************************/
1355 #ifdef WITH_NISPLUS_HOME
1356 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
1360 char *nis_map = (char *)lp_nis_home_map_name();
1362 char buffer[NIS_MAXATTRVAL + 1];
1367 snprintf(buffer, sizeof(buffer), "[key=%s],%s", user_name, nis_map);
1368 DEBUG(5, ("NIS+ querystring: %s\n", buffer));
1370 if (result = nis_list(buffer, FOLLOW_PATH|EXPAND_NAME|HARD_LOOKUP, NULL, NULL)) {
1371 if (result->status != NIS_SUCCESS) {
1372 DEBUG(3, ("NIS+ query failed: %s\n", nis_sperrno(result->status)));
1374 object = result->objects.objects_val;
1375 if (object->zo_data.zo_type == ENTRY_OBJ) {
1376 entry = &object->zo_data.objdata_u.en_data;
1377 DEBUG(5, ("NIS+ entry type: %s\n", entry->en_type));
1378 DEBUG(3, ("NIS+ result: %s\n", entry->en_cols.en_cols_val[1].ec_value.ec_value_val));
1380 value = talloc_strdup(ctx,
1381 entry->en_cols.en_cols_val[1].ec_value.ec_value_val);
1383 nis_freeresult(result);
1386 value = talloc_string_sub(ctx,
1393 nis_freeresult(result);
1396 value = strip_mount_options(ctx, value);
1397 DEBUG(4, ("NIS+ Lookup: %s resulted in %s\n",
1402 #else /* WITH_NISPLUS_HOME */
1404 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
1408 int nis_error; /* returned by yp all functions */
1409 char *nis_result; /* yp_match inits this */
1410 int nis_result_len; /* and set this */
1411 char *nis_domain; /* yp_get_default_domain inits this */
1412 char *nis_map = (char *)lp_nis_home_map_name();
1414 if ((nis_error = yp_get_default_domain(&nis_domain)) != 0) {
1415 DEBUG(3, ("YP Error: %s\n", yperr_string(nis_error)));
1419 DEBUG(5, ("NIS Domain: %s\n", nis_domain));
1421 if ((nis_error = yp_match(nis_domain, nis_map, user_name,
1422 strlen(user_name), &nis_result,
1423 &nis_result_len)) == 0) {
1424 value = talloc_strdup(ctx, nis_result);
1428 value = strip_mount_options(ctx, value);
1429 } else if(nis_error == YPERR_KEY) {
1430 DEBUG(3, ("YP Key not found: while looking up \"%s\" in map \"%s\"\n",
1431 user_name, nis_map));
1432 DEBUG(3, ("using defaults for server and home directory\n"));
1434 DEBUG(3, ("YP Error: \"%s\" while looking up \"%s\" in map \"%s\"\n",
1435 yperr_string(nis_error), user_name, nis_map));
1439 DEBUG(4, ("YP Lookup: %s resulted in %s\n", user_name, value));
1443 #endif /* WITH_NISPLUS_HOME */
1446 /****************************************************************************
1447 Check if a process exists. Does this work on all unixes?
1448 ****************************************************************************/
1450 bool process_exists(const struct server_id pid)
1452 if (procid_is_me(&pid)) {
1456 if (procid_is_local(&pid)) {
1457 return (kill(pid.pid,0) == 0 || errno != ESRCH);
1460 #ifdef CLUSTER_SUPPORT
1461 return ctdbd_process_exists(messaging_ctdbd_connection(), pid.vnn,
1468 /*******************************************************************
1469 Convert a uid into a user name.
1470 ********************************************************************/
1472 const char *uidtoname(uid_t uid)
1474 TALLOC_CTX *ctx = talloc_tos();
1476 struct passwd *pass = NULL;
1478 pass = getpwuid_alloc(ctx,uid);
1480 name = talloc_strdup(ctx,pass->pw_name);
1483 name = talloc_asprintf(ctx,
1490 /*******************************************************************
1491 Convert a gid into a group name.
1492 ********************************************************************/
1494 char *gidtoname(gid_t gid)
1498 grp = getgrgid(gid);
1500 return talloc_strdup(talloc_tos(), grp->gr_name);
1503 return talloc_asprintf(talloc_tos(),
1509 /*******************************************************************
1510 Convert a user name into a uid.
1511 ********************************************************************/
1513 uid_t nametouid(const char *name)
1515 struct passwd *pass;
1519 pass = getpwnam_alloc(talloc_autofree_context(), name);
1526 u = (uid_t)strtol(name, &p, 0);
1527 if ((p != name) && (*p == '\0'))
1533 /*******************************************************************
1534 Convert a name to a gid_t if possible. Return -1 if not a group.
1535 ********************************************************************/
1537 gid_t nametogid(const char *name)
1543 g = (gid_t)strtol(name, &p, 0);
1544 if ((p != name) && (*p == '\0'))
1547 grp = sys_getgrnam(name);
1549 return(grp->gr_gid);
1553 /*******************************************************************
1554 Something really nasty happened - panic !
1555 ********************************************************************/
1557 void smb_panic(const char *const why)
1565 if (global_clobber_region_function) {
1566 DEBUG(0,("smb_panic: clobber_region() last called from [%s(%u)]\n",
1567 global_clobber_region_function,
1568 global_clobber_region_line));
1573 DEBUG(0,("PANIC (pid %llu): %s\n",
1574 (unsigned long long)sys_getpid(), why));
1577 cmd = lp_panic_action();
1579 DEBUG(0, ("smb_panic(): calling panic action [%s]\n", cmd));
1580 result = system(cmd);
1583 DEBUG(0, ("smb_panic(): fork failed in panic action: %s\n",
1586 DEBUG(0, ("smb_panic(): action returned status %d\n",
1587 WEXITSTATUS(result)));
1593 /*******************************************************************
1594 Print a backtrace of the stack to the debug log. This function
1595 DELIBERATELY LEAKS MEMORY. The expectation is that you should
1596 exit shortly after calling it.
1597 ********************************************************************/
1599 #ifdef HAVE_LIBUNWIND_H
1600 #include <libunwind.h>
1603 #ifdef HAVE_EXECINFO_H
1604 #include <execinfo.h>
1607 #ifdef HAVE_LIBEXC_H
1611 void log_stack_trace(void)
1613 #ifdef HAVE_LIBUNWIND
1614 /* Try to use libunwind before any other technique since on ia64
1615 * libunwind correctly walks the stack in more circumstances than
1618 unw_cursor_t cursor;
1623 unw_word_t ip, sp, off;
1625 procname[sizeof(procname) - 1] = '\0';
1627 if (unw_getcontext(&uc) != 0) {
1628 goto libunwind_failed;
1631 if (unw_init_local(&cursor, &uc) != 0) {
1632 goto libunwind_failed;
1635 DEBUG(0, ("BACKTRACE:\n"));
1639 unw_get_reg(&cursor, UNW_REG_IP, &ip);
1640 unw_get_reg(&cursor, UNW_REG_SP, &sp);
1642 switch (unw_get_proc_name(&cursor,
1643 procname, sizeof(procname) - 1, &off) ) {
1647 /* Name truncated. */
1648 DEBUGADD(0, (" #%u %s + %#llx [ip=%#llx] [sp=%#llx]\n",
1649 i, procname, (long long)off,
1650 (long long)ip, (long long) sp));
1653 /* case -UNW_ENOINFO: */
1654 /* case -UNW_EUNSPEC: */
1655 /* No symbol name found. */
1656 DEBUGADD(0, (" #%u %s [ip=%#llx] [sp=%#llx]\n",
1657 i, "<unknown symbol>",
1658 (long long)ip, (long long) sp));
1661 } while (unw_step(&cursor) > 0);
1666 DEBUG(0, ("unable to produce a stack trace with libunwind\n"));
1668 #elif HAVE_BACKTRACE_SYMBOLS
1669 void *backtrace_stack[BACKTRACE_STACK_SIZE];
1670 size_t backtrace_size;
1671 char **backtrace_strings;
1673 /* get the backtrace (stack frames) */
1674 backtrace_size = backtrace(backtrace_stack,BACKTRACE_STACK_SIZE);
1675 backtrace_strings = backtrace_symbols(backtrace_stack, backtrace_size);
1677 DEBUG(0, ("BACKTRACE: %lu stack frames:\n",
1678 (unsigned long)backtrace_size));
1680 if (backtrace_strings) {
1683 for (i = 0; i < backtrace_size; i++)
1684 DEBUGADD(0, (" #%u %s\n", i, backtrace_strings[i]));
1686 /* Leak the backtrace_strings, rather than risk what free() might do */
1691 /* The IRIX libexc library provides an API for unwinding the stack. See
1692 * libexc(3) for details. Apparantly trace_back_stack leaks memory, but
1693 * since we are about to abort anyway, it hardly matters.
1696 #define NAMESIZE 32 /* Arbitrary */
1698 __uint64_t addrs[BACKTRACE_STACK_SIZE];
1699 char * names[BACKTRACE_STACK_SIZE];
1700 char namebuf[BACKTRACE_STACK_SIZE * NAMESIZE];
1707 ZERO_ARRAY(namebuf);
1709 /* We need to be root so we can open our /proc entry to walk
1710 * our stack. It also helps when we want to dump core.
1714 for (i = 0; i < BACKTRACE_STACK_SIZE; i++) {
1715 names[i] = namebuf + (i * NAMESIZE);
1718 levels = trace_back_stack(0, addrs, names,
1719 BACKTRACE_STACK_SIZE, NAMESIZE - 1);
1721 DEBUG(0, ("BACKTRACE: %d stack frames:\n", levels));
1722 for (i = 0; i < levels; i++) {
1723 DEBUGADD(0, (" #%d 0x%llx %s\n", i, addrs[i], names[i]));
1728 DEBUG(0, ("unable to produce a stack trace on this platform\n"));
1732 /*******************************************************************
1733 A readdir wrapper which just returns the file name.
1734 ********************************************************************/
1736 const char *readdirname(SMB_STRUCT_DIR *p)
1738 SMB_STRUCT_DIRENT *ptr;
1744 ptr = (SMB_STRUCT_DIRENT *)sys_readdir(p);
1748 dname = ptr->d_name;
1755 #ifdef HAVE_BROKEN_READDIR_NAME
1756 /* using /usr/ucb/cc is BAD */
1760 return talloc_strdup(talloc_tos(), dname);
1763 /*******************************************************************
1764 Utility function used to decide if the last component
1765 of a path matches a (possibly wildcarded) entry in a namelist.
1766 ********************************************************************/
1768 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive)
1770 const char *last_component;
1772 /* if we have no list it's obviously not in the path */
1773 if((namelist == NULL ) || ((namelist != NULL) && (namelist[0].name == NULL))) {
1777 DEBUG(8, ("is_in_path: %s\n", name));
1779 /* Get the last component of the unix name. */
1780 last_component = strrchr_m(name, '/');
1781 if (!last_component) {
1782 last_component = name;
1784 last_component++; /* Go past '/' */
1787 for(; namelist->name != NULL; namelist++) {
1788 if(namelist->is_wild) {
1789 if (mask_match(last_component, namelist->name, case_sensitive)) {
1790 DEBUG(8,("is_in_path: mask match succeeded\n"));
1794 if((case_sensitive && (strcmp(last_component, namelist->name) == 0))||
1795 (!case_sensitive && (StrCaseCmp(last_component, namelist->name) == 0))) {
1796 DEBUG(8,("is_in_path: match succeeded\n"));
1801 DEBUG(8,("is_in_path: match not found\n"));
1805 /*******************************************************************
1806 Strip a '/' separated list into an array of
1807 name_compare_enties structures suitable for
1808 passing to is_in_path(). We do this for
1809 speed so we can pre-parse all the names in the list
1810 and don't do it for each call to is_in_path().
1811 namelist is modified here and is assumed to be
1812 a copy owned by the caller.
1813 We also check if the entry contains a wildcard to
1814 remove a potentially expensive call to mask_match
1816 ********************************************************************/
1818 void set_namearray(name_compare_entry **ppname_array, const char *namelist)
1821 const char *nameptr = namelist;
1822 int num_entries = 0;
1825 (*ppname_array) = NULL;
1827 if((nameptr == NULL ) || ((nameptr != NULL) && (*nameptr == '\0')))
1830 /* We need to make two passes over the string. The
1831 first to count the number of elements, the second
1836 if ( *nameptr == '/' ) {
1837 /* cope with multiple (useless) /s) */
1841 /* find the next / */
1842 name_end = strchr_m(nameptr, '/');
1844 /* oops - the last check for a / didn't find one. */
1845 if (name_end == NULL)
1848 /* next segment please */
1849 nameptr = name_end + 1;
1853 if(num_entries == 0)
1856 if(( (*ppname_array) = SMB_MALLOC_ARRAY(name_compare_entry, num_entries + 1)) == NULL) {
1857 DEBUG(0,("set_namearray: malloc fail\n"));
1861 /* Now copy out the names */
1865 if ( *nameptr == '/' ) {
1866 /* cope with multiple (useless) /s) */
1870 /* find the next / */
1871 if ((name_end = strchr_m(nameptr, '/')) != NULL)
1874 /* oops - the last check for a / didn't find one. */
1875 if(name_end == NULL)
1878 (*ppname_array)[i].is_wild = ms_has_wild(nameptr);
1879 if(((*ppname_array)[i].name = SMB_STRDUP(nameptr)) == NULL) {
1880 DEBUG(0,("set_namearray: malloc fail (1)\n"));
1884 /* next segment please */
1885 nameptr = name_end + 1;
1889 (*ppname_array)[i].name = NULL;
1894 /****************************************************************************
1895 Routine to free a namearray.
1896 ****************************************************************************/
1898 void free_namearray(name_compare_entry *name_array)
1902 if(name_array == NULL)
1905 for(i=0; name_array[i].name!=NULL; i++)
1906 SAFE_FREE(name_array[i].name);
1907 SAFE_FREE(name_array);
1911 #define DBGC_CLASS DBGC_LOCKING
1913 /****************************************************************************
1914 Simple routine to query existing file locks. Cruft in NFS and 64->32 bit mapping
1915 is dealt with in posix.c
1916 Returns True if we have information regarding this lock region (and returns
1917 F_UNLCK in *ptype if the region is unlocked). False if the call failed.
1918 ****************************************************************************/
1920 bool fcntl_getlock(int fd, SMB_OFF_T *poffset, SMB_OFF_T *pcount, int *ptype, pid_t *ppid)
1922 SMB_STRUCT_FLOCK lock;
1925 DEBUG(8,("fcntl_getlock fd=%d offset=%.0f count=%.0f type=%d\n",
1926 fd,(double)*poffset,(double)*pcount,*ptype));
1928 lock.l_type = *ptype;
1929 lock.l_whence = SEEK_SET;
1930 lock.l_start = *poffset;
1931 lock.l_len = *pcount;
1934 ret = sys_fcntl_ptr(fd,SMB_F_GETLK,&lock);
1938 DEBUG(3,("fcntl_getlock: lock request failed at offset %.0f count %.0f type %d (%s)\n",
1939 (double)*poffset,(double)*pcount,*ptype,strerror(errno)));
1944 *ptype = lock.l_type;
1945 *poffset = lock.l_start;
1946 *pcount = lock.l_len;
1949 DEBUG(3,("fcntl_getlock: fd %d is returned info %d pid %u\n",
1950 fd, (int)lock.l_type, (unsigned int)lock.l_pid));
1955 #define DBGC_CLASS DBGC_ALL
1957 /*******************************************************************
1958 Is the name specified one of my netbios names.
1959 Returns true if it is equal, false otherwise.
1960 ********************************************************************/
1962 bool is_myname(const char *s)
1967 for (n=0; my_netbios_names(n); n++) {
1968 if (strequal(my_netbios_names(n), s)) {
1973 DEBUG(8, ("is_myname(\"%s\") returns %d\n", s, ret));
1977 /*******************************************************************
1978 Is the name specified our workgroup/domain.
1979 Returns true if it is equal, false otherwise.
1980 ********************************************************************/
1982 bool is_myworkgroup(const char *s)
1986 if (strequal(s, lp_workgroup())) {
1990 DEBUG(8, ("is_myworkgroup(\"%s\") returns %d\n", s, ret));
1994 /*******************************************************************
1995 we distinguish between 2K and XP by the "Native Lan Manager" string
1996 WinXP => "Windows 2002 5.1"
1997 WinXP 64bit => "Windows XP 5.2"
1998 Win2k => "Windows 2000 5.0"
1999 NT4 => "Windows NT 4.0"
2000 Win9x => "Windows 4.0"
2001 Windows 2003 doesn't set the native lan manager string but
2002 they do set the domain to "Windows 2003 5.2" (probably a bug).
2003 ********************************************************************/
2005 void ra_lanman_string( const char *native_lanman )
2007 if ( strcmp( native_lanman, "Windows 2002 5.1" ) == 0 )
2008 set_remote_arch( RA_WINXP );
2009 else if ( strcmp( native_lanman, "Windows XP 5.2" ) == 0 )
2010 set_remote_arch( RA_WINXP64 );
2011 else if ( strcmp( native_lanman, "Windows Server 2003 5.2" ) == 0 )
2012 set_remote_arch( RA_WIN2K3 );
2015 static const char *remote_arch_str;
2017 const char *get_remote_arch_str(void)
2019 if (!remote_arch_str) {
2022 return remote_arch_str;
2025 /*******************************************************************
2026 Set the horrid remote_arch string based on an enum.
2027 ********************************************************************/
2029 void set_remote_arch(enum remote_arch_types type)
2034 remote_arch_str = "WfWg";
2037 remote_arch_str = "OS2";
2040 remote_arch_str = "Win95";
2043 remote_arch_str = "WinNT";
2046 remote_arch_str = "Win2K";
2049 remote_arch_str = "WinXP";
2052 remote_arch_str = "WinXP64";
2055 remote_arch_str = "Win2K3";
2058 remote_arch_str = "Vista";
2061 remote_arch_str = "Samba";
2064 remote_arch_str = "CIFSFS";
2067 ra_type = RA_UNKNOWN;
2068 remote_arch_str = "UNKNOWN";
2072 DEBUG(10,("set_remote_arch: Client arch is \'%s\'\n",
2076 /*******************************************************************
2077 Get the remote_arch type.
2078 ********************************************************************/
2080 enum remote_arch_types get_remote_arch(void)
2085 const char *tab_depth(int level, int depth)
2087 if( CHECK_DEBUGLVL(level) ) {
2088 dbgtext("%*s", depth*4, "");
2093 /*****************************************************************************
2094 Provide a checksum on a string
2096 Input: s - the null-terminated character string for which the checksum
2099 Output: The checksum value calculated for s.
2100 *****************************************************************************/
2102 int str_checksum(const char *s)
2110 res ^= (c << (i % 15)) ^ (c >> (15-(i%15)));
2117 /*****************************************************************
2118 Zero a memory area then free it. Used to catch bugs faster.
2119 *****************************************************************/
2121 void zero_free(void *p, size_t size)
2127 /*****************************************************************
2128 Set our open file limit to a requested max and return the limit.
2129 *****************************************************************/
2131 int set_maxfiles(int requested_max)
2133 #if (defined(HAVE_GETRLIMIT) && defined(RLIMIT_NOFILE))
2135 int saved_current_limit;
2137 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
2138 DEBUG(0,("set_maxfiles: getrlimit (1) for RLIMIT_NOFILE failed with error %s\n",
2141 return requested_max;
2145 * Set the fd limit to be real_max_open_files + MAX_OPEN_FUDGEFACTOR to
2146 * account for the extra fd we need
2147 * as well as the log files and standard
2148 * handles etc. Save the limit we want to set in case
2149 * we are running on an OS that doesn't support this limit (AIX)
2150 * which always returns RLIM_INFINITY for rlp.rlim_max.
2153 /* Try raising the hard (max) limit to the requested amount. */
2155 #if defined(RLIM_INFINITY)
2156 if (rlp.rlim_max != RLIM_INFINITY) {
2157 int orig_max = rlp.rlim_max;
2159 if ( rlp.rlim_max < requested_max )
2160 rlp.rlim_max = requested_max;
2162 /* This failing is not an error - many systems (Linux) don't
2163 support our default request of 10,000 open files. JRA. */
2165 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
2166 DEBUG(3,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d max files failed with error %s\n",
2167 (int)rlp.rlim_max, strerror(errno) ));
2169 /* Set failed - restore original value from get. */
2170 rlp.rlim_max = orig_max;
2175 /* Now try setting the soft (current) limit. */
2177 saved_current_limit = rlp.rlim_cur = MIN(requested_max,rlp.rlim_max);
2179 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
2180 DEBUG(0,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d files failed with error %s\n",
2181 (int)rlp.rlim_cur, strerror(errno) ));
2183 return saved_current_limit;
2186 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
2187 DEBUG(0,("set_maxfiles: getrlimit (2) for RLIMIT_NOFILE failed with error %s\n",
2190 return saved_current_limit;
2193 #if defined(RLIM_INFINITY)
2194 if(rlp.rlim_cur == RLIM_INFINITY)
2195 return saved_current_limit;
2198 if((int)rlp.rlim_cur > saved_current_limit)
2199 return saved_current_limit;
2201 return rlp.rlim_cur;
2202 #else /* !defined(HAVE_GETRLIMIT) || !defined(RLIMIT_NOFILE) */
2204 * No way to know - just guess...
2206 return requested_max;
2210 /*****************************************************************
2211 Possibly replace mkstemp if it is broken.
2212 *****************************************************************/
2214 int smb_mkstemp(char *name_template)
2216 #if HAVE_SECURE_MKSTEMP
2217 return mkstemp(name_template);
2219 /* have a reasonable go at emulating it. Hope that
2220 the system mktemp() isn't completly hopeless */
2221 char *p = mktemp(name_template);
2224 return open(p, O_CREAT|O_EXCL|O_RDWR, 0600);
2228 /*****************************************************************
2229 malloc that aborts with smb_panic on fail or zero size.
2230 *****************************************************************/
2232 void *smb_xmalloc_array(size_t size, unsigned int count)
2236 smb_panic("smb_xmalloc_array: called with zero size");
2238 if (count >= MAX_ALLOC_SIZE/size) {
2239 smb_panic("smb_xmalloc_array: alloc size too large");
2241 if ((p = SMB_MALLOC(size*count)) == NULL) {
2242 DEBUG(0, ("smb_xmalloc_array failed to allocate %lu * %lu bytes\n",
2243 (unsigned long)size, (unsigned long)count));
2244 smb_panic("smb_xmalloc_array: malloc failed");
2250 vasprintf that aborts on malloc fail
2253 int smb_xvasprintf(char **ptr, const char *format, va_list ap)
2260 n = vasprintf(ptr, format, ap2);
2261 if (n == -1 || ! *ptr) {
2262 smb_panic("smb_xvasprintf: out of memory");
2268 /*****************************************************************
2269 Get local hostname and cache result.
2270 *****************************************************************/
2272 char *myhostname(void)
2276 /* This is cached forever so
2277 * use talloc_autofree_context() ctx. */
2278 ret = talloc_get_myname(talloc_autofree_context());
2283 /*****************************************************************
2284 A useful function for returning a path in the Samba pid directory.
2285 *****************************************************************/
2287 static char *xx_path(const char *name, const char *rootpath)
2291 fname = talloc_strdup(talloc_tos(), rootpath);
2295 trim_string(fname,"","/");
2297 if (!directory_exist(fname)) {
2301 return talloc_asprintf(talloc_tos(),
2307 /*****************************************************************
2308 A useful function for returning a path in the Samba lock directory.
2309 *****************************************************************/
2311 char *lock_path(const char *name)
2313 return xx_path(name, lp_lockdir());
2316 /*****************************************************************
2317 A useful function for returning a path in the Samba pid directory.
2318 *****************************************************************/
2320 char *pid_path(const char *name)
2322 return xx_path(name, lp_piddir());
2326 * @brief Returns an absolute path to a file in the Samba lib directory.
2328 * @param name File to find, relative to LIBDIR.
2330 * @retval Pointer to a string containing the full path.
2333 char *lib_path(const char *name)
2335 return talloc_asprintf(talloc_tos(), "%s/%s", get_dyn_LIBDIR(), name);
2339 * @brief Returns an absolute path to a file in the Samba modules directory.
2341 * @param name File to find, relative to MODULESDIR.
2343 * @retval Pointer to a string containing the full path.
2346 char *modules_path(const char *name)
2348 return talloc_asprintf(talloc_tos(), "%s/%s", get_dyn_MODULESDIR(), name);
2352 * @brief Returns an absolute path to a file in the Samba data directory.
2354 * @param name File to find, relative to CODEPAGEDIR.
2356 * @retval Pointer to a talloc'ed string containing the full path.
2359 char *data_path(const char *name)
2361 return talloc_asprintf(talloc_tos(), "%s/%s", get_dyn_CODEPAGEDIR(), name);
2364 /*****************************************************************
2365 a useful function for returning a path in the Samba state directory
2366 *****************************************************************/
2368 char *state_path(const char *name)
2370 return xx_path(name, get_dyn_STATEDIR());
2374 * @brief Returns the platform specific shared library extension.
2376 * @retval Pointer to a const char * containing the extension.
2379 const char *shlib_ext(void)
2381 return get_dyn_SHLIBEXT();
2384 /*******************************************************************
2385 Given a filename - get its directory name
2386 NB: Returned in static storage. Caveats:
2387 o If caller wishes to preserve, they should copy.
2388 ********************************************************************/
2390 char *parent_dirname(const char *path)
2394 if (!parent_dirname_talloc(talloc_tos(), path, &parent, NULL)) {
2401 bool parent_dirname_talloc(TALLOC_CTX *mem_ctx, const char *dir,
2402 char **parent, const char **name)
2407 p = strrchr_m(dir, '/'); /* Find final '/', if any */
2410 if (!(*parent = talloc_strdup(mem_ctx, "."))) {
2421 if (!(*parent = TALLOC_ARRAY(mem_ctx, char, len+1))) {
2424 memcpy(*parent, dir, len);
2425 (*parent)[len] = '\0';
2433 /*******************************************************************
2434 Determine if a pattern contains any Microsoft wildcard characters.
2435 *******************************************************************/
2437 bool ms_has_wild(const char *s)
2441 if (lp_posix_pathnames()) {
2442 /* With posix pathnames no characters are wild. */
2446 while ((c = *s++)) {
2459 bool ms_has_wild_w(const smb_ucs2_t *s)
2462 if (!s) return False;
2463 while ((c = *s++)) {
2465 case UCS2_CHAR('*'):
2466 case UCS2_CHAR('?'):
2467 case UCS2_CHAR('<'):
2468 case UCS2_CHAR('>'):
2469 case UCS2_CHAR('"'):
2476 /*******************************************************************
2477 A wrapper that handles case sensitivity and the special handling
2479 *******************************************************************/
2481 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive)
2483 if (strcmp(string,"..") == 0)
2485 if (strcmp(pattern,".") == 0)
2488 return ms_fnmatch(pattern, string, Protocol <= PROTOCOL_LANMAN2, is_case_sensitive) == 0;
2491 /*******************************************************************
2492 A wrapper that handles case sensitivity and the special handling
2493 of the ".." name. Varient that is only called by old search code which requires
2494 pattern translation.
2495 *******************************************************************/
2497 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive)
2499 if (strcmp(string,"..") == 0)
2501 if (strcmp(pattern,".") == 0)
2504 return ms_fnmatch(pattern, string, True, is_case_sensitive) == 0;
2507 /*******************************************************************
2508 A wrapper that handles a list of patters and calls mask_match()
2509 on each. Returns True if any of the patterns match.
2510 *******************************************************************/
2512 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive)
2514 while (listLen-- > 0) {
2515 if (mask_match(string, *list++, is_case_sensitive))
2521 /*********************************************************
2522 Recursive routine that is called by unix_wild_match.
2523 *********************************************************/
2525 static bool unix_do_match(const char *regexp, const char *str)
2529 for( p = regexp; *p && *str; ) {
2540 * Look for a character matching
2541 * the one after the '*'.
2545 return true; /* Automatic match */
2548 while(*str && (*p != *str))
2552 * Patch from weidel@multichart.de. In the case of the regexp
2553 * '*XX*' we want to ensure there are at least 2 'X' characters
2554 * in the string after the '*' for a match to be made.
2561 * Eat all the characters that match, but count how many there were.
2564 while(*str && (*p == *str)) {
2570 * Now check that if the regexp had n identical characters that
2571 * matchcount had at least that many matches.
2574 while ( *(p+1) && (*(p+1) == *p)) {
2579 if ( matchcount <= 0 )
2583 str--; /* We've eaten the match char after the '*' */
2585 if(unix_do_match(p, str))
2607 if (!*p && str[0] == '.' && str[1] == 0)
2610 if (!*str && *p == '?') {
2616 if(!*str && (*p == '*' && p[1] == '\0'))
2622 /*******************************************************************
2623 Simple case insensitive interface to a UNIX wildcard matcher.
2624 Returns True if match, False if not.
2625 *******************************************************************/
2627 bool unix_wild_match(const char *pattern, const char *string)
2629 TALLOC_CTX *ctx = talloc_stackframe();
2635 p2 = talloc_strdup(ctx,pattern);
2636 s2 = talloc_strdup(ctx,string);
2644 /* Remove any *? and ** from the pattern as they are meaningless */
2645 for(p = p2; *p; p++) {
2646 while( *p == '*' && (p[1] == '?' ||p[1] == '*')) {
2647 memmove(&p[1], &p[2], strlen(&p[2])+1);
2651 if (strequal(p2,"*")) {
2656 ret = unix_do_match(p2, s2);
2661 /**********************************************************************
2662 Converts a name to a fully qualified domain name.
2663 Returns true if lookup succeeded, false if not (then fqdn is set to name)
2664 Note we deliberately use gethostbyname here, not getaddrinfo as we want
2665 to examine the h_aliases and I don't know how to do that with getaddrinfo.
2666 ***********************************************************************/
2668 bool name_to_fqdn(fstring fqdn, const char *name)
2671 struct hostent *hp = gethostbyname(name);
2673 if (!hp || !hp->h_name || !*hp->h_name) {
2674 DEBUG(10,("name_to_fqdn: lookup for %s failed.\n", name));
2675 fstrcpy(fqdn, name);
2679 /* Find out if the fqdn is returned as an alias
2680 * to cope with /etc/hosts files where the first
2681 * name is not the fqdn but the short name */
2682 if (hp->h_aliases && (! strchr_m(hp->h_name, '.'))) {
2684 for (i = 0; hp->h_aliases[i]; i++) {
2685 if (strchr_m(hp->h_aliases[i], '.')) {
2686 full = hp->h_aliases[i];
2691 if (full && (StrCaseCmp(full, "localhost.localdomain") == 0)) {
2692 DEBUG(1, ("WARNING: your /etc/hosts file may be broken!\n"));
2693 DEBUGADD(1, (" Specifing the machine hostname for address 127.0.0.1 may lead\n"));
2694 DEBUGADD(1, (" to Kerberos authentication problems as localhost.localdomain\n"));
2695 DEBUGADD(1, (" may end up being used instead of the real machine FQDN.\n"));
2702 DEBUG(10,("name_to_fqdn: lookup for %s -> %s.\n", name, full));
2703 fstrcpy(fqdn, full);
2707 /**********************************************************************
2708 Append a DATA_BLOB to a talloc'ed object
2709 ***********************************************************************/
2711 void *talloc_append_blob(TALLOC_CTX *mem_ctx, void *buf, DATA_BLOB blob)
2713 size_t old_size = 0;
2716 if (blob.length == 0) {
2721 old_size = talloc_get_size(buf);
2724 result = (char *)TALLOC_REALLOC(mem_ctx, buf, old_size + blob.length);
2725 if (result == NULL) {
2729 memcpy(result + old_size, blob.data, blob.length);
2733 uint32 map_share_mode_to_deny_mode(uint32 share_access, uint32 private_options)
2735 switch (share_access & ~FILE_SHARE_DELETE) {
2736 case FILE_SHARE_NONE:
2738 case FILE_SHARE_READ:
2740 case FILE_SHARE_WRITE:
2742 case FILE_SHARE_READ|FILE_SHARE_WRITE:
2745 if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_DOS) {
2747 } else if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_FCB) {
2754 pid_t procid_to_pid(const struct server_id *proc)
2759 static uint32 my_vnn = NONCLUSTER_VNN;
2761 void set_my_vnn(uint32 vnn)
2763 DEBUG(10, ("vnn pid %d = %u\n", (int)sys_getpid(), (unsigned int)vnn));
2767 uint32 get_my_vnn(void)
2772 struct server_id pid_to_procid(pid_t pid)
2774 struct server_id result;
2776 #ifdef CLUSTER_SUPPORT
2777 result.vnn = my_vnn;
2782 struct server_id procid_self(void)
2784 return pid_to_procid(sys_getpid());
2787 struct server_id server_id_self(void)
2789 return procid_self();
2792 bool procid_equal(const struct server_id *p1, const struct server_id *p2)
2794 if (p1->pid != p2->pid)
2796 #ifdef CLUSTER_SUPPORT
2797 if (p1->vnn != p2->vnn)
2803 bool cluster_id_equal(const struct server_id *id1,
2804 const struct server_id *id2)
2806 return procid_equal(id1, id2);
2809 bool procid_is_me(const struct server_id *pid)
2811 if (pid->pid != sys_getpid())
2813 #ifdef CLUSTER_SUPPORT
2814 if (pid->vnn != my_vnn)
2820 struct server_id interpret_pid(const char *pid_string)
2822 #ifdef CLUSTER_SUPPORT
2823 unsigned int vnn, pid;
2824 struct server_id result;
2825 if (sscanf(pid_string, "%u:%u", &vnn, &pid) == 2) {
2829 else if (sscanf(pid_string, "%u", &pid) == 1) {
2830 result.vnn = get_my_vnn();
2834 result.vnn = NONCLUSTER_VNN;
2839 return pid_to_procid(atoi(pid_string));
2843 char *procid_str(TALLOC_CTX *mem_ctx, const struct server_id *pid)
2845 #ifdef CLUSTER_SUPPORT
2846 if (pid->vnn == NONCLUSTER_VNN) {
2847 return talloc_asprintf(mem_ctx,
2852 return talloc_asprintf(mem_ctx,
2858 return talloc_asprintf(mem_ctx,
2864 char *procid_str_static(const struct server_id *pid)
2866 return procid_str(talloc_tos(), pid);
2869 bool procid_valid(const struct server_id *pid)
2871 return (pid->pid != -1);
2874 bool procid_is_local(const struct server_id *pid)
2876 #ifdef CLUSTER_SUPPORT
2877 return pid->vnn == my_vnn;
2883 int this_is_smp(void)
2885 #if defined(HAVE_SYSCONF)
2887 #if defined(SYSCONF_SC_NPROC_ONLN)
2888 return (sysconf(_SC_NPROC_ONLN) > 1) ? 1 : 0;
2889 #elif defined(SYSCONF_SC_NPROCESSORS_ONLN)
2890 return (sysconf(_SC_NPROCESSORS_ONLN) > 1) ? 1 : 0;
2900 /****************************************************************
2901 Check if offset/length fit into bufsize. Should probably be
2902 merged with is_offset_safe, but this would require a rewrite
2903 of lanman.c. Later :-)
2904 ****************************************************************/
2906 bool trans_oob(uint32_t bufsize, uint32_t offset, uint32_t length)
2908 if ((offset + length < offset) || (offset + length < length)) {
2912 if ((offset > bufsize) || (offset + length > bufsize)) {
2919 /****************************************************************
2920 Check if an offset into a buffer is safe.
2921 If this returns True it's safe to indirect into the byte at
2923 ****************************************************************/
2925 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off)
2927 const char *end_base = buf_base + buf_len;
2928 char *end_ptr = ptr + off;
2930 if (!buf_base || !ptr) {
2934 if (end_base < buf_base || end_ptr < ptr) {
2935 return False; /* wrap. */
2938 if (end_ptr < end_base) {
2944 /****************************************************************
2945 Return a safe pointer into a buffer, or NULL.
2946 ****************************************************************/
2948 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
2950 return is_offset_safe(buf_base, buf_len, ptr, off) ?
2954 /****************************************************************
2955 Return a safe pointer into a string within a buffer, or NULL.
2956 ****************************************************************/
2958 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
2960 if (!is_offset_safe(buf_base, buf_len, ptr, off)) {
2963 /* Check if a valid string exists at this offset. */
2964 if (skip_string(buf_base,buf_len, ptr + off) == NULL) {
2970 /****************************************************************
2971 Return an SVAL at a pointer, or failval if beyond the end.
2972 ****************************************************************/
2974 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
2977 * Note we use off+1 here, not off+2 as SVAL accesses ptr[0] and ptr[1],
2980 if (!is_offset_safe(buf_base, buf_len, ptr, off+1)) {
2983 return SVAL(ptr,off);
2986 /****************************************************************
2987 Return an IVAL at a pointer, or failval if beyond the end.
2988 ****************************************************************/
2990 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
2993 * Note we use off+3 here, not off+4 as IVAL accesses
2994 * ptr[0] ptr[1] ptr[2] ptr[3] NOT ptr[4].
2996 if (!is_offset_safe(buf_base, buf_len, ptr, off+3)) {
2999 return IVAL(ptr,off);
3002 /****************************************************************
3003 Split DOM\user into DOM and user. Do not mix with winbind variants of that
3004 call (they take care of winbind separator and other winbind specific settings).
3005 ****************************************************************/
3007 void split_domain_user(TALLOC_CTX *mem_ctx,
3008 const char *full_name,
3012 const char *p = NULL;
3014 p = strchr_m(full_name, '\\');
3017 *domain = talloc_strndup(mem_ctx, full_name,
3018 PTR_DIFF(p, full_name));
3019 *user = talloc_strdup(mem_ctx, p+1);
3021 *domain = talloc_strdup(mem_ctx, "");
3022 *user = talloc_strdup(mem_ctx, full_name);
3028 Disable these now we have checked all code paths and ensured
3029 NULL returns on zero request. JRA.
3031 /****************************************************************
3032 talloc wrapper functions that guarentee a null pointer return
3034 ****************************************************************/
3036 #ifndef MAX_TALLOC_SIZE
3037 #define MAX_TALLOC_SIZE 0x10000000
3041 * talloc and zero memory.
3042 * - returns NULL if size is zero.
3045 void *_talloc_zero_zeronull(const void *ctx, size_t size, const char *name)
3053 p = talloc_named_const(ctx, size, name);
3056 memset(p, '\0', size);
3063 * memdup with a talloc.
3064 * - returns NULL if size is zero.
3067 void *_talloc_memdup_zeronull(const void *t, const void *p, size_t size, const char *name)
3075 newp = talloc_named_const(t, size, name);
3077 memcpy(newp, p, size);
3084 * alloc an array, checking for integer overflow in the array size.
3085 * - returns NULL if count or el_size are zero.
3088 void *_talloc_array_zeronull(const void *ctx, size_t el_size, unsigned count, const char *name)
3090 if (count >= MAX_TALLOC_SIZE/el_size) {
3094 if (el_size == 0 || count == 0) {
3098 return talloc_named_const(ctx, el_size * count, name);
3102 * alloc an zero array, checking for integer overflow in the array size
3103 * - returns NULL if count or el_size are zero.
3106 void *_talloc_zero_array_zeronull(const void *ctx, size_t el_size, unsigned count, const char *name)
3108 if (count >= MAX_TALLOC_SIZE/el_size) {
3112 if (el_size == 0 || count == 0) {
3116 return _talloc_zero(ctx, el_size * count, name);
3120 * Talloc wrapper that returns NULL if size == 0.
3122 void *talloc_zeronull(const void *context, size_t size, const char *name)
3127 return talloc_named_const(context, size, name);
3131 /* Split a path name into filename and stream name components. Canonicalise
3132 * such that an implicit $DATA token is always explicit.
3134 * The "specification" of this function can be found in the
3135 * run_local_stream_name() function in torture.c, I've tried those
3136 * combinations against a W2k3 server.
3139 NTSTATUS split_ntfs_stream_name(TALLOC_CTX *mem_ctx, const char *fname,
3140 char **pbase, char **pstream)
3143 char *stream = NULL;
3144 char *sname; /* stream name */
3145 const char *stype; /* stream type */
3147 DEBUG(10, ("split_ntfs_stream_name called for [%s]\n", fname));
3149 sname = strchr_m(fname, ':');
3151 if (lp_posix_pathnames() || (sname == NULL)) {
3152 if (pbase != NULL) {
3153 base = talloc_strdup(mem_ctx, fname);
3154 NT_STATUS_HAVE_NO_MEMORY(base);
3159 if (pbase != NULL) {
3160 base = talloc_strndup(mem_ctx, fname, PTR_DIFF(sname, fname));
3161 NT_STATUS_HAVE_NO_MEMORY(base);
3166 stype = strchr_m(sname, ':');
3168 if (stype == NULL) {
3169 sname = talloc_strdup(mem_ctx, sname);
3173 if (StrCaseCmp(stype, ":$DATA") != 0) {
3175 * If there is an explicit stream type, so far we only
3176 * allow $DATA. Is there anything else allowed? -- vl
3178 DEBUG(10, ("[%s] is an invalid stream type\n", stype));
3180 return NT_STATUS_OBJECT_NAME_INVALID;
3182 sname = talloc_strndup(mem_ctx, sname, PTR_DIFF(stype, sname));
3186 if (sname == NULL) {
3188 return NT_STATUS_NO_MEMORY;
3191 if (sname[0] == '\0') {
3193 * no stream name, so no stream
3198 if (pstream != NULL) {
3199 stream = talloc_asprintf(mem_ctx, "%s:%s", sname, stype);
3200 if (stream == NULL) {
3203 return NT_STATUS_NO_MEMORY;
3206 * upper-case the type field
3208 strupper_m(strchr_m(stream, ':')+1);
3212 if (pbase != NULL) {
3215 if (pstream != NULL) {
3218 return NT_STATUS_OK;
3221 bool is_valid_policy_hnd(const POLICY_HND *hnd)
3225 return (memcmp(&tmp, hnd, sizeof(tmp)) != 0);
3228 bool policy_hnd_equal(const struct policy_handle *hnd1,
3229 const struct policy_handle *hnd2)
3231 if (!hnd1 || !hnd2) {
3235 return (memcmp(hnd1, hnd2, sizeof(*hnd1)) == 0);
3238 /****************************************************************
3239 strip off leading '\\' from a hostname
3240 ****************************************************************/
3242 const char *strip_hostname(const char *s)
3248 if (strlen_m(s) < 3) {
3252 if (s[0] == '\\') s++;
3253 if (s[0] == '\\') s++;