Skip to main content

CableProbe

CableProbe is an open-source defensive USB cable analysis tool for Linux (developed and tested on Raspberry Pi OS / Debian, and reasonably portable to other Debian/Ubuntu systems).

CableProbe watches a sacrificial Linux host while you connect an unknown USB cable — USB-C or USB-A, charge-only or data — then compares before, during and after to surface hidden HID devices, rogue network gadgets, mass storage, serial channels, transient enumeration and kernel errors.

CableProbe only observes, records and reports. It does not inject payloads, exploit anything, capture credentials, establish persistence or provide remote access. It is a monitoring tool for a sacrificial test host.

⚠️ CableProbe cannot prove that a cable is safe or uncompromised. A clean report means CableProbe did not observe anything notable during that session, not that the cable is benign. Use it as one input to your own judgement.

⚠️ Run this on a dedicated, disposable Raspberry Pi that holds no sensitive data and is isolated from networks you care about. Treat any cable under test as hostile hardware.

How it works

A session has three phases:

Phase What happens
baseline Observe the Pi before the unknown cable is connected.
test You connect / power the unknown cable; CableProbe keeps observing.
post_test You disconnect the cable; CableProbe observes the return to baseline.

CableProbe then compares the three phases and writes a structured JSON report describing everything that appeared, disappeared or changed in correlation with the cable, and runs a set of YAML-configurable detection rules over those differences to produce prioritised findings. The console summary ends with a plain-language "What this means" box — an overall read of the session and what to do next, written for a moderately technical reader rather than a USB specialist.

Connector type does not matter — CableProbe watches how the host reacts, not the plug. Any cable you can get one end of into a port on the test Pi works: USB-C or USB-A, either orientation, with a passive adapter if you need one. The usbc_pd probe additionally reports Type-C power-delivery state when the Pi exposes a Type-C port, and simply skips otherwise.

Probes (observation only)

Probe Observes
udev_monitor Live udev add/remove/change events across all subsystems.
usb USB device inventory (vendor/model, interface classes, HID, hub).
usb_descriptors Per-interface USB descriptors from sysfs (class/subclass/driver/endpoints).
usb_topology USB hub/port tree — hub count, device count, depth, per-hub inventory.
hid_report Parses HID report descriptors — catches a device that can send keystrokes but didn't register as a keyboard, and vendor-usage covert channels.
usbc_pd USB-C / Power Delivery port + partner state: data/power roles, alt modes.
block Block devices and their transport (lsblk).
mounts Filesystem mounts backed by a device or under removable-media paths.
network Network interfaces, drivers, USB-ness, addresses.
routing Default route and DNS resolvers (gateway / resolver hijack).
listeners TCP LISTEN sockets on fixed (non-ephemeral) ports; owning process when ss is present.
persistence Fingerprints boot / device-event / login files (udev rules, systemd units, cron, rc.local, ld.so.preload, authorized_keys, /etc/hosts). Any change during a session is critical.
input Input / HID devices (keyboards, mice, tablets) — one entry per physical device.
serial Serial / modem (TTY) devices, including USB serial (CDC-ACM, FTDI, cp210x).
audio Audio (sound-card) devices, including USB audio class.
video video4linux camera / capture devices, including UVC.
pci PCI and Thunderbolt devices (USB4/TBT PCIe-tunnel / DMA surface).
kernel_modules Loaded kernel modules — catches network / serial / Bluetooth gadget drivers loaded on connect.
keystroke_cadence Key-press timing per input device — flags superhuman / robotic typing.
process New userspace processes started after the session began (kernel threads excluded).
kernel_log Notable kernel / journal lines — enumeration failures and gadget-driver classes (set kernel_log_verbose for the full firehose).
wifi_scan (off by default) Wi-Fi APs in range. Only useful when you specifically suspect the cable carries a radio and can baseline somewhere RF-quiet — on normal premises every session lists a dozen neighbouring APs. Enable it in probes.enabled.
power (off by default) Inline USB VBUS voltage / current from an INA219 on the Pi's I²C bus — the one measurement a cable can't lie about (powered electronics draw tens of mA). Samples continuously between phase boundaries, so a brief current spike (a radio burst) is caught, not just a steady draw. Needs the sensor wired up and pip install 'cableprobe[power]'.
connections (off by default) Outbound TCP connections to routable hosts — a payload or gadget phoning home. Samples continuously between phase boundaries, so a remote host contacted repeatedly across the test phase is distinguished from a single-poll coincidence. Enable only when the test host has no internet access, or every apt/NTP call is noise.

Probes that need hardware or kernel interfaces the host does not expose (no Type-C class, no /sys/bus/pci, …) are skipped automatically. cableprobe check lists them as FAIL with the reason, and a run notes them once as skipped: … (interface not present on this host) — that is expected, not an error. Raspberry Pi 4, for example, has no usbc_pd (its USB-C port is power-only); Raspberry Pi 5 does. To silence a skip entirely, drop the probe from probes.enabled in your config.

