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