7 # REQUIRE: LOGIN FILESYSTEMS
9 # KEYWORD: nojail shutdown
14 desc="Manage system jails"
17 start_cmd="jail_start"
18 start_postcmd="jail_warn"
20 config_cmd="jail_config"
21 console_cmd="jail_console"
22 status_cmd="jail_status"
23 extra_commands="config console status"
24 : ${jail_conf:=/etc/jail.conf}
25 : ${jail_program:=/usr/sbin/jail}
26 : ${jail_consolecmd:=/usr/bin/login -f root}
27 : ${jail_jexec:=/usr/sbin/jexec}
28 : ${jail_jls:=/usr/sbin/jls}
32 # extract_var jv name param num defval
33 # Extract value from ${jail_$jv_$name} or ${jail_$name} and
34 # set it to $param. If not defined, $defval is used.
35 # When $num is [0-9]*, ${jail_$jv_$name$num} are looked up and
36 # $param is set by using +=. $num=0 is optional (params may start at 1).
37 # When $num is YN or NY, the value is interpreted as boolean.
38 # When $num is @, the value is interpreted as an array separted by IFS.
41 local i _jv _name _param _num _def _name1 _name2
50 _name1=jail_${_jv}_${_name}
52 eval $_name1=\"\${$_name1:-\${$_name2:-$_def}}\"
53 if checkyesno $_name1; then
60 _name1=jail_${_jv}_${_name}
62 eval $_name1=\"\${$_name1:-\${$_name2:-$_def}}\"
63 if checkyesno $_name1; then
72 _name1=jail_${_jv}_${_name}${i}
73 _name2=jail_${_name}${i}
74 eval _tmpargs=\"\${$_name1:-\${$_name2:-$_def}}\"
75 if [ -n "$_tmpargs" ]; then
76 echo " $_param += \"$_tmpargs\";"
77 elif [ $i != 0 ]; then
84 _name1=jail_${_jv}_${_name}
86 eval _tmpargs=\"\${$_name1:-\${$_name2:-$_def}}\"
90 while [ $# -gt 1 ]; do
98 _name1=jail_${_jv}_${_name}
100 eval _tmpargs=\"\${$_name1:-\${$_name2:-$_def}}\"
101 if [ -n "$_tmpargs" ]; then
102 echo " $_param = \"$_tmpargs\";"
108 # parse_options _j _jv
109 # Parse options and create a temporary configuration file if necessary.
118 if [ -z "$_j" ]; then
119 warn "parse_options: you must specify a jail"
122 eval _jconf=\"\${jail_${_jv}_conf:-/etc/jail.${_j}.conf}\"
123 eval _rootdir=\"\$jail_${_jv}_rootdir\"
124 eval _hostname=\"\$jail_${_jv}_hostname\"
125 if [ -z "$_rootdir" -o \
126 -z "$_hostname" ]; then
127 if [ -r "$_jconf" ]; then
130 elif [ -r "$jail_conf" ]; then
134 warn "Invalid configuration for $_j " \
135 "(no jail.conf, no hostname, or no path). " \
136 "Jail $_j was ignored."
140 eval _ip=\"\$jail_${_jv}_ip\"
141 if [ -z "$_ip" ] && ! check_kern_features vimage; then
142 warn "no ipaddress specified and no vimage support. " \
143 "Jail $_j was ignored."
146 _conf=/var/run/jail.${_j}.conf
148 # To relieve confusion, show a warning message.
151 if [ -r "$jail_conf" -o -r "$_jconf" ]; then
152 if ! checkyesno jail_parallel_start; then
153 warn "$_conf is created and used for jail $_j."
156 /usr/bin/install -m 0644 -o root -g wheel /dev/null $_conf || return 1
158 eval : \${jail_${_jv}_flags:=${jail_flags}}
159 eval _exec=\"\$jail_${_jv}_exec\"
160 eval _exec_start=\"\$jail_${_jv}_exec_start\"
161 eval _exec_stop=\"\$jail_${_jv}_exec_stop\"
162 if [ -n "${_exec}" ]; then
163 # simple/backward-compatible execution
164 _exec_start="${_exec}"
168 if [ -z "${_exec_start}" ]; then
169 _exec_start="/bin/sh /etc/rc"
170 if [ -z "${_exec_stop}" ]; then
171 _exec_stop="/bin/sh /etc/rc.shutdown"
175 eval _interface=\"\${jail_${_jv}_interface:-${jail_interface}}\"
176 eval _parameters=\"\${jail_${_jv}_parameters:-${jail_parameters}}\"
177 eval _fstab=\"\${jail_${_jv}_fstab:-${jail_fstab:-/etc/fstab.$_j}}\"
179 date +"# Generated by rc.d/jail at %Y-%m-%d %H:%M:%S"
181 extract_var $_jv hostname host.hostname - ""
182 extract_var $_jv rootdir path - ""
183 if [ -n "$_ip" ]; then
184 extract_var $_jv interface interface - ""
185 jail_handle_ips_option $_ip $_interface
188 eval _x=\"\$jail_${_jv}_ip_multi${alias}\"
189 [ -z "$_x" ] && break
191 jail_handle_ips_option $_x $_interface
192 alias=$(($alias + 1))
194 case $need_dad_wait in
196 # Sleep to let DAD complete before
198 echo " exec.start += \"sleep " \
199 $(($(${SYSCTL_N} net.inet6.ip6.dad_count) + 1)) \
203 # These are applicable only to non-vimage jails.
204 extract_var $_jv fib exec.fib - ""
205 extract_var $_jv socket_unixiproute_only \
206 allow.raw_sockets NY YES
209 extract_var $_jv vnet_interface vnet.interface @ ""
213 echo " exec.system_user = \"root\";"
214 echo " exec.jail_user = \"root\";"
215 extract_var $_jv exec_prestart exec.prestart 0 ""
216 extract_var $_jv exec_poststart exec.poststart 0 ""
217 extract_var $_jv exec_prestop exec.prestop 0 ""
218 extract_var $_jv exec_poststop exec.poststop 0 ""
220 echo " exec.start += \"$_exec_start\";"
221 extract_var $_jv exec_afterstart exec.start 0 ""
222 echo " exec.stop = \"$_exec_stop\";"
224 extract_var $_jv consolelog exec.consolelog - \
225 /var/log/jail_${_j}_console.log
227 if [ -r $_fstab ]; then
228 echo " mount.fstab = \"$_fstab\";"
231 eval : \${jail_${_jv}_devfs_enable:=${jail_devfs_enable:-NO}}
232 if checkyesno jail_${_jv}_devfs_enable; then
234 eval _ruleset=\${jail_${_jv}_devfs_ruleset:-${jail_devfs_ruleset}}
237 [0-9]*) echo " devfs_ruleset = \"$_ruleset\";" ;;
239 # XXX: This is the default value,
240 # Let jail(8) to use the default because
241 # mount(8) only accepts an integer.
242 # This should accept a ruleset name.
244 *) warn "devfs_ruleset must be an integer." ;;
247 eval : \${jail_${_jv}_fdescfs_enable:=${jail_fdescfs_enable:-NO}}
248 if checkyesno jail_${_jv}_fdescfs_enable; then
249 echo " mount.fdescfs;"
251 eval : \${jail_${_jv}_procfs_enable:=${jail_procfs_enable:-NO}}
252 if checkyesno jail_${_jv}_procfs_enable; then
253 echo " mount.procfs;"
256 eval : \${jail_${_jv}_mount_enable:=${jail_mount_enable:-NO}}
257 if checkyesno jail_${_jv}_mount_enable; then
261 extract_var $_jv set_hostname_allow allow.set_hostname YN NO
262 extract_var $_jv sysvipc_allow allow.sysvipc YN NO
263 extract_var $_jv enforce_statfs enforce_statfs - 2
264 extract_var $_jv osreldate osreldate
265 extract_var $_jv osrelease osrelease
266 for _p in $_parameters; do
275 # jail_extract_address argument iface
276 # The second argument is the string from one of the _ip
277 # or the _multi variables. In case of a comma separated list
278 # only one argument must be passed in at a time.
279 # The function alters the _type, _iface, _addr and _mask variables.
281 jail_extract_address()
287 if [ -z "${_i}" ]; then
288 warn "jail_extract_address: called without input"
292 # Check if we have an interface prefix given and split into
295 *\|*) # ifN|.. prefix there
304 # In case the IP has no interface given, check if we have a global one.
305 _iface=${_iface:-${_interface}}
307 # Set address, cut off any prefix/netmask/prefixlen.
309 _addr=${_addr%%[/ ]*}
311 # Theoretically we can return here if interface is not set,
312 # as we only care about the _mask if we call ifconfig.
313 # This is not done because we may want to santize IP addresses
314 # based on _type later, and optionally change the type as well.
316 # Extract the prefix/netmask/prefixlen part by cutting off the address.
318 _mask=`expr "${_mask}" : "${_addr}\(.*\)"`
320 # Identify type {inet,inet6}.
322 *\.*\.*\.*) _type="inet" ;;
323 *:*) _type="inet6" ;;
324 *) warn "jail_extract_address: type not identified"
328 # Handle the special /netmask instead of /prefix or
329 # "netmask xxx" case for legacy IP.
330 # We do NOT support shortend class-full netmasks.
331 if [ "${_type}" = "inet" ]; then
333 /*\.*\.*\.*) _mask=" netmask ${_mask#/}" ;;
337 # In case _mask is still not set use /32.
340 elif [ "${_type}" = "inet6" ]; then
341 # In case _mask is not set for IPv6, use /128.
346 # jail_handle_ips_option input iface
347 # Handle a single argument imput which can be a comma separated
348 # list of addresses (theoretically with an option interface and
349 # prefix/netmask/prefixlen).
351 jail_handle_ips_option()
353 local _x _type _i _defif
357 if [ -z "${_x}" ]; then
358 # No IP given. This can happen for the primary address
359 # of each address family.
363 # Loop, in case we find a comma separated list, we need to handle
364 # each argument on its own.
365 while [ ${#_x} -gt 0 ]; do
367 *,*) # Extract the first argument and strip it off the list.
368 _i=`expr "${_x}" : '^\([^,]*\)'`
369 _x=`expr "${_x}" : "^[^,]*,\(.*\)"`
380 jail_extract_address $_i $_defif
382 # make sure we got an address.
388 # Append address to list of addresses for the jail command.
391 echo " ip4.addr += \"${_iface:+${_iface}|}${_addr}${_mask}\";"
394 echo " ip6.addr += \"${_iface:+${_iface}|}${_addr}${_mask}\";"
409 _j=$(echo $_j | tr /. _)
410 _jv=$(echo -n $_j | tr -c '[:alnum:]' _)
411 if parse_options $_j $_jv; then
412 echo "$_j: parameters are in $_conf."
421 # One argument that is not _ALL.
423 0:*|1:_ALL) err 3 "Specify a jail name." ;;
426 _j=$(echo $1 | tr /. _)
427 _jv=$(echo -n $1 | tr -c '[:alnum:]' _)
430 0) eval _cmd=\${jail_${_jv}_consolecmd:-$jail_consolecmd} ;;
433 $jail_jexec $_j $_cmd
444 local _j _jv _jid _id _name
449 echo -n 'Starting jails:'
452 command=$jail_program
454 command_args="-f $jail_conf -c"
455 if ! checkyesno jail_parallel_start; then
456 command_args="$command_args -p1"
458 _tmp=`mktemp -t jail` || exit 3
459 if $command $rc_flags $command_args >> $_tmp 2>&1; then
460 $jail_jls jid name | while read _id _name; do
462 echo $_id > /var/run/jail_${_name}.id
472 if checkyesno jail_parallel_start; then
474 # Start jails in parallel and then check jail id when
475 # jail_parallel_start is YES.
478 _j=$(echo $_j | tr /. _)
479 _jv=$(echo -n $_j | tr -c '[:alnum:]' _)
480 parse_options $_j $_jv || continue
482 eval rc_flags=\${jail_${_jv}_flags:-$jail_flags}
483 eval command=\${jail_${_jv}_program:-$jail_program}
484 command_args="-i -f $_conf -c $_j"
486 _tmp=`mktemp -t jail_${_j}` || exit 3
487 if $command $rc_flags $command_args \
488 >> $_tmp 2>&1 </dev/null; then
489 echo -n " ${_hostname:-${_j}}"
490 _jid=$($jail_jls -j $_j jid)
491 echo $_jid > /var/run/jail_${_j}.id
493 echo " cannot start jail " \
494 "\"${_hostname:-${_j}}\": "
503 # Start jails one-by-one when jail_parallel_start is NO.
506 _j=$(echo $_j | tr /. _)
507 _jv=$(echo -n $_j | tr -c '[:alnum:]' _)
508 parse_options $_j $_jv || continue
510 eval rc_flags=\${jail_${_jv}_flags:-$jail_flags}
511 eval command=\${jail_${_jv}_program:-$jail_program}
512 command_args="-i -f $_conf -c $_j"
513 _tmp=`mktemp -t jail` || exit 3
514 if $command $rc_flags $command_args \
515 >> $_tmp 2>&1 </dev/null; then
516 echo -n " ${_hostname:-${_j}}"
517 _jid=$($jail_jls -j $_j jid)
518 echo $_jid > /var/run/jail_${_j}.id
520 echo " cannot start jail " \
521 "\"${_hostname:-${_j}}\": "
537 echo -n 'Stopping jails:'
540 command=$jail_program
542 command_args="-f $jail_conf -r"
543 if checkyesno jail_reverse_stop; then
544 $jail_jls name | tail -r
547 fi | while read _j; do
549 _tmp=`mktemp -t jail` || exit 3
550 $command $rc_flags $command_args $_j >> $_tmp 2>&1
551 if $jail_jls -j $_j > /dev/null 2>&1; then
554 rm -f /var/run/jail_${_j}.id
562 checkyesno jail_reverse_stop && set -- $(reverse_list $@)
564 _j=$(echo $_j | tr /. _)
565 _jv=$(echo -n $_j | tr -c '[:alnum:]' _)
566 parse_options $_j $_jv || continue
567 if ! $jail_jls -j $_j > /dev/null 2>&1; then
570 eval command=\${jail_${_jv}_program:-$jail_program}
571 echo -n " ${_hostname:-${_j}}"
572 _tmp=`mktemp -t jail` || exit 3
573 $command -q -f $_conf -r $_j >> $_tmp 2>&1
574 if $jail_jls -j $_j > /dev/null 2>&1; then
577 rm -f /var/run/jail_${_j}.id
587 # To relieve confusion, show a warning message.
589 1) warn "Per-jail configuration via jail_* variables " \
590 "is obsolete. Please consider migrating to $jail_conf."
597 1) run_rc_command $@ ${jail_list:-_ALL} ;;
598 *) jail_reverse_stop="no"