freebsd-skq/share/man/man9/VOP_GETACL.9

.\"-
.\" Copyright (c) 1999, 2000, 2001 Robert N. M. Watson
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd December 23, 1999
.Os
.Dt VOP_GETACL 9
.Sh NAME
.Nm VOP_GETACL
.Nd retrieve access control list for a vnode
.Sh SYNOPSIS
.In sys/param.h
.In sys/vnode.h
.In sys/acl.h
.Ft int
.Fn VOP_GETACL "struct vnode *vp" "acl_type_t type" "struct acl *aclp" "struct ucred *cred" "struct thread *td"
.Sh DESCRIPTION
This vnode call may be used to retrieve the access control list (ACL) from a
file or directory.
.Pp
Its arguments are:
.Bl -tag -width type
.It Fa vp
The vnode of the file or directory.
.It Fa type
The type of ACL to retrieve.
.It Fa aclp
A pointer to an ACL structure to receive the ACL data.
.It Fa cred
The user credentials to use in authorizing the request.
.It Fa td
The thread requesting the ACL.
.El
.Pp
The
.Fa cred
pointer may be
.Dv NULL
to indicate that access control checks are not to be performed, if possible.
This cred setting might be used to allow the kernel to authorize ACL
retrieval that the active process might not be permitted to do.
.Pp
The vnode ACL interface defines the syntax, and not semantics, of file and
directory ACL interfaces.
More information about ACL management in kernel may be found in
.Xr acl 9 .
.Sh LOCKS
The vnode will be locked on entry and should remain locked on return.
.Sh RETURN VALUES
If the
.Fa aclp
pointer will point to a valid ACL, then zero is returned.
Otherwise, an appropriate error code is returned.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EINVAL
The ACL type passed is invalid for this vnode.
.It Bq Er EACCES
The the caller does not have the appropriate privilege.
.It Bq Er ENOMEM
Sufficient memory is not available to fulfill the request.
.It Bq Er EOPNOTSUPP
The file system does not support
.Fn VOP_GETACL .
.El
.Sh SEE ALSO
.Xr acl 9 ,
.Xr vnode 9 ,
.Xr VOP_ACLCHECK 9 ,
.Xr VOP_SETACL 9
.Sh AUTHORS
This manual page was written by
.An Robert Watson .
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.\"-`
o The revenge of the mdoc(7) police: - These pages abused Ar macro (they should have used Fa). - NULL and other numeric constants should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 17:42:38 +00:00			`.\" Copyright (c) 1999, 2000, 2001 Robert N. M. Watson`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
o The revenge of the mdoc(7) police: - These pages abused Ar macro (they should have used Fa). - NULL and other numeric constants should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 17:42:38 +00:00			`.\" $FreeBSD$`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.\"`
			`.Dd December 23, 1999`
			`.Os`
			`.Dt VOP_GETACL 9`
			`.Sh NAME`
			`.Nm VOP_GETACL`
mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00			`.Nd retrieve access control list for a vnode`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/param.h`
			`.In sys/vnode.h`
			`.In sys/acl.h`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Ft int`
