|
|
@@ -30,14 +30,32 @@
|
|
|
|
|
|
Gitleaks is a SAST tool for **detecting** and **preventing** hardcoded secrets like passwords, api keys, and tokens in git repos. Gitleaks is an **easy-to-use, all-in-one solution** for detecting secrets, past or present, in your code.
|
|
|
|
|
|
-| Demos |
|
|
|
-| ----------- |
|
|
|
-| CLI [](https://asciinema.org/a/455683)|
|
|
|
-| [Github-Action](https://github.com/gitleaks/gitleaks-action) |
|
|
|
+```
|
|
|
+➜ ~/code(master) gitleaks detect --source . -v
|
|
|
+
|
|
|
+ ○
|
|
|
+ │╲
|
|
|
+ │ ○
|
|
|
+ ○ ░
|
|
|
+ ░ gitleaks
|
|
|
+
|
|
|
+
|
|
|
+Finding: "export BUNDLE_ENTERPRISE__CONTRIBSYS__COM=cafebabe:deadbeef",
|
|
|
+Secret: cafebabe:deadbeef
|
|
|
+RuleID: sidekiq-secret
|
|
|
+Entropy: 2.609850
|
|
|
+File: cmd/generate/config/rules/sidekiq.go
|
|
|
+Line: 23
|
|
|
+Commit: cd5226711335c68be1e720b318b7bc3135a30eb2
|
|
|
+Author: John
|
|
|
+Email: john@users.noreply.github.com
|
|
|
+Date: 2022-08-03T12:31:40Z
|
|
|
+Fingerprint: cd5226711335c68be1e720b318b7bc3135a30eb2:cmd/generate/config/rules/sidekiq.go:sidekiq-secret:23
|
|
|
+```
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
-Gitleaks can be installed using Homebrew, Docker, or Go. Gitleaks is also available in binary form for many popular platforms and OS types on the [releases page](https://github.com/zricethezav/gitleaks/releases). In addition, Gitleaks can be implemented as a pre-commit hook directly in your repo or as a GitHub action using [Gitleaks-Action](https://github.com/gitleaks/gitleaks-action) (see demo above).
|
|
|
+Gitleaks can be installed using Homebrew, Docker, or Go. Gitleaks is also available in binary form for many popular platforms and OS types on the [releases page](https://github.com/zricethezav/gitleaks/releases). In addition, Gitleaks can be implemented as a pre-commit hook directly in your repo or as a GitHub action using [Gitleaks-Action](https://github.com/gitleaks/gitleaks-action).
|
|
|
|
|
|
### MacOS
|
|
|
|