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