sys/cddl/compat/opensolaris/sys/acl.h

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