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