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/.
Max gerrit-no-reply at lists.osmocom.orgHello Jenkins Builder,
I'd like you to reexamine a change. Please visit
https://gerrit.osmocom.org/1265
to look at the new patch set (#3).
Add IPA multiplexor
Add base class and derived Ctrl class implementing ctrl-specific
routines.
Change-Id: I41e37ec143183e422c0b31af95d183bd84f0c328
Related: SYS#3028
---
A openbsc/contrib/ipa.py
1 file changed, 268 insertions(+), 0 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/openbsc refs/changes/65/1265/3
diff --git a/openbsc/contrib/ipa.py b/openbsc/contrib/ipa.py
new file mode 100755
index 0000000..61653b1
--- /dev/null
+++ b/openbsc/contrib/ipa.py
@@ -0,0 +1,268 @@
+#!/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.
+ */
+"""
+
+import struct, random, sys
+
+class IPA(object):
+ """
+ Stateless IPA protocol multiplexor: add/remove/parse (extended) header
+ """
+ version = "0.0.1"
+ TCP_PORT_OML = 3002
+ TCP_PORT_RSL = 3003
+ # OpenBSC extensions: OSMO, MGCP_OLD
+ PROTO = dict(RSL = 0x00, CCM = 0xFE, SCCP = 0xFD, OML = 0xFF, OSMO = 0xEE, MGCP_OLD = 0xFC)
+ # ...OML Router Control, GSUP GPRS extension, Osmocom Authn Protocol
+ EXT = dict(CTRL = 0, MGCP = 1, LAC = 2, SMSC = 3, ORC = 4, GSUP = 5, OAP = 6)
+ # OpenBSC extension: SCCP_OLD
+ MSGT = dict(PING = 0x00, PONG = 0x01, ID_GET = 0x04, ID_RESP = 0x05, ID_ACK = 0x06, SCCP_OLD = 0xFF)
+ IDTAG = dict(SERNR = 0, UNITNAME = 1, LOCATION = 2, TYPE = 3, EQUIPVERS = 4, SWVERSION = 5, IPADDR = 6, MACADDR = 7, UNIT = 8)
+
+ def __l(self, d, p):
+ """
+ Reverse dictionary lookup: return key for a given value
+ """
+ if p != None:
+ return list(d.keys())[list(d.values()).index(p)]
+ return 'UNKNOWN'
+
+ def __tag(self, t, v):
+ """
+ Create TAG as TLV data
+ """
+ return struct.pack(">HB", len(v) + 1, t) + v
+
+ def proto(self, p):
+ """
+ Lookup protocol name
+ """
+ return self.__l(self.PROTO, p)
+
+ def ext(self, p):
+ """
+ Lookup protocol extension name
+ """
+ return self.__l(self.EXT, p)
+
+ def msgt(self, p):
+ """
+ Lookup message type name
+ """
+ return self.__l(self.MSGT, p)
+
+ def idtag(self, p):
+ """
+ Lookup ID tag name
+ """
+ return self.__l(self.IDTAG, p)
+
+ def ext_name(self, proto, exten):
+ """
+ Return proper extension byte name depending on the protocol used
+ """
+ if self.PROTO['CCM'] == proto:
+ return self.msgt(exten)
+ if self.PROTO['OSMO'] == proto:
+ return self.ext(exten)
+ return None
+
+ def add_header(self, data, proto, ext = None):
+ """
+ Add IPA header (with extension if necessary), data must be represented as bytes
+ """
+ if ext != None:
+ return struct.pack(">HBB", len(data) + 1, proto, ext) + data
+ else:
+ return struct.pack(">HB", len(data) + 1, proto) + data
+
+ def del_header(self, data):
+ """
+ Strip IPA protocol header correctly removing extension if present
+ Returns data length, IPA protocol, extension (or None if not defined for a give protocol) and the data without header
+ """
+ (dlen, proto) = struct.unpack(">HB", data[:3])
+ if self.PROTO['OSMO'] == proto or self.PROTO['CCM'] == proto:
+ return struct.unpack(">HBB", data[:4]) + (data[4:], )
+ return dlen, proto, None, data[3:]
+
+ def tag_serial(self, data):
+ """
+ Make TAG for serial number
+ """
+ return self.__tag(self.IDTAG['SERNR'], data)
+
+ def tag_name(self, data):
+ """
+ Make TAG for unit name
+ """
+ return self.__tag(self.IDTAG['UNITNAME'], data)
+
+ def tag_loc(self, data):
+ """
+ Make TAG for location
+ """
+ return self.__tag(self.IDTAG['LOCATION'], data)
+
+ def tag_type(self, data):
+ """
+ Make TAG for unit type
+ """
+ return self.__tag(self.IDTAG['TYPE'], data)
+
+ def tag_equip(self, data):
+ """
+ Make TAG for equipment version
+ """
+ return self.__tag(self.IDTAG['EQUIPVERS'], data)
+
+ def tag_sw(self, data):
+ """
+ Make TAG for software version
+ """
+ return self.__tag(self.IDTAG['SWVERSION'], data)
+
+ def tag_ip(self, data):
+ """
+ Make TAG for IP address
+ """
+ return self.__tag(self.IDTAG['IPADDR'], data)
+
+ def tag_mac(self, data):
+ """
+ Make TAG for MAC address
+ """
+ return self.__tag(self.IDTAG['MACADDR'], data)
+
+ def tag_unit(self, data):
+ """
+ Make TAG for unit ID
+ """
+ return self.__tag(self.IDTAG['UNIT'], data)
+
+ def identity(self, unit = b'', mac = b'', location = b'', utype = b'', equip = b'', sw = b'', name = b'', serial = b''):
+ """
+ Make IPA IDENTITY tag list, by default returns empty concatenated bytes of tag list
+ """
+ return self.tag_unit(unit) + self.tag_mac(mac) + self.tag_loc(location) + self.tag_type(utype) + self.tag_equip(equip) + self.tag_sw(sw) + self.tag_name(name) + self.tag_serial(serial)
+
+ def ping(self):
+ """
+ Make PING message
+ """
+ return self.add_header(b'', self.PROTO['CCM'], self.MSGT['PING'])
+
+ def pong(self):
+ """
+ Make PONG message
+ """
+ return self.add_header(b'', self.PROTO['CCM'], self.MSGT['PONG'])
+
+ def id_ack(self):
+ """
+ Make ID_ACK CCM message
+ """
+ return self.add_header(b'', self.PROTO['CCM'], self.MSGT['ID_ACK'])
+
+ def id_get(self):
+ """
+ Make ID_GET CCM message
+ """
+ return self.add_header(self.identity(), self.PROTO['CCM'], self.MSGT['ID_GET'])
+
+ def id_resp(self, data):
+ """
+ Make ID_RESP CCM message
+ """
+ return self.add_header(data, self.PROTO['CCM'], self.MSGT['ID_RESP'])
+
+class Ctrl(IPA):
+ """
+ Osmocom CTRL protocol implemented on top of IPA multiplexor
+ """
+ def __init__(self):
+ random.seed()
+
+ def add_header(self, data):
+ """
+ Add CTRL header
+ """
+ return super(Ctrl, self).add_header(data.encode('utf-8'), IPA.PROTO['OSMO'], IPA.EXT['CTRL'])
+
+ def del_header(self, data):
+ """
+ Strip CTRL protocol header while correctly checking and removing extension
+ Returns data length and the data without header (or None if parsing failed)
+ """
+ (dlen, proto, ext, d) = super(Ctrl, self).del_header(data)
+ if self.PROTO['OSMO'] != proto or self.EXT['CTRL'] != ext:
+ return dlen, None
+ return dlen, d
+
+ def parse(self, data, op = None):
+ """
+ Parse Ctrl string returning (var, value) pair
+ var could be None in case of ERROR message
+ value could be None in case of GET message
+ """
+ (s, i, v) = data.split(' ', 2)
+ if 'ERROR' == s:
+ return None, v
+ if 'GET' == s:
+ return v, None
+ (s, i, var, val) = data.split(' ', 3)
+ if 'TRAP' == s and i != '0':
+ return None, 'TRAP with non-zero id %s' % i
+ if op != None:
+ if 'SET_REPLY' == s and i != op:
+ return None, 'SET reply with unexpected id %s' % i
+ if 'GET_REPLY' == s and i != op:
+ return None, 'GET reply with unexpected id %s' % i
+ return var, val
+
+ def trap(self, var, val):
+ """
+ Make TRAP message with given (vak, val) pair
+ """
+ return self.add_header("TRAP 0 %s %s" %(var, val))
+
+ def cmd(self, var, val = None):
+ """
+ Make SET/GET command message: returns (r, m) tuple where r is random operation id and m is assembled message
+ """
+ r = random.randint(1, sys.maxint)
+ if val != None:
+ return r, self.add_header("SET %s %s %s" %(r, var, val))
+ return r, self.add_header("GET %s %s" %(r, var))
+
+ def verify(self, reply, r, var, val = None):
+ """
+ Verify reply to SET/GET command: returns (b, v) tuple where v is True/False verification result and v is the variable value
+ """
+ (k, v) = self.parse(reply)
+ if k != var or (val != None and v != val):
+ return False, v
+ return True, v
+
+if __name__ == '__main__':
+ print("IPA multiplexor v%s loaded." % IPA.version)
--
To view, visit https://gerrit.osmocom.org/1265
To unsubscribe, visit https://gerrit.osmocom.org/settings
Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I41e37ec143183e422c0b31af95d183bd84f0c328
Gerrit-PatchSet: 3
Gerrit-Project: openbsc
Gerrit-Branch: master
Gerrit-Owner: Max <msuraev at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder