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

Bring CLOMonitor Score to 100% #3212

Closed
20 of 21 tasks
alinskens opened this issue Oct 14, 2022 · 6 comments · Fixed by #3236
Closed
20 of 21 tasks

Bring CLOMonitor Score to 100% #3212

alinskens opened this issue Oct 14, 2022 · 6 comments · Fixed by #3236
Labels
area/security Security related issues and pull requests

Comments

@alinskens
Copy link

alinskens commented Oct 14, 2022

This repo is signed up as part of the KubeCon Security Slam. I'm bringing to your attention the checklist from the official CLOMonitor page for Flux -- it refreshes every hour, so it should be up-to-date.

CLOMonitor report

Summary

Repository: flux2
URL: https://github.com/fluxcd/flux2
Checks sets: CODE
Score: 86

Checks passed per category

Category Score
Documentation 100%
License 100%
Best Practices 100%
Security 90%
Legal n/a

Checks

Documentation [100%]

License [100%]

  • Apache-2.0 (docs)
  • Approved license (docs)
  • License scanning (docs)

Best Practices [100%]

Security [90%]

For more information about the checks sets available and how each of the checks work, please see the CLOMonitor's documentation.

@stefanprodan
Copy link
Member

stefanprodan commented Oct 15, 2022

We do have Helm charts maintained by the community here https://artifacthub.io/packages/helm/fluxcd-community/flux2 but I can't figure out the badge URL for ArtifactHub. As for Dependency update tool, we have our own GitHub Action.

@stefanprodan
Copy link
Member

stefanprodan commented Oct 15, 2022

Token permissions (from OpenSSF Scorecard)
ID: token_permissions
This check determines whether the project’s automated workflows tokens are set to read-only by default.

@alinskens this requirement feels very wrong to me. How are we suppose to use Goreleaser and publish signed checksums, binaries, container images, SBOM, etc if the release workflow must be set to read-only? For reference here is our workflow: https://github.com/fluxcd/flux2/blob/main/.github/workflows/release.yaml

permissions:
  contents: write # needed to write releases
  id-token: write # needed for keyless signing
  packages: write # needed for ghcr access

@stefanprodan
Copy link
Member

stefanprodan commented Oct 15, 2022

@alinskens can you please remove the fluxcd/flux repo from this https://clomonitor.io/projects/cncf/flux-project? Flux v1 is no longer maintained and we'll archive that repo on 1st of November this year. cc @dholbach

@eddie-knight
Copy link
Contributor

How are we suppose to use Goreleaser and publish signed checksums, binaries, container images, SBOM, etc if the release workflow must be set to read-only?

This has been an ongoing discussion, and I've currently got an open PR to address the issue.

@stefanprodan
Copy link
Member

stefanprodan commented Oct 18, 2022

@eddie-knight @alinskens thanks for all the help. The only thing left is the "Token permissions", should we keep this issue opened till ossf/scorecard#2355 is fixed? From our side there is nothing left to do.

@eddie-knight
Copy link
Contributor

@stefanprodan We got that issue released on Scorecard yesterday and integrated into CLOMonitor this morning! 👏

The only thing left to do is take advantage of the changes by moving write permission allocations to the job level. I'll try to get a PR up this morning if I can spare a cycle for it.

@pjbgf pjbgf added the area/security Security related issues and pull requests label Oct 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/security Security related issues and pull requests
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants