sbin/casperd/casperd.8

   1 .\" Copyright (c) 2013 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 AUTHORS 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 AUTHORS 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 October 26, 2013
  31 .Dt CASPERD 8
  32 .Os
  33 .Sh NAME
  34 .Nm casperd
  35 .Nd "Capability Services friendly daemon"
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl Fhv
  39 .Op Fl l Ar listenqueue
  40 .Op Fl D Ar servconfdir
  41 .Op Fl P Ar pidfile
  42 .Op Fl S Ar sockpath
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 daemon hosts various services that can be accessed through
  47 libcapsicum's capabilities by programs running in sandboxes.
  48 For example it is prohibited to send UDP packets to arbitrary destinations
  49 when operating in capability mode, which makes DNS resolution impossible.
  50 To make it possible the
  51 .Nm
  52 daemon provides the
  53 .Nm system.dns
  54 service that proxies DNS resolution requests through a dedicated,
  55 non-sandboxed process provided by
  56 .Nm .
  57 .Pp
  58 The
  59 .Nm
  60 daemon can be started with the following command line arguments:
  61 .Bl -tag -width ".Fl D Ar servconfdir"
  62 .It Fl D Ar servconfdir
  63 Specify alternative location of the service configuration directory.
  64 The default location is
  65 .Pa /etc/casper/ .
  66 .It Fl F
  67 Start the
  68 .Nm
  69 daemon in the foreground.
  70 By default
  71 .Nm
  72 starts in the background.
  73 .It Fl h
  74 Print the
  75 .Nm
  76 usage message.
  77 .It Fl l Ar listenqueue
  78 Specify depth of socket listen queue for the
  79 .Nm
  80 daemon.
  81 The default queue length is
  82 .Pa SOMAXCONN .
  83 .It Fl P Ar pidfile
  84 Specify alternative location of a file where main process PID will be
  85 stored.
  86 The default location is
  87 .Pa /var/run/casperd.pid .
  88 .It Fl S Ar sockpath
  89 Specify alternative location of the
  90 .Xr unix 4
  91 domain socket used to connect to the
  92 .Nm
  93 daemon.
  94 The default location is
  95 .Pa /var/run/casper .
  96 .It Fl v
  97 Print or log verbose/debugging information.
  98 This option can be specified multiple times to raise the verbosity
  99 level.
 100 .El
 101 .Sh FILES
 102 .Bl -tag -width ".Pa /var/run/casperd.pid" -compact
 103 .It Pa /etc/casper/
 104 The configuration directory for
 105 .Nm
 106 services.
 107 .It Pa /var/run/casper
 108 .Xr unix 4
 109 domain socket used to connect to the
 110 .Nm
 111 daemon.
 112 .It Pa /var/run/casperd.pid
 113 The default location of the
 114 .Nm
 115 PID file.
 116 .El
 117 .Sh EXIT STATUS
 118 The
 119 .Nm
 120 daemon exits 0 on success, and >0 if an error occurs.
 121 .Sh SEE ALSO
 122 .Xr cap_enter 2 ,
 123 .Xr libcapsicum 3 ,
 124 .Xr pidfile 3 ,
 125 .Xr capsicum 4 ,
 126 .Xr unix 4
 127 .Sh AUTHORS
 128 The
 129 .Nm
 130 was implemented by
 131 .An Pawel Jakub Dawidek Aq Mt pawel@dawidek.net
 132 under sponsorship from the FreeBSD Foundation.