blob: 45802caec34ecf85896f486898cbf75f6ea9d53d [file] [log] [blame]
Neels Hofmeyr25dd7852017-09-25 16:37:34 +02001[[overview]]
2== Overview
3
4This manual should help you getting started with OsmoHLR. It will cover
5aspects of configuring and running the OsmoHLR.
6
7[[intro_overview]]
8=== About OsmoHLR
9
10OsmoHLR is Osmocom's minimal implementation of a Home Location Register (HLR)
11for 2G and 3G GSM and UMTS mobile core networks. Its interfaces are:
12
13- GSUP, serving towards OsmoMSC and OsmoSGSN;
14- A local SQLite database;
15- The Osmocom typical telnet VTY and CTRL interfaces.
16
17Originally, the OpenBSC project's OsmoNITB all-in-one implementation had an
18integrated HLR, managing subscribers and SMS in the same local database. Along
19with the separate OsmoMSC and its new VLR component, OsmoHLR was implemented
20from scratch to alleviate various shortcomings of the internal HLR:
21
22- The separate HLR allows using centralized subscriber management for both
23 circuit-switched and packet-switched domains (i.e. one OsmoHLR for both
24 OsmoMSC and OsmoSGSN).
25
26- VLR and HLR brought full UMTS AKA (Authentication and Key Agreement) support,
27 i.e. Milenage authentication in both the full 3G variant as well as the
28 backwards compatible 2G variant.
29
30- In contrast to the OsmoNITB, the specific way the new OsmoMSC's VLR accesses
31 OsmoHLR brings fully asynchronous subscriber database access.
32
33Find the OsmoHLR issue tracker and wiki online at
34
35- https://osmocom.org/projects/osmo-hlr
36- https://osmocom.org/projects/osmo-hlr/wiki
37
38
39[[fig-gsm]]
40.Typical GSM network architecture used with OsmoHLR
41[graphviz]
42----
43digraph G {
44 rankdir=LR;
45 subgraph cluster_hlr {
46 label = "OsmoHLR";
47 GSUP [label="GSUP server"]
48 DB [label="SQLite DB"]
49 GSUP->DB
50 DB->CTRL [dir="back"]
51 DB->VTY [dir="back"]
52 }
53
54 Admin [label="Admin and\nMaintenance"]
55 SW [label="3rd party software\nintegration"]
56 VTY->Admin [dir="back"]
57 CTRL->SW [dir="back"]
58
59 MSC [label="MSC/VLR"]
60 MSC->GSUP [label="GSUP"]
61 SGSN->GSUP [label="GSUP"]
62
63 BSC->MSC
64 HNBGW->MSC
65 HNBGW->SGSN
66 PCU->SGSN
67}
68----
69