Skip to content

doc: adr for handling vulnerability scores and severities #1604

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

Merged
merged 1 commit into from
May 20, 2025

Conversation

dejanb
Copy link
Contributor

@dejanb dejanb commented May 6, 2025

This PR contains ADR for handling vulnerability scores and severities. It covers current state of things in specs that we are using and proposing API changes to properly reflect data that users are interested in.

@dejanb dejanb force-pushed the vulnerability_scores branch 3 times, most recently from 37ac972 to 2f48893 Compare May 6, 2025 11:56
@ctron
Copy link
Contributor

ctron commented May 6, 2025

I absolutely like the detail of this ADR. The context and history! Awesome!

I am wondering why the data model doesn't have a "type" field (v2, v3, v4?) Did I overlook it? Isn't it necessary?

@dejanb
Copy link
Contributor Author

dejanb commented May 6, 2025

I absolutely like the detail of this ADR. The context and history! Awesome!

I am wondering why the data model doesn't have a "type" field (v2, v3, v4?) Did I overlook it? Isn't it necessary?

We definitely need it. I added it (version) in the CVSSVector object just to make it clear. Note that this is not the exact data model proposal, but just proposed pseudo-API changes.

@dejanb dejanb force-pushed the vulnerability_scores branch from 120366b to a2cb014 Compare May 6, 2025 13:32
@PhilipCattanach
Copy link

PhilipCattanach commented May 20, 2025

@dejanb - what's not clear to me is what is going to change?

I think the Vulnerability score is straight forward as it is a 1:1

The Advisory can have a 1:M to Vulnerability so are we still intending on presenting the Aggregate score on the Advisory List and Detail Screen?

Or should each Advisory List row be expandable to show the individual CVEs and their scores from that Advisory (essentially what the Advisory Vulnerability list scree does currently)?

A couple of concrete examples for the AS IS and the TO BE illustrating what the changes will provide would be super helpful.

@dejanb
Copy link
Contributor Author

dejanb commented May 20, 2025

@PhilipCattanach I was thinking to keep the ADR focused on describing how things will be in the future, as this transition is just a temporary.

I created a project to detail of the work we are doing to make it work

CVSS Scores (view)

As for the concrete topics.

Vulnerabilities will only get scores from CVE files.
CSAF advisories should have "aggregate severity" displayed, but it doesn't make sense for other types. All advisories will have all scores in them, so we should probably show them all (without making any assumptions).

Note also, that this is nothing to with UI, just how we store and return data using API. UI is another discussion completely.

Copy link
Collaborator

@mrizzi mrizzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dejanb thanks a lot: the ADR is precise and clear and it reads very well.

@dejanb dejanb added this pull request to the merge queue May 20, 2025
Merged via the queue into main with commit a3d76c2 May 20, 2025
2 checks passed
@dejanb dejanb deleted the vulnerability_scores branch May 20, 2025 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants