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