- Fix a number of man pages broken by the KSE merger. 2001-11-20 18:19:19 +00:00			`.Fn VOP_GETACL "struct vnode vp" "acl_type_t type" "struct acl aclp" "struct ucred cred" "struct thread td"`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Sh DESCRIPTION`
			`This vnode call may be used to retrieve the access control list (ACL) from a`
			`file or directory.`
			`.Pp`
			`Its arguments are:`
			`.Bl -tag -width type`
o The revenge of the mdoc(7) police: - These pages abused Ar macro (they should have used Fa). - NULL and other numeric constants should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 17:42:38 +00:00			`.It Fa vp`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`The vnode of the file or directory.`
o The revenge of the mdoc(7) police: - These pages abused Ar macro (they should have used Fa). - NULL and other numeric constants should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 17:42:38 +00:00			`.It Fa type`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`The type of ACL to retrieve.`
o The revenge of the mdoc(7) police: - These pages abused Ar macro (they should have used Fa). - NULL and other numeric constants should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 17:42:38 +00:00			`.It Fa aclp`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`A pointer to an ACL structure to receive the ACL data.`
o The revenge of the mdoc(7) police: - These pages abused Ar macro (they should have used Fa). - NULL and other numeric constants should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 17:42:38 +00:00			`.It Fa cred`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`The user credentials to use in authorizing the request.`
mdoc(7) police: remove whitespace at EOL. 2002-03-28 12:57:48 +00:00			`.It Fa td`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`The thread requesting the ACL.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.El`
			`.Pp`
			`The`
			`.Fa cred`
o The revenge of the mdoc(7) police: - These pages abused Ar macro (they should have used Fa). - NULL and other numeric constants should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 17:42:38 +00:00			`pointer may be`
			`.Dv NULL`
Fix typos. o replace `of possible' with `if possible' o VOP_SETACL(9) is modified to say about `ACL' instead of `extended attributed' o EOPNOTSUPP of VOP_SETEXTATTR(9) is modified to say about VOP_SETEXTATTR(9) instead of VOP_GETEXTATTR(9) Reviewed by: Robert Watson <rwatson@FreeBSD.org>, Chris Costello <chris@calldei.com> 2001-05-07 22:15:18 +00:00			`to indicate that access control checks are not to be performed, if possible.`
o The revenge of the mdoc(7) police: - These pages abused Ar macro (they should have used Fa). - NULL and other numeric constants should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 17:42:38 +00:00			`This cred setting might be used to allow the kernel to authorize ACL`
			`retrieval that the active process might not be permitted to do.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Pp`
			`The vnode ACL interface defines the syntax, and not semantics, of file and`
Mdoc Janitor: * Fix hard sentence breaks in VFS_(9) and VOP_(9) manual pages. 2003-10-23 02:11:14 +00:00			`directory ACL interfaces.`
			`More information about ACL management in kernel may be found in`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Xr acl 9 .`
			`.Sh LOCKS`
o Bring VOP_GETACL(9) and VOP_GETEXTATTR(9) man page "LOCKS" sections in sync with the implementation. Vnode locks are required for these operations, as some underlying implementations will require them. Obtained from: TrustedBSD Project 2000-09-21 18:51:48 +00:00			`The vnode will be locked on entry and should remain locked on return.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Sh RETURN VALUES`
			`If the`
			`.Fa aclp`
Mdoc Janitor: * Fix hard sentence breaks in VFS_(9) and VOP_(9) manual pages. 2003-10-23 02:11:14 +00:00			`pointer will point to a valid ACL, then zero is returned.`
			`Otherwise, an appropriate error code is returned.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Sh ERRORS`
			`.Bl -tag -width Er`
			`.It Bq Er EINVAL`
Style and markup changes only. Capitalize the first letter of the descriptions for the entries in the ERRORS section if they are complete sentences and end the sentences with periods. 2002-09-18 09:34:01 +00:00			`The ACL type passed is invalid for this vnode.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.It Bq Er EACCES`
Convert descriptions in the ERRORS section to full sentences if they were not full sentences, elaborating as necessary. 2002-09-18 22:12:43 +00:00			`The the caller does not have the appropriate privilege.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.It Bq Er ENOMEM`
Convert descriptions in the ERRORS section to full sentences if they were not full sentences, elaborating as necessary. 2002-09-18 22:12:43 +00:00			`Sufficient memory is not available to fulfill the request.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.It Bq Er EOPNOTSUPP`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`The file system does not support`
Style and markup changes only. Capitalize the first letter of the descriptions for the entries in the ERRORS section if they are complete sentences and end the sentences with periods. 2002-09-18 09:34:01 +00:00			`.Fn VOP_GETACL .`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr acl 9 ,`
			`.Xr vnode 9 ,`
			`.Xr VOP_ACLCHECK 9 ,`
			`.Xr VOP_SETACL 9`
			`.Sh AUTHORS`
Use 'manual page' instead of 'man page' for consistency. Approved by: re (hrs) 2005-06-28 20:15:19 +00:00			`This manual page was written by`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.An Robert Watson .`