rule

Documentation

Index

• Constants
• func CreateCustomRule(c api.Client, rule CustomRule) (int, error)
• func DeleteCustomRule(c api.Client, id int) error
• func GenerateCustomRuleId(c api.Client) (int, error)
• func UpdateCustomRule(c api.Client, rule CustomRule) error
• type CustomRule
  • func GetCustomRuleById(c api.Client, id int) (*CustomRule, error)
  • func GetCustomRuleByName(c api.Client, name string) (*CustomRule, error)
  • func ListCustomRules(c api.Client) ([]CustomRule, error)

Constants

const CustomRulesEndpoint = "api/v1/custom-rules"

Functions

func CreateCustomRule

func CreateCustomRule(c api.Client, rule CustomRule) (int, error)

Create a new custom rule.

func DeleteCustomRule

func DeleteCustomRule(c api.Client, id int) error

Delete an existing custom rule.

func GenerateCustomRuleId

func GenerateCustomRuleId(c api.Client) (int, error)

Helper method to generate an ID for new custom rule. Finds the maximum custom rule ID and increments it by 1.

func UpdateCustomRule

func UpdateCustomRule(c api.Client, rule CustomRule) error

Update an existing custom rule.

Types

type CustomRule

type CustomRule struct {
	Id               int      `json:"_id,omitempty"`
	AttackTechniques []string `json:"attackTechniques,omitempty"`
	Description      string   `json:"description,omitempty"`
	Message          string   `json:"message,omitempty"`
	MinVersion       string   `json:"minVersion,omitempty"`
	Name             string   `json:"name,omitempty"`
	Script           string   `json:"script,omitempty"`
	Type             string   `json:"type,omitempty"`
	VulnIDs          []string `json:"vulnIds,omitempty"`
}

func GetCustomRuleById

func GetCustomRuleById(c api.Client, id int) (*CustomRule, error)

Get a specific custom rule by ID.

func GetCustomRuleByName

func GetCustomRuleByName(c api.Client, name string) (*CustomRule, error)

Get a specific custom rule by name.

func ListCustomRules

func ListCustomRules(c api.Client) ([]CustomRule, error)

Get all custom rules.