groupie

Documentation

Overview

Package groupie allows getting, saving and grouping vulnerabilities detected by Vulcan, making them easier to process by the end users.

Index

• func Classified(summary string) bool
• type Groupie
  • func New(db db.DB) *Groupie
  • func (g *Groupie) GroupByScan(scanID ...string) ([]models.Group, error)
  • func (g *Groupie) GroupByTarget(target ...string) ([]models.Group, error)
  • func (g *Groupie) UpdateFromScan(scanID string, date string, reports []report.Report) error
• type Results

Functions

func Classified

func Classified(summary string) bool

Classified specifies if a vulnerability is already classified in groupie or not.

Types

type Groupie

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

Groupie allows calling the package functions using an injected configuration and persistence layer.

func New

func New(db db.DB) *Groupie

New creates a Groupie instance given the injected config and db, and returns its address.

func (*Groupie) GroupByScan

func (g *Groupie) GroupByScan(scanID ...string) ([]models.Group, error)

GroupByScan returns the current vulnerabilities stored in the db for a given scan.

func (*Groupie) GroupByTarget

func (g *Groupie) GroupByTarget(target ...string) ([]models.Group, error)

GroupByTarget returns the current vulnerabilities stored in the db for the given targets.

func (*Groupie) UpdateFromScan

func (g *Groupie) UpdateFromScan(scanID string, date string, reports []report.Report) error

UpdateFromScan gets the vulnerabilities for the given scanID from Vulcan Core and stores them in the db.

type Results

type Results interface {
	ScanReports(ctx context.Context, ID string, workers int) ([]report.Report, error)
}

Results defines the methods required by the Groupie from a results client.