=================================================================== RCS file: /cvs/openbsd/fw_update/fw_install.sh,v retrieving revision 1.39 retrieving revision 1.127 diff -u -r1.39 -r1.127 --- openbsd/fw_update/fw_install.sh 2021/12/01 02:19:00 1.39 +++ openbsd/fw_update/fw_install.sh 2021/12/25 02:38:33 1.127 @@ -1,7 +1,6 @@ #!/bin/ksh -# $OpenBSD: fw_install.sh,v 1.39 2021/12/01 02:19:00 afresh1 Exp $ -set -e - +# $OpenBSD: fw_install.sh,v 1.127 2021/12/25 02:38:33 afresh1 Exp $ +# # Copyright (c) 2021 Andrew Hewus Fresh # # Permission to use, copy, modify, and distribute this software for any @@ -16,241 +15,445 @@ # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -# Fake up some things from install.sub that we don't need to actually do -prefetcharea_fs_list() { - echo "${DESTDIR}/tmp" -} +set -o errexit -o pipefail -o nounset -o noclobber -o noglob +set +o monitor +export PATH=/usr/bin:/bin:/usr/sbin:/sbin -# tmpdir, do_as, unpriv, and unpriv2 are from install.sub +CFILE=SHA256.sig +DESTDIR=${DESTDIR:-} +FWPATTERNS="${DESTDIR}/usr/share/misc/firmware_patterns" -# Create a temporary directory based on the supplied directory name prefix. +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 + +VERBOSE=false +DELETE=false +DOWNLOAD=true +INSTALL=true +LOCALSRC= + +unset FTPPID +REMOVE_LOCALSRC=false +cleanup() { + set +o errexit # ignore errors from killing ftp + [ "${FTPPID:-}" ] && kill -TERM -"$FTPPID" #2>/dev/null + "$REMOVE_LOCALSRC" && rm -rf "$LOCALSRC" +} +trap cleanup EXIT + tmpdir() { local _i=1 _dir - until _dir="${1?}.$_i.$RANDOM" && mkdir -- "$_dir" 2>/dev/null; do - ((++_i < 10000)) || return 1 - done + # 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" } -# Run a command ($2+) as unprivileged user ($1). -# Take extra care that after "cmd" no "user" processes exist. -# -# Optionally: -# - create "file" and chown it to "user" -# - after "cmd", chown "file" back to root -# -# Usage: do_as user [-f file] cmd -do_as() { - (( $# >= 2 )) || return +fetch() { + local _src="${FWURL}/${1##*/}" _dst=$1 _user=_file _exit _error='' - local _file _rc _user=$1 - shift + # 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 + ( + flags=-VM + "$VERBOSE" && flags=-vm + if [ -x /usr/bin/su ]; then + exec /usr/bin/su -s /bin/ksh "$_user" -c \ + "/usr/bin/ftp -N '${0##/}' -D 'Get/Verify' $flags -o- '$_src'" > "$_dst" + else + exec /usr/bin/doas -u "$_user" \ + /usr/bin/ftp -N "${0##/}" -D 'Get/Verify' $flags -o- "$_src" > "$_dst" + fi + ) & FTPPID=$! + set +o monitor - if [[ $1 == -f ]]; then - _file=$2 - shift 2 + SECONDS=0 + _last=0 + while kill -0 -"$FTPPID" 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 -"$FTPPID" + _error=" (timed out)" + fi + else + sleep 1 + fi + done + + set +o errexit + wait "$FTPPID" + _exit=$? + set -o errexit + + unset FTPPID + + if [ "$_exit" -ne 0 ]; then + rm -f "$_dst" + echo "Cannot fetch $_src$_error" >&2 + return 1 fi +} - if [[ -n $_file ]]; then - >$_file - chown "$_user" "$_file" +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 +} - doas -u "$_user" "$@" - _rc=$? +firmware_in_dmesg() { + local _d _m _line _dmesgtail _last='' _nl=$( echo ) - while doas -u "$_user" kill -9 -1 2>/dev/null; do - echo "Processes still running for user $_user after: $@" - sleep 1 - done + # 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 " )" - [[ -n $_file ]] && chown root "$_file" + 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#^}" - return $_rc + if [[ $_dmesgtail = *$_m* ]]; then + echo "$_d" + _last="$_d" + fi + done } -unpriv() { - do_as _sndio "$@" +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" } -unpriv2() { - do_as _file "$@" +firmware_devicename() { + local _d="${1##*/}" + _d="${_d%-firmware-*}" + echo "$_d" } -VNAME=${VNAME:-$(sysctl -n kern.osrelease)} -VERSION=${VERSION:-"${VNAME%.*}${VNAME#*.}"} -FWDIR=${FWDIR:-$VNAME} -MODE=${MODE:-install} +installed_firmware() { + local _pre="$1" _match="$2" _post="$3" _firmware + set -sA _firmware -- $( + set +o noglob + grep -Fxl '@option firmware' \ + "${DESTDIR}/var/db/pkg/"$_pre"$_match"$_post"/+CONTENTS" \ + 2>/dev/null || true + set -o noglob + ) -# TODO: We need the firmware for the system we just installed -# not the one we booted from. For example: -# * booting from a snapshot bsd.rd that thinks it is the 7.0 release -# will install the firmware from the 7.0 directory instead of -# from the snapshots dir. -# If they're using sysupgrade, then the installer kernel will be correct. -# If we're doing this in the installer we can check what they picked -# for downloading sets and use that value. -# Otherwise, the fw_update after first boot will fix it up for us. + [ "${_firmware[*]:-}" ] || return 0 + for fw in "${_firmware[@]}"; do + fw="${fw%/+CONTENTS}" + echo "${fw##*/}" + done +} -HTTP_FWDIR=$FWDIR -set -- sed -n "/^OpenBSD $VNAME\([^ ]*\).*$/s//\1/p" /var/run/dmesg.boot -[[ $1 == -!(stable) ]] && HTTP_FWDIR=snapshots +detect_firmware() { + local _devices _last='' _d -FWURL=http://firmware.openbsd.org/firmware/${HTTP_FWDIR} -FWPUB_KEY=${DESTDIR}/etc/signify/openbsd-${VERSION}-fw.pub -FWPATTERNS="${DESTDIR}/usr/share/misc/firmware_patterns" + set -sA _devices -- $( + firmware_in_dmesg + for _d in $( installed_firmware '*' '-firmware-' '*' ); do + echo "$( firmware_devicename "$_d" )" + done + ) -# TODO: support srclocal installation of firmware somehow -fw_install() { - local _src=$1 _tmpfs_list _tmpfs _tmpsrc \ - _t=Get _cfile="/tmp/SHA256" _pkgdir=${DESTDIR}/var/db/pkg \ - _f _r _remove _i _installed - local _srclocal=false _unpriv=unpriv + [ "${_devices[*]:-}" ] || return 0 + for _d in "${_devices[@]}"; do + [[ $_last = $_d ]] && continue + echo $_d + _last="$_d" + done +} - echo "Let's $MODE firmware!" - local _d _drivers=$( - last='' - while read _d _m; do - grep=grep - [ "$last" = "$_d" ] && continue - [ "$_m" ] || _m="^$_d[0-9][0-9]* at " - [ "$_m" = "${_m#^}" ] && grep=fgrep - $grep -q "$_m" /var/run/dmesg.boot || continue - echo $_d - last=$_d - done < $FWPATTERNS - ) +add_firmware () { + local _f="${1##*/}" _pkgname + local _tmpdir="$( tmpdir "${DESTDIR}/var/db/pkg/.firmware" )" + local flags=-VM + "$VERBOSE" && flags=-vm + ftp -N "${0##/}" -D "Install" "$flags" -o- "file:${1}" | + tar -s ",^\+,${_tmpdir}/+," \ + -s ",^firmware,${DESTDIR}/etc/firmware," \ + -C / -zxphf - "+*" "firmware/*" - if [ -z "$_drivers" ]; then - echo "No devices found which need firmware files to be downloaded." - return + _pkgname="$( sed -n '/^@name /{s///p;q;}' "${_tmpdir}/+CONTENTS" )" + if [ ! "$_pkgname" ]; then + echo "Failed to extract name from $1, partial install" 2>&1 + rm -rf "$_tmpdir" + return 1 fi - ! _tmpfs_list=$(prefetcharea_fs_list) && - echo "Cannot determine prefetch area" >&2 && return + # TODO: Should we mark these so real fw_update can -Drepair? + ed -s "${_tmpdir}/+CONTENTS" <$_tmpsrc/t && - $_unpriv cat $_tmpsrc/t - ) >/dev/null 2>&1 && break || - rm -r $_tmpsrc +delete_firmware() { + local _cwd _pkg="$1" _pkgdir="${DESTDIR}/var/db/pkg" + + # TODO: Check hash for files before deleting + "$VERBOSE" && echo "Uninstalling $_pkg" + _cwd="${_pkgdir}/$_pkg" + + if [ ! -e "$_cwd/+CONTENTS" ] || + ! grep -Fxq '@option firmware' "$_cwd/+CONTENTS"; then + echo "${0##*/}: $_pkg does not appear to be firmware" >&2 + return 2 + fi + + 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. + set +o noglob + [ "$_r/*" = "$( echo "$_r"/* )" ] && rm -rf "$_r" + set -o noglob + else + rm -f "$_r" fi done +} - [[ ! -d $_tmpsrc ]] && - echo "Cannot create prefetch area" >&2 && return 1 +usage() { + echo "usage: ${0##*/} [-d | -D] [-av] [-p path] [driver | file ...]" + exit 2 +} - # Cleanup from previous runs. - rm -f $_cfile $_cfile.sig +ALL=false +OPT_D= +while getopts :adDp:v name +do + case "$name" in + a) ALL=true ;; + d) DELETE=true ;; + D) OPT_D=true ;; + p) LOCALSRC="$OPTARG" ;; + v) VERBOSE=true ;; + :) + echo "${0##*/}: option requires an argument -- -$OPTARG" >&2 + usage 2 + ;; + ?) + echo "${0##*/}: unknown option -- -$OPTARG" >&2 + usage 2 + ;; + esac +done +shift $((OPTIND - 1)) - _t=Get/Verify +if [ "$LOCALSRC" ]; then + if [[ $LOCALSRC = @(ftp|http?(s))://* ]]; then + FWURL="${LOCALSRC}" + LOCALSRC= + else + LOCALSRC="${LOCALSRC:#file:}" + ! [ -d "$LOCALSRC" ] && + echo "The path must be a URL or an existing directory" >&2 && + exit 2 + fi +fi - ! $_unpriv ftp -D "$_t" -Vmo - "$_src/SHA256.sig" >"$_cfile.sig" && - echo "Cannot fetch SHA256.sig" >&2 && return 1 +# "Download only" means local dir and don't install +if [ "$OPT_D" ]; then + INSTALL=false + LOCALSRC="${LOCALSRC:-.}" +fi - # Verify signature file with public keys. - ! $_unpriv -f "$_cfile" \ - signify -Vep $FWPUB_KEY -x "$_cfile.sig" -m "$_cfile" && - echo "Signature check of SHA256.sig failed" >&2 && return 1 +if [ -x /usr/bin/id ] && [ "$(/usr/bin/id -u)" != 0 ]; then + echo "need root privileges" >&2 + exit 1 +fi - for _d in $_drivers; do - _f=$( sed -n "s/.*(\($_d-firmware-.*\.tgz\)).*/\1/p" "$_cfile" | tail -1 ) - _installed=$( - for fw in "${_pkgdir}/$_d-firmware"*; do - [ -e "$fw" ] || continue - echo ${fw##*/} - done - ) +set -sA devices -- "$@" - for _i in $_installed; do - if [ "$_f" = "$_i.tgz" ]; then - echo "$_i already installed" - continue 2 +if "$DELETE"; then + [ "$OPT_D" ] && usage 22 + + set -A installed + if [ "${devices[*]:-}" ]; then + "$ALL" && usage 22 + + set -A installed -- $( + for d in "${devices[@]}"; do + f="${d##*/}" # only care about the name + f="${f%.tgz}" # allow specifying the package name + [ "$( firmware_devicename "$f" )" = "$f" ] && f="$f-firmware" + + set -A i -- $( installed_firmware '' "$f-" '*' ) + + if [ "${i[*]:-}" ]; then + echo "${i[@]}" + else + echo "No firmware found for '$d'" >&2 fi + done + ) + elif "$ALL"; then + set -A installed -- $( installed_firmware '*' '-firmware-' '*' ) + fi + + deleted='' + if [ "${installed:-}" ]; then + for fw in "${installed[@]}"; do + delete_firmware "$fw" || continue + deleted="$deleted,$( firmware_devicename "$fw" )" done + fi - rm -f /tmp/h /tmp/fail + deleted="${deleted:+${deleted#,}}" + echo "${0:##*/}: deleted ${deleted:-none}"; - # Fetch firmware file and create a checksum by piping through - # sha256. Create a flag file in case ftp failed. Firmware - # from net is written to the prefetch area. - ( $_unpriv ftp -D "$_t" -Vmo - "$_src/$_f" || >/tmp/fail ) | - ( $_srclocal && unpriv2 sha256 -b >/tmp/h || - unpriv2 -f /tmp/h sha256 -bph /tmp/h >"$_tmpsrc/$_f" ) + exit +fi - # Handle failed transfer. - if [[ -f /tmp/fail ]]; then - rm -f "$_tmpsrc/$_f" - echo "Fetching of $_f failed!" >&2 - continue - fi +if [ ! "$LOCALSRC" ]; then + LOCALSRC="$( tmpdir "${DESTDIR}/tmp/${0##*/}" )" + REMOVE_LOCALSRC=true +fi - # Verify firmware by comparing its checksum with SHA256. - if ! fgrep -qx "SHA256 ($_f) = $(&2 - continue - fi +CFILE="$LOCALSRC/$CFILE" - # TODO: Check hash for files before deleting - if [ "$_installed" ] && [ -e "${_pkgdir}/$_installed/+CONTENTS" ]; then - echo "Uninstalling $_installed" - cwd=${_pkgdir}/$_installed +if [ "${devices[*]:-}" ]; then + "$ALL" && usage 22 +else + "$VERBOSE" && echo -n "Detecting firmware ..." + set -sA devices -- $( detect_firmware ) + "$VERBOSE" && + { [ "${devices[*]:-}" ] && echo " found." || echo " done." ; } +fi - set -A _remove -- "${cwd}/+CONTENTS" "${cwd}" +[ "${devices[*]:-}" ] || exit - while read c g; do - case $c in - @cwd) cwd="${DESTDIR}/$g" - ;; - @*) continue - ;; - *) set -A _remove -- "$cwd/$c" "${_remove[@]}" - ;; - esac - done < "${_pkgdir}/$_installed/+CONTENTS" +if "$DOWNLOAD"; then + set +o noclobber # we want to get the latest CFILE + fetch "$CFILE" + set -o noclobber + ! signify -qVep "$FWPUB_KEY" -x "$CFILE" -m "$CFILE" && + echo "Signature check of SHA256.sig failed" >&2 && exit 1 +elif [ ! -e "$CFILE" ]; then + # TODO: We shouldn't need a CFILE if all arguments are files. + echo "${0##*/}: $CFILE: No such file or directory" >&2 + exit 2 +fi - # 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 +added='' +updated='' +kept='' +for f in "${devices[@]}"; do + d="$( firmware_devicename "$f" )" + + 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 + + set -A installed -- $( installed_firmware '' "$d-firmware-" '*' ) + + if "$INSTALL" && [ "${installed[*]:-}" ]; then + for i in "${installed[@]}"; do + if [ "${f##*/}" = "$i.tgz" ]; then + "$VERBOSE" && echo "$i already installed" + kept="$kept,$d" + continue 2 + fi + done + fi + + if [ -e "$f" ]; then + if "$DOWNLOAD"; then + "$VERBOSE" && echo "Verify existing ${f##*/}" + verify "$f" || continue + "$INSTALL" || kept="$kept,$d" + # else assume it was verified when downloaded fi + elif "$DOWNLOAD"; then + fetch "$f" || continue + verify "$f" || continue + "$INSTALL" || added="$added,$d" + elif "$INSTALL"; then + echo "Cannot install ${f##*/}, not found" >&2 + continue + fi - # TODO: Should we mark these so real fw_update can -Drepair? - ftp -D "Install" -Vmo- "file:$_tmpsrc/$_f" | - tar -s ",^\+,${_pkgdir}/${_f%.tgz}/+," \ - -s ",^firmware,${DESTDIR}/etc/firmware," \ - -C / -zxphf - "+*" "firmware/*" + "$INSTALL" || continue - ed -s "${_pkgdir}/${_f%.tgz}/+CONTENTS" <