-
Notifications
You must be signed in to change notification settings - Fork 1
Installation
There is a shell script provided that installs Python3.10 and Python2.7, creates virtual environments for both versions, and installs the required submodules and pip packages. After the installation, you should be able to activate the venv for Python3.10 and run the CLI tool. This script depends on apt
(used by Debian-based Linux operating systems) and an available Python2.7 distribution (which isn't supported in Debian > 12).
There is also a container image being provided, which you can run with tools like Podman or Docker. Please note that the sbleedy
CLI tool relies on connected USB hardware, so you should be able to pass the devices through (e.g., with podman run --device /dev/ttyACM0 <image>
). Please refer to the section "Windows: using a container" for more instructions.
⚠️ Attention: When using Windows and your PC is routing all traffic through a Proxy/Firewall, trying to pass the USB devices to a container can be challenging (due to reasons like blocked TCP connections). In this case, it may be easier to use a VM and either run the container in there or run the install script in the VM. Whether on Linux or Windows, if your proxy requires a certificate, some additional work will be necessary.
Using the container image (without a VM)
- Install a container tool of your choice (Docker, Podman, etc.)
⚠️ When behind a Proxy: You may have to add the certificate to the container machine. Please refer to the documentation of the tool you chose (e.g., this for Podman).- Get the container image from the GitHub registry [WILL BE PROVIDED].
⚠️ When using Windows: Follow these instructions to attach the connected USB devices to the container usingusbipd
and WSL.- Run the container with a bash as entrypoint and pass the connected hardware (e.g.,
podman run --device /dev/ttyACM0 <image>
). When behind a proxy, you also have to add the proxy settings like this:podman run -e http_proxy=http://whatever.net:0000 -e https_proxy=http://whatever.net:0000 -e no_proxy=localhost,etc.int your-image-name
- Activate the
venv3
(source venv3/bin/activate
). - Test the installation of the CLI tool by running
sbleedy -h #should print usage info
. - Test the connected hardware by running
hciconfig
andlsusb
and confirm that your connected devices are found.
Using a VM
-
Setup the VM:
- Install a virtual machine of your choice (e.g., VirtualBox).
- Download a pre-built VM for your machine (e.g., Kali Linux) and start it.
⚠️ When behind a Proxy: Configure the VM to use the certificate by copying the certificate as root to/usr/local/share/ca-certificates
, then update the settings withsudo update-ca-certificates --verbose
.⚠️ Some virtual machines require an extension to be able to use the hardware that is connected through USB (e.g. VirtualBox Extension Pack)
Choose one of the following methods to proceed:
Option 1: Run the Container | Option 2: Run the Shell Script |
---|---|
Install a container tool of your choice (Docker, Podman). | Clone the repository: git clone https://github.com/b0rdst31n/SbleedyGonzales.git --recurse-submodules . |
Get the container image from the GitHub registry [WILL BE PROVIDED]. | Run the shell script to get both Python versions and their corresponding virtualenvs, create venv3 and venv2 , and install the necessary dependencies and submodules: cd SbleedyGonzales && helpers/sbleedy_installer.sh . When behind a Proxy, pass arguments to the script like this helpers/sbleedy_installer.sh --http_proxy "http://whatever.net:0000/" --https_proxy "http://whatever.net:0000/" --no_proxy "localhost,etc.int" --pip_proxy "http://whatever.net:0000/" --pip_cert "$HOME/Desktop/my_cert.crt"
|
Run the container with a bash as entrypoint and pass the connected hardware (e.g., podman run --device /dev/ttyACM0 <image> ). |
apt (non-Debian systems) or lacks an available Python2.7 package, you will need to edit the script accordingly. Please avoid changing the name of venv2 , or you'll have to adapt the variable VENV2_PATH in sbleedyCLI/constants.py . |
-
Test the installation:
- Activate the
venv3
(source venv3/bin/activate
). - Test the installation of the CLI tool by running
sbleedy -h #should print usage info
. You may need to runpip install .
again after activating thevenv3
. - Test the connected hardware by running
hciconfig
andlsusb
and confirm that your connected devices are found.
- Activate the