Skip to content

Commit

Permalink
Added addition plugin information
Browse files Browse the repository at this point in the history
Also updated the `Things that won't be prevented` section
  • Loading branch information
KevinHock authored Sep 20, 2018
1 parent c0bea0b commit 1198523
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@ The current heuristic searches we implement out of the box include:

* **PrivateKeyDetector**: checks to see if any private keys are committed.

* **BasicAuthDetector**: checks to see if BasicAuth is used e.g. `https://username:[email protected]`

* **KeywordDetector**: checks to see if certain keywords are being used e.g. `password` or `secret`

See [detect_secrets/
plugins](https://github.com/Yelp/detect-secrets/tree/master/detect_secrets/plugins)
for more details.
Expand All @@ -152,8 +156,8 @@ committing secrets.

### Things that won't be prevented

* Multi-line secrets.
* Default passwords (eg. `password = "password"`)
* Multi-line secrets
* Default passwords that do not trigger the `KeywordDetector` (e.g. `paaassword = "paaassword"`)

### Plugin Configuration

Expand Down

0 comments on commit 1198523

Please sign in to comment.