xref: /freebsd/share/man/man9/VOP_ACLCHECK.9 (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1.\"-
2.\" Copyright (c) 1999 Robert N. M. Watson
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 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 December 23, 1999
27.Dt VOP_ACLCHECK 9
28.Os
29.Sh NAME
30.Nm VOP_ACLCHECK
31.Nd check an access control list for a vnode
32.Sh SYNOPSIS
33.In sys/param.h
34.In sys/vnode.h
35.In sys/acl.h
36.Ft int
37.Fn VOP_ACLCHECK "struct vnode *vp" "acl_type_t type" "struct acl *aclp" "struct ucred *cred" "struct thread *td"
38.Sh DESCRIPTION
39This vnode call may be used to determine the validity of a particular access
40control list (ACL) for a particular file or directory.
41.Pp
42Its arguments are:
43.Bl -tag -width type
44.It Fa vp
45The vnode of the file or directory.
46.It Fa type
47The type of ACL to check.
48.It Fa aclp
49A pointer to an ACL structure from which to retrieve the ACL data.
50.It Fa cred
51The user credentials to use in authorizing the request.
52.It Fa td
53The thread checking the ACL.
54.El
55.Pp
56The
57.Fa cred
58pointer may be NULL to indicate that access control checks are not to be
59performed, if possible.
60This cred setting might be used to allow the
61kernel to authorize ACL verification that the active process might not be
62permitted to do.
63.Pp
64The vnode ACL interface defines the syntax, and not semantics, of file and
65directory ACL interfaces.
66More information about ACL management in kernel
67may be found in
68.Xr acl 9 .
69.Sh LOCKS
70No locks are required to call this vnode method, and any locks held on
71entry will be held on exit.
72.Sh RETURN VALUES
73If the
74.Fa aclp
75pointer points to a valid ACL of type
76.Fa type
77for the object
78.Fa vp ,
79then zero is returned.
80Otherwise, an appropriate error code is returned.
81.Sh ERRORS
82.Bl -tag -width Er
83.It Bq Er EINVAL
84The ACL type passed is invalid for this vnode, or the ACL data is invalid.
85.It Bq Er EACCES
86The file or directory ACL does not permit access.
87.It Bq Er ENOMEM
88Sufficient memory is not available to fulfill the request.
89.It Bq Er EOPNOTSUPP
90The file system does not support
91.Fn VOP_ACLCHECK .
92.El
93.Sh SEE ALSO
94.Xr acl 9 ,
95.Xr vnode 9 ,
96.Xr VOP_GETACL 9 ,
97.Xr VOP_SETACL 9
98.Sh AUTHORS
99This manual page was written by
100.An Robert Watson .
101