Merge remote-tracking branch 'origin/topic/awelzel/4474-cluster-websocket-ipv6'

* origin/topic/awelzel/4474-cluster-websocket-ipv6:
  IXWebsocket: Bump to version with memset() sock addr fix
  cluster/websocket: Deprecate $listen_host, introduce $listen_addr
  cluster/websocket-ixwebsocket: Determine proper address_family

CHANGES

@@ -1,3 +1,11 @@
+8.0.0-dev.267 | 2025-05-30 11:43:57 +0200
+
+  * IXWebsocket: Bump to version with memset() sock addr fix (Arne Welzel, Corelight)
+
+  * cluster/websocket: Deprecate $listen_host, introduce $listen_addr (Arne Welzel, Corelight)
+
+  * GH-4474: cluster/websocket-ixwebsocket: Determine proper address_family (Arne Welzel, Corelight)
+
 8.0.0-dev.262 | 2025-05-28 08:29:33 -0700
 
   * Remove obsolete --with-bind configure flag (Tim Wojtulewicz, Corelight)

NEWS

@@ -69,6 +69,10 @@ Changed Functionality
   found/picked-up by default. Use --with-krb5 for pointing at a custom librkb5
   installation.
 
+- The ``$listen_host`` configuration for ``Cluster::listen_websocket()``'s
+  ``WebSocketServerOptions`` was deprecated. Use the new ``$listen_addr`` field
+  instead.
+
 Removed Functionality
 ---------------------
 

VERSION

@@ -1 +1 @@
-8.0.0-dev.262
+8.0.0-dev.267

scripts/base/frameworks/cluster/main.zeek

