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