Tar update

Installation script
#46 - Changed My IP query hosts

README.md

@@ -36,16 +36,18 @@ Up to three scanning methods are used:
 ## Components
 The system consists of two parts:
 
-- **Back**, in charge of:
+### Back
+In charge of:
   - Scan the network searching connected devices using the scanning methods
-        described
+    described
   - Store the information in the DB
   - Report the changes detected by e-mail
 
   | ![Report 1][report1] | ![Report 2][report2] |
   | -------------------- | -------------------- |
 
-- **Front**, a web frontal that allows:
+### Front
+A web frontal that allows:
   - Manage the devices inventory and the characteristics
   - Display in a visual way all the information collected by the back
     - Sessions
@@ -65,10 +67,11 @@ The system consists of two parts:
 
 # Installation
 <!--- --------------------------------------------------------------------- --->
-Initially designed to run on a Raspberry PI, probably it can run on many other
+Initially designed to run on a Raspberry Pi, probably it can run on many other
 Linux distributions.
-
+- One-step Automated Install:
-  - [Installation instructions](docs/INSTALL.md)
+  #### `curl -sSL https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_install.sh | bash`
+- [Installation Guide (step by step)](docs/INSTALL.md)
 
 
 ## Device Management
@@ -77,9 +80,12 @@ Linux distributions.
   - [Device Management instructions](docs/DEVICE_MANAGEMENT.md)
 
 
+
 ## Other useful info
 <!--- --------------------------------------------------------------------- --->
 
+### [Versions History](docs/VERSIONS_HISTORY.md)
+
 ### Powered by:
   | Product      | Objetive                               |
   | ------------ | -------------------------------------- |
@@ -97,7 +103,7 @@ Linux distributions.
 
 ### License
   GPL 3.0
-  [Read more here](docs/LICENSE.txt)
+  [Read more here](LICENSE.txt)
 
 ### Contact
   pi.alert.application@gmail.com

back/pialert.conf

@@ -1,29 +0,0 @@
-VERSION         = '2.52'
-VERSION_YEAR    = '2021'
-VERSION_DATE    = '2021-01-11'
-
-DB_PATH         = '/home/pi/pialert/db/pialert.db'
-LOG_PATH        = '/home/pi/pialert/log'
-VENDORS_DB      = '/usr/share/arp-scan/ieee-oui.txt'
-PA_FRONT_URL    = 'http://pi.alert/deviceDetails.php?mac='
-PRINT_LOG       = False
-
-SMTP_SERVER     = 'smtp.gmail.com'
-SMTP_PORT       = 587
-SMTP_USER       = 'user@gmail.com'
-SMTP_PASS       = 'password'
-
-REPORT_MAIL     = False
-REPORT_FROM     = 'Pi.Alert <' + SMTP_USER +'>'
-REPORT_TO       = 'user@gmail.com'
-
-DDNS_ACTIVE     = False
-DDNS_DOMAIN     = 'your_domain.freeddns.org'
-DDNS_USER       = 'dynu_user'
-DDNS_PASSWORD   = 'A0000000B0000000C0000000D0000000'
-DDNS_UPDATE_URL = 'https://api.dynu.com/nic/update?'
-
-PIHOLE_ACTIVE   = False
-PIHOLE_DB       = '/etc/pihole/pihole-FTL.db'
-DHCP_ACTIVE     = False
-DHCP_LEASES     = '/etc/pihole/dhcp.leases'

back/pialert.cron

@@ -1,7 +0,0 @@
-#
-# Pi.Alert cron
-#
-0 3 * * 1      python ~/pialert/back/pialert.py update_vendors >~/pialert/log/pialert.vendors.log  2>&1
-*/1 * * * *    python ~/pialert/back/pialert.py internet_IP    >~/pialert/log/pialert.IP.log       2>&1
-*/5 * * * *    python ~/pialert/back/pialert.py 1              >~/pialert/log/pialert.1.log        2>&1
-*/15 * * * *   python ~/pialert/back/pialert.py 15             >~/pialert/log/pialert.15.log       2>&1

back/pialert.py

@@ -1,8 +1,13 @@
 #!/usr/bin/env python
 #
-# Pi.Alert v2.52  /  2021-01-11
+#-------------------------------------------------------------------------------
-# Puche 2020
+#  Pi.Alert  v2.61  /  2021-01-25
-# GNU GPLv3
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  pialert.py - Back module. Network scanner
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#-------------------------------------------------------------------------------
 
 
 #===============================================================================
@@ -27,8 +32,15 @@ import csv
 #===============================================================================
 # CONFIG CONSTANTS
 #===============================================================================
-PIALERT_PATH = os.path.dirname(os.path.abspath(__file__))
+PIALERT_BACK_PATH = os.path.dirname(os.path.abspath(__file__))
-execfile (PIALERT_PATH + "/pialert.conf")
+PIALERT_PATH = PIALERT_BACK_PATH + "/.."
+
+if (sys.version_info > (3,0)):
+    exec(open(PIALERT_PATH + "/config/version.conf").read())
+    exec(open(PIALERT_PATH + "/config/pialert.conf").read())
+else:
+    execfile (PIALERT_PATH + "/config/version.conf")
+    execfile (PIALERT_PATH + "/config/pialert.conf")
 
 
 #===============================================================================
@@ -46,7 +58,6 @@ def main ():
     print ('---------------------------------------------------------')
 
     # Initialize global variables
-    # PIALERT_PATH   = os.path.dirname(os.path.abspath(__file__))
     log_timestamp  = datetime.datetime.now()
 
     # DB
@@ -68,6 +79,8 @@ def main ():
         res = check_internet_IP()
     elif cycle == 'update_vendors':
         res = update_devices_MAC_vendors()
+    elif cycle == 'update_vendors_silent':
+        res = update_devices_MAC_vendors('-s')
     else :
         res = scan_network()
     
@@ -152,16 +165,20 @@ def check_internet_IP ():
 
 #-------------------------------------------------------------------------------
 def get_internet_IP ():
+    # BUGFIX #46 - curl http://ipv4.icanhazip.com repeatedly is very slow
     # Using 'dig'
-        # dig_args = ['dig', '+short', 'myip.opendns.com',
+    dig_args = ['dig', '+short', '-4', 'myip.opendns.com',
-        #   '@resolver1.opendns.com']
+                '@resolver1.opendns.com']
+    cmd_output = subprocess.check_output (dig_args, universal_newlines=True)
 
-    # Using 'curl' instead of 'dig'
+    ## BUGFIX #12 - Query IPv4 address (not IPv6)
-    curl_args = ['curl', '-s', 'https://diagnostic.opendns.com/myip']
+    ## Using 'curl' instead of 'dig'
-    curl_output = subprocess.check_output (curl_args, universal_newlines=True)
+    ## curl_args = ['curl', '-s', 'https://diagnostic.opendns.com/myip']
+    #curl_args = ['curl', '-s', QUERY_MYIP_SERVER]
+    #cmd_output = subprocess.check_output (curl_args, universal_newlines=True)
 
     # Check result is an IP
-    IP = check_IP_format (curl_output)
+    IP = check_IP_format (cmd_output)
     return IP
 
 #-------------------------------------------------------------------------------
@@ -237,14 +254,14 @@ def check_IP_format (pIP):
 #===============================================================================
 # UPDATE DEVICE MAC VENDORS
 #===============================================================================
-def update_devices_MAC_vendors ():
+def update_devices_MAC_vendors (pArg = ''):
     # Header
     print ('Update HW Vendors')
     print ('    Timestamp:', startTime )
 
     # Update vendors DB (iab oui)
     print ('\nUpdating vendors DB (iab & oui)...')
-    update_args = ['sh', PIALERT_PATH + '/vendors_db_update.sh']
+    update_args = ['sh', PIALERT_BACK_PATH + '/update_vendors.sh', pArg]
     update_output = subprocess.check_output (update_args)
     # DEBUG
         # update_args = ['./vendors_db_update.sh']
@@ -292,9 +309,12 @@ def update_devices_MAC_vendors ():
 #-------------------------------------------------------------------------------
 def query_MAC_vendor (pMAC):
     try :
+        # BUGFIX #6 - Fix pMAC parameter as numbers
+        pMACstr = str(pMAC)
+        
         # Check MAC parameter
-        mac = pMAC.replace (':','')
+        mac = pMACstr.replace (':','')
-        if len(pMAC) != 17 or len(mac) != 12 :
+        if len(pMACstr) != 17 or len(mac) != 12 :
             return -2
 
         # Search vendor in HW Vendors DB
@@ -447,8 +467,28 @@ def execute_arpscan (pRetries):
     devices_list = [device.groupdict()
         for device in re.finditer (re_pattern, arpscan_output)]
 
+    # Bugfix #5 - Delete duplicated MAC's with different IP's
+    # TEST - Force duplicated device
+        # devices_list.append(devices_list[0])
+    # Delete duplicate MAC
+    unique_mac = [] 
+    unique_devices = [] 
+
+    for device in devices_list :
+        if device['mac'] not in unique_mac: 
+            unique_mac.append(device['mac'])
+            unique_devices.append(device)
+
+    # DEBUG
+        # print (devices_list)
+        # print (unique_mac)
+        # print (unique_devices)
+        # print (len(devices_list))
+        # print (len(unique_mac))
+        # print (len(unique_devices))
+
     # return list
-    return devices_list
+    return unique_devices
 
 #-------------------------------------------------------------------------------
 def copy_pihole_network ():
@@ -684,16 +724,39 @@ def create_new_devices ():
 
     # DHCP Leases - Create New Devices
     print_log ('New devices - 6 DHCP Leases Create devices')
