dsl_deleg.c

Go to the documentation of this file.

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2012 by Delphix. All rights reserved.
 */

#include <sys/dmu.h>
#include <sys/dmu_objset.h>
#include <sys/dmu_tx.h>
#include <sys/dsl_dataset.h>
#include <sys/dsl_dir.h>
#include <sys/dsl_prop.h>
#include <sys/dsl_synctask.h>
#include <sys/dsl_deleg.h>
#include <sys/spa.h>
#include <sys/zap.h>
#include <sys/fs/zfs.h>
#include <sys/cred.h>
#include <sys/sunddi.h>

#include "zfs_deleg.h"

int
dsl_deleg_can_allow(char *ddname, nvlist_t *nvp, cred_t *cr)
{
        nvpair_t *whopair = NULL;
        int error;

        if ((error = dsl_deleg_access(ddname, ZFS_DELEG_PERM_ALLOW, cr)) != 0)
                return (error);

        while (whopair = nvlist_next_nvpair(nvp, whopair)) {
                nvlist_t *perms;
                nvpair_t *permpair = NULL;

                VERIFY(nvpair_value_nvlist(whopair, &perms) == 0);

                while (permpair = nvlist_next_nvpair(perms, permpair)) {
                        const char *perm = nvpair_name(permpair);

                        if (strcmp(perm, ZFS_DELEG_PERM_ALLOW) == 0)
                                return (EPERM);

                        if ((error = dsl_deleg_access(ddname, perm, cr)) != 0)
                                return (error);
                }
        }
        return (0);
}

int
dsl_deleg_can_unallow(char *ddname, nvlist_t *nvp, cred_t *cr)
{
        nvpair_t *whopair = NULL;
        int error;
        char idstr[32];

        if ((error = dsl_deleg_access(ddname, ZFS_DELEG_PERM_ALLOW, cr)) != 0)
                return (error);

        (void) snprintf(idstr, sizeof (idstr), "%lld",
            (longlong_t)crgetuid(cr));

        while (whopair = nvlist_next_nvpair(nvp, whopair)) {
                zfs_deleg_who_type_t type = nvpair_name(whopair)[0];

                if (type != ZFS_DELEG_USER &&
                    type != ZFS_DELEG_USER_SETS)
                        return (EPERM);

                if (strcmp(idstr, &nvpair_name(whopair)[3]) != 0)
                        return (EPERM);
        }
        return (0);
}

static void
dsl_deleg_set_sync(void *arg1, void *arg2, dmu_tx_t *tx)
{
        dsl_dir_t *dd = arg1;
        nvlist_t *nvp = arg2;
        objset_t *mos = dd->dd_pool->dp_meta_objset;
        nvpair_t *whopair = NULL;
        uint64_t zapobj = dd->dd_phys->dd_deleg_zapobj;

        if (zapobj == 0) {
                dmu_buf_will_dirty(dd->dd_dbuf, tx);
                zapobj = dd->dd_phys->dd_deleg_zapobj = zap_create(mos,
                    DMU_OT_DSL_PERMS, DMU_OT_NONE, 0, tx);
        }

        while (whopair = nvlist_next_nvpair(nvp, whopair)) {
                const char *whokey = nvpair_name(whopair);
                nvlist_t *perms;
                nvpair_t *permpair = NULL;
                uint64_t jumpobj;

                VERIFY(nvpair_value_nvlist(whopair, &perms) == 0);

                if (zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj) != 0) {
                        jumpobj = zap_create_link(mos, DMU_OT_DSL_PERMS,
                            zapobj, whokey, tx);
                }

                while (permpair = nvlist_next_nvpair(perms, permpair)) {
                        const char *perm = nvpair_name(permpair);
                        uint64_t n = 0;

                        VERIFY(zap_update(mos, jumpobj,
                            perm, 8, 1, &n, tx) == 0);
                        spa_history_log_internal(LOG_DS_PERM_UPDATE,
                            dd->dd_pool->dp_spa, tx,
                            "%s %s dataset = %llu", whokey, perm,
                            dd->dd_phys->dd_head_dataset_obj);
                }
        }
}

