ci: [StepSecurity] Apply security best practices #420
Conversation
Signed-off-by: StepSecurity Bot <bot@stepsecurity.io>
There was a problem hiding this comment.
Pull Request Overview
This PR applies security best practices to the GitHub Actions workflows and related configuration files as recommended by StepSecurity. The changes focus on hardening the CI/CD pipeline through dependency pinning, permission restrictions, and additional security tooling.
Key changes include:
- Pinning all GitHub Actions and Docker images to specific commit hashes instead of version tags
- Adding the Harden Runner security agent to all workflow jobs
- Implementing least-privilege permissions for GitHub tokens
- Adding new security workflows for dependency review and CodeQL static analysis
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| Dockerfile | Pin Python base images to specific SHA256 digests |
| .pre-commit-config.yaml | Add gitleaks hook for secret detection |
| .github/workflows/scorecard.yml | Add Harden Runner and pin actions to commit hashes |
| .github/workflows/publish_to_pypi.yml | Add Harden Runner and pin actions to commit hashes |
| .github/workflows/pr-title-check.yml | Add Harden Runner and pin actions to commit hashes |
| .github/workflows/docker_image.yml | Add permissions, Harden Runner, and pin actions to commit hashes |
| .github/workflows/dependency-review.yml | New workflow for dependency vulnerability scanning |
| .github/workflows/codeql.yml | New workflow for static code analysis |
| .github/workflows/ci.yml | Add Harden Runner and pin actions to commit hashes |
| .github/dependabot.yml | Add Docker dependency updates |
filipchristiansen
changed the title
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
There was a problem hiding this comment.
LGTM, but I didn't know there were plans to add so many tools for security checks.
I'll let @NicolasIRAGNE have a look too, I think for this PR we need a consensus from all reviewers.
|
@ix-56h We were already running this. the |
Summary
This pull request is created by StepSecurity at the request of @filipchristiansen. Please merge the Pull Request to incorporate the requested changes. Please tag @filipchristiansen on your message if you have any questions related to the PR.
Security Fixes
Least Privileged GitHub Actions Token Permissions
The GITHUB_TOKEN is an automatically generated secret to make authenticated calls to the GitHub API. GitHub recommends setting minimum token permissions for the GITHUB_TOKEN.
Pinned Dependencies
GitHub Action tags and Docker tags are mutable. This poses a security risk. GitHub's Security Hardening guide recommends pinning actions to full length commit.
Harden Runner
Harden-Runner is an open-source security agent for the GitHub-hosted runner to prevent software supply chain attacks. It prevents exfiltration of credentials, detects tampering of source code during build, and enables running jobs without
sudoaccess. See how popular open-source projects use Harden-Runner here.Harden runner usage
You can find link to view insights and policy recommendation in the build log
Please refer to documentation to find more details.
Keeping your actions up to date with Dependabot
With Dependabot version updates, when Dependabot identifies an outdated dependency, it raises a pull request to update the manifest to the latest version of the dependency. This is recommended by GitHub as well as The Open Source Security Foundation (OpenSSF).
Detect Vulnerabilities with SAST Workflow
Static Code Analysis (also known as Source Code Analysis) is usually performed as part of a Code Review (also known as clear-box testing) and is carried out at the Implementation phase of a Security Development Lifecycle (SDL). Static Code Analysis commonly refers to the running of Static Code Analysis tools that attempt to highlight possible vulnerabilities within ‘static’ (non-running) source code by using techniques such as Taint Analysis and Data Flow Analysis.
Secure Dockerfiles
Pin image tags to digests in Dockerfiles. With the Docker v2 API release, it became possible to use digests in place of tags when pulling images or to use them in FROM lines in Dockerfiles.
Add Dependency Review Workflow
The Dependency Review Workflow enforces dependency reviews on your pull requests. The action scans for vulnerable versions of dependencies introduced by package version changes in pull requests, and warns you about the associated security vulnerabilities. This gives you better visibility of what's changing in a pull request, and helps prevent vulnerabilities being added to your repository.
Maintain Code Quality with Pre-Commit
Pre-commit is a framework for managing and maintaining multi-language pre-commit hooks. Hooks can be any scripts, code, or binaries that run at any stage of the git workflow. Pre-commit hooks are useful for enforcing code quality, code formatting, and detecting security vulnerabilities.
Feedback
For bug reports, feature requests, and general feedback; please email support@stepsecurity.io. To create such PRs, please visit https://app.stepsecurity.io/securerepo.
Signed-off-by: StepSecurity Bot bot@stepsecurity.io