manual/acl/original/man3/acl_extended_fd.3

   1 .\" Access Control Lists manual pages
   2 .\"
   3 .\" (C) 2002 Andreas Gruenbacher, <a.gruenbacher@bestbits.at>
   4 .\"
   5 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   6 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   7 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   8 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   9 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  10 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  11 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  12 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  13 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  14 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  15 .\" SUCH DAMAGE.
  16 .\"
  17 .Dd March 23, 2002
  18 .Dt ACL_EXTENDED_FD 3
  19 .Os "Linux ACL"
  20 .Sh NAME
  21 .Nm acl_extended_fd
  22 .Nd test for information in the ACL by file descriptor
  23 .Sh LIBRARY
  24 Linux Access Control Lists library (libacl, \-lacl).
  25 .Sh SYNOPSIS
  26 .In sys/types.h
  27 .In acl/libacl.h
  28 .Ft int
  29 .Fn acl_extended_fd "int fd"
  30 .Sh DESCRIPTION
  31 The
  32 .Fn acl_extended_fd
  33 function returns
  34 .Li 1
  35 if the file identified by the argument
  36 .Va fd
  37 is associated with an extended access ACL. The function returns
  38 .Li 0
  39 if the file does not have an extended access ACL.
  40 .Pp
  41 An extended ACL is an ACL that contains entries other than the three
  42 required entries of tag types ACL_USER_OBJ, ACL_GROUP_OBJ and ACL_OTHER.
  43 If the result of the
  44 .Fn acl_extended_fd
  45 function for a file object is
  46 .Li 0 ,
  47 then the ACL defines no discretionary access rights other than those
  48 already defined by the traditional file permission bits.
  49 .Pp
  50 Access to the file object may be further restricted by other
  51 mechanisms, such as Mandatory Access Control schemes. The
  52 .Xr access 2
  53 system call can be used to check whether a given type of access to a file
  54 object would be granted.
  55 .Sh RETURN VALUE
  56 If successful, the
  57 .Fn acl_extended_fd
  58 function returns
  59 .Li 1
  60 if the file object identified by
  61 .Va fd
  62 has an extended access ACL, and
  63 .Li 0
  64 if the file object identified by
  65 .Va fd
  66 does not have an extended access ACL. Otherwise, the value
  67 .Li -1
  68 is returned and the global variable
  69 .Va errno
  70 is set to indicate the error.
  71 .Sh ERRORS
  72 If any of the following conditions occur, the
  73 .Fn acl_extended_fd
  74 function returns
  75 .Li -1
  76 and sets
  77 .Va errno
  78 to the corresponding value:
  79 .Bl -tag -width Er
  80 .It Bq Er EBADF
  81 The
  82 .Va fd
  83 argument is not a valid file descriptor.
  84 .It Bq Er ENOTSUP
  85 The file system on which the file identified by
  86 .Va fd
  87 is located does not support ACLs, or ACLs are disabled.
  88 .El
  89 .Sh STANDARDS
  90 This is a non-portable, Linux specific extension to the ACL manipulation
  91 functions defined in IEEE Std 1003.1e draft 17 (\(lqPOSIX.1e\(rq, abandoned).
  92 .Sh SEE ALSO
  93 .Xr access 2 ,
  94 .Xr acl_get_fd 3 ,
  95 .Xr acl 5
  96 .Sh AUTHOR
  97 Written by
  98 .An "Andreas Gruenbacher" Aq a.gruenbacher@bestbits.at .