xref: /freebsd/share/man/man9/VOP_GETACL.9 (revision 8aac90f18aef7c9eea906c3ff9a001ca7b94f375)
1.\"-
2.\" Copyright (c) 1999, 2000, 2001 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_GETACL 9
28.Os
29.Sh NAME
30.Nm VOP_GETACL
31.Nd retrieve 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_GETACL "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 retrieve the access control list (ACL) from a
40file 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 retrieve.
48.It Fa aclp
49A pointer to an ACL structure to receive the ACL data.
50.It Fa cred
51The user credentials to use in authorizing the request.
52.It Fa td
53The thread requesting the ACL.
54.El
55.Pp
56The
57.Fa cred
58pointer may be
59.Dv NULL
60to indicate that access control checks are not to be performed, if possible.
61This cred setting might be used to allow the kernel to authorize ACL
62retrieval that the active process might not be permitted 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 may be found in
67.Xr acl 9 .
68.Sh LOCKS
69The vnode will be locked on entry and should remain locked on return.
70.Sh RETURN VALUES
71If the
72.Fa aclp
73pointer will point to a valid ACL, then zero is returned.
74Otherwise, an appropriate error code is returned.
75.Sh ERRORS
76.Bl -tag -width Er
77.It Bq Er EINVAL
78The ACL type passed is invalid for this vnode.
79.It Bq Er EACCES
80The caller does not have the appropriate privilege.
81.It Bq Er ENOMEM
82Sufficient memory is not available to fulfill the request.
83.It Bq Er EOPNOTSUPP
84The file system does not support
85.Fn 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 manual page was written by
94.An Robert Watson .
95