diff --git a/cloud/endagaweb/static/js/dashboard/sms-broadcast.js b/cloud/endagaweb/static/js/dashboard/sms-broadcast.js
new file mode 100644
index 00000000..b58e21dd
--- /dev/null
+++ b/cloud/endagaweb/static/js/dashboard/sms-broadcast.js
@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2016-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+ function broadcastSms() {
+ var data = {
+ sendto: $('input[type=radio][name="send_to"]:checked').val(),
+ network_id: $('#network_id').val(),
+ tower_id: $('#bts_id').val(),
+ imsi: $('#imsi').val(),
+ message: $('#message').val(),
+ csrfmiddlewaretoken: $('#token').val(),
+ };
+ $.post('/dashboard/broadcast', data, function(response) {
+ if (response['status'] == 'ok') {
+ // Show that it was successful and then reload the page.
+ // Clear out any old messages and show the div again.
+ $('#messages-container').html();
+ $('#messages-container').css('opacity', 1);
+ var html = '';
+ response['messages'].map(function(message) {
+ html += '
' + message + '
';
+ });
+ $('#messages-container').html(html).show();
+ setTimeout(function() {
+ location.reload();
+ }, 800);
+ } else {
+ // Show the messages that were sent back.
+ // Clear out any old messages and show the div again.
+ $('#messages-container').html();
+ $('#messages-container').css('opacity', 1);
+ var html = '';
+ response['messages'].map(function(message) {
+ html += '
Hello {{ user_profile.display_name }}, please enter your password for authorization.
+
+
+
+
+
+
+
+
+
+
@@ -152,7 +183,7 @@
No events match these filters!
{% if event_count > 100000 %}
Too many results to export, try a shorter date range.
{% elif event_count > 0 %}
- Export results as CSV
+ Export results as CSV
{% endif %}
+
$(function() {
// Show or hide parts of the form when autoupgrade is enabled or disabled.
$('input:radio').change(function() {
diff --git a/cloud/endagaweb/templates/dashboard/network_detail/inactive-subscribers.html b/cloud/endagaweb/templates/dashboard/network_detail/inactive-subscribers.html
index eb786070..c299f916 100644
--- a/cloud/endagaweb/templates/dashboard/network_detail/inactive-subscribers.html
+++ b/cloud/endagaweb/templates/dashboard/network_detail/inactive-subscribers.html
@@ -150,5 +150,6 @@
});
});
+
{% endblock %}
diff --git a/cloud/endagaweb/templates/dashboard/network_detail/info.html b/cloud/endagaweb/templates/dashboard/network_detail/info.html
index 6ae1b2c5..f877da3e 100644
--- a/cloud/endagaweb/templates/dashboard/network_detail/info.html
+++ b/cloud/endagaweb/templates/dashboard/network_detail/info.html
@@ -81,3 +81,7 @@
@@ -46,3 +43,5 @@
+
+{% include "dashboard/subscriber_detail/broadcast.html" with target='imsi' imsi=subscriber.imsi %}
\ No newline at end of file
diff --git a/cloud/endagaweb/templates/dashboard/tower_detail/deregister.html b/cloud/endagaweb/templates/dashboard/tower_detail/deregister.html
index d2ad1fdf..18663d96 100644
--- a/cloud/endagaweb/templates/dashboard/tower_detail/deregister.html
+++ b/cloud/endagaweb/templates/dashboard/tower_detail/deregister.html
@@ -150,14 +150,13 @@
{% endif %}
-
{% endblock %}
{% block js %}
-
+
+
+
+
+{% endblock %}
\ No newline at end of file
diff --git a/cloud/endagaweb/templates/dashboard/tower_detail/tower_select.html b/cloud/endagaweb/templates/dashboard/tower_detail/tower_select.html
new file mode 100644
index 00000000..d28c018b
--- /dev/null
+++ b/cloud/endagaweb/templates/dashboard/tower_detail/tower_select.html
@@ -0,0 +1,12 @@
+
\ No newline at end of file
diff --git a/cloud/endagaweb/templatetags/apptags.py b/cloud/endagaweb/templatetags/apptags.py
index d52b019d..2f4068a6 100644
--- a/cloud/endagaweb/templatetags/apptags.py
+++ b/cloud/endagaweb/templatetags/apptags.py
@@ -15,7 +15,7 @@
import pytz
from ccm.common.currency import humanize_credits, CURRENCIES
-
+from endagaweb.models import (BTS)
register = Library()
@@ -80,3 +80,16 @@ def tmpl_const(name):
return settings.TEMPLATE_CONSTANTS.get(name, "")
except AttributeError:
return ""
+
+
+@register.inclusion_tag('dashboard/tower_detail/tower_select.html')
+def get_towers(network_id=None, selected_bts=None):
+ """get tower list for network """
+ try:
+ if network_id:
+ towers = BTS.objects.filter(network=network_id)
+ else:
+ towers = BTS.objects.all()
+ return {'towers': towers, 'uuid': selected_bts}
+ except:
+ return {'towers': [], 'uuid': selected_bts}
diff --git a/cloud/endagaweb/tests/test_subscriber_views.py b/cloud/endagaweb/tests/test_subscriber_views.py
index 61b26621..fca2299b 100644
--- a/cloud/endagaweb/tests/test_subscriber_views.py
+++ b/cloud/endagaweb/tests/test_subscriber_views.py
@@ -186,3 +186,29 @@ def test_get(self):
response = self.client.get('/dashboard/subscribers/%s/edit' %
self.subscriber_imsi)
self.assertEqual(200, response.status_code)
+
+
+class BroadcastViewTest(SubscriberBaseTest):
+ """Testing endagaweb.views.dashboard.BroadcastView."""
+
+ def test_post(self):
+ """Sending an SMS should redirect and generate a new task."""
+
+ data = {
+ 'message': 'test -- hi there',
+ 'sendto': 'network',
+ 'network_id': '',
+ 'tower_id': '',
+ 'imsi': self.subscriber_imsi
+ }
+ url = '/dashboard/broadcast'
+ with mock.patch('endagaweb.tasks.async_post.delay') as mocked_task:
+ self.client.post(url, data)
+ self.assertTrue(mocked_task.called)
+ args, _ = mocked_task.call_args
+ task_endpoint, task_data = args
+ expected_url = '%s/endaga_sms' % self.bts.inbound_url
+ self.assertEqual(expected_url, task_endpoint)
+ self.assertEqual('0000', task_data['sender'])
+ self.assertEqual(self.number.number, task_data['to'])
+ self.assertEqual(data['message'], task_data['text'])
diff --git a/cloud/endagaweb/urls.py b/cloud/endagaweb/urls.py
index d2b8d10c..e3ed8fd3 100644
--- a/cloud/endagaweb/urls.py
+++ b/cloud/endagaweb/urls.py
@@ -157,6 +157,9 @@
url(r'^dashboard/activity',
endagaweb.views.dashboard.ActivityView.as_view(),
name='network-activity'),
+ url(r'^dashboard/broadcast',
+ endagaweb.views.dashboard.BroadcastView.as_view(),
+ name='sms-brosdcast'),
# Raise a server error on-demand to test the 500 template.
url(r'^insta-five-hundred$',
diff --git a/cloud/endagaweb/views/dashboard.py b/cloud/endagaweb/views/dashboard.py
index fad4b84e..9986f106 100644
--- a/cloud/endagaweb/views/dashboard.py
+++ b/cloud/endagaweb/views/dashboard.py
@@ -9,6 +9,7 @@
"""
import datetime
+import json
import logging
import time
import urllib
@@ -33,18 +34,17 @@
import csv
import humanize
import pytz
-from rest_framework.authtoken.models import Token
import stripe
from guardian.shortcuts import get_objects_for_user
-from ccm.common.currency import parse_credits, humanize_credits, \
- CURRENCIES, Money
-from endagaweb.models import (UserProfile, Ledger, Subscriber, UsageEvent,
- Network, PendingCreditUpdate, Number)
+from ccm.common.currency import parse_credits, humanize_credits, CURRENCIES
+from endagaweb.models import (UserProfile, Subscriber, UsageEvent,
+ Network, PendingCreditUpdate, Number, BTS)
from endagaweb.util.currency import cents2mc
from endagaweb.forms import dashboard_forms as dform
from endagaweb import tasks
from endagaweb.views import django_tables
+import json
class ProtectedView(View):
""" A class-based view that requires a login. """
@@ -280,6 +280,7 @@ def get(self, request, imsi=None):
'currency': CURRENCIES[network.subscriber_currency],
'user_profile': user_profile,
'subscriber': subscriber,
+ 'network': network
}
try:
context['created'] = subscriber.usageevent_set.order_by(
@@ -432,6 +433,7 @@ def get(self, request, imsi=None):
'end_date': context_end_date,
'all_services': all_services,
'checked_services': checked_services,
+ 'network': network
}
template = get_template('dashboard/subscriber_detail/activity.html')
@@ -461,7 +463,8 @@ def get(self, request, imsi=None):
'user_profile': user_profile,
'subscriber': subscriber,
'send_sms_form': dform.SubscriberSendSMSForm(
- initial=initial_form_data)
+ initial=initial_form_data),
+ 'network': network
}
# Render template.
template = get_template('dashboard/subscriber_detail/send_sms.html')
@@ -526,6 +529,7 @@ def get(self, request, imsi=None):
'pending_updates': pending_updates,
'credit_update_form': dform.SubscriberCreditUpdateForm(
initial=initial_form_data),
+ 'network': network
}
# Render template.
template = get_template(
@@ -616,6 +620,7 @@ def get(self, request, imsi=None):
initial=initial_form_data),
'network_version': (
subscriber.network.get_lowest_tower_version()),
+ 'network': network
}
# Render template.
template = get_template(
@@ -688,6 +693,12 @@ def _handle_request(self, request):
request.session['end_date'] = request.POST.get('end_date', None)
request.session['services'] = request.POST.getlist('services[]',
None)
+ # Added to check password to download the csv
+ if (request.user.check_password(request.POST.get('password'))):
+ response = {'status': 'ok'}
+ return HttpResponse(json.dumps(response),
+ content_type="application/json")
+
# We always just do a redirect to GET. We include page reference
# to retain the search parameters in the session.
return redirect(urlresolvers.reverse('network-activity') +
@@ -910,3 +921,88 @@ def _search_events(self, profile, query_string, orig_events):
res_events |= events
return res_events
+
+
+class BroadcastView(ProtectedView):
+ """Send an SMS to a single subscriber."""
+
+ def post(self, request):
+ """Broadcast bulk SMS to network, tower or selected imsi.
+
+ This API will call tasks.async_post method to send request to
+ Client BTS system for broadcast SMS
+ """
+
+ sendto = request.POST.get('sendto', None)
+ network_id = request.POST.get('network_id', None)
+ tower_id = request.POST.get('tower_id', None)
+ imsi_str = request.POST.get('imsi', None)
+ message = request.POST.get('message', None)
+ response = {
+ 'status': 'failed',
+ 'messages': [],
+ }
+ if sendto in ['network', 'tower']:
+ if (sendto == 'tower' and not tower_id) or sendto == 'network':
+ # Lookup for BTS inbound_url.
+ bts_list = BTS.objects.filter(network=network_id)
+ else:
+ # Lookup for BTS inbound_url.
+ bts_list = BTS.objects.filter(id=tower_id)
+
+ for bts in bts_list:
+ # Fire off an async task request to send the SMS.
+ params = {
+ 'to': '*',
+ 'sender': '0000',
+ 'text': message,
+ 'msgid': str(uuid.uuid4())
+ }
+ url = bts.inbound_url + "/endaga_sms"
+ tasks.async_post.delay(url, params)
+ elif sendto == 'imsi':
+ imsi_list = imsi_str.split(',')
+ invalid_imsi = []
+ subscribers = []
+ for imsi in imsi_list:
+ try:
+ sub = Subscriber.objects.get(imsi=imsi, network=network_id)
+ subscribers.append(sub)
+ except Subscriber.DoesNotExist:
+ invalid_imsi.append(imsi)
+ if not imsi_str:
+ message = "Enter Subscriber IMSI number."
+ response['messages'].append(message)
+ return HttpResponse(json.dumps(response),
+ content_type="application/json")
+ if len(invalid_imsi) > 0:
+ message = "%s does not exist in this network." % (','.join(
+ invalid_imsi))
+ response['messages'].append(message)
+ return HttpResponse(json.dumps(response),
+ content_type="application/json")
+ for subscriber in subscribers:
+ try:
+ # We send sms to the subscriber's first number.
+ num = subscriber.number_set.all()[0]
+ except:
+ num = None
+ if num:
+ # Fire off an async task request to send the SMS.
+ params = {
+ 'to': num.number,
+ 'sender': '0000',
+ 'text': message,
+ 'msgid': str(uuid.uuid4())
+ }
+ url = subscriber.bts.inbound_url + "/endaga_sms"
+ tasks.async_post.delay(url, params)
+ else:
+ response['messages'].append('Invalid request data.')
+ return HttpResponse(json.dumps(response),
+ content_type="application/json")
+ message = "Broadcast SMS sent successfully"
+ response['status'] = 'ok'
+ response['messages'].append(message)
+ return HttpResponse(json.dumps(response),
+ content_type="application/json")
diff --git a/cloud/endagaweb/views/towers.py b/cloud/endagaweb/views/towers.py
index db57cfb8..ae57f100 100644
--- a/cloud/endagaweb/views/towers.py
+++ b/cloud/endagaweb/views/towers.py
@@ -145,6 +145,7 @@ def get(self, request, uuid=None):
'tower_endaga_version': tower.printable_version(
versions['endaga_version']),
'uptime': uptime,
+ 'network': user_profile.network
}
# Render template.
info_template = template.loader.get_template(
@@ -180,6 +181,7 @@ def get(self, request, uuid=None):
'timezone_offset': timezone_offset,
'endaga_version': endaga_version,
'tower_has_monitoring_stats': tower_has_monitoring_stats,
+ 'network': user_profile.network
}
# Render template.
monitor_template = template.loader.get_template(
@@ -217,6 +219,7 @@ def get(self, request, uuid=None):
'tower': tower,
'tower_nickname': tower.nickname if tower.nickname else '',
'suggested_nickname': suggested_nickname,
+ 'network': user_profile.network
}
# Render template.
edit_template = template.loader.get_template(
@@ -298,6 +301,7 @@ def get(self, request, uuid=None):
'tower': tower,
'endaga_version': endaga_version,
'status': tower.get_status_display(),
+ 'network': user_profile.network
}
# Render template.
edit_template = template.loader.get_template(
@@ -356,6 +360,7 @@ def _handle_request(self, request, uuid=None):
'tower': tower,
'endaga_version': endaga_version,
'events': events,
+ 'network': user_profile.network
}
# Render template.
edit_template = template.loader.get_template(
diff --git a/osmocom-python/osmocom/gsup/protocols/ipa.py b/osmocom-python/osmocom/gsup/protocols/ipa.py
old mode 100644
new mode 100755
index 48d11ce1..e46a37a8
--- a/osmocom-python/osmocom/gsup/protocols/ipa.py
+++ b/osmocom-python/osmocom/gsup/protocols/ipa.py
@@ -9,32 +9,55 @@
import asyncio
import logging
+import random
import struct
+from abc import ABC, abstractmethod
from . import gsup
-# IPA constants
+# IPA Constants
+# References:
+# - http://ftp.osmocom.org/docs/latest/osmobts-abis.pdf
+# - http://ftp.osmocom.org/docs/latest/osmobsc-usermanual.pdf
+
+# IPA Misc
IPA_HEADER_LEN = 3
+
+# IPA Stream ID
IPA_STREAM_CCM = 0xfe
IPA_STREAM_OSMO = 0xee
-# IPA OSMO Extenstions
+# IPA Osmo Extenstions
IPA_OSMO_GSUP = 0x05
IPA_OSMO_OAP = 0x06
+IPA_OSMO_CTRL = 0x00
# IPA CCM messages
IPA_CCM_PING = 0x00
IPA_CCM_PONG = 0x01
+# IPA ports
+TCP_PORT_OML = 3002
+TCP_PORT_RSL = 3003
+TCP_PORT_NITB = 4249
+
+# IPA cmds
+GET_CMD = 'GET'
+SET_CMD = 'SET'
+TRAP_CMD = 'TRAP'
-class OsmoIPAccessProtocol(asyncio.Protocol):
+
+class OsmoIPAccessProtocol(asyncio.Protocol, ABC):
"""
IP Access is layer is used above TCP/IP to:
- multiplex multiple protocols over the same connection
- abstract segmentation so higher protocols can handle msg as a whole
+ References:
+ - http://ftp.osmocom.org/docs/latest/osmobts-abis.pdf
+
IPA multiplexing layer:
Offset Length Field
@@ -52,30 +75,33 @@ class OsmoIPAccessProtocol(asyncio.Protocol):
"""
- def __init__(self, gsm_processor):
- self._gsm_processor = gsm_processor
- self._gsup_manager = None
- self._ccm_manager = None
- # bytesarray is more efficient to append fragments of reads
+ def __init__(self, gsup_callback=None, ctrl_callback=None):
+ self._gsup_callback = gsup_callback
+ self._ctrl_callback = ctrl_callback
self._readbuf = bytearray()
def connection_made(self, transport):
"""
- Handle the new IPA connection.
+ Serves to initialize all protocol managers and their writers with each
+ protocol's respective headers.
- Args:
- transport (asynio.Transport): the transport for the new connection
- Returns:
- None
+ In the case of server subclasses, this connection_made() may
+ be sufficent, while the server waits for data to be received.
+
+ However most client subclasses, further functionality will generally be
+ required in their connection_made() to transmit client message.
"""
- logging.info("Connection received!")
+ logging.info("Connection made!")
writer = IPAWriter(transport, IPA_STREAM_OSMO, IPA_OSMO_GSUP)
- self._gsup_manager = gsup.GSUPManager(self._gsm_processor, writer)
+ self._gsup_manager = gsup.GSUPManager(self._gsup_callback, writer)
writer = IPAWriter(transport, IPA_STREAM_CCM)
self._ccm_manager = IPAConnectionManager(writer)
+ writer = IPAWriter(transport, IPA_STREAM_OSMO, IPA_OSMO_CTRL)
+ self._ctrl_manager = OsmoCtrlManager(self._ctrl_callback, writer)
+
def data_received(self, data):
"""
Append the 'data' bytes to the readbuf, and parse the message
@@ -83,6 +109,11 @@ def data_received(self, data):
Unparsed bytes will be left in readbuf and will be parsed when
more data is received in the future.
+ Strips away outer headers of the IPA packet:
+ - payload length
+ - IPA Stream ID
+ - converts remainder of packet into a memoryview object
+
Args:
data (bytes): new data read from the transport
Returns:
@@ -98,16 +129,17 @@ def data_received(self, data):
while remain >= IPA_HEADER_LEN:
# Parse the header
- (payload_len, stream) = struct.unpack_from('!HB', memview, begin)
+ (payload_len, ipa_stream_id) = struct.unpack_from('!HB', memview, begin)
msg_len = IPA_HEADER_LEN + payload_len
if remain < msg_len:
# Need more data for the payload
return
# Handle the IPA message
- payload = memview[begin + IPA_HEADER_LEN:begin + msg_len]
+ payload = memview[(begin + IPA_HEADER_LEN):(begin + msg_len)]
try:
- self._handle_ipa_msg(payload_len, stream, payload)
+ self._handle_ipa_msg(payload_len, ipa_stream_id, payload)
+
except Exception as exc: # pylint: disable=broad-except
# Handle any exceptions with message handling, without
# affecting other messages/users
@@ -120,6 +152,7 @@ def data_received(self, data):
# Get the unparsed bytes
self._readbuf = bytearray(memview[begin:])
+ @abstractmethod
def connection_lost(self, exc):
"""
The IPA connection has been lost.
@@ -129,36 +162,115 @@ def connection_lost(self, exc):
Returns:
None
"""
- logging.warning("Connection lost!")
- self._gsup_manager = None
- self._ccm_manager = None
+ if exc:
+ logging.warning("Connection lost, Exception: {}".format(exc))
+ else:
+ logging.info("Closing connection")
+
def _handle_ipa_msg(self, length, stream_id, payload):
"""
- Handle the payload of an IPA message. This would be
- called after a full IPA message is received.
+ Handle the payload of an IPA message, strips away a header
+ and sends the remainder of the packet to the respective manager:
+ based the IPA Stream ID, and IPA Osmo Extenstions where appropriate.
+
+ This would be called after a full IPA message is received.
+
+ Strips away headers of the IPA packet:
+ - IPA Osmo extension
Args:
length (int): length of the payload
stream_id (int): IPA stream id
- payload (bytes): the underlying message
+ payload (memoryview): the underlying message
Returns:
None
"""
- if stream_id == IPA_STREAM_CCM: # IPA Connection Management
+ if stream_id == IPA_STREAM_CCM and self._ccm_manager is not None:
self._ccm_manager.handle_msg(payload)
return
- elif stream_id == IPA_STREAM_OSMO: # Osmo extensions
- if payload[0] == IPA_OSMO_GSUP: # GSUP msgs
+ elif stream_id == IPA_STREAM_OSMO:
+ if payload[0] == IPA_OSMO_GSUP and self._gsup_manager is not None:
self._gsup_manager.handle_msg(payload[1:])
return
- elif payload[0] == IPA_OSMO_OAP: # OAP msgs
+ elif payload[0] == IPA_OSMO_OAP:
logging.debug("OAP message received")
return
+ elif payload[0] == IPA_OSMO_CTRL and self._ctrl_manager is not None:
+ self._ctrl_manager.handle_msg(payload[1:])
+ return
+
+ raise RuntimeError("Unhandled IPA msg: length: %d, stream_id: %d, "
+ "payload: %s", length, stream_id,
+ bytearray(payload).decode("utf-8"))
+
+
+class OsmoIPAServer(OsmoIPAccessProtocol):
+
+ """
+ Handle the new IPA connection as a server.
+
+ Currently server supports GSUP, and CCM protocols.
+
+ Two steps are required to start the server, first use the event loop to create
+ a new server object using this protocol class and hostname / socket to listen on.
+ Because create_server() returns a coroutine (generator in case of python 3.4),
+ the OsmoIPAServer process will begin only after the loop is started on the coroutine
+ with a command like: `run_until_complete`
+
+ An example of this is in `osmocom_hlr`:
+ ```
+ loop = asyncio.get_event_loop()
+
+ ipa_server = functools.partial(OsmoIPAServer, processor)
+ server_coro = loop.create_server(ipa_server, '0.0.0.0', 2222)
+ server = loop.run_until_complete(server_coro)
+ ````
+ """
+ def __init__(self, gsup_callback=None):
+ super().__init__(gsup_callback=gsup_callback)
+
+ def connection_lost(self, exc):
+ super().connection_lost(exc)
+ self._gsup_manager = None
+ self._ccm_manager = None
+
+
+class OsmoIPAClient(OsmoIPAccessProtocol):
+
+ """
+ Handle the new IPA connection as a client.
- logging.warning("Unhandled IPA msg: length: %d, stream_id: %d, "
- "payload: %s", length, stream_id,
- payload.decode("utf-8"))
+ Two steps are required to start the client, first use the event loop to create
+ a new connection object using this protocol class and hostname / socket to send to,
+ as well as the message to send.
+
+ Because create_connection() returns a coroutine (generator in case of python 3.4),
+ the OsmoIPAClient process will begin only after the loop is started on the coroutine
+ with a command like: `run_until_complete`
+
+ An example of this is in `osmocom_ctrl`:
+
+
+ ```
+ loop = asyncio.get_event_loop()
+ ...
+ ctrl_client = functools.partial(OsmoCtrlClient, msg, callback)
+ client_coro = loop.create_connection(ctrl_client, HOST, PORT)
+
+ try:
+ _, protocol = loop.run_until_complete(client_coro)
+ finally:
+ protocol.connection_lost(exc=None)
+ ````
+ """
+
+ def __init__(self, ctrl_callback=None):
+ super().__init__(ctrl_callback=ctrl_callback)
+
+ def connection_lost(self, exc):
+ super().connection_lost(exc)
+ self._ctrl_manager = None
class IPAWriter:
@@ -173,7 +285,7 @@ def __init__(self, transport, stream_id, osmo_extn=None):
self._stream_id = stream_id
self._osmo_extn = osmo_extn
self._header_len = IPA_HEADER_LEN
- if self._osmo_extn: # occupies one more byte
+ if self._osmo_extn is not None: # occupies one more byte
self._header_len += 1
def get_write_buf(self, length):
@@ -202,7 +314,7 @@ def reset_length(self, buf, length):
Returns:
None
"""
- if self._osmo_extn:
+ if self._osmo_extn is not None: # Ctrl extn is 0x00
struct.pack_into('!HBB', buf, 0, length + 1,
self._stream_id, self._osmo_extn)
else:
@@ -219,6 +331,9 @@ class IPAConnectionManager:
Class to perform connection management operations.
We might need to run a timer and proactively perform Pings if needed.
+ Reference:
+ - http://ftp.osmocom.org/docs/latest/osmobts-abis.pdf
+
IPA CCM (Connection Management):
Offset Length Field
@@ -254,3 +369,87 @@ def send_pong(self):
(buf, offset) = self._ipa_writer.get_write_buf(1)
buf[offset] = IPA_CCM_PONG
self._ipa_writer.write(buf)
+
+
+class OsmoCtrlManager:
+
+ """
+ Class to perform management for the CTRL interface (which is
+ exposed at the various layers of the Osmocom GSM stack).
+
+ References:
+ - http://ftp.osmocom.org/docs/latest/*-usermanual.pdf
+ i.e.
+ - http://ftp.osmocom.org/docs/latest/osmobsc-usermanual.pdf
+
+ An example CTRL packets look at follows:
+ b'\x00\x0e\xee\x00SET 14686 mnc 2
+
+ - x00\x0e : payload length
+ - xee : IPA_STREAM_OSMO header
+ - x00 : IPA_OSMO_CTRL header extension
+ - SET : GET, SET or TRAP command
+ - 14686 : unique message ID
+ - mnc : variable being set
+ - 2 : value variable is being set to
+ """
+
+ def __init__(self, ctrl_callback=None, ipa_writer=None):
+ self._ipa_writer = ipa_writer
+ self._ctrl_callback = ctrl_callback
+
+ def handle_msg(self, payload):
+ """
+ Handle the Ctrl messages.
+
+ Args:
+ payload (memoryview): payload of IPA Ctrl message
+ - packet minus IPA Straem ID and Osmo extension headers
+ request_id (int): random id that was associated client's request
+
+ Returns:
+ None
+
+ Prints:
+ response (dict): variable value pairs from contents of the msg
+ """
+ (msg_type, msg_id, msg) = bytearray(payload).split(None, 2)
+ msg_id = int(msg_id)
+ response = {'msg_type': msg_type.decode('utf-8'), 'id': msg_id}
+ if response['msg_type'] == "ERROR":
+ response['error'] = msg.decode('utf-8')
+
+ else:
+ split = msg.split(None, 1)
+ response['var'] = split[0].decode('utf-8')
+ if len(split) > 1:
+ response['val'] = split[1].decode('utf-8')
+ else:
+ response['val'] = None
+
+ self._ctrl_callback.process_response(response)
+
+ @staticmethod
+ def generate_msg(var, val=None):
+ """
+ Generate SET/GET command message: returns (msg_id, cmd).
+ """
+ msg_id = random.randint(10000, 20000)
+ if val is not None:
+ return msg_id, "%s %s %s %s" % (SET_CMD, msg_id, var, val)
+ return msg_id, "%s %s %s" % (GET_CMD, msg_id, var)
+
+ def generate_packet(self, message):
+ """
+ Encodes and sends the message to the IPA layer.
+ """
+ buf_size = len(message)
+ # offset accounts for header_len
+ (buf, offset) = self._ipa_writer.get_write_buf(buf_size)
+
+ msg_byte_list = memoryview(bytearray(message.encode('utf-8'))).tolist()
+ for i, byte in enumerate(msg_byte_list):
+ buf[offset+i] = byte
+
+ # Write the encoded msg
+ self._ipa_writer.write(buf)
diff --git a/osmocom-python/osmocom/osmocom_ctrl.py b/osmocom-python/osmocom/osmocom_ctrl.py
new file mode 100755
index 00000000..b54b8235
--- /dev/null
+++ b/osmocom-python/osmocom/osmocom_ctrl.py
@@ -0,0 +1,246 @@
+#!/usr/bin/env python3
+"""
+Copyright (c) 2016-present, Facebook, Inc.
+All rights reserved.
+
+This source code is licensed under the BSD-style license found in the
+LICENSE file in the root directory of this source tree. An additional grant
+of patent rights can be found in the PATENTS file in the same directory.
+"""
+import argparse
+import asyncio
+import functools
+import logging
+import sys
+import warnings
+
+from .gsup.protocols.ipa import OsmoIPAClient, OsmoCtrlManager
+
+
+# IPA Constants and References
+# References:
+# - http://ftp.osmocom.org/docs/latest/osmobts-abis.pdf
+# - http://ftp.osmocom.org/docs/latest/osmobsc-usermanual.pdf
+
+# IPA ports
+TCP_PORT_NITB = 4249
+
+# Script globals
+HOST = '127.0.0.1'
+PORT = TCP_PORT_NITB
+SERVER_ADDRESS = (HOST, PORT)
+
+
+def main():
+ """
+ `osmocom_ctrl.py` expose the new Osmocom Ctrl interface to SET/GET state
+ on an actively running instance of the Osmocom GSM stack. This can be used
+ instead of the VTY interface for programatic access to config.
+
+ Reccomended usage (access to help menu with further details)
+ in `osmocom-python` call `PYTHONASYNCIODEBUG=1 python3 -m osmocom.osmocom_ctrl -h`
+
+ Open: Plan for how to pass on results. Currently response is returned to main
+ function
+ """
+ logging.basicConfig(format='%(asctime)s %(levelname)s: %(message)s',
+ stream=sys.stdout, level=logging.DEBUG)
+ # Report all mistakes managing asynchronous resources.
+ warnings.simplefilter('always', ResourceWarning)
+
+ args = parse_args()
+ if args.set:
+ var, value = args.set
+ if args.get:
+ var, = args.get
+ value = None
+
+ if args.trap:
+ var = value = msg = msg_id = None
+
+ output = open(args.outfile, 'w+') if args.outfile else sys.stdout
+
+ # Initialize event loop.
+ loop = asyncio.get_event_loop()
+
+ # Use OsmoCtrlManager's methods to generate msg and msg_id for GET/SET requests
+ if not args.trap:
+ (msg_id, msg) = OsmoCtrlManager.generate_msg(var, value)
+
+ # CtrlProcessor callback instance called by the OsmoCtrlClient (via OsmoCtrlManager)
+ processor_cb = CtrlProcessor(msg_id)
+
+ # Future instance to use to signal that the client is done
+ client_completed = asyncio.Future()
+
+ # Wrapping protocol class because event loop can notaccept extra arguments.
+ ctrl_client = functools.partial(OsmoCtrlClient, msg,
+ future=client_completed,
+ callback=processor_cb)
+
+ # Protocol class, msg, future, and callback passed to the event loop to create
+ # the connection.
+ client_coro = loop.create_connection(ctrl_client, HOST, PORT)
+
+ logging.info('waiting for client to complete')
+ try:
+ # Event loop called once for initiating the OsmoCtrlClient protocol
+ loop.run_until_complete(client_coro)
+
+ # Display response from GET/SET request or from TRAP
+ response = processor_cb.response
+ print('\nResponse for {} request, var: {}, val: {}\n'.format(response['msg_type'],
+ response['var'], response['val']), file=output)
+
+ # Called again to run until the protocol defined by OsmoCtrlClient has completed
+ loop.run_until_complete(client_completed)
+
+ finally:
+ logging.debug('closing from main()')
+ loop.close()
+
+
+def parse_args():
+ parser = argparse.ArgumentParser(
+ description='Access to GET/SET/TRAP variables in running osmocom GSM stack through CLI.\
+ Refer to manual for exposed variables: \
+ http://ftp.osmocom.org/docs/latest/*-usermanual.pdf, \
+ i.e. http://ftp.osmocom.org/docs/latest/osmobsc-usermanual.pdf')
+ parser.add_argument(
+ "-s", "--set",
+ nargs=2,
+ default=None,
+ help="SET ")
+ parser.add_argument(
+ "-g", "--get",
+ nargs=1,
+ default=None,
+ help="GET ")
+ parser.add_argument(
+ "-t", "--trap",
+ action='store_true',
+ default=False,
+ help="TRAP")
+ parser.add_argument(
+ "-o", "--outfile",
+ type=str,
+ default=None,
+ help="outfile ")
+
+ if len(sys.argv) == 1:
+ parser.print_help()
+ sys.exit(1)
+ args = parser.parse_args()
+ return args
+
+
+class CtrlProcessor:
+
+ """
+ Interface for the CTRL protocol to interact with other parts of CCM.
+
+ Curren: only deals with errors.
+
+ Open:
+ - add interface such as gRPC for interaction with other CCM components.
+ """
+
+ def __init__(self, msg_id):
+ self.request_id = msg_id
+
+ def process_response(self, response):
+ """ Interface to application layer processing of Osmo CTRL responses"""
+ self.response = response # enabling callback access to attribute
+ if self.request_id == response['id']:
+ if response['msg_type'] == "ERROR":
+ raise OsmoCtrlError('Request id: {}, returned error response: {}'.
+ format(response['id'], response['error']))
+ else:
+ raise MsgIdError('Mismatch between response message id: {} \
+ and request message id: {}.'\
+ .format(response['id'], self.request_id))
+
+
+class OsmoCtrlClient(OsmoIPAClient):
+ """
+ Ctrl ports:
+ L4 protocol |Port Number| Purpose | Software
+ ----------------------------------------------------------------------------
+ TCP | 4249 | Control interface | osmo-nitb, osmo-bsc
+ TCP | 4250 | Control interface | osmo-bsc_nat
+ TCP | 4251 | Control interface | osmo-sgsn
+ TCP | 4255 | Control interface | osmo-msc
+ TCP | 4257 | Control interface | ggsn (OpenGGSN)
+ TCP | 4259 | Control interface | osmo-hlr
+ """
+ def __init__(self, message, future, callback=None):
+ super().__init__(ctrl_callback=callback)
+ self.future = future
+ self.message = message
+ self.trap = not bool(self.message) # TRAP request have no message
+
+ def connection_made(self, transport):
+ """
+ Establish the new IPA connection as a client
+
+ Args:
+ transport (asynio.Transport): the transport for the new connection
+ Returns:
+ None
+ """
+ super().connection_made(transport)
+ self.transport = transport
+ self.address = self.transport.get_extra_info('peername')
+ logging.debug('connecting to {} port {}'.format(*self.address))
+ if self.message is not None:
+ self._ctrl_manager.generate_packet(self.message)
+
+ def data_received(self, data):
+ """
+ Close transport as required by protocol
+
+ CTRL protocol doesn't specify an End of File (eof) nor does the
+ server necesarily close after communication terminates. TRAP
+ communication maintains an open connection, while GET/SET terminate
+
+ Args:
+ data (bytes): new data read from the transport
+ Returns:
+ None
+ """
+ super().data_received(data)
+ if not self.trap:
+ self.transport.close()
+
+ def connection_lost(self, exc):
+ """
+ The IPA connection has been lost.
+
+ Args:
+ exc: exception object or None if EOF
+ Returns:
+ None
+ """
+ if not self.future.done():
+ self.future.set_result(True)
+ self._ctrl_manager = None
+ super().connection_lost(exc) # rare case of calling super() after cleaning up locally
+
+
+class Error(Exception):
+ """Base class for exceptions in this module."""
+ pass
+
+
+class MsgIdError(Error):
+ """Error when response_id from Osmo stack doesn't match request_id"""
+ pass
+
+
+class OsmoCtrlError(Error):
+ """Error message returned from Osmo stack"""
+ pass
+
+
+if __name__ == '__main__':
+ main()
diff --git a/osmocom-python/scripts/osmocom_hlr b/osmocom-python/scripts/osmocom_hlr
index 0ae88200..2810582f 100755
--- a/osmocom-python/scripts/osmocom_hlr
+++ b/osmocom-python/scripts/osmocom_hlr
@@ -9,17 +9,18 @@ of patent rights can be found in the PATENTS file in the same directory.
"""
import asyncio
+import functools
import logging
from osmocom.gsup.processor import Processor
-from osmocom.gsup.protocols.ipa import OsmoIPAccessProtocol
+from osmocom.gsup.protocols.ipa import OsmoIPAServer
from osmocom.gsup.store.sqlite import SqliteStore
def main():
""" main() for subscriberdb """
- logging.basicConfig(level=logging.DEBUG)
-
+ logging.basicConfig(level=logging.INFO)
+
# Initialize a store to keep all subscriber data.
store = SqliteStore('file::memory:?cache=shared')
@@ -28,18 +29,22 @@ def main():
loop = asyncio.get_event_loop()
# Setup the listening interfaces and protocols for subscriberdb.
- ipa_server = loop.create_server(
- lambda: OsmoIPAccessProtocol(processor),
- '0.0.0.0', 2222)
- loop.run_until_complete(ipa_server)
+ ipa_server = functools.partial(OsmoIPAServer, processor)
+ server_coro = loop.create_server(ipa_server, '0.0.0.0', 2222)
+ server = loop.run_until_complete(server_coro)
# Run the service loop
logging.info("Starting server.")
- loop.run_forever()
+ try:
+ loop.run_forever()
+ except KeyboardInterrupt:
+ pass
+
# Cleanup the service
- ipa_server.stop(0)
- loop.stop()
+ server.close()
+ loop.run_until_complete(server.wait_closed())
+ loop.close()
if __name__ == "__main__":
diff --git a/osmocom-python/tests/gsup/protocols/protocol_tests.py b/osmocom-python/tests/gsup/protocols/protocol_tests.py
index 8d789359..a9d65d9a 100644
--- a/osmocom-python/tests/gsup/protocols/protocol_tests.py
+++ b/osmocom-python/tests/gsup/protocols/protocol_tests.py
@@ -8,11 +8,12 @@
"""
import asyncio
+import functools
import unittest
-
from unittest.mock import Mock
-from osmocom.gsup.protocols.ipa import OsmoIPAccessProtocol
+from osmocom.gsup.protocols.ipa import OsmoCtrlManager, OsmoIPAServer
+from osmocom.osmocom_ctrl import OsmoCtrlClient, CtrlProcessor, MsgIdError, OsmoCtrlError
class IPATests(unittest.TestCase):
@@ -21,7 +22,7 @@ class IPATests(unittest.TestCase):
"""
def setUp(self):
- self._ipa = OsmoIPAccessProtocol(None)
+ self._ipa = OsmoIPAServer(None)
# Mock the writes to check responses
self._writes = Mock()
@@ -76,6 +77,104 @@ def test_ignore_unknown(self):
# Check that we still get Pong when Ping is sent
self._check_ping()
+ def test_bad_header(self):
+ """
+ Test a packet with fake/bad header gets caught.
+ """
+ self.length = 30
+ self.stream_id = 'bad_id'
+ self.payload = memoryview(b'\x00\x00\x00\x00')
+ self.assertRaises(RuntimeError, self._ipa._handle_ipa_msg,
+ self.length, self.stream_id, self.payload)
+
+
+class OsmoCtrlClientTests(unittest.TestCase):
+ """
+ Test class specific to osmo IPA client protocols
+ """
+
+ def setUp(self):
+ self.mock = Mock()
+ self.mock.message = 'message'
+ self._client_completed = asyncio.Future()
+ self._ctrl_client = functools.partial(OsmoCtrlClient, self.mock.message,
+ future=self._client_completed)
+
+ def test_client_completed(self):
+ """ test connection_lost() completes the client"""
+ self.assertEquals(self._client_completed.done(), False)
+ self._ctrl_client().connection_lost(None)
+ self.assertEquals(self._client_completed.done(), True)
+
+
+class CtrlProcessorTests(unittest.TestCase):
+ """
+ Test class for Osmo CTRL processor
+ """
+ def setUp(self):
+ self.request_id = 12345
+ self._ctrl_processor = CtrlProcessor(self.request_id)
+
+ def test_bad_request_id(self):
+ """ testing mismatch between request/response ids"""
+ response = {'id': 11111}
+ self.assertRaises(MsgIdError, self._ctrl_processor.process_response, response)
+
+ def test_handle_error_response(self):
+ """ testing handling of error message from Osmo stack"""
+ response = {'id': self.request_id,
+ 'msg_type': "ERROR",
+ 'error': b'Read Only attribute'}
+ self.assertRaises(OsmoCtrlError, self._ctrl_processor.process_response, response)
+
+
+class OsmoCtrlManagerTests(unittest.TestCase):
+ """
+ Test class for Osmo CTRL manager
+ """
+
+ def setUp(self):
+ self.mock = Mock()
+ self._ctrl_manager = OsmoCtrlManager(self.mock.ipa_writer)
+
+ def test_generate_msg_set(self):
+ """ testing the generation of a Ctrl SET message"""
+ self.mock.variable = 'mcc'
+ self.mock.value = 600
+ _, self.cmd = self._ctrl_manager.generate_msg(self.mock.variable,
+ self.mock.value)
+ responses = self._process_msg(self.cmd)
+ self.assertEquals(responses['action'], 'SET')
+ self.assertEquals(responses['value'], '600')
+ self.assertEquals(responses['var'], 'mcc')
+
+ def test_generate_msg_get(self):
+ """ testing the generation of a Ctrl GET message"""
+ self.mock.variable = 'mcc'
+ self.mock.value = None
+ _, self.cmd = self._ctrl_manager.generate_msg(self.mock.variable,
+ self.mock.value)
+ responses = self._process_msg(self.cmd)
+ self.assertEquals(responses['action'], 'GET')
+ self.assertEquals(responses['value'], None)
+ self.assertEquals(responses['var'], 'mcc')
+
+ @staticmethod
+ def _process_msg(data):
+ """returns the contents of an IPA Osmo Ctrl command as dict of str's"""
+ (action, msg_id, msg) = data.split(None, 2)
+ msg_id = int(msg_id)
+ response = {'action': action, 'id': msg_id}
+ if action == "ERROR":
+ response['error'] = msg
+ else:
+ split = msg.split(None, 1)
+ response['var'] = split[0]
+ if len(split) > 1:
+ response['value'] = split[1]
+ else:
+ response['value'] = None
+ return response
if __name__ == "__main__":
unittest.main()