gbucchino/check_sys
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update report

Browse Source
This commit is contained in:
gbucchino 2023-06-27 11:20:38 +02:00
parent d3ec39c8f1
commit 0cd833db66
5 changed files with 91 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
core/main.py
View File

@ -6,23 +6,42 @@ from core.postfix import Postfix
from core.report import generateHtmlReport from core.report import generateHtmlReport
from core.config import AUDIT_SYSTEM, AUDIT_APPLICATION, generateConfig, parsingConfigFile from core.config import AUDIT_SYSTEM, AUDIT_APPLICATION, generateConfig, parsingConfigFile
from core.dispatcher import Dispatcher from core.dispatcher import Dispatcher
from utils import getHostname, getKernelVersion, identifySystem, getCodeName, getRelease
from os import listdir
from os.path import isdir
def checkArguments(): def checkArguments():
args = ArgumentParser(description="Check Gitlab repositories") args = ArgumentParser(description="Check Gitlab repositories")
args.add_argument('-a', '--audit', help="Kind of audit", choices=['system', 'application']) args.add_argument('-a', '--audit', help="Kind of audit", choices=['system', 'application'])
args.add_argument('-p', '--plugins', help="Get all plugins", choices=['system', 'application'])
args.add_argument('-c', '--config', help="Config file") args.add_argument('-c', '--config', help="Config file")
return args.parse_args() return args.parse_args()
def getAllPlugins(audit):
print(f"List all plugins for {audit}")
path = str()
if audit == "system":
path = "audit/system/plugins/"
else:
path = "audit/applications/"
for directory in listdir(path):
if isdir(f"{path}/{directory}"):
print(directory)
def main(): def main():
args = checkArguments() args = checkArguments()
if args.plugins is not None:
getAllPlugins(args.plugins)
exit(0)
# If audit is not specified # If audit is not specified
if args.audit is None: if args.audit is None:
print("Please, you must specify the audit type") print("Please, you must specify the audit type")
exit(1) exit(1)
# If config file is specified # If config file is specified
configs = generateConfig() configs = generateConfig()
if args.config is not None: if args.config is not None:
@ -32,19 +51,29 @@ def main():
report = dict() report = dict()
report['system'] = dict() report['system'] = dict()
# Get the hostname of the VM
report['hostname'] = getHostname()
# Get system informations
report['kernel'] = getKernelVersion()
report['release'] = f"{identifySystem()} {getRelease()} ({getCodeName()}) "
# Create our dispatcher # Create our dispatcher
dispatcher = Dispatcher() dispatcher = Dispatcher()
print(configs) #print(configs)
if args.audit == "system": if args.audit == "system":
print("Auditing the system...")
for audit in AUDIT_SYSTEM: for audit in AUDIT_SYSTEM:
if audit not in configs["system"]["exclude_plugins"]: if audit not in configs["system"]["exclude_plugins"]:
report["system"][audit] = dispatcher.runPlugin(audit, configs["system"][audit]) report["system"][audit] = dispatcher.runPlugin(audit, configs["system"][audit])
if args.audit == "application": if args.audit == "application":
print("Auditing the application...")
pass pass
print("End of the audit. Generating the report")
generateHtmlReport(report) generateHtmlReport(report)
@Dispatcher.register_plugins @Dispatcher.register_plugins

44
core/report.py
View File

