summaryrefslogtreecommitdiff
path: root/man/man3/acl_calc_mask.3
blob: a5a46c0f7491f654a302aa0c56b85e180e6de599 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
.\" Access Control Lists manual pages
.\"
.\" (C) 2002 Andreas Gruenbacher, <a.gruenbacher@computer.org>
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.TH ACL_CALC_MASK 3 "Linux ACL Library" "March 2002" "Access Control Lists"
.SH NAME
acl_calc_mask \- calculate the file group class mask
.SH LIBRARY
Linux Access Control Lists library (libacl, \-lacl).
.SH C SYNOPSIS
.sp
.nf
.B #include <sys/types.h>
.B #include <sys/acl.h>
.sp
.B "int acl_calc_mask (acl_t *\f2acl_p\f3);"
.Op
.SH DESCRIPTION
The
.B acl_calc_mask
function calculates and sets the permissions associated with the ACL_MASK
ACL entry of the ACL referred to by
.IR acl_p .
The value of the new permissions is the union of the permissions
granted by all entries of tag type ACL_GROUP, ACL_GROUP_OBJ, or ACL_USER.
If the ACL referred to by
.I acl_p
already contains an ACL_MASK entry, its permissions are overwritten;
if it does not contain an ACL_MASK entry, one is added.
.PP
If the ACL referred to by
.I acl_p
does not contain enough space for the new ACL entry, then additional working
storage may be allocated. If the working storage cannot be increased in the
current location, then it may be relocated and the previous working storage
is released and a pointer to the new working storage is returned via
.IR acl_p .
.PP
The order of existing entries in the ACL is undefined after this function.
.PP
Any existing ACL entry descriptors that refer to entries in the ACL continue to
refer to those entries. Any existing ACL pointers that refer to the ACL
referred to by
.I acl_p
continue to refer to the ACL.
.\" <AG>
.\" Conflict between requirements:
.\" (a) ACL may be relocated,
.\" (b) all pointers remain valid.
.\" </AG>
.SH RETURN VALUE
The value 0 is returned if successful; otherwise the value -1 is
returned and the global variable errno is set to indicate the error.
.SH ERRORS
If any of the following conditions occur, the
.B acl_calc_mask
function returns -1 and sets
.B errno
to the corresponding value:
.TP
.SM
\%[EINVAL]
The argument
.I acl
is not a valid pointer to an ACL.
.TP
.SM
\%[ENOMEM]
The
.B acl_calc_mask
function is unable to allocate the memory required for an ACL_MASK ACL entry.
.SH STANDARDS
IEEE Std 1003.1e draft 17 (\(lqPOSIX.1e\(rq, abandoned)
.SH AUTHOR
Derived from the FreeBSD manual pages written by
.IR "Robert N M Watson" ;
and adapted for Linux by
.I "Andreas Gruenbacher"
<a.gruenbacher@computer.org>.
.SH SEE ALSO
.BR acl (5)