mirror of https://github.com/daffainfo/nuclei.git
195 lines
5.5 KiB
Go
195 lines
5.5 KiB
Go
package output
|
|
|
|
import (
|
|
"os"
|
|
"regexp"
|
|
"sync"
|
|
"time"
|
|
|
|
jsoniter "github.com/json-iterator/go"
|
|
"github.com/logrusorgru/aurora"
|
|
"github.com/pkg/errors"
|
|
"github.com/projectdiscovery/nuclei/v2/internal/colorizer"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/operators"
|
|
)
|
|
|
|
// Writer is an interface which writes output to somewhere for nuclei events.
|
|
type Writer interface {
|
|
// Close closes the output writer interface
|
|
Close()
|
|
// Colorizer returns the colorizer instance for writer
|
|
Colorizer() aurora.Aurora
|
|
// Write writes the event to file and/or screen.
|
|
Write(*ResultEvent) error
|
|
// Request logs a request in the trace log
|
|
Request(templateID, url, requestType string, err error)
|
|
}
|
|
|
|
// StandardWriter is a writer writing output to file and screen for results.
|
|
type StandardWriter struct {
|
|
json bool
|
|
noMetadata bool
|
|
aurora aurora.Aurora
|
|
outputFile *fileWriter
|
|
outputMutex *sync.Mutex
|
|
traceFile *fileWriter
|
|
traceMutex *sync.Mutex
|
|
severityColors *colorizer.Colorizer
|
|
}
|
|
|
|
var decolorizerRegex = regexp.MustCompile(`\x1B\[[0-9;]*[a-zA-Z]`)
|
|
|
|
// InternalEvent is an internal output generation structure for nuclei.
|
|
type InternalEvent map[string]interface{}
|
|
|
|
// InternalWrappedEvent is a wrapped event with operators result added to it.
|
|
type InternalWrappedEvent struct {
|
|
InternalEvent InternalEvent
|
|
Results []*ResultEvent
|
|
OperatorsResult *operators.Result
|
|
}
|
|
|
|
// ResultEvent is a wrapped result event for a single nuclei output.
|
|
type ResultEvent struct {
|
|
// TemplateID is the ID of the template for the result.
|
|
TemplateID string `json:"templateID"`
|
|
// Info contains information block of the template for the result.
|
|
Info map[string]interface{} `json:"info,inline"`
|
|
// MatcherName is the name of the matcher matched if any.
|
|
MatcherName string `json:"matcher_name,omitempty"`
|
|
// ExtractorName is the name of the extractor matched if any.
|
|
ExtractorName string `json:"extractor_name,omitempty"`
|
|
// Type is the type of the result event.
|
|
Type string `json:"type"`
|
|
// Host is the host input on which match was found.
|
|
Host string `json:"host,omitempty"`
|
|
// Path is the path input on which match was found.
|
|
Path string `json:"path,omitempty"`
|
|
// Matched contains the matched input in its transformed form.
|
|
Matched string `json:"matched,omitempty"`
|
|
// ExtractedResults contains the extraction result from the inputs.
|
|
ExtractedResults []string `json:"extracted_results,omitempty"`
|
|
// Request is the optional dumped request for the match.
|
|
Request string `json:"request,omitempty"`
|
|
// Response is the optional dumped response for the match.
|
|
Response string `json:"response,omitempty"`
|
|
// Metadata contains any optional metadata for the event
|
|
Metadata map[string]interface{} `json:"meta,omitempty"`
|
|
// IP is the IP address for the found result event.
|
|
IP string `json:"ip,omitempty"`
|
|
// Timestamp is the time the result was found at.
|
|
Timestamp time.Time `json:"timestamp"`
|
|
}
|
|
|
|
// NewStandardWriter creates a new output writer based on user configurations
|
|
func NewStandardWriter(colors, noMetadata, json bool, file, traceFile string) (*StandardWriter, error) {
|
|
auroraColorizer := aurora.NewAurora(colors)
|
|
|
|
var outputFile *fileWriter
|
|
if file != "" {
|
|
output, err := newFileOutputWriter(file)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "could not create output file")
|
|
}
|
|
outputFile = output
|
|
}
|
|
var traceOutput *fileWriter
|
|
if traceFile != "" {
|
|
output, err := newFileOutputWriter(traceFile)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "could not create output file")
|
|
}
|
|
traceOutput = output
|
|
}
|
|
writer := &StandardWriter{
|
|
json: json,
|
|
noMetadata: noMetadata,
|
|
aurora: auroraColorizer,
|
|
outputFile: outputFile,
|
|
outputMutex: &sync.Mutex{},
|
|
traceFile: traceOutput,
|
|
traceMutex: &sync.Mutex{},
|
|
severityColors: colorizer.New(auroraColorizer),
|
|
}
|
|
return writer, nil
|
|
}
|
|
|
|
// Write writes the event to file and/or screen.
|
|
func (w *StandardWriter) Write(event *ResultEvent) error {
|
|
event.Timestamp = time.Now()
|
|
|
|
var data []byte
|
|
var err error
|
|
|
|
if w.json {
|
|
data, err = w.formatJSON(event)
|
|
} else {
|
|
data = w.formatScreen(event)
|
|
}
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not format output")
|
|
}
|
|
if len(data) == 0 {
|
|
return nil
|
|
}
|
|
_, _ = os.Stdout.Write(data)
|
|
_, _ = os.Stdout.Write([]byte("\n"))
|
|
if w.outputFile != nil {
|
|
if !w.json {
|
|
data = decolorizerRegex.ReplaceAll(data, []byte(""))
|
|
}
|
|
if writeErr := w.outputFile.Write(data); writeErr != nil {
|
|
return errors.Wrap(err, "could not write to output")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// JSONTraceRequest is a trace log request written to file
|
|
type JSONTraceRequest struct {
|
|
ID string `json:"id"`
|
|
URL string `json:"url"`
|
|
Error string `json:"error"`
|
|
Type string `json:"type"`
|
|
}
|
|
|
|
// Request writes a log the requests trace log
|
|
func (w *StandardWriter) Request(templateID, url, requestType string, err error) {
|
|
if w.traceFile == nil {
|
|
return
|
|
}
|
|
request := &JSONTraceRequest{
|
|
ID: templateID,
|
|
URL: url,
|
|
Type: requestType,
|
|
}
|
|
if err != nil {
|
|
request.Error = err.Error()
|
|
} else {
|
|
request.Error = "none"
|
|
}
|
|
|
|
data, err := jsoniter.Marshal(request)
|
|
if err != nil {
|
|
return
|
|
}
|
|
w.traceMutex.Lock()
|
|
_ = w.traceFile.Write(data)
|
|
w.traceMutex.Unlock()
|
|
}
|
|
|
|
// Colorizer returns the colorizer instance for writer
|
|
func (w *StandardWriter) Colorizer() aurora.Aurora {
|
|
return w.aurora
|
|
}
|
|
|
|
// Close closes the output writing interface
|
|
func (w *StandardWriter) Close() {
|
|
if w.outputFile != nil {
|
|
w.outputFile.Close()
|
|
}
|
|
if w.traceFile != nil {
|
|
w.traceFile.Close()
|
|
}
|
|
}
|