X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=kernel_hardening_checker%2F__init__.py;h=d3bf1ab724a69241e532af20ea32921d0dc92022;hb=5cf82d04161ffc0f7696611bc529fceaea55d737;hp=cc256f7a0d59662ac830b4e839408223bb0b8cee;hpb=bd43103399c363609ec6d4f5650c64bd58768dba;p=kconfig-hardened-check.git diff --git a/kernel_hardening_checker/__init__.py b/kernel_hardening_checker/__init__.py index cc256f7..d3bf1ab 100644 --- a/kernel_hardening_checker/__init__.py +++ b/kernel_hardening_checker/__init__.py @@ -14,22 +14,21 @@ import gzip import sys from argparse import ArgumentParser from collections import OrderedDict +from typing import List, Tuple, OrderedDict, TextIO import re import json from .__about__ import __version__ from .checks import add_kconfig_checks, add_cmdline_checks, normalize_cmdline_options, add_sysctl_checks -from .engine import populate_with_data, perform_checks, override_expected_value +from .engine import StrOrNone, TupleOrNone, populate_with_data, perform_checks, override_expected_value -def _open(file: str, *args, **kwargs): - open_method = open +def _open(file: str, *args, **kwargs) -> TextIO: if file.endswith('.gz'): - open_method = gzip.open + return gzip.open(file, *args, **kwargs) + return open(file, *args, **kwargs) - return open_method(file, *args, **kwargs) - -def detect_arch(fname, archs): +def detect_arch(fname: str, archs: List[str]) -> Tuple[StrOrNone, str]: with _open(fname, 'rt', encoding='utf-8') as f: arch_pattern = re.compile(r"CONFIG_[a-zA-Z0-9_]+=y$") arch = None @@ -46,23 +45,24 @@ def detect_arch(fname, archs): return arch, 'OK' -def detect_kernel_version(fname): +def detect_kernel_version(fname: str) -> Tuple[TupleOrNone, str]: with _open(fname, 'rt', encoding='utf-8') as f: ver_pattern = re.compile(r"^# Linux/.+ Kernel Configuration$|^Linux version .+") for line in f.readlines(): if ver_pattern.match(line): line = line.strip() parts = line.split() - ver_str = parts[2] + ver_str = parts[2].split('-', 1)[0] ver_numbers = ver_str.split('.') - if len(ver_numbers) < 3 or not ver_numbers[0].isdigit() or not ver_numbers[1].isdigit(): - msg = f'failed to parse the version "{ver_str}"' - return None, msg - return (int(ver_numbers[0]), int(ver_numbers[1])), None + if len(ver_numbers) >= 3: + if all(map(lambda x: x.isdigit(), ver_numbers)): + return tuple(map(int, ver_numbers)), 'OK' + msg = f'failed to parse the version "{parts[2]}"' + return None, msg return None, 'no kernel version detected' -def detect_compiler(fname): +def detect_compiler(fname: str) -> Tuple[StrOrNone, str]: gcc_version = None clang_version = None with _open(fname, 'rt', encoding='utf-8') as f: @@ -80,20 +80,20 @@ def detect_compiler(fname): sys.exit(f'[!] ERROR: invalid GCC_VERSION and CLANG_VERSION: {gcc_version} {clang_version}') -def print_unknown_options(checklist, parsed_options, opt_type): +def print_unknown_options(checklist: List, parsed_options: OrderedDict, opt_type: str) -> None: known_options = [] for o1 in checklist: - if o1.type != 'complex': + if o1.opt_type != 'complex': known_options.append(o1.name) continue for o2 in o1.opts: - if o2.type != 'complex': + if o2.opt_type != 'complex': if hasattr(o2, 'name'): known_options.append(o2.name) continue for o3 in o2.opts: - assert(o3.type != 'complex'), \ + assert(o3.opt_type != 'complex'), \ f'unexpected ComplexOptCheck inside {o2.name}' if hasattr(o3, 'name'): known_options.append(o3.name) @@ -103,7 +103,7 @@ def print_unknown_options(checklist, parsed_options, opt_type): print(f'[?] No check for {opt_type} option {option} ({value})') -def print_checklist(mode, checklist, with_results): +def print_checklist(mode: StrOrNone, checklist: List, with_results: bool) -> None: if mode == 'json': output = [] for opt in checklist: @@ -116,9 +116,9 @@ def print_checklist(mode, checklist, with_results): if with_results: sep_line_len += 30 print('=' * sep_line_len) - print(f'{"option name":^40}|{"type":^7}|{"desired val":^12}|{"decision":^10}|{"reason":^18}', end='') + print(f'{"option_name":^40}|{"type":^7}|{"desired_val":^12}|{"decision":^10}|{"reason":^18}', end='') if with_results: - print('| check result', end='') + print('| check_result', end='') print() print('=' * sep_line_len) @@ -150,7 +150,7 @@ def print_checklist(mode, checklist, with_results): print(f'[+] Config check is finished: \'OK\' - {ok_count}{ok_suppressed} / \'FAIL\' - {fail_count}{fail_suppressed}') -def parse_kconfig_file(_mode, parsed_options, fname): +def parse_kconfig_file(_mode: StrOrNone, parsed_options: OrderedDict, fname: str) -> None: with _open(fname, 'rt', encoding='utf-8') as f: opt_is_on = re.compile(r"CONFIG_[a-zA-Z0-9_]+=.+$") opt_is_off = re.compile(r"# CONFIG_[a-zA-Z0-9_]+ is not set$") @@ -178,7 +178,7 @@ def parse_kconfig_file(_mode, parsed_options, fname): parsed_options[option] = value -def parse_cmdline_file(mode, parsed_options, fname): +def parse_cmdline_file(mode: StrOrNone, parsed_options: OrderedDict, fname: str) -> None: with open(fname, 'r', encoding='utf-8') as f: line = f.readline() opts = line.split() @@ -199,7 +199,7 @@ def parse_cmdline_file(mode, parsed_options, fname): parsed_options[name] = value -def parse_sysctl_file(mode, parsed_options, fname): +def parse_sysctl_file(mode: StrOrNone, parsed_options: OrderedDict, fname: str) -> None: with open(fname, 'r', encoding='utf-8') as f: sysctl_pattern = re.compile(r"[a-zA-Z0-9/\._-]+ =.*$") for line in f.readlines(): @@ -218,11 +218,11 @@ def parse_sysctl_file(mode, parsed_options, fname): sys.exit(f'[!] ERROR: {fname} doesn\'t look like a sysctl output file, please try `sudo sysctl -a > {fname}`') # let's check the presence of a sysctl option available for root - if 'net.core.bpf_jit_harden' not in parsed_options and mode != 'json': - print(f'[!] WARNING: sysctl option "net.core.bpf_jit_harden" available for root is not found in {fname}, please try `sudo sysctl -a > {fname}`') + if 'kernel.cad_pid' not in parsed_options and mode != 'json': + print(f'[!] WARNING: sysctl option "kernel.cad_pid" available for root is not found in {fname}, please try `sudo sysctl -a > {fname}`') -def main(): +def main() -> None: # Report modes: # * verbose mode for # - reporting about unknown kernel options in the Kconfig @@ -255,7 +255,7 @@ def main(): if mode != 'json': print(f'[+] Special report mode: {mode}') - config_checklist = [] + config_checklist = [] # type: List if args.config: if args.print: @@ -285,7 +285,7 @@ def main(): print('[!] Hint: provide the kernel version file through --kernel-version option') sys.exit(f'[!] ERROR: {msg}') if mode != 'json': - print(f'[+] Detected kernel version: {kernel_version[0]}.{kernel_version[1]}') + print(f'[+] Detected kernel version: {kernel_version}') compiler, msg = detect_compiler(args.config) if mode != 'json': @@ -306,7 +306,7 @@ def main(): add_sysctl_checks(config_checklist, arch) # populate the checklist with the parsed Kconfig data - parsed_kconfig_options = OrderedDict() + parsed_kconfig_options = OrderedDict() # type: OrderedDict parse_kconfig_file(mode, parsed_kconfig_options, args.config) populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig') @@ -315,13 +315,13 @@ def main(): if args.cmdline: # populate the checklist with the parsed cmdline data - parsed_cmdline_options = OrderedDict() + parsed_cmdline_options = OrderedDict() # type: OrderedDict parse_cmdline_file(mode, parsed_cmdline_options, args.cmdline) populate_with_data(config_checklist, parsed_cmdline_options, 'cmdline') if args.sysctl: # populate the checklist with the parsed sysctl data - parsed_sysctl_options = OrderedDict() + parsed_sysctl_options = OrderedDict() # type: OrderedDict parse_sysctl_file(mode, parsed_sysctl_options, args.sysctl) populate_with_data(config_checklist, parsed_sysctl_options, 'sysctl') @@ -331,7 +331,8 @@ def main(): override_expected_value(config_checklist, 'CONFIG_ARCH_MMAP_RND_BITS', mmap_rnd_bits_max) else: # remove the CONFIG_ARCH_MMAP_RND_BITS check to avoid false results - print('[-] Can\'t check CONFIG_ARCH_MMAP_RND_BITS without CONFIG_ARCH_MMAP_RND_BITS_MAX') + if mode != 'json': + print('[-] Can\'t check CONFIG_ARCH_MMAP_RND_BITS without CONFIG_ARCH_MMAP_RND_BITS_MAX') config_checklist[:] = [o for o in config_checklist if o.name != 'CONFIG_ARCH_MMAP_RND_BITS'] # now everything is ready, perform the checks @@ -387,6 +388,7 @@ def main(): if mode and mode not in ('verbose', 'json'): sys.exit(f'[!] ERROR: wrong mode "{mode}" for --print') arch = args.print + assert arch, 'unexpected empty arch from ArgumentParser' add_kconfig_checks(config_checklist, arch) add_cmdline_checks(config_checklist, arch) add_sysctl_checks(config_checklist, arch) @@ -400,6 +402,7 @@ def main(): if mode: sys.exit(f'[!] ERROR: wrong mode "{mode}" for --generate') arch = args.generate + assert arch, 'unexpected empty arch from ArgumentParser' add_kconfig_checks(config_checklist, arch) print(f'CONFIG_{arch}=y') # the Kconfig fragment should describe the microarchitecture for opt in config_checklist: