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: src/share/man/man9/VOP_ACLCHECK.9,v 1.1.2.3 2001/12/17 11:30:18 ru Exp $
  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 proc *p"
  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 Ar vp
  47 the vnode of the file or directory
  48 .It Ar type
  49 the type of ACL to check
  50 .It Ar aclp
  51 a pointer to an ACL structure from which to retrieve the ACL data
  52 .It Ar cred
  53 the user credentials to use in authorizing the request
  54 .It Ar p
  55 the process 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.  This cred setting might be used to allow the
  62 kernel to authorize ACL verification that the active process might not be
  63 permitted to do.
  64 .Pp
  65 The vnode ACL interface defines the syntax, and not semantics, of file and
  66 directory ACL interfaces.  More information about ACL management in kernel
  67 may be found in
  68 .Xr acl 9 .
  69 .Sh LOCKS
  70 No locks are required to call this vnode method, and any locks held on
  71 entry will be held on exit.
  72 .Sh RETURN VALUES
  73 If the
  74 .Fa aclp
  75 pointer points to a valid ACL of type
  76 .Fa type
  77 for the object
  78 .Fa vp ,
  79 then zero is returned.  Otherwise, an appropriate error code is returned.
  80 .Sh ERRORS
  81 .Bl -tag -width Er
  82 .It Bq Er EINVAL
  83 The ACL type passed is invalid for this vnode, or the ACL data is invalid
  84 .It Bq Er EACCES
  85 Permission denied
  86 .It Bq Er ENOMEM
  87 Insufficient memory available to fulfill request
  88 .It Bq Er EOPNOTSUPP
  89 The file system does not support VOP_ACLCHECK
  90 .El
  91 .Sh SEE ALSO
  92 .Xr acl 9 ,
  93 .Xr vnode 9 ,
  94 .Xr VOP_GETACL 9 ,
  95 .Xr VOP_SETACL 9
  96 .Sh AUTHORS
  97 This man page was written by
  98 .An Robert Watson .