lib/libc/gen/cap_sandboxed.3

   1 .\" Copyright (c) 2012 The FreeBSD Foundation
   2 .\" All rights reserved.
   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 September 18, 2012
  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/capability.h
  40 .In stdbool.h
  41 .Ft bool
  42 .Fn cap_sandboxed "void"
  43 .Sh DESCRIPTION
  44 .Fn cap_sandboxed
  45 returns
  46 .Va true
  47 if the process is in a capability mode sandbox or
  48 .Va false
  49 if it is not.
  50 This function is a more handy alternative to the
  51 .Xr cap_getmode 2
  52 system call as it always succeeds, so there is no need for error checking.
  53 If the support for capability mode is not compiled into the kernel,
  54 .Fn cap_sandboxed
  55 will always return
  56 .Va false .
  57 .Sh RETURN VALUES
  58 Function
  59 .Fn cap_sandboxed
  60 is always successful and will return either
  61 .Va true
  62 or
  63 .Va false .
  64 .Sh SEE ALSO
  65 .Xr cap_enter 2 ,
  66 .Xr capsicum 4
  67 .Sh AUTHORS
  68 This function was implemented and manual page was written by
  69 .An Pawel Jakub Dawidek Aq pawel@dawidek.net
  70 under sponsorship of the FreeBSD Foundation.