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 #    page_alloc.shuffle=1
  15 #    iommu=force (does it help against DMA attacks?)
  16 #    iommu.passthrough=0
  17 #    iommu.strict=1
  18 #    slub_debug=FZ (slow)
  19 #    init_on_alloc=1 (since v5.3)
  20 #    init_on_free=1 (since v5.3, otherwise slub_debug=P and page_poison=1)
  21 #    loadpin.enforce=1
  22 #    debugfs=no-mount (or off if possible)
  23 #
  24 #    Mitigations of CPU vulnerabilities:
  25 #       Аrch-independent:
  26 #           mitigations=auto,nosmt (nosmt is slow)
  27 #       X86:
  28 #           spectre_v2=on
  29 #           pti=on
  30 #           spec_store_bypass_disable=on
  31 #           l1tf=full,force
  32 #           l1d_flush=on (a part of the l1tf option)
  33 #           mds=full,nosmt
  34 #           tsx=off
  35 #       ARM64:
  36 #           kpti=on
  37 #           ssbd=force-on
  38 #
  39 #    Should NOT be set:
  40 #           slab_merge
  41 #           nokaslr
  42 #           rodata=off
  43 #           sysrq_always_enabled
  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 SIMPLE_OPTION_TYPES = ('kconfig', 'version', 'cmdline')
  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     def json_dump(self, with_results):
 135         dump = [self.name, self.type, self.expected, self.decision, self.reason]
 136         if with_results:
 137             dump.append(self.result)
 138         return dump
 139
 140
 141 class KconfigCheck(OptCheck):
 142     def __init__(self, *args, **kwargs):
 143         super().__init__(*args, **kwargs)
 144         self.name = 'CONFIG_' + self.name
 145
 146     @property
 147     def type(self):
 148         return 'kconfig'
 149
 150
 151 class CmdlineCheck(OptCheck):
 152     @property
 153     def type(self):
 154         return 'cmdline'
 155
 156
 157 class VersionCheck:
 158     def __init__(self, ver_expected):
 159         self.ver_expected = ver_expected
 160         self.ver = ()
 161         self.result = None
 162
 163     @property
 164     def type(self):
 165         return 'version'
 166
 167     def check(self):
 168         if self.ver[0] > self.ver_expected[0]:
 169             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 170             return
 171         if self.ver[0] < self.ver_expected[0]:
 172             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 173             return
 174         if self.ver[1] >= self.ver_expected[1]:
 175             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 176             return
 177         self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 178
 179     def table_print(self, _mode, with_results):
 180         ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 181         print('{:<91}'.format(ver_req), end='')
 182         if with_results:
 183             print('| {}'.format(self.result), end='')
 184
 185
 186 class ComplexOptCheck:
 187     def __init__(self, *opts):
 188         self.opts = opts
 189         if not self.opts:
 190             sys.exit('[!] ERROR: empty {} check'.format(self.__class__.__name__))
 191         if len(self.opts) == 1:
 192             sys.exit('[!] ERROR: useless {} check'.format(self.__class__.__name__))
 193         if not isinstance(opts[0], KconfigCheck) and not isinstance(opts[0], CmdlineCheck):
 194             sys.exit('[!] ERROR: invalid {} check: {}'.format(self.__class__.__name__, opts))
 195         self.result = None
 196
 197     @property
 198     def name(self):
 199         return self.opts[0].name
 200
 201     @property
 202     def type(self):
 203         return 'complex'
 204
 205     @property
 206     def expected(self):
 207         return self.opts[0].expected
 208
 209     @property
 210     def decision(self):
 211         return self.opts[0].decision
 212
 213     @property
 214     def reason(self):
 215         return self.opts[0].reason
 216
 217     def table_print(self, mode, with_results):
 218         if mode == 'verbose':
 219             print('    {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
 220             if with_results:
 221                 print('| {}'.format(self.result), end='')
 222             for o in self.opts:
 223                 print()
 224                 o.table_print(mode, with_results)
 225         else:
 226             o = self.opts[0]
 227             o.table_print(mode, False)
 228             if with_results:
 229                 print('| {}'.format(self.result), end='')
 230
 231     def json_dump(self, with_results):
 232         dump = self.opts[0].json_dump(False)
 233         if with_results:
 234             dump.append(self.result)
 235         return dump
 236
 237
 238 class OR(ComplexOptCheck):
 239     # self.opts[0] is the option that this OR-check is about.
 240     # Use cases:
 241     #     OR(<X_is_hardened>, <X_is_disabled>)
 242     #     OR(<X_is_hardened>, <old_X_is_hardened>)
 243     def check(self):
 244         if not self.opts:
 245             sys.exit('[!] ERROR: invalid OR check')
 246         for i, opt in enumerate(self.opts):
 247             opt.check()
 248             if opt.result.startswith('OK'):
 249                 self.result = opt.result
 250                 # Add more info for additional checks:
 251                 if i != 0:
 252                     if opt.result == 'OK':
 253                         self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
 254                     elif opt.result == 'OK: not found':
 255                         self.result = 'OK: {} not found'.format(opt.name)
 256                     elif opt.result == 'OK: is present':
 257                         self.result = 'OK: {} is present'.format(opt.name)
 258                     # VersionCheck provides enough info
 259                     elif not opt.result.startswith('OK: version'):
 260                         sys.exit('[!] ERROR: unexpected OK description "{}"'.format(opt.result))
 261                 return
 262         self.result = self.opts[0].result
 263
 264
 265 class AND(ComplexOptCheck):
 266     # self.opts[0] is the option that this AND-check is about.
 267     # Use cases:
 268     #     AND(<suboption>, <main_option>)
 269     #       Suboption is not checked if checking of the main_option is failed.
 270     #     AND(<X_is_disabled>, <old_X_is_disabled>)
 271     def check(self):
 272         for i, opt in reversed(list(enumerate(self.opts))):
 273             opt.check()
 274             if i == 0:
 275                 self.result = opt.result
 276                 return
 277             if not opt.result.startswith('OK'):
 278                 # This FAIL is caused by additional checks,
 279                 # and not by the main option that this AND-check is about.
 280                 # Describe the reason of the FAIL.
 281                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
 282                     self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
 283                 elif opt.result == 'FAIL: not present':
 284                     self.result = 'FAIL: {} not present'.format(opt.name)
 285                 else:
 286                     # VersionCheck provides enough info
 287                     self.result = opt.result
 288                     if not opt.result.startswith('FAIL: version'):
 289                         sys.exit('[!] ERROR: unexpected FAIL description "{}"'.format(opt.result))
 290                 return
 291         sys.exit('[!] ERROR: invalid AND check')
 292
 293
 294 def detect_arch(fname, archs):
 295     with open(fname, 'r') as f:
 296         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 297         arch = None
 298         for line in f.readlines():
 299             if arch_pattern.match(line):
 300                 option, _ = line[7:].split('=', 1)
 301                 if option in archs:
 302                     if not arch:
 303                         arch = option
 304                     else:
 305                         return None, 'more than one supported architecture is detected'
 306         if not arch:
 307             return None, 'failed to detect architecture'
 308         return arch, 'OK'
 309
 310
 311 def detect_version(fname):
 312     with open(fname, 'r') as f:
 313         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
 314         for line in f.readlines():
 315             if ver_pattern.match(line):
 316                 line = line.strip()
 317                 parts = line.split()
 318                 ver_str = parts[2]
 319                 ver_numbers = ver_str.split('.')
 320                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
 321                     msg = 'failed to parse the version "' + ver_str + '"'
 322                     return None, msg
 323                 return (int(ver_numbers[0]), int(ver_numbers[1])), None
 324         return None, 'no kernel version detected'
 325
 326
 327 def add_kconfig_checks(l, arch):
 328     # Calling the KconfigCheck class constructor:
 329     #     KconfigCheck(reason, decision, name, expected)
 330
 331     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
 332     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
 333     bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
 334     efi_not_set = KconfigCheck('cut_attack_surface', 'my', 'EFI', 'is not set')
 335
 336     # 'self_protection', 'defconfig'
 337     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
 338     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
 339     l += [KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
 340     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
 341              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'))]
 342     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
 343              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 344     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
 345              KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
 346     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
 347              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
 348              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
 349     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
 350              VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
 351     l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
 352     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
 353     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
 354     if arch in ('X86_64', 'ARM64', 'X86_32'):
 355         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
 356     if arch in ('X86_64', 'ARM64'):
 357         l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
 358     if arch in ('X86_64', 'X86_32'):
 359         l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
 360         l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
 361         l += [KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
 362         l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
 363         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
 364                  KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
 365     if arch in ('ARM64', 'ARM'):
 366         l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
 367     if arch == 'X86_64':
 368         l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
 369         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
 370         l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
 371                   iommu_support_is_set)]
 372         l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
 373                   iommu_support_is_set)]
 374     if arch == 'ARM64':
 375         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
 376         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
 377         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
 378         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
 379                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
 380                      VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
 381         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
 382         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
 383         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
 384         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
 385                  VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
 386         l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
 387         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
 388         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
 389     if arch == 'ARM':
 390         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
 391         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
 392         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
 393
 394     # 'self_protection', 'kspp'
 395     l += [KconfigCheck('self_protection', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
 396     l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
 397     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
 398     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
 399     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
 400     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
 401     l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
 402     l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
 403     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
 404     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
 405     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
 406     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
 407     l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
 408     l += [KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
 409     l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
 410     l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
 411     l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
 412     l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
 413     randstruct_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
 414     l += [randstruct_is_set]
 415     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 416     l += [hardened_usercopy_is_set]
 417     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 418               hardened_usercopy_is_set)]
 419     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
 420               hardened_usercopy_is_set)]
 421     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 422              modules_not_set)]
 423     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 424              modules_not_set)]
 425     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 426              modules_not_set)]
 427     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 428              modules_not_set)] # refers to LOCKDOWN
 429     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
 430              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 431     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 432              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
 433              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
 434              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
 435              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
 436              # the 0xAA poison pattern on allocation.
 437              # That brings higher performance penalty.
 438     if arch in ('X86_64', 'ARM64', 'X86_32'):
 439         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 440         l += [stackleak_is_set]
 441         l += [OR(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
 442                  CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'))]
 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 += [OR(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
 471              CmdlineCheck('self_protection', 'kspp', 'slab_nomerge'))] # option presence check
 472     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
 473     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
 474     l += [AND(KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 475               randstruct_is_set)]
 476     if arch in ('X86_64', 'ARM64', 'X86_32'):
 477         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
 478                   stackleak_is_set)]
 479         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 480                   stackleak_is_set)]
 481     if arch in ('X86_64', 'X86_32'):
 482         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 483                   iommu_support_is_set)]
 484     if arch == 'X86_64':
 485         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
 486                   iommu_support_is_set)]
 487     if arch == 'X86_32':
 488         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
 489                   iommu_support_is_set)]
 490
 491     # 'self_protection', 'my'
 492     l += [OR(KconfigCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y'),
 493              efi_not_set)] # needs userspace support (systemd)
 494     if arch == 'X86_64':
 495         l += [KconfigCheck('self_protection', 'my', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
 496         l += [AND(KconfigCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
 497                   iommu_support_is_set)]
 498     if arch == 'ARM64':
 499         l += [KconfigCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
 500         l += [KconfigCheck('self_protection', 'my', 'KASAN_HW_TAGS', 'y')]
 501         cfi_clang_is_set = KconfigCheck('self_protection', 'my', 'CFI_CLANG', 'y')
 502         l += [cfi_clang_is_set]
 503         l += [AND(KconfigCheck('self_protection', 'my', 'CFI_PERMISSIVE', 'is not set'),
 504                   cfi_clang_is_set)]
 505
 506     # 'security_policy'
 507     if arch in ('X86_64', 'ARM64', 'X86_32'):
 508         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
 509     if arch == 'ARM':
 510         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
 511     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 512     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
 513     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
 514     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 515     l += [KconfigCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 516     l += [KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
 517     l += [KconfigCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
 518     loadpin_is_set = KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
 519     l += [loadpin_is_set] # needs userspace support
 520     l += [AND(KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
 521               loadpin_is_set)]
 522
 523     # 'cut_attack_surface', 'defconfig'
 524     l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
 525              bpf_syscall_not_set)] # see unprivileged_bpf_disabled
 526     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 527     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 528     if arch in ('X86_64', 'ARM64', 'X86_32'):
 529         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 530                  devmem_not_set)] # refers to LOCKDOWN
 531
 532     # 'cut_attack_surface', 'kspp'
 533     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 534     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 535     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 536     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 537     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 538     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 539     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 540     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 541     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 542     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 543     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 544     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 545     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 546     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 547     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 548     l += [modules_not_set]
 549     l += [devmem_not_set]
 550     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 551              devmem_not_set)] # refers to LOCKDOWN
 552     if arch == 'ARM':
 553         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 554                  devmem_not_set)] # refers to LOCKDOWN
 555     if arch == 'X86_64':
 556         l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 557
 558     # 'cut_attack_surface', 'grsec'
 559     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
 560     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
 561     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
 562     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
 563     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
 564     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
 565     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 566     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
 567     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
 568     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
 569     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
 570     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
 571     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
 572     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
 573     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
 574     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
 575     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
 576     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
 577     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 578     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 579     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 580     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
 581     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
 582     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
 583     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
 584     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
 585     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
 586     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
 587     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
 588     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
 589     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
 590     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
 591     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
 592     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
 593     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
 594     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
 595     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
 596     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
 597               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
 598
 599     # 'cut_attack_surface', 'maintainer'
 600     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
 601     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
 602     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
 603     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
 604     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
 605
 606     # 'cut_attack_surface', 'grapheneos'
 607     l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 608
 609     # 'cut_attack_surface', 'clipos'
 610     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 611     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 612 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 613     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 614     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 615     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 616     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 617     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 618     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 619     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 620     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 621     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 622     l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
 623               KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD'))] # option presence check
 624     if arch in ('X86_64', 'X86_32'):
 625         l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 626
 627     # 'cut_attack_surface', 'lockdown'
 628     l += [bpf_syscall_not_set] # refers to LOCKDOWN
 629     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 630     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 631     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 632
 633     # 'cut_attack_surface', 'my'
 634     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
 635              modules_not_set)]
 636     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 637     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 638     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 639     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 640     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 641     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 642     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 643     l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
 644
 645     # 'harden_userspace'
 646     if arch in ('X86_64', 'ARM64', 'X86_32'):
 647         l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
 648     if arch == 'ARM':
 649         l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
 650     if arch in ('ARM', 'X86_32'):
 651         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
 652     if arch in ('X86_64', 'ARM64'):
 653         l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
 654     if arch in ('X86_32', 'ARM'):
 655         l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
 656
 657 #   l += [KconfigCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
 658
 659
 660 def add_cmdline_checks(l, arch):
 661     # Calling the CmdlineCheck class constructor:
 662     #     CmdlineCheck(reason, decision, name, expected)
 663
 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 SIMPLE_OPTION_TYPES:
 742         sys.exit('[!] ERROR: invalid opt type "{}" for {}'.format(opt.type, opt.name))
 743     if data_type not in SIMPLE_OPTION_TYPES:
 744         sys.exit('[!] ERROR: invalid data type "{}"'.format(data_type))
 745
 746     if data_type != opt.type:
 747         return
 748
 749     if data_type in ('kconfig', 'cmdline'):
 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 not in ('kconfig', 'cmdline'):
 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 parse_cmdline_file(parsed_options, fname):
 806     with open(fname, 'r') as f:
 807         line = f.readline()
 808         opts = line.split()
 809
 810         line = f.readline()
 811         if line:
 812             sys.exit('[!] ERROR: more than one line in "{}"'.format(fname))
 813
 814         for opt in opts:
 815             if '=' in opt:
 816                 name, value = opt.split('=', 1)
 817             else:
 818                 name = opt
 819                 value = '' # '' is not None
 820             parsed_options[name] = value
 821
 822
 823 def main():
 824     # Report modes:
 825     #   * verbose mode for
 826     #     - reporting about unknown kernel options in the kconfig
 827     #     - verbose printing of ComplexOptCheck items
 828     #   * json mode for printing the results in JSON format
 829     report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
 830     supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
 831     parser = ArgumentParser(prog='kconfig-hardened-check',
 832                             description='A tool for checking the security hardening options of the Linux kernel')
 833     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
 834     parser.add_argument('-p', '--print', choices=supported_archs,
 835                         help='print security hardening preferences for the selected architecture')
 836     parser.add_argument('-c', '--config',
 837                         help='check the kernel kconfig file against these preferences')
 838     parser.add_argument('-l', '--cmdline',
 839                         help='check the kernel cmdline file against these preferences')
 840     parser.add_argument('-m', '--mode', choices=report_modes,
 841                         help='choose the report mode')
 842     args = parser.parse_args()
 843
 844     mode = None
 845     if args.mode:
 846         mode = args.mode
 847         if mode != 'json':
 848             print('[+] Special report mode: {}'.format(mode))
 849
 850     config_checklist = []
 851
 852     if args.config:
 853         if mode != 'json':
 854             print('[+] Kconfig file to check: {}'.format(args.config))
 855             if args.cmdline:
 856                 print('[+] Kernel cmdline file to check: {}'.format(args.cmdline))
 857
 858         arch, msg = detect_arch(args.config, supported_archs)
 859         if not arch:
 860             sys.exit('[!] ERROR: {}'.format(msg))
 861         if mode != 'json':
 862             print('[+] Detected architecture: {}'.format(arch))
 863
 864         kernel_version, msg = detect_version(args.config)
 865         if not kernel_version:
 866             sys.exit('[!] ERROR: {}'.format(msg))
 867         if mode != 'json':
 868             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
 869
 870         # add relevant kconfig checks to the checklist
 871         add_kconfig_checks(config_checklist, arch)
 872
 873         # populate the checklist with the parsed kconfig data
 874         parsed_kconfig_options = OrderedDict()
 875         parse_kconfig_file(parsed_kconfig_options, args.config)
 876         populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
 877         populate_with_data(config_checklist, kernel_version, 'version')
 878
 879         if args.cmdline:
 880             # add relevant cmdline checks to the checklist
 881             add_cmdline_checks(config_checklist, arch)
 882
 883             # populate the checklist with the parsed kconfig data
 884             parsed_cmdline_options = OrderedDict()
 885             parse_cmdline_file(parsed_cmdline_options, args.cmdline)
 886             populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
 887
 888         # now everything is ready for performing the checks
 889         perform_checks(config_checklist)
 890
 891         # finally print the results
 892         if mode == 'verbose':
 893             print_unknown_options(config_checklist, parsed_kconfig_options)
 894         print_checklist(mode, config_checklist, True)
 895
 896         sys.exit(0)
 897     elif args.cmdline:
 898         sys.exit('[!] ERROR: checking cmdline doesn\'t work without checking kconfig')
 899
 900     if args.print:
 901         if mode in ('show_ok', 'show_fail'):
 902             sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
 903         arch = args.print
 904         add_kconfig_checks(config_checklist, arch)
 905         add_cmdline_checks(config_checklist, arch)
 906         if mode != 'json':
 907             print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
 908         print_checklist(mode, config_checklist, False)
 909         sys.exit(0)
 910
 911     parser.print_help()
 912     sys.exit(0)
 913
 914 if __name__ == '__main__':
 915     main()