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