mirror of
https://github.com/hashicorp/packer.git
synced 2026-09-30 03:34:02 -04:00
hcp-sbom: use a JSON-encoded output for Packer
When outputting the data from the provisioner so Packer can consume it, we are writing to a file. The only constraints on this file are that Packer manages its lifecycle, and that Packer core and the provisioner are synced-up in terms of the contents and the structure of the file. Since we are outputting the file, and its format, we can bundle the two together, and export them under a structure that both the provisioner and Packer core have access to, so we can then fill-in the blanks, and write a serialised version of this structure to disk. This is the approach taken in this commit. First we clean-up the existing code a bit, since some abstractions were a bit hasty, and did not necessarily make sense in all cases, so the code is consolidated under `Provision`, and we use that structure then to fill-in the relevant information before serialising it to JSON and writing it in the output file provided by Packer core.
This commit is contained in:
Lucas Bajolet
+10
-33
@@ -5,6 +5,7 @@ package packer
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
@@ -290,47 +291,23 @@ func (p *SBOMInternalProvisioner) Provision(
|
||||
return err
|
||||
}
|
||||
|
||||
sbomFormat, err := p.getSBOMFormat(tmpFile.Name())
|
||||
packerSbom, err := os.Open(tmpFileName)
|
||||
if err != nil {
|
||||
return err
|
||||
return fmt.Errorf("failed to open Packer SBOM file %q: %s", tmpFileName, err)
|
||||
}
|
||||
|
||||
compressedData, err := p.compressFile(tmpFile.Name())
|
||||
provisionerOut := &hcpSbomProvisioner.PackerSBOM{}
|
||||
err = json.NewDecoder(packerSbom).Decode(provisionerOut)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
p.CompressedData = compressedData
|
||||
p.SBOMFormat = sbomFormat
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *SBOMInternalProvisioner) compressFile(filePath string) ([]byte, error) {
|
||||
data, err := os.ReadFile(filePath)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to read file %s: %w", filePath, err)
|
||||
return fmt.Errorf("malformed packer SBOM output from file %q: %s", tmpFileName, err)
|
||||
}
|
||||
|
||||
encoder, err := zstd.NewWriter(nil, zstd.WithEncoderLevel(zstd.SpeedBestCompression))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create zstd encoder: %w", err)
|
||||
return fmt.Errorf("failed to create zstd encoder: %s", err)
|
||||
}
|
||||
p.CompressedData = encoder.EncodeAll(provisionerOut.RawSBOM, nil)
|
||||
p.SBOMFormat = provisionerOut.Format
|
||||
|
||||
compressedData := encoder.EncodeAll(data, nil)
|
||||
|
||||
log.Printf("SBOM file compressed successfully. Size: %d bytes\n", len(compressedData))
|
||||
return compressedData, nil
|
||||
}
|
||||
|
||||
func (p *SBOMInternalProvisioner) getSBOMFormat(filePath string) (string, error) {
|
||||
fileContent, err := os.ReadFile(filePath)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to open SBOM file %s: %w", filePath, err)
|
||||
}
|
||||
|
||||
format, err := hcpSbomProvisioner.ValidateSBOM(fileContent)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to detect SBOM format: %w", err)
|
||||
}
|
||||
|
||||
return format, nil
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -9,6 +9,7 @@ package hcp_sbom
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log"
|
||||
@@ -76,6 +77,17 @@ func (p *Provisioner) Prepare(raws ...interface{}) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// PackerSBOM is the type we write to the temporary JSON dump of the SBOM to
|
||||
// be consumed by Packer core
|
||||
type PackerSBOM struct {
|
||||
// RawSBOM is the raw data from the SBOM downloaded from the guest
|
||||
RawSBOM []byte `json:"raw_sbom"`
|
||||
// Format is the format detected by the provisioner
|
||||
//
|
||||
// Supported values: `spdx` or `cyclonedx`
|
||||
Format string `json:"format"`
|
||||
}
|
||||
|
||||
func (p *Provisioner) Provision(
|
||||
ctx context.Context, ui packersdk.Ui, comm packersdk.Communicator,
|
||||
generatedData map[string]interface{},
|
||||
@@ -87,18 +99,6 @@ func (p *Provisioner) Provision(
|
||||
}
|
||||
p.config.ctx.Data = generatedData
|
||||
|
||||
downloadErr := p.downloadAndValidateSBOM(ui, comm, generatedData)
|
||||
if downloadErr != nil {
|
||||
return fmt.Errorf("failed to download SBOM file: %w", downloadErr)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// downloadAndValidateSBOM handles downloading SBOM files for the User and Packer.
|
||||
func (p *Provisioner) downloadAndValidateSBOM(
|
||||
ui packersdk.Ui, comm packersdk.Communicator, generatedData map[string]interface{},
|
||||
) error {
|
||||
src := p.config.Source
|
||||
|
||||
pkrDst := generatedData["dst"].(string)
|
||||
@@ -112,44 +112,46 @@ func (p *Provisioner) downloadAndValidateSBOM(
|
||||
return err
|
||||
}
|
||||
|
||||
if _, err := ValidateSBOM(buf.Bytes()); err != nil {
|
||||
ui.Errorf("validation failed for SBOM file: %s", err)
|
||||
return err
|
||||
format, err := ValidateSBOM(buf.Bytes())
|
||||
if err != nil {
|
||||
return fmt.Errorf("validation failed for SBOM file: %s", err)
|
||||
}
|
||||
|
||||
err := p.writeToFile(bytes.NewReader(buf.Bytes()), pkrDst)
|
||||
outFile, err := os.Create(pkrDst)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to write HCP's SBOM: %s", err)
|
||||
return fmt.Errorf("failed to open/create output file %q: %s", pkrDst, err)
|
||||
}
|
||||
defer outFile.Close()
|
||||
|
||||
err = json.NewEncoder(outFile).Encode(PackerSBOM{
|
||||
RawSBOM: buf.Bytes(),
|
||||
Format: format,
|
||||
Name: p.config.SbomName,
|
||||
})
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to write sbom file to %q: %s", pkrDst, err)
|
||||
}
|
||||
|
||||
if p.config.Destination == "" {
|
||||
return nil
|
||||
}
|
||||
|
||||
// SBOM for User
|
||||
usrDst, err := p.getUserDestination()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to determine user SBOM destination: %s", err)
|
||||
return fmt.Errorf("failed to compute destination path %q: %s", p.config.Destination, err)
|
||||
}
|
||||
err = os.WriteFile(usrDst, buf.Bytes(), 0644)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to write SBOM to destination %q: %s", usrDst, err)
|
||||
}
|
||||
|
||||
if usrDst != "" {
|
||||
err = p.writeToFile(bytes.NewReader(buf.Bytes()), usrDst)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to download User SBOM: %s", err)
|
||||
}
|
||||
log.Printf("User SBOM file successfully downloaded to: %s\n", usrDst)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// getUserDestination determines and returns the destination path for the user SBOM file.
|
||||
func (p *Provisioner) getUserDestination() (string, error) {
|
||||
dst := p.config.Destination
|
||||
if dst == "" {
|
||||
log.Println("skipped downloading user SBOM file because 'Destination' is not provided")
|
||||
return "", nil
|
||||
}
|
||||
|
||||
dst, err := interpolate.Render(dst, &p.config.ctx)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("error interpolating SBOM file destination for user: %s", err)
|
||||
}
|
||||
|
||||
// Check if the destination exists and determine its type
|
||||
info, err := os.Stat(dst)
|
||||
@@ -191,19 +193,3 @@ func (p *Provisioner) getUserDestination() (string, error) {
|
||||
|
||||
return dst, nil
|
||||
}
|
||||
|
||||
func (p *Provisioner) writeToFile(buf *bytes.Reader, dst string) error {
|
||||
// Open the destination file
|
||||
f, err := os.OpenFile(dst, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to open destination file for SBOM: %s", err)
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
// Write the buffer content to the destination file
|
||||
if _, err = buf.WriteTo(f); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user