cddl/contrib/opensolaris/lib/pyzfs/common/allow.py

   1 #! /usr/bin/python2.6
   2 #
   3 # CDDL HEADER START
   4 #
   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.
   8 #
   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.
  13 #
  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]
  19 #
  20 # CDDL HEADER END
  21 #
  22 # Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  23 #
  24
  25 """This module implements the "zfs allow" and "zfs unallow" subcommands.
  26 The only public interface is the zfs.allow.do_allow() function."""
  27
  28 import zfs.util
  29 import zfs.dataset
  30 import optparse
  31 import sys
  32 import pwd
  33 import grp
  34 import errno
  35
  36 _ = zfs.util._
  37
  38 class FSPerms(object):
  39         """This class represents all the permissions that are set on a
  40         particular filesystem (not including those inherited)."""
  41
  42         __slots__ = "create", "sets", "local", "descend", "ld"
  43         __repr__ = zfs.util.default_repr
  44
  45         def __init__(self, raw):
  46                 """Create a FSPerms based on the dict of raw permissions
  47                 from zfs.ioctl.get_fsacl()."""
  48                 # set of perms
  49                 self.create = set()
  50
  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)
  55                 self.sets = dict()
  56                 self.local = dict()
  57                 self.descend = dict()
  58                 self.ld = dict()
  59
  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()
  64                         ws = whokey[3:]
  65                         if whotypechr == "c":
  66                                 self.create.update(perms)
  67                         elif whotypechr == "s":
  68                                 nwho = "1" + ws
  69                                 self.sets.setdefault(nwho, set()).update(perms)
  70                         else:
  71                                 if whotypechr == "u":
  72                                         try:
  73                                                 name = pwd.getpwuid(int(ws)).pw_name
  74                                         except KeyError:
  75                                                 name = ws
  76                                         nwho = "1user " + name
  77                                 elif whotypechr == "g":
  78                                         try:
  79                                                 name = grp.getgrgid(int(ws)).gr_name
  80                                         except KeyError:
  81                                                 name = ws
  82                                         nwho = "2group " + name
  83                                 elif whotypechr == "e":
  84                                         nwho = "3everyone"
  85                                 else:
  86                                         raise ValueError(whotypechr)
  87
  88                                 if whokey[1] == "l":
  89                                         d = self.local
  90                                 elif whokey[1] == "d":
  91                                         d = self.descend
  92                                 else:
  93                                         raise ValueError(whokey[1])
  94
  95                                 d.setdefault(nwho, set()).update(perms)
  96
  97                 # Find perms that are in both local and descend, and
  98                 # move them to ld.
  99                 for nwho in self.local:
 100                         if nwho not in self.descend:
 101                                 continue
 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]
 106
 107         @staticmethod
 108         def __ldstr(d, header):
 109                 s = ""
 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
 114                         if perms:
 115                                 s += "\t%s %s\n" % \
 116                                     (nwho[1:], ",".join(sorted(perms)))
 117                 if s:
 118                         s = header + s
 119                 return s
 120
 121         def __str__(self):
 122                 s = self.__ldstr(self.sets, _("Permission sets:\n"))
 123
 124                 if self.create:
 125                         s += _("Create time permissions:\n")
 126                         s += "\t%s\n" % ",".join(sorted(self.create))
 127
 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"))
 131                 return s.rstrip()
 132
 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."""
 136
 137         # perms is not set if we are doing a "zfs unallow <who> <fs>" to
 138         # remove all of someone's permissions
 139         if perms:
 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] != "@"))
 143         else:
 144                 setperms = None
 145                 baseperms = None
 146
 147         d = dict()
 148
 149         def storeperm(typechr, inheritchr, arg):
 150                 assert typechr in "ugecs"
 151                 assert inheritchr in "ld-"
 152
 153                 def mkwhokey(t):
 154                         return "%c%c$%s" % (t, inheritchr, arg)
 155
 156                 if baseperms or not perms:
 157                         d[mkwhokey(typechr)] = baseperms
 158                 if setperms or not perms:
 159                         d[mkwhokey(typechr.upper())] = setperms
 160
 161         def decodeid(w, toidfunc, fmt):
 162                 try:
 163                         return int(w)
 164                 except ValueError:
 165                         try:
 166                                 return toidfunc(w)[2]
 167                         except KeyError:
 168                                 parser.error(fmt % w)
 169
 170         if options.set:
 171                 storeperm("s", "-", who)
 172         elif options.create:
 173                 storeperm("c", "-", "")
 174         else:
 175                 for w in who:
 176                         if options.user:
 177                                 id = decodeid(w, pwd.getpwnam,
 178                                     _("invalid user %s"))
 179                                 typechr = "u"
 180                         elif options.group:
 181                                 id = decodeid(w, grp.getgrnam,
 182                                     _("invalid group %s"))
 183                                 typechr = "g"
 184                         elif w == "everyone":
 185                                 id = ""
 186                                 typechr = "e"
 187                         else:
 188                                 try:
 189                                         id = pwd.getpwnam(w)[2]
 190                                         typechr = "u"
 191                                 except KeyError:
 192                                         try:
 193                                                 id = grp.getgrnam(w)[2]
 194                                                 typechr = "g"
 195                                         except KeyError:
 196                                                 parser.error(_("invalid user/group %s") % w)
 197                         if options.local:
 198                                 storeperm(typechr, "l", id)
 199                         if options.descend:
 200                                 storeperm(typechr, "d", id)
 201         return d
 202
 203 perms_subcmd = dict(
 204     create=_("Must also have the 'mount' ability"),
 205     destroy=_("Must also have the 'mount' ability"),
 206     snapshot="",
 207     rollback="",
 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"),
 218     send="",
 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"),
 222 )
 223
 224 perms_other = dict(
 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"),
 230 )
 231
 232 def hasset(ds, setname):
 233         """Return True if the given setname (string) is defined for this
 234         ds (Dataset)."""
 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:
 239                                 return True
 240         return False
 241
 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():
 246                 return permname
 247         try:
 248                 return zfs.dataset.getpropobj(permname).name
 249         except KeyError:
 250                 raise zfs.util.ZFSError(errno.EINVAL, permname,
 251                     _("invalid permission"))
 252
 253 def print_perms():
 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")))
 258
 259         for (name, note) in sorted(perms_subcmd.iteritems()):
 260                 print(fmt % (name, _("subcommand"), note))
 261
 262         for (name, note) in sorted(perms_other.iteritems()):
 263                 print(fmt % (name, _("other"), note))
 264
 265         for (name, prop) in sorted(zfs.dataset.proptable.iteritems()):
 266                 if prop.visible and prop.delegatable():
 267                         print(fmt % (name, _("property"), ""))
 268
 269 def do_allow():
 270         """Implements the "zfs allow" and "zfs unallow" subcommands."""
 271         un = (sys.argv[1] == "unallow")
 272
 273         def usage(msg=None):
 274                 parser.print_help()
 275                 print_perms()
 276                 if msg:
 277                         print
 278                         parser.exit("zfs: error: " + msg)
 279                 else:
 280                         parser.exit()
 281
 282         if un:
 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>""")
 288                 verb = _("remove")
 289                 sstr = _("undefine permission set")
 290         else:
 291                 u = _("""allow <filesystem|volume>
 292         allow [-ldug] <"everyone"|user|group>[,...] <perm|@setname>[,...]
 293             <filesystem|volume>
 294         allow [-ld] -e <perm|@setname>[,...] <filesystem|volume>
 295         allow -c <perm|@setname>[,...] <filesystem|volume>
 296         allow -s @setname <perm|@setname>[,...] <filesystem|volume>""")
 297                 verb = _("set")
 298                 sstr = _("define permission set")
 299
 300         parser = optparse.OptionParser(usage=u, prog="zfs")
 301
 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)
 315         if un:
 316                 parser.add_option("-r", action="store_true", dest="recursive",
 317                     help=_("remove permissions recursively"))
 318
 319         if len(sys.argv) == 3 and not un:
 320                 # just print the permissions on this fs
 321
 322                 if sys.argv[2] == "-h":
 323                         # hack to make "zfs allow -h" work
 324                         usage()
 325                 ds = zfs.dataset.Dataset(sys.argv[2], snaps=False)
 326
 327                 p = dict()
 328                 for (fs, raw) in ds.get_fsacl().items():
 329                         p[fs] = FSPerms(raw)
 330
 331                 for fs in sorted(p.keys(), reverse=True):
 332                         s = _("---- Permissions on %s ") % fs
 333                         print(s + "-" * (70-len(s)))
 334                         print(p[fs])
 335                 return
 336
 337
 338         (options, args) = parser.parse_args(sys.argv[2:])
 339
 340         if sum((bool(options.everyone), bool(options.user),
 341             bool(options.group))) > 1:
 342                 parser.error(_("-u, -g, and -e are mutually exclusive"))
 343
 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])
 350                 else:
 351                         usage(_("wrong number of parameters"))
 352
 353         if options.set:
 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"))
 359
 360                 (perms, fsname) = mungeargs(3)
 361                 who = args[0]
 362         elif options.create:
 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"))
 366
 367                 (perms, fsname) = mungeargs(2)
 368                 who = None
 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"))
 373
 374                 (perms, fsname) = mungeargs(2)
 375                 who = ["everyone"]
 376         else:
 377                 (perms, fsname) = mungeargs(3)
 378                 who = args[0].split(",")
 379
 380         if not options.local and not options.descend:
 381                 options.local = True
 382                 options.descend = True
 383
 384         d = args_to_perms(parser, options, who, perms)
 385
 386         ds = zfs.dataset.Dataset(fsname, snaps=False)
 387
 388         if not un and perms:
 389                 for p in perms:
 390                         if p[0] == "@" and not hasset(ds, p):
 391                                 parser.error(_("set %s is not defined") % p)
 392
 393         ds.set_fsacl(un, d)
 394         if un and options.recursive:
 395                 for child in ds.descendents():
 396                         child.set_fsacl(un, d)