lib/libc/posix1e/acl_valid.3

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