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