share/man/man9/vfs_suser.9

   1 .\"
   2 .\" Copyright (c) 2004 Alfred Perlstein
   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 ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  19 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  21 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  22 .\" 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 April 2, 2004
  29 .Dt VFS_SUSER 9
  30 .Os
  31 .Sh NAME
  32 .Nm vfs_suser
  33 .Nd check if credentials have superuser privileges for a mount point
  34 .Sh SYNOPSIS
  35 .In sys/param.h
  36 .In sys/systm.h
  37 .In sys/mount.h
  38 .Ft int
  39 .Fn vfs_suser "struct mount *mp" "struct thread *td"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vfs_suser
  43 function checks if the credentials given include superuser powers
  44 for the given mount point.
  45 It will check to see if the thread
  46 passed in has the same credentials as the user that mounted the
  47 file system.
  48 If so, it returns 0, otherwise it returns what
  49 .Xr suser 9
  50 would have returned.
  51 .Sh RETURN VALUES
  52 The
  53 .Fn vfs_suser
  54 function returns 0 if the user has superuser powers and
  55 .Er EPERM
  56 otherwise.
  57 This is the
  58 .Em reverse logic
  59 of some other implementations of
  60 .Fn suser
  61 in which a TRUE response indicates superuser powers.
  62 .Sh SEE ALSO
  63 .Xr chroot 2 ,
  64 .Xr jail 2 ,
  65 .Xr suser 9
  66 .Sh HISTORY
  67 The
  68 .Fn vfs_suser
  69 function was introduced in
  70 .Fx 5.2 .
  71 .Sh AUTHORS
  72 This manual page was written by
  73 .An Alfred Perlstein .