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