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 #           arm64.nomte
  25 #
  26 #    Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
  27 #           kasan=on
  28 #           kasan.stacktrace=off
  29 #           kasan.fault=panic
  30 #
  31 # N.B. Hardening sysctls:
  32 #    kernel.kptr_restrict=2 (or 1?)
  33 #    kernel.dmesg_restrict=1 (also see the kconfig option)
  34 #    kernel.perf_event_paranoid=3
  35 #    kernel.kexec_load_disabled=1
  36 #    kernel.yama.ptrace_scope=3
  37 #    user.max_user_namespaces=0
  38 #    what about bpf_jit_enable?
  39 #    kernel.unprivileged_bpf_disabled=1
  40 #    net.core.bpf_jit_harden=2
  41 #    vm.unprivileged_userfaultfd=0
  42 #        (at first, it disabled unprivileged userfaultfd,
  43 #         and since v5.11 it enables unprivileged userfaultfd for user-mode only)
  44 #    vm.mmap_min_addr has a good value
  45 #    dev.tty.ldisc_autoload=0
  46 #    fs.protected_symlinks=1
  47 #    fs.protected_hardlinks=1
  48 #    fs.protected_fifos=2
  49 #    fs.protected_regular=2
  50 #    fs.suid_dumpable=0
  51 #    kernel.modules_disabled=1
  52 #    kernel.randomize_va_space = 2
  53
  54
  55 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
  56 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
  57
  58
  59 import sys
  60 from argparse import ArgumentParser
  61 from collections import OrderedDict
  62 import re
  63 import json
  64 from .__about__ import __version__
  65
  66 SIMPLE_OPTION_TYPES = ('kconfig', 'version', 'cmdline')
  67
  68 class OptCheck:
  69     def __init__(self, reason, decision, name, expected):
  70         assert(name and name == name.strip() and len(name.split()) == 1), \
  71                'invalid name "{}" for {}'.format(name, self.__class__.__name__)
  72         self.name = name
  73
  74         assert(decision and decision == decision.strip() and len(decision.split()) == 1), \
  75                'invalid decision "{}" for "{}" check'.format(decision, name)
  76         self.decision = decision
  77
  78         assert(reason and reason == reason.strip() and len(reason.split()) == 1), \
  79                'invalid reason "{}" for "{}" check'.format(reason, name)
  80         self.reason = reason
  81
  82         assert(expected and expected == expected.strip()), \
  83                'invalid expected value "{}" for "{}" check (1)'.format(expected, name)
  84         val_len = len(expected.split())
  85         if val_len == 3:
  86             assert(expected == 'is not set' or expected == 'is not off'), \
  87                    'invalid expected value "{}" for "{}" check (2)'.format(expected, name)
  88         elif val_len == 2:
  89             assert(expected == 'is present'), \
  90                    'invalid expected value "{}" for "{}" check (3)'.format(expected, name)
  91         else:
  92             assert(val_len == 1), \
  93                    'invalid expected value "{}" for "{}" check (4)'.format(expected, name)
  94         self.expected = expected
  95
  96         self.state = None
  97         self.result = None
  98
  99     @property
 100     def type(self):
 101         return None
 102
 103     def check(self):
 104         # handle the 'is present' check
 105         if self.expected == 'is present':
 106             if self.state is None:
 107                 self.result = 'FAIL: is not present'
 108             else:
 109                 self.result = 'OK: is present'
 110             return
 111
 112         # handle the 'is not off' option check
 113         if self.expected == 'is not off':
 114             if self.state == 'off':
 115                 self.result = 'FAIL: is off'
 116             elif self.state is None:
 117                 self.result = 'FAIL: is off, not found'
 118             else:
 119                 self.result = 'OK: is not off, "' + self.state + '"'
 120             return
 121
 122         # handle the option value check
 123         if self.expected == self.state:
 124             self.result = 'OK'
 125         elif self.state is None:
 126             if self.expected == 'is not set':
 127                 self.result = 'OK: is not found'
 128             else:
 129                 self.result = 'FAIL: is not found'
 130         else:
 131             self.result = 'FAIL: "' + self.state + '"'
 132
 133     def table_print(self, _mode, with_results):
 134         print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, self.expected, self.decision, self.reason), end='')
 135         if with_results:
 136             print('| {}'.format(self.result), end='')
 137
 138     def json_dump(self, with_results):
 139         dump = [self.name, self.type, self.expected, self.decision, self.reason]
 140         if with_results:
 141             dump.append(self.result)
 142         return dump
 143
 144
 145 class KconfigCheck(OptCheck):
 146     def __init__(self, *args, **kwargs):
 147         super().__init__(*args, **kwargs)
 148         self.name = 'CONFIG_' + self.name
 149
 150     @property
 151     def type(self):
 152         return 'kconfig'
 153
 154
 155 class CmdlineCheck(OptCheck):
 156     @property
 157     def type(self):
 158         return 'cmdline'
 159
 160
 161 class VersionCheck:
 162     def __init__(self, ver_expected):
 163         assert(ver_expected and isinstance(ver_expected, tuple) and len(ver_expected) == 2), \
 164                'invalid version "{}" for VersionCheck'.format(ver_expected)
 165         self.ver_expected = ver_expected
 166         self.ver = ()
 167         self.result = None
 168
 169     @property
 170     def type(self):
 171         return 'version'
 172
 173     def check(self):
 174         if self.ver[0] > self.ver_expected[0]:
 175             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 176             return
 177         if self.ver[0] < self.ver_expected[0]:
 178             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 179             return
 180         if self.ver[1] >= self.ver_expected[1]:
 181             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 182             return
 183         self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 184
 185     def table_print(self, _mode, with_results):
 186         ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 187         print('{:<91}'.format(ver_req), end='')
 188         if with_results:
 189             print('| {}'.format(self.result), end='')
 190
 191
 192 class ComplexOptCheck:
 193     def __init__(self, *opts):
 194         self.opts = opts
 195         assert(self.opts), \
 196                'empty {} check'.format(self.__class__.__name__)
 197         assert(len(self.opts) != 1), \
 198                 'useless {} check: {}'.format(self.__class__.__name__, opts)
 199         assert(isinstance(opts[0], (KconfigCheck, CmdlineCheck))), \
 200                'invalid {} check: {}'.format(self.__class__.__name__, opts)
 201         self.result = None
 202
 203     @property
 204     def type(self):
 205         return 'complex'
 206
 207     @property
 208     def name(self):
 209         return self.opts[0].name
 210
 211     @property
 212     def expected(self):
 213         return self.opts[0].expected
 214
 215     def table_print(self, mode, with_results):
 216         if mode == 'verbose':
 217             print('    {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
 218             if with_results:
 219                 print('| {}'.format(self.result), end='')
 220             for o in self.opts:
 221                 print()
 222                 o.table_print(mode, with_results)
 223         else:
 224             o = self.opts[0]
 225             o.table_print(mode, False)
 226             if with_results:
 227                 print('| {}'.format(self.result), end='')
 228
 229     def json_dump(self, with_results):
 230         dump = self.opts[0].json_dump(False)
 231         if with_results:
 232             dump.append(self.result)
 233         return dump
 234
 235
 236 class OR(ComplexOptCheck):
 237     # self.opts[0] is the option that this OR-check is about.
 238     # Use cases:
 239     #     OR(<X_is_hardened>, <X_is_disabled>)
 240     #     OR(<X_is_hardened>, <old_X_is_hardened>)
 241     def check(self):
 242         for i, opt in enumerate(self.opts):
 243             opt.check()
 244             if opt.result.startswith('OK'):
 245                 self.result = opt.result
 246                 # Add more info for additional checks:
 247                 if i != 0:
 248                     if opt.result == 'OK':
 249                         self.result = 'OK: {} is "{}"'.format(opt.name, opt.expected)
 250                     elif opt.result == 'OK: is not found':
 251                         self.result = 'OK: {} is not found'.format(opt.name)
 252                     elif opt.result == 'OK: is present':
 253                         self.result = 'OK: {} is present'.format(opt.name)
 254                     elif opt.result.startswith('OK: is not off'):
 255                         self.result = 'OK: {} is not off'.format(opt.name)
 256                     else:
 257                         # VersionCheck provides enough info
 258                         assert(opt.result.startswith('OK: version')), \
 259                                'unexpected OK description "{}"'.format(opt.result)
 260                 return
 261         self.result = self.opts[0].result
 262
 263
 264 class AND(ComplexOptCheck):
 265     # self.opts[0] is the option that this AND-check is about.
 266     # Use cases:
 267     #     AND(<suboption>, <main_option>)
 268     #       Suboption is not checked if checking of the main_option is failed.
 269     #     AND(<X_is_disabled>, <old_X_is_disabled>)
 270     def check(self):
 271         for i, opt in reversed(list(enumerate(self.opts))):
 272             opt.check()
 273             if i == 0:
 274                 self.result = opt.result
 275                 return
 276             if not opt.result.startswith('OK'):
 277                 # This FAIL is caused by additional checks,
 278                 # and not by the main option that this AND-check is about.
 279                 # Describe the reason of the FAIL.
 280                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: is not found':
 281                     self.result = 'FAIL: {} is not "{}"'.format(opt.name, opt.expected)
 282                 elif opt.result == 'FAIL: is not present':
 283                     self.result = 'FAIL: {} is not present'.format(opt.name)
 284                 elif opt.result == 'FAIL: is off':
 285                     self.result = 'FAIL: {} is off'.format(opt.name)
 286                 elif opt.result == 'FAIL: is off, not found':
 287                     self.result = 'FAIL: {} is off, not found'.format(opt.name)
 288                 else:
 289                     # VersionCheck provides enough info
 290                     self.result = opt.result
 291                     assert(opt.result.startswith('FAIL: version')), \
 292                            'unexpected FAIL description "{}"'.format(opt.result)
 293                 return
 294
 295
 296 def detect_arch(fname, archs):
 297     with open(fname, 'r') as f:
 298         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 299         arch = None
 300         for line in f.readlines():
 301             if arch_pattern.match(line):
 302                 option, _ = line[7:].split('=', 1)
 303                 if option in archs:
 304                     if not arch:
 305                         arch = option
 306                     else:
 307                         return None, 'more than one supported architecture is detected'
 308         if not arch:
 309             return None, 'failed to detect architecture'
 310         return arch, 'OK'
 311
 312
 313 def detect_kernel_version(fname):
 314     with open(fname, 'r') as f:
 315         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
 316         for line in f.readlines():
 317             if ver_pattern.match(line):
 318                 line = line.strip()
 319                 parts = line.split()
 320                 ver_str = parts[2]
 321                 ver_numbers = ver_str.split('.')
 322                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
 323                     msg = 'failed to parse the version "' + ver_str + '"'
 324                     return None, msg
 325                 return (int(ver_numbers[0]), int(ver_numbers[1])), None
 326         return None, 'no kernel version detected'
 327
 328
 329 def detect_compiler(fname):
 330     gcc_version = None
 331     clang_version = None
 332     with open(fname, 'r') as f:
 333         gcc_version_pattern = re.compile("CONFIG_GCC_VERSION=[0-9]*")
 334         clang_version_pattern = re.compile("CONFIG_CLANG_VERSION=[0-9]*")
 335         for line in f.readlines():
 336             if gcc_version_pattern.match(line):
 337                 gcc_version = line[19:-1]
 338             if clang_version_pattern.match(line):
 339                 clang_version = line[21:-1]
 340     if not gcc_version or not clang_version:
 341         return None, 'no CONFIG_GCC_VERSION or CONFIG_CLANG_VERSION'
 342     if gcc_version == '0' and clang_version != '0':
 343         return 'CLANG ' + clang_version, 'OK'
 344     if gcc_version != '0' and clang_version == '0':
 345         return 'GCC ' + gcc_version, 'OK'
 346     sys.exit('[!] ERROR: invalid GCC_VERSION and CLANG_VERSION: {} {}'.format(gcc_version, clang_version))
 347
 348
 349 def add_kconfig_checks(l, arch):
 350     # Calling the KconfigCheck class constructor:
 351     #     KconfigCheck(reason, decision, name, expected)
 352     #
 353     # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
 354     #     when the tool doesn't check the cmdline.
 355
 356     efi_not_set = KconfigCheck('-', '-', 'EFI', 'is not set')
 357     cc_is_gcc = KconfigCheck('-', '-', 'CC_IS_GCC', 'y') # exists since v4.18
 358     cc_is_clang = KconfigCheck('-', '-', 'CC_IS_CLANG', 'y') # exists since v4.18
 359
 360     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
 361     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
 362     bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
 363
 364     # 'self_protection', 'defconfig'
 365     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
 366     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
 367     l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
 368     gcc_plugins_support_is_set = KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')
 369     l += [gcc_plugins_support_is_set]
 370     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
 371     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
 372     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
 373              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'),
 374              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_REGULAR', 'y'),
 375              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_AUTO', 'y'),
 376              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 377     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
 378              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 379     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
 380              KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
 381     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
 382              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
 383              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
 384     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
 385              VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
 386     if arch in ('X86_64', 'ARM64', 'X86_32'):
 387         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
 388     if arch in ('X86_64', 'ARM64'):
 389         l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
 390     if arch in ('X86_64', 'X86_32'):
 391         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE', 'y')]
 392         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_INTEL', 'y')]
 393         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_AMD', 'y')]
 394         l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
 395         l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
 396         l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
 397         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y'),
 398                  VersionCheck((5, 19)))] # X86_SMAP is enabled by default since v5.19
 399         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
 400                  KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
 401     if arch in ('ARM64', 'ARM'):
 402         l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
 403     if arch == 'X86_64':
 404         l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
 405         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
 406         l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
 407                   iommu_support_is_set)]
 408         l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
 409                   iommu_support_is_set)]
 410     if arch == 'ARM64':
 411         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
 412         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
 413         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
 414         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_E0PD', 'y')]
 415         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
 416         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
 417         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
 418         l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
 419         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
 420         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
 421         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
 422                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
 423                      VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
 424         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
 425                  VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
 426     if arch == 'ARM':
 427         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
 428         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
 429         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
 430
 431     # 'self_protection', 'kspp'
 432     l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
 433     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
 434     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
 435     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
 436     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
 437     l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
 438     l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
 439     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
 440     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_VIRTUAL', 'y')]
 441     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
 442     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
 443     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
 444     l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
 445     l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
 446     l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
 447     l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
 448     l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
 449     l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
 450     l += [KconfigCheck('self_protection', 'kspp', 'HW_RANDOM_TPM', 'y')]
 451     l += [KconfigCheck('self_protection', 'kspp', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
 452     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
 453     randstruct_is_set = OR(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_FULL', 'y'),
 454                            KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y'))
 455     l += [randstruct_is_set]
 456     l += [AND(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_PERFORMANCE', 'is not set'),
 457               KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 458               randstruct_is_set)]
 459     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 460     l += [hardened_usercopy_is_set]
 461     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 462               hardened_usercopy_is_set)]
 463     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
 464               hardened_usercopy_is_set)]
 465     l += [AND(KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y'),
 466               gcc_plugins_support_is_set)]
 467     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 468              modules_not_set)]
 469     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 470              modules_not_set)]
 471     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 472              modules_not_set)]
 473     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 474              modules_not_set)] # refers to LOCKDOWN
 475     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
 476              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 477     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 478              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
 479              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
 480              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
 481              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
 482              # the 0xAA poison pattern on allocation.
 483              # That brings higher performance penalty.
 484     l += [OR(KconfigCheck('self_protection', 'kspp', 'EFI_DISABLE_PCI_DMA', 'y'),
 485              efi_not_set)]
 486     l += [OR(KconfigCheck('self_protection', 'kspp', 'RESET_ATTACK_MITIGATION', 'y'),
 487              efi_not_set)] # needs userspace support (systemd)
 488     ubsan_bounds_is_set = KconfigCheck('self_protection', 'kspp', 'UBSAN_BOUNDS', 'y')
 489     l += [ubsan_bounds_is_set]
 490     l += [OR(KconfigCheck('self_protection', 'kspp', 'UBSAN_LOCAL_BOUNDS', 'y'),
 491              AND(ubsan_bounds_is_set,
 492                  cc_is_gcc))]
 493     l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_TRAP', 'y'),
 494               ubsan_bounds_is_set,
 495               KconfigCheck('self_protection', 'kspp', 'UBSAN_SHIFT', 'is not set'),
 496               KconfigCheck('self_protection', 'kspp', 'UBSAN_DIV_ZERO', 'is not set'),
 497               KconfigCheck('self_protection', 'kspp', 'UBSAN_UNREACHABLE', 'is not set'),
 498               KconfigCheck('self_protection', 'kspp', 'UBSAN_BOOL', 'is not set'),
 499               KconfigCheck('self_protection', 'kspp', 'UBSAN_ENUM', 'is not set'),
 500               KconfigCheck('self_protection', 'kspp', 'UBSAN_ALIGNMENT', 'is not set'))] # only array index bounds checking with traps
 501     if arch in ('X86_64', 'ARM64', 'X86_32'):
 502         l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_SANITIZE_ALL', 'y'),
 503                   ubsan_bounds_is_set)] # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
 504         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 505         l += [AND(stackleak_is_set, gcc_plugins_support_is_set)]
 506         l += [AND(KconfigCheck('self_protection', 'kspp', 'STACKLEAK_METRICS', 'is not set'),
 507                   stackleak_is_set,
 508                   gcc_plugins_support_is_set)]
 509         l += [AND(KconfigCheck('self_protection', 'kspp', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 510                   stackleak_is_set,
 511                   gcc_plugins_support_is_set)]
 512         l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
 513     if arch in ('X86_64', 'ARM64'):
 514         cfi_clang_is_set = KconfigCheck('self_protection', 'kspp', 'CFI_CLANG', 'y')
 515         l += [cfi_clang_is_set]
 516         l += [AND(KconfigCheck('self_protection', 'kspp', 'CFI_PERMISSIVE', 'is not set'),
 517                   cfi_clang_is_set)]
 518     if arch in ('X86_64', 'X86_32'):
 519         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
 520         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 521                   iommu_support_is_set)]
 522     if arch in ('ARM64', 'ARM'):
 523         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
 524         l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
 525     if arch == 'X86_64':
 526         l += [KconfigCheck('self_protection', 'kspp', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
 527         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU_SVM', 'y'),
 528                   iommu_support_is_set)]
 529         l += [AND(KconfigCheck('self_protection', 'kspp', 'AMD_IOMMU_V2', 'y'),
 530                   iommu_support_is_set)]
 531     if arch == 'ARM64':
 532         l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
 533         l += [KconfigCheck('self_protection', 'kspp', 'SHADOW_CALL_STACK', 'y')]
 534         l += [KconfigCheck('self_protection', 'kspp', 'KASAN_HW_TAGS', 'y')]
 535     if arch == 'X86_32':
 536         l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
 537         l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
 538         l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
 539         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU', 'y'),
 540                   iommu_support_is_set)]
 541
 542     # 'self_protection', 'clipos'
 543     l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')]
 544
 545     # 'security_policy'
 546     if arch in ('X86_64', 'ARM64', 'X86_32'):
 547         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
 548     if arch == 'ARM':
 549         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
 550     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 551     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LANDLOCK', 'y')]
 552     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
 553     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_BOOTPARAM', 'is not set')]
 554     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DEVELOP', 'is not set')]
 555     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM', 'y')]
 556     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 557     l += [KconfigCheck('security_policy', 'kspp', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 558     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
 559
 560     # 'cut_attack_surface', 'defconfig'
 561     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 562     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 563     l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
 564              bpf_syscall_not_set)] # see unprivileged_bpf_disabled
 565     if arch in ('X86_64', 'ARM64', 'X86_32'):
 566         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 567                  devmem_not_set)] # refers to LOCKDOWN
 568
 569     # 'cut_attack_surface', 'kspp'
 570     l += [KconfigCheck('cut_attack_surface', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
 571     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 572     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 573     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 574     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 575     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 576     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 577     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 578     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 579     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 580     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 581     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 582     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 583     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 584     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 585     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 586     l += [modules_not_set]
 587     l += [devmem_not_set]
 588     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 589              devmem_not_set)] # refers to LOCKDOWN
 590     l += [AND(KconfigCheck('cut_attack_surface', 'kspp', 'LDISC_AUTOLOAD', 'is not set'),
 591               KconfigCheck('cut_attack_surface', 'kspp', 'LDISC_AUTOLOAD', 'is present'))]
 592     if arch == 'X86_64':
 593         l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 594     if arch == 'ARM':
 595         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 596                  devmem_not_set)] # refers to LOCKDOWN
 597
 598     # 'cut_attack_surface', 'grsec'
 599     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
 600     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
 601     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
 602     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
 603     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
 604     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
 605     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 606     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
 607     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
 608     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
 609     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
 610     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
 611     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
 612     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
 613     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
 614     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
 615     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
 616     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
 617     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 618     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 619     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 620     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
 621     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
 622     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
 623     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
 624     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
 625     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
 626     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
 627     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
 628     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
 629     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
 630     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
 631     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
 632     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
 633     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
 634     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
 635     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
 636     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
 637               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
 638
 639     # 'cut_attack_surface', 'maintainer'
 640     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
 641     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
 642     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
 643     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
 644     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
 645
 646     # 'cut_attack_surface', 'grapheneos'
 647     l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 648
 649     # 'cut_attack_surface', 'clipos'
 650     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 651     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 652     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 653     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 654     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 655     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 656     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 657     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 658     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 659     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 660     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 661     l += [KconfigCheck('cut_attack_surface', 'clipos', 'COREDUMP', 'is not set')] # cut userspace attack surface
 662 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 663     if arch in ('X86_64', 'X86_32'):
 664         l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 665
 666     # 'cut_attack_surface', 'lockdown'
 667     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 668     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 669     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 670     l += [bpf_syscall_not_set] # refers to LOCKDOWN
 671
 672     # 'cut_attack_surface', 'my'
 673     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 674     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 675     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 676     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 677     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 678     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 679     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 680     l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
 681     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
 682              modules_not_set)]
 683
 684     # 'harden_userspace'
 685     if arch in ('X86_64', 'ARM64', 'X86_32'):
 686         l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
 687     if arch == 'ARM':
 688         l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
 689     if arch == 'ARM64':
 690         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
 691         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_BTI', 'y')]
 692     if arch in ('ARM', 'X86_32'):
 693         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
 694     if arch in ('X86_64', 'ARM64'):
 695         l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
 696     if arch in ('X86_32', 'ARM'):
 697         l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
 698
 699
 700 def add_cmdline_checks(l, arch):
 701     # Calling the CmdlineCheck class constructor:
 702     #     CmdlineCheck(reason, decision, name, expected)
 703     #
 704     # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
 705     #     when the tool doesn't check the cmdline.
 706     #
 707     # [!] Make sure that values of the options in CmdlineChecks need normalization.
 708     #     For more info see normalize_cmdline_options().
 709     #
 710     # A common pattern for checking the 'param_x' cmdline parameter
 711     # that __overrides__ the 'PARAM_X_DEFAULT' kconfig option:
 712     #   l += [OR(CmdlineCheck(reason, decision, 'param_x', '1'),
 713     #            AND(KconfigCheck(reason, decision, 'PARAM_X_DEFAULT_ON', 'y'),
 714     #                CmdlineCheck(reason, decision, 'param_x, 'is not set')))]
 715     #
 716     # Here we don't check the kconfig options or minimal kernel version
 717     # required for the cmdline parameters. That would make the checks
 718     # very complex and not give a 100% guarantee anyway.
 719
 720     # 'self_protection', 'defconfig'
 721     l += [CmdlineCheck('self_protection', 'defconfig', 'nosmep', 'is not set')]
 722     l += [CmdlineCheck('self_protection', 'defconfig', 'nosmap', 'is not set')]
 723     l += [CmdlineCheck('self_protection', 'defconfig', 'nokaslr', 'is not set')]
 724     l += [CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set')]
 725     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v1', 'is not set')]
 726     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v2', 'is not set')]
 727     l += [CmdlineCheck('self_protection', 'defconfig', 'nospec_store_bypass_disable', 'is not set')]
 728     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nobti', 'is not set')]
 729     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nopauth', 'is not set')]
 730     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mitigations', 'is not off'),
 731              CmdlineCheck('self_protection', 'defconfig', 'mitigations', 'is not set'))]
 732     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not off'),
 733              CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not set'))]
 734     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not off'),
 735              CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not set'))]
 736     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not off'),
 737              CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not set'))]
 738     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not off'),
 739              CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not set'))]
 740     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not off'),
 741              CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not set'))]
 742     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not off'),
 743              CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not set'))]
 744     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not off'),
 745              CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not set'))]
 746     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not off'),
 747              CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not set'))]
 748     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not off'),
 749              CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not set'))]
 750     if arch == 'ARM64':
 751         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'kernel'),
 752                  CmdlineCheck('self_protection', 'my', 'ssbd', 'force-on'),
 753                  CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'is not set'))]
 754         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', 'full'),
 755                  AND(KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y'),
 756                      CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set')))]
 757     else:
 758         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', '1'),
 759                  CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set'))]
 760
 761     # 'self_protection', 'kspp'
 762     l += [CmdlineCheck('self_protection', 'kspp', 'nosmt', 'is present')]
 763     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
 764              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
 765                  CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
 766     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_free', '1'),
 767              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 768                  CmdlineCheck('self_protection', 'kspp', 'init_on_free', 'is not set')),
 769              AND(CmdlineCheck('self_protection', 'kspp', 'page_poison', '1'),
 770                  KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'),
 771                  CmdlineCheck('self_protection', 'kspp', 'slub_debug', 'P')))]
 772     l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_nomerge', 'is present'),
 773              AND(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
 774                  CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set')))]
 775     l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.strict', '1'),
 776              AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y'),
 777                  CmdlineCheck('self_protection', 'kspp', 'iommu.strict', 'is not set')))]
 778     l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', '0'),
 779              AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set'),
 780                  CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', 'is not set')))]
 781     # The cmdline checks compatible with the kconfig recommendations of the KSPP project...
 782     l += [OR(CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', '1'),
 783              AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y'),
 784                  CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', 'is not set')))]
 785     l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', '0'),
 786              AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 787                  CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', 'is not set')))]
 788     # ... the end
 789     if arch in ('X86_64', 'ARM64', 'X86_32'):
 790         l += [OR(CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'),
 791                  AND(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
 792                      CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', 'is not set')))]
 793     if arch in ('X86_64', 'X86_32'):
 794         l += [AND(CmdlineCheck('self_protection', 'kspp', 'pti', 'on'),
 795                   CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set'))]
 796
 797     # 'self_protection', 'clipos'
 798     l += [CmdlineCheck('self_protection', 'clipos', 'page_alloc.shuffle', '1')]
 799
 800     # 'cut_attack_surface', 'kspp'
 801     if arch == 'X86_64':
 802         l += [OR(CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'none'),
 803                  AND(KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'),
 804                      CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'is not set')))]
 805
 806     # 'cut_attack_surface', 'grsec'
 807     # The cmdline checks compatible with the kconfig options disabled by grsecurity...
 808     l += [OR(CmdlineCheck('cut_attack_surface', 'grsec', 'debugfs', 'off'),
 809              KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set'))] # ... the end
 810
 811     # 'cut_attack_surface', 'my'
 812     l += [CmdlineCheck('cut_attack_surface', 'my', 'sysrq_always_enabled', 'is not set')]
 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)