rule

package

v0.4.0 Latest Latest Go to latest Published: Feb 9, 2026 License: MIT Imports: 2 Imported by: 0

Details

Package rule defines rules and their results.

This section is empty.

This section is empty.

func FilterRules[T Rule](rules []T, filter *TargetFilter) []T

FilterRules returns only rules matching the filter. Returns all rules if filter is nil.

type Applicability struct {
	Platform  binary.Platform
	Compilers map[toolchain.Compiler]CompilerRequirement
}

Applicability defines which platforms and compilers a rule applies to.

type CompilerRequirement struct {
	MinVersion     toolchain.Version
	DefaultVersion toolchain.Version
	Flag           string
}

CompilerRequirement specifies version and flag requirements for a compiler.

type CompilerTarget struct {
	Compiler   toolchain.Compiler
	MaxVersion *toolchain.Version
}

CompilerTarget specifies a compiler constraint for filtering rules.

type ELFRule interface {
	Rule
	Execute(bin *binary.ELFBinary) Result
}

ELFRule is a Rule that operates on ELF binaries.

type Finding struct {
	Result
	RuleID string
	Name   string
}

Finding is a Result with rule metadata attached.

type PlatformTarget struct {
	Architecture binary.Architecture
	MaxISA       *binary.ISA
}

PlatformTarget specifies an architecture constraint for filtering rules.

type Result struct {
	Status  Status
	Message string
}

Result is the outcome of executing a rule.

type Rule interface {
	ID() string
	Name() string
	Description() string
	Applicability() Applicability
}

Rule is a check that can be executed against a binary.

type Status int

Status indicates whether a rule passed, failed, or was skipped.

const (
	StatusPassed Status = iota
	StatusFailed
	StatusSkipped
)

func (s Status) String() string

type TargetFilter struct {
	Platforms []PlatformTarget
	Compilers []CompilerTarget
}

TargetFilter selects rules based on platform and compiler constraints.

Path	Synopsis
elf Package elf provides built-in ELF security hardening rules.	Package elf provides built-in ELF security hardening rules.