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