signature

Documentation

Index

• type Signature
  • func DefaultSignatures(log *logging.Logger) []Signature
  • func NewStdViaSocketSignature(log *logging.Logger) Signature
• type SignatureEngine
  • func NewEngine(signatures []Signature, log *logging.Logger, cfg SignatureEngineConfig) *SignatureEngine
  • func (e *SignatureEngine) EventInput() chan<- *types.Event
  • func (e *SignatureEngine) Events() <-chan *castpb.Event
  • func (e *SignatureEngine) QueueEvent(event *types.Event)
  • func (e *SignatureEngine) Run(ctx context.Context) error
  • func (e *SignatureEngine) TargetEvents() []events.ID
• type SignatureEngineConfig
• type SignatureMetadata
• type StdioViaSocket
  • func (*StdioViaSocket) GetMetadata() SignatureMetadata
  • func (s *StdioViaSocket) OnEvent(event *types.Event) *v1.SignatureFinding

Types

type Signature

type Signature interface {
	GetMetadata() SignatureMetadata

	OnEvent(event *types.Event) *castpb.SignatureFinding
}

func DefaultSignatures

func DefaultSignatures(log *logging.Logger) []Signature

func NewStdViaSocketSignature

func NewStdViaSocketSignature(log *logging.Logger) Signature

type SignatureEngine

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

func NewEngine

func NewEngine(signatures []Signature, log *logging.Logger, cfg SignatureEngineConfig) *SignatureEngine

func (*SignatureEngine) EventInput

func (e *SignatureEngine) EventInput() chan<- *types.Event

func (*SignatureEngine) Events

func (e *SignatureEngine) Events() <-chan *castpb.Event

func (*SignatureEngine) QueueEvent

func (e *SignatureEngine) QueueEvent(event *types.Event)

func (*SignatureEngine) Run

func (e *SignatureEngine) Run(ctx context.Context) error

func (*SignatureEngine) TargetEvents

func (e *SignatureEngine) TargetEvents() []events.ID

type SignatureEngineConfig

type SignatureEngineConfig struct {
	InputChanSize  int `validate:"required"`
	OutputChanSize int `validate:"required"`
}

type SignatureMetadata

type SignatureMetadata struct {
	ID           castpb.SignatureEventID
	Name         string
	Version      string
	TargetEvents []events.ID
}

type StdioViaSocket

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

func (*StdioViaSocket) GetMetadata

func (*StdioViaSocket) GetMetadata() SignatureMetadata

func (*StdioViaSocket) OnEvent

func (s *StdioViaSocket) OnEvent(event *types.Event) *v1.SignatureFinding