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