xref: /titanic_44/usr/src/uts/common/sys/acl.h (revision 355b4669e025ff377602b6fc7caaf30dbc218371)
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 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SYS_ACL_H
27 #define	_SYS_ACL_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/types.h>
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 #define	MAX_ACL_ENTRIES		(1024)	/* max entries of each type */
38 typedef struct acl {
39 	int		a_type;		/* the type of ACL entry */
40 	uid_t		a_id;		/* the entry in -uid or gid */
41 	o_mode_t	a_perm;		/* the permission field */
42 } aclent_t;
43 
44 typedef struct ace {
45 	uid_t		a_who;		/* uid or gid */
46 	uint32_t	a_access_mask;	/* read,write,... */
47 	uint16_t	a_flags;	/* see below */
48 	uint16_t	a_type;		/* allow or deny */
49 } ace_t;
50 
51 typedef struct acl_info acl_t;
52 
53 /*
54  * The following are Defined types for an aclent_t.
55  */
56 #define	USER_OBJ	(0x01)		/* object owner */
57 #define	USER		(0x02)		/* additional users */
58 #define	GROUP_OBJ	(0x04)		/* owning group of the object */
59 #define	GROUP		(0x08)		/* additional groups */
60 #define	CLASS_OBJ	(0x10)		/* file group class and mask entry */
61 #define	OTHER_OBJ	(0x20)		/* other entry for the object */
62 #define	ACL_DEFAULT	(0x1000)	/* default flag */
63 /* default object owner */
64 #define	DEF_USER_OBJ	(ACL_DEFAULT | USER_OBJ)
65 /* defalut additional users */
66 #define	DEF_USER	(ACL_DEFAULT | USER)
67 /* default owning group */
68 #define	DEF_GROUP_OBJ	(ACL_DEFAULT | GROUP_OBJ)
69 /* default additional groups */
70 #define	DEF_GROUP	(ACL_DEFAULT | GROUP)
71 /* default mask entry */
72 #define	DEF_CLASS_OBJ	(ACL_DEFAULT | CLASS_OBJ)
73 /* default other entry */
74 #define	DEF_OTHER_OBJ	(ACL_DEFAULT | OTHER_OBJ)
75 
76 /*
77  * The following are defined for ace_t.
78  */
79 #define	ACE_READ_DATA		0x00000001
80 #define	ACE_LIST_DIRECTORY	0x00000001
81 #define	ACE_WRITE_DATA		0x00000002
82 #define	ACE_ADD_FILE		0x00000002
83 #define	ACE_APPEND_DATA		0x00000004
84 #define	ACE_ADD_SUBDIRECTORY	0x00000004
85 #define	ACE_READ_NAMED_ATTRS	0x00000008
86 #define	ACE_WRITE_NAMED_ATTRS	0x00000010
87 #define	ACE_EXECUTE		0x00000020
88 #define	ACE_DELETE_CHILD	0x00000040
89 #define	ACE_READ_ATTRIBUTES	0x00000080
90 #define	ACE_WRITE_ATTRIBUTES	0x00000100
91 #define	ACE_DELETE		0x00010000
92 #define	ACE_READ_ACL		0x00020000
93 #define	ACE_WRITE_ACL		0x00040000
94 #define	ACE_WRITE_OWNER		0x00080000
95 #define	ACE_SYNCHRONIZE		0x00100000
96 
97 #define	ACE_FILE_INHERIT_ACE		0x0001
98 #define	ACE_DIRECTORY_INHERIT_ACE	0x0002
99 #define	ACE_NO_PROPAGATE_INHERIT_ACE	0x0004
100 #define	ACE_INHERIT_ONLY_ACE		0x0008
101 #define	ACE_SUCCESSFUL_ACCESS_ACE_FLAG	0x0010
102 #define	ACE_FAILED_ACCESS_ACE_FLAG	0x0020
103 #define	ACE_IDENTIFIER_GROUP		0x0040
104 #define	ACE_OWNER			0x1000
105 #define	ACE_GROUP			0x2000
106 #define	ACE_EVERYONE			0x4000
107 
108 #define	ACE_ACCESS_ALLOWED_ACE_TYPE	0x0000
109 #define	ACE_ACCESS_DENIED_ACE_TYPE	0x0001
110 #define	ACE_SYSTEM_AUDIT_ACE_TYPE	0x0002
111 #define	ACE_SYSTEM_ALARM_ACE_TYPE	0x0003
112 
113 #define	ACE_ALL_PERMS	(ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \
114     ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \
115     ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \
116     ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_WRITE_ACL| \
117     ACE_WRITE_OWNER|ACE_SYNCHRONIZE)
118 
119 /*
120  * The following flags are supported by both NFSv4 ACLs and ace_t.
121  */
122 #define	ACE_NFSV4_SUP_FLAGS (ACE_FILE_INHERIT_ACE | \
123     ACE_DIRECTORY_INHERIT_ACE | \
124     ACE_NO_PROPAGATE_INHERIT_ACE | \
125     ACE_INHERIT_ONLY_ACE | \
126     ACE_IDENTIFIER_GROUP)
127 
128 #define	ACE_TYPE_FLAGS	(ACE_OWNER|ACE_GROUP|ACE_EVERYONE|ACE_IDENTIFIER_GROUP)
129 
130 /* cmd args to acl(2) for aclent_t  */
131 #define	GETACL			1
132 #define	SETACL			2
133 #define	GETACLCNT		3
134 
135 /* cmd's to manipulate ace acls. */
136 #define	ACE_GETACL		4
137 #define	ACE_SETACL		5
138 #define	ACE_GETACLCNT		6
139 
140 /* minimal acl entries from GETACLCNT */
141 #define	MIN_ACL_ENTRIES		4
142 
143 #if !defined(_KERNEL)
144 
145 /* acl check errors */
146 #define	GRP_ERROR		1
147 #define	USER_ERROR		2
148 #define	OTHER_ERROR		3
149 #define	CLASS_ERROR		4
150 #define	DUPLICATE_ERROR		5
151 #define	MISS_ERROR		6
152 #define	MEM_ERROR		7
153 #define	ENTRY_ERROR		8
154 
155 
156 /*
157  * similar to ufs_acl.h: changed to char type for user commands (tar, cpio)
158  * Attribute types
159  */
160 #define	UFSD_FREE	('0')	/* Free entry */
161 #define	UFSD_ACL	('1')	/* Access Control Lists */
162 #define	UFSD_DFACL	('2')	/* reserved for future use */
163 #define	ACE_ACL		('3')	/* ace_t style acls */
164 
165 /*
166  * flag to [f]acl_get()
167  * controls whether a trivial acl should be returned.
168  */
169 #define	ACL_NO_TRIVIAL	0x2
170 
171 
172 /*
173  * Flags to control acl_totext()
174  */
175 
176 #define	ACL_APPEND_ID	0x1 	/* append uid/gid to user/group entries */
177 #define	ACL_COMPACT_FMT	0x2 	/* build ACL in ls -V format */
178 #define	ACL_NORESOLVE	0x4	/* don't do name service lookups */
179 
180 /*
181  * Legacy aclcheck errors for aclent_t ACLs
182  */
183 #define	EACL_GRP_ERROR		GRP_ERROR
184 #define	EACL_USER_ERROR		USER_ERROR
185 #define	EACL_OTHER_ERROR	OTHER_ERROR
186 #define	EACL_CLASS_ERROR	CLASS_ERROR
187 #define	EACL_DUPLICATE_ERROR	DUPLICATE_ERROR
188 #define	EACL_MISS_ERROR		MISS_ERROR
189 #define	EACL_MEM_ERROR		MEM_ERROR
190 #define	EACL_ENTRY_ERROR	ENTRY_ERROR
191 
192 #define	EACL_INHERIT_ERROR	9		/* invalid inherit flags */
193 #define	EACL_FLAGS_ERROR	10		/* unknown flag value */
194 #define	EACL_PERM_MASK_ERROR	11		/* unknown permission */
195 #define	EACL_COUNT_ERROR	12		/* invalid acl count */
196 
197 #define	EACL_INVALID_SLOT	13		/* invalid acl slot */
198 #define	EACL_NO_ACL_ENTRY	14		/* Entry doesn't exist */
199 #define	EACL_DIFF_TYPE		15		/* acls aren't same type */
200 
201 #define	EACL_INVALID_USER_GROUP	16		/* need user/group name */
202 #define	EACL_INVALID_STR	17		/* invalid acl string */
203 #define	EACL_FIELD_NOT_BLANK	18		/* can't have blank field */
204 #define	EACL_INVALID_ACCESS_TYPE 19		/* invalid access type */
205 #define	EACL_UNKNOWN_DATA	20		/* Unrecognized data in ACL */
206 #define	EACL_MISSING_FIELDS	21		/* missing fields in acl */
207 
208 #define	EACL_INHERIT_NOTDIR	22		/* Need dir for inheritance */
209 
210 extern int aclcheck(aclent_t *, int, int *);
211 extern int acltomode(aclent_t *, int, mode_t *);
212 extern int aclfrommode(aclent_t *, int, mode_t *);
213 extern int aclsort(int, int, aclent_t *);
214 extern char *acltotext(aclent_t *, int);
215 extern aclent_t *aclfromtext(char *, int *);
216 extern void acl_free(acl_t *);
217 extern int acl_get(const char *, int, acl_t **);
218 extern int facl_get(int, int, acl_t **);
219 extern int acl_set(const char *, acl_t *acl);
220 extern int facl_set(int, acl_t *acl);
221 extern int acl_strip(const char *, uid_t, gid_t, mode_t);
222 extern int acl_trivial(const char *);
223 extern char *acl_totext(acl_t *, int);
224 extern int acl_fromtext(const char *, acl_t **);
225 extern int acl_check(acl_t *, int);
226 
227 #else	/* !defined(_KERNEL) */
228 
229 extern void ksort(caddr_t, int, int, int (*)(void *, void *));
230 extern int cmp2acls(void *, void *);
231 
232 #endif	/* !defined(_KERNEL) */
233 
234 #if defined(__STDC__)
235 extern int acl(const char *path, int cmd, int cnt, void *buf);
236 extern int facl(int fd, int cmd, int cnt, void *buf);
237 #else	/* !__STDC__ */
238 extern int acl();
239 extern int facl();
240 #endif	/* defined(__STDC__) */
241 
242 #ifdef	__cplusplus
243 }
244 #endif
245 
246 #endif /* _SYS_ACL_H */
247