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

Plugins 0.2 - Fixed issues detecting changes + added UserData column

Browse Source
This commit is contained in:
Jokob-sk
2023-02-18 15:14:31 +11:00
parent b0ce1b87a9
commit 86315a245b
3 changed files with 102 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

149
back/pialert.py
View File

@@ -3153,13 +3153,15 @@ def upgradeDB ():
Plugin TEXT NOT NULL, Plugin TEXT NOT NULL,
Object_PrimaryID TEXT NOT NULL, Object_PrimaryID TEXT NOT NULL,
Object_SecondaryID TEXT NOT NULL, Object_SecondaryID TEXT NOT NULL,
DateTime TEXT NOT NULL, DateTimeCreated TEXT NOT NULL,
DateTimeChanged TEXT NOT NULL,
Watched_Value1 TEXT NOT NULL, Watched_Value1 TEXT NOT NULL,
Watched_Value2 TEXT NOT NULL, Watched_Value2 TEXT NOT NULL,
Watched_Value3 TEXT NOT NULL, Watched_Value3 TEXT NOT NULL,
Watched_Value4 TEXT NOT NULL, Watched_Value4 TEXT NOT NULL,
Status TEXT NOT NULL, Status TEXT NOT NULL,
Extra TEXT NOT NULL, Extra TEXT NOT NULL,
UserData TEXT NOT NULL,
PRIMARY KEY("Index" AUTOINCREMENT) PRIMARY KEY("Index" AUTOINCREMENT)
); """ ); """
sql.execute(sql_Plugins_Objects) sql.execute(sql_Plugins_Objects)
@@ -3170,13 +3172,15 @@ def upgradeDB ():
Plugin TEXT NOT NULL, Plugin TEXT NOT NULL,
Object_PrimaryID TEXT NOT NULL, Object_PrimaryID TEXT NOT NULL,
Object_SecondaryID TEXT NOT NULL, Object_SecondaryID TEXT NOT NULL,
DateTime TEXT NOT NULL, DateTimeCreated TEXT NOT NULL,
DateTimeChanged TEXT NOT NULL,
Watched_Value1 TEXT NOT NULL, Watched_Value1 TEXT NOT NULL,
Watched_Value2 TEXT NOT NULL, Watched_Value2 TEXT NOT NULL,
Watched_Value3 TEXT NOT NULL, Watched_Value3 TEXT NOT NULL,
Watched_Value4 TEXT NOT NULL, Watched_Value4 TEXT NOT NULL,
Status TEXT NOT NULL, Status TEXT NOT NULL,
Extra TEXT NOT NULL, Extra TEXT NOT NULL,
UserData TEXT NOT NULL,
PRIMARY KEY("Index" AUTOINCREMENT) PRIMARY KEY("Index" AUTOINCREMENT)
); """ ); """
sql.execute(sql_Plugins_Events) sql.execute(sql_Plugins_Events)
@@ -3791,12 +3795,12 @@ def execute_plugin(plugin):
columns = line.split("|") columns = line.split("|")
# There has to be always 8 columns # There has to be always 8 columns
if len(columns) == 8: if len(columns) == 8:
sqlParams.append((plugin["unique_prefix"], columns[0], columns[1], columns[2], columns[3], columns[4], columns[5], columns[6], 0, columns[7])) sqlParams.append((plugin["unique_prefix"], columns[0], columns[1], 'null', columns[2], columns[3], columns[4], columns[5], columns[6], 0, columns[7], 'null'))
else: else:
mylog('none', [' [Plugins]: Skipped invalid line in the output: ', line]) mylog('none', [' [Plugins]: Skipped invalid line in the output: ', line])
if len(sqlParams) > 0: if len(sqlParams) > 0:
sql.executemany ("""INSERT INTO Plugins_Events ("Plugin", "Object_PrimaryID", "Object_SecondaryID", "DateTime", "Watched_Value1", "Watched_Value2", "Watched_Value3", "Watched_Value4", "Status" ,"Extra") VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)""", sqlParams) sql.executemany ("""INSERT INTO Plugins_Events ("Plugin", "Object_PrimaryID", "Object_SecondaryID", "DateTimeCreated", "DateTimeChanged", "Watched_Value1", "Watched_Value2", "Watched_Value3", "Watched_Value4", "Status" ,"Extra", "UserData") VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)""", sqlParams)
commitDB () commitDB ()
process_plugin_events(plugin) process_plugin_events(plugin)
@@ -3815,87 +3819,102 @@ def process_plugin_events(plugin):
plugEventsArr = get_sql_array ("SELECT * FROM Plugins_Events where Plugin = '" + str(pluginPref)+"'") plugEventsArr = get_sql_array ("SELECT * FROM Plugins_Events where Plugin = '" + str(pluginPref)+"'")
pluginObjects = [] pluginObjects = []
pluginEvents = []
for obj in plugObjectsArr: for obj in plugObjectsArr:
pluginObjects.append(plugin_object_class(plugin, obj)) pluginObjects.append(plugin_object_class(plugin, obj))
mylog('debug', [' [Plugins] Existing objects: ', len(pluginObjects)]) existingPluginObjectsCount = len(pluginObjects)
existingPluginObjects = len(pluginObjects) mylog('debug', [' [Plugins] Existing objects: ', existingPluginObjectsCount])
# set status as new - will be changed later if conditions are fulfilled, e.g. entry found
for eve in plugEventsArr:
tmpObject = plugin_object_class(plugin, eve)
tmpObject.status = "new"
pluginEvents.append(tmpObject)
# Collect new entries # Update the status to "exists"
index = 0 index = 0
for eve in plugEventsArr: for tmpObjFromEvent in pluginEvents:
tmpObject = plugin_object_class(plugin, eve)
# compare hash of the IDs for uniqueness # compare hash of the IDs for uniqueness
if any(x.idsHash != tmpObject.idsHash for x in pluginObjects): if any(x.idsHash == tmpObject.idsHash for x in pluginObjects):
mylog('debug', [' [Plugins] Collecting a new object']) mylog('debug', [' [Plugins] Found existing object'])
tmpObject.status = "new" pluginEvents[index].status = "exists"
pluginObjects.append(tmpObject)
plugEventsArr.pop(index) # remove processed entry # plugEventsArr.pop(index) # remove processed entry
index += 1 index += 1
# mylog('debug', [' [Plugins] New objects: ', index]) # Loop thru events and update the one that exist to determine if watched columns changed
# Collect entries with changed watched columns
index = 0 index = 0
for eve in plugEventsArr: for tmpObjFromEvent in pluginEvents:
tmpObject = plugin_object_class(plugin, eve) if tmpObjFromEvent.status == "exists":
# compare hash of the changed watched columns for uniqueness # compare hash of the changed watched columns for uniqueness
if any(x.watchedHash != tmpObject.watchedHash for x in pluginObjects): if any(x.watchedHash != tmpObject.watchedHash for x in pluginObjects):
tmpObject.status = "watched-changed" pluginEvents[index].status = "watched-changed"
pluginObjects.append(tmpObject)
plugEventsArr.pop(index) # remove processed entry # plugEventsArr.pop(index) # remove processed entry
else:
pluginEvents[index].status = "watched-not-changed"
index += 1 index += 1
# mylog('debug', [' [Plugins] Objects with changed watched columns: ', index])
# Collect remaining events
for eve in plugEventsArr:
tmpObject = plugin_object_class(plugin, eve) # Merge existing plugin objects with newly discovered ones and update existin ones with new values
for eveObj in pluginEvents:
if eveObj.status == 'new':
pluginObjects.append(eveObj)
else:
index = 0
for plugObj in pluginObjects:
# find corresponding object for the event and merge
if plugObj.idsHash == eveObj.idsHash:
pluginObjects[index] = combine_plugin_objects(plugObj, eveObj)
tmpObject.status = "watched-not-changed" index += 1
pluginObjects.append(tmpObject)
# Update the DB # Update the DB
for plugObj in pluginObjects: # ----------------------------
# Create new objects if detected
mylog('debug', [' [Plugins] Object latest status: ', plugObj.status]) # Update the Plugin_Objects
sql.execute ("DELETE FROM Plugins_Objects")
for plugObj in pluginObjects:
createdTime = plugObj.created
if plugObj.status == 'new': if plugObj.status == 'new':
createdTime = plugObj.changed
sql.execute ("INSERT INTO Plugins_Objects (Plugin, Object_PrimaryID, Object_SecondaryID, DateTime, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status, Extra) VALUES (?,?,?,?,?,?,?,?,?,?)", (plugObj.pluginPref, plugObj.primaryId , plugObj.secondaryId , plugObj.dateTime , plugObj.watched1 , plugObj.watched2 , plugObj.watched3 , plugObj.watched4 , plugObj.status , plugObj.extra )) sql.execute ("INSERT INTO Plugins_Objects (Plugin, Object_PrimaryID, Object_SecondaryID, DateTimeCreated, DateTimeChanged, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status, Extra, UserData) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)", (plugObj.pluginPref, plugObj.primaryId , plugObj.secondaryId , createdTime, plugObj.changed , plugObj.watched1 , plugObj.watched2 , plugObj.watched3 , plugObj.watched4 , plugObj.status , plugObj.extra, plugObj.userData ))
commitDB()
if plugObj.status == 'watched-not-changed' and existingPluginObjects == 0: # Update the Plugins_Events with the new statuses
sql.execute ("DELETE FROM Plugins_Events")
sql.execute ("INSERT INTO Plugins_Objects (Plugin, Object_PrimaryID, Object_SecondaryID, DateTime, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status, Extra) VALUES (?,?,?,?,?,?,?,?,?,?)", (plugObj.pluginPref, plugObj.primaryId , plugObj.secondaryId , plugObj.dateTime , plugObj.watched1 , plugObj.watched2 , plugObj.watched3 , plugObj.watched4 , plugObj.status , plugObj.extra )) for plugObj in pluginEvents:
commitDB()
if plugObj.status == "watched-changed": createdTime = plugObj.created
sql.execute ("UPDATE Plugins_Objects (Plugin, Object_PrimaryID, Object_SecondaryID, DateTime, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status, Extra) VALUES (?,?,?,?,?,?,?,?,?,?) WHERE Object_PrimaryID = '" +str(plugObj.primaryId)+"' and Object_SecondaryID = '" +str(plugObj.secondaryId)+"'", (plugObj.pluginPref, plugObj.primaryId , plugObj.secondaryId , plugObj.dateTime , plugObj.watched1 , plugObj.watched2 , plugObj.watched3 , plugObj.watched4 , plugObj.status , plugObj.extra )) if plugObj.status == 'new':
createdTime = plugObj.changed
commitDB()
sql.execute ("INSERT INTO Plugins_Events (Plugin, Object_PrimaryID, Object_SecondaryID, DateTimeCreated, DateTimeChanged, Watched_Value1, Watched_Value2, Watched_Value3, Watched_Value4, Status, Extra, UserData) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)", (plugObj.pluginPref, plugObj.primaryId , plugObj.secondaryId , createdTime, plugObj.changed , plugObj.watched1 , plugObj.watched2 , plugObj.watched3 , plugObj.watched4 , plugObj.status , plugObj.extra, plugObj.userData ))
commitDB()
# TODO HERE test on empty DB as well # TODO HERE test on empty DB as well
# collect notifications here as well? # collect notifications here as well?
# deleye the events here or later? probably later - on notification fail # delete the events here or later? probably later - on notification fail
# so the events can be reanalyzed and notification re-send # so the events can be reanalyzed and notification re-send
# enable form controls on table columns
@@ -3906,13 +3925,15 @@ class plugin_object_class:
self.pluginPref = objDbRow[1] self.pluginPref = objDbRow[1]
self.primaryId = objDbRow[2] self.primaryId = objDbRow[2]
self.secondaryId = objDbRow[3] self.secondaryId = objDbRow[3]
self.dateTime = objDbRow[4] self.created = objDbRow[4]
self.watched1 = objDbRow[5] self.changed = objDbRow[5]
self.watched2 = objDbRow[6] self.watched1 = objDbRow[6]
self.watched3 = objDbRow[7] self.watched2 = objDbRow[7]
self.watched4 = objDbRow[8] self.watched3 = objDbRow[8]
self.status = objDbRow[9] self.watched4 = objDbRow[9]
self.extra = objDbRow[10] self.status = objDbRow[10]
self.extra = objDbRow[11]
self.userData = objDbRow[12]
self.idsHash = str(hash(str(self.primaryId) + str(self.secondaryId))) self.idsHash = str(hash(str(self.primaryId) + str(self.secondaryId)))
@@ -3921,7 +3942,7 @@ class plugin_object_class:
setObj = get_plugin_setting(plugin, 'WATCH') setObj = get_plugin_setting(plugin, 'WATCH')
indexNameColumnMapping = [(5, 'Watched_Value1' ), (6, 'Watched_Value2' ), (7, 'Watched_Value3' ), (8, 'Watched_Value4' )] indexNameColumnMapping = [(6, 'Watched_Value1' ), (7, 'Watched_Value2' ), (8, 'Watched_Value3' ), (9, 'Watched_Value4' )]
if setObj is not None: if setObj is not None:
@@ -3937,15 +3958,15 @@ class plugin_object_class:
tmp += str(objDbRow[indx]) tmp += str(objDbRow[indx])
self.watchedHash = str(hash(tmp)) self.watchedHash = str(hash(tmp))
#-------------------------------------------------------------------------------
# Combine plugin objects, keep user-defined values, created time
def combine_plugin_objects(old, new):
new.userData = old.userData
new.created = old.created
return new
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# Replace {wildcars} with parameters # Replace {wildcars} with parameters

