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