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