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