@@ -1398,6 +1363,7 @@ export default {
},
hasDomain: false,
acceptedStatusCodeOptions: [],
+ acceptedWebsocketCodeOptions: [],
dnsresolvetypeOptions: [],
kafkaSaslMechanismOptions: [],
ipOrHostnameRegexPattern: hostNameRegexPattern(),
@@ -1770,6 +1736,7 @@ message HealthCheckResponse {
"monitor.type"(newType, oldType) {
if (oldType && this.monitor.type === "websocket-upgrade") {
this.monitor.url = "wss://";
+ this.monitor.accepted_statuscodes = [ "1000" ];
}
if (this.monitor.type === "push") {
if (! this.monitor.pushToken) {
@@ -1877,6 +1844,8 @@ message HealthCheckResponse {
"500-599",
];
+ let acceptedWebsocketCodeOptions = [];
+
let dnsresolvetypeOptions = [
"A",
"AAAA",
@@ -1902,6 +1871,11 @@ message HealthCheckResponse {
acceptedStatusCodeOptions.push(i.toString());
}
+ for (let i = 1000; i <= 4999; i++) {
+ acceptedWebsocketCodeOptions.push(i.toString());
+ }
+
+ this.acceptedWebsocketCodeOptions = acceptedWebsocketCodeOptions;
this.acceptedStatusCodeOptions = acceptedStatusCodeOptions;
this.dnsresolvetypeOptions = dnsresolvetypeOptions;
this.kafkaSaslMechanismOptions = kafkaSaslMechanismOptions;
diff --git a/test/backend-test/test-websocket.js b/test/backend-test/test-websocket.js
index 33660d134..3eeeb3243 100644
--- a/test/backend-test/test-websocket.js
+++ b/test/backend-test/test-websocket.js
@@ -3,15 +3,34 @@ const { describe, test } = require("node:test");
const assert = require("node:assert");
const { WebSocketMonitorType } = require("../../server/monitor-types/websocket-upgrade");
const { UP, PENDING } = require("../../src/util");
+const net = require("node:net");
+
+/**
+ * Simulates non compliant WS Server, doesnt send Sec-WebSocket-Accept header
+ * @param {number} port Port the server listens on. Defaults to 8080
+ * @returns {Promise} Promise that resolves to the created server once listening
+ */
+function nonCompliantWS(port = 8080) {
+ const srv = net.createServer((socket) => {
+ socket.once("data", (buf) => {
+ socket.write("HTTP/1.1 101 Switching Protocols\r\n" +
+ "Upgrade: websocket\r\n" +
+ "Connection: Upgrade\r\n\r\n");
+ socket.destroy();
+ });
+ });
+ return new Promise((resolve) => srv.listen(port, () => resolve(srv)));
+}
describe("Websocket Test", {
}, () => {
- test("Non Websocket Server", {}, async () => {
+ test("Non WS Server", {}, async () => {
const websocketMonitor = new WebSocketMonitorType();
const monitor = {
url: "wss://example.org",
wsIgnoreSecWebsocketAcceptHeader: false,
+ timeout: 30,
};
const heartbeat = {
@@ -25,12 +44,14 @@ describe("Websocket Test", {
);
});
- test("Secure Websocket", async () => {
+ test("Secure WS", async () => {
const websocketMonitor = new WebSocketMonitorType();
const monitor = {
url: "wss://echo.websocket.org",
wsIgnoreSecWebsocketAcceptHeader: false,
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
};
const heartbeat = {
@@ -39,7 +60,7 @@ describe("Websocket Test", {
};
const expected = {
- msg: "101 - OK",
+ msg: "1000 - OK",
status: UP,
};
@@ -47,7 +68,7 @@ describe("Websocket Test", {
assert.deepStrictEqual(heartbeat, expected);
});
- test("Insecure Websocket", async (t) => {
+ test("Insecure WS", async (t) => {
t.after(() => wss.close());
const websocketMonitor = new WebSocketMonitorType();
const wss = new WebSocketServer({ port: 8080 });
@@ -55,6 +76,8 @@ describe("Websocket Test", {
const monitor = {
url: "ws://localhost:8080",
wsIgnoreSecWebsocketAcceptHeader: false,
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
};
const heartbeat = {
@@ -63,7 +86,7 @@ describe("Websocket Test", {
};
const expected = {
- msg: "101 - OK",
+ msg: "1000 - OK",
status: UP,
};
@@ -71,12 +94,58 @@ describe("Websocket Test", {
assert.deepStrictEqual(heartbeat, expected);
});
- test("Non compliant WS server without IgnoreSecWebsocket", async () => {
+ test("Non compliant WS Server wrong status code", async () => {
const websocketMonitor = new WebSocketMonitorType();
const monitor = {
- url: "wss://c.img-cdn.net/yE4s7KehTFyj/",
+ url: "wss://echo.websocket.org",
wsIgnoreSecWebsocketAcceptHeader: false,
+ accepted_statuscodes_json: JSON.stringify([ "1001" ]),
+ timeout: 30,
+ };
+
+ const heartbeat = {
+ msg: "",
+ status: PENDING,
+ };
+
+ await assert.rejects(
+ websocketMonitor.check(monitor, heartbeat, {}),
+ new Error("Unexpected status code: 1000")
+ );
+ });
+
+ test("Secure WS Server no status code", async () => {
+ const websocketMonitor = new WebSocketMonitorType();
+
+ const monitor = {
+ url: "wss://echo.websocket.org",
+ wsIgnoreSecWebsocketAcceptHeader: false,
+ accepted_statuscodes_json: JSON.stringify([ "" ]),
+ timeout: 30,
+ };
+
+ const heartbeat = {
+ msg: "",
+ status: PENDING,
+ };
+
+ await assert.rejects(
+ websocketMonitor.check(monitor, heartbeat, {}),
+ new Error("Unexpected status code: 1000")
+ );
+ });
+
+ test("Non compliant WS server without IgnoreSecWebsocket", async (t) => {
+ t.after(() => wss.close());
+ const websocketMonitor = new WebSocketMonitorType();
+ const wss = await nonCompliantWS();
+
+ const monitor = {
+ url: "ws://localhost:8080",
+ wsIgnoreSecWebsocketAcceptHeader: false,
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
};
const heartbeat = {
@@ -90,12 +159,16 @@ describe("Websocket Test", {
);
});
- test("Non compliant WS server with IgnoreSecWebsocket", async () => {
+ test("Non compliant WS server with IgnoreSecWebsocket", async (t) => {
+ t.after(() => wss.close());
const websocketMonitor = new WebSocketMonitorType();
+ const wss = await nonCompliantWS();
const monitor = {
- url: "wss://c.img-cdn.net/yE4s7KehTFyj/",
+ url: "ws://localhost:8080",
wsIgnoreSecWebsocketAcceptHeader: true,
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
};
const heartbeat = {
@@ -104,7 +177,7 @@ describe("Websocket Test", {
};
const expected = {
- msg: "101 - OK",
+ msg: "1000 - OK",
status: UP,
};
@@ -118,6 +191,8 @@ describe("Websocket Test", {
const monitor = {
url: "wss://echo.websocket.org",
wsIgnoreSecWebsocketAcceptHeader: true,
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
};
const heartbeat = {
@@ -126,7 +201,7 @@ describe("Websocket Test", {
};
const expected = {
- msg: "101 - OK",
+ msg: "1000 - OK",
status: UP,
};
@@ -140,6 +215,8 @@ describe("Websocket Test", {
const monitor = {
url: "wss://example.org",
wsIgnoreSecWebsocketAcceptHeader: true,
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
};
const heartbeat = {
@@ -153,13 +230,15 @@ describe("Websocket Test", {
);
});
- test("Secure Websocket with Subprotocol", async () => {
+ test("Secure WS no subprotocol support", async () => {
const websocketMonitor = new WebSocketMonitorType();
const monitor = {
url: "wss://echo.websocket.org",
wsIgnoreSecWebsocketAcceptHeader: false,
wsSubprotocol: "ocpp1.6",
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
};
const heartbeat = {
@@ -172,4 +251,88 @@ describe("Websocket Test", {
new Error("Server sent no subprotocol")
);
});
+
+ test("Multiple subprotocols invalid input", async () => {
+ const websocketMonitor = new WebSocketMonitorType();
+
+ const monitor = {
+ url: "wss://echo.websocket.org",
+ wsIgnoreSecWebsocketAcceptHeader: false,
+ wsSubprotocol: " # & ,ocpp2.0 [] , ocpp1.6 , ,, ; ",
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
+ };
+
+ const heartbeat = {
+ msg: "",
+ status: PENDING,
+ };
+
+ await assert.rejects(
+ websocketMonitor.check(monitor, heartbeat, {}),
+ new SyntaxError("An invalid or duplicated subprotocol was specified")
+ );
+ });
+
+ test("Insecure WS subprotocol multiple spaces", async (t) => {
+ t.after(() => wss.close());
+ const websocketMonitor = new WebSocketMonitorType();
+ const wss = new WebSocketServer({ port: 8080,
+ handleProtocols: (protocols) => {
+ return Array.from(protocols).includes("test") ? "test" : null;
+ }
+ });
+
+ const monitor = {
+ url: "ws://localhost:8080",
+ wsIgnoreSecWebsocketAcceptHeader: false,
+ wsSubprotocol: "invalid , test ",
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
+ };
+
+ const heartbeat = {
+ msg: "",
+ status: PENDING,
+ };
+
+ const expected = {
+ msg: "1000 - OK",
+ status: UP,
+ };
+
+ await websocketMonitor.check(monitor, heartbeat, {});
+ assert.deepStrictEqual(heartbeat, expected);
+ });
+
+ test("Insecure WS supports one subprotocol", async (t) => {
+ t.after(() => wss.close());
+ const websocketMonitor = new WebSocketMonitorType();
+ const wss = new WebSocketServer({ port: 8080,
+ handleProtocols: (protocols) => {
+ return Array.from(protocols).includes("test") ? "test" : null;
+ }
+ });
+
+ const monitor = {
+ url: "ws://localhost:8080",
+ wsIgnoreSecWebsocketAcceptHeader: false,
+ wsSubprotocol: "invalid,test",
+ accepted_statuscodes_json: JSON.stringify([ "1000" ]),
+ timeout: 30,
+ };
+
+ const heartbeat = {
+ msg: "",
+ status: PENDING,
+ };
+
+ const expected = {
+ msg: "1000 - OK",
+ status: UP,
+ };
+
+ await websocketMonitor.check(monitor, heartbeat, {});
+ assert.deepStrictEqual(heartbeat, expected);
+ });
});