Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support exclude regexes, excludewords, and entropy filters for custom detectors #3860

Merged
merged 4 commits into from
Jan 30, 2025
Merged

Support exclude regexes, excludewords, and entropy filters for custom detectors #3860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6fa99b9
Simple implementation of exclude regexes, stopwords, and entropy chec…
zricethezav Jan 30, 2025
cf933e0
better name
zricethezav Jan 30, 2025
37b1b92
readme blurb and example
zricethezav Jan 30, 2025
67bb156
link
zricethezav Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,10 @@ TruffleHog will send a JSON POST request containing the regex matches to a
configured webhook endpoint. If the endpoint responds with a `200 OK` response
status code, the secret is considered verified.

Custom Detectors support a few different filtering mechanisms: entropy, regex targeting the entire match, regex targeting the captured secret,
and excluded word lists checked against the secret (captured group if present, entire match if capture group is not present). Note that if
your custom detector has multiple `regex` set (in this example `hogID`, and `hogToken`), then the filters get applied to each regex. [Here](examples/generic_with_filters.yml) is an example of a custom detector using these filters.

**NB:** This feature is alpha and subject to change.

## Regex Detector Example
Expand Down Expand Up @@ -749,6 +753,8 @@ with HTTPServer(('', 8000), Verifier) as server:
pass
```



## :mag: Analyze

TruffleHog supports running a deeper analysis of a credential to view its permissions and the resources it has access to.
Expand Down
Loading
Loading