-    sql.execute ("""INSERT INTO Devices (dev_MAC, dev_name, dev_Vendor,
+    # BUGFIX #23 - Duplicated MAC in DHCP.Leases
-                        dev_LastIP, dev_FirstConnection, dev_LastConnection,
+    # TEST - Force Duplicated MAC
+        # sql.execute ("""INSERT INTO DHCP_Leases VALUES
+        #                 (1610700000, 'TEST1', '10.10.10.1', 'Test 1', '*')""")
+        # sql.execute ("""INSERT INTO DHCP_Leases VALUES
+        #                 (1610700000, 'TEST2', '10.10.10.2', 'Test 2', '*')""")
+    sql.execute ("""INSERT INTO Devices (dev_MAC, dev_name, dev_LastIP, 
+                        dev_Vendor, dev_FirstConnection, dev_LastConnection,
                         dev_ScanCycle, dev_AlertEvents, dev_AlertDeviceDown,
                         dev_PresentLastScan)
-                    SELECT DHCP_MAC, DHCP_Name, '(unknown)', DHCP_IP, ?, ?,
+                    SELECT DISTINCT DHCP_MAC,
-                        1, 1, 0, 1
+                        (SELECT DHCP_Name FROM DHCP_Leases AS D2
-                    FROM DHCP_Leases
+                         WHERE D2.DHCP_MAC = D1.DHCP_MAC
+                         ORDER BY DHCP_DateTime DESC LIMIT 1),
+                        (SELECT DHCP_IP FROM DHCP_Leases AS D2
+                         WHERE D2.DHCP_MAC = D1.DHCP_MAC
+                         ORDER BY DHCP_DateTime DESC LIMIT 1),
+                        '(unknown)', ?, ?, 1, 1, 0, 1
+                    FROM DHCP_Leases AS D1
                     WHERE NOT EXISTS (SELECT 1 FROM Devices
                                       WHERE dev_MAC = DHCP_MAC) """,
                     (startTime, startTime) ) 
+
+    # sql.execute ("""INSERT INTO Devices (dev_MAC, dev_name, dev_Vendor,
+    #                     dev_LastIP, dev_FirstConnection, dev_LastConnection,
+    #                     dev_ScanCycle, dev_AlertEvents, dev_AlertDeviceDown,
+    #                     dev_PresentLastScan)
+    #                 SELECT DHCP_MAC, DHCP_Name, '(unknown)', DHCP_IP, ?, ?,
+    #                     1, 1, 0, 1
+    #                 FROM DHCP_Leases
+    #                 WHERE NOT EXISTS (SELECT 1 FROM Devices
+    #                                   WHERE dev_MAC = DHCP_MAC) """,
+    #                 (startTime, startTime) ) 
     print_log ('New Devices end')
 
 #-------------------------------------------------------------------------------
@@ -993,12 +1056,12 @@ def email_reporting ():
     openDB()
 
     # Open text Template
-    template_file = open(PIALERT_PATH + '/report_template.txt', 'r') 
+    template_file = open(PIALERT_BACK_PATH + '/report_template.txt', 'r') 
     mail_text = template_file.read() 
     template_file.close() 
 
     # Open html Template
-    template_file = open(PIALERT_PATH + '/report_template.html', 'r') 
+    template_file = open(PIALERT_BACK_PATH + '/report_template.html', 'r') 
     mail_html = template_file.read() 
     template_file.close() 
 
@@ -1043,7 +1106,7 @@ def email_reporting ():
             eventAlert['eve_EventType'], eventAlert['eve_DateTime'],
             eventAlert['eve_IP'], eventAlert['eve_AdditionalInfo'])
         mail_html_Internet += html_line_template.format (
-            PA_FRONT_URL, eventAlert['eve_MAC'],
+            REPORT_DEVICE_URL, eventAlert['eve_MAC'],
             eventAlert['eve_EventType'], eventAlert['eve_DateTime'],
             eventAlert['eve_IP'], eventAlert['eve_AdditionalInfo'])
 
@@ -1071,7 +1134,7 @@ def email_reporting ():
             eventAlert['eve_IP'], eventAlert['dev_Name'],
             eventAlert['eve_AdditionalInfo'])
         mail_html_new_devices += html_line_template.format (
-            PA_FRONT_URL, eventAlert['eve_MAC'], eventAlert['eve_MAC'],
+            REPORT_DEVICE_URL, eventAlert['eve_MAC'], eventAlert['eve_MAC'],
             eventAlert['eve_DateTime'], eventAlert['eve_IP'],
             eventAlert['dev_Name'], eventAlert['eve_AdditionalInfo'])
 
@@ -1098,7 +1161,7 @@ def email_reporting ():
             eventAlert['eve_MAC'], eventAlert['eve_DateTime'],
             eventAlert['eve_IP'], eventAlert['dev_Name'])
         mail_html_devices_down += html_line_template.format (
-            PA_FRONT_URL, eventAlert['eve_MAC'], eventAlert['eve_MAC'],
+            REPORT_DEVICE_URL, eventAlert['eve_MAC'], eventAlert['eve_MAC'],
             eventAlert['eve_DateTime'], eventAlert['eve_IP'],
             eventAlert['dev_Name'])
 
@@ -1128,7 +1191,7 @@ def email_reporting ():
             eventAlert['eve_IP'], eventAlert['eve_EventType'],
             eventAlert['dev_Name'], eventAlert['eve_AdditionalInfo'])
         mail_html_events += html_line_template.format (
-            PA_FRONT_URL, eventAlert['eve_MAC'], eventAlert['eve_MAC'],
+            REPORT_DEVICE_URL, eventAlert['eve_MAC'], eventAlert['eve_MAC'],
             eventAlert['eve_DateTime'], eventAlert['eve_IP'],
             eventAlert['eve_EventType'], eventAlert['dev_Name'],
             eventAlert['eve_AdditionalInfo'])
@@ -1210,7 +1273,7 @@ def write_file (pPath, pText):
         file.close() 
     else:
         file = open (pPath, 'w', encoding='utf-8') 
-        file.write (ptext) 
+        file.write (pText) 
         file.close() 
 
 #-------------------------------------------------------------------------------

back/report_template.html

@@ -1,3 +1,12 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  repot_template.html - Back module. Template to email reporting in HTML format
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
 <html>
 
 <head>
@@ -101,9 +110,9 @@
         <td>
             <table width=100% border=0 bgcolor=#70AD47 cellpadding=5px cellspacing=0 style="border-collapse: collapse; font-size: 12px; font-weight: bold; color:#385723">
                <tr>
-                    <td width=25% style="text-align:Left">   Puche <PIALERT_YEAR></td>
+                    <td width=25% style="text-align:Left"> <span style="display:inline-block; transform: rotate(180deg)">&copy;</span> <PIALERT_YEAR> Puche</td>
-                    <td width=50% style="text-align:center"> Pi.Alert <PIALERT_VERSION> &nbsp; / &nbsp; <PIALERT_VERSION_DATE>  </td>
+                    <td width=50% style="text-align:center"> Pi.Alert <PIALERT_VERSION> &nbsp; &nbsp; (<PIALERT_VERSION_DATE>)  </td>
-                    <td width=25% style="text-align:right">  GNU GPLv3</td>
+                    <td width=25% style="text-align:right"> GNU GPLv3</td>
                 </tr>
             </table>
         </td>

back/report_template.txt

@@ -24,4 +24,4 @@ Events
 <TABLE_EVENTS>
 </SECTION_EVENTS>
 ----------------------------------------------------------------------
-Puche <PIALERT_YEAR>            Pi.Alert <PIALERT_VERSION> / <PIALERT_VERSION_DATE>             GNU GPLv3
+(?) <PIALERT_YEAR> Puche          Pi.Alert <PIALERT_VERSION> (<PIALERT_VERSION_DATE>)           GNU GPLv3

back/update_vendors.sh

@@ -0,0 +1,62 @@
+#!/bin/sh
+# ------------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  vendors_db_update.sh - Back module. IEEE Vendors db update
+# ------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+# ------------------------------------------------------------------------------
+
+# ----------------------------------------------------------------------
+#  Main directories to update:
+#    /usr/share/arp-scan
+#    /usr/share/ieee-data
+#    /var/lib/ieee-data
+# ----------------------------------------------------------------------
+
+
+# ----------------------------------------------------------------------
+echo Updating... /usr/share/ieee-data/
+cd /usr/share/ieee-data/
+
+sudo mkdir -p 2_backup
+sudo cp *.txt 2_backup
+sudo cp *.csv 2_backup
+
+sudo curl $1 -# -O http://standards-oui.ieee.org/iab/iab.csv
+sudo curl $1 -# -O http://standards-oui.ieee.org/iab/iab.txt
+
+sudo curl $1 -# -O http://standards-oui.ieee.org/oui28/mam.csv
+sudo curl $1 -# -O http://standards-oui.ieee.org/oui28/mam.txt
+
+sudo curl $1 -# -O http://standards-oui.ieee.org/oui36/oui36.csv
+sudo curl $1 -# -O http://standards-oui.ieee.org/oui36/oui36.txt
+
+sudo curl $1 -# -O http://standards-oui.ieee.org/oui/oui.csv
+sudo curl $1 -# -O http://standards-oui.ieee.org/oui/oui.txt
+
+
+# ----------------------------------------------------------------------
+echo ""
+echo Updating... /usr/share/arp-scan/
+cd /usr/share/arp-scan
+
+sudo mkdir -p 2_backup
+sudo cp *.txt 2_backup
+
+# Update from /usb/lib/ieee-data
+sudo get-iab -v
+sudo get-oui -v
+
+# Update from ieee website
+# sudo get-iab -v -u http://standards-oui.ieee.org/iab/iab.txt
+# sudo get-oui -v -u http://standards-oui.ieee.org/oui/oui.txt
+
+# Update from ieee website develop
+# sudo get-iab -v -u http://standards.ieee.org/develop/regauth/iab/iab.txt
+# sudo get-oui -v -u http://standards.ieee.org/develop/regauth/oui/oui.txt
+
+# Update from Sanitized oui (linuxnet.ca)
+# sudo get-oui -v -u https://linuxnet.ca/ieee/oui.txt
+

