kconfig_hardened_check/__init__.py

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