2 .\" Copyright (c) 2000, 2002 Robert N. M. Watson
3 .\" All rights reserved.
5 .\" This software was developed by Robert Watson for the TrustedBSD Project.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
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.
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
38 .Nd get an ACL for a file
45 .Fn acl_get_fd "int fd"
47 .Fn acl_get_fd_np "int fd" "acl_type_t type"
49 .Fn acl_get_file "const char *path_p" "acl_type_t type"
51 .Fn acl_get_link_np "const char *path_p" "acl_type_t type"
59 each allow the retrieval of an ACL from a file.
62 is a POSIX.1e call that allows the retrieval of an ACL of type
64 from a file descriptor.
68 is a non-portable form of
70 that allows the retrieval of any type of ACL from a file descriptor.
73 function is a POSIX.1e call that allows the retrieval of a
74 specified type of ACL from a file by name;
76 is a non-portable variation on
78 which does not follow a symlink if the target of the call is a
81 These functions may cause memory to be allocated.
82 The caller should free
83 any releasable memory, when the new ACL is no longer required, by calling
89 The ACL in the working storage is an independent copy of the ACL associated
90 with the object referred to by
92 The ACL in the working storage shall not participate in any access control
99 .Bl -column -offset 3n "ACL_TYPE_DEFAULT"
100 .It ACL_TYPE_ACCESS POSIX.1e access ACL
101 .It ACL_TYPE_DEFAULT POSIX.1e default ACL
102 .It ACL_TYPE_NFS4 NFSv4 ACL
105 The ACL returned will be branded accordingly.
106 .Sh IMPLEMENTATION NOTES
108 support for POSIX.1e interfaces and features is still under
109 development at this time.
111 Upon successful completion, the function shall return a pointer to the ACL
113 Otherwise, a value of
115 shall be returned, and
117 shall be set to indicate the error.
119 If any of the following conditions occur, the
121 function shall return a value of
125 to the corresponding value:
128 Search permission is denied for a component of the path prefix, or the
129 object exists and the process does not have appropriate access rights.
133 argument is not a valid file descriptor.
135 The ACL type passed is invalid for this file object.
136 .It Bq Er ENAMETOOLONG
137 A component of a pathname exceeded 255 characters, or an
138 entire path name exceeded 1023 characters.
140 The named object does not exist, or the
142 argument points to an empty string.
144 Insufficient memory available to fulfill request.
146 The file system does not support ACL retrieval.
152 .Xr acl_get_brand_np 3 ,
156 POSIX.1e is described in IEEE POSIX.1e draft 17.
158 of the draft continues on the cross-platform POSIX.1e implementation
160 To join this list, see the
162 POSIX.1e implementation
163 page for more information.
165 POSIX.1e support was introduced in
167 and development continues.
169 .An Robert N M Watson