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