| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame^] | 1 | == Managing Subscribers |
| 2 | |
| 3 | Subscribers are kept in a local SQLite database file and can be managed via VTY |
| 4 | and CTRL interfaces. |
| 5 | |
| 6 | See this section for some examples, and also refer to the OsmoHLR VTY reference |
| 7 | manual <<vty-ref-osmohlr>> as well as the Control interface described in |
| 8 | <<hlr-ctrl>>. |
| 9 | |
| 10 | === Example: Add/Update/Delete Subscriber via VTY |
| 11 | |
| 12 | The following telnet VTY session adds a subscriber complete with 2G and 3G |
| 13 | authentication tokens, and finally removes the subscriber again; it assumes |
| 14 | that osmo-hlr is running and listening for telnet VTY connections on localhost: |
| 15 | |
| 16 | ---- |
| 17 | $ telnet localhost 4258 |
| 18 | include::../example_subscriber_add_update_delete.vty[] |
| 19 | ---- |
| 20 | |
| 21 | [[subscriber-params]] |
| 22 | === Subscriber Parameters |
| 23 | |
| 24 | The following parameters are managed for each subscriber of the HLR, modelled |
| 25 | roughly after 3GPP TS 23.008, version 13.3.0; note that not all of these |
| 26 | parameters are necessarily in active use: |
| 27 | |
| 28 | .OsmoHLR's subscriber parameters |
| 29 | [options="header",width="100%",cols="20%,20%,60%"] |
| 30 | |=== |
| 31 | |Name|Example|Description |
| 32 | |imsi|901700000014701|identity of the SIM/USIM, 3GPP TS 23.008 chapter 2.1.1.1 |
| 33 | |msisdn|2342123|number to dial to reach this subscriber (multiple MSISDNs can be stored per subscriber), 3GPP TS 23.008 chapter 2.1.2 |
| 34 | |imeisv|4234234234234275|identity of the mobile device and software version, 3GPP TS 23.008 chapter 2.2.3 |
| 35 | |aud2g.algo|comp128v3|Authentication algorithm ID for 2G, corresponds to enum osmo_auth_algo |
| 36 | |aud2g.ki||Subscriber's secret key (128bit) |
| 37 | |aud3g.algo|milenage|Authentication algorithm ID for 3G and UMTS AKA, corresponds to enum osmo_auth_algo |
| 38 | |aud3g.k|(32 hexadecimal digits)|Subscriber's secret key (128bit) |
| 39 | |aud3g.op|(32 hexadecimal digits)|Operator's secret key (128bit) |
| 40 | |aud3g.opc|(32 hexadecimal digits)|Secret key derived from OP and K (128bit), alternative to using OP which does not disclose OP to subscribers |
| 41 | |aud3g.sqn|123|Sequence number of last used key (64bit unsigned) |
| 42 | |aud3g.ind_bitlen|5|Nr of index bits at lower SQN end |
| 43 | |apn|| |
| 44 | |vlr_number||3GPP TS 23.008 chapter 2.4.5 |
| 45 | |hlr_number||3GPP TS 23.008 chapter 2.4.6 |
| 46 | |sgsn_number||3GPP TS 23.008 chapter 2.4.8.1 |
| 47 | |sgsn_address||3GPP TS 23.008 chapter 2.13.10 |
| 48 | |ggsn_number||3GPP TS 23.008 chapter 2.4.8.2 |
| 49 | |gmlc_number||3GPP TS 23.008 chapter 2.4.9.2 |
| 50 | |smsc_number||3GPP TS 23.008 chapter 2.4.23 |
| 51 | |periodic_lu_tmr||3GPP TS 23.008 chapter 2.4.24 |
| 52 | |periodic_rau_tau_tmr||3GPP TS 23.008 chapter 2.13.115 |
| 53 | |nam_cs|1|Enable/disable voice access (3GPP TS 23.008 chapter 2.1.1.2: network access mode) |
| 54 | |nam_ps|0|Enable/disable data access (3GPP TS 23.008 chapter 2.1.1.2: network access mode) |
| 55 | |lmsi||3GPP TS 23.008 chapter 2.1.8 |
| 56 | |ms_purged_cs|0|3GPP TS 23.008 chapter 2.7.5 |
| 57 | |ms_purged_ps|1|3GPP TS 23.008 chapter 2.7.6 |
| 58 | |=== |
| 59 | |