7 # REQUIRE: LOGIN cleanvar
9 # KEYWORD: nojail shutdown
11 # WARNING: This script deals with untrusted data (the data and
12 # processes inside the jails) and care must be taken when changing the
13 # code related to this! If you have any doubt whether a change is
14 # correct and have security impact, please get the patch reviewed by
15 # the FreeBSD Security Team prior to commit.
21 start_cmd="jail_start"
25 # Initialize the various jail variables for jail _j.
32 warn "init_variables: you must specify a jail"
36 eval _rootdir=\"\$jail_${_j}_rootdir\"
37 _devdir="${_rootdir}/dev"
38 _fdescdir="${_devdir}/fd"
39 _procdir="${_rootdir}/proc"
40 eval _hostname=\"\$jail_${_j}_hostname\"
41 eval _ip=\"\$jail_${_j}_ip\"
42 eval _interface=\"\${jail_${_j}_interface:-${jail_interface}}\"
43 eval _exec=\"\$jail_${_j}_exec\"
47 eval _exec_prestart${i}=\"\${jail_${_j}_exec_prestart${i}:-\${jail_exec_prestart${i}}}\"
48 [ -z "$(eval echo \"\$_exec_prestart${i}\")" ] && break
52 eval _exec_start=\"\${jail_${_j}_exec_start:-${jail_exec_start}}\"
56 eval _exec_afterstart${i}=\"\${jail_${_j}_exec_afterstart${i}:-\${jail_exec_afterstart${i}}}\"
57 [ -z "$(eval echo \"\$_exec_afterstart${i}\")" ] && break
63 eval _exec_poststart${i}=\"\${jail_${_j}_exec_poststart${i}:-\${jail_exec_poststart${i}}}\"
64 [ -z "$(eval echo \"\$_exec_poststart${i}\")" ] && break
70 eval _exec_prestop${i}=\"\${jail_${_j}_exec_prestop${i}:-\${jail_exec_prestop${i}}}\"
71 [ -z "$(eval echo \"\$_exec_prestop${i}\")" ] && break
75 eval _exec_stop=\"\${jail_${_j}_exec_stop:-${jail_exec_stop}}\"
79 eval _exec_poststop${i}=\"\${jail_${_j}_exec_poststop${i}:-\${jail_exec_poststop${i}}}\"
80 [ -z "$(eval echo \"\$_exec_poststop${i}\")" ] && break
84 if [ -n "${_exec}" ]; then
85 # simple/backward-compatible execution
86 _exec_start="${_exec}"
90 if [ -z "${_exec_start}" ]; then
91 _exec_start="/bin/sh /etc/rc"
92 if [ -z "${_exec_stop}" ]; then
93 _exec_stop="/bin/sh /etc/rc.shutdown"
98 # The default jail ruleset will be used by rc.subr if none is specified.
99 eval _ruleset=\"\${jail_${_j}_devfs_ruleset:-${jail_devfs_ruleset}}\"
100 eval _devfs=\"\${jail_${_j}_devfs_enable:-${jail_devfs_enable}}\"
101 [ -z "${_devfs}" ] && _devfs="NO"
102 eval _fdescfs=\"\${jail_${_j}_fdescfs_enable:-${jail_fdescfs_enable}}\"
103 [ -z "${_fdescfs}" ] && _fdescfs="NO"
104 eval _procfs=\"\${jail_${_j}_procfs_enable:-${jail_procfs_enable}}\"
105 [ -z "${_procfs}" ] && _procfs="NO"
107 eval _mount=\"\${jail_${_j}_mount_enable:-${jail_mount_enable}}\"
108 [ -z "${_mount}" ] && _mount="NO"
109 # "/etc/fstab.${_j}" will be used for {,u}mount(8) if none is specified.
110 eval _fstab=\"\${jail_${_j}_fstab:-${jail_fstab}}\"
111 [ -z "${_fstab}" ] && _fstab="/etc/fstab.${_j}"
112 eval _flags=\"\${jail_${_j}_flags:-${jail_flags}}\"
113 [ -z "${_flags}" ] && _flags="-l -U root"
114 eval _consolelog=\"\${jail_${_j}_consolelog:-${jail_consolelog}}\"
115 [ -z "${_consolelog}" ] && _consolelog="/var/log/jail_${_j}_console.log"
116 eval _parameters=\"\${jail_${_j}_parameters:-${jail_parameters}}\"
117 [ -z "${_parameters}" ] && _parameters=""
118 eval _fib=\"\${jail_${_j}_fib:-${jail_fib}}\"
122 debug "$_j devfs enable: $_devfs"
123 debug "$_j fdescfs enable: $_fdescfs"
124 debug "$_j procfs enable: $_procfs"
125 debug "$_j mount enable: $_mount"
126 debug "$_j hostname: $_hostname"
128 jail_show_addresses ${_j}
129 debug "$_j interface: $_interface"
130 debug "$_j fib: $_fib"
131 debug "$_j root: $_rootdir"
132 debug "$_j devdir: $_devdir"
133 debug "$_j fdescdir: $_fdescdir"
134 debug "$_j procdir: $_procdir"
135 debug "$_j ruleset: $_ruleset"
136 debug "$_j fstab: $_fstab"
140 eval out=\"\${_exec_prestart${i}:-''}\"
141 if [ -z "$out" ]; then
144 debug "$_j exec pre-start #${i}: ${out}"
148 debug "$_j exec start: $_exec_start"
152 eval out=\"\${_exec_afterstart${i}:-''}\"
154 if [ -z "$out" ]; then
158 debug "$_j exec after start #${i}: ${out}"
164 eval out=\"\${_exec_poststart${i}:-''}\"
165 if [ -z "$out" ]; then
168 debug "$_j exec post-start #${i}: ${out}"
174 eval out=\"\${_exec_prestop${i}:-''}\"
175 if [ -z "$out" ]; then
178 debug "$_j exec pre-stop #${i}: ${out}"
182 debug "$_j exec stop: $_exec_stop"
186 eval out=\"\${_exec_poststop${i}:-''}\"
187 if [ -z "$out" ]; then
190 debug "$_j exec post-stop #${i}: ${out}"
194 debug "$_j flags: $_flags"
195 debug "$_j consolelog: $_consolelog"
196 debug "$_j parameters: $_parameters"
198 if [ -z "${_hostname}" ]; then
199 err 3 "$name: No hostname has been defined for ${_j}"
201 if [ -z "${_rootdir}" ]; then
202 err 3 "$name: No root directory has been defined for ${_j}"
206 # set_sysctl rc_knob mib msg
207 # If the mib sysctl is set according to what rc_knob
208 # specifies, this function does nothing. However if
209 # rc_knob is set differently than mib, then the mib
210 # is set accordingly and msg is displayed followed by
211 # an '=" sign and the word 'YES' or 'NO'.
219 _current=`${SYSCTL} -n $_mib 2>/dev/null`
220 if checkyesno $_knob ; then
221 if [ "$_current" -ne 1 ]; then
222 echo -n " ${_msg}=YES"
223 ${SYSCTL_W} 1>/dev/null ${_mib}=1
226 if [ "$_current" -ne 0 ]; then
227 echo -n " ${_msg}=NO"
228 ${SYSCTL_W} 1>/dev/null ${_mib}=0
233 # is_current_mountpoint()
234 # Is the directory mount point for a currently mounted file
237 is_current_mountpoint()
243 _dir=`echo $_dir | sed -Ee 's#//+#/#g' -e 's#/$##'`
244 [ ! -d "${_dir}" ] && return 1
245 _dir2=`df ${_dir} | tail +2 | awk '{ print $6 }'`
246 [ "${_dir}" = "${_dir2}" ]
250 # is_symlinked_mountpoint()
251 # Is a mount point, or any of its parent directories, a symlink?
253 is_symlinked_mountpoint()
259 [ -L "$_dir" ] && return 0
260 [ "$_dir" = "/" ] && return 1
261 is_symlinked_mountpoint `dirname $_dir`
266 # Try to unmount a mount point without being vulnerable to
275 if is_current_mountpoint ${_dir}; then
276 umount -f ${_dir} >/dev/null 2>&1
278 debug "Nothing mounted on ${_dir} - not unmounting"
284 # This function unmounts certain special filesystems in the
285 # currently selected jail. The caller must call the init_variables()
286 # routine before calling this one.
290 local _device _mountpt _rest
292 if checkyesno _fdescfs; then
293 if [ -d "${_fdescdir}" ] ; then
294 secure_umount ${_fdescdir}
297 if checkyesno _devfs; then
298 if [ -d "${_devdir}" ] ; then
299 secure_umount ${_devdir}
302 if checkyesno _procfs; then
303 if [ -d "${_procdir}" ] ; then
304 secure_umount ${_procdir}
307 if checkyesno _mount; then
308 [ -f "${_fstab}" ] || warn "${_fstab} does not exist"
309 tail -r ${_fstab} | while read _device _mountpt _rest; do
310 case ":${_device}" in
315 secure_umount ${_mountpt}
321 # Mount file systems from a per jail fstab while trying to
322 # secure against symlink attacks at the mount points.
324 # If we are certain we cannot secure against symlink attacks we
325 # do not mount all of the file systems (since we cannot just not
326 # mount the file system with the problematic mount point).
328 # The caller must call the init_variables() routine before
333 local _device _mountpt _rest
335 while read _device _mountpt _rest; do
336 case ":${_device}" in
341 if is_symlinked_mountpoint ${_mountpt}; then
342 warn "${_mountpt} has symlink as parent - not mounting from ${_fstab}"
346 mount -a -F "${_fstab}"
349 # jail_show_addresses jail
350 # Debug print the input for the given _multi aliases
351 # for a jail for init_variables().
353 jail_show_addresses()
359 if [ -z "${_j}" ]; then
360 warn "jail_show_addresses: you must specify a jail"
365 eval _addr=\"\$jail_${_j}_ip_multi${alias}\"
366 if [ -n "${_addr}" ]; then
367 debug "${_j} ip_multi${alias}: $_addr"
368 alias=$((${alias} + 1))
375 # jail_extract_address argument
376 # The second argument is the string from one of the _ip
377 # or the _multi variables. In case of a comma separated list
378 # only one argument must be passed in at a time.
379 # The function alters the _type, _iface, _addr and _mask variables.
381 jail_extract_address()
386 if [ -z "${_i}" ]; then
387 warn "jail_extract_address: called without input"
391 # Check if we have an interface prefix given and split into
394 *\|*) # ifN|.. prefix there
403 # In case the IP has no interface given, check if we have a global one.
404 _iface=${_iface:-${_interface}}
406 # Set address, cut off any prefix/netmask/prefixlen.
408 _addr=${_addr%%[/ ]*}
410 # Theoretically we can return here if interface is not set,
411 # as we only care about the _mask if we call ifconfig.
412 # This is not done because we may want to santize IP addresses
413 # based on _type later, and optionally change the type as well.
415 # Extract the prefix/netmask/prefixlen part by cutting off the address.
417 _mask=`expr "${_mask}" : "${_addr}\(.*\)"`
419 # Identify type {inet,inet6}.
421 *\.*\.*\.*) _type="inet" ;;
422 *:*) _type="inet6" ;;
423 *) warn "jail_extract_address: type not identified"
427 # Handle the special /netmask instead of /prefix or
428 # "netmask xxx" case for legacy IP.
429 # We do NOT support shortend class-full netmasks.
430 if [ "${_type}" = "inet" ]; then
432 /*\.*\.*\.*) _mask=" netmask ${_mask#/}" ;;
436 # In case _mask is still not set use /32.
439 elif [ "${_type}" = "inet6" ]; then
440 # In case _maske is not set for IPv6, use /128.
445 # jail_handle_ips_option {add,del} input
446 # Handle a single argument imput which can be a comma separated
447 # list of addresses (theoretically with an option interface and
448 # prefix/netmask/prefixlen).
450 jail_handle_ips_option()
452 local _x _action _type _i
456 if [ -z "${_x}" ]; then
457 # No IP given. This can happen for the primary address
458 # of each address family.
462 # Loop, in case we find a comma separated list, we need to handle
463 # each argument on its own.
464 while [ ${#_x} -gt 0 ]; do
466 *,*) # Extract the first argument and strip it off the list.
467 _i=`expr "${_x}" : '^\([^,]*\)'`
468 _x=`expr "${_x}" : "^[^,]*,\(.*\)"`
479 jail_extract_address "${_i}"
481 # make sure we got an address.
487 # Append address to list of addresses for the jail command.
491 "") _addrl="${_addr}" ;;
492 *) _addrl="${_addrl},${_addr}" ;;
497 "") _addr6l="${_addr}" ;;
498 *) _addr6l="${_addr6l},${_addr}" ;;
503 # Configure interface alias if requested by a given interface
504 # and if we could correctly parse everything.
510 inet6) ipv6_address_count=$((ipv6_address_count + 1)) ;;
511 *) warn "Could not determine address family. Not going" \
512 "to ${_action} address '${_addr}' for ${_jail}."
517 add) ifconfig ${_iface} ${_type} ${_addr}${_mask} alias
519 del) # When removing the IP, ignore the _mask.
520 ifconfig ${_iface} ${_type} ${_addr} -alias
527 # Extract the comma separated list of addresses and return them
528 # for the jail command.
529 # Handle more than one address via the _multi option as well.
530 # If an interface is given also add/remove an alias for the
531 # address with an optional netmask.
541 *) warn "jail_ips: invalid action '${_action}'"
548 jail_handle_ips_option ${_action} "${_ip}"
549 # Handle jail_xxx_ip_multi<N>
552 eval _x=\"\$jail_${_jail}_ip_multi${alias}\"
555 *) jail_handle_ips_option ${_action} "${_x}"
556 alias=$((${alias} + 1))
560 case ${ipv6_address_count} in
562 *) # Sleep 1 second to let DAD complete before starting services.
570 echo -n 'Configuring jails:'
571 set_sysctl jail_set_hostname_allow security.jail.set_hostname_allowed \
573 set_sysctl jail_socket_unixiproute_only \
574 security.jail.socket_unixiproute_only unixiproute_only
575 set_sysctl jail_sysvipc_allow security.jail.sysvipc_allowed \
579 echo -n 'Starting jails:'
580 _tmp_dir=`mktemp -d /tmp/jail.XXXXXXXX` || \
581 err 3 "$name: Can't create temp dir, exiting..."
582 for _jail in ${jail_list}
584 init_variables $_jail
585 if [ -f /var/run/jail_${_jail}.id ]; then
586 echo -n " [${_hostname} already running (/var/run/jail_${_jail}.id exists)]"
592 if [ -n "${_fib}" ]; then
593 _setfib="setfib -F '${_fib}'"
597 if checkyesno _mount; then
598 info "Mounting fstab for jail ${_jail} (${_fstab})"
599 if [ ! -f "${_fstab}" ]; then
600 err 3 "$name: ${_fstab} does not exist"
604 if checkyesno _devfs; then
605 # If devfs is already mounted here, skip it.
606 df -t devfs "${_devdir}" >/dev/null
607 if [ $? -ne 0 ]; then
608 if is_symlinked_mountpoint ${_devdir}; then
609 warn "${_devdir} has symlink as parent - not starting jail ${_jail}"
612 info "Mounting devfs on ${_devdir}"
613 devfs_mount_jail "${_devdir}" ${_ruleset}
614 # Transitional symlink for old binaries
615 if [ ! -L "${_devdir}/log" ]; then
616 ln -sf ../var/run/log "${_devdir}/log"
620 # XXX - It seems symlinks don't work when there
621 # is a devfs(5) device of the same name.
622 # Jail console output
625 # ln -sf ../var/log/console console
628 if checkyesno _fdescfs; then
629 if is_symlinked_mountpoint ${_fdescdir}; then
630 warn "${_fdescdir} has symlink as parent, not mounting"
632 info "Mounting fdescfs on ${_fdescdir}"
633 mount -t fdescfs fdesc "${_fdescdir}"
636 if checkyesno _procfs; then
637 if is_symlinked_mountpoint ${_procdir}; then
638 warn "${_procdir} has symlink as parent, not mounting"
640 info "Mounting procfs onto ${_procdir}"
641 if [ -d "${_procdir}" ] ; then
642 mount -t procfs proc "${_procdir}"
646 _tmp_jail=${_tmp_dir}/jail.$$
650 eval out=\"\${_exec_prestart${i}:-''}\"
651 [ -z "$out" ] && break
656 eval ${_setfib} jail -n ${_jail} ${_flags} -i -c path=${_rootdir} host.hostname=${_hostname} \
657 ip4.addr=\"${_addrl}\" ip6.addr=\"${_addr6l}\" ${_parameters} command=${_exec_start} > ${_tmp_jail} 2>&1
659 if [ "$?" -eq 0 ] ; then
660 _jail_id=$(head -1 ${_tmp_jail})
663 eval out=\"\${_exec_afterstart${i}:-''}\"
665 if [ -z "$out" ]; then
669 jexec "${_jail_id}" ${out}
673 echo -n " $_hostname"
674 tail +2 ${_tmp_jail} >${_consolelog}
675 echo ${_jail_id} > /var/run/jail_${_jail}.id
679 eval out=\"\${_exec_poststart${i}:-''}\"
680 [ -z "$out" ] && break
687 echo " cannot start jail \"${_jail}\": "
698 echo -n 'Stopping jails:'
699 for _jail in ${jail_list}
701 if [ -f "/var/run/jail_${_jail}.id" ]; then
702 _jail_id=$(cat /var/run/jail_${_jail}.id)
703 if [ ! -z "${_jail_id}" ]; then
704 init_variables $_jail
708 eval out=\"\${_exec_prestop${i}:-''}\"
709 [ -z "$out" ] && break
714 if [ -n "${_exec_stop}" ]; then
715 eval env -i /usr/sbin/jexec ${_jail_id} ${_exec_stop} \
716 >> ${_consolelog} 2>&1
718 killall -j ${_jail_id} -TERM > /dev/null 2>&1
720 killall -j ${_jail_id} -KILL > /dev/null 2>&1
722 echo -n " $_hostname"
726 eval out=\"\${_exec_poststop${i}:-''}\"
727 [ -z "$out" ] && break
733 rm /var/run/jail_${_jail}.id
735 echo " cannot stop jail ${_jail}. No jail id in /var/run"
743 if [ $# -gt 0 ]; then
749 run_rc_command "${cmd}"