back/vendors_db_update.sh

@@ -1,54 +0,0 @@
-#!/bin/sh
-#
-# Update MAC Vendor DB
-#
-# /usr/share/arp-scan
-# /usr/share/ieee-data
-# /var/lib/ieee-data
-# ----------------------------------------------------------------------
-
-
-# ----------------------------------------------------------------------
-echo Updating... /usr/share/ieee-data/
-cd /usr/share/ieee-data/
-
-sudo mkdir -p 2_backup
-sudo cp *.txt 2_backup
-sudo cp *.csv 2_backup
-
-sudo curl -# -O http://standards-oui.ieee.org/iab/iab.csv
-sudo curl -# -O http://standards-oui.ieee.org/iab/iab.txt
-
-sudo curl -# -O http://standards-oui.ieee.org/oui28/mam.csv
-sudo curl -# -O http://standards-oui.ieee.org/oui28/mam.txt
-
-sudo curl -# -O http://standards-oui.ieee.org/oui36/oui36.csv
-sudo curl -# -O http://standards-oui.ieee.org/oui36/oui36.txt
-
-sudo curl -# -O http://standards-oui.ieee.org/oui/oui.csv
-sudo curl -# -O http://standards-oui.ieee.org/oui/oui.txt
-
-
-# ----------------------------------------------------------------------
-echo ""
-echo Updating... /usr/share/arp-scan/
-cd /usr/share/arp-scan
-
-sudo mkdir -p 2_backup
-sudo cp *.txt 2_backup
-
-# Update from /usb/lib/ieee-data
-sudo get-iab -v
-sudo get-oui -v
-
-# Update from ieee website
-# sudo get-iab -v -u http://standards-oui.ieee.org/iab/iab.txt
-# sudo get-oui -v -u http://standards-oui.ieee.org/oui/oui.txt
-
-# Update from ieee website develop
-# sudo get-iab -v -u http://standards.ieee.org/develop/regauth/iab/iab.txt
-# sudo get-oui -v -u http://standards.ieee.org/develop/regauth/oui/oui.txt
-
-# Update from Sanitized oui (linuxnet.ca)
-# sudo get-oui -v -u https://linuxnet.ca/ieee/oui.txt
-

config/pialert.conf

@@ -0,0 +1,37 @@
+#-------------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  pialert.conf - Back module. Configuration file
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#-------------------------------------------------------------------------------
+
+PIALERT_PATH      = '/home/pi/pialert'
+DB_PATH           = PIALERT_PATH + '/db/pialert.db'
+LOG_PATH          = PIALERT_PATH + '/log'
+VENDORS_DB        = '/usr/share/arp-scan/ieee-oui.txt'
+PRINT_LOG         = False
+
+SMTP_SERVER       = 'smtp.gmail.com'
+SMTP_PORT         = 587
+SMTP_USER         = 'user@gmail.com'
+SMTP_PASS         = 'password'
+
+REPORT_MAIL       = False
+REPORT_FROM       = 'Pi.Alert <' + SMTP_USER +'>'
+REPORT_TO         = 'user@gmail.com'
+REPORT_DEVICE_URL = 'http://pi.alert/deviceDetails.php?mac='
+
+# QUERY_MYIP_SERVER = 'https://diagnostic.opendns.com/myip'
+QUERY_MYIP_SERVER = 'http://ipv4.icanhazip.com'
+DDNS_ACTIVE       = False
+DDNS_DOMAIN       = 'your_domain.freeddns.org'
+DDNS_USER         = 'dynu_user'
+DDNS_PASSWORD     = 'A0000000B0000000C0000000D0000000'
+DDNS_UPDATE_URL   = 'https://api.dynu.com/nic/update?'
+
+PIHOLE_ACTIVE     = False
+PIHOLE_DB         = '/etc/pihole/pihole-FTL.db'
+DHCP_ACTIVE       = False
+DHCP_LEASES       = '/etc/pihole/dhcp.leases'

config/version.conf

@@ -0,0 +1,3 @@
+VERSION           = '2.61'
+VERSION_YEAR      = '2021'
+VERSION_DATE      = '2021-01-25'

docs/DEVICE_MANAGEMENT.md

@@ -79,7 +79,7 @@ decides to change the MAC).
   
 ### License
   GPL 3.0
-  [Read more here](LICENSE.txt)
+  [Read more here](../LICENSE.txt)
 
 ### Contact
   pi.alert.application@gmail.com

docs/INSTALL.md

@@ -1,9 +1,9 @@
-# Pi.Alert Installation
+# Pi.Alert Installation Guide
 <!--- --------------------------------------------------------------------- --->
 Initially designed to run on a Raspberry PI, probably it can run on many other
 Linux distributions.
 
-Stimated time: 20'
+Estimated time: 20'
 
 ### Dependencies
   | Dependency | Comments                                                 |
@@ -14,177 +14,278 @@ Stimated time: 20'
   | dnsmasq    | Optional. Scan Method 3. Check devices using DHCP server |
   | IEEE HW DB | Necessary to identified Device vendor                    |
 
-# Installation process
+# One-step Automated Install:
+<!--- --------------------------------------------------------------------- --->
+### `curl -sSL https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_install.sh | bash`
+
+# Installation process (step by step)
 <!--- --------------------------------------------------------------------- --->
 
 ## Raspberry Setup
 <!--- --------------------------------------------------------------------- --->
-1 - Install 'Raspberry Pi OS'
+1.1 - Install 'Raspberry Pi OS'
   - Instructions https://www.raspberrypi.org/documentation/installation/installing-images/
   - *Lite version (without Descktop) is enough for Pi.Alert*
 
-2 - Activate ssh
+1.2 - Activate ssh
   - Create a empty file with name 'ssh' in the boot partition of the SD
 
-3 - Start the raspberry
+1.3 - Start the raspberry
 
-4 - Login to the system with pi user
+1.4 - Login to the system with pi user
-```
+  ```
   user: pi
   password: raspberry
-```
+  ```
 
-5 - Change de default password of pi user
+1.5 - Change the default password of pi user
-```
+  ```
   passwd
-```
+  ```
 
-6 - Setup the basic configuration
+1.6 - Setup the basic configuration
-```
+  ```
   sudo raspi-config
-```
+  ```
 
-7 - Optionally, configure a static IP in raspi-config
+1.7 - Optionally, configure a static IP in raspi-config
 
-8 - Update the OS
+1.8 - Update the OS
-```
+  ```
   sudo apt-get update
   sudo apt-get upgrade
-  sudo reboot
+  sudo shutdown -r now
-```
+  ```
 
-## Pi-hole Setup
+
+## Pi-hole Setup (optional)
 <!--- --------------------------------------------------------------------- --->
-1- Links & Doc
+2.1 - Links & Doc
   - https://pi-hole.net/
   - https://github.com/pi-hole/pi-hole
   - https://github.com/pi-hole/pi-hole/#one-step-automated-install
 
-2 - Login to the system with pi user
+2.2 - Login to the system with pi user
 
-3 - Install Pi-hole
+2.3 - Install Pi-hole
-```
+  ```
-    curl -sSL https://install.pi-hole.net | bash
+  curl -sSL https://install.pi-hole.net | bash
-```
+  ```
-  - Mark "Install web admin interface"
+  - Select "Install web admin interface"
-  - Mark "Install web server lighttpd"
+  - Select "Install web server lighttpd"
 
-4 - Configure Pi-hole admin password
+2.4 - Configure Pi-hole admin password
-```
+  ```
-    pihole -a -p PASSWORD
+  pihole -a -p PASSWORD
-```
+  ```
 
-5 - Connect to web admin panel
+2.5 - Connect to web admin panel
+  ```
+  hostname -I
+  ```
   - http://192.168.1.x/admin/
-  - (*replace the 192.168.1.x with your Raspberry IP*)
+  - (*replace 192.168.1.x with your Raspberry IP*)
 
-6 - Activate DHCP server
+2.6 - Activate DHCP server
-  - Pi-hole -> Settings -> DHCP -> Mark "DHCP server enabled"
+  - Pi-hole admin portal -> Settings -> DHCP -> Mark "DHCP server enabled"
 
-7 - Add pi.alert DNS Record
+2.7 - Add pi.alert DNS Record
-  - Pi-hole -> Local DNS -> DNS Records -> Add new domain /IP
+  ```
+  hostname -I
+  ```
+  - Pi-hole admin portal -> Local DNS -> DNS Records -> Add new domain /IP
     - pi.alert    192.168.1.x
-    - (*replace the 192.168.1.x with your Raspberry IP*)
+    - (*replace 192.168.1.x with your Raspberry IP*)
 
-8 - Deactivate your current DHCP Server (*Normaly at your router or AP*)
+2.8 - Deactivate your current DHCP Server (*Normaly at your router or AP*)
 
-9 - Renew your computer IP to unsure you are using the new DHCP and DNS server
+2.9 - Renew your computer IP to unsure you are using the new DHCP and DNS server
   - Windows: cmd -> ipconfig /renew
   - Linux: shell -> sudo dhclient -r; sudo dhclient
