modules

type Inspector interface {
	Init()                         // Init Initializes module data
	GetOptions() []Option          // GetOptions returns a list of available options for the module
	GetRegistry() Registry         // GetRegistry returns an object with meta data describing the module
	Inspect(webData WebData) error // Inspect inspects web content for discovery and recon purposes
}

type InspectorModule struct {
	Inspect  func(webData WebData) error
	Registry Registry
	Options  []Option
}

type Modules struct {
	Processors []ProcessorModule
	Inspectors []InspectorModule
}

type Option struct {
	Name        string `json:"name"`        // Name of the option
	Value       string `json:"value"`       // Value of the option
	Required    bool   `json:"required"`    // Is this a required option?
	Description string `json:"description"` // A description of the option
}

type Processor interface {
	Init()                                   // Init Initializes module data
	GetOptions() []Option                    // GetOptions returns a list of available options for the module
	GetRegistry() Registry                   // GetRegistry returns an object with meta data describing the module
	Process(webData WebData) (string, error) // Process alters the body of a request
}

type ProcessorModule struct {
	Process  func(webData WebData) (string, error)
	Registry Registry
	Options  []Option `json:"options"` // A list of configurable options/arguments for the module
}

type Registry struct {
	Name        string   `json:"name"`        // Name of the module
	DocTypes    []string `json:"docTypes"`    // Type of document
	Author      []string `json:"author"`      // A list of module authors
	Credits     []string `json:"credits"`     // A list of people to credit for underlying tool or techniques
	Path        string   `json:"path"`        // Path to the module
	Description string   `json:"description"` // A description of what the module does
	Notes       string   `json:"notes"`       // Additional information or notes about the module
}

type WebData struct {
	Body    string
	Headers map[string]interface{}
	Type    string
	Url     string
	Method  string
}