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

chore(docs): Update docs regarding trivy client/server for misconfiguration scanning #7177

Closed
simar7 opened this issue Jul 17, 2024 · 4 comments · Fixed by #7277
Closed

chore(docs): Update docs regarding trivy client/server for misconfiguration scanning #7177

simar7 opened this issue Jul 17, 2024 · 4 comments · Fixed by #7277
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. scan/misconfiguration Issues relating to misconfiguration scanning

Comments

@simar7
Copy link
Member

simar7 commented Jul 17, 2024

TODO:

  • Removing AWS from the table
  • Changing Config to unsupported in the table
  • Adding a new table for supported scanners

Misconfiguration scanning is performed on the client side. Otherwise, a client needs to send all the IaC files, which may include sensitive information, to the server.
Another benefit of the client/server mode is caching. In image scanning, the server stores the analysis result in the cache per layer, and the client can skip analyzing layers in subsequent scans. This is very useful for vulnerability scanning but not for misconfiguration scanning. In misconfiguration scanning, we need to cache the IaC file contents. In addition, filesystem scanning doesn't fit for cache.

For the above reasons, misconfiguration scanning (and secret scanning for the same reasons) doesn't support the client/server mode.

@simar7 @nikpivkin I think we should update the document.

  • Removing AWS from the table
  • Changing Config to unsupported in the table
  • Adding a new table for supported scanners

Originally posted by @knqyf263 in #7172 (reply in thread)

@simar7 simar7 added kind/documentation Categorizes issue or PR as related to documentation. scan/misconfiguration Issues relating to misconfiguration scanning labels Jul 17, 2024
@nikpivkin nikpivkin self-assigned this Jul 31, 2024
@nikpivkin
Copy link
Contributor

@knqyf263 I'm confused by the 3rd point. Are there restrictions for certain scanners in client/server mode?

@knqyf263
Copy link
Collaborator

knqyf263 commented Jul 31, 2024

The misconfiguration and secret scanners do not support client/server mode. More strictly, detection still occurs in client/server mode, but the scanning is done on the client side and therefore works in the same way as in standalone mode.

It may be clearer to mention which side the scan is performed on, as ‘not supported’ may sound like it doesn't work. The misconfiguration scans are performed on the client side, so the checks bundle also needs to be downloaded by the client. And this is not what many users want from client-server mode. They expect checks bundle to be downloaded and the scan is performed on the server side.

@nikpivkin
Copy link
Contributor

Thank you! Is it also worth adding a log that secrets and misconfiguration scanning will be done on the client side in client/server mode?

@knqyf263
Copy link
Collaborator

Yes, it helps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. scan/misconfiguration Issues relating to misconfiguration scanning
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants