acl.h revision 70759
1/*- 2 * Copyright (c) 1999-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: head/sys/sys/acl.h 70759 2001-01-07 19:21:06Z rwatson $ 27 */ 28/* 29 * Userland/kernel interface for Access Control Lists. 30 * 31 * The POSIX.1e implementation page may be reached at: 32 * http://www.watson.org/fbsd-hardening/posix1e/ 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_NAME "$posix1e.acl_access" 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 47typedef int acl_type_t; 48typedef int acl_tag_t; 49typedef mode_t acl_perm_t; 50 51struct acl_entry { 52 acl_tag_t ae_tag; 53 uid_t ae_id; 54 acl_perm_t ae_perm; 55}; 56typedef struct acl_entry *acl_entry_t; 57 58struct acl { 59 int acl_cnt; 60 struct acl_entry acl_entry[ACL_MAX_ENTRIES]; 61}; 62typedef struct acl *acl_t; 63 64/* 65 * Possible valid values for ae_tag field. 66 */ 67#define ACL_USER_OBJ 0x00000001 68#define ACL_USER 0x00000002 69#define ACL_GROUP_OBJ 0x00000004 70#define ACL_GROUP 0x00000008 71#define ACL_MASK 0x00000010 72#define ACL_OTHER 0x00000020 73#define ACL_OTHER_OBJ ACL_OTHER 74 75/* 76 * Possible valid values for acl_type_t arguments. 77 */ 78#define ACL_TYPE_ACCESS 0x00000000 79#define ACL_TYPE_DEFAULT 0x00000001 80#define ACL_TYPE_AFS 0x00000002 81#define ACL_TYPE_CODA 0x00000003 82#define ACL_TYPE_NTFS 0x00000004 83#define ACL_TYPE_NWFS 0x00000005 84 85/* 86 * Possible flags in ae_perm field. 87 */ 88#define ACL_PERM_EXEC 0x0001 89#define ACL_PERM_WRITE 0x0002 90#define ACL_PERM_READ 0x0004 91#define ACL_PERM_NONE 0x0000 92#define ACL_PERM_BITS (ACL_PERM_EXEC | ACL_PERM_WRITE | ACL_PERM_READ) 93#define ACL_POSIX1E_BITS (ACL_PERM_EXEC | ACL_PERM_WRITE | ACL_PERM_READ) 94 95#ifdef _KERNEL 96 97/* 98 * Storage for ACLs and support structures. 99 */ 100#ifdef MALLOC_DECLARE 101MALLOC_DECLARE(M_ACL); 102#endif 103 104#else /* !_KERNEL */ 105 106/* 107 * Syscall interface -- use the library calls instead as the syscalls 108 * have strict acl entry ordering requirements. 109 */ 110__BEGIN_DECLS 111int __acl_aclcheck_fd(int _filedes, acl_type_t _type, struct acl *_aclp); 112int __acl_aclcheck_file(const char *_path, acl_type_t _type, 113 struct acl *_aclp); 114int __acl_delete_fd(int _filedes, acl_type_t _type); 115int __acl_delete_file(const char *_path_p, acl_type_t _type); 116int __acl_get_fd(int _filedes, acl_type_t _type, struct acl *_aclp); 117int __acl_get_file(const char *_path, acl_type_t _type, struct acl *_aclp); 118int __acl_set_fd(int _filedes, acl_type_t _type, struct acl *_aclp); 119int __acl_set_file(const char *_path, acl_type_t _type, struct acl *_aclp); 120__END_DECLS 121 122/* 123 * Supported POSIX.1e ACL manipulation and assignment/retrieval API 124 * _np calls are local extensions that reflect an environment capable of 125 * opening file descriptors of directories, and allowing additional 126 * ACL type for different file systems (i.e., AFS). 127 */ 128__BEGIN_DECLS 129int acl_delete_fd_np(int _filedes, acl_type_t _type); 130int acl_delete_file_np(const char *_path_p, acl_type_t _type); 131int acl_delete_def_file(const char *_path_p); 132acl_t acl_dup(acl_t _acl); 133int acl_free(void *_obj_p); 134acl_t acl_from_text(const char *_buf_p); 135acl_t acl_get_fd(int _fd); 136acl_t acl_get_fd_np(int fd, acl_type_t _type); 137acl_t acl_get_file(const char *_path_p, acl_type_t _type); 138acl_t acl_init(int _count); 139int acl_set_fd(int _fd, acl_t _acl); 140int acl_set_fd_np(int _fd, acl_t _acl, acl_type_t _type); 141int acl_set_file(const char *_path_p, acl_type_t _type, acl_t _acl); 142char *acl_to_text(acl_t _acl, ssize_t *_len_p); 143int acl_valid(acl_t _acl); 144int acl_valid_fd_np(int _fd, acl_type_t _type, acl_t _acl); 145int acl_valid_file_np(const char *_path_p, acl_type_t _type, acl_t _acl); 146__END_DECLS 147 148#endif /* !_KERNEL */ 149 150#endif /* !_SYS_ACL_H */ 151