2 Samba Unix/Linux SMB client library
3 Distributed SMB/CIFS Server Management Utility
5 Copyright (C) Jeremy Allison (jra@samba.org) 2005
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
22 #include "utils/net.h"
25 const char *us_errstr;
26 enum usershare_err us_err;
29 {"Malformed usershare file", USERSHARE_MALFORMED_FILE},
30 {"Bad version number", USERSHARE_BAD_VERSION},
31 {"Malformed path entry", USERSHARE_MALFORMED_PATH},
32 {"Malformed comment entryfile", USERSHARE_MALFORMED_COMMENT_DEF},
33 {"Malformed acl definition", USERSHARE_MALFORMED_ACL_DEF},
34 {"Acl parse error", USERSHARE_ACL_ERR},
35 {"Path not absolute", USERSHARE_PATH_NOT_ABSOLUTE},
36 {"Path is denied", USERSHARE_PATH_IS_DENIED},
37 {"Path not allowed", USERSHARE_PATH_NOT_ALLOWED},
38 {"Path is not a directory", USERSHARE_PATH_NOT_DIRECTORY},
39 {"System error", USERSHARE_POSIX_ERR},
40 {NULL,(enum usershare_err)-1}
43 static const char *get_us_error_code(enum usershare_err us_err)
48 while (us_errs[idx].us_errstr != NULL) {
49 if (us_errs[idx].us_err == us_err) {
50 return us_errs[idx].us_errstr;
55 slprintf(out, sizeof(out), "Usershare error code (0x%x)", (unsigned int)us_err);
59 /* The help subsystem for the USERSHARE subcommand */
61 static int net_usershare_add_usage(int argc, const char **argv)
63 char c = *lp_winbind_separator();
65 "net usershare add [-l|--long] <sharename> <path> [<comment>] [<acl>] [<guest_ok=[y|n]>]\n"
66 "\tAdds the specified share name for this user.\n"
67 "\t<sharename> is the new share name.\n"
68 "\t<path> is the path on the filesystem to export.\n"
69 "\t<comment> is the optional comment for the new share.\n"
70 "\t<acl> is an optional share acl in the format \"DOMAIN%cname:X,DOMAIN%cname:X,....\"\n"
71 "\t<guest_ok=y> if present sets \"guest ok = yes\" on this usershare.\n"
72 "\t\t\"X\" represents a permission and can be any one of the characters f, r or d\n"
73 "\t\twhere \"f\" means full control, \"r\" means read-only, \"d\" means deny access.\n"
74 "\t\tname may be a domain user or group. For local users use the local server name "
75 "instead of \"DOMAIN\"\n"
76 "\t\tThe default acl is \"Everyone:r\" which allows everyone read-only access.\n"
77 "\tAdd -l or --long to print the info on the newly added share.\n",
82 static int net_usershare_delete_usage(int argc, const char **argv)
85 "net usershare delete <sharename>\n"\
86 "\tdeletes the specified share name for this user.\n");
90 static int net_usershare_info_usage(int argc, const char **argv)
93 "net usershare info [-l|--long] [wildcard sharename]\n"\
94 "\tPrints out the path, comment and acl elements of shares that match the wildcard.\n"
95 "\tBy default only gives info on shares owned by the current user\n"
96 "\tAdd -l or --long to apply this to all shares\n"
97 "\tOmit the sharename or use a wildcard of '*' to see all shares\n");
101 static int net_usershare_list_usage(int argc, const char **argv)
104 "net usershare list [-l|--long] [wildcard sharename]\n"\
105 "\tLists the names of all shares that match the wildcard.\n"
106 "\tBy default only lists shares owned by the current user\n"
107 "\tAdd -l or --long to apply this to all shares\n"
108 "\tOmit the sharename or use a wildcard of '*' to see all shares\n");
112 int net_usershare_usage(int argc, const char **argv)
114 d_printf("net usershare add <sharename> <path> [<comment>] [<acl>] [<guest_ok=[y|n]>] to "
115 "add or change a user defined share.\n"
116 "net usershare delete <sharename> to delete a user defined share.\n"
117 "net usershare info [-l|--long] [wildcard sharename] to print info about a user defined share.\n"
118 "net usershare list [-l|--long] [wildcard sharename] to list user defined shares.\n"
119 "net usershare help\n"\
120 "\nType \"net usershare help <option>\" to get more information on that option\n\n");
122 net_common_flags_usage(argc, argv);
126 /***************************************************************************
127 ***************************************************************************/
129 static void get_basepath(pstring basepath)
131 pstrcpy(basepath, lp_usershare_path());
132 if ((basepath[0] != '\0') && (basepath[strlen(basepath)-1] == '/')) {
133 basepath[strlen(basepath)-1] = '\0';
137 /***************************************************************************
138 Delete a single userlevel share.
139 ***************************************************************************/
141 static int net_usershare_delete(int argc, const char **argv)
147 return net_usershare_delete_usage(argc, argv);
150 if ((sharename = strdup_lower(argv[0])) == NULL) {
151 d_fprintf(stderr, "strdup failed\n");
155 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
156 d_fprintf(stderr, "net usershare delete: share name %s contains "
157 "invalid characters (any of %s)\n",
158 sharename, INVALID_SHARENAME_CHARS);
159 SAFE_FREE(sharename);
163 pstrcpy(us_path, lp_usershare_path());
164 pstrcat(us_path, "/");
165 pstrcat(us_path, sharename);
167 if (unlink(us_path) != 0) {
168 d_fprintf(stderr, "net usershare delete: unable to remove usershare %s. "
170 us_path, strerror(errno));
171 SAFE_FREE(sharename);
174 SAFE_FREE(sharename);
178 /***************************************************************************
179 Data structures to handle a list of usershare files.
180 ***************************************************************************/
183 struct file_list *next, *prev;
184 const char *pathname;
187 static struct file_list *flist;
189 /***************************************************************************
190 ***************************************************************************/
192 static int get_share_list(TALLOC_CTX *ctx, const char *wcard, BOOL only_ours)
195 SMB_STRUCT_DIRENT *de;
196 uid_t myuid = geteuid();
197 struct file_list *fl = NULL;
200 get_basepath(basepath);
201 dp = sys_opendir(basepath);
203 d_fprintf(stderr, "get_share_list: cannot open usershare directory %s. Error %s\n",
204 basepath, strerror(errno) );
208 while((de = sys_readdir(dp)) != 0) {
209 SMB_STRUCT_STAT sbuf;
211 const char *n = de->d_name;
213 /* Ignore . and .. */
215 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
220 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
221 d_fprintf(stderr, "get_share_list: ignoring bad share name %s\n",n);
224 pstrcpy(path, basepath);
228 if (sys_lstat(path, &sbuf) != 0) {
229 d_fprintf(stderr, "get_share_list: can't lstat file %s. Error was %s\n",
230 path, strerror(errno) );
234 if (!S_ISREG(sbuf.st_mode)) {
235 d_fprintf(stderr, "get_share_list: file %s is not a regular file. Ignoring.\n",
240 if (only_ours && sbuf.st_uid != myuid) {
244 if (!unix_wild_match(wcard, n)) {
248 /* (Finally) - add to list. */
249 fl = TALLOC_P(ctx, struct file_list);
253 fl->pathname = talloc_strdup(ctx, n);
258 DLIST_ADD(flist, fl);
265 enum us_priv_op { US_LIST_OP, US_INFO_OP};
267 struct us_priv_info {
272 /***************************************************************************
273 Call a function for every share on the list.
274 ***************************************************************************/
276 static int process_share_list(int (*fn)(struct file_list *, void *), void *priv)
278 struct file_list *fl;
281 for (fl = flist; fl; fl = fl->next) {
282 ret = (*fn)(fl, priv);
288 /***************************************************************************
290 ***************************************************************************/
292 static int info_fn(struct file_list *fl, void *priv)
294 SMB_STRUCT_STAT sbuf;
296 struct us_priv_info *pi = (struct us_priv_info *)priv;
297 TALLOC_CTX *ctx = pi->ctx;
300 SEC_DESC *psd = NULL;
307 enum usershare_err us_err;
308 BOOL guest_ok = False;
310 sep_str[0] = *lp_winbind_separator();
313 get_basepath(basepath);
314 pstrcat(basepath, "/");
315 pstrcat(basepath, fl->pathname);
318 fd = sys_open(basepath, O_RDONLY|O_NOFOLLOW, 0);
320 fd = sys_open(basepath, O_RDONLY, 0);
324 d_fprintf(stderr, "info_fn: unable to open %s. %s\n",
325 basepath, strerror(errno) );
330 if (sys_fstat(fd, &sbuf) != 0) {
331 d_fprintf(stderr, "info_fn: can't fstat file %s. Error was %s\n",
332 basepath, strerror(errno) );
337 if (!S_ISREG(sbuf.st_mode)) {
338 d_fprintf(stderr, "info_fn: file %s is not a regular file. Ignoring.\n",
344 lines = fd_lines_load(fd, &numlines, 10240);
351 /* Ensure it's well formed. */
352 us_err = parse_usershare_file(ctx, &sbuf, fl->pathname, -1, lines, numlines,
358 file_lines_free(lines);
360 if (us_err != USERSHARE_OK) {
361 d_fprintf(stderr, "info_fn: file %s is not a well formed usershare file.\n",
363 d_fprintf(stderr, "info_fn: Error was %s.\n",
364 get_us_error_code(us_err) );
368 pstrcpy(acl_str, "usershare_acl=");
370 for (num_aces = 0; num_aces < psd->dacl->num_aces; num_aces++) {
375 ntstatus = net_lookup_name_from_sid(ctx, &psd->dacl->ace[num_aces].trustee, &domain, &name);
377 if (NT_STATUS_IS_OK(ntstatus)) {
378 if (domain && *domain) {
379 pstrcat(acl_str, domain);
380 pstrcat(acl_str, sep_str);
382 pstrcat(acl_str,name);
385 sid_to_string(sidstr, &psd->dacl->ace[num_aces].trustee);
386 pstrcat(acl_str,sidstr);
388 pstrcat(acl_str, ":");
390 if (psd->dacl->ace[num_aces].type == SEC_ACE_TYPE_ACCESS_DENIED) {
391 pstrcat(acl_str, "D,");
393 if (psd->dacl->ace[num_aces].info.mask & GENERIC_ALL_ACCESS) {
394 pstrcat(acl_str, "F,");
396 pstrcat(acl_str, "R,");
401 acl_str[strlen(acl_str)-1] = '\0';
403 if (pi->op == US_INFO_OP) {
404 d_printf("[%s]\n", fl->pathname );
405 d_printf("path=%s\n", sharepath );
406 d_printf("comment=%s\n", comment);
407 d_printf("%s\n", acl_str);
408 d_printf("guest_ok=%c\n\n", guest_ok ? 'y' : 'n');
409 } else if (pi->op == US_LIST_OP) {
410 d_printf("%s\n", fl->pathname);
416 /***************************************************************************
417 Print out info (internal detail) on userlevel shares.
418 ***************************************************************************/
420 static int net_usershare_info(int argc, const char **argv)
423 BOOL only_ours = True;
425 struct us_priv_info pi;
430 if (opt_long_list_entries) {
438 fstrcpy(wcard, argv[0]);
441 return net_usershare_info_usage(argc, argv);
446 ctx = talloc_init("share_info");
447 ret = get_share_list(ctx, wcard, only_ours);
455 ret = process_share_list(info_fn, &pi);
460 /***************************************************************************
461 Count the current total number of usershares.
462 ***************************************************************************/
464 static int count_num_usershares(void)
467 SMB_STRUCT_DIRENT *de;
469 int num_usershares = 0;
471 get_basepath(basepath);
472 dp = sys_opendir(basepath);
474 d_fprintf(stderr, "count_num_usershares: cannot open usershare directory %s. Error %s\n",
475 basepath, strerror(errno) );
479 while((de = sys_readdir(dp)) != 0) {
480 SMB_STRUCT_STAT sbuf;
482 const char *n = de->d_name;
484 /* Ignore . and .. */
486 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
491 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
492 d_fprintf(stderr, "count_num_usershares: ignoring bad share name %s\n",n);
495 pstrcpy(path, basepath);
499 if (sys_lstat(path, &sbuf) != 0) {
500 d_fprintf(stderr, "count_num_usershares: can't lstat file %s. Error was %s\n",
501 path, strerror(errno) );
505 if (!S_ISREG(sbuf.st_mode)) {
506 d_fprintf(stderr, "count_num_usershares: file %s is not a regular file. Ignoring.\n",
514 return num_usershares;
517 /***************************************************************************
518 Add a single userlevel share.
519 ***************************************************************************/
521 static int net_usershare_add(int argc, const char **argv)
523 TALLOC_CTX *ctx = NULL;
524 SMB_STRUCT_STAT sbuf;
525 SMB_STRUCT_STAT lsbuf;
528 pstring full_path_tmp;
530 const char *us_comment;
539 uid_t myeuid = geteuid();
540 BOOL guest_ok = False;
544 arg_acl = "S-1-1-0:R";
550 return net_usershare_add_usage(argc, argv);
552 sharename = strdup_lower(argv[0]);
556 sharename = strdup_lower(argv[0]);
558 us_comment = argv[2];
561 sharename = strdup_lower(argv[0]);
563 us_comment = argv[2];
567 sharename = strdup_lower(argv[0]);
569 us_comment = argv[2];
571 if (!strnequal(argv[4], "guest_ok=", 9)) {
572 return net_usershare_add_usage(argc, argv);
574 switch (argv[4][9]) {
584 return net_usershare_add_usage(argc, argv);
589 /* Ensure we're under the "usershare max shares" number. Advisory only. */
590 num_usershares = count_num_usershares();
591 if (num_usershares > lp_usershare_max_shares()) {
592 d_fprintf(stderr, "net usershare add: too many usershares already defined (%d), "
593 "maximum number allowed is %d.\n",
594 num_usershares, lp_usershare_max_shares() );
595 SAFE_FREE(sharename);
599 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
600 d_fprintf(stderr, "net usershare add: share name %s contains "
601 "invalid characters (any of %s)\n",
602 sharename, INVALID_SHARENAME_CHARS);
603 SAFE_FREE(sharename);
607 /* Disallow shares the same as users. */
608 if (getpwnam(sharename)) {
609 d_fprintf(stderr, "net usershare add: share name %s is already a valid system user name\n",
611 SAFE_FREE(sharename);
615 /* Construct the full path for the usershare file. */
616 get_basepath(full_path);
617 pstrcat(full_path, "/");
618 pstrcpy(full_path_tmp, full_path);
619 pstrcat(full_path, sharename);
620 pstrcat(full_path_tmp, ":tmpXXXXXX");
622 /* The path *must* be absolute. */
623 if (us_path[0] != '/') {
624 d_fprintf(stderr,"net usershare add: path %s is not an absolute path.\n",
626 SAFE_FREE(sharename);
630 /* Check the directory to be shared exists. */
631 if (sys_stat(us_path, &sbuf) != 0) {
632 d_fprintf(stderr, "net usershare add: cannot stat path %s to ensure "
633 "this is a directory. Error was %s\n",
634 us_path, strerror(errno) );
635 SAFE_FREE(sharename);
639 if (!S_ISDIR(sbuf.st_mode)) {
640 d_fprintf(stderr, "net usershare add: path %s is not a directory.\n",
642 SAFE_FREE(sharename);
646 /* If we're not root, check if we're restricted to sharing out directories
649 if ((myeuid != 0) && lp_usershare_owner_only() && (myeuid != sbuf.st_uid)) {
650 d_fprintf(stderr, "net usershare add: cannot share path %s as "
651 "we are restricted to only sharing directories we own.\n"
652 "\tAsk the administrator to add the line \"usershare owner only = False\" \n"
653 "\tto the [global] section of the smb.conf to allow this.\n",
655 SAFE_FREE(sharename);
659 /* No validation needed on comment. Now go through and validate the
660 acl string. Convert names to SID's as needed. Then run it through
661 parse_usershare_acl to ensure it's valid. */
663 ctx = talloc_init("share_info");
665 /* Start off the string we'll append to. */
666 us_acl = talloc_strdup(ctx, "");
671 /* Add the number of ',' characters to get the number of aces. */
672 num_aces += count_chars(pacl,',');
674 for (i = 0; i < num_aces; i++) {
676 const char *pcolon = strchr_m(pacl, ':');
679 if (pcolon == NULL) {
680 d_fprintf(stderr, "net usershare add: malformed acl %s (missing ':').\n",
683 SAFE_FREE(sharename);
695 d_fprintf(stderr, "net usershare add: malformed acl %s "
696 "(access control must be 'r', 'f', or 'd')\n",
699 SAFE_FREE(sharename);
703 if (pcolon[2] != ',' && pcolon[2] != '\0') {
704 d_fprintf(stderr, "net usershare add: malformed terminating character for acl %s\n",
707 SAFE_FREE(sharename);
712 if ((name = talloc_strndup(ctx, pacl, pcolon - pacl)) == NULL) {
713 d_fprintf(stderr, "talloc_strndup failed\n");
715 SAFE_FREE(sharename);
718 if (!string_to_sid(&sid, name)) {
719 /* Convert to a SID */
720 NTSTATUS ntstatus = net_lookup_sid_from_name(ctx, name, &sid);
721 if (!NT_STATUS_IS_OK(ntstatus)) {
722 d_fprintf(stderr, "net usershare add: cannot convert name \"%s\" to a SID. %s.",
723 name, get_friendly_nt_error_msg(ntstatus) );
724 if (NT_STATUS_EQUAL(ntstatus, NT_STATUS_CONNECTION_REFUSED)) {
725 d_fprintf(stderr, " Maybe smbd is not running.\n");
727 d_fprintf(stderr, "\n");
730 SAFE_FREE(sharename);
734 us_acl = talloc_asprintf_append(us_acl, "%s:%c,", sid_string_static(&sid), pcolon[1]);
736 /* Move to the next ACL entry. */
737 if (pcolon[2] == ',') {
742 /* Remove the last ',' */
743 us_acl[strlen(us_acl)-1] = '\0';
745 if (guest_ok && !lp_usershare_allow_guests()) {
746 d_fprintf(stderr, "net usershare add: guest_ok=y requested "
747 "but the \"usershare allow guests\" parameter is not enabled "
748 "by this server.\n");
750 SAFE_FREE(sharename);
754 /* Create a temporary filename for this share. */
755 tmpfd = smb_mkstemp(full_path_tmp);
758 d_fprintf(stderr, "net usershare add: cannot create tmp file %s\n",
761 SAFE_FREE(sharename);
765 /* Ensure we opened the file we thought we did. */
766 if (sys_lstat(full_path_tmp, &lsbuf) != 0) {
767 d_fprintf(stderr, "net usershare add: cannot lstat tmp file %s\n",
770 SAFE_FREE(sharename);
774 /* Check this is the same as the file we opened. */
775 if (sys_fstat(tmpfd, &sbuf) != 0) {
776 d_fprintf(stderr, "net usershare add: cannot fstat tmp file %s\n",
779 SAFE_FREE(sharename);
783 if (!S_ISREG(sbuf.st_mode) || sbuf.st_dev != lsbuf.st_dev || sbuf.st_ino != lsbuf.st_ino) {
784 d_fprintf(stderr, "net usershare add: tmp file %s is not a regular file ?\n",
787 SAFE_FREE(sharename);
791 if (fchmod(tmpfd, 0644) == -1) {
792 d_fprintf(stderr, "net usershare add: failed to fchmod tmp file %s to 0644n",
795 SAFE_FREE(sharename);
799 /* Create the in-memory image of the file. */
800 file_img = talloc_strdup(ctx, "#VERSION 2\npath=");
801 file_img = talloc_asprintf_append(file_img, "%s\ncomment=%s\nusershare_acl=%s\nguest_ok=%c\n",
802 us_path, us_comment, us_acl, guest_ok ? 'y' : 'n');
804 to_write = strlen(file_img);
806 if (write(tmpfd, file_img, to_write) != to_write) {
807 d_fprintf(stderr, "net usershare add: failed to write %u bytes to file %s. Error was %s\n",
808 (unsigned int)to_write, full_path_tmp, strerror(errno));
809 unlink(full_path_tmp);
811 SAFE_FREE(sharename);
815 /* Attempt to replace any existing share by this name. */
816 if (rename(full_path_tmp, full_path) != 0) {
817 unlink(full_path_tmp);
818 d_fprintf(stderr, "net usershare add: failed to add share %s. Error was %s\n",
819 sharename, strerror(errno));
822 SAFE_FREE(sharename);
829 if (opt_long_list_entries) {
830 const char *my_argv[2];
831 my_argv[0] = sharename;
833 net_usershare_info(1, my_argv);
836 SAFE_FREE(sharename);
841 /***************************************************************************
843 ***************************************************************************/
845 static int list_fn(struct file_list *fl, void *priv)
847 d_printf("%s\n", fl->pathname);
852 /***************************************************************************
853 List userlevel shares.
854 ***************************************************************************/
856 static int net_usershare_list(int argc, const char **argv)
859 BOOL only_ours = True;
861 struct us_priv_info pi;
866 if (opt_long_list_entries) {
874 fstrcpy(wcard, argv[0]);
877 return net_usershare_list_usage(argc, argv);
882 ctx = talloc_init("share_list");
883 ret = get_share_list(ctx, wcard, only_ours);
891 ret = process_share_list(info_fn, &pi);
896 /***************************************************************************
897 Handle "net usershare help *" subcommands.
898 ***************************************************************************/
900 int net_usershare_help(int argc, const char **argv)
902 struct functable func[] = {
903 {"ADD", net_usershare_add_usage},
904 {"DELETE", net_usershare_delete_usage},
905 {"INFO", net_usershare_info_usage},
906 {"LIST", net_usershare_list_usage},
909 return net_run_function(argc, argv, func, net_usershare_usage);
912 /***************************************************************************
913 Entry-point for all the USERSHARE functions.
914 ***************************************************************************/
916 int net_usershare(int argc, const char **argv)
920 struct functable func[] = {
921 {"ADD", net_usershare_add},
922 {"DELETE", net_usershare_delete},
923 {"INFO", net_usershare_info},
924 {"LIST", net_usershare_list},
925 {"HELP", net_usershare_help},
929 if (lp_usershare_max_shares() == 0) {
930 d_fprintf(stderr, "net usershare: usershares are currently disabled\n");
934 dp = sys_opendir(lp_usershare_path());
937 d_fprintf(stderr, "net usershare: cannot open usershare directory %s. Error %s\n",
938 lp_usershare_path(), strerror(err) );
940 d_fprintf(stderr, "You do not have permission to create a usershare. Ask your "
941 "administrator to grant you permissions to create a share.\n");
942 } else if (err == ENOENT) {
943 d_fprintf(stderr, "Please ask your system administrator to "
944 "enable user sharing.\n");
950 return net_run_function(argc, argv, func, net_usershare_usage);