client

Documentation

Index

• Variables
• type Client
  • func New(options *Options) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) SaveSessionTo(filename string) error
  • func (c *Client) StartPolling(duration time.Duration, callback InteractionCallback) error
  • func (c *Client) StopPolling() error
  • func (c *Client) TryGetAsnInfo(interaction *server.Interaction) error
  • func (c *Client) URL() string
• type InteractionCallback
• type Options
• type State

Variables

var DefaultOptions = &Options{
	ServerURL:                "oast.pro,oast.live,oast.site,oast.online,oast.fun,oast.me",
	CorrelationIdLength:      settings.CorrelationIdLengthDefault,
	CorrelationIdNonceLength: settings.CorrelationIdNonceLengthDefault,
}

DefaultOptions is the default options for the interact client

Types

type Client

type Client struct {
	State atomic.Value

	CorrelationIdNonceLength int
	// contains filtered or unexported fields
}

Client is a client for communicating with interactsh server instance.

func New

func New(options *Options) (*Client, error)

New creates a new client instance based on provided options

func (*Client) Close

func (c *Client) Close() error

Close closes the collaborator client and deregisters from the collaborator server if not explicitly asked by the user.

func (*Client) SaveSessionTo

func (c *Client) SaveSessionTo(filename string) error

func (*Client) StartPolling

func (c *Client) StartPolling(duration time.Duration, callback InteractionCallback) error

StartPolling the server each duration and returns any events that may have been captured by the collaborator server.

func (*Client) StopPolling

func (c *Client) StopPolling() error

StopPolling the interactsh server.

func (*Client) TryGetAsnInfo

func (c *Client) TryGetAsnInfo(interaction *server.Interaction) error

TryGetAsnInfo attempts to enrich interaction with asn data

func (*Client) URL

func (c *Client) URL() string

URL returns a new URL that can be used for external interaction requests.

type InteractionCallback

type InteractionCallback func(*server.Interaction)

InteractionCallback is a callback function for a reported interaction

type Options

type Options struct {
	// ServerURL is the URL for the interactsh server.
	ServerURL string
	// Token if the server requires authentication
	Token string
	// DisableHTTPFallback determines if failed requests over https should not be retried over http
	DisableHTTPFallback bool
	// CorrelationIdLength of the preamble
	CorrelationIdLength int
	// CorrelationIdNonceLengthLength of the nonce
	CorrelationIdNonceLength int
	// HTTPClient use a custom http client
	HTTPClient *retryablehttp.Client
	// SessionInfo to resume an existing session
	SessionInfo *options.SessionInfo
	// keepAliveInterval to renew the session
	KeepAliveInterval time.Duration
}

Options contains configuration options for interactsh client

type State

type State uint8

const (
	Idle State = iota
	Polling
	Closed
)