kconfig-hardened-check.py

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