@airterm/protocol 0.2.0 → 0.3.0

package/dist/transport.js

@@ -0,0 +1,85 @@
+import { decodeInnerFrame, encodeInnerFrame, } from './framing.js';
+import { NoiseTransport } from './noise.js';
+import { OutboundQueue } from './outbound-queue.js';
+export class WebSocketTransport {
+    buffered;
+    send;
+    stop;
+    constructor(buffered, send, stop) {
+        this.buffered = buffered;
+        this.send = send;
+        this.stop = stop;
+    }
+    get bufferedAmount() {
+        return this.buffered();
+    }
+    write(bytes, done) {
+        this.send(bytes, done);
+    }
+    close() {
+        this.stop();
+    }
+}
+/** Owns ciphers and encrypts only when the bounded scheduler actually writes. */
+export class EncryptedConnection {
+    transport;
+    options;
+    events;
+    #noise;
+    #queue;
+    #closed = false;
+    constructor(transport, options, events) {
+        this.transport = transport;
+        this.options = options;
+        this.events = events;
+        this.#noise = new NoiseTransport(options);
+        this.#queue = new OutboundQueue(() => transport.bufferedAmount, (frame, done) => transport.write(this.#noise.encrypt(encodeInnerFrame(frame)), done), (paused) => events.onBackpressure?.(paused), (error) => {
+            this.close();
+            events.onFailure(error);
+        });
+    }
+    get complete() {
+        return !this.#closed && this.#noise.complete;
+    }
+    get pendingBytes() {
+        return this.#queue.pendingBytes;
+    }
+    start() {
+        if (this.options.initiator && !this.#closed)
+            this.#writeHandshake();
+    }
+    receive(bytes) {
+        if (this.#closed)
+            return;
+        if (!this.#noise.complete) {
+            this.#noise.readHandshake(bytes);
+            if (!this.options.initiator)
+                this.#writeHandshake();
+            if (this.complete)
+                this.events.onSecure?.();
+        }
+        else {
+            this.events.onFrame?.(decodeInnerFrame(this.#noise.decrypt(bytes)));
+        }
+    }
+    send(frame) {
+        if (!this.complete)
+            return Promise.reject(new Error('Encrypted transport is not ready.'));
+        return this.#queue.send(frame);
+    }
+    close() {
+        if (this.#closed)
+            return;
+        this.#closed = true;
+        this.#queue.close();
+    }
+    #writeHandshake() {
+        this.transport.write(this.#noise.writeHandshake(), (error) => {
+            if (error && !this.#closed) {
+                this.close();
+                this.events.onFailure(error);
+            }
+        });
+    }
+}
+//# sourceMappingURL=transport.js.map

package/dist/transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.js","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAChB,gBAAgB,GAEnB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,cAAc,EAA8B,MAAM,YAAY,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AASpD,MAAM,OAAO,kBAAkB;IAEN;IACA;IACA;IAHrB,YACqB,QAAsB,EACtB,IAA8B,EAC9B,IAAgB;QAFhB,aAAQ,GAAR,QAAQ,CAAc;QACtB,SAAI,GAAJ,IAAI,CAA0B;QAC9B,SAAI,GAAJ,IAAI,CAAY;IAClC,CAAC;IACJ,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IACM,KAAK,CACR,KAAiB,EACjB,IAAoC;QAEpC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3B,CAAC;IACM,KAAK;QACR,IAAI,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC;CACJ;AASD,iFAAiF;AACjF,MAAM,OAAO,mBAAmB;IAKP;IACA;IACA;IANZ,MAAM,CAAiB;IACvB,MAAM,CAAgB;IAC/B,OAAO,GAAG,KAAK,CAAC;IAChB,YACqB,SAA0B,EAC1B,OAA8B,EAC9B,MAAiC;QAFjC,cAAS,GAAT,SAAS,CAAiB;QAC1B,YAAO,GAAP,OAAO,CAAuB;QAC9B,WAAM,GAAN,MAAM,CAA2B;QAElD,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,aAAa,CAC3B,GAAG,EAAE,CAAC,SAAS,CAAC,cAAc,EAC9B,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACZ,SAAS,CAAC,KAAK,CACX,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAC5C,IAAI,CACP,EACL,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAC3C,CAAC,KAAK,EAAE,EAAE;YACN,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC,CACJ,CAAC;IACN,CAAC;IACD,IAAW,QAAQ;QACf,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;IACjD,CAAC;IACD,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IACpC,CAAC;IACM,KAAK;QACR,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,eAAe,EAAE,CAAC;IACxE,CAAC;IACM,OAAO,CAAC,KAAiB;QAC5B,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS;gBAAE,IAAI,CAAC,eAAe,EAAE,CAAC;YACpD,IAAI,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;QAChD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IACM,IAAI,CAAC,KAAiB;QACzB,IAAI,CAAC,IAAI,CAAC,QAAQ;YACd,OAAO,OAAO,CAAC,MAAM,CACjB,IAAI,KAAK,CAAC,mCAAmC,CAAC,CACjD,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IACM,KAAK;QACR,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IACD,eAAe;QACX,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE;YACzD,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACzB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YACjC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/webrtc-transport.d.ts

@@ -0,0 +1,14 @@
+import type { BinaryTransport } from './transport.js';
+/** Ordered fragmentation is below encryption; only complete bounded frames escape. */
+export declare class WebRTCTransport implements BinaryTransport {
+    #private;
+    private readonly channel;
+    private readonly receiveFrame;
+    private readonly failure;
+    constructor(channel: BinaryTransport, receiveFrame: (bytes: Uint8Array) => void, failure: (error: Error) => void);
+    get bufferedAmount(): number;
+    write(bytes: Uint8Array, done: (error?: Error | null) => void): void;
+    receive(fragment: Uint8Array): void;
+    close(): void;
+}
+//# sourceMappingURL=webrtc-transport.d.ts.map

package/dist/webrtc-transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webrtc-transport.d.ts","sourceRoot":"","sources":["../src/webrtc-transport.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAMtD,sFAAsF;AACtF,qBAAa,eAAgB,YAAW,eAAe;;IAO/C,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAFP,OAAO,EAAE,eAAe,EACxB,YAAY,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,EACzC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI;IAEpD,IAAW,cAAc,IAAI,MAAM,CAElC;IACM,KAAK,CACR,KAAK,EAAE,UAAU,EACjB,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI,KAAK,IAAI,GACrC,IAAI;IAqCA,OAAO,CAAC,QAAQ,EAAE,UAAU,GAAG,IAAI;IAkDnC,KAAK,IAAI,IAAI;CAavB"}

package/dist/webrtc-transport.js

@@ -0,0 +1,106 @@
+import { MAX_CIPHERTEXT_BYTES } from './framing.js';
+const MESSAGE_BYTES = 16 * 1024;
+const HEADER_BYTES = 8;
+const FRAME_BYTES = MAX_CIPHERTEXT_BYTES + 2;
+/** Ordered fragmentation is below encryption; only complete bounded frames escape. */
+export class WebRTCTransport {
+    channel;
+    receiveFrame;
+    failure;
+    #assembly;
+    #offset = 0;
+    #timer;
+    #closed = false;
+    #writing = false;
+    constructor(channel, receiveFrame, failure) {
+        this.channel = channel;
+        this.receiveFrame = receiveFrame;
+        this.failure = failure;
+    }
+    get bufferedAmount() {
+        return this.channel.bufferedAmount;
+    }
+    write(bytes, done) {
+        if (this.#closed ||
+            this.#writing ||
+            bytes.length < 2 ||
+            bytes.length > FRAME_BYTES) {
+            done(new Error('Invalid direct transport write.'));
+            return;
+        }
+        this.#writing = true;
+        let offset = 0;
+        const next = (error) => {
+            if (error || this.#closed) {
+                this.#writing = false;
+                done(error ?? new Error('Direct transport closed.'));
+                return;
+            }
+            if (offset === bytes.length) {
+                this.#writing = false;
+                done();
+                return;
+            }
+            const end = Math.min(bytes.length, offset + MESSAGE_BYTES - HEADER_BYTES);
+            const fragment = new Uint8Array(HEADER_BYTES + end - offset);
+            const header = new DataView(fragment.buffer);
+            header.setUint32(0, bytes.length);
+            header.setUint32(4, offset);
+            fragment.set(bytes.subarray(offset, end), HEADER_BYTES);
+            offset = end;
+            this.channel.write(fragment, next);
+        };
+        next();
+    }
+    receive(fragment) {
+        if (this.#closed)
+            return;
+        try {
+            if (fragment.length <= HEADER_BYTES ||
+                fragment.length > MESSAGE_BYTES)
+                throw new Error('Invalid direct fragment size.');
+            const view = new DataView(fragment.buffer, fragment.byteOffset, fragment.byteLength);
+            const length = view.getUint32(0);
+            const offset = view.getUint32(4);
+            if (length < 2 || length > FRAME_BYTES || offset !== this.#offset)
+                throw new Error('Invalid direct fragment offset.');
+            if (this.#assembly === undefined) {
+                this.#assembly = new Uint8Array(length);
+                this.#timer = setTimeout(() => this.#fail(new Error('Direct frame assembly timed out.')), 10_000);
+            }
+            if (length !== this.#assembly.length ||
+                offset + fragment.length - HEADER_BYTES > length)
+                throw new Error('Invalid direct fragment length.');
+            this.#assembly.set(fragment.subarray(HEADER_BYTES), offset);
+            this.#offset += fragment.length - HEADER_BYTES;
+            if (this.#offset === length) {
+                const frame = this.#assembly;
+                this.#assembly = undefined;
+                this.#offset = 0;
+                clearTimeout(this.#timer);
+                this.#timer = undefined;
+                this.receiveFrame(frame);
+            }
+        }
+        catch (error) {
+            this.#fail(error instanceof Error
+                ? error
+                : new Error('Direct transport failed.'));
+        }
+    }
+    close() {
+        if (this.#closed)
+            return;
+        this.#closed = true;
+        clearTimeout(this.#timer);
+        this.#timer = undefined;
+        this.#assembly = undefined;
+        this.#offset = 0;
+        this.channel.close();
+    }
+    #fail(error) {
+        this.close();
+        this.failure(error);
+    }
+}
+//# sourceMappingURL=webrtc-transport.js.map

package/dist/webrtc-transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webrtc-transport.js","sourceRoot":"","sources":["../src/webrtc-transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAGpD,MAAM,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC;AAChC,MAAM,YAAY,GAAG,CAAC,CAAC;AACvB,MAAM,WAAW,GAAG,oBAAoB,GAAG,CAAC,CAAC;AAE7C,sFAAsF;AACtF,MAAM,OAAO,eAAe;IAOH;IACA;IACA;IARrB,SAAS,CAAyB;IAClC,OAAO,GAAG,CAAC,CAAC;IACZ,MAAM,CAA4C;IAClD,OAAO,GAAG,KAAK,CAAC;IAChB,QAAQ,GAAG,KAAK,CAAC;IACjB,YACqB,OAAwB,EACxB,YAAyC,EACzC,OAA+B;QAF/B,YAAO,GAAP,OAAO,CAAiB;QACxB,iBAAY,GAAZ,YAAY,CAA6B;QACzC,YAAO,GAAP,OAAO,CAAwB;IACjD,CAAC;IACJ,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACvC,CAAC;IACM,KAAK,CACR,KAAiB,EACjB,IAAoC;QAEpC,IACI,IAAI,CAAC,OAAO;YACZ,IAAI,CAAC,QAAQ;YACb,KAAK,CAAC,MAAM,GAAG,CAAC;YAChB,KAAK,CAAC,MAAM,GAAG,WAAW,EAC5B,CAAC;YACC,IAAI,CAAC,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC,CAAC;YACnD,OAAO;QACX,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,MAAM,IAAI,GAAG,CAAC,KAAoB,EAAQ,EAAE;YACxC,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACxB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;gBACtB,IAAI,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC;gBACrD,OAAO;YACX,CAAC;YACD,IAAI,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;gBACtB,IAAI,EAAE,CAAC;gBACP,OAAO;YACX,CAAC;YACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAChB,KAAK,CAAC,MAAM,EACZ,MAAM,GAAG,aAAa,GAAG,YAAY,CACxC,CAAC;YACF,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,YAAY,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC;YAC7D,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7C,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAClC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5B,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,YAAY,CAAC,CAAC;YACxD,MAAM,GAAG,GAAG,CAAC;YACb,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC,CAAC;QACF,IAAI,EAAE,CAAC;IACX,CAAC;IACM,OAAO,CAAC,QAAoB;QAC/B,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC;YACD,IACI,QAAQ,CAAC,MAAM,IAAI,YAAY;gBAC/B,QAAQ,CAAC,MAAM,GAAG,aAAa;gBAE/B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACrD,MAAM,IAAI,GAAG,IAAI,QAAQ,CACrB,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,UAAU,CACtB,CAAC;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACjC,IAAI,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG,WAAW,IAAI,MAAM,KAAK,IAAI,CAAC,OAAO;gBAC7D,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;YACvD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;gBACxC,IAAI,CAAC,MAAM,GAAG,UAAU,CACpB,GAAG,EAAE,CACD,IAAI,CAAC,KAAK,CACN,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAChD,EACL,MAAM,CACT,CAAC;YACN,CAAC;YACD,IACI,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM;gBAChC,MAAM,GAAG,QAAQ,CAAC,MAAM,GAAG,YAAY,GAAG,MAAM;gBAEhD,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;YACvD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5D,IAAI,CAAC,OAAO,IAAI,QAAQ,CAAC,MAAM,GAAG,YAAY,CAAC;YAC/C,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;gBAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;gBAC3B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;gBACjB,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;gBACxB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,KAAK,CACN,KAAK,YAAY,KAAK;gBAClB,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAC9C,CAAC;QACN,CAAC;IACL,CAAC;IACM,KAAK;QACR,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;QACjB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IACD,KAAK,CAAC,KAAY;QACd,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@airterm/protocol",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "description": "Shared browser and Node.js protocol implementation for AirTerm",
     "keywords": [
         "terminal",