kics

Documentation

Index

• 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) StartScan(ctx context.Context, scanID string) error
• type SourceProvider
• type Storage
• type Tracker

Types

type Service

type Service struct {
	SourceProvider SourceProvider
	Storage        Storage
	Parser         *parser.Parser
	Inspector      *engine.Inspector
	Tracker        Tracker
}

func (*Service) GetScanSummary

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

func (*Service) GetVulnerabilities

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

func (*Service) StartScan

func (s *Service) StartScan(ctx context.Context, scanID string) error

type SourceProvider

type SourceProvider interface {
	GetSources(ctx context.Context, scanID string, extensions model.Extensions, sink source.Sink) error
}

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)
}

type Tracker

type Tracker interface {
	TrackFileFound()
	TrackFileParse()
}