xref: /freebsd/lib/libc/gen/cap_sandboxed.3 (revision 81ad626541db97eb356e2c1d4a20eb2a26a766ab)
1.\"
2.\" Copyright (c) 2012 The FreeBSD Foundation
3.\"
4.\" This documentation was written by Pawel Jakub Dawidek under sponsorship
5.\" from the FreeBSD Foundation.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd May 5, 2020
31.Dt CAP_SANDBOXED 3
32.Os
33.Sh NAME
34.Nm cap_sandboxed
35.Nd Check if in a capability mode sandbox
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/capsicum.h
40.In stdbool.h
41.Ft bool
42.Fn cap_sandboxed "void"
43.Sh DESCRIPTION
44.Fn cap_sandboxed
45returns
46.Va true
47if the process is in a capability mode sandbox or
48.Va false
49if it is not.
50This function is a more handy alternative to the
51.Xr cap_getmode 2
52system call as it always succeeds, so there is no need for error checking.
53If the support for capability mode is not compiled into the kernel,
54.Fn cap_sandboxed
55will always return
56.Va false .
57.Sh RETURN VALUES
58Function
59.Fn cap_sandboxed
60is always successful and will return either
61.Va true
62or
63.Va false .
64.Sh SEE ALSO
65.Xr cap_enter 2 ,
66.Xr capsicum 4
67.Sh HISTORY
68The
69.Fn cap_sandboxed
70function first appeared in
71.Fx 9.2 .
72.Sh AUTHORS
73This function was implemented and manual page was written by
74.An Pawel Jakub Dawidek Aq Mt pawel@dawidek.net
75under sponsorship of the FreeBSD Foundation.
76