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