"
+ },
+ {
+ "equals": "watched-changed",
+ "replacement": "
"
+ },
+ {
+ "equals": "new",
+ "replacement": "
"
+ },
+ {
+ "equals": "missing-in-last-scan",
+ "replacement": "
"
+ }
+ ],
+ "localized": ["name"],
+ "name":[{
+ "language_code": "en_us",
+ "string" : "Status"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Estado"
+ }]
+ },
+ {
+ "column": "Extra",
+ "css_classes": "col-sm-3",
+ "show": false,
+ "type": "label",
+ "default_value":"",
+ "options": [],
+ "localized": ["name"],
+ "name":[{
+ "language_code": "en_us",
+ "string" : "Extra"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Extra"
+ }]
+ }
+ ],
+ "settings":[
+ {
+ "function": "RUN",
+ "events": ["test"],
+ "type": "text.select",
+ "default_value":"disabled",
+ "options": ["disabled", "on_notification" ],
+ "localized": ["name", "description"],
+ "name" :[{
+ "language_code": "en_us",
+ "string" : "When to run"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Cuando ejecuta"
+ }],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string" : "Enable sending notifications via
NTFY."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Habilitar el envío de notificaciones a través de
NTFY."
+ }
+ ]
+ },
+ {
+ "function": "CMD",
+ "type": "readonly",
+ "default_value":"python3 /home/pi/pialert/front/plugins/_publisher_ntfy/ntfy.py",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "Command"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Comando"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Command to run"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Comando a ejecutar"
+ }]
+ },
+ {
+ "function": "RUN_TIMEOUT",
+ "type": "integer",
+ "default_value": 10,
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "Run timeout"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Tiempo de espera de ejecución"
+ },
+ {
+ "language_code": "de_de",
+ "string" : "Wartezeit"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Tiempo máximo en segundos para esperar a que finalice el script. Si se supera este tiempo, el script se cancela."
+ }]
+ },
+ {
+ "function": "HOST",
+ "type": "text",
+ "default_value": "https://ntfy.sh",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "NTFY host URL"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "URL del host NTFY"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "NTFY host URL starting with
http:// or
https://. You can use the hosted instance on
https://ntfy.sh by simply entering
https://ntfy.sh."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "URL de host NTFY que comienza con
http:// o
https://. Puede usar la instancia alojada en
https://ntfy.sh simplemente ingresando
https://ntfy. sh."
+ }]
+ },
+ {
+ "function": "TOPIC",
+ "type": "text",
+ "default_value": "",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "NTFY topic"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Tema de NTFY"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Your secret topic."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Tu tema secreto."
+ }]
+ },
+ {
+ "function": "USER",
+ "type": "text",
+ "default_value": "",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "NTFY user"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Usuario de NTFY"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Enter user if you need (host) an instance with enabled authetication."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Ingrese usuario si necesita (alojar) una instancia con autenticación habilitada."
+ }]
+ },
+ {
+ "function": "PASSWORD",
+ "type": "password",
+ "default_value": "",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "NTFY password"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Contraseña de NTFY"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Enter password if you need (host) an instance with enabled authetication."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Ingrese la contraseña si necesita (host) una instancia con autenticación habilitada."
+ }]
+ }
+ ]
+}
diff --git a/front/plugins/_publisher_ntfy/ignore_plugin b/front/plugins/_publisher_ntfy/ignore_plugin
deleted file mode 100755
index 77ffa1c1..00000000
--- a/front/plugins/_publisher_ntfy/ignore_plugin
+++ /dev/null
@@ -1 +0,0 @@
-This plugin will not be loaded
\ No newline at end of file
diff --git a/front/plugins/_publisher_ntfy/ntfy.py b/front/plugins/_publisher_ntfy/ntfy.py
new file mode 100755
index 00000000..2509ae61
--- /dev/null
+++ b/front/plugins/_publisher_ntfy/ntfy.py
@@ -0,0 +1,128 @@
+
+#!/usr/bin/env python
+
+import json
+import subprocess
+import argparse
+import os
+import pathlib
+import sys
+import requests
+from datetime import datetime
+from base64 import b64encode
+
+# Replace these paths with the actual paths to your Pi.Alert directories
+sys.path.extend(["/home/pi/pialert/front/plugins", "/home/pi/pialert/pialert"])
+
+import conf
+from plugin_helper import Plugin_Objects
+from logger import mylog, append_line_to_file
+from helper import timeNowTZ, noti_obj, get_setting_value
+from notification import Notification_obj
+from database import DB
+
+
+CUR_PATH = str(pathlib.Path(__file__).parent.resolve())
+RESULT_FILE = os.path.join(CUR_PATH, 'last_result.log')
+
+pluginName = 'NTFY'
+
+def main():
+
+ mylog('verbose', [f'[{pluginName}](publisher) In script'])
+
+ # Check if basic config settings supplied
+ if check_config() == False:
+ mylog('none', [f'[{pluginName}] Error: Publisher notification gateway not set up correctly. Check your pialert.conf {pluginName}_* variables.'])
+ return
+
+ # Create a database connection
+ db = DB() # instance of class DB
+ db.open()
+
+ # Initialize the Plugin obj output file
+ plugin_objects = Plugin_Objects(RESULT_FILE)
+
+ # Create a Notification_obj instance
+ notifications = Notification_obj(db)
+
+ # Retrieve new notifications
+ new_notifications = notifications.getNew()
+
+ # Process the new notifications
+ for notification in new_notifications:
+
+ # Send notification
+ response_text, response_status_code = send(notification["HTML"], notification["Text"])
+
+ # Log result
+ plugin_objects.add_object(
+ primaryId = pluginName,
+ secondaryId = timeNowTZ(),
+ watched1 = notification["GUID"],
+ watched2 = response_text,
+ watched3 = response_status_code,
+ watched4 = 'null',
+ extra = 'null',
+ foreignKey = notification["GUID"]
+ )
+
+ plugin_objects.write_result_file()
+
+
+
+#-------------------------------------------------------------------------------
+def check_config():
+ if get_setting_value('NTFY_HOST') == '' or get_setting_value('NTFY_TOPIC') == '':
+ return False
+ else:
+ return True
+
+#-------------------------------------------------------------------------------
+def send(html, text):
+
+ response_text = ''
+ response_status_code = ''
+
+
+ headers = {
+ "Title": "Pi.Alert Notification",
+ "Actions": "view, Open Dashboard, "+ get_setting_value('REPORT_DASHBOARD_URL'),
+ "Priority": "urgent",
+ "Tags": "warning"
+ }
+
+ # if username and password are set generate hash and update header
+ if get_setting_value('NTFY_USER') != "" and get_setting_value('NTFY_PASSWORD') != "":
+ # Generate hash for basic auth
+ # usernamepassword = "{}:{}".format(get_setting_value('NTFY_USER'),get_setting_value('NTFY_PASSWORD'))
+ basichash = b64encode(bytes(get_setting_value('NTFY_USER') + ':' + get_setting_value('NTFY_PASSWORD'), "utf-8")).decode("ascii")
+
+ # add authorization header with hash
+ headers["Authorization"] = "Basic {}".format(basichash)
+
+ try:
+ response = requests.post("{}/{}".format( get_setting_value('NTFY_HOST'),
+ get_setting_value('NTFY_TOPIC')),
+ data = text,
+ headers = headers)
+
+ response_status_code = response.status_code
+
+ # Check if the request was successful (status code 200)
+ if response_status_code == 200:
+ response_text = response.text # This captures the response body/message
+
+ except requests.exceptions.RequestException as e:
+ mylog('none', [f'[{pluginName}] Error: ', e])
+
+ response_text = e
+
+ return response_text, response_status_code
+
+ return response_text, response_status_code
+
+
+if __name__ == '__main__':
+ sys.exit(main())
+
diff --git a/front/plugins/arp_scan/script.py b/front/plugins/arp_scan/script.py
index 833315c1..fc7f79c5 100755
--- a/front/plugins/arp_scan/script.py
+++ b/front/plugins/arp_scan/script.py
@@ -12,7 +12,7 @@ from time import strftime
sys.path.append("/home/pi/pialert/front/plugins")
sys.path.append('/home/pi/pialert/pialert')
-from plugin_helper import Plugin_Object, Plugin_Objects
+from plugin_helper import Plugin_Object, Plugin_Objects, handleEmpty
from logger import mylog, append_line_to_file
from helper import timeNowTZ
from const import logPath, pialertPath
@@ -70,14 +70,14 @@ def main():
for device in unique_devices:
plugin_objects.add_object(
- primaryId=device['mac'], # MAC (Device Name)
- secondaryId=device['ip'], # IP Address
- watched1=device['ip'], # Device Name
- watched2=device.get('hw', ''), # Vendor (assuming it's in the 'hw' field)
- watched3=device.get('interface', ''), # Add the interface
- watched4='',
- extra='arp-scan',
- foreignKey="")
+ primaryId = handleEmpty(device['mac']), # MAC (Device Name)
+ secondaryId = handleEmpty(device['ip']), # IP Address
+ watched1 = handleEmpty(device['ip']), # Device Name
+ watched2 = handleEmpty(device.get('hw', '')), # Vendor (assuming it's in the 'hw' field)
+ watched3 = handleEmpty(device.get('interface', '')), # Add the interface
+ watched4 = '',
+ extra = 'arp-scan',
+ foreignKey = "")
plugin_objects.write_result_file()
diff --git a/front/plugins/dhcp_leases/script.py b/front/plugins/dhcp_leases/script.py
index a8562987..93f527df 100755
--- a/front/plugins/dhcp_leases/script.py
+++ b/front/plugins/dhcp_leases/script.py
@@ -62,14 +62,14 @@ def get_entries(path, plugin_objects):
row = line.rstrip().split()
if len(row) == 5:
plugin_objects.add_object(
- primaryId=handleEmpty(row[1]),
- secondaryId=handleEmpty(row[2]),
- watched1=handleEmpty('True'),
- watched2=handleEmpty(row[3]),
- watched3=handleEmpty(row[4]),
- watched4=handleEmpty('True'),
- extra=handleEmpty(path),
- foreignKey=handleEmpty(row[1])
+ primaryId = handleEmpty(row[1]),
+ secondaryId = handleEmpty(row[2]),
+ watched1 = handleEmpty('True'),
+ watched2 = handleEmpty(row[3]),
+ watched3 = handleEmpty(row[4]),
+ watched4 = handleEmpty('True'),
+ extra = handleEmpty(path),
+ foreignKey = handleEmpty(row[1])
)
else:
# Handle generic dhcp.leases files
diff --git a/front/plugins/plugin_helper.py b/front/plugins/plugin_helper.py
index 610f5a5e..9c3abf06 100755
--- a/front/plugins/plugin_helper.py
+++ b/front/plugins/plugin_helper.py
@@ -1,6 +1,7 @@
from time import strftime
import pytz
import sys
+import re
import base64
from datetime import datetime
@@ -38,7 +39,11 @@ def handleEmpty(input):
if input == '' or None:
return 'null'
else:
- return input
+ # Validate and sanitize message content
+ # Remove potentially problematic characters if string
+ if isinstance(input, str):
+ input = re.sub(r'[^\x00-\x7F]+', ' ', input)
+ return input
# -------------------------------------------------------------------
def decodeBase64(inputParamBase64):
diff --git a/front/plugins/snmp_discovery/script.py b/front/plugins/snmp_discovery/script.py
index 6a705319..4c4714a0 100755
--- a/front/plugins/snmp_discovery/script.py
+++ b/front/plugins/snmp_discovery/script.py
@@ -75,15 +75,14 @@ def main():
ipAddress = '.'.join(ipStr)
mylog('verbose', [f'[SNMPDSC] IP: {ipAddress} MAC: {macAddress}'])
-
plugin_objects.add_object(
- primaryId=macAddress,
- secondaryId=ipAddress.strip(), # Remove leading/trailing spaces from IP
- watched1='(unknown)',
- watched2=snmpwalkArgs[6], # router IP
- extra=line,
- foreignKey=macAddress # Use the primary ID as the foreign key
+ primaryId = handleEmpty(macAddress),
+ secondaryId = handleEmpty(ipAddress.strip()), # Remove leading/trailing spaces from IP
+ watched1 = '(unknown)',
+ watched2 = handleEmpty(snmpwalkArgs[6]), # router IP
+ extra = handleEmpty(line),
+ foreignKey = handleEmpty(macAddress) # Use the primary ID as the foreign key
)
mylog('verbose', ['[SNMPDSC] Entries found: ', len(plugin_objects)])
diff --git a/front/plugins/vendor_update/script.py b/front/plugins/vendor_update/script.py
index d61f0395..29e654cf 100755
--- a/front/plugins/vendor_update/script.py
+++ b/front/plugins/vendor_update/script.py
@@ -16,7 +16,7 @@ from datetime import datetime
sys.path.append("/home/pi/pialert/front/plugins")
sys.path.append('/home/pi/pialert/pialert')
-from plugin_helper import Plugin_Object, Plugin_Objects, decodeBase64
+from plugin_helper import Plugin_Object, Plugin_Objects, decodeBase64, handleEmpty
from logger import mylog, append_line_to_file
from helper import timeNowTZ
from const import logPath, pialertPath
@@ -106,14 +106,14 @@ def update_vendors (dbPath, plugin_objects):
ignored += 1
else :
plugin_objects.add_object(
- primaryId = device[0], # MAC (Device Name)
- secondaryId = device[1], # IP Address (always 0.0.0.0)
- watched1 = vendor,
- watched2 = device[2], # Device name
+ primaryId = handleEmpty(device[0]), # MAC (Device Name)
+ secondaryId = handleEmpty(device[1]), # IP Address (always 0.0.0.0)
+ watched1 = handleEmpty(vendor),
+ watched2 = handleEmpty(device[2]), # Device name
watched3 = "",
watched4 = "",
extra = "",
- foreignKey = device[0]
+ foreignKey = handleEmpty(device[0])
)
# Print log
diff --git a/pialert/conf.py b/pialert/conf.py
index 3df227e9..7d82039b 100755
--- a/pialert/conf.py
+++ b/pialert/conf.py
@@ -45,18 +45,6 @@ REPORT_DASHBOARD_URL = 'http://pi.alert/'
# Notification gateways
# -------------------------------------------
-# Email
-REPORT_MAIL = False
-SMTP_SERVER = ''
-SMTP_PORT = 587
-REPORT_TO = 'user@gmail.com'
-REPORT_FROM = 'Pi.Alert '
-SMTP_SKIP_LOGIN = False
-SMTP_USER = ''
-SMTP_PASS = ''
-SMTP_SKIP_TLS = False
-SMTP_FORCE_SSL = False
-
# Webhooks
REPORT_WEBHOOK = False
WEBHOOK_URL = ''
@@ -64,12 +52,6 @@ WEBHOOK_PAYLOAD = 'json'
WEBHOOK_REQUEST_METHOD = 'GET'
WEBHOOK_SECRET = ''
-# NTFY
-REPORT_NTFY = False
-NTFY_HOST = 'https://ntfy.sh'
-NTFY_TOPIC = ''
-NTFY_USER = ''
-NTFY_PASSWORD = ''
# PUSHSAFER
REPORT_PUSHSAFER = False
diff --git a/pialert/initialise.py b/pialert/initialise.py
index 6b5e8266..4ec77c3c 100755
--- a/pialert/initialise.py
+++ b/pialert/initialise.py
@@ -128,13 +128,6 @@ def importConfigs (db):
conf.WEBHOOK_SIZE = ccd('WEBHOOK_SIZE', 1024 , c_d, 'Payload size', 'integer', '', 'Webhooks')
conf.WEBHOOK_SECRET = ccd('WEBHOOK_SECRET', '' , c_d, 'Secret', 'text', '', 'Webhooks')
- # NTFY
- conf.REPORT_NTFY = ccd('REPORT_NTFY', False , c_d, 'Enable NTFY', 'boolean', '', 'NTFY', ['test'])
- conf.NTFY_HOST = ccd('NTFY_HOST', 'https://ntfy.sh' , c_d, 'NTFY host URL', 'text', '', 'NTFY')
- conf.NTFY_TOPIC = ccd('NTFY_TOPIC', '' , c_d, 'NTFY topic', 'text', '', 'NTFY')
- conf.NTFY_USER = ccd('NTFY_USER', '' , c_d, 'NTFY user', 'text', '', 'NTFY')
- conf.NTFY_PASSWORD = ccd('NTFY_PASSWORD', '' , c_d, 'NTFY password', 'password', '', 'NTFY')
-
# PUSHSAFER
conf.REPORT_PUSHSAFER = ccd('REPORT_PUSHSAFER', False , c_d, 'Enable PUSHSAFER', 'boolean', '', 'PUSHSAFER', ['test'])
conf.PUSHSAFER_TOKEN = ccd('PUSHSAFER_TOKEN', 'ApiKey' , c_d, 'PUSHSAFER token', 'text', '', 'PUSHSAFER')
diff --git a/pialert/publishers/ntfy.py b/pialert/publishers/ntfy.py
deleted file mode 100755
index fd613f78..00000000
--- a/pialert/publishers/ntfy.py
+++ /dev/null
@@ -1,43 +0,0 @@
-
-import conf
-import requests
-from base64 import b64encode
-
-from logger import mylog
-from helper import noti_obj
-
-#-------------------------------------------------------------------------------
-def check_config():
- if conf.NTFY_HOST == '' or conf.NTFY_TOPIC == '':
- mylog('none', ['[Check Config] Error: NTFY service not set up correctly. Check your pialert.conf NTFY_* variables.'])
- return False
- else:
- return True
-
-#-------------------------------------------------------------------------------
-def send (msg: noti_obj):
-
- headers = {
- "Title": "Pi.Alert Notification",
- "Actions": "view, Open Dashboard, "+ conf.REPORT_DASHBOARD_URL,
- "Priority": "urgent",
- "Tags": "warning"
- }
- # if username and password are set generate hash and update header
- if conf.NTFY_USER != "" and conf.NTFY_PASSWORD != "":
- # Generate hash for basic auth
- # usernamepassword = "{}:{}".format(conf.NTFY_USER,conf.NTFY_PASSWORD)
- basichash = b64encode(bytes(conf.NTFY_USER + ':' + conf.NTFY_PASSWORD, "utf-8")).decode("ascii")
-
- # add authorization header with hash
- headers["Authorization"] = "Basic {}".format(basichash)
-
- try:
- requests.post("{}/{}".format( conf.NTFY_HOST, conf.NTFY_TOPIC),
- data=msg.text,
- headers=headers)
- except requests.exceptions.RequestException as e:
- mylog('none', ['[NTFY] Error: ', e])
- return -1
-
- return 0
diff --git a/pialert/reporting.py b/pialert/reporting.py
index 0cc2be7f..6e689f64 100755
--- a/pialert/reporting.py
+++ b/pialert/reporting.py
@@ -24,8 +24,6 @@ from const import pialertPath, logPath, apiPath
from helper import noti_obj, generate_mac_links, removeDuplicateNewLines, timeNowTZ, hide_email, updateState, get_file_content, write_file
from logger import logResult, mylog, print_log
-from publishers.ntfy import (check_config as ntfy_check_config,
- send as send_ntfy )
from publishers.webhook import (check_config as webhook_check_config,
send as send_webhook)
from publishers.pushsafer import (check_config as pushsafer_check_config,