#!/bin/bash # # Install Voltron for whichever debuggers are detected (only GDB and LLDB so # far). # # Adapted from pwndbg's install script. # # Usage: ./install.sh [ -u -d ] # -u Install to user's site-packages directory # -d Install in developer mode (-e flag passed to pip) # SUDO='sudo' GDB=$(command -v gdb) LLDB=$(command -v lldb) set -ex while getopts ":ud" opt; do case $opt in u) USER_MODE='--user' SUDO='' ;; d) DEV_MODE="-e" ;; \?) echo "Invalid option: -$OPTARG" >&2 exit 1 ;; esac done function install_apt { if uname | grep -i Linux &>/dev/null; then sudo apt-get update if echo $PYVER|grep "3\."; then sudo apt-get -y install libreadline6-dev python3-dev python3-setuptools python3-yaml else sudo apt-get -y install libreadline6-dev python-dev python-setuptools python-yaml fi fi } if [ -n "${GDB}" ]; then # Find the Python version used by GDB PYVER=$(gdb -batch -q --nx -ex 'pi import platform; print(".".join(platform.python_version_tuple()[:2]))') PYTHON=$(gdb -batch -q --nx -ex 'pi import sys; print(sys.executable)') PYTHON="${PYTHON}${PYVER}" install_apt if [ -z $USER_MODE ]; then GDB_SITE_PACKAGES=$(gdb -batch -q --nx -ex 'pi import site; print(site.getsitepackages()[0])') else GDB_SITE_PACKAGES=$(gdb -batch -q --nx -ex 'pi import site; print(site.getusersitepackages())') fi # Install Voltron and dependencies ${SUDO} ${PYTHON} -m pip install $USER_MODE $DEV_MODE -U . # Add Voltron to gdbinit if ! grep voltron ~/.gdbinit &>/dev/null; then echo "source $GDB_SITE_PACKAGES/voltron/entry.py" >> ~/.gdbinit fi fi if [ -n "${LLDB}" ]; then # Find the Python version used by LLDB PYVER=$(lldb -Qxb --one-line 'script import platform; print(".".join(platform.python_version_tuple()[:2]))'|tail -1) PYTHON=$(lldb -Qxb --one-line 'script import sys; print(sys.executable)'|tail -1) PYTHON="${PYTHON}${PYVER}" if [ -z $USER_MODE ]; then LLDB_SITE_PACKAGES=$(lldb -Qxb --one-line 'script import site; print(site.getsitepackages()[0])'|tail -1) else LLDB_SITE_PACKAGES=$(lldb -Qxb --one-line 'script import site; print(site.getusersitepackages())'|tail -1) fi install_apt if [ "$LLDB_SITE_PACKAGES" == "$GDB_SITE_PACKAGES" ]; then echo "Skipping installation for LLDB - same site-packages directory" else # Install Voltron and dependencies ${SUDO} ${PYTHON} -m pip install $USER_MODE $DEV_MODE -U . fi # Add Voltron to lldbinit if ! grep voltron ~/.lldbinit &>/dev/null; then INIT_FILE='~/.lldbinit' echo "command script import $LLDB_SITE_PACKAGES/voltron/entry.py" >> ~/.lldbinit fi fi if [ -z "${GDB}" ] && [ -z "${LLDB}" ]; then # Find system Python PYTHON=$(command -v python) PYVER=$(${PYTHON} -c 'import platform; print(".".join(platform.python_version_tuple()[:2]))') if [ -z $USER_MODE ]; then PYTHON_SITE_PACKAGES=$(${PYTHON} -c 'import site; print(site.getsitepackages()[0])') else PYTHON_SITE_PACKAGES=$(${PYTHON} -c 'import site; print(site.getusersitepackages())') fi install_apt # Install Voltron and dependencies ${SUDO} ${PYTHON} -m pip install $USER_MODE $DEV_MODE -U . fi set +x echo "==============================================================" if [ -n "${GDB}" ]; then echo "Installed for GDB (${GDB}):" echo " Python: $PYTHON" echo " Packages directory: $GDB_SITE_PACKAGES" if [ -n "${INIT_FILE}" ]; then echo " Added voltron to: ~/.gdbinit" else echo " Already loaded in: ~/.gdbinit" fi fi if [ -n "${LLDB}" ]; then echo "Installed for LLDB (${LLDB}):" echo " Python: $PYTHON" echo " Packages directory: $LLDB_SITE_PACKAGES" if [ -n "${INIT_FILE}" ]; then echo " Added voltron to: ~/.lldbinit" else echo " Already loaded in: ~/.lldbinit" fi fi if [ -z "${GDB}" ] && [ -z "${LLDB}" ]; then echo "Couldn't find any debuggers. Installed using the Python in your path:" echo " Python: $PYTHON" echo " Packages directory: $PYTHON_SITE_PACKAGES" echo " Did not add Voltron to any debugger init files." fi