@@ -363,7 +363,9 @@ export {
 	## WebSocket server options to pass to :zeek:see:`Cluster::listen_websocket`.
 	type WebSocketServerOptions: record {
 		## The host address to listen on.
-		listen_host: string;
+		listen_host: string &optional &deprecated="Remove in v8.1: Use $listen_addr instead.";
+		## The address to listen on, cannot be used together with ``listen_host``.
+		listen_addr: addr &optional;
 		## The port the WebSocket server is supposed to listen on.
 		listen_port: port;
 		## The maximum event queue size for this server.

src/cluster/cluster.bif

@@ -1,6 +1,7 @@
 %%{
 #include <string>
 
+#include "zeek/IPAddr.h"
 #include "zeek/cluster/Backend.h"
 #include "zeek/cluster/BifSupport.h"
 #include "zeek/cluster/Manager.h"
@@ -192,8 +193,32 @@ function Cluster::__listen_websocket%(options: WebSocketServerOptions%): bool
 		tls_options_rec->GetFieldOrDefault<zeek::StringVal>("ciphers")->ToStdString(),
 	};
 
-	struct ServerOptions server_options {
+	std::string listen_addr;
-		options_rec->GetField<zeek::StringVal>("listen_host")->ToStdString(),
+
+	// Backwards compat for listen_host if listen_addr isn't set.
+	if ( options_rec->HasField("listen_host") ) {
+		if ( options_rec->HasField("listen_addr") ) {
+			zeek::emit_builtin_error("cannot use both listen_addr and listen_host");
+			return zeek::val_mgr->False();
+		}
+
+		auto host = options_rec->GetField<zeek::StringVal>("listen_host")->ToStdString();
+		if ( ! zeek::IPAddr::IsValid(host.c_str()) ) {
+			zeek::emit_builtin_error("invalid listen_host");
+			return zeek::val_mgr->False();
+		}
+
+		listen_addr = std::move(host);
+
+	} else if ( options_rec->HasField("listen_addr") ) {
+		listen_addr = options_rec->GetField<zeek::AddrVal>("listen_addr")->AsAddr().AsString();
+	} else {
+		zeek::emit_builtin_error("missing listen_host field");
+		return zeek::val_mgr->False();
+	}
+
+	struct ServerOptions server_options{
+		listen_addr,
 		static_cast<uint16_t>(options_rec->GetField<zeek::PortVal>("listen_port")->Port()),
 	};
 

src/cluster/websocket/WebSocket-IXWebSocket.cc

@@ -3,10 +3,13 @@
 // Implementation of a WebSocket server and clients using the IXWebSocket client library.
 #include "zeek/cluster/websocket/WebSocket.h"
 
+#include <sys/socket.h>
 #include <memory>
 #include <stdexcept>
 
+#include "zeek/IPAddr.h"
 #include "zeek/Reporter.h"
+#include "zeek/net_util.h"
 
 #include "ixwebsocket/IXConnectionState.h"
 #include "ixwebsocket/IXSocketTLSOptions.h"
@@ -73,11 +76,18 @@ private:
 
 std::unique_ptr<WebSocketServer> StartServer(std::unique_ptr<WebSocketEventDispatcher> dispatcher,
                                              const ServerOptions& options) {
-    auto server =
+    if ( ! zeek::IPAddr::IsValid(options.host.c_str()) ) {
-        std::make_unique<ix::WebSocketServer>(options.port, options.host, ix::SocketServer::kDefaultTcpBacklog,
+        zeek::reporter->Error("WebSocket: Host is not a valid IP %s", options.host.c_str());
-                                              options.max_connections,
+        return nullptr;
-                                              ix::WebSocketServer::kDefaultHandShakeTimeoutSecs,
+    }
-                                              ix::SocketServer::kDefaultAddressFamily, options.ping_interval_seconds);
+
+    zeek::IPAddr host_addr(options.host);
+    int address_family = host_addr.GetFamily() == IPv4 ? AF_INET : AF_INET6;
+
+    auto server = std::make_unique<ix::WebSocketServer>(options.port, options.host,
+                                                        ix::SocketServer::kDefaultTcpBacklog, options.max_connections,
+                                                        ix::WebSocketServer::kDefaultHandShakeTimeoutSecs,
+                                                        address_family, options.ping_interval_seconds);
 
     if ( ! options.per_message_deflate )
         server->disablePerMessageDeflate();

src/cluster/websocket/auxil/IXWebSocket

@@ -1 +1 @@
-Subproject commit 2efe037c9cc96fd536774f17bdb5215161ee5087
+Subproject commit a9351e1f11561c1ae846b3005ea4b0f29b2a8ccc

testing/btest/Baseline.zam/cluster.websocket.listen-idempotent/.stderr

@@ -1,5 +1,5 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-error in <...>/main.zeek, line 673: Already listening on 127.0.0.1:<port> (Cluster::__listen_websocket(ws_opts_x))
+error in <...>/main.zeek, line 675: Already listening on 127.0.0.1:<port> (Cluster::__listen_websocket(ws_opts_x))
-error in <...>/main.zeek, line 673: Already listening on 127.0.0.1:<port> (Cluster::__listen_websocket(ws_opts_wss_port))
+error in <...>/main.zeek, line 675: Already listening on 127.0.0.1:<port> (Cluster::__listen_websocket(ws_opts_wss_port))
-error in <...>/main.zeek, line 673: Already listening on 127.0.0.1:<port> (Cluster::__listen_websocket(ws_opts_qs))
+error in <...>/main.zeek, line 675: Already listening on 127.0.0.1:<port> (Cluster::__listen_websocket(ws_opts_qs))
 received termination signal

testing/btest/Baseline.zam/cluster.websocket.one-ipv6-deprecated/..manager..stderr

@@ -0,0 +1,4 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+warning in ../manager.zeek, line 12: deprecated (Cluster::WebSocketServerOptions$listen_host): Remove in v8.1: Use $listen_addr instead. ((coerce [$listen_host=::1, $listen_port=to_port(getenv(WEBSOCKET_PORT))] to Cluster::WebSocketServerOptions))
+warning in <no location>: deprecated (Cluster::WebSocketServerOptions$listen_host): Remove in v8.1: Use $listen_addr instead. (Cluster::WebSocketServerOptions($listen_host=::1, $listen_port=to_port(getenv(WEBSOCKET_PORT))))
+received termination signal

testing/btest/Baseline.zam/cluster.websocket.tls-usage-error/.stderr

@@ -1,3 +1,3 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-error in <...>/main.zeek, line 673: Invalid tls_options: No key_file field (Cluster::__listen_websocket(Cluster::options.0))
+error in <...>/main.zeek, line 675: Invalid tls_options: No key_file field (Cluster::__listen_websocket(Cluster::options.0))
-error in <...>/main.zeek, line 673: Invalid tls_options: No cert_file field (Cluster::__listen_websocket(Cluster::options.3))
+error in <...>/main.zeek, line 675: Invalid tls_options: No cert_file field (Cluster::__listen_websocket(Cluster::options.3))

testing/btest/Baseline/cluster.websocket.one-ipv6-deprecated/..client..stderr

@@ -0,0 +1 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.

testing/btest/Baseline/cluster.websocket.one-ipv6-deprecated/..client.out

@@ -0,0 +1,12 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+Connected
+Sending ping 0
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 1}]
+Sending ping 1
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 2}]
+Sending ping 2
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 3}]
+Sending ping 3
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 4}]
+Sending ping 4
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 5}]

testing/btest/Baseline/cluster.websocket.one-ipv6-deprecated/..manager..stderr

@@ -0,0 +1,3 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+warning in ../manager.zeek, line 12: deprecated (Cluster::WebSocketServerOptions$listen_host): Remove in v8.1: Use $listen_addr instead. ((coerce [$listen_host=::1, $listen_port=to_port(getenv(WEBSOCKET_PORT))] to Cluster::WebSocketServerOptions))
+received termination signal

testing/btest/Baseline/cluster.websocket.one-ipv6-deprecated/..manager.out

@@ -0,0 +1,8 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+Cluster::websocket_client_added, [/test/pings, /zeek/wstest/ws1/]
+got ping: ping 0, 0
+got ping: ping 1, 1
+got ping: ping 2, 2
+got ping: ping 3, 3
+got ping: ping 4, 4
+Cluster::websocket_client_lost

testing/btest/Baseline/cluster.websocket.one-ipv6/..client..stderr

@@ -0,0 +1 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.

testing/btest/Baseline/cluster.websocket.one-ipv6/..client.out

@@ -0,0 +1,12 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+Connected
+Sending ping 0
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 1}]
+Sending ping 1
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 2}]
+Sending ping 2
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 3}]
+Sending ping 3
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 4}]
+Sending ping 4
+topic /test/pings event name pong args [{'@data-type': 'string', 'data': 'my-message'}, {'@data-type': 'count', 'data': 5}]

testing/btest/Baseline/cluster.websocket.one-ipv6/..manager..stderr

@@ -0,0 +1,2 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+received termination signal

testing/btest/Baseline/cluster.websocket.one-ipv6/..manager.out

@@ -0,0 +1,8 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+Cluster::websocket_client_added, [/test/pings, /zeek/wstest/ws1/]
+got ping: ping 0, 0
+got ping: ping 1, 1
+got ping: ping 2, 2
+got ping: ping 3, 3
+got ping: ping 4, 4
+Cluster::websocket_client_lost

testing/btest/Baseline/cluster.websocket.tls-usage-error/.stderr

@@ -1,3 +1,3 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
-error in <...>/tls-usage-error.zeek, line 17: Invalid tls_options: No key_file field (Cluster::listen_websocket((coerce [$listen_host=127.0.0.1, $listen_port=1234/tcp, $tls_options=tls_options_no_key] to Cluster::WebSocketServerOptions)))
+error in <...>/tls-usage-error.zeek, line 17: Invalid tls_options: No key_file field (Cluster::listen_websocket((coerce [$listen_addr=127.0.0.1, $listen_port=1234/tcp, $tls_options=tls_options_no_key] to Cluster::WebSocketServerOptions)))
-error in <...>/tls-usage-error.zeek, line 18: Invalid tls_options: No cert_file field (Cluster::listen_websocket((coerce [$listen_host=127.0.0.1, $listen_port=1234/tcp, $tls_options=tls_options_no_cert] to Cluster::WebSocketServerOptions)))
+error in <...>/tls-usage-error.zeek, line 18: Invalid tls_options: No cert_file field (Cluster::listen_websocket((coerce [$listen_addr=127.0.0.1, $listen_port=1234/tcp, $tls_options=tls_options_no_cert] to Cluster::WebSocketServerOptions)))

testing/btest/Files/ws/wstest.py

