kics

Documentation

Index

• func PrepareScanDocument(body map[string]interface{}, kind model.FileKind) map[string]interface{}
• type Content
• type Service
  • func (s *Service) GetScanSummary(ctx context.Context, scanIDs []string) ([]model.SeveritySummary, error)
  • func (s *Service) GetVulnerabilities(ctx context.Context, scanID string) ([]model.Vulnerability, error)
  • func (s *Service) PrepareSources(ctx context.Context, scanID string, openAPIResolveReferences bool, ...)
  • func (s *Service) StartScan(ctx context.Context, scanID string, errCh chan<- error, wg *sync.WaitGroup, ...)
• type Storage
• type Tracker

Functions

func PrepareScanDocument

func PrepareScanDocument(body map[string]interface{}, kind model.FileKind) map[string]interface{}

PrepareScanDocument removes _kics_lines from payload and parses json filters

Types

type Content

type Content struct {
	Content    *[]byte
	CountLines int
	IsMinified bool
}

Content keeps the content of the file and the number of lines

type Service

type Service struct {
	SourceProvider   provider.SourceProvider
	Storage          Storage
	Parser           *parser.Parser
	Inspector        *engine.Inspector
	SecretsInspector *secrets.Inspector
	Tracker          Tracker
	Resolver         *resolver.Resolver

	MaxFileSize int
	// contains filtered or unexported fields
}

Service is a struct that contains a SourceProvider to receive sources, a storage to save and retrieve scanning informations a parser to parse and provide files in format that KICS understand, a inspector that runs the scanning and a tracker to update scanning numbers

func (*Service) GetScanSummary

func (s *Service) GetScanSummary(ctx context.Context, scanIDs []string) ([]model.SeveritySummary, error)

GetScanSummary returns how many vulnerabilities of each severity was found

func (*Service) GetVulnerabilities

func (s *Service) GetVulnerabilities(ctx context.Context, scanID string) ([]model.Vulnerability, error)

GetVulnerabilities returns a list of scan detected vulnerabilities

func (*Service) PrepareSources

func (s *Service) PrepareSources(ctx context.Context,
	scanID string,
	openAPIResolveReferences bool,
	wg *sync.WaitGroup, errCh chan<- error)

PrepareSources will prepare the sources to be scanned

func (*Service) StartScan

func (s *Service) StartScan(
	ctx context.Context,
	scanID string,
	errCh chan<- error,
	wg *sync.WaitGroup,
	currentQuery chan<- int64)

StartScan executes scan over the context, using the scanID as reference

type Storage

type Storage interface {
	SaveFile(ctx context.Context, metadata *model.FileMetadata) error
	SaveVulnerabilities(ctx context.Context, vulnerabilities []model.Vulnerability) error
	GetVulnerabilities(ctx context.Context, scanID string) ([]model.Vulnerability, error)
	GetScanSummary(ctx context.Context, scanIDs []string) ([]model.SeveritySummary, error)
}

Storage is the interface that wraps following basic methods: SaveFile, SaveVulnerability, GetVulnerability and GetScanSummary SaveFile should append metadata to a file SaveVulnerabilities should append vulnerabilities list to current storage GetVulnerabilities should returns all vulnerabilities associated to a scan ID GetScanSummary should return a list of summaries based on their scan IDs

type Tracker

type Tracker interface {
	TrackFileFound(path string)
	TrackFileParse(path string)
	TrackFileFoundCountLines(countLines int)
	TrackFileParseCountLines(countLines int)
	TrackFileIgnoreCountLines(countLines int)
}

Tracker is the interface that wraps the basic methods: TrackFileFound and TrackFileParse TrackFileFound should increment the number of files to be scanned TrackFileParse should increment the number of files parsed successfully to be scanned