static void
dsl_deleg_unset_sync(void *arg1, void *arg2, dmu_tx_t *tx)
{
        dsl_dir_t *dd = arg1;
        nvlist_t *nvp = arg2;
        objset_t *mos = dd->dd_pool->dp_meta_objset;
        nvpair_t *whopair = NULL;
        uint64_t zapobj = dd->dd_phys->dd_deleg_zapobj;

        if (zapobj == 0)
                return;

        while (whopair = nvlist_next_nvpair(nvp, whopair)) {
                const char *whokey = nvpair_name(whopair);
                nvlist_t *perms;
                nvpair_t *permpair = NULL;
                uint64_t jumpobj;

                if (nvpair_value_nvlist(whopair, &perms) != 0) {
                        if (zap_lookup(mos, zapobj, whokey, 8,
                            1, &jumpobj) == 0) {
                                (void) zap_remove(mos, zapobj, whokey, tx);
                                VERIFY(0 == zap_destroy(mos, jumpobj, tx));
                        }
                        spa_history_log_internal(LOG_DS_PERM_WHO_REMOVE,
                            dd->dd_pool->dp_spa, tx,
                            "%s dataset = %llu", whokey,
                            dd->dd_phys->dd_head_dataset_obj);
                        continue;
                }

                if (zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj) != 0)
                        continue;

                while (permpair = nvlist_next_nvpair(perms, permpair)) {
                        const char *perm = nvpair_name(permpair);
                        uint64_t n = 0;

                        (void) zap_remove(mos, jumpobj, perm, tx);
                        if (zap_count(mos, jumpobj, &n) == 0 && n == 0) {
                                (void) zap_remove(mos, zapobj,
                                    whokey, tx);
                                VERIFY(0 == zap_destroy(mos,
                                    jumpobj, tx));
                        }
                        spa_history_log_internal(LOG_DS_PERM_REMOVE,
                            dd->dd_pool->dp_spa, tx,
                            "%s %s dataset = %llu", whokey, perm,
                            dd->dd_phys->dd_head_dataset_obj);
                }
        }
}

int
dsl_deleg_set(const char *ddname, nvlist_t *nvp, boolean_t unset)
{
        dsl_dir_t *dd;
        int error;
        nvpair_t *whopair = NULL;
        int blocks_modified = 0;

        error = dsl_dir_open(ddname, FTAG, &dd, NULL);
        if (error)
                return (error);

        if (spa_version(dmu_objset_spa(dd->dd_pool->dp_meta_objset)) <
            SPA_VERSION_DELEGATED_PERMS) {
                dsl_dir_close(dd, FTAG);
                return (ENOTSUP);
        }

        while (whopair = nvlist_next_nvpair(nvp, whopair))
                blocks_modified++;

        error = dsl_sync_task_do(dd->dd_pool, NULL,
            unset ? dsl_deleg_unset_sync : dsl_deleg_set_sync,
            dd, nvp, blocks_modified);
        dsl_dir_close(dd, FTAG);

        return (error);
}

int
dsl_deleg_get(const char *ddname, nvlist_t **nvp)
{
        dsl_dir_t *dd, *startdd;
        dsl_pool_t *dp;
        int error;
        objset_t *mos;

        error = dsl_dir_open(ddname, FTAG, &startdd, NULL);
        if (error)
                return (error);

        dp = startdd->dd_pool;
        mos = dp->dp_meta_objset;

        VERIFY(nvlist_alloc(nvp, NV_UNIQUE_NAME, KM_SLEEP) == 0);

        rw_enter(&dp->dp_config_rwlock, RW_READER);
        for (dd = startdd; dd != NULL; dd = dd->dd_parent) {
                zap_cursor_t basezc;
                zap_attribute_t baseza;
                nvlist_t *sp_nvp;
                uint64_t n;
                char source[MAXNAMELEN];

                if (dd->dd_phys->dd_deleg_zapobj &&
                    (zap_count(mos, dd->dd_phys->dd_deleg_zapobj,
                    &n) == 0) && n) {
                        VERIFY(nvlist_alloc(&sp_nvp,
                            NV_UNIQUE_NAME, KM_SLEEP) == 0);
                } else {
                        continue;
                }

                for (zap_cursor_init(&basezc, mos,
                    dd->dd_phys->dd_deleg_zapobj);
                    zap_cursor_retrieve(&basezc, &baseza) == 0;
                    zap_cursor_advance(&basezc)) {
                        zap_cursor_t zc;
                        zap_attribute_t za;
                        nvlist_t *perms_nvp;

                        ASSERT(baseza.za_integer_length == 8);
                        ASSERT(baseza.za_num_integers == 1);

                        VERIFY(nvlist_alloc(&perms_nvp,
                            NV_UNIQUE_NAME, KM_SLEEP) == 0);
                        for (zap_cursor_init(&zc, mos, baseza.za_first_integer);
                            zap_cursor_retrieve(&zc, &za) == 0;
                            zap_cursor_advance(&zc)) {
                                VERIFY(nvlist_add_boolean(perms_nvp,
                                    za.za_name) == 0);
                        }
                        zap_cursor_fini(&zc);
                        VERIFY(nvlist_add_nvlist(sp_nvp, baseza.za_name,
                            perms_nvp) == 0);
                        nvlist_free(perms_nvp);
                }

                zap_cursor_fini(&basezc);

                dsl_dir_name(dd, source);
                VERIFY(nvlist_add_nvlist(*nvp, source, sp_nvp) == 0);
                nvlist_free(sp_nvp);
        }
        rw_exit(&dp->dp_config_rwlock);

        dsl_dir_close(startdd, FTAG);
        return (0);
}

