README.md

   1 # kconfig-hardened-check
   2
   3 ![functional test](https://github.com/a13xp0p0v/kconfig-hardened-check/workflows/functional%20test/badge.svg)
   4 [![Coverage Status](https://codecov.io/gh/a13xp0p0v/kconfig-hardened-check/graph/badge.svg)](https://codecov.io/gh/a13xp0p0v/kconfig-hardened-check)
   5
   6 ## Motivation
   7
   8 There are plenty of Linux kernel hardening config options. A lot of them are
   9 not enabled by the major distros. We have to enable these options ourselves to
  10 make our systems more secure.
  11
  12 But nobody likes checking configs manually. So let the computers do their job!
  13
  14 __kconfig-hardened-check.py__ helps me to check the Linux kernel Kconfig option list
  15 against my hardening preferences, which are based on the
  16
  17   - [KSPP recommended settings][1],
  18   - [CLIP OS kernel configuration][2],
  19   - last public [grsecurity][3] patch (options which they disable),
  20   - [SECURITY_LOCKDOWN_LSM][5] patchset,
  21   - direct feedback from Linux kernel maintainers (Daniel Vetter in [issue #38][6]).
  22
  23 I also created [__Linux Kernel Defence Map__][4] that is a graphical representation of the
  24 relationships between these hardening features and the corresponding vulnerability classes
  25 or exploitation techniques.
  26
  27 ## Supported microarchitectures
  28
  29   - X86_64
  30   - X86_32
  31   - ARM64
  32   - ARM
  33
  34 ## Installation
  35
  36 You can install the package:
  37
  38 ```
  39 pip install git+https://github.com/a13xp0p0v/kconfig-hardened-check
  40 ```
  41
  42 or simply run `./bin/kconfig-hardened-check` from the cloned repository.
  43
  44 ## Usage
  45 ```
  46 usage: kconfig-hardened-check [-h] [--version] [-p {X86_64,X86_32,ARM64,ARM}]
  47                               [-c CONFIG]
  48                               [-m {verbose,json,show_ok,show_fail}]
  49
  50 Checks the hardening options in the Linux kernel config
  51
  52 optional arguments:
  53   -h, --help            show this help message and exit
  54   --version             show program's version number and exit
  55   -p {X86_64,X86_32,ARM64,ARM}, --print {X86_64,X86_32,ARM64,ARM}
  56                         print hardening preferences for selected architecture
  57   -c CONFIG, --config CONFIG
  58                         check the kernel config file against these preferences
  59   -m {verbose,json,show_ok,show_fail}, --mode {verbose,json,show_ok,show_fail}
  60                         choose the report mode
  61 ```
  62
  63 ## Output for `Ubuntu 20.04 LTS (Focal Fossa)` kernel config
  64 ```
  65 $ ./bin/kconfig-hardened-check -c kconfig_hardened_check/config_files/distros/ubuntu-focal.config
  66 [+] Config file to check: kconfig_hardened_check/config_files/distros/ubuntu-focal.config
  67 [+] Detected architecture: X86_64
  68 [+] Detected kernel version: 5.4
  69 =========================================================================================================================
  70                  option name                 | desired val | decision |       reason       |   check result
  71 =========================================================================================================================
  72 CONFIG_BUG                                   |      y      |defconfig |  self_protection   |   OK
  73 CONFIG_SLUB_DEBUG                            |      y      |defconfig |  self_protection   |   OK
  74 CONFIG_GCC_PLUGINS                           |      y      |defconfig |  self_protection   |   FAIL: not found
  75 CONFIG_STACKPROTECTOR_STRONG                 |      y      |defconfig |  self_protection   |   OK
  76 CONFIG_STRICT_KERNEL_RWX                     |      y      |defconfig |  self_protection   |   OK
  77 CONFIG_STRICT_MODULE_RWX                     |      y      |defconfig |  self_protection   |   OK
  78 CONFIG_REFCOUNT_FULL                         |      y      |defconfig |  self_protection   |   FAIL: "is not set"
  79 CONFIG_IOMMU_SUPPORT                         |      y      |defconfig |  self_protection   |   OK
  80 CONFIG_MICROCODE                             |      y      |defconfig |  self_protection   |   OK
  81 CONFIG_RETPOLINE                             |      y      |defconfig |  self_protection   |   OK
  82 CONFIG_X86_SMAP                              |      y      |defconfig |  self_protection   |   OK
  83 CONFIG_SYN_COOKIES                           |      y      |defconfig |  self_protection   |   OK
  84 CONFIG_X86_UMIP                              |      y      |defconfig |  self_protection   |   OK: CONFIG_X86_INTEL_UMIP "y"
  85 CONFIG_PAGE_TABLE_ISOLATION                  |      y      |defconfig |  self_protection   |   OK
  86 CONFIG_RANDOMIZE_MEMORY                      |      y      |defconfig |  self_protection   |   OK
  87 CONFIG_INTEL_IOMMU                           |      y      |defconfig |  self_protection   |   OK
  88 CONFIG_AMD_IOMMU                             |      y      |defconfig |  self_protection   |   OK
  89 CONFIG_VMAP_STACK                            |      y      |defconfig |  self_protection   |   OK
  90 CONFIG_RANDOMIZE_BASE                        |      y      |defconfig |  self_protection   |   OK
  91 CONFIG_THREAD_INFO_IN_TASK                   |      y      |defconfig |  self_protection   |   OK
  92 CONFIG_BUG_ON_DATA_CORRUPTION                |      y      |   kspp   |  self_protection   |   FAIL: "is not set"
  93 CONFIG_DEBUG_WX                              |      y      |   kspp   |  self_protection   |   OK
  94 CONFIG_SCHED_STACK_END_CHECK                 |      y      |   kspp   |  self_protection   |   OK
  95 CONFIG_SLAB_FREELIST_HARDENED                |      y      |   kspp   |  self_protection   |   OK
  96 CONFIG_SLAB_FREELIST_RANDOM                  |      y      |   kspp   |  self_protection   |   OK
  97 CONFIG_SHUFFLE_PAGE_ALLOCATOR                |      y      |   kspp   |  self_protection   |   OK
  98 CONFIG_FORTIFY_SOURCE                        |      y      |   kspp   |  self_protection   |   OK
  99 CONFIG_DEBUG_LIST                            |      y      |   kspp   |  self_protection   |   FAIL: "is not set"
 100 CONFIG_DEBUG_SG                              |      y      |   kspp   |  self_protection   |   FAIL: "is not set"
 101 CONFIG_DEBUG_CREDENTIALS                     |      y      |   kspp   |  self_protection   |   FAIL: "is not set"
 102 CONFIG_DEBUG_NOTIFIERS                       |      y      |   kspp   |  self_protection   |   FAIL: "is not set"
 103 CONFIG_INIT_ON_ALLOC_DEFAULT_ON              |      y      |   kspp   |  self_protection   |   OK
 104 CONFIG_GCC_PLUGIN_LATENT_ENTROPY             |      y      |   kspp   |  self_protection   |   FAIL: not found
 105 CONFIG_GCC_PLUGIN_RANDSTRUCT                 |      y      |   kspp   |  self_protection   |   FAIL: not found
 106 CONFIG_HARDENED_USERCOPY                     |      y      |   kspp   |  self_protection   |   OK
 107 CONFIG_HARDENED_USERCOPY_FALLBACK            | is not set  |   kspp   |  self_protection   |   FAIL: "y"
 108 CONFIG_MODULE_SIG                            |      y      |   kspp   |  self_protection   |   OK
 109 CONFIG_MODULE_SIG_ALL                        |      y      |   kspp   |  self_protection   |   OK
 110 CONFIG_MODULE_SIG_SHA512                     |      y      |   kspp   |  self_protection   |   OK
 111 CONFIG_MODULE_SIG_FORCE                      |      y      |   kspp   |  self_protection   |   FAIL: "is not set"
 112 CONFIG_INIT_STACK_ALL                        |      y      |   kspp   |  self_protection   |   FAIL: not found
 113 CONFIG_INIT_ON_FREE_DEFAULT_ON               |      y      |   kspp   |  self_protection   |   OK: CONFIG_PAGE_POISONING "y"
 114 CONFIG_GCC_PLUGIN_STACKLEAK                  |      y      |   kspp   |  self_protection   |   FAIL: not found
 115 CONFIG_DEFAULT_MMAP_MIN_ADDR                 |    65536    |   kspp   |  self_protection   |   OK
 116 CONFIG_SECURITY_DMESG_RESTRICT               |      y      |  clipos  |  self_protection   |   FAIL: "is not set"
 117 CONFIG_DEBUG_VIRTUAL                         |      y      |  clipos  |  self_protection   |   FAIL: "is not set"
 118 CONFIG_STATIC_USERMODEHELPER                 |      y      |  clipos  |  self_protection   |   FAIL: "is not set"
 119 CONFIG_EFI_DISABLE_PCI_DMA                   |      y      |  clipos  |  self_protection   |   FAIL: not found
 120 CONFIG_SLAB_MERGE_DEFAULT                    | is not set  |  clipos  |  self_protection   |   FAIL: "y"
 121 CONFIG_RANDOM_TRUST_BOOTLOADER               | is not set  |  clipos  |  self_protection   |   FAIL: "y"
 122 CONFIG_RANDOM_TRUST_CPU                      | is not set  |  clipos  |  self_protection   |   FAIL: "y"
 123 CONFIG_GCC_PLUGIN_RANDSTRUCT_PERFORMANCE     | is not set  |  clipos  |  self_protection   |   FAIL: CONFIG_GCC_PLUGIN_RANDSTRUCT not "y"
 124 CONFIG_STACKLEAK_METRICS                     | is not set  |  clipos  |  self_protection   |   FAIL: CONFIG_GCC_PLUGIN_STACKLEAK not "y"
 125 CONFIG_STACKLEAK_RUNTIME_DISABLE             | is not set  |  clipos  |  self_protection   |   FAIL: CONFIG_GCC_PLUGIN_STACKLEAK not "y"
 126 CONFIG_INTEL_IOMMU_SVM                       |      y      |  clipos  |  self_protection   |   OK
 127 CONFIG_INTEL_IOMMU_DEFAULT_ON                |      y      |  clipos  |  self_protection   |   FAIL: "is not set"
 128 CONFIG_SLUB_DEBUG_ON                         |      y      |    my    |  self_protection   |   FAIL: "is not set"
 129 CONFIG_RESET_ATTACK_MITIGATION               |      y      |    my    |  self_protection   |   OK
 130 CONFIG_AMD_IOMMU_V2                          |      y      |    my    |  self_protection   |   FAIL: "m"
 131 CONFIG_SECURITY                              |      y      |defconfig |  security_policy   |   OK
 132 CONFIG_SECURITY_YAMA                         |      y      |   kspp   |  security_policy   |   OK
 133 CONFIG_SECURITY_WRITABLE_HOOKS               | is not set  |    my    |  security_policy   |   OK: not found
 134 CONFIG_SECURITY_LOCKDOWN_LSM                 |      y      |  clipos  |  security_policy   |   OK
 135 CONFIG_SECURITY_LOCKDOWN_LSM_EARLY           |      y      |  clipos  |  security_policy   |   OK
 136 CONFIG_LOCK_DOWN_KERNEL_FORCE_CONFIDENTIALITY|      y      |  clipos  |  security_policy   |   FAIL: "is not set"
 137 CONFIG_SECURITY_SAFESETID                    |      y      |    my    |  security_policy   |   OK
 138 CONFIG_SECURITY_LOADPIN                      |      y      |    my    |  security_policy   |   FAIL: "is not set"
 139 CONFIG_SECURITY_LOADPIN_ENFORCE              |      y      |    my    |  security_policy   |   FAIL: CONFIG_SECURITY_LOADPIN not "y"
 140 CONFIG_SECCOMP                               |      y      |defconfig | cut_attack_surface |   OK
 141 CONFIG_SECCOMP_FILTER                        |      y      |defconfig | cut_attack_surface |   OK
 142 CONFIG_STRICT_DEVMEM                         |      y      |defconfig | cut_attack_surface |   OK
 143 CONFIG_ACPI_CUSTOM_METHOD                    | is not set  |   kspp   | cut_attack_surface |   OK
 144 CONFIG_COMPAT_BRK                            | is not set  |   kspp   | cut_attack_surface |   OK
 145 CONFIG_DEVKMEM                               | is not set  |   kspp   | cut_attack_surface |   OK
 146 CONFIG_COMPAT_VDSO                           | is not set  |   kspp   | cut_attack_surface |   OK
 147 CONFIG_BINFMT_MISC                           | is not set  |   kspp   | cut_attack_surface |   FAIL: "m"
 148 CONFIG_INET_DIAG                             | is not set  |   kspp   | cut_attack_surface |   FAIL: "m"
 149 CONFIG_KEXEC                                 | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 150 CONFIG_PROC_KCORE                            | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 151 CONFIG_LEGACY_PTYS                           | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 152 CONFIG_HIBERNATION                           | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 153 CONFIG_IA32_EMULATION                        | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 154 CONFIG_X86_X32                               | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 155 CONFIG_MODIFY_LDT_SYSCALL                    | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 156 CONFIG_OABI_COMPAT                           | is not set  |   kspp   | cut_attack_surface |   OK: not found
 157 CONFIG_MODULES                               | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 158 CONFIG_DEVMEM                                | is not set  |   kspp   | cut_attack_surface |   FAIL: "y"
 159 CONFIG_IO_STRICT_DEVMEM                      |      y      |   kspp   | cut_attack_surface |   FAIL: "is not set"
 160 CONFIG_LEGACY_VSYSCALL_NONE                  |      y      |   kspp   | cut_attack_surface |   FAIL: "is not set"
 161 CONFIG_ZSMALLOC_STAT                         | is not set  |grsecurity| cut_attack_surface |   OK
 162 CONFIG_PAGE_OWNER                            | is not set  |grsecurity| cut_attack_surface |   OK
 163 CONFIG_DEBUG_KMEMLEAK                        | is not set  |grsecurity| cut_attack_surface |   OK
 164 CONFIG_BINFMT_AOUT                           | is not set  |grsecurity| cut_attack_surface |   OK: not found
 165 CONFIG_KPROBES                               | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 166 CONFIG_UPROBES                               | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 167 CONFIG_GENERIC_TRACER                        | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 168 CONFIG_PROC_VMCORE                           | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 169 CONFIG_PROC_PAGE_MONITOR                     | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 170 CONFIG_USELIB                                | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 171 CONFIG_CHECKPOINT_RESTORE                    | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 172 CONFIG_USERFAULTFD                           | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 173 CONFIG_HWPOISON_INJECT                       | is not set  |grsecurity| cut_attack_surface |   FAIL: "m"
 174 CONFIG_MEM_SOFT_DIRTY                        | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 175 CONFIG_DEVPORT                               | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 176 CONFIG_DEBUG_FS                              | is not set  |grsecurity| cut_attack_surface |   FAIL: "y"
 177 CONFIG_NOTIFIER_ERROR_INJECTION              | is not set  |grsecurity| cut_attack_surface |   FAIL: "m"
 178 CONFIG_X86_PTDUMP                            | is not set  |grsecurity| cut_attack_surface |   OK
 179 CONFIG_DRM_LEGACY                            | is not set  |maintainer| cut_attack_surface |   OK
 180 CONFIG_FB                                    | is not set  |maintainer| cut_attack_surface |   FAIL: "y"
 181 CONFIG_VT                                    | is not set  |maintainer| cut_attack_surface |   FAIL: "y"
 182 CONFIG_AIO                                   | is not set  |grapheneos| cut_attack_surface |   FAIL: "y"
 183 CONFIG_STAGING                               | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 184 CONFIG_KSM                                   | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 185 CONFIG_KALLSYMS                              | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 186 CONFIG_X86_VSYSCALL_EMULATION                | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 187 CONFIG_MAGIC_SYSRQ                           | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 188 CONFIG_KEXEC_FILE                            | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 189 CONFIG_USER_NS                               | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 190 CONFIG_X86_MSR                               | is not set  |  clipos  | cut_attack_surface |   FAIL: "m"
 191 CONFIG_X86_CPUID                             | is not set  |  clipos  | cut_attack_surface |   FAIL: "m"
 192 CONFIG_IO_URING                              | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 193 CONFIG_X86_IOPL_IOPERM                       | is not set  |  clipos  | cut_attack_surface |   OK: not found
 194 CONFIG_LDISC_AUTOLOAD                        | is not set  |  clipos  | cut_attack_surface |   FAIL: "y"
 195 CONFIG_X86_INTEL_TSX_MODE_OFF                |      y      |  clipos  | cut_attack_surface |   OK
 196 CONFIG_ACPI_TABLE_UPGRADE                    | is not set  | lockdown | cut_attack_surface |   FAIL: "y"
 197 CONFIG_EFI_TEST                              | is not set  | lockdown | cut_attack_surface |   FAIL: "m"
 198 CONFIG_BPF_SYSCALL                           | is not set  | lockdown | cut_attack_surface |   FAIL: "y"
 199 CONFIG_MMIOTRACE_TEST                        | is not set  | lockdown | cut_attack_surface |   OK
 200 CONFIG_MMIOTRACE                             | is not set  |    my    | cut_attack_surface |   FAIL: "y"
 201 CONFIG_LIVEPATCH                             | is not set  |    my    | cut_attack_surface |   FAIL: "y"
 202 CONFIG_IP_DCCP                               | is not set  |    my    | cut_attack_surface |   FAIL: "m"
 203 CONFIG_IP_SCTP                               | is not set  |    my    | cut_attack_surface |   FAIL: "m"
 204 CONFIG_FTRACE                                | is not set  |    my    | cut_attack_surface |   FAIL: "y"
 205 CONFIG_BPF_JIT                               | is not set  |    my    | cut_attack_surface |   FAIL: "y"
 206 CONFIG_VIDEO_VIVID                           | is not set  |    my    | cut_attack_surface |   FAIL: "m"
 207 CONFIG_INPUT_EVBUG                           | is not set  |    my    | cut_attack_surface |   FAIL: "m"
 208 CONFIG_INTEGRITY                             |      y      |defconfig |userspace_hardening |   OK
 209 CONFIG_ARCH_MMAP_RND_BITS                    |     32      |  clipos  |userspace_hardening |   FAIL: "28"
 210
 211 [+] Config check is finished: 'OK' - 57 / 'FAIL' - 81
 212 ```
 213
 214 ## kconfig-hardened-check versioning
 215
 216 I usually update the kernel hardening recommendations after each Linux kernel release.
 217
 218 So the version of `kconfig-hardened-check` is associated with the corresponding version of the kernel.
 219
 220 The version format is: __[major_number].[kernel_version].[kernel_patchlevel]__
 221
 222
 223 ## Questions and answers
 224
 225 __Q:__ How disabling `CONFIG_USER_NS` cuts the attack surface? It's needed for containers!
 226
 227 __A:__ Yes, the `CONFIG_USER_NS` option provides some isolation between the userspace programs,
 228 but the tool recommends disabling it to cut the attack surface __of the kernel__.
 229
 230 The rationale:
 231
 232   - A nice LWN article about the corresponding LKML discussion: https://lwn.net/Articles/673597/
 233
 234   - A twitter thread about `CONFIG_USER_NS` and security: https://twitter.com/robertswiecki/status/1095447678949953541
 235
 236   - 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
 237
 238 <br />
 239
 240 __Q:__ Why `CONFIG_GCC_PLUGINS` is automatically disabled during the kernel compilation?
 241
 242 __A:__ It means that your gcc doesn't support plugins. For example, if you have `gcc-7` on Ubuntu,
 243 try to install `gcc-7-plugin-dev` package, it should help.
 244
 245 <br />
 246
 247 __Q:__ KSPP and CLIP OS recommend `CONFIG_PANIC_ON_OOPS=y`. Why doesn't this tool do the same?
 248
 249 __A:__ I personally don't support this recommendation because it provides easy denial-of-service
 250 attacks for the whole system (kernel oops is not a rare situation). I think having `CONFIG_BUG` is enough here --
 251 if we have a kernel oops in the process context, the offending/attacking process is killed.
 252
 253 <br />
 254
 255 __Q:__ What about performance impact of these kernel hardening options?
 256
 257 __A:__ Ike Devolder [@BlackIkeEagle][7] made some performance tests and described the results in [this article][8].
 258
 259 <br />
 260
 261 __Q:__ Why enabling `CONFIG_STATIC_USERMODEHELPER` breaks various things in my GNU/Linux system?
 262 Do I really need that feature?
 263
 264 __A:__ Linux kernel usermode helpers can be used for privilege escalation in kernel exploits
 265 ([example 1][9], [example 2][10]). `CONFIG_STATIC_USERMODEHELPER` prevents that method. But it
 266 requires the corresponding support in the userspace: see the [example implementation][11] by
 267 Tycho Andersen [@tych0][12].
 268
 269 <br />
 270
 271 __Q:__ Does my kernel have all those mitigations of Transient Execution Vulnerabilities in my hardware?
 272
 273 __A:__ Checking the kernel config is not enough to answer this question.
 274 I highly recommend using [spectre-meltdown-checker][13] tool maintained by Stéphane Lesimple [@speed47][14].
 275
 276
 277 [1]: http://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project/Recommended_Settings
 278 [2]: https://docs.clip-os.org/clipos/kernel.html#configuration
 279 [3]: https://grsecurity.net/
 280 [4]: https://github.com/a13xp0p0v/linux-kernel-defence-map
 281 [5]: https://lwn.net/Articles/791863/
 282 [6]: https://github.com/a13xp0p0v/kconfig-hardened-check/issues/38
 283 [7]: https://github.com/BlackIkeEagle
 284 [8]: https://blog.herecura.eu/blog/2020-05-30-kconfig-hardening-tests/
 285 [9]: https://googleprojectzero.blogspot.com/2018/09/a-cache-invalidation-bug-in-linux.html
 286 [10]: https://a13xp0p0v.github.io/2020/02/15/CVE-2019-18683.html
 287 [11]: https://github.com/tych0/huldufolk
 288 [12]: https://github.com/tych0
 289 [13]: https://github.com/speed47/spectre-meltdown-checker
 290 [14]: https://github.com/speed47