[BACK]Return to fw_install.sh CVS log [TXT][DIR] Up to [local] / openbsd / fw_update

Diff for /openbsd/fw_update/fw_install.sh between version 1.8 and 1.118

version 1.8, 2021/10/16 19:31:13 version 1.118, 2021/12/24 00:46:02
Line 1 
Line 1 
 #!/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 -o noclobber -o noglob
         # no bsort for now  set +o monitor
         sed -n "$1" /var/run/dmesg.boot  export PATH=/usr/bin:/bin:/usr/sbin:/sbin
 }  
   
 installed_firmware() {  CFILE=SHA256.sig
         for fw in ${PKGDIR}/$1-firmware*; do  DESTDIR=${DESTDIR:-}
                 [ -e "$fw" ] || continue  FWPATTERNS="${DESTDIR}/usr/share/misc/firmware_patterns"
                 echo ${fw##*/}  
         done  
 }  
   
 # tmpdir, do_as, unpriv, and unpriv2 are from install.sub  VNAME=${VNAME:-$(sysctl -n kern.osrelease)}
   VERSION=${VERSION:-"${VNAME%.*}${VNAME#*.}"}
   
 # Create a temporary directory based on the supplied directory name prefix.  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=
   
 tmpdir() {  tmpdir() {
         local _i=1 _dir          local _i=1 _dir
   
         until _dir="${1?}.$_i.$RANDOM" && mkdir -- "$_dir" 2>/dev/null; do          # If we're not in the installer,
                 ((++_i < 10000)) || return 1          # we have mktemp and a more hostile environment.
         done          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"          echo "$_dir"
 }  }
   
 # Run a command ($2+) as unprivileged user ($1).  fetch() {
 # Take extra care that after "cmd" no "user" processes exist.          local _src="${FWURL}/${1##*/}" _dst=$1 _user=_file _pid _exit _error=''
 #  
 # 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  
   
         local _file _rc _user=$1          # If we're not in the installer,
         shift          # 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 -D 'Get/Verify' $flags -o- '$_src'" > "$_dst"
           else
                   exec /usr/bin/doas -u "$_user" \
                       /usr/bin/ftp -D 'Get/Verify' $flags -o- "$_src" > "$_dst"
           fi
           ) & _pid=$!
           set +o monitor
   
         if [[ $1 == -f ]]; then          trap "kill -TERM '-$_pid' 2>/dev/null; exit 1" EXIT INT QUIT ABRT TERM
                 _file=$2  
                 shift 2          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          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 _line _dmesgtail _last='' _nl=$( echo )
   
         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="$( echo ; sed -n 'H;/^OpenBSD/h;${g;p;}' /var/run/dmesg.boot |
         done              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() {  firmware_filename() {
         do_as _sndio "$@"          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() {  firmware_devicename() {
         do_as _file "$@"          local _d="${1##*/}"
           _d="${_d%-firmware-*}"
           echo "$_d"
 }  }
   
 _issue=  installed_firmware() {
 fail() {          local _pre="$1" _match="$2" _post="$3" _firmware
         echo $_issue >&2          set -A _firmware -- $(
         exit 1              set +o noglob
               grep -Fxl '@option firmware' \
                   "${DESTDIR}/var/db/pkg/"$_pre"$_match"$_post"/+CONTENTS" \
                   2>/dev/null || true
               set -o noglob
           )
   
           [ "${_firmware[*]:-}" ] || return 0
           for fw in "${_firmware[@]}"; do
                   fw="${fw%/+CONTENTS}"
                   echo "${fw##*/}"
           done
 }  }
   
 VNAME=$(sysctl -n kern.osrelease)  add_firmware () {
 VERSION="${VNAME%.*}${VNAME#*.}"          local _f="${1##*/}" _pkgname
 FWDIR="$VNAME"          local _tmpdir="$( tmpdir "${DESTDIR}/var/db/pkg/.firmware" )"
           local flags=-VM
           "$VERBOSE" && flags=-vm
           ftp -D "Install" "$flags" -o- "file:${1}" |
                   tar -s ",^\+,${_tmpdir}/+," \
                       -s ",^firmware,${DESTDIR}/etc/firmware," \
                       -C / -zxphf - "+*" "firmware/*"
   
 HTTP_FWDIR=$FWDIR          _pkgname="$( sed -n '/^@name /{s///p;q;}' "${_tmpdir}/+CONTENTS" )"
 set -- $(scan_dmesg "/^OpenBSD $VNAME\([^ ]*\).*$/s//\1/p")          if [ ! "$_pkgname" ]; then
 [[ $1 == -!(stable) ]] && HTTP_FWDIR=snapshots                  echo "Failed to extract name from $1, partial install" 2>&1
                   rm -rf "$_tmpdir"
                   return 1
           fi
   
 FWURL=http://firmware.openbsd.org/firmware/${HTTP_FWDIR}          # TODO: Should we mark these so real fw_update can -Drepair?
 FWPUB_KEY=${DESTDIR}/etc/signify/openbsd-${VERSION}-fw.pub          ed -s "${_tmpdir}/+CONTENTS" <<EOL
 PKGDIR=${DESTDIR}/var/db/pkg  /^@comment pkgpath/ -1a
 PATTERNS="file:${0%/*}/firmware_patterns"  @option manual-installation
   @option firmware
   @comment install-script
   .
   w
   EOL
   
 drivers=$(          chmod 755 "$_tmpdir"
         last=''          mv "$_tmpdir" "${DESTDIR}/var/db/pkg/${_pkgname}"
         ftp -D "Detecting" -Vmo- $PATTERNS |  }
         while read d m; do  
                 grep=grep  delete_firmware() {
                 [ "$last" = "$d" ] && continue          local _cwd _pkg="$1" _pkgdir="${DESTDIR}/var/db/pkg"
                 [ "$m" ] || m="^$d[0-9][0-9]* at "  
                 [ "$m" = "${m#^}" ] && grep=fgrep          # TODO: Check hash for files before deleting
                 $grep -q "$m" /var/run/dmesg.boot || continue          "$VERBOSE" && echo "Uninstalling $_pkg"
                 echo $d          _cwd="${_pkgdir}/$_pkg"
                 last=$d  
           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          done
 )  }
   
 if [ -z "$drivers" ]; then  usage() {
         echo "No devices found which need firmware files to be downloaded." >&2          echo "usage:  ${0##*/} [-d | -D | -L] [-av] [driver | file ...]"
         exit 0          exit 2
 fi  }
   
 _src=$FWURL  ALL=false
 if _tmpsrc=$( tmpdir "${DESTDIR}/tmp/fw_update" ); then  OPT_D=
         (  OPT_L=
         >$_tmpsrc/t &&  while getopts :adDLv name
         $_unpriv cat $_tmpsrc/t  do
         ) >/dev/null 2>&1 ||         case "$name" in
             rm -r $_tmpsrc         a) ALL=true ;;
 fi         d) DELETE=true ;;
          D) OPT_D=true ;;
          L) OPT_L=true ;;
          v) VERBOSE=true ;;
          ?) echo "${0##*/}: unknown option -- -$OPTARG"; usage 2 ;;
          esac
   done
   shift $((OPTIND - 1))
   
 [[ ! -d $_tmpsrc ]] &&  [ "$OPT_D" ] && [ "$OPT_L" ] && usage 1
         _issue="Cannot create prefetch area" && fail  
   
 cd "$_tmpsrc"  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/${0##*/}" )"
   fi
   
 _t=Get  CFILE="$LOCALSRC/$CFILE"
 _cfile="$_tmpsrc/SHA256"  
 _srclocal=false  
   
 ! $_unpriv ftp -D "$_t" -Vmo - "$_src/SHA256.sig" >"$_cfile.sig" &&  if [ -x /usr/bin/id ] && [ "$(/usr/bin/id -u)" != 0 ]; then
     _issue="Cannot fetch SHA256.sig" && fail          echo "need root privileges" >&2
           exit 1
   fi
   
 # Verify signature file with public keys.  set -A devices -- "$@"
 ! unpriv -f "$_cfile" \  
     signify -Vep $FWPUB_KEY -x "$_cfile.sig" -m "$_cfile" &&  
     _issue="Signature check of SHA256.sig failed" && fail  
   
 for d in $drivers; do  if "$DELETE"; then
         _f=$( sed -n "s/.*(\($d-firmware-.*\.tgz\)).*/\1/p" "$_cfile" )          [ "$OPT_D" ] || [ "$OPT_L" ] && usage 22
         installed=$( installed_firmware "$d" )  
   
         for i in $installed; do          set -A installed
                 if [ "$_f" = "$i.tgz" ]; then          if [ "${devices[*]:-}" ]; then
                         echo "Firmware for $d already installed ($installed)"                  "$ALL" && usage 22
                         continue 2  
                 fi  
         done  
   
         rm -f /tmp/h /tmp/fail                  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"
   
         _t=Get/Verify                          set -A i -- $( installed_firmware '' "$f-" '*' )
         # 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" )  
   
         # Handle failed transfer.                          if [ "${i[*]:-}" ]; then
         if [[ -f /tmp/fail ]]; then                                  echo "${i[@]}"
                 rm -f "$_tmpsrc/$_f"                          else
                 _issue="Fetching of $_f failed!"                                  echo "No firmware found for '$d'" >&2
                 fail                          fi
                       done
                   )
           elif "$ALL"; then
                   set -A installed -- $( installed_firmware '*' '-firmware-' '*' )
         fi          fi
   
         # Verify firmware by comparing its checksum with SHA256.          deleted=''
         if fgrep -qx "SHA256 ($_f) = $(</tmp/h)" "$_cfile"; then          if [ "${installed:-}" ]; then
                 #_unver=$(rmel $_f $_unver)                  for fw in "${installed[@]}"; do
                 true                          delete_firmware "$fw" || continue
         else                          deleted="$deleted,$( firmware_devicename "$fw" )"
                 [[ -d "$_tmpsrc" ]] && rm -rf "$_tmpsrc"                  done
                 _issue="Checksum test for $_f failed."  
                 fail  
         fi          fi
   
         # TODO: Check hash for files before deleting          deleted="${deleted:+${deleted#,}}"
         if [ "$installed" ] && [ -e "${PKGDIR}/$installed/+CONTENTS" ]; then          echo "${0:##*/}: deleted ${deleted:-none}";
                 echo "Uninstalling $installed"  
                 cwd=${PKGDIR}/$installed  
   
                 remove="${cwd}/+CONTENTS ${cwd}"          exit
   fi
   
                 while read c g; do  if [ "${devices[*]:-}" ]; then
                         case $c in          "$ALL" && usage 22
                         @cwd) cwd=$g  else
                           ;;          "$VERBOSE" && echo -n "Detecting firmware ..."
                         @*) continue          set -A devices -- $( devices_needing_firmware )
                           ;;          "$VERBOSE" &&
                         *)  remove="$cwd/$c $remove"              { [ "${devices[*]:-}" ] && echo " found." || echo " done." ; }
                           ;;  fi
                         esac  
                 done < "${PKGDIR}/$installed/+CONTENTS"  
   
                 for r in $remove ; do  [ "${devices[*]:-}" ] || exit
                         if [ -d "$r" ]; then  
                                 # Try hard not to actually remove recursively  if "$DOWNLOAD"; then
                                 # without rmdir on the install media.          set +o noclobber # we want to get the latest CFILE
                                 [ "$r/*" = $( echo "$r"/* ) ] && rm -rf "$r"          fetch "$CFILE"
                         else          set -o noclobber
                                 rm -f "$r"          ! signify -qVep "$FWPUB_KEY" -x "$CFILE" -m "$CFILE" &&
               echo "Signature check of SHA256.sig failed" >&2 && exit 1
   fi
   
   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                          fi
                 done                  done
         fi          fi
   
         # TODO: Add some details about the install to +CONTENTS like pkg_add          if [ -e "$f" ]; then
         # TODO: Or, maybe we save the firmware someplace and make pkg_add reinstall                  if "$DOWNLOAD"; then
         echo "Installing $_f"                          "$VERBOSE" && echo "Verify existing ${f##*/}"
         tar -zxphf "$_f" -C /etc "firmware/*"                          verify "$f" || continue
         mkdir -p ${PKGDIR}/${firmware%.tgz}/                          "$INSTALL"  || kept="$kept,$d"
         tar -zxphf "$_f" -C "${PKGDIR}/${firmware%.tgz}" "+*"                  # else assume it was verified when downloaded
         ed -s "${PKGDIR}/${firmware%.tgz}/+CONTENTS" <<EOL                  fi
 /^@comment pkgpath/ -1a          elif "$DOWNLOAD"; then
 @option manual-installation                  fetch  "$f" || continue
 @option firmware                  verify "$f" || continue
 @comment install-script                  "$INSTALL"  || added="$added,$d"
 .          elif "$INSTALL"; then
 w                  echo "Cannot install ${f##*/}, not found" >&2
 EOL                  continue
           fi
   
           "$INSTALL" || continue
   
           removed=false
           if [ "${installed[*]:-}" ]; then
                   for i in "${installed[@]}"; do
                           delete_firmware "$i"
                           removed=true
                   done
           fi
   
           add_firmware "$f"
   
           if "$removed"; then
                   updated="$updated,$d"
           else
                   added="$added,$d"
           fi
 done  done
   
   added="${added:#,}"
   updated="${updated:#,}"
   kept="${kept:#,}"
   if "$INSTALL"; then
           echo  "${0##*/}: added ${added:-none}; updated ${updated:-none}; kept ${kept:-none}"
   else
           echo  "${0##*/}: downloaded ${added:-none}; kept ${kept:-none}"
   fi
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.118
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>