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