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