inspector2util

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 4, 2026 License: MIT Imports: 22 Imported by: 0

README

AWS Inspector 2 Util

This package reads Inspector 2 JSON files and provides various aggregations and filtering on those files.

Documentation

Index

Constants

View Source
const (

	// Resource table field-name constants.
	ImageHash           = "image_hash"
	ImageRepositoryName = "image_repo_name"
	ImageTags           = "image_tags"

	ResourceTypeAwsEc2Instance       = types.ResourceTypeAwsEc2Instance
	ResourceTypeAwsEcrContainerImage = types.ResourceTypeAwsEcrContainerImage
	ResourceTypeAwsEcrRepository     = types.ResourceTypeAwsEcrRepository
	ResourceTypeAwsLambdaFunction    = types.ResourceTypeAwsLambdaFunction
)

Variables

This section is empty.

Functions

func ReadFileListFindingsOutput

func ReadFileListFindingsOutput(filename string) (inspector2.ListFindingsOutput, error)

func ReadFileListFindingsOutputStream added in v0.10.0

func ReadFileListFindingsOutputStream(filename string, fn func(f types.Finding) error) error

ReadFileListFindingsOutputStream streams findings from a ListFindingsOutput JSON file, invoking fn for each finding without loading the full findings array into memory.

func ResourceTableColumns added in v0.8.0

func ResourceTableColumns() ([]string, map[int]string)

Types

type Finding

type Finding types.Finding

func (Finding) CVEID added in v0.8.0

func (f Finding) CVEID() *string

func (Finding) FilePaths

func (f Finding) FilePaths() []string

func (Finding) FilePathsInclPOMProperties

func (f Finding) FilePathsInclPOMProperties() bool

func (Finding) FindingOrVendorSeverity added in v0.7.2

func (f Finding) FindingOrVendorSeverity(canonical bool) string

func (Finding) FindingSeverity

func (f Finding) FindingSeverity(canonical bool) string

func (Finding) ImageHashes

func (f Finding) ImageHashes() []string

func (Finding) ImageRepoNameVulnIDs

func (f Finding) ImageRepoNameVulnIDs(sep string) []string

ImageRepoNameVulnID is used as a unique key across images.

func (Finding) ImageRepositoryNames

func (f Finding) ImageRepositoryNames() []string

func (Finding) ImageTags added in v0.8.1

func (f Finding) ImageTags() []string

func (Finding) ToFinding added in v0.11.0

func (f Finding) ToFinding(opts FindingSpecOptions) []findingspec.Finding

ToFinding converts a single AWS Inspector2 finding into a slice of findingspec.Finding values, one per vulnerable package. Findings that are not package vulnerabilities return nil.

func (Finding) VendorCreatedAt

func (f Finding) VendorCreatedAt() *time.Time

func (Finding) VendorCreatedAtAgeMonths

func (f Finding) VendorCreatedAtAgeMonths() *float32

func (Finding) VendorSeverity

func (f Finding) VendorSeverity(canonical bool) string

func (Finding) VulnerabilityID

func (f Finding) VulnerabilityID() string

func (Finding) VulnerablePackages

func (f Finding) VulnerablePackages() Packages

func (Finding) VulnerablePackagesIDs added in v0.8.0

func (f Finding) VulnerablePackagesIDs() []string

func (Finding) VulnerablePackagesX added in v0.8.0

func (f Finding) VulnerablePackagesX() []Package

type FindingMerger added in v0.8.0

type FindingMerger struct {
	Data map[string]Findings
}

func NewFindingMerger added in v0.8.0

func NewFindingMerger() FindingMerger

func (*FindingMerger) Add added in v0.8.0

func (set *FindingMerger) Add(f ...types.Finding) error

func (*FindingMerger) Merge added in v0.8.0

func (set *FindingMerger) Merge() (Findings, error)

type FindingSpecOptions added in v0.11.0

type FindingSpecOptions struct {
	// Repo sets Location.Repo for multi-repo/workspace sweeps, optional.
	Repo string
}

FindingSpecOptions configures conversion of AWS Inspector2 findings to findingspec.

type Findings

type Findings []types.Finding

func (Findings) FilterImageHashes

func (fs Findings) FilterImageHashes(hashesIncl []string) Findings

func (Findings) FilterImageTags added in v0.8.1

func (fs Findings) FilterImageTags(tagsIncl []string) Findings

func (Findings) FilterPOMPropertiesExcl

func (fs Findings) FilterPOMPropertiesExcl() Findings

func (Findings) FindingOneRawMatch

func (fs Findings) FindingOneRawMatch(s string) *Finding

func (Findings) Findings added in v0.11.0

Findings converts a list of AWS Inspector2 findings into a findingspec.FindingSet of normalized security vulnerability findings. Each vulnerable package within a finding produces its own findingspec.Finding.

func (Findings) ImageHashes added in v0.8.0

func (fs Findings) ImageHashes() []string

ImageHashes returns a list of unique repo names

func (Findings) ImageRepoNameVulnIDs

