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