vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 01:26:11 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

/data and /tmp standarization

Browse Source
This commit is contained in:
Adam Outler
2025-11-04 22:26:35 +00:00
parent 90a07c61eb
commit 5b871865db
250 changed files with 7462 additions and 4940 deletions
Download Patch File Download Diff File Expand all files Collapse all files

193
server/__main__.py
View File

@@ -1,32 +1,30 @@
#!/usr/bin/env python
#
#-------------------------------------------------------------------------------
# -------------------------------------------------------------------------------
# NetAlertX v2.70 / 2021-02-01
# Open Source Network Guard / WIFI & LAN intrusion detector
# Open Source Network Guard / WIFI & LAN intrusion detector
#
# Back module. Network scanner
#-------------------------------------------------------------------------------
# -------------------------------------------------------------------------------
# Puche 2021 / 2022+ jokob jokob@duck.com GNU GPLv3
#-------------------------------------------------------------------------------
# -------------------------------------------------------------------------------
#===============================================================================
# ===============================================================================
# IMPORTS
#===============================================================================
#from __future__ import print_function
# ===============================================================================
# from __future__ import print_function
import sys
import time
import datetime
import multiprocessing
import subprocess
from pathlib import Path
# Register NetAlertX modules
# Register NetAlertX modules
import conf
from const import *
from logger import mylog
from helper import filePermissions, timeNowTZ, get_setting_value
from logger import mylog
from helper import filePermissions, timeNowTZ
from app_state import updateState
from api import update_api
from scan.session_events import process_scan
@@ -36,13 +34,13 @@ from messaging.reporting import get_notifications
from models.notification_instance import NotificationInstance
from models.user_events_queue_instance import UserEventsQueueInstance
from scan.device_handling import update_devices_names
from workflows.manager import WorkflowManager
from workflows.manager import WorkflowManager
#===============================================================================
#===============================================================================
# ===============================================================================
# ===============================================================================
# MAIN
#===============================================================================
#===============================================================================
# ===============================================================================
# ===============================================================================
"""
main structure of NetAlertX
@@ -62,16 +60,19 @@ main structure of NetAlertX
end loop
"""
def main ():
mylog('none', ['[MAIN] Setting up ...']) # has to be level 'none' as user config not loaded yet
mylog('none', [f'[conf.tz] Setting up ...{conf.tz}'])
def main():
mylog(
"none", ["[MAIN] Setting up ..."]
) # has to be level 'none' as user config not loaded yet
mylog("none", [f"[conf.tz] Setting up ...{conf.tz}"])
# check file permissions and fix if required
filePermissions()
# Header + init app state
updateState("Initializing", None, None, None, 0)
updateState("Initializing", None, None, None, 0)
# Open DB once and keep open
# Opening/closing the DB frequently actually causes more issues
@@ -79,17 +80,17 @@ def main ():
db.open()
sql = db.sql # To-Do replace with the db class
# Init DB
# Init DB
db.initDB()
# Initialize the WorkflowManager
workflow_manager = WorkflowManager(db)
#===============================================================================
# This is the main loop of NetAlertX
#===============================================================================
# ===============================================================================
# This is the main loop of NetAlertX
# ===============================================================================
mylog('debug', '[MAIN] Starting loop')
mylog("debug", "[MAIN] Starting loop")
all_plugins = None
pm = None
@@ -100,80 +101,77 @@ def main ():
# -- SETTINGS BACKWARD COMPATIBILITY END --
while True:
# re-load user configuration and plugins
# re-load user configuration and plugins
pm, all_plugins, imported = importConfigs(pm, db, all_plugins)
# update time started
conf.loop_start_time = timeNowTZ()
loop_start_time = conf.loop_start_time # TODO fix
conf.loop_start_time = timeNowTZ()
loop_start_time = conf.loop_start_time # TODO fix
# Handle plugins executed ONCE
if conf.plugins_once_run == False:
pm.run_plugin_scripts('once')
pm.run_plugin_scripts("once")
conf.plugins_once_run = True
# check if user is waiting for api_update
pm.check_and_run_user_event()
# Update API endpoints
# Update API endpoints
update_api(db, all_plugins, False)
# proceed if 1 minute passed
if conf.last_scan_run + datetime.timedelta(minutes=1) < conf.loop_start_time :
# last time any scan or maintenance/upkeep was run
conf.last_scan_run = loop_start_time
if conf.last_scan_run + datetime.timedelta(minutes=1) < conf.loop_start_time:
# last time any scan or maintenance/upkeep was run
conf.last_scan_run = loop_start_time
# Header
updateState("Process: Start")
updateState("Process: Start")
# Timestamp
startTime = loop_start_time
startTime = startTime.replace (microsecond=0)
startTime = startTime.replace(microsecond=0)
# Check if any plugins need to run on schedule
pm.run_plugin_scripts('schedule')
pm.run_plugin_scripts("schedule")
# determine run/scan type based on passed time
# --------------------------------------------
# Runs plugin scripts which are set to run every time after a scans finished
pm.run_plugin_scripts('always_after_scan')
# Runs plugin scripts which are set to run every time after a scans finished
pm.run_plugin_scripts("always_after_scan")
# process all the scanned data into new devices
processScan = updateState("Check scan").processScan
mylog('debug', [f'[MAIN] processScan: {processScan}'])
if processScan == True:
mylog('debug', "[MAIN] start processing scan results")
mylog("debug", [f"[MAIN] processScan: {processScan}"])
if processScan == True:
mylog("debug", "[MAIN] start processing scan results")
process_scan(db)
updateState("Scan processed", None, None, None, None, False)
# Name resolution
# --------------------------------------------
# run plugins before notification processing (e.g. Plugins to discover device names)
pm.run_plugin_scripts('before_name_updates')
pm.run_plugin_scripts("before_name_updates")
# Resolve devices names
mylog('debug','[Main] Resolve devices names')
update_devices_names(pm)
mylog("debug", "[Main] Resolve devices names")
update_devices_names(pm)
# --------
# Reporting
# Reporting
# Check if new devices found
sql.execute (sql_new_devices)
sql.execute(sql_new_devices)
newDevices = sql.fetchall()
db.commitDB()
# new devices were found
if len(newDevices) > 0:
# run all plugins registered to be run when new devices are found
pm.run_plugin_scripts('on_new_device')
# run all plugins registered to be run when new devices are found
pm.run_plugin_scripts("on_new_device")
# Notification handling
# ----------------------------------------
@@ -182,7 +180,7 @@ def main ():
final_json = get_notifications(db)
# Write the notifications into the DB
notification = NotificationInstance(db)
notification = NotificationInstance(db)
notificationObj = notification.create(final_json, "")
# ------------------------------------------------------------------------------
@@ -195,75 +193,84 @@ def main ():
# (e.g. down-event reporting, delay timers, plugin conditions).
# - A pending flag means “still under evaluation,” not “missed.”
# It will clear automatically once its event is included in a sent alert.
# ------------------------------------------------------------------------------
if notificationObj.HasNotifications:
pm.run_plugin_scripts('on_notification')
# ------------------------------------------------------------------------------
if notificationObj.HasNotifications:
pm.run_plugin_scripts("on_notification")
notification.setAllProcessed()
# Only clear pending email flags and plugins_events once notifications are sent.
notification.clearPendingEmailFlag()
else:
# If there are no notifications to process,
# we still need to clear all plugin events to prevent database growth if
# we still need to clear all plugin events to prevent database growth if
# no notification gateways are configured
notification.clearPluginEvents()
mylog('verbose', ['[Notification] No changes to report'])
mylog("verbose", ["[Notification] No changes to report"])
# Commit SQL
db.commitDB()
mylog('verbose', ['[MAIN] Process: Idle'])
db.commitDB()
mylog("verbose", ["[MAIN] Process: Idle"])
else:
# do something
# do something
# mylog('verbose', ['[MAIN] Waiting to start next loop'])
updateState("Process: Idle")
# WORKFLOWS handling
# WORKFLOWS handling
# ----------------------------------------
# Fetch new unprocessed events
new_events = workflow_manager.get_new_app_events()
mylog('debug', [f'[MAIN] Processing WORKFLOW new_events from get_new_app_events: {len(new_events)}'])
mylog(
"debug",
[
f"[MAIN] Processing WORKFLOW new_events from get_new_app_events: {len(new_events)}"
],
)
# Process each new event and check triggers
if len(new_events) > 0:
updateState("Workflows: Start")
update_api_flag = False
for event in new_events:
mylog('debug', [f'[MAIN] Processing WORKFLOW app event with GUID {event["GUID"]}'])
mylog(
"debug",
[f"[MAIN] Processing WORKFLOW app event with GUID {event['GUID']}"],
)
# proceed to process events
workflow_manager.process_event(event)
workflow_manager.process_event(event)
if workflow_manager.update_api:
# Update API endpoints if needed
update_api_flag = True
# Update API endpoints if needed
update_api_flag = True
if update_api_flag:
if update_api_flag:
update_api(db, all_plugins, True)
updateState("Workflows: End")
# check if devices list needs updating
userUpdatedDevices = UserEventsQueueInstance().has_update_devices()
mylog('debug', [f'[Plugins] Should I update API (userUpdatedDevices): {userUpdatedDevices}'])
mylog(
"debug",
[
f"[Plugins] Should I update API (userUpdatedDevices): {userUpdatedDevices}"
],
)
if userUpdatedDevices:
if userUpdatedDevices:
update_api(db, all_plugins, True, ["devices"], userUpdatedDevices)
update_api(db, all_plugins, True, ["devices"], userUpdatedDevices)
#loop
time.sleep(5) # wait for N seconds
# loop
time.sleep(5) # wait for N seconds
#===============================================================================
# ===============================================================================
# BEGIN
#===============================================================================
if __name__ == '__main__':
mylog('debug', ['[__main__] Welcome to NetAlertX'])
sys.exit(main())
# ===============================================================================
if __name__ == "__main__":
mylog("debug", ["[__main__] Welcome to NetAlertX"])
sys.exit(main())