xref: /freebsd/share/man/man9/prison_check.9 (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
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.Dd December 11, 2003
30.Os
31.Dt prison_check 9
32.Sh NAME
33.Nm prison_check
34.Nd determine if two credentials belong to the same jail
35.Sh SYNOPSIS
36.In sys/jail.h
37.Ft int
38.Fn prison_check "struct ucred *cred1" "struct ucred *cred2"
39.Sh DESCRIPTION
40This function can be used to determine if the two credentials
41.Fa cred1
42and
43.Fa cred2
44belong to the same jail.
45.Sh RETURN VALUES
46.Fn prison_check
47returns
48.Er ESRCH
49if
50.Fa cred1
51has been jailed, and
52.Fa cred1
53and
54.Fa cred2
55do not belong to the same jail.
56In all other cases,
57.Fn prison_check
58returns zero.
59.Sh SEE ALSO
60.Xr jail 2