analyze

type AnalysisOptions struct {
	// MinSeverity filters risks below this severity level.
	MinSeverity RiskSeverity

	// Categories filters to only these categories (empty = all).
	Categories []RiskCategory

	// EnabledRules specifies which rules to run (empty = all).
	EnabledRules []string

	// DisabledRules specifies which rules to skip.
	DisabledRules []string
}

type RiskCategory string

type RiskSeverity string

type SecurityAnalysis struct {
	// ProtocolID identifies the analyzed protocol.
	ProtocolID string `json:"protocol_id"`

	// ProtocolName is the human-readable name.
	ProtocolName string `json:"protocol_name"`

	// AnalyzedAt is when the analysis was performed.
	AnalyzedAt time.Time `json:"analyzed_at"`

	// Risks contains all identified security risks.
	Risks []SecurityRisk `json:"risks"`

	// Summary provides aggregate statistics.
	Summary SecuritySummary `json:"summary"`
}

type SecurityRisk struct {
	// ID is a unique identifier for this risk type.
	ID string `json:"id"`

	// Severity indicates how serious the risk is.
	Severity RiskSeverity `json:"severity"`

	// Category classifies the type of risk.
	Category RiskCategory `json:"category"`

	// Title is a brief description of the risk.
	Title string `json:"title"`

	// Description provides detailed information about the risk.
	Description string `json:"description"`

	// Location identifies where in the protocol the risk was found.
	Location string `json:"location"`

	// Remediation provides guidance on how to address the risk.
	Remediation string `json:"remediation"`
}

type SecurityRule struct {
	// ID is a unique identifier for the rule.
	ID string

	// Name is a human-readable name.
	Name string

	// Description explains what the rule checks.
	Description string

	// Check runs the rule against a protocol and returns any risks found.
	Check func(p *pidl.Protocol) []SecurityRisk
}

type SecuritySummary struct {
	// TotalRisks is the total number of risks found.
	TotalRisks int `json:"total_risks"`

	// BySeverity breaks down risks by severity level.
	BySeverity map[RiskSeverity]int `json:"by_severity"`

	// ByCategory breaks down risks by category.
	ByCategory map[RiskCategory]int `json:"by_category"`

	// Score is a numeric security score (0-100, higher is better).
	Score int `json:"score"`
}