xref: /freebsd/lib/libc/posix1e/acl_calc_mask.3 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
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 THE AUTHOR OR THE VOICES IN HIS HEAD BE
18.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24.\" POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd March 10, 2001
29.Dt ACL_CALC_MASK 3
30.Os
31.Sh NAME
32.Nm acl_calc_mask
33.Nd calculate and set ACL mask permissions
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/acl.h
39.Ft int
40.Fn acl_calc_mask "acl_t *acl_p"
41.Sh DESCRIPTION
42The
43.Fn acl_calc_mask
44function
45is a POSIX.1e call that calculates and set the permissions
46associated with the
47.Dv ACL_MASK
48ACL entry of the ACL referred to by
49.Fa acl_p .
50.Pp
51The value of new permissions are the union of the permissions
52granted by the
53.Dv ACL_GROUP , ACL_GROUP_OBJ , ACL_USER
54tag types which
55match processes in the file group class contained in the ACL
56referred to by
57.Fa acl_p .
58.Pp
59If the ACL referred to by
60.Fa acl_p
61already contains an
62.Dv ACL_MASK
63entry, its permissions shall be
64overwritten; if it does not contain an
65.Dv ACL_MASK
66entry, one shall
67be added.
68.Sh RETURN VALUES
69.Rv -std acl_calc_mask
70.Sh ERRORS
71The
72.Fn acl_calc_mask
73function fails if:
74.Bl -tag -width Er
75.It Bq Er EINVAL
76Argument
77.Fa acl_p
78does not point to a pointer to a valid ACL.
79.El
80.Sh SEE ALSO
81.Xr acl 3 ,
82.Xr acl_get_entry 3 ,
83.Xr acl_valid 3 ,
84.Xr posix1e 3
85.Sh STANDARDS
86POSIX.1e is described in IEEE POSIX.1e draft 17.
87.Sh HISTORY
88POSIX.1e support was introduced in
89.Fx 4.0 .
90The
91.Fn acl_calc_mask
92function was added in
93.Fx 5.0 .
94.Sh AUTHORS
95The
96.Fn acl_calc_mask
97function was written by
98.An Chris D. Faulhaber Aq jedgar@fxp.org .
99