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