1 # Kconfig hardened check
5 There are plenty of Linux kernel hardening config options. A lot of them are
6 not enabled by the major distros. We have to enable these options ourselves to
7 make our systems more secure.
9 But nobody likes checking configs manually. So let the computers do their job!
11 __kconfig-hardened-check.py__ helps me to check the Linux kernel Kconfig option list
12 against my hardening preferences, which are based on the
14 - [KSPP recommended settings][1],
15 - [CLIP OS kernel configuration][2],
16 - last public [grsecurity][3] patch (options which they disable).
18 Please don't cry if my Python code looks like C. I'm just a kernel developer.
20 ## Supported microarchitectures
27 ## Script output examples
31 usage: kconfig-hardened-check.py [-h] [-p {X86_64,X86_32,ARM64,ARM}]
32 [-c CONFIG] [--debug] [--json]
34 Checks the hardening options in the Linux kernel config
37 -h, --help show this help message and exit
38 -p {X86_64,X86_32,ARM64,ARM}, --print {X86_64,X86_32,ARM64,ARM}
39 print hardening preferences for selected architecture
40 -c CONFIG, --config CONFIG
41 check the config_file against these preferences
42 --debug enable internal debug mode
43 --json print results in JSON format
47 ### Script output for `Ubuntu 18.04 (Bionic Beaver)` kernel config
49 #./kconfig-hardened-check.py -c config_files/distros/ubuntu-bionic-generic.config
50 [+] Trying to detect architecture in "config_files/distros/ubuntu-bionic-generic.config"...
51 [+] Detected architecture: X86_64
52 [+] Checking "config_files/distros/ubuntu-bionic-generic.config" against hardening preferences...
53 option name | desired val | decision | reason || check result
54 ====================================================================================================================
55 CONFIG_BUG | y |defconfig | self_protection || OK
56 CONFIG_STRICT_KERNEL_RWX | y |defconfig | self_protection || OK
57 CONFIG_STACKPROTECTOR_STRONG | y |defconfig | self_protection ||OK: CONFIG_CC_STACKPROTECTOR_STRONG "y"
58 CONFIG_SLUB_DEBUG | y |defconfig | self_protection || OK
59 CONFIG_STRICT_MODULE_RWX | y |defconfig | self_protection || OK
60 CONFIG_PAGE_TABLE_ISOLATION | y |defconfig | self_protection || OK
61 CONFIG_RANDOMIZE_MEMORY | y |defconfig | self_protection || OK
62 CONFIG_RANDOMIZE_BASE | y |defconfig | self_protection || OK
63 CONFIG_RETPOLINE | y |defconfig | self_protection || OK
64 CONFIG_X86_SMAP | y |defconfig | self_protection || OK
65 CONFIG_X86_INTEL_UMIP | y |defconfig | self_protection || OK
66 CONFIG_SYN_COOKIES | y |defconfig | self_protection || OK
67 CONFIG_VMAP_STACK | y |defconfig | self_protection || OK
68 CONFIG_THREAD_INFO_IN_TASK | y |defconfig | self_protection || OK
69 CONFIG_BUG_ON_DATA_CORRUPTION | y | kspp | self_protection || FAIL: "is not set"
70 CONFIG_DEBUG_WX | y | kspp | self_protection || OK
71 CONFIG_SCHED_STACK_END_CHECK | y | kspp | self_protection || OK
72 CONFIG_SLAB_FREELIST_HARDENED | y | kspp | self_protection || OK
73 CONFIG_SLAB_FREELIST_RANDOM | y | kspp | self_protection || OK
74 CONFIG_SHUFFLE_PAGE_ALLOCATOR | y | kspp | self_protection || FAIL: not found
75 CONFIG_FORTIFY_SOURCE | y | kspp | self_protection || OK
76 CONFIG_GCC_PLUGINS | y | kspp | self_protection || FAIL: "is not set"
77 CONFIG_GCC_PLUGIN_RANDSTRUCT | y | kspp | self_protection || FAIL: not found
78 CONFIG_GCC_PLUGIN_LATENT_ENTROPY | y | kspp | self_protection || FAIL: not found
79 CONFIG_DEBUG_LIST | y | kspp | self_protection || FAIL: "is not set"
80 CONFIG_DEBUG_SG | y | kspp | self_protection || FAIL: "is not set"
81 CONFIG_DEBUG_CREDENTIALS | y | kspp | self_protection || FAIL: "is not set"
82 CONFIG_DEBUG_NOTIFIERS | y | kspp | self_protection || FAIL: "is not set"
83 CONFIG_PAGE_POISONING | y | kspp | self_protection || FAIL: "is not set"
84 CONFIG_HARDENED_USERCOPY | y | kspp | self_protection || OK
85 CONFIG_HARDENED_USERCOPY_FALLBACK | is not set | kspp | self_protection || OK: not found
86 CONFIG_MODULE_SIG | y | kspp | self_protection || OK
87 CONFIG_MODULE_SIG_ALL | y | kspp | self_protection || OK
88 CONFIG_MODULE_SIG_SHA512 | y | kspp | self_protection || OK
89 CONFIG_MODULE_SIG_FORCE | y | kspp | self_protection || FAIL: "is not set"
90 CONFIG_DEFAULT_MMAP_MIN_ADDR | 65536 | kspp | self_protection || OK
91 CONFIG_REFCOUNT_FULL | y | kspp | self_protection || FAIL: "is not set"
92 CONFIG_LOCK_DOWN_KERNEL | y | clipos | self_protection || OK
93 CONFIG_SECURITY_DMESG_RESTRICT | y | clipos | self_protection || FAIL: "is not set"
94 CONFIG_DEBUG_VIRTUAL | y | clipos | self_protection || FAIL: "is not set"
95 CONFIG_STATIC_USERMODEHELPER | y | clipos | self_protection || FAIL: "is not set"
96 CONFIG_SLAB_MERGE_DEFAULT | is not set | clipos | self_protection || FAIL: "y"
97 CONFIG_GCC_PLUGIN_RANDSTRUCT_PERFORMANCE| is not set | clipos | self_protection ||FAIL: CONFIG_GCC_PLUGIN_RANDSTRUCT is needed
98 CONFIG_GCC_PLUGIN_STACKLEAK | y | clipos | self_protection || FAIL: not found
99 CONFIG_STACKLEAK_METRICS | is not set | clipos | self_protection ||FAIL: CONFIG_GCC_PLUGIN_STACKLEAK is needed
100 CONFIG_STACKLEAK_RUNTIME_DISABLE | is not set | clipos | self_protection ||FAIL: CONFIG_GCC_PLUGIN_STACKLEAK is needed
101 CONFIG_RANDOM_TRUST_CPU | is not set | clipos | self_protection || OK: not found
102 CONFIG_MICROCODE | y | clipos | self_protection || OK
103 CONFIG_IOMMU_SUPPORT | y | clipos | self_protection || OK
104 CONFIG_INTEL_IOMMU | y | clipos | self_protection || OK
105 CONFIG_INTEL_IOMMU_SVM | y | clipos | self_protection || OK
106 CONFIG_INTEL_IOMMU_DEFAULT_ON | y | clipos | self_protection || FAIL: "is not set"
107 CONFIG_INIT_STACK_ALL | y | my | self_protection || FAIL: not found
108 CONFIG_SLUB_DEBUG_ON | y | my | self_protection || FAIL: "is not set"
109 CONFIG_SECURITY_LOADPIN | y | my | self_protection || FAIL: "is not set"
110 CONFIG_RESET_ATTACK_MITIGATION | y | my | self_protection || OK
111 CONFIG_PAGE_POISONING_NO_SANITY | is not set | my | self_protection ||FAIL: CONFIG_PAGE_POISONING is needed
112 CONFIG_PAGE_POISONING_ZERO | is not set | my | self_protection ||FAIL: CONFIG_PAGE_POISONING is needed
113 CONFIG_AMD_IOMMU | y | my | self_protection || OK
114 CONFIG_AMD_IOMMU_V2 | y | my | self_protection || FAIL: "m"
115 CONFIG_SECURITY | y |defconfig | security_policy || OK
116 CONFIG_SECURITY_YAMA | y | kspp | security_policy || OK
117 CONFIG_SECCOMP | y |defconfig | cut_attack_surface || OK
118 CONFIG_SECCOMP_FILTER | y |defconfig | cut_attack_surface || OK
119 CONFIG_STRICT_DEVMEM | y |defconfig | cut_attack_surface || OK
120 CONFIG_MODULES | is not set | kspp | cut_attack_surface || FAIL: "y"
121 CONFIG_DEVMEM | is not set | kspp | cut_attack_surface || FAIL: "y"
122 CONFIG_IO_STRICT_DEVMEM | y | kspp | cut_attack_surface || FAIL: "is not set"
123 CONFIG_ACPI_CUSTOM_METHOD | is not set | kspp | cut_attack_surface || OK
124 CONFIG_COMPAT_BRK | is not set | kspp | cut_attack_surface || OK
125 CONFIG_DEVKMEM | is not set | kspp | cut_attack_surface || OK
126 CONFIG_COMPAT_VDSO | is not set | kspp | cut_attack_surface || OK
127 CONFIG_BINFMT_MISC | is not set | kspp | cut_attack_surface || FAIL: "m"
128 CONFIG_INET_DIAG | is not set | kspp | cut_attack_surface || FAIL: "m"
129 CONFIG_KEXEC | is not set | kspp | cut_attack_surface || FAIL: "y"
130 CONFIG_PROC_KCORE | is not set | kspp | cut_attack_surface || FAIL: "y"
131 CONFIG_LEGACY_PTYS | is not set | kspp | cut_attack_surface || FAIL: "y"
132 CONFIG_HIBERNATION | is not set | kspp | cut_attack_surface || FAIL: "y"
133 CONFIG_LEGACY_VSYSCALL_NONE | y | kspp | cut_attack_surface || FAIL: "is not set"
134 CONFIG_IA32_EMULATION | is not set | kspp | cut_attack_surface || FAIL: "y"
135 CONFIG_X86_X32 | is not set | kspp | cut_attack_surface || FAIL: "y"
136 CONFIG_MODIFY_LDT_SYSCALL | is not set | kspp | cut_attack_surface || FAIL: "y"
137 CONFIG_X86_PTDUMP | is not set |grsecurity| cut_attack_surface || OK
138 CONFIG_ZSMALLOC_STAT | is not set |grsecurity| cut_attack_surface || OK
139 CONFIG_PAGE_OWNER | is not set |grsecurity| cut_attack_surface || OK
140 CONFIG_DEBUG_KMEMLEAK | is not set |grsecurity| cut_attack_surface || OK
141 CONFIG_BINFMT_AOUT | is not set |grsecurity| cut_attack_surface || OK: not found
142 CONFIG_KPROBES | is not set |grsecurity| cut_attack_surface || FAIL: "y"
143 CONFIG_UPROBES | is not set |grsecurity| cut_attack_surface || FAIL: "y"
144 CONFIG_GENERIC_TRACER | is not set |grsecurity| cut_attack_surface || FAIL: "y"
145 CONFIG_PROC_VMCORE | is not set |grsecurity| cut_attack_surface || FAIL: "y"
146 CONFIG_PROC_PAGE_MONITOR | is not set |grsecurity| cut_attack_surface || FAIL: "y"
147 CONFIG_USELIB | is not set |grsecurity| cut_attack_surface || FAIL: "y"
148 CONFIG_CHECKPOINT_RESTORE | is not set |grsecurity| cut_attack_surface || FAIL: "y"
149 CONFIG_USERFAULTFD | is not set |grsecurity| cut_attack_surface || FAIL: "y"
150 CONFIG_HWPOISON_INJECT | is not set |grsecurity| cut_attack_surface || FAIL: "m"
151 CONFIG_MEM_SOFT_DIRTY | is not set |grsecurity| cut_attack_surface || FAIL: "y"
152 CONFIG_DEVPORT | is not set |grsecurity| cut_attack_surface || FAIL: "y"
153 CONFIG_DEBUG_FS | is not set |grsecurity| cut_attack_surface || FAIL: "y"
154 CONFIG_NOTIFIER_ERROR_INJECTION | is not set |grsecurity| cut_attack_surface || FAIL: "m"
155 CONFIG_ACPI_TABLE_UPGRADE | is not set | lockdown | cut_attack_surface || FAIL: "y"
156 CONFIG_ACPI_APEI_EINJ | is not set | lockdown | cut_attack_surface || FAIL: "m"
157 CONFIG_PROFILING | is not set | lockdown | cut_attack_surface || FAIL: "y"
158 CONFIG_BPF_SYSCALL | is not set | lockdown | cut_attack_surface || FAIL: "y"
159 CONFIG_MMIOTRACE_TEST | is not set | lockdown | cut_attack_surface || OK
160 CONFIG_KSM | is not set | clipos | cut_attack_surface || FAIL: "y"
161 CONFIG_IKCONFIG | is not set | clipos | cut_attack_surface || OK
162 CONFIG_KALLSYMS | is not set | clipos | cut_attack_surface || FAIL: "y"
163 CONFIG_X86_VSYSCALL_EMULATION | is not set | clipos | cut_attack_surface || FAIL: "y"
164 CONFIG_MAGIC_SYSRQ | is not set | clipos | cut_attack_surface || FAIL: "y"
165 CONFIG_KEXEC_FILE | is not set | clipos | cut_attack_surface || FAIL: "y"
166 CONFIG_USER_NS | is not set | clipos | cut_attack_surface || FAIL: "y"
167 CONFIG_LDISC_AUTOLOAD | is not set | clipos | cut_attack_surface || OK: not found
168 CONFIG_MMIOTRACE | is not set | my | cut_attack_surface || FAIL: "y"
169 CONFIG_LIVEPATCH | is not set | my | cut_attack_surface || FAIL: "y"
170 CONFIG_IP_DCCP | is not set | my | cut_attack_surface || FAIL: "m"
171 CONFIG_IP_SCTP | is not set | my | cut_attack_surface || FAIL: "m"
172 CONFIG_FTRACE | is not set | my | cut_attack_surface || FAIL: "y"
173 CONFIG_BPF_JIT | is not set | my | cut_attack_surface || FAIL: "y"
174 CONFIG_ARCH_MMAP_RND_BITS | 32 | clipos |userspace_protection|| FAIL: "28"
176 [+] config check is finished: 'OK' - 50 / 'FAIL' - 70
179 ## kconfig-hardened-check versioning
181 I usually update the kernel hardening recommendations after each Linux kernel release.
183 So the version of `kconfig-hardened-check` is associated with the corresponding version of the kernel.
185 The version format is: __[major_number].[kernel_version]__
187 The current version of `kconfig-hardened-check` is __0.5.2__, it's marked with the git tag.
190 ## Questions and answers
192 __Q:__ How disabling `CONFIG_USER_NS` cuts the attack surface? It's needed for containers!
194 __A:__ Yes, the `CONFIG_USER_NS` option provides some isolation between the userspace programs,
195 but the script recommends disabling it to cut the attack surface __of the kernel__.
199 - A nice LWN article about the corresponding LKML discussion: https://lwn.net/Articles/673597/
201 - A twitter thread about `CONFIG_USER_NS` and security: https://twitter.com/robertswiecki/status/1095447678949953541
205 __Q:__ Why `CONFIG_GCC_PLUGINS` is automatically disabled during the kernel compilation?
207 __A:__ It means that your gcc doesn't support plugins. For example, if you have `gcc-7` on Ubuntu,
208 try to install `gcc-7-plugin-dev` package, it should help.
211 [1]: http://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project/Recommended_Settings
212 [2]: https://docs.clip-os.org/clipos/kernel.html#configuration
213 [3]: https://grsecurity.net/
projects / kconfig-hardened-check.git / blob