replicant

Documentation

Overview

Package replicant provides a PT 2.1 Go API implementation of the Replicant adversary-tunable transport

Index

• func NewClientConnection(conn net.Conn, config ClientConfig) (net.Conn, error)
• func NewServerConnection(conn net.Conn, config ServerConfig) (net.Conn, error)
• func ResolveAddr(addrStr string) (*net.TCPAddr, error)
• type ClientConfig
  • func UnmarshalClientConfig(data []byte) (*ClientConfig, error)
  • func (config ClientConfig) Dial() (net.Conn, error)
  • func (config ClientConfig) Marshal() (string, error)
  • func (config ClientConfig) ToJsonString() (string, error)
• type ClientJsonConfig
• type ConnectionState
  • func NewReplicantClientConnectionState(config ClientConfig) (*ConnectionState, error)
  • func NewReplicantServerConnectionState(config ServerConfig, polishServer polish.Server, conn net.Conn) (*ConnectionState, error)
• type DarkStarPolishClientJsonConfig
• type DarkStarPolishServerJsonConfig
• type ServerConfig
  • func UnmarshalServerConfig(data []byte) (*ServerConfig, error)
  • func (config ServerConfig) Listen() (net.Listener, error)
  • func (config ServerConfig) Marshal() (string, error)
  • func (config ServerConfig) ToJsonString() (string, error)
• type ServerJsonConfig
• type TransportClient
  • func NewClient(config ClientConfig, dialer proxy.Dialer) TransportClient
  • func (transport TransportClient) Dial() (net.Conn, error)
• type TransportServer
  • func NewServer(config ServerConfig, dialer proxy.Dialer) TransportServer
  • func (transport TransportServer) Listen() (net.Listener, error)

Functions

func NewClientConnection

func NewClientConnection(conn net.Conn, config ClientConfig) (net.Conn, error)

func NewServerConnection

func NewServerConnection(conn net.Conn, config ServerConfig) (net.Conn, error)

func ResolveAddr

func ResolveAddr(addrStr string) (*net.TCPAddr, error)

Resolve an address string into a net.TCPAddr. We are a bit more strict than net.ResolveTCPAddr; we don't allow an empty host or port, and the host part must be a literal IP address.

Types

type ClientConfig

type ClientConfig struct {
	ServerAddress string              `json:"serverAddress"`
	Toneburst     toneburst.Config    `json:"toneburst"`
	Polish        polish.ClientConfig `json:"polish"`
	Transport     string              `json:"transport"`
}

func UnmarshalClientConfig

func UnmarshalClientConfig(data []byte) (*ClientConfig, error)

func (ClientConfig) Dial

func (config ClientConfig) Dial() (net.Conn, error)

Create outgoing transport connection

func (ClientConfig) Marshal

func (config ClientConfig) Marshal() (string, error)

func (ClientConfig) ToJsonString

func (config ClientConfig) ToJsonString() (string, error)

type ClientJsonConfig

type ClientJsonConfig struct {
	ServerAddress string                         `json:"serverAddress"`
	Toneburst     toneburst.StarburstConfig      `json:"toneburst"`
	Polish        DarkStarPolishClientJsonConfig `json:"polish"`
	Transport     string                         `json:"transport"`
}

type ConnectionState

type ConnectionState struct {
	// contains filtered or unexported fields
}

func NewReplicantClientConnectionState

func NewReplicantClientConnectionState(config ClientConfig) (*ConnectionState, error)

func NewReplicantServerConnectionState

func NewReplicantServerConnectionState(config ServerConfig, polishServer polish.Server, conn net.Conn) (*ConnectionState, error)

type DarkStarPolishClientJsonConfig

type DarkStarPolishClientJsonConfig struct {
	ServerAddress   string `json:"serverAddress"`
	ServerPublicKey string `json:"serverPublicKey"`
}

type DarkStarPolishServerJsonConfig

type DarkStarPolishServerJsonConfig struct {
	ServerAddress    string `json:"serverAddress"`
	ServerPrivateKey string `json:"serverPrivateKey"`
}

type ServerConfig

type ServerConfig struct {
	ServerAddress string              `json:"serverAddress"`
	Toneburst     toneburst.Config    `json:"toneburst"`
	Polish        polish.ServerConfig `json:"polish"`
	Transport     string              `json:"transport"`
	BindAddress   *string             `json:"bindAddress"`
}

func UnmarshalServerConfig

func UnmarshalServerConfig(data []byte) (*ServerConfig, error)

func (ServerConfig) Listen

func (config ServerConfig) Listen() (net.Listener, error)

Create listener for incoming transport connection

func (ServerConfig) Marshal

func (config ServerConfig) Marshal() (string, error)

func (ServerConfig) ToJsonString

func (config ServerConfig) ToJsonString() (string, error)

type ServerJsonConfig

type ServerJsonConfig struct {
	ServerAddress string                         `json:"serverAddress"`
	Toneburst     toneburst.StarburstConfig      `json:"toneburst"`
	Polish        DarkStarPolishServerJsonConfig `json:"polish"`
	Transport     string                         `json:"transport"`
	BindAddress   *string                        `json:"bindAddress"`
}

type TransportClient

type TransportClient struct {
	Config  ClientConfig
	Address string
	// TODO: Dialer can be removed later (both here and in dispatcher)
	Dialer proxy.Dialer
}

This makes Replicant compliant with Optimizer

func NewClient

func NewClient(config ClientConfig, dialer proxy.Dialer) TransportClient

func (TransportClient) Dial

func (transport TransportClient) Dial() (net.Conn, error)

type TransportServer

type TransportServer struct {
	Config  ServerConfig
	Address string
	// TODO: Dialer can be removed later (both here and in dispatcher)
	Dialer proxy.Dialer
}

func NewServer

func NewServer(config ServerConfig, dialer proxy.Dialer) TransportServer

func (TransportServer) Listen

func (transport TransportServer) Listen() (net.Listener, error)