xref: /openbsd-src/usr.sbin/syspatch/syspatch.sh (revision 2ae78c74dfdf0852cde326e3f2bd0858763fbb87)
1#!/bin/ksh
2#
3# $OpenBSD: syspatch.sh,v 1.24 2016/11/01 20:46:02 ajacoutot Exp $
4#
5# Copyright (c) 2016 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
20
21sp_err()
22{
23	echo "${@}" 1>&2 && return 1
24}
25
26usage()
27{
28	sp_err "usage: ${0##*/} [-c | -l | -r]"
29}
30
31needs_root()
32{
33	[[ $(id -u) -ne 0 ]] && sp_err "${0##*/}: need root privileges"
34}
35
36apply_patch()
37{
38	local _explodir _file _files _patch=$1
39	[[ -n ${_patch} ]]
40
41	local _explodir=${_TMP}/${_patch}
42	mkdir -p ${_explodir}
43
44	_files="$(tar xvzphf ${_TMP}/${_patch}.tgz -C ${_explodir})"
45	create_rollback ${_patch} "${_files}"
46
47	trap "" 2
48	for _file in ${_files}; do
49		if [[ ${_file} == @(bsd|bsd.mp) ]]; then
50			if ! install_kernel ${_explodir}/${_file}; then
51				rollback_patch
52				sp_err "Failed to apply ${_patch} (/${_file})"
53			fi
54		else
55			if ! install_file ${_explodir}/${_file} /${_file}; then
56				rollback_patch
57				sp_err "Failed to apply ${_patch} (/${_file})"
58			fi
59		fi
60	done
61	trap - 2
62}
63
64apply_patches()
65{
66	needs_root
67	local _m _patch _patches="$(ls_missing)"
68
69	for _patch in ${_patches}; do
70		fetch_and_verify "${_patch}"
71		apply_patch "${_patch}"
72	done
73
74	sp_cleanup
75}
76
77create_rollback()
78{
79	local _file _patch=$1 _rbfiles
80	[[ -n ${_patch} ]]
81	shift
82	local _files="${@}"
83	[[ -n ${_files} ]]
84
85	[[ -d ${_PDIR}/${_REL} ]] || install -d ${_PDIR}/${_REL}
86
87	for _file in ${_files}; do
88		[[ -f /${_file} ]] || continue
89		_rbfiles="${_rbfiles} ${_file}"
90	done
91
92	trap "" 2
93	if ! (cd / &&
94		# GENERIC.MP: substitute bsd.mp->bsd and bsd.sp->bsd
95		if ${_BSDMP} &&
96			tar -tzf ${_TMP}/${_patch}.tgz bsd >/dev/null 2>&1; then
97			tar -czf ${_PDIR}/${_REL}/rollback-${_patch}.tgz \
98				-s '/^bsd.mp$//' -s '/^bsd$/bsd.mp/' \
99				-s '/^bsd.sp$/bsd/' bsd.sp ${_rbfiles}
100		else
101			tar -czf ${_PDIR}/${_REL}/rollback-${_patch}.tgz \
102				${_rbfiles}
103		fi
104	); then
105		rm ${_PDIR}/${_REL}/rollback-${_patch}.tgz
106		sp_err "Failed to create rollback for ${_patch}"
107	fi
108	trap - 2
109}
110
111fetch_and_verify()
112{
113	# XXX privsep ala installer
114	local _patch=$1
115	[[ -n ${_patch} ]]
116
117	local _key="/etc/signify/openbsd-${_RELINT}-syspatch.pub" _p
118
119	# XXX handle bogus PATCH_PATH (ftp(1) interactive mode)
120	${_FETCH} -o "${_TMP}/SHA256.sig" "${PATCH_PATH}/SHA256.sig"
121
122	# XXX see above
123	${_FETCH} -mD "Applying" -o "${_TMP}/${_patch}.tgz" \
124		"${PATCH_PATH}/${_patch}.tgz"
125	(cd ${_TMP} &&
126		/usr/bin/signify -qC -p ${_key} -x SHA256.sig ${_patch}.tgz)
127}
128
129install_file()
130{
131	# XXX handle sym/hardlinks?
132	# XXX handle dir becoming file and vice-versa?
133	local _src=$1 _dst=$2
134	[[ -f ${_src} && -f ${_dst} ]]
135
136	local _fmode _fown _fgrp
137	eval $(stat -f "_fmode=%OMp%OLp _fown=%Su _fgrp=%Sg" ${_src})
138
139	install -DFS -m ${_fmode} -o ${_fown} -g ${_fgrp} ${_src} ${_dst}
140}
141
142install_kernel()
143{
144	local _bsd=/bsd _kern=$1
145	[[ -n ${_kern} ]]
146
147	# only save the original release kernel once
148	[[ -f /bsd.rollback${_RELINT} ]] ||
149		install -FSp /bsd /bsd.rollback${_RELINT}
150
151	if ${_BSDMP}; then
152		[[ ${_kern##*/} == bsd ]] && _bsd=/bsd.sp
153	fi
154
155	if [[ -n ${_bsd} ]]; then
156		install -FS ${_kern} ${_bsd}
157	fi
158}
159
160ls_avail()
161{
162	# XXX see above + catch missing index.txt
163	${_FETCH} -o - "${PATCH_PATH}/index.txt" |
164		sed 's/^.* //;s/^M//;s/.tgz$//' |
165		grep "^syspatch-${_RELINT}-.*$" | sort -V
166}
167
168ls_installed()
169{
170	local _p
171	# no _REL dir = no installed patch
172	cd ${_PDIR}/${_REL} 2>/dev/null && set -- * || return 0
173	for _p; do
174		 [[ ${_p} = rollback-syspatch-${_RELINT}-*.tgz ]] &&
175			_p=${_p#rollback-} && echo ${_p%.tgz}
176	done | sort -V
177}
178
179ls_missing()
180{
181	local _a _installed
182	_installed="$(ls_installed)"
183
184	for _a in $(ls_avail); do
185		if [[ -n ${_installed} ]]; then
186			echo ${_a} | grep -qw -- "${_installed}" || echo ${_a}
187		else
188			echo ${_a}
189		fi
190	done
191}
192
193rollback_patch()
194{
195	needs_root
196	local _explodir _file _files _patch
197
198	_patch="$(ls_installed | sort -V | tail -1)"
199	[[ -n ${_patch} ]]
200
201	_explodir=${_TMP}/rollback-${_patch}
202	mkdir -p ${_explodir}
203
204	_files="$(tar xvzphf ${_PDIR}/${_REL}/rollback-${_patch}.tgz -C \
205		${_explodir})"
206
207	trap "" 2
208	for _file in ${_files}; do
209		if [[ ${_file} == @(bsd|bsd.mp) ]]; then
210			install_kernel ${_explodir}/${_file} ||
211				sp_err "Failed to rollback ${_patch} (/${_file})"
212		else
213			install_file ${_explodir}/${_file} /${_file} ||
214				sp_err "Failed to rollback ${_patch} (/${_file})"
215		fi
216	done
217
218	rm ${_PDIR}/${_REL}/rollback-${_patch}.tgz \
219		${_PDIR}/${_REL}/${_patch#syspatch-${_RELINT}-}.patch.sig
220	trap - 2
221
222	sp_cleanup
223}
224
225sp_cleanup()
226{
227	local _d _k
228
229	# remove non matching release /var/syspatch/ content
230	cd ${_PDIR} && set -- *
231	for _d; do
232		[[ -e ${_d} ]] || continue
233		[[ ${_d} == ${_REL} ]] || rm -r ${_d}
234	done
235
236	# remove non matching release rollback kernel
237	set -- /bsd.rollback*
238	for _k; do
239		[[ -f ${_k} ]] || continue
240		[[ ${_k} == /bsd.rollback${_RELINT} ]] || rm ${_k}
241	done
242
243	# remove rollback kernel if all kernel syspatches have been reverted
244	cmp -s /bsd /bsd.rollback${_RELINT} && rm /bsd.rollback${_RELINT}
245
246	# non-fatal: the syspatch|rollback tarball should have correct perms
247	for _m in 4.4BSD BSD.x11; do
248		mtree -qdef /etc/mtree/${_m}.dist -p / -U >/dev/null || true
249	done
250}
251
252# only run on release (not -current nor -stable)
253set -A _KERNV -- $(sysctl -n kern.version |
254	sed 's/^OpenBSD \([0-9]\.[0-9]\)\([^ ]*\).*/\1 \2/;q')
255[[ -z ${_KERNV[1]} ]]
256
257# check args
258[[ $@ == @(|-[[:alpha:]]) ]] || usage
259
260# XXX to be discussed; check for $ARCH?
261[[ -n ${PATCH_PATH} ]]
262[[ -d ${PATCH_PATH} ]] && PATCH_PATH="file://$(readlink -f ${PATCH_PATH})"
263
264# XXX hw.ncpufound ?
265[[ $(sysctl -n hw.ncpu) -gt 1 ]] && _BSDMP=true || _BSDMP=false
266_FETCH="/usr/bin/ftp -MV -k ${FTP_KEEPALIVE-0}"
267_PDIR="/var/syspatch"
268_REL=${_KERNV[0]}
269_RELINT=${_REL%\.*}${_REL#*\.}
270_TMP=$(mktemp -d -p /tmp syspatch.XXXXXXXXXX)
271readonly _BSDMP _FETCH _PDIR _REL _RELINT _TMP
272[[ -n ${_REL} && -n ${_RELINT} ]]
273
274trap "rm -rf ${_TMP}; exit 1" 3 9 13 15 ERR
275
276while getopts clr arg; do
277	case ${arg} in
278		c) ls_missing;;
279		l) ls_installed;;
280		r) rollback_patch;;
281		*) usage;;
282	esac
283done
284shift $(( OPTIND -1 ))
285[[ $# -ne 0 ]] && usage
286
287[[ ${OPTIND} != 1 ]] || apply_patches
288
289rm -rf ${_TMP}
290