xref: /freebsd/lib/libc/posix1e/acl_from_text.3 (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
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_FROM_TEXT 3
32.Os
33.Sh NAME
34.Nm acl_from_text
35.Nd create an ACL from text
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/types.h
40.In sys/acl.h
41.Ft acl_t
42.Fn acl_from_text "const char *buf_p"
43.Sh DESCRIPTION
44The
45.Fn acl_from_text
46function converts the text form of an ACL referred to by
47.Va buf_p
48into the internal working structure for ACLs, appropriate for applying to
49files or manipulating.
50.Pp
51This function may cause memory to be allocated.  The caller should free any
52releasable memory, when the new ACL is no longer required, by calling
53.Xr acl_free 3
54with the
55.Va (void *)acl_t
56as an argument.
57.Sh IMPLEMENTATION NOTES
58.Fx Ns 's
59support for POSIX.1e interfaces and features is still under
60development at this time.
61.Sh RETURN VALUES
62Upon successful completion, the function shall return a pointer to the
63internal representation of the ACL in working storage.  Otherwise, 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.  Discussion
94of the draft continues on the cross-platform POSIX.1e implementation
95mailing list.  To join this list, see the
96.Fx
97POSIX.1e implementation
98page for more information.
99.Sh HISTORY
100POSIX.1e support was introduced in
101.Fx 4.0 ,
102and development continues.
103.Sh AUTHORS
104.An Robert N M Watson
105.Sh BUGS
106The
107.Fn acl_from_text
108and
109.Fn acl_to_text
110functions
111rely on the
112.Xr getpwent 3
113library calls to manage username and uid mapping, as well as the
114.Xr getgrent 3
115library calls to manage groupname and gid mapping.  These calls are not
116thread safe, and so transitively, neither are
117.Fn acl_from_text
118and
119.Fn acl_to_text .
120These functions may also interfere with stateful
121calls associated with the
122.Fn getpwent
123and
124.Fn getgrent
125calls.
126