security_advisory

Documentation

Overview

Package security_advisory provides necessary interfaces and implementations for creating alerts of type security advisory.

Index

• Constants
• type Alert
  • func NewSecurityAdvisoryAlert(actionType interfaces.ActionType, ruleType *pb.RuleType, ...) (*Alert, error)
  • func (alert *Alert) Class() interfaces.ActionType
  • func (alert *Alert) Do(ctx context.Context, cmd interfaces.ActionCmd, ...) (json.RawMessage, error)
  • func (alert *Alert) GetOnOffState() models.ActionOpt
  • func (_ *Alert) Type() string

Constants

const (
	// AlertType is the type of the security advisory alert engine
	AlertType = "security_advisory"
)

Types

type Alert

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

Alert is the structure backing the security-advisory alert action

func NewSecurityAdvisoryAlert

func NewSecurityAdvisoryAlert(
	actionType interfaces.ActionType,
	ruleType *pb.RuleType,
	saCfg *pb.RuleType_Definition_Alert_AlertTypeSA,
	cli provifv1.GitHub,
	setting models.ActionOpt,
) (*Alert, error)

NewSecurityAdvisoryAlert creates a new security-advisory alert action

func (*Alert) Class

func (alert *Alert) Class() interfaces.ActionType

Class returns the action type of the security-advisory engine

func (*Alert) Do

func (alert *Alert) Do(
	ctx context.Context,
	cmd interfaces.ActionCmd,
	entity protoreflect.ProtoMessage,
	params interfaces.ActionsParams,
	metadata *json.RawMessage,
) (json.RawMessage, error)

Do alerts through security advisory

func (*Alert) GetOnOffState

func (alert *Alert) GetOnOffState() models.ActionOpt

GetOnOffState returns the alert action state read from the profile

func (*Alert) Type

func (_ *Alert) Type() string

Type returns the action subtype of the remediation engine