docs: update README and manifest for cross-browser support

- Change Chrome extension to browser extension throughout
- Add Chrome Web Store and Firefox Add-ons install links
- Add Firefox badge to README header
- Update architecture section with Firefox manifest and build script
- Update installation instructions for both browsers
This commit is contained in:
moamen
2026-04-14 15:42:08 +02:00
parent 99e54bb93a
commit 8d2f3fc1e4
2 changed files with 31 additions and 21 deletions
+30 -20
View File
@@ -5,12 +5,13 @@
<h1 align="center">KeyFinder</h1> <h1 align="center">KeyFinder</h1>
<p align="center"> <p align="center">
<strong>Passive API key and secret discovery for Chrome</strong> <strong>Passive API key and secret discovery for Chrome and Firefox</strong>
</p> </p>
<p align="center"> <p align="center">
<img src="https://img.shields.io/badge/manifest-v3-blue"/> <img src="https://img.shields.io/badge/manifest-v3-blue"/>
<img src="https://img.shields.io/badge/Chrome-Extension-green"/> <a href="https://chromewebstore.google.com/detail/keyfinder/oogbljkilkfgdlkbmajlolpanilnnkim"><img src="https://img.shields.io/badge/Chrome-Extension-green"/></a>
<a href="https://addons.mozilla.org/en-US/firefox/addon/keyfinder-original/"><img src="https://img.shields.io/badge/Firefox-Add--on-orange"/></a>
<img src="https://img.shields.io/github/license/momenbasel/keyFinder"/> <img src="https://img.shields.io/github/license/momenbasel/keyFinder"/>
<img src="https://img.shields.io/github/v/release/momenbasel/keyFinder"/> <img src="https://img.shields.io/github/v/release/momenbasel/keyFinder"/>
<img src="https://img.shields.io/github/downloads/momenbasel/keyFinder/total.svg"/> <img src="https://img.shields.io/github/downloads/momenbasel/keyFinder/total.svg"/>
@@ -18,7 +19,7 @@
<hr> <hr>
KeyFinder is a Chrome extension that passively scans every page you visit for leaked API keys, tokens, secrets, and credentials. It runs silently in the background with zero configuration required. KeyFinder is a browser extension for Chrome and Firefox that passively scans every page you visit for leaked API keys, tokens, secrets, and credentials. It runs silently in the background with zero configuration required.
## What It Detects ## What It Detects
@@ -57,7 +58,7 @@ Additionally, **Shannon entropy analysis** is applied to detect random high-entr
## Features ## Features
- **Zero dependencies** - Pure vanilla JavaScript, no jQuery, no external libraries - **Zero dependencies** - Pure vanilla JavaScript, no jQuery, no external libraries
- **Manifest V3** - Built for modern Chrome with service worker architecture - **Manifest V3** - Built for modern Chrome and Firefox with service worker architecture
- **Passive scanning** - Runs automatically on every page load - **Passive scanning** - Runs automatically on every page load
- **Custom keywords** - Add your own search terms to scan for - **Custom keywords** - Add your own search terms to scan for
- **Dashboard** - Professional results page with filtering, sorting, and search - **Dashboard** - Professional results page with filtering, sorting, and search
@@ -68,12 +69,11 @@ Additionally, **Shannon entropy analysis** is applied to detect random high-entr
## Installation ## Installation
### From Release (Recommended) ### Chrome
- [Install from Chrome Web Store](https://chromewebstore.google.com/detail/keyfinder/oogbljkilkfgdlkbmajlolpanilnnkim)
1. Go to [Releases](https://github.com/momenbasel/keyFinder/releases) and download the latest `.crx` file ### Firefox
2. Open Chrome and navigate to `chrome://extensions` - [Install from Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/keyfinder-original/)
3. Enable **Developer mode** (top right toggle)
4. Drag and drop the `.crx` file onto the page
### From Source ### From Source
@@ -81,10 +81,16 @@ Additionally, **Shannon entropy analysis** is applied to detect random high-entr
git clone https://github.com/momenbasel/keyFinder.git git clone https://github.com/momenbasel/keyFinder.git
``` ```
1. Open Chrome and go to `chrome://extensions` **Chrome:**
1. Go to `chrome://extensions`
2. Enable **Developer mode** 2. Enable **Developer mode**
3. Click **Load unpacked** and select the `keyFinder` folder 3. Click **Load unpacked** and select the `keyFinder` folder
**Firefox:**
1. Go to `about:debugging` > "This Firefox"
2. Click **Load Temporary Add-on**
3. Select `manifest.firefox.json` from the `keyFinder` folder
## Usage ## Usage
1. **Install** the extension 1. **Install** the extension
@@ -104,22 +110,26 @@ Default keywords: `key`, `api_key`, `apikey`, `api-key`, `secret`, `token`, `acc
``` ```
keyFinder/ keyFinder/
manifest.json # MV3 manifest manifest.json # Chrome MV3 manifest
popup.html # Extension popup UI manifest.firefox.json # Firefox MV3 manifest
results.html # Findings dashboard popup.html # Extension popup UI
results.html # Findings dashboard
js/ js/
background.js # Service worker - storage and message handling background.js # Service worker - storage and message handling
patterns.js # 80+ secret detection regex patterns patterns.js # 80+ secret detection regex patterns
content.js # Page scanner - DOM, scripts, network interception content.js # Page scanner - DOM, scripts, network interception
popup.js # Popup logic interceptor.js # XHR/Fetch hooking and window global scanning
results.js # Dashboard logic with filtering and export popup.js # Popup logic
results.js # Dashboard logic with filtering and export
css/ css/
popup.css # Popup styles popup.css # Popup styles
results.css # Dashboard styles results.css # Dashboard styles
icons/ icons/
icon16.png icon16.png
icon48.png icon48.png
icon128.png icon128.png
scripts/
build.sh # Build Chrome and Firefox zip packages
``` ```
## Disclaimer ## Disclaimer
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "KeyFinder", "name": "KeyFinder",
"description": "Passively discovers API keys, tokens, and secrets leaked in page scripts, DOM, network responses, and browser storage.", "description": "Passively discovers API keys, tokens, and secrets leaked in page scripts, DOM, network responses, and browser storage. Available for Chrome and Firefox.",
"version": "2.0.0", "version": "2.0.0",
"manifest_version": 3, "manifest_version": 3,
"action": { "action": {