osv-schema icon indicating copy to clipboard operation
osv-schema copied to clipboard

What kind of credit in credits field?

Open kurtseifried opened this issue 3 years ago • 8 comments

credits fields { "credits": [ { "name": string, "contact": [ string ], } ] } The credits field is a JSON array providing a way to give credit for the discovery, confirmation, patch, or other events in the life cycle of a vulnerability.

is there some reason we don't have an optional text description or ENUM for what kind of credit(s)?

kurtseifried avatar Sep 08 '22 04:09 kurtseifried

Chiming in here from the GitHub side, we'd like to update our own credits model to have types of credits in alignment with the MITRE spec.

Would be great if we could consider a "type" field in credits similar to the OSV references field.

KateCatlin avatar Jan 03 '23 19:01 KateCatlin

Thanks for chiming in! Given the additional interest, let's resurrect this thread.

A "type" enum field that allows an easy 1:1 mapping to the MITRE spec could certainly work here.

oliverchang avatar Jan 05 '23 02:01 oliverchang

How should package-maintainers get credited? remediation developer ?

captn3m0 avatar Jan 05 '23 07:01 captn3m0

@captn3m0 here's how the meanings are described as per MITRE:

finder: identifies the vulnerability reporter: notifies the vendor of the vulnerability to a CNA. analyst: validates the vulnerability to ensure accuracy or severity. coordinator: facilitates the coordinated response process. remediation developer: prepares a code change or other remediation plans. remediation reviewer: reviews vulnerability remediation plans or code changes for effectiveness and completeness. remediation verifier: tests and verifies the vulnerability or its remediation. tool: names of tools used in vulnerability discovery or identification. sponsor: supports the vulnerability identification or remediation activities.

So I guess it would depend on the maintainer's role in the solution... Could be analyst, coordinator, remediation developer, or really any.

KateCatlin avatar Jan 05 '23 22:01 KateCatlin

Would someone like to suggest a PR to add this? It seems like the type should enable an easy 1:1 mapping to MITRE for interoperability.

oliverchang avatar Jan 11 '23 05:01 oliverchang

@oliverchang thank you! Our team will submit one.

KateCatlin avatar Jan 11 '23 20:01 KateCatlin

@oliverchang created a PR here: https://github.com/ossf/osv-schema/pull/110

/cc @KateCatlin @katblag

hawaiigal avatar Jan 27 '23 21:01 hawaiigal

@oliverchang Looks like this has been merged/deployed. Time to close the issue? :tada:

joshbuker avatar Mar 29 '23 21:03 joshbuker