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

HTML output format for scanning result #1274

Closed
3 tasks done
hogo6002 opened this issue Sep 25, 2024 · 2 comments
Closed
3 tasks done

HTML output format for scanning result #1274

hogo6002 opened this issue Sep 25, 2024 · 2 comments
Assignees
Labels
container-scanning-mvp blockers for container scanning MVP enhancement New feature or request good first issue Good for newcomers

Comments

@hogo6002
Copy link
Contributor

hogo6002 commented Sep 25, 2024

The current OSV-Scanner table and vertical display formats have some limitations when adding more data, especially for container scanning results. Adding an HTML output format may be ideal for container image scanning use cases.

TODO:

  • Initial PR
  • UI improvment
  • Setup a webserver or host the html at localhost:<default port> when users don't specify --output <path>
@hogo6002 hogo6002 added the enhancement New feature or request label Sep 25, 2024
@hogo6002 hogo6002 self-assigned this Sep 25, 2024
hogo6002 added a commit that referenced this issue Oct 9, 2024
Implement #1274
Add an HTML output format to display results more effectively,
particularly for container scanning.
This format retains all the information from the existing table output,
including called/uncalled vulnerability details.

New features:
* Provides a package summary page
* Groups vulnerabilities by source package and ecosystem.
Vulnerabilities from OS images are displayed last by default.
* Provides a total count of vulnerabilities (excluding uncalled
vulnerabilities by default).
* Surfaces container scanning metrics, such as layer commands.
* Shows fix version information.

![image](https://github.com/user-attachments/assets/dfe80bd4-243c-4f3e-8196-aef735b8b2ed)

![image](https://github.com/user-attachments/assets/620fc0b2-82a3-4fa0-bb62-557717aee1b1)

![image](https://github.com/user-attachments/assets/fbabe9f1-d054-4222-aba9-5d40acf93e1b)
@oliverchang oliverchang added the container-scanning-mvp blockers for container scanning MVP label Oct 9, 2024
@another-rex
Copy link
Collaborator

another-rex commented Jan 29, 2025

Adding a list of minor tasks/fixes for the HTML output here:

  • Support git scanning results, currently shows completely blank line
  • Lift tooltip z-index so it does not get hidden by the container that it is in.
  • Improve contrast/borders of the scroll-able accordion containers
  • Allow setting of the port number when using the --serve flag
  • Use the new logo in the report

@hogo6002
Copy link
Contributor Author

I will close this issue and track remaining ones in #1528

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
container-scanning-mvp blockers for container scanning MVP enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants