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 https://opensource.org/licenses/CDDL-1.0. 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 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 * 25 * Copyright 2014 Garrett D'Amore <garrett@damore.org> 26 * Copyright 2014 Nexenta Systems, Inc. All rights reserved. 27 * Copyright 2017 RackTop Systems. 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 37extern "C" { 38#endif 39 40#define MAX_ACL_ENTRIES (1024) /* max entries of each type */ 41typedef 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 47typedef 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 54typedef 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#define ACE_READ_DATA 0x00000001 /* file: read data */ 83#define ACE_LIST_DIRECTORY 0x00000001 /* dir: list files */ 84#define ACE_WRITE_DATA 0x00000002 /* file: write data */ 85#define ACE_ADD_FILE 0x00000002 /* dir: create file */ 86#define ACE_APPEND_DATA 0x00000004 /* file: append data */ 87#define ACE_ADD_SUBDIRECTORY 0x00000004 /* dir: create subdir */ 88#define ACE_READ_NAMED_ATTRS 0x00000008 /* FILE_READ_EA */ 89#define ACE_WRITE_NAMED_ATTRS 0x00000010 /* FILE_WRITE_EA */ 90#define ACE_EXECUTE 0x00000020 /* file: execute */ 91#define ACE_TRAVERSE 0x00000020 /* dir: lookup name */ 92#define ACE_DELETE_CHILD 0x00000040 /* dir: unlink child */ 93#define ACE_READ_ATTRIBUTES 0x00000080 /* (all) stat, etc. */ 94#define ACE_WRITE_ATTRIBUTES 0x00000100 /* (all) utimes, etc. */ 95#define ACE_DELETE 0x00010000 /* (all) unlink self */ 96#define ACE_READ_ACL 0x00020000 /* (all) getsecattr */ 97#define ACE_WRITE_ACL 0x00040000 /* (all) setsecattr */ 98#define ACE_WRITE_OWNER 0x00080000 /* (all) chown */ 99#define ACE_SYNCHRONIZE 0x00100000 /* (all) */ 100 101#define ACE_FILE_INHERIT_ACE 0x0001 102#define ACE_DIRECTORY_INHERIT_ACE 0x0002 103#define ACE_NO_PROPAGATE_INHERIT_ACE 0x0004 104#define ACE_INHERIT_ONLY_ACE 0x0008 105#define ACE_SUCCESSFUL_ACCESS_ACE_FLAG 0x0010 106#define ACE_FAILED_ACCESS_ACE_FLAG 0x0020 107#define ACE_IDENTIFIER_GROUP 0x0040 108#define ACE_INHERITED_ACE 0x0080 109#define ACE_OWNER 0x1000 110#define ACE_GROUP 0x2000 111#define ACE_EVERYONE 0x4000 112 113#define ACE_ACCESS_ALLOWED_ACE_TYPE 0x0000 114#define ACE_ACCESS_DENIED_ACE_TYPE 0x0001 115#define ACE_SYSTEM_AUDIT_ACE_TYPE 0x0002 116#define ACE_SYSTEM_ALARM_ACE_TYPE 0x0003 117 118#define ACL_AUTO_INHERIT 0x0001 119#define ACL_PROTECTED 0x0002 120#define ACL_DEFAULTED 0x0004 121#define ACL_FLAGS_ALL (ACL_AUTO_INHERIT|ACL_PROTECTED| \ 122 ACL_DEFAULTED) 123 124/* 125 * These are only applicable in a CIFS context. 126 */ 127#define ACE_ACCESS_ALLOWED_COMPOUND_ACE_TYPE 0x04 128#define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05 129#define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06 130#define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07 131#define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08 132#define ACE_ACCESS_ALLOWED_CALLBACK_ACE_TYPE 0x09 133#define ACE_ACCESS_DENIED_CALLBACK_ACE_TYPE 0x0A 134#define ACE_ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE 0x0B 135#define ACE_ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE 0x0C 136#define ACE_SYSTEM_AUDIT_CALLBACK_ACE_TYPE 0x0D 137#define ACE_SYSTEM_ALARM_CALLBACK_ACE_TYPE 0x0E 138#define ACE_SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE 0x0F 139#define ACE_SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE 0x10 140 141#define ACE_ALL_TYPES 0x001F 142 143#if defined(_KERNEL) 144 145typedef struct ace_object { 146 uid_t a_who; /* uid or gid */ 147 uint32_t a_access_mask; /* read,write,... */ 148 uint16_t a_flags; /* see below */ 149 uint16_t a_type; /* allow or deny */ 150 uint8_t a_obj_type[16]; /* obj type */ 151 uint8_t a_inherit_obj_type[16]; /* inherit obj */ 152} ace_object_t; 153 154#endif 155 156#define ACE_ALL_PERMS (ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \ 157 ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \ 158 ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \ 159 ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_WRITE_ACL| \ 160 ACE_WRITE_OWNER|ACE_SYNCHRONIZE) 161 162#define ACE_ALL_WRITE_PERMS (ACE_WRITE_DATA|ACE_APPEND_DATA| \ 163 ACE_WRITE_ATTRIBUTES|ACE_WRITE_NAMED_ATTRS|ACE_WRITE_ACL| \ 164 ACE_WRITE_OWNER|ACE_DELETE|ACE_DELETE_CHILD) 165 166#define ACE_READ_PERMS (ACE_READ_DATA|ACE_READ_ACL|ACE_READ_ATTRIBUTES| \ 167 ACE_READ_NAMED_ATTRS) 168 169#define ACE_WRITE_PERMS (ACE_WRITE_DATA|ACE_APPEND_DATA|ACE_WRITE_ATTRIBUTES| \ 170 ACE_WRITE_NAMED_ATTRS) 171 172#define ACE_MODIFY_PERMS (ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \ 173 ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \ 174 ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \ 175 ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_SYNCHRONIZE) 176 177/* 178 * The following flags are supported by both NFSv4 ACLs and ace_t. 179 */ 180#define ACE_NFSV4_SUP_FLAGS (ACE_FILE_INHERIT_ACE | \ 181 ACE_DIRECTORY_INHERIT_ACE | \ 182 ACE_NO_PROPAGATE_INHERIT_ACE | \ 183 ACE_INHERIT_ONLY_ACE | \ 184 ACE_IDENTIFIER_GROUP) 185 186#define ACE_TYPE_FLAGS (ACE_OWNER|ACE_GROUP|ACE_EVERYONE| \ 187 ACE_IDENTIFIER_GROUP) 188#define ACE_INHERIT_FLAGS (ACE_FILE_INHERIT_ACE| \ 189 ACE_DIRECTORY_INHERIT_ACE|ACE_NO_PROPAGATE_INHERIT_ACE|ACE_INHERIT_ONLY_ACE) 190 191/* cmd args to acl(2) for aclent_t */ 192#define GETACL 1 193#define SETACL 2 194#define GETACLCNT 3 195 196/* cmd's to manipulate ace acls. */ 197#define ACE_GETACL 4 198#define ACE_SETACL 5 199#define ACE_GETACLCNT 6 200 201/* minimal acl entries from GETACLCNT */ 202#define MIN_ACL_ENTRIES 4 203 204#if !defined(_KERNEL) 205 206/* acl check errors */ 207#define GRP_ERROR 1 208#define USER_ERROR 2 209#define OTHER_ERROR 3 210#define CLASS_ERROR 4 211#define DUPLICATE_ERROR 5 212#define MISS_ERROR 6 213#define MEM_ERROR 7 214#define ENTRY_ERROR 8 215 216 217/* 218 * similar to ufs_acl.h: changed to char type for user commands (tar, cpio) 219 * Attribute types 220 */ 221#define UFSD_FREE ('0') /* Free entry */ 222#define UFSD_ACL ('1') /* Access Control Lists */ 223#define UFSD_DFACL ('2') /* reserved for future use */ 224#define ACE_ACL ('3') /* ace_t style acls */ 225 226/* 227 * flag to [f]acl_get() 228 * controls whether a trivial acl should be returned. 229 */ 230#define ACL_NO_TRIVIAL 0x2 231 232 233/* 234 * Flags to control acl_totext() 235 */ 236 237#define ACL_APPEND_ID 0x1 /* append uid/gid to user/group entries */ 238#define ACL_COMPACT_FMT 0x2 /* build ACL in ls -V format */ 239#define ACL_NORESOLVE 0x4 /* don't do name service lookups */ 240#define ACL_SID_FMT 0x8 /* use usersid/groupsid when appropriate */ 241 242/* 243 * Legacy aclcheck errors for aclent_t ACLs 244 */ 245#define EACL_GRP_ERROR GRP_ERROR 246#define EACL_USER_ERROR USER_ERROR 247#define EACL_OTHER_ERROR OTHER_ERROR 248#define EACL_CLASS_ERROR CLASS_ERROR 249#define EACL_DUPLICATE_ERROR DUPLICATE_ERROR 250#define EACL_MISS_ERROR MISS_ERROR 251#define EACL_MEM_ERROR MEM_ERROR 252#define EACL_ENTRY_ERROR ENTRY_ERROR 253 254#define EACL_INHERIT_ERROR 9 /* invalid inherit flags */ 255#define EACL_FLAGS_ERROR 10 /* unknown flag value */ 256#define EACL_PERM_MASK_ERROR 11 /* unknown permission */ 257#define EACL_COUNT_ERROR 12 /* invalid acl count */ 258 259#define EACL_INVALID_SLOT 13 /* invalid acl slot */ 260#define EACL_NO_ACL_ENTRY 14 /* Entry doesn't exist */ 261#define EACL_DIFF_TYPE 15 /* acls aren't same type */ 262 263#define EACL_INVALID_USER_GROUP 16 /* need user/group name */ 264#define EACL_INVALID_STR 17 /* invalid acl string */ 265#define EACL_FIELD_NOT_BLANK 18 /* can't have blank field */ 266#define EACL_INVALID_ACCESS_TYPE 19 /* invalid access type */ 267#define EACL_UNKNOWN_DATA 20 /* Unrecognized data in ACL */ 268#define EACL_MISSING_FIELDS 21 /* missing fields in acl */ 269 270#define EACL_INHERIT_NOTDIR 22 /* Need dir for inheritance */ 271 272extern int aclcheck(aclent_t *, int, int *); 273extern int acltomode(aclent_t *, int, mode_t *); 274extern int aclfrommode(aclent_t *, int, mode_t *); 275extern int aclsort(int, int, aclent_t *); 276extern char *acltotext(aclent_t *, int); 277extern aclent_t *aclfromtext(char *, int *); 278extern void acl_free(acl_t *); 279extern int acl_get(const char *, int, acl_t **); 280extern int facl_get(int, int, acl_t **); 281extern int acl_set(const char *, acl_t *acl); 282extern int facl_set(int, acl_t *acl); 283extern int acl_strip(const char *, uid_t, gid_t, mode_t); 284extern int acl_trivial(const char *); 285extern char *acl_totext(acl_t *, int); 286extern int acl_fromtext(const char *, acl_t **); 287extern int acl_check(acl_t *, int); 288 289#else /* !defined(_KERNEL) */ 290 291extern void ksort(caddr_t, int, int, int (*)(void *, void *)); 292extern int cmp2acls(void *, void *); 293 294#endif /* !defined(_KERNEL) */ 295 296extern int acl(const char *path, int cmd, int cnt, void *buf); 297extern int facl(int fd, int cmd, int cnt, void *buf); 298 299#ifdef __cplusplus 300} 301#endif 302 303#endif /* _SYS_ACL_H */ 304