typedef struct perm_set {
        avl_node_t      p_node;
        boolean_t       p_matched;
        char            p_setname[ZFS_MAX_DELEG_NAME];
} perm_set_t;

static int
perm_set_compare(const void *arg1, const void *arg2)
{
        const perm_set_t *node1 = arg1;
        const perm_set_t *node2 = arg2;
        int val;

        val = strcmp(node1->p_setname, node2->p_setname);
        if (val == 0)
                return (0);
        return (val > 0 ? 1 : -1);
}

static int
dsl_check_access(objset_t *mos, uint64_t zapobj,
    char type, char checkflag, void *valp, const char *perm)
{
        int error;
        uint64_t jumpobj, zero;
        char whokey[ZFS_MAX_DELEG_NAME];

        zfs_deleg_whokey(whokey, type, checkflag, valp);
        error = zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj);
        if (error == 0) {
                error = zap_lookup(mos, jumpobj, perm, 8, 1, &zero);
                if (error == ENOENT)
                        error = EPERM;
        }
        return (error);
}

static int
dsl_check_user_access(objset_t *mos, uint64_t zapobj, const char *perm,
    int checkflag, cred_t *cr)
{
        const   gid_t *gids;
        int     ngids;
        int     i;
        uint64_t id;

        /* check for user */
        id = crgetuid(cr);
        if (dsl_check_access(mos, zapobj,
            ZFS_DELEG_USER, checkflag, &id, perm) == 0)
                return (0);

        /* check for users primary group */
        id = crgetgid(cr);
        if (dsl_check_access(mos, zapobj,
            ZFS_DELEG_GROUP, checkflag, &id, perm) == 0)
                return (0);

        /* check for everyone entry */
        id = -1;
        if (dsl_check_access(mos, zapobj,
            ZFS_DELEG_EVERYONE, checkflag, &id, perm) == 0)
                return (0);

        /* check each supplemental group user is a member of */
        ngids = crgetngroups(cr);
        gids = crgetgroups(cr);
        for (i = 0; i != ngids; i++) {
                id = gids[i];
                if (dsl_check_access(mos, zapobj,
                    ZFS_DELEG_GROUP, checkflag, &id, perm) == 0)
                        return (0);
        }

        return (EPERM);
}

static int
dsl_load_sets(objset_t *mos, uint64_t zapobj,
    char type, char checkflag, void *valp, avl_tree_t *avl)
{
        zap_cursor_t zc;
        zap_attribute_t za;
        perm_set_t *permnode;
        avl_index_t idx;
        uint64_t jumpobj;
        int error;
        char whokey[ZFS_MAX_DELEG_NAME];

        zfs_deleg_whokey(whokey, type, checkflag, valp);

        error = zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj);
        if (error != 0)
                return (error);

        for (zap_cursor_init(&zc, mos, jumpobj);
            zap_cursor_retrieve(&zc, &za) == 0;
            zap_cursor_advance(&zc)) {
                permnode = kmem_alloc(sizeof (perm_set_t), KM_SLEEP);
                (void) strlcpy(permnode->p_setname, za.za_name,
                    sizeof (permnode->p_setname));
                permnode->p_matched = B_FALSE;

                if (avl_find(avl, permnode, &idx) == NULL) {
                        avl_insert(avl, permnode, idx);
                } else {
                        kmem_free(permnode, sizeof (perm_set_t));
                }
        }
        zap_cursor_fini(&zc);
        return (0);
}

