share/man/man9/vaccess.9

   1 .\"-
   2 .\" Copyright (c) 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 September 18, 2009
  29 .Dt VACCESS 9
  30 .Os
  31 .Sh NAME
  32 .Nm vaccess
  33 .Nd generate an access control decision using vnode parameters
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In sys/vnode.h
  37 .Ft int
  38 .Fo vaccess
  39 .Fa "enum vtype type"
  40 .Fa "mode_t file_mode"
  41 .Fa "uid_t file_uid"
  42 .Fa "gid_t file_gid"
  43 .Fa "accmode_t accmode"
  44 .Fa "struct ucred *cred"
  45 .Fa "int *privused"
  46 .Fc
  47 .Sh DESCRIPTION
  48 This call implements the logic for the
  49 .Ux
  50 discretionary file security model
  51 common to many file systems in
  52 .Fx .
  53 It accepts the vnodes type
  54 .Fa type ,
  55 permissions via
  56 .Fa file_mode ,
  57 owning UID
  58 .Fa file_uid ,
  59 owning GID
  60 .Fa file_gid ,
  61 desired access mode
  62 .Fa accmode ,
  63 requesting credential
  64 .Fa cred ,
  65 and an optional call-by-reference
  66 .Vt int
  67 pointer returning whether or not
  68 privilege was required for successful evaluation of the call; the
  69 .Fa privused
  70 pointer may be set to
  71 .Dv NULL
  72 by the caller in order not to be informed of
  73 privilege information, or it may point to an integer that will be set to
  74 1 if privilege is used, and 0 otherwise.
  75 .Pp
  76 This call is intended to support implementations of
  77 .Xr VOP_ACCESS 9 ,
  78 which will use their own access methods to retrieve the vnode properties,
  79 and then invoke
  80 .Fn vaccess
  81 in order to perform the actual check.
  82 Implementations of
  83 .Xr VOP_ACCESS 9
  84 may choose to implement additional security mechanisms whose results will
  85 be composed with the return value.
  86 .Pp
  87 The algorithm used by
  88 .Fn vaccess
  89 selects a component of the file permission bits based on comparing the
  90 passed credential, file owner, and file group.
  91 If the credential's effective UID matches the file owner, then the
  92 owner component of the permission bits is selected.
  93 If the UID does not match, then the credential's effective GID, followed
  94 by additional groups, are compared with the file group\[em]if there is
  95 a match, then the group component of the permission bits is selected.
  96 If neither the credential UID or GIDs match the passed file owner and
  97 group, then the other component of the permission bits is selected.
  98 .Pp
  99 Once appropriate protections are selected for the current credential,
 100 the requested access mode, in combination with the vnode type, will be
 101 compared with the discretionary rights available for the credential.
 102 If the rights granted by discretionary protections are insufficient,
 103 then super-user privilege, if available for the credential, will also be
 104 considered.
 105 .Sh RETURN VALUES
 106 .Fn vaccess
 107 will return 0 on success, or a non-zero error value on failure.
 108 .Sh ERRORS
 109 .Bl -tag -width Er
 110 .It Bq Er EACCES
 111 Permission denied.
 112 An attempt was made to access a file in a way forbidden by its file access
 113 permissions.
 114 .It Bq Er EPERM
 115 Operation not permitted.
 116 An attempt was made to perform an operation limited to processes with
 117 appropriate privileges or to the owner of a file or other resource.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr vaccess_acl_nfs4 9 ,
 121 .Xr vaccess_acl_posix1e 9 ,
 122 .Xr vnode 9 ,
 123 .Xr VOP_ACCESS 9
 124 .Sh AUTHORS
 125 This manual page and the current implementation of
 126 .Fn vaccess
 127 were written by
 128 .An Robert Watson .