xref: /freebsd/lib/libc/posix1e/acl_from_text.3 (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
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.Dd January 28, 2000
29.Dt ACL_FROM_TEXT 3
30.Os
31.Sh NAME
32.Nm acl_from_text
33.Nd create an ACL from text
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/acl.h
39.Ft acl_t
40.Fn acl_from_text "const char *buf_p"
41.Sh DESCRIPTION
42The
43.Fn acl_from_text
44function converts the text form of an ACL referred to by
45.Va buf_p
46into the internal working structure for ACLs, appropriate for applying to
47files or manipulating.
48.Pp
49This function may cause memory to be allocated.
50The caller should free any
51releasable memory, when the new ACL is no longer required, by calling
52.Xr acl_free 3
53with the
54.Va (void *)acl_t
55as an argument.
56.Sh IMPLEMENTATION NOTES
57.Fx Ns 's
58support for POSIX.1e interfaces and features is still under
59development at this time.
60.Sh RETURN VALUES
61Upon successful completion, the function shall return a pointer to the
62internal representation of the ACL in working storage.
63Otherwise, a value
64of
65.Va (acl_t)NULL
66shall be returned, and
67.Va errno
68shall be set to indicate the error.
69.Sh ERRORS
70If any of the following conditions occur, the
71.Fn acl_from_text
72function shall return a value of
73.Va (acl_t)NULL
74and set
75.Va errno
76to the corresponding value:
77.Bl -tag -width Er
78.It Bq Er EINVAL
79Argument
80.Va buf_p
81cannot be translated into an ACL.
82.It Bq Er ENOMEM
83The ACL working storage requires more memory than is allowed by the
84hardware or system-imposed memory management constraints.
85.El
86.Sh SEE ALSO
87.Xr acl 3 ,
88.Xr acl_free 3 ,
89.Xr acl_get 3 ,
90.Xr acl_to_text 3 ,
91.Xr posix1e 3
92.Sh STANDARDS
93POSIX.1e is described in IEEE POSIX.1e draft 17.
94Discussion
95of the draft continues on the cross-platform POSIX.1e implementation
96mailing list.
97To join this list, see the
98.Fx
99POSIX.1e implementation
100page for more information.
101.Sh HISTORY
102POSIX.1e support was introduced in
103.Fx 4.0 ,
104and development continues.
105.Sh AUTHORS
106.An Robert N M Watson
107.Sh BUGS
108The
109.Fn acl_from_text
110and
111.Fn acl_to_text
112functions
113rely on the
114.Xr getpwent 3
115library calls to manage username and uid mapping, as well as the
116.Xr getgrent 3
117library calls to manage groupname and gid mapping.
118These calls are not
119thread safe, and so transitively, neither are
120.Fn acl_from_text
121and
122.Fn acl_to_text .
123These functions may also interfere with stateful
124calls associated with the
125.Fn getpwent
126and
127.Fn getgrent
128calls.
129