Start of a GUI for tinc.
authorGuus Sliepen <guus@tinc-vpn.org>
Wed, 16 Dec 2009 20:18:21 +0000 (21:18 +0100)
committerGuus Sliepen <guus@tinc-vpn.org>
Wed, 16 Dec 2009 20:18:21 +0000 (21:18 +0100)
Makefile.am
gui/README.gui [new file with mode: 0644]
gui/Tinc.py [new file with mode: 0755]
gui/tinc-gui [new file with mode: 0755]

index b13689aa35566e99a3c9fe75e84ddd600e2d3132..ce8a4d00e36fbc8d071f47d32d4217eeb8823830 100644 (file)
@@ -6,7 +6,7 @@ SUBDIRS =  m4 lib src doc
 
 ACLOCAL_AMFLAGS = -I m4 
 
-EXTRA_DIST = have.h system.h COPYING.README
+EXTRA_DIST = have.h system.h COPYING.README gui
 
 ChangeLog:
        git log > ChangeLog
diff --git a/gui/README.gui b/gui/README.gui
new file mode 100644 (file)
index 0000000..f2b095b
--- /dev/null
@@ -0,0 +1,24 @@
+This experimental GUI is written in Python with wxPython widgets. You need to
+have both installed for it to work. After starting tinc with either tincd or
+tincctl, you can start the gui:
+
+tincd -n vpn
+tinc-gui -n vpn
+
+If the GUI cannot find the controlcookie (for example if it is not in
+/var/run), you can specify its location manually:
+
+tinc-gui --controlcookie /usr/local/var/run/tinc.vpn.cookie
+
+The following things sort of work:
+
+- Changing the debug level from the settings page
+- Viewing the list of connections, nodes, edges and subnets. These lists will
+  be refreshed once per second.
+- Right-clicking on a connection brings up a popup menu, which allows you to
+  close a connection.
+
+Python was chosen to enable rapid application development, wxWidgets for its
+cross-platform compatibility and platform-native widgets. Once the GUI is
+matured, it will probably rewritten in C++ to allow static linking and easy
+distribution, without needing to install both Python and wxWidgets.
diff --git a/gui/Tinc.py b/gui/Tinc.py
new file mode 100755 (executable)
index 0000000..d4dddd2
--- /dev/null
@@ -0,0 +1,215 @@
+#!/usr/bin/python
+
+import string
+import socket
+
+REQ_STOP = 0
+REQ_RELOAD = 1
+REQ_RESTART = 2
+REQ_DUMP_NODES = 3
+REQ_DUMP_EDGES = 4
+REQ_DUMP_SUBNETS = 5
+REQ_DUMP_CONNECTIONS = 6
+REQ_DUMP_GRAPH = 7
+REQ_PURGE = 8
+REQ_SET_DEBUG = 9
+REQ_RETRY = 10
+REQ_CONNECT = 11
+REQ_DISCONNECT = 12
+
+ID = 0
+ACK = 4
+CONTROL = 18
+
+class Node:
+       def __init__(self):
+               print('New node')
+
+       def __exit__(self):
+               print('Deleting node ' + self.name)
+
+       def parse(self, args):
+               self.name = args[0]
+               self.address = args[2]
+               if args[3] != 'port':
+                       args.insert(3, 'port')
+                       args.insert(4, '')
+               self.port = args[4]
+               self.cipher = int(args[6])
+               self.digest = int(args[8])
+               self.maclength = int(args[10])
+               self.compression = int(args[12])
+               self.options = int(args[14], 0x10)
+               self.status = int(args[16], 0x10)
+               self.nexthop = args[18]
+               self.via = args[20]
+               self.distance = int(args[22])
+               self.pmtu = int(args[24])
+               self.minmtu = int(args[26])
+               self.maxmtu = int(args[28][:-1])
+
+               self.subnets = {}
+
+class Edge:
+       def parse(self, args):
+               self.fr = args[0]
+               self.to = args[2]
+               self.address = args[4]
+               self.port = args[6]
+               self.options = int(args[8])
+               self.weight = int(args[10])
+
+class Subnet:
+       def parse(self, args):
+               if args[0].find('#') >= 0:
+                       (address, self.weight) = args[0].split('#', 1)
+               else:
+                       self.weight = 10
+                       address = args[0]
+
+               if address.find('/') >= 0:
+                       (self.address, self.prefixlen) = address.split('/', 1)
+               else:
+                       self.address = address
+                       self.prefixlen = '48'
+
+               self.owner = args[2]    
+
+class Connection:
+       def parse(self, args):
+               self.name = args[0]
+               self.address = args[2]
+               if args[3] != 'port':
+                       args.insert(3, 'port')
+                       args.insert(4, '')
+               self.port = args[4]
+               self.options = int(args[6], 0x10)
+               self.socket = int(args[8])
+               self.status = int(args[10], 0x10)
+               self.weight = 123
+
+class VPN:
+       confdir = '/etc/tinc'
+       cookiedir = '/var/run/'
+
+       def connect(self):
+               f = open(self.cookiefile)
+               cookie = string.split(f.readline())
+               f.close()
+               s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+               s.connect(('127.0.0.1', int(cookie[1])))
+               self.sf = s.makefile()
+               s.close()
+               hello = string.split(self.sf.readline())
+               self.name = hello[1]
+               self.sf.write('0 ^' + cookie[0] + ' 17\r\n')
+               self.sf.flush()
+               resp = string.split(self.sf.readline())
+               self.port = cookie[1]
+               self.nodes = {}
+               self.edges = {}
+               self.subnets = {}
+               self.connections = {}
+               self.refresh()
+
+       def refresh(self):
+               self.sf.write('18 3\r\n18 4\r\n18 5\r\n18 6\r\n')
+               self.sf.flush()
+
+               for node in self.nodes.values():
+                       node.visited = False
+               for edge in self.edges.values():
+                       edge.visited = False
+               for subnet in self.subnets.values():
+                       subnet.visited = False
+               for connections in self.connections.values():
+                       connections.visited = False
+
+               while True:
+                       resp = string.split(self.sf.readline())
+                       if len(resp) < 2:
+                               break
+                       if resp[0] != '18':
+                               break
+                       if resp[1] == '3':
+                               if len(resp) < 3:
+                                       continue
+                               node = self.nodes.get(resp[2]) or Node()
+                               node.parse(resp[2:])
+                               node.visited = True
+                               self.nodes[resp[2]] = node
+                       elif resp[1] == '4':
+                               if len(resp) < 5:
+                                       continue
+                               edge = self.nodes.get((resp[2], resp[4])) or Edge()
+                               edge.parse(resp[2:])
+                               edge.visited = True
+                               self.edges[(resp[2], resp[4])] = edge
+                       elif resp[1] == '5':
+                               if len(resp) < 5:
+                                       continue
+                               subnet = self.subnets.get((resp[2], resp[4])) or Subnet()
+                               subnet.parse(resp[2:])
+                               subnet.visited = True
+                               self.subnets[(resp[2], resp[4])] = subnet
+                               self.nodes[subnet.owner].subnets[resp[2]] = subnet
+                       elif resp[1] == '6':
+                               if len(resp) < 5:
+                                       break
+                               connection = self.connections.get((resp[2], resp[4])) or Connection()
+                               connection.parse(resp[2:])
+                               connection.visited = True
+                               self.connections[(resp[2], resp[4])] = connection
+                       else:
+                               break
+
+               for key, subnet in self.subnets.items():
+                       if not subnet.visited:
+                               del self.subnets[key]
+
+               for key, edge in self.edges.items():
+                       if not edge.visited:
+                               del self.edges[key]
+
+               for key, node in self.nodes.items():
+                       if not node.visited:
+                               del self.nodes[key]
+                       else:
+                               for key, subnet in node.subnets.items():
+                                       if not subnet.visited:
+                                               del node.subnets[key]
+
+               for key, connection in self.connections.items():
+                       if not connection.visited:
+                               del self.connections[key]
+
+       def close(self):
+               self.sf.close()
+
+       def disconnect(self, name):
+               self.sf.write('18 12 ' + name + '\r\n')
+               self.sf.flush()
+               resp = string.split(self.sf.readline())
+
+       def debug(self, level = -1):
+               self.sf.write('18 9 ' + str(level) + '\r\n')
+               self.sf.flush()
+               resp = string.split(self.sf.readline())
+               return int(resp[2])
+
+       def __init__(self, netname = None, controlcookie = None):
+               self.tincconf = VPN.confdir + '/'
+
+               if netname:
+                       self.netname = netname
+                       self.tincconf += netname + '/'
+
+               self.tincconf += 'tinc.conf'
+
+               if controlcookie is not None:
+                       self.cookiefile = controlcookie
+               else:
+                       self.cookiefile = VPN.cookiedir + 'tinc.'
+                       if netname:
+                               self.cookiefile += netname + '.'
+                       self.cookiefile += 'cookie'
diff --git a/gui/tinc-gui b/gui/tinc-gui
new file mode 100755 (executable)
index 0000000..e5c9f76
--- /dev/null
@@ -0,0 +1,317 @@
+#!/usr/bin/python
+
+import wx
+import sys
+import Tinc
+from wx.lib.mixins.listctrl import ColumnSorterMixin
+from wx.lib.mixins.listctrl import ListCtrlAutoWidthMixin
+
+del sys.argv[0]
+net = None
+controlcookie = None
+
+while len(sys.argv) >= 2:
+       if sys.argv[0] in ('-n', '--net'):
+               net = sys.argv[1]
+       elif sys.argv[0] in ('--controlcookie'):
+               controlcookie = sys.argv[1]
+       else:
+               print('Unknown option ' + sys.argv[0])
+               sys.exit(1)
+
+       del sys.argv[0]
+       del sys.argv[0]
+
+vpn = Tinc.VPN(net, controlcookie)
+vpn.connect()
+
+class SuperListCtrl(wx.ListCtrl, ColumnSorterMixin, ListCtrlAutoWidthMixin):
+    def __init__(self, parent, style):
+        wx.ListCtrl.__init__(self, parent, -1, style=wx.LC_REPORT | wx.LC_HRULES | wx.LC_VRULES)
+       ListCtrlAutoWidthMixin.__init__(self)
+        ColumnSorterMixin.__init__(self, 14)
+
+    def GetListCtrl(self):
+        return self
+
+
+class SettingsPage(wx.Panel):
+       def OnDebugLevel(self, event):
+               vpn.debug(self.debug.GetValue())
+
+       def __init__(self, parent, id):
+               wx.Panel.__init__(self, parent, id)
+               grid = wx.FlexGridSizer(cols = 2)
+               grid.AddGrowableCol(0, 1)
+
+               namelabel = wx.StaticText(self, -1, 'Name:')
+               self.name = wx.TextCtrl(self, -1, vpn.name)
+               grid.Add(namelabel)
+               grid.Add(self.name)
+
+               portlabel = wx.StaticText(self, -1, 'Port:')
+               self.port = wx.TextCtrl(self, -1, vpn.port)
+               grid.Add(portlabel)
+               grid.Add(self.port)
+
+               debuglabel = wx.StaticText(self, -1, 'Debug level:')
+               self.debug = wx.SpinCtrl(self, min = 0, max = 5, initial = vpn.debug())
+               self.debug.Bind(wx.EVT_SPINCTRL, self.OnDebugLevel)
+               grid.Add(debuglabel)
+               grid.Add(self.debug)
+
+               modelabel = wx.StaticText(self, -1, 'Mode:')
+               self.mode = wx.ComboBox(self, -1, style = wx.CB_READONLY, value = 'Router', choices = ['Router', 'Switch', 'Hub'])
+               grid.Add(modelabel)
+               grid.Add(self.mode)
+
+               self.SetSizer(grid)
+
+class ConnectionsPage(wx.Panel):
+       def __init__(self, parent, id):
+               wx.Panel.__init__(self, parent, id)
+               self.list = wx.ListCtrl(self, id, style=wx.LC_REPORT | wx.LC_HRULES | wx.LC_VRULES)
+               self.list.InsertColumn(0, 'Name')
+               self.list.InsertColumn(1, 'Address')
+               self.list.InsertColumn(2, 'Port')
+               self.list.InsertColumn(3, 'Options')
+               self.list.InsertColumn(4, 'Weight')
+
+               hbox = wx.BoxSizer(wx.HORIZONTAL)
+               hbox.Add(self.list, 1, wx.EXPAND)
+               self.SetSizer(hbox)
+               self.refresh()
+
+       class ContextMenu(wx.Menu):
+               def __init__(self, item):
+                       wx.Menu.__init__(self)
+
+                       self.item = item
+
+                       disconnect = wx.MenuItem(self, -1, 'Disconnect')
+                       self.AppendItem(disconnect)
+                       self.Bind(wx.EVT_MENU, self.OnDisconnect, id=disconnect.GetId())
+
+               def OnDisconnect(self, event):
+                       print('Disconnecting ' + self.item[0])
+                       vpn.disconnect(self.item[0])
+
+       def OnContext(self, event):
+               print('Context menu!')
+               i = event.GetIndex()
+               print(i)
+               self.PopupMenu(self.ContextMenu(self.list.itemDataMap[event.GetIndex()]), event.GetPosition())
+
+       def refresh(self):
+               self.list.itemDataMap = {}
+               i = 0
+
+               for key, connection in vpn.connections.items():
+                       if self.list.ItemCount <= i:
+                               self.list.InsertStringItem(i, connection.name)
+                       else:
+                               self.list.SetStringItem(i, 0, connection.name)
+                       self.list.SetStringItem(i, 1, connection.address)
+                       self.list.SetStringItem(i, 2, connection.port)
+                       self.list.SetStringItem(i, 3, str(connection.options))
+                       self.list.SetStringItem(i, 4, str(connection.weight))
+                       self.list.itemDataMap[i] = (connection.name, connection.address, connection.port, connection.options, connection.weight)
+                       self.list.Bind(wx.EVT_LIST_ITEM_RIGHT_CLICK, self.OnContext)
+                       i += 1
+
+               while self.list.ItemCount > i:
+                       self.list.DeleteItem(self.list.ItemCount - 1)
+
+
+class NodesPage(wx.Panel):
+       def __init__(self, parent, id):
+               wx.Panel.__init__(self, parent, id)
+               self.list = SuperListCtrl(self, id)
+               self.list.InsertColumn( 0, 'Name')
+               self.list.InsertColumn( 1, 'Address')
+               self.list.InsertColumn( 2, 'Port')
+               self.list.InsertColumn( 3, 'Cipher')
+               self.list.InsertColumn( 4, 'Digest')
+               self.list.InsertColumn( 5, 'MACLength')
+               self.list.InsertColumn( 6, 'Compression')
+               self.list.InsertColumn( 7, 'Options')
+               self.list.InsertColumn( 8, 'Status')
+               self.list.InsertColumn( 9, 'Nexthop')
+               self.list.InsertColumn(10, 'Via')
+               self.list.InsertColumn(11, 'Distance')
+               self.list.InsertColumn(12, 'PMTU')
+               self.list.InsertColumn(13, 'Min MTU')
+               self.list.InsertColumn(14, 'Max MTU')
+
+               hbox = wx.BoxSizer(wx.HORIZONTAL)
+               hbox.Add(self.list, 1, wx.EXPAND)
+               self.SetSizer(hbox)
+               self.refresh()
+
+       def refresh(self):
+               self.list.itemDataMap = {}
+               i = 0
+
+               for key, node in vpn.nodes.items():
+                       if self.list.ItemCount <= i:
+                               self.list.InsertStringItem(i, node.name)
+                       else:
+                               self.list.SetStringItem(i,  0, node.name)
+                       self.list.SetStringItem(i,  1, node.address)
+                       self.list.SetStringItem(i,  2, node.port)
+                       self.list.SetStringItem(i,  3, str(node.cipher))
+                       self.list.SetStringItem(i,  4, str(node.digest))
+                       self.list.SetStringItem(i,  5, str(node.maclength))
+                       self.list.SetStringItem(i,  6, str(node.compression))
+                       self.list.SetStringItem(i,  7, str(node.options))
+                       self.list.SetStringItem(i,  8, str(node.status))
+                       self.list.SetStringItem(i,  9, node.nexthop)
+                       self.list.SetStringItem(i, 10, node.via)
+                       self.list.SetStringItem(i, 11, str(node.distance))
+                       self.list.SetStringItem(i, 12, str(node.pmtu))
+                       self.list.SetStringItem(i, 13, str(node.minmtu))
+                       self.list.SetStringItem(i, 14, str(node.maxmtu))
+                       self.list.itemDataMap[i] = (node.name, node.address, node.port, node.cipher, node.digest, node.maclength, node.compression, node.options, node.status, node.nexthop, node.via, node.distance, node.pmtu, node.minmtu, node.maxmtu)
+                       self.list.SetItemData(i, i)
+                       i += 1
+
+               while self.list.ItemCount > i:
+                       self.list.DeleteItem(self.list.ItemCount - 1)
+
+class EdgesPage(wx.Panel):
+       def __init__(self, parent, id):
+               wx.Panel.__init__(self, parent, id)
+               self.list = wx.ListCtrl(self, id, style=wx.LC_REPORT | wx.LC_HRULES | wx.LC_VRULES)
+               self.list.InsertColumn(0, 'From')
+               self.list.InsertColumn(1, 'To')
+               self.list.InsertColumn(2, 'Address')
+               self.list.InsertColumn(3, 'Port')
+               self.list.InsertColumn(4, 'Options')
+               self.list.InsertColumn(5, 'Weight')
+
+               hbox = wx.BoxSizer(wx.HORIZONTAL)
+               hbox.Add(self.list, 1, wx.EXPAND)
+               self.SetSizer(hbox)
+               self.refresh()
+
+       def refresh(self):
+               self.list.itemDataMap = {}
+               i = 0
+
+               for key, edge in vpn.edges.items():
+                       if self.list.ItemCount <= i:
+                               self.list.InsertStringItem(i, edge.fr)
+                       else:
+                               self.list.SetStringItem(i, 0, edge.fr)
+                       self.list.SetStringItem(i, 1, edge.to)
+                       self.list.SetStringItem(i, 2, edge.address)
+                       self.list.SetStringItem(i, 3, edge.port)
+                       self.list.SetStringItem(i, 4, str(edge.options))
+                       self.list.SetStringItem(i, 5, str(edge.weight))
+                       self.list.itemDataMap[i] = (edge.fr, edge.to, edge.address, edge.port, edge.options, edge.weight)
+                       i += 1
+
+               while self.list.ItemCount > i:
+                       self.list.DeleteItem(self.list.ItemCount - 1)
+
+class SubnetsPage(wx.Panel):
+       def __init__(self, parent, id):
+               wx.Panel.__init__(self, parent, id)
+               self.list = SuperListCtrl(self, id)
+               self.list.InsertColumn(0, 'Subnet', wx.LIST_FORMAT_RIGHT)
+               self.list.InsertColumn(1, 'Weight', wx.LIST_FORMAT_RIGHT)
+               self.list.InsertColumn(2, 'Owner')
+               hbox = wx.BoxSizer(wx.HORIZONTAL)
+               hbox.Add(self.list, 1, wx.EXPAND)
+               self.SetSizer(hbox)
+               self.refresh()
+
+       def refresh(self):
+               self.list.itemDataMap = {}
+               i = 0
+
+               for key, subnet in vpn.subnets.items():
+                       if self.list.ItemCount <= i:
+                               self.list.InsertStringItem(i, subnet.address + '/' + subnet.prefixlen)
+                       else:
+                               self.list.SetStringItem(i, 0, subnet.address + '/' + subnet.prefixlen)
+                       self.list.SetStringItem(i, 1, subnet.weight)
+                       self.list.SetStringItem(i, 2, subnet.owner)
+                       self.list.itemDataMap[i] = (subnet.address + '/' + subnet.prefixlen, subnet.weight, subnet.owner)
+                       i = i + 1
+
+               while self.list.ItemCount > i:
+                       self.list.DeleteItem(self.list.ItemCount - 1)
+
+class StatusPage(wx.Panel):
+       def __init__(self, parent, id):
+               wx.Panel.__init__(self, parent, id)
+
+class GraphPage(wx.Window):
+       def __init__(self, parent, id):
+               wx.Window.__init__(self, parent, id)
+
+class NetPage(wx.Notebook):
+       def __init__(self, parent, id):
+               wx.Notebook.__init__(self, parent)
+               self.settings = SettingsPage(self, id)
+               self.connections = ConnectionsPage(self, id)
+               self.nodes = NodesPage(self, id)
+               self.edges = EdgesPage(self, id)
+               self.subnets = SubnetsPage(self, id)
+               self.graph = GraphPage(self, id)
+               self.status = StatusPage(self, id)
+
+               self.AddPage(self.settings, 'Settings')
+               #self.AddPage(self.status, 'Status')
+               self.AddPage(self.connections, 'Connections')
+               self.AddPage(self.nodes, 'Nodes')
+               self.AddPage(self.edges, 'Edges')
+               self.AddPage(self.subnets, 'Subnets')
+               #self.AddPage(self.graph, 'Graph')
+               
+
+class MainWindow(wx.Frame):
+       def OnQuit(self, event):
+               self.Close(True)
+
+       def OnTimer(self, event):
+               vpn.refresh()
+               self.np.nodes.refresh()
+               self.np.subnets.refresh()
+               self.np.edges.refresh()
+               self.np.connections.refresh()
+
+       def __init__(self, parent, id, title):
+               wx.Frame.__init__(self, parent, id, title)
+
+               menubar = wx.MenuBar()
+               file = wx.Menu()
+               file.Append(1, '&Quit\tCtrl-X', 'Quit tinc GUI')
+               menubar.Append(file, '&File')
+
+               #nb = wx.Notebook(self, -1)
+               #nb.SetPadding((0, 0))
+               self.np = NetPage(self, -1)
+               #nb.AddPage(np, 'VPN')
+               
+               self.timer = wx.Timer(self, -1)
+               self.Bind(wx.EVT_TIMER, self.OnTimer, self.timer)
+               self.timer.Start(1000)
+               self.Bind(wx.EVT_MENU, self.OnQuit, id=1)
+               self.SetMenuBar(menubar)
+               self.Show()
+
+app = wx.App()
+mw = MainWindow(None, -1, 'Tinc GUI')
+
+#def OnTaskBarIcon(event):
+#      mw.Raise()
+#
+#icon = wx.Icon("tincgui.ico", wx.BITMAP_TYPE_PNG)
+#taskbaricon = wx.TaskBarIcon()
+#taskbaricon.SetIcon(icon, 'Tinc GUI')
+#wx.EVT_TASKBAR_RIGHT_UP(taskbaricon, OnTaskBarIcon)
+
+app.MainLoop()
+vpn.close()