lib/libposix1e/acl_get.3

   1 .\"-
   2 .\" Copyright (c) 2000 Robert N. M. Watson
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/libposix1e/acl_get.3,v 1.3.2.5 2001/12/20 16:27:06 ru Exp $
  27 .\" $DragonFly: src/lib/libposix1e/acl_get.3,v 1.3 2004/03/11 12:28:52 hmp Exp $
  28 .\"
  29 .Dd January 28, 2000
  30 .Dt ACL_GET 3
  31 .Os
  32 .Sh NAME
  33 .Nm acl_get_fd ,
  34 .Nm acl_get_fd_np ,
  35 .Nm acl_get_file
  36 .Nd get an ACL for a file
  37 .Sh LIBRARY
  38 .Lb libposix1e
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/acl.h
  42 .Ft acl_t
  43 .Fn acl_get_file "const char *path_p" "acl_type_t type"
  44 .Ft acl_t
  45 .Fn acl_get_fd "int fd"
  46 .Ft acl_t
  47 .Fn acl_get_fd_np "int fd" "acl_type_t type"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn acl_get_file ,
  51 .Fn acl_get_fd ,
  52 and
  53 .Fn acl_get_fd_np
  54 each allow the retrieval of an ACL from a file.
  55 .Fn acl_get_file
  56 is a POSIX.1e call that allows the retrieval of a
  57 specified type of ACL from a file by name;
  58 .Fn acl_get_fd
  59 is a POSIX.1e call that allows the retrieval of an ACL of type
  60 ACL_TYPE_ACCESS
  61 from a file descriptor.
  62 .Fn acl_get_fd_np
  63 is a non-portable form of
  64 .Fn acl_get_fd
  65 that allows the retrieval of any type of ACL from a file descriptor.
  66 .Pp
  67 This function may cause memory to be allocated.  The caller should free
  68 any releasable memory, when the new ACL is no longer required, by calling
  69 .Xr acl_free 3
  70 with the
  71 .Va (void *)acl_t
  72 as an argument.
  73 .Pp
  74 The ACL in the working storage is an independent copy of the ACL associated
  75 with the object referred to by
  76 .Va fd .
  77 The ACL in the working storage shall not participate in any access control
  78 decisions.
  79 .Sh IMPLEMENTATION NOTES
  80 .Dx Ns 's
  81 support for POSIX.1e interfaces and features is still under
  82 development at this time.
  83 .Sh RETURN VALUES
  84 Upon successful completion, the function shall return a pointer to the ACL
  85 that was retrieved.  Otherwise, a value of
  86 .Va (acl_t)NULL
  87 shall be returned, and
  88 .Va errno
  89 shall be set to indicate the error.
  90 .Sh ERRORS
  91 If any of the following conditions occur, the
  92 .Fn acl_get_fd
  93 function shall return a value of
  94 .Va (acl_t)NULL
  95 and set
  96 .Va errno
  97 to the corresponding value:
  98 .Bl -tag -width Er
  99 .It Bq Er EACCES
 100 Search permission is denied for a component of the path prefix, or the
 101 object exists and the process does not have appropriate access rights.
 102 .It Bq Er EBADF
 103 The
 104 .Va fd
 105 argument is not a valid file descriptor.
 106 .It Bq Er EINVAL
 107 The ACL type passed is invalid for this file object.
 108 .It Bq Er ENAMETOOLONG
 109 A component of a pathname exceeded 255 characters, or an
 110 entire path name exceeded 1023 characters.
 111 .It Bq Er ENOENT
 112 The named object does not exist, or the
 113 .Va path_p
 114 argument points to an empty string.
 115 .It Bq Er ENOMEM
 116 Insufficient memory available to fulfill request.
 117 .It Bq Er EOPNOTSUPP
 118 The file system does not support ACL retrieval.
 119 .El
 120 .Sh SEE ALSO
 121 .Xr acl 3 ,
 122 .Xr acl_free 3 ,
 123 .Xr acl_get 3 ,
 124 .Xr acl_set 3 ,
 125 .Xr posix1e 3
 126 .Sh STANDARDS
 127 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
 128 of the draft continues on the cross-platform POSIX.1e implementation
 129 mailing list.  To join this list, see the
 130 .Fx
 131 POSIX.1e implementation
 132 page for more information.
 133 .Sh HISTORY
 134 POSIX.1e support was introduced in
 135 .Fx 4.0 ,
 136 and development continues.
 137 .Sh AUTHORS
 138 .An Robert N M Watson
 139 .Sh BUGS
 140 These features are not yet fully implemented.  In particular, the shipped
 141 version of UFS/FFS does not support storage of additional security labels,
 142 and so is unable to (easily) provide support for most of these features.