iotsploit-cli

IoTSploit interactive CLI shell for IoT security testing.

Overview

This package provides the iotsploit command-line shell built on top of cmd2. It bundles the core console loop (console.py) and all command modules (commands/) that implement device management, plugin execution, target management, network operations, and more.

Installation

pip install iotsploit-cli

Usage

iotsploit

Or with the Django server started immediately:

iotsploit --runserver

Choose the backend and MCP listening addresses when the defaults are not suitable:

iotsploit --runserver \
  --host 0.0.0.0 --api-port 8080 --ws-port 8081 \
  --mcp-host 127.0.0.1 --mcp-port 9901

The same options are available inside the shell:

<IoX_SHELL> service start --host 0.0.0.0 --api-port 8080 --ws-port 8081

--host controls the API and WebSocket listeners. MCP remains on loopback by default because it does not authenticate incoming requests; expose it only on a protected network. All ports must be distinct.

Background service stdout and stderr are appended to per-service files in IOTSPLOIT_SERVICE_LOG_DIR, including mcp.log and daphne.log. When unset, the directory is iotsploit_logs under IOTSPLOIT_RUNTIME_DIR, or under Python's tempfile.gettempdir() when neither override is set:

Temporary-directory settings can change these paths. Service startup prints the resolved log directory. Set IOTSPLOIT_SERVICE_LOG_DIR to a persistent directory if logs must survive temporary-file cleanup.

Set IOTSPLOIT_SERVICE_LOG_TO_CONSOLE=1 before launching the CLI to send service logs to the terminal instead. Restart services to apply a routing change; terminal log format does not control service output routing.

Custom plugins

IOTSPLOIT_EXPLOIT_PLUGINS_DIR can be used for user custom exploit plugins. IOTSPLOIT_DEVICE_PLUGINS_DIR can be used for user custom device plugins.

Command standard

Application commands use a predictable resource action grammar:

device list
driver status
firmware flash <firmware> <device>
plugin run <plugin>
target export [file]
service status

The top-level resources are host, device, driver, firmware, plugin, target, service, wifi, and config. Run help for the concise public surface, help <resource> for its actions, or help --all for advanced cmd2 commands and the legacy-name migration table.

Previous command names and abbreviations remain executable during the migration. They print a deprecation warning with the canonical replacement.

Command Palette

The IoTSploit shell includes a live command palette for the canonical command surface. When you type at the top-level prompt, a menu shows matching resources with a short explanation. After a resource and a space, it shows that resource's actions.

How it works

1. Start typing any character at the empty prompt.
2. The menu lists canonical resources and essential shell commands matching the typed prefix (for example, d shows device and driver).
3. Type a resource and a space to see its actions (for example, plugin shows list, run, run-all, and refresh).
4. Navigate the list, insert a selection, or dismiss the menu.

Keyboard controls

Behaviour notes

• The palette is TTY-only. Non-interactive use (piped input, startup scripts, non-TTY stdin) bypasses the palette entirely and uses the normal cmd2 input path.
• The command list comes from the same canonical registry as help and the argparse command definitions, so names and explanations stay aligned.
• Tab completion for arguments (after a space) still uses cmd2's existing completion engine, including argument-specific completers and argparse completers.
• Selecting a command from the palette does not execute it; it inserts the command name so you can type arguments before pressing Enter.

License

GPL-3.0-or-later. See LICENSE for details. For commercial use, contact wang3919379@gmail.com.