xref: /freebsd/usr.sbin/bsdconfig/networking/share/netmask.subr (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1if [ ! "$_NETWORKING_NETMASK_SUBR" ]; then _NETWORKING_NETMASK_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#
28############################################################ INCLUDES
29
30BSDCFG_SHARE="/usr/share/bsdconfig"
31. $BSDCFG_SHARE/common.subr || exit 1
32f_dprintf "%s: loading includes..." networking/netmask.subr
33f_include $BSDCFG_SHARE/dialog.subr
34f_include $BSDCFG_SHARE/networking/common.subr
35f_include $BSDCFG_SHARE/strings.subr
36
37BSDCFG_LIBE="/usr/libexec/bsdconfig" APP_DIR="120.networking"
38f_include_lang $BSDCFG_LIBE/$APP_DIR/include/messages.subr
39
40############################################################ FUNCTIONS
41
42# f_dialog_maskerror $error $netmask
43#
44# Display a msgbox with the appropriate error message for an error returned by
45# the f_validate_netmask function.
46#
47f_dialog_maskerror()
48{
49	local error="$1" netmask="$2"
50
51	[ ${error:-0} -ne 0 ] || return $SUCCESS
52
53	case "$error" in
54	1) f_show_msg "$msg_ipv4_mask_field_contains_invalid_chars" "$mask" ;;
55	2) f_show_msg "$msg_ipv4_mask_field_is_null" "$mask" ;;
56	3) f_show_msg "$msg_ipv4_mask_field_exceeds_max_value" "$mask" ;;
57	4) f_show_msg "$msg_ipv4_mask_field_missing_or_extra" "$mask" ;;
58	5) f_show_msg "$msg_ipv4_mask_field_invalid_value" "$mask" ;;
59	esac
60}
61
62# f_dialog_validate_netmask $netmask
63#
64# Returns zero if the given argument (a subnet mask) is of the proper format.
65#
66# If the subnet mask is determined to be invalid, the appropriate error will be
67# displayed using the f_dialog_maskerror function above.
68#
69f_dialog_validate_netmask()
70{
71	local netmask="$1"
72
73	f_validate_netmask "$netmask"
74	local retval=$?
75
76	# Produce an appropriate error message if necessary.
77	[ $retval -eq $SUCCESS ] || f_dialog_maskerror $retval "$netmask"
78
79	return $retval
80}
81
82# f_dialog_input_netmask $interface $netmask
83#
84# Edits the IP netmask of the given interface.
85#
86f_dialog_input_netmask()
87{
88	local interface="$1" _netmask="$2" _input
89
90	#
91	# Return with-error when there are NFS-mounts currently active. If the
92	# subnet mask is changed while NFS-exported directories are mounted,
93	# the system may hang (if any NFS mounts are using that interface).
94	#
95	if f_nfs_mounted && ! f_jailed; then
96		local setting
97		f_sprintf setting "$msg_current_subnet" \
98		                  "$interface" "$_netmask"
99		f_noyes "$msg_nfs_mounts_may_cause_hang" "$setting" ||
100			return $DIALOG_CANCEL
101	fi
102
103	#
104	# Loop until the user provides taint-free input.
105	#
106	local msg
107	f_sprintf msg "$msg_please_enter_subnet_mask" "$interface"
108	while :; do
109		#
110		# Return error status if:
111		# - User has either pressed ESC or chosen Cancel/No
112		# - User has not made any changes to the given value
113		#
114		f_dialog_input _input "$msg" "$_netmask" \
115		               "$hline_num_punc_tab_enter" || return $?
116		[ "$_netmask" = "$_input" ] && return $DIALOG_CANCEL
117
118		# Return success if NULL value was entered
119		[ "$_input" ] || return $DIALOG_OK
120
121		# Take only the first "word" of the user's input
122		_netmask="$_input"
123		_netmask="${_netmask%%[$IFS]*}"
124
125		# Taint-check the user's input
126		f_dialog_validate_netmask "$_netmask" && break
127	done
128
129	netmask="$_netmask"
130}
131
132############################################################ MAIN
133
134f_dprintf "%s: Successfully loaded." networking/netmask.subr
135
136fi # ! $_NETWORKING_NETMASK_SUBR
137