xref: /freebsd/share/man/man9/VOP_SETACL.9 (revision 77a0943ded95b9e6438f7db70c4a28e4d93946d4)
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_SETACL 9
31.Sh NAME
32.Nm VOP_SETACL
33.Nd Set the 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_SETACL "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 set the access control list (ACL) for a file
42or 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 set
50.It Ar aclp
51a pointer to an ACL structure from which to retrieve the ACL data
52.It Ar cred
53the user credentials to use in authorizing the request
54.It Ar p
55the process setting the ACL
56.El
57.Pp
58The
59.Fa aclp
60pointer may be NULL to indicate that the specified ACL should be deleted.
61.Pp
62The
63.Fa cred
64pointer may be NULL to indicate that access control checks are not to be
65performed, of possible.  This cred setting might be used to allow the
66kernel to authorize extended attribute changes that the active process might
67not be permitted to make.
68.Pp
69The vnode ACL interface defines the syntax, and not semantics, of file and
70directory ACL interfaces.  More information about ACL management in kernel
71may be found in
72.Xr acl 9 .
73.Sh LOCKS
74The vnode will be locked on entry and should remain locked on return.
75.Sh RETURN VALUES
76If the ACL is successfully set, then zero is returned.  Otherwise, an
77appropriate error code is returned.
78.Sh ERRORS
79.Bl -tag -width Er
80.It Bq Er EINVAL
81The ACL type passed is invalid for this vnode, or the ACL data is invalid
82.It Bq Er EACCES
83Permission denied
84.It Bq Er ENOMEM
85Insufficient memory available to fulfill request
86.It Bq Er EOPNOTSUPP
87The file system does not support VOP_SETACL
88.It Bq Er ENOSPC
89The file system is out of space
90.It Bq Er EROFS
91The file system is read-only
92.El
93.Sh SEE ALSO
94.Xr acl 9 ,
95.Xr vnode 9 ,
96.Xr VOP_ACLCHECK 9 ,
97.Xr VOP_GETACL 9
98.Sh AUTHORS
99This man page was written by
100.An Robert Watson .
101