zfs_acl.h revision 6257:0c7475fa4852
1/* 2 * CDDL HEADER START 3 * 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. 7 * 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. 12 * 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] 18 * 19 * CDDL HEADER END 20 */ 21/* 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26#ifndef _SYS_FS_ZFS_ACL_H 27#define _SYS_FS_ZFS_ACL_H 28 29#pragma ident "%Z%%M% %I% %E% SMI" 30 31#ifdef _KERNEL 32#include <sys/isa_defs.h> 33#include <sys/types32.h> 34#endif 35#include <sys/acl.h> 36#include <sys/dmu.h> 37#include <sys/zfs_fuid.h> 38 39#ifdef __cplusplus 40extern "C" { 41#endif 42 43struct znode_phys; 44 45#define ACE_SLOT_CNT 6 46#define ZFS_ACL_VERSION_INITIAL 0ULL 47#define ZFS_ACL_VERSION_FUID 1ULL 48#define ZFS_ACL_VERSION ZFS_ACL_VERSION_FUID 49 50/* 51 * ZFS ACLs are store in various forms. 52 * Files created with ACL version ZFS_ACL_VERSION_INITIAL 53 * will all be created with fixed length ACEs of type 54 * zfs_oldace_t. 55 * 56 * Files with ACL version ZFS_ACL_VERSION_FUID will be created 57 * with various sized ACEs. The abstraction entries will utilize 58 * zfs_ace_hdr_t, normal user/group entries will use zfs_ace_t 59 * and some specialized CIFS ACEs will use zfs_object_ace_t. 60 */ 61 62/* 63 * All ACEs have a common hdr. For 64 * owner@, group@, and everyone@ this is all 65 * thats needed. 66 */ 67typedef struct zfs_ace_hdr { 68 uint16_t z_type; 69 uint16_t z_flags; 70 uint32_t z_access_mask; 71} zfs_ace_hdr_t; 72 73typedef zfs_ace_hdr_t zfs_ace_abstract_t; 74 75/* 76 * Standard ACE 77 */ 78typedef struct zfs_ace { 79 zfs_ace_hdr_t z_hdr; 80 uint64_t z_fuid; 81} zfs_ace_t; 82 83/* 84 * The following type only applies to ACE_ACCESS_ALLOWED|DENIED_OBJECT_ACE_TYPE 85 * and will only be set/retrieved in a CIFS context. 86 */ 87 88typedef struct zfs_object_ace { 89 zfs_ace_t z_ace; 90 uint8_t z_object_type[16]; /* object type */ 91 uint8_t z_inherit_type[16]; /* inherited object type */ 92} zfs_object_ace_t; 93 94typedef struct zfs_oldace { 95 uint32_t z_fuid; /* "who" */ 96 uint32_t z_access_mask; /* access mask */ 97 uint16_t z_flags; /* flags, i.e inheritance */ 98 uint16_t z_type; /* type of entry allow/deny */ 99} zfs_oldace_t; 100 101typedef struct zfs_acl_phys_v0 { 102 uint64_t z_acl_extern_obj; /* ext acl pieces */ 103 uint32_t z_acl_count; /* Number of ACEs */ 104 uint16_t z_acl_version; /* acl version */ 105 uint16_t z_acl_pad; /* pad */ 106 zfs_oldace_t z_ace_data[ACE_SLOT_CNT]; /* 6 standard ACEs */ 107} zfs_acl_phys_v0_t; 108 109#define ZFS_ACE_SPACE (sizeof (zfs_oldace_t) * ACE_SLOT_CNT) 110 111typedef struct zfs_acl_phys { 112 uint64_t z_acl_extern_obj; /* ext acl pieces */ 113 uint32_t z_acl_size; /* Number of bytes in ACL */ 114 uint16_t z_acl_version; /* acl version */ 115 uint16_t z_acl_count; /* ace count */ 116 uint8_t z_ace_data[ZFS_ACE_SPACE]; /* space for embedded ACEs */ 117} zfs_acl_phys_t; 118 119 120 121typedef struct acl_ops { 122 uint32_t (*ace_mask_get) (void *acep); /* get access mask */ 123 void (*ace_mask_set) (void *acep, 124 uint32_t mask); /* set access mask */ 125 uint16_t (*ace_flags_get) (void *acep); /* get flags */ 126 void (*ace_flags_set) (void *acep, 127 uint16_t flags); /* set flags */ 128 uint16_t (*ace_type_get)(void *acep); /* get type */ 129 void (*ace_type_set)(void *acep, 130 uint16_t type); /* set type */ 131 uint64_t (*ace_who_get)(void *acep); /* get who/fuid */ 132 void (*ace_who_set)(void *acep, 133 uint64_t who); /* set who/fuid */ 134 size_t (*ace_size)(void *acep); /* how big is this ace */ 135 size_t (*ace_abstract_size)(void); /* sizeof abstract entry */ 136 int (*ace_mask_off)(void); /* off of access mask in ace */ 137 int (*ace_data)(void *acep, void **datap); 138 /* ptr to data if any */ 139} acl_ops_t; 140 141/* 142 * A zfs_acl_t structure is composed of a list of zfs_acl_node_t's. 143 * Each node will have one or more ACEs associated with it. You will 144 * only have multiple nodes during a chmod operation. Normally only 145 * one node is required. 146 */ 147typedef struct zfs_acl_node { 148 list_node_t z_next; /* Next chunk of ACEs */ 149 void *z_acldata; /* pointer into actual ACE(s) */ 150 void *z_allocdata; /* pointer to kmem allocated memory */ 151 size_t z_allocsize; /* Size of blob in bytes */ 152 size_t z_size; /* length of ACL data */ 153 int z_ace_count; /* number of ACEs in this acl node */ 154 int z_ace_idx; /* ace iterator positioned on */ 155} zfs_acl_node_t; 156 157typedef struct zfs_acl { 158 int z_acl_count; /* Number of ACEs */ 159 size_t z_acl_bytes; /* Number of bytes in ACL */ 160 uint_t z_version; /* version of ACL */ 161 void *z_next_ace; /* pointer to next ACE */ 162 int z_hints; /* ACL hints (ZFS_INHERIT_ACE ...) */ 163 zfs_acl_node_t *z_curr_node; /* current node iterator is handling */ 164 list_t z_acl; /* chunks of ACE data */ 165 acl_ops_t z_ops; /* ACL operations */ 166 boolean_t z_has_fuids; /* FUIDs present in ACL? */ 167} zfs_acl_t; 168 169#define ACL_DATA_ALLOCED 0x1 170#define ZFS_ACL_SIZE(aclcnt) (sizeof (ace_t) * (aclcnt)) 171 172/* 173 * Property values for acl_mode and acl_inherit. 174 * 175 * acl_mode can take discard, noallow, groupmask and passthrough. 176 * whereas acl_inherit has secure instead of groupmask. 177 */ 178 179#define ZFS_ACL_DISCARD 0 180#define ZFS_ACL_NOALLOW 1 181#define ZFS_ACL_GROUPMASK 2 182#define ZFS_ACL_PASSTHROUGH 3 183#define ZFS_ACL_SECURE 4 184 185struct znode; 186struct zfsvfs; 187struct zfs_fuid_info; 188 189#ifdef _KERNEL 190void zfs_perm_init(struct znode *, struct znode *, int, vattr_t *, 191 dmu_tx_t *, cred_t *, zfs_acl_t *, zfs_fuid_info_t **); 192int zfs_getacl(struct znode *, vsecattr_t *, boolean_t, cred_t *); 193int zfs_setacl(struct znode *, vsecattr_t *, boolean_t, cred_t *); 194void zfs_acl_rele(void *); 195void zfs_oldace_byteswap(ace_t *, int); 196void zfs_ace_byteswap(void *, size_t, boolean_t); 197extern int zfs_zaccess(struct znode *, int, int, boolean_t, cred_t *); 198extern int zfs_zaccess_rwx(struct znode *, mode_t, int, cred_t *); 199extern int zfs_zaccess_unix(struct znode *, mode_t, cred_t *); 200extern int zfs_acl_access(struct znode *, int, cred_t *); 201int zfs_acl_chmod_setattr(struct znode *, zfs_acl_t **, uint64_t); 202int zfs_zaccess_delete(struct znode *, struct znode *, cred_t *); 203int zfs_zaccess_rename(struct znode *, struct znode *, 204 struct znode *, struct znode *, cred_t *cr); 205void zfs_acl_free(zfs_acl_t *); 206int zfs_vsec_2_aclp(struct zfsvfs *, vtype_t, vsecattr_t *, zfs_acl_t **); 207int zfs_aclset_common(struct znode *, zfs_acl_t *, cred_t *, 208 struct zfs_fuid_info **, dmu_tx_t *); 209 210#endif 211 212#ifdef __cplusplus 213} 214#endif 215#endif /* _SYS_FS_ZFS_ACL_H */ 216