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