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

What kind of credit in credits field? #85

Open
kurtseifried opened this issue Sep 8, 2022 · 8 comments
Open

What kind of credit in credits field? #85

kurtseifried opened this issue Sep 8, 2022 · 8 comments

Comments

@kurtseifried
Copy link
Contributor

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)?

@KateCatlin
Copy link

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.

@oliverchang
Copy link
Contributor

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.

@captn3m0
Copy link
Contributor

captn3m0 commented Jan 5, 2023

How should package-maintainers get credited? remediation developer ?

@KateCatlin
Copy link

@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.

@oliverchang
Copy link
Contributor

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.

@KateCatlin
Copy link

@oliverchang thank you! Our team will submit one.

@hawaiigal
Copy link
Contributor

@oliverchang created a PR here: #110

/cc @KateCatlin @katblag

oliverchang pushed a commit that referenced this issue Feb 8, 2023
As discussed in #85, we'd like
to propose these changes to the OSV schema to add credit types/roles
that correspond to those defined by the [MITRE CVE
schema](https://github.com/CVEProject/cve-schema/blob/master/schema/v5.0/CVE_JSON_5.0_schema.json).

Would appreciate any feedback or proposed changes!

---------

Signed-off-by: Kailani Chu <hawaiigal@github.com>
@joshbuker
Copy link
Contributor

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

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

No branches or pull requests

6 participants