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 3 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, see <http://www.gnu.org/licenses/>.
22 #include "utils/net.h"
25 const char *us_errstr;
26 enum usershare_err us_err;
29 {N_("Malformed usershare file"), USERSHARE_MALFORMED_FILE},
30 {N_("Bad version number"), USERSHARE_BAD_VERSION},
31 {N_("Malformed path entry"), USERSHARE_MALFORMED_PATH},
32 {N_("Malformed comment entryfile"), USERSHARE_MALFORMED_COMMENT_DEF},
33 {N_("Malformed acl definition"), USERSHARE_MALFORMED_ACL_DEF},
34 {N_("Acl parse error"), USERSHARE_ACL_ERR},
35 {N_("Path not absolute"), USERSHARE_PATH_NOT_ABSOLUTE},
36 {N_("Path is denied"), USERSHARE_PATH_IS_DENIED},
37 {N_("Path not allowed"), USERSHARE_PATH_NOT_ALLOWED},
38 {N_("Path is not a directory"), USERSHARE_PATH_NOT_DIRECTORY},
39 {N_("System error"), USERSHARE_POSIX_ERR},
40 {N_("Malformed sharename definition"), USERSHARE_MALFORMED_SHARENAME_DEF},
41 {N_("Bad sharename (doesn't match filename)"), USERSHARE_BAD_SHARENAME},
42 {NULL,(enum usershare_err)-1}
45 static const char *get_us_error_code(enum usershare_err us_err)
50 while (us_errs[idx].us_errstr != NULL) {
51 if (us_errs[idx].us_err == us_err) {
52 return us_errs[idx].us_errstr;
57 result = talloc_asprintf(talloc_tos(), _("Usershare error code (0x%x)"),
58 (unsigned int)us_err);
59 SMB_ASSERT(result != NULL);
63 /* The help subsystem for the USERSHARE subcommand */
65 static int net_usershare_add_usage(struct net_context *c, int argc, const char **argv)
67 char chr = *lp_winbind_separator();
69 "net usershare add [-l|--long] <sharename> <path> [<comment>] [<acl>] [<guest_ok=[y|n]>]\n"
70 "\tAdds the specified share name for this user.\n"
71 "\t<sharename> is the new share name.\n"
72 "\t<path> is the path on the filesystem to export.\n"
73 "\t<comment> is the optional comment for the new share.\n"
74 "\t<acl> is an optional share acl in the format \"DOMAIN%cname:X,DOMAIN%cname:X,....\"\n"
75 "\t<guest_ok=y> if present sets \"guest ok = yes\" on this usershare.\n"
76 "\t\t\"X\" represents a permission and can be any one of the characters f, r or d\n"
77 "\t\twhere \"f\" means full control, \"r\" means read-only, \"d\" means deny access.\n"
78 "\t\tname may be a domain user or group. For local users use the local server name "
79 "instead of \"DOMAIN\"\n"
80 "\t\tThe default acl is \"Everyone:r\" which allows everyone read-only access.\n"
81 "\tAdd -l or --long to print the info on the newly added share.\n"),
86 static int net_usershare_delete_usage(struct net_context *c, int argc, const char **argv)
89 "net usershare delete <sharename>\n"
90 "\tdeletes the specified share name for this user.\n"));
94 static int net_usershare_info_usage(struct net_context *c, int argc, const char **argv)
97 "net usershare info [-l|--long] [wildcard sharename]\n"
98 "\tPrints out the path, comment and acl elements of shares that match the wildcard.\n"
99 "\tBy default only gives info on shares owned by the current user\n"
100 "\tAdd -l or --long to apply this to all shares\n"
101 "\tOmit the sharename or use a wildcard of '*' to see all shares\n"));
105 static int net_usershare_list_usage(struct net_context *c, int argc, const char **argv)
108 "net usershare list [-l|--long] [wildcard sharename]\n"
109 "\tLists the names of all shares that match the wildcard.\n"
110 "\tBy default only lists shares owned by the current user\n"
111 "\tAdd -l or --long to apply this to all shares\n"
112 "\tOmit the sharename or use a wildcard of '*' to see all shares\n"));
116 int net_usershare_usage(struct net_context *c, int argc, const char **argv)
118 d_printf(_("net usershare add <sharename> <path> [<comment>] [<acl>] [<guest_ok=[y|n]>] to "
119 "add or change a user defined share.\n"
120 "net usershare delete <sharename> to delete a user defined share.\n"
121 "net usershare info [-l|--long] [wildcard sharename] to print info about a user defined share.\n"
122 "net usershare list [-l|--long] [wildcard sharename] to list user defined shares.\n"
123 "net usershare help\n"
124 "\nType \"net usershare help <option>\" to get more information on that option\n\n"));
126 net_common_flags_usage(c, argc, argv);
130 /***************************************************************************
131 ***************************************************************************/
133 static char *get_basepath(TALLOC_CTX *ctx)
135 char *basepath = talloc_strdup(ctx, lp_usershare_path());
140 if ((basepath[0] != '\0') && (basepath[strlen(basepath)-1] == '/')) {
141 basepath[strlen(basepath)-1] = '\0';
146 /***************************************************************************
147 Delete a single userlevel share.
148 ***************************************************************************/
150 static int net_usershare_delete(struct net_context *c, int argc, const char **argv)
155 if (argc != 1 || c->display_usage) {
156 return net_usershare_delete_usage(c, argc, argv);
159 if ((sharename = strlower_talloc(talloc_tos(), argv[0])) == NULL) {
160 d_fprintf(stderr, _("strlower_talloc failed\n"));
164 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
165 d_fprintf(stderr, _("net usershare delete: share name %s contains "
166 "invalid characters (any of %s)\n"),
167 sharename, INVALID_SHARENAME_CHARS);
168 TALLOC_FREE(sharename);
172 us_path = talloc_asprintf(talloc_tos(),
177 TALLOC_FREE(sharename);
181 if (unlink(us_path) != 0) {
182 d_fprintf(stderr, _("net usershare delete: unable to remove usershare %s. "
184 us_path, strerror(errno));
185 TALLOC_FREE(sharename);
188 TALLOC_FREE(sharename);
192 /***************************************************************************
193 Data structures to handle a list of usershare files.
194 ***************************************************************************/
197 struct file_list *next, *prev;
198 const char *pathname;
201 static struct file_list *flist;
203 /***************************************************************************
204 ***************************************************************************/
206 static int get_share_list(TALLOC_CTX *ctx, const char *wcard, bool only_ours)
209 SMB_STRUCT_DIRENT *de;
210 uid_t myuid = geteuid();
211 struct file_list *fl = NULL;
212 char *basepath = get_basepath(ctx);
217 dp = sys_opendir(basepath);
220 _("get_share_list: cannot open usershare directory %s. "
222 basepath, strerror(errno) );
226 while((de = sys_readdir(dp)) != 0) {
227 SMB_STRUCT_STAT sbuf;
229 const char *n = de->d_name;
231 /* Ignore . and .. */
233 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
238 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
240 _("get_share_list: ignoring bad share "
244 path = talloc_asprintf(ctx,
253 if (sys_lstat(path, &sbuf, false) != 0) {
255 _("get_share_list: can't lstat file %s. Error "
257 path, strerror(errno) );
261 if (!S_ISREG(sbuf.st_ex_mode)) {
263 _("get_share_list: file %s is not a regular "
264 "file. Ignoring.\n"),
269 if (only_ours && sbuf.st_ex_uid != myuid) {
273 if (!unix_wild_match(wcard, n)) {
277 /* (Finally) - add to list. */
278 fl = TALLOC_P(ctx, struct file_list);
283 fl->pathname = talloc_strdup(ctx, n);
289 DLIST_ADD(flist, fl);
296 enum us_priv_op { US_LIST_OP, US_INFO_OP};
298 struct us_priv_info {
301 struct net_context *c;
304 /***************************************************************************
305 Call a function for every share on the list.
306 ***************************************************************************/
308 static int process_share_list(int (*fn)(struct file_list *, void *), void *priv)
310 struct file_list *fl;
313 for (fl = flist; fl; fl = fl->next) {
314 ret = (*fn)(fl, priv);
320 /***************************************************************************
322 ***************************************************************************/
324 static int info_fn(struct file_list *fl, void *priv)
326 SMB_STRUCT_STAT sbuf;
328 struct us_priv_info *pi = (struct us_priv_info *)priv;
329 TALLOC_CTX *ctx = pi->ctx;
330 struct net_context *c = pi->c;
333 struct security_descriptor *psd = NULL;
335 char *sharepath = NULL;
336 char *comment = NULL;
337 char *cp_sharename = NULL;
341 enum usershare_err us_err;
342 bool guest_ok = false;
344 sep_str[0] = *lp_winbind_separator();
347 basepath = get_basepath(ctx);
351 basepath = talloc_asprintf_append(basepath,
359 fd = sys_open(basepath, O_RDONLY|O_NOFOLLOW, 0);
361 fd = sys_open(basepath, O_RDONLY, 0);
365 d_fprintf(stderr, _("info_fn: unable to open %s. %s\n"),
366 basepath, strerror(errno) );
371 if (sys_fstat(fd, &sbuf, false) != 0) {
373 _("info_fn: can't fstat file %s. Error was %s\n"),
374 basepath, strerror(errno) );
379 if (!S_ISREG(sbuf.st_ex_mode)) {
381 _("info_fn: file %s is not a regular file. Ignoring.\n"),
387 lines = fd_lines_load(fd, &numlines, 10240, NULL);
394 /* Ensure it's well formed. */
395 us_err = parse_usershare_file(ctx, &sbuf, fl->pathname, -1, lines, numlines,
404 if (us_err != USERSHARE_OK) {
406 _("info_fn: file %s is not a well formed usershare "
409 d_fprintf(stderr, _("info_fn: Error was %s.\n"),
410 get_us_error_code(us_err) );
414 acl_str = talloc_strdup(ctx, "usershare_acl=");
419 for (num_aces = 0; num_aces < psd->dacl->num_aces; num_aces++) {
424 ntstatus = net_lookup_name_from_sid(c, ctx,
425 &psd->dacl->aces[num_aces].trustee,
428 if (NT_STATUS_IS_OK(ntstatus)) {
429 if (domain && *domain) {
430 acl_str = talloc_asprintf_append(acl_str,
438 acl_str = talloc_asprintf_append(acl_str,
447 sid_to_fstring(sidstr,
448 &psd->dacl->aces[num_aces].trustee);
449 acl_str = talloc_asprintf_append(acl_str,
456 acl_str = talloc_asprintf_append(acl_str, ":");
461 if (psd->dacl->aces[num_aces].type == SEC_ACE_TYPE_ACCESS_DENIED) {
462 acl_str = talloc_asprintf_append(acl_str, "D,");
467 if (psd->dacl->aces[num_aces].access_mask & GENERIC_ALL_ACCESS) {
468 acl_str = talloc_asprintf_append(acl_str, "F,");
470 acl_str = talloc_asprintf_append(acl_str, "R,");
478 /* NOTE: This is smb.conf-like output. Do not translate. */
479 if (pi->op == US_INFO_OP) {
480 d_printf("[%s]\n", cp_sharename );
481 d_printf("path=%s\n", sharepath );
482 d_printf("comment=%s\n", comment);
483 d_printf("%s\n", acl_str);
484 d_printf("guest_ok=%c\n\n", guest_ok ? 'y' : 'n');
485 } else if (pi->op == US_LIST_OP) {
486 d_printf("%s\n", cp_sharename);
492 /***************************************************************************
493 Print out info (internal detail) on userlevel shares.
494 ***************************************************************************/
496 static int net_usershare_info(struct net_context *c, int argc, const char **argv)
499 bool only_ours = true;
501 struct us_priv_info pi;
506 if (c->display_usage)
507 return net_usershare_info_usage(c, argc, argv);
509 if (c->opt_long_list_entries) {
517 fstrcpy(wcard, argv[0]);
520 return net_usershare_info_usage(c, argc, argv);
525 ctx = talloc_init("share_info");
526 ret = get_share_list(ctx, wcard, only_ours);
535 ret = process_share_list(info_fn, &pi);
540 /***************************************************************************
541 Count the current total number of usershares.
542 ***************************************************************************/
544 static int count_num_usershares(void)
547 SMB_STRUCT_DIRENT *de;
548 int num_usershares = 0;
549 TALLOC_CTX *ctx = talloc_tos();
550 char *basepath = get_basepath(ctx);
556 dp = sys_opendir(basepath);
559 _("count_num_usershares: cannot open usershare "
560 "directory %s. Error %s\n"),
561 basepath, strerror(errno) );
565 while((de = sys_readdir(dp)) != 0) {
566 SMB_STRUCT_STAT sbuf;
568 const char *n = de->d_name;
570 /* Ignore . and .. */
572 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
577 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
579 _("count_num_usershares: ignoring bad share "
583 path = talloc_asprintf(ctx,
592 if (sys_lstat(path, &sbuf, false) != 0) {
594 _("count_num_usershares: can't lstat file %s. "
596 path, strerror(errno) );
600 if (!S_ISREG(sbuf.st_ex_mode)) {
602 _("count_num_usershares: file %s is not a "
603 "regular file. Ignoring.\n"),
611 return num_usershares;
614 /***************************************************************************
615 Add a single userlevel share.
616 ***************************************************************************/
618 static int net_usershare_add(struct net_context *c, int argc, const char **argv)
620 TALLOC_CTX *ctx = talloc_stackframe();
621 SMB_STRUCT_STAT sbuf;
622 SMB_STRUCT_STAT lsbuf;
624 const char *cp_sharename;
628 const char *us_comment;
637 uid_t myeuid = geteuid();
638 bool guest_ok = false;
642 arg_acl = "S-1-1-0:R";
644 if (c->display_usage)
645 return net_usershare_add_usage(c, argc, argv);
651 return net_usershare_add_usage(c, argc, argv);
653 cp_sharename = argv[0];
654 sharename = strlower_talloc(ctx, argv[0]);
658 cp_sharename = argv[0];
659 sharename = strlower_talloc(ctx, argv[0]);
661 us_comment = argv[2];
664 cp_sharename = argv[0];
665 sharename = strlower_talloc(ctx, argv[0]);
667 us_comment = argv[2];
671 cp_sharename = argv[0];
672 sharename = strlower_talloc(ctx, argv[0]);
674 us_comment = argv[2];
676 if (strlen(arg_acl) == 0) {
677 arg_acl = "S-1-1-0:R";
679 if (!strnequal(argv[4], "guest_ok=", 9)) {
681 return net_usershare_add_usage(c, argc, argv);
683 switch (argv[4][9]) {
694 return net_usershare_add_usage(c, argc, argv);
699 /* Ensure we're under the "usershare max shares" number. Advisory only. */
700 num_usershares = count_num_usershares();
701 if (num_usershares >= lp_usershare_max_shares()) {
703 _("net usershare add: maximum number of allowed "
704 "usershares (%d) reached\n"),
705 lp_usershare_max_shares() );
710 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
711 d_fprintf(stderr, _("net usershare add: share name %s contains "
712 "invalid characters (any of %s)\n"),
713 sharename, INVALID_SHARENAME_CHARS);
718 /* Disallow shares the same as users. */
719 if (getpwnam(sharename)) {
721 _("net usershare add: share name %s is already a valid "
722 "system user name\n"),
728 /* Construct the full path for the usershare file. */
729 full_path = get_basepath(ctx);
734 full_path_tmp = talloc_asprintf(ctx,
737 if (!full_path_tmp) {
742 full_path = talloc_asprintf_append(full_path,
750 /* The path *must* be absolute. */
751 if (us_path[0] != '/') {
753 _("net usershare add: path %s is not an absolute "
760 /* Check the directory to be shared exists. */
761 if (sys_stat(us_path, &sbuf, false) != 0) {
763 _("net usershare add: cannot stat path %s to ensure "
764 "this is a directory. Error was %s\n"),
765 us_path, strerror(errno) );
770 if (!S_ISDIR(sbuf.st_ex_mode)) {
772 _("net usershare add: path %s is not a directory.\n"),
778 /* If we're not root, check if we're restricted to sharing out directories
781 if ((myeuid != 0) && lp_usershare_owner_only() && (myeuid != sbuf.st_ex_uid)) {
782 d_fprintf(stderr, _("net usershare add: cannot share path %s as "
783 "we are restricted to only sharing directories we own.\n"
784 "\tAsk the administrator to add the line \"usershare owner only = false\" \n"
785 "\tto the [global] section of the smb.conf to allow this.\n"),
791 /* No validation needed on comment. Now go through and validate the
792 acl string. Convert names to SID's as needed. Then run it through
793 parse_usershare_acl to ensure it's valid. */
795 /* Start off the string we'll append to. */
796 us_acl = talloc_strdup(ctx, "");
805 /* Add the number of ',' characters to get the number of aces. */
806 num_aces += count_chars(pacl,',');
808 for (i = 0; i < num_aces; i++) {
810 const char *pcolon = strchr_m(pacl, ':');
813 if (pcolon == NULL) {
815 _("net usershare add: malformed acl %s "
831 _("net usershare add: malformed acl %s "
832 "(access control must be 'r', 'f', "
839 if (pcolon[2] != ',' && pcolon[2] != '\0') {
841 _("net usershare add: malformed terminating "
842 "character for acl %s\n"),
849 if ((name = talloc_strndup(ctx, pacl, pcolon - pacl)) == NULL) {
850 d_fprintf(stderr, _("talloc_strndup failed\n"));
854 if (!string_to_sid(&sid, name)) {
855 /* Convert to a SID */
856 NTSTATUS ntstatus = net_lookup_sid_from_name(c, ctx, name, &sid);
857 if (!NT_STATUS_IS_OK(ntstatus)) {
859 _("net usershare add: cannot convert "
860 "name \"%s\" to a SID. %s."),
861 name, get_friendly_nt_error_msg(ntstatus) );
862 if (NT_STATUS_EQUAL(ntstatus, NT_STATUS_CONNECTION_REFUSED)) {
864 _(" Maybe smbd is not running.\n"));
866 d_fprintf(stderr, "\n");
872 us_acl = talloc_asprintf_append(
873 us_acl, "%s:%c,", sid_string_tos(&sid), pcolon[1]);
875 /* Move to the next ACL entry. */
876 if (pcolon[2] == ',') {
881 /* Remove the last ',' */
882 us_acl[strlen(us_acl)-1] = '\0';
884 if (guest_ok && !lp_usershare_allow_guests()) {
885 d_fprintf(stderr, _("net usershare add: guest_ok=y requested "
886 "but the \"usershare allow guests\" parameter is not "
887 "enabled by this server.\n"));
892 /* Create a temporary filename for this share. */
893 tmpfd = mkstemp(full_path_tmp);
897 _("net usershare add: cannot create tmp file %s\n"),
903 /* Ensure we opened the file we thought we did. */
904 if (sys_lstat(full_path_tmp, &lsbuf, false) != 0) {
906 _("net usershare add: cannot lstat tmp file %s\n"),
912 /* Check this is the same as the file we opened. */
913 if (sys_fstat(tmpfd, &sbuf, false) != 0) {
915 _("net usershare add: cannot fstat tmp file %s\n"),
921 if (!S_ISREG(sbuf.st_ex_mode) || sbuf.st_ex_dev != lsbuf.st_ex_dev || sbuf.st_ex_ino != lsbuf.st_ex_ino) {
923 _("net usershare add: tmp file %s is not a regular "
930 if (fchmod(tmpfd, 0644) == -1) {
932 _("net usershare add: failed to fchmod tmp file %s "
939 /* Create the in-memory image of the file. */
940 file_img = talloc_strdup(ctx, "#VERSION 2\npath=");
941 file_img = talloc_asprintf_append(file_img,
942 "%s\ncomment=%s\nusershare_acl=%s\n"
943 "guest_ok=%c\nsharename=%s\n",
947 guest_ok ? 'y' : 'n',
950 to_write = strlen(file_img);
952 if (write(tmpfd, file_img, to_write) != to_write) {
954 _("net usershare add: failed to write %u bytes to "
955 "file %s. Error was %s\n"),
956 (unsigned int)to_write, full_path_tmp, strerror(errno));
957 unlink(full_path_tmp);
962 /* Attempt to replace any existing share by this name. */
963 if (rename(full_path_tmp, full_path) != 0) {
964 unlink(full_path_tmp);
966 _("net usershare add: failed to add share %s. Error "
968 sharename, strerror(errno));
976 if (c->opt_long_list_entries) {
977 const char *my_argv[2];
978 my_argv[0] = sharename;
980 net_usershare_info(c, 1, my_argv);
988 /***************************************************************************
990 ***************************************************************************/
992 static int list_fn(struct file_list *fl, void *priv)
994 d_printf("%s\n", fl->pathname);
999 /***************************************************************************
1000 List userlevel shares.
1001 ***************************************************************************/
1003 static int net_usershare_list(struct net_context *c, int argc,
1007 bool only_ours = true;
1009 struct us_priv_info pi;
1012 fstrcpy(wcard, "*");
1014 if (c->display_usage)
1015 return net_usershare_list_usage(c, argc, argv);
1017 if (c->opt_long_list_entries) {
1025 fstrcpy(wcard, argv[0]);
1028 return net_usershare_list_usage(c, argc, argv);
1033 ctx = talloc_init("share_list");
1034 ret = get_share_list(ctx, wcard, only_ours);
1043 ret = process_share_list(info_fn, &pi);
1044 talloc_destroy(ctx);
1048 /***************************************************************************
1049 Entry-point for all the USERSHARE functions.
1050 ***************************************************************************/
1052 int net_usershare(struct net_context *c, int argc, const char **argv)
1056 struct functable func[] = {
1060 NET_TRANSPORT_LOCAL,
1061 N_("Add/modify user defined share"),
1062 N_("net usershare add\n"
1063 " Add/modify user defined share")
1067 net_usershare_delete,
1068 NET_TRANSPORT_LOCAL,
1069 N_("Delete user defined share"),
1070 N_("net usershare delete\n"
1071 " Delete user defined share")
1076 NET_TRANSPORT_LOCAL,
1077 N_("Display information about a user defined share"),
1078 N_("net usershare info\n"
1079 " Display information about a user defined share")
1084 NET_TRANSPORT_LOCAL,
1085 N_("List user defined shares"),
1086 N_("net usershare list\n"
1087 " List user defined shares")
1089 {NULL, NULL, 0, NULL, NULL}
1092 if (lp_usershare_max_shares() == 0) {
1094 _("net usershare: usershares are currently "
1099 dp = sys_opendir(lp_usershare_path());
1103 _("net usershare: cannot open usershare directory %s. "
1105 lp_usershare_path(), strerror(err) );
1106 if (err == EACCES) {
1108 _("You do not have permission to create a "
1109 "usershare. Ask your administrator to grant "
1110 "you permissions to create a share.\n"));
1111 } else if (err == ENOENT) {
1113 _("Please ask your system administrator to "
1114 "enable user sharing.\n"));
1120 return net_run_function(c, argc, argv, "net usershare", func);