kconfig_hardened_check/__init__.py

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