Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(scan): do not trigger false alerts on ExternalSecrets file #6812

Open
gusfcarvalho opened this issue Nov 17, 2023 · 2 comments
Open

feat(scan): do not trigger false alerts on ExternalSecrets file #6812

gusfcarvalho opened this issue Nov 17, 2023 · 2 comments
Labels
community Community contribution feature request Community: new feature request kubernetes Kubernetes query query New query feature

Comments

@gusfcarvalho
Copy link

Is your feature request related to a problem? Please describe.
external-secrets is a project used to synchronize sensitive information from secrets providers and kubernetes clusters without needing the end user to have any credentials whatsoever. It is also compatible with IaC by leveraging any GitOps mechanism to deploy the manifests onto the target cluster.

currently, any ExternalSecret manifest generates a false alert, as a reference to kubernetes Secret key (named secretKey) is identified as a sensitive information (while it is really a metadata address for the Key, not for the Value).

Describe the solution you'd like
ExternalSecrets manifests should be avoided by adding a specific avoid rule in https://github.com/Checkmarx/kics/blob/master/assets/queries/common/passwords_and_secrets/regex_rules.json#L30C1-L47

Describe alternatives you've considered
Deal with the pain of false alerts for a tool that actually helps reducing sensitive information in git repos in the first place :)

Additional context
This discussion here triggered me to open up this issue.

@gusfcarvalho gusfcarvalho added community Community contribution feature request Community: new feature request labels Nov 17, 2023
@github-actions github-actions bot added query New query feature kubernetes Kubernetes query labels Nov 17, 2023
@gusfcarvalho gusfcarvalho changed the title feat(scan): Do not trigger false alerts on ExternalSecrets file feat(scan): do not trigger false alerts on ExternalSecrets file Nov 17, 2023
@gusfcarvalho
Copy link
Author

My original thoughts was on adding a regexp that would avoid files that starts with kind: ExternalSecrets as a way to prevent those secretKeys from being read - but this implementation might be naive (or even not applicable, I'm not sure how the scanning logic works when parsing a given file).

@pereiramarco011
Copy link
Collaborator

Hello @gusfcarvalho,
Thank you for opening this issue to us 😄

Can you kindly provide a sample where that secret is falsely detected so we can use it for debugging and testing purposes?

Best Regards,
KICS Team

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Community contribution feature request Community: new feature request kubernetes Kubernetes query query New query feature
Projects
None yet
Development

No branches or pull requests

2 participants