blob: 03cc28831b6795ff1fb1728e46688992b21e2619 [file] [log] [blame]
Harald Welte379d45a2017-08-03 09:55:15 +02001module GGSN_Tests {
2
Harald Welte94ade362017-08-04 00:36:55 +02003 import from General_Types all;
Harald Welte811651e2017-08-05 15:25:06 +02004 import from Osmocom_Types all;
Harald Welte94ade362017-08-04 00:36:55 +02005 import from IPL4asp_PortType all;
6 import from IPL4asp_Types all;
7 import from GTP_CodecPort all;
8 import from GTP_CodecPort_CtrlFunct all;
9 import from GTPC_Types all;
10 import from GTPU_Types all;
Harald Welte231b9412017-08-09 17:16:31 +020011 import from IP_Types all;
12 import from ICMPv6_Types all;
Harald Welte94ade362017-08-04 00:36:55 +020013
14 const integer GTP0_PORT := 3386;
15 const integer GTP1C_PORT := 2123;
16 const integer GTP1U_PORT := 2152;
Harald Welte876345e2017-08-04 16:19:59 +020017 const charstring g_bind_ip_c := "127.23.42.1";
18 const charstring g_bind_ip_u := g_bind_ip_c;
Harald Welte94ade362017-08-04 00:36:55 +020019
Harald Welte811651e2017-08-05 15:25:06 +020020 type set PdpContext {
21 hexstring imsi,
22 octetstring msisdn optional,
23 octetstring apn,
Harald Welteed7a1772017-08-09 20:26:20 +020024 ProtConfigOptions pco_req optional,
25 ProtConfigOptions pco_neg optional,
Harald Welte811651e2017-08-05 15:25:06 +020026 EndUserAddress eua,
Harald Welte231b9412017-08-09 17:16:31 +020027 OCT16 ip6_prefix optional,
Harald Welte811651e2017-08-05 15:25:06 +020028 BIT4 nsapi,
29 /* TEI (Data) local side */
30 OCT4 teid,
31 /* TEI (Control) local side */
32 OCT4 teic,
33 /* TEI (Data) remote side */
34 OCT4 teid_remote,
35 /* TEI (Control) remote side */
36 OCT4 teic_remote,
37 /* next to-be-sent GTP-C sequence number */
38 uint16_t c_seq_nr,
39 /* next to-be-sent GTP-U sequence number */
40 uint16_t d_seq_nr
41 }
42
Harald Welte94ade362017-08-04 00:36:55 +020043 type component GT_CT {
44 port GTPC_PT GTPC;
45 port GTPU_PT GTPU;
46
47 var OCT1 g_restart_ctr := '01'O;
48 /* FIXME: unify with g_bind_ip + parse from config file */
Harald Welte876345e2017-08-04 16:19:59 +020049 var OCT4 g_sgsn_ip_c := '7f172a01'O;
50 var OCT4 g_sgsn_ip_u := '7f172a01'O;
Harald Welte94ade362017-08-04 00:36:55 +020051 /* FIXME: parse remName from config file */
Harald Welte811651e2017-08-05 15:25:06 +020052 var GtpPeer g_peer_c := { connId := 0, remName := "127.0.0.6", remPort := GTP1C_PORT };
53 var GtpPeer g_peer_u := { connId := 0, remName := "127.0.0.6", remPort := GTP1U_PORT };
Harald Welte94ade362017-08-04 00:36:55 +020054 timer T_default := 3.0;
55 }
56
57 function f_init() runs on GT_CT {
58 var Result res;
59 map(self:GTPC, system:GTPC);
Harald Welte876345e2017-08-04 16:19:59 +020060 res := GTP_CodecPort_CtrlFunct.f_IPL4_listen(GTPC, g_bind_ip_c, GTP1C_PORT, {udp:={}});
Harald Welte94ade362017-08-04 00:36:55 +020061 log("GTP1C ConnectionID: ", res.connId);
Harald Welte811651e2017-08-05 15:25:06 +020062 g_peer_c.connId := res.connId;
Harald Welte94ade362017-08-04 00:36:55 +020063
64 map(self:GTPU, system:GTPU);
Harald Welte811651e2017-08-05 15:25:06 +020065 res := GTP_CodecPort_CtrlFunct.f_GTPU_listen(GTPU, g_bind_ip_u, GTP1U_PORT, {udp:={}});
66 g_peer_u.connId:= res.connId;
Harald Welte94ade362017-08-04 00:36:55 +020067 }
68
69 /* generalized GTP-C receive template */
70 template PDU_GTPC tr_GTP1C_PDU(template OCT1 msg_type, template OCT4 teid) := {
71 /* N-PDU Number flag (PN) shall be set to '0'. A GTP-C receiver shall not return an
72 * error if this flag is set to '1'. */
73 pn_bit := '0'B,
74 /* Sequence number flag (S) shall be set to '1'. */
75 s_bit := '1'B,
76 e_bit := ?,
77 spare := ?,
78 /* Protocol Type flag (PT) shall be set to '1'.*/
79 pt := '1'B,
80 /* Version shall be set to decimal 1 ('001'). */
81 version := '001'B,
82 messageType := msg_type,
83 lengthf := ?,
84 teid := teid,
85 opt_part := *,
86 gtpc_pdu := ?
87 }
88
89 /* generalized GTP-C send template */
Harald Welte811651e2017-08-05 15:25:06 +020090 template PDU_GTPC ts_GTP1C_PDU(OCT1 msg_type, OCT4 teid, GTPC_PDUs pdu, uint16_t seq_nr) := {
Harald Welte94ade362017-08-04 00:36:55 +020091 /* N-PDU Number flag (PN) shall be set to '0'. A GTP-C receiver shall not return an
92 * error if this flag is set to '1'. */
93 pn_bit := '0'B,
94 /* Sequence number flag (S) shall be set to '1'. */
95 s_bit := '1'B,
96 e_bit := '0'B,
97 spare := '0'B,
98 /* Protocol Type flag (PT) shall be set to '1'.*/
99 pt := '1'B,
100 /* Version shall be set to decimal 1 ('001'). */
101 version := '001'B,
102 messageType := msg_type,
103 lengthf := 0, /* we assume encoder overwrites this */
104 teid := teid,
105 opt_part := {
Harald Welte811651e2017-08-05 15:25:06 +0200106 sequenceNumber := int2oct(seq_nr, 2),
Harald Welte94ade362017-08-04 00:36:55 +0200107 npduNumber := '00'O,
108 nextExtHeader := '00'O,
109 gTPC_extensionHeader_List := omit
110 },
111 gtpc_pdu := pdu
112 }
113
114 /* recovery IE */
115 template Recovery_gtpc ts_Recovery(OCT1 restart_counter) := {
116 type_gtpc := '00'O, /* we assume encoder fixes this */
117 restartCounter := restart_counter
118 }
119
120 /* template matching reception of GTP-C echo-request */
121 template Gtp1cUnitdata tr_GTPC_MsgType(template GtpPeer peer, template OCT1 msg_type, template OCT4 teid) := {
122 peer := peer,
123 gtpc := tr_GTP1C_PDU(msg_type, teid)
124 }
125
126 /* template matching reception of GTP-C echo-request */
127 template Gtp1cUnitdata tr_GTPC_PING(template GtpPeer peer) := tr_GTPC_MsgType(peer, echoRequest, '00000000'O);
128
129 template GTPC_PDUs ts_EchoRespPDU(OCT1 restart_counter) := {
130 echoResponse := {
131 recovery := {
132 type_gtpc := '00'O, /* we assume encoder fixes? */
133 restartCounter := restart_counter
134 },
135 private_extension_gtpc := omit
136 }
137 }
138
139 /* master template for senidng a GTP-C echo response */
Harald Welte811651e2017-08-05 15:25:06 +0200140 template Gtp1cUnitdata ts_GTPC_PONG(GtpPeer peer, uint16_t seq, OCT1 rest_ctr) := {
Harald Welte94ade362017-08-04 00:36:55 +0200141 peer := peer,
Harald Welte811651e2017-08-05 15:25:06 +0200142 gtpc := ts_GTP1C_PDU(echoResponse, '00000000'O, valueof(ts_EchoRespPDU(rest_ctr)), seq)
Harald Welte94ade362017-08-04 00:36:55 +0200143 }
144
145 template EndUserAddress t_EuaIPv4(template OCT4 ip_addr) := {
146 type_gtpc := '80'O,
147 endUserAddress := {
148 endUserAddressIPv4 := {
149 lengthf := 2,
150 pdp_typeorg := '0001'B,
151 spare := '1111'B,
152 pdp_typenum := '21'O,
153 ipv4_address := ip_addr
154 }
155 }
156 }
157 template EndUserAddress t_EuaIPv4Dyn := t_EuaIPv4(omit);
158 template EndUserAddress t_EuaIPv6(template OCT16 ip_addr) := {
159 type_gtpc := '80'O,
160 endUserAddress := {
161 endUserAddressIPv6 := {
162 lengthf := 2,
163 pdp_typeorg := '0001'B,
164 spare := '1111'B,
165 pdp_typenum := '57'O,
166 ipv6_address := ip_addr
167 }
168 }
169 }
170 template EndUserAddress t_EuaIPv6Dyn := t_EuaIPv6(omit);
171
172 template AccessPointName ts_APN(octetstring apn) := {
173 type_gtpc := '83'O,
174 lengthf := lengthof(apn),
175 apn_value := apn
176 }
177
178 template GSN_Address_GTPC ts_GsnAddr(octetstring ip_addr) := {
179 type_gtpc := '85'O,
180 lengthf := lengthof(ip_addr),
181 addressf := ip_addr
182 }
183
184 template MSISDN ts_Msisdn(octetstring msisdn) := {
185 type_gtpc := '86'O,
186 lengthf := lengthof(msisdn),
187 msisdn := msisdn
188 }
189
190 template QualityOfServiceProfile ts_QosDefault := {
191 type_gtpc := '87'O,
192 lengthf := 4,
193 allocRetensionPrio := '00'O,
194 qos_ProfileValue := {
195 reliabilityClass := '011'B,
196 delayClass := '001'B,
197 spare1 := '00'B,
198 precedenceClass := '010'B,
199 spare2 := '0'B,
200 peakThroughput := '1001'B,
201 meanThroughput := '11111'B,
202 spare3 := '000'B,
203 deliverErroneusSDU := omit,
204 deliveryOrder := omit,
205 trafficClass := omit,
206 maxSDUSize := omit,
207 maxBitrateUplink := omit,
208 maxBitrateDownlink := omit,
209 sduErrorRatio := omit,
210 residualBER := omit,
211 trafficHandlingPriority := omit,
212 transferDelay := omit,
213 guaranteedBitRateUplink := omit,
214 guaranteedBitRateDownlink := omit,
215 sourceStatisticsDescriptor := omit,
216 signallingIndication := omit,
217 spare4 := omit,
218 maxBitrateDownlinkExt := omit,
219 guaranteedBitRateDownlinkExt := omit,
220 maxBitrateUplinkExt := omit,
221 guaranteedBitRateUplinkExt := omit
222 }
223 }
224
225 template IMSI_gtpc ts_Imsi(hexstring digits) := {
226 type_gtpc := '02'O,
227 digits := digits,
228 padding := 'F'H
229 }
230
231 template GTPC_PDUs ts_CreatePdpPDU(hexstring imsi, OCT1 restart_ctr, OCT4 teid_data, OCT4 teid_ctrl,
232 BIT4 nsapi, EndUserAddress eua, octetstring apn,
233 octetstring sgsn_ip_sign, octetstring sgsn_ip_data,
Harald Welteed7a1772017-08-09 20:26:20 +0200234 octetstring msisdn, template ProtConfigOptions pco := omit) := {
Harald Welte94ade362017-08-04 00:36:55 +0200235 createPDPContextRequest := {
236 imsi := ts_Imsi(imsi),
237 rai := omit,
238 recovery := ts_Recovery(restart_ctr),
239 selectionMode := {
240 type_gtpc := '0F'O,
241 selectModeValue := '00'B,
242 spare := '111111'B
243 },
244 teidDataI := {
245 type_gtpc := '00'O,
246 teidDataI := teid_data
247 },
248 teidControlPlane := {
249 type_gtpc := '00'O,
250 teidControlPlane := teid_ctrl
251 },
252 nsapi := {
253 type_gtpc := '00'O,
254 nsapi := nsapi,
255 unused := '0000'B
256 },
257 linked_nsapi := omit,
258 charging_char := omit,
259 trace_ref := omit,
260 trace_type := omit,
261 endUserAddress := eua,
262 accessPointName := ts_APN(apn),
Harald Welteed7a1772017-08-09 20:26:20 +0200263 protConfigOptions := pco,
Harald Welte94ade362017-08-04 00:36:55 +0200264 sgsn_addr_signalling := ts_GsnAddr(sgsn_ip_sign),
265 sgsn_addr_traffic := ts_GsnAddr(sgsn_ip_data),
266 msisdn := ts_Msisdn(msisdn),
267 qualityOfServiceProfile := ts_QosDefault,
268 tft := omit,
269 triggerId := omit,
270 omcId := omit,
271 commonFlags := omit,
272 aPN_Restriction := omit,
273 ratType := omit,
274 userLocationInformation := omit,
275 mS_TimeZone := omit,
276 imeisv := omit,
277 camelChargingInformationContainer := omit,
278 additionalTraceInfo := omit,
279 correlationID := omit,
280 evolvedAllocationRetentionPriorityI := omit,
281 extendedCommonFlags := omit,
282 userCSGInformation := omit,
283 aPN_AMBR := omit,
284 signallingPriorityIndication := omit,
285 cN_OperatorSelectionEntity := omit,
286 private_extension_gtpc := omit
287 }
288 }
289
Harald Welte811651e2017-08-05 15:25:06 +0200290 template Gtp1cUnitdata ts_GTPC_CreatePDP(GtpPeer peer, uint16_t seq, hexstring imsi,
291 OCT1 restart_ctr, OCT4 teid_data,
Harald Welte94ade362017-08-04 00:36:55 +0200292 OCT4 teid_ctrl, BIT4 nsapi, EndUserAddress eua,
293 octetstring apn, octetstring sgsn_ip_sign,
Harald Welteed7a1772017-08-09 20:26:20 +0200294 octetstring sgsn_ip_data, octetstring msisdn,
295 template ProtConfigOptions pco := omit) := {
Harald Welte94ade362017-08-04 00:36:55 +0200296 peer := peer,
297 gtpc := ts_GTP1C_PDU(createPDPContextRequest, '00000000'O,
298 valueof(ts_CreatePdpPDU(imsi, restart_ctr, teid_data, teid_ctrl,
299 nsapi, eua, apn, sgsn_ip_sign,
Harald Welteed7a1772017-08-09 20:26:20 +0200300 sgsn_ip_data, msisdn, pco)), seq)
301 }
302
303 template ProtConfigOptions ts_PCO := {
304 type_gtpc := '84'O,
305 lengthf := 0,
306 configProtocol := '000'B,
307 spare := '0000'B,
308 extension0 := '1'B,
309 protocols := {}
310 }
311
312
313 template ProtConfigOptions ts_PCO_IPv6_DNS modifies ts_PCO := {
314 protocols := {
315 { protocolID := '0003'O, lengthProtoID := 0, protoIDContents := ''O }
316 }
317 }
318
319 template ProtConfigOptions ts_PCO_IPv4_DNS_IPCP modifies ts_PCO := {
320 protocols := {
321 { protocolID := '8021'O, lengthProtoID := 16, protoIDContents := '01000010810600000000830600000000'O }
322 }
323 }
324
325 template ProtConfigOptions ts_PCO_IPv4_DNS_CONT modifies ts_PCO := {
326 protocols := {
327 { protocolID := '000d'O, lengthProtoID := 0, protoIDContents := ''O }
328 }
Harald Welte94ade362017-08-04 00:36:55 +0200329 }
330
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200331 function f_teardown_ind_IE(in template BIT1 ind) return template TearDownInd {
Harald Welte811651e2017-08-05 15:25:06 +0200332/*
333 if (not isvalue(ind)) {
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200334 return omit;
335 }
Harald Welte811651e2017-08-05 15:25:06 +0200336*/
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200337 var TearDownInd ret := {
338 type_gtpc := '13'O,
339 tdInd := valueof(ind),
340 spare:= '0000000'B
341 }
342 return ret;
343 }
344
345 template GTPC_PDUs ts_DeletePdpPDU(BIT4 nsapi, template BIT1 teardown_ind) := {
346 deletePDPContextRequest := {
347 cause := omit,
348 tearDownIndicator := f_teardown_ind_IE(teardown_ind),
349 nsapi := {
350 type_gtpc := '14'O,
351 nsapi := nsapi,
352 unused := '0000'B
353 },
354 protConfigOptions := omit,
355 userLocationInformation := omit,
356 mS_TimeZone := omit,
357 extendedCommonFlags := omit,
358 uLI_Timestamp := omit,
359 private_extension_gtpc := omit
360 }
361 }
362
Harald Welte811651e2017-08-05 15:25:06 +0200363 template Gtp1cUnitdata ts_GTPC_DeletePDP(GtpPeer peer, uint16_t seq, OCT4 teid,
364 BIT4 nsapi, template BIT1 teardown_ind) := {
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200365 peer := peer,
366 gtpc := ts_GTP1C_PDU(deletePDPContextRequest, teid,
Harald Welte811651e2017-08-05 15:25:06 +0200367 valueof(ts_DeletePdpPDU(nsapi, teardown_ind)), seq)
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200368 }
369
370
Harald Welte3af89482017-08-04 16:20:23 +0200371 /* GTP-U */
372
Harald Welte231b9412017-08-09 17:16:31 +0200373 template PDU_GTPU tr_GTP1U_PDU(template OCT1 msg_type, template OCT4 teid, template GTPU_IEs ies := ?) := {
Harald Welte3af89482017-08-04 16:20:23 +0200374 pn_bit := ?,
375 s_bit := ?,
376 e_bit := ?,
377 spare := ?,
378 /* Protocol Type flag (PT) shall be set to '1' in GTP */
379 pt := '1'B,
380 /* Version shall be set to decimal 1 ('001'). */
381 version := '001'B,
382 messageType := msg_type,
383 lengthf := ?,
384 teid := teid,
385 opt_part := *,
Harald Welte231b9412017-08-09 17:16:31 +0200386 gtpu_IEs := ies
Harald Welte3af89482017-08-04 16:20:23 +0200387 }
388
389 /* generalized GTP-U send template */
Harald Welte811651e2017-08-05 15:25:06 +0200390 template PDU_GTPU ts_GTP1U_PDU(OCT1 msg_type, uint16_t seq, OCT4 teid, GTPU_IEs ies) := {
Harald Welte3af89482017-08-04 16:20:23 +0200391 /* N-PDU Number flag (PN): the GTP-U header contains a meaningful N-PDU Number field if the PN
392 * flag is set to 1. */
393 pn_bit := '0'B, /* we assume the encoder overwrites this if an optional part is given */
394 /* If the Sequence Number flag (S) is set to '1' the sequence number field is present and
395 * meaningful otherwise it is set to '0'. For GTP-U messages Echo Request, Echo Response,
396 * Error Indication and Supported Extension Headers Notification, the S flag shall be set to '1'. */
Harald Welte811651e2017-08-05 15:25:06 +0200397 s_bit := '1'B, /* we assume the encoder overwrites this if an optional part is given */
Harald Welte3af89482017-08-04 16:20:23 +0200398 /* Extension header presence */
399 e_bit := '0'B,
400 spare := '0'B,
401 /* Protocol Type flag (PT) shall be set to '1' in GTP */
402 pt := '1'B,
403 /* Version shall be set to decimal 1 ('001'). */
404 version := '001'B,
405 messageType := msg_type,
406 lengthf := 0, /* we assume encoder overwrites this */
407 teid := teid,
Harald Welte811651e2017-08-05 15:25:06 +0200408 opt_part := {
409 sequenceNumber := int2oct(seq, 2),
410 npduNumber := '00'O,
411 nextExtHeader := '00'O,
412 gTPU_extensionHeader_List := omit
413 },
Harald Welte3af89482017-08-04 16:20:23 +0200414 gtpu_IEs := ies
415 }
416
417 template Gtp1uUnitdata tr_GTPU_MsgType(template GtpPeer peer, template OCT1 msg_type, template OCT4 teid) := {
418 peer := peer,
419 gtpu := tr_GTP1U_PDU(msg_type, teid)
420 }
421
422
Harald Welte231b9412017-08-09 17:16:31 +0200423 /* template matching reception of GTP-U echo-request */
Harald Welte3af89482017-08-04 16:20:23 +0200424 template Gtp1uUnitdata tr_GTPU_PING(template GtpPeer peer) := tr_GTPU_MsgType(peer, echoRequest, '00000000'O);
425
Harald Welte231b9412017-08-09 17:16:31 +0200426 /* template matching reception of GTP-U GPDU */
427 template GTPU_IEs t_GPDU(template octetstring data) := {
428 g_PDU_IEs := {
429 data := data
430 }
431 }
432 template Gtp1uUnitdata tr_GTPU_GPDU(template GtpPeer peer, template OCT4 teid, template octetstring data := ?) := {
433 peer := peer,
434 gtpu := tr_GTP1U_PDU('FF'O, teid, t_GPDU(data))
435 }
436
Harald Welte3af89482017-08-04 16:20:23 +0200437 template GTPU_IEs ts_UEchoRespPDU(OCT1 restart_counter) := {
438 echoResponse_IEs := {
439 recovery_gtpu := {
440 type_gtpu := '00'O, /* we assume encoder fixes? */
441 restartCounter := restart_counter
442 },
443 private_extension_gtpu := omit
444 }
445 }
446
447 /* master template for sending a GTP-U echo response */
Harald Welte811651e2017-08-05 15:25:06 +0200448 template Gtp1uUnitdata ts_GTPU_PONG(GtpPeer peer, uint16_t seq, OCT1 rest_ctr) := {
Harald Welte3af89482017-08-04 16:20:23 +0200449 peer := peer,
Harald Welte811651e2017-08-05 15:25:06 +0200450 gtpu := ts_GTP1U_PDU(echoResponse, seq, '00000000'O, valueof(ts_UEchoRespPDU(rest_ctr)))
Harald Welte3af89482017-08-04 16:20:23 +0200451 }
452
Harald Welte811651e2017-08-05 15:25:06 +0200453 /* master template for sending a GTP-U user plane data */
454 template Gtp1uUnitdata ts_GTP1U_GPDU(GtpPeer peer, uint16_t seq, OCT4 teid, octetstring data) := {
455 peer := peer,
456 gtpu := ts_GTP1U_PDU('FF'O, seq, teid, { g_PDU_IEs := { data := data }})
457 }
Harald Welte3af89482017-08-04 16:20:23 +0200458
Harald Welte94ade362017-08-04 00:36:55 +0200459 /* Altstep implementing responses to any incoming echo requests */
460 altstep pingpong() runs on GT_CT {
461 var Gtp1cUnitdata ud;
Harald Welte3af89482017-08-04 16:20:23 +0200462 var Gtp1uUnitdata udu;
Harald Welte94ade362017-08-04 00:36:55 +0200463 [] GTPC.receive(tr_GTPC_PING(?)) -> value ud {
Harald Welte811651e2017-08-05 15:25:06 +0200464 var uint16_t seq := oct2int(ud.gtpc.opt_part.sequenceNumber);
465 GTPC.send(ts_GTPC_PONG(ud.peer, seq, '00'O));
Harald Welte94ade362017-08-04 00:36:55 +0200466 repeat;
467 };
Harald Welte3af89482017-08-04 16:20:23 +0200468 [] GTPU.receive(tr_GTPU_PING(?)) -> value udu {
Harald Welte811651e2017-08-05 15:25:06 +0200469 var uint16_t seq := oct2int(udu.gtpu.opt_part.sequenceNumber);
470 GTPU.send(ts_GTPU_PONG(udu.peer, seq, '00'O));
Harald Welte3af89482017-08-04 16:20:23 +0200471 };
Harald Welte94ade362017-08-04 00:36:55 +0200472 [] T_default.timeout { setverdict(fail); };
473 }
474
Harald Welte811651e2017-08-05 15:25:06 +0200475 /* 'internet' in DNS encoding */
Harald Welte94ade362017-08-04 00:36:55 +0200476 template octetstring t_ApnInternet := '08696E7465726E6574'O;
477
Harald Welte811651e2017-08-05 15:25:06 +0200478 /* return random integer between 0 and max */
479 function f_rnd_int(integer max) return integer {
480 return float2int(rnd()*int2float(max));
481 }
482
483 /* return random NSAPI */
484 function f_rnd_nsapi() return BIT4 {
485 return int2bit(f_rnd_int(16), 4);
486 }
487
488 /* return random TEI[DC] */
489 function f_rnd_tei() return OCT4 {
490 return int2oct(f_rnd_int(4294967296), 4);
491 }
492
493 /* define an (internal) representation of a PDP context */
494 template PdpContext t_DefinePDP(hexstring imsi, octetstring msisdn, octetstring apn,
495 EndUserAddress eua) := {
496 imsi := imsi,
497 msisdn := msisdn,
498 nsapi := f_rnd_nsapi(),
499 apn := apn,
Harald Welteed7a1772017-08-09 20:26:20 +0200500 pco_req := omit,
Harald Welte811651e2017-08-05 15:25:06 +0200501 eua := eua,
502 teid := f_rnd_tei(),
503 teic := f_rnd_tei(),
504 d_seq_nr := 0,
505 c_seq_nr := 0
506 }
507
508 /* send GTP-C for a given context and increment sequence number */
509 function f_send_gtpc(inout PdpContext ctx, in template Gtp1cUnitdata data) runs on GT_CT {
510 GTPC.send(data);
511 ctx.c_seq_nr := ctx.c_seq_nr + 1;
512 }
513
514 /* send GTP-U for a given context and increment sequence number */
Harald Welte231b9412017-08-09 17:16:31 +0200515 function f_send_gtpu(inout PdpContext ctx, in octetstring data) runs on GT_CT {
516 GTPU.send(ts_GTP1U_GPDU(g_peer_u, ctx.d_seq_nr, ctx.teid_remote, data));
Harald Welte811651e2017-08-05 15:25:06 +0200517 ctx.d_seq_nr := ctx.d_seq_nr + 1;
518 }
519
520 /* send a PDP context activation */
521 function f_pdp_ctx_act(inout PdpContext ctx) runs on GT_CT {
Harald Welte94ade362017-08-04 00:36:55 +0200522 var Gtp1cUnitdata ud;
Harald Welte94ade362017-08-04 00:36:55 +0200523 var default d;
524
525 log("sending CreatePDP");
Harald Welte811651e2017-08-05 15:25:06 +0200526 f_send_gtpc(ctx, ts_GTPC_CreatePDP(g_peer_c, ctx.c_seq_nr, ctx.imsi, g_restart_ctr,
527 ctx.teid, ctx.teic, ctx.nsapi, ctx.eua, ctx.apn,
Harald Welteed7a1772017-08-09 20:26:20 +0200528 g_sgsn_ip_c, g_sgsn_ip_u, ctx.msisdn, ctx.pco_req));
Harald Welte94ade362017-08-04 00:36:55 +0200529 T_default.start;
Harald Welte94ade362017-08-04 00:36:55 +0200530 d := activate(pingpong());
531 alt {
Harald Welte811651e2017-08-05 15:25:06 +0200532 [] GTPC.receive(tr_GTPC_MsgType(g_peer_c, createPDPContextResponse, ctx.teic)) -> value ud {
533 var CreatePDPContextResponse cpr := ud.gtpc.gtpc_pdu.createPDPContextResponse;
534 if (cpr.cause.causevalue == '80'O) {
535 ctx.teid_remote := cpr.teidDataI.teidDataI;
536 ctx.teic_remote := cpr.teidControlPlane.teidControlPlane;
Harald Welte231b9412017-08-09 17:16:31 +0200537 ctx.eua := cpr.endUserAddress;
Harald Welteed7a1772017-08-09 20:26:20 +0200538 ctx.pco_neg := cpr.protConfigOptions;
Harald Welte94ade362017-08-04 00:36:55 +0200539 setverdict(pass);
540 } else {
541 setverdict(fail);
542 }
543 }
544 }
545 deactivate(d);
Harald Welte811651e2017-08-05 15:25:06 +0200546 T_default.stop;
Harald Welte94ade362017-08-04 00:36:55 +0200547 }
548
Harald Welte811651e2017-08-05 15:25:06 +0200549 function f_pdp_ctx_del(PdpContext ctx, template BIT1 teardown_ind) runs on GT_CT {
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200550 var Gtp1cUnitdata ud;
551 var default d;
552
Harald Welte811651e2017-08-05 15:25:06 +0200553 f_send_gtpc(ctx, ts_GTPC_DeletePDP(g_peer_c, ctx.c_seq_nr, ctx.teic_remote, ctx.nsapi, teardown_ind));
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200554 T_default.start;
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200555 d := activate(pingpong());
556 alt {
Harald Welte811651e2017-08-05 15:25:06 +0200557 [] GTPC.receive(tr_GTPC_MsgType(g_peer_c, deletePDPContextResponse, ctx.teic)) -> value ud {
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200558 if (ud.gtpc.gtpc_pdu.deletePDPContextResponse.cause.causevalue == '80'O) {
559 setverdict(pass);
560 } else {
561 setverdict(fail);
562 }
563 }
564 }
565 deactivate(d);
Harald Welte811651e2017-08-05 15:25:06 +0200566 T_default.stop;
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200567 }
Harald Welte811651e2017-08-05 15:25:06 +0200568 /* IPv6 router solicitation fe80::2 -> ff02::2 from 02:88:b5:1f:25:59 */
569 const octetstring c_router_solicit := '6000000000103afffe800000000000000000000000000002ff02000000000000000000000000000285009f2b0000000001010288b51f2559'O;
570 /* IPv6 neighbor solicitation fe80::2 -> ff02::1:ff00:2 from 02:88:b5:1f:25:59 */
571 const octetstring c_neigh_solicit:= '6000000000203afffe800000000000000000000000000002ff0200000000000000000001ff00000287009f9600000000fe80000000000000000000000000000201010288b51f2559'O;
Harald Weltef1e0d5a2017-08-05 08:51:22 +0200572
Harald Welte231b9412017-08-09 17:16:31 +0200573 /* template to generate a 'Prefix Information' ICMPv6 option */
574 template OptionField ts_ICMP6_OptPrefix(OCT16 prefix, INT1 prefix_len) := {
575 prefixInformation := {
576 typeField := 3,
577 lengthIndicator := 8,
578 prefixLength := prefix_len,
579 reserved1 := '000000'B,
580 a_Bit := '0'B,
581 l_Bit := '0'B,
582 validLifetime := oct2int('FFFFFFFF'O),
583 preferredLifetime := oct2int('FFFFFFFF'O),
584 reserved2 := '00000000'O,
585 prefix := prefix
586 }
587 }
588
589 /* template for an ICMPv6 router solicitation */
590 template PDU_ICMPv6 ts_ICMPv6_RS := {
591 routerSolicitation := {
592 typeField := 133,
593 code := 0,
594 checksum := '0000'O,
595 reserved := '00000000'O,
596 /* TODO: do we need 'Source link-layer address' ? */
597 options := omit
598 }
599 }
600
601 /* template for an ICMPv6 router advertisement */
602 template PDU_ICMPv6 ts_ICMPv6_RA(OCT16 prefix, INT1 prefix_len) := {
603 routerAdvertisement := {
604 typeField := 134,
605 code := 0,
606 checksum := '0000'O,
607 curHopLimit := ?,
608 reserved := '000000'B,
609 o_Bit := '0'B,
610 m_Bit := '0'B,
611 routerLifetime := oct2int('FFFF'O),
612 reachableTime := oct2int('FFFFFFFF'O),
613 retransTimer := oct2int('FFFFFFFF'O),
614 options := {
615 ts_ICMP6_OptPrefix(prefix, prefix_len)
616 }
617 }
618 }
619
620 template PDU_ICMPv6 ts_ICMPv6_NS(OCT16 target_addr) := {
621 neighborSolicitation := {
622 typeField := 135,
623 code := 0,
624 checksum := '0000'O,
625 reserved := '00000000'O,
626 targetAddress := target_addr,
627 /* TODO: do we need 'Source link-layer address' ? */
628 options := omit
629 }
630 }
631
632 /* derive ICMPv6 link-local address from lower 64bit of link_id */
633 /* template for receiving/matching an ICMPv6 'Prefix Information' option */
634 template OptionField tr_ICMP6_OptPrefix(template OCT16 prefix, template INT1 prefix_len) := {
635 prefixInformation := {
636 typeField := 3,
637 lengthIndicator := 4,
638 prefixLength := prefix_len,
639 reserved1 := ?,
640 a_Bit := ?,
641 l_Bit := ?,
642 validLifetime := ?,
643 preferredLifetime := ?,
644 reserved2 := ?,
645 prefix := prefix
646 }
647 }
648
649 /* template for receiving/matching an ICMPv6 router advertisement */
650 template PDU_ICMPv6 tr_ICMPv6_RA(template OCT16 prefix, template INT1 prefix_len) := {
651 routerAdvertisement := {
652 typeField := 134,
653 code := 0,
654 checksum := ?,
655 curHopLimit := ?,
656 reserved := ?,
657 o_Bit := '0'B,
658 m_Bit := '0'B,
659 routerLifetime := ?,
660 reachableTime := ?,
661 retransTimer := ?,
662 options := {
663 tr_ICMP6_OptPrefix(prefix, prefix_len)
664 }
665 }
666 }
667
668 /* template to construct IPv6_packet from input arguments, ready for use in f_IPv6_enc() */
669 template IPv6_packet ts_IP6(OCT16 srcaddr, OCT16 dstaddr, LIN1 nexthead, octetstring payload, LIN1 hlim := 255) := {
670 header := {
671 ver := 6,
672 trclass := 0,
673 flabel := 0,
674 plen := 0,
675 nexthead := nexthead,
676 hlim := hlim,
677 srcaddr := srcaddr,
678 dstaddr := dstaddr
679 },
680 ext_headers := omit,
681 payload := payload
682 }
683
684 function f_ipv6_link_local(in OCT16 link_id) return OCT16 {
685 return 'FE80000000000000'O & substr(link_id, 8, 8);
686 }
687
688 /* Compute solicited-node multicast address as per RFC4291 2.7.1 */
689 function f_ipv6_sol_node_mcast(in OCT16 addr) return OCT16 {
690 return 'FF0200000000000000000001FF'O & substr(addr, 13, 3);
691 }
692
693 /* generate and encode ICMPv6 router solicitation */
694 function f_gen_icmpv6_router_solicitation(in OCT16 link_id) return octetstring {
695 const OCT16 c_ip6_all_router_mcast := 'FF020000000000000000000000000002'O;
696 var OCT16 saddr := f_ipv6_link_local(link_id);
697
698 var octetstring tmp;
699 tmp := f_enc_PDU_ICMPv6(valueof(ts_ICMPv6_RS), saddr, c_ip6_all_router_mcast);
700 var IPv6_packet ip6 := valueof(ts_IP6(saddr, c_ip6_all_router_mcast, 58, tmp));
701
702 return f_IPv6_enc(ip6);
703 }
704
705 /* create ICMPv6 router solicitation deriving link-id from PDP Context EUA */
706 function f_icmpv6_rs_for_pdp(in PdpContext ctx) return octetstring {
707 var OCT16 interface_id := ctx.eua.endUserAddress.endUserAddressIPv6.ipv6_address;
708 return f_gen_icmpv6_router_solicitation(interface_id);
709 }
710
711 /* generate and encode ICMPv6 neighbor solicitation */
712 function f_gen_icmpv6_neigh_solicit(in OCT16 saddr, in OCT16 daddr, in OCT16 tgt_addr) return octetstring {
713 var octetstring tmp;
714 tmp := f_enc_PDU_ICMPv6(valueof(ts_ICMPv6_NS(tgt_addr)), saddr, daddr);
715 var IPv6_packet ip6 := valueof(ts_IP6(saddr, daddr, 58, tmp));
716 return f_IPv6_enc(ip6);
717 }
718
719 /* generate and encode ICMPv6 neighbor solicitation for PDP Context */
720 function f_gen_icmpv6_neigh_solicit_for_pdp(in PdpContext ctx) return octetstring {
721 var OCT16 interface_id := ctx.eua.endUserAddress.endUserAddressIPv6.ipv6_address;
722 var OCT16 link_local := f_ipv6_link_local(interface_id);
723 var OCT16 daddr := f_ipv6_sol_node_mcast(link_local);
724
725 return f_gen_icmpv6_neigh_solicit(link_local, daddr, link_local);
726 }
727
728 /* wait for GGSN to send us an ICMPv6 router advertisement */
729 function f_wait_rtr_adv(PdpContext ctx) runs on GT_CT {
730 var Gtp1uUnitdata ud;
731 T_default.start;
732 alt {
733 //'6???????????3aff'O
734 [] GTPU.receive(tr_GTPU_GPDU(g_peer_u, ?)) -> value ud {
735 var octetstring gpdu := ud.gtpu.gtpu_IEs.g_PDU_IEs.data;
736 var IPv6_packet ip6 := f_IPv6_dec(gpdu);
737 if (ip6.header.ver != 6 or ip6.header.nexthead != 58 or ip6.header.hlim != 255) {
738 repeat;
739 }
740 var PDU_ICMPv6 icmp6 := f_dec_PDU_ICMPv6(ip6.payload);
741 if (not match(icmp6, tr_ICMPv6_RA(?, 64))) {
742 repeat;
743 }
744 ctx.ip6_prefix := icmp6.routerAdvertisement.options[0].prefixInformation.prefix;
745 log("RA with /64 prefix ", ctx.ip6_prefix);
746 }
747 [] GTPU.receive(tr_GTPU_GPDU(?, ?)) { repeat; }
748 [] GTPU.receive { setverdict(fail); }
749 [] T_default.timeout { setverdict(fail); }
750 }
751 T_default.stop;
752 }
753
Harald Welteed7a1772017-08-09 20:26:20 +0200754 testcase TC_pdp6_act_deact() runs on GT_CT {
Harald Welte94ade362017-08-04 00:36:55 +0200755 f_init();
Harald Welte231b9412017-08-09 17:16:31 +0200756
Harald Welte811651e2017-08-05 15:25:06 +0200757 var PdpContext ctx := valueof(t_DefinePDP('262420123456789'H, '1234'O, valueof(t_ApnInternet), valueof(t_EuaIPv6Dyn)));
758 f_pdp_ctx_act(ctx);
Harald Welteed7a1772017-08-09 20:26:20 +0200759 f_pdp_ctx_del(ctx, '1'B);
760 }
761
762 testcase TC_pdp6_act_deact_pcodns() runs on GT_CT {
763 f_init();
764
765 var PdpContext ctx := valueof(t_DefinePDP('262420123456789'H, '1234'O, valueof(t_ApnInternet), valueof(t_EuaIPv6Dyn)));
766 ctx.pco_req := valueof(ts_PCO_IPv6_DNS);
767 f_pdp_ctx_act(ctx);
768 f_pdp_ctx_del(ctx, '1'B);
769 }
770
771 testcase TC_pdp6_act_deact_icmp6() runs on GT_CT {
772 f_init();
773
774 var PdpContext ctx := valueof(t_DefinePDP('262420123456789'H, '1234'O, valueof(t_ApnInternet), valueof(t_EuaIPv6Dyn)));
775 ctx.pco_req := valueof(ts_PCO_IPv6_DNS);
776 f_pdp_ctx_act(ctx);
Harald Welte231b9412017-08-09 17:16:31 +0200777
778 //f_send_gtpu(ctx, c_router_solicit);
779 //f_send_gtpu(ctx, c_neigh_solicit);
780
781 f_send_gtpu(ctx, f_icmpv6_rs_for_pdp(ctx));
782 f_wait_rtr_adv(ctx);
783 f_send_gtpu(ctx, f_gen_icmpv6_neigh_solicit_for_pdp(ctx));
784
Harald Welte811651e2017-08-05 15:25:06 +0200785 f_pdp_ctx_del(ctx, '1'B);
Harald Welte94ade362017-08-04 00:36:55 +0200786 }
787
Harald Welteed7a1772017-08-09 20:26:20 +0200788 testcase TC_pdp4_act_deact() runs on GT_CT {
789 f_init();
790 var PdpContext ctx := valueof(t_DefinePDP('262420123456789'H, '1234'O, valueof(t_ApnInternet), valueof(t_EuaIPv4Dyn)));
791 f_pdp_ctx_act(ctx);
792 f_pdp_ctx_del(ctx, '1'B);
793 }
794
795 testcase TC_pdp4_act_deact_ipcp() runs on GT_CT {
796 f_init();
797 var PdpContext ctx := valueof(t_DefinePDP('262420123456789'H, '1234'O, valueof(t_ApnInternet), valueof(t_EuaIPv4Dyn)));
798 f_pdp_ctx_act(ctx);
799 f_pdp_ctx_del(ctx, '1'B);
800 }
801
802 testcase TC_pdp4_act_deact_pcodns() runs on GT_CT {
803 f_init();
804 var PdpContext ctx := valueof(t_DefinePDP('262420123456789'H, '1234'O, valueof(t_ApnInternet), valueof(t_EuaIPv4Dyn)));
805 f_pdp_ctx_act(ctx);
806 f_pdp_ctx_del(ctx, '1'B);
807 }
808
Harald Welte94ade362017-08-04 00:36:55 +0200809 control {
Harald Welteed7a1772017-08-09 20:26:20 +0200810 execute(TC_pdp4_act_deact());
811 execute(TC_pdp4_act_deact_ipcp());
812 execute(TC_pdp4_act_deact_pcodns());
813
814 execute(TC_pdp6_act_deact());
815 execute(TC_pdp6_act_deact_pcodns());
816 execute(TC_pdp6_act_deact_icmp6());
Harald Welte94ade362017-08-04 00:36:55 +0200817 }
Harald Welte379d45a2017-08-03 09:55:15 +0200818}