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=P
  15 #    slab_nomerge
  16 #    pti=on
  17 #    kernel.kptr_restrict=1
  18
  19 import sys, getopt
  20 from collections import namedtuple
  21 import re
  22
  23 debug_mode = False  # set it to True to print the unknown options from the config
  24 error_count = 0
  25 opt_list = []
  26
  27 Opt = namedtuple('Opt', ['name', 'state', 'decision', 'reason'])
  28
  29 def construct_opt_list():
  30     opt_list.append([Opt('BUG',                     'y', 'ubuntu18', 'self_protection'), ''])
  31     opt_list.append([Opt('PAGE_TABLE_ISOLATION',    'y', 'ubuntu18', 'self_protection'), ''])
  32     opt_list.append([Opt('RETPOLINE',               'y', 'ubuntu18', 'self_protection'), ''])
  33     opt_list.append([Opt('X86_64',                  'y', 'ubuntu18', 'self_protection'), ''])
  34     opt_list.append([Opt('STRICT_KERNEL_RWX',       'y', 'ubuntu18', 'self_protection'), ''])
  35     opt_list.append([Opt('STRICT_MODULE_RWX',       'y', 'ubuntu18', 'self_protection'), ''])
  36     opt_list.append([Opt('DEBUG_WX',                'y', 'ubuntu18', 'self_protection'), ''])
  37     opt_list.append([Opt('RANDOMIZE_BASE',          'y', 'ubuntu18', 'self_protection'), ''])
  38     opt_list.append([Opt('RANDOMIZE_MEMORY',        'y', 'ubuntu18', 'self_protection'), ''])
  39     opt_list.append([Opt('CC_STACKPROTECTOR',       'y', 'ubuntu18', 'self_protection'), ''])
  40     opt_list.append([Opt('CC_STACKPROTECTOR_STRONG','y', 'ubuntu18', 'self_protection'), ''])
  41     opt_list.append([Opt('VMAP_STACK',              'y', 'ubuntu18', 'self_protection'), ''])
  42     opt_list.append([Opt('THREAD_INFO_IN_TASK',     'y', 'ubuntu18', 'self_protection'), ''])
  43     opt_list.append([Opt('SCHED_STACK_END_CHECK',   'y', 'ubuntu18', 'self_protection'), ''])
  44     opt_list.append([Opt('SLUB_DEBUG',              'y', 'ubuntu18', 'self_protection'), ''])
  45     opt_list.append([Opt('SLAB_FREELIST_HARDENED',  'y', 'ubuntu18', 'self_protection'), ''])
  46     opt_list.append([Opt('SLAB_FREELIST_RANDOM',    'y', 'ubuntu18', 'self_protection'), ''])
  47     opt_list.append([Opt('HARDENED_USERCOPY',       'y', 'ubuntu18', 'self_protection'), ''])
  48     opt_list.append([Opt('FORTIFY_SOURCE',          'y', 'ubuntu18', 'self_protection'), ''])
  49     opt_list.append([Opt('MODULE_SIG',              'y', 'ubuntu18', 'self_protection'), ''])
  50     opt_list.append([Opt('MODULE_SIG_ALL',          'y', 'ubuntu18', 'self_protection'), ''])
  51     opt_list.append([Opt('MODULE_SIG_SHA512',       'y', 'ubuntu18', 'self_protection'), ''])
  52     opt_list.append([Opt('SYN_COOKIES',             'y', 'ubuntu18', 'self_protection'), '']) # another reason?
  53     opt_list.append([Opt('DEFAULT_MMAP_MIN_ADDR',   '65536', 'ubuntu18', 'self_protection'), ''])
  54
  55     opt_list.append([Opt('BUG_ON_DATA_CORRUPTION',           'y', 'kspp', 'self_protection'), ''])
  56     opt_list.append([Opt('PAGE_POISONING',                   'y', 'kspp', 'self_protection'), ''])
  57     opt_list.append([Opt('GCC_PLUGINS',                      'y', 'kspp', 'self_protection'), ''])
  58     opt_list.append([Opt('GCC_PLUGIN_RANDSTRUCT',            'y', 'kspp', 'self_protection'), ''])
  59     opt_list.append([Opt('GCC_PLUGIN_STRUCTLEAK',            'y', 'kspp', 'self_protection'), ''])
  60     opt_list.append([Opt('GCC_PLUGIN_STRUCTLEAK_BYREF_ALL',  'y', 'kspp', 'self_protection'), ''])
  61     opt_list.append([Opt('GCC_PLUGIN_LATENT_ENTROPY',        'y', 'kspp', 'self_protection'), ''])
  62     opt_list.append([Opt('REFCOUNT_FULL',                    'y', 'kspp', 'self_protection'), ''])
  63     opt_list.append([Opt('DEBUG_LIST',                       'y', 'kspp', 'self_protection'), ''])
  64     opt_list.append([Opt('DEBUG_SG',                         'y', 'kspp', 'self_protection'), ''])
  65     opt_list.append([Opt('DEBUG_CREDENTIALS',                'y', 'kspp', 'self_protection'), ''])
  66     opt_list.append([Opt('DEBUG_NOTIFIERS',                  'y', 'kspp', 'self_protection'), ''])
  67     opt_list.append([Opt('MODULE_SIG_FORCE',                 'y', 'kspp', 'self_protection'), ''])
  68     opt_list.append([Opt('HARDENED_USERCOPY_FALLBACK',       'is not set', 'kspp', 'self_protection'), ''])
  69
  70     opt_list.append([Opt('GCC_PLUGIN_STACKLEAK',             'y', 'my', 'self_protection'), ''])
  71     opt_list.append([Opt('SLUB_DEBUG_ON',                    'y', 'my', 'self_protection'), ''])
  72     opt_list.append([Opt('SECURITY_DMESG_RESTRICT',          'y', 'my', 'self_protection'), ''])
  73     opt_list.append([Opt('STATIC_USERMODEHELPER',            'y', 'my', 'self_protection'), '']) # breaks systemd?
  74     opt_list.append([Opt('PAGE_POISONING_NO_SANITY',         'is not set', 'my', 'self_protection'), ''])
  75     opt_list.append([Opt('PAGE_POISONING_ZERO',              'is not set', 'my', 'self_protection'), ''])
  76
  77     opt_list.append([Opt('SECURITY',                    'y', 'ubuntu18', 'security_policy'), ''])
  78     opt_list.append([Opt('SECURITY_YAMA',               'y', 'ubuntu18', 'security_policy'), ''])
  79     opt_list.append([Opt('SECURITY_SELINUX_DISABLE',    'is not set', 'ubuntu18', 'security_policy'), ''])
  80
  81     opt_list.append([Opt('SECCOMP',              'y', 'ubuntu18', 'cut_attack_surface'), ''])
  82     opt_list.append([Opt('SECCOMP_FILTER',       'y', 'ubuntu18', 'cut_attack_surface'), ''])
  83     opt_list.append([Opt('STRICT_DEVMEM',        'y', 'ubuntu18', 'cut_attack_surface'), ''])
  84     opt_list.append([Opt('ACPI_CUSTOM_METHOD',   'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  85     opt_list.append([Opt('COMPAT_BRK',           'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  86     opt_list.append([Opt('DEVKMEM',              'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  87     opt_list.append([Opt('COMPAT_VDSO',          'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  88     opt_list.append([Opt('X86_PTDUMP',           'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  89     opt_list.append([Opt('ZSMALLOC_STAT',        'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  90     opt_list.append([Opt('PAGE_OWNER',           'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  91     opt_list.append([Opt('DEBUG_KMEMLEAK',       'is not set', 'ubuntu18', 'cut_attack_surface'), ''])
  92
  93     opt_list.append([Opt('IO_STRICT_DEVMEM',     'y', 'kspp', 'cut_attack_surface'), ''])
  94     opt_list.append([Opt('LEGACY_VSYSCALL_NONE', 'y', 'kspp', 'cut_attack_surface'), '']) # 'vsyscall=none'
  95     opt_list.append([Opt('BINFMT_MISC',          'is not set', 'kspp', 'cut_attack_surface'), ''])
  96     opt_list.append([Opt('INET_DIAG',            'is not set', 'kspp', 'cut_attack_surface'), ''])
  97     opt_list.append([Opt('KEXEC',                'is not set', 'kspp', 'cut_attack_surface'), ''])
  98     opt_list.append([Opt('PROC_KCORE',           'is not set', 'kspp', 'cut_attack_surface'), ''])
  99     opt_list.append([Opt('LEGACY_PTYS',          'is not set', 'kspp', 'cut_attack_surface'), ''])
 100     opt_list.append([Opt('IA32_EMULATION',       'is not set', 'kspp', 'cut_attack_surface'), ''])
 101     opt_list.append([Opt('X86_X32',              'is not set', 'kspp', 'cut_attack_surface'), ''])
 102     opt_list.append([Opt('MODIFY_LDT_SYSCALL',   'is not set', 'kspp', 'cut_attack_surface'), ''])
 103     opt_list.append([Opt('HIBERNATION',          'is not set', 'kspp', 'cut_attack_surface'), ''])
 104
 105     opt_list.append([Opt('KPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 106     opt_list.append([Opt('UPROBES',                 'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 107     opt_list.append([Opt('GENERIC_TRACER',          'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 108     opt_list.append([Opt('PROC_VMCORE',             'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 109     opt_list.append([Opt('PROC_PAGE_MONITOR',       'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 110     opt_list.append([Opt('USELIB',                  'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 111     opt_list.append([Opt('CHECKPOINT_RESTORE',      'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 112     opt_list.append([Opt('USERFAULTFD',             'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 113     opt_list.append([Opt('HWPOISON_INJECT',         'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 114     opt_list.append([Opt('MEM_SOFT_DIRTY',          'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 115     opt_list.append([Opt('DEVPORT',                 'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 116     opt_list.append([Opt('DEBUG_FS',                'is not set', 'grsecurity', 'cut_attack_surface'), ''])
 117     opt_list.append([Opt('NOTIFIER_ERROR_INJECTION','is not set', 'grsecurity', 'cut_attack_surface'), ''])
 118
 119     opt_list.append([Opt('KEXEC_FILE',           'is not set', 'my', 'cut_attack_surface'), ''])
 120     opt_list.append([Opt('LIVEPATCH',            'is not set', 'my', 'cut_attack_surface'), ''])
 121     opt_list.append([Opt('USER_NS',              'is not set', 'my', 'cut_attack_surface'), '']) # user.max_user_namespaces=0
 122     opt_list.append([Opt('IP_DCCP',              'is not set', 'my', 'cut_attack_surface'), ''])
 123     opt_list.append([Opt('IP_SCTP',              'is not set', 'my', 'cut_attack_surface'), ''])
 124     opt_list.append([Opt('FTRACE',               'is not set', 'my', 'cut_attack_surface'), ''])
 125     opt_list.append([Opt('PROFILING',            'is not set', 'my', 'cut_attack_surface'), ''])
 126     opt_list.append([Opt('BPF_JIT',              'is not set', 'my', 'cut_attack_surface'), ''])
 127     opt_list.append([Opt('BPF_SYSCALL',          'is not set', 'my', 'cut_attack_surface'), ''])
 128
 129     opt_list.append([Opt('ARCH_MMAP_RND_BITS',   '32', 'my', 'userspace_protection'), ''])
 130
 131     opt_list.append([Opt('LKDTM',    'm', 'my', 'feature_test'), ''])
 132
 133
 134 def print_opt_list():
 135     print('[+] Printing kernel hardening preferences...')
 136     print('  {:<39}|{:^13}|{:^10}|{:^20}'.format('option name', 'desired val', 'decision', 'reason'))
 137     print('  ======================================================================================')
 138     for o in opt_list:
 139         print('  CONFIG_{:<32}|{:^13}|{:^10}|{:^20}'.format(o[0].name, o[0].state, o[0].decision, o[0].reason))
 140     print()
 141
 142
 143 def print_check_results():
 144     global error_count
 145
 146     print('  {:<39}|{:^13}|{:^10}|{:^20}||{:^20}'.format('option name', 'desired val', 'decision', 'reason', 'check result'))
 147     print('  ===========================================================================================================')
 148     for o in opt_list:
 149         if o[1] == '':
 150             if o[0].state == 'is not set':
 151                 o[1] = 'OK: not found'
 152             else:
 153                 error_count += 1
 154                 o[1] = 'FAIL: not found'
 155         print('  CONFIG_{:<32}|{:^13}|{:^10}|{:^20}||{:^20}'.format(o[0].name, o[0].state, o[0].decision, o[0].reason, o[1]))
 156     print()
 157
 158
 159 def check_state(option):
 160     global error_count
 161     found = False
 162
 163     for o in opt_list:
 164         if option[0] == o[0].name:
 165             found = True
 166
 167             if o[1] != '':
 168                 sys.exit('[!] BUG: CONFIG_{} was found more than once'.format(o[0].name))
 169
 170             if option[1] == o[0].state:
 171                 o[1] = 'OK'
 172             else:
 173                 o[1] = 'FAIL: "' + option[1] + '"'
 174                 error_count += 1
 175
 176     if not found and debug_mode:
 177         print("DEBUG: dunno about option {} ".format(option))
 178
 179
 180 def check_on(line):
 181     if line[:7] != 'CONFIG_':
 182         sys.exit('[!] BUG: bad enabled config option "{}"'.format(line))
 183
 184     line_parts = line[7:].split('=')
 185     check_state(line_parts)
 186
 187
 188 def check_off(line):
 189     if line[:9] != '# CONFIG_':
 190         sys.exit('[!] BUG: bad disabled config option "{}"'.format(line))
 191
 192     line_parts = line[9:].split(' ', 1)
 193
 194     if line_parts[1] != 'is not set':
 195         sys.exit('[!] BUG: bad disabled config option "{}"'.format(line))
 196
 197     check_state(line_parts)
 198
 199
 200 def check_config_file(fname):
 201     f = open(fname, 'r')
 202
 203     print('[+] Checking "{}" against hardening preferences...'.format(fname))
 204     for line in f:
 205         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
 206         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
 207         if opt_is_on.match(line):
 208             check_on(line[:-1]) # drop newline
 209         if opt_is_off.match(line):
 210             check_off(line[:-1]) # ditto
 211
 212     print_check_results()
 213     f.close()
 214
 215
 216 def usage(name):
 217     print('Usage: {} [-p | -c <config_file>] '.format(name))
 218     print(' -p, --print\n\tprint hardening preferences')
 219     print(' -c <config_file>, --config=<config_file>\n\tcheck the config_file against these preferences')
 220     sys.exit(1)
 221
 222
 223 def main(argv):
 224     try:
 225         opts, args = getopt.getopt(argv[1:], 'pc:', ['print', 'config='])
 226     except getopt.GetoptError:
 227         usage(argv[0])
 228
 229     if not opts:
 230         usage(argv[0])
 231
 232     construct_opt_list()
 233
 234     for opt, arg in opts:
 235         if opt in ('-p', '--print'):
 236             print_opt_list()
 237             sys.exit()
 238         elif opt in ('-c', '--config'):
 239             check_config_file(arg)
 240             if error_count == 0:
 241                 print('[+] config check is PASSED')
 242             else:
 243                 sys.exit('[-] config check is NOT PASSED: {} errors'.format(error_count))
 244
 245 main(sys.argv)