emux

README

EMux

EMux(Express Multiplexing) is a simple, fast stream Multiplexer. EMux is using a custom protocol, is not compatible with any other, any similarity is purely coincidental.

This project is to add protocol support for the Bridge, or it can be used alone

The following is the implementation of other proxy protocols

• Socks4
• Socks5
• HTTP Proxy
• Shadow Socks
• SSH Proxy
• Any Proxy

License

Licensed under the MIT License. See LICENSE for the full license text.

Documentation

Index

• Variables
• type BytesPool
• type Client
  • func NewClient(ctx context.Context, stm io.ReadWriteCloser, instruction *Instruction) *Client
  • func (s Client) Close() error
  • func (c *Client) Dial(ctx context.Context) (io.ReadWriteCloser, error)
  • func (s Client) IsClosed() bool
• type Decode
  • func NewDecode(r DecodeReader) *Decode
  • func (d *Decode) ReadBytes() ([]byte, error)
  • func (d *Decode) ReadUvarint() (uint64, error)
  • func (d *Decode) WriteTo(w io.Writer, buf []byte) (int64, error)
• type DecodeReader
• type Dialer
• type DialerSession
  • func NewDialer(ctx context.Context, dialer Dialer) *DialerSession
  • func (d *DialerSession) DialContext(ctx context.Context, network, address string) (net.Conn, error)
• type Encode
  • func NewEncode(w EncodeWriter) *Encode
  • func (e *Encode) WriteByte(b byte) error
  • func (e *Encode) WriteBytes(b []byte) error
  • func (e *Encode) WriteCmd(cmd uint8, sid uint64) error
  • func (e *Encode) WriteUvarint(v uint64) error
• type EncodeWriter
• type Handshake
  • func NewHandshake(h []byte, send bool) Handshake
• type Instruction
• type ListenConfig
• type ListenConfigSession
  • func NewListenConfig(ctx context.Context, listener ListenConfig) *ListenConfigSession
  • func (l *ListenConfigSession) Listen(ctx context.Context, network, address string) (net.Listener, error)
• type ListenerSession
  • func NewListener(ctx context.Context, listener net.Listener) *ListenerSession
  • func (l *ListenerSession) Accept() (net.Conn, error)
  • func (l *ListenerSession) Addr() net.Addr
  • func (l *ListenerSession) Close() error
  • func (l *ListenerSession) IsClosed() bool
• type Logger
• type Server
  • func NewServer(ctx context.Context, stm io.ReadWriteCloser, instruction *Instruction) *Server
  • func (s *Server) Accept() (io.ReadWriteCloser, error)
  • func (s *Server) AcceptTo(acceptChan chan io.ReadWriteCloser) error
  • func (s Server) Close() error
  • func (s Server) IsClosed() bool

Variables

var (
	HandshakeData          = []byte("EMUX ")
	DefaultClientHandshake = NewHandshake(HandshakeData, true)
	DefaultServerHandshake = NewHandshake(HandshakeData, false)
	DefaultTimeout         = 10 * time.Second
)

DefaultHandshake 0 5 +---------+---------+---------+---------+---------+ | "EMUX " | +---------+---------+---------+---------+---------+

var (
	ErrClosed         = net.ErrClosed
	ErrAlreadyStarted = fmt.Errorf("session already started")
)

var DefaultInstruction = Instruction{
	Close:             0x00,
	Connect:           0xa0,
	Connected:         0xa1,
	Disconnect:        0xc0,
	Disconnected:      0xc1,
	Data:              0xb0,
	MaxDataPacketSize: bufSize - 1 - 2*binary.MaxVarintLen64,
}

var (
	ErrTimeout = fmt.Errorf("timeout")
)

Types

type BytesPool

type BytesPool interface {
	Get() []byte
	Put([]byte)
}

BytesPool is the interface for a bytes pool.

type Client

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

func NewClient

func NewClient(ctx context.Context, stm io.ReadWriteCloser, instruction *Instruction) *Client

func (Client) Close

func (s Client) Close() error

func (*Client) Dial

func (c *Client) Dial(ctx context.Context) (io.ReadWriteCloser, error)

func (Client) IsClosed

func (s Client) IsClosed() bool

type Decode

