wsoding

README

wsoding - Tsoding's c3ws library translated to Go

Made it work for majority of the Autobahn Test Cases, so this project can be considered done (with extremely unfriendly API)

Echo Server

./build.sh 

In one terminal:

./build/echo_server

In another terminal

./build/send_client 127.0.0.1 9001 "Hello, World" 

You can also connect to the server from a browser:

firefox ./tools/example_send_client.html

Autobahn Test Suite

docker run -it --rm --net=host \
    -v ${PWD}/autobahn:/config \
    -v ${PWD}/reports:/reports \
    crossbario/autobahn-testsuite \
    wstest -m fuzzingclient -s /config/fuzzingclient.json

firefox ./reports/servers/index.html

Documentation

Index

• Variables
• type WS
  • func Accept(ctx context.Context, sock *socket.Conn) (WS, error)
  • func Connect(ctx context.Context, sock *socket.Conn, host string, endpoint string) (WS, error)
  • func (ws *WS) ClientHandshake(ctx context.Context, host, endpoint string) error
  • func (ws *WS) Close() error
  • func (ws *WS) ReadMessage() (*WSMessage, error)
  • func (ws *WS) SendBinary(binary []byte) error
  • func (ws *WS) SendFrame(fin bool, opcode WSOpcode, payload []byte) error
  • func (ws *WS) SendMessage(kind WSMessageKind, payload []byte) error
  • func (ws *WS) SendText(text string) error
  • func (ws *WS) ServerHandshake(ctx context.Context) error
• type WSFrameHeader
• type WSMessage
• type WSMessageKind
• type WSOpcode

Variables

var ErrClientHandshakeBadAccept = errors.New("client handshake bad accept")

var ErrClientHandshakeBadResponse = errors.New("client handshake bad response")

Client Handshake Errors

var ErrClientHandshakeDuplicateAccept = errors.New("client handshake duplicate accept")

var ErrClientHandshakeNoAccept = errors.New("client handshake no accept")

var ErrCloseFrameSent = errors.New("close frame sent")

Connection Errors

var ErrControlFrameTooBig = errors.New("control frame too big")

var ErrInvalidUtf8 = errors.New("invalid utf-8")

var ErrReservedBitsNotNegotiated = errors.New("reserved bits not negotiated")

var ErrServerHandshakeBadRequest = errors.New("server handshake bad request")

Server Handshake Errors

var ErrServerHandshakeDuplicateKey = errors.New("server handshake duplicate key")

var ErrServerHandshakeNoKey = errors.New("server handshake no key")

var ErrShortUtf8 = errors.New("short utf-8")

utf-8 Errors

var ErrUnexpectedOpCode = errors.New("unexpected opcode")

Types

type WS

type WS struct {
	Sock   *socket.Conn
	Debug  bool
	Client bool
}

func Accept

func Accept(ctx context.Context, sock *socket.Conn) (WS, error)

func Connect

func Connect(ctx context.Context, sock *socket.Conn, host string, endpoint string) (WS, error)

func (*WS) ClientHandshake

func (ws *WS) ClientHandshake(ctx context.Context, host, endpoint string) error

func (*WS) Close

func (ws *WS) Close() error

func (*WS) ReadMessage

func (ws *WS) ReadMessage() (*WSMessage, error)

func (*WS) SendBinary

func (ws *WS) SendBinary(binary []byte) error

func (*WS) SendFrame

func (ws *WS) SendFrame(fin bool, opcode WSOpcode, payload []byte) error

func (*WS) SendMessage

func (ws *WS) SendMessage(kind WSMessageKind, payload []byte) error

func (*WS) SendText

func (ws *WS) SendText(text string) error

func (*WS) ServerHandshake

func (ws *WS) ServerHandshake(ctx context.Context) error

type WSFrameHeader

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

type WSMessage

type WSMessage struct {
	Kind    WSMessageKind
	Payload []byte
}

type WSMessageKind

type WSMessageKind byte

const MessageBIN WSMessageKind = WSMessageKind(OpCodeBIN)

const MessageTEXT WSMessageKind = WSMessageKind(OpCodeTEXT)

type WSOpcode

type WSOpcode byte

const (
	OpCodeCONT  WSOpcode = 0x0
	OpCodeTEXT  WSOpcode = 0x1
	OpCodeBIN   WSOpcode = 0x2
	OpCodeCLOSE WSOpcode = 0x8
	OpCodePING  WSOpcode = 0x9
	OpCodePONG  WSOpcode = 0xA
)