You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-16
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,9 @@ This project is written in Python. Here are the dependencies needed to run the t
71
71
-`pypy`
72
72
-`tox` installed via pip or your os package manager
73
73
-`make`
74
+
-`pre-commit`
75
+
-`pip install pre-commit`
76
+
-`pre-commit install`
74
77
75
78
#### Installing via pyenv
76
79
@@ -90,23 +93,9 @@ docker-compose build test && docker-compose run --rm test
90
93
91
94
## Plugins
92
95
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.
94
97
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.
0 commit comments