share/man/man9/prison_check.9

   1 .\"
   2 .\" Copyright (c) 2003 Joseph Koshy <jkoshy@FreeBSD.org>
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" This program is free software.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd December 11, 2003
  31 .Dt PRISON_CHECK 9
  32 .Os
  33 .Sh NAME
  34 .Nm prison_check
  35 .Nd determine if two credentials belong to the same jail
  36 .Sh SYNOPSIS
  37 .In sys/jail.h
  38 .Ft int
  39 .Fn prison_check "struct ucred *cred1" "struct ucred *cred2"
  40 .Sh DESCRIPTION
  41 This function can be used to determine if the two credentials
  42 .Fa cred1
  43 and
  44 .Fa cred2
  45 belong to the same jail.
  46 .Sh RETURN VALUES
  47 The
  48 .Fn prison_check
  49 function
  50 returns
  51 .Er ESRCH
  52 if
  53 .Fa cred1
  54 has been jailed, and
  55 .Fa cred1
  56 and
  57 .Fa cred2
  58 do not belong to the same jail.
  59 In all other cases,
  60 .Fn prison_check
  61 returns zero.
  62 .Sh SEE ALSO
  63 .Xr jail 2