type Decode struct {
	DecodeReader
}

func NewDecode

func NewDecode(r DecodeReader) *Decode

func (*Decode) ReadBytes

func (d *Decode) ReadBytes() ([]byte, error)

func (*Decode) ReadUvarint

func (d *Decode) ReadUvarint() (uint64, error)

func (*Decode) WriteTo

func (d *Decode) WriteTo(w io.Writer, buf []byte) (int64, error)

type DecodeReader

type DecodeReader interface {
	io.Reader
	io.ByteReader
}

type Dialer

type Dialer interface {
	DialContext(ctx context.Context, network, address string) (net.Conn, error)
}

Dialer contains options for connecting to an address.

type DialerSession

type DialerSession struct {
	BytesPool   BytesPool
	Logger      Logger
	Handshake   Handshake
	Instruction Instruction
	Timeout     time.Duration
	Retry       int
	// contains filtered or unexported fields
}

func NewDialer

func NewDialer(ctx context.Context, dialer Dialer) *DialerSession

func (*DialerSession) DialContext

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

type Encode

type Encode struct {
	EncodeWriter
	// contains filtered or unexported fields
}

func NewEncode

func NewEncode(w EncodeWriter) *Encode

func (*Encode) WriteByte

func (e *Encode) WriteByte(b byte) error

func (*Encode) WriteBytes

func (e *Encode) WriteBytes(b []byte) error

func (*Encode) WriteCmd

func (e *Encode) WriteCmd(cmd uint8, sid uint64) error

func (*Encode) WriteUvarint

func (e *Encode) WriteUvarint(v uint64) error

type EncodeWriter

type EncodeWriter interface {
	io.Writer
	Flush() error
}

type Handshake

type Handshake interface {
	Handshake(ctx context.Context, rw io.ReadWriter) error
}

func NewHandshake

func NewHandshake(h []byte, send bool) Handshake

type Instruction

type Instruction struct {
	Close uint8 // close all sessions and connections, only command

	Connect      uint8 // create a connect stream, with both command and stream id
	Connected    uint8 // reply to connect, with both command and stream id
	Disconnect   uint8 // disconnect a stream and report the reason, with both command and stream id
	Disconnected uint8 // reply to disconnect, with both command and stream id

	Data uint8 // data packet, all fields

	MaxDataPacketSize uint64 // max data packet size
}

type ListenConfig

type ListenConfig interface {
	Listen(ctx context.Context, network, address string) (net.Listener, error)
}

ListenConfig contains options for listening to an address.

type ListenConfigSession

type ListenConfigSession struct {
	Logger      Logger
	BytesPool   BytesPool
	Handshake   Handshake
	Instruction Instruction
	Timeout     time.Duration
	// contains filtered or unexported fields
}

func NewListenConfig

func NewListenConfig(ctx context.Context, listener ListenConfig) *ListenConfigSession

func (*ListenConfigSession) Listen

func (l *ListenConfigSession) Listen(ctx context.Context, network, address string) (net.Listener, error)

type ListenerSession

type ListenerSession struct {
	BytesPool   BytesPool
	Logger      Logger
	Handshake   Handshake
	Instruction Instruction
	Timeout     time.Duration
	// contains filtered or unexported fields
}

func NewListener

func NewListener(ctx context.Context, listener net.Listener) *ListenerSession

func (*ListenerSession) Accept

func (l *ListenerSession) Accept() (net.Conn, error)

func (*ListenerSession) Addr

func (l *ListenerSession) Addr() net.Addr

func (*ListenerSession) Close

func (l *ListenerSession) Close() error

func (*ListenerSession) IsClosed

func (l *ListenerSession) IsClosed() bool

type Logger

type Logger interface {
	Println(v ...interface{})
}

Logger is the interface for logging.

type Server

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

func NewServer

func NewServer(ctx context.Context, stm io.ReadWriteCloser, instruction *Instruction) *Server

func (*Server) Accept

func (s *Server) Accept() (io.ReadWriteCloser, error)

func (*Server) AcceptTo

func (s *Server) AcceptTo(acceptChan chan io.ReadWriteCloser) error

func (Server) Close

func (s Server) Close() error

func (Server) IsClosed

func (s Server) IsClosed() bool