README.md

   1 # Kconfig hardened check
   2
   3 ## Motivation
   4
   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.
   8
   9 But nobody likes checking configs manually. So let the computers do their job!
  10
  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
  13 [KSPP recommended settings][1] and last public [grsecurity][2] patch (options
  14 which they disable).
  15
  16 Please don't cry if my Python code looks like C. I'm just a kernel developer.
  17
  18 ## Supported microarchitectures
  19
  20   - X86_64
  21   - X86_32
  22   - ARM64
  23   - ARM
  24
  25 ## Script output examples
  26
  27 ### Usage
  28 ```
  29 #usage: kconfig-hardened-check.py [-h] [-p {X86_64,X86_32,ARM64,ARM}]
  30                                  [-c CONFIG] [--debug]
  31
  32 Checks the hardening options in the Linux kernel config
  33
  34 optional arguments:
  35   -h, --help            show this help message and exit
  36   -p {X86_64,X86_32,ARM64,ARM}, --print {X86_64,X86_32,ARM64,ARM}
  37                         print hardening preferences for selected architecture
  38   -c CONFIG, --config CONFIG
  39                         check the config_file against these preferences
  40   --debug               enable internal debug mode
  41
  42 ```
  43
  44 ### Script output for `Ubuntu 18.04 (Bionic Beaver)` kernel config
  45 ```
  46 #./kconfig-hardened-check.py -c config_files/distros/ubuntu-bionic-generic.config
  47 [+] Trying to detect architecture in "config_files/distros/ubuntu-bionic-generic.config"...
  48 [+] Detected architecture: X86_64
  49 [+] Checking "config_files/distros/ubuntu-bionic-generic.config" against hardening preferences...
  50   option name                            | desired val | decision |       reason       ||        check result
  51   ===================================================================================================================
  52   CONFIG_BUG                             |      y      |defconfig |  self_protection   ||             OK
  53   CONFIG_STRICT_KERNEL_RWX               |      y      |defconfig |  self_protection   ||             OK
  54   CONFIG_STACKPROTECTOR_STRONG           |      y      |defconfig |  self_protection   ||CONFIG_CC_STACKPROTECTOR_STRONG: OK ("y")
  55   CONFIG_SLUB_DEBUG                      |      y      |defconfig |  self_protection   ||             OK
  56   CONFIG_STRICT_MODULE_RWX               |      y      |defconfig |  self_protection   ||             OK
  57   CONFIG_PAGE_TABLE_ISOLATION            |      y      |defconfig |  self_protection   ||             OK
  58   CONFIG_RANDOMIZE_MEMORY                |      y      |defconfig |  self_protection   ||             OK
  59   CONFIG_RANDOMIZE_BASE                  |      y      |defconfig |  self_protection   ||             OK
  60   CONFIG_RETPOLINE                       |      y      |defconfig |  self_protection   ||             OK
  61   CONFIG_X86_SMAP                        |      y      |defconfig |  self_protection   ||             OK
  62   CONFIG_X86_INTEL_UMIP                  |      y      |defconfig |  self_protection   ||             OK
  63   CONFIG_SYN_COOKIES                     |      y      |defconfig |  self_protection   ||             OK
  64   CONFIG_VMAP_STACK                      |      y      |defconfig |  self_protection   ||             OK
  65   CONFIG_THREAD_INFO_IN_TASK             |      y      |defconfig |  self_protection   ||             OK
  66   CONFIG_BUG_ON_DATA_CORRUPTION          |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  67   CONFIG_DEBUG_WX                        |      y      |   kspp   |  self_protection   ||             OK
  68   CONFIG_SCHED_STACK_END_CHECK           |      y      |   kspp   |  self_protection   ||             OK
  69   CONFIG_PAGE_POISONING                  |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  70   CONFIG_SLAB_FREELIST_HARDENED          |      y      |   kspp   |  self_protection   ||             OK
  71   CONFIG_SLAB_FREELIST_RANDOM            |      y      |   kspp   |  self_protection   ||             OK
  72   CONFIG_HARDENED_USERCOPY               |      y      |   kspp   |  self_protection   ||             OK
  73   CONFIG_HARDENED_USERCOPY_FALLBACK      | is not set  |   kspp   |  self_protection   ||       OK: not found
  74   CONFIG_FORTIFY_SOURCE                  |      y      |   kspp   |  self_protection   ||             OK
  75   CONFIG_GCC_PLUGINS                     |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  76   CONFIG_GCC_PLUGIN_RANDSTRUCT           |      y      |   kspp   |  self_protection   ||      FAIL: not found
  77   CONFIG_GCC_PLUGIN_STRUCTLEAK           |      y      |   kspp   |  self_protection   ||      FAIL: not found
  78   CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF_ALL |      y      |   kspp   |  self_protection   ||      FAIL: not found
  79   CONFIG_GCC_PLUGIN_LATENT_ENTROPY       |      y      |   kspp   |  self_protection   ||      FAIL: not found
  80   CONFIG_DEBUG_LIST                      |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  81   CONFIG_DEBUG_SG                        |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  82   CONFIG_DEBUG_CREDENTIALS               |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  83   CONFIG_DEBUG_NOTIFIERS                 |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  84   CONFIG_MODULE_SIG                      |      y      |   kspp   |  self_protection   ||             OK
  85   CONFIG_MODULE_SIG_ALL                  |      y      |   kspp   |  self_protection   ||             OK
  86   CONFIG_MODULE_SIG_SHA512               |      y      |   kspp   |  self_protection   ||             OK
  87   CONFIG_MODULE_SIG_FORCE                |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  88   CONFIG_DEFAULT_MMAP_MIN_ADDR           |    65536    |   kspp   |  self_protection   ||             OK
  89   CONFIG_REFCOUNT_FULL                   |      y      |   kspp   |  self_protection   ||     FAIL: "is not set"
  90   CONFIG_GCC_PLUGIN_STACKLEAK            |      y      |    my    |  self_protection   ||      FAIL: not found
  91   CONFIG_LOCK_DOWN_KERNEL                |      y      |    my    |  self_protection   ||             OK
  92   CONFIG_SLUB_DEBUG_ON                   |      y      |    my    |  self_protection   ||     FAIL: "is not set"
  93   CONFIG_SECURITY_DMESG_RESTRICT         |      y      |    my    |  self_protection   ||     FAIL: "is not set"
  94   CONFIG_STATIC_USERMODEHELPER           |      y      |    my    |  self_protection   ||     FAIL: "is not set"
  95   CONFIG_SECURITY_LOADPIN                |      y      |    my    |  self_protection   ||     FAIL: "is not set"
  96   CONFIG_RESET_ATTACK_MITIGATION         |      y      |    my    |  self_protection   ||             OK
  97   CONFIG_PAGE_POISONING_NO_SANITY        | is not set  |    my    |  self_protection   ||       OK: not found
  98   CONFIG_PAGE_POISONING_ZERO             | is not set  |    my    |  self_protection   ||       OK: not found
  99   CONFIG_SLAB_MERGE_DEFAULT              | is not set  |    my    |  self_protection   ||         FAIL: "y"
 100   CONFIG_SECURITY                        |      y      |defconfig |  security_policy   ||             OK
 101   CONFIG_SECURITY_YAMA                   |      y      |   kspp   |  security_policy   ||             OK
 102   CONFIG_SECURITY_SELINUX_DISABLE        | is not set  |   kspp   |  security_policy   ||             OK
 103   CONFIG_SECCOMP                         |      y      |defconfig | cut_attack_surface ||             OK
 104   CONFIG_SECCOMP_FILTER                  |      y      |defconfig | cut_attack_surface ||             OK
 105   CONFIG_STRICT_DEVMEM                   |      y      |defconfig | cut_attack_surface ||             OK
 106   CONFIG_IO_STRICT_DEVMEM                |      y      |   kspp   | cut_attack_surface ||     FAIL: "is not set"
 107   CONFIG_ACPI_CUSTOM_METHOD              | is not set  |   kspp   | cut_attack_surface ||             OK
 108   CONFIG_COMPAT_BRK                      | is not set  |   kspp   | cut_attack_surface ||             OK
 109   CONFIG_DEVKMEM                         | is not set  |   kspp   | cut_attack_surface ||             OK
 110   CONFIG_COMPAT_VDSO                     | is not set  |   kspp   | cut_attack_surface ||             OK
 111   CONFIG_BINFMT_MISC                     | is not set  |   kspp   | cut_attack_surface ||         FAIL: "m"
 112   CONFIG_INET_DIAG                       | is not set  |   kspp   | cut_attack_surface ||         FAIL: "m"
 113   CONFIG_KEXEC                           | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 114   CONFIG_PROC_KCORE                      | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 115   CONFIG_LEGACY_PTYS                     | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 116   CONFIG_HIBERNATION                     | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 117   CONFIG_LEGACY_VSYSCALL_NONE            |      y      |   kspp   | cut_attack_surface ||     FAIL: "is not set"
 118   CONFIG_IA32_EMULATION                  | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 119   CONFIG_X86_X32                         | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 120   CONFIG_MODIFY_LDT_SYSCALL              | is not set  |   kspp   | cut_attack_surface ||         FAIL: "y"
 121   CONFIG_X86_PTDUMP                      | is not set  |grsecurity| cut_attack_surface ||             OK
 122   CONFIG_ZSMALLOC_STAT                   | is not set  |grsecurity| cut_attack_surface ||             OK
 123   CONFIG_PAGE_OWNER                      | is not set  |grsecurity| cut_attack_surface ||             OK
 124   CONFIG_DEBUG_KMEMLEAK                  | is not set  |grsecurity| cut_attack_surface ||             OK
 125   CONFIG_BINFMT_AOUT                     | is not set  |grsecurity| cut_attack_surface ||       OK: not found
 126   CONFIG_KPROBES                         | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 127   CONFIG_UPROBES                         | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 128   CONFIG_GENERIC_TRACER                  | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 129   CONFIG_PROC_VMCORE                     | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 130   CONFIG_PROC_PAGE_MONITOR               | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 131   CONFIG_USELIB                          | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 132   CONFIG_CHECKPOINT_RESTORE              | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 133   CONFIG_USERFAULTFD                     | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 134   CONFIG_HWPOISON_INJECT                 | is not set  |grsecurity| cut_attack_surface ||         FAIL: "m"
 135   CONFIG_MEM_SOFT_DIRTY                  | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 136   CONFIG_DEVPORT                         | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 137   CONFIG_DEBUG_FS                        | is not set  |grsecurity| cut_attack_surface ||         FAIL: "y"
 138   CONFIG_NOTIFIER_ERROR_INJECTION        | is not set  |grsecurity| cut_attack_surface ||         FAIL: "m"
 139   CONFIG_ACPI_TABLE_UPGRADE              | is not set  | lockdown | cut_attack_surface ||         FAIL: "y"
 140   CONFIG_ACPI_APEI_EINJ                  | is not set  | lockdown | cut_attack_surface ||         FAIL: "m"
 141   CONFIG_PROFILING                       | is not set  | lockdown | cut_attack_surface ||         FAIL: "y"
 142   CONFIG_BPF_SYSCALL                     | is not set  | lockdown | cut_attack_surface ||         FAIL: "y"
 143   CONFIG_MMIOTRACE_TEST                  | is not set  | lockdown | cut_attack_surface ||             OK
 144   CONFIG_MMIOTRACE                       | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 145   CONFIG_KEXEC_FILE                      | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 146   CONFIG_LIVEPATCH                       | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 147   CONFIG_USER_NS                         | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 148   CONFIG_IP_DCCP                         | is not set  |    my    | cut_attack_surface ||         FAIL: "m"
 149   CONFIG_IP_SCTP                         | is not set  |    my    | cut_attack_surface ||         FAIL: "m"
 150   CONFIG_FTRACE                          | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 151   CONFIG_BPF_JIT                         | is not set  |    my    | cut_attack_surface ||         FAIL: "y"
 152   CONFIG_ARCH_MMAP_RND_BITS              |     32      |    my    |userspace_protection||         FAIL: "28"
 153
 154 [-] config check is NOT PASSED: 56 errors
 155 ```
 156
 157 __Go and fix them all!__
 158
 159
 160 N.B. If `CONFIG_GCC_PLUGIN*` options are automatically disabled during your kernel compilation,
 161 then your gcc doesn't support plugins. For example, if you have `gcc-7` on Ubuntu, try to install
 162 `gcc-7-plugin-dev` package, it should help.
 163
 164
 165 [1]: http://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project/Recommended_Settings
 166 [2]: https://grsecurity.net/