===================================================================
RCS file: /cvs/openbsd/fw_update/fw_install.sh,v
retrieving revision 1.3
retrieving revision 1.94
diff -u -r1.3 -r1.94
--- openbsd/fw_update/fw_install.sh	2021/10/05 01:48:59	1.3
+++ openbsd/fw_update/fw_install.sh	2021/12/21 02:16:01	1.94
@@ -1,127 +1,310 @@
 #!/bin/ksh
-set -e
+#	$OpenBSD: fw_install.sh,v 1.94 2021/12/21 02:16:01 afresh1 Exp $
+#
+# Copyright (c) 2021 Andrew Hewus Fresh <afresh1@openbsd.org>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-scan_dmesg() {
-	# no bsort for now
-	sed -n "$1" /var/run/dmesg.boot
+set -o errexit -o pipefail -o nounset
+set +o monitor
+export PATH=/usr/bin:/bin:/usr/sbin:/sbin
+
+CFILE=SHA256.sig
+DESTDIR=${DESTDIR:-}
+FWPATTERNS="${DESTDIR}/usr/share/misc/firmware_patterns"
+
+VNAME=${VNAME:-$(sysctl -n kern.osrelease)}
+VERSION=${VERSION:-"${VNAME%.*}${VNAME#*.}"}
+
+HTTP_FWDIR="$VNAME"
+VTYPE=$( sed -n "/^OpenBSD $VNAME\([^ ]*\).*$/s//\1/p" \
+    /var/run/dmesg.boot | sed '$!d' )
+[[ $VTYPE == -!(stable) ]] && HTTP_FWDIR=snapshots
+
+FWURL=http://firmware.openbsd.org/firmware/${HTTP_FWDIR}
+FWPUB_KEY=${DESTDIR}/etc/signify/openbsd-${VERSION}-fw.pub
+
+DOWNLOAD=true
+INSTALL=true
+LOCALSRC=
+
+tmpdir() {
+	local _i=1 _dir
+
+	# If we're not in the installer,
+	# we have mktemp and a more hostile environment.
+	if [ -x /usr/bin/mktemp ]; then
+		_dir=$( mktemp -d "${1}-XXXXXXXXX" )
+	else
+		until _dir="${1}.$_i.$RANDOM" && mkdir -- "$_dir" 2>/dev/null; do
+		    ((++_i < 10000)) || return 1
+		done
+	fi
+
+	echo "$_dir"
 }
 
