Cellular Network Infrastructure » Core Network (CN) » osmo-sip-connector

h1. Osmo-sip-connector

{{>toc}}

h2. Introduction

osmo-sip-connector translates between MNCC and SIP protocols and hereby replaces the old LCR based approach. Osmo-sip-connector does not handle RTP by itself, an external SIP-PBX server which can accept SIP-Trunks is still required. The following image illustrates how the network components are laid out:

h2. osmo-sip-connector with [[OsmoNITB:]]

{{graphviz_link()

digraph G{

  "osmo-sip-connector" [color="red"];

  rankdir = LR;

  MS -> BTS [label = "Um"];

  BTS -> "osmo-nitb" [label = "Abis"];

  "osmo-nitb" -> "osmo-sip-connector" [label = "MNCC"];

  "osmo-sip-connector" -> "PBX" [label = "SIP"];

  "BTS" -> "PBX" [label = "RTP"];

}

}}

h2. osmo-sip-connector with [[OsmoBSC:]] and [[OsmoMSC:]]

{{graphviz_link()

digraph G{

  rankdir = LR;

  "osmo-sip-connector" [color="red"];

  OsmoMGWB [label="OsmoMGW\n(BSC)"];

  OsmoMGWM [label="OsmoMGW\n(MSC)"];

  MS -> BTS [label = "Um"];

  BTS -> OsmoBSC [label = "Abis"];

  OsmoBSC -> OsmoMSC [label = "AoIP" ];

  OsmoMSC -> "osmo-sip-connector" [label = "MNCC"];

  "osmo-sip-connector" -> "PBX" [label = "SIP"];

  BTS -> OsmoMGWB [label = "RTP"];

  OsmoMGWB -> OsmoMGWM [label = "RTP"];

  OsmoMGWM -> "PBX" [label = "RTP"];

  OsmoBSC -> OsmoMGWB [label = "MGCP" ];

  OsmoMSC -> OsmoMGWM [label = "MGCP" ];

  { rank = same; OsmoBSC; OsmoMGWB; }

  { rank = same; OsmoMSC; OsmoMGWM; }

}

}}

{{include(cellular-infrastructure:MacroBinaryPackages)}}

h2. Manuals

Unfortunately, contrary to other Osmocom network elements, there is no user manual available yet at http://ftp.osmocom.org/docs/latest/

h2. Source code

The source code is available from @git.osmocom.org@ (module @osmo-sip-connector@).

Public read-only access is available via

<pre>

git clone git://git.osmocom.org/osmo-sip-connector.git

</pre>

You can browse it via cgit:  https://git.osmocom.org/osmo-sip-connector

Contributions are welcome via [[Cellular Infrastructure:Gerrit]].

h2. Howto

This howto was created and tested using Debian 8.7.1. It is assumed, that a working installation of osmo-nitb already exists. In the following steps we will show how to integrate that existing installation with Asterisk using osmo-sip-connector.

Note: All configuration files discussed below can also be found in the attachement section

h3. Preparations

As we assume that we use an existing and working osmo-nitb configuration as a starting point most of the relevant dependencies are already installed. However, we still miss osmo-sip-connector and Asterisk as a major components.

* Install dependancies:

The extension we are about to make requires to install some additional packages.

<pre>

sudo apt-get install libsofia-sip-ua-glib-dev

sudo apt-get install asterisk

</pre>

* Install osmo-sip-connector:

The installation of osmo-sip-connector is as straight forward as you know it already from other osmocom projects:

<pre>

git clone git://git.osmocom.org/osmo-sip-connector.git

cd osmo-sip-connector/

autoreconf -fi

./configure

make

sudo make install

</pre>

h3. Osmo-sip-connector configuration

In this section we illustrate how equip osmo-nitb with a SIP-trunk interface using osmo-sip-connector. The steps are not necessarly Asterisk dependant, the result would work with any PBX software that supports sip-trunk connections.

* Osmo-nitb:

Osmo-nitb does not require any change of of its configuration. The connection between osmo-sip-connector is configured using the command line option “-M”:

<pre>

