1/*
2 * Copyright (c) 2004, 2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
11 *
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
18 * under the License.
19 *
20 * @APPLE_LICENSE_HEADER_END@
21 */
22
23#ifndef _SYS_ACL_H
24#define _SYS_ACL_H
25
26#include <Availability.h>
27#include <_bounds.h>
28#include <sys/kauth.h>
29#include <sys/_types/_ssize_t.h>
30
31_LIBC_SINGLE_BY_DEFAULT()
32
33#define __DARWIN_ACL_READ_DATA (1<<1)
34#define __DARWIN_ACL_LIST_DIRECTORY __DARWIN_ACL_READ_DATA
35#define __DARWIN_ACL_WRITE_DATA (1<<2)
36#define __DARWIN_ACL_ADD_FILE __DARWIN_ACL_WRITE_DATA
37#define __DARWIN_ACL_EXECUTE (1<<3)
38#define __DARWIN_ACL_SEARCH __DARWIN_ACL_EXECUTE
39#define __DARWIN_ACL_DELETE (1<<4)
40#define __DARWIN_ACL_APPEND_DATA (1<<5)
41#define __DARWIN_ACL_ADD_SUBDIRECTORY __DARWIN_ACL_APPEND_DATA
42#define __DARWIN_ACL_DELETE_CHILD (1<<6)
43#define __DARWIN_ACL_READ_ATTRIBUTES (1<<7)
44#define __DARWIN_ACL_WRITE_ATTRIBUTES (1<<8)
45#define __DARWIN_ACL_READ_EXTATTRIBUTES (1<<9)
46#define __DARWIN_ACL_WRITE_EXTATTRIBUTES (1<<10)
47#define __DARWIN_ACL_READ_SECURITY (1<<11)
48#define __DARWIN_ACL_WRITE_SECURITY (1<<12)
49#define __DARWIN_ACL_CHANGE_OWNER (1<<13)
50#define __DARWIN_ACL_SYNCHRONIZE (1<<20)
51
52#define __DARWIN_ACL_EXTENDED_ALLOW 1
53#define __DARWIN_ACL_EXTENDED_DENY 2
54
55#define __DARWIN_ACL_ENTRY_INHERITED (1<<4)
56#define __DARWIN_ACL_ENTRY_FILE_INHERIT (1<<5)
57#define __DARWIN_ACL_ENTRY_DIRECTORY_INHERIT (1<<6)
58#define __DARWIN_ACL_ENTRY_LIMIT_INHERIT (1<<7)
59#define __DARWIN_ACL_ENTRY_ONLY_INHERIT (1<<8)
60#define __DARWIN_ACL_FLAG_NO_INHERIT (1<<17)
61
62/*
63 * Implementation constants.
64 *
65 * The ACL_TYPE_EXTENDED binary format permits 169 entries plus
66 * the ACL header in a page. Give ourselves some room to grow;
67 * this limit is arbitrary.
68 */
69#define ACL_MAX_ENTRIES 128
70
71/* 23.2.2 Individual object access permissions - nonstandard */
72typedef enum {
73 ACL_READ_DATA = __DARWIN_ACL_READ_DATA,
74 ACL_LIST_DIRECTORY = __DARWIN_ACL_LIST_DIRECTORY,
75 ACL_WRITE_DATA = __DARWIN_ACL_WRITE_DATA,
76 ACL_ADD_FILE = __DARWIN_ACL_ADD_FILE,
77 ACL_EXECUTE = __DARWIN_ACL_EXECUTE,
78 ACL_SEARCH = __DARWIN_ACL_SEARCH,
79 ACL_DELETE = __DARWIN_ACL_DELETE,
80 ACL_APPEND_DATA = __DARWIN_ACL_APPEND_DATA,
81 ACL_ADD_SUBDIRECTORY = __DARWIN_ACL_ADD_SUBDIRECTORY,
82 ACL_DELETE_CHILD = __DARWIN_ACL_DELETE_CHILD,
83 ACL_READ_ATTRIBUTES = __DARWIN_ACL_READ_ATTRIBUTES,
84 ACL_WRITE_ATTRIBUTES = __DARWIN_ACL_WRITE_ATTRIBUTES,
85 ACL_READ_EXTATTRIBUTES = __DARWIN_ACL_READ_EXTATTRIBUTES,
86 ACL_WRITE_EXTATTRIBUTES = __DARWIN_ACL_WRITE_EXTATTRIBUTES,
87 ACL_READ_SECURITY = __DARWIN_ACL_READ_SECURITY,
88 ACL_WRITE_SECURITY = __DARWIN_ACL_WRITE_SECURITY,
89 ACL_CHANGE_OWNER = __DARWIN_ACL_CHANGE_OWNER,
90 ACL_SYNCHRONIZE = __DARWIN_ACL_SYNCHRONIZE,
91} acl_perm_t;
92
93/* 23.2.5 ACL entry tag type bits - nonstandard */
94typedef enum {
95 ACL_UNDEFINED_TAG = 0,
96 ACL_EXTENDED_ALLOW = __DARWIN_ACL_EXTENDED_ALLOW,
97 ACL_EXTENDED_DENY = __DARWIN_ACL_EXTENDED_DENY
98} acl_tag_t;
99
100/* 23.2.6 Individual ACL types */
101typedef enum {
102 ACL_TYPE_EXTENDED = 0x00000100,
103/* Posix 1003.1e types - not supported */
104 ACL_TYPE_ACCESS = 0x00000000,
105 ACL_TYPE_DEFAULT = 0x00000001,
106/* The following types are defined on FreeBSD/Linux - not supported */
107 ACL_TYPE_AFS = 0x00000002,
108 ACL_TYPE_CODA = 0x00000003,
109 ACL_TYPE_NTFS = 0x00000004,
110 ACL_TYPE_NWFS = 0x00000005
111} acl_type_t;
112
113/* 23.2.7 ACL qualifier constants */
114
115#define ACL_UNDEFINED_ID NULL /* XXX ? */
116
117/* 23.2.8 ACL Entry Constants */
118typedef enum {
119 ACL_FIRST_ENTRY = 0,
120 ACL_NEXT_ENTRY = -1,
121 ACL_LAST_ENTRY = -2
122} acl_entry_id_t;
123
124/* nonstandard ACL / entry flags */
125typedef enum {
126 ACL_FLAG_DEFER_INHERIT = (1 << 0), /* tentative */
127 ACL_FLAG_NO_INHERIT = __DARWIN_ACL_FLAG_NO_INHERIT,
128 ACL_ENTRY_INHERITED = __DARWIN_ACL_ENTRY_INHERITED,
129 ACL_ENTRY_FILE_INHERIT = __DARWIN_ACL_ENTRY_FILE_INHERIT,
130 ACL_ENTRY_DIRECTORY_INHERIT = __DARWIN_ACL_ENTRY_DIRECTORY_INHERIT,
131 ACL_ENTRY_LIMIT_INHERIT = __DARWIN_ACL_ENTRY_LIMIT_INHERIT,
132 ACL_ENTRY_ONLY_INHERIT = __DARWIN_ACL_ENTRY_ONLY_INHERIT
133} acl_flag_t;
134
135/* "External" ACL types */
136
137struct _acl;
138struct _acl_entry;
139struct _acl_permset;
140struct _acl_flagset;
141
142typedef struct _acl *acl_t;
143typedef struct _acl_entry *acl_entry_t;
144typedef struct _acl_permset *acl_permset_t;
145typedef struct _acl_flagset *acl_flagset_t;
146
147typedef u_int64_t acl_permset_mask_t;
148
149__BEGIN_DECLS
150/* 23.1.6.1 ACL Storage Management */
151extern acl_t acl_dup(acl_t acl);
152extern int acl_free(void *obj_p);
153extern acl_t acl_init(int count);
154
155/* 23.1.6.2 (1) ACL Entry manipulation */
156extern int acl_copy_entry(acl_entry_t dest_d, acl_entry_t src_d);
157extern int acl_create_entry(acl_t *acl_p, acl_entry_t *entry_p);
158extern int acl_create_entry_np(acl_t *acl_p, acl_entry_t *entry_p, int entry_index);
159extern int acl_delete_entry(acl_t acl, acl_entry_t entry_d);
160extern int acl_get_entry(acl_t acl, int entry_id, acl_entry_t *entry_p);
161extern int acl_valid(acl_t acl);
162extern int acl_valid_fd_np(int fd, acl_type_t type, acl_t acl);
163extern int acl_valid_file_np(const char *path, acl_type_t type, acl_t acl);
164extern int acl_valid_link_np(const char *path, acl_type_t type, acl_t acl);
165
166/* 23.1.6.2 (2) Manipulate permissions within an ACL entry */
167extern int acl_add_perm(acl_permset_t permset_d, acl_perm_t perm);
168extern int acl_calc_mask(acl_t *acl_p); /* not supported */
169extern int acl_clear_perms(acl_permset_t permset_d);
170extern int acl_delete_perm(acl_permset_t permset_d, acl_perm_t perm);
171extern int acl_get_perm_np(acl_permset_t permset_d, acl_perm_t perm);
172extern int acl_get_permset(acl_entry_t entry_d, acl_permset_t *permset_p);
173extern int acl_set_permset(acl_entry_t entry_d, acl_permset_t permset_d);
174
175/* nonstandard - manipulate permissions within an ACL entry using bitmasks */
176extern int acl_maximal_permset_mask_np(acl_permset_mask_t * mask_p) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
177extern int acl_get_permset_mask_np(acl_entry_t entry_d, acl_permset_mask_t * mask_p) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
178extern int acl_set_permset_mask_np(acl_entry_t entry_d, acl_permset_mask_t mask) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
179
180/* nonstandard - manipulate flags on ACLs and entries */
181extern int acl_add_flag_np(acl_flagset_t flagset_d, acl_flag_t flag);
182extern int acl_clear_flags_np(acl_flagset_t flagset_d);
183extern int acl_delete_flag_np(acl_flagset_t flagset_d, acl_flag_t flag);
184extern int acl_get_flag_np(acl_flagset_t flagset_d, acl_flag_t flag);
185extern int acl_get_flagset_np(void *obj_p, acl_flagset_t *flagset_p);
186extern int acl_set_flagset_np(void *obj_p, acl_flagset_t flagset_d);
187
188/* 23.1.6.2 (3) Manipulate ACL entry tag type and qualifier */
189extern void *acl_get_qualifier(acl_entry_t entry_d);
190extern int acl_get_tag_type(acl_entry_t entry_d, acl_tag_t *tag_type_p);
191extern int acl_set_qualifier(acl_entry_t entry_d, const void *tag_qualifier_p);
192extern int acl_set_tag_type(acl_entry_t entry_d, acl_tag_t tag_type);
193
194/* 23.1.6.3 ACL manipulation on an Object */
195extern int acl_delete_def_file(const char *path_p); /* not supported */
196extern acl_t acl_get_fd(int fd);
197extern acl_t acl_get_fd_np(int fd, acl_type_t type);
198extern acl_t acl_get_file(const char *path_p, acl_type_t type);
199extern acl_t acl_get_link_np(const char *path_p, acl_type_t type);
200extern int acl_set_fd(int fd, acl_t acl);
201extern int acl_set_fd_np(int fd, acl_t acl, acl_type_t acl_type);
202extern int acl_set_file(const char *path_p, acl_type_t type, acl_t acl);
203extern int acl_set_link_np(const char *path_p, acl_type_t type, acl_t acl);
204
205/* 23.1.6.4 ACL Format translation */
206extern ssize_t acl_copy_ext(void *_LIBC_SIZE(size) buf_p, acl_t acl, ssize_t size);
207extern ssize_t acl_copy_ext_native(void *_LIBC_SIZE(size) buf_p, acl_t acl, ssize_t size);
208extern acl_t acl_copy_int(const void *_LIBC_UNSAFE_INDEXABLE buf_p);
209extern acl_t acl_copy_int_native(const void *_LIBC_UNSAFE_INDEXABLE buf_p);
210extern acl_t acl_from_text(const char *_LIBC_UNSAFE_INDEXABLE buf_p);
211extern ssize_t acl_size(acl_t acl);
212extern char *_LIBC_CSTR acl_to_text(acl_t acl, ssize_t *len_p);
213__END_DECLS
214
215#endif /* _SYS_ACL_H */