Make base port configurable

Author: brunorijsman

client/__main__.py

@@ -22,13 +22,13 @@ def parse_command_line_arguments():
     parser = argparse.ArgumentParser(description="DSKE Client")
     parser.add_argument("name", type=str, help="Client name")
     parser.add_argument(
-        "--port", type=int, default=configuration.DEFAULT_BASE_PORT, help="Port number"
+        "--port", type=int, default=configuration._DEFAULT_BASE_PORT, help="Port number"
     )
     parser.add_argument(
         "--hubs",
         nargs="+",
         type=str,
-        help=f"Base URLs for hubs (e.g., http://127.0.0.1:{configuration.DEFAULT_BASE_PORT})",
+        help=f"Base URLs for hubs (e.g., http://127.0.0.1:{configuration._DEFAULT_BASE_PORT})",
     )
     parser.add_argument(
         "--encryptors",

common/configuration.py

@@ -8,7 +8,7 @@
 import yaml
 from common.node import Node, NodeType
 
-DEFAULT_BASE_PORT = 8100
+_DEFAULT_BASE_PORT = 8100
 
 
 class Configuration:
@@ -17,8 +17,9 @@ class Configuration:
     """
 
     _nodes: list[Node]
+    _base_port: int
 
-    def __init__(self, nodes, base_port=DEFAULT_BASE_PORT):
+    def __init__(self, nodes, base_port):
         # Sort nodes by type and name, so that clients are always before hubs (the order matters
         # for startup and shutdown).
         self._nodes = sorted(nodes)
@@ -68,6 +69,7 @@ def parse_configuration_file(filename: str):
         },
     }
     schema = {
+        "base_port": {"type": "integer", "default": _DEFAULT_BASE_PORT},
         "hubs": {"type": "list", "schema": hub_schema, "default": []},
         "clients": {"type": "list", "schema": client_schema, "default": []},
     }
@@ -106,4 +108,5 @@ def parse_configuration_file(filename: str):
             encryptor_names = [pec["name"] for pec in parsed_encryptors_config]
         node = Node(NodeType.CLIENT, node_name, encryptor_names)
         nodes.append(node)
-    return Configuration(nodes)
+    base_port = parsed_config["base_port"]
+    return Configuration(nodes, base_port)

dske-config.yaml

@@ -1,21 +1,31 @@
-hubs:
-  - name: hank
+# Configuration file for DSKE topology.
+
+# base_port: 8000       # Base TCP port for the DSKE topology.
+                        # The first hub uses TCP port base_port.
+                        # The second hub uses TCP port base_port + 1, and so on. 
+                        # The first client uses TCP port base_port + N, etc. 
+                        # (where N is the number of hubs).
+                        # Optional; default value is 8100.
+
+hubs:                   # List of hubs (aka DSKE security hubs) in the DSKE topology.
+  - name: hank          # Name of the hub.
   - name: helen
   - name: hilary
   - name: holly
   - name: hugo
-clients:
-  - name: carol
-    encryptors:
-      - name: sam
+
+clients:                # List of client (aka DSKE clients) in the DSKE topology.`
+  - name: carol         # Name of the client node.
+    encryptors:         # List of encryptors (aka Secure Application Entity SAE) directly connected to this client (carol).
+      - name: sam       # Name of the encryptor.
   - name: celia
     encryptors:
       - name: serena
-  - name: cindy
+  - name: cindy         # A client with zero directly connected encryptors.
   - name: connie
     encryptors:
       - name: sofia
   - name: curtis
-    encryptors:
+    encryptors:         # A client with more than one (namely two) directly connected encryptors.
       - name: sunny
       - name: susan

hub/__main__.py

@@ -29,7 +29,7 @@ def parse_command_line_arguments():
         "-p",
         "--port",
         type=int,
-        default=configuration.DEFAULT_BASE_PORT,
+        default=configuration._DEFAULT_BASE_PORT,
         help="Port number",
     )
     args = parser.parse_args()