main.py

#
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
#
# Copyright (c) 2018 Juniper Networks, Inc.
# All rights reserved.
#
# Use is subject to license terms.
#
# Licensed under the Apache License, Version 2.0 (the ?License?); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at http://www.apache.org/licenses/LICENSE-2.0.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#


import os
import cherrypy
import hashlib
import datetime
import yaml
import re

from jinja2 import Environment, FileSystemLoader
from jnpr.junos.utils.config import Config
from jnpr.junos import Device
from jnpr.junos.exception import ConfigLoadError, CommitError
from data.fr import FlowRoutesTable, FlowFilterTable


class MyDev(object):

    def __init__(self):

        self.dev_user = None
        self.dev_pw = None
        self.age_out_interval = None
        self.flow_active = dict()
        self.flow_config = dict()
        self.filter_active = dict()
        self.routers = list()

    def addNewFlowRoute(self, flowRouteData=None):

        env = Environment(autoescape=False,
                          loader=FileSystemLoader('./template'), trim_blocks=False, lstrip_blocks=False)
        template = env.get_template('set-flow-route.conf')

        # print template.render(flowRouteData)

        my_router = None
        for router in self.routers:

            for name, value in router.iteritems():
                if 'rr' in value['type']:
                    my_router = [value['ip']]

        with Device(host=my_router[0], user=self.dev_user, password=self.dev_pw) as dev:

            try:

                cu = Config(dev)
                cu.lock()

                cu.load(template_path='template/set-flow-route.conf', template_vars=flowRouteData, merge=True)
                cu.commit()
                cu.unlock()

            except ConfigLoadError as cle:
                return False, cle.message

        self.flow_config[flowRouteData['flowRouteName']] = {
            'dstPrefix': flowRouteData['dstPrefix'] if 'dstPrefix' in flowRouteData else None,
            'srcPrefix': flowRouteData['srcPrefix'] if 'srcPrefix' in flowRouteData else None,
            'protocol': flowRouteData['protocol'] if 'protocol' in flowRouteData else None,
            'dstPort': flowRouteData['dstPort'] if 'dstPort' in flowRouteData else None,
            'srcPort': flowRouteData['srcPort'] if 'srcPort' in flowRouteData else None,
            'action': flowRouteData['action']}
        return True, 'Successfully added new flow route'

    def modFlowRoute(self, flowRouteData=None):

        my_router = None
        for router in self.routers:

            for name, value in router.iteritems():
                if 'rr' in value['type']:
                    my_router = [value['ip']]

        with Device(host=my_router[0], user=self.dev_user, password=self.dev_pw) as dev:

            try:
                cu = Config(dev)
                cu.lock()
                cu.load(template_path='template/mod-flow-route.conf', template_vars=flowRouteData)
                cu.commit()
                cu.unlock()

            except CommitError as ce:
                return False, ce.message

        self.flow_config[flowRouteData['flowRouteName']] = {
            'dstPrefix': flowRouteData['dstPrefix'] if 'dstPrefix' in flowRouteData else None,
            'srcPrefix': flowRouteData['srcPrefix'] if 'srcPrefix' in flowRouteData else None,
            'protocol': flowRouteData['protocol'] if 'protocol' in flowRouteData else None,
            'dstPort': flowRouteData['dstPort'] if 'dstPort' in flowRouteData else None,
            'srcPort': flowRouteData['srcPort'] if 'srcPort' in flowRouteData else None,
            'action': flowRouteData['action']}

        return True, 'Successfully modified flow route'

    def delFlowRoute(self, flowRouteData=None):

        my_router = None
        for router in self.routers:

            for name, value in router.iteritems():
                if 'rr' in value['type']:
                    my_router = [value['ip']]

        with Device(host=my_router[0], user=self.dev_user, password=self.dev_pw) as dev:

            try:

                cu = Config(dev)
                cu.lock()
                cu.load(template_path='template/delete-flow-route.conf', template_vars=flowRouteData, merge=True)
                cu.commit()
                cu.unlock()

            except ConfigLoadError as cle:
                return False, cle.message

        self.flow_config.pop(flowRouteData['flowRouteName'], None)

        return True, 'Sucessfully deleted flow route'

    def getActiveFlowRoutes(self):

        t = datetime.datetime.strptime(self.age_out_interval, "%H:%M:%S")
        self.flow_active = dict()

        for router in self.routers:

            for name, value in router.iteritems():

                with Device(host=value['ip'], user=self.dev_user, password=self.dev_pw) as dev:

                    # data = dev.rpc.get_config(filter_xml='routing-options/flow/route/name')
                    frt = FlowRoutesTable(dev)
                    frt.get()

                    for flow in frt:

                        destination = flow.destination.split(',')

                        for index, item in enumerate(destination):
                            _item = item.split('=')
                            destination[index] = _item[1] if len(_item) > 1 else _item[0]

                        hash_object = hashlib.sha512(b'{0}{1}'.format(str(destination), str(value['ip'])))
                        hex_dig = hash_object.hexdigest()
                        _age = dict()

                        if len(flow.age) <= 2:
                            _age['current'] = datetime.timedelta(seconds=int(flow.age))
                        elif len(flow.age) == 4 or len(flow.age) == 5:
                            ms = flow.age.split(':')
                            _age['current'] = datetime.timedelta(minutes=int(ms[0]), seconds=int(ms[1]))
                        elif len(flow.age) == 7 or len(flow.age) == 8:
                            ms = flow.age.split(':')
                            _age['current'] = datetime.timedelta(hours=int(ms[0]), minutes=int(ms[1]),
                                                                 seconds=int(ms[2]))
                        else:
                            pattern = r'(.*)\s(.*?):(.*?):(.*)'
                            regex = re.compile(pattern)
                            age = re.findall(regex, flow.age)
                            _age['current'] = datetime.timedelta(days=int(age[0][0][:-1]), hours=int(age[0][1]),
                                                                 minutes=int(age[0][2]), seconds=int(age[0][3]))

                        pattern = r'([^\s]+)'
                        regex = re.compile(pattern)
                        _krt_actions = re.findall(regex, flow.tsi)

                        if len(_krt_actions) <= 4:
                            krt_actions = _krt_actions
                        else:
                            krt_actions = _krt_actions[4]

                        # Junos 14.1RX different XPATH for BGP communities
                        version = dev.facts['version'].split('R')[0].split('.')

                        if int(version[0]) <= 14 and int(version[1]) <= 1:

                            if isinstance(flow.action_141, str):
                                if 'traffic-action' in flow.action_141:
                                    commAction = flow.action_141.split(":")[1].lstrip().strip()
                                else:
                                    commAction = flow.action_141

                            elif isinstance(flow.action_141, list):
                                commAction = flow.action_141[1].split(':')[1].lstrip().strip()
                            else:
                                commAction = flow.action_141

                        else:

                            if isinstance(flow.action, str):
                                if 'traffic-action' in flow.action:
                                    commAction = flow.action.split(":")[1].lstrip().strip()
                                else:
                                    commAction = flow.action

                            elif isinstance(flow.action, list):
                                commAction = flow.action[1].split(':')[1].lstrip().strip()
                            else:
                                commAction = flow.action

                        if hex_dig not in self.flow_active:

                            self.flow_active[hex_dig] = {'router': name, 'term': flow.term, 'destination': destination,
                                                         'commAction': commAction, 'krtAction': krt_actions,
                                                         'age': str(_age['current']),
                                                         'hash': hex_dig, 'status': 'new'}
                        else:

                            if 'term:N/A' in flow['term']:
                                self.flow_active.pop(hex_dig, None)

                            if _age['current']:

                                if _age['current'] > datetime.timedelta(hours=t.hour, minutes=t.minute,
                                                                        seconds=t.second):
                                    self.flow_active[hex_dig]['status'] = 'old'

                            try:
                                if hex_dig in self.flow_active:
                                    self.flow_active[hex_dig].update({'term': flow.term, 'destination': destination,
                                                                      'commAction': commAction,
                                                                      'krtAction': krt_actions,
                                                                      'age': str(_age['current'])})

                            except KeyError as ke:
                                return False, ke.message

        return True, self.flow_active

    def getActiveFlowRouteFilter(self):

        if self.routers:

            for router in self.routers:

                for name, value in router.iteritems():
                    self.filter_active[name] = list()

                    with Device(host=value['ip'], user=self.dev_user, password=self.dev_pw) as dev:

                        frft = FlowFilterTable(dev)
                        frft.get()

                        for filter in frft:

                            data = filter.name.split(',')

                            for didx, item in enumerate(data):
                                _item = item.split('=')
                                data[didx] = _item[1] if len(_item) > 1 else _item[0]

                            self.filter_active[name].append({'data': data, 'packet_count': filter.packet_count,
                                                             'byte_count': filter.byte_count})

            return True, self.filter_active

    def loadFlowRouteConfig(self):

        dev_ip = list()

        for router in self.routers:

            for name, value in router.iteritems():

                if 'rr' in value['type']:
                    dev_ip.append(value['ip'])

        with Device(host=dev_ip[0], user=self.dev_user, password=self.dev_pw, normalize=True) as dev:
            version = dev.facts['version'].split('R')[0].split('.')

            # Junos 14.1RX does not support json so let's go with XML here

            if int(version[0]) <= 14 and int(version[1]) <= 1:

                data = dev.rpc.get_config(options={'format': 'xml'}, filter_xml='routing-options/flow')

                for route in data.iter('route'):
                    my_list = list()

                    for item in route:

                        if 'name' in item.tag:
                            my_list.append(item.text)
                            self.flow_config[item.text] = {}

                        elif 'match' in item.tag:
                            tag = None

                            for child in item.iterchildren():

                                if 'destination-port' in child.tag:
                                    tag = 'dstPort'
                                elif 'source-port' in child.tag:
                                    tag = 'srcPort'
                                elif 'destination' in child.tag:
                                    tag = 'dstPrefix'
                                elif 'source' in child.tag:
                                    tag = 'srcPrefix'
                                elif 'protocol' in child.tag:
                                    tag = 'protocol'

                                self.flow_config[my_list[0]][tag] = child.text

                        elif 'then' in item.tag:

                            _action = dict()

                            for child in item.iterchildren():

                                for value in child.iter():
                                    _action[child.tag] = {'value': value.text}

                                self.flow_config[my_list[0]]['action'] = _action

                return True, self.flow_config

            else:

                data = dev.rpc.get_config(options={'format': 'json'})

                if 'route' in data['configuration']['routing-options']['flow']:

                    for route in data['configuration']['routing-options']['flow']['route']:
                        _action = dict()

                        for key, value in route['then'].iteritems():

                            if value[0]:
                                _action[key] = {'value': value}
                            else:
                                _action[key] = {'value': None}

                        self.flow_config[route['name']] = {
                            'dstPrefix': route['match']['destination'] if 'destination' in route['match'] else None,
                            'srcPrefix': route['match']['source'] if 'source' in route['match'] else None,
                            'protocol': route['match']['protocol'] if 'protocol' in route['match'] else None,
                            'dstPort': route['match']['destination-port'] if 'destination-port' in route[
                                'match'] else None,
                            'srcPort': route['match']['source-port'] if 'source-port' in route['match'] else None,
                            'action': _action}
                    return True, self.flow_config

                else:
                    return False, self.flow_config

    def save_settings(self, dev_user=None, dev_pw=None, routers=None, age_out_interval=None):

        self.dev_user = dev_user
        self.dev_pw = dev_pw
        self.age_out_interval = age_out_interval
        # self.routers = routers

        # with open('ui/config.yml', 'w') as fp:
        #    config = {'dev_user': self.dev_user, 'dev_pw': self.dev_pw, 'routers': self.routers,
        #              'age_out_interval': self.age_out_interval}
        #    yaml.safe_dump(config, fp, default_flow_style=False)

    def load_settings(self):

        with open('ui/config.yml', 'r') as fp:
            _config = fp.read()
            config = yaml.safe_load(_config)
            self.dev_user = config['dev_user']
            self.dev_pw = config['dev_pw']
            self.age_out_interval = config['age_out_interval']
            self.routers = config['routers']


