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