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.
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.
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]
22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
29 #include <sys/types.h>
30 #include <sys/acl_impl.h>
36 #define MAX_ACL_ENTRIES (1024) /* max entries of each type */
38 int a_type; /* the type of ACL entry */
39 uid_t a_id; /* the entry in -uid or gid */
40 o_mode_t a_perm; /* the permission field */
44 uid_t a_who; /* uid or gid */
45 uint32_t a_access_mask; /* read,write,... */
46 uint16_t a_flags; /* see below */
47 uint16_t a_type; /* allow or deny */
50 typedef struct acl_info acl_t;
53 * The following are Defined types for an aclent_t.
55 #define USER_OBJ (0x01) /* object owner */
56 #define USER (0x02) /* additional users */
57 #define GROUP_OBJ (0x04) /* owning group of the object */
58 #define GROUP (0x08) /* additional groups */
59 #define CLASS_OBJ (0x10) /* file group class and mask entry */
60 #define OTHER_OBJ (0x20) /* other entry for the object */
61 #define ACL_DEFAULT (0x1000) /* default flag */
62 /* default object owner */
63 #define DEF_USER_OBJ (ACL_DEFAULT | USER_OBJ)
64 /* default additional users */
65 #define DEF_USER (ACL_DEFAULT | USER)
66 /* default owning group */
67 #define DEF_GROUP_OBJ (ACL_DEFAULT | GROUP_OBJ)
68 /* default additional groups */
69 #define DEF_GROUP (ACL_DEFAULT | GROUP)
70 /* default mask entry */
71 #define DEF_CLASS_OBJ (ACL_DEFAULT | CLASS_OBJ)
72 /* default other entry */
73 #define DEF_OTHER_OBJ (ACL_DEFAULT | OTHER_OBJ)
76 * The following are defined for ace_t.
78 #define ACE_READ_DATA 0x00000001
79 #define ACE_LIST_DIRECTORY 0x00000001
80 #define ACE_WRITE_DATA 0x00000002
81 #define ACE_ADD_FILE 0x00000002
82 #define ACE_APPEND_DATA 0x00000004
83 #define ACE_ADD_SUBDIRECTORY 0x00000004
84 #define ACE_READ_NAMED_ATTRS 0x00000008
85 #define ACE_WRITE_NAMED_ATTRS 0x00000010
86 #define ACE_EXECUTE 0x00000020
87 #define ACE_DELETE_CHILD 0x00000040
88 #define ACE_READ_ATTRIBUTES 0x00000080
89 #define ACE_WRITE_ATTRIBUTES 0x00000100
90 #define ACE_DELETE 0x00010000
91 #define ACE_READ_ACL 0x00020000
92 #define ACE_WRITE_ACL 0x00040000
93 #define ACE_WRITE_OWNER 0x00080000
94 #define ACE_SYNCHRONIZE 0x00100000
96 #define ACE_FILE_INHERIT_ACE 0x0001
97 #define ACE_DIRECTORY_INHERIT_ACE 0x0002
98 #define ACE_NO_PROPAGATE_INHERIT_ACE 0x0004
99 #define ACE_INHERIT_ONLY_ACE 0x0008
100 #define ACE_SUCCESSFUL_ACCESS_ACE_FLAG 0x0010
101 #define ACE_FAILED_ACCESS_ACE_FLAG 0x0020
102 #define ACE_IDENTIFIER_GROUP 0x0040
103 #define ACE_INHERITED_ACE 0x0080
104 #define ACE_OWNER 0x1000
105 #define ACE_GROUP 0x2000
106 #define ACE_EVERYONE 0x4000
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
113 #define ACL_AUTO_INHERIT 0x0001
114 #define ACL_PROTECTED 0x0002
115 #define ACL_DEFAULTED 0x0004
116 #define ACL_FLAGS_ALL (ACL_AUTO_INHERIT|ACL_PROTECTED| \
122 * These are only applicable in a CIFS context.
124 #define ACE_ACCESS_ALLOWED_COMPOUND_ACE_TYPE 0x04
125 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05
126 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06
127 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07
128 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08
129 #define ACE_ACCESS_ALLOWED_CALLBACK_ACE_TYPE 0x09
130 #define ACE_ACCESS_DENIED_CALLBACK_ACE_TYPE 0x0A
131 #define ACE_ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE 0x0B
132 #define ACE_ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE 0x0C
133 #define ACE_SYSTEM_AUDIT_CALLBACK_ACE_TYPE 0x0D
134 #define ACE_SYSTEM_ALARM_CALLBACK_ACE_TYPE 0x0E
135 #define ACE_SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE 0x0F
136 #define ACE_SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE 0x10
138 #define ACE_ALL_TYPES 0x001F
140 typedef struct ace_object {
141 uid_t a_who; /* uid or gid */
142 uint32_t a_access_mask; /* read,write,... */
143 uint16_t a_flags; /* see below */
144 uint16_t a_type; /* allow or deny */
145 uint8_t a_obj_type[16]; /* obj type */
146 uint8_t a_inherit_obj_type[16]; /* inherit obj */
151 #define ACE_ALL_PERMS (ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \
152 ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \
153 ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \
154 ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_WRITE_ACL| \
155 ACE_WRITE_OWNER|ACE_SYNCHRONIZE)
158 * The following flags are supported by both NFSv4 ACLs and ace_t.
160 #define ACE_NFSV4_SUP_FLAGS (ACE_FILE_INHERIT_ACE | \
161 ACE_DIRECTORY_INHERIT_ACE | \
162 ACE_NO_PROPAGATE_INHERIT_ACE | \
163 ACE_INHERIT_ONLY_ACE | \
164 ACE_IDENTIFIER_GROUP)
166 #define ACE_TYPE_FLAGS (ACE_OWNER|ACE_GROUP|ACE_EVERYONE| \
167 ACE_IDENTIFIER_GROUP)
168 #define ACE_INHERIT_FLAGS (ACE_FILE_INHERIT_ACE| \
169 ACE_DIRECTORY_INHERIT_ACE|ACE_NO_PROPAGATE_INHERIT_ACE|ACE_INHERIT_ONLY_ACE)
171 /* cmd args to acl(2) for aclent_t */
176 /* cmd's to manipulate ace acls. */
179 #define ACE_GETACLCNT 6
181 /* minimal acl entries from GETACLCNT */
182 #define MIN_ACL_ENTRIES 4
184 #if !defined(_KERNEL)
186 /* acl check errors */
189 #define OTHER_ERROR 3
190 #define CLASS_ERROR 4
191 #define DUPLICATE_ERROR 5
194 #define ENTRY_ERROR 8
198 * similar to ufs_acl.h: changed to char type for user commands (tar, cpio)
201 #define UFSD_FREE ('0') /* Free entry */
202 #define UFSD_ACL ('1') /* Access Control Lists */
203 #define UFSD_DFACL ('2') /* reserved for future use */
204 #define ACE_ACL ('3') /* ace_t style acls */
207 * flag to [f]acl_get()
208 * controls whether a trivial acl should be returned.
210 #define ACL_NO_TRIVIAL 0x2
214 * Flags to control acl_totext()
217 #define ACL_APPEND_ID 0x1 /* append uid/gid to user/group entries */
218 #define ACL_COMPACT_FMT 0x2 /* build ACL in ls -V format */
219 #define ACL_NORESOLVE 0x4 /* don't do name service lookups */
222 * Legacy aclcheck errors for aclent_t ACLs
224 #define EACL_GRP_ERROR GRP_ERROR
225 #define EACL_USER_ERROR USER_ERROR
226 #define EACL_OTHER_ERROR OTHER_ERROR
227 #define EACL_CLASS_ERROR CLASS_ERROR
228 #define EACL_DUPLICATE_ERROR DUPLICATE_ERROR
229 #define EACL_MISS_ERROR MISS_ERROR
230 #define EACL_MEM_ERROR MEM_ERROR
231 #define EACL_ENTRY_ERROR ENTRY_ERROR
233 #define EACL_INHERIT_ERROR 9 /* invalid inherit flags */
234 #define EACL_FLAGS_ERROR 10 /* unknown flag value */
235 #define EACL_PERM_MASK_ERROR 11 /* unknown permission */
236 #define EACL_COUNT_ERROR 12 /* invalid acl count */
238 #define EACL_INVALID_SLOT 13 /* invalid acl slot */
239 #define EACL_NO_ACL_ENTRY 14 /* Entry doesn't exist */
240 #define EACL_DIFF_TYPE 15 /* acls aren't same type */
242 #define EACL_INVALID_USER_GROUP 16 /* need user/group name */
243 #define EACL_INVALID_STR 17 /* invalid acl string */
244 #define EACL_FIELD_NOT_BLANK 18 /* can't have blank field */
245 #define EACL_INVALID_ACCESS_TYPE 19 /* invalid access type */
246 #define EACL_UNKNOWN_DATA 20 /* Unrecognized data in ACL */
247 #define EACL_MISSING_FIELDS 21 /* missing fields in acl */
249 #define EACL_INHERIT_NOTDIR 22 /* Need dir for inheritance */
251 extern int aclcheck(aclent_t *, int, int *);
252 extern int acltomode(aclent_t *, int, mode_t *);
253 extern int aclfrommode(aclent_t *, int, mode_t *);
254 extern int aclsort(int, int, aclent_t *);
255 extern char *acltotext(aclent_t *, int);
256 extern aclent_t *aclfromtext(char *, int *);
257 extern void acl_free(acl_t *);
258 extern int acl_get(const char *, int, acl_t **);
259 extern int facl_get(int, int, acl_t **);
260 extern int acl_set(const char *, acl_t *acl);
261 extern int facl_set(int, acl_t *acl);
262 extern int acl_strip(const char *, uid_t, gid_t, mode_t);
263 extern int acl_trivial(const char *);
264 extern char *acl_totext(acl_t *, int);
265 extern int acl_fromtext(const char *, acl_t **);
266 extern int acl_check(acl_t *, int);
268 #else /* !defined(_KERNEL) */
270 extern void ksort(caddr_t, int, int, int (*)(void *, void *));
271 extern int cmp2acls(void *, void *);
273 #endif /* !defined(_KERNEL) */
275 #if defined(__STDC__)
276 extern int acl(const char *path, int cmd, int cnt, void *buf);
277 extern int facl(int fd, int cmd, int cnt, void *buf);
278 #else /* !__STDC__ */
281 #endif /* defined(__STDC__) */
287 #endif /* _SYS_ACL_H */