@@ -43,6 +43,7 @@ WS_PORT = (
 
 # IPv4 non-secure WebSocker URL for version 1
 WS4_URL_V1 = f"ws://127.0.0.1:{WS_PORT}/v1/messages/json"
+WS6_URL_V1 = f"ws://[::1]:{WS_PORT}/v1/messages/json"
 
 DEFAULT_RECV_TIMEOUT = 0.1
 OWN_TOPIC_PREFIX = "/zeek/wstest"

testing/btest/cluster/websocket/bad-event-args.zeek

@@ -35,7 +35,7 @@ global pong: event(msg: string, c: count) &is_used;
 event zeek_init()
 	{
 	Cluster::subscribe("/zeek/event/my_topic");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 event ping(msg: string, n: count) &is_used

testing/btest/cluster/websocket/bad-subscriptions.zeek

@@ -35,7 +35,7 @@ global pong: event(msg: string, c: count) &is_used;
 event zeek_init()
 	{
 	Cluster::subscribe("/zeek/event/my_topic");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 global added = 0;

testing/btest/cluster/websocket/bad-url.zeek

@@ -37,7 +37,7 @@ global pong: event(msg: string, c: count) &is_used;
 event zeek_init()
 	{
 	Cluster::subscribe("/zeek/event/my_topic");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 event ping(msg: string, n: count) &is_used

testing/btest/cluster/websocket/broker/manager-recvs.zeek

@@ -42,7 +42,7 @@ event zeek_init()
 	Cluster::subscribe("/test/pings/");
 
 	Cluster::listen_websocket([
-		$listen_host="127.0.0.1",
+		$listen_addr=127.0.0.1,
 		$listen_port=to_port(getenv("WEBSOCKET_PORT")),
 	]);
 	}

testing/btest/cluster/websocket/broker/manager-sends.zeek

@@ -40,7 +40,7 @@ global lost = 0;
 event zeek_init()
 	{
 	Cluster::listen_websocket([
-		$listen_host="127.0.0.1",
+		$listen_addr=127.0.0.1,
 		$listen_port=to_port(getenv("WEBSOCKET_PORT")),
 	]);
 	}

testing/btest/cluster/websocket/broker/manager-worker-ping-pong.zeek

@@ -76,7 +76,7 @@ event Cluster::node_up(name: string, id: string)
 	# Delay listening on WebSocket clients until worker-1 is around.
 	if ( name == "worker-1" )
 		Cluster::listen_websocket([
-			$listen_host="127.0.0.1",
+			$listen_addr=127.0.0.1,
 			$listen_port=to_port(getenv("WEBSOCKET_PORT"))
 		]);
 	}

testing/btest/cluster/websocket/broker/no-subscriptions.zeek

@@ -32,7 +32,7 @@ redef Broker::disable_ssl = T;
 event zeek_init()
 	{
 	Cluster::subscribe("/test/pings");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 global ping_count = 0;

testing/btest/cluster/websocket/broker/oneshot.zeek

@@ -36,7 +36,7 @@ global ping: event(msg: string, c: count) &is_used;
 event zeek_init()
 	{
 	Cluster::subscribe("/test/pings");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 event ping(msg: string, n: count) &is_used

testing/btest/cluster/websocket/cluster-log.zeek

@@ -43,7 +43,7 @@ global pong: event(msg: string, c: count) &is_used;
 event zeek_init()
 	{
 	Cluster::subscribe("/test/manager");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 event ping(msg: string, n: count) &is_used

testing/btest/cluster/websocket/listen-idempotent.zeek

@@ -20,20 +20,20 @@ event zeek_init()
 	local ws_port = to_port(getenv("WEBSOCKET_PORT"));
 	local wss_port = to_port(getenv("WEBSOCKET_SECURE_PORT"));
 
-	local ws_opts = Cluster::WebSocketServerOptions($listen_host="127.0.0.1", $listen_port=ws_port);
+	local ws_opts = Cluster::WebSocketServerOptions($listen_addr=127.0.0.1, $listen_port=ws_port);
 	local ws_opts_x = copy(ws_opts);
 	ws_opts_x$tls_options = tls_options;
 
-	local ws_opts_wss_port = Cluster::WebSocketServerOptions($listen_host="127.0.0.1", $listen_port=wss_port);
+	local ws_opts_wss_port = Cluster::WebSocketServerOptions($listen_addr=127.0.0.1, $listen_port=wss_port);
 
 	local ws_tls_opts = Cluster::WebSocketServerOptions(
-		$listen_host="127.0.0.1",
+		$listen_addr=127.0.0.1,
 		$listen_port=wss_port,
 		$tls_options=tls_options,
 	);
 	# Same as ws_tls_opts
 	local ws_tls_opts_copy = Cluster::WebSocketServerOptions(
-		$listen_host="127.0.0.1",
+		$listen_addr=127.0.0.1,
 		$listen_port=wss_port,
 		$tls_options=tls_options_2,
 	);

testing/btest/cluster/websocket/one-ipv6-deprecated.zeek

@@ -0,0 +1,85 @@
+# @TEST-DOC: Use listen_host to listen on an IPv6 address, otherwise same as one-ipv6.zeek
+#
+# @TEST-REQUIRES: have-zeromq
+# @TEST-REQUIRES: python3 -c 'import websockets.sync'
+# @TEST-REQUIRES: can-listen-tcp 6 ::1
+#
+# @TEST-GROUP: cluster-zeromq
+#
+# @TEST-PORT: XPUB_PORT
+# @TEST-PORT: XSUB_PORT
+# @TEST-PORT: LOG_PULL_PORT
+# @TEST-PORT: WEBSOCKET_PORT
+#
+# @TEST-EXEC: cp $FILES/zeromq/cluster-layout-simple.zeek cluster-layout.zeek
+# @TEST-EXEC: cp $FILES/zeromq/test-bootstrap.zeek zeromq-test-bootstrap.zeek
+# @TEST-EXEC: cp $FILES/ws/wstest.py .
+#
+# @TEST-EXEC: zeek -b --parse-only manager.zeek
+# @TEST-EXEC: python3 -m py_compile client.py
+#
+# @TEST-EXEC: btest-bg-run manager "ZEEKPATH=$ZEEKPATH:.. && CLUSTER_NODE=manager zeek -b ../manager.zeek >out"
+# @TEST-EXEC: btest-bg-run client "python3 ../client.py >out"
+#
+# @TEST-EXEC: btest-bg-wait 30
+# @TEST-EXEC: btest-diff ./manager/out
+# @TEST-EXEC: btest-diff ./manager/.stderr
+# @TEST-EXEC: btest-diff ./client/out
+# @TEST-EXEC: btest-diff ./client/.stderr
+
+# @TEST-START-FILE manager.zeek
+@load ./zeromq-test-bootstrap
+redef exit_only_after_terminate = T;
+
+global ping_count = 0;
+
+global ping: event(msg: string, c: count) &is_used;
+global pong: event(msg: string, c: count) &is_used;
+
+event zeek_init()
+	{
+	Cluster::subscribe("/test/pings/");
+	Cluster::listen_websocket([$listen_host="::1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	}
+
+event ping(msg: string, n: count) &is_used
+	{
+	++ping_count;
+	print fmt("got ping: %s, %s", msg, n);
+	local e = Cluster::make_event(pong, "my-message", ping_count);
+	Cluster::publish("/test/pings", e);
+	}
+
+event Cluster::websocket_client_added(info: Cluster::EndpointInfo, subscriptions: string_vec)
+	{
+	print "Cluster::websocket_client_added", subscriptions;
+	}
+
+event Cluster::websocket_client_lost(info: Cluster::EndpointInfo, code: count, reason: string)
+	{
+	print "Cluster::websocket_client_lost";
+	terminate();
+	}
+# @TEST-END-FILE
+
+
+# @TEST-START-FILE client.py
+# @TEST-START-FILE client.py
+import wstest
+
+def run(ws_url):
+    with wstest.connect("ws1", ws_url) as tc:
+        print("Connected")
+        tc.hello_v1(["/test/pings"])
+
+        for i in range(5):
+            print("Sending ping", i)
+            tc.send_json(wstest.build_event_v1("/test/pings/", "ping", [f"ping {i}", i]))
+            pong = tc.recv_json()
+            assert pong["@data-type"] == "vector"
+            ev = pong["data"][2]["data"]
+            print("topic", pong["topic"], "event name", ev[0]["data"], "args", ev[1]["data"])
+
+if __name__ == "__main__":
+    wstest.main(run, wstest.WS6_URL_V1)
+# @TEST-END-FILE

testing/btest/cluster/websocket/one-ipv6.zeek

@@ -0,0 +1,85 @@
+# @TEST-DOC: Make a WebSocket server listen on IPv6 ::1.
+#
+# @TEST-REQUIRES: have-zeromq
+# @TEST-REQUIRES: python3 -c 'import websockets.sync'
+# @TEST-REQUIRES: can-listen-tcp 6 ::1
+#
+# @TEST-GROUP: cluster-zeromq
+#
+# @TEST-PORT: XPUB_PORT
+# @TEST-PORT: XSUB_PORT
+# @TEST-PORT: LOG_PULL_PORT
+# @TEST-PORT: WEBSOCKET_PORT
+#
+# @TEST-EXEC: cp $FILES/zeromq/cluster-layout-simple.zeek cluster-layout.zeek
+# @TEST-EXEC: cp $FILES/zeromq/test-bootstrap.zeek zeromq-test-bootstrap.zeek
+# @TEST-EXEC: cp $FILES/ws/wstest.py .
+#
+# @TEST-EXEC: zeek -b --parse-only manager.zeek
+# @TEST-EXEC: python3 -m py_compile client.py
+#
+# @TEST-EXEC: btest-bg-run manager "ZEEKPATH=$ZEEKPATH:.. && CLUSTER_NODE=manager zeek -b ../manager.zeek >out"
+# @TEST-EXEC: btest-bg-run client "python3 ../client.py >out"
+#
+# @TEST-EXEC: btest-bg-wait 30
+# @TEST-EXEC: btest-diff ./manager/out
+# @TEST-EXEC: btest-diff ./manager/.stderr
+# @TEST-EXEC: btest-diff ./client/out
+# @TEST-EXEC: btest-diff ./client/.stderr
+
+# @TEST-START-FILE manager.zeek
+@load ./zeromq-test-bootstrap
+redef exit_only_after_terminate = T;
+
+global ping_count = 0;
+
+global ping: event(msg: string, c: count) &is_used;
+global pong: event(msg: string, c: count) &is_used;
+
+event zeek_init()
+	{
+	Cluster::subscribe("/test/pings/");
+	Cluster::listen_websocket([$listen_addr=[::1], $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	}
+
+event ping(msg: string, n: count) &is_used
+	{
+	++ping_count;
+	print fmt("got ping: %s, %s", msg, n);
+	local e = Cluster::make_event(pong, "my-message", ping_count);
+	Cluster::publish("/test/pings", e);
+	}
+
+event Cluster::websocket_client_added(info: Cluster::EndpointInfo, subscriptions: string_vec)
+	{
+	print "Cluster::websocket_client_added", subscriptions;
+	}
+
+event Cluster::websocket_client_lost(info: Cluster::EndpointInfo, code: count, reason: string)
+	{
+	print "Cluster::websocket_client_lost";
+	terminate();
+	}
+# @TEST-END-FILE
+
+
+# @TEST-START-FILE client.py
+# @TEST-START-FILE client.py
+import wstest
+
+def run(ws_url):
+    with wstest.connect("ws1", ws_url) as tc:
+        print("Connected")
+        tc.hello_v1(["/test/pings"])
+
+        for i in range(5):
+            print("Sending ping", i)
+            tc.send_json(wstest.build_event_v1("/test/pings/", "ping", [f"ping {i}", i]))
+            pong = tc.recv_json()
+            assert pong["@data-type"] == "vector"
+            ev = pong["data"][2]["data"]
+            print("topic", pong["topic"], "event name", ev[0]["data"], "args", ev[1]["data"])
+
+if __name__ == "__main__":
+    wstest.main(run, wstest.WS6_URL_V1)
+# @TEST-END-FILE

testing/btest/cluster/websocket/one-pipelining.zeek

@@ -37,7 +37,7 @@ global pong: event(msg: string, c: count) &is_used;
 event zeek_init()
 	{
 	Cluster::subscribe("/zeek/event/my_topic");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 event ping(msg: string, n: count) &is_used

testing/btest/cluster/websocket/one.zeek

@@ -37,7 +37,7 @@ global pong: event(msg: string, c: count) &is_used;
 event zeek_init()
 	{
 	Cluster::subscribe("/zeek/event/my_topic");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 event ping(msg: string, n: count) &is_used

testing/btest/cluster/websocket/ping-timeout.zeek

@@ -39,7 +39,7 @@ event Cluster::websocket_client_lost(info: Cluster::EndpointInfo, code: count, r
 
 event zeek_init()
 	{
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT")), $ping_interval=1sec]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT")), $ping_interval=1sec]);
 	Cluster::subscribe("/test/pings/");
 	}
 # @TEST-END-FILE

testing/btest/cluster/websocket/terminate-while-queuing.zeek

@@ -53,7 +53,7 @@ event Cluster::websocket_client_lost(info: Cluster::EndpointInfo, code: count, r
 
 event zeek_init()
 	{
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	Cluster::subscribe("/test/pings/");
 	}
 # @TEST-END-FILE

testing/btest/cluster/websocket/three.zeek

@@ -71,7 +71,7 @@ event Cluster::Backend::ZeroMQ::subscription(topic: string)
 
 event zeek_init()
 	{
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	Cluster::subscribe("/test/manager");
 	}
 # @TEST-END-FILE

testing/btest/cluster/websocket/tls-usage-error.zeek

@@ -14,6 +14,6 @@ event zeek_init()
 		$key_file="../localhost.key",
 	);
 
-	assert ! Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=1234/tcp, $tls_options=tls_options_no_key]);
+	assert ! Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=1234/tcp, $tls_options=tls_options_no_key]);
-	assert ! Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=1234/tcp, $tls_options=tls_options_no_cert]);
+	assert ! Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=1234/tcp, $tls_options=tls_options_no_cert]);
 	}

