Add the GitHub link
[kconfig-hardened-check.git] / README.md
1 # kconfig-hardened-check
2
3 ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/a13xp0p0v/kconfig-hardened-check?label=release)
4 ![functional test](https://github.com/a13xp0p0v/kconfig-hardened-check/workflows/functional%20test/badge.svg)
5 [![Coverage Status](https://codecov.io/gh/a13xp0p0v/kconfig-hardened-check/graph/badge.svg)](https://codecov.io/gh/a13xp0p0v/kconfig-hardened-check)
6
7 ## Motivation
8
9 There are plenty of security hardening options for the Linux kernel. A lot of them are
10 not enabled by the major distros. We have to enable these options ourselves to
11 make our systems more secure.
12
13 But nobody likes checking configs manually. So let the computers do their job!
14
15 __kconfig-hardened-check__ helps me to check the Linux kernel options
16 against my security hardening preferences, which are based on the
17
18   - [KSPP recommended settings][1]
19   - [CLIP OS kernel configuration][2]
20   - Last public [grsecurity][3] patch (options which they disable)
21   - [SECURITY_LOCKDOWN_LSM][5] patchset
22   - [Direct feedback from the Linux kernel maintainers][23]
23
24 This tool supports checking __Kconfig__ options and __kernel cmdline__ parameters.
25
26 I also created the [__Linux Kernel Defence Map__][4], which is a graphical representation of the
27 relationships between security hardening features and the corresponding vulnerability classes
28 or exploitation techniques.
29
30 __Attention!__ Changing Linux kernel security parameters may also affect system performance
31 and functionality of userspace software. So for choosing these parameters consider
32 the threat model of your Linux-based information system and perform thorough testing
33 of its typical workload.
34
35 ## Repositories
36
37  - Main at GitHub <https://github.com/a13xp0p0v/kconfig-hardened-check>
38  - Mirror at Codeberg: <https://codeberg.org/a13xp0p0v/kconfig-hardened-check>
39  - Mirror at GitFlic: <https://gitflic.ru/project/a13xp0p0v/kconfig-hardened-check>
40
41 ## Supported microarchitectures
42
43   - X86_64
44   - X86_32
45   - ARM64
46   - ARM
47
48 TODO: RISC-V (issue [#56][22])
49
50 ## Installation
51
52 You can install the package:
53
54 ```
55 pip install git+https://github.com/a13xp0p0v/kconfig-hardened-check
56 ```
57
58 or simply run `./bin/kconfig-hardened-check` from the cloned repository.
59
60 Some Linux distributions also provide `kconfig-hardened-check` as a package.
61
62 ## Usage
63 ```
64 usage: kconfig-hardened-check [-h] [--version] [-p {X86_64,X86_32,ARM64,ARM}]
65                               [-c CONFIG]
66                               [-l CMDLINE]
67                               [-m {verbose,json,show_ok,show_fail}]
68
69 A tool for checking the security hardening options of the Linux kernel
70
71 optional arguments:
72   -h, --help            show this help message and exit
73   --version             show program's version number and exit
74   -p {X86_64,X86_32,ARM64,ARM}, --print {X86_64,X86_32,ARM64,ARM}
75                         print security hardening preferences for the selected architecture
76   -c CONFIG, --config CONFIG
77                         check the kernel kconfig file against these preferences
78   -l CMDLINE, --cmdline CMDLINE
79                         check the kernel cmdline file against these preferences
80   -m {verbose,json,show_ok,show_fail}, --mode {verbose,json,show_ok,show_fail}
81                         choose the report mode
82 ```
83
84 ## Output modes
85
86   -  no `-m` argument for the default output mode (see the example below)
87   - `-m verbose` for printing additional info:
88     - config options without a corresponding check
89     - internals of complex checks with AND/OR, like this:
90 ```
91 -------------------------------------------------------------------------------------------
92     <<< OR >>>                                                                             
93 CONFIG_STRICT_DEVMEM                         |      y      |defconfig | cut_attack_surface 
94 CONFIG_DEVMEM                                | is not set  |   kspp   | cut_attack_surface 
95 -------------------------------------------------------------------------------------------
96 ```
97   - `-m show_fail` for showing only the failed checks
98   - `-m show_ok` for showing only the successful checks
99   - `-m json` for printing the results in JSON format (for combining `kconfig-hardened-check` with other tools)
100
101 ## Example output for `Fedora 36` kernel configuration
102 ```
103 $ ./bin/kconfig-hardened-check -c /boot/config-6.0.18-200.fc36.x86_64 -l /proc/cmdline
104 [+] Kconfig file to check: /boot/config-6.0.18-200.fc36.x86_64
105 [+] Kernel cmdline file to check: /proc/cmdline
106 [+] Detected architecture: X86_64
107 [+] Detected kernel version: 6.0
108 [+] Detected compiler: GCC 120201
109 =========================================================================================================================
110               option name               | type  |desired val | decision |      reason      | check result
111 =========================================================================================================================
112 CONFIG_BUG                              |kconfig|     y      |defconfig | self_protection  | OK
113 CONFIG_SLUB_DEBUG                       |kconfig|     y      |defconfig | self_protection  | OK
114 CONFIG_THREAD_INFO_IN_TASK              |kconfig|     y      |defconfig | self_protection  | OK
115 CONFIG_GCC_PLUGINS                      |kconfig|     y      |defconfig | self_protection  | OK
116 CONFIG_IOMMU_SUPPORT                    |kconfig|     y      |defconfig | self_protection  | OK
117 CONFIG_STACKPROTECTOR                   |kconfig|     y      |defconfig | self_protection  | OK
118 CONFIG_STACKPROTECTOR_STRONG            |kconfig|     y      |defconfig | self_protection  | FAIL: "is not set"
119 CONFIG_STRICT_KERNEL_RWX                |kconfig|     y      |defconfig | self_protection  | OK
120 CONFIG_STRICT_MODULE_RWX                |kconfig|     y      |defconfig | self_protection  | OK
121 CONFIG_REFCOUNT_FULL                    |kconfig|     y      |defconfig | self_protection  | OK: version >= 5.5
122 CONFIG_RANDOMIZE_BASE                   |kconfig|     y      |defconfig | self_protection  | OK
123 CONFIG_VMAP_STACK                       |kconfig|     y      |defconfig | self_protection  | OK
124 CONFIG_DEBUG_WX                         |kconfig|     y      |defconfig | self_protection  | OK
125 CONFIG_WERROR                           |kconfig|     y      |defconfig | self_protection  | FAIL: "is not set"
126 CONFIG_X86_MCE                          |kconfig|     y      |defconfig | self_protection  | OK
127 CONFIG_X86_MCE_INTEL                    |kconfig|     y      |defconfig | self_protection  | OK
128 CONFIG_X86_MCE_AMD                      |kconfig|     y      |defconfig | self_protection  | OK
129 CONFIG_MICROCODE                        |kconfig|     y      |defconfig | self_protection  | OK
130 CONFIG_RETPOLINE                        |kconfig|     y      |defconfig | self_protection  | OK
131 CONFIG_SYN_COOKIES                      |kconfig|     y      |defconfig | self_protection  | OK
132 CONFIG_X86_SMAP                         |kconfig|     y      |defconfig | self_protection  | OK: version >= 5.19
133 CONFIG_X86_UMIP                         |kconfig|     y      |defconfig | self_protection  | OK
134 CONFIG_PAGE_TABLE_ISOLATION             |kconfig|     y      |defconfig | self_protection  | OK
135 CONFIG_RANDOMIZE_MEMORY                 |kconfig|     y      |defconfig | self_protection  | OK
136 CONFIG_INTEL_IOMMU                      |kconfig|     y      |defconfig | self_protection  | OK
137 CONFIG_AMD_IOMMU                        |kconfig|     y      |defconfig | self_protection  | OK
138 CONFIG_BUG_ON_DATA_CORRUPTION           |kconfig|     y      |   kspp   | self_protection  | OK
139 CONFIG_SCHED_STACK_END_CHECK            |kconfig|     y      |   kspp   | self_protection  | OK
140 CONFIG_SLAB_FREELIST_HARDENED           |kconfig|     y      |   kspp   | self_protection  | OK
141 CONFIG_SLAB_FREELIST_RANDOM             |kconfig|     y      |   kspp   | self_protection  | OK
142 CONFIG_SHUFFLE_PAGE_ALLOCATOR           |kconfig|     y      |   kspp   | self_protection  | OK
143 CONFIG_FORTIFY_SOURCE                   |kconfig|     y      |   kspp   | self_protection  | OK
144 CONFIG_DEBUG_LIST                       |kconfig|     y      |   kspp   | self_protection  | OK
145 CONFIG_DEBUG_VIRTUAL                    |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
146 CONFIG_DEBUG_SG                         |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
147 CONFIG_DEBUG_CREDENTIALS                |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
148 CONFIG_DEBUG_NOTIFIERS                  |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
149 CONFIG_INIT_ON_ALLOC_DEFAULT_ON         |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
150 CONFIG_KFENCE                           |kconfig|     y      |   kspp   | self_protection  | OK
151 CONFIG_ZERO_CALL_USED_REGS              |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
152 CONFIG_HW_RANDOM_TPM                    |kconfig|     y      |   kspp   | self_protection  | OK
153 CONFIG_STATIC_USERMODEHELPER            |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
154 CONFIG_RANDSTRUCT_FULL                  |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
155 CONFIG_RANDSTRUCT_PERFORMANCE           |kconfig| is not set |   kspp   | self_protection  | FAIL: CONFIG_RANDSTRUCT_FULL is not "y"
156 CONFIG_HARDENED_USERCOPY                |kconfig|     y      |   kspp   | self_protection  | OK
157 CONFIG_HARDENED_USERCOPY_FALLBACK       |kconfig| is not set |   kspp   | self_protection  | OK: is not found
158 CONFIG_HARDENED_USERCOPY_PAGESPAN       |kconfig| is not set |   kspp   | self_protection  | OK: is not found
159 CONFIG_GCC_PLUGIN_LATENT_ENTROPY        |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
160 CONFIG_MODULE_SIG                       |kconfig|     y      |   kspp   | self_protection  | OK
161 CONFIG_MODULE_SIG_ALL                   |kconfig|     y      |   kspp   | self_protection  | OK
162 CONFIG_MODULE_SIG_SHA512                |kconfig|     y      |   kspp   | self_protection  | OK
163 CONFIG_MODULE_SIG_FORCE                 |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
164 CONFIG_INIT_STACK_ALL_ZERO              |kconfig|     y      |   kspp   | self_protection  | OK
165 CONFIG_INIT_ON_FREE_DEFAULT_ON          |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
166 CONFIG_EFI_DISABLE_PCI_DMA              |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
167 CONFIG_RESET_ATTACK_MITIGATION          |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
168 CONFIG_UBSAN_BOUNDS                     |kconfig|     y      |   kspp   | self_protection  | FAIL: is not found
169 CONFIG_UBSAN_LOCAL_BOUNDS               |kconfig|     y      |   kspp   | self_protection  | FAIL: is not found
170 CONFIG_UBSAN_TRAP                       |kconfig|     y      |   kspp   | self_protection  | FAIL: CONFIG_UBSAN_BOUNDS is not "y"
171 CONFIG_UBSAN_SANITIZE_ALL               |kconfig|     y      |   kspp   | self_protection  | FAIL: CONFIG_UBSAN_BOUNDS is not "y"
172 CONFIG_GCC_PLUGIN_STACKLEAK             |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
173 CONFIG_STACKLEAK_METRICS                |kconfig| is not set |   kspp   | self_protection  | FAIL: CONFIG_GCC_PLUGIN_STACKLEAK is not "y"
174 CONFIG_STACKLEAK_RUNTIME_DISABLE        |kconfig| is not set |   kspp   | self_protection  | FAIL: CONFIG_GCC_PLUGIN_STACKLEAK is not "y"
175 CONFIG_RANDOMIZE_KSTACK_OFFSET_DEFAULT  |kconfig|     y      |   kspp   | self_protection  | OK
176 CONFIG_CFI_CLANG                        |kconfig|     y      |   kspp   | self_protection  | FAIL: is not found
177 CONFIG_CFI_PERMISSIVE                   |kconfig| is not set |   kspp   | self_protection  | FAIL: CONFIG_CFI_CLANG is not "y"
178 CONFIG_SCHED_CORE                       |kconfig|     y      |   kspp   | self_protection  | OK
179 CONFIG_DEFAULT_MMAP_MIN_ADDR            |kconfig|   65536    |   kspp   | self_protection  | OK
180 CONFIG_IOMMU_DEFAULT_DMA_STRICT         |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
181 CONFIG_IOMMU_DEFAULT_PASSTHROUGH        |kconfig| is not set |   kspp   | self_protection  | OK
182 CONFIG_INTEL_IOMMU_DEFAULT_ON           |kconfig|     y      |   kspp   | self_protection  | FAIL: "is not set"
183 CONFIG_SLS                              |kconfig|     y      |   kspp   | self_protection  | OK
184 CONFIG_INTEL_IOMMU_SVM                  |kconfig|     y      |   kspp   | self_protection  | OK
185 CONFIG_AMD_IOMMU_V2                     |kconfig|     y      |   kspp   | self_protection  | FAIL: "m"
186 CONFIG_SLAB_MERGE_DEFAULT               |kconfig| is not set |  clipos  | self_protection  | OK
187 CONFIG_SECURITY                         |kconfig|     y      |defconfig | security_policy  | OK
188 CONFIG_SECURITY_YAMA                    |kconfig|     y      |   kspp   | security_policy  | OK
189 CONFIG_SECURITY_LANDLOCK                |kconfig|     y      |   kspp   | security_policy  | OK
190 CONFIG_SECURITY_SELINUX_DISABLE         |kconfig| is not set |   kspp   | security_policy  | OK
191 CONFIG_SECURITY_SELINUX_BOOTPARAM       |kconfig| is not set |   kspp   | security_policy  | FAIL: "y"
192 CONFIG_SECURITY_SELINUX_DEVELOP         |kconfig| is not set |   kspp   | security_policy  | FAIL: "y"
193 CONFIG_SECURITY_LOCKDOWN_LSM            |kconfig|     y      |   kspp   | security_policy  | OK
194 CONFIG_SECURITY_LOCKDOWN_LSM_EARLY      |kconfig|     y      |   kspp   | security_policy  | OK
195 CONFIG_LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY|kconfig|     y      |   kspp   | security_policy  | FAIL: "is not set"
196 CONFIG_SECURITY_WRITABLE_HOOKS          |kconfig| is not set |   kspp   | security_policy  | OK: is not found
197 CONFIG_SECCOMP                          |kconfig|     y      |defconfig |cut_attack_surface| OK
198 CONFIG_SECCOMP_FILTER                   |kconfig|     y      |defconfig |cut_attack_surface| OK
199 CONFIG_BPF_UNPRIV_DEFAULT_OFF           |kconfig|     y      |defconfig |cut_attack_surface| OK
200 CONFIG_STRICT_DEVMEM                    |kconfig|     y      |defconfig |cut_attack_surface| OK
201 CONFIG_X86_INTEL_TSX_MODE_OFF           |kconfig|     y      |defconfig |cut_attack_surface| OK
202 CONFIG_SECURITY_DMESG_RESTRICT          |kconfig|     y      |   kspp   |cut_attack_surface| FAIL: "is not set"
203 CONFIG_ACPI_CUSTOM_METHOD               |kconfig| is not set |   kspp   |cut_attack_surface| OK
204 CONFIG_COMPAT_BRK                       |kconfig| is not set |   kspp   |cut_attack_surface| OK
205 CONFIG_DEVKMEM                          |kconfig| is not set |   kspp   |cut_attack_surface| OK: is not found
206 CONFIG_COMPAT_VDSO                      |kconfig| is not set |   kspp   |cut_attack_surface| OK
207 CONFIG_BINFMT_MISC                      |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "m"
208 CONFIG_INET_DIAG                        |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
209 CONFIG_KEXEC                            |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
210 CONFIG_PROC_KCORE                       |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
211 CONFIG_LEGACY_PTYS                      |kconfig| is not set |   kspp   |cut_attack_surface| OK
212 CONFIG_HIBERNATION                      |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
213 CONFIG_COMPAT                           |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
214 CONFIG_IA32_EMULATION                   |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
215 CONFIG_X86_X32                          |kconfig| is not set |   kspp   |cut_attack_surface| OK: is not found
216 CONFIG_X86_X32_ABI                      |kconfig| is not set |   kspp   |cut_attack_surface| OK
217 CONFIG_MODIFY_LDT_SYSCALL               |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
218 CONFIG_OABI_COMPAT                      |kconfig| is not set |   kspp   |cut_attack_surface| OK: is not found
219 CONFIG_X86_MSR                          |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
220 CONFIG_MODULES                          |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
221 CONFIG_DEVMEM                           |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
222 CONFIG_IO_STRICT_DEVMEM                 |kconfig|     y      |   kspp   |cut_attack_surface| OK
223 CONFIG_LDISC_AUTOLOAD                   |kconfig| is not set |   kspp   |cut_attack_surface| FAIL: "y"
224 CONFIG_LEGACY_VSYSCALL_NONE             |kconfig|     y      |   kspp   |cut_attack_surface| FAIL: "is not set"
225 CONFIG_ZSMALLOC_STAT                    |kconfig| is not set |  grsec   |cut_attack_surface| OK
226 CONFIG_PAGE_OWNER                       |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
227 CONFIG_DEBUG_KMEMLEAK                   |kconfig| is not set |  grsec   |cut_attack_surface| OK
228 CONFIG_BINFMT_AOUT                      |kconfig| is not set |  grsec   |cut_attack_surface| OK: is not found
229 CONFIG_KPROBE_EVENTS                    |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
230 CONFIG_UPROBE_EVENTS                    |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
231 CONFIG_GENERIC_TRACER                   |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
232 CONFIG_FUNCTION_TRACER                  |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
233 CONFIG_STACK_TRACER                     |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
234 CONFIG_HIST_TRIGGERS                    |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
235 CONFIG_BLK_DEV_IO_TRACE                 |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
236 CONFIG_PROC_VMCORE                      |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
237 CONFIG_PROC_PAGE_MONITOR                |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
238 CONFIG_USELIB                           |kconfig| is not set |  grsec   |cut_attack_surface| OK
239 CONFIG_CHECKPOINT_RESTORE               |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
240 CONFIG_USERFAULTFD                      |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
241 CONFIG_HWPOISON_INJECT                  |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "m"
242 CONFIG_MEM_SOFT_DIRTY                   |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
243 CONFIG_DEVPORT                          |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
244 CONFIG_DEBUG_FS                         |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
245 CONFIG_NOTIFIER_ERROR_INJECTION         |kconfig| is not set |  grsec   |cut_attack_surface| OK
246 CONFIG_FAIL_FUTEX                       |kconfig| is not set |  grsec   |cut_attack_surface| OK: is not found
247 CONFIG_PUNIT_ATOM_DEBUG                 |kconfig| is not set |  grsec   |cut_attack_surface| OK
248 CONFIG_ACPI_CONFIGFS                    |kconfig| is not set |  grsec   |cut_attack_surface| OK
249 CONFIG_EDAC_DEBUG                       |kconfig| is not set |  grsec   |cut_attack_surface| OK
250 CONFIG_DRM_I915_DEBUG                   |kconfig| is not set |  grsec   |cut_attack_surface| OK: is not found
251 CONFIG_BCACHE_CLOSURES_DEBUG            |kconfig| is not set |  grsec   |cut_attack_surface| OK
252 CONFIG_DVB_C8SECTPFE                    |kconfig| is not set |  grsec   |cut_attack_surface| OK: is not found
253 CONFIG_MTD_SLRAM                        |kconfig| is not set |  grsec   |cut_attack_surface| OK
254 CONFIG_MTD_PHRAM                        |kconfig| is not set |  grsec   |cut_attack_surface| OK
255 CONFIG_IO_URING                         |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
256 CONFIG_KCMP                             |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
257 CONFIG_RSEQ                             |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
258 CONFIG_LATENCYTOP                       |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
259 CONFIG_KCOV                             |kconfig| is not set |  grsec   |cut_attack_surface| OK
260 CONFIG_PROVIDE_OHCI1394_DMA_INIT        |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
261 CONFIG_SUNRPC_DEBUG                     |kconfig| is not set |  grsec   |cut_attack_surface| FAIL: "y"
262 CONFIG_PTDUMP_DEBUGFS                   |kconfig| is not set |  grsec   |cut_attack_surface| OK
263 CONFIG_DRM_LEGACY                       |kconfig| is not set |maintainer|cut_attack_surface| OK
264 CONFIG_FB                               |kconfig| is not set |maintainer|cut_attack_surface| FAIL: "y"
265 CONFIG_VT                               |kconfig| is not set |maintainer|cut_attack_surface| FAIL: "y"
266 CONFIG_BLK_DEV_FD                       |kconfig| is not set |maintainer|cut_attack_surface| FAIL: "m"
267 CONFIG_BLK_DEV_FD_RAWCMD                |kconfig| is not set |maintainer|cut_attack_surface| OK
268 CONFIG_STAGING                          |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
269 CONFIG_KSM                              |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
270 CONFIG_KALLSYMS                         |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
271 CONFIG_X86_VSYSCALL_EMULATION           |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
272 CONFIG_MAGIC_SYSRQ                      |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
273 CONFIG_KEXEC_FILE                       |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
274 CONFIG_USER_NS                          |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
275 CONFIG_X86_CPUID                        |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
276 CONFIG_X86_IOPL_IOPERM                  |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
277 CONFIG_ACPI_TABLE_UPGRADE               |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
278 CONFIG_EFI_CUSTOM_SSDT_OVERLAYS         |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
279 CONFIG_COREDUMP                         |kconfig| is not set |  clipos  |cut_attack_surface| FAIL: "y"
280 CONFIG_EFI_TEST                         |kconfig| is not set | lockdown |cut_attack_surface| FAIL: "m"
281 CONFIG_MMIOTRACE_TEST                   |kconfig| is not set | lockdown |cut_attack_surface| OK
282 CONFIG_KPROBES                          |kconfig| is not set | lockdown |cut_attack_surface| FAIL: "y"
283 CONFIG_BPF_SYSCALL                      |kconfig| is not set | lockdown |cut_attack_surface| FAIL: "y"
284 CONFIG_MMIOTRACE                        |kconfig| is not set |    my    |cut_attack_surface| FAIL: "y"
285 CONFIG_LIVEPATCH                        |kconfig| is not set |    my    |cut_attack_surface| FAIL: "y"
286 CONFIG_IP_DCCP                          |kconfig| is not set |    my    |cut_attack_surface| OK
287 CONFIG_IP_SCTP                          |kconfig| is not set |    my    |cut_attack_surface| FAIL: "m"
288 CONFIG_FTRACE                           |kconfig| is not set |    my    |cut_attack_surface| FAIL: "y"
289 CONFIG_VIDEO_VIVID                      |kconfig| is not set |    my    |cut_attack_surface| OK: is not found
290 CONFIG_INPUT_EVBUG                      |kconfig| is not set |    my    |cut_attack_surface| OK
291 CONFIG_KGDB                             |kconfig| is not set |    my    |cut_attack_surface| FAIL: "y"
292 CONFIG_TRIM_UNUSED_KSYMS                |kconfig|     y      |    my    |cut_attack_surface| FAIL: is not found
293 CONFIG_INTEGRITY                        |kconfig|     y      |defconfig | harden_userspace | OK
294 CONFIG_ARCH_MMAP_RND_BITS               |kconfig|     32     |  clipos  | harden_userspace | FAIL: "28"
295 nosmep                                  |cmdline| is not set |defconfig | self_protection  | OK: is not found
296 nosmap                                  |cmdline| is not set |defconfig | self_protection  | OK: is not found
297 nokaslr                                 |cmdline| is not set |defconfig | self_protection  | OK: is not found
298 nopti                                   |cmdline| is not set |defconfig | self_protection  | OK: is not found
299 nospectre_v1                            |cmdline| is not set |defconfig | self_protection  | OK: is not found
300 nospectre_v2                            |cmdline| is not set |defconfig | self_protection  | OK: is not found
301 nospectre_bhb                           |cmdline| is not set |defconfig | self_protection  | OK: is not found
302 nospec_store_bypass_disable             |cmdline| is not set |defconfig | self_protection  | OK: is not found
303 arm64.nobti                             |cmdline| is not set |defconfig | self_protection  | OK: is not found
304 arm64.nopauth                           |cmdline| is not set |defconfig | self_protection  | OK: is not found
305 arm64.nomte                             |cmdline| is not set |defconfig | self_protection  | OK: is not found
306 mitigations                             |cmdline| is not off |defconfig | self_protection  | OK: mitigations is not found
307 spectre_v2                              |cmdline| is not off |defconfig | self_protection  | OK: spectre_v2 is not found
308 spectre_v2_user                         |cmdline| is not off |defconfig | self_protection  | OK: spectre_v2_user is not found
309 spec_store_bypass_disable               |cmdline| is not off |defconfig | self_protection  | OK: spec_store_bypass_disable is not found
310 l1tf                                    |cmdline| is not off |defconfig | self_protection  | OK: l1tf is not found
311 mds                                     |cmdline| is not off |defconfig | self_protection  | OK: mds is not found
312 tsx_async_abort                         |cmdline| is not off |defconfig | self_protection  | OK: tsx_async_abort is not found
313 srbds                                   |cmdline| is not off |defconfig | self_protection  | OK: srbds is not found
314 mmio_stale_data                         |cmdline| is not off |defconfig | self_protection  | OK: mmio_stale_data is not found
315 retbleed                                |cmdline| is not off |defconfig | self_protection  | OK: retbleed is not found
316 kpti                                    |cmdline| is not off |defconfig | self_protection  | OK: kpti is not found
317 kvm.nx_huge_pages                       |cmdline| is not off |defconfig | self_protection  | OK: kvm.nx_huge_pages is not found
318 rodata                                  |cmdline|     1      |defconfig | self_protection  | OK: rodata is not found
319 nosmt                                   |cmdline| is present |   kspp   | self_protection  | FAIL: is not present
320 init_on_alloc                           |cmdline|     1      |   kspp   | self_protection  | FAIL: is not found
321 init_on_free                            |cmdline|     1      |   kspp   | self_protection  | FAIL: is not found
322 slab_nomerge                            |cmdline| is present |   kspp   | self_protection  | OK: CONFIG_SLAB_MERGE_DEFAULT is "is not set"
323 iommu.strict                            |cmdline|     1      |   kspp   | self_protection  | FAIL: is not found
324 iommu.passthrough                       |cmdline|     0      |   kspp   | self_protection  | OK: CONFIG_IOMMU_DEFAULT_PASSTHROUGH is "is not set"
325 hardened_usercopy                       |cmdline|     1      |   kspp   | self_protection  | OK: CONFIG_HARDENED_USERCOPY is "y"
326 slab_common.usercopy_fallback           |cmdline|     0      |   kspp   | self_protection  | OK: CONFIG_HARDENED_USERCOPY_FALLBACK is not found
327 randomize_kstack_offset                 |cmdline|     1      |   kspp   | self_protection  | OK: CONFIG_RANDOMIZE_KSTACK_OFFSET_DEFAULT is "y"
328 pti                                     |cmdline|     on     |   kspp   | self_protection  | FAIL: is not found
329 page_alloc.shuffle                      |cmdline|     1      |  clipos  | self_protection  | FAIL: is not found
330 iommu                                   |cmdline|   force    |  clipos  | self_protection  | FAIL: is not found
331 tsx                                     |cmdline|    off     |defconfig |cut_attack_surface| OK: CONFIG_X86_INTEL_TSX_MODE_OFF is "y"
332 vsyscall                                |cmdline|    none    |   kspp   |cut_attack_surface| FAIL: is not found
333 debugfs                                 |cmdline|    off     |  grsec   |cut_attack_surface| FAIL: is not found
334 sysrq_always_enabled                    |cmdline| is not set |    my    |cut_attack_surface| OK: is not found
335
336 [+] Config check is finished: 'OK' - 122 / 'FAIL' - 101
337 ```
338
339 ## kconfig-hardened-check versioning
340
341 I usually update the kernel security hardening recommendations every few kernel releases.
342
343 So the version of `kconfig-hardened-check` is associated with the corresponding version of the kernel.
344
345 The version format is: __[major_number].[kernel_version].[kernel_patchlevel]__
346
347
348 ## Questions and answers
349
350 __Q:__ How all these kernel parameters influence the Linux kernel security?
351
352 __A:__ To answer this question, you can use the `kconfig-hardened-check` [sources of recommendations][24]
353 and the [Linux Kernel Defence Map][4] with its references.
354
355 <br />
356
357 __Q:__ How disabling `CONFIG_USER_NS` cuts the attack surface? It's needed for containers!
358
359 __A:__ Yes, the `CONFIG_USER_NS` option provides some isolation between the userspace programs,
360 but the tool recommends disabling it to cut the attack surface __of the kernel__.
361
362 The rationale:
363
364   - An LWN article about the corresponding LKML discussion: https://lwn.net/Articles/673597/
365
366   - A twitter thread about `CONFIG_USER_NS` and security: https://twitter.com/robertswiecki/status/1095447678949953541
367
368   - A good overview of the trade-off between having user namespaces enabled, disabled and available only for root: https://github.com/NixOS/nixpkgs/pull/84522#issuecomment-614640601
369
370 <br />
371
372 __Q:__ KSPP and CLIP OS recommend `CONFIG_PANIC_ON_OOPS=y`. Why doesn't this tool do the same?
373
374 __A:__ I personally don't support this recommendation because:
375   - It decreases system safety (kernel oops is still not a rare situation)
376   - It allows easier denial-of-service attacks for the whole system
377
378 I think having `CONFIG_BUG` is enough here.
379 If a kernel oops happens in the process context, the offending/attacking process is killed.
380 In other cases, the kernel panics, which is similar to `CONFIG_PANIC_ON_OOPS=y`.
381
382 <br />
383
384 __Q:__ Why enabling `CONFIG_STATIC_USERMODEHELPER` breaks various things in my GNU/Linux system?
385 Do I really need that feature?
386
387 __A:__ Linux kernel usermode helpers can be used for privilege escalation in kernel exploits
388 ([example 1][9], [example 2][10]). `CONFIG_STATIC_USERMODEHELPER` prevents that method. But it
389 requires the corresponding support in the userspace: see the [example implementation][11] by
390 Tycho Andersen [@tych0][12].
391
392 <br />
393
394 __Q:__ What about performance impact of these security hardening options?
395
396 __A:__ Ike Devolder [@BlackIkeEagle][7] made some performance tests and described the results in [this article][8].
397 A more detailed evaluation is in the TODO list (the issue [#66][21]).
398
399 <br />
400
401 __Q:__ Can I easily check which kernel versions support some Kconfig option?
402
403 __A:__ Yes. See the [LKDDb][18] project (Linux Kernel Driver Database) by Giacomo Catenazzi [@cateee][19].
404 You can use it for the `mainline` or `stable` tree from [kernel.org][20] or for your custom kernel sources.
405
406 <br />
407
408 __Q:__ Does my kernel have all those mitigations of Transient Execution Vulnerabilities in my hardware?
409
410 __A:__ Checking the kernel config is not enough to answer this question.
411 I highly recommend using [spectre-meltdown-checker][13] tool maintained by Stéphane Lesimple [@speed47][14].
412
413 <br />
414
415 __Q:__ Why the `CONFIG_GCC_PLUGINS` option is automatically disabled during the kernel compilation?
416
417 __A:__ It means that your gcc doesn't support plugins. For example, if you have `gcc-7` on Ubuntu,
418 try to install `gcc-7-plugin-dev` package, it should help.
419
420
421 [1]: http://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project/Recommended_Settings
422 [2]: https://docs.clip-os.org/clipos/kernel.html#configuration
423 [3]: https://grsecurity.net/
424 [4]: https://github.com/a13xp0p0v/linux-kernel-defence-map
425 [5]: https://lwn.net/Articles/791863/
426 [6]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/38
427 [7]: https://github.com/BlackIkeEagle
428 [8]: https://blog.herecura.eu/blog/2020-05-30-kconfig-hardening-tests/
429 [9]: https://googleprojectzero.blogspot.com/2018/09/a-cache-invalidation-bug-in-linux.html
430 [10]: https://a13xp0p0v.github.io/2020/02/15/CVE-2019-18683.html
431 [11]: https://github.com/tych0/huldufolk
432 [12]: https://github.com/tych0
433 [13]: https://github.com/speed47/spectre-meltdown-checker
434 [14]: https://github.com/speed47
435 [15]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/53
436 [16]: https://github.com/a13xp0p0v/kconfig-hardened-check/pull/54
437 [17]: https://github.com/a13xp0p0v/kconfig-hardened-check/pull/62
438 [18]: https://cateee.net/lkddb/web-lkddb/
439 [19]: https://github.com/cateee/lkddb
440 [20]: https://kernel.org/
441 [21]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/66
442 [22]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/56
443 [23]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues?q=label%3Akernel_maintainer_feedback
444 [24]: https://github.com/a13xp0p0v/kconfig-hardened-check#motivation