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