-  - Mac: Apple menu -> System Preferences -> Network -> Select the network ->
+  - Mac: Apple menu -> System Preferences -> Network -> Select the network
-    Advanced -> TCP/IP -> Renew DHCP Lease
+    -> Advanced -> TCP/IP -> Renew DHCP Lease
+
+
+## Lighttpd & PHP
+<!--- --------------------------------------------------------------------- --->
+If you have installed Pi.hole, lighttpd and PHP are already installed and this
+block is not necessary
+
+3.1 - Install lighttpd
+  ```
+  sudo apt-get install lighttpd -y
+  ```
+
+3.2 - If Pi.Alert will be the only site available in this webserver, you can
+  redirect the default server page to pialert subfolder
+  ```
+  sudo mv /var/www/html/index.lighttpd.html /var/www/html/index.lighttpd.html.old
+  sudo ln -s ~/pialert/install/index.html /var/www/html/index.html
+  ```
+
+3.3 - Install PHP
+  ```
+  sudo apt-get install php php-cgi php-fpm php-sqlite3 -y     
+  ```
+
+3.4 - Activate PHP
+  ```
+  sudo lighttpd-enable-mod fastcgi-php
+  sudo /etc/init.d/lighttpd restart
+  ```
+
 
 ## arp-scan & Python
 <!--- --------------------------------------------------------------------- --->
-1 - Install arp-scan utility and test
+4.1 - Install arp-scan utility and test
-```
+  ```
-  sudo apt-get install arp-scan
+  sudo apt-get install arp-scan -y
   sudo arp-scan -l
-```
+  ```
 
-2 - Install Python & packages
+4.2 - Test Python
-```
-  sudo apt-get install python-setuptools
-  sudo apt install python-pip
 
-  pip install netaddr
+  New versions of 'Raspberry Pi OS' includes Python. You can check that 
-  pip install dpkt
+  Python is installed with the command:
-  pip install MacLookup
+  ```
-```
+  python -V
+  ```
 
+  New versions of Ubuntu includes Python 3. You can choose between use `python3`
+  command or to install Python 2 (that includes `python` command).
+  
+  
+  If you prefer to use Python 3, in the next installation block, you must update
+  `pialert.cron` file with the correct command: `python3` instead of `python`.
+  ```
+  python3 -V
+  ```
+
+4.3 - If Python is not installed in your system, you can install it with this
+  command:
+  ```
+  sudo apt-get install python
+  ```
+  Or this one if you prefer Python 3:
+  ```
+  sudo apt-get install python3
+  ```
 
 ## Pi.Alert
 <!--- --------------------------------------------------------------------- --->
-1- Download Pi.Alert and uncmompress
+5.1 - Download Pi.Alert and uncompress
-```
+  ```
-  curl -LO https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_latest.tar
+  cd
+  curl -LO https://github.com/pucherot/Pi.Alert/raw/main/tar/pialert_latest.tar
   tar xvf pialert_latest.tar
   rm pialert_latest.tar
-```
+  ```
 
-2 - Public the front portal
+5.2 - Public the front portal
-```
+  ```
-  sudo ln -s /home/pi/pialert/front /var/www/html/pialert
+  sudo ln -s ~/pialert/front /var/www/html/pialert
-```
+  ```
 
-3 - Update lighttp config
+5.3 - Configure web server redirection
-```
+
-  sudo sh -c "printf '\n\n\$HTTP[\"host\"] == \"pi.alert\" {\n  server.document-root = \"/var/www/html/pialert/\"\n}\n' >> /etc/lighttpd/external.conf"
+  If you have configured your DNS server (Pi.hole or other) to resolve pi.alert
+  with the IP of your raspberry, youy must configure lighttpd to redirect these 
+  requests to the correct pialert web folder
+  ```
+  sudo cp ~/pialert/install/pialert_front.conf /etc/lighttpd/conf-available
+  sudo ln -s ../conf-available/pialert_front.conf /etc/lighttpd/conf-enabled/pialert_front.conf
   sudo /etc/init.d/lighttpd restart
-```
+  ```
 
-4 - If you want to use email reporting with gmail
+5.4 - If you want to use email reporting with gmail
   - Go to your Google Account https://myaccount.google.com/
   - On the left navigation panel, click Security
   - On the bottom of the page, in the Less secure app access panel,
     click Turn on access
   - Click Save button
 
-5 - Config Pialert parameters
+5.5 - Config Pialert parameters
-```
+  ```
-  nano  ~/pialert/back/pialert.conf
+  sed -i "s,'/home/pi/pialert','$HOME/pialert'," ~/pialert/config/pialert.conf          
-```
+  nano  ~/pialert/config/pialert.conf
-  - if you want to use email reporting, configure this parameters
+  ```
-```
+  - If you want to use email reporting, configure this parameters
-  REPORT_MAIL     = True
+    ```ini
-  SMTP_USER       = 'user@gmail.com'
+    REPORT_MAIL     = True
-  SMTP_PASS       = 'password'
+    SMTP_USER       = 'user@gmail.com'
-  REPORT_TO       = 'user@gmail.com'
+    SMTP_PASS       = 'password'
-```
+    REPORT_TO       = 'user@gmail.com'
+    ```
 
-  - if you want to update yout Dynamic DNS, configure this parameters
+  - If you want to update your Dynamic DNS, configure this parameters
-```
+    ```ini
-  DDNS_ACTIVE     = True
+    DDNS_ACTIVE     = True
-  DDNS_DOMAIN     = 'your_domain.freeddns.org'
+    DDNS_DOMAIN     = 'your_domain.freeddns.org'
-  DDNS_USER       = 'dynu_user'
+    DDNS_USER       = 'dynu_user'
-  DDNS_PASSWORD   = 'A0000000B0000000C0000000D0000000'
+    DDNS_PASSWORD   = 'A0000000B0000000C0000000D0000000'
-  DDNS_UPDATE_URL = 'https://api.dynu.com/nic/update?'
+    DDNS_UPDATE_URL = 'https://api.dynu.com/nic/update?'
-```
+    ```
 
-  - if you have installed Pi.hole and DHCP, activate this parameters
+  - If you have installed Pi.hole and DHCP, activate this parameters
-```
+    ```ini
-  PIHOLE_ACTIVE   = True
+    PIHOLE_ACTIVE   = True
-  DHCP_ACTIVE     = True
+    DHCP_ACTIVE     = True
-```
+    ```
 
-6 - Update vendors DB
+5.6 - Update vendors DB
-```
+  ```
   python ~/pialert/back/pialert.py update_vendors
-```
+  ```
+  or
+  ```
+  python3 ~/pialert/back/pialert.py update_vendors
+  ```
 
-7 - Test Pi.Alert Scan
+5.7 - Test Pi.Alert Scan
-```
+  ```
   python ~/pialert/back/pialert.py internet_IP
   python ~/pialert/back/pialert.py 1
-```
+  ```
+  or
+  ```
+  python3 ~/pialert/back/pialert.py internet_IP
+  python3 ~/pialert/back/pialert.py 1
+  ```
 
-8 - Add crontab jobs
+5.8 - Update crontab template with python3
-```
-  (crontab -l 2>/dev/null; cat ~/pialert/back/pialert.cron) | crontab -
-```
 
-9 - Use admin panel to configure the devices
+  If you prefer to use Python 3 (installed in the previous block), you must
+  update `pialert.cron` file with the correct command: `python3` instead of
+  `python`
+  ```
+  sed -i 's/python/python3/g' ~/pialert/install/pialert.cron
+  ```
+
+5.9 - Add crontab jobs
+  ```
+  (crontab -l 2>/dev/null; cat ~/pialert/install/pialert.cron) | crontab -
+  ```
+
+5.10 - Add permissions to the web-server user
+  ```
+  sudo chgrp -R www-data ~/pialert/db
+  chmod -R 770 ~/pialert/db
+  ```
+
+5.11 - Check DNS record for pi.alert (explained in point 2.7 of Pi.hole
+  installation)
+  - Add pi.alert DNS Record
+    ```
+    hostname -I
+    ```
+    - Pi-hole admin portal -> Local DNS -> DNS Records -> Add new domain /IP
+      - pi.alert    192.168.1.x
+      - (*replace 192.168.1.x with your Raspberry IP*)
+
+5.12 - Use admin panel to configure the devices
   - http://pi.alert/
+  - http://192.168.1.x/pialert/
+    - (*replace 192.168.1.x with your Raspberry IP*)
 
 
 ## Device Management
@@ -195,7 +296,7 @@ Stimated time: 20'
 
 ### License
   GPL 3.0
-  [Read more here](LICENSE.txt)
+  [Read more here](../LICENSE.txt)
 
 ### Contact
   pi.alert.application@gmail.com

docs/RAMDOM_MAC.md

@@ -16,12 +16,12 @@ WIFI's**, in this way, Pi.Alert will be able to identify the device, and it
 will not identify it as a new device every so often (every time IOS or Android
 decides to change the MAC).
 
