Skip to content

Commit 0046d69

Browse files
committed
[GR-45299] Add documentation for using the SBOM Github integration for vulnerability tracking
PullRequest: graal/19508
2 parents 5b7b717 + 762d5af commit 0046d69

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/security/SBOM.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,20 @@ It outputs the SBOM in the following format:
7171

7272
## Vulnerability Scanning
7373

74-
To scan for any vulnerable libraries, submit the SBOM to a vulnerability scanner.
75-
For example, the popular [Anchore software supply chain management platform](https://anchore.com/) makes the `grype` scanner freely available.
74+
To scan for vulnerable libraries, use either the [GraalVM GitHub Action](https://github.com/marketplace/actions/github-action-for-graalvm) for automated scanning, or submit the SBOM to a vulnerability scanner directly.
75+
76+
### GitHub Integration
77+
78+
When using the [GraalVM GitHub Action](https://github.com/marketplace/actions/github-action-for-graalvm), the SBOM can be automatically generated and submitted to GitHub's dependency submission API for continuous scanning.
79+
This enables:
80+
- Vulnerability tracking with GitHub's Dependabot.
81+
- Dependency tracking with GitHub's Dependency Graph.
82+
83+
If you use GitHub, this integration offers you the simplest setup and powerful security tooling.
84+
85+
### Command-Line Scanning
86+
87+
The popular [Anchore software supply chain management platform](https://anchore.com/) makes the `grype` scanner available for free.
7688
You can check whether the libraries given in your SBOMs have known vulnerabilities documented in Anchore's database.
7789
For this purpose, the output of the tool can be fed directly to the `grype` scanner to check for vulnerable libraries, using the command `$JAVA_HOME/bin/native-image-inspect --sbom <path_to_binary> | grype` which produces the following output:
7890
```shell
@@ -91,6 +103,8 @@ This dependency information is derived from Native Image's static analysis call
91103
Analyzing the dependency graph can help you understand why specific components are included in your application.
92104
For example, discovering an unexpected component in the SBOM allows for tracing its inclusion through the dependency graph to identify which parts of the application are using it.
93105

106+
With the GraalVM GitHub Action, you get access to GitHub's Dependency Graph feature.
107+
94108
## Enhanced SBOMs with Maven Plugin for Native Image
95109

96110
To generate more accurate SBOMs with richer component metadata, consider using the [Maven plugin for GraalVM Native Image](https://graalvm.github.io/native-build-tools/latest/maven-plugin.html).

0 commit comments

Comments
 (0)