results

Documentation

Index

• type Finding
  • func (f *Finding) GenerateFindingFingerprint() string
• type FindingMeta
  • func (m *FindingMeta) UnmarshalJSON(data []byte) error
• type FindingsResult
• type Rule
• type RuleConfig

Types

type Finding

type Finding struct {
	RuleId string      `json:"rule_id"`
	Purl   string      `json:"purl"`
	Meta   FindingMeta `json:"meta"`
}

func (*Finding) GenerateFindingFingerprint

func (f *Finding) GenerateFindingFingerprint() string

type FindingMeta

type FindingMeta struct {
	Path          string   `json:"path,omitempty"`
	Line          int      `json:"line,omitempty"`
	Job           string   `json:"job,omitempty"`
	Step          string   `json:"step,omitempty"`
	OsvId         string   `json:"osv_id,omitempty"`
	Details       string   `json:"details,omitempty"`
	EventTriggers []string `json:"event_triggers,omitempty"`
	BlobSHA       string   `json:"blobsha,omitempty"`
}

func (*FindingMeta) UnmarshalJSON

func (m *FindingMeta) UnmarshalJSON(data []byte) error

type FindingsResult

type FindingsResult struct {
	Findings []Finding       `json:"findings"`
	Rules    map[string]Rule `json:"rules"`
}

type Rule

type Rule struct {
	Id          string `json:"id"`
	Title       string `json:"title"`
	Description string `json:"description"`
	Level       string `json:"level"`
	Refs        []struct {
		Ref         string `json:"ref"`
		Description string `json:"description"`
	} `json:"refs,omitempty"`
	Config map[string]RuleConfig `json:"config,omitempty"`
}

type RuleConfig

type RuleConfig struct {
	Default     interface{} `json:"default"`
	Description string      `json:"description"`
	Value       interface{} `json:"value"`
}