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