Improve 'type' for ComplexOptCheck and PresenceCheck classes
[kconfig-hardened-check.git] / kconfig_hardened_check / __init__.py
1 #!/usr/bin/python3
2
3 #
4 # This tool helps me to check Linux kernel options against
5 # my security 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 #    slab_nomerge
15 #    page_alloc.shuffle=1
16 #    iommu=force (does it help against DMA attacks?)
17 #    slub_debug=FZ (slow)
18 #    init_on_alloc=1 (since v5.3)
19 #    init_on_free=1 (since v5.3, otherwise slub_debug=P and page_poison=1)
20 #    loadpin.enforce=1
21 #    debugfs=no-mount (or off if possible)
22 #    randomize_kstack_offset=1
23 #
24 #    Mitigations of CPU vulnerabilities:
25 #       Аrch-independent:
26 #           mitigations=auto,nosmt (nosmt is slow)
27 #       X86:
28 #           spectre_v2=on
29 #           pti=on
30 #           spec_store_bypass_disable=on
31 #           l1tf=full,force
32 #           mds=full,nosmt
33 #           tsx=off
34 #           l1d_flush=on
35 #       ARM64:
36 #           kpti=on
37 #           ssbd=force-on
38 #
39 #    Should NOT be set:
40 #           nokaslr
41 #           arm64.nobti
42 #           arm64.nopauth
43 #
44 #    Hardware tag-based KASAN with arm64 Memory Tagging Extension (MTE):
45 #           kasan=on
46 #           kasan.stacktrace=off
47 #           kasan.fault=panic
48 #
49 # N.B. Hardening sysctls:
50 #    kernel.kptr_restrict=2 (or 1?)
51 #    kernel.dmesg_restrict=1 (also see the kconfig option)
52 #    kernel.perf_event_paranoid=3
53 #    kernel.kexec_load_disabled=1
54 #    kernel.yama.ptrace_scope=3
55 #    user.max_user_namespaces=0
56 #    what about bpf_jit_enable?
57 #    kernel.unprivileged_bpf_disabled=1
58 #    net.core.bpf_jit_harden=2
59 #
60 #    vm.unprivileged_userfaultfd=0
61 #        (at first, it disabled unprivileged userfaultfd,
62 #         and since v5.11 it enables unprivileged userfaultfd for user-mode only)
63 #
64 #    dev.tty.ldisc_autoload=0
65 #    fs.protected_symlinks=1
66 #    fs.protected_hardlinks=1
67 #    fs.protected_fifos=2
68 #    fs.protected_regular=2
69 #    fs.suid_dumpable=0
70 #    kernel.modules_disabled=1
71
72
73 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
74 # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
75
76
77 import sys
78 from argparse import ArgumentParser
79 from collections import OrderedDict
80 import re
81 import json
82 from .__about__ import __version__
83
84 TYPES_OF_CHECKS = ('kconfig', 'version')
85
86 class OptCheck:
87     def __init__(self, reason, decision, name, expected):
88         self.name = name
89         self.expected = expected
90         self.decision = decision
91         self.reason = reason
92         self.state = None
93         self.result = None
94
95     def check(self):
96         if self.expected == self.state:
97             self.result = 'OK'
98         elif self.state is None:
99             if self.expected == 'is not set':
100                 self.result = 'OK: not found'
101             else:
102                 self.result = 'FAIL: not found'
103         else:
104             self.result = 'FAIL: "' + self.state + '"'
105
106         if self.result.startswith('OK'):
107             return True
108         return False
109
110     def table_print(self, _mode, with_results):
111         print('{:<40}|{:^7}|{:^12}|{:^10}|{:^18}'.format(self.name, self.type, self.expected, self.decision, self.reason), end='')
112         if with_results:
113             print('| {}'.format(self.result), end='')
114
115
116 class KconfigCheck(OptCheck):
117     def __init__(self, *args, **kwargs):
118         super().__init__(*args, **kwargs)
119         self.name = 'CONFIG_' + self.name
120
121     @property
122     def type(self):
123         return 'kconfig'
124
125
126 class VersionCheck:
127     def __init__(self, ver_expected):
128         self.ver_expected = ver_expected
129         self.ver = ()
130         self.result = None
131
132     @property
133     def type(self):
134         return 'version'
135
136     def check(self):
137         if self.ver[0] > self.ver_expected[0]:
138             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
139             return True
140         if self.ver[0] < self.ver_expected[0]:
141             self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
142             return False
143         if self.ver[1] >= self.ver_expected[1]:
144             self.result = 'OK: version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
145             return True
146         self.result = 'FAIL: version < ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
147         return False
148
149     def table_print(self, _mode, with_results):
150         ver_req = 'kernel version >= ' + str(self.ver_expected[0]) + '.' + str(self.ver_expected[1])
151         print('{:<91}'.format(ver_req), end='')
152         if with_results:
153             print('| {}'.format(self.result), end='')
154
155
156 class PresenceCheck:
157     def __init__(self, name, type):
158         self.type = type
159         if self.type == 'kconfig':
160             self.name = 'CONFIG_' + name
161         else:
162             sys.exit('[!] ERROR: unsupported type "{}" for {}'.format(type, self.__class__.__name__))
163         self.state = None
164         self.result = None
165
166     def check(self):
167         if self.state is None:
168             self.result = 'FAIL: not present'
169             return False
170         self.result = 'OK: is present'
171         return True
172
173     def table_print(self, _mode, with_results):
174         print('{:<91}'.format(self.name + ' is present'), end='')
175         if with_results:
176             print('| {}'.format(self.result), end='')
177
178
179 class ComplexOptCheck:
180     def __init__(self, *opts):
181         self.opts = opts
182         if not self.opts:
183             sys.exit('[!] ERROR: empty {} check'.format(self.__class__.__name__))
184         if len(self.opts) == 1:
185             sys.exit('[!] ERROR: useless {} check'.format(self.__class__.__name__))
186         if not isinstance(opts[0], KconfigCheck):
187             sys.exit('[!] ERROR: invalid {} check: {}'.format(self.__class__.__name__, opts))
188         self.result = None
189
190     @property
191     def name(self):
192         return self.opts[0].name
193
194     @property
195     def type(self):
196         return 'complex'
197
198     @property
199     def expected(self):
200         return self.opts[0].expected
201
202     @property
203     def decision(self):
204         return self.opts[0].decision
205
206     @property
207     def reason(self):
208         return self.opts[0].reason
209
210     def table_print(self, mode, with_results):
211         if mode == 'verbose':
212             print('    {:87}'.format('<<< ' + self.__class__.__name__ + ' >>>'), end='')
213             if with_results:
214                 print('| {}'.format(self.result), end='')
215             for o in self.opts:
216                 print()
217                 o.table_print(mode, with_results)
218         else:
219             o = self.opts[0]
220             o.table_print(mode, False)
221             if with_results:
222                 print('| {}'.format(self.result), end='')
223
224
225 class OR(ComplexOptCheck):
226     # self.opts[0] is the option that this OR-check is about.
227     # Use cases:
228     #     OR(<X_is_hardened>, <X_is_disabled>)
229     #     OR(<X_is_hardened>, <old_X_is_hardened>)
230
231     def check(self):
232         if not self.opts:
233             sys.exit('[!] ERROR: invalid OR check')
234
235         for i, opt in enumerate(self.opts):
236             ret = opt.check()
237             if ret:
238                 if opt.result == 'OK' and i != 0:
239                     # Simple OK is not enough for additional checks, add more info:
240                     self.result = 'OK: {} "{}"'.format(opt.name, opt.expected)
241                 else:
242                     self.result = opt.result
243                 return True
244         self.result = self.opts[0].result
245         return False
246
247
248 class AND(ComplexOptCheck):
249     # self.opts[0] is the option that this AND-check is about.
250     # Use cases:
251     #     AND(<suboption>, <main_option>)
252     #       Suboption is not checked if checking of the main_option is failed.
253     #     AND(<X_is_disabled>, <old_X_is_disabled>)
254
255     def check(self):
256         for i, opt in reversed(list(enumerate(self.opts))):
257             ret = opt.check()
258             if i == 0:
259                 self.result = opt.result
260                 return ret
261             if not ret:
262                 # This FAIL is caused by additional checks,
263                 # and not by the main option that this AND-check is about.
264                 # Describe the reason of the FAIL.
265                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: not found':
266                     self.result = 'FAIL: {} not "{}"'.format(opt.name, opt.expected)
267                 elif opt.result == 'FAIL: not present':
268                     self.result = 'FAIL: {} not present'.format(opt.name)
269                 else:
270                     # This FAIL message is self-explaining.
271                     self.result = opt.result
272                 return False
273
274         sys.exit('[!] ERROR: invalid AND check')
275
276
277 def detect_arch(fname, archs):
278     with open(fname, 'r') as f:
279         arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]*=y")
280         arch = None
281         for line in f.readlines():
282             if arch_pattern.match(line):
283                 option, _ = line[7:].split('=', 1)
284                 if option in archs:
285                     if not arch:
286                         arch = option
287                     else:
288                         return None, 'more than one supported architecture is detected'
289         if not arch:
290             return None, 'failed to detect architecture'
291         return arch, 'OK'
292
293
294 def detect_version(fname):
295     with open(fname, 'r') as f:
296         ver_pattern = re.compile("# Linux/.* Kernel Configuration")
297         for line in f.readlines():
298             if ver_pattern.match(line):
299                 line = line.strip()
300                 parts = line.split()
301                 ver_str = parts[2]
302                 ver_numbers = ver_str.split('.')
303                 if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit():
304                     msg = 'failed to parse the version "' + ver_str + '"'
305                     return None, msg
306                 return (int(ver_numbers[0]), int(ver_numbers[1])), None
307         return None, 'no kernel version detected'
308
309
310 def add_kconfig_checks(l, arch):
311     # Calling the KconfigCheck class constructor:
312     #     KconfigCheck(reason, decision, name, expected)
313
314     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
315     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
316
317     # 'self_protection', 'defconfig'
318     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
319     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
320     l += [KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')]
321     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
322              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
323     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
324              KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
325     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
326              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
327              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
328     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
329              VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
330     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
331     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
332     if arch in ('X86_64', 'ARM64', 'X86_32'):
333         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
334         l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
335     if arch in ('X86_64', 'ARM64'):
336         l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
337     if arch in ('X86_64', 'X86_32'):
338         l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
339         l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
340         l += [KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y')]
341         l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
342         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
343                  KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
344     if arch in ('ARM64', 'ARM'):
345         l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
346     if arch == 'X86_64':
347         l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
348         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
349         l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
350                   iommu_support_is_set)]
351         l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
352                   iommu_support_is_set)]
353     if arch == 'ARM64':
354         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
355         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
356         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
357         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
358                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
359                      VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
360         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
361         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
362         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
363         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
364                  VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
365         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
366     if arch == 'ARM':
367         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
368         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
369
370     # 'self_protection', 'kspp'
371     l += [KconfigCheck('self_protection', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
372     l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
373     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
374     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
375     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
376     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
377     l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
378     l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
379     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
380     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
381     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
382     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
383     l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
384     l += [KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y')]
385     randstruct_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y')
386     l += [randstruct_is_set]
387     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
388     l += [hardened_usercopy_is_set]
389     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
390               hardened_usercopy_is_set)]
391     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
392               hardened_usercopy_is_set)]
393     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
394              modules_not_set)]
395     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
396              modules_not_set)]
397     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
398              modules_not_set)]
399     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
400              modules_not_set)] # refers to LOCKDOWN
401     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
402              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
403     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
404              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
405              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
406              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
407              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
408              # the 0xAA poison pattern on allocation.
409              # That brings higher performance penalty.
410     if arch in ('X86_64', 'ARM64', 'X86_32'):
411         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
412         l += [stackleak_is_set]
413         l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
414     if arch in ('X86_64', 'X86_32'):
415         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
416     if arch in ('ARM64', 'ARM'):
417         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
418         l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
419     if arch == 'ARM64':
420         l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
421     if arch == 'X86_32':
422         l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
423         l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
424         l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
425
426     # 'self_protection', 'maintainer'
427     ubsan_bounds_is_set = KconfigCheck('self_protection', 'maintainer', 'UBSAN_BOUNDS', 'y') # only array index bounds checking
428     l += [ubsan_bounds_is_set] # recommended by Kees Cook in /issues/53
429     l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_SANITIZE_ALL', 'y'),
430               ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
431     l += [AND(KconfigCheck('self_protection', 'maintainer', 'UBSAN_TRAP', 'y'),
432               ubsan_bounds_is_set)] # recommended by Kees Cook in /issues/53
433
434     # 'self_protection', 'clipos'
435     l += [KconfigCheck('self_protection', 'clipos', 'DEBUG_VIRTUAL', 'y')]
436     l += [KconfigCheck('self_protection', 'clipos', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
437     l += [KconfigCheck('self_protection', 'clipos', 'EFI_DISABLE_PCI_DMA', 'y')]
438     l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')] # slab_nomerge
439     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_BOOTLOADER', 'is not set')]
440     l += [KconfigCheck('self_protection', 'clipos', 'RANDOM_TRUST_CPU', 'is not set')]
441     l += [AND(KconfigCheck('self_protection', 'clipos', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
442               randstruct_is_set)]
443     if arch in ('X86_64', 'ARM64', 'X86_32'):
444         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_METRICS', 'is not set'),
445                   stackleak_is_set)]
446         l += [AND(KconfigCheck('self_protection', 'clipos', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
447                   stackleak_is_set)]
448     if arch in ('X86_64', 'X86_32'):
449         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
450                   iommu_support_is_set)]
451     if arch == 'X86_64':
452         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU_SVM', 'y'),
453                   iommu_support_is_set)]
454     if arch == 'X86_32':
455         l += [AND(KconfigCheck('self_protection', 'clipos', 'INTEL_IOMMU', 'y'),
456                   iommu_support_is_set)]
457
458     # 'self_protection', 'my'
459     l += [KconfigCheck('self_protection', 'my', 'RESET_ATTACK_MITIGATION', 'y')] # needs userspace support (systemd)
460     if arch == 'X86_64':
461         l += [AND(KconfigCheck('self_protection', 'my', 'AMD_IOMMU_V2', 'y'),
462                   iommu_support_is_set)]
463     if arch == 'ARM64':
464         l += [KconfigCheck('self_protection', 'my', 'SHADOW_CALL_STACK', 'y')] # depends on clang, maybe it's alternative to STACKPROTECTOR_STRONG
465         l += [KconfigCheck('self_protection', 'my', 'KASAN_HW_TAGS', 'y')]
466         cfi_clang_is_set = KconfigCheck('self_protection', 'my', 'CFI_CLANG', 'y')
467         l += [cfi_clang_is_set]
468         l += [AND(KconfigCheck('self_protection', 'my', 'CFI_PERMISSIVE', 'is not set'),
469                   cfi_clang_is_set)]
470
471     # 'security_policy'
472     if arch in ('X86_64', 'ARM64', 'X86_32'):
473         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')] # and choose your favourite LSM
474     if arch == 'ARM':
475         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')] # and choose your favourite LSM
476     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
477     l += [OR(KconfigCheck('security_policy', 'my', 'SECURITY_WRITABLE_HOOKS', 'is not set'),
478              KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set'))]
479     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM', 'y')]
480     l += [KconfigCheck('security_policy', 'clipos', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
481     l += [KconfigCheck('security_policy', 'clipos', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
482     l += [KconfigCheck('security_policy', 'my', 'SECURITY_SAFESETID', 'y')]
483     loadpin_is_set = KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN', 'y')
484     l += [loadpin_is_set] # needs userspace support
485     l += [AND(KconfigCheck('security_policy', 'my', 'SECURITY_LOADPIN_ENFORCE', 'y'),
486               loadpin_is_set)]
487
488     # 'cut_attack_surface', 'defconfig'
489     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
490     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
491     if arch in ('X86_64', 'ARM64', 'X86_32'):
492         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
493                  devmem_not_set)] # refers to LOCKDOWN
494
495     # 'cut_attack_surface', 'kspp'
496     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
497     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
498     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
499     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
500     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
501     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
502     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
503     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
504     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
505     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
506     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
507     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
508     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
509     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
510     l += [modules_not_set]
511     l += [devmem_not_set]
512     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
513              devmem_not_set)] # refers to LOCKDOWN
514     if arch == 'ARM':
515         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
516                  devmem_not_set)] # refers to LOCKDOWN
517     if arch == 'X86_64':
518         l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y')] # 'vsyscall=none'
519
520     # 'cut_attack_surface', 'grsec'
521     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
522     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
523     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
524     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
525     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
526     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
527     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
528     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
529     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
530     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
531     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
532     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
533     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
534     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
535     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
536     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
537     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
538     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
539     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
540     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
541     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
542     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
543     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
544     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
545     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
546     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
547     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
548     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
549     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
550     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
551     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
552     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
553     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
554     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
555     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
556     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
557     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
558     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
559               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
560
561     # 'cut_attack_surface', 'maintainer'
562     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
563     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
564     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
565     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
566
567     # 'cut_attack_surface', 'grapheneos'
568     l += [KconfigCheck('cut_attack_surface', 'grapheneos', 'AIO', 'is not set')]
569
570     # 'cut_attack_surface', 'clipos'
571     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
572     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
573 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
574     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
575     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set')]
576     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
577     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
578     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
579     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
580     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
581     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
582     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
583     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
584     l += [AND(KconfigCheck('cut_attack_surface', 'clipos', 'LDISC_AUTOLOAD', 'is not set'),
585               PresenceCheck('LDISC_AUTOLOAD', 'kconfig'))]
586     if arch in ('X86_64', 'X86_32'):
587         l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
588
589     # 'cut_attack_surface', 'lockdown'
590     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
591     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set')] # refers to LOCKDOWN
592     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
593     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
594
595     # 'cut_attack_surface', 'my'
596     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
597              modules_not_set)]
598     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
599     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
600     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
601     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
602     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
603     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
604     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
605
606     # 'harden_userspace'
607     if arch in ('X86_64', 'ARM64', 'X86_32'):
608         l += [KconfigCheck('harden_userspace', 'defconfig', 'INTEGRITY', 'y')]
609     if arch == 'ARM':
610         l += [KconfigCheck('harden_userspace', 'my', 'INTEGRITY', 'y')]
611     if arch == 'ARM64':
612         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_MTE', 'y')]
613     if arch in ('ARM', 'X86_32'):
614         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
615     if arch in ('X86_64', 'ARM64'):
616         l += [KconfigCheck('harden_userspace', 'clipos', 'ARCH_MMAP_RND_BITS', '32')]
617     if arch in ('X86_32', 'ARM'):
618         l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', '16')]
619
620 #   l += [KconfigCheck('feature_test', 'my', 'LKDTM', 'm')] # only for debugging!
621
622
623 def print_unknown_options(checklist, parsed_options):
624     known_options = []
625
626     for o1 in checklist:
627         if not hasattr(o1, 'opts'):
628             known_options.append(o1.name)
629             continue
630         for o2 in o1.opts:
631             if not hasattr(o2, 'opts'):
632                 if hasattr(o2, 'name'):
633                     known_options.append(o2.name)
634                 continue
635             for o3 in o2.opts:
636                 if hasattr(o3, 'opts'):
637                     sys.exit('[!] ERROR: unexpected ComplexOptCheck inside {}'.format(o2.name))
638                 if hasattr(o3, 'name'):
639                     known_options.append(o3.name)
640
641     for option, value in parsed_options.items():
642         if option not in known_options:
643             print('[?] No check for option {} ({})'.format(option, value))
644
645
646 def print_checklist(mode, checklist, with_results):
647     if mode == 'json':
648         opts = []
649         for o in checklist:
650             opt = [o.name, o.type, o.expected, o.decision, o.reason]
651             if with_results:
652                 opt.append(o.result)
653             opts.append(opt)
654         print(json.dumps(opts))
655         return
656
657     # table header
658     sep_line_len = 91
659     if with_results:
660         sep_line_len += 30
661     print('=' * sep_line_len)
662     print('{:^40}|{:^7}|{:^12}|{:^10}|{:^18}'.format('option name', 'type', 'desired val', 'decision', 'reason'), end='')
663     if with_results:
664         print('| {}'.format('check result'), end='')
665     print()
666     print('=' * sep_line_len)
667
668     # table contents
669     for opt in checklist:
670         if with_results:
671             if mode == 'show_ok':
672                 if not opt.result.startswith('OK'):
673                     continue
674             if mode == 'show_fail':
675                 if not opt.result.startswith('FAIL'):
676                     continue
677         opt.table_print(mode, with_results)
678         print()
679         if mode == 'verbose':
680             print('-' * sep_line_len)
681     print()
682
683     # final score
684     if with_results:
685         fail_count = len(list(filter(lambda opt: opt.result.startswith('FAIL'), checklist)))
686         fail_suppressed = ''
687         ok_count = len(list(filter(lambda opt: opt.result.startswith('OK'), checklist)))
688         ok_suppressed = ''
689         if mode == 'show_ok':
690             fail_suppressed = ' (suppressed in output)'
691         if mode == 'show_fail':
692             ok_suppressed = ' (suppressed in output)'
693         if mode != 'json':
694             print('[+] Config check is finished: \'OK\' - {}{} / \'FAIL\' - {}{}'.format(ok_count, ok_suppressed, fail_count, fail_suppressed))
695
696
697 def populate_simple_opt_with_data(opt, data, data_type):
698     if hasattr(opt, 'opts'):
699         sys.exit('[!] ERROR: unexpected ComplexOptCheck {}: {}'.format(opt.name, vars(opt)))
700     if data_type not in TYPES_OF_CHECKS:
701         sys.exit('[!] ERROR: invalid data type "{}"'.format(data_type))
702     if data_type != opt.type:
703         return
704     if data_type == 'kconfig':
705         opt.state = data.get(opt.name, None)
706     elif data_type == 'version':
707         opt.ver = data
708
709
710 def populate_opt_with_data(opt, data, data_type):
711     if hasattr(opt, 'opts'):
712         for o in opt.opts:
713             if hasattr(o, 'opts'):
714                 # Recursion for nested ComplexOptCheck objects
715                 populate_opt_with_data(o, data, data_type)
716             else:
717                 populate_simple_opt_with_data(o, data, data_type)
718     else:
719         # The 'state' is mandatory for simple checks
720         if not hasattr(opt, 'state'):
721             sys.exit('[!] ERROR: bad simple check {}'.format(vars(opt)))
722         populate_simple_opt_with_data(opt, data, data_type)
723
724
725 def populate_with_data(checklist, data, data_type):
726     for opt in checklist:
727         populate_opt_with_data(opt, data, data_type)
728
729
730 def perform_checks(checklist):
731     for opt in checklist:
732         opt.check()
733
734
735 def parse_kconfig_file(parsed_options, fname):
736     with open(fname, 'r') as f:
737         opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]*=[a-zA-Z0-9_\"]*")
738         opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]* is not set")
739
740         for line in f.readlines():
741             line = line.strip()
742             option = None
743             value = None
744
745             if opt_is_on.match(line):
746                 option, value = line.split('=', 1)
747             elif opt_is_off.match(line):
748                 option, value = line[2:].split(' ', 1)
749                 if value != 'is not set':
750                     sys.exit('[!] ERROR: bad disabled kconfig option "{}"'.format(line))
751
752             if option in parsed_options:
753                 sys.exit('[!] ERROR: kconfig option "{}" exists multiple times'.format(line))
754
755             if option:
756                 parsed_options[option] = value
757
758         return parsed_options
759
760
761 def main():
762     # Report modes:
763     #   * verbose mode for
764     #     - reporting about unknown kernel options in the kconfig
765     #     - verbose printing of ComplexOptCheck items
766     #   * json mode for printing the results in JSON format
767     report_modes = ['verbose', 'json', 'show_ok', 'show_fail']
768     supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM']
769     parser = ArgumentParser(prog='kconfig-hardened-check',
770                             description='A tool for checking the security hardening options of the Linux kernel')
771     parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
772     parser.add_argument('-p', '--print', choices=supported_archs,
773                         help='print security hardening preferences for the selected architecture')
774     parser.add_argument('-c', '--config',
775                         help='check the kernel kconfig file against these preferences')
776     parser.add_argument('-m', '--mode', choices=report_modes,
777                         help='choose the report mode')
778     args = parser.parse_args()
779
780     mode = None
781     if args.mode:
782         mode = args.mode
783         if mode != 'json':
784             print('[+] Special report mode: {}'.format(mode))
785
786     config_checklist = []
787
788     if args.config:
789         if mode != 'json':
790             print('[+] Kconfig file to check: {}'.format(args.config))
791
792         arch, msg = detect_arch(args.config, supported_archs)
793         if not arch:
794             sys.exit('[!] ERROR: {}'.format(msg))
795         if mode != 'json':
796             print('[+] Detected architecture: {}'.format(arch))
797
798         kernel_version, msg = detect_version(args.config)
799         if not kernel_version:
800             sys.exit('[!] ERROR: {}'.format(msg))
801         if mode != 'json':
802             print('[+] Detected kernel version: {}.{}'.format(kernel_version[0], kernel_version[1]))
803
804         # add relevant kconfig checks to the checklist
805         add_kconfig_checks(config_checklist, arch)
806
807         # populate the checklist with the parsed kconfig data
808         parsed_kconfig_options = OrderedDict()
809         parse_kconfig_file(parsed_kconfig_options, args.config)
810         populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')
811         populate_with_data(config_checklist, kernel_version, 'version')
812
813         # now everything is ready for performing the checks
814         perform_checks(config_checklist)
815
816         # finally print the results
817         if mode == 'verbose':
818             print_unknown_options(config_checklist, parsed_kconfig_options)
819         print_checklist(mode, config_checklist, True)
820
821         sys.exit(0)
822
823     if args.print:
824         if mode in ('show_ok', 'show_fail'):
825             sys.exit('[!] ERROR: wrong mode "{}" for --print'.format(mode))
826         arch = args.print
827         add_kconfig_checks(config_checklist, arch)
828         if mode != 'json':
829             print('[+] Printing kernel security hardening preferences for {}...'.format(arch))
830         print_checklist(mode, config_checklist, False)
831         sys.exit(0)
832
833     parser.print_help()
834     sys.exit(0)
835
836 if __name__ == '__main__':
837     main()