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