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