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