Skip to content

Find, verify, and analyze leaked credentials

Update README.md (#861)

Dylan Ayreyd5fef0f3e186
diff --git a/README.md b/README.md
index 31c27cf48..7d1150c6f 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,66 @@ https://join.slack.com/t/trufflehog-community/shared_invite/zt-pw2qbi43-Aa86hkii
docker run -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --org=trufflesecurity
```
+## Examples
+
+### Example 1: Scan a repo for only verified secrets
+
+Command:
+```
+trufflehog git https://github.com/trufflesecurity/test_keys --only-verified
+```
+
+Expected output:
+```
+πŸ·πŸ”‘πŸ· TruffleHog. Unearth your secrets. πŸ·πŸ”‘πŸ·
+
+Found verified result πŸ·πŸ”‘
+Detector Type: AWS
+Decoder Type: PLAIN
+Raw result: AKIAYVP4CIPPERUVIFXG
+Line: 4
+Commit: fbc14303ffbf8fb1c2c1914e8dda7d0121633aca
+File: keys
+Email: counter <[email protected]>
+Repository: https://github.com/trufflesecurity/test_keys
+Timestamp: 2022-06-16 10:17:40 -0700 PDT
+...
+```
+
+### Example 2: Scan a GitHub Org for only verified secrets
+
+```
+trufflehog github --org=trufflesecurity --only-verified
+```
+
+### Example 3: Scan a GitHub Repo for only verified keys and get JSON output
+
+Command:
+```
+trufflehog git https://github.com/trufflesecurity/test_keys --only-verified --json
+```
+
+Expected output:
+```
+{"SourceMetadata":{"Data":{"Git":{"commit":"fbc14303ffbf8fb1c2c1914e8dda7d0121633aca","file":"keys","email":"counter \[email protected]\u003e","repository":"https://github.com/trufflesecurity/test_keys","timestamp":"2022-06-16 10:17:40 -0700 PDT","line":4}}},"SourceID":0,"SourceType":16,"SourceName":"trufflehog - git","DetectorType":2,"DetectorName":"AWS","DecoderName":"PLAIN","Verified":true,"Raw":"AKIAYVP4CIPPERUVIFXG","Redacted":"AKIAYVP4CIPPERUVIFXG","ExtraData":{"account":"595918472158","arn":"arn:aws:iam::595918472158:user/canarytokens.com@@mirux23ppyky6hx3l6vclmhnj","user_id":"AIDAYVP4CIPPJ5M54LRCY"},"StructuredData":null}
+...
+```
+
+### Example 4: Scan an S3 bucket for verified keys
+```
+trufflehog s3 --bucket=<bucket name> --only-verified
+```
+
+### FAQ
+
++ All I see is `πŸ·πŸ”‘πŸ· TruffleHog. Unearth your secrets. πŸ·πŸ”‘πŸ·` and the program exits, what gives?
+ + That means no secrets were detected
++ Why is the scan is taking a long time when I scan a GitHub org
+ + Unathenticated GitHub scans have rate limits. To improve your rate limits, include the `--token` flag with a personal access token
++ It says a private key was verified, what does that mean?
+ + Check out our Driftwood blog post to learn how to do this, in short we've confirmed the key can be used live for SSH or SSL [Blog post](https://trufflesecurity.com/blog/driftwood-know-if-private-keys-are-sensitive/)
+
+
# What's new in v3?
TruffleHog v3 is a complete rewrite in Go with many new powerful features.