Add security best practices #107
Merged
Conversation
This file contains 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
Signed-off-by: StepSecurity Bot <[email protected]>
|
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. |
abrown
approved these changes
Oct 24, 2023
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: ["cpp", "python"] |
There was a problem hiding this comment.
Wish this also supported Rust but I don't think that is available yet.
There was a problem hiding this comment.
That's right, not available for Rust yet.
ekovanova
approved these changes
Oct 25, 2023
abrown
added a commit
to abrown/ittapi
that referenced
this pull request
Feb 6, 2024
PR intel#107 introduced dependabot to the repository to update GitHub Actions. This results in a weekly stream of PRs to incorporate every tiny patch update for every GitHub Action we use here. This results in a lot of churn and I do not have any sense that it improves the code quality in any way. Instead, it may in fact be the cause of the breakage in the release workflow, since that relies on `upload-artifact` which dependabot bumped from v3.1.3 to v4.0.0. What this change does is follow GitHub's [guidance] to only receive security updates. Since "dependabot security updates" are enabled, we don't need to follow each action update; setting `open-pull-requests-limit` to 0 mutes the dependabot PRs but we should still see any security alerts in the security tab. [guidance]: https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#overriding-the-default-behavior-with-a-configuration-file
abrown
added a commit
that referenced
this pull request
Feb 10, 2024
PR #107 introduced dependabot to the repository to update GitHub Actions. This results in a weekly stream of PRs to incorporate every tiny patch update for every GitHub Action we use here. This results in a lot of churn and I do not have any sense that it improves the code quality in any way. Instead, it may in fact be the cause of the breakage in the release workflow, since that relies on `upload-artifact` which dependabot bumped from v3.1.3 to v4.0.0. What this change does is follow GitHub's [guidance] to only receive security updates. Since "dependabot security updates" are enabled, we don't need to follow each action update; setting `open-pull-requests-limit` to 0 mutes the dependabot PRs but we should still see any security alerts in the security tab. [guidance]: https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#overriding-the-default-behavior-with-a-configuration-file
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.
Adds some changes for improving security. Motivation was to improve score as tracked by https://github.com/ossf/scorecard .
The tool at https://app.stepsecurity.io/securerepo is used for identifying the required changes, and the bot helped create the base commit, as recommended by Scorecard.
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 mutatble. This poses a security risk. GitHub's Security Hardening guide recommends pinning actions to full length commit.
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. (CodeQL is added in this PR)