+fetch() {
+	local _src="${FWURL}/${1##*/}" _dst=$1 _user=_file _pid _exit _error=''
+
+	# If we're not in the installer,
+	# we have su(1) and doas(1) is unlikely to be configured.
+	set -o monitor # make sure ftp gets its own process group
+	(
+	if [ -x /usr/bin/su ]; then
+		exec /usr/bin/su -s /bin/ksh "$_user" -c \
+		    "/usr/bin/ftp -D 'Get/Verify' -Vm -o- '$_src'" > "$_dst"
+	else
+		exec /usr/bin/doas -u "$_user" \
+		    /usr/bin/ftp -D 'Get/Verify' -Vm -o- "$_src" > "$_dst"
+	fi
+	) & _pid=$!
+	set +o monitor
+
+	trap "kill -TERM '-$_pid'; exit 1" EXIT INT QUIT ABRT TERM
+
+	SECONDS=0
+	_last=0
+	while kill -0 -"$_pid" 2>/dev/null; do
+		if [[ $SECONDS -gt 12 ]]; then
+			set -- $( ls -ln "$_dst" 2>/dev/null )
+			if [[ $_last -ne $5 ]]; then
+				_last=$5
+				SECONDS=0
+				sleep 1
+			else
+				kill -INT -"$_pid"
+				_error=" (timed out)"
+			fi
+		else
+			sleep 1
+		fi
+	done
+
+	set +o errexit
+	wait "$_pid"
+	_exit=$?
+	set -o errexit
+
+	trap "" EXIT INT QUIT ABRT TERM
+
+	if [ "$_exit" -ne 0 ]; then
+		rm -f "$_dst"
+		echo "Cannot fetch $_src$_error" >&2
+		return 1
+	fi
+}
+
+verify() {
+	# On the installer we don't get sha256 -C, so fake it.
+	if ! fgrep -qx "SHA256 (${1##*/}) = $( /bin/sha256 -qb "$1" )" "$CFILE"; then
+		echo "Checksum test for ${1##*/} failed." >&2
+		return 1
+	fi
+}
+
+devices_needing_firmware() {
+	local _d _m _line _dmesgtail _last='' _nl=$( echo )
+
+	# When we're not in the installer, the dmesg.boot can
+	# contain multiple boots, so only look in the last one
+	_dmesgtail="$( echo ; sed -n 'H;/^OpenBSD/h;${g;p;}' /var/run/dmesg.boot |
+	    grep -e "^[a-z][a-z]*[0-9]" -e " not configured " )"
+
+	grep -v '^[[:space:]]*#' "$FWPATTERNS" |
+	    while read -r _d _m; do
+		[ "$_d" = "$_last" ] && continue
+		[ "$_m" ]             || _m="${_nl}${_d}[0-9] at "
+		[ "$_m" = "${_m#^}" ] || _m="${_nl}${_m#^}"
+
+		if [[ $_dmesgtail = *$_m* ]]; then
+			echo "$_d"
+			_last="$_d"
+		fi
+	    done
+}
+
+firmware_filename() {
+	local _f
+	_f="$( sed -n "s/.*(\($1-firmware-.*\.tgz\)).*/\1/p" "$CFILE" | sed '$!d' )"
+	! [ "$_f" ] && echo "Unable to find firmware for $1" >&2 && return 1
+	echo "$_f"
+}
+
+firmware_devicename() {
+	local _d="${1##*/}"
+	_d="${_d%-firmware-*}"
+	echo "$_d"
+}
+
 installed_firmware() {
-	for fw in ${PKGDIR}/$1-firmware*; do
+	for fw in "${DESTDIR}/var/db/pkg/$1-firmware"*; do
 		[ -e "$fw" ] || continue
-		echo ${fw##*/}
+		echo "${fw##*/}"
 	done
 }
 
-set -A _KERNV -- $( scan_dmesg '/^OpenBSD \([1-9][0-9]*\.[0-9]\)\([^ ]*\) .*/ { s//\1 \2/p; q; }' )
-VNAME=${_KERNV[0]}
-OSDIR=$VNAME
-if ((${#_KERNV[*]} > 1)) && [ "$_KERNV[1]" = "-current" -o "$_KERNV[1]" = "-beta" ]; then
-	OSDIR=snapshots
-fi
+add_firmware () {
+	local _f="${1##*/}"
+	local _pkgdir="${DESTDIR}/var/db/pkg/${_f%.tgz}"
+	ftp -D "Install" -Vmo- "file:${1}" |
+		tar -s ",^\+,${_pkgdir}/+," \
+		    -s ",^firmware,${DESTDIR}/etc/firmware," \
+		    -C / -zxphf - "+*" "firmware/*"
 
-FWURL=http://firmware.openbsd.org/firmware/${OSDIR}
-PKGDIR=${DESTDIR}/var/db/pkg
-PATTERNS="file:${0%/*}/firmware_patterns"
+	# TODO: Should we mark these so real fw_update can -Drepair?
+	ed -s "${_pkgdir}/+CONTENTS" <<EOL
+/^@comment pkgpath/ -1a
+@option manual-installation
+@option firmware
+@comment install-script
+.
+w
+EOL
+}
 
-drivers=$(
-	last=''
-	ftp -D "Detecting" -Vmo- $PATTERNS |
-	while read d m; do
-		grep=fgrep
-		[ "$last" = "$d" ] && continue
-		[ "$m" ] || m="^$d[0-9][0-9]* at "
-		[ "$m" != "${m#^}" ] && grep=grep
-		$grep -q "$m" /var/run/dmesg.boot || continue
-		echo $d
-		last=$d
+delete_firmware() {
+	local _cwd _pkg="$1" _pkgdir="${DESTDIR}/var/db/pkg"
+
+	# TODO: Check hash for files before deleting
+	echo "Uninstalling $_pkg"
+	_cwd="${_pkgdir}/$_pkg"
+
+	set -A _remove -- "${_cwd}/+CONTENTS" "${_cwd}"
+
+	while read -r c g; do
+		case $c in
+		@cwd) _cwd="${DESTDIR}$g"
+		  ;;
+		@*) continue
+		  ;;
+		*) set -A _remove -- "$_cwd/$c" "${_remove[@]}"
+		  ;;
+		esac
+	done < "${_pkgdir}/${_pkg}/+CONTENTS"
+
+	# We specifically rm -f here because not removing files/dirs
+	# is probably not worth failing over.
+	for _r in "${_remove[@]}" ; do
+		if [ -d "$_r" ]; then
+			# Try hard not to actually remove recursively
+			# without rmdir on the install media.
+			[ "$_r/*" = "$( echo "$_r"/* )" ] && rm -rf "$_r"
+		else
+			rm -f "$_r"
+		fi
 	done
-)
+}
 
-if [ -z "$drivers" ]; then
-	echo "No devices found which need firmware files to be downloaded." >&2
-	exit 0
-fi
+usage() {
+	echo "usage:  ${0##*/} [-D | -L] [driver | file ...]"
+	exit 2
+}
 
-tmpdir=${DESTDIR}/tmp/fw_update
-[ -e "$tmpdir" ] && rm -rf "$tmpdir"
-mkdir -p "$tmpdir"
-cd "$tmpdir"
+OPT_D=
+OPT_L=
+while getopts DL name
+do
+       case "$name" in
+       D) OPT_D=true ;;
+       L) OPT_L=true ;;
+       ?) usage 2 ;;
+       esac
+done
+shift $((OPTIND - 1))
 
