generate the rule name in junos
[flowspy] / flowspec / models.py
index c695ad7..5f2f455 100644 (file)
@@ -1,17 +1,50 @@
-# -*- coding: utf-8 -*- vim:encoding=utf-8:
+# -*- coding: utf-8 -*- vim:fileencoding=utf-8:
 # vim: tabstop=4:shiftwidth=4:softtabstop=4:expandtab
 
+# Copyright (C) 2010-2014 GRNET S.A.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 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 flowspec.tasks import *
 from time import sleep
+from junos import create_junos_name, policer_name
+
+import beanstalkc
+from utils.randomizer import id_generator as id_gen
 
-from flowspy.utils import beanstalkc
+from tasks import *
+
+
+def user_unicode_patch(self):
+    peer = None
+    try:
+        peer = self.get_profile().peer.peer_tag
+    except:
+        pass
+    if peer:
+        return '%s.::.%s' % (self.username, peer)
+    return self.username
+
+User.__unicode__ = user_unicode_patch
 
 
 FORMAT = '%(asctime)s %(levelname)s: %(message)s'
@@ -35,18 +68,45 @@ THEN_CHOICES = (
     ("next-term", "Next term"),
     ("routing-instance", "Routing Instance"),
     ("rate-limit", "Rate limit"),
-    ("sample", "Sample")                
+    ("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.date.today() + datetime.timedelta(days = settings.EXPIRATION_DAYS_OFFSET)
 
-def days_offset(): return datetime.now() + 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:
-        db_table = u'match_port'    
+        db_table = u'match_port'
 
 class MatchDscp(models.Model):
     dscp = models.CharField(max_length=24)
@@ -55,47 +115,75 @@ 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 FragmentType(models.Model):
+    fragmenttype = models.CharField(max_length=20, choices=FRAGMENT_CODES, verbose_name="Fragment Type")
+
+    def __unicode__(self):
+        return "%s" %(self.fragmenttype)
+
+
 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.SlugField(max_length=128)
+    name = models.SlugField(max_length=128, verbose_name=_("Name"))
     applier = models.ForeignKey(User, blank=True, null=True)
-    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, 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" )
+    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")
+    fragmenttype = models.ManyToManyField(FragmentType, 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, blank=True, null=True,)
-    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:
@@ -103,66 +191,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):
-#        edit = False
-#        if self.pk:
-#            #This is an edit
-#            edit = True
-#        super(Route, self).save(*args, **kwargs)
-#        if not edit:
-#            response = add.delay(self)
-#            logger.info("Got save job id: %s" %response)
-    
+                raise ValidationError(_('Invalid network address format at Source Field'))
+
     def commit_add(self, *args, **kwargs):
-        send_message("Adding route %s. Please wait..." %self.name, self.applier)
+        peer = self.applier.get_profile().peer.peer_tag
+        send_message("[%s] Adding rule %s. Please wait..." %(self.applier.username, self.name), peer)
         response = add.delay(self)
-        logger.info("Got save job id: %s" %response)
-
-    def deactivate(self):
-        self.is_online = False
-        self.is_active = False
-        self.save()
-#    def delete(self, *args, **kwargs):
-#        response = delete.delay(self)
-#        logger.info("Got delete job id: %s" %response)
-        
+        logger.info("Got add job id: %s" %response)
+
     def commit_edit(self, *args, **kwargs):
-        send_message("Editing route %s. Please wait..." %self.name, self.applier)
+        peer = self.applier.get_profile().peer.peer_tag
+        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):
-        send_message("Removing route %s. Please wait..." %self.name, self.applier)
-        response = delete.delay(self)
-        logger.info("Got edit job id: %s" %response)
-#    
-#    def delete(self, *args, **kwargs):
-#        response = delete.delay(self)
-#        logger.info("Got delete job id: %s" %response)
+        reason_text = ''
+        reason = ''
+        if "reason" in kwargs:
+            reason = kwargs['reason']
+            reason_text = "Reason: %s. " %reason
+        peer = self.applier.get_profile().peer.peer_tag
+        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.is_online = False
+            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)
@@ -186,10 +271,14 @@ class Route(models.Model):
                         logger.info('Source fields do not match')
                 except:
                     pass
+
                 try:
