samba-tool user: Fix typos, improve messages.
[Samba/wip.git] / source3 / lib / util.c
blob5ffce583db417a206e2e6b1859eec63624dd17f0
1 /*
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/>.
24 #include "includes.h"
25 #include "system/passwd.h"
26 #include "system/filesys.h"
27 #include "util_tdb.h"
28 #include "ctdbd_conn.h"
29 #include "../lib/util/util_pw.h"
30 #include "messages.h"
31 #include <ccan/hash/hash.h>
32 #include "libcli/security/security.h"
33 #include "serverid.h"
35 #ifdef HAVE_SYS_PRCTL_H
36 #include <sys/prctl.h>
37 #endif
39 /* Max allowable allococation - 256mb - 0x10000000 */
40 #define MAX_ALLOC_SIZE (1024*1024*256)
42 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
43 #ifdef WITH_NISPLUS_HOME
44 #ifdef BROKEN_NISPLUS_INCLUDE_FILES
46 * The following lines are needed due to buggy include files
47 * in Solaris 2.6 which define GROUP in both /usr/include/sys/acl.h and
48 * also in /usr/include/rpcsvc/nis.h. The definitions conflict. JRA.
49 * Also GROUP_OBJ is defined as 0x4 in /usr/include/sys/acl.h and as
50 * an enum in /usr/include/rpcsvc/nis.h.
53 #if defined(GROUP)
54 #undef GROUP
55 #endif
57 #if defined(GROUP_OBJ)
58 #undef GROUP_OBJ
59 #endif
61 #endif /* BROKEN_NISPLUS_INCLUDE_FILES */
63 #include <rpcsvc/nis.h>
65 #endif /* WITH_NISPLUS_HOME */
66 #endif /* HAVE_NETGROUP && WITH_AUTOMOUNT */
68 static enum protocol_types Protocol = PROTOCOL_COREPLUS;
70 enum protocol_types get_Protocol(void)
72 return Protocol;
75 void set_Protocol(enum protocol_types p)
77 Protocol = p;
80 static enum remote_arch_types ra_type = RA_UNKNOWN;
82 void gfree_all( void )
84 gfree_names();
85 gfree_loadparm();
86 gfree_charcnv();
87 gfree_interfaces();
88 gfree_debugsyms();
91 /*******************************************************************
92 Check if a file exists - call vfs_file_exist for samba files.
93 ********************************************************************/
95 bool file_exist_stat(const char *fname,SMB_STRUCT_STAT *sbuf,
96 bool fake_dir_create_times)
98 SMB_STRUCT_STAT st;
99 if (!sbuf)
100 sbuf = &st;
102 if (sys_stat(fname, sbuf, fake_dir_create_times) != 0)
103 return(False);
105 return((S_ISREG(sbuf->st_ex_mode)) || (S_ISFIFO(sbuf->st_ex_mode)));
108 /*******************************************************************
109 Check if a unix domain socket exists - call vfs_file_exist for samba files.
110 ********************************************************************/
112 bool socket_exist(const char *fname)
114 SMB_STRUCT_STAT st;
115 if (sys_stat(fname, &st, false) != 0)
116 return(False);
118 return S_ISSOCK(st.st_ex_mode);
121 /*******************************************************************
122 Returns the size in bytes of the named given the stat struct.
123 ********************************************************************/
125 uint64_t get_file_size_stat(const SMB_STRUCT_STAT *sbuf)
127 return sbuf->st_ex_size;
130 /****************************************************************************
131 Check two stats have identical dev and ino fields.
132 ****************************************************************************/
134 bool check_same_dev_ino(const SMB_STRUCT_STAT *sbuf1,
135 const SMB_STRUCT_STAT *sbuf2)
137 if (sbuf1->st_ex_dev != sbuf2->st_ex_dev ||
138 sbuf1->st_ex_ino != sbuf2->st_ex_ino) {
139 return false;
141 return true;
144 /****************************************************************************
145 Check if a stat struct is identical for use.
146 ****************************************************************************/
148 bool check_same_stat(const SMB_STRUCT_STAT *sbuf1,
149 const SMB_STRUCT_STAT *sbuf2)
151 if (sbuf1->st_ex_uid != sbuf2->st_ex_uid ||
152 sbuf1->st_ex_gid != sbuf2->st_ex_gid ||
153 !check_same_dev_ino(sbuf1, sbuf2)) {
154 return false;
156 return true;
159 /*******************************************************************
160 Show a smb message structure.
161 ********************************************************************/
163 void show_msg(const char *buf)
165 int i;
166 int bcc=0;
168 if (!DEBUGLVL(5))
169 return;
171 DEBUG(5,("size=%d\nsmb_com=0x%x\nsmb_rcls=%d\nsmb_reh=%d\nsmb_err=%d\nsmb_flg=%d\nsmb_flg2=%d\n",
172 smb_len(buf),
173 (int)CVAL(buf,smb_com),
174 (int)CVAL(buf,smb_rcls),
175 (int)CVAL(buf,smb_reh),
176 (int)SVAL(buf,smb_err),
177 (int)CVAL(buf,smb_flg),
178 (int)SVAL(buf,smb_flg2)));
179 DEBUGADD(5,("smb_tid=%d\nsmb_pid=%d\nsmb_uid=%d\nsmb_mid=%d\n",
180 (int)SVAL(buf,smb_tid),
181 (int)SVAL(buf,smb_pid),
182 (int)SVAL(buf,smb_uid),
183 (int)SVAL(buf,smb_mid)));
184 DEBUGADD(5,("smt_wct=%d\n",(int)CVAL(buf,smb_wct)));
186 for (i=0;i<(int)CVAL(buf,smb_wct);i++)
187 DEBUGADD(5,("smb_vwv[%2d]=%5d (0x%X)\n",i,
188 SVAL(buf,smb_vwv+2*i),SVAL(buf,smb_vwv+2*i)));
190 bcc = (int)SVAL(buf,smb_vwv+2*(CVAL(buf,smb_wct)));
192 DEBUGADD(5,("smb_bcc=%d\n",bcc));
194 if (DEBUGLEVEL < 10)
195 return;
197 if (DEBUGLEVEL < 50)
198 bcc = MIN(bcc, 512);
200 dump_data(10, (const uint8 *)smb_buf_const(buf), bcc);
203 /*******************************************************************
204 Setup only the byte count for a smb message.
205 ********************************************************************/
207 int set_message_bcc(char *buf,int num_bytes)
209 int num_words = CVAL(buf,smb_wct);
210 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
211 _smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
212 return (smb_size + num_words*2 + num_bytes);
215 /*******************************************************************
216 Add a data blob to the end of a smb_buf, adjusting bcc and smb_len.
217 Return the bytes added
218 ********************************************************************/
220 ssize_t message_push_blob(uint8 **outbuf, DATA_BLOB blob)
222 size_t newlen = smb_len(*outbuf) + 4 + blob.length;
223 uint8 *tmp;
225 if (!(tmp = talloc_realloc(NULL, *outbuf, uint8, newlen))) {
226 DEBUG(0, ("talloc failed\n"));
227 return -1;
229 *outbuf = tmp;
231 memcpy(tmp + smb_len(tmp) + 4, blob.data, blob.length);
232 set_message_bcc((char *)tmp, smb_buflen(tmp) + blob.length);
233 return blob.length;
236 /*******************************************************************
237 Reduce a file name, removing .. elements.
238 ********************************************************************/
240 static char *dos_clean_name(TALLOC_CTX *ctx, const char *s)
242 char *p = NULL;
243 char *str = NULL;
245 DEBUG(3,("dos_clean_name [%s]\n",s));
247 /* remove any double slashes */
248 str = talloc_all_string_sub(ctx, s, "\\\\", "\\");
249 if (!str) {
250 return NULL;
253 /* Remove leading .\\ characters */
254 if(strncmp(str, ".\\", 2) == 0) {
255 trim_string(str, ".\\", NULL);
256 if(*str == 0) {
257 str = talloc_strdup(ctx, ".\\");
258 if (!str) {
259 return NULL;
264 while ((p = strstr_m(str,"\\..\\")) != NULL) {
265 char *s1;
267 *p = 0;
268 s1 = p+3;
270 if ((p=strrchr_m(str,'\\')) != NULL) {
271 *p = 0;
272 } else {
273 *str = 0;
275 str = talloc_asprintf(ctx,
276 "%s%s",
277 str,
278 s1);
279 if (!str) {
280 return NULL;
284 trim_string(str,NULL,"\\..");
285 return talloc_all_string_sub(ctx, str, "\\.\\", "\\");
288 /*******************************************************************
289 Reduce a file name, removing .. elements.
290 ********************************************************************/
292 char *unix_clean_name(TALLOC_CTX *ctx, const char *s)
294 char *p = NULL;
295 char *str = NULL;
297 DEBUG(3,("unix_clean_name [%s]\n",s));
299 /* remove any double slashes */
300 str = talloc_all_string_sub(ctx, s, "//","/");
301 if (!str) {
302 return NULL;
305 /* Remove leading ./ characters */
306 if(strncmp(str, "./", 2) == 0) {
307 trim_string(str, "./", NULL);
308 if(*str == 0) {
309 str = talloc_strdup(ctx, "./");
310 if (!str) {
311 return NULL;
316 while ((p = strstr_m(str,"/../")) != NULL) {
317 char *s1;
319 *p = 0;
320 s1 = p+3;
322 if ((p=strrchr_m(str,'/')) != NULL) {
323 *p = 0;
324 } else {
325 *str = 0;
327 str = talloc_asprintf(ctx,
328 "%s%s",
329 str,
330 s1);
331 if (!str) {
332 return NULL;
336 trim_string(str,NULL,"/..");
337 return talloc_all_string_sub(ctx, str, "/./", "/");
340 char *clean_name(TALLOC_CTX *ctx, const char *s)
342 char *str = dos_clean_name(ctx, s);
343 if (!str) {
344 return NULL;
346 return unix_clean_name(ctx, str);
349 /*******************************************************************
350 Write data into an fd at a given offset. Ignore seek errors.
351 ********************************************************************/
353 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, off_t pos)
355 size_t total=0;
356 ssize_t ret;
358 if (pos == (off_t)-1) {
359 return write_data(fd, buffer, N);
361 #if defined(HAVE_PWRITE) || defined(HAVE_PRWITE64)
362 while (total < N) {
363 ret = sys_pwrite(fd,buffer + total,N - total, pos);
364 if (ret == -1 && errno == ESPIPE) {
365 return write_data(fd, buffer + total,N - total);
367 if (ret == -1) {
368 DEBUG(0,("write_data_at_offset: write failure. Error = %s\n", strerror(errno) ));
369 return -1;
371 if (ret == 0) {
372 return total;
374 total += ret;
375 pos += ret;
377 return (ssize_t)total;
378 #else
379 /* Use lseek and write_data. */
380 if (lseek(fd, pos, SEEK_SET) == -1) {
381 if (errno != ESPIPE) {
382 return -1;
385 return write_data(fd, buffer, N);
386 #endif
389 static int reinit_after_fork_pipe[2] = { -1, -1 };
391 NTSTATUS init_before_fork(void)
393 int ret;
395 ret = pipe(reinit_after_fork_pipe);
396 if (ret == -1) {
397 NTSTATUS status;
399 status = map_nt_error_from_unix_common(errno);
401 DEBUG(0, ("Error creating child_pipe: %s\n",
402 nt_errstr(status)));
404 return status;
407 return NT_STATUS_OK;
411 * Detect died parent by detecting EOF on the pipe
413 static void reinit_after_fork_pipe_handler(struct tevent_context *ev,
414 struct tevent_fd *fde,
415 uint16_t flags,
416 void *private_data)
418 char c;
420 if (sys_read(reinit_after_fork_pipe[0], &c, 1) != 1) {
422 * we have reached EOF on stdin, which means the
423 * parent has exited. Shutdown the server
425 (void)kill(getpid(), SIGTERM);
430 NTSTATUS reinit_after_fork(struct messaging_context *msg_ctx,
431 struct event_context *ev_ctx,
432 bool parent_longlived)
434 NTSTATUS status = NT_STATUS_OK;
436 if (reinit_after_fork_pipe[1] != -1) {
437 close(reinit_after_fork_pipe[1]);
438 reinit_after_fork_pipe[1] = -1;
441 /* Reset the state of the random
442 * number generation system, so
443 * children do not get the same random
444 * numbers as each other */
445 set_need_random_reseed();
447 /* tdb needs special fork handling */
448 if (tdb_reopen_all(parent_longlived ? 1 : 0) != 0) {
449 DEBUG(0,("tdb_reopen_all failed.\n"));
450 status = NT_STATUS_OPEN_FAILED;
451 goto done;
454 if (ev_ctx && tevent_re_initialise(ev_ctx) != 0) {
455 smb_panic(__location__ ": Failed to re-initialise event context");
458 if (reinit_after_fork_pipe[0] != -1) {
459 struct tevent_fd *fde;
461 fde = tevent_add_fd(ev_ctx, ev_ctx /* TALLOC_CTX */,
462 reinit_after_fork_pipe[0], TEVENT_FD_READ,
463 reinit_after_fork_pipe_handler, NULL);
464 if (fde == NULL) {
465 smb_panic(__location__ ": Failed to add reinit_after_fork pipe event");
469 if (msg_ctx) {
471 * For clustering, we need to re-init our ctdbd connection after the
472 * fork
474 status = messaging_reinit(msg_ctx);
475 if (!NT_STATUS_IS_OK(status)) {
476 DEBUG(0,("messaging_reinit() failed: %s\n",
477 nt_errstr(status)));
480 done:
481 return status;
484 /****************************************************************************
485 (Hopefully) efficient array append.
486 ****************************************************************************/
488 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
489 void *element, void *_array, uint32 *num_elements,
490 ssize_t *array_size)
492 void **array = (void **)_array;
494 if (*array_size < 0) {
495 return;
498 if (*array == NULL) {
499 if (*array_size == 0) {
500 *array_size = 128;
503 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
504 goto error;
507 *array = TALLOC(mem_ctx, element_size * (*array_size));
508 if (*array == NULL) {
509 goto error;
513 if (*num_elements == *array_size) {
514 *array_size *= 2;
516 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
517 goto error;
520 *array = TALLOC_REALLOC(mem_ctx, *array,
521 element_size * (*array_size));
523 if (*array == NULL) {
524 goto error;
528 memcpy((char *)(*array) + element_size*(*num_elements),
529 element, element_size);
530 *num_elements += 1;
532 return;
534 error:
535 *num_elements = 0;
536 *array_size = -1;
539 /****************************************************************************
540 Get my own domain name, or "" if we have none.
541 ****************************************************************************/
543 char *get_mydnsdomname(TALLOC_CTX *ctx)
545 const char *domname;
546 char *p;
548 domname = get_mydnsfullname();
549 if (!domname) {
550 return NULL;
553 p = strchr_m(domname, '.');
554 if (p) {
555 p++;
556 return talloc_strdup(ctx, p);
557 } else {
558 return talloc_strdup(ctx, "");
562 /****************************************************************************
563 Interpret a protocol description string, with a default.
564 ****************************************************************************/
566 int interpret_protocol(const char *str,int def)
568 if (strequal(str,"NT1"))
569 return(PROTOCOL_NT1);
570 if (strequal(str,"LANMAN2"))
571 return(PROTOCOL_LANMAN2);
572 if (strequal(str,"LANMAN1"))
573 return(PROTOCOL_LANMAN1);
574 if (strequal(str,"CORE"))
575 return(PROTOCOL_CORE);
576 if (strequal(str,"COREPLUS"))
577 return(PROTOCOL_COREPLUS);
578 if (strequal(str,"CORE+"))
579 return(PROTOCOL_COREPLUS);
581 DEBUG(0,("Unrecognised protocol level %s\n",str));
583 return(def);
587 #if (defined(HAVE_NETGROUP) && defined(WITH_AUTOMOUNT))
588 /******************************************************************
589 Remove any mount options such as -rsize=2048,wsize=2048 etc.
590 Based on a fix from <Thomas.Hepper@icem.de>.
591 Returns a malloc'ed string.
592 *******************************************************************/
594 static char *strip_mount_options(TALLOC_CTX *ctx, const char *str)
596 if (*str == '-') {
597 const char *p = str;
598 while(*p && !isspace(*p))
599 p++;
600 while(*p && isspace(*p))
601 p++;
602 if(*p) {
603 return talloc_strdup(ctx, p);
606 return NULL;
609 /*******************************************************************
610 Patch from jkf@soton.ac.uk
611 Split Luke's automount_server into YP lookup and string splitter
612 so can easily implement automount_path().
613 Returns a malloc'ed string.
614 *******************************************************************/
616 #ifdef WITH_NISPLUS_HOME
617 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
619 char *value = NULL;
621 char *nis_map = (char *)lp_nis_home_map_name();
623 char buffer[NIS_MAXATTRVAL + 1];
624 nis_result *result;
625 nis_object *object;
626 entry_obj *entry;
628 snprintf(buffer, sizeof(buffer), "[key=%s],%s", user_name, nis_map);
629 DEBUG(5, ("NIS+ querystring: %s\n", buffer));
631 if (result = nis_list(buffer, FOLLOW_PATH|EXPAND_NAME|HARD_LOOKUP, NULL, NULL)) {
632 if (result->status != NIS_SUCCESS) {
633 DEBUG(3, ("NIS+ query failed: %s\n", nis_sperrno(result->status)));
634 } else {
635 object = result->objects.objects_val;
636 if (object->zo_data.zo_type == ENTRY_OBJ) {
637 entry = &object->zo_data.objdata_u.en_data;
638 DEBUG(5, ("NIS+ entry type: %s\n", entry->en_type));
639 DEBUG(3, ("NIS+ result: %s\n", entry->en_cols.en_cols_val[1].ec_value.ec_value_val));
641 value = talloc_strdup(ctx,
642 entry->en_cols.en_cols_val[1].ec_value.ec_value_val);
643 if (!value) {
644 nis_freeresult(result);
645 return NULL;
647 value = talloc_string_sub(ctx,
648 value,
649 "&",
650 user_name);
654 nis_freeresult(result);
656 if (value) {
657 value = strip_mount_options(ctx, value);
658 DEBUG(4, ("NIS+ Lookup: %s resulted in %s\n",
659 user_name, value));
661 return value;
663 #else /* WITH_NISPLUS_HOME */
665 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
667 char *value = NULL;
669 int nis_error; /* returned by yp all functions */
670 char *nis_result; /* yp_match inits this */
671 int nis_result_len; /* and set this */
672 char *nis_domain; /* yp_get_default_domain inits this */
673 char *nis_map = lp_nis_home_map_name(talloc_tos());
675 if ((nis_error = yp_get_default_domain(&nis_domain)) != 0) {
676 DEBUG(3, ("YP Error: %s\n", yperr_string(nis_error)));
677 return NULL;
680 DEBUG(5, ("NIS Domain: %s\n", nis_domain));
682 if ((nis_error = yp_match(nis_domain, nis_map, user_name,
683 strlen(user_name), &nis_result,
684 &nis_result_len)) == 0) {
685 if (nis_result_len > 0 && nis_result[nis_result_len] == '\n') {
686 nis_result[nis_result_len] = '\0';
688 value = talloc_strdup(ctx, nis_result);
689 if (!value) {
690 return NULL;
692 value = strip_mount_options(ctx, value);
693 } else if(nis_error == YPERR_KEY) {
694 DEBUG(3, ("YP Key not found: while looking up \"%s\" in map \"%s\"\n",
695 user_name, nis_map));
696 DEBUG(3, ("using defaults for server and home directory\n"));
697 } else {
698 DEBUG(3, ("YP Error: \"%s\" while looking up \"%s\" in map \"%s\"\n",
699 yperr_string(nis_error), user_name, nis_map));
702 if (value) {
703 DEBUG(4, ("YP Lookup: %s resulted in %s\n", user_name, value));
705 return value;
707 #endif /* WITH_NISPLUS_HOME */
708 #endif
710 bool process_exists(const struct server_id pid)
712 return serverid_exists(&pid);
715 /*******************************************************************
716 Convert a uid into a user name.
717 ********************************************************************/
719 const char *uidtoname(uid_t uid)
721 TALLOC_CTX *ctx = talloc_tos();
722 char *name = NULL;
723 struct passwd *pass = NULL;
725 pass = getpwuid_alloc(ctx,uid);
726 if (pass) {
727 name = talloc_strdup(ctx,pass->pw_name);
728 TALLOC_FREE(pass);
729 } else {
730 name = talloc_asprintf(ctx,
731 "%ld",
732 (long int)uid);
734 return name;
737 /*******************************************************************
738 Convert a gid into a group name.
739 ********************************************************************/
741 char *gidtoname(gid_t gid)
743 struct group *grp;
745 grp = getgrgid(gid);
746 if (grp) {
747 return talloc_strdup(talloc_tos(), grp->gr_name);
749 else {
750 return talloc_asprintf(talloc_tos(),
751 "%d",
752 (int)gid);
756 /*******************************************************************
757 Convert a user name into a uid.
758 ********************************************************************/
760 uid_t nametouid(const char *name)
762 struct passwd *pass;
763 char *p;
764 uid_t u;
766 pass = Get_Pwnam_alloc(talloc_tos(), name);
767 if (pass) {
768 u = pass->pw_uid;
769 TALLOC_FREE(pass);
770 return u;
773 u = (uid_t)strtol(name, &p, 0);
774 if ((p != name) && (*p == '\0'))
775 return u;
777 return (uid_t)-1;
780 /*******************************************************************
781 Convert a name to a gid_t if possible. Return -1 if not a group.
782 ********************************************************************/
784 gid_t nametogid(const char *name)
786 struct group *grp;
787 char *p;
788 gid_t g;
790 g = (gid_t)strtol(name, &p, 0);
791 if ((p != name) && (*p == '\0'))
792 return g;
794 grp = getgrnam(name);
795 if (grp)
796 return(grp->gr_gid);
797 return (gid_t)-1;
800 /*******************************************************************
801 Something really nasty happened - panic !
802 ********************************************************************/
804 void smb_panic_s3(const char *why)
806 char *cmd;
807 int result;
809 DEBUG(0,("PANIC (pid %llu): %s\n",
810 (unsigned long long)getpid(), why));
811 log_stack_trace();
813 #if defined(HAVE_PRCTL) && defined(PR_SET_PTRACER)
815 * Make sure all children can attach a debugger.
817 prctl(PR_SET_PTRACER, getpid(), 0, 0, 0);
818 #endif
820 cmd = lp_panic_action(talloc_tos());
821 if (cmd && *cmd) {
822 DEBUG(0, ("smb_panic(): calling panic action [%s]\n", cmd));
823 result = system(cmd);
825 if (result == -1)
826 DEBUG(0, ("smb_panic(): fork failed in panic action: %s\n",
827 strerror(errno)));
828 else
829 DEBUG(0, ("smb_panic(): action returned status %d\n",
830 WEXITSTATUS(result)));
833 dump_core();
836 /*******************************************************************
837 Print a backtrace of the stack to the debug log. This function
838 DELIBERATELY LEAKS MEMORY. The expectation is that you should
839 exit shortly after calling it.
840 ********************************************************************/
842 #ifdef HAVE_LIBUNWIND_H
843 #include <libunwind.h>
844 #endif
846 #ifdef HAVE_EXECINFO_H
847 #include <execinfo.h>
848 #endif
850 #ifdef HAVE_LIBEXC_H
851 #include <libexc.h>
852 #endif
854 void log_stack_trace(void)
856 #ifdef HAVE_LIBUNWIND
857 /* Try to use libunwind before any other technique since on ia64
858 * libunwind correctly walks the stack in more circumstances than
859 * backtrace.
861 unw_cursor_t cursor;
862 unw_context_t uc;
863 unsigned i = 0;
865 char procname[256];
866 unw_word_t ip, sp, off;
868 procname[sizeof(procname) - 1] = '\0';
870 if (unw_getcontext(&uc) != 0) {
871 goto libunwind_failed;
874 if (unw_init_local(&cursor, &uc) != 0) {
875 goto libunwind_failed;
878 DEBUG(0, ("BACKTRACE:\n"));
880 do {
881 ip = sp = 0;
882 unw_get_reg(&cursor, UNW_REG_IP, &ip);
883 unw_get_reg(&cursor, UNW_REG_SP, &sp);
885 switch (unw_get_proc_name(&cursor,
886 procname, sizeof(procname) - 1, &off) ) {
887 case 0:
888 /* Name found. */
889 case -UNW_ENOMEM:
890 /* Name truncated. */
891 DEBUGADD(0, (" #%u %s + %#llx [ip=%#llx] [sp=%#llx]\n",
892 i, procname, (long long)off,
893 (long long)ip, (long long) sp));
894 break;
895 default:
896 /* case -UNW_ENOINFO: */
897 /* case -UNW_EUNSPEC: */
898 /* No symbol name found. */
899 DEBUGADD(0, (" #%u %s [ip=%#llx] [sp=%#llx]\n",
900 i, "<unknown symbol>",
901 (long long)ip, (long long) sp));
903 ++i;
904 } while (unw_step(&cursor) > 0);
906 return;
908 libunwind_failed:
909 DEBUG(0, ("unable to produce a stack trace with libunwind\n"));
911 #elif HAVE_BACKTRACE_SYMBOLS
912 void *backtrace_stack[BACKTRACE_STACK_SIZE];
913 size_t backtrace_size;
914 char **backtrace_strings;
916 /* get the backtrace (stack frames) */
917 backtrace_size = backtrace(backtrace_stack,BACKTRACE_STACK_SIZE);
918 backtrace_strings = backtrace_symbols(backtrace_stack, backtrace_size);
920 DEBUG(0, ("BACKTRACE: %lu stack frames:\n",
921 (unsigned long)backtrace_size));
923 if (backtrace_strings) {
924 int i;
926 for (i = 0; i < backtrace_size; i++)
927 DEBUGADD(0, (" #%u %s\n", i, backtrace_strings[i]));
929 /* Leak the backtrace_strings, rather than risk what free() might do */
932 #elif HAVE_LIBEXC
934 /* The IRIX libexc library provides an API for unwinding the stack. See
935 * libexc(3) for details. Apparantly trace_back_stack leaks memory, but
936 * since we are about to abort anyway, it hardly matters.
939 #define NAMESIZE 32 /* Arbitrary */
941 __uint64_t addrs[BACKTRACE_STACK_SIZE];
942 char * names[BACKTRACE_STACK_SIZE];
943 char namebuf[BACKTRACE_STACK_SIZE * NAMESIZE];
945 int i;
946 int levels;
948 ZERO_ARRAY(addrs);
949 ZERO_ARRAY(names);
950 ZERO_ARRAY(namebuf);
952 /* We need to be root so we can open our /proc entry to walk
953 * our stack. It also helps when we want to dump core.
955 become_root();
957 for (i = 0; i < BACKTRACE_STACK_SIZE; i++) {
958 names[i] = namebuf + (i * NAMESIZE);
961 levels = trace_back_stack(0, addrs, names,
962 BACKTRACE_STACK_SIZE, NAMESIZE - 1);
964 DEBUG(0, ("BACKTRACE: %d stack frames:\n", levels));
965 for (i = 0; i < levels; i++) {
966 DEBUGADD(0, (" #%d 0x%llx %s\n", i, addrs[i], names[i]));
968 #undef NAMESIZE
970 #else
971 DEBUG(0, ("unable to produce a stack trace on this platform\n"));
972 #endif
975 /*******************************************************************
976 A readdir wrapper which just returns the file name.
977 ********************************************************************/
979 const char *readdirname(DIR *p)
981 struct dirent *ptr;
982 char *dname;
984 if (!p)
985 return(NULL);
987 ptr = (struct dirent *)readdir(p);
988 if (!ptr)
989 return(NULL);
991 dname = ptr->d_name;
993 #ifdef NEXT2
994 if (telldir(p) < 0)
995 return(NULL);
996 #endif
998 #ifdef HAVE_BROKEN_READDIR_NAME
999 /* using /usr/ucb/cc is BAD */
1000 dname = dname - 2;
1001 #endif
1003 return talloc_strdup(talloc_tos(), dname);
1006 /*******************************************************************
1007 Utility function used to decide if the last component
1008 of a path matches a (possibly wildcarded) entry in a namelist.
1009 ********************************************************************/
1011 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive)
1013 const char *last_component;
1015 /* if we have no list it's obviously not in the path */
1016 if((namelist == NULL ) || ((namelist != NULL) && (namelist[0].name == NULL))) {
1017 return False;
1020 DEBUG(8, ("is_in_path: %s\n", name));
1022 /* Get the last component of the unix name. */
1023 last_component = strrchr_m(name, '/');
1024 if (!last_component) {
1025 last_component = name;
1026 } else {
1027 last_component++; /* Go past '/' */
1030 for(; namelist->name != NULL; namelist++) {
1031 if(namelist->is_wild) {
1032 if (mask_match(last_component, namelist->name, case_sensitive)) {
1033 DEBUG(8,("is_in_path: mask match succeeded\n"));
1034 return True;
1036 } else {
1037 if((case_sensitive && (strcmp(last_component, namelist->name) == 0))||
1038 (!case_sensitive && (strcasecmp_m(last_component, namelist->name) == 0))) {
1039 DEBUG(8,("is_in_path: match succeeded\n"));
1040 return True;
1044 DEBUG(8,("is_in_path: match not found\n"));
1045 return False;
1048 /*******************************************************************
1049 Strip a '/' separated list into an array of
1050 name_compare_enties structures suitable for
1051 passing to is_in_path(). We do this for
1052 speed so we can pre-parse all the names in the list
1053 and don't do it for each call to is_in_path().
1054 We also check if the entry contains a wildcard to
1055 remove a potentially expensive call to mask_match
1056 if possible.
1057 ********************************************************************/
1059 void set_namearray(name_compare_entry **ppname_array, const char *namelist_in)
1061 char *name_end;
1062 char *namelist;
1063 char *nameptr;
1064 int num_entries = 0;
1065 int i;
1067 (*ppname_array) = NULL;
1069 if((namelist_in == NULL ) || ((namelist_in != NULL) && (*namelist_in == '\0')))
1070 return;
1072 namelist = talloc_strdup(talloc_tos(), namelist_in);
1073 if (namelist == NULL) {
1074 DEBUG(0,("set_namearray: talloc fail\n"));
1075 return;
1077 nameptr = namelist;
1079 /* We need to make two passes over the string. The
1080 first to count the number of elements, the second
1081 to split it.
1084 while(*nameptr) {
1085 if ( *nameptr == '/' ) {
1086 /* cope with multiple (useless) /s) */
1087 nameptr++;
1088 continue;
1090 /* anything left? */
1091 if ( *nameptr == '\0' )
1092 break;
1094 /* find the next '/' or consume remaining */
1095 name_end = strchr_m(nameptr, '/');
1096 if (name_end == NULL)
1097 name_end = (char *)nameptr + strlen(nameptr);
1099 /* next segment please */
1100 nameptr = name_end + 1;
1101 num_entries++;
1104 if(num_entries == 0) {
1105 talloc_free(namelist);
1106 return;
1109 if(( (*ppname_array) = SMB_MALLOC_ARRAY(name_compare_entry, num_entries + 1)) == NULL) {
1110 DEBUG(0,("set_namearray: malloc fail\n"));
1111 talloc_free(namelist);
1112 return;
1115 /* Now copy out the names */
1116 nameptr = namelist;
1117 i = 0;
1118 while(*nameptr) {
1119 if ( *nameptr == '/' ) {
1120 /* cope with multiple (useless) /s) */
1121 nameptr++;
1122 continue;
1124 /* anything left? */
1125 if ( *nameptr == '\0' )
1126 break;
1128 /* find the next '/' or consume remaining */
1129 name_end = strchr_m(nameptr, '/');
1130 if (name_end)
1131 *name_end = '\0';
1132 else
1133 name_end = nameptr + strlen(nameptr);
1135 (*ppname_array)[i].is_wild = ms_has_wild(nameptr);
1136 if(((*ppname_array)[i].name = SMB_STRDUP(nameptr)) == NULL) {
1137 DEBUG(0,("set_namearray: malloc fail (1)\n"));
1138 talloc_free(namelist);
1139 return;
1142 /* next segment please */
1143 nameptr = name_end + 1;
1144 i++;
1147 (*ppname_array)[i].name = NULL;
1149 talloc_free(namelist);
1150 return;
1153 #undef DBGC_CLASS
1154 #define DBGC_CLASS DBGC_LOCKING
1156 /****************************************************************************
1157 Simple routine to query existing file locks. Cruft in NFS and 64->32 bit mapping
1158 is dealt with in posix.c
1159 Returns True if we have information regarding this lock region (and returns
1160 F_UNLCK in *ptype if the region is unlocked). False if the call failed.
1161 ****************************************************************************/
1163 bool fcntl_getlock(int fd, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid)
1165 struct flock lock;
1166 int ret;
1168 DEBUG(8,("fcntl_getlock fd=%d offset=%.0f count=%.0f type=%d\n",
1169 fd,(double)*poffset,(double)*pcount,*ptype));
1171 lock.l_type = *ptype;
1172 lock.l_whence = SEEK_SET;
1173 lock.l_start = *poffset;
1174 lock.l_len = *pcount;
1175 lock.l_pid = 0;
1177 ret = sys_fcntl_ptr(fd,F_GETLK,&lock);
1179 if (ret == -1) {
1180 int sav = errno;
1181 DEBUG(3,("fcntl_getlock: lock request failed at offset %.0f count %.0f type %d (%s)\n",
1182 (double)*poffset,(double)*pcount,*ptype,strerror(errno)));
1183 errno = sav;
1184 return False;
1187 *ptype = lock.l_type;
1188 *poffset = lock.l_start;
1189 *pcount = lock.l_len;
1190 *ppid = lock.l_pid;
1192 DEBUG(3,("fcntl_getlock: fd %d is returned info %d pid %u\n",
1193 fd, (int)lock.l_type, (unsigned int)lock.l_pid));
1194 return True;
1197 #undef DBGC_CLASS
1198 #define DBGC_CLASS DBGC_ALL
1200 /*******************************************************************
1201 Is the name specified one of my netbios names.
1202 Returns true if it is equal, false otherwise.
1203 ********************************************************************/
1205 bool is_myname(const char *s)
1207 int n;
1208 bool ret = False;
1210 for (n=0; my_netbios_names(n); n++) {
1211 if (strequal(my_netbios_names(n), s)) {
1212 ret=True;
1213 break;
1216 DEBUG(8, ("is_myname(\"%s\") returns %d\n", s, ret));
1217 return(ret);
1220 /*******************************************************************
1221 we distinguish between 2K and XP by the "Native Lan Manager" string
1222 WinXP => "Windows 2002 5.1"
1223 WinXP 64bit => "Windows XP 5.2"
1224 Win2k => "Windows 2000 5.0"
1225 NT4 => "Windows NT 4.0"
1226 Win9x => "Windows 4.0"
1227 Windows 2003 doesn't set the native lan manager string but
1228 they do set the domain to "Windows 2003 5.2" (probably a bug).
1229 ********************************************************************/
1231 void ra_lanman_string( const char *native_lanman )
1233 if ( strcmp( native_lanman, "Windows 2002 5.1" ) == 0 )
1234 set_remote_arch( RA_WINXP );
1235 else if ( strcmp( native_lanman, "Windows XP 5.2" ) == 0 )
1236 set_remote_arch( RA_WINXP64 );
1237 else if ( strcmp( native_lanman, "Windows Server 2003 5.2" ) == 0 )
1238 set_remote_arch( RA_WIN2K3 );
1241 static const char *remote_arch_str;
1243 const char *get_remote_arch_str(void)
1245 if (!remote_arch_str) {
1246 return "UNKNOWN";
1248 return remote_arch_str;
1251 /*******************************************************************
1252 Set the horrid remote_arch string based on an enum.
1253 ********************************************************************/
1255 void set_remote_arch(enum remote_arch_types type)
1257 ra_type = type;
1258 switch( type ) {
1259 case RA_WFWG:
1260 remote_arch_str = "WfWg";
1261 break;
1262 case RA_OS2:
1263 remote_arch_str = "OS2";
1264 break;
1265 case RA_WIN95:
1266 remote_arch_str = "Win95";
1267 break;
1268 case RA_WINNT:
1269 remote_arch_str = "WinNT";
1270 break;
1271 case RA_WIN2K:
1272 remote_arch_str = "Win2K";
1273 break;
1274 case RA_WINXP:
1275 remote_arch_str = "WinXP";
1276 break;
1277 case RA_WINXP64:
1278 remote_arch_str = "WinXP64";
1279 break;
1280 case RA_WIN2K3:
1281 remote_arch_str = "Win2K3";
1282 break;
1283 case RA_VISTA:
1284 remote_arch_str = "Vista";
1285 break;
1286 case RA_SAMBA:
1287 remote_arch_str = "Samba";
1288 break;
1289 case RA_CIFSFS:
1290 remote_arch_str = "CIFSFS";
1291 break;
1292 case RA_OSX:
1293 remote_arch_str = "OSX";
1294 break;
1295 default:
1296 ra_type = RA_UNKNOWN;
1297 remote_arch_str = "UNKNOWN";
1298 break;
1301 DEBUG(10,("set_remote_arch: Client arch is \'%s\'\n",
1302 remote_arch_str));
1305 /*******************************************************************
1306 Get the remote_arch type.
1307 ********************************************************************/
1309 enum remote_arch_types get_remote_arch(void)
1311 return ra_type;
1314 const char *tab_depth(int level, int depth)
1316 if( CHECK_DEBUGLVL(level) ) {
1317 dbgtext("%*s", depth*4, "");
1319 return "";
1322 /*****************************************************************************
1323 Provide a checksum on a string
1325 Input: s - the null-terminated character string for which the checksum
1326 will be calculated.
1328 Output: The checksum value calculated for s.
1329 *****************************************************************************/
1331 int str_checksum(const char *s)
1333 if (s == NULL)
1334 return 0;
1335 return hash(s, strlen(s), 0);
1338 /*****************************************************************
1339 Zero a memory area then free it. Used to catch bugs faster.
1340 *****************************************************************/
1342 void zero_free(void *p, size_t size)
1344 memset(p, 0, size);
1345 SAFE_FREE(p);
1348 /*****************************************************************
1349 Set our open file limit to a requested max and return the limit.
1350 *****************************************************************/
1352 int set_maxfiles(int requested_max)
1354 #if (defined(HAVE_GETRLIMIT) && defined(RLIMIT_NOFILE))
1355 struct rlimit rlp;
1356 int saved_current_limit;
1358 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
1359 DEBUG(0,("set_maxfiles: getrlimit (1) for RLIMIT_NOFILE failed with error %s\n",
1360 strerror(errno) ));
1361 /* just guess... */
1362 return requested_max;
1366 * Set the fd limit to be real_max_open_files + MAX_OPEN_FUDGEFACTOR to
1367 * account for the extra fd we need
1368 * as well as the log files and standard
1369 * handles etc. Save the limit we want to set in case
1370 * we are running on an OS that doesn't support this limit (AIX)
1371 * which always returns RLIM_INFINITY for rlp.rlim_max.
1374 /* Try raising the hard (max) limit to the requested amount. */
1376 #if defined(RLIM_INFINITY)
1377 if (rlp.rlim_max != RLIM_INFINITY) {
1378 int orig_max = rlp.rlim_max;
1380 if ( rlp.rlim_max < requested_max )
1381 rlp.rlim_max = requested_max;
1383 /* This failing is not an error - many systems (Linux) don't
1384 support our default request of 10,000 open files. JRA. */
1386 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
1387 DEBUG(3,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d max files failed with error %s\n",
1388 (int)rlp.rlim_max, strerror(errno) ));
1390 /* Set failed - restore original value from get. */
1391 rlp.rlim_max = orig_max;
1394 #endif
1396 /* Now try setting the soft (current) limit. */
1398 saved_current_limit = rlp.rlim_cur = MIN(requested_max,rlp.rlim_max);
1400 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
1401 DEBUG(0,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d files failed with error %s\n",
1402 (int)rlp.rlim_cur, strerror(errno) ));
1403 /* just guess... */
1404 return saved_current_limit;
1407 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
1408 DEBUG(0,("set_maxfiles: getrlimit (2) for RLIMIT_NOFILE failed with error %s\n",
1409 strerror(errno) ));
1410 /* just guess... */
1411 return saved_current_limit;
1414 #if defined(RLIM_INFINITY)
1415 if(rlp.rlim_cur == RLIM_INFINITY)
1416 return saved_current_limit;
1417 #endif
1419 if((int)rlp.rlim_cur > saved_current_limit)
1420 return saved_current_limit;
1422 return rlp.rlim_cur;
1423 #else /* !defined(HAVE_GETRLIMIT) || !defined(RLIMIT_NOFILE) */
1425 * No way to know - just guess...
1427 return requested_max;
1428 #endif
1431 /*****************************************************************
1432 malloc that aborts with smb_panic on fail or zero size.
1433 *****************************************************************/
1435 void *smb_xmalloc_array(size_t size, unsigned int count)
1437 void *p;
1438 if (size == 0) {
1439 smb_panic("smb_xmalloc_array: called with zero size");
1441 if (count >= MAX_ALLOC_SIZE/size) {
1442 smb_panic("smb_xmalloc_array: alloc size too large");
1444 if ((p = SMB_MALLOC(size*count)) == NULL) {
1445 DEBUG(0, ("smb_xmalloc_array failed to allocate %lu * %lu bytes\n",
1446 (unsigned long)size, (unsigned long)count));
1447 smb_panic("smb_xmalloc_array: malloc failed");
1449 return p;
1453 vasprintf that aborts on malloc fail
1456 int smb_xvasprintf(char **ptr, const char *format, va_list ap)
1458 int n;
1459 va_list ap2;
1461 va_copy(ap2, ap);
1463 n = vasprintf(ptr, format, ap2);
1464 va_end(ap2);
1465 if (n == -1 || ! *ptr) {
1466 smb_panic("smb_xvasprintf: out of memory");
1468 return n;
1471 /*****************************************************************
1472 Get local hostname and cache result.
1473 *****************************************************************/
1475 char *myhostname(void)
1477 static char *ret;
1478 if (ret == NULL) {
1479 ret = get_myname(NULL);
1481 return ret;
1484 /*****************************************************************
1485 Get local hostname and cache result.
1486 *****************************************************************/
1488 char *myhostname_upper(void)
1490 char *name;
1491 static char *ret;
1492 if (ret == NULL) {
1493 name = get_myname(talloc_tos());
1494 ret = strupper_talloc(NULL, name);
1495 talloc_free(name);
1497 return ret;
1501 * @brief Returns an absolute path to a file concatenating the provided
1502 * @a rootpath and @a basename
1504 * @param name Filename, relative to @a rootpath
1506 * @retval Pointer to a string containing the full path.
1509 static char *xx_path(const char *name, const char *rootpath)
1511 char *fname = NULL;
1513 fname = talloc_strdup(talloc_tos(), rootpath);
1514 if (!fname) {
1515 return NULL;
1517 trim_string(fname,"","/");
1519 if (!directory_exist(fname)) {
1520 if (!mkdir(fname,0755))
1521 DEBUG(1, ("Unable to create directory %s for file %s. "
1522 "Error was %s\n", fname, name, strerror(errno)));
1525 return talloc_asprintf(talloc_tos(),
1526 "%s/%s",
1527 fname,
1528 name);
1532 * @brief Returns an absolute path to a file in the Samba lock directory.
1534 * @param name File to find, relative to LOCKDIR.
1536 * @retval Pointer to a talloc'ed string containing the full path.
1539 char *lock_path(const char *name)
1541 return xx_path(name, lp_lockdir());
1545 * @brief Returns an absolute path to a file in the Samba state directory.
1547 * @param name File to find, relative to STATEDIR.
1549 * @retval Pointer to a talloc'ed string containing the full path.
1552 char *state_path(const char *name)
1554 return xx_path(name, lp_statedir());
1558 * @brief Returns an absolute path to a file in the Samba cache directory.
1560 * @param name File to find, relative to CACHEDIR.
1562 * @retval Pointer to a talloc'ed string containing the full path.
1565 char *cache_path(const char *name)
1567 return xx_path(name, lp_cachedir());
1570 /*******************************************************************
1571 Given a filename - get its directory name
1572 ********************************************************************/
1574 bool parent_dirname(TALLOC_CTX *mem_ctx, const char *dir, char **parent,
1575 const char **name)
1577 char *p;
1578 ptrdiff_t len;
1580 p = strrchr_m(dir, '/'); /* Find final '/', if any */
1582 if (p == NULL) {
1583 if (!(*parent = talloc_strdup(mem_ctx, "."))) {
1584 return False;
1586 if (name) {
1587 *name = dir;
1589 return True;
1592 len = p-dir;
1594 if (!(*parent = (char *)talloc_memdup(mem_ctx, dir, len+1))) {
1595 return False;
1597 (*parent)[len] = '\0';
1599 if (name) {
1600 *name = p+1;
1602 return True;
1605 /*******************************************************************
1606 Determine if a pattern contains any Microsoft wildcard characters.
1607 *******************************************************************/
1609 bool ms_has_wild(const char *s)
1611 char c;
1613 if (lp_posix_pathnames()) {
1614 /* With posix pathnames no characters are wild. */
1615 return False;
1618 while ((c = *s++)) {
1619 switch (c) {
1620 case '*':
1621 case '?':
1622 case '<':
1623 case '>':
1624 case '"':
1625 return True;
1628 return False;
1631 bool ms_has_wild_w(const smb_ucs2_t *s)
1633 smb_ucs2_t c;
1634 if (!s) return False;
1635 while ((c = *s++)) {
1636 switch (c) {
1637 case UCS2_CHAR('*'):
1638 case UCS2_CHAR('?'):
1639 case UCS2_CHAR('<'):
1640 case UCS2_CHAR('>'):
1641 case UCS2_CHAR('"'):
1642 return True;
1645 return False;
1648 /*******************************************************************
1649 A wrapper that handles case sensitivity and the special handling
1650 of the ".." name.
1651 *******************************************************************/
1653 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive)
1655 if (ISDOTDOT(string))
1656 string = ".";
1657 if (ISDOT(pattern))
1658 return False;
1660 return ms_fnmatch(pattern, string, Protocol <= PROTOCOL_LANMAN2, is_case_sensitive) == 0;
1663 /*******************************************************************
1664 A wrapper that handles case sensitivity and the special handling
1665 of the ".." name. Varient that is only called by old search code which requires
1666 pattern translation.
1667 *******************************************************************/
1669 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive)
1671 if (ISDOTDOT(string))
1672 string = ".";
1673 if (ISDOT(pattern))
1674 return False;
1676 return ms_fnmatch(pattern, string, True, is_case_sensitive) == 0;
1679 /*******************************************************************
1680 A wrapper that handles a list of patters and calls mask_match()
1681 on each. Returns True if any of the patterns match.
1682 *******************************************************************/
1684 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive)
1686 while (listLen-- > 0) {
1687 if (mask_match(string, *list++, is_case_sensitive))
1688 return True;
1690 return False;
1693 /*********************************************************
1694 Recursive routine that is called by unix_wild_match.
1695 *********************************************************/
1697 static bool unix_do_match(const char *regexp, const char *str)
1699 const char *p;
1701 for( p = regexp; *p && *str; ) {
1703 switch(*p) {
1704 case '?':
1705 str++;
1706 p++;
1707 break;
1709 case '*':
1712 * Look for a character matching
1713 * the one after the '*'.
1715 p++;
1716 if(!*p)
1717 return true; /* Automatic match */
1718 while(*str) {
1720 while(*str && (*p != *str))
1721 str++;
1724 * Patch from weidel@multichart.de. In the case of the regexp
1725 * '*XX*' we want to ensure there are at least 2 'X' characters
1726 * in the string after the '*' for a match to be made.
1730 int matchcount=0;
1733 * Eat all the characters that match, but count how many there were.
1736 while(*str && (*p == *str)) {
1737 str++;
1738 matchcount++;
1742 * Now check that if the regexp had n identical characters that
1743 * matchcount had at least that many matches.
1746 while ( *(p+1) && (*(p+1) == *p)) {
1747 p++;
1748 matchcount--;
1751 if ( matchcount <= 0 )
1752 return false;
1755 str--; /* We've eaten the match char after the '*' */
1757 if(unix_do_match(p, str))
1758 return true;
1760 if(!*str)
1761 return false;
1762 else
1763 str++;
1765 return false;
1767 default:
1768 if(*str != *p)
1769 return false;
1770 str++;
1771 p++;
1772 break;
1776 if(!*p && !*str)
1777 return true;
1779 if (!*p && str[0] == '.' && str[1] == 0)
1780 return true;
1782 if (!*str && *p == '?') {
1783 while (*p == '?')
1784 p++;
1785 return(!*p);
1788 if(!*str && (*p == '*' && p[1] == '\0'))
1789 return true;
1791 return false;
1794 /*******************************************************************
1795 Simple case insensitive interface to a UNIX wildcard matcher.
1796 Returns True if match, False if not.
1797 *******************************************************************/
1799 bool unix_wild_match(const char *pattern, const char *string)
1801 TALLOC_CTX *ctx = talloc_stackframe();
1802 char *p2;
1803 char *s2;
1804 char *p;
1805 bool ret = false;
1807 p2 = talloc_strdup(ctx,pattern);
1808 s2 = talloc_strdup(ctx,string);
1809 if (!p2 || !s2) {
1810 TALLOC_FREE(ctx);
1811 return false;
1813 if (!strlower_m(p2)) {
1814 TALLOC_FREE(ctx);
1815 return false;
1817 if (!strlower_m(s2)) {
1818 TALLOC_FREE(ctx);
1819 return false;
1822 /* Remove any *? and ** from the pattern as they are meaningless */
1823 for(p = p2; *p; p++) {
1824 while( *p == '*' && (p[1] == '?' ||p[1] == '*')) {
1825 memmove(&p[1], &p[2], strlen(&p[2])+1);
1829 if (strequal(p2,"*")) {
1830 TALLOC_FREE(ctx);
1831 return true;
1834 ret = unix_do_match(p2, s2);
1835 TALLOC_FREE(ctx);
1836 return ret;
1839 /**********************************************************************
1840 Converts a name to a fully qualified domain name.
1841 Returns true if lookup succeeded, false if not (then fqdn is set to name)
1842 Note we deliberately use gethostbyname here, not getaddrinfo as we want
1843 to examine the h_aliases and I don't know how to do that with getaddrinfo.
1844 ***********************************************************************/
1846 bool name_to_fqdn(fstring fqdn, const char *name)
1848 char *full = NULL;
1849 struct hostent *hp = gethostbyname(name);
1851 if (!hp || !hp->h_name || !*hp->h_name) {
1852 DEBUG(10,("name_to_fqdn: lookup for %s failed.\n", name));
1853 fstrcpy(fqdn, name);
1854 return false;
1857 /* Find out if the fqdn is returned as an alias
1858 * to cope with /etc/hosts files where the first
1859 * name is not the fqdn but the short name */
1860 if (hp->h_aliases && (! strchr_m(hp->h_name, '.'))) {
1861 int i;
1862 for (i = 0; hp->h_aliases[i]; i++) {
1863 if (strchr_m(hp->h_aliases[i], '.')) {
1864 full = hp->h_aliases[i];
1865 break;
1869 if (full && (strcasecmp_m(full, "localhost.localdomain") == 0)) {
1870 DEBUG(1, ("WARNING: your /etc/hosts file may be broken!\n"));
1871 DEBUGADD(1, (" Specifing the machine hostname for address 127.0.0.1 may lead\n"));
1872 DEBUGADD(1, (" to Kerberos authentication problems as localhost.localdomain\n"));
1873 DEBUGADD(1, (" may end up being used instead of the real machine FQDN.\n"));
1874 full = hp->h_name;
1876 if (!full) {
1877 full = hp->h_name;
1880 DEBUG(10,("name_to_fqdn: lookup for %s -> %s.\n", name, full));
1881 fstrcpy(fqdn, full);
1882 return true;
1885 /**********************************************************************
1886 Append a DATA_BLOB to a talloc'ed object
1887 ***********************************************************************/
1889 void *talloc_append_blob(TALLOC_CTX *mem_ctx, void *buf, DATA_BLOB blob)
1891 size_t old_size = 0;
1892 char *result;
1894 if (blob.length == 0) {
1895 return buf;
1898 if (buf != NULL) {
1899 old_size = talloc_get_size(buf);
1902 result = (char *)TALLOC_REALLOC(mem_ctx, buf, old_size + blob.length);
1903 if (result == NULL) {
1904 return NULL;
1907 memcpy(result + old_size, blob.data, blob.length);
1908 return result;
1911 uint32 map_share_mode_to_deny_mode(uint32 share_access, uint32 private_options)
1913 switch (share_access & ~FILE_SHARE_DELETE) {
1914 case FILE_SHARE_NONE:
1915 return DENY_ALL;
1916 case FILE_SHARE_READ:
1917 return DENY_WRITE;
1918 case FILE_SHARE_WRITE:
1919 return DENY_READ;
1920 case FILE_SHARE_READ|FILE_SHARE_WRITE:
1921 return DENY_NONE;
1923 if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_DOS) {
1924 return DENY_DOS;
1925 } else if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_FCB) {
1926 return DENY_FCB;
1929 return (uint32)-1;
1932 pid_t procid_to_pid(const struct server_id *proc)
1934 return proc->pid;
1937 static uint32 my_vnn = NONCLUSTER_VNN;
1939 void set_my_vnn(uint32 vnn)
1941 DEBUG(10, ("vnn pid %d = %u\n", (int)getpid(), (unsigned int)vnn));
1942 my_vnn = vnn;
1945 uint32 get_my_vnn(void)
1947 return my_vnn;
1950 static uint64_t my_unique_id = 0;
1952 void set_my_unique_id(uint64_t unique_id)
1954 my_unique_id = unique_id;
1957 struct server_id pid_to_procid(pid_t pid)
1959 struct server_id result;
1960 result.pid = pid;
1961 result.task_id = 0;
1962 result.unique_id = my_unique_id;
1963 result.vnn = my_vnn;
1964 return result;
1967 struct server_id procid_self(void)
1969 return pid_to_procid(getpid());
1972 static struct idr_context *task_id_tree;
1974 static int free_task_id(struct server_id *server_id)
1976 idr_remove(task_id_tree, server_id->task_id);
1977 return 0;
1980 /* Return a server_id with a unique task_id element. Free the
1981 * returned pointer to de-allocate the task_id via a talloc destructor
1982 * (ie, use talloc_free()) */
1983 struct server_id *new_server_id_task(TALLOC_CTX *mem_ctx)
1985 struct server_id *server_id;
1986 int task_id;
1987 if (!task_id_tree) {
1988 task_id_tree = idr_init(NULL);
1989 if (!task_id_tree) {
1990 return NULL;
1994 server_id = talloc(mem_ctx, struct server_id);
1996 if (!server_id) {
1997 return NULL;
1999 *server_id = procid_self();
2001 /* 0 is the default server_id, so we need to start with 1 */
2002 task_id = idr_get_new_above(task_id_tree, server_id, 1, INT32_MAX);
2004 if (task_id == -1) {
2005 talloc_free(server_id);
2006 return NULL;
2009 talloc_set_destructor(server_id, free_task_id);
2010 server_id->task_id = task_id;
2011 return server_id;
2014 bool procid_is_me(const struct server_id *pid)
2016 if (pid->pid != getpid())
2017 return False;
2018 if (pid->task_id != 0)
2019 return False;
2020 if (pid->vnn != my_vnn)
2021 return False;
2022 return True;
2025 struct server_id interpret_pid(const char *pid_string)
2027 return server_id_from_string(get_my_vnn(), pid_string);
2030 char *procid_str_static(const struct server_id *pid)
2032 return server_id_str(talloc_tos(), pid);
2035 bool procid_valid(const struct server_id *pid)
2037 return (pid->pid != (uint64_t)-1);
2040 bool procid_is_local(const struct server_id *pid)
2042 return pid->vnn == my_vnn;
2045 /****************************************************************
2046 Check if an offset into a buffer is safe.
2047 If this returns True it's safe to indirect into the byte at
2048 pointer ptr+off.
2049 ****************************************************************/
2051 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off)
2053 const char *end_base = buf_base + buf_len;
2054 char *end_ptr = ptr + off;
2056 if (!buf_base || !ptr) {
2057 return False;
2060 if (end_base < buf_base || end_ptr < ptr) {
2061 return False; /* wrap. */
2064 if (end_ptr < end_base) {
2065 return True;
2067 return False;
2070 /****************************************************************
2071 Return a safe pointer into a buffer, or NULL.
2072 ****************************************************************/
2074 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
2076 return is_offset_safe(buf_base, buf_len, ptr, off) ?
2077 ptr + off : NULL;
2080 /****************************************************************
2081 Return a safe pointer into a string within a buffer, or NULL.
2082 ****************************************************************/
2084 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
2086 if (!is_offset_safe(buf_base, buf_len, ptr, off)) {
2087 return NULL;
2089 /* Check if a valid string exists at this offset. */
2090 if (skip_string(buf_base,buf_len, ptr + off) == NULL) {
2091 return NULL;
2093 return ptr + off;
2096 /****************************************************************
2097 Return an SVAL at a pointer, or failval if beyond the end.
2098 ****************************************************************/
2100 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
2103 * Note we use off+1 here, not off+2 as SVAL accesses ptr[0] and ptr[1],
2104 * NOT ptr[2].
2106 if (!is_offset_safe(buf_base, buf_len, ptr, off+1)) {
2107 return failval;
2109 return SVAL(ptr,off);
2112 /****************************************************************
2113 Return an IVAL at a pointer, or failval if beyond the end.
2114 ****************************************************************/
2116 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
2119 * Note we use off+3 here, not off+4 as IVAL accesses
2120 * ptr[0] ptr[1] ptr[2] ptr[3] NOT ptr[4].
2122 if (!is_offset_safe(buf_base, buf_len, ptr, off+3)) {
2123 return failval;
2125 return IVAL(ptr,off);
2128 /****************************************************************
2129 Split DOM\user into DOM and user. Do not mix with winbind variants of that
2130 call (they take care of winbind separator and other winbind specific settings).
2131 ****************************************************************/
2133 void split_domain_user(TALLOC_CTX *mem_ctx,
2134 const char *full_name,
2135 char **domain,
2136 char **user)
2138 const char *p = NULL;
2140 p = strchr_m(full_name, '\\');
2142 if (p != NULL) {
2143 *domain = talloc_strndup(mem_ctx, full_name,
2144 PTR_DIFF(p, full_name));
2145 *user = talloc_strdup(mem_ctx, p+1);
2146 } else {
2147 *domain = talloc_strdup(mem_ctx, "");
2148 *user = talloc_strdup(mem_ctx, full_name);
2152 /****************************************************************
2153 strip off leading '\\' from a hostname
2154 ****************************************************************/
2156 const char *strip_hostname(const char *s)
2158 if (!s) {
2159 return NULL;
2162 if (strlen_m(s) < 3) {
2163 return s;
2166 if (s[0] == '\\') s++;
2167 if (s[0] == '\\') s++;
2169 return s;
2172 bool any_nt_status_not_ok(NTSTATUS err1, NTSTATUS err2, NTSTATUS *result)
2174 if (!NT_STATUS_IS_OK(err1)) {
2175 *result = err1;
2176 return true;
2178 if (!NT_STATUS_IS_OK(err2)) {
2179 *result = err2;
2180 return true;
2182 return false;
2185 int timeval_to_msec(struct timeval t)
2187 return t.tv_sec * 1000 + (t.tv_usec+999) / 1000;
2190 /*******************************************************************
2191 Check a given DOS pathname is valid for a share.
2192 ********************************************************************/
2194 char *valid_share_pathname(TALLOC_CTX *ctx, const char *dos_pathname)
2196 char *ptr = NULL;
2198 if (!dos_pathname) {
2199 return NULL;
2202 ptr = talloc_strdup(ctx, dos_pathname);
2203 if (!ptr) {
2204 return NULL;
2206 /* Convert any '\' paths to '/' */
2207 unix_format(ptr);
2208 ptr = unix_clean_name(ctx, ptr);
2209 if (!ptr) {
2210 return NULL;
2213 /* NT is braindead - it wants a C: prefix to a pathname ! So strip it. */
2214 if (strlen(ptr) > 2 && ptr[1] == ':' && ptr[0] != '/')
2215 ptr += 2;
2217 /* Only absolute paths allowed. */
2218 if (*ptr != '/')
2219 return NULL;
2221 return ptr;
2224 /*******************************************************************
2225 Return True if the filename is one of the special executable types.
2226 ********************************************************************/
2228 bool is_executable(const char *fname)
2230 if ((fname = strrchr_m(fname,'.'))) {
2231 if (strequal(fname,".com") ||
2232 strequal(fname,".dll") ||
2233 strequal(fname,".exe") ||
2234 strequal(fname,".sym")) {
2235 return True;
2238 return False;
2241 /****************************************************************************
2242 Open a file with a share mode - old openX method - map into NTCreate.
2243 ****************************************************************************/
2245 bool map_open_params_to_ntcreate(const char *smb_base_fname,
2246 int deny_mode, int open_func,
2247 uint32 *paccess_mask,
2248 uint32 *pshare_mode,
2249 uint32 *pcreate_disposition,
2250 uint32 *pcreate_options,
2251 uint32_t *pprivate_flags)
2253 uint32 access_mask;
2254 uint32 share_mode;
2255 uint32 create_disposition;
2256 uint32 create_options = FILE_NON_DIRECTORY_FILE;
2257 uint32_t private_flags = 0;
2259 DEBUG(10,("map_open_params_to_ntcreate: fname = %s, deny_mode = 0x%x, "
2260 "open_func = 0x%x\n",
2261 smb_base_fname, (unsigned int)deny_mode,
2262 (unsigned int)open_func ));
2264 /* Create the NT compatible access_mask. */
2265 switch (GET_OPENX_MODE(deny_mode)) {
2266 case DOS_OPEN_EXEC: /* Implies read-only - used to be FILE_READ_DATA */
2267 case DOS_OPEN_RDONLY:
2268 access_mask = FILE_GENERIC_READ;
2269 break;
2270 case DOS_OPEN_WRONLY:
2271 access_mask = FILE_GENERIC_WRITE;
2272 break;
2273 case DOS_OPEN_RDWR:
2274 case DOS_OPEN_FCB:
2275 access_mask = FILE_GENERIC_READ|FILE_GENERIC_WRITE;
2276 break;
2277 default:
2278 DEBUG(10,("map_open_params_to_ntcreate: bad open mode = 0x%x\n",
2279 (unsigned int)GET_OPENX_MODE(deny_mode)));
2280 return False;
2283 /* Create the NT compatible create_disposition. */
2284 switch (open_func) {
2285 case OPENX_FILE_EXISTS_FAIL|OPENX_FILE_CREATE_IF_NOT_EXIST:
2286 create_disposition = FILE_CREATE;
2287 break;
2289 case OPENX_FILE_EXISTS_OPEN:
2290 create_disposition = FILE_OPEN;
2291 break;
2293 case OPENX_FILE_EXISTS_OPEN|OPENX_FILE_CREATE_IF_NOT_EXIST:
2294 create_disposition = FILE_OPEN_IF;
2295 break;
2297 case OPENX_FILE_EXISTS_TRUNCATE:
2298 create_disposition = FILE_OVERWRITE;
2299 break;
2301 case OPENX_FILE_EXISTS_TRUNCATE|OPENX_FILE_CREATE_IF_NOT_EXIST:
2302 create_disposition = FILE_OVERWRITE_IF;
2303 break;
2305 default:
2306 /* From samba4 - to be confirmed. */
2307 if (GET_OPENX_MODE(deny_mode) == DOS_OPEN_EXEC) {
2308 create_disposition = FILE_CREATE;
2309 break;
2311 DEBUG(10,("map_open_params_to_ntcreate: bad "
2312 "open_func 0x%x\n", (unsigned int)open_func));
2313 return False;
2316 /* Create the NT compatible share modes. */
2317 switch (GET_DENY_MODE(deny_mode)) {
2318 case DENY_ALL:
2319 share_mode = FILE_SHARE_NONE;
2320 break;
2322 case DENY_WRITE:
2323 share_mode = FILE_SHARE_READ;
2324 break;
2326 case DENY_READ:
2327 share_mode = FILE_SHARE_WRITE;
2328 break;
2330 case DENY_NONE:
2331 share_mode = FILE_SHARE_READ|FILE_SHARE_WRITE;
2332 break;
2334 case DENY_DOS:
2335 private_flags |= NTCREATEX_OPTIONS_PRIVATE_DENY_DOS;
2336 if (is_executable(smb_base_fname)) {
2337 share_mode = FILE_SHARE_READ|FILE_SHARE_WRITE;
2338 } else {
2339 if (GET_OPENX_MODE(deny_mode) == DOS_OPEN_RDONLY) {
2340 share_mode = FILE_SHARE_READ;
2341 } else {
2342 share_mode = FILE_SHARE_NONE;
2345 break;
2347 case DENY_FCB:
2348 private_flags |= NTCREATEX_OPTIONS_PRIVATE_DENY_FCB;
2349 share_mode = FILE_SHARE_NONE;
2350 break;
2352 default:
2353 DEBUG(10,("map_open_params_to_ntcreate: bad deny_mode 0x%x\n",
2354 (unsigned int)GET_DENY_MODE(deny_mode) ));
2355 return False;
2358 DEBUG(10,("map_open_params_to_ntcreate: file %s, access_mask = 0x%x, "
2359 "share_mode = 0x%x, create_disposition = 0x%x, "
2360 "create_options = 0x%x private_flags = 0x%x\n",
2361 smb_base_fname,
2362 (unsigned int)access_mask,
2363 (unsigned int)share_mode,
2364 (unsigned int)create_disposition,
2365 (unsigned int)create_options,
2366 (unsigned int)private_flags));
2368 if (paccess_mask) {
2369 *paccess_mask = access_mask;
2371 if (pshare_mode) {
2372 *pshare_mode = share_mode;
2374 if (pcreate_disposition) {
2375 *pcreate_disposition = create_disposition;
2377 if (pcreate_options) {
2378 *pcreate_options = create_options;
2380 if (pprivate_flags) {
2381 *pprivate_flags = private_flags;
2384 return True;
2388 /*************************************************************************
2389 Return a talloced copy of a struct security_unix_token. NULL on fail.
2390 *************************************************************************/
2392 struct security_unix_token *copy_unix_token(TALLOC_CTX *ctx, const struct security_unix_token *tok)
2394 struct security_unix_token *cpy;
2396 cpy = talloc(ctx, struct security_unix_token);
2397 if (!cpy) {
2398 return NULL;
2401 cpy->uid = tok->uid;
2402 cpy->gid = tok->gid;
2403 cpy->ngroups = tok->ngroups;
2404 if (tok->ngroups) {
2405 /* Make this a talloc child of cpy. */
2406 cpy->groups = (gid_t *)talloc_memdup(
2407 cpy, tok->groups, tok->ngroups * sizeof(gid_t));
2408 if (!cpy->groups) {
2409 TALLOC_FREE(cpy);
2410 return NULL;
2412 } else {
2413 cpy->groups = NULL;
2415 return cpy;