search

karmada-io / karmada

Open, Multi-Cloud, Multi-Cluster Kubernetes Orchestration
https://karmada.io
Apache License 2.0
4.51k stars 892 forks source link

Enable OpenSSF Scorecard to enhance security practices across the project #5229

Open harshitasao opened 4 months ago

harshitasao commented 4 months ago

Hi, I'm Harshita. I’m working with CNCF and the Google Open Source Security Team for the GSoC 2024 term. We are collaborating to enhance security practices across various CNCF projects. The goal is to improve security for all CNCF projects by both using OpenSSF Scorecards and implementing its security improvements.

The Open Source Security Foundation (OpenSSF) Scorecard is a tool designed to evaluate the security posture of open-source projects. This has the Scorecard GitHub Action, which automates the process by running security checks on the GitHub repository. By integrating this Action into the repository's workflow, developers can continuously monitor the project’s security posture. The Scorecard checks cover various security best practices and provide scores for multiple categories. Some checks include Code Reviews, Branch Protection, Signed Releases, etc.

The workflow runs on every change in the main branch. It publishes the Scorecard checks' results to the project's security dashboard and includes suggestions on how to solve any issues. This Action has already been adopted by 1800+ projects, with prominent users like Tensorflow, Angular, sos.dev, deps.dev, and many CNCF projects.

Once the Scorecard GitHub Action is set up and running, the results can be displayed as a badge in the repository's README file. This badge serves as a quick indicator of the project's security posture, helping users and contributors evaluate the project's security practices quickly.

Why is this needed:

The OpenSSF Scorecard improves open-source project's security by providing automated, transparent assessments of their security practices. It will help you identify vulnerabilities, adhere to best practices, and continuously enhance your security posture, increasing user trust and reducing the risk of security exploits.

I'll be the one to create the PR to add the scorecard GitHub action, and I will also work with you to remediate the identified vulnerabilities. I'll go through each scorecard check to see where the score has dropped and how it can be improved.

Would you be interested in a PR which adds this Action?

/cc @joycebrum @diogoteles08 @pnacht @nate-double-u

RainbowMango commented 4 months ago

Would you be interested in a PR which adds this Action?

Karmada maintainer here. We would appreciate your help, thanks in advance.

Karmada added both CLOMonitor and openssf scorecard badges, and now had been actively working on CLOMonitor, the tasks are tracked by #5048. We can also have a similar issue for the scorecard to track all the tasks together.

By the way, I understand that with the scorecard GitHub action, we can get the scores quickly(since it responds to every change on the main branch), how often will the scorecard score be updated without an Action?

harshitasao commented 4 months ago

Hi, I am thinking of creating an umbrella issue for scorecard score improvement after the scorecard action PR is merged. If the action is not added in the project, the Scorecard team runs a weekly scan of public GitHub repositories in order to track the overall security health of the open source ecosystem.

RainbowMango commented 4 months ago

Sounds great to me. Thank you Harshita.