1185029Spjd/* 2185029Spjd * CDDL HEADER START 3185029Spjd * 4185029Spjd * The contents of this file are subject to the terms of the 5185029Spjd * Common Development and Distribution License (the "License"). 6185029Spjd * You may not use this file except in compliance with the License. 7185029Spjd * 8185029Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9185029Spjd * or http://www.opensolaris.org/os/licensing. 10185029Spjd * See the License for the specific language governing permissions 11185029Spjd * and limitations under the License. 12185029Spjd * 13185029Spjd * When distributing Covered Code, include this CDDL HEADER in each 14185029Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15185029Spjd * If applicable, add the following below this CDDL HEADER, with the 16185029Spjd * fields enclosed by brackets "[]" replaced with your own identifying 17185029Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 18185029Spjd * 19185029Spjd * CDDL HEADER END 20185029Spjd */ 21185029Spjd/* 22209962Smm * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23185029Spjd * Use is subject to license terms. 24185029Spjd */ 25185029Spjd 26185029Spjd#ifndef _SYS_ACL_H 27185029Spjd#define _SYS_ACL_H 28185029Spjd 29185029Spjd#include <sys/types.h> 30185029Spjd#include <sys/acl_impl.h> 31185029Spjd 32192800Strasz#if defined(_KERNEL) 33192800Strasz/* 34192800Strasz * When compiling OpenSolaris kernel code, this file is getting 35192800Strasz * included instead of FreeBSD one. Pull the original sys/acl.h as well. 36192800Strasz */ 37192800Strasz#undef _SYS_ACL_H 38192800Strasz#include_next <sys/acl.h> 39192800Strasz#define _SYS_ACL_H 40219089Spjd#endif /* _KERNEL */ 41192800Strasz 42185029Spjd#ifdef __cplusplus 43185029Spjdextern "C" { 44185029Spjd#endif 45185029Spjd 46185029Spjd#define MAX_ACL_ENTRIES (1024) /* max entries of each type */ 47192800Strasztypedef struct { 48185029Spjd int a_type; /* the type of ACL entry */ 49185029Spjd uid_t a_id; /* the entry in -uid or gid */ 50185029Spjd o_mode_t a_perm; /* the permission field */ 51185029Spjd} aclent_t; 52185029Spjd 53185029Spjdtypedef struct ace { 54185029Spjd uid_t a_who; /* uid or gid */ 55185029Spjd uint32_t a_access_mask; /* read,write,... */ 56185029Spjd uint16_t a_flags; /* see below */ 57185029Spjd uint16_t a_type; /* allow or deny */ 58185029Spjd} ace_t; 59185029Spjd 60219089Spjd#ifndef _KERNEL 61185029Spjdtypedef struct acl_info acl_t; 62192800Strasz#endif 63185029Spjd 64185029Spjd/* 65185029Spjd * The following are Defined types for an aclent_t. 66185029Spjd */ 67185029Spjd#define USER_OBJ (0x01) /* object owner */ 68185029Spjd#define USER (0x02) /* additional users */ 69185029Spjd#define GROUP_OBJ (0x04) /* owning group of the object */ 70185029Spjd#define GROUP (0x08) /* additional groups */ 71185029Spjd#define CLASS_OBJ (0x10) /* file group class and mask entry */ 72185029Spjd#define OTHER_OBJ (0x20) /* other entry for the object */ 73185029Spjd#define ACL_DEFAULT (0x1000) /* default flag */ 74185029Spjd/* default object owner */ 75185029Spjd#define DEF_USER_OBJ (ACL_DEFAULT | USER_OBJ) 76185029Spjd/* default additional users */ 77185029Spjd#define DEF_USER (ACL_DEFAULT | USER) 78185029Spjd/* default owning group */ 79185029Spjd#define DEF_GROUP_OBJ (ACL_DEFAULT | GROUP_OBJ) 80185029Spjd/* default additional groups */ 81185029Spjd#define DEF_GROUP (ACL_DEFAULT | GROUP) 82185029Spjd/* default mask entry */ 83185029Spjd#define DEF_CLASS_OBJ (ACL_DEFAULT | CLASS_OBJ) 84185029Spjd/* default other entry */ 85185029Spjd#define DEF_OTHER_OBJ (ACL_DEFAULT | OTHER_OBJ) 86185029Spjd 87185029Spjd/* 88185029Spjd * The following are defined for ace_t. 89185029Spjd */ 90185029Spjd#define ACE_READ_DATA 0x00000001 91185029Spjd#define ACE_LIST_DIRECTORY 0x00000001 92185029Spjd#define ACE_WRITE_DATA 0x00000002 93185029Spjd#define ACE_ADD_FILE 0x00000002 94185029Spjd#define ACE_APPEND_DATA 0x00000004 95185029Spjd#define ACE_ADD_SUBDIRECTORY 0x00000004 96185029Spjd#define ACE_READ_NAMED_ATTRS 0x00000008 97185029Spjd#define ACE_WRITE_NAMED_ATTRS 0x00000010 98185029Spjd#define ACE_EXECUTE 0x00000020 99185029Spjd#define ACE_DELETE_CHILD 0x00000040 100185029Spjd#define ACE_READ_ATTRIBUTES 0x00000080 101185029Spjd#define ACE_WRITE_ATTRIBUTES 0x00000100 102185029Spjd#define ACE_DELETE 0x00010000 103185029Spjd#define ACE_READ_ACL 0x00020000 104185029Spjd#define ACE_WRITE_ACL 0x00040000 105185029Spjd#define ACE_WRITE_OWNER 0x00080000 106185029Spjd#define ACE_SYNCHRONIZE 0x00100000 107185029Spjd 108185029Spjd#define ACE_FILE_INHERIT_ACE 0x0001 109185029Spjd#define ACE_DIRECTORY_INHERIT_ACE 0x0002 110185029Spjd#define ACE_NO_PROPAGATE_INHERIT_ACE 0x0004 111185029Spjd#define ACE_INHERIT_ONLY_ACE 0x0008 112185029Spjd#define ACE_SUCCESSFUL_ACCESS_ACE_FLAG 0x0010 113185029Spjd#define ACE_FAILED_ACCESS_ACE_FLAG 0x0020 114185029Spjd#define ACE_IDENTIFIER_GROUP 0x0040 115185029Spjd#define ACE_INHERITED_ACE 0x0080 116185029Spjd#define ACE_OWNER 0x1000 117185029Spjd#define ACE_GROUP 0x2000 118185029Spjd#define ACE_EVERYONE 0x4000 119185029Spjd 120185029Spjd#define ACE_ACCESS_ALLOWED_ACE_TYPE 0x0000 121185029Spjd#define ACE_ACCESS_DENIED_ACE_TYPE 0x0001 122185029Spjd#define ACE_SYSTEM_AUDIT_ACE_TYPE 0x0002 123185029Spjd#define ACE_SYSTEM_ALARM_ACE_TYPE 0x0003 124185029Spjd 125185029Spjd#define ACL_AUTO_INHERIT 0x0001 126185029Spjd#define ACL_PROTECTED 0x0002 127185029Spjd#define ACL_DEFAULTED 0x0004 128185029Spjd#define ACL_FLAGS_ALL (ACL_AUTO_INHERIT|ACL_PROTECTED| \ 129185029Spjd ACL_DEFAULTED) 130185029Spjd 131185029Spjd#ifdef _KERNEL 132185029Spjd 133185029Spjd/* 134185029Spjd * These are only applicable in a CIFS context. 135185029Spjd */ 136185029Spjd#define ACE_ACCESS_ALLOWED_COMPOUND_ACE_TYPE 0x04 137185029Spjd#define ACE_ACCESS_ALLOWED_OBJECT_ACE_TYPE 0x05 138185029Spjd#define ACE_ACCESS_DENIED_OBJECT_ACE_TYPE 0x06 139185029Spjd#define ACE_SYSTEM_AUDIT_OBJECT_ACE_TYPE 0x07 140185029Spjd#define ACE_SYSTEM_ALARM_OBJECT_ACE_TYPE 0x08 141185029Spjd#define ACE_ACCESS_ALLOWED_CALLBACK_ACE_TYPE 0x09 142185029Spjd#define ACE_ACCESS_DENIED_CALLBACK_ACE_TYPE 0x0A 143185029Spjd#define ACE_ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE 0x0B 144185029Spjd#define ACE_ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE 0x0C 145185029Spjd#define ACE_SYSTEM_AUDIT_CALLBACK_ACE_TYPE 0x0D 146185029Spjd#define ACE_SYSTEM_ALARM_CALLBACK_ACE_TYPE 0x0E 147185029Spjd#define ACE_SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE 0x0F 148185029Spjd#define ACE_SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE 0x10 149185029Spjd 150185029Spjd#define ACE_ALL_TYPES 0x001F 151185029Spjd 152185029Spjdtypedef struct ace_object { 153185029Spjd uid_t a_who; /* uid or gid */ 154185029Spjd uint32_t a_access_mask; /* read,write,... */ 155185029Spjd uint16_t a_flags; /* see below */ 156185029Spjd uint16_t a_type; /* allow or deny */ 157185029Spjd uint8_t a_obj_type[16]; /* obj type */ 158185029Spjd uint8_t a_inherit_obj_type[16]; /* inherit obj */ 159185029Spjd} ace_object_t; 160185029Spjd 161185029Spjd#endif 162185029Spjd 163185029Spjd#define ACE_ALL_PERMS (ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \ 164185029Spjd ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \ 165185029Spjd ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \ 166185029Spjd ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_WRITE_ACL| \ 167185029Spjd ACE_WRITE_OWNER|ACE_SYNCHRONIZE) 168185029Spjd 169209962Smm#define ACE_ALL_WRITE_PERMS (ACE_WRITE_DATA|ACE_APPEND_DATA| \ 170209962Smm ACE_WRITE_ATTRIBUTES|ACE_WRITE_NAMED_ATTRS|ACE_WRITE_ACL| \ 171209962Smm ACE_WRITE_OWNER|ACE_DELETE|ACE_DELETE_CHILD) 172209962Smm 173185029Spjd#define ACE_READ_PERMS (ACE_READ_DATA|ACE_READ_ACL|ACE_READ_ATTRIBUTES| \ 174185029Spjd ACE_READ_NAMED_ATTRS) 175185029Spjd 176185029Spjd#define ACE_WRITE_PERMS (ACE_WRITE_DATA|ACE_APPEND_DATA|ACE_WRITE_ATTRIBUTES| \ 177185029Spjd ACE_WRITE_NAMED_ATTRS) 178185029Spjd 179185029Spjd#define ACE_MODIFY_PERMS (ACE_READ_DATA|ACE_LIST_DIRECTORY|ACE_WRITE_DATA| \ 180185029Spjd ACE_ADD_FILE|ACE_APPEND_DATA|ACE_ADD_SUBDIRECTORY|ACE_READ_NAMED_ATTRS| \ 181185029Spjd ACE_WRITE_NAMED_ATTRS|ACE_EXECUTE|ACE_DELETE_CHILD|ACE_READ_ATTRIBUTES| \ 182185029Spjd ACE_WRITE_ATTRIBUTES|ACE_DELETE|ACE_READ_ACL|ACE_SYNCHRONIZE) 183185029Spjd/* 184185029Spjd * The following flags are supported by both NFSv4 ACLs and ace_t. 185185029Spjd */ 186185029Spjd#define ACE_NFSV4_SUP_FLAGS (ACE_FILE_INHERIT_ACE | \ 187185029Spjd ACE_DIRECTORY_INHERIT_ACE | \ 188185029Spjd ACE_NO_PROPAGATE_INHERIT_ACE | \ 189185029Spjd ACE_INHERIT_ONLY_ACE | \ 190185029Spjd ACE_IDENTIFIER_GROUP) 191185029Spjd 192185029Spjd#define ACE_TYPE_FLAGS (ACE_OWNER|ACE_GROUP|ACE_EVERYONE| \ 193185029Spjd ACE_IDENTIFIER_GROUP) 194185029Spjd#define ACE_INHERIT_FLAGS (ACE_FILE_INHERIT_ACE| \ 195185029Spjd ACE_DIRECTORY_INHERIT_ACE|ACE_NO_PROPAGATE_INHERIT_ACE|ACE_INHERIT_ONLY_ACE) 196185029Spjd 197185029Spjd/* cmd args to acl(2) for aclent_t */ 198185029Spjd#define GETACL 1 199185029Spjd#define SETACL 2 200185029Spjd#define GETACLCNT 3 201185029Spjd 202185029Spjd/* cmd's to manipulate ace acls. */ 203185029Spjd#define ACE_GETACL 4 204185029Spjd#define ACE_SETACL 5 205185029Spjd#define ACE_GETACLCNT 6 206185029Spjd 207185029Spjd/* minimal acl entries from GETACLCNT */ 208185029Spjd#define MIN_ACL_ENTRIES 4 209185029Spjd 210185029Spjd#if !defined(_KERNEL) 211185029Spjd 212185029Spjd/* acl check errors */ 213185029Spjd#define GRP_ERROR 1 214185029Spjd#define USER_ERROR 2 215185029Spjd#define OTHER_ERROR 3 216185029Spjd#define CLASS_ERROR 4 217185029Spjd#define DUPLICATE_ERROR 5 218185029Spjd#define MISS_ERROR 6 219185029Spjd#define MEM_ERROR 7 220185029Spjd#define ENTRY_ERROR 8 221185029Spjd 222185029Spjd 223185029Spjd/* 224185029Spjd * similar to ufs_acl.h: changed to char type for user commands (tar, cpio) 225185029Spjd * Attribute types 226185029Spjd */ 227185029Spjd#define UFSD_FREE ('0') /* Free entry */ 228185029Spjd#define UFSD_ACL ('1') /* Access Control Lists */ 229185029Spjd#define UFSD_DFACL ('2') /* reserved for future use */ 230185029Spjd#define ACE_ACL ('3') /* ace_t style acls */ 231185029Spjd 232185029Spjd/* 233185029Spjd * flag to [f]acl_get() 234185029Spjd * controls whether a trivial acl should be returned. 235185029Spjd */ 236185029Spjd#define ACL_NO_TRIVIAL 0x2 237185029Spjd 238185029Spjd 239185029Spjd/* 240185029Spjd * Flags to control acl_totext() 241185029Spjd */ 242185029Spjd 243185029Spjd#define ACL_APPEND_ID 0x1 /* append uid/gid to user/group entries */ 244185029Spjd#define ACL_COMPACT_FMT 0x2 /* build ACL in ls -V format */ 245185029Spjd#define ACL_NORESOLVE 0x4 /* don't do name service lookups */ 246185029Spjd#define ACL_SID_FMT 0x8 /* use usersid/groupsid when appropriate */ 247185029Spjd 248185029Spjd/* 249185029Spjd * Legacy aclcheck errors for aclent_t ACLs 250185029Spjd */ 251185029Spjd#define EACL_GRP_ERROR GRP_ERROR 252185029Spjd#define EACL_USER_ERROR USER_ERROR 253185029Spjd#define EACL_OTHER_ERROR OTHER_ERROR 254185029Spjd#define EACL_CLASS_ERROR CLASS_ERROR 255185029Spjd#define EACL_DUPLICATE_ERROR DUPLICATE_ERROR 256185029Spjd#define EACL_MISS_ERROR MISS_ERROR 257185029Spjd#define EACL_MEM_ERROR MEM_ERROR 258185029Spjd#define EACL_ENTRY_ERROR ENTRY_ERROR 259185029Spjd 260185029Spjd#define EACL_INHERIT_ERROR 9 /* invalid inherit flags */ 261185029Spjd#define EACL_FLAGS_ERROR 10 /* unknown flag value */ 262185029Spjd#define EACL_PERM_MASK_ERROR 11 /* unknown permission */ 263185029Spjd#define EACL_COUNT_ERROR 12 /* invalid acl count */ 264185029Spjd 265185029Spjd#define EACL_INVALID_SLOT 13 /* invalid acl slot */ 266185029Spjd#define EACL_NO_ACL_ENTRY 14 /* Entry doesn't exist */ 267185029Spjd#define EACL_DIFF_TYPE 15 /* acls aren't same type */ 268185029Spjd 269185029Spjd#define EACL_INVALID_USER_GROUP 16 /* need user/group name */ 270185029Spjd#define EACL_INVALID_STR 17 /* invalid acl string */ 271185029Spjd#define EACL_FIELD_NOT_BLANK 18 /* can't have blank field */ 272185029Spjd#define EACL_INVALID_ACCESS_TYPE 19 /* invalid access type */ 273185029Spjd#define EACL_UNKNOWN_DATA 20 /* Unrecognized data in ACL */ 274185029Spjd#define EACL_MISSING_FIELDS 21 /* missing fields in acl */ 275185029Spjd 276185029Spjd#define EACL_INHERIT_NOTDIR 22 /* Need dir for inheritance */ 277185029Spjd 278185029Spjdextern int aclcheck(aclent_t *, int, int *); 279185029Spjdextern int acltomode(aclent_t *, int, mode_t *); 280185029Spjdextern int aclfrommode(aclent_t *, int, mode_t *); 281185029Spjdextern int aclsort(int, int, aclent_t *); 282185029Spjdextern char *acltotext(aclent_t *, int); 283185029Spjdextern aclent_t *aclfromtext(char *, int *); 284185029Spjdextern void acl_free(acl_t *); 285185029Spjdextern int acl_get(const char *, int, acl_t **); 286185029Spjdextern int facl_get(int, int, acl_t **); 287185029Spjdextern int acl_set(const char *, acl_t *acl); 288185029Spjdextern int facl_set(int, acl_t *acl); 289185029Spjdextern int acl_strip(const char *, uid_t, gid_t, mode_t); 290185029Spjdextern int acl_trivial(const char *); 291185029Spjdextern char *acl_totext(acl_t *, int); 292185029Spjdextern int acl_fromtext(const char *, acl_t **); 293185029Spjdextern int acl_check(acl_t *, int); 294185029Spjd 295185029Spjd#else /* !defined(_KERNEL) */ 296185029Spjd 297185029Spjdextern void ksort(caddr_t, int, int, int (*)(void *, void *)); 298185029Spjdextern int cmp2acls(void *, void *); 299185029Spjd 300185029Spjd#endif /* !defined(_KERNEL) */ 301185029Spjd 302185029Spjd#if defined(__STDC__) 303185029Spjdextern int acl(const char *path, int cmd, int cnt, void *buf); 304185029Spjdextern int facl(int fd, int cmd, int cnt, void *buf); 305185029Spjd#else /* !__STDC__ */ 306185029Spjdextern int acl(); 307185029Spjdextern int facl(); 308185029Spjd#endif /* defined(__STDC__) */ 309185029Spjd 310185029Spjd#ifdef __cplusplus 311185029Spjd} 312185029Spjd#endif 313185029Spjd 314185029Spjd#endif /* _SYS_ACL_H */ 315