Skip to content

Commit f792705

Browse files
feat: add documentation for the ossf scorecard report [LK-1615] (#2484)
* add documentation for the ossf scorecard report LK-1615 * add new screenshots
1 parent dd539d5 commit f792705

File tree

4 files changed

+29
-1
lines changed

4 files changed

+29
-1
lines changed
152 KB
Loading
128 KB
Loading
114 KB
Loading

docs/organizations/managing-security-and-risk.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -542,11 +542,39 @@ To access the dependencies page, access the [overview page](#dashboard) and clic
542542

543543
When viewing dependencies, you'll be presented with a list of the dependencies used by all repositories in your organization. For each dependency, you'll be able to see how many repositories are making use of it, how many different versions you are using across all repositories, and how many security findings were found due to the presence of that dependency.
544544

545+
You can sort the dependencies list using the sort dropdown to prioritize dependencies based on your security assessment needs:
546+
547+
- **Highest vulnerability** (default) - Dependencies with the most critical security findings appear first
548+
- **Lowest OSSF score** - Dependencies with the lowest [OSSF Scorecard](#ossf-scorecard) security scores appear first, helping you identify dependencies that may not follow security best practices
549+
545550
You're also able to click any dependency to find out more information about it.
546551

547552
![Security and risk management dependency page](images/security-risk-management-dependencies-single.png)
548553

549-
The dependency overview page offers a quick bird's-eye view of that particular dependency. You'll be able to see all different versions that are being used, including which repository is using them, the oldest and most recent versions you're leveraging, as well as the highest criticality of security issues and the license <a href="#license-scanning"><sup>6</sup></a> applied to any particular version of that dependency.
554+
The dependency overview page offers a quick bird's-eye view of that particular dependency. You'll be able to see all different versions that are being used, including which repository is using them, the oldest and most recent versions you're leveraging, as well as the highest criticality of security issues, the license <a href="#license-scanning"><sup>6</sup></a> applied to any particular version of that dependency, and the [OSSF Scorecard](#ossf-scorecard) security assessment.
555+
556+
### OSSF Scorecard {: id="ossf-scorecard"}
557+
558+
The **OSSF Scorecard** feature provides additional security insights for your dependencies by displaying security assessment data from the Open Source Security Foundation (OSSF) Scorecard project.
559+
560+
The OSSF Scorecard is an automated tool that evaluates open source repositories against a comprehensive set of security best practices. It performs various checks on a dependency's repository to assess whether the project follows security best practices and helps determine if the dependency is safe for consumption.
561+
562+
When available, OSSF Scorecard information appears on the dependency overview page, providing you with:
563+
564+
- **Overall security score** - A numerical score indicating the overall security posture of the dependency
565+
- **Individual check results** - Detailed results for specific security practices such as:
566+
- Code review practices
567+
- Dependency update policies
568+
- Security policy documentation
569+
- Vulnerability disclosure processes
570+
- Branch protection configurations
571+
- Binary artifact verification
572+
- Token permissions and usage
573+
574+
This information helps you make informed decisions about the security risks associated with your dependencies and identify which dependencies may require additional scrutiny or alternative options.
575+
576+
577+
![Security and risk management OSSF scorecard report](images/security-risk-management-ossf-scorecard.png)
550578

551579

552580
<sup><span id="semgrep">1</span></sup>: Semgrep supports additional security rules when signing up for [Semgrep Pro](https://semgrep.dev/pricing/).

0 commit comments

Comments
 (0)