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', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
 398     l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
 399     randstruct_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
 400     l += [randstruct_is_set]
 401     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 402     l += [hardened_usercopy_is_set]
 403     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 404               hardened_usercopy_is_set)]
 405     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
 406               hardened_usercopy_is_set)]
 407     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 408              modules_not_set)]
 409     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 410              modules_not_set)]
 411     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 412              modules_not_set)]
 413     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 414              modules_not_set)] # refers to LOCKDOWN
 415     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
 416              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 417     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 418              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
 419              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
 420              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
 421              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
 422              # the 0xAA poison pattern on allocation.
 423              # That brings higher performance penalty.
 424     if arch in ('X86_64', 'ARM64', 'X86_32'):
 425         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 426         l += [stackleak_is_set]
 427         l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
 428     if arch in ('X86_64', 'X86_32'):
 429         l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
 430         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
 431     if arch in ('ARM64', 'ARM'):
 432         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
 433         l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
 434     if arch == 'ARM64':
 435         l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
 436     if arch == 'X86_32':
 437         l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
 438         l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
 439         l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
 440
 441     # 'self_protection', 'maintainer'
 442     ubsan_bounds_is_set = KconfigCheck('self_protection', 'maintainer', 'UBSAN_BOUNDS', 'y') # only array index bounds checking
 443     l += [ubsan_bounds_is_set] # recommended by Kees Cook in /issues/53
 444     if arch in ('X86_64', 'ARM64', 'X86_32'):  # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
 445         l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_SANITIZE_ALL', 'y'),
 446                   ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
 447     l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_TRAP', 'y'),
 448               ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
 449
 450     # 'self_protection', 'clipos'
 451     l += [KconfigCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
 452     l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
 453     l += [OR(KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y'),
 454              efi_not_set)]
 455     l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')]
 456     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
 457     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
 458     l += [AND(KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 459               randstruct_is_set)]
 460     if arch in ('X86_64', 'ARM64', 'X86_32'):
 461         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
 462                   stackleak_is_set)]
 463         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 464                   stackleak_is_set)]
 465     if arch in ('X86_64', 'X86_32'):
 466         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 467                   iommu_support_is_set)]
 468     if arch == 'X86_64':
 469         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
 470                   iommu_support_is_set)]
 471     if arch == 'X86_32':
 472         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
 473                   iommu_support_is_set)]
 474
 475     # 'self_protection', 'my'
 476     l += [OR(KconfigCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y'),
 477              efi_not_set)] # needs userspace support (systemd)
 478     if arch == 'X86_64':
 479         l += [KconfigCheck('self_protection', 'my', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
 480         l += [AND(KconfigCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
 481                   iommu_support_is_set)]
 482     if arch == 'ARM64':
 483         l += [KconfigCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
 484         l += [KconfigCheck('self_protection', 'my', 'KASAN_HW_TAGS', 'y')]
 485         cfi_clang_is_set = KconfigCheck('self_protection', 'my', 'CFI_CLANG', 'y')
 486         l += [cfi_clang_is_set]
 487         l += [AND(KconfigCheck('self_protection', 'my', 'CFI_PERMISSIVE', 'is not set'),
 488                   cfi_clang_is_set)]
 489
 490     # 'security_policy'
 491     if arch in ('X86_64', 'ARM64', 'X86_32'):
 492         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
 493     if arch == 'ARM':
 494         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
 495     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 496     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
 497     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
 498     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 499     l += [KconfigCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 500     l += [KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
 501     l += [KconfigCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
 502     loadpin_is_set = KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
 503     l += [loadpin_is_set] # needs userspace support
 504     l += [AND(KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
 505               loadpin_is_set)]
 506
 507     # 'cut_attack_surface', 'defconfig'
 508     l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
 509              bpf_syscall_not_set)] # see unprivileged_bpf_disabled
 510     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 511     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 512     if arch in ('X86_64', 'ARM64', 'X86_32'):
 513         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 514                  devmem_not_set)] # refers to LOCKDOWN
 515
 516     # 'cut_attack_surface', 'kspp'
 517     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 518     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 519     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 520     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 521     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 522     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 523     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 524     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 525     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 526     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 527     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 528     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 529     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 530     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 531     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 532     l += [modules_not_set]
 533     l += [devmem_not_set]
 534     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 535              devmem_not_set)] # refers to LOCKDOWN
 536     if arch == 'ARM':
 537         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 538                  devmem_not_set)] # refers to LOCKDOWN
 539     if arch == 'X86_64':
 540         l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 541
 542     # 'cut_attack_surface', 'grsec'
 543     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
 544     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
 545     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
 546     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
 547     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
 548     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
 549     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 550     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
 551     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
 552     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
 553     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
 554     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
 555     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
 556     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
 557     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
 558     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
 559     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
 560     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
 561     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 562     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 563     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 564     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
 565     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
 566     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
 567     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
 568     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
 569     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
 570     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
 571     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
 572     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
 573     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
 574     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
 575     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
 576     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
 577     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
 578     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
 579     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
 580     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
 581               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
 582
 583     # 'cut_attack_surface', 'maintainer'
 584     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
 585     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
 586     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
 587     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
 588     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
 589
 590     # 'cut_attack_surface', 'grapheneos'
 591     l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 592
 593     # 'cut_attack_surface', 'clipos'
 594     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 595     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 596 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 597     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 598     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 599     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 600     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 601     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 602     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 603     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 604     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 605     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 606     l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
 607               KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD'))] # option presence check
 608     if arch in ('X86_64', 'X86_32'):
 609         l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 610
 611     # 'cut_attack_surface', 'lockdown'
 612     l += [bpf_syscall_not_set] # refers to LOCKDOWN
 613     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 614     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 615     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 616
 617     # 'cut_attack_surface', 'my'
 618     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
 619              modules_not_set)]
 620     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 621     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 622     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 623     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 624     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 625     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 626     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 627     l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
 628
 629     # 'harden_userspace'
 630     if arch in ('X86_64', 'ARM64', 'X86_32'):
 631         l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
 632     if arch == 'ARM':
 633         l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
 634     if arch in ('ARM', 'X86_32'):
 635         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
 636     if arch in ('X86_64', 'ARM64'):
 637         l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
 638     if arch in ('X86_32', 'ARM'):
 639         l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
 640
 641 #   l += [KconfigCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
 642
 643
 644 def add_cmdline_checks(l, arch):
 645     # Calling the CmdlineCheck class constructor:
 646     #     CmdlineCheck(reason, decision, name, expected)
 647     # Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
 648     # when the tool doesn't check the cmdline.
 649
 650     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
 651              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
 652                  CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
 653     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_free', '1'),
 654              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 655                  CmdlineCheck('self_protection', 'kspp', 'init_on_free', 'is not set')),
 656              AND(CmdlineCheck('self_protection', 'kspp', 'page_poison', '1'),
 657                  KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'),
 658                  CmdlineCheck('self_protection', 'kspp', 'slub_debug', 'P')))]
 659     l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_nomerge'),
 660              AND(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
 661                  CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set')))] # option presence check
 662     l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.strict', '1'),
 663              AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y'),
 664                  CmdlineCheck('self_protection', 'kspp', 'iommu.strict', 'is not set')))]
 665     if arch in ('X86_64', 'ARM64', 'X86_32'):
 666         l += [OR(CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'),
 667                  AND(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
 668                      CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', 'is not set')))]
 669     if arch in ('X86_64', 'X86_32'):
 670         l += [CmdlineCheck('self_protection', 'kspp', 'pti', 'on')]
 671
 672     if arch == 'X86_64':
 673         l += [OR(CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'none'),
 674                  AND(KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'),
 675                      CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'is not set')))]
 676
 677     # TODO: add other
 678
 679
 680 def print_unknown_options(checklist, parsed_options):
 681     known_options = []
 682
 683     for o1 in checklist:
 684         if o1.type != 'complex':
 685             known_options.append(o1.name)
 686             continue
 687         for o2 in o1.opts:
 688             if o2.type != 'complex':
 689                 if hasattr(o2, 'name'):
 690                     known_options.append(o2.name)
 691                 continue
 692             for o3 in o2.opts:
 693                 assert(o3.type != 'complex'), \
 694                        'unexpected ComplexOptCheck inside {}'.format(o2.name)
 695                 if hasattr(o3, 'name'):
 696                     known_options.append(o3.name)
 697
 698     for option, value in parsed_options.items():
 699         if option not in known_options:
 700             print('[?] No check for option {} ({})'.format(option, value))
 701
 702
 703 def print_checklist(mode, checklist, with_results):
 704     if mode == 'json':
 705         output = []
 706         for o in checklist:
 707             output.append(o.json_dump(with_results))
 708         print(json.dumps(output))
 709         return
 710
 711     # table header
 712     sep_line_len = 91
 713     if with_results:
 714         sep_line_len += 30
 715     print('=' * sep_line_len)
 716     print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
 717     if with_results:
 718         print('| {}'.format('check result'), end='')
 719     print()
 720     print('=' * sep_line_len)
 721
 722     # table contents
 723     for opt in checklist:
 724         if with_results:
 725             if mode == 'show_ok':
 726                 if not opt.result.startswith('OK'):
 727                     continue
 728             if mode == 'show_fail':
 729                 if not opt.result.startswith('FAIL'):
 730                     continue
 731         opt.table_print(mode, with_results)
 732         print()
 733         if mode == 'verbose':
 734             print('-' * sep_line_len)
 735     print()
 736
 737     # final score
 738     if with_results:
 739         fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 740         fail_suppressed = ''
 741         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
 742         ok_suppressed = ''
 743         if mode == 'show_ok':
 744             fail_suppressed = ' (suppressed in output)'
 745         if mode == 'show_fail':
 746             ok_suppressed = ' (suppressed in output)'
 747         if mode != 'json':
 748             print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
 749
 750
 751 def populate_simple_opt_with_data(opt, data, data_type):
 752     assert(opt.type != 'complex'), \
 753            'unexpected ComplexOptCheck "{}"'.format(opt.name)
 754     assert(opt.type in SIMPLE_OPTION_TYPES), \
 755            'invalid opt type "{}"'.format(opt.type)
 756     assert(data_type in SIMPLE_OPTION_TYPES), \
 757            'invalid data type "{}"'.format(data_type)
 758
 759     if data_type != opt.type:
 760         return
 761
 762     if data_type in ('kconfig', 'cmdline'):
 763         opt.state = data.get(opt.name, None)
 764     else:
 765         assert(data_type == 'version'), \
 766                'unexpected data type "{}"'.format(data_type)
 767         opt.ver = data
 768
 769
 770 def populate_opt_with_data(opt, data, data_type):
 771     if opt.type == 'complex':
 772         for o in opt.opts:
 773             if o.type == 'complex':
 774                 # Recursion for nested ComplexOptCheck objects
 775                 populate_opt_with_data(o, data, data_type)
 776             else:
 777                 populate_simple_opt_with_data(o, data, data_type)
 778     else:
 779         assert(opt.type in ('kconfig', 'cmdline')), \
 780                'bad type "{}" for a simple check'.format(opt.type)
 781         populate_simple_opt_with_data(opt, data, data_type)
 782
 783
 784 def populate_with_data(checklist, data, data_type):
 785     for opt in checklist:
 786         populate_opt_with_data(opt, data, data_type)
 787
 788
 789 def perform_checks(checklist):
 790     for opt in checklist:
 791         opt.check()
 792
 793
 794 def parse_kconfig_file(parsed_options, fname):
 795     with open(fname, 'r') as f:
 796         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 797         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 798
 799         for line in f.readlines():
 800             line = line.strip()
 801             option = None
 802             value = None
 803
 804             if opt_is_on.match(line):
 805                 option, value = line.split('=', 1)
 806                 if value == 'is not set':
 807                     sys.exit('[!] ERROR: bad enabled kconfig option "{}"'.format(line))
 808             elif opt_is_off.match(line):
 809                 option, value = line[2:].split(' ', 1)
 810                 if value != 'is not set':
 811                     sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
 812
 813             if option in parsed_options:
 814                 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
 815
 816             if option:
 817                 parsed_options[option] = value
 818
 819
 820 def parse_cmdline_file(parsed_options, fname):
 821     with open(fname, 'r') as f:
 822         line = f.readline()
 823         opts = line.split()
 824
 825         line = f.readline()
 826         if line:
 827             sys.exit('[!] ERROR: more than one line in "{}"'.format(fname))
 828
 829         for opt in opts:
 830             if '=' in opt:
 831                 name, value = opt.split('=', 1)
 832             else:
 833                 name = opt
 834                 value = '' # '' is not None
 835             parsed_options[name] = value
 836
 837
 838 def main():
 839     # Report modes:
 840     #   * verbose mode for
 841     #     - reporting about unknown kernel options in the kconfig
 842     #     - verbose printing of ComplexOptCheck items
 843     #   * json mode for printing the results in JSON format
 844     report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
 845     supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
 846     parser = ArgumentParser(prog='kconfig-hardened-check',
 847                             description='A tool for checking the security hardening options of the Linux kernel')
 848     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
 849     parser.add_argument('-p', '--print', choices=supported_archs,
 850                         help='print security hardening preferences for the selected architecture')
 851     parser.add_argument('-c', '--config',
 852                         help='check the kernel kconfig file against these preferences')
 853     parser.add_argument('-l', '--cmdline',
 854                         help='check the kernel cmdline file against these preferences')
 855     parser.add_argument('-m', '--mode', choices=report_modes,
 856                         help='choose the report mode')
 857     args = parser.parse_args()
 858
 859     mode = None
 860     if args.mode:
 861         mode = args.mode
 862         if mode != 'json':
 863             print('[+] Special report mode: {}'.format(mode))
 864
 865     config_checklist = []
 866
 867     if args.config:
 868         if args.print:
 869             sys.exit('[!] ERROR: --config and --print can\'t be used together')
 870
 871         if mode != 'json':
 872             print('[+] Kconfig file to check: {}'.format(args.config))
 873             if args.cmdline:
 874                 print('[+] Kernel cmdline file to check: {}'.format(args.cmdline))
 875
 876         arch, msg = detect_arch(args.config, supported_archs)
 877         if not arch:
 878             sys.exit('[!] ERROR: {}'.format(msg))
 879         if mode != 'json':
 880             print('[+] Detected architecture: {}'.format(arch))
 881
 882         kernel_version, msg = detect_version(args.config)
 883         if not kernel_version:
 884             sys.exit('[!] ERROR: {}'.format(msg))
 885         if mode != 'json':
 886             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
 887
 888         # add relevant kconfig checks to the checklist
 889         add_kconfig_checks(config_checklist, arch)
 890
 891         if args.cmdline:
 892             # add relevant cmdline checks to the checklist
 893             add_cmdline_checks(config_checklist, arch)
 894
 895         # populate the checklist with the parsed kconfig data
 896         parsed_kconfig_options = OrderedDict()
 897         parse_kconfig_file(parsed_kconfig_options, args.config)
 898         populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
 899         populate_with_data(config_checklist, kernel_version, 'version')
 900
 901         if args.cmdline:
 902             # populate the checklist with the parsed kconfig data
 903             parsed_cmdline_options = OrderedDict()
 904             parse_cmdline_file(parsed_cmdline_options, args.cmdline)
 905             populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline')
 906
 907         # now everything is ready for performing the checks
 908         perform_checks(config_checklist)
 909
 910         # finally print the results
 911         if mode == 'verbose':
 912             print_unknown_options(config_checklist, parsed_kconfig_options)
 913         print_checklist(mode, config_checklist, True)
 914
 915         sys.exit(0)
 916     elif args.cmdline:
 917         sys.exit('[!] ERROR: checking cmdline doesn\'t work without checking kconfig')
 918
 919     if args.print:
 920         if mode in ('show_ok', 'show_fail'):
 921             sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
 922         arch = args.print
 923         add_kconfig_checks(config_checklist, arch)
 924         add_cmdline_checks(config_checklist, arch)
 925         if mode != 'json':
 926             print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
 927         print_checklist(mode, config_checklist, False)
 928         sys.exit(0)
 929
 930     parser.print_help()
 931     sys.exit(0)