share/man/man9/vaccess_acl_nfs4.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_ACL_NFS4 9
  30 .Os
  31 .Sh NAME
  32 .Nm vaccess_acl_nfs4
  33 .Nd generate a NFSv4 ACL access control decision using vnode parameters
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In sys/vnode.h
  37 .In sys/acl.h
  38 .Ft int
  39 .Fo vaccess_acl_nfs4
  40 .Fa "enum vtype type"
  41 .Fa "uid_t file_uid"
  42 .Fa "gid_t file_gid"
  43 .Fa "struct acl *acl"
  44 .Fa "accmode_t accmode"
  45 .Fa "struct ucred *cred"
  46 .Fa "int *privused"
  47 .Fc
  48 .Sh DESCRIPTION
  49 This call implements the logic for the
  50 .Ux
  51 discretionary file security model
  52 with NFSv4 ACL extensions.
  53 It accepts the vnodes type
  54 .Fa type ,
  55 owning UID
  56 .Fa file_uid ,
  57 owning GID
  58 .Fa file_gid ,
  59 access ACL for the file
  60 .Fa acl ,
  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_acl_nfs4
  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_acl_nfs4
  89 is based on the NFSv4 ACL evaluation algorithm, as described in
  90 NFSv4 Minor Version 1, draft-ietf-nfsv4-minorversion1-21.txt.
  91 The algorithm selects a
  92 .Em matching
  93 entry from the access ACL, which may
  94 then be composed with an available ACL mask entry, providing
  95 .Ux
  96 security compatibility.
  97 .Pp
  98 Once appropriate protections are selected for the current credential,
  99 the requested access mode, in combination with the vnode type, will be
 100 compared with the discretionary rights available for the credential.
 101 If the rights granted by discretionary protections are insufficient,
 102 then super-user privilege, if available for the credential, will also be
 103 considered.
 104 .Sh RETURN VALUES
 105 .Fn vaccess_acl_nfs4
 106 will return 0 on success, or a non-zero error value on failure.
 107 .Sh ERRORS
 108 .Bl -tag -width Er
 109 .It Bq Er EACCES
 110 Permission denied.
 111 An attempt was made to access a file in a way forbidden by its file access
 112 permissions.
 113 .It Bq Er EPERM
 114 Operation not permitted.
 115 An attempt was made to perform an operation limited to processes with
 116 appropriate privileges or to the owner of a file or other resource.
 117 .El
 118 .Sh SEE ALSO
 119 .Xr vaccess 9 ,
 120 .Xr vnode 9 ,
 121 .Xr VOP_ACCESS 9
 122 .Sh AUTHORS
 123 Current implementation of
 124 .Fn vaccess_acl_nfs4
 125 was written by
 126 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org .
 127 .Sh BUGS
 128 This manual page should include a full description of the NFSv4 ACL
 129 evaluation algorithm, or cross reference another page that does.