2 * Copyright (c) 1999-2001 Robert N. M. Watson
5 * This software was developed by Robert Watson for the TrustedBSD Project.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * Developed by the TrustedBSD Project.
32 * Support for POSIX.1e access control lists.
39 * POSIX.1e ACL types and related constants.
42 #define POSIX1E_ACL_ACCESS_EXTATTR_NAMESPACE EXTATTR_NAMESPACE_SYSTEM
43 #define POSIX1E_ACL_ACCESS_EXTATTR_NAME "posix1e.acl_access"
44 #define POSIX1E_ACL_DEFAULT_EXTATTR_NAMESPACE EXTATTR_NAMESPACE_SYSTEM
45 #define POSIX1E_ACL_DEFAULT_EXTATTR_NAME "posix1e.acl_default"
46 #define ACL_MAX_ENTRIES 32 /* maximum entries in an ACL */
48 typedef int acl_type_t;
49 typedef int acl_tag_t;
50 typedef mode_t acl_perm_t;
51 typedef mode_t *acl_permset_t;
58 typedef struct acl_entry *acl_entry_t;
60 /* internal ACL structure */
63 struct acl_entry acl_entry[ACL_MAX_ENTRIES];
66 /* external ACL structure */
71 typedef struct acl_t_struct *acl_t;
74 * Possible valid values for ae_tag field.
76 #define ACL_UNDEFINED_TAG 0x00000000
77 #define ACL_USER_OBJ 0x00000001
78 #define ACL_USER 0x00000002
79 #define ACL_GROUP_OBJ 0x00000004
80 #define ACL_GROUP 0x00000008
81 #define ACL_MASK 0x00000010
82 #define ACL_OTHER 0x00000020
83 #define ACL_OTHER_OBJ ACL_OTHER
86 * Possible valid values for acl_type_t arguments.
88 #define ACL_TYPE_ACCESS 0x00000000
89 #define ACL_TYPE_DEFAULT 0x00000001
90 #define ACL_TYPE_AFS 0x00000002
91 #define ACL_TYPE_CODA 0x00000003
92 #define ACL_TYPE_NTFS 0x00000004
93 #define ACL_TYPE_NWFS 0x00000005
96 * Possible flags in ae_perm field.
98 #define ACL_EXECUTE 0x0001
99 #define ACL_WRITE 0x0002
100 #define ACL_READ 0x0004
101 #define ACL_PERM_NONE 0x0000
102 #define ACL_PERM_BITS (ACL_EXECUTE | ACL_WRITE | ACL_READ)
103 #define ACL_POSIX1E_BITS (ACL_EXECUTE | ACL_WRITE | ACL_READ)
106 * Possible entry_id values for acl_get_entry()
108 #define ACL_FIRST_ENTRY 0
109 #define ACL_NEXT_ENTRY 1
112 * Undefined value in ae_id field
114 #define ACL_UNDEFINED_ID ((uid_t)-1)
120 * Storage for ACLs and support structures.
122 #ifdef MALLOC_DECLARE
123 MALLOC_DECLARE(M_ACL);
126 acl_perm_t acl_posix1e_mode_to_perm(acl_tag_t tag, mode_t mode);
127 struct acl_entry acl_posix1e_mode_to_entry(acl_tag_t tag, uid_t uid,
128 gid_t gid, mode_t mode);
129 mode_t acl_posix1e_perms_to_mode(struct acl_entry *acl_user_obj_entry,
130 struct acl_entry *acl_group_obj_entry, struct acl_entry *acl_other_entry);
131 int acl_posix1e_check(struct acl *acl);
136 * Syscall interface -- use the library calls instead as the syscalls
137 * have strict acl entry ordering requirements.
140 int __acl_aclcheck_fd(int _filedes, acl_type_t _type, struct acl *_aclp);
141 int __acl_aclcheck_file(const char *_path, acl_type_t _type,
143 int __acl_delete_fd(int _filedes, acl_type_t _type);
144 int __acl_delete_file(const char *_path_p, acl_type_t _type);
145 int __acl_get_fd(int _filedes, acl_type_t _type, struct acl *_aclp);
146 int __acl_get_file(const char *_path, acl_type_t _type, struct acl *_aclp);
147 int __acl_set_fd(int _filedes, acl_type_t _type, struct acl *_aclp);
148 int __acl_set_file(const char *_path, acl_type_t _type, struct acl *_aclp);
152 * Supported POSIX.1e ACL manipulation and assignment/retrieval API
153 * _np calls are local extensions that reflect an environment capable of
154 * opening file descriptors of directories, and allowing additional
155 * ACL type for different filesystems (i.e., AFS).
158 int acl_add_perm(acl_permset_t _permset_d, acl_perm_t _perm);
159 int acl_calc_mask(acl_t *_acl_p);
160 int acl_clear_perms(acl_permset_t _permset_d);
161 int acl_copy_entry(acl_entry_t _dest_d, acl_entry_t _src_d);
162 ssize_t acl_copy_ext(void *_buf_p, acl_t _acl, ssize_t _size);
163 acl_t acl_copy_int(const void *_buf_p);
164 int acl_create_entry(acl_t *_acl_p, acl_entry_t *_entry_p);
165 int acl_delete_fd_np(int _filedes, acl_type_t _type);
166 int acl_delete_entry(acl_t _acl, acl_entry_t _entry_d);
167 int acl_delete_file_np(const char *_path_p, acl_type_t _type);
168 int acl_delete_def_file(const char *_path_p);
169 int acl_delete_perm(acl_permset_t _permset_d, acl_perm_t _perm);
170 acl_t acl_dup(acl_t _acl);
171 int acl_free(void *_obj_p);
172 acl_t acl_from_text(const char *_buf_p);
173 int acl_get_entry(acl_t _acl, int _entry_id, acl_entry_t *_entry_p);
174 acl_t acl_get_fd(int _fd);
175 acl_t acl_get_fd_np(int fd, acl_type_t _type);
176 acl_t acl_get_file(const char *_path_p, acl_type_t _type);
177 void *acl_get_qualifier(acl_entry_t _entry_d);
178 int acl_get_perm_np(acl_permset_t _permset_d, acl_perm_t _perm);
179 int acl_get_permset(acl_entry_t _entry_d, acl_permset_t *_permset_p);
180 int acl_get_tag_type(acl_entry_t _entry_d, acl_tag_t *_tag_type_p);
181 acl_t acl_init(int _count);
182 int acl_set_fd(int _fd, acl_t _acl);
183 int acl_set_fd_np(int _fd, acl_t _acl, acl_type_t _type);
184 int acl_set_file(const char *_path_p, acl_type_t _type, acl_t _acl);
185 int acl_set_permset(acl_entry_t _entry_d, acl_permset_t _permset_d);
186 int acl_set_qualifier(acl_entry_t _entry_d, const void *_tag_qualifier_p);
187 int acl_set_tag_type(acl_entry_t _entry_d, acl_tag_t _tag_type);
188 ssize_t acl_size(acl_t _acl);
189 char *acl_to_text(acl_t _acl, ssize_t *_len_p);
190 int acl_valid(acl_t _acl);
191 int acl_valid_fd_np(int _fd, acl_type_t _type, acl_t _acl);
192 int acl_valid_file_np(const char *_path_p, acl_type_t _type, acl_t _acl);
195 #endif /* !_KERNEL */
197 #endif /* !_SYS_ACL_H */