Skip to content

Commit 86640a4

Browse files
authored
Merge pull request #138 from mongodb/development
updated README
2 parents b7d8e29 + 5074342 commit 86640a4

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,17 @@
44
<img src="docs/kingfisher_logo.png" alt="Kingfisher Logo" width="126" height="173" style="vertical-align: right;" />
55

66
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)<br>
7-
[![ghcr downloads](https://ghcr-badge.elias.eu.org/shield/mongodb/kingfisher/kingfisher)](https://github.com/mongodb/kingfisher/pkgs/container/kingfisher)
7+
[![ghcr downloads](https://ghcr-badge.elias.eu.org/shield/mongodb/kingfisher/kingfisher)](https://github.com/mongodb/kingfisher/pkgs/container/kingfisher)<br>
88

99

10-
Kingfisher is a blazingly fast secret‑scanning and live validation tool built in Rust. It combines Intel’s SIMD accelerated regex engine (Hyperscan) with language‑aware source code parsing, and **ships with hundreds of built‑in rules** to detect, validate, and triage secrets before they ever reach production
11-
</p>
10+
Kingfisher is a blazingly fast secret-scanning and **live validation** tool built in Rust.
11+
12+
It combines Intel’s SIMD-accelerated regex engine (Hyperscan) with language-aware parsing to achieve high accuracy at massive scale,
13+
and **ships with hundreds of built-in rules** to detect, **validate**, and triage secrets before they ever reach production.
14+
15+
For a look at how Kingfisher has grown from its early foundations into today's full-featured scanner, see [Lineage and Evolution](#lineage-and-evolution).
1216

13-
Originally forked from Praetorian’s Nosey Parker, Kingfisher has since significantly expanded and diverged, adding live validation, 10+ new scan targets, and major architectural enhancements. See [Origins and Divergence](#origins-and-divergence) for details.
17+
</p>
1418

1519
## Key Features
1620

@@ -143,7 +147,7 @@ See ([docs/COMPARISON.md](docs/COMPARISON.md))
143147
- [Finding Fingerprint](#finding-fingerprint)
144148
- [Rule Performance Profiling](#rule-performance-profiling)
145149
- [CLI Options](#cli-options)
146-
- [Origins and Divergence](#origins-and-divergence)
150+
- [Lineage and Evolution](#lineage-and-evolution)
147151
- [Roadmap](#roadmap)
148152
- [License](#license)
149153

@@ -156,7 +160,7 @@ See ([docs/COMPARISON.md](docs/COMPARISON.md))
156160
Pre-built binaries are available from the [Releases](https://github.com/mongodb/kingfisher/releases) section.
157161

158162
### Homebrew
159-
163+
![Homebrew Formula Version](https://img.shields.io/homebrew/v/kingfisher)
160164

161165
```bash
162166
brew install kingfisher
@@ -1286,20 +1290,22 @@ kingfisher scan --help
12861290
```
12871291

12881292

1289-
## Origins and Divergence
1293+
## Lineage and Evolution
1294+
1295+
Kingfisher began as an internal fork of Nosey Parker, used as a high-performance foundation for secret detection.
12901296

1291-
Kingfisher began as a fork of Praetorian’s Nosey Parker, as our experiment with adding live validation support and embedding that validation directly inside each rule.
1297+
Since then it has evolved far beyond that starting point, introducing live validation, hundreds of new rules, additional scan targets, and major architectural changes across nearly every subsystem.
12921298

1293-
Since that initial fork, it has diverged heavily from Nosey Parker:
1294-
- Added support for live validation of discovered secrets
1295-
- Added hundreds of new rules
1296-
- Added support for analyzing compressed files
1297-
- Added support for building "baselines" to allow for only reporting on newly discovered secrets
1298-
- Added Tree-Sitter based source code parsing on top of Hyperscan for deeper language-aware detection
1299-
- Expanded support for new targets (GitLab, BitBucket, Gitea, Jira, Confluence, Slack, S3, GCS, Docker, Hugging Face, etc.)
1300-
- Replaced the SQLite datastore with an in-memory store + Bloom filter
1301-
- Collapsed the workflow into a single scan-and-report phase with direct JSON/BSON/SARIF outputs
1302-
- Delivered cross-platform builds, including native Windows
1299+
**Key areas of evolution**
1300+
- **Live validation** of detected secrets directly within rules
1301+
- **Hundreds of new built-in rules** and an expanded YAML rule schema
1302+
- **Baseline management** to suppress known findings over time
1303+
- **Tree-sitter parsing** layered on Hyperscan for language-aware detection
1304+
- **More scan targets** (GitLab, Bitbucket, Gitea, Jira, Confluence, Slack, S3, GCS, Docker, Hugging Face, etc.)
1305+
- **Compressed Files** scanning support added
1306+
- **New storage model** (in-memory + Bloom filter, replacing SQLite)
1307+
- **Unified workflow** with JSON/BSON/SARIF outputs
1308+
- **Cross-platform builds** for Linux, macOS, and Windows
13031309

13041310
# Roadmap
13051311

0 commit comments

Comments
 (0)