The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/acl.h

Version: -  FREEBSD  -  FREEBSD11  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: 9341138d2cefbe0f9c5f85985fe19361


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.