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