Files
trivy/pkg/vex/document.go
2025-04-30 06:24:09 +00:00

107 lines
2.7 KiB
Go

package vex
import (
"encoding/json"
"io"
"os"
"github.com/gocsaf/csaf/v3/csaf"
"github.com/hashicorp/go-multierror"
openvex "github.com/openvex/go-vex/pkg/vex"
"github.com/sirupsen/logrus"
"golang.org/x/xerrors"
ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
"github.com/aquasecurity/trivy/pkg/sbom"
"github.com/aquasecurity/trivy/pkg/sbom/cyclonedx"
"github.com/aquasecurity/trivy/pkg/types"
)
func NewDocument(filePath string, report *types.Report) (VEX, error) {
if filePath == "" {
return nil, xerrors.New("VEX file path is empty")
}
f, err := os.Open(filePath)
if err != nil {
return nil, xerrors.Errorf("file open error: %w", err)
}
defer f.Close()
v, errs := decodeVEX(f, filePath, report)
if errs != nil {
return nil, xerrors.Errorf("unable to load VEX from file: %w", errs)
}
return v, nil
}
func decodeVEX(r io.ReadSeeker, source string, report *types.Report) (VEX, error) {
var errs error
// Try CycloneDX JSON
if ok, err := sbom.IsCycloneDXJSON(r); err != nil {
errs = multierror.Append(errs, err)
} else if ok {
return decodeCycloneDXJSON(r, report)
}
// Try OpenVEX
if v, err := decodeOpenVEX(r, source); err != nil {
errs = multierror.Append(errs, err)
} else if v != nil {
return v, nil
}
// Try CSAF
if v, err := decodeCSAF(r, source); err != nil {
errs = multierror.Append(errs, err)
} else if v != nil {
return v, nil
}
return nil, xerrors.Errorf("unable to decode VEX: %w", errs)
}
func decodeCycloneDXJSON(r io.ReadSeeker, report *types.Report) (*CycloneDX, error) {
if _, err := r.Seek(0, io.SeekStart); err != nil {
return nil, xerrors.Errorf("seek error: %w", err)
}
vex, err := cyclonedx.DecodeJSON(r)
if err != nil {
return nil, xerrors.Errorf("json decode error: %w", err)
}
if report.ArtifactType != ftypes.TypeCycloneDX {
return nil, xerrors.New("CycloneDX VEX can be used with CycloneDX SBOM")
}
return newCycloneDX(report.BOM, vex), nil
}
func decodeOpenVEX(r io.ReadSeeker, source string) (*OpenVEX, error) {
// openvex/go-vex outputs log messages by default
logrus.SetOutput(io.Discard)
if _, err := r.Seek(0, io.SeekStart); err != nil {
return nil, xerrors.Errorf("seek error: %w", err)
}
var openVEX openvex.VEX
if err := json.NewDecoder(r).Decode(&openVEX); err != nil {
return nil, err
}
if openVEX.Context == "" {
return nil, nil
}
return newOpenVEX(openVEX, source), nil
}
func decodeCSAF(r io.ReadSeeker, source string) (*CSAF, error) {
if _, err := r.Seek(0, io.SeekStart); err != nil {
return nil, xerrors.Errorf("seek error: %w", err)
}
var adv csaf.Advisory
if err := json.NewDecoder(r).Decode(&adv); err != nil {
return nil, err
}
if adv.Vulnerabilities == nil {
return nil, nil
}
return newCSAF(adv, source), nil
}