testing/btest/cluster/websocket/tls.zeek

@@ -46,7 +46,7 @@ event zeek_init()
 	);
 
 	local ws_server_options = Cluster::WebSocketServerOptions(
-		$listen_host="127.0.0.1",
+		$listen_addr=127.0.0.1,
 		$listen_port=to_port(getenv("WEBSOCKET_PORT")),
 		$tls_options=tls_options,
 	);

testing/btest/cluster/websocket/two-pipelining.zeek

@@ -103,7 +103,7 @@ event Cluster::Backend::ZeroMQ::subscription(topic: string)
 
 event zeek_init()
 	{
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	Cluster::subscribe("/test/manager");
 	}
 # @TEST-END-FILE

testing/btest/cluster/websocket/zeromq/manager-worker-ping-pong.zeek

@@ -79,7 +79,7 @@ event Cluster::node_up(name: string, id: string)
 	# Delay listening on WebSocket clients until worker-1 is around.
 	if ( name == "worker-1" )
 		Cluster::listen_websocket([
-			$listen_host="127.0.0.1",
+			$listen_addr=127.0.0.1,
 			$listen_port=to_port(getenv("WEBSOCKET_PORT"))
 		]);
 	}

testing/btest/cluster/websocket/zeromq/no-subscriptions.zeek

