diff --git a/.secrets.baseline b/.secrets.baseline index 62db3dfcc..b17bee5e6 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -3,7 +3,7 @@ "files": "test_data/.*|tests/.*|^.secrets.baseline$", "lines": null }, - "generated_at": "2020-02-17T15:57:42Z", + "generated_at": "2020-04-08T20:21:00Z", "plugins_used": [ { "name": "AWSKeyDetector" @@ -27,15 +27,6 @@ } ], "results": { - "README.md": [ - { - "hashed_secret": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8", - "is_secret": false, - "is_verified": false, - "line_number": 103, - "type": "Basic Auth Credentials" - } - ], "detect_secrets/plugins/private_key.py": [ { "hashed_secret": "daefe0b4345a654580dcad25c7c11ff4c944a8c0", diff --git a/README.md b/README.md index 6024cc43e..2f0bde8be 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,9 @@ This project is written in Python. Here are the dependencies needed to run the t - `pypy` - `tox` installed via pip or your os package manager - `make` +- `pre-commit` + - `pip install pre-commit` + - `pre-commit install` #### Installing via pyenv @@ -90,23 +93,9 @@ docker-compose build test && docker-compose run --rm test ## Plugins -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: +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. -The current heuristic searches we implement out of the box include: - -* **Base64HighEntropyString**: checks for all strings matching the Base64 character set, and alerts if their Shannon entropy is above a certain limit. - -* **HexHighEntropyString**: checks for all strings matching the Hex character set, and alerts if their Shannon entropy is above a certain limit. - -* **PrivateKeyDetector**: checks to see if any private keys are committed. - -* **BasicAuthDetector**: checks to see if BasicAuth is used e.g. `https://username:password@example.com` - -* **KeywordDetector**: checks to see if certain keywords are being used e.g. `password` or `secret` - -* **ArtifactoryDetector**: checks to see if Artifactory credentials are present. - -* **GheDetector**: checks to see if GitHub credentials are present. +Refer to the plugin directory above for the list of supported secret detectors. ## IBM versioning and rebase guide