xref: /freebsd/usr.sbin/bsdconfig/networking/share/hostname.subr (revision 6574b8ed19b093f0af09501d2c9676c28993cb97)
1if [ ! "$_NETWORKING_HOSTNAME_SUBR" ]; then _NETWORKING_HOSTNAME_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
31BSDCFG_SHARE="/usr/share/bsdconfig"
32. $BSDCFG_SHARE/common.subr || exit 1
33f_dprintf "%s: loading includes..." networking/hostname.subr
34f_include $BSDCFG_SHARE/dialog.subr
35f_include $BSDCFG_SHARE/networking/common.subr
36f_include $BSDCFG_SHARE/networking/resolv.subr
37f_include $BSDCFG_SHARE/sysrc.subr
38
39BSDCFG_LIBE="/usr/libexec/bsdconfig" APP_DIR="120.networking"
40f_include_lang $BSDCFG_LIBE/$APP_DIR/include/messages.subr
41
42############################################################ FUNCTIONS
43
44# f_dialog_hnerror $error $hostname
45#
46# Display a msgbox with the appropriate error message for an error returned by
47# the f_validate_hostname function.
48#
49f_dialog_hnerror()
50{
51	local error="$1" fqhn="$2"
52
53	[ ${error:-0} -ne 0 ] || return $SUCCESS
54
55	case "$error" in
56	1) f_show_msg "$msg_hostname_label_contains_invalid_chars" "$fqhn" ;;
57	2) f_show_msg \
58		"$msg_hostname_label_starts_or_ends_with_hyphen" "$fqhn" ;;
59	3) f_show_msg "$msg_hostname_label_is_null" "$fqhn" ;;
60	63) f_show_msg "$msg_hostname_label_exceeds_max_length" "$fqhn" ;;
61	255) f_show_msg "$msg_hostname_exceeds_max_length" "$fqhn" ;;
62	esac
63}
64
65# f_dialog_validate_hostname $hostname
66#
67# Returns zero if the given argument (a fully-qualified hostname) is compliant
68# with standards set-forth in RFC's 952 and 1123 of the Network Working Group:
69#
70# RFC 952 - DoD Internet host table specification
71# http://tools.ietf.org/html/rfc952
72#
73# RFC 1123 - Requirements for Internet Hosts - Application and Support
74# http://tools.ietf.org/html/rfc1123
75#
76# If the hostname is determined to be invalid, the appropriate error will be
77# displayed using the f_dialog_hnerror function above.
78#
79f_dialog_validate_hostname()
80{
81	local fqhn="$1"
82
83	f_validate_hostname "$fqhn"
84	local retval=$?
85
86	# Produce an appropriate error message if necessary.
87	[ $retval -eq $SUCCESS ] || f_dialog_hnerror $retval "$fqhn"
88
89	return $retval
90}
91
92# f_dialog_input_hostname
93#
94# Edits the current hostname.
95#
96f_dialog_input_hostname()
97{
98	local funcname=f_dialog_input_hostname
99	local hostname="$( f_sysrc_get 'hostname:-$(hostname)' )"
100	local hostname_orig="$hostname" # for change-tracking
101
102	local msg
103	if [ "$USE_XDIALOG" ]; then
104		msg="$xmsg_please_enter_fqhn"
105	else
106		msg="$msg_please_enter_fqhn"
107	fi
108
109	#
110	# Loop until the user provides taint-free input.
111	#
112	while :; do
113		f_dialog_input hostname "$msg" "$hostname" \
114		               "$hline_alnum_punc_tab_enter" || return $?
115		# Taint-check the user's input
116		f_dialog_validate_hostname "$hostname" && break
117	done
118
119	#
120	# Save hostname only if the user changed the hostname.
121	#
122	if [ "$hostname" != "$hostname_orig" ]; then
123		f_dialog_info "$msg_saving_hostname"
124		f_eval_catch $funcname f_sysrc_set \
125			'f_sysrc_set hostname "%s"' "$hostname"
126	fi
127
128	#
129	# Update resolv.conf(5) search/domain directives
130	#
131	f_dialog_resolv_conf_update "$hostname"
132
133	#
134	# Only ask to apply setting if the current hostname is different than
135	# the stored configuration (in rc.conf(5)).
136	#
137	if [ "$( hostname )" != "$( f_sysrc_get hostname )" ]; then
138		[ ! "$USE_XDIALOG" ] && f_dialog_clear
139
140		#
141		# If connected via ssh(1) and performing X11-Forwarding, don't
142		# allow the hostname to be changed to prevent the fatal error
143		# "X11 connection rejected because of wrong authentication."
144		#
145		if [ "$USE_XDIALOG" -a "$SSH_CONNECTION" ]; then
146			f_show_msg "$msg_activate_hostname_x11warning" \
147			           "$( hostname )" "$hostname"
148		else
149			f_yesno "$msg_activate_hostname" \
150			        "$( hostname )" "$hostname" \
151			&& hostname "$hostname"
152		fi
153	fi
154
155	return $DIALOG_OK
156}
157
158############################################################ MAIN
159
160f_dprintf "%s: Successfully loaded." networking/hostname.subr
161
162fi # ! $_NETWORKING_HOSTNAME_SUBR
163