-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
800. Add sbom section to deploy configure/review (#1713)
## Description #800 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Other (security config, docs update, etc) ## Checklist before merging - [x] Test, docs, adr added or updated as needed - [ ] [Contributor Guide Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow) followed --------- Co-authored-by: Wayne Starr <[email protected]> Co-authored-by: Wayne Starr <[email protected]>
- Loading branch information
3 people
authored
May 22, 2023
1 parent
becbfd7
commit 4983505
Showing
27 changed files
with
381 additions
and
75 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
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,134 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // SPDX-FileCopyrightText: 2021-Present The Zarf Authors | ||
|
|
||
| // Package packages provides api functions for managing Zarf packages. | ||
| package packages | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/url" | ||
| "os" | ||
| "os/signal" | ||
| "path/filepath" | ||
| "syscall" | ||
|
|
||
| "github.com/defenseunicorns/zarf/src/config" | ||
| "github.com/defenseunicorns/zarf/src/internal/api/common" | ||
| "github.com/defenseunicorns/zarf/src/pkg/message" | ||
| "github.com/defenseunicorns/zarf/src/pkg/utils" | ||
| "github.com/defenseunicorns/zarf/src/types" | ||
| "github.com/go-chi/chi/v5" | ||
| "github.com/mholt/archiver/v3" | ||
| ) | ||
|
|
||
| var signalChan = make(chan os.Signal, 1) | ||
|
|
||
| // ExtractSBOM Extracts the SBOM from the package and returns the path to the SBOM | ||
| func ExtractSBOM(w http.ResponseWriter, r *http.Request) { | ||
| path := chi.URLParam(r, "path") | ||
|
|
||
| sbom, err := extractSBOM(path) | ||
|
|
||
| if err != nil { | ||
| message.ErrorWebf(err, w, err.Error()) | ||
| } else { | ||
| common.WriteJSONResponse(w, sbom, http.StatusOK) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| // DeleteSBOM removes the SBOM directory | ||
| func DeleteSBOM(w http.ResponseWriter, _ *http.Request) { | ||
| err := cleanupSBOM() | ||
| if err != nil { | ||
| message.ErrorWebf(err, w, err.Error()) | ||
| return | ||
| } | ||
| common.WriteJSONResponse(w, nil, http.StatusOK) | ||
| } | ||
|
|
||
| // cleanupSBOM removes the SBOM directory | ||
| func cleanupSBOM() error { | ||
| err := os.RemoveAll(config.ZarfSBOMDir) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // Extracts the SBOM from the package and returns the path to the SBOM | ||
| func extractSBOM(escapedPath string) (sbom types.APIPackageSBOM, err error) { | ||
| path, err := url.QueryUnescape(escapedPath) | ||
| if err != nil { | ||
| return sbom, err | ||
| } | ||
|
|
||
| // Ensure we can get the cwd | ||
| cwd, err := os.Getwd() | ||
| if err != nil { | ||
| return sbom, err | ||
| } | ||
|
|
||
| // ensure the package exists | ||
| if _, err := os.Stat(path); os.IsNotExist(err) { | ||
| return sbom, err | ||
| } | ||
|
|
||
| // Join the current working directory with the zarf-sbom directory | ||
| sbomPath := filepath.Join(cwd, config.ZarfSBOMDir) | ||
|
|
||
| // ensure the zarf-sbom directory is empty | ||
| if _, err := os.Stat(sbomPath); !os.IsNotExist(err) { | ||
| cleanupSBOM() | ||
| } | ||
|
|
||
| // Create the Zarf SBOM directory | ||
| err = utils.CreateDirectory(sbomPath, 0700) | ||
| if err != nil { | ||
| return sbom, err | ||
| } | ||
|
|
||
| // Extract the SBOM tar.gz from the package | ||
| err = archiver.Extract(path, config.ZarfSBOMTar, sbomPath) | ||
| if err != nil { | ||
| cleanupSBOM() | ||
| return sbom, err | ||
| } | ||
|
|
||
| // Unarchive the SBOM tar.gz | ||
| err = archiver.Unarchive(filepath.Join(sbomPath, config.ZarfSBOMTar), sbomPath) | ||
| if err != nil { | ||
| cleanupSBOM() | ||
| return sbom, err | ||
| } | ||
|
|
||
| // Get the SBOM viewer files | ||
| sbom, err = getSbomViewFiles(sbomPath) | ||
| if err != nil { | ||
| cleanupSBOM() | ||
| return sbom, err | ||
| } | ||
|
|
||
| // Cleanup the temp directory on exit | ||
| go func() { | ||
| signal.Notify(signalChan, syscall.SIGINT, syscall.SIGTERM) | ||
| // Wait for a signal to be received | ||
| <-signalChan | ||
|
|
||
| cleanupSBOM() | ||
|
|
||
| // Exit the program | ||
| os.Exit(0) | ||
| }() | ||
|
|
||
| return sbom, err | ||
| } | ||
|
|
||
| func getSbomViewFiles(sbomPath string) (sbom types.APIPackageSBOM, err error) { | ||
| sbomViewFiles, err := filepath.Glob(filepath.Join(sbomPath, "sbom-viewer-*")) | ||
| if len(sbomViewFiles) > 0 { | ||
| sbom.Path = sbomViewFiles[0] | ||
| sbom.SBOMS = sbomViewFiles | ||
| } | ||
| return sbom, err | ||
| } |
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
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.