CHWHB.sh

#!/bin/bash

##########################################
# Program:    CHWHB (Create Hardware Hacking Box)
# Author:     Brian Mork (Hermit)
# Version:    0.1.5          - Corrected apt dependencies, process, and git directories
# Modified:   2021-09-27
##########################################

######################################################################################
###                             Helper Functions                                   ###
######################################################################################

LOGFILE=/root/chwhb.log

################
# Function:   showError
# Variables:  First argument is error text
# Requires:   Nothing
# Returns:    Nothing
################
showError() {
  echo " [!] " $1 | tee -a ${LOGFILE}
  exit 1
}

################
# Function:   showWarning
# Variables:  First argument is warning text
# Requires:   Nothing
# Returns:    Nothing
################
showWarning() {
  echo " [W] " $1 | tee -a ${LOGFILE}
}

################
# Function:   showInfo
# Variables:  First argument is informational text
# Requires:   Nothing
# Returns:    Nothing
################
showInfo() {
  echo " [I] " $1 | tee -a ${LOGFILE}
}

################
# Function:   ask
# Variables:  None
# Requires:   Nothing
# Returns:    "1" if user selects Yes, "0" if user selects No
################
ask()
{
  VALID="FALSE"
  while [ "$VALID" = "FALSE" ]; do
    read -p "  ==> $1 [Y/N] " ANS
    case $ANS in
      [Yy]) RETVAL=1; VALID="TRUE";;
      [Nn]) RETVAL=0; VALID="TRUE";;
      *) echo "Invalid choice."
    esac
  done
  return $RETVAL
}

################
# Function:   paktc (Press Any Key To Continue)
# Variables:  None
# Requires:   Nothing
# Returns:    Nothing
################
paktc()
{
   read -p "Press any key to continue..." -n 1 throwaway
   echo
}

################
# Function:   fileExists
# Does:       Quick test/reporting for the existence of a file
# Variables:  First argument is the file to check
# Requires:   Nothing
# Returns:    Nothing
################
fileExists()
{
  if [ -f $1 ]; then
    ISFILE="yes"
  else
    ISFILE="no"
  fi
}


################
# Function:   dirExists
# Does:       Quick test/reporting for the existence of a directory
# Variables:  First argument is the directory to check
# Requires:   Nothing
# Returns:    Nothing
################
dirExists()
{
  if [ -d $1 ]; then
    ISDIR="yes"
  else
    ISDIR="no"
  fi
}


################
# Function:   checkMakeFile
# Does:       Quick test/reporting for the existence of a file, create it if it doesn't exist
# Variables:  First argument is the file to check
# Requires:   Nothing
# Returns:    Nothing
################
checkMakeFile()
{
  fileExists $1
  if [ "${ISFILE}" == "no" ]; then
    touch $1
  fi
}


################
# Function:   checkMakeDir
# Does:       Quick test/reporting for the existence of a directory, create it if it doesn't exist
# Variables:  First argument is the directory to check
# Requires:   Nothing
# Returns:    Nothing
################
checkMakeDir()
{
  dirExists $1
  if [ "$ISDIR" == "no" ]; then
    mkdir -p $1
  fi
}


################
# Function:   purgeIfFound
# Does:       If a directory exists, purge everything there to prepare
# Variables:  First argument is the directory to check
# Requires:   Nothing
# Returns:    Nothing
################
purgeIfFound()
{
  dirExists $1
  if [ "$ISDIR" == "yes" ]; then
    rm -Rf $1
    showInfo "Found and cleared $1"
  fi
}


######################################################################################
###                                   Main Program                                 ###
######################################################################################

# Check for root, exit if not
if [[ $EUID -ne 0 ]]; then
  echo "You must be root.  Exiting..."
  exit 1
fi

# Check for Ubuntu-esque operating system, exit if not found
OSNAME=`grep -E '^NAME=' /etc/os-release | cut -d \" -f 2`
if [[ $OSNAME != "Ubuntu" ]]; then
  showWarning "Ubuntu not detected"
  ask "Continue anyways?"
  if [ $RETVAL -eq 0 ]; then
    showError "Exiting now"
  fi
else
  showInfo "Found Ubuntu installation"
fi

# Get to known starting point
cd /root

# Add OpenJDK to repositories
add-apt-repository -y ppa:openjdk-r/ppa >> ${LOGFILE} 2>&1

# Update repositories
showInfo "Updating repositories..."
apt update > ${LOGFILE} 2>&1
showInfo "Repositories updated"

# Prepare for non-interactive updates
export DEBIAN_FRONTEND=noninteractive

