-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generate CycloneDX SBOMs using our own JSON generation (#587)
* Generate CycloneDX SBOMs using our own JSON generation * fix some errors * Add support to ko deps * Add e2e SBOM validation * ignore empty hashes (why are hashes empty?)
- Loading branch information
Showing
9 changed files
with
304 additions
and
3 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,98 @@ | ||
| name: Validate SBOMs | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: ['main'] | ||
|
|
||
| jobs: | ||
| go-version-m: | ||
| name: Generate go version -m | ||
| runs-on: ubuntu-latest | ||
|
|
||
| env: | ||
| KO_DOCKER_REPO: localhost:1338 | ||
|
|
||
| steps: | ||
| - uses: actions/setup-go@v2 | ||
| with: | ||
| go-version: '1.17.x' | ||
| - name: Install cmd/registry | ||
| run: | | ||
| go install github.com/google/go-containerregistry/cmd/registry@latest | ||
| registry & | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| - name: Generate | ||
| run: | | ||
| img=$(go run ./ build ./) | ||
| go run ./ deps $img --sbom=go.version-m > gomod.txt | ||
| cat gomod.txt | ||
| cyclonedx: | ||
| name: Validate CycloneDX SBOM | ||
| runs-on: ubuntu-latest | ||
|
|
||
| env: | ||
| KO_DOCKER_REPO: localhost:1338 | ||
|
|
||
| steps: | ||
| - uses: actions/setup-go@v2 | ||
| with: | ||
| go-version: '1.17.x' | ||
| - name: Install cmd/registry | ||
| run: | | ||
| go install github.com/google/go-containerregistry/cmd/registry@latest | ||
| registry & | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| - name: Install CycloneDX | ||
| run: | | ||
| wget https://github.com/CycloneDX/cyclonedx-cli/releases/download/v0.22.0/cyclonedx-linux-x64 | ||
| chmod +x cyclonedx-linux-x64 | ||
| - name: Generate and Validate | ||
| run: | | ||
| img=$(go run ./ build ./) | ||
| go run ./ deps $img --sbom=cyclonedx > sbom.json | ||
| ./cyclonedx-linux-x64 validate --input-file=sbom.json --fail-on-errors | ||
| - uses: actions/upload-artifact@v2 | ||
| if: ${{ always() }} | ||
| with: | ||
| name: sbom.json | ||
| path: sbom.json | ||
|
|
||
| spdx: | ||
| name: Validate SPDX SBOM | ||
| runs-on: ubuntu-latest | ||
|
|
||
| env: | ||
| KO_DOCKER_REPO: localhost:1338 | ||
|
|
||
| steps: | ||
| - uses: actions/setup-go@v2 | ||
| with: | ||
| go-version: '1.17.x' | ||
| - name: Install cmd/registry | ||
| run: | | ||
| go install github.com/google/go-containerregistry/cmd/registry@latest | ||
| registry & | ||
| - uses: actions/checkout@v2 | ||
|
|
||
| - name: Install SPDX Tools | ||
| run: | | ||
| wget https://github.com/spdx/tools/releases/download/v2.2.7/spdx-tools-2.2.7.zip | ||
| unzip spdx-tools-2.2.7.zip | ||
| - name: Generate and Validate | ||
| run: | | ||
| img=$(go run ./ build ./) | ||
| go run ./ deps $img --sbom=spdx > sbom.txt | ||
| java -jar ./spdx-tools-2.2.7-jar-with-dependencies.jar Verify sbom.txt | ||
| - uses: actions/upload-artifact@v2 | ||
| if: ${{ always() }} | ||
| with: | ||
| name: sbom.txt | ||
| path: sbom.txt |
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,167 @@ | ||
| // Copyright 2022 Google LLC All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package sbom | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/base64" | ||
| "encoding/hex" | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
| ) | ||
|
|
||
| func bomRef(path, version string) string { | ||
| return fmt.Sprintf("pkg:golang/%s@%s?type=module", path, version) | ||
| } | ||
|
|
||
| func h1ToSHA256(s string) string { | ||
| if !strings.HasPrefix(s, "h1:") { | ||
| return "" | ||
| } | ||
| b, err := base64.StdEncoding.DecodeString(s[3:]) | ||
| if err != nil { | ||
| return "" | ||
| } | ||
| return hex.EncodeToString(b) | ||
| } | ||
|
|
||
| func GenerateCycloneDX(mod []byte) ([]byte, error) { | ||
| bi := &BuildInfo{} | ||
| if err := bi.UnmarshalText(mod); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| doc := document{ | ||
| BOMFormat: "CycloneDX", | ||
| SpecVersion: "1.4", | ||
| Version: 1, | ||
| Metadata: metadata{ | ||
| Component: component{ | ||
| BOMRef: bomRef(bi.Main.Path, bi.Main.Version), | ||
| Type: "application", | ||
| Name: bi.Main.Path, | ||
| Version: bi.Main.Version, | ||
| Purl: bomRef(bi.Main.Path, bi.Main.Version), | ||
| ExternalReferences: []externalReference{{ | ||
| URL: "https://" + bi.Main.Path, | ||
| Type: "vcs", | ||
| }}, | ||
| }, | ||
| Properties: []property{{ | ||
| Name: "cdx:gomod:binary:name", | ||
| Value: "out", | ||
| }}, | ||
| // TODO: include all hashes | ||
| // TODO: include go version | ||
| // TODO: include bi.Settings? | ||
| }, | ||
| Dependencies: []dependency{{ | ||
| Ref: bomRef(bi.Main.Path, bi.Main.Version), | ||
| }}, | ||
| Compositions: []composition{{ | ||
| Aggregate: "complete", | ||
| Dependencies: []string{ | ||
| bomRef(bi.Main.Path, bi.Main.Version), | ||
| }, | ||
| }, { | ||
| Aggregate: "unknown", | ||
| Dependencies: []string{}, | ||
| }}, | ||
| } | ||
| for _, dep := range bi.Deps { | ||
| // Don't include replaced deps | ||
| if dep.Replace != nil { | ||
| continue | ||
| } | ||
| comp := component{ | ||
| BOMRef: bomRef(dep.Path, dep.Version), | ||
| Type: "library", | ||
| Name: dep.Path, | ||
| Version: dep.Version, | ||
| Scope: "required", | ||
| Purl: bomRef(dep.Path, dep.Version), | ||
| ExternalReferences: []externalReference{{ | ||
| URL: "https://" + dep.Path, | ||
| Type: "vcs", | ||
| }}, | ||
| } | ||
| if dep.Sum != "" { | ||
| comp.Hashes = []hash{{ | ||
| Alg: "SHA-256", | ||
| Content: h1ToSHA256(dep.Sum), | ||
| }} | ||
| } | ||
| doc.Components = append(doc.Components, comp) | ||
| doc.Dependencies[0].DependsOn = append(doc.Dependencies[0].DependsOn, bomRef(dep.Path, dep.Version)) | ||
| doc.Dependencies = append(doc.Dependencies, dependency{ | ||
| Ref: bomRef(dep.Path, dep.Version), | ||
| }) | ||
|
|
||
| doc.Compositions[1].Dependencies = append(doc.Compositions[1].Dependencies, bomRef(dep.Path, dep.Version)) | ||
| } | ||
|
|
||
| var buf bytes.Buffer | ||
| enc := json.NewEncoder(&buf) | ||
| enc.SetIndent("", " ") | ||
| if err := enc.Encode(doc); err != nil { | ||
| return nil, err | ||
| } | ||
| return buf.Bytes(), nil | ||
| } | ||
|
|
||
| type document struct { | ||
| BOMFormat string `json:"bomFormat"` | ||
| SpecVersion string `json:"specVersion"` | ||
| Version int `json:"version"` | ||
| Metadata metadata `json:"metadata"` | ||
| Components []component `json:"components,omitempty"` | ||
| Dependencies []dependency `json:"dependencies,omitempty"` | ||
| Compositions []composition `json:"compositions,omitempty"` | ||
| } | ||
| type metadata struct { | ||
| Component component `json:"component"` | ||
| Properties []property `json:"properties,omitempty"` | ||
| } | ||
| type component struct { | ||
| BOMRef string `json:"bom-ref"` | ||
| Type string `json:"type"` | ||
| Name string `json:"name"` | ||
| Version string `json:"version"` | ||
| Scope string `json:"scope,omitempty"` | ||
| Hashes []hash `json:"hashes,omitempty"` | ||
| Purl string `json:"purl"` | ||
| ExternalReferences []externalReference `json:"externalReferences"` | ||
| } | ||
| type hash struct { | ||
| Alg string `json:"alg"` | ||
| Content string `json:"content"` | ||
| } | ||
| type externalReference struct { | ||
| URL string `json:"url"` | ||
| Type string `json:"type"` | ||
| } | ||
| type property struct { | ||
| Name string `json:"name"` | ||
| Value string `json:"value"` | ||
| } | ||
| type dependency struct { | ||
| Ref string `json:"ref"` | ||
| DependsOn []string `json:"dependsOn,omitempty"` | ||
| } | ||
| type composition struct { | ||
| Aggregate string `json:"aggregate"` | ||
| Dependencies []string `json:"dependencies,omitempty"` | ||
| } |
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