]> CyberLeo.Net >> Repos - FreeBSD/releng/10.3.git/blob - usr.sbin/jail/jail.8
- Copy stable/10@296371 to releng/10.3 in preparation for 10.3-RC1
[FreeBSD/releng/10.3.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 July 6, 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.linprocfs
567 privileged users inside the jail will be able to mount and unmount the
568 linprocfs 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.linsysfs
575 privileged users inside the jail will be able to mount and unmount the
576 linsysfs 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 .It Va allow.mount.tmpfs
583 privileged users inside the jail will be able to mount and unmount the
584 tmpfs file system.
585 This permission is effective only together with
586 .Va allow.mount
587 and only when
588 .Va enforce_statfs
589 is set to a value lower than 2.
590 .It Va allow.mount.zfs
591 privileged users inside the jail will be able to mount and unmount the
592 ZFS file system.
593 This permission is effective only together with
594 .Va allow.mount
595 and only when
596 .Va enforce_statfs
597 is set to a value lower than 2.
598 See
599 .Xr zfs 8
600 for information on how to configure the ZFS filesystem to operate from
601 within a jail.
602 .It Va allow.quotas
603 The jail root may administer quotas on the jail's filesystem(s).
604 This includes filesystems that the jail may share with other jails or
605 with non-jailed parts of the system.
606 .It Va allow.socket_af
607 Sockets within a jail are normally restricted to IPv4, IPv6, local
608 (UNIX), and route.  This allows access to other protocol stacks that
609 have not had jail functionality added to them.
610 .El
611 .El
612 .Pp
613 There are pseudo-parameters that are not passed to the kernel, but are
614 used by
615 .Nm
616 to set up the jail environment, often by running specified commands
617 when jails are created or removed.
618 The
619 .Va exec.*
620 command parameters are
621 .Xr sh 1
622 command lines that are run in either the system or jail environment.
623 They may be given multiple values, which would run the specified
624 commands in sequence.
625 All commands must succeed (return a zero exit status), or the jail will
626 not be created or removed, as appropriate.
627 .Pp
628 The pseudo-parameters are:
629 .Bl -tag -width indent
630 .It Va exec.prestart
631 Command(s) to run in the system environment before a jail is created.
632 .It Va exec.start
633 Command(s) to run in the jail environment when a jail is created.
634 A typical command to run is
635 .Dq sh /etc/rc .
636 .It Va command
637 A synonym for
638 .Va exec.start
639 for use when specifying a jail directly on the command line.
640 Unlike other parameters whose value is a single string,
641 .Va command
642 uses the remainder of the
643 .Nm
644 command line as its own arguments.
645 .It Va exec.poststart
646 Command(s) to run in the system environment after a jail is created,
647 and after any
648 .Va exec.start
649 commands have completed.
650 .It Va exec.prestop
651 Command(s) to run in the system environment before a jail is removed.
652 .It Va exec.stop
653 Command(s) to run in the jail environment before a jail is removed,
654 and after any
655 .Va exec.prestop
656 commands have completed.
657 A typical command to run is
658 .Dq sh /etc/rc.shutdown .
659 .It Va exec.poststop
660 Command(s) to run in the system environment after a jail is removed.
661 .It Va exec.clean
662 Run commands in a clean environment.
663 The environment is discarded except for
664 .Ev HOME , SHELL , TERM
665 and
666 .Ev USER .
667 .Ev HOME
668 and
669 .Ev SHELL
670 are set to the target login's default values.
671 .Ev USER
672 is set to the target login.
673 .Ev TERM
674 is imported from the current environment.
675 The environment variables from the login class capability database for the
676 target login are also set.
677 .It Va exec.jail_user
678 The user to run commands as, when running in the jail environment.
679 The default is to run the commands as the current user.
680 .It Va exec.system_jail_user
681 This boolean option looks for the
682 .Va exec.jail_user
683 in the system
684 .Xr passwd 5
685 file, instead of in the jail's file.
686 .It Va exec.system_user
687 The user to run commands as, when running in the system environment.
688 The default is to run the commands as the current user.
689 .It Va exec.timeout
690 The maximum amount of time to wait for a command to complete, in
691 seconds.
692 If a command is still running after this timeout has passed,
693 the jail will not be created or removed, as appropriate.
694 .It Va exec.consolelog
695 A file to direct command output (stdout and stderr) to.
696 .It Va exec.fib
697 The FIB (routing table) to set when running commands inside the jail.
698 .It Va stop.timeout
699 The maximum amount of time to wait for a jail's processes to exit
700 after sending them a
701 .Dv SIGTERM
702 signal (which happens after the
703 .Va exec.stop
704 commands have completed).
705 After this many seconds have passed, the jail will be removed, which
706 will kill any remaining processes.
707 If this is set to zero, no
708 .Dv SIGTERM
709 is sent and the jail is immediately removed.
710 The default is 10 seconds.
711 .It Va interface
712 A network interface to add the jail's IP addresses
713 .Va ( ip4.addr
714 and
715 .Va ip6.addr )
716 to.
717 An alias for each address will be added to the interface before the
718 jail is created, and will be removed from the interface after the
719 jail is removed.
720 .It Va ip4.addr
721 In addition to the IP addresses that are passed to the kernel, an
722 interface, netmask and additional paramters (as supported by
723 .Xr ifconfig 8 Ns )
724 may also be specified, in the form
725 .Dq Ar interface Ns | Ns Ar ip-address Ns / Ns Ar netmask param ... .
726 If an interface is given before the IP address, an alias for the address
727 will be added to that interface, as it is with the
728 .Va interface
729 parameter.
730 If a netmask in either dotted-quad or CIDR form is given
731 after an IP address, it will be used when adding the IP alias.
732 If additional parameters are specified then they will also be used when
733 adding the IP alias.
734 .It Va ip6.addr
735 In addition to the IP addresses that are passed to the kernel,
736 an interface, prefix and additional parameters (as supported by
737 .Xr ifconfig 8 Ns )
738 may also be specified, in the form
739 .Dq Ar interface Ns | Ns Ar ip-address Ns / Ns Ar prefix param ... .
740 .It Va vnet.interface
741 A network interface to give to a vnet-enabled jail after is it created.
742 The interface will automatically be released when the jail is removed.
743 .It Va ip_hostname
744 Resolve the
745 .Va host.hostname
746 parameter and add all IP addresses returned by the resolver
747 to the list of addresses
748 .Po Va ip4.addr
749 or
750 .Va ip6.addr Pc
751 for this jail.
752 This may affect default address selection for outgoing IPv4 connections
753 from jails.
754 The address first returned by the resolver for each address family
755 will be used as the primary address.
756 .It Va mount
757 A filesystem to mount before creating the jail (and to unmount after
758 removing it), given as a single
759 .Xr fstab 5
760 line.
761 .It Va mount.fstab
762 An
763 .Xr fstab 5
764 format file containing filesystems to mount before creating a jail.
765 .It Va mount.devfs
766 Mount a
767 .Xr devfs 5
768 filesystem on the chrooted
769 .Pa /dev
770 directory, and apply the ruleset in the
771 .Va devfs_ruleset
772 parameter (or a default of ruleset 4: devfsrules_jail)
773 to restrict the devices visible inside the jail.
774 .It Va mount.fdescfs
775 Mount a
776 .Xr fdescfs 5
777 filesystem on the chrooted
778 .Pa /dev/fd
779 directory.
780 .It Va mount.procfs
781 Mount a
782 .Xr procfs 5
783 filesystem on the chrooted
784 .Pa /proc
785 directory.
786 .It Va allow.dying
787 Allow making changes to a
788 .Va dying
789 jail.
790 .It Va depend
791 Specify a jail (or jails) that this jail depends on.
792 Any such jails must be fully created, up to the last
793 .Va exec.poststart
794 command, before any action will taken to create this jail.
795 When jails are removed the opposite is true:
796 this jail must be fully removed, up to the last
797 .Va exec.poststop
798 command, before the jail(s) it depends on are stopped.
799 .El
800 .Sh EXAMPLES
801 Jails are typically set up using one of two philosophies: either to
802 constrain a specific application (possibly running with privilege), or
803 to create a
804 .Dq "virtual system image"
805 running a variety of daemons and services.
806 In both cases, a fairly complete file system install of
807 .Fx
808 is
809 required, so as to provide the necessary command line tools, daemons,
810 libraries, application configuration files, etc.
811 However, for a virtual server configuration, a fair amount of
812 additional work is required so as to replace the
813 .Dq boot
814 process.
815 This manual page documents the configuration steps necessary to support
816 either of these steps, although the configuration steps may need to be
817 refined based on local requirements.
818 .Ss "Setting up a Jail Directory Tree"
819 To set up a jail directory tree containing an entire
820 .Fx
821 distribution, the following
822 .Xr sh 1
823 command script can be used:
824 .Bd -literal
825 D=/here/is/the/jail
826 cd /usr/src
827 mkdir -p $D
828 make world DESTDIR=$D
829 make distribution DESTDIR=$D
830 .Ed
831 .Pp
832 In many cases this example would put far more in the jail than needed.
833 In the other extreme case a jail might contain only one file:
834 the executable to be run in the jail.
835 .Pp
836 We recommend experimentation, and caution that it is a lot easier to
837 start with a
838 .Dq fat
839 jail and remove things until it stops working,
840 than it is to start with a
841 .Dq thin
842 jail and add things until it works.
843 .Ss "Setting Up a Jail"
844 Do what was described in
845 .Sx "Setting Up a Jail Directory Tree"
846 to build the jail directory tree.
847 For the sake of this example, we will
848 assume you built it in
849 .Pa /data/jail/testjail ,
850 for a jail named
851 .Dq testjail .
852 Substitute below as needed with your
853 own directory, IP address, and hostname.
854 .Ss "Setting up the Host Environment"
855 First, set up the real system's environment to be
856 .Dq jail-friendly .
857 For consistency, we will refer to the parent box as the
858 .Dq "host environment" ,
859 and to the jailed virtual machine as the
860 .Dq "jail environment" .
861 Since jails are implemented using IP aliases, one of the first things to do
862 is to disable IP services on the host system that listen on all local
863 IP addresses for a service.
864 If a network service is present in the host environment that binds all
865 available IP addresses rather than specific IP addresses, it may service
866 requests sent to jail IP addresses if the jail did not bind the port.
867 This means changing
868 .Xr inetd 8
869 to only listen on the
870 appropriate IP address, and so forth.
871 Add the following to
872 .Pa /etc/rc.conf
873 in the host environment:
874 .Bd -literal -offset indent
875 sendmail_enable="NO"
876 inetd_flags="-wW -a 192.0.2.23"
877 rpcbind_enable="NO"
878 .Ed
879 .Pp
880 .Li 192.0.2.23
881 is the native IP address for the host system, in this example.
882 Daemons that run out of
883 .Xr inetd 8
884 can be easily configured to use only the specified host IP address.
885 Other daemons
886 will need to be manually configured \(em for some this is possible through
887 .Xr rc.conf 5
888 flags entries; for others it is necessary to modify per-application
889 configuration files, or to recompile the application.
890 The following frequently deployed services must have their individual
891 configuration files modified to limit the application to listening
892 to a specific IP address:
893 .Pp
894 To configure
895 .Xr sshd 8 ,
896 it is necessary to modify
897 .Pa /etc/ssh/sshd_config .
898 .Pp
899 To configure
900 .Xr sendmail 8 ,
901 it is necessary to modify
902 .Pa /etc/mail/sendmail.cf .
903 .Pp
904 For
905 .Xr named 8 ,
906 it is necessary to modify
907 .Pa /etc/namedb/named.conf .
908 .Pp
909 In addition, a number of services must be recompiled in order to run
910 them in the host environment.
911 This includes most applications providing services using
912 .Xr rpc 3 ,
913 such as
914 .Xr rpcbind 8 ,
915 .Xr nfsd 8 ,
916 and
917 .Xr mountd 8 .
918 In general, applications for which it is not possible to specify which
919 IP address to bind should not be run in the host environment unless they
920 should also service requests sent to jail IP addresses.
921 Attempting to serve
922 NFS from the host environment may also cause confusion, and cannot be
923 easily reconfigured to use only specific IPs, as some NFS services are
924 hosted directly from the kernel.
925 Any third-party network software running
926 in the host environment should also be checked and configured so that it
927 does not bind all IP addresses, which would result in those services also
928 appearing to be offered by the jail environments.
929 .Pp
930 Once
931 these daemons have been disabled or fixed in the host environment, it is
932 best to reboot so that all daemons are in a known state, to reduce the
933 potential for confusion later (such as finding that when you send mail
934 to a jail, and its sendmail is down, the mail is delivered to the host,
935 etc.).
936 .Ss "Configuring the Jail"
937 Start any jail for the first time without configuring the network
938 interface so that you can clean it up a little and set up accounts.
939 As
940 with any machine (virtual or not), you will need to set a root password, time
941 zone, etc.
942 Some of these steps apply only if you intend to run a full virtual server
943 inside the jail; others apply both for constraining a particular application
944 or for running a virtual server.
945 .Pp
946 Start a shell in the jail:
947 .Bd -literal -offset indent
948 jail -c path=/data/jail/testjail mount.devfs host.hostname=testhostname \\
949         ip4.addr=192.0.2.100 command=/bin/sh
950 .Ed
951 .Pp
952 Assuming no errors, you will end up with a shell prompt within the jail.
953 You can now run
954 .Pa /usr/sbin/sysinstall
955 and do the post-install configuration to set various configuration options,
956 or perform these actions manually by editing
957 .Pa /etc/rc.conf ,
958 etc.
959 .Pp
960 .Bl -bullet -offset indent -compact
961 .It
962 Configure
963 .Pa /etc/resolv.conf
964 so that name resolution within the jail will work correctly.
965 .It
966 Run
967 .Xr newaliases 1
968 to quell
969 .Xr sendmail 8
970 warnings.
971 .It
972 Set a root password, probably different from the real host system.
973 .It
974 Set the timezone.
975 .It
976 Add accounts for users in the jail environment.
977 .It
978 Install any packages the environment requires.
979 .El
980 .Pp
981 You may also want to perform any package-specific configuration (web servers,
982 SSH servers, etc), patch up
983 .Pa /etc/syslog.conf
984 so it logs as you would like, etc.
985 If you are not using a virtual server, you may wish to modify
986 .Xr syslogd 8
987 in the host environment to listen on the syslog socket in the jail
988 environment; in this example, the syslog socket would be stored in
989 .Pa /data/jail/testjail/var/run/log .
990 .Pp
991 Exit from the shell, and the jail will be shut down.
992 .Ss "Starting the Jail"
993 You are now ready to restart the jail and bring up the environment with
994 all of its daemons and other programs.
995 Create an entry for the jail in
996 .Pa /etc/jail.conf :
997 .Bd -literal -offset indent
998 testjail {
999         path = /tmp/jail/testjail;
1000         mount.devfs;
1001         host.hostname = testhostname;
1002         ip4.addr = 192.0.2.100;
1003         interface = ed0;
1004         exec.start = "/bin/sh /etc/rc";
1005         exec.stop = "/bin/sh /etc/rc.shutdown";
1006 }
1007 .Ed
1008 .Pp
1009 To start a virtual server environment,
1010 .Pa /etc/rc
1011 is run to launch various daemons and services, and
1012 .Pa /etc/rc.shutdown
1013 is run to shut them down when the jail is removed.
1014 If you are running a single application in the jail,
1015 substitute the command used to start the application for
1016 .Dq /bin/sh /etc/rc ;
1017 there may be some script available to cleanly shut down the application,
1018 or it may be sufficient to go without a stop command, and have
1019 .Nm
1020 send
1021 .Dv SIGTERM
1022 to the application.
1023 .Pp
1024 Start the jail by running:
1025 .Bd -literal -offset indent
1026 jail -c testjail
1027 .Ed
1028 .Pp
1029 A few warnings may be produced; however, it should all work properly.
1030 You should be able to see
1031 .Xr inetd 8 ,
1032 .Xr syslogd 8 ,
1033 and other processes running within the jail using
1034 .Xr ps 1 ,
1035 with the
1036 .Ql J
1037 flag appearing beside jailed processes.
1038 To see an active list of jails, use
1039 .Xr jls 8 .
1040 If
1041 .Xr sshd 8
1042 is enabled in the jail environment, you should be able to
1043 .Xr ssh 1
1044 to the hostname or IP address of the jailed environment, and log
1045 in using the accounts you created previously.
1046 .Pp
1047 It is possible to have jails started at boot time.
1048 Please refer to the
1049 .Dq jail_*
1050 variables in
1051 .Xr rc.conf 5
1052 for more information.
1053 .Ss "Managing the Jail"
1054 Normal machine shutdown commands, such as
1055 .Xr halt 8 ,
1056 .Xr reboot 8 ,
1057 and
1058 .Xr shutdown 8 ,
1059 cannot be used successfully within the jail.
1060 To kill all processes from within a jail, you may use one of the
1061 following commands, depending on what you want to accomplish:
1062 .Bd -literal -offset indent
1063 kill -TERM -1
1064 kill -KILL -1
1065 .Ed
1066 .Pp
1067 This will send the
1068 .Dv SIGTERM
1069 or
1070 .Dv SIGKILL
1071 signals to all processes in the jail \(em be careful not to run this from
1072 the host environment!
1073 Once all of the jail's processes have died, unless the jail was created
1074 with the
1075 .Va persist
1076 parameter, the jail will be removed.
1077 Depending on
1078 the intended use of the jail, you may also want to run
1079 .Pa /etc/rc.shutdown
1080 from within the jail.
1081 .Pp
1082 To shut down the jail from the outside, simply remove it with
1083 .Nm
1084 .Ar -r ,
1085 which will run any commands specified by
1086 .Va exec.stop ,
1087 and then send
1088 .Dv SIGTERM
1089 and eventually
1090 .Dv SIGKILL
1091 to any remaining jailed processes.
1092 .Pp
1093 The
1094 .Pa /proc/ Ns Ar pid Ns Pa /status
1095 file contains, as its last field, the name of the jail in which the
1096 process runs, or
1097 .Dq Li -
1098 to indicate that the process is not running within a jail.
1099 The
1100 .Xr ps 1
1101 command also shows a
1102 .Ql J
1103 flag for processes in a jail.
1104 .Pp
1105 You can also list/kill processes based on their jail ID.
1106 To show processes and their jail ID, use the following command:
1107 .Pp
1108 .Dl "ps ax -o pid,jid,args"
1109 .Pp
1110 To show and then kill processes in jail number 3 use the following commands:
1111 .Bd -literal -offset indent
1112 pgrep -lfj 3
1113 pkill -j 3
1114 .Ed
1115 or:
1116 .Pp
1117 .Dl "killall -j 3"
1118 .Ss "Jails and File Systems"
1119 It is not possible to
1120 .Xr mount 8
1121 or
1122 .Xr umount 8
1123 any file system inside a jail unless the file system is marked
1124 jail-friendly, the jail's
1125 .Va allow.mount
1126 parameter is set, and the jail's
1127 .Va enforce_statfs
1128 parameter is lower than 2.
1129 .Pp
1130 Multiple jails sharing the same file system can influence each other.
1131 For example, a user in one jail can fill the file system,
1132 leaving no space for processes in the other jail.
1133 Trying to use
1134 .Xr quota 1
1135 to prevent this will not work either, as the file system quotas
1136 are not aware of jails but only look at the user and group IDs.
1137 This means the same user ID in two jails share a single file
1138 system quota.
1139 One would need to use one file system per jail to make this work.
1140 .Ss "Sysctl MIB Entries"
1141 The read-only entry
1142 .Va security.jail.jailed
1143 can be used to determine if a process is running inside a jail (value
1144 is one) or not (value is zero).
1145 .Pp
1146 The variable
1147 .Va security.jail.max_af_ips
1148 determines how may address per address family a jail may have.
1149 The default is 255.
1150 .Pp
1151 Some MIB variables have per-jail settings.
1152 Changes to these variables by a jailed process do not affect the host
1153 environment, only the jail environment.
1154 These variables are
1155 .Va kern.securelevel ,
1156 .Va kern.hostname ,
1157 .Va kern.domainname ,
1158 .Va kern.hostid ,
1159 and
1160 .Va kern.hostuuid .
1161 .Ss "Hierarchical Jails"
1162 By setting a jail's
1163 .Va children.max
1164 parameter, processes within a jail may be able to create jails of their own.
1165 These child jails are kept in a hierarchy, with jails only able to see and/or
1166 modify the jails they created (or those jails' children).
1167 Each jail has a read-only
1168 .Va parent
1169 parameter, containing the
1170 .Va jid
1171 of the jail that created it; a
1172 .Va jid
1173 of 0 indicates the jail is a child of the current jail (or is a top-level
1174 jail if the current process isn't jailed).
1175 .Pp
1176 Jailed processes are not allowed to confer greater permissions than they
1177 themselves are given, e.g., if a jail is created with
1178 .Va allow.nomount ,
1179 it is not able to create a jail with
1180 .Va allow.mount
1181 set.
1182 Similarly, such restrictions as
1183 .Va ip4.addr
1184 and
1185 .Va securelevel
1186 may not be bypassed in child jails.
1187 .Pp
1188 A child jail may in turn create its own child jails if its own
1189 .Va children.max
1190 parameter is set (remember it is zero by default).
1191 These jails are visible to and can be modified by their parent and all
1192 ancestors.
1193 .Pp
1194 Jail names reflect this hierarchy, with a full name being an MIB-type string
1195 separated by dots.
1196 For example, if a base system process creates a jail
1197 .Dq foo ,
1198 and a process under that jail creates another jail
1199 .Dq bar ,
1200 then the second jail will be seen as
1201 .Dq foo.bar
1202 in the base system (though it is only seen as
1203 .Dq bar
1204 to any processes inside jail
1205 .Dq foo ) .
1206 Jids on the other hand exist in a single space, and each jail must have a
1207 unique jid.
1208 .Pp
1209 Like the names, a child jail's
1210 .Va path
1211 appears relative to its creator's own
1212 .Va path .
1213 This is by virtue of the child jail being created in the chrooted
1214 environment of the first jail.
1215 .Sh SEE ALSO
1216 .Xr killall 1 ,
1217 .Xr lsvfs 1 ,
1218 .Xr newaliases 1 ,
1219 .Xr pgrep 1 ,
1220 .Xr pkill 1 ,
1221 .Xr ps 1 ,
1222 .Xr quota 1 ,
1223 .Xr ifconfig 8 ,
1224 .Xr jail_set 2 ,
1225 .Xr devfs 5 ,
1226 .Xr fdescfs 5 ,
1227 .Xr jail.conf 5 ,
1228 .Xr procfs 5 ,
1229 .Xr linprocfs 5 ,
1230 .Xr linsysfs 5 ,
1231 .Xr rc.conf 5 ,
1232 .Xr sysctl.conf 5 ,
1233 .Xr chroot 8 ,
1234 .Xr devfs 8 ,
1235 .Xr halt 8 ,
1236 .Xr inetd 8 ,
1237 .Xr jexec 8 ,
1238 .Xr jls 8 ,
1239 .Xr mount 8 ,
1240 .Xr named 8 ,
1241 .Xr procfs 5 ,
1242 .Xr reboot 8 ,
1243 .Xr rpcbind 8 ,
1244 .Xr sendmail 8 ,
1245 .Xr shutdown 8 ,
1246 .Xr sysctl 8 ,
1247 .Xr syslogd 8 ,
1248 .Xr umount 8
1249 .Sh HISTORY
1250 The
1251 .Nm
1252 utility appeared in
1253 .Fx 4.0 .
1254 Hierarchical/extensible jails were introduced in
1255 .Fx 8.0 .
1256 The configuration file was introduced in
1257 .Fx 9.1 .
1258 .Sh AUTHORS
1259 .An -nosplit
1260 The jail feature was written by
1261 .An Poul-Henning Kamp
1262 for R&D Associates
1263 .Pa http://www.rndassociates.com/
1264 who contributed it to
1265 .Fx .
1266 .Pp
1267 .An Robert Watson
1268 wrote the extended documentation, found a few bugs, added
1269 a few new features, and cleaned up the userland jail environment.
1270 .Pp
1271 .An Bjoern A. Zeeb
1272 added multi-IP jail support for IPv4 and IPv6 based on a patch
1273 originally done by
1274 .An Pawel Jakub Dawidek
1275 for IPv4.
1276 .Pp
1277 .An James Gritton
1278 added the extensible jail parameters, hierarchical jails,
1279 and the configuration file.
1280 .Sh BUGS
1281 It might be a good idea to add an
1282 address alias flag such that daemons listening on all IPs
1283 .Pq Dv INADDR_ANY
1284 will not bind on that address, which would facilitate building a safe
1285 host environment such that host daemons do not impose on services offered
1286 from within jails.
1287 Currently, the simplest answer is to minimize services
1288 offered on the host, possibly limiting it to services offered from
1289 .Xr inetd 8
1290 which is easily configurable.
1291 .Sh NOTES
1292 Great care should be taken when managing directories visible within the jail.
1293 For example, if a jailed process has its current working directory set to a
1294 directory that is moved out of the jail's chroot, then the process may gain
1295 access to the file space outside of the jail.
1296 It is recommended that directories always be copied, rather than moved, out
1297 of a jail.
1298 .Pp
1299 In addition, there are several ways in which an unprivileged user
1300 outside the jail can cooperate with a privileged user inside the jail
1301 and thereby obtain elevated privileges in the host environment.
1302 Most of these attacks can be mitigated by ensuring that the jail root
1303 is not accessible to unprivileged users in the host environment.
1304 Regardless, as a general rule, untrusted users with privileged access
1305 to a jail should not be given access to the host environment.