etc/network.subr

   1 #
   2 # Copyright (c) 2003 The FreeBSD Project. All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions
   6 # are met:
   7 # 1. Redistributions of source code must retain the above copyright
   8 #    notice, this list of conditions and the following disclaimer.
   9 # 2. Redistributions in binary form must reproduce the above copyright
  10 #    notice, this list of conditions and the following disclaimer in the
  11 #    documentation and/or other materials provided with the distribution.
  12 #
  13 # THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  14 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 # ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  17 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 # SUCH DAMAGE.
  24 #
  25 # $FreeBSD: src/etc/network.subr,v 1.151 2003/06/24 03:55:21 kuriyama Exp $
  26 # $DragonFly: src/etc/network.subr,v 1.2 2005/12/23 17:42:59 dillon Exp $
  27 #
  28
  29 #
  30 # Subroutines commonly used from network startup scripts.
  31 # Requires that rc.conf be loaded first.
  32 #
  33
  34 # ifconfig_up if
  35 #       Evaluate ifconfig(8) arguments for interface $if and
  36 #       run ifconfig(8) with those arguments. It returns 0 if
  37 #       arguments were found and executed or 1 if the interface
  38 #       had no arguments.
  39 #
  40 ifconfig_up()
  41 {
  42         eval ifconfig_args=\$ifconfig_$1
  43         if [ -n "${ifconfig_args}" ]; then
  44                 ifconfig $1 ${ifconfig_args}
  45                 return 0
  46         fi
  47         return 1
  48 }
  49
  50 # ifconfig_down if
  51 #       Remove all inet entries from the $if interface. It returns
  52 #       0 if inet entries were found and removed. It returns 1 if
  53 #       no entries were found or they could not be removed.
  54 #
  55 ifconfig_down()
  56 {
  57         [ -z "$1" ] && return 1
  58         _ifs="^"
  59         _ret=1
  60
  61         inetList="`ifconfig $1 | grep 'inet ' | tr "\n" "$_ifs"`"
  62
  63         oldifs="$IFS"
  64         IFS="$_ifs"
  65         for _inet in $inetList ; do
  66                 # get rid of extraneous line
  67                 [ -z "$_inet" ] && break
  68
  69                 _inet=`expr "$_inet" : '.*\(inet \([0-9]\{1,3\}\.\)\{3\}[0-9]\{1,3\}\).*'`
  70
  71                 IFS="$oldifs"
  72                 ifconfig $1 ${_inet} delete
  73                 IFS="$_ifs"
  74                 _ret=0
  75         done
  76         IFS="$oldifs"
  77
  78         return $_ret
  79 }
  80
  81 # ifalias_up if
  82 #       Configure aliases for network interface $if.
  83 #       It returns 0 if at least one alias was configured or
  84 #       1 if there were none.
  85 #
  86 ifalias_up()
  87 {
  88         _ret=1
  89         alias=0
  90         while : ; do
  91                 eval ifconfig_args=\$ifconfig_$1_alias${alias}
  92                 if [ -n "${ifconfig_args}" ]; then
  93                         ifconfig $1 ${ifconfig_args} alias
  94                         alias=$((${alias} + 1))
  95                         _ret=0
  96                 else
  97                         break
  98                 fi
  99         done
 100         return $_ret
 101 }
 102
 103 #ifalias_down if
 104 #       Remove aliases for network interface $if.
 105 #       It returns 0 if at least one alias was removed or
 106 #       1 if there were none.
 107 #
 108 ifalias_down()
 109 {
 110         _ret=1
 111         alias=0
 112         while : ; do
 113                 eval ifconfig_args=\$ifconfig_$1_alias${alias}
 114                 if [ -n "${ifconfig_args}" ]; then
 115                         ifconfig $1 ${ifconfig_args} -alias
 116                         alias=$((${alias} + 1))
 117                         _ret=0
 118                 else
 119                         break
 120                 fi
 121         done
 122         return $_ret
 123 }
 124
 125 # ifscript_up if
 126 #       Evaluate a startup script for the $if interface.
 127 #       It returns 0 if a script was found and processed or
 128 #       1 if no script was found.
 129 #
 130 ifscript_up()
 131 {
 132         if [ -r /etc/start_if.$1 ]; then
 133                 . /etc/start_if.$1
 134                 return 0
 135         fi
 136         return 1
 137 }
 138
 139 # ifscript_down if
 140 #       Evaluate a shutdown script for the $if interface.
 141 #       It returns 0 if a script was found and processed or
 142 #       1 if no script was found.
 143 #
 144 ifscript_down()
 145 {
 146         if [ -r /etc/stop_if.$1 ]; then
 147                 . /etc/stop_if.$1
 148                 return 0
 149         fi
 150         return 1
 151 }
 152
 153 # Create cloneable interfaces.
 154 #
 155 clone_up()
 156 {
 157         _prefix=
 158         _list=
 159         for ifn in ${cloned_interfaces}; do
 160                 ifconfig ${ifn} create
 161                 if [ $? -eq 0 ]; then
 162                         _list="${_list}${_prefix}${ifn}"
 163                         [ -z "$_prefix" ] && _prefix=' '
 164                 fi
 165         done
 166         debug "Cloned: ${_list}"
 167 }
 168
 169 # Destroy cloned interfaces. Destroyed interfaces are echoed
 170 # to standard output.
 171 #
 172 clone_down()
 173 {
 174         _prefix=
 175         _list=
 176         for ifn in ${cloned_interfaces}; do
 177                 ifconfig ${ifn} destroy
 178                 if [ $? -eq 0 ]; then
 179                         _list="${_list}${_prefix}${ifn}"
 180                         [ -z "$_prefix" ] && _prefix=' '
 181                 fi
 182         done
 183         debug "Destroyed clones: ${_list}"
 184 }
 185
 186 gif_up() {
 187         case ${gif_interfaces} in
 188         [Nn][Oo] | '')
 189                 ;;
 190         *)
 191                 for i in ${gif_interfaces}; do
 192                         eval peers=\$gifconfig_$i
 193                         case ${peers} in
 194                         '')
 195                                 continue
 196                                 ;;
 197                         *)
 198                                 ifconfig $i create >/dev/null 2>&1
 199                                 ifconfig $i tunnel ${peers}
 200                                 ifconfig $i up
 201                                 ;;
 202                         esac
 203                 done
 204                 ;;
 205         esac
 206 }
 207
 208 #
 209 # ipx_up ifn
 210 # Configure any IPX addresses for interface $ifn. Returns 0 if IPX
 211 # arguments were found and configured; returns 1 otherwise.
 212 #
 213 ipx_up()
 214 {
 215         ifn="$1"
 216         eval ifconfig_args=\$ifconfig_${ifn}_ipx
 217         if [ -n "${ifconfig_args}" ]; then
 218                 ifconfig ${ifn} ${ifconfig_args}
 219                 return 0
 220         fi
 221         return 1
 222 }
 223
 224 # ipx_down ifn
 225 #       Remove IPX addresses for interface $ifn. Returns 0 if IPX
 226 #       addresses were found and unconfigured. It returns 1, otherwise.
 227 #
 228 ipx_down()
 229 {
 230         [ -z "$1" ] && return 1
 231         _ifs="^"
 232         _ret=1
 233
 234         ipxList="`ifconfig $1 | grep 'ipx ' | tr "\n" "$_ifs"`"
 235
 236         oldifs="$IFS"
 237         IFS="$_ifs"
 238         for _ipx in $ipxList ; do
 239                 # get rid of extraneous line
 240                 [ -z "$_ipx" ] && break
 241
 242                 _ipx=`expr "$_ipx" : '.*\(ipx [0-9a-h]\{1,8\}H*\.[0-9a-h]\{1,12\}\).*'`
 243
 244                 IFS="$oldifs"
 245                 ifconfig $1 ${_ipx} delete
 246                 IFS="$_ifs"
 247                 _ret=0
 248         done
 249         IFS="$oldifs"
 250
 251         return $_ret
 252 }
 253
 254 #
 255 # list_net_interfaces type
 256 #       List all network interfaces. The type of interface returned
 257 #       can be controlled by the type argument. The type
 258 #       argument can be any of the following:
 259 #               nodhcp - all interfaces, excluding DHCP configured interfaces
 260 #               dhcp   - list only DHCP configured interfaces
 261 #       If no argument is specified all network interfaces are output.
 262 #       Note that the list always includes cloned interfaces.
 263 #
 264 list_net_interfaces()
 265 {
 266         type=$1
 267
 268         # Get a list of ALL the interfaces.  NOTE: cloned interfaces
 269         # have already been configured so they should show up in the
 270         # ifconfig -l output.
 271         #
 272         case ${network_interfaces} in
 273         [Aa][Uu][Tt][Oo])
 274                 _tmplist="`ifconfig -l`"
 275                 ;;
 276         *)
 277                 _tmplist="${network_interfaces}"
 278                 ;;
 279         esac
 280
 281         if [ -z "$type" ]; then
 282                 echo $_tmplist
 283                 return 0
 284         fi
 285
 286         # Separate out dhcp and non-dhcp intefraces
 287         #
 288         _aprefix=
 289         _brefix=
 290         for _if in ${_tmplist} ; do
 291                 eval _ifarg="\$ifconfig_${_if}"
 292                 case "$_ifarg" in
 293                 [Dd][Hh][Cc][Pp])
 294                         _dhcplist="${_dhcplist}${_aprefix}${_if}"
 295                         [ -z "$_aprefix" ] && _aprefix=' '
 296                         ;;
 297                 ''|*)
 298                         _nodhcplist="${_nodhcplist}${_bprefix}${_if}"
 299                         [ -z "$_bprefix" ] && _bprefix=' '
 300                         ;;
 301                 esac
 302         done
 303
 304         case "$type" in
 305         nodhcp)
 306                 echo $_nodhcplist
 307                 ;;
 308         dhcp)
 309                 echo $_dhcplist
 310                 ;;
 311         esac
 312         return 0
 313 }
 314
 315 hexdigit()
 316 {
 317         if [ $1 -lt 10 ]; then
 318                 echo $1
 319         else
 320                 case $1 in
 321                 10)     echo a ;;
 322                 11)     echo b ;;
 323                 12)     echo c ;;
 324                 13)     echo d ;;
 325                 14)     echo e ;;
 326                 15)     echo f ;;
 327                 esac
 328         fi
 329 }
 330
 331 hexprint()
 332 {
 333         val=$1
 334         str=''
 335
 336         dig=`hexdigit $((${val} & 15))`
 337         str=${dig}${str}
 338         val=$((${val} >> 4))
 339         while [ ${val} -gt 0 ]; do
 340                 dig=`hexdigit $((${val} & 15))`
 341                 str=${dig}${str}
 342                 val=$((${val} >> 4))
 343         done
 344
 345         echo ${str}
 346 }
 347
 348 # Setup the interfaces for IPv6
 349 network6_interface_setup()
 350 {
 351         interfaces=$*
 352         rtsol_interfaces=''
 353         case ${ipv6_gateway_enable} in
 354         [Yy][Ee][Ss])
 355                 rtsol_available=no
 356                 ;;
 357         *)
 358                 rtsol_available=yes
 359                 ;;
 360         esac
 361         for i in $interfaces; do
 362                 rtsol_interface=yes
 363                 eval prefix=\$ipv6_prefix_$i
 364                 if [ -n "${prefix}" ]; then
 365                         rtsol_available=no
 366                         rtsol_interface=no
 367                         laddr=`network6_getladdr $i`
 368                         hostid=`expr "${laddr}" : 'fe80::\(.*\)%\(.*\)'`
 369                         for j in ${prefix}; do
 370                                 address=$j\:${hostid}
 371                                 ifconfig $i inet6 ${address} prefixlen 64 alias
 372
 373                                 case ${ipv6_gateway_enable} in
 374                                 [Yy][Ee][Ss])
 375                                         # subnet-router anycast address
 376                                         # (rfc2373)
 377                                         ifconfig $i inet6 $j:: prefixlen 64 \
 378                                                 alias anycast
 379                                         ;;
 380                                 esac
 381                         done
 382                 fi
 383                 eval ipv6_ifconfig=\$ipv6_ifconfig_$i
 384                 if [ -n "${ipv6_ifconfig}" ]; then
 385                         rtsol_available=no
 386                         rtsol_interface=no
 387                         ifconfig $i inet6 ${ipv6_ifconfig} alias
 388                 fi
 389
 390                 if [ ${rtsol_available} = yes -a ${rtsol_interface} = yes ]
 391                 then
 392                         case ${i} in
 393                         lo0|gif[0-9]*|stf[0-9]*|faith[0-9]*|lp[0-9]*|sl[0-9]*|tun[0-9]*)
 394                                 ;;
 395                         *)
 396                                 rtsol_interfaces="${rtsol_interfaces} ${i}"
 397                                 ;;
 398                         esac
 399                 else
 400                         ifconfig $i inet6
 401                 fi
 402         done
 403
 404         if [ ${rtsol_available} = yes -a -n "${rtsol_interfaces}" ]; then
 405                 # Act as endhost - automatically configured.
 406                 # You can configure only single interface, as
 407                 # specification assumes that autoconfigured host has
 408                 # single interface only.
 409                 sysctl net.inet6.ip6.accept_rtadv=1
 410                 set ${rtsol_interfaces}
 411                 ifconfig $1 up
 412                 rtsol $1
 413         fi
 414
 415         for i in $interfaces; do
 416                 alias=0
 417                 while : ; do
 418                         eval ipv6_ifconfig=\$ipv6_ifconfig_${i}_alias${alias}
 419                         if [ -z "${ipv6_ifconfig}" ]; then
 420                                 break;
 421                         fi
 422                         ifconfig $i inet6 ${ipv6_ifconfig} alias
 423                         alias=$((${alias} + 1))
 424                 done
 425         done
 426 }
 427
 428 # Setup IPv6 to IPv4 mapping
 429 network6_stf_setup()
 430 {
 431         case ${stf_interface_ipv4addr} in
 432         [Nn][Oo] | '')
 433                 ;;
 434         *)
 435                 # assign IPv6 addr and interface route for 6to4 interface
 436                 stf_prefixlen=$((16+${stf_interface_ipv4plen:-0}))
 437                 OIFS="$IFS"
 438                 IFS=".$IFS"
 439                 set ${stf_interface_ipv4addr}
 440                 IFS="$OIFS"
 441                 hexfrag1=`hexprint $(($1*256 + $2))`
 442                 hexfrag2=`hexprint $(($3*256 + $4))`
 443                 ipv4_in_hexformat="${hexfrag1}:${hexfrag2}"
 444                 case ${stf_interface_ipv6_ifid} in
 445                 [Aa][Uu][Tt][Oo] | '')
 446                         for i in ${ipv6_network_interfaces}; do
 447                                 laddr=`network6_getladdr ${i}`
 448                                 case ${laddr} in
 449                                 '')
 450                                         ;;
 451                                 *)
 452                                         break
 453                                         ;;
 454                                 esac
 455                         done
 456                         stf_interface_ipv6_ifid=`expr "${laddr}" : \
 457                                                       'fe80::\(.*\)%\(.*\)'`
 458                         case ${stf_interface_ipv6_ifid} in
 459                         '')
 460                                 stf_interface_ipv6_ifid=0:0:0:1
 461                                 ;;
 462                         esac
 463                         ;;
 464                 esac
 465                 ifconfig stf0 create >/dev/null 2>&1
 466                 ifconfig stf0 inet6 2002:${ipv4_in_hexformat}:${stf_interface_ipv6_slaid:-0}:${stf_interface_ipv6_ifid} \
 467                         prefixlen ${stf_prefixlen}
 468                 # disallow packets to malicious 6to4 prefix
 469                 route add -inet6 2002:e000:: -prefixlen 20 ::1 -reject
 470                 route add -inet6 2002:7f00:: -prefixlen 24 ::1 -reject
 471                 route add -inet6 2002:0000:: -prefixlen 24 ::1 -reject
 472                 route add -inet6 2002:ff00:: -prefixlen 24 ::1 -reject
 473                 ;;
 474         esac
 475 }
 476
 477 # Setup static routes
 478 network6_static_routes_setup()
 479 {
 480         # Set up any static routes.
 481         case ${ipv6_defaultrouter} in
 482         [Nn][Oo] | '')
 483                 ;;
 484         *)
 485                 ipv6_static_routes="default ${ipv6_static_routes}"
 486                 ipv6_route_default="default ${ipv6_defaultrouter}"
 487                 ;;
 488         esac
 489         case ${ipv6_static_routes} in
 490         [Nn][Oo] | '')
 491                 ;;
 492         *)
 493                 for i in ${ipv6_static_routes}; do
 494                         eval ipv6_route_args=\$ipv6_route_${i}
 495                         route add -inet6 ${ipv6_route_args}
 496                 done
 497                 ;;
 498         esac
 499 }
 500
 501 # Setup faith
 502 network6_faith_setup()
 503 {
 504         case ${ipv6_faith_prefix} in
 505         [Nn][Oo] | '')
 506                 ;;
 507         *)
 508                 sysctl net.inet6.ip6.keepfaith=1
 509                 ifconfig faith0 create >/dev/null 2>&1
 510                 ifconfig faith0 up
 511                 for prefix in ${ipv6_faith_prefix}; do
 512                         prefixlen=`expr "${prefix}" : ".*/\(.*\)"`
 513                         case ${prefixlen} in
 514                         '')
 515                                 prefixlen=96
 516                                 ;;
 517                         *)
 518                                 prefix=`expr "${prefix}" : \
 519                                              "\(.*\)/${prefixlen}"`
 520                                 ;;
 521                         esac
 522                         route add -inet6 ${prefix} -prefixlen ${prefixlen} ::1
 523                         route change -inet6 ${prefix} -prefixlen ${prefixlen} \
 524                                 -ifp faith0
 525                 done
 526                 ;;
 527         esac
 528 }
 529
 530 # Install the "default interface" to kernel, which will be used
 531 # as the default route when there's no router.
 532 network6_default_interface_setup()
 533 {
 534         # Choose IPv6 default interface if it is not clearly specified.
 535         case ${ipv6_default_interface} in
 536         '')
 537                 for i in ${ipv6_network_interfaces}; do
 538                         case $i in
 539                         lo0|faith[0-9]*)
 540                                 continue
 541                                 ;;
 542                         esac
 543                         laddr=`network6_getladdr $i exclude_tentative`
 544                         case ${laddr} in
 545                         '')
 546                                 ;;
 547                         *)
 548                                 ipv6_default_interface=$i
 549                                 break
 550                                 ;;
 551                         esac
 552                 done
 553                 ;;
 554         esac
 555
 556         # Disallow unicast packets without outgoing scope identifiers,
 557         # or route such packets to a "default" interface, if it is specified.
 558         route add -inet6 fe80:: -prefixlen 10 ::1 -reject
 559         case ${ipv6_default_interface} in
 560         [Nn][Oo] | '')
 561                 route add -inet6 ff02:: -prefixlen 16 ::1 -reject
 562                 ;;
 563         *)
 564                 laddr=`network6_getladdr ${ipv6_default_interface}`
 565                 route add -inet6 ff02:: ${laddr} -prefixlen 16 -interface \
 566                         -cloning
 567
 568                 # Disable installing the default interface with the
 569                 # case net.inet6.ip6.forwarding=0 and
 570                 # net.inet6.ip6.accept_rtadv=0, due to avoid conflict
 571                 # between the default router list and the manual
 572                 # configured default route.
 573                 case ${ipv6_gateway_enable} in
 574                 [Yy][Ee][Ss])
 575                         ;;
 576                 *)
 577                         if [ `sysctl -n net.inet6.ip6.accept_rtadv` -eq 1 ]
 578                         then
 579                                 ndp -I ${ipv6_default_interface}
 580                         fi
 581                         ;;
 582                 esac
 583                 ;;
 584         esac
 585 }
 586
 587 network6_getladdr()
 588 {
 589         ifconfig $1 2>/dev/null | while read proto addr rest; do
 590                 case ${proto} in
 591                 inet6)
 592                         case ${addr} in
 593                         fe80::*)
 594                                 if [ -z "$2" ]; then
 595                                         echo ${addr}
 596                                         return
 597                                 fi
 598                                 case ${rest} in
 599                                 *tentative*)
 600                                         continue
 601                                         ;;
 602                                 *)
 603                                         echo ${addr}
 604                                         return
 605                                 esac
 606                         esac
 607                 esac
 608         done
 609 }