report

Documentation

Index

• Variables
• func CheckIfAzureContainerExists() error
• func CheckIfBucketExists() error
• func LoadOneScanHistory(jsonDir string) (scanHistory models.ScanHistory, err error)
• func RunTui(jsonDirName string) subcommands.ExitStatus
• func ToPlainTextSummary(r models.ScanResult) string
• type AzureBlobWriter
  • func (w AzureBlobWriter) Write(scanResults []models.ScanResult) (err error)
• type JSONDirs
  • func GetValidJSONDirs() (jsonDirs JSONDirs, err error)
  • func (d JSONDirs) Len() int
  • func (d JSONDirs) Less(i, j int) bool
  • func (d JSONDirs) Swap(i, j int)
• type JSONWriter
  • func (w JSONWriter) Write(scanResults []models.ScanResult) (err error)
• type LogrusWriter
  • func (w LogrusWriter) Write(scanResults []models.ScanResult) error
• type MailWriter
  • func (w MailWriter) Write(scanResults []models.ScanResult) (err error)
• type ResultWriter
• type S3Writer
  • func (w S3Writer) Write(scanResults []models.ScanResult) (err error)
• type SlackWriter
  • func (w SlackWriter) Write(scanResults []models.ScanResult) error
• type StdoutWriter
  • func (w StdoutWriter) Write(scanResults []models.ScanResult) error
• type TextFileWriter
  • func (w TextFileWriter) Write(scanResults []models.ScanResult) (err error)

Variables

var JSONDirPattern = regexp.MustCompile(`^\d{8}_\d{4}$`)

JSONDirPattern is file name pattern of JSON directory

Functions

func CheckIfAzureContainerExists

func CheckIfAzureContainerExists() error

CheckIfAzureContainerExists check the existence of Azure storage container

func CheckIfBucketExists

func CheckIfBucketExists() error

CheckIfBucketExists check the existence of S3 bucket

func LoadOneScanHistory

func LoadOneScanHistory(jsonDir string) (scanHistory models.ScanHistory, err error)

LoadOneScanHistory read JSON data

func RunTui

func RunTui(jsonDirName string) subcommands.ExitStatus

RunTui execute main logic

func ToPlainTextSummary

func ToPlainTextSummary(r models.ScanResult) string

ToPlainTextSummary format summary for plain text.

Types

type AzureBlobWriter

type AzureBlobWriter struct{}

AzureBlobWriter writes results to AzureBlob

func (AzureBlobWriter) Write

func (w AzureBlobWriter) Write(scanResults []models.ScanResult) (err error)

Write results to Azure Blob storage

type JSONDirs

type JSONDirs []string

JSONDirs array of json files path.

func GetValidJSONDirs

func GetValidJSONDirs() (jsonDirs JSONDirs, err error)

GetValidJSONDirs return valid json directory as array

func (JSONDirs) Len

func (d JSONDirs) Len() int

func (JSONDirs) Less

func (d JSONDirs) Less(i, j int) bool

func (JSONDirs) Swap

func (d JSONDirs) Swap(i, j int)

type JSONWriter

type JSONWriter struct {
	ScannedAt time.Time
}

JSONWriter writes results to file.

func (JSONWriter) Write

func (w JSONWriter) Write(scanResults []models.ScanResult) (err error)

type LogrusWriter

type LogrusWriter struct {
}

LogrusWriter write to logfile

func (LogrusWriter) Write

func (w LogrusWriter) Write(scanResults []models.ScanResult) error

type MailWriter

type MailWriter struct{}

MailWriter send mail

func (MailWriter) Write

func (w MailWriter) Write(scanResults []models.ScanResult) (err error)

type ResultWriter

type ResultWriter interface {
	Write([]models.ScanResult) error
}

ResultWriter Interface

type S3Writer

type S3Writer struct{}

S3Writer writes results to S3

func (S3Writer) Write

func (w S3Writer) Write(scanResults []models.ScanResult) (err error)

Write results to S3

type SlackWriter

type SlackWriter struct{}

SlackWriter send report to slack

func (SlackWriter) Write

func (w SlackWriter) Write(scanResults []models.ScanResult) error

type StdoutWriter

type StdoutWriter struct{}

StdoutWriter write to stdout

func (StdoutWriter) Write

func (w StdoutWriter) Write(scanResults []models.ScanResult) error

type TextFileWriter

type TextFileWriter struct {
	ScannedAt time.Time
}

TextFileWriter writes results to file.

func (TextFileWriter) Write

func (w TextFileWriter) Write(scanResults []models.ScanResult) (err error)