jng revision 295553
1#!/bin/sh 2#- 3# Copyright (c) 2016 Devin Teske 4# All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions 8# are met: 9# 1. Redistributions of source code must retain the above copyright 10# notice, this list of conditions and the following disclaimer. 11# 2. Redistributions in binary form must reproduce the above copyright 12# notice, this list of conditions and the following disclaimer in the 13# documentation and/or other materials provided with the distribution. 14# 15# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25# SUCH DAMAGE. 26# 27# $FreeBSD: head/share/examples/jails/jng 295553 2016-02-12 01:12:44Z dteske $ 28# 29############################################################ IDENT(1) 30# 31# $Title: netgraph(4) management script for vnet jails $ 32# 33############################################################ INFORMATION 34# 35# Use this tool with jail.conf(5) (or rc.conf(5) ``legacy'' configuration) to 36# manage `vnet' interfaces for jails. Designed to automate the creation of vnet 37# interface(s) during jail `prestart' and destroy said interface(s) during jail 38# `poststop'. 39# 40# In jail.conf(5) format: 41# 42# ### BEGIN EXCERPT ### 43# 44# xxx { 45# host.hostname = "xxx.yyy"; 46# path = "/vm/xxx"; 47# 48# # 49# # NB: Below 2-lines required 50# # NB: The number of ngN_xxx interfaces should match the number of 51# # arguments given to `jng bridge xxx' in exec.prestart value. 52# # 53# vnet; 54# vnet.interface = "ng0_xxx ng1_xxx ..."; 55# 56# exec.clean; 57# exec.system_user = "root"; 58# exec.jail_user = "root"; 59# 60# # 61# # NB: Below 2-lines required 62# # NB: The number of arguments after `jng bridge xxx' should match 63# # the number of ngN_xxx arguments in vnet.interface value. 64# # 65# exec.prestart += "jng bridge xxx em0 em1 ..."; 66# exec.poststop += "jng shutdown xxx"; 67# 68# # Standard recipe 69# exec.start += "/bin/sh /etc/rc"; 70# exec.stop = "/bin/sh /etc/rc.shutdown"; 71# exec.consolelog = "/var/log/jail_xxx_console.log"; 72# mount.devfs; 73# 74# # Optional (default off) 75# #allow.mount; 76# #allow.set_hostname = 1; 77# #allow.sysvipc = 1; 78# #devfs_ruleset = "11"; # rule to unhide bpf for DHCP 79# } 80# 81# ### END EXCERPT ### 82# 83# In rc.conf(5) ``legacy'' format (used when /etc/jail.conf does not exist): 84# 85# ### BEGIN EXCERPT ### 86# 87# jail_enable="YES" 88# jail_list="xxx" 89# 90# # 91# # Global presets for all jails 92# # 93# jail_devfs_enable="YES" # mount devfs 94# 95# # 96# # Global options (default off) 97# # 98# #jail_mount_enable="YES" # mount /etc/fstab.{name} 99# #jail_set_hostname_allow="YES" # Allow hostname to change 100# #jail_sysvipc_allow="YES" # Allow SysV Interprocess Comm. 101# 102# # xxx 103# jail_xxx_hostname="xxx.shxd.cx" # hostname 104# jail_xxx_rootdir="/vm/xxx" # root directory 105# jail_xxx_vnet_interfaces="ng0_xxx ng1xxx ..." # vnet interface(s) 106# jail_xxx_exec_prestart0="jng bridge xxx em0 em1 ..." # bridge interface(s) 107# jail_xxx_exec_poststop0="jng shutdown xxx" # destroy interface(s) 108# #jail_xxx_mount_enable="YES" # mount /etc/fstab.xxx 109# #jail_xxx_devfs_ruleset="11" # rule to unhide bpf for DHCP 110# 111# ### END EXCERPT ### 112# 113# Note that the legacy rc.conf(5) format is converted to 114# /var/run/jail.{name}.conf by /etc/rc.d/jail if jail.conf(5) is missing. 115# 116# ASIDE: dhclient(8) inside a vnet jail... 117# 118# To allow dhclient(8) to work inside a vnet jail, make sure the following 119# appears in /etc/devfs.rules (which should be created if it doesn't exist): 120# 121# [devfsrules_jail=11] 122# add include $devfsrules_hide_all 123# add include $devfsrules_unhide_basic 124# add include $devfsrules_unhide_login 125# add path 'bpf*' unhide 126# 127# And set ether devfs.ruleset="11" (jail.conf(5)) or 128# jail_{name}_devfs_ruleset="11" (rc.conf(5)). 129# 130# NB: While this tool can't create every type of desirable topology, it should 131# handle most setups, minus some which considered exotic or purpose-built. 132# 133############################################################ GLOBALS 134 135pgm="${0##*/}" # Program basename 136 137# 138# Global exit status 139# 140SUCCESS=0 141FAILURE=1 142 143############################################################ FUNCTIONS 144 145usage() 146{ 147 local action usage descr 148 exec >&2 149 echo "Usage: $pgm action [arguments]" 150 echo "Actions:" 151 for action in \ 152 bridge \ 153 graph \ 154 show \ 155 show1 \ 156 shutdown \ 157 stats \ 158 ; do 159 eval usage=\"\$jng_${action}_usage\" 160 [ "$usage" ] || continue 161 eval descr=\"\$jng_${action}_descr\" 162 printf "\t%s\n\t\t%s\n" "$usage" "$descr" 163 done 164 exit $FAILURE 165} 166 167action_usage() 168{ 169 local usage action="$1" 170 eval usage=\"\$jng_${action}_usage\" 171 echo "Usage: $pgm $usage" >&2 172 exit $FAILURE 173} 174 175derive_mac() 176{ 177 local OPTIND=1 OPTARG __flag 178 local __mac_num= __make_pair= 179 while getopts 2n: __flag; do 180 case "$__flag" in 181 2) __make_pair=1 ;; 182 n) __mac_num=${OPTARG%%[^0-9]*} ;; 183 esac 184 done 185 shift $(( $OPTIND - 1 )) 186 187 if [ ! "$__mac_num" ]; then 188 eval __mac_num=\${_${iface}_num:--1} 189 __mac_num=$(( $__mac_num + 1 )) 190 eval _${iface}_num=\$__mac_num 191 fi 192 193 local __iface="$1" __name="$2" __var_to_set="$3" __var_to_set_b="$4" 194 local __iface_devid __new_devid __num __new_devid_b 195 # 196 # Calculate MAC address derived from given iface. 197 # 198 # The formula I'm using is ``NP:SS:SS:II:II:II'' where: 199 # + N denotes 4 bits used as a counter to support branching 200 # each parent interface up to 15 times under the same jail 201 # name (see S below). 202 # + P denotes the special nibble whose value, if one of 203 # 2, 6, A, or E (but usually 2) denotes a privately 204 # administered MAC address (while remaining routable). 205 # + S denotes 16 bits, the sum(1) value of the jail name. 206 # + I denotes bits that are inherited from parent interface. 207 # 208 # The S bits are a CRC-16 checksum of NAME, allowing the jail 209 # to change link numbers in ng_bridge(4) without affecting the 210 # MAC address. Meanwhile, if... 211 # + the jail NAME changes (e.g., it was duplicated and given 212 # a new name with no other changes) 213 # + the underlying network interface changes 214 # + the jail is moved to another host 215 # the MAC address will be recalculated to a new, similarly 216 # unique value preventing conflict. 217 # 218 __iface_devid=$( ifconfig $__iface ether | awk '/ether/,$0=$2' ) 219 # ??:??:??:II:II:II 220 __new_devid=${__iface_devid#??:??:??} # => :II:II:II 221 # => :SS:SS:II:II:II 222 __num=$( set -- `echo -n "$__name" | sum` && echo $1 ) 223 __new_devid=$( printf :%02x:%02x \ 224 $(( $__num >> 8 & 255 )) $(( $__num & 255 )) )$__new_devid 225 # => P:SS:SS:II:II:II 226 case "$__iface_devid" in 227 ?2:*) __new_devid=a$__new_devid __new_devid_b=e$__new_devid ;; 228 ?[Ee]:*) __new_devid=2$__new_devid __new_devid_b=6$__new_devid ;; 229 *) __new_devid=2$__new_devid __new_devid_b=e$__new_devid 230 esac 231 # => NP:SS:SS:II:II:II 232 __new_devid=$( printf %x $(( $__mac_num & 15 )) )$__new_devid 233 __new_devid_b=$( printf %x $(( $__mac_num & 15 )) )$__new_devid_b 234 235 # 236 # Return derivative MAC address(es) 237 # 238 if [ "$__make_pair" ]; then 239 if [ "$__var_to_set" -a "$__var_to_set_b" ]; then 240 eval $__var_to_set=\$__new_devid 241 eval $__var_to_set_b=\$__new_devid_b 242 else 243 echo $__new_devid $__new_devid_b 244 fi 245 else 246 if [ "$__var_to_set" ]; then 247 eval $__var_to_set=\$__new_devid 248 else 249 echo $__new_devid 250 fi 251 fi 252} 253 254mustberoot_to_continue() 255{ 256 if [ "$( id -u )" -ne 0 ]; then 257 echo "Must run as root!" >&2 258 exit $FAILURE 259 fi 260} 261 262jng_bridge_usage="bridge [-b BRIDGE_NAME] NAME [=]iface0 [[=]iface1 ...]" 263jng_bridge_descr="Create ng0_NAME [ng1_NAME ...]" 264jng_bridge() 265{ 266 local OPTIND=1 OPTARG flag bridge=bridge 267 while getopts b: flag; do 268 case "$flag" in 269 b) bridge="$OPTARG" 270 [ "$bridge" ] || action_usage bridge ;; # NOTREACHED 271 *) action_usage bridge # NOTREACHED 272 esac 273 done 274 shift $(( $OPTIND - 1 )) 275 276 local name="$1" 277 [ "${name:-x}" = "${name#*[!0-9a-zA-Z_]}" -a $# -gt 1 ] || 278 action_usage bridge # NOTREACHED 279 shift 1 # name 280 281 mustberoot_to_continue 282 283 local iface parent eiface eiface_devid 284 local new clone_mac num quad i=0 285 for iface in $*; do 286 287 clone_mac= 288 case "$iface" in 289 =*) iface=${iface#=} clone_mac=1 ;; 290 esac 291 292 # 0. Make sure the interface doesn't exist already 293 eiface=ng${i}_$name 294 ngctl msg "$eiface:" getifname > /dev/null 2>&1 && continue 295 296 # 1. Bring the interface up 297 ifconfig $iface up || return 298 299 # 2. Set promiscuous mode and don't overwrite src addr 300 ngctl msg $iface: setpromisc 1 || return 301 ngctl msg $iface: setautosrc 0 || return 302 303 # 3. Make sure the interface has been bridged 304 if ! ngctl info ${iface}bridge: > /dev/null 2>&1; then 305 ngctl mkpeer $iface: bridge lower link0 || return 306 ngctl connect $iface: $iface:lower upper link1 || 307 return 308 ngctl name $iface:lower ${iface}bridge || return 309 fi 310 311 # 3.5. Optionally create a secondary bridge 312 if [ "$bridge" != "bridge" ] && 313 ! ngctl info "$iface$bridge:" > /dev/null 2>&1 314 then 315 num=2 316 while ngctl msg ${iface}bridge: getstats $num \ 317 > /dev/null 2>&1 318 do 319 num=$(( $num + 1 )) 320 done 321 ngctl mkpeer $iface:lower bridge link$num link1 || 322 return 323 ngctl name ${iface}bridge:link$num "$iface$bridge" || 324 return 325 fi 326 327 # 4. Create a new interface to the bridge 328 num=2 329 while ngctl msg "$iface$bridge:" getstats $num > /dev/null 2>&1 330 do 331 num=$(( $num + 1 )) 332 done 333 ngctl mkpeer "$iface$bridge:" eiface link$num ether || return 334 335 # 5. Rename the new interface 336 while [ ${#eiface} -gt 15 ]; do # OS limitation 337 eiface=${eiface%?} 338 done 339 new=$( set -- `ngctl show -n "$iface$bridge:link$num"` && 340 echo $2 ) || return 341 ngctl name "$iface$bridge:link$num" $eiface || return 342 ifconfig $new name $eiface || return 343 ifconfig $eiface up || return 344 345 # 346 # 6. Set the MAC address of the new interface using a sensible 347 # algorithm to prevent conflicts on the network. 348 # 349 case "$iface" in 350 wlan[0-9]*) 351 parent=$( sysctl -n net.wlan.${iface#wlan}.%parent ) 352 case "$parent" in 353 iwn[0-9]*) 354 # iwn(4) supports only 1 virtual net at a time 355 # NB: Cloning MAC allows new interface to work 356 clone_mac=1 ;; 357 esac 358 esac 359 if [ "$clone_mac" ]; then 360 eiface_devid=$( 361 ifconfig $iface ether | awk '/ether/,$0=$2' 362 ) 363 else 364 derive_mac $iface "$name" eiface_devid 365 fi 366 ifconfig $eiface ether $eiface_devid 367 368 i=$(( $i + 1 )) # on to next ng{i}_name 369 done # for iface 370} 371 372jng_graph_usage="graph [-f] [-T type] [-o output]" 373jng_graph_descr="Generate network graph (default output is \`jng.svg')" 374jng_graph() 375{ 376 local OPTIND=1 OPTARG flag 377 local output=jng.svg output_type= force= 378 while getopts fo:T: flag; do 379 case "$flag" in 380 f) force=1 ;; 381 o) output="$OPTARG" ;; 382 T) output_type="$OPTARG" ;; 383 *) action_usage graph # NOTREACHED 384 esac 385 done 386 shift $(( $OPTIND - 1 )) 387 [ $# -eq 0 -a "$output" ] || action_usage graph # NOTREACHED 388 mustberoot_to_continue 389 if [ -e "$output" -a ! "$force" ]; then 390 echo "$output: Already exists (use \`-f' to overwrite)" >&2 391 return $FAILURE 392 fi 393 if [ ! "$output_type" ]; then 394 local valid suffix 395 valid=$( dot -Txxx 2>&1 ) 396 for suffix in ${valid##*:}; do 397 [ "$output" != "${output%.$suffix}" ] || continue 398 output_type=$suffix 399 break 400 done 401 fi 402 ngctl dot | dot ${output_type:+-T "$output_type"} -o "$output" 403} 404 405jng_show_usage="show" 406jng_show_descr="List possible NAME values for \`show NAME'" 407jng_show1_usage="show NAME" 408jng_show1_descr="Lists ng0_NAME [ng1_NAME ...]" 409jng_show2_usage="show [NAME]" 410jng_show() 411{ 412 local OPTIND=1 OPTARG flag 413 while getopts "" flag; do 414 case "$flag" in 415 *) action_usage show2 # NOTREACHED 416 esac 417 done 418 shift $(( $OPTIND - 1 )) 419 mustberoot_to_continue 420 if [ $# -eq 0 ]; then 421 ngctl ls | awk '$4=="bridge",$0=$2' | 422 xargs -rn1 -Ibridge ngctl show bridge: | 423 awk 'sub(/^ng[[:digit:]]+_/, "", $2), $0 = $2' | 424 sort -u 425 return 426 fi 427 ngctl ls | awk -v name="$1" ' 428 match($2, /^ng[[:digit:]]+_/) && 429 substr($2, RSTART + RLENGTH) == name && 430 $4 == "eiface", $0 = $2 431 ' | sort 432} 433 434jng_shutdown_usage="shutdown NAME" 435jng_shutdown_descr="Shutdown ng0_NAME [ng1_NAME ...]" 436jng_shutdown() 437{ 438 local OPTIND=1 OPTARG flag 439 while getopts "" flag; do 440 case "$flag" in 441 *) action_usage shutdown # NOTREACHED 442 esac 443 done 444 shift $(( $OPTIND -1 )) 445 local name="$1" 446 [ "${name:-x}" = "${name#*[!0-9a-zA-Z_]}" -a $# -eq 1 ] || 447 action_usage shutdown # NOTREACHED 448 mustberoot_to_continue 449 jng_show "$name" | xargs -rn1 -I eiface ngctl shutdown eiface: 450} 451 452jng_stats_usage="stats NAME" 453jng_stats_descr="Show ng_bridge link statistics for NAME interfaces" 454jng_stats() 455{ 456 local OPTIND=1 OPTARG flag 457 while getopts "" flag; do 458 case "$flag" in 459 *) action_usage stats # NOTREACHED 460 esac 461 done 462 shift $(( $OPTIND -1 )) 463 local name="$1" 464 [ "${name:-x}" = "${name#*[!0-9a-zA-Z_]}" -a $# -eq 1 ] || 465 action_usage stats # NOTREACHED 466 mustberoot_to_continue 467 for eiface in $( jng_show "$name" ); do 468 echo "$eiface:" 469 ngctl show $eiface: | awk ' 470 $3 == "bridge" && $5 ~ /^link/ { 471 bridge = $2 472 link = substr($5, 5) 473 system(sprintf("ngctl msg %s: getstats %u", 474 bridge, link)) 475 }' | fmt 2 | awk ' 476 /=/ && fl = index($0, "=") { 477 printf "%20s = %s\n", 478 substr($0, 0, fl-1), 479 substr($0, 0, fl+1) 480 } 481 ' # END-QUOTE 482 done 483} 484 485############################################################ MAIN 486 487# 488# Command-line arguments 489# 490action="$1" 491[ "$action" ] || usage # NOTREACHED 492 493# 494# Validate action argument 495# 496if [ "$BASH_VERSION" ]; then 497 type="$( type -t "jng_$action" )" || usage # NOTREACHED 498else 499 type="$( type "jng_$action" 2> /dev/null )" || usage # NOTREACHED 500fi 501case "$type" in 502*function) 503 shift 1 # action 504 eval "jng_$action" \"\$@\" 505 ;; 506*) usage # NOTREACHED 507esac 508 509################################################################################ 510# END 511################################################################################ 512
