xref: /netbsd-src/lib/libc/posix1e/acl_calc_mask.3 (revision 1b3734281f17fd86d3db0e29f84ea9985be6fe06)
1.\" $NetBSD: acl_calc_mask.3,v 1.2 2020/06/18 19:46:34 wiz Exp $
2.\"-
3.\" Copyright (c) 2001 Chris D. Faulhaber
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD: head/lib/libc/posix1e/acl_calc_mask.3 267774 2014-06-23 08:25:03Z bapt $
28.\"
29.Dd March 10, 2001
30.Dt ACL_CALC_MASK 3
31.Os
32.Sh NAME
33.Nm acl_calc_mask
34.Nd calculate and set ACL mask permissions
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In sys/types.h
39.In sys/acl.h
40.Ft int
41.Fn acl_calc_mask "acl_t *acl_p"
42.Sh DESCRIPTION
43The
44.Fn acl_calc_mask
45function
46is a POSIX.1e call that calculates and set the permissions
47associated with the
48.Dv ACL_MASK
49ACL entry of the ACL referred to by
50.Fa acl_p .
51.Pp
52The value of new permissions are the union of the permissions
53granted by the
54.Dv ACL_GROUP , ACL_GROUP_OBJ , ACL_USER
55tag types which
56match processes in the file group class contained in the ACL
57referred to by
58.Fa acl_p .
59.Pp
60If the ACL referred to by
61.Fa acl_p
62already contains an
63.Dv ACL_MASK
64entry, its permissions shall be
65overwritten; if it does not contain an
66.Dv ACL_MASK
67entry, one shall
68be added.
69.Sh RETURN VALUES
70.Rv -std acl_calc_mask
71.Sh ERRORS
72The
73.Fn acl_calc_mask
74function fails if:
75.Bl -tag -width Er
76.It Bq Er EINVAL
77Argument
78.Fa acl_p
79does not point to a pointer to a valid ACL.
80.El
81.Sh SEE ALSO
82.Xr acl 3 ,
83.Xr acl_get_entry 3 ,
84.Xr acl_valid 3 ,
85.Xr posix1e 3
86.Sh STANDARDS
87POSIX.1e is described in IEEE POSIX.1e draft 17.
88.Sh HISTORY
89POSIX.1e support was introduced in
90.Fx 4.0 .
91The
92.Fn acl_calc_mask
93function was added in
94.Fx 5.0 .
95.Sh AUTHORS
96The
97.Fn acl_calc_mask
98function was written by
99.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
100