1.\"- 2.\" Copyright (c) 2000 Robert N. M. Watson 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd January 28, 2000 29.Dt ACL_TO_TEXT 3 30.Os FreeBSD 31.Sh NAME 32.Nm acl_to_text 33.Nd convert an ACL to Text 34.Sh LIBRARY 35.Lb libposix1e 36.Sh SYNOPSIS 37.Fd #include <sys/types.h> 38.Fd #include <sys/acl.h> 39.Ft char * 40.Fn acl_to_text "acl_t acl" "ssize_t *len_p" 41.Sh DESCRIPTION 42The 43.Fn acl_to_text 44function translates the ACL pointed to by argument 45.Va acl 46into a NULL terminated character string. If the pointer 47.Va len_p 48is not NULL, then the function shall return the length of the string (not 49including the NULL terminator) in the location pointed to by 50.Va len_p . 51The format of the text string returned by 52.Fn acl_to_text 53shall be the POSIX.1e long ACL form. 54.Pp 55This function allocates any memory necessary to contain the string and 56returns a pointer to the string. The caller should free any releasable 57memory, when the new string is no longer required, by calling 58.Xr acl_free 3 59with the 60.Va (void*)char 61as an argument. 62.Sh IMPLEMENTATION NOTES 63.Fx Ns 's 64support for POSIX.1e interfaces and features is still under 65development at this time. 66.Sh RETURN VALUES 67Upon successful completion, the function shall return a pointer to the 68long text form of an ACL. Otherwise, a value of 69.Va (char*)NULL 70shall be returned and 71.Va errno 72shall be set to indicate the error. 73.Sh ERRORS 74If any of the following conditions occur, the 75.Fn acl_to_text 76function shall return a value of 77.Va (acl_t)NULL 78and set 79.Va errno 80to the corresponding value: 81.Bl -tag -width Er 82.It Bq Er EINVAL 83Argument 84.Va acl 85does not point to a valid ACL. 86.Pp 87The ACL denoted by 88.Va acl 89contains one or more improperly formed ACL entries, or for some other 90reason cannot be translated into a text form of an ACL. 91.It Bq Er ENOMEM 92The character string to be returned requires more memory than is allowed 93by the hardware or software-imposed memory management constraints. 94.El 95.Sh SEE ALSO 96.Xr acl 3 , 97.Xr acl_free 3 , 98.Xr acl_from_text 3 , 99.Xr posix1e 3 100.Sh STANDARDS 101POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion 102of the draft continues on the cross-platform POSIX.1e implementation 103mailing list. To join this list, see the 104.Fx 105POSIX.1e implementation 106page for more information. 107.Sh HISTORY 108POSIX.1e support was introduced in 109.Fx 4.0 , 110and development continues. 111.Sh AUTHORS 112.An Robert N M Watson 113.Sh BUGS 114These features are not yet fully implemented. 115.Pp 116.Fn acl_from_text 117and 118.Fn acl_to_text 119rely on the 120.Xr getpwent 3 121library calls to manage username and uid mapping, as well as the 122.Xr getgrent 3 123library calls to manage groupname and gid mapping. These calls are not 124thread safe, and so transitively, neither are 125.Fn acl_from_text 126and 127.Fn acl_to_text . 128These functions may also interfere with stateful 129calls associated with the 130.Fn getpwent 131and 132.Fn getgrent 133calls. 134