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