[StepSecurity] Apply security best practices #10
Conversation
Signed-off-by: StepSecurity Bot <bot@stepsecurity.io>
There was a problem hiding this comment.
Pull Request Overview
Apply security best practices by hardening runners, limiting token permissions, pinning action dependencies, and adding security scans.
- Added
.pre-commit-config.yamlto enforce local hooks - Updated existing workflows to use least-privilege
permissions, pinned action versions, and hardened runners - Introduced new workflows for dependency review, CodeQL analysis, and Dependabot for GitHub Actions and npm
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| .pre-commit-config.yaml | Added and pinned security and quality hooks |
| .github/workflows/trivy-scan.yml | Limited GITHUB_TOKEN scope, hardened runner, pinned actions |
| .github/workflows/scorecard-analysis.yml | Hardened runner, pinned checkout action |
| .github/workflows/release.yml | Limited token scope, hardened runner, pinned actions |
| .github/workflows/dependency-review.yml | New dependency-review workflow, hardened runner, pinned actions |
| .github/workflows/codeql.yml | New CodeQL analysis workflow, hardened runner, pinned actions |
| .github/dependabot.yml | Extended Dependabot to GitHub Actions and additional npm directory |
Comments suppressed due to low confidence (2)
.github/workflows/trivy-scan.yml:8
- The job only grants
contents: read, but theupload-artifactstep needs write access to store artifacts. Please add the minimal permissions required (e.g.,actions: write) to allow artifact uploads.
permissions:
.github/workflows/codeql.yml:43
- [nitpick] The runner hardening and checkout steps are duplicated in multiple workflows. Consider extracting them into a reusable workflow or composite action to reduce duplication.
- name: Harden the runner (Audit all outbound calls)
|
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. |
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Summary
This pull request is created by StepSecurity at the request of @agustinfrancesa. Please merge the Pull Request to incorporate the requested changes. Please tag @agustinfrancesa 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.
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