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     if debug_mode or arch == 'X86_64' or arch == 'ARM64':
 196         checklist.append(OptCheck('VMAP_STACK',                  'y', 'defconfig', 'self_protection'))
 197     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 198         checklist.append(OptCheck('THREAD_INFO_IN_TASK',         'y', 'defconfig', 'self_protection'))
 199     if debug_mode or arch == 'ARM':
 200         checklist.append(OptCheck('VMSPLIT_3G',                  'y', 'defconfig', 'self_protection'))
 201         checklist.append(OptCheck('CPU_SW_DOMAIN_PAN',           'y', 'defconfig', 'self_protection'))
 202     if debug_mode or arch == 'ARM64' or arch == 'ARM':
 203         checklist.append(OptCheck('REFCOUNT_FULL',               'y', 'defconfig', 'self_protection'))
 204         checklist.append(OptCheck('HARDEN_BRANCH_PREDICTOR',     'y', 'defconfig', 'self_protection'))
 205
 206     checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION',           'y', 'kspp', 'self_protection'))
 207     checklist.append(OptCheck('DEBUG_WX',                         'y', 'kspp', 'self_protection'))
 208     checklist.append(OptCheck('SCHED_STACK_END_CHECK',            'y', 'kspp', 'self_protection'))
 209     checklist.append(OptCheck('SLAB_FREELIST_HARDENED',           'y', 'kspp', 'self_protection'))
 210     checklist.append(OptCheck('SLAB_FREELIST_RANDOM',             'y', 'kspp', 'self_protection'))
 211     checklist.append(OptCheck('SHUFFLE_PAGE_ALLOCATOR',           'y', 'kspp', 'self_protection'))
 212     checklist.append(OptCheck('FORTIFY_SOURCE',                   'y', 'kspp', 'self_protection'))
 213     checklist.append(OptCheck('GCC_PLUGINS',                      'y', 'kspp', 'self_protection'))
 214     randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT',         'y', 'kspp', 'self_protection')
 215     checklist.append(randstruct_is_set)
 216     checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY',        'y', 'kspp', 'self_protection'))
 217     checklist.append(OptCheck('DEBUG_LIST',                       'y', 'kspp', 'self_protection'))
 218     checklist.append(OptCheck('DEBUG_SG',                         'y', 'kspp', 'self_protection'))
 219     checklist.append(OptCheck('DEBUG_CREDENTIALS',                'y', 'kspp', 'self_protection'))
 220     checklist.append(OptCheck('DEBUG_NOTIFIERS',                  'y', 'kspp', 'self_protection'))
 221     page_poisoning_is_set = OptCheck('PAGE_POISONING',            'y', 'kspp', 'self_protection')
 222     checklist.append(page_poisoning_is_set)
 223     hardened_usercopy_is_set = OptCheck('HARDENED_USERCOPY',      'y', 'kspp', 'self_protection')
 224     checklist.append(hardened_usercopy_is_set)
 225     checklist.append(AND(OptCheck('HARDENED_USERCOPY_FALLBACK',   'is not set', 'kspp', 'self_protection'), \
 226                          hardened_usercopy_is_set))
 227     checklist.append(OR(OptCheck('MODULE_SIG',                    'y', 'kspp', 'self_protection'), \
 228                         modules_not_set))
 229     checklist.append(OR(OptCheck('MODULE_SIG_ALL',                'y', 'kspp', 'self_protection'), \
 230                         modules_not_set))
 231     checklist.append(OR(OptCheck('MODULE_SIG_SHA512',             'y', 'kspp', 'self_protection'), \
 232                         modules_not_set))
 233     checklist.append(OR(OptCheck('MODULE_SIG_FORCE',              'y', 'kspp', 'self_protection'), \
 234                         modules_not_set)) # refers to LOCK_DOWN_KERNEL
 235     if debug_mode or arch == 'X86_64' or arch == 'X86_32':
 236         checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR',            '65536', 'kspp', 'self_protection'))
 237         checklist.append(OptCheck('REFCOUNT_FULL',                    'y', 'kspp', 'self_protection'))
 238     if debug_mode or arch == 'X86_32':
 239         checklist.append(OptCheck('HIGHMEM64G',                       'y', 'kspp', 'self_protection'))
 240         checklist.append(OptCheck('X86_PAE',                          'y', 'kspp', 'self_protection'))
 241     if debug_mode or arch == 'ARM64':
 242         checklist.append(OptCheck('ARM64_SW_TTBR0_PAN',               'y', 'kspp', 'self_protection'))
 243         checklist.append(OptCheck('RANDOMIZE_BASE',                   'y', 'kspp', 'self_protection'))
 244     if debug_mode or arch == 'ARM64' or arch == 'ARM':
 245         checklist.append(OptCheck('SYN_COOKIES',                      'y', 'kspp', 'self_protection')) # another reason?
 246         checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR',            '32768', 'kspp', 'self_protection'))
 247
 248     checklist.append(OptCheck('LOCK_DOWN_KERNEL',                      'y', 'clipos', 'self_protection')) # remember about LOCK_DOWN_MANDATORY
 249     checklist.append(OptCheck('SECURITY_DMESG_RESTRICT',               'y', 'clipos', 'self_protection'))
 250     checklist.append(OptCheck('DEBUG_VIRTUAL',                         'y', 'clipos', 'self_protection'))
 251     checklist.append(OptCheck('STATIC_USERMODEHELPER',                 'y', 'clipos', 'self_protection')) # needs userspace support (systemd)
 252     checklist.append(OptCheck('SLAB_MERGE_DEFAULT',                    'is not set', 'clipos', 'self_protection')) # slab_nomerge
 253     checklist.append(AND(OptCheck('GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set', 'clipos', 'self_protection'), \
 254                          randstruct_is_set))
 255     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 256         stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK',                'y', 'clipos', 'self_protection')
 257         checklist.append(stackleak_is_set)
 258         checklist.append(AND(OptCheck('STACKLEAK_METRICS',                 'is not set', 'clipos', 'self_protection'), \
 259                              stackleak_is_set))
 260         checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE',         'is not set', 'clipos', 'self_protection'), \
 261                              stackleak_is_set))
 262     if debug_mode or arch == 'X86_64' or arch == 'X86_32':
 263         checklist.append(OptCheck('RANDOM_TRUST_CPU',                      'is not set', 'clipos', 'self_protection'))
 264         checklist.append(OptCheck('MICROCODE',                             'y', 'clipos', 'self_protection')) # is needed for mitigating CPU bugs
 265         iommu_support_is_set = OptCheck('IOMMU_SUPPORT',                   'y', 'clipos', 'self_protection') # is needed for mitigating DMA attacks
 266         checklist.append(iommu_support_is_set)
 267         checklist.append(AND(OptCheck('INTEL_IOMMU',                       'y', 'clipos', 'self_protection'), \
 268                              iommu_support_is_set))
 269         checklist.append(AND(OptCheck('INTEL_IOMMU_SVM',                   'y', 'clipos', 'self_protection'), \
 270                              iommu_support_is_set))
 271         checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON',            'y', 'clipos', 'self_protection'), \
 272                              iommu_support_is_set))
 273
 274     checklist.append(OR(OptCheck('INIT_STACK_ALL',                  'y', 'my', 'self_protection'), \
 275                         OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y', 'kspp', 'self_protection')))
 276     checklist.append(OptCheck('SLUB_DEBUG_ON',                      'y', 'my', 'self_protection'))
 277     checklist.append(OptCheck('SECURITY_LOADPIN',                   'y', 'my', 'self_protection')) # needs userspace support
 278     checklist.append(OptCheck('RESET_ATTACK_MITIGATION',            'y', 'my', 'self_protection')) # needs userspace support (systemd)
 279     checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY',       'is not set', 'my', 'self_protection'), \
 280                          page_poisoning_is_set))
 281     checklist.append(AND(OptCheck('PAGE_POISONING_ZERO',            'is not set', 'my', 'self_protection'), \
 282                          page_poisoning_is_set))
 283     if debug_mode or arch == 'X86_64':
 284         checklist.append(AND(OptCheck('AMD_IOMMU',                      'y', 'my', 'self_protection'), \
 285                              iommu_support_is_set))
 286         checklist.append(AND(OptCheck('AMD_IOMMU_V2',                   'y', 'my', 'self_protection'), \
 287                              iommu_support_is_set))
 288     if debug_mode or arch == 'X86_32':
 289         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',               'y', 'my', 'self_protection'))
 290     if debug_mode or arch == 'ARM':
 291         checklist.append(OptCheck('STACKPROTECTOR_PER_TASK',            'y', 'my', 'self_protection'))
 292
 293     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 294         checklist.append(OptCheck('SECURITY',             'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
 295     if debug_mode or arch == 'ARM':
 296         checklist.append(OptCheck('SECURITY',             'y', 'kspp', 'security_policy')) # and choose your favourite LSM
 297     checklist.append(OptCheck('SECURITY_YAMA',        'y', 'kspp', 'security_policy'))
 298
 299     checklist.append(OptCheck('SECCOMP',              'y', 'defconfig', 'cut_attack_surface'))
 300     checklist.append(OptCheck('SECCOMP_FILTER',       'y', 'defconfig', 'cut_attack_surface'))
 301     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 302         checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'defconfig', 'cut_attack_surface'), \
 303                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 304
 305     checklist.append(modules_not_set)
 306     checklist.append(devmem_not_set)
 307     checklist.append(OR(OptCheck('IO_STRICT_DEVMEM',  'y', 'kspp', 'cut_attack_surface'), \
 308                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 309     if debug_mode or arch == 'ARM':
 310         checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'kspp', 'cut_attack_surface'), \
 311                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 312     checklist.append(OptCheck('ACPI_CUSTOM_METHOD',   'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 313     checklist.append(OptCheck('COMPAT_BRK',           'is not set', 'kspp', 'cut_attack_surface'))
 314     checklist.append(OptCheck('DEVKMEM',              'is not set', 'kspp', 'cut_attack_surface'))
 315     checklist.append(OptCheck('COMPAT_VDSO',          'is not set', 'kspp', 'cut_attack_surface'))
 316     checklist.append(OptCheck('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'))
 317     checklist.append(OptCheck('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'))
 318     checklist.append(OptCheck('KEXEC',                'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 319     checklist.append(OptCheck('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 320     checklist.append(OptCheck('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'))
 321     checklist.append(OptCheck('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 322     if debug_mode or arch == 'X86_64':
 323         checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
 324         checklist.append(OptCheck('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'))
 325         checklist.append(OptCheck('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'))
 326         checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'))
 327     if debug_mode or arch == 'ARM':
 328         checklist.append(OptCheck('OABI_COMPAT',          'is not set', 'kspp', 'cut_attack_surface'))
 329
 330     checklist.append(OptCheck('X86_PTDUMP',              'is not set', 'grsecurity', 'cut_attack_surface'))
 331     checklist.append(OptCheck('ZSMALLOC_STAT',           'is not set', 'grsecurity', 'cut_attack_surface'))
 332     checklist.append(OptCheck('PAGE_OWNER',              'is not set', 'grsecurity', 'cut_attack_surface'))
 333     checklist.append(OptCheck('DEBUG_KMEMLEAK',          'is not set', 'grsecurity', 'cut_attack_surface'))
 334     checklist.append(OptCheck('BINFMT_AOUT',             'is not set', 'grsecurity', 'cut_attack_surface'))
 335     checklist.append(OptCheck('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 336     checklist.append(OptCheck('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'))
 337     checklist.append(OptCheck('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'))
 338     checklist.append(OptCheck('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'))
 339     checklist.append(OptCheck('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'))
 340     checklist.append(OptCheck('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'))
 341     checklist.append(OptCheck('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'))
 342     checklist.append(OptCheck('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'))
 343     checklist.append(OptCheck('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'))
 344     checklist.append(OptCheck('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'))
 345     checklist.append(OptCheck('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 346     checklist.append(OptCheck('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 347     checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
 348
 349     checklist.append(OptCheck('ACPI_TABLE_UPGRADE',   'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 350     checklist.append(OptCheck('ACPI_APEI_EINJ',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 351     checklist.append(OptCheck('PROFILING',            'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 352     checklist.append(OptCheck('BPF_SYSCALL',          'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 353     checklist.append(OptCheck('MMIOTRACE_TEST',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 354
 355     checklist.append(OptCheck('KSM',                      'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
 356     checklist.append(OptCheck('IKCONFIG',                 'is not set', 'clipos', 'cut_attack_surface'))
 357     checklist.append(OptCheck('KALLSYMS',                 'is not set', 'clipos', 'cut_attack_surface'))
 358     checklist.append(OptCheck('X86_VSYSCALL_EMULATION',   'is not set', 'clipos', 'cut_attack_surface'))
 359     checklist.append(OptCheck('MAGIC_SYSRQ',              'is not set', 'clipos', 'cut_attack_surface'))
 360     checklist.append(OptCheck('KEXEC_FILE',               'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 361     checklist.append(OptCheck('USER_NS',                  'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
 362     checklist.append(OptCheck('LDISC_AUTOLOAD',           'is not set', 'clipos', 'cut_attack_surface'))
 363
 364     checklist.append(OptCheck('MMIOTRACE',            'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 365     checklist.append(OptCheck('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'))
 366     checklist.append(OptCheck('IP_DCCP',              'is not set', 'my', 'cut_attack_surface'))
 367     checklist.append(OptCheck('IP_SCTP',              'is not set', 'my', 'cut_attack_surface'))
 368     checklist.append(OptCheck('FTRACE',               'is not set', 'my', 'cut_attack_surface'))
 369     checklist.append(OptCheck('BPF_JIT',              'is not set', 'my', 'cut_attack_surface'))
 370     if debug_mode or arch == 'X86_32':
 371         checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'my', 'cut_attack_surface'))
 372
 373     if debug_mode or arch == 'ARM64':
 374         checklist.append(OptCheck('ARM64_PTR_AUTH',       'y', 'defconfig', 'userspace_protection'))
 375     if debug_mode or arch == 'X86_64' or arch == 'ARM64':
 376         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '32', 'clipos', 'userspace_protection'))
 377     if debug_mode or arch == 'X86_32' or arch == 'ARM':
 378         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '16', 'my', 'userspace_protection'))
 379
 380 #   checklist.append(OptCheck('LKDTM',    'm', 'my', 'feature_test'))
 381
 382
 383 def print_checklist(checklist, with_results):
 384     if json_mode:
 385         opts = []
 386         for o in checklist:
 387             opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
 388             if with_results:
 389                 opt.append(o.result)
 390             opts.append(opt)
 391         print(json.dumps(opts))
 392         return
 393
 394     # header
 395     print('{:^40}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
 396     sep_line_len = 86
 397     if with_results:
 398         print('||{:^28}'.format('check result'), end='')
 399         sep_line_len += 30
 400     print()
 401
 402     print('=' * sep_line_len)
 403
 404     for opt in checklist:
 405         print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
 406         if with_results:
 407             print('||{:^28}'.format(opt.result), end='')
 408         print()
 409     print()
 410
 411
 412 def get_option_state(options, name):
 413     return options.get(name, None)
 414
 415
 416 def perform_checks(checklist, parsed_options):
 417     for opt in checklist:
 418         if hasattr(opt, 'opts'):
 419             for o in opt.opts:
 420                 o.state = get_option_state(parsed_options, o.name)
 421         else:
 422             opt.state = get_option_state(parsed_options, opt.name)
 423         opt.check()
 424
 425
 426 def check_config_file(checklist, fname):
 427     with open(fname, 'r') as f:
 428         parsed_options = OrderedDict()
 429         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 430         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 431
 432         if not json_mode:
 433             print('[+] Checking "{}" against hardening preferences...'.format(fname))
 434         for line in f.readlines():
 435             line = line.strip()
 436             option = None
 437             value = None
 438
 439             if opt_is_on.match(line):
 440                 option, value = line[7:].split('=', 1)
 441             elif opt_is_off.match(line):
 442                 option, value = line[9:].split(' ', 1)
 443                 if value != 'is not set':
 444                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 445
 446             if option in parsed_options:
 447                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 448
 449             if option is not None:
 450                 parsed_options[option] = value
 451
 452         perform_checks(checklist, parsed_options)
 453
 454         if debug_mode:
 455             known_options = [opt.name for opt in checklist]
 456             for option, value in parsed_options.items():
 457                 if option not in known_options:
 458                     print("DEBUG: dunno about option {} ({})".format(option, value))
 459
 460         print_checklist(checklist, True)
 461
 462
 463 if __name__ == '__main__':
 464     config_checklist = []
 465
 466     parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
 467     parser.add_argument('-p', '--print', choices=supported_archs,
 468                         help='print hardening preferences for selected architecture')
 469     parser.add_argument('-c', '--config',
 470                         help='check the config_file against these preferences')
 471     parser.add_argument('--debug', action='store_true',
 472                         help='enable internal debug mode')
 473     parser.add_argument('--json', action='store_true',
 474                         help='print results in JSON format')
 475     args = parser.parse_args()
 476
 477     if args.debug:
 478         debug_mode = True
 479     if args.json:
 480         json_mode = True
 481     if debug_mode and json_mode:
 482         sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
 483
 484     if args.config:
 485         arch, msg = detect_arch(args.config)
 486         if not arch:
 487             sys.exit('[!] ERROR: {}'.format(msg))
 488         elif not json_mode:
 489             print('[+] Detected architecture: {}'.format(arch))
 490
 491         construct_checklist(config_checklist, arch)
 492         check_config_file(config_checklist, args.config)
 493         error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
 494         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
 495         if debug_mode:
 496             sys.exit(0)
 497         if not json_mode:
 498             print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
 499         sys.exit(0)
 500
 501     if args.print:
 502         arch = args.print
 503         construct_checklist(config_checklist, arch)
 504         if not json_mode:
 505             print('[+] Printing kernel hardening preferences for {}...'.format(arch))
 506         print_checklist(config_checklist, False)
 507         sys.exit(0)
 508
 509     parser.print_help()