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