ws/draft.md at 45a3166dccdf4a41a7ec5fae7b2ae196e8a94649

2.4 KiB

Raw Blame History

This document describes the expected usage of the library. It mixes go code and prose to expose what is intended. Also it features expected behavior and some library rules and websocket standards (e.g. RFC).

Warning

This document is not a documentation, it is used by developers to try to find the best interface for an eased usage by other developers using this library.

Handshake

1. Client HTTP Upgrade Request

This request is sent by clients which want to open a new websocket connection.

GET {uri} HTTP/{httpClientVersion}
Host: {host}
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: {clientKey}
Origin: {origin}
Sec-WebSocket-Protocol: {clientProtocols[]}
Sec-WebSocket-Extensions: {clientExtensions[]}
Sec-WebSocket-Version: {wsVersion}

Required fields

httpClientVersion at least 1.1
host ...
Upgrade: websocket header (not case sensitive)
Connection: Upgrade header (not case sensitive)
Origin for security issues only when from browser (to study)
clientKey because it is not consistent websocket without it. It must be a 16-byte value base64 encoded
wsVersion is required to be 13

Optional fields

clientProtocols[] if not received is an empty list
clientExtensions[] if not received is an empty list

2. Server HTTP Response

HTTP/{httpServerVersion} {errorCode} Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: {serverKey}
Sec-WebSocket-Protocol: {serverProtocol}