Documentation
¶
Index ¶
- func Filter(ctx context.Context, report *types.Report, opts Options) error
- type CSAF
- type Client
- type CycloneDX
- type NotAffected
- type OpenVEX
- func (v *OpenVEX) Filter(result *types.Result, bom *core.BOM)
- func (v *OpenVEX) Matches(vuln types.DetectedVulnerability, product, subComponent *core.Component) []openvex.Statement
- func (v *OpenVEX) NotAffected(vuln types.DetectedVulnerability, product, subComponent *core.Component) (types.ModifiedFinding, bool)
- type Options
- type RepositoryIndex
- type RepositorySet
- type SBOMReferenceSet
- type Source
- type SourceType
- type Statement
- type VEX
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CSAF ¶ added in v0.49.0
type CSAF struct {
// contains filtered or unexported fields
}
func (*CSAF) NotAffected ¶ added in v0.52.0
func (v *CSAF) NotAffected(vuln types.DetectedVulnerability, product, subProduct *core.Component) (types.ModifiedFinding, bool)
type Client ¶ added in v0.54.0
type Client struct {
VEXes []VEX
}
func (*Client) NotAffected ¶ added in v0.54.0
func (c *Client) NotAffected(vuln types.DetectedVulnerability, product, subComponent *core.Component) (types.ModifiedFinding, bool)
type CycloneDX ¶
type CycloneDX struct {
// contains filtered or unexported fields
}
func (*CycloneDX) NotAffected ¶ added in v0.54.0
func (v *CycloneDX) NotAffected(vuln types.DetectedVulnerability, product, _ *core.Component) (types.ModifiedFinding, bool)
type NotAffected ¶ added in v0.52.0
type NotAffected func(vuln types.DetectedVulnerability, product, subComponent *core.Component) (types.ModifiedFinding, bool)
type OpenVEX ¶
type OpenVEX struct {
// contains filtered or unexported fields
}
func NewOCI ¶ added in v0.54.0
NewOCI discovers and loads the OpenVEX document attached to the scanned OCI image. It returns nil when the report is not an OCI image or no VEX attestation is found.
func (*OpenVEX) NotAffected ¶ added in v0.52.0
func (v *OpenVEX) NotAffected(vuln types.DetectedVulnerability, product, subComponent *core.Component) (types.ModifiedFinding, bool)
type RepositoryIndex ¶ added in v0.54.0
RepositoryIndex wraps the repository index
type RepositorySet ¶ added in v0.54.0
type RepositorySet struct {
// contains filtered or unexported fields
}
func NewRepositorySet ¶ added in v0.54.0
func NewRepositorySet(ctx context.Context, cacheDir string) (*RepositorySet, error)
func (*RepositorySet) NotAffected ¶ added in v0.54.0
func (rs *RepositorySet) NotAffected(vuln types.DetectedVulnerability, product, subComponent *core.Component) (types.ModifiedFinding, bool)
func (*RepositorySet) OpenDocument ¶ added in v0.54.0
func (rs *RepositorySet) OpenDocument(source, dir string, entry repo.PackageEntry) (VEX, error)
type SBOMReferenceSet ¶ added in v0.60.0
type SBOMReferenceSet struct {
VEXes []VEX
}
func NewSBOMReferenceSet ¶ added in v0.60.0
func NewSBOMReferenceSet(report *types.Report) (*SBOMReferenceSet, error)
func (*SBOMReferenceSet) NotAffected ¶ added in v0.60.0
func (set *SBOMReferenceSet) NotAffected(vuln types.DetectedVulnerability, product, subComponent *core.Component) (types.ModifiedFinding, bool)
type Source ¶ added in v0.54.0
type Source struct {
Type SourceType
FilePath string // Used only for the file type
}
type SourceType ¶ added in v0.54.0
type SourceType string
const ( TypeFile SourceType = "file" TypeRepository SourceType = "repo" TypeOCI SourceType = "oci" TypeSBOMReference SourceType = "sbom-ref" )
type Statement ¶
type Statement struct {
Affects []string
Status types.FindingStatus
Justification string
}
type VEX ¶
type VEX interface {
NotAffected(vuln types.DetectedVulnerability, product, subComponent *core.Component) (types.ModifiedFinding, bool)
}
VEX represents Vulnerability Exploitability eXchange. It abstracts multiple VEX formats. Note: This is in the experimental stage and does not yet support many specifications. The implementation may change significantly.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.