processor

package

Go to main page

Versions in this module

v1

v1.4.0

Apr 3, 2026

v1.3.0

Mar 23, 2026

Changes in this version

type ConfigInfo

+ DeviceType common.DeviceType

type Report

+ DeviceType common.DeviceType

type ValidationError

+ func ValidateCommonDevice(cfg *common.CommonDevice) []ValidationError

v1.2.2

Feb 12, 2026

v1.2.0

Feb 11, 2026

Changes in this version

type Statistics

+ IDSDetectionProfile string

+ IDSEnabled bool

+ IDSLoggingEnabled bool

+ IDSMode string

+ IDSMonitoredInterfaces []string

v1.1.0

Feb 3, 2026

Changes in this version

+ const DefaultJobQueueSize

+ const DefaultWorkerCount

+ var ErrWorkerPoolClosed = errors.New("worker pool is closed")

+ type Job struct

+ ID string

+ Input T

+ Process func(ctx context.Context, input T) (R, error)

+ type Result struct

+ Err error

+ JobID string

+ Value R

+ func ProcessBatch[T, R any](ctx context.Context, inputs []T, ...) ([]Result[R], error)

type Statistics

+ TotalGatewayGroups int

+ TotalGateways int

+ type WorkerPool struct

+ func NewWorkerPool[T, R any](ctx context.Context, opts ...WorkerPoolOption[T, R]) *WorkerPool[T, R]

+ func (wp *WorkerPool[T, R]) Cancel()

+ func (wp *WorkerPool[T, R]) Close()

+ func (wp *WorkerPool[T, R]) IsClosed() bool

+ func (wp *WorkerPool[T, R]) Results() <-chan Result[R]

+ func (wp *WorkerPool[T, R]) Submit(job Job[T, R]) error

+ func (wp *WorkerPool[T, R]) WorkerCount() int

+ type WorkerPoolOption func(*WorkerPool[T, R])

+ func WithMaxRetries[T, R any](retries int) WorkerPoolOption[T, R]

+ func WithWorkerCount[T, R any](count int) WorkerPoolOption[T, R]

v1.0.0

Aug 4, 2025

Changes in this version

+ const FindingTypeSecurity

+ const NetworkAny

+ const NoConfigAvailable

+ const ProtocolHTTPS

+ const RuleTypePass

+ const StatusEnabled

+ const StatusNotEnabled

+ const ThemeDark

+ const ThemeLight

+ var ErrConfigurationNil = errors.New("configuration cannot be nil")

+ var ErrNormalizedConfigUnavailable = errors.New("no normalized configuration available for markdown conversion")

+ func ExampleUsage(cfg *model.OpnSenseDocument)

+ func NewTestError(id int, message string) error

+ func ProcessConfigFromFile(configPath string) error

+ type Config struct

+ EnableComplianceCheck bool

+ EnableDeadRuleCheck bool

+ EnablePerformanceAnalysis bool

+ EnableSecurityAnalysis bool

+ EnableStats bool

+ func DefaultConfig() *Config

+ func (c *Config) ApplyOptions(opts ...Option)

+ type ConfigInfo struct

+ Domain string

+ Hostname string

+ Theme string

+ Version string

+ type CoreProcessor struct

+ func NewCoreProcessor() (*CoreProcessor, error)

+ func (p *CoreProcessor) Process(ctx context.Context, cfg *model.OpnSenseDocument, opts ...Option) (*Report, error)

+ func (p *CoreProcessor) Transform(ctx context.Context, report *Report, format string) (string, error)

+ type CustomCheck struct

+ CheckFunc func(*model.OpnSenseDocument) []Finding

+ Description string

+ Name string

+ func ExampleCustomCheck() CustomCheck

+ type CustomProcessorExample struct

+ func NewCustomProcessor(customChecks []CustomCheck) *CustomProcessorExample

