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