lib/libposix1e/acl_to_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$
  27 .\"
  28 .Dd January 28, 2000
  29 .Dt ACL_TO_TEXT 3
  30 .Os FreeBSD 4.0
  31 .Sh NAME
  32 .Nm acl_to_text
  33 .Nd Convert an ACL to Text
  34 .Sh SYNOPSIS
  35 .Fd #include <sys/types.h>
  36 .Fd #include <sys/acl.h>
  37 .Ft char *
  38 .Fn acl_to_text "acl_t acl" "ssize_t *len_p"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn acl_to_text
  42 function translates the ACL pointed to by argument
  43 .Va acl
  44 into a NULL terminated character string.  If the pointer
  45 .Va len_p
  46 is not NULL, then the function shall return the length of the string (not
  47 including the NULL terminator) in the location pointed to by
  48 .Va len_p .
  49 The format of the text string returned by
  50 .Fn acl_to_text
  51 shall be the POSIX.1e long ACL form.
  52
  53 This function allocates any memory necessary to contain the string and
  54 returns a pointer to the string.  The caller should free any releasable
  55 memory, when the new string is no longer required, by calling
  56 .Xr acl_free 3
  57 with the
  58 .Va (void*)char
  59 as an argument.
  60 .Sh IMPLEMENTATION NOTES
  61 FreeBSD's support for POSIX.1e interfaces and features is still under
  62 development at this time.
  63 .Sh RETURN VALUES
  64 Upon successful completion, the function shall return a pointer to the
  65 long text form of an ACL.  Otherwise, a value of
  66 .Va (char*)NULL
  67 shall be returned and
  68 .Va errno
  69 shall be set to indicate the error.
  70 .Sh ERRORS
  71 If any of the following conditions occur, the
  72 .Fn acl_to_text
  73 function shall return a value of
  74 .Va (acl_t)NULL
  75 and set
  76 .Va errno
  77 to the corresponding value:
  78 .Bl -tag -width Er
  79 .It Bq Er EINVAL
  80 Argument
  81 .Va acl
  82 does not point to a valid ACL.
  83
  84 The ACL denoted by
  85 .Va acl
  86 contains one or more improperly formed ACL entries, or for some other
  87 reason cannot be translated into a text form of an ACL.
  88 .It Bq Er ENOMEM
  89 The character string to be returned requires more memory than is allowed
  90 by the hardware or software-imposed memory management constraints.
  91 .El
  92 .Sh SEE ALSO
  93 .Xr acl 3 ,
  94 .Xr acl_free 3 ,
  95 .Xr acl_from_text 3 ,
  96 .Xr posix1e 3
  97 .Sh STANDARDS
  98 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  99 of the draft continues on the cross-platform POSIX.1e implementation
 100 mailing list.  To join this list, see the FreeBSD POSIX.1e implementation
 101 page for more information.
 102 .Sh HISTORY
 103 POSIX.1e support was introduced in
 104 .Fx 4.0 ,
 105 and development continues.
 106 .Sh AUTHORS
 107 .An Robert N M Watson
 108 .Sh BUGS
 109 These features are not yet fully implemented.  In particular, the shipped
 110 version of UFS/FFS does not support storage of additional security labels,
 111 and so is unable to (easily) provide support for most of these features.
 112
 113 .Fn acl_from_text
 114 and
 115 .Fn acl_to_text
 116 rely on the
 117 .Xr getpwent 3
 118 library calls to manage username and uid mapping, as well as the
 119 .Xr getgrent 3
 120 library calls to manage groupname and gid mapping.  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.