projects
/
kconfig-hardened-check.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
328a89c
)
Add docstrings for the modules
author
Alexander Popov
<alex.popov@linux.com>
Sun, 26 Feb 2023 20:05:44 +0000
(23:05 +0300)
committer
Alexander Popov
<alex.popov@linux.com>
Sun, 26 Feb 2023 20:11:15 +0000
(23:11 +0300)
kconfig_hardened_check/__about__.py
patch
|
blob
|
history
kconfig_hardened_check/__init__.py
patch
|
blob
|
history
kconfig_hardened_check/checks.py
patch
|
blob
|
history
kconfig_hardened_check/engine.py
patch
|
blob
|
history
diff --git
a/kconfig_hardened_check/__about__.py
b/kconfig_hardened_check/__about__.py
index 8411e551d5d59687dba6ad3a45721ad67ada5567..f573417a377242b5d7e1ece369ee92f047e72a4b 100644
(file)
--- a/
kconfig_hardened_check/__about__.py
+++ b/
kconfig_hardened_check/__about__.py
@@
-1
+1,5
@@
+"""
+Version
+"""
+
__version__ = '0.6.1'
__version__ = '0.6.1'
diff --git
a/kconfig_hardened_check/__init__.py
b/kconfig_hardened_check/__init__.py
index f6e0305d237620762e06295ee7c88a056694d588..ed4746bef61773a3c656de07643f971ae3936740 100644
(file)
--- a/
kconfig_hardened_check/__init__.py
+++ b/
kconfig_hardened_check/__init__.py
@@
-1,15
+1,18
@@
#!/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=line-too-long,invalid-name,too-many-branches,too-many-statements
# 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 <alex.popov@linux.com>
+
+This module performs input/output.
+"""
+
import sys
from argparse import ArgumentParser
import sys
from argparse import ArgumentParser
diff --git
a/kconfig_hardened_check/checks.py
b/kconfig_hardened_check/checks.py
index 5b917bfbfd41d5cc0f8dc781df6f512c0de51ea6..8942124ef64a7aeb7dca0aac9ccfab321df054b3 100644
(file)
--- a/
kconfig_hardened_check/checks.py
+++ b/
kconfig_hardened_check/checks.py
@@
-1,5
+1,15
@@
#!/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:
# kernel.kptr_restrict=2 (or 1?)
# kernel.dmesg_restrict=1 (also see the kconfig option)
# 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 b458d29ac35870196d6e2ead615d98fe2f473a08..82f95c60e4f9561b8fbf198bf46adbc2b572316f 100644
(file)
--- a/
kconfig_hardened_check/engine.py
+++ b/
kconfig_hardened_check/engine.py
@@
-1,5
+1,15
@@
#!/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=line-too-long,invalid-name,too-many-branches,too-many-statements
# pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
# pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements