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 2014 Garrett D'Amore <garrett@damore.org> 23 * 24 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 25 * Use is subject to license terms. 26 * 27 * Copyright 2014 Nexenta Systems, Inc. All rights reserved. 28 */ 29 30 #ifndef _SYS_ACL_H 31 #define _SYS_ACL_H 32 33 #include <sys/types.h> 34 #include <sys/acl_impl.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 #define MAX_ACL_ENTRIES (1024) /* max entries of each type */ 41 typedef struct acl { 42 int a_type; /* the type of ACL entry */ 43 uid_t a_id; /* the entry in -uid or gid */ 44 o_mode_t a_perm; /* the permission field */ 45 } aclent_t; 46 47 typedef struct ace { 48 uid_t a_who; /* uid or gid */ 49 uint32_t a_access_mask; /* read,write,... */ 50 uint16_t a_flags; /* see below */ 51 uint16_t a_type; /* allow or deny */ 52 } ace_t; 53 54 typedef struct acl_info acl_t; 55 56 /* 57 * The following are Defined types for an aclent_t. 58 */ 59 #define USER_OBJ (0x01) /* object owner */ 60 #define USER (0x02) /* additional users */ 61 #define GROUP_OBJ (0x04) /* owning group of the object */ 62 #define GROUP (0x08) /* additional groups */ 63 #define CLASS_OBJ (0x10) /* file group class and mask entry */ 64 #define OTHER_OBJ (0x20) /* other entry for the object */ 65 #define ACL_DEFAULT (0x1000) /* default flag */ 66 /* default object owner */ 67 #define DEF_USER_OBJ (ACL_DEFAULT | USER_OBJ) 68 /* default additional users */ 69 #define DEF_USER (ACL_DEFAULT | USER) 70 /* default owning group */ 71 #define DEF_GROUP_OBJ (ACL_DEFAULT | GROUP_OBJ) 72 /* default additional groups */ 73 #define DEF_GROUP (ACL_DEFAULT | GROUP) 74 /* default mask entry */ 75 #define DEF_CLASS_OBJ (ACL_DEFAULT | CLASS_OBJ) 76 /* default other entry */ 77 #define DEF_OTHER_OBJ (ACL_DEFAULT | OTHER_OBJ) 78 79 /* 80 * The following are defined for ace_t. 81 * 82 * Note, these are intentionally the same as the Windows 83 * "File Access Rights Constants" you can find on MSDN. 84 * (See also: "Standard Access Rights" on MSDN). 85 * 86 * The equivalent Windows names for these are just like 87 * those show below, with FILE_ in place of ACE_, except 88 * as noted below. Also note that Windows uses a special 89 * privilege: BYPASS_TRAVERSE_CHECKING, normally granted 90 * to everyone, that causes the absence of ACE_TRAVERSE 91 * to be ignored. 92 */ 93 #define ACE_READ_DATA 0x00000001 /* file: read data */ 94 #define ACE_LIST_DIRECTORY 0x00000001 /* dir: list files */ 95 #define ACE_WRITE_DATA 0x00000002 /* file: write data */ 96 #define ACE_ADD_FILE 0x00000002 /* dir: create file */ 97 #define ACE_APPEND_DATA 0x00000004 /* file: append data */ 98 #define ACE_ADD_SUBDIRECTORY 0x00000004 /* dir: create subdir */ 99 #define ACE_READ_NAMED_ATTRS 0x00000008 /* FILE_READ_EA */ 100 #define ACE_WRITE_NAMED_ATTRS 0x00000010 /* FILE_WRITE_EA */ 101 #define ACE_EXECUTE 0x00000020 /* file: execute */ 102 #define ACE_TRAVERSE 0x00000020 /* dir: lookup name */ 103 #define ACE_DELETE_CHILD 0x00000040 /* dir: unlink child */ 104 #define ACE_READ_ATTRIBUTES 0x00000080 /* (all) stat, etc. */ 105 #define ACE_WRITE_ATTRIBUTES 0x00000100 /* (all) utimes, etc. */ 106 #define ACE_DELETE 0x00010000 /* (all) unlink self */ 107 #define ACE_READ_ACL 0x00020000 /* (all) getsecattr */ 108 #define ACE_WRITE_ACL 0x00040000 /* (all) setsecattr */ 109 #define ACE_WRITE_OWNER 0x00080000 /* (all) chown */ 110 #define ACE_SYNCHRONIZE 0x00100000 /* (all) see MSDN */ 111 112 /* 113 * Some of the following are the same as Windows uses. (but NOT ALL!) 114 * See the "ACE_HEADER" structure description on MSDN for details. 115 * Comments show relations to the MSDN names. 116 */ 117 #define ACE_FILE_INHERIT_ACE 0x0001 /* = OBJECT_INHERIT_ACE */ 118 #define ACE_DIRECTORY_INHERIT_ACE 0x0002 /* = CONTAINER_INHERIT_ACE */ 119 #define ACE_NO_PROPAGATE_INHERIT_ACE 0x0004 /* = NO_PROPAGATE_INHERIT_ACE */ 120 #define ACE_INHERIT_ONLY_ACE 0x0008 /* = INHERIT_ONLY_ACE */ 121 #define ACE_SUCCESSFUL_ACCESS_ACE_FLAG 0x0010 122 #define ACE_FAILED_ACCESS_ACE_FLAG 0x0020 123 #define ACE_IDENTIFIER_GROUP 0x0040 124 #define ACE_INHERITED_ACE 0x0080 /* INHERITED_ACE, 0x10 on NT */ 125 #define ACE_OWNER 0x1000 126 #define ACE_GROUP 0x2000 127 #define ACE_EVERYONE 0x4000 128 129 /* These four are the same as Windows, but with an ACE_ prefix added. */ 130 #define ACE_ACCESS_ALLOWED_ACE_TYPE 0x0000 131 #define ACE_ACCESS_DENIED_ACE_TYPE 0x0001 132 #define ACE_SYSTEM_AUDIT_ACE_TYPE 0x0002 133 #define ACE_SYSTEM_ALARM_ACE_TYPE 0x0003 134 135 #define ACL_AUTO_INHERIT 0x0001 136 #define ACL_PROTECTED 0x0002 137 #define ACL_DEFAULTED 0x0004 138 #define ACL_FLAGS_ALL (ACL_AUTO_INHERIT|ACL_PROTECTED| \ 139 ACL_DEFAULTED) 140 141 /* 142 * These are only applicable in a CIFS context. 143 * Here again, same as Windows, but with an ACE_ prefix added. 144 */ 145 #define ACE_ACCESS_ALLOWED_COMPOUND_ACE_TYPE 0x04 146 #define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05 147 #define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06 148 #define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07 149 #define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08 150 #define ACE_ACCESS_ALLOWED_CALLBACK_ACE_TYPE 0x09 151 #define ACE_ACCESS_DENIED_CALLBACK_ACE_TYPE 0x0A 152 #define ACE_ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE 0x0B 153 #define ACE_ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE 0x0C 154 #define ACE_SYSTEM_AUDIT_CALLBACK_ACE_TYPE 0x0D 155 #define ACE_SYSTEM_ALARM_CALLBACK_ACE_TYPE 0x0E 156 #define ACE_SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE 0x0F 157 #define ACE_SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE 0x10 158 159 #define ACE_ALL_TYPES 0x001F 160 161 #ifdef _KERNEL 162 163 typedef struct ace_object { 164 uid_t a_who; /* uid or gid */ 165 uint32_t a_access_mask; /* read,write,... */ 166 uint16_t a_flags; /* see below */ 167 uint16_t a_type; /* allow or deny */ 168 uint8_t a_obj_type[16]; /* obj type */ 169 uint8_t a_inherit_obj_type[16]; /* inherit obj */ 170 } ace_object_t; 171 172 #endif 173 174 #define ACE_ALL_PERMS (ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \ 175 ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \ 176 ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \ 177 ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_WRITE_ACL| \ 178 ACE_WRITE_OWNER|ACE_SYNCHRONIZE) 179 180 #define ACE_ALL_WRITE_PERMS (ACE_WRITE_DATA|ACE_APPEND_DATA| \ 181 ACE_WRITE_ATTRIBUTES|ACE_WRITE_NAMED_ATTRS|ACE_WRITE_ACL| \ 182 ACE_WRITE_OWNER|ACE_DELETE|ACE_DELETE_CHILD) 183 184 #define ACE_READ_PERMS (ACE_READ_DATA|ACE_READ_ACL|ACE_READ_ATTRIBUTES| \ 185 ACE_READ_NAMED_ATTRS) 186 187 #define ACE_WRITE_PERMS (ACE_WRITE_DATA|ACE_APPEND_DATA|ACE_WRITE_ATTRIBUTES| \ 188 ACE_WRITE_NAMED_ATTRS) 189 190 #define ACE_MODIFY_PERMS (ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \ 191 ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \ 192 ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \ 193 ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_SYNCHRONIZE) 194 /* 195 * The following flags are supported by both NFSv4 ACLs and ace_t. 196 */ 197 #define ACE_NFSV4_SUP_FLAGS (ACE_FILE_INHERIT_ACE | \ 198 ACE_DIRECTORY_INHERIT_ACE | \ 199 ACE_NO_PROPAGATE_INHERIT_ACE | \ 200 ACE_INHERIT_ONLY_ACE | \ 201 ACE_IDENTIFIER_GROUP) 202 203 #define ACE_TYPE_FLAGS (ACE_OWNER|ACE_GROUP|ACE_EVERYONE| \ 204 ACE_IDENTIFIER_GROUP) 205 #define ACE_INHERIT_FLAGS (ACE_FILE_INHERIT_ACE| \ 206 ACE_DIRECTORY_INHERIT_ACE|ACE_NO_PROPAGATE_INHERIT_ACE|ACE_INHERIT_ONLY_ACE) 207 208 /* cmd args to acl(2) for aclent_t */ 209 #define GETACL 1 210 #define SETACL 2 211 #define GETACLCNT 3 212 213 /* cmd's to manipulate ace acls. */ 214 #define ACE_GETACL 4 215 #define ACE_SETACL 5 216 #define ACE_GETACLCNT 6 217 218 /* minimal acl entries from GETACLCNT */ 219 #define MIN_ACL_ENTRIES 4 220 221 #if !defined(_KERNEL) 222 223 /* acl check errors */ 224 #define GRP_ERROR 1 225 #define USER_ERROR 2 226 #define OTHER_ERROR 3 227 #define CLASS_ERROR 4 228 #define DUPLICATE_ERROR 5 229 #define MISS_ERROR 6 230 #define MEM_ERROR 7 231 #define ENTRY_ERROR 8 232 233 234 /* 235 * similar to ufs_acl.h: changed to char type for user commands (tar, cpio) 236 * Attribute types 237 */ 238 #define UFSD_FREE ('0') /* Free entry */ 239 #define UFSD_ACL ('1') /* Access Control Lists */ 240 #define UFSD_DFACL ('2') /* reserved for future use */ 241 #define ACE_ACL ('3') /* ace_t style acls */ 242 243 /* 244 * flag to [f]acl_get() 245 * controls whether a trivial acl should be returned. 246 */ 247 #define ACL_NO_TRIVIAL 0x2 248 249 250 /* 251 * Flags to control acl_totext() 252 */ 253 254 #define ACL_APPEND_ID 0x1 /* append uid/gid to user/group entries */ 255 #define ACL_COMPACT_FMT 0x2 /* build ACL in ls -V format */ 256 #define ACL_NORESOLVE 0x4 /* don't do name service lookups */ 257 #define ACL_SID_FMT 0x8 /* use usersid/groupsid when appropriate */ 258 259 /* 260 * Legacy aclcheck errors for aclent_t ACLs 261 */ 262 #define EACL_GRP_ERROR GRP_ERROR 263 #define EACL_USER_ERROR USER_ERROR 264 #define EACL_OTHER_ERROR OTHER_ERROR 265 #define EACL_CLASS_ERROR CLASS_ERROR 266 #define EACL_DUPLICATE_ERROR DUPLICATE_ERROR 267 #define EACL_MISS_ERROR MISS_ERROR 268 #define EACL_MEM_ERROR MEM_ERROR 269 #define EACL_ENTRY_ERROR ENTRY_ERROR 270 271 #define EACL_INHERIT_ERROR 9 /* invalid inherit flags */ 272 #define EACL_FLAGS_ERROR 10 /* unknown flag value */ 273 #define EACL_PERM_MASK_ERROR 11 /* unknown permission */ 274 #define EACL_COUNT_ERROR 12 /* invalid acl count */ 275 276 #define EACL_INVALID_SLOT 13 /* invalid acl slot */ 277 #define EACL_NO_ACL_ENTRY 14 /* Entry doesn't exist */ 278 #define EACL_DIFF_TYPE 15 /* acls aren't same type */ 279 280 #define EACL_INVALID_USER_GROUP 16 /* need user/group name */ 281 #define EACL_INVALID_STR 17 /* invalid acl string */ 282 #define EACL_FIELD_NOT_BLANK 18 /* can't have blank field */ 283 #define EACL_INVALID_ACCESS_TYPE 19 /* invalid access type */ 284 #define EACL_UNKNOWN_DATA 20 /* Unrecognized data in ACL */ 285 #define EACL_MISSING_FIELDS 21 /* missing fields in acl */ 286 287 #define EACL_INHERIT_NOTDIR 22 /* Need dir for inheritance */ 288 289 extern int aclcheck(aclent_t *, int, int *); 290 extern int acltomode(aclent_t *, int, mode_t *); 291 extern int aclfrommode(aclent_t *, int, mode_t *); 292 extern int aclsort(int, int, aclent_t *); 293 extern char *acltotext(aclent_t *, int); 294 extern aclent_t *aclfromtext(char *, int *); 295 extern void acl_free(acl_t *); 296 extern int acl_get(const char *, int, acl_t **); 297 extern int facl_get(int, int, acl_t **); 298 extern int acl_set(const char *, acl_t *acl); 299 extern int facl_set(int, acl_t *acl); 300 extern int acl_strip(const char *, uid_t, gid_t, mode_t); 301 extern int acl_trivial(const char *); 302 extern char *acl_totext(acl_t *, int); 303 extern int acl_fromtext(const char *, acl_t **); 304 extern int acl_check(acl_t *, int); 305 306 #else /* !defined(_KERNEL) */ 307 308 extern void ksort(caddr_t, int, int, int (*)(void *, void *)); 309 extern int cmp2acls(void *, void *); 310 311 #endif /* !defined(_KERNEL) */ 312 313 extern int acl(const char *path, int cmd, int cnt, void *buf); 314 extern int facl(int fd, int cmd, int cnt, void *buf); 315 316 #ifdef __cplusplus 317 } 318 #endif 319 320 #endif /* _SYS_ACL_H */ 321