Add vsyscall check
[kconfig-hardened-check.git] / kconfig_hardened_check / __init__.py
index 45bd9d5c49110a61999e2a43fae4c33bf78d5c5f..30c9f3a97a0900c507a90b19bb65a324d4106315 100644 (file)
@@ -16,8 +16,6 @@
 #    iommu.passthrough=0
 #    iommu.strict=1
 #    slub_debug=FZ (slow)
-#    init_on_alloc=1 (since v5.3)
-#    init_on_free=1 (since v5.3, otherwise slub_debug=P and page_poison=1)
 #    loadpin.enforce=1
 #    debugfs=no-mount (or off if possible)
 #
@@ -36,7 +34,6 @@
 #           ssbd=force-on
 #
 #    Should NOT be set:
-#           slab_merge
 #           nokaslr
 #           rodata=off
 #           sysrq_always_enabled
@@ -189,29 +186,21 @@ class ComplexOptCheck:
                'empty {} check'.format(self.__class__.__name__)
         assert(len(self.opts) != 1), \
                 'useless {} check: {}'.format(self.__class__.__name__, opts)
-        assert(isinstance(opts[0], KconfigCheck) or isinstance(opts[0], CmdlineCheck)), \
+        assert(isinstance(opts[0], (KconfigCheck, CmdlineCheck))), \
                'invalid {} check: {}'.format(self.__class__.__name__, opts)
         self.result = None
 
-    @property
-    def name(self):
-        return self.opts[0].name
-
     @property
     def type(self):
         return 'complex'
 
     @property
-    def expected(self):
-        return self.opts[0].expected
-
-    @property
-    def decision(self):
-        return self.opts[0].decision
+    def name(self):
+        return self.opts[0].name
 
     @property
-    def reason(self):
-        return self.opts[0].reason
+    def expected(self):
+        return self.opts[0].expected
 
     def table_print(self, mode, with_results):
         if mode == 'verbose':
@@ -252,9 +241,10 @@ class OR(ComplexOptCheck):
                         self.result = 'OK: {} not found'.format(opt.name)
                     elif opt.result == 'OK: is present':
                         self.result = 'OK: {} is present'.format(opt.name)
-                    # VersionCheck provides enough info
-                    elif not opt.result.startswith('OK: version'):
-                        sys.exit('[!] ERROR: unexpected OK description "{}"'.format(opt.result))
+                    else:
+                        # VersionCheck provides enough info
+                        assert(opt.result.startswith('OK: version')), \
+                               'unexpected OK description "{}"'.format(opt.result)
                 return
         self.result = self.opts[0].result
 
@@ -282,8 +272,8 @@ class AND(ComplexOptCheck):
                 else:
                     # VersionCheck provides enough info
                     self.result = opt.result
-                    if not opt.result.startswith('FAIL: version'):
-                        sys.exit('[!] ERROR: unexpected FAIL description "{}"'.format(opt.result))
+                    assert(opt.result.startswith('FAIL: version')), \
+                           'unexpected FAIL description "{}"'.format(opt.result)
                 return
 
 
@@ -434,8 +424,7 @@ def add_kconfig_checks(l, arch):
     if arch in ('X86_64', 'ARM64', 'X86_32'):
         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
         l += [stackleak_is_set]
