usr.sbin/jail/jail.8

   1 .\"
   2 .\" Copyright (c) 2000 Robert N. M. Watson
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\"
  27 .\" ----------------------------------------------------------------------------
  28 .\" "THE BEER-WARE LICENSE" (Revision 42):
  29 .\" <phk@FreeBSD.ORG> wrote this file.  As long as you retain this notice you
  30 .\" can do whatever you want with this stuff. If we meet some day, and you think
  31 .\" this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
  32 .\" ----------------------------------------------------------------------------
  33 .\"
  34 .\" $FreeBSD: src/usr.sbin/jail/jail.8,v 1.13.2.15 2003/05/08 13:04:24 maxim Exp $
  35 .\" $DragonFly: src/usr.sbin/jail/jail.8,v 1.3 2004/03/11 12:28:59 hmp Exp $
  36 .\"
  37 .Dd December 12, 2001
  38 .Dt JAIL 8
  39 .Os
  40 .Sh NAME
  41 .Nm jail
  42 .Nd "imprison process and its descendants"
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Fl u Ar username
  46 .Ar path hostname ip-number command ...
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 command imprisons a process and all future descendants.
  51 .Pp
  52 The options are as follows:
  53 .Bl -tag -width ".Fl u Ar username"
  54 .It Fl u Ar username
  55 The user name as whom the
  56 .Ar command
  57 should run.
  58 .It Ar path
  59 Directory which is to be the root of the prison.
  60 .It Ar hostname
  61 Hostname of the prison.
  62 .It Ar ip-number
  63 IP number assigned to the prison.
  64 .It Ar command
  65 Pathname of the program which is to be executed.
  66 .El
  67 .Pp
  68 Please see the
  69 .Xr jail 2
  70 man page for further details.
  71 .Sh EXAMPLES
  72 .Ss "Setting up a Jail Directory Tree"
  73 This example shows how to setup a jail directory tree
  74 containing an entire
  75 .Dx
  76 distribution:
  77 .Bd -literal
  78 D=/here/is/the/jail
  79 cd /usr/src
  80 mkdir -p $D
  81 make world DESTDIR=$D
  82 cd etc
  83 make distribution DESTDIR=$D -DNO_MAKEDEV_RUN
  84 cd $D/dev
  85 sh MAKEDEV jail
  86 cd $D
  87 ln -sf dev/null kernel
  88 .Ed
  89 .Pp
  90 In many cases this example would put far more stuff in the jail than is needed.
  91 In the other extreme case a jail might contain only one single file:
  92 the executable to be run in the jail.
  93 .Pp
  94 We recommend experimentation and caution that it is a lot easier to
  95 start with a
  96 .Dq fat
  97 jail and remove things until it stops working,
  98 than it is to start with a
  99 .Dq thin
 100 jail and add things until it works.
 101 .Ss "Setting Up a Jail"
 102 Do what was described in
 103 .Sx "Setting Up a Jail Directory Tree"
 104 to build the jail directory tree.
 105 For the sake of this example, we will
 106 assume you built it in
 107 .Pa /data/jail/192.168.11.100 ,
 108 named for the jailed IP address.
 109 Substitute below as needed with your
 110 own directory, IP address, and hostname.
 111 .Pp
 112 First, you will want to set up your real system's environment to be
 113 .Dq jail-friendly .
 114 For consistency, we will refer to the parent box as the
 115 .Dq "host environment" ,
 116 and to the jailed virtual machine as the
 117 .Dq "jail environment" .
 118 Because jail is implemented using IP aliases, one of the first things to do
 119 is to disable IP services on the host system that listen on all local
 120 IP addresses for a service.
 121 This means changing
 122 .Xr inetd 8
 123 to only listen on the
 124 appropriate IP address, and so forth.
 125 Add the following to
 126 .Pa /etc/rc.conf
 127 in the host environment:
 128 .Bd -literal -offset indent
 129 sendmail_enable="NO"
 130 inetd_flags="-wW -a 192.168.11.23"
 131 portmap_enable="NO"
 132 .Ed
 133 .Pp
 134 .Li 192.168.11.23
 135 is the native IP address for the host system, in this example.
 136 Daemons that run out of
 137 .Xr inetd 8
 138 can be easily set to use only the specified host IP address.
 139 Other daemons
 140 will need to be manually configured\(emfor some this is possible through
 141 the
 142 .Xr rc.conf 5
 143 flags entries, for others it is not possible without munging
 144 the per-application configuration files, or even recompiling.
 145 For those
 146 applications that cannot specify the IP they run on, it is better to disable
 147 them, if possible.
 148 .Pp
 149 A number of daemons ship with the base system that may have problems when
 150 run from outside of a jail in a jail-centric environment.
 151 This includes
 152 .Xr sendmail 8 ,
 153 .Xr named 8 ,
 154 and
 155 .Xr portmap 8 .
 156 While
 157 .Xr sendmail 8
 158 and
 159 .Xr named 8
 160 can be configured to listen only on a specific
 161 IP using their configuration files, in most cases it is easier to simply
 162 run the daemons in jails only, and not in the host environment.
 163 Attempting to serve
 164 NFS from the host environment may also cause confusion, and cannot be
 165 easily reconfigured to use only specific IPs, as some NFS services are
 166 hosted directly from the kernel.
 167 Any third party network software running
 168 in the host environment should also be checked and configured so that it
 169 does not bind all IP addresses, which would result in those services also
 170 appearing to be offered by the jail environments.
 171 .Pp
 172 Once
 173 these daemons have been disabled or fixed in the host environment, it is
 174 best to reboot so that all daemons are in a known state, to reduce the
 175 potential for confusion later (such as finding that when you send mail
 176 to a jail, and its sendmail is down, the mail is delivered to the host,
 177 etc.)
 178 .Pp
 179 Start any jails for the first time without configuring the network
 180 interface so that you can clean it up a little and set up accounts.
 181 As
 182 with any machine (virtual or not) you will need to set a root password, time
 183 zone, etc.
 184 Before beginning, you may want to copy
 185 .Xr sysinstall 8
 186 into the tree so that you can use it to set things up easily.
 187 Do this using:
 188 .Bd -literal -offset indent
 189 mkdir /data/jail/192.168.11.100/stand
 190 cp /stand/sysinstall /data/jail/192.168.11.100/stand
 191 .Ed
 192 .Pp
 193 Now start the jail:
 194 .Pp
 195 .Dl "jail /data/jail/192.168.11.100 testhostname 192.168.11.100 /bin/sh"
 196 .Pp
 197 You will end up with a shell prompt, assuming no errors, within the jail.
 198 You can now run
 199 .Pa /stand/sysinstall
 200 and do the post-install configuration to set various configuration options,
 201 or perform these actions manually by editing
 202 .Pa /etc/rc.conf ,
 203 etc.
 204 .Pp
 205 .Bl -bullet -offset indent -compact
 206 .It
 207 Create an empty
 208 .Pa /etc/fstab
 209 to quell startup warnings about missing fstab
 210 .It
 211 Disable the port mapper
 212 .Pa ( /etc/rc.conf :
 213 .Li portmap_enable="NO" )
 214 .It
 215 Run
 216 .Xr newaliases 1
 217 to quell
 218 .Xr sendmail 8
 219 warnings.
 220 .It
 221 Disable interface configuration to quell startup warnings about
 222 .Xr ifconfig 8
 223 .Pq Li network_interfaces=""
 224 .It
 225 Configure
 226 .Pa /etc/resolv.conf
 227 so that name resolution within the jail will work correctly
 228 .It
 229 Set a root password, probably different from the real host system
 230 .It
 231 Set the timezone
 232 .It
 233 Add accounts for users in the jail environment
 234 .It
 235 Install any packages that you think the environment requires
 236 .El
 237 .Pp
 238 You may also want to perform any package-specific configuration (web servers,
 239 SSH servers, etc), patch up
 240 .Pa /etc/syslog.conf
 241 so it logs as you would like, etc.
 242 .Pp
 243 Exit from the shell, and the jail will be shut down.
 244 .Ss "Starting the Jail"
 245 You are now ready to restart the jail and bring up the environment with
 246 all of its daemons and other programs.
 247 To do this, first bring up the
 248 virtual host interface, and then start the jail's
 249 .Pa /etc/rc
 250 script from within the jail.
 251 .Pp
 252 NOTE: If you plan to allow untrusted users to have root access inside the
 253 jail, you may wish to consider setting the
 254 .Va jail.set_hostname_allowed
 255 to 0.
 256 Please see the management reasons why this is a good idea.
 257 If you do decide to set this variable,
 258 it must be set before starting any jails, and once each boot.
 259 .Bd -literal -offset indent
 260 ifconfig ed0 inet alias 192.168.11.100/32
 261 mount -t procfs proc /data/jail/192.168.11.100/proc
 262 jail /data/jail/192.168.11.100 testhostname 192.168.11.100 \\
 263         /bin/sh /etc/rc
 264 .Ed
 265 .Pp
 266 A few warnings will be produced, because most
 267 .Xr sysctl 8
 268 configuration variables cannot be set from within the jail, as they are
 269 global across all jails and the host environment.
 270 However, it should all
 271 work properly.
 272 You should be able to see
 273 .Xr inetd 8 ,
 274 .Xr syslogd 8 ,
 275 and other processes running within the jail using
 276 .Xr ps 1 ,
 277 with the
 278 .Ql J
 279 flag appearing beside jailed processes.
 280 You should also be able to
 281 .Xr telnet 1
 282 to the hostname or IP address of the jailed environment, and log
 283 in using the accounts you created previously.
 284 .Ss "Managing the Jail"
 285 Normal machine shutdown commands, such as
 286 .Xr halt 8 ,
 287 .Xr reboot 8 ,
 288 and
 289 .Xr shutdown 8 ,
 290 cannot be used successfully within the jail.
 291 To kill all processes in a
 292 jail, you may log into the jail and, as root, use one of the following
 293 commands, depending on what you want to accomplish:
 294 .Pp
 295 .Bd -literal -offset indent
 296 kill -TERM -1
 297 kill -KILL -1
 298 .Ed
 299 .Pp
 300 This will send the
 301 .Dv SIGTERM
 302 or
 303 .Dv SIGKILL
 304 signals to all processes in the jail from within the jail.
 305 Depending on
 306 the intended use of the jail, you may also want to run
 307 .Pa /etc/rc.shutdown
 308 from within the jail.
 309 Currently there is no way to insert new processes
 310 into a jail, so you must first log into the jail before performing these
 311 actions.
 312 .Pp
 313 To kill processes from outside the jail, you must individually identify the
 314 PID of each process to be killed.
 315 The
 316 .Pa /proc/ Ns Ar pid Ns Pa /status
 317 file contains, as its last field, the hostname of the jail in which the
 318 process runs, or
 319 .Dq Li -
 320 to indicate that the process is not running within a jail.
 321 The
 322 .Xr ps 1
 323 command also shows a
 324 .Ql J
 325 flag for processes in a jail.
 326 However, the hostname for a jail may be, by
 327 default, modified from within the jail, so the
 328 .Pa /proc
 329 status entry is unreliable by default.
 330 To disable the setting of the hostname
 331 from within a jail, set the
 332 .Va jail.set_hostname_allowed
 333 sysctl variable in the host environment to 0, which will affect all jails.
 334 You can have this sysctl set on each boot using
 335 .Xr sysctl.conf 5 .
 336 Just add the following line to
 337 .Pa /etc/sysctl.conf :
 338 .Pp
 339 .Dl jail.set_hostname_allowed=0
 340 .Pp
 341 In a future version of
 342 .Dx ,
 343 the mechanisms for managing jails may be
 344 more refined.
 345 .Ss "Sysctl MIB Entries"
 346 Certain aspects of the jail containments environment may be modified from
 347 the host environment using
 348 .Xr sysctl 8
 349 MIB variables.
 350 Currently, these variables affect all jails on the system, although in
 351 the future this functionality may be finer grained.
 352 .Bl -tag -width XXX
 353 .It Va jail.set_hostname_allowed
 354 This MIB entry determines whether or not processes within a jail are
 355 allowed to change their hostname via
 356 .Xr hostname 1
 357 or
 358 .Xr sethostname 3 .
 359 In the current jail implementation, the ability to set the hostname from
 360 within the jail can impact management tools relying on the accuracy of jail
 361 information in
 362 .Pa /proc .
 363 As such, this should be disabled in environments where privileged access to
 364 jails is given out to untrusted parties.
 365 .It Va jail.socket_unixiproute_only
 366 The jail functionality binds an IPv4 address to each jail, and limits
 367 access to other network addresses in the IPv4 space that may be available
 368 in the host environment.
 369 However, jail is not currently able to limit access to other network
 370 protocol stacks that have not had jail functionality added to them.
 371 As such, by default, processes within jails may only access protocols
 372 in the following domains:
 373 .Dv PF_LOCAL , PF_INET ,
 374 and
 375 .Dv PF_ROUTE ,
 376 permitting them access to
 377 .Ux
 378 domain sockets,
 379 IPv4 addresses, and routing sockets.
 380 To enable access to other domains, this MIB variable may be set to
 381 0.
 382 .It Va jail.sysvipc_allowed
 383 This MIB entry determines whether or not processes within a jail have access
 384 to System V IPC primitives.
 385 In the current jail implementation, System V primitives share a single
 386 namespace across the host and jail environments, meaning that processes
 387 within a jail would be able to communicate with (and potentially interfere
 388 with) processes outside of the jail, and in other jails.
 389 As such, this functionality is disabled by default, but can be enabled
 390 by setting this MIB entry to 1.
 391 .El
 392 .Sh SEE ALSO
 393 .Xr newaliases 1 ,
 394 .Xr ps 1 ,
 395 .Xr chroot 2 ,
 396 .Xr jail 2 ,
 397 .Xr procfs 5 ,
 398 .Xr rc.conf 5 ,
 399 .Xr sysctl.conf 5 ,
 400 .Xr halt 8 ,
 401 .Xr inetd 8 ,
 402 .Xr named 8 ,
 403 .Xr portmap 8 ,
 404 .Xr reboot 8 ,
 405 .Xr sendmail 8 ,
 406 .Xr shutdown 8 ,
 407 .Xr sysctl 8 ,
 408 .Xr syslogd 8
 409 .Sh HISTORY
 410 The
 411 .Nm
 412 command appeared in
 413 .Fx 4.0 .
 414 .Sh AUTHORS
 415 .An -nosplit
 416 The jail feature was written by
 417 .An Poul-Henning Kamp
 418 for R&D Associates
 419 .Pa http://www.rndassociates.com/
 420 who contributed it to
 421 .Fx .
 422 .Pp
 423 .An Robert Watson
 424 wrote the extended documentation, found a few bugs, added
 425 a few new features, and cleaned up the userland jail environment.
 426 .Sh BUGS
 427 Jail currently lacks strong management functionality, such as the ability
 428 to deliver signals to all processes in a jail, and to allow access to
 429 specific jail information via
 430 .Xr ps 1
 431 as opposed to
 432 .Xr procfs 5 .
 433 Similarly, it might be a good idea to add an
 434 address alias flag such that daemons listening on all IPs
 435 .Pq Dv INADDR_ANY
 436 will not bind on that address, which would facilitate building a safe
 437 host environment such that host daemons do not impose on services offered
 438 from within jails.
 439 Currently, the simplist answer is to minimize services
 440 offered on the host, possibly limiting it to services offered from
 441 .Xr inetd 8
 442 which is easily configurable.