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