This is merely a historical archive of years 2008-2021, before the migration to mailman3.
A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.
Pau Espin Pedrol gerrit-no-reply at lists.osmocom.orgPau Espin Pedrol has uploaded this change for review. ( https://gerrit.osmocom.org/9963 Change subject: Introduce script ctrl2cgi.py ...................................................................... Introduce script ctrl2cgi.py This scripts implements a similar proxy to the one already available in soapy.py, but aiming at converting CTRl into a regular HTTP POST Request to be handled by a CGI script in the HTTP server. Furthermore, it includes several improvements over the soapy.py script, such as using a token to authenticate users and capability to read some parameters from a cfg file. Change-Id: I7a83ecb379835e295c8cb4c27c39883783746544 --- M README A scripts/ctrl2cgi.py M setup.py 3 files changed, 249 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/python/osmo-python-tests refs/changes/63/9963/1 diff --git a/README b/README index 2c04047..37cd847 100644 --- a/README +++ b/README @@ -9,6 +9,7 @@ There are currently following scripts in this package: osmotestconfig.py - test that apps start/write with example configs soap.py - implementation of SOAP <-> Ctrl proxy implemented on top of Twisted +ctrl2cgi.py - implementation of CGI <-> Ctrl proxy implemented on top of Twisted osmo_rate_ctr2csv.py - rate counter dumper on top of osmo_ipa osmo_interact_vty.py - pipe stdin/stdout to a VTY session osmo_interact_ctrl.py - pipe stdin/stdout to a CTRL port diff --git a/scripts/ctrl2cgi.py b/scripts/ctrl2cgi.py new file mode 100755 index 0000000..20293af --- /dev/null +++ b/scripts/ctrl2cgi.py @@ -0,0 +1,247 @@ +#!/usr/bin/python3 +# -*- mode: python-mode; py-indent-tabs-mode: nil -*- +""" +/* + * Copyright (C) 2016 sysmocom s.f.m.c. GmbH + * + * All Rights Reserved + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ +""" + +__version__ = "0.0.1" # bump this on every non-trivial change + +from twisted.internet import defer, reactor +from osmopy.twisted_ipa import CTRL, IPAFactory, __version__ as twisted_ipa_version +from osmopy.osmo_ipa import Ctrl +from treq import post, collect +from functools import partial +from distutils.version import StrictVersion as V # FIXME: use NormalizedVersion from PEP-386 when available +import argparse, datetime, signal, sys, os, logging, logging.handlers +import hashlib +import json +import configparser + +# we don't support older versions of TwistedIPA module +assert V(twisted_ipa_version) > V('0.4') + +# keys from OpenBSC openbsc/src/libbsc/bsc_rf_ctrl.c, values CGI-specific +oper = { 'inoperational' : 0, 'operational' : 1 } +admin = { 'locked' : 0, 'unlocked' : 1 } +policy = { 'off' : 0, 'on' : 1, 'grace' : 2, 'unknown' : 3 } + +# keys from OpenBSC openbsc/src/libbsc/bsc_vty.c +fix = { 'invalid' : 0, 'fix2d' : 1, 'fix3d' : 1 } # CGI server treats it as boolean but expects int + +def patch_cgi_resp(r): + str = r.decode('utf-8') + lines = str.splitlines() + i = 0 + #search for empty line, marks start of body + for l in lines: + i += 1 + if l == '': + break + print('i="%r"' % i) + json_lines = lines[i:] + json_str = '\n'.join(json_lines) + return json.loads(json_str) + + at defer.inlineCallbacks +def handle_reply(f, log, resp): + """ + Reply handler: process raw CGI server response, function f to run for each command + """ + #log.debug('HANDLE_REPLY: code=%r' % (resp.code)) + #for key,val in resp.headers.getAllRawHeaders(): + # log.debug('HANDLE_REPLY: key=%r val=%r' % (key, val)) + if resp.code != 200: + resp_body = yield resp.text() + log.critical('Received HTTP response %d: %s' % (resp.code, resp_body)) + return + + parsed = yield resp.json() + #log.debug("RESPONSE: %r" % (parsed)) + bsc_id = parsed.get('commands')[0].split()[0].split('.')[3] # we expect 1st command to have net.0.bsc.666.bts.2.trx.1 location prefix format + log.info("Received CGI response for BSC %s with %d commands, error status: %s" % (bsc_id, len(parsed.get('commands')), parsed.get('error'))) + log.debug("BSC %s commands: %r" % (bsc_id, parsed.get('commands'))) + for t in parsed.get('commands'): # Process commands format + (_, m) = Ctrl().cmd(*t.split()) + f(m) + +def gen_hash(params, skey): + input = '' + for key in ['time_stamp','position_validity','admin_status','policy_status']: + input += str(params.get(key)) + input += skey + for key in ['bsc_id','lat','lon','position_validity']: + input += str(params.get(key)) + m = hashlib.md5() + m.update(input.encode('utf-8')) + res = m.hexdigest() + #print('HASH: \nparams="%r"\ninput="%s" \nres="%s"' %(params, input, res)) + return res + +class Trap(CTRL): + """ + TRAP handler (agnostic to factory's client object) + """ + def ctrl_TRAP(self, data, op_id, v): + """ + Parse CTRL TRAP and dispatch to appropriate handler after normalization + """ + (l, r) = v.split() + loc = l.split('.') + t_type = loc[-1] + p = partial(lambda a, i: a[i] if len(a) > i else None, loc) # parse helper + method = getattr(self, 'handle_' + t_type.replace('-', ''), lambda: "Unhandled %s trap" % t_type) + method(p(1), p(3), p(5), p(7), r) # we expect net.0.bsc.666.bts.2.trx.1 format for trap prefix + + def ctrl_SET_REPLY(self, data, _, v): + """ + Debug log for replies to our commands + """ + self.factory.log.debug('SET REPLY %s' % v) + + def ctrl_ERROR(self, data, op_id, v): + """ + We want to know if smth went wrong + """ + self.factory.log.debug('CTRL ERROR [%s] %s' % (op_id, v)) + + def connectionMade(self): + """ + Logging wrapper, calling super() is necessary not to break reconnection logic + """ + self.factory.log.info("Connected to CTRL@%s:%d" % (self.factory.host, self.factory.port)) + super(CTRL, self).connectionMade() + + @defer.inlineCallbacks + def handle_locationstate(self, net, bsc, bts, trx, data): + """ + Handle location-state TRAP: parse trap content, build CGI Request and use treq's routines to post it while setting up async handlers + """ + (ts, fx, lat, lon, height, opr, adm, pol, mcc, mnc) = data.split(',') + tstamp = datetime.datetime.fromtimestamp(float(ts)).isoformat() + self.factory.log.debug('location-state@%s.%s.%s.%s (%s) [%s/%s] => %s' % (net, bsc, bts, trx, tstamp, mcc, mnc, data)) + params = {'bsc_id': bsc, 'lon': lon, 'lat': lat, 'position_validity': fix.get(fx, 0), 'time_stamp': tstamp, 'oper_status': oper.get(opr, 2), 'admin_status': admin.get(adm, 2), 'policy_status': policy.get(pol, 3) } + params['h'] = gen_hash(params, self.factory.secret_key) + d = post(self.factory.location, None, params=params) + d.addCallback(partial(handle_reply, self.transport.write, self.factory.log)) # treq's collect helper is handy to get all reply content at once using closure on ctx + d.addErrback(lambda e, bsc: self.factory.log.critical("HTTP POST error %s while trying to register BSC %s" % (e, bsc)), bsc) # handle HTTP errors + # Ensure that we run only limited number of requests in parallel: + yield self.factory.semaphore.acquire() + yield d # we end up here only if semaphore is available which means it's ok to fire the request without exceeding the limit + self.factory.semaphore.release() + + def handle_notificationrejectionv1(self, net, bsc, bts, trx, data): + """ + Handle notification-rejection-v1 TRAP: just an example to show how more message types can be handled + """ + self.factory.log.debug('notification-rejection-v1 at bsc-id %s => %s' % (bsc, data)) + + +class TrapFactory(IPAFactory): + """ + Store CGI information so TRAP handler can use it for requests + """ + location = None + log = None + semaphore = None + client = None + host = None + port = None + secret_key = None + def __init__(self, host, port, proto, semaphore, log, location, secret_key): + self.host = host # for logging only, + self.port = port # seems to be no way to get it from ReconnectingClientFactory + self.log = log + self.semaphore = semaphore + self.location = location + self.secret_key = secret_key + level = self.log.getEffectiveLevel() + self.log.setLevel(logging.WARNING) # we do not need excessive debug from lower levels + super(TrapFactory, self).__init__(proto, self.log) + self.log.setLevel(level) + self.log.debug("Using IPA %s, CGI server: %s" % (Ctrl.version, self.location)) + + +def reloader(path, script, log, dbg1, dbg2, signum, _): + """ + Signal handler: we have to use execl() because twisted's reactor is not restartable due to some bug in twisted implementation + """ + log.info("Received Signal %d - restarting..." % signum) + if signum == signal.SIGUSR1 and dbg1 not in sys.argv and dbg2 not in sys.argv: + sys.argv.append(dbg1) # enforce debug + if signum == signal.SIGUSR2 and (dbg1 in sys.argv or dbg2 in sys.argv): # disable debug + if dbg1 in sys.argv: + sys.argv.remove(dbg1) + if dbg2 in sys.argv: + sys.argv.remove(dbg2) + os.execl(path, script, *sys.argv[1:]) + + +if __name__ == '__main__': + p = argparse.ArgumentParser(description='Proxy between given GCI service and Osmocom CTRL protocol.') + p.add_argument('-v', '--version', action='version', version=("%(prog)s v" + __version__)) + p.add_argument('-a', '--addr-ctrl', default='localhost', help="Adress to use for CTRL interface, defaults to localhost") + p.add_argument('-p', '--port-ctrl', type=int, default=4250, help="Port to use for CTRL interface, defaults to 4250") + p.add_argument('-n', '--num-max-conn', type=int, default=5, help="Max number of concurrent HTTP requests to CGI server") + p.add_argument('-d', '--debug', action='store_true', help="Enable debug log") + p.add_argument('-o', '--output', action='store_true', help="Log to STDOUT in addition to SYSLOG") + p.add_argument('-l', '--location', help="Location URL of the CGI server") + p.add_argument('-s', '--secret-key', help="Secret key used to generate verification token") + p.add_argument('-c', '--config-file', help="Path Config file. Cmd line args override values in config file") + args = p.parse_args() + + log = logging.getLogger('CTRL2CGI') + if args.debug: + log.setLevel(logging.DEBUG) + else: + log.setLevel(logging.INFO) + log.addHandler(logging.handlers.SysLogHandler('/dev/log')) + if args.output: + log.addHandler(logging.StreamHandler(sys.stdout)) + + reboot = partial(reloader, os.path.abspath(__file__), os.path.basename(__file__), log, '-d', '--debug') # keep in sync with add_argument() call above + signal.signal(signal.SIGHUP, reboot) + signal.signal(signal.SIGQUIT, reboot) + signal.signal(signal.SIGUSR1, reboot) # restart and enabled debug output + signal.signal(signal.SIGUSR2, reboot) # restart and disable debug output + + location_cfgfile = None + secret_key_cfgfile = None + port_ctrl_cfgfile = None + addr_ctrl_cfgfile = None + num_max_conn_cfgfile = None + if args.config_file: + config = configparser.ConfigParser() + config.read(args.config_file) + if 'main' in config: + location_cfgfile = config['main'].get('location', None) + secret_key_cfgfile = config['main'].get('secret_key', None) + addr_ctrl_cfgfile = config['main'].get('addr_ctrl', None) + port_ctrl_cfgfile = config['main'].get('port_ctrl', None) + num_max_conn_cfgfile = config['main'].get('num_max_conn', None) + location = args.location if args.location is not None else location_cfgfile + secret_key = args.secret_key if args.secret_key is not None else secret_key_cfgfile + addr_ctrl = args.addr_ctrl if args.addr_ctrl is not None else addr_ctrl_cfgfile + port_ctrl = args.port_ctrl if args.port_ctrl is not None else port_ctrl_cfgfile + num_max_conn = args.num_max_conn if args.num_max_conn is not None else num_max_conn_cfgfile + + log.info("CGI proxy %s starting with PID %d ..." % (__version__, os.getpid())) + reactor.connectTCP(addr_ctrl, port_ctrl, TrapFactory(addr_ctrl, port_ctrl, Trap, defer.DeferredSemaphore(num_max_conn), log, location, secret_key)) + reactor.run() diff --git a/setup.py b/setup.py index 1d785e7..061e5df 100755 --- a/setup.py +++ b/setup.py @@ -30,6 +30,7 @@ "scripts/osmo_ctrl.py", "scripts/osmo_rate_ctr2csv.py", "scripts/soap.py", + "scripts/ctrl2cgi.py", "scripts/osmo_interact_vty.py", "scripts/osmo_interact_ctrl.py", "scripts/osmo_verify_transcript_vty.py", -- To view, visit https://gerrit.osmocom.org/9963 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: python/osmo-python-tests Gerrit-Branch: master Gerrit-MessageType: newchange Gerrit-Change-Id: I7a83ecb379835e295c8cb4c27c39883783746544 Gerrit-Change-Number: 9963 Gerrit-PatchSet: 1 Gerrit-Owner: Pau Espin Pedrol <pespin at sysmocom.de> -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20180711/852e5b3e/attachment.htm>