static void
dsl_load_user_sets(objset_t *mos, uint64_t zapobj, avl_tree_t *avl,
    char checkflag, cred_t *cr)
{
        const   gid_t *gids;
        int     ngids, i;
        uint64_t id;

        id = crgetuid(cr);
        (void) dsl_load_sets(mos, zapobj,
            ZFS_DELEG_USER_SETS, checkflag, &id, avl);

        id = crgetgid(cr);
        (void) dsl_load_sets(mos, zapobj,
            ZFS_DELEG_GROUP_SETS, checkflag, &id, avl);

        (void) dsl_load_sets(mos, zapobj,
            ZFS_DELEG_EVERYONE_SETS, checkflag, NULL, avl);

        ngids = crgetngroups(cr);
        gids = crgetgroups(cr);
        for (i = 0; i != ngids; i++) {
                id = gids[i];
                (void) dsl_load_sets(mos, zapobj,
                    ZFS_DELEG_GROUP_SETS, checkflag, &id, avl);
        }
}

int
dsl_deleg_access_impl(dsl_dataset_t *ds, boolean_t descendent, const char *perm,
    cred_t *cr)
{
        dsl_dir_t *dd;
        dsl_pool_t *dp;
        void *cookie;
        int     error;
        char    checkflag;
        objset_t *mos;
        avl_tree_t permsets;
        perm_set_t *setnode;

        dp = ds->ds_dir->dd_pool;
        mos = dp->dp_meta_objset;

        if (dsl_delegation_on(mos) == B_FALSE)
                return (ECANCELED);

        if (spa_version(dmu_objset_spa(dp->dp_meta_objset)) <
            SPA_VERSION_DELEGATED_PERMS)
                return (EPERM);

        if (dsl_dataset_is_snapshot(ds) || descendent) {
                /*
                 * Snapshots are treated as descendents only,
                 * local permissions do not apply.
                 */
                checkflag = ZFS_DELEG_DESCENDENT;
        } else {
                checkflag = ZFS_DELEG_LOCAL;
        }

        avl_create(&permsets, perm_set_compare, sizeof (perm_set_t),
            offsetof(perm_set_t, p_node));

        rw_enter(&dp->dp_config_rwlock, RW_READER);
        for (dd = ds->ds_dir; dd != NULL; dd = dd->dd_parent,
            checkflag = ZFS_DELEG_DESCENDENT) {
                uint64_t zapobj;
                boolean_t expanded;

                /*
                 * If not in global zone then make sure
                 * the zoned property is set
                 */
                if (!INGLOBALZONE(curthread)) {
                        uint64_t zoned;

                        if (dsl_prop_get_dd(dd,
                            zfs_prop_to_name(ZFS_PROP_ZONED),
                            8, 1, &zoned, NULL, B_FALSE) != 0)
                                break;
                        if (!zoned)
                                break;
                }
                zapobj = dd->dd_phys->dd_deleg_zapobj;

                if (zapobj == 0)
                        continue;

                dsl_load_user_sets(mos, zapobj, &permsets, checkflag, cr);
again:
                expanded = B_FALSE;
                for (setnode = avl_first(&permsets); setnode;
                    setnode = AVL_NEXT(&permsets, setnode)) {
                        if (setnode->p_matched == B_TRUE)
                                continue;

                        /* See if this set directly grants this permission */
                        error = dsl_check_access(mos, zapobj,
                            ZFS_DELEG_NAMED_SET, 0, setnode->p_setname, perm);
                        if (error == 0)
                                goto success;
                        if (error == EPERM)
                                setnode->p_matched = B_TRUE;

                        /* See if this set includes other sets */
                        error = dsl_load_sets(mos, zapobj,
                            ZFS_DELEG_NAMED_SET_SETS, 0,
                            setnode->p_setname, &permsets);
                        if (error == 0)
                                setnode->p_matched = expanded = B_TRUE;
                }
                /*
                 * If we expanded any sets, that will define more sets,
                 * which we need to check.
                 */
                if (expanded)
                        goto again;

                error = dsl_check_user_access(mos, zapobj, perm, checkflag, cr);
                if (error == 0)
                        goto success;
        }
        error = EPERM;
success:
        rw_exit(&dp->dp_config_rwlock);

        cookie = NULL;
        while ((setnode = avl_destroy_nodes(&permsets, &cookie)) != NULL)
                kmem_free(setnode, sizeof (perm_set_t));

        return (error);
}

