Skip to content

Commit 50a2f8b

Browse files
committed
Update README: reflect SPA support, nonce bridge, loader, SECURITY links
1 parent 72f324a commit 50a2f8b

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,13 @@ Additionally, **Shannon entropy analysis** is applied to detect random high-entr
6060
- **Zero dependencies** - Pure vanilla JavaScript, no jQuery, no external libraries
6161
- **Manifest V3** - Built for modern Chrome and Firefox with service worker architecture
6262
- **Passive scanning** - Runs automatically on every page load
63-
- **Custom keywords** - Add your own search terms to scan for
63+
- **SPA-aware** - MutationObserver re-scans dynamically injected DOM
64+
- **Per-tab alert badge** - Red-dot icon overlay when a tab has findings
65+
- **Custom keywords** - Add your own search terms to scan for (validated, 50 max)
6466
- **Dashboard** - Professional results page with filtering, sorting, and search
65-
- **Export** - Download findings as JSON or CSV
66-
- **Badge counter** - Shows finding count on the extension icon
67+
- **Export** - Download findings as JSON or CSV (with formula-injection sanitiser)
68+
- **Hardened bridge** - Per-page nonce on MAIN <-> ISOLATED CustomEvent channel
69+
- **Bounded storage** - 5000-finding cap with FIFO eviction; serialised writes across tabs
6770
- **Low footprint** - Minimal CPU and memory usage
6871
- **All frames** - Scans iframes and embedded content
6972

@@ -117,8 +120,9 @@ keyFinder/
117120
js/
118121
background.js # Service worker - storage and message handling
119122
patterns.js # 80+ secret detection regex patterns
120-
content.js # Page scanner - DOM, scripts, network interception
121-
interceptor.js # XHR/Fetch hooking and window global scanning
123+
content.js # ISOLATED-world page scanner - DOM, scripts, network
124+
interceptor-loader.js # ISOLATED loader - sets nonce, injects MAIN-world interceptor
125+
interceptor.js # MAIN-world XHR/Fetch hooks + window global scanning
122126
popup.js # Popup logic
123127
results.js # Dashboard logic with filtering and export
124128
css/
@@ -132,6 +136,10 @@ keyFinder/
132136
build.sh # Build Chrome and Firefox zip packages
133137
```
134138

139+
## Security
140+
141+
See [SECURITY.md](SECURITY.md) for the threat model, disclosure policy, and known limitations. Release notes are in [CHANGELOG.md](CHANGELOG.md).
142+
135143
## Disclaimer
136144

137145
This tool is intended for **security research and authorized testing only**. Use it to identify leaked secrets on your own applications or during authorized penetration tests. You are responsible for your own actions.

0 commit comments

Comments
 (0)