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