mirror of
https://github.com/lunchcat/sif.git
synced 2026-01-12 13:05:20 -08:00
107 lines
3.8 KiB
Go
107 lines
3.8 KiB
Go
/*
|
|
·━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━·
|
|
: :
|
|
: █▀ █ █▀▀ · Blazing-fast pentesting suite :
|
|
: ▄█ █ █▀ · BSD 3-Clause License :
|
|
: :
|
|
: (c) 2022-2025 vmfunc (Celeste Hickenlooper), xyzeva, :
|
|
: lunchcat alumni & contributors :
|
|
: :
|
|
·━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━·
|
|
*/
|
|
|
|
// Package modules provides the module system infrastructure for SIF.
|
|
// It defines the core interfaces, types, and utilities for building
|
|
// and executing security scanning modules.
|
|
package modules
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"time"
|
|
)
|
|
|
|
// ModuleType represents the type of module.
|
|
type ModuleType string
|
|
|
|
const (
|
|
TypeHTTP ModuleType = "http"
|
|
TypeDNS ModuleType = "dns"
|
|
TypeTCP ModuleType = "tcp"
|
|
TypeScript ModuleType = "script"
|
|
)
|
|
|
|
// Module is the interface all modules implement.
|
|
// Each module must provide metadata, specify its type, and implement
|
|
// an Execute method for running the scan against a target.
|
|
type Module interface {
|
|
// Info returns the module metadata.
|
|
Info() Info
|
|
|
|
// Type returns the module type (http, dns, tcp, script).
|
|
Type() ModuleType
|
|
|
|
// Execute runs the module against the specified target.
|
|
Execute(ctx context.Context, target string, opts Options) (*Result, error)
|
|
}
|
|
|
|
// Info contains module metadata.
|
|
type Info struct {
|
|
ID string `yaml:"id" json:"id"`
|
|
Name string `yaml:"name" json:"name"`
|
|
Author string `yaml:"author" json:"author"`
|
|
Severity string `yaml:"severity" json:"severity"`
|
|
Description string `yaml:"description" json:"description"`
|
|
Tags []string `yaml:"tags" json:"tags"`
|
|
}
|
|
|
|
// Options for module execution.
|
|
type Options struct {
|
|
Timeout time.Duration
|
|
Threads int
|
|
LogDir string
|
|
Client *http.Client
|
|
}
|
|
|
|
// Result from module execution.
|
|
type Result struct {
|
|
ModuleID string `json:"module_id"`
|
|
Target string `json:"target"`
|
|
Findings []Finding `json:"findings,omitempty"`
|
|
}
|
|
|
|
// ResultType implements the ScanResult interface from pkg/scan.
|
|
func (r *Result) ResultType() string {
|
|
return r.ModuleID
|
|
}
|
|
|
|
// Finding represents a discovered issue.
|
|
type Finding struct {
|
|
URL string `json:"url,omitempty"`
|
|
Severity string `json:"severity"`
|
|
Evidence string `json:"evidence,omitempty"`
|
|
Extracted map[string]string `json:"extracted,omitempty"`
|
|
}
|
|
|
|
// Matcher defines matching logic for module responses.
|
|
// Matchers are used to determine if a response indicates a vulnerability.
|
|
type Matcher struct {
|
|
Type string `yaml:"type"` // regex, status, word, size
|
|
Part string `yaml:"part"` // body, header, all
|
|
Regex []string `yaml:"regex,omitempty"`
|
|
Words []string `yaml:"words,omitempty"`
|
|
Status []int `yaml:"status,omitempty"`
|
|
Condition string `yaml:"condition"` // and, or
|
|
Negative bool `yaml:"negative"`
|
|
}
|
|
|
|
// Extractor defines data extraction from responses.
|
|
// Extractors pull specific data from matched responses for reporting.
|
|
type Extractor struct {
|
|
Type string `yaml:"type"` // regex, kval, json
|
|
Name string `yaml:"name"`
|
|
Part string `yaml:"part"`
|
|
Regex []string `yaml:"regex,omitempty"`
|
|
Group int `yaml:"group"`
|
|
}
|