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