cmd

Documentation

Index

• Constants
• Variables
• func NewBundleCmd(newAsyncDecoder func() AsyncDecoder) *cobra.Command
• func NewConfigCmd(configMap map[string]any, configFileUsed string, configPath string) *cobra.Command
• func NewEPSSCmd(EPSSDownloadAgent io.Reader) *cobra.Command
• func NewExportCmd(ddService DDExportService, ddTimeout time.Duration, ...) *cobra.Command
• func NewPrintCommand(pipedFile *os.File, newAsyncDecoder func() AsyncDecoder) *cobra.Command
• func NewRootCommand(config CLIConfig) *cobra.Command
• func NewValidateCmd(newAsyncDecoder func() AsyncDecoder, KEVDownloadAgent io.Reader, ...) *cobra.Command
• func NewVersionCmd(version string) *cobra.Command
• type AWSExportService
• type AsyncDecoder
• type CLIConfig
• type DDExportService

Constants

const GatecheckLogo string = `` /* 589-byte string literal not displayed */

Variables

var (
	ErrorFileAccess     = errors.New("File Access Failure")
	ErrorEncoding       = errors.New("Encoding Failure")
	ErrorValidation     = errors.New("Validation Failure")
	ErrorAPI            = errors.New("API Failure")
	ErrorUserInput      = errors.New("User Input Failure")
	GlobalVerboseOutput = false
)

Functions

func NewBundleCmd

func NewBundleCmd(newAsyncDecoder func() AsyncDecoder) *cobra.Command

func NewConfigCmd

func NewConfigCmd(configMap map[string]any, configFileUsed string, configPath string) *cobra.Command

func NewEPSSCmd

func NewEPSSCmd(EPSSDownloadAgent io.Reader) *cobra.Command

func NewExportCmd

func NewExportCmd(
	ddService DDExportService,
	ddTimeout time.Duration,
	newAsyncDecoder func() AsyncDecoder,
	ddEngagement defectdojo.EngagementQuery,
	awsService AWSExportService,
	awsTimeout time.Duration,
) *cobra.Command

func NewPrintCommand

func NewPrintCommand(pipedFile *os.File, newAsyncDecoder func() AsyncDecoder) *cobra.Command

NewPrintCommand will pretty print a report file table, r can be piped input from standard out

func NewRootCommand

func NewRootCommand(config CLIConfig) *cobra.Command

func NewValidateCmd

func NewValidateCmd(newAsyncDecoder func() AsyncDecoder, KEVDownloadAgent io.Reader, EPSSDownloadAgent io.Reader) *cobra.Command

func NewVersionCmd

func NewVersionCmd(version string) *cobra.Command

Types

type AWSExportService

type AWSExportService interface {
	Export(context.Context, io.Reader, string) error
}

type AsyncDecoder

type AsyncDecoder interface {
	io.Writer
	Decode() (any, error)
	DecodeFrom(r io.Reader) (any, error)
	FileType() string
	Reset()
}

type CLIConfig

type CLIConfig struct {
	Version             string
	PipedInput          *os.File
	EPSSDownloadAgent   io.Reader
	KEVDownloadAgent    io.Reader
	DDExportService     DDExportService
	DDEngagement        defectdojo.EngagementQuery
	DDExportTimeout     time.Duration
	AWSExportService    AWSExportService
	AWSExportTimeout    time.Duration
	NewAsyncDecoderFunc func() AsyncDecoder
	ConfigMap           map[string]any
	ConfigFileUsed      string
	ConfigPath          string
}

type DDExportService

type DDExportService interface {
	Export(context.Context, io.Reader, defectdojo.EngagementQuery, defectdojo.ScanType) error
}