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