# Perform upgrade inline?
ask "Perform upgrade on all packages before continuing?"
if [ $RETVAL -eq 1 ]; then
  showInfo "Fixing broken installs"
  apt -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" --fix-broken install >> ${LOGFILE}  2>&1
  showInfo "Performing upgrade"
  apt -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" upgrade >> ${LOGFILE}  2>&1
fi

# Build core list of things to install
INSTALLPKGS="android-sdk apktool automake build-essential cmake curl driftnet ettercap-common ettercap-graphical firefoxdriver gcc gcc-arm-none-eabi gdb gdb-multiarch git git-man golang golang-doc hexedit hexdiff libftdi-dev libpci-dev libsmali-java libusb-dev libusb-1.0-0-dev linux-headers-generic m4 meld minicom nasm nmap openjdk-17-jre picocom python2 python3 python3-dev python3-pip python3-selenium qunit-selenium screen tcptrace tmux tshark wget wireshark xxd"

# Add Ghidra pre-requisites
INSTALLPKGS="${INSTALLPKGS} openjdk-11-jdk openjdk-11-jre-headless"

# Add Radare 2 items
INSTALLPKGS="${INSTALLPKGS} radare2 radare2-cutter"

# Add Arduino-specific items
INSTALLPKGS="${INSTALLPKGS} arduino arduino-core arduino-mk arduino-builder arduino-mighty-1284p"

# Add AVR support beyond Arduino
INSTALLPKGS="${INSTALLPKGS} simavr simulavr xc3sprog gdb-avr avarice"

# Add logic analyzer software
INSTALLPKGS="${INSTALLPKGS} sigrok sigrok-cli sigrok-firmware-fx2lafw"

# Add firmware tools
INSTALLPKGS="${INSTALLPKGS} avrdude binwalk binutils flashrom squashfs-tools squashfs-tools-ng"

# Add filesystem support
INSTALLPKGS="${INSTALLPKGS} aptfs exfat-fuse fuse fuse2fs fusefat fuseiso9660 fusesmb httpfs2 ifuse libfuse2 libfuse3-3 libntfs-3g883 lxcfs ntfs-3g python3-fuse rdiff-backup-fs s3fs squashfuse tmfs vmfs-tools winregfs zfs-fuse"

# Add SDR support
INSTALLPKGS="${INSTALLPKGS} airspy bladerf cubicsdr cutesdr dump1090-mutability freedv gnuradio gqrx-sdr gr-dab gr-fcdproplus gr-hpsdr gr-limesdr gr-osmosdr hackrf hamradio-sdr horst inspectrum multimon-ng osmo-sdr osmo-trx quisk rtl-sdr sdrangelove soapysdr-module-all soapysdr-tools welle.io"

# Add standard WiFi tools
INSTALLPKGS="${INSTALLPKGS} aircrack-ng airgraph-ng kismet kismet-plugins mdk4 wifite"

# Add dependencies for Discord
INSTALLPKGS="${INSTALLPKGS} libappindicator1 libgconf-2-4 gconf2-common libdbusmenu-gtk4 libc++1 libc++1-10 libc++abi1-10"

# DEBUG
# echo "${INSTALLPKGS}"
# ask "PAUSE FOR CONCERNS"

# Install packages
apt -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" install ${INSTALLPKGS} >> ${LOGFILE}  2>&1

# Install Salae software
showInfo "Installing Salae"
SALAEFILE="/usr/local/sbin/salae-logic-analyzer"
fileExists ${SALAEFILE}
if [ "${ISFILE}" == "yes" ]; then
  showInfo "Found Salae Logic Analyzer already installed.  Software will be updated."
  rm -f ${SALAEFILE} 
fi
wget -O ${SALAEFILE} "https://logic2api.saleae.com/download?os=linux" >> ${LOGFILE} 2>&1
chmod +x ${SALAEFILE}
showInfo "Installed Salae Logic Analyzer to ${SALAEFILE}"

# Install Discord
showInfo "Installing Discord"
DISCORDTMPDIR=`mktemp -d`
wget -O ${DISCORDTMPDIR}/discord.deb 'https://discord.com/api/download?platform=linux&format=deb' >> ${LOGFILE} 2>&1
dpkg -i ${DISCORDTMPDIR}/discord.deb >> ${LOGFILE} 2>&1
showInfo "Installed Discord"

# Install CHIPSEC
showInfo "Installing CHIPSEC"
cd /root
pip install setuptools >> ${LOGFILE} 2>&1
purgeIfFound /root/chipsec
git clone https://github.com/chipsec/chipsec.git >> ${LOGFILE} 2>&1
cd chipsec
python setup.py build_ext -i >> ${LOGFILE} 2>&1
cd ..
showInfo "Installed CHIPSEC"

