Publish Security Insights, run Scorecard and enable Dependabot - #2318
Open
Akshats-git wants to merge 4 commits into
Open
Publish Security Insights, run Scorecard and enable Dependabot#2318Akshats-git wants to merge 4 commits into
Akshats-git wants to merge 4 commits into
Conversation
The CLOMonitor report for Flatcar fails the security_insights and dependencies_policy checks because the project publishes no Security Insights manifest. Both checks read the same file. CLOMonitor feeds the CNCF graduation review tracked in flatcar#1818. https://clomonitor.io/projects/cncf/flatcar Add a manifest following version 2.2.0 of the specification. The contents come from the documents already in this repository, from MAINTAINERS.md and from the CNCF project maintainers list. The self assessment entry points at flatcar#1820, which is still open, rather than claiming an assessment that does not exist yet. Validated against the specification's own schema: cue vet -c -d '#SecurityInsights' ./spec SECURITY-INSIGHTS.yml Signed-off-by: Akshat <akshatgupta099@gmail.com>
The actions used by the workflows here are pinned by commit SHA, so they stay on the revision they were added with until someone bumps them by hand. Nothing does that today. Enable Dependabot for the github-actions ecosystem, grouped and run weekly, matching the configuration already used in flatcar/nebraska. This also satisfies the dependency_update_tool check in CLOMonitor. Signed-off-by: Akshat <akshatgupta099@gmail.com>
Scorecard results are part of the security evidence the CNCF graduation review looks at, and CLOMonitor scores the badge separately. This repository publishes neither. Add the analysis workflow and the README badge. The workflow is the one already running in flatcar/nebraska, with the pinned action SHAs refreshed. Results are published to the Scorecard API and uploaded to the code scanning dashboard. The badge reads "invalid repo path" until the workflow first runs against the default branch, because no results are published for this repository yet. Signed-off-by: Akshat <akshatgupta099@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Publish a Security Insights manifest, run OpenSSF Scorecard and enable Dependabot
Our CLOMonitor report at https://clomonitor.io/projects/cncf/flatcar is part of the evidence the CNCF looks at for graduation (#1818). It currently fails four checks that this repository can fix on its own:
security_insights,dependencies_policy,dependency_update_toolandopenssf_scorecard_badge.This adds
SECURITY-INSIGHTS.ymlon spec v2.2.0, a Dependabot config for thegithub-actionsecosystem, the Scorecard analysis workflow, and a Scorecard badge in the README. The manifest fixes two checks at once, because CLOMonitor readsdependencies_policyfromrepository.documentation.dependency-management-policyin the same file. Everything in the manifest comes from documents already in this repo, fromMAINTAINERS.md, and from the CNCF project maintainers list. The self assessment entry points at #1820 rather than claiming an assessment we have not published. The workflow and the Dependabot config are the ones already running inflatcar/nebraska, with the pinned action SHAs refreshed.I reimplemented the CLOMonitor scoring from its source and confirmed it reproduces our current published numbers exactly (repo 75.00, project 80.17). On that basis this moves security from 63.64 to 86.36, best practices from 52.63 to 78.95, and the project global from 80.17 to 88.43.
Fixes #2317
How to use
Nothing to do on a running system. To validate the manifest against the specification's own schema:
After merge, the Scorecard workflow runs on the push to
mainand again daily at 01:30 UTC. CLOMonitor refreshes roughly once a day, so the four checks should flip on the project page within about 24 hours.Testing done
Validated the manifest against the spec schema, with the spec's own example as a control so a silent pass is ruled out:
Linted both workflows:
Checked every URL in the manifest. All 29 return 200, apart from three that point at files this PR adds and which resolve once it lands.
Simulated the four CLOMonitor checks against the branch, using the path order and regexes from
clomonitor-core/src/linter/checks:changelog/directory (user-facing change, bug fix, security fix, update)/bootand/usrsize, packages, list files for any missing binaries, kernel modules, config files, kernel modules, etc.Both boxes are left unchecked on purpose. This repository has no
changelog/directory and builds no image, so neither applies here.