tapdance

Documentation

Index

• func Assets() *assets
• func AssetsSetDir(dir string) *assets
• func Dial(network, address string) (net.Conn, error)
• func EnableProxyProtocol()
• func Logger() *logrus.Logger
• func NewTapDanceConn() (net.Conn, error)
• func SetTlsLogFilename(filename string) error
• func WriteTlsLog(clientRandom, masterSecret []byte) error
• type CounterUint64
  • func (c *CounterUint64) Dec() uint64
  • func (c *CounterUint64) Get() (value uint64)
  • func (c *CounterUint64) GetAndInc() uint64
  • func (c *CounterUint64) Inc() uint64
  • func (c *CounterUint64) Set(value uint64)
• type Dialer
  • func (d *Dialer) Dial(network, address string) (net.Conn, error)
  • func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)
  • func (d *Dialer) DialProxy() (net.Conn, error)
  • func (d *Dialer) DialProxyContext(ctx context.Context) (net.Conn, error)
• type DualConn
  • func (tdConn *DualConn) Write(b []byte) (int, error)
• type TapdanceFlowConn
  • func (flowConn *TapdanceFlowConn) Close() error
  • func (flowConn *TapdanceFlowConn) DialContext(ctx context.Context) error
  • func (flowConn *TapdanceFlowConn) LocalAddr() net.Addr
  • func (flowConn *TapdanceFlowConn) Read(b []byte) (int, error)
  • func (flowConn *TapdanceFlowConn) RemoteAddr() net.Addr
  • func (flowConn *TapdanceFlowConn) SetDeadline(t time.Time) error
  • func (flowConn *TapdanceFlowConn) SetReadDeadline(t time.Time) error
  • func (flowConn *TapdanceFlowConn) SetWriteDeadline(t time.Time) error
  • func (flowConn *TapdanceFlowConn) Write(b []byte) (int, error)

Functions

func Assets

func Assets() *assets

Assets is an access point to asset managing singleton. First access to singleton sets path. Assets(), if called before SetAssetsDir() sets path to "./assets/"

func AssetsSetDir

func AssetsSetDir(dir string) *assets

AssetsSetDir sets the directory to read assets from. Functionally equivalent to Assets() after initialization, unless dir changes.

func Dial

func Dial(network, address string) (net.Conn, error)

Dial connects to the address on the named network.

The only supported network at this time: "tcp". The address has the form "host:port". The host must be a literal IP address, or a host name that can be resolved to IP addresses. To avoid abuse, only certain whitelisted ports are allowed.

Example: Dial("tcp", "golang.org:80")

func EnableProxyProtocol

func EnableProxyProtocol()

Requests station to proxy client IP to upstream in following form: CONNECT 1.2.3.4:443 HTTP/1.1\r\n Host: 1.2.3.4\r\n \r\n PROXY TCP4 x.x.x.x 127.0.0.1 1111 1234\r\n

 ^__^ ^_____^ ^_________________^
proto clientIP      garbage

func Logger

func Logger() *logrus.Logger

Logger is an access point for TapDance-wide logger

func NewTapDanceConn

func NewTapDanceConn() (net.Conn, error)

NewTapDanceConn returns TapDance connection, that is ready to be Dial'd

func SetTlsLogFilename

func SetTlsLogFilename(filename string) error

func WriteTlsLog

func WriteTlsLog(clientRandom, masterSecret []byte) error

Types

type CounterUint64

type CounterUint64 struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

CounterUint64 is a goroutine-safe uint64 counter. Wraps, if underflows/overflows.

func (*CounterUint64) Dec

func (c *CounterUint64) Dec() uint64

Dec decrements the counter and returns resulting value

func (*CounterUint64) Get

func (c *CounterUint64) Get() (value uint64)

Get returns current counter value

func (*CounterUint64) GetAndInc

func (c *CounterUint64) GetAndInc() uint64

GetAndInc returns current value and then increases the counter

func (*CounterUint64) Inc

func (c *CounterUint64) Inc() uint64

Inc increases the counter and returns resulting value

func (*CounterUint64) Set

func (c *CounterUint64) Set(value uint64)

Set assigns current counter value

type Dialer

