mirror of
https://github.com/anchore/syft.git
synced 2026-11-03 16:06:36 +01:00
chore: stop re-exporting wfn.Attributes (#2534)
* chore: stop re-exporting wfn.Attributes Previously, Syft re-exported wfn.Attributes from the nvdtools package as a member of the Package struct. However, Syft doesn't own this struct, and so after Syft 1.0, might be forced to bump a semver major version due to a breaking change in wfn.Attributes. Rather than incur this risk going into 1.0, instead replace Syft's use of wfn.Attributes with Syft's own cpe.CPE type. That type has some pass-through calls to wfn.Attributes, but hides the dependency from the rest of the application. Signed-off-by: Will Murphy <will.murphy@anchore.com> * chore: make cpe.CPE type a Stringer Previously, the cpe.CPE type was an alias for wfn.Attributes from nvdtools. Now that it is a type we control, make the String method take the CPE as a receiver, rather than as a normal parameter, so that Syft's cpe.CPE type implements Stringer. Signed-off-by: Will Murphy <will.murphy@anchore.com> --------- Signed-off-by: Will Murphy <will.murphy@anchore.com>
This commit is contained in:
+46
-16
@@ -8,7 +8,35 @@ import (
|
||||
"github.com/facebookincubator/nvdtools/wfn"
|
||||
)
|
||||
|
||||
type CPE = wfn.Attributes
|
||||
type CPE struct {
|
||||
Part string
|
||||
Vendor string
|
||||
Product string
|
||||
Version string
|
||||
Update string
|
||||
Edition string
|
||||
SWEdition string
|
||||
TargetSW string
|
||||
TargetHW string
|
||||
Other string
|
||||
Language string
|
||||
}
|
||||
|
||||
func (c CPE) asAttributes() wfn.Attributes {
|
||||
return wfn.Attributes(c)
|
||||
}
|
||||
|
||||
func fromAttributes(a wfn.Attributes) CPE {
|
||||
return CPE(a)
|
||||
}
|
||||
|
||||
func (c CPE) BindToFmtString() string {
|
||||
return c.asAttributes().BindToFmtString()
|
||||
}
|
||||
|
||||
func NewWithAny() CPE {
|
||||
return fromAttributes(*(wfn.NewAttributesWithAny()))
|
||||
}
|
||||
|
||||
const (
|
||||
allowedCPEPunctuation = "-!\"#$%&'()+,./:;<=>@[]^`{|}~"
|
||||
@@ -34,7 +62,7 @@ func New(cpeStr string) (CPE, error) {
|
||||
}
|
||||
|
||||
// ensure that this CPE can be validated after being fully sanitized
|
||||
if ValidateString(String(c)) != nil {
|
||||
if ValidateString(c.String()) != nil {
|
||||
return CPE{}, err
|
||||
}
|
||||
|
||||
@@ -71,20 +99,22 @@ func newWithoutValidation(cpeStr string) (CPE, error) {
|
||||
return CPE{}, fmt.Errorf("failed to parse CPE=%q", cpeStr)
|
||||
}
|
||||
|
||||
// we need to compare the raw data since we are constructing CPEs in other locations
|
||||
value.Vendor = normalizeField(value.Vendor)
|
||||
value.Product = normalizeField(value.Product)
|
||||
value.Language = normalizeField(value.Language)
|
||||
value.Version = normalizeField(value.Version)
|
||||
value.TargetSW = normalizeField(value.TargetSW)
|
||||
value.Part = normalizeField(value.Part)
|
||||
value.Edition = normalizeField(value.Edition)
|
||||
value.Other = normalizeField(value.Other)
|
||||
value.SWEdition = normalizeField(value.SWEdition)
|
||||
value.TargetHW = normalizeField(value.TargetHW)
|
||||
value.Update = normalizeField(value.Update)
|
||||
syftCPE := fromAttributes(*value)
|
||||
|
||||
return *value, nil
|
||||
// we need to compare the raw data since we are constructing CPEs in other locations
|
||||
syftCPE.Vendor = normalizeField(syftCPE.Vendor)
|
||||
syftCPE.Product = normalizeField(syftCPE.Product)
|
||||
syftCPE.Language = normalizeField(syftCPE.Language)
|
||||
syftCPE.Version = normalizeField(syftCPE.Version)
|
||||
syftCPE.TargetSW = normalizeField(syftCPE.TargetSW)
|
||||
syftCPE.Part = normalizeField(syftCPE.Part)
|
||||
syftCPE.Edition = normalizeField(syftCPE.Edition)
|
||||
syftCPE.Other = normalizeField(syftCPE.Other)
|
||||
syftCPE.SWEdition = normalizeField(syftCPE.SWEdition)
|
||||
syftCPE.TargetHW = normalizeField(syftCPE.TargetHW)
|
||||
syftCPE.Update = normalizeField(syftCPE.Update)
|
||||
|
||||
return syftCPE, nil
|
||||
}
|
||||
|
||||
func normalizeField(field string) string {
|
||||
@@ -112,7 +142,7 @@ func stripSlashes(s string) string {
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
func String(c CPE) string {
|
||||
func (c CPE) String() string {
|
||||
output := CPE{}
|
||||
output.Vendor = sanitize(c.Vendor)
|
||||
output.Product = sanitize(c.Product)
|
||||
|
||||
Reference in New Issue
Block a user