4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2011 by Delphix. All rights reserved.
27 * DSL permissions are stored in a two level zap attribute
28 * mechanism. The first level identifies the "class" of
29 * entry. The class is identified by the first 2 letters of
30 * the attribute. The second letter "l" or "d" identifies whether
31 * it is a local or descendent permission. The first letter
32 * identifies the type of entry.
34 * ul$<id> identifies permissions granted locally for this userid.
35 * ud$<id> identifies permissions granted on descendent datasets for
37 * Ul$<id> identifies permission sets granted locally for this userid.
38 * Ud$<id> identifies permission sets granted on descendent datasets for
40 * gl$<id> identifies permissions granted locally for this groupid.
41 * gd$<id> identifies permissions granted on descendent datasets for
43 * Gl$<id> identifies permission sets granted locally for this groupid.
44 * Gd$<id> identifies permission sets granted on descendent datasets for
46 * el$ identifies permissions granted locally for everyone.
47 * ed$ identifies permissions granted on descendent datasets
49 * El$ identifies permission sets granted locally for everyone.
50 * Ed$ identifies permission sets granted to descendent datasets for
52 * c-$ identifies permission to create at dataset creation time.
53 * C-$ identifies permission sets to grant locally at dataset creation
55 * s-$@<name> permissions defined in specified set @<name>
56 * S-$@<name> Sets defined in named set @<name>
58 * Each of the above entities points to another zap attribute that contains one
59 * attribute for each allowed permission, such as create, destroy,...
60 * All of the "upper" case class types will specify permission set names
61 * rather than permissions.
63 * Basically it looks something like this:
64 * ul$12 -> ZAP OBJ -> permissions...
66 * The ZAP OBJ is referred to as the jump object.
70 #include <sys/dmu_objset.h>
71 #include <sys/dmu_tx.h>
72 #include <sys/dsl_dataset.h>
73 #include <sys/dsl_dir.h>
74 #include <sys/dsl_prop.h>
75 #include <sys/dsl_synctask.h>
76 #include <sys/dsl_deleg.h>
79 #include <sys/fs/zfs.h>
81 #include <sys/sunddi.h>
83 #include "zfs_deleg.h"
86 * Validate that user is allowed to delegate specified permissions.
88 * In order to delegate "create" you must have "create"
92 dsl_deleg_can_allow(char *ddname, nvlist_t *nvp, cred_t *cr)
94 nvpair_t *whopair = NULL;
97 if ((error = dsl_deleg_access(ddname, ZFS_DELEG_PERM_ALLOW, cr)) != 0)
100 while ((whopair = nvlist_next_nvpair(nvp, whopair))) {
102 nvpair_t *permpair = NULL;
104 VERIFY(nvpair_value_nvlist(whopair, &perms) == 0);
106 while ((permpair = nvlist_next_nvpair(perms, permpair))) {
107 const char *perm = nvpair_name(permpair);
109 if (strcmp(perm, ZFS_DELEG_PERM_ALLOW) == 0)
112 if ((error = dsl_deleg_access(ddname, perm, cr)) != 0)
120 * Validate that user is allowed to unallow specified permissions. They
121 * must have the 'allow' permission, and even then can only unallow
122 * perms for their uid.
125 dsl_deleg_can_unallow(char *ddname, nvlist_t *nvp, cred_t *cr)
127 nvpair_t *whopair = NULL;
131 if ((error = dsl_deleg_access(ddname, ZFS_DELEG_PERM_ALLOW, cr)) != 0)
134 (void) snprintf(idstr, sizeof (idstr), "%lld",
135 (longlong_t)crgetuid(cr));
137 while ((whopair = nvlist_next_nvpair(nvp, whopair))) {
138 zfs_deleg_who_type_t type = nvpair_name(whopair)[0];
140 if (type != ZFS_DELEG_USER &&
141 type != ZFS_DELEG_USER_SETS)
144 if (strcmp(idstr, &nvpair_name(whopair)[3]) != 0)
151 dsl_deleg_set_sync(void *arg1, void *arg2, dmu_tx_t *tx)
153 dsl_dir_t *dd = arg1;
154 nvlist_t *nvp = arg2;
155 objset_t *mos = dd->dd_pool->dp_meta_objset;
156 nvpair_t *whopair = NULL;
157 uint64_t zapobj = dd->dd_phys->dd_deleg_zapobj;
160 dmu_buf_will_dirty(dd->dd_dbuf, tx);
161 zapobj = dd->dd_phys->dd_deleg_zapobj = zap_create(mos,
162 DMU_OT_DSL_PERMS, DMU_OT_NONE, 0, tx);
165 while ((whopair = nvlist_next_nvpair(nvp, whopair))) {
166 const char *whokey = nvpair_name(whopair);
168 nvpair_t *permpair = NULL;
171 VERIFY(nvpair_value_nvlist(whopair, &perms) == 0);
173 if (zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj) != 0) {
174 jumpobj = zap_create(mos, DMU_OT_DSL_PERMS,
176 VERIFY(zap_update(mos, zapobj,
177 whokey, 8, 1, &jumpobj, tx) == 0);
180 while ((permpair = nvlist_next_nvpair(perms, permpair))) {
181 const char *perm = nvpair_name(permpair);
184 VERIFY(zap_update(mos, jumpobj,
185 perm, 8, 1, &n, tx) == 0);
186 spa_history_log_internal(LOG_DS_PERM_UPDATE,
187 dd->dd_pool->dp_spa, tx,
188 "%s %s dataset = %llu", whokey, perm,
189 dd->dd_phys->dd_head_dataset_obj);
195 dsl_deleg_unset_sync(void *arg1, void *arg2, dmu_tx_t *tx)
197 dsl_dir_t *dd = arg1;
198 nvlist_t *nvp = arg2;
199 objset_t *mos = dd->dd_pool->dp_meta_objset;
200 nvpair_t *whopair = NULL;
201 uint64_t zapobj = dd->dd_phys->dd_deleg_zapobj;
206 while ((whopair = nvlist_next_nvpair(nvp, whopair))) {
207 const char *whokey = nvpair_name(whopair);
209 nvpair_t *permpair = NULL;
212 if (nvpair_value_nvlist(whopair, &perms) != 0) {
213 if (zap_lookup(mos, zapobj, whokey, 8,
215 (void) zap_remove(mos, zapobj, whokey, tx);
216 VERIFY(0 == zap_destroy(mos, jumpobj, tx));
218 spa_history_log_internal(LOG_DS_PERM_WHO_REMOVE,
219 dd->dd_pool->dp_spa, tx,
220 "%s dataset = %llu", whokey,
221 dd->dd_phys->dd_head_dataset_obj);
225 if (zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj) != 0)
228 while ((permpair = nvlist_next_nvpair(perms, permpair))) {
229 const char *perm = nvpair_name(permpair);
232 (void) zap_remove(mos, jumpobj, perm, tx);
233 if (zap_count(mos, jumpobj, &n) == 0 && n == 0) {
234 (void) zap_remove(mos, zapobj,
236 VERIFY(0 == zap_destroy(mos,
239 spa_history_log_internal(LOG_DS_PERM_REMOVE,
240 dd->dd_pool->dp_spa, tx,
241 "%s %s dataset = %llu", whokey, perm,
242 dd->dd_phys->dd_head_dataset_obj);
248 dsl_deleg_set(const char *ddname, nvlist_t *nvp, boolean_t unset)
252 nvpair_t *whopair = NULL;
253 int blocks_modified = 0;
255 error = dsl_dir_open(ddname, FTAG, &dd, NULL);
259 if (spa_version(dmu_objset_spa(dd->dd_pool->dp_meta_objset)) <
260 SPA_VERSION_DELEGATED_PERMS) {
261 dsl_dir_close(dd, FTAG);
265 while ((whopair = nvlist_next_nvpair(nvp, whopair)))
268 error = dsl_sync_task_do(dd->dd_pool, NULL,
269 unset ? dsl_deleg_unset_sync : dsl_deleg_set_sync,
270 dd, nvp, blocks_modified);
271 dsl_dir_close(dd, FTAG);
277 * Find all 'allow' permissions from a given point and then continue
278 * traversing up to the root.
280 * This function constructs an nvlist of nvlists.
281 * each setpoint is an nvlist composed of an nvlist of an nvlist
282 * of the individual * users/groups/everyone/create
285 * The nvlist will look like this.
287 * { source fsname -> { whokeys { permissions,...}, ...}}
289 * The fsname nvpairs will be arranged in a bottom up order. For example,
290 * if we have the following structure a/b/c then the nvpairs for the fsnames
291 * will be ordered a/b/c, a/b, a.
294 dsl_deleg_get(const char *ddname, nvlist_t **nvp)
296 dsl_dir_t *dd, *startdd;
300 zap_cursor_t *basezc, *zc;
301 zap_attribute_t *baseza, *za;
304 error = dsl_dir_open(ddname, FTAG, &startdd, NULL);
308 dp = startdd->dd_pool;
309 mos = dp->dp_meta_objset;
311 zc = kmem_alloc(sizeof(zap_cursor_t), KM_SLEEP);
312 za = kmem_alloc(sizeof(zap_attribute_t), KM_SLEEP);
313 basezc = kmem_alloc(sizeof(zap_cursor_t), KM_SLEEP);
314 baseza = kmem_alloc(sizeof(zap_attribute_t), KM_SLEEP);
315 source = kmem_alloc(MAXNAMELEN + strlen(MOS_DIR_NAME) + 1, KM_SLEEP);
316 VERIFY(nvlist_alloc(nvp, NV_UNIQUE_NAME, KM_SLEEP) == 0);
318 rw_enter(&dp->dp_config_rwlock, RW_READER);
319 for (dd = startdd; dd != NULL; dd = dd->dd_parent) {
323 if (dd->dd_phys->dd_deleg_zapobj &&
324 (zap_count(mos, dd->dd_phys->dd_deleg_zapobj,
326 VERIFY(nvlist_alloc(&sp_nvp,
327 NV_UNIQUE_NAME, KM_SLEEP) == 0);
332 for (zap_cursor_init(basezc, mos,
333 dd->dd_phys->dd_deleg_zapobj);
334 zap_cursor_retrieve(basezc, baseza) == 0;
335 zap_cursor_advance(basezc)) {
338 ASSERT(baseza->za_integer_length == 8);
339 ASSERT(baseza->za_num_integers == 1);
341 VERIFY(nvlist_alloc(&perms_nvp,
342 NV_UNIQUE_NAME, KM_SLEEP) == 0);
343 for (zap_cursor_init(zc, mos, baseza->za_first_integer);
344 zap_cursor_retrieve(zc, za) == 0;
345 zap_cursor_advance(zc)) {
346 VERIFY(nvlist_add_boolean(perms_nvp,
350 VERIFY(nvlist_add_nvlist(sp_nvp, baseza->za_name,
352 nvlist_free(perms_nvp);
355 zap_cursor_fini(basezc);
357 dsl_dir_name(dd, source);
358 VERIFY(nvlist_add_nvlist(*nvp, source, sp_nvp) == 0);
361 rw_exit(&dp->dp_config_rwlock);
363 kmem_free(source, MAXNAMELEN + strlen(MOS_DIR_NAME) + 1);
364 kmem_free(baseza, sizeof(zap_attribute_t));
365 kmem_free(basezc, sizeof(zap_cursor_t));
366 kmem_free(za, sizeof(zap_attribute_t));
367 kmem_free(zc, sizeof(zap_cursor_t));
369 dsl_dir_close(startdd, FTAG);
374 * Routines for dsl_deleg_access() -- access checking.
376 typedef struct perm_set {
379 char p_setname[ZFS_MAX_DELEG_NAME];
383 perm_set_compare(const void *arg1, const void *arg2)
385 const perm_set_t *node1 = arg1;
386 const perm_set_t *node2 = arg2;
389 val = strcmp(node1->p_setname, node2->p_setname);
392 return (val > 0 ? 1 : -1);
396 * Determine whether a specified permission exists.
398 * First the base attribute has to be retrieved. i.e. ul$12
399 * Once the base object has been retrieved the actual permission
400 * is lookup up in the zap object the base object points to.
402 * Return 0 if permission exists, ENOENT if there is no whokey, EPERM if
403 * there is no perm in that jumpobj.
406 dsl_check_access(objset_t *mos, uint64_t zapobj,
407 char type, char checkflag, void *valp, const char *perm)
410 uint64_t jumpobj, zero;
411 char whokey[ZFS_MAX_DELEG_NAME];
413 zfs_deleg_whokey(whokey, type, checkflag, valp);
414 error = zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj);
416 error = zap_lookup(mos, jumpobj, perm, 8, 1, &zero);
424 * check a specified user/group for a requested permission
427 dsl_check_user_access(objset_t *mos, uint64_t zapobj, const char *perm,
428 int checkflag, cred_t *cr)
437 if (dsl_check_access(mos, zapobj,
438 ZFS_DELEG_USER, checkflag, &id, perm) == 0)
441 /* check for users primary group */
443 if (dsl_check_access(mos, zapobj,
444 ZFS_DELEG_GROUP, checkflag, &id, perm) == 0)
447 /* check for everyone entry */
449 if (dsl_check_access(mos, zapobj,
450 ZFS_DELEG_EVERYONE, checkflag, &id, perm) == 0)
453 /* check each supplemental group user is a member of */
454 ngids = crgetngroups(cr);
455 gids = crgetgroups(cr);
456 for (i = 0; i != ngids; i++) {
458 if (dsl_check_access(mos, zapobj,
459 ZFS_DELEG_GROUP, checkflag, &id, perm) == 0)
467 * Iterate over the sets specified in the specified zapobj
468 * and load them into the permsets avl tree.
471 dsl_load_sets(objset_t *mos, uint64_t zapobj,
472 char type, char checkflag, void *valp, avl_tree_t *avl)
476 perm_set_t *permnode;
480 char whokey[ZFS_MAX_DELEG_NAME];
482 zfs_deleg_whokey(whokey, type, checkflag, valp);
484 error = zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj);
488 for (zap_cursor_init(&zc, mos, jumpobj);
489 zap_cursor_retrieve(&zc, &za) == 0;
490 zap_cursor_advance(&zc)) {
491 permnode = kmem_alloc(sizeof (perm_set_t), KM_SLEEP);
492 (void) strlcpy(permnode->p_setname, za.za_name,
493 sizeof (permnode->p_setname));
494 permnode->p_matched = B_FALSE;
496 if (avl_find(avl, permnode, &idx) == NULL) {
497 avl_insert(avl, permnode, idx);
499 kmem_free(permnode, sizeof (perm_set_t));
502 zap_cursor_fini(&zc);
507 * Load all permissions user based on cred belongs to.
510 dsl_load_user_sets(objset_t *mos, uint64_t zapobj, avl_tree_t *avl,
511 char checkflag, cred_t *cr)
518 (void) dsl_load_sets(mos, zapobj,
519 ZFS_DELEG_USER_SETS, checkflag, &id, avl);
522 (void) dsl_load_sets(mos, zapobj,
523 ZFS_DELEG_GROUP_SETS, checkflag, &id, avl);
525 (void) dsl_load_sets(mos, zapobj,
526 ZFS_DELEG_EVERYONE_SETS, checkflag, NULL, avl);
528 ngids = crgetngroups(cr);
529 gids = crgetgroups(cr);
530 for (i = 0; i != ngids; i++) {
532 (void) dsl_load_sets(mos, zapobj,
533 ZFS_DELEG_GROUP_SETS, checkflag, &id, avl);
538 * Check if user has requested permission. If descendent is set, must have
542 dsl_deleg_access_impl(dsl_dataset_t *ds, boolean_t descendent, const char *perm,
554 dp = ds->ds_dir->dd_pool;
555 mos = dp->dp_meta_objset;
557 if (dsl_delegation_on(mos) == B_FALSE)
560 if (spa_version(dmu_objset_spa(dp->dp_meta_objset)) <
561 SPA_VERSION_DELEGATED_PERMS)
564 if (dsl_dataset_is_snapshot(ds) || descendent) {
566 * Snapshots are treated as descendents only,
567 * local permissions do not apply.
569 checkflag = ZFS_DELEG_DESCENDENT;
571 checkflag = ZFS_DELEG_LOCAL;
574 avl_create(&permsets, perm_set_compare, sizeof (perm_set_t),
575 offsetof(perm_set_t, p_node));
577 rw_enter(&dp->dp_config_rwlock, RW_READER);
578 for (dd = ds->ds_dir; dd != NULL; dd = dd->dd_parent,
579 checkflag = ZFS_DELEG_DESCENDENT) {
584 * If not in global zone then make sure
585 * the zoned property is set
587 if (!INGLOBALZONE(curproc)) {
590 if (dsl_prop_get_dd(dd,
591 zfs_prop_to_name(ZFS_PROP_ZONED),
592 8, 1, &zoned, NULL, B_FALSE) != 0)
597 zapobj = dd->dd_phys->dd_deleg_zapobj;
602 dsl_load_user_sets(mos, zapobj, &permsets, checkflag, cr);
605 for (setnode = avl_first(&permsets); setnode;
606 setnode = AVL_NEXT(&permsets, setnode)) {
607 if (setnode->p_matched == B_TRUE)
610 /* See if this set directly grants this permission */
611 error = dsl_check_access(mos, zapobj,
612 ZFS_DELEG_NAMED_SET, 0, setnode->p_setname, perm);
616 setnode->p_matched = B_TRUE;
618 /* See if this set includes other sets */
619 error = dsl_load_sets(mos, zapobj,
620 ZFS_DELEG_NAMED_SET_SETS, 0,
621 setnode->p_setname, &permsets);
623 setnode->p_matched = expanded = B_TRUE;
626 * If we expanded any sets, that will define more sets,
627 * which we need to check.
632 error = dsl_check_user_access(mos, zapobj, perm, checkflag, cr);
638 rw_exit(&dp->dp_config_rwlock);
641 while ((setnode = avl_destroy_nodes(&permsets, &cookie)) != NULL)
642 kmem_free(setnode, sizeof (perm_set_t));
648 dsl_deleg_access(const char *dsname, const char *perm, cred_t *cr)
653 error = dsl_dataset_hold(dsname, FTAG, &ds);
657 error = dsl_deleg_access_impl(ds, B_FALSE, perm, cr);
658 dsl_dataset_rele(ds, FTAG);
668 copy_create_perms(dsl_dir_t *dd, uint64_t pzapobj,
669 boolean_t dosets, uint64_t uid, dmu_tx_t *tx)
671 objset_t *mos = dd->dd_pool->dp_meta_objset;
672 uint64_t jumpobj, pjumpobj;
673 uint64_t zapobj = dd->dd_phys->dd_deleg_zapobj;
676 char whokey[ZFS_MAX_DELEG_NAME];
678 zfs_deleg_whokey(whokey,
679 dosets ? ZFS_DELEG_CREATE_SETS : ZFS_DELEG_CREATE,
680 ZFS_DELEG_LOCAL, NULL);
681 if (zap_lookup(mos, pzapobj, whokey, 8, 1, &pjumpobj) != 0)
685 dmu_buf_will_dirty(dd->dd_dbuf, tx);
686 zapobj = dd->dd_phys->dd_deleg_zapobj = zap_create(mos,
687 DMU_OT_DSL_PERMS, DMU_OT_NONE, 0, tx);
690 zfs_deleg_whokey(whokey,
691 dosets ? ZFS_DELEG_USER_SETS : ZFS_DELEG_USER,
692 ZFS_DELEG_LOCAL, &uid);
693 if (zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj) == ENOENT) {
694 jumpobj = zap_create(mos, DMU_OT_DSL_PERMS, DMU_OT_NONE, 0, tx);
695 VERIFY(zap_add(mos, zapobj, whokey, 8, 1, &jumpobj, tx) == 0);
698 for (zap_cursor_init(&zc, mos, pjumpobj);
699 zap_cursor_retrieve(&zc, &za) == 0;
700 zap_cursor_advance(&zc)) {
702 ASSERT(za.za_integer_length == 8 && za.za_num_integers == 1);
704 VERIFY(zap_update(mos, jumpobj, za.za_name,
705 8, 1, &zero, tx) == 0);
707 zap_cursor_fini(&zc);
711 * set all create time permission on new dataset.
714 dsl_deleg_set_create_perms(dsl_dir_t *sdd, dmu_tx_t *tx, cred_t *cr)
717 uint64_t uid = crgetuid(cr);
719 if (spa_version(dmu_objset_spa(sdd->dd_pool->dp_meta_objset)) <
720 SPA_VERSION_DELEGATED_PERMS)
723 for (dd = sdd->dd_parent; dd != NULL; dd = dd->dd_parent) {
724 uint64_t pzapobj = dd->dd_phys->dd_deleg_zapobj;
729 copy_create_perms(sdd, pzapobj, B_FALSE, uid, tx);
730 copy_create_perms(sdd, pzapobj, B_TRUE, uid, tx);
735 dsl_deleg_destroy(objset_t *mos, uint64_t zapobj, dmu_tx_t *tx)
743 for (zap_cursor_init(&zc, mos, zapobj);
744 zap_cursor_retrieve(&zc, &za) == 0;
745 zap_cursor_advance(&zc)) {
746 ASSERT(za.za_integer_length == 8 && za.za_num_integers == 1);
747 VERIFY(0 == zap_destroy(mos, za.za_first_integer, tx));
749 zap_cursor_fini(&zc);
750 VERIFY(0 == zap_destroy(mos, zapobj, tx));
755 dsl_delegation_on(objset_t *os)
757 return (!!spa_delegation(os->os_spa));
760 #if defined(_KERNEL) && defined(HAVE_SPL)
761 EXPORT_SYMBOL(dsl_deleg_get);
762 EXPORT_SYMBOL(dsl_deleg_set);