From 7767eaae2e36c239d3c1a33290186e11e3906642 Mon Sep 17 00:00:00 2001
From: Thuban <thuban@yeuxdelibad.net>
Date: Wed, 09 Aug 2017 14:29:19 +0000
Subject: [PATCH] typo

---
 vilain.py |  191 +++++++++++++++++++++++++++++------------------
 1 files changed, 116 insertions(+), 75 deletions(-)

diff --git a/vilain.py b/vilain.py
index 24e2ff4..352f1f7 100755
--- a/vilain.py
+++ b/vilain.py
@@ -4,6 +4,7 @@
 
 """
 Author :      thuban <thuban@yeuxdelibad.net>  
+              Vincent <vincent.delft@gmail.com>
 Licence :     MIT
 Require : python >= 3.5
 
@@ -13,9 +14,6 @@
               In pf.conf, add : 
                     table <vilain_bruteforce> persist
                     block quick from <vilain_bruteforce> 
-
-              You might want to add a cron task to remove old banned IP. As example, to ban for one day max : 
-                    pfctl -t vilain_bruteforce -T expire 86400
 
               To see banned IP : 
                     pfctl -t vilain_bruteforce -T show
@@ -29,81 +27,100 @@
 import subprocess
 import asyncio
 import time
-from multiprocessing import Process
 
-configfile = "/etc/vilain.conf"
-version = "0.3"
+CONFIGFILE = "/etc/vilain.conf"
+VERSION = "0.5"
 vilain_table = "vilain_bruteforce"
-logfile = "/var/log/daemon"
-sleeptime = 0.5
+LOGFILE = "/var/log/daemon"
 
 if os.geteuid() != 0:
     print("Only root can use this tool")
-    sys.exit()
+    sys.exit(1)
 
 # Configure logging
 logger = logging.getLogger(__name__)
-logging.basicConfig(filename=logfile,
+logging.basicConfig(filename=LOGFILE,
                     format='%(asctime)s %(module)s:%(funcName)s:%(message)s',
                     datefmt='%H:%M:%S')
-logger.setLevel(logging.DEBUG)
-ch = logging.StreamHandler(sys.stdout)
-logger.addHandler(ch)
+logger.setLevel(logging.INFO)
 
 # functions
 def readconfig():
-    if not os.path.isfile(configfile):
+    logger.info('Read config file: {}'.format(CONFIGFILE))
+    if not os.path.isfile(CONFIGFILE):
         logging.error("Can't read config file, exiting...")
         sys.exit(1)
 
     config = configparser.ConfigParser()
-    config.read(configfile)
+    config.read(CONFIGFILE)
     return(config)
 
 def load_config():
     c = readconfig()
     d = c.defaults()
     watch_while = int(d['watch_while'])
-    maxtries = int(d['maxtries'])
-    vilain_table = d['vilain_table']
+    VILAIN_TABLE = d['vilain_table']
+    default_maxtries = int(d['maxtries'])
+    sleeptime = float(d['sleeptime'])
+    ignore_ips = []
 
     if c.has_section('ignoreip'):
-        ignoreip = [ i[1] for i in c.items('ignoreip') if i[0] not in c.defaults()]
-    else:
-        ignoreip = []
-    return(watch_while, maxtries, vilain_table, ignoreip)
+        ignoreips = [ i[1] for i in c.items('ignoreip') if i[0] not in c.defaults()]
+    return(watch_while, default_maxtries, vilain_table, ignoreips, sleeptime)
 
 def load_sections():
     c = readconfig()
     for s in c.sections():
         if c.has_option(s,'logfile'):
-            logfile = c.get(s,'logfile')
+            LOGFILE = c.get(s,'logfile')
             regex = c.get(s,'regex')
-            d = {'name' : s, 'logfile':logfile, 'regex':regex}
+            #we take the default value of maxtries
+            maxtries = c.defaults()['maxtries']
+            if c.has_option(s,'maxtries'):
+                #if we have a maxtries defined in the section, we overwrite the default
+                maxtries = int(c.get(s,'maxtries'))
+            d = {'name' : s, 'logfile':LOGFILE, 'regex':regex, 'maxtries': maxtries}
             yield d
 
 class Vilain():
     def __init__(self):
+        logger.info('Start vilain version {}'.format(VERSION))
         self.loop = asyncio.get_event_loop()
-        self.watch_while, self.maxtries, self.vilain_table, self.ignore_ip = load_config()
-        #self.bad_ip_queue = []
+        self.watch_while, self.default_maxtries, self.vilain_table, self.ignore_ips, self.sleeptime = load_config()
+        self.ip_seen_at = {}
+        self.load_bad_ips()
         self.bad_ip_queue = asyncio.Queue(loop=self.loop)
 
         for entry in load_sections():
-            logger.info("Start vilain for {}".format(entry['name']))
-            asyncio.ensure_future(self.check_logs(entry['logfile'], entry['regex'], entry['name']))
+            logger.info("Start vilain for {}".format(entry))
+            asyncio.ensure_future(self.check_logs(entry['logfile'], entry['maxtries'], entry['regex'], entry['name']))
 
         asyncio.ensure_future(self.ban_ips())
+        asyncio.ensure_future(self.clean_ips())
+
+    def load_bad_ips(self):
+        try:
+            ret = subprocess.check_output(["pfctl", "-t", self.vilain_table, "-T", "show"])
+        except:
+            logger.warning("Failed to run pfctl -t {} -T show".format(self.vilain_table))
+            ret = ""
+        for res in ret.split():
+            ip = res.strip().decode('utf-8')
+            logger.info('Add existing banned IPs in your pf table: {}'.format(ip))
+            #we assign the counter to 1, but for sure we don't know the real value 
+            self.ip_seen_at[ip]={'time':time.time(),'count':1}
+
 
     def start(self):
         try:
+            logger.info('Run forever loop')
             self.loop.run_forever()
         except KeyboardInterrupt:
             self.loop.close()
         finally:
             self.loop.close()
 
-    async def check_logs(self, logfile, regex, reason):
+    async def check_logs(self, logfile, maxtries, regex, reason):
         """
         worker who put in bad_ip_queue bruteforce IP
         """
@@ -113,68 +130,74 @@
             # Watch the file for changes
             stat = os.stat(logfile)
             size = stat.st_size
+            inode = stat.st_ino
             mtime = stat.st_mtime
             RE = re.compile(regex)
             while True:
-                await asyncio.sleep(sleeptime)
+                await asyncio.sleep(self.sleeptime)
                 stat = os.stat(logfile)
-                if mtime < stat.st_mtime:
+                if size > stat.st_size and inode != stat.st_ino:
+                    logger.info("The file {} has rotated. We start from position 0".format(logfile))
+                    size = 0
+                    inode = stat.st_ino
+                if mtime < stat.st_mtime and inode == stat.st_ino:
+                    logger.debug("{} has been modified".format(logfile))
                     mtime = stat.st_mtime
                     with open(logfile, "rb") as f:
-                        f.seek(size)
-                        lines = f.readlines()
-                        ul = [ u.decode() for u in lines ]
-                        line = "".join(ul).strip()
-
-                        ret = RE.match(line)
-                        if ret:
-                            bad_ip = ret.groups()[0]
-                            if bad_ip not in self.ignore_ip :
-                                #self.bad_ip_queue.append({'ip' : bad_ip, 'reason' : reason})
-                                await self.bad_ip_queue.put({'ip' : bad_ip, 'reason' : reason})
+                        f.seek(size,0)
+                        for bline in f.readlines():
+                            line = bline.decode().strip()
+                            ret = RE.match(line)
+                            logger.debug('line:{}'.format(line))
+                            if ret:
+                                bad_ip = ret.groups()[0]
+                                if bad_ip not in self.ignore_ips :
+                                    logger.info('line match {} the {} rule'.format(bad_ip, reason))
+                                    await self.bad_ip_queue.put({'ip' : bad_ip, 'maxtries': maxtries, 'reason' : reason})
+                                    logger.debug('queue size: {}'.format(self.bad_ip_queue.qsize()))
+                                else:
+                                    logger.info('line match {}. But IP in ignore list'.format(bad_ip))
                     size = stat.st_size
 
     async def ban_ips(self):
         """
