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     def __init__(self, reason, decision, name, expected):
  90         self.name = name
  91         self.expected = expected
  92         self.decision = decision
  93         self.reason = reason
  94         self.state = None
  95         self.result = None
  96
  97     def check(self):
  98         if self.expected == self.state:
  99             self.result = 'OK'
 100         elif self.state is None:
 101             if self.expected == 'is not set':
 102                 self.result = 'OK: not found'
 103             else:
 104                 self.result = 'FAIL: not found'
 105         else:
 106             self.result = 'FAIL: "' + self.state + '"'
 107
 108     def table_print(self, _mode, with_results):
 109         print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, self.expected, self.decision, self.reason), end='')
 110         if with_results:
 111             print('| {}'.format(self.result), end='')
 112
 113
 114 class KconfigCheck(OptCheck):
 115     def __init__(self, *args, **kwargs):
 116         super().__init__(*args, **kwargs)
 117         self.name = 'CONFIG_' + self.name
 118
 119     @property
 120     def type(self):
 121         return 'kconfig'
 122
 123     def json_dump(self, with_results):
 124         dump = [self.name, self.type, self.expected, self.decision, self.reason]
 125         if with_results:
 126             dump.append(self.result)
 127         return dump
 128
 129
 130 class VersionCheck:
 131     def __init__(self, ver_expected):
 132         self.ver_expected = ver_expected
 133         self.ver = ()
 134         self.result = None
 135
 136     @property
 137     def type(self):
 138         return 'version'
 139
 140     def check(self):
 141         if self.ver[0] > self.ver_expected[0]:
 142             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 143             return
 144         if self.ver[0] < self.ver_expected[0]:
 145             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 146             return
 147         if self.ver[1] >= self.ver_expected[1]:
 148             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 149             return
 150         self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 151
 152     def table_print(self, _mode, with_results):
 153         ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 154         print('{:<91}'.format(ver_req), end='')
 155         if with_results:
 156             print('| {}'.format(self.result), end='')
 157
 158
 159 class PresenceCheck:
 160     def __init__(self, name, type):
 161         self.type = type
 162         if self.type == 'kconfig':
 163             self.name = 'CONFIG_' + name
 164         else:
 165             sys.exit('[!] ERROR: unsupported type "{}" for {}'.format(type, self.__class__.__name__))
 166         self.state = None
 167         self.result = None
 168
 169     def check(self):
 170         if self.state is None:
 171             self.result = 'FAIL: not present'
 172             return
 173         self.result = 'OK: is present'
 174
 175     def table_print(self, _mode, with_results):
 176         print('{:<91}'.format(self.name + ' is present'), end='')
 177         if with_results:
 178             print('| {}'.format(self.result), end='')
 179
 180
 181 class ComplexOptCheck:
 182     def __init__(self, *opts):
 183         self.opts = opts
 184         if not self.opts:
 185             sys.exit('[!] ERROR: empty {} check'.format(self.__class__.__name__))
 186         if len(self.opts) == 1:
 187             sys.exit('[!] ERROR: useless {} check'.format(self.__class__.__name__))
 188         if not isinstance(opts[0], KconfigCheck):
 189             sys.exit('[!] ERROR: invalid {} check: {}'.format(self.__class__.__name__, opts))
 190         self.result = None
 191
 192     @property
 193     def name(self):
 194         return self.opts[0].name
 195
 196     @property
 197     def type(self):
 198         return 'complex'
 199
 200     @property
 201     def expected(self):
 202         return self.opts[0].expected
 203
 204     @property
 205     def decision(self):
 206         return self.opts[0].decision
 207
 208     @property
 209     def reason(self):
 210         return self.opts[0].reason
 211
 212     def table_print(self, mode, with_results):
 213         if mode == 'verbose':
 214             print('    {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
 215             if with_results:
 216                 print('| {}'.format(self.result), end='')
 217             for o in self.opts:
 218                 print()
 219                 o.table_print(mode, with_results)
 220         else:
 221             o = self.opts[0]
 222             o.table_print(mode, False)
 223             if with_results:
 224                 print('| {}'.format(self.result), end='')
 225
 226     def json_dump(self, with_results):
 227         dump = self.opts[0].json_dump(False)
 228         if with_results:
 229             dump.append(self.result)
 230         return dump
 231
 232
 233 class OR(ComplexOptCheck):
 234     # self.opts[0] is the option that this OR-check is about.
 235     # Use cases:
 236     #     OR(<X_is_hardened>, <X_is_disabled>)
 237     #     OR(<X_is_hardened>, <old_X_is_hardened>)
 238     def check(self):
 239         if not self.opts:
 240             sys.exit('[!] ERROR: invalid OR check')
 241         for i, opt in enumerate(self.opts):
 242             opt.check()
 243             if opt.result.startswith('OK'):
 244                 if opt.result == 'OK' and i != 0:
 245                     # Simple OK is not enough for additional checks, add more info:
 246                     self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
 247                 else:
 248                     self.result = opt.result
 249                 return
 250         self.result = self.opts[0].result
 251
 252
 253 class AND(ComplexOptCheck):
 254     # self.opts[0] is the option that this AND-check is about.
 255     # Use cases:
 256     #     AND(<suboption>, <main_option>)
 257     #       Suboption is not checked if checking of the main_option is failed.
 258     #     AND(<X_is_disabled>, <old_X_is_disabled>)
 259     def check(self):
 260         for i, opt in reversed(list(enumerate(self.opts))):
 261             opt.check()
 262             if i == 0:
 263                 self.result = opt.result
 264                 return
 265             if not opt.result.startswith('OK'):
 266                 # This FAIL is caused by additional checks,
 267                 # and not by the main option that this AND-check is about.
 268                 # Describe the reason of the FAIL.
 269                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
 270                     self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
 271                 elif opt.result == 'FAIL: not present':
 272                     self.result = 'FAIL: {} not present'.format(opt.name)
 273                 else:
 274                     # This FAIL message is self-explaining.
 275                     self.result = opt.result
 276                 return
 277         sys.exit('[!] ERROR: invalid AND check')
 278
 279
 280 def detect_arch(fname, archs):
 281     with open(fname, 'r') as f:
 282         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 283         arch = None
 284         for line in f.readlines():
 285             if arch_pattern.match(line):
 286                 option, _ = line[7:].split('=', 1)
 287                 if option in archs:
 288                     if not arch:
 289                         arch = option
 290                     else:
 291                         return None, 'more than one supported architecture is detected'
 292         if not arch:
 293             return None, 'failed to detect architecture'
 294         return arch, 'OK'
 295
 296
 297 def detect_version(fname):
 298     with open(fname, 'r') as f:
 299         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
 300         for line in f.readlines():
 301             if ver_pattern.match(line):
 302                 line = line.strip()
 303                 parts = line.split()
 304                 ver_str = parts[2]
 305                 ver_numbers = ver_str.split('.')
 306                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
 307                     msg = 'failed to parse the version "' + ver_str + '"'
 308                     return None, msg
 309                 return (int(ver_numbers[0]), int(ver_numbers[1])), None
 310         return None, 'no kernel version detected'
 311
 312
 313 def add_kconfig_checks(l, arch):
 314     # Calling the KconfigCheck class constructor:
 315     #     KconfigCheck(reason, decision, name, expected)
 316
 317     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
 318     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
 319     bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
 320     efi_not_set = KconfigCheck('cut_attack_surface', 'my', 'EFI', 'is not set')
 321
 322     # 'self_protection', 'defconfig'
 323     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
 324     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
 325     l += [KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', '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     if arch == 'ARM':
 373         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
 374         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
 375         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
 376
 377     # 'self_protection', 'kspp'
 378     l += [KconfigCheck('self_protection', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
 379     l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
 380     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
 381     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
 382     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
 383     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
 384     l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
 385     l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
 386     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
 387     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
 388     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
 389     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
 390     l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
 391     l += [KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
 392     l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
 393     l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
 394     l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
 395     randstruct_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
 396     l += [randstruct_is_set]
 397     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 398     l += [hardened_usercopy_is_set]
 399     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 400               hardened_usercopy_is_set)]
 401     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
 402               hardened_usercopy_is_set)]
 403     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 404              modules_not_set)]
 405     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 406              modules_not_set)]
 407     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 408              modules_not_set)]
 409     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 410              modules_not_set)] # refers to LOCKDOWN
 411     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
 412              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 413     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 414              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
 415              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
 416              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
 417              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
 418              # the 0xAA poison pattern on allocation.
 419              # That brings higher performance penalty.
 420     if arch in ('X86_64', 'ARM64', 'X86_32'):
 421         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 422         l += [stackleak_is_set]
 423         l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
 424     if arch in ('X86_64', 'X86_32'):
 425         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
 426     if arch in ('ARM64', 'ARM'):
 427         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
 428         l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
 429     if arch == 'ARM64':
 430         l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
 431     if arch == 'X86_32':
 432         l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
 433         l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
 434         l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
 435
 436     # 'self_protection', 'maintainer'
 437     ubsan_bounds_is_set = KconfigCheck('self_protection', 'maintainer', 'UBSAN_BOUNDS', 'y') # only array index bounds checking
 438     l += [ubsan_bounds_is_set] # recommended by Kees Cook in /issues/53
 439     if arch in ('X86_64', 'ARM64', 'X86_32'):  # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
 440         l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_SANITIZE_ALL', 'y'),
 441                   ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
 442     l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_TRAP', 'y'),
 443               ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
 444
 445     # 'self_protection', 'clipos'
 446     l += [KconfigCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
 447     l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
 448     l += [OR(KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y'),
 449              efi_not_set)]
 450     l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')] # slab_nomerge
 451     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
 452     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
 453     l += [AND(KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 454               randstruct_is_set)]
 455     if arch in ('X86_64', 'ARM64', 'X86_32'):
 456         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
 457                   stackleak_is_set)]
 458         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 459                   stackleak_is_set)]
 460     if arch in ('X86_64', 'X86_32'):
 461         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 462                   iommu_support_is_set)]
 463     if arch == 'X86_64':
 464         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
 465                   iommu_support_is_set)]
 466     if arch == 'X86_32':
 467         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
 468                   iommu_support_is_set)]
 469
 470     # 'self_protection', 'my'
 471     l += [OR(KconfigCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y'),
 472              efi_not_set)] # needs userspace support (systemd)
 473     if arch == 'X86_64':
 474         l += [KconfigCheck('self_protection', 'my', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
 475         l += [AND(KconfigCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
 476                   iommu_support_is_set)]
 477     if arch == 'ARM64':
 478         l += [KconfigCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
 479         l += [KconfigCheck('self_protection', 'my', 'KASAN_HW_TAGS', 'y')]
 480         cfi_clang_is_set = KconfigCheck('self_protection', 'my', 'CFI_CLANG', 'y')
 481         l += [cfi_clang_is_set]
 482         l += [AND(KconfigCheck('self_protection', 'my', 'CFI_PERMISSIVE', 'is not set'),
 483                   cfi_clang_is_set)]
 484
 485     # 'security_policy'
 486     if arch in ('X86_64', 'ARM64', 'X86_32'):
 487         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
 488     if arch == 'ARM':
 489         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
 490     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 491     l += [OR(KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
 492              KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
 493     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
 494     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 495     l += [KconfigCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 496     l += [KconfigCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
 497     loadpin_is_set = KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
 498     l += [loadpin_is_set] # needs userspace support
 499     l += [AND(KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
 500               loadpin_is_set)]
 501
 502     # 'cut_attack_surface', 'defconfig'
 503     l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
 504              bpf_syscall_not_set)] # see unprivileged_bpf_disabled
 505     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 506     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 507     if arch in ('X86_64', 'ARM64', 'X86_32'):
 508         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 509                  devmem_not_set)] # refers to LOCKDOWN
 510
 511     # 'cut_attack_surface', 'kspp'
 512     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 513     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 514     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 515     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 516     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 517     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 518     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 519     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 520     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 521     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 522     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 523     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 524     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 525     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 526     l += [modules_not_set]
 527     l += [devmem_not_set]
 528     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 529              devmem_not_set)] # refers to LOCKDOWN
 530     if arch == 'ARM':
 531         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 532                  devmem_not_set)] # refers to LOCKDOWN
 533     if arch == 'X86_64':
 534         l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 535
 536     # 'cut_attack_surface', 'grsec'
 537     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
 538     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
 539     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
 540     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
 541     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
 542     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
 543     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 544     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
 545     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
 546     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
 547     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
 548     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
 549     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
 550     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
 551     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
 552     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
 553     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
 554     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
 555     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 556     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 557     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 558     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
 559     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
 560     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
 561     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
 562     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
 563     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
 564     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
 565     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
 566     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
 567     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
 568     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
 569     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
 570     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
 571     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
 572     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
 573     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
 574     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
 575               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
 576
 577     # 'cut_attack_surface', 'maintainer'
 578     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
 579     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
 580     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
 581     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
 582
 583     # 'cut_attack_surface', 'grapheneos'
 584     l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 585
 586     # 'cut_attack_surface', 'clipos'
 587     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 588     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 589 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 590     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 591     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 592     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 593     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 594     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 595     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 596     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 597     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 598     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 599     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 600     l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
 601               PresenceCheck('LDISC_AUTOLOAD', 'kconfig'))]
 602     if arch in ('X86_64', 'X86_32'):
 603         l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 604
 605     # 'cut_attack_surface', 'lockdown'
 606     l += [bpf_syscall_not_set] # refers to LOCKDOWN
 607     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 608     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 609     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 610
 611     # 'cut_attack_surface', 'my'
 612     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
 613              modules_not_set)]
 614     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 615     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 616     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 617     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 618     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 619     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 620     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 621
 622     # 'harden_userspace'
 623     if arch in ('X86_64', 'ARM64', 'X86_32'):
 624         l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
 625     if arch == 'ARM':
 626         l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
 627     if arch == 'ARM64':
 628         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_MTE', 'y')]
 629     if arch in ('ARM', 'X86_32'):
 630         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
 631     if arch in ('X86_64', 'ARM64'):
 632         l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
 633     if arch in ('X86_32', 'ARM'):
 634         l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
 635
 636 #   l += [KconfigCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
 637
 638
 639 def print_unknown_options(checklist, parsed_options):
 640     known_options = []
 641
 642     for o1 in checklist:
 643         if o1.type != 'complex':
 644             known_options.append(o1.name)
 645             continue
 646         for o2 in o1.opts:
 647             if o2.type != 'complex':
 648                 if hasattr(o2, 'name'):
 649                     known_options.append(o2.name)
 650                 continue
 651             for o3 in o2.opts:
 652                 if o3.type == 'complex':
 653                     sys.exit('[!] ERROR: unexpected ComplexOptCheck inside {}'.format(o2.name))
 654                 if hasattr(o3, 'name'):
 655                     known_options.append(o3.name)
 656
 657     for option, value in parsed_options.items():
 658         if option not in known_options:
 659             print('[?] No check for option {} ({})'.format(option, value))
 660
 661
 662 def print_checklist(mode, checklist, with_results):
 663     if mode == 'json':
 664         output = []
 665         for o in checklist:
 666             output.append(o.json_dump(with_results))
 667         print(json.dumps(output))
 668         return
 669
 670     # table header
 671     sep_line_len = 91
 672     if with_results:
 673         sep_line_len += 30
 674     print('=' * sep_line_len)
 675     print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
 676     if with_results:
 677         print('| {}'.format('check result'), end='')
 678     print()
 679     print('=' * sep_line_len)
 680
 681     # table contents
 682     for opt in checklist:
 683         if with_results:
 684             if mode == 'show_ok':
 685                 if not opt.result.startswith('OK'):
 686                     continue
 687             if mode == 'show_fail':
 688                 if not opt.result.startswith('FAIL'):
 689                     continue
 690         opt.table_print(mode, with_results)
 691         print()
 692         if mode == 'verbose':
 693             print('-' * sep_line_len)
 694     print()
 695
 696     # final score
 697     if with_results:
 698         fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 699         fail_suppressed = ''
 700         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
 701         ok_suppressed = ''
 702         if mode == 'show_ok':
 703             fail_suppressed = ' (suppressed in output)'
 704         if mode == 'show_fail':
 705             ok_suppressed = ' (suppressed in output)'
 706         if mode != 'json':
 707             print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
 708
 709
 710 def populate_simple_opt_with_data(opt, data, data_type):
 711     if opt.type == 'complex':
 712         sys.exit('[!] ERROR: unexpected ComplexOptCheck {}: {}'.format(opt.name, vars(opt)))
 713     if data_type not in TYPES_OF_CHECKS:
 714         sys.exit('[!] ERROR: invalid data type "{}"'.format(data_type))
 715
 716     if data_type != opt.type:
 717         return
 718
 719     if data_type == 'kconfig':
 720         opt.state = data.get(opt.name, None)
 721     elif data_type == 'version':
 722         opt.ver = data
 723
 724
 725 def populate_opt_with_data(opt, data, data_type):
 726     if opt.type == 'complex':
 727         for o in opt.opts:
 728             if o.type == 'complex':
 729                 # Recursion for nested ComplexOptCheck objects
 730                 populate_opt_with_data(o, data, data_type)
 731             else:
 732                 populate_simple_opt_with_data(o, data, data_type)
 733     else:
 734         if opt.type != 'kconfig':
 735             sys.exit('[!] ERROR: bad type "{}" for a simple check {}'.format(opt.type, opt.name))
 736         populate_simple_opt_with_data(opt, data, data_type)
 737
 738
 739 def populate_with_data(checklist, data, data_type):
 740     for opt in checklist:
 741         populate_opt_with_data(opt, data, data_type)
 742
 743
 744 def perform_checks(checklist):
 745     for opt in checklist:
 746         opt.check()
 747
 748
 749 def parse_kconfig_file(parsed_options, fname):
 750     with open(fname, 'r') as f:
 751         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 752         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 753
 754         for line in f.readlines():
 755             line = line.strip()
 756             option = None
 757             value = None
 758
 759             if opt_is_on.match(line):
 760                 option, value = line.split('=', 1)
 761             elif opt_is_off.match(line):
 762                 option, value = line[2:].split(' ', 1)
 763                 if value != 'is not set':
 764                     sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
 765
 766             if option in parsed_options:
 767                 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
 768
 769             if option:
 770                 parsed_options[option] = value
 771
 772
 773 def main():
 774     # Report modes:
 775     #   * verbose mode for
 776     #     - reporting about unknown kernel options in the kconfig
 777     #     - verbose printing of ComplexOptCheck items
 778     #   * json mode for printing the results in JSON format
 779     report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
 780     supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
 781     parser = ArgumentParser(prog='kconfig-hardened-check',
 782                             description='A tool for checking the security hardening options of the Linux kernel')
 783     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
 784     parser.add_argument('-p', '--print', choices=supported_archs,
 785                         help='print security hardening preferences for the selected architecture')
 786     parser.add_argument('-c', '--config',
 787                         help='check the kernel kconfig file against these preferences')
 788     parser.add_argument('-m', '--mode', choices=report_modes,
 789                         help='choose the report mode')
 790     args = parser.parse_args()
 791
 792     mode = None
 793     if args.mode:
 794         mode = args.mode
 795         if mode != 'json':
 796             print('[+] Special report mode: {}'.format(mode))
 797
 798     config_checklist = []
 799
 800     if args.config:
 801         if mode != 'json':
 802             print('[+] Kconfig file to check: {}'.format(args.config))
 803
 804         arch, msg = detect_arch(args.config, supported_archs)
 805         if not arch:
 806             sys.exit('[!] ERROR: {}'.format(msg))
 807         if mode != 'json':
 808             print('[+] Detected architecture: {}'.format(arch))
 809
 810         kernel_version, msg = detect_version(args.config)
 811         if not kernel_version:
 812             sys.exit('[!] ERROR: {}'.format(msg))
 813         if mode != 'json':
 814             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
 815
 816         # add relevant kconfig checks to the checklist
 817         add_kconfig_checks(config_checklist, arch)
 818
 819         # populate the checklist with the parsed kconfig data
 820         parsed_kconfig_options = OrderedDict()
 821         parse_kconfig_file(parsed_kconfig_options, args.config)
 822         populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
 823         populate_with_data(config_checklist, kernel_version, 'version')
 824
 825         # now everything is ready for performing the checks
 826         perform_checks(config_checklist)
 827
 828         # finally print the results
 829         if mode == 'verbose':
 830             print_unknown_options(config_checklist, parsed_kconfig_options)
 831         print_checklist(mode, config_checklist, True)
 832
 833         sys.exit(0)
 834
 835     if args.print:
 836         if mode in ('show_ok', 'show_fail'):
 837             sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
 838         arch = args.print
 839         add_kconfig_checks(config_checklist, arch)
 840         if mode != 'json':
 841             print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
 842         print_checklist(mode, config_checklist, False)
 843         sys.exit(0)
 844
 845     parser.print_help()
 846     sys.exit(0)
 847
 848 if __name__ == '__main__':
 849     main()