class BGPFlow(object):

    @cherrypy.expose
    def index(self):
        return open('ui/index.html', 'r')


@cherrypy.expose
class BGPFlowWS(object):

    def __init__(self, my_dev=None):
        self.my_dev = my_dev

    @cherrypy.tools.json_out()
    @cherrypy.tools.json_in()
    def GET(self, action=None):

        if action == 'active':
            data = self.my_dev.getActiveFlowRoutes()

            return data

    @cherrypy.tools.json_out()
    @cherrypy.tools.json_in()
    def POST(self, action=None):

        if action == 'add':

            input_json = cherrypy.request.json
            resp = self.my_dev.addNewFlowRoute(flowRouteData=input_json)
            return resp

        elif action == 'mod':
            input_json = cherrypy.request.json
            resp = self.my_dev.modFlowRoute(flowRouteData=input_json)
            return resp

        elif action == 'del':
            input_json = cherrypy.request.json
            resp = self.my_dev.delFlowRoute(flowRouteData=input_json)
            return resp

        elif action == 'save':

            input_json = cherrypy.request.json
            self.my_dev.save_settings(dev_user=input_json['user'], dev_pw=input_json['password'],
                                      age_out_interval=input_json['age_out_interval'])
            return True, 'Successfully saved configuration settings'

        else:
            return False, 'Action not defined'


