gatecheck

Documentation

Index

• Variables
• func AppendToBundle(bundleRWS io.ReadWriteSeeker, src io.Reader, label string, tags []string) error
• func CreateBundle(dstBundle io.Writer, src io.Reader, label string, tags []string) error
• func DownloadEPSS(w io.Writer, optionFuncs ...optionFunc) error
• func DownloadKEV(w io.Writer, optionFuncs ...optionFunc) error
• func EncodeConfigTo(w io.Writer, config *Config, format string) error
• func List(dst io.Writer, src io.Reader, inputFilename string, options ...ListOptionFunc) error
• func ListCyclonedx(dst io.Writer, src io.Reader) (*tablewriter.Table, error)
• func ListGrypeReport(dst io.Writer, src io.Reader) (*tablewriter.Table, error)
• func ListSemgrep(dst io.Writer, src io.Reader) (*tablewriter.Table, error)
• func LoadCatalogAndData(config *Config, catalog *kev.Catalog, epssData *epss.Data, ...) error
• func RemoveFromBundle(bundleRWS io.ReadWriteSeeker, label string) error
• func Validate(config *Config, reportSrc io.Reader, targetfilename string, ...) error
• func WithDisplayFormat(displayFormat string) func(*listOptions)
• func WithEPSS(epssFile *os.File, epssURL string) (func(*listOptions), error)
• func WithEPSSFile(r io.Reader) optionFunc
• func WithEPSSURL(url string) optionFunc
• func WithKEVFile(r io.Reader) optionFunc
• func WithKEVURL(url string) optionFunc
• func WriteDefaultConfig(w io.Writer, format string) error
• type ApplicationMetadata
  • func (m ApplicationMetadata) String() string
  • func (m ApplicationMetadata) WriteTo(w io.Writer) (int64, error)
• type Config
  • func NewDefaultConfig() *Config
  • func (c *Config) String() string
• type ConfigDecoder
  • func NewConfigDecoder(filename string) *ConfigDecoder
  • func (d *ConfigDecoder) Decode(config *Config) error
• type ConfigEncoder
  • func NewConfigEncoder(w io.Writer, ext string) *ConfigEncoder
  • func (e *ConfigEncoder) Encode(config *Config) error
• type ListOptionFunc

Variables

var ErrValidationFailure = errors.New("Validation Failure")

Functions

func AppendToBundle

func AppendToBundle(bundleRWS io.ReadWriteSeeker, src io.Reader, label string, tags []string) error

AppendToBundle adds a file to an existing bundle

If the bundle doesn't exist, use CreateBundle

func CreateBundle

func CreateBundle(dstBundle io.Writer, src io.Reader, label string, tags []string) error

CreateBundle create a new bundle with a file

If the bundle already exist, use CreateBundle. this function will completely overwrite an existing bundle

func DownloadEPSS

func DownloadEPSS(w io.Writer, optionFuncs ...optionFunc) error

func DownloadKEV

func DownloadKEV(w io.Writer, optionFuncs ...optionFunc) error

func EncodeConfigTo

func EncodeConfigTo(w io.Writer, config *Config, format string) error

func List

func List(dst io.Writer, src io.Reader, inputFilename string, options ...ListOptionFunc) error

func ListCyclonedx

func ListCyclonedx(dst io.Writer, src io.Reader) (*tablewriter.Table, error)

func ListGrypeReport

func ListGrypeReport(dst io.Writer, src io.Reader) (*tablewriter.Table, error)

func ListSemgrep

func ListSemgrep(dst io.Writer, src io.Reader) (*tablewriter.Table, error)

func LoadCatalogAndData

func LoadCatalogAndData(config *Config, catalog *kev.Catalog, epssData *epss.Data, options *fetchOptions) error

func RemoveFromBundle

func RemoveFromBundle(bundleRWS io.ReadWriteSeeker, label string) error

RemoveFromBundle removes a file from an existing bundle

func Validate

func Validate(config *Config, reportSrc io.Reader, targetfilename string, optionFuncs ...optionFunc) error

Validate against config thresholds

func WithDisplayFormat

func WithDisplayFormat(displayFormat string) func(*listOptions)

func WithEPSS

func WithEPSS(epssFile *os.File, epssURL string) (func(*listOptions), error)

func WithEPSSFile

func WithEPSSFile(r io.Reader) optionFunc

func WithEPSSURL

func WithEPSSURL(url string) optionFunc

WithEPSSURL optionFunc that sets the fetch URL for EPSS data

Will use the default option if "" is passed

func WithKEVFile

func WithKEVFile(r io.Reader) optionFunc

func WithKEVURL

func WithKEVURL(url string) optionFunc

WithKEVURL optionFunc that sets the fetch URL for KEV data

Will use the default option if "" is passed

func WriteDefaultConfig

func WriteDefaultConfig(w io.Writer, format string) error

Types

type ApplicationMetadata

type ApplicationMetadata struct {
	CLIVersion     string
	GitCommit      string
	BuildDate      string
	GitDescription string
	Platform       string
	GoVersion      string
	Compiler       string
}

ApplicationMetadata ...

func (ApplicationMetadata) String

func (m ApplicationMetadata) String() string

func (ApplicationMetadata) WriteTo

func (m ApplicationMetadata) WriteTo(w io.Writer) (int64, error)

type Config

type Config struct {
	Version   string               `json:"version"   toml:"version"   yaml:"version"`
	Metadata  configMetadata       `json:"metadata"  toml:"metadata"  yaml:"metadata"`
	Grype     reportWithCVEs       `json:"grype"     toml:"grype"     yaml:"grype"`
	Cyclonedx reportWithCVEs       `json:"cyclonedx" toml:"cyclonedx" yaml:"cyclonedx"`
	Semgrep   configSemgrepReport  `json:"semgrep"   toml:"semgrep"   yaml:"semgrep"`
	Gitleaks  configGitleaksReport `json:"gitleaks"  toml:"gitleaks"  yaml:"gitleaks"`
}

Config is used to set limits and allowances during validation

The report can be encoded/decoded into json, yaml, or toml Metadata fields are intended for arbitrary data and shouldn't conflict with rule validation

func NewDefaultConfig

func NewDefaultConfig() *Config

func (*Config) String

func (c *Config) String() string

type ConfigDecoder

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

func NewConfigDecoder

func NewConfigDecoder(filename string) *ConfigDecoder

func (*ConfigDecoder) Decode

func (d *ConfigDecoder) Decode(config *Config) error

type ConfigEncoder

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

func NewConfigEncoder

func NewConfigEncoder(w io.Writer, ext string) *ConfigEncoder

func (*ConfigEncoder) Encode

func (e *ConfigEncoder) Encode(config *Config) error

type ListOptionFunc

type ListOptionFunc func(*listOptions)