opa

Documentation

Index

• func Capabilities() (*ast.Capabilities, error)
• type Finding
  • func (f *Finding) GenerateFindingFingerprint() string
• type FindingMeta
  • func (m *FindingMeta) UnmarshalJSON(data []byte) error
• type FindingsResult
• type InventoryResult
• type Opa
  • func NewOpa() (*Opa, error)
  • func (o *Opa) Compile(ctx context.Context) error
  • func (o *Opa) Eval(ctx context.Context, query string, input map[string]interface{}, ...) error
  • func (o *Opa) Print(ctx print.Context, s string) error
  • func (o *Opa) WithConfig(ctx context.Context, config *models.Config) error
• type Rule

Functions

func Capabilities

func Capabilities() (*ast.Capabilities, error)

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"`
}

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 InventoryResult

type InventoryResult struct {
	BuildDependencies   []string `json:"build_dependencies"`
	PackageDependencies []string `json:"package_dependencies"`
}

type Opa

type Opa struct {
	Compiler  *ast.Compiler
	Store     storage.Store
	LoadPaths []string
}

func NewOpa

func NewOpa() (*Opa, error)

func (*Opa) Compile

func (o *Opa) Compile(ctx context.Context) error

func (*Opa) Eval

func (o *Opa) Eval(ctx context.Context, query string, input map[string]interface{}, result interface{}) error

func (*Opa) Print

func (o *Opa) Print(ctx print.Context, s string) error

func (*Opa) WithConfig

func (o *Opa) WithConfig(ctx context.Context, config *models.Config) error

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"`
}