werift 0.24.4 → 0.25.0

package/lib/sctp/src/sctp.d.ts

@@ -4,6 +4,13 @@ import { type Unpacked } from "./helper";
 import { Event } from "./imports/common";
 import { OutgoingSSNResetRequestParam, type StreamParam } from "./param";
 import type { Transport } from "./transport";
+export declare const DEFAULT_SCTP_MTU = 1191;
+export interface SCTPOptions {
+    /** SCTP packet MTU used for outbound DATA chunk fragmentation. */
+    mtu?: number;
+}
+export declare function maxPayloadSizeForMtu(mtu: number, dataChunkHeaderSize?: number): number;
+export declare function validateSctpMtu(mtu: number): void;
 declare const SCTPConnectionStates: readonly ["new", "closed", "connected", "connecting"];
 type SCTPConnectionState = Unpacked<typeof SCTPConnectionStates>;
 export declare class SCTP {
@@ -46,6 +53,8 @@ export declare class SCTP {
     private sackImmediate;
     private sackTimeout;
     private cwnd;
+    readonly mtu: number;
+    private readonly maxPayloadSize;
     private fastRecoveryExit?;
     private fastRecoveryTransmit;
     private forwardTsnChunk?;
@@ -86,11 +95,11 @@ export declare class SCTP {
     private timerHeartbeatHandle?;
     private heartbeatInterval;
     private ssthresh?;
-    constructor(transport: Transport, port?: number);
+    constructor(transport: Transport, port?: number, options?: SCTPOptions);
     private get isStopped();
     get maxChannels(): number | undefined;
-    static client(transport: Transport, port?: number): SCTP;
-    static server(transport: Transport, port?: number): SCTP;
+    static client(transport: Transport, port?: number, options?: SCTPOptions): SCTP;
+    static server(transport: Transport, port?: number, options?: SCTPOptions): SCTP;
     private handleData;
     private scheduleSack;
     private sendSack;

package/lib/sctp/src/sctp.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RTCSctpCapabilities = exports.InboundStream = exports.SCTP = void 0;
+exports.RTCSctpCapabilities = exports.InboundStream = exports.SCTP = exports.DEFAULT_SCTP_MTU = void 0;
+exports.maxPayloadSizeForMtu = maxPayloadSizeForMtu;
+exports.validateSctpMtu = validateSctpMtu;
 const crypto_1 = require("crypto");
 const chunk_1 = require("./chunk");
 const const_1 = require("./const");
@@ -13,7 +15,22 @@ const log = (0, common_1.debug)("werift/sctp/sctp");
 const COOKIE_LENGTH = 24;
 const COOKIE_LIFETIME = 60;
 const MAX_STREAMS = 65535;
-const USERDATA_MAX_LENGTH = 1200;
+exports.DEFAULT_SCTP_MTU = 1191;
+function maxPayloadSizeForMtu(mtu, dataChunkHeaderSize = chunk_1.SCTP_DATA_CHUNK_HEADER_SIZE) {
+    const headerSize = chunk_1.SCTP_COMMON_HEADER_SIZE + dataChunkHeaderSize;
+    if (mtu <= headerSize)
+        return 0;
+    const payloadBudget = mtu - headerSize;
+    return payloadBudget - (payloadBudget % chunk_1.SCTP_PADDING_MULTIPLE);
+}
+function validateSctpMtu(mtu) {
+    if (!Number.isSafeInteger(mtu) || mtu <= 0) {
+        throw new Error("SCTP MTU must be a positive integer");
+    }
+    if (maxPayloadSizeForMtu(mtu) === 0) {
+        throw new Error("SCTP MTU is too small for a DATA chunk");
+    }
+}
 // # protocol constants
 const SCTP_DATA_LAST_FRAG = 0x01;
 const SCTP_DATA_FIRST_FRAG = 0x02;
@@ -48,7 +65,7 @@ class SCTP {
         // RFC 9260 §6.2.1(D-ii): available receiver window = a_rwnd - outstanding DATA.
         return Math.max(0, this.peerAdvertisedRwnd - this.flightSize);
     }
-    constructor(transport, port = 5000) {
+    constructor(transport, port = 5000, options = {}) {
         Object.defineProperty(this, "transport", {
             enumerable: true,
             configurable: true,
@@ -260,8 +277,20 @@ class SCTP {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 3 * USERDATA_MAX_LENGTH
+            value: void 0
         }); // Congestion Window
+        Object.defineProperty(this, "mtu", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "maxPayloadSize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "fastRecoveryExit", {
             enumerable: true,
             configurable: true,
@@ -477,7 +506,7 @@ class SCTP {
             writable: true,
             value: async (streamId, ppId, userData, { expiry, maxRetransmits, ordered, } = { expiry: undefined, maxRetransmits: undefined, ordered: true }) => {
                 const streamSeqNum = ordered ? this.outboundStreamSeq[streamId] || 0 : 0;
-                const fragments = Math.ceil(userData.length / USERDATA_MAX_LENGTH);
+                const fragments = Math.ceil(userData.length / this.maxPayloadSize);
                 let pos = 0;
                 const chunks = [];
                 for (let fragment = 0; fragment < fragments; fragment++) {
@@ -496,11 +525,11 @@ class SCTP {
                     chunk.streamId = streamId;
                     chunk.streamSeqNum = streamSeqNum;
                     chunk.protocol = ppId;
-                    chunk.userData = userData.slice(pos, pos + USERDATA_MAX_LENGTH);
+                    chunk.userData = userData.slice(pos, pos + this.maxPayloadSize);
                     chunk.bookSize = chunk.userData.length;
                     chunk.expiry = expiry;
                     chunk.maxRetransmits = maxRetransmits;
-                    pos += USERDATA_MAX_LENGTH;
+                    pos += this.maxPayloadSize;
                     this.localTsn = tsnPlusOne(this.localTsn);
                     chunks.push(chunk);
                 }
@@ -587,8 +616,8 @@ class SCTP {
                 this.fastRecoveryExit = undefined;
                 this.flightSize = 0;
                 this.partialBytesAcked = 0;
-                this.ssthresh = Math.max(Math.floor(this.cwnd / 2), 4 * USERDATA_MAX_LENGTH);
-                this.cwnd = USERDATA_MAX_LENGTH;
+                this.ssthresh = Math.max(Math.floor(this.cwnd / 2), 4 * this.maxPayloadSize);
+                this.cwnd = this.maxPayloadSize;
                 this.transmit();
             }
         });
@@ -636,6 +665,10 @@ class SCTP {
                 this.heartbeatStart();
             }
         });
+        this.mtu = options.mtu ?? exports.DEFAULT_SCTP_MTU;
+        validateSctpMtu(this.mtu);
+        this.maxPayloadSize = maxPayloadSizeForMtu(this.mtu);
+        this.cwnd = 3 * this.maxPayloadSize;
         this.localPort = this.port;
         this.transport.onData = (buf) => {
             this.handleData(buf);
@@ -650,13 +683,13 @@ class SCTP {
         }
         return undefined;
     }
-    static client(transport, port = 5000) {
-        const sctp = new SCTP(transport, port);
+    static client(transport, port = 5000, options = {}) {
+        const sctp = new SCTP(transport, port, options);
         sctp.isServer = false;
         return sctp;
     }
-    static server(transport, port = 5000) {
-        const sctp = new SCTP(transport, port);
+    static server(transport, port = 5000, options = {}) {
+        const sctp = new SCTP(transport, port, options);
         sctp.isServer = true;
         return sctp;
     }
@@ -1098,18 +1131,18 @@ class SCTP {
         if (this.fastRecoveryExit === undefined) {
             if (done && cwndFullyUtilized) {
                 if (this.cwnd <= this.ssthresh) {
-                    this.cwnd += Math.min(doneBytes, USERDATA_MAX_LENGTH);
+                    this.cwnd += Math.min(doneBytes, this.maxPayloadSize);
                 }
                 else {
                     this.partialBytesAcked += doneBytes;
                     if (this.partialBytesAcked >= this.cwnd) {
                         this.partialBytesAcked -= this.cwnd;
-                        this.cwnd += USERDATA_MAX_LENGTH;
+                        this.cwnd += this.maxPayloadSize;
                     }
                 }
             }
             if (loss) {
-                this.ssthresh = Math.max(Math.floor(this.cwnd / 2), 4 * USERDATA_MAX_LENGTH);
+                this.ssthresh = Math.max(Math.floor(this.cwnd / 2), 4 * this.maxPayloadSize);
                 this.cwnd = this.ssthresh;
                 this.partialBytesAcked = 0;
                 this.fastRecoveryExit = this.sentQueue[this.sentQueue.length - 1].tsn;
@@ -1243,8 +1276,8 @@ class SCTP {
             }
         }
         const burstSize = this.fastRecoveryExit != undefined
-            ? 2 * USERDATA_MAX_LENGTH
-            : 4 * USERDATA_MAX_LENGTH;
+            ? 2 * this.maxPayloadSize
+            : 4 * this.maxPayloadSize;
         const cwnd = Math.min(this.flightSize + burstSize, this.cwnd);
         let retransmitEarliest = true;
         for (const dataChunk of this.sentQueue) {