kconfig_hardened_check/__init__.py

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