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