Skip to content

Commit d6fc842

Browse files
[Update] README to incldue SBOM and Provenance information
1 parent f789e1b commit d6fc842

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,28 @@ Branch | Build Status
3939
Master | ![Build Status](https://github.com/STARIONGROUP/SysML2.NET/actions/workflows/CodeQuality.yml/badge.svg?branch=master)
4040
Development | ![Build Status](https://github.com/STARIONGROUP/SysML2.NET/actions/workflows/CodeQuality.yml/badge.svg?branch=development)
4141

42+
# Software Bill of Materials (SBOM) and Provenance
43+
44+
As part of our commitment to security, transparency, and traceability the docker images and nuget packaves Software Bill of Materials (SBOM), the docker containers also contain Provenance information. These are automatically generated during the build process, providing detailed insights into the components, their licenses, versions, and the integrity of the nugets and docker images. What is Included:
45+
46+
## SBOM (Software Bill of Materials):
47+
48+
- A comprehensive list of all open-source and third-party components included in the Docker images and nugets.
49+
- Tracks software dependencies, licenses, and versions.
50+
- Helps with vulnerability management by allowing users to quickly identify potential risks tied to specific components.
51+
52+
## Provenance:
53+
54+
- A record of the image's origin and build process, providing traceability and assurance regarding the integrity of the image.
55+
- This ensures that the image was built using the declared sources and under the specified conditions, helping verify its authenticity and consistency.
56+
57+
## Why SBOM and Provenance?
58+
59+
- Improved Transparency: Provides full visibility into the open-source and third-party components included in the image.
60+
- Security Assurance: Enables easier tracking of vulnerabilities associated with specific components, promoting proactive security measures.
61+
- Compliance: Ensures adherence to licensing requirements and simplifies audits of dependencies and build processes.
62+
- Image Integrity: Provenance guarantees that the image is built as expected, without unauthorized modifications.
63+
4264
# License
4365

4466
The SysML2.NET libraries and reference web-application are provided to the community under the Apache License 2.0. The solution contains files that contain information about the SysML2 metamodel which are distributed with the [GNU Lesser General Public License (LGPL) v3.0](https://opensource.org/licenses/LGPL-3.0).

0 commit comments

Comments
 (0)