lib/libposix1e/acl_from_text.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_from_text.3,v 1.3.2.5 2001/12/20 16:27:06 ru Exp $
  27 .\"
  28 .Dd January 28, 2000
  29 .Dt ACL_FROM_TEXT 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_from_text
  33 .Nd create an ACL from text
  34 .Sh LIBRARY
  35 .Lb libposix1e
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/acl.h
  39 .Ft acl_t
  40 .Fn acl_from_text "const char *buf_p"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_from_text
  44 function converts the text form of an ACL referred to by
  45 .Va buf_p
  46 into the internal working structure for ACLs, appropriate for applying to
  47 files or manipulating.
  48 .Pp
  49 This function may cause memory to be allocated.  The caller should free any
  50 releasable memory, when the new ACL is no longer required, by calling
  51 .Xr acl_free 3
  52 with the
  53 .Va (void *)acl_t
  54 as an argument.
  55 .Sh IMPLEMENTATION NOTES
  56 .Fx Ns 's
  57 support for POSIX.1e interfaces and features is still under
  58 development at this time.
  59 .Sh RETURN VALUES
  60 Upon successful completion, the function shall return a pointer to the
  61 internal representation of the ACL in working storage.  Otherwise, a value
  62 of
  63 .Va (acl_t)NULL
  64 shall be returned, and
  65 .Va errno
  66 shall be set to indicate the error.
  67 .Sh ERRORS
  68 If any of the following conditions occur, the
  69 .Fn acl_from_text
  70 function shall return a value of
  71 .Va (acl_t)NULL
  72 and set
  73 .Va errno
  74 to the corresponding value:
  75 .Bl -tag -width Er
  76 .It Bq Er EACCES
  77 Search permission is denied for a component of the path prefix, or the
  78 object exists and the process does not have appropriate access rights.
  79 .It Bq Er EINVAL
  80 Argument
  81 .Va buf_p
  82 cannot be translated into an ACL.
  83 .It Bq Er ENOMEM
  84 The ACL working storage requires more memory than is allowed by the
  85 hardware or system-imposed memory management constraints.
  86 .El
  87 .Sh SEE ALSO
  88 .Xr acl 3 ,
  89 .Xr acl_free 3 ,
  90 .Xr acl_get 3 ,
  91 .Xr acl_to_text 3 ,
  92 .Xr posix1e 3
  93 .Sh STANDARDS
  94 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  95 of the draft continues on the cross-platform POSIX.1e implementation
  96 mailing list.  To join this list, see the
  97 .Fx
  98 POSIX.1e implementation
  99 page for more information.
 100 .Sh HISTORY
 101 POSIX.1e support was introduced in
 102 .Fx 4.0 ,
 103 and development continues.
 104 .Sh AUTHORS
 105 .An Robert N M Watson
 106 .Sh BUGS
 107 These features are not yet fully implemented.  In particular, the shipped
 108 version of UFS/FFS does not support storage of additional security labels,
 109 and so is unable to (easily) provide support for most of these features.
 110 .Pp
 111 .Fn acl_from_text
 112 and
 113 .Fn acl_to_text
 114 rely on the
 115 .Xr getpwent 3
 116 library calls to manage username and uid mapping, as well as the
 117 .Xr getgrent 3
 118 library calls to manage groupname and gid mapping.  These calls are not
 119 thread safe, and so transitively, neither are
 120 .Fn acl_from_text
 121 and
 122 .Fn acl_to_text .
 123 These functions may also interfere with stateful
 124 calls associated with the
 125 .Fn getpwent
 126 and
 127 .Fn getgrent
 128 calls.