Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Supporting IPv6 addresses for the --controller option #42

Merged
merged 3 commits into from
Dec 13, 2024
Merged

Supporting IPv6 addresses for the --controller option #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b4428a
Supporting IPv6 addresses for the --controller option
dopheide-esnet Aug 9, 2024
1c63a9c
chore: linting/pre-commit
dopheide-esnet Aug 9, 2024
83c2438
Fixup pre-commit
dopheide-esnet Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions tests/test_config_overrides.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,30 @@ def test_update_from_args_controller_host(self):
self.assertEqual(self.config.get("controller", "host"), "foo")
self.assertEqual(self.config.getint("controller", "port"), 2149)

parser = zeekclient.cli.create_parser()
args = parser.parse_args(["--controller", "127.0.0.1"])
self.config.update_from_args(args)
self.assertEqual(self.config.get("controller", "host"), "127.0.0.1")
self.assertEqual(self.config.getint("controller", "port"), 2149)

parser = zeekclient.cli.create_parser()
args = parser.parse_args(["--controller", "127.0.0.1:"])
self.config.update_from_args(args)
self.assertEqual(self.config.get("controller", "host"), "127.0.0.1")
self.assertEqual(self.config.getint("controller", "port"), 2149)

parser = zeekclient.cli.create_parser()
args = parser.parse_args(["--controller", "[fe80::1]"])
self.config.update_from_args(args)
self.assertEqual(self.config.get("controller", "host"), "[fe80::1]")
self.assertEqual(self.config.getint("controller", "port"), 2149)

parser = zeekclient.cli.create_parser()
args = parser.parse_args(["--controller", "[fe80::1]:"])
self.config.update_from_args(args)
self.assertEqual(self.config.get("controller", "host"), "[fe80::1]")
self.assertEqual(self.config.getint("controller", "port"), 2149)

def test_update_from_args_controller_port(self):
parser = zeekclient.cli.create_parser()
args = parser.parse_args(["--controller", ":2222"])
Expand All @@ -76,3 +100,15 @@ def test_update_from_args_controller_hostport(self):
self.config.update_from_args(args)
self.assertEqual(self.config.get("controller", "host"), "foo")
self.assertEqual(self.config.getint("controller", "port"), 2222)

parser = zeekclient.cli.create_parser()
args = parser.parse_args(["--controller", "127.0.0.1:2222"])
self.config.update_from_args(args)
self.assertEqual(self.config.get("controller", "host"), "127.0.0.1")
self.assertEqual(self.config.getint("controller", "port"), 2222)

parser = zeekclient.cli.create_parser()
args = parser.parse_args(["--controller", "[fe80::1]:2222"])
self.config.update_from_args(args)
self.assertEqual(self.config.get("controller", "host"), "[fe80::1]")
self.assertEqual(self.config.getint("controller", "port"), 2222)
28 changes: 21 additions & 7 deletions zeekclient/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,16 +118,30 @@ def update_from_args(self, args):
# The `--controller` argument is a shortcut for two `--set` arguments that
# set controller host and port, so update these manually:
if args.controller:
host_port = args.controller.split(":", 1)
if len(host_port) != 2 or not host_port[1]:
if ":" not in args.controller:
host = args.controller
port = ""
else:
(host, _, port) = args.controller.rpartition(":")
if host.count(":") >= 1:
# We likely have an IPv6 address
if not host.startswith("["):
raise ValueError(
"IPv6 addresses must be surrounded by brackets: [<ipv6>]:<port>"
)
if port.endswith("]"):
host = host + ":" + port
port = ""

if port == "":
# It's just a hostname
self.set("controller", "host", host_port[0])
elif not host_port[0]:
self.set("controller", "host", host)
elif host == "":
# It's just a port (as ":<port>")
self.set("controller", "port", host_port[1])
self.set("controller", "port", port)
else:
self.set("controller", "host", host_port[0])
self.set("controller", "port", host_port[1])
self.set("controller", "host", host)
self.set("controller", "port", port)

# --verbose/-v/-vvv etc set a numeric verbosity level:
if args.verbose:
Expand Down
Loading