kernel_hardening_checker/engine.py

   1 #!/usr/bin/env python3
   2
   3 """
   4 This tool is for checking the security hardening options of the Linux kernel.
   5
   6 Author: Alexander Popov <alex.popov@linux.com>
   7
   8 This module is the engine of checks.
   9 """
  10
  11 # pylint: disable=missing-class-docstring,missing-function-docstring
  12 # pylint: disable=line-too-long,invalid-name,too-many-branches
  13
  14 GREEN_COLOR = '\x1b[32m'
  15 RED_COLOR = '\x1b[31m'
  16 COLOR_END = '\x1b[0m'
  17
  18 def colorize_result(input_text):
  19     if input_text is None:
  20         return input_text
  21     if input_text.startswith('OK'):
  22         color = GREEN_COLOR
  23     else:
  24         assert(input_text.startswith('FAIL:')), f'unexpected result "{input_text}"'
  25         color = RED_COLOR
  26     return f'{color}{input_text}{COLOR_END}'
  27
  28
  29 class OptCheck:
  30     def __init__(self, reason, decision, name, expected):
  31         assert(name and name == name.strip() and len(name.split()) == 1), \
  32                f'invalid name "{name}" for {self.__class__.__name__}'
  33         self.name = name
  34
  35         assert(decision and decision == decision.strip() and len(decision.split()) == 1), \
  36                f'invalid decision "{decision}" for "{name}" check'
  37         self.decision = decision
  38
  39         assert(reason and reason == reason.strip() and len(reason.split()) == 1), \
  40                f'invalid reason "{reason}" for "{name}" check'
  41         self.reason = reason
  42
  43         assert(expected and expected == expected.strip()), \
  44                f'invalid expected value "{expected}" for "{name}" check (1)'
  45         val_len = len(expected.split())
  46         if val_len == 3:
  47             assert(expected in ('is not set', 'is not off')), \
  48                    f'invalid expected value "{expected}" for "{name}" check (2)'
  49         elif val_len == 2:
  50             assert(expected == 'is present'), \
  51                    f'invalid expected value "{expected}" for "{name}" check (3)'
  52         else:
  53             assert(val_len == 1), \
  54                    f'invalid expected value "{expected}" for "{name}" check (4)'
  55         self.expected = expected
  56
  57         self.state = None
  58         self.result = None
  59
  60     @property
  61     def type(self):
  62         return None
  63
  64     def check(self):
  65         # handle the 'is present' check
  66         if self.expected == 'is present':
  67             if self.state is None:
  68                 self.result = 'FAIL: is not present'
  69             else:
  70                 self.result = 'OK: is present'
  71             return
  72
  73         # handle the 'is not off' option check
  74         if self.expected == 'is not off':
  75             if self.state == 'off':
  76                 self.result = 'FAIL: is off'
  77             elif self.state == '0':
  78                 self.result = 'FAIL: is off, "0"'
  79             elif self.state is None:
  80                 self.result = 'FAIL: is off, not found'
  81             else:
  82                 self.result = f'OK: is not off, "{self.state}"'
  83             return
  84
  85         # handle the option value check
  86         if self.expected == self.state:
  87             self.result = 'OK'
  88         elif self.state is None:
  89             if self.expected == 'is not set':
  90                 self.result = 'OK: is not found'
  91             else:
  92                 self.result = 'FAIL: is not found'
  93         else:
  94             self.result = f'FAIL: "{self.state}"'
  95
  96     def table_print(self, _mode, with_results):
  97         print(f'{self.name:<40}|{self.type:^7}|{self.expected:^12}|{self.decision:^10}|{self.reason:^18}', end='')
  98         if with_results:
  99             print(f'| {colorize_result(self.result)}', end='')
 100
 101     def json_dump(self, with_results):
 102         dump = [self.name, self.type, self.expected, self.decision, self.reason]
 103         if with_results:
 104             dump.append(self.result)
 105         return dump
 106
 107
 108 class KconfigCheck(OptCheck):
 109     def __init__(self, *args, **kwargs):
 110         super().__init__(*args, **kwargs)
 111         self.name = 'CONFIG_' + self.name
 112
 113     @property
 114     def type(self):
 115         return 'kconfig'
 116
 117
 118 class CmdlineCheck(OptCheck):
 119     @property
 120     def type(self):
 121         return 'cmdline'
 122
 123
 124 class SysctlCheck(OptCheck):
 125     @property
 126     def type(self):
 127         return 'sysctl'
 128
 129
 130 class VersionCheck:
 131     def __init__(self, ver_expected):
 132         assert(ver_expected and isinstance(ver_expected, tuple) and len(ver_expected) == 2), \
 133                f'invalid version "{ver_expected}" for VersionCheck'
 134         self.ver_expected = ver_expected
 135         self.ver = ()
 136         self.result = None
 137
 138     @property
 139     def type(self):
 140         return 'version'
 141
 142     def check(self):
 143         if self.ver[0] > self.ver_expected[0]:
 144             self.result = f'OK: version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
 145             return
 146         if self.ver[0] < self.ver_expected[0]:
 147             self.result = f'FAIL: version < {self.ver_expected[0]}.{self.ver_expected[1]}'
 148             return
 149         if self.ver[1] >= self.ver_expected[1]:
 150             self.result = f'OK: version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
 151             return
 152         self.result = f'FAIL: version < {self.ver_expected[0]}.{self.ver_expected[1]}'
 153
 154     def table_print(self, _mode, with_results):
 155         ver_req = f'kernel version >= {self.ver_expected[0]}.{self.ver_expected[1]}'
 156         print(f'{ver_req:<91}', end='')
 157         if with_results:
 158             print(f'| {colorize_result(self.result)}', end='')
 159
 160
 161 class ComplexOptCheck:
 162     def __init__(self, *opts):
 163         self.opts = opts
 164         assert(self.opts), \
 165                f'empty {self.__class__.__name__} check'
 166         assert(len(self.opts) != 1), \
 167                f'useless {self.__class__.__name__} check: {opts}'
 168         assert(isinstance(opts[0], (KconfigCheck, CmdlineCheck, SysctlCheck))), \
 169                f'invalid {self.__class__.__name__} check: {opts}'
 170         self.result = None
 171
 172     @property
 173     def type(self):
 174         return 'complex'
 175
 176     @property
 177     def name(self):
 178         return self.opts[0].name
 179
 180     @property
 181     def expected(self):
 182         return self.opts[0].expected
 183
 184     def table_print(self, mode, with_results):
 185         if mode == 'verbose':
 186             print(f'    {"<<< " + self.__class__.__name__ + " >>>":87}', end='')
 187             if with_results:
 188                 print(f'| {colorize_result(self.result)}', end='')
 189             for o in self.opts:
 190                 print()
 191                 o.table_print(mode, with_results)
 192         else:
 193             o = self.opts[0]
 194             o.table_print(mode, False)
 195             if with_results:
 196                 print(f'| {colorize_result(self.result)}', end='')
 197
 198     def json_dump(self, with_results):
 199         dump = self.opts[0].json_dump(False)
 200         if with_results:
 201             dump.append(self.result)
 202         return dump
 203
 204
 205 class OR(ComplexOptCheck):
 206     # self.opts[0] is the option that this OR-check is about.
 207     # Use cases:
 208     #     OR(<X_is_hardened>, <X_is_disabled>)
 209     #     OR(<X_is_hardened>, <old_X_is_hardened>)
 210     def check(self):
 211         for i, opt in enumerate(self.opts):
 212             opt.check()
 213             if opt.result.startswith('OK'):
 214                 self.result = opt.result
 215                 # Add more info for additional checks:
 216                 if i != 0:
 217                     if opt.result == 'OK':
 218                         self.result = f'OK: {opt.name} is "{opt.expected}"'
 219                     elif opt.result == 'OK: is not found':
 220                         self.result = f'OK: {opt.name} is not found'
 221                     elif opt.result == 'OK: is present':
 222                         self.result = f'OK: {opt.name} is present'
 223                     elif opt.result.startswith('OK: is not off'):
 224                         self.result = f'OK: {opt.name} is not off'
 225                     else:
 226                         # VersionCheck provides enough info
 227                         assert(opt.result.startswith('OK: version')), \
 228                                f'unexpected OK description "{opt.result}"'
 229                 return
 230         self.result = self.opts[0].result
 231
 232
 233 class AND(ComplexOptCheck):
 234     # self.opts[0] is the option that this AND-check is about.
 235     # Use cases:
 236     #     AND(<suboption>, <main_option>)
 237     #       Suboption is not checked if checking of the main_option is failed.
 238     #     AND(<X_is_disabled>, <old_X_is_disabled>)
 239     def check(self):
 240         for i, opt in reversed(list(enumerate(self.opts))):
 241             opt.check()
 242             if i == 0:
 243                 self.result = opt.result
 244                 return
 245             if not opt.result.startswith('OK'):
 246                 # This FAIL is caused by additional checks,
 247                 # and not by the main option that this AND-check is about.
 248                 # Describe the reason of the FAIL.
 249                 if opt.result.startswith('FAIL: \"') or opt.result == 'FAIL: is not found':
 250                     self.result = f'FAIL: {opt.name} is not "{opt.expected}"'
 251                 elif opt.result == 'FAIL: is not present':
 252                     self.result = f'FAIL: {opt.name} is not present'
 253                 elif opt.result in ('FAIL: is off', 'FAIL: is off, "0"'):
 254                     self.result = f'FAIL: {opt.name} is off'
 255                 elif opt.result == 'FAIL: is off, not found':
 256                     self.result = f'FAIL: {opt.name} is off, not found'
 257                 else:
 258                     # VersionCheck provides enough info
 259                     self.result = opt.result
 260                     assert(opt.result.startswith('FAIL: version')), \
 261                            f'unexpected FAIL description "{opt.result}"'
 262                 return
 263
 264
 265 SIMPLE_OPTION_TYPES = ('kconfig', 'cmdline', 'sysctl', 'version')
 266
 267
 268 def populate_simple_opt_with_data(opt, data, data_type):
 269     assert(opt.type != 'complex'), \
 270            f'unexpected ComplexOptCheck "{opt.name}"'
 271     assert(opt.type in SIMPLE_OPTION_TYPES), \
 272            f'invalid opt type "{opt.type}"'
 273     assert(data_type in SIMPLE_OPTION_TYPES), \
 274            f'invalid data type "{data_type}"'
 275     assert(data), \
 276            'empty data'
 277
 278     if data_type != opt.type:
 279         return
 280
 281     if data_type in ('kconfig', 'cmdline', 'sysctl'):
 282         opt.state = data.get(opt.name, None)
 283     else:
 284         assert(data_type == 'version'), \
 285                f'unexpected data type "{data_type}"'
 286         opt.ver = data
 287
 288
 289 def populate_opt_with_data(opt, data, data_type):
 290     assert(opt.type != 'version'), 'a single VersionCheck is useless'
 291     if opt.type != 'complex':
 292         populate_simple_opt_with_data(opt, data, data_type)
 293     else:
 294         for o in opt.opts:
 295             if o.type != 'complex':
 296                 populate_simple_opt_with_data(o, data, data_type)
 297             else:
 298                 # Recursion for nested ComplexOptCheck objects
 299                 populate_opt_with_data(o, data, data_type)
 300
 301
 302 def populate_with_data(checklist, data, data_type):
 303     for opt in checklist:
 304         populate_opt_with_data(opt, data, data_type)
 305
 306
 307 def override_expected_value(checklist, name, new_val):
 308     for opt in checklist:
 309         if opt.name == name:
 310             assert(opt.type in ('kconfig', 'cmdline', 'sysctl')), \
 311                    f'overriding an expected value for "{opt.type}" checks is not supported yet'
 312             opt.expected = new_val
 313
 314
 315 def perform_checks(checklist):
 316     for opt in checklist:
 317         opt.check()