etc/rc.d/jail

   1 #!/bin/sh
   2 #
   3 # $FreeBSD$
   4 #
   5
   6 # PROVIDE: jail
   7 # REQUIRE: LOGIN FILESYSTEMS
   8 # BEFORE: securelevel
   9 # KEYWORD: nojail shutdown
  10
  11 . /etc/rc.subr
  12
  13 name="jail"
  14 rcvar="jail_enable"
  15
  16 start_cmd="jail_start"
  17 start_postcmd="jail_warn"
  18 stop_cmd="jail_stop"
  19 config_cmd="jail_config"
  20 console_cmd="jail_console"
  21 status_cmd="jail_status"
  22 extra_commands="config console status"
  23 : ${jail_conf:=/etc/jail.conf}
  24 : ${jail_program:=/usr/sbin/jail}
  25 : ${jail_consolecmd:=/usr/bin/login -f root}
  26 : ${jail_jexec:=/usr/sbin/jexec}
  27 : ${jail_jls:=/usr/sbin/jls}
  28
  29 need_dad_wait=
  30
  31 # extact_var jail name param num defval
  32 #       Extract value from ${jail_$jail_$name} or ${jail_$name} and
  33 #       set it to $param.  If not defined, $defval is used.
  34 #       When $num is [0-9]*, ${jail_$jail_$name$num} are looked up and
  35 #       $param is set by using +=.
  36 #       When $num is YN or NY, the value is interpret as boolean.
  37 extract_var()
  38 {
  39         local i _j _name _param _num _def _name1 _name2
  40         _j=$1
  41         _name=$2
  42         _param=$3
  43         _num=$4
  44         _def=$5
  45
  46         case $_num in
  47         YN)
  48                 _name1=jail_${_j}_${_name}
  49                 _name2=jail_${_name}
  50                 eval $_name1=\"\${$_name1:-\${$_name2:-$_def}}\"
  51                 if checkyesno $_name1; then
  52                         echo "  $_param = 1;"
  53                 else
  54                         echo "  $_param = 0;"
  55                 fi
  56         ;;
  57         NY)
  58                 _name1=jail_${_j}_${_name}
  59                 _name2=jail_${_name}
  60                 eval $_name1=\"\${$_name1:-\${$_name2:-$_def}}\"
  61                 if checkyesno $_name1; then
  62                         echo "  $_param = 0;"
  63                 else
  64                         echo "  $_param = 1;"
  65                 fi
  66         ;;
  67         [0-9]*)
  68                 i=$_num
  69                 while : ; do
  70                         _name1=jail_${_j}_${_name}${i}
  71                         _name2=jail_${_name}${i}
  72                         eval _tmpargs=\"\${$_name1:-\${$_name2:-$_def}}\"
  73                         if [ -n "$_tmpargs" ]; then
  74                                 echo "  $_param += \"$_tmpargs\";"
  75                         else
  76                                 break;
  77                         fi
  78                         i=$(($i + 1))
  79                 done
  80         ;;
  81         *)
  82                 _name1=jail_${_j}_${_name}
  83                 _name2=jail_${_name}
  84                 eval _tmpargs=\"\${$_name1:-\${$_name2:-$_def}}\"
  85                 if [ -n "$_tmpargs" ]; then
  86                         echo "  $_param = \"$_tmpargs\";"
  87                 fi
  88         ;;
  89         esac
  90 }
  91
  92 # parse_options _j
  93 #       Parse options and create a temporary configuration file if necessary.
  94 #
  95 parse_options()
  96 {
  97         local _j _p
  98         _j=$1
  99
 100         _confwarn=0
 101         if [ -z "$_j" ]; then
 102                 warn "parse_options: you must specify a jail"
 103                 return
 104         fi
 105         eval _jconf=\"\${jail_${_j}_conf:-/etc/jail.${_j}.conf}\"
 106         eval _rootdir=\"\$jail_${_j}_rootdir\"
 107         eval _hostname=\"\$jail_${_j}_hostname\"
 108         if [ -z "$_rootdir" -o \
 109              -z "$_hostname" ]; then
 110                 if [ -r "$_jconf" ]; then
 111                         _conf="$_jconf"
 112                         return 0
 113                 elif [ -r "$jail_conf" ]; then
 114                         _conf="$jail_conf"
 115                         return 0
 116                 else
 117                         warn "Invalid configuration for $_j " \
 118                             "(no jail.conf, no hostname, or no path).  " \
 119                             "Jail $_j was ignored."
 120                 fi
 121                 return 1
 122         fi
 123         eval _ip=\"\$jail_${_j}_ip\"
 124         if [ -z "$_ip" ] && ! check_kern_features vimage; then
 125                 warn "no ipaddress specified and no vimage support.  " \
 126                     "Jail $_j was ignored."
 127                 return 1
 128         fi
 129         _conf=/var/run/jail.${_j}.conf
 130         #
 131         # To relieve confusion, show a warning message.
 132         #
 133         _confwarn=1
 134         if [ -r "$jail_conf" -o -r "$_jconf" ]; then
 135                 if ! checkyesno jail_parallel_start; then
 136                         warn "$_conf is created and used for jail $_j."
 137                 fi
 138         fi
 139         /usr/bin/install -m 0644 -o root -g wheel /dev/null $_conf || return 1
 140
 141         eval : \${jail_${_j}_flags:=${jail_flags}}
 142         eval _exec=\"\$jail_${_j}_exec\"
 143         eval _exec_start=\"\$jail_${_j}_exec_start\"
 144         eval _exec_stop=\"\$jail_${_j}_exec_stop\"
 145         if [ -n "${_exec}" ]; then
 146                 #   simple/backward-compatible execution
 147                 _exec_start="${_exec}"
 148                 _exec_stop=""
 149         else
 150                 #   flexible execution
 151                 if [ -z "${_exec_start}" ]; then
 152                         _exec_start="/bin/sh /etc/rc"
 153                         if [ -z "${_exec_stop}" ]; then
 154                                 _exec_stop="/bin/sh /etc/rc.shutdown"
 155                         fi
 156                 fi
 157         fi
 158         eval _interface=\"\${jail_${_j}_interface:-${jail_interface}}\"
 159         eval _parameters=\"\${jail_${_j}_parameters:-${jail_parameters}}\"
 160         eval _fstab=\"\${jail_${_j}_fstab:-${jail_fstab:-/etc/fstab.$_j}}\"
 161         (
 162                 date +"# Generated by rc.d/jail at %Y-%m-%d %H:%M:%S"
 163                 echo "$_j {"
 164                 extract_var $_j hostname host.hostname - ""
 165                 extract_var $_j rootdir path - ""
 166                 if [ -n "$_ip" ]; then
 167                         extract_var $_j interface interface - ""
 168                         jail_handle_ips_option $_ip $_interface
 169                         alias=0
 170                         while : ; do
 171                                 eval _x=\"\$jail_${_j}_ip_multi${alias}\"
 172                                 [ -z "$_x" ] && break
 173
 174                                 jail_handle_ips_option $_x $_interface
 175                                 alias=$(($alias + 1))
 176                         done
 177                         case $need_dad_wait in
 178                         1)
 179                                 # Sleep to let DAD complete before
 180                                 # starting services.
 181                                 echo "  exec.start += \"sleep " \
 182                                 $(($(${SYSCTL_N} net.inet6.ip6.dad_count) + 1)) \
 183                                 "\";"
 184                         ;;
 185                         esac
 186                         # These are applicable only to non-vimage jails.
 187                         extract_var $_j fib exec.fib - ""
 188                         extract_var $_j socket_unixiproute_only \
 189                             allow.raw_sockets NY YES
 190                 else
 191                         echo "  vnet;"
 192                         extract_var $_j vnet_interface vnet.interface - ""
 193                 fi
 194
 195                 echo "  exec.clean;"
 196                 echo "  exec.system_user = \"root\";"
 197                 echo "  exec.jail_user = \"root\";"
 198                 extract_var $_j exec_prestart exec.prestart 0 ""
 199                 extract_var $_j exec_poststart exec.poststart 0 ""
 200                 extract_var $_j exec_prestop exec.prestop 0 ""
 201                 extract_var $_j exec_poststop exec.poststop 0 ""
 202
 203                 echo "  exec.start += \"$_exec_start\";"
 204                 extract_var $_j exec_afterstart exec.start 1 ""
 205                 echo "  exec.stop = \"$_exec_stop\";"
 206
 207                 extract_var $_j consolelog exec.consolelog - \
 208                     /var/log/jail_${_j}_console.log
 209
 210                 eval : \${jail_${_j}_devfs_enable:=${jail_devfs_enable:-NO}}
 211                 if checkyesno jail_${_j}_devfs_enable; then
 212                         echo "  mount.devfs;"
 213                         eval _ruleset=\${jail_${_j}_devfs_ruleset:-${jail_devfs_ruleset}}
 214                         case $_ruleset in
 215                         "")     ;;
 216                         [0-9]*) echo "  devfs_ruleset = \"$_ruleset\";" ;;
 217                         devfsrules_jail)
 218                                 # XXX: This is the default value,
 219                                 # Let jail(8) to use the default because
 220                                 # mount(8) only accepts an integer.
 221                                 # This should accept a ruleset name.
 222                         ;;
 223                         *)      warn "devfs_ruleset must be an integer." ;;
 224                         esac
 225                         if [ -r $_fstab ]; then
 226                                 echo "  mount.fstab = \"$_fstab\";"
 227                         fi
 228                 fi
 229
 230                 eval : \${jail_${_j}_fdescfs_enable:=${jail_fdescfs_enable:-NO}}
 231                 if checkyesno jail_${_j}_fdescfs_enable; then
 232                         echo "  mount.fdescfs;"
 233                 fi
 234                 eval : \${jail_${_j}_procfs_enable:=${jail_procfs_enable:-NO}}
 235                 if checkyesno jail_${_j}_procfs_enable; then
 236                         echo "  mount += " \
 237                             "\"procfs ${_rootdir%/}/proc procfs rw 0 0\";"
 238                 fi
 239
 240                 eval : \${jail_${_j}_mount_enable:=${jail_mount_enable:-NO}}
 241                 if checkyesno jail_${_j}_mount_enable; then
 242                         echo "  allow.mount;" >> $_conf
 243                 fi
 244
 245                 extract_var $_j set_hostname_allow allow.set_hostname YN NO
 246                 extract_var $_j sysvipc_allow allow.sysvipc YN NO
 247                 for _p in $_parameters; do
 248                         echo "  ${_p%\;};"
 249                 done
 250                 echo "}"
 251         ) >> $_conf
 252
 253         return 0
 254 }
 255
 256 # jail_extract_address argument iface
 257 #       The second argument is the string from one of the _ip
 258 #       or the _multi variables. In case of a comma separated list
 259 #       only one argument must be passed in at a time.
 260 #       The function alters the _type, _iface, _addr and _mask variables.
 261 #
 262 jail_extract_address()
 263 {
 264         local _i _interface
 265         _i=$1
 266         _interface=$2
 267
 268         if [ -z "${_i}" ]; then
 269                 warn "jail_extract_address: called without input"
 270                 return
 271         fi
 272
 273         # Check if we have an interface prefix given and split into
 274         # iFace and rest.
 275         case "${_i}" in
 276         *\|*)   # ifN|.. prefix there
 277                 _iface=${_i%%|*}
 278                 _r=${_i##*|}
 279                 ;;
 280         *)      _iface=""
 281                 _r=${_i}
 282                 ;;
 283         esac
 284
 285         # In case the IP has no interface given, check if we have a global one.
 286         _iface=${_iface:-${_interface}}
 287
 288         # Set address, cut off any prefix/netmask/prefixlen.
 289         _addr=${_r}
 290         _addr=${_addr%%[/ ]*}
 291
 292         # Theoretically we can return here if interface is not set,
 293         # as we only care about the _mask if we call ifconfig.
 294         # This is not done because we may want to santize IP addresses
 295         # based on _type later, and optionally change the type as well.
 296
 297         # Extract the prefix/netmask/prefixlen part by cutting off the address.
 298         _mask=${_r}
 299         _mask=`expr "${_mask}" : "${_addr}\(.*\)"`
 300
 301         # Identify type {inet,inet6}.
 302         case "${_addr}" in
 303         *\.*\.*\.*)     _type="inet" ;;
 304         *:*)            _type="inet6" ;;
 305         *)              warn "jail_extract_address: type not identified"
 306                         ;;
 307         esac
 308
 309         # Handle the special /netmask instead of /prefix or
 310         # "netmask xxx" case for legacy IP.
 311         # We do NOT support shortend class-full netmasks.
 312         if [ "${_type}" = "inet" ]; then
 313                 case "${_mask}" in
 314                 /*\.*\.*\.*)    _mask=" netmask ${_mask#/}" ;;
 315                 *)              ;;
 316                 esac
 317
 318                 # In case _mask is still not set use /32.
 319                 _mask=${_mask:-/32}
 320
 321         elif [ "${_type}" = "inet6" ]; then
 322                 # In case _maske is not set for IPv6, use /64.
 323                 _mask=${_mask:-/64}
 324         fi
 325 }
 326
 327 # jail_handle_ips_option input iface
 328 #       Handle a single argument imput which can be a comma separated
 329 #       list of addresses (theoretically with an option interface and
 330 #       prefix/netmask/prefixlen).
 331 #
 332 jail_handle_ips_option()
 333 {
 334         local _x _type _i _defif
 335         _x=$1
 336         _defif=$2
 337
 338         if [ -z "${_x}" ]; then
 339                 # No IP given. This can happen for the primary address
 340                 # of each address family.
 341                 return
 342         fi
 343
 344         # Loop, in case we find a comma separated list, we need to handle
 345         # each argument on its own.
 346         while [ ${#_x} -gt 0 ]; do
 347                 case "${_x}" in
 348                 *,*)    # Extract the first argument and strip it off the list.
 349                         _i=`expr "${_x}" : '^\([^,]*\)'`
 350                         _x=`expr "${_x}" : "^[^,]*,\(.*\)"`
 351                 ;;
 352                 *)      _i=${_x}
 353                         _x=""
 354                 ;;
 355                 esac
 356
 357                 _type=""
 358                 _addr=""
 359                 _mask=""
 360                 _iface=""
 361                 jail_extract_address $_i $_defif
 362
 363                 # make sure we got an address.
 364                 case $_addr in
 365                 "")     continue ;;
 366                 *)      ;;
 367                 esac
 368
 369                 # Append address to list of addresses for the jail command.
 370                 case $_type in
 371                 inet)
 372                         echo "  ip4.addr += \"${_iface:+${_iface}|}${_addr}${_mask}\";"
 373                 ;;
 374                 inet6)
 375                         echo "  ip6.addr += \"${_iface:+${_iface}|}${_addr}${_mask}\";"
 376                         need_dad_wait=1
 377                 ;;
 378                 esac
 379         done
 380 }
 381
 382 jail_config()
 383 {
 384         local _j
 385
 386         case $1 in
 387         _ALL)   return ;;
 388         esac
 389         for _j in $@; do
 390                 _j=$(echo $_j | tr /. _)
 391                 if parse_options $_j; then
 392                         echo "$_j: parameters are in $_conf."
 393                 fi
 394         done
 395 }
 396
 397 jail_console()
 398 {
 399         local _j _cmd
 400
 401         # One argument that is not _ALL.
 402         case $#:$1 in
 403         0:*|1:_ALL)     err 3 "Specify a jail name." ;;
 404         1:*)            ;;
 405         esac
 406         _j=$(echo $1 | tr /. _)
 407         shift
 408         case $# in
 409         0)      eval _cmd=\${jail_${_j}_consolecmd:-$jail_consolecmd} ;;
 410         *)      _cmd=$@ ;;
 411         esac
 412         $jail_jexec $_j $_cmd
 413 }
 414
 415 jail_status()
 416 {
 417
 418         $jail_jls -N
 419 }
 420
 421 jail_start()
 422 {
 423         local _j _jid _jn _jl
 424
 425         if [ $# = 0 ]; then
 426                 return
 427         fi
 428         echo -n 'Starting jails:'
 429         case $1 in
 430         _ALL)
 431                 command=$jail_program
 432                 rc_flags=$jail_flags
 433                 command_args="-f $jail_conf -c"
 434                 _tmp=`mktemp -t jail` || exit 3
 435                 if $command $rc_flags $command_args >> $_tmp 2>&1; then
 436                         $jail_jls -nq | while read IN; do
 437                                 _jn=$(echo $IN | tr " " "\n" | grep ^name=)
 438                                 _jid=$(echo $IN | tr " " "\n" | grep ^jid=)
 439                                 echo -n " ${_jn#name=}"
 440                                 echo "${_jid#jid=}" \
 441                                     > /var/run/jail_${_jn#name=}.id
 442                         done
 443                 else
 444                         tail -1 $_tmp
 445                 fi
 446                 rm -f $_tmp
 447                 echo '.'
 448                 return
 449         ;;
 450         esac
 451         if checkyesno jail_parallel_start; then
 452                 #
 453                 # Start jails in parallel and then check jail id when
 454                 # jail_parallel_start is YES.
 455                 #
 456                 _jl=
 457                 for _j in $@; do
 458                         _j=$(echo $_j | tr /. _)
 459                         parse_options $_j || continue
 460
 461                         _jl="$_jl $_j"
 462                         eval rc_flags=\${jail_${_j}_flags:-$jail_flags}
 463                         eval command=\${jail_${_j}_program:-$jail_program}
 464                         command_args="-i -f $_conf -c $_j"
 465                         $command $rc_flags $command_args \
 466                             >/dev/null 2>&1 </dev/null &
 467                 done
 468                 sleep 1
 469                 for _j in $_jl; do
 470                         echo -n " ${_hostname:-${_j}}"
 471                         if _jid=$($jail_jls -n -j $_j | tr " " "\n" | \
 472                             grep ^jid=); then
 473                                 echo "${_jid#jid=}" > /var/run/jail_${_j}.id
 474                         else
 475                                 rm -f /var/run/jail_${_j}.id
 476                                 echo " cannot start jail " \
 477                                     "\"${_hostname:-${_j}}\": "
 478                         fi
 479                 done
 480         else
 481                 #
 482                 # Start jails one-by-one when jail_parallel_start is NO.
 483                 #
 484                 for _j in $@; do
 485                         _j=$(echo $_j | tr /. _)
 486                         parse_options $_j || continue
 487
 488                         eval rc_flags=\${jail_${_j}_flags:-$jail_flags}
 489                         eval command=\${jail_${_j}_program:-$jail_program}
 490                         command_args="-i -f $_conf -c $_j"
 491                         _tmp=`mktemp -t jail` || exit 3
 492                         if $command $rc_flags $command_args \
 493                             >> $_tmp 2>&1 </dev/null; then
 494                                 echo -n " ${_hostname:-${_j}}"
 495                                 _jid=$($jail_jls -n -j $_j | \
 496                                     tr " " "\n" | grep ^jid=)
 497                                 echo "${_jid#jid=}" > /var/run/jail_${_j}.id
 498                         else
 499                                 rm -f /var/run/jail_${_j}.id
 500                                 echo " cannot start jail " \
 501                                     "\"${_hostname:-${_j}}\": "
 502                                 cat $_tmp
 503                         fi
 504                         rm -f $_tmp
 505                 done
 506         fi
 507         echo '.'
 508 }
 509
 510 jail_stop()
 511 {
 512         local _j _jn
 513
 514         if [ $# = 0 ]; then
 515                 return
 516         fi
 517         echo -n 'Stopping jails:'
 518         case $1 in
 519         _ALL)
 520                 command=$jail_program
 521                 rc_flags=$jail_flags
 522                 command_args="-f $jail_conf -r"
 523                 $jail_jls -nq | while read IN; do
 524                         _jn=$(echo $IN | tr " " "\n" | grep ^name=)
 525                         echo -n " ${_jn#name=}"
 526                         _tmp=`mktemp -t jail` || exit 3
 527                         $command $rc_flags $command_args ${_jn#name=} \
 528                             >> $_tmp 2>&1
 529                         if $jail_jls -j ${_jn#name=} > /dev/null 2>&1; then
 530                                 tail -1 $_tmp
 531                         else
 532                                 rm -f /var/run/jail_${_jn#name=}.id
 533                         fi
 534                         rm -f $_tmp
 535                 done
 536                 echo '.'
 537                 return
 538         ;;
 539         esac
 540         for _j in $@; do
 541                 _j=$(echo $_j | tr /. _)
 542                 parse_options $_j || continue
 543                 if ! $jail_jls -j $_j > /dev/null 2>&1; then
 544                         continue
 545                 fi
 546                 eval command=\${jail_${_j}_program:-$jail_program}
 547                 echo -n " ${_hostname:-${_j}}"
 548                 _tmp=`mktemp -t jail` || exit 3
 549                 $command -q -f $_conf -r $_j >> $_tmp 2>&1
 550                 if $jail_jls -j $_j > /dev/null 2>&1; then
 551                         tail -1 $_tmp
 552                 else
 553                         rm -f /var/run/jail_${_j}.id
 554                 fi
 555                 rm -f $_tmp
 556         done
 557         echo '.'
 558 }
 559
 560 jail_warn()
 561 {
 562
 563         # To relieve confusion, show a warning message.
 564         case $_confwarn in
 565         1)      warn "Per-jail configuration via jail_* variables " \
 566                     "is obsolete.  Please consider to migrate to $jail_conf."
 567         ;;
 568         esac
 569 }
 570
 571 load_rc_config $name
 572 case $# in
 573 1)      run_rc_command $@ ${jail_list:-_ALL} ;;
 574 *)      run_rc_command $@ ;;
 575 esac