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