report

Documentation

Index

• Variables
• func CheckIfAzureContainerExists() error
• func CheckIfBucketExists() error
• func EnsureUUIDs(configPath string, results models.ScanResults) error
• func FillCveInfo(dbclient DBClient, r *models.ScanResult, cpeNames []string) error
• func FillCveInfos(dbclient DBClient, rs []models.ScanResult, dir string) ([]models.ScanResult, error)
• func FillWithOval(driver ovaldb.DB, r *models.ScanResult) (err error)
• func JSONDir(args []string) (string, error)
• func ListValidJSONDirs() (dirs []string, err error)
• func LoadScanResults(jsonDir string) (results models.ScanResults, err error)
• func NewCveDB(cType, cURL, cPath string, debug bool) (driver cvedb.DB, err error)
• func NewOvalDB(oType, oURL, oPath string, debug bool) (driver ovaldb.DB)
• func RunTui(results models.ScanResults) subcommands.ExitStatus
• type AzureBlobWriter
  • func (w AzureBlobWriter) Write(rs ...models.ScanResult) (err error)
• type DBClient
  • func NewDBClient(cType, cURL, cPath, oType, oURL, oPath string, debug bool) (dbclient DBClient, err error)
  • func (d DBClient) CloseDB()
• type EMailSender
  • func NewEMailSender() EMailSender
• type EMailWriter
  • func (w EMailWriter) Write(rs ...models.ScanResult) (err error)
• type LocalFileWriter
  • func (w LocalFileWriter) Write(rs ...models.ScanResult) (err error)
• type ResultWriter
• type S3Writer
  • func (w S3Writer) Write(rs ...models.ScanResult) (err error)
• type SlackWriter
  • func (w SlackWriter) Write(rs ...models.ScanResult) (err error)
• type StdoutWriter
  • func (w StdoutWriter) Write(rs ...models.ScanResult) error
  • func (w StdoutWriter) WriteScanSummary(rs ...models.ScanResult)

Variables

var CveClient cvedictClient

CveClient is api client of CVE disctionary service.

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 EnsureUUIDs

func EnsureUUIDs(configPath string, results models.ScanResults) error

EnsureUUIDs generate a new UUID of the scan target server if UUID is not assigned yet. And then set the generated UUID to config.toml and scan results.

func FillCveInfo

func FillCveInfo(dbclient DBClient, r *models.ScanResult, cpeNames []string) error

FillCveInfo fill scanResult with cve info.

func FillCveInfos

func FillCveInfos(dbclient DBClient, rs []models.ScanResult, dir string) ([]models.ScanResult, error)

FillCveInfos fills CVE Detailed Information

func FillWithOval

func FillWithOval(driver ovaldb.DB, r *models.ScanResult) (err error)

FillWithOval fetches OVAL database, and then set to fields.

func JSONDir

func JSONDir(args []string) (string, error)

JSONDir returns If there is an arg, check if it is a valid format and return the corresponding path under results. If arg passed via PIPE (such as history subcommand), return that path. Otherwise, returns the path of the latest directory

func ListValidJSONDirs

func ListValidJSONDirs() (dirs []string, err error)

ListValidJSONDirs returns valid json directory as array Returned array is sorted so that recent directories are at the head

func LoadScanResults

func LoadScanResults(jsonDir string) (results models.ScanResults, err error)

LoadScanResults read JSON data

func NewCveDB

func NewCveDB(cType, cURL, cPath string, debug bool) (driver cvedb.DB, err error)

NewCveDB returns cve db client

func NewOvalDB

func NewOvalDB(oType, oURL, oPath string, debug bool) (driver ovaldb.DB)

NewOvalDB returns oval db client

func RunTui

func RunTui(results models.ScanResults) subcommands.ExitStatus

RunTui execute main logic

Types

type AzureBlobWriter

type AzureBlobWriter struct{}

AzureBlobWriter writes results to AzureBlob

func (AzureBlobWriter) Write

func (w AzureBlobWriter) Write(rs ...models.ScanResult) (err error)

Write results to Azure Blob storage

type DBClient

type DBClient struct {
	CveDB  cvedb.DB
	OvalDB ovaldb.DB
}

DBClient is a dictionarie's db client for reporting

func NewDBClient

func NewDBClient(cType, cURL, cPath, oType, oURL, oPath string, debug bool) (dbclient DBClient, err error)

NewDBClient returns db clients

func (DBClient) CloseDB

func (d DBClient) CloseDB()

CloseDB close dbs

type EMailSender

type EMailSender interface {
	Send(subject, body string) error
}

EMailSender is interface of sending e-mail

func NewEMailSender

func NewEMailSender() EMailSender

NewEMailSender creates emailSender

type EMailWriter

type EMailWriter struct{}

EMailWriter send mail

func (EMailWriter) Write

func (w EMailWriter) Write(rs ...models.ScanResult) (err error)

type LocalFileWriter

type LocalFileWriter struct {
	CurrentDir string
}

LocalFileWriter writes results to a local file.

func (LocalFileWriter) Write

func (w LocalFileWriter) Write(rs ...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(rs ...models.ScanResult) (err error)

Write results to S3 http://docs.aws.amazon.com/sdk-for-go/latest/v1/developerguide/common-examples.title.html

type SlackWriter

type SlackWriter struct{}

SlackWriter send report to slack

func (SlackWriter) Write

func (w SlackWriter) Write(rs ...models.ScanResult) (err error)

type StdoutWriter

type StdoutWriter struct{}

StdoutWriter write to stdout

func (StdoutWriter) Write

func (w StdoutWriter) Write(rs ...models.ScanResult) error

func (StdoutWriter) WriteScanSummary

func (w StdoutWriter) WriteScanSummary(rs ...models.ScanResult)

WriteScanSummary prints Scan summary at the end of scan