From 798f7d4570224f03e21cceea10d5b6b3c5260da1 Mon Sep 17 00:00:00 2001 From: Alexander Popov Date: Sun, 26 Feb 2023 23:05:44 +0300 Subject: [PATCH] Add docstrings for the modules --- kconfig_hardened_check/__about__.py | 4 ++++ kconfig_hardened_check/__init__.py | 17 ++++++++++------- kconfig_hardened_check/checks.py | 10 ++++++++++ kconfig_hardened_check/engine.py | 10 ++++++++++ 4 files changed, 34 insertions(+), 7 deletions(-) diff --git a/kconfig_hardened_check/__about__.py b/kconfig_hardened_check/__about__.py index 8411e55..f573417 100644 --- a/kconfig_hardened_check/__about__.py +++ b/kconfig_hardened_check/__about__.py @@ -1 +1,5 @@ +""" +Version +""" + __version__ = '0.6.1' diff --git a/kconfig_hardened_check/__init__.py b/kconfig_hardened_check/__init__.py index f6e0305..ed4746b 100644 --- a/kconfig_hardened_check/__init__.py +++ b/kconfig_hardened_check/__init__.py @@ -1,15 +1,18 @@ #!/usr/bin/python3 -# This tool helps me to check Linux kernel options against -# my security hardening preferences for X86_64, ARM64, X86_32, and ARM. -# Let the computers do their job! -# -# Author: Alexander Popov -# -# Please don't cry if my Python code looks like C. # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements +""" +This tool helps me to check Linux kernel options against +my security hardening preferences for X86_64, ARM64, X86_32, and ARM. +Let the computers do their job! + +Author: Alexander Popov + +This module performs input/output. +""" + import sys from argparse import ArgumentParser diff --git a/kconfig_hardened_check/checks.py b/kconfig_hardened_check/checks.py index 5b917bf..8942124 100644 --- a/kconfig_hardened_check/checks.py +++ b/kconfig_hardened_check/checks.py @@ -1,5 +1,15 @@ #!/usr/bin/python3 +""" +This tool helps me to check Linux kernel options against +my security hardening preferences for X86_64, ARM64, X86_32, and ARM. +Let the computers do their job! + +Author: Alexander Popov + +This module contains knowledge for checks. +""" + # N.B. Hardening sysctls: # kernel.kptr_restrict=2 (or 1?) # kernel.dmesg_restrict=1 (also see the kconfig option) diff --git a/kconfig_hardened_check/engine.py b/kconfig_hardened_check/engine.py index b458d29..82f95c6 100644 --- a/kconfig_hardened_check/engine.py +++ b/kconfig_hardened_check/engine.py @@ -1,5 +1,15 @@ #!/usr/bin/python3 +""" +This tool helps me to check Linux kernel options against +my security hardening preferences for X86_64, ARM64, X86_32, and ARM. +Let the computers do their job! + +Author: Alexander Popov + +This module is the engine of checks. +""" + # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements -- 2.31.1