High-performance iocx plugin for detecting Windows Registry keys, values, and persistence locations.
Project description
iocx-registry-keys
A high‑performance registry key detector plugin for the iocx engine.
This plugin extracts:
- Registry keys (generic Windows registry paths)
- Registry values (REG_SZ, REG_DWORD, etc.)
- Persistence keys (autorun locations such as Run and RunOnce)
What this plugin does not do:
- Read the Windows registry
- Execute code
- Perform system inspection
It only analyses text input and extracts registry-related IOCs.
It is designed to be:
- Fast — sub‑millisecond detection on typical inputs
- Safe — no catastrophic backtracking, even on pathological inputs
- Accurate — clean separation between keys, values, and persistence
- Well‑tested — full unit, integration, and performance coverage
Features
✔ Registry Key Detection
Matches Windows registry paths such as:
HKCU\Software\Example
HKLM\System\CurrentControlSet\Services\Tcpip
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows
✔ Registry Value Detection
Detects common value types:
REG_SZ
REG_DWORD
REG_BINARY
REG_QWORD
REG_MULTI_SZ
REG_EXPAND_SZ
✔ Persistence Key Detection
Identifies autorun locations used by malware:
HKCU\Software\Microsoft\Windows\CurrentVersion\Run
HKLM\Software\Microsoft\Windows\CurrentVersion\RunOnce
HKCU\Software\Microsoft\Windows\CurrentVersion\Policies\Explorer\Run
✔ High Performance
All detectors are optimized to avoid backtracking and scale linearly with input size.
✔ Enrichment Heuristics (optional)
When run with --enrich or via the Python API, this plugin applies a lightweight scoring model to each detected registry key. The goal is to highlight keys that are more likely to indicate persistence mechanisms, suspicious tooling, or malware staging behaviour. Enrichment helps analysts quickly prioritise registry keys that warrant deeper investigation, especially in large or noisy datasets.
Each enrichment entry includes:
- value — the original registry key
- score — integer score (0–100)
- reasons — human‑readable explanations
- flags — boolean indicators for specific heuristics
The scoring model is fully deterministic - the same input always produces the same score and reasons.
Scoring Rules:
The following heuristics contribute to the score:
| Heuristic | Description | Score |
|---|---|---|
| Persistence path | Key is under a known autorun location | +50 |
(Run, RunOnce, Policies\Explorer\Run) |
||
| Suspicious substrings | Key contains tooling or malware‑associated | +10 each |
| terms (powershell, cmd.exe, wscript, etc.) | ||
| Unusually long key | Path length > 200 characters (common in | +5 |
| obfuscation or hiding techniques) | ||
| Unknown vendor paths | Keys under uncommon vendor namespaces | +? |
| (optional future rule) |
Example Enrichment Output:
{
"value": "HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Run\\BadApp",
"score": 60,
"reasons": [
"Registry path contains persistence location: HKCU/HKLM Run key",
"Matched suspicious substring: 'BadApp'"
],
"flags": {
"persistence": true,
"suspicious_substrings": ["BadApp"]
}
}
The heuristics are intentionally conservative: they highlight suspicious patterns without generating false positives for normal system activity.
Installation
Install via pip:
pip install iocx-registry-keys
Or install in editable mode during development:
pip install -e .
Usage
The plugin is automatically discovered by the iocx engine via entry points.
CLI
echo "HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Run\\BadApp" | iocx -
Python API
from iocx import Engine
engine = Engine()
result = engine.extract("HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Run\\BadApp")
print(result["iocs"])
Output
{
"registry.persistence": [
"HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Run\\BadApp"
],
"registry.keys": [],
"registry.values": []
}
Related Plugins
iocx(core engine)
Development
Install dev dependencies
make install
Run tests
make test
make test-performance
Run coverage
make test-coverage
Run security checks
make security
This runs:
- pip-audit for dependency vulnerabilities
- bandit for static code security analysis
Performance
This plugin includes a full performance suite under tests/performance/.
Example results on a typical machine:
registry-keys 1MB mixed-content: ~0.002s
registry-values 1MB mixed-content: ~0.001s
registry-persistence 1MB mixed-content ~0.002s
registry-enricher 60k mixed-content: ~0.006s
Pathological cases (deep nesting, repeated patterns) remain safe and predictable.
Testing
The project includes:
- Unit tests
- Integration tests
- Performance tests
- Pathological safety tests
- 100% coverage on plugin code
Run everything:
pytest -q
Contributing
Contributions are welcome.
If you want to propose changes to detection behavior (e.g., adding new persistence keys), please open a PR. Priority decisions are centrally managed by the IOCX engine, so contributors can propose category priority changes through the normal review process.
License
MIT License.
See LICENSE for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file iocx_registry_keys-1.1.0.tar.gz.
File metadata
- Download URL: iocx_registry_keys-1.1.0.tar.gz
- Upload date:
- Size: 6.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
901bef283be2dcb7c7a388deea2da09ee8414e0be5593215234abebdbe821777
|
|
| MD5 |
7ccfb84f7233f3213eaecbe12b1e7af0
|
|
| BLAKE2b-256 |
00ce49ebd411ce260be9ccdd4bd1fbca90bf660d534c19e0b5b40d52a48cf95f
|
File details
Details for the file iocx_registry_keys-1.1.0-py3-none-any.whl.
File metadata
- Download URL: iocx_registry_keys-1.1.0-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2adce09dc036674f67dae2e336fdb3c8308e9b708c794fac8396adbc706dad60
|
|
| MD5 |
d68192af594529c6d00009212e3ba4aa
|
|
| BLAKE2b-256 |
d92c42bbaaf955d54c35bb57224b6ddf577d8a0ee237fd7abbda67c21c2644aa
|