@ -6,9 +6,6 @@ import jinja2
def generateHtmlReport(data): def generateHtmlReport(data):
today = datetime.now().isoformat()[0:10].replace("-", "_") today = datetime.now().isoformat()[0:10].replace("-", "_")
html = _getHeader()
html += "<body>" \
f"<h1>Reports of {today}</h1>"
dataJinja2 = dict() dataJinja2 = dict()
dataJinja2['title'] = 'Report check system' dataJinja2['title'] = 'Report check system'
dataJinja2['plugins'] = list() dataJinja2['plugins'] = list()
@ -23,7 +20,7 @@ def generateHtmlReport(data):
body = str() body = str()
for plugin in data['system']: for plugin in data['system']:
print(plugin) #print(plugin)
dataJinja2['plugins'].append(f"{plugin}.html.j2") dataJinja2['plugins'].append(f"{plugin}.html.j2")
if 'postfix' in dataJinja2['plugins']: if 'postfix' in dataJinja2['plugins']:
@ -40,44 +37,15 @@ def generateHtmlReport(data):
for sysctl in dataJinja2['sysctl']['file']['sysctl']: for sysctl in dataJinja2['sysctl']['file']['sysctl']:
dataJinja2['sysctl']['file']['sysctl'][sysctl]['accordion-id'] = f"accordion-{index}" dataJinja2['sysctl']['file']['sysctl'][sysctl]['accordion-id'] = f"accordion-{index}"
index += 1 index += 1
#print(data['system']['sysctl']['file'][sysctl])
#for entry in data['system']['sysctl']['file']['sysctl']:
# print(entry)
# print(data['system']['sysctl']['file']['sysctl'][entry])
#print(dataJinja2)
dataJinja2['year'] = '2023' dataJinja2['year'] = '2023'
dataJinja2['hostname'] = data['hostname']
dataJinja2['kernel'] = data['kernel']
dataJinja2['release'] = data['release']
rdr = tmplIndex.render(data=dataJinja2) rdr = tmplIndex.render(data=dataJinja2)
# For sysctl
#for entry in data['sysctl']:
# body += f"<h2>Sysctl</h2>"
# # For file
# body += f"<h3>File</h3>"
#for f in data['sysctl']['file']:
# body += f"<h4>{data['sysctl']['file']['filename']}</h4>"
# for vul in data['sysctl']['file']['sysctl']:
# #print(data['sysctl']['file']['sysctl'][vul])
# body += f"<h5>{vul}</h5>"
# body += f"<p>"
# body += f"Results:<br />"
#for result in data['sysctl']['file']['sysctl'][vul]:
# print(result)
# body += f"Line: {result['lineNumber']}<br />"
# body += f"Line: {result['line']}<br />"
# body += f"Level: {result['level']}<br />"
# body += f"Description: {result['description']}<br /><br />"
#body += f"</p>"
#print(body)
with open(f"reports/reports_{today}.html", "w") as f: with open(f"reports/reports_{today}.html", "w") as f:
f.write(rdr) f.write(rdr)
def _getHeader() -> str: print("The report is generated at this location: " \
header = "<!doctype html>" \ f"reports/reports_{today}.html")
"<html>" \
"<head>" \
"</head>" \
return header

5
reports/templates/index.html.j2
View File

@ -22,7 +22,10 @@
<div class="p-5 mb-4 bg-body-tertiary rounded-3"> <div class="p-5 mb-4 bg-body-tertiary rounded-3">
<div class="container-fluid py-5"> <div class="container-fluid py-5">
<h1 class="display-5 fw-bold">Report</h1> <h1 class="display-5 fw-bold">Report</h1>
<p class="col-md-8 fs-4">Report of the day... blablabla</p> <p class="col-md-8 fs-4">
Audit of the system {{ data['hostname'] }} ({{ data['release'] }}).<br />
Kernel version: {{ data['kernel'] }}<br />
</p>
</div> </div>
</div> </div>

21
reports/templates/sysctl.html.j2
View File

