xref: /freebsd/usr.sbin/bsdconfig/networking/share/routing.subr (revision c6ec7d31830ab1c80edae95ad5e4b9dba10c47ac)
1if [ ! "$_NETWORKING_ROUTING_SUBR" ]; then _NETWORKING_ROUTING_SUBR=1
2#
3# Copyright (c) 2006-2012 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 (INLUDING, 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
31BSDCFG_SHARE="/usr/share/bsdconfig"
32. $BSDCFG_SHARE/common.subr || exit 1
33f_include $BSDCFG_SHARE/sysrc.subr
34f_include $BSDCFG_SHARE/dialog.subr
35f_include $BSDCFG_SHARE/networking/common.subr
36f_include $BSDCFG_SHARE/networking/ipaddr.subr
37
38BSDCFG_LIBE="/usr/libexec/bsdconfig" APP_DIR="120.networking"
39f_include_lang $BSDCFG_LIBE/$APP_DIR/include/messages.subr
40
41############################################################ FUNCTIONS
42
43# f_route_get_default
44#
45# Returns the IP address of the currently active default router.
46#
47f_route_get_default()
48{
49	route -n get default 2> /dev/null | awk \
50	'
51		BEGIN { found = 0 }
52		( $1 == "gateway:" ) \
53		{
54			print $2
55			found = 1
56			exit
57		}
58		END { exit ! found }
59	'
60}
61
62# f_dialog_input_defaultrouter
63#
64# Edits the default router.
65#
66f_dialog_input_defaultrouter()
67{
68	#
69	# Get the defaultrouter. When this is not configured, the default is
70	# "NO", however we don't ever want to present this default to the user
71	# in the following dialog. If the current value is "NO", then try to
72	# obtain the value from the running system using route(8).
73	#
74	# NOTE: Our `f_route_get_default' function will return NULL if the
75	# system does not have an active default router set (which is what we
76	# want).
77	#
78	local defaultrouter="$( f_sysrc_get 'defaultrouter:-NO' )"
79	local defaultrouter_orig="$defaultrouter" # for change-tracking
80	case "$defaultrouter" in
81	[Nn][Oo])
82		defaultrouter=$( f_route_get_default )
83		;;
84	esac
85
86	#
87	# Return with-error when there are NFS-mounts currently active. If the
88	# default router/gateway is changed while NFS-exported directories are
89	# mounted, the system will hang.
90	#
91	if f_nfs_mounted && ! f_jailed; then
92		local setting="$( printf "$msg_current_default_router" \
93		                         "$defaultrouter" )"
94		f_show_msg "$msg_nfs_mounts_may_cause_hang" "$setting"
95		return $FAILURE
96	fi
97
98	#
99	# Loop until the user provides taint-free input.
100	#
101	local retval
102	while :; do
103		defaultrouter=$( f_dialog_input \
104			"$msg_please_enter_default_router" \
105			"$defaultrouter" "$hline_num_punc_tab_enter"
106		)
107		retval=$?
108		[ "$defaultrouter" ] || return $SUCCESS
109		[ $retval -eq $SUCCESS ] || return $retval
110
111		# Taint-check the user's input
112		f_dialog_validate_ipaddr "$defaultrouter" && break
113	done
114
115	#
116	# Save only if the user changed the default router/gateway.
117	#
118	if [ "$defaultrouter" != "$defaultrouter_orig" ]; then
119		f_dialog_info "$msg_saving_default_router"
120
121		# Save the default router/gateway
122		f_sysrc_set defaultrouter "$defaultrouter"
123	fi
124
125	#
126	# Only ask to apply setting if the current defaultrouter is different
127	# than the stored configuration (in rc.conf(5)).
128	#
129	if [ "$( f_route_get_default )" != "$defaultrouter" ]; then
130		f_dialog_clear
131		f_dialog_yesno "$(
132			printf "$msg_activate_default_router" \
133			       "$( f_route_get_default )" "$defaultrouter"
134		)"
135
136		if [ $? -eq $SUCCESS ]; then
137			local err
138
139			# Apply the default router/gateway
140			f_quietly route delete default
141			err=$( route add default "$defaultrouter" 2>&1 )
142			if [ $? -ne $SUCCESS ]; then
143				f_dialog_msgbox "$err"
144				return $FAILURE
145			fi
146		fi
147	fi
148}
149
150fi # ! $_NETWORKING_ROUTING_SUBR
151