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