From 3b8d01f5645e19e223208d650ed94bc6c0afc5ca Mon Sep 17 00:00:00 2001 From: Jeroen Willemsen Date: Sat, 2 Apr 2022 07:35:43 +0200 Subject: [PATCH 1/3] Create readme and project instructions --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index c764c25cc..c64ae20d8 100644 --- a/README.md +++ b/README.md @@ -193,6 +193,12 @@ You can help us by the following methods: - Share this app with others - Of course, we can always use your help [to get more flavors](https://github.com/commjoen/wrongsecrets/issues/37) of "wrongly" configured secrets in to spread awareness! We would love to get some help with other cloudproiders, like Alibabaor Tencent cloud for instance. Do you miss something else than a cloud provider as an example? File an issue or create a PR! See [our guide on contributing for more details](CONTRIBUTING.md). Contributors will be listed in releases, in the "Special thanks & Contributors"-section, and the web-app. +## Use OWASP WrongSecrets as a secret detection benchmark + +As there are tons of secret detection tools coming up for both Docker and Git, we are creating a Benchmark testbed for it. +Want to know if your tool detects everything? We will keep track of the embedded secrets in [this issue](https://github.com/commjoen/wrongsecrets/issues/201) and have a [branch](https://github.com/commjoen/wrongsecrets/tree/experiment-bed) in which we put additional secrets for your tool to detect. +The branch will contain a Docker container generation script eventually with which you can test your container secret scanning. + ## Notes on development If you want to test against vault without K8s: start vault locally with From 23d54e555f4f562733a43e3591f88505a4f4169b Mon Sep 17 00:00:00 2001 From: Jeroen Willemsen Date: Sat, 2 Apr 2022 07:38:15 +0200 Subject: [PATCH 2/3] Updated welcome.html to include the right link --- src/main/resources/templates/welcome.html | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/main/resources/templates/welcome.html b/src/main/resources/templates/welcome.html index b698ab90a..28f6da6a3 100644 --- a/src/main/resources/templates/welcome.html +++ b/src/main/resources/templates/welcome.html @@ -130,6 +130,11 @@ +
+
+ Want to see if your tool of choice detects all the secrets available in this project? Checkout the instructions at the README.md. +
+
From ddece698f76742ab8842025bcd955bad779cc9d8 Mon Sep 17 00:00:00 2001 From: Jeroen Willemsen Date: Mon, 4 Apr 2022 12:00:17 +0200 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Ben de Haan <53901866+bendehaan@users.noreply.github.com> --- README.md | 4 ++-- src/main/resources/templates/welcome.html | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c64ae20d8..7637092cb 100644 --- a/README.md +++ b/README.md @@ -195,9 +195,9 @@ You can help us by the following methods: ## Use OWASP WrongSecrets as a secret detection benchmark -As there are tons of secret detection tools coming up for both Docker and Git, we are creating a Benchmark testbed for it. +As tons of secret detection tools are coming up for both Docker and Git, we are creating a Benchmark testbed for it. Want to know if your tool detects everything? We will keep track of the embedded secrets in [this issue](https://github.com/commjoen/wrongsecrets/issues/201) and have a [branch](https://github.com/commjoen/wrongsecrets/tree/experiment-bed) in which we put additional secrets for your tool to detect. -The branch will contain a Docker container generation script eventually with which you can test your container secret scanning. +The branch will contain a Docker container generation script using which you can eventually test your container secret scanning. ## Notes on development diff --git a/src/main/resources/templates/welcome.html b/src/main/resources/templates/welcome.html index 28f6da6a3..147e1689c 100644 --- a/src/main/resources/templates/welcome.html +++ b/src/main/resources/templates/welcome.html @@ -132,7 +132,7 @@
- Want to see if your tool of choice detects all the secrets available in this project? Checkout the instructions at the README.md. + Want to see if your tool of choice detects all the secrets available in this project? Check the instructions in the README.