Annotation of openbsd/fw_update/fw_install.sh, Revision 1.128
1.1 afresh1 1: #!/bin/ksh
1.36 afresh1 2: # $OpenBSD$
1.50 afresh1 3: #
1.38 afresh1 4: # Copyright (c) 2021 Andrew Hewus Fresh <afresh1@openbsd.org>
5: #
6: # Permission to use, copy, modify, and distribute this software for any
7: # purpose with or without fee is hereby granted, provided that the above
8: # copyright notice and this permission notice appear in all copies.
9: #
10: # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17:
1.95 afresh1 18: set -o errexit -o pipefail -o nounset -o noclobber -o noglob
1.85 afresh1 19: set +o monitor
1.77 afresh1 20: export PATH=/usr/bin:/bin:/usr/sbin:/sbin
1.50 afresh1 21:
22: CFILE=SHA256.sig
23: DESTDIR=${DESTDIR:-}
24: FWPATTERNS="${DESTDIR}/usr/share/misc/firmware_patterns"
25:
26: VNAME=${VNAME:-$(sysctl -n kern.osrelease)}
27: VERSION=${VERSION:-"${VNAME%.*}${VNAME#*.}"}
28:
29: HTTP_FWDIR="$VNAME"
1.52 afresh1 30: VTYPE=$( sed -n "/^OpenBSD $VNAME\([^ ]*\).*$/s//\1/p" \
31: /var/run/dmesg.boot | sed '$!d' )
1.50 afresh1 32: [[ $VTYPE == -!(stable) ]] && HTTP_FWDIR=snapshots
1.22 afresh1 33:
1.50 afresh1 34: FWURL=http://firmware.openbsd.org/firmware/${HTTP_FWDIR}
35: FWPUB_KEY=${DESTDIR}/etc/signify/openbsd-${VERSION}-fw.pub
1.8 afresh1 36:
1.97 afresh1 37: VERBOSE=false
1.111 afresh1 38: DELETE=false
1.87 afresh1 39: DOWNLOAD=true
40: INSTALL=true
1.69 afresh1 41: LOCALSRC=
42:
1.126 afresh1 43: unset FTPPID
44: REMOVE_LOCALSRC=false
45: cleanup() {
1.127 afresh1 46: set +o errexit # ignore errors from killing ftp
1.128 ! afresh1 47: [ "${FTPPID:-}" ] && kill -TERM -"$FTPPID" 2>/dev/null
1.126 afresh1 48: "$REMOVE_LOCALSRC" && rm -rf "$LOCALSRC"
49: }
50: trap cleanup EXIT
51:
1.8 afresh1 52: tmpdir() {
53: local _i=1 _dir
54:
1.50 afresh1 55: # If we're not in the installer,
1.79 afresh1 56: # we have mktemp and a more hostile environment.
1.50 afresh1 57: if [ -x /usr/bin/mktemp ]; then
58: _dir=$( mktemp -d "${1}-XXXXXXXXX" )
1.44 afresh1 59: else
1.50 afresh1 60: until _dir="${1}.$_i.$RANDOM" && mkdir -- "$_dir" 2>/dev/null; do
1.44 afresh1 61: ((++_i < 10000)) || return 1
62: done
63: fi
1.50 afresh1 64:
1.8 afresh1 65: echo "$_dir"
66: }
1.6 afresh1 67:
1.50 afresh1 68: fetch() {
1.126 afresh1 69: local _src="${FWURL}/${1##*/}" _dst=$1 _user=_file _exit _error=''
1.6 afresh1 70:
1.79 afresh1 71: # If we're not in the installer,
72: # we have su(1) and doas(1) is unlikely to be configured.
1.85 afresh1 73: set -o monitor # make sure ftp gets its own process group
74: (
1.101 afresh1 75: flags=-VM
76: "$VERBOSE" && flags=-vm
1.53 afresh1 77: if [ -x /usr/bin/su ]; then
1.85 afresh1 78: exec /usr/bin/su -s /bin/ksh "$_user" -c \
1.119 afresh1 79: "/usr/bin/ftp -N '${0##/}' -D 'Get/Verify' $flags -o- '$_src'" > "$_dst"
1.42 afresh1 80: else
1.85 afresh1 81: exec /usr/bin/doas -u "$_user" \
1.119 afresh1 82: /usr/bin/ftp -N "${0##/}" -D 'Get/Verify' $flags -o- "$_src" > "$_dst"
1.42 afresh1 83: fi
1.126 afresh1 84: ) & FTPPID=$!
1.85 afresh1 85: set +o monitor
86:
87: SECONDS=0
88: _last=0
1.126 afresh1 89: while kill -0 -"$FTPPID" 2>/dev/null; do
1.85 afresh1 90: if [[ $SECONDS -gt 12 ]]; then
91: set -- $( ls -ln "$_dst" 2>/dev/null )
92: if [[ $_last -ne $5 ]]; then
93: _last=$5
94: SECONDS=0
95: sleep 1
96: else
1.126 afresh1 97: kill -INT -"$FTPPID"
1.92 afresh1 98: _error=" (timed out)"
1.85 afresh1 99: fi
100: else
101: sleep 1
102: fi
103: done
104:
105: set +o errexit
1.126 afresh1 106: wait "$FTPPID"
1.85 afresh1 107: _exit=$?
108: set -o errexit
109:
1.126 afresh1 110: unset FTPPID
1.6 afresh1 111:
1.50 afresh1 112: if [ "$_exit" -ne 0 ]; then
1.69 afresh1 113: rm -f "$_dst"
1.92 afresh1 114: echo "Cannot fetch $_src$_error" >&2
1.50 afresh1 115: return 1
116: fi
1.6 afresh1 117: }
118:
1.50 afresh1 119: verify() {
120: # On the installer we don't get sha256 -C, so fake it.
1.69 afresh1 121: if ! fgrep -qx "SHA256 (${1##*/}) = $( /bin/sha256 -qb "$1" )" "$CFILE"; then
122: echo "Checksum test for ${1##*/} failed." >&2
1.50 afresh1 123: return 1
124: fi
1.6 afresh1 125: }
126:
1.124 afresh1 127: firmware_in_dmesg() {
1.90 afresh1 128: local _d _m _line _dmesgtail _last='' _nl=$( echo )
1.1 afresh1 129:
1.50 afresh1 130: # When we're not in the installer, the dmesg.boot can
131: # contain multiple boots, so only look in the last one
1.89 afresh1 132: _dmesgtail="$( echo ; sed -n 'H;/^OpenBSD/h;${g;p;}' /var/run/dmesg.boot |
133: grep -e "^[a-z][a-z]*[0-9]" -e " not configured " )"
1.50 afresh1 134:
1.89 afresh1 135: grep -v '^[[:space:]]*#' "$FWPATTERNS" |
136: while read -r _d _m; do
137: [ "$_d" = "$_last" ] && continue
1.90 afresh1 138: [ "$_m" ] || _m="${_nl}${_d}[0-9] at "
139: [ "$_m" = "${_m#^}" ] || _m="${_nl}${_m#^}"
1.83 afresh1 140:
1.89 afresh1 141: if [[ $_dmesgtail = *$_m* ]]; then
142: echo "$_d"
143: _last="$_d"
144: fi
145: done
1.50 afresh1 146: }
1.14 afresh1 147:
1.50 afresh1 148: firmware_filename() {
1.56 afresh1 149: local _f
150: _f="$( sed -n "s/.*(\($1-firmware-.*\.tgz\)).*/\1/p" "$CFILE" | sed '$!d' )"
151: ! [ "$_f" ] && echo "Unable to find firmware for $1" >&2 && return 1
152: echo "$_f"
1.50 afresh1 153: }
1.7 afresh1 154:
1.57 afresh1 155: firmware_devicename() {
156: local _d="${1##*/}"
157: _d="${_d%-firmware-*}"
158: echo "$_d"
159: }
160:
1.50 afresh1 161: installed_firmware() {
1.110 afresh1 162: local _pre="$1" _match="$2" _post="$3" _firmware
1.123 afresh1 163: set -sA _firmware -- $(
1.109 afresh1 164: set +o noglob
165: grep -Fxl '@option firmware' \
1.110 afresh1 166: "${DESTDIR}/var/db/pkg/"$_pre"$_match"$_post"/+CONTENTS" \
1.109 afresh1 167: 2>/dev/null || true
168: set -o noglob
169: )
170:
171: [ "${_firmware[*]:-}" ] || return 0
172: for fw in "${_firmware[@]}"; do
173: fw="${fw%/+CONTENTS}"
1.50 afresh1 174: echo "${fw##*/}"
175: done
176: }
1.1 afresh1 177:
1.124 afresh1 178: detect_firmware() {
179: local _devices _last='' _d
180:
181: set -sA _devices -- $(
182: firmware_in_dmesg
183: for _d in $( installed_firmware '*' '-firmware-' '*' ); do
184: echo "$( firmware_devicename "$_d" )"
185: done
186: )
187:
188: [ "${_devices[*]:-}" ] || return 0
189: for _d in "${_devices[@]}"; do
190: [[ $_last = $_d ]] && continue
191: echo $_d
192: _last="$_d"
193: done
194: }
195:
1.50 afresh1 196: add_firmware () {
1.106 afresh1 197: local _f="${1##*/}" _pkgname
198: local _tmpdir="$( tmpdir "${DESTDIR}/var/db/pkg/.firmware" )"
1.101 afresh1 199: local flags=-VM
200: "$VERBOSE" && flags=-vm
1.119 afresh1 201: ftp -N "${0##/}" -D "Install" "$flags" -o- "file:${1}" |
1.106 afresh1 202: tar -s ",^\+,${_tmpdir}/+," \
1.69 afresh1 203: -s ",^firmware,${DESTDIR}/etc/firmware," \
204: -C / -zxphf - "+*" "firmware/*"
1.1 afresh1 205:
1.106 afresh1 206: _pkgname="$( sed -n '/^@name /{s///p;q;}' "${_tmpdir}/+CONTENTS" )"
207: if [ ! "$_pkgname" ]; then
208: echo "Failed to extract name from $1, partial install" 2>&1
209: rm -rf "$_tmpdir"
210: return 1
211: fi
212:
1.50 afresh1 213: # TODO: Should we mark these so real fw_update can -Drepair?
1.106 afresh1 214: ed -s "${_tmpdir}/+CONTENTS" <<EOL
1.50 afresh1 215: /^@comment pkgpath/ -1a
216: @option manual-installation
217: @option firmware
218: @comment install-script
219: .
220: w
221: EOL
1.106 afresh1 222:
223: chmod 755 "$_tmpdir"
224: mv "$_tmpdir" "${DESTDIR}/var/db/pkg/${_pkgname}"
1.50 afresh1 225: }
1.22 afresh1 226:
1.50 afresh1 227: delete_firmware() {
1.51 afresh1 228: local _cwd _pkg="$1" _pkgdir="${DESTDIR}/var/db/pkg"
1.22 afresh1 229:
1.50 afresh1 230: # TODO: Check hash for files before deleting
1.101 afresh1 231: "$VERBOSE" && echo "Uninstalling $_pkg"
1.51 afresh1 232: _cwd="${_pkgdir}/$_pkg"
1.50 afresh1 233:
1.107 afresh1 234: if [ ! -e "$_cwd/+CONTENTS" ] ||
235: ! grep -Fxq '@option firmware' "$_cwd/+CONTENTS"; then
236: echo "${0##*/}: $_pkg does not appear to be firmware" >&2
237: return 2
238: fi
239:
1.51 afresh1 240: set -A _remove -- "${_cwd}/+CONTENTS" "${_cwd}"
1.50 afresh1 241:
242: while read -r c g; do
243: case $c in
1.51 afresh1 244: @cwd) _cwd="${DESTDIR}$g"
1.50 afresh1 245: ;;
246: @*) continue
247: ;;
1.52 afresh1 248: *) set -A _remove -- "$_cwd/$c" "${_remove[@]}"
1.50 afresh1 249: ;;
250: esac
251: done < "${_pkgdir}/${_pkg}/+CONTENTS"
252:
253: # We specifically rm -f here because not removing files/dirs
254: # is probably not worth failing over.
255: for _r in "${_remove[@]}" ; do
256: if [ -d "$_r" ]; then
257: # Try hard not to actually remove recursively
258: # without rmdir on the install media.
1.95 afresh1 259: set +o noglob
1.50 afresh1 260: [ "$_r/*" = "$( echo "$_r"/* )" ] && rm -rf "$_r"
1.95 afresh1 261: set -o noglob
1.50 afresh1 262: else
263: rm -f "$_r"
1.22 afresh1 264: fi
265: done
1.50 afresh1 266: }
1.1 afresh1 267:
1.59 afresh1 268: usage() {
1.122 afresh1 269: echo "usage: ${0##*/} [-d | -D] [-av] [-p path] [driver | file ...]"
1.59 afresh1 270: exit 2
271: }
272:
1.113 afresh1 273: ALL=false
1.87 afresh1 274: OPT_D=
1.122 afresh1 275: while getopts :adDp:v name
1.59 afresh1 276: do
277: case "$name" in
1.113 afresh1 278: a) ALL=true ;;
1.111 afresh1 279: d) DELETE=true ;;
1.87 afresh1 280: D) OPT_D=true ;;
1.121 afresh1 281: p) LOCALSRC="$OPTARG" ;;
1.97 afresh1 282: v) VERBOSE=true ;;
1.121 afresh1 283: :)
284: echo "${0##*/}: option requires an argument -- -$OPTARG" >&2
285: usage 2
286: ;;
287: ?)
288: echo "${0##*/}: unknown option -- -$OPTARG" >&2
289: usage 2
290: ;;
1.59 afresh1 291: esac
292: done
293: shift $((OPTIND - 1))
294:
1.121 afresh1 295: if [ "$LOCALSRC" ]; then
296: if [[ $LOCALSRC = @(ftp|http?(s))://* ]]; then
297: FWURL="${LOCALSRC}"
298: LOCALSRC=
299: else
300: LOCALSRC="${LOCALSRC:#file:}"
301: ! [ -d "$LOCALSRC" ] &&
302: echo "The path must be a URL or an existing directory" >&2 &&
303: exit 2
304: fi
305: fi
306:
1.122 afresh1 307: # "Download only" means local dir and don't install
1.87 afresh1 308: if [ "$OPT_D" ]; then
309: INSTALL=false
1.121 afresh1 310: LOCALSRC="${LOCALSRC:-.}"
1.87 afresh1 311: fi
1.64 afresh1 312:
1.118 afresh1 313: if [ -x /usr/bin/id ] && [ "$(/usr/bin/id -u)" != 0 ]; then
314: echo "need root privileges" >&2
315: exit 1
1.94 afresh1 316: fi
317:
1.123 afresh1 318: set -sA devices -- "$@"
1.111 afresh1 319:
320: if "$DELETE"; then
1.122 afresh1 321: [ "$OPT_D" ] && usage 22
1.111 afresh1 322:
1.113 afresh1 323: set -A installed
324: if [ "${devices[*]:-}" ]; then
325: "$ALL" && usage 22
326:
327: set -A installed -- $(
328: for d in "${devices[@]}"; do
329: f="${d##*/}" # only care about the name
330: f="${f%.tgz}" # allow specifying the package name
331: [ "$( firmware_devicename "$f" )" = "$f" ] && f="$f-firmware"
332:
333: set -A i -- $( installed_firmware '' "$f-" '*' )
334:
335: if [ "${i[*]:-}" ]; then
336: echo "${i[@]}"
337: else
338: echo "No firmware found for '$d'" >&2
339: fi
340: done
341: )
342: elif "$ALL"; then
343: set -A installed -- $( installed_firmware '*' '-firmware-' '*' )
344: fi
1.111 afresh1 345:
346: deleted=''
1.113 afresh1 347: if [ "${installed:-}" ]; then
1.111 afresh1 348: for fw in "${installed[@]}"; do
349: delete_firmware "$fw" || continue
1.112 afresh1 350: deleted="$deleted,$( firmware_devicename "$fw" )"
1.111 afresh1 351: done
1.113 afresh1 352: fi
1.111 afresh1 353:
354: deleted="${deleted:+${deleted#,}}"
355: echo "${0:##*/}: deleted ${deleted:-none}";
356:
357: exit
358: fi
1.125 afresh1 359:
360: if [ ! "$LOCALSRC" ]; then
361: LOCALSRC="$( tmpdir "${DESTDIR}/tmp/${0##*/}" )"
1.126 afresh1 362: REMOVE_LOCALSRC=true
1.125 afresh1 363: fi
364:
365: CFILE="$LOCALSRC/$CFILE"
1.58 afresh1 366:
1.113 afresh1 367: if [ "${devices[*]:-}" ]; then
368: "$ALL" && usage 22
369: else
1.101 afresh1 370: "$VERBOSE" && echo -n "Detecting firmware ..."
1.124 afresh1 371: set -sA devices -- $( detect_firmware )
1.101 afresh1 372: "$VERBOSE" &&
373: { [ "${devices[*]:-}" ] && echo " found." || echo " done." ; }
1.50 afresh1 374: fi
1.91 afresh1 375:
376: [ "${devices[*]:-}" ] || exit
1.50 afresh1 377:
1.71 afresh1 378: if "$DOWNLOAD"; then
1.116 afresh1 379: set +o noclobber # we want to get the latest CFILE
1.64 afresh1 380: fetch "$CFILE"
1.116 afresh1 381: set -o noclobber
1.64 afresh1 382: ! signify -qVep "$FWPUB_KEY" -x "$CFILE" -m "$CFILE" &&
383: echo "Signature check of SHA256.sig failed" >&2 && exit 1
1.120 afresh1 384: elif [ ! -e "$CFILE" ]; then
385: # TODO: We shouldn't need a CFILE if all arguments are files.
386: echo "${0##*/}: $CFILE: No such file or directory" >&2
387: exit 2
1.64 afresh1 388: fi
1.50 afresh1 389:
1.103 afresh1 390: added=''
391: updated=''
1.115 afresh1 392: kept=''
1.70 afresh1 393: for f in "${devices[@]}"; do
394: d="$( firmware_devicename "$f" )"
395:
1.58 afresh1 396: if [ "$f" = "$d" ]; then
397: f=$( firmware_filename "$d" || true )
398: [ "$f" ] || continue
1.69 afresh1 399: f="$LOCALSRC/$f"
1.76 afresh1 400: elif ! "$INSTALL" && ! grep -Fq "($f)" "$CFILE" ; then
1.70 afresh1 401: echo "Cannot download local file $f" >&2
402: exit 2
1.58 afresh1 403: fi
404:
1.110 afresh1 405: set -A installed -- $( installed_firmware '' "$d-firmware-" '*' )
1.50 afresh1 406:
1.68 afresh1 407: if "$INSTALL" && [ "${installed[*]:-}" ]; then
1.65 afresh1 408: for i in "${installed[@]}"; do
1.58 afresh1 409: if [ "${f##*/}" = "$i.tgz" ]; then
1.101 afresh1 410: "$VERBOSE" && echo "$i already installed"
1.115 afresh1 411: kept="$kept,$d"
1.11 afresh1 412: continue 2
1.1 afresh1 413: fi
414: done
1.50 afresh1 415: fi
1.1 afresh1 416:
1.72 afresh1 417: if [ -e "$f" ]; then
418: if "$DOWNLOAD"; then
1.101 afresh1 419: "$VERBOSE" && echo "Verify existing ${f##*/}"
1.72 afresh1 420: verify "$f" || continue
1.117 afresh1 421: "$INSTALL" || kept="$kept,$d"
1.72 afresh1 422: # else assume it was verified when downloaded
423: fi
1.75 afresh1 424: elif "$DOWNLOAD"; then
425: fetch "$f" || continue
426: verify "$f" || continue
1.117 afresh1 427: "$INSTALL" || added="$added,$d"
1.75 afresh1 428: elif "$INSTALL"; then
1.72 afresh1 429: echo "Cannot install ${f##*/}, not found" >&2
430: continue
1.58 afresh1 431: fi
1.60 afresh1 432:
1.68 afresh1 433: "$INSTALL" || continue
1.11 afresh1 434:
1.103 afresh1 435: removed=false
1.65 afresh1 436: if [ "${installed[*]:-}" ]; then
1.50 afresh1 437: for i in "${installed[@]}"; do
438: delete_firmware "$i"
1.103 afresh1 439: removed=true
1.50 afresh1 440: done
441: fi
1.11 afresh1 442:
1.50 afresh1 443: add_firmware "$f"
1.103 afresh1 444:
445: if "$removed"; then
1.114 afresh1 446: updated="$updated,$d"
1.103 afresh1 447: else
1.114 afresh1 448: added="$added,$d"
1.103 afresh1 449: fi
1.50 afresh1 450: done
1.1 afresh1 451:
1.114 afresh1 452: added="${added:#,}"
453: updated="${updated:#,}"
1.115 afresh1 454: kept="${kept:#,}"
1.117 afresh1 455: if "$INSTALL"; then
456: echo "${0##*/}: added ${added:-none}; updated ${updated:-none}; kept ${kept:-none}"
457: else
458: echo "${0##*/}: downloaded ${added:-none}; kept ${kept:-none}"
459: fi
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to fw_install.sh CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [local] / openbsd / fw_update