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 _fib=\"\${jail_${_j}_fib:-${jail_fib}}\"
120 debug "$_j devfs enable: $_devfs"
121 debug "$_j fdescfs enable: $_fdescfs"
122 debug "$_j procfs enable: $_procfs"
123 debug "$_j mount enable: $_mount"
124 debug "$_j hostname: $_hostname"
126 jail_show_addresses ${_j}
127 debug "$_j interface: $_interface"
128 debug "$_j fib: $_fib"
129 debug "$_j root: $_rootdir"
130 debug "$_j devdir: $_devdir"
131 debug "$_j fdescdir: $_fdescdir"
132 debug "$_j procdir: $_procdir"
133 debug "$_j ruleset: $_ruleset"
134 debug "$_j fstab: $_fstab"
135 debug "$_j consolelog: $_consolelog"
139 eval out=\"\${_exec_prestart${i}:-''}\"
140 if [ -z "$out" ]; then
143 debug "$_j exec pre-start #${i}: ${out}"
147 debug "$_j exec start: $_exec_start"
151 eval out=\"\${_exec_afterstart${i}:-''}\"
153 if [ -z "$out" ]; then
157 debug "$_j exec after start #${i}: ${out}"
163 eval out=\"\${_exec_poststart${i}:-''}\"
164 if [ -z "$out" ]; then
167 debug "$_j exec post-start #${i}: ${out}"
173 eval out=\"\${_exec_prestop${i}:-''}\"
174 if [ -z "$out" ]; then
177 debug "$_j exec pre-stop #${i}: ${out}"
181 debug "$_j exec stop: $_exec_stop"
185 eval out=\"\${_exec_poststop${i}:-''}\"
186 if [ -z "$out" ]; then
189 debug "$_j exec post-stop #${i}: ${out}"
193 debug "$_j flags: $_flags"
194 debug "$_j consolelog: $_consolelog"
196 if [ -z "${_hostname}" ]; then
197 err 3 "$name: No hostname has been defined for ${_j}"
199 if [ -z "${_rootdir}" ]; then
200 err 3 "$name: No root directory has been defined for ${_j}"
204 # set_sysctl rc_knob mib msg
205 # If the mib sysctl is set according to what rc_knob
206 # specifies, this function does nothing. However if
207 # rc_knob is set differently than mib, then the mib
208 # is set accordingly and msg is displayed followed by
209 # an '=" sign and the word 'YES' or 'NO'.
217 _current=`${SYSCTL} -n $_mib 2>/dev/null`
218 if checkyesno $_knob ; then
219 if [ "$_current" -ne 1 ]; then
220 echo -n " ${_msg}=YES"
221 ${SYSCTL_W} 1>/dev/null ${_mib}=1
224 if [ "$_current" -ne 0 ]; then
225 echo -n " ${_msg}=NO"
226 ${SYSCTL_W} 1>/dev/null ${_mib}=0
231 # is_current_mountpoint()
232 # Is the directory mount point for a currently mounted file
235 is_current_mountpoint()
241 _dir=`echo $_dir | sed -Ee 's#//+#/#g' -e 's#/$##'`
242 [ ! -d "${_dir}" ] && return 1
243 _dir2=`df ${_dir} | tail +2 | awk '{ print $6 }'`
244 [ "${_dir}" = "${_dir2}" ]
248 # is_symlinked_mountpoint()
249 # Is a mount point, or any of its parent directories, a symlink?
251 is_symlinked_mountpoint()
257 [ -L "$_dir" ] && return 0
258 [ "$_dir" = "/" ] && return 1
259 is_symlinked_mountpoint `dirname $_dir`
264 # Try to unmount a mount point without being vulnerable to
273 if is_current_mountpoint ${_dir}; then
274 umount -f ${_dir} >/dev/null 2>&1
276 debug "Nothing mounted on ${_dir} - not unmounting"
282 # This function unmounts certain special filesystems in the
283 # currently selected jail. The caller must call the init_variables()
284 # routine before calling this one.
288 local _device _mountpt _rest
290 if checkyesno _fdescfs; then
291 if [ -d "${_fdescdir}" ] ; then
292 secure_umount ${_fdescdir}
295 if checkyesno _devfs; then
296 if [ -d "${_devdir}" ] ; then
297 secure_umount ${_devdir}
300 if checkyesno _procfs; then
301 if [ -d "${_procdir}" ] ; then
302 secure_umount ${_procdir}
305 if checkyesno _mount; then
306 [ -f "${_fstab}" ] || warn "${_fstab} does not exist"
307 tail -r ${_fstab} | while read _device _mountpt _rest; do
308 case ":${_device}" in
313 secure_umount ${_mountpt}
319 # Mount file systems from a per jail fstab while trying to
320 # secure against symlink attacks at the mount points.
322 # If we are certain we cannot secure against symlink attacks we
323 # do not mount all of the file systems (since we cannot just not
324 # mount the file system with the problematic mount point).
326 # The caller must call the init_variables() routine before
331 local _device _mountpt _rest
333 while read _device _mountpt _rest; do
334 case ":${_device}" in
339 if is_symlinked_mountpoint ${_mountpt}; then
340 warn "${_mountpt} has symlink as parent - not mounting from ${_fstab}"
344 mount -a -F "${_fstab}"
347 # jail_show_addresses jail
348 # Debug print the input for the given _multi aliases
349 # for a jail for init_variables().
351 jail_show_addresses()
357 if [ -z "${_j}" ]; then
358 warn "jail_show_addresses: you must specify a jail"
363 eval _addr=\"\$jail_${_j}_ip_multi${alias}\"
364 if [ -n "${_addr}" ]; then
365 debug "${_j} ip_multi${alias}: $_addr"
366 alias=$((${alias} + 1))
373 # jail_extract_address argument
374 # The second argument is the string from one of the _ip
375 # or the _multi variables. In case of a comma separated list
376 # only one argument must be passed in at a time.
377 # The function alters the _type, _iface, _addr and _mask variables.
379 jail_extract_address()
384 if [ -z "${_i}" ]; then
385 warn "jail_extract_address: called without input"
389 # Check if we have an interface prefix given and split into
392 *\|*) # ifN|.. prefix there
401 # In case the IP has no interface given, check if we have a global one.
402 _iface=${_iface:-${_interface}}
404 # Set address, cut off any prefix/netmask/prefixlen.
406 _addr=${_addr%%[/ ]*}
408 # Theoretically we can return here if interface is not set,
409 # as we only care about the _mask if we call ifconfig.
410 # This is not done because we may want to santize IP addresses
411 # based on _type later, and optionally change the type as well.
413 # Extract the prefix/netmask/prefixlen part by cutting off the address.
415 _mask=`expr "${_mask}" : "${_addr}\(.*\)"`
417 # Identify type {inet,inet6}.
419 *\.*\.*\.*) _type="inet" ;;
420 *:*) _type="inet6" ;;
421 *) warn "jail_extract_address: type not identified"
425 # Handle the special /netmask instead of /prefix or
426 # "netmask xxx" case for legacy IP.
427 # We do NOT support shortend class-full netmasks.
428 if [ "${_type}" = "inet" ]; then
430 /*\.*\.*\.*) _mask=" netmask ${_mask#/}" ;;
434 # In case _mask is still not set use /32.
437 elif [ "${_type}" = "inet6" ]; then
438 # In case _maske is not set for IPv6, use /128.
443 # jail_handle_ips_option {add,del} input
444 # Handle a single argument imput which can be a comma separated
445 # list of addresses (theoretically with an option interface and
446 # prefix/netmask/prefixlen).
448 jail_handle_ips_option()
450 local _x _action _type _i
454 if [ -z "${_x}" ]; then
455 # No IP given. This can happen for the primary address
456 # of each address family.
460 # Loop, in case we find a comma separated list, we need to handle
461 # each argument on its own.
462 while [ ${#_x} -gt 0 ]; do
464 *,*) # Extract the first argument and strip it off the list.
465 _i=`expr "${_x}" : '^\([^,]*\)'`
466 _x=`expr "${_x}" : "^[^,]*,\(.*\)"`
477 jail_extract_address "${_i}"
479 # make sure we got an address.
485 # Append address to list of addresses for the jail command.
487 "") _addrl="${_addr}" ;;
488 *) _addrl="${_addrl},${_addr}" ;;
491 # Configure interface alias if requested by a given interface
492 # and if we could correctly parse everything.
499 *) warn "Could not determine address family. Not going" \
500 "to ${_action} address '${_addr}' for ${_jail}."
505 add) ifconfig ${_iface} ${_type} ${_addr}${_mask} alias
507 del) # When removing the IP, ignore the _mask.
508 ifconfig ${_iface} ${_type} ${_addr} -alias
515 # Extract the comma separated list of addresses and return them
516 # for the jail command.
517 # Handle more than one address via the _multi option as well.
518 # If an interface is given also add/remove an alias for the
519 # address with an optional netmask.
529 *) warn "jail_ips: invalid action '${_action}'"
535 jail_handle_ips_option ${_action} "${_ip}"
536 # Handle jail_xxx_ip_multi<N>
539 eval _x=\"\$jail_${_jail}_ip_multi${alias}\"
542 *) jail_handle_ips_option ${_action} "${_x}"
543 alias=$((${alias} + 1))
551 echo -n 'Configuring jails:'
552 set_sysctl jail_set_hostname_allow security.jail.set_hostname_allowed \
554 set_sysctl jail_socket_unixiproute_only \
555 security.jail.socket_unixiproute_only unixiproute_only
556 set_sysctl jail_sysvipc_allow security.jail.sysvipc_allowed \
560 echo -n 'Starting jails:'
561 _tmp_dir=`mktemp -d /tmp/jail.XXXXXXXX` || \
562 err 3 "$name: Can't create temp dir, exiting..."
563 for _jail in ${jail_list}
565 init_variables $_jail
566 if [ -f /var/run/jail_${_jail}.id ]; then
567 echo -n " [${_hostname} already running (/var/run/jail_${_jail}.id exists)]"
572 if [ -n "${_fib}" ]; then
573 _setfib="setfib -F '${_fib}'"
577 if checkyesno _mount; then
578 info "Mounting fstab for jail ${_jail} (${_fstab})"
579 if [ ! -f "${_fstab}" ]; then
580 err 3 "$name: ${_fstab} does not exist"
584 if checkyesno _devfs; then
585 # If devfs is already mounted here, skip it.
586 df -t devfs "${_devdir}" >/dev/null
587 if [ $? -ne 0 ]; then
588 if is_symlinked_mountpoint ${_devdir}; then
589 warn "${_devdir} has symlink as parent - not starting jail ${_jail}"
592 info "Mounting devfs on ${_devdir}"
593 devfs_mount_jail "${_devdir}" ${_ruleset}
594 # Transitional symlink for old binaries
595 if [ ! -L "${_devdir}/log" ]; then
598 ln -sf ../var/run/log log
603 # XXX - It seems symlinks don't work when there
604 # is a devfs(5) device of the same name.
605 # Jail console output
608 # ln -sf ../var/log/console console
611 if checkyesno _fdescfs; then
612 if is_symlinked_mountpoint ${_fdescdir}; then
613 warn "${_fdescdir} has symlink as parent, not mounting"
615 info "Mounting fdescfs on ${_fdescdir}"
616 mount -t fdescfs fdesc "${_fdescdir}"
619 if checkyesno _procfs; then
620 if is_symlinked_mountpoint ${_procdir}; then
621 warn "${_procdir} has symlink as parent, not mounting"
623 info "Mounting procfs onto ${_procdir}"
624 if [ -d "${_procdir}" ] ; then
625 mount -t procfs proc "${_procdir}"
629 _tmp_jail=${_tmp_dir}/jail.$$
633 eval out=\"\${_exec_prestart${i}:-''}\"
634 [ -z "$out" ] && break
639 eval ${_setfib} jail ${_flags} -i ${_rootdir} ${_hostname} \
640 \"${_addrl}\" ${_exec_start} > ${_tmp_jail} 2>&1
642 if [ "$?" -eq 0 ] ; then
643 _jail_id=$(head -1 ${_tmp_jail})
646 eval out=\"\${_exec_afterstart${i}:-''}\"
648 if [ -z "$out" ]; then
652 jexec "${_jail_id}" ${out}
656 echo -n " $_hostname"
657 tail +2 ${_tmp_jail} >${_consolelog}
658 echo ${_jail_id} > /var/run/jail_${_jail}.id
662 eval out=\"\${_exec_poststart${i}:-''}\"
663 [ -z "$out" ] && break
670 echo " cannot start jail \"${_jail}\": "
681 echo -n 'Stopping jails:'
682 for _jail in ${jail_list}
684 if [ -f "/var/run/jail_${_jail}.id" ]; then
685 _jail_id=$(cat /var/run/jail_${_jail}.id)
686 if [ ! -z "${_jail_id}" ]; then
687 init_variables $_jail
691 eval out=\"\${_exec_prestop${i}:-''}\"
692 [ -z "$out" ] && break
697 if [ -n "${_exec_stop}" ]; then
698 eval env -i /usr/sbin/jexec ${_jail_id} ${_exec_stop} \
699 >> ${_consolelog} 2>&1
701 killall -j ${_jail_id} -TERM > /dev/null 2>&1
703 killall -j ${_jail_id} -KILL > /dev/null 2>&1
705 echo -n " $_hostname"
709 eval out=\"\${_exec_poststop${i}:-''}\"
710 [ -z "$out" ] && break
716 rm /var/run/jail_${_jail}.id
718 echo " cannot stop jail ${_jail}. No jail id in /var/run"
726 if [ $# -gt 0 ]; then
732 run_rc_command "${cmd}"