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 {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 result = talloc_asprintf(talloc_tos(), _("Usershare error code (0x%x)"),
56 (unsigned int)us_err);
57 SMB_ASSERT(result != NULL);
61 /* The help subsystem for the USERSHARE subcommand */
63 static int net_usershare_add_usage(struct net_context *c, int argc, const char **argv)
65 char chr = *lp_winbind_separator();
67 "net usershare add [-l|--long] <sharename> <path> [<comment>] [<acl>] [<guest_ok=[y|n]>]\n"
68 "\tAdds the specified share name for this user.\n"
69 "\t<sharename> is the new share name.\n"
70 "\t<path> is the path on the filesystem to export.\n"
71 "\t<comment> is the optional comment for the new share.\n"
72 "\t<acl> is an optional share acl in the format \"DOMAIN%cname:X,DOMAIN%cname:X,....\"\n"
73 "\t<guest_ok=y> if present sets \"guest ok = yes\" on this usershare.\n"
74 "\t\t\"X\" represents a permission and can be any one of the characters f, r or d\n"
75 "\t\twhere \"f\" means full control, \"r\" means read-only, \"d\" means deny access.\n"
76 "\t\tname may be a domain user or group. For local users use the local server name "
77 "instead of \"DOMAIN\"\n"
78 "\t\tThe default acl is \"Everyone:r\" which allows everyone read-only access.\n"
79 "\tAdd -l or --long to print the info on the newly added share.\n"),
84 static int net_usershare_delete_usage(struct net_context *c, int argc, const char **argv)
87 "net usershare delete <sharename>\n"
88 "\tdeletes the specified share name for this user.\n"));
92 static int net_usershare_info_usage(struct net_context *c, int argc, const char **argv)
95 "net usershare info [-l|--long] [wildcard sharename]\n"
96 "\tPrints out the path, comment and acl elements of shares that match the wildcard.\n"
97 "\tBy default only gives info on shares owned by the current user\n"
98 "\tAdd -l or --long to apply this to all shares\n"
99 "\tOmit the sharename or use a wildcard of '*' to see all shares\n"));
103 static int net_usershare_list_usage(struct net_context *c, int argc, const char **argv)
106 "net usershare list [-l|--long] [wildcard sharename]\n"
107 "\tLists the names of all shares that match the wildcard.\n"
108 "\tBy default only lists shares owned by the current user\n"
109 "\tAdd -l or --long to apply this to all shares\n"
110 "\tOmit the sharename or use a wildcard of '*' to see all shares\n"));
114 int net_usershare_usage(struct net_context *c, int argc, const char **argv)
116 d_printf(_("net usershare add <sharename> <path> [<comment>] [<acl>] [<guest_ok=[y|n]>] to "
117 "add or change a user defined share.\n"
118 "net usershare delete <sharename> to delete a user defined share.\n"
119 "net usershare info [-l|--long] [wildcard sharename] to print info about a user defined share.\n"
120 "net usershare list [-l|--long] [wildcard sharename] to list user defined shares.\n"
121 "net usershare help\n"
122 "\nType \"net usershare help <option>\" to get more information on that option\n\n"));
124 net_common_flags_usage(c, argc, argv);
128 /***************************************************************************
129 ***************************************************************************/
131 static char *get_basepath(TALLOC_CTX *ctx)
133 char *basepath = talloc_strdup(ctx, lp_usershare_path());
138 if ((basepath[0] != '\0') && (basepath[strlen(basepath)-1] == '/')) {
139 basepath[strlen(basepath)-1] = '\0';
144 /***************************************************************************
145 Delete a single userlevel share.
146 ***************************************************************************/
148 static int net_usershare_delete(struct net_context *c, int argc, const char **argv)
153 if (argc != 1 || c->display_usage) {
154 return net_usershare_delete_usage(c, argc, argv);
157 if ((sharename = strlower_talloc(talloc_tos(), argv[0])) == NULL) {
158 d_fprintf(stderr, _("strlower_talloc failed\n"));
162 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
163 d_fprintf(stderr, _("net usershare delete: share name %s contains "
164 "invalid characters (any of %s)\n"),
165 sharename, INVALID_SHARENAME_CHARS);
166 TALLOC_FREE(sharename);
170 us_path = talloc_asprintf(talloc_tos(),
175 TALLOC_FREE(sharename);
179 if (unlink(us_path) != 0) {
180 d_fprintf(stderr, _("net usershare delete: unable to remove usershare %s. "
182 us_path, strerror(errno));
183 TALLOC_FREE(sharename);
186 TALLOC_FREE(sharename);
190 /***************************************************************************
191 Data structures to handle a list of usershare files.
192 ***************************************************************************/
195 struct file_list *next, *prev;
196 const char *pathname;
199 static struct file_list *flist;
201 /***************************************************************************
202 ***************************************************************************/
204 static int get_share_list(TALLOC_CTX *ctx, const char *wcard, bool only_ours)
207 SMB_STRUCT_DIRENT *de;
208 uid_t myuid = geteuid();
209 struct file_list *fl = NULL;
210 char *basepath = get_basepath(ctx);
215 dp = sys_opendir(basepath);
218 _("get_share_list: cannot open usershare directory %s. "
220 basepath, strerror(errno) );
224 while((de = sys_readdir(dp)) != 0) {
225 SMB_STRUCT_STAT sbuf;
227 const char *n = de->d_name;
229 /* Ignore . and .. */
231 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
236 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
238 _("get_share_list: ignoring bad share "
242 path = talloc_asprintf(ctx,
251 if (sys_lstat(path, &sbuf, false) != 0) {
253 _("get_share_list: can't lstat file %s. Error "
255 path, strerror(errno) );
259 if (!S_ISREG(sbuf.st_ex_mode)) {
261 _("get_share_list: file %s is not a regular "
262 "file. Ignoring.\n"),
267 if (only_ours && sbuf.st_ex_uid != myuid) {
271 if (!unix_wild_match(wcard, n)) {
275 /* (Finally) - add to list. */
276 fl = TALLOC_P(ctx, struct file_list);
281 fl->pathname = talloc_strdup(ctx, n);
287 DLIST_ADD(flist, fl);
294 enum us_priv_op { US_LIST_OP, US_INFO_OP};
296 struct us_priv_info {
299 struct net_context *c;
302 /***************************************************************************
303 Call a function for every share on the list.
304 ***************************************************************************/
306 static int process_share_list(int (*fn)(struct file_list *, void *), void *priv)
308 struct file_list *fl;
311 for (fl = flist; fl; fl = fl->next) {
312 ret = (*fn)(fl, priv);
318 /***************************************************************************
320 ***************************************************************************/
322 static int info_fn(struct file_list *fl, void *priv)
324 SMB_STRUCT_STAT sbuf;
326 struct us_priv_info *pi = (struct us_priv_info *)priv;
327 TALLOC_CTX *ctx = pi->ctx;
328 struct net_context *c = pi->c;
331 SEC_DESC *psd = NULL;
333 char *sharepath = NULL;
334 char *comment = NULL;
338 enum usershare_err us_err;
339 bool guest_ok = false;
341 sep_str[0] = *lp_winbind_separator();
344 basepath = get_basepath(ctx);
348 basepath = talloc_asprintf_append(basepath,
356 fd = sys_open(basepath, O_RDONLY|O_NOFOLLOW, 0);
358 fd = sys_open(basepath, O_RDONLY, 0);
362 d_fprintf(stderr, _("info_fn: unable to open %s. %s\n"),
363 basepath, strerror(errno) );
368 if (sys_fstat(fd, &sbuf, false) != 0) {
370 _("info_fn: can't fstat file %s. Error was %s\n"),
371 basepath, strerror(errno) );
376 if (!S_ISREG(sbuf.st_ex_mode)) {
378 _("info_fn: file %s is not a regular file. Ignoring.\n"),
384 lines = fd_lines_load(fd, &numlines, 10240, NULL);
391 /* Ensure it's well formed. */
392 us_err = parse_usershare_file(ctx, &sbuf, fl->pathname, -1, lines, numlines,
400 if (us_err != USERSHARE_OK) {
402 _("info_fn: file %s is not a well formed usershare "
405 d_fprintf(stderr, _("info_fn: Error was %s.\n"),
406 get_us_error_code(us_err) );
410 acl_str = talloc_strdup(ctx, "usershare_acl=");
415 for (num_aces = 0; num_aces < psd->dacl->num_aces; num_aces++) {
420 ntstatus = net_lookup_name_from_sid(c, ctx,
421 &psd->dacl->aces[num_aces].trustee,
424 if (NT_STATUS_IS_OK(ntstatus)) {
425 if (domain && *domain) {
426 acl_str = talloc_asprintf_append(acl_str,
434 acl_str = talloc_asprintf_append(acl_str,
443 sid_to_fstring(sidstr,
444 &psd->dacl->aces[num_aces].trustee);
445 acl_str = talloc_asprintf_append(acl_str,
452 acl_str = talloc_asprintf_append(acl_str, ":");
457 if (psd->dacl->aces[num_aces].type == SEC_ACE_TYPE_ACCESS_DENIED) {
458 acl_str = talloc_asprintf_append(acl_str, "D,");
463 if (psd->dacl->aces[num_aces].access_mask & GENERIC_ALL_ACCESS) {
464 acl_str = talloc_asprintf_append(acl_str, "F,");
466 acl_str = talloc_asprintf_append(acl_str, "R,");
474 /* NOTE: This is smb.conf-like output. Do not translate. */
475 if (pi->op == US_INFO_OP) {
476 d_printf("[%s]\n", fl->pathname );
477 d_printf("path=%s\n", sharepath );
478 d_printf("comment=%s\n", comment);
479 d_printf("%s\n", acl_str);
480 d_printf("guest_ok=%c\n\n", guest_ok ? 'y' : 'n');
481 } else if (pi->op == US_LIST_OP) {
482 d_printf("%s\n", fl->pathname);
488 /***************************************************************************
489 Print out info (internal detail) on userlevel shares.
490 ***************************************************************************/
492 static int net_usershare_info(struct net_context *c, int argc, const char **argv)
495 bool only_ours = true;
497 struct us_priv_info pi;
502 if (c->display_usage)
503 return net_usershare_info_usage(c, argc, argv);
505 if (c->opt_long_list_entries) {
513 fstrcpy(wcard, argv[0]);
516 return net_usershare_info_usage(c, argc, argv);
521 ctx = talloc_init("share_info");
522 ret = get_share_list(ctx, wcard, only_ours);
531 ret = process_share_list(info_fn, &pi);
536 /***************************************************************************
537 Count the current total number of usershares.
538 ***************************************************************************/
540 static int count_num_usershares(void)
543 SMB_STRUCT_DIRENT *de;
544 int num_usershares = 0;
545 TALLOC_CTX *ctx = talloc_tos();
546 char *basepath = get_basepath(ctx);
552 dp = sys_opendir(basepath);
555 _("count_num_usershares: cannot open usershare "
556 "directory %s. Error %s\n"),
557 basepath, strerror(errno) );
561 while((de = sys_readdir(dp)) != 0) {
562 SMB_STRUCT_STAT sbuf;
564 const char *n = de->d_name;
566 /* Ignore . and .. */
568 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
573 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
575 _("count_num_usershares: ignoring bad share "
579 path = talloc_asprintf(ctx,
588 if (sys_lstat(path, &sbuf, lp_fake_dir_create_times())
591 _("count_num_usershares: can't lstat file %s. "
593 path, strerror(errno) );
597 if (!S_ISREG(sbuf.st_ex_mode)) {
599 _("count_num_usershares: file %s is not a "
600 "regular file. Ignoring.\n"),
608 return num_usershares;
611 /***************************************************************************
612 Add a single userlevel share.
613 ***************************************************************************/
615 static int net_usershare_add(struct net_context *c, int argc, const char **argv)
617 TALLOC_CTX *ctx = talloc_stackframe();
618 SMB_STRUCT_STAT sbuf;
619 SMB_STRUCT_STAT lsbuf;
624 const char *us_comment;
633 uid_t myeuid = geteuid();
634 bool guest_ok = false;
638 arg_acl = "S-1-1-0:R";
640 if (c->display_usage)
641 return net_usershare_add_usage(c, argc, argv);
647 return net_usershare_add_usage(c, argc, argv);
649 sharename = strlower_talloc(ctx, argv[0]);
653 sharename = strlower_talloc(ctx, argv[0]);
655 us_comment = argv[2];
658 sharename = strlower_talloc(ctx, argv[0]);
660 us_comment = argv[2];
664 sharename = strlower_talloc(ctx, argv[0]);
666 us_comment = argv[2];
668 if (strlen(arg_acl) == 0) {
669 arg_acl = "S-1-1-0:R";
671 if (!strnequal(argv[4], "guest_ok=", 9)) {
673 return net_usershare_add_usage(c, argc, argv);
675 switch (argv[4][9]) {
686 return net_usershare_add_usage(c, argc, argv);
691 /* Ensure we're under the "usershare max shares" number. Advisory only. */
692 num_usershares = count_num_usershares();
693 if (num_usershares >= lp_usershare_max_shares()) {
695 _("net usershare add: maximum number of allowed "
696 "usershares (%d) reached\n"),
697 lp_usershare_max_shares() );
702 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
703 d_fprintf(stderr, _("net usershare add: share name %s contains "
704 "invalid characters (any of %s)\n"),
705 sharename, INVALID_SHARENAME_CHARS);
710 /* Disallow shares the same as users. */
711 if (getpwnam(sharename)) {
713 _("net usershare add: share name %s is already a valid "
714 "system user name\n"),
720 /* Construct the full path for the usershare file. */
721 full_path = get_basepath(ctx);
726 full_path_tmp = talloc_asprintf(ctx,
729 if (!full_path_tmp) {
734 full_path = talloc_asprintf_append(full_path,
742 /* The path *must* be absolute. */
743 if (us_path[0] != '/') {
745 _("net usershare add: path %s is not an absolute "
752 /* Check the directory to be shared exists. */
753 if (sys_stat(us_path, &sbuf, lp_fake_dir_create_times()) != 0) {
755 _("net usershare add: cannot stat path %s to ensure "
756 "this is a directory. Error was %s\n"),
757 us_path, strerror(errno) );
762 if (!S_ISDIR(sbuf.st_ex_mode)) {
764 _("net usershare add: path %s is not a directory.\n"),
770 /* If we're not root, check if we're restricted to sharing out directories
773 if ((myeuid != 0) && lp_usershare_owner_only() && (myeuid != sbuf.st_ex_uid)) {
774 d_fprintf(stderr, _("net usershare add: cannot share path %s as "
775 "we are restricted to only sharing directories we own.\n"
776 "\tAsk the administrator to add the line \"usershare owner only = false\" \n"
777 "\tto the [global] section of the smb.conf to allow this.\n"),
783 /* No validation needed on comment. Now go through and validate the
784 acl string. Convert names to SID's as needed. Then run it through
785 parse_usershare_acl to ensure it's valid. */
787 /* Start off the string we'll append to. */
788 us_acl = talloc_strdup(ctx, "");
797 /* Add the number of ',' characters to get the number of aces. */
798 num_aces += count_chars(pacl,',');
800 for (i = 0; i < num_aces; i++) {
802 const char *pcolon = strchr_m(pacl, ':');
805 if (pcolon == NULL) {
807 _("net usershare add: malformed acl %s "
823 _("net usershare add: malformed acl %s "
824 "(access control must be 'r', 'f', "
831 if (pcolon[2] != ',' && pcolon[2] != '\0') {
833 _("net usershare add: malformed terminating "
834 "character for acl %s\n"),
841 if ((name = talloc_strndup(ctx, pacl, pcolon - pacl)) == NULL) {
842 d_fprintf(stderr, _("talloc_strndup failed\n"));
846 if (!string_to_sid(&sid, name)) {
847 /* Convert to a SID */
848 NTSTATUS ntstatus = net_lookup_sid_from_name(c, ctx, name, &sid);
849 if (!NT_STATUS_IS_OK(ntstatus)) {
851 _("net usershare add: cannot convert "
852 "name \"%s\" to a SID. %s."),
853 name, get_friendly_nt_error_msg(ntstatus) );
854 if (NT_STATUS_EQUAL(ntstatus, NT_STATUS_CONNECTION_REFUSED)) {
856 _(" Maybe smbd is not running.\n"));
858 d_fprintf(stderr, "\n");
864 us_acl = talloc_asprintf_append(
865 us_acl, "%s:%c,", sid_string_tos(&sid), pcolon[1]);
867 /* Move to the next ACL entry. */
868 if (pcolon[2] == ',') {
873 /* Remove the last ',' */
874 us_acl[strlen(us_acl)-1] = '\0';
876 if (guest_ok && !lp_usershare_allow_guests()) {
877 d_fprintf(stderr, _("net usershare add: guest_ok=y requested "
878 "but the \"usershare allow guests\" parameter is not "
879 "enabled by this server.\n"));
884 /* Create a temporary filename for this share. */
885 tmpfd = mkstemp(full_path_tmp);
889 _("net usershare add: cannot create tmp file %s\n"),
895 /* Ensure we opened the file we thought we did. */
896 if (sys_lstat(full_path_tmp, &lsbuf, lp_fake_dir_create_times())
899 _("net usershare add: cannot lstat tmp file %s\n"),
905 /* Check this is the same as the file we opened. */
906 if (sys_fstat(tmpfd, &sbuf, lp_fake_dir_create_times()) != 0) {
908 _("net usershare add: cannot fstat tmp file %s\n"),
914 if (!S_ISREG(sbuf.st_ex_mode) || sbuf.st_ex_dev != lsbuf.st_ex_dev || sbuf.st_ex_ino != lsbuf.st_ex_ino) {
916 _("net usershare add: tmp file %s is not a regular "
923 if (fchmod(tmpfd, 0644) == -1) {
925 _("net usershare add: failed to fchmod tmp file %s "
932 /* Create the in-memory image of the file. */
933 file_img = talloc_strdup(ctx, "#VERSION 2\npath=");
934 file_img = talloc_asprintf_append(file_img, "%s\ncomment=%s\nusershare_acl=%s\nguest_ok=%c\n",
935 us_path, us_comment, us_acl, guest_ok ? 'y' : 'n');
937 to_write = strlen(file_img);
939 if (write(tmpfd, file_img, to_write) != to_write) {
941 _("net usershare add: failed to write %u bytes to "
942 "file %s. Error was %s\n"),
943 (unsigned int)to_write, full_path_tmp, strerror(errno));
944 unlink(full_path_tmp);
949 /* Attempt to replace any existing share by this name. */
950 if (rename(full_path_tmp, full_path) != 0) {
951 unlink(full_path_tmp);
953 _("net usershare add: failed to add share %s. Error "
955 sharename, strerror(errno));
963 if (c->opt_long_list_entries) {
964 const char *my_argv[2];
965 my_argv[0] = sharename;
967 net_usershare_info(c, 1, my_argv);
975 /***************************************************************************
977 ***************************************************************************/
979 static int list_fn(struct file_list *fl, void *priv)
981 d_printf("%s\n", fl->pathname);
986 /***************************************************************************
987 List userlevel shares.
988 ***************************************************************************/
990 static int net_usershare_list(struct net_context *c, int argc,
994 bool only_ours = true;
996 struct us_priv_info pi;
1001 if (c->display_usage)
1002 return net_usershare_list_usage(c, argc, argv);
1004 if (c->opt_long_list_entries) {
1012 fstrcpy(wcard, argv[0]);
1015 return net_usershare_list_usage(c, argc, argv);
1020 ctx = talloc_init("share_list");
1021 ret = get_share_list(ctx, wcard, only_ours);
1030 ret = process_share_list(info_fn, &pi);
1031 talloc_destroy(ctx);
1035 /***************************************************************************
1036 Entry-point for all the USERSHARE functions.
1037 ***************************************************************************/
1039 int net_usershare(struct net_context *c, int argc, const char **argv)
1043 struct functable func[] = {
1047 NET_TRANSPORT_LOCAL,
1048 N_("Add/modify user defined share"),
1049 N_("net usershare add\n"
1050 " Add/modify user defined share")
1054 net_usershare_delete,
1055 NET_TRANSPORT_LOCAL,
1056 N_("Delete user defined share"),
1057 N_("net usershare delete\n"
1058 " Delete user defined share")
1063 NET_TRANSPORT_LOCAL,
1064 N_("Display information about a user defined share"),
1065 N_("net usershare info\n"
1066 " Display information about a user defined share")
1071 NET_TRANSPORT_LOCAL,
1072 N_("List user defined shares"),
1073 N_("net usershare list\n"
1074 " List user defined shares")
1076 {NULL, NULL, 0, NULL, NULL}
1079 if (lp_usershare_max_shares() == 0) {
1081 _("net usershare: usershares are currently "
1086 dp = sys_opendir(lp_usershare_path());
1090 _("net usershare: cannot open usershare directory %s. "
1092 lp_usershare_path(), strerror(err) );
1093 if (err == EACCES) {
1095 _("You do not have permission to create a "
1096 "usershare. Ask your administrator to grant "
1097 "you permissions to create a share.\n"));
1098 } else if (err == ENOENT) {
1100 _("Please ask your system administrator to "
1101 "enable user sharing.\n"));
1107 return net_run_function(c, argc, argv, "net usershare", func);