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