func (fs Findings) ImageRepoNameVulnIDs(sep string) []string

ImageRepoNameVulnID is used as a unique key across images.

func (Findings) ImageRepoNameVulnIDsMapSeverity added in v0.8.0

func (fs Findings) ImageRepoNameVulnIDsMapSeverity() map[string][]string

ImageRepoNameVulnID is used as a unique key across images.

func (Findings) ImageRepositoryNames

func (fs Findings) ImageRepositoryNames() []string

ImageRepositoryNames returns a list of unique repo names

func (Findings) ImageSet added in v0.8.0

func (fs Findings) ImageSet(hashesIncl []string) (*ImageSet, error)

func (Findings) ImageSetRepoNameByTagsOrLatest added in v0.8.0

func (fs Findings) ImageSetRepoNameByTagsOrLatest(imageTagOverrides []string) (*ImageSet, error)

func (Findings) MergeByImageRepoNameAndVulnID added in v0.8.0

func (fs Findings) MergeByImageRepoNameAndVulnID() (Findings, error)

MergeByImageRepoNameAndVulnID merges select fields including images and packages.

func (Findings) MergeFilteredByImageRepoNameAndVulnID added in v0.8.0

func (fs Findings) MergeFilteredByImageRepoNameAndVulnID() (*types.Finding, error)

MergeFilteredByImageRepoNameAndVulnID merges select fields including images and packages. Image repo name and vulnid must be the same.

func (Findings) ResourceSet added in v0.8.0

func (fs Findings) ResourceSet(inclResourceTypes []types.ResourceType) (*ResourceSet, error)

func (Findings) Stats

func (fs Findings) Stats() FindingsStats

func (Findings) VulnerabilityIDs added in v0.8.0

func (fs Findings) VulnerabilityIDs() []string

type FindingsStats

type FindingsStats struct {
	Findings Findings
}

func (FindingsStats) FindingVulnerablePackageCounts

func (stats FindingsStats) FindingVulnerablePackageCounts() map[string]int

func (FindingsStats) ImagenameVulnidCounts

func (stats FindingsStats) ImagenameVulnidCounts() map[string]int

ImageRepoNameVulnID is used as a unique key across images.

func (FindingsStats) ImagenameVulnidRevCounts

func (stats FindingsStats) ImagenameVulnidRevCounts() map[string]int

func (FindingsStats) VendorCreatedAtMonthly

func (stats FindingsStats) VendorCreatedAtMonthly() map[string]int

func (FindingsStats) VendorCreatedAtYearly

func (stats FindingsStats) VendorCreatedAtYearly() map[string]int

func (FindingsStats) VendorSeverities

func (stats FindingsStats) VendorSeverities(canonicalSev bool) map[string]int

type ImageSet added in v0.8.0

type ImageSet struct {
	Data map[string]types.AwsEcrContainerImageDetails `json:"data"`
}

func NewImageSet added in v0.8.0

func NewImageSet() *ImageSet

func (*ImageSet) Add added in v0.8.0

func (set *ImageSet) Add(imgs ...types.AwsEcrContainerImageDetails) error

func (*ImageSet) FilterHashes added in v0.8.0

func (set *ImageSet) FilterHashes(hashesIncl []string) (*ImageSet, error)

func (*ImageSet) ImageByHash added in v0.8.0

func (set *ImageSet) ImageByHash(imgHash string) *types.AwsEcrContainerImageDetails

func (*ImageSet) ImageByLatest added in v0.8.0

func (set *ImageSet) ImageByLatest() *types.AwsEcrContainerImageDetails

func (*ImageSet) ImageHashes added in v0.8.0

func (set *ImageSet) ImageHashes() []string

func (*ImageSet) ImageSetsByRepoName added in v0.8.0

func (set *ImageSet) ImageSetsByRepoName() (*ImageSets, error)

func (*ImageSet) ImageTags added in v0.8.0

func (set *ImageSet) ImageTags() ([]string, map[string]int)

func (*ImageSet) ImagesByTag added in v0.8.0

func (set *ImageSet) ImagesByTag(imageTags []string) []types.AwsEcrContainerImageDetails

func (*ImageSet) ImagesByTagsOrLatest added in v0.8.0

func (set *ImageSet) ImagesByTagsOrLatest(imageTagOverrides []string) []types.AwsEcrContainerImageDetails

func (*ImageSet) RepositoryNames added in v0.8.0

func (set *ImageSet) RepositoryNames() ([]string, map[string]int)

func (*ImageSet) Table added in v0.8.0

func (set *ImageSet) Table() (*table.Table, error)

func (*ImageSet) WriteFileJSON added in v0.8.0

func (set *ImageSet) WriteFileJSON(filename, prefix, indent string, perm os.FileMode) error

func (*ImageSet) WriteFileXLSX added in v0.8.0

func (set *ImageSet) WriteFileXLSX(filename string) error

type ImageSets added in v0.8.0

type ImageSets struct {
	Data map[string]ImageSet
}

func NewImageSets added in v0.8.0

