device.subr revision 266290 
1230429Skibif [ ! "$_NETWORKING_DEVICE_SUBR" ]; then _NETWORKING_DEVICE_SUBR=1
2230429Skib#
3230429Skib# Copyright (c) 2006-2013 Devin Teske
4230429Skib# All rights reserved.
5230429Skib#
6230429Skib# Redistribution and use in source and binary forms, with or without
7230429Skib# modification, are permitted provided that the following conditions
8230429Skib# are met:
9230429Skib# 1. Redistributions of source code must retain the above copyright
10230429Skib#    notice, this list of conditions and the following disclaimer.
11230429Skib# 2. Redistributions in binary form must reproduce the above copyright
12230429Skib#    notice, this list of conditions and the following disclaimer in the
13230429Skib#    documentation and/or other materials provided with the distribution.
14230429Skib#
15230429Skib# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16230429Skib# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17230429Skib# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18230429Skib# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19230429Skib# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20230429Skib# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21230429Skib# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22230429Skib# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23230429Skib# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24230429Skib# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25230429Skib# SUCH DAMAGE.
26230429Skib#
27230429Skib# $FreeBSD: stable/10/usr.sbin/bsdconfig/networking/share/device.subr 266290 2014-05-17 03:28:43Z dteske $
28230429Skib#
29230429Skib############################################################ INCLUDES
30230429Skib
31230429SkibBSDCFG_SHARE="/usr/share/bsdconfig"
32230429Skib. $BSDCFG_SHARE/common.subr || exit 1
33230429Skibf_dprintf "%s: loading includes..." networking/device.subr
34230429Skibf_include $BSDCFG_SHARE/device.subr
35230864Skibf_include $BSDCFG_SHARE/dialog.subr
36230429Skibf_include $BSDCFG_SHARE/media/tcpip.subr
37230429Skibf_include $BSDCFG_SHARE/networking/common.subr
38230429Skibf_include $BSDCFG_SHARE/networking/ipaddr.subr
39230429Skibf_include $BSDCFG_SHARE/networking/media.subr
40230429Skibf_include $BSDCFG_SHARE/networking/netmask.subr
41230429Skibf_include $BSDCFG_SHARE/networking/resolv.subr
42230429Skibf_include $BSDCFG_SHARE/networking/routing.subr
43251047Skibf_include $BSDCFG_SHARE/strings.subr
44251047Skibf_include $BSDCFG_SHARE/sysrc.subr
45251047Skib
46251047SkibBSDCFG_LIBE="/usr/libexec/bsdconfig" APP_DIR="120.networking"
47251047Skibf_include_lang $BSDCFG_LIBE/$APP_DIR/include/messages.subr
48251047Skib
49251047Skib############################################################ GLOBALS
50230429Skib
51230429Skib#
52230429Skib# Settings used while interacting with various dialog(1) menus
53230429Skib#
54230429Skib: ${DIALOG_MENU_NETDEV_KICK_INTERFACES=1}
55230429Skib: ${DIALOG_MENU_NETDEV_SLEEP_AFTER_KICK=3}
56230429Skib
57230429Skib############################################################ FUNCTIONS
58230429Skib
59230429Skib# f_dialog_menu_netdev [$default]
60230429Skib#
61230429Skib# Display a list of network devices with descriptions. Optionally, if present
62230429Skib# and non-NULL, initially highlight $default interface.
63230429Skib#
64230429Skibf_dialog_menu_netdev()
65230429Skib{
66230429Skib	local menu_list # Calculated below
67230429Skib	local defaultitem="${1%\*}" # Trim trailing asterisk if present
68230429Skib
69230429Skib	#
70230429Skib	# Display a message to let the user know we're working...
71230429Skib	# (message will remain until we throw up the next dialog)
72230429Skib	#
73230429Skib	f_dialog_info "$msg_probing_network_interfaces"
74230429Skib
75230429Skib	#
76230429Skib	# Get list of usable network interfaces
77	#
78	local dev devs if iflist= # Calculated below
79	f_device_rescan_network
80	f_device_find "" $DEVICE_TYPE_NETWORK devs
81	for dev in $devs; do
82		f_struct "$dev" get name if || continue
83		# Skip unsavory interfaces
84		case "$if" in
85		lo[0-9]*|ppp[0-9]*|sl[0-9]*|faith[0-9]*) continue ;;
86		esac
87		iflist="$iflist $if"
88	done
89	iflist="${iflist# }"
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		for if in $iflist; do
99			f_quietly ifconfig $if up
100		done
101
102		if [ "$DIALOG_MENU_NETDEV_SLEEP_AFTER_KICK" ]; then
103			# interfaces need time to update carrier status
104			sleep $DIALOG_MENU_NETDEV_SLEEP_AFTER_KICK
105		fi
106	fi
107
108	#
109	# Mark any "active" interfaces with an asterisk (*)
110	# to the right of the device name.
111	#
112	menu_list=$(
113		for if in $iflist; do
114			f_device_desc $if $DEVICE_TYPE_NETWORK desc
115			f_shell_escape "$desc" desc
116			if f_device_is_active $if; then
117				printf "'%s\*' '%s'\n" $if "$desc"
118			else
119				printf "'%s' '%s'\n" $if "$desc"
120			fi
121		done
122	)
123	if [ ! "$menu_list" ]; then
124		f_show_msg "$msg_no_network_interfaces"
125		return $DIALOG_CANCEL
126	fi
127
128	# Maybe the default item was marked as active
129	f_device_is_active "$defaultitem" && defaultitem="$defaultitem*"
130
131	#
132	# Ask user to select an interface
133	#
134	local prompt="$msg_select_network_interface"
135	local hline="$hline_arrows_tab_enter"
136	local height width rows
137	eval f_dialog_menu_size height width rows \
138	                        \"\$DIALOG_TITLE\"     \
139	                        \"\$DIALOG_BACKTITLE\" \
140	                        \"\$prompt\"           \
141	                        \"\$hline\"            \
142	                        $menu_list
143	local menu_choice
144	menu_choice=$( eval $DIALOG \
145		--title \"\$DIALOG_TITLE\"         \
146		--backtitle \"\$DIALOG_BACKTITLE\" \
147		--hline \"\$hline\"                \
148		--ok-label \"\$msg_ok\"            \
149		--cancel-label \"\$msg_cancel\"    \
150		--default-item \"\$defaultitem\"   \
151		--menu \"\$prompt\"                \
152		$height $width $rows               \
153		$menu_list                         \
154		2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
155	)
156	local retval=$?
157	f_dialog_menutag_store -s "$menu_choice"
158	return $retval
159}
160
161# f_dialog_menu_netdev_edit $interface $ipaddr $netmask $options $dhcp
162#
163# Allow a user to edit network interface settings. Current values are not
164# probed but rather taken from the positional arguments.
165#
166f_dialog_menu_netdev_edit()
167{
168	local funcname=f_dialog_menu_netdev_edit
169	local interface="$1" ipaddr="$2" netmask="$3" options="$4" dhcp="$5"
170	local prompt menu_list height width rows
171
172	#
173	# Create a duplicate set of variables for change-tracking...
174	#
175	local ipaddr_orig="$2"  \
176	      netmask_orig="$3" \
177	      options_orig="$4" \
178	      dhcp_orig="$5"
179
180	local hline="$hline_arrows_tab_enter"
181	f_sprintf prompt "$msg_network_configuration" "$interface"
182
183	#
184	# Loop forever until the user has finished configuring the different
185	# components of the network interface.
186	#
187	# To apply the settings, we need to know each of the following:
188	# 	- IP Address
189	# 	- Network subnet mask
190	# 	- Additional ifconfig(8) options
191	#
192	# It is only when we have all of the above values that we can make the
193	# changes effective because all three options must be specified at-once
194	# to ifconfig(8).
195	#
196	local defaultitem=
197	while :; do
198		local dhcp_status="$msg_disabled"
199		[ "$dhcp" ] && dhcp_status="$msg_enabled"
200
201		#
202		# Display configuration-edit menu
203		#
204		menu_list="
205			'X $msg_save_exit' '$msg_return_to_previous_menu'
206			'2 $msg_dhcp'      '$dhcp_status'
207			'3 $msg_ipaddr4'   '$ipaddr'
208			'4 $msg_netmask'   '$netmask'
209			'5 $msg_options'   '$options'
210		"
211		eval f_dialog_menu_size height width rows \
212		                        \"\$DIALOG_TITLE\"     \
213		                        \"\$DIALOG_BACKTITLE\" \
214		                        \"\$prompt\"           \
215		                        \"\$hline\"            \
216		                        $menu_list
217		local tag
218		tag=$( eval $DIALOG \
219			--title \"\$DIALOG_TITLE\"         \
220			--backtitle \"\$DIALOG_BACKTITLE\" \
221			--hline \"\$hline\"                \
222			--ok-label \"\$msg_ok\"            \
223			--cancel-label \"\$msg_cancel\"    \
224			--help-button                      \
225			--help-label \"\$msg_help\"        \
226			${USE_XDIALOG:+--help \"\"}        \
227			--default-item \"\$defaultitem\"   \
228			--menu \"\$prompt\"                \
229			$height $width $rows               \
230			$menu_list                         \
231			2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
232		)
233		local retval=$?
234		f_dialog_data_sanitize tag
235
236		if [ $retval -eq $DIALOG_HELP ]; then
237			f_show_help "$TCP_HELPFILE"
238			continue
239		elif [ $retval -ne $DIALOG_OK ]; then
240			return $retval
241		else
242			# Only update default-item on success
243			defaultitem="$tag"
244		fi
245
246		#
247		# Call the below ``modifier functions'' whose job it is to take
248		# input from the user and assign the newly-acquired values back
249		# to the ipaddr, netmask, and options variables for us to re-
250		# read and display in the summary dialog.
251		#
252		case "$tag" in
253		X\ *) break ;;
254		2\ *) #
255		      # Proceed cautiously (confirm with the user) if/when NFS-
256		      # mounts are active. If the network on which these mounts
257		      # are made is changed parts of the system may hang.
258		      #
259		      if f_nfs_mounted && ! f_jailed; then
260			local setting
261			f_sprintf setting "$msg_current_dhcp_status" \
262		      	                  "$interface" "$dhcp_status"
263			f_noyes "$msg_nfs_mounts_may_cause_hang" "$setting" ||
264		      		continue
265		      fi
266
267		      #
268		      # Toggle DHCP status
269		      #
270		      if [ "$dhcp_status" = "$msg_enabled" ]; then
271		      	dhcp=
272		      else
273		      	trap - SIGINT
274		      	( # Execute within sub-shell to allow/catch Ctrl-C
275		      	  trap 'exit $FAILURE' SIGINT
276			  f_sprintf msg "$msg_scanning_for_dhcp" "$interface"
277		      	  if [ "$USE_XDIALOG" ]; then
278		      	  	(
279		      	  	  f_quietly ifconfig "$interface" delete
280		      	  	  f_quietly dhclient "$interface"
281		      	  	) |
282		      	  	  f_xdialog_info "$msg"
283		      	  else
284		      	  	f_dialog_info "$msg"
285		      	  	f_quietly ifconfig "$interface" delete
286		      	  	f_quietly dhclient "$interface"
287		      	  fi
288		      	)
289		      	retval=$?
290		      	trap 'interrupt' SIGINT
291		      	if [ $retval -eq $DIALOG_OK ]; then
292		      		dhcp=1
293		      		f_ifconfig_inet "$interface" ipaddr
294				f_ifconfig_inet6 "$interface" ipaddr6
295		      		f_ifconfig_netmask "$interface" netmask
296		      		options=
297
298		      		# Fixup search/domain in resolv.conf(5)
299		      		hostname=$( f_sysrc_get \
300				            	'hostname:-$(hostname)' )
301		      		f_dialog_resolv_conf_update "$hostname"
302		      	fi
303		      fi
304		      ;;
305		3\ *) f_dialog_input_ipaddr "$interface" "$ipaddr"
306		      [ $? -eq $DIALOG_OK ] && dhcp= ;;
307		4\ *) f_dialog_input_netmask "$interface" "$netmask"
308		      [ $? -eq $DIALOG_OK -a "$_netmask" ] && dhcp= ;;
309		5\ *) f_dialog_menu_media_options "$interface" "$options"
310		      [ $? -eq $DIALOG_OK ] && dhcp= ;;
311		esac
312	done
313
314	#
315	# Save only if the user changed at least one feature of the interface
316	#
317	if [ "$ipaddr"  != "$ipaddr_orig"  -o \
318	     "$netmask" != "$netmask_orig" -o \
319	     "$options" != "$options_orig" -o \
320	     "$dhcp"    != "$dhcp_orig" ]
321	then
322		f_show_info "$msg_saving_network_interface" "$interface"
323
324		local value=
325		if [ "$dhcp" ]; then
326			f_eval_catch $funcname f_sysrc_delete \
327				'f_sysrc_delete defaultrouter'
328			value=DHCP
329		else
330			value="inet $ipaddr netmask $netmask"
331			value="$value${options:+ }$options"
332		fi
333
334		f_eval_catch $funcname f_sysrc_set \
335			'f_sysrc_set "ifconfig_%s" "%s"' "$interface" "$value"
336	fi
337
338	#
339	# Re/Apply the settings if desired
340	#
341	if [ ! "$dhcp" ]; then
342		if f_yesno "$msg_bring_interface_up" "$interface"
343		then
344			f_show_info "$msg_bring_interface_up" "$interface"
345
346			local dr="$( f_sysrc_get defaultrouter )"
347			if [ "$dr" = "NO" -o ! "$dr" ]; then
348				f_route_get_default dr
349				[ "$dr" ] && f_eval_catch \
350					$funcname f_sysrc_set \
351					'f_sysrc_set defaultrouter "%s"' "$dr"
352			fi
353			#
354			# Make a backup of resolv.conf(5) before using
355			# ifconfig(8) and then restore it afterward. This
356			# allows preservation of nameservers acquired via
357			# DHCP on FreeBSD-8.x (normally lost as ifconfig(8)
358			# usage causes dhclient(8) to exit which scrubs
359			# resolv.conf(5) by-default upon termination).
360			#
361			f_quietly cp -fp "$RESOLV_CONF" "$RESOLV_CONF.$$"
362			if f_eval_catch $funcname ifconfig \
363				'ifconfig "%s" inet "%s" netmask "%s" %s' \
364				"$interface" "$ipaddr" "$netmask" "$options"
365			then
366				[ "$dr" -a "$dr" != "NO" ] &&
367					f_eval_catch $funcname route \
368						'route add default "%s"' "$dr"
369			fi
370			if cmp -s "$RESOLV_CONF" "$RESOLV_CONF.$$"; then
371				f_quietly rm -f "$RESOLV_CONF.$$"
372			else
373				f_quietly mv -f "$RESOLV_CONF.$$" "$RESOLV_CONF"
374			fi
375		fi
376	fi
377
378	return $DIALOG_OK
379}
380
381############################################################ MAIN
382
383f_dprintf "%s: Successfully loaded." networking/device.subr
384
385fi # ! $_NETWORKING_DEVICE_SUBR
386