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