-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #370 from gini/IPC-68-generate-SBOM
Ipc 68 generate SBOM
- Loading branch information
Showing
13 changed files
with
269 additions
and
10 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| name: Generate SBOMs for all projects | ||
|
|
||
| # TODO: remove push trigger after merging to main | ||
| # TODO: add trigger to run after we have published a release | ||
| # TODO: use GitHub's dependency submission API to submit the SBOMs to GitHub's dependency graph: | ||
| # https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api | ||
| on: | ||
| push: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| generate-sbom: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: checkout | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: setup java | ||
| uses: actions/setup-java@v3 | ||
| with: | ||
| distribution: 'temurin' | ||
| java-version: '17' | ||
| cache: 'gradle' | ||
|
|
||
| - name: generate a cyclonedx sbom for each project | ||
| run: > | ||
| ./gradlew clean | ||
| core-api-library:library:cyclonedxBom | ||
| health-api-library:library:cyclonedxBom | ||
| bank-api-library:library:cyclonedxBom | ||
| health-sdk:sdk:cyclonedxBom | ||
| capture-sdk:sdk:cyclonedxBom | ||
| capture-sdk:default-network:cyclonedxBom | ||
| bank-sdk:sdk:cyclonedxBom | ||
| -PcreateSBOM=true | ||
| - name: validate cyclonedx sboms | ||
| shell: bash | ||
| run: | | ||
| curl -Lo cyclonedx https://github.com/CycloneDX/cyclonedx-cli/releases/download/v0.25.0/cyclonedx-linux-x64 | ||
| chmod +x cyclonedx | ||
| ./cyclonedx validate --input-file core-api-library/library/build/reports/gini-internal-core-api-lib-sbom.json | ||
| ./cyclonedx validate --input-file health-api-library/library/build/reports/gini-health-api-lib-sbom.json | ||
| ./cyclonedx validate --input-file bank-api-library/library/build/reports/gini-bank-api-lib-sbom.json | ||
| ./cyclonedx validate --input-file health-sdk/sdk/build/reports/gini-health-sdk-sbom.json | ||
| ./cyclonedx validate --input-file capture-sdk/sdk/build/reports/gini-capture-sdk-sbom.json | ||
| ./cyclonedx validate --input-file capture-sdk/default-network/build/reports/gini-capture-sdk-default-network-sbom.json | ||
| ./cyclonedx validate --input-file bank-sdk/sdk/build/reports/gini-bank-sdk-sbom.json | ||
| - name: zip the cyclonedx sboms | ||
| run: > | ||
| zip -rj sbom-jsons.zip | ||
| core-api-library/library/build/reports/gini-internal-core-api-lib-sbom.json | ||
| health-api-library/library/build/reports/gini-health-api-lib-sbom.json | ||
| bank-api-library/library/build/reports/gini-bank-api-lib-sbom.json | ||
| health-sdk/sdk/build/reports/gini-health-sdk-sbom.json | ||
| capture-sdk/sdk/build/reports/gini-capture-sdk-sbom.json | ||
| capture-sdk/default-network/build/reports/gini-capture-sdk-default-network-sbom.json | ||
| bank-sdk/sdk/build/reports/gini-bank-sdk-sbom.json | ||
| - name: archive the cyclonedx sboms | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: CycloneDX SBOM JSONs | ||
| path: sbom-jsons.zip |
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| package net.gini.gradle | ||
|
|
||
| import org.gradle.api.Plugin | ||
| import org.gradle.api.Project | ||
| import org.gradle.kotlin.dsl.getByName | ||
| import org.json.JSONArray | ||
| import org.json.JSONObject | ||
|
|
||
| /** | ||
| * Uses the CycloneDX Gradle plugin to generate an SBOM (Software Bill of Materials) for the project. | ||
| * | ||
| * Applies the necessary configuration and edits the generated SBOM to use the artifactId instead of the project name and "aar" type instead of "jar". | ||
| */ | ||
| class SBOMPlugin : Plugin<Project> { | ||
|
|
||
| override fun apply(target: Project) { | ||
| if (target.properties["createSBOM"] != "true") { | ||
| return | ||
| } | ||
|
|
||
| target.plugins.apply("org.cyclonedx.bom") | ||
|
|
||
| target.group = target.properties["groupId"] as String | ||
|
|
||
| target.tasks.getByName<org.cyclonedx.gradle.CycloneDxTask>("cyclonedxBom") { | ||
| setSchemaVersion("1.4") | ||
|
|
||
| setIncludeConfigs(listOf( | ||
| "releaseRuntimeClasspath", | ||
| "releaseCompileClasspath" | ||
| )) | ||
|
|
||
| val outputName = "${project.properties["artifactId"]}-sbom" | ||
| setOutputName(outputName) | ||
|
|
||
| setOrganizationalEntity { | ||
| it.name = "Gini GmbH" | ||
| it.urls = listOf("https://gini.net") | ||
| } | ||
|
|
||
| doLast { | ||
| val artifactId = project.properties["artifactId"] as String | ||
| val projectPURL = "pkg:maven/${project.group}/$artifactId@${project.version}?type=aar" | ||
| val generatedPURL = "pkg:maven/${project.group}/${project.name}@${project.version}?type=jar" | ||
|
|
||
| val bomFile = project.file("build/reports/$outputName.json") | ||
| val bom = bomFile.readText() | ||
|
|
||
| val bomJson = JSONObject(bom) | ||
| val metadataJson = bomJson["metadata"] as JSONObject | ||
|
|
||
| fixComponentName(bomJson, artifactId) | ||
|
|
||
| fixPURLAndRefs( | ||
| bomJson = bomJson, | ||
| incorrectPURL = generatedPURL, | ||
| correctPURL = projectPURL) | ||
|
|
||
| renameManufactureToSupplier(metadataJson) | ||
|
|
||
| addAuthors(metadataJson) | ||
|
|
||
| bomFile.writeText(bomJson.toString(4)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun fixComponentName(bomJson: JSONObject, artifactId: String,) { | ||
| val metadataJson = bomJson["metadata"] as JSONObject | ||
| val componentJson = metadataJson["component"] as JSONObject | ||
| componentJson.put("name", artifactId) | ||
| } | ||
|
|
||
| private fun fixPURLAndRefs( | ||
| bomJson: JSONObject, | ||
| incorrectPURL: String, | ||
| correctPURL: String, | ||
| ) { | ||
| val metadataJson = bomJson["metadata"] as JSONObject | ||
| val componentJson = metadataJson["component"] as JSONObject | ||
| componentJson.put("purl", correctPURL) | ||
| componentJson.put("bom-ref", correctPURL) | ||
|
|
||
| val dependenciesJson = bomJson["dependencies"] as JSONArray | ||
| dependenciesJson.forEach { | ||
| val dependencyJson = it as JSONObject | ||
| if (dependencyJson["ref"].toString() == incorrectPURL) { | ||
| dependencyJson.put("ref", correctPURL) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun renameManufactureToSupplier(metadataJson: JSONObject) { | ||
| val manufactureJson = metadataJson["manufacture"] as JSONObject | ||
| metadataJson.remove("manufacture") | ||
| metadataJson.put("supplier", manufactureJson) | ||
| } | ||
|
|
||
| private fun addAuthors(metadataJson: JSONObject) { | ||
| metadataJson.put( | ||
| "authors", JSONArray( | ||
| listOf( | ||
| JSONObject( | ||
| mapOf( | ||
| "name" to "Gini GmbH" | ||
| ) | ||
| ) | ||
| ) | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| } |
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
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
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
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
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
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
Oops, something went wrong.