-        worker who ban IP on bad_ip_queue
-        add IP in bad_ips_list 
-        record time when this IP has been seen in ip_seen_at = { ip:time }
-
-        check number of occurence of the same ip in bad_ips_list
-        if more than 3 : ban and clean of list
-
-        check old ip in ip_seen_at : remove older than watch_while
+        record time when this IP has been seen in ip_seen_at = { ip:{'time':<time>,'count':<counter} }
+        and ban with pf
         """
-
-        bad_ips_list = []
-        ip_seen_at = {}
+        logger.info('ban_ips started')
         while True:
-            await asyncio.sleep(sleeptime)
-            #if not len(s#elf.bad_ip_queue) > 0:
-            #    continue
             ip_item = await self.bad_ip_queue.get()
-            #ip_item = self.bad_ip_queue.pop()
+            logger.debug('ban_ips awake')
             ip = ip_item['ip']
             reason = ip_item['reason']
-            logger.info("{} detected, reason {}".format(ip, reason))
-            bad_ips_list.append(ip)
-            ip_seen_at[ip] = time.time()
-            n_ip = bad_ips_list.count(ip)
-            if n_ip >= self.maxtries:
-                logger.info("Blacklisting {}".format(ip))
-                subprocess.call(["pfctl", "-t", self.vilain_table, "-T", "add", ip])
-                ip_seen_at.pop(ip)
-                while ip in bad_ips_list:
-                    bad_ips_list.remove(ip)
+            maxtries = ip_item['maxtries']
+            self.ip_seen_at.setdefault(ip, {'time':time.time(),'count':0})
+            self.ip_seen_at[ip]['count'] += 1
+            n_ip = self.ip_seen_at[ip]['count']
+            logger.info("{} detected, reason {}, count: {}, maxtries: {}".format(ip, reason, n_ip, maxtries))
+            if n_ip >= maxtries:
+                ret = subprocess.call(["pfctl", "-t", self.vilain_table, "-T", "add", ip])
+                logger.info("Blacklisting {}, return code:{}".format(ip, ret))
+            #for debugging, this line allow us to see if the script run until here
+            logger.debug('ban_ips end:{}'.format(self.ip_seen_at))
 
+    async def clean_ips(self):
+        """
+        check old ip in ip_seen_at : remove older than watch_while
+        """
+        logger.info('clean_ips started with sleeptime={}'.format(self.sleeptime))
+        while True:
+            await asyncio.sleep(self.watch_while)
             to_remove = []
-            for recorded_ip, last_seen in ip_seen_at.items():
-                if time.time() - last_seen >= self.watch_while:
-                    logger.info("{} not seen since a long time, forgetting...".format(recorded_ip))
+            for recorded_ip, data in self.ip_seen_at.items():
+                if time.time() - data['time'] >= self.watch_while:
+                    ret = subprocess.call(["pfctl", "-t", self.vilain_table, "-T", "delete", recorded_ip])
+                    logger.info("{} not blocked any more, return code:{}".format(recorded_ip, ret))
                     to_remove.append(recorded_ip)
-            for i in to_remove:
-                ip_seen_at.pop(i)
-
+            for ip in to_remove:
+                self.ip_seen_at.pop(ip)
+            #for debugging, this line allow us to see if the script run until here
+            logger.debug('clean_ips end:{}'.format(self.ip_seen_at))
 
 
 
@@ -182,12 +205,30 @@
 def main():
     os.chdir(os.path.dirname(os.path.abspath(__file__)))
     v = Vilain()
-    p = Process(target=v.start())
-    p.start()
+    v.start()
     return 0
 
 if __name__ == '__main__':
-	main()
+    import argparse
+    parser = argparse.ArgumentParser(description="Vilain mimic fail2ban with pf for OpenBSD")
+    parser.add_argument('--debug','-d', action="store_true", help="run in debug mode")
+    parser.add_argument('--conf','-c', nargs="?", help="location of the config file")
+    parser.add_argument('--version','-v', action="store_true", help="Show the version and exit")
+    args = parser.parse_args()
+    if args.debug:
+        print("run in debug")
+        logger.setLevel(logging.DEBUG)
+        ch = logging.StreamHandler(sys.stdout)
+        logger.addHandler(ch)
+    if args.conf:
+        CONFIGFILE = args.conf
+    if args.version:
+        print("Version: ", VERSION)
+        sys.exit(0)
+    main()
+
+
+# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4
 
 
 # vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4

--
Gitblit v1.9.3