An open source, self-hosted, real-time port monitoring and discovery tool.
fix: enforce secure truenas websocket api key transport (#94)
Mostafa Wahiedfefb696f84bd
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 0824215..69add87 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -2,6 +2,13 @@All notable changes to portracker will be documented in this file.+## [Unreleased]++### Fixed++- **TrueNAS API Key Transport Security**: Enforced secure WebSocket usage for TrueNAS API key authentication by restricting secure mode to `wss://` endpoints and skipping insecure `ws://` endpoints.+- **TrueNAS WebSocket Base Handling**: In secure mode, `TRUENAS_WS_BASE` now upgrades insecure `ws://` values to `wss://` and ignores insecure explicit URLs.+## [1.3.4] - 2026-02-05### Fixeddiff --git a/backend/lib/tn-ws.js b/backend/lib/tn-ws.jsindex 4166390..37c6d8b 100644--- a/backend/lib/tn-ws.js+++ b/backend/lib/tn-ws.js@@ -96,6 +96,15 @@ async function connectWs(options = {}) {isConnecting = true;const currentUrl = urls[i++];+ if (currentUrl.startsWith("ws://")) {+ if (appDebugEnabled) {+ debugWS(+ `Skipping insecure WebSocket URL for API-key authentication: ${currentUrl}`+ );+ }+ return next(resolve, reject);+ }+if (appDebugEnabled) {debugWS(`Attempting connection to ${currentUrl}`);}diff --git a/backend/lib/truenas-auto-discover.js b/backend/lib/truenas-auto-discover.jsindex e81df59..a57000d 100644--- a/backend/lib/truenas-auto-discover.js+++ b/backend/lib/truenas-auto-discover.js@@ -246,10 +246,28 @@ function generateWebSocketURLs(uiConfig = null, options = {}) {const explicitBase = process.env.TRUENAS_WS_BASE;if (explicitBase) {- const wsBase = explicitBase.replace(/^http/, "ws");- urls.push(`${wsBase}/websocket`);+ const normalizedBase = explicitBase.replace(/\/+$/, "");+ let wsBase = normalizedBase.replace(/^http/i, "ws");+ if (requireSecure && /^ws:\/\//i.test(wsBase)) {+ wsBase = wsBase.replace(/^ws:\/\//i, "wss://");+ if (appDebugEnabled) {+ debugDiscovery(+ `TRUENAS_WS_BASE uses insecure scheme; upgrading to secure WebSocket base: ${wsBase}`+ );+ }+ }++ const explicitWsUrl = `${wsBase}/websocket`;+ if (!requireSecure || /^wss:\/\//i.test(explicitWsUrl)) {+ urls.push(explicitWsUrl);+ } else if (appDebugEnabled) {+ debugDiscovery(+ `Ignoring insecure explicit WebSocket URL in secure mode: ${explicitWsUrl}`+ );+ }+if (appDebugEnabled) {- debugDiscovery(`Added explicit WebSocket URL: ${wsBase}/websocket`);+ debugDiscovery(`Added explicit WebSocket URL: ${explicitWsUrl}`);}if (urls.length > 0) {return urls;@@ -276,15 +294,6 @@ function generateWebSocketURLs(uiConfig = null, options = {}) {}}}- for (const host of hostAddresses) {- if (uiConfig.httpPort) {- const url = `ws://${host}:${uiConfig.httpPort}/websocket`;- urls.push(url);- if (appDebugEnabled) {- debugDiscovery(`Added discovered HTTP WebSocket (fallback): ${url}`);- }- }- }} else {for (const host of hostAddresses) {if (uiConfig.httpsEnabled && uiConfig.httpsPort) {@@ -306,16 +315,23 @@ function generateWebSocketURLs(uiConfig = null, options = {}) {}}- if (!uiConfig) {+ const shouldUseFallbackPorts =+ !uiConfig || (requireSecure && urls.length === 0);++ if (shouldUseFallbackPorts) {if (appDebugEnabled) {- debugDiscovery("No UI config discovered, using generic fallback ports");+ if (!uiConfig) {+ debugDiscovery("No UI config discovered, using generic fallback ports");+ } else {+ debugDiscovery(+ "No secure WebSocket URL discovered from UI config, using secure fallback ports"+ );+ }}const commonPorts = requireSecure ? [{ port: 443, protocol: "wss" },{ port: 8443, protocol: "wss" },- { port: 80, protocol: "ws" },- { port: 8080, protocol: "ws" },] : [{ port: 443, protocol: "wss" },{ port: 80, protocol: "ws" },