Two probes have side effects worth knowing about:

  • keystroke_cadence reads /dev/input/event* for key-press timing only — the key code of every event is discarded before anything is stored, so it never learns which keys were pressed. Set capture_keystroke_timing: false to disable it.
  • wifi_scan (opt-in) runs an active Wi-Fi scan (iw / nmcli) at each phase boundary, which briefly interrupts any Wi-Fi association on that interface. It never associates with a discovered AP. With it enabled, the one rule that fires is a strong AP that appeared on connect and disappeared again on disconnect — a fixed AP on your premises never trips it.

Install

Requires Python 3.11+. See DISTRIBUTING.md for the full picture; the short version:

# 1. pip / pipx on an existing Raspberry Pi OS / Debian host
pipx install cableprobe
sudo apt install usbutils util-linux iw     # CLI tools CableProbe shells out to
#   note: this puts `cableprobe` in ~/.local/bin, which is NOT on root's PATH.
#   run `cableprobe link` once (it escalates itself) so `sudo cableprobe` works
#   (see "command not found" under Usage).

# 2. one command on a Pi (isolated venv under /opt/cableprobe) — RECOMMENDED for
#    a test rig: links /usr/local/bin/cableprobe so `sudo cableprobe` just works,
#    and apt-installs the helper CLIs (usbutils, util-linux, iw, pciutils)
sudo ./scripts/install.sh                    # sudo scripts/uninstall.sh to remove

# 3. from a checkout, for development
git clone https://github.com/rosscooney/CableProbe cableprobe && cd cableprobe
python3 -m venv .venv && . .venv/bin/activate
pip install -e ".[dev]"

For a disposable Raspberry Pi image, build your own from stock Raspberry Pi OS using the pi-gen custom stage in packaging/pi-gen/ — CableProbe ships the recipe, not a prebuilt image.

pyudev needs libudev (present on Raspberry Pi OS / Debian). On non-Linux hosts CableProbe still installs and its --help / check / report commands work, but the live probes are unavailable.

Upgrading

cableprobe upgrade            # checks PyPI directly, then upgrades this install
cableprobe upgrade --check    # just report whether a newer version exists

cableprobe upgrade queries PyPI itself (so it is not fooled by a stale pip index cache the way pipx upgrade sometimes is), works out how this copy was installed — pipx, pip, scripts/install.sh, a source checkout — and runs the right upgrade with the cache bypassed. Then:

cableprobe --version
cableprobe check

Doing it by hand instead:

# pipx, to the latest release — add --no-cache-dir if it claims you're up to date
pipx upgrade cableprobe --pip-args=--no-cache-dir
pipx install --force cableprobe==0.4.1        # pin / roll back to a version

# pipx, to the latest development code (main), ahead of the last release
pipx install --force "cableprobe @ git+https://github.com/rosscooney/CableProbe@main"

# scripts/install.sh install — re-run it against a fresh checkout
git -C cableprobe pull && sudo ./cableprobe/scripts/install.sh

# development checkout
git pull && pip install -e ".[dev]"

If a release drops a probe or changes report fields it is called out in the GitHub release notes and CHANGELOG.md; saved .cableprobe.json reports from older versions still open with cableprobe report.

Usage

# Check the host is ready
cableprobe check

# Run a session (you will be prompted before each phase; a progress bar
# tracks each phase's timer)
sudo cableprobe run --name "suspect-cable-01" \
    --baseline 30 --test 90 --post-test 30

# Unattended / rig mode: advance phases on a timer instead of prompts
sudo cableprobe run --auto --baseline 20 --test 60 --post-test 20

# Inspect a saved report
cableprobe report                         # lists saved reports, asks which
cableprobe report cableprobe-sessions/2026*.cableprobe.json
cableprobe report <file> --format json | jq .

# See / customise detection rules
cableprobe rules
cableprobe rules my-rules.yaml

Running with sudo is strongly recommended: without root the kernel-log, udev-attribute, USB-descriptor, keystroke-timing and raw-socket probes see much less detail and some are skipped entirely. cableprobe run detects this and, in interactive mode, prints the sudo command and asks whether to continue anyway; --auto just warns and proceeds. cableprobe check flags it too.

sudo: cableprobe: command not found? A pipx / pip install --user install puts cableprobe in ~/.local/bin, which is not on root's PATH. Fix it permanently — run this once (no sudo in front; it escalates itself and asks for your password):

cableprobe link          # cableprobe link --remove to undo

after which sudo cableprobe run just works. Or, per-invocation: run it by absolute path (sudo "$(command -v cableprobe)" check) or preserve your PATH (sudo env "PATH=$PATH" cableprobe check). The not-root warning prints whichever of these applies to your install. (scripts/install.sh, below, sets the link up as part of a from-scratch /opt install.)