int
dsl_deleg_access(const char *dsname, const char *perm, cred_t *cr)
{
        dsl_dataset_t *ds;
        int error;

        error = dsl_dataset_hold(dsname, FTAG, &ds);
        if (error)
                return (error);

        error = dsl_deleg_access_impl(ds, B_FALSE, perm, cr);
        dsl_dataset_rele(ds, FTAG);

        return (error);
}

/*
 * Other routines.
 */

static void
copy_create_perms(dsl_dir_t *dd, uint64_t pzapobj,
    boolean_t dosets, uint64_t uid, dmu_tx_t *tx)
{
        objset_t *mos = dd->dd_pool->dp_meta_objset;
        uint64_t jumpobj, pjumpobj;
        uint64_t zapobj = dd->dd_phys->dd_deleg_zapobj;
        zap_cursor_t zc;
        zap_attribute_t za;
        char whokey[ZFS_MAX_DELEG_NAME];

        zfs_deleg_whokey(whokey,
            dosets ? ZFS_DELEG_CREATE_SETS : ZFS_DELEG_CREATE,
            ZFS_DELEG_LOCAL, NULL);
        if (zap_lookup(mos, pzapobj, whokey, 8, 1, &pjumpobj) != 0)
                return;

        if (zapobj == 0) {
                dmu_buf_will_dirty(dd->dd_dbuf, tx);
                zapobj = dd->dd_phys->dd_deleg_zapobj = zap_create(mos,
                    DMU_OT_DSL_PERMS, DMU_OT_NONE, 0, tx);
        }

        zfs_deleg_whokey(whokey,
            dosets ? ZFS_DELEG_USER_SETS : ZFS_DELEG_USER,
            ZFS_DELEG_LOCAL, &uid);
        if (zap_lookup(mos, zapobj, whokey, 8, 1, &jumpobj) == ENOENT) {
                jumpobj = zap_create(mos, DMU_OT_DSL_PERMS, DMU_OT_NONE, 0, tx);
                VERIFY(zap_add(mos, zapobj, whokey, 8, 1, &jumpobj, tx) == 0);
        }

        for (zap_cursor_init(&zc, mos, pjumpobj);
            zap_cursor_retrieve(&zc, &za) == 0;
            zap_cursor_advance(&zc)) {
                uint64_t zero = 0;
                ASSERT(za.za_integer_length == 8 && za.za_num_integers == 1);

                VERIFY(zap_update(mos, jumpobj, za.za_name,
                    8, 1, &zero, tx) == 0);
        }
        zap_cursor_fini(&zc);
}

void
dsl_deleg_set_create_perms(dsl_dir_t *sdd, dmu_tx_t *tx, cred_t *cr)
{
        dsl_dir_t *dd;
        uint64_t uid = crgetuid(cr);

        if (spa_version(dmu_objset_spa(sdd->dd_pool->dp_meta_objset)) <
            SPA_VERSION_DELEGATED_PERMS)
                return;

        for (dd = sdd->dd_parent; dd != NULL; dd = dd->dd_parent) {
                uint64_t pzapobj = dd->dd_phys->dd_deleg_zapobj;

                if (pzapobj == 0)
                        continue;

                copy_create_perms(sdd, pzapobj, B_FALSE, uid, tx);
                copy_create_perms(sdd, pzapobj, B_TRUE, uid, tx);
        }
}

int
dsl_deleg_destroy(objset_t *mos, uint64_t zapobj, dmu_tx_t *tx)
{
        zap_cursor_t zc;
        zap_attribute_t za;

        if (zapobj == 0)
                return (0);

        for (zap_cursor_init(&zc, mos, zapobj);
            zap_cursor_retrieve(&zc, &za) == 0;
            zap_cursor_advance(&zc)) {
                ASSERT(za.za_integer_length == 8 && za.za_num_integers == 1);
                VERIFY(0 == zap_destroy(mos, za.za_first_integer, tx));
        }
        zap_cursor_fini(&zc);
        VERIFY(0 == zap_destroy(mos, zapobj, tx));
        return (0);
}

boolean_t
dsl_delegation_on(objset_t *os)
{
        return (!!spa_delegation(os->os_spa));
}