Mozilla

mcmanus@ducksong.com

Applications and Real-Time HTTP Internet-Draft This document defines a mechanism for running the WebSocket Protocol (RFC 6455) over a single stream of an HTTP/2 connection.

The Hypertext Transfer Protocol (HTTP) provides compatible resource-level semantics across different versions but it does not offer compatibility at the connection management level. Other protocols, such as WebSockets, that rely on connection management details of HTTP must be updated for new versions of HTTP. The WebSocket Protocol uses the HTTP/1.1 Upgrade mechanism () to transition a TCP connection from HTTP into a WebSocket connection. A different approach must be taken with HTTP/2 . HTTP/2 does not allow connection-wide header fields and status codes such as the Upgrade and Connection request header fields or the 101 (Switching Protocols) response code due to its multiplexing nature. These are all required by the opening handshake. Being able to bootstrap WebSockets from HTTP/2 allows one TCP connection to be shared by both protocols and extends HTTP/2’s more efficient use of the network to WebSockets. This document extends the HTTP CONNECT method (as specified for HTTP/2 in ). The extension allows the substitution of a new protocol name to connect to rather than the external host normally used by CONNECT. The result is a tunnel on a single HTTP/2 stream that can carry data for WebSockets (or any other protocol). The other streams on the connection may carry more extended CONNECT tunnels, traditional HTTP/2 data, or a mixture of both. This tunneled stream will be multiplexed with other regular streams on the connection and enjoys the normal priority, cancellation, and flow control features of HTTP/2. Streams that successfully establish a WebSocket connection using a tunneled stream and the modifications to the opening handshake defined in this document then use the traditional WebSocket Protocol, treating the stream as if were the TCP connection in that specification.

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here.

This document adds a new SETTINGS Parameter to those defined by . The new parameter name is SETTINGS_ENABLE_CONNECT_PROTOCOL. The value of the parameter MUST be 0 or 1. Upon receipt of SETTINGS_ENABLE_CONNECT_PROTOCOL with a value of 1, a client MAY use the Extended CONNECT definition of this document when creating new streams. Receipt of this parameter by a server does not have any impact. A sender MUST NOT send a SETTINGS_ENABLE_CONNECT_PROTOCOL parameter with the value of 0 after previously sending a value of 1. The use of a SETTINGS Parameter to opt-in to an otherwise incompatible protocol change is a use of “Extending HTTP/2” defined by . Specifically, the addition a new pseudo-header field “:protocol” and the change in meaning of the “:authority” pseudo-header field in require opt-in negotiation. If a client were to use the provisions of the extended CONNECT method defined in this document without first receiving a SETTINGS_ENABLE_CONNECT_PROTOCOL parameter, a non-supporting peer would detect a malformed request and generate a stream error ().

Usage of the CONNECT method in HTTP/2 is defined by . This extension modifies the method in the following ways: A new pseudo-header field :protocol MAY be included on request HEADERS indicating the desired protocol to be spoken on the tunnel created by CONNECT. The pseudo-header field is single valued and contains a value from the HTTP Upgrade Token Registry located at https://www.iana.org/assignments/http-upgrade-tokens/http-upgrade-tokens.xhtml On requests that contain the :protocol pseudo-header field, the :scheme and :path pseudo-header fields of the target URI (See ) MUST also be included. On requests bearing the :protocol pseudo-header field, the :authority pseudo-header field is interpreted according to instead of . In particular, the server MUST NOT create a tunnel to the host indicated by the :authority as it would with a CONNECT method request that was not modified by this extension. Upon receiving a CONNECT request bearing the :protocol pseudo-header field the server establishes a tunnel to another service of the protocol type indicated by the pseudo-header field. This service may or may not be co-located with the server.

