xref: /freebsd/lib/libc/posix1e/acl_calc_mask.3 (revision 1da7f3f6f72b2245e458fc7195733268ae4a1136)
1.\"-
2.\" Copyright (c) 2001 Chris D. Faulhaber
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 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.Dd March 10, 2001
27.Dt ACL_CALC_MASK 3
28.Os
29.Sh NAME
30.Nm acl_calc_mask
31.Nd calculate and set ACL mask permissions
32.Sh LIBRARY
33.Lb libc
34.Sh SYNOPSIS
35.In sys/types.h
36.In sys/acl.h
37.Ft int
38.Fn acl_calc_mask "acl_t *acl_p"
39.Sh DESCRIPTION
40The
41.Fn acl_calc_mask
42function
43is a POSIX.1e call that calculates and set the permissions
44associated with the
45.Dv ACL_MASK
46ACL entry of the ACL referred to by
47.Fa acl_p .
48.Pp
49The value of new permissions are the union of the permissions
50granted by the
51.Dv ACL_GROUP , ACL_GROUP_OBJ , ACL_USER
52tag types which
53match processes in the file group class contained in the ACL
54referred to by
55.Fa acl_p .
56.Pp
57If the ACL referred to by
58.Fa acl_p
59already contains an
60.Dv ACL_MASK
61entry, its permissions shall be
62overwritten; if it does not contain an
63.Dv ACL_MASK
64entry, one shall
65be added.
66.Sh RETURN VALUES
67.Rv -std acl_calc_mask
68.Sh ERRORS
69The
70.Fn acl_calc_mask
71function fails if:
72.Bl -tag -width Er
73.It Bq Er EINVAL
74Argument
75.Fa acl_p
76does not point to a pointer to a valid ACL.
77.El
78.Sh SEE ALSO
79.Xr acl 3 ,
80.Xr acl_get_entry 3 ,
81.Xr acl_valid 3 ,
82.Xr posix1e 3
83.Sh STANDARDS
84POSIX.1e is described in IEEE POSIX.1e draft 17.
85.Sh HISTORY
86POSIX.1e support was introduced in
87.Fx 4.0 .
88The
89.Fn acl_calc_mask
90function was added in
91.Fx 5.0 .
92.Sh AUTHORS
93The
94.Fn acl_calc_mask
95function was written by
96.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
97