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