rules

package

v1.0.0 Latest Latest Go to latest Published: Apr 17, 2025 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/harekrishnarai/flowlyt

Links

Documentation ¶

Index ¶

type Category
type Finding
type Rule
- func StandardRules() []Rule
type Severity

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Category ¶

type Category string

Category represents the category of a security rule

const (
	MaliciousPattern Category = "MALICIOUS_PATTERN"
	Misconfiguration Category = "MISCONFIGURATION"
	SecretExposure   Category = "SECRET_EXPOSURE"
	ShellObfuscation Category = "SHELL_OBFUSCATION"
	PolicyViolation  Category = "POLICY_VIOLATION"
)

type Finding ¶

type Finding struct {
	RuleID      string
	RuleName    string
	Description string
	Severity    Severity
	Category    Category
	FilePath    string
	JobName     string
	StepName    string
	Evidence    string
	Remediation string
	LineNumber  int // Line number where the issue was found
}

Finding represents a detected security issue

type Rule ¶

type Rule struct {
	ID          string
	Name        string
	Description string
	Severity    Severity
	Category    Category
	Check       func(workflow parser.WorkflowFile) []Finding
}

Rule represents a security rule to check in a workflow

func StandardRules ¶

func StandardRules() []Rule

StandardRules returns the list of built-in security rules

type Severity ¶

type Severity string

Severity represents the severity level of a finding

const (
	Critical Severity = "CRITICAL"
	High     Severity = "HIGH"
	Medium   Severity = "MEDIUM"
	Low      Severity = "LOW"
	Info     Severity = "INFO"
)

Source Files ¶

View all Source files

rules.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL