chiark / gitweb /
AGPLv3+CAFv2
[hippotat] / hippotatd
1 #!/usr/bin/python3
2
3 from hippotatlib import *
4
5 import os
6 import tempfile
7 import atexit
8 import shutil
9
10 import twisted.internet
11 from twisted.web.server import NOT_DONE_YET
12
13 import twisted.web.static
14
15 import hippotatlib.ownsource
16 from hippotatlib.ownsource import SourceShipmentPreparer
17
18 #import twisted.web.server import Site
19 #from twisted.web.resource import Resource
20
21 import syslog
22
23 cleanups = [ ]
24
25 clients = { }
26
27 #---------- "router" ----------
28
29 def route(packet, iface, saddr, daddr):
30   def lt(dest):
31     log_debug(DBG.ROUTE, 'route: %s -> %s: %s' % (saddr,daddr,dest), d=packet)
32   try: dclient = clients[daddr]
33   except KeyError: dclient = None
34   if dclient is not None:
35     lt('client')
36     dclient.queue_outbound(packet)
37   elif daddr == c.vaddr or daddr not in c.vnetwork:
38     lt('inbound')
39     queue_inbound(ipif, packet)
40   elif daddr == c.relay:
41     lt('discard relay')
42     log_discard(packet, iface, saddr, daddr, 'relay')
43   else:
44     lt('discard no-client')
45     log_discard(packet, iface, saddr, daddr, 'no-client')
46
47 #---------- client ----------
48
49 class Client():
50   def __init__(self, ip, cc):
51     # instance data members
52     self._ip = ip
53     self.cc = cc
54     self._rq = collections.deque() # requests
55     self._pq = PacketQueue(str(ip), self.cc.max_queue_time)
56
57     if ip not in c.vnetwork:
58       raise ValueError('client %s not in vnetwork' % ip)
59
60     if ip in clients:
61       raise ValueError('multiple client cfg sections for %s' % ip)
62     clients[ip] = self
63
64     self._log(DBG.INIT, 'new')
65
66   def _log(self, dflag, msg, **kwargs):
67     log_debug(dflag, ('client %s: ' % self._ip)+msg, **kwargs)
68
69   def process_arriving_data(self, d):
70     self._log(DBG.FLOW, "req data (enc'd)", d=d)
71     if not len(d): return
72     for packet in slip.decode(d):
73       (saddr, daddr) = packet_addrs(packet)
74       if saddr != self._ip:
75         raise ValueError('wrong source address %s' % saddr)
76       route(packet, self._ip, saddr, daddr)
77
78   def _req_cancel(self, request):
79     self._log(DBG.HTTP_CTRL, 'cancel', idof=request)
80     request.finish()
81
82   def _req_error(self, err, request):
83     self._log(DBG.HTTP_CTRL, 'error %s' % err, idof=request)
84     self._req_cancel(request)
85
86   def queue_outbound(self, packet):
87     self._pq.append(packet)
88     self._check_outbound()
89
90   def _req_fin(self, dummy, request, cl):
91     self._log(DBG.HTTP_CTRL, '_req_fin ' + repr(dummy), idof=request)
92     try: cl.cancel()
93     except twisted.internet.error.AlreadyCalled: pass
94
95   def new_request(self, request):
96     request.setHeader('Content-Type','application/octet-stream')
97     cl = reactor.callLater(self.cc.http_timeout, self._req_cancel, request)
98     nf = request.notifyFinish()
99     nf.addErrback(self._req_error, request)
100     nf.addCallback(self._req_fin, request, cl)
101     self._rq.append(request)
102     self._check_outbound()
103
104   def _req_write(self, req, d):
105     self._log(DBG.HTTP, 'req_write ', idof=req, d=d)
106     req.write(d)
107
108   def _check_outbound(self):
109     log_debug(DBG.HTTP_CTRL, 'CHKO')
110     while True:
111       try: request = self._rq[0]
112       except IndexError: request = None
113       if request and request.finished:
114         self._log(DBG.HTTP_CTRL, 'CHKO req finished, discard', idof=request)
115         self._rq.popleft()
116         continue
117
118       if not self._pq.nonempty():
119         # no packets, oh well
120         self._log(DBG.HTTP_CTRL, 'CHKO no packets, OUT-DONE', idof=request)
121         break
122
123       if request is None:
124         # no request
125         self._log(DBG.HTTP_CTRL, 'CHKO no request, OUT-DONE', idof=request)
126         break
127
128       self._log(DBG.HTTP_CTRL, 'CHKO processing', idof=request)
129       # request, and also some non-expired packets
130       self._pq.process((lambda: request.sentLength),
131                        (lambda d: self._req_write(request, d)),
132                        self.cc.max_batch_down)
133
134       assert(request.sentLength)
135       self._rq.popleft()
136       request.finish()
137       self._log(DBG.HTTP, 'complete', idof=request)
138       # round again, looking for more to do
139
140     while len(self._rq) > self.cc.target_requests_outstanding:
141       request = self._rq.popleft()
142       self._log(DBG.HTTP, 'CHKO above target, returning empty', idof=request)
143       request.finish()
144
145 def process_request(request, desca):
146   # find client, update config, etc.
147   metadata = request.args[b'm'][0]
148   metadata = metadata.split(b'\r\n')
149   (ci_s, pw, tro, cto) = metadata[0:4]
150   desca['m[0,2:3]'] = [ci_s, tro, cto]
151   ci_s = ci_s.decode('utf-8')
152   tro = int(tro); desca['tro']= tro
153   cto = int(cto); desca['cto']= cto
154   ci = ipaddr(ci_s)
155   desca['ci'] = ci
156   cl = clients[ci]
157   if pw != cl.cc.password: raise ValueError('bad password')
158   desca['pwok']=True
159
160   if tro != cl.cc.target_requests_outstanding:
161     raise ValueError('tro must be %d' % cl.cc.target_requests_outstanding)
162
163   if cto < cl.cc.http_timeout:
164     raise ValueError('cto must be >= %d' % cl.cc.http_timeout)
165
166   try:
167     d = request.args[b'd'][0]
168     desca['d'] = d
169     desca['dlen'] = len(d)
170   except KeyError:
171     d = b''
172     desca['dlen'] = None
173
174   log_http(desca, 'processing', idof=id(request), d=d)
175
176   d = mime_translate(d)
177
178   cl.process_arriving_data(d)
179   cl.new_request(request)
180
181 def log_http(desca, msg, **kwargs):
182   try:
183     kwargs['d'] = desca['d']
184     del desca['d']
185   except KeyError:
186     pass
187   log_debug(DBG.HTTP, msg + repr(desca), **kwargs)
188
189 class NotStupidResource(twisted.web.resource.Resource):
190   # why this is not the default is a mystery!
191   def getChild(self, name, request):
192     if name == b'': return self
193     else: return twisted.web.resource.Resource.getChild(name, request)
194
195 class IphttpResource(NotStupidResource):
196   def render_POST(self, request):
197     log_debug(DBG.HTTP_FULL,
198               'req recv: ' + repr(request) + ' ' + repr(request.args),
199               idof=id(request))
200     desca = {'d': None}
201     try: process_request(request, desca)
202     except Exception as e:
203       emsg = traceback.format_exc()
204       log_http(desca, 'RETURNING EXCEPTION ' + emsg)
205       request.setHeader('Content-Type','text/plain; charset="utf-8"')
206       request.setResponseCode(400)
207       return (emsg + ' # ' + repr(desca) + '\r\n').encode('utf-8')
208     log_debug(DBG.HTTP_CTRL, '...', idof=id(request))
209     return NOT_DONE_YET
210
211   def render_GET(self, request):
212     log_debug(DBG.HTTP, 'GET request')
213     return b'''
214 <html><body>
215 hippotat
216 <p>
217 <a href="source">source</a> available
218 </body></html>
219 '''
220
221 class SourceResource(twisted.web.static.File):
222   def __init__(self):
223     td = tempfile.mkdtemp()
224
225     def cleanup():
226       try: shutil.rmtree(td)
227       except FileNotFoundError: pass
228
229     cleanups.append(cleanup)
230
231     self._ssp = SourceShipmentPreparer(td)
232     self._ssp.logger = self.log
233     self._ssp.generate()
234
235     super().__init__(self._ssp.output_path)
236
237   def log(self, m):
238     log_debug(DBG.OWNSOURCE, m)
239
240 def start_http():
241   resource = IphttpResource()
242   resource.putChild(b'source',SourceResource())
243   site = twisted.web.server.Site(resource)
244   for sa in c.saddrs:
245     ep = sa.make_endpoint()
246     crash_on_defer(ep.listen(site))
247     log_debug(DBG.INIT, 'listening on %s' % sa)
248
249 #---------- config and setup ----------
250
251 def process_cfg(putative_servers, putative_clients):
252   global c
253   c = ConfigResults()
254   c.server = cfg.get('SERVER','server')
255
256   cfg_process_common(c, c.server)
257   cfg_process_saddrs(c, c.server)
258   cfg_process_vnetwork(c, c.server)
259   cfg_process_vaddr(c, c.server)
260
261   for (ci,cs) in putative_clients.items():
262     cc = ConfigResults()
263     sections = cfg_process_client_common(cc,c.server,cs,ci)
264     if not sections: continue
265     cfg_process_client_limited(cc,c.server,sections, 'max_batch_down')
266     cfg_process_client_limited(cc,c.server,sections, 'max_queue_time')
267     Client(ci, cc)
268
269   try:
270     c.vrelay = cfg.get(c.server, 'vrelay')
271   except NoOptionError:
272     for search in c.vnetwork.hosts():
273       if search == c.vaddr: continue
274       c.vrelay = search
275       break
276
277   cfg_process_ipif(c,
278                    [c.server, 'DEFAULT'],
279                    (('local','vaddr'),
280                     ('peer', 'vrelay'),
281                     ('rnets','vnetwork')))
282
283 def catch_termination():
284   def run_cleanups():
285     for cleanup in cleanups:
286       cleanup()
287
288   atexit.register(run_cleanups)
289
290   def signal_handler(name, sig, *args):
291     signal.signal(sig, signal.SIG_DFL)
292     print('exiting due to %s' % name, file=sys.stderr)
293     run_cleanups()
294     os.kill(os.getpid(), sig)
295     raise RuntimeError('did not die due to signal %s !' % name)
296
297   for sig in (signal.SIGINT, signal.SIGTERM):
298     signal.signal(sig, partial(signal_handler, sig.name))
299
300 common_startup(process_cfg)
301 catch_termination()
302 ipif = start_ipif(c.ipif_command, (lambda p,s,d: route(p,"[ipif]",s,d)))
303 start_http()
304 common_run()