xref: /freebsd/libexec/rc/rc.d/hostid (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1#!/bin/sh
2#
3# Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
4# Copyright (c) 2015 Xin LI <delphij@FreeBSD.org>
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 AUTHORS 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 AUTHORS 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
29# PROVIDE: hostid
30# REQUIRE: sysctl
31# KEYWORD: nojail
32
33. /etc/rc.subr
34
35name="hostid"
36desc="Generate a unique host ID"
37start_cmd="hostid_start"
38stop_cmd=":"
39reset_cmd="hostid_reset"
40extra_commands="reset"
41rcvar="hostid_enable"
42
43hostid_set()
44{
45	uuid=$1
46	# Generate hostid based on hostuuid - take first four bytes from md5(uuid).
47	id=`echo -n $uuid | /sbin/md5`
48	id="0x${id%????????????????????????}"
49
50	# Set both kern.hostuuid and kern.hostid.
51	#
52	startmsg "Setting hostuuid: ${uuid}."
53	${SYSCTL} kern.hostuuid="${uuid}" >/dev/null
54	startmsg "Setting hostid: ${id}."
55	${SYSCTL} kern.hostid=${id} >/dev/null
56}
57
58valid_hostid()
59{
60	uuid=$1
61
62	x="[0-9a-f]"
63	y=$x$x$x$x
64
65	# Check against a blacklist before
66	# accepting the UUID.
67	case "${uuid}" in
68	00000000-0000-0000-0000-000000000000)
69		;;
70	00020003-0004-0005-0006-000700080009)
71		;;
72	03000200-0400-0500-0006-000700080009)
73		;;
74	07090201-0103-0301-0807-060504030201)
75		;;
76	11111111-1111-1111-1111-111111111111)
77		;;
78	11111111-2222-3333-4444-555555555555)
79		;;
80	4c4c4544-0000-2010-8020-80c04f202020)
81		;;
82	58585858-5858-5858-5858-585858585858)
83		;;
84	890e2d14-cacd-45d1-ae66-bc80e8bfeb0f)
85		;;
86	8e275844-178f-44a8-aceb-a7d7e5178c63)
87		;;
88	dc698397-fa54-4cf2-82c8-b1b5307a6a7f)
89		;;
90	fefefefe-fefe-fefe-fefe-fefefefefefe)
91		;;
92	*-ffff-ffff-ffff-ffffffffffff)
93		;;
94	$y$y-$y-$y-$y-$y$y$y)
95		return 0
96		;;
97	esac
98
99	return 1
100}
101
102hostid_hardware()
103{
104	uuid=`kenv -q smbios.system.uuid`
105
106	if valid_hostid $uuid; then
107		echo "${uuid}"
108	elif [ "$uuid" ]; then
109		echo "INVALID"
110	fi
111}
112
113hostid_generate()
114{
115	# First look for UUID in hardware.
116	uuid=`hostid_hardware`
117
118	# Warn about invalid UUIDs
119	if [ "${uuid}" = "INVALID" ]; then
120		warn "hostid: unable to figure out a UUID from DMI data, generating a new one"
121		sleep 2
122		uuid=""
123	fi
124
125	# Generate a random UUID if invalid or not found
126	if [ -z "${uuid}" ]; then
127		# If not found, fall back to software-generated UUID.
128		uuid=`uuidgen ${hostid_uuidgen_flags}`
129	fi
130	hostid_set $uuid
131}
132
133hostid_reset()
134{
135	hostid_generate
136	# Store newly generated UUID in ${hostid_file}.
137	echo $uuid > ${hostid_file}
138	if [ $? -ne 0 ]; then
139		warn "could not store hostuuid in ${hostid_file}."
140	fi
141}
142
143hostid_start()
144{
145	# If ${hostid_file} already exists, we take UUID from there.
146	if [ -r ${hostid_file} ]; then
147		read saved_hostid < ${hostid_file}
148		if valid_hostid ${saved_hostid}; then
149			hostid_set ${saved_hostid}
150			exit 0
151		fi
152	fi
153
154	# No hostid file, generate UUID.
155	hostid_generate
156}
157
158load_rc_config $name
159run_rc_command "$1"
160