xref: /dragonfly/share/man/man9/acl.9 (revision b40e316c)
1.\"-
2.\" Copyright (c) 1999, 2000 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: src/share/man/man9/acl.9,v 1.2.2.4 2001/12/17 11:30:18 ru Exp $
27.\"       $DragonFly: src/share/man/man9/acl.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
28.\"
29.Dd December 23, 1999
30.Os
31.Dt ACL 9
32.Sh NAME
33.Nm acl
34.Nd virtual file system access control lists
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/vnode.h
38.In sys/acl.h
39.Pp
40.Bd -literal
41typedef int     acl_type_t;
42typedef int     acl_tag_t;
43typedef mode_t  acl_perm_t;
44
45struct acl_entry {
46        acl_tag_t       ae_tag;
47        uid_t           ae_id;
48        acl_perm_t      ae_perm;
49};
50typedef struct acl_entry        *acl_entry_t;
51
52struct acl {
53        int                     acl_cnt;
54        struct acl_entry        acl_entry[ACL_MAX_ENTRIES];
55};
56typedef struct acl      *acl_t;
57
58/*
59 * Possible valid values for a_tag of acl_entry_t
60 */
61#define ACL_USER_OBJ    0x00000001
62#define ACL_USER        0x00000002
63#define ACL_GROUP_OBJ   0x00000004
64#define ACL_GROUP       0x00000008
65#define ACL_MASK        0x00000010
66#define ACL_OTHER       0x00000020
67#define ACL_OTHER_OBJ   ACL_OTHER
68
69/*
70 * Possible valid values a_type_t arguments
71 */
72#define ACL_TYPE_ACCESS         0x00000000
73#define ACL_TYPE_DEFAULT        0x00000001
74#define ACL_TYPE_AFS            0x00000002
75#define ACL_TYPE_CODA           0x00000003
76#define ACL_TYPE_NTFS           0x00000004
77#define ACL_TYPE_NWFS           0x00000005
78
79/*
80 * Possible flags in a_perm field
81 */
82#define ACL_PERM_EXEC           0x0001
83#define ACL_PERM_WRITE          0x0002
84#define ACL_PERM_READ           0x0004
85#define ACL_PERM_NONE           0x0000
86#define ACL_PERM_BITS           (ACL_PERM_EXEC | ACL_PERM_WRITE | ACL_PERM_READ)
87#define ACL_POSIX1E_BITS        (ACL_PERM_EXEC | ACL_PERM_WRITE | ACL_PERM_READ)
88.Ed
89.Sh DESCRIPTION
90Access control lists, or ACLs, allow fine-grained specification of rights
91for vnodes representing files and directories.  However, as there are a
92plethora of file systems with differing ACL semantics, the vnode interface
93is aware only of the syntax of ACLs, relying on the underlying file system
94to implement the details.  Depending on the underlying file system, each
95file or directory may have zero or more ACLs associated with it, named using
96the
97.Fa type
98field of the appropriate vnode ACL calls,
99.Xr VOP_ACLCHECK 9 ,
100.Xr VOP_GETACL 9 ,
101and
102.Xr VOP_SETACL 9 .
103.Pp
104Currently, each ACL is represented in-kernel by a fixed-size acl structure.
105An ACL is constructed from a fixed size array of ACL entries, each of which
106consists of a set of permissions, principal namespace, and principal
107identifier.  Zero or more of these entries may be "defined", depending on
108the value of the associated acl_cnt field.
109.Sh SEE ALSO
110.Xr VFS 9 ,
111.Xr VOP_ACLCHECK 9 ,
112.Xr VOP_GETACL 9 ,
113.Xr VOP_SETACL 9
114.Sh AUTHORS
115This man page was written by
116.An Robert Watson .
117