6 from framework import VppTestCase, VppTestRunner
7 from vpp_ip import DpoProto
8 from vpp_ip_route import VppIpRoute, VppRoutePath
9 from util import fragment_rfc791, fragment_rfc8200
12 from scapy.layers.l2 import Ether
13 from scapy.packet import Raw
14 from scapy.layers.inet import IP, UDP, ICMP, TCP
15 from scapy.layers.inet6 import IPv6, ICMPv6TimeExceeded, IPv6ExtHdrFragment
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_udp(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 * 4, self.pg0)
147 self.validate(p[1], v4_reply)
150 # Fire in a v4 packet that will be encapped to the BR
152 v4 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
153 IP(src=self.pg0.remote_ip4, dst='192.168.1.1') /
154 UDP(sport=20000, dport=10000) /
157 self.send_and_assert_encapped(v4 * 4, "3000::1", map_translated_addr)
160 # Verify reordered fragments are able to pass as well
162 v4 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
163 IP(id=1, src=self.pg0.remote_ip4, dst='192.168.1.1') /
164 UDP(sport=20000, dport=10000) /
167 frags = fragment_rfc791(v4, 400)
170 self.send_and_assert_encapped(frags, "3000::1", map_translated_addr)
172 # Enable MAP on interface.
173 self.vapi.map_if_enable_disable(is_enable=1,
174 sw_if_index=self.pg1.sw_if_index,
177 # Ensure MAP doesn't steal all packets
178 v6 = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
179 IPv6(src=self.pg1.remote_ip6, dst=self.pg1.remote_ip6) /
180 UDP(sport=20000, dport=10000) /
182 rx = self.send_and_expect(self.pg1, v6*1, self.pg1)
186 self.validate(p[1], v6_reply)
189 # Fire in a V6 encapped packet.
190 # expect a decapped packet on the inside ip4 link
192 p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
193 IPv6(dst='3000::1', src=map_translated_addr) /
194 IP(dst=self.pg0.remote_ip4, src='192.168.1.1') /
195 UDP(sport=10000, dport=20000) /
198 self.pg1.add_stream(p)
200 self.pg_enable_capture(self.pg_interfaces)
203 rx = self.pg0.get_capture(1)
206 self.assertFalse(rx.haslayer(IPv6))
207 self.assertEqual(rx[IP].src, p[IP].src)
208 self.assertEqual(rx[IP].dst, p[IP].dst)
211 # Verify encapped reordered fragments pass as well
213 p = (IP(id=1, dst=self.pg0.remote_ip4, src='192.168.1.1') /
214 UDP(sport=10000, dport=20000) /
216 frags = fragment_rfc791(p, 400)
219 stream = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
220 IPv6(dst='3000::1', src=map_translated_addr) /
223 self.pg1.add_stream(stream)
225 self.pg_enable_capture(self.pg_interfaces)
228 rx = self.pg0.get_capture(len(frags))
231 self.assertFalse(r.haslayer(IPv6))
232 self.assertEqual(r[IP].src, p[IP].src)
233 self.assertEqual(r[IP].dst, p[IP].dst)
235 # Verify that fragments pass even if ipv6 layer is fragmented
236 stream = (IPv6(dst='3000::1', src=map_translated_addr) / x
240 Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) / x
241 for i in range(len(frags))
242 for x in fragment_rfc8200(
243 IPv6(dst='3000::1', src=map_translated_addr) / frags[i],
246 self.pg1.add_stream(v6_stream)
248 self.pg_enable_capture(self.pg_interfaces)
251 rx = self.pg0.get_capture(len(frags))
254 self.assertFalse(r.haslayer(IPv6))
255 self.assertEqual(r[IP].src, p[IP].src)
256 self.assertEqual(r[IP].dst, p[IP].dst)
259 # Pre-resolve. No API for this!!
261 self.vapi.ppcli("map params pre-resolve ip6-nh 4001::1")
263 self.send_and_assert_no_replies(self.pg0, v4,
264 "resolved via default route")
267 # Add a route to 4001::1. Expect the encapped traffic to be
268 # sent via that routes next-hop
270 pre_res_route = VppIpRoute(self, "4001::1", 128,
271 [VppRoutePath(self.pg1.remote_hosts[2].ip6,
272 self.pg1.sw_if_index)])
273 pre_res_route.add_vpp_config()
275 self.send_and_assert_encapped_one(v4, "3000::1",
277 dmac=self.pg1.remote_hosts[2].mac)
280 # change the route to the pre-solved next-hop
282 pre_res_route.modify([VppRoutePath(self.pg1.remote_hosts[3].ip6,
283 self.pg1.sw_if_index)])
284 pre_res_route.add_vpp_config()
286 self.send_and_assert_encapped_one(v4, "3000::1",
288 dmac=self.pg1.remote_hosts[3].mac)
291 # cleanup. The test infra's object registry will ensure
292 # the route is really gone and thus that the unresolve worked.
294 pre_res_route.remove_vpp_config()
295 self.vapi.ppcli("map params pre-resolve del ip6-nh 4001::1")
297 def test_map_e_inner_frag(self):
298 """ MAP-E Inner fragmentation """
301 # Add a route to the MAP-BR
303 map_br_pfx = "2001::"
305 map_route = VppIpRoute(self,
308 [VppRoutePath(self.pg1.remote_ip6,
309 self.pg1.sw_if_index)])
310 map_route.add_vpp_config()
313 # Add a domain that maps from pg0 to pg1
315 map_dst = '2001::/32'
316 map_src = '3000::1/128'
317 client_pfx = '192.168.0.0/16'
318 map_translated_addr = '2001:0:101:7000:0:c0a8:101:7'
320 self.vapi.map_add_domain(ip4_prefix=client_pfx,
329 # Enable MAP on interface.
330 self.vapi.map_if_enable_disable(is_enable=1,
331 sw_if_index=self.pg0.sw_if_index,
334 # Enable inner fragmentation
335 self.vapi.map_param_set_fragmentation(inner=1)
337 v4 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
338 IP(src=self.pg0.remote_ip4, dst='192.168.1.1') /
339 UDP(sport=20000, dport=10000) /
342 self.pg_send(self.pg0, v4*1)
343 rx = self.pg1.get_capture(2)
345 frags = fragment_rfc791(v4[1], 1000)
353 v6_reply1 = (IPv6(src='3000::1', dst=map_translated_addr, hlim=63) /
355 v6_reply2 = (IPv6(src='3000::1', dst=map_translated_addr, hlim=63) /
361 rx[0][1][IP].chksum = 0
362 rx[1][1][IP].chksum = 0
364 self.validate(rx[0][1], v6_reply1)
365 self.validate(rx[1][1], v6_reply2)
367 def test_map_e_tcp_mss(self):
371 # Add a route to the MAP-BR
373 map_br_pfx = "2001::"
375 map_route = VppIpRoute(self,
378 [VppRoutePath(self.pg1.remote_ip6,
379 self.pg1.sw_if_index)])
380 map_route.add_vpp_config()
383 # Add a domain that maps from pg0 to pg1
385 map_dst = '2001::/32'
386 map_src = '3000::1/128'
387 client_pfx = '192.168.0.0/16'
388 map_translated_addr = '2001:0:101:5000:0:c0a8:101:5'
389 tag = 'MAP-E TCP tag.'
390 self.vapi.map_add_domain(ip4_prefix=client_pfx,
398 # Enable MAP on pg0 interface.
399 self.vapi.map_if_enable_disable(is_enable=1,
400 sw_if_index=self.pg0.sw_if_index,
403 # Enable MAP on pg1 interface.
404 self.vapi.map_if_enable_disable(is_enable=1,
405 sw_if_index=self.pg1.sw_if_index,
410 self.vapi.map_param_set_tcp(mss_clamp)
413 # Send a v4 packet that will be encapped.
415 p_ether = Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac)
416 p_ip4 = IP(src=self.pg0.remote_ip4, dst='192.168.1.1')
417 p_tcp = TCP(sport=20000, dport=30000, flags="S",
418 options=[("MSS", 1455)])
419 p4 = p_ether / p_ip4 / p_tcp
421 self.pg1.add_stream(p4)
422 self.pg_enable_capture(self.pg_interfaces)
425 rx = self.pg1.get_capture(1)
428 self.assertTrue(rx.haslayer(IPv6))
429 self.assertEqual(rx[IP].src, p4[IP].src)
430 self.assertEqual(rx[IP].dst, p4[IP].dst)
431 self.assertEqual(rx[IPv6].src, "3000::1")
432 self.assertEqual(rx[TCP].options,
433 TCP(options=[('MSS', mss_clamp)]).options)
435 def validate(self, rx, expected):
436 self.assertEqual(rx, expected.__class__(scapy.compat.raw(expected)))
438 def validate_frag(self, p6_frag, p_ip6_expected):
439 self.assertFalse(p6_frag.haslayer(IP))
440 self.assertTrue(p6_frag.haslayer(IPv6))
441 self.assertTrue(p6_frag.haslayer(IPv6ExtHdrFragment))
442 self.assertEqual(p6_frag[IPv6].src, p_ip6_expected.src)
443 self.assertEqual(p6_frag[IPv6].dst, p_ip6_expected.dst)
445 def validate_frag_payload_len(self, rx, proto, payload_len_expected):
448 payload_total += p[IPv6].plen
450 # First fragment has proto
451 payload_total -= len(proto())
453 # Every fragment has IPv6 fragment header
454 payload_total -= len(IPv6ExtHdrFragment()) * len(rx)
456 self.assertEqual(payload_total, payload_len_expected)
458 def payload(self, len):
461 def test_map_t(self):
465 # Add a domain that maps from pg0 to pg1
467 map_dst = '2001:db8::/32'
468 map_src = '1234:5678:90ab:cdef::/64'
469 ip4_pfx = '192.168.0.0/24'
472 self.vapi.map_add_domain(ip6_prefix=map_dst,
481 # Enable MAP-T on interfaces.
482 self.vapi.map_if_enable_disable(is_enable=1,
483 sw_if_index=self.pg0.sw_if_index,
485 self.vapi.map_if_enable_disable(is_enable=1,
486 sw_if_index=self.pg1.sw_if_index,
489 # Ensure MAP doesn't steal all packets!
490 v4 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
491 IP(src=self.pg0.remote_ip4, dst=self.pg0.remote_ip4) /
492 UDP(sport=20000, dport=10000) /
494 rx = self.send_and_expect(self.pg0, v4*1, self.pg0)
498 self.validate(p[1], v4_reply)
499 # Ensure MAP doesn't steal all packets
500 v6 = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
501 IPv6(src=self.pg1.remote_ip6, dst=self.pg1.remote_ip6) /
502 UDP(sport=20000, dport=10000) /
504 rx = self.send_and_expect(self.pg1, v6*1, self.pg1)
508 self.validate(p[1], v6_reply)
510 map_route = VppIpRoute(self,
513 [VppRoutePath(self.pg1.remote_ip6,
514 self.pg1.sw_if_index,
515 proto=DpoProto.DPO_PROTO_IP6)])
516 map_route.add_vpp_config()
519 # Send a v4 packet that will be translated
521 p_ether = Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac)
522 p_ip4 = IP(src=self.pg0.remote_ip4, dst='192.168.0.1')
523 payload = TCP(sport=0xabcd, dport=0xabcd)
525 p4 = (p_ether / p_ip4 / payload)
526 p6_translated = (IPv6(src="1234:5678:90ab:cdef:ac:1001:200:0",
527 dst="2001:db8:1f0::c0a8:1:f") / payload)
528 p6_translated.hlim -= 1
529 rx = self.send_and_expect(self.pg0, p4*1, self.pg1)
531 self.validate(p[1], p6_translated)
533 # Send back an IPv6 packet that will be "untranslated"
534 p_ether6 = Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac)
535 p_ip6 = IPv6(src='2001:db8:1f0::c0a8:1:f',
536 dst='1234:5678:90ab:cdef:ac:1001:200:0')
537 p6 = (p_ether6 / p_ip6 / payload)
538 p4_translated = (IP(src='192.168.0.1',
539 dst=self.pg0.remote_ip4) / payload)
541 p4_translated.ttl -= 1
542 rx = self.send_and_expect(self.pg1, p6*1, self.pg0)
544 self.validate(p[1], p4_translated)
547 ip4_ttl_expired = IP(src=self.pg0.remote_ip4, dst='192.168.0.1', ttl=0)
548 p4 = (p_ether / ip4_ttl_expired / payload)
550 icmp4_reply = (IP(id=0, ttl=254, src=self.pg0.local_ip4,
551 dst=self.pg0.remote_ip4) /
552 ICMP(type='time-exceeded',
553 code='ttl-zero-during-transit') /
554 IP(src=self.pg0.remote_ip4,
555 dst='192.168.0.1', ttl=0) / payload)
556 rx = self.send_and_expect(self.pg0, p4*1, self.pg0)
558 self.validate(p[1], icmp4_reply)
561 This one is broken, cause it would require hairpinning...
563 ip4_ttl_expired = IP(src=self.pg0.remote_ip4, dst='192.168.0.1', ttl=1)
564 p4 = (p_ether / ip4_ttl_expired / payload)
566 icmp4_reply = IP(id=0, ttl=254, src=self.pg0.local_ip4,
567 dst=self.pg0.remote_ip4) / \
568 ICMP(type='time-exceeded', code='ttl-zero-during-transit' ) / \
569 IP(src=self.pg0.remote_ip4, dst='192.168.0.1', ttl=0) / payload
570 rx = self.send_and_expect(self.pg0, p4*1, self.pg0)
572 self.validate(p[1], icmp4_reply)
576 ip6_hlim_expired = IPv6(hlim=0, src='2001:db8:1ab::c0a8:1:ab',
577 dst='1234:5678:90ab:cdef:ac:1001:200:0')
578 p6 = (p_ether6 / ip6_hlim_expired / payload)
580 icmp6_reply = (IPv6(hlim=255, src=self.pg1.local_ip6,
581 dst="2001:db8:1ab::c0a8:1:ab") /
582 ICMPv6TimeExceeded(code=0) /
583 IPv6(src="2001:db8:1ab::c0a8:1:ab",
584 dst='1234:5678:90ab:cdef:ac:1001:200:0',
586 rx = self.send_and_expect(self.pg1, p6*1, self.pg1)
588 self.validate(p[1], icmp6_reply)
590 # IPv4 Well-known port
591 p_ip4 = IP(src=self.pg0.remote_ip4, dst='192.168.0.1')
592 payload = UDP(sport=200, dport=200)
593 p4 = (p_ether / p_ip4 / payload)
594 self.send_and_assert_no_replies(self.pg0, p4*1)
596 # IPv6 Well-known port
597 payload = UDP(sport=200, dport=200)
598 p6 = (p_ether6 / p_ip6 / payload)
599 self.send_and_assert_no_replies(self.pg1, p6*1)
601 # Packet fragmentation
603 payload = UDP(sport=40000, dport=4000) / self.payload(payload_len)
604 p4 = (p_ether / p_ip4 / payload)
605 self.pg_enable_capture()
606 self.pg0.add_stream(p4)
608 rx = self.pg1.get_capture(2)
610 p_ip6_translated = IPv6(src='1234:5678:90ab:cdef:ac:1001:200:0',
611 dst='2001:db8:1e0::c0a8:1:e')
613 self.validate_frag(p, p_ip6_translated)
615 self.validate_frag_payload_len(rx, UDP, payload_len)
617 # Packet fragmentation send fragments
618 payload = UDP(sport=40000, dport=4000) / self.payload(payload_len)
619 p4 = (p_ether / p_ip4 / payload)
620 frags = fragment_rfc791(p4, fragsize=1000)
621 self.pg_enable_capture()
622 self.pg0.add_stream(frags)
624 rx = self.pg1.get_capture(2)
627 self.validate_frag(p, p_ip6_translated)
629 self.validate_frag_payload_len(rx, UDP, payload_len)
631 # reass_pkt = reassemble(rx)
634 # self.validate(reass_pkt, p4_reply)
637 self.vapi.map_param_set_tcp(1300)
640 # Send a v4 TCP SYN packet that will be translated and MSS clamped
642 p_ether = Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac)
643 p_ip4 = IP(src=self.pg0.remote_ip4, dst='192.168.0.1')
644 payload = TCP(sport=0xabcd, dport=0xabcd, flags="S",
645 options=[('MSS', 1460)])
647 p4 = (p_ether / p_ip4 / payload)
648 p6_translated = (IPv6(src="1234:5678:90ab:cdef:ac:1001:200:0",
649 dst="2001:db8:1f0::c0a8:1:f") / payload)
650 p6_translated.hlim -= 1
651 p6_translated[TCP].options = [('MSS', 1300)]
652 rx = self.send_and_expect(self.pg0, p4*1, self.pg1)
654 self.validate(p[1], p6_translated)
656 # Send back an IPv6 packet that will be "untranslated"
657 p_ether6 = Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac)
658 p_ip6 = IPv6(src='2001:db8:1f0::c0a8:1:f',
659 dst='1234:5678:90ab:cdef:ac:1001:200:0')
660 p6 = (p_ether6 / p_ip6 / payload)
661 p4_translated = (IP(src='192.168.0.1',
662 dst=self.pg0.remote_ip4) / payload)
664 p4_translated.ttl -= 1
665 p4_translated[TCP].options = [('MSS', 1300)]
666 rx = self.send_and_expect(self.pg1, p6*1, self.pg0)
668 self.validate(p[1], p4_translated)
670 def test_map_t_ip6_psid(self):
671 """ MAP-T v6->v4 PSID validation"""
674 # Add a domain that maps from pg0 to pg1
676 map_dst = '2001:db8::/32'
677 map_src = '1234:5678:90ab:cdef::/64'
678 ip4_pfx = '192.168.0.0/24'
679 tag = 'MAP-T Test Domain'
681 self.vapi.map_add_domain(ip6_prefix=map_dst,
690 # Enable MAP-T on interfaces.
691 self.vapi.map_if_enable_disable(is_enable=1,
692 sw_if_index=self.pg0.sw_if_index,
694 self.vapi.map_if_enable_disable(is_enable=1,
695 sw_if_index=self.pg1.sw_if_index,
698 map_route = VppIpRoute(self,
701 [VppRoutePath(self.pg1.remote_ip6,
702 self.pg1.sw_if_index,
703 proto=DpoProto.DPO_PROTO_IP6)])
704 map_route.add_vpp_config()
706 p_ether6 = Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac)
707 p_ip6 = IPv6(src='2001:db8:1f0::c0a8:1:f',
708 dst='1234:5678:90ab:cdef:ac:1001:200:0')
710 # Send good IPv6 source port, ensure translated IPv4 received
711 payload = TCP(sport=0xabcd, dport=80)
712 p6 = (p_ether6 / p_ip6 / payload)
713 p4_translated = (IP(src='192.168.0.1',
714 dst=self.pg0.remote_ip4) / payload)
716 p4_translated.ttl -= 1
717 rx = self.send_and_expect(self.pg1, p6*1, self.pg0)
719 self.validate(p[1], p4_translated)
721 # Send bad IPv6 source port, ensure translated IPv4 not received
722 payload = TCP(sport=0xdcba, dport=80)
723 p6 = (p_ether6 / p_ip6 / payload)
724 self.send_and_assert_no_replies(self.pg1, p6*1)
726 if __name__ == '__main__':
727 unittest.main(testRunner=VppTestRunner)