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 .\"       $DragonFly: src/share/man/man9/VOP_ACLCHECK.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
  28 .\"
  29 .Dd December 23, 1999
  30 .Os
  31 .Dt VOP_ACLCHECK 9
  32 .Sh NAME
  33 .Nm VOP_ACLCHECK
  34 .Nd check an access control list for a vnode
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .In sys/acl.h
  39 .Ft int
  40 .Fn VOP_ACLCHECK "struct vnode *vp" "acl_type_t type" "struct acl *aclp" "struct ucred *cred" "struct proc *p"
  41 .Sh DESCRIPTION
  42 This vnode call may be used to determine the validity of a particular access
  43 control list (ACL) for a particular file or directory.
  44 .Pp
  45 Its arguments are:
  46 .Bl -tag -width type
  47 .It Ar vp
  48 the vnode of the file or directory
  49 .It Ar type
  50 the type of ACL to check
  51 .It Ar aclp
  52 a pointer to an ACL structure from which to retrieve the ACL data
  53 .It Ar cred
  54 the user credentials to use in authorizing the request
  55 .It Ar p
  56 the process checking the ACL
  57 .El
  58 .Pp
  59 The
  60 .Fa cred
  61 pointer may be NULL to indicate that access control checks are not to be
  62 performed, if possible.  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.  More information about ACL management in kernel
  68 may be found in
  69 .Xr acl 9 .
  70 .Sh LOCKS
  71 No locks are required to call this vnode method, and any locks held on
  72 entry will be held on exit.
  73 .Sh RETURN VALUES
  74 If the
  75 .Fa aclp
  76 pointer points to a valid ACL of type
  77 .Fa type
  78 for the object
  79 .Fa vp ,
  80 then zero is returned.  Otherwise, an appropriate error code is returned.
  81 .Sh ERRORS
  82 .Bl -tag -width Er
  83 .It Bq Er EINVAL
  84 The ACL type passed is invalid for this vnode, or the ACL data is invalid
  85 .It Bq Er EACCES
  86 Permission denied
  87 .It Bq Er ENOMEM
  88 Insufficient memory available to fulfill request
  89 .It Bq Er EOPNOTSUPP
  90 The file system does not support VOP_ACLCHECK
  91 .El
  92 .Sh SEE ALSO
  93 .Xr acl 9 ,
  94 .Xr vnode 9 ,
  95 .Xr VOP_GETACL 9 ,
  96 .Xr VOP_SETACL 9
  97 .Sh AUTHORS
  98 This man page was written by
  99 .An Robert Watson .