Add option in dot1x config to enable debug logs and make config file … (#851)

Author: anurag6

subset/dot1x/authenticator/authenticator.py

@@ -4,11 +4,11 @@
 from heartbeat_scheduler import HeartbeatScheduler
 from radius_module import RadiusModule, RadiusPacketInfo, RadiusSocketInfo, port_id_to_int
 from message_parser import IdentityMessage, FailureMessage
-from utils import get_logger, get_interface_name, get_interface_ip, get_interface_mac
 
 import json
 import threading
 import time
+import utils
 
 
 class AuthStateMachine:
@@ -24,7 +24,7 @@ def __init__(self, src_mac, auth_mac, idle_time, retry_count,
         self.state = None
         self._state_lock = threading.Lock()
         self._timer_lock = threading.RLock()
-        self.logger = get_logger('AuthSM')
+        self.logger = utils.get_logger('AuthSM')
         self.src_mac = src_mac
         self.eap_send_callback = eap_send_callback
         self.radius_send_callback = radius_send_callback
@@ -143,7 +143,7 @@ def __init__(self, config_file):
         self.results = {}
         self.eap_module = None
         self.radius_module = None
-        self.logger = get_logger('Authenticator')
+        self.logger = utils.get_logger('Authenticator')
         self._config_file = config_file
         self._threads = []
         self._radius_socket_info = None
@@ -153,6 +153,7 @@ def __init__(self, config_file):
         self._idle_time = None
         self._max_retry_count = None
         self._current_timeout = None
+        self._debug = False
 
         self._setup()
 
@@ -161,21 +162,25 @@ def _load_config(self):
             full_config = json.load(file_stream)
         config = full_config.get('modules').get('dot1x')
 
+        self._debug = config.get('debug')
+        if self._debug:
+            utils.enable_debug_logs(self.logger)
+
         self.logger.debug('Loaded config from %s:\n %s', self._config_file, config)
 
-        self._interface = config.get('interface', get_interface_name())
+        self._interface = config.get('interface', utils.get_interface_name())
 
         radius_config = config.get('radius_server', {})
         radius_socket_info = radius_config.get('radius_socket_info', {})
 
-        listen_ip = radius_socket_info.get('listen_ip', get_interface_ip(self._interface))
+        listen_ip = radius_socket_info.get('listen_ip', utils.get_interface_ip(self._interface))
         listen_port = radius_socket_info.get('listen_port', 0)
         remote_ip = radius_socket_info.get('remote_ip', '127.0.0.1')
         remote_port = radius_socket_info.get('remote_port', self.RADIUS_PORT)
 
         self._radius_socket_info = RadiusSocketInfo(listen_ip, listen_port, remote_ip, remote_port)
         self._radius_secret = radius_config.get('secret', 'SECRET')
-        self._radius_id = radius_config.get('id', get_interface_mac(self._interface))
+        self._radius_id = radius_config.get('id', utils.get_interface_mac(self._interface))
 
     def _setup(self):
         self._load_config()
@@ -184,6 +189,10 @@ def _setup(self):
             self._radius_id, self.received_radius_response)
         self.eap_module = EapModule(self._interface, self.received_eap_request)
 
+        if self._debug:
+            utils.enable_debug_logs(self.radius_module.logger)
+            utils.enable_debug_logs(self.eap_module.logger)
+
         # TODO: Take value from config and then revert to default
         interval = self.HEARTBEAT_INTERVAL
 

subset/dot1x/authenticator/test_dot1x.py

@@ -9,11 +9,20 @@ def main():
     TEST_NAME = "dot1x.dot1x"
 
     LOGGER = get_logger('test_dot1x')
-    write_file = sys.argv[1]
+    arg_length = len(sys.argv)
+    if arg_length > 1:
+        write_file = sys.argv[1]
+    else:
+        write_file = '/tmp/dot1x_result.txt'
+    if arg_length > 2:
+        config_file = sys.argv[2]
+    else:
+        config_file = '/config/device/module_config.json'
+
     # TODO: Link with authentucation module once ready.
     # Currently simply writes an empty result into the file.
     LOGGER.info('Initialising authenticator')
-    authenticator = Authenticator('/config/device/module_config.json')
+    authenticator = Authenticator(config_file)
     LOGGER.info('Running auth test')
     result_summary, test_result = authenticator.run_authentication_test()
     result_line = "RESULT %s %s %s" % (test_result, TEST_NAME, result_summary)

subset/dot1x/authenticator/utils.py

@@ -27,6 +27,13 @@ def get_logger(logname):
     return logger
 
 
+def enable_debug_logs(logger):
+    """Enable debug logs for logger"""
+    logger.setLevel(logging.DEBUG)
+    for handler in logger.handlers:
+        handler.setLevel(logging.DEBUG)
+
+
 def get_interface_name():
     """Get main interface name from test container"""
     return '%s-eth0' % socket.gethostname()

subset/dot1x/base_config.json

@@ -0,0 +1,9 @@
+{
+  "modules": {
+    "dot1x": {
+      "enabled": true,
+      "interface": "eth0",
+      "debug": true
+    }
+  }
+}

subset/dot1x/docker-compose.yaml

@@ -22,6 +22,7 @@ services:
             context: ../..
             dockerfile: ./subset/dot1x/Dockerfile.test_dot1x
         image: 'authenticator/authenticator:latest'
+        command: './test_dot1x /config/device/test_config.json'
         networks:
             00wpasupplicant-net:
                 ipv4_address: 10.20.0.3
@@ -30,6 +31,7 @@ services:
             - ALL
         volumes:
             - ../../resources/setups/common/base_config.json:/config/device/module_config.json
+            - ./../../subset/dot1x/base_config.json:/config/device/test_config.json
 
     tcpdump:
         image: kaazing/tcpdump

subset/dot1x/test_dot1x

@@ -1,5 +1,7 @@
 #!/bin/bash -e
 
+dot1x_config=$1
+
 freeradius -xx -l /tmp/radius_log
 
 source reporting.sh
@@ -8,10 +10,12 @@ REPORT=/tmp/report.txt
 TEST_NAME="dot1x.dot1x"
 TEST_DESCRIPTION="Dot1x authentication tests"
 
-route add default gw $GATEWAY_IP
+if [ -n "$GATEWAY_IP" ] ; then
+    route add default gw $GATEWAY_IP
+fi
 echo 'Dot1x Authentication tests'
 
-python3 authenticator/test_dot1x.py /tmp/dot1x_result.txt
+python3 authenticator/test_dot1x.py /tmp/dot1x_result.txt $1
 
 RESULT_AND_SUMMARY=$(cat /tmp/dot1x_result.txt)