s3:vfs: Correctly check if OFD locks should be enabled or not
[Samba.git] / source3 / lib / util.c
blob7530ea6797301e474e54b496b79dc66640f1b8c6
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 "lib/util/server_id.h"
28 #include "util_tdb.h"
29 #include "ctdbd_conn.h"
30 #include "../lib/util/util_pw.h"
31 #include "messages.h"
32 #include "messages_dgm.h"
33 #include "libcli/security/security.h"
34 #include "serverid.h"
35 #include "lib/util/sys_rw.h"
36 #include "lib/util/sys_rw_data.h"
37 #include "lib/util/util_process.h"
38 #include "lib/dbwrap/dbwrap_ctdb.h"
39 #include "lib/gencache.h"
41 #ifdef HAVE_SYS_PRCTL_H
42 #include <sys/prctl.h>
43 #endif
45 /* Max allowable allococation - 256mb - 0x10000000 */
46 #define MAX_ALLOC_SIZE (1024*1024*256)
48 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
49 /* rpc/xdr.h uses TRUE and FALSE */
50 #ifdef TRUE
51 #undef TRUE
52 #endif
54 #ifdef FALSE
55 #undef FALSE
56 #endif
58 #include "system/nis.h"
60 #ifdef WITH_NISPLUS_HOME
61 #ifdef BROKEN_NISPLUS_INCLUDE_FILES
63 * The following lines are needed due to buggy include files
64 * in Solaris 2.6 which define GROUP in both /usr/include/sys/acl.h and
65 * also in /usr/include/rpcsvc/nis.h. The definitions conflict. JRA.
66 * Also GROUP_OBJ is defined as 0x4 in /usr/include/sys/acl.h and as
67 * an enum in /usr/include/rpcsvc/nis.h.
70 #if defined(GROUP)
71 #undef GROUP
72 #endif
74 #if defined(GROUP_OBJ)
75 #undef GROUP_OBJ
76 #endif
78 #endif /* BROKEN_NISPLUS_INCLUDE_FILES */
80 #include <rpcsvc/nis.h>
82 #endif /* WITH_NISPLUS_HOME */
83 #endif /* HAVE_NETGROUP && WITH_AUTOMOUNT */
85 static enum protocol_types Protocol = PROTOCOL_COREPLUS;
87 enum protocol_types get_Protocol(void)
89 return Protocol;
92 void set_Protocol(enum protocol_types p)
94 Protocol = p;
97 static enum remote_arch_types ra_type = RA_UNKNOWN;
99 void gfree_all( void )
101 gfree_names();
102 gfree_loadparm();
103 gfree_charcnv();
104 gfree_interfaces();
105 gfree_debugsyms();
108 /*******************************************************************
109 Check if a file exists - call vfs_file_exist for samba files.
110 ********************************************************************/
112 bool file_exist_stat(const char *fname,SMB_STRUCT_STAT *sbuf,
113 bool fake_dir_create_times)
115 SMB_STRUCT_STAT st;
116 if (!sbuf)
117 sbuf = &st;
119 if (sys_stat(fname, sbuf, fake_dir_create_times) != 0)
120 return(False);
122 return((S_ISREG(sbuf->st_ex_mode)) || (S_ISFIFO(sbuf->st_ex_mode)));
125 /*******************************************************************
126 Check if a unix domain socket exists - call vfs_file_exist for samba files.
127 ********************************************************************/
129 bool socket_exist(const char *fname)
131 SMB_STRUCT_STAT st;
132 if (sys_stat(fname, &st, false) != 0)
133 return(False);
135 return S_ISSOCK(st.st_ex_mode);
138 /*******************************************************************
139 Returns the size in bytes of the named given the stat struct.
140 ********************************************************************/
142 uint64_t get_file_size_stat(const SMB_STRUCT_STAT *sbuf)
144 return sbuf->st_ex_size;
147 /****************************************************************************
148 Check two stats have identical dev and ino fields.
149 ****************************************************************************/
151 bool check_same_dev_ino(const SMB_STRUCT_STAT *sbuf1,
152 const SMB_STRUCT_STAT *sbuf2)
154 if (sbuf1->st_ex_dev != sbuf2->st_ex_dev ||
155 sbuf1->st_ex_ino != sbuf2->st_ex_ino) {
156 return false;
158 return true;
161 /****************************************************************************
162 Check if a stat struct is identical for use.
163 ****************************************************************************/
165 bool check_same_stat(const SMB_STRUCT_STAT *sbuf1,
166 const SMB_STRUCT_STAT *sbuf2)
168 if (sbuf1->st_ex_uid != sbuf2->st_ex_uid ||
169 sbuf1->st_ex_gid != sbuf2->st_ex_gid ||
170 !check_same_dev_ino(sbuf1, sbuf2)) {
171 return false;
173 return true;
176 /*******************************************************************
177 Show a smb message structure.
178 ********************************************************************/
180 void show_msg(const char *buf)
182 int i;
183 int bcc=0;
185 if (!DEBUGLVL(5))
186 return;
188 DEBUG(5,("size=%d\nsmb_com=0x%x\nsmb_rcls=%d\nsmb_reh=%d\nsmb_err=%d\nsmb_flg=%d\nsmb_flg2=%d\n",
189 smb_len(buf),
190 (int)CVAL(buf,smb_com),
191 (int)CVAL(buf,smb_rcls),
192 (int)CVAL(buf,smb_reh),
193 (int)SVAL(buf,smb_err),
194 (int)CVAL(buf,smb_flg),
195 (int)SVAL(buf,smb_flg2)));
196 DEBUGADD(5,("smb_tid=%d\nsmb_pid=%d\nsmb_uid=%d\nsmb_mid=%d\n",
197 (int)SVAL(buf,smb_tid),
198 (int)SVAL(buf,smb_pid),
199 (int)SVAL(buf,smb_uid),
200 (int)SVAL(buf,smb_mid)));
201 DEBUGADD(5,("smt_wct=%d\n",(int)CVAL(buf,smb_wct)));
203 for (i=0;i<(int)CVAL(buf,smb_wct);i++)
204 DEBUGADD(5,("smb_vwv[%2d]=%5d (0x%X)\n",i,
205 SVAL(buf,smb_vwv+2*i),SVAL(buf,smb_vwv+2*i)));
207 bcc = (int)SVAL(buf,smb_vwv+2*(CVAL(buf,smb_wct)));
209 DEBUGADD(5,("smb_bcc=%d\n",bcc));
211 if (DEBUGLEVEL < 10)
212 return;
214 if (DEBUGLEVEL < 50)
215 bcc = MIN(bcc, 512);
217 dump_data(10, (const uint8_t *)smb_buf_const(buf), bcc);
220 /*******************************************************************
221 Setup only the byte count for a smb message.
222 ********************************************************************/
224 int set_message_bcc(char *buf,int num_bytes)
226 int num_words = CVAL(buf,smb_wct);
227 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
228 _smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
229 return (smb_size + num_words*2 + num_bytes);
232 /*******************************************************************
233 Add a data blob to the end of a smb_buf, adjusting bcc and smb_len.
234 Return the bytes added
235 ********************************************************************/
237 ssize_t message_push_blob(uint8_t **outbuf, DATA_BLOB blob)
239 size_t newlen = smb_len(*outbuf) + 4 + blob.length;
240 uint8_t *tmp;
242 if (!(tmp = talloc_realloc(NULL, *outbuf, uint8_t, newlen))) {
243 DEBUG(0, ("talloc failed\n"));
244 return -1;
246 *outbuf = tmp;
248 memcpy(tmp + smb_len(tmp) + 4, blob.data, blob.length);
249 set_message_bcc((char *)tmp, smb_buflen(tmp) + blob.length);
250 return blob.length;
253 /*******************************************************************
254 Reduce a file name, removing .. elements.
255 ********************************************************************/
257 static char *dos_clean_name(TALLOC_CTX *ctx, const char *s)
259 char *p = NULL;
260 char *str = NULL;
262 DEBUG(3,("dos_clean_name [%s]\n",s));
264 /* remove any double slashes */
265 str = talloc_all_string_sub(ctx, s, "\\\\", "\\");
266 if (!str) {
267 return NULL;
270 /* Remove leading .\\ characters */
271 if(strncmp(str, ".\\", 2) == 0) {
272 trim_string(str, ".\\", NULL);
273 if(*str == 0) {
274 str = talloc_strdup(ctx, ".\\");
275 if (!str) {
276 return NULL;
281 while ((p = strstr_m(str,"\\..\\")) != NULL) {
282 char *s1;
284 *p = 0;
285 s1 = p+3;
287 if ((p=strrchr_m(str,'\\')) != NULL) {
288 *p = 0;
289 } else {
290 *str = 0;
292 str = talloc_asprintf(ctx,
293 "%s%s",
294 str,
295 s1);
296 if (!str) {
297 return NULL;
301 trim_string(str,NULL,"\\..");
302 return talloc_all_string_sub(ctx, str, "\\.\\", "\\");
305 /*******************************************************************
306 Reduce a file name, removing .. elements.
307 ********************************************************************/
309 char *unix_clean_name(TALLOC_CTX *ctx, const char *s)
311 char *p = NULL;
312 char *str = NULL;
314 DEBUG(3,("unix_clean_name [%s]\n",s));
316 /* remove any double slashes */
317 str = talloc_all_string_sub(ctx, s, "//","/");
318 if (!str) {
319 return NULL;
322 /* Remove leading ./ characters */
323 if(strncmp(str, "./", 2) == 0) {
324 trim_string(str, "./", NULL);
325 if(*str == 0) {
326 str = talloc_strdup(ctx, "./");
327 if (!str) {
328 return NULL;
333 while ((p = strstr_m(str,"/../")) != NULL) {
334 char *s1;
336 *p = 0;
337 s1 = p+3;
339 if ((p=strrchr_m(str,'/')) != NULL) {
340 *p = 0;
341 } else {
342 *str = 0;
344 str = talloc_asprintf(ctx,
345 "%s%s",
346 str,
347 s1);
348 if (!str) {
349 return NULL;
353 trim_string(str,NULL,"/..");
354 return talloc_all_string_sub(ctx, str, "/./", "/");
357 char *clean_name(TALLOC_CTX *ctx, const char *s)
359 char *str = dos_clean_name(ctx, s);
360 if (!str) {
361 return NULL;
363 return unix_clean_name(ctx, str);
366 /*******************************************************************
367 Write data into an fd at a given offset. Ignore seek errors.
368 ********************************************************************/
370 ssize_t write_data_at_offset(int fd, const char *buffer, size_t N, off_t pos)
372 size_t total=0;
373 ssize_t ret;
375 if (pos == (off_t)-1) {
376 return write_data(fd, buffer, N);
378 #if defined(HAVE_PWRITE) || defined(HAVE_PRWITE64)
379 while (total < N) {
380 ret = sys_pwrite(fd,buffer + total,N - total, pos);
381 if (ret == -1 && errno == ESPIPE) {
382 return write_data(fd, buffer + total,N - total);
384 if (ret == -1) {
385 DEBUG(0,("write_data_at_offset: write failure. Error = %s\n", strerror(errno) ));
386 return -1;
388 if (ret == 0) {
389 return total;
391 total += ret;
392 pos += ret;
394 return (ssize_t)total;
395 #else
396 /* Use lseek and write_data. */
397 if (lseek(fd, pos, SEEK_SET) == -1) {
398 if (errno != ESPIPE) {
399 return -1;
402 return write_data(fd, buffer, N);
403 #endif
406 static int reinit_after_fork_pipe[2] = { -1, -1 };
408 NTSTATUS init_before_fork(void)
410 int ret;
412 ret = pipe(reinit_after_fork_pipe);
413 if (ret == -1) {
414 NTSTATUS status;
416 status = map_nt_error_from_unix_common(errno);
418 DEBUG(0, ("Error creating child_pipe: %s\n",
419 nt_errstr(status)));
421 return status;
424 return NT_STATUS_OK;
428 * Detect died parent by detecting EOF on the pipe
430 static void reinit_after_fork_pipe_handler(struct tevent_context *ev,
431 struct tevent_fd *fde,
432 uint16_t flags,
433 void *private_data)
435 char c;
437 if (sys_read(reinit_after_fork_pipe[0], &c, 1) != 1) {
439 * we have reached EOF on stdin, which means the
440 * parent has exited. Shutdown the server
442 TALLOC_FREE(fde);
443 (void)kill(getpid(), SIGTERM);
448 NTSTATUS reinit_after_fork(struct messaging_context *msg_ctx,
449 struct tevent_context *ev_ctx,
450 bool parent_longlived,
451 const char *comment)
453 NTSTATUS status = NT_STATUS_OK;
454 int ret;
457 * The main process thread should never
458 * allow per_thread_cwd_enable() to be
459 * called.
461 per_thread_cwd_disable();
463 if (reinit_after_fork_pipe[1] != -1) {
464 close(reinit_after_fork_pipe[1]);
465 reinit_after_fork_pipe[1] = -1;
468 /* tdb needs special fork handling */
469 if (tdb_reopen_all(parent_longlived ? 1 : 0) != 0) {
470 DEBUG(0,("tdb_reopen_all failed.\n"));
471 status = NT_STATUS_OPEN_FAILED;
472 goto done;
475 if (ev_ctx != NULL) {
476 tevent_set_trace_callback(ev_ctx, NULL, NULL);
477 if (tevent_re_initialise(ev_ctx) != 0) {
478 smb_panic(__location__ ": Failed to re-initialise event context");
482 if (reinit_after_fork_pipe[0] != -1) {
483 struct tevent_fd *fde;
485 fde = tevent_add_fd(ev_ctx, ev_ctx /* TALLOC_CTX */,
486 reinit_after_fork_pipe[0], TEVENT_FD_READ,
487 reinit_after_fork_pipe_handler, NULL);
488 if (fde == NULL) {
489 smb_panic(__location__ ": Failed to add reinit_after_fork pipe event");
493 if (msg_ctx) {
495 * For clustering, we need to re-init our ctdbd connection after the
496 * fork
498 status = messaging_reinit(msg_ctx);
499 if (!NT_STATUS_IS_OK(status)) {
500 DEBUG(0,("messaging_reinit() failed: %s\n",
501 nt_errstr(status)));
504 if (lp_clustering()) {
505 ret = ctdb_async_ctx_reinit(
506 NULL, messaging_tevent_context(msg_ctx));
507 if (ret != 0) {
508 DBG_ERR("db_ctdb_async_ctx_reinit failed: %s\n",
509 strerror(errno));
510 return map_nt_error_from_unix(ret);
515 if (comment) {
516 prctl_set_comment(comment);
519 done:
520 return status;
523 /****************************************************************************
524 (Hopefully) efficient array append.
525 ****************************************************************************/
527 void add_to_large_array(TALLOC_CTX *mem_ctx, size_t element_size,
528 void *element, void *_array, uint32_t *num_elements,
529 ssize_t *array_size)
531 void **array = (void **)_array;
533 if (*array_size < 0) {
534 return;
537 if (*array == NULL) {
538 if (*array_size == 0) {
539 *array_size = 128;
542 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
543 goto error;
546 *array = TALLOC(mem_ctx, element_size * (*array_size));
547 if (*array == NULL) {
548 goto error;
552 if (*num_elements == *array_size) {
553 *array_size *= 2;
555 if (*array_size >= MAX_ALLOC_SIZE/element_size) {
556 goto error;
559 *array = TALLOC_REALLOC(mem_ctx, *array,
560 element_size * (*array_size));
562 if (*array == NULL) {
563 goto error;
567 memcpy((char *)(*array) + element_size*(*num_elements),
568 element, element_size);
569 *num_elements += 1;
571 return;
573 error:
574 *num_elements = 0;
575 *array_size = -1;
578 /****************************************************************************
579 Get my own domain name, or "" if we have none.
580 ****************************************************************************/
582 char *get_mydnsdomname(TALLOC_CTX *ctx)
584 const char *domname;
585 char *p;
587 domname = get_mydnsfullname();
588 if (!domname) {
589 return NULL;
592 p = strchr_m(domname, '.');
593 if (p) {
594 p++;
595 return talloc_strdup(ctx, p);
596 } else {
597 return talloc_strdup(ctx, "");
601 #if (defined(HAVE_NETGROUP) && defined(WITH_AUTOMOUNT))
602 /******************************************************************
603 Remove any mount options such as -rsize=2048,wsize=2048 etc.
604 Based on a fix from <Thomas.Hepper@icem.de>.
605 Returns a malloc'ed string.
606 *******************************************************************/
608 static char *strip_mount_options(TALLOC_CTX *ctx, const char *str)
610 if (*str == '-') {
611 const char *p = str;
612 while(*p && !isspace(*p))
613 p++;
614 while(*p && isspace(*p))
615 p++;
616 if(*p) {
617 return talloc_strdup(ctx, p);
620 return NULL;
623 /*******************************************************************
624 Patch from jkf@soton.ac.uk
625 Split Luke's automount_server into YP lookup and string splitter
626 so can easily implement automount_path().
627 Returns a malloc'ed string.
628 *******************************************************************/
630 #ifdef WITH_NISPLUS_HOME
631 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
633 char *value = NULL;
635 char *nis_map = (char *)lp_homedir_map();
637 char buffer[NIS_MAXATTRVAL + 1];
638 nis_result *result;
639 nis_object *object;
640 entry_obj *entry;
642 snprintf(buffer, sizeof(buffer), "[key=%s],%s", user_name, nis_map);
643 DEBUG(5, ("NIS+ querystring: %s\n", buffer));
645 if (result = nis_list(buffer, FOLLOW_PATH|EXPAND_NAME|HARD_LOOKUP, NULL, NULL)) {
646 if (result->status != NIS_SUCCESS) {
647 DEBUG(3, ("NIS+ query failed: %s\n", nis_sperrno(result->status)));
648 } else {
649 object = result->objects.objects_val;
650 if (object->zo_data.zo_type == ENTRY_OBJ) {
651 entry = &object->zo_data.objdata_u.en_data;
652 DEBUG(5, ("NIS+ entry type: %s\n", entry->en_type));
653 DEBUG(3, ("NIS+ result: %s\n", entry->en_cols.en_cols_val[1].ec_value.ec_value_val));
655 value = talloc_strdup(ctx,
656 entry->en_cols.en_cols_val[1].ec_value.ec_value_val);
657 if (!value) {
658 nis_freeresult(result);
659 return NULL;
661 value = talloc_string_sub(ctx,
662 value,
663 "&",
664 user_name);
668 nis_freeresult(result);
670 if (value) {
671 value = strip_mount_options(ctx, value);
672 DEBUG(4, ("NIS+ Lookup: %s resulted in %s\n",
673 user_name, value));
675 return value;
677 #else /* WITH_NISPLUS_HOME */
679 char *automount_lookup(TALLOC_CTX *ctx, const char *user_name)
681 char *value = NULL;
683 int nis_error; /* returned by yp all functions */
684 char *nis_result; /* yp_match inits this */
685 int nis_result_len; /* and set this */
686 char *nis_domain; /* yp_get_default_domain inits this */
687 char *nis_map = lp_homedir_map(talloc_tos());
689 if ((nis_error = yp_get_default_domain(&nis_domain)) != 0) {
690 DEBUG(3, ("YP Error: %s\n", yperr_string(nis_error)));
691 return NULL;
694 DEBUG(5, ("NIS Domain: %s\n", nis_domain));
696 if ((nis_error = yp_match(nis_domain, nis_map, user_name,
697 strlen(user_name), &nis_result,
698 &nis_result_len)) == 0) {
699 if (nis_result_len > 0 && nis_result[nis_result_len] == '\n') {
700 nis_result[nis_result_len] = '\0';
702 value = talloc_strdup(ctx, nis_result);
703 if (!value) {
704 return NULL;
706 value = strip_mount_options(ctx, value);
707 } else if(nis_error == YPERR_KEY) {
708 DEBUG(3, ("YP Key not found: while looking up \"%s\" in map \"%s\"\n",
709 user_name, nis_map));
710 DEBUG(3, ("using defaults for server and home directory\n"));
711 } else {
712 DEBUG(3, ("YP Error: \"%s\" while looking up \"%s\" in map \"%s\"\n",
713 yperr_string(nis_error), user_name, nis_map));
716 if (value) {
717 DEBUG(4, ("YP Lookup: %s resulted in %s\n", user_name, value));
719 return value;
721 #endif /* WITH_NISPLUS_HOME */
722 #endif
724 bool process_exists(const struct server_id pid)
726 return serverid_exists(&pid);
729 /*******************************************************************
730 Convert a uid into a user name.
731 ********************************************************************/
733 const char *uidtoname(uid_t uid)
735 TALLOC_CTX *ctx = talloc_tos();
736 char *name = NULL;
737 struct passwd *pass = NULL;
739 pass = getpwuid_alloc(ctx,uid);
740 if (pass) {
741 name = talloc_strdup(ctx,pass->pw_name);
742 TALLOC_FREE(pass);
743 } else {
744 name = talloc_asprintf(ctx,
745 "%ld",
746 (long int)uid);
748 return name;
751 /*******************************************************************
752 Convert a gid into a group name.
753 ********************************************************************/
755 char *gidtoname(gid_t gid)
757 struct group *grp;
759 grp = getgrgid(gid);
760 if (grp) {
761 return talloc_strdup(talloc_tos(), grp->gr_name);
763 else {
764 return talloc_asprintf(talloc_tos(),
765 "%d",
766 (int)gid);
770 /*******************************************************************
771 Convert a user name into a uid.
772 ********************************************************************/
774 uid_t nametouid(const char *name)
776 struct passwd *pass;
777 char *p;
778 uid_t u;
780 pass = Get_Pwnam_alloc(talloc_tos(), name);
781 if (pass) {
782 u = pass->pw_uid;
783 TALLOC_FREE(pass);
784 return u;
787 u = (uid_t)strtol(name, &p, 0);
788 if ((p != name) && (*p == '\0'))
789 return u;
791 return (uid_t)-1;
794 /*******************************************************************
795 Convert a name to a gid_t if possible. Return -1 if not a group.
796 ********************************************************************/
798 gid_t nametogid(const char *name)
800 struct group *grp;
801 char *p;
802 gid_t g;
804 g = (gid_t)strtol(name, &p, 0);
805 if ((p != name) && (*p == '\0'))
806 return g;
808 grp = getgrnam(name);
809 if (grp)
810 return(grp->gr_gid);
811 return (gid_t)-1;
814 /*******************************************************************
815 Something really nasty happened - panic !
816 ********************************************************************/
818 void smb_panic_s3(const char *why)
820 char *cmd;
821 int result;
823 DEBUG(0,("PANIC (pid %llu): %s\n",
824 (unsigned long long)getpid(), why));
825 log_stack_trace();
827 #if defined(HAVE_PRCTL) && defined(PR_SET_PTRACER)
829 * Make sure all children can attach a debugger.
831 prctl(PR_SET_PTRACER, getpid(), 0, 0, 0);
832 #endif
834 cmd = lp_panic_action(talloc_tos());
835 if (cmd && *cmd) {
836 DEBUG(0, ("smb_panic(): calling panic action [%s]\n", cmd));
837 result = system(cmd);
839 if (result == -1)
840 DEBUG(0, ("smb_panic(): fork failed in panic action: %s\n",
841 strerror(errno)));
842 else
843 DEBUG(0, ("smb_panic(): action returned status %d\n",
844 WEXITSTATUS(result)));
847 dump_core();
850 /*******************************************************************
851 A readdir wrapper which just returns the file name.
852 ********************************************************************/
854 const char *readdirname(DIR *p)
856 struct dirent *ptr;
857 char *dname;
859 if (!p)
860 return(NULL);
862 ptr = (struct dirent *)readdir(p);
863 if (!ptr)
864 return(NULL);
866 dname = ptr->d_name;
868 #ifdef NEXT2
869 if (telldir(p) < 0)
870 return(NULL);
871 #endif
873 #ifdef HAVE_BROKEN_READDIR_NAME
874 /* using /usr/ucb/cc is BAD */
875 dname = dname - 2;
876 #endif
878 return talloc_strdup(talloc_tos(), dname);
881 /*******************************************************************
882 Utility function used to decide if the last component
883 of a path matches a (possibly wildcarded) entry in a namelist.
884 ********************************************************************/
886 bool is_in_path(const char *name, name_compare_entry *namelist, bool case_sensitive)
888 const char *last_component;
890 /* if we have no list it's obviously not in the path */
891 if((namelist == NULL ) || ((namelist != NULL) && (namelist[0].name == NULL))) {
892 return False;
895 DEBUG(8, ("is_in_path: %s\n", name));
897 /* Get the last component of the unix name. */
898 last_component = strrchr_m(name, '/');
899 if (!last_component) {
900 last_component = name;
901 } else {
902 last_component++; /* Go past '/' */
905 for(; namelist->name != NULL; namelist++) {
906 if(namelist->is_wild) {
907 if (mask_match(last_component, namelist->name, case_sensitive)) {
908 DEBUG(8,("is_in_path: mask match succeeded\n"));
909 return True;
911 } else {
912 if((case_sensitive && (strcmp(last_component, namelist->name) == 0))||
913 (!case_sensitive && (strcasecmp_m(last_component, namelist->name) == 0))) {
914 DEBUG(8,("is_in_path: match succeeded\n"));
915 return True;
919 DEBUG(8,("is_in_path: match not found\n"));
920 return False;
923 /*******************************************************************
924 Strip a '/' separated list into an array of
925 name_compare_enties structures suitable for
926 passing to is_in_path(). We do this for
927 speed so we can pre-parse all the names in the list
928 and don't do it for each call to is_in_path().
929 We also check if the entry contains a wildcard to
930 remove a potentially expensive call to mask_match
931 if possible.
932 ********************************************************************/
934 void set_namearray(name_compare_entry **ppname_array, const char *namelist_in)
936 char *name_end;
937 char *namelist;
938 char *namelist_end;
939 char *nameptr;
940 int num_entries = 0;
941 int i;
943 (*ppname_array) = NULL;
945 if((namelist_in == NULL ) || ((namelist_in != NULL) && (*namelist_in == '\0')))
946 return;
948 namelist = talloc_strdup(talloc_tos(), namelist_in);
949 if (namelist == NULL) {
950 DEBUG(0,("set_namearray: talloc fail\n"));
951 return;
953 nameptr = namelist;
955 namelist_end = &namelist[strlen(namelist)];
957 /* We need to make two passes over the string. The
958 first to count the number of elements, the second
959 to split it.
962 while(nameptr <= namelist_end) {
963 if ( *nameptr == '/' ) {
964 /* cope with multiple (useless) /s) */
965 nameptr++;
966 continue;
968 /* anything left? */
969 if ( *nameptr == '\0' )
970 break;
972 /* find the next '/' or consume remaining */
973 name_end = strchr_m(nameptr, '/');
974 if (name_end == NULL) {
975 /* Point nameptr at the terminating '\0' */
976 nameptr += strlen(nameptr);
977 } else {
978 /* next segment please */
979 nameptr = name_end + 1;
981 num_entries++;
984 if(num_entries == 0) {
985 talloc_free(namelist);
986 return;
989 if(( (*ppname_array) = SMB_MALLOC_ARRAY(name_compare_entry, num_entries + 1)) == NULL) {
990 DEBUG(0,("set_namearray: malloc fail\n"));
991 talloc_free(namelist);
992 return;
995 /* Now copy out the names */
996 nameptr = namelist;
997 i = 0;
998 while(nameptr <= namelist_end) {
999 if ( *nameptr == '/' ) {
1000 /* cope with multiple (useless) /s) */
1001 nameptr++;
1002 continue;
1004 /* anything left? */
1005 if ( *nameptr == '\0' )
1006 break;
1008 /* find the next '/' or consume remaining */
1009 name_end = strchr_m(nameptr, '/');
1010 if (name_end != NULL) {
1011 *name_end = '\0';
1014 (*ppname_array)[i].is_wild = ms_has_wild(nameptr);
1015 if(((*ppname_array)[i].name = SMB_STRDUP(nameptr)) == NULL) {
1016 DEBUG(0,("set_namearray: malloc fail (1)\n"));
1017 talloc_free(namelist);
1018 return;
1021 if (name_end == NULL) {
1022 /* Point nameptr at the terminating '\0' */
1023 nameptr += strlen(nameptr);
1024 } else {
1025 /* next segment please */
1026 nameptr = name_end + 1;
1028 i++;
1031 (*ppname_array)[i].name = NULL;
1033 talloc_free(namelist);
1034 return;
1037 #undef DBGC_CLASS
1038 #define DBGC_CLASS DBGC_LOCKING
1040 /****************************************************************************
1041 Simple routine to query existing file locks. Cruft in NFS and 64->32 bit mapping
1042 is dealt with in posix.c
1043 Returns True if we have information regarding this lock region (and returns
1044 F_UNLCK in *ptype if the region is unlocked). False if the call failed.
1045 ****************************************************************************/
1047 bool fcntl_getlock(int fd, int op, off_t *poffset, off_t *pcount, int *ptype, pid_t *ppid)
1049 struct flock lock;
1050 int ret;
1052 DEBUG(8,("fcntl_getlock fd=%d op=%d offset=%.0f count=%.0f type=%d\n",
1053 fd,op,(double)*poffset,(double)*pcount,*ptype));
1055 lock.l_type = *ptype;
1056 lock.l_whence = SEEK_SET;
1057 lock.l_start = *poffset;
1058 lock.l_len = *pcount;
1059 lock.l_pid = 0;
1061 ret = sys_fcntl_ptr(fd,op,&lock);
1063 if (ret == -1) {
1064 int sav = errno;
1065 DEBUG(3,("fcntl_getlock: lock request failed at offset %.0f count %.0f type %d (%s)\n",
1066 (double)*poffset,(double)*pcount,*ptype,strerror(errno)));
1067 errno = sav;
1068 return False;
1071 *ptype = lock.l_type;
1072 *poffset = lock.l_start;
1073 *pcount = lock.l_len;
1074 *ppid = lock.l_pid;
1076 DEBUG(3,("fcntl_getlock: fd %d is returned info %d pid %u\n",
1077 fd, (int)lock.l_type, (unsigned int)lock.l_pid));
1078 return True;
1081 #if defined(HAVE_OFD_LOCKS)
1082 int map_process_lock_to_ofd_lock(int op)
1084 switch (op) {
1085 case F_GETLK:
1086 case F_OFD_GETLK:
1087 op = F_OFD_GETLK;
1088 break;
1089 case F_SETLK:
1090 case F_OFD_SETLK:
1091 op = F_OFD_SETLK;
1092 break;
1093 case F_SETLKW:
1094 case F_OFD_SETLKW:
1095 op = F_OFD_SETLKW;
1096 break;
1097 default:
1098 return -1;
1100 return op;
1102 #else /* HAVE_OFD_LOCKS */
1103 int map_process_lock_to_ofd_lock(int op)
1105 return op;
1107 #endif /* HAVE_OFD_LOCKS */
1109 #undef DBGC_CLASS
1110 #define DBGC_CLASS DBGC_ALL
1112 /*******************************************************************
1113 Is the name specified one of my netbios names.
1114 Returns true if it is equal, false otherwise.
1115 ********************************************************************/
1117 bool is_myname(const char *s)
1119 int n;
1120 bool ret = False;
1122 for (n=0; my_netbios_names(n); n++) {
1123 const char *nbt_name = my_netbios_names(n);
1125 if (strncasecmp_m(nbt_name, s, MAX_NETBIOSNAME_LEN-1) == 0) {
1126 ret=True;
1127 break;
1130 DEBUG(8, ("is_myname(\"%s\") returns %d\n", s, ret));
1131 return(ret);
1134 /*******************************************************************
1135 we distinguish between 2K and XP by the "Native Lan Manager" string
1136 WinXP => "Windows 2002 5.1"
1137 WinXP 64bit => "Windows XP 5.2"
1138 Win2k => "Windows 2000 5.0"
1139 NT4 => "Windows NT 4.0"
1140 Win9x => "Windows 4.0"
1141 Windows 2003 doesn't set the native lan manager string but
1142 they do set the domain to "Windows 2003 5.2" (probably a bug).
1143 ********************************************************************/
1145 void ra_lanman_string( const char *native_lanman )
1147 if ( strcmp( native_lanman, "Windows 2002 5.1" ) == 0 )
1148 set_remote_arch( RA_WINXP );
1149 else if ( strcmp( native_lanman, "Windows XP 5.2" ) == 0 )
1150 set_remote_arch( RA_WINXP64 );
1151 else if ( strcmp( native_lanman, "Windows Server 2003 5.2" ) == 0 )
1152 set_remote_arch( RA_WIN2K3 );
1155 static const char *remote_arch_strings[] = {
1156 [RA_UNKNOWN] = "UNKNOWN",
1157 [RA_WFWG] = "WfWg",
1158 [RA_OS2] = "OS2",
1159 [RA_WIN95] = "Win95",
1160 [RA_WINNT] = "WinNT",
1161 [RA_WIN2K] = "Win2K",
1162 [RA_WINXP] = "WinXP",
1163 [RA_WIN2K3] = "Win2K3",
1164 [RA_VISTA] = "Vista",
1165 [RA_SAMBA] = "Samba",
1166 [RA_CIFSFS] = "CIFSFS",
1167 [RA_WINXP64] = "WinXP64",
1168 [RA_OSX] = "OSX",
1171 const char *get_remote_arch_str(void)
1173 if (ra_type >= ARRAY_SIZE(remote_arch_strings)) {
1175 * set_remote_arch() already checks this so ra_type
1176 * should be in the allowed range, but anyway, let's
1177 * do another bound check here.
1179 DBG_ERR("Remote arch info out of sync [%d] missing\n", ra_type);
1180 ra_type = RA_UNKNOWN;
1182 return remote_arch_strings[ra_type];
1185 enum remote_arch_types get_remote_arch_from_str(const char *remote_arch_string)
1187 int i;
1189 for (i = 0; i < ARRAY_SIZE(remote_arch_strings); i++) {
1190 if (strcmp(remote_arch_string, remote_arch_strings[i]) == 0) {
1191 return i;
1194 return RA_UNKNOWN;
1197 /*******************************************************************
1198 Set the horrid remote_arch string based on an enum.
1199 ********************************************************************/
1201 void set_remote_arch(enum remote_arch_types type)
1203 if (ra_type >= ARRAY_SIZE(remote_arch_strings)) {
1205 * This protects against someone adding values to enum
1206 * remote_arch_types without updating
1207 * remote_arch_strings array.
1209 DBG_ERR("Remote arch info out of sync [%d] missing\n", ra_type);
1210 ra_type = RA_UNKNOWN;
1211 return;
1214 ra_type = type;
1215 DEBUG(10,("set_remote_arch: Client arch is \'%s\'\n",
1216 get_remote_arch_str()));
1219 /*******************************************************************
1220 Get the remote_arch type.
1221 ********************************************************************/
1223 enum remote_arch_types get_remote_arch(void)
1225 return ra_type;
1228 #define RA_CACHE_TTL 7*24*3600
1230 static bool remote_arch_cache_key(const struct GUID *client_guid,
1231 fstring key)
1233 struct GUID_txt_buf guid_buf;
1234 const char *guid_string = NULL;
1236 guid_string = GUID_buf_string(client_guid, &guid_buf);
1237 if (guid_string == NULL) {
1238 return false;
1241 fstr_sprintf(key, "RA/%s", guid_string);
1242 return true;
1245 struct ra_parser_state {
1246 bool found;
1247 enum remote_arch_types ra;
1250 static void ra_parser(const struct gencache_timeout *t,
1251 DATA_BLOB blob,
1252 void *priv_data)
1254 struct ra_parser_state *state = (struct ra_parser_state *)priv_data;
1255 const char *ra_str = NULL;
1257 if (gencache_timeout_expired(t)) {
1258 return;
1261 if ((blob.length == 0) || (blob.data[blob.length-1] != '\0')) {
1262 DBG_ERR("Remote arch cache key not a string\n");
1263 return;
1266 ra_str = (const char *)blob.data;
1267 DBG_INFO("Got remote arch [%s] from cache\n", ra_str);
1269 state->ra = get_remote_arch_from_str(ra_str);
1270 state->found = true;
1271 return;
1274 static bool remote_arch_cache_get(const struct GUID *client_guid)
1276 bool ok;
1277 fstring ra_key;
1278 struct ra_parser_state state = (struct ra_parser_state) {
1279 .found = false,
1280 .ra = RA_UNKNOWN,
1283 ok = remote_arch_cache_key(client_guid, ra_key);
1284 if (!ok) {
1285 return false;
1288 ok = gencache_parse(ra_key, ra_parser, &state);
1289 if (!ok || !state.found) {
1290 return true;
1293 if (state.ra == RA_UNKNOWN) {
1294 return true;
1297 set_remote_arch(state.ra);
1298 return true;
1301 static bool remote_arch_cache_set(const struct GUID *client_guid)
1303 bool ok;
1304 fstring ra_key;
1305 const char *ra_str = NULL;
1307 if (get_remote_arch() == RA_UNKNOWN) {
1308 return true;
1311 ok = remote_arch_cache_key(client_guid, ra_key);
1312 if (!ok) {
1313 return false;
1316 ra_str = get_remote_arch_str();
1317 if (ra_str == NULL) {
1318 return false;
1321 ok = gencache_set(ra_key, ra_str, time(NULL) + RA_CACHE_TTL);
1322 if (!ok) {
1323 return false;
1326 return true;
1329 bool remote_arch_cache_update(const struct GUID *client_guid)
1331 bool ok;
1333 if (get_remote_arch() == RA_UNKNOWN) {
1335 become_root();
1336 ok = remote_arch_cache_get(client_guid);
1337 unbecome_root();
1339 return ok;
1342 become_root();
1343 ok = remote_arch_cache_set(client_guid);
1344 unbecome_root();
1346 return ok;
1349 bool remote_arch_cache_delete(const struct GUID *client_guid)
1351 bool ok;
1352 fstring ra_key;
1354 ok = remote_arch_cache_key(client_guid, ra_key);
1355 if (!ok) {
1356 return false;
1359 become_root();
1360 ok = gencache_del(ra_key);
1361 unbecome_root();
1363 if (!ok) {
1364 return false;
1367 return true;
1370 const char *tab_depth(int level, int depth)
1372 if( CHECK_DEBUGLVL(level) ) {
1373 dbgtext("%*s", depth*4, "");
1375 return "";
1378 /*****************************************************************************
1379 Provide a checksum on a string
1381 Input: s - the null-terminated character string for which the checksum
1382 will be calculated.
1384 Output: The checksum value calculated for s.
1385 *****************************************************************************/
1387 int str_checksum(const char *s)
1389 TDB_DATA key;
1390 if (s == NULL)
1391 return 0;
1393 key = (TDB_DATA) { .dptr = discard_const_p(uint8_t, s),
1394 .dsize = strlen(s) };
1396 return tdb_jenkins_hash(&key);
1399 /*****************************************************************
1400 Zero a memory area then free it. Used to catch bugs faster.
1401 *****************************************************************/
1403 void zero_free(void *p, size_t size)
1405 memset(p, 0, size);
1406 SAFE_FREE(p);
1409 /*****************************************************************
1410 Set our open file limit to a requested max and return the limit.
1411 *****************************************************************/
1413 int set_maxfiles(int requested_max)
1415 #if (defined(HAVE_GETRLIMIT) && defined(RLIMIT_NOFILE))
1416 struct rlimit rlp;
1417 int saved_current_limit;
1419 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
1420 DEBUG(0,("set_maxfiles: getrlimit (1) for RLIMIT_NOFILE failed with error %s\n",
1421 strerror(errno) ));
1422 /* just guess... */
1423 return requested_max;
1427 * Set the fd limit to be real_max_open_files + MAX_OPEN_FUDGEFACTOR to
1428 * account for the extra fd we need
1429 * as well as the log files and standard
1430 * handles etc. Save the limit we want to set in case
1431 * we are running on an OS that doesn't support this limit (AIX)
1432 * which always returns RLIM_INFINITY for rlp.rlim_max.
1435 /* Try raising the hard (max) limit to the requested amount. */
1437 #if defined(RLIM_INFINITY)
1438 if (rlp.rlim_max != RLIM_INFINITY) {
1439 int orig_max = rlp.rlim_max;
1441 if ( rlp.rlim_max < requested_max )
1442 rlp.rlim_max = requested_max;
1444 /* This failing is not an error - many systems (Linux) don't
1445 support our default request of 10,000 open files. JRA. */
1447 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
1448 DEBUG(3,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d max files failed with error %s\n",
1449 (int)rlp.rlim_max, strerror(errno) ));
1451 /* Set failed - restore original value from get. */
1452 rlp.rlim_max = orig_max;
1455 #endif
1457 /* Now try setting the soft (current) limit. */
1459 saved_current_limit = rlp.rlim_cur = MIN(requested_max,rlp.rlim_max);
1461 if(setrlimit(RLIMIT_NOFILE, &rlp)) {
1462 DEBUG(0,("set_maxfiles: setrlimit for RLIMIT_NOFILE for %d files failed with error %s\n",
1463 (int)rlp.rlim_cur, strerror(errno) ));
1464 /* just guess... */
1465 return saved_current_limit;
1468 if(getrlimit(RLIMIT_NOFILE, &rlp)) {
1469 DEBUG(0,("set_maxfiles: getrlimit (2) for RLIMIT_NOFILE failed with error %s\n",
1470 strerror(errno) ));
1471 /* just guess... */
1472 return saved_current_limit;
1475 #if defined(RLIM_INFINITY)
1476 if(rlp.rlim_cur == RLIM_INFINITY)
1477 return saved_current_limit;
1478 #endif
1480 if((int)rlp.rlim_cur > saved_current_limit)
1481 return saved_current_limit;
1483 return rlp.rlim_cur;
1484 #else /* !defined(HAVE_GETRLIMIT) || !defined(RLIMIT_NOFILE) */
1486 * No way to know - just guess...
1488 return requested_max;
1489 #endif
1492 /*****************************************************************
1493 malloc that aborts with smb_panic on fail or zero size.
1494 *****************************************************************/
1496 void *smb_xmalloc_array(size_t size, unsigned int count)
1498 void *p;
1499 if (size == 0) {
1500 smb_panic("smb_xmalloc_array: called with zero size");
1502 if (count >= MAX_ALLOC_SIZE/size) {
1503 smb_panic("smb_xmalloc_array: alloc size too large");
1505 if ((p = SMB_MALLOC(size*count)) == NULL) {
1506 DEBUG(0, ("smb_xmalloc_array failed to allocate %lu * %lu bytes\n",
1507 (unsigned long)size, (unsigned long)count));
1508 smb_panic("smb_xmalloc_array: malloc failed");
1510 return p;
1514 vasprintf that aborts on malloc fail
1517 int smb_xvasprintf(char **ptr, const char *format, va_list ap)
1519 int n;
1520 va_list ap2;
1522 va_copy(ap2, ap);
1524 n = vasprintf(ptr, format, ap2);
1525 va_end(ap2);
1526 if (n == -1 || ! *ptr) {
1527 smb_panic("smb_xvasprintf: out of memory");
1529 return n;
1532 /*****************************************************************
1533 Get local hostname and cache result.
1534 *****************************************************************/
1536 char *myhostname(void)
1538 static char *ret;
1539 if (ret == NULL) {
1540 ret = get_myname(NULL);
1542 return ret;
1545 /*****************************************************************
1546 Get local hostname and cache result.
1547 *****************************************************************/
1549 char *myhostname_upper(void)
1551 static char *ret;
1552 if (ret == NULL) {
1553 char *name = get_myname(NULL);
1554 if (name == NULL) {
1555 return NULL;
1557 ret = strupper_talloc(NULL, name);
1558 talloc_free(name);
1560 return ret;
1563 /*******************************************************************
1564 Given a filename - get its directory name
1565 ********************************************************************/
1567 bool parent_dirname(TALLOC_CTX *mem_ctx, const char *dir, char **parent,
1568 const char **name)
1570 char *p;
1571 ptrdiff_t len;
1573 p = strrchr_m(dir, '/'); /* Find final '/', if any */
1575 if (p == NULL) {
1576 if (!(*parent = talloc_strdup(mem_ctx, "."))) {
1577 return False;
1579 if (name) {
1580 *name = dir;
1582 return True;
1585 len = p-dir;
1587 if (!(*parent = (char *)talloc_memdup(mem_ctx, dir, len+1))) {
1588 return False;
1590 (*parent)[len] = '\0';
1592 if (name) {
1593 *name = p+1;
1595 return True;
1598 /*******************************************************************
1599 Determine if a pattern contains any Microsoft wildcard characters.
1600 *******************************************************************/
1602 bool ms_has_wild(const char *s)
1604 char c;
1606 while ((c = *s++)) {
1607 switch (c) {
1608 case '*':
1609 case '?':
1610 case '<':
1611 case '>':
1612 case '"':
1613 return True;
1616 return False;
1619 bool ms_has_wild_w(const smb_ucs2_t *s)
1621 smb_ucs2_t c;
1622 if (!s) return False;
1623 while ((c = *s++)) {
1624 switch (c) {
1625 case UCS2_CHAR('*'):
1626 case UCS2_CHAR('?'):
1627 case UCS2_CHAR('<'):
1628 case UCS2_CHAR('>'):
1629 case UCS2_CHAR('"'):
1630 return True;
1633 return False;
1636 /*******************************************************************
1637 A wrapper that handles case sensitivity and the special handling
1638 of the ".." name.
1639 *******************************************************************/
1641 bool mask_match(const char *string, const char *pattern, bool is_case_sensitive)
1643 if (ISDOTDOT(string))
1644 string = ".";
1645 if (ISDOT(pattern))
1646 return False;
1648 return ms_fnmatch_protocol(pattern, string, Protocol, is_case_sensitive) == 0;
1651 /*******************************************************************
1652 A wrapper that handles case sensitivity and the special handling
1653 of the ".." name. Varient that is only called by old search code which requires
1654 pattern translation.
1655 *******************************************************************/
1657 bool mask_match_search(const char *string, const char *pattern, bool is_case_sensitive)
1659 if (ISDOTDOT(string))
1660 string = ".";
1661 if (ISDOT(pattern))
1662 return False;
1664 return ms_fnmatch(pattern, string, True, is_case_sensitive) == 0;
1667 /*******************************************************************
1668 A wrapper that handles a list of patters and calls mask_match()
1669 on each. Returns True if any of the patterns match.
1670 *******************************************************************/
1672 bool mask_match_list(const char *string, char **list, int listLen, bool is_case_sensitive)
1674 while (listLen-- > 0) {
1675 if (mask_match(string, *list++, is_case_sensitive))
1676 return True;
1678 return False;
1681 /**********************************************************************
1682 Converts a name to a fully qualified domain name.
1683 Returns true if lookup succeeded, false if not (then fqdn is set to name)
1684 Uses getaddrinfo() with AI_CANONNAME flag to obtain the official
1685 canonical name of the host. getaddrinfo() may use a variety of sources
1686 including /etc/hosts to obtain the domainname. It expects aliases in
1687 /etc/hosts to NOT be the FQDN. The FQDN should come first.
1688 ************************************************************************/
1690 bool name_to_fqdn(fstring fqdn, const char *name)
1692 char *full = NULL;
1693 struct addrinfo hints;
1694 struct addrinfo *result;
1695 int s;
1697 /* Configure hints to obtain canonical name */
1699 memset(&hints, 0, sizeof(struct addrinfo));
1700 hints.ai_family = AF_UNSPEC; /* Allow IPv4 or IPv6 */
1701 hints.ai_socktype = SOCK_DGRAM; /* Datagram socket */
1702 hints.ai_flags = AI_CANONNAME; /* Get host's FQDN */
1703 hints.ai_protocol = 0; /* Any protocol */
1705 s = getaddrinfo(name, NULL, &hints, &result);
1706 if (s != 0) {
1707 DEBUG(1, ("getaddrinfo: %s\n", gai_strerror(s)));
1708 DEBUG(10,("name_to_fqdn: lookup for %s failed.\n", name));
1709 fstrcpy(fqdn, name);
1710 return false;
1712 full = result->ai_canonname;
1714 /* Find out if the FQDN is returned as an alias
1715 * to cope with /etc/hosts files where the first
1716 * name is not the FQDN but the short name.
1717 * getaddrinfo provides no easy way of handling aliases
1718 * in /etc/hosts. Users should make sure the FQDN
1719 * comes first in /etc/hosts. */
1720 if (full && (! strchr_m(full, '.'))) {
1721 DEBUG(1, ("WARNING: your /etc/hosts file may be broken!\n"));
1722 DEBUGADD(1, (" Full qualified domain names (FQDNs) should not be specified\n"));
1723 DEBUGADD(1, (" as an alias in /etc/hosts. FQDN should be the first name\n"));
1724 DEBUGADD(1, (" prior to any aliases.\n"));
1726 if (full && (strcasecmp_m(full, "localhost.localdomain") == 0)) {
1727 DEBUG(1, ("WARNING: your /etc/hosts file may be broken!\n"));
1728 DEBUGADD(1, (" Specifying the machine hostname for address 127.0.0.1 may lead\n"));
1729 DEBUGADD(1, (" to Kerberos authentication problems as localhost.localdomain\n"));
1730 DEBUGADD(1, (" may end up being used instead of the real machine FQDN.\n"));
1733 DEBUG(10,("name_to_fqdn: lookup for %s -> %s.\n", name, full));
1734 fstrcpy(fqdn, full);
1735 freeaddrinfo(result); /* No longer needed */
1736 return true;
1739 uint32_t map_share_mode_to_deny_mode(uint32_t share_access, uint32_t private_options)
1741 switch (share_access & ~FILE_SHARE_DELETE) {
1742 case FILE_SHARE_NONE:
1743 return DENY_ALL;
1744 case FILE_SHARE_READ:
1745 return DENY_WRITE;
1746 case FILE_SHARE_WRITE:
1747 return DENY_READ;
1748 case FILE_SHARE_READ|FILE_SHARE_WRITE:
1749 return DENY_NONE;
1751 if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_DOS) {
1752 return DENY_DOS;
1753 } else if (private_options & NTCREATEX_OPTIONS_PRIVATE_DENY_FCB) {
1754 return DENY_FCB;
1757 return (uint32_t)-1;
1760 struct server_id interpret_pid(const char *pid_string)
1762 return server_id_from_string(get_my_vnn(), pid_string);
1765 /****************************************************************
1766 Check if an offset into a buffer is safe.
1767 If this returns True it's safe to indirect into the byte at
1768 pointer ptr+off.
1769 ****************************************************************/
1771 bool is_offset_safe(const char *buf_base, size_t buf_len, char *ptr, size_t off)
1773 const char *end_base = buf_base + buf_len;
1774 char *end_ptr = ptr + off;
1776 if (!buf_base || !ptr) {
1777 return False;
1780 if (end_base < buf_base || end_ptr < ptr) {
1781 return False; /* wrap. */
1784 if (end_ptr < end_base) {
1785 return True;
1787 return False;
1790 /****************************************************************
1791 Return a safe pointer into a buffer, or NULL.
1792 ****************************************************************/
1794 char *get_safe_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
1796 return is_offset_safe(buf_base, buf_len, ptr, off) ?
1797 ptr + off : NULL;
1800 /****************************************************************
1801 Return a safe pointer into a string within a buffer, or NULL.
1802 ****************************************************************/
1804 char *get_safe_str_ptr(const char *buf_base, size_t buf_len, char *ptr, size_t off)
1806 if (!is_offset_safe(buf_base, buf_len, ptr, off)) {
1807 return NULL;
1809 /* Check if a valid string exists at this offset. */
1810 if (skip_string(buf_base,buf_len, ptr + off) == NULL) {
1811 return NULL;
1813 return ptr + off;
1816 /****************************************************************
1817 Return an SVAL at a pointer, or failval if beyond the end.
1818 ****************************************************************/
1820 int get_safe_SVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
1823 * Note we use off+1 here, not off+2 as SVAL accesses ptr[0] and ptr[1],
1824 * NOT ptr[2].
1826 if (!is_offset_safe(buf_base, buf_len, ptr, off+1)) {
1827 return failval;
1829 return SVAL(ptr,off);
1832 /****************************************************************
1833 Return an IVAL at a pointer, or failval if beyond the end.
1834 ****************************************************************/
1836 int get_safe_IVAL(const char *buf_base, size_t buf_len, char *ptr, size_t off, int failval)
1839 * Note we use off+3 here, not off+4 as IVAL accesses
1840 * ptr[0] ptr[1] ptr[2] ptr[3] NOT ptr[4].
1842 if (!is_offset_safe(buf_base, buf_len, ptr, off+3)) {
1843 return failval;
1845 return IVAL(ptr,off);
1848 /****************************************************************
1849 Split DOM\user into DOM and user. Do not mix with winbind variants of that
1850 call (they take care of winbind separator and other winbind specific settings).
1851 ****************************************************************/
1853 bool split_domain_user(TALLOC_CTX *mem_ctx,
1854 const char *full_name,
1855 char **domain,
1856 char **user)
1858 const char *p = NULL;
1860 p = strchr_m(full_name, '\\');
1862 if (p != NULL) {
1863 *domain = talloc_strndup(mem_ctx, full_name,
1864 PTR_DIFF(p, full_name));
1865 if (*domain == NULL) {
1866 return false;
1868 *user = talloc_strdup(mem_ctx, p+1);
1869 if (*user == NULL) {
1870 TALLOC_FREE(*domain);
1871 return false;
1873 } else {
1874 *domain = NULL;
1875 *user = talloc_strdup(mem_ctx, full_name);
1876 if (*user == NULL) {
1877 return false;
1881 return true;
1884 /****************************************************************
1885 strip off leading '\\' from a hostname
1886 ****************************************************************/
1888 const char *strip_hostname(const char *s)
1890 if (!s) {
1891 return NULL;
1894 if (strlen_m(s) < 3) {
1895 return s;
1898 if (s[0] == '\\') s++;
1899 if (s[0] == '\\') s++;
1901 return s;
1904 bool any_nt_status_not_ok(NTSTATUS err1, NTSTATUS err2, NTSTATUS *result)
1906 if (!NT_STATUS_IS_OK(err1)) {
1907 *result = err1;
1908 return true;
1910 if (!NT_STATUS_IS_OK(err2)) {
1911 *result = err2;
1912 return true;
1914 return false;
1917 int timeval_to_msec(struct timeval t)
1919 return t.tv_sec * 1000 + (t.tv_usec+999) / 1000;
1922 /*******************************************************************
1923 Check a given DOS pathname is valid for a share.
1924 ********************************************************************/
1926 char *valid_share_pathname(TALLOC_CTX *ctx, const char *dos_pathname)
1928 char *ptr = NULL;
1930 if (!dos_pathname) {
1931 return NULL;
1934 ptr = talloc_strdup(ctx, dos_pathname);
1935 if (!ptr) {
1936 return NULL;
1938 /* Convert any '\' paths to '/' */
1939 unix_format(ptr);
1940 ptr = unix_clean_name(ctx, ptr);
1941 if (!ptr) {
1942 return NULL;
1945 /* NT is braindead - it wants a C: prefix to a pathname ! So strip it. */
1946 if (strlen(ptr) > 2 && ptr[1] == ':' && ptr[0] != '/')
1947 ptr += 2;
1949 /* Only absolute paths allowed. */
1950 if (*ptr != '/')
1951 return NULL;
1953 return ptr;
1956 /*******************************************************************
1957 Return True if the filename is one of the special executable types.
1958 ********************************************************************/
1960 bool is_executable(const char *fname)
1962 if ((fname = strrchr_m(fname,'.'))) {
1963 if (strequal(fname,".com") ||
1964 strequal(fname,".dll") ||
1965 strequal(fname,".exe") ||
1966 strequal(fname,".sym")) {
1967 return True;
1970 return False;
1973 /****************************************************************************
1974 Open a file with a share mode - old openX method - map into NTCreate.
1975 ****************************************************************************/
1977 bool map_open_params_to_ntcreate(const char *smb_base_fname,
1978 int deny_mode, int open_func,
1979 uint32_t *paccess_mask,
1980 uint32_t *pshare_mode,
1981 uint32_t *pcreate_disposition,
1982 uint32_t *pcreate_options,
1983 uint32_t *pprivate_flags)
1985 uint32_t access_mask;
1986 uint32_t share_mode;
1987 uint32_t create_disposition;
1988 uint32_t create_options = FILE_NON_DIRECTORY_FILE;
1989 uint32_t private_flags = 0;
1991 DEBUG(10,("map_open_params_to_ntcreate: fname = %s, deny_mode = 0x%x, "
1992 "open_func = 0x%x\n",
1993 smb_base_fname, (unsigned int)deny_mode,
1994 (unsigned int)open_func ));
1996 /* Create the NT compatible access_mask. */
1997 switch (GET_OPENX_MODE(deny_mode)) {
1998 case DOS_OPEN_EXEC: /* Implies read-only - used to be FILE_READ_DATA */
1999 case DOS_OPEN_RDONLY:
2000 access_mask = FILE_GENERIC_READ;
2001 break;
2002 case DOS_OPEN_WRONLY:
2003 access_mask = FILE_GENERIC_WRITE;
2004 break;
2005 case DOS_OPEN_RDWR:
2006 case DOS_OPEN_FCB:
2007 access_mask = FILE_GENERIC_READ|FILE_GENERIC_WRITE;
2008 break;
2009 default:
2010 DEBUG(10,("map_open_params_to_ntcreate: bad open mode = 0x%x\n",
2011 (unsigned int)GET_OPENX_MODE(deny_mode)));
2012 return False;
2015 /* Create the NT compatible create_disposition. */
2016 switch (open_func) {
2017 case OPENX_FILE_EXISTS_FAIL|OPENX_FILE_CREATE_IF_NOT_EXIST:
2018 create_disposition = FILE_CREATE;
2019 break;
2021 case OPENX_FILE_EXISTS_OPEN:
2022 create_disposition = FILE_OPEN;
2023 break;
2025 case OPENX_FILE_EXISTS_OPEN|OPENX_FILE_CREATE_IF_NOT_EXIST:
2026 create_disposition = FILE_OPEN_IF;
2027 break;
2029 case OPENX_FILE_EXISTS_TRUNCATE:
2030 create_disposition = FILE_OVERWRITE;
2031 break;
2033 case OPENX_FILE_EXISTS_TRUNCATE|OPENX_FILE_CREATE_IF_NOT_EXIST:
2034 create_disposition = FILE_OVERWRITE_IF;
2035 break;
2037 default:
2038 /* From samba4 - to be confirmed. */
2039 if (GET_OPENX_MODE(deny_mode) == DOS_OPEN_EXEC) {
2040 create_disposition = FILE_CREATE;
2041 break;
2043 DEBUG(10,("map_open_params_to_ntcreate: bad "
2044 "open_func 0x%x\n", (unsigned int)open_func));
2045 return False;
2048 /* Create the NT compatible share modes. */
2049 switch (GET_DENY_MODE(deny_mode)) {
2050 case DENY_ALL:
2051 share_mode = FILE_SHARE_NONE;
2052 break;
2054 case DENY_WRITE:
2055 share_mode = FILE_SHARE_READ;
2056 break;
2058 case DENY_READ:
2059 share_mode = FILE_SHARE_WRITE;
2060 break;
2062 case DENY_NONE:
2063 share_mode = FILE_SHARE_READ|FILE_SHARE_WRITE;
2064 break;
2066 case DENY_DOS:
2067 private_flags |= NTCREATEX_OPTIONS_PRIVATE_DENY_DOS;
2068 if (is_executable(smb_base_fname)) {
2069 share_mode = FILE_SHARE_READ|FILE_SHARE_WRITE;
2070 } else {
2071 if (GET_OPENX_MODE(deny_mode) == DOS_OPEN_RDONLY) {
2072 share_mode = FILE_SHARE_READ;
2073 } else {
2074 share_mode = FILE_SHARE_NONE;
2077 break;
2079 case DENY_FCB:
2080 private_flags |= NTCREATEX_OPTIONS_PRIVATE_DENY_FCB;
2081 share_mode = FILE_SHARE_NONE;
2082 break;
2084 default:
2085 DEBUG(10,("map_open_params_to_ntcreate: bad deny_mode 0x%x\n",
2086 (unsigned int)GET_DENY_MODE(deny_mode) ));
2087 return False;
2090 DEBUG(10,("map_open_params_to_ntcreate: file %s, access_mask = 0x%x, "
2091 "share_mode = 0x%x, create_disposition = 0x%x, "
2092 "create_options = 0x%x private_flags = 0x%x\n",
2093 smb_base_fname,
2094 (unsigned int)access_mask,
2095 (unsigned int)share_mode,
2096 (unsigned int)create_disposition,
2097 (unsigned int)create_options,
2098 (unsigned int)private_flags));
2100 if (paccess_mask) {
2101 *paccess_mask = access_mask;
2103 if (pshare_mode) {
2104 *pshare_mode = share_mode;
2106 if (pcreate_disposition) {
2107 *pcreate_disposition = create_disposition;
2109 if (pcreate_options) {
2110 *pcreate_options = create_options;
2112 if (pprivate_flags) {
2113 *pprivate_flags = private_flags;
2116 return True;
2120 /*************************************************************************
2121 Return a talloced copy of a struct security_unix_token. NULL on fail.
2122 *************************************************************************/
2124 struct security_unix_token *copy_unix_token(TALLOC_CTX *ctx, const struct security_unix_token *tok)
2126 struct security_unix_token *cpy;
2128 cpy = talloc(ctx, struct security_unix_token);
2129 if (!cpy) {
2130 return NULL;
2133 cpy->uid = tok->uid;
2134 cpy->gid = tok->gid;
2135 cpy->ngroups = tok->ngroups;
2136 if (tok->ngroups) {
2137 /* Make this a talloc child of cpy. */
2138 cpy->groups = (gid_t *)talloc_memdup(
2139 cpy, tok->groups, tok->ngroups * sizeof(gid_t));
2140 if (!cpy->groups) {
2141 TALLOC_FREE(cpy);
2142 return NULL;
2144 } else {
2145 cpy->groups = NULL;
2147 return cpy;
2150 /****************************************************************************
2151 Return a root token
2152 ****************************************************************************/
2154 struct security_unix_token *root_unix_token(TALLOC_CTX *mem_ctx)
2156 struct security_unix_token *t = NULL;
2158 t = talloc_zero(mem_ctx, struct security_unix_token);
2159 if (t == NULL) {
2160 return NULL;
2164 * This is not needed, but lets make it explicit, not implicit.
2166 *t = (struct security_unix_token) {
2167 .uid = 0,
2168 .gid = 0,
2169 .ngroups = 0,
2170 .groups = NULL
2173 return t;
2176 /****************************************************************************
2177 Check that a file matches a particular file type.
2178 ****************************************************************************/
2180 bool dir_check_ftype(uint32_t mode, uint32_t dirtype)
2182 uint32_t mask;
2184 /* Check the "may have" search bits. */
2185 if (((mode & ~dirtype) &
2186 (FILE_ATTRIBUTE_HIDDEN |
2187 FILE_ATTRIBUTE_SYSTEM |
2188 FILE_ATTRIBUTE_DIRECTORY)) != 0) {
2189 return false;
2192 /* Check the "must have" bits,
2193 which are the may have bits shifted eight */
2194 /* If must have bit is set, the file/dir can
2195 not be returned in search unless the matching
2196 file attribute is set */
2197 mask = ((dirtype >> 8) & (FILE_ATTRIBUTE_DIRECTORY|
2198 FILE_ATTRIBUTE_ARCHIVE|
2199 FILE_ATTRIBUTE_READONLY|
2200 FILE_ATTRIBUTE_HIDDEN|
2201 FILE_ATTRIBUTE_SYSTEM)); /* & 0x37 */
2202 if(mask) {
2203 if((mask & (mode & (FILE_ATTRIBUTE_DIRECTORY|
2204 FILE_ATTRIBUTE_ARCHIVE|
2205 FILE_ATTRIBUTE_READONLY|
2206 FILE_ATTRIBUTE_HIDDEN|
2207 FILE_ATTRIBUTE_SYSTEM))) == mask) {
2208 /* check if matching attribute present */
2209 return true;
2210 } else {
2211 return false;
2215 return true;