1.\"- 2.\" Copyright (c) 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$ 27.\" 28.Dd January 28, 2000 29.Dt ACL_GET 3 30.Os 31.Sh NAME 32.Nm acl_get_fd , 33.Nm acl_get_fd_np , 34.Nm acl_get_file 35.Nd get an ACL for a file 36.Sh LIBRARY 37.Lb libc 38.Sh SYNOPSIS 39.Fd #include <sys/types.h> 40.Fd #include <sys/acl.h> 41.Ft acl_t 42.Fn acl_get_file "const char *path_p" "acl_type_t type" 43.Ft acl_t 44.Fn acl_get_fd "int fd" 45.Ft acl_t 46.Fn acl_get_fd_np "int fd" "acl_type_t type" 47.Sh DESCRIPTION 48The 49.Fn acl_get_file , 50.Fn acl_get_fd , 51and 52.Fn acl_get_fd_np 53each allow the retrieval of an ACL from a file. 54.Fn acl_get_file 55is a POSIX.1e call that allows the retrieval of a 56specified type of ACL from a file by name; 57.Fn acl_get_fd 58is a POSIX.1e call that allows the retrieval of an ACL of type 59ACL_TYPE_ACCESS 60from a file descriptor. 61.Fn acl_get_fd_np 62is a non-portable form of 63.Fn acl_get_fd 64that allows the retrieval of any type of ACL from a file descriptor. 65.Pp 66This function may cause memory to be allocated. The caller should free 67any releasable memory, when the new ACL is no longer required, by calling 68.Xr acl_free 3 69with the 70.Va (void *)acl_t 71as an argument. 72.Pp 73The ACL in the working storage is an independent copy of the ACL associated 74with the object referred to by 75.Va fd . 76The ACL in the working storage shall not participate in any access control 77decisions. 78.Sh IMPLEMENTATION NOTES 79.Fx Ns 's 80support for POSIX.1e interfaces and features is still under 81development at this time. 82.Sh RETURN VALUES 83Upon successful completion, the function shall return a pointer to the ACL 84that was retrieved. Otherwise, a value of 85.Va (acl_t)NULL 86shall be returned, and 87.Va errno 88shall be set to indicate the error. 89.Sh ERRORS 90If any of the following conditions occur, the 91.Fn acl_get_fd 92function shall return a value of 93.Va (acl_t)NULL 94and set 95.Va errno 96to the corresponding value: 97.Bl -tag -width Er 98.It Bq Er EACCES 99Search permission is denied for a component of the path prefix, or the 100object exists and the process does not have appropriate access rights. 101.It Bq Er EBADF 102The 103.Va fd 104argument is not a valid file descriptor. 105.It Bq Er EINVAL 106The ACL type passed is invalid for this file object. 107.It Bq Er ENAMETOOLONG 108A component of a pathname exceeded 255 characters, or an 109entire path name exceeded 1023 characters. 110.It Bq Er ENOENT 111The named object does not exist, or the 112.Va path_p 113argument points to an empty string. 114.It Bq Er ENOMEM 115Insufficient memory available to fulfill request. 116.It Bq Er EOPNOTSUPP 117The file system does not support ACL retrieval. 118.El 119.Sh SEE ALSO 120.Xr acl 3 , 121.Xr acl_free 3 , 122.Xr acl_get 3 , 123.Xr acl_set 3 , 124.Xr posix1e 3 125.Sh STANDARDS 126POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion 127of the draft continues on the cross-platform POSIX.1e implementation 128mailing list. To join this list, see the 129.Fx 130POSIX.1e implementation 131page for more information. 132.Sh HISTORY 133POSIX.1e support was introduced in 134.Fx 4.0 , 135and development continues. 136.Sh AUTHORS 137.An Robert N M Watson 138.Sh BUGS 139These features are not yet fully implemented. 140