@ -4,13 +4,26 @@
<div class="accordion" id="accordionSysctl"> <div class="accordion" id="accordionSysctl">
<div class="accordion-item"> <div class="accordion-item">
<h2 class="accordion-header"> <h2 class="accordion-header">
<button class="accordion-button" type="button" data-bs-toggle="collapse" data-bs-target="#{{ data['sysctl']['file']['sysctl'][item]['accordion-id'] }}" aria-expanded="true" aria-controls="{{ data['sysctl']['file']['sysctl'][item]['accordion-id'] }}"> <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#{{ data['sysctl']['file']['sysctl'][item]['accordion-id'] }}" aria-expanded="true" aria-controls="{{ data['sysctl']['file']['sysctl'][item]['accordion-id'] }}">
<strong>{{ item }}</strong> <span class="text-bg-danger p-1" style="padding-left:10pt;padding-right:10pt;margin-left:15pt;">{{ data['sysctl']['file']['sysctl'][item]['result']['result'] }}</span> <strong>{{ item }}</strong>
{% if data['sysctl']['file']['sysctl'][item]['result']['result'] == 'failed' %}
<span class="text-bg-danger p-1" style="padding-left:10pt;padding-right:10pt;margin-left:15pt;">{{ data['sysctl']['file']['sysctl'][item]['result']['result'] }}</span>
{% elif data['sysctl']['file']['sysctl'][item]['result']['result'] == 'success' %}
<span class="text-bg-success p-1" style="padding-left:10pt;padding-right:10pt;margin-left:15pt;">{{ data['sysctl']['file']['sysctl'][item]['result']['result'] }}</span>
{% endif %}
</button> </button>
</h2> </h2>
<div id="{{ data['sysctl']['file']['sysctl'][item]['accordion-id'] }}" class="accordion-collapse collapse show" data-bs-parent="#accordionSysctl"> <div id="{{ data['sysctl']['file']['sysctl'][item]['accordion-id'] }}" class="accordion-collapse collapse" data-bs-parent="#accordionSysctl">
<div class="accordion-body"> <div class="accordion-body">
{{ data['sysctl']['file']['sysctl'][item]['description'] }} {{ data['sysctl']['file']['sysctl'][item]['description'] }}. <br />
For resolving the issue, add this line in the <strong>{{ data['sysctl']['file']['filename'] }}</strong> file:
<div class="bd-example-snippet bd-code-snippet">
<div class="highlight">
<pre tabindex="0" class="chroma"><code class="language-shell">
{{ data['sysctl']['file']['sysctl'][item]['flag'] }} = {{ data['sysctl']['file']['sysctl'][item]['value'] }}
</pre></code>
</div>
</div>
</div> </div>
</div> </div>
</div> </div>

48
utils.py
View File

@ -2,6 +2,7 @@
import re import re
from subprocess import run from subprocess import run
from socket import gethostname
class ConfigError(Exception): class ConfigError(Exception):
@ -13,23 +14,40 @@ class ConfigError(Exception):
super().__init__(self.message) super().__init__(self.message)
def identifySystem(): def identifySystem():
os = None #os = None
with open('/etc/issue', 'r') as f: #with open('/etc/issue', 'r') as f:
line = f.readline() # line = f.readline()
if re.search('Arch Linux', line): # if re.search('Arch Linux', line):
os = 'ARCHLINUX' # os = 'ARCHLINUX'
elif re.search('Ubuntu', line): # elif re.search('Ubuntu', line):
os = 'UBUNTU' # os = 'UBUNTU'
elif re.search('Debian', line): # elif re.search('Debian', line):
os = 'DEBIAN' # os = 'DEBIAN'
else: # else:
os = 'UNKNOWN' # os = 'UNKNOWN'
kernelVers = run(['/usr/bin/lsb_release', '-is'], capture_output=True)
return os return kernelVers.stdout.decode('utf-8')
def getKernelVersion(): def getKernelVersion():
""" """
This function get the kernel version Linux This function get the kernel version Linux
""" """
kernelVers = run(['/usr/bin/uname', '-r']) kernelVers = run(['/usr/bin/uname', '-r'], capture_output=True)
return kernelVers.stdout return kernelVers.stdout.decode('utf-8')
def getCodeName():
"""
This function get the code name of the system
"""
kernelVers = run(['/usr/bin/lsb_release', '-cs'], capture_output=True)
return kernelVers.stdout.decode('utf-8')
def getRelease():
"""
This function get the release name of the system
"""
kernelVers = run(['/usr/bin/lsb_release', '-rs'], capture_output=True)
return kernelVers.stdout.decode('utf-8')
def getHostname():
return gethostname()