osmo-nitb -c ./openbsc.cfg -d option –debug=DRLL:DCC:DMM:DRR:DRSL:DNM -M /tmp/bsc_mncc

</pre>

The “-M” option disables the internal call control handler of osmo-nitb and offers an unix domain socket, where an external call control handler can be connected. In the described situation this will be osmo-sip-connector.

* osmo-sip-connector:

Osmo-sip connector acts as a translator between the classic ISDN call control (mncc) and SIP. The configuration is rather simple.

<pre>

app

mncc

  socket-path /tmp/bsc_mncc

sip

  local 10.9.1.110 5069

  remote 10.9.1.110 5060

</pre>

Again, we have to setup a socket path. This path has to be the same as we provided with the commandline option “-M” for osmo-nitb earlier. For SIP we need to setup a remote and local IP-Address and port. In most cases, Asterisk and osmo-sip-connector will run on one and the same machine, so it is ovious that local and remote IP-Address are the same. The type of connection between osmo-sip-connector and Asterisk is a classic SIP-Trunk. For Asterisk it appears as just another PBX. Osmo-sip-connector is started via commandline as follows:

<pre>

osmo-sip-connector -c ./osmo-sip-connector.cfg

</pre>

h3. Asterisk configuration

The following section will discuss a minimal Asterisk configuration that is able to route calls between mobile phones. The described case assumes a freshly installed Asterisk with virgin configuration files. In the following we will edit extensions.conf and sip.conf which can be found in the /etc/asterisk directory. The example below is not special to GSM, its rather a normal SIP-trunk configuration.

* Set up the sip-trunk towards osmo-sip-connector:

The first that has to be taken care of is the connection to osmo-sip-connector. The following lines need be appended to sip.conf:

<pre>

[GSM]

type=friend

host=10.9.1.110

dtmfmode=rfc2833

canreinvite=no

disallow=all

allow=gsm

context=gsmsubscriber

port=5069

</pre>

The connection is named GSM, this name will be used later to reference the connection when routing outgoing calls. The context name “gsmsubscriber” references the context where mobile originated calls are routed into the dialplan.

* Set up a dialplan to route calls:

Now Asterisk and osmo-sip-connector are connected. The following example introduces a very basic dialplan configuration to route calls between mobile phones. The following example can be added to extensions.conf:

<pre>

[gsmsubscriber]

exten=>_XXXXX,1,Dial(SIP/GSM/${EXTEN})

exten=>_XXXXX,n,Playback(vm-nobodyavail)

exten=>_XXXXX,n,HangUp

</pre>

The name in “[]” is the context name which we already defined in sip.conf (“gsmsubscriber”). Every incoming call, that is entering through the “GSM” connection is directly routet to “[gsmsubscriber]”. The following three lines will check if the dialed number is exactly 5 digits long. When the check passes Asterisk dials that number through the “GSM” connection. This causes the call to be routed back through the “GSM” connection back to osmo-nitb. If the subscriber is not available, the call will fail and alternatively a voice message “vm-nobodyavail” will be played. Finally the call is hung up.

Note: In this example configuration security considerations are left out. It is up to the user to make sure that the SIP-Trunk interface is not reachable for unauthorized users. 

h3. Use Kamailio as an alternative to Asterisk

As already mentioned above it is also possible to use other SIP-PBX server than Astersik. One popular example is Kamailio. The attached kamailio.cfg matches the osmo-sip-connector configuration and conditions discussed above.

The configuration implements a SIP server which can be used to route calls between mobile phones. It also handles 2 special numbers 500 (routed to sip:music@iptel.org) and 600 (routed to sip:echo@iptel.org): by dialing them you can use echo test or hear nice music from your mobile.

*Note:* in attached kamailio.cfg, for 64bit systems, you may need to adjust

<pre>

mpath="/usr/lib/x86_64-linux-gnu/kamailio/modules/"

</pre>

N. B: Those numbers are meant only as an example for quick tests - please consider running your own Asterisk instance if you expect more than couple of calls, do not abuse http://www.iptel.org/service

See also https://www.kamailio.org

h2. Attachements