From e732c2ca3badf9e16cb393efb5c4b2556a43fd0b Mon Sep 17 00:00:00 2001 From: Max Date: Thu, 23 Nov 2017 16:42:59 +0100 Subject: [PATCH] Add *.py from OsmoBSC Those are generic enough and can be used as advanced example of uzing CTRL interface from python on top of osmo_ipa. Change-Id: Ic4e1155d3bd546feaabab34a46e354c69058056e --- README | 8 +- osmopy/__init__.py | 5 +- osmopy/osmo_ctrl.py | 120 +++++++++++++ osmopy/soap.py | 188 +++++++++++++++++++++ osmopy/twisted_ipa.py | 384 ++++++++++++++++++++++++++++++++++++++++++ setup.py | 3 + 6 files changed, 705 insertions(+), 3 deletions(-) create mode 100755 osmopy/osmo_ctrl.py create mode 100755 osmopy/soap.py create mode 100755 osmopy/twisted_ipa.py diff --git a/README b/README index b85f7c9..25be782 100644 --- a/README +++ b/README @@ -2,13 +2,15 @@ Building/installation: sudo python setup.py install If you prefer to have it cleanly removable, install checkinstall and run sudo checkinstall python setup.py install -Alternatively, just run 'pip install --user -e ./' +Alternatively, just run 'pip install --user -e ./' or 'pip3 install --user -e ./' +depending on your python version. Use -There are currently 3 scripts in this package: +There are currently following scripts in this package: osmodumpdoc.py - dump documentation (the VTY's "show online-help"). osmotestconfig.py - test that apps start/write with example configs osmotestvty.py - test vty operations (currently, tests very few) +soap.py - implementation of SOAP <-> Ctrl proxy implemented on top of Twisted Each of these scripts imports a project-specific osmoappdesc.py, which provides information about the available apps, configs, vty ports, etc. @@ -24,5 +26,7 @@ cd /openbsc/openbsc && osmodumpdoc.py Libraries: osmopy/obscvty.py - connect to a vty, run commands on it, see the result osmopy/osmoutil.py - code that's shared between the scripts +osmopy/osmo_ipa.py - generic implementation of IPA and Ctrl protocols in python +twisted_ipa.py - implementation of IPA and Ctrl protocols on top of Twisted framework obscvty.py may be of general use. osmoutil.py probably isn't. diff --git a/osmopy/__init__.py b/osmopy/__init__.py index 1b97e33..b760111 100644 --- a/osmopy/__init__.py +++ b/osmopy/__init__.py @@ -1,9 +1,12 @@ #!/usr/bin/env python -__version__ = '0.0.1' +__version__ = '0.0.2' __all__ = ['obscvty', 'osmodumpdoc', 'osmotestconfig', 'osmotestvty', 'osmoutil', 'osmo_ipa', + 'osmo_ctrl', + 'soap', + 'twisted_ipa', 'osmo_interact_common', 'osmo_interact_vty', 'osmo_interact_ctrl', diff --git a/osmopy/osmo_ctrl.py b/osmopy/osmo_ctrl.py new file mode 100755 index 0000000..003f100 --- /dev/null +++ b/osmopy/osmo_ctrl.py @@ -0,0 +1,120 @@ +#!/usr/bin/python +# -*- 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. + */ +""" + +from optparse import OptionParser +from osmopy.osmo_ipa import Ctrl +import socket + +verbose = False + +def connect(host, port): + if verbose: + print "Connecting to host %s:%i" % (host, port) + + sck = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + sck.setblocking(1) + sck.connect((host, port)) + return sck + +def do_set_get(sck, var, value = None): + (r, c) = Ctrl().cmd(var, value) + sck.send(c) + answer = Ctrl().rem_header(sck.recv(4096)) + return (answer,) + Ctrl().verify(answer, r, var, value) + +def set_var(sck, var, val): + (a, _, _) = do_set_get(sck, var, val) + return a + +def get_var(sck, var): + (_, _, v) = do_set_get(sck, var) + return v + +def _leftovers(sck, fl): + """ + Read outstanding data if any according to flags + """ + try: + data = sck.recv(1024, fl) + except socket.error as (s_errno, strerror): + return False + if len(data) != 0: + tail = data + while True: + (head, tail) = Ctrl().split_combined(tail) + print "Got message:", Ctrl().rem_header(head) + if len(tail) == 0: + break + return True + return False + +if __name__ == '__main__': + parser = OptionParser("Usage: %prog [options] var [value]") + parser.add_option("-d", "--host", dest="host", + help="connect to HOST", metavar="HOST") + parser.add_option("-p", "--port", dest="port", type="int", + help="use PORT", metavar="PORT", default=4249) + parser.add_option("-g", "--get", action="store_true", + dest="cmd_get", help="perform GET operation") + parser.add_option("-s", "--set", action="store_true", + dest="cmd_set", help="perform SET operation") + parser.add_option("-v", "--verbose", action="store_true", + dest="verbose", help="be verbose", default=False) + parser.add_option("-m", "--monitor", action="store_true", + dest="monitor", help="monitor the connection for traps", default=False) + + (options, args) = parser.parse_args() + + verbose = options.verbose + + if options.cmd_set and options.cmd_get: + parser.error("Get and set options are mutually exclusive!") + + if not (options.cmd_get or options.cmd_set or options.monitor): + parser.error("One of -m, -g, or -s must be set") + + if not (options.host): + parser.error("Destination host and port required!") + + sock = connect(options.host, options.port) + + if options.cmd_set: + if len(args) < 2: + parser.error("Set requires var and value arguments") + _leftovers(sock, socket.MSG_DONTWAIT) + print "Got message:", set_var(sock, args[0], ' '.join(args[1:])) + + if options.cmd_get: + if len(args) != 1: + parser.error("Get requires the var argument") + _leftovers(sock, socket.MSG_DONTWAIT) + (a, _, _) = do_set_get(sock, args[0]) + print "Got message:", a + + if options.monitor: + while True: + if not _leftovers(sock, 0): + print "Connection is gone." + break + sock.close() diff --git a/osmopy/soap.py b/osmopy/soap.py new file mode 100755 index 0000000..f1da8f2 --- /dev/null +++ b/osmopy/soap.py @@ -0,0 +1,188 @@ +#!/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.7.1" # bump this on every non-trivial change + +from twisted.internet import defer, reactor +from twisted_ipa import CTRL, IPAFactory, __version__ as twisted_ipa_version +from osmopy.osmo_ipa import Ctrl +from treq import post, collect +from suds.client import Client +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 + +# 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 SOAP-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 } # SOAP server treats it as boolean but expects int + + +def handle_reply(p, f, log, r): + """ + Reply handler: takes function p to process raw SOAP server reply r, function f to run for each command and verbosity flag v + """ + repl = p(r) # result is expected to have both commands[] array and error string (could be None) + bsc_id = repl.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 SOAP response for BSC %s with %d commands, error status: %s" % (bsc_id, len(repl.commands), repl.error)) + log.debug("BSC %s commands: %s" % (bsc_id, repl.commands)) + for t in repl.commands: # Process OpenBscCommands format from .wsdl + (_, m) = Ctrl().cmd(*t.split()) + f(m) + + +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 SOAP context 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)) + ctx = self.factory.client.registerSiteLocation(bsc, float(lon), float(lat), fix.get(fx, 0), tstamp, oper.get(opr, 2), admin.get(adm, 2), policy.get(pol, 3)) + d = post(self.factory.location, ctx.envelope) + d.addCallback(collect, partial(handle_reply, ctx.process_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@bsc-id %s => %s' % (bsc, data)) + + +class TrapFactory(IPAFactory): + """ + Store SOAP client object so TRAP handler can use it for requests + """ + location = None + log = None + semaphore = None + client = None + host = None + port = None + def __init__(self, host, port, proto, semaphore, log, wsdl=None, location=None): + 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 + soap = Client(wsdl, location=location, nosend=True) # make async SOAP client + self.location = location.encode() if location else soap.wsdl.services[0].ports[0].location # necessary for dispatching HTTP POST via treq + self.client = soap.service + 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, SUDS client: %s" % (Ctrl.version, soap)) + + +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 SOAP service and Osmocom CTRL protocol.') + p.add_argument('-v', '--version', action='version', version=("%(prog)s v" + __version__)) + p.add_argument('-p', '--port', type=int, default=4250, help="Port to use for CTRL interface, defaults to 4250") + p.add_argument('-c', '--ctrl', default='localhost', help="Adress to use for CTRL interface, defaults to localhost") + p.add_argument('-w', '--wsdl', required=True, help="WSDL URL for SOAP") + p.add_argument('-n', '--num', type=int, default=5, help="Max number of concurrent HTTP requests to SOAP 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="Override location found in WSDL file (don't use unless you know what you're doing)") + args = p.parse_args() + + log = logging.getLogger('CTRL2SOAP') + 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 + + log.info("SOAP proxy %s starting with PID %d ..." % (__version__, os.getpid())) + reactor.connectTCP(args.ctrl, args.port, TrapFactory(args.ctrl, args.port, Trap, defer.DeferredSemaphore(args.num), log, args.wsdl, args.location)) + reactor.run() diff --git a/osmopy/twisted_ipa.py b/osmopy/twisted_ipa.py new file mode 100755 index 0000000..bb8323d --- /dev/null +++ b/osmopy/twisted_ipa.py @@ -0,0 +1,384 @@ +#!/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.7.0" # bump this on every non-trivial change + +from osmopy.osmo_ipa import Ctrl, IPA +from twisted.internet.protocol import ReconnectingClientFactory +from twisted.internet import reactor +from twisted.protocols import basic +import argparse, logging, sys + +class IPACommon(basic.Int16StringReceiver): + """ + Generic IPA protocol handler: include some routines for simpler subprotocols. + It's not intended as full implementation of all subprotocols, rather common ground and example code. + """ + def dbg(self, line): + """ + Debug print helper + """ + self.factory.log.debug(line) + + def osmo_CTRL(self, data): + """ + OSMO CTRL protocol + Placeholder, see corresponding derived class + """ + pass + + def osmo_MGCP(self, data): + """ + OSMO MGCP extension + """ + self.dbg('OSMO MGCP received %s' % data) + + def osmo_LAC(self, data): + """ + OSMO LAC extension + """ + self.dbg('OSMO LAC received %s' % data) + + def osmo_SMSC(self, data): + """ + OSMO SMSC extension + """ + self.dbg('OSMO SMSC received %s' % data) + + def osmo_ORC(self, data): + """ + OSMO ORC extension + """ + self.dbg('OSMO ORC received %s' % data) + + def osmo_GSUP(self, data): + """ + OSMO GSUP extension + """ + self.dbg('OSMO GSUP received %s' % data) + + def osmo_OAP(self, data): + """ + OSMO OAP extension + """ + self.dbg('OSMO OAP received %s' % data) + + def osmo_UNKNOWN(self, data): + """ + OSMO defaul extension handler + """ + self.dbg('OSMO unknown extension received %s' % data) + + def handle_RSL(self, data, proto, extension): + """ + RSL protocol handler + """ + self.dbg('IPA RSL received message with extension %s' % extension) + + def handle_CCM(self, data, proto, msgt): + """ + CCM (IPA Connection Management) + Placeholder, see corresponding derived class + """ + pass + + def handle_SCCP(self, data, proto, extension): + """ + SCCP protocol handler + """ + self.dbg('IPA SCCP received message with extension %s' % extension) + + def handle_OML(self, data, proto, extension): + """ + OML protocol handler + """ + self.dbg('IPA OML received message with extension %s' % extension) + + def handle_OSMO(self, data, proto, extension): + """ + Dispatcher point for OSMO subprotocols based on extension name, lambda default should never happen + """ + method = getattr(self, 'osmo_' + IPA().ext(extension), lambda: "extension dispatch failure") + method(data) + + def handle_MGCP(self, data, proto, extension): + """ + MGCP protocol handler + """ + self.dbg('IPA MGCP received message with attribute %s' % extension) + + def handle_UNKNOWN(self, data, proto, extension): + """ + Default protocol handler + """ + self.dbg('IPA received message for %s (%s) protocol with attribute %s' % (IPA().proto(proto), proto, extension)) + + def process_chunk(self, data): + """ + Generic message dispatcher for IPA (sub)protocols based on protocol name, lambda default should never happen + """ + (_, proto, extension, content) = IPA().del_header(data) + if content is not None: + self.dbg('IPA received %s::%s [%d/%d] %s' % (IPA().proto(proto), IPA().ext_name(proto, extension), len(data), len(content), content)) + method = getattr(self, 'handle_' + IPA().proto(proto), lambda: "protocol dispatch failure") + method(content, proto, extension) + + def dataReceived(self, data): + """ + Override for dataReceived from Int16StringReceiver because of inherently incompatible interpretation of length + If default handler is used than we would always get off-by-1 error (Int16StringReceiver use equivalent of l + 2) + """ + if len(data): + (head, tail) = IPA().split_combined(data) + self.process_chunk(head) + self.dataReceived(tail) + + def connectionMade(self): + """ + We have to resetDelay() here to drop internal state to default values to make reconnection logic work + Make sure to call this via super() if overriding to keep reconnection logic intact + """ + addr = self.transport.getPeer() + self.dbg('IPA connected to %s:%d peer' % (addr.host, addr.port)) + self.factory.resetDelay() + + +class CCM(IPACommon): + """ + Implementation of CCM protocol for IPA multiplex + """ + def ack(self): + self.transport.write(IPA().id_ack()) + + def ping(self): + self.transport.write(IPA().ping()) + + def pong(self): + self.transport.write(IPA().pong()) + + def handle_CCM(self, data, proto, msgt): + """ + CCM (IPA Connection Management) + Only basic logic necessary for tests is implemented (ping-pong, id ack etc) + """ + if msgt == IPA.MSGT['ID_GET']: + self.transport.getHandle().sendall(IPA().id_resp(self.factory.ccm_id)) + # if we call + # self.transport.write(IPA().id_resp(self.factory.test_id)) + # instead, than we would have to also call + # reactor.callLater(1, self.ack) + # instead of self.ack() + # otherwise the writes will be glued together - hence the necessity for ugly hack with 1s timeout + # Note: this still might work depending on the IPA implementation details on the other side + self.ack() + # schedule PING in 4s + reactor.callLater(4, self.ping) + if msgt == IPA.MSGT['PING']: + self.pong() + + +class CTRL(IPACommon): + """ + Implementation of Osmocom control protocol for IPA multiplex + """ + def ctrl_SET(self, data, op_id, v): + """ + Handle CTRL SET command + """ + self.dbg('CTRL SET [%s] %s' % (op_id, v)) + + def ctrl_SET_REPLY(self, data, op_id, v): + """ + Handle CTRL SET reply + """ + self.dbg('CTRL SET REPLY [%s] %s' % (op_id, v)) + + def ctrl_GET(self, data, op_id, v): + """ + Handle CTRL GET command + """ + self.dbg('CTRL GET [%s] %s' % (op_id, v)) + + def ctrl_GET_REPLY(self, data, op_id, v): + """ + Handle CTRL GET reply + """ + self.dbg('CTRL GET REPLY [%s] %s' % (op_id, v)) + + def ctrl_TRAP(self, data, op_id, v): + """ + Handle CTRL TRAP command + """ + self.dbg('CTRL TRAP [%s] %s' % (op_id, v)) + + def ctrl_ERROR(self, data, op_id, v): + """ + Handle CTRL ERROR reply + """ + self.dbg('CTRL ERROR [%s] %s' % (op_id, v)) + + def osmo_CTRL(self, data): + """ + OSMO CTRL message dispatcher, lambda default should never happen + For basic tests only, appropriate handling routines should be replaced: see CtrlServer for example + """ + self.dbg('OSMO CTRL received %s::%s' % Ctrl().parse(data.decode('utf-8'))) + (cmd, op_id, v) = data.decode('utf-8').split(' ', 2) + method = getattr(self, 'ctrl_' + cmd, lambda: "CTRL unknown command") + method(data, op_id, v) + + +class IPAServer(CCM): + """ + Test implementation of IPA server + Demonstrate CCM opearation by overriding necessary bits from CCM + """ + def connectionMade(self): + """ + Keep reconnection logic working by calling routine from CCM + Initiate CCM upon connection + """ + addr = self.transport.getPeer() + self.factory.log.info('IPA server: connection from %s:%d client' % (addr.host, addr.port)) + super(IPAServer, self).connectionMade() + self.transport.write(IPA().id_get()) + + +class CtrlServer(CTRL): + """ + Test implementation of CTRL server + Demonstarte CTRL handling by overriding simpler routines from CTRL + """ + def connectionMade(self): + """ + Keep reconnection logic working by calling routine from CTRL + Send TRAP upon connection + Note: we can't use sendString() because of it's incompatibility with IPA interpretation of length prefix + """ + addr = self.transport.getPeer() + self.factory.log.info('CTRL server: connection from %s:%d client' % (addr.host, addr.port)) + super(CtrlServer, self).connectionMade() + self.transport.write(Ctrl().trap('LOL', 'what')) + self.transport.write(Ctrl().trap('rulez', 'XXX')) + + def reply(self, r): + self.transport.write(Ctrl().add_header(r)) + + def ctrl_SET(self, data, op_id, v): + """ + CTRL SET command: always succeed + """ + self.dbg('SET [%s] %s' % (op_id, v)) + self.reply('SET_REPLY %s %s' % (op_id, v)) + + def ctrl_GET(self, data, op_id, v): + """ + CTRL GET command: always fail + """ + self.dbg('GET [%s] %s' % (op_id, v)) + self.reply('ERROR %s No variable found' % op_id) + + +class IPAFactory(ReconnectingClientFactory): + """ + Generic IPA Client Factory which can be used to store state for various subprotocols and manage connections + Note: so far we do not really need separate Factory for acting as a server due to protocol simplicity + """ + protocol = IPACommon + log = None + ccm_id = IPA().identity(unit=b'1515/0/1', mac=b'b0:0b:fa:ce:de:ad:be:ef', utype=b'sysmoBTS', name=b'StingRay', location=b'hell', sw=IPA.version.encode('utf-8')) + + def __init__(self, proto=None, log=None, ccm_id=None): + if proto: + self.protocol = proto + if ccm_id: + self.ccm_id = ccm_id + if log: + self.log = log + else: + self.log = logging.getLogger('IPAFactory') + self.log.setLevel(logging.CRITICAL) + self.log.addHandler(logging.NullHandler) + + def clientConnectionFailed(self, connector, reason): + """ + Only necessary for as debugging aid - if we can somehow set parent's class noisy attribute then we can omit this method + """ + self.log.warning('IPAFactory connection failed: %s' % reason.getErrorMessage()) + ReconnectingClientFactory.clientConnectionFailed(self, connector, reason) + + def clientConnectionLost(self, connector, reason): + """ + Only necessary for as debugging aid - if we can somehow set parent's class noisy attribute then we can omit this method + """ + self.log.warning('IPAFactory connection lost: %s' % reason.getErrorMessage()) + ReconnectingClientFactory.clientConnectionLost(self, connector, reason) + + +if __name__ == '__main__': + p = argparse.ArgumentParser("Twisted IPA (module v%s) app" % IPA.version) + p.add_argument('-v', '--version', action='version', version="%(prog)s v" + __version__) + p.add_argument('-p', '--port', type=int, default=4250, help="Port to use for CTRL interface") + p.add_argument('-d', '--host', default='localhost', help="Adress to use for CTRL interface") + cs = p.add_mutually_exclusive_group() + cs.add_argument("-c", "--client", action='store_true', help="asume client role") + cs.add_argument("-s", "--server", action='store_true', help="asume server role") + ic = p.add_mutually_exclusive_group() + ic.add_argument("--ipa", action='store_true', help="use IPA protocol") + ic.add_argument("--ctrl", action='store_true', help="use CTRL protocol") + args = p.parse_args() + test = False + + log = logging.getLogger('TwistedIPA') + log.setLevel(logging.DEBUG) + log.addHandler(logging.StreamHandler(sys.stdout)) + + if args.ctrl: + if args.client: + # Start osmo-bsc to receive TRAP messages when osmo-bts-* connects to it + print('CTRL client, connecting to %s:%d' % (args.host, args.port)) + reactor.connectTCP(args.host, args.port, IPAFactory(CTRL, log)) + test = True + if args.server: + # Use bsc_control.py to issue set/get commands + print('CTRL server, listening on port %d' % args.port) + reactor.listenTCP(args.port, IPAFactory(CtrlServer, log)) + test = True + if args.ipa: + if args.client: + # Start osmo-nitb which would initiate A-bis/IP session + print('IPA client, connecting to %s ports %d and %d' % (args.host, IPA.TCP_PORT_OML, IPA.TCP_PORT_RSL)) + reactor.connectTCP(args.host, IPA.TCP_PORT_OML, IPAFactory(CCM, log)) + reactor.connectTCP(args.host, IPA.TCP_PORT_RSL, IPAFactory(CCM, log)) + test = True + if args.server: + # Start osmo-bts-* which would attempt to connect to us + print('IPA server, listening on ports %d and %d' % (IPA.TCP_PORT_OML, IPA.TCP_PORT_RSL)) + reactor.listenTCP(IPA.TCP_PORT_RSL, IPAFactory(IPAServer, log)) + reactor.listenTCP(IPA.TCP_PORT_OML, IPAFactory(IPAServer, log)) + test = True + if test: + reactor.run() + else: + print("Please specify which protocol in which role you'd like to test.") diff --git a/setup.py b/setup.py index a1fad1a..daff5ea 100755 --- a/setup.py +++ b/setup.py @@ -25,6 +25,9 @@ if sys.version_info.major == 2: elif sys.version_info.major == 3: scripts = ["osmopy/osmo_interact_vty.py", "osmopy/osmo_interact_ctrl.py", + "osmopy/soap.py", + "osmopy/osmo_ctrl.py", + "osmopy/twisted_ipa.py", "osmopy/osmo_verify_transcript_vty.py", "osmopy/osmo_verify_transcript_ctrl.py"]