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