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