diff --git a/knowledge base/detect-secrets.md b/knowledge base/detect-secrets.md new file mode 100644 index 0000000..0320093 --- /dev/null +++ b/knowledge base/detect-secrets.md @@ -0,0 +1,68 @@ +# `detect-secrets` + +Python module for detecting secrets within code bases. + +1. [TL;DR](#tldr) +1. [Further readings](#further-readings) + 1. [Sources](#sources) + +## TL;DR + +
+ Setup + +```sh +brew install 'detect-secrets' +pip install 'detect-secrets' +``` + +
+ +
+ Usage + +```sh +detect-secrets scan +detect-secrets scan --exclude-lines 'password = (blah|fake)' --exclude-files '.*\.signature$' +``` + +
+ + + +## Further readings + +- [Main repository] + +Alternatives: + +- [gitleaks] +- [`ripsecrets`][ripsecrets] +- [trufflehog] + +### Sources + + + + + +[gitleaks]: gitleaks.md +[ripsecrets]: ripsecrets.md +[trufflehog]: trufflehog.md + + + +[main repository]: https://github.com/Yelp/detect-secrets + + diff --git a/knowledge base/detect-secrets.placeholder b/knowledge base/detect-secrets.placeholder deleted file mode 100644 index 5597559..0000000 --- a/knowledge base/detect-secrets.placeholder +++ /dev/null @@ -1,3 +0,0 @@ -https://github.com/Yelp/detect-secrets - -alternatives: gitleaks, ripsecrets, trufflehog diff --git a/knowledge base/gitleaks.md b/knowledge base/gitleaks.md new file mode 100644 index 0000000..4cd4193 --- /dev/null +++ b/knowledge base/gitleaks.md @@ -0,0 +1,70 @@ +# Gitleaks + +Open-source secret scanner for git repositories, files, and directories. + +1. [TL;DR](#tldr) +1. [Further readings](#further-readings) + 1. [Sources](#sources) + +## TL;DR + +
+ Setup + +```sh +brew install 'gitleaks' +docker pull 'zricethezav/gitleaks:latest' +``` + +
+ + + + + +## Further readings + +- [Website] +- [Main repository] + +Alternatives: + +- [`detect-secrets`][detect-secrets] +- [`ripsecrets`][ripsecrets] +- [trufflehog] + +### Sources + + + + + +[detect-secrets]: detect-secrets.md +[ripsecrets]: ripsecrets.md +[trufflehog]: trufflehog.md + + + +[main repository]: https://github.com/gitleaks/gitleaks +[website]: https://gitleaks.io/ + + diff --git a/knowledge base/gitleaks.placeholder b/knowledge base/gitleaks.placeholder deleted file mode 100644 index 59b9e2c..0000000 --- a/knowledge base/gitleaks.placeholder +++ /dev/null @@ -1,4 +0,0 @@ -https://gitleaks.io/ -https://github.com/gitleaks/gitleaks - -alternatives: detect-secrets, ripsecrets, trufflehog diff --git a/knowledge base/ripsecrets.md b/knowledge base/ripsecrets.md new file mode 100644 index 0000000..cf3f167 --- /dev/null +++ b/knowledge base/ripsecrets.md @@ -0,0 +1,68 @@ +# `ripsecrets` + +Command-line tool to prevent committing secret keys into source code. + +1. [TL;DR](#tldr) +1. [Further readings](#further-readings) + 1. [Sources](#sources) + +## TL;DR + +
+ Setup + +```sh +brew install 'ripsecrets' +cargo install --git 'https://github.com/sirwart/ripsecrets' --branch 'main' +``` + +
+ +
+ Usage + +```sh +ripsecrets +ripsecrets 'path/to/file.1' 'file2' 'dir1' +``` + +
+ + + +## Further readings + +- [Main repository] + +Alternatives: + +- [`detect-secrets`][detect-secrets] +- [gitleaks] +- [trufflehog] + +### Sources + + + + + +[detect-secrets]: detect-secrets.md +[gitleaks]: gitleaks.md +[trufflehog]: trufflehog.md + + + +[main repository]: https://github.com/sirwart/ripsecrets + + diff --git a/knowledge base/ripsecrets.placeholder b/knowledge base/ripsecrets.placeholder deleted file mode 100644 index 36abbd3..0000000 --- a/knowledge base/ripsecrets.placeholder +++ /dev/null @@ -1,3 +0,0 @@ -https://github.com/sirwart/ripsecrets - -alternatives: detect-secrets, gitleaks, trufflehog diff --git a/knowledge base/trufflehog.md b/knowledge base/trufflehog.md new file mode 100644 index 0000000..6ec3773 --- /dev/null +++ b/knowledge base/trufflehog.md @@ -0,0 +1,70 @@ +# Trufflehog + +1. [TL;DR](#tldr) +1. [Further readings](#further-readings) + 1. [Sources](#sources) + +## TL;DR + +
+ Setup + +```sh +brew install 'trufflehog' +docker pull 'trufflesecurity/trufflehog:latest' +``` + +
+ +
+ Usage + +```sh +trufflehog git 'https://github.com/trufflesecurity/test_keys' --only-verified + +docker run --rm -it -v "$PWD:/pwd" 'trufflesecurity/trufflehog:latest' \ + github --repo 'https://github.com/trufflesecurity/test_keys' +``` + +
+ + + +## Further readings + +- [Website] +- [Main repository] + +Alternatives: + +- [`detect-secrets`][detect-secrets] +- [gitleaks] +- [`ripsecrets`][ripsecrets] + +### Sources + + + + + +[detect-secrets]: detect-secrets.md +[gitleaks]: gitleaks.md +[ripsecrets]: ripsecrets.md + + + +[main repository]: https://github.com/trufflesecurity/trufflehog +[website]: https://trufflesecurity.com/ + + diff --git a/knowledge base/trufflehog.placeholder b/knowledge base/trufflehog.placeholder deleted file mode 100644 index 1d07d33..0000000 --- a/knowledge base/trufflehog.placeholder +++ /dev/null @@ -1,5 +0,0 @@ -# Trufflehog - -https://github.com/trufflesecurity/trufflehog - -alternatives: detect-secrets, gitleaks, ripsecrets