kconfig_hardened_check/__init__.py

   1 #!/usr/bin/python3
   2
   3 #
   4 # This tool helps me to check the Linux kernel Kconfig option list
   5 # against my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
   6 # Let the computers do their job!
   7 #
   8 # Author: Alexander Popov <alex.popov@linux.com>
   9 #
  10 # Please don't cry if my Python code looks like C.
  11 #
  12 #
  13 # N.B Hardening command line parameters:
  14 #    slab_nomerge
  15 #    page_alloc.shuffle=1
  16 #    iommu=force (does it help against DMA attacks?)
  17 #    slub_debug=FZ (slow)
  18 #    init_on_alloc=1 (since v5.3)
  19 #    init_on_free=1 (since v5.3, otherwise slub_debug=P and page_poison=1)
  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 #           pti=on
  29 #           spec_store_bypass_disable=on
  30 #           l1tf=full,force
  31 #           mds=full,nosmt
  32 #           tsx=off
  33 #       ARM64:
  34 #           kpti=on
  35 #           ssbd=force-on
  36 #
  37 # N.B. Hardening sysctls:
  38 #    kernel.kptr_restrict=2 (or 1?)
  39 #    kernel.dmesg_restrict=1 (also see the kconfig option)
  40 #    kernel.perf_event_paranoid=3
  41 #    kernel.kexec_load_disabled=1
  42 #    kernel.yama.ptrace_scope=3
  43 #    user.max_user_namespaces=0
  44 #    what about bpf_jit_enable?
  45 #    kernel.unprivileged_bpf_disabled=1
  46 #    net.core.bpf_jit_harden=2
  47 #
  48 #    vm.unprivileged_userfaultfd=0
  49 #        (at first, it disabled unprivileged userfaultfd,
  50 #         and since v5.11 it enables unprivileged userfaultfd for user-mode only)
  51 #
  52 #    dev.tty.ldisc_autoload=0
  53 #    fs.protected_symlinks=1
  54 #    fs.protected_hardlinks=1
  55 #    fs.protected_fifos=2
  56 #    fs.protected_regular=2
  57 #    fs.suid_dumpable=0
  58 #    kernel.modules_disabled=1
  59
  60
  61 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
  62 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
  63
  64
  65 import sys
  66 from argparse import ArgumentParser
  67 from collections import OrderedDict
  68 import re
  69 import json
  70 from .__about__ import __version__
  71
  72
  73 class OptCheck:
  74     def __init__(self, reason, decision, name, expected):
  75         self.name = name
  76         self.expected = expected
  77         self.decision = decision
  78         self.reason = reason
  79         self.state = None
  80         self.result = None
  81
  82     def check(self):
  83         if self.expected == self.state:
  84             self.result = 'OK'
  85         elif self.state is None:
  86             if self.expected == 'is not set':
  87                 self.result = 'OK: not found'
  88             else:
  89                 self.result = 'FAIL: not found'
  90         else:
  91             self.result = 'FAIL: "' + self.state + '"'
  92
  93         if self.result.startswith('OK'):
  94             return True
  95         return False
  96
  97     def table_print(self, _mode, with_results):
  98         print('CONFIG_{:<38}|{:^13}|{:^10}|{:^20}'.format(self.name, self.expected, self.decision, self.reason), end='')
  99         if with_results:
 100             print('|   {}'.format(self.result), end='')
 101
 102
 103 class VerCheck:
 104     def __init__(self, ver_expected):
 105         self.ver_expected = ver_expected
 106         self.ver = ()
 107         self.result = None
 108
 109     def check(self):
 110         if self.ver[0] > self.ver_expected[0]:
 111             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 112             return True
 113         if self.ver[0] < self.ver_expected[0]:
 114             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 115             return False
 116         if self.ver[1] >= self.ver_expected[1]:
 117             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 118             return True
 119         self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 120         return False
 121
 122     def table_print(self, _mode, with_results):
 123         ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
 124         print('{:<91}'.format(ver_req), end='')
 125         if with_results:
 126             print('|   {}'.format(self.result), end='')
 127
 128
 129 class PresenceCheck:
 130     def __init__(self, name):
 131         self.name = name
 132         self.state = None
 133         self.result = None
 134
 135     def check(self):
 136         if self.state is None:
 137             self.result = 'FAIL: not present'
 138             return False
 139         self.result = 'OK: is present'
 140         return True
 141
 142     def table_print(self, _mode, with_results):
 143         print('CONFIG_{:<84}'.format(self.name + ' is present'), end='')
 144         if with_results:
 145             print('|   {}'.format(self.result), end='')
 146
 147
 148 class ComplexOptCheck:
 149     def __init__(self, *opts):
 150         self.opts = opts
 151         if not self.opts:
 152             sys.exit('[!] ERROR: empty {} check'.format(self.__class__.__name__))
 153         if not isinstance(opts[0], OptCheck):
 154             sys.exit('[!] ERROR: invalid {} check: {}'.format(self.__class__.__name__, opts))
 155         self.result = None
 156
 157     @property
 158     def name(self):
 159         return self.opts[0].name
 160
 161     @property
 162     def expected(self):
 163         return self.opts[0].expected
 164
 165     @property
 166     def decision(self):
 167         return self.opts[0].decision
 168
 169     @property
 170     def reason(self):
 171         return self.opts[0].reason
 172
 173     def table_print(self, mode, with_results):
 174         if mode == 'verbose':
 175             print('    {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
 176             if with_results:
 177                 print('|   {}'.format(self.result), end='')
 178             for o in self.opts:
 179                 print()
 180                 o.table_print(mode, with_results)
 181         else:
 182             o = self.opts[0]
 183             o.table_print(mode, False)
 184             if with_results:
 185                 print('|   {}'.format(self.result), end='')
 186
 187
 188 class OR(ComplexOptCheck):
 189     # self.opts[0] is the option that this OR-check is about.
 190     # Use cases:
 191     #     OR(<X_is_hardened>, <X_is_disabled>)
 192     #     OR(<X_is_hardened>, <old_X_is_hardened>)
 193
 194     def check(self):
 195         if not self.opts:
 196             sys.exit('[!] ERROR: invalid OR check')
 197
 198         for i, opt in enumerate(self.opts):
 199             ret = opt.check()
 200             if ret:
 201                 if opt.result != 'OK' or i == 0:
 202                     # Preserve additional explanation of this OK result.
 203                     # Simple OK is enough only for the main option that
 204                     # this OR-check is about.
 205                     self.result = opt.result
 206                 else:
 207                     # Simple OK is not enough for additional checks.
 208                     self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
 209                 return True
 210         self.result = self.opts[0].result
 211         return False
 212
 213
 214 class AND(ComplexOptCheck):
 215     # self.opts[0] is the option that this AND-check is about.
 216     # Use cases:
 217     #     AND(<suboption>, <main_option>)
 218     #       Suboption is not checked if checking of the main_option is failed.
 219     #     AND(<X_is_disabled>, <old_X_is_disabled>)
 220
 221     def check(self):
 222         for i, opt in reversed(list(enumerate(self.opts))):
 223             ret = opt.check()
 224             if i == 0:
 225                 self.result = opt.result
 226                 return ret
 227             if not ret:
 228                 # This FAIL is caused by additional checks,
 229                 # and not by the main option that this AND-check is about.
 230                 # Describe the reason of the FAIL.
 231                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
 232                     self.result = 'FAIL: CONFIG_{} not "{}"'.format(opt.name, opt.expected)
 233                 elif opt.result == 'FAIL: not present':
 234                     self.result = 'FAIL: CONFIG_{} not present'.format(opt.name)
 235                 else:
 236                     # This FAIL message is self-explaining.
 237                     self.result = opt.result
 238                 return False
 239
 240         sys.exit('[!] ERROR: invalid AND check')
 241
 242
 243 def detect_arch(fname, archs):
 244     with open(fname, 'r') as f:
 245         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 246         arch = None
 247         for line in f.readlines():
 248             if arch_pattern.match(line):
 249                 option, _ = line[7:].split('=', 1)
 250                 if option in archs:
 251                     if not arch:
 252                         arch = option
 253                     else:
 254                         return None, 'more than one supported architecture is detected'
 255         if not arch:
 256             return None, 'failed to detect architecture'
 257         return arch, 'OK'
 258
 259
 260 def detect_version(fname):
 261     with open(fname, 'r') as f:
 262         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
 263         for line in f.readlines():
 264             if ver_pattern.match(line):
 265                 line = line.strip()
 266                 parts = line.split()
 267                 ver_str = parts[2]
 268                 ver_numbers = ver_str.split('.')
 269                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
 270                     msg = 'failed to parse the version "' + ver_str + '"'
 271                     return None, msg
 272                 return (int(ver_numbers[0]), int(ver_numbers[1])), None
 273         return None, 'no kernel version detected'
 274
 275
 276 def construct_checklist(l, arch):
 277     modules_not_set = OptCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
 278     devmem_not_set = OptCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
 279
 280     # 'self_protection', 'defconfig'
 281     l += [OptCheck('self_protection', 'defconfig', 'BUG', 'y')]
 282     l += [OptCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
 283     l += [OptCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
 284     l += [OR(OptCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
 285              OptCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 286     l += [OR(OptCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
 287              OptCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
 288     l += [OR(OptCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
 289              OptCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
 290              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
 291     l += [OR(OptCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
 292              VerCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
 293     iommu_support_is_set = OptCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
 294     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
 295     if arch in ('X86_64', 'ARM64', 'X86_32'):
 296         l += [OptCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
 297         l += [OptCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
 298     if arch in ('X86_64', 'ARM64'):
 299         l += [OptCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
 300     if arch in ('X86_64', 'X86_32'):
 301         l += [OptCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
 302         l += [OptCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
 303         l += [OptCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
 304         l += [OptCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
 305         l += [OR(OptCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
 306                  OptCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
 307     if arch in ('ARM64', 'ARM'):
 308         l += [OptCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
 309     if arch == 'X86_64':
 310         l += [OptCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
 311         l += [OptCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
 312         l += [AND(OptCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
 313                   iommu_support_is_set)]
 314         l += [AND(OptCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
 315                   iommu_support_is_set)]
 316     if arch == 'ARM64':
 317         l += [OptCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
 318         l += [OptCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
 319         l += [OR(OptCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
 320                  AND(OptCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
 321                      VerCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
 322         l += [OptCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
 323         l += [OptCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
 324         l += [OptCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
 325         l += [OR(OptCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
 326                  VerCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
 327     if arch == 'ARM':
 328         l += [OptCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
 329         l += [OptCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
 330
 331     # 'self_protection', 'kspp'
 332     l += [OptCheck('self_protection', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
 333     l += [OptCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
 334     l += [OptCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
 335     l += [OptCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
 336     l += [OptCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
 337     l += [OptCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
 338     l += [OptCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
 339     l += [OptCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
 340     l += [OptCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
 341     l += [OptCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
 342     l += [OptCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
 343     l += [OptCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
 344     l += [OptCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
 345     l += [OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
 346     randstruct_is_set = OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
 347     l += [randstruct_is_set]
 348     hardened_usercopy_is_set = OptCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 349     l += [hardened_usercopy_is_set]
 350     l += [AND(OptCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 351               hardened_usercopy_is_set)]
 352     l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 353              modules_not_set)]
 354     l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 355              modules_not_set)]
 356     l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 357              modules_not_set)]
 358     l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 359              modules_not_set)] # refers to LOCKDOWN
 360     l += [OR(OptCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
 361              OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 362     l += [OR(OptCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 363              OptCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
 364              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
 365              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
 366              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
 367              # the 0xAA poison pattern on allocation.
 368              # That brings higher performance penalty.
 369     if arch in ('X86_64', 'ARM64', 'X86_32'):
 370         stackleak_is_set = OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 371         l += [stackleak_is_set]
 372     if arch in ('X86_64', 'X86_32'):
 373         l += [OptCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
 374     if arch in ('ARM64', 'ARM'):
 375         l += [OptCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
 376         l += [OptCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
 377     if arch == 'ARM64':
 378         l += [OptCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
 379     if arch == 'X86_32':
 380         l += [OptCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
 381         l += [OptCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
 382         l += [OptCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
 383
 384     # 'self_protection', 'clipos'
 385     l += [OptCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
 386     l += [OptCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
 387     l += [OptCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y')]
 388     l += [OptCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')] # slab_nomerge
 389     l += [OptCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
 390     l += [OptCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
 391     l += [AND(OptCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 392               randstruct_is_set)]
 393     if arch in ('X86_64', 'ARM64', 'X86_32'):
 394         l += [AND(OptCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
 395                   stackleak_is_set)]
 396         l += [AND(OptCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 397                   stackleak_is_set)]
 398     if arch in ('X86_64', 'X86_32'):
 399         l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 400                   iommu_support_is_set)]
 401     if arch == 'X86_64':
 402         l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
 403                   iommu_support_is_set)]
 404     if arch == 'X86_32':
 405         l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
 406                   iommu_support_is_set)]
 407
 408     # 'self_protection', 'my'
 409     l += [AND(OptCheck('self_protection', 'my', 'UBSAN_BOUNDS', 'y'),
 410               OptCheck('self_protection', 'my', 'UBSAN_MISC', 'is not set'),
 411               OptCheck('self_protection', 'my', 'UBSAN_TRAP', 'y'))]
 412     l += [OptCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y')] # needs userspace support (systemd)
 413     if arch == 'X86_64':
 414         l += [AND(OptCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
 415                   iommu_support_is_set)]
 416     if arch == 'ARM64':
 417         l += [OptCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
 418
 419     # 'security_policy'
 420     if arch in ('X86_64', 'ARM64', 'X86_32'):
 421         l += [OptCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
 422     if arch == 'ARM':
 423         l += [OptCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
 424     l += [OptCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 425     l += [OR(OptCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
 426              OptCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
 427     l += [OptCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
 428     l += [OptCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 429     l += [OptCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 430     l += [OptCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
 431     loadpin_is_set = OptCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
 432     l += [loadpin_is_set] # needs userspace support
 433     l += [AND(OptCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
 434               loadpin_is_set)]
 435
 436     # 'cut_attack_surface', 'defconfig'
 437     l += [OptCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 438     l += [OptCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 439     if arch in ('X86_64', 'ARM64', 'X86_32'):
 440         l += [OR(OptCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 441                  devmem_not_set)] # refers to LOCKDOWN
 442
 443     # 'cut_attack_surface', 'kspp'
 444     l += [OptCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 445     l += [OptCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 446     l += [OptCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 447     l += [OptCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 448     l += [OptCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 449     l += [OptCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 450     l += [OptCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 451     l += [OptCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 452     l += [OptCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 453     l += [OptCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 454     l += [OptCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 455     l += [OptCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 456     l += [OptCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 457     l += [OptCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 458     l += [modules_not_set]
 459     l += [devmem_not_set]
 460     l += [OR(OptCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 461              devmem_not_set)] # refers to LOCKDOWN
 462     if arch == 'ARM':
 463         l += [OR(OptCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 464                  devmem_not_set)] # refers to LOCKDOWN
 465     if arch == 'X86_64':
 466         l += [OptCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 467
 468     # 'cut_attack_surface', 'grsecurity'
 469     l += [OptCheck('cut_attack_surface', 'grsecurity', 'ZSMALLOC_STAT', 'is not set')]
 470     l += [OptCheck('cut_attack_surface', 'grsecurity', 'PAGE_OWNER', 'is not set')]
 471     l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEBUG_KMEMLEAK', 'is not set')]
 472     l += [OptCheck('cut_attack_surface', 'grsecurity', 'BINFMT_AOUT', 'is not set')]
 473     l += [OptCheck('cut_attack_surface', 'grsecurity', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 474     l += [OptCheck('cut_attack_surface', 'grsecurity', 'UPROBES', 'is not set')]
 475     l += [OptCheck('cut_attack_surface', 'grsecurity', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 476     l += [OptCheck('cut_attack_surface', 'grsecurity', 'PROC_VMCORE', 'is not set')]
 477     l += [OptCheck('cut_attack_surface', 'grsecurity', 'PROC_PAGE_MONITOR', 'is not set')]
 478     l += [OptCheck('cut_attack_surface', 'grsecurity', 'USELIB', 'is not set')]
 479     l += [OptCheck('cut_attack_surface', 'grsecurity', 'CHECKPOINT_RESTORE', 'is not set')]
 480     l += [OptCheck('cut_attack_surface', 'grsecurity', 'USERFAULTFD', 'is not set')]
 481     l += [OptCheck('cut_attack_surface', 'grsecurity', 'HWPOISON_INJECT', 'is not set')]
 482     l += [OptCheck('cut_attack_surface', 'grsecurity', 'MEM_SOFT_DIRTY', 'is not set')]
 483     l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 484     l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 485     l += [OptCheck('cut_attack_surface', 'grsecurity', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
 486     l += [AND(OptCheck('cut_attack_surface', 'grsecurity', 'X86_PTDUMP', 'is not set'),
 487               OptCheck('cut_attack_surface', 'my', 'PTDUMP_DEBUGFS', 'is not set'))]
 488
 489     # 'cut_attack_surface', 'maintainer'
 490     l += [OptCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')]
 491     l += [OptCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')]
 492     l += [OptCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')]
 493
 494     # 'cut_attack_surface', 'grapheneos'
 495     l += [OptCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 496
 497     # 'cut_attack_surface', 'clipos'
 498     l += [OptCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 499     l += [OptCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 500 #   l += [OptCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 501     l += [OptCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 502     l += [OptCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 503     l += [OptCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 504     l += [OptCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 505     l += [OptCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 506     l += [OptCheck('cut_attack_surface', 'clipos', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 507     l += [OptCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 508     l += [OptCheck('cut_attack_surface', 'clipos', 'IO_URING', 'is not set')]
 509     l += [OptCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 510     l += [OptCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 511     l += [OptCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
 512     l += [AND(OptCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
 513               PresenceCheck('LDISC_AUTOLOAD'))]
 514     if arch in ('X86_64', 'X86_32'):
 515         l += [OptCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 516
 517     # 'cut_attack_surface', 'lockdown'
 518     l += [OptCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 519     l += [OptCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set')] # refers to LOCKDOWN
 520     l += [OptCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 521
 522     # 'cut_attack_surface', 'my'
 523     l += [OptCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y')]
 524     l += [OptCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 525     l += [OptCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 526     l += [OptCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 527     l += [OptCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 528     l += [OptCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 529     l += [OptCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 530     l += [OptCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 531
 532     # 'userspace_hardening'
 533     if arch in ('X86_64', 'ARM64', 'X86_32'):
 534         l += [OptCheck('userspace_hardening', 'defconfig', 'INTEGRITY', 'y')]
 535     if arch == 'ARM':
 536         l += [OptCheck('userspace_hardening', 'my', 'INTEGRITY', 'y')]
 537     if arch == 'ARM64':
 538         l += [OptCheck('userspace_hardening', 'defconfig', 'ARM64_MTE', 'y')]
 539     if arch in ('ARM', 'X86_32'):
 540         l += [OptCheck('userspace_hardening', 'defconfig', 'VMSPLIT_3G', 'y')]
 541     if arch in ('X86_64', 'ARM64'):
 542         l += [OptCheck('userspace_hardening', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
 543     if arch in ('X86_32', 'ARM'):
 544         l += [OptCheck('userspace_hardening', 'my', 'ARCH_MMAP_RND_BITS', '16')]
 545
 546 #   l += [OptCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
 547
 548
 549 def print_unknown_options(checklist, parsed_options):
 550     known_options = []
 551     for opt in checklist:
 552         if hasattr(opt, 'opts'):
 553             for o in opt.opts:
 554                 if hasattr(o, 'name'):
 555                     known_options.append(o.name)
 556         else:
 557             known_options.append(opt.name)
 558     for option, value in parsed_options.items():
 559         if option not in known_options:
 560             print('[?] No rule for option {} ({})'.format(option, value))
 561
 562
 563 def print_checklist(mode, checklist, with_results):
 564     if mode == 'json':
 565         opts = []
 566         for o in checklist:
 567             opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
 568             if with_results:
 569                 opt.append(o.result)
 570             opts.append(opt)
 571         print(json.dumps(opts))
 572         return
 573
 574     # table header
 575     sep_line_len = 91
 576     if with_results:
 577         sep_line_len += 30
 578     print('=' * sep_line_len)
 579     print('{:^45}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
 580     if with_results:
 581         print('|   {}'.format('check result'), end='')
 582     print()
 583     print('=' * sep_line_len)
 584
 585     # table contents
 586     for opt in checklist:
 587         if with_results:
 588             if mode == 'show_ok':
 589                 if not opt.result.startswith('OK'):
 590                     continue
 591             if mode == 'show_fail':
 592                 if not opt.result.startswith('FAIL'):
 593                     continue
 594         opt.table_print(mode, with_results)
 595         print()
 596         if mode == 'verbose':
 597             print('-' * sep_line_len)
 598     print()
 599
 600     # final score
 601     if with_results:
 602         fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 603         fail_suppressed = ''
 604         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
 605         ok_suppressed = ''
 606         if mode == 'show_ok':
 607             fail_suppressed = ' (suppressed in output)'
 608         if mode == 'show_fail':
 609             ok_suppressed = ' (suppressed in output)'
 610         if mode != 'json':
 611             print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
 612
 613
 614 def perform_check(opt, parsed_options, kernel_version):
 615     if hasattr(opt, 'opts'):
 616         # prepare ComplexOptCheck
 617         for o in opt.opts:
 618             if hasattr(o, 'opts'):
 619                 # Recursion for nested ComplexOptChecks
 620                 perform_check(o, parsed_options, kernel_version)
 621             if hasattr(o, 'state'):
 622                 o.state = parsed_options.get(o.name, None)
 623             if hasattr(o, 'ver'):
 624                 o.ver = kernel_version
 625     else:
 626         # prepare simple check, opt.state is mandatory
 627         if not hasattr(opt, 'state'):
 628             sys.exit('[!] ERROR: bad simple check {}'.format(vars(opt)))
 629         opt.state = parsed_options.get(opt.name, None)
 630     opt.check()
 631
 632
 633 def perform_checks(checklist, parsed_options, kernel_version):
 634     for opt in checklist:
 635         perform_check(opt, parsed_options, kernel_version)
 636
 637
 638 def parse_config_file(parsed_options, fname):
 639     with open(fname, 'r') as f:
 640         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 641         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 642
 643         for line in f.readlines():
 644             line = line.strip()
 645             option = None
 646             value = None
 647
 648             if opt_is_on.match(line):
 649                 option, value = line[7:].split('=', 1)
 650             elif opt_is_off.match(line):
 651                 option, value = line[9:].split(' ', 1)
 652                 if value != 'is not set':
 653                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 654
 655             if option in parsed_options:
 656                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 657
 658             if option:
 659                 parsed_options[option] = value
 660
 661         return parsed_options
 662
 663
 664 def main():
 665     # Report modes:
 666     #   * verbose mode for
 667     #     - reporting about unknown kernel options in the config
 668     #     - verbose printing of ComplexOptCheck items
 669     #   * json mode for printing the results in JSON format
 670     report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
 671     supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
 672     parser = ArgumentParser(prog='kconfig-hardened-check',
 673                             description='A tool for checking the security hardening options of the Linux kernel')
 674     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
 675     parser.add_argument('-p', '--print', choices=supported_archs,
 676                         help='print security hardening preferences for the selected architecture')
 677     parser.add_argument('-c', '--config',
 678                         help='check the kernel config file against these preferences')
 679     parser.add_argument('-m', '--mode', choices=report_modes,
 680                         help='choose the report mode')
 681     args = parser.parse_args()
 682
 683     mode = None
 684     if args.mode:
 685         mode = args.mode
 686         if mode != 'json':
 687             print("[+] Special report mode: {}".format(mode))
 688
 689     config_checklist = []
 690
 691     if args.config:
 692         if mode != 'json':
 693             print('[+] Config file to check: {}'.format(args.config))
 694
 695         arch, msg = detect_arch(args.config, supported_archs)
 696         if not arch:
 697             sys.exit('[!] ERROR: {}'.format(msg))
 698         if mode != 'json':
 699             print('[+] Detected architecture: {}'.format(arch))
 700
 701         kernel_version, msg = detect_version(args.config)
 702         if not kernel_version:
 703             sys.exit('[!] ERROR: {}'.format(msg))
 704         if mode != 'json':
 705             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
 706
 707         construct_checklist(config_checklist, arch)
 708         parsed_options = OrderedDict()
 709         parse_config_file(parsed_options, args.config)
 710         perform_checks(config_checklist, parsed_options, kernel_version)
 711
 712         if mode == 'verbose':
 713             print_unknown_options(config_checklist, parsed_options)
 714         print_checklist(mode, config_checklist, True)
 715
 716         sys.exit(0)
 717
 718     if args.print:
 719         if mode in ('show_ok', 'show_fail'):
 720             sys.exit('[!] ERROR: please use "{}" mode for checking the kernel config'.format(mode))
 721         arch = args.print
 722         construct_checklist(config_checklist, arch)
 723         if mode != 'json':
 724             print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
 725         print_checklist(mode, config_checklist, False)
 726         sys.exit(0)
 727
 728     parser.print_help()
 729     sys.exit(0)
 730
 731 if __name__ == '__main__':
 732     main()