4
docs/API.md
View File

@@ -30,9 +30,9 @@ You can access the following files:
| `table_pholus_scan.json` | The latest state of the [pholus](https://github.com/jokob-sk/Pi.Alert/tree/main/pholus) (A multicast DNS and DNS Service Discovery Security Assessment Tool) scan results. | | `table_pholus_scan.json` | The latest state of the [pholus](https://github.com/jokob-sk/Pi.Alert/tree/main/pholus) (A multicast DNS and DNS Service Discovery Security Assessment Tool) scan results. |
| `table_events_pending_alert.json` | The list of the unprocessed (pending) notification events. | | `table_events_pending_alert.json` | The list of the unprocessed (pending) notification events. |
| `table_settings.json` | The content of the settings table. | | `table_settings.json` | The content of the settings table. |
| `table_plugins_entries.json` | The content of the plugins_entries table. Find more info on the [Plugin system here](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins)| | `table_plugins_objects.json` | The content of the plugins_objects table. Find more info on the [Plugin system here](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins)|
| `language_strings.json` | The content of the language_strings table, which in turn is loaded from the plugins `config.json` definitions. | | `language_strings.json` | The content of the language_strings table, which in turn is loaded from the plugins `config.json` definitions. |
| `table_plugins_unprocessed_entries.json` | The content of the plugins_unprocessed_entries table. | | `table_plugins_events.json` | The content of the plugins_events table. |
| `table_custom_endpoint.json` | A custom endpoint generated by the SQL query specified by the `API_CUSTOM_SQL` setting. | | `table_custom_endpoint.json` | A custom endpoint generated by the SQL query specified by the `API_CUSTOM_SQL` setting. |
Current/latest state of the aforementioned files depends on your settings. Current/latest state of the aforementioned files depends on your settings.

22
front/plugins/website_monitor/config.json
View File

@@ -30,18 +30,18 @@
"value" : "WEBMON_SQL_internet_ip" "value" : "WEBMON_SQL_internet_ip"
}], }],
"database_column_aliases":{ "database_column_aliases":{
"localized": ["Index", "Object_PrimaryID", "DateTime", "Watched_Value1", "Watched_Value2"], "localized": ["Object_PrimaryID", "DateTimeCreated", "DateTimeChanged", "Watched_Value1", "Watched_Value2", "UserData", "Status"],
"Index":[{
"language_code":"en_us",
"string" : "Index"
}],
"Object_PrimaryID":[{ "Object_PrimaryID":[{
"language_code":"en_us", "language_code":"en_us",
"string" : "Monitored URL" "string" : "Monitored URL"
}], }],
"DateTime":[{ "DateTimeCreated":[{
"language_code":"en_us", "language_code":"en_us",
"string" : "Checked on" "string" : "Created"
}],
"DateTimeChanged":[{
"language_code":"en_us",
"string" : "Changed"
}], }],
"Watched_Value1":[{ "Watched_Value1":[{
"language_code":"en_us", "language_code":"en_us",
@@ -50,6 +50,14 @@
"Watched_Value2":[{ "Watched_Value2":[{
"language_code":"en_us", "language_code":"en_us",
"string" : "Latency" "string" : "Latency"
}],
"UserData":[{
"language_code":"en_us",
"string" : "Comments"
}],
"Status":[{
"language_code":"en_us",
"string" : "Status"
}] }]
}, },
"settings":[ "settings":[