WiSH: A General Purpose Message Framing over Byte-Stream Oriented Wire Protocols (HTTP)

The WebSocket protocol was proposed to provide native client-server bi-directional messaging for the Web. It has been implemented and deployed widely, but there are still missing semantics and functionalities. See . WiSH is a message framing format for use over the standard HTTP semantics to provide bi-directional messaging semantics. WiSH stands for Web in Strict HTTP. The communication protocol providing the HTTP semantics can be HTTP/1.1 , HTTP/2 , HTTP/2 + QUIC , or any future protocols. Wire-protocol functionalities such as compression, multiplexing, session priority, etc. are provided by the underlying protocol . Unlike HTTP/2, HTTP/1.1 doesn't specify if earlier 2xx responses are allowed . Therefore when HTTP/1.1 is used as the underlying protocol, full-duplex communication may be broken if the client, server or any proxy chooses to buffer or reject earlier 2xx responses. Since proxies may buffer response bodies, communication over WiSH may experience extra latency compared to WebSocket. When HTTPS is used, response buffering by proxies is less likely to happen. Wire-protocol features of WebSocket, such as handshake or control messages, are all dropped. The WiSH framing respects the semantics of the underlying protocol (as opposed to turning it to a transport protocol). The concept of fragmentation is retained for enabling starting message transmission before determining the final length of the message. Application-level protocols may use WiSH as the framing protocol to support bi-directional communication over HTTP and for Web and Internet clients.

There has been several attempts to improve bi-directional message-based communication on the Web. The server-sent events realized message-based communication in the server-to-client direction, by introducing a new Web API and a special message framing format while using HTTP as the wire protocol. Except for the issue of possible buffering by intermediaries, the server-sent events work well with existing intermediaries and frameworks that support HTTP. WebSocket introduced both a new Web API and a new wire protocol to realize bi-directional message-based communication. Because the wire protocol is incompatible with HTTP, intermediaries and frameworks have to be upgraded to understand the protocol to support WebSocket. In parallel to the development of WebSocket, HTTP has been greatly improved with HTTP/2. There are more improvements upcoming e.g. QUIC to the HTTP. At the same time, the Web APIs for HTTP have also been improved. The XMLHttpRequest is being replaced with the Fetch API which allows for streamed uploading and downloading of the body part of HTTP messages by using the Streams API . The Streams API also enables implementing data transfer and various data processing (e.g. compression/decompression, message framing) in the form of the transform stream. The transform stream mechanism is designed to allow for optimizing transfer and processing by offloading some part of them from the JavaScript world. It's desirable that furthur evolution of bi-directional message-based communication utilize HTTP/2 to reduce cost of development and standardization. Bidi communication should be multiplexed with normal HTTP traffic and should benefit from future transport-level improvements such as QUIC. The WiSH idea is based on the above analysis. Combination of the Fetch API and transform streams enables efficient processing of the WiSH framing. Use of the HTTP semantics as-is reduces cost and makes the Web simpler. Once the WiSH idea is successfully adopted, binding to the WebSocket API could be introduced as furthur optimization for existing WebSocket users.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in . Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the meaning of the key word ("MUST", "SHOULD", "MAY", etc.) used in introducing the algorithm. Conformance requirements phrased as algorithms or specific steps can be implemented in any manner, so long as the end result is equivalent. In particular, the algorithms defined in this specification are intended to be easy to understand and are not intended to be performant.

WiSH frames messages over an HTTP request or response body using the framing defined in . The Content-Type header value of the underlying HTTP request/response message MUST be application/webstream.

0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-------+-+-------------+-------------------------------+ |F|0|0|0|opcode |0|Payload |Extended payload length | |I| | | |4 bit | |length |16 bit if payload length is 126| |N| | | | | |7 bit |64 bit if payload length is 127| +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - + | | + - - - - - - - - - - - - - - - +-------------------------------+ | |Payload Data | +-------------------------------+ - - - - - - - - - - - - - - - + | | +---------------------------------------------------------------+ WiSH framing is compatible with the framing defined in for the WebSocket protocol. The opcode field indicates how to interpret the payload data field. WiSH uses the following opcodes. %x0 denotes a continuation frame %x1 denotes a text frame %x2 denotes a binary frame Any values not listed here are reserved. The FIN bit together with the continuation frame opcode, payload length and extended payload length work in the same way as WebSocket to represent frames and messages. The fragmentation mechanism allows for flushing part of a large message payload without waiting for the total size of the message to be determined. The message type distinction by the opcode field (text and binary) is kept to allow better Web support. One of the possible use cases is to use the text type for exchaning meta data encoded in JSON, etc., and the binary type for exchanging non-meta data messages. The status code and status reason defined in the WebSocket protocol are dropped. The ping and pong control message of the WebSocket protocol are dropped. If such a feature is needed, it should be provided by underlying protocols. The permessage-deflate extension is defined for the WebSocket protocol, to add a compression mechanism to it. No extension mechanism is defined for WiSH. Compression can be implemented by underlying protocols or in the application layer if needed. What contents are exchanged and in what encoding they are exchanged over WiSH are to be defined by the application layer.

Thank you to the following people for giving feedback to the document: Ben Christensen, Kari Hurtta, Roberto Peon.