blob: 62eddf3712f8f46db5f887ee0a3645de0146decd [file] [log] [blame]
Harald Weltea49e36e2018-01-21 19:29:33 +01001module BSC_ConnectionHandler {
2
3import from General_Types all;
4import from Osmocom_Types all;
Harald Welteb71901a2018-01-26 19:16:05 +01005import from Native_Functions all;
Harald Weltea49e36e2018-01-21 19:29:33 +01006import from GSM_Types all;
Harald Welteb71901a2018-01-26 19:16:05 +01007import from IPL4asp_Types all;
Harald Weltea49e36e2018-01-21 19:29:33 +01008import from SCCPasp_Types all;
9import from BSSAP_Types all;
10import from BSSMAP_Emulation all;
11import from BSSMAP_Templates all;
12
13import from GSUP_Types all;
14import from GSUP_Emulation all;
15
16import from MNCC_Types all;
17import from MNCC_Emulation all;
18
Harald Welte4aa970c2018-01-26 10:38:09 +010019import from MGCP_Types all;
20import from MGCP_Emulation all;
Harald Welteb71901a2018-01-26 19:16:05 +010021import from MGCP_Templates all;
22import from SDP_Types all;
Harald Welte4aa970c2018-01-26 10:38:09 +010023
Harald Weltea49e36e2018-01-21 19:29:33 +010024import from MobileL3_Types all;
25import from MobileL3_CommonIE_Types all;
26import from MobileL3_MM_Types all;
Harald Welteb71901a2018-01-26 19:16:05 +010027import from MobileL3_CC_Types all;
Harald Weltea49e36e2018-01-21 19:29:33 +010028import from L3_Templates all;
Harald Welte158a7ca2018-02-16 18:11:31 +010029import from L3_Common all;
Harald Weltea49e36e2018-01-21 19:29:33 +010030
31/* this component represents a single subscriber connection */
Harald Welte4aa970c2018-01-26 10:38:09 +010032type component BSC_ConnHdlr extends BSSAP_ConnHdlr, MNCC_ConnHdlr, GSUP_ConnHdlr, MGCP_ConnHdlr {
Harald Weltea49e36e2018-01-21 19:29:33 +010033 var BSC_ConnHdlrPars g_pars;
Harald Weltea10db902018-01-27 12:44:49 +010034 timer g_Tguard := 60.0;
Harald Weltea49e36e2018-01-21 19:29:33 +010035}
36
Harald Weltede371492018-01-27 23:44:41 +010037type record BSC_ConnHdlrNetworkPars {
38 OCT1 kc_support,
39 boolean expect_tmsi,
40 boolean expect_auth,
41 boolean expect_ciph
42}
43
Harald Weltea49e36e2018-01-21 19:29:33 +010044type record BSC_ConnHdlrPars {
45 SCCP_PAR_Address sccp_addr_own,
46 SCCP_PAR_Address sccp_addr_peer,
47 BSSMAP_IE_CellIdentifier cell_id,
Harald Welte256571e2018-01-24 18:47:19 +010048 hexstring imei,
Harald Weltea49e36e2018-01-21 19:29:33 +010049 hexstring imsi,
Harald Welte82600572018-01-21 20:54:08 +010050 hexstring msisdn,
Harald Welte256571e2018-01-24 18:47:19 +010051 OCT4 tmsi optional,
Harald Welte9de84792018-01-28 01:06:35 +010052 MobileStationClassmark1_V cm1,
Harald Welte82600572018-01-21 20:54:08 +010053 BSSMAP_IE_ClassmarkInformationType2 cm2,
Harald Welte16114282018-01-24 22:41:21 +010054 BSSMAP_IE_ClassmarkInformationType3 cm3 optional,
Harald Weltede371492018-01-27 23:44:41 +010055 AuthVector vec optional,
Neels Hofmeyrc1f105a2018-03-01 20:00:19 +010056 BSC_ConnHdlrNetworkPars net,
57 boolean send_early_cm
Harald Weltea49e36e2018-01-21 19:29:33 +010058};
59
Harald Welte9de84792018-01-28 01:06:35 +010060/* get a one-octet bitmaks of supported algorithms based on Classmark information */
61function f_alg_mask_from_cm(BSSMAP_IE_ClassmarkInformationType2 cm2) return OCT1 {
62 var BIT8 res := '00000001'B; /* A5/0 always supported */
63
64 if (cm2.a5_1 == '0'B) {
65 res := res or4b '00000010'B;
66 }
67 if (cm2.classmarkInformationType2_oct5.a5_2 == '1'B ) {
68 res := res or4b '00000100'B;
69 }
70 if (cm2.classmarkInformationType2_oct5.a5_3 == '1'B) {
71 res := res or4b '00001000'B;
72 }
73 /* TODO: CM3 for A5/4 and beyond */
74 return bit2oct(res);
75}
76
77/* determine the best algorithm available within the bit-mask */
78function f_best_alg_from_mask(OCT1 alg_in) return OCT1 {
79 var BIT8 alg := oct2bit(alg_in);
80 var BIT8 ordered_algs[8] := {
81 '10000000'B, '01000000'B, '00100000'B, '00010000'B,
82 '00001000'B, /* A5/3 */
83 '00000010'B, /* A5/1 */
84 '00000100'B, /* A5/2 */
85 '00000001'B /* A5/0 */ }
86 for (var integer i := 0; i < sizeof(ordered_algs); i := i+1) {
87 if (alg and4b ordered_algs[i] != '00000000'B) {
88 return bit2oct(ordered_algs[i]);
89 }
90 }
91 return '00'O;
92}
93
94/* return an integer like '1' for A5/1 based on a mask (with only one bit set */
95function f_alg_from_mask(OCT1 mask_in) return integer {
96 var BIT8 mask := oct2bit(mask_in);
97 for (var integer i := 0; i < 8; i := i+1) {
98 if (mask and4b ('00000001'B << i) != '00000000'B) {
99 return i;
100 }
101 }
102 return -1;
103}
104
Harald Weltea10db902018-01-27 12:44:49 +0100105/* altstep for the global guard timer */
106private altstep as_Tguard() runs on BSC_ConnHdlr {
107 [] g_Tguard.timeout {
Daniel Willmann90829d62018-02-15 17:45:14 +0100108 setverdict(fail, "Tguard timeout");
Harald Weltea10db902018-01-27 12:44:49 +0100109 self.stop;
110 }
111}
112
113/* init function, called as first function in new BSC_ConnHdlr */
Harald Weltead2952e2018-01-27 14:12:46 +0100114function f_init_handler(BSC_ConnHdlrPars pars, float t_guard := 60.0) runs on BSC_ConnHdlr {
Harald Weltea10db902018-01-27 12:44:49 +0100115 /* make parameters available via component variable */
116 g_pars := pars;
117 /* Start guard timer and activate it as default */
Harald Weltead2952e2018-01-27 14:12:46 +0100118 g_Tguard.start(t_guard);
Harald Weltea10db902018-01-27 12:44:49 +0100119 activate(as_Tguard());
120}
121
Harald Weltea49e36e2018-01-21 19:29:33 +0100122
123/* Callback function from general BSSMAP_Emulation whenever a connectionless
124 * BSSMAP message arrives. Canreturn a PDU_BSSAPthat should be sent in return */
125private function BscUnitdataCallback(PDU_BSSAP bssap)
126runs on BSSMAP_Emulation_CT return template PDU_BSSAP {
127 var template PDU_BSSAP resp := omit;
128
129 log("BSSMAP_BscUnitdataCallback");
130 /* answer all RESET with RESET ACK */
131 if (match(bssap, tr_BSSMAP_Reset)){
132 log("BSSMAP_BscUnitdataCallback: Responding to RESET with RESET-ACK");
133 resp := ts_BSSMAP_ResetAck;
134 }
135
136 /* FIXME: Handle paging, etc. */
137 return resp;
138}
139
140const BssmapOps BSC_BssmapOps := {
141 /* Create call-back for inbound connections from MSC (hand-over) */
142 create_cb := refers(BSSMAP_Emulation.ExpectedCreateCallback),
143 unitdata_cb := refers(BscUnitdataCallback),
144 decode_dtap := true,
Harald Weltea4ca4462018-02-09 00:17:14 +0100145 role_ms := true,
146 sccp_addr_local := omit,
147 sccp_addr_peer := omit
Harald Weltea49e36e2018-01-21 19:29:33 +0100148}
149
150
151private function MnccUnitdataCallback(MNCC_PDU mncc)
152runs on MNCC_Emulation_CT return template MNCC_PDU {
153 log("Ignoring MNCC", mncc);
154 return omit;
155}
156
157const MnccOps BCC_MnccOps := {
158 create_cb := refers(MNCC_Emulation.ExpectedCreateCallback),
159 unitdata_cb := refers(MnccUnitdataCallback)
160}
161
162
163
164template BSSAP_Conn_Req ts_BSSAP_Conn_Req(SCCP_PAR_Address peer, SCCP_PAR_Address own, PDU_BSSAP bssap) := {
165 addr_peer := peer,
166 addr_own := own,
167 bssap := bssap
168};
169
Harald Weltea49e36e2018-01-21 19:29:33 +0100170/* Encode 'l3' and ask BSSMAP_Emulation to create new connection with COMPL L3 INFO */
171function f_bssap_compl_l3(PDU_ML3_MS_NW l3)
172runs on BSC_ConnHdlr {
173 log("Sending COMPL L3: ", l3);
174 var octetstring l3_enc := enc_PDU_ML3_MS_NW(l3);
175 BSSAP.send(ts_BSSAP_Conn_Req(g_pars.sccp_addr_peer, g_pars.sccp_addr_own,
176 valueof(ts_BSSMAP_ComplL3(g_pars.cell_id, l3_enc))));
Harald Welte71b69332018-01-21 20:43:53 +0100177 alt {
178 [] BSSAP.receive(BSSAP_Conn_Prim:MSC_CONN_PRIM_CONF_IND) {}
179 [] BSSAP.receive(BSSAP_Conn_Prim:MSC_CONN_PRIM_DISC_IND) {
180 setverdict(fail, "DISC.ind from SCCP");
181 self.stop;
182 }
183 }
Harald Weltea49e36e2018-01-21 19:29:33 +0100184}
185
Harald Welte081b19a2018-02-10 09:11:13 +0100186type enumerated EstablishType {
187 EST_TYPE_MO_CALL,
Harald Welte0bef21e2018-02-10 09:48:23 +0100188 EST_TYPE_EMERG_CALL,
Harald Welte081b19a2018-02-10 09:11:13 +0100189 EST_TYPE_PAG_RESP
190};
191
Harald Weltea49e36e2018-01-21 19:29:33 +0100192/* helper function to fully establish a dedicated channel */
Harald Welte081b19a2018-02-10 09:11:13 +0100193function f_establish_fully(MobileIdentityLV mi, EstablishType etype := EST_TYPE_MO_CALL)
Harald Weltea49e36e2018-01-21 19:29:33 +0100194runs on BSC_ConnHdlr {
Harald Welte081b19a2018-02-10 09:11:13 +0100195 var PDU_ML3_MS_NW l3_info;
196 select (etype) {
197 case (EST_TYPE_MO_CALL) {
198 l3_info := valueof(ts_CM_SERV_REQ(CM_TYPE_MO_CALL, mi));
199 }
Harald Welte0bef21e2018-02-10 09:48:23 +0100200 case (EST_TYPE_EMERG_CALL) {
201 l3_info := valueof(ts_CM_SERV_REQ(CM_TYPE_EMERG_CALL, mi));
202 }
Harald Welte081b19a2018-02-10 09:11:13 +0100203 case (EST_TYPE_PAG_RESP) {
204 l3_info := valueof(ts_PAG_RESP(mi));
205 }
206 }
Harald Weltea49e36e2018-01-21 19:29:33 +0100207
208 /* Send BSSAP_Conn_Req with COMPL L3 INFO to MSC */
209 f_bssap_compl_l3(l3_info);
210
Harald Weltede371492018-01-27 23:44:41 +0100211 f_mm_common();
212 if (g_pars.net.expect_ciph) {
Harald Welte148a7082018-01-26 18:56:43 +0100213 /* implicit CM SERVICE ACCEPT? */
214 } else {
Harald Welte0bef21e2018-02-10 09:48:23 +0100215 if (etype != EST_TYPE_PAG_RESP) {
Harald Welte081b19a2018-02-10 09:11:13 +0100216 /* explicit CM SERVICE ACCEPT */
217 BSSAP.receive(tr_PDU_DTAP_MT(tr_CM_SERV_ACC));
218 }
Harald Weltea49e36e2018-01-21 19:29:33 +0100219 }
Harald Weltea49e36e2018-01-21 19:29:33 +0100220}
221
222/* build a PDU_ML3_MS_NW containing a Location Update by IMSI */
Harald Welte9de84792018-01-28 01:06:35 +0100223function f_build_lu_imsi(hexstring imsi) runs on BSC_ConnHdlr return PDU_ML3_MS_NW
Harald Weltea49e36e2018-01-21 19:29:33 +0100224{
225 var MobileIdentityLV mi := valueof(ts_MI_IMSI_LV(imsi));
226 return f_build_lu(mi);
227}
Harald Welte9de84792018-01-28 01:06:35 +0100228function f_build_lu_imei(hexstring imei) runs on BSC_ConnHdlr return PDU_ML3_MS_NW
Harald Welteba7b6d92018-01-23 21:32:34 +0100229{
230 var MobileIdentityLV mi := valueof(ts_MI_IMEI_LV(imei));
231 return f_build_lu(mi);
232}
Harald Welte9de84792018-01-28 01:06:35 +0100233function f_build_lu_tmsi(OCT4 tmsi) runs on BSC_ConnHdlr return PDU_ML3_MS_NW
Harald Welteba7b6d92018-01-23 21:32:34 +0100234{
235 var MobileIdentityLV mi := valueof(ts_MI_TMSI_LV(tmsi));
236 return f_build_lu(mi);
237}
Harald Welte9de84792018-01-28 01:06:35 +0100238private function f_build_lu(MobileIdentityLV mi) runs on BSC_ConnHdlr return PDU_ML3_MS_NW
Harald Weltea49e36e2018-01-21 19:29:33 +0100239{
240 var LocationAreaIdentification_V old_lai := { '62F220'O, '9999'O };
241 var PDU_ML3_MS_NW l3_info := valueof(ts_ML3_MO_LU_Req(valueof(ts_ML3_IE_LuType_Attach),
Harald Welte9de84792018-01-28 01:06:35 +0100242 old_lai, mi, g_pars.cm1));
Harald Weltea49e36e2018-01-21 19:29:33 +0100243 return l3_info;
244}
245
Harald Welte9de84792018-01-28 01:06:35 +0100246function f_mm_auth() runs on BSC_ConnHdlr
Harald Welte148a7082018-01-26 18:56:43 +0100247{
Harald Weltede371492018-01-27 23:44:41 +0100248 if (g_pars.net.expect_auth) {
Harald Welte148a7082018-01-26 18:56:43 +0100249 g_pars.vec := f_gen_auth_vec_2g();
250 var GSUP_IE auth_tuple := valueof(ts_GSUP_IE_AuthTuple2G(g_pars.vec.rand,
251 g_pars.vec.sres,
252 g_pars.vec.kc));
253 GSUP.receive(tr_GSUP_SAI_REQ(g_pars.imsi));
254 GSUP.send(ts_GSUP_SAI_RES(g_pars.imsi, auth_tuple));
255
256 BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_MM_AUTH_REQ(g_pars.vec.rand)));
257 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MT_MM_AUTH_RESP_2G(g_pars.vec.sres)));
258 }
Harald Welte9de84792018-01-28 01:06:35 +0100259}
Harald Welte148a7082018-01-26 18:56:43 +0100260
Harald Welte9de84792018-01-28 01:06:35 +0100261function f_mm_common() runs on BSC_ConnHdlr
262{
263 f_mm_auth();
Harald Weltede371492018-01-27 23:44:41 +0100264 if (g_pars.net.expect_ciph) {
Harald Welte9de84792018-01-28 01:06:35 +0100265 var OCT1 a5_net := f_alg_mask_from_cm(g_pars.cm2);
266 var OCT1 a5_intersect := g_pars.net.kc_support and4b a5_net;
267 alt {
268 [] BSSAP.receive(tr_BSSMAP_CipherModeCmd(a5_intersect, g_pars.vec.kc)) {
269 var OCT1 a5_chosen := f_best_alg_from_mask(a5_intersect);
270 var integer a5_nr := f_alg_from_mask(a5_chosen);
271 BSSAP.send(ts_BSSMAP_CipherModeCompl(int2oct(a5_nr+1, 1)));
272 }
273 [] BSSAP.receive(tr_BSSMAP_CipherModeCmd(?, g_pars.vec.kc)) {
274 setverdict(fail, "Wrong ciphering algorithm mask in CiphModCmd");
275 self.stop;
276 }
277 }
278 /* FIXME: Send the best available algorithm */
Harald Welte148a7082018-01-26 18:56:43 +0100279 }
280}
281
Neels Hofmeyrc1f105a2018-03-01 20:00:19 +0100282function f_perform_lu()
Harald Weltea49e36e2018-01-21 19:29:33 +0100283runs on BSC_ConnHdlr {
284 var PDU_ML3_MS_NW l3_lu := f_build_lu_imsi(g_pars.imsi)
285 var PDU_DTAP_MT dtap_mt;
286
287 /* tell GSUP dispatcher to send this IMSI to us */
288 f_create_gsup_expect(hex2str(g_pars.imsi));
289
290 /* Send BSSAP_Conn_Req with COMPL L3 INFO to MSC */
291 f_bssap_compl_l3(l3_lu);
292
Neels Hofmeyrc1f105a2018-03-01 20:00:19 +0100293 if (g_pars.send_early_cm) {
Harald Welte8a121b32018-01-22 03:00:41 +0100294 BSSAP.send(ts_BSSMAP_ClassmarkUpd(g_pars.cm2, g_pars.cm3));
295 }
Harald Welte5c2622c2018-01-21 20:45:20 +0100296
Harald Weltede371492018-01-27 23:44:41 +0100297 f_mm_common();
Harald Welte16114282018-01-24 22:41:21 +0100298
Harald Weltea49e36e2018-01-21 19:29:33 +0100299 /* Expect MSC to perform LU with HLR */
300 GSUP.receive(tr_GSUP_UL_REQ(g_pars.imsi));
301 GSUP.send(ts_GSUP_ISD_REQ(g_pars.imsi, g_pars.msisdn));
302 GSUP.receive(tr_GSUP_ISD_RES(g_pars.imsi));
303 GSUP.send(ts_GSUP_UL_RES(g_pars.imsi));
304
305 alt {
306 [] BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_LU_Acc)) -> value dtap_mt {
307 var PDU_ML3_LocationUpdateAccept lu_acc := dtap_mt.dtap.msgs.mm.locationUpdateAccept;
Harald Weltede371492018-01-27 23:44:41 +0100308 if (g_pars.net.expect_tmsi) {
Harald Weltea49e36e2018-01-21 19:29:33 +0100309 if (not ispresent(lu_acc.mobileIdentityTLV) or
310 not ischosen(lu_acc.mobileIdentityTLV.mobileIdentityLV.mobileIdentityV.oddEvenInd_identity.tmsi_ptmsi)) {
311 setverdict(fail, "Expected TMSI but no TMSI was allocated");
312 self.stop;
313 } else {
Harald Welte256571e2018-01-24 18:47:19 +0100314 g_pars.tmsi := lu_acc.mobileIdentityTLV.mobileIdentityLV.mobileIdentityV.oddEvenInd_identity.tmsi_ptmsi.octets;
Harald Weltea49e36e2018-01-21 19:29:33 +0100315 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_TmsiRealloc_Cmpl));
316 }
317 } else {
318 if (ispresent(lu_acc.mobileIdentityTLV) and
319 ischosen(lu_acc.mobileIdentityTLV.mobileIdentityLV.mobileIdentityV.oddEvenInd_identity.tmsi_ptmsi)) {
320 setverdict(fail, "Expected no TMSI but TMSI was allocated");
321 self.stop;
322 }
323 }
324 }
325 [] BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_LU_Rej)) {
326 setverdict(fail, "Expected LU ACK, but received LU REJ");
327 self.stop;
328 }
329 }
330 /* FIXME: there could be pending SMS or other common procedures by the MSC, let's ignore them */
331 BSSAP.receive(tr_BSSMAP_ClearCommand);
332 BSSAP.send(ts_BSSMAP_ClearComplete);
333 BSSAP.receive(BSSAP_Conn_Prim:MSC_CONN_PRIM_DISC_IND);
334 setverdict(pass);
335}
336
337function f_foo() runs on BSC_ConnHdlr{
338 /* SCCP CC handled by BSSMAP_Emulation_CT.main() */
339 /* Expect auth, if enabled */
340
341 /* TODO: ISD */
342 /* Expect encr, if enabled */
343 /* Expect encr, if enabled */
344 /* Expect ASS CMD, if chan_type != requested */
345 /* Send ASS CMPL in successful case */
346
347 /* Expect AoIP port/ip information for RTP stream */
348 /* Expect MSC-originated MGCP to our simulated MGW */
349 /* Verify Counters via CTRL */
350 /* re-configure MSC behaviour via VTY */
351}
352
Harald Welteb71901a2018-01-26 19:16:05 +0100353/* parameters related to a (MO?) voice call */
354type record CallParameters {
Harald Welteb71901a2018-01-26 19:16:05 +0100355 /* CC related parameters */
356 hexstring called_party, /* whom are we calling */
357 integer transaction_id optional, /* which TS 04.08 CC transaction ID to use */
358 BearerCapability_TLV bearer_cap, /* which bearer capabilities to claim */
Harald Welte0bef21e2018-02-10 09:48:23 +0100359 boolean emergency, /* is this an emergency call? */
Harald Welteb71901a2018-01-26 19:16:05 +0100360
361 /* MNCC related parameters */
362 uint32_t mncc_callref optional, /* call reference on the MNCC side */
363 MNCC_bearer_cap mncc_bearer_cap optional, /* MNCC-side bearer capabilities */
364
365 /* RTP related parameters */
366 HostName bss_rtp_ip optional, /* BSS Side RTP IP */
367 PortNumber bss_rtp_port optional, /* BSS Side RTP Port */
368 HostName mss_rtp_ip optional, /* MSS Side RTP IP */
369 PortNumber mss_rtp_port optional, /* MSS Side RTP Port */
Harald Welte4017d552018-01-26 21:40:05 +0100370 HostName mgw_rtp_ip_bss, /* BSS-facing MGW RTP IP */
371 PortNumber mgw_rtp_port_bss, /* BSS-facing MGW RTP Port */
372 HostName mgw_rtp_ip_mss, /* MSS-facing MGW RTP IP */
373 PortNumber mgw_rtp_port_mss, /* MSS-facing MGW RTP Port */
Harald Welteb71901a2018-01-26 19:16:05 +0100374 uint7_t rtp_payload_type, /* dynamic RTP payload type */
375 charstring rtp_sdp_format, /* AMR/8000 or the like */
Philipp Maier2a98a732018-03-19 16:06:12 +0100376 boolean mgw_drop_dlcx optional, /* Provoke errors by not responding to DLCX
377 (f_mt_call and f_mt_call) */
Harald Welteb71901a2018-01-26 19:16:05 +0100378
Philipp Maiercd668572018-03-19 16:11:52 +0100379 MgcpCallId mgcp_call_id optional, /* MGCP Call ID; CallAgent allocated */
Harald Welteb71901a2018-01-26 19:16:05 +0100380 MgcpEndpoint mgcp_ep optional /* MGCP Endpoint, CallAgent or MGW allocated */,
381 MgcpConnectionId mgcp_connection_id_bss, /* MGCP Connection ID BSS Side */
382 MgcpConnectionId mgcp_connection_id_mss /* MGCP Connection ID MSS Side */
383}
384
385template (value) CallParameters t_CallParams(hexstring called, integer tid) := {
Harald Welteb71901a2018-01-26 19:16:05 +0100386 called_party := called,
387 transaction_id := tid,
388 bearer_cap := valueof(ts_Bcap_voice),
Harald Welte0bef21e2018-02-10 09:48:23 +0100389 emergency := false,
Harald Welteb71901a2018-01-26 19:16:05 +0100390 mncc_callref := omit,
391 mncc_bearer_cap := valueof(ts_MNCC_bcap_voice),
Harald Welte4017d552018-01-26 21:40:05 +0100392 bss_rtp_ip := "9.8.7.6",
393 bss_rtp_port := 9000,
Harald Welteb71901a2018-01-26 19:16:05 +0100394 mss_rtp_ip := omit,
395 mss_rtp_port := omit,
Harald Welte4017d552018-01-26 21:40:05 +0100396 mgw_rtp_ip_bss := "1.1.1.1",
397 mgw_rtp_port_bss := 10000,
398 mgw_rtp_ip_mss := "1.1.1.1",
399 mgw_rtp_port_mss := 11000,
Harald Welteb71901a2018-01-26 19:16:05 +0100400 rtp_payload_type := 98,
401 rtp_sdp_format := "AMR/8000",
402 mgcp_call_id := omit,
403 mgcp_ep := omit,
404 mgcp_connection_id_bss := '0'H,//
405 mgcp_connection_id_mss := '0'H //
406};
407
Philipp Maier3716a5e2018-03-21 15:53:35 +0100408function f_mt_call_establish(inout CallParameters cpars)
Harald Welte33ec09b2018-02-10 15:34:46 +0100409runs on BSC_ConnHdlr {
410
411 var MobileIdentityLV mi;
412 var MNCC_PDU mncc;
413 var MgcpCommand mgcp_cmd;
414
415 f_bssmap_register_imsi(g_pars.imsi, g_pars.tmsi);
416
417 /* Allocate a call reference and send SETUP via MNCC to MSC */
418 cpars.mncc_callref := f_rnd_int(2147483648);
419 MNCC.send(ts_MNCC_SETUP_req(cpars.mncc_callref, hex2str(g_pars.msisdn),
420 hex2str(cpars.called_party), hex2str(g_pars.imsi)));
421 /* BSC <- MSC: Expect paging. FIXME: By TMSI or not? */
422 BSSAP.receive(tr_BSSMAP_Paging(g_pars.imsi));
423
424 /* If we have a TMSI, use TMSI instead of IMSI */
425 if (ispresent(g_pars.tmsi)) {
426 mi := valueof(ts_MI_TMSI_LV(g_pars.tmsi));
427 } else {
428 mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
429 }
430 f_establish_fully(mi, EST_TYPE_PAG_RESP);
431
432 /* MS <- MSC: Expect CC SETUP */
433 BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_CC_SETUP(cpars.transaction_id, *, cpars.called_party)));
434
435 /* MS -> MSC: ALERTING */
436 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_CC_ALERTING(cpars.transaction_id)));
437 MNCC.receive(tr_MNCC_ALERT_ind(cpars.mncc_callref));
438
439
440 /* Create MGCP expect */
441 f_create_mgcp_expect(ExpectCriteria:{omit,omit,omit});
442 /* Ask MSC via MNCC to create the RTP socket on the MSC/MGW side */
443 MNCC.send(ts_MNCC_RTP_CREATE(cpars.mncc_callref));
444
445 /* First MGCP CRCX (for BSS/RAN side) */
446 MGCP.receive(tr_CRCX) -> value mgcp_cmd {
447 cpars.mgcp_call_id := f_MgcpCmd_extract_call_id(mgcp_cmd);
Philipp Maier4b2692d2018-03-14 16:37:48 +0100448
449 /* When the endpoint contains a wildcard we keep the endpoint
450 * identifier we have set up in cpars. Otherwise we use the
451 * endpoint name that the call agent has supplied */
452 if (match(mgcp_cmd.line.ep, t_MGCP_EP_wildcard) == false) {
453 cpars.mgcp_ep := mgcp_cmd.line.ep;
454 }
455
Harald Welte33ec09b2018-02-10 15:34:46 +0100456 var SDP_Message sdp := valueof(ts_SDP(cpars.mgw_rtp_ip_bss, cpars.mgw_rtp_ip_bss,
457 hex2str(cpars.mgcp_call_id), "42",
458 cpars.mgw_rtp_port_bss,
459 { int2str(cpars.rtp_payload_type) },
460 { valueof(ts_SDP_rtpmap(cpars.rtp_payload_type,
461 cpars.rtp_sdp_format)),
462 valueof(ts_SDP_ptime(20)) }));
Philipp Maier4b2692d2018-03-14 16:37:48 +0100463 var template MgcpResponse mgcp_resp;
464 mgcp_resp := ts_CRCX_ACK(mgcp_cmd.line.trans_id, cpars.mgcp_connection_id_bss, sdp);
465 f_mgcp_par_append(mgcp_resp.params, ts_MgcpParSpecEP(cpars.mgcp_ep));
466 MGCP.send(mgcp_resp);
Harald Welte33ec09b2018-02-10 15:34:46 +0100467 }
468 /* Second MGCP CRCX (this time for MSS/CN side) */
469 MGCP.receive(tr_CRCX(cpars.mgcp_ep)) -> value mgcp_cmd {
470 var SDP_Message sdp := valueof(ts_SDP(cpars.mgw_rtp_ip_mss, cpars.mgw_rtp_ip_mss,
471 hex2str(cpars.mgcp_call_id), "42",
472 cpars.mgw_rtp_port_mss,
473 { int2str(cpars.rtp_payload_type) },
474 { valueof(ts_SDP_rtpmap(cpars.rtp_payload_type,
475 cpars.rtp_sdp_format)),
476 valueof(ts_SDP_ptime(20)) }));
477 MGCP.send(ts_CRCX_ACK(mgcp_cmd.line.trans_id, cpars.mgcp_connection_id_mss, sdp));
478 /* MSC acknowledges the MNCC_CREATE to the MNCC handler */
479 MNCC.receive(tr_MNCC_RTP_CREATE(cpars.mncc_callref));
480 }
481
482 /* expect the MSC to trigger a BSSMAP ASSIGNMENT */
483 var BSSMAP_IE_AoIP_TransportLayerAddress tla_ass :=
484 valueof(ts_BSSMAP_IE_AoIP_TLA4(f_inet_addr(cpars.mgw_rtp_ip_bss),cpars.mgw_rtp_port_bss));
485 BSSAP.receive(tr_BSSMAP_AssignmentReq(omit, tla_ass)) {
486 var BSSMAP_IE_AoIP_TransportLayerAddress tla;
487 tla := valueof(ts_BSSMAP_IE_AoIP_TLA4(f_inet_addr(cpars.bss_rtp_ip), cpars.bss_rtp_port));
488 BSSAP.send(ts_BSSMAP_AssignmentComplete(omit, tla));
489 }
490
491 /* MS -> MSC: ALERTING */
492 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_CC_CONNECT(cpars.transaction_id)));
493 MNCC.receive(tr_MNCC_SETUP_cnf(cpars.mncc_callref));
494
Harald Welte33ec09b2018-02-10 15:34:46 +0100495 setverdict(pass);
496}
497
Philipp Maier3716a5e2018-03-21 15:53:35 +0100498function f_mo_call_establish(inout CallParameters cpars)
Harald Welteb71901a2018-01-26 19:16:05 +0100499runs on BSC_ConnHdlr {
500
501 var MobileIdentityLV mi;
502 var MNCC_PDU mncc;
503 var MgcpCommand mgcp_cmd;
Philipp Maier2a98a732018-03-19 16:06:12 +0100504 var boolean respond_to_dlcx;
Harald Welteb71901a2018-01-26 19:16:05 +0100505
506 /* If we have a TMSI, use TMSI instead of IMSI */
507 if (ispresent(g_pars.tmsi)) {
508 mi := valueof(ts_MI_TMSI_LV(g_pars.tmsi));
509 } else {
510 mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
511 }
Harald Welte0bef21e2018-02-10 09:48:23 +0100512 if (cpars.emergency) {
513 f_establish_fully(mi, EST_TYPE_EMERG_CALL);
514 } else {
515 f_establish_fully(mi, EST_TYPE_MO_CALL);
516 }
Harald Welteb71901a2018-01-26 19:16:05 +0100517
518 /* Create MNCC and MGCP expect */
519 f_create_mncc_expect(hex2str(cpars.called_party));
520 f_create_mgcp_expect(ExpectCriteria:{omit,omit,omit});
521
Harald Welte0bef21e2018-02-10 09:48:23 +0100522 if (cpars.emergency) {
523 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_CC_EMERG_SETUP(cpars.transaction_id)));
524 } else {
525 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_CC_SETUP(cpars.transaction_id, cpars.called_party)));
526 }
Harald Welteb71901a2018-01-26 19:16:05 +0100527 interleave {
528 [] MNCC.receive(tr_MNCC_SETUP_ind(?, tr_MNCC_number(hex2str(cpars.called_party)))) -> value mncc {
529 cpars.mncc_callref := mncc.u.signal.callref;
530 /* Call Proceeding */
531 MNCC.send(ts_MNCC_CALL_PROC_req(cpars.mncc_callref, cpars.mncc_bearer_cap));
532 BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_CC_CALL_PROC(cpars.transaction_id)));
533 };
Harald Welte4017d552018-01-26 21:40:05 +0100534 /* First MGCP CRCX (for BSS/RAN side) */
Harald Welteb71901a2018-01-26 19:16:05 +0100535 [] MGCP.receive(tr_CRCX) -> value mgcp_cmd {
536 cpars.mgcp_call_id := f_MgcpCmd_extract_call_id(mgcp_cmd);
Philipp Maierf1e02bb2018-03-15 16:30:00 +0100537
538 /* When the endpoint contains a wildcard we keep the endpoint
539 * identifier we have set up in cpars. Otherwise we use the
540 * endpoint name that the call agent has supplied */
541 if (match(mgcp_cmd.line.ep, t_MGCP_EP_wildcard) == false) {
542 cpars.mgcp_ep := mgcp_cmd.line.ep;
543 }
544
Harald Welte4017d552018-01-26 21:40:05 +0100545 var SDP_Message sdp := valueof(ts_SDP(cpars.mgw_rtp_ip_bss, cpars.mgw_rtp_ip_bss,
Harald Welteb71901a2018-01-26 19:16:05 +0100546 hex2str(cpars.mgcp_call_id), "42",
Harald Welte4017d552018-01-26 21:40:05 +0100547 cpars.mgw_rtp_port_bss,
Harald Welteb71901a2018-01-26 19:16:05 +0100548 { int2str(cpars.rtp_payload_type) },
549 { valueof(ts_SDP_rtpmap(cpars.rtp_payload_type,
550 cpars.rtp_sdp_format)),
551 valueof(ts_SDP_ptime(20)) }));
Philipp Maierf1e02bb2018-03-15 16:30:00 +0100552
553 var template MgcpResponse mgcp_resp;
554 mgcp_resp := ts_CRCX_ACK(mgcp_cmd.line.trans_id, cpars.mgcp_connection_id_bss, sdp);
555 f_mgcp_par_append(mgcp_resp.params, ts_MgcpParSpecEP(cpars.mgcp_ep));
556 MGCP.send(mgcp_resp);
Harald Welteb71901a2018-01-26 19:16:05 +0100557 }
558 }
Harald Welte4017d552018-01-26 21:40:05 +0100559 /* Second MGCP CRCX (this time for MSS/CN side) */
560 MGCP.receive(tr_CRCX(cpars.mgcp_ep)) -> value mgcp_cmd {
561 var SDP_Message sdp := valueof(ts_SDP(cpars.mgw_rtp_ip_mss, cpars.mgw_rtp_ip_mss,
562 hex2str(cpars.mgcp_call_id), "42",
563 cpars.mgw_rtp_port_mss,
564 { int2str(cpars.rtp_payload_type) },
565 { valueof(ts_SDP_rtpmap(cpars.rtp_payload_type,
566 cpars.rtp_sdp_format)),
567 valueof(ts_SDP_ptime(20)) }));
568 MGCP.send(ts_CRCX_ACK(mgcp_cmd.line.trans_id, cpars.mgcp_connection_id_mss, sdp));
569 }
Harald Welteb71901a2018-01-26 19:16:05 +0100570
571 /* Alerting */
572 MNCC.send(ts_MNCC_ALERT_req(cpars.mncc_callref));
Harald Welteb71901a2018-01-26 19:16:05 +0100573
Harald Welte4017d552018-01-26 21:40:05 +0100574 var BSSMAP_IE_AoIP_TransportLayerAddress tla_ass :=
575 valueof(ts_BSSMAP_IE_AoIP_TLA4(f_inet_addr(cpars.mgw_rtp_ip_bss),cpars.mgw_rtp_port_bss));
576 interleave {
577 [] BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_CC_ALERTING(cpars.transaction_id))) {}
578 /* expect AoIP IP/Port to match what we returned in CRCX_ACK above */
579 [] BSSAP.receive(tr_BSSMAP_AssignmentReq(omit, tla_ass)) {
Harald Welteb71901a2018-01-26 19:16:05 +0100580 var BSSMAP_IE_AoIP_TransportLayerAddress tla;
581 tla := valueof(ts_BSSMAP_IE_AoIP_TLA4(f_inet_addr(cpars.bss_rtp_ip), cpars.bss_rtp_port));
582 BSSAP.send(ts_BSSMAP_AssignmentComplete(omit, tla));
583 }
584 }
585
Harald Welte4017d552018-01-26 21:40:05 +0100586 /* Answer. MNCC_SETUP_RSP -> CONNECT to MS; CONNECT_ACK from MS */
587 MNCC.send(ts_MNCC_SETUP_rsp(cpars.mncc_callref));
588 BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_CC_CONNECT(cpars.transaction_id)));
589 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_CC_CONNECT_ACK(cpars.transaction_id)));
Harald Welteb71901a2018-01-26 19:16:05 +0100590
Philipp Maier3716a5e2018-03-21 15:53:35 +0100591 setverdict(pass);
592}
Harald Welteb71901a2018-01-26 19:16:05 +0100593
Philipp Maier3716a5e2018-03-21 15:53:35 +0100594function f_call_hangup(inout CallParameters cpars, boolean release_by_ms)
595runs on BSC_ConnHdlr {
596
597 var MobileIdentityLV mi;
598 var MNCC_PDU mncc;
599 var MgcpCommand mgcp_cmd;
600 var boolean respond_to_dlcx;
601
Harald Welteb71901a2018-01-26 19:16:05 +0100602 MNCC.send(ts_MNCC_DISC_req(cpars.mncc_callref, valueof(ts_MNCC_cause(23))));
603 BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_CC_DISC(cpars.transaction_id)));
604
Philipp Maier3716a5e2018-03-21 15:53:35 +0100605 if (release_by_ms) {
606 /* B-side (MS) Release of call */
607 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_CC_RELEASE(cpars.transaction_id, '1'B, '0000000'B)));
608 MNCC.receive(tr_MNCC_REL_ind(cpars.mncc_callref));
609 BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_CC_REL_COMPL(cpars.transaction_id)));
610 } else {
611 /* A-side (PLMN) Release of call */
612 MNCC.send(ts_MNCC_REL_req(cpars.mncc_callref, valueof(ts_MNCC_cause(42))));
613 BSSAP.receive(tr_PDU_DTAP_MT(tr_ML3_MT_CC_RELEASE(cpars.transaction_id)));
614 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_CC_REL_COMPL(cpars.transaction_id)));
615 }
Harald Welteb71901a2018-01-26 19:16:05 +0100616
Philipp Maier2a98a732018-03-19 16:06:12 +0100617 respond_to_dlcx := not (isbound(cpars.mgw_drop_dlcx) and valueof(cpars.mgw_drop_dlcx));
618
Harald Welteb71901a2018-01-26 19:16:05 +0100619 /* clearing of radio channel */
620 interleave {
621 [] BSSAP.receive(tr_BSSMAP_ClearCommand) {
622 BSSAP.send(ts_BSSMAP_ClearComplete);
623 BSSAP.receive(BSSAP_Conn_Prim:MSC_CONN_PRIM_DISC_IND);
624 }
625 [] MGCP.receive(tr_DLCX(?)) -> value mgcp_cmd {
Philipp Maier2a98a732018-03-19 16:06:12 +0100626 if (respond_to_dlcx) {
627 /* TODO: For one or all connections on EP? */
628 MGCP.send(ts_DLCX_ACK2(mgcp_cmd.line.trans_id));
629 f_create_mgcp_delete_ep(cpars.mgcp_ep);
630 }
Harald Welteb71901a2018-01-26 19:16:05 +0100631 }
632 }
Philipp Maier3716a5e2018-03-21 15:53:35 +0100633
634 setverdict(pass);
635}
636
637function f_mt_call(inout CallParameters cpars)
638runs on BSC_ConnHdlr {
639
640 f_mt_call_establish(cpars);
641
642 /* Hold the call for some time */
643 f_sleep(3.0);
644
645 f_call_hangup(cpars, true);
646
647 setverdict(pass);
648}
649
650function f_mo_call(inout CallParameters cpars)
651runs on BSC_ConnHdlr {
652
653 f_mo_call_establish(cpars);
654
655 /* Hold the call for some time */
656 f_sleep(3.0);
657
658 f_call_hangup(cpars, false);
659
Harald Welteb71901a2018-01-26 19:16:05 +0100660 setverdict(pass);
661}
Harald Weltea49e36e2018-01-21 19:29:33 +0100662
Daniel Willmann8b084372018-02-04 13:35:26 +0100663function f_mo_seq_dtmf_dup(inout CallParameters cpars)
664runs on BSC_ConnHdlr {
665
666 timer T := 1.0;
667 var MobileIdentityLV mi;
668 var MNCC_PDU mncc;
669 var MgcpCommand mgcp_cmd;
670 var template PDU_ML3_MS_NW dtmf_dtap;
671
672 /* If we have a TMSI, use TMSI instead of IMSI */
673 if (ispresent(g_pars.tmsi)) {
674 mi := valueof(ts_MI_TMSI_LV(g_pars.tmsi));
675 } else {
676 mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
677 }
678 f_establish_fully(mi);
679
680 /* Create MNCC and MGCP expect */
681 f_create_mncc_expect(hex2str(cpars.called_party));
682 f_create_mgcp_expect(ExpectCriteria:{omit,omit,omit});
683
684 BSSAP.send(ts_PDU_DTAP_MO(ts_ML3_MO_CC_SETUP(cpars.transaction_id, cpars.called_party)));
685 MNCC.receive(tr_MNCC_SETUP_ind(?, tr_MNCC_number(hex2str(cpars.called_party)))) -> value mncc;
686 cpars.mncc_callref := mncc.u.signal.callref;
687
688 /* Send DTMF */
689 dtmf_dtap := ts_ML3_MO_CC_START_DTMF(cpars.transaction_id, "2");
690 dtmf_dtap.msgs.cc.startDTMF.nsd := int2bit(2, 2);
Daniel Willmann92f66272018-02-06 15:50:52 +0100691 BSSAP.send(ts_PDU_DTAP_MO(dtmf_dtap, '00'O, true));
Daniel Willmann8b084372018-02-04 13:35:26 +0100692 T.start;
693 alt {
694 [] MNCC.receive(tr_MNCC_START_DTMF_ind(cpars.mncc_callref, "2")) {}
695 [] T.timeout {
696 setverdict(fail, "Timeout waiting for START_DTMF_ind");
697 self.stop;
698 }
699 }
700
Daniel Willmann92f66272018-02-06 15:50:52 +0100701 BSSAP.send(ts_PDU_DTAP_MO(dtmf_dtap, '00'O, true));
Daniel Willmann8b084372018-02-04 13:35:26 +0100702 T.start;
703 alt {
704 [] MNCC.receive(tr_MNCC_START_DTMF_ind(cpars.mncc_callref, "2")) {
705 setverdict(fail, "Received duplicate START_DTMF_ind");
706 self.stop;
707 }
708 [] T.timeout { }
709 }
710
711 dtmf_dtap := ts_ML3_MO_CC_START_DTMF(cpars.transaction_id, "3");
712 dtmf_dtap.msgs.cc.startDTMF.nsd := int2bit(3, 2);
Daniel Willmann92f66272018-02-06 15:50:52 +0100713 BSSAP.send(ts_PDU_DTAP_MO(dtmf_dtap, '00'O, true));
Daniel Willmann8b084372018-02-04 13:35:26 +0100714 alt {
715 [] MNCC.receive(tr_MNCC_START_DTMF_ind(cpars.mncc_callref, "3")) { }
716 [] T.timeout {
717 setverdict(fail, "Received duplicate START_DTMF_ind");
718 self.stop;
719 }
720 }
721
722 setverdict(pass);
723}
Harald Welte1ddc7162018-01-27 14:25:46 +0100724/* expect a clear command */
Harald Welte5946b332018-03-18 23:32:21 +0100725altstep as_clear_cmd_compl_disc(float t := 5.0) runs on BSC_ConnHdlr {
726 [] BSSAP.receive(tr_BSSMAP_ClearCommand) {
727 BSSAP.send(ts_BSSMAP_ClearComplete);
728 alt {
729 [] BSSAP.receive(BSSAP_Conn_Prim:MSC_CONN_PRIM_DISC_IND) {
730 setverdict(pass);
731 }
732 [] BSSAP.receive {
733 setverdict(fail, "Unexpected BSSMAP while waiting for SCCP Release");
734 self.stop;
735 }
736 }
737 }
738 [] BSSAP.receive {
739 setverdict(fail, "Unexpected BSSMAP while waiting for ClearCommand");
740 self.stop;
741 }
742}
743
Harald Welte1ddc7162018-01-27 14:25:46 +0100744function f_expect_clear(float t := 5.0) runs on BSC_ConnHdlr {
745 timer T := t;
746
747 T.start;
748 alt {
Harald Welte5946b332018-03-18 23:32:21 +0100749 [] as_clear_cmd_compl_disc(t) { }
Harald Welte1ddc7162018-01-27 14:25:46 +0100750 [] T.timeout {
Harald Welte5946b332018-03-18 23:32:21 +0100751 setverdict(fail, "Timeout waiting for ClearCommand/Release");
Harald Welte1ddc7162018-01-27 14:25:46 +0100752 self.stop;
753 }
754 }
755}
756
Harald Weltea49e36e2018-01-21 19:29:33 +0100757
758
759
760}
761
762