This project is a framework around the Octowire hardware.
It provides multiple modules allowing you to work efficiently and save time on any hardware project.
This framework is fully compatible with Linux and Windows (Not tested on MacOS).
To obtain a more beautiful rendering on Windows, use the new Windows Terminal.
Installing the framework will require the following:
- python (at least 3.7)
- pip (for python3)
- python3-requests (
pip install requests) - python3-setuptools (
pip install setuptools)
# Windows powershell (as Administrator)
curl.exe -s https://raw.githubusercontent.com/immunIT/octowire-framework/master/install.py | python
# Linux (as root)
curl https://raw.githubusercontent.com/immunIT/octowire-framework/master/install.py | python
Clone this repository or get the latest release, then run:
python3 setup.py install
This framework is designed to be simple to use.
Just run owfconsole, list available modules using the show modules command and load the one you need with use <module_categroy>/<module_name>.
Then, list available options for the current module: show options, setup the needed ones with set <option_name> <value> and finally run it with run!
Auto completion is implemented in the framework. Press the Tab key anywhere to trigger the auto completion.
A file/path completer is available for the set and setg framework commands if the option expects a file.
Typing a slash / is required to trigger the auto completion on sub folders.
(sudo) owfupdate
docker build -t owf .
docker run --rm -it -v /local/folder/:/remote/folder --device=/dev/ttyACM0:/dev/ttyACM0 owf
Framework configuration is stored in the /home/<user>/.owf/owf.cfg file.
This configuration can be changed through the framework using commands.
[OCTOWIRE]
port = /dev/ttyACM0 # Octowire device
baudrate = 7372800 # baudrate value to communicate with the Octowire device
read_timeout = 1 # The serial read timeout value (in seconds)
[MINITERM]
parity = N # set parity. one of {N, E, O, S, M}
xonxoff = False # enable software flow control
echo = False # enable local echo
filters = default # Text transformation, see Miniterm man
raw = False # Do no apply any encodings/transformations if True
quiet = False # suppress non-error messages
exit_char = 29 # Unicode of special character that is used to exit the application, default ctrl+] (29)
menu_char = 20 # Unicode of special character that is used to control miniterm (menu), default ctrl+t (20)
serial_port_encoding = UTF-8 # set the encoding for the serial port (Latin1, UTF-8, ...)
eol = CR # end of line mode (CR, LF, CRLF)
[THEME] # You can use HTML color codes. For all possible theme values, see prompt_toolkit manual https://python-prompt-toolkit.readthedocs.io/en/master/pages/advanced_topics/styling.html#style-strings
base = #3399ff # Base prompt color ([owf])
pound = #3399ff # Pound prompt color (>)
module = #ff0000 bold # Selected module name color
category = #ffffff # Selected module category colorFollow the guidelines in the CONTRIBUTING.md file.
[owf] > show modules
A global option is an option that will be used for every module loaded.
Setting the option with the setg command will set the specified option globally for every module loaded.
Unset a specific global option with the unsetg command.
It is also possible to print all previously defined global options using the show global command.
You identify an SPI flash chip on a hardware device. You want to dump its memory.
Simply run owfconsole from a shell and follow these instructions:
- List available module:
[owf] > show modules
- Select the appropriate module:
[owf] > use spi/flash_dump
- Show available options:
[owf] spi(flash_dump) > show options
- Set necessary options:
[owf] spi(flash_dump) > set dump_file dump.bin
- Run the module:
[owf] spi(flash_dump) > run
Run owfremove in your terminal to uninstall the framework along with its modules.
User configuration files need to be manually removed; these are present in '~/.owf' directory for any user which has run the framework at least once.
Run owfconsole and execute the show modules command to list installed modules.
The module names returned by the framework are in the following format: category/module_name.
For each module, run pip3 uninstall owfmodules.<category>.<module_name>.
Then, run pip3 uninstall octowire_framework.
Finally, delete the .owf directory in your home folder.