Skip to content

Commit b11042c

Browse files
theresa-mnaveensrinivasan
authored andcommitted
Generate docs
Signed-off-by: Theresa Mammarella <[email protected]>
1 parent ff37bea commit b11042c

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/checks.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -292,9 +292,12 @@ The highest score is awarded when all workflows avoid the dangerous code pattern
292292
Risk: `High` (possibly vulnerable to attacks on known flaws)
293293

294294
This check tries to determine if the project uses a dependency update tool,
295-
specifically [dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates) or
296-
[renovatebot](https://docs.renovatebot.com/configuration-options/). Out-of-date
297-
dependencies make a project vulnerable to known flaws and prone to attacks.
295+
specifically one of:
296+
- [dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)
297+
- [renovatebot](https://docs.renovatebot.com/configuration-options/)
298+
- [Sonatype Lift](https://help.sonatype.com/lift/getting-started)
299+
- [PyUp](https://docs.pyup.io/docs) (Python)
300+
Out-of-date dependencies make a project vulnerable to known flaws and prone to attacks.
298301
These tools automate the process of updating dependencies by scanning for
299302
outdated or insecure requirements, and opening a pull request to update them if
300303
found.
@@ -310,7 +313,7 @@ low score is therefore not a definitive indication that the project is at risk.
310313

311314

312315
**Remediation steps**
313-
- Signup for automatic dependency updates with [dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates) or [renovatebot](https://docs.renovatebot.com/configuration-options/) and place the config file in the locations that are recommended by these tools. Due to https://github.com/dependabot/dependabot-core/issues/2804 Dependabot can be enabled for forks where security updates have ever been turned on so projects maintaining stable forks should evaluate whether this behavior is satisfactory before turning it on.
316+
- Signup for automatic dependency updates with one of the previously listed dependency update tools and place the config file in the locations that are recommended by these tools. Due to https://github.com/dependabot/dependabot-core/issues/2804 Dependabot can be enabled for forks where security updates have ever been turned on so projects maintaining stable forks should evaluate whether this behavior is satisfactory before turning it on.
314317
- Unlike dependabot, renovatebot has support to migrate dockerfiles' dependencies from version pinning to hash pinning via the [pinDigests setting](https://docs.renovatebot.com/configuration-options/#pindigests) without aditional manual effort.
315318

316319
## Fuzzing
@@ -478,9 +481,7 @@ dependencies using the [GitHub dependency graph](https://docs.github.com/en/code
478481
- If your project is producing an application and the package manager supports lock files (e.g. `package-lock.json` for npm), make sure to check these in the source code as well. These files maintain signatures for the entire dependency tree and saves from future exploitation in case the package is compromised.
479482
- For Dockerfiles used in building and releasing your project, pin dependencies by hash. See [Dockerfile](https://github.com/ossf/scorecard/blob/main/cron/internal/worker/Dockerfile) for example. If you are using a manifest list to support builds across multiple architectures, you can pin to the manifest list hash instead of a single image hash. You can use a tool like [crane](https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md) to obtain the hash of the manifest list like in this [example](https://github.com/ossf/scorecard/issues/1773#issuecomment-1076699039).
480483
- For GitHub workflows used in building and releasing your project, pin dependencies by hash. See [main.yaml](https://github.com/ossf/scorecard/blob/f55b86d6627cc3717e3a0395e03305e81b9a09be/.github/workflows/main.yml#L27) for example. To determine the permissions needed for your workflows, you may use [StepSecurity's online tool](https://app.stepsecurity.io/) by ticking the "Pin actions to a full length commit SHA". You may also tick the "Restrict permissions for GITHUB_TOKEN" to fix issues found by the Token-Permissions check.
481-
- To help update your dependencies after pinning them, use tools such as
482-
Github's [dependabot](https://github.blog/2020-06-01-keep-all-your-packages-up-to-date-with-dependabot/)
483-
or [renovate bot](https://github.com/renovatebot/renovate).
484+
- To help update your dependencies after pinning them, use tools such as those listed for the dependency update tool check.
484485

485486
## SAST
486487

0 commit comments

Comments
 (0)