5 # The contents of this file are subject to the terms of the
6 # Common Development and Distribution License (the "License").
7 # You may not use this file except in compliance with the License.
9 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 # or http://www.opensolaris.org/os/licensing.
11 # See the License for the specific language governing permissions
12 # and limitations under the License.
14 # When distributing Covered Code, include this CDDL HEADER in each
15 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 # If applicable, add the following below this CDDL HEADER, with the
17 # fields enclosed by brackets "[]" replaced with your own identifying
18 # information: Portions Copyright [yyyy] [name of copyright owner]
22 # Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
25 """This module implements the "zfs allow" and "zfs unallow" subcommands.
26 The only public interface is the zfs.allow.do_allow() function."""
38 class FSPerms(object):
39 """This class represents all the permissions that are set on a
40 particular filesystem (not including those inherited)."""
42 __slots__ = "create", "sets", "local", "descend", "ld"
43 __repr__ = zfs.util.default_repr
45 def __init__(self, raw):
46 """Create a FSPerms based on the dict of raw permissions
47 from zfs.ioctl.get_fsacl()."""
51 # below are { "Ntype name": set(perms) }
52 # where N is a number that we just use for sorting,
53 # type is "user", "group", "everyone", or "" (for sets)
54 # name is a user, group, or set name, or "" (for everyone)
60 # see the comment in dsl_deleg.c for the definition of whokey
61 for whokey in raw.keys():
62 perms = raw[whokey].keys()
63 whotypechr = whokey[0].lower()
66 self.create.update(perms)
67 elif whotypechr == "s":
69 self.sets.setdefault(nwho, set()).update(perms)
73 name = pwd.getpwuid(int(ws)).pw_name
76 nwho = "1user " + name
77 elif whotypechr == "g":
79 name = grp.getgrgid(int(ws)).gr_name
82 nwho = "2group " + name
83 elif whotypechr == "e":
86 raise ValueError(whotypechr)
90 elif whokey[1] == "d":
93 raise ValueError(whokey[1])
95 d.setdefault(nwho, set()).update(perms)
97 # Find perms that are in both local and descend, and
99 for nwho in self.local:
100 if nwho not in self.descend:
102 # note: these are set operations
103 self.ld[nwho] = self.local[nwho] & self.descend[nwho]
104 self.local[nwho] -= self.ld[nwho]
105 self.descend[nwho] -= self.ld[nwho]
108 def __ldstr(d, header):
110 for (nwho, perms) in sorted(d.items()):
111 # local and descend may have entries where perms
112 # is an empty set, due to consolidating all
113 # permissions into ld
116 (nwho[1:], ",".join(sorted(perms)))
122 s = self.__ldstr(self.sets, _("Permission sets:\n"))
125 s += _("Create time permissions:\n")
126 s += "\t%s\n" % ",".join(sorted(self.create))
128 s += self.__ldstr(self.local, _("Local permissions:\n"))
129 s += self.__ldstr(self.descend, _("Descendent permissions:\n"))
130 s += self.__ldstr(self.ld, _("Local+Descendent permissions:\n"))
133 def args_to_perms(parser, options, who, perms):
134 """Return a dict of raw perms {"whostr" -> {"perm" -> None}}
135 based on the command-line input."""
137 # perms is not set if we are doing a "zfs unallow <who> <fs>" to
138 # remove all of someone's permissions
140 setperms = dict(((p, None) for p in perms if p[0] == "@"))
141 baseperms = dict(((canonicalized_perm(p), None)
142 for p in perms if p[0] != "@"))
149 def storeperm(typechr, inheritchr, arg):
150 assert typechr in "ugecs"
151 assert inheritchr in "ld-"
154 return "%c%c$%s" % (t, inheritchr, arg)
156 if baseperms or not perms:
157 d[mkwhokey(typechr)] = baseperms
158 if setperms or not perms:
159 d[mkwhokey(typechr.upper())] = setperms
161 def decodeid(w, toidfunc, fmt):
166 return toidfunc(w)[2]
168 parser.error(fmt % w)
171 storeperm("s", "-", who)
173 storeperm("c", "-", "")
177 id = decodeid(w, pwd.getpwnam,
178 _("invalid user %s"))
181 id = decodeid(w, grp.getgrnam,
182 _("invalid group %s"))
184 elif w == "everyone":
189 id = pwd.getpwnam(w)[2]
193 id = grp.getgrnam(w)[2]
196 parser.error(_("invalid user/group %s") % w)
198 storeperm(typechr, "l", id)
200 storeperm(typechr, "d", id)
204 create=_("Must also have the 'mount' ability"),
205 destroy=_("Must also have the 'mount' ability"),
208 clone=_("""Must also have the 'create' ability and 'mount'
209 \t\t\t\tability in the origin file system"""),
210 promote=_("""Must also have the 'mount'
211 \t\t\t\tand 'promote' ability in the origin file system"""),
212 rename=_("""Must also have the 'mount' and 'create'
213 \t\t\t\tability in the new parent"""),
214 receive=_("Must also have the 'mount' and 'create' ability"),
215 allow=_("Must also have the permission that is being\n\t\t\t\tallowed"),
216 mount=_("Allows mount/umount of ZFS datasets"),
217 share=_("Allows sharing file systems over NFS or SMB\n\t\t\t\tprotocols"),
219 hold=_("Allows adding a user hold to a snapshot"),
220 release=_("Allows releasing a user hold which\n\t\t\t\tmight destroy the snapshot"),
221 diff=_("Allows lookup of paths within a dataset,\n\t\t\t\tgiven an object number. Ordinary users need this\n\t\t\t\tin order to use zfs diff"),
225 userprop=_("Allows changing any user property"),
226 userquota=_("Allows accessing any userquota@... property"),
227 groupquota=_("Allows accessing any groupquota@... property"),
228 userused=_("Allows reading any userused@... property"),
229 groupused=_("Allows reading any groupused@... property"),
232 def hasset(ds, setname):
233 """Return True if the given setname (string) is defined for this
235 # It would be nice to cache the result of get_fsacl().
236 for raw in ds.get_fsacl().values():
237 for whokey in raw.keys():
238 if whokey[0].lower() == "s" and whokey[3:] == setname:
242 def canonicalized_perm(permname):
243 """Return the canonical name (string) for this permission (string).
244 Raises ZFSError if it is not a valid permission."""
245 if permname in perms_subcmd.keys() or permname in perms_other.keys():
248 return zfs.dataset.getpropobj(permname).name
250 raise zfs.util.ZFSError(errno.EINVAL, permname,
251 _("invalid permission"))
254 """Print the set of supported permissions."""
255 print(_("\nThe following permissions are supported:\n"))
256 fmt = "%-16s %-14s\t%s"
257 print(fmt % (_("NAME"), _("TYPE"), _("NOTES")))
259 for (name, note) in sorted(perms_subcmd.iteritems()):
260 print(fmt % (name, _("subcommand"), note))
262 for (name, note) in sorted(perms_other.iteritems()):
263 print(fmt % (name, _("other"), note))
265 for (name, prop) in sorted(zfs.dataset.proptable.iteritems()):
266 if prop.visible and prop.delegatable():
267 print(fmt % (name, _("property"), ""))
270 """Implements the "zfs allow" and "zfs unallow" subcommands."""
271 un = (sys.argv[1] == "unallow")
278 parser.exit("zfs: error: " + msg)
283 u = _("""unallow [-rldug] <"everyone"|user|group>[,...]
284 [<perm|@setname>[,...]] <filesystem|volume>
285 unallow [-rld] -e [<perm|@setname>[,...]] <filesystem|volume>
286 unallow [-r] -c [<perm|@setname>[,...]] <filesystem|volume>
287 unallow [-r] -s @setname [<perm|@setname>[,...]] <filesystem|volume>""")
289 sstr = _("undefine permission set")
291 u = _("""allow <filesystem|volume>
292 allow [-ldug] <"everyone"|user|group>[,...] <perm|@setname>[,...]
294 allow [-ld] -e <perm|@setname>[,...] <filesystem|volume>
295 allow -c <perm|@setname>[,...] <filesystem|volume>
296 allow -s @setname <perm|@setname>[,...] <filesystem|volume>""")
298 sstr = _("define permission set")
300 parser = optparse.OptionParser(usage=u, prog="zfs")
302 parser.add_option("-l", action="store_true", dest="local",
303 help=_("%s permission locally") % verb)
304 parser.add_option("-d", action="store_true", dest="descend",
305 help=_("%s permission for descendents") % verb)
306 parser.add_option("-u", action="store_true", dest="user",
307 help=_("%s permission for user") % verb)
308 parser.add_option("-g", action="store_true", dest="group",
309 help=_("%s permission for group") % verb)
310 parser.add_option("-e", action="store_true", dest="everyone",
311 help=_("%s permission for everyone") % verb)
312 parser.add_option("-c", action="store_true", dest="create",
313 help=_("%s create time permissions") % verb)
314 parser.add_option("-s", action="store_true", dest="set", help=sstr)
316 parser.add_option("-r", action="store_true", dest="recursive",
317 help=_("remove permissions recursively"))
319 if len(sys.argv) == 3 and not un:
320 # just print the permissions on this fs
322 if sys.argv[2] == "-h":
323 # hack to make "zfs allow -h" work
325 ds = zfs.dataset.Dataset(sys.argv[2], snaps=False)
328 for (fs, raw) in ds.get_fsacl().items():
331 for fs in sorted(p.keys(), reverse=True):
332 s = _("---- Permissions on %s ") % fs
333 print(s + "-" * (70-len(s)))
338 (options, args) = parser.parse_args(sys.argv[2:])
340 if sum((bool(options.everyone), bool(options.user),
341 bool(options.group))) > 1:
342 parser.error(_("-u, -g, and -e are mutually exclusive"))
344 def mungeargs(expected_len):
345 if un and len(args) == expected_len-1:
346 return (None, args[expected_len-2])
347 elif len(args) == expected_len:
348 return (args[expected_len-2].split(","),
349 args[expected_len-1])
351 usage(_("wrong number of parameters"))
354 if options.local or options.descend or options.user or \
355 options.group or options.everyone or options.create:
356 parser.error(_("invalid option combined with -s"))
357 if args[0][0] != "@":
358 parser.error(_("invalid set name: missing '@' prefix"))
360 (perms, fsname) = mungeargs(3)
363 if options.local or options.descend or options.user or \
364 options.group or options.everyone or options.set:
365 parser.error(_("invalid option combined with -c"))
367 (perms, fsname) = mungeargs(2)
369 elif options.everyone:
370 if options.user or options.group or \
371 options.create or options.set:
372 parser.error(_("invalid option combined with -e"))
374 (perms, fsname) = mungeargs(2)
377 (perms, fsname) = mungeargs(3)
378 who = args[0].split(",")
380 if not options.local and not options.descend:
382 options.descend = True
384 d = args_to_perms(parser, options, who, perms)
386 ds = zfs.dataset.Dataset(fsname, snaps=False)
390 if p[0] == "@" and not hasset(ds, p):
391 parser.error(_("set %s is not defined") % p)
394 if un and options.recursive:
395 for child in ds.descendents():
396 child.set_fsacl(un, d)