The self-escalation and cableprobe link resolve the launcher through your PATH. Both refuse to act if the resolved launcher — or the directory holding it — is writable by other users, so a poisoned PATH entry cannot get code run as root that way. On a shared host, install with pipx under your own account or from scripts/install.sh into root-owned /opt.

Exit codes

cableprobe run --fail-on-findings exits 10 / 20 / 30 for the highest finding severity (medium / high / critical), otherwise 0. Without the flag, run always exits 0 on a completed session.

Configuration

Optional YAML config (--config cableprobe.yaml):

session:
  baseline_seconds: 30
  test_seconds: 90
  post_test_seconds: 30
  sample_interval_seconds: 2.0
probes:
  # the default set; list a subset to narrow the session, or add the opt-in
  # probes: wifi_scan, power, connections
  enabled: [udev_monitor, usb, usb_descriptors, usb_topology, hid_report, usbc_pd,
            block, mounts, network, routing, listeners, persistence, input,
            serial, audio, video, pci, kernel_modules, keystroke_cadence,
            process, kernel_log]
  kernel_log_backend: auto        # auto | journalctl | dmesg
  kernel_log_keywords: []         # extra case-insensitive substrings to keep
  kernel_log_verbose: false       # true => also keep routine enumeration chatter
  capture_process_cmdline: true   # false => store only the executable name.
                                  # when true, obvious secrets in argv (--password,
                                  # TOKEN=, user:pass@ URLs, JWTs) are masked
  capture_keystroke_timing: true  # false => disable the keystroke_cadence probe
  power_i2c_bus: 1                 # `power` probe: INA219 location + calibration
  power_i2c_address: 0x40
  power_shunt_ohms: 0.1
  power_alert_ma: 8               # mA over baseline that counts as "electronics"
  power_sample_interval_ms: 250   # `power` waveform: sample cadence between snapshots
  power_series_max_samples: 4000  #   and the per-phase ring cap
  connections_sample_interval_seconds: 2.0  # `connections`: how often to sample
  connections_repeat_threshold: 3           #   samples before a remote counts as "repeated"
rules_file: null                  # null => packaged default rules
output_dir: ./cableprobe-sessions

Reports are written with mode 0600 (they can contain host details, MAC addresses and process command lines). When capture_process_cmdline is on, CableProbe masks the common secret shapes in captured command lines (--password x, TOKEN=x, user:pass@host URLs, JWTs, long high-entropy blobs) on a best-effort basis; if it actually masks a value, the report adds a one-line note to check the rest of it before sharing. All device-supplied text (USB descriptor strings, device names, kernel log lines) is stripped of control characters and length-bounded before it is stored or shown, so a hostile cable cannot inject terminal escape sequences via the report or the console summary.

Report and index writes go through an atomic create-and-rename that never follows a symlink, so a predictable path under the output directory cannot redirect a write. Still, when running as root, point --output-dir at a root-owned directory (scripts/install.sh uses /var/lib/cableprobe/sessions) and don't run from a world-writable working directory — cableprobe run warns, and aborts on a symlinked output directory.

Detection rules

Rules live in YAML (see cableprobe/data/default_rules.yaml). Each rule matches a phase delta and raises a finding:

- id: hid-keyboard-appeared-on-connect
  title: HID keyboard appeared while the unknown cable was connected
  severity: high
  rationale: >
    A keyboard-class HID device that enumerates only when the cable is
    connected is the classic BadUSB signature.
  match:
    change: appeared          # appeared | disappeared | modified
    first_seen_phase: test    # baseline | test | post_test
    kind: [input_device, hid_device]
    attributes:
      any:
        - { key: ID_INPUT_KEYBOARD, equals: "1" }

Match keys: change, kind, first_seen_phase, reverted_after_disconnect, transient, label_regex, event_action, and attributes.all / attributes.any (conditions: equals, not_equals, exists, contains, not_contains, regex).

Known-implant list and allowlist

Two lookup tables are applied to the findings after the rules run:

  • A packaged known-implant list of USB vendor:product IDs that off-the-shelf BadUSB tools present by default (Digispark, Bash Bunny arming mode, Teensy, Malduino boards, ESP32 cable implants, …). A match raises its own finding. Most of these tools can be reflashed with a spoofed ID, so a match is a lead, not proof, and a non-match proves nothing. Extend it with implants_file: my-list.yaml in the config.
  • An allowlist of devices you trust. Findings about an allowlisted device are downgraded to info, so repeat tests of your own gear stop shouting.
cableprobe allow                                    # list
cableprobe allow --vid 0bda --pid 8153 --serial 750998 --name "Belkin USB-C LAN"
cableprobe allow --from-report cableprobe-sessions/2026*.json   # add interactively
cableprobe allow --remove 2

