import signal
signal.signal(signal.SIGINT, signal.SIG_DFL)
+import sys
+
import twisted
from twisted.internet import reactor
from twisted.logger import LogLevel
+import twisted.internet.endpoints
import ipaddress
from ipaddress import AddressValueError
-import hippotat.slip as slip
-
from optparse import OptionParser
from configparser import ConfigParser
from configparser import NoOptionError
import collections
+import time
+
+import re as regexp
+
+from twisted.python.constants import NamedConstant
+
+import hippotat.slip as slip
+
+class DBG(twisted.python.constants.Names):
+ ROUTE = NamedConstant()
+ FLOW = NamedConstant()
+ HTTP = NamedConstant()
+ HTTP_CTRL = NamedConstant()
+ INIT = NamedConstant()
+ QUEUE = NamedConstant()
+ QUEUE_CTRL = NamedConstant()
+
+defcfg = '''
+[DEFAULT]
+#[<client>] overrides
+max_batch_down = 65536 # used by server, subject to [limits]
+max_queue_time = 10 # used by server, subject to [limits]
+max_request_time = 54 # used by server, subject to [limits]
+target_requests_outstanding = 3 # must match; subject to [limits] on server
+max_requests_outstanding = 4 # used by client
+max_batch_up = 4000 # used by client
+http_timeout = 30 # used by client
+http_retry = 5 # used by client
+
+#[server] or [<client>] overrides
+ipif = userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s
+# extra interpolations: %(local)s %(peer)s %(rnet)s
+# obtained on server [virtual]server [virtual]relay [virtual]network
+# from on client <client> [virtual]server [virtual]routes
+
+[virtual]
+mtu = 1500
+routes = ''
+# network = <prefix>/<len> # mandatory for server
+# server = <ipaddr> # used by both, default is computed from `network'
+# relay = <ipaddr> # used by server, default from `network' and `server'
+# default server is first host in network
+# default relay is first host which is not server
+
+[server]
+# addrs = 127.0.0.1 ::1 # mandatory for server
+port = 80 # used by server
+# url # used by client; default from first `addrs' and `port'
+
+# [<client-ip4-or-ipv6-address>]
+# password = <password> # used by both, must match
+
+[limits]
+max_batch_down = 262144 # used by server
+max_queue_time = 121 # used by server
+max_request_time = 121 # used by server
+target_requests_outstanding = 10 # used by server
+'''
# these need to be defined here so that they can be imported by import *
cfg = ConfigParser()
optparser = OptionParser()
+_mimetrans = bytes.maketrans(b'-'+slip.esc, slip.esc+b'-')
+def mime_translate(s):
+ # SLIP-encoded packets cannot contain ESC ESC.
+ # Swap `-' and ESC. The result cannot contain `--'
+ return s.translate(_mimetrans)
+
class ConfigResults:
def __init__(self, d = { }):
self.__dict__ = d
c = ConfigResults()
+def log_discard(packet, saddr, daddr, why):
+ print('DROP ', saddr, daddr, why)
+# syslog.syslog(syslog.LOG_DEBUG,
+# 'discarded packet %s -> %s (%s)' % (saddr, daddr, why))
+
#---------- packet parsing ----------
def packet_addrs(packet):
#---------- ipif (SLIP) subprocess ----------
-class _IpifProcessProtocol(twisted.internet.protocol.ProcessProtocol):
- def __init__(self, router):
+class SlipStreamDecoder():
+ def __init__(self, on_packet):
+ # we will call packet(<packet>)
self._buffer = b''
- self._router = router
- def connectionMade(self): pass
- def outReceived(self, data):
- #print('RECV ', repr(data))
+ self._on_packet = on_packet
+
+ def inputdata(self, data):
+ #print('SLIP-GOT ', repr(data))
self._buffer += data
packets = slip.decode(self._buffer)
self._buffer = packets.pop()
for packet in packets:
- if not len(packet): continue
- (saddr, daddr) = packet_addrs(packet)
- self._router(packet, saddr, daddr)
+ self._maybe_packet(packet)
+
+ def _maybe_packet(self, packet):
+ if len(packet):
+ self._on_packet(packet)
+
+ def flush(self):
+ self._maybe_packet(self._buffer)
+ self._buffer = b''
+
+class _IpifProcessProtocol(twisted.internet.protocol.ProcessProtocol):
+ def __init__(self, router):
+ self._router = router
+ self._decoder = SlipStreamDecoder(self.slip_on_packet)
+ def connectionMade(self): pass
+ def outReceived(self, data):
+ self._decoder.inputdata(data)
+ def slip_on_packet(self, packet):
+ (saddr, daddr) = packet_addrs(packet)
+ if saddr.is_link_local or daddr.is_link_local:
+ log_discard(packet, saddr, daddr, 'link-local')
+ return
+ self._router(packet, saddr, daddr)
def processEnded(self, status):
status.raiseException()
ipif = _IpifProcessProtocol(router)
reactor.spawnProcess(ipif,
'/bin/sh',['sh','-xc', command],
- childFDs={0:'w', 1:'r', 2:2})
+ childFDs={0:'w', 1:'r', 2:2},
+ env=None)
def queue_inbound(packet):
ipif.transport.write(slip.delimiter)
#---------- packet queue ----------
class PacketQueue():
- def __init__(self, max_queue_time):
+ def __init__(self, desc, max_queue_time):
+ self._desc = desc
self._max_queue_time = max_queue_time
self._pq = collections.deque() # packets
+ def _log_debug(self, fn, pri, msg)
+ log_debug(pri,
+
def append(self, packet):
+ log_data(DBG.QUEUE, packet, 'pq %s: append' % self._desc)
self._pq.append((time.monotonic(), packet))
def nonempty(self):
+ log_debug(DBG.QUEUE, 'pq %s: nonempty ?' % self._desc)
while True:
try: (queuetime, packet) = self._pq[0]
except IndexError: return False
age = time.monotonic() - queuetime
- if age > self.max_queue_time:
+ if age > self._max_queue_time:
# strip old packets off the front
self._pq.popleft()
continue
return True
- def popleft(self):
- # caller must have checked nonempty
- try: (dummy, packet) = self._pq[0]
- except IndexError: return None
- return packet
+ def process(self, sizequery, moredata, max_batch):
+ # sizequery() should return size of batch so far
+ # moredata(s) should add s to batch
+ while True:
+ try: (dummy, packet) = self._pq[0]
+ except IndexError: break
+
+ encoded = slip.encode(packet)
+ sofar = sizequery()
+
+ if sofar > 0:
+ if sofar + len(slip.delimiter) + len(encoded) > max_batch:
+ break
+ moredata(slip.delimiter)
+
+ moredata(encoded)
+ self._pq.popleft()
#---------- error handling ----------
def process_cfg_ipif(section, varmap):
for d, s in varmap:
try: v = getattr(c, s)
- except KeyError: pass
+ except AttributeError: continue
setattr(c, d, v)
print(repr(c))
try:
self.addr = ipaddress.IPv4Address(addrspec)
self._endpointfactory = twisted.internet.endpoints.TCP4ServerEndpoint
- self._inurl = '%s'
+ self._inurl = b'%s'
except AddressValueError:
self.addr = ipaddress.IPv6Address(addrspec)
self._endpointfactory = twisted.internet.endpoints.TCP6ServerEndpoint
- self._inurl = '[%s]'
+ self._inurl = b'[%s]'
def make_endpoint(self):
return self._endpointfactory(reactor, self.port, self.addr)
def url(self):
- url = 'http://' + (self._inurl % self.addr)
- if self.port != 80: url += ':%d' % self.port
- url += '/'
+ url = b'http://' + (self._inurl % str(self.addr).encode('ascii'))
+ if self.port != 80: url += b':%d' % self.port
+ url += b'/'
return url
def process_cfg_saddrs():
- port = cfg.getint('server','port')
+ try: port = cfg.getint('server','port')
+ except NoOptionError: port = 80
c.saddrs = [ ]
for addrspec in cfg.get('server','addrs').split():
if not (':' in cs or '.' in cs): continue
ci = ipaddr(cs)
pw = cfg.get(cs, 'password')
+ pw = pw.encode('utf-8')
constructor(ci,cs,pw)
#---------- startup ----------
-def common_startup(defcfg):
+def common_startup():
twisted.logger.globalLogPublisher.addObserver(crash_on_critical)
optparser.add_option('-c', '--config', dest='configfile',
(opts, args) = optparser.parse_args()
if len(args): optparser.error('no non-option arguments please')
- cfg.read_string(defcfg)
+ re = regexp.compile('#.*')
+ cfg.read_string(re.sub('', defcfg))
cfg.read(opts.configfile)
def common_run():
~ian / hippotat.git / blobdiff