]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.sbin/jail/jail.8
Fix a typo in the examples.
[FreeBSD/FreeBSD.git] / usr.sbin / jail / jail.8
1 .\"
2 .\" Copyright (c) 2000, 2003 Robert N. M. Watson
3 .\" Copyright (c) 2008 James Gritton
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .\"
28 .\" ----------------------------------------------------------------------------
29 .\" "THE BEER-WARE LICENSE" (Revision 42):
30 .\" <phk@FreeBSD.ORG> wrote this file.  As long as you retain this notice you
31 .\" can do whatever you want with this stuff. If we meet some day, and you think
32 .\" this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
33 .\" ----------------------------------------------------------------------------
34 .\"
35 .\" $FreeBSD$
36 .\"
37 .Dd July 8, 2009
38 .Dt JAIL 8
39 .Os
40 .Sh NAME
41 .Nm jail
42 .Nd "create or modify a system jail"
43 .Sh SYNOPSIS
44 .Nm
45 .Op Fl dhi
46 .Op Fl J Ar jid_file
47 .Op Fl l u Ar username | Fl U Ar username
48 .Op Fl c | m
49 .Op Ar parameter=value ...
50 .Br
51 .Nm
52 .Op Fl hi
53 .Op Fl n Ar jailname
54 .Op Fl J Ar jid_file
55 .Op Fl s Ar securelevel
56 .Op Fl l u Ar username | Fl U Ar username
57 .Op Ar path hostname [ip[,..]] command ...
58 .Br
59 .Nm
60 .Op Fl r Ar jail
61 .Sh DESCRIPTION
62 The
63 .Nm
64 utility creates a new jail or modifies an existing jail, optionally
65 imprisoning the current process (and future descendants) inside it.
66 .Pp
67 The options are as follows:
68 .Bl -tag -width indent
69 .It Fl d
70 Allow making changes to a
71 .Va
72 dying jail.
73 .It Fl h
74 Resolve the
75 .Va host.hostname
76 parameter (or
77 .Va hostname )
78 and add all IP addresses returned by the resolver
79 to the list of
80 .Va ip
81 addresses for this prison.
82 This may affect default address selection for outgoing IPv4 connections
83 of prisons.
84 The address first returned by the resolver for each address family
85 will be used as primary address.
86 See the
87 .Va ip4.addr
88 and
89 .Va ip6.addr
90 parameters further down for details.
91 .It Fl i
92 Output the jail identifier of the newly created jail.
93 .It Fl n Ar jailname
94 Set the jail's name.
95 This is deprecated and is equivalent to setting the
96 .Va name
97 parameter.
98 .It Fl J Ar jid_file
99 Write a
100 .Ar jid_file
101 file, containing jail identifier, path, hostname, IP and
102 command used to start the jail.
103 .It Fl l
104 Run program in the clean environment.
105 The environment is discarded except for
106 .Ev HOME , SHELL , TERM
107 and
108 .Ev USER .
109 .Ev HOME
110 and
111 .Ev SHELL
112 are set to the target login's default values.
113 .Ev USER
114 is set to the target login.
115 .Ev TERM
116 is imported from the current environment.
117 The environment variables from the login class capability database for the
118 target login are also set.
119 .It Fl s Ar securelevel
120 Set the
121 .Va kern.securelevel
122 MIB entry to the specified value inside the newly created jail.
123 This is deprecated and is equivalent to setting the
124 .Va securelevel
125 parameter.
126 .It Fl u Ar username
127 The user name from host environment as whom the
128 .Ar command
129 should run.
130 .It Fl U Ar username
131 The user name from jailed environment as whom the
132 .Ar command
133 should run.
134 .It Fl c
135 Create a new jail.
136 The
137 .Va jid
138 and
139 .Va name
140 parameters (if specified) must not refer to an existing jail.
141 .It Fl m
142 Modify an existing jail.
143 One of the
144 .Va jid
145 or
146 .Va name
147 parameters must exist and refer to an existing jail.
148 .It Fl cm
149 Create a jail if it does not exist, or modify a jail if it does exist.
150 .It Fl r
151 Remove the
152 .Ar jail
153 specified by jid or name.
154 All jailed processes are killed, and all children of this jail are also
155 removed.
156 .El
157 .Pp
158 At least one of the
159 .Fl c ,
160 .Fl m
161 or
162 .Fl r
163 options must be specified.
164 .Pp
165 .Ar Parameters
166 are listed in
167 .Dq name=value
168 form, following the options.
169 Some parameters are boolean, and do not have a value but are set by the
170 name alone with or without a
171 .Dq no
172 prefix, e.g.
173 .Va persist
174 or
175 .Va nopersist .
176 Any parameters not set will be given default values, often based on the
177 current environment.
178 .Pp
179 The pseudo-parameter
180 .Va command
181 specifies that the current process should enter the new (or modified) jail,
182 and run the specified command.
183 It must be the last parameter specified, because it includes not only
184 the value following the
185 .Sq =
186 sign, but also passes the rest of the arguments to the command.
187 .Pp
188 Instead of supplying named
189 .Ar parameters ,
190 four fixed parameters may be supplied in order on the command line:
191 .Ar path ,
192 .Ar hostname ,
193 .Ar ip ,
194 and
195 .Ar command .
196 As the
197 .Va jid
198 and
199 .Va name
200 parameters aren't in this list, this mode will always create a new jail, and
201 the
202 .Fl c
203 and
204 .Fl m
205 options don't apply (and must not exist).
206 .Pp
207 Jails have a set a core parameters, and modules can add their own jail
208 parameters.
209 The current set of available parameters can be retrieved via
210 .Dq Nm sysctl Fl d Va security.jail.param .
211 The core parameters are:
212 .Bl -tag -width indent
213 .It Va jid
214 The jail identifier.
215 This will be assigned automatically to a new jail (or can be explicitly
216 set), and can be used to identify the jail for later modification, or
217 for such commands as
218 .Xr jls 8
219 or
220 .Xr jexec 8 .
221 .It Va name
222 The jail name.
223 This is an arbitrary string that identifies a jail (except it may not
224 contain a
225 .Sq \&. ) .
226 Like the
227 .Va jid ,
228 it can be passed to later
229 .Nm
230 commands, or to
231 .Xr jls 8
232 or
233 .Xr jexec 8 .
234 If no
235 .Va name
236 is supplied, a default is assumed that is the same as the
237 .Va jid .
238 .It Va path
239 Directory which is to be the root of the prison.
240 The
241 .Va command
242 (if any) is run from this directory, as are commands from
243 .Xr jexec 8 .
244 .It Va ip4.addr
245 A comma-separated list of IPv4 addresses assigned to the prison.
246 If this is set, the jail is restricted to using only these address.
247 Any attempts to use other addresses fail, and attempts to use wildcard
248 addresses silently use the jailed address instead.
249 For IPv4 the first address given will be kept used as the source address
250 in case source address selection on unbound sockets cannot find a better
251 match.
252 It is only possible to start multiple jails with the same IP address,
253 if none of the jails has more than this single overlapping IP address
254 assigned to itself.
255 .Pp
256 A list of zero elements (an empty string) will stop the jail from using IPv4
257 entirely; setting the boolean parameter
258 .Ar noip4
259 will not restrict the jail at all.
260 .It Va ip6.addr
261 A list of IPv6 addresses assigned to the prison, the counterpart to
262 .Ar ip4.addr
263 above.
264 .It Va host.hostname
265 Hostname of the prison.
266 Other similar parameters are
267 .Va host.domainname ,
268 .Va host.hostuuid
269 and
270 .Va host.hostid .
271 Setting the boolean parameter
272 .Va nohost
273 will retain the system values of these settings.
274 .It Va securelevel
275 The value of the jail's
276 .Va kern.securelevel
277 sysctl.
278 A jail never has a lower securelevel than the default system, but by
279 setting this parameter it may have a higher one.
280 If the system securelevel is changed, any jail securelevels will be at
281 least as secure.
282 .It Va children.max
283 The number of child jails allowed to be created by this jail (or by
284 other jails under this jail).
285 This limit is zero by default, indicating the jail is not allowed to
286 create child jails.
287 See the
288 .Va "Hierarchical Jails"
289 section for more information.
290 .It Va children.cur
291 The number of descendents of this jail, including its own child jails
292 and any jails created under them.
293 .It Va enforce_statfs
294 This determines which information processes in a jail are able to get
295 about mount points.
296 It affects the behaviour of the following syscalls:
297 .Xr statfs 2 ,
298 .Xr fstatfs 2 ,
299 .Xr getfsstat 2
300 and
301 .Xr fhstatfs 2
302 (as well as similar compatibility syscalls).
303 When set to 0, all mount points are available without any restrictions.
304 When set to 1, only mount points below the jail's chroot directory are
305 visible.
306 In addition to that, the path to the jail's chroot directory is removed
307 from the front of their pathnames.
308 When set to 2 (default), above syscalls can operate only on a mount-point
309 where the jail's chroot directory is located.
310 .It Va persist
311 Setting this boolean parameter allows a jail to exist without any
312 processes.
313 Normally, a jail is destroyed as its last process exits.
314 A new jail must have either the
315 .Va persist
316 parameter or
317 .Va command
318 pseudo-parameter set.
319 .It Va cpuset.id
320 The ID of the cpuset associated with this jail (read-only).
321 .It Va dying
322 This is true if the jail is in the process of shutting down (read-only).
323 .It Va parent
324 The
325 .Va jid
326 of the parent of this jail, or zero if this is a top-level jail
327 (read-only).
328 .It Va allow.*
329 Some restrictions of the jail environment may be set on a per-jail
330 basis.
331 With the exception of
332 .Va allow.set_hostname ,
333 these boolean parameters are off by default.
334 .Bl -tag -width indent
335 .It Va allow.set_hostname
336 The jail's hostname may be changed via
337 .Xr hostname 1
338 or
339 .Xr sethostname 3 .
340 .It Va allow.sysvipc
341 A process within the jail has access to System V IPC primitives.
342 In the current jail implementation, System V primitives share a single
343 namespace across the host and jail environments, meaning that processes
344 within a jail would be able to communicate with (and potentially interfere
345 with) processes outside of the jail, and in other jails.
346 .It Va allow.raw_sockets
347 The prison root is allowed to create raw sockets.
348 Setting this parameter allows utilities like
349 .Xr ping 8
350 and
351 .Xr traceroute 8
352 to operate inside the prison.
353 If this is set, the source IP addresses are enforced to comply
354 with the IP address bound to the jail, regardless of whether or not
355 the
356 .Dv IP_HDRINCL
357 flag has been set on the socket.
358 Since raw sockets can be used to configure and interact with various
359 network subsystems, extra caution should be used where privileged access
360 to jails is given out to untrusted parties.
361 .It Va allow.chflags
362 Normally, priveleged users inside a jail are treated as unprivileged by
363 .Xr chflags 2 .
364 When this parameter is set, such users are treated as privileged, and
365 may manipulate system file flags subject to the usual constraints on
366 .Va kern.securelevel .
367 .It Va allow.mount
368 privileged users inside the jail will be able to mount and unmount file
369 system types marked as jail-friendly.
370 The
371 .Xr lsvfs 1
372 command can be used to find file system types available for mount from
373 within a jail.
374 .It Va allow.quotas
375 The prison root may administer quotas on the jail's filesystem(s).
376 This includes filesystems that the jail may share with other jails or
377 with non-jailed parts of the system.
378 .It Va allow.socket_af
379 Sockets within a jail are normally restricted to IPv4, IPv6, local
380 (UNIX), and route.  This allows access to other protocol stacks that
381 have not had jail functionality added to them.
382 .El
383 .El
384 .Pp
385 Jails are typically set up using one of two philosophies: either to
386 constrain a specific application (possibly running with privilege), or
387 to create a
388 .Dq "virtual system image"
389 running a variety of daemons and services.
390 In both cases, a fairly complete file system install of
391 .Fx
392 is
393 required, so as to provide the necessary command line tools, daemons,
394 libraries, application configuration files, etc.
395 However, for a virtual server configuration, a fair amount of
396 additional work is required so as to configure the
397 .Dq boot
398 process.
399 This manual page documents the configuration steps necessary to support
400 either of these steps, although the configuration steps may be
401 refined based on local requirements.
402 .Sh EXAMPLES
403 .Ss "Setting up a Jail Directory Tree"
404 To set up a jail directory tree containing an entire
405 .Fx
406 distribution, the following
407 .Xr sh 1
408 command script can be used:
409 .Bd -literal
410 D=/here/is/the/jail
411 cd /usr/src
412 mkdir -p $D
413 make world DESTDIR=$D
414 make distribution DESTDIR=$D
415 mount -t devfs devfs $D/dev
416 .Ed
417 .Pp
418 NOTE: It is important that only appropriate device nodes in devfs be
419 exposed to a jail; access to disk devices in the jail may permit processes
420 in the jail to bypass the jail sandboxing by modifying files outside of
421 the jail.
422 See
423 .Xr devfs 8
424 for information on how to use devfs rules to limit access to entries
425 in the per-jail devfs.
426 A simple devfs ruleset for jails is available as ruleset #4 in
427 .Pa /etc/defaults/devfs.rules .
428 .Pp
429 In many cases this example would put far more in the jail than needed.
430 In the other extreme case a jail might contain only one file:
431 the executable to be run in the jail.
432 .Pp
433 We recommend experimentation and caution that it is a lot easier to
434 start with a
435 .Dq fat
436 jail and remove things until it stops working,
437 than it is to start with a
438 .Dq thin
439 jail and add things until it works.
440 .Ss "Setting Up a Jail"
441 Do what was described in
442 .Sx "Setting Up a Jail Directory Tree"
443 to build the jail directory tree.
444 For the sake of this example, we will
445 assume you built it in
446 .Pa /data/jail/192.0.2.100 ,
447 named for the jailed IP address.
448 Substitute below as needed with your
449 own directory, IP address, and hostname.
450 .Ss "Setting up the Host Environment"
451 First, you will want to set up your real system's environment to be
452 .Dq jail-friendly .
453 For consistency, we will refer to the parent box as the
454 .Dq "host environment" ,
455 and to the jailed virtual machine as the
456 .Dq "jail environment" .
457 Since jail is implemented using IP aliases, one of the first things to do
458 is to disable IP services on the host system that listen on all local
459 IP addresses for a service.
460 If a network service is present in the host environment that binds all
461 available IP addresses rather than specific IP addresses, it may service
462 requests sent to jail IP addresses if the jail did not bind the port.
463 This means changing
464 .Xr inetd 8
465 to only listen on the
466 appropriate IP address, and so forth.
467 Add the following to
468 .Pa /etc/rc.conf
469 in the host environment:
470 .Bd -literal -offset indent
471 sendmail_enable="NO"
472 inetd_flags="-wW -a 192.0.2.23"
473 rpcbind_enable="NO"
474 .Ed
475 .Pp
476 .Li 192.0.2.23
477 is the native IP address for the host system, in this example.
478 Daemons that run out of
479 .Xr inetd 8
480 can be easily set to use only the specified host IP address.
481 Other daemons
482 will need to be manually configured\(emfor some this is possible through
483 the
484 .Xr rc.conf 5
485 flags entries; for others it is necessary to modify per-application
486 configuration files, or to recompile the applications.
487 The following frequently deployed services must have their individual
488 configuration files modified to limit the application to listening
489 to a specific IP address:
490 .Pp
491 To configure
492 .Xr sshd 8 ,
493 it is necessary to modify
494 .Pa /etc/ssh/sshd_config .
495 .Pp
496 To configure
497 .Xr sendmail 8 ,
498 it is necessary to modify
499 .Pa /etc/mail/sendmail.cf .
500 .Pp
501 For
502 .Xr named 8 ,
503 it is necessary to modify
504 .Pa /etc/namedb/named.conf .
505 .Pp
506 In addition, a number of services must be recompiled in order to run
507 them in the host environment.
508 This includes most applications providing services using
509 .Xr rpc 3 ,
510 such as
511 .Xr rpcbind 8 ,
512 .Xr nfsd 8 ,
513 and
514 .Xr mountd 8 .
515 In general, applications for which it is not possible to specify which
516 IP address to bind should not be run in the host environment unless they
517 should also service requests sent to jail IP addresses.
518 Attempting to serve
519 NFS from the host environment may also cause confusion, and cannot be
520 easily reconfigured to use only specific IPs, as some NFS services are
521 hosted directly from the kernel.
522 Any third-party network software running
523 in the host environment should also be checked and configured so that it
524 does not bind all IP addresses, which would result in those services' also
525 appearing to be offered by the jail environments.
526 .Pp
527 Once
528 these daemons have been disabled or fixed in the host environment, it is
529 best to reboot so that all daemons are in a known state, to reduce the
530 potential for confusion later (such as finding that when you send mail
531 to a jail, and its sendmail is down, the mail is delivered to the host,
532 etc.).
533 .Ss "Configuring the Jail"
534 Start any jail for the first time without configuring the network
535 interface so that you can clean it up a little and set up accounts.
536 As
537 with any machine (virtual or not) you will need to set a root password, time
538 zone, etc.
539 Some of these steps apply only if you intend to run a full virtual server
540 inside the jail; others apply both for constraining a particular application
541 or for running a virtual server.
542 .Pp
543 Start a shell in the jail:
544 .Pp
545 .Bd -literal -offset indent
546 jail path=/data/jail/192.0.2.100 host.hostname=testhostname \\
547         ip4.addr=192.0.2.100 command=/bin/sh
548 .Ed
549 .Pp
550 Assuming no errors, you will end up with a shell prompt within the jail.
551 You can now run
552 .Pa /usr/sbin/sysinstall
553 and do the post-install configuration to set various configuration options,
554 or perform these actions manually by editing
555 .Pa /etc/rc.conf ,
556 etc.
557 .Pp
558 .Bl -bullet -offset indent -compact
559 .It
560 Create an empty
561 .Pa /etc/fstab
562 to quell startup warnings about missing fstab (virtual server only)
563 .It
564 Disable the port mapper
565 .Pa ( /etc/rc.conf :
566 .Li rpcbind_enable="NO" )
567 (virtual server only)
568 .It
569 Configure
570 .Pa /etc/resolv.conf
571 so that name resolution within the jail will work correctly
572 .It
573 Run
574 .Xr newaliases 1
575 to quell
576 .Xr sendmail 8
577 warnings.
578 .It
579 Disable interface configuration to quell startup warnings about
580 .Xr ifconfig 8
581 .Pq Li network_interfaces=""
582 (virtual server only)
583 .It
584 Set a root password, probably different from the real host system
585 .It
586 Set the timezone
587 .It
588 Add accounts for users in the jail environment
589 .It
590 Install any packages the environment requires
591 .El
592 .Pp
593 You may also want to perform any package-specific configuration (web servers,
594 SSH servers, etc), patch up
595 .Pa /etc/syslog.conf
596 so it logs as you would like, etc.
597 If you are not using a virtual server, you may wish to modify
598 .Xr syslogd 8
599 in the host environment to listen on the syslog socket in the jail
600 environment; in this example, the syslog socket would be stored in
601 .Pa /data/jail/192.0.2.100/var/run/log .
602 .Pp
603 Exit from the shell, and the jail will be shut down.
604 .Ss "Starting the Jail"
605 You are now ready to restart the jail and bring up the environment with
606 all of its daemons and other programs.
607 If you are running a single application in the jail, substitute the
608 command used to start the application for
609 .Pa /etc/rc
610 in the examples below.
611 To start a virtual server environment,
612 .Pa /etc/rc
613 is run to launch various daemons and services.
614 To do this, first bring up the
615 virtual host interface, and then start the jail's
616 .Pa /etc/rc
617 script from within the jail.
618 .Bd -literal -offset indent
619 ifconfig ed0 inet alias 192.0.2.100/32
620 mount -t procfs proc /data/jail/192.0.2.100/proc
621 jail path=/data/jail/192.0.2.100 host.hostname=testhostname \\
622         ip4.addr=192.0.2.100 command=/bin/sh /etc/rc
623 .Ed
624 .Pp
625 A few warnings will be produced, because most
626 .Xr sysctl 8
627 configuration variables cannot be set from within the jail, as they are
628 global across all jails and the host environment.
629 However, it should all
630 work properly.
631 You should be able to see
632 .Xr inetd 8 ,
633 .Xr syslogd 8 ,
634 and other processes running within the jail using
635 .Xr ps 1 ,
636 with the
637 .Ql J
638 flag appearing beside jailed processes.
639 To see an active list of jails, use the
640 .Xr jls 8
641 utility.
642 You should also be able to
643 .Xr telnet 1
644 to the hostname or IP address of the jailed environment, and log
645 in using the accounts you created previously.
646 .Pp
647 It is possible to have jails started at boot time.
648 Please refer to the
649 .Dq jail_*
650 variables in
651 .Xr rc.conf 5
652 for more information.
653 The
654 .Xr rc 8
655 jail script provides a flexible system to start/stop jails:
656 .Bd -literal
657 /etc/rc.d/jail start
658 /etc/rc.d/jail stop
659 /etc/rc.d/jail start myjail
660 /etc/rc.d/jail stop myjail
661 .Ed
662 .Ss "Managing the Jail"
663 Normal machine shutdown commands, such as
664 .Xr halt 8 ,
665 .Xr reboot 8 ,
666 and
667 .Xr shutdown 8 ,
668 cannot be used successfully within the jail.
669 To kill all processes in a
670 jail, you may log into the jail and, as root, use one of the following
671 commands, depending on what you want to accomplish:
672 .Pp
673 .Bd -literal -offset indent
674 kill -TERM -1
675 kill -KILL -1
676 .Ed
677 .Pp
678 This will send the
679 .Dv SIGTERM
680 or
681 .Dv SIGKILL
682 signals to all processes in the jail from within the jail.
683 Depending on
684 the intended use of the jail, you may also want to run
685 .Pa /etc/rc.shutdown
686 from within the jail.
687 To kill processes from outside the jail, use the
688 .Xr jexec 8
689 utility in conjunction with the one of the
690 .Xr kill 1
691 commands above.
692 You may also remove the jail with
693 .Nm
694 .Ar -r ,
695 which will killall the jail's processes with
696 .Dv SIGKILL .
697 .Pp
698 The
699 .Pa /proc/ Ns Ar pid Ns Pa /status
700 file contains, as its last field, the name of the jail in which the
701 process runs, or
702 .Dq Li -
703 to indicate that the process is not running within a jail.
704 The
705 .Xr ps 1
706 command also shows a
707 .Ql J
708 flag for processes in a jail.
709 .Pp
710 You can also list/kill processes based on their jail ID.
711 To show processes and their jail ID, use the following command:
712 .Pp
713 .Dl "ps ax -o pid,jid,args"
714 .Pp
715 To show and then kill processes in jail number 3 use the following commands:
716 .Bd -literal -offset indent
717 pgrep -lfj 3
718 pkill -j 3
719 .Ed
720 or:
721 .Pp
722 .Dl "killall -j 3"
723 .Ss "Jails and File Systems"
724 It is not possible to
725 .Xr mount 8
726 or
727 .Xr umount 8
728 any file system inside a jail unless the file system is marked
729 jail-friendly and the jail's
730 .Va allow.mount
731 parameter is set.
732 .Pp
733 Multiple jails sharing the same file system can influence each other.
734 For example a user in one jail can fill the file system also
735 leaving no space for processes in the other jail.
736 Trying to use
737 .Xr quota 1
738 to prevent this will not work either as the file system quotas
739 are not aware of jails but only look at the user and group IDs.
740 This means the same user ID in two jails share the same file
741 system quota.
742 One would need to use one file system per jail to make this work.
743 .Ss "Sysctl MIB Entries"
744 The read-only entry
745 .Va security.jail.jailed
746 can be used to determine if a process is running inside a jail (value
747 is one) or not (value is zero).
748 .Pp
749 The variable
750 .Va security.jail.max_af_ips
751 determines how may address per address family a prison may have.
752 The default is 255.
753 .Pp
754 Some MIB variables have per-jail settings.
755 Changes to these variables by a jailed process do not effect the host
756 environment, only the jail environment.
757 These variables are
758 .Va kern.securelevel ,
759 .Va kern.hostname ,
760 .Va kern.domainname ,
761 .Va kern.hostid ,
762 and
763 .Va kern.hostuuid .
764 .Ss "Hierarchical Jails"
765 By setting a jail's
766 .Va children.max
767 parameter, processes within a jail may be able to create jails of their own.
768 These child jails are kept in a hierarchy, with jails only able to see and/or
769 modify the jails they created (or those jails' children).
770 Each jail has a read-only
771 .Va parent
772 parameter, containing the
773 .Va jid
774 of the jail that created it; a
775 .Va jid
776 of 0 indicates the jail is a child of the current jail (or is a top-level
777 jail if the current process isn't jailed).
778 .Pp
779 Jailed processes are not allowed to confer greater permissions than they
780 themselves are given, e.g. if a jail is created with
781 .Va allow.nomount ,
782 it is not able to create a jail with
783 .Va allow.mount
784 set.
785 Similarly, such restrictions as
786 .Va ip4.addr
787 and
788 .Va securelevel
789 may not be bypassed in child jails.
790 .Pp
791 A child jail may in turn create its own child jails if its own
792 .Va children.max
793 parameter is set (remember it is zero by default).
794 These jails are visible to and can be modified by their parent and all
795 ancestors.
796 .Pp
797 Jail names reflect this hierarchy, with a full name being an MIB-type string
798 separated by dots.
799 For example, if a base system process creates a jail
800 .Dq foo ,
801 and a process under that jail creates another jail
802 .Dq bar ,
803 then the second jail will be seen as
804 .Dq foo.bar
805 in the base system (though it is only seen as
806 .Dq bar
807 to any processes inside jail
808 .Dq foo ) .
809 Jids on the other hand exist in a single space, and each jail must have a
810 unique jid.
811 .Pp
812 Like the names, a child jail's
813 .Va path
814 is relative to its creator's own
815 .Va path .
816 This is by virtue of the child jail being created in the chrooted
817 environment of the first jail.
818 .Sh SEE ALSO
819 .Xr killall 1 ,
820 .Xr lsvfs 1 ,
821 .Xr newaliases 1 ,
822 .Xr pgrep 1 ,
823 .Xr pkill 1 ,
824 .Xr ps 1 ,
825 .Xr quota 1 ,
826 .Xr chroot 2 ,
827 .Xr jail_set 2 ,
828 .Xr jail_attach 2 ,
829 .Xr procfs 5 ,
830 .Xr rc.conf 5 ,
831 .Xr sysctl.conf 5 ,
832 .Xr devfs 8 ,
833 .Xr halt 8 ,
834 .Xr inetd 8 ,
835 .Xr jexec 8 ,
836 .Xr jls 8 ,
837 .Xr mount 8 ,
838 .Xr named 8 ,
839 .Xr reboot 8 ,
840 .Xr rpcbind 8 ,
841 .Xr sendmail 8 ,
842 .Xr shutdown 8 ,
843 .Xr sysctl 8 ,
844 .Xr syslogd 8 ,
845 .Xr umount 8
846 .Sh HISTORY
847 The
848 .Nm
849 utility appeared in
850 .Fx 4.0 .
851 Hierarchical/extensible jails were introduced in
852 .Fx 8.0 .
853 .Sh AUTHORS
854 .An -nosplit
855 The jail feature was written by
856 .An Poul-Henning Kamp
857 for R&D Associates
858 .Pa http://www.rndassociates.com/
859 who contributed it to
860 .Fx .
861 .Pp
862 .An Robert Watson
863 wrote the extended documentation, found a few bugs, added
864 a few new features, and cleaned up the userland jail environment.
865 .Pp
866 .An Bjoern A. Zeeb
867 added multi-IP jail support for IPv4 and IPv6 based on a patch
868 originally done by
869 .An Pawel Jakub Dawidek
870 for IPv4.
871 .Pp
872 .An James Gritton
873 added the extensible jail parameters and hierchical jails.
874 .Sh BUGS
875 Jail currently lacks the ability to allow access to
876 specific jail information via
877 .Xr ps 1
878 as opposed to
879 .Xr procfs 5 .
880 Similarly, it might be a good idea to add an
881 address alias flag such that daemons listening on all IPs
882 .Pq Dv INADDR_ANY
883 will not bind on that address, which would facilitate building a safe
884 host environment such that host daemons do not impose on services offered
885 from within jails.
886 Currently, the simplest answer is to minimize services
887 offered on the host, possibly limiting it to services offered from
888 .Xr inetd 8
889 which is easily configurable.