-        l += [OR(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
-                 CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'))]
+        l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
     if arch in ('X86_64', 'X86_32'):
         l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
@@ -463,8 +452,7 @@ def add_kconfig_checks(l, arch):
     l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
     l += [OR(KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y'),
              efi_not_set)]
-    l += [OR(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
-             CmdlineCheck('self_protection', 'kspp', 'slab_nomerge'))] # option presence check
+    l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')]
     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
     l += [AND(KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
@@ -656,9 +644,33 @@ def add_kconfig_checks(l, arch):
 def add_cmdline_checks(l, arch):
     # Calling the CmdlineCheck class constructor:
     #     CmdlineCheck(reason, decision, name, expected)
-
+    # Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
+    # when the tool doesn't check the cmdline.
+
+    l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
+             AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
+                 CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
+    l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_free', '1'),
+             AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
+                 CmdlineCheck('self_protection', 'kspp', 'init_on_free', 'is not set')),
+             AND(CmdlineCheck('self_protection', 'kspp', 'page_poison', '1'),
+                 KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'),
+                 CmdlineCheck('self_protection', 'kspp', 'slub_debug', 'P')))]
+    l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_nomerge'),
+             AND(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
+                 CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set')))] # option presence check
+    if arch in ('X86_64', 'ARM64', 'X86_32'):
+        l += [OR(CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'),
+                 AND(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
+                     CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', 'is not set')))]
     if arch in ('X86_64', 'X86_32'):
         l += [CmdlineCheck('self_protection', 'kspp', 'pti', 'on')]
+
+    if arch == 'X86_64':
+        l += [OR(CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'none'),
+                 AND(KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'),
+                     CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'is not set')))]
+
     # TODO: add other
 
 
@@ -675,8 +687,8 @@ def print_unknown_options(checklist, parsed_options):
                     known_options.append(o2.name)
                 continue
             for o3 in o2.opts:
-                if o3.type == 'complex':
-                    sys.exit('[!] ERROR: unexpected ComplexOptCheck inside {}'.format(o2.name))
+                assert(o3.type != 'complex'), \
+                       'unexpected ComplexOptCheck inside {}'.format(o2.name)
                 if hasattr(o3, 'name'):
                     known_options.append(o3.name)
 
@@ -734,22 +746,22 @@ def print_checklist(mode, checklist, with_results):
 
 
 def populate_simple_opt_with_data(opt, data, data_type):
-    if opt.type == 'complex':
-        sys.exit('[!] ERROR: unexpected ComplexOptCheck {}: {}'.format(opt.name, vars(opt)))
-    if opt.type not in SIMPLE_OPTION_TYPES:
-        sys.exit('[!] ERROR: invalid opt type "{}" for {}'.format(opt.type, opt.name))
-    if data_type not in SIMPLE_OPTION_TYPES:
-        sys.exit('[!] ERROR: invalid data type "{}"'.format(data_type))
+    assert(opt.type != 'complex'), \
+           'unexpected ComplexOptCheck "{}"'.format(opt.name)
+    assert(opt.type in SIMPLE_OPTION_TYPES), \
+           'invalid opt type "{}"'.format(opt.type)
+    assert(data_type in SIMPLE_OPTION_TYPES), \
+           'invalid data type "{}"'.format(data_type)
 
     if data_type != opt.type:
         return
 
     if data_type in ('kconfig', 'cmdline'):
         opt.state = data.get(opt.name, None)
-    elif data_type == 'version':
-        opt.ver = data
     else:
-        sys.exit('[!] ERROR: unexpected data type "{}"'.format(data_type))
+        assert(data_type == 'version'), \
+               'unexpected data type "{}"'.format(data_type)
+        opt.ver = data
 
 
 def populate_opt_with_data(opt, data, data_type):
@@ -761,8 +773,8 @@ def populate_opt_with_data(opt, data, data_type):
             else:
                 populate_simple_opt_with_data(o, data, data_type)
     else:
-        if opt.type not in ('kconfig', 'cmdline'):
-            sys.exit('[!] ERROR: bad type "{}" for a simple check {}'.format(opt.type, opt.name))
+        assert(opt.type in ('kconfig', 'cmdline')), \
+               'bad type "{}" for a simple check'.format(opt.type)
         populate_simple_opt_with_data(opt, data, data_type)
 
 
@@ -788,6 +800,8 @@ def parse_kconfig_file(parsed_options, fname):
 
             if opt_is_on.match(line):
                 option, value = line.split('=', 1)
+                if value == 'is not set':
+                    sys.exit('[!] ERROR: bad enabled kconfig option "{}"'.format(line))
             elif opt_is_off.match(line):
                 option, value = line[2:].split(' ', 1)
                 if value != 'is not set':
@@ -871,6 +885,10 @@ def main():
         # add relevant kconfig checks to the checklist
         add_kconfig_checks(config_checklist, arch)
 
+        if args.cmdline:
+            # add relevant cmdline checks to the checklist
+            add_cmdline_checks(config_checklist, arch)
+
         # populate the checklist with the parsed kconfig data
         parsed_kconfig_options = OrderedDict()
         parse_kconfig_file(parsed_kconfig_options, args.config)
@@ -878,9 +896,6 @@ def main():
         populate_with_data(config_checklist, kernel_version, 'version')
 
         if args.cmdline:
-            # add relevant cmdline checks to the checklist
-            add_cmdline_checks(config_checklist, arch)
-
             # populate the checklist with the parsed kconfig data
             parsed_cmdline_options = OrderedDict()
             parse_cmdline_file(parsed_cmdline_options, args.cmdline)
@@ -911,6 +926,3 @@ def main():
 
     parser.print_help()
     sys.exit(0)
-
-if __name__ == '__main__':
-    main()