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