lib/libc/posix1e/acl_to_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 June 25, 2009
  31 .Dt ACL_TO_TEXT 3
  32 .Os
  33 .Sh NAME
  34 .Nm acl_to_text ,
  35 .Nm acl_to_text_np
  36 .Nd convert an ACL to text
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/acl.h
  42 .Ft char *
  43 .Fn acl_to_text "acl_t acl" "ssize_t *len_p"
  44 .Ft char *
  45 .Fn acl_to_text_np "acl_t acl" "ssize_t *len_p" "int flags"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn acl_to_text
  49 and
  50 .Fn acl_to_text_np
  51 functions translate the ACL pointed to by argument
  52 .Va acl
  53 into a NULL terminated character string.
  54 If the pointer
  55 .Va len_p
  56 is not NULL, then the function shall return the length of the string (not
  57 including the NULL terminator) in the location pointed to by
  58 .Va len_p .
  59 If the ACL is POSIX.1e, the format of the text string returned by
  60 .Fn acl_to_text
  61 shall be the POSIX.1e long ACL form.  If the ACL is NFSv4, the format
  62 of the text string shall be the compact form, unless the
  63 .Va ACL_TEXT_VERBOSE
  64 flag is given.
  65 .Pp
  66 The flags specified are formed by
  67 .Em or Ns 'ing
  68 the following values
  69 .Bl -column -offset 3n "ACL_TEXT_NUMERIC_IDS"
  70 .It ACL_TEXT_VERBOSE Ta "Format ACL using verbose form"
  71 .It ACL_TEXT_NUMERIC_IDS Ta "Do not resolve IDs into user or group names"
  72 .It ACL_TEXT_APPEND_ID Ta "In addition to user and group names, append numeric IDs"
  73 .El
  74 .Pp
  75 This function allocates any memory necessary to contain the string and
  76 returns a pointer to the string.
  77 The caller should free any releasable
  78 memory, when the new string is no longer required, by calling
  79 .Xr acl_free 3
  80 with the
  81 .Va (void*)char
  82 as an argument.
  83 .Sh IMPLEMENTATION NOTES
  84 .Fx Ns 's
  85 support for POSIX.1e interfaces and features is still under
  86 development at this time.
  87 .Sh RETURN VALUES
  88 Upon successful completion, the function shall return a pointer to the
  89 long text form of an ACL.
  90 Otherwise, a value of
  91 .Va (char*)NULL
  92 shall be returned and
  93 .Va errno
  94 shall be set to indicate the error.
  95 .Sh ERRORS
  96 If any of the following conditions occur, the
  97 .Fn acl_to_text
  98 function shall return a value of
  99 .Va (acl_t)NULL
 100 and set
 101 .Va errno
 102 to the corresponding value:
 103 .Bl -tag -width Er
 104 .It Bq Er EINVAL
 105 Argument
 106 .Va acl
 107 does not point to a valid ACL.
 108 .Pp
 109 The ACL denoted by
 110 .Va acl
 111 contains one or more improperly formed ACL entries, or for some other
 112 reason cannot be translated into a text form of an ACL.
 113 .It Bq Er ENOMEM
 114 The character string to be returned requires more memory than is allowed
 115 by the hardware or software-imposed memory management constraints.
 116 .El
 117 .Sh SEE ALSO
 118 .Xr acl 3 ,
 119 .Xr acl_free 3 ,
 120 .Xr acl_from_text 3 ,
 121 .Xr posix1e 3
 122 .Sh STANDARDS
 123 POSIX.1e is described in IEEE POSIX.1e draft 17.
 124 Discussion
 125 of the draft continues on the cross-platform POSIX.1e implementation
 126 mailing list.
 127 To join this list, see the
 128 .Fx
 129 POSIX.1e implementation
 130 page for more information.
 131 .Sh HISTORY
 132 POSIX.1e support was introduced in
 133 .Fx 4.0 ,
 134 and development continues.
 135 .Sh AUTHORS
 136 .An Robert N M Watson
 137 .Sh BUGS
 138 The
 139 .Fn acl_from_text
 140 and
 141 .Fn acl_to_text
 142 functions
 143 rely on the
 144 .Xr getpwent 3
 145 library calls to manage username and uid mapping, as well as the
 146 .Xr getgrent 3
 147 library calls to manage groupname and gid mapping.
 148 These calls are not
 149 thread safe, and so transitively, neither are
 150 .Fn acl_from_text
 151 and
 152 .Fn acl_to_text .
 153 These functions may also interfere with stateful
 154 calls associated with the
 155 .Fn getpwent
 156 and
 157 .Fn getgrent
 158 calls.