xref: /freebsd/sys/contrib/openzfs/lib/libspl/include/sys/acl.h (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3  * CDDL HEADER START
4  *
5  * The contents of this file are subject to the terms of the
6  * Common Development and Distribution License (the "License").
7  * You may not use this file except in compliance with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or https://opensource.org/licenses/CDDL-1.0.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
27  * Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
28  * Copyright 2017 RackTop Systems.
29  */
30 
31 #ifndef _SYS_ACL_H
32 #define	_SYS_ACL_H
33 
34 #include <sys/types.h>
35 #include <sys/acl_impl.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 #define	MAX_ACL_ENTRIES		(1024)	/* max entries of each type */
42 typedef struct acl {
43 	int		a_type;		/* the type of ACL entry */
44 	uid_t		a_id;		/* the entry in -uid or gid */
45 	o_mode_t	a_perm;		/* the permission field */
46 } aclent_t;
47 
48 typedef struct ace {
49 	uid_t		a_who;		/* uid or gid */
50 	uint32_t	a_access_mask;	/* read,write,... */
51 	uint16_t	a_flags;	/* see below */
52 	uint16_t	a_type;		/* allow or deny */
53 } ace_t;
54 
55 typedef struct acl_info acl_t;
56 
57 /*
58  * The following are Defined types for an aclent_t.
59  */
60 #define	USER_OBJ	(0x01)		/* object owner */
61 #define	USER		(0x02)		/* additional users */
62 #define	GROUP_OBJ	(0x04)		/* owning group of the object */
63 #define	GROUP		(0x08)		/* additional groups */
64 #define	CLASS_OBJ	(0x10)		/* file group class and mask entry */
65 #define	OTHER_OBJ	(0x20)		/* other entry for the object */
66 #define	ACL_DEFAULT	(0x1000)	/* default flag */
67 /* default object owner */
68 #define	DEF_USER_OBJ	(ACL_DEFAULT | USER_OBJ)
69 /* default additional users */
70 #define	DEF_USER	(ACL_DEFAULT | USER)
71 /* default owning group */
72 #define	DEF_GROUP_OBJ	(ACL_DEFAULT | GROUP_OBJ)
73 /* default additional groups */
74 #define	DEF_GROUP	(ACL_DEFAULT | GROUP)
75 /* default mask entry */
76 #define	DEF_CLASS_OBJ	(ACL_DEFAULT | CLASS_OBJ)
77 /* default other entry */
78 #define	DEF_OTHER_OBJ	(ACL_DEFAULT | OTHER_OBJ)
79 
80 /*
81  * The following are defined for ace_t.
82  */
83 #define	ACE_READ_DATA		0x00000001	/* file: read data */
84 #define	ACE_LIST_DIRECTORY	0x00000001	/* dir: list files */
85 #define	ACE_WRITE_DATA		0x00000002	/* file: write data */
86 #define	ACE_ADD_FILE		0x00000002	/* dir: create file */
87 #define	ACE_APPEND_DATA		0x00000004	/* file: append data */
88 #define	ACE_ADD_SUBDIRECTORY	0x00000004	/* dir: create subdir */
89 #define	ACE_READ_NAMED_ATTRS	0x00000008	/* FILE_READ_EA */
90 #define	ACE_WRITE_NAMED_ATTRS	0x00000010	/* FILE_WRITE_EA */
91 #define	ACE_EXECUTE		0x00000020	/* file: execute */
92 #define	ACE_TRAVERSE		0x00000020	/* dir: lookup name */
93 #define	ACE_DELETE_CHILD	0x00000040	/* dir: unlink child */
94 #define	ACE_READ_ATTRIBUTES	0x00000080	/* (all) stat, etc. */
95 #define	ACE_WRITE_ATTRIBUTES	0x00000100	/* (all) utimes, etc. */
96 #define	ACE_DELETE		0x00010000	/* (all) unlink self */
97 #define	ACE_READ_ACL		0x00020000	/* (all) getsecattr */
98 #define	ACE_WRITE_ACL		0x00040000	/* (all) setsecattr */
99 #define	ACE_WRITE_OWNER		0x00080000	/* (all) chown */
100 #define	ACE_SYNCHRONIZE		0x00100000	/* (all) */
101 
102 #define	ACE_FILE_INHERIT_ACE		0x0001
103 #define	ACE_DIRECTORY_INHERIT_ACE	0x0002
104 #define	ACE_NO_PROPAGATE_INHERIT_ACE	0x0004
105 #define	ACE_INHERIT_ONLY_ACE		0x0008
106 #define	ACE_SUCCESSFUL_ACCESS_ACE_FLAG	0x0010
107 #define	ACE_FAILED_ACCESS_ACE_FLAG	0x0020
108 #define	ACE_IDENTIFIER_GROUP		0x0040
109 #define	ACE_INHERITED_ACE		0x0080
110 #define	ACE_OWNER			0x1000
111 #define	ACE_GROUP			0x2000
112 #define	ACE_EVERYONE			0x4000
113 
114 #define	ACE_ACCESS_ALLOWED_ACE_TYPE	0x0000
115 #define	ACE_ACCESS_DENIED_ACE_TYPE	0x0001
116 #define	ACE_SYSTEM_AUDIT_ACE_TYPE	0x0002
117 #define	ACE_SYSTEM_ALARM_ACE_TYPE	0x0003
118 
119 #define	ACL_AUTO_INHERIT		0x0001
120 #define	ACL_PROTECTED			0x0002
121 #define	ACL_DEFAULTED			0x0004
122 #define	ACL_FLAGS_ALL			(ACL_AUTO_INHERIT|ACL_PROTECTED| \
123     ACL_DEFAULTED)
124 
125 /*
126  * These are only applicable in a CIFS context.
127  */
128 #define	ACE_ACCESS_ALLOWED_COMPOUND_ACE_TYPE		0x04
129 #define	ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE		0x05
130 #define	ACE_ACCESS_DENIED_OBJECT_ACE_TYPE		0x06
131 #define	ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE		0x07
132 #define	ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE		0x08
133 #define	ACE_ACCESS_ALLOWED_CALLBACK_ACE_TYPE		0x09
134 #define	ACE_ACCESS_DENIED_CALLBACK_ACE_TYPE		0x0A
135 #define	ACE_ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE	0x0B
136 #define	ACE_ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE	0x0C
137 #define	ACE_SYSTEM_AUDIT_CALLBACK_ACE_TYPE		0x0D
138 #define	ACE_SYSTEM_ALARM_CALLBACK_ACE_TYPE		0x0E
139 #define	ACE_SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE	0x0F
140 #define	ACE_SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE	0x10
141 
142 #define	ACE_ALL_TYPES	0x001F
143 
144 #if defined(_KERNEL)
145 
146 typedef struct ace_object {
147 	uid_t		a_who;		/* uid or gid */
148 	uint32_t	a_access_mask;	/* read,write,... */
149 	uint16_t	a_flags;	/* see below */
150 	uint16_t	a_type;		/* allow or deny */
151 	uint8_t		a_obj_type[16];	/* obj type */
152 	uint8_t		a_inherit_obj_type[16];  /* inherit obj */
153 } ace_object_t;
154 
155 #endif
156 
157 #define	ACE_ALL_PERMS	(ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \
158     ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \
159     ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \
160     ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_WRITE_ACL| \
161     ACE_WRITE_OWNER|ACE_SYNCHRONIZE)
162 
163 #define	ACE_ALL_WRITE_PERMS (ACE_WRITE_DATA|ACE_APPEND_DATA| \
164     ACE_WRITE_ATTRIBUTES|ACE_WRITE_NAMED_ATTRS|ACE_WRITE_ACL| \
165     ACE_WRITE_OWNER|ACE_DELETE|ACE_DELETE_CHILD)
166 
167 #define	ACE_READ_PERMS	(ACE_READ_DATA|ACE_READ_ACL|ACE_READ_ATTRIBUTES| \
168     ACE_READ_NAMED_ATTRS)
169 
170 #define	ACE_WRITE_PERMS	(ACE_WRITE_DATA|ACE_APPEND_DATA|ACE_WRITE_ATTRIBUTES| \
171     ACE_WRITE_NAMED_ATTRS)
172 
173 #define	ACE_MODIFY_PERMS (ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \
174     ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \
175     ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \
176     ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_SYNCHRONIZE)
177 
178 /*
179  * The following flags are supported by both NFSv4 ACLs and ace_t.
180  */
181 #define	ACE_NFSV4_SUP_FLAGS (ACE_FILE_INHERIT_ACE | \
182     ACE_DIRECTORY_INHERIT_ACE | \
183     ACE_NO_PROPAGATE_INHERIT_ACE | \
184     ACE_INHERIT_ONLY_ACE | \
185     ACE_IDENTIFIER_GROUP)
186 
187 #define	ACE_TYPE_FLAGS		(ACE_OWNER|ACE_GROUP|ACE_EVERYONE| \
188     ACE_IDENTIFIER_GROUP)
189 #define	ACE_INHERIT_FLAGS	(ACE_FILE_INHERIT_ACE| \
190     ACE_DIRECTORY_INHERIT_ACE|ACE_NO_PROPAGATE_INHERIT_ACE|ACE_INHERIT_ONLY_ACE)
191 
192 /* cmd args to acl(2) for aclent_t  */
193 #define	GETACL			1
194 #define	SETACL			2
195 #define	GETACLCNT		3
196 
197 /* cmd's to manipulate ace acls. */
198 #define	ACE_GETACL		4
199 #define	ACE_SETACL		5
200 #define	ACE_GETACLCNT		6
201 
202 /* minimal acl entries from GETACLCNT */
203 #define	MIN_ACL_ENTRIES		4
204 
205 #if !defined(_KERNEL)
206 
207 /* acl check errors */
208 #define	GRP_ERROR		1
209 #define	USER_ERROR		2
210 #define	OTHER_ERROR		3
211 #define	CLASS_ERROR		4
212 #define	DUPLICATE_ERROR		5
213 #define	MISS_ERROR		6
214 #define	MEM_ERROR		7
215 #define	ENTRY_ERROR		8
216 
217 
218 /*
219  * similar to ufs_acl.h: changed to char type for user commands (tar, cpio)
220  * Attribute types
221  */
222 #define	UFSD_FREE	('0')	/* Free entry */
223 #define	UFSD_ACL	('1')	/* Access Control Lists */
224 #define	UFSD_DFACL	('2')	/* reserved for future use */
225 #define	ACE_ACL		('3')	/* ace_t style acls */
226 
227 /*
228  * flag to [f]acl_get()
229  * controls whether a trivial acl should be returned.
230  */
231 #define	ACL_NO_TRIVIAL	0x2
232 
233 
234 /*
235  * Flags to control acl_totext()
236  */
237 
238 #define	ACL_APPEND_ID	0x1 	/* append uid/gid to user/group entries */
239 #define	ACL_COMPACT_FMT	0x2 	/* build ACL in ls -V format */
240 #define	ACL_NORESOLVE	0x4	/* don't do name service lookups */
241 #define	ACL_SID_FMT	0x8	/* use usersid/groupsid when appropriate */
242 
243 /*
244  * Legacy aclcheck errors for aclent_t ACLs
245  */
246 #define	EACL_GRP_ERROR		GRP_ERROR
247 #define	EACL_USER_ERROR		USER_ERROR
248 #define	EACL_OTHER_ERROR	OTHER_ERROR
249 #define	EACL_CLASS_ERROR	CLASS_ERROR
250 #define	EACL_DUPLICATE_ERROR	DUPLICATE_ERROR
251 #define	EACL_MISS_ERROR		MISS_ERROR
252 #define	EACL_MEM_ERROR		MEM_ERROR
253 #define	EACL_ENTRY_ERROR	ENTRY_ERROR
254 
255 #define	EACL_INHERIT_ERROR	9		/* invalid inherit flags */
256 #define	EACL_FLAGS_ERROR	10		/* unknown flag value */
257 #define	EACL_PERM_MASK_ERROR	11		/* unknown permission */
258 #define	EACL_COUNT_ERROR	12		/* invalid acl count */
259 
260 #define	EACL_INVALID_SLOT	13		/* invalid acl slot */
261 #define	EACL_NO_ACL_ENTRY	14		/* Entry doesn't exist */
262 #define	EACL_DIFF_TYPE		15		/* acls aren't same type */
263 
264 #define	EACL_INVALID_USER_GROUP	16		/* need user/group name */
265 #define	EACL_INVALID_STR	17		/* invalid acl string */
266 #define	EACL_FIELD_NOT_BLANK	18		/* can't have blank field */
267 #define	EACL_INVALID_ACCESS_TYPE 19		/* invalid access type */
268 #define	EACL_UNKNOWN_DATA	20		/* Unrecognized data in ACL */
269 #define	EACL_MISSING_FIELDS	21		/* missing fields in acl */
270 
271 #define	EACL_INHERIT_NOTDIR	22		/* Need dir for inheritance */
272 
273 extern int aclcheck(aclent_t *, int, int *);
274 extern int acltomode(aclent_t *, int, mode_t *);
275 extern int aclfrommode(aclent_t *, int, mode_t *);
276 extern int aclsort(int, int, aclent_t *);
277 extern char *acltotext(aclent_t *, int);
278 extern aclent_t *aclfromtext(char *, int *);
279 extern void acl_free(acl_t *);
280 extern int acl_get(const char *, int, acl_t **);
281 extern int facl_get(int, int, acl_t **);
282 extern int acl_set(const char *, acl_t *acl);
283 extern int facl_set(int, acl_t *acl);
284 extern int acl_strip(const char *, uid_t, gid_t, mode_t);
285 extern int acl_trivial(const char *);
286 extern char *acl_totext(acl_t *, int);
287 extern int acl_fromtext(const char *, acl_t **);
288 extern int acl_check(acl_t *, int);
289 
290 #else	/* !defined(_KERNEL) */
291 
292 extern void ksort(caddr_t, int, int, int (*)(void *, void *));
293 extern int cmp2acls(void *, void *);
294 
295 #endif	/* !defined(_KERNEL) */
296 
297 extern int acl(const char *path, int cmd, int cnt, void *buf);
298 extern int facl(int fd, int cmd, int cnt, void *buf);
299 
300 #ifdef	__cplusplus
301 }
302 #endif
303 
304 #endif /* _SYS_ACL_H */
305