@@ -33,7 +33,7 @@ redef exit_only_after_terminate = T;
 event zeek_init()
 	{
 	Cluster::subscribe("/test/pings");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 global ping_count = 0;

testing/btest/cluster/websocket/zeromq/oneshot.zeek

@@ -38,7 +38,7 @@ global ping: event(msg: string, c: count) &is_used;
 event zeek_init()
 	{
 	Cluster::subscribe("/test/pings");
-	Cluster::listen_websocket([$listen_host="127.0.0.1", $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
+	Cluster::listen_websocket([$listen_addr=127.0.0.1, $listen_port=to_port(getenv("WEBSOCKET_PORT"))]);
 	}
 
 event ping(msg: string, n: count) &is_used

testing/scripts/can-listen-tcp

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+#
+# Try binding on the given family with addr and a port of 0 so that an
+# ephemeral port is allocated. This can be used to guard IPv6 tests.
+
+import socket
+import sys
+
+
+def usage():
+    print(f"Usage: {sys.argv[0]} 4|6 <addr>", file=sys.stderr)
+    sys.exit(1)
+
+
+if len(sys.argv) != 3:
+    usage()
+
+family = 0
+
+if sys.argv[1] == "4":
+    family = socket.AF_INET
+elif sys.argv[1] == "6":
+    family = socket.AF_INET6
+else:
+    usage()
+
+addr = sys.argv[2]
+port = 0
+
+s = socket.socket(family)
+
+try:
+    s.bind((addr, port))
+except Exception as e:
+    print(f"cannot listen on {addr}:{port} ({e!r})")
+    sys.exit(1)
+finally:
+    try:
+        s.close()
+    except:
+        pass