@cherrypy.expose
class Frt(object):

    def __init__(self, my_dev=None):
        self.my_dev = my_dev

    @cherrypy.tools.json_out()
    def POST(self):
        resp = self.my_dev.getActiveFlowRoutes()
        return resp


@cherrypy.expose
class Frtc(object):

    def __init__(self, my_dev=None):
        self.my_dev = my_dev

    @cherrypy.tools.json_out()
    def POST(self):
        resp = self.my_dev.loadFlowRouteConfig()
        return resp


@cherrypy.expose
class Frft(object):

    def __init__(self, my_dev=None):
        self.my_dev = my_dev

    @cherrypy.tools.json_out()
    def POST(self):
        resp = self.my_dev.getActiveFlowRouteFilter()
        return resp


if __name__ == '__main__':
    cherrypy.config.update({'log.screen': False,
                            'log.access_file': '',
                            'log.error_file': ''})
    conf = {
        '/': {
            'tools.sessions.on': True,
            'tools.staticdir.root': os.path.abspath(os.getcwd()),
            'tools.staticdir.on': True,
            'tools.staticdir.dir': 'ui'
        },
        '/api': {
            'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
            'tools.response_headers.on': True,
            'tools.response_headers.headers': [('Content-Type', 'text/plain')],
        },
        '/api/frt': {
            'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
            'tools.response_headers.on': True,
            'tools.response_headers.headers': [('Content-Type', 'text/plain')],
        },
        '/api/frct': {
            'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
            'tools.response_headers.on': True,
            'tools.response_headers.headers': [('Content-Type', 'text/plain')],
        },
        '/api/frft': {
            'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
            'tools.response_headers.on': True,
            'tools.response_headers.headers': [('Content-Type', 'text/plain')],
        },
    }

    my_dev = MyDev()
    my_dev.load_settings()
    webapp = BGPFlow()
    webapp.api = BGPFlowWS(my_dev=my_dev)
    webapp.api.frt = Frt(my_dev=my_dev)
    webapp.api.frct = Frtc(my_dev=my_dev)
    webapp.api.frft = Frft(my_dev=my_dev)
    cherrypy.config.update({'log.screen': False,
                            'server.socket_host': '0.0.0.0',
                            'server.socket_port': 8080,
                            })
    cherrypy.quickstart(webapp, '/', conf)