]> CyberLeo.Net >> Repos - FreeBSD/releng/9.2.git/blob - usr.sbin/jail/jail.8
- Copy stable/9 to releng/9.2 as part of the 9.2-RELEASE cycle.
[FreeBSD/releng/9.2.git] / usr.sbin / jail / jail.8
1 .\" Copyright (c) 2000, 2003 Robert N. M. Watson
2 .\" Copyright (c) 2008-2012 James Gritton
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 .\" $FreeBSD$
27 .\"
28 .Dd May 23, 2012
29 .Dt JAIL 8
30 .Os
31 .Sh NAME
32 .Nm jail
33 .Nd "manage system jails"
34 .Sh SYNOPSIS
35 .Nm
36 .Op Fl dhilqv
37 .Op Fl J Ar jid_file
38 .Op Fl u Ar username
39 .Op Fl U Ar username
40 .Op Fl cmr
41 .Ar param Ns = Ns Ar value ...
42 .Op Cm command Ns = Ns Ar command ...
43 .Nm
44 .Op Fl dqv
45 .Op Fl f Ar conf_file
46 .Op Fl p Ar limit
47 .Op Fl cmr
48 .Op Ar jail
49 .Nm
50 .Op Fl qv
51 .Op Fl f Ar conf_file
52 .Op Fl rR
53 .Op Cm * | Ar jail ...
54 .Nm
55 .Op Fl dhilqv
56 .Op Fl J Ar jid_file
57 .Op Fl u Ar username
58 .Op Fl U Ar username
59 .Op Fl n Ar jailname
60 .Op Fl s Ar securelevel
61 .Op Ar path hostname [ Ar ip Ns [ Ns Ar ,... Ns ]] Ar command ...
62 .Sh DESCRIPTION
63 The
64 .Nm
65 utility creates new jails, or modifies or removes existing jails.
66 A jail is specified via parameters on the command line, or in the
67 .Xr jail.conf 5
68 file.
69 .Pp
70 At least one of the options
71 .Fl c ,
72 .Fl m
73 or
74 .Fl r
75 must be specified.
76 These options are used alone or in combination describe the operation to
77 perform:
78 .Bl -tag -width indent
79 .It Fl c
80 Create a new jail.
81 The jail
82 .Va jid
83 and
84 .Va name
85 parameters (if specified) on the command line,
86 or any jails
87 must not refer to an existing jail.
88 .It Fl m
89 Modify an existing jail.
90 One of the
91 .Va jid
92 or
93 .Va name
94 parameters must exist and refer to an existing jail.
95 Some parameters may not be changed on a running jail.
96 .It Fl r
97 Remove the
98 .Ar jail
99 specified by jid or name.
100 All jailed processes are killed, and all children of this jail are also
101 removed.
102 .It Fl rc
103 Restart an existing jail.
104 The jail is first removed and then re-created, as if
105 .Dq Nm Fl c
106 and
107 .Dq Nm Fl r
108 were run in succession.
109 .It Fl cm
110 Create a jail if it does not exist, or modify the jail if it does exist.
111 .It Fl mr
112 Modify an existing jail.
113 The jail may be restarted if necessary to modify parameters than could
114 not otherwise be changed.
115 .It Fl cmr
116 Create a jail if it doesn't exist, or modify (and possibly restart) the
117 jail if it does exist.
118 .El
119 .Pp
120 Other available options are:
121 .Bl -tag -width indent
122 .It Fl d
123 Allow making changes to a dying jail, equivalent to the
124 .Va allow.dying
125 parameter.
126 .It Fl f Ar conf_file
127 Use configuration file
128 .Ar conf_file
129 instead of the default
130 .Pa /etc/jail.conf .
131 .It Fl h
132 Resolve the
133 .Va host.hostname
134 parameter (or
135 .Va hostname )
136 and add all IP addresses returned by the resolver
137 to the list of addresses for this prison.
138 This is equivalent to the
139 .Va ip_hostname
140 parameter.
141 .It Fl i
142 Output (only) the jail identifier of the newly created jail(s).
143 This implies the
144 .Fl q
145 option.
146 .It Fl J Ar jid_file
147 Write a
148 .Ar jid_file
149 file, containing parameters used to start the jail.
150 .It Fl l
151 Run commands in a clean environment.
152 This is deprecated and is equivalent to the exec.clean parameter.
153 .It Fl n Ar jailname
154 Set the jail's name.
155 This is deprecated and is equivalent to the
156 .Va name
157 parameter.
158 .It Fl p Ar limit
159 Limit the number of commands from
160 .Va  exec.*
161 that can run simultaneously.
162 .It Fl q
163 Suppress the message printed whenever a jail is created, modified or removed.
164 Only error messages will be printed.
165 .It Fl R
166 A variation of the
167 .Fl r
168 option that removes an existing jail without using the configuration file.
169 No removal-related parameters for this jail will be used - the jail will
170 simply be removed.
171 .It Fl s Ar securelevel
172 Set the
173 .Va kern.securelevel
174 MIB entry to the specified value inside the newly created jail.
175 This is deprecated and is equivalent to the
176 .Va securelevel
177 parameter.
178 .It Fl u Ar username
179 The user name from host environment as whom jailed commands should run.
180 This is deprecated and is equivalent to the
181 .Va exec.jail_user
182 and
183 .Va exec.system_jail_user
184 parameters.
185 .It Fl U Ar username
186 The user name from jailed environment as whom jailed commands should run.
187 This is deprecated and is equivalent to the
188 .Va exec.jail_user
189 parameter.
190 .It Fl v
191 Print a message on every operation, such as running commands and
192 mounting filesystems.
193 .El
194 .Pp
195 If no arguments are given after the options, the operation (except
196 remove) will be performed on all jails specified in the
197 .Xr jail.conf 5
198 file.
199 A single argument of a jail name will operate only on the specified jail.
200 The
201 .Fl r
202 and
203 .Fl R
204 options can also remove running jails that aren't in the
205 .Xr jail.conf 5
206 file, specified by name or jid.
207 .Pp
208 An argument of
209 .Dq *
210 is a wildcard that will operate on all jails, regardless of whether
211 they appear in
212 .Xr jail.conf 5 ;
213 this is the surest way for
214 .Fl r
215 to remove all jails.
216 If hierarchical jails exist, a partial-matching wildcard definition may
217 be specified.
218 For example, an argument of
219 .Dq foo.*
220 would apply to jails with names like
221 .Dq foo.bar
222 and
223 .Dq foo.bar.baz .
224 .Pp
225 A jail may be specified with parameters directly on the command line.
226 In this case, the
227 .Xr jail.conf 5
228 file will not be used.
229 For backward compatibility, the command line may also have four fixed
230 parameters, without names:
231 .Ar path ,
232 .Ar hostname ,
233 .Ar ip ,
234 and
235 .Ar command .
236 This mode will always create a new jail, and the
237 .Fl c
238 and
239 .Fl m
240 options don't apply (and must not exist).
241 .Ss Jail Parameters
242 Parameters in the
243 .Xr jail.conf 5
244 file, or on the command line, are generally in
245 .Dq name=value
246 form.
247 Some parameters are boolean, and do not have a value but are set by the
248 name alone with or without a
249 .Dq no
250 prefix, e.g.
251 .Va persist
252 or
253 .Va nopersist .
254 They can also be given the values
255 .Dq true
256 and
257 .Dq false .
258 Other parameters may have more than one value, specified as a
259 comma-separated list or with
260 .Dq +=
261 in the configuration file (see
262 .Xr jail.conf 5
263 for details).
264 .Pp
265 The
266 .Nm
267 utility recognizes two classes of parameters.  There are the true jail
268 parameters that are passed to the kernel when the jail is created,
269 can be seen with
270 .Xr jls 8 ,
271 and can (usually) be changed with
272 .Dq Nm Fl m .
273 Then there are pseudo-parameters that are only used by
274 .Nm
275 itself.
276 .Pp
277 Jails have a set a core parameters, and kernel modules can add their own
278 jail parameters.
279 The current set of available parameters can be retrieved via
280 .Dq Nm sysctl Fl d Va security.jail.param .
281 Any parameters not set will be given default values, often based on the
282 current environment.
283 The core parameters are:
284 .Bl -tag -width indent
285 .It Va jid
286 The jail identifier.
287 This will be assigned automatically to a new jail (or can be explicitly
288 set), and can be used to identify the jail for later modification, or
289 for such commands as
290 .Xr jls 8
291 or
292 .Xr jexec 8 .
293 .It Va name
294 The jail name.
295 This is an arbitrary string that identifies a jail (except it may not
296 contain a
297 .Sq \&. ) .
298 Like the
299 .Va jid ,
300 it can be passed to later
301 .Nm
302 commands, or to
303 .Xr jls 8
304 or
305 .Xr jexec 8 .
306 If no
307 .Va name
308 is supplied, a default is assumed that is the same as the
309 .Va jid .
310 The
311 .Va name
312 parameter is implied by the
313 .Xr jail.conf 5
314 file format, and need not be explicitly set when using the configuration
315 file.
316 .It Va path
317 The directory which is to be the root of the prison.
318 Any commands run inside the prison, either by
319 .Nm
320 or from
321 .Xr jexec 8 ,
322 are run from this directory.
323 .It Va ip4.addr
324 A list of IPv4 addresses assigned to the prison.
325 If this is set, the jail is restricted to using only these addresses.
326 Any attempts to use other addresses fail, and attempts to use wildcard
327 addresses silently use the jailed address instead.
328 For IPv4 the first address given will be kept used as the source address
329 in case source address selection on unbound sockets cannot find a better
330 match.
331 It is only possible to start multiple jails with the same IP address,
332 if none of the jails has more than this single overlapping IP address
333 assigned to itself.
334 .It Va ip4.saddrsel
335 A boolean option to change the formerly mentioned behaviour and disable
336 IPv4 source address selection for the prison in favour of the primary
337 IPv4 address of the jail.
338 Source address selection is enabled by default for all jails and the
339 .Va ip4.nosaddrsel
340 setting of a parent jail is not inherited for any child jails.
341 .It Va ip4
342 Control the availability of IPv4 addresses.
343 Possible values are
344 .Dq inherit
345 to allow unrestricted access to all system addresses,
346 .Dq new
347 to restrict addresses via
348 .Va ip4.addr
349 above, and
350 .Dq disable
351 to stop the jail from using IPv4 entirely.
352 Setting the
353 .Va ip4.addr
354 parameter implies a value of
355 .Dq new .
356 .It Va ip6.addr , Va ip6.saddrsel , Va ip6
357 A set of IPv6 options for the prison, the counterparts to
358 .Va ip4.addr ,
359 .Va ip4.saddrsel
360 and
361 .Va ip4
362 above.
363 .It vnet
364 Create the prison with its own virtual network stack,
365 with its own network interfaces, addresses, routing table, etc.
366 The kernel must have been compiled with the
367 .Sy VIMAGE option
368 for this to be available.
369 Possible values are
370 .Dq inherit
371 to use the system network stack, possibly with restricted IP addresses,
372 and
373 .Dq new
374 to create a new network stack.
375 .It Va host.hostname
376 The hostname of the prison.
377 Other similar parameters are
378 .Va host.domainname ,
379 .Va host.hostuuid
380 and
381 .Va host.hostid .
382 .It Va host
383 Set the origin of hostname and related information.
384 Possible values are
385 .Dq inherit
386 to use the system information and
387 .Dq new
388 for the jail to use the information from the above fields.
389 Setting any of the above fields implies a value of
390 .Dq new .
391 .It Va securelevel
392 The value of the jail's
393 .Va kern.securelevel
394 sysctl.
395 A jail never has a lower securelevel than the default system, but by
396 setting this parameter it may have a higher one.
397 If the system securelevel is changed, any jail securelevels will be at
398 least as secure.
399 .It Va devfs_ruleset
400 The number of the devfs ruleset that is enforced for mounting devfs in
401 this jail.
402 A value of zero (default) means no ruleset is enforced.
403 Descendant jails inherit the parent jail's devfs ruleset enforcement.
404 Mounting devfs inside a jail is possible only if the
405 .Va allow.mount
406 and
407 .Va allow.mount.devfs
408 permissions are effective and
409 .Va enforce_statfs
410 is set to a value lower than 2.
411 Devfs rules and rulesets cannot be viewed or modified from inside a jail.
412 .Pp
413 NOTE: It is important that only appropriate device nodes in devfs be
414 exposed to a jail; access to disk devices in the jail may permit processes
415 in the jail to bypass the jail sandboxing by modifying files outside of
416 the jail.
417 See
418 .Xr devfs 8
419 for information on how to use devfs rules to limit access to entries
420 in the per-jail devfs.
421 A simple devfs ruleset for jails is available as ruleset #4 in
422 .Pa /etc/defaults/devfs.rules .
423 .It Va children.max
424 The number of child jails allowed to be created by this jail (or by
425 other jails under this jail).
426 This limit is zero by default, indicating the jail is not allowed to
427 create child jails.
428 See the
429 .Sx "Hierarchical Jails"
430 section for more information.
431 .It Va children.cur
432 The number of descendents of this jail, including its own child jails
433 and any jails created under them.
434 .It Va enforce_statfs
435 This determines which information processes in a jail are able to get
436 about mount points.
437 It affects the behaviour of the following syscalls:
438 .Xr statfs 2 ,
439 .Xr fstatfs 2 ,
440 .Xr getfsstat 2
441 and
442 .Xr fhstatfs 2
443 (as well as similar compatibility syscalls).
444 When set to 0, all mount points are available without any restrictions.
445 When set to 1, only mount points below the jail's chroot directory are
446 visible.
447 In addition to that, the path to the jail's chroot directory is removed
448 from the front of their pathnames.
449 When set to 2 (default), above syscalls can operate only on a mount-point
450 where the jail's chroot directory is located.
451 .It Va persist
452 Setting this boolean parameter allows a jail to exist without any
453 processes.
454 Normally, a command is run as part of jail creation, and then the jail
455 is destroyed as its last process exits.
456 A new jail must have either the
457 .Va persist
458 parameter or
459 .Va exec.start
460 or
461 .Va command
462 pseudo-parameter set.
463 .It Va cpuset.id
464 The ID of the cpuset associated with this jail (read-only).
465 .It Va dying
466 This is true if the jail is in the process of shutting down (read-only).
467 .It Va parent
468 The
469 .Va jid
470 of the parent of this jail, or zero if this is a top-level jail
471 (read-only).
472 .It Va allow.*
473 Some restrictions of the jail environment may be set on a per-jail
474 basis.
475 With the exception of
476 .Va allow.set_hostname ,
477 these boolean parameters are off by default.
478 .Bl -tag -width indent
479 .It Va allow.set_hostname
480 The jail's hostname may be changed via
481 .Xr hostname 1
482 or
483 .Xr sethostname 3 .
484 .It Va allow.sysvipc
485 A process within the jail has access to System V IPC primitives.
486 In the current jail implementation, System V primitives share a single
487 namespace across the host and jail environments, meaning that processes
488 within a jail would be able to communicate with (and potentially interfere
489 with) processes outside of the jail, and in other jails.
490 .It Va allow.raw_sockets
491 The prison root is allowed to create raw sockets.
492 Setting this parameter allows utilities like
493 .Xr ping 8
494 and
495 .Xr traceroute 8
496 to operate inside the prison.
497 If this is set, the source IP addresses are enforced to comply
498 with the IP address bound to the jail, regardless of whether or not
499 the
500 .Dv IP_HDRINCL
501 flag has been set on the socket.
502 Since raw sockets can be used to configure and interact with various
503 network subsystems, extra caution should be used where privileged access
504 to jails is given out to untrusted parties.
505 .It Va allow.chflags
506 Normally, privileged users inside a jail are treated as unprivileged by
507 .Xr chflags 2 .
508 When this parameter is set, such users are treated as privileged, and
509 may manipulate system file flags subject to the usual constraints on
510 .Va kern.securelevel .
511 .It Va allow.mount
512 privileged users inside the jail will be able to mount and unmount file
513 system types marked as jail-friendly.
514 The
515 .Xr lsvfs 1
516 command can be used to find file system types available for mount from
517 within a jail.
518 This permission is effective only if
519 .Va enforce_statfs
520 is set to a value lower than 2.
521 .It Va allow.mount.devfs
522 privileged users inside the jail will be able to mount and unmount the
523 devfs file system.
524 This permission is effective only together with
525 .Va allow.mount
526 and if
527 .Va enforce_statfs
528 is set to a value lower than 2.
529 Please consider restricting the devfs ruleset with the
530 .Va devfs_ruleset
531 option.
532 .It Va allow.mount.nullfs
533 privileged users inside the jail will be able to mount and unmount the
534 nullfs file system.
535 This permission is effective only together with
536 .Va allow.mount
537 and if
538 .Va enforce_statfs
539 is set to a value lower than 2.
540 .It Va allow.mount.procfs
541 privileged users inside the jail will be able to mount and unmount the
542 procfs file system.
543 This permission is effective only together with
544 .Va allow.mount
545 and if
546 .Va enforce_statfs
547 is set to a value lower than 2.
548 .It Va allow.mount.zfs
549 privileged users inside the jail will be able to mount and unmount the
550 ZFS file system.
551 This permission is effective only together with
552 .Va allow.mount
553 and if
554 .Va enforce_statfs
555 is set to a value lower than 2.
556 See
557 .Xr zfs 8
558 for information on how to configure the ZFS filesystem to operate from
559 within a jail.
560 .It Va allow.quotas
561 The prison root may administer quotas on the jail's filesystem(s).
562 This includes filesystems that the jail may share with other jails or
563 with non-jailed parts of the system.
564 .It Va allow.socket_af
565 Sockets within a jail are normally restricted to IPv4, IPv6, local
566 (UNIX), and route.  This allows access to other protocol stacks that
567 have not had jail functionality added to them.
568 .El
569 .El
570 .Pp
571 There are pseudo-parameters that aren't passed to the kernel, but are
572 used by
573 .Nm
574 to set up the prison environment, often by running specified commands
575 when jails are created or removed.
576 The
577 .Va exec.*
578 command parameters are
579 .Xr sh 1
580 command lines that are run in either the system or prison environment.
581 They may be given multiple values, which run would the specified
582 commands in sequence.
583 All commands must succeed (return a zero exit status), or the jail will
584 not be created or removed.
585 .Pp
586 The pseudo-parameters are:
587 .Bl -tag -width indent
588 .It Va exec.prestart
589 Command(s) to run in the system environment before a prison is created.
590 .It Va exec.start
591 Command(s) to run in the prison environment when a jail is created.
592 A typical command to run is
593 .Dq sh /etc/rc .
594 .It Va command
595 A synonym for
596 .Va exec.start
597 for use when specifying a prison directly on the command line.
598 Unlike other parameters whose value is a single string,
599 .Va command
600 uses the remainder of the
601 .Nm
602 command line as its own arguments.
603 .It Va exec.poststart
604 Command(s) to run in the system environment after a jail is created,
605 and after any
606 .Va exec.start
607 commands have completed.
608 .It Va exec.prestop
609 Command(s) to run in the system environment before a jail is removed.
610 .It Va exec.stop
611 Command(s) to run in the prison environment before a jail is removed,
612 and after any
613 .Va exec.prestop
614 commands have completed.
615 A typical command to run is
616 .Dq sh /etc/rc.shutdown .
617 .It Va exec.poststop
618 Command(s) to run in the system environment after a jail is removed.
619 .It Va exec.clean
620 Run commands in a clean environment.
621 The environment is discarded except for
622 .Ev HOME , SHELL , TERM
623 and
624 .Ev USER .
625 .Ev HOME
626 and
627 .Ev SHELL
628 are set to the target login's default values.
629 .Ev USER
630 is set to the target login.
631 .Ev TERM
632 is imported from the current environment.
633 The environment variables from the login class capability database for the
634 target login are also set.
635 .It Va exec.jail_user
636 The user to run commands as, when running in the prison environment.
637 The default is to run the commands as the current user.
638 .It Va exec.system_jail_user
639 This boolean option looks for the
640 .Va exec.jail_user
641 in the system
642 .Xr passwd 5
643 file, instead of in the prison's file.
644 .It Va exec.system_user
645 The user to run commands as, when running in the system environment.
646 The default is to run the commands as the current user.
647 .It Va exec.timeout
648 The maximum amount of time to wait for a command to complete.
649 If a command is still running after this many seconds have passed,
650 the jail not be created or removed.
651 .It Va exec.consolelog
652 A file to direct command output (stdout and stderr) to.
653 .It Va exec.fib
654 The FIB (routing table) to set when running commands inside the prison.
655 .It Va stop.timeout
656 The maximum amount of time to wait for a prison's processes to exit
657 after sending them a
658 .Dv SIGTERM
659 signal (which happens after the
660 .Va exec.stop
661 commands have completed).
662 After this many seconds have passed, the prison will be removed, which
663 will kill any remaining processes.
664 If this is set to zero, no
665 .Dv SIGTERM
666 is sent and the prison is immediately removed.
667 The default is 10 seconds.
668 .It Va interface
669 A network interface to add the prison's IP addresses
670 .Va ( ip4.addr
671 and
672 .Va ip6.addr )
673 to.
674 An alias for each address will be added to the interface before the
675 prison is created, and will be removed from the interface after the
676 prison is removed.
677 .It Op Va ip4.addr
678 In addition to the IP addresses that are passed to the kernel, and
679 interface and/or a netmask may also be specified, in the form
680 .Dq Ar interface Ns | Ns Ar ip-address Ns / Ns Ar netmask .
681 If an interface is given before the IP address, an alias for the address
682 will be added to that interface, as it is with the
683 .Va interface
684 parameter.  If a netmask in either dotted-quad or CIDR form is given
685 after IP address, it will be used when adding the IP alias.
686 .It Op Va ip6.addr
687 In addition to the IP addresses that are passed to the kernel,
688 and interface and/or a prefix may also be specified, in the form
689 .Dq Ar interface Ns | Ns Ar ip-address Ns / Ns Ar prefix .
690 .It Va vnet.interface
691 A network interface to give to a vnet-enabled jail after is it created.
692 The interface will automatically be returned when the jail is removed.
693 .It Va ip_hostname
694 Resolve the
695 .Va host.hostname
696 parameter and add all IP addresses returned by the resolver
697 to the list of addresses
698 .Va ( ip4.addr
699 or
700 .Va ip6.addr )
701 for this prison.
702 This may affect default address selection for outgoing IPv4 connections
703 of prisons.
704 The address first returned by the resolver for each address family
705 will be used as primary address.
706 .It Va mount
707 A filesystem to mount before creating the jail (and to unmount after
708 removing it), given as a single
709 .Xr fstab 5
710 line.
711 .It Va mount.fstab
712 An
713 .Xr fstab 5
714 format file containing filesystems to mount before creating a jail.
715 .It Va mount.devfs
716 Mount a
717 .Xr devfs
718 filesystem on the chrooted /dev directory, and apply the ruleset in the
719 .Va devfs_ruleset
720 parameter (or a default of ruleset 4: devfsrules_jail)
721 to restrict the devices visible inside the prison.
722 .It Va allow.dying
723 Allow making changes to a
724 .Va dying
725 jail.
726 .It Va depend
727 Specify a jail (or jails) that this jail depends on.
728 Any such jails must be fully created, up to the last
729 .Va exec.poststart
730 command, before any action will taken to create this jail.
731 When jails are removed the opposite is true:
732 this jail must be fully removed, up to the last
733 .Va exec.poststop
734 command, before the jail(s) it depends on are stopped.
735 .El
736 .Sh EXAMPLES
737 Jails are typically set up using one of two philosophies: either to
738 constrain a specific application (possibly running with privilege), or
739 to create a
740 .Dq "virtual system image"
741 running a variety of daemons and services.
742 In both cases, a fairly complete file system install of
743 .Fx
744 is
745 required, so as to provide the necessary command line tools, daemons,
746 libraries, application configuration files, etc.
747 However, for a virtual server configuration, a fair amount of
748 additional work is required so as to configure the
749 .Dq boot
750 process.
751 This manual page documents the configuration steps necessary to support
752 either of these steps, although the configuration steps may be
753 refined based on local requirements.
754 .Ss "Setting up a Jail Directory Tree"
755 To set up a jail directory tree containing an entire
756 .Fx
757 distribution, the following
758 .Xr sh 1
759 command script can be used:
760 .Bd -literal
761 D=/here/is/the/jail
762 cd /usr/src
763 mkdir -p $D
764 make world DESTDIR=$D
765 make distribution DESTDIR=$D
766 .Ed
767 .Pp
768 In many cases this example would put far more in the jail than needed.
769 In the other extreme case a jail might contain only one file:
770 the executable to be run in the jail.
771 .Pp
772 We recommend experimentation and caution that it is a lot easier to
773 start with a
774 .Dq fat
775 jail and remove things until it stops working,
776 than it is to start with a
777 .Dq thin
778 jail and add things until it works.
779 .Ss "Setting Up a Jail"
780 Do what was described in
781 .Sx "Setting Up a Jail Directory Tree"
782 to build the jail directory tree.
783 For the sake of this example, we will
784 assume you built it in
785 .Pa /data/jail/testjail ,
786 for a jail named
787 .Dq testjail .
788 Substitute below as needed with your
789 own directory, IP address, and hostname.
790 .Ss "Setting up the Host Environment"
791 First, you will want to set up your real system's environment to be
792 .Dq jail-friendly .
793 For consistency, we will refer to the parent box as the
794 .Dq "host environment" ,
795 and to the jailed virtual machine as the
796 .Dq "jail environment" .
797 Since jail is implemented using IP aliases, one of the first things to do
798 is to disable IP services on the host system that listen on all local
799 IP addresses for a service.
800 If a network service is present in the host environment that binds all
801 available IP addresses rather than specific IP addresses, it may service
802 requests sent to jail IP addresses if the jail did not bind the port.
803 This means changing
804 .Xr inetd 8
805 to only listen on the
806 appropriate IP address, and so forth.
807 Add the following to
808 .Pa /etc/rc.conf
809 in the host environment:
810 .Bd -literal -offset indent
811 sendmail_enable="NO"
812 inetd_flags="-wW -a 192.0.2.23"
813 rpcbind_enable="NO"
814 .Ed
815 .Pp
816 .Li 192.0.2.23
817 is the native IP address for the host system, in this example.
818 Daemons that run out of
819 .Xr inetd 8
820 can be easily set to use only the specified host IP address.
821 Other daemons
822 will need to be manually configured\(emfor some this is possible through
823 the
824 .Xr rc.conf 5
825 flags entries; for others it is necessary to modify per-application
826 configuration files, or to recompile the applications.
827 The following frequently deployed services must have their individual
828 configuration files modified to limit the application to listening
829 to a specific IP address:
830 .Pp
831 To configure
832 .Xr sshd 8 ,
833 it is necessary to modify
834 .Pa /etc/ssh/sshd_config .
835 .Pp
836 To configure
837 .Xr sendmail 8 ,
838 it is necessary to modify
839 .Pa /etc/mail/sendmail.cf .
840 .Pp
841 For
842 .Xr named 8 ,
843 it is necessary to modify
844 .Pa /etc/namedb/named.conf .
845 .Pp
846 In addition, a number of services must be recompiled in order to run
847 them in the host environment.
848 This includes most applications providing services using
849 .Xr rpc 3 ,
850 such as
851 .Xr rpcbind 8 ,
852 .Xr nfsd 8 ,
853 and
854 .Xr mountd 8 .
855 In general, applications for which it is not possible to specify which
856 IP address to bind should not be run in the host environment unless they
857 should also service requests sent to jail IP addresses.
858 Attempting to serve
859 NFS from the host environment may also cause confusion, and cannot be
860 easily reconfigured to use only specific IPs, as some NFS services are
861 hosted directly from the kernel.
862 Any third-party network software running
863 in the host environment should also be checked and configured so that it
864 does not bind all IP addresses, which would result in those services' also
865 appearing to be offered by the jail environments.
866 .Pp
867 Once
868 these daemons have been disabled or fixed in the host environment, it is
869 best to reboot so that all daemons are in a known state, to reduce the
870 potential for confusion later (such as finding that when you send mail
871 to a jail, and its sendmail is down, the mail is delivered to the host,
872 etc.).
873 .Ss "Configuring the Jail"
874 Start any jail for the first time without configuring the network
875 interface so that you can clean it up a little and set up accounts.
876 As
877 with any machine (virtual or not) you will need to set a root password, time
878 zone, etc.
879 Some of these steps apply only if you intend to run a full virtual server
880 inside the jail; others apply both for constraining a particular application
881 or for running a virtual server.
882 .Pp
883 Start a shell in the jail:
884 .Bd -literal -offset indent
885 jail -c path=/data/jail/testjail mount.devfs host.hostname=testhostname \\
886         ip4.addr=192.0.2.100 command=/bin/sh
887 .Ed
888 .Pp
889 Assuming no errors, you will end up with a shell prompt within the jail.
890 You can now run
891 .Pa /usr/sbin/sysinstall
892 and do the post-install configuration to set various configuration options,
893 or perform these actions manually by editing
894 .Pa /etc/rc.conf ,
895 etc.
896 .Pp
897 .Bl -bullet -offset indent -compact
898 .It
899 Configure
900 .Pa /etc/resolv.conf
901 so that name resolution within the jail will work correctly
902 .It
903 Run
904 .Xr newaliases 1
905 to quell
906 .Xr sendmail 8
907 warnings.
908 .It
909 Set a root password, probably different from the real host system
910 .It
911 Set the timezone
912 .It
913 Add accounts for users in the jail environment
914 .It
915 Install any packages the environment requires
916 .El
917 .Pp
918 You may also want to perform any package-specific configuration (web servers,
919 SSH servers, etc), patch up
920 .Pa /etc/syslog.conf
921 so it logs as you would like, etc.
922 If you are not using a virtual server, you may wish to modify
923 .Xr syslogd 8
924 in the host environment to listen on the syslog socket in the jail
925 environment; in this example, the syslog socket would be stored in
926 .Pa /data/jail/testjail/var/run/log .
927 .Pp
928 Exit from the shell, and the jail will be shut down.
929 .Ss "Starting the Jail"
930 You are now ready to restart the jail and bring up the environment with
931 all of its daemons and other programs.
932 Create an entry for the jail in
933 .Pa /etc/jail.conf :
934 .Bd -literal -offset indent
935 testjail {
936         path = /tmp/jail/testjail;
937         mount.devfs;
938         host.hostname = testhostname;
939         ip4.addr = 192.0.2.100;
940         interface = ed0;
941         exec.start = "/bin/sh /etc/rc";
942         exec.stop = "/bin/sh /etc/rc.shutdown";
943 }
944 .Ed
945 .Pp
946 To start a virtual server environment,
947 .Pa /etc/rc
948 is run to launch various daemons and services, and
949 .Pa /etc/rc.shutdown
950 is run to shut them down when the jail is removed.
951 If you are running a single application in the jail,
952 substitute the command used to start the application for
953 .Dq /bin/sh /etc/rc ;
954 there may be some script available to cleanly shut down the application,
955 or it may be sufficient to go without a stop command, and have
956 .Nm
957 send
958 .Dv SIGTERM
959 to the application.
960 .Pp
961 Start the jail by running:
962 .Bd -literal -offset indent
963 jail -c testjail
964 .Ed
965 .Pp
966 A few warnings may be produced; however, it should all work properly.
967 You should be able to see
968 .Xr inetd 8 ,
969 .Xr syslogd 8 ,
970 and other processes running within the jail using
971 .Xr ps 1 ,
972 with the
973 .Ql J
974 flag appearing beside jailed processes.
975 To see an active list of jails, use the
976 .Xr jls 8
977 utility.
978 You should also be able to
979 .Xr telnet 1
980 to the hostname or IP address of the jailed environment, and log
981 in using the accounts you created previously.
982 .Pp
983 It is possible to have jails started at boot time.
984 Please refer to the
985 .Dq jail_*
986 variables in
987 .Xr rc.conf 5
988 for more information.
989 .Ss "Managing the Jail"
990 Normal machine shutdown commands, such as
991 .Xr halt 8 ,
992 .Xr reboot 8 ,
993 and
994 .Xr shutdown 8 ,
995 cannot be used successfully within the jail.
996 To kill all processes from within a jail, you may use one of the
997 following commands, depending on what you want to accomplish:
998 .Bd -literal -offset indent
999 kill -TERM -1
1000 kill -KILL -1
1001 .Ed
1002 .Pp
1003 This will send the
1004 .Dv SIGTERM
1005 or
1006 .Dv SIGKILL
1007 signals to all processes in the jail - be careful not to run this from
1008 the host environment!
1009 Once all of the jail's processes have died, unless the jail was created
1010 with the
1011 .Va persist
1012 parameter, the jail will be removed.
1013 Depending on
1014 the intended use of the jail, you may also want to run
1015 .Pa /etc/rc.shutdown
1016 from within the jail.
1017 .Pp
1018 To shut down the jail from the outside, simply remove it with
1019 .Nm
1020 .Ar -r ,
1021 which will run any commands specified by
1022 .Va exec.stop ,
1023 and then send
1024 .Dv SIGTERM
1025 and eventually
1026 .Dv SIGKILL
1027 to any remaining jailed processes.
1028 .Pp
1029 The
1030 .Pa /proc/ Ns Ar pid Ns Pa /status
1031 file contains, as its last field, the name of the jail in which the
1032 process runs, or
1033 .Dq Li -
1034 to indicate that the process is not running within a jail.
1035 The
1036 .Xr ps 1
1037 command also shows a
1038 .Ql J
1039 flag for processes in a jail.
1040 .Pp
1041 You can also list/kill processes based on their jail ID.
1042 To show processes and their jail ID, use the following command:
1043 .Pp
1044 .Dl "ps ax -o pid,jid,args"
1045 .Pp
1046 To show and then kill processes in jail number 3 use the following commands:
1047 .Bd -literal -offset indent
1048 pgrep -lfj 3
1049 pkill -j 3
1050 .Ed
1051 or:
1052 .Pp
1053 .Dl "killall -j 3"
1054 .Ss "Jails and File Systems"
1055 It is not possible to
1056 .Xr mount 8
1057 or
1058 .Xr umount 8
1059 any file system inside a jail unless the file system is marked
1060 jail-friendly, the jail's
1061 .Va allow.mount
1062 parameter is set and the jail's
1063 .Va enforce_statfs
1064 parameter is lower than 2.
1065 .Pp
1066 Multiple jails sharing the same file system can influence each other.
1067 For example a user in one jail can fill the file system also
1068 leaving no space for processes in the other jail.
1069 Trying to use
1070 .Xr quota 1
1071 to prevent this will not work either as the file system quotas
1072 are not aware of jails but only look at the user and group IDs.
1073 This means the same user ID in two jails share the same file
1074 system quota.
1075 One would need to use one file system per jail to make this work.
1076 .Ss "Sysctl MIB Entries"
1077 The read-only entry
1078 .Va security.jail.jailed
1079 can be used to determine if a process is running inside a jail (value
1080 is one) or not (value is zero).
1081 .Pp
1082 The variable
1083 .Va security.jail.max_af_ips
1084 determines how may address per address family a prison may have.
1085 The default is 255.
1086 .Pp
1087 Some MIB variables have per-jail settings.
1088 Changes to these variables by a jailed process do not effect the host
1089 environment, only the jail environment.
1090 These variables are
1091 .Va kern.securelevel ,
1092 .Va kern.hostname ,
1093 .Va kern.domainname ,
1094 .Va kern.hostid ,
1095 and
1096 .Va kern.hostuuid .
1097 .Ss "Hierarchical Jails"
1098 By setting a jail's
1099 .Va children.max
1100 parameter, processes within a jail may be able to create jails of their own.
1101 These child jails are kept in a hierarchy, with jails only able to see and/or
1102 modify the jails they created (or those jails' children).
1103 Each jail has a read-only
1104 .Va parent
1105 parameter, containing the
1106 .Va jid
1107 of the jail that created it; a
1108 .Va jid
1109 of 0 indicates the jail is a child of the current jail (or is a top-level
1110 jail if the current process isn't jailed).
1111 .Pp
1112 Jailed processes are not allowed to confer greater permissions than they
1113 themselves are given, e.g. if a jail is created with
1114 .Va allow.nomount ,
1115 it is not able to create a jail with
1116 .Va allow.mount
1117 set.
1118 Similarly, such restrictions as
1119 .Va ip4.addr
1120 and
1121 .Va securelevel
1122 may not be bypassed in child jails.
1123 .Pp
1124 A child jail may in turn create its own child jails if its own
1125 .Va children.max
1126 parameter is set (remember it is zero by default).
1127 These jails are visible to and can be modified by their parent and all
1128 ancestors.
1129 .Pp
1130 Jail names reflect this hierarchy, with a full name being an MIB-type string
1131 separated by dots.
1132 For example, if a base system process creates a jail
1133 .Dq foo ,
1134 and a process under that jail creates another jail
1135 .Dq bar ,
1136 then the second jail will be seen as
1137 .Dq foo.bar
1138 in the base system (though it is only seen as
1139 .Dq bar
1140 to any processes inside jail
1141 .Dq foo ) .
1142 Jids on the other hand exist in a single space, and each jail must have a
1143 unique jid.
1144 .Pp
1145 Like the names, a child jail's
1146 .Va path
1147 appears relative to its creator's own
1148 .Va path .
1149 This is by virtue of the child jail being created in the chrooted
1150 environment of the first jail.
1151 .Sh SEE ALSO
1152 .Xr killall 1 ,
1153 .Xr lsvfs 1 ,
1154 .Xr newaliases 1 ,
1155 .Xr pgrep 1 ,
1156 .Xr pkill 1 ,
1157 .Xr ps 1 ,
1158 .Xr quota 1 ,
1159 .Xr jail_set 2 ,
1160 .Xr jail.conf 5 ,
1161 .Xr procfs 5 ,
1162 .Xr rc.conf 5 ,
1163 .Xr sysctl.conf 5 ,
1164 .Xr chroot 8 ,
1165 .Xr devfs 8 ,
1166 .Xr halt 8 ,
1167 .Xr inetd 8 ,
1168 .Xr jexec 8 ,
1169 .Xr jls 8 ,
1170 .Xr mount 8 ,
1171 .Xr named 8 ,
1172 .Xr reboot 8 ,
1173 .Xr rpcbind 8 ,
1174 .Xr sendmail 8 ,
1175 .Xr shutdown 8 ,
1176 .Xr sysctl 8 ,
1177 .Xr syslogd 8 ,
1178 .Xr umount 8
1179 .Sh HISTORY
1180 The
1181 .Nm
1182 utility appeared in
1183 .Fx 4.0 .
1184 Hierarchical/extensible jails were introduced in
1185 .Fx 8.0 .
1186 The configuration file was introduced in
1187 .Fx 9.1 .
1188 .Sh AUTHORS
1189 .An -nosplit
1190 The jail feature was written by
1191 .An Poul-Henning Kamp
1192 for R&D Associates
1193 .Pa http://www.rndassociates.com/
1194 who contributed it to
1195 .Fx .
1196 .Pp
1197 .An Robert Watson
1198 wrote the extended documentation, found a few bugs, added
1199 a few new features, and cleaned up the userland jail environment.
1200 .Pp
1201 .An Bjoern A. Zeeb
1202 added multi-IP jail support for IPv4 and IPv6 based on a patch
1203 originally done by
1204 .An Pawel Jakub Dawidek
1205 for IPv4.
1206 .Pp
1207 .An James Gritton
1208 added the extensible jail parameters, hierarchical jails,
1209 and the configuration file.
1210 .Sh BUGS
1211 It might be a good idea to add an
1212 address alias flag such that daemons listening on all IPs
1213 .Pq Dv INADDR_ANY
1214 will not bind on that address, which would facilitate building a safe
1215 host environment such that host daemons do not impose on services offered
1216 from within jails.
1217 Currently, the simplest answer is to minimize services
1218 offered on the host, possibly limiting it to services offered from
1219 .Xr inetd 8
1220 which is easily configurable.
1221 .Sh NOTES
1222 Great care should be taken when managing directories visible within the jail.
1223 For example, if a jailed process has its current working directory set to a
1224 directory that is moved out of the jail's chroot, then the process may gain
1225 access to the file space outside of the jail.
1226 It is recommended that directories always be copied, rather than moved, out
1227 of a jail.