reporter

type ColorConfig struct {
	// contains filtered or unexported fields
}

type CsvReportingConfig struct {
	Path string
}

type CycloneDXReporterConfig struct {
	Tool ToolMetadata

	// Path defines the output file path
	Path string

	// Application component name, this is the top-level component in the BOM
	ApplicationComponentName string

	// Unique identifier for this BOM confirming to UUID RFC 4122 standard
	// If empty, a new UUID will be generated
	SerialNumber string
}

type DefectDojoProduct struct {
	ID            int       `json:"id"`
	FindingsCount int       `json:"findings_count"`
	FindingsList  []int     `json:"findings_list"`
	Tags          []string  `json:"tags"`
	Name          string    `json:"name"`
	Description   string    `json:"description"`
	Created       time.Time `json:"created"`
}

type DefectDojoReporterConfig struct {
	Tool               ToolMetadata
	IncludeVulns       bool
	IncludeMalware     bool
	ProductID          int
	EngagementName     string
	DefectDojoHostUrl  string
	DefectDojoApiV2Key string
}

type GitLabReporterConfig struct {
	Path string // Report path, value of --report-gitlab
	Tool ToolMetadata
}

type HtmlReportingConfig struct {
	Path string // Output path for HTML file
}

type JsonReportingConfig struct {
	Path string
	Tool ToolMetadata
}

type MarkdownReportingConfig struct {
	Path string
}

type MarkdownSummaryReporterConfig struct {
	Tool                   ToolMetadata
	Path                   string
	ReportTitle            string
	IncludeMalwareAnalysis bool
	ActiveMalwareAnalysis  bool
}

type Reporter interface {
	Name() string

	// Feed collected data to reporting module
	AddManifest(manifest *models.PackageManifest)
	AddAnalyzerEvent(event *analyzer.AnalyzerEvent)
	AddPolicyEvent(event *policy.PolicyEvent)

	// Inform reporting module to finalise (e.g. write report to file)
	Finish() error
}

type SarifReporterConfig struct {
	Tool           ToolMetadata
	IncludeVulns   bool
	IncludeMalware bool
	Path           string
}

type Severity string

type SkillReporterConfig struct {
	// Whether to show detailed evidence in output
	ShowEvidence bool
}

type Sqlite3ReporterConfig struct {
	Path      string
	Tool      ToolMetadata
	Overwrite bool
	Append    bool
}

type SummaryReporterConfig struct {
	MaxAdvice               int
	GroupByDirectDependency bool

	// This requires code analysis to be enabled with dependency
	// usage evidences to be available
	ShowOnlyPackagesWithEvidence bool
}

type SyncReporterCallbacks struct {
	OnSyncStart       func()
	OnSyncFinish      func()
	OnPackageSync     func(pkg *models.Package)
	OnPackageSyncDone func(pkg *models.Package)
	OnEventSync       func(event *analyzer.AnalyzerEvent)
	OnEventSyncDone   func(event *analyzer.AnalyzerEvent)
}

type SyncReporterConfig struct {
	// gRPC connection for ControlTower
	ClientConnection *grpc.ClientConn

	// Enable multi-project syncing
	// In this case, a new project is created per package manifest
	EnableMultiProjectSync bool

	// Required when scanning a single project
	ProjectName    string
	ProjectVersion string

	// Performance
	WorkerCount int

	// Tool details
	Tool ToolMetadata
}

type SyncReporterEnvResolver interface {
	// The resolved source of the runtime environment (e.g. GitHub)
	GetProjectSource() controltowerv1pb.Project_Source

	// The resolved URL of the runtime environment (e.g. GitHub repository URL)
	GetProjectURL() string

	// The trigger of the runtime environment (e.g. CI/CD pipeline)
	Trigger() controltowerv1.ToolTrigger

	// The Git reference of the runtime environment (e.g. branch, tag, commit)
	GitRef() string

	// The Git SHA of the runtime environment (e.g. commit hash)
	GitSha() string
}

type ToolMetadata struct {
	Name                 string
	Version              string
	Purl                 string
	InformationURI       string
	VendorName           string
	VendorInformationURI string
}