Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 1 | /* GTP Emulation in TTCN-3 |
| 2 | * |
| 3 | * (C) 2018 Harald Welte <laforge@gnumonks.org> |
| 4 | * All rights reserved. |
| 5 | * |
| 6 | * Released under the terms of GNU General Public License, Version 2 or |
| 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * SPDX-License-Identifier: GPL-2.0-or-later |
| 10 | */ |
| 11 | |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 12 | module GTP_Emulation { |
| 13 | |
| 14 | import from IPL4asp_Types all; |
| 15 | import from General_Types all; |
| 16 | import from Osmocom_Types all; |
| 17 | import from GTPC_Types all; |
| 18 | import from GTPU_Types all; |
| 19 | import from GTP_CodecPort all; |
| 20 | import from GTP_CodecPort_CtrlFunct all; |
| 21 | |
| 22 | /*********************************************************************** |
| 23 | * Main Emulation Component |
| 24 | ***********************************************************************/ |
| 25 | |
| 26 | const integer GTP0_PORT := 3386; |
| 27 | const integer GTP1C_PORT := 2123; |
| 28 | const integer GTP1U_PORT := 2152; |
| 29 | |
| 30 | type record GtpEmulationCfg { |
| 31 | HostName gtpc_bind_ip, |
| 32 | PortNumber gtpc_bind_port, |
Philipp Maier | 5c1b5f2 | 2023-07-12 14:03:52 +0200 | [diff] [blame] | 33 | HostName gtpu_bind_ip optional, |
| 34 | PortNumber gtpu_bind_port optional, |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 35 | boolean sgsn_role |
| 36 | }; |
| 37 | |
| 38 | type component GTP_Emulation_CT { |
| 39 | /* Communication with underlying GTP CodecPort */ |
| 40 | port GTPC_PT GTPC; |
| 41 | port GTPU_PT GTPU; |
| 42 | |
| 43 | /* Communication with Clients */ |
| 44 | port GTPEM_PT CLIENT; |
| 45 | port GTPEM_PROC_PT CLIENT_PROC; |
Pau Espin Pedrol | 8c74cbb | 2021-05-04 15:26:56 +0200 | [diff] [blame] | 46 | port GTPEM_PT CLIENT_DEFAULT; |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 47 | |
| 48 | /* Configuration by the user */ |
| 49 | var GtpEmulationCfg g_gtp_cfg; |
| 50 | |
| 51 | /* State */ |
| 52 | var integer g_gtpc_id, g_gtpu_id; |
| 53 | var OCT1 g_restart_ctr; |
| 54 | var uint16_t g_c_seq_nr, g_u_seq_nr; |
| 55 | var TidTableRec TidTable[16]; |
| 56 | var ImsiTableRec ImsiTable[16]; |
| 57 | }; |
| 58 | |
| 59 | type record TidTableRec { |
| 60 | OCT4 teid, |
| 61 | GTP_ConnHdlr vc_conn |
| 62 | }; |
| 63 | |
| 64 | type record ImsiTableRec { |
| 65 | hexstring imsi, |
| 66 | GTP_ConnHdlr vc_conn |
| 67 | }; |
| 68 | |
| 69 | private function f_comp_by_teid(OCT4 teid) runs on GTP_Emulation_CT return GTP_ConnHdlr { |
| 70 | var integer i; |
| 71 | for (i := 0; i < sizeof(TidTable); i := i+1) { |
| 72 | if (isbound(TidTable[i].teid) and TidTable[i].teid == teid) { |
| 73 | return TidTable[i].vc_conn; |
| 74 | } |
| 75 | } |
| 76 | setverdict(fail, "No Component for TEID ", teid); |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 77 | mtc.stop; |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 78 | } |
| 79 | |
| 80 | private function f_comp_by_imsi(hexstring imsi) runs on GTP_Emulation_CT return GTP_ConnHdlr { |
| 81 | var integer i; |
| 82 | for (i := 0; i < sizeof(ImsiTable); i := i+1) { |
| 83 | if (isbound(ImsiTable[i].imsi) and ImsiTable[i].imsi == imsi) { |
| 84 | return ImsiTable[i].vc_conn; |
| 85 | } |
| 86 | } |
| 87 | setverdict(fail, "No Component for IMSI ", imsi); |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 88 | mtc.stop; |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | private function f_tid_tbl_add(OCT4 teid, GTP_ConnHdlr vc_conn) runs on GTP_Emulation_CT { |
| 92 | var integer i; |
| 93 | for (i := 0; i < sizeof(TidTable); i := i+1) { |
| 94 | if (not isbound(TidTable[i].teid)) { |
| 95 | TidTable[i].teid := teid; |
| 96 | TidTable[i].vc_conn := vc_conn; |
| 97 | return; |
| 98 | } |
| 99 | } |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 100 | testcase.stop("No Space in TidTable for ", teid); |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 101 | } |
| 102 | |
| 103 | private function f_imsi_tbl_add(hexstring imsi, GTP_ConnHdlr vc_conn) runs on GTP_Emulation_CT { |
| 104 | var integer i; |
| 105 | for (i := 0; i < sizeof(ImsiTable); i := i+1) { |
| 106 | if (not isbound(ImsiTable[i].imsi)) { |
| 107 | ImsiTable[i].imsi := imsi; |
| 108 | ImsiTable[i].vc_conn := vc_conn; |
| 109 | return; |
| 110 | } |
| 111 | } |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 112 | testcase.stop("No Space in IMSI Table for ", imsi); |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 113 | } |
| 114 | |
| 115 | function f_gtpc_extract_imsi(PDU_GTPC gtp) return template (omit) hexstring { |
| 116 | if (ischosen(gtp.gtpc_pdu.createPDPContextRequest)) { |
| 117 | return gtp.gtpc_pdu.createPDPContextRequest.imsi.digits; |
| 118 | } else if (ischosen(gtp.gtpc_pdu.updatePDPContextRequest.updatePDPContextRequestSGSN)) { |
| 119 | return gtp.gtpc_pdu.updatePDPContextRequest.updatePDPContextRequestSGSN.imsi.digits; |
| 120 | } else if (ischosen(gtp.gtpc_pdu.updatePDPContextRequest.updatePDPContextRequestGGSN)) { |
| 121 | return gtp.gtpc_pdu.updatePDPContextRequest.updatePDPContextRequestGGSN.imsi.digits; |
| 122 | } else if (ischosen(gtp.gtpc_pdu.updatePDPContextRequest.updatePDPContextRequestCGW)) { |
| 123 | return gtp.gtpc_pdu.updatePDPContextRequest.updatePDPContextRequestCGW.imsi.digits; |
| 124 | } else if (ischosen(gtp.gtpc_pdu.pdu_NotificationRequest)) { |
| 125 | return gtp.gtpc_pdu.pdu_NotificationRequest.imsi.digits; |
| 126 | } else if (ischosen(gtp.gtpc_pdu.sendRouteingInformationForGPRSRequest)) { |
| 127 | return gtp.gtpc_pdu.sendRouteingInformationForGPRSRequest.imsi.digits; |
| 128 | } else if (ischosen(gtp.gtpc_pdu.sendRouteingInformationForGPRSResponse)) { |
| 129 | return gtp.gtpc_pdu.sendRouteingInformationForGPRSResponse.imsi.digits; |
| 130 | } else if (ischosen(gtp.gtpc_pdu.failureReportRequest)) { |
| 131 | return gtp.gtpc_pdu.failureReportRequest.imsi.digits; |
| 132 | } else if (ischosen(gtp.gtpc_pdu.noteMS_GPRSPresentRequest)) { |
| 133 | return gtp.gtpc_pdu.noteMS_GPRSPresentRequest.imsi.digits; |
| 134 | } else if (ischosen(gtp.gtpc_pdu.identificationResponse) ){ |
| 135 | return gtp.gtpc_pdu.identificationResponse.imsi.digits; |
| 136 | } else if (ischosen(gtp.gtpc_pdu.sgsn_ContextRequest)) { |
Pau Espin Pedrol | 12cf40a | 2024-01-02 17:45:12 +0100 | [diff] [blame^] | 137 | if (ispresent(gtp.gtpc_pdu.sgsn_ContextRequest.imsi.digits)) { |
| 138 | return gtp.gtpc_pdu.sgsn_ContextRequest.imsi.digits; |
| 139 | } else { |
| 140 | return omit; |
| 141 | } |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 142 | } else if (ischosen(gtp.gtpc_pdu.sgsn_ContextResponse)) { |
Pau Espin Pedrol | 22a65e6 | 2023-12-15 17:22:23 +0100 | [diff] [blame] | 143 | if (ispresent(gtp.gtpc_pdu.sgsn_ContextResponse.imsi.digits)) { |
| 144 | return gtp.gtpc_pdu.sgsn_ContextResponse.imsi.digits; |
| 145 | } else { |
| 146 | return omit; |
| 147 | } |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 148 | } else if (ischosen(gtp.gtpc_pdu.forwardRelocationRequest)) { |
| 149 | return gtp.gtpc_pdu.forwardRelocationRequest.imsi.digits; |
| 150 | } else if (ischosen(gtp.gtpc_pdu.relocationCancelRequest)) { |
| 151 | return gtp.gtpc_pdu.relocationCancelRequest.imsi.digits; |
| 152 | } else if (ischosen(gtp.gtpc_pdu.uERegistrationQueryRequest)) { |
| 153 | return gtp.gtpc_pdu.uERegistrationQueryRequest.imsi.digits; |
| 154 | } else if (ischosen(gtp.gtpc_pdu.uERegistrationQueryResponse)) { |
| 155 | return gtp.gtpc_pdu.uERegistrationQueryResponse.imsi.digits; |
| 156 | } else if (ischosen(gtp.gtpc_pdu.mBMSNotificationRequest)) { |
| 157 | return gtp.gtpc_pdu.mBMSNotificationRequest.imsi.digits; |
| 158 | } else if (ischosen(gtp.gtpc_pdu.createMBMSContextRequest)) { |
| 159 | return gtp.gtpc_pdu.createMBMSContextRequest.imsi.digits; |
| 160 | } else if (ischosen(gtp.gtpc_pdu.deleteMBMSContextRequest)) { |
| 161 | return gtp.gtpc_pdu.deleteMBMSContextRequest.imsi.digits; |
| 162 | } else if (ischosen(gtp.gtpc_pdu.mS_InfoChangeNotificationRequest)) { |
| 163 | return gtp.gtpc_pdu.mS_InfoChangeNotificationRequest.imsi.digits; |
| 164 | } else if (ischosen(gtp.gtpc_pdu.mS_InfoChangeNotificationResponse)) { |
| 165 | return gtp.gtpc_pdu.mS_InfoChangeNotificationResponse.imsi.digits; |
| 166 | } else { |
| 167 | return omit; |
| 168 | } |
| 169 | } |
| 170 | |
| 171 | private function f_init(GtpEmulationCfg cfg) runs on GTP_Emulation_CT { |
| 172 | var Result res; |
| 173 | |
| 174 | map(self:GTPC, system:GTPC); |
| 175 | res := GTP_CodecPort_CtrlFunct.f_IPL4_listen(GTPC, cfg.gtpc_bind_ip, |
| 176 | cfg.gtpc_bind_port, {udp:={}}); |
| 177 | g_gtpc_id := res.connId; |
| 178 | |
Philipp Maier | 5c1b5f2 | 2023-07-12 14:03:52 +0200 | [diff] [blame] | 179 | if (isvalue(cfg.gtpu_bind_ip) and isvalue(cfg.gtpu_bind_port)) { |
| 180 | map(self:GTPU, system:GTPU); |
| 181 | res := GTP_CodecPort_CtrlFunct.f_GTPU_listen(GTPU, cfg.gtpu_bind_ip, |
| 182 | cfg.gtpu_bind_port, {udp:={}}); |
| 183 | g_gtpu_id := res.connId; |
| 184 | } |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 185 | |
| 186 | g_restart_ctr := f_rnd_octstring(1); |
| 187 | g_c_seq_nr := f_rnd_int(65535); |
| 188 | g_u_seq_nr := f_rnd_int(65535); |
| 189 | g_gtp_cfg := cfg; |
| 190 | } |
| 191 | |
| 192 | function main(GtpEmulationCfg cfg) runs on GTP_Emulation_CT { |
| 193 | var Gtp1cUnitdata g1c_ud; |
| 194 | var Gtp1uUnitdata g1u_ud; |
| 195 | var GTP_ConnHdlr vc_conn; |
| 196 | var hexstring imsi; |
| 197 | var OCT4 teid; |
| 198 | |
| 199 | f_init(cfg); |
| 200 | |
| 201 | while (true) { |
| 202 | alt { |
| 203 | /* route inbound GTP-C based on IMSI or TEID */ |
| 204 | [] GTPC.receive(Gtp1cUnitdata:?) -> value g1c_ud { |
| 205 | var template hexstring imsi_t := f_gtpc_extract_imsi(g1c_ud.gtpc); |
| 206 | if (isvalue(imsi_t)) { |
| 207 | vc_conn := f_comp_by_imsi(valueof(imsi_t)); |
Pau Espin Pedrol | 20e16c1 | 2018-07-10 18:38:17 +0200 | [diff] [blame] | 208 | CLIENT.send(g1c_ud) to vc_conn; |
| 209 | } else if(g1c_ud.gtpc.teid != int2oct(0, 4)) { |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 210 | vc_conn := f_comp_by_teid(g1c_ud.gtpc.teid); |
Pau Espin Pedrol | 20e16c1 | 2018-07-10 18:38:17 +0200 | [diff] [blame] | 211 | CLIENT.send(g1c_ud) to vc_conn; |
| 212 | } else { |
Pau Espin Pedrol | 8c74cbb | 2021-05-04 15:26:56 +0200 | [diff] [blame] | 213 | /* Check if a default port is set: */ |
| 214 | if (CLIENT_DEFAULT.checkstate("Connected")) { |
| 215 | CLIENT_DEFAULT.send(g1c_ud); |
| 216 | } else { |
| 217 | /* Send to all clients */ |
| 218 | var integer i; |
| 219 | for (i := 0; i < sizeof(TidTable); i := i+1) { |
| 220 | if (isbound(TidTable[i].teid) and TidTable[i].teid == teid) { |
| 221 | CLIENT.send(g1c_ud) to TidTable[i].vc_conn; |
| 222 | } |
Pau Espin Pedrol | 20e16c1 | 2018-07-10 18:38:17 +0200 | [diff] [blame] | 223 | } |
| 224 | } |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 225 | } |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 226 | } |
| 227 | [] GTPU.receive(Gtp1uUnitdata:?) -> value g1u_ud { |
| 228 | vc_conn := f_comp_by_teid(g1u_ud.gtpu.teid); |
| 229 | CLIENT.send(g1u_ud) to vc_conn; |
| 230 | } |
| 231 | |
| 232 | /* transparently forward any GTP-C / GTP-U from clients to peer[s] */ |
| 233 | [] CLIENT.receive(Gtp1cUnitdata:?) -> value g1c_ud sender vc_conn { |
| 234 | GTPC.send(g1c_ud); |
| 235 | } |
| 236 | [] CLIENT.receive(Gtp1uUnitdata:?) -> value g1u_ud sender vc_conn { |
| 237 | GTPU.send(g1u_ud); |
| 238 | } |
Pau Espin Pedrol | 8c74cbb | 2021-05-04 15:26:56 +0200 | [diff] [blame] | 239 | [] CLIENT_DEFAULT.receive(Gtp1cUnitdata:?) -> value g1c_ud sender vc_conn { |
| 240 | GTPC.send(g1c_ud); |
| 241 | } |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 242 | |
| 243 | [] CLIENT_PROC.getcall(GTPEM_register_imsi:{?}) -> param(imsi) sender vc_conn { |
| 244 | f_imsi_tbl_add(imsi, vc_conn); |
Harald Welte | e32ad99 | 2018-05-31 22:17:46 +0200 | [diff] [blame] | 245 | CLIENT_PROC.reply(GTPEM_register_imsi:{imsi}) to vc_conn; |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 246 | } |
| 247 | |
| 248 | [] CLIENT_PROC.getcall(GTPEM_register_teid:{?}) -> param(teid) sender vc_conn { |
| 249 | f_tid_tbl_add(teid, vc_conn); |
Harald Welte | e32ad99 | 2018-05-31 22:17:46 +0200 | [diff] [blame] | 250 | CLIENT_PROC.reply(GTPEM_register_teid:{teid}) to vc_conn; |
Harald Welte | c69cf4e | 2018-02-17 20:57:02 +0100 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | } |
| 254 | } |
| 255 | } |
| 256 | |
| 257 | |
| 258 | /*********************************************************************** |
| 259 | * Interaction between Main and Client Components |
| 260 | ***********************************************************************/ |
| 261 | type port GTPEM_PT message { |
| 262 | inout Gtp1cUnitdata, Gtp1uUnitdata; |
| 263 | } with { extension "internal" }; |
| 264 | |
| 265 | signature GTPEM_register_imsi(hexstring imsi); |
| 266 | signature GTPEM_register_teid(OCT4 teid); |
| 267 | |
| 268 | type port GTPEM_PROC_PT procedure { |
| 269 | inout GTPEM_register_imsi, GTPEM_register_teid; |
| 270 | } with { extension "internal" }; |
| 271 | |
| 272 | /*********************************************************************** |
| 273 | * Client Compoennt |
| 274 | ***********************************************************************/ |
| 275 | |
| 276 | type component GTP_ConnHdlr { |
| 277 | port GTPEM_PT GTP; |
| 278 | port GTPEM_PROC_PT GTP_PROC; |
| 279 | }; |
| 280 | |
| 281 | function f_gtp_register_imsi(hexstring imsi) runs on GTP_ConnHdlr { |
| 282 | GTP_PROC.call(GTPEM_register_imsi:{imsi}) { |
| 283 | [] GTP_PROC.getreply(GTPEM_register_imsi:{imsi}); |
| 284 | } |
| 285 | } |
| 286 | |
| 287 | function f_gtp_register_teid(OCT4 teid) runs on GTP_ConnHdlr { |
| 288 | GTP_PROC.call(GTPEM_register_teid:{teid}) { |
| 289 | [] GTP_PROC.getreply(GTPEM_register_teid:{teid}); |
| 290 | } |
| 291 | } |
| 292 | |
| 293 | } |