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