Prefer entries with a serial — one without trusts any device presenting that vendor:product, including a spoofed one. The allowlist lives at <output_dir>/allowlist.yaml (override with allowlist_file:).

Report structure

{
  "metadata":  { "session_name", "host", "config", "probes_used", "probe_warnings", ... },
  "phases":    { "baseline": {...}, "test": {...}, "post_test": {...} },
  "deltas":    [ { "change", "kind", "identity", "label",
                   "first_seen_phase", "present_in",
                   "reverted_after_disconnect", "transient",
                   "attributes", "attribute_changes", "related_events" } ],
  "findings":  [ { "rule_id", "title", "severity", "rationale", "evidence" } ],
  "summary":   { "delta_count", "cable_correlated_change_count",
                 "findings_by_severity", "highest_severity", ... }
}

Development

pip install -e ".[dev]"
pytest

The analysis, rules and report layers are pure and fully unit-tested without hardware. Each probe keeps a pure parser (of lsusb / lsblk / /proc output) or sysfs-tree scanner that is tested against captured samples or a fake /sys tree — see tests/test_probes_parsing.py and tests/test_probes_new.py.

The source lives at https://github.com/rosscooney/CableProbe. See CHANGELOG.md for what changed in each release, CONTRIBUTING.md for how to contribute, SECURITY.md for how to report vulnerabilities privately, and RELEASING.md for how maintainers cut a release to PyPI.

Scope / non-goals

  • CLI only — no web dashboard.
  • The usbc_pd probe reads the kernel's USB-C / Power Delivery port state (data/power roles, alternate modes); CableProbe does not do electrical measurement of the cable itself — no voltage/current sampling, no e-marker interrogation.
  • No offensive capability of any kind, by design.

Third-party dependencies

CableProbe does not copy or vendor third-party source code. It depends on a small set of Python libraries and, at runtime, invokes standard Linux command-line tools as separate, independently installed programs. See NOTICE.md and the note below for details.

Direct Python dependencies and their licences:

Package Licence Notes
typer MIT CLI framework
pydantic MIT data models
psutil BSD-3-Clause process / network inventory
PyYAML MIT config and rules parsing
rich MIT console rendering
pyudev LGPL-2.1-or-later Linux-only; imported as a library — see note
smbus2 MIT optional (power probe / INA219); Linux only
pytest, pytest-asyncio (dev only) MIT, Apache-2.0 test suite

Note on pyudev: pyudev is LGPL-2.1-or-later. It is a normal, separately installed Python dependency that CableProbe imports; it is not vendored or modified. Distributing an MIT-licensed project that depends on an unmodified LGPL library is standard practice, provided pyudev remains replaceable and its source stays available (it is, from PyPI). If you redistribute CableProbe as a bundled binary/image, keep pyudev as a replaceable component and include its licence text. The Linux CLI tools CableProbe shells out to (lsusb/usbutils, lsblk/dmesg/util-linux — GPL-2.0; journalctl/systemd — LGPL-2.1) are invoked as independent programs and do not affect CableProbe's MIT licensing.

Licence

CableProbe is open-source software created by Stable State Consulting Ltd and released under the MIT License.

Copyright © 2026-present Stable State Consulting Ltd.

See LICENSE for details.

Metadata

Release files for CableProbe 0.4.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for CableProbe 0.4.8
File Size Uploaded
cableprobe-0.4.8.tar.gz 169.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for CableProbe 0.4.8
File Interpreter ABI Platform
cableprobe-0.4.8-py3-none-any.whl Python 3 none any Details

Total release size: 307.7 kB

Release files / cableprobe-0.4.8.tar.gz

Download URL cableprobe-0.4.8.tar.gz
Size 169.6 kB
Tags Source
SHA-256 checksum
How to use checksums
dc26efcae3acc6c8215c18f161ccba506bc9d2d41f86efd8610f86c300b35773
BLAKE2b-256 checksum
How to use checksums
4ac7459e9e295e8ef9c620904059e38fdbab11f4ac74c95a9e28b1ee4453ebf7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.

Transparency log

Release files / cableprobe-0.4.8-py3-none-any.whl

Download URL cableprobe-0.4.8-py3-none-any.whl
Size 138.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8757474b7addcd3a9c8a87d35cfa52f228b5d8aee6d846a0f770ce27f5e66ad9
BLAKE2b-256 checksum
How to use checksums
9d7c9c2d7dd3a814d75c764fa3ba36b2f2bb826027273989fc9e4c374ec3e59f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.

Transparency log

Release history Release notifications | RSS feed

0.4.11

2 release files

0.4.10

2 release files

0.4.9

2 release files

This release

0.4.8 This release

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.1.2

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page