kconfig_hardened_check/__init__.py

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