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 json_mode = False   # if True, print results in JSON format
  46
  47 supported_archs = [ 'X86_64', 'X86_32', 'ARM64', 'ARM' ]
  48
  49
  50 class OptCheck:
  51     def __init__(self, name, expected, decision, reason):
  52         self.name = name
  53         self.expected = expected
  54         self.decision = decision
  55         self.reason = reason
  56         self.state = None
  57         self.result = None
  58
  59     def check(self):
  60         if self.expected == self.state:
  61             self.result = 'OK'
  62         elif self.state is None:
  63             if self.expected == 'is not set':
  64                 self.result = 'OK: not found'
  65             else:
  66                 self.result = 'FAIL: not found'
  67         else:
  68             self.result = 'FAIL: "' + self.state + '"'
  69
  70         if self.result.startswith('OK'):
  71             return True, self.result
  72         else:
  73             return False, self.result
  74
  75     def __repr__(self):
  76         return '{} = {}'.format(self.name, self.state)
  77
  78
  79 class ComplexOptCheck:
  80     def __init__(self, *opts):
  81         self.opts = opts
  82         self.result = None
  83
  84     @property
  85     def name(self):
  86         return self.opts[0].name
  87
  88     @property
  89     def expected(self):
  90         return self.opts[0].expected
  91
  92     @property
  93     def state(self):
  94         return self.opts[0].state
  95
  96     @property
  97     def decision(self):
  98         return self.opts[0].decision
  99
 100     @property
 101     def reason(self):
 102         return self.opts[0].reason
 103
 104
 105 class OR(ComplexOptCheck):
 106     # self.opts[0] is the option which this OR-check is about.
 107     # Use case:
 108     #     OR(<X_is_hardened>, <X_is_disabled>)
 109     #     OR(<X_is_hardened>, <X_is_hardened_old>)
 110
 111     def check(self):
 112         if not self.opts:
 113             sys.exit('[!] ERROR: invalid OR check')
 114
 115         for i, opt in enumerate(self.opts):
 116             ret, msg = opt.check()
 117             if ret:
 118                 if i == 0:
 119                     self.result = opt.result
 120                 else:
 121                     self.result = 'OK: CONFIG_{} "{}"'.format(opt.name, opt.expected)
 122                 return True, self.result
 123         self.result = self.opts[0].result
 124         return False, self.result
 125
 126
 127 class AND(ComplexOptCheck):
 128     # self.opts[0] is the option which this AND-check is about.
 129     # Use case: AND(<suboption>, <main_option>)
 130     # Suboption is not checked if checking of the main_option is failed.
 131
 132     def check(self):
 133         for i, opt in reversed(list(enumerate(self.opts))):
 134             ret, msg = opt.check()
 135             if i == 0:
 136                 self.result = opt.result
 137                 return ret, self.result
 138             elif not ret:
 139                 self.result = 'FAIL: CONFIG_{} is needed'.format(opt.name)
 140                 return False, self.result
 141
 142         sys.exit('[!] ERROR: invalid AND check')
 143
 144
 145 def detect_arch(fname):
 146     with open(fname, 'r') as f:
 147         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
 148         arch = None
 149         msg = None
 150         if not json_mode:
 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(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 == 'ARM64' or arch == 'X86_32':
 251         stackleak_is_set = OptCheck('GCC_PLUGIN_STACKLEAK',       'y', 'clipos', 'self_protection')
 252         checklist.append(stackleak_is_set)
 253         checklist.append(AND(OptCheck('STACKLEAK_METRICS',        'is not set', 'clipos', 'self_protection'), \
 254                              stackleak_is_set))
 255         checklist.append(AND(OptCheck('STACKLEAK_RUNTIME_DISABLE','is not set', 'clipos', 'self_protection'), \
 256                              stackleak_is_set))
 257     if debug_mode or arch == 'X86_64' or arch == 'X86_32':
 258         checklist.append(OptCheck('RANDOM_TRUST_CPU',             'is not set', 'clipos', 'self_protection'))
 259         checklist.append(OptCheck('MICROCODE',                    'y', 'clipos', 'self_protection')) # is needed for mitigating CPU bugs
 260         iommu_support_is_set = OptCheck('IOMMU_SUPPORT',          'y', 'clipos', 'self_protection') # is needed for mitigating DMA attacks
 261         checklist.append(iommu_support_is_set)
 262         checklist.append(AND(OptCheck('INTEL_IOMMU',              'y', 'clipos', 'self_protection'), \
 263                              iommu_support_is_set))
 264         checklist.append(AND(OptCheck('INTEL_IOMMU_SVM',          'y', 'clipos', 'self_protection'), \
 265                              iommu_support_is_set))
 266         checklist.append(AND(OptCheck('INTEL_IOMMU_DEFAULT_ON',   'y', 'clipos', 'self_protection'), \
 267                              iommu_support_is_set))
 268
 269     if debug_mode or arch == 'X86_64':
 270         checklist.append(AND(OptCheck('AMD_IOMMU',                'y', 'my', 'self_protection'), \
 271                              iommu_support_is_set))
 272         checklist.append(AND(OptCheck('AMD_IOMMU_V2',             'y', 'my', 'self_protection'), \
 273                              iommu_support_is_set))
 274     checklist.append(OptCheck('SLUB_DEBUG_ON',                    'y', 'my', 'self_protection'))
 275     checklist.append(OptCheck('SECURITY_LOADPIN',                 'y', 'my', 'self_protection')) # needs userspace support
 276     checklist.append(OptCheck('RESET_ATTACK_MITIGATION',          'y', 'my', 'self_protection')) # needs userspace support (systemd)
 277     checklist.append(AND(OptCheck('PAGE_POISONING_NO_SANITY',     'is not set', 'my', 'self_protection'), \
 278                          page_poisoning_is_set))
 279     checklist.append(AND(OptCheck('PAGE_POISONING_ZERO',          'is not set', 'my', 'self_protection'), \
 280                          page_poisoning_is_set))
 281     if debug_mode or arch == 'X86_32':
 282         checklist.append(OptCheck('PAGE_TABLE_ISOLATION',         'y', 'my', 'self_protection'))
 283     if debug_mode or arch == 'ARM':
 284         checklist.append(OptCheck('STACKPROTECTOR_PER_TASK',      'y', 'my', 'self_protection'))
 285
 286     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 287         checklist.append(OptCheck('SECURITY',                'y', 'defconfig', 'security_policy')) # and choose your favourite LSM
 288     if debug_mode or arch == 'ARM':
 289         checklist.append(OptCheck('SECURITY',                'y', 'kspp', 'security_policy')) # and choose your favourite LSM
 290     checklist.append(OptCheck('SECURITY_YAMA',               'y', 'kspp', 'security_policy'))
 291
 292     checklist.append(OptCheck('SECCOMP',              'y', 'defconfig', 'cut_attack_surface'))
 293     checklist.append(OptCheck('SECCOMP_FILTER',       'y', 'defconfig', 'cut_attack_surface'))
 294     if debug_mode or arch == 'X86_64' or arch == 'ARM64' or arch == 'X86_32':
 295         checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'defconfig', 'cut_attack_surface'), \
 296                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 297
 298     checklist.append(modules_not_set)
 299     checklist.append(devmem_not_set)
 300     checklist.append(OR(OptCheck('IO_STRICT_DEVMEM',  'y', 'kspp', 'cut_attack_surface'), \
 301                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 302     if debug_mode or arch == 'ARM':
 303         checklist.append(OR(OptCheck('STRICT_DEVMEM', 'y', 'kspp', 'cut_attack_surface'), \
 304                             devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 305     checklist.append(OptCheck('ACPI_CUSTOM_METHOD',   'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 306     checklist.append(OptCheck('COMPAT_BRK',           'is not set', 'kspp', 'cut_attack_surface'))
 307     checklist.append(OptCheck('DEVKMEM',              'is not set', 'kspp', 'cut_attack_surface'))
 308     checklist.append(OptCheck('COMPAT_VDSO',          'is not set', 'kspp', 'cut_attack_surface'))
 309     checklist.append(OptCheck('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'))
 310     checklist.append(OptCheck('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'))
 311     checklist.append(OptCheck('KEXEC',                'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 312     checklist.append(OptCheck('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 313     checklist.append(OptCheck('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'))
 314     checklist.append(OptCheck('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 315     if debug_mode or arch == 'X86_64':
 316         checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
 317         checklist.append(OptCheck('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'))
 318         checklist.append(OptCheck('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'))
 319         checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'))
 320     if debug_mode or arch == 'ARM':
 321         checklist.append(OptCheck('OABI_COMPAT',          'is not set', 'kspp', 'cut_attack_surface'))
 322
 323     checklist.append(OptCheck('X86_PTDUMP',              'is not set', 'grsecurity', 'cut_attack_surface'))
 324     checklist.append(OptCheck('ZSMALLOC_STAT',           'is not set', 'grsecurity', 'cut_attack_surface'))
 325     checklist.append(OptCheck('PAGE_OWNER',              'is not set', 'grsecurity', 'cut_attack_surface'))
 326     checklist.append(OptCheck('DEBUG_KMEMLEAK',          'is not set', 'grsecurity', 'cut_attack_surface'))
 327     checklist.append(OptCheck('BINFMT_AOUT',             'is not set', 'grsecurity', 'cut_attack_surface'))
 328     checklist.append(OptCheck('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 329     checklist.append(OptCheck('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'))
 330     checklist.append(OptCheck('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'))
 331     checklist.append(OptCheck('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'))
 332     checklist.append(OptCheck('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'))
 333     checklist.append(OptCheck('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'))
 334     checklist.append(OptCheck('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'))
 335     checklist.append(OptCheck('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'))
 336     checklist.append(OptCheck('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'))
 337     checklist.append(OptCheck('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'))
 338     checklist.append(OptCheck('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 339     checklist.append(OptCheck('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 340     checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
 341
 342     checklist.append(OptCheck('ACPI_TABLE_UPGRADE',   'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 343     checklist.append(OptCheck('ACPI_APEI_EINJ',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 344     checklist.append(OptCheck('PROFILING',            'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 345     checklist.append(OptCheck('BPF_SYSCALL',          'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 346     checklist.append(OptCheck('MMIOTRACE_TEST',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 347
 348     checklist.append(OptCheck('KSM',                      'is not set', 'clipos', 'cut_attack_surface')) # to prevent FLUSH+RELOAD attack
 349     checklist.append(OptCheck('IKCONFIG',                 'is not set', 'clipos', 'cut_attack_surface'))
 350     checklist.append(OptCheck('KALLSYMS',                 'is not set', 'clipos', 'cut_attack_surface'))
 351     checklist.append(OptCheck('X86_VSYSCALL_EMULATION',   'is not set', 'clipos', 'cut_attack_surface'))
 352     checklist.append(OptCheck('MAGIC_SYSRQ',              'is not set', 'clipos', 'cut_attack_surface'))
 353     checklist.append(OptCheck('KEXEC_FILE',               'is not set', 'clipos', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 354     checklist.append(OptCheck('USER_NS',                  'is not set', 'clipos', 'cut_attack_surface')) # user.max_user_namespaces=0
 355     checklist.append(OptCheck('LDISC_AUTOLOAD',           'is not set', 'clipos', 'cut_attack_surface'))
 356
 357     checklist.append(OptCheck('MMIOTRACE',            'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 358     checklist.append(OptCheck('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'))
 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', 'clipos', '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(checklist, with_results):
 377     if json_mode:
 378         opts = []
 379         for o in checklist:
 380             opt = ['CONFIG_'+o.name, o.expected, o.decision, o.reason]
 381             if with_results:
 382                 opt.append(o.result)
 383             opts.append(opt)
 384         print(opts)
 385         return
 386
 387     # header
 388     print('{:^40}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'), end='')
 389     sep_line_len = 86
 390     if with_results:
 391         print('||{:^28}'.format('check result'), end='')
 392         sep_line_len += 30
 393     print()
 394
 395     print('=' * sep_line_len)
 396
 397     for opt in checklist:
 398         print('CONFIG_{:<33}|{:^13}|{:^10}|{:^20}'.format(opt.name, opt.expected, opt.decision, opt.reason), end='')
 399         if with_results:
 400             print('||{:^28}'.format(opt.result), end='')
 401         print()
 402     print()
 403
 404
 405 def get_option_state(options, name):
 406     return options.get(name, None)
 407
 408
 409 def perform_checks(checklist, parsed_options):
 410     for opt in checklist:
 411         if hasattr(opt, 'opts'):
 412             for o in opt.opts:
 413                 o.state = get_option_state(parsed_options, o.name)
 414         else:
 415             opt.state = get_option_state(parsed_options, opt.name)
 416         opt.check()
 417
 418
 419 def check_config_file(checklist, fname):
 420     with open(fname, 'r') as f:
 421         parsed_options = OrderedDict()
 422         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 423         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 424
 425         if not json_mode:
 426             print('[+] Checking "{}" against hardening preferences...'.format(fname))
 427         for line in f.readlines():
 428             line = line.strip()
 429             option = None
 430             value = None
 431
 432             if opt_is_on.match(line):
 433                 option, value = line[7:].split('=', 1)
 434             elif opt_is_off.match(line):
 435                 option, value = line[9:].split(' ', 1)
 436                 if value != 'is not set':
 437                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 438
 439             if option in parsed_options:
 440                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 441
 442             if option is not None:
 443                 parsed_options[option] = value
 444
 445         perform_checks(checklist, parsed_options)
 446
 447         if debug_mode:
 448             known_options = [opt.name for opt in checklist]
 449             for option, value in parsed_options.items():
 450                 if option not in known_options:
 451                     print("DEBUG: dunno about option {} ({})".format(option, value))
 452
 453         print_checklist(checklist, True)
 454
 455
 456 if __name__ == '__main__':
 457     config_checklist = []
 458
 459     parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
 460     parser.add_argument('-p', '--print', choices=supported_archs,
 461                         help='print hardening preferences for selected architecture')
 462     parser.add_argument('-c', '--config',
 463                         help='check the config_file against these preferences')
 464     parser.add_argument('--debug', action='store_true',
 465                         help='enable internal debug mode')
 466     parser.add_argument('--json', action='store_true',
 467                         help='print results in JSON format')
 468     args = parser.parse_args()
 469
 470     if args.debug:
 471         debug_mode = True
 472     if args.json:
 473         json_mode = True
 474     if debug_mode and json_mode:
 475         sys.exit('[!] ERROR: options --debug and --json cannot be used simultaneously')
 476
 477     if args.config:
 478         arch, msg = detect_arch(args.config)
 479         if not arch:
 480             sys.exit('[!] ERROR: {}'.format(msg))
 481         elif not json_mode:
 482             print('[+] Detected architecture: {}'.format(arch))
 483
 484         construct_checklist(config_checklist, arch)
 485         check_config_file(config_checklist, args.config)
 486         error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), config_checklist)))
 487         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), config_checklist)))
 488         if debug_mode:
 489             sys.exit(0)
 490         if not json_mode:
 491             print('[+] config check is finished: \'OK\' - {} / \'FAIL\' - {}'.format(ok_count, error_count))
 492         sys.exit(0)
 493
 494     if args.print:
 495         arch = args.print
 496         construct_checklist(config_checklist, arch)
 497         if not json_mode:
 498             print('[+] Printing kernel hardening preferences for {}...'.format(arch))
 499         print_checklist(config_checklist, False)
 500         sys.exit(0)
 501
 502     parser.print_help()