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. Let the computers do their job!
   6 #
   7 # Author: Alexander Popov <alex.popov@linux.com>
   8 #
   9 # Please don't cry if my Python code looks like C.
  10 #
  11 #
  12 # N.B Hardening command line parameters:
  13 #    page_poison=1
  14 #    slub_debug=FZP
  15 #    slab_nomerge
  16 #    pti=on
  17 #    kernel.kptr_restrict=1
  18 #    lockdown=1
  19 #
  20 # N.B. Hardening sysctl's:
  21 #    net.core.bpf_jit_harden
  22 #
  23
  24 import sys
  25 from argparse import ArgumentParser
  26 from collections import OrderedDict
  27 import re
  28
  29 debug_mode = False  # set it to True to print the unknown options from the config
  30 checklist = []
  31
  32
  33 class OptCheck:
  34     def __init__(self, name, expected, decision, reason):
  35         self.name = name
  36         self.expected = expected
  37         self.decision = decision
  38         self.reason = reason
  39         self.state = None
  40         self.result = None
  41
  42     def check(self):
  43         if self.expected == self.state:
  44             self.result = 'OK'
  45         elif self.state is None:
  46             if self.expected == 'is not set':
  47                 self.result = 'OK: not found'
  48             else:
  49                 self.result = 'FAIL: not found'
  50         else:
  51             self.result = 'FAIL: "' + self.state + '"'
  52
  53         if self.result.startswith('OK'):
  54             return True, self.result
  55         else:
  56             return False, self.result
  57
  58     def __repr__(self):
  59         return '{} = {}'.format(self.name, self.state)
  60
  61
  62 class OR:
  63     def __init__(self, *opts):
  64         self.opts = opts
  65         self.result = None
  66
  67     # self.opts[0] is the option which this OR-check is about.
  68     # Use case: OR(<X_is_hardened>, <X_is_disabled>)
  69
  70     @property
  71     def name(self):
  72         return self.opts[0].name
  73
  74     @property
  75     def expected(self):
  76         return self.opts[0].expected
  77
  78     @property
  79     def state(self):
  80         return self.opts[0].state
  81
  82     @property
  83     def decision(self):
  84         return self.opts[0].decision
  85
  86     @property
  87     def reason(self):
  88         return self.opts[0].reason
  89
  90     def check(self):
  91         for i, opt in enumerate(self.opts):
  92             result, msg = opt.check()
  93             if result:
  94                 if i == 0:
  95                     self.result = opt.result
  96                 else:
  97                     self.result = 'CONFIG_{}: {} ("{}")'.format(opt.name, opt.result, opt.expected)
  98                 return True, self.result
  99         self.result = self.opts[0].result
 100         return False, self.result
 101
 102
 103 def construct_checklist():
 104     modules_not_set = OptCheck('MODULES',                'is not set', 'kspp', 'cut_attack_surface')
 105     devmem_not_set = OptCheck('DEVMEM',                  'is not set', 'kspp', 'cut_attack_surface') # refers to LOCK_DOWN_KERNEL
 106
 107     checklist.append(OptCheck('BUG',                         'y', 'ubuntu18', 'self_protection'))
 108     checklist.append(OptCheck('PAGE_TABLE_ISOLATION',        'y', 'ubuntu18', 'self_protection'))
 109     checklist.append(OptCheck('RETPOLINE',                   'y', 'ubuntu18', 'self_protection'))
 110     checklist.append(OptCheck('X86_64',                      'y', 'ubuntu18', 'self_protection'))
 111     checklist.append(OptCheck('X86_SMAP',                    'y', 'ubuntu18', 'self_protection'))
 112     checklist.append(OptCheck('X86_INTEL_UMIP',              'y', 'ubuntu18', 'self_protection'))
 113     checklist.append(OR(OptCheck('STRICT_KERNEL_RWX',        'y', 'ubuntu18', 'self_protection'), \
 114                         OptCheck('DEBUG_RODATA',             'y', 'before_v4.11', 'self_protection')))
 115     checklist.append(OptCheck('DEBUG_WX',                    'y', 'ubuntu18', 'self_protection'))
 116     checklist.append(OptCheck('RANDOMIZE_BASE',              'y', 'ubuntu18', 'self_protection'))
 117     checklist.append(OptCheck('RANDOMIZE_MEMORY',            'y', 'ubuntu18', 'self_protection'))
 118     checklist.append(OR(OptCheck('STACKPROTECTOR_STRONG',    'y', 'ubuntu18', 'self_protection'), \
 119                         OptCheck('CC_STACKPROTECTOR_STRONG', 'y', 'ubuntu18', 'self_protection')))
 120     checklist.append(OptCheck('VMAP_STACK',                  'y', 'ubuntu18', 'self_protection'))
 121     checklist.append(OptCheck('THREAD_INFO_IN_TASK',         'y', 'ubuntu18', 'self_protection'))
 122     checklist.append(OptCheck('SCHED_STACK_END_CHECK',       'y', 'ubuntu18', 'self_protection'))
 123     checklist.append(OptCheck('SLUB_DEBUG',                  'y', 'ubuntu18', 'self_protection'))
 124     checklist.append(OptCheck('SLAB_FREELIST_HARDENED',      'y', 'ubuntu18', 'self_protection'))
 125     checklist.append(OptCheck('SLAB_FREELIST_RANDOM',        'y', 'ubuntu18', 'self_protection'))
 126     checklist.append(OptCheck('HARDENED_USERCOPY',           'y', 'ubuntu18', 'self_protection'))
 127     checklist.append(OptCheck('FORTIFY_SOURCE',              'y', 'ubuntu18', 'self_protection'))
 128     checklist.append(OptCheck('LOCK_DOWN_KERNEL',            'y', 'ubuntu18', 'self_protection')) # remember about LOCK_DOWN_MANDATORY
 129     checklist.append(OR(OptCheck('STRICT_MODULE_RWX',        'y', 'ubuntu18', 'self_protection'), \
 130                         OptCheck('DEBUG_SET_MODULE_RONX',    'y', 'before_v4.11', 'self_protection'), \
 131                         modules_not_set))
 132     checklist.append(OR(OptCheck('MODULE_SIG',               'y', 'ubuntu18', 'self_protection'), \
 133                         modules_not_set))
 134     checklist.append(OR(OptCheck('MODULE_SIG_ALL',           'y', 'ubuntu18', 'self_protection'), \
 135                         modules_not_set))
 136     checklist.append(OR(OptCheck('MODULE_SIG_SHA512',        'y', 'ubuntu18', 'self_protection'), \
 137                         modules_not_set))
 138     checklist.append(OptCheck('SYN_COOKIES',                 'y', 'ubuntu18', 'self_protection')) # another reason?
 139     checklist.append(OptCheck('DEFAULT_MMAP_MIN_ADDR',       '65536', 'ubuntu18', 'self_protection'))
 140
 141     checklist.append(OptCheck('BUG_ON_DATA_CORRUPTION',           'y', 'kspp', 'self_protection'))
 142     checklist.append(OptCheck('PAGE_POISONING',                   'y', 'kspp', 'self_protection'))
 143     checklist.append(OptCheck('GCC_PLUGINS',                      'y', 'kspp', 'self_protection'))
 144     checklist.append(OptCheck('GCC_PLUGIN_RANDSTRUCT',            'y', 'kspp', 'self_protection'))
 145     checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK',            'y', 'kspp', 'self_protection'))
 146     checklist.append(OptCheck('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL',  'y', 'kspp', 'self_protection'))
 147     checklist.append(OptCheck('GCC_PLUGIN_LATENT_ENTROPY',        'y', 'kspp', 'self_protection'))
 148     checklist.append(OptCheck('REFCOUNT_FULL',                    'y', 'kspp', 'self_protection'))
 149     checklist.append(OptCheck('DEBUG_LIST',                       'y', 'kspp', 'self_protection'))
 150     checklist.append(OptCheck('DEBUG_SG',                         'y', 'kspp', 'self_protection'))
 151     checklist.append(OptCheck('DEBUG_CREDENTIALS',                'y', 'kspp', 'self_protection'))
 152     checklist.append(OptCheck('DEBUG_NOTIFIERS',                  'y', 'kspp', 'self_protection'))
 153     checklist.append(OptCheck('MODULE_SIG_FORCE',                 'y', 'kspp', 'self_protection')) # refers to LOCK_DOWN_KERNEL
 154     checklist.append(OptCheck('HARDENED_USERCOPY_FALLBACK',       'is not set', 'kspp', 'self_protection'))
 155
 156     checklist.append(OptCheck('GCC_PLUGIN_STACKLEAK',             'y', 'my', 'self_protection'))
 157     checklist.append(OptCheck('SLUB_DEBUG_ON',                    'y', 'my', 'self_protection'))
 158     checklist.append(OptCheck('SECURITY_DMESG_RESTRICT',          'y', 'my', 'self_protection'))
 159     checklist.append(OptCheck('STATIC_USERMODEHELPER',            'y', 'my', 'self_protection')) # breaks systemd?
 160     checklist.append(OptCheck('SECURITY_LOADPIN',                 'y', 'my', 'self_protection'))
 161     checklist.append(OptCheck('PAGE_POISONING_NO_SANITY',         'is not set', 'my', 'self_protection'))
 162     checklist.append(OptCheck('PAGE_POISONING_ZERO',              'is not set', 'my', 'self_protection'))
 163     checklist.append(OptCheck('SLAB_MERGE_DEFAULT',               'is not set', 'my', 'self_protection')) # slab_nomerge
 164
 165     checklist.append(OptCheck('SECURITY',                    'y', 'ubuntu18', 'security_policy'))
 166     checklist.append(OptCheck('SECURITY_YAMA',               'y', 'ubuntu18', 'security_policy'))
 167     checklist.append(OptCheck('SECURITY_SELINUX_DISABLE',    'is not set', 'ubuntu18', 'security_policy'))
 168
 169     checklist.append(OptCheck('SECCOMP',              'y', 'ubuntu18', 'cut_attack_surface'))
 170     checklist.append(OptCheck('SECCOMP_FILTER',       'y', 'ubuntu18', 'cut_attack_surface'))
 171     checklist.append(OR(OptCheck('STRICT_DEVMEM',     'y', 'ubuntu18', 'cut_attack_surface'), \
 172                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 173     checklist.append(OptCheck('ACPI_CUSTOM_METHOD',   'is not set', 'ubuntu18', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 174     checklist.append(OptCheck('COMPAT_BRK',           'is not set', 'ubuntu18', 'cut_attack_surface'))
 175     checklist.append(OptCheck('DEVKMEM',              'is not set', 'ubuntu18', 'cut_attack_surface'))
 176     checklist.append(OptCheck('COMPAT_VDSO',          'is not set', 'ubuntu18', 'cut_attack_surface'))
 177     checklist.append(OptCheck('X86_PTDUMP',           'is not set', 'ubuntu18', 'cut_attack_surface'))
 178     checklist.append(OptCheck('ZSMALLOC_STAT',        'is not set', 'ubuntu18', 'cut_attack_surface'))
 179     checklist.append(OptCheck('PAGE_OWNER',           'is not set', 'ubuntu18', 'cut_attack_surface'))
 180     checklist.append(OptCheck('DEBUG_KMEMLEAK',       'is not set', 'ubuntu18', 'cut_attack_surface'))
 181     checklist.append(OptCheck('BINFMT_AOUT',          'is not set', 'ubuntu18', 'cut_attack_surface'))
 182     checklist.append(OptCheck('MMIOTRACE_TEST',       'is not set', 'ubuntu18', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 183
 184     checklist.append(OR(OptCheck('IO_STRICT_DEVMEM',  'y', 'kspp', 'cut_attack_surface'), \
 185                         devmem_not_set)) # refers to LOCK_DOWN_KERNEL
 186     checklist.append(OptCheck('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface')) # 'vsyscall=none'
 187     checklist.append(OptCheck('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'))
 188     checklist.append(OptCheck('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'))
 189     checklist.append(OptCheck('KEXEC',                'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 190     checklist.append(OptCheck('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 191     checklist.append(OptCheck('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'))
 192     checklist.append(OptCheck('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'))
 193     checklist.append(OptCheck('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'))
 194     checklist.append(OptCheck('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'))
 195     checklist.append(OptCheck('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 196
 197     checklist.append(OptCheck('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 198     checklist.append(OptCheck('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'))
 199     checklist.append(OptCheck('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'))
 200     checklist.append(OptCheck('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'))
 201     checklist.append(OptCheck('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'))
 202     checklist.append(OptCheck('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'))
 203     checklist.append(OptCheck('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'))
 204     checklist.append(OptCheck('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'))
 205     checklist.append(OptCheck('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'))
 206     checklist.append(OptCheck('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'))
 207     checklist.append(OptCheck('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 208     checklist.append(OptCheck('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 209     checklist.append(OptCheck('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'))
 210
 211     checklist.append(OptCheck('ACPI_TABLE_UPGRADE',   'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 212     checklist.append(OptCheck('ACPI_APEI_EINJ',       'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 213     checklist.append(OptCheck('PROFILING',            'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 214     checklist.append(OptCheck('BPF_SYSCALL',          'is not set', 'lockdown', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL
 215
 216     checklist.append(OptCheck('MMIOTRACE',            'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 217     checklist.append(OptCheck('KEXEC_FILE',           'is not set', 'my', 'cut_attack_surface')) # refers to LOCK_DOWN_KERNEL (permissive)
 218     checklist.append(OptCheck('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'))
 219     checklist.append(OptCheck('USER_NS',              'is not set', 'my', 'cut_attack_surface')) # user.max_user_namespaces=0
 220     checklist.append(OptCheck('IP_DCCP',              'is not set', 'my', 'cut_attack_surface'))
 221     checklist.append(OptCheck('IP_SCTP',              'is not set', 'my', 'cut_attack_surface'))
 222     checklist.append(OptCheck('FTRACE',               'is not set', 'my', 'cut_attack_surface'))
 223     checklist.append(OptCheck('BPF_JIT',              'is not set', 'my', 'cut_attack_surface'))
 224
 225     checklist.append(OptCheck('ARCH_MMAP_RND_BITS',   '32', 'my', 'userspace_protection'))
 226
 227 #   checklist.append(OptCheck('LKDTM',    'm', 'my', 'feature_test'))
 228
 229
 230 def print_checklist():
 231     print('[+] Printing kernel hardening preferences...')
 232     print('  {:<39}|{:^13}|{:^10}|{:^20}'.format(
 233         'option name', 'desired val', 'decision', 'reason'))
 234     print('  ' + '=' * 86)
 235     for opt in checklist:
 236         print('  CONFIG_{:<32}|{:^13}|{:^10}|{:^20}'.format(
 237             opt.name, opt.expected, opt.decision, opt.reason))
 238     print()
 239
 240
 241 def print_check_results():
 242     print('  {:<39}|{:^13}|{:^10}|{:^20}||{:^28}'.format(
 243         'option name', 'desired val', 'decision', 'reason', 'check result'))
 244     print('  ' + '=' * 115)
 245     for opt in checklist:
 246         print('  CONFIG_{:<32}|{:^13}|{:^10}|{:^20}||{:^28}'.format(
 247             opt.name, opt.expected, opt.decision, opt.reason, opt.result))
 248     print()
 249
 250
 251 def get_option_state(options, name):
 252     return options.get(name, None)
 253
 254
 255 def perform_checks(parsed_options):
 256     for opt in checklist:
 257         if hasattr(opt, 'opts'):
 258             for o in opt.opts:
 259                 o.state = get_option_state(parsed_options, o.name)
 260         else:
 261             opt.state = get_option_state(parsed_options, opt.name)
 262         opt.check()
 263
 264
 265 def check_config_file(fname):
 266     with open(fname, 'r') as f:
 267         parsed_options = OrderedDict()
 268         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 269         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 270
 271         print('[+] Checking "{}" against hardening preferences...'.format(fname))
 272         for line in f.readlines():
 273             line = line.strip()
 274             option = None
 275             value = None
 276
 277             if opt_is_on.match(line):
 278                 option, value = line[7:].split('=', 1)
 279             elif opt_is_off.match(line):
 280                 option, value = line[9:].split(' ', 1)
 281                 if value != 'is not set':
 282                     sys.exit('[!] ERROR: bad disabled config option "{}"'.format(line))
 283
 284             if option in parsed_options:
 285                 sys.exit('[!] ERROR: config option "{}" exists multiple times'.format(line))
 286
 287             if option is not None:
 288                 parsed_options[option] = value
 289
 290         perform_checks(parsed_options)
 291
 292         if debug_mode:
 293             known_options = [opt.name for opt in checklist]
 294             for option, value in parsed_options.items():
 295                 if option not in known_options:
 296                     print("DEBUG: dunno about option {} ({})".format(option, value))
 297
 298         print_check_results()
 299
 300
 301 if __name__ == '__main__':
 302     parser = ArgumentParser(description='Checks the hardening options in the Linux kernel config')
 303     parser.add_argument('-p', '--print', action='store_true', help='print hardening preferences')
 304     parser.add_argument('-c', '--config', help='check the config_file against these preferences')
 305     parser.add_argument('--debug', action='store_true', help='enable internal debug mode')
 306     args = parser.parse_args()
 307
 308     construct_checklist()
 309
 310     if args.print:
 311         print_checklist()
 312         sys.exit(0)
 313
 314     if args.debug:
 315         debug_mode = True
 316
 317     if args.config:
 318         check_config_file(args.config)
 319         error_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
 320         if error_count == 0:
 321             print('[+] config check is PASSED')
 322             sys.exit(0)
 323         else:
 324             sys.exit('[-] config check is NOT PASSED: {} errors'.format(error_count))
 325
 326     parser.print_help()