Made the appropriate changes to settings.py.dist
[flowspy] / flowspec / models.py
index b3f917b..165964b 100644 (file)
@@ -4,10 +4,17 @@
 from django.db import models
 from django.conf import settings
 from django.contrib.auth.models import User
+from django.utils.translation import ugettext_lazy as _
 from utils import proxy as PR
 from ipaddr import *
-from datetime import *
+import datetime
 import logging
+from time import sleep
+
+import beanstalkc
+from flowspy.utils.randomizer import id_generator as id_gen
+
+from flowspec.tasks import *
 
 FORMAT = '%(asctime)s %(levelname)s: %(message)s'
 logging.basicConfig(format=FORMAT)
@@ -33,11 +40,38 @@ THEN_CHOICES = (
     ("sample", "Sample")                
 )
 
+MATCH_PROTOCOL = (
+    ("ah", "ah"),
+    ("egp", "egp"),
+    ("esp", "esp"),
+    ("gre", "gre"),
+    ("icmp", "icmp"),
+    ("icmp6", "icmp6"),
+    ("igmp", "igmp"),
+    ("ipip", "ipip"),
+    ("ospf", "ospf"),
+    ("pim", "pim"),
+    ("rsvp", "rsvp"),
+    ("sctp", "sctp"),
+    ("tcp", "tcp"),
+    ("udp", "udp"),
+)
+
+ROUTE_STATES = (
+    ("ACTIVE", "ACTIVE"),
+    ("ERROR", "ERROR"),
+    ("EXPIRED", "EXPIRED"),
+    ("PENDING", "PENDING"),
+    ("OUTOFSYNC", "OUTOFSYNC"),
+    ("INACTIVE", "INACTIVE"),
+    ("ADMININACTIVE", "ADMININACTIVE"),           
+)
+
 
-def days_offset(): return datetime.now() + timedelta(days = settings.EXPIRATION_DAYS_OFFSET)
+def days_offset(): return datetime.date.today() + datetime.timedelta(days = settings.EXPIRATION_DAYS_OFFSET)
     
 class MatchPort(models.Model):
-    port = models.CharField(max_length=24)
+    port = models.CharField(max_length=24, unique=True)
     def __unicode__(self):
         return self.port
     class Meta:
@@ -50,47 +84,66 @@ class MatchDscp(models.Model):
     class Meta:
         db_table = u'match_dscp'
 
+class MatchProtocol(models.Model):
+    protocol = models.CharField(max_length=24, unique=True)
+    def __unicode__(self):
+        return self.protocol
+    class Meta:
+        db_table = u'match_protocol'
+
    
 class ThenAction(models.Model):
     action = models.CharField(max_length=60, choices=THEN_CHOICES, verbose_name="Action")
     action_value = models.CharField(max_length=255, blank=True, null=True, verbose_name="Action Value")
     def __unicode__(self):
-        return "%s: %s" %(self.action, self.action_value)
+        ret = "%s:%s" %(self.action, self.action_value)
+        return ret.rstrip(":")
     class Meta:
         db_table = u'then_action'
+        ordering = ['action', 'action_value']
+        unique_together = ("action", "action_value")
 
 class Route(models.Model):
-    name = models.CharField(max_length=128)
-    applier = models.ForeignKey(User)
-    source = models.CharField(max_length=32, blank=True, null=True, help_text=u"Network address. Use address/CIDR notation", verbose_name="Source Address")
-    sourceport = models.ManyToManyField(MatchPort, blank=True, null=True, related_name="matchSourcePort", verbose_name="Source Port")
-    destination = models.CharField(max_length=32, blank=True, null=True, help_text=u"Network address. Use address/CIDR notation", verbose_name="Destination Address")
-    destinationport = models.ManyToManyField(MatchPort, blank=True, null=True, related_name="matchDestinationPort", verbose_name="Destination Port")
-    port = models.ManyToManyField(MatchPort, blank=True, null=True, related_name="matchPort", verbose_name="Port" )
+    name = models.SlugField(max_length=128, verbose_name=_("Name"))
+    applier = models.ForeignKey(User, blank=True, null=True)
+    source = models.CharField(max_length=32, help_text=_("Network address. Use address/CIDR notation"), verbose_name=_("Source Address"))
+    sourceport = models.ManyToManyField(MatchPort, blank=True, null=True, related_name="matchSourcePort", verbose_name=_("Source Port"))
+    destination = models.CharField(max_length=32, help_text=_("Network address. Use address/CIDR notation"), verbose_name=_("Destination Address"))
+    destinationport = models.ManyToManyField(MatchPort, blank=True, null=True, related_name="matchDestinationPort", verbose_name=_("Destination Port"))
+    port = models.ManyToManyField(MatchPort, blank=True, null=True, related_name="matchPort", verbose_name=_("Port"))
     dscp = models.ManyToManyField(MatchDscp, blank=True, null=True, verbose_name="DSCP")
     fragmenttype = models.CharField(max_length=20, choices=FRAGMENT_CODES, blank=True, null=True, verbose_name="Fragment Type")
     icmpcode = models.CharField(max_length=32, blank=True, null=True, verbose_name="ICMP Code")
     icmptype = models.CharField(max_length=32, blank=True, null=True, verbose_name="ICMP Type")
     packetlength = models.IntegerField(blank=True, null=True, verbose_name="Packet Length")
-    protocol = models.CharField(max_length=32, blank=True, null=True, verbose_name="Protocol")
+    protocol = models.ManyToManyField(MatchProtocol, blank=True, null=True, verbose_name=_("Protocol"))
     tcpflag = models.CharField(max_length=128, blank=True, null=True, verbose_name="TCP flag")
-    then = models.ManyToManyField(ThenAction, verbose_name="Then")
+    then = models.ManyToManyField(ThenAction, verbose_name=_("Then"))
     filed = models.DateTimeField(auto_now_add=True)
     last_updated = models.DateTimeField(auto_now=True)
-    is_online = models.BooleanField(default=False)
-    is_active = models.BooleanField(default=False)
-    expires = models.DateField(default=days_offset)
-    response = models.CharField(max_length=512, blank=True, null=True)
-    comments = models.TextField(null=True, blank=True, verbose_name="Comments")
+    status = models.CharField(max_length=20, choices=ROUTE_STATES, blank=True, null=True, verbose_name=_("Status"), default="PENDING")
+#    is_online = models.BooleanField(default=False)
+#    is_active = models.BooleanField(default=False)
+    expires = models.DateField(default=days_offset, verbose_name=_("Expires"))
+    response = models.CharField(max_length=512, blank=True, null=True, verbose_name=_("Response"))
+    comments = models.TextField(null=True, blank=True, verbose_name=_("Comments"))
 
     
     def __unicode__(self):
         return self.name
     
     class Meta:
-        unique_together = (("name", "is_active"),)
         db_table = u'route'
+        verbose_name = "Rule"
+        verbose_name_plural = "Rules"
     
+    def save(self, *args, **kwargs):
+        if not self.pk:
+            hash = id_gen()
+            self.name = "%s_%s" %(self.name, hash)
+        super(Route, self).save(*args, **kwargs) # Call the "real" save() method.
+
+        
     def clean(self, *args, **kwargs):
         from django.core.exceptions import ValidationError
         if self.destination:
@@ -98,40 +151,63 @@ class Route(models.Model):
                 address = IPNetwork(self.destination)
                 self.destination = address.exploded
             except Exception:
-                raise ValidationError('Invalid network address format at Destination Field')
+                raise ValidationError(_('Invalid network address format at Destination Field'))
         if self.source:
             try:
                 address = IPNetwork(self.source)
                 self.source = address.exploded
             except Exception:
-                raise ValidationError('Invalid network address format at Source Field')
-    
-    def save(self, *args, **kwargs):
-        applier = PR.Applier(route_object=self)
-        commit, response = applier.apply()
-        if commit:
-            self.is_online = True
-            self.is_active = True
-            self.response = response
-        else:
-            self.is_online = False
-            self.response = response
-        super(Route, self).save(*args, **kwargs)
+                raise ValidationError(_('Invalid network address format at Source Field'))
+   
+    def commit_add(self, *args, **kwargs):
+        peer = self.applier.get_profile().peer.domain_name
+        send_message("[%s] Adding rule %s. Please wait..." %(self.applier.username, self.name), peer)
+        response = add.delay(self)
+        logger.info("Got add job id: %s" %response)
+        
+    def commit_edit(self, *args, **kwargs):
+        peer = self.applier.get_profile().peer.domain_name
+        send_message("[%s] Editing rule %s. Please wait..." %(self.applier.username, self.name), peer)
+        response = edit.delay(self)
+        logger.info("Got edit job id: %s" %response)
 
+    def commit_delete(self, *args, **kwargs):
+        reason_text = ''
+        reason = ''
+        if "reason" in kwargs:
+            reason = kwargs['reason']
+            reason_text = "Reason: %s. " %reason
+        peer = self.applier.get_profile().peer.domain_name
+        send_message("[%s] Suspending rule %s. %sPlease wait..." %(self.applier.username, self.name, reason_text), peer)
+        response = delete.delay(self, reason=reason)
+        logger.info("Got delete job id: %s" %response)
+
+    def has_expired(self):
+        today = datetime.date.today()
+        if today > self.expires:
+            return True
+        return False
+    
+    def check_sync(self):
+        if not self.is_synced():
+            self.status = "OUTOFSYNC"
+            self.save()
+    
     def is_synced(self):
-        
         found = False
         get_device = PR.Retriever()
         device = get_device.fetch_device()
         try:
             routes = device.routing_options[0].routes
         except Exception as e:
+            self.status = "EXPIRED"
+            self.save()
             logger.error("No routing options on device. Exception: %s" %e)
-            return False
+            return True
         for route in routes:
             if route.name == self.name:
                 found = True
