freedom

Documentation

Index

• Constants
• type Client
  • func NewClient(ctx context.Context, _ tunnel.Client) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) DialConn(addr *tunnel.Address, _ tunnel.Tunnel) (tunnel.Conn, error)
  • func (c *Client) DialPacket(tunnel.Tunnel) (tunnel.PacketConn, error)
• type Config
• type Conn
  • func (c *Conn) Metadata() *tunnel.Metadata
• type ForwardProxyConfig
• type PacketConn
  • func (c *PacketConn) ReadWithMetadata(p []byte) (int, *tunnel.Metadata, error)
  • func (c *PacketConn) WriteTo(p []byte, addr net.Addr) (int, error)
  • func (c *PacketConn) WriteWithMetadata(p []byte, m *tunnel.Metadata) (int, error)
• type SocksPacketConn
  • func (c *SocksPacketConn) Close() error
  • func (c *SocksPacketConn) ReadWithMetadata(payload []byte) (int, *tunnel.Metadata, error)
  • func (c *SocksPacketConn) WriteWithMetadata(payload []byte, metadata *tunnel.Metadata) (int, error)
• type TCPConfig
• type Tunnel
  • func (*Tunnel) Name() string
  • func (*Tunnel) NewClient(ctx context.Context, client tunnel.Client) (tunnel.Client, error)
  • func (*Tunnel) NewServer(ctx context.Context, client tunnel.Server) (tunnel.Server, error)

Constants

const MaxPacketSize = 1024 * 8

const Name = "FREEDOM"

Types

type Client

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

func NewClient

func NewClient(ctx context.Context, _ tunnel.Client) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) DialConn

func (c *Client) DialConn(addr *tunnel.Address, _ tunnel.Tunnel) (tunnel.Conn, error)

func (*Client) DialPacket

func (c *Client) DialPacket(tunnel.Tunnel) (tunnel.PacketConn, error)

type Config

type Config struct {
	LocalHost    string             `json:"local_addr" yaml:"local-addr"`
	LocalPort    int                `json:"local_port" yaml:"local-port"`
	TCP          TCPConfig          `json:"tcp" yaml:"tcp"`
	ForwardProxy ForwardProxyConfig `json:"forward_proxy" yaml:"forward-proxy"`
}

type Conn

type Conn struct {
	net.Conn
}

func (*Conn) Metadata

func (c *Conn) Metadata() *tunnel.Metadata

type ForwardProxyConfig

type ForwardProxyConfig struct {
	Enabled   bool   `json:"enabled" yaml:"enabled"`
	ProxyHost string `json:"proxy_addr" yaml:"proxy-addr"`
	ProxyPort int    `json:"proxy_port" yaml:"proxy-port"`
	Username  string `json:"username" yaml:"username"`
	Password  string `json:"password" yaml:"password"`
}

type PacketConn

type PacketConn struct {
	*net.UDPConn
}

func (*PacketConn) ReadWithMetadata

func (c *PacketConn) ReadWithMetadata(p []byte) (int, *tunnel.Metadata, error)

func (*PacketConn) WriteTo

func (c *PacketConn) WriteTo(p []byte, addr net.Addr) (int, error)

func (*PacketConn) WriteWithMetadata

func (c *PacketConn) WriteWithMetadata(p []byte, m *tunnel.Metadata) (int, error)

type SocksPacketConn

type SocksPacketConn struct {
	net.PacketConn
	// contains filtered or unexported fields
}

func (*SocksPacketConn) Close

func (c *SocksPacketConn) Close() error

func (*SocksPacketConn) ReadWithMetadata

func (c *SocksPacketConn) ReadWithMetadata(payload []byte) (int, *tunnel.Metadata, error)

func (*SocksPacketConn) WriteWithMetadata

func (c *SocksPacketConn) WriteWithMetadata(
	payload []byte,
	metadata *tunnel.Metadata,
) (int, error)

type TCPConfig

type TCPConfig struct {
	PreferIPV4 bool `json:"prefer_ipv4" yaml:"prefer-ipv4"`
	KeepAlive  bool `json:"keep_alive" yaml:"keep-alive"`
	NoDelay    bool `json:"no_delay" yaml:"no-delay"`
}

type Tunnel

type Tunnel struct{}

func (*Tunnel) Name

func (*Tunnel) Name() string

func (*Tunnel) NewClient

func (*Tunnel) NewClient(ctx context.Context, client tunnel.Client) (tunnel.Client, error)

func (*Tunnel) NewServer

func (*Tunnel) NewServer(ctx context.Context, client tunnel.Server) (tunnel.Server, error)