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