-# TODO: Drop privs during fetch and verify
-ftp -D Get -Vm "$FWURL/SHA256.sig"
+[ "$OPT_D" ] && [ "$OPT_L" ] && usage 1
 
-# Probably should bundle the firmware sigfile on the installer,
-# although we can just get it from the recently installed system.
-if [ "$DESTDIR" ]; then
-	sigfile=$( sed -n '/^untrusted comment: verify with \(.*\)$/ { s//\1/p; q; }' SHA256.sig )
-	if [ ! -e "/etc/signify/$sigfile" ] \
-	  && [ -e "${DESTDIR}/etc/signify/$sigfile" ]; then
-		cp -a "${DESTDIR}/etc/signify/$sigfile" "/etc/signify/$sigfile"
-	fi
+if [ "$OPT_D" ]; then
+	# "Download only" means local dir and don't install
+	INSTALL=false
+	LOCALSRC=.
+elif [ "$OPT_L" ]; then
+	# "Local" means don't download, install from local dir
+	DOWNLOAD=false
+	LOCALSRC=.
+else
+	LOCALSRC="$( tmpdir "${DESTDIR}/tmp/fw_install" )"
 fi
 
-signify -Ve -x SHA256.sig -m - < SHA256.sig > SHA256
+CFILE="$LOCALSRC/$CFILE"
 
-for d in $drivers; do
-	firmware=$( sed -n "s/.*(\($d-firmware-.*\.tgz\)).*/\1/p" SHA256 )
-	installed=$( installed_firmware $d )
+if "$INSTALL" && [ -x /usr/bin/id ] && [ $(/usr/bin/id -u) != 0 ]; then
+	echo "need root privileges" >&2
+	exit 1
+fi
 
-	for i in $installed; do
-		if [ "$firmware" = "$i.tgz" ]; then
-			echo "Firmware for $d already installed ($installed)"
-			continue 2
-		fi
-	done
+set -A devices -- "$@"
 
