5 from ipaddress import IPv6Network, IPv4Network
7 from framework import VppTestCase, VppTestRunner
8 from vpp_ip import DpoProto
9 from vpp_ip_route import VppIpRoute, VppRoutePath
10 from util import fragment_rfc791
13 from scapy.layers.l2 import Ether, Raw
14 from scapy.layers.inet import IP, UDP, ICMP, TCP, fragment
15 from scapy.layers.inet6 import IPv6, ICMPv6TimeExceeded
18 class TestMAP(VppTestCase):
23 super(TestMAP, cls).setUpClass()
26 def tearDownClass(cls):
27 super(TestMAP, cls).tearDownClass()
30 super(TestMAP, self).setUp()
32 # create 2 pg interfaces
33 self.create_pg_interfaces(range(4))
35 # pg0 is 'inside' IPv4
38 self.pg0.resolve_arp()
40 # pg1 is 'outside' IPv6
43 self.pg1.generate_remote_hosts(4)
44 self.pg1.configure_ipv6_neighbors()
47 super(TestMAP, self).tearDown()
48 for i in self.pg_interfaces:
53 def send_and_assert_encapped(self, packets, ip6_src, ip6_dst, dmac=None):
55 dmac = self.pg1.remote_mac
57 self.pg0.add_stream(packets)
59 self.pg_enable_capture(self.pg_interfaces)
62 capture = self.pg1.get_capture(len(packets))
63 for rx, tx in zip(capture, packets):
64 self.assertEqual(rx[Ether].dst, dmac)
65 self.assertEqual(rx[IP].src, tx[IP].src)
66 self.assertEqual(rx[IPv6].src, ip6_src)
67 self.assertEqual(rx[IPv6].dst, ip6_dst)
69 def send_and_assert_encapped_one(self, packet, ip6_src, ip6_dst,
71 return self.send_and_assert_encapped([packet], ip6_src, ip6_dst, dmac)
73 def test_api_map_domain_dump(self):
75 map_src = '3000::1/128'
76 client_pfx = '192.168.0.0/16'
78 index = self.vapi.map_add_domain(ip4_prefix=client_pfx,
82 rv = self.vapi.map_domain_dump()
84 # restore the state early so as to not impact subsequent tests.
85 # If an assert fails, we will not get the chance to do it at the end.
86 self.vapi.map_del_domain(index=index)
88 self.assertGreater(len(rv), 0,
89 "Expected output from 'map_domain_dump'")
91 # typedefs are returned as ipaddress objects.
92 # wrap results in str() ugh! to avoid the need to call unicode.
93 self.assertEqual(str(rv[0].ip4_prefix), client_pfx)
94 self.assertEqual(str(rv[0].ip6_prefix), map_dst)
95 self.assertEqual(str(rv[0].ip6_src), map_src)
97 self.assertEqual(rv[0].tag, tag,
98 "output produced incorrect tag value.")
100 def test_map_e(self):
104 # Add a route to the MAP-BR
106 map_br_pfx = "2001::"
108 map_route = VppIpRoute(self,
111 [VppRoutePath(self.pg1.remote_ip6,
112 self.pg1.sw_if_index)])
113 map_route.add_vpp_config()
116 # Add a domain that maps from pg0 to pg1
118 map_dst = '2001::/32'
119 map_src = '3000::1/128'
120 client_pfx = '192.168.0.0/16'
121 map_translated_addr = '2001:0:101:7000:0:c0a8:101:7'
123 self.vapi.map_add_domain(ip4_prefix=client_pfx,
131 self.vapi.map_param_set_security_check(enable=1, fragments=1)
133 # Enable MAP on interface.
134 self.vapi.map_if_enable_disable(is_enable=1,
135 sw_if_index=self.pg0.sw_if_index,
138 # Ensure MAP doesn't steal all packets!
139 v4 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
140 IP(src=self.pg0.remote_ip4, dst=self.pg0.remote_ip4) /
141 UDP(sport=20000, dport=10000) /
143 rx = self.send_and_expect(self.pg0, v4*1, self.pg0)
147 self.validate(p[1], v4_reply)
149 self.logger.debug("show trace")
152 # Fire in a v4 packet that will be encapped to the BR
154 v4 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
155 IP(src=self.pg0.remote_ip4, dst='192.168.1.1') /
156 UDP(sport=20000, dport=10000) /
159 self.send_and_assert_encapped_one(v4, "3000::1", map_translated_addr)
161 self.logger.debug("show trace")
163 # Verify reordered fragments are able to pass as well
165 v4 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
166 IP(id=1, src=self.pg0.remote_ip4, dst='192.168.1.1') /
167 UDP(sport=20000, dport=10000) /
170 frags = fragment_rfc791(v4, 400)
173 self.send_and_assert_encapped(frags, "3000::1", map_translated_addr)
175 self.logger.debug("show trace")
177 # Enable MAP on interface.
178 self.vapi.map_if_enable_disable(is_enable=1,
179 sw_if_index=self.pg1.sw_if_index,
182 # Ensure MAP doesn't steal all packets
183 v6 = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
184 IPv6(src=self.pg1.remote_ip6, dst=self.pg1.remote_ip6) /
185 UDP(sport=20000, dport=10000) /
187 rx = self.send_and_expect(self.pg1, v6*1, self.pg1)
191 self.validate(p[1], v6_reply)
194 # Fire in a V6 encapped packet.
195 # expect a decapped packet on the inside ip4 link
197 p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
198 IPv6(dst='3000::1', src=map_translated_addr) /
199 IP(dst=self.pg0.remote_ip4, src='192.168.1.1') /
200 UDP(sport=10000, dport=20000) /
203 self.pg1.add_stream(p)
205 self.pg_enable_capture(self.pg_interfaces)
208 rx = self.pg0.get_capture(1)
211 self.assertFalse(rx.haslayer(IPv6))
212 self.assertEqual(rx[IP].src, p[IP].src)
213 self.assertEqual(rx[IP].dst, p[IP].dst)
216 # Verify encapped reordered fragments pass as well
218 p = (IP(id=1, dst=self.pg0.remote_ip4, src='192.168.1.1') /
219 UDP(sport=10000, dport=20000) /
221 frags = fragment_rfc791(p, 400)
224 stream = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
225 IPv6(dst='3000::1', src=map_translated_addr) /
228 self.pg1.add_stream(stream)
230 self.pg_enable_capture(self.pg_interfaces)
233 rx = self.pg0.get_capture(len(frags))
236 self.assertFalse(r.haslayer(IPv6))
237 self.assertEqual(r[IP].src, p[IP].src)
238 self.assertEqual(r[IP].dst, p[IP].dst)
243 # Pre-resolve. No API for this!!
245 self.vapi.ppcli("map params pre-resolve ip6-nh 4001::1")
247 self.send_and_assert_no_replies(self.pg0, v4,
248 "resolved via default route")
251 # Add a route to 4001::1. Expect the encapped traffic to be
252 # sent via that routes next-hop
254 pre_res_route = VppIpRoute(self, "4001::1", 128,
255 [VppRoutePath(self.pg1.remote_hosts[2].ip6,
256 self.pg1.sw_if_index)])
257 pre_res_route.add_vpp_config()
259 self.send_and_assert_encapped_one(v4, "3000::1",
261 dmac=self.pg1.remote_hosts[2].mac)
264 # change the route to the pre-solved next-hop
266 pre_res_route.modify([VppRoutePath(self.pg1.remote_hosts[3].ip6,
267 self.pg1.sw_if_index)])
268 pre_res_route.add_vpp_config()
270 self.send_and_assert_encapped_one(v4, "3000::1",
272 dmac=self.pg1.remote_hosts[3].mac)
275 # cleanup. The test infra's object registry will ensure
276 # the route is really gone and thus that the unresolve worked.
278 pre_res_route.remove_vpp_config()
279 self.vapi.ppcli("map params pre-resolve del ip6-nh 4001::1")
281 def validate(self, rx, expected):
282 self.assertEqual(rx, expected.__class__(scapy.compat.raw(expected)))
284 def payload(self, len):
287 def test_map_t(self):
291 # Add a domain that maps from pg0 to pg1
293 map_dst = '2001:db8::/32'
294 map_src = '1234:5678:90ab:cdef::/64'
295 ip4_pfx = '192.168.0.0/24'
298 self.vapi.map_add_domain(ip6_prefix=map_dst,
307 # Enable MAP-T on interfaces.
308 self.vapi.map_if_enable_disable(is_enable=1,
309 sw_if_index=self.pg0.sw_if_index,
311 self.vapi.map_if_enable_disable(is_enable=1,
312 sw_if_index=self.pg1.sw_if_index,
315 # Ensure MAP doesn't steal all packets!
316 v4 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
317 IP(src=self.pg0.remote_ip4, dst=self.pg0.remote_ip4) /
318 UDP(sport=20000, dport=10000) /
320 rx = self.send_and_expect(self.pg0, v4*1, self.pg0)
324 self.validate(p[1], v4_reply)
325 # Ensure MAP doesn't steal all packets
326 v6 = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
327 IPv6(src=self.pg1.remote_ip6, dst=self.pg1.remote_ip6) /
328 UDP(sport=20000, dport=10000) /
330 rx = self.send_and_expect(self.pg1, v6*1, self.pg1)
334 self.validate(p[1], v6_reply)
336 map_route = VppIpRoute(self,
339 [VppRoutePath(self.pg1.remote_ip6,
340 self.pg1.sw_if_index,
341 proto=DpoProto.DPO_PROTO_IP6)])
342 map_route.add_vpp_config()
345 # Send a v4 packet that will be translated
347 p_ether = Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac)
348 p_ip4 = IP(src=self.pg0.remote_ip4, dst='192.168.0.1')
349 payload = TCP(sport=0xabcd, dport=0xabcd)
351 p4 = (p_ether / p_ip4 / payload)
352 p6_translated = (IPv6(src="1234:5678:90ab:cdef:ac:1001:200:0",
353 dst="2001:db8:1f0::c0a8:1:f") / payload)
354 p6_translated.hlim -= 1
355 rx = self.send_and_expect(self.pg0, p4*1, self.pg1)
357 self.validate(p[1], p6_translated)
359 # Send back an IPv6 packet that will be "untranslated"
360 p_ether6 = Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac)
361 p_ip6 = IPv6(src='2001:db8:1f0::c0a8:1:f',
362 dst='1234:5678:90ab:cdef:ac:1001:200:0')
363 p6 = (p_ether6 / p_ip6 / payload)
364 p4_translated = (IP(src='192.168.0.1',
365 dst=self.pg0.remote_ip4) / payload)
367 p4_translated.ttl -= 1
368 rx = self.send_and_expect(self.pg1, p6*1, self.pg0)
370 self.validate(p[1], p4_translated)
373 ip4_ttl_expired = IP(src=self.pg0.remote_ip4, dst='192.168.0.1', ttl=0)
374 p4 = (p_ether / ip4_ttl_expired / payload)
376 icmp4_reply = (IP(id=0, ttl=254, src=self.pg0.local_ip4,
377 dst=self.pg0.remote_ip4) /
378 ICMP(type='time-exceeded',
379 code='ttl-zero-during-transit') /
380 IP(src=self.pg0.remote_ip4,
381 dst='192.168.0.1', ttl=0) / payload)
382 rx = self.send_and_expect(self.pg0, p4*1, self.pg0)
384 self.validate(p[1], icmp4_reply)
387 This one is broken, cause it would require hairpinning...
389 ip4_ttl_expired = IP(src=self.pg0.remote_ip4, dst='192.168.0.1', ttl=1)
390 p4 = (p_ether / ip4_ttl_expired / payload)
392 icmp4_reply = IP(id=0, ttl=254, src=self.pg0.local_ip4,
393 dst=self.pg0.remote_ip4) / \
394 ICMP(type='time-exceeded', code='ttl-zero-during-transit' ) / \
395 IP(src=self.pg0.remote_ip4, dst='192.168.0.1', ttl=0) / payload
396 rx = self.send_and_expect(self.pg0, p4*1, self.pg0)
398 self.validate(p[1], icmp4_reply)
402 ip6_hlim_expired = IPv6(hlim=0, src='2001:db8:1ab::c0a8:1:ab',
403 dst='1234:5678:90ab:cdef:ac:1001:200:0')
404 p6 = (p_ether6 / ip6_hlim_expired / payload)
406 icmp6_reply = (IPv6(hlim=255, src=self.pg1.local_ip6,
407 dst="2001:db8:1ab::c0a8:1:ab") /
408 ICMPv6TimeExceeded(code=0) /
409 IPv6(src="2001:db8:1ab::c0a8:1:ab",
410 dst='1234:5678:90ab:cdef:ac:1001:200:0',
412 rx = self.send_and_expect(self.pg1, p6*1, self.pg1)
414 self.validate(p[1], icmp6_reply)
416 # IPv4 Well-known port
417 p_ip4 = IP(src=self.pg0.remote_ip4, dst='192.168.0.1')
418 payload = UDP(sport=200, dport=200)
419 p4 = (p_ether / p_ip4 / payload)
420 self.send_and_assert_no_replies(self.pg0, p4*1)
422 # IPv6 Well-known port
423 payload = UDP(sport=200, dport=200)
424 p6 = (p_ether6 / p_ip6 / payload)
425 self.send_and_assert_no_replies(self.pg1, p6*1)
427 # Packet fragmentation
428 payload = UDP(sport=40000, dport=4000) / self.payload(1453)
429 p4 = (p_ether / p_ip4 / payload)
430 self.pg_enable_capture()
431 self.pg0.add_stream(p4)
433 rx = self.pg1.get_capture(2)
436 # TODO: Manual validation
437 # self.validate(p[1], icmp4_reply)
439 # Packet fragmentation send fragments
440 payload = UDP(sport=40000, dport=4000) / self.payload(1453)
441 p4 = (p_ether / p_ip4 / payload)
442 frags = fragment(p4, fragsize=1000)
443 self.pg_enable_capture()
444 self.pg0.add_stream(frags)
446 rx = self.pg1.get_capture(2)
450 # reass_pkt = reassemble(rx)
453 # self.validate(reass_pkt, p4_reply)
456 self.vapi.map_param_set_tcp(1300)
459 # Send a v4 TCP SYN packet that will be translated and MSS clamped
461 p_ether = Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac)
462 p_ip4 = IP(src=self.pg0.remote_ip4, dst='192.168.0.1')
463 payload = TCP(sport=0xabcd, dport=0xabcd, flags="S",
464 options=[('MSS', 1460)])
466 p4 = (p_ether / p_ip4 / payload)
467 p6_translated = (IPv6(src="1234:5678:90ab:cdef:ac:1001:200:0",
468 dst="2001:db8:1f0::c0a8:1:f") / payload)
469 p6_translated.hlim -= 1
470 p6_translated[TCP].options = [('MSS', 1300)]
471 rx = self.send_and_expect(self.pg0, p4*1, self.pg1)
473 self.validate(p[1], p6_translated)
475 # Send back an IPv6 packet that will be "untranslated"
476 p_ether6 = Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac)
477 p_ip6 = IPv6(src='2001:db8:1f0::c0a8:1:f',
478 dst='1234:5678:90ab:cdef:ac:1001:200:0')
479 p6 = (p_ether6 / p_ip6 / payload)
480 p4_translated = (IP(src='192.168.0.1',
481 dst=self.pg0.remote_ip4) / payload)
483 p4_translated.ttl -= 1
484 p4_translated[TCP].options = [('MSS', 1300)]
485 rx = self.send_and_expect(self.pg1, p6*1, self.pg0)
487 self.validate(p[1], p4_translated)
490 if __name__ == '__main__':
491 unittest.main(testRunner=VppTestRunner)