Make populate_with_data() aware of data type

[kconfig-hardened-check.git] / kconfig_hardened_check / __init__.py

diff --git a/kconfig_hardened_check/__init__.py b/kconfig_hardened_check/__init__.py
index d69dded085a9d55763e693fe540c59be0f892a47..5092742fcc4e5392fd01d38b3dc87faee30d0d91 100644 (file)
--- a/kconfig_hardened_check/__init__.py
+++ b/kconfig_hardened_check/__init__.py
@@ -81,6 +81,7 @@ import re
 import json
 from .__about__ import __version__
 
+TYPES_OF_CHECKS = ('kconfig', 'version')
 
 class OptCheck:
     def __init__(self, reason, decision, name, expected):
@@ -122,12 +123,16 @@ class KconfigCheck(OptCheck):
         return 'kconfig'
 
 
-class VerCheck:
+class VersionCheck:
     def __init__(self, ver_expected):
         self.ver_expected = ver_expected
         self.ver = ()
         self.result = None
 
+    @property
+    def type(self):
+        return 'version'
+
     def check(self):
         if self.ver[0] > self.ver_expected[0]:
             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
@@ -150,7 +155,8 @@ class VerCheck:
 
 class PresenceCheck:
     def __init__(self, name, type):
-        if type == 'kconfig':
+        self.type = type
+        if self.type == 'kconfig':
             self.name = 'CONFIG_' + name
         else:
             self.name = name
@@ -320,7 +326,7 @@ def add_kconfig_checks(l, arch):
              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
-             VerCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
+             VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
     if arch in ('X86_64', 'ARM64', 'X86_32'):
@@ -350,12 +356,12 @@ def add_kconfig_checks(l, arch):
         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
-                     VerCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
+                     VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
-                 VerCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
+                 VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
     if arch == 'ARM':
         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
@@ -688,27 +694,37 @@ def print_checklist(mode, checklist, with_results):
             print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
 
 
-def populate_opt_with_data(opt, parsed_options, kernel_version):
+def populate_simple_opt_with_data(opt, data, data_type):
+    if hasattr(opt, 'opts'):
+        sys.exit('[!] ERROR: unexpected ComplexOptCheck {}: {}'.format(opt.name, vars(opt)))
+    if data_type not in TYPES_OF_CHECKS:
+        sys.exit('[!] ERROR: invalid data type "{}"'.format(data_type))
+    if data_type != opt.type:
+        return
+    if data_type == 'kconfig':
+        opt.state = data.get(opt.name, None)
+    elif data_type == 'version':
+        opt.ver = data
+
+
+def populate_opt_with_data(opt, data, data_type):
     if hasattr(opt, 'opts'):
-        # prepare ComplexOptCheck
         for o in opt.opts:
             if hasattr(o, 'opts'):
-                # Recursion for nested ComplexOptChecks
-                populate_opt_with_data(o, parsed_options, kernel_version)
-            if hasattr(o, 'state'):
-                o.state = parsed_options.get(o.name, None)
-            if hasattr(o, 'ver'):
-                o.ver = kernel_version
+                # Recursion for nested ComplexOptCheck objects
+                populate_opt_with_data(o, data, data_type)
+            else:
+                populate_simple_opt_with_data(o, data, data_type)
     else:
-        # prepare simple check, opt.state is mandatory
+        # The 'state' is mandatory for simple checks
         if not hasattr(opt, 'state'):
             sys.exit('[!] ERROR: bad simple check {}'.format(vars(opt)))
-        opt.state = parsed_options.get(opt.name, None)
+        populate_simple_opt_with_data(opt, data, data_type)
 
 
-def populate_with_data(checklist, parsed_options, kernel_version):
+def populate_with_data(checklist, data, data_type):
     for opt in checklist:
-        populate_opt_with_data(opt, parsed_options, kernel_version)
+        populate_opt_with_data(opt, data, data_type)
 
 
 def perform_checks(checklist):
@@ -791,7 +807,8 @@ def main():
         # populate the checklist with the parsed kconfig data
         parsed_kconfig_options = OrderedDict()
         parse_kconfig_file(parsed_kconfig_options, args.config)
-        populate_with_data(config_checklist, parsed_kconfig_options, kernel_version)
+        populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
+        populate_with_data(config_checklist, kernel_version, 'version')
 
         # now everything is ready for performing the checks
         perform_checks(config_checklist)