sans

package
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 21, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package sans provides a compliance plugin for SANS security controls.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin implements the compliance.Plugin interface for SANS plugin.

func NewPlugin

func NewPlugin() *Plugin

NewPlugin creates a new SANS compliance plugin.

func (*Plugin) Description

func (sp *Plugin) Description() string

Description returns the plugin description.

func (*Plugin) GetControlByID

func (sp *Plugin) GetControlByID(id string) (*compliance.Control, error)

GetControlByID returns a specific control by ID.

func (*Plugin) GetControls

func (sp *Plugin) GetControls() []compliance.Control

GetControls returns all SANS controls. The returned slice is a deep copy to prevent callers from mutating the plugin's internal state, including nested reference types (References, Tags, Metadata).

func (*Plugin) Name

func (sp *Plugin) Name() string

Name returns the plugin name.

func (*Plugin) RunChecks

func (sp *Plugin) RunChecks(
	device *common.CommonDevice,
) ([]compliance.Finding, []string, error)

RunChecks performs SANS compliance checks against the device configuration in a single traversal. Returns (findings, evaluated, err). Each check is invoked exactly once — its result determines both whether a finding is emitted and whether the control ID is appended to evaluated.

err is currently always nil; reserved for future unrecoverable conditions.

func (*Plugin) ValidateConfiguration

func (sp *Plugin) ValidateConfiguration() error

ValidateConfiguration validates the plugin configuration.

func (*Plugin) Version

func (sp *Plugin) Version() string

Version returns the plugin version.

Jump to

Keyboard shortcuts

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