ORC-1342: Publish SBOM artifacts #1353
Closed
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
|
cc @omalley , @williamhyun , @wgtmac , @guiyanakuang, @stiga-huang , @pavibhai |
|
Just curious: is it relevant to BOM of maven? |
|
No, it's not. While Maven BOM pom is designed like the following, this PR is simply providing additional manifest.
|
|
Here is the context. Let me add this link to the PR description too. |
wgtmac
approved these changes
Jan 5, 2023
guiyanakuang
approved these changes
Jan 5, 2023
|
Thank you, @wgtmac and @guiyanakuang . |
dongjoon-hyun
added a commit
that referenced
this pull request
Jan 5, 2023
### What changes were proposed in this pull request? This PR aims to publish `SBOM` artifacts. ### Why are the changes needed? Here is an article to give some context. - https://www.activestate.com/blog/why-the-us-government-is-mandating-software-bill-of-materials-sbom/ Software Bill of Materials (SBOM) are additional artifacts containing the aggregate of all direct and transitive dependencies of a project. The US Government (based on NIST recommendations) currently accepts only the three most popular SBOM standards as valid, namely: [CycloneDX](https://cyclonedx.org/), [Software Identification (SWID) tag](https://csrc.nist.gov/projects/Software-Identification-SWID), [Software Package Data Exchange® (SPDX)](https://spdx.dev/). This PR uses [CycloneDX maven plugin](https://github.com/CycloneDX/cyclonedx-maven-plugin), a lightweight software bill of materials (SBOM) standard designed for use in application security contexts and supply chain component analysis. For example, `orc-core-1.9.0-SNAPSHOT-cyclonedx.json` and `orc-core-1.9.0-SNAPSHOT-cyclonedx.xml` are attached like the following. ``` $ tree ~/.m2/repository/org/apache/orc/orc-core /Users/dongjoon/.m2/repository/org/apache/orc/orc-core ├── 1.9.0-SNAPSHOT │ ├── _remote.repositories │ ├── maven-metadata-apache.snapshots.xml │ ├── maven-metadata-apache.snapshots.xml.sha1 │ ├── maven-metadata-local.xml │ ├── orc-core-1.9.0-20230103.231254-184.jar │ ├── orc-core-1.9.0-20230103.231254-184.jar.sha1 │ ├── orc-core-1.9.0-20230103.231254-184.pom │ ├── orc-core-1.9.0-20230103.231254-184.pom.sha1 │ ├── orc-core-1.9.0-SNAPSHOT-cyclonedx.json │ ├── orc-core-1.9.0-SNAPSHOT-cyclonedx.xml │ ├── orc-core-1.9.0-SNAPSHOT-nohive.jar │ ├── orc-core-1.9.0-SNAPSHOT-shaded-protobuf.jar │ ├── orc-core-1.9.0-SNAPSHOT-sources.jar │ ├── orc-core-1.9.0-SNAPSHOT-test-sources.jar │ ├── orc-core-1.9.0-SNAPSHOT-tests.jar │ ├── orc-core-1.9.0-SNAPSHOT.jar │ ├── orc-core-1.9.0-SNAPSHOT.pom │ └── resolver-status.properties └── maven-metadata-local.xml ``` ### How was this patch tested? After installing locally and check the `*cyclonedx.*` files. ``` $ mvn install -DskipTests ``` Closes #1353 from dongjoon-hyun/ORC-1342. Authored-by: Dongjoon Hyun <dongjoon@apache.org> Signed-off-by: Dongjoon Hyun <dongjoon@apache.org> (cherry picked from commit ef775fb) Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
dongjoon-hyun
added a commit
that referenced
this pull request
Jan 5, 2023
### What changes were proposed in this pull request? This PR aims to publish `SBOM` artifacts. ### Why are the changes needed? Here is an article to give some context. - https://www.activestate.com/blog/why-the-us-government-is-mandating-software-bill-of-materials-sbom/ Software Bill of Materials (SBOM) are additional artifacts containing the aggregate of all direct and transitive dependencies of a project. The US Government (based on NIST recommendations) currently accepts only the three most popular SBOM standards as valid, namely: [CycloneDX](https://cyclonedx.org/), [Software Identification (SWID) tag](https://csrc.nist.gov/projects/Software-Identification-SWID), [Software Package Data Exchange® (SPDX)](https://spdx.dev/). This PR uses [CycloneDX maven plugin](https://github.com/CycloneDX/cyclonedx-maven-plugin), a lightweight software bill of materials (SBOM) standard designed for use in application security contexts and supply chain component analysis. For example, `orc-core-1.9.0-SNAPSHOT-cyclonedx.json` and `orc-core-1.9.0-SNAPSHOT-cyclonedx.xml` are attached like the following. ``` $ tree ~/.m2/repository/org/apache/orc/orc-core /Users/dongjoon/.m2/repository/org/apache/orc/orc-core ├── 1.9.0-SNAPSHOT │ ├── _remote.repositories │ ├── maven-metadata-apache.snapshots.xml │ ├── maven-metadata-apache.snapshots.xml.sha1 │ ├── maven-metadata-local.xml │ ├── orc-core-1.9.0-20230103.231254-184.jar │ ├── orc-core-1.9.0-20230103.231254-184.jar.sha1 │ ├── orc-core-1.9.0-20230103.231254-184.pom │ ├── orc-core-1.9.0-20230103.231254-184.pom.sha1 │ ├── orc-core-1.9.0-SNAPSHOT-cyclonedx.json │ ├── orc-core-1.9.0-SNAPSHOT-cyclonedx.xml │ ├── orc-core-1.9.0-SNAPSHOT-nohive.jar │ ├── orc-core-1.9.0-SNAPSHOT-shaded-protobuf.jar │ ├── orc-core-1.9.0-SNAPSHOT-sources.jar │ ├── orc-core-1.9.0-SNAPSHOT-test-sources.jar │ ├── orc-core-1.9.0-SNAPSHOT-tests.jar │ ├── orc-core-1.9.0-SNAPSHOT.jar │ ├── orc-core-1.9.0-SNAPSHOT.pom │ └── resolver-status.properties └── maven-metadata-local.xml ``` ### How was this patch tested? After installing locally and check the `*cyclonedx.*` files. ``` $ mvn install -DskipTests ``` Closes #1353 from dongjoon-hyun/ORC-1342. Authored-by: Dongjoon Hyun <dongjoon@apache.org> Signed-off-by: Dongjoon Hyun <dongjoon@apache.org> (cherry picked from commit ef775fb) Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
This was referenced Jan 5, 2023
williamhyun
reviewed
Jan 7, 2023
cxzl25
pushed a commit
to cxzl25/orc
that referenced
this pull request
Jan 11, 2024
### What changes were proposed in this pull request? This PR aims to publish `SBOM` artifacts. ### Why are the changes needed? Here is an article to give some context. - https://www.activestate.com/blog/why-the-us-government-is-mandating-software-bill-of-materials-sbom/ Software Bill of Materials (SBOM) are additional artifacts containing the aggregate of all direct and transitive dependencies of a project. The US Government (based on NIST recommendations) currently accepts only the three most popular SBOM standards as valid, namely: [CycloneDX](https://cyclonedx.org/), [Software Identification (SWID) tag](https://csrc.nist.gov/projects/Software-Identification-SWID), [Software Package Data Exchange® (SPDX)](https://spdx.dev/). This PR uses [CycloneDX maven plugin](https://github.com/CycloneDX/cyclonedx-maven-plugin), a lightweight software bill of materials (SBOM) standard designed for use in application security contexts and supply chain component analysis. For example, `orc-core-1.9.0-SNAPSHOT-cyclonedx.json` and `orc-core-1.9.0-SNAPSHOT-cyclonedx.xml` are attached like the following. ``` $ tree ~/.m2/repository/org/apache/orc/orc-core /Users/dongjoon/.m2/repository/org/apache/orc/orc-core ├── 1.9.0-SNAPSHOT │ ├── _remote.repositories │ ├── maven-metadata-apache.snapshots.xml │ ├── maven-metadata-apache.snapshots.xml.sha1 │ ├── maven-metadata-local.xml │ ├── orc-core-1.9.0-20230103.231254-184.jar │ ├── orc-core-1.9.0-20230103.231254-184.jar.sha1 │ ├── orc-core-1.9.0-20230103.231254-184.pom │ ├── orc-core-1.9.0-20230103.231254-184.pom.sha1 │ ├── orc-core-1.9.0-SNAPSHOT-cyclonedx.json │ ├── orc-core-1.9.0-SNAPSHOT-cyclonedx.xml │ ├── orc-core-1.9.0-SNAPSHOT-nohive.jar │ ├── orc-core-1.9.0-SNAPSHOT-shaded-protobuf.jar │ ├── orc-core-1.9.0-SNAPSHOT-sources.jar │ ├── orc-core-1.9.0-SNAPSHOT-test-sources.jar │ ├── orc-core-1.9.0-SNAPSHOT-tests.jar │ ├── orc-core-1.9.0-SNAPSHOT.jar │ ├── orc-core-1.9.0-SNAPSHOT.pom │ └── resolver-status.properties └── maven-metadata-local.xml ``` ### How was this patch tested? After installing locally and check the `*cyclonedx.*` files. ``` $ mvn install -DskipTests ``` Closes apache#1353 from dongjoon-hyun/ORC-1342. Authored-by: Dongjoon Hyun <dongjoon@apache.org> Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
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.
What changes were proposed in this pull request?
This PR aims to publish
SBOMartifacts.Why are the changes needed?
Here is an article to give some context.
Software Bill of Materials (SBOM) are additional artifacts containing the aggregate of all direct and transitive dependencies of a project. The US Government (based on NIST recommendations) currently accepts only the three most popular SBOM standards as valid, namely: CycloneDX, Software Identification (SWID) tag, Software Package Data Exchange® (SPDX).
This PR uses CycloneDX maven plugin, a lightweight software bill of materials (SBOM) standard designed for use in application security contexts and supply chain component analysis.
For example,
orc-core-1.9.0-SNAPSHOT-cyclonedx.jsonandorc-core-1.9.0-SNAPSHOT-cyclonedx.xmlare attached like the following.How was this patch tested?
After installing locally and check the
*cyclonedx.*files.