Skip to content

Commit fa39922

Browse files
committed
Update README (Yelp#287)
Supports git-defenders/detect-secrets-discuss#390
1 parent 604e8f7 commit fa39922

File tree

2 files changed

+6
-26
lines changed

2 files changed

+6
-26
lines changed

Diff for: .secrets.baseline

+1-10
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"files": "test_data/.*|tests/.*|^.secrets.baseline$",
44
"lines": null
55
},
6-
"generated_at": "2020-02-17T15:57:42Z",
6+
"generated_at": "2020-04-08T20:21:00Z",
77
"plugins_used": [
88
{
99
"name": "AWSKeyDetector"
@@ -27,15 +27,6 @@
2727
}
2828
],
2929
"results": {
30-
"README.md": [
31-
{
32-
"hashed_secret": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
33-
"is_secret": false,
34-
"is_verified": false,
35-
"line_number": 103,
36-
"type": "Basic Auth Credentials"
37-
}
38-
],
3930
"detect_secrets/plugins/private_key.py": [
4031
{
4132
"hashed_secret": "daefe0b4345a654580dcad25c7c11ff4c944a8c0",

Diff for: README.md

+5-16
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ This project is written in Python. Here are the dependencies needed to run the t
7171
- `pypy`
7272
- `tox` installed via pip or your os package manager
7373
- `make`
74+
- `pre-commit`
75+
- `pip install pre-commit`
76+
- `pre-commit install`
7477

7578
#### Installing via pyenv
7679

@@ -90,23 +93,9 @@ docker-compose build test && docker-compose run --rm test
9093

9194
## Plugins
9295

93-
Each of the checks are developed as plugins in the [detect_secrets/plugins](/tree/master/detect_secrets/plugins) directory. Each plugin represent a single test or a group of tests. The following is a list of the currently developed plugins:
96+
Each of the secret checks are developed as plugins in the [detect_secrets/plugins](/tree/master/detect_secrets/plugins) directory. Each plugin represents a single test or a group of tests.
9497

95-
The current heuristic searches we implement out of the box include:
96-
97-
* **Base64HighEntropyString**: checks for all strings matching the Base64 character set, and alerts if their Shannon entropy is above a certain limit.
98-
99-
* **HexHighEntropyString**: checks for all strings matching the Hex character set, and alerts if their Shannon entropy is above a certain limit.
100-
101-
* **PrivateKeyDetector**: checks to see if any private keys are committed.
102-
103-
* **BasicAuthDetector**: checks to see if BasicAuth is used e.g. `https://username:[email protected]`
104-
105-
* **KeywordDetector**: checks to see if certain keywords are being used e.g. `password` or `secret`
106-
107-
* **ArtifactoryDetector**: checks to see if Artifactory credentials are present.
108-
109-
* **GheDetector**: checks to see if GitHub credentials are present.
98+
Refer to the plugin directory above for the list of supported secret detectors.
11099

111100
## IBM versioning and rebase guide
112101

0 commit comments

Comments
 (0)