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.Dd August 18, 2023 29.Dt PRISON_CHECK 9 30.Os 31.Sh NAME 32.Nm prison_check 33.Nd determine if subjects may see entities according to jail restrictions 34.Sh SYNOPSIS 35.In sys/jail.h 36.Ft int 37.Fn prison_check "struct ucred *cred1" "struct ucred *cred2" 38.Sh DESCRIPTION 39This function determines if a subject with credentials 40.Fa cred1 41is denied access to subjects or objects with credentials 42.Fa cred2 43according to the policy that a subject can see subjects or objects in its own 44jail or any sub-jail of it. 45.Sh RETURN VALUES 46The 47.Fn prison_check 48function 49returns 50.Er ESRCH 51if 52.Fa cred2 53is not in the same jail or a sub-jail of that of 54.Fa cred1 . 55In all other cases, 56.Fn prison_check 57returns zero. 58.Sh SEE ALSO 59.Xr jail 2 60