2001-08-25 15:04:23 +00:00
|
|
|
.\"-
|
|
|
|
.\" Copyright (c) 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$
|
|
|
|
.\"
|
2009-09-22 15:15:03 +00:00
|
|
|
.Dd September 18, 2009
|
2001-08-27 13:56:16 +00:00
|
|
|
.Dt VACCESS 9
|
2010-04-14 19:08:06 +00:00
|
|
|
.Os
|
2001-08-25 15:04:23 +00:00
|
|
|
.Sh NAME
|
|
|
|
.Nm vaccess
|
|
|
|
.Nd generate an access control decision using vnode parameters
|
|
|
|
.Sh SYNOPSIS
|
2001-12-26 23:14:04 +00:00
|
|
|
.In sys/param.h
|
2001-08-27 13:56:16 +00:00
|
|
|
.In sys/vnode.h
|
2001-08-25 15:04:23 +00:00
|
|
|
.Ft int
|
2001-08-27 13:56:16 +00:00
|
|
|
.Fo vaccess
|
|
|
|
.Fa "enum vtype type"
|
|
|
|
.Fa "mode_t file_mode"
|
|
|
|
.Fa "uid_t file_uid"
|
|
|
|
.Fa "gid_t file_gid"
|
2008-10-28 13:44:11 +00:00
|
|
|
.Fa "accmode_t accmode"
|
2001-08-27 13:56:16 +00:00
|
|
|
.Fa "struct ucred *cred"
|
|
|
|
.Fa "int *privused"
|
|
|
|
.Fc
|
2001-08-25 15:04:23 +00:00
|
|
|
.Sh DESCRIPTION
|
2001-08-27 13:56:16 +00:00
|
|
|
This call implements the logic for the
|
|
|
|
.Ux
|
|
|
|
discretionary file security model
|
2002-12-12 17:26:04 +00:00
|
|
|
common to many file systems in
|
2001-08-27 13:56:16 +00:00
|
|
|
.Fx .
|
2001-08-25 15:04:23 +00:00
|
|
|
It accepts the vnodes type
|
2001-08-27 13:56:16 +00:00
|
|
|
.Fa type ,
|
2001-08-25 15:19:37 +00:00
|
|
|
permissions via
|
2001-08-27 13:56:16 +00:00
|
|
|
.Fa file_mode ,
|
|
|
|
owning UID
|
2001-08-25 15:04:23 +00:00
|
|
|
.Fa file_uid ,
|
2001-08-27 13:56:16 +00:00
|
|
|
owning GID
|
2001-08-25 15:04:23 +00:00
|
|
|
.Fa file_gid ,
|
|
|
|
desired access mode
|
2008-10-28 13:44:11 +00:00
|
|
|
.Fa accmode ,
|
2001-08-25 15:04:23 +00:00
|
|
|
requesting credential
|
|
|
|
.Fa cred ,
|
2001-08-27 13:56:16 +00:00
|
|
|
and an optional call-by-reference
|
|
|
|
.Vt int
|
|
|
|
pointer returning whether or not
|
2001-08-25 15:04:23 +00:00
|
|
|
privilege was required for successful evaluation of the call; the
|
|
|
|
.Fa privused
|
2001-08-27 13:56:16 +00:00
|
|
|
pointer may be set to
|
|
|
|
.Dv NULL
|
|
|
|
by the caller in order not to be informed of
|
2001-08-25 15:04:23 +00:00
|
|
|
privilege information, or it may point to an integer that will be set to
|
|
|
|
1 if privilege is used, and 0 otherwise.
|
|
|
|
.Pp
|
|
|
|
This call is intended to support implementations of
|
|
|
|
.Xr VOP_ACCESS 9 ,
|
2002-01-09 11:43:48 +00:00
|
|
|
which will use their own access methods to retrieve the vnode properties,
|
2001-08-25 15:04:23 +00:00
|
|
|
and then invoke
|
|
|
|
.Fn vaccess
|
|
|
|
in order to perform the actual check.
|
|
|
|
Implementations of
|
|
|
|
.Xr VOP_ACCESS 9
|
|
|
|
may choose to implement additional security mechanisms whose results will
|
|
|
|
be composed with the return value.
|
|
|
|
.Pp
|
|
|
|
The algorithm used by
|
|
|
|
.Fn vaccess
|
|
|
|
selects a component of the file permission bits based on comparing the
|
|
|
|
passed credential, file owner, and file group.
|
2001-08-27 13:56:16 +00:00
|
|
|
If the credential's effective UID matches the file owner, then the
|
2001-08-25 15:04:23 +00:00
|
|
|
owner component of the permission bits is selected.
|
2001-08-27 13:56:16 +00:00
|
|
|
If the UID does not match, then the credential's effective GID, followed
|
|
|
|
by additional groups, are compared with the file group\[em]if there is
|
2001-08-25 15:04:23 +00:00
|
|
|
a match, then the group component of the permission bits is selected.
|
2001-08-27 13:56:16 +00:00
|
|
|
If neither the credential UID or GIDs match the passed file owner and
|
|
|
|
group, then the other component of the permission bits is selected.
|
2001-08-25 15:04:23 +00:00
|
|
|
.Pp
|
|
|
|
Once appropriate protections are selected for the current credential,
|
|
|
|
the requested access mode, in combination with the vnode type, will be
|
|
|
|
compared with the discretionary rights available for the credential.
|
|
|
|
If the rights granted by discretionary protections are insufficient,
|
|
|
|
then super-user privilege, if available for the credential, will also be
|
|
|
|
considered.
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
.Fn vaccess
|
|
|
|
will return 0 on success, or a non-zero error value on failure.
|
|
|
|
.Sh ERRORS
|
|
|
|
.Bl -tag -width Er
|
|
|
|
.It Bq Er EACCES
|
|
|
|
Permission denied.
|
|
|
|
An attempt was made to access a file in a way forbidden by its file access
|
|
|
|
permissions.
|
|
|
|
.It Bq Er EPERM
|
|
|
|
Operation not permitted.
|
|
|
|
An attempt was made to perform an operation limited to processes with
|
|
|
|
appropriate privileges or to the owner of a file or other resource.
|
|
|
|
.El
|
|
|
|
.Sh SEE ALSO
|
2009-09-22 15:15:03 +00:00
|
|
|
.Xr vaccess_acl_nfs4 9 ,
|
2001-08-27 17:45:06 +00:00
|
|
|
.Xr vaccess_acl_posix1e 9 ,
|
2001-08-25 15:04:23 +00:00
|
|
|
.Xr vnode 9 ,
|
|
|
|
.Xr VOP_ACCESS 9
|
|
|
|
.Sh AUTHORS
|
2005-06-28 20:15:19 +00:00
|
|
|
This manual page and the current implementation of
|
2001-08-25 15:04:23 +00:00
|
|
|
.Fn vaccess
|
|
|
|
were written by
|
|
|
|
.An Robert Watson .
|