Skip to content

[Feature suggestion & draft] Redesigned browser dialer #3840

Open
@PoneyClairDeLune

Description

A continuation of #3832. Aimed at maximizing throughput and minimizing resource consumption on the browser side, and also potentially allowing arbitrary headers with the browser dialer.

Prerequisites

This draft is designed with the following assumptions.

  • The web server implementation in Go supports routable HTTP servers with streaming and WebSocket support.
  • The implementation of maps in Go is 💫 blazingly fast 💫.
  • The user has a recent installation of a modern browser (Chromium, Firefox or Safari).

Design

Still not fleshed out. Critiques are welcomed!

Web routes

WS /control

The control plane. This is the only place where any form of processing can happen with all possible latest web features. Xray can command the browser dialer on what and how to connect through it. If request bodies from Meek-like transports are not streamed, this should also carry the body of the request.

Message structure
Byte length Required? Use
4 (uint32) Y Length of payload. MSB to eliminate uncertainty of endianness with a somewhat fast implementation, or LSB to maximize speed. Should always be 0 for WebSocket connections and streamed web requests.
variable Y JSON-encoded command.
variable N Raw payload. Currently only used by non-streamed requests to post to remote.
Commands
{
	"m": "WS", // Method, can be "WS", "GET" or "POST"
	"p": "", // A string or an array of strings for expected **WebSocket** protocols
	"r": "", // Remote URL
	"i": 65535, // A numerical (positive integer) or a web-safe random string ID to distinguish connections
	"h": {} // A map of non-restricted custom headers to send to the server, cannot be used for WebSocket
}

WS /data?id=<socketId>

For Chrome 124 and later. Where contents of WebSocket connections are passed through without any processing.

WebSocketStream - MDN

GET/POST /data?id=<socketId>

For Chrome 105 and later. Where contents of all web-compliant connections are passed through without any processing. Has the exact same use as above, only that for each duplex connection, a get-post pair is created due to browsers refusing to support HTTP/2 cleartext.

Send ReadableStream in request body - caniuse.com

Browser-side behaviour

Criteria WebSocket behaviour
WebSocketStream WebSocketStream pass-through 1
Anything else Iterated WebSocket
Criteria Meek-like behaviour
Chrome 105+ Request stream pass-through
Anything else Iterated bodies (memory leak)
  • 1: Using streamed requests instead of streamed WebSocket on the local machine may yield better performance, as instead of native piping, server to client messages could all be in pass-through.

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions