| version 1.6, 2021/10/14 02:39:43 |
version 1.67, 2021/12/11 03:25:09 |
|
|
| #!/bin/ksh |
#!/bin/ksh |
| set -e |
# $OpenBSD$ |
| |
# |
| |
# 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() { |
set -o errexit -o pipefail -o nounset |
| # no bsort for now |
|
| sed -n "$1" /var/run/dmesg.boot |
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 |
| |
|
| |
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" |
| } |
} |
| |
|
| installed_firmware() { |
realpath () { |
| for fw in ${PKGDIR}/$1-firmware*; do |
if [ -x /usr/bin/realpath ]; then |
| [ -e "$fw" ] || continue |
/usr/bin/realpath "$1" |
| echo ${fw##*/} |
elif [ "$1" = "${1%/*}" ]; then |
| done |
echo "${PWD}/$1" |
| |
else |
| |
echo "$( cd "${1%/*}" && pwd )/${1##*/}" |
| |
fi |
| } |
} |
| |
|
| # do_as, unpriv, and unpriv2 are from install.sub |
fetch() { |
| |
local _file=$1 _user=_file _exit |
| |
|
| # Run a command ($2+) as unprivileged user ($1). |
# If we're not in the installer, we have su(1) |
| # Take extra care that after "cmd" no "user" processes exist. |
# and doas(1) is unlikely to be configured. |
| # |
if [ -x /usr/bin/su ]; then |
| # Optionally: |
/usr/bin/su -s /bin/ksh "$_user" -c \ |
| # - create "file" and chown it to "user" |
"/usr/bin/ftp -D 'Get/Verify' -Vm \ |
| # - after "cmd", chown "file" back to root |
-o- '${FWURL}/${_file}'" > "$_file" |
| # |
_exit="$?" |
| # Usage: do_as user [-f file] cmd |
else |
| do_as() { |
/usr/bin/doas -u "$_user" \ |
| (( $# >= 2 )) || return |
ftp -D 'Get/Verify' -Vm \ |
| |
-o- "${FWURL}/${_file}" > "$_file" |
| |
_exit="$?" |
| |
fi |
| |
|
| local _file _rc _user=$1 |
if [ "$_exit" -ne 0 ]; then |
| shift |
rm -f "$_file" |
| |
echo "Cannot fetch $_file" >&2 |
| if [[ $1 == -f ]]; then |
return 1 |
| _file=$2 |
|
| shift 2 |
|
| fi |
fi |
| |
} |
| |
|
| if [[ -n $_file ]]; then |
verify() { |
| >$_file |
# On the installer we don't get sha256 -C, so fake it. |
| chown "$_user" "$_file" |
if ! fgrep -qx "SHA256 ($1) = $( /bin/sha256 -qb "$1" )" "$CFILE"; then |
| |
echo "Checksum test for $1 failed." >&2 |
| |
return 1 |
| fi |
fi |
| |
} |
| |
|
| doas -u "$_user" "$@" |
devices_needing_firmware() { |
| _rc=$? |
local _d _m _grep _dmesgtail _last='' |
| |
|
| while doas -u "$_user" kill -9 -1 2>/dev/null; do |
# When we're not in the installer, the dmesg.boot can |
| echo "Processes still running for user $_user after: $@" |
# contain multiple boots, so only look in the last one |
| sleep 1 |
_dmesgtail=$( sed -n 'H;/^OpenBSD/h;${g;p;}' /var/run/dmesg.boot ) |
| |
|
| |
grep -v '^[[:space:]]*#' "$FWPATTERNS" | |
| |
while read -r _d _m; do |
| |
_grep="grep" |
| |
[ "$_last" = "$_d" ] && continue |
| |
[ "$_m" ] || _m="^${_d}[0-9][0-9]* at " |
| |
[ "$_m" = "${_m#^}" ] && _grep="fgrep" |
| |
|
| |
echo "$_dmesgtail" | $_grep -q "$_m" || continue |
| |
echo "$_d" |
| |
_last="$_d" |
| done |
done |
| |
} |
| |
|
| [[ -n $_file ]] && chown root "$_file" |
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" |
| |
} |
| |
|
| return $_rc |
firmware_devicename() { |
| |
local _d="${1##*/}" |
| |
_d="${_d%-firmware-*}" |
| |
echo "$_d" |
| } |
} |
| |
|
| unpriv() { |
installed_firmware() { |
| do_as _sndio "$@" |
for fw in "${DESTDIR}/var/db/pkg/$1-firmware"*; do |
| |
[ -e "$fw" ] || continue |
| |
echo "${fw##*/}" |
| |
done |
| } |
} |
| |
|
| unpriv2() { |
add_firmware () { |
| do_as _file "$@" |
local _f="${1##*/}" _pkgdir="${DESTDIR}/var/db/pkg" |
| |
ftp -D "Install" -Vmo- "file:${1}" | |
| |
tar -s ",^\+,${_pkgdir}/${_f%.tgz}/+," \ |
| |
-s ",^firmware,${DESTDIR}/etc/firmware," \ |
| |
-C / -zxphf - "+*" "firmware/*" |
| |
|
| |
# TODO: Should we mark these so real fw_update can -Drepair? |
| |
ed -s "${_pkgdir}/${_f%.tgz}/+CONTENTS" <<EOL |
| |
/^@comment pkgpath/ -1a |
| |
@option manual-installation |
| |
@option firmware |
| |
@comment install-script |
| |
. |
| |
w |
| |
EOL |
| } |
} |
| |
|
| set -A _KERNV -- $( scan_dmesg '/^OpenBSD \([1-9][0-9]*\.[0-9]\)\([^ ]*\) .*/ { s//\1 \2/p; q; }' ) |
delete_firmware() { |
| VNAME=${_KERNV[0]} |
local _cwd _pkg="$1" _pkgdir="${DESTDIR}/var/db/pkg" |
| OSDIR=$VNAME |
|
| if ((${#_KERNV[*]} > 1)) && [ "$_KERNV[1]" = "-current" -o "$_KERNV[1]" = "-beta" ]; then |
|
| OSDIR=snapshots |
|
| fi |
|
| |
|
| FWURL=http://firmware.openbsd.org/firmware/${OSDIR} |
# TODO: Check hash for files before deleting |
| PKGDIR=${DESTDIR}/var/db/pkg |
echo "Uninstalling $_pkg" |
| PATTERNS="file:${0%/*}/firmware_patterns" |
_cwd="${_pkgdir}/$_pkg" |
| |
|
| drivers=$( |
set -A _remove -- "${_cwd}/+CONTENTS" "${_cwd}" |
| last='' |
|
| ftp -D "Detecting" -Vmo- $PATTERNS | |
while read -r c g; do |
| while read d m; do |
case $c in |
| grep=grep |
@cwd) _cwd="${DESTDIR}$g" |
| [ "$last" = "$d" ] && continue |
;; |
| [ "$m" ] || m="^$d[0-9][0-9]* at " |
@*) continue |
| [ "$m" = "${m#^}" ] && grep=fgrep |
;; |
| $grep -q "$m" /var/run/dmesg.boot || continue |
*) set -A _remove -- "$_cwd/$c" "${_remove[@]}" |
| echo $d |
;; |
| last=$d |
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 |
done |
| ) |
} |
| |
|
| if [ -z "$drivers" ]; then |
usage() { |
| echo "No devices found which need firmware files to be downloaded." >&2 |
echo "usage: fw_install [-d dir | -L dir] [driver | file [...]]" |
| exit 0 |
exit 2 |
| |
} |
| |
|
| |
DOWNLOADDIR= |
| |
LOCALDIR= |
| |
while getopts d:L: name |
| |
do |
| |
case "$name" in |
| |
d) DOWNLOADDIR=$OPTARG ;; |
| |
L) LOCALDIR=$OPTARG ;; |
| |
?) usage 2 ;; |
| |
esac |
| |
done |
| |
shift $((OPTIND - 1)) |
| |
|
| |
if [[ -n "$DOWNLOADDIR" && -n "$LOCALDIR" ]]; then |
| |
echo "Cannot use -d and -L" >&2 |
| |
usage 2 |
| fi |
fi |
| |
|
| tmpdir=${DESTDIR}/tmp/fw_update |
set -A devices -- "$@" |
| [ -e "$tmpdir" ] && rm -rf "$tmpdir" |
|
| mkdir -p "$tmpdir" |
|
| cd "$tmpdir" |
|
| |
|
| # TODO: Drop privs during fetch and verify |
[ "${devices[*]:-}" ] || |
| ftp -D Get -Vm "$FWURL/SHA256.sig" |
set -A devices -- $( devices_needing_firmware ) |
| |
|
| # Probably should bundle the firmware sigfile on the installer, |
if [ ! "${devices[*]:-}" ]; then |
| # although we can just get it from the recently installed system. |
echo "No devices found which need firmware files to be downloaded." |
| if [ "$DESTDIR" ]; then |
exit |
| 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 |
|
| fi |
fi |
| |
|
| signify -Ve -x SHA256.sig -m - < SHA256.sig > SHA256 |
# Have to find the full path to firmware files |
| |
# so we can cd and still find them later. |
| |
i=0 |
| |
while (( i < "${#devices[@]}" )); do |
| |
f="${devices[$i]}" |
| |
d=$( firmware_devicename "$f" ) |
| |
if [ -e "$f" ]; then |
| |
if [ "$DOWNLOADDIR" ]; then |
| |
echo "Cannot download local file $f" >&2 |
| |
exit 2 |
| |
fi |
| |
devices[$i]="$d:$( realpath "$f" )" |
| |
fi |
| |
i=$((i + 1)) |
| |
done |
| |
|
| for d in $drivers; do |
if [ "$DOWNLOADDIR" ]; then |
| firmware=$( sed -n "s/.*(\($d-firmware-.*\.tgz\)).*/\1/p" SHA256 ) |
if ! cd "$DOWNLOADDIR"; then |
| installed=$( installed_firmware $d ) |
echo "Unable to use $DOWNLOADDIR, make sure it is a directory" |
| |
exit 2 |
| |
fi |
| |
elif [ "$LOCALDIR" ]; then |
| |
if ! cd "$LOCALDIR"; then |
| |
echo "Unable to use $LOCALDIR, make sure it is a directory" |
| |
exit 2 |
| |
fi |
| |
else |
| |
TMPDIR=$( tmpdir "${DESTDIR}/tmp/fw_install" ) |
| |
cd "$TMPDIR" |
| |
fi |
| |
|
| for i in $installed; do |
if ! [[ -n "$LOCALDIR" && -e "$CFILE" ]]; then |
| if [ "$firmware" = "$i.tgz" ]; then |
fetch "$CFILE" |
| echo "Firmware for $d already installed ($installed)" |
! signify -qVep "$FWPUB_KEY" -x "$CFILE" -m "$CFILE" && |
| continue 2 |
echo "Signature check of SHA256.sig failed" >&2 && exit 1 |
| fi |
fi |
| done |
|
| |
|
| mkdir $d |
for d in "${devices[@]}"; do |
| |
f="${d##*:}" |
| |
if [ "$f" = "$d" ]; then |
| |
f=$( firmware_filename "$d" || true ) |
| |
[ "$f" ] || continue |
| |
else |
| |
d="${d%:*}" |
| |
fi |
| |
|
| # TODO: Drop privs during fetch and verify |
set -A installed -- $( installed_firmware "$d" ) |
| ftp -D "Get/Verify" -Vmo- "$FWURL/$firmware" | sha256 -bph "$d/h" > "$firmware" |
|
| fgrep -qx "SHA256 ($firmware) = $(<$d/h)" SHA256 |
|
| |
|
| # TODO: Check hash for files before deleting |
if [ ! "$DOWNLOADDIR" ] && [ "${installed[*]:-}" ]; then |
| if [ "$installed" ] && [ -e "${PKGDIR}/$installed/+CONTENTS" ]; then |
for i in "${installed[@]}"; do |
| echo "Uninstalling $installed" |
if [ "${f##*/}" = "$i.tgz" ]; then |
| cwd=${PKGDIR}/$installed |
echo "$i already installed" |
| |
continue 2 |
| |
fi |
| |
done |
| |
fi |
| |
|
| remove="${cwd}/+CONTENTS ${cwd}" |
if [ ! -e "$f" ]; then |
| |
[ "$LOCALDIR" ] && echo "Cannot install $f, not found" >&2 && continue |
| |
fetch "$f" || continue |
| |
verify "$f" || continue |
| |
elif [ "$DOWNLOADDIR" ]; then |
| |
echo "Already have $f" |
| |
verify "$f" || continue |
| |
fi |
| |
|
| while read c g; do |
[ "$DOWNLOADDIR" ] && continue |
| case $c in |
|
| @cwd) cwd=$g |
|
| ;; |
|
| @*) continue |
|
| ;; |
|
| *) remove="$cwd/$c $remove" |
|
| ;; |
|
| esac |
|
| done < "${PKGDIR}/$installed/+CONTENTS" |
|
| |
|
| for r in $remove ; do |
if [ "${installed[*]:-}" ]; then |
| if [ -d "$r" ]; then |
for i in "${installed[@]}"; do |
| # Try hard not to actually remove recursively |
delete_firmware "$i" |
| # without rmdir on the install media. |
|
| [ "$r/*" = $( echo "$r"/* ) ] && rm -rf "$r" |
|
| else |
|
| rm -f "$r" |
|
| fi |
|
| done |
done |
| fi |
fi |
| |
|
| # TODO: Add some details about the install to +CONTENTS like pkg_add |
add_firmware "$f" |
| # 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 |
|
| done |
done |
| |
|