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

[Proposal] Standardize Name for Scorecard Checks in OpenAPI Spec #380

Open
abhisek opened this issue Apr 25, 2023 · 0 comments
Open

[Proposal] Standardize Name for Scorecard Checks in OpenAPI Spec #380

abhisek opened this issue Apr 25, 2023 · 0 comments
Labels
api enhancement New feature or request

Comments

@abhisek
Copy link

abhisek commented Apr 25, 2023

Current State

OpenSSF scorecard website identifies checks by name as documented at:
https://securityscorecards.dev/#the-checks

The check names are treated as strings without any strong meaning
https://github.com/ossf/scorecard-webapp/blob/main/openapi.yaml#L202

Proposal

Standardize the check names in OpenAPI spec by defining an enum . This will help tools make policy decisions based on the check names.

To do this properly, I think OpenAPI spec should be treated as source of truth and even the scorecard scanner should generate the Go structs & types from the spec and reference that as check names instead of defining string constants.

Example:
https://github.com/ossf/scorecard/blob/main/checks/binary_artifact.go#L25

@naveensrinivasan naveensrinivasan added enhancement New feature or request api labels Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants