3 # Hippotat - Asinine IP Over HTTP program
4 # ./hippotatd - server main program
6 # Copyright 2017 Ian Jackson
10 # This program is free software: you can redistribute it and/or
11 # modify it under the terms of the GNU Affero General Public
12 # License as published by the Free Software Foundation, either
13 # version 3 of the License, or (at your option) any later version,
14 # with the "CAF Login Exception" as published by Ian Jackson
15 # (version 2, or at your option any later version) as an Additional
18 # This program is distributed in the hope that it will be useful,
19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # Affero General Public License for more details.
23 # You should have received a copy of the GNU Affero General Public
24 # License and the CAF Login Exception along with this program, in
25 # the file AGPLv3+CAFv2. If not, email Ian Jackson
26 # <ijackson@chiark.greenend.org.uk>.
28 #@ import sys; sys.path.append('@PYBUILD_INSTALL_DIR@')
29 from hippotatlib import *
37 import twisted.internet
38 from twisted.web.server import NOT_DONE_YET
40 import twisted.web.static
42 import hippotatlib.ownsource
43 from hippotatlib.ownsource import SourceShipmentPreparer
45 #import twisted.web.server import Site
46 #from twisted.web.resource import Resource
54 #---------- "router" ----------
56 def route(packet, iface, saddr, daddr):
58 log_debug(DBG.ROUTE, 'route: %s -> %s: %s' % (saddr,daddr,dest), d=packet)
59 try: dclient = clients[daddr]
60 except KeyError: dclient = None
61 if dclient is not None:
63 dclient.queue_outbound(packet)
64 elif daddr == c.vaddr or daddr not in c.vnetwork:
66 queue_inbound(ipif, packet)
67 elif daddr == c.vrelay:
69 log_discard(packet, iface, saddr, daddr, 'relay')
71 lt('discard no-client')
72 log_discard(packet, iface, saddr, daddr, 'no-client')
74 #---------- client ----------
77 def __init__(self, ip, cc):
78 # instance data members
81 self._rq = collections.deque() # requests
82 self._pq = PacketQueue(str(ip), self.cc.max_queue_time)
84 if ip not in c.vnetwork:
85 raise ValueError('client %s not in vnetwork' % ip)
88 raise ValueError('multiple client cfg sections for %s' % ip)
91 self._log(DBG.INIT, 'new')
93 def _log(self, dflag, msg, **kwargs):
94 log_debug(dflag, ('client %s: ' % self._ip)+msg, **kwargs)
96 def process_arriving_data(self, d):
97 self._log(DBG.FLOW, "req data (enc'd)", d=d)
99 for packet in slip.decode(d):
100 (saddr, daddr) = packet_addrs(packet)
101 if saddr != self._ip:
102 raise ValueError('wrong source address %s' % saddr)
103 route(packet, self._ip, saddr, daddr)
105 def _req_cancel(self, request):
106 self._log(DBG.HTTP_CTRL, 'cancel', idof=request)
109 def _req_error(self, err, request):
110 self._log(DBG.HTTP_CTRL, 'error %s' % err, idof=request)
111 self._req_cancel(request)
113 def queue_outbound(self, packet):
114 self._pq.append(packet)
115 self._check_outbound()
117 def _req_fin(self, dummy, request, cl):
118 self._log(DBG.HTTP_CTRL, '_req_fin ' + repr(dummy), idof=request)
120 except twisted.internet.error.AlreadyCalled: pass
122 def new_request(self, request):
123 request.setHeader('Content-Type','application/octet-stream')
124 cl = reactor.callLater(self.cc.http_timeout, self._req_cancel, request)
125 nf = request.notifyFinish()
126 nf.addErrback(self._req_error, request)
127 nf.addCallback(self._req_fin, request, cl)
128 self._rq.append(request)
129 self._check_outbound()
131 def _req_write(self, req, d):
132 self._log(DBG.HTTP, 'req_write ', idof=req, d=d)
135 def _check_outbound(self):
136 log_debug(DBG.HTTP_CTRL, 'CHKO')
138 try: request = self._rq[0]
139 except IndexError: request = None
140 if request and request.finished:
141 self._log(DBG.HTTP_CTRL, 'CHKO req finished, discard', idof=request)
145 if not self._pq.nonempty():
146 # no packets, oh well
147 self._log(DBG.HTTP_CTRL, 'CHKO no packets, OUT-DONE', idof=request)
152 self._log(DBG.HTTP_CTRL, 'CHKO no request, OUT-DONE', idof=request)
155 self._log(DBG.HTTP_CTRL, 'CHKO processing', idof=request)
156 # request, and also some non-expired packets
157 self._pq.process((lambda: request.sentLength),
158 (lambda d: self._req_write(request, d)),
159 self.cc.max_batch_down)
161 assert(request.sentLength)
164 self._log(DBG.HTTP, 'complete', idof=request)
165 # round again, looking for more to do
167 while len(self._rq) > self.cc.target_requests_outstanding:
168 request = self._rq.popleft()
169 self._log(DBG.HTTP, 'CHKO above target, returning empty', idof=request)
172 def process_request(request, desca):
173 # find client, update config, etc.
174 metadata = request.args[b'm'][0]
175 metadata = metadata.split(b'\r\n')
176 (ci_s, pw, tro, cto) = metadata[0:4]
177 desca['m[0,2:3]'] = [ci_s, tro, cto]
178 ci_s = ci_s.decode('utf-8')
179 tro = int(tro); desca['tro']= tro
180 cto = int(cto); desca['cto']= cto
184 if pw != cl.cc.password: raise ValueError('bad password')
187 if tro != cl.cc.target_requests_outstanding:
188 raise ValueError('tro must be %d' % cl.cc.target_requests_outstanding)
190 if cto < cl.cc.http_timeout:
191 raise ValueError('cto must be >= %d' % cl.cc.http_timeout)
194 d = request.args[b'd'][0]
196 desca['dlen'] = len(d)
201 log_http(desca, 'processing', idof=id(request), d=d)
203 d = mime_translate(d)
205 cl.process_arriving_data(d)
206 cl.new_request(request)
208 def log_http(desca, msg, **kwargs):
210 kwargs['d'] = desca['d']
214 log_debug(DBG.HTTP, msg + repr(desca), **kwargs)
216 class NotStupidResource(twisted.web.resource.Resource):
217 # why this is not the default is a mystery!
218 def getChild(self, name, request):
219 if name == b'': return self
220 else: return twisted.web.resource.Resource.getChild(name, request)
222 class IphttpResource(NotStupidResource):
223 def render_POST(self, request):
224 log_debug(DBG.HTTP_FULL,
225 'req recv: ' + repr(request) + ' ' + repr(request.args),
228 try: process_request(request, desca)
229 except Exception as e:
230 emsg = traceback.format_exc()
231 log_http(desca, 'RETURNING EXCEPTION ' + emsg)
232 request.setHeader('Content-Type','text/plain; charset="utf-8"')
233 request.setResponseCode(400)
234 return (emsg + ' # ' + repr(desca) + '\r\n').encode('utf-8')
235 log_debug(DBG.HTTP_CTRL, '...', idof=id(request))
238 # instantiator should set
239 # self.hippotat_sources = (source_names[0], source_names[1])
241 self.hippotat_sources = [None, None]
244 def render_GET(self, request):
245 log_debug(DBG.HTTP, 'GET request')
246 s = '<html><body>hippotat\n'
247 (s0,s1) = self.hippotat_sources
249 s += '<p><a href="%s">source</a>\n' % s0
250 if self.hippotat_sources[1]:
251 s += ('(and that of dependency <a href="%s">packages</a>)\n' % s1)
255 s += '</body></html>'
256 return s.encode('utf-8')
259 resource = IphttpResource()
260 site = twisted.web.server.Site(resource)
263 ep = sa.make_endpoint()
264 crash_on_defer(ep.listen(site))
265 log_debug(DBG.INIT, 'listening on %s' % sa)
267 td = tempfile.mkdtemp()
270 try: shutil.rmtree(td)
271 except FileNotFoundError: pass
273 cleanups.append(cleanup)
275 ssp = SourceShipmentPreparer(td)
276 ssp.logger = partial(log_debug, DBG.OWNSOURCE)
277 if DBG.OWNSOURCE in debug_set: ssp.stream_debug = sys.stdout
278 ssp.download_packages = opts.ownsource >= 2
279 if opts.ownsource >= 1: ssp.generate()
282 bn = ssp.output_names[ix]
283 op = ssp.output_paths[ix]
284 if op is None: continue
285 resource.hippotat_sources[ix] = bn
286 subresource =twisted.web.static.File(op)
287 resource.putChild(bn.encode('utf-8'), subresource)
289 reactor.callLater(0.1, (lambda: log.info('hippotatd started', dflag=False)))
291 #---------- config and setup ----------
293 def process_cfg(_opts, putative_servers, putative_clients):
299 try: c.server = cfg.get('SERVER','server')
300 except NoOptionError: c.server = 'SERVER'
302 cfg_process_common(c, c.server)
303 cfg_process_saddrs(c, c.server)
304 cfg_process_vnetwork(c, c.server)
305 cfg_process_vaddr(c, c.server)
307 for (ci,cs) in putative_clients.items():
309 sections = cfg_process_client_common(cc,c.server,cs,ci)
310 if not sections: continue
311 cfg_process_client_limited(cc,c.server,sections, 'max_batch_down')
312 cfg_process_client_limited(cc,c.server,sections, 'max_queue_time')
316 c.vrelay = cfg.get(c.server, 'vrelay')
317 except NoOptionError:
318 for search in c.vnetwork.hosts():
319 if search == c.vaddr: continue
323 try: c.ifname = cfg.get(c.server, 'ifname_server', raw=True)
324 except NoOptionError: pass
327 [c.server, 'DEFAULT'],
330 ('rnets','vnetwork')))
332 if opts.printconfig is not None:
333 try: val = cfg.get(c.server, opts.printconfig)
334 except NoOptionError: pass
338 def catch_termination():
340 for cleanup in cleanups:
343 atexit.register(run_cleanups)
345 def signal_handler(name, sig, *args):
346 signal.signal(sig, signal.SIG_DFL)
347 print('exiting due to %s' % name, file=sys.stderr)
349 os.kill(os.getpid(), sig)
350 raise RuntimeError('did not die due to signal %s !' % name)
352 for sig in (signal.SIGINT, signal.SIGTERM):
353 try: signame = sig.name
354 except AttributeError: signame = "signal %d" % sig
355 signal.signal(sig, partial(signal_handler, signame))
358 global syslogfacility
359 if opts.daemon and opts.syslogfacility is None:
360 opts.syslogfacility = 'daemon'
362 if opts.syslogfacility is not None:
363 facilnum = syslog.__dict__['LOG_' + opts.syslogfacility.upper()]
364 syslog.openlog('hippotatd',
366 logoption=syslog.LOG_PID)
368 if logevent_is_boringtwisted(event): return
369 m = twisted.logger.formatEvent(event)
370 #print(repr(event), m, file=org_stderr)
371 level = event.get('log_level')
372 if event.get('dflag',None) is not None: sl = syslog.LOG_DEBUG
373 elif level == LogLevel.critical : sl = syslog.LOG_CRIT
374 elif level == LogLevel.error : sl = syslog.LOG_ERR
375 elif level == LogLevel.warn : sl = syslog.LOG_WARNING
376 else : sl = syslog.LOG_INFO
378 failure = event.get('log_failure')
379 if failure is not None:
380 for l in failure.getTraceback().split('\n'):
382 glp = twisted.logger.globalLogPublisher
383 glp.addObserver(emit)
384 log_debug(DBG.INIT, 'starting to log to syslog')
386 #log.crit('daemonic hippotatd crashed', dflag=False)
388 daemonic_reactor = (twisted.internet.interfaces.IReactorDaemonize
389 .providedBy(reactor))
390 if daemonic_reactor: reactor.beforeDaemonize()
391 if opts.pidfile is not None:
392 pidfile_h = open(opts.pidfile, 'w')
403 log.critical('daemonic hippotatd crashed', dflag=False)
407 grandchildpid = os.fork()
409 # we are the intermediate child
410 if opts.pidfile is not None:
411 print(grandchildpid, file=pidfile_h)
415 if opts.pidfile is not None:
418 logger = subprocess.Popen(['logger','-d',
419 '-t','hippotat[%d](stderr)' % os.getpid(),
420 '-p',opts.syslogfacility + '.err'],
421 stdin=subprocess.PIPE,
422 stdout=subprocess.DEVNULL,
423 stderr=subprocess.DEVNULL,
424 restore_signals=True)
426 nullfd = os.open('/dev/null', os.O_RDWR)
429 os.dup2(logger.stdin.fileno(), 2)
431 if daemonic_reactor: reactor.afterDaemonize()
432 log_debug(DBG.INIT, 'daemonised')
436 if opts.syslogfacility is not None:
437 glp.removeObserver(hippotatlib.file_log_observer)
439 optparser.add_option('--ownsource', default=2,
440 action='store_const', dest='ownsource', const=2,
441 help='source download fully enabled (default)')
443 optparser.add_option('--ownsource-local',
444 action='store_const', dest='ownsource', const=1,
445 help='source download is local source code only')
447 optparser.add_option('--no-ownsource',
448 action='store_const', dest='ownsource', const=0,
449 help='source download disabled (for testing only)')
451 optparser.add_option('--daemon',
452 action='store_true', dest='daemon', default=False,
453 help='daemonize (and log to syslog)')
455 optparser.add_option('--pidfile',
456 nargs=1, type='string',
457 action='store', dest='pidfile', default=None,
458 help='write pid to this file')
460 optparser.add_option('--syslog-facility',
461 nargs=1, type='string',action='store',
462 metavar='FACILITY', dest='syslogfacility',
464 help='log to syslog, with specified facility')
466 optparser.add_option('--print-config',
467 nargs=1, type='string',action='store',
468 metavar='OPTION', dest='printconfig',
470 help='print one config option value and exit')
472 common_startup(process_cfg)
476 ipif = start_ipif(c.ipif_command, (lambda p,s,d: route(p,"[ipif]",s,d)))