kconfig_hardened_check/__init__.py

   1 #!/usr/bin/python3
   2
   3 #
   4 # This tool helps me to check Linux kernel options against
   5 # my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
   6 # Let the computers do their job!
   7 #
   8 # Author: Alexander Popov <alex.popov@linux.com>
   9 #
  10 # Please don't cry if my Python code looks like C.
  11 #
  12 #
  13 # N.B Hardening command line parameters:
  14 #    iommu=force (does it help against DMA attacks?)
  15 #
  16 #    Mitigations of CPU vulnerabilities:
  17 #       Аrch-independent:
  18 #       X86:
  19 #           l1d_flush=on (a part of the l1tf option)
  20 #       ARM64:
  21 #           kpti=on
  22 #
  23 #    Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
  24 #           kasan=on
  25 #           kasan.stacktrace=off
  26 #           kasan.fault=panic
  27 #
  28 # N.B. Hardening sysctls:
  29 #    kernel.kptr_restrict=2 (or 1?)
  30 #    kernel.dmesg_restrict=1 (also see the kconfig option)
  31 #    kernel.perf_event_paranoid=3
  32 #    kernel.kexec_load_disabled=1
  33 #    kernel.yama.ptrace_scope=3
  34 #    user.max_user_namespaces=0
  35 #    what about bpf_jit_enable?
  36 #    kernel.unprivileged_bpf_disabled=1
  37 #    net.core.bpf_jit_harden=2
  38 #    vm.unprivileged_userfaultfd=0
  39 #        (at first, it disabled unprivileged userfaultfd,
  40 #         and since v5.11 it enables unprivileged userfaultfd for user-mode only)
  41 #    vm.mmap_min_addr has a good value
  42 #    dev.tty.ldisc_autoload=0
  43 #    fs.protected_symlinks=1
  44 #    fs.protected_hardlinks=1
  45 #    fs.protected_fifos=2
  46 #    fs.protected_regular=2
  47 #    fs.suid_dumpable=0
  48 #    kernel.modules_disabled=1
  49 #    kernel.randomize_va_space = 2
  50
  51
  52 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
  53 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
  54
  55
  56 import sys
  57 from argparse import ArgumentParser
  58 from collections import OrderedDict
  59 import re
  60 import json
  61 from .__about__ import __version__
  62
  63 SIMPLE_OPTION_TYPES = ('kconfig', 'version', 'cmdline')
  64
  65 class OptCheck:
  66     def __init__(self, reason, decision, name, expected):
  67         assert(name and name == name.strip() and len(name.split()) == 1), \
  68                'invalid name "{}" for {}'.format(name, self.__class__.__name__)
  69         self.name = name
  70
  71         assert(decision and decision == decision.strip() and len(decision.split()) == 1), \
  72                'invalid decision "{}" for "{}" check'.format(decision, name)
  73         self.decision = decision
  74
  75         assert(reason and reason == reason.strip() and len(reason.split()) == 1), \
  76                'invalid reason "{}" for "{}" check'.format(reason, name)
  77         self.reason = reason
  78
  79         assert(expected and expected == expected.strip()), \
  80                'invalid expected value "{}" for "{}" check (1)'.format(expected, name)
  81         val_len = len(expected.split())
  82         if val_len == 3:
  83             assert(expected == 'is not set' or expected == 'is not off'), \
  84                    'invalid expected value "{}" for "{}" check (2)'.format(expected, name)
  85         elif val_len == 2:
  86             assert(expected == 'is present'), \
  87                    'invalid expected value "{}" for "{}" check (3)'.format(expected, name)
  88         else:
  89             assert(val_len == 1), \
  90                    'invalid expected value "{}" for "{}" check (4)'.format(expected, name)
  91         self.expected = expected
  92
  93         self.state = None
  94         self.result = None
  95
  96     @property
  97     def type(self):
  98         return None
  99
 100     def check(self):
 101         # handle the 'is present' check
 102         if self.expected == 'is present':
 103             if self.state is None:
 104                 self.result = 'FAIL: is not present'
 105             else:
 106                 self.result = 'OK: is present'
 107             return
 108
 109         # handle the 'is not off' option check
 110         if self.expected == 'is not off':
 111             if self.state == 'off':
 112                 self.result = 'FAIL: is off'
 113             if self.state == '0':
 114                 self.result = 'FAIL: is off, "0"'
 115             elif self.state is None:
 116                 self.result = 'FAIL: is off, not found'
 117             else:
 118                 self.result = 'OK: is not off, "' + self.state + '"'
 119             return
 120
 121         # handle the option value check
 122         if self.expected == self.state:
 123             self.result = 'OK'
 124         elif self.state is None:
 125             if self.expected == 'is not set':
 126                 self.result = 'OK: is not found'
 127             else:
 128                 self.result = 'FAIL: is not found'
 129         else:
 130             self.result = 'FAIL: "' + self.state + '"'
 131
 132     def table_print(self, _mode, with_results):
 133         print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, self.expected, self.decision, self.reason), end='')
 134         if with_results:
 135             print('| {}'.format(self.result), end='')
 136
 137     def json_dump(self, with_results):
 138         dump = [self.name, self.type, self.expected, self.decision, self.reason]
 139         if with_results:
 140             dump.append(self.result)
 141         return dump
 142
 143
 144 class KconfigCheck(OptCheck):
 145     def __init__(self, *args, **kwargs):
 146         super().__init__(*args, **kwargs)
 147         self.name = 'CONFIG_' + self.name
 148
 149     @property
 150     def type(self):
 151         return 'kconfig'
 152
 153
 154 class CmdlineCheck(OptCheck):
 155     @property
 156     def type(self):
 157         return 'cmdline'
 158
 159
 160 class VersionCheck:
 161     def __init__(self, ver_expected):
 162         assert(ver_expected and isinstance(ver_expected, tuple) and len(ver_expected) == 2), \
 163                'invalid version "{}" for VersionCheck'.format(ver_expected)
 164         self.ver_expected = ver_expected
 165         self.ver = ()
 166         self.result = None
 167
 168     @property
 169     def type(self):
 170         return 'version'
 171
 172     def check(self):
 173         if self.ver[0] > self.ver_expected[0]:
 174             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 175             return
 176         if self.ver[0] < self.ver_expected[0]:
 177             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 178             return
 179         if self.ver[1] >= self.ver_expected[1]:
 180             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 181             return
 182         self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 183
 184     def table_print(self, _mode, with_results):
 185         ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 186         print('{:<91}'.format(ver_req), end='')
 187         if with_results:
 188             print('| {}'.format(self.result), end='')
 189
 190
 191 class ComplexOptCheck:
 192     def __init__(self, *opts):
 193         self.opts = opts
 194         assert(self.opts), \
 195                'empty {} check'.format(self.__class__.__name__)
 196         assert(len(self.opts) != 1), \
 197                 'useless {} check: {}'.format(self.__class__.__name__, opts)
 198         assert(isinstance(opts[0], (KconfigCheck, CmdlineCheck))), \
 199                'invalid {} check: {}'.format(self.__class__.__name__, opts)
 200         self.result = None
 201
 202     @property
 203     def type(self):
 204         return 'complex'
 205
 206     @property
 207     def name(self):
 208         return self.opts[0].name
 209
 210     @property
 211     def expected(self):
 212         return self.opts[0].expected
 213
 214     def table_print(self, mode, with_results):
 215         if mode == 'verbose':
 216             print('    {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
 217             if with_results:
 218                 print('| {}'.format(self.result), end='')
 219             for o in self.opts:
 220                 print()
 221                 o.table_print(mode, with_results)
 222         else:
 223             o = self.opts[0]
 224             o.table_print(mode, False)
 225             if with_results:
 226                 print('| {}'.format(self.result), end='')
 227
 228     def json_dump(self, with_results):
 229         dump = self.opts[0].json_dump(False)
 230         if with_results:
 231             dump.append(self.result)
 232         return dump
 233
 234
 235 class OR(ComplexOptCheck):
 236     # self.opts[0] is the option that this OR-check is about.
 237     # Use cases:
 238     #     OR(<X_is_hardened>, <X_is_disabled>)
 239     #     OR(<X_is_hardened>, <old_X_is_hardened>)
 240     def check(self):
 241         for i, opt in enumerate(self.opts):
 242             opt.check()
 243             if opt.result.startswith('OK'):
 244                 self.result = opt.result
 245                 # Add more info for additional checks:
 246                 if i != 0:
 247                     if opt.result == 'OK':
 248                         self.result = 'OK: {} is "{}"'.format(opt.name, opt.expected)
 249                     elif opt.result == 'OK: is not found':
 250                         self.result = 'OK: {} is not found'.format(opt.name)
 251                     elif opt.result == 'OK: is present':
 252                         self.result = 'OK: {} is present'.format(opt.name)
 253                     elif opt.result.startswith('OK: is not off'):
 254                         self.result = 'OK: {} is not off'.format(opt.name)
 255                     else:
 256                         # VersionCheck provides enough info
 257                         assert(opt.result.startswith('OK: version')), \
 258                                'unexpected OK description "{}"'.format(opt.result)
 259                 return
 260         self.result = self.opts[0].result
 261
 262
 263 class AND(ComplexOptCheck):
 264     # self.opts[0] is the option that this AND-check is about.
 265     # Use cases:
 266     #     AND(<suboption>, <main_option>)
 267     #       Suboption is not checked if checking of the main_option is failed.
 268     #     AND(<X_is_disabled>, <old_X_is_disabled>)
 269     def check(self):
 270         for i, opt in reversed(list(enumerate(self.opts))):
 271             opt.check()
 272             if i == 0:
 273                 self.result = opt.result
 274                 return
 275             if not opt.result.startswith('OK'):
 276                 # This FAIL is caused by additional checks,
 277                 # and not by the main option that this AND-check is about.
 278                 # Describe the reason of the FAIL.
 279                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: is not found':
 280                     self.result = 'FAIL: {} is not "{}"'.format(opt.name, opt.expected)
 281                 elif opt.result == 'FAIL: is not present':
 282                     self.result = 'FAIL: {} is not present'.format(opt.name)
 283                 elif opt.result == 'FAIL: is off' or opt.result == 'FAIL: is off, "0"':
 284                     self.result = 'FAIL: {} is off'.format(opt.name)
 285                 elif opt.result == 'FAIL: is off, not found':
 286                     self.result = 'FAIL: {} is off, not found'.format(opt.name)
 287                 else:
 288                     # VersionCheck provides enough info
 289                     self.result = opt.result
 290                     assert(opt.result.startswith('FAIL: version')), \
 291                            'unexpected FAIL description "{}"'.format(opt.result)
 292                 return
 293
 294
 295 def detect_arch(fname, archs):
 296     with open(fname, 'r') as f:
 297         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 298         arch = None
 299         for line in f.readlines():
 300             if arch_pattern.match(line):
 301                 option, _ = line[7:].split('=', 1)
 302                 if option in archs:
 303                     if not arch:
 304                         arch = option
 305                     else:
 306                         return None, 'more than one supported architecture is detected'
 307         if not arch:
 308             return None, 'failed to detect architecture'
 309         return arch, 'OK'
 310
 311
 312 def detect_kernel_version(fname):
 313     with open(fname, 'r') as f:
 314         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
 315         for line in f.readlines():
 316             if ver_pattern.match(line):
 317                 line = line.strip()
 318                 parts = line.split()
 319                 ver_str = parts[2]
 320                 ver_numbers = ver_str.split('.')
 321                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
 322                     msg = 'failed to parse the version "' + ver_str + '"'
 323                     return None, msg
 324                 return (int(ver_numbers[0]), int(ver_numbers[1])), None
 325         return None, 'no kernel version detected'
 326
 327
 328 def detect_compiler(fname):
 329     gcc_version = None
 330     clang_version = None
 331     with open(fname, 'r') as f:
 332         gcc_version_pattern = re.compile("CONFIG_GCC_VERSION=[0-9]*")
 333         clang_version_pattern = re.compile("CONFIG_CLANG_VERSION=[0-9]*")
 334         for line in f.readlines():
 335             if gcc_version_pattern.match(line):
 336                 gcc_version = line[19:-1]
 337             if clang_version_pattern.match(line):
 338                 clang_version = line[21:-1]
 339     if not gcc_version or not clang_version:
 340         return None, 'no CONFIG_GCC_VERSION or CONFIG_CLANG_VERSION'
 341     if gcc_version == '0' and clang_version != '0':
 342         return 'CLANG ' + clang_version, 'OK'
 343     if gcc_version != '0' and clang_version == '0':
 344         return 'GCC ' + gcc_version, 'OK'
 345     sys.exit('[!] ERROR: invalid GCC_VERSION and CLANG_VERSION: {} {}'.format(gcc_version, clang_version))
 346
 347
 348 def add_kconfig_checks(l, arch):
 349     # Calling the KconfigCheck class constructor:
 350     #     KconfigCheck(reason, decision, name, expected)
 351     #
 352     # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
 353     #     when the tool doesn't check the cmdline.
 354
 355     efi_not_set = KconfigCheck('-', '-', 'EFI', 'is not set')
 356     cc_is_gcc = KconfigCheck('-', '-', 'CC_IS_GCC', 'y') # exists since v4.18
 357     cc_is_clang = KconfigCheck('-', '-', 'CC_IS_CLANG', 'y') # exists since v4.18
 358
 359     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
 360     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
 361     bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
 362
 363     # 'self_protection', 'defconfig'
 364     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
 365     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
 366     l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
 367     gcc_plugins_support_is_set = KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')
 368     l += [gcc_plugins_support_is_set]
 369     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
 370     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
 371     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
 372              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'),
 373              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_REGULAR', 'y'),
 374              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_AUTO', 'y'),
 375              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 376     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
 377              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 378     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
 379              KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
 380     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
 381              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
 382              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
 383     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
 384              VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
 385     if arch in ('X86_64', 'ARM64', 'X86_32'):
 386         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
 387     if arch in ('X86_64', 'ARM64'):
 388         l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
 389     if arch in ('X86_64', 'X86_32'):
 390         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE', 'y')]
 391         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_INTEL', 'y')]
 392         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_AMD', 'y')]
 393         l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
 394         l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
 395         l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
 396         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y'),
 397                  VersionCheck((5, 19)))] # X86_SMAP is enabled by default since v5.19
 398         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
 399                  KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
 400     if arch in ('ARM64', 'ARM'):
 401         l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
 402     if arch == 'X86_64':
 403         l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
 404         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
 405         l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
 406                   iommu_support_is_set)]
 407         l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
 408                   iommu_support_is_set)]
 409     if arch == 'ARM64':
 410         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
 411         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
 412         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
 413         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_E0PD', 'y')]
 414         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
 415         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
 416         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
 417         l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
 418         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
 419         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
 420         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
 421                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
 422                      VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
 423         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
 424                  VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
 425     if arch == 'ARM':
 426         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
 427         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
 428         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
 429
 430     # 'self_protection', 'kspp'
 431     l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
 432     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
 433     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
 434     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
 435     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
 436     l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
 437     l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
 438     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
 439     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_VIRTUAL', 'y')]
 440     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
 441     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
 442     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
 443     l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
 444     l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
 445     l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
 446     l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
 447     l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
 448     l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
 449     l += [KconfigCheck('self_protection', 'kspp', 'HW_RANDOM_TPM', 'y')]
 450     l += [KconfigCheck('self_protection', 'kspp', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
 451     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
 452     randstruct_is_set = OR(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_FULL', 'y'),
 453                            KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y'))
 454     l += [randstruct_is_set]
 455     l += [AND(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_PERFORMANCE', 'is not set'),
 456               KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 457               randstruct_is_set)]
 458     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 459     l += [hardened_usercopy_is_set]
 460     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 461               hardened_usercopy_is_set)]
 462     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
 463               hardened_usercopy_is_set)]
 464     l += [AND(KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y'),
 465               gcc_plugins_support_is_set)]
 466     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 467              modules_not_set)]
 468     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 469              modules_not_set)]
 470     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 471              modules_not_set)]
 472     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 473              modules_not_set)] # refers to LOCKDOWN
 474     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
 475              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 476     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 477              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
 478              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
 479              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
 480              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
 481              # the 0xAA poison pattern on allocation.
 482              # That brings higher performance penalty.
 483     l += [OR(KconfigCheck('self_protection', 'kspp', 'EFI_DISABLE_PCI_DMA', 'y'),
 484              efi_not_set)]
 485     l += [OR(KconfigCheck('self_protection', 'kspp', 'RESET_ATTACK_MITIGATION', 'y'),
 486              efi_not_set)] # needs userspace support (systemd)
 487     ubsan_bounds_is_set = KconfigCheck('self_protection', 'kspp', 'UBSAN_BOUNDS', 'y')
 488     l += [ubsan_bounds_is_set]
 489     l += [OR(KconfigCheck('self_protection', 'kspp', 'UBSAN_LOCAL_BOUNDS', 'y'),
 490              AND(ubsan_bounds_is_set,
 491                  cc_is_gcc))]
 492     l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_TRAP', 'y'),
 493               ubsan_bounds_is_set,
 494               KconfigCheck('self_protection', 'kspp', 'UBSAN_SHIFT', 'is not set'),
 495               KconfigCheck('self_protection', 'kspp', 'UBSAN_DIV_ZERO', 'is not set'),
 496               KconfigCheck('self_protection', 'kspp', 'UBSAN_UNREACHABLE', 'is not set'),
 497               KconfigCheck('self_protection', 'kspp', 'UBSAN_BOOL', 'is not set'),
 498               KconfigCheck('self_protection', 'kspp', 'UBSAN_ENUM', 'is not set'),
 499               KconfigCheck('self_protection', 'kspp', 'UBSAN_ALIGNMENT', 'is not set'))] # only array index bounds checking with traps
 500     if arch in ('X86_64', 'ARM64', 'X86_32'):
 501         l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_SANITIZE_ALL', 'y'),
 502                   ubsan_bounds_is_set)] # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
 503         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 504         l += [AND(stackleak_is_set, gcc_plugins_support_is_set)]
 505         l += [AND(KconfigCheck('self_protection', 'kspp', 'STACKLEAK_METRICS', 'is not set'),
 506                   stackleak_is_set,
 507                   gcc_plugins_support_is_set)]
 508         l += [AND(KconfigCheck('self_protection', 'kspp', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 509                   stackleak_is_set,
 510                   gcc_plugins_support_is_set)]
 511         l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
 512     if arch in ('X86_64', 'ARM64'):
 513         cfi_clang_is_set = KconfigCheck('self_protection', 'kspp', 'CFI_CLANG', 'y')
 514         l += [cfi_clang_is_set]
 515         l += [AND(KconfigCheck('self_protection', 'kspp', 'CFI_PERMISSIVE', 'is not set'),
 516                   cfi_clang_is_set)]
 517     if arch in ('X86_64', 'X86_32'):
 518         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
 519         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 520                   iommu_support_is_set)]
 521     if arch in ('ARM64', 'ARM'):
 522         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
 523         l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
 524     if arch == 'X86_64':
 525         l += [KconfigCheck('self_protection', 'kspp', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
 526         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU_SVM', 'y'),
 527                   iommu_support_is_set)]
 528         l += [AND(KconfigCheck('self_protection', 'kspp', 'AMD_IOMMU_V2', 'y'),
 529                   iommu_support_is_set)]
 530     if arch == 'ARM64':
 531         l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
 532         l += [KconfigCheck('self_protection', 'kspp', 'SHADOW_CALL_STACK', 'y')]
 533         l += [KconfigCheck('self_protection', 'kspp', 'KASAN_HW_TAGS', 'y')]
 534     if arch == 'X86_32':
 535         l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
 536         l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
 537         l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
 538         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU', 'y'),
 539                   iommu_support_is_set)]
 540
 541     # 'self_protection', 'clipos'
 542     l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')]
 543
 544     # 'security_policy'
 545     if arch in ('X86_64', 'ARM64', 'X86_32'):
 546         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
 547     if arch == 'ARM':
 548         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
 549     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 550     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LANDLOCK', 'y')]
 551     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
 552     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_BOOTPARAM', 'is not set')]
 553     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DEVELOP', 'is not set')]
 554     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM', 'y')]
 555     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 556     l += [KconfigCheck('security_policy', 'kspp', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 557     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
 558
 559     # 'cut_attack_surface', 'defconfig'
 560     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 561     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 562     l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
 563              bpf_syscall_not_set)] # see unprivileged_bpf_disabled
 564     if arch in ('X86_64', 'ARM64', 'X86_32'):
 565         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 566                  devmem_not_set)] # refers to LOCKDOWN
 567     if arch in ('X86_64', 'X86_32'):
 568         l += [KconfigCheck('cut_attack_surface', 'defconfig', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 569
 570     # 'cut_attack_surface', 'kspp'
 571     l += [KconfigCheck('cut_attack_surface', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
 572     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 573     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 574     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 575     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 576     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 577     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 578     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 579     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 580     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 581     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 582     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 583     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 584     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 585     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 586     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 587     l += [modules_not_set]
 588     l += [devmem_not_set]
 589     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 590              devmem_not_set)] # refers to LOCKDOWN
 591     l += [AND(KconfigCheck('cut_attack_surface', 'kspp', 'LDISC_AUTOLOAD', 'is not set'),
 592               KconfigCheck('cut_attack_surface', 'kspp', 'LDISC_AUTOLOAD', 'is present'))]
 593     if arch == 'X86_64':
 594         l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 595     if arch == 'ARM':
 596         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 597                  devmem_not_set)] # refers to LOCKDOWN
 598
 599     # 'cut_attack_surface', 'grsec'
 600     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
 601     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
 602     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
 603     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
 604     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
 605     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
 606     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 607     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
 608     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
 609     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
 610     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
 611     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
 612     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
 613     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
 614     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
 615     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
 616     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
 617     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
 618     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 619     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 620     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 621     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
 622     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
 623     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
 624     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
 625     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
 626     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
 627     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
 628     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
 629     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
 630     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
 631     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
 632     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
 633     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
 634     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
 635     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
 636     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
 637     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
 638               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
 639
 640     # 'cut_attack_surface', 'maintainer'
 641     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
 642     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
 643     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
 644     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
 645     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
 646
 647     # 'cut_attack_surface', 'grapheneos'
 648     l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 649
 650     # 'cut_attack_surface', 'clipos'
 651     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 652     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 653     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 654     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 655     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 656     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 657     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 658     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 659     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 660     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 661     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 662     l += [KconfigCheck('cut_attack_surface', 'clipos', 'COREDUMP', 'is not set')] # cut userspace attack surface
 663 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 664
 665     # 'cut_attack_surface', 'lockdown'
 666     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 667     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 668     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 669     l += [bpf_syscall_not_set] # refers to LOCKDOWN
 670
 671     # 'cut_attack_surface', 'my'
 672     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 673     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 674     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 675     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 676     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 677     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 678     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 679     l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
 680     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
 681              modules_not_set)]
 682
 683     # 'harden_userspace'
 684     if arch in ('X86_64', 'ARM64', 'X86_32'):
 685         l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
 686     if arch == 'ARM':
 687         l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
 688     if arch == 'ARM64':
 689         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
 690         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_BTI', 'y')]
 691     if arch in ('ARM', 'X86_32'):
 692         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
 693     if arch in ('X86_64', 'ARM64'):
 694         l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
 695     if arch in ('X86_32', 'ARM'):
 696         l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
 697
 698
 699 def add_cmdline_checks(l, arch):
 700     # Calling the CmdlineCheck class constructor:
 701     #     CmdlineCheck(reason, decision, name, expected)
 702     #
 703     # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
 704     #     when the tool doesn't check the cmdline.
 705     #
 706     # [!] Make sure that values of the options in CmdlineChecks need normalization.
 707     #     For more info see normalize_cmdline_options().
 708     #
 709     # A common pattern for checking the 'param_x' cmdline parameter
 710     # that __overrides__ the 'PARAM_X_DEFAULT' kconfig option:
 711     #   l += [OR(CmdlineCheck(reason, decision, 'param_x', '1'),
 712     #            AND(KconfigCheck(reason, decision, 'PARAM_X_DEFAULT_ON', 'y'),
 713     #                CmdlineCheck(reason, decision, 'param_x, 'is not set')))]
 714     #
 715     # Here we don't check the kconfig options or minimal kernel version
 716     # required for the cmdline parameters. That would make the checks
 717     # very complex and not give a 100% guarantee anyway.
 718
 719     # 'self_protection', 'defconfig'
 720     l += [CmdlineCheck('self_protection', 'defconfig', 'nosmep', 'is not set')]
 721     l += [CmdlineCheck('self_protection', 'defconfig', 'nosmap', 'is not set')]
 722     l += [CmdlineCheck('self_protection', 'defconfig', 'nokaslr', 'is not set')]
 723     l += [CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set')]
 724     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v1', 'is not set')]
 725     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v2', 'is not set')]
 726     l += [CmdlineCheck('self_protection', 'defconfig', 'nospec_store_bypass_disable', 'is not set')]
 727     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nobti', 'is not set')]
 728     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nopauth', 'is not set')]
 729     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nomte', 'is not set')]
 730     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mitigations', 'is not off'),
 731              CmdlineCheck('self_protection', 'defconfig', 'mitigations', 'is not set'))]
 732     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not off'),
 733              CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not set'))]
 734     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not off'),
 735              CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not set'))]
 736     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not off'),
 737              CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not set'))]
 738     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not off'),
 739              CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not set'))]
 740     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not off'),
 741              CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not set'))]
 742     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not off'),
 743              CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not set'))]
 744     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not off'),
 745              CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not set'))]
 746     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not off'),
 747              CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not set'))]
 748     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not off'),
 749              CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not set'))]
 750     if arch == 'ARM64':
 751         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'kernel'),
 752                  CmdlineCheck('self_protection', 'my', 'ssbd', 'force-on'),
 753                  CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'is not set'))]
 754         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', 'full'),
 755                  AND(KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y'),
 756                      CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set')))]
 757     else:
 758         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', '1'),
 759                  CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set'))]
 760
 761     # 'self_protection', 'kspp'
 762     l += [CmdlineCheck('self_protection', 'kspp', 'nosmt', 'is present')]
 763     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
 764              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
 765                  CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
 766     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_free', '1'),
 767              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 768                  CmdlineCheck('self_protection', 'kspp', 'init_on_free', 'is not set')),
 769              AND(CmdlineCheck('self_protection', 'kspp', 'page_poison', '1'),
 770                  KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'),
 771                  CmdlineCheck('self_protection', 'kspp', 'slub_debug', 'P')))]
 772     l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_nomerge', 'is present'),
 773              AND(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
 774                  CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set')))]
 775     l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.strict', '1'),
 776              AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y'),
 777                  CmdlineCheck('self_protection', 'kspp', 'iommu.strict', 'is not set')))]
 778     l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', '0'),
 779              AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set'),
 780                  CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', 'is not set')))]
 781     # The cmdline checks compatible with the kconfig recommendations of the KSPP project...
 782     l += [OR(CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', '1'),
 783              AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y'),
 784                  CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', 'is not set')))]
 785     l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', '0'),
 786              AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 787                  CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', 'is not set')))]
 788     # ... the end
 789     if arch in ('X86_64', 'ARM64', 'X86_32'):
 790         l += [OR(CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'),
 791                  AND(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
 792                      CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', 'is not set')))]
 793     if arch in ('X86_64', 'X86_32'):
 794         l += [AND(CmdlineCheck('self_protection', 'kspp', 'pti', 'on'),
 795                   CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set'))]
 796
 797     # 'self_protection', 'clipos'
 798     l += [CmdlineCheck('self_protection', 'clipos', 'page_alloc.shuffle', '1')]
 799
 800     # 'cut_attack_surface', 'defconfig'
 801     if arch in ('X86_64', 'X86_32'):
 802         l += [OR(CmdlineCheck('cut_attack_surface', 'defconfig', 'tsx', 'off'),
 803                  AND(KconfigCheck('cut_attack_surface', 'defconfig', 'X86_INTEL_TSX_MODE_OFF', 'y'),
 804                      CmdlineCheck('cut_attack_surface', 'defconfig', 'tsx', 'is not set')))]
 805
 806     # 'cut_attack_surface', 'kspp'
 807     if arch == 'X86_64':
 808         l += [OR(CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'none'),
 809                  AND(KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'),
 810                      CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'is not set')))]
 811
 812     # 'cut_attack_surface', 'grsec'
 813     # The cmdline checks compatible with the kconfig options disabled by grsecurity...
 814     l += [OR(CmdlineCheck('cut_attack_surface', 'grsec', 'debugfs', 'off'),
 815              KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set'))] # ... the end
 816
 817     # 'cut_attack_surface', 'my'
 818     l += [CmdlineCheck('cut_attack_surface', 'my', 'sysrq_always_enabled', 'is not set')]
 819
 820 def print_unknown_options(checklist, parsed_options):
 821     known_options = []
 822
 823     for o1 in checklist:
 824         if o1.type != 'complex':
 825             known_options.append(o1.name)
 826             continue
 827         for o2 in o1.opts:
 828             if o2.type != 'complex':
 829                 if hasattr(o2, 'name'):
 830                     known_options.append(o2.name)
 831                 continue
 832             for o3 in o2.opts:
 833                 assert(o3.type != 'complex'), \
 834                        'unexpected ComplexOptCheck inside {}'.format(o2.name)
 835                 if hasattr(o3, 'name'):
 836                     known_options.append(o3.name)
 837
 838     for option, value in parsed_options.items():
 839         if option not in known_options:
 840             print('[?] No check for option {} ({})'.format(option, value))
 841
 842
 843 def print_checklist(mode, checklist, with_results):
 844     if mode == 'json':
 845         output = []
 846         for o in checklist:
 847             output.append(o.json_dump(with_results))
 848         print(json.dumps(output))
 849         return
 850
 851     # table header
 852     sep_line_len = 91
 853     if with_results:
 854         sep_line_len += 30
 855     print('=' * sep_line_len)
 856     print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
 857     if with_results:
 858         print('| {}'.format('check result'), end='')
 859     print()
 860     print('=' * sep_line_len)
 861
 862     # table contents
 863     for opt in checklist:
 864         if with_results:
 865             if mode == 'show_ok':
 866                 if not opt.result.startswith('OK'):
 867                     continue
 868             if mode == 'show_fail':
 869                 if not opt.result.startswith('FAIL'):
 870                     continue
 871         opt.table_print(mode, with_results)
 872         print()
 873         if mode == 'verbose':
 874             print('-' * sep_line_len)
 875     print()
 876
 877     # final score
 878     if with_results:
 879         fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 880         fail_suppressed = ''
 881         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
 882         ok_suppressed = ''
 883         if mode == 'show_ok':
 884             fail_suppressed = ' (suppressed in output)'
 885         if mode == 'show_fail':
 886             ok_suppressed = ' (suppressed in output)'
 887         if mode != 'json':
 888             print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
 889
 890
 891 def populate_simple_opt_with_data(opt, data, data_type):
 892     assert(opt.type != 'complex'), \
 893            'unexpected ComplexOptCheck "{}"'.format(opt.name)
 894     assert(opt.type in SIMPLE_OPTION_TYPES), \
 895            'invalid opt type "{}"'.format(opt.type)
 896     assert(data_type in SIMPLE_OPTION_TYPES), \
 897            'invalid data type "{}"'.format(data_type)
 898
 899     if data_type != opt.type:
 900         return
 901
 902     if data_type in ('kconfig', 'cmdline'):
 903         opt.state = data.get(opt.name, None)
 904     else:
 905         assert(data_type == 'version'), \
 906                'unexpected data type "{}"'.format(data_type)
 907         opt.ver = data
 908
 909
 910 def populate_opt_with_data(opt, data, data_type):
 911     if opt.type == 'complex':
 912         for o in opt.opts:
 913             if o.type == 'complex':
 914                 # Recursion for nested ComplexOptCheck objects
 915                 populate_opt_with_data(o, data, data_type)
 916             else:
 917                 populate_simple_opt_with_data(o, data, data_type)
 918     else:
 919         assert(opt.type in ('kconfig', 'cmdline')), \
 920                'bad type "{}" for a simple check'.format(opt.type)
 921         populate_simple_opt_with_data(opt, data, data_type)
 922
 923
 924 def populate_with_data(checklist, data, data_type):
 925     for opt in checklist:
 926         populate_opt_with_data(opt, data, data_type)
 927
 928
 929 def perform_checks(checklist):
 930     for opt in checklist:
 931         opt.check()
 932
 933
 934 def parse_kconfig_file(parsed_options, fname):
 935     with open(fname, 'r') as f:
 936         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 937         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 938
 939         for line in f.readlines():
 940             line = line.strip()
 941             option = None
 942             value = None
 943
 944             if opt_is_on.match(line):
 945                 option, value = line.split('=', 1)
 946                 if value == 'is not set':
 947                     sys.exit('[!] ERROR: bad enabled kconfig option "{}"'.format(line))
 948             elif opt_is_off.match(line):
 949                 option, value = line[2:].split(' ', 1)
 950                 if value != 'is not set':
 951                     sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
 952
 953             if option in parsed_options:
 954                 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
 955
 956             if option:
 957                 parsed_options[option] = value
 958
 959
 960 def normalize_cmdline_options(option, value):
 961     # Don't normalize the cmdline option values if
 962     # the Linux kernel doesn't use kstrtobool() for them
 963     if option == 'debugfs':
 964         # See debugfs_kernel() in fs/debugfs/inode.c
 965         return value
 966     if option == 'mitigations':
 967         # See mitigations_parse_cmdline() in kernel/cpu.c
 968         return value
 969     if option == 'pti':
 970         # See pti_check_boottime_disable() in arch/x86/mm/pti.c
 971         return value
 972     if option == 'spectre_v2':
 973         # See spectre_v2_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 974         return value
 975     if option == 'spectre_v2_user':
 976         # See spectre_v2_parse_user_cmdline() in arch/x86/kernel/cpu/bugs.c
 977         return value
 978     if option == 'spec_store_bypass_disable':
 979         # See ssb_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 980         return value
 981     if option == 'l1tf':
 982         # See l1tf_cmdline() in arch/x86/kernel/cpu/bugs.c
 983         return value
 984     if option == 'mds':
 985         # See mds_cmdline() in arch/x86/kernel/cpu/bugs.c
 986         return value
 987     if option == 'tsx_async_abort':
 988         # See tsx_async_abort_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 989         return value
 990     if option == 'srbds':
 991         # See srbds_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 992         return value
 993     if option == 'mmio_stale_data':
 994         # See mmio_stale_data_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 995         return value
 996     if option == 'retbleed':
 997         # See retbleed_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
 998         return value
 999     if option == 'tsx':
1000         # See tsx_init() in arch/x86/kernel/cpu/tsx.c
1001         return value
1002
1003     # Implement a limited part of the kstrtobool() logic
1004     if value in ('1', 'on', 'On', 'ON', 'y', 'Y', 'yes', 'Yes', 'YES'):
1005         return '1'
1006     if value in ('0', 'off', 'Off', 'OFF', 'n', 'N', 'no', 'No', 'NO'):
1007         return '0'
1008
1009     # Preserve unique values
1010     return value
1011
1012
1013 def parse_cmdline_file(parsed_options, fname):
1014     with open(fname, 'r') as f:
1015         line = f.readline()
1016         opts = line.split()
1017
1018         line = f.readline()
1019         if line:
1020             sys.exit('[!] ERROR: more than one line in "{}"'.format(fname))
1021
1022         for opt in opts:
1023             if '=' in opt:
1024                 name, value = opt.split('=', 1)
1025             else:
1026                 name = opt
1027                 value = '' # '' is not None
1028             value = normalize_cmdline_options(name, value)
1029             parsed_options[name] = value
1030
1031
1032 def main():
1033     # Report modes:
1034     #   * verbose mode for
1035     #     - reporting about unknown kernel options in the kconfig
1036     #     - verbose printing of ComplexOptCheck items
1037     #   * json mode for printing the results in JSON format
1038     report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
1039     supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
1040     parser = ArgumentParser(prog='kconfig-hardened-check',
1041                             description='A tool for checking the security hardening options of the Linux kernel')
1042     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
1043     parser.add_argument('-p', '--print', choices=supported_archs,
1044                         help='print security hardening preferences for the selected architecture')
1045     parser.add_argument('-c', '--config',
1046                         help='check the kernel kconfig file against these preferences')
1047     parser.add_argument('-l', '--cmdline',
1048                         help='check the kernel cmdline file against these preferences')
1049     parser.add_argument('-m', '--mode', choices=report_modes,
1050                         help='choose the report mode')
1051     args = parser.parse_args()
1052
1053     mode = None
1054     if args.mode:
1055         mode = args.mode
1056         if mode != 'json':
1057             print('[+] Special report mode: {}'.format(mode))
1058
1059     config_checklist = []
1060
1061     if args.config:
1062         if args.print:
1063             sys.exit('[!] ERROR: --config and --print can\'t be used together')
1064
1065         if mode != 'json':
1066             print('[+] Kconfig file to check: {}'.format(args.config))
1067             if args.cmdline:
1068                 print('[+] Kernel cmdline file to check: {}'.format(args.cmdline))
1069
1070         arch, msg = detect_arch(args.config, supported_archs)
1071         if not arch:
1072             sys.exit('[!] ERROR: {}'.format(msg))
1073         if mode != 'json':
1074             print('[+] Detected architecture: {}'.format(arch))
1075
1076         kernel_version, msg = detect_kernel_version(args.config)
1077         if not kernel_version:
1078             sys.exit('[!] ERROR: {}'.format(msg))
1079         if mode != 'json':
1080             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
1081
1082         compiler, msg = detect_compiler(args.config)
1083         if mode != 'json':
1084             if compiler:
1085                 print('[+] Detected compiler: {}'.format(compiler))
1086             else:
1087                 print('[-] Can\'t detect the compiler: {}'.format(msg))
1088
1089         # add relevant kconfig checks to the checklist
1090         add_kconfig_checks(config_checklist, arch)
1091
1092         if args.cmdline:
1093             # add relevant cmdline checks to the checklist
1094             add_cmdline_checks(config_checklist, arch)
1095
1096         # populate the checklist with the parsed kconfig data
1097         parsed_kconfig_options = OrderedDict()
1098         parse_kconfig_file(parsed_kconfig_options, args.config)
1099         populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
1100         populate_with_data(config_checklist, kernel_version, 'version')
1101
1102         if args.cmdline:
1103             # populate the checklist with the parsed kconfig data
1104             parsed_cmdline_options = OrderedDict()
1105             parse_cmdline_file(parsed_cmdline_options, args.cmdline)
1106             populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
1107
1108         # now everything is ready for performing the checks
1109         perform_checks(config_checklist)
1110
1111         # finally print the results
1112         if mode == 'verbose':
1113             print_unknown_options(config_checklist, parsed_kconfig_options)
1114         print_checklist(mode, config_checklist, True)
1115
1116         sys.exit(0)
1117     elif args.cmdline:
1118         sys.exit('[!] ERROR: checking cmdline doesn\'t work without checking kconfig')
1119
1120     if args.print:
1121         if mode in ('show_ok', 'show_fail'):
1122             sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
1123         arch = args.print
1124         add_kconfig_checks(config_checklist, arch)
1125         add_cmdline_checks(config_checklist, arch)
1126         if mode != 'json':
1127             print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
1128         print_checklist(mode, config_checklist, False)
1129         sys.exit(0)
1130
1131     parser.print_help()
1132     sys.exit(0)