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