nuclei/v2/pkg/protocols/common/interactsh/interactsh.go

package interactsh

import (
	"net/url"
	"strings"
	"time"

	"github.com/karlseguin/ccache"
	"github.com/pkg/errors"
	"github.com/projectdiscovery/interactsh/pkg/client"
	"github.com/projectdiscovery/interactsh/pkg/server"
	"github.com/projectdiscovery/nuclei/v2/pkg/operators"
	"github.com/projectdiscovery/nuclei/v2/pkg/output"
	"github.com/projectdiscovery/nuclei/v2/pkg/progress"
	"github.com/valyala/fasttemplate"
)

// Client is a wrapped client for interactsh server.
type Client struct {
	// interactsh is a client for interactsh server.
	interactsh *client.Client
	// requests is a stored cache for interactsh-url->request-event data.
	requests *ccache.Cache

	matched          bool
	dotHostname      string
	eviction         time.Duration
	pollDuration     time.Duration
	cooldownDuration time.Duration
}

var interactshURLMarker = "{{interactsh-url}}"

// Options contains configuration options for interactsh nuclei integration.
type Options struct {
	// ServerURL is the URL of the interactsh server.
	ServerURL string
	// CacheSize is the numbers of requests to keep track of at a time.
	// Older items are discarded in LRU manner in favor of new requests.
	CacheSize int64
	// Eviction is the period of time after which to automatically discard
	// interaction requests.
	Eviction time.Duration
	// CooldownPeriod is additional time to wait for interactions after closing
	// of the poller.
	ColldownPeriod time.Duration
	// PollDuration is the time to wait before each poll to the server for interactions.
	PollDuration time.Duration
	// Output is the output writer for nuclei
	Output output.Writer
	// Progress is the nuclei progress bar implementation.
	Progress progress.Progress
}

// New returns a new interactsh server client
func New(options *Options) (*Client, error) {
	parsed, err := url.Parse(options.ServerURL)
	if err != nil {
		return nil, errors.Wrap(err, "could not parse server url")
	}

	interactsh, err := client.New(&client.Options{
		ServerURL:         options.ServerURL,
		PersistentSession: false,
	})
	if err != nil {
		return nil, errors.Wrap(err, "could not create client")
	}
	configure := ccache.Configure()
	configure = configure.MaxSize(options.CacheSize)
	cache := ccache.New(configure)

	interactClient := &Client{
		interactsh:       interactsh,
		eviction:         options.Eviction,
		dotHostname:      "." + parsed.Host,
		requests:         cache,
		pollDuration:     options.PollDuration,
		cooldownDuration: options.ColldownPeriod,
	}

	interactClient.interactsh.StartPolling(interactClient.pollDuration, func(interaction *server.Interaction) {
		item := interactClient.requests.Get(interaction.UniqueID)
		if item == nil {
			return
		}
		data, ok := item.Value().(*RequestData)
		if !ok {
			return
		}

		data.Event.InternalEvent["interactsh-protocol"] = interaction.Protocol
		data.Event.InternalEvent["interactsh-request"] = interaction.RawRequest
		data.Event.InternalEvent["interactsh-response"] = interaction.RawResponse
		result, matched := data.Operators.Execute(data.Event.InternalEvent, data.MatchFunc, data.ExtractFunc)
		if !matched || result == nil {
			return // if we don't match, return
		}
		interactClient.requests.Delete(interaction.UniqueID)

		if data.Event.OperatorsResult != nil {
			data.Event.OperatorsResult.Merge(result)
		} else {
			data.Event.OperatorsResult = result
		}
		data.Event.Results = data.MakeResultFunc(data.Event)
		for _, result := range data.Event.Results {
			result.Interaction = interaction
			_ = options.Output.Write(result)
			if !interactClient.matched {
				interactClient.matched = true
			}
			options.Progress.IncrementMatched()
		}
	})
	return interactClient, nil
}

// URL returns a new URL that can be interacted with
func (c *Client) URL() string {
	return c.interactsh.URL()
}

// Close closes the interactsh clients after waiting for cooldown period.
func (c *Client) Close() bool {
	if c.cooldownDuration > 0 {
		time.Sleep(c.cooldownDuration)
	}
	c.interactsh.StopPolling()
	c.interactsh.Close()
	return c.matched
}

// ReplaceMarkers replaces the {{interactsh-url}} placeholders to actual
// URLs pointing to interactsh-server.
//
// It accepts data to replace as well as the URL to replace placeholders
// with generated uniquely for each request.
func (c *Client) ReplaceMarkers(data, interactshURL string) string {
	if !strings.Contains(data, interactshURLMarker) {
		return data
	}
	replaced := fasttemplate.ExecuteStringStd(data, "{{", "}}", map[string]interface{}{
		"interactsh-url": interactshURL,
	})
	return replaced
}

// MakeResultEventFunc is a result making function for nuclei
type MakeResultEventFunc func(wrapped *output.InternalWrappedEvent) []*output.ResultEvent

// RequestData contains data for a request event
type RequestData struct {
	MakeResultFunc MakeResultEventFunc
	Event          *output.InternalWrappedEvent
	Operators      *operators.Operators
	MatchFunc      operators.MatchFunc
	ExtractFunc    operators.ExtractFunc
}

// RequestEvent is the event for a network request sent by nuclei.
func (c *Client) RequestEvent(interactshURL string, data *RequestData) {
	id := strings.TrimSuffix(interactshURL, c.dotHostname)
	c.requests.Set(id, data, c.eviction)
}

// HasMatchers returns true if an operator has interactsh part
// matchers or extractors.
//
// Used by requests to show result or not depending on presence of interact.sh
// data part matchers.
func HasMatchers(operators *operators.Operators) bool {
	for _, matcher := range operators.Matchers {
		if strings.HasPrefix(matcher.Part, "interactsh-") {
			return true
		}
	}
	for _, matcher := range operators.Extractors {
		if strings.HasPrefix(matcher.Part, "interactsh-") {
			return true
		}
	}
	return false
}