sys/sys/acl.h

   1 /*-
   2  * Copyright (c) 1999, 2000, 2001 Robert N. M. Watson
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28 /*
  29  * Developed by the TrustedBSD Project.
  30  * Support for POSIX.1e access control lists.
  31  */
  32
  33 #ifndef _SYS_ACL_H
  34 #define _SYS_ACL_H
  35
  36 /*
  37  * POSIX.1e ACL types and related constants.
  38  */
  39
  40 #define POSIX1E_ACL_ACCESS_EXTATTR_NAMESPACE    EXTATTR_NAMESPACE_SYSTEM
  41 #define POSIX1E_ACL_ACCESS_EXTATTR_NAME         "posix1e.acl_access"
  42 #define POSIX1E_ACL_DEFAULT_EXTATTR_NAMESPACE   EXTATTR_NAMESPACE_SYSTEM
  43 #define POSIX1E_ACL_DEFAULT_EXTATTR_NAME        "posix1e.acl_default"
  44 #define ACL_MAX_ENTRIES         32 /* maximum entries in an ACL */
  45 #define _POSIX_ACL_PATH_MAX     ACL_MAX_ENTRIES
  46
  47 typedef int     acl_type_t;
  48 typedef int     acl_tag_t;
  49 typedef mode_t  acl_perm_t;
  50 typedef mode_t *acl_permset_t;
  51
  52 struct acl_entry {
  53         acl_tag_t       ae_tag;
  54         uid_t           ae_id;
  55         acl_perm_t      ae_perm;
  56 };
  57 typedef struct acl_entry        *acl_entry_t;
  58
  59 /* internal ACL structure */
  60 struct acl {
  61         int                     acl_cnt;
  62         struct acl_entry        acl_entry[ACL_MAX_ENTRIES];
  63 };
  64
  65 /* external ACL structure */
  66 struct acl_t_struct {
  67         struct acl              ats_acl;
  68         int                     ats_cur_entry;
  69 };
  70 typedef struct acl_t_struct *acl_t;
  71
  72 /*
  73  * Possible valid values for ae_tag field.
  74  */
  75 #define ACL_UNDEFINED_TAG       0x00000000
  76 #define ACL_USER_OBJ            0x00000001
  77 #define ACL_USER                0x00000002
  78 #define ACL_GROUP_OBJ           0x00000004
  79 #define ACL_GROUP               0x00000008
  80 #define ACL_MASK                0x00000010
  81 #define ACL_OTHER               0x00000020
  82 #define ACL_OTHER_OBJ           ACL_OTHER
  83
  84 /*
  85  * Possible valid values for acl_type_t arguments.
  86  */
  87 #define ACL_TYPE_ACCESS         0x00000000
  88 #define ACL_TYPE_DEFAULT        0x00000001
  89 #define ACL_TYPE_AFS            0x00000002
  90 #define ACL_TYPE_CODA           0x00000003
  91 #define ACL_TYPE_NTFS           0x00000004
  92 #define ACL_TYPE_NWFS           0x00000005
  93
  94 /*
  95  * Possible flags in ae_perm field.
  96  */
  97 #define ACL_EXECUTE             0x0001
  98 #define ACL_WRITE               0x0002
  99 #define ACL_READ                0x0004
 100 #define ACL_PERM_NONE           0x0000
 101 #define ACL_PERM_BITS           (ACL_EXECUTE | ACL_WRITE | ACL_READ)
 102 #define ACL_POSIX1E_BITS        (ACL_EXECUTE | ACL_WRITE | ACL_READ)
 103
 104 /*
 105  * Possible entry_id values for acl_get_entry()
 106  */
 107 #define ACL_FIRST_ENTRY         0
 108 #define ACL_NEXT_ENTRY          1
 109
 110 /*
 111  * Undefined value in ae_id field
 112  */
 113 #define ACL_UNDEFINED_ID        ((uid_t)-1)
 114
 115
 116 #ifdef _KERNEL
 117
 118 /*
 119  * Storage for ACLs and support structures.
 120  */
 121 #ifdef MALLOC_DECLARE
 122 MALLOC_DECLARE(M_ACL);
 123 #endif
 124
 125 acl_perm_t      acl_posix1e_mode_to_perm __P((acl_tag_t tag, mode_t mode));
 126 struct acl_entry        acl_posix1e_mode_to_entry __P((acl_tag_t tag, uid_t uid,
 127     gid_t gid, mode_t mode));
 128 mode_t  acl_posix1e_perms_to_mode __P((struct acl_entry *acl_user_obj_entry,
 129     struct acl_entry *acl_group_obj_entry, struct acl_entry *acl_other_entry));
 130 int     acl_posix1e_check(struct acl *acl);
 131
 132 #else /* !_KERNEL */
 133
 134 /*
 135  * Syscall interface -- use the library calls instead as the syscalls
 136  * have strict acl entry ordering requirements.
 137  */
 138 __BEGIN_DECLS
 139 int     __acl_aclcheck_fd(int _filedes, acl_type_t _type, struct acl *_aclp);
 140 int     __acl_aclcheck_file(const char *_path, acl_type_t _type,
 141             struct acl *_aclp);
 142 int     __acl_delete_fd(int _filedes, acl_type_t _type);
 143 int     __acl_delete_file(const char *_path_p, acl_type_t _type);
 144 int     __acl_get_fd(int _filedes, acl_type_t _type, struct acl *_aclp);
 145 int     __acl_get_file(const char *_path, acl_type_t _type, struct acl *_aclp);
 146 int     __acl_set_fd(int _filedes, acl_type_t _type, struct acl *_aclp);
 147 int     __acl_set_file(const char *_path, acl_type_t _type, struct acl *_aclp);
 148 __END_DECLS
 149
 150 /*
 151  * Supported POSIX.1e ACL manipulation and assignment/retrieval API
 152  * _np calls are local extensions that reflect an environment capable of
 153  * opening file descriptors of directories, and allowing additional
 154  * ACL type for different file systems (i.e., AFS).
 155  */
 156 __BEGIN_DECLS
 157 int     acl_add_perm(acl_permset_t _permset_d, acl_perm_t _perm);
 158 int     acl_calc_mask(acl_t *_acl_p);
 159 int     acl_clear_perms(acl_permset_t _permset_d);
 160 int     acl_copy_entry(acl_entry_t _dest_d, acl_entry_t _src_d);
 161 ssize_t acl_copy_ext(void *_buf_p, acl_t _acl, ssize_t _size);
 162 acl_t   acl_copy_int(const void *_buf_p);
 163 int     acl_create_entry(acl_t *_acl_p, acl_entry_t *_entry_p);
 164 int     acl_delete_fd_np(int _filedes, acl_type_t _type);
 165 int     acl_delete_entry(acl_t _acl, acl_entry_t _entry_d);
 166 int     acl_delete_file_np(const char *_path_p, acl_type_t _type);
 167 int     acl_delete_def_file(const char *_path_p);
 168 int     acl_delete_perm(acl_permset_t _permset_d, acl_perm_t _perm);
 169 acl_t   acl_dup(acl_t _acl);
 170 int     acl_free(void *_obj_p);
 171 acl_t   acl_from_text(const char *_buf_p);
 172 int     acl_get_entry(acl_t _acl, int _entry_id, acl_entry_t *_entry_p);
 173 acl_t   acl_get_fd(int _fd);
 174 acl_t   acl_get_fd_np(int fd, acl_type_t _type);
 175 acl_t   acl_get_file(const char *_path_p, acl_type_t _type);
 176 void    *acl_get_qualifier(acl_entry_t _entry_d);
 177 int     acl_get_perm_np(acl_permset_t _permset_d, acl_perm_t _perm);
 178 int     acl_get_permset(acl_entry_t _entry_d, acl_permset_t *_permset_p);
 179 int     acl_get_tag_type(acl_entry_t _entry_d, acl_tag_t *_tag_type_p);
 180 acl_t   acl_init(int _count);
 181 int     acl_set_fd(int _fd, acl_t _acl);
 182 int     acl_set_fd_np(int _fd, acl_t _acl, acl_type_t _type);
 183 int     acl_set_file(const char *_path_p, acl_type_t _type, acl_t _acl);
 184 int     acl_set_permset(acl_entry_t _entry_d, acl_permset_t _permset_d);
 185 int     acl_set_qualifier(acl_entry_t _entry_d, const void *_tag_qualifier_p);
 186 int     acl_set_tag_type(acl_entry_t _entry_d, acl_tag_t _tag_type);
 187 ssize_t acl_size(acl_t _acl);
 188 char    *acl_to_text(acl_t _acl, ssize_t *_len_p);
 189 int     acl_valid(acl_t _acl);
 190 int     acl_valid_fd_np(int _fd, acl_type_t _type, acl_t _acl);
 191 int     acl_valid_file_np(const char *_path_p, acl_type_t _type, acl_t _acl);
 192 __END_DECLS
 193
 194 #endif /* !_KERNEL */
 195
 196 #endif /* !_SYS_ACL_H */