# Install smali
showInfo "Installing smali"
cd /root
purgeIfFound /root/smali
git clone https://github.com/JesusFreke/smali.git >> ${LOGFILE} 2>&1
cd smali
./gradlew build >> ${LOGFILE} 2>&1
cd ..
showInfo "Installed smali"

# Install Reverse-APK
showInfo "Installing Reverse-APK"
cd /root
purgeIfFound /root/ReverseAPK
git clone https://github.com/1N3/ReverseAPK.git /root/ReverseAPK >> ${LOGFILE} 2>&1
cd ReverseAPK
./install >> ${LOGFILE} 2>&1
cd /root
showInfo "Installed Reverse-APK"

# Install Postman
showInfo "Installing Postman"
snap install postman >> ${LOGFILE} 2>&1
showInfo "Installed Postman"

# Install Ghidra
showInfo "Installing Ghidra"
GTEMP=`mktemp -d`
GINSTALLDIR="/usr/local/ghidra"
purgeIfFound ${GINSTALLDIR}
GHIDRAFILE="${GTEMP}/ghidra.zip"
wget -O ${GHIDRAFILE} "https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_10.0.4_build/ghidra_10.0.4_PUBLIC_20210928.zip" >> ${LOGFILE} 2>&1
cd ${GTEMP}
unzip ${GHIDRAFILE} >> ${LOGFILE} 2>&1
# Assumption that the directory structure won't change, may need fixed later
mv ghidra_* ${GINSTALLDIR}
fileExists /usr/local/bin/ghidra
if [ ${ISFILE} == "no" ]; then
  ln -s ${GINSTALLDIR}/ghidraRun /usr/local/bin/ghidra
fi
rm -Rf ${GTEMP}
cd /root
showInfo "Installed Ghidra"

# Update root user environment
showInfo "Configuring root environment"
checkMakeDir /root/.tmux
checkMakeDir /root/.tmux/plugins
wget -O /root/.bashrc https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/root/.bashrc >> ${LOGFILE} 2>&1
wget -O /root/.tmux.conf https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/root/.tmux.conf >> ${LOGFILE} 2>&1
wget -O /root/.bash_aliases https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/.bash_aliases >> ${LOGFILE} 2>&1

# Grab some of Hermit's Helpful Helper Scripts from the CTF-Tools repo
showInfo "Pulling down helper files from Hermit's GitHub"
wget -O /usr/local/bin/ByteAdder.py https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/ByteAdder.py >> ${LOGFILE} 2>&1
chmod +x /usr/local/bin/ByteAdder.py
wget -O /usr/local/bin/apk-process.sh https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/apk-process.sh >> ${LOGFILE} 2>&1
chmod +x /usr/local/bin/apk-process.sh
wget -O /usr/local/bin/ascii2bin.sh https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/ascii-to-bin.sh >> ${LOGFILE} 2>&1
chmod +x /usr/local/bin/ascii2bin.sh
wget -O /usr/local/bin/rotall.sh https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/rot-all.sh >> ${LOGFILE} 2>&1
chmod +x /usr/local/bin/rotall.sh
wget -O /usr/local/bin/tarsum.py https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/tarsum.py >> ${LOGFILE} 2>&1
chmod +x /usr/local/bin/tarsum.py
wget -O /usr/local/bin/wgm.sh https://raw.githubusercontent.com/hermit-hacker/ctf-tools/master/wgm.sh >> ${LOGFILE} 2>&1
chmod +x /usr/local/bin/wgm.sh

# Add Tmux customizations
purgeIfFound /root/.tmux/plugins/tpm
git clone https://github.com/tmux-plugins/tpm /root/.tmux/plugins/tpm >> ${LOGFILE} 2>&1
purgeIfFound /root/.tmux/plugins/tmux-logging
git clone https://github.com/tmux-plugins/tmux-logging /root/.tmux/plugins/tmux-logging >> ${LOGFILE} 2>&1
purgeIfFound /root/OSCP-Notes
git clone https://github.com/hermit-hacker/OSCP-Study-Notes.git /root/OSCP-Notes >> ${LOGFILE} 2>&1
showInfo "Installations complete!"

showInfo "Cleaning up unused packages"
apt -y -q autoremove >> ${LOGFILE} 2>&1

showInfo "Clean up complete!"
showInfo "--------------------------------------------"
showInfo "Installation tasks completed, exiting CHWHB!"
echo