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_VALID 3 30.Os FreeBSD 4.0 31.Sh NAME 32.Nm acl_valid , 33.Nm acl_valid_fd_np , 34.Nm acl_valid_file_np 35.Nd validate an ACL 36.Sh LIBRARY 37.Lb libposix1e 38.Sh SYNOPSIS 39.Fd #include <sys/types.h> 40.Fd #include <sys/acl.h> 41.Ft int 42.Fn acl_valid "acl_t acl" 43.Ft int 44.Fn acl_valid_fd_np "int fd" "acl_type_t type" "acl_t acl" 45.Ft int 46.Fn acl_valid_file_np "const char *path_p" "acl_type_t type" "acl_t acl" 47.Sh DESCRIPTION 48These functions check that the ACL referred to by the argument 49.Va acl 50is valid. The POSIX.1e routine, 51.Fn acl_valid , 52checks this validity only with POSIX.1e ACL semantics, and irrespective 53of the context in which the ACL is to be used. The non-portable forms, 54.Fn acl_valid_fd_np 55and 56.Fn acl_valid_file_np , 57allow an ACL to be checked in the context of a specific acl type, 58.Va type , 59and file system object. In environments where additional ACL types are 60supported than just POSIX.1e, this makes more sense. 61 62For POSIX.1e semantics, the checks include: 63.Bd -literal -offset indent 64The three required entries (ACL_USER_OBJ, ACL_GROUP_OBJ, 65and ACL_OTHER) shall exist exactly once in the ACL. If 66the ACL contains any ACL_USER, ACL_GROUP, or any other 67implementation-defined entries in the file group class 68then one ACL_MASK entry shall also be required. The ACL 69shall contain at most on ACL_MASK entry. 70 71The qualifier field shall be unique among all entries of 72the same POSIX.1e ACL facility defined tag type. The 73tag type field shall contain valid values including any 74implementation-defined values. Validation of the values 75of the qualifier field is implementation-defined. 76.Ed 77 78The POSIX.1e 79.Fn acl_valid 80function may reorder the ACL for the purposes of verification; the 81non-portable validation functions will not. 82.Sh IMPLEMENTATION NOTES 83FreeBSD's support for POSIX.1e interfaces and features is still under 84development at this time. 85.Sh RETURN VALUES 86Upon successful completion, the function shall return a value of zero. 87Otherwise, a value of -1 shall be returned and 88.Va errno 89shall be set to indicate the error. 90.Sh ERRORS 91If any of the following conditions occur, these functions shall return 92-1 and 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 104Argument 105.Va acl 106does not point to a valid ACL. 107 108One or more of the required ACL entries is not present in 109.Va acl . 110 111The ACL contains entries that are not unique. 112 113The file system rejects the ACL based on fs-specific semantics issues. 114.It Bq Er ENAMETOOLONG 115A component of a pathname exceeded 255 characters, or an 116entire path name exceeded 1023 characters. 117.It Bq Er ENOENT 118The named object does not exist, or the 119.Va path_p 120argument points to an empty string. 121.It Bq Er ENOMEM 122Insufficient memory available to fulfill request. 123.It Bq Er EOPNOTSUPP 124The file system does not support ACL retrieval. 125.El 126.Sh SEE ALSO 127.Xr acl 3 , 128.Xr acl_get 3 , 129.Xr acl_init 3 , 130.Xr acl_set 3 , 131.Xr posix1e 3 132.Sh STANDARDS 133POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion 134of the draft continues on the cross-platform POSIX.1e implementation 135mailing list. To join this list, see the FreeBSD POSIX.1e implementation 136page for more information. 137.Sh HISTORY 138POSIX.1e support was introduced in 139.Fx 4.0 , 140and development continues. 141.Sh AUTHORS 142.An Robert N M Watson 143.Sh BUGS 144These features are not yet fully implemented. 145