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