-### IOS
+## IOS
 ![ios][ios]
 
   - [Use private Wi-Fi addresses in iOS 14](https://support.apple.com/en-us/HT211227)
 
-### Android
+## Android
 ![Android][Android]
 
   - [How to Disable MAC Randomization in Android 10](https://support.boingo.com/s/article/How-to-Disable-MAC-Randomization-in-Android-10-Android-Q)
@@ -30,7 +30,7 @@ decides to change the MAC).
 
 ### License
   GPL 3.0
-  [Read more here](LICENSE.txt)
+  [Read more here](../LICENSE.txt)
 
 ### Contact
   pi.alert.application@gmail.com

docs/VERSIONS_HISTORY.md

@@ -0,0 +1,28 @@
+# Pi.Alert Version History
+<!--- --------------------------------------------------------------------- --->
+
+  | Version | Description                                                     |
+  | ------- | --------------------------------------------------------------- |
+  |  v2.60  | Improved the compability of installation process (Ubuntu)       |
+  |  v2.56  | Bug fixing                                                      |
+  |  v2.55  | Bug fixing                                                      |
+  |  v2.52  | Bug fixing                                                      |
+  |  v2.51  | Bug fixing                                                      |
+  |  v2.50  | First public release                                            |
+
+
+## Pi.Alert v2.60
+<!--- --------------------------------------------------------------------- --->
+  - `pialert.conf` moved from `back` to `config` folder
+  - `pialert.conf` splitted in two files: `pialert.conf` and `version.conf`
+  - Added compatibility with Python 3 (default version installed with Ubuntu)
+  - Added compatibility in the Installation guide with Ubuntu server
+  - Eliminated some unnecessary packages from the installation
+
+
+### License
+  GPL 3.0
+  [Read more here](../LICENSE.txt)
+
+### Contact
+  pi.alert.application@gmail.com

docs/report_sample_1.html

@@ -1,3 +1,12 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  repot_sample.html - Back module. Sample email reporting in HTML format
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
 <html>
 
 <head>

docs/report_sample_2.html

@@ -1,3 +1,12 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  repot_sample.html - Back module. Sample email reporting in HTML format
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
 <html>
 
 <head>

front/php/templates/footer.php

@@ -1,10 +1,36 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  footer.php - Front module. Common footer to all the front pages 
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
   <!-- Main Footer -->
   <footer class="main-footer">
     <!-- Default to the left -->
-    &copy; 2021 Puche
+
+    <!-- 
+    &copy; 2020 Puche
+    -->
+    <?php
+      $conf_file = '../config/version.conf';
+      $conf_data = parse_ini_file($conf_file);
+      echo '<span style="display:inline-block; transform: rotate(180deg)">&copy;</span> '. $conf_data['VERSION_YEAR'] .' Puche';
+    ?>
+
     <!-- To the right -->
     <div class="pull-right no-hidden-xs">
-      Pi.alert&nbsp&nbsp2.52&nbsp&nbsp<small>(2021-01-11)</small>
+
+    <!-- 
+      Pi.Alert&nbsp&nbsp2.50&nbsp&nbsp<small>(2019-12-30)</small>
+    -->
+    <?php
+      $conf_file = '../config/version.conf';
+      $conf_data = parse_ini_file($conf_file);
+      echo 'Pi.Alert&nbsp&nbsp'. $conf_data['VERSION'] .'&nbsp&nbsp<small>('. $conf_data['VERSION_DATE'] .')</small>';
+    ?>
     </div>
   </footer>
 

front/php/templates/header.php

@@ -1,9 +1,18 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  header.php - Front module. Common header to all the front pages 
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
 <!DOCTYPE html> 
 <html>
 <head>
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <title>Pi.alert</title>
+  <title>Pi.Alert</title>
   <!-- Tell the browser to be responsive to screen width -->
   <meta content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" name="viewport">
   <!-- Bootstrap 3.3.7 -->
@@ -21,7 +30,7 @@
   <link rel="stylesheet" href="lib/AdminLTE/dist/css/skins/skin-yellow-light.min.css">
 
   
-  <!-- Pi.alert CSS -->
+  <!-- Pi.Alert CSS -->
   <link rel="stylesheet" href="css/pialert.css">
 
   <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
@@ -40,7 +49,7 @@
 </head>
 
 <!-- Layout Boxed Yellow -->
-<body class="hold-transition skin-yellow-light layout-boxed sidebar-mini" style="background-image: url('img/backgroud.png');">
+<body class="hold-transition skin-yellow-light layout-boxed sidebar-mini" style="background-image: url('img/background.png');">
 <!-- Site wrapper -->
 <div class="wrapper">
 
@@ -52,7 +61,7 @@
       <!-- mini logo for sidebar mini 50x50 pixels -->
       <span class="logo-mini">P<b>a</b></span>
       <!-- logo for regular state and mobile devices -->
-      <span class="logo-lg">Pi<b>.alert</b></span>
+      <span class="logo-lg">Pi<b>.Alert</b></span>
     </a>
 
     <!-- Header Navbar -->
@@ -73,14 +82,14 @@
             <!-- Menu Toggle Button -->
             <a href="#" class="dropdown-toggle" data-toggle="dropdown">
               <!-- The user image in the navbar-->
-              <img src="img/pialertLogoWhite.png" class="user-image" style="border-radius: initial" alt="Pi.alert Logo">
+              <img src="img/pialertLogoWhite.png" class="user-image" style="border-radius: initial" alt="Pi.Alert Logo">
               <!-- hidden-xs hides the username on small devices so only the image appears. -->
-              <span class="hidden-xs">Pi.alert</span>
+              <span class="hidden-xs">Pi.Alert</span>
             </a>
             <ul class="dropdown-menu">
               <!-- The user image in the menu -->
               <li class="user-header">
-                <img src="img/pialertLogoWhite.png" class="img-circle" alt="Pi.alert Logo" style="border-color:transparent">
+                <img src="img/pialertLogoWhite.png" class="img-circle" alt="Pi.Alert Logo" style="border-color:transparent">
 
                 <p>
                   Open Source Network Guard
@@ -91,15 +100,19 @@
               <li class="user-body">
                 <div class="row">
                   <div class="col-xs-4 text-center">
-                    <a href="https://github.com/pucherot/Pi.Alert">GitHub</a>
+                    <a target="_blank" href="https://github.com/pucherot/Pi.Alert">GitHub Pi.Alert</a>
                   </div>
                   <div class="col-xs-4 text-center">
-                    <a href="https://github.com/pucherot/Pi.Alert">Pi.Alert</a>
+                    <a href="mailto:pi.alert.application@gmail.com">email Support</a>
-                    <!-- <a href="#">Website</a> -->
                   </div>
+                  <div class="col-xs-4 text-center">
+                    <a target="_blank" href="https://github.com/pucherot/Pi.Alert/blob/main/LICENSE.txt">GNU GPLv3</a>
+                  </div>
+                  <!--
                   <div class="col-xs-4 text-center">
                     <a href="#">Updates</a>
                   </div>
+                  -->
                 </div>
                 <!-- /.row -->
               </li>
@@ -118,11 +131,11 @@
       <!-- Sidebar user panel (optional) -->
       <div class="user-panel">
         <a href="/" class="logo">
-          <img src="img/pialertLogoGray80.png" class="img-responsive" alt="Pi.alert Logo"/>
+          <img src="img/pialertLogoGray80.png" class="img-responsive" alt="Pi.Alert Logo"/>
         </a>
         <div class="pull-left image">
 <!--
-          <br><img src="img/pialertLogoBlack.png" class="img-responsive" alt="Pi.alert Logo" style="display: table; table-layout: fixed;" />
+          <br><img src="img/pialertLogoBlack.png" class="img-responsive" alt="Pi.Alert Logo" style="display: table; table-layout: fixed;" />
 -->
         </div>
 

install/create_tar.sh

@@ -1,16 +0,0 @@
-#
-PIALERT_VERSION=2.52
-PIALERT_DEV_PATH=/media/WD_4TB/dev
-
-cd $PIALERT_DEV_PATH
-
-tar tvf pialert/install/pialert_$PIALERT_VERSION.tar | wc -l
-rm pialert/install/pialert_$PIALERT_VERSION.tar
-
-tar cvf pialert/install/pialert_$PIALERT_VERSION.tar --exclude="pialert/install" --exclude="pialert/.git" pialert | wc -l
-
-rm pialert/install/pialert_latest.tar
-ln -s pialert_$PIALERT_VERSION.tar pialert/install/pialert_latest.tar
-
-
-

install/index.html

@@ -0,0 +1,11 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  index.html - Redirect file to pialert subdirectory
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
+<meta http-equiv="refresh" content="0; url=pialert"/>
+<meta http-equiv="Cache-Control" content="no-store" />

install/pialert.cron

@@ -0,0 +1,13 @@
+#-------------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  pialert.cron - Back module. Crontab jobs
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#-------------------------------------------------------------------------------
+
+0 3 * * 1      python ~/pialert/back/pialert.py update_vendors >~/pialert/log/pialert.vendors.log  2>&1
+*/1 * * * *    python ~/pialert/back/pialert.py internet_IP    >~/pialert/log/pialert.IP.log       2>&1
+*/5 * * * *    python ~/pialert/back/pialert.py 1              >~/pialert/log/pialert.1.log        2>&1
+*/15 * * * *   python ~/pialert/back/pialert.py 15             >~/pialert/log/pialert.15.log       2>&1

install/pialert_front.conf

@@ -0,0 +1,12 @@
+# ------------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  index.html - Redirect file to pialert subdirectory
+# ------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+# ------------------------------------------------------------------------------
+
+$HTTP["host"] == "pi.alert" {
+  server.document-root = "/var/www/html/pialert/"
+}

install/pialert_install.sh

@@ -0,0 +1,728 @@
+#!/bin/bash
+# ------------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  pialert_install.sh - Installation script
+# ------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+# ------------------------------------------------------------------------------
+
+# stop on errors
+set -e
+
+# ------------------------------------------------------------------------------
+# Variables
+# ------------------------------------------------------------------------------
+COLS=70
+ROWS=12
+
+INSTALL_DIR=~
+PIALERT_HOME="$INSTALL_DIR/pialert"
+
+LIGHTTPD_CONF_DIR="/etc/lighttpd"
+WEBROOT="/var/www/html"
+PIALERT_DEFAULT_PAGE=false
+
+LOG="pialert_install_`date +"%Y-%m-%d_%H-%M"`.log"
+
+PIHOLE_INSTALL=false
+PIHOLE_ACTIVE=false
+DHCP_ACTIVATE=false
+DHCP_ACTIVE=false
+
+DHCP_RANGE_START="192.168.1.200"
+DHCP_RANGE_END="192.168.1.251"
+DHCP_ROUTER="192.168.1.1"
+DHCP_LEASE="1"
+DHCP_DOMAIN="local"
+
+USE_PYTHON_VERSION=0
+PYTHON_BIN=python
+
+REPORT_MAIL=False
+REPORT_TO=user@gmail.com
+SMTP_SERVER=smtp.gmail.com
+SMTP_PORT=587
+SMTP_USER=user@gmail.com
+SMTP_PASS=password
+
+DDNS_ACTIVE=False
+DDNS_DOMAIN='your_domain.freeddns.org'
+DDNS_USER='dynu_user'
+DDNS_PASSWORD='A0000000B0000000C0000000D0000000'
+DDNS_UPDATE_URL='https://api.dynu.com/nic/update?'
+
+
+# ------------------------------------------------------------------------------
+# Main
+# ------------------------------------------------------------------------------
+main() {
+  print_superheader "Pi.Alert Installation"
+  log "`date`"
+  log "Logfile: $LOG"
+
+  check_pialert_home
+ 
+  print_msg "Use: - http://pi.alert/"
+  ask_yesno "This script will install Pi.Alert in this system using this path:\n$PIALERT_HOME" \
+           "Do you want to continue ?"
+  if ! $ANSWER ; then
+   exit 1
+  fi
+ 
+  ask_config
+
+  msgbox "Configuration finished. To updete the configuration, edit file:" \
+    "$PIALERT_HOME/config/pialert.conf"
+
+  msgbox "" "The installation will start now"
+
+  install_pihole
+  activate_DHCP
+  add_pialert_DNS
+  install_lighttpd
+  install_arpscan
+  install_python
+  install_pialert
+
+  print_header "Installation process finished"
+  print_msg "Use: - http://pi.alert/"
+  print_msg "     - http://`hostname -I | tr -d ' '`/pialert/"
+  print_msg "To access Pi.Alert web"
+  print_msg ""
+
+  move_logfile
+}
+
+# ------------------------------------------------------------------------------
+# Ask config questions
+# ------------------------------------------------------------------------------
+ask_config() {
+  # Ask Pi-hole Installation
+  PIHOLE_ACTIVE=false
+  if [ -e /usr/local/bin/pihole ] || [ -e /etc/pihole ]; then
+    PIHOLE_ACTIVE=true
+  fi
+
+  PIHOLE_INSTALL=false
+  if $PIHOLE_ACTIVE ; then
+    msgbox "Pi-hole is already installed in this system." \
+           "Perfect: Pi-hole Installation not necessary"
+  else
+    ask_yesno "Pi-hole is not installed." \
+      "Do you want to install Pi-hole before installing Pi.Alert ?" "YES"
+    if $ANSWER ; then
+      PIHOLE_INSTALL=true
+      msgbox "In the installation wizard of Pi-hole, select this options" \
+        "'Install web admin interface' & 'Install web server lighttpd'"
+    fi
+  fi
+
+  # Ask DHCP Activation
+  DHCP_ACTIVE=false
+  DHCP_ACTIVATE=false
+  if $PIHOLE_ACTIVE ; then
+    DHCP_ACTIVE=`sudo grep DHCP_ACTIVE /etc/pihole/setupVars.conf |
+      awk -F= '/./{print $2}'`
+
+    if ! $DHCP_ACTIVE ; then
+      ask_yesno "Pi-hole DHCP server is not active." \
+        "Do you want to activate Pi-hole DHCP server ?"
+       if $ANSWER ; then
+         DHCP_ACTIVATE=true
+       fi
+    fi
+
+  elif $PIHOLE_INSTALL ; then
+    ask_yesno "Pi-hole installation." \
+      "Do you want to activate Pi-hole DHCP server ?"
+    if $ANSWER ; then
+      DHCP_ACTIVATE=true
+    fi
+  fi
+
+  if $DHCP_ACTIVATE ; then
+    msgbox "Default DHCP options will be used. Range=$DHCP_RANGE_START - $DHCP_RANGE_END / Router=$DHCP_ROUTER / Domain=$DHCP_DOMAIN / Leases=$DHCP_LEASE h." \
+           "Yo can change this values in your Pi-hole Admin Portal"
+    msgbox "Make sure your router's DHCP server is disabled" \
+           "when using the Pi-hole DHCP server!"
+  fi
+
+  # Ask Pi.Alert deafault page
+  PIALERT_DEFAULT_PAGE=false
+  if ! $PIHOLE_ACTIVE && ! $PIHOLE_INSTALL; then
+    ask_yesno "As Pi-hole is not going to be available in this system," \
+      "Do you want to use Pi.Alert as default web server page ?" "YES"
+    if $ANSWER ; then
+      PIALERT_DEFAULT_PAGE=true
+    fi
+  fi
+  
+  # Ask Python version
+  ask_option "What Python version do you want to use ?" \
+    3 \
+    0 " - Use Python already installed in the system (DEFAULT)" \
+    2 " - Use Python 2" \
+    3 " - Use Python 3"
+  if [ "$ANSWER" = "" ] ; then
+    USE_PYTHON_VERSION=0
+  else
+    USE_PYTHON_VERSION=$ANSWER
+  fi
+
+  # Ask e-mail notification config
+  MAIL_REPORT=false
+  ask_yesno "Pi.Alert can notify you by e-mail when a network event occurs" \
+    "Do you want to activate this feature ?"
+  if $ANSWER ; then
+    ask_yesno "e-mail notification needs a SMTP server (i.e. smtp.gmail.com)" \
+      "Do you want to continue activating this feature ?"
+    MAIL_REPORT=$ANSWER
+  fi
+
+  if $MAIL_REPORT ; then
+    ask_input "" "Notify alert to this e-mail address:" "user@gmail.com"
+    REPORT_TO=$ANSWER
+
+    ask_input "" "SMTP server:" "smtp.gmail.com"
+    SMTP_SERVER=$ANSWER
+
+    ask_input "" "SMTP user:" "user@gmail.com"
+    SMTP_USER=$ANSWER
+
+    ask_input "" "SMTP password:" "password"
+    SMTP_PASS=$ANSWER
+  fi
+
+  # Ask Dynamic DNS config
+  DDNS_ACTIVE=false
+  ask_yesno "Pi.Alert can update your Dynamic DNS IP (i.e with www.dynu.net)" \
+    "Do you want to activate this feature ?"
+  if $ANSWER ; then
+    ask_yesno "Dynamics DNS updater needs a DNS with IP Update Protocol" \
+      "(i.e with www.dynu.net). Do you want to continue ?"
+    DDNS_ACTIVE=$ANSWER
+  fi
+
+  if $DDNS_ACTIVE ; then
+    ask_input "" "Domain to update:" "your_domain.freeddns.org"
+    DDNS_DOMAIN=$ANSWER
+
+    ask_input "" "DDNS user:" "dynu_user"
+    DDNS_USER=$ANSWER
+
+    ask_input "" "DDNS password:" "A0000000B0000000C0000000D0000000"
+    DDNS_PASSWORD=$ANSWER
+
+    ask_input "" "URL to update DDNS IP:" "https://api.dynu.com/nic/update?"
+    DDNS_UPDATE_URL=$ANSWER
+  fi
+}
+
+# ------------------------------------------------------------------------------
+# Install Pi-hole
+# ------------------------------------------------------------------------------
+install_pihole() {
+  print_header "Pi-hole"
+
+  if ! $PIHOLE_INSTALL ; then
+    return
+  fi
+
+  print_msg "- Checking if Pi-hole is installed..."
+  if [ -e /usr/local/bin/pihole ] || [ -e /etc/pihole ]; then
+    print_msg "  - Pi-hole already installed"
+    print_msg "`pihole -v 2>&1`"
+    print_msg ""
+
+    PIHOLE_ACTIVE=true
+    return
+  fi
+
+  print_msg "- Installing Pi-hole..."
+  print_msg "  - Pi-hole has its own logfile"
+  curl -sSL https://install.pi-hole.net | bash
+  print_msg ""
+  PIHOLE_ACTIVE=true
+}
+
+# ------------------------------------------------------------------------------
+# Activate DHCP
+# ------------------------------------------------------------------------------
+activate_DHCP() {
+  if ! $DHCP_ACTIVATE ; then
+    return
+  fi
+
+  if ! $PIHOLE_ACTIVE ; then
+    return
+  fi
+
+  print_msg "- Checking if DHCP is active..."
+  if [ -e /etc/pihole ]; then
+    DHCP_ACTIVE= \
+      `grep DHCP_ACTIVE /etc/pihole/setupVars.conf | awk -F= '/./{print $2}'`
+  fi
+
+  if $DHCP_ACTIVE ; then
+    print_msg "  - DHCP already active"
+  fi
+
+  print_msg "- Activating DHCP..."
+  sudo pihole -a enabledhcp "$DHCP_RANGE_START" "$DHCP_RANGE_END" \
+    "$DHCP_ROUTER" "$DHCP_LEASE" "$DHCP_DOMAIN"                   2>&1 >> "$LOG"
+  DHCP_ACTIVE=true
+}
+
+# ------------------------------------------------------------------------------
+# Add Pi.Alert DNS
+# ------------------------------------------------------------------------------
+add_pialert_DNS() {
+  if ! $PIHOLE_ACTIVE ; then
+    return
+  fi
+
+  print_msg "- Checking if 'pi.alert' is configured in Local DNS..."
+  if grep -Fq pi.alert /etc/pihole/custom.list; then
+    print_msg "  - 'pi.alert' already in Local DNS..."
+    return
+  fi
+
+  print_msg "- Adding 'pi.alert' to Local DNS..."
+  sudo sh -c "echo `hostname -I` pi.alert >> /etc/pihole/custom.list" \
+                                                                  2>&1 >> "$LOG"
+  sudo pihole restartdns                                          2>&1 >> "$LOG"
+}
+
+
+# ------------------------------------------------------------------------------
+# Install Lighttpd & PHP
+# ------------------------------------------------------------------------------
+install_lighttpd() {
+  print_header "Lighttpd & PHP"
+
+  print_msg "- Installing lighttpd..."
+  sudo apt-get install lighttpd -y                                2>&1 >> "$LOG"
+  
+  print_msg "- Installing PHP..."
+  sudo apt-get install php php-cgi php-fpm php-sqlite3 -y         2>&1 >> "$LOG"
+
+  print_msg "- Activating PHP..."
+  sudo lighttpd-enable-mod fastcgi-php 2>&1                 >>"$LOG" || ERRNO=$? 
+  log_no_screen "-- Command error code: $ERRNO"
+  if [ $ERRNO -eq 1 ] ; then
+    process_error "Error activating PHP"
+  fi
+  
+  print_msg "- Restarting lighttpd..."
+  sudo /etc/init.d/lighttpd restart                               2>&1 >> "$LOG"
+}
+
+# ------------------------------------------------------------------------------
+# Install arp-scan
+# ------------------------------------------------------------------------------
+install_arpscan() {
+  print_header "arp-scan"
+
+  print_msg "- Installing arp-scan..."
+  sudo apt-get install arp-scan -y                                2>&1 >> "$LOG"
+
+  print_msg "- Testing arp-scan..."
+  sudo arp-scan -l | head -n -3 | tail +3                        | tee -a "$LOG"
+}
+  
+
+# ------------------------------------------------------------------------------
+# Install Python
+# ------------------------------------------------------------------------------
+install_python() {
+  print_header "Python"
+
+  check_python_versions
+
+  if [ $USE_PYTHON_VERSION -eq 0 ] ; then
+    print_msg "- Using the available Python version installed"
+    if $PYTHON3 ; then
+      print_msg "  - Python 3 is available"
+      USE_PYTHON_VERSION=3
+    elif $PYTHON2 ; then
+      print_msg "  - Python 2 is available"
+      USE_PYTHON_VERSION=2
+    else
+      print_msg "  - Python is not available in this system"
+      print_msg "    - Python 3 will be installed"
+      USE_PYTHON_VERSION=3
+    fi
+    echo ""
+  fi
+
+  if [ $USE_PYTHON_VERSION -eq 2 ] ; then
+    if $PYTHON2 ; then
+      print_msg "- Using Python 2"
+    else
+      print_msg "- Installing Python 2..."
+      sudo apt-get install python -y                              2>&1 >> "$LOG"
+    fi
+    PYTHON_BIN="python"
+  elif [ $USE_PYTHON_VERSION -eq 3 ] ; then
+    if $PYTHON3 ; then
+      print_msg "- Using Python 3"
+    else
+      print_msg "- Installing Python 3..."
+      sudo apt-get install python -y                              2>&1 >> "$LOG"
+    fi
+    PYTHON_BIN="python3"
+  else
+    process_error "Unknown Python version to use: $USE_PYTHON_VERSION"
+  fi
+}
+
+# ------------------------------------------------------------------------------
+# Check Python versions available
+# ------------------------------------------------------------------------------
+check_python_versions() {
+  print_msg "- Checking Python 2..."
+  if [ -f /usr/bin/python ] ; then
+    print_msg "  - Python 2 is installed"
+    print_msg "    - `python -V 2>&1`"
+    PYTHON2=true
+  else
+    print_msg "  - Python 2 is NOT installed"
+    PYTHON2=false
+  fi
+  echo ""
+
+  print_msg "- Checking Python 3..."
+  if [ -f /usr/bin/python3 ] ; then
+    print_msg "  - Python 3 is installed"
+    print_msg "    - `python3 -V 2>&1`"
+    PYTHON3=true
+  else
+    print_msg "  - Python 3 is NOT installed"
+    PYTHON3=false
+  fi
+  echo ""
+}
+
+
+# ------------------------------------------------------------------------------
+# Install Pi.Alert
+# ------------------------------------------------------------------------------
+install_pialert() {
+  print_header "Pi.Alert"
+
+  download_pialert
+  configure_pialert
+  test_pialert
+  add_jobs_to_crontab
+  publish_pialert
+  set_pialert_default_page
+}
+
+# ------------------------------------------------------------------------------
+# Download and uncompress Pi.Alert
+# ------------------------------------------------------------------------------
+download_pialert() {
+  if [ -f "$INSTALL_DIR/pialert_latest.tar" ] ; then
+    print_msg "- Deleting previous downloaded tar file"
+    rm -r "$INSTALL_DIR/pialert_latest.tar"
+  fi
+  
+  print_msg "- Downloading installation tar file..."
+  curl -Lo "$INSTALL_DIR/pialert_latest.tar" \
+    https://github.com/pucherot/Pi.Alert/raw/main/tar/pialert_latest.tar
+  echo ""
+
+  print_msg "- Uncompressing tar file"
+  tar xf "$INSTALL_DIR/pialert_latest.tar" -C "$INSTALL_DIR" \
+    --checkpoint=100 --checkpoint-action="ttyout=."               2>&1 >> "$LOG"
+  echo ""
+
+  print_msg "- Deleting downloaded tar file..."
+  rm -r "$INSTALL_DIR/pialert_latest.tar"
+}
+
+# ------------------------------------------------------------------------------
+# Configure Pi.Alert parameters
+# ------------------------------------------------------------------------------
+configure_pialert() {
+  print_msg "- Settting Pi.Alert config file"
+
+  set_pialert_parameter PIALERT_PATH    "'$PIALERT_HOME'"
+  
+  set_pialert_parameter REPORT_MAIL     "$REPORT_MAIL"
+  set_pialert_parameter REPORT_TO       "'$REPORT_TO'"
+  set_pialert_parameter SMTP_SERVER     "'$SMTP_SERVER'"
+  set_pialert_parameter SMTP_PORT       "$SMTP_PORT"
+  set_pialert_parameter SMTP_USER       "'$SMTP_USER'"
+  set_pialert_parameter SMTP_PASS       "'$SMTP_PASS'"
+
+  set_pialert_parameter DDNS_ACTIVE     "$DDNS_ACTIVE"
+  set_pialert_parameter DDNS_DOMAIN     "'$DDNS_DOMAIN'"
+  set_pialert_parameter DDNS_USER       "'$DDNS_USER'"
+  set_pialert_parameter DDNS_PASSWORD   "'$DDNS_PASSWORD'"
+  set_pialert_parameter DDNS_UPDATE_URL "'$DDNS_UPDATE_URL'"
+
+  set_pialert_parameter PIHOLE_ACTIVE   "$PIHOLE_ACTIVE"
+  set_pialert_parameter DHCP_ACTIVE     "$DHCP_ACTIVE"
+}
+
+# ------------------------------------------------------------------------------
+# Set Pi.Alert parameter
+# ------------------------------------------------------------------------------
+set_pialert_parameter() {
+  if [ "$2" = "false" ] ; then
+    VALUE="False"
+  elif [ "$2" = "true" ] ; then
+    VALUE="True"
+  else
+    VALUE="$2"
+  fi
+  
+  sed -i "/^$1.*=/s|=.*|= $VALUE|" $PIALERT_HOME/config/pialert.conf \
+    2>&1 >> "$LOG"
+}
+
+
+# ------------------------------------------------------------------------------
+# Test Pi.Alert
+# ------------------------------------------------------------------------------
+test_pialert() {
+  print_msg "- Testing Pi.Alert HW vendors database update process..."
+  print_msg "*** PLEASE WAIT A COUPLE OF MINUTES..."
+  stdbuf -i0 -o0 -e0 \
+    $PYTHON_BIN $PIALERT_HOME/back/pialert.py update_vendors_silent  2>&1 \
+                                                                | tee -ai "$LOG"
+
+  echo ""
+  print_msg "- Testing Pi.Alert Internet IP Lookup..."
+  stdbuf -i0 -o0 -e0 \
+    $PYTHON_BIN $PIALERT_HOME/back/pialert.py internet_IP  2>&1 | tee -ai "$LOG"
+
+  echo ""
+  print_msg "- Testing Pi.Alert Network scan..."
+  print_msg "*** PLEASE WAIT A COUPLE OF MINUTES..."
+  stdbuf -i0 -o0 -e0 \
+    $PYTHON_BIN $PIALERT_HOME/back/pialert.py 1            2>&1 | tee -ai "$LOG"
+}
+
+# ------------------------------------------------------------------------------
+# Add Pi.Alert jobs to crontab
+# ------------------------------------------------------------------------------
+add_jobs_to_crontab() {
+  if crontab -l 2>/dev/null | grep -Fq pialert ; then
+    print_msg "- Pi.Alert crontab jobs already exists. This is your crontab:"
+    crontab -l | grep -F pialert                           2>&1 | tee -ai "$LOG"
+    return    
+  fi
+
+  print_msg "- Adding jobs to the crontab..."
+  if [ $USE_PYTHON_VERSION -eq 3 ] ; then
+    sed -i "s/\<python\>/$PYTHON_BIN/g" $PIALERT_HOME/install/pialert.cron
+  fi
+
+  (crontab -l 2>/dev/null || : ; cat $PIALERT_HOME/install/pialert.cron) | \
+  crontab -
+}
+
+# ------------------------------------------------------------------------------
+# Publish Pi.Alert web
+# ------------------------------------------------------------------------------
+publish_pialert() {
+  if [ -e "$WEBROOT/pialert" ] || [ -L "$WEBROOT/pialert" ] ; then
+    print_msg "- Deleting previous Pi.Alert site"
+    sudo rm -r "$WEBROOT/pialert"                                 2>&1 >> "$LOG"
+  fi
+
+  print_msg "- Setting permissions..."
+  sudo chgrp -R www-data $PIALERT_HOME/db                         2>&1 >> "$LOG"
+  chmod -R 770 $PIALERT_HOME/db                                   2>&1 >> "$LOG"
+
+  print_msg "- Publishing Pi.Alert web..."
+  sudo ln -s "$PIALERT_HOME/front" "$WEBROOT/pialert"             2>&1 >> "$LOG"
+
+  print_msg "- Configuring http://pi.alert/ redirection..."
+  if [ -e "$LIGHTTPD_CONF_DIR/conf-available/pialert_front.conf" ] ; then
+    sudo rm -r "$LIGHTTPD_CONF_DIR/conf-available/pialert_front.conf" \
+                                                                  2>&1 >> "$LOG"
+  fi
+  sudo cp "$PIALERT_HOME/install/pialert_front.conf" \
+          "$LIGHTTPD_CONF_DIR/conf-available"                     2>&1 >> "$LOG"
+
+  if [ -e "$LIGHTTPD_CONF_DIR/conf-enabled/pialert_front.conf" ] || \
+     [ -L "$LIGHTTPD_CONF_DIR/conf-enabled/pialert_front.conf" ] ; then
+    sudo rm -r "$LIGHTTPD_CONF_DIR/conf-enabled/pialert_front.conf" \
+                                                                  2>&1 >> "$LOG"
+  fi
+
+  sudo ln -s ../conf-available/pialert_front.conf \
+    "$LIGHTTPD_CONF_DIR/conf-enabled/pialert_front.conf"          2>&1 >> "$LOG"
+
+  print_msg "- Restarting lighttpd..."
+  sudo /etc/init.d/lighttpd restart                               2>&1 >> "$LOG"
+}
+
+# ------------------------------------------------------------------------------
+# Set Pi.Alert the default web server page
+# ------------------------------------------------------------------------------
+set_pialert_default_page() {
+  if ! $PIALERT_DEFAULT_PAGE ; then
+    return
+  fi
+  
+  print_msg "- Setting Pi.Alert as default web server page..."
+
+  if [ -e "$WEBROOT/index.lighttpd.html" ] ; then
+    if [ -e "$WEBROOT/index.lighttpd.html.orig" ] ; then
+      sudo rm "$WEBROOT/index.lighttpd.html"                      2>&1 >> "$LOG"
+    else
+      sudo mv "$WEBROOT/index.lighttpd.html" \
+              "$WEBROOT/index.lighttpd.html.orig"                 2>&1 >> "$LOG"
+    fi
+  fi
+
+  if [ -e "$WEBROOT/index.html" ] || [ -L "$WEBROOT/index.html" ] ; then
+    if [ -e "$WEBROOT/index.html.orig" ] ; then
+      sudo rm "$WEBROOT/index.html"                               2>&1 >> "$LOG"
+    else
+      sudo mv "$WEBROOT/index.html" "$WEBROOT/index.html.orig"    2>&1 >> "$LOG"
+    fi
+  fi
+
+  sudo cp "$PIALERT_HOME/install/index.html" "$WEBROOT/index.html" 2>&1 >>"$LOG"
+}
+
+# ------------------------------------------------------------------------------
+# Check Pi.Alert Installation Path
+# ------------------------------------------------------------------------------
+check_pialert_home() {
+  mkdir -p "$INSTALL_DIR"
+  if [ ! -d "$INSTALL_DIR" ] ; then
+    process_error "Installation path does not exists: $INSTALL_DIR"
+  fi
+
+  if [ -e "$PIALERT_HOME" ] || [ -L "$PIALERT_HOME" ] ; then
+    process_error "Pi.Alert path already exists: $PIALERT_HOME"
+  fi
+}
+
+
+# ------------------------------------------------------------------------------
+# Move Logfile
+# ------------------------------------------------------------------------------
+move_logfile() {
+  NEWLOG="$PIALERT_HOME/log/$LOG"
+
+  mkdir -p "$PIALERT_HOME/log"
+  mv $LOG $NEWLOG
+
+  LOG="$NEWLOG"
+  NEWLOG=""
+}
+
+
+# ------------------------------------------------------------------------------
+# ASK
+# ------------------------------------------------------------------------------
+msgbox() {
+  LINE1=$(printf "%*s" $(((${#1}+$COLS-5)/2)) "$1")
+  LINE2=$(printf "%*s" $(((${#2}+$COLS-5)/2)) "$2")
+
+  whiptail --title "Pi.Alert Installation" --msgbox "$LINE1\\n\\n$LINE2" \
+    $ROWS $COLS
+}
+
+ask_yesno() {
+  LINE1=$(printf "%*s" $(((${#1}+$COLS-5)/2)) "$1")
+  LINE2=$(printf "%*s" $(((${#2}+$COLS-5)/2)) "$2")
+
+  if [ "$3" = "YES" ]; then
+    DEF_BUTTON=""
+  else
+    DEF_BUTTON="--defaultno"
+  fi
+
+  if whiptail --title "Pi.Alert Installation" --yesno $DEF_BUTTON \
+              "$LINE1\\n\\n$LINE2" $ROWS $COLS; then
+    ANSWER=true
+  else
+    ANSWER=false
+  fi
+}
+
+ask_option() {
+  MENU_ARGS=("$@")
+  MENU_ARGS=("${MENU_ARGS[@]:1}")
+
+  ANSWER=$(whiptail --title "Pi.Alert Installation" --menu "$1" $ROWS $COLS \
+    "${MENU_ARGS[@]}"  3>&2 2>&1 1>&3  || : )
+}
+
+ask_input() {
+  LINE1=$(printf "%*s" $(((${#1}+$COLS-5)/2)) "$1")
+  LINE2=$(printf "%*s" $(((${#2}+$COLS-5)/2)) "$2")
+
+  ANSWER=$(whiptail --title "Pi.Alert Installation" --inputbox \
+    "$LINE1\\n\\n$LINE2" $ROWS $COLS $3  3>&2 2>&1 1>&3  || : )
+
+  if [ "$ANSWER" = "" ] ; then
+    ANSWER=$3
+  fi
+}
+
+
+# ------------------------------------------------------------------------------
+# Log
+# ------------------------------------------------------------------------------
+log() {
+  echo "$1" | tee -a "$LOG"
+}
+
+log_no_screen () {
+  echo "$1" >> "$LOG"
+}
+
+log_only_screen () {
+  echo "$1"
+}
+
+print_msg() {
+  log_no_screen ""
+  log "$1"
+}
+
+print_superheader() {
+  log ""
+  log "############################################################"
+  log " $1"
+  log "############################################################"  
+}
+
+print_header() {
+  log ""
+  log "------------------------------------------------------------"
+  log " $1"
+  log "------------------------------------------------------------"
+}
+
+process_error() {
+  log "\n"
+  log "************************************************************"
+  log "************************************************************"
+  log "**            ERROR INSTALLING PI.ALERT                   **"
+  log "************************************************************"
+  log "************************************************************"
+  log ""
+  log "$1"
+  log ""
+  log "Use 'cat $LOG' to view installation log"
+  log ""
+
+  msgbox "****** ERROR INSTALLING Pi.ALERT ******" "$1"
+  exit 1
+}
+
+# ------------------------------------------------------------------------------
+  main
+  exit 0

log/IP_changes.log

@@ -1 +1,10 @@
+#-------------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  IP_changes.log - Back module. Logfile for Internet IP changes
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#-------------------------------------------------------------------------------
+
 2021-01-01 00:00:00	0.0.0.0

log/report_output.html

@@ -1,3 +1,12 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  repot_template.html - Back module. Template to email reporting in HTML format
+#-------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
 <html>
 
 <head>

tar/create_tar.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+# ------------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  create_tar.sh - Create the installation file
+# ------------------------------------------------------------------------------
+#  Puche 2021        pi.alert.application@gmail.com        GNU GPLv3
+# ------------------------------------------------------------------------------
+
+PIALERT_VERSION=`awk '$1=="VERSION" { print $3 }' ../config/version.conf | tr -d \'`
+PIALERT_DEV_PATH=/media/WD_4TB/dev
+
+# ------------------------------------------------------------------------------
+cd $PIALERT_DEV_PATH
+pwd
+
+# ------------------------------------------------------------------------------
+ls -l pialert/tar/pialert*.tar
+tar tvf pialert/tar/pialert_latest.tar | wc -l
+rm pialert/tar/pialert_*.tar
+
+# ------------------------------------------------------------------------------
+tar cvf pialert/tar/pialert_$PIALERT_VERSION.tar --exclude="pialert/tar" --exclude="pialert/.git" pialert | wc -l
+
+ln -s pialert_$PIALERT_VERSION.tar pialert/tar/pialert_latest.tar
+ls -l pialert/tar/pialert*.tar
+