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.Bl -bullet 78.It 79The three required entries 80.Dv ( ACL_USER_OBJ , ACL_GROUP_OBJ , 81and 82.Dv ACL_OTHER ) 83shall exist exactly once in the ACL. 84If the ACL contains any 85.Dv ACL_USER , ACL_GROUP , 86or any other 87implementation-defined entries in the file group class 88then one 89.Dv ACL_MASK 90entry shall also be required. 91The ACL shall contain at most one 92.Dv ACL_MASK 93entry. 94.It 95The qualifier field shall be unique among all entries of 96the same POSIX.1e ACL facility defined tag type. 97The 98tag type field shall contain valid values including any 99implementation-defined values. 100Validation of the values 101of the qualifier field is implementation-defined. 102.El 103.Pp 104The POSIX.1e 105.Fn acl_valid 106function may reorder the ACL for the purposes of verification; the 107non-portable validation functions will not. 108.Sh IMPLEMENTATION NOTES 109.Fx Ns 's 110support for POSIX.1e interfaces and features is still under 111development at this time. 112.Sh RETURN VALUES 113.Rv -std 114.Sh ERRORS 115If any of the following conditions occur, these functions shall return 116-1 and set 117.Va errno 118to the corresponding value: 119.Bl -tag -width Er 120.It Bq Er EACCES 121Search permission is denied for a component of the path prefix, or the 122object exists and the process does not have appropriate access rights. 123.It Bq Er EBADF 124The 125.Va fd 126argument is not a valid file descriptor. 127.It Bq Er EINVAL 128Argument 129.Va acl 130does not point to a valid ACL. 131.Pp 132One or more of the required ACL entries is not present in 133.Va acl . 134.Pp 135The ACL contains entries that are not unique. 136.Pp 137The file system rejects the ACL based on fs-specific semantics issues. 138.It Bq Er ENAMETOOLONG 139A component of a pathname exceeded 255 characters, or an 140entire path name exceeded 1023 characters. 141.It Bq Er ENOENT 142The named object does not exist, or the 143.Va path_p 144argument points to an empty string. 145.It Bq Er ENOMEM 146Insufficient memory available to fulfill request. 147.It Bq Er EOPNOTSUPP 148The file system does not support ACL retrieval. 149.El 150.Sh SEE ALSO 151.Xr acl 3 , 152.Xr acl_get 3 , 153.Xr acl_init 3 , 154.Xr acl_set 3 , 155.Xr posix1e 3 156.Sh STANDARDS 157POSIX.1e is described in IEEE POSIX.1e draft 17. 158Discussion 159of the draft continues on the cross-platform POSIX.1e implementation 160mailing list. 161To join this list, see the 162.Fx 163POSIX.1e implementation 164page for more information. 165.Sh HISTORY 166POSIX.1e support was introduced in 167.Fx 4.0 , 168and development continues. 169.Sh AUTHORS 170.An Robert N M Watson 171