share/man/man9/VOP_ACLCHECK.9

   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_ACLCHECK 9
  31 .Sh NAME
  32 .Nm VOP_ACLCHECK
  33 .Nd check an access control list for a vnode
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In sys/vnode.h
  37 .In sys/acl.h
  38 .Ft int
  39 .Fn VOP_ACLCHECK "struct vnode *vp" "acl_type_t type" "struct acl *aclp" "struct ucred *cred" "struct thread *td"
  40 .Sh DESCRIPTION
  41 This vnode call may be used to determine the validity of a particular access
  42 control list (ACL) for a particular file or directory.
  43 .Pp
  44 Its arguments are:
  45 .Bl -tag -width type
  46 .It Fa vp
  47 The vnode of the file or directory.
  48 .It Fa type
  49 The type of ACL to check.
  50 .It Fa aclp
  51 A pointer to an ACL structure from which to retrieve the ACL data.
  52 .It Fa cred
  53 The user credentials to use in authorizing the request.
  54 .It Fa td
  55 The thread checking the ACL.
  56 .El
  57 .Pp
  58 The
  59 .Fa cred
  60 pointer may be NULL to indicate that access control checks are not to be
  61 performed, if possible.
  62 This cred setting might be used to allow the
  63 kernel to authorize ACL verification that the active process might not be
  64 permitted to do.
  65 .Pp
  66 The vnode ACL interface defines the syntax, and not semantics, of file and
  67 directory ACL interfaces.
  68 More information about ACL management in kernel
  69 may be found in
  70 .Xr acl 9 .
  71 .Sh LOCKS
  72 No locks are required to call this vnode method, and any locks held on
  73 entry will be held on exit.
  74 .Sh RETURN VALUES
  75 If the
  76 .Fa aclp
  77 pointer points to a valid ACL of type
  78 .Fa type
  79 for the object
  80 .Fa vp ,
  81 then zero is returned.
  82 Otherwise, an appropriate error code is returned.
  83 .Sh ERRORS
  84 .Bl -tag -width Er
  85 .It Bq Er EINVAL
  86 The ACL type passed is invalid for this vnode, or the ACL data is invalid.
  87 .It Bq Er EACCES
  88 The file or directory ACL does not permit access.
  89 .It Bq Er ENOMEM
  90 Sufficient memory is not available to fulfill the request.
  91 .It Bq Er EOPNOTSUPP
  92 The file system does not support
  93 .Fn VOP_ACLCHECK .
  94 .El
  95 .Sh SEE ALSO
  96 .Xr acl 9 ,
  97 .Xr vnode 9 ,
  98 .Xr VOP_GETACL 9 ,
  99 .Xr VOP_SETACL 9
 100 .Sh AUTHORS
 101 This manual page was written by
 102 .An Robert Watson .