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