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"
23 #include "../libcli/security/security.h"
26 const char *us_errstr;
27 enum usershare_err us_err;
30 {N_("Malformed usershare file"), USERSHARE_MALFORMED_FILE},
31 {N_("Bad version number"), USERSHARE_BAD_VERSION},
32 {N_("Malformed path entry"), USERSHARE_MALFORMED_PATH},
33 {N_("Malformed comment entryfile"), USERSHARE_MALFORMED_COMMENT_DEF},
34 {N_("Malformed acl definition"), USERSHARE_MALFORMED_ACL_DEF},
35 {N_("Acl parse error"), USERSHARE_ACL_ERR},
36 {N_("Path not absolute"), USERSHARE_PATH_NOT_ABSOLUTE},
37 {N_("Path is denied"), USERSHARE_PATH_IS_DENIED},
38 {N_("Path not allowed"), USERSHARE_PATH_NOT_ALLOWED},
39 {N_("Path is not a directory"), USERSHARE_PATH_NOT_DIRECTORY},
40 {N_("System error"), USERSHARE_POSIX_ERR},
41 {N_("Malformed sharename definition"), USERSHARE_MALFORMED_SHARENAME_DEF},
42 {N_("Bad sharename (doesn't match filename)"), USERSHARE_BAD_SHARENAME},
43 {NULL,(enum usershare_err)-1}
46 static const char *get_us_error_code(enum usershare_err us_err)
51 while (us_errs[idx].us_errstr != NULL) {
52 if (us_errs[idx].us_err == us_err) {
53 return us_errs[idx].us_errstr;
58 result = talloc_asprintf(talloc_tos(), _("Usershare error code (0x%x)"),
59 (unsigned int)us_err);
60 SMB_ASSERT(result != NULL);
64 /* The help subsystem for the USERSHARE subcommand */
66 static int net_usershare_add_usage(struct net_context *c, int argc, const char **argv)
68 char chr = *lp_winbind_separator();
70 "net usershare add [-l|--long] <sharename> <path> [<comment>] [<acl>] [<guest_ok=[y|n]>]\n"
71 "\tAdds the specified share name for this user.\n"
72 "\t<sharename> is the new share name.\n"
73 "\t<path> is the path on the filesystem to export.\n"
74 "\t<comment> is the optional comment for the new share.\n"
75 "\t<acl> is an optional share acl in the format \"DOMAIN%cname:X,DOMAIN%cname:X,....\"\n"
76 "\t<guest_ok=y> if present sets \"guest ok = yes\" on this usershare.\n"
77 "\t\t\"X\" represents a permission and can be any one of the characters f, r or d\n"
78 "\t\twhere \"f\" means full control, \"r\" means read-only, \"d\" means deny access.\n"
79 "\t\tname may be a domain user or group. For local users use the local server name "
80 "instead of \"DOMAIN\"\n"
81 "\t\tThe default acl is \"Everyone:r\" which allows everyone read-only access.\n"
82 "\tAdd -l or --long to print the info on the newly added share.\n"),
87 static int net_usershare_delete_usage(struct net_context *c, int argc, const char **argv)
90 "net usershare delete <sharename>\n"
91 "\tdeletes the specified share name for this user.\n"));
95 static int net_usershare_info_usage(struct net_context *c, int argc, const char **argv)
98 "net usershare info [-l|--long] [wildcard sharename]\n"
99 "\tPrints out the path, comment and acl elements of shares that match the wildcard.\n"
100 "\tBy default only gives info on shares owned by the current user\n"
101 "\tAdd -l or --long to apply this to all shares\n"
102 "\tOmit the sharename or use a wildcard of '*' to see all shares\n"));
106 static int net_usershare_list_usage(struct net_context *c, int argc, const char **argv)
109 "net usershare list [-l|--long] [wildcard sharename]\n"
110 "\tLists the names of all shares that match the wildcard.\n"
111 "\tBy default only lists shares owned by the current user\n"
112 "\tAdd -l or --long to apply this to all shares\n"
113 "\tOmit the sharename or use a wildcard of '*' to see all shares\n"));
117 int net_usershare_usage(struct net_context *c, int argc, const char **argv)
119 d_printf(_("net usershare add <sharename> <path> [<comment>] [<acl>] [<guest_ok=[y|n]>] to "
120 "add or change a user defined share.\n"
121 "net usershare delete <sharename> to delete a user defined share.\n"
122 "net usershare info [-l|--long] [wildcard sharename] to print info about a user defined share.\n"
123 "net usershare list [-l|--long] [wildcard sharename] to list user defined shares.\n"
124 "net usershare help\n"
125 "\nType \"net usershare help <option>\" to get more information on that option\n\n"));
127 net_common_flags_usage(c, argc, argv);
131 /***************************************************************************
132 ***************************************************************************/
134 static char *get_basepath(TALLOC_CTX *ctx)
136 char *basepath = talloc_strdup(ctx, lp_usershare_path());
141 if ((basepath[0] != '\0') && (basepath[strlen(basepath)-1] == '/')) {
142 basepath[strlen(basepath)-1] = '\0';
147 /***************************************************************************
148 Delete a single userlevel share.
149 ***************************************************************************/
151 static int net_usershare_delete(struct net_context *c, int argc, const char **argv)
156 if (argc != 1 || c->display_usage) {
157 return net_usershare_delete_usage(c, argc, argv);
160 if ((sharename = strlower_talloc(talloc_tos(), argv[0])) == NULL) {
161 d_fprintf(stderr, _("strlower_talloc failed\n"));
165 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
166 d_fprintf(stderr, _("net usershare delete: share name %s contains "
167 "invalid characters (any of %s)\n"),
168 sharename, INVALID_SHARENAME_CHARS);
169 TALLOC_FREE(sharename);
173 us_path = talloc_asprintf(talloc_tos(),
178 TALLOC_FREE(sharename);
182 if (unlink(us_path) != 0) {
183 d_fprintf(stderr, _("net usershare delete: unable to remove usershare %s. "
185 us_path, strerror(errno));
186 TALLOC_FREE(sharename);
189 TALLOC_FREE(sharename);
193 /***************************************************************************
194 Data structures to handle a list of usershare files.
195 ***************************************************************************/
198 struct file_list *next, *prev;
199 const char *pathname;
202 static struct file_list *flist;
204 /***************************************************************************
205 ***************************************************************************/
207 static int get_share_list(TALLOC_CTX *ctx, const char *wcard, bool only_ours)
210 SMB_STRUCT_DIRENT *de;
211 uid_t myuid = geteuid();
212 struct file_list *fl = NULL;
213 char *basepath = get_basepath(ctx);
218 dp = sys_opendir(basepath);
221 _("get_share_list: cannot open usershare directory %s. "
223 basepath, strerror(errno) );
227 while((de = sys_readdir(dp)) != 0) {
228 SMB_STRUCT_STAT sbuf;
230 const char *n = de->d_name;
232 /* Ignore . and .. */
234 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
239 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
241 _("get_share_list: ignoring bad share "
245 path = talloc_asprintf(ctx,
254 if (sys_lstat(path, &sbuf, false) != 0) {
256 _("get_share_list: can't lstat file %s. Error "
258 path, strerror(errno) );
262 if (!S_ISREG(sbuf.st_ex_mode)) {
264 _("get_share_list: file %s is not a regular "
265 "file. Ignoring.\n"),
270 if (only_ours && sbuf.st_ex_uid != myuid) {
274 if (!unix_wild_match(wcard, n)) {
278 /* (Finally) - add to list. */
279 fl = TALLOC_P(ctx, struct file_list);
284 fl->pathname = talloc_strdup(ctx, n);
290 DLIST_ADD(flist, fl);
297 enum us_priv_op { US_LIST_OP, US_INFO_OP};
299 struct us_priv_info {
302 struct net_context *c;
305 /***************************************************************************
306 Call a function for every share on the list.
307 ***************************************************************************/
309 static int process_share_list(int (*fn)(struct file_list *, void *), void *priv)
311 struct file_list *fl;
314 for (fl = flist; fl; fl = fl->next) {
315 ret = (*fn)(fl, priv);
321 /***************************************************************************
323 ***************************************************************************/
325 static int info_fn(struct file_list *fl, void *priv)
327 SMB_STRUCT_STAT sbuf;
329 struct us_priv_info *pi = (struct us_priv_info *)priv;
330 TALLOC_CTX *ctx = pi->ctx;
331 struct net_context *c = pi->c;
334 struct security_descriptor *psd = NULL;
336 char *sharepath = NULL;
337 char *comment = NULL;
338 char *cp_sharename = NULL;
342 enum usershare_err us_err;
343 bool guest_ok = false;
345 sep_str[0] = *lp_winbind_separator();
348 basepath = get_basepath(ctx);
352 basepath = talloc_asprintf_append(basepath,
360 fd = sys_open(basepath, O_RDONLY|O_NOFOLLOW, 0);
362 fd = sys_open(basepath, O_RDONLY, 0);
366 d_fprintf(stderr, _("info_fn: unable to open %s. %s\n"),
367 basepath, strerror(errno) );
372 if (sys_fstat(fd, &sbuf, false) != 0) {
374 _("info_fn: can't fstat file %s. Error was %s\n"),
375 basepath, strerror(errno) );
380 if (!S_ISREG(sbuf.st_ex_mode)) {
382 _("info_fn: file %s is not a regular file. Ignoring.\n"),
388 lines = fd_lines_load(fd, &numlines, 10240, NULL);
395 /* Ensure it's well formed. */
396 us_err = parse_usershare_file(ctx, &sbuf, fl->pathname, -1, lines, numlines,
405 if (us_err != USERSHARE_OK) {
407 _("info_fn: file %s is not a well formed usershare "
410 d_fprintf(stderr, _("info_fn: Error was %s.\n"),
411 get_us_error_code(us_err) );
415 acl_str = talloc_strdup(ctx, "usershare_acl=");
420 for (num_aces = 0; num_aces < psd->dacl->num_aces; num_aces++) {
425 ntstatus = net_lookup_name_from_sid(c, ctx,
426 &psd->dacl->aces[num_aces].trustee,
429 if (NT_STATUS_IS_OK(ntstatus)) {
430 if (domain && *domain) {
431 acl_str = talloc_asprintf_append(acl_str,
439 acl_str = talloc_asprintf_append(acl_str,
448 sid_to_fstring(sidstr,
449 &psd->dacl->aces[num_aces].trustee);
450 acl_str = talloc_asprintf_append(acl_str,
457 acl_str = talloc_asprintf_append(acl_str, ":");
462 if (psd->dacl->aces[num_aces].type == SEC_ACE_TYPE_ACCESS_DENIED) {
463 acl_str = talloc_asprintf_append(acl_str, "D,");
468 if (psd->dacl->aces[num_aces].access_mask & GENERIC_ALL_ACCESS) {
469 acl_str = talloc_asprintf_append(acl_str, "F,");
471 acl_str = talloc_asprintf_append(acl_str, "R,");
479 /* NOTE: This is smb.conf-like output. Do not translate. */
480 if (pi->op == US_INFO_OP) {
481 d_printf("[%s]\n", cp_sharename );
482 d_printf("path=%s\n", sharepath );
483 d_printf("comment=%s\n", comment);
484 d_printf("%s\n", acl_str);
485 d_printf("guest_ok=%c\n\n", guest_ok ? 'y' : 'n');
486 } else if (pi->op == US_LIST_OP) {
487 d_printf("%s\n", cp_sharename);
493 /***************************************************************************
494 Print out info (internal detail) on userlevel shares.
495 ***************************************************************************/
497 static int net_usershare_info(struct net_context *c, int argc, const char **argv)
500 bool only_ours = true;
502 struct us_priv_info pi;
507 if (c->display_usage)
508 return net_usershare_info_usage(c, argc, argv);
510 if (c->opt_long_list_entries) {
518 fstrcpy(wcard, argv[0]);
521 return net_usershare_info_usage(c, argc, argv);
526 ctx = talloc_init("share_info");
527 ret = get_share_list(ctx, wcard, only_ours);
536 ret = process_share_list(info_fn, &pi);
541 /***************************************************************************
542 Count the current total number of usershares.
543 ***************************************************************************/
545 static int count_num_usershares(void)
548 SMB_STRUCT_DIRENT *de;
549 int num_usershares = 0;
550 TALLOC_CTX *ctx = talloc_tos();
551 char *basepath = get_basepath(ctx);
557 dp = sys_opendir(basepath);
560 _("count_num_usershares: cannot open usershare "
561 "directory %s. Error %s\n"),
562 basepath, strerror(errno) );
566 while((de = sys_readdir(dp)) != 0) {
567 SMB_STRUCT_STAT sbuf;
569 const char *n = de->d_name;
571 /* Ignore . and .. */
573 if ((n[1] == '\0') || (n[1] == '.' && n[2] == '\0')) {
578 if (!validate_net_name(n, INVALID_SHARENAME_CHARS, strlen(n))) {
580 _("count_num_usershares: ignoring bad share "
584 path = talloc_asprintf(ctx,
593 if (sys_lstat(path, &sbuf, false) != 0) {
595 _("count_num_usershares: can't lstat file %s. "
597 path, strerror(errno) );
601 if (!S_ISREG(sbuf.st_ex_mode)) {
603 _("count_num_usershares: file %s is not a "
604 "regular file. Ignoring.\n"),
612 return num_usershares;
615 /***************************************************************************
616 Add a single userlevel share.
617 ***************************************************************************/
619 static int net_usershare_add(struct net_context *c, int argc, const char **argv)
621 TALLOC_CTX *ctx = talloc_stackframe();
622 SMB_STRUCT_STAT sbuf;
623 SMB_STRUCT_STAT lsbuf;
625 const char *cp_sharename;
629 const char *us_comment;
638 uid_t myeuid = geteuid();
639 bool guest_ok = false;
643 arg_acl = "S-1-1-0:R";
645 if (c->display_usage)
646 return net_usershare_add_usage(c, argc, argv);
652 return net_usershare_add_usage(c, argc, argv);
654 cp_sharename = argv[0];
655 sharename = strlower_talloc(ctx, argv[0]);
659 cp_sharename = argv[0];
660 sharename = strlower_talloc(ctx, argv[0]);
662 us_comment = argv[2];
665 cp_sharename = argv[0];
666 sharename = strlower_talloc(ctx, argv[0]);
668 us_comment = argv[2];
672 cp_sharename = argv[0];
673 sharename = strlower_talloc(ctx, argv[0]);
675 us_comment = argv[2];
677 if (strlen(arg_acl) == 0) {
678 arg_acl = "S-1-1-0:R";
680 if (!strnequal(argv[4], "guest_ok=", 9)) {
682 return net_usershare_add_usage(c, argc, argv);
684 switch (argv[4][9]) {
695 return net_usershare_add_usage(c, argc, argv);
700 /* Ensure we're under the "usershare max shares" number. Advisory only. */
701 num_usershares = count_num_usershares();
702 if (num_usershares >= lp_usershare_max_shares()) {
704 _("net usershare add: maximum number of allowed "
705 "usershares (%d) reached\n"),
706 lp_usershare_max_shares() );
711 if (!validate_net_name(sharename, INVALID_SHARENAME_CHARS, strlen(sharename))) {
712 d_fprintf(stderr, _("net usershare add: share name %s contains "
713 "invalid characters (any of %s)\n"),
714 sharename, INVALID_SHARENAME_CHARS);
719 /* Disallow shares the same as users. */
720 if (getpwnam(sharename)) {
722 _("net usershare add: share name %s is already a valid "
723 "system user name\n"),
729 /* Construct the full path for the usershare file. */
730 full_path = get_basepath(ctx);
735 full_path_tmp = talloc_asprintf(ctx,
738 if (!full_path_tmp) {
743 full_path = talloc_asprintf_append(full_path,
751 /* The path *must* be absolute. */
752 if (us_path[0] != '/') {
754 _("net usershare add: path %s is not an absolute "
761 /* Check the directory to be shared exists. */
762 if (sys_stat(us_path, &sbuf, false) != 0) {
764 _("net usershare add: cannot stat path %s to ensure "
765 "this is a directory. Error was %s\n"),
766 us_path, strerror(errno) );
771 if (!S_ISDIR(sbuf.st_ex_mode)) {
773 _("net usershare add: path %s is not a directory.\n"),
779 /* If we're not root, check if we're restricted to sharing out directories
782 if ((myeuid != 0) && lp_usershare_owner_only() && (myeuid != sbuf.st_ex_uid)) {
783 d_fprintf(stderr, _("net usershare add: cannot share path %s as "
784 "we are restricted to only sharing directories we own.\n"
785 "\tAsk the administrator to add the line \"usershare owner only = false\" \n"
786 "\tto the [global] section of the smb.conf to allow this.\n"),
792 /* No validation needed on comment. Now go through and validate the
793 acl string. Convert names to SID's as needed. Then run it through
794 parse_usershare_acl to ensure it's valid. */
796 /* Start off the string we'll append to. */
797 us_acl = talloc_strdup(ctx, "");
806 /* Add the number of ',' characters to get the number of aces. */
807 num_aces += count_chars(pacl,',');
809 for (i = 0; i < num_aces; i++) {
811 const char *pcolon = strchr_m(pacl, ':');
814 if (pcolon == NULL) {
816 _("net usershare add: malformed acl %s "
832 _("net usershare add: malformed acl %s "
833 "(access control must be 'r', 'f', "
840 if (pcolon[2] != ',' && pcolon[2] != '\0') {
842 _("net usershare add: malformed terminating "
843 "character for acl %s\n"),
850 if ((name = talloc_strndup(ctx, pacl, pcolon - pacl)) == NULL) {
851 d_fprintf(stderr, _("talloc_strndup failed\n"));
855 if (!string_to_sid(&sid, name)) {
856 /* Convert to a SID */
857 NTSTATUS ntstatus = net_lookup_sid_from_name(c, ctx, name, &sid);
858 if (!NT_STATUS_IS_OK(ntstatus)) {
860 _("net usershare add: cannot convert "
861 "name \"%s\" to a SID. %s."),
862 name, get_friendly_nt_error_msg(ntstatus) );
863 if (NT_STATUS_EQUAL(ntstatus, NT_STATUS_CONNECTION_REFUSED)) {
865 _(" Maybe smbd is not running.\n"));
867 d_fprintf(stderr, "\n");
873 us_acl = talloc_asprintf_append(
874 us_acl, "%s:%c,", sid_string_tos(&sid), pcolon[1]);
876 /* Move to the next ACL entry. */
877 if (pcolon[2] == ',') {
882 /* Remove the last ',' */
883 us_acl[strlen(us_acl)-1] = '\0';
885 if (guest_ok && !lp_usershare_allow_guests()) {
886 d_fprintf(stderr, _("net usershare add: guest_ok=y requested "
887 "but the \"usershare allow guests\" parameter is not "
888 "enabled by this server.\n"));
893 /* Create a temporary filename for this share. */
894 tmpfd = mkstemp(full_path_tmp);
898 _("net usershare add: cannot create tmp file %s\n"),
904 /* Ensure we opened the file we thought we did. */
905 if (sys_lstat(full_path_tmp, &lsbuf, false) != 0) {
907 _("net usershare add: cannot lstat tmp file %s\n"),
914 /* Check this is the same as the file we opened. */
915 if (sys_fstat(tmpfd, &sbuf, false) != 0) {
917 _("net usershare add: cannot fstat tmp file %s\n"),
924 if (!S_ISREG(sbuf.st_ex_mode) || sbuf.st_ex_dev != lsbuf.st_ex_dev || sbuf.st_ex_ino != lsbuf.st_ex_ino) {
926 _("net usershare add: tmp file %s is not a regular "
934 if (fchmod(tmpfd, 0644) == -1) {
936 _("net usershare add: failed to fchmod tmp file %s "
944 /* Create the in-memory image of the file. */
945 file_img = talloc_strdup(ctx, "#VERSION 2\npath=");
946 file_img = talloc_asprintf_append(file_img,
947 "%s\ncomment=%s\nusershare_acl=%s\n"
948 "guest_ok=%c\nsharename=%s\n",
952 guest_ok ? 'y' : 'n',
955 to_write = strlen(file_img);
957 if (write(tmpfd, file_img, to_write) != to_write) {
959 _("net usershare add: failed to write %u bytes to "
960 "file %s. Error was %s\n"),
961 (unsigned int)to_write, full_path_tmp, strerror(errno));
962 unlink(full_path_tmp);
968 /* Attempt to replace any existing share by this name. */
969 if (rename(full_path_tmp, full_path) != 0) {
970 unlink(full_path_tmp);
972 _("net usershare add: failed to add share %s. Error "
974 sharename, strerror(errno));
982 if (c->opt_long_list_entries) {
983 const char *my_argv[2];
984 my_argv[0] = sharename;
986 net_usershare_info(c, 1, my_argv);
994 /***************************************************************************
996 ***************************************************************************/
998 static int list_fn(struct file_list *fl, void *priv)
1000 d_printf("%s\n", fl->pathname);
1005 /***************************************************************************
1006 List userlevel shares.
1007 ***************************************************************************/
1009 static int net_usershare_list(struct net_context *c, int argc,
1013 bool only_ours = true;
1015 struct us_priv_info pi;
1018 fstrcpy(wcard, "*");
1020 if (c->display_usage)
1021 return net_usershare_list_usage(c, argc, argv);
1023 if (c->opt_long_list_entries) {
1031 fstrcpy(wcard, argv[0]);
1034 return net_usershare_list_usage(c, argc, argv);
1039 ctx = talloc_init("share_list");
1040 ret = get_share_list(ctx, wcard, only_ours);
1049 ret = process_share_list(info_fn, &pi);
1050 talloc_destroy(ctx);
1054 /***************************************************************************
1055 Entry-point for all the USERSHARE functions.
1056 ***************************************************************************/
1058 int net_usershare(struct net_context *c, int argc, const char **argv)
1062 struct functable func[] = {
1066 NET_TRANSPORT_LOCAL,
1067 N_("Add/modify user defined share"),
1068 N_("net usershare add\n"
1069 " Add/modify user defined share")
1073 net_usershare_delete,
1074 NET_TRANSPORT_LOCAL,
1075 N_("Delete user defined share"),
1076 N_("net usershare delete\n"
1077 " Delete user defined share")
1082 NET_TRANSPORT_LOCAL,
1083 N_("Display information about a user defined share"),
1084 N_("net usershare info\n"
1085 " Display information about a user defined share")
1090 NET_TRANSPORT_LOCAL,
1091 N_("List user defined shares"),
1092 N_("net usershare list\n"
1093 " List user defined shares")
1095 {NULL, NULL, 0, NULL, NULL}
1098 if (lp_usershare_max_shares() == 0) {
1100 _("net usershare: usershares are currently "
1105 dp = sys_opendir(lp_usershare_path());
1109 _("net usershare: cannot open usershare directory %s. "
1111 lp_usershare_path(), strerror(err) );
1112 if (err == EACCES) {
1114 _("You do not have permission to create a "
1115 "usershare. Ask your administrator to grant "
1116 "you permissions to create a share.\n"));
1117 } else if (err == ENOENT) {
1119 _("Please ask your system administrator to "
1120 "enable user sharing.\n"));
1126 return net_run_function(c, argc, argv, "net usershare", func);