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 .\" $FreeBSD: src/lib/libc/posix1e/acl_valid.3,v 1.14 2002/12/29 20:47:05 rwatson Exp $
  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
  53 These functions check that the ACL referred to by the argument
  54 .Va acl
  55 is valid.  The POSIX.1e routine,
  56 .Fn acl_valid ,
  57 checks assumes ACL_TYPE_EXTENDED, and disregard
  58 of 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 ,
  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 The qualifier field shall be unique among all entries of
  75 the same POSIX.1e ACL facility defined tag type.  The
  76 tag type field shall contain valid values including any
  77 implementation-defined values.  Validation of the values
  78 of the qualifier field is implementation-defined.
  79 .Pp
  80 The POSIX.1e
  81 .Fn acl_valid
  82 function may reorder the ACL for the purposes of verification; the
  83 non-portable validation functions will not.
  84 .Sh RETURN VALUES
  85 .Rv -std
  86 .Sh ERRORS
  87 If any of the following conditions occur, these functions shall return
  88 -1 and set
  89 .Va errno
  90 to the corresponding value:
  91 .Bl -tag -width Er
  92 .It Bq Er EACCES
  93 Search permission is denied for a component of the path prefix, or the
  94 object exists and the process does not have appropriate access rights.
  95 .It Bq Er EBADF
  96 The
  97 .Va fd
  98 argument is not a valid file descriptor.
  99 .It Bq Er EINVAL
 100 Argument
 101 .Va acl
 102 does not point to a valid ACL.
 103 .Pp
 104 One or more of the required ACL entries is not present in
 105 .Va acl .
 106 .Pp
 107 The ACL contains entries that are not unique.
 108 .Pp
 109 The file system rejects the ACL based on fs-specific semantics issues.
 110 .It Bq Er ENAMETOOLONG
 111 A component of a pathname exceeded 255 characters, or an
 112 entire path name exceeded 1023 characters.
 113 .It Bq Er ENOENT
 114 The named object does not exist, or the
 115 .Va path_p
 116 argument points to an empty string.
 117 .It Bq Er ENOMEM
 118 Insufficient memory available to fulfill request.
 119 .It Bq Er EOPNOTSUPP
 120 The file system does not support ACL retrieval.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr acl 3 ,
 124 .Xr acl_get 3 ,
 125 .Xr acl_init 3 ,
 126 .Xr acl_set 3 ,
 127 .Xr posix1e 3
 128 .Sh STANDARDS
 129 POSIX.1e is described in IEEE POSIX.1e draft 17.
 130 .Sh AUTHORS
 131 .An Michael Smith
 132 .An Robert N M Watson