type Dialer struct {
	SplitFlows bool
	TcpDialer  func(context.Context, string, string) (net.Conn, error)
}

Dialer contains options and implements advanced functions for establishing TapDance connection.

func (*Dialer) Dial

func (d *Dialer) Dial(network, address string) (net.Conn, error)

Dial connects to the address on the named network.

func (*Dialer) DialContext

func (d *Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)

DialContext connects to the address on the named network using the provided context. Long deadline is strongly advised, since tapdance will try multiple decoys.

The only supported network at this time: "tcp". The address has the form "host:port". The host must be a literal IP address, or a host name that can be resolved to IP addresses. To avoid abuse, only certain whitelisted ports are allowed.

Example: Dial("tcp", "golang.org:80")

func (*Dialer) DialProxy

func (d *Dialer) DialProxy() (net.Conn, error)

DialProxy establishes direct connection to TapDance station proxy. Users are expected to send HTTP CONNECT request next.

func (*Dialer) DialProxyContext

func (d *Dialer) DialProxyContext(ctx context.Context) (net.Conn, error)

DialProxy establishes direct connection to TapDance station proxy using the provided context. Users are expected to send HTTP CONNECT request next.

type DualConn

type DualConn struct {
	net.Conn
	// contains filtered or unexported fields
}

DualConn is composed of 2 separate TapdanceFlowConn. Allows to achieve substantially higher upload speed and slightly higher download speed.

func (*DualConn) Write

func (tdConn *DualConn) Write(b []byte) (int, error)

Write writes data to the connection. Write can be made to time out and return an Error with Timeout() == true after a fixed time limit; see SetDeadline and SetWriteDeadline.

type TapdanceFlowConn

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

TapdanceFlowConn represents single TapDance flow.

func (*TapdanceFlowConn) Close

func (flowConn *TapdanceFlowConn) Close() error

Close closes the connection. Any blocked Read or Write operations will be unblocked and return errors.

func (*TapdanceFlowConn) DialContext

func (flowConn *TapdanceFlowConn) DialContext(ctx context.Context) error

Dial establishes direct connection to TapDance station proxy. Users are expected to send HTTP CONNECT request next.

func (*TapdanceFlowConn) LocalAddr

func (flowConn *TapdanceFlowConn) LocalAddr() net.Addr

LocalAddr returns the local network address.

func (*TapdanceFlowConn) Read

func (flowConn *TapdanceFlowConn) Read(b []byte) (int, error)

func (*TapdanceFlowConn) RemoteAddr

func (flowConn *TapdanceFlowConn) RemoteAddr() net.Addr

RemoteAddr returns the address of current decoy. Not goroutine-safe, mostly here to satisfy net.Conn

func (*TapdanceFlowConn) SetDeadline

func (flowConn *TapdanceFlowConn) SetDeadline(t time.Time) error

SetDeadline is supposed to set the read and write deadlines associated with the connection. It is equivalent to calling both SetReadDeadline and SetWriteDeadline.

TODO: In reality, SetDeadline doesn't do that yet, but existence of this function is mandatory to implement net.Conn

A deadline is an absolute time after which I/O operations fail with a timeout (see type Error) instead of blocking. The deadline applies to all future I/O, not just the immediately following call to Read or Write.

An idle timeout can be implemented by repeatedly extending the deadline after successful Read or Write calls.

A zero value for t means I/O operations will not time out.

func (*TapdanceFlowConn) SetReadDeadline

func (flowConn *TapdanceFlowConn) SetReadDeadline(t time.Time) error

SetReadDeadline sets the deadline for future Read calls. A zero value for t means Read will not time out.

func (*TapdanceFlowConn) SetWriteDeadline

func (flowConn *TapdanceFlowConn) SetWriteDeadline(t time.Time) error

SetWriteDeadline sets the deadline for future Write calls. Even if write times out, it may return n > 0, indicating that some of the data was successfully written. A zero value for t means Write will not time out.

func (*TapdanceFlowConn) Write

func (flowConn *TapdanceFlowConn) Write(b []byte) (int, error)

Write writes data to the connection. Write can be made to time out and return an Error with Timeout() == true after a fixed time limit; see SetDeadline and SetWriteDeadline.