kconfig-hardened-check.py

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