xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_acl.h (revision d0f3f37e7f24f68fdbd85386c60e576883622762)
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 #ifdef _KERNEL
30 #include <sys/isa_defs.h>
31 #include <sys/types32.h>
32 #endif
33 #include <sys/acl.h>
34 #include <sys/dmu.h>
35 #include <sys/zfs_fuid.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 struct znode_phys;
42 
43 #define	ACE_SLOT_CNT	6
44 #define	ZFS_ACL_VERSION_INITIAL 0ULL
45 #define	ZFS_ACL_VERSION_FUID	1ULL
46 #define	ZFS_ACL_VERSION		ZFS_ACL_VERSION_FUID
47 
48 /*
49  * ZFS ACLs are store in various forms.
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 typedef struct zfs_acl_phys {
110 	uint64_t	z_acl_extern_obj;	  /* ext acl pieces */
111 	uint32_t	z_acl_size;		  /* Number of bytes in ACL */
112 	uint16_t	z_acl_version;		  /* acl version */
113 	uint16_t	z_acl_count;		  /* ace count */
114 	uint8_t		z_ace_data[ZFS_ACE_SPACE]; /* space for embedded ACEs */
115 } zfs_acl_phys_t;
116 
117 
118 
119 typedef struct acl_ops {
120 	uint32_t	(*ace_mask_get) (void *acep); /* get  access mask */
121 	void 		(*ace_mask_set) (void *acep,
122 			    uint32_t mask); /* set access mask */
123 	uint16_t	(*ace_flags_get) (void *acep);	/* get flags */
124 	void		(*ace_flags_set) (void *acep,
125 			    uint16_t flags); /* set flags */
126 	uint16_t	(*ace_type_get)(void *acep); /* get type */
127 	void		(*ace_type_set)(void *acep,
128 			    uint16_t type); /* set type */
129 	uint64_t	(*ace_who_get)(void *acep); /* get who/fuid */
130 	void		(*ace_who_set)(void *acep,
131 			    uint64_t who); /* set who/fuid */
132 	size_t		(*ace_size)(void *acep); /* how big is this ace */
133 	size_t		(*ace_abstract_size)(void); /* sizeof abstract entry */
134 	int		(*ace_mask_off)(void); /* off of access mask in ace */
135 	int		(*ace_data)(void *acep, void **datap);
136 			    /* ptr to data if any */
137 } acl_ops_t;
138 
139 /*
140  * A zfs_acl_t structure is composed of a list of zfs_acl_node_t's.
141  * Each node will have one or more ACEs associated with it.  You will
142  * only have multiple nodes during a chmod operation.   Normally only
143  * one node is required.
144  */
145 typedef struct zfs_acl_node {
146 	list_node_t	z_next;		/* Next chunk of ACEs */
147 	void		*z_acldata;	/* pointer into actual ACE(s) */
148 	void		*z_allocdata;	/* pointer to kmem allocated memory */
149 	size_t		z_allocsize;	/* Size of blob in bytes */
150 	size_t		z_size;		/* length of ACL data */
151 	int		z_ace_count;	/* number of ACEs in this acl node */
152 	int		z_ace_idx;	/* ace iterator positioned on */
153 } zfs_acl_node_t;
154 
155 typedef struct zfs_acl {
156 	int		z_acl_count;	/* Number of ACEs */
157 	size_t		z_acl_bytes;	/* Number of bytes in ACL */
158 	uint_t		z_version;	/* version of ACL */
159 	void		*z_next_ace;	/* pointer to next ACE */
160 	int		z_hints;	/* ACL hints (ZFS_INHERIT_ACE ...) */
161 	zfs_acl_node_t	*z_curr_node;	/* current node iterator is handling */
162 	list_t		z_acl;		/* chunks of ACE data */
163 	acl_ops_t	z_ops;		/* ACL operations */
164 	boolean_t	z_has_fuids;	/* FUIDs present in ACL? */
165 } zfs_acl_t;
166 
167 #define	ACL_DATA_ALLOCED	0x1
168 #define	ZFS_ACL_SIZE(aclcnt)	(sizeof (ace_t) * (aclcnt))
169 
170 /*
171  * Property values for acl_mode and acl_inherit.
172  *
173  * acl_mode can take discard, noallow, groupmask and passthrough.
174  * whereas acl_inherit has secure instead of groupmask.
175  */
176 
177 #define	ZFS_ACL_DISCARD		0
178 #define	ZFS_ACL_NOALLOW		1
179 #define	ZFS_ACL_GROUPMASK	2
180 #define	ZFS_ACL_PASSTHROUGH	3
181 #define	ZFS_ACL_RESTRICTED	4
182 #define	ZFS_ACL_PASSTHROUGH_X	5
183 
184 struct znode;
185 struct zfsvfs;
186 struct zfs_fuid_info;
187 
188 #ifdef _KERNEL
189 void zfs_perm_init(struct znode *, struct znode *, int, vattr_t *,
190     dmu_tx_t *, cred_t *, zfs_acl_t *, zfs_fuid_info_t **);
191 int zfs_getacl(struct znode *, vsecattr_t *, boolean_t, cred_t *);
192 int zfs_setacl(struct znode *, vsecattr_t *, boolean_t, cred_t *);
193 void zfs_acl_rele(void *);
194 void zfs_oldace_byteswap(ace_t *, int);
195 void zfs_ace_byteswap(void *, size_t, boolean_t);
196 extern int zfs_zaccess(struct znode *, int, int, boolean_t, cred_t *);
197 extern int zfs_zaccess_rwx(struct znode *, mode_t, int, cred_t *);
198 extern int zfs_zaccess_unix(struct znode *, mode_t, cred_t *);
199 extern int zfs_acl_access(struct znode *, int, cred_t *);
200 int zfs_acl_chmod_setattr(struct znode *, zfs_acl_t **, uint64_t);
201 int zfs_zaccess_delete(struct znode *, struct znode *, cred_t *);
202 int zfs_zaccess_rename(struct znode *, struct znode *,
203     struct znode *, struct znode *, cred_t *cr);
204 void zfs_acl_free(zfs_acl_t *);
205 int zfs_vsec_2_aclp(struct zfsvfs *, vtype_t, vsecattr_t *, zfs_acl_t **);
206 int zfs_aclset_common(struct znode *, zfs_acl_t *, cred_t *,
207     struct zfs_fuid_info **, dmu_tx_t *);
208 
209 #endif
210 
211 #ifdef	__cplusplus
212 }
213 #endif
214 #endif	/* _SYS_FS_ZFS_ACL_H */
215