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