Skip to content

Commit

Permalink
implementation of arch_mmap_rnd checks
Browse files Browse the repository at this point in the history
  • Loading branch information
d1sgr4c3 committed Oct 26, 2024
1 parent e4896e0 commit ad3a851
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 11 deletions.
36 changes: 25 additions & 11 deletions kernel_hardening_checker/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import re
import json
from .checks import add_kconfig_checks, add_cmdline_checks, normalize_cmdline_options, add_sysctl_checks
from .engine import StrOrNone, TupleOrNone, ChecklistObjType
from .engine import StrOrNone, TupleOrNone, ChecklistObjType, DictOrNone
from .engine import print_unknown_options, populate_with_data, perform_checks, override_expected_value


Expand Down Expand Up @@ -247,6 +247,24 @@ def parse_sysctl_file(mode: StrOrNone, parsed_options: Dict[str, str], fname: st
print(f'[!] WARNING: sysctl options available for root are not found in {fname}, please use the output of `sudo sysctl -a`')


def refine_check(mode: StrOrNone, checklist: List[ChecklistObjType], parsed_options: DictOrNone, target: str, source: str) -> None:
# override target check with source check
if parsed_options is None:
# remove the target check to avoid false results
if mode != 'json':
print(f'[-] Can\'t parse {source}: no config')
checklist[:] = [o for o in checklist if o.name != target]
else:
source_option = parsed_options.get(source, None)
if source_option:
override_expected_value(checklist, target, source)
else:
# remove the target check to avoid false results
if mode != 'json':
print(f'[-] Can\'t check {target} without {source}')
checklist[:] = [o for o in checklist if o.name != target]


def perform_checking(mode: StrOrNone, version: TupleOrNone,
kconfig: StrOrNone, cmdline: StrOrNone, sysctl: StrOrNone) -> None:
config_checklist = [] # type: List[ChecklistObjType]
Expand Down Expand Up @@ -301,16 +319,8 @@ def perform_checking(mode: StrOrNone, version: TupleOrNone,
parsed_kconfig_options = {} # type: Dict[str, str]
parse_kconfig_file(mode, parsed_kconfig_options, kconfig)
populate_with_data(config_checklist, parsed_kconfig_options, 'kconfig')

# hackish refinement of the CONFIG_ARCH_MMAP_RND_BITS check
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']
refine_check(mode, config_checklist, parsed_kconfig_options, 'CONFIG_ARCH_MMAP_RND_BITS', 'CONFIG_ARCH_MMAP_RND_BITS_MAX')
refine_check(mode, config_checklist, parsed_kconfig_options, 'CONFIG_ARCH_MMAP_RND_COMPAT_BITS', 'CONFIG_ARCH_MMAP_RND_COMPAT_BITS_MAX')

if cmdline:
# populate the checklist with the parsed cmdline data
Expand All @@ -323,6 +333,10 @@ def perform_checking(mode: StrOrNone, version: TupleOrNone,
parsed_sysctl_options = {} # type: Dict[str, str]
parse_sysctl_file(mode, parsed_sysctl_options, sysctl)
populate_with_data(config_checklist, parsed_sysctl_options, 'sysctl')
if not kconfig:
parsed_kconfig_options = None
refine_check(mode, config_checklist, parsed_kconfig_options, 'vm.mmap_rnd_bits', 'CONFIG_ARCH_MMAP_RND_BITS_MAX')
refine_check(mode, config_checklist, parsed_kconfig_options, 'vm.mmap_rnd_compat_bits', 'CONFIG_ARCH_MMAP_RND_COMPAT_BITS_MAX')

# now everything is ready, perform the checks
perform_checks(config_checklist)
Expand Down
3 changes: 3 additions & 0 deletions kernel_hardening_checker/checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,7 @@ def add_kconfig_checks(l: List[ChecklistObjType], arch: str) -> None:
l += [KconfigCheck('harden_userspace', 'defconfig', 'VMSPLIT_3G', 'y')]
l += [KconfigCheck('harden_userspace', 'clipos', 'COREDUMP', 'is not set')]
l += [KconfigCheck('harden_userspace', 'a13xp0p0v', 'ARCH_MMAP_RND_BITS', 'MAX')] # 'MAX' value is refined using ARCH_MMAP_RND_BITS_MAX
l += [KconfigCheck('harden_userspace', 'a13xp0p0v', 'ARCH_MMAP_RND_COMPAT_BITS', 'MAX')] # 'MAX' value is refined using ARCH_MMAP_RND_COMPAT_BITS_MAX
if arch == 'X86_64':
l += [KconfigCheck('harden_userspace', 'kspp', 'X86_USER_SHADOW_STACK', 'y')]

Expand Down Expand Up @@ -788,3 +789,5 @@ def add_sysctl_checks(l: List[ChecklistObjType], arch: StrOrNone) -> None:
l += [SysctlCheck('harden_userspace', 'kspp', 'fs.suid_dumpable', '0')]
l += [SysctlCheck('harden_userspace', 'kspp', 'kernel.randomize_va_space', '2')]
l += [SysctlCheck('harden_userspace', 'kspp', 'kernel.yama.ptrace_scope', '3')]
l += [SysctlCheck('harden_userspace', 'a13xp0p0v', 'vm.mmap_rnd_bits', 'MAX')] # 'MAX' value is refined using ARCH_MMAP_RND_BITS_MAX
l += [SysctlCheck('harden_userspace', 'a13xp0p0v', 'vm.mmap_rnd_compat_bits', 'MAX')] # 'MAX' value is refined using ARCH_MMAP_RND_COMPAT_BITS_MAX
1 change: 1 addition & 0 deletions kernel_hardening_checker/engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
TupleOrNone = Optional[Tuple[int, ...]]
DictOrTuple = Union[Dict[str, str], Tuple[int, ...]]
StrOrBool = Union[str, bool]
DictOrNone = Dict[str, str], None

GREEN_COLOR = '\x1b[32m'
RED_COLOR = '\x1b[31m'
Expand Down

0 comments on commit ad3a851

Please sign in to comment.