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(l, 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     l += [OptCheck('self_protection', 'defconfig', 'BUG', 'y')]
 278     l += [OptCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
 279     l += [OptCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
 280     l += [OR(OptCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
 281              OptCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
 282     l += [OR(OptCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
 283              OptCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
 284     l += [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     l += [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')
 290     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
 291     if arch in ('X86_64', 'X86_32'):
 292         l += [OptCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
 293         l += [OptCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
 294         l += [OptCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
 295         l += [OptCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
 296         l += [OR(OptCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
 297                  OptCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
 298     if arch == 'X86_64':
 299         l += [OptCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
 300         l += [OptCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
 301         l += [AND(OptCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
 302                   iommu_support_is_set)]
 303         l += [AND(OptCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
 304                   iommu_support_is_set)]
 305     if arch == 'ARM64':
 306         l += [OptCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
 307         l += [OptCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
 308         l += [OptCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y')]
 309         l += [OptCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
 310         l += [OptCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
 311     if arch in ('X86_64', 'ARM64'):
 312         l += [OptCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
 313     if arch in ('X86_64', 'ARM64', 'X86_32'):
 314         l += [OptCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
 315         l += [OptCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
 316     if arch == 'ARM':
 317         l += [OptCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
 318         l += [OptCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
 319     if arch in ('ARM64', 'ARM'):
 320         l += [OptCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
 321
 322     # 'self_protection', 'kspp'
 323     l += [OptCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
 324     l += [OptCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
 325     l += [OptCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
 326     l += [OptCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
 327     l += [OptCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
 328     l += [OptCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
 329     l += [OptCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
 330     l += [OptCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
 331     l += [OptCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
 332     l += [OptCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
 333     l += [OptCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
 334     l += [OptCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
 335     l += [OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
 336     randstruct_is_set = OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
 337     l += [randstruct_is_set]
 338     hardened_usercopy_is_set = OptCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
 339     l += [hardened_usercopy_is_set]
 340     l += [AND(OptCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
 341               hardened_usercopy_is_set)]
 342     l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
 343              modules_not_set)]
 344     l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
 345              modules_not_set)]
 346     l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
 347              modules_not_set)]
 348     l += [OR(OptCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
 349              modules_not_set)] # refers to LOCKDOWN
 350     l += [OR(OptCheck('self_protection', 'kspp', 'INIT_STACK_ALL', 'y'),
 351              OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
 352     l += [OR(OptCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
 353              OptCheck('self_protection', 'kspp', 'PAGE_POISONING', 'y'))] # before v5.3
 354     if arch in ('X86_64', 'ARM64', 'X86_32'):
 355         stackleak_is_set = OptCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
 356         l += [stackleak_is_set]
 357     if arch in ('X86_64', 'X86_32'):
 358         l += [OptCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
 359     if arch == 'X86_32':
 360         l += [OptCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
 361         l += [OptCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
 362         l += [OptCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
 363     if arch == 'ARM64':
 364         l += [OptCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
 365     if arch in ('ARM64', 'ARM'):
 366         l += [OptCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
 367         l += [OptCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
 368
 369     # 'self_protection', 'clipos'
 370     l += [OptCheck('self_protection', 'clipos', 'SECURITY_DMESG_RESTRICT', 'y')]
 371     l += [OptCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
 372     l += [OptCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
 373     l += [OptCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')] # slab_nomerge
 374     l += [OptCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
 375     l += [OptCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
 376     l += [AND(OptCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
 377               randstruct_is_set)]
 378     if arch in ('X86_64', 'ARM64', 'X86_32'):
 379         l += [AND(OptCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
 380                   stackleak_is_set)]
 381         l += [AND(OptCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
 382                   stackleak_is_set)]
 383     if arch in ('X86_64', 'X86_32'):
 384         l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
 385                   iommu_support_is_set)]
 386         l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
 387                   iommu_support_is_set)]
 388     if arch == 'X86_32':
 389         l += [AND(OptCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
 390                   iommu_support_is_set)]
 391
 392     # 'self_protection', 'my'
 393     l += [OptCheck('self_protection', 'my', 'SLUB_DEBUG_ON', 'y')]
 394     l += [OptCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y')] # needs userspace support (systemd)
 395     if arch == 'X86_64':
 396         l += [AND(OptCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
 397                   iommu_support_is_set)]
 398
 399     # 'security_policy'
 400     if arch in ('X86_64', 'ARM64', 'X86_32'):
 401         l += [OptCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
 402     if arch == 'ARM':
 403         l += [OptCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
 404     l += [OptCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
 405     l += [OR(OptCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
 406              OptCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
 407     l += [OptCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
 408     l += [OptCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
 409     l += [OptCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
 410     l += [OptCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
 411     loadpin_is_set = OptCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
 412     l += [loadpin_is_set] # needs userspace support
 413     l += [AND(OptCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
 414               loadpin_is_set)]
 415
 416     # 'cut_attack_surface', 'defconfig'
 417     l += [OptCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
 418     l += [OptCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
 419     if arch in ('X86_64', 'ARM64', 'X86_32'):
 420         l += [OR(OptCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
 421                  devmem_not_set)] # refers to LOCKDOWN
 422
 423     # 'cut_attack_surface', 'kspp'
 424     l += [OptCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
 425     l += [OptCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
 426     l += [OptCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
 427     l += [OptCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
 428     l += [OptCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
 429     l += [OptCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
 430     l += [OptCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
 431     l += [OptCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
 432     l += [OptCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
 433     l += [OptCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
 434     l += [OptCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
 435     l += [OptCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
 436     l += [OptCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
 437     l += [OptCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
 438     l += [modules_not_set]
 439     l += [devmem_not_set]
 440     l += [OR(OptCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
 441              devmem_not_set)] # refers to LOCKDOWN
 442     if arch == 'ARM':
 443         l += [OR(OptCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
 444                  devmem_not_set)] # refers to LOCKDOWN
 445     if arch == 'X86_64':
 446         l += [OptCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
 447
 448     # 'cut_attack_surface', 'grsecurity'
 449     l += [OptCheck('cut_attack_surface', 'grsecurity', 'X86_PTDUMP', 'is not set')]
 450     l += [OptCheck('cut_attack_surface', 'grsecurity', 'ZSMALLOC_STAT', 'is not set')]
 451     l += [OptCheck('cut_attack_surface', 'grsecurity', 'PAGE_OWNER', 'is not set')]
 452     l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEBUG_KMEMLEAK', 'is not set')]
 453     l += [OptCheck('cut_attack_surface', 'grsecurity', 'BINFMT_AOUT', 'is not set')]
 454     l += [OptCheck('cut_attack_surface', 'grsecurity', 'KPROBES', 'is not set')] # refers to LOCKDOWN
 455     l += [OptCheck('cut_attack_surface', 'grsecurity', 'UPROBES', 'is not set')]
 456     l += [OptCheck('cut_attack_surface', 'grsecurity', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
 457     l += [OptCheck('cut_attack_surface', 'grsecurity', 'PROC_VMCORE', 'is not set')]
 458     l += [OptCheck('cut_attack_surface', 'grsecurity', 'PROC_PAGE_MONITOR', 'is not set')]
 459     l += [OptCheck('cut_attack_surface', 'grsecurity', 'USELIB', 'is not set')]
 460     l += [OptCheck('cut_attack_surface', 'grsecurity', 'CHECKPOINT_RESTORE', 'is not set')]
 461     l += [OptCheck('cut_attack_surface', 'grsecurity', 'USERFAULTFD', 'is not set')]
 462     l += [OptCheck('cut_attack_surface', 'grsecurity', 'HWPOISON_INJECT', 'is not set')]
 463     l += [OptCheck('cut_attack_surface', 'grsecurity', 'MEM_SOFT_DIRTY', 'is not set')]
 464     l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
 465     l += [OptCheck('cut_attack_surface', 'grsecurity', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
 466     l += [OptCheck('cut_attack_surface', 'grsecurity', 'NOTIFIER_ERROR_INJECTION','is not set')]
 467
 468     # 'cut_attack_surface', 'maintainer'
 469     l += [OptCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')]
 470     l += [OptCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')]
 471     l += [OptCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')]
 472
 473     # 'cut_attack_surface', 'lockdown'
 474     l += [OptCheck('cut_attack_surface', 'lockdown', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
 475     l += [OptCheck('cut_attack_surface', 'lockdown', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
 476     l += [OptCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
 477     l += [OptCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set')] # refers to LOCKDOWN
 478     l += [OptCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
 479
 480     # 'cut_attack_surface', 'clipos'
 481     l += [OptCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
 482     l += [OptCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
 483 #   l += [OptCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
 484     l += [OptCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
 485     l += [OptCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
 486     l += [OptCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
 487     l += [OptCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
 488     l += [OptCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
 489     l += [OptCheck('cut_attack_surface', 'clipos', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
 490     l += [OptCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
 491     l += [AND(OptCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
 492               PresenceCheck('LDISC_AUTOLOAD'))]
 493     if arch in ('X86_64', 'X86_32'):
 494         l += [OptCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
 495
 496     # 'cut_attack_surface', 'grapheneos'
 497     l += [OptCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
 498
 499     # 'cut_attack_surface', 'my'
 500     l += [OptCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
 501     l += [OptCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
 502     l += [OptCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
 503     l += [OptCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
 504     l += [OptCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
 505     l += [OptCheck('cut_attack_surface', 'my', 'BPF_JIT', 'is not set')]
 506     l += [OptCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
 507     l += [OptCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
 508
 509     # 'userspace_hardening'
 510     l += [OptCheck('userspace_hardening', 'defconfig', 'INTEGRITY', 'y')]
 511     if arch in ('ARM', 'X86_32'):
 512         l += [OptCheck('userspace_hardening', 'defconfig', 'VMSPLIT_3G', 'y')]
 513     if arch in ('X86_64', 'ARM64'):
 514         l += [OptCheck('userspace_hardening', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
 515     if arch in ('X86_32', 'ARM'):
 516         l += [OptCheck('userspace_hardening', 'my', 'ARCH_MMAP_RND_BITS', '16')]
 517
 518 #   l += [OptCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
 519
 520
 521 def print_checklist(checklist, with_results):
 522     if json_mode:
 523         opts = []
 524         for o in checklist:
 525             opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
 526             if with_results:
 527                 opt.append(o.result)
 528             opts.append(opt)
 529         print(json.dumps(opts))
 530         return
 531
 532     # table header
 533     sep_line_len = 91
 534     if with_results:
 535         sep_line_len += 30
 536     print('=' * sep_line_len)
 537     print('{:^45}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
 538     if with_results:
 539         print('|   {}'.format('check result'), end='')
 540     print()
 541     print('=' * sep_line_len)
 542
 543     # table contents
 544     for opt in checklist:
 545         opt.table_print(with_results)
 546         print()
 547         if debug_mode:
 548             print('-' * sep_line_len)
 549     print()
 550
 551
 552 def perform_checks(checklist, parsed_options):
 553     for opt in checklist:
 554         if hasattr(opt, 'opts'):
 555             # prepare ComplexOptCheck
 556             for o in opt.opts:
 557                 if hasattr(o, 'state'):
 558                     o.state = parsed_options.get(o.name, None)
 559         else:
 560             # prepare simple check
 561             if not hasattr(opt, 'state'):
 562                 sys.exit('[!] ERROR: bad simple check {}'.format(vars(opt)))
 563             opt.state = parsed_options.get(opt.name, None)
 564         opt.check()
 565
 566
 567 def check_config_file(checklist, fname, arch):
 568     with open(fname, 'r') as f:
 569         parsed_options = OrderedDict()
 570         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 571         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 572
 573         if not json_mode:
 574             print('[+] Checking "{}" against {} hardening preferences...'.format(fname, arch))
 575         for line in f.readlines():
 576             line = line.strip()
 577             option = None
 578             value = None
 579
 580             if opt_is_on.match(line):
 581                 option, value = line[7:].split('=', 1)
 582             elif opt_is_off.match(line):
 583                 option, value = line[9:].split(' ', 1)
 584                 if value != 'is not set':
 585                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 586
 587             if option in parsed_options:
 588                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 589
 590             if option is not None:
 591                 parsed_options[option] = value
 592
 593         perform_checks(checklist, parsed_options)
 594
 595         if debug_mode:
 596             known_options = []
 597             for opt in checklist:
 598                 if hasattr(opt, 'opts'):
 599                     for o in opt.opts:
 600                         if hasattr(o, 'name'):
 601                             known_options.append(o.name)
 602                 else:
 603                     known_options.append(opt.name)
 604             for option, value in parsed_options.items():
 605                 if option not in known_options:
 606                     print('DEBUG: dunno about option {} ({})'.format(option, value))
 607
 608         print_checklist(checklist, True)
 609
 610 def main():
 611     global debug_mode
 612     global json_mode
 613     global kernel_version
 614
 615     config_checklist = []
 616
 617     parser = ArgumentParser(prog='kconfig-hardened-check',
 618                             description='Checks the hardening options in the Linux kernel config')
 619     parser.add_argument('-p', '--print', choices=supported_archs,
 620                         help='print hardening preferences for selected architecture')
 621     parser.add_argument('-c', '--config',
 622                         help='check the config_file against these preferences')
 623     parser.add_argument('--debug', action='store_true',
 624                         help='enable verbose debug mode')
 625     parser.add_argument('--json', action='store_true',
 626                         help='print results in JSON format')
 627     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
 628     args = parser.parse_args()
 629
 630     if args.debug:
 631         debug_mode = True
 632         print('[!] WARNING: debug mode is enabled')
 633     if args.json:
 634         json_mode = True
 635     if debug_mode and json_mode:
 636         sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
 637
 638     if args.config:
 639         arch, msg = detect_arch(args.config)
 640         if not arch:
 641             sys.exit('[!] ERROR: {}'.format(msg))
 642         elif not json_mode:
 643             print('[+] Detected architecture: {}'.format(arch))
 644
 645         kernel_version, msg = detect_version(args.config)
 646         if not kernel_version:
 647             sys.exit('[!] ERROR: {}'.format(msg))
 648         elif not json_mode:
 649             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
 650
 651         construct_checklist(config_checklist, arch)
 652         check_config_file(config_checklist, args.config, arch)
 653         error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
 654         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
 655         if not debug_mode and not json_mode:
 656             print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
 657         sys.exit(0)
 658
 659     if args.print:
 660         arch = args.print
 661         construct_checklist(config_checklist, arch)
 662         if not json_mode:
 663             print('[+] Printing kernel hardening preferences for {}...'.format(arch))
 664         print_checklist(config_checklist, False)
 665         sys.exit(0)
 666
 667     parser.print_help()
 668     sys.exit(0)
 669
 670 if __name__ == '__main__':
 671     main()