Commit 798f7d45 by Alexander Popov

Add docstrings for the modules

parent 328a89c7
"""
Version
"""
__version__ = '0.6.1' __version__ = '0.6.1'
#!/usr/bin/python3 #!/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 <alex.popov@linux.com>
#
# Please don't cry if my Python code looks like C.
# pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
# pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements # 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 <alex.popov@linux.com>
This module performs input/output.
"""
import sys import sys
from argparse import ArgumentParser from argparse import ArgumentParser
......
#!/usr/bin/python3 #!/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 <alex.popov@linux.com>
This module contains knowledge for checks.
"""
# N.B. Hardening sysctls: # N.B. Hardening sysctls:
# kernel.kptr_restrict=2 (or 1?) # kernel.kptr_restrict=2 (or 1?)
# kernel.dmesg_restrict=1 (also see the kconfig option) # kernel.dmesg_restrict=1 (also see the kconfig option)
......
#!/usr/bin/python3 #!/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 <alex.popov@linux.com>
This module is the engine of checks.
"""
# pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
# pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements # pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment