reports

Documentation

Index

• Constants
• Variables
• func GenerateReport(ctx context.Context, task *asynq.Task) error
• func NodeIDToNodeName(ctx context.Context, nodeIds []string, node_type string) []string
• type Info
• type NodeWiseData
• type ScanData

Constants

const (
	VULNERABILITY    = "vulnerability"
	SBOM             = "sbom"
	SECRET           = "secret"
	MALWARE          = "malware"
	COMPLIANCE       = "compliance"
	CLOUD_COMPLIANCE = "cloud_compliance"
)

const (
	SYFT_JSON          = "syft-json"
	SPDX_JSON_2_2      = "spdx-json@2.2"
	SPDX_JSON_2_3      = "spdx-json@2.3"
	CYCLONEDX_JSON_1_5 = "cyclonedx-json@1.5"
)

Variables

var (
	//go:embed assets/df-logo.png
	DeepfenceLogo []byte
)

var ErrNotImplemented = errors.New("not implemented")

var ErrUnknownReportType = errors.New("unknown report type")

var (
	ErrUnknownSbomFormat = errors.New("unknown sbom format")
)

var ErrUnknownScanType = errors.New("unknown scan type")

var ErrorMaxRecords = errors.New("number of records in result is greater than ReportRecordsMax, apply more filters to reduce number of records in results")

Functions

func GenerateReport

func GenerateReport(ctx context.Context, task *asynq.Task) error

func NodeIDToNodeName

func NodeIDToNodeName(ctx context.Context, nodeIds []string, node_type string) []string

Types

type Info

type Info[T any] struct {
	ScanType       string
	Title          string
	StartTime      string
	EndTime        string
	AppliedFilters sdkUtils.ReportFilters
	NodeWiseData   NodeWiseData[T]
}

type NodeWiseData

type NodeWiseData[T any] struct {
	RecordCount   uint64
	SeverityCount map[string]map[string]int32
	ScanData      map[string]ScanData[T]
}

type ScanData

type ScanData[T any] struct {
	ScanInfo    model.ScanResultsCommon
	ScanResults []T
}