diff --git a/examples/kics.config b/examples/kics.config new file mode 100644 index 0000000..34a80e2 --- /dev/null +++ b/examples/kics.config @@ -0,0 +1,6 @@ +--- +exclude-paths: + # The container starts in '/app/bin', these paths are relative to there. + # See the command in the lefthook configuration. + - repository/container-images/image-builder +exclude-severities: info,low diff --git a/knowledge base/kics.md b/knowledge base/kics.md index 1fda773..9f9fc88 100644 --- a/knowledge base/kics.md +++ b/knowledge base/kics.md @@ -6,10 +6,19 @@ ## TL;DR
- Installation and configuration + Setup ```sh docker pull 'checkmarx/kics' + +cat < kics.config +--- +exclude-paths: + # The container starts in '/app/bin', these paths are relative to there. + # See the command in the lefthook configuration. + - repository/container-images/image-builder +exclude-severities: info,low +EOF ```
@@ -18,8 +27,9 @@ docker pull 'checkmarx/kics' Usage ```sh -docker run -t -v "${PWD}:/path" 'checkmarx/kics' scan -p '/path' -docker run -t -v "${PWD}:/path" 'checkmarx/kics' scan -p '/path' -o '/path/' +docker run -t -v "${PWD}:/workdir" 'checkmarx/kics' scan -p '/workdir' +docker run -t -v "${PWD}:/workdir" 'checkmarx/kics' \ + scan -p '/workdir' -o '/workdir/output' --report-formats "glsast,html,pdf" --output-name kics-result ``` @@ -33,6 +43,7 @@ docker run -t -v "${PWD}:/path" 'checkmarx/kics' scan -p '/path' -o '/path/' ## Further readings - [Website] +- [Codebase] -[website]: https://docs.kics.io/latest/ +[Codebase]: https://github.com/Checkmarx/kics/ +[Website]: https://docs.kics.io/latest/