1 .\" Copyright (c) 2000, 2003 Robert N. M. Watson
2 .\" Copyright (c) 2008-2012 James Gritton
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
33 .Nd "manage system jails"
41 .Ar param Ns = Ns Ar value ...
42 .Op Cm command Ns = Ns Ar command ...
54 .Op Cm * | Ar jail ...
61 .Op Fl s Ar securelevel
62 .Op Ar path hostname [ Ar ip Ns [ Ns Ar ,... Ns ]] Ar command ...
66 utility creates new jails, or modifies or removes existing jails.
67 It can also print a list of configured jails and their parameters.
70 is specified via parameters on the command line, or in the
74 At least one of the options
81 These options are used alone or in combination to describe the operation to
83 .Bl -tag -width indent
90 parameters (if specified on the command line)
91 must not refer to an existing jail.
93 Exhibit a list of all configured non-wildcard jails and their parameters.
94 No jail creation, modification or removal performed if this option is used.
97 string is used to separate parameters.
100 utility to list running jails.
102 Modify an existing jail.
107 parameters must exist and refer to an existing jail.
108 Some parameters may not be changed on a running jail.
112 specified by jid or name.
113 All jailed processes are killed, and all jails that are
114 children of this jail are also
117 Restart an existing jail.
118 The jail is first removed and then re-created, as if
122 were run in succession.
124 Create a jail if it does not exist, or modify the jail if it does exist.
126 Modify an existing jail.
127 The jail may be restarted if necessary to modify parameters than could
128 not otherwise be changed.
130 Create a jail if it doesn't exist, or modify (and possibly restart) the
131 jail if it does exist.
134 Other available options are:
135 .Bl -tag -width indent
137 Allow making changes to a dying jail, equivalent to the
140 .It Fl f Ar conf_file
141 Use configuration file
143 instead of the default
150 and add all IP addresses returned by the resolver
151 to the list of addresses for this jail.
152 This is equivalent to the
156 Output (only) the jail identifier of the newly created jail(s).
163 file, containing the parameters used to start the jail.
165 Run commands in a clean environment.
166 This is deprecated and is equivalent to the exec.clean parameter.
169 This is deprecated and is equivalent to the
173 Limit the number of commands from
175 that can run simultaneously.
177 Suppress the message printed whenever a jail is created, modified or removed.
178 Only error messages will be printed.
182 option that removes an existing jail without using the configuration file.
183 No removal-related parameters for this jail will be used \(em the jail will
185 .It Fl s Ar securelevel
188 MIB entry to the specified value inside the newly created jail.
189 This is deprecated and is equivalent to the
193 The user name from host environment as whom jailed commands should run.
194 This is deprecated and is equivalent to the
197 .Va exec.system_jail_user
200 The user name from the jailed environment as whom jailed commands should run.
201 This is deprecated and is equivalent to the
205 Print a message on every operation, such as running commands and
206 mounting filesystems.
209 If no arguments are given after the options, the operation (except
210 remove) will be performed on all jails specified in the
213 A single argument of a jail name will operate only on the specified jail.
218 options can also remove running jails that aren't in the
220 file, specified by name or jid.
224 is a wildcard that will operate on all jails, regardless of whether
227 this is the surest way for
230 If hierarchical jails exist, a partial-matching wildcard definition may
232 For example, an argument of
234 would apply to jails with names like
239 A jail may be specified with parameters directly on the command line.
242 file will not be used.
243 For backward compatibility, the command line may also have four fixed
244 parameters, without names:
250 This mode will always create a new jail, and the
254 options do not apply (and must not be present).
258 file, or on the command line, are generally of the form
260 Some parameters are boolean, and do not have a value but are set by the
261 name alone with or without a
267 They can also be given the values
271 Other parameters may have more than one value, specified as a
272 comma-separated list or with
274 in the configuration file (see
280 utility recognizes two classes of parameters.
281 There are the true jail
282 parameters that are passed to the kernel when the jail is created,
283 which can be seen with
285 and can (usually) be changed with
287 Then there are pseudo-parameters that are only used by
291 Jails have a set of core parameters, and kernel modules can add their own
293 The current set of available parameters can be retrieved via
294 .Dq Nm sysctl Fl d Va security.jail.param .
295 Any parameters not set will be given default values, often based on the
297 The core parameters are:
298 .Bl -tag -width indent
301 This will be assigned automatically to a new jail (or can be explicitly
302 set), and can be used to identify the jail for later modification, or
309 This is an arbitrary string that identifies a jail (except it may not
314 it can be passed to later
322 is supplied, a default is assumed that is the same as the
326 parameter is implied by the
328 file format, and need not be explicitly set when using the configuration
331 The directory which is to be the root of the jail.
332 Any commands run inside the jail, either by
336 are run from this directory.
338 A list of IPv4 addresses assigned to the jail.
339 If this is set, the jail is restricted to using only these addresses.
340 Any attempts to use other addresses fail, and attempts to use wildcard
341 addresses silently use the jailed address instead.
342 For IPv4 the first address given will be used as the source address
343 when source address selection on unbound sockets cannot find a better
345 It is only possible to start multiple jails with the same IP address
346 if none of the jails has more than this single overlapping IP address
349 A boolean option to change the formerly mentioned behaviour and disable
350 IPv4 source address selection for the jail in favour of the primary
351 IPv4 address of the jail.
352 Source address selection is enabled by default for all jails and the
354 setting of a parent jail is not inherited for any child jails.
356 Control the availability of IPv4 addresses.
359 to allow unrestricted access to all system addresses,
361 to restrict addresses via
365 to stop the jail from using IPv4 entirely.
368 parameter implies a value of
370 .It Va ip6.addr , Va ip6.saddrsel , Va ip6
371 A set of IPv6 options for the jail, the counterparts to
378 Create the jail with its own virtual network stack,
379 with its own network interfaces, addresses, routing table, etc.
380 The kernel must have been compiled with the
382 for this to be available.
385 to use the system network stack, possibly with restricted IP addresses,
388 to create a new network stack.
390 The hostname of the jail.
391 Other similar parameters are
392 .Va host.domainname ,
397 Set the origin of hostname and related information.
400 to use the system information and
402 for the jail to use the information from the above fields.
403 Setting any of the above fields implies a value of
406 The value of the jail's
409 A jail never has a lower securelevel than its parent system, but by
410 setting this parameter it may have a higher one.
411 If the system securelevel is changed, any jail securelevels will be at
414 The number of the devfs ruleset that is enforced for mounting devfs in
416 A value of zero (default) means no ruleset is enforced.
417 Descendant jails inherit the parent jail's devfs ruleset enforcement.
418 Mounting devfs inside a jail is possible only if the
421 .Va allow.mount.devfs
422 permissions are effective and
424 is set to a value lower than 2.
425 Devfs rules and rulesets cannot be viewed or modified from inside a jail.
427 NOTE: It is important that only appropriate device nodes in devfs be
428 exposed to a jail; access to disk devices in the jail may permit processes
429 in the jail to bypass the jail sandboxing by modifying files outside of
433 for information on how to use devfs rules to limit access to entries
434 in the per-jail devfs.
435 A simple devfs ruleset for jails is available as ruleset #4 in
436 .Pa /etc/defaults/devfs.rules .
438 The number of child jails allowed to be created by this jail (or by
439 other jails under this jail).
440 This limit is zero by default, indicating the jail is not allowed to
443 .Sx "Hierarchical Jails"
444 section for more information.
446 The number of descendants of this jail, including its own child jails
447 and any jails created under them.
448 .It Va enforce_statfs
449 This determines what information processes in a jail are able to get
451 It affects the behaviour of the following syscalls:
457 (as well as similar compatibility syscalls).
458 When set to 0, all mount points are available without any restrictions.
459 When set to 1, only mount points below the jail's chroot directory are
461 In addition to that, the path to the jail's chroot directory is removed
462 from the front of their pathnames.
463 When set to 2 (default), above syscalls can operate only on a mount-point
464 where the jail's chroot directory is located.
466 Setting this boolean parameter allows a jail to exist without any
468 Normally, a command is run as part of jail creation, and then the jail
469 is destroyed as its last process exits.
470 A new jail must have either the
476 pseudo-parameter set.
478 The ID of the cpuset associated with this jail (read-only).
480 This is true if the jail is in the process of shutting down (read-only).
484 of the parent of this jail, or zero if this is a top-level jail
487 The string for the jail's
491 The number for the jail's
495 Some restrictions of the jail environment may be set on a per-jail
497 With the exception of
498 .Va allow.set_hostname
500 .Va allow.reserved_ports ,
501 these boolean parameters are off by default.
502 .Bl -tag -width indent
503 .It Va allow.set_hostname
504 The jail's hostname may be changed via
509 A process within the jail has access to System V IPC primitives.
510 This is deprecated in favor of the per-module parameters (see below).
511 When this parameter is set, it is equivalent to setting
518 .It Va allow.raw_sockets
519 The jail root is allowed to create raw sockets.
520 Setting this parameter allows utilities like
524 to operate inside the jail.
525 If this is set, the source IP addresses are enforced to comply
526 with the IP address bound to the jail, regardless of whether or not
529 flag has been set on the socket.
530 Since raw sockets can be used to configure and interact with various
531 network subsystems, extra caution should be used where privileged access
532 to jails is given out to untrusted parties.
534 Normally, privileged users inside a jail are treated as unprivileged by
536 When this parameter is set, such users are treated as privileged, and
537 may manipulate system file flags subject to the usual constraints on
538 .Va kern.securelevel .
540 privileged users inside the jail will be able to mount and unmount file
541 system types marked as jail-friendly.
544 command can be used to find file system types available for mount from
546 This permission is effective only if
548 is set to a value lower than 2.
549 .It Va allow.mount.devfs
550 privileged users inside the jail will be able to mount and unmount the
552 This permission is effective only together with
556 is set to a value lower than 2.
557 The devfs ruleset should be restricted from the default by using the
561 The jail root may administer quotas on the jail's filesystem(s).
562 This includes filesystems that the jail may share with other jails or
563 with non-jailed parts of the system.
564 .It Va allow.read_msgbuf
565 Jailed users may read the kernel message buffer.
567 .Va security.bsd.unprivileged_read_msgbuf
568 MIB entry is zero, this will be restricted to the root user.
569 .It Va allow.socket_af
570 Sockets within a jail are normally restricted to IPv4, IPv6, local
571 (UNIX), and route. This allows access to other protocol stacks that
572 have not had jail functionality added to them.
574 Locking or unlocking physical pages in memory are normally not available
576 When this parameter is set, users may
581 .Va security.bsd.unprivileged_mlock
583 .It Va allow.reserved_ports
584 The jail root may bind to ports lower than 1024.
585 .It Va allow.unprivileged_proc_debug
586 Unprivileged processes in the jail may use debugging facilities.
590 Kernel modules may add their own parameters, which only exist when the
592 These are typically headed under a parameter named after the module,
595 to give the jail full use of the module,
597 to encapsulate the jail in some module-specific way,
600 to make the module unavailable to the jail.
601 There also may be other parameters to define jail behavior within the module.
602 Module-specific parameters include:
603 .Bl -tag -width indent
604 .It Va allow.mount.fdescfs
605 privileged users inside the jail will be able to mount and unmount the
607 This permission is effective only together with
611 is set to a value lower than 2.
612 .It Va allow.mount.fusefs
613 privileged users inside the jail will be able to mount and unmount
614 fuse-based file systems.
615 This permission is effective only together with
619 is set to a value lower than 2.
620 .It Va allow.mount.nullfs
621 privileged users inside the jail will be able to mount and unmount the
623 This permission is effective only together with
627 is set to a value lower than 2.
628 .It Va allow.mount.procfs
629 privileged users inside the jail will be able to mount and unmount the
631 This permission is effective only together with
635 is set to a value lower than 2.
636 .It Va allow.mount.linprocfs
637 privileged users inside the jail will be able to mount and unmount the
638 linprocfs file system.
639 This permission is effective only together with
643 is set to a value lower than 2.
644 .It Va allow.mount.linsysfs
645 privileged users inside the jail will be able to mount and unmount the
646 linsysfs file system.
647 This permission is effective only together with
651 is set to a value lower than 2.
652 .It Va allow.mount.tmpfs
653 privileged users inside the jail will be able to mount and unmount the
655 This permission is effective only together with
659 is set to a value lower than 2.
660 .It Va allow.mount.zfs
661 privileged users inside the jail will be able to mount and unmount the
663 This permission is effective only together with
667 is set to a value lower than 2.
670 for information on how to configure the ZFS filesystem to operate from
675 This flag is only available when the
677 kernel module is loaded.
679 Determine how a jail's Linux emulation environment appears.
682 will keep the same environment, and
684 will give the jail it's own environment (still originally inherited when
685 the jail is created).
686 .It Va linux.osname , linux.osrelease , linux.oss_version
687 The Linux OS name, OS release, and OSS version associated with this jail.
689 Allow access to SYSV IPC message primitives.
692 all IPC objects on the system are visible to this jail, whether they
693 were created by the jail itself, the base system, or other jails.
696 the jail will have its own key namespace, and can only see the objects
698 the system (or parent jail) has access to the jail's objects, but not to
702 the jail cannot perform any sysvmsg-related system calls.
703 .It Va sysvsem, sysvshm
704 Allow access to SYSV IPC semaphore and shared memory primitives, in the
709 There are pseudo-parameters that are not passed to the kernel, but are
712 to set up the jail environment, often by running specified commands
713 when jails are created or removed.
716 command parameters are
718 command lines that are run in either the system or jail environment.
719 They may be given multiple values, which would run the specified
720 commands in sequence.
721 All commands must succeed (return a zero exit status), or the jail will
722 not be created or removed, as appropriate.
724 The pseudo-parameters are:
725 .Bl -tag -width indent
727 Command(s) to run in the system environment before a jail is created.
729 Command(s) to run in the system environment right after a jail has been
730 created, but before commands (or services) get executed in the jail.
732 Command(s) to run in the jail environment when a jail is created.
733 A typical command to run is
738 for use when specifying a jail directly on the command line.
739 Unlike other parameters whose value is a single string,
741 uses the remainder of the
743 command line as its own arguments.
744 .It Va exec.poststart
745 Command(s) to run in the system environment after a jail is created,
748 commands have completed.
750 Command(s) to run in the system environment before a jail is removed.
752 Command(s) to run in the jail environment before a jail is removed,
755 commands have completed.
756 A typical command to run is
757 .Dq sh /etc/rc.shutdown .
759 Command(s) to run in the system environment after a jail is removed.
761 Run commands in a clean environment.
762 The environment is discarded except for
763 .Ev HOME , SHELL , TERM
769 are set to the target login's default values.
771 is set to the target login.
773 is imported from the current environment.
774 The environment variables from the login class capability database for the
775 target login are also set.
776 .It Va exec.jail_user
777 The user to run commands as, when running in the jail environment.
778 The default is to run the commands as the current user.
779 .It Va exec.system_jail_user
780 This boolean option looks for the
784 file, instead of in the jail's file.
785 .It Va exec.system_user
786 The user to run commands as, when running in the system environment.
787 The default is to run the commands as the current user.
789 The maximum amount of time to wait for a command to complete, in
791 If a command is still running after this timeout has passed,
792 the jail will not be created or removed, as appropriate.
793 .It Va exec.consolelog
794 A file to direct command output (stdout and stderr) to.
796 The FIB (routing table) to set when running commands inside the jail.
798 The maximum amount of time to wait for a jail's processes to exit
801 signal (which happens after the
803 commands have completed).
804 After this many seconds have passed, the jail will be removed, which
805 will kill any remaining processes.
806 If this is set to zero, no
808 is sent and the jail is immediately removed.
809 The default is 10 seconds.
811 A network interface to add the jail's IP addresses
816 An alias for each address will be added to the interface before the
817 jail is created, and will be removed from the interface after the
820 In addition to the IP addresses that are passed to the kernel, an
821 interface, netmask and additional parameters (as supported by
823 may also be specified, in the form
824 .Dq Ar interface Ns | Ns Ar ip-address Ns / Ns Ar netmask param ... .
825 If an interface is given before the IP address, an alias for the address
826 will be added to that interface, as it is with the
829 If a netmask in either dotted-quad or CIDR form is given
830 after an IP address, it will be used when adding the IP alias.
831 If additional parameters are specified then they will also be used when
834 In addition to the IP addresses that are passed to the kernel,
835 an interface, prefix and additional parameters (as supported by
837 may also be specified, in the form
838 .Dq Ar interface Ns | Ns Ar ip-address Ns / Ns Ar prefix param ... .
839 .It Va vnet.interface
840 A network interface to give to a vnet-enabled jail after is it created.
841 The interface will automatically be released when the jail is removed.
845 parameter and add all IP addresses returned by the resolver
846 to the list of addresses
851 This may affect default address selection for outgoing IPv4 connections
853 The address first returned by the resolver for each address family
854 will be used as the primary address.
856 A filesystem to mount before creating the jail (and to unmount after
857 removing it), given as a single
863 format file containing filesystems to mount before creating a jail.
867 filesystem on the chrooted
869 directory, and apply the ruleset in the
871 parameter (or a default of ruleset 4: devfsrules_jail)
872 to restrict the devices visible inside the jail.
876 filesystem on the chrooted
882 filesystem on the chrooted
886 Allow making changes to a
890 Specify a jail (or jails) that this jail depends on.
891 When this jail is to be created, any jail(s) it depends on must already exist.
892 If not, they will be created automatically, up to the completion of the last
894 command, before any action will taken to create this jail.
895 When jails are removed the opposite is true:
896 this jail will be removed, up to the last
898 command, before any jail(s) it depends on are stopped.
901 Jails are typically set up using one of two philosophies: either to
902 constrain a specific application (possibly running with privilege), or
904 .Dq "virtual system image"
905 running a variety of daemons and services.
906 In both cases, a fairly complete file system install of
909 required, so as to provide the necessary command line tools, daemons,
910 libraries, application configuration files, etc.
911 However, for a virtual server configuration, a fair amount of
912 additional work is required so as to replace the
915 This manual page documents the configuration steps necessary to support
916 either of these steps, although the configuration steps may need to be
917 refined based on local requirements.
918 .Ss "Setting up a Jail Directory Tree"
919 To set up a jail directory tree containing an entire
921 distribution, the following
923 command script can be used:
928 make world DESTDIR=$D
929 make distribution DESTDIR=$D
932 In many cases this example would put far more in the jail than needed.
933 In the other extreme case a jail might contain only one file:
934 the executable to be run in the jail.
936 We recommend experimentation, and caution that it is a lot easier to
939 jail and remove things until it stops working,
940 than it is to start with a
942 jail and add things until it works.
943 .Ss "Setting Up a Jail"
944 Do what was described in
945 .Sx "Setting Up a Jail Directory Tree"
946 to build the jail directory tree.
947 For the sake of this example, we will
948 assume you built it in
949 .Pa /data/jail/testjail ,
952 Substitute below as needed with your
953 own directory, IP address, and hostname.
954 .Ss "Setting up the Host Environment"
955 First, set up the real system's environment to be
957 For consistency, we will refer to the parent box as the
958 .Dq "host environment" ,
959 and to the jailed virtual machine as the
960 .Dq "jail environment" .
961 Since jails are implemented using IP aliases, one of the first things to do
962 is to disable IP services on the host system that listen on all local
963 IP addresses for a service.
964 If a network service is present in the host environment that binds all
965 available IP addresses rather than specific IP addresses, it may service
966 requests sent to jail IP addresses if the jail did not bind the port.
969 to only listen on the
970 appropriate IP address, and so forth.
973 in the host environment:
974 .Bd -literal -offset indent
976 inetd_flags="-wW -a 192.0.2.23"
981 is the native IP address for the host system, in this example.
982 Daemons that run out of
984 can be easily configured to use only the specified host IP address.
986 will need to be manually configured \(em for some this is possible through
988 flags entries; for others it is necessary to modify per-application
989 configuration files, or to recompile the application.
990 The following frequently deployed services must have their individual
991 configuration files modified to limit the application to listening
992 to a specific IP address:
996 it is necessary to modify
997 .Pa /etc/ssh/sshd_config .
1001 it is necessary to modify
1002 .Pa /etc/mail/sendmail.cf .
1006 it is necessary to modify
1007 .Pa /etc/namedb/named.conf .
1009 In addition, a number of services must be recompiled in order to run
1010 them in the host environment.
1011 This includes most applications providing services using
1018 In general, applications for which it is not possible to specify which
1019 IP address to bind should not be run in the host environment unless they
1020 should also service requests sent to jail IP addresses.
1022 NFS from the host environment may also cause confusion, and cannot be
1023 easily reconfigured to use only specific IPs, as some NFS services are
1024 hosted directly from the kernel.
1025 Any third-party network software running
1026 in the host environment should also be checked and configured so that it
1027 does not bind all IP addresses, which would result in those services also
1028 appearing to be offered by the jail environments.
1031 these daemons have been disabled or fixed in the host environment, it is
1032 best to reboot so that all daemons are in a known state, to reduce the
1033 potential for confusion later (such as finding that when you send mail
1034 to a jail, and its sendmail is down, the mail is delivered to the host,
1036 .Ss "Configuring the Jail"
1037 Start any jail for the first time without configuring the network
1038 interface so that you can clean it up a little and set up accounts.
1040 with any machine (virtual or not), you will need to set a root password, time
1042 Some of these steps apply only if you intend to run a full virtual server
1043 inside the jail; others apply both for constraining a particular application
1044 or for running a virtual server.
1046 Start a shell in the jail:
1047 .Bd -literal -offset indent
1048 jail -c path=/data/jail/testjail mount.devfs \\
1049 host.hostname=testhostname ip4.addr=192.0.2.100 \\
1053 Assuming no errors, you will end up with a shell prompt within the jail.
1056 and do the post-install configuration to set various configuration options,
1057 or perform these actions manually by editing
1061 .Bl -bullet -offset indent -compact
1064 .Pa /etc/resolv.conf
1065 so that name resolution within the jail will work correctly.
1073 Set a root password, probably different from the real host system.
1077 Add accounts for users in the jail environment.
1079 Install any packages the environment requires.
1082 You may also want to perform any package-specific configuration (web servers,
1083 SSH servers, etc), patch up
1084 .Pa /etc/syslog.conf
1085 so it logs as you would like, etc.
1086 If you are not using a virtual server, you may wish to modify
1088 in the host environment to listen on the syslog socket in the jail
1089 environment; in this example, the syslog socket would be stored in
1090 .Pa /data/jail/testjail/var/run/log .
1092 Exit from the shell, and the jail will be shut down.
1093 .Ss "Starting the Jail"
1094 You are now ready to restart the jail and bring up the environment with
1095 all of its daemons and other programs.
1096 Create an entry for the jail in
1097 .Pa /etc/jail.conf :
1098 .Bd -literal -offset indent
1100 path = /tmp/jail/testjail;
1102 host.hostname = testhostname;
1103 ip4.addr = 192.0.2.100;
1105 exec.start = "/bin/sh /etc/rc";
1106 exec.stop = "/bin/sh /etc/rc.shutdown";
1110 To start a virtual server environment,
1112 is run to launch various daemons and services, and
1113 .Pa /etc/rc.shutdown
1114 is run to shut them down when the jail is removed.
1115 If you are running a single application in the jail,
1116 substitute the command used to start the application for
1117 .Dq /bin/sh /etc/rc ;
1118 there may be some script available to cleanly shut down the application,
1119 or it may be sufficient to go without a stop command, and have
1125 Start the jail by running:
1126 .Bd -literal -offset indent
1130 A few warnings may be produced; however, it should all work properly.
1131 You should be able to see
1134 and other processes running within the jail using
1138 flag appearing beside jailed processes.
1139 To see an active list of jails, use
1143 is enabled in the jail environment, you should be able to
1145 to the hostname or IP address of the jailed environment, and log
1146 in using the accounts you created previously.
1148 It is possible to have jails started at boot time.
1153 for more information.
1154 .Ss "Managing the Jail"
1155 Normal machine shutdown commands, such as
1160 cannot be used successfully within the jail.
1161 To kill all processes from within a jail, you may use one of the
1162 following commands, depending on what you want to accomplish:
1163 .Bd -literal -offset indent
1172 signals to all processes in the jail \(em be careful not to run this from
1173 the host environment!
1174 Once all of the jail's processes have died, unless the jail was created
1177 parameter, the jail will be removed.
1179 the intended use of the jail, you may also want to run
1180 .Pa /etc/rc.shutdown
1181 from within the jail.
1183 To shut down the jail from the outside, simply remove it with
1186 which will run any commands specified by
1192 to any remaining jailed processes.
1195 .Pa /proc/ Ns Ar pid Ns Pa /status
1196 file contains, as its last field, the name of the jail in which the
1199 to indicate that the process is not running within a jail.
1202 command also shows a
1204 flag for processes in a jail.
1206 You can also list/kill processes based on their jail ID.
1207 To show processes and their jail ID, use the following command:
1209 .Dl "ps ax -o pid,jid,args"
1211 To show and then kill processes in jail number 3 use the following commands:
1212 .Bd -literal -offset indent
1219 .Ss "Jails and File Systems"
1220 It is not possible to
1224 any file system inside a jail unless the file system is marked
1225 jail-friendly, the jail's
1227 parameter is set, and the jail's
1229 parameter is lower than 2.
1231 Multiple jails sharing the same file system can influence each other.
1232 For example, a user in one jail can fill the file system,
1233 leaving no space for processes in the other jail.
1236 to prevent this will not work either, as the file system quotas
1237 are not aware of jails but only look at the user and group IDs.
1238 This means the same user ID in two jails share a single file
1240 One would need to use one file system per jail to make this work.
1241 .Ss "Sysctl MIB Entries"
1243 .Va security.jail.jailed
1244 can be used to determine if a process is running inside a jail (value
1245 is one) or not (value is zero).
1248 .Va security.jail.max_af_ips
1249 determines how may address per address family a jail may have.
1252 Some MIB variables have per-jail settings.
1253 Changes to these variables by a jailed process do not affect the host
1254 environment, only the jail environment.
1256 .Va kern.securelevel ,
1258 .Va kern.domainname ,
1262 .Ss "Hierarchical Jails"
1265 parameter, processes within a jail may be able to create jails of their own.
1266 These child jails are kept in a hierarchy, with jails only able to see and/or
1267 modify the jails they created (or those jails' children).
1268 Each jail has a read-only
1270 parameter, containing the
1272 of the jail that created it; a
1274 of 0 indicates the jail is a child of the current jail (or is a top-level
1275 jail if the current process isn't jailed).
1277 Jailed processes are not allowed to confer greater permissions than they
1278 themselves are given, e.g., if a jail is created with
1280 it is not able to create a jail with
1283 Similarly, such restrictions as
1287 may not be bypassed in child jails.
1289 A child jail may in turn create its own child jails if its own
1291 parameter is set (remember it is zero by default).
1292 These jails are visible to and can be modified by their parent and all
1295 Jail names reflect this hierarchy, with a full name being an MIB-type string
1297 For example, if a base system process creates a jail
1299 and a process under that jail creates another jail
1301 then the second jail will be seen as
1303 in the base system (though it is only seen as
1305 to any processes inside jail
1307 Jids on the other hand exist in a single space, and each jail must have a
1310 Like the names, a child jail's
1312 appears relative to its creator's own
1314 This is by virtue of the child jail being created in the chrooted
1315 environment of the first jail.
1356 Hierarchical/extensible jails were introduced in
1358 The configuration file was introduced in
1362 The jail feature was written by
1363 .An Poul-Henning Kamp
1365 who contributed it to
1369 wrote the extended documentation, found a few bugs, added
1370 a few new features, and cleaned up the userland jail environment.
1373 added multi-IP jail support for IPv4 and IPv6 based on a patch
1375 .An Pawel Jakub Dawidek
1379 added the extensible jail parameters, hierarchical jails,
1380 and the configuration file.
1382 It might be a good idea to add an
1383 address alias flag such that daemons listening on all IPs
1385 will not bind on that address, which would facilitate building a safe
1386 host environment such that host daemons do not impose on services offered
1388 Currently, the simplest answer is to minimize services
1389 offered on the host, possibly limiting it to services offered from
1391 which is easily configurable.
1393 Great care should be taken when managing directories visible within the jail.
1394 For example, if a jailed process has its current working directory set to a
1395 directory that is moved out of the jail's chroot, then the process may gain
1396 access to the file space outside of the jail.
1397 It is recommended that directories always be copied, rather than moved, out
1400 In addition, there are several ways in which an unprivileged user
1401 outside the jail can cooperate with a privileged user inside the jail
1402 and thereby obtain elevated privileges in the host environment.
1403 Most of these attacks can be mitigated by ensuring that the jail root
1404 is not accessible to unprivileged users in the host environment.
1405 Regardless, as a general rule, untrusted users with privileged access
1406 to a jail should not be given access to the host environment.