Project

General

Profile

Osmocom Network In The Box » History » Version 137

neels, 12/14/2018 01:28 PM

1 1 neels
h1. Osmocom Network In The Box
2 126 fixeria
3
{{>toc}}
4 1 neels
5 22 neels
This is a brief guide to the most basic and minimal setup of an Osmocom 2G and/or 3G network for voice and data services. It is a good starting point for newcomers to familiarize with the software, and to expand upon by the [[Osmocom Manuals]] and other wiki pages.
6 21 neels
7 68 neels
h1. OsmoNITB R.I.P., long live the Network In The Box
8 1 neels
9 2 neels
Historically, Osmocom offered the [[OsmoNITB:]] "Network-In-The-Box" as an actual single program. It was a useful simplification at the time, but in 2017, Osmocom have decided to split OsmoNITB into programs more closely resembling traditional network architecture. It is recommended to use the new separate components instead of the OsmoNITB, since active development focus has moved there.
10 1 neels
11 4 neels
It is still very much possible to run a complete Osmocom core network in one "box". For example, a sysmoBTS can run the entire core network on the same hardware that drives the TRX, making it a complete network in actually one single box. At the same time, having separate components also allows scaling to large deployments, with properly distributed load and a central subscriber database.
12 1 neels
13 2 neels
To migrate from OsmoNITB to the new separate programs, see the [[OsmoNITB Migration Guide]].
14
15 68 neels
h1. Part of this Complete Network
16 2 neels
17 32 neels
Assuming that you have your radio hardware ready (a BTS, a femto cell or an SDR driven by osmo-trx), the core network consists of separate programs providing voice/SMS/USSD ("circuit-switched" or CS) and data ("packet-switched" or PS) services.
18 2 neels
19 32 neels
Here is a table of the components you need:
20 1 neels
21 32 neels
|\4. *Required for*  |/3. *Program* |/3. *Description* |
22
|\2. *2G*  |\2. *3G* |
23
| *CS* | *PS* | *CS* | *PS* |
24 92 neels
| ✔ | ✔ | ✔ | ✔ | [[Osmocom Network In The Box#OsmoHLR|OsmoHLR]] | Home Location Register, stores subscriber IMSI, phone number and auth tokens. |
25 99 neels
| ✔ | (1) | ✔ (3) | (1) | [[Osmocom Network In The Box#OsmoMSC|OsmoMSC]] | Mobile Switching Center, handles signalling, i.e. attach/detach of subscribers, call establishment, messaging (SMS and USSD). |
26 92 neels
| ✔ |   | ✔ |   | [[Osmocom Network In The Box#OsmoMGW|OsmoMGW]] | Media Gateway, is instructed by the MSC and/or the BSC to direct RTP streams for active voice calls. |
27
| ✔ | ✔ | ✔ | ✔ | [[Osmocom Network In The Box#OsmoSTP|OsmoSTP]] | Signal Transfer Point, routes SCCP messages between MSC, BSC, HNBGW and for 3G also the SGSN. |
28
| ✔ | (1) |   |   | [[Osmocom Network In The Box#OsmoBSC|OsmoBSC]] | 2G Base Station Controller, manages logical channels and other lower level aspects for one or more 2G BTS; it is technically part of the BSS and not the "core network". |
29
|   |   | ✔ | ✔ | [[Osmocom Network In The Box#OsmoHNBGW|OsmoHNBGW]] | 3G HomeNodeB Gateway, receives the Iuh protocol from a 3G femto cell and forwards to MSC and SGSN by SCCP/M3UA via OsmoSTP. |
30
|   | ✔ (2) |   | ✔ (2) | [[Osmocom Network In The Box#OsmoGGSN|OsmoGGSN]] | Gateway GPRS Support Node, "opens" GTP tunnels received from SGSNs to internet uplink. |
31 99 neels
|   | ✔ |   | ✔ (3) | [[Osmocom Network In The Box#OsmoSGSN|OsmoSGSN]] | Serving GPRS Support Node, handles signalling, i.e. attach/detach of subscribers and PDP contexts. |
32 92 neels
| ✔ | (1) |   |   | [[Osmocom Network In The Box#OsmoBTS|OsmoBTS]] | for 2G networks, drives the TRX and ties to the BSC via Abis-interface. |
33
|   | ✔ |   |   | [[Osmocom Network In The Box#OsmoPCU|OsmoPCU]] | for 2G networks, a component closely tied to the BTS, drives the TRX for PS timeslots and ties to the SGSN via Gb-interface. |
34 37 neels
|   |   | ✔ | ✔ | hNodeb | 3rd party 3G femto cell hardware to connect to OsmoHNBGW via Iuh |
35 5 neels
36 99 neels
1: PS is always an _addition_ to CS: even though these components do not handle PS requests, you need to have these to be able to setup and register with a network, which is a prerequisite for data services. That is mostly due to policy by the mobile phones, theoretically they could accept a network without voice service.
37 1 neels
38 32 neels
2: For the GGSN to successfully route packets to an internet uplink, it needs a tun device set up and usually IP masquerading/forwarding enabled. Please refer to the OsmoGGSN manual for more details.
39 99 neels
40
3: If building from source, remember to build with --enable-iu. (Our binary packages are built with --enable-iu.)
41 18 neels
42 68 neels
h2. Topology
43 55 neels
44
{{graphviz_link()
45
digraph G {
46
  rankdir = LR;
47 56 neels
  
48
  MS [label="MS\n(2G phone)"]
49
  UE [label="UE\n(3G phone)"]
50 1 neels
51 56 neels
  subgraph cluster_bts {
52
    BTS [rank="min"]
53
    PCU [rank="min"]
54
  }
55
56
  subgraph cluster_msc_mgw {
57 59 neels
    label=MGCP;style=dotted
58 56 neels
    MSC
59 57 neels
    MGW1 [label="MGW"]
60 56 neels
  }
61
62
  subgraph cluster_bsc_mgw {
63 59 neels
    label=MGCP;style=dotted
64 56 neels
    BSC
65 57 neels
    MGW2 [label="MGW"]
66 1 neels
  }
67
68 59 neels
  hNodeB [shape="box",label="hNodeB\n(3G femto cell)"]
69
70 61 neels
  MS -> BTS [label="Um"]
71 65 neels
  MS -> PCU [style="dashed"]
72 60 neels
 
73 56 neels
  BTS -> BSC [label="Abis/IP"]
74
  STP [label="STP\n(SCCP/M3UA)"]
75
  BSC -> STP -> MSC [label="A"]
76 70 neels
  MSC -> HLR [label="GSUP"]
77
  SGSN -> HLR [label="GSUP",style="dashed"]
78 62 neels
  UE -> hNodeB [label="Uu"]
79 65 neels
  UE -> hNodeB [style="dashed"]
80 56 neels
  hNodeB -> HNBGW [label="Iuh"]
81 1 neels
  HNBGW -> STP -> SGSN [label="IuPS",style="dashed"]
82 104 neels
  HNBGW -> STP -> MSC [label="IuCS"]
83 61 neels
  PCU -> SGSN [label="Gb",style="dashed"]
84 58 neels
  SGSN -> GGSN [label="GTP-C",style="dashed"]
85
  SGSN -> GGSN [label="GTP-U(2G)",style="dashed"]
86
  hNodeB -> GGSN [label="GTP-U(3G)",style="dashed"]
87
  GGSN -> internet [label="tun",style="dashed"]
88 56 neels
89 73 neels
  BTS -> MGW2 -> MGW1 [label="RTP"]
90 59 neels
  MGW1 -> MGW1 [label="RTP"]
91 1 neels
  hNodeB -> MGW1 [label="IuUP/RTP"]
92 59 neels
93
  A, B, C, D [style="invisible"]
94 63 neels
  A -> B [label="data (PS)",style="dashed"]
95 103 neels
  C -> D [label="voice/SMS/USSD (CS)"]
96 56 neels
97 55 neels
}
98
}}
99
100 5 neels
h1. Have to Know
101 10 neels
102
Each program features a detailed [[Osmocom Manuals|user manual]], your primary source of information to expand on the setup described here.
103 24 laforge
104 5 neels
Osmocom offers [[Binary_Packages|compiled packages for various distributions]]. If you're up to it, you may also [[Build from Source]].
105
106
Each Osmocom program typically has
107
108 1 neels
* a distinct configuration file;
109 25 neels
* a VTY telnet console for live interaction;
110 1 neels
* a CTRL interface for live interaction from 3rd party programs.
111 18 neels
112 102 neels
See [[Port Numbers]] to find out which program runs what services on which port.
113 18 neels
114
h1. Configuration Examples
115 5 neels
116 83 neels
Here is a tarball of the config files discussed below: attachment:nitb.tar
117
118 6 neels
h2. OsmoHLR
119
120 127 neels
[[OsmoHLR:]] is the Home Location Register: it stores subscriber IMSI, phone number and auth tokens. This is where you configure who is allowed on your network and who has which phone number. It also handles USSD services (like "*100#").
121 67 neels
122 72 neels
osmo-hlr will automatically bootstrap an empty subscriber database. See the [[Osmocom Manuals|manual]] on how to add one or more subscribers -- if you don't know your IMSI, it can be useful to attempt a connection and watch the OsmoHLR log for a rejected IMSI. To migrate subscribers from an older OsmoNITB database, see the [[OsmoNITB migration guide]].
123 6 neels
124 50 neels
While you do need one, your configuration file may actually remain empty. This will serve GSUP on localhost (127.0.0.1), sufficient for a Network In The Box with MSC and SGSN on the same machine as the HLR.
125 1 neels
126 127 neels
This example optionally configures two USSD services and logging.
127
128 1 neels
*osmo-hlr.cfg* (download: attachment:nitb.tar)
129
<pre>
130 127 neels
hlr
131
 ussd route prefix *#100# internal own-msisdn
132
 ussd route prefix *#101# internal own-imsi
133
134
log stderr
135
 logging filter all 1
136
 logging print extended-timestamp 1
137
 logging print category 1
138
 logging print category-hex 0
139
 logging print level 1
140
 logging print file basename last
141 128 neels
 logging level set-all debug
142 48 neels
</pre>
143
144 97 neels
Once your HLR is running, you will want to add subscribers with authentication keys to the HLR database. Please refer to the OsmoHLR [[Osmocom Manuals]], section "Managing Subscribers".
145
146 6 neels
h2. OsmoMSC
147 1 neels
148 93 neels
[[OsmoMSC:]] is the Mobile Switching Center: it handles signalling, i.e. attach/detach of subscribers, call establishment, messaging (SMS and USSD). The OsmoMSC is your central "manager" of the network.
149 66 neels
150 6 neels
The VLR component of OsmoMSC needs to connect to the OsmoHLR's GSUP server to know which subscribers are authorized. By default, it will connect to OsmoHLR on localhost, no explicit config needed.
151 26 neels
152 6 neels
To be reachable by OsmoBSC and OsmoHNBGW, OsmoMSC needs an SCCP point code, and it needs to connect to OsmoSTP to make itself known to SCCP routing.
153 7 neels
154 86 neels
* There is a default point code, currently 0.23.1 (in 8.8.3 point code format, see [[Point Codes]]).
155 6 neels
* OsmoMSC will by default look for OsmoSTP on localhost's M3UA port, 2905.
156 7 neels
157 51 neels
To direct RTP streams, OsmoMSC needs an OsmoMGW instance (see OsmoMGW below).
158 38 neels
159 51 neels
You only need to set up your MCC, MNC, and how to reach/use the MGW.
160 43 neels
161 108 neels
*osmo-msc.cfg* (download: attachment:nitb.tar)
162 1 neels
<pre>
163 38 neels
network
164
 network country code 901
165 53 neels
 mobile network code 70
166
msc
167 1 neels
 mgw remote-ip 192.168.0.9
168 134 neels
 # For nano3G:
169
 iu rab-assign-addr-enc x213
170 128 neels
 
171
log stderr
172
 logging filter all 1
173
 logging print extended-timestamp 1
174
 logging print category 1
175 1 neels
 logging print category-hex 0
176 134 neels
 logging print level 1
177 128 neels
 logging print file basename last
178
 logging level set-all info
179 38 neels
</pre>
180 47 neels
181 1 neels
h2. OsmoMGW
182
183 93 neels
[[OsmoMGW:]] is the Media Gateway: it is instructed by the MSC and/or the BSC to direct RTP streams for active voice calls. The Media Gateway receives instructions in the form of MGCP messages from OsmoMSC/OsmoBSC. It forwards RTP streams directly between BTS, femto cells and remote endpoints, e.g. other MGW instances, and its job is to transcode between codecs (future).
184 52 neels
185 47 neels
You need an OsmoMGW to serve OsmoMSC's MGCP requests, and an OsmoMGW to serve OsmoBSC's MGCP requests. In fact, these two can be served by one single OsmoMGW instance. If you would like to keep two separate OsmoMGW instances, you need to take care that they don't attempt to bind to identical ports on the same IP address (for MGCP, but also for VTY and CTRL interfaces).
186
187
Consider that you have a 2G network with an external BTS (say a sysmoBTS), which means that you need your OsmoBSC's MGW instance to be reachable on a public interface. So far the MSC's MGW can be on a local loopback interface, it only needs to be reachable by the BSC's MGW and by the MSC.
188
189
If you also have a 3G femto cell, then the MSC's MGW instance also needs to be on a public interface. At this point you either need two public interface addresses, or you need to put one of the MGWs on a different MGCP port.
190
191 105 neels
You may decide to use one OsmoMGW for both BSC and MSC, if your network topology allows.
192
(There used to be the need to separate the endpoint config for BSC and MSC, but now the MGW takes care of that automatically.)
193 47 neels
194 105 neels
To increase the likelihood that your first setup will work out, below examples pick distinct MGCP ports and VTY interfaces, which allows running two MGWs on the same public IP address.
195 47 neels
196
h3. OsmoMGW for OsmoMSC
197 1 neels
198 101 neels
OsmoMGW listens for MGCP connections, by default on port 2427.
199
200 1 neels
* In a setup that truly runs in one box (e.g. sysmoBTS or osmo-trx with co-located core network), this may be localhost (127.0.0.1), which is the default, and your config file may omit the 'bind ip'.
201 9 neels
* With a separate BTS and/or RNC (e.g. 3G femto cell or nanoBTS), make sure to configure an IP address that is reachable by the hNodeB and BTS:
202 1 neels
203 108 neels
*osmo-mgw-for-msc.cfg* (download: attachment:nitb.tar)
204 48 neels
<pre>
205 82 neels
mgcp
206 40 neels
 bind ip 192.168.0.9
207 82 neels
line vty
208 1 neels
 bind 127.0.0.1
209 129 neels
 
210
log stderr
211
 logging filter all 1
212
 logging print extended-timestamp 1
213
 logging print category 1
214
 logging print category-hex 0
215
 logging print level 1
216
 logging print file basename last
217
 logging level set-all info
218 1 neels
</pre>
219
220 47 neels
h3. OsmoMGW for OsmoBSC
221 1 neels
222 130 neels
OsmoBSC also requires an OsmoMGW instance to run alongside it. In a setup where OsmoBSC and OsmoMSC can both reach it directly, they may in fact share the same OsmoMGW instance (endpoints are allocated dynamically).
223 1 neels
224 124 neels
It is semantically more clear to run a separate OsmoMGW instance for the OsmoBSC. When running on the same machine, though, then each MGW obviously needs to use different UDP ports, for example:
225 1 neels
226 108 neels
*osmo-mgw-for-bsc.cfg* (download: attachment:nitb.tar)
227 1 neels
<pre>
228 40 neels
mgcp
229 82 neels
 bind ip 192.168.0.9
230 47 neels
 # default port is 2427 (is used for MSC's MGW)
231
 bind port 12427
232 41 neels
line vty
233 1 neels
 # default VTY interface is on 127.0.0.1 (used for MSC's MGW)
234
 bind 127.0.0.2
235 130 neels
236
log stderr
237
 logging filter all 1
238
 logging print extended-timestamp 1
239
 logging print category 1
240
 logging print category-hex 0
241
 logging print level 1
242
 logging print file basename last
243
 logging level set-all info
244
245 1 neels
</pre>
246 40 neels
247 130 neels
Note that osmo-bsc.cfg below sets the 'mgw remote-port' to the 'bind port' configured here; if the MGWs run on distinct interfaces, the default ports will do in both cases.
248 1 neels
249 9 neels
h2. OsmoSTP
250
251 131 neels
[[OsmoSTP:]] is the Signal Transfer Point; think of it like a network switch that quietly routes messages between components, for the SS7 system. You almost never need to look at its logging or configuration.
252 1 neels
253 131 neels
OsmoSTP acts as a server for routing SCCP messages. OsmoMSC, OsmoBSC, OsmoHNBGW and OsmoSGSN contact OsmoSTP and announce their own point code, after which they may instruct OsmoSTP to route SCCP messages to each other by these point codes.
254
255 9 neels
The basic configuration that permits dynamic routing is:
256
257 108 neels
*osmo-stp.cfg* (download: attachment:nitb.tar)
258 9 neels
<pre>
259
cs7 instance 0
260
 xua rkm routing-key-allocation dynamic-permitted
261
 listen m3ua 2905
262 1 neels
  accept-asp-connections dynamic-permitted
263 131 neels
264
log stderr
265
 logging filter all 1
266
 logging print extended-timestamp 1
267
 logging print category 1
268
 logging print category-hex 0
269
 logging print level 1
270
 logging print file basename last
271
 logging level set-all info
272 11 neels
</pre>
273 1 neels
274
h2. OsmoBSC
275 11 neels
276 93 neels
[[OsmoBSC:]] is the 2G Base Station Controller: it manages logical channels and other lower level aspects for one or more 2G BTS. The BSC tells the MSC what the phones would like to do, and in turn the MSC tells the BSC to establish channels, page phones, and take care of the lower level BTS maintenance.
277 67 neels
278 87 neels
OsmoBSC needs to register with OsmoSTP, and contact the MSC by its point code. If not configured otherwise, it will use OsmoMSC's default point code to contact it, see [[Point Codes]].
279 11 neels
280 132 neels
OsmoBSC needs to contact an OsmoMGW on its MGCP port, to manage RTP streams between BTS and the MSC's MGW, as discussed above under "OsmoMGW".
281 42 neels
282 132 neels
OsmoBSC also needs complete configuration of all connected BTS -- usually the BTS side configures the phy, unit id and the BSC's remote address, and the BSC configures everything else over OML. This example shows configuration for a sysmoBTS.
283 15 neels
284
Furthermore, some network properties need to be set.
285 1 neels
286 132 neels
The 'gprs mode' determines whether packet switched access will be enabled. 'gprs mode none' switches off data services, it tells osmo-bts not to contact osmo-pcu to establish data service. Note that if you set 'gprs mode gprs' but fail to provide a working PCU, a phone may oscillate between BTS cells to try to establish GPRS service.
287 15 neels
288 83 neels
To allow data service, set a 'gprs mode gprs' or 'gprs mode egprs', and configure PDCH timeslots. Traditionally, a fixed amount of TCH timeslots for voice and PDCH timeslots for data service are configured. OsmoBTS also supports two types of dynamic timeslots, as described in the "Abis manual":http://ftp.osmocom.org/docs/latest/osmobts-abis.pdf, chapter "Dynamic Channel Combinations". The following is a configuration with voice-and-data service based on Osmocom style dynamic timeslots:
289 15 neels
290 108 neels
*osmo-bsc.cfg* for voice and data service (download: attachment:nitb.tar)
291 48 neels
<pre>
292 75 neels
network
293
 network country code 901
294 1 neels
 mobile network code 70
295 75 neels
 bts 0
296 1 neels
  type sysmobts
297 75 neels
  band GSM-1800
298 1 neels
  location_area_code 23
299 132 neels
  # This is the unit id that has to match the BTS configuration
300 75 neels
  ip.access unit_id 1800 0
301 132 neels
  codec-support fr hr amr
302 75 neels
  gprs mode gprs
303 82 neels
  gprs nsvc 0 remote ip 192.168.0.9
304 75 neels
  gprs nsvc 0 remote udp port 23000
305
  gprs nsvc 0 local udp port 23000
306
  gprs nsvc 0 nsvci 1800
307
  gprs nsei 1800
308
  gprs cell bvci 1800
309
  trx 0
310
   rf_locked 0
311
   arfcn 868
312
   nominal power 23
313
   timeslot 0
314
    phys_chan_config CCCH+SDCCH4
315
   timeslot 1
316
    phys_chan_config SDCCH8
317
   timeslot 2
318
    phys_chan_config TCH/F_TCH/H_PDCH
319
   timeslot 3
320 1 neels
    phys_chan_config TCH/F_TCH/H_PDCH
321 75 neels
   timeslot 4
322
    phys_chan_config TCH/F_TCH/H_PDCH
323
   timeslot 5
324
    phys_chan_config TCH/F_TCH/H_PDCH
325
   timeslot 6
326
    phys_chan_config TCH/F_TCH/H_PDCH
327
   timeslot 7
328
    phys_chan_config PDCH
329
e1_input
330 1 neels
 e1_line 0 driver ipa
331 75 neels
msc 0
332 82 neels
 mgw remote-ip 192.168.0.9
333 1 neels
 mgw remote-port 12427
334
 allow-emergency deny
335
 codec-list hr3
336 132 neels
337
log stderr
338
 logging filter all 1
339
 logging print extended-timestamp 1
340
 logging print category 1
341
 logging print category-hex 0
342
 logging print level 1
343
 logging print file basename last
344
 logging level set-all info
345 1 neels
</pre>
346
347
h2. OsmoHNBGW
348
349 93 neels
[[OsmoHNBGW:]] is the 3G HomeNodeB Gateway, found in the osmo-iuh.git repository: it receives the Iuh protocol from a 3G femto cell, separates it into IuCS and IuPS and forwards to the MSC and SGSN.
350 1 neels
351 89 neels
OsmoHNBGW needs to connect to OsmoSTP for routing, and needs to know the MSC and SGSN point codes. If omitted, it assumes OsmoSTP on 127.0.0.1 and uses the point codes that are default in OsmoMSC and OsmoSGSN, see [[Point Codes]].
352 1 neels
353
It must also be reachable by the hNodeB, hence its Iuh must typically run on a public IP, not a loopback address like 127.0.0.1.
354
355 108 neels
*osmo-hnbgw.cfg* (download: attachment:nitb.tar)
356 1 neels
<pre>
357 82 neels
hnbgw
358
 iuh
359
  local-ip 192.168.0.9
360 133 neels
 
361
log stderr
362
 logging filter all 1
363
 logging print extended-timestamp 1
364
 logging print category 1
365
 logging print category-hex 0
366
 logging print level 1
367
 logging print file basename last
368
 logging level set-all info
369 1 neels
</pre>
370
371 133 neels
*NOTE:* For the nano3G, the MSC must encode X.213 style addresses in the RAB assignment, see osmo-msc.cfg, 'iu rab-assign-addr-enc x213'.
372 96 neels
373 133 neels
*NOTE:* To connect your femto cell to the HNBGW, see for example [[Configuring_the_ipaccess_nano3G]]
374 1 neels
375 98 neels
*NOTE:* The 'hnbap-allow-tmsi' option is just a workaround for the nano3G passing a TMSI as UE-Register identity, which would normally have to be an IMSI.
376 95 neels
377 1 neels
h2. OsmoGGSN
378
379 93 neels
[[OpenGGSN:|OsmoGGSN]] is the Gateway GPRS Support Node: it "opens" GTP tunnels received from SGSNs to internet uplink. To provide packet switched service, OsmoGGSN must offer GTP service to the OsmoSGSN.
380 1 neels
381 135 neels
Notably, both OsmoGGSN and OsmoSGSN must use identical GTP port numbers, which is an intrinsic requirement of the GTP protocol. Hence they must not run on the same IP address. Furthermore, for 2G networks, the SGSN must be reachable by the PCU and thus needs to be on a public interface if the BTS is a separate box; for 3G networks, the GGSN must be reachable by the hNodeB and thus needs to be on a public interface. So, to cover both, you need to have *two* public interfaces; this example uses 192.168.0.42, assumed to be an IP address available on the local ethernet interface.
382 1 neels
383 135 neels
Refer to your distribution on how to configure a second IP address.
384
385
(In an aside, this script would obtain a second address from your DHCP server:
386
387 1 neels
<pre>
388 135 neels
#!/bin/sh
389
# usage: ./second_dhclient.sh eth0
390
dev="${1:-eth0}"
391
nr="$(ip a | grep "^[0-9]*: $dev" | wc -l)"
392
name="$(echo "$dev" | sed 's/[^0-9a-fA-F]//g' | head -c 1)"
393
mac="ac:ac:1a:b0:a0:$name$nr"
394
set -e -x
395
sudo ip link add link $dev address $mac $dev.$nr type macvlan
396
sudo dhclient $dev.$nr
397
ip addr show dev $dev.$nr
398 82 neels
</pre>
399
400 135 neels
For this example to work, the DCHP server would need to assign to you the address 192.168.0.42.)
401 82 neels
402 1 neels
OsmoGGSN maintains a gsn_restart counter, to be able to reliably communicate to the SGSN that it has restarted. This is kept in the 'state-dir', by default in /tmp.
403 13 neels
404 82 neels
It also needs access to a tun device with an address range available to subscribers' PDP contexts. This may be configured ahead of time, so that OsmoGGSN does not need root privileges. If run with 'sudo', OsmoGGSN may also create its own tun device. In below example, the 'apn0' device has been created ahead of time, with:
405 13 neels
406 82 neels
<pre>
407
sudo ip tuntap add dev apn0 mode tun user $USER group $USER
408
sudo ip addr add 192.168.42.0/24 dev apn0
409
sudo ip link set apn0 up
410
</pre>
411
412
IPv4 operation is enabled by default, but for future compatibility, it is good to indicate that explicitly.
413
414 76 neels
OsmoGGSN furthermore indicates DNS servers, as well as an IPv4 address range to assign to subscribers' PDP contexts.
415 13 neels
416 85 neels
Note that the APN named in this config file (here "internet") needs to be configured on your phone, see [[Osmocom Network In The Box#APN-for-Data-Service|APN for Data Service]] below. With the @default-apn@ command, any unknown APN name will use that default APN instead, but still you usually have to define _some_ APN on your phone so that it even tries to connect to the data service.
417 13 neels
418 85 neels
A profound part of GGSN configuration is the network setup of your system: you need to allow the packets to be routed between the subscribers and your internet uplink. See the [[Osmocom Manuals|OsmoGGSN User Manual]], section _Running OsmoGGSN_ / _Routing_.
419 84 neels
420 108 neels
*osmo-ggsn.cfg* (download: attachment:nitb.tar)
421 125 neels
NOTE: this configuration requires the _apn0_ tun device to be configured and up, as well as IP-forwarding and masquerading to be enabled -- please see the manual as indicated above.
422 13 neels
<pre>
423 137 neels
log stderr
424
 logging level all debug
425
 logging filter all 1
426
 logging print category 1
427 13 neels
ggsn ggsn0
428 82 neels
 gtp bind-ip 192.168.0.42
429 1 neels
 apn internet
430
  tun-device apn0
431
  type-support v4
432
  ip dns 0 192.168.0.1
433 137 neels
  ip dns 1 9.9.9.9
434 1 neels
  ip prefix dynamic 192.168.42.0/24
435
  no shutdown
436
 default-apn internet
437
 no shutdown ggsn
438 137 neels
 
439 135 neels
log stderr
440
 logging filter all 1
441
 logging print extended-timestamp 1
442
 logging print category 1
443
 logging print category-hex 0
444
 logging print level 1
445
 logging print file basename last
446
 logging level set-all info
447 14 neels
</pre>
448 67 neels
449
h2. OsmoSGSN
450 14 neels
451 93 neels
[[OsmoSGSN:]] is the Serving GPRS Support Node: it handles signalling, i.e. attach/detach of subscribers and PDP contexts for data services.
452 14 neels
453
OsmoSGSN needs to reach the GGSN to establish GTP tunnels for subscribers. It must have a separate GTP IP address from OsmoGGSN, as mentioned before.
454
455
For 2G, OsmoSGSN needs to be reachable by the PCU, and needs a public IP for the Gb interface if it is not running directly on the BTS hardware (e.g. on sysmoBTS or when using osmo-trx). For 2G operation, SGSN and GGSN may both use a local IP address for GTP, as long as they differ (e.g. 127.0.0.1 and 127.0.0.2).
456
457 136 neels
For 3G, OsmoSGSN needs to be reachable by the HNBGW for IuPS. If you're running _only_ 3G, the SGSN does not need to listen on a public IP address.
458 88 neels
459
For 3G IuPS, the SGSN must sign up at OsmoSTP with a point code that the HNBGW knows. If not configured explicitly, the respective defaults are used, see [[Point Codes]].
460 14 neels
461 136 neels
Finally, OsmoSGSN needs access to OsmoHLR to access subscriber data. Set 'auth-policy remote' to use the HLR for subscriber authorization.
462 1 neels
463 108 neels
*osmo-sgsn.cfg* (download: attachment:nitb.tar)
464 14 neels
<pre>
465 77 neels
sgsn
466 82 neels
 gtp local-ip 192.168.0.9
467
 ggsn 0 remote-ip 192.168.0.42
468 79 neels
 ggsn 0 gtp-version 1
469 14 neels
 auth-policy remote
470 1 neels
 gsup remote-ip 127.0.0.1
471
ns
472
 encapsulation udp local-ip 192.168.0.9
473
 encapsulation udp local-port 23000
474
 encapsulation framerelay-gre enabled 0
475 136 neels
  
476
log stderr
477
 logging filter all 1
478
 logging print extended-timestamp 1
479
 logging print category 1
480
 logging print category-hex 0
481
 logging print level 1
482
 logging print file basename last
483
 logging level set-all info
484 1 neels
</pre>
485
486
The @auth-policy remote@ requires that you have the SIM cards' authentication tokens in your OsmoHLR database. Instead, you can use @auth-policy accept-all@, but be aware that this will only work for 2G. 3G networks _require_ successful authentication, and @auth-policy remote@ is your _only_ option for a 3G SGSN.
487 93 neels
488
h1. OsmoBTS
489
490
[[OsmoBTS:]] operates 2G radio hardware. OsmoBTS supports various hardware platforms including sysmoBTS and USRP. Instead, you may choose BTS vendors like ip.access or Siemens, which can also directly operate with OsmoBSC without OsmoBTS being involved.
491
492
The BTS needs to know where to reach OsmoBSC's Abis interface, and its unit id needs to match one of the BTS unit ids configured at OsmoBSC.
493
494
An example configuration for a sysmoBTS is:
495
496
<pre>
497
phy 0
498
 instance 0
499
bts 0
500
 band 1800
501
 ipa unit-id 1800 0
502
 oml remote-ip 192.168.0.9
503
 trx 0
504
  phy 0 instance 0
505
</pre>
506
507
h1. OsmoPCU
508
509
[[OsmoPCU:]] operates the packet-switched part of 2G radio hardware. Timeslots used for data transmission are controlled by the PCU instead of the BTS. OsmoPCU is typically configured from the @gprs@ config items in OsmoBSC, which is communicated to the PCU via OML and OsmoBTS (via the PCU socket). An example configuration for OsmoPCU would be:
510
511
<pre>
512
pcu
513
 flow-control-interval 10
514
 cs 2
515
 alloc-algorithm dynamic
516
 alpha 0
517
 gamma 0
518
 two-phase-access
519
</pre>
520 17 neels
521
h1. Running Examples
522
523 122 laforge
Each Osmocom program comes with a systemd service file. It is recommended to place config files in @/etc/osmocom/@ and launch the individual components using @systemd@.
524 17 neels
525 122 laforge
When installed from debian or opkg feeds, you will find the systemd service files in @/lib/systemd/system/@.
526 17 neels
527
Re/starting and stopping then works like this:
528
529
<pre>
530 1 neels
systemctl restart osmo-hlr
531
systemctl stop osmo-hlr
532
</pre>
533 36 neels
534
It can be useful to have an @osmo-all@ script to re/start or stop all components at once, edit to pick yours:
535
536
*osmo-all* script
537
<pre>
538
#!/bin/sh
539
cmd="${1:-start}"
540
set -ex
541
systemctl $cmd osmo-hlr osmo-msc osmo-mgw osmo-ggsn osmo-sgsn osmo-stp osmo-bsc osmo-hnbgw osmo-bts-sysmo osmo-pcu 
542
</pre>
543
544
which allows
545
546
<pre>
547 1 neels
./osmo-all restart
548
./osmo-all status
549 36 neels
./osmo-all stop
550
</pre>
551
552 1 neels
For illustration, the manual command invocations for the components would look like this:
553
554
<pre>
555
osmo-hlr -l hlr.db -c osmo-hlr.cfg
556
osmo-msc -c osmo-msc.cfg
557
osmo-mgw -c osmo-mgw-for-msc.cfg
558
osmo-mgw -c osmo-mgw-for-bsc.cfg
559 48 neels
osmo-ggsn -c osmo-ggsn.cfg
560
osmo-sgsn -c osmo-sgsn.cfg
561 36 neels
osmo-stp -c osmo-stp.cfg
562 1 neels
osmo-bsc -c osmo-bsc.cfg
563
osmo-hnbgw -c osmo-hnbgw.cfg
564
# on a 2G sysmoBTS:
565 36 neels
osmo-bts-sysmo -c osmo-bts.cfg -s -M
566
osmo-pcu -c osmo-pcu.cfg
567
</pre>
568 18 neels
569
h1. Logging Examples
570
571
Osmocom programs have a common logging mechanism, configurable by the config files as well as the telnet VTY.
572
573 82 neels
h2. System Logging
574
575 18 neels
Depending on the system's logging configuration, logs may by default be visible in /var/log/daemon.log, or by using journalctl:
576
577 1 neels
<pre>
578
journalctl -f -u osmo-hlr
579
</pre>
580
581
When journalctl is used, it may be necessary to enable it first, e.g. by setting "Storage=volatile" in /etc/systemd/journald.conf followed by a 'systemctl restart systemd-journald'; you may also need to 'systemctl unmask systemd-journald.service systemd-jounald.socket'. Logging will only start appearing for components that were restarted after these changes.
582
583 82 neels
h2. telnet VTY logging
584
585 1 neels
A sure way to see the logs is to connect to the program's telnet VTY and enable logging on the VTY session -- this way you do not modify the application's default logging, but create a separate logging target for your telnet VTY session:
586
587
<pre>
588
$ telnet localhost 4254
589
OsmoMSC> logging enable 
590
OsmoMSC> logging level ?
591
  all      Global setting for all subsystems
592
  rll      A-bis Radio Link Layer (RLL)
593 18 neels
  cc       Layer3 Call Control (CC)
594
  mm       Layer3 Mobility Management (MM)
595
  [...]
596 35 neels
OsmoMSC> logging level all ?
597 19 neels
everything debug      info       notice     error      fatal      
598
OsmoMSC> logging level all debug 
599
OsmoMSC> logging filter all 1
600 1 neels
</pre>
601
602
You will see logging output on your telnet console immediately. Note that the VTY prompt is still listening, so you may at any time issue 'logging filter all 0' to switch off logging, and be able to type commands without being cluttered by ongoing log output.
603
604
h2. stderr logging
605
606
A common configuration you can add to any of the above configuration files to show *all* logging on stderr is:
607
608
<pre>
609
log stderr
610
 logging filter all 1
611
 logging color 1
612
 logging print category 1
613
 logging timestamp 1
614
 logging print extended-timestamp 1
615
 logging level all debug
616
</pre>
617
618
The @filter all 1@ switches on logging, read "do not discard all logging". The amount of logging seen is determined by @logging level ...@ commands, here all categories are set to level @debug@, to show absolutely all logging. You will probably want to refine that.
619 90 neels
620
h1. Point Codes
621
622
If you'd like to configure non-default point-codes, see this example for OsmoHNBGW on the general approach:
623
624
<pre>
625
cs7 instance 0
626
 # HNBGW's local point code
627
 point-code 0.23.5
628
 # Address book entries, used below
629
 sccp-address my_msc
630
  point-code 0.23.1
631
 sccp-address my_sgsn
632
  point-code 0.23.4
633
hnbgw
634
 iucs
635
  remote-addr my_msc
636
 iups
637
  remote-addr my_sgsn
638
</pre>
639 76 neels
640
h1. Troubleshooting
641
642
h2. APN for Data Service
643
644
For the data service to work, phones generally need an APN added to their
645
configuration, or they will not even attempt to establish a data connection.
646
The APN should match the name configured in osmo-ggsn.conf.
647
648
The APN configuration steps are usually similar to:
649
650
* Navigate to APN settings:
651
** 'Settings'
652
** 'Wireless & Networks'
653
** 'Mobile networks'
654
** 'Access Point Names'
655
* You should see the list of APNs (possibly empty)
656
* Press the Menu button
657
* Choose 'New APN'
658
* Enter values for 'Name' as well as 'APN'
659
* Again press the Menu button
660
* Choose 'Save'
661
* The APN should now appear in the list of APNs.
662 1 neels
* Possibly tap the bullet icon to select the APN as default.
663 116 duo_kali
.
664 117 duo_kali
665 110 duo_kali
</pre>
Add picture from clipboard (Maximum size: 48.8 MB)