#!/usr/bin/env python # -*- coding: utf-8 -*- # # Ethernet over WebSocket # # depends on: # - python-2.7.2 # - python-pytun-0.2 # - websocket-client-0.7.0 # - tornado-2.3 # # =========================================================================== # Copyright (c) 2012, Atzm WATANABE # All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met: # # 1. Redistributions of source code must retain the above copyright notice, # this list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the above copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # =========================================================================== # # $Id$ import os import sys import ssl import time import json import fcntl import base64 import socket import urllib2 import hashlib import getpass import argparse import traceback import tornado import websocket from tornado.web import Application, RequestHandler from tornado.websocket import WebSocketHandler from tornado.httpserver import HTTPServer from tornado.ioloop import IOLoop from pytun import TunTapDevice, IFF_TAP, IFF_NO_PI class DebugMixIn(object): def dprintf(self, msg, func=lambda: ()): if self._debug: prefix = '[%s] %s - ' % (time.asctime(), self.__class__.__name__) sys.stderr.write(prefix + (msg % func())) class EthernetFrame(object): def __init__(self, data): self.data = data @property def dst_multicast(self): return ord(self.data[0]) & 1 @property def src_multicast(self): return ord(self.data[6]) & 1 @property def dst_mac(self): return self.data[:6] @property def src_mac(self): return self.data[6:12] @property def tagged(self): return ord(self.data[12]) == 0x81 and ord(self.data[13]) == 0 @property def vid(self): if self.tagged: return ((ord(self.data[14]) << 8) | ord(self.data[15])) & 0x0fff return 0 @staticmethod def format_mac(mac, sep=':'): return sep.join(b.encode('hex') for b in mac) class FDB(DebugMixIn): class Entry(object): def __init__(self, port, ageout): self.port = port self._time = time.time() self._ageout = ageout @property def age(self): return time.time() - self._time @property def agedout(self): return self.age > self._ageout def __init__(self, ageout, debug=False): self._ageout = ageout self._debug = debug self._table = {} def _set_entry(self, vid, mac, port): if vid not in self._table: self._table[vid] = {} self._table[vid][mac] = self.Entry(port, self._ageout) def _del_entry(self, vid, mac): if vid in self._table: if mac in self._table[vid]: del self._table[vid][mac] if not self._table[vid]: del self._table[vid] def _get_entry(self, vid, mac): try: entry = self._table[vid][mac] except KeyError: return None if not entry.agedout: return entry self._del_entry(vid, mac) self.dprintf('aged out: port:%d; vid:%d; mac:%s\n', lambda: (entry.port.number, vid, mac.encode('hex'))) def each(self): for vid in sorted(self._table.iterkeys()): for mac in sorted(self._table[vid].iterkeys()): entry = self._get_entry(vid, mac) if entry: yield (vid, mac, entry) def lookup(self, frame): mac = frame.dst_mac vid = frame.vid entry = self._get_entry(vid, mac) return getattr(entry, 'port', None) def learn(self, port, frame): mac = frame.src_mac vid = frame.vid self._set_entry(vid, mac, port) self.dprintf('learned: port:%d; vid:%d; mac:%s\n', lambda: (port.number, vid, mac.encode('hex'))) def delete(self, port): for vid, mac, entry in self.each(): if entry.port.number == port.number: self._del_entry(vid, mac) self.dprintf('deleted: port:%d; vid:%d; mac:%s\n', lambda: (port.number, vid, mac.encode('hex'))) class SwitchingHub(DebugMixIn): class Port(object): def __init__(self, number, interface): self.number = number self.interface = interface self.tx = 0 self.rx = 0 self.shut = False @staticmethod def cmp_by_number(x, y): return cmp(x.number, y.number) def __init__(self, fdb, debug=False): self.fdb = fdb self._debug = debug self._table = {} self._next = 1 @property def portlist(self): return sorted(self._table.itervalues(), cmp=self.Port.cmp_by_number) def get_port(self, portnum): return self._table[portnum] def register_port(self, interface): try: self._set_privattr('portnum', interface, self._next) # XXX self._table[self._next] = self.Port(self._next, interface) return self._next finally: self._next += 1 def unregister_port(self, interface): portnum = self._get_privattr('portnum', interface) self._del_privattr('portnum', interface) self.fdb.delete(self._table[portnum]) del self._table[portnum] def send(self, dst_interfaces, frame): portnums = (self._get_privattr('portnum', i) for i in dst_interfaces) ports = (self._table[n] for n in portnums) ports = (p for p in ports if not p.shut) ports = sorted(ports, cmp=self.Port.cmp_by_number) for p in ports: p.interface.write_message(frame.data, True) p.tx += 1 if ports: self.dprintf('sent: port:%s; vid:%d; %s -> %s\n', lambda: (','.join(str(p.number) for p in ports), frame.vid, frame.src_mac.encode('hex'), frame.dst_mac.encode('hex'))) def receive(self, src_interface, frame): port = self._table[self._get_privattr('portnum', src_interface)] if not port.shut: port.rx += 1 self._forward(port, frame) def _forward(self, src_port, frame): try: if not frame.src_multicast: self.fdb.learn(src_port, frame) if not frame.dst_multicast: dst_port = self.fdb.lookup(frame) if dst_port: self.send([dst_port.interface], frame) return ports = set(self.portlist) - set([src_port]) self.send((p.interface for p in ports), frame) except: # ex. received invalid frame traceback.print_exc() def _privattr(self, name): return '_%s_%s_%s' % (self.__class__.__name__, id(self), name) def _set_privattr(self, name, obj, value): return setattr(obj, self._privattr(name), value) def _get_privattr(self, name, obj, defaults=None): return getattr(obj, self._privattr(name), defaults) def _del_privattr(self, name, obj): return delattr(obj, self._privattr(name)) class Htpasswd(object): def __init__(self, path): self._path = path self._stat = None self._data = {} def auth(self, name, passwd): passwd = base64.b64encode(hashlib.sha1(passwd).digest()) return self._data.get(name) == passwd def load(self): old_stat = self._stat with open(self._path) as fp: fileno = fp.fileno() fcntl.flock(fileno, fcntl.LOCK_SH | fcntl.LOCK_NB) self._stat = os.fstat(fileno) unchanged = old_stat and \ old_stat.st_ino == self._stat.st_ino and \ old_stat.st_dev == self._stat.st_dev and \ old_stat.st_mtime == self._stat.st_mtime if not unchanged: self._data = self._parse(fp) return self def _parse(self, fp): data = {} for line in fp: line = line.strip() if 0 <= line.find(':'): name, passwd = line.split(':', 1) if passwd.startswith('{SHA}'): data[name] = passwd[5:] return data class BasicAuthMixIn(object): def _execute(self, transforms, *args, **kwargs): def do_execute(): sp = super(BasicAuthMixIn, self) return sp._execute(transforms, *args, **kwargs) def auth_required(): stream = getattr(self, 'stream', self.request.connection.stream) stream.write(tornado.escape.utf8( 'HTTP/1.1 401 Authorization Required\r\n' 'WWW-Authenticate: Basic realm=etherws\r\n\r\n' )) stream.close() try: if not self._htpasswd: return do_execute() creds = self.request.headers.get('Authorization') if not creds or not creds.startswith('Basic '): return auth_required() name, passwd = base64.b64decode(creds[6:]).split(':', 1) if self._htpasswd.load().auth(name, passwd): return do_execute() except: traceback.print_exc() return auth_required() class EtherWebSocketHandler(DebugMixIn, BasicAuthMixIn, WebSocketHandler): IFTYPE = 'server' def __init__(self, app, req, switch, htpasswd=None, debug=False): super(EtherWebSocketHandler, self).__init__(app, req) self._switch = switch self._htpasswd = htpasswd self._debug = debug @property def target(self): return ':'.join(str(e) for e in self.request.connection.address) def open(self): try: return self._switch.register_port(self) finally: self.dprintf('connected: %s\n', lambda: self.request.remote_ip) def on_message(self, message): self._switch.receive(self, EthernetFrame(message)) def on_close(self): self._switch.unregister_port(self) self.dprintf('disconnected: %s\n', lambda: self.request.remote_ip) class NetdevHandler(DebugMixIn): IFTYPE = 'netdev' READ_SIZE = 65535 ETH_P_ALL = 0x0003 # from def __init__(self, ioloop, switch, dev, debug=False): self._ioloop = ioloop self._switch = switch self._dev = dev self._debug = debug self._sock = None @property def target(self): return self._dev @property def closed(self): return not self._sock def open(self): if not self.closed: raise ValueError('Already opened') self._sock = socket.socket( socket.PF_PACKET, socket.SOCK_RAW, socket.htons(self.ETH_P_ALL)) self._sock.bind((self._dev, self.ETH_P_ALL)) self._ioloop.add_handler(self.fileno(), self, self._ioloop.READ) return self._switch.register_port(self) def close(self): if self.closed: raise ValueError('I/O operation on closed netdev') self._switch.unregister_port(self) self._ioloop.remove_handler(self.fileno()) self._sock.close() self._sock = None def fileno(self): if self.closed: raise ValueError('I/O operation on closed netdev') return self._sock.fileno() def write_message(self, message, binary=False): if self.closed: raise ValueError('I/O operation on closed netdev') self._sock.sendall(message) def __call__(self, fd, events): try: self._switch.receive(self, EthernetFrame(self._read())) return except: traceback.print_exc() self.close() def _read(self): if self.closed: raise ValueError('I/O operation on closed netdev') buf = [] while True: buf.append(self._sock.recv(self.READ_SIZE)) if len(buf[-1]) < self.READ_SIZE: break return ''.join(buf) class TapHandler(DebugMixIn): IFTYPE = 'tap' READ_SIZE = 65535 def __init__(self, ioloop, switch, dev, debug=False): self._ioloop = ioloop self._switch = switch self._dev = dev self._debug = debug self._tap = None @property def target(self): if self.closed: return self._dev return self._tap.name @property def closed(self): return not self._tap @property def address(self): if self.closed: raise ValueError('I/O operation on closed tap') try: return self._tap.addr except: return '' @property def netmask(self): if self.closed: raise ValueError('I/O operation on closed tap') try: return self._tap.netmask except: return '' @property def mtu(self): if self.closed: raise ValueError('I/O operation on closed tap') return self._tap.mtu @address.setter def address(self, address): if self.closed: raise ValueError('I/O operation on closed tap') self._tap.addr = address @netmask.setter def netmask(self, netmask): if self.closed: raise ValueError('I/O operation on closed tap') self._tap.netmask = netmask @mtu.setter def mtu(self, mtu): if self.closed: raise ValueError('I/O operation on closed tap') self._tap.mtu = mtu def open(self): if not self.closed: raise ValueError('Already opened') self._tap = TunTapDevice(self._dev, IFF_TAP | IFF_NO_PI) self._tap.up() self._ioloop.add_handler(self.fileno(), self, self._ioloop.READ) return self._switch.register_port(self) def close(self): if self.closed: raise ValueError('I/O operation on closed tap') self._switch.unregister_port(self) self._ioloop.remove_handler(self.fileno()) self._tap.close() self._tap = None def fileno(self): if self.closed: raise ValueError('I/O operation on closed tap') return self._tap.fileno() def write_message(self, message, binary=False): if self.closed: raise ValueError('I/O operation on closed tap') self._tap.write(message) def __call__(self, fd, events): try: self._switch.receive(self, EthernetFrame(self._read())) return except: traceback.print_exc() self.close() def _read(self): if self.closed: raise ValueError('I/O operation on closed tap') buf = [] while True: buf.append(self._tap.read(self.READ_SIZE)) if len(buf[-1]) < self.READ_SIZE: break return ''.join(buf) class EtherWebSocketClient(DebugMixIn): IFTYPE = 'client' def __init__(self, ioloop, switch, url, ssl_=None, cred=None, debug=False): self._ioloop = ioloop self._switch = switch self._url = url self._ssl = ssl_ self._debug = debug self._sock = None self._options = {} if isinstance(cred, dict) and cred['user'] and cred['passwd']: token = base64.b64encode('%s:%s' % (cred['user'], cred['passwd'])) auth = ['Authorization: Basic %s' % token] self._options['header'] = auth @property def target(self): return self._url @property def closed(self): return not self._sock def open(self): sslwrap = websocket._SSLSocketWrapper if not self.closed: raise websocket.WebSocketException('Already opened') if self._ssl: websocket._SSLSocketWrapper = self._ssl # XXX: may be blocked try: self._sock = websocket.WebSocket() self._sock.connect(self._url, **self._options) self._ioloop.add_handler(self.fileno(), self, self._ioloop.READ) self.dprintf('connected: %s\n', lambda: self._url) return self._switch.register_port(self) finally: websocket._SSLSocketWrapper = sslwrap def close(self): if self.closed: raise websocket.WebSocketException('Already closed') self._switch.unregister_port(self) self._ioloop.remove_handler(self.fileno()) self._sock.close() self._sock = None self.dprintf('disconnected: %s\n', lambda: self._url) def fileno(self): if self.closed: raise websocket.WebSocketException('Closed socket') return self._sock.io_sock.fileno() def write_message(self, message, binary=False): if self.closed: raise websocket.WebSocketException('Closed socket') if binary: flag = websocket.ABNF.OPCODE_BINARY else: flag = websocket.ABNF.OPCODE_TEXT self._sock.send(message, flag) def __call__(self, fd, events): try: data = self._sock.recv() if data is not None: self._switch.receive(self, EthernetFrame(data)) return except: traceback.print_exc() self.close() class EtherWebSocketControlHandler(DebugMixIn, BasicAuthMixIn, RequestHandler): NAMESPACE = 'etherws.control' IFTYPES = { NetdevHandler.IFTYPE: NetdevHandler, TapHandler.IFTYPE: TapHandler, EtherWebSocketClient.IFTYPE: EtherWebSocketClient, } def __init__(self, app, req, ioloop, switch, htpasswd=None, debug=False): super(EtherWebSocketControlHandler, self).__init__(app, req) self._ioloop = ioloop self._switch = switch self._htpasswd = htpasswd self._debug = debug def post(self): try: request = json.loads(self.request.body) except Exception as e: return self._jsonrpc_response(error={ 'code': 0 - 32700, 'message': 'Parse error', 'data': '%s: %s' % (e.__class__.__name__, str(e)), }) try: id_ = request.get('id') params = request.get('params') version = request['jsonrpc'] method = request['method'] if version != '2.0': raise ValueError('Invalid JSON-RPC version: %s' % version) except Exception as e: return self._jsonrpc_response(id_=id_, error={ 'code': 0 - 32600, 'message': 'Invalid Request', 'data': '%s: %s' % (e.__class__.__name__, str(e)), }) try: if not method.startswith(self.NAMESPACE + '.'): raise ValueError('Invalid method namespace: %s' % method) handler = 'handle_' + method[len(self.NAMESPACE) + 1:] handler = getattr(self, handler) except Exception as e: return self._jsonrpc_response(id_=id_, error={ 'code': 0 - 32601, 'message': 'Method not found', 'data': '%s: %s' % (e.__class__.__name__, str(e)), }) try: return self._jsonrpc_response(id_=id_, result=handler(params)) except Exception as e: traceback.print_exc() return self._jsonrpc_response(id_=id_, error={ 'code': 0 - 32602, 'message': 'Invalid params', 'data': '%s: %s' % (e.__class__.__name__, str(e)), }) def handle_listFdb(self, params): list_ = [] for vid, mac, entry in self._switch.fdb.each(): list_.append({ 'vid': vid, 'mac': EthernetFrame.format_mac(mac), 'port': entry.port.number, 'age': int(entry.age), }) return {'entries': list_} def handle_listPort(self, params): return {'entries': [self._portstat(p) for p in self._switch.portlist]} def handle_addPort(self, params): type_ = params['type'] target = params['target'] opts = getattr(self, '_optparse_' + type_)(params.get('options', {})) cls = self.IFTYPES[type_] interface = cls(self._ioloop, self._switch, target, **opts) portnum = interface.open() return {'entries': [self._portstat(self._switch.get_port(portnum))]} def handle_setPort(self, params): port = self._switch.get_port(int(params['port'])) shut = params.get('shut') if shut is not None: port.shut = bool(shut) return {'entries': [self._portstat(port)]} def handle_delPort(self, params): port = self._switch.get_port(int(params['port'])) port.interface.close() return {'entries': [self._portstat(port)]} def handle_setInterface(self, params): portnum = int(params['port']) port = self._switch.get_port(portnum) address = params.get('address') netmask = params.get('netmask') mtu = params.get('mtu') if not isinstance(port.interface, TapHandler): raise ValueError('Port %d has unsupported interface: %s' % (portnum, port.interface.IFTYPE)) if address is not None: port.interface.address = address if netmask is not None: port.interface.netmask = netmask if mtu is not None: port.interface.mtu = mtu return {'entries': [self._ifstat(port)]} def handle_listInterface(self, params): return {'entries': [self._ifstat(p) for p in self._switch.portlist if isinstance(p.interface, TapHandler)]} def _optparse_netdev(self, opt): return {'debug': self._debug} def _optparse_tap(self, opt): return {'debug': self._debug} def _optparse_client(self, opt): args = {'cert_reqs': ssl.CERT_REQUIRED, 'ca_certs': opt.get('cacerts')} if opt.get('insecure'): args = {} ssl_ = lambda sock: ssl.wrap_socket(sock, **args) cred = {'user': opt.get('user'), 'passwd': opt.get('passwd')} return {'ssl_': ssl_, 'cred': cred, 'debug': self._debug} def _jsonrpc_response(self, id_=None, result=None, error=None): res = {'jsonrpc': '2.0', 'id': id_} if result: res['result'] = result if error: res['error'] = error self.finish(res) @staticmethod def _portstat(port): return { 'port': port.number, 'type': port.interface.IFTYPE, 'target': port.interface.target, 'tx': port.tx, 'rx': port.rx, 'shut': port.shut, } @staticmethod def _ifstat(port): return { 'port': port.number, 'type': port.interface.IFTYPE, 'target': port.interface.target, 'address': port.interface.address, 'netmask': port.interface.netmask, 'mtu': port.interface.mtu, } def _print_error(error): print(' %s (%s)' % (error['message'], error['code'])) print(' %s' % error['data']) def _start_sw(args): def daemonize(nochdir=False, noclose=False): if os.fork() > 0: sys.exit(0) os.setsid() if os.fork() > 0: sys.exit(0) if not nochdir: os.chdir('/') if not noclose: os.umask(0) sys.stdin.close() sys.stdout.close() sys.stderr.close() os.close(0) os.close(1) os.close(2) sys.stdin = open(os.devnull) sys.stdout = open(os.devnull, 'a') sys.stderr = open(os.devnull, 'a') def checkabspath(ns, path): val = getattr(ns, path, '') if not val.startswith('/'): raise ValueError('Invalid %: %s' % (path, val)) def getsslopt(ns, key, cert): kval = getattr(ns, key, None) cval = getattr(ns, cert, None) if kval and cval: return {'keyfile': kval, 'certfile': cval} elif kval or cval: raise ValueError('Both %s and %s are required' % (key, cert)) return None def setrealpath(ns, *keys): for k in keys: v = getattr(ns, k, None) if v is not None: v = os.path.realpath(v) open(v).close() # check readable setattr(ns, k, v) def setport(ns, port, isssl): val = getattr(ns, port, None) if val is None: if isssl: return setattr(ns, port, 443) return setattr(ns, port, 80) if not (0 <= val <= 65535): raise ValueError('Invalid %s: %s' % (port, val)) def sethtpasswd(ns, htpasswd): val = getattr(ns, htpasswd, None) if val: return setattr(ns, htpasswd, Htpasswd(val)) #if args.debug: # websocket.enableTrace(True) if args.ageout <= 0: raise ValueError('Invalid ageout: %s' % args.ageout) setrealpath(args, 'htpasswd', 'sslkey', 'sslcert') setrealpath(args, 'ctlhtpasswd', 'ctlsslkey', 'ctlsslcert') checkabspath(args, 'path') checkabspath(args, 'ctlpath') sslopt = getsslopt(args, 'sslkey', 'sslcert') ctlsslopt = getsslopt(args, 'ctlsslkey', 'ctlsslcert') setport(args, 'port', sslopt) setport(args, 'ctlport', ctlsslopt) sethtpasswd(args, 'htpasswd') sethtpasswd(args, 'ctlhtpasswd') ioloop = IOLoop.instance() fdb = FDB(ageout=args.ageout, debug=args.debug) switch = SwitchingHub(fdb, debug=args.debug) if args.port == args.ctlport and args.host == args.ctlhost: if args.path == args.ctlpath: raise ValueError('Same path/ctlpath on same host') if args.sslkey != args.ctlsslkey: raise ValueError('Different sslkey/ctlsslkey on same host') if args.sslcert != args.ctlsslcert: raise ValueError('Different sslcert/ctlsslcert on same host') app = Application([ (args.path, EtherWebSocketHandler, { 'switch': switch, 'htpasswd': args.htpasswd, 'debug': args.debug, }), (args.ctlpath, EtherWebSocketControlHandler, { 'ioloop': ioloop, 'switch': switch, 'htpasswd': args.ctlhtpasswd, 'debug': args.debug, }), ]) server = HTTPServer(app, ssl_options=sslopt) server.listen(args.port, address=args.host) else: app = Application([(args.path, EtherWebSocketHandler, { 'switch': switch, 'htpasswd': args.htpasswd, 'debug': args.debug, })]) server = HTTPServer(app, ssl_options=sslopt) server.listen(args.port, address=args.host) ctl = Application([(args.ctlpath, EtherWebSocketControlHandler, { 'ioloop': ioloop, 'switch': switch, 'htpasswd': args.ctlhtpasswd, 'debug': args.debug, })]) ctlserver = HTTPServer(ctl, ssl_options=ctlsslopt) ctlserver.listen(args.ctlport, address=args.ctlhost) if not args.foreground: daemonize() ioloop.start() def _start_ctl(args): def request(args, method, params=None, id_=0): req = urllib2.Request(args.ctlurl) req.add_header('Content-type', 'application/json') if args.ctluser: if not args.ctlpasswd: args.ctlpasswd = getpass.getpass('Control Password: ') token = base64.b64encode('%s:%s' % (args.ctluser, args.ctlpasswd)) req.add_header('Authorization', 'Basic %s' % token) method = '.'.join([EtherWebSocketControlHandler.NAMESPACE, method]) data = {'jsonrpc': '2.0', 'method': method, 'id': id_} if params is not None: data['params'] = params return json.loads(urllib2.urlopen(req, json.dumps(data)).read()) def maxlen(dict_, key, min_): if not dict_: return min_ max_ = max(len(str(r[key])) for r in dict_) return min_ if max_ < min_ else max_ def print_portlist(result): pmax = maxlen(result, 'port', 4) ymax = maxlen(result, 'type', 4) smax = maxlen(result, 'shut', 5) rmax = maxlen(result, 'rx', 2) tmax = maxlen(result, 'tx', 2) fmt = ' %%%ds %%%ds %%%ds %%%ds %%%ds %%s' % \ (pmax, ymax, smax, rmax, tmax) print(fmt % ('Port', 'Type', 'State', 'RX', 'TX', 'Target')) for r in result: shut = 'shut' if r['shut'] else 'up' print(fmt % (r['port'], r['type'], shut, r['rx'], r['tx'], r['target'])) def print_iflist(result): pmax = maxlen(result, 'port', 4) tmax = maxlen(result, 'type', 4) amax = maxlen(result, 'address', 7) nmax = maxlen(result, 'netmask', 7) mmax = maxlen(result, 'mtu', 3) fmt = ' %%%ds %%%ds %%%ds %%%ds %%%ds %%s' % \ (pmax, tmax, amax, nmax, mmax) print(fmt % ('Port', 'Type', 'Address', 'Netmask', 'MTU', 'Target')) for r in result: print(fmt % (r['port'], r['type'], r['address'], r['netmask'], r['mtu'], r['target'])) def handle_ctl_addport(args): opts = { 'user': getattr(args, 'user', None), 'passwd': getattr(args, 'passwd', None), 'cacerts': getattr(args, 'cacerts', None), 'insecure': getattr(args, 'insecure', None), } if args.iftype == EtherWebSocketClient.IFTYPE: if not args.target.startswith('ws://') and \ not args.target.startswith('wss://'): raise ValueError('Invalid target URL scheme: %s' % args.target) if not opts['user'] and opts['passwd']: raise ValueError('Authentication required but username empty') if opts['user'] and not opts['passwd']: opts['passwd'] = getpass.getpass('Client Password: ') result = request(args, 'addPort', { 'type': args.iftype, 'target': args.target, 'options': opts, }) if 'error' in result: _print_error(result['error']) else: print_portlist(result['result']['entries']) def handle_ctl_setport(args): if args.port <= 0: raise ValueError('Invalid port: %d' % args.port) req = {'port': args.port} shut = getattr(args, 'shut', None) if shut is not None: req['shut'] = bool(shut) result = request(args, 'setPort', req) if 'error' in result: _print_error(result['error']) else: print_portlist(result['result']['entries']) def handle_ctl_delport(args): if args.port <= 0: raise ValueError('Invalid port: %d' % args.port) result = request(args, 'delPort', {'port': args.port}) if 'error' in result: _print_error(result['error']) else: print_portlist(result['result']['entries']) def handle_ctl_listport(args): result = request(args, 'listPort') if 'error' in result: _print_error(result['error']) else: print_portlist(result['result']['entries']) def handle_ctl_setif(args): if args.port <= 0: raise ValueError('Invalid port: %d' % args.port) req = {'port': args.port} address = getattr(args, 'address', None) netmask = getattr(args, 'netmask', None) mtu = getattr(args, 'mtu', None) if address is not None: if address: socket.inet_aton(address) # validate req['address'] = address if netmask is not None: if netmask: socket.inet_aton(netmask) # validate req['netmask'] = netmask if mtu is not None: if mtu < 576: raise ValueError('Invalid MTU: %d' % mtu) req['mtu'] = mtu result = request(args, 'setInterface', req) if 'error' in result: _print_error(result['error']) else: print_iflist(result['result']['entries']) def handle_ctl_listif(args): result = request(args, 'listInterface') if 'error' in result: _print_error(result['error']) else: print_iflist(result['result']['entries']) def handle_ctl_listfdb(args): result = request(args, 'listFdb') if 'error' in result: return _print_error(result['error']) result = result['result']['entries'] pmax = maxlen(result, 'port', 4) vmax = maxlen(result, 'vid', 4) mmax = maxlen(result, 'mac', 3) amax = maxlen(result, 'age', 3) fmt = ' %%%ds %%%ds %%-%ds %%%ds' % (pmax, vmax, mmax, amax) print(fmt % ('Port', 'VLAN', 'MAC', 'Age')) for r in result: print(fmt % (r['port'], r['vid'], r['mac'], r['age'])) locals()['handle_ctl_' + args.control_method](args) def _main(): parser = argparse.ArgumentParser() subcommand = parser.add_subparsers(dest='subcommand') # - sw parser_sw = subcommand.add_parser('sw', help='start virtual switch') parser_sw.add_argument('--debug', action='store_true', default=False, help='run as debug mode') parser_sw.add_argument('--foreground', action='store_true', default=False, help='run as foreground mode') parser_sw.add_argument('--ageout', type=int, default=300, help='FDB ageout time (sec)') parser_sw.add_argument('--path', default='/', help='http(s) path to serve WebSocket') parser_sw.add_argument('--host', default='', help='listen address to serve WebSocket') parser_sw.add_argument('--port', type=int, help='listen port to serve WebSocket') parser_sw.add_argument('--htpasswd', help='path to htpasswd file to auth WebSocket') parser_sw.add_argument('--sslkey', help='path to SSL private key for WebSocket') parser_sw.add_argument('--sslcert', help='path to SSL certificate for WebSocket') parser_sw.add_argument('--ctlpath', default='/ctl', help='http(s) path to serve control API') parser_sw.add_argument('--ctlhost', default='127.0.0.1', help='listen address to serve control API') parser_sw.add_argument('--ctlport', type=int, default=7867, help='listen port to serve control API') parser_sw.add_argument('--ctlhtpasswd', help='path to htpasswd file to auth control API') parser_sw.add_argument('--ctlsslkey', help='path to SSL private key for control API') parser_sw.add_argument('--ctlsslcert', help='path to SSL certificate for control API') # - ctl parser_ctl = subcommand.add_parser('ctl', help='control virtual switch') parser_ctl.add_argument('--ctlurl', default='http://127.0.0.1:7867/ctl', help='URL to control API') parser_ctl.add_argument('--ctluser', help='username to auth control API') parser_ctl.add_argument('--ctlpasswd', help='password to auth control API') control_method = parser_ctl.add_subparsers(dest='control_method') # -- ctl addport parser_ctl_addport = control_method.add_parser('addport', help='create and add port') iftype = parser_ctl_addport.add_subparsers(dest='iftype') # --- ctl addport netdev parser_ctl_addport_netdev = iftype.add_parser(NetdevHandler.IFTYPE, help='netdev') parser_ctl_addport_netdev.add_argument('target', help='device name to add interface') # --- ctl addport tap parser_ctl_addport_tap = iftype.add_parser(TapHandler.IFTYPE, help='TAP device') parser_ctl_addport_tap.add_argument('target', help='device name to create interface') # --- ctl addport client parser_ctl_addport_client = iftype.add_parser(EtherWebSocketClient.IFTYPE, help='WebSocket client') parser_ctl_addport_client.add_argument('target', help='URL to connect WebSocket') parser_ctl_addport_client.add_argument('--user', help='username to auth WebSocket') parser_ctl_addport_client.add_argument('--passwd', help='password to auth WebSocket') parser_ctl_addport_client.add_argument('--cacerts', help='path to CA certificate') parser_ctl_addport_client.add_argument( '--insecure', action='store_true', default=False, help='do not verify server certificate') # -- ctl setport parser_ctl_setport = control_method.add_parser('setport', help='set port config') parser_ctl_setport.add_argument('port', type=int, help='port number to set config') parser_ctl_setport.add_argument('--shut', type=int, choices=(0, 1), help='set shutdown state') # -- ctl delport parser_ctl_delport = control_method.add_parser('delport', help='delete port') parser_ctl_delport.add_argument('port', type=int, help='port number to delete') # -- ctl listport parser_ctl_listport = control_method.add_parser('listport', help='show port list') # -- ctl setif parser_ctl_setif = control_method.add_parser('setif', help='set interface config') parser_ctl_setif.add_argument('port', type=int, help='port number to set config') parser_ctl_setif.add_argument('--address', help='IPv4 address to set interface') parser_ctl_setif.add_argument('--netmask', help='IPv4 netmask to set interface') parser_ctl_setif.add_argument('--mtu', type=int, help='MTU to set interface') # -- ctl listif parser_ctl_listif = control_method.add_parser('listif', help='show interface list') # -- ctl listfdb parser_ctl_listfdb = control_method.add_parser('listfdb', help='show FDB entries') # -- go args = parser.parse_args() try: globals()['_start_' + args.subcommand](args) except Exception as e: _print_error({ 'code': 0 - 32603, 'message': 'Internal error', 'data': '%s: %s' % (e.__class__.__name__, str(e)), }) if __name__ == '__main__': _main()