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