1# GTP unit tests
2#
3# Type the following command to launch start the tests:
4# $ test/run_tests -P "load_contrib('gtp')" -t scapy/contrib/gtp.uts
5
6+ GTPv1
7
8= GTPHeader, basic instanciation
9
10a = GTPHeader()
11assert a.version == 1
12assert a.E == a.S == a.PN == 0
13
14= GTP_U_Header detection
15
16a = GTPHeader(raw(GTP_U_Header()/GTPErrorIndication()))
17assert isinstance(a, GTP_U_Header)
18
19= GTPCreatePDPContextRequest(), basic instanciation
20gtp = IP(src="127.0.0.1")/UDP(dport=2123)/GTPHeader(teid=2807)/GTPCreatePDPContextRequest()
21gtp.dport == 2123 and gtp.teid == 2807 and len(gtp.IE_list) == 5
22
23= GTPCreatePDPContextRequest(), basic dissection
24~ random_weird_py3
25random.seed(0x2807)
26assert raw(gtp) in [b"E\x00\x00K\x00\x01\x00\x00@\x11|\x9f\x7f\x00\x00\x01\x7f\x00\x00\x01\x08K\x08K\x007\x1c\xdb0\x10\x00'\x00\x00\n\xf7\x10A\xb77-\x14\x0f\x85\x00\x04\xd6!-b\x85\x00\x04\xbf\xf8\xc9Z\x87\x00\x0faWdWRWX0qEAXLPE",
27                    b"E\x00\x00K\x00\x01\x00\x00@\x11|\x9f\x7f\x00\x00\x01\x7f\x00\x00\x01\x08K\x08K\x007J\r0\x10\x00'\x00\x00\n\xf7\x10\xab\xec\x14Y\x14\n\x85\x00\x04\xbb((,\x85\x00\x04V*\xe0\xff\x87\x00\x0f0eQSJUqm06eIP1Q"]
28
29= GTPV1UpdatePDPContextRequest(), dissect
30h = "3333333333332222222222228100a38408004588006800000000fd1134820a2a00010a2a00024aa5084b005408bb32120044ed99aea9386f0000100000530514058500040a2a00018500040a2a000187000c0213921f739680fe74f2ffff94000130970001019800080112f41004d204d29900024000b6000101"
31gtp = Ether(hex_bytes(h))
32assert gtp.gtp_type == 18
33assert gtp.next_ex == 0
34
35= GTPV1UpdatePDPContextResponse(), dissect
36h = "3333333333332222222222228100838408004588005400000000fd1182850a2a00010a2a0002084b084b00406b46321300305843da17f07300000180100000032c7f4a0f58108500040a2a00018500040a2a000187000f0213921f7396d1fe7482ffff004a00f7a71e0a"
37gtp = Ether(hex_bytes(h))
38gtp.gtp_type == 19
39
40= IE_Cause(), dissect
41h = "3333333333332222222222228100838408004588005400000000fd1182850a2a00010a2a0002084b084b00406b4632130030f15422be19ed0000018010000046a97f4a0f58108500040a2a00018500040a2a000187000f0213921f7396d1fe7482ffff004a00f7a71e0a"
42gtp = Ether(hex_bytes(h))
43ie = gtp.IE_list[0]
44ie.ietype == 1 and ie.CauseValue == 128
45
46= IE_Cause(), basic instantiation
47ie = IE_Cause(CauseValue='IMSI not known')
48ie.ietype == 1 and ie.CauseValue == 194
49
50= IE_IMSI(), dissect
51h = "333333333333222222222222810083840800458800ba00000000fc1185060a2a00010a2a00024ace084b00a68204321000960eeec43e99ae00000202081132547600000332f42004d27b0ffc102c0787b611b2f9023914051a0400800002f1218300070661616161616184001480802110010100108106000000008306000000008500040a2a00018500040a2a00018600079111111111111187000d0213621f7396737374f2ffff0094000120970001029800080032f42004d204d299000240009a00081111111111110000d111193b"
52gtp = Ether(hex_bytes(h))
53ie = gtp.IE_list[0]
54ie.ietype == 2 and ie.imsi == b'2080112345670000'
55
56= IE_IMSI(), basic instantiation
57ie = IE_IMSI(imsi='208103397660354')
58ie.ietype == 2 and ie.imsi == b'208103397660354'
59
60= IE_Routing(), dissect
61h = "33333333333322222222222281008384080045880072647100003e11dcf60a2a00010a2a0002084b084b005e78d93212004ef51a4ac3a291ff000332f42004d27b10eb3981b414058500040a2a00018500040a2a000187000f0213921f7396d1fe7482ffff004a0094000110970001019800080132f42004d204d299000240fcb60001015bf2090f"
62gtp = Ether(hex_bytes(h))
63ie = gtp.IE_list[0]
64ie.ietype == 3 and ie.MCC == b'234' and ie.MNC == b'02' and ie.LAC == 1234 and ie.RAC == 123
65
66= IE_Routing(), basic instantiation
67ie = IE_Routing(MCC='234', MNC='02', LAC=1234, RAC=123)
68ie.ietype == 3 and ie.MCC == b'234' and ie.MNC == b'02' and ie.LAC == 1234 and ie.RAC == 123
69
70= IE_Recovery(), dissect
71h = "3333333333332222222222228100038408004500002ac6e60000fd11ccbc0a2a00010a2a0002084b084b001659db32020006c192a26c8cb400000e0e00000000f4b40b31"
72gtp = Ether(hex_bytes(h))
73ie = gtp.IE_list[0]
74ie.ietype == 14 and ie.restart_counter == 14
75
76= IE_Recovery(), basic instantiation
77ie = IE_Recovery(restart_counter=14)
78ie.ietype == 14 and ie.restart_counter == 14
79
80= IE_SelectionMode(), dissect
81h = "333333333333222222222222810083840800458800c500000000fc1184df0a2a00010a2a00024a55084b00b1f62a321000a11c025b77dccc00000202081132547600000332f42004d27b0ffc1055080923117c347b6a14051a0a00800002f1218300070661616161616184001d8080211001000010810600000000830600000000000d00000a000005008500040a2a00018500040a2a00018600079111111111111187000f0213921f7396d3fe74f2ffff00640094000120970001019800080132f42004d204d299000240009a00081111111111110000eea69220"
82gtp = Ether(hex_bytes(h))
83ie = gtp.IE_list[2]
84ie.ietype == 15 and ie.SelectionMode == 252
85
86= IE_SelectionMode(), basic instantiation
87ie = IE_SelectionMode(SelectionMode=252)
88ie.ietype == 15 and ie.SelectionMode == 252
89
90= IE_TEIDI(), dissect
91h = "3333333333332222222222228100838408004588005400000000fd1182850a2a00010a2a0002084b084b00406b46321300303f0ff4fb966f00000180109a0f08ef7f3af826978500040a2a00018500040a2a000187000f0213921f7396d1fe7482ffff004a00f7a71e0a"
92gtp = Ether(hex_bytes(h))
93ie = gtp.IE_list[1]
94ie.ietype == 16 and ie.TEIDI == 0x9a0f08ef
95
96= IE_TEIDI(), basic instantiation
97ie = IE_TEIDI(TEIDI=0x9a0f08ef)
98ie.ietype == 16 and ie.TEIDI == 0x9a0f08ef
99
100= IE_TEICP(), dissect
101h = "333333333333222222222222810083840800458800c500000000fc1184df0a2a00010a2a00024a55084b00b1f62a321000a1b75eb617464800000202081132547600000332f42004d27b0ffc10db5c765711ba5d87ba14051a0a00800002f1218300070661616161616184001d8080211001000010810600000000830600000000000d00000a000005008500040a2a00018500040a2a00018600079111111111111187000f0213921f7396d3fe74f2ffff00640094000120970001019800080132f42004d204d299000240009a00081111111111110000eea69220"
102gtp = Ether(hex_bytes(h))
103ie = gtp.IE_list[4]
104ie.ietype == 17 and ie.TEICI == 0xba5d87ba
105
106= IE_TEICP(), basic instantiation
107ie = IE_TEICP(TEICI=0xba5d87ba)
108ie.ietype == 17 and ie.TEICI == 0xba5d87ba
109
110= IE_Teardown(), dissect
111h = "3333333333332222222222228100838408004588002c00000000fd1184640a2a00010a2a00023d66084b00184c2232140008ba66ce5b6efe000013ff14050000c309006c"
112gtp = Ether(hex_bytes(h))
113ie = gtp.IE_list[0]
114ie.ietype == 19 and ie.indicator == 255
115
116= IE_Teardown(), basic instantiation
117ie = IE_Teardown(indicator='True')
118ie.ietype == 19 and ie.indicator == 255
119
120= IE_NSAPI(), dissect
121h = "3333333333332222222222228100838408004588002c00000000fd1184640a2a00010a2a00023d66084b00184c2232140008dafc273ee7ab000013ff14050000c309006c"
122gtp = Ether(hex_bytes(h))
123ie = gtp.IE_list[1]
124ie.ietype == 20 and ie.NSAPI == 5
125
126= IE_NSAPI(), basic instantiation
127ie = IE_NSAPI(NSAPI=5)
128ie.ietype == 20 and ie.NSAPI == 5
129
130= IE_ChargingCharacteristics(), dissect
131h = "333333333333222222222222810083840800458800bc00000000fc1184c90a2a00010a2a00024acf084b00a87bbb32100098a3e2565004a400000202081132547600000332f42004d27b0ffc10b87f17ad11c53c5e1b14051a0400800002f1218300070661616161616184001480802110010000108106000000008306000000008500040a2a00018500040a2a00018600079111111111111187000f0213921f7396d3fe74f2ffff004a0094000120970001019800080132f42004d204d299000240009a00081111111111110000951c5bbe"
132gtp = Ether(hex_bytes(h))
133ie = gtp.IE_list[6]
134ie.ietype == 26 and ie.normal_charging == 0 and ie.prepaid_charging == 1 and ie.flat_rate_charging == 0
135
136= IE_ChargingCharacteristics(), basic instantiation
137ie = IE_ChargingCharacteristics(
138    normal_charging=0, prepaid_charging=1, flat_rate_charging=0)
139ie.ietype == 26 and ie.normal_charging == 0 and ie.prepaid_charging == 1 and ie.flat_rate_charging == 0
140
141= IE_TraceReference(), basic instantiation
142ie = IE_TraceReference(Trace_reference=0x1212)
143ie.ietype == 27 and ie.Trace_reference == 0x1212
144
145= IE_TraceType(), basic instantiation
146ie = IE_TraceType(Trace_type=0x1212)
147ie.ietype == 28 and ie.Trace_type == 0x1212
148
149= IE_ChargingId(), dissect
150h = "3333333333332222222222228100838408004588005400000000fd1182850a2a00010a2a0002084b084b00406b4632130030e77ffb7e30410000018010ed654ff37fff1bc3f28500040a2a00018500040a2a000187000f0213921f7396d1fe7482ffff004a00f7a71e0a"
151gtp = Ether(hex_bytes(h))
152ie = gtp.IE_list[2]
153ie.ietype == 127 and ie.Charging_id == 0xff1bc3f2
154
155= IE_ChargingId(), basic instantiation
156ie = IE_ChargingId(Charging_id=0xff1bc3f2)
157ie.ietype == 127 and ie.Charging_id == 0xff1bc3f2
158
159= IE_EndUserAddress(), dissect
160h = "3333333333332222222222228100838408004588008500000000fd11840b0a2a00010a2a0002084b4a6c00717c8a32110061c1b9728f356a0000018008fe10af709e9011e3cb6a4b7fb60e1b28800006f1210a2a00038400218080210a0301000a03060ab0aa93802110030100108106ac14020a8306ac1402278500040a2a00018500040a2a000187000c0213621f7396486874f2ffff44ded108"
161gtp = Ether(hex_bytes(h))
162ie = gtp.IE_list[5]
163ie.ietype == 128 and ie.length == 6 and ie.PDPTypeOrganization == 1 and ie.PDPTypeNumber == 0x21 and ie.PDPAddress == '10.42.0.3'
164
165= IE_EndUserAddress(), basic instantiation
166ie = IE_EndUserAddress(
167    length=6, PDPTypeOrganization=1, PDPTypeNumber=0x21, PDPAddress='10.42.0.3')
168ie.ietype == 128 and ie.length == 6 and ie.PDPTypeOrganization == 1 and ie.PDPTypeNumber == 0x21 and ie.PDPAddress == '10.42.0.3'
169
170= IE_AccessPointName(), dissect
171h = "333333333333222222222222810083840800458800bc00000000fc1184c90a2a00010a2a00024acf084b00a87bbb3210009867fe972185e800000202081132547600000332f42004d27b0ffc1093b20c3f11940eb2bf14051a0400800002f1218300070661616161616184001480802110010000108106000000008306000000008500040a2a00018500040a2a00018600079111111111111187000f0213921f7396d3fe74f2ffff004a0094000120970001019800080132f42004d204d299000240009a000811111111111100001b1212951c5bbe"
172gtp = Ether(hex_bytes(h))
173ie = gtp.IE_list[8]
174ie.ietype == 131 and ie.APN == b'aaaaaa'
175
176= IE_AccessPointName(), basic instantiation
177ie = IE_AccessPointName(APN='aaaaaa')
178ie.ietype == 131 and ie.APN == b'aaaaaa'
179
180= IE_ProtocolConfigurationOptions(), dissect
181h = "333333333333222222222222810083840800458800c300000000fc1184e50a2a00010a2a00024a4d084b00af41993210009fdef90e15440900000202081132547600000332f42004d27b0ffc10c29998b81145c6c9ee14051a0a00800002f1218300070661616161616184001d80c02306010100060000802110010100108106000000008306000000008500040a2a00018500040a2a00018600079111111111111187000d0213621f73967373741affff0094000120970001029800080032f42004d204d299000240009a0008111111111111000081182fb2"
182gtp = Ether(hex_bytes(h))
183ie = gtp.IE_list[9]
184ie.ietype == 132 and ie.Protocol_Configuration == b'\x80\xc0#\x06\x01\x01\x00\x06\x00\x00\x80!\x10\x01\x01\x00\x10\x81\x06\x00\x00\x00\x00\x83\x06\x00\x00\x00\x00'
185
186= IE_ProtocolConfigurationOptions(), basic instantiation
187ie = IE_ProtocolConfigurationOptions(
188    length=29, Protocol_Configuration=b'\x80\xc0#\x06\x01\x01\x00\x06\x00\x00\x80!\x10\x01\x01\x00\x10\x81\x06\x00\x00\x00\x00\x83\x06\x00\x00\x00\x00')
189ie.ietype == 132 and ie.Protocol_Configuration == b'\x80\xc0#\x06\x01\x01\x00\x06\x00\x00\x80!\x10\x01\x01\x00\x10\x81\x06\x00\x00\x00\x00\x83\x06\x00\x00\x00\x00'
190
191= IE_GSNAddress(), dissect
192h = "3333333333332222222222228100838408004588005400000000fd1182850a2a00010a2a0002084b084b00406b463213003031146413c18000000180109181ba027fcf701a8c8500040a2a00018500040a2a000187000f0213921f7396d1fe7482ffff004a00f7a71e0a"
193gtp = Ether(hex_bytes(h))
194ie = gtp.IE_list[3]
195ie.ietype == 133 and ie.address == '10.42.0.1'
196
197= IE_GSNAddress(), basic instantiation
198ie = IE_GSNAddress(address='10.42.0.1')
199ie.ietype == 133 and ie.address == '10.42.0.1'
200
201= IE_MSInternationalNumber(), dissect
202h = "333333333333222222222222810083840800458800c300000000fc1184e50a2a00010a2a00024a4d084b00af41993210009f79504a3e048e00000202081132547600000332f42004d27b0ffc10a692773d1158da9e2214051a0a00800002f1218300070661616161616184001d80c02306010100060000802110010100108106000000008306000000008500040a2a00018500040a2a00018600079111111111111187000d0213621f73967373741affff0094000120970001029800080032f42004d204d299000240009a0008111111111111000081182fb2"
203gtp = Ether(hex_bytes(h))
204ie = gtp.IE_list[12]
205ie.ietype == 134 and ie.flags == 145 and ie.digits == b'111111111111'
206
207= IE_MSInternationalNumber(), basic instantiation
208ie = IE_MSInternationalNumber(flags=145, digits='111111111111')
209ie.ietype == 134 and ie.flags == 145 and ie.digits == b'111111111111'
210
211= IE_QoS(), dissect
212h = "3333333333332222222222228100838408004588005400000000fd1182850a2a00010a2a0002084b084b00406b4632130030afe9d3a3317e0000018010bd82f3997f9febcaf58500040a2a00018500040a2a000187000f0213921f7396d1fe7482ffff004a00f7a71e0a"
213gtp = Ether(hex_bytes(h))
214ie = gtp.IE_list[5]
215ie.ietype == 135 and ie.allocation_retention_prioiry == 2 and ie.delay_class == 2 and ie.traffic_class == 3
216
217= IE_QoS(), basic instantiation
218ie = IE_QoS(
219    allocation_retention_prioiry=2, delay_class=2, traffic_class=3)
220ie.ietype == 135 and ie.allocation_retention_prioiry == 2 and ie.delay_class == 2 and ie.traffic_class == 3
221
222= IE_CommonFlags(), dissect
223h = "3333333333332222222222228100a38408004588006800000000fd1134820a2a00010a2a00024aa5084b005408bb32120044623f97e3ac610000104d82c69214058500040a2a00018500040a2a000187000c0213921f739680fe74f2ffff94000130970001019800080132f42004d204d29900024000b6000101"
224gtp = Ether(hex_bytes(h))
225ie = gtp.IE_list[5]
226ie.ietype == 148 and ie.nrsn == 1 and ie.no_qos_nego == 1 and ie.prohibit_payload_compression == 0
227
228= IE_CommonFlags(), basic instantiation
229ie = IE_CommonFlags(nrsn=1, no_qos_nego=1)
230ie.ietype == 148 and ie.nrsn == 1 and ie.no_qos_nego == 1 and ie.prohibit_payload_compression == 0
231
232= IE_APNRestriction(), basic instantiation
233ie = IE_APNRestriction(restriction_type_value=12)
234ie.ietype == 149 and ie.restriction_type_value == 12
235
236= IE_RATType(), dissect
237h = "3333333333332222222222228100a38408004588006800000000fd1134820a2a00010a2a00024aa5084b005408bb321200442f686a89d33c000010530ec20a14058500040a2a00018500040a2a000187000c0213921f739680fe74f2ffff94000130970001019800080132f42004d204d29900024000b6000101"
238gtp = Ether(hex_bytes(h))
239ie = gtp.IE_list[6]
240ie.ietype == 151 and ie.RAT_Type == 1
241
242= IE_RATType(), basic instantiation
243ie = IE_RATType(RAT_Type=1)
244ie.ietype == 151 and ie.RAT_Type == 1
245
246= IE_UserLocationInformation(), dissect
247h = "3333333333332222222222228100a38408004588006800000000fd1134820a2a00010a2a00024aa5084b005408bb32120044981eb5dcb29400001016e85d9f14058500040a2a00018500040a2a000187000c0213921f739680fe74f2ffff94000130970001019800080132f42004d204d29900024000b6000101"
248gtp = Ether(hex_bytes(h))
249ie = gtp.IE_list[7]
250ie.MCC == b'234' and ie.MNC == b'02' and ie.LAC == 1234 and ie.SAC == 1234
251
252= IE_UserLocationInformation(), basic instantiation
253ie = IE_UserLocationInformation(MCC='234', MNC='02', LAC=1234, SAC=1234)
254ie.ietype == 152 and ie.MCC == b'234' and ie.MNC == b'02' and ie.LAC == 1234 and ie.SAC == 1234
255
256= IE_MSTimeZone(), dissect
257h = "3333333333332222222222228100a38408004588006800000000fd1134820a2a00010a2a00024aa5084b005408bb32120044f24a4d5825290000102ca9c8c314058500040a2a00018500040a2a000187000c0213921f739680fe74f2ffff94000130970001019800080132f42004d204d29900024000b6000101"
258gtp = Ether(hex_bytes(h))
259ie = gtp.IE_list[8]
260ie.ietype == 153 and ie.timezone == 64 and ie.daylight_saving_time == 0
261
262= IE_MSTimeZone(), basic instantiation
263ie = IE_MSTimeZone(timezone=64)
264ie.ietype == 153 and ie.timezone == 64 and ie.daylight_saving_time == 0
265
266= IE_IMEI(), dissect
267h = "333333333333222222222222810083840800458800c300000000fc1184e50a2a00010a2a00024a4d084b00af41993210009f2f3ae0eb7b9c00000202081132547600000332f42004d27b0ffc10424a10c8117ca21aba14051a0a00800002f1218300070661616161616184001d80c02306010100060000802110010100108106000000008306000000008500040a2a00018500040a2a00018600079111111111111187000d0213621f73967373741affff0094000120970001029800080032f42004d204d299000240009a0008111111111111000081182fb2"
268gtp = Ether(hex_bytes(h))
269ie = gtp.IE_list[18] and ie.ietype == 154 and ie.IMEI == b'0132750094080322'
270
271= IE_IMEI(), basic instantiation
272ie = IE_IMEI(IMEI='0132750094080322')
273ie.ietype == 154 and ie.IMEI == b'0132750094080322'
274
275= IE_MSInfoChangeReportingAction(), basic instantiation
276ie = IE_MSInfoChangeReportingAction(Action=12)
277ie.ietype == 181 and ie.Action == 12
278
279= IE_DirectTunnelFlags(), dissect
280h = "3333333333332222222222228100a38408004588006800000000fd1134820a2a00010a2a00024aa5084b005408bb32120044d2a7dffabfb70000108caa6b0b14058500040a2a00018500040a2a000187000c0213921f739680fe74f2ffff94000130970001019800080132f42004d204d29900024000b6000101"
281gtp = Ether(hex_bytes(h))
282ie = gtp.IE_list[9]
283ie.ietype == 182 and ie.EI == 0 and ie.GCSI == 0 and ie.DTI == 1
284
285= IE_DirectTunnelFlags(), basic instantiation
286ie = IE_DirectTunnelFlags(DTI=1)
287ie.ietype == 182 and ie.EI == 0 and ie.GCSI == 0 and ie.DTI == 1
288
289= IE_BearerControlMode(), basic instantiation
290ie = IE_BearerControlMode(bearer_control_mode=1)
291ie.ietype == 184 and ie.bearer_control_mode == 1
292
293= IE_EvolvedAllocationRetentionPriority(), basic instantiation
294ie = IE_EvolvedAllocationRetentionPriority(PCI=1)
295ie.ietype == 191 and ie.PCI == 1
296
297= IE_CharginGatewayAddress(), basic instantiation
298ie = IE_CharginGatewayAddress()
299ie.ietype == 251 and ie.ipv4_address == '127.0.0.1' and ie.ipv6_address == '::1'
300
301= IE_PrivateExtension(), basic instantiation
302ie = IE_PrivateExtension(extention_value='hello')
303ie.ietype == 255 and ie.extention_value == b'hello'
304