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