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