xref: /openbsd-src/usr.sbin/syspatch/syspatch.sh (revision 505ee9ea3b177e2387d907a91ca7da069f3f14d8)
1#!/bin/ksh
2#
3# $OpenBSD: syspatch.sh,v 1.164 2020/07/18 14:08:07 ajacoutot Exp $
4#
5# Copyright (c) 2016, 2017 Antoine Jacoutot <ajacoutot@openbsd.org>
6#
7# Permission to use, copy, modify, and distribute this software for any
8# purpose with or without fee is hereby granted, provided that the above
9# copyright notice and this permission notice appear in all copies.
10#
11# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18
19set -e
20umask 0022
21export PATH=/usr/bin:/bin:/usr/sbin:/sbin
22
23sp_err()
24{
25	echo "${0##*/}: ${1}" 1>&2 && return ${2:-1}
26}
27
28usage()
29{
30	echo "usage: ${0##*/} [-c | -l | -R | -r]"; return 1
31}
32
33apply_patch()
34{
35	local _edir _file _files _patch=$1 _rc=0 _s _upself=false
36	[[ -n ${_patch} ]]
37
38	_edir=${_TMP}/${_patch}
39
40	fetch_and_verify "syspatch${_patch}.tgz"
41
42	trap '' INT
43	echo "Installing patch ${_patch##${_OSrev}-}"
44	install -d ${_edir} ${_PDIR}/${_patch}
45
46	(($(sysctl -n hw.ncpufound) > 1)) &&
47		_s="-s @usr/share/relink/kernel/GENERIC/.*@@g" ||
48		_s="-s @usr/share/relink/kernel/GENERIC.MP/.*@@g"
49	_files="$(tar -xvzphf ${_TMP}/syspatch${_patch}.tgz -C ${_edir} \
50		${_s})" || { rm -r ${_PDIR}/${_patch}; return 1; }
51
52	checkfs ${_files}
53	create_rollback ${_patch} "${_files}"
54
55	for _file in ${_files}; do
56		((_rc == 0)) || break
57		[[ ${_file} == usr/sbin/syspatch ]] && _upself=true
58		install_file ${_edir}/${_file} /${_file} || _rc=$?
59	done
60
61	if ((_rc != 0)); then
62		sp_err "Failed to apply patch ${_patch##${_OSrev}-}" 0
63		rollback_patch; return ${_rc}
64	fi
65	# don't fill up /tmp when installing multiple patches at once; non-fatal
66	rm -rf ${_edir} ${_TMP}/syspatch${_patch}.tgz
67	trap exit INT
68
69	echo ${_files} | grep -Eqv \
70		'(^|[[:blank:]]+)usr/share/relink/kernel/GENERI(C|C.MP)/[[:print:]]+([[:blank:]]+|$)' ||
71		_KARL=true
72
73	(! ${_upself} || sp_err "updated itself, run it again to install \
74missing patches" 2)
75}
76
77# quick-and-dirty filesystem status and size checks:
78# - assume old files are about the same size as new ones
79# - ignore new (nonexistent) files
80# - ignore rollback tarball: create_rollback() will handle the failure
81# - compute total size of all files per fs, simpler and less margin for error
82#   (instead of computing before installing each file)
83checkfs()
84{
85	local _d _dev _df _files="${@}" _sz
86	[[ -n ${_files} ]]
87
88	set +e # ignore errors due to:
89	# - nonexistent files (i.e. syspatch is installing new files)
90	# - broken interpolation due to bogus devices like remote filesystems
91	eval $(cd / &&
92		stat -qf "_dev=\"\${_dev} %Sd\";
93			local %Sd=\"\${%Sd:+\${%Sd}\+}%Uz\"" ${_files}) \
94			2>/dev/null
95	set -e
96
97	for _d in $(printf '%s\n' ${_dev} | sort -u); do
98		[[ ${_d} != "??" ]] || sp_err "Unsupported filesystem, aborting"
99		mount | grep -v read-only | grep -q "^/dev/${_d} " ||
100			sp_err "Read-only filesystem, aborting"
101		_df=$(df -Pk | grep "^/dev/${_d} " | tr -s ' ' | cut -d ' ' -f4)
102		_sz=$(($((_d))/1024))
103		((_df > _sz)) || sp_err "No space left on ${_d}, aborting"
104	done
105}
106
107create_rollback()
108{
109	# XXX annotate new files so we can remove them if we rollback?
110	local _file _patch=$1 _rbfiles _rc=0
111	[[ -n ${_patch} ]]
112	shift
113	local _files="${@}"
114	[[ -n ${_files} ]]
115
116	for _file in ${_files}; do
117		[[ -f /${_file} ]] && _rbfiles="${_rbfiles} ${_file}"
118	done
119
120	tar -C / -czf ${_PDIR}/${_patch}/rollback.tgz ${_rbfiles} || _rc=$?
121
122	if ((_rc != 0)); then
123		sp_err "Failed to create rollback patch ${_patch##${_OSrev}-}" 0
124		rm -r ${_PDIR}/${_patch}; return ${_rc}
125	fi
126}
127
128fetch_and_verify()
129{
130	local _tgz=$1 _title="Get/Verify"
131	[[ -n ${_tgz} ]]
132
133	[[ -t 0 ]] || echo "${_title} ${_tgz}"
134	unpriv -f "${_TMP}/${_tgz}" ftp -N syspatch -VD "${_title}" -o \
135		"${_TMP}/${_tgz}" "${_MIRROR}/${_tgz}"
136
137	(cd ${_TMP} && sha256 -qC ${_TMP}/SHA256 ${_tgz})
138}
139
140install_file()
141{
142	# XXX handle hard link, dir->file, file->dir?
143	local _dst=$2 _fgrp _fmode _fown _src=$1
144	[[ -f ${_src} && -f ${_dst} ]]
145
146	if [[ -h ${_src} ]]; then
147		ln -sf $(readlink ${_src}) ${_dst}
148	else
149		eval $(stat -f "_fmode=%OMp%OLp _fown=%Su _fgrp=%Sg" ${_src})
150		install -DFp -m ${_fmode} -o ${_fown} -g ${_fgrp} ${_src} \
151			${_dst}
152	fi
153}
154
155ls_installed()
156{
157	local _p
158	for _p in ${_PDIR}/${_OSrev}-+([[:digit:]])_+([[:alnum:]_-]); do
159		[[ -f ${_p}/rollback.tgz ]] && echo ${_p##*/${_OSrev}-}
160	done
161}
162
163ls_missing()
164{
165	local _c _f _cmd _l="$(ls_installed)" _p _sha=${_TMP}/SHA256
166
167	# don't output anything on stdout to prevent corrupting the patch list
168	unpriv -f "${_sha}.sig" ftp -N syspatch -MVo "${_sha}.sig" \
169		"${_MIRROR}/SHA256.sig" >/dev/null
170	unpriv -f "${_sha}" signify -Veq -x ${_sha}.sig -m ${_sha} -p \
171		/etc/signify/openbsd-${_OSrev}-syspatch.pub >/dev/null
172
173	# sig file less than 3 lines long doesn't list any patch (new release)
174	(($(grep -c ".*" ${_sha}) < 3)) && return
175
176	set -o pipefail
177	grep -Eo "syspatch${_OSrev}-[[:digit:]]{3}_[[:alnum:]_-]+" ${_sha} |
178		while read _c; do _c=${_c##syspatch${_OSrev}-} &&
179		[[ -n ${_l} ]] && echo ${_c} | grep -qw -- "${_l}" || echo ${_c}
180	done | while read _p; do
181		_cmd="ftp -N syspatch -MVo - \
182			${_MIRROR}/syspatch${_OSrev}-${_p}.tgz"
183		unpriv "${_cmd}" | tar tzf - | while read _f; do
184			# no earlier version of _all_ files contained in the tgz
185			# exists on the system, it means a missing set: skip it
186			[[ -f /${_f} ]] || continue && echo ${_p} && pkill -u \
187				_syspatch -xf "${_cmd}" || true && break
188		done
189	done | sort -V # only used as a buffer to display all patches at once
190	set +o pipefail
191}
192
193rollback_patch()
194{
195	local _edir _file _files _patch _rc=0
196
197	_patch="$(ls_installed | tail -1)"
198	[[ -n ${_patch} ]] || return 0 # nothing to rollback
199
200	_edir=${_TMP}/${_patch}-rollback
201	_patch=${_OSrev}-${_patch}
202
203	trap '' INT
204	echo "Reverting patch ${_patch##${_OSrev}-}"
205	install -d ${_edir}
206
207	_files="$(tar xvzphf ${_PDIR}/${_patch}/rollback.tgz -C ${_edir})"
208	checkfs ${_files} ${_PDIR} # check for read-only /var/syspatch
209
210	for _file in ${_files}; do
211		((_rc == 0)) || break
212		install_file ${_edir}/${_file} /${_file} || _rc=$?
213	done
214
215	((_rc != 0)) || rm -r ${_PDIR}/${_patch} || _rc=$?
216	((_rc == 0)) ||
217		sp_err "Failed to revert patch ${_patch##${_OSrev}-}" ${_rc}
218	rm -rf ${_edir} # don't fill up /tmp when using `-R'; non-fatal
219	trap exit INT
220
221	echo ${_files} | grep -Eqv \
222		'(^|[[:blank:]]+)usr/share/relink/kernel/GENERI(C|C.MP)/[[:print:]]+([[:blank:]]+|$)' ||
223		_KARL=true
224}
225
226trap_handler()
227{
228	set +e # we're trapped
229	rm -rf "${_TMP}"
230
231	# in case a patch added a new directory (install -D)
232	if [[ -n ${_PATCHES} ]]; then
233		mtree -qdef /etc/mtree/4.4BSD.dist -p / -U >/dev/null
234		[[ -f /var/sysmerge/xetc.tgz ]] &&
235			mtree -qdef /etc/mtree/BSD.x11.dist -p / -U >/dev/null
236	fi
237
238	if ${_KARL}; then
239		echo -n "Relinking to create unique kernel..."
240		if /usr/libexec/reorder_kernel; then
241			echo " done; reboot to load the new kernel"
242		else
243			echo " failed!\n!!! \"/usr/libexec/reorder_kernel\" \
244must be run manually to install the new kernel"
245			exit 1
246		fi
247	fi
248
249	${_PATCH_APPLIED} && echo "Errata can be reviewed under ${_PDIR}"
250}
251
252unpriv()
253{
254	local _file=$2 _rc=0 _user=_syspatch
255
256	if [[ $1 == -f && -n ${_file} ]]; then
257		>${_file}
258		chown "${_user}" "${_file}"
259		chmod 0711 ${_TMP}
260		shift 2
261	fi
262	(($# >= 1))
263
264	eval su -s /bin/sh ${_user} -c "'$@'" || _rc=$?
265
266	[[ -n ${_file} ]] && chown root "${_file}"
267
268	return ${_rc}
269}
270
271# only run on release (not -current nor -stable)
272set -A _KERNV -- $(sysctl -n kern.version |
273	sed 's/^OpenBSD \([1-9][0-9]*\.[0-9]\)\([^ ]*\).*/\1 \2/;q')
274((${#_KERNV[*]} > 1)) && sp_err "Unsupported release: ${_KERNV[0]}${_KERNV[1]}"
275
276[[ $@ == @(|-[[:alpha:]]) ]] || usage; [[ $@ == @(|-(c|R|r)) ]] &&
277	(($(id -u) != 0)) && sp_err "need root privileges"
278[[ $@ == @(|-(R|r)) ]] && pgrep -qxf '/bin/ksh .*reorder_kernel' &&
279	sp_err "cannot apply patches while reorder_kernel is running"
280
281_OSrev=${_KERNV[0]%.*}${_KERNV[0]#*.}
282[[ -n ${_OSrev} ]]
283
284_MIRROR=$(while read _line; do _line=${_line%%#*}; [[ -n ${_line} ]] &&
285	print -r -- "${_line}"; done </etc/installurl | tail -1) 2>/dev/null
286[[ ${_MIRROR} == @(file|ftp|http|https)://* ]] ||
287	_MIRROR=https://cdn.openbsd.org/pub/OpenBSD
288_MIRROR="${_MIRROR}/syspatch/${_KERNV[0]}/$(machine)"
289
290_PATCH_APPLIED=false
291_PDIR="/var/syspatch"
292_TMP=$(mktemp -d -p ${TMPDIR:-/tmp} syspatch.XXXXXXXXXX)
293_KARL=false
294
295readonly _KERNV _MIRROR _OSrev _PDIR _TMP
296
297trap 'trap_handler' EXIT
298trap exit HUP INT TERM
299
300while getopts clRr arg; do
301	case ${arg} in
302		c) ls_missing ;;
303		l) ls_installed ;;
304		R) while [[ -n $(ls_installed) ]]; do rollback_patch; done ;;
305		r) rollback_patch ;;
306		*) usage ;;
307	esac
308done
309shift $((OPTIND - 1))
310(($# != 0)) && usage
311
312# default action: apply all patches
313if ((OPTIND == 1)); then
314	# remove non matching release /var/syspatch/ content
315	for _D in ${_PDIR}/{.[!.],}*; do
316		[[ -e ${_D} ]] || continue
317		[[ ${_D##*/} == ${_OSrev}-+([[:digit:]])_+([[:alnum:]_-]) ]] &&
318			[[ -f ${_D}/rollback.tgz ]] || rm -r ${_D}
319	done
320	_PATCHES=$(ls_missing) # can't use errexit in a for loop
321	for _PATCH in ${_PATCHES}; do
322		apply_patch ${_OSrev}-${_PATCH}
323		_PATCH_APPLIED=true
324	done
325fi
326