The :protocol pseudo-header field MUST be included in the CONNECT request and it MUST have a value of websocket to initiate a WebSocket connection on an HTTP/2 stream. Other HTTP request and response header fields, such as those for manipulating cookies, may be included in the HEADERS with the CONNECT method as usual. This request replaces the GET-based request in and is used to process the WebSockets opening handshake. The scheme of the target URI () MUST be https for wss schemed WebSockets and http for ws schemed WebSockets. The remainder of the Target URI is the same as the websocket URI. The websocket URI is still used for proxy autoconfiguration. The security requirements for the HTTP/2 connection used by this specification are established by for https requests and for http requests. requires the use of Connection and Upgrade header fields that are not part of HTTP/2. They MUST NOT be included in the CONNECT request defined here. requires the use of a Host header field which is also not part of HTTP/2. The Host information is conveyed as part of the :authority pseudo-header field which is required on every HTTP/2 transaction. Implementations using this extended CONNECT to bootstrap WebSockets do not do the processing of the Sec-WebSocket-Key and Sec-WebSocket-Accept header fields as that functionality has been superseded by the :protocol pseudo-header field. The Origin , Sec-WebSocket-Version, Sec-WebSocket-Protocol, and Sec-WebSocket-Extensions header fields are used in the CONNECT request and response header fields in the same way as defined in . Note that HTTP/1 header field names were case-insensitive and HTTP/2 requires they be encoded as lower case. After successfully processing the opening handshake, the peers should proceed with the WebSocket Protocol using the HTTP/2 stream from the CONNECT transaction as if it were the TCP connection referred to in . The state of the WebSocket connection at this point is OPEN as defined by . The HTTP/2 stream closure is also analogous to the TCP connection closure of . Orderly TCP level closures are represented as END_STREAM () flags and RST exceptions are represented with the RST_STREAM () frame with the CANCEL () error code.

[[ From Client ]] [[ From Server ]] SETTINGS SETTINGS_ENABLE_CONNECT_[..] = 1 HEADERS + END_HEADERS :method = CONNECT :protocol = websocket :scheme = https :path = /chat :authority = server.example.com sec-websocket-protocol = chat, superchat sec-websocket-extensions = permessage-deflate sec-websocket-version = 13 origin = http://www.example.com HEADERS + END_HEADERS :status = 200 sec-websocket-protocol = chat DATA WebSocket Data DATA + END_STREAM WebSocket Data DATA + END_STREAM WebSocket Data

A more native integration with HTTP/2 is certainly possible with larger additions to HTTP/2. This design was selected to minimize the solution complexity while still addressing the primary concern of running HTTP/2 and WebSockets concurrently.

This document does not change how WebSockets interacts with HTTP forward proxies. If a client wishing to speak WebSockets connects via HTTP/2 to an HTTP proxy it should continue to use a traditional (i.e. not with a :protocol pseudo-header field) CONNECT to tunnel through that proxy to the WebSocket server via HTTP. The resulting version of HTTP on that tunnel determines whether WebSockets is initiated directly or via a modified CONNECT request described in this document.

ensures that non-WebSockets clients, especially XMLHttpRequest based clients, cannot make a WebSocket connection. Its primary mechanism for doing that is the use of Sec- prefixed request header fields that cannot be created by XMLHttpRequest-based clients. This specification addresses that concern in two ways: XMLHttpRequest also prohibits use of the CONNECT method in addition to Sec- prefixed request header fields. The use of a pseudo-header field is something that is connection specific and HTTP/2 does not ever allow to be created outside of the protocol stack. The security considerations of section 10 continue to apply to the use of the WebSocket Protocol when using this specification with the exception of 10.8. That section is not relevant because it is specific to the boostrapping handshake that is changed in this document.

This document establishes an entry for the HTTP/2 Settings Registry that was established by . Name: SETTINGS_ENABLE_CONNECT_PROTOCOL Code: 0x8 Initial Value: 0 Specification: This document

The 2017 HTTP Workshop had a very productive discussion that helped determine the key problem and acceptable level of solution complexity.