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, lp_fake_dir_create_times())
254 _("get_share_list: can't lstat file %s. Error "
256 path, strerror(errno) );
260 if (!S_ISREG(sbuf.st_ex_mode)) {
262 _("get_share_list: file %s is not a regular "
263 "file. Ignoring.\n"),
268 if (only_ours && sbuf.st_ex_uid != myuid) {
272 if (!unix_wild_match(wcard, n)) {
276 /* (Finally) - add to list. */
277 fl = TALLOC_P(ctx, struct file_list);
282 fl->pathname = talloc_strdup(ctx, n);
288 DLIST_ADD(flist, fl);
295 enum us_priv_op { US_LIST_OP, US_INFO_OP};
297 struct us_priv_info {
300 struct net_context *c;
303 /***************************************************************************
304 Call a function for every share on the list.
305 ***************************************************************************/
307 static int process_share_list(int (*fn)(struct file_list *, void *), void *priv)
309 struct file_list *fl;
312 for (fl = flist; fl; fl = fl->next) {
313 ret = (*fn)(fl, priv);
319 /***************************************************************************
321 ***************************************************************************/
323 static int info_fn(struct file_list *fl, void *priv)
325 SMB_STRUCT_STAT sbuf;
327 struct us_priv_info *pi = (struct us_priv_info *)priv;
328 TALLOC_CTX *ctx = pi->ctx;
329 struct net_context *c = pi->c;
332 SEC_DESC *psd = NULL;
334 char *sharepath = NULL;
335 char *comment = NULL;
339 enum usershare_err us_err;
340 bool guest_ok = false;
342 sep_str[0] = *lp_winbind_separator();
345 basepath = get_basepath(ctx);
349 basepath = talloc_asprintf_append(basepath,
357 fd = sys_open(basepath, O_RDONLY|O_NOFOLLOW, 0);
359 fd = sys_open(basepath, O_RDONLY, 0);
363 d_fprintf(stderr, _("info_fn: unable to open %s. %s\n"),
364 basepath, strerror(errno) );
369 if (sys_fstat(fd, &sbuf, lp_fake_dir_create_times()) != 0) {
371 _("info_fn: can't fstat file %s. Error was %s\n"),
372 basepath, strerror(errno) );
377 if (!S_ISREG(sbuf.st_ex_mode)) {
379 _("info_fn: file %s is not a regular file. Ignoring.\n"),
385 lines = fd_lines_load(fd, &numlines, 10240, NULL);
392 /* Ensure it's well formed. */
393 us_err = parse_usershare_file(ctx, &sbuf, fl->pathname, -1, lines, numlines,
401 if (us_err != USERSHARE_OK) {
403 _("info_fn: file %s is not a well formed usershare "
406 d_fprintf(stderr, _("info_fn: Error was %s.\n"),
407 get_us_error_code(us_err) );
411 acl_str = talloc_strdup(ctx, "usershare_acl=");
416 for (num_aces = 0; num_aces < psd->dacl->num_aces; num_aces++) {
421 ntstatus = net_lookup_name_from_sid(c, ctx,
422 &psd->dacl->aces[num_aces].trustee,
425 if (NT_STATUS_IS_OK(ntstatus)) {
426 if (domain && *domain) {
427 acl_str = talloc_asprintf_append(acl_str,
435 acl_str = talloc_asprintf_append(acl_str,
444 sid_to_fstring(sidstr,
445 &psd->dacl->aces[num_aces].trustee);
446 acl_str = talloc_asprintf_append(acl_str,
453 acl_str = talloc_asprintf_append(acl_str, ":");
458 if (psd->dacl->aces[num_aces].type == SEC_ACE_TYPE_ACCESS_DENIED) {
459 acl_str = talloc_asprintf_append(acl_str, "D,");
464 if (psd->dacl->aces[num_aces].access_mask & GENERIC_ALL_ACCESS) {
465 acl_str = talloc_asprintf_append(acl_str, "F,");
467 acl_str = talloc_asprintf_append(acl_str, "R,");
475 /* NOTE: This is smb.conf-like output. Do not translate. */
476 if (pi->op == US_INFO_OP) {
477 d_printf("[%s]\n", fl->pathname );
478 d_printf("path=%s\n", sharepath );
479 d_printf("comment=%s\n", comment);
480 d_printf("%s\n", acl_str);
481 d_printf("guest_ok=%c\n\n", guest_ok ? 'y' : 'n');
482 } else if (pi->op == US_LIST_OP) {
483 d_printf("%s\n", fl->pathname);
489 /***************************************************************************
490 Print out info (internal detail) on userlevel shares.
491 ***************************************************************************/
493 static int net_usershare_info(struct net_context *c, int argc, const char **argv)
496 bool only_ours = true;
498 struct us_priv_info pi;
503 if (c->display_usage)
504 return net_usershare_info_usage(c, argc, argv);
506 if (c->opt_long_list_entries) {
514 fstrcpy(wcard, argv[0]);
517 return net_usershare_info_usage(c, argc, argv);
522 ctx = talloc_init("share_info");
523 ret = get_share_list(ctx, wcard, only_ours);
532 ret = process_share_list(info_fn, &pi);
537 /***************************************************************************
538 Count the current total number of usershares.
539 ***************************************************************************/
541 static int count_num_usershares(void)
544 SMB_STRUCT_DIRENT *de;
545 int num_usershares = 0;
546 TALLOC_CTX *ctx = talloc_tos();
547 char *basepath = get_basepath(ctx);
553 dp = sys_opendir(basepath);
556 _("count_num_usershares: cannot open usershare "
557 "directory %s. Error %s\n"),
558 basepath, strerror(errno) );
562 while((de = sys_readdir(dp)) != 0) {
563 SMB_STRUCT_STAT sbuf;
565 const char *n = de->d_name;
567 /* Ignore . and .. */
569 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
574 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
576 _("count_num_usershares: ignoring bad share "
580 path = talloc_asprintf(ctx,
589 if (sys_lstat(path, &sbuf, lp_fake_dir_create_times())
592 _("count_num_usershares: can't lstat file %s. "
594 path, strerror(errno) );
598 if (!S_ISREG(sbuf.st_ex_mode)) {
600 _("count_num_usershares: file %s is not a "
601 "regular file. Ignoring.\n"),
609 return num_usershares;
612 /***************************************************************************
613 Add a single userlevel share.
614 ***************************************************************************/
616 static int net_usershare_add(struct net_context *c, int argc, const char **argv)
618 TALLOC_CTX *ctx = talloc_stackframe();
619 SMB_STRUCT_STAT sbuf;
620 SMB_STRUCT_STAT lsbuf;
625 const char *us_comment;
634 uid_t myeuid = geteuid();
635 bool guest_ok = false;
639 arg_acl = "S-1-1-0:R";
641 if (c->display_usage)
642 return net_usershare_add_usage(c, argc, argv);
648 return net_usershare_add_usage(c, argc, argv);
650 sharename = strlower_talloc(ctx, argv[0]);
654 sharename = strlower_talloc(ctx, argv[0]);
656 us_comment = argv[2];
659 sharename = strlower_talloc(ctx, argv[0]);
661 us_comment = argv[2];
665 sharename = strlower_talloc(ctx, argv[0]);
667 us_comment = argv[2];
669 if (strlen(arg_acl) == 0) {
670 arg_acl = "S-1-1-0:R";
672 if (!strnequal(argv[4], "guest_ok=", 9)) {
674 return net_usershare_add_usage(c, argc, argv);
676 switch (argv[4][9]) {
687 return net_usershare_add_usage(c, argc, argv);
692 /* Ensure we're under the "usershare max shares" number. Advisory only. */
693 num_usershares = count_num_usershares();
694 if (num_usershares >= lp_usershare_max_shares()) {
696 _("net usershare add: maximum number of allowed "
697 "usershares (%d) reached\n"),
698 lp_usershare_max_shares() );
703 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
704 d_fprintf(stderr, _("net usershare add: share name %s contains "
705 "invalid characters (any of %s)\n"),
706 sharename, INVALID_SHARENAME_CHARS);
711 /* Disallow shares the same as users. */
712 if (getpwnam(sharename)) {
714 _("net usershare add: share name %s is already a valid "
715 "system user name\n"),
721 /* Construct the full path for the usershare file. */
722 full_path = get_basepath(ctx);
727 full_path_tmp = talloc_asprintf(ctx,
730 if (!full_path_tmp) {
735 full_path = talloc_asprintf_append(full_path,
743 /* The path *must* be absolute. */
744 if (us_path[0] != '/') {
746 _("net usershare add: path %s is not an absolute "
753 /* Check the directory to be shared exists. */
754 if (sys_stat(us_path, &sbuf, lp_fake_dir_create_times()) != 0) {
756 _("net usershare add: cannot stat path %s to ensure "
757 "this is a directory. Error was %s\n"),
758 us_path, strerror(errno) );
763 if (!S_ISDIR(sbuf.st_ex_mode)) {
765 _("net usershare add: path %s is not a directory.\n"),
771 /* If we're not root, check if we're restricted to sharing out directories
774 if ((myeuid != 0) && lp_usershare_owner_only() && (myeuid != sbuf.st_ex_uid)) {
775 d_fprintf(stderr, _("net usershare add: cannot share path %s as "
776 "we are restricted to only sharing directories we own.\n"
777 "\tAsk the administrator to add the line \"usershare owner only = false\" \n"
778 "\tto the [global] section of the smb.conf to allow this.\n"),
784 /* No validation needed on comment. Now go through and validate the
785 acl string. Convert names to SID's as needed. Then run it through
786 parse_usershare_acl to ensure it's valid. */
788 /* Start off the string we'll append to. */
789 us_acl = talloc_strdup(ctx, "");
798 /* Add the number of ',' characters to get the number of aces. */
799 num_aces += count_chars(pacl,',');
801 for (i = 0; i < num_aces; i++) {
803 const char *pcolon = strchr_m(pacl, ':');
806 if (pcolon == NULL) {
808 _("net usershare add: malformed acl %s "
824 _("net usershare add: malformed acl %s "
825 "(access control must be 'r', 'f', "
832 if (pcolon[2] != ',' && pcolon[2] != '\0') {
834 _("net usershare add: malformed terminating "
835 "character for acl %s\n"),
842 if ((name = talloc_strndup(ctx, pacl, pcolon - pacl)) == NULL) {
843 d_fprintf(stderr, _("talloc_strndup failed\n"));
847 if (!string_to_sid(&sid, name)) {
848 /* Convert to a SID */
849 NTSTATUS ntstatus = net_lookup_sid_from_name(c, ctx, name, &sid);
850 if (!NT_STATUS_IS_OK(ntstatus)) {
852 _("net usershare add: cannot convert "
853 "name \"%s\" to a SID. %s."),
854 name, get_friendly_nt_error_msg(ntstatus) );
855 if (NT_STATUS_EQUAL(ntstatus, NT_STATUS_CONNECTION_REFUSED)) {
857 _(" Maybe smbd is not running.\n"));
859 d_fprintf(stderr, "\n");
865 us_acl = talloc_asprintf_append(
866 us_acl, "%s:%c,", sid_string_tos(&sid), pcolon[1]);
868 /* Move to the next ACL entry. */
869 if (pcolon[2] == ',') {
874 /* Remove the last ',' */
875 us_acl[strlen(us_acl)-1] = '\0';
877 if (guest_ok && !lp_usershare_allow_guests()) {
878 d_fprintf(stderr, _("net usershare add: guest_ok=y requested "
879 "but the \"usershare allow guests\" parameter is not "
880 "enabled by this server.\n"));
885 /* Create a temporary filename for this share. */
886 tmpfd = mkstemp(full_path_tmp);
890 _("net usershare add: cannot create tmp file %s\n"),
896 /* Ensure we opened the file we thought we did. */
897 if (sys_lstat(full_path_tmp, &lsbuf, lp_fake_dir_create_times())
900 _("net usershare add: cannot lstat tmp file %s\n"),
906 /* Check this is the same as the file we opened. */
907 if (sys_fstat(tmpfd, &sbuf, lp_fake_dir_create_times()) != 0) {
909 _("net usershare add: cannot fstat tmp file %s\n"),
915 if (!S_ISREG(sbuf.st_ex_mode) || sbuf.st_ex_dev != lsbuf.st_ex_dev || sbuf.st_ex_ino != lsbuf.st_ex_ino) {
917 _("net usershare add: tmp file %s is not a regular "
924 if (fchmod(tmpfd, 0644) == -1) {
926 _("net usershare add: failed to fchmod tmp file %s "
933 /* Create the in-memory image of the file. */
934 file_img = talloc_strdup(ctx, "#VERSION 2\npath=");
935 file_img = talloc_asprintf_append(file_img, "%s\ncomment=%s\nusershare_acl=%s\nguest_ok=%c\n",
936 us_path, us_comment, us_acl, guest_ok ? 'y' : 'n');
938 to_write = strlen(file_img);
940 if (write(tmpfd, file_img, to_write) != to_write) {
942 _("net usershare add: failed to write %u bytes to "
943 "file %s. Error was %s\n"),
944 (unsigned int)to_write, full_path_tmp, strerror(errno));
945 unlink(full_path_tmp);
950 /* Attempt to replace any existing share by this name. */
951 if (rename(full_path_tmp, full_path) != 0) {
952 unlink(full_path_tmp);
954 _("net usershare add: failed to add share %s. Error "
956 sharename, strerror(errno));
964 if (c->opt_long_list_entries) {
965 const char *my_argv[2];
966 my_argv[0] = sharename;
968 net_usershare_info(c, 1, my_argv);
976 /***************************************************************************
978 ***************************************************************************/
980 static int list_fn(struct file_list *fl, void *priv)
982 d_printf("%s\n", fl->pathname);
987 /***************************************************************************
988 List userlevel shares.
989 ***************************************************************************/
991 static int net_usershare_list(struct net_context *c, int argc,
995 bool only_ours = true;
997 struct us_priv_info pi;
1000 fstrcpy(wcard, "*");
1002 if (c->display_usage)
1003 return net_usershare_list_usage(c, argc, argv);
1005 if (c->opt_long_list_entries) {
1013 fstrcpy(wcard, argv[0]);
1016 return net_usershare_list_usage(c, argc, argv);
1021 ctx = talloc_init("share_list");
1022 ret = get_share_list(ctx, wcard, only_ours);
1031 ret = process_share_list(info_fn, &pi);
1032 talloc_destroy(ctx);
1036 /***************************************************************************
1037 Entry-point for all the USERSHARE functions.
1038 ***************************************************************************/
1040 int net_usershare(struct net_context *c, int argc, const char **argv)
1044 struct functable func[] = {
1048 NET_TRANSPORT_LOCAL,
1049 N_("Add/modify user defined share"),
1050 N_("net usershare add\n"
1051 " Add/modify user defined share")
1055 net_usershare_delete,
1056 NET_TRANSPORT_LOCAL,
1057 N_("Delete user defined share"),
1058 N_("net usershare delete\n"
1059 " Delete user defined share")
1064 NET_TRANSPORT_LOCAL,
1065 N_("Display information about a user defined share"),
1066 N_("net usershare info\n"
1067 " Display information about a user defined share")
1072 NET_TRANSPORT_LOCAL,
1073 N_("List user defined shares"),
1074 N_("net usershare list\n"
1075 " List user defined shares")
1077 {NULL, NULL, 0, NULL, NULL}
1080 if (lp_usershare_max_shares() == 0) {
1082 _("net usershare: usershares are currently "
1087 dp = sys_opendir(lp_usershare_path());
1091 _("net usershare: cannot open usershare directory %s. "
1093 lp_usershare_path(), strerror(err) );
1094 if (err == EACCES) {
1096 _("You do not have permission to create a "
1097 "usershare. Ask your administrator to grant "
1098 "you permissions to create a share.\n"));
1099 } else if (err == ENOENT) {
1101 _("Please ask your system administrator to "
1102 "enable user sharing.\n"));
1108 return net_run_function(c, argc, argv, "net usershare", func);