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 #    slab_nomerge
  15 #    page_alloc.shuffle=1
  16 #    iommu=force (does it help against DMA attacks?)
  17 #    iommu.passthrough=0
  18 #    iommu.strict=1
  19 #    slub_debug=FZ (slow)
  20 #    init_on_alloc=1 (since v5.3)
  21 #    init_on_free=1 (since v5.3, otherwise slub_debug=P and page_poison=1)
  22 #    loadpin.enforce=1
  23 #    debugfs=no-mount (or off if possible)
  24 #    randomize_kstack_offset=1
  25 #
  26 #    Mitigations of CPU vulnerabilities:
  27 #       Аrch-independent:
  28 #           mitigations=auto,nosmt (nosmt is slow)
  29 #       X86:
  30 #           spectre_v2=on
  31 #           pti=on
  32 #           spec_store_bypass_disable=on
  33 #           l1tf=full,force
  34 #           l1d_flush=on (a part of the l1tf option)
  35 #           mds=full,nosmt
  36 #           tsx=off
  37 #       ARM64:
  38 #           kpti=on
  39 #           ssbd=force-on
  40 #
  41 #    Should NOT be set:
  42 #           nokaslr
  43 #           arm64.nobti
  44 #           arm64.nopauth
  45 #
  46 #    Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
  47 #           kasan=on
  48 #           kasan.stacktrace=off
  49 #           kasan.fault=panic
  50 #
  51 # N.B. Hardening sysctls:
  52 #    kernel.kptr_restrict=2 (or 1?)
  53 #    kernel.dmesg_restrict=1 (also see the kconfig option)
  54 #    kernel.perf_event_paranoid=3
  55 #    kernel.kexec_load_disabled=1
  56 #    kernel.yama.ptrace_scope=3
  57 #    user.max_user_namespaces=0
  58 #    what about bpf_jit_enable?
  59 #    kernel.unprivileged_bpf_disabled=1
  60 #    net.core.bpf_jit_harden=2
  61 #
  62 #    vm.unprivileged_userfaultfd=0
  63 #        (at first, it disabled unprivileged userfaultfd,
  64 #         and since v5.11 it enables unprivileged userfaultfd for user-mode only)
  65 #
  66 #    dev.tty.ldisc_autoload=0
  67 #    fs.protected_symlinks=1
  68 #    fs.protected_hardlinks=1
  69 #    fs.protected_fifos=2
  70 #    fs.protected_regular=2
  71 #    fs.suid_dumpable=0
  72 #    kernel.modules_disabled=1
  73
  74
  75 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
  76 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
  77
  78
  79 import sys
  80 from argparse import ArgumentParser
  81 from collections import OrderedDict
  82 import re
  83 import json
  84 from .__about__ import __version__
  85
  86 TYPES_OF_CHECKS = ('kconfig', 'version')
  87
  88 class OptCheck:
  89     # Constructor without the 'expected' parameter is for option presence checks (any value is OK)
  90     def __init__(self, reason, decision, name, expected=None):
  91         if not reason or not decision or not name:
  92             sys.exit('[!] ERROR: invalid {} check for "{}"'.format(self.__class__.__name__, name))
  93         self.name = name
  94         self.expected = expected
  95         self.decision = decision
  96         self.reason = reason
  97         self.state = None
  98         self.result = None
  99
 100     def check(self):
 101         # handle the option presence check
 102         if self.expected is None:
 103             if self.state is None:
 104                 self.result = 'FAIL: not present'
 105             else:
 106                 self.result = 'OK: is present'
 107             return
 108
 109         # handle the option value check
 110         if self.expected == self.state:
 111             self.result = 'OK'
 112         elif self.state is None:
 113             if self.expected == 'is not set':
 114                 self.result = 'OK: not found'
 115             else:
 116                 self.result = 'FAIL: not found'
 117         else:
 118             self.result = 'FAIL: "' + self.state + '"'
 119
 120     def table_print(self, _mode, with_results):
 121         if self.expected is None:
 122             expected = ''
 123         else:
 124             expected = self.expected
 125         print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, expected, self.decision, self.reason), end='')
 126         if with_results:
 127             print('| {}'.format(self.result), end='')
 128
 129
 130 class KconfigCheck(OptCheck):
 131     def __init__(self, *args, **kwargs):
 132         super().__init__(*args, **kwargs)
 133         self.name = 'CONFIG_' + self.name
 134
 135     @property
 136     def type(self):
 137         return 'kconfig'
 138
 139     def json_dump(self, with_results):
 140         dump = [self.name, self.type, self.expected, self.decision, self.reason]
 141         if with_results:
 142             dump.append(self.result)
 143         return dump
 144
 145
 146 class VersionCheck:
 147     def __init__(self, ver_expected):
 148         self.ver_expected = ver_expected
 149         self.ver = ()
 150         self.result = None
 151
 152     @property
 153     def type(self):
 154         return 'version'
 155
 156     def check(self):
 157         if self.ver[0] > self.ver_expected[0]:
 158             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 159             return
 160         if self.ver[0] < self.ver_expected[0]:
 161             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 162             return
 163         if self.ver[1] >= self.ver_expected[1]:
 164             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 165             return
 166         self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 167
 168     def table_print(self, _mode, with_results):
 169         ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 170         print('{:<91}'.format(ver_req), end='')
 171         if with_results:
 172             print('| {}'.format(self.result), end='')
 173
 174
 175 class ComplexOptCheck:
 176     def __init__(self, *opts):
 177         self.opts = opts
 178         if not self.opts:
 179             sys.exit('[!] ERROR: empty {} check'.format(self.__class__.__name__))
 180         if len(self.opts) == 1:
 181             sys.exit('[!] ERROR: useless {} check'.format(self.__class__.__name__))
 182         if not isinstance(opts[0], KconfigCheck):
 183             sys.exit('[!] ERROR: invalid {} check: {}'.format(self.__class__.__name__, opts))
 184         self.result = None
 185
 186     @property
 187     def name(self):
 188         return self.opts[0].name
 189
 190     @property
 191     def type(self):
 192         return 'complex'
 193
 194     @property
 195     def expected(self):
 196         return self.opts[0].expected
 197
 198     @property
 199     def decision(self):
 200         return self.opts[0].decision
 201
 202     @property
 203     def reason(self):
 204         return self.opts[0].reason
 205
 206     def table_print(self, mode, with_results):
 207         if mode == 'verbose':
 208             print('    {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
 209             if with_results:
 210                 print('| {}'.format(self.result), end='')
 211             for o in self.opts:
 212                 print()
 213                 o.table_print(mode, with_results)
 214         else:
 215             o = self.opts[0]
 216             o.table_print(mode, False)
 217             if with_results:
 218                 print('| {}'.format(self.result), end='')
 219
 220     def json_dump(self, with_results):
 221         dump = self.opts[0].json_dump(False)
 222         if with_results:
 223             dump.append(self.result)
 224         return dump
 225
 226
 227 class OR(ComplexOptCheck):
 228     # self.opts[0] is the option that this OR-check is about.
 229     # Use cases:
 230     #     OR(<X_is_hardened>, <X_is_disabled>)
 231     #     OR(<X_is_hardened>, <old_X_is_hardened>)
 232     def check(self):
 233         if not self.opts:
 234             sys.exit('[!] ERROR: invalid OR check')
 235         for i, opt in enumerate(self.opts):
 236             opt.check()
 237             if opt.result.startswith('OK'):
 238                 self.result = opt.result
 239                 # Add more info for additional checks:
 240                 if i != 0:
 241                     if opt.result == 'OK':
 242                         self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
 243                     elif opt.result == 'OK: not found':
 244                         self.result = 'OK: {} not found'.format(opt.name)
 245                     elif opt.result == 'OK: is present':
 246                         self.result = 'OK: {} is present'.format(opt.name)
 247                     # VersionCheck provides enough info
 248                     elif not opt.result.startswith('OK: version'):
 249                         sys.exit('[!] ERROR: unexpected OK description "{}"'.format(opt.result))
 250                 return
 251         self.result = self.opts[0].result
 252
 253
 254 class AND(ComplexOptCheck):
 255     # self.opts[0] is the option that this AND-check is about.
 256     # Use cases:
 257     #     AND(<suboption>, <main_option>)
 258     #       Suboption is not checked if checking of the main_option is failed.
 259     #     AND(<X_is_disabled>, <old_X_is_disabled>)
 260     def check(self):
 261         for i, opt in reversed(list(enumerate(self.opts))):
 262             opt.check()
 263             if i == 0:
 264                 self.result = opt.result
 265                 return
 266             if not opt.result.startswith('OK'):
 267                 # This FAIL is caused by additional checks,
 268                 # and not by the main option that this AND-check is about.
 269                 # Describe the reason of the FAIL.
 270                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
 271                     self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
 272                 elif opt.result == 'FAIL: not present':
 273                     self.result = 'FAIL: {} not present'.format(opt.name)
 274                 else:
 275                     # VersionCheck provides enough info
 276                     self.result = opt.result
 277                     if not opt.result.startswith('FAIL: version'):
 278                         sys.exit('[!] ERROR: unexpected FAIL description "{}"'.format(opt.result))
 279                 return
 280         sys.exit('[!] ERROR: invalid AND check')
 281
 282
 283 def detect_arch(fname, archs):
 284     with open(fname, 'r') as f:
 285         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 286         arch = None
 287         for line in f.readlines():
 288             if arch_pattern.match(line):
 289                 option, _ = line[7:].split('=', 1)
 290                 if option in archs:
 291                     if not arch:
 292                         arch = option
 293                     else:
 294                         return None, 'more than one supported architecture is detected'
 295         if not arch:
 296             return None, 'failed to detect architecture'
 297         return arch, 'OK'
 298
 299
 300 def detect_version(fname):
 301     with open(fname, 'r') as f:
 302         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
 303         for line in f.readlines():
 304             if ver_pattern.match(line):
 305                 line = line.strip()
 306                 parts = line.split()
 307                 ver_str = parts[2]
 308                 ver_numbers = ver_str.split('.')
 309                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
 310                     msg = 'failed to parse the version "' + ver_str + '"'
 311                     return None, msg
 312                 return (int(ver_numbers[0]), int(ver_numbers[1])), None
 313         return None, 'no kernel version detected'
 314
 315
 316 def add_kconfig_checks(l, arch):
 317     # Calling the KconfigCheck class constructor:
 318     #     KconfigCheck(reason, decision, name, expected)
 319
 320     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
 321     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
 322     bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
 323     efi_not_set = KconfigCheck('cut_attack_surface', 'my', 'EFI', 'is not set')
 324
 325     # 'self_protection', 'defconfig'
 326     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
 327     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
 328     l += [KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
 329     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
 330              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 331     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
 332              KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
 333     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
 334              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
 335              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
 336     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
 337              VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
 338     l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
 339     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
 340     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
 341     if arch in ('X86_64', 'ARM64', 'X86_32'):
 342         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
 343     if arch in ('X86_64', 'ARM64'):
 344         l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
 345     if arch in ('X86_64', 'X86_32'):
 346         l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
 347         l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
 348         l += [KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
 349         l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
 350         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
 351                  KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
 352     if arch in ('ARM64', 'ARM'):
 353         l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
 354     if arch == 'X86_64':
 355         l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
 356         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
 357         l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
 358                   iommu_support_is_set)]
 359         l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
 360                   iommu_support_is_set)]
 361     if arch == 'ARM64':
 362         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
 363         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
 364         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
 365         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
 366                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
 367                      VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
 368         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
 369         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
 370         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
 371         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
 372                  VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
 373         l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
 374         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', '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     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         l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
 428     if arch in ('X86_64', 'X86_32'):
 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')] # slab_nomerge
 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 += [OR(KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
 496              KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
 497     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
 498     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 499     l += [KconfigCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 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 += [modules_not_set]
 531     l += [devmem_not_set]
 532     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 533              devmem_not_set)] # refers to LOCKDOWN
 534     if arch == 'ARM':
 535         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 536                  devmem_not_set)] # refers to LOCKDOWN
 537     if arch == 'X86_64':
 538         l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 539
 540     # 'cut_attack_surface', 'grsec'
 541     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
 542     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
 543     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
 544     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
 545     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
 546     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
 547     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 548     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
 549     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
 550     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
 551     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
 552     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
 553     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
 554     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
 555     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
 556     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
 557     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
 558     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
 559     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 560     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 561     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 562     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
 563     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
 564     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
 565     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
 566     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
 567     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
 568     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
 569     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
 570     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
 571     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
 572     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
 573     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
 574     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
 575     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
 576     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
 577     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
 578     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
 579               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
 580
 581     # 'cut_attack_surface', 'maintainer'
 582     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
 583     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
 584     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
 585     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
 586
 587     # 'cut_attack_surface', 'grapheneos'
 588     l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 589
 590     # 'cut_attack_surface', 'clipos'
 591     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 592     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 593 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 594     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 595     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 596     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 597     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 598     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 599     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 600     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 601     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 602     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 603     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 604     l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
 605               KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD'))] # option presence check
 606     if arch in ('X86_64', 'X86_32'):
 607         l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 608
 609     # 'cut_attack_surface', 'lockdown'
 610     l += [bpf_syscall_not_set] # refers to LOCKDOWN
 611     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 612     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 613     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 614
 615     # 'cut_attack_surface', 'my'
 616     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
 617              modules_not_set)]
 618     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 619     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 620     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 621     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 622     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 623     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 624     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 625
 626     # 'harden_userspace'
 627     if arch in ('X86_64', 'ARM64', 'X86_32'):
 628         l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
 629     if arch == 'ARM':
 630         l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
 631     if arch == 'ARM64':
 632         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_MTE', '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 print_unknown_options(checklist, parsed_options):
 644     known_options = []
 645
 646     for o1 in checklist:
 647         if o1.type != 'complex':
 648             known_options.append(o1.name)
 649             continue
 650         for o2 in o1.opts:
 651             if o2.type != 'complex':
 652                 if hasattr(o2, 'name'):
 653                     known_options.append(o2.name)
 654                 continue
 655             for o3 in o2.opts:
 656                 if o3.type == 'complex':
 657                     sys.exit('[!] ERROR: unexpected ComplexOptCheck inside {}'.format(o2.name))
 658                 if hasattr(o3, 'name'):
 659                     known_options.append(o3.name)
 660
 661     for option, value in parsed_options.items():
 662         if option not in known_options:
 663             print('[?] No check for option {} ({})'.format(option, value))
 664
 665
 666 def print_checklist(mode, checklist, with_results):
 667     if mode == 'json':
 668         output = []
 669         for o in checklist:
 670             output.append(o.json_dump(with_results))
 671         print(json.dumps(output))
 672         return
 673
 674     # table header
 675     sep_line_len = 91
 676     if with_results:
 677         sep_line_len += 30
 678     print('=' * sep_line_len)
 679     print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
 680     if with_results:
 681         print('| {}'.format('check result'), end='')
 682     print()
 683     print('=' * sep_line_len)
 684
 685     # table contents
 686     for opt in checklist:
 687         if with_results:
 688             if mode == 'show_ok':
 689                 if not opt.result.startswith('OK'):
 690                     continue
 691             if mode == 'show_fail':
 692                 if not opt.result.startswith('FAIL'):
 693                     continue
 694         opt.table_print(mode, with_results)
 695         print()
 696         if mode == 'verbose':
 697             print('-' * sep_line_len)
 698     print()
 699
 700     # final score
 701     if with_results:
 702         fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 703         fail_suppressed = ''
 704         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
 705         ok_suppressed = ''
 706         if mode == 'show_ok':
 707             fail_suppressed = ' (suppressed in output)'
 708         if mode == 'show_fail':
 709             ok_suppressed = ' (suppressed in output)'
 710         if mode != 'json':
 711             print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
 712
 713
 714 def populate_simple_opt_with_data(opt, data, data_type):
 715     if opt.type == 'complex':
 716         sys.exit('[!] ERROR: unexpected ComplexOptCheck {}: {}'.format(opt.name, vars(opt)))
 717     if data_type not in TYPES_OF_CHECKS:
 718         sys.exit('[!] ERROR: invalid data type "{}"'.format(data_type))
 719
 720     if data_type != opt.type:
 721         return
 722
 723     if data_type == 'kconfig':
 724         opt.state = data.get(opt.name, None)
 725     elif data_type == 'version':
 726         opt.ver = data
 727     else:
 728         sys.exit('[!] ERROR: unexpected data type "{}"'.format(data_type))
 729
 730
 731 def populate_opt_with_data(opt, data, data_type):
 732     if opt.type == 'complex':
 733         for o in opt.opts:
 734             if o.type == 'complex':
 735                 # Recursion for nested ComplexOptCheck objects
 736                 populate_opt_with_data(o, data, data_type)
 737             else:
 738                 populate_simple_opt_with_data(o, data, data_type)
 739     else:
 740         if opt.type != 'kconfig':
 741             sys.exit('[!] ERROR: bad type "{}" for a simple check {}'.format(opt.type, opt.name))
 742         populate_simple_opt_with_data(opt, data, data_type)
 743
 744
 745 def populate_with_data(checklist, data, data_type):
 746     for opt in checklist:
 747         populate_opt_with_data(opt, data, data_type)
 748
 749
 750 def perform_checks(checklist):
 751     for opt in checklist:
 752         opt.check()
 753
 754
 755 def parse_kconfig_file(parsed_options, fname):
 756     with open(fname, 'r') as f:
 757         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 758         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 759
 760         for line in f.readlines():
 761             line = line.strip()
 762             option = None
 763             value = None
 764
 765             if opt_is_on.match(line):
 766                 option, value = line.split('=', 1)
 767             elif opt_is_off.match(line):
 768                 option, value = line[2:].split(' ', 1)
 769                 if value != 'is not set':
 770                     sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
 771
 772             if option in parsed_options:
 773                 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
 774
 775             if option:
 776                 parsed_options[option] = value
 777
 778
 779 def main():
 780     # Report modes:
 781     #   * verbose mode for
 782     #     - reporting about unknown kernel options in the kconfig
 783     #     - verbose printing of ComplexOptCheck items
 784     #   * json mode for printing the results in JSON format
 785     report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
 786     supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
 787     parser = ArgumentParser(prog='kconfig-hardened-check',
 788                             description='A tool for checking the security hardening options of the Linux kernel')
 789     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
 790     parser.add_argument('-p', '--print', choices=supported_archs,
 791                         help='print security hardening preferences for the selected architecture')
 792     parser.add_argument('-c', '--config',
 793                         help='check the kernel kconfig file against these preferences')
 794     parser.add_argument('-m', '--mode', choices=report_modes,
 795                         help='choose the report mode')
 796     args = parser.parse_args()
 797
 798     mode = None
 799     if args.mode:
 800         mode = args.mode
 801         if mode != 'json':
 802             print('[+] Special report mode: {}'.format(mode))
 803
 804     config_checklist = []
 805
 806     if args.config:
 807         if mode != 'json':
 808             print('[+] Kconfig file to check: {}'.format(args.config))
 809
 810         arch, msg = detect_arch(args.config, supported_archs)
 811         if not arch:
 812             sys.exit('[!] ERROR: {}'.format(msg))
 813         if mode != 'json':
 814             print('[+] Detected architecture: {}'.format(arch))
 815
 816         kernel_version, msg = detect_version(args.config)
 817         if not kernel_version:
 818             sys.exit('[!] ERROR: {}'.format(msg))
 819         if mode != 'json':
 820             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
 821
 822         # add relevant kconfig checks to the checklist
 823         add_kconfig_checks(config_checklist, arch)
 824
 825         # populate the checklist with the parsed kconfig data
 826         parsed_kconfig_options = OrderedDict()
 827         parse_kconfig_file(parsed_kconfig_options, args.config)
 828         populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
 829         populate_with_data(config_checklist, kernel_version, 'version')
 830
 831         # now everything is ready for performing the checks
 832         perform_checks(config_checklist)
 833
 834         # finally print the results
 835         if mode == 'verbose':
 836             print_unknown_options(config_checklist, parsed_kconfig_options)
 837         print_checklist(mode, config_checklist, True)
 838
 839         sys.exit(0)
 840
 841     if args.print:
 842         if mode in ('show_ok', 'show_fail'):
 843             sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
 844         arch = args.print
 845         add_kconfig_checks(config_checklist, arch)
 846         if mode != 'json':
 847             print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
 848         print_checklist(mode, config_checklist, False)
 849         sys.exit(0)
 850
 851     parser.print_help()
 852     sys.exit(0)
 853
 854 if __name__ == '__main__':
 855     main()