core

Documentation

Index

• type FileProcessor
• type Finding
• type FindingIterator
• type FindingRepository
• type FindingSet
• type PostScanner
• type ReportStorage
• type Reporter
• type SqlQueries
• type SqlQuery

Types

type FileProcessor

type FileProcessor interface {
	Supports(filePath string) bool

	Process(path string, repoName string, content string) ([]Finding, error)
}

FileProcessor is an interface that defines a generic processor.

type Finding

type Finding struct {
	Name       string                 `json:"name,omitempty"`
	Type       string                 `json:"type,omitempty"`
	Category   string                 `json:"category,omitempty"`
	Properties map[string]interface{} `json:"properties,omitempty"`
	Path       string                 `json:"path,omitempty"`
	RepoName   string                 `json:"repo_name,omitempty"`
}

type FindingIterator

type FindingIterator interface {
	HasNext() bool
	Next() (FindingSet, error)
	Reset() error // New method to reset the iterator
}

type FindingRepository

type FindingRepository interface {
	Store(matches []Finding) error
	Clear() error
	NewIterator() FindingIterator
	Close() error // add this method
}

type FindingSet

type FindingSet struct {
	Matches []Finding `json:"matchSet"`
}

type PostScanner

type PostScanner interface {
	Scan(path, name string) ([]Finding, error)
}

type ReportStorage

type ReportStorage interface {
	Store(data []byte) error
}

type Reporter

type Reporter interface {
	Report(repository FindingRepository) error
}

type SqlQueries

type SqlQueries struct {
	Queries []SqlQuery `yaml:"queries"`
}

SqlQueries holds a collection of SqlQuery instances.

type SqlQuery

type SqlQuery struct {
	Name  string `yaml:"name"`
	Query string `yaml:"query"`
}