2 .\" Copyright (c) 2001 Robert N. M. Watson
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
28 .Dd September 18, 2009
29 .Dt VACCESS_ACL_NFS4 9
33 .Nd generate a NFSv4 ACL access control decision using vnode parameters
44 .Fa "accmode_t accmode"
45 .Fa "struct ucred *cred"
49 This call implements the logic for the
51 discretionary file security model
52 with NFSv4 ACL extensions.
53 It accepts the vnodes type
59 access ACL for the file
65 and an optional call-by-reference
67 pointer returning whether or not
68 privilege was required for successful evaluation of the call; the
72 by the caller in order not to be informed of
73 privilege information, or it may point to an integer that will be set to
74 1 if privilege is used, and 0 otherwise.
76 This call is intended to support implementations of
78 which will use their own access methods to retrieve the vnode properties,
81 in order to perform the actual check.
84 may choose to implement additional security mechanisms whose results will
85 be composed with the return value.
89 is based on the NFSv4 ACL evaluation algorithm, as described in
90 NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-21.txt.
91 The algorithm selects a
93 entry from the access ACL, which may
94 then be composed with an available ACL mask entry, providing
96 security compatibility.
98 Once appropriate protections are selected for the current credential,
99 the requested access mode, in combination with the vnode type, will be
100 compared with the discretionary rights available for the credential.
101 If the rights granted by discretionary protections are insufficient,
102 then super-user privilege, if available for the credential, will also be
106 will return 0 on success, or a non-zero error value on failure.
111 An attempt was made to access a file in a way forbidden by its file access
114 Operation not permitted.
115 An attempt was made to perform an operation limited to processes with
116 appropriate privileges or to the owner of a file or other resource.
123 Current implementation of
126 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org .
128 This manual page should include a full description of the NFSv4 ACL
129 evaluation algorithm, or cross reference another page that does.