lib/libc/gen/cap_sandboxed.3

   1 .\"
   2 .\" Copyright (c) 2012 The FreeBSD Foundation
   3 .\" All rights reserved.
   4 .\"
   5 .\" This documentation was written by Pawel Jakub Dawidek under sponsorship
   6 .\" from the FreeBSD Foundation.
   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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 27, 2014
  32 .Dt CAP_SANDBOXED 3
  33 .Os
  34 .Sh NAME
  35 .Nm cap_sandboxed
  36 .Nd Check if in a capability mode sandbox
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/capsicum.h
  41 .In stdbool.h
  42 .Ft bool
  43 .Fn cap_sandboxed "void"
  44 .Sh DESCRIPTION
  45 .Fn cap_sandboxed
  46 returns
  47 .Va true
  48 if the process is in a capability mode sandbox or
  49 .Va false
  50 if it is not.
  51 This function is a more handy alternative to the
  52 .Xr cap_getmode 2
  53 system call as it always succeeds, so there is no need for error checking.
  54 If the support for capability mode is not compiled into the kernel,
  55 .Fn cap_sandboxed
  56 will always return
  57 .Va false .
  58 .Sh RETURN VALUES
  59 Function
  60 .Fn cap_sandboxed
  61 is always successful and will return either
  62 .Va true
  63 or
  64 .Va false .
  65 .Sh SEE ALSO
  66 .Xr cap_enter 2 ,
  67 .Xr capsicum 4
  68 .Sh AUTHORS
  69 This function was implemented and manual page was written by
  70 .An Pawel Jakub Dawidek Aq pawel@dawidek.net
  71 under sponsorship of the FreeBSD Foundation.