securityhub

Documentation

Index

• Variables
• type Controller
  • func NewController() Controller
• type Option
  • func WithArtifact(enable bool) Option
  • func WithCVE(enable bool) Option
• type Options

Variables

var Ctl = NewController()

Ctl is the global controller for security hub

Types

type Controller

type Controller interface {
	// SecuritySummary returns the security summary of the specified project.
	SecuritySummary(ctx context.Context, projectID int64, options ...Option) (*secHubModel.Summary, error)
	// ListVuls list vulnerabilities by query
	ListVuls(ctx context.Context, scannerUUID string, projectID int64, withTag bool, query *q.Query) ([]*secHubModel.VulnerabilityItem, error)
	// CountVuls get all vulnerability count by query
	CountVuls(ctx context.Context, scannerUUID string, projectID int64, tuneCount bool, query *q.Query) (int64, error)
}

Controller controller of security hub

func NewController

func NewController() Controller

NewController ...

type Option

type Option func(*Options)

Option define the func to build options

func WithArtifact

func WithArtifact(enable bool) Option

WithArtifact enable artifact info in summary

func WithCVE

func WithCVE(enable bool) Option

WithCVE enable CVE info in summary

type Options

type Options struct {
	WithCVE      bool
	WithArtifact bool
}

Options define the option to query summary info