cluster_backend_zeromq: Set Cluster::Backend::ZeroMQ::ipv6=T when needed

ZeekControl/plugins/cluster_backend_zeromq.py

@@ -46,6 +46,12 @@ def init(self):
         # The manager address is used for listening of the XPUB/XSUB proxy.
         self.xpub_xsub_addr = ZeekControl.config.Config.manager().addr
 
+        # If the address looks like an IPv6 address, put brackets around it
+        # so that libzmq does not interpret it as a device and instead as
+        # an IPv6 address.
+        if ":" in self.xpub_xsub_addr:
+            self.xpub_xsub_addr = "[" + self.xpub_xsub_addr + "]"
+
         # Check if this is a multi-node cluster (multiple IP addresses) and
         # tell the user about it.
         addrs = {n.addr for n in self.nodes()}
@@ -66,6 +72,12 @@ def init(self):
                 "\n    cluster_backend_zeromq.disable_unencrypted_warning = 1\n"
             )
 
+        # If any of the addresses used by nodes looks like an IPv6 address,
+        # enable ZeroMQ IPv6 support via the configuration knob.
+        self.ipv6 = False
+        if any(":" in a for a in addrs):
+            self.ipv6 = True
+
         return True
 
     def zeekctl_config(self):
@@ -86,6 +98,8 @@ def zeekctl_config(self):
                 f'redef Cluster::Backend::ZeroMQ::connect_xpub_endpoint = "tcp://{self.xpub_xsub_addr}:{self.xsub_port}";',
                 f'redef Cluster::Backend::ZeroMQ::connect_xsub_endpoint = "tcp://{self.xpub_xsub_addr}:{self.xpub_port}";',
                 "",
+                f'redef Cluster::Backend::ZeroMQ::ipv6 = {"T" if self.ipv6 else "F"};',
+                "",
             ]
         )
 

testing/Baseline/command.install-cluster-backend-zeromq-ipv6/zeekctl-config-redefs

@@ -0,0 +1,11 @@
+### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
+@endif
+
+redef Cluster::Backend::ZeroMQ::listen_xpub_endpoint = "tcp://[::1]:27760";
+redef Cluster::Backend::ZeroMQ::listen_xsub_endpoint = "tcp://[::1]:27761";
+redef Cluster::Backend::ZeroMQ::connect_xpub_endpoint = "tcp://[::1]:27761";
+redef Cluster::Backend::ZeroMQ::connect_xsub_endpoint = "tcp://[::1]:27760";
+
+redef Cluster::Backend::ZeroMQ::ipv6 = T;
+
+# End code from cluster_backend_zeromq plugin

testing/Baseline/command.install-empty-file-extract-dir/standalone

@@ -29,6 +29,8 @@ redef Cluster::Backend::ZeroMQ::listen_xsub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xpub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xsub_endpoint = "tcp://127.0.0.1:27760";
 
+redef Cluster::Backend::ZeroMQ::ipv6 = F;
+
 # Standalone: Run the XPUB/XSUB thread in standalone mode
 redef Cluster::Backend::ZeroMQ::run_proxy_thread = T;
 

testing/Baseline/command.install-zeekctl-config/logger

@@ -32,4 +32,6 @@ redef Cluster::Backend::ZeroMQ::listen_xsub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xpub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xsub_endpoint = "tcp://127.0.0.1:27760";
 
+redef Cluster::Backend::ZeroMQ::ipv6 = F;
+
 # End code from cluster_backend_zeromq plugin

testing/Baseline/command.install-zeekctl-config/no-logger

@@ -32,4 +32,6 @@ redef Cluster::Backend::ZeroMQ::listen_xsub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xpub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xsub_endpoint = "tcp://127.0.0.1:27760";
 
+redef Cluster::Backend::ZeroMQ::ipv6 = F;
+
 # End code from cluster_backend_zeromq plugin

testing/Baseline/command.install-zeekctl-config/standalone

@@ -30,6 +30,8 @@ redef Cluster::Backend::ZeroMQ::listen_xsub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xpub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xsub_endpoint = "tcp://127.0.0.1:27760";
 
+redef Cluster::Backend::ZeroMQ::ipv6 = F;
+
 # Standalone: Run the XPUB/XSUB thread in standalone mode
 redef Cluster::Backend::ZeroMQ::run_proxy_thread = T;
 

testing/Baseline/plugin.zeekctl-config/out

@@ -12,6 +12,8 @@ redef Cluster::Backend::ZeroMQ::listen_xsub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xpub_endpoint = "tcp://127.0.0.1:27761";
 redef Cluster::Backend::ZeroMQ::connect_xsub_endpoint = "tcp://127.0.0.1:27760";
 
+redef Cluster::Backend::ZeroMQ::ipv6 = F;
+
 # Standalone: Run the XPUB/XSUB thread in standalone mode
 redef Cluster::Backend::ZeroMQ::run_proxy_thread = T;
 

testing/command/install-cluster-backend-zeromq-ipv6.test

@@ -0,0 +1,17 @@
+# @TEST-DOC: Test using IPv6 addresses enabled the Cluster::Backend::ZeroMQ::ipv6 option.
+#
+# @TEST-EXEC: bash %INPUT
+#
+# @TEST-EXEC: btest-diff zeekctl-config-redefs
+
+. zeekctl-test-setup
+
+config=$ZEEKCTL_INSTALL_PREFIX/spool/installed-scripts-do-not-touch/auto/zeekctl-config.zeek
+
+installfile etc/node.cfg__cluster
+# Replace localhost with ::1 and verify that the ZeroMQ endpoints have
+# brackets and that the ipv6 option is set to T.
+sed -i 's/localhost/::1/g' $ZEEKCTL_INSTALL_PREFIX/etc/node.cfg
+zeekctl install
+
+grep -C2 'redef.*Cluster::Backend' $config > zeekctl-config-redefs