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