func NewImageSets() *ImageSets

func (*ImageSets) AddImagesByRepositoryName added in v0.8.0

func (sets *ImageSets) AddImagesByRepositoryName(imgs ...types.AwsEcrContainerImageDetails) error

func (*ImageSets) FilterLatestByRepositoryName added in v0.8.0

func (sets *ImageSets) FilterLatestByRepositoryName(imageTagOverrides []string) (*ImageSets, error)

func (*ImageSets) ImageSetByRepositoryNameTagsOrLatest added in v0.8.0

func (sets *ImageSets) ImageSetByRepositoryNameTagsOrLatest(repoTagOverrides []string) (*ImageSet, error)

type Package

type Package types.VulnerablePackage

func (Package) FilepathAtVersion

func (p Package) FilepathAtVersion() string

func (Package) FilepathAtVersionFixed

func (p Package) FilepathAtVersionFixed() string

func (Package) FilepathString

func (p Package) FilepathString() string

func (Package) NameAndFilepathAtVersion

func (p Package) NameAndFilepathAtVersion() string

func (Package) NameAndFilepathAtVersionFixed

func (p Package) NameAndFilepathAtVersionFixed() string

func (Package) NameAtVersion

func (p Package) NameAtVersion() string

func (Package) NameAtVersionAtFilepath added in v0.8.0

func (p Package) NameAtVersionAtFilepath() string

NameAtVersionAtFilepath can be treated as a package id.

func (Package) NameAtVersionFixed

func (p Package) NameAtVersionFixed() string

func (Package) NameString

func (p Package) NameString() string

func (Package) PackageType added in v0.8.2

func (p Package) PackageType() string

func (Package) VersionFixedString

func (p Package) VersionFixedString() string

func (Package) VersionString

func (p Package) VersionString() string

type Packages

type Packages []types.VulnerablePackage

func (Packages) Filepaths added in v0.8.0

func (ps Packages) Filepaths() []string

func (Packages) FilepathsAtVersion

func (ps Packages) FilepathsAtVersion() string

func (Packages) FilepathsAtVersionFixed

func (ps Packages) FilepathsAtVersionFixed() string

func (Packages) FilepathsContainsPOMProperties added in v0.8.0

func (ps Packages) FilepathsContainsPOMProperties() int

func (Packages) NameAtVersionAtFilepaths added in v0.8.0

func (ps Packages) NameAtVersionAtFilepaths() []string

func (Packages) NamesAndFilepathsAtVersion

func (ps Packages) NamesAndFilepathsAtVersion() string

func (Packages) NamesAndFilepathsAtVersionFixed

func (ps Packages) NamesAndFilepathsAtVersionFixed() string

func (Packages) PackagesManagers added in v0.8.2

func (ps Packages) PackagesManagers() []string

func (Packages) PackagesTypes added in v0.8.2

func (ps Packages) PackagesTypes() string

type Resource

type Resource types.Resource

func (Resource) HasTagsAny added in v0.8.0

func (r Resource) HasTagsAny(tagsAny []string) bool

func (Resource) ImageHash

func (r Resource) ImageHash() string

func (Resource) ImageRepositoryName

func (r Resource) ImageRepositoryName() string

func (Resource) ImageTagFirst

func (r Resource) ImageTagFirst() string

func (Resource) ImageTags added in v0.8.0

func (r Resource) ImageTags() []string

func (Resource) Values added in v0.8.0

func (r Resource) Values(fields []string) ([]string, error)

type ResourceSet added in v0.8.0

type ResourceSet struct {
	Set map[string]Resource
}

func NewResourceSet added in v0.8.0

func NewResourceSet() *ResourceSet

func (*ResourceSet) Add added in v0.8.0

func (rs *ResourceSet) Add(r Resource) error

func (*ResourceSet) FilterImageHash added in v0.8.0

func (rs *ResourceSet) FilterImageHash(hashesIncl []string) *ResourceSet

func (*ResourceSet) FilterImageTags added in v0.8.0

func (rs *ResourceSet) FilterImageTags(tagsAny []string) *ResourceSet

func (*ResourceSet) FilterResourceTypes added in v0.8.0

func (rs *ResourceSet) FilterResourceTypes(inclResourceTypes []types.ResourceType) (*ResourceSet, error)

func (*ResourceSet) ImageRepositoryNames added in v0.8.0

func (rs *ResourceSet) ImageRepositoryNames() []string

func (*ResourceSet) ImageSet added in v0.8.0

func (rs *ResourceSet) ImageSet(hashesIncl []string) (*ImageSet, error)

func (*ResourceSet) ImageTags added in v0.8.0

func (rs *ResourceSet) ImageTags() []string

func (*ResourceSet) Table added in v0.8.0

func (rs *ResourceSet) Table(cols []string, fmtMap map[int]string) (*table.Table, error)

type Resources added in v0.8.0

type Resources []types.Resource

func (Resources) ImageHashes added in v0.8.0

func (res Resources) ImageHashes() []string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL