spike

package

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

Details

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

Repository

github.com/ayuxsec/spike

Links

Open Source Insights

Documentation ¶

Overview ¶

Package spike provides the main Spike application structure and functionality. It attaches the scanner and reporter components to run the scanning process.

Index ¶

Variables
func NewREPLShell(dbPath string) error
type Option
type OutputMode
type ScanMode
type Scanner
- func NewScanner(opts ...Option) (*Scanner, error)
- func (s *Scanner) Output(domainName string, outputFolder string, mode OutputMode) error
- func (s *Scanner) Run() error

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrClosingScanner = errors.New("error while closing scanner")

View Source

var ErrFailedScanner = errors.New("error while running scanner")

Functions ¶

func NewREPLShell ¶

func NewREPLShell(dbPath string) error

Types ¶

type Option ¶

type Option func(s *Scanner)

func OptionWithConfig ¶

func OptionWithConfig(cfg *config.Config) Option

OptionWithConfig sets the config.

func OptionWithDBPath ¶

func OptionWithDBPath(dbPath string) Option

OptionWithDBPath sets the database path.

func OptionWithInputDomains ¶

func OptionWithInputDomains(inputDomains []string) Option

OptionWithInputDomains sets the input domains.

func OptionWithScanMode ¶

func OptionWithScanMode(mode ScanMode) Option

OptionWithScanMode sets the scan mode.

func OptionWithSkipTimedOut ¶ added in v0.7.5

func OptionWithSkipTimedOut(skip bool) Option

OptionWithSkipTimedOut sets the skip timed out scan option.

type OutputMode ¶ added in v0.7.1

type OutputMode int

const (
	TextOutputMode OutputMode = iota
)

type ScanMode ¶ added in v0.6.4

type ScanMode int

const (
	DomainScanMode ScanMode = iota // scan input domains
	DbScanMode                     // select unscanned domains from the database and scans them
)

type Scanner ¶

type Scanner struct {
	InputDomains            []string       // domains to scan
	DBPath                  string         // path to the sqlite database
	Config                  *config.Config // configuration for the scan
	ScanMode                ScanMode       // DomainScanMode or DbScanMode
	DoSkipScanTimedOutTools bool           // skip timed out tools
}

func NewScanner ¶

func NewScanner(opts ...Option) (*Scanner, error)

func (*Scanner) Output ¶ added in v0.7.1

func (s *Scanner) Output(domainName string, outputFolder string, mode OutputMode) error

func (*Scanner) Run ¶

func (s *Scanner) Run() error

Source Files ¶

View all Source files

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