usr.sbin/bsdconfig/networking/share/device.subr

   1 if [ ! "$_NETWORKING_DEVICE_SUBR" ]; then _NETWORKING_DEVICE_SUBR=1
   2 #
   3 # Copyright (c) 2006-2013 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$
  28 #
  29 ############################################################ INCLUDES
  30
  31 BSDCFG_SHARE="/usr/share/bsdconfig"
  32 . $BSDCFG_SHARE/common.subr || exit 1
  33 f_dprintf "%s: loading includes..." networking/device.subr
  34 f_include $BSDCFG_SHARE/device.subr
  35 f_include $BSDCFG_SHARE/dialog.subr
  36 f_include $BSDCFG_SHARE/media/tcpip.subr
  37 f_include $BSDCFG_SHARE/networking/common.subr
  38 f_include $BSDCFG_SHARE/networking/ipaddr.subr
  39 f_include $BSDCFG_SHARE/networking/media.subr
  40 f_include $BSDCFG_SHARE/networking/netmask.subr
  41 f_include $BSDCFG_SHARE/networking/resolv.subr
  42 f_include $BSDCFG_SHARE/networking/routing.subr
  43 f_include $BSDCFG_SHARE/sysrc.subr
  44
  45 BSDCFG_LIBE="/usr/libexec/bsdconfig" APP_DIR="120.networking"
  46 f_include_lang $BSDCFG_LIBE/$APP_DIR/include/messages.subr
  47
  48 ############################################################ GLOBALS
  49
  50 #
  51 # Settings used while interacting with various dialog(1) menus
  52 #
  53 : ${DIALOG_MENU_NETDEV_KICK_INTERFACES=1}
  54 : ${DIALOG_MENU_NETDEV_SLEEP_AFTER_KICK=3}
  55
  56 ############################################################ FUNCTIONS
  57
  58 # f_dialog_menu_netdev [$default]
  59 #
  60 # Display a list of network devices with descriptions. Optionally, if present
  61 # and non-NULL, initially highlight $default interface.
  62 #
  63 f_dialog_menu_netdev()
  64 {
  65         local defaultitem="${1%\*}" # Tim trailing asterisk if present
  66
  67         #
  68         # Display a message to let the user know we're working...
  69         # (message will remain until we throw up the next dialog)
  70         #
  71         f_dialog_info "$msg_probing_network_interfaces"
  72
  73         #
  74         # Get list of usable network interfaces
  75         #
  76         local d='[[:digit:]]+:'
  77         local iflist="`echo "$(ifconfig -l):" | sed -E -e "
  78                 # Convert all spaces to colons
  79                 y/ /:/
  80
  81                 # Prune unsavory interfaces
  82                 s/lo$d//g
  83                 s/ppp$d//g
  84                 s/sl$d//g
  85                 s/faith$d//g
  86
  87                 # Convert all colons back into spaces
  88                 y/:/ /
  89         "`"
  90
  91         #
  92         # Optionally kick interfaces in the head to get them to accurately
  93         # track the carrier status in realtime (required on FreeBSD).
  94         #
  95         if [ "$DIALOG_MENU_NETDEV_KICK_INTERFACES" ]; then
  96                 DIALOG_MENU_NETDEV_KICK_INTERFACES=
  97
  98                 local ifn
  99                 for ifn in $iflist; do
 100                         f_quietly ifconfig $ifn up
 101                 done
 102
 103                 if [ "$DIALOG_MENU_NETDEV_SLEEP_AFTER_KICK" ]; then
 104                         # interfaces need time to update carrier status
 105                         sleep $DIALOG_MENU_NETDEV_SLEEP_AFTER_KICK
 106                 fi
 107         fi
 108
 109         #
 110         # Mark any "active" interfaces with an asterisk (*)
 111         # to the right of the device name.
 112         #
 113         interfaces=$(
 114                 for ifn in $iflist; do
 115                         active=$( ifconfig $ifn | awk \
 116                         '
 117                                 ( $1 == "status:" ) \
 118                                 {
 119                                         if ( $2 == "active" ) { print 1; exit }
 120                                 }
 121                         ' )
 122                         printf "'%s%s' '%s'\n" \
 123                                 $ifn "${active:+*}" "$( f_device_desc $ifn )"
 124                 done
 125         )
 126         if [ ! "$interfaces" ]; then
 127                 f_show_msg "$msg_no_network_interfaces"
 128                 return $FAILURE
 129         fi
 130
 131         #
 132         # Maybe the default item was marked as active
 133         #
 134         if [ "$defaultitem" ]; then
 135                 ifconfig "$defaultitem" 2> /dev/null | awk \
 136                         '( $1 == "status:" && $2 != "active" ) { exit 0 }' ||
 137                         defaultitem="$defaultitem*"
 138         fi
 139
 140         local hline="$hline_arrows_tab_enter"
 141
 142         #
 143         # Ask user to select an interface
 144         #
 145         local prompt="$msg_select_network_interface"
 146         local height width rows
 147         eval f_dialog_menu_size height width rows \
 148                                 \"\$DIALOG_TITLE\"     \
 149                                 \"\$DIALOG_BACKTITLE\" \
 150                                 \"\$prompt\"           \
 151                                 \"\$hline\"            \
 152                                 $interfaces
 153         local menu_choice
 154         menu_choice=$( eval $DIALOG \
 155                 --title \"\$DIALOG_TITLE\"         \
 156                 --backtitle \"\$DIALOG_BACKTITLE\" \
 157                 --hline \"\$hline\"                \
 158                 --ok-label \"\$msg_ok\"            \
 159                 --cancel-label \"\$msg_cancel\"    \
 160                 --default-item \"\$defaultitem\"   \
 161                 --menu \"\$prompt\"                \
 162                 $height $width $rows               \
 163                 $interfaces                        \
 164                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
 165         )
 166         local retval=$?
 167         f_dialog_menutag_store -s "$menu_choice"
 168         return $retval
 169 }
 170
 171 # f_dialog_menu_netdev_edit $interface $ipaddr $netmask $options $dhcp
 172 #
 173 # Allow a user to edit network interface settings. Current values are not
 174 # probed but rather taken from the positional arguments.
 175 #
 176 f_dialog_menu_netdev_edit()
 177 {
 178         local interface="$1" ipaddr="$2" netmask="$3" options="$4" dhcp="$5"
 179         local prompt menu_list height width rows
 180
 181         #
 182         # Create a duplicate set of variables for change-tracking...
 183         #
 184         local ipaddr_orig="$2"  \
 185               netmask_orig="$3" \
 186               options_orig="$4" \
 187               dhcp_orig="$5"
 188
 189         local hline="$hline_arrows_tab_enter"
 190         prompt=$( printf "$msg_network_configuration" "$interface" )
 191
 192         #
 193         # Loop forever until the user has finished configuring the different
 194         # components of the network interface.
 195         #
 196         # To apply the settings, we need to know each of the following:
 197         #       - IP Address
 198         #       - Network subnet mask
 199         #       - Additional ifconfig(8) options
 200         #
 201         # It is only when we have all of the above values that we can make the
 202         # changes effective because all three options must be specified at-once
 203         # to ifconfig(8).
 204         #
 205         local defaultitem=
 206         while :; do
 207                 local dhcp_status="$msg_disabled"
 208                 [ "$dhcp" ] && dhcp_status="$msg_enabled"
 209
 210                 #
 211                 # Display configuration-edit menu
 212                 #
 213                 menu_list="
 214                         'X $msg_save_exit' '$msg_return_to_previous_menu'
 215                         '2 $msg_dhcp'      '$dhcp_status'
 216                         '3 $msg_ipaddr4'   '$ipaddr'
 217                         '4 $msg_netmask'   '$netmask'
 218                         '5 $msg_options'   '$options'
 219                 "
 220                 eval f_dialog_menu_size height width rows \
 221                                         \"\$DIALOG_TITLE\"     \
 222                                         \"\$DIALOG_BACKTITLE\" \
 223                                         \"\$prompt\"           \
 224                                         \"\$hline\"            \
 225                                         $menu_list
 226                 local tag
 227                 tag=$( eval $DIALOG \
 228                         --title \"\$DIALOG_TITLE\"         \
 229                         --backtitle \"\$DIALOG_BACKTITLE\" \
 230                         --hline \"\$hline\"                \
 231                         --ok-label \"\$msg_ok\"            \
 232                         --cancel-label \"\$msg_cancel\"    \
 233                         --help-button                      \
 234                         --help-label \"\$msg_help\"        \
 235                         ${USE_XDIALOG:+--help \"\"}        \
 236                         --default-item \"\$defaultitem\"   \
 237                         --menu \"\$prompt\"                \
 238                         $height $width $rows               \
 239                         $menu_list                         \
 240                         2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
 241                 )
 242                 local retval=$?
 243                 f_dialog_data_sanitize tag
 244
 245                 if [ $retval -eq 2 ]; then
 246                         # The Help button was pressed
 247                         f_show_help "$TCP_HELPFILE"
 248                         continue
 249                 elif [ $retval -ne $SUCCESS ]; then
 250                         # "Cancel" was chosen (-1) or ESC was pressed (255)
 251                         return $retval
 252                 else
 253                         # Only update default-item on success
 254                         defaultitem="$tag"
 255                 fi
 256
 257                 #
 258                 # Call the below ``modifier functions'' whose job it is to take
 259                 # input from the user and assign the newly-acquired values back
 260                 # to the ipaddr, netmask, and options variables for us to re-
 261                 # read and display in the summary dialog.
 262                 #
 263                 case "$tag" in
 264                 X\ *) break ;;
 265                 2\ *) #
 266                       # Proceed cautiously (confirm with the user) if/when NFS-
 267                       # mounts are active. If the network on which these mounts
 268                       # are made is changed parts of the system may hang.
 269                       #
 270                       if f_nfs_mounted && ! f_jailed; then
 271                         local setting="$( printf "$msg_current_dhcp_status" \
 272                                                  "$interface" "$dhcp_status" )"
 273                         f_noyes "$msg_nfs_mounts_may_cause_hang" "$setting" ||
 274                                 continue
 275                       fi
 276
 277                       #
 278                       # Toggle DHCP status
 279                       #
 280                       if [ "$dhcp_status" = "$msg_enabled" ]; then
 281                         dhcp=
 282                       else
 283                         trap - SIGINT
 284                         ( # Execute within sub-shell to allow/catch Ctrl-C
 285                           trap 'exit $FAILURE' SIGINT
 286                           msg=$( printf "$msg_scanning_for_dhcp" "$interface" )
 287                           if [ "$USE_XDIALOG" ]; then
 288                                 (
 289                                   f_quietly ifconfig $interface delete
 290                                   f_quietly dhclient $interface
 291                                 ) |
 292                                   f_xdialog_info "$msg"
 293                           else
 294                                 f_dialog_info "$msg"
 295                                 f_quietly ifconfig $interface delete
 296                                 f_quietly dhclient $interface
 297                           fi
 298                         )
 299                         retval=$?
 300                         trap 'interrupt' SIGINT
 301                         if [ $retval -eq $SUCCESS ]; then
 302                                 dhcp=1
 303                                 ipaddr=$( f_ifconfig_inet $interface )
 304                                 netmask=$( f_ifconfig_netmask $interface )
 305                                 options=
 306
 307                                 # Fixup search/domain in resolv.conf(5)
 308                                 hostname=$( f_sysrc_get \
 309                                                 'hostname:-$(hostname)' )
 310                                 f_dialog_resolv_conf_update "$hostname"
 311                         fi
 312                       fi
 313                       ;;
 314                 3\ *) f_dialog_input_ipaddr "$interface" "$ipaddr"
 315                       [ $? -eq $SUCCESS ] && dhcp= ;;
 316                 4\ *) f_dialog_input_netmask "$interface" "$netmask"
 317                       [ $? -eq $SUCCESS -a "$_netmask" ] && dhcp= ;;
 318                 5\ *) f_dialog_menu_media_options "$interface" "$options"
 319                       [ $? -eq $SUCCESS ] && dhcp= ;;
 320                 esac
 321         done
 322
 323         #
 324         # Save only if the user changed at least one feature of the interface
 325         #
 326         if [ "$ipaddr"  != "$ipaddr_orig"  -o \
 327              "$netmask" != "$netmask_orig" -o \
 328              "$options" != "$options_orig" -o \
 329              "$dhcp"    != "$dhcp_orig" ]
 330         then
 331                 f_show_info "$msg_saving_network_interface" "$interface"
 332
 333                 local value=
 334                 if [ "$dhcp" ]; then
 335                         f_sysrc_delete defaultrouter
 336                         value=DHCP
 337                 else
 338                         value="inet $ipaddr netmask $netmask"
 339                         value="$value${options:+ }$options"
 340                 fi
 341
 342                 f_sysrc_set ifconfig_$interface "$value"
 343         fi
 344
 345         #
 346         # Re/Apply the settings if desired
 347         #
 348         if [ ! "$dhcp" ]; then
 349                 if f_yesno "$msg_bring_interface_up" "$interface"
 350                 then
 351                         f_show_info "$msg_bring_interface_up" "$interface"
 352
 353                         local dr="$( f_sysrc_get defaultrouter )" err
 354                         if [ "$dr" = "NO" -o ! "$dr" ]; then
 355                                 dr=$( f_route_get_default )
 356                                 [ "$dr" ] && f_sysrc_set defaultrouter "$dr"
 357                         fi
 358                         #
 359                         # Make a backup of resolv.conf(5) before using
 360                         # ifconfig(8) and then restore it afterward. This
 361                         # allows preservation of nameservers acquired via
 362                         # DHCP on FreeBSD-8.x (normally lost as ifconfig(8)
 363                         # usage causes dhclient(8) to exit which scrubs
 364                         # resolv.conf(5) by-default upon termination).
 365                         #
 366                         f_quietly cp -fp "$RESOLV_CONF" "$RESOLV_CONF.$$"
 367                         err=$( ifconfig $interface inet $ipaddr \
 368                                 netmask $netmask $options 2>&1 )
 369                         if [ $? -eq $SUCCESS ]; then
 370                                 if [ "$dr" -a "$dr" != "NO" ]; then
 371                                         err=$( route add default "$dr" 2>&1 )
 372                                         [ $? -eq $SUCCESS ] || \
 373                                                 dialog_msgbox "$err"
 374                                 fi
 375                         else
 376                                 dialog_msgbox "$err"
 377                         fi
 378                         if cmp -s "$RESOLV_CONF" "$RESOLV_CONF.$$"; then
 379                                 f_quietly rm -f "$RESOLV_CONF.$$"
 380                         else
 381                                 f_quietly mv -f "$RESOLV_CONF.$$" "$RESOLV_CONF"
 382                         fi
 383                 fi
 384         fi
 385
 386         return $SUCCESS
 387 }
 388
 389 ############################################################ MAIN
 390
 391 f_dprintf "%s: Successfully loaded." networking/device.subr
 392
 393 fi # ! $_NETWORKING_DEVICE_SUBR