-                    assert(self.fragmenttype)
-                    assert(devicematch['fragment'][0])
-                    if self.fragmenttype == devicematch['fragment'][0]:
+                    assert(self.fragmenttype.all())
+                    assert(devicematch['fragment'])
+                    devitems = devicematch['fragment']
+                    dbitems = ["%s"%i for i in self.fragmenttype.all()]
+                    intersect = list(set(devitems).intersection(set(dbitems)))
+                    if ((len(intersect) == len(dbitems)) and (len(intersect) == len(devitems))):
                         found = found and True
                         logger.info('Found a matching fragment type')
                     else:
@@ -197,6 +286,79 @@ class Route(models.Model):
                         logger.info('Fragment type fields do not match')
                 except:
                     pass
+
+                try:
+                    assert(self.port.all())
+                    assert(devicematch['port'])
+                    devitems = devicematch['port']
+                    dbitems = ["%s"%i for i in self.port.all()]
+                    intersect = list(set(devitems).intersection(set(dbitems)))
+                    if ((len(intersect) == len(dbitems)) and (len(intersect) == len(devitems))):
+                        found = found and True
+                        logger.info('Found a matching port type')
+                    else:
+                        found = False
+                        logger.info('Port type fields do not match')
+                except:
+                    pass
+
+                try:
+                    assert(self.protocol.all())
+                    assert(devicematch['protocol'])
+                    devitems = devicematch['protocol']
+                    dbitems = ["%s"%i for i in self.protocol.all()]
+                    intersect = list(set(devitems).intersection(set(dbitems)))
+                    if ((len(intersect) == len(dbitems)) and (len(intersect) == len(devitems))):
+                        found = found and True
+                        logger.info('Found a matching protocol type')
+                    else:
+                        found = False
+                        logger.info('Protocol type fields do not match')
+                except:
+                    pass
+
+                try:
+                    assert(self.destinationport.all())
+                    assert(devicematch['destination-port'])
+                    devitems = devicematch['destination-port']
+                    dbitems = ["%s"%i for i in self.destinationport.all()]
+                    intersect = list(set(devitems).intersection(set(dbitems)))
+                    if ((len(intersect) == len(dbitems)) and (len(intersect) == len(devitems))):
+                        found = found and True
+                        logger.info('Found a matching destination port type')
+                    else:
+                        found = False
+                        logger.info('Destination port type fields do not match')
+                except:
+                    pass
+
+                try:
+                    assert(self.sourceport.all())
+                    assert(devicematch['source-port'])
+                    devitems = devicematch['source-port']
+                    dbitems = ["%s"%i for i in self.sourceport.all()]
+                    intersect = list(set(devitems).intersection(set(dbitems)))
+                    if ((len(intersect) == len(dbitems)) and (len(intersect) == len(devitems))):
+                        found = found and True
+                        logger.info('Found a matching source port type')
+                    else:
+                        found = False
+                        logger.info('Source port type fields do not match')
+                except:
+                    pass
+
+
+#                try:
+#                    assert(self.fragmenttype)
+#                    assert(devicematch['fragment'][0])
+#                    if self.fragmenttype == devicematch['fragment'][0]:
+#                        found = found and True
+#                        logger.info('Found a matching fragment type')
+#                    else:
+#                        found = False
+#                        logger.info('Fragment type fields do not match')
+#                except:
+#                    pass
                 try:
                     assert(self.icmpcode)
                     assert(devicematch['icmp-code'][0])
@@ -219,21 +381,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):
@@ -241,53 +395,86 @@ class Route(models.Model):
         then_statements = self.then.all()
         for statement in then_statements:
             if statement.action_value:
-                ret = "%s %s:<strong>%s</strong><br/>" %(ret, statement.action, statement.action_value)
-            else: 
-                ret = "%s %s<br>" %(ret, statement.action)
-        return ret.rstrip(',')
-    
+                ret = "%s %s %s" %(ret, statement.action, statement.action_value)
+            else:
+                ret = "%s %s" %(ret, statement.action)
+        return ret
+
     get_then.short_description = 'Then statement'
     get_then.allow_tags = True
 #
     def get_match(self):
-        ret = ''
+        ret = '<dl class="dl-horizontal">'
         if self.destination:
-            ret = '%s Destination Address:<strong>%s</strong><br/>' %(ret, self.destination)
-        if self.fragmenttype:
-            ret = "%s Fragment Type:<strong>%s</strong><br/>" %(ret, self.fragmenttype)
+            ret = '%s <dt>Dst Addr</dt><dd>%s</dd>' %(ret, self.destination)
+        if self.fragmenttype.all():
+            ret = ret + "<dt>Fragment Types</dt><dd>%s</dd>" %(', '.join(["%s"%i for i in self.fragmenttype.all()]))
+#            for fragment in self.fragmenttype.all():
+#                    ret = ret + "Fragment Types:<strong>%s</dd>" %(fragment)
         if self.icmpcode:
-            ret = "%s ICMP code:<strong>%s</strong><br/>" %(ret, self.icmpcode)
+            ret = "%s <dt>ICMP code</dt><dd>%s</dd>" %(ret, self.icmpcode)
         if self.icmptype:
-            ret = "%s ICMP Type:<strong>%s</strong><br/>" %(ret, self.icmptype)
+            ret = "%s <dt>ICMP Type</dt><dd>%s</dd>" %(ret, self.icmptype)
         if self.packetlength:
-            ret = "%s Packet Length:<strong>%s</strong><br/>" %(ret, self.packetlength)
-        if self.protocol:
-            ret = "%s Protocol:<strong>%s</strong><br/>" %(ret, self.protocol)
+            ret = "%s <dt>Packet Length</dt><dd>%s</dd>" %(ret, self.packetlength)
         if self.source:
-            ret = "%s Source Address:<strong>%s</strong><br/>" %(ret, self.source)
+            ret = "%s <dt>Src Addr</dt><dd>%s</dd>" %(ret, self.source)
         if self.tcpflag:
-            ret = "%s TCP flag:<strong>%s</strong><br/>" %(ret, self.tcpflag)
-        if self.port:
-            for port in self.port.all():
-                    ret = ret + "Port:<strong>%s</strong><br/>" %(port)
-        if self.destinationport:
-            for port in self.destinationport.all():
-                    ret = ret + "Destination Port:<strong>%s</strong><br/>" %(port)
-        if self.sourceport:
-            for port in self.sourceport.all():
-                    ret = ret +"Source Port:<strong>%s</strong><br/>" %(port)
+            ret = "%s <dt>TCP flag</dt><dd>%s</dd>" %(ret, self.tcpflag)
+        if self.port.all():
+            ret = ret + "<dt>Ports</dt><dd>%s</dd>" %(', '.join(["%s"%i for i in self.port.all()]))
+#            for port in self.port.all():
+#                    ret = ret + "Port:<strong>%s</dd>" %(port)
+        if self.protocol.all():
+            ret = ret + "<dt>Protocols</dt><dd>%s</dd>" %(', '.join(["%s"%i for i in self.protocol.all()]))
+#            for protocol in self.protocol.all():
+#                    ret = ret + "Protocol:<strong>%s</dd>" %(protocol)
+        if self.destinationport.all():
+            ret = ret + "<dt>DstPorts</dt><dd>%s</dd>" %(', '.join(["%s"%i for i in self.destinationport.all()]))
+#            for port in self.destinationport.all():
+#                    ret = ret + "Dst Port:<strong>%s</dd>" %(port)
+        if self.sourceport.all():
+            ret = ret + "<dt>SrcPorts</dt><dd>%s</dd>" %(', '.join(["%s"%i for i in self.sourceport.all()]))
+#            for port in self.sourceport.all():
+#                    ret = ret +"Src Port:<strong>%s</dd>" %(port)
         if self.dscp:
             for dscp in self.dscp.all():
-                    ret = ret + "%s Port:<strong>%s</strong><br/>" %(ret, dscp)
-        return ret.rstrip('<br/>')
-        
+                    ret = ret + "%s <dt>Port</dt><dd>%s</dd>" %(ret, dscp)
+        ret = ret + "</dl>"
+        return ret
+
     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
+
+    @property
+    def junos_name(self):
+        return create_junos_name(self)
+
+
 def send_message(msg, user):
-    username = user.username
+#    username = user.username
+    peer = user
     b = beanstalkc.Connection()
     b.use(settings.POLLS_TUBE)
-    tube_message = json.dumps({'message': str(msg), 'username':username})
+    tube_message = json.dumps({'message': str(msg), 'username':peer})
     b.put(tube_message)
     b.close()