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