-                logger.info('Found a matching route name')
+                logger.info('Found a matching rule name')
                 devicematch = route.match
                 try:
                     assert(self.destination)
@@ -188,21 +264,13 @@ class Route(models.Model):
                         logger.info('Icmp type fields do not match')
                 except:
                     pass
-                try:
-                    assert(self.protocol)
-                    assert(devicematch['protocol'][0])
-                    if self.protocol == devicematch['protocol'][0]:
-                        found = found and True
-                        logger.info('Found a matching protocol')
-                    else:
-                        found = False
-                        logger.info('Protocol fields do not match')
-                except:
-                    pass
-                if found and not self.is_online:
-                     logger.error('Rule is applied on device but appears as offline')
-                     found = False
-        
+                if found and self.status != "ACTIVE":
+                    logger.error('Rule is applied on device but appears as offline')
+                    self.status = "ACTIVE"
+                    self.save()
+                    found = True
+            if self.status == "ADMININACTIVE" or self.status == "INACTIVE" or self.status == "EXPIRED":
+                found = True
         return found
 
     def get_then(self):
@@ -221,35 +289,63 @@ class Route(models.Model):
     def get_match(self):
         ret = ''
         if self.destination:
-            ret = ret = '%s Destination Address:<strong>%s</strong><br/>' %(ret, self.destination)
+            ret = '%s Dst Addr:<strong>%s</strong> <br/>' %(ret, self.destination)
         if self.fragmenttype:
-            ret = ret = "%s Fragment Type:<strong>%s</strong><br/>" %(ret, self.fragmenttype)
+            ret = "%s Fragment Type:<strong>%s</strong><br/>" %(ret, self.fragmenttype)
         if self.icmpcode:
-            ret = ret = "%s ICMP code:<strong>%s</strong><br/>" %(ret, self.icmpcode)
+            ret = "%s ICMP code:<strong>%s</strong><br/>" %(ret, self.icmpcode)
         if self.icmptype:
-            ret = ret = "%s ICMP Type:<strong>%s</strong><br/>" %(ret, self.icmptype)
+            ret = "%s ICMP Type:<strong>%s</strong><br/>" %(ret, self.icmptype)
         if self.packetlength:
-            ret = ret = "%s Packet Length:<strong>%s</strong><br/>" %(ret, self.packetlength)
-        if self.protocol:
-            ret = ret = "%s Protocol:<strong>%s</strong><br/>" %(ret, self.protocol)
+            ret = "%s Packet Length:<strong>%s</strong><br/>" %(ret, self.packetlength)
         if self.source:
-            ret = ret = "%s Source Address:<strong>%s</strong><br/>" %(ret, self.source)
+            ret = "%s Src Addr:<strong>%s</strong> <br/>" %(ret, self.source)
         if self.tcpflag:
-            ret = ret = "%s TCP flag:<strong>%s</strong><br/>" %(ret, self.tcpflag)
+            ret = "%s TCP flag:<strong>%s</strong><br/>" %(ret, self.tcpflag)
         if self.port:
             for port in self.port.all():
-                    ret = "%s Port:<strong>%s</strong><br/>" %(ret, port)
+                    ret = ret + "Port:<strong>%s</strong> <br/>" %(port)
+        if self.protocol:
+            for protocol in self.protocol.all():
+                    ret = ret + "Protocol:<strong>%s</strong> <br/>" %(protocol)
         if self.destinationport:
             for port in self.destinationport.all():
-                    ret = "%s Port:<strong>%s</strong><br/>" %(ret, port)
+                    ret = ret + "Dst Port:<strong>%s</strong> <br/>" %(port)
         if self.sourceport:
             for port in self.sourceport.all():
-                    ret = "%s Port:<strong>%s</strong><br/>" %(ret, port)
+                    ret = ret +"Src Port:<strong>%s</strong> <br/>" %(port)
         if self.dscp:
             for dscp in self.dscp.all():
-                    ret = "%s Port:<strong>%s</strong><br/>" %(ret, dscp)
+                    ret = ret + "%s Port:<strong>%s</strong> <br/>" %(ret, dscp)
         return ret.rstrip('<br/>')
         
     get_match.short_description = 'Match statement'
     get_match.allow_tags = True
+    
+    @property
+    def applier_peer(self):
+        try:
+            applier_peer = self.applier.get_profile().peer
+        except:
+            applier_peer = None
+        return applier_peer
+    
+    @property
+    def days_to_expire(self):
+        if self.status not in ['EXPIRED', 'ADMININACTIVE', 'ERROR', 'INACTIVE']:
+            expiration_days = (self.expires - datetime.date.today()).days
+            if expiration_days < settings.EXPIRATION_NOTIFY_DAYS:
+                return "%s" %expiration_days
+            else:
+                return False
+        else:
+            return False
 
+def send_message(msg, user):
+#    username = user.username
+    peer = user
+    b = beanstalkc.Connection()
+    b.use(settings.POLLS_TUBE)
+    tube_message = json.dumps({'message': str(msg), 'username':peer})
+    b.put(tube_message)
+    b.close()