1.\"- 2.\" Copyright (c) 2000, 2002 Robert N. M. Watson 3.\" All rights reserved. 4.\" 5.\" This software was developed by Robert Watson for the TrustedBSD Project. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" $FreeBSD$ 29.\" 30.Dd December 29, 2002 31.Dt ACL_VALID 3 32.Os 33.Sh NAME 34.Nm acl_valid , 35.Nm acl_valid_fd_np , 36.Nm acl_valid_file_np , 37.Nm acl_valid_link_np 38.Nd validate an ACL 39.Sh LIBRARY 40.Lb libc 41.Sh SYNOPSIS 42.In sys/types.h 43.In sys/acl.h 44.Ft int 45.Fn acl_valid "acl_t acl" 46.Ft int 47.Fn acl_valid_fd_np "int fd" "acl_type_t type" "acl_t acl" 48.Ft int 49.Fn acl_valid_file_np "const char *path_p" "acl_type_t type" "acl_t acl" 50.Ft int 51.Fn acl_valid_link_np "const char *path_p" "acl_type_t type" "acl_t acl" 52.Sh DESCRIPTION 53These functions check that the ACL referred to by the argument 54.Va acl 55is valid. 56The POSIX.1e routine, 57.Fn acl_valid , 58checks this validity only with POSIX.1e ACL semantics, and irrespective 59of the context in which the ACL is to be used. 60The non-portable forms, 61.Fn acl_valid_fd_np , 62.Fn acl_valid_file_np , 63and 64.Fn acl_valid_link_np 65allow an ACL to be checked in the context of a specific acl type, 66.Va type , 67and file system object. 68In environments where additional ACL types are 69supported than just POSIX.1e, this makes more sense. 70Whereas 71.Fn acl_valid_file_np 72will follow the symlink if the specified path is to a symlink, 73.Fn acl_valid_link_np 74will not. 75.Pp 76For POSIX.1e semantics, the checks include: 77.Bd -literal -offset indent 78The three required entries (ACL_USER_OBJ, ACL_GROUP_OBJ, 79and ACL_OTHER) shall exist exactly once in the ACL. If 80the ACL contains any ACL_USER, ACL_GROUP, or any other 81implementation-defined entries in the file group class 82then one ACL_MASK entry shall also be required. The ACL 83shall contain at most on ACL_MASK entry. 84.Pp 85The qualifier field shall be unique among all entries of 86the same POSIX.1e ACL facility defined tag type. The 87tag type field shall contain valid values including any 88implementation-defined values. Validation of the values 89of the qualifier field is implementation-defined. 90.Ed 91.Pp 92The POSIX.1e 93.Fn acl_valid 94function may reorder the ACL for the purposes of verification; the 95non-portable validation functions will not. 96.Sh IMPLEMENTATION NOTES 97.Fx Ns 's 98support for POSIX.1e interfaces and features is still under 99development at this time. 100.Sh RETURN VALUES 101.Rv -std 102.Sh ERRORS 103If any of the following conditions occur, these functions shall return 104-1 and set 105.Va errno 106to the corresponding value: 107.Bl -tag -width Er 108.It Bq Er EACCES 109Search permission is denied for a component of the path prefix, or the 110object exists and the process does not have appropriate access rights. 111.It Bq Er EBADF 112The 113.Va fd 114argument is not a valid file descriptor. 115.It Bq Er EINVAL 116Argument 117.Va acl 118does not point to a valid ACL. 119.Pp 120One or more of the required ACL entries is not present in 121.Va acl . 122.Pp 123The ACL contains entries that are not unique. 124.Pp 125The file system rejects the ACL based on fs-specific semantics issues. 126.It Bq Er ENAMETOOLONG 127A component of a pathname exceeded 255 characters, or an 128entire path name exceeded 1023 characters. 129.It Bq Er ENOENT 130The named object does not exist, or the 131.Va path_p 132argument points to an empty string. 133.It Bq Er ENOMEM 134Insufficient memory available to fulfill request. 135.It Bq Er EOPNOTSUPP 136The file system does not support ACL retrieval. 137.El 138.Sh SEE ALSO 139.Xr acl 3 , 140.Xr acl_get 3 , 141.Xr acl_init 3 , 142.Xr acl_set 3 , 143.Xr posix1e 3 144.Sh STANDARDS 145POSIX.1e is described in IEEE POSIX.1e draft 17. 146Discussion 147of the draft continues on the cross-platform POSIX.1e implementation 148mailing list. 149To join this list, see the 150.Fx 151POSIX.1e implementation 152page for more information. 153.Sh HISTORY 154POSIX.1e support was introduced in 155.Fx 4.0 , 156and development continues. 157.Sh AUTHORS 158.An Robert N M Watson 159