xref: /freebsd/share/man/man9/VOP_GETACL.9 (revision 1d66272a85cde1c8a69c58f4b5dd649babd6eca6)
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.\"       $FreeBSD$
27.\"
28.Dd December 23, 1999
29.Os
30.Dt VOP_GETACL 9
31.Sh NAME
32.Nm VOP_GETACL
33.Nd Retrieve access control list for a vnode
34.Sh SYNOPSIS
35.Fd #include <sys/param.h>
36.Fd #include <sys/vnode.h>
37.Fd #include <sys/acl.h>
38.Ft int
39.Fn VOP_GETACL "struct vnode *vp" "acl_type_t type" "struct acl *aclp" "struct ucred *cred" "struct proc *p"
40.Sh DESCRIPTION
41This vnode call may be used to retrieve the access control list (ACL) from a
42file or directory.
43.Pp
44Its arguments are:
45.Bl -tag -width type
46.It Ar vp
47the vnode of the file or directory
48.It Ar type
49the type of ACL to retrieve
50.It Ar aclp
51a pointer to an ACL structure to receive the ACL data
52.It Ar cred
53the user credentials to use in authorizing the request
54.It Ar p
55the process requesting the ACL
56.El
57.Pp
58The
59.Fa cred
60pointer may be NULL to indicate that access control checks are not to be
61performed, of possible.  This cred setting might be used to allow the
62kernel to authorize ACL retrieval that the active process might not be
63permitted to do.
64.Pp
65The vnode ACL interface defines the syntax, and not semantics, of file and
66directory ACL interfaces.  More information about ACL management in kernel
67may be found in
68.Xr acl 9 .
69.Sh LOCKS
70The vnode will be locked on entry and should remain locked on return.
71.Sh RETURN VALUES
72If the
73.Fa aclp
74pointer will point to a valid ACL, then zero is returned.  Otherwise,
75an appropriate error code is returned.
76.Sh ERRORS
77.Bl -tag -width Er
78.It Bq Er EINVAL
79The ACL type passed is invalid for this vnode
80.It Bq Er EACCES
81Permission denied
82.It Bq Er ENOMEM
83Insufficient memory available to fulfill request
84.It Bq Er EOPNOTSUPP
85The file system does not support VOP_GETACL
86.El
87.Sh SEE ALSO
88.Xr acl 9 ,
89.Xr vnode 9 ,
90.Xr VOP_ACLCHECK 9 ,
91.Xr VOP_SETACL 9
92.Sh AUTHORS
93This man page was written by
94.An Robert Watson .
95