Detect-secrets

July 9th, 2020

:mega: Release Highlights

- Remove support for Python 2 ([292], big thanks to [KevinHock]!)

:tada: New Features

- Add support for custom plugins ([308], big thanks to [KevinHock]!)

:performing_arts: Performance

- Check the allowlist after a secret is found, instead of before ([293], [244])

:telescope: Accuracy

- Make IBM plugins less noisy ([289], thanks to [killuazhu])

:bug: Bugfixes

- Display helpful error message when scanning a baseline from a newer `detect-secrets` version ([293], [269])

:snake: Miscellaneous

- Pin coverage version used in testing ([290])

[244]: https://github.com/Yelp/detect-secrets/issues/244
[269]: https://github.com/Yelp/detect-secrets/issues/269
[289]: https://github.com/Yelp/detect-secrets/pull/289
[290]: https://github.com/Yelp/detect-secrets/pull/290
[292]: https://github.com/Yelp/detect-secrets/pull/292
[293]: https://github.com/Yelp/detect-secrets/pull/293
[308]: https://github.com/Yelp/detect-secrets/pull/308

March 26th, 2020

:tada: New Features

- Adding plugin for IBM's Cloudant ([261], thanks [killuazhu])
- Adding plugin for IBM Cloud Object Storage HMAC ([263], thanks [killuazhu])
- Adding Twilio plugin ([267], thanks [EdOverflow])

[261]: https://github.com/Yelp/detect-secrets/pull/261
[263]: https://github.com/Yelp/detect-secrets/pull/263
[267]: https://github.com/Yelp/detect-secrets/pull/267

:sparkles: Usability

- Support for `DETECT_SECRETS_SECURITY_TEAM` environment variable to customize
the pre-commit hook error message ([283], thanks [0atman])

[283]: https://github.com/Yelp/detect-secrets/pull/283

:bug: Bugfixes

- Adhoc `HighEntropyString` scanning supports multiple words ([287])

[287]: https://github.com/Yelp/detect-secrets/pull/287

October 28th, 2019

:newspaper: News

- Rationale for the minor version bump:
- Some accuracy changes that might change baselines significantly
- OiCMudkips' first release increases spookiness
- It being almost Halloween increases spookiness

:tada: New Features

- Added a Softlayer plugin ([254], thanks [killuazhu] and [justineyster])
- Support URL-safe base64 strings in the base64 plugin ([245])

:sparkles: Usability

- Make it easier to add new plugins to detect-secrets ([248])

:telescope: Accuracy

- Exclude NOPASSWD from the keyword detector ([247], thanks [security-architecture])
- Ignore lines with `id` in them in the high-entropy plugins ([245])
- Ignore UUIDs detected by the base64 plugin ([245])

:bug: Bugfixes

- Fix the signal metric in the audit results view ([251])

[245]: https://github.com/Yelp/detect-secrets/pull/245
[247]: https://github.com/Yelp/detect-secrets/pull/247
[248]: https://github.com/Yelp/detect-secrets/pull/248
[251]: https://github.com/Yelp/detect-secrets/pull/251
[254]: https://github.com/Yelp/detect-secrets/pull/254

September 23rd, 2019

:tada: New Features

- Added a `JwtTokenDetector` plugin ([239], thanks [gdemarcsek])
- [Added verification for Mailchimp API keys](https://github.com/Yelp/detect-secrets/pull/241/commits/977c4fb5606b42a9c73dfb598fa0a6cd0ab77c90)
- [Added verification for Stripe secret API keys](https://github.com/Yelp/detect-secrets/pull/241/commits/9cabbe078c16ce476400859ebbdf160c82f6ea80)

:telescope: Accuracy

- Added a `--word-list` option for filtering secrets with words in them ([241], do `pip install detect-secrets[word_list]` to use this feature)

:bug: Bugfixes

- [Fixed a bug where we were not skipping ignored file extensions](https://github.com/Yelp/detect-secrets/pull/241/commits/bb543c5b20372f507ae0f99f7d01872f66db3a83)
- [Fixed a bug in the `audit` functionality where we crashed if the baseline had a Mailchimp secret in it](https://github.com/Yelp/detect-secrets/pull/241/commits/ef5d0006cc953784631f19f7de72ba3ab5972def)

[239]: https://github.com/Yelp/detect-secrets/pull/239
[241]: https://github.com/Yelp/detect-secrets/pull/241

September 16th, 2019

:tada: New Features

- Added a `MailchimpDetector` plugin ([217], thanks [dgzlopes])
- Added verification for Slack webhooks ([233], thanks [Patil2099])

:telescope: Accuracy

- Added handling of binary secrets in YAML files ([223])
- Added various accuracy improvements to the `KeywordDetector` plugin ([229])

:bug: Bugfixes

- Fixed a bug in the `audit` functionality where we crashed when the highlighter failed ([228])
- Fixed a bug in the `audit` functionality where there was no (b)ack audit functionality when a secret was not found ([215], thanks [dgzlopes])
- Fixed a bug where we were not excluding SVG files ([219])

:snake: Miscellaneous

- Added a unique exit code to identify baseline changes ([214], thanks [lirantal])
- Updated and ran our pre-commit hooks ([221], thanks [killuazhu])


[214]: https://github.com/Yelp/detect-secrets/pull/214
[215]: https://github.com/Yelp/detect-secrets/pull/215
[217]: https://github.com/Yelp/detect-secrets/pull/217
[219]: https://github.com/Yelp/detect-secrets/pull/219
[221]: https://github.com/Yelp/detect-secrets/pull/221
[223]: https://github.com/Yelp/detect-secrets/pull/223
[228]: https://github.com/Yelp/detect-secrets/pull/228
[229]: https://github.com/Yelp/detect-secrets/pull/229
[233]: https://github.com/Yelp/detect-secrets/pull/233

July 23rd, 2019

:tada: New Features

- Added webhook detection to our `SlackDetector` plugin ([195], thanks [adrianbn])
- Added support for scanning multiple files ([188], thanks [dgzlopes])
- Added support for scanning multiple repositories ([193])
- Added verification for AWS access keys and Slack tokens ([194])
- Added an `audit --display-results` feature to aid plugin development ([205])

:telescope: Accuracy

- Improved our Artifactory regex ([195], thanks [adrianbn])
- Improved sequential string detection to catch the Base64 character set ([207])
- Moved our sequential string detection so it is used by all plugins ([196])

:performing_arts: Performance

- Added performance testing benchmarks ([181], [186], [187], thanks [dgzlopes])

[181]: https://github.com/Yelp/detect-secrets/pull/181
[186]: https://github.com/Yelp/detect-secrets/pull/186
[187]: https://github.com/Yelp/detect-secrets/pull/187
[188]: https://github.com/Yelp/detect-secrets/pull/188
[193]: https://github.com/Yelp/detect-secrets/pull/193
[194]: https://github.com/Yelp/detect-secrets/pull/194
[195]: https://github.com/Yelp/detect-secrets/pull/195
[196]: https://github.com/Yelp/detect-secrets/pull/196
[205]: https://github.com/Yelp/detect-secrets/pull/205
[207]: https://github.com/Yelp/detect-secrets/pull/207