43a4c648bba53fed54727838f518e6b4ed616d3f
[kconfig-hardened-check.git] / kconfig_hardened_check / checks.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 This module contains knowledge for checks.
11 """
12
13 # N.B. Hardening sysctls:
14 #    kernel.kptr_restrict=2 (or 1?)
15 #    kernel.dmesg_restrict=1 (also see the kconfig option)
16 #    kernel.perf_event_paranoid=2 (or 3 with a custom patch, see https://lwn.net/Articles/696216/)
17 #    kernel.kexec_load_disabled=1
18 #    kernel.yama.ptrace_scope=3
19 #    user.max_user_namespaces=0
20 #    what about bpf_jit_enable?
21 #    kernel.unprivileged_bpf_disabled=1
22 #    net.core.bpf_jit_harden=2
23 #    vm.unprivileged_userfaultfd=0
24 #        (at first, it disabled unprivileged userfaultfd,
25 #         and since v5.11 it enables unprivileged userfaultfd for user-mode only)
26 #    vm.mmap_min_addr has a good value
27 #    dev.tty.ldisc_autoload=0
28 #    fs.protected_symlinks=1
29 #    fs.protected_hardlinks=1
30 #    fs.protected_fifos=2
31 #    fs.protected_regular=2
32 #    fs.suid_dumpable=0
33 #    kernel.modules_disabled=1
34 #    kernel.randomize_va_space=2
35 #    nosmt sysfs control file
36 #    dev.tty.legacy_tiocsti=0
37 #    vm.mmap_rnd_bits=max (?)
38 #    kernel.sysrq=0
39 #
40 # Think of these boot params:
41 #    module.sig_enforce=1
42 #    lockdown=confidentiality
43 #    mce=0
44 #    nosmt=force
45 #    intel_iommu=on
46 #    amd_iommu=on
47 #    efi=disable_early_pci_dma
48
49 # pylint: disable=missing-function-docstring,line-too-long,invalid-name
50 # pylint: disable=too-many-branches,too-many-statements
51
52 from .engine import KconfigCheck, CmdlineCheck, VersionCheck, OR, AND
53
54
55 def add_kconfig_checks(l, arch):
56     # Calling the KconfigCheck class constructor:
57     #     KconfigCheck(reason, decision, name, expected)
58     #
59     # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
60     #     when the tool doesn't check the cmdline.
61
62     efi_not_set = KconfigCheck('-', '-', 'EFI', 'is not set')
63     cc_is_gcc = KconfigCheck('-', '-', 'CC_IS_GCC', 'y') # exists since v4.18
64     cc_is_clang = KconfigCheck('-', '-', 'CC_IS_CLANG', 'y') # exists since v4.18
65
66     modules_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'MODULES', 'is not set')
67     devmem_not_set = KconfigCheck('cut_attack_surface', 'kspp', 'DEVMEM', 'is not set') # refers to LOCKDOWN
68     bpf_syscall_not_set = KconfigCheck('cut_attack_surface', 'lockdown', 'BPF_SYSCALL', 'is not set') # refers to LOCKDOWN
69
70     # 'self_protection', 'defconfig'
71     l += [KconfigCheck('self_protection', 'defconfig', 'BUG', 'y')]
72     l += [KconfigCheck('self_protection', 'defconfig', 'SLUB_DEBUG', 'y')]
73     l += [KconfigCheck('self_protection', 'defconfig', 'THREAD_INFO_IN_TASK', 'y')]
74     gcc_plugins_support_is_set = KconfigCheck('self_protection', 'defconfig', 'GCC_PLUGINS', 'y')
75     l += [gcc_plugins_support_is_set]
76     iommu_support_is_set = KconfigCheck('self_protection', 'defconfig', 'IOMMU_SUPPORT', 'y')
77     l += [iommu_support_is_set] # is needed for mitigating DMA attacks
78     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR', 'y'),
79              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR', 'y'),
80              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_REGULAR', 'y'),
81              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_AUTO', 'y'),
82              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
83     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_STRONG', 'y'),
84              KconfigCheck('self_protection', 'defconfig', 'CC_STACKPROTECTOR_STRONG', 'y'))]
85     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_KERNEL_RWX', 'y'),
86              KconfigCheck('self_protection', 'defconfig', 'DEBUG_RODATA', 'y'))] # before v4.11
87     l += [OR(KconfigCheck('self_protection', 'defconfig', 'STRICT_MODULE_RWX', 'y'),
88              KconfigCheck('self_protection', 'defconfig', 'DEBUG_SET_MODULE_RONX', 'y'),
89              modules_not_set)] # DEBUG_SET_MODULE_RONX was before v4.11
90     l += [OR(KconfigCheck('self_protection', 'defconfig', 'REFCOUNT_FULL', 'y'),
91              VersionCheck((5, 5)))] # REFCOUNT_FULL is enabled by default since v5.5
92     if arch in ('X86_64', 'ARM64', 'X86_32'):
93         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y')]
94     if arch in ('X86_64', 'ARM64', 'ARM'):
95         l += [KconfigCheck('self_protection', 'defconfig', 'VMAP_STACK', 'y')]
96     if arch in ('X86_64', 'X86_32'):
97         l += [KconfigCheck('self_protection', 'defconfig', 'DEBUG_WX', 'y')]
98         l += [KconfigCheck('self_protection', 'defconfig', 'WERROR', 'y')]
99         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE', 'y')]
100         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_INTEL', 'y')]
101         l += [KconfigCheck('self_protection', 'defconfig', 'X86_MCE_AMD', 'y')]
102         l += [KconfigCheck('self_protection', 'defconfig', 'MICROCODE', 'y')] # is needed for mitigating CPU bugs
103         l += [KconfigCheck('self_protection', 'defconfig', 'RETPOLINE', 'y')]
104         l += [KconfigCheck('self_protection', 'defconfig', 'SYN_COOKIES', 'y')] # another reason?
105         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_SMAP', 'y'),
106                  VersionCheck((5, 19)))] # X86_SMAP is enabled by default since v5.19
107         l += [OR(KconfigCheck('self_protection', 'defconfig', 'X86_UMIP', 'y'),
108                  KconfigCheck('self_protection', 'defconfig', 'X86_INTEL_UMIP', 'y'))]
109     if arch in ('ARM64', 'ARM'):
110         l += [KconfigCheck('self_protection', 'defconfig', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
111         l += [KconfigCheck('self_protection', 'defconfig', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
112         l += [KconfigCheck('self_protection', 'defconfig', 'STACKPROTECTOR_PER_TASK', 'y')]
113     if arch == 'X86_64':
114         l += [KconfigCheck('self_protection', 'defconfig', 'PAGE_TABLE_ISOLATION', 'y')]
115         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MEMORY', 'y')]
116         l += [AND(KconfigCheck('self_protection', 'defconfig', 'INTEL_IOMMU', 'y'),
117                   iommu_support_is_set)]
118         l += [AND(KconfigCheck('self_protection', 'defconfig', 'AMD_IOMMU', 'y'),
119                   iommu_support_is_set)]
120     if arch == 'ARM64':
121         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PAN', 'y')]
122         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_EPAN', 'y')]
123         l += [KconfigCheck('self_protection', 'defconfig', 'UNMAP_KERNEL_AT_EL0', 'y')]
124         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_E0PD', 'y')]
125         l += [KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y')]
126         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_PTR_AUTH_KERNEL', 'y')]
127         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_BTI_KERNEL', 'y')]
128         l += [KconfigCheck('self_protection', 'defconfig', 'MITIGATE_SPECTRE_BRANCH_HISTORY', 'y')]
129         l += [KconfigCheck('self_protection', 'defconfig', 'ARM64_MTE', 'y')]
130         l += [KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_MODULE_REGION_FULL', 'y')]
131         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_EL2_VECTORS', 'y'),
132                  AND(KconfigCheck('self_protection', 'defconfig', 'RANDOMIZE_BASE', 'y'),
133                      VersionCheck((5, 9))))] # HARDEN_EL2_VECTORS was included in RANDOMIZE_BASE in v5.9
134         l += [OR(KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y'),
135                  VersionCheck((5, 10)))] # HARDEN_BRANCH_PREDICTOR is enabled by default since v5.10
136     if arch == 'ARM':
137         l += [KconfigCheck('self_protection', 'defconfig', 'CPU_SW_DOMAIN_PAN', 'y')]
138         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_PREDICTOR', 'y')]
139         l += [KconfigCheck('self_protection', 'defconfig', 'HARDEN_BRANCH_HISTORY', 'y')]
140         l += [KconfigCheck('self_protection', 'defconfig', 'DEBUG_ALIGN_RODATA', 'y')]
141
142     # 'self_protection', 'kspp'
143     l += [KconfigCheck('self_protection', 'kspp', 'BUG_ON_DATA_CORRUPTION', 'y')]
144     l += [KconfigCheck('self_protection', 'kspp', 'SCHED_STACK_END_CHECK', 'y')]
145     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_HARDENED', 'y')]
146     l += [KconfigCheck('self_protection', 'kspp', 'SLAB_FREELIST_RANDOM', 'y')]
147     l += [KconfigCheck('self_protection', 'kspp', 'SHUFFLE_PAGE_ALLOCATOR', 'y')]
148     l += [KconfigCheck('self_protection', 'kspp', 'FORTIFY_SOURCE', 'y')]
149     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_LIST', 'y')]
150     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_VIRTUAL', 'y')]
151     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_SG', 'y')]
152     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_CREDENTIALS', 'y')]
153     l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_NOTIFIERS', 'y')]
154     l += [KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y')]
155     l += [KconfigCheck('self_protection', 'kspp', 'KFENCE', 'y')]
156     l += [KconfigCheck('self_protection', 'kspp', 'ZERO_CALL_USED_REGS', 'y')]
157     l += [KconfigCheck('self_protection', 'kspp', 'HW_RANDOM_TPM', 'y')]
158     l += [KconfigCheck('self_protection', 'kspp', 'STATIC_USERMODEHELPER', 'y')] # needs userspace support
159     randstruct_is_set = OR(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_FULL', 'y'),
160                            KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT', 'y'))
161     l += [randstruct_is_set]
162     l += [AND(KconfigCheck('self_protection', 'kspp', 'RANDSTRUCT_PERFORMANCE', 'is not set'),
163               KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_RANDSTRUCT_PERFORMANCE', 'is not set'),
164               randstruct_is_set)]
165     hardened_usercopy_is_set = KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y')
166     l += [hardened_usercopy_is_set]
167     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
168               hardened_usercopy_is_set)]
169     l += [AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_PAGESPAN', 'is not set'),
170               hardened_usercopy_is_set)]
171     l += [AND(KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_LATENT_ENTROPY', 'y'),
172               gcc_plugins_support_is_set)]
173     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG', 'y'),
174              modules_not_set)]
175     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_ALL', 'y'),
176              modules_not_set)]
177     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_SHA512', 'y'),
178              modules_not_set)]
179     l += [OR(KconfigCheck('self_protection', 'kspp', 'MODULE_SIG_FORCE', 'y'),
180              modules_not_set)] # refers to LOCKDOWN
181     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_STACK_ALL_ZERO', 'y'),
182              KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STRUCTLEAK_BYREF_ALL', 'y'))]
183     l += [OR(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
184              KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'))]
185              # CONFIG_INIT_ON_FREE_DEFAULT_ON was added in v5.3.
186              # CONFIG_PAGE_POISONING_ZERO was removed in v5.11.
187              # Starting from v5.11 CONFIG_PAGE_POISONING unconditionally checks
188              # the 0xAA poison pattern on allocation.
189              # That brings higher performance penalty.
190     l += [OR(KconfigCheck('self_protection', 'kspp', 'EFI_DISABLE_PCI_DMA', 'y'),
191              efi_not_set)]
192     l += [OR(KconfigCheck('self_protection', 'kspp', 'RESET_ATTACK_MITIGATION', 'y'),
193              efi_not_set)] # needs userspace support (systemd)
194     ubsan_bounds_is_set = KconfigCheck('self_protection', 'kspp', 'UBSAN_BOUNDS', 'y')
195     l += [ubsan_bounds_is_set]
196     l += [OR(KconfigCheck('self_protection', 'kspp', 'UBSAN_LOCAL_BOUNDS', 'y'),
197              AND(ubsan_bounds_is_set,
198                  cc_is_gcc))]
199     l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_TRAP', 'y'),
200               ubsan_bounds_is_set,
201               KconfigCheck('self_protection', 'kspp', 'UBSAN_SHIFT', 'is not set'),
202               KconfigCheck('self_protection', 'kspp', 'UBSAN_DIV_ZERO', 'is not set'),
203               KconfigCheck('self_protection', 'kspp', 'UBSAN_UNREACHABLE', 'is not set'),
204               KconfigCheck('self_protection', 'kspp', 'UBSAN_BOOL', 'is not set'),
205               KconfigCheck('self_protection', 'kspp', 'UBSAN_ENUM', 'is not set'),
206               KconfigCheck('self_protection', 'kspp', 'UBSAN_ALIGNMENT', 'is not set'))] # only array index bounds checking with traps
207     if arch in ('X86_64', 'ARM64', 'X86_32'):
208         l += [AND(KconfigCheck('self_protection', 'kspp', 'UBSAN_SANITIZE_ALL', 'y'),
209                   ubsan_bounds_is_set)] # ARCH_HAS_UBSAN_SANITIZE_ALL is not enabled for ARM
210         stackleak_is_set = KconfigCheck('self_protection', 'kspp', 'GCC_PLUGIN_STACKLEAK', 'y')
211         l += [AND(stackleak_is_set, gcc_plugins_support_is_set)]
212         l += [AND(KconfigCheck('self_protection', 'kspp', 'STACKLEAK_METRICS', 'is not set'),
213                   stackleak_is_set,
214                   gcc_plugins_support_is_set)]
215         l += [AND(KconfigCheck('self_protection', 'kspp', 'STACKLEAK_RUNTIME_DISABLE', 'is not set'),
216                   stackleak_is_set,
217                   gcc_plugins_support_is_set)]
218         l += [KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y')]
219     if arch in ('X86_64', 'ARM64'):
220         cfi_clang_is_set = KconfigCheck('self_protection', 'kspp', 'CFI_CLANG', 'y')
221         l += [cfi_clang_is_set]
222         l += [AND(KconfigCheck('self_protection', 'kspp', 'CFI_PERMISSIVE', 'is not set'),
223                   cfi_clang_is_set)]
224     if arch in ('X86_64', 'X86_32'):
225         l += [KconfigCheck('self_protection', 'kspp', 'SCHED_CORE', 'y')]
226         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '65536')]
227         l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y')]
228         l += [KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set')] # true if IOMMU_DEFAULT_DMA_STRICT is set
229         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU_DEFAULT_ON', 'y'),
230                   iommu_support_is_set)]
231     if arch in ('ARM64', 'ARM'):
232         l += [KconfigCheck('self_protection', 'kspp', 'DEBUG_WX', 'y')]
233         l += [KconfigCheck('self_protection', 'kspp', 'WERROR', 'y')]
234         l += [KconfigCheck('self_protection', 'kspp', 'DEFAULT_MMAP_MIN_ADDR', '32768')]
235         l += [KconfigCheck('self_protection', 'kspp', 'SYN_COOKIES', 'y')] # another reason?
236     if arch == 'X86_64':
237         l += [KconfigCheck('self_protection', 'kspp', 'SLS', 'y')] # vs CVE-2021-26341 in Straight-Line-Speculation
238         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU_SVM', 'y'),
239                   iommu_support_is_set)]
240         l += [AND(KconfigCheck('self_protection', 'kspp', 'AMD_IOMMU_V2', 'y'),
241                   iommu_support_is_set)]
242     if arch == 'ARM64':
243         l += [KconfigCheck('self_protection', 'kspp', 'ARM64_SW_TTBR0_PAN', 'y')]
244         l += [KconfigCheck('self_protection', 'kspp', 'SHADOW_CALL_STACK', 'y')]
245         l += [KconfigCheck('self_protection', 'kspp', 'KASAN_HW_TAGS', 'y')] # see also: kasan=on, kasan.stacktrace=off, kasan.fault=panic
246     if arch == 'X86_32':
247         l += [KconfigCheck('self_protection', 'kspp', 'PAGE_TABLE_ISOLATION', 'y')]
248         l += [KconfigCheck('self_protection', 'kspp', 'HIGHMEM64G', 'y')]
249         l += [KconfigCheck('self_protection', 'kspp', 'X86_PAE', 'y')]
250         l += [AND(KconfigCheck('self_protection', 'kspp', 'INTEL_IOMMU', 'y'),
251                   iommu_support_is_set)]
252
253     # 'self_protection', 'clipos'
254     l += [KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set')]
255
256     # 'security_policy'
257     if arch in ('X86_64', 'ARM64', 'X86_32'):
258         l += [KconfigCheck('security_policy', 'defconfig', 'SECURITY', 'y')]
259     if arch == 'ARM':
260         l += [KconfigCheck('security_policy', 'kspp', 'SECURITY', 'y')]
261     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_YAMA', 'y')]
262     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LANDLOCK', 'y')]
263     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DISABLE', 'is not set')]
264     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_BOOTPARAM', 'is not set')]
265     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_SELINUX_DEVELOP', 'is not set')]
266     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM', 'y')]
267     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_LOCKDOWN_LSM_EARLY', 'y')]
268     l += [KconfigCheck('security_policy', 'kspp', 'LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY', 'y')]
269     l += [KconfigCheck('security_policy', 'kspp', 'SECURITY_WRITABLE_HOOKS', 'is not set')] # refers to SECURITY_SELINUX_DISABLE
270     l += [OR(KconfigCheck('security_policy', 'my', 'SECURITY_SELINUX', 'y'),
271              KconfigCheck('security_policy', 'my', 'SECURITY_APPARMOR', 'y'),
272              KconfigCheck('security_policy', 'my', 'SECURITY_SMACK', 'y'),
273              KconfigCheck('security_policy', 'my', 'SECURITY_TOMOYO', 'y'))] # one of major LSMs implementing MAC
274
275     # 'cut_attack_surface', 'defconfig'
276     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP', 'y')]
277     l += [KconfigCheck('cut_attack_surface', 'defconfig', 'SECCOMP_FILTER', 'y')]
278     l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'BPF_UNPRIV_DEFAULT_OFF', 'y'),
279              bpf_syscall_not_set)] # see unprivileged_bpf_disabled
280     if arch in ('X86_64', 'ARM64', 'X86_32'):
281         l += [OR(KconfigCheck('cut_attack_surface', 'defconfig', 'STRICT_DEVMEM', 'y'),
282                  devmem_not_set)] # refers to LOCKDOWN
283     if arch in ('X86_64', 'X86_32'):
284         l += [KconfigCheck('cut_attack_surface', 'defconfig', 'X86_INTEL_TSX_MODE_OFF', 'y')] # tsx=off
285
286     # 'cut_attack_surface', 'kspp'
287     l += [KconfigCheck('cut_attack_surface', 'kspp', 'SECURITY_DMESG_RESTRICT', 'y')]
288     l += [KconfigCheck('cut_attack_surface', 'kspp', 'ACPI_CUSTOM_METHOD', 'is not set')] # refers to LOCKDOWN
289     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_BRK', 'is not set')]
290     l += [KconfigCheck('cut_attack_surface', 'kspp', 'DEVKMEM', 'is not set')] # refers to LOCKDOWN
291     l += [KconfigCheck('cut_attack_surface', 'kspp', 'BINFMT_MISC', 'is not set')]
292     l += [KconfigCheck('cut_attack_surface', 'kspp', 'INET_DIAG', 'is not set')]
293     l += [KconfigCheck('cut_attack_surface', 'kspp', 'KEXEC', 'is not set')] # refers to LOCKDOWN
294     l += [KconfigCheck('cut_attack_surface', 'kspp', 'PROC_KCORE', 'is not set')] # refers to LOCKDOWN
295     l += [KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_PTYS', 'is not set')]
296     l += [KconfigCheck('cut_attack_surface', 'kspp', 'HIBERNATION', 'is not set')] # refers to LOCKDOWN
297     l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT', 'is not set')]
298     l += [KconfigCheck('cut_attack_surface', 'kspp', 'IA32_EMULATION', 'is not set')]
299     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32', 'is not set')]
300     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_X32_ABI', 'is not set')]
301     l += [KconfigCheck('cut_attack_surface', 'kspp', 'MODIFY_LDT_SYSCALL', 'is not set')]
302     l += [KconfigCheck('cut_attack_surface', 'kspp', 'OABI_COMPAT', 'is not set')]
303     l += [KconfigCheck('cut_attack_surface', 'kspp', 'X86_MSR', 'is not set')] # refers to LOCKDOWN
304     l += [modules_not_set]
305     l += [devmem_not_set]
306     l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'IO_STRICT_DEVMEM', 'y'),
307              devmem_not_set)] # refers to LOCKDOWN
308     l += [AND(KconfigCheck('cut_attack_surface', 'kspp', 'LDISC_AUTOLOAD', 'is not set'),
309               KconfigCheck('cut_attack_surface', 'kspp', 'LDISC_AUTOLOAD', 'is present'))]
310     if arch in ('X86_64', 'X86_32'):
311         l += [KconfigCheck('cut_attack_surface', 'kspp', 'COMPAT_VDSO', 'is not set')]
312               # CONFIG_COMPAT_VDSO disabled ASLR of vDSO only on X86_64 and X86_32;
313               # on ARM64 this option has different meaning
314     if arch == 'ARM':
315         l += [OR(KconfigCheck('cut_attack_surface', 'kspp', 'STRICT_DEVMEM', 'y'),
316                  devmem_not_set)] # refers to LOCKDOWN
317
318     # 'cut_attack_surface', 'grsec'
319     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ZSMALLOC_STAT', 'is not set')]
320     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PAGE_OWNER', 'is not set')]
321     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_KMEMLEAK', 'is not set')]
322     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BINFMT_AOUT', 'is not set')]
323     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KPROBE_EVENTS', 'is not set')]
324     l += [KconfigCheck('cut_attack_surface', 'grsec', 'UPROBE_EVENTS', 'is not set')]
325     l += [KconfigCheck('cut_attack_surface', 'grsec', 'GENERIC_TRACER', 'is not set')] # refers to LOCKDOWN
326     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FUNCTION_TRACER', 'is not set')]
327     l += [KconfigCheck('cut_attack_surface', 'grsec', 'STACK_TRACER', 'is not set')]
328     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HIST_TRIGGERS', 'is not set')]
329     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BLK_DEV_IO_TRACE', 'is not set')]
330     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_VMCORE', 'is not set')]
331     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROC_PAGE_MONITOR', 'is not set')]
332     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USELIB', 'is not set')]
333     l += [KconfigCheck('cut_attack_surface', 'grsec', 'CHECKPOINT_RESTORE', 'is not set')]
334     l += [KconfigCheck('cut_attack_surface', 'grsec', 'USERFAULTFD', 'is not set')]
335     l += [KconfigCheck('cut_attack_surface', 'grsec', 'HWPOISON_INJECT', 'is not set')]
336     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MEM_SOFT_DIRTY', 'is not set')]
337     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEVPORT', 'is not set')] # refers to LOCKDOWN
338     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set')] # refers to LOCKDOWN
339     l += [KconfigCheck('cut_attack_surface', 'grsec', 'NOTIFIER_ERROR_INJECTION', 'is not set')]
340     l += [KconfigCheck('cut_attack_surface', 'grsec', 'FAIL_FUTEX', 'is not set')]
341     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PUNIT_ATOM_DEBUG', 'is not set')]
342     l += [KconfigCheck('cut_attack_surface', 'grsec', 'ACPI_CONFIGFS', 'is not set')]
343     l += [KconfigCheck('cut_attack_surface', 'grsec', 'EDAC_DEBUG', 'is not set')]
344     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DRM_I915_DEBUG', 'is not set')]
345     l += [KconfigCheck('cut_attack_surface', 'grsec', 'BCACHE_CLOSURES_DEBUG', 'is not set')]
346     l += [KconfigCheck('cut_attack_surface', 'grsec', 'DVB_C8SECTPFE', 'is not set')]
347     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_SLRAM', 'is not set')]
348     l += [KconfigCheck('cut_attack_surface', 'grsec', 'MTD_PHRAM', 'is not set')]
349     l += [KconfigCheck('cut_attack_surface', 'grsec', 'IO_URING', 'is not set')]
350     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCMP', 'is not set')]
351     l += [KconfigCheck('cut_attack_surface', 'grsec', 'RSEQ', 'is not set')]
352     l += [KconfigCheck('cut_attack_surface', 'grsec', 'LATENCYTOP', 'is not set')]
353     l += [KconfigCheck('cut_attack_surface', 'grsec', 'KCOV', 'is not set')]
354     l += [KconfigCheck('cut_attack_surface', 'grsec', 'PROVIDE_OHCI1394_DMA_INIT', 'is not set')]
355     l += [KconfigCheck('cut_attack_surface', 'grsec', 'SUNRPC_DEBUG', 'is not set')]
356     l += [AND(KconfigCheck('cut_attack_surface', 'grsec', 'PTDUMP_DEBUGFS', 'is not set'),
357               KconfigCheck('cut_attack_surface', 'grsec', 'X86_PTDUMP', 'is not set'))]
358
359     # 'cut_attack_surface', 'maintainer'
360     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'DRM_LEGACY', 'is not set')] # recommended by Daniel Vetter in /issues/38
361     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'FB', 'is not set')] # recommended by Daniel Vetter in /issues/38
362     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'VT', 'is not set')] # recommended by Daniel Vetter in /issues/38
363     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD', 'is not set')] # recommended by Denis Efremov in /pull/54
364     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'BLK_DEV_FD_RAWCMD', 'is not set')] # recommended by Denis Efremov in /pull/62
365     l += [KconfigCheck('cut_attack_surface', 'maintainer', 'NOUVEAU_LEGACY_CTX_SUPPORT', 'is not set')]
366                                             # recommended by Dave Airlie in kernel commit b30a43ac7132cdda
367
368     # 'cut_attack_surface', 'clipos'
369     l += [KconfigCheck('cut_attack_surface', 'clipos', 'STAGING', 'is not set')]
370     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KSM', 'is not set')] # to prevent FLUSH+RELOAD attack
371     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KALLSYMS', 'is not set')]
372     l += [KconfigCheck('cut_attack_surface', 'clipos', 'MAGIC_SYSRQ', 'is not set')]
373     l += [KconfigCheck('cut_attack_surface', 'clipos', 'KEXEC_FILE', 'is not set')] # refers to LOCKDOWN (permissive)
374     l += [KconfigCheck('cut_attack_surface', 'clipos', 'USER_NS', 'is not set')] # user.max_user_namespaces=0
375     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_CPUID', 'is not set')]
376     l += [KconfigCheck('cut_attack_surface', 'clipos', 'X86_IOPL_IOPERM', 'is not set')] # refers to LOCKDOWN
377     l += [KconfigCheck('cut_attack_surface', 'clipos', 'ACPI_TABLE_UPGRADE', 'is not set')] # refers to LOCKDOWN
378     l += [KconfigCheck('cut_attack_surface', 'clipos', 'EFI_CUSTOM_SSDT_OVERLAYS', 'is not set')]
379     l += [KconfigCheck('cut_attack_surface', 'clipos', 'COREDUMP', 'is not set')] # cut userspace attack surface
380 #   l += [KconfigCheck('cut_attack_surface', 'clipos', 'IKCONFIG', 'is not set')] # no, IKCONFIG is needed for this check :)
381     if arch == 'X86_64':
382         l += [OR(KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set'),
383                  KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'))]
384                  # disabling X86_VSYSCALL_EMULATION turns vsyscall off completely,
385                  # and LEGACY_VSYSCALL_NONE can be changed at boot time via the cmdline parameter
386
387     # 'cut_attack_surface', 'lockdown'
388     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'EFI_TEST', 'is not set')] # refers to LOCKDOWN
389     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'MMIOTRACE_TEST', 'is not set')] # refers to LOCKDOWN
390     l += [KconfigCheck('cut_attack_surface', 'lockdown', 'KPROBES', 'is not set')] # refers to LOCKDOWN
391     l += [bpf_syscall_not_set] # refers to LOCKDOWN
392
393     # 'cut_attack_surface', 'my'
394     l += [KconfigCheck('cut_attack_surface', 'my', 'LEGACY_TIOCSTI', 'is not set')]
395     l += [KconfigCheck('cut_attack_surface', 'my', 'MMIOTRACE', 'is not set')] # refers to LOCKDOWN (permissive)
396     l += [KconfigCheck('cut_attack_surface', 'my', 'LIVEPATCH', 'is not set')]
397     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_DCCP', 'is not set')]
398     l += [KconfigCheck('cut_attack_surface', 'my', 'IP_SCTP', 'is not set')]
399     l += [KconfigCheck('cut_attack_surface', 'my', 'FTRACE', 'is not set')] # refers to LOCKDOWN
400     l += [KconfigCheck('cut_attack_surface', 'my', 'VIDEO_VIVID', 'is not set')]
401     l += [KconfigCheck('cut_attack_surface', 'my', 'INPUT_EVBUG', 'is not set')] # Can be used as a keylogger
402     l += [KconfigCheck('cut_attack_surface', 'my', 'KGDB', 'is not set')]
403     l += [KconfigCheck('cut_attack_surface', 'my', 'AIO', 'is not set')]
404     l += [KconfigCheck('cut_attack_surface', 'my', 'CORESIGHT', 'is not set')]
405     l += [OR(KconfigCheck('cut_attack_surface', 'my', 'TRIM_UNUSED_KSYMS', 'y'),
406              modules_not_set)]
407
408     # 'harden_userspace'
409     if arch == 'ARM64':
410         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_PTR_AUTH', 'y')]
411         l += [KconfigCheck('harden_userspace', 'defconfig', 'ARM64_BTI', 'y')]
412     if arch in ('ARM', 'X86_32'):
413         l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
414     l += [KconfigCheck('harden_userspace', 'my', 'ARCH_MMAP_RND_BITS', 'MAX')] # 'MAX' value is refined using ARCH_MMAP_RND_BITS_MAX
415
416
417 def add_cmdline_checks(l, arch):
418     # Calling the CmdlineCheck class constructor:
419     #     CmdlineCheck(reason, decision, name, expected)
420     #
421     # [!] Don't add CmdlineChecks in add_kconfig_checks() to avoid wrong results
422     #     when the tool doesn't check the cmdline.
423     #
424     # [!] Make sure that values of the options in CmdlineChecks need normalization.
425     #     For more info see normalize_cmdline_options().
426     #
427     # A common pattern for checking the 'param_x' cmdline parameter
428     # that __overrides__ the 'PARAM_X_DEFAULT' kconfig option:
429     #   l += [OR(CmdlineCheck(reason, decision, 'param_x', '1'),
430     #            AND(KconfigCheck(reason, decision, 'PARAM_X_DEFAULT_ON', 'y'),
431     #                CmdlineCheck(reason, decision, 'param_x, 'is not set')))]
432     #
433     # Here we don't check the kconfig options or minimal kernel version
434     # required for the cmdline parameters. That would make the checks
435     # very complex and not give a 100% guarantee anyway.
436
437     # 'self_protection', 'defconfig'
438     l += [CmdlineCheck('self_protection', 'defconfig', 'nosmep', 'is not set')]
439     l += [CmdlineCheck('self_protection', 'defconfig', 'nosmap', 'is not set')]
440     l += [CmdlineCheck('self_protection', 'defconfig', 'nokaslr', 'is not set')]
441     l += [CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set')]
442     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v1', 'is not set')]
443     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_v2', 'is not set')]
444     l += [CmdlineCheck('self_protection', 'defconfig', 'nospectre_bhb', 'is not set')]
445     l += [CmdlineCheck('self_protection', 'defconfig', 'nospec_store_bypass_disable', 'is not set')]
446     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nobti', 'is not set')]
447     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nopauth', 'is not set')]
448     l += [CmdlineCheck('self_protection', 'defconfig', 'arm64.nomte', 'is not set')]
449     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not off'),
450              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
451                  CmdlineCheck('self_protection', 'defconfig', 'spectre_v2', 'is not set')))]
452     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not off'),
453              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
454                  CmdlineCheck('self_protection', 'defconfig', 'spectre_v2_user', 'is not set')))]
455     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not off'),
456              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
457                  CmdlineCheck('self_protection', 'defconfig', 'spec_store_bypass_disable', 'is not set')))]
458     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not off'),
459              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
460                  CmdlineCheck('self_protection', 'defconfig', 'l1tf', 'is not set')))]
461     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not off'),
462              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
463                  CmdlineCheck('self_protection', 'defconfig', 'mds', 'is not set')))]
464     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not off'),
465              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
466                  CmdlineCheck('self_protection', 'defconfig', 'tsx_async_abort', 'is not set')))]
467     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not off'),
468              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
469                  CmdlineCheck('self_protection', 'defconfig', 'srbds', 'is not set')))]
470     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not off'),
471              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
472                  CmdlineCheck('self_protection', 'defconfig', 'mmio_stale_data', 'is not set')))]
473     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not off'),
474              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
475                  CmdlineCheck('self_protection', 'defconfig', 'retbleed', 'is not set')))]
476     l += [OR(CmdlineCheck('self_protection', 'defconfig', 'kpti', 'is not off'),
477              AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
478                  CmdlineCheck('self_protection', 'defconfig', 'kpti', 'is not set')))]
479     if arch == 'ARM64':
480         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'kernel'),
481                  CmdlineCheck('self_protection', 'my', 'ssbd', 'force-on'),
482                  AND(CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt'),
483                      CmdlineCheck('self_protection', 'defconfig', 'ssbd', 'is not set')))]
484         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', 'full'),
485                  AND(KconfigCheck('self_protection', 'defconfig', 'RODATA_FULL_DEFAULT_ENABLED', 'y'),
486                      CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set')))]
487     else:
488         l += [OR(CmdlineCheck('self_protection', 'defconfig', 'rodata', '1'),
489                  CmdlineCheck('self_protection', 'defconfig', 'rodata', 'is not set'))]
490
491     # 'self_protection', 'kspp'
492     l += [CmdlineCheck('self_protection', 'kspp', 'nosmt', 'is present')]
493     l += [CmdlineCheck('self_protection', 'kspp', 'mitigations', 'auto,nosmt')] # 'nosmt' by kspp + 'auto' by defconfig
494     l += [CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set')] # consequence of 'slab_nomerge' by kspp
495     l += [CmdlineCheck('self_protection', 'kspp', 'slub_merge', 'is not set')] # consequence of 'slab_nomerge' by kspp
496     l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_nomerge', 'is present'),
497              AND(KconfigCheck('self_protection', 'clipos', 'SLAB_MERGE_DEFAULT', 'is not set'),
498                  CmdlineCheck('self_protection', 'kspp', 'slab_merge', 'is not set'),
499                  CmdlineCheck('self_protection', 'kspp', 'slub_merge', 'is not set')))]
500     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', '1'),
501              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_ALLOC_DEFAULT_ON', 'y'),
502                  CmdlineCheck('self_protection', 'kspp', 'init_on_alloc', 'is not set')))]
503     l += [OR(CmdlineCheck('self_protection', 'kspp', 'init_on_free', '1'),
504              AND(KconfigCheck('self_protection', 'kspp', 'INIT_ON_FREE_DEFAULT_ON', 'y'),
505                  CmdlineCheck('self_protection', 'kspp', 'init_on_free', 'is not set')),
506              AND(CmdlineCheck('self_protection', 'kspp', 'page_poison', '1'),
507                  KconfigCheck('self_protection', 'kspp', 'PAGE_POISONING_ZERO', 'y'),
508                  CmdlineCheck('self_protection', 'kspp', 'slub_debug', 'P')))]
509     l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.strict', '1'),
510              AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_DMA_STRICT', 'y'),
511                  CmdlineCheck('self_protection', 'kspp', 'iommu.strict', 'is not set')))]
512     l += [OR(CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', '0'),
513              AND(KconfigCheck('self_protection', 'kspp', 'IOMMU_DEFAULT_PASSTHROUGH', 'is not set'),
514                  CmdlineCheck('self_protection', 'kspp', 'iommu.passthrough', 'is not set')))]
515     # The cmdline checks compatible with the kconfig recommendations of the KSPP project...
516     l += [OR(CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', '1'),
517              AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY', 'y'),
518                  CmdlineCheck('self_protection', 'kspp', 'hardened_usercopy', 'is not set')))]
519     l += [OR(CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', '0'),
520              AND(KconfigCheck('self_protection', 'kspp', 'HARDENED_USERCOPY_FALLBACK', 'is not set'),
521                  CmdlineCheck('self_protection', 'kspp', 'slab_common.usercopy_fallback', 'is not set')))]
522     # ... the end
523     if arch in ('X86_64', 'ARM64', 'X86_32'):
524         l += [OR(CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', '1'),
525                  AND(KconfigCheck('self_protection', 'kspp', 'RANDOMIZE_KSTACK_OFFSET_DEFAULT', 'y'),
526                      CmdlineCheck('self_protection', 'kspp', 'randomize_kstack_offset', 'is not set')))]
527     if arch in ('X86_64', 'X86_32'):
528         l += [AND(CmdlineCheck('self_protection', 'kspp', 'pti', 'on'),
529                   CmdlineCheck('self_protection', 'defconfig', 'nopti', 'is not set'))]
530
531     # 'self_protection', 'clipos'
532     l += [CmdlineCheck('self_protection', 'clipos', 'page_alloc.shuffle', '1')]
533     if arch in ('X86_64', 'X86_32'):
534         l += [CmdlineCheck('self_protection', 'clipos', 'iommu', 'force')]
535
536     # 'cut_attack_surface', 'defconfig'
537     if arch in ('X86_64', 'X86_32'):
538         l += [OR(CmdlineCheck('cut_attack_surface', 'defconfig', 'tsx', 'off'),
539                  AND(KconfigCheck('cut_attack_surface', 'defconfig', 'X86_INTEL_TSX_MODE_OFF', 'y'),
540                      CmdlineCheck('cut_attack_surface', 'defconfig', 'tsx', 'is not set')))]
541
542     # 'cut_attack_surface', 'kspp'
543     if arch == 'X86_64':
544         l += [OR(CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'none'),
545                  KconfigCheck('cut_attack_surface', 'clipos', 'X86_VSYSCALL_EMULATION', 'is not set'),
546                  AND(KconfigCheck('cut_attack_surface', 'kspp', 'LEGACY_VSYSCALL_NONE', 'y'),
547                      CmdlineCheck('cut_attack_surface', 'kspp', 'vsyscall', 'is not set')))]
548
549     # 'cut_attack_surface', 'grsec'
550     # The cmdline checks compatible with the kconfig options disabled by grsecurity...
551     l += [OR(CmdlineCheck('cut_attack_surface', 'grsec', 'debugfs', 'off'),
552              KconfigCheck('cut_attack_surface', 'grsec', 'DEBUG_FS', 'is not set'))] # ... the end
553
554     # 'cut_attack_surface', 'my'
555     l += [CmdlineCheck('cut_attack_surface', 'my', 'sysrq_always_enabled', 'is not set')]
556
557     # 'harden_userspace'
558     l += [CmdlineCheck('harden_userspace', 'defconfig', 'norandmaps', 'is not set')]
559
560
561 no_kstrtobool_options = [
562     'debugfs', # See debugfs_kernel() in fs/debugfs/inode.c
563     'mitigations', # See mitigations_parse_cmdline() in kernel/cpu.c
564     'pti', # See pti_check_boottime_disable() in arch/x86/mm/pti.c
565     'spectre_v2', # See spectre_v2_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
566     'spectre_v2_user', # See spectre_v2_parse_user_cmdline() in arch/x86/kernel/cpu/bugs.c
567     'spec_store_bypass_disable', # See ssb_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
568     'l1tf', # See l1tf_cmdline() in arch/x86/kernel/cpu/bugs.c
569     'mds', # See mds_cmdline() in arch/x86/kernel/cpu/bugs.c
570     'tsx_async_abort', # See tsx_async_abort_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
571     'srbds', # See srbds_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
572     'mmio_stale_data', # See mmio_stale_data_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
573     'retbleed', # See retbleed_parse_cmdline() in arch/x86/kernel/cpu/bugs.c
574     'tsx' # See tsx_init() in arch/x86/kernel/cpu/tsx.c
575 ]
576
577
578 def normalize_cmdline_options(option, value):
579     # Don't normalize the cmdline option values if
580     # the Linux kernel doesn't use kstrtobool() for them
581     if option in no_kstrtobool_options:
582         return value
583
584     # Implement a limited part of the kstrtobool() logic
585     if value in ('1', 'on', 'On', 'ON', 'y', 'Y', 'yes', 'Yes', 'YES'):
586         return '1'
587     if value in ('0', 'off', 'Off', 'OFF', 'n', 'N', 'no', 'No', 'NO'):
588         return '0'
589
590     # Preserve unique values
591     return value