xref: /freebsd/lib/libc/posix1e/acl_from_text.3 (revision 41466b50c1d5bfd1cf6adaae547a579a75d7c04e)
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_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.  The caller should free any
50releasable memory, when the new ACL is no longer required, by calling
51.Xr acl_free 3
52with the
53.Va (void *)acl_t
54as an argument.
55.Sh IMPLEMENTATION NOTES
56.Fx Ns 's
57support for POSIX.1e interfaces and features is still under
58development at this time.
59.Sh RETURN VALUES
60Upon successful completion, the function shall return a pointer to the
61internal representation of the ACL in working storage.  Otherwise, a value
62of
63.Va (acl_t)NULL
64shall be returned, and
65.Va errno
66shall be set to indicate the error.
67.Sh ERRORS
68If any of the following conditions occur, the
69.Fn acl_from_text
70function shall return a value of
71.Va (acl_t)NULL
72and set
73.Va errno
74to the corresponding value:
75.Bl -tag -width Er
76.It Bq Er EINVAL
77Argument
78.Va buf_p
79cannot be translated into an ACL.
80.It Bq Er ENOMEM
81The ACL working storage requires more memory than is allowed by the
82hardware or system-imposed memory management constraints.
83.El
84.Sh SEE ALSO
85.Xr acl 3 ,
86.Xr acl_free 3 ,
87.Xr acl_get 3 ,
88.Xr acl_to_text 3 ,
89.Xr posix1e 3
90.Sh STANDARDS
91POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
92of the draft continues on the cross-platform POSIX.1e implementation
93mailing list.  To join this list, see the
94.Fx
95POSIX.1e implementation
96page for more information.
97.Sh HISTORY
98POSIX.1e support was introduced in
99.Fx 4.0 ,
100and development continues.
101.Sh AUTHORS
102.An Robert N M Watson
103.Sh BUGS
104These features are not yet fully implemented.
105.Pp
106.Fn acl_from_text
107and
108.Fn acl_to_text
109rely on the
110.Xr getpwent 3
111library calls to manage username and uid mapping, as well as the
112.Xr getgrent 3
113library calls to manage groupname and gid mapping.  These calls are not
114thread safe, and so transitively, neither are
115.Fn acl_from_text
116and
117.Fn acl_to_text .
118These functions may also interfere with stateful
119calls associated with the
120.Fn getpwent
121and
122.Fn getgrent
123calls.
124