+ func (p *CustomProcessorExample) Process(ctx context.Context, cfg *model.OpnSenseDocument, opts ...Option) (*Report, error)

+ type DHCPScopeStatistics struct

+ Enabled bool

+ From string

+ Interface string

+ To string

+ type ExampleProcessor struct

+ func NewExampleProcessor() *ExampleProcessor

+ func (p *ExampleProcessor) Process(ctx context.Context, cfg *model.OpnSenseDocument, opts ...Option) (*Report, error)

+ type Finding struct

+ Component string

+ Description string

+ Recommendation string

+ Reference string

+ Title string

+ Type string

+ type Findings struct

+ Critical []Finding

+ High []Finding

+ Info []Finding

+ Low []Finding

+ Medium []Finding

+ type InterfaceStatistics struct

+ BlockBogons bool

+ BlockPriv bool

+ Enabled bool

+ HasDHCP bool

+ HasIPv4 bool

+ HasIPv6 bool

+ Name string

+ Type string

+ type Option func(*Config)

+ func WithAllFeatures() Option

+ func WithComplianceCheck() Option

+ func WithDeadRuleCheck() Option

+ func WithPerformanceAnalysis() Option

+ func WithSecurityAnalysis() Option

+ func WithStats() Option

+ type OutputFormat string

+ const OutputFormatJSON

+ const OutputFormatMarkdown

+ const OutputFormatYAML

+ type Processor interface

+ Process func(ctx context.Context, cfg *model.OpnSenseDocument, opts ...Option) (*Report, error)

+ type Report struct

+ ConfigInfo ConfigInfo

+ Findings Findings

+ GeneratedAt time.Time

+ NormalizedConfig *model.OpnSenseDocument

+ ProcessorConfig Config

+ Statistics *Statistics

+ func NewReport(cfg *model.OpnSenseDocument, processorConfig Config) *Report

+ func (r *Report) AddFinding(severity Severity, finding Finding)

+ func (r *Report) HasCriticalFindings() bool

+ func (r *Report) Summary() string

+ func (r *Report) ToFormat(format OutputFormat) (string, error)

+ func (r *Report) ToJSON() (string, error)

+ func (r *Report) ToMarkdown() string

+ func (r *Report) ToYAML() (string, error)

+ func (r *Report) TotalFindings() int

+ type ServiceStatistics struct

+ Details map[string]string

+ Enabled bool

+ Name string

+ type Severity string

+ const SeverityCritical

+ const SeverityHigh

+ const SeverityInfo

+ const SeverityLow

+ const SeverityMedium

+ type Statistics struct

+ DHCPScopeDetails []DHCPScopeStatistics

+ DHCPScopes int

+ EnabledServices []string

+ GroupsByScope map[string]int

+ InterfaceDetails []InterfaceStatistics

+ InterfacesByType map[string]int

+ LoadBalancerMonitors int

+ NATEntries int

+ NATMode string

+ RulesByInterface map[string]int

+ RulesByType map[string]int

+ SecurityFeatures []string

+ ServiceDetails []ServiceStatistics

+ Summary StatisticsSummary

+ SysctlSettings int

+ TotalFirewallRules int

+ TotalGroups int

+ TotalInterfaces int

+ TotalServices int

+ TotalUsers int

+ UsersByScope map[string]int

+ type StatisticsSummary struct

+ ConfigComplexity int

+ HasSecurityFeatures bool

+ SecurityScore int

+ TotalConfigItems int

+ type TestError struct

+ GoroutineID int

+ Message string

+ func (e *TestError) Error() string

+ type TestHostnameError struct

+ ActualHostname string

+ ExpectedHostname string

+ GoroutineID int

+ func (e *TestHostnameError) Error() string

+ type UnsupportedFormatError struct

+ Format string

+ func (e *UnsupportedFormatError) Error() string

+ type ValidationError struct

+ Field string

+ Message string

+ func (e ValidationError) Error() string

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