[openvpn] Simplified and improved OpenVPN parser

Author: nemesifier

netdiff/parsers/openvpn.py

@@ -1,36 +1,19 @@
 import networkx
-from openvpn_status import ParsingError, parse_status
+from openvpn_status import parse_status
 
-from ..exceptions import ConversionException, ParserError
 from .base import BaseParser
 
 
 class OpenvpnParser(BaseParser):
     """ OpenVPN status log parser """
-    protocol = 'openvpn'
-    server_address = '127.0.0.1' # Testing purposes
+    protocol = 'OpenVPN Status Log'
     version = '1'
-    metric = '0'
+    metric = 'static'
+    # for internal use only
+    _server_common_name = 'openvpn-server'
 
     def to_python(self, data):
-        status = parse_status(data)
-        nodes = []
-        for i in status.client_list:
-            node = status.client_list[i]
-            nodes.append({
-                'commonName': node.common_name,
-                'bytesSent': node.bytes_sent,
-                'bytesReceived': node.bytes_received,
-                'connectedSince': node.connected_since,
-                'realAddress': str(node.real_address)
-            })
-
-        return {
-            'type': 'OpenVPN',
-            'nodes': nodes,
-            'updated_at': status.updated_at,
-            'server': self.server_address
-        }
+        return parse_status(data)
 
     def parse(self, data):
         """
@@ -39,20 +22,24 @@ def parse(self, data):
         """
         # initialize graph and list of aggregated nodes
         graph = networkx.Graph()
-        if 'type' not in data or data['type'] != 'OpenVPN':
-            raise ParserError('Parse Error, not a OpenVPN object')
-        required_keys = ['nodes', 'server']
-        for key in required_keys:
-            if key not in data:
-                raise ParserError('Parse Error, "%s" key not found' % key)
-
-        graph.add_node(data['server'])
-        for link in data['nodes']:
-            try:
-                source = data['server']
-                target = link['realAddress']
-            except KeyError as e:
-                raise ParserError('Parse Error, "%s" key not found' % key)
-            graph.add_node(target)
-            graph.add_edge(source, target, weight=1)
+        server = self._server_common_name
+        # add server (central node) to graph
+        graph.add_node(server)
+        # add clients in graph as nodes
+        for common_name, client in data.client_list.items():
+            client_properties = {
+                'real_address': str(client.real_address.host),
+                'port': client.real_address.port,
+                'connected_since': client.connected_since.strftime('%Y-%m-%dT%H:%M:%SZ'),
+                'bytes_received': client.bytes_received,
+                'bytes_sent': client.bytes_sent
+            }
+            if common_name in data.routing_table:
+                client_properties['local_addresses'] = [
+                    str(data.routing_table.get(common_name).virtual_address)
+                ]
+            graph.add_node(common_name, **client_properties)
+        # add links in routing table to graph
+        for common_name, link in data.routing_table.items():
+            graph.add_edge(server, common_name, weight=1)
         return graph

tests/static/openvpn-2-links.txt

@@ -1,12 +1,12 @@
 OpenVPN CLIENT LIST
 Updated,Thu Jun 18 08:12:15 2015
 Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since
-foo@example.com,10.10.10.10:49502,334948,1973012,Thu Jun 18 04:23:03 2015
-bar@example.com,10.10.10.10:64169,1817262,28981224,Thu Jun 18 04:08:39 2015
+node1,87.18.10.87:49502,334948,1973012,Thu Jun 18 04:23:03 2015
+node2,93.40.230.50:64169,1817262,28981224,Thu Jun 18 04:08:39 2015
 ROUTING TABLE
 Virtual Address,Common Name,Real Address,Last Ref
-192.168.255.134,foo@example.com,10.10.10.10:49502,Thu Jun 18 08:12:09 2015
-192.168.255.126,bar@example.com,10.10.10.10:64169,Thu Jun 18 08:11:55 2015
+192.168.255.134,node1,87.18.10.87:49502,Thu Jun 18 08:12:09 2015
+192.168.255.126,node2,93.40.230.50:64169,Thu Jun 18 08:11:55 2015
 GLOBAL STATS
 Max bcast/mcast queue length,0
 END

tests/test_openvpn.py

@@ -16,17 +16,17 @@ def test_parse(self):
         p = OpenvpnParser(links2)
         self.assertIsInstance(p.graph, networkx.Graph)
         self.assertEqual(p.version, '1')
-        self.assertEqual(p.metric, '0')
+        self.assertEqual(p.metric, 'static')
 
     def test_json_dict(self):
         p = OpenvpnParser(links2)
         data = p.json(dict=True)
         self.assertIsInstance(data, dict)
         self.assertEqual(data['type'], 'NetworkGraph')
-        self.assertEqual(data['protocol'], 'openvpn')
+        self.assertEqual(data['protocol'], 'OpenVPN Status Log')
         self.assertEqual(data['version'], '1')
         self.assertEqual(data['revision'], None)
-        self.assertEqual(data['metric'], '0')
+        self.assertEqual(data['metric'], 'static')
         self.assertIsInstance(data['nodes'], list)
         self.assertIsInstance(data['links'], list)
         self.assertEqual(len(data['nodes']), 3)