Improve JSON output format for enhanced processing

[kconfig-hardened-check.git] / kernel_hardening_checker / engine.py

diff --git a/kernel_hardening_checker/engine.py b/kernel_hardening_checker/engine.py
index 52ae76153ae15ef55f11b48c73782a44e0342e01..b78b1013a2e84b2a2de0b12196b9093cfdc290bc 100644 (file)
--- a/kernel_hardening_checker/engine.py
+++ b/kernel_hardening_checker/engine.py
@@ -61,6 +61,11 @@ class OptCheck:
     def type(self):
         return None
 
+    def set_state(self, data):
+        assert(data is None or isinstance(data, str)), \
+               f'invalid state "{data}" for "{self.name}" check'
+        self.state = data
+
     def check(self):
         # handle the 'is present' check
         if self.expected == 'is present':
@@ -99,9 +104,16 @@ class OptCheck:
             print(f'| {colorize_result(self.result)}', end='')
 
     def json_dump(self, with_results):
-        dump = [self.name, self.type, self.expected, self.decision, self.reason]
+        dump = {
+            "option_name": self.name,
+            "type": self.type,
+            "desired_val": self.expected,
+            "decision": self.decision,
+            "reason": self.reason,
+        }
         if with_results:
-            dump.append(self.result)
+            dump["check_result_text"] = self.result
+            dump["check_result"] = "FAIL" not in self.result
         return dump
 
 
@@ -129,8 +141,10 @@ class SysctlCheck(OptCheck):
 
 class VersionCheck:
     def __init__(self, ver_expected):
-        assert(ver_expected and isinstance(ver_expected, tuple) and len(ver_expected) == 2), \
-               f'invalid version "{ver_expected}" for VersionCheck'
+        assert(ver_expected and isinstance(ver_expected, tuple) and len(ver_expected) == 3), \
+               f'invalid expected version "{ver_expected}" for VersionCheck (1)'
+        assert(all(map(lambda x: isinstance(x, int), ver_expected))), \
+               f'invalid expected version "{ver_expected}" for VersionCheck (2)'
         self.ver_expected = ver_expected
         self.ver = ()
         self.result = None
@@ -139,20 +153,33 @@ class VersionCheck:
     def type(self):
         return 'version'
 
+    def set_state(self, data):
+        assert(data and isinstance(data, tuple) and len(data) >= 3), \
+               f'invalid version "{data}" for VersionCheck'
+        self.ver = data[:3]
+
     def check(self):
         if self.ver[0] > self.ver_expected[0]:
-            self.result = f'OK: version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
+            self.result = f'OK: version >= {self.ver_expected}'
             return
         if self.ver[0] < self.ver_expected[0]:
-            self.result = f'FAIL: version < {self.ver_expected[0]}.{self.ver_expected[1]}'
+            self.result = f'FAIL: version < {self.ver_expected}'
+            return
+        # self.ver[0] and self.ver_expected[0] are equal
+        if self.ver[1] > self.ver_expected[1]:
+            self.result = f'OK: version >= {self.ver_expected}'
+            return
+        if self.ver[1] < self.ver_expected[1]:
+            self.result = f'FAIL: version < {self.ver_expected}'
             return
-        if self.ver[1] >= self.ver_expected[1]:
-            self.result = f'OK: version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
+        # self.ver[1] and self.ver_expected[1] are equal too
+        if self.ver[2] >= self.ver_expected[2]:
+            self.result = f'OK: version >= {self.ver_expected}'
             return
-        self.result = f'FAIL: version < {self.ver_expected[0]}.{self.ver_expected[1]}'
+        self.result = f'FAIL: version < {self.ver_expected}'
 
     def table_print(self, _mode, with_results):
-        ver_req = f'kernel version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
+        ver_req = f'kernel version >= {self.ver_expected}'
         print(f'{ver_req:<91}', end='')
         if with_results:
             print(f'| {colorize_result(self.result)}', end='')
@@ -199,7 +226,9 @@ class ComplexOptCheck:
     def json_dump(self, with_results):
         dump = self.opts[0].json_dump(False)
         if with_results:
-            dump.append(self.result)
+            # Add 'result_text' and 'result' keys to the dictionary
+            dump["check_result_text"] = self.result
+            dump["check_result"] = "FAIL" not in self.result
         return dump
 
 
@@ -280,11 +309,11 @@ def populate_simple_opt_with_data(opt, data, data_type):
         return
 
     if data_type in ('kconfig', 'cmdline', 'sysctl'):
-        opt.state = data.get(opt.name, None)
+        opt.set_state(data.get(opt.name, None))
     else:
         assert(data_type == 'version'), \
                f'unexpected data type "{data_type}"'
-        opt.ver = data
+        opt.set_state(data)
 
 
 def populate_opt_with_data(opt, data, data_type):