X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=kernel_hardening_checker%2F__init__.py;h=858341a05c8ebfea894775f08fc3ef1cb2a2e9e9;hb=3224016c39c28c0797b63957599e01453a832e66;hp=87f438e28d1eb5089a154d74f3faa8dff43a8ffd;hpb=5f9e0ea2c7e08888404f8a00d5d26456d6f37711;p=kconfig-hardened-check.git diff --git a/kernel_hardening_checker/__init__.py b/kernel_hardening_checker/__init__.py index 87f438e..858341a 100644 --- a/kernel_hardening_checker/__init__.py +++ b/kernel_hardening_checker/__init__.py @@ -23,7 +23,7 @@ from .engine import populate_with_data, perform_checks, override_expected_value def _open(file: str, *args, **kwargs): open_method = open - if file.endswith(".gz"): + if file.endswith('.gz'): open_method = gzip.open return open_method(file, *args, **kwargs) @@ -31,7 +31,7 @@ def _open(file: str, *args, **kwargs): def detect_arch(fname, archs): with _open(fname, 'rt', encoding='utf-8') as f: - arch_pattern = re.compile("CONFIG_[a-zA-Z0-9_]+=y$") + arch_pattern = re.compile(r"CONFIG_[a-zA-Z0-9_]+=y$") arch = None for line in f.readlines(): if arch_pattern.match(line): @@ -48,17 +48,18 @@ def detect_arch(fname, archs): def detect_kernel_version(fname): with _open(fname, 'rt', encoding='utf-8') as f: - ver_pattern = re.compile("# Linux/.+ Kernel Configuration$") + 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)), None + msg = f'failed to parse the version "{parts[2]}"' + return None, msg return None, 'no kernel version detected' @@ -74,13 +75,13 @@ def detect_compiler(fname): if gcc_version is None or clang_version is None: return None, 'no CONFIG_GCC_VERSION or CONFIG_CLANG_VERSION' if gcc_version == '0' and clang_version != '0': - return 'CLANG ' + clang_version, 'OK' + return f'CLANG {clang_version}', 'OK' if gcc_version != '0' and clang_version == '0': - return 'GCC ' + gcc_version, 'OK' + return f'GCC {gcc_version}', 'OK' sys.exit(f'[!] ERROR: invalid GCC_VERSION and CLANG_VERSION: {gcc_version} {clang_version}') -def print_unknown_options(checklist, parsed_options): +def print_unknown_options(checklist, parsed_options, opt_type): known_options = [] for o1 in checklist: @@ -100,7 +101,7 @@ def print_unknown_options(checklist, parsed_options): for option, value in parsed_options.items(): if option not in known_options: - print(f'[?] No check for option {option} ({value})') + print(f'[?] No check for {opt_type} option {option} ({value})') def print_checklist(mode, checklist, with_results): @@ -116,9 +117,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,10 +151,10 @@ 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, parsed_options, fname): with _open(fname, 'rt', encoding='utf-8') as f: - opt_is_on = re.compile("CONFIG_[a-zA-Z0-9_]+=.+$") - opt_is_off = re.compile("# CONFIG_[a-zA-Z0-9_]+ is not set$") + 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$") for line in f.readlines(): line = line.strip() @@ -201,7 +202,7 @@ def parse_cmdline_file(mode, parsed_options, fname): def parse_sysctl_file(mode, parsed_options, fname): with open(fname, 'r', encoding='utf-8') as f: - sysctl_pattern = re.compile("[a-zA-Z0-9/\._-]+ =.*$") + sysctl_pattern = re.compile(r"[a-zA-Z0-9/\._-]+ =.*$") for line in f.readlines(): line = line.strip() if not sysctl_pattern.match(line): @@ -232,7 +233,7 @@ def main(): supported_archs = ['X86_64', 'X86_32', 'ARM64', 'ARM'] parser = ArgumentParser(prog='kernel-hardening-checker', description='A tool for checking the security hardening options of the Linux kernel') - parser.add_argument('--version', action='version', version='%(prog)s ' + __version__) + parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}') parser.add_argument('-m', '--mode', choices=report_modes, help='choose the report mode') parser.add_argument('-c', '--config', @@ -241,6 +242,8 @@ def main(): help='check the security hardening options in the kernel cmdline file (contents of /proc/cmdline)') parser.add_argument('-s', '--sysctl', help='check the security hardening options in the sysctl output file (`sudo sysctl -a > file`)') + parser.add_argument('-v', '--kernel-version', + help='extract the version from the kernel version file (contents of /proc/version)') parser.add_argument('-p', '--print', choices=supported_archs, help='print the security hardening recommendations for the selected microarchitecture') parser.add_argument('-g', '--generate', choices=supported_archs, @@ -274,11 +277,16 @@ def main(): if mode != 'json': print(f'[+] Detected microarchitecture: {arch}') - kernel_version, msg = detect_kernel_version(args.config) + if args.kernel_version: + kernel_version, msg = detect_kernel_version(args.kernel_version) + else: + kernel_version, msg = detect_kernel_version(args.config) if kernel_version is None: + if args.kernel_version is None: + 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': @@ -322,18 +330,22 @@ def main(): mmap_rnd_bits_max = parsed_kconfig_options.get('CONFIG_ARCH_MMAP_RND_BITS_MAX', None) if mmap_rnd_bits_max: 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 + 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 perform_checks(config_checklist) if mode == 'verbose': # print the parsed options without the checks (for debugging) - all_parsed_options = parsed_kconfig_options # assignment does not copy + print_unknown_options(config_checklist, parsed_kconfig_options, 'kconfig') if args.cmdline: - all_parsed_options.update(parsed_cmdline_options) + print_unknown_options(config_checklist, parsed_cmdline_options, 'cmdline') if args.sysctl: - all_parsed_options.update(parsed_sysctl_options) - print_unknown_options(config_checklist, all_parsed_options) + print_unknown_options(config_checklist, parsed_sysctl_options, 'sysctl') # finally print the results print_checklist(mode, config_checklist, True) @@ -364,7 +376,7 @@ def main(): if mode == 'verbose': # print the parsed options without the checks (for debugging) - print_unknown_options(config_checklist, parsed_sysctl_options) + print_unknown_options(config_checklist, parsed_sysctl_options, 'sysctl') # finally print the results print_checklist(mode, config_checklist, True) @@ -395,6 +407,8 @@ def main(): for opt in config_checklist: if opt.name == 'CONFIG_ARCH_MMAP_RND_BITS': continue # don't add CONFIG_ARCH_MMAP_RND_BITS because its value needs refinement + if opt.expected == 'is not off': + continue # don't add Kconfig options without explicitly recommended values if opt.expected == 'is not set': print(f'# {opt.name} is not set') else: