blob: e64842760ecd08f43ce5e19a99bb0b7a900e96cd [file] [log] [blame]
Harald Welte28d943e2017-11-25 15:00:50 +01001module MSC_ConnectionHandler {
2
3import from General_Types all;
4import from Osmocom_Types all;
Harald Weltec1a2fff2017-12-17 11:06:19 +01005import from GSM_Types all;
Harald Welte28d943e2017-11-25 15:00:50 +01006import from SCCPasp_Types all;
7import from BSSAP_Types all;
8import from BSSMAP_Emulation all;
9import from BSSMAP_Templates all;
10
Harald Welte211219e2018-01-29 22:03:36 +010011import from IPL4asp_Types all;
12import from Native_Functions all;
13
Harald Welte28d943e2017-11-25 15:00:50 +010014import from MGCP_Types all;
15import from MGCP_Templates all;
Daniel Willmann191e0d92018-01-17 12:44:35 +010016import from MGCP_Emulation all;
Harald Welte28d943e2017-11-25 15:00:50 +010017import from SDP_Types all;
18
Harald Weltec1a2fff2017-12-17 11:06:19 +010019import from RSL_Emulation all;
20import from RSL_Types all;
21
22import from MobileL3_Types all;
23import from MobileL3_CommonIE_Types all;
Harald Welte211219e2018-01-29 22:03:36 +010024import from MobileL3_RRM_Types all;
Harald Weltec1a2fff2017-12-17 11:06:19 +010025import from L3_Templates all;
26
Harald Weltec20b1c42018-02-12 20:50:08 +010027import from TELNETasp_PortType all;
28import from Osmocom_VTY_Functions all;
29
Harald Weltec1a2fff2017-12-17 11:06:19 +010030
Harald Welte211219e2018-01-29 22:03:36 +010031/***********************************************************************
32 * Media related handling
33 ***********************************************************************/
34
35/* Tuple containing host/ip and port */
36type record HostPort {
37 HostName host,
38 PortNumber port_nr
39};
40
41/* State encapsulating one MGCP Connection */
42type record MgcpConnState {
43 boolean crcx_seen,
44 MgcpConnectionId conn_id,
45 charstring mime_type, /* e.g. AMR */
46 integer sample_rate, /* 8000 */
47 integer ptime, /* 20 */
48 uint7_t rtp_pt, /* RTP Payload Type */
49 HostPort mgw, /* MGW side */
50 HostPort peer /* CA side */
51};
52
53/* BTS media state */
54type record BtsMediaState {
55 boolean ipa_crcx_seen,
56 uint16_t conn_id,
57 uint7_t rtp_pt,
58 HostPort bts,
59 HostPort peer
60};
61
62type record MediaState {
63 MgcpEndpoint mgcp_ep,
64 MgcpConnState mgcp_conn[2],
Harald Welte261af4b2018-02-12 21:20:39 +010065 BtsMediaState bts,
66 BtsMediaState bts1 /* only during hand-over */
Harald Welte211219e2018-01-29 22:03:36 +010067};
68
69function f_MediaState_init(inout MediaState g_media, integer nr, HostName bts, HostName mgw) {
70 /* BTS Side */
71 g_media.bts := {
72 ipa_crcx_seen := false,
73 conn_id := nr,
74 rtp_pt := 0,
75 bts := {
76 host := bts,
77 port_nr := 9000 + nr*2
78 },
79 peer := -
80 }
81
Harald Welte261af4b2018-02-12 21:20:39 +010082 g_media.bts1 := {
83 ipa_crcx_seen := false,
84 conn_id := nr,
85 rtp_pt := 0,
86 bts := {
87 host := bts, /* FIXME */
88 port_nr := 9000 + nr*2
89 },
90 peer := -
91 }
92
Harald Welte363cb0a2018-01-30 19:35:53 +010093 g_media.mgcp_ep := "rtpbridge/" & int2str(nr) & "@mgw";
Harald Welte211219e2018-01-29 22:03:36 +010094
95 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
96 g_media.mgcp_conn[i].mime_type := "AMR";
97 g_media.mgcp_conn[i].sample_rate := 8000;
98 g_media.mgcp_conn[i].ptime := 20;
99 g_media.mgcp_conn[i].rtp_pt := 98;
100 g_media.mgcp_conn[i].crcx_seen := false;
101 g_media.mgcp_conn[i].conn_id := f_mgcp_alloc_conn_id();
102 }
103
104 g_media.mgcp_conn[0].mgw := {
105 host := mgw,
106 port_nr := 10000 + nr*2
107 }
108 g_media.mgcp_conn[1].mgw := {
109 host := mgw,
110 port_nr := 11000 + nr*2
111 }
112}
113
114private function f_get_free_mgcp_conn() runs on MSC_ConnHdlr return integer {
115 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
116 if (not g_media.mgcp_conn[i].crcx_seen) {
117 return i;
118 }
119 }
120 setverdict(fail, "Only 2 Connections per EP!");
121 self.stop;
Harald Welte211219e2018-01-29 22:03:36 +0100122}
123
124private function f_get_mgcp_conn(MgcpConnectionId cid) runs on MSC_ConnHdlr return integer {
125 for (var integer i:= 0; i < sizeof(g_media.mgcp_conn); i := i+1) {
126 if (g_media.mgcp_conn[i].conn_id == cid and g_media.mgcp_conn[i].crcx_seen) {
127 return i;
128 }
129 }
130 setverdict(fail, "No Connection for ID ", cid);
131 self.stop;
Harald Welte211219e2018-01-29 22:03:36 +0100132}
133
134
135/* altstep for handling of IPA + MGCP media related commands. Can be activated by a given
136 * test case if it expects to see media related handling (i.e. voice calls */
137altstep as_Media() runs on MSC_ConnHdlr {
138 var RSL_Message rsl;
139 var MgcpCommand mgcp_cmd;
140 var RSL_IE_Body ie;
Harald Welte930d0a72018-03-22 22:08:40 +0100141 var boolean b_unused;
Harald Welte211219e2018-01-29 22:03:36 +0100142 [not g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
143 /* Extract parameters from request + use in response */
144 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
145 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
146 }
147 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
148 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
149 }
150 RSL.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts.conn_id,
151 oct2int(f_inet_addr(g_media.bts.bts.host)),
152 g_media.bts.bts.port_nr,
153 g_media.bts.rtp_pt));
154 g_media.bts.ipa_crcx_seen := true;
155 repeat;
156 }
157 [g_media.bts.ipa_crcx_seen] RSL.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
158 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100159 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100160 if (g_media.bts.conn_id != ie.ipa_conn_id) {
161 setverdict(fail, "IPA MDCX for unknown ConnId", rsl);
162 self.stop;
163 }
164 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100165 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100166 g_media.bts.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
Harald Welte930d0a72018-03-22 22:08:40 +0100167 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte211219e2018-01-29 22:03:36 +0100168 g_media.bts.peer.port_nr := ie.ipa_remote_port;
169 /* optional */
170 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
171 g_media.bts.rtp_pt := ie.ipa_rtp_pt;
172 }
173 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
174 g_media.bts.rtp_pt := ie.ipa_rtp_pt2;
175 }
176 RSL.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts.conn_id,
177 oct2int(f_inet_addr(g_media.bts.peer.host)),
178 g_media.bts.peer.port_nr,
179 g_media.bts.rtp_pt));
Harald Welte261af4b2018-02-12 21:20:39 +0100180 //g_media.bts.ipa_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100181 repeat;
182 }
Harald Welte261af4b2018-02-12 21:20:39 +0100183
184 /* on second (new) BTS during hand-over */
185 [not g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_CRCX(g_chan_nr)) -> value rsl {
186 /* Extract parameters from request + use in response */
187 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
188 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
189 }
190 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
191 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
192 }
193 RSL1.send(ts_RSL_IPA_CRCX_ACK(g_chan_nr, g_media.bts1.conn_id,
194 oct2int(f_inet_addr(g_media.bts1.bts.host)),
195 g_media.bts1.bts.port_nr,
196 g_media.bts1.rtp_pt));
197 g_media.bts1.ipa_crcx_seen := true;
198 repeat;
199 }
200 /* on second (new) BTS during hand-over */
201 [g_media.bts1.ipa_crcx_seen] RSL1.receive(tr_RSL_IPA_MDCX(g_chan_nr, ?)) -> value rsl{
202 /* Extract conn_id, ip, port, rtp_pt2 from request + use in response */
Harald Welte930d0a72018-03-22 22:08:40 +0100203 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_CONN_ID, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100204 if (g_media.bts1.conn_id != ie.ipa_conn_id) {
205 setverdict(fail, "IPA MDCX for unknown ConnId", rsl);
206 self.stop;
207 }
208 /* mandatory */
Harald Welte930d0a72018-03-22 22:08:40 +0100209 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_IP, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100210 g_media.bts1.peer.host := f_inet_ntoa(int2oct(ie.ipa_remote_ip, 4));
Harald Welte930d0a72018-03-22 22:08:40 +0100211 b_unused := f_rsl_find_ie(rsl, RSL_IE_IPAC_REMOTE_PORT, ie);
Harald Welte261af4b2018-02-12 21:20:39 +0100212 g_media.bts1.peer.port_nr := ie.ipa_remote_port;
213 /* optional */
214 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD, ie)) {
215 g_media.bts1.rtp_pt := ie.ipa_rtp_pt;
216 }
217 if (f_rsl_find_ie(rsl, RSL_IE_IPAC_RTP_PAYLOAD2, ie)) {
218 g_media.bts1.rtp_pt := ie.ipa_rtp_pt2;
219 }
220 RSL1.send(ts_RSL_IPA_MDCX_ACK(g_chan_nr, g_media.bts1.conn_id,
221 oct2int(f_inet_addr(g_media.bts1.peer.host)),
222 g_media.bts1.peer.port_nr,
223 g_media.bts1.rtp_pt));
224 //g_media.bts1.ipa_mdcx_seen := true;
225 repeat;
226 }
227
Harald Welte211219e2018-01-29 22:03:36 +0100228 [] MGCP.receive(tr_CRCX) -> value mgcp_cmd {
229 var SDP_Message sdp;
230 var integer cid := f_get_free_mgcp_conn();
Harald Welte363cb0a2018-01-30 19:35:53 +0100231 if (match(mgcp_cmd.line.ep, t_MGCP_EP_wildcard)) {
232 if (cid != 0) {
233 setverdict(fail, "MGCP wildcard EP only works in first CRCX");
234 self.stop;
235 }
236 /* we keep the endpoint name allocated during MediaState_init */
237 } else {
238 /* Call Agent allocated endpoint, trust/use it always */
239 g_media.mgcp_ep := mgcp_cmd.line.ep;
240 }
Harald Welte211219e2018-01-29 22:03:36 +0100241 if (isvalue(mgcp_cmd.sdp)) {
242 sdp := mgcp_cmd.sdp;
243 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
244 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
245 }
246 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
247 sdp := valueof(ts_SDP(mgcp_conn.mgw.host, mgcp_conn.mgw.host, "foo", "21",
248 mgcp_conn.mgw.port_nr, { int2str(mgcp_conn.rtp_pt) },
249 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
250 mgcp_conn.mime_type & "/" &
251 int2str(mgcp_conn.sample_rate))),
252 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
Harald Welte363cb0a2018-01-30 19:35:53 +0100253 var template MgcpResponse mgcp_resp;
254 mgcp_resp := ts_CRCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp);
255 f_mgcp_par_append(mgcp_resp.params, ts_MgcpParSpecEP(g_media.mgcp_ep));
256 MGCP.send(mgcp_resp);
Harald Welte211219e2018-01-29 22:03:36 +0100257 g_media.mgcp_conn[cid].crcx_seen := true;
258 repeat;
259 }
260 [] MGCP.receive(tr_MDCX) -> value mgcp_cmd {
261 var SDP_Message sdp;
262 var integer cid := f_get_mgcp_conn(f_MgcpCmd_extract_conn_id(mgcp_cmd));
263 if (isvalue(mgcp_cmd.sdp)) {
264 sdp := mgcp_cmd.sdp;
265 g_media.mgcp_conn[cid].peer.host := sdp.connection.conn_addr.addr;
266 g_media.mgcp_conn[cid].peer.port_nr := sdp.media_list[0].media_field.ports.port_number;
267 } else {
268 setverdict(fail, "MDCX has no [recognizable] SDP");
Harald Welte211219e2018-01-29 22:03:36 +0100269 }
270 var MgcpConnState mgcp_conn := g_media.mgcp_conn[cid];
271 sdp := valueof(ts_SDP(mgcp_conn.peer.host, mgcp_conn.peer.host, "foo", "21",
272 mgcp_conn.peer.port_nr, { int2str(mgcp_conn.rtp_pt) },
273 {valueof(ts_SDP_rtpmap(mgcp_conn.rtp_pt,
274 mgcp_conn.mime_type & "/" &
275 int2str(mgcp_conn.sample_rate))),
276 valueof(ts_SDP_ptime(mgcp_conn.ptime)) } ));
277 MGCP.send(ts_MDCX_ACK(mgcp_cmd.line.trans_id, mgcp_conn.conn_id, sdp));
Harald Welte261af4b2018-02-12 21:20:39 +0100278 //g_media.mgcp_mdcx_seen := true;
Harald Welte211219e2018-01-29 22:03:36 +0100279 repeat;
280 }
281}
282
283
284
285
Harald Welte28d943e2017-11-25 15:00:50 +0100286/* this component represents a single subscriber connection at the MSC.
287 * There is a 1:1 mapping between SCCP connections and BSSAP_ConnHdlr components.
288 * We inherit all component variables, ports, functions, ... from BSSAP_ConnHdlr */
Daniel Willmann191e0d92018-01-17 12:44:35 +0100289type component MSC_ConnHdlr extends BSSAP_ConnHdlr, RSL_DchanHdlr, MGCP_ConnHdlr {
Harald Welte28d943e2017-11-25 15:00:50 +0100290 /* SCCP Connecction Identifier for the underlying SCCP connection */
291 var integer g_sccp_conn_id;
292
Harald Weltec1a2fff2017-12-17 11:06:19 +0100293 /* procedure port back to our parent (BSSMAP_Emulation_CT) for control */
294 port BSSMAPEM_PROC_PT BSSMAPEM;
Harald Weltec20b1c42018-02-12 20:50:08 +0100295 port TELNETasp_PT BSCVTY;
Harald Welte28d943e2017-11-25 15:00:50 +0100296
Harald Welte211219e2018-01-29 22:03:36 +0100297 var MediaState g_media;
Harald Weltea0630032018-03-20 21:09:55 +0100298 var TestHdlrParams g_pars;
Harald Weltee97eab42018-03-21 18:46:06 +0100299
300 var boolean g_vty_initialized := false;
Harald Welte211219e2018-01-29 22:03:36 +0100301}
302
303/* initialize all parameters */
304function f_MscConnHdlr_init(integer i, HostName bts, HostName mgw) runs on MSC_ConnHdlr {
305 f_MediaState_init(g_media, i, bts, mgw);
Harald Weltee97eab42018-03-21 18:46:06 +0100306 if (not g_vty_initialized) {
307 map(self:BSCVTY, system:BSCVTY);
308 f_vty_set_prompts(BSCVTY);
309 f_vty_transceive(BSCVTY, "enable");
310 g_vty_initialized := true;
311 }
Harald Welte28d943e2017-11-25 15:00:50 +0100312}
313
314/* Callback function from general BSSMAP_Emulation whenever a connectionless
315 * BSSMAP message arrives. Can retunr a PDU_BSSAP that should be sent in return */
316private function UnitdataCallback(PDU_BSSAP bssap)
317runs on BSSMAP_Emulation_CT return template PDU_BSSAP {
318 var template PDU_BSSAP resp := omit;
319
Harald Weltec1a2fff2017-12-17 11:06:19 +0100320 /* answer all RESET with a RESET ACK */
Harald Welte28d943e2017-11-25 15:00:50 +0100321 if (match(bssap, tr_BSSMAP_Reset)) {
322 resp := ts_BSSMAP_ResetAck;
323 }
324
325 return resp;
326}
327
328const BssmapOps MSC_BssmapOps := {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100329 create_cb := refers(BSSMAP_Emulation.ExpectedCreateCallback),
Harald Welte0b476062018-01-21 19:07:32 +0100330 unitdata_cb := refers(UnitdataCallback),
331 decode_dtap := false,
Harald Welte930d0a72018-03-22 22:08:40 +0100332 role_ms := false,
333 sccp_addr_local := omit,
334 sccp_addr_peer := omit
Harald Welte28d943e2017-11-25 15:00:50 +0100335}
336
Daniel Willmann191e0d92018-01-17 12:44:35 +0100337const MGCPOps MSC_MGCPOps := {
Harald Welte930d0a72018-03-22 22:08:40 +0100338 create_cb := refers(MGCP_Emulation.ExpectedCreateCallback),
339 unitdata_cb := refers(MGCP_Emulation.DummyUnitdataCallback)
Daniel Willmann191e0d92018-01-17 12:44:35 +0100340}
341
Harald Weltec1a2fff2017-12-17 11:06:19 +0100342/* register an expect with the BSSMAP core */
Daniel Willmann191e0d92018-01-17 12:44:35 +0100343private function f_create_bssmap_exp(octetstring l3_enc) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100344 BSSMAPEM.call(BSSMAPEM_register:{l3_enc, self}) {
345 [] BSSMAPEM.getreply(BSSMAPEM_register:{?, ?}) {};
Harald Welte28d943e2017-11-25 15:00:50 +0100346 }
347}
348
Harald Weltec1a2fff2017-12-17 11:06:19 +0100349type record TestHdlrParams {
350 OCT1 ra,
351 GsmFrameNumber fn,
352 hexstring imsi,
Harald Welte60aa5762018-03-21 19:33:13 +0100353 RslLinkId link_id,
354 BSSMAP_IE_SpeechCodecList ass_codec_list optional
Harald Weltec1a2fff2017-12-17 11:06:19 +0100355};
356
357template (value) TestHdlrParams t_def_TestHdlrPars := {
358 ra := '23'O,
359 fn := 23,
360 imsi := '001019876543210'H,
Harald Welte60aa5762018-03-21 19:33:13 +0100361 link_id := valueof(ts_RslLinkID_DCCH(0)),
362 ass_codec_list := omit
Harald Weltec1a2fff2017-12-17 11:06:19 +0100363}
364
Harald Weltea0630032018-03-20 21:09:55 +0100365function f_create_chan_and_exp() runs on MSC_ConnHdlr {
366 var MobileIdentityLV mi := valueof(ts_MI_IMSI_LV(g_pars.imsi));
Harald Welte6ed6bf92018-01-24 21:09:15 +0100367 var PDU_ML3_MS_NW l3_info := valueof(ts_CM_SERV_REQ(CM_TYPE_MO_CALL, mi));
Harald Weltec1a2fff2017-12-17 11:06:19 +0100368 var octetstring l3_enc := enc_PDU_ML3_MS_NW(l3_info);
369
370 /* call helper function for CHAN_RQD -> IMM ASS ->EST_IND */
Harald Weltea0630032018-03-20 21:09:55 +0100371 RSL_Emulation.f_chan_est(g_pars.ra, l3_enc, g_pars.link_id, g_pars.fn);
Daniel Willmann191e0d92018-01-17 12:44:35 +0100372 f_create_bssmap_exp(l3_enc);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100373}
374
Harald Welte898113b2018-01-31 18:32:21 +0100375function f_rsl_send_l3(template PDU_ML3_MS_NW l3, template (omit) RslLinkId link_id := omit,
376 template (omit) RslChannelNr chan_nr := omit) runs on MSC_ConnHdlr {
377 if (not isvalue(link_id)) {
378 link_id := ts_RslLinkID_DCCH(0);
379 }
380 if (not isvalue(chan_nr)) {
381 chan_nr := g_chan_nr;
382 }
383 RSL.send(ts_RSL_DATA_IND(valueof(chan_nr), valueof(link_id), enc_PDU_ML3_MS_NW(valueof(l3))));
384}
385
Harald Weltec1a2fff2017-12-17 11:06:19 +0100386function f_rsl_reply(template PDU_ML3_MS_NW l3, RSL_Message orig) runs on MSC_ConnHdlr {
387 var RslChannelNr chan_nr := orig.ies[0].body.chan_nr;
Harald Welte1a40de62017-12-23 02:28:34 +0100388 var RslLinkId link_id;
Harald Welte8d5eead2017-12-17 18:56:45 +0100389 if (orig.msg_type == RSL_MT_ENCR_CMD) {
390 link_id := orig.ies[2].body.link_id;
391 } else {
392 link_id := orig.ies[1].body.link_id;
393 }
Harald Welte898113b2018-01-31 18:32:21 +0100394 f_rsl_send_l3(l3, link_id, chan_nr);
Harald Weltec1a2fff2017-12-17 11:06:19 +0100395}
396
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100397/* Convert the chipher representation on BSSMAP to the representation used on RSL */
398function f_chipher_mode_bssmap_to_rsl(OCT1 alg_bssmap) return OCT1
399{
400 /* A5 0 */
401 if (alg_bssmap == '01'O) {
402 return '01'O;
403 }
404 /* A5 1 */
405 else if (alg_bssmap == '02'O) {
406 return '02'O;
407 }
408 /* A5 2 */
409 else if (alg_bssmap == '04'O) {
410 return '03'O;
411 }
412 /* A5 3 */
413 else if (alg_bssmap == '08'O) {
414 return '04'O;
415 }
416 /* A5 4 */
417 else if (alg_bssmap == '10'O) {
418 return '05'O;
419 }
420 /* A5 5 */
421 else if (alg_bssmap == '20'O) {
422 return '06'O;
423 }
424 /* A5 6 */
425 else if (alg_bssmap == '40'O) {
426 return '07'O;
427 }
428 /* A5 7 */
429 else if (alg_bssmap == '80'O) {
430 return '08'O;
431 } else {
432 setverdict(fail, "Unexpected Encryption Algorithm");
433 return '00'O;
434 }
435}
436
Harald Welte38b2a102017-12-23 02:42:58 +0100437function f_cipher_mode(OCT1 alg, OCT8 key, template OCT16 kc128 := omit, boolean exp_fail := false)
438runs on MSC_ConnHdlr {
Harald Welte73cd2712017-12-17 00:44:52 +0100439 var PDU_BSSAP bssap;
440 var RSL_Message rsl;
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100441 var OCT1 alg_rsl;
Harald Welte73cd2712017-12-17 00:44:52 +0100442
443 if (isvalue(kc128)) {
444 BSSAP.send(ts_BSSMAP_CipherModeCmdKc128(alg, key, valueof(kc128)));
445 } else {
446 BSSAP.send(ts_BSSMAP_CipherModeCmd(alg, key));
447 }
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100448
449 /* RSL uses a different representation of the encryption algorithm,
450 * so we need to convert first */
451 alg_rsl := f_chipher_mode_bssmap_to_rsl(alg);
452
Harald Welte73cd2712017-12-17 00:44:52 +0100453 alt {
454 /* RSL/UE Side */
Philipp Maierb20c3dc2018-02-07 18:36:25 +0100455 [] RSL.receive(tr_RSL_ENCR_CMD(g_chan_nr, ?, alg_rsl, key)) -> value rsl {
Harald Welte73cd2712017-12-17 00:44:52 +0100456 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[3].body.l3_info.payload);
457 log("Rx L3 from net: ", l3);
458 if (ischosen(l3.msgs.rrm.cipheringModeCommand)) {
459 f_rsl_reply(ts_RRM_CiphModeCompl, rsl);
460 }
461 repeat;
462 }
463 [] BSSAP.receive(tr_BSSMAP_CipherModeCompl) -> value bssap {
464 // bssap.bssmap.cipherModeComplete.chosenEncryptionAlgorithm.algoritmhIdentifier
Harald Welte38b2a102017-12-23 02:42:58 +0100465 if (exp_fail == true) {
466 setverdict(fail, "Unexpected Cipher Mode Complete");
467 } else {
468 setverdict(pass);
469 }
Harald Welte73cd2712017-12-17 00:44:52 +0100470 }
471 [] BSSAP.receive(tr_BSSMAP_CipherModeRej) -> value bssap {
Harald Welte38b2a102017-12-23 02:42:58 +0100472 if (exp_fail == false) {
473 setverdict(fail, "Ciphering Mode Reject");
474 } else {
475 setverdict(pass);
476 }
Harald Welte73cd2712017-12-17 00:44:52 +0100477 }
478 }
479}
480
Harald Welte211219e2018-01-29 22:03:36 +0100481/* Convert from Ericsson ChanDesc2 format to Osmocom RslChannelNr format */
482function f_ChDesc2RslChanNr(ChannelDescription2_V ch_desc, out RslChannelNr chan_nr, out GsmArfcn arfcn) {
483 var BIT5 inp := ch_desc.channelTypeandTDMAOffset;
Harald Welte6fa1f732018-03-21 22:46:16 +0100484 var uint3_t tn := bit2int(ch_desc.timeslotNumber);
Harald Welte211219e2018-01-29 22:03:36 +0100485
486 if (match(inp, '00001'B)) { /* TCH/F */
Harald Welte6fa1f732018-03-21 22:46:16 +0100487 chan_nr := valueof(t_RslChanNr_Bm(tn));
Harald Welte211219e2018-01-29 22:03:36 +0100488 }
489 else if (match(inp, '0001?'B)) { /* TCH/H */
Harald Welte6fa1f732018-03-21 22:46:16 +0100490 chan_nr := valueof(t_RslChanNr_Lm(tn, bit2int(substr(inp, 4, 1))));
Harald Welte211219e2018-01-29 22:03:36 +0100491 }
492 else if (match(inp, '001??'B)) { /* SDCCH/4 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100493 chan_nr := valueof(t_RslChanNr_SDCCH4(tn, bit2int(substr(inp, 3, 2))));
Harald Welte211219e2018-01-29 22:03:36 +0100494 }
495 else if (match(inp, '01???'B)) { /* SDCCH/8 */
Harald Welte6fa1f732018-03-21 22:46:16 +0100496 chan_nr := valueof(t_RslChanNr_SDCCH8(tn, bit2int(substr(inp, 2, 3))));
Harald Welte211219e2018-01-29 22:03:36 +0100497 }
498 else {
499 setverdict(fail, "Unknown ChDesc!");
500 self.stop;
501 }
502
503 if (ch_desc.octet3 and4b '10'O == '10'O) {
504 setverdict(fail, "No support for Hopping");
505 self.stop;
506 } else {
507 var OCT2 concat := ch_desc.octet3 & ch_desc.octet4;
508 arfcn := oct2int(concat);
509 }
510}
511
512type record AssignmentState {
513 /* global */
514 boolean voice_call,
515 boolean is_assignment,
516 /* Assignment related bits */
517 boolean rr_ass_cmpl_seen,
Harald Welte21583082018-01-29 22:28:26 +0100518 boolean assignment_done,
Harald Welte211219e2018-01-29 22:03:36 +0100519 RslChannelNr old_chan_nr,
520 /* Modify related bits */
521 boolean rr_modify_seen,
Harald Welte21583082018-01-29 22:28:26 +0100522 boolean modify_done
Harald Welte211219e2018-01-29 22:03:36 +0100523}
524
525template (value) AssignmentState ts_AssignmentStateInit := {
526 voice_call := false,
527 is_assignment := false,
528 rr_ass_cmpl_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100529 assignment_done := false,
Harald Welte211219e2018-01-29 22:03:36 +0100530 old_chan_nr := -,
531 rr_modify_seen := false,
Harald Welte21583082018-01-29 22:28:26 +0100532 modify_done := false
Harald Welte211219e2018-01-29 22:03:36 +0100533}
534
535altstep as_assignment(inout AssignmentState st) runs on MSC_ConnHdlr {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100536 var RSL_Message rsl;
Harald Welte211219e2018-01-29 22:03:36 +0100537 [not st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
538 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
539 log("Rx L3 from net: ", l3);
540 if (ischosen(l3.msgs.rrm.assignmentCommand)) {
541 var RslChannelNr new_chan_nr;
542 var GsmArfcn arfcn;
543 f_ChDesc2RslChanNr(l3.msgs.rrm.assignmentCommand.descrOf1stChAfterTime,
544 new_chan_nr, arfcn);
545 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
Harald Weltec1a2fff2017-12-17 11:06:19 +0100546
Harald Welte211219e2018-01-29 22:03:36 +0100547 /* register our component for this channel number at the RSL Emulation */
548 f_rslem_register(0, new_chan_nr);
549 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_AssignmentComplete('00'O));
550 /* send assignment complete over the new channel */
551 RSL.send(ts_RSL_DATA_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
552 enc_PDU_ML3_MS_NW(l3_tx)));
553 /* by default, send via the new channel from now */
554 st.old_chan_nr := g_chan_nr;
555 g_chan_nr := new_chan_nr;
556 st.rr_ass_cmpl_seen := true;
557 repeat;
558 } else {
559 setverdict(fail, "Unexpected L3 received", l3);
560 self.stop;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100561 }
Harald Welte211219e2018-01-29 22:03:36 +0100562 }
563 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
564 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
565 repeat;
566 }
567 [st.rr_ass_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
568 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
Harald Welte1909f462018-01-29 22:29:29 +0100569 /* unregister for old channel number in RSL emulation */
570 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
571 f_rslem_unregister(0, st.old_chan_nr);
Harald Welte21583082018-01-29 22:28:26 +0100572 st.assignment_done := true;
Harald Welte211219e2018-01-29 22:03:36 +0100573 repeat;
574 }
575}
576
577altstep as_modify(inout AssignmentState st) runs on MSC_ConnHdlr {
578 /* no assignment, just mode modify */
579 var RSL_Message rsl;
580
581 [st.voice_call and not st.rr_modify_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100582 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
583 log("Rx L3 from net: ", l3);
584 if (ischosen(l3.msgs.rrm.channelModeModify)) {
585 f_rsl_reply(ts_RRM_ModeModifyAck(l3.msgs.rrm.channelModeModify.channelDescription,
586 l3.msgs.rrm.channelModeModify.channelMode), rsl);
Harald Welte211219e2018-01-29 22:03:36 +0100587 st.rr_modify_seen := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100588 }
589 repeat;
590 }
Harald Welte211219e2018-01-29 22:03:36 +0100591 [st.voice_call and st.rr_modify_seen] RSL.receive(tr_RSL_MsgTypeD(RSL_MT_MODE_MODIFY_REQ)) -> value rsl {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100592 RSL.send(ts_RSL_MODE_MODIFY_ACK(g_chan_nr));
Harald Welte21583082018-01-29 22:28:26 +0100593 st.modify_done := true;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100594 repeat;
595 }
Harald Welte211219e2018-01-29 22:03:36 +0100596}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100597
Harald Welte211219e2018-01-29 22:03:36 +0100598/* Determine if given rsl_chan_nr is compatible with given BSSMAP ChannelType */
599function f_channel_compatible(BSSMAP_IE_ChannelType bssmap, RslChannelNr rsl_chan_nr)
600return boolean {
601 select (bssmap.speechOrDataIndicator) {
602 case ('0011'B) { /* Signalling */
603 /* all channels support signalling */
604 return true;
605 }
606 case else { /* Speech, Speech+CTM or CSD */
607 select (bssmap.channelRateAndType) {
608 case ('08'O) { /* TCH/F */
609 select (rsl_chan_nr) {
610 case (t_RslChanNr_Bm(?)) { return true; }
611 }
612 }
613 case ('09'O) { /* TCH/H */
614 select (rsl_chan_nr) {
615 case (t_RslChanNr_Lm(?, ?)) { return true; }
616 }
617 }
618 case else { /* full or half-rate */
619 select (rsl_chan_nr) {
620 case (t_RslChanNr_Bm(?)) { return true; }
621 case (t_RslChanNr_Lm(?, ?)) { return true; }
622 }
623 }
624 }
Harald Weltec1a2fff2017-12-17 11:06:19 +0100625 }
Harald Welte211219e2018-01-29 22:03:36 +0100626 }
627 return false;
628}
Daniel Willmann191e0d92018-01-17 12:44:35 +0100629
Harald Welte211219e2018-01-29 22:03:36 +0100630/* establish a channel fully, expecting an assignment matching 'exp' */
Harald Welte930d0a72018-03-22 22:08:40 +0100631function f_establish_fully_ret(PDU_BSSAP ass_cmd, template PDU_BSSAP exp_ass_cpl)
Harald Welte211219e2018-01-29 22:03:36 +0100632runs on MSC_ConnHdlr return PDU_BSSAP {
633 var PDU_BSSAP bssap;
634 timer T := 10.0;
635 var boolean exp_compl := ischosen(exp_ass_cpl.pdu.bssmap.assignmentComplete);
Philipp Maier86f39202018-02-07 14:40:09 +0100636 var boolean exp_fail := ischosen(exp_ass_cpl.pdu.bssmap.assignmentFailure);
Harald Welte211219e2018-01-29 22:03:36 +0100637 var ExpectCriteria mgcpcrit := {
638 connid := omit,
639 endpoint := omit,
640 transid := omit
641 };
642 var AssignmentState st := valueof(ts_AssignmentStateInit);
643 /* if the channel type is SIGNAL, we're not handling a voice call */
644 if (ass_cmd.pdu.bssmap.assignmentRequest.channelType.speechOrDataIndicator != '0011'B) {
645 st.voice_call := true;
646 }
647 /* determine if the current channel can support the given service or not */
648 if (not f_channel_compatible(ass_cmd.pdu.bssmap.assignmentRequest.channelType, g_chan_nr)) {
649 st.is_assignment := true;
650 }
651
Harald Weltec20b1c42018-02-12 20:50:08 +0100652 f_MscConnHdlr_init(1, "127.0.0.2", "127.0.0.3");
Harald Welte211219e2018-01-29 22:03:36 +0100653
Harald Weltea0630032018-03-20 21:09:55 +0100654 f_create_chan_and_exp();
Harald Welte211219e2018-01-29 22:03:36 +0100655 /* we should now have a COMPL_L3 at the MSC */
656 BSSAP.receive(tr_BSSMAP_ComplL3);
657 f_create_mgcp_expect(mgcpcrit);
658 BSSAP.send(ass_cmd);
659
660 T.start;
661 alt {
662 /* assignment related bits */
663 [st.is_assignment] as_assignment(st);
664
665 /* modify related bits */
666 [not st.is_assignment] as_modify(st);
667
668 /* voice call related bits (IPA CRCX/MDCX + MGCP) */
669 [st.voice_call] as_Media();
670
671 /* if we receive exactly what we expected, always return + pass */
Harald Welte21583082018-01-29 22:28:26 +0100672 [st.is_assignment and st.assignment_done or
673 (not st.is_assignment and st.modify_done)] BSSAP.receive(exp_ass_cpl) -> value bssap {
Harald Welte211219e2018-01-29 22:03:36 +0100674 setverdict(pass);
675 }
Philipp Maier86f39202018-02-07 14:40:09 +0100676 [exp_fail] BSSAP.receive(exp_ass_cpl) -> value bssap {
677 setverdict(pass);
678 }
Harald Welte21583082018-01-29 22:28:26 +0100679 [(st.is_assignment and st.assignment_done or
680 (not st.is_assignment and st.modify_done)) and
681 exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
Harald Weltec1a2fff2017-12-17 11:06:19 +0100682 setverdict(fail, "Received non-matching ASSIGNMENT COMPLETE");
683 }
684 [exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
685 setverdict(fail, "Received unexpected ASSIGNMENT FAIL");
686 }
687 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentComplete) {
688 setverdict(fail, "Received unexpected ASSIGNMENT COMPLETE");
689 }
690 [not exp_compl] BSSAP.receive(tr_BSSMAP_AssignmentFail) {
691 setverdict(fail, "Received non-matching ASSIGNMENT FAIL");
692 }
693 [] T.timeout {
Harald Welte458fd372018-03-21 11:26:23 +0100694 setverdict(fail, "Timeout waiting for ASSIGNMENT COMPLETE");
Harald Weltec1a2fff2017-12-17 11:06:19 +0100695 }
696 }
Harald Welte211219e2018-01-29 22:03:36 +0100697 log("g_media ", g_media);
698 if (not isbound(bssap)) {
699 self.stop;
700 }
701 return bssap;
Harald Weltec1a2fff2017-12-17 11:06:19 +0100702}
703
Harald Welte930d0a72018-03-22 22:08:40 +0100704function f_establish_fully(PDU_BSSAP ass_cmd, template PDU_BSSAP exp_ass_cpl)
705runs on MSC_ConnHdlr {
706 var PDU_BSSAP unused := f_establish_fully_ret(ass_cmd, exp_ass_cpl);
707}
708
Harald Welte261af4b2018-02-12 21:20:39 +0100709type record HandoverState {
710 /* Assignment related bits */
711 boolean rr_ho_cmpl_seen,
712 boolean handover_done,
713 RslChannelNr old_chan_nr
714};
715
716altstep as_handover(inout HandoverState st) runs on MSC_ConnHdlr {
717 var RSL_Message rsl;
718 [not st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_DATA_REQ(g_chan_nr)) -> value rsl {
719 var PDU_ML3_NW_MS l3 := dec_PDU_ML3_NW_MS(rsl.ies[2].body.l3_info.payload);
720 log("Rx L3 from net: ", l3);
721 if (ischosen(l3.msgs.rrm.handoverCommand)) {
722 var RslChannelNr new_chan_nr;
723 var GsmArfcn arfcn;
724 f_ChDesc2RslChanNr(l3.msgs.rrm.handoverCommand.channelDescription2,
725 new_chan_nr, arfcn);
726 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
727
728 /* register our component for this channel number at the RSL Emulation */
729 f_rslem_register(0, new_chan_nr, RSL1_PROC);
730
731 /* resume processing of RSL DChan messages, which was temporarily suspended
732 * before performing a hand-over */
733 f_rslem_resume(RSL1_PROC);
734
735 /* send handover complete over the new channel */
736 var PDU_ML3_MS_NW l3_tx := valueof(ts_RRM_HandoverComplete('00'O));
737 RSL1.send(ts_RSL_DATA_IND(new_chan_nr, valueof(ts_RslLinkID_DCCH(0)),
738 enc_PDU_ML3_MS_NW(l3_tx)));
739 /* by default, send via the new channel from now */
740 st.old_chan_nr := g_chan_nr;
741 g_chan_nr := new_chan_nr;
742 st.rr_ho_cmpl_seen := true;
743 repeat;
744 } else {
745 setverdict(fail, "Unexpected L3 received", l3);
746 self.stop;
747 }
748 }
749 [st.rr_ho_cmpl_seen] as_Media();
750 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_REL_REQ(st.old_chan_nr, tr_RslLinkID_DCCH(0))) {
751 RSL.send(ts_RSL_REL_CONF(st.old_chan_nr, valueof(ts_RslLinkID_DCCH(0))));
752 repeat;
753 }
754 [st.rr_ho_cmpl_seen] RSL.receive(tr_RSL_RF_CHAN_REL(st.old_chan_nr)) {
755 RSL.send(ts_RSL_RF_CHAN_REL_ACK(st.old_chan_nr));
756 /* unregister for old channel number in RSL emulation */
757 /* FIXME: Determine TRX NR by ARFCN, instead of hard-coded TRX0! */
758 f_rslem_unregister(0, st.old_chan_nr);
759 st.handover_done := true;
Harald Welte261af4b2018-02-12 21:20:39 +0100760 }
761}
762
763
Harald Weltec1a2fff2017-12-17 11:06:19 +0100764
Harald Welte28d943e2017-11-25 15:00:50 +0100765}