Move some features to 'cut_attack_surface' category
[kconfig-hardened-check.git] / 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 for `x86_64`, which are based on the
13 [KSPP recommended settings][1]
14
15 Please don't cry if my Python code looks like C. I'm just a kernel developer.
16
17 ## Script output examples
18
19 ### Usage
20 ```
21 #./kconfig-hardened-check.py
22 Usage: ./kconfig-hardened-check.py [-p | -c <config_file>]
23  -p, --print
24         print hardening preferences
25  -c <config_file>, --config=<config_file>
26         check the config_file against these preferences
27 ```
28
29 ### Script output for `Ubuntu 18.04 (Bionic Beaver)` kernel config
30 ```
31 ./kconfig-hardened-check.py -c ubuntu-bionic-generic.config
32 [+] Checking "ubuntu-bionic-generic.config" against hardening preferences...
33   option name                            | desired val | decision |       reason       ||    check result    
34   ===========================================================================================================
35   CONFIG_BUG                             |      y      | ubuntu18 |  self_protection   ||         OK         
36   CONFIG_PAGE_TABLE_ISOLATION            |      y      | ubuntu18 |  self_protection   ||         OK         
37   CONFIG_RETPOLINE                       |      y      | ubuntu18 |  self_protection   ||         OK         
38   CONFIG_X86_64                          |      y      | ubuntu18 |  self_protection   ||         OK         
39   CONFIG_STRICT_KERNEL_RWX               |      y      | ubuntu18 |  self_protection   ||         OK         
40   CONFIG_STRICT_MODULE_RWX               |      y      | ubuntu18 |  self_protection   ||         OK         
41   CONFIG_DEBUG_WX                        |      y      | ubuntu18 |  self_protection   ||         OK         
42   CONFIG_RANDOMIZE_BASE                  |      y      | ubuntu18 |  self_protection   ||         OK         
43   CONFIG_RANDOMIZE_MEMORY                |      y      | ubuntu18 |  self_protection   ||         OK         
44   CONFIG_CC_STACKPROTECTOR               |      y      | ubuntu18 |  self_protection   ||         OK         
45   CONFIG_CC_STACKPROTECTOR_STRONG        |      y      | ubuntu18 |  self_protection   ||         OK         
46   CONFIG_VMAP_STACK                      |      y      | ubuntu18 |  self_protection   ||         OK         
47   CONFIG_THREAD_INFO_IN_TASK             |      y      | ubuntu18 |  self_protection   ||         OK         
48   CONFIG_SCHED_STACK_END_CHECK           |      y      | ubuntu18 |  self_protection   ||         OK         
49   CONFIG_SLUB_DEBUG                      |      y      | ubuntu18 |  self_protection   ||         OK         
50   CONFIG_SLAB_FREELIST_HARDENED          |      y      | ubuntu18 |  self_protection   ||         OK         
51   CONFIG_SLAB_FREELIST_RANDOM            |      y      | ubuntu18 |  self_protection   ||         OK         
52   CONFIG_HARDENED_USERCOPY               |      y      | ubuntu18 |  self_protection   ||         OK         
53   CONFIG_FORTIFY_SOURCE                  |      y      | ubuntu18 |  self_protection   ||         OK         
54   CONFIG_MODULE_SIG                      |      y      | ubuntu18 |  self_protection   ||         OK         
55   CONFIG_MODULE_SIG_ALL                  |      y      | ubuntu18 |  self_protection   ||         OK         
56   CONFIG_MODULE_SIG_SHA512               |      y      | ubuntu18 |  self_protection   ||         OK         
57   CONFIG_SYN_COOKIES                     |      y      | ubuntu18 |  self_protection   ||         OK         
58   CONFIG_DEFAULT_MMAP_MIN_ADDR           |    65536    | ubuntu18 |  self_protection   ||         OK         
59   CONFIG_BUG_ON_DATA_CORRUPTION          |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
60   CONFIG_PAGE_POISONING                  |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
61   CONFIG_GCC_PLUGINS                     |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
62   CONFIG_GCC_PLUGIN_RANDSTRUCT           |      y      |   kspp   |  self_protection   ||  FAIL: not found   
63   CONFIG_GCC_PLUGIN_STRUCTLEAK           |      y      |   kspp   |  self_protection   ||  FAIL: not found   
64   CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF_ALL |      y      |   kspp   |  self_protection   ||  FAIL: not found   
65   CONFIG_GCC_PLUGIN_LATENT_ENTROPY       |      y      |   kspp   |  self_protection   ||  FAIL: not found   
66   CONFIG_REFCOUNT_FULL                   |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
67   CONFIG_DEBUG_LIST                      |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
68   CONFIG_DEBUG_SG                        |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
69   CONFIG_DEBUG_CREDENTIALS               |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
70   CONFIG_DEBUG_NOTIFIERS                 |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
71   CONFIG_MODULE_SIG_FORCE                |      y      |   kspp   |  self_protection   || FAIL: "is not set" 
72   CONFIG_HARDENED_USERCOPY_FALLBACK      | is not set  |   kspp   |  self_protection   ||  FAIL: not found   
73   CONFIG_GCC_PLUGIN_STACKLEAK            |      y      |    my    |  self_protection   ||  FAIL: not found   
74   CONFIG_SLUB_DEBUG_ON                   |      y      |    my    |  self_protection   || FAIL: "is not set" 
75   CONFIG_SECURITY_DMESG_RESTRICT         |      y      |    my    |  self_protection   || FAIL: "is not set" 
76   CONFIG_STATIC_USERMODEHELPER           |      y      |    my    |  self_protection   || FAIL: "is not set" 
77   CONFIG_PAGE_POISONING_NO_SANITY        | is not set  |    my    |  self_protection   ||  FAIL: not found   
78   CONFIG_PAGE_POISONING_ZERO             | is not set  |    my    |  self_protection   ||  FAIL: not found   
79   CONFIG_SECURITY                        |      y      | ubuntu18 |  security_policy   ||         OK         
80   CONFIG_SECURITY_YAMA                   |      y      | ubuntu18 |  security_policy   ||         OK         
81   CONFIG_SECURITY_SELINUX_DISABLE        | is not set  | ubuntu18 |  security_policy   ||         OK         
82   CONFIG_SECCOMP                         |      y      | ubuntu18 | cut_attack_surface ||         OK         
83   CONFIG_SECCOMP_FILTER                  |      y      | ubuntu18 | cut_attack_surface ||         OK         
84   CONFIG_STRICT_DEVMEM                   |      y      | ubuntu18 | cut_attack_surface ||         OK         
85   CONFIG_ACPI_CUSTOM_METHOD              | is not set  | ubuntu18 | cut_attack_surface ||         OK         
86   CONFIG_COMPAT_BRK                      | is not set  | ubuntu18 | cut_attack_surface ||         OK         
87   CONFIG_DEVKMEM                         | is not set  | ubuntu18 | cut_attack_surface ||         OK         
88   CONFIG_COMPAT_VDSO                     | is not set  | ubuntu18 | cut_attack_surface ||         OK         
89   CONFIG_IO_STRICT_DEVMEM                |      y      |   kspp   | cut_attack_surface || FAIL: "is not set" 
90   CONFIG_LEGACY_VSYSCALL_NONE            |      y      |   kspp   | cut_attack_surface || FAIL: "is not set" 
91   CONFIG_BINFMT_MISC                     | is not set  |   kspp   | cut_attack_surface ||     FAIL: "m"      
92   CONFIG_INET_DIAG                       | is not set  |   kspp   | cut_attack_surface ||     FAIL: "m"      
93   CONFIG_KEXEC                           | is not set  |   kspp   | cut_attack_surface ||     FAIL: "y"      
94   CONFIG_PROC_KCORE                      | is not set  |   kspp   | cut_attack_surface ||     FAIL: "y"      
95   CONFIG_LEGACY_PTYS                     | is not set  |   kspp   | cut_attack_surface ||     FAIL: "y"      
96   CONFIG_IA32_EMULATION                  | is not set  |   kspp   | cut_attack_surface ||     FAIL: "y"      
97   CONFIG_X86_X32                         | is not set  |   kspp   | cut_attack_surface ||     FAIL: "y"      
98   CONFIG_MODIFY_LDT_SYSCALL              | is not set  |   kspp   | cut_attack_surface ||     FAIL: "y"      
99   CONFIG_HIBERNATION                     | is not set  |   kspp   | cut_attack_surface ||     FAIL: "y"      
100   CONFIG_KEXEC_FILE                      | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
101   CONFIG_LIVEPATCH                       | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
102   CONFIG_USER_NS                         | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
103   CONFIG_IP_DCCP                         | is not set  |    my    | cut_attack_surface ||     FAIL: "m"      
104   CONFIG_IP_SCTP                         | is not set  |    my    | cut_attack_surface ||     FAIL: "m"      
105   CONFIG_FTRACE                          | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
106   CONFIG_KPROBES                         | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
107   CONFIG_PROFILING                       | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
108   CONFIG_UPROBES                         | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
109   CONFIG_BPF_JIT                         | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
110   CONFIG_BPF_SYSCALL                     | is not set  |    my    | cut_attack_surface ||     FAIL: "y"      
111   CONFIG_ARCH_MMAP_RND_BITS              |     32      |    my    |userspace_protection||     FAIL: "28"     
112   CONFIG_LKDTM                           |      m      |    my    |    feature_test    || FAIL: "is not set" 
113
114 [-] config check is NOT PASSED: 44 errors
115 ```
116
117 __Go and fix them all!__
118
119 [1]: http://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project/Recommended_Settings
120