helpers

Documentation

Index

• func CustomConsoleWriter(fileLogger *zerolog.ConsoleWriter) zerolog.ConsoleWriter
• func FileAnalyzer(path string) (string, error)
• func GenerateReport(path, filename string, body interface{}, formats []string) error
• func GetDefaultQueryPath(queriesPath string) (string, error)
• func GetExecutableDirectory() string
• func InitShouldFailArg(args []string) error
• func InitShouldIgnoreArg(arg string) error
• func ListReportFormats() []string
• func PrintResult(summary *model.Summary, failedQueries map[string]error, printer *Printer) error
• func ResultsExitCode(summary *model.Summary) int
• func ShowError(kind string) bool
• func ValidateReportFormats(formats []string) error
• func WordWrap(s, identation string, limit int) string
• type Printer
  • func NewPrinter(minimal bool) *Printer
  • func (p *Printer) PrintBySev(content, sev string) string
• type ProgressBar
  • func NewProgressBar(label string, space int, total float64, progress chan float64) ProgressBar
  • func (p *ProgressBar) Start(wg *sync.WaitGroup)

Functions

func CustomConsoleWriter

func CustomConsoleWriter(fileLogger *zerolog.ConsoleWriter) zerolog.ConsoleWriter

CustomConsoleWriter creates an output to print log in a files

func FileAnalyzer

func FileAnalyzer(path string) (string, error)

FileAnalyzer determines the type of extension in the passed config file by its content

func GenerateReport

func GenerateReport(path, filename string, body interface{}, formats []string) error

GenerateReport execute each report function to generate report

func GetDefaultQueryPath

func GetDefaultQueryPath(queriesPath string) (string, error)

GetDefaultQueryPath - returns the default query path

func GetExecutableDirectory

func GetExecutableDirectory() string

GetExecutableDirectory - returns the path to the directory containing KICS executable

func InitShouldFailArg

func InitShouldFailArg(args []string) error

InitShouldFailArg initializes which kind of vulnerability severity should changes exit code

func InitShouldIgnoreArg

func InitShouldIgnoreArg(arg string) error

InitShouldIgnoreArg initializes what kind of errors should be used on exit codes

func ListReportFormats

func ListReportFormats() []string

ListReportFormats return a slice with all supported report formats

func PrintResult

func PrintResult(summary *model.Summary, failedQueries map[string]error, printer *Printer) error

PrintResult prints on output the summary results

func ResultsExitCode

func ResultsExitCode(summary *model.Summary) int

ResultsExitCode calculate exit code base on severity of results, returns 0 if no results was reported

func ShowError

func ShowError(kind string) bool

ShowError returns true if should show error, otherwise returns false

func ValidateReportFormats

func ValidateReportFormats(formats []string) error

ValidateReportFormats returns an error if output format is not supported

func WordWrap

func WordWrap(s, identation string, limit int) string

WordWrap Wraps text at the specified number of words

Types

type Printer

type Printer struct {
	Medium  color.RGBColor
	High    color.RGBColor
	Low     color.RGBColor
	Info    color.RGBColor
	Success color.RGBColor
	Line    color.RGBColor
	// contains filtered or unexported fields
}

Printer wil print console output with colors Medium is for medium sevevity results High is for high sevevity results Low is for low sevevity results Info is for info sevevity results Success is for successful prints Line is the color to print the line with the vulnerability minVersion is a bool that if true will print the results output in a minimum version

func NewPrinter

func NewPrinter(minimal bool) *Printer

NewPrinter initializes a new Printer

func (*Printer) PrintBySev

func (p *Printer) PrintBySev(content, sev string) string

PrintBySev will print the output with the specific severity color given the severity of the result

type ProgressBar

type ProgressBar struct {
	Writer io.Writer
	// contains filtered or unexported fields
}

ProgressBar represents a Progress Writer is the writer output for progress bar

func NewProgressBar

func NewProgressBar(label string, space int, total float64, progress chan float64) ProgressBar

NewProgressBar initializes a new ProgressBar label is a string print before the progress bar total is the progress bar target (a.k.a 100%) space is the number of '=' characters on each side of the bar progress is a channel updating the current executed elements

func (*ProgressBar) Start

func (p *ProgressBar) Start(wg *sync.WaitGroup)

Start starts to print a progress bar on console wg is a wait group to report when progress is done