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 #           ? CONFIG_HARDEN_BRANCH_PREDICTOR
  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
  41 #    kernel.unprivileged_bpf_disabled=1
  42
  43 import sys
  44 from argparse import ArgumentParser
  45 from collections import OrderedDict
  46 import re
  47 import json
  48
  49 debug_mode = False  # set it to True to print the unknown options from the config
  50 json_mode = False   # if True, print results in JSON format
  51
  52 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
  53
  54
  55 class OptCheck:
  56     def __init__(self, name, expected, decision, reason):
  57         self.name = name
  58         self.expected = expected
  59         self.decision = decision
  60         self.reason = reason
  61         self.state = None
  62         self.result = None
  63
  64     def check(self):
  65         if self.expected == self.state:
  66             self.result = 'OK'
  67         elif self.state is None:
  68             if self.expected == 'is not set':
  69                 self.result = 'OK: not found'
  70             else:
  71                 self.result = 'FAIL: not found'
  72         else:
  73             self.result = 'FAIL: "' + self.state + '"'
  74
  75         if self.result.startswith('OK'):
  76             return True, self.result
  77         else:
  78             return False, self.result
  79
  80     def __repr__(self):
  81         return '{} = {}'.format(self.name, self.state)
  82
  83
  84 class ComplexOptCheck:
  85     def __init__(self, *opts):
  86         self.opts = opts
  87         self.result = None
  88
  89     @property
  90     def name(self):
  91         return self.opts[0].name
  92
  93     @property
  94     def expected(self):
  95         return self.opts[0].expected
  96
  97     @property
  98     def state(self):
  99         return self.opts[0].state
 100
 101     @property
 102     def decision(self):
 103         return self.opts[0].decision
 104
 105     @property
 106     def reason(self):
 107         return self.opts[0].reason
 108
 109
 110 class OR(ComplexOptCheck):
 111     # self.opts[0] is the option which this OR-check is about.
 112     # Use case:
 113     #     OR(<X_is_hardened>, <X_is_disabled>)
 114     #     OR(<X_is_hardened>, <X_is_hardened_old>)
 115
 116     def check(self):
 117         if not self.opts:
 118             sys.exit('[!] ERROR: invalid OR check')
 119
 120         for i, opt in enumerate(self.opts):
 121             ret, msg = opt.check()
 122             if ret:
 123                 if i == 0:
 124                     self.result = opt.result
 125                 else:
 126                     self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
 127                 return True, self.result
 128         self.result = self.opts[0].result
 129         return False, self.result
 130
 131
 132 class AND(ComplexOptCheck):
 133     # self.opts[0] is the option which this AND-check is about.
 134     # Use case: AND(<suboption>, <main_option>)
 135     # Suboption is not checked if checking of the main_option is failed.
 136
 137     def check(self):
 138         for i, opt in reversed(list(enumerate(self.opts))):
 139             ret, msg = opt.check()
 140             if i == 0:
 141                 self.result = opt.result
 142                 return ret, self.result
 143             elif not ret:
 144                 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
 145                 return False, self.result
 146
 147         sys.exit('[!] ERROR: invalid AND check')
 148
 149
 150 def detect_arch(fname):
 151     with open(fname, 'r') as f:
 152         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 153         arch = None
 154         msg = None
 155         if not json_mode:
 156             print('[+] Trying to detect architecture in "{}"...'.format(fname))
 157         for line in f.readlines():
 158             if arch_pattern.match(line):
 159                 option, value = line[7:].split('=', 1)
 160                 if option in supported_archs:
 161                     if not arch:
 162                         arch = option
 163                     else:
 164                         return None, 'more than one supported architecture is detected'
 165         if not arch:
 166             return None, 'failed to detect architecture'
 167         else:
 168             return arch, 'OK'
 169
 170
 171 def construct_checklist(checklist, arch):
 172     modules_not_set = OptCheck('MODULES',                'is not set', 'kspp', 'cut_attack_surface')
 173     devmem_not_set = OptCheck('DEVMEM',                  'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
 174
 175     checklist.append(OptCheck('BUG',                         'y', 'defconfig', 'self_protection'))
 176     checklist.append(OR(OptCheck('STRICT_KERNEL_RWX',        'y', 'defconfig', 'self_protection'), \
 177                         OptCheck('DEBUG_RODATA',             'y', 'defconfig', 'self_protection'))) # before v4.11
 178     checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG',    'y', 'defconfig', 'self_protection'), \
 179                         OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'defconfig', 'self_protection')))
 180     checklist.append(OptCheck('SLUB_DEBUG',                  'y', 'defconfig', 'self_protection'))
 181     checklist.append(OR(OptCheck('STRICT_MODULE_RWX',        'y', 'defconfig', 'self_protection'), \
 182                         OptCheck('DEBUG_SET_MODULE_RONX',    'y', 'defconfig', 'self_protection'), \
 183                         modules_not_set)) # DEBUG_SET_MODULE_RONX was before v4.11
 184     if debug_mode or arch == 'X86_64':
 185         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',    'y', 'defconfig', 'self_protection'))
 186         checklist.append(OptCheck('RANDOMIZE_MEMORY',        'y', 'defconfig', 'self_protection'))
 187     if debug_mode or arch == 'X86_64' or arch == 'X86_32':
 188         checklist.append(OptCheck('RANDOMIZE_BASE',              'y', 'defconfig', 'self_protection'))
 189         checklist.append(OptCheck('RETPOLINE',                   'y', 'defconfig', 'self_protection'))
 190         checklist.append(OptCheck('X86_SMAP',                    'y', 'defconfig', 'self_protection'))
 191         checklist.append(OptCheck('X86_INTEL_UMIP',              'y', 'defconfig', 'self_protection'))
 192         checklist.append(OptCheck('SYN_COOKIES',                 'y', 'defconfig', 'self_protection')) # another reason?
 193     if debug_mode or arch == 'ARM64':
 194         checklist.append(OptCheck('UNMAP_KERNEL_AT_EL0',         '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
 205     checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION',           'y', 'kspp', 'self_protection'))
 206     checklist.append(OptCheck('DEBUG_WX',                         'y', 'kspp', 'self_protection'))
 207     checklist.append(OptCheck('SCHED_STACK_END_CHECK',            'y', 'kspp', 'self_protection'))
 208     checklist.append(OptCheck('SLAB_FREELIST_HARDENED',           'y', 'kspp', 'self_protection'))
 209     checklist.append(OptCheck('SLAB_FREELIST_RANDOM',             'y', 'kspp', 'self_protection'))
 210     checklist.append(OptCheck('FORTIFY_SOURCE',                   'y', 'kspp', 'self_protection'))
 211     checklist.append(OptCheck('GCC_PLUGINS',                      'y', 'kspp', 'self_protection'))
 212     randstruct_is_set = OptCheck('GCC_PLUGIN_RANDSTRUCT',         'y', 'kspp', 'self_protection')
 213     checklist.append(randstruct_is_set)
 214     checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK',            'y', 'kspp', 'self_protection'))
 215     checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL',  'y', 'kspp', 'self_protection'))
 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     if debug_mode or arch == 'X86_64':
 275         checklist.append(AND(OptCheck('AMD_IOMMU',                'y', 'my', 'self_protection'), \
 276                              iommu_support_is_set))
 277         checklist.append(AND(OptCheck('AMD_IOMMU_V2',             'y', 'my', 'self_protection'), \
 278                              iommu_support_is_set))
 279     checklist.append(OptCheck('SLUB_DEBUG_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_32':
 287         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',         'y', 'my', 'self_protection'))
 288     if debug_mode or arch == 'ARM':
 289         checklist.append(OptCheck('STACKPROTECTOR_PER_TASK',      'y', 'my', 'self_protection'))
 290
 291     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 292         checklist.append(OptCheck('SECURITY',                'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
 293     if debug_mode or arch == 'ARM':
 294         checklist.append(OptCheck('SECURITY',                'y', 'kspp', 'security_policy')) # and choose your favourite LSM
 295     checklist.append(OptCheck('SECURITY_YAMA',               'y', 'kspp', 'security_policy'))
 296
 297     checklist.append(OptCheck('SECCOMP',              'y', 'defconfig', 'cut_attack_surface'))
 298     checklist.append(OptCheck('SECCOMP_FILTER',       'y', 'defconfig', 'cut_attack_surface'))
 299     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 300         checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'defconfig', 'cut_attack_surface'), \
 301                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 302
 303     checklist.append(modules_not_set)
 304     checklist.append(devmem_not_set)
 305     checklist.append(OR(OptCheck('IO_STRICT_DEVMEM',  'y', 'kspp', 'cut_attack_surface'), \
 306                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 307     if debug_mode or arch == 'ARM':
 308         checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
 309                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 310     checklist.append(OptCheck('ACPI_CUSTOM_METHOD',   'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 311     checklist.append(OptCheck('COMPAT_BRK',           'is not set', 'kspp', 'cut_attack_surface'))
 312     checklist.append(OptCheck('DEVKMEM',              'is not set', 'kspp', 'cut_attack_surface'))
 313     checklist.append(OptCheck('COMPAT_VDSO',          'is not set', 'kspp', 'cut_attack_surface'))
 314     checklist.append(OptCheck('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'))
 315     checklist.append(OptCheck('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'))
 316     checklist.append(OptCheck('KEXEC',                'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 317     checklist.append(OptCheck('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 318     checklist.append(OptCheck('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'))
 319     checklist.append(OptCheck('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 320     if debug_mode or arch == 'X86_64':
 321         checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
 322         checklist.append(OptCheck('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'))
 323         checklist.append(OptCheck('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'))
 324         checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'))
 325     if debug_mode or arch == 'ARM':
 326         checklist.append(OptCheck('OABI_COMPAT',          'is not set', 'kspp', 'cut_attack_surface'))
 327
 328     checklist.append(OptCheck('X86_PTDUMP',              'is not set', 'grsecurity', 'cut_attack_surface'))
 329     checklist.append(OptCheck('ZSMALLOC_STAT',           'is not set', 'grsecurity', 'cut_attack_surface'))
 330     checklist.append(OptCheck('PAGE_OWNER',              'is not set', 'grsecurity', 'cut_attack_surface'))
 331     checklist.append(OptCheck('DEBUG_KMEMLEAK',          'is not set', 'grsecurity', 'cut_attack_surface'))
 332     checklist.append(OptCheck('BINFMT_AOUT',             'is not set', 'grsecurity', 'cut_attack_surface'))
 333     checklist.append(OptCheck('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 334     checklist.append(OptCheck('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'))
 335     checklist.append(OptCheck('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'))
 336     checklist.append(OptCheck('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'))
 337     checklist.append(OptCheck('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'))
 338     checklist.append(OptCheck('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'))
 339     checklist.append(OptCheck('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'))
 340     checklist.append(OptCheck('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'))
 341     checklist.append(OptCheck('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'))
 342     checklist.append(OptCheck('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'))
 343     checklist.append(OptCheck('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 344     checklist.append(OptCheck('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 345     checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
 346
 347     checklist.append(OptCheck('ACPI_TABLE_UPGRADE',   'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 348     checklist.append(OptCheck('ACPI_APEI_EINJ',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 349     checklist.append(OptCheck('PROFILING',            'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 350     checklist.append(OptCheck('BPF_SYSCALL',          'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 351     checklist.append(OptCheck('MMIOTRACE_TEST',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 352
 353     checklist.append(OptCheck('KSM',                      'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
 354     checklist.append(OptCheck('IKCONFIG',                 'is not set', 'clipos', 'cut_attack_surface'))
 355     checklist.append(OptCheck('KALLSYMS',                 'is not set', 'clipos', 'cut_attack_surface'))
 356     checklist.append(OptCheck('X86_VSYSCALL_EMULATION',   'is not set', 'clipos', 'cut_attack_surface'))
 357     checklist.append(OptCheck('MAGIC_SYSRQ',              'is not set', 'clipos', 'cut_attack_surface'))
 358     checklist.append(OptCheck('KEXEC_FILE',               'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 359     checklist.append(OptCheck('USER_NS',                  'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
 360     checklist.append(OptCheck('LDISC_AUTOLOAD',           'is not set', 'clipos', 'cut_attack_surface'))
 361
 362     checklist.append(OptCheck('MMIOTRACE',            'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 363     checklist.append(OptCheck('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'))
 364     checklist.append(OptCheck('IP_DCCP',              'is not set', 'my', 'cut_attack_surface'))
 365     checklist.append(OptCheck('IP_SCTP',              'is not set', 'my', 'cut_attack_surface'))
 366     checklist.append(OptCheck('FTRACE',               'is not set', 'my', 'cut_attack_surface'))
 367     checklist.append(OptCheck('BPF_JIT',              'is not set', 'my', 'cut_attack_surface'))
 368     if debug_mode or arch == 'X86_32':
 369         checklist.append(OptCheck('MODIFY_LDT_SYSCALL', 'is not set', 'my', 'cut_attack_surface'))
 370
 371     if debug_mode or arch == 'ARM64':
 372         checklist.append(OptCheck('ARM64_PTR_AUTH',       'y', 'defconfig', 'userspace_protection'))
 373     if debug_mode or arch == 'X86_64' or arch == 'ARM64':
 374         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '32', 'clipos', 'userspace_protection'))
 375     if debug_mode or arch == 'X86_32' or arch == 'ARM':
 376         checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '16', 'my', 'userspace_protection'))
 377
 378 #   checklist.append(OptCheck('LKDTM',    'm', 'my', 'feature_test'))
 379
 380
 381 def print_checklist(checklist, with_results):
 382     if json_mode:
 383         opts = []
 384         for o in checklist:
 385             opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
 386             if with_results:
 387                 opt.append(o.result)
 388             opts.append(opt)
 389         print(json.dumps(opts))
 390         return
 391
 392     # header
 393     print('{:^40}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
 394     sep_line_len = 86
 395     if with_results:
 396         print('||{:^28}'.format('check result'), end='')
 397         sep_line_len += 30
 398     print()
 399
 400     print('=' * sep_line_len)
 401
 402     for opt in checklist:
 403         print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
 404         if with_results:
 405             print('||{:^28}'.format(opt.result), end='')
 406         print()
 407     print()
 408
 409
 410 def get_option_state(options, name):
 411     return options.get(name, None)
 412
 413
 414 def perform_checks(checklist, parsed_options):
 415     for opt in checklist:
 416         if hasattr(opt, 'opts'):
 417             for o in opt.opts:
 418                 o.state = get_option_state(parsed_options, o.name)
 419         else:
 420             opt.state = get_option_state(parsed_options, opt.name)
 421         opt.check()
 422
 423
 424 def check_config_file(checklist, fname):
 425     with open(fname, 'r') as f:
 426         parsed_options = OrderedDict()
 427         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 428         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 429
 430         if not json_mode:
 431             print('[+] Checking "{}" against hardening preferences...'.format(fname))
 432         for line in f.readlines():
 433             line = line.strip()
 434             option = None
 435             value = None
 436
 437             if opt_is_on.match(line):
 438                 option, value = line[7:].split('=', 1)
 439             elif opt_is_off.match(line):
 440                 option, value = line[9:].split(' ', 1)
 441                 if value != 'is not set':
 442                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 443
 444             if option in parsed_options:
 445                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 446
 447             if option is not None:
 448                 parsed_options[option] = value
 449
 450         perform_checks(checklist, parsed_options)
 451
 452         if debug_mode:
 453             known_options = [opt.name for opt in checklist]
 454             for option, value in parsed_options.items():
 455                 if option not in known_options:
 456                     print("DEBUG: dunno about option {} ({})".format(option, value))
 457
 458         print_checklist(checklist, True)
 459
 460
 461 if __name__ == '__main__':
 462     config_checklist = []
 463
 464     parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
 465     parser.add_argument('-p', '--print', choices=supported_archs,
 466                         help='print hardening preferences for selected architecture')
 467     parser.add_argument('-c', '--config',
 468                         help='check the config_file against these preferences')
 469     parser.add_argument('--debug', action='store_true',
 470                         help='enable internal debug mode')
 471     parser.add_argument('--json', action='store_true',
 472                         help='print results in JSON format')
 473     args = parser.parse_args()
 474
 475     if args.debug:
 476         debug_mode = True
 477     if args.json:
 478         json_mode = True
 479     if debug_mode and json_mode:
 480         sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
 481
 482     if args.config:
 483         arch, msg = detect_arch(args.config)
 484         if not arch:
 485             sys.exit('[!] ERROR: {}'.format(msg))
 486         elif not json_mode:
 487             print('[+] Detected architecture: {}'.format(arch))
 488
 489         construct_checklist(config_checklist, arch)
 490         check_config_file(config_checklist, args.config)
 491         error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
 492         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
 493         if debug_mode:
 494             sys.exit(0)
 495         if not json_mode:
 496             print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
 497         sys.exit(0)
 498
 499     if args.print:
 500         arch = args.print
 501         construct_checklist(config_checklist, arch)
 502         if not json_mode:
 503             print('[+] Printing kernel hardening preferences for {}...'.format(arch))
 504         print_checklist(config_checklist, False)
 505         sys.exit(0)
 506
 507     parser.print_help()