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