-	mkdir $d
+if [ ! "${devices[*]:-}" ]; then
+	echo -n "Detecting firmware ..."
+	set -A devices -- $( devices_needing_firmware )
+	[ "${devices[*]:-}" ] && echo " found." || echo " done."
+fi
 
-	# TODO: Drop privs during fetch and verify
-	ftp -D "Get/Verify" -Vmo- "$FWURL/$firmware" | sha256 -bph "$d/h" > "$firmware"
-	fgrep -qx "SHA256 ($firmware) = $(<$d/h)" SHA256
+[ "${devices[*]:-}" ] || exit
 
-	# TODO: Check hash for files before deleting
-	if [ "$installed" ] && [ -e "${PKGDIR}/$installed/+CONTENTS" ]; then
-		echo "Uninstalling $installed"
-		cwd=${PKGDIR}/$installed
+if "$DOWNLOAD"; then
+	fetch "$CFILE"
+	! signify -qVep "$FWPUB_KEY" -x "$CFILE" -m "$CFILE" &&
+	    echo "Signature check of SHA256.sig failed" >&2 && exit 1
+fi
 
-		remove="${cwd}/+CONTENTS ${cwd}"
+for f in "${devices[@]}"; do
+	d="$( firmware_devicename "$f" )"
 
-		while read c g; do
-			case $c in
-			@cwd) cwd=$g
-			  ;;
-			@*) continue
-			  ;;
-			*)  remove="$cwd/$c $remove"
-			  ;;
-			esac
-		done < "${PKGDIR}/$installed/+CONTENTS"
+	if [ "$f" = "$d" ]; then
+		f=$( firmware_filename "$d" || true )
+		[ "$f" ] || continue
+		f="$LOCALSRC/$f"
+	elif ! "$INSTALL" && ! grep -Fq "($f)" "$CFILE" ; then
+		echo "Cannot download local file $f" >&2
+		exit 2
+	fi
 
-		for r in $remove ; do
-			if [ -d "$r" ]; then
-				# Try hard not to actually remove recursively
-				# without rmdir on the install media.
-				[ "$r/*" = $( echo "$r"/* ) ] && rm -rf "$r"
-			else
-				rm -f "$r"
+	set -A installed -- $( installed_firmware "$d" )
+
+	if "$INSTALL" && [ "${installed[*]:-}" ]; then
+		for i in "${installed[@]}"; do
+			if [ "${f##*/}" = "$i.tgz" ]; then
+				echo "$i already installed"
+				continue 2
 			fi
 		done
 	fi
 
-	# TODO: Add some details about the install to +CONTENTS like pkg_add
-	# TODO: Or, maybe we save the firmware someplace and make pkg_add reinstall
-	echo "Installing $firmware"
-	tar -zxphf "$firmware" -C /etc "firmware/*"
-	mkdir -p ${PKGDIR}/${firmware%.tgz}/
-	tar -zxphf "$firmware" -C "${PKGDIR}/${firmware%.tgz}" "+*"
-    ed -s "${PKGDIR}/${firmware%.tgz}/+CONTENTS" <<EOL
-/^@comment pkgpath/ -1a
-@option manual-installation
-@option firmware
-@comment install-script
-.
-w
-EOL
+	if [ -e "$f" ]; then
+		if "$DOWNLOAD"; then
+			echo "Verify existing ${f##*/}"
+			verify "$f" || continue
+		# else assume it was verified when downloaded
+		fi
+	elif "$DOWNLOAD"; then
+		fetch  "$f" || continue
+		verify "$f" || continue
+	elif "$INSTALL"; then
+		echo "Cannot install ${f##*/}, not found" >&2
+		continue
+	fi
+
+	"$INSTALL" || continue
+
+	if [ "${installed[*]:-}" ]; then
+		for i in "${installed[@]}"; do
+			delete_firmware "$i"
+		done
+	fi
+
+	add_firmware "$f"
 done