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