5 from scapy.layers.inet import IP, ICMP, TCP, UDP
6 from scapy.layers.ipsec import SecurityAssociation, ESP
7 from scapy.layers.l2 import Ether, Raw
8 from scapy.layers.inet6 import IPv6, ICMPv6EchoRequest
10 from framework import VppTestCase, VppTestRunner
11 from util import ppp, reassemble4, fragment_rfc791, fragment_rfc8200
12 from vpp_papi import VppEnum
15 class IPsecIPv4Params(object):
17 addr_type = socket.AF_INET
19 addr_bcast = "255.255.255.255"
24 self.remote_tun_if_host = '1.1.1.1'
25 self.remote_tun_if_host6 = '1111::1'
27 self.scapy_tun_sa_id = 10
28 self.scapy_tun_spi = 1001
29 self.vpp_tun_sa_id = 20
30 self.vpp_tun_spi = 1000
32 self.scapy_tra_sa_id = 30
33 self.scapy_tra_spi = 2001
34 self.vpp_tra_sa_id = 40
35 self.vpp_tra_spi = 2000
37 self.auth_algo_vpp_id = (VppEnum.vl_api_ipsec_integ_alg_t.
38 IPSEC_API_INTEG_ALG_SHA1_96)
39 self.auth_algo = 'HMAC-SHA1-96' # scapy name
40 self.auth_key = b'C91KUR9GYMm5GfkEvNjX'
42 self.crypt_algo_vpp_id = (VppEnum.vl_api_ipsec_crypto_alg_t.
43 IPSEC_API_CRYPTO_ALG_AES_CBC_128)
44 self.crypt_algo = 'AES-CBC' # scapy name
45 self.crypt_key = b'JPjyOWBeVEQiMe7h'
48 self.nat_header = None
51 class IPsecIPv6Params(object):
53 addr_type = socket.AF_INET6
55 addr_bcast = "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"
60 self.remote_tun_if_host = '1111:1111:1111:1111:1111:1111:1111:1111'
61 self.remote_tun_if_host4 = '1.1.1.1'
63 self.scapy_tun_sa_id = 50
64 self.scapy_tun_spi = 3001
65 self.vpp_tun_sa_id = 60
66 self.vpp_tun_spi = 3000
68 self.scapy_tra_sa_id = 70
69 self.scapy_tra_spi = 4001
70 self.vpp_tra_sa_id = 80
71 self.vpp_tra_spi = 4000
73 self.auth_algo_vpp_id = (VppEnum.vl_api_ipsec_integ_alg_t.
74 IPSEC_API_INTEG_ALG_SHA1_96)
75 self.auth_algo = 'HMAC-SHA1-96' # scapy name
76 self.auth_key = b'C91KUR9GYMm5GfkEvNjX'
78 self.crypt_algo_vpp_id = (VppEnum.vl_api_ipsec_crypto_alg_t.
79 IPSEC_API_CRYPTO_ALG_AES_CBC_128)
80 self.crypt_algo = 'AES-CBC' # scapy name
81 self.crypt_key = b'JPjyOWBeVEQiMe7h'
84 self.nat_header = None
87 def mk_scapy_crypt_key(p):
88 if p.crypt_algo == "AES-GCM":
89 return p.crypt_key + struct.pack("!I", p.salt)
94 def config_tun_params(p, encryption_type, tun_if):
95 ip_class_by_addr_type = {socket.AF_INET: IP, socket.AF_INET6: IPv6}
96 use_esn = bool(p.flags & (VppEnum.vl_api_ipsec_sad_flags_t.
97 IPSEC_API_SAD_FLAG_USE_ESN))
98 crypt_key = mk_scapy_crypt_key(p)
99 p.scapy_tun_sa = SecurityAssociation(
100 encryption_type, spi=p.vpp_tun_spi,
101 crypt_algo=p.crypt_algo,
103 auth_algo=p.auth_algo, auth_key=p.auth_key,
104 tunnel_header=ip_class_by_addr_type[p.addr_type](
105 src=tun_if.remote_addr[p.addr_type],
106 dst=tun_if.local_addr[p.addr_type]),
107 nat_t_header=p.nat_header,
109 p.vpp_tun_sa = SecurityAssociation(
110 encryption_type, spi=p.scapy_tun_spi,
111 crypt_algo=p.crypt_algo,
113 auth_algo=p.auth_algo, auth_key=p.auth_key,
114 tunnel_header=ip_class_by_addr_type[p.addr_type](
115 dst=tun_if.remote_addr[p.addr_type],
116 src=tun_if.local_addr[p.addr_type]),
117 nat_t_header=p.nat_header,
121 def config_tra_params(p, encryption_type):
122 use_esn = bool(p.flags & (VppEnum.vl_api_ipsec_sad_flags_t.
123 IPSEC_API_SAD_FLAG_USE_ESN))
124 crypt_key = mk_scapy_crypt_key(p)
125 p.scapy_tra_sa = SecurityAssociation(
128 crypt_algo=p.crypt_algo,
130 auth_algo=p.auth_algo,
132 nat_t_header=p.nat_header,
134 p.vpp_tra_sa = SecurityAssociation(
137 crypt_algo=p.crypt_algo,
139 auth_algo=p.auth_algo,
141 nat_t_header=p.nat_header,
145 class TemplateIpsec(VppTestCase):
150 |tra_if| <-------> |VPP|
155 ------ encrypt --- plain ---
156 |tun_if| <------- |VPP| <------ |pg1|
159 ------ decrypt --- plain ---
160 |tun_if| -------> |VPP| ------> |pg1|
166 def ipsec_select_backend(self):
167 """ empty method to be overloaded when necessary """
172 super(TemplateIpsec, cls).setUpClass()
175 def tearDownClass(cls):
176 super(TemplateIpsec, cls).tearDownClass()
178 def setup_params(self):
179 self.ipv4_params = IPsecIPv4Params()
180 self.ipv6_params = IPsecIPv6Params()
181 self.params = {self.ipv4_params.addr_type: self.ipv4_params,
182 self.ipv6_params.addr_type: self.ipv6_params}
184 def config_interfaces(self):
185 self.create_pg_interfaces(range(3))
186 self.interfaces = list(self.pg_interfaces)
187 for i in self.interfaces:
195 super(TemplateIpsec, self).setUp()
199 self.vpp_esp_protocol = (VppEnum.vl_api_ipsec_proto_t.
201 self.vpp_ah_protocol = (VppEnum.vl_api_ipsec_proto_t.
204 self.config_interfaces()
206 self.ipsec_select_backend()
208 def unconfig_interfaces(self):
209 for i in self.interfaces:
215 super(TemplateIpsec, self).tearDown()
217 self.unconfig_interfaces()
219 def show_commands_at_teardown(self):
220 self.logger.info(self.vapi.cli("show hardware"))
222 def gen_encrypt_pkts(self, sa, sw_intf, src, dst, count=1,
224 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
225 sa.encrypt(IP(src=src, dst=dst) /
226 ICMP() / Raw(b'X' * payload_size))
227 for i in range(count)]
229 def gen_encrypt_pkts6(self, sa, sw_intf, src, dst, count=1,
231 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
232 sa.encrypt(IPv6(src=src, dst=dst) /
233 ICMPv6EchoRequest(id=0, seq=1,
234 data='X' * payload_size))
235 for i in range(count)]
237 def gen_pkts(self, sw_intf, src, dst, count=1, payload_size=54):
238 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
239 IP(src=src, dst=dst) / ICMP() / Raw(b'X' * payload_size)
240 for i in range(count)]
242 def gen_pkts6(self, sw_intf, src, dst, count=1, payload_size=54):
243 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
244 IPv6(src=src, dst=dst) /
245 ICMPv6EchoRequest(id=0, seq=1, data='X' * payload_size)
246 for i in range(count)]
249 class IpsecTcp(object):
250 def verify_tcp_checksum(self):
251 self.vapi.cli("test http server")
252 p = self.params[socket.AF_INET]
253 send = (Ether(src=self.tun_if.remote_mac, dst=self.tun_if.local_mac) /
254 p.scapy_tun_sa.encrypt(IP(src=p.remote_tun_if_host,
255 dst=self.tun_if.local_ip4) /
256 TCP(flags='S', dport=80)))
257 self.logger.debug(ppp("Sending packet:", send))
258 recv = self.send_and_expect(self.tun_if, [send], self.tun_if)
260 decrypted = p.vpp_tun_sa.decrypt(recv[IP])
261 self.assert_packet_checksums_valid(decrypted)
264 class IpsecTcpTests(IpsecTcp):
265 def test_tcp_checksum(self):
266 """ verify checksum correctness for vpp generated packets """
267 self.verify_tcp_checksum()
270 class IpsecTra4(object):
271 """ verify methods for Transport v4 """
272 def verify_tra_anti_replay(self):
273 p = self.params[socket.AF_INET]
274 use_esn = p.vpp_tra_sa.use_esn
276 seq_cycle_node_name = ('/err/%s/sequence number cycled' %
277 self.tra4_encrypt_node_name)
278 replay_node_name = ('/err/%s/SA replayed packet' %
279 self.tra4_decrypt_node_name)
280 if ESP == self.encryption_type and p.crypt_algo == "AES-GCM":
281 hash_failed_node_name = ('/err/%s/ESP decryption failed' %
282 self.tra4_decrypt_node_name)
284 hash_failed_node_name = ('/err/%s/Integrity check failed' %
285 self.tra4_decrypt_node_name)
286 replay_count = self.statistics.get_err_counter(replay_node_name)
287 hash_failed_count = self.statistics.get_err_counter(
288 hash_failed_node_name)
289 seq_cycle_count = self.statistics.get_err_counter(seq_cycle_node_name)
291 if ESP == self.encryption_type:
292 undersize_node_name = ('/err/%s/undersized packet' %
293 self.tra4_decrypt_node_name)
294 undersize_count = self.statistics.get_err_counter(
298 # send packets with seq numbers 1->34
299 # this means the window size is still in Case B (see RFC4303
302 # for reasons i haven't investigated Scapy won't create a packet with
305 pkts = [(Ether(src=self.tra_if.remote_mac,
306 dst=self.tra_if.local_mac) /
307 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
308 dst=self.tra_if.local_ip4) /
311 for seq in range(1, 34)]
312 recv_pkts = self.send_and_expect(self.tra_if, pkts, self.tra_if)
314 # replayed packets are dropped
315 self.send_and_assert_no_replies(self.tra_if, pkts)
316 replay_count += len(pkts)
317 self.assert_error_counter_equal(replay_node_name, replay_count)
320 # now send a batch of packets all with the same sequence number
321 # the first packet in the batch is legitimate, the rest bogus
323 pkts = (Ether(src=self.tra_if.remote_mac,
324 dst=self.tra_if.local_mac) /
325 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
326 dst=self.tra_if.local_ip4) /
329 recv_pkts = self.send_and_expect(self.tra_if, pkts * 8,
332 self.assert_error_counter_equal(replay_node_name, replay_count)
335 # now move the window over to 257 (more than one byte) and into Case A
337 pkt = (Ether(src=self.tra_if.remote_mac,
338 dst=self.tra_if.local_mac) /
339 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
340 dst=self.tra_if.local_ip4) /
343 recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
345 # replayed packets are dropped
346 self.send_and_assert_no_replies(self.tra_if, pkt * 3)
348 self.assert_error_counter_equal(replay_node_name, replay_count)
350 # the window size is 64 packets
351 # in window are still accepted
352 pkt = (Ether(src=self.tra_if.remote_mac,
353 dst=self.tra_if.local_mac) /
354 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
355 dst=self.tra_if.local_ip4) /
358 recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
360 # a packet that does not decrypt does not move the window forward
361 bogus_sa = SecurityAssociation(self.encryption_type,
363 crypt_algo=p.crypt_algo,
364 crypt_key=mk_scapy_crypt_key(p)[::-1],
365 auth_algo=p.auth_algo,
366 auth_key=p.auth_key[::-1])
367 pkt = (Ether(src=self.tra_if.remote_mac,
368 dst=self.tra_if.local_mac) /
369 bogus_sa.encrypt(IP(src=self.tra_if.remote_ip4,
370 dst=self.tra_if.local_ip4) /
373 self.send_and_assert_no_replies(self.tra_if, pkt * 17)
375 hash_failed_count += 17
376 self.assert_error_counter_equal(hash_failed_node_name,
379 # a malformed 'runt' packet
380 # created by a mis-constructed SA
381 if (ESP == self.encryption_type and p.crypt_algo != "NULL"):
382 bogus_sa = SecurityAssociation(self.encryption_type,
384 pkt = (Ether(src=self.tra_if.remote_mac,
385 dst=self.tra_if.local_mac) /
386 bogus_sa.encrypt(IP(src=self.tra_if.remote_ip4,
387 dst=self.tra_if.local_ip4) /
390 self.send_and_assert_no_replies(self.tra_if, pkt * 17)
392 undersize_count += 17
393 self.assert_error_counter_equal(undersize_node_name,
396 # which we can determine since this packet is still in the window
397 pkt = (Ether(src=self.tra_if.remote_mac,
398 dst=self.tra_if.local_mac) /
399 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
400 dst=self.tra_if.local_ip4) /
403 self.send_and_expect(self.tra_if, [pkt], self.tra_if)
406 # out of window are dropped
407 # this is Case B. So VPP will consider this to be a high seq num wrap
408 # and so the decrypt attempt will fail
410 pkt = (Ether(src=self.tra_if.remote_mac,
411 dst=self.tra_if.local_mac) /
412 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
413 dst=self.tra_if.local_ip4) /
416 self.send_and_assert_no_replies(self.tra_if, pkt * 17)
419 # an out of window error with ESN looks like a high sequence
420 # wrap. but since it isn't then the verify will fail.
421 hash_failed_count += 17
422 self.assert_error_counter_equal(hash_failed_node_name,
427 self.assert_error_counter_equal(replay_node_name,
430 # valid packet moves the window over to 258
431 pkt = (Ether(src=self.tra_if.remote_mac,
432 dst=self.tra_if.local_mac) /
433 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
434 dst=self.tra_if.local_ip4) /
437 rx = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
438 decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
441 # move VPP's SA TX seq-num to just before the seq-number wrap.
442 # then fire in a packet that VPP should drop on TX because it
443 # causes the TX seq number to wrap; unless we're using extened sequence
446 self.vapi.cli("test ipsec sa %d seq 0xffffffff" % p.scapy_tra_sa_id)
447 self.logger.info(self.vapi.ppcli("show ipsec sa 0"))
448 self.logger.info(self.vapi.ppcli("show ipsec sa 1"))
450 pkts = [(Ether(src=self.tra_if.remote_mac,
451 dst=self.tra_if.local_mac) /
452 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
453 dst=self.tra_if.local_ip4) /
456 for seq in range(259, 280)]
459 rxs = self.send_and_expect(self.tra_if, pkts, self.tra_if)
462 # in order for scapy to decrypt its SA's high order number needs
465 p.vpp_tra_sa.seq_num = 0x100000000
467 decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
470 # wrap scapy's TX high sequence number. VPP is in case B, so it
471 # will consider this a high seq wrap also.
472 # The low seq num we set it to will place VPP's RX window in Case A
474 p.scapy_tra_sa.seq_num = 0x100000005
475 pkt = (Ether(src=self.tra_if.remote_mac,
476 dst=self.tra_if.local_mac) /
477 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
478 dst=self.tra_if.local_ip4) /
480 seq_num=0x100000005))
481 rx = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
482 decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
485 # A packet that has seq num between (2^32-64) and 5 is within
488 p.scapy_tra_sa.seq_num = 0xfffffffd
489 pkt = (Ether(src=self.tra_if.remote_mac,
490 dst=self.tra_if.local_mac) /
491 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
492 dst=self.tra_if.local_ip4) /
495 rx = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
496 decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
499 # While in case A we cannot wrap the high sequence number again
500 # becuase VPP will consider this packet to be one that moves the
503 pkt = (Ether(src=self.tra_if.remote_mac,
504 dst=self.tra_if.local_mac) /
505 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
506 dst=self.tra_if.local_ip4) /
508 seq_num=0x200000999))
509 self.send_and_assert_no_replies(self.tra_if, [pkt], self.tra_if)
511 hash_failed_count += 1
512 self.assert_error_counter_equal(hash_failed_node_name,
516 # but if we move the wondow forward to case B, then we can wrap
519 p.scapy_tra_sa.seq_num = 0x100000555
520 pkt = (Ether(src=self.tra_if.remote_mac,
521 dst=self.tra_if.local_mac) /
522 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
523 dst=self.tra_if.local_ip4) /
525 seq_num=0x100000555))
526 rx = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
527 decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
529 p.scapy_tra_sa.seq_num = 0x200000444
530 pkt = (Ether(src=self.tra_if.remote_mac,
531 dst=self.tra_if.local_mac) /
532 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
533 dst=self.tra_if.local_ip4) /
535 seq_num=0x200000444))
536 rx = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
537 decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
541 # without ESN TX sequence numbers can't wrap and packets are
542 # dropped from here on out.
544 self.send_and_assert_no_replies(self.tra_if, pkts)
545 seq_cycle_count += len(pkts)
546 self.assert_error_counter_equal(seq_cycle_node_name,
549 # move the security-associations seq number on to the last we used
550 self.vapi.cli("test ipsec sa %d seq 0x15f" % p.scapy_tra_sa_id)
551 p.scapy_tra_sa.seq_num = 351
552 p.vpp_tra_sa.seq_num = 351
554 def verify_tra_basic4(self, count=1):
555 """ ipsec v4 transport basic test """
556 self.vapi.cli("clear errors")
557 self.vapi.cli("clear ipsec sa")
559 p = self.params[socket.AF_INET]
560 send_pkts = self.gen_encrypt_pkts(p.scapy_tra_sa, self.tra_if,
561 src=self.tra_if.remote_ip4,
562 dst=self.tra_if.local_ip4,
564 recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
567 self.assertEqual(len(rx) - len(Ether()), rx[IP].len)
568 self.assert_packet_checksums_valid(rx)
570 decrypted = p.vpp_tra_sa.decrypt(rx[IP])
571 self.assert_packet_checksums_valid(decrypted)
573 self.logger.debug(ppp("Unexpected packet:", rx))
576 self.logger.info(self.vapi.ppcli("show error"))
577 self.logger.info(self.vapi.ppcli("show ipsec all"))
579 pkts = p.tra_sa_in.get_stats()['packets']
580 self.assertEqual(pkts, count,
581 "incorrect SA in counts: expected %d != %d" %
583 pkts = p.tra_sa_out.get_stats()['packets']
584 self.assertEqual(pkts, count,
585 "incorrect SA out counts: expected %d != %d" %
588 self.assert_packet_counter_equal(self.tra4_encrypt_node_name, count)
589 self.assert_packet_counter_equal(self.tra4_decrypt_node_name, count)
592 class IpsecTra4Tests(IpsecTra4):
593 """ UT test methods for Transport v4 """
594 def test_tra_anti_replay(self):
595 """ ipsec v4 transport anti-reply test """
596 self.verify_tra_anti_replay()
598 def test_tra_basic(self, count=1):
599 """ ipsec v4 transport basic test """
600 self.verify_tra_basic4(count=1)
602 def test_tra_burst(self):
603 """ ipsec v4 transport burst test """
604 self.verify_tra_basic4(count=257)
607 class IpsecTra6(object):
608 """ verify methods for Transport v6 """
609 def verify_tra_basic6(self, count=1):
610 self.vapi.cli("clear errors")
612 p = self.params[socket.AF_INET6]
613 send_pkts = self.gen_encrypt_pkts6(p.scapy_tra_sa, self.tra_if,
614 src=self.tra_if.remote_ip6,
615 dst=self.tra_if.local_ip6,
617 recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
620 self.assertEqual(len(rx) - len(Ether()) - len(IPv6()),
623 decrypted = p.vpp_tra_sa.decrypt(rx[IPv6])
624 self.assert_packet_checksums_valid(decrypted)
626 self.logger.debug(ppp("Unexpected packet:", rx))
629 self.logger.info(self.vapi.ppcli("show error"))
630 self.logger.info(self.vapi.ppcli("show ipsec all"))
632 pkts = p.tra_sa_in.get_stats()['packets']
633 self.assertEqual(pkts, count,
634 "incorrect SA in counts: expected %d != %d" %
636 pkts = p.tra_sa_out.get_stats()['packets']
637 self.assertEqual(pkts, count,
638 "incorrect SA out counts: expected %d != %d" %
640 self.assert_packet_counter_equal(self.tra6_encrypt_node_name, count)
641 self.assert_packet_counter_equal(self.tra6_decrypt_node_name, count)
644 class IpsecTra6Tests(IpsecTra6):
645 """ UT test methods for Transport v6 """
646 def test_tra_basic6(self):
647 """ ipsec v6 transport basic test """
648 self.verify_tra_basic6(count=1)
650 def test_tra_burst6(self):
651 """ ipsec v6 transport burst test """
652 self.verify_tra_basic6(count=257)
655 class IpsecTra46Tests(IpsecTra4Tests, IpsecTra6Tests):
656 """ UT test methods for Transport v6 and v4"""
660 class IpsecTun4(object):
661 """ verify methods for Tunnel v4 """
662 def verify_counters4(self, p, count, n_frags=None):
665 if (hasattr(p, "spd_policy_in_any")):
666 pkts = p.spd_policy_in_any.get_stats()['packets']
667 self.assertEqual(pkts, count,
668 "incorrect SPD any policy: expected %d != %d" %
671 if (hasattr(p, "tun_sa_in")):
672 pkts = p.tun_sa_in.get_stats()['packets']
673 self.assertEqual(pkts, count,
674 "incorrect SA in counts: expected %d != %d" %
676 pkts = p.tun_sa_out.get_stats()['packets']
677 self.assertEqual(pkts, count,
678 "incorrect SA out counts: expected %d != %d" %
681 self.assert_packet_counter_equal(self.tun4_encrypt_node_name, n_frags)
682 self.assert_packet_counter_equal(self.tun4_decrypt_node_name, count)
684 def verify_decrypted(self, p, rxs):
686 self.assert_equal(rx[IP].src, p.remote_tun_if_host)
687 self.assert_equal(rx[IP].dst, self.pg1.remote_ip4)
688 self.assert_packet_checksums_valid(rx)
690 def verify_encrypted(self, p, sa, rxs):
694 self.assertEqual(rx[UDP].dport, 4500)
695 self.assert_packet_checksums_valid(rx)
696 self.assertEqual(len(rx) - len(Ether()), rx[IP].len)
698 decrypt_pkt = p.vpp_tun_sa.decrypt(rx[IP])
699 if not decrypt_pkt.haslayer(IP):
700 decrypt_pkt = IP(decrypt_pkt[Raw].load)
701 decrypt_pkts.append(decrypt_pkt)
702 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip4)
703 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
705 self.logger.debug(ppp("Unexpected packet:", rx))
707 self.logger.debug(ppp("Decrypted packet:", decrypt_pkt))
711 pkts = reassemble4(decrypt_pkts)
713 self.assert_packet_checksums_valid(pkt)
715 def verify_tun_44(self, p, count=1, payload_size=64, n_rx=None):
716 self.vapi.cli("clear errors")
720 send_pkts = self.gen_encrypt_pkts(p.scapy_tun_sa, self.tun_if,
721 src=p.remote_tun_if_host,
722 dst=self.pg1.remote_ip4,
724 recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
725 self.verify_decrypted(p, recv_pkts)
727 send_pkts = self.gen_pkts(self.pg1, src=self.pg1.remote_ip4,
728 dst=p.remote_tun_if_host, count=count,
729 payload_size=payload_size)
730 recv_pkts = self.send_and_expect(self.pg1, send_pkts,
732 self.verify_encrypted(p, p.vpp_tun_sa, recv_pkts)
735 self.logger.info(self.vapi.ppcli("show error"))
736 self.logger.info(self.vapi.ppcli("show ipsec all"))
738 self.verify_counters4(p, count, n_rx)
740 def verify_tun_reass_44(self, p):
741 self.vapi.cli("clear errors")
742 self.vapi.ip_reassembly_enable_disable(
743 sw_if_index=self.tun_if.sw_if_index, enable_ip4=True)
746 send_pkts = self.gen_encrypt_pkts(p.scapy_tun_sa, self.tun_if,
747 src=p.remote_tun_if_host,
748 dst=self.pg1.remote_ip4,
751 send_pkts = fragment_rfc791(send_pkts[0], 1400)
752 recv_pkts = self.send_and_expect(self.tun_if, send_pkts,
754 self.verify_decrypted(p, recv_pkts)
756 send_pkts = self.gen_pkts(self.pg1, src=self.pg1.remote_ip4,
757 dst=p.remote_tun_if_host, count=1)
758 recv_pkts = self.send_and_expect(self.pg1, send_pkts,
760 self.verify_encrypted(p, p.vpp_tun_sa, recv_pkts)
763 self.logger.info(self.vapi.ppcli("show error"))
764 self.logger.info(self.vapi.ppcli("show ipsec all"))
766 self.verify_counters4(p, 1, 1)
767 self.vapi.ip_reassembly_enable_disable(
768 sw_if_index=self.tun_if.sw_if_index, enable_ip4=False)
770 def verify_tun_64(self, p, count=1):
771 self.vapi.cli("clear errors")
773 send_pkts = self.gen_encrypt_pkts6(p.scapy_tun_sa, self.tun_if,
774 src=p.remote_tun_if_host6,
775 dst=self.pg1.remote_ip6,
777 recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
778 for recv_pkt in recv_pkts:
779 self.assert_equal(recv_pkt[IPv6].src, p.remote_tun_if_host6)
780 self.assert_equal(recv_pkt[IPv6].dst, self.pg1.remote_ip6)
781 self.assert_packet_checksums_valid(recv_pkt)
782 send_pkts = self.gen_pkts6(self.pg1, src=self.pg1.remote_ip6,
783 dst=p.remote_tun_if_host6, count=count)
784 recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
785 for recv_pkt in recv_pkts:
787 decrypt_pkt = p.vpp_tun_sa.decrypt(recv_pkt[IP])
788 if not decrypt_pkt.haslayer(IPv6):
789 decrypt_pkt = IPv6(decrypt_pkt[Raw].load)
790 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip6)
791 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host6)
792 self.assert_packet_checksums_valid(decrypt_pkt)
794 self.logger.error(ppp("Unexpected packet:", recv_pkt))
797 ppp("Decrypted packet:", decrypt_pkt))
802 self.logger.info(self.vapi.ppcli("show error"))
803 self.logger.info(self.vapi.ppcli("show ipsec all"))
805 self.verify_counters4(p, count)
807 def verify_keepalive(self, p):
808 pkt = (Ether(src=self.tun_if.remote_mac, dst=self.tun_if.local_mac) /
809 IP(src=p.remote_tun_if_host, dst=self.tun_if.local_ip4) /
810 UDP(sport=333, dport=4500) /
812 self.send_and_assert_no_replies(self.tun_if, pkt*31)
813 self.assert_error_counter_equal(
814 '/err/%s/NAT Keepalive' % self.tun4_input_node, 31)
816 pkt = (Ether(src=self.tun_if.remote_mac, dst=self.tun_if.local_mac) /
817 IP(src=p.remote_tun_if_host, dst=self.tun_if.local_ip4) /
818 UDP(sport=333, dport=4500) /
820 self.send_and_assert_no_replies(self.tun_if, pkt*31)
821 self.assert_error_counter_equal(
822 '/err/%s/Too Short' % self.tun4_input_node, 31)
825 class IpsecTun4Tests(IpsecTun4):
826 """ UT test methods for Tunnel v4 """
827 def test_tun_basic44(self):
828 """ ipsec 4o4 tunnel basic test """
829 self.verify_tun_44(self.params[socket.AF_INET], count=1)
831 def test_tun_reass_basic44(self):
832 """ ipsec 4o4 tunnel basic reassembly test """
833 self.verify_tun_reass_44(self.params[socket.AF_INET])
835 def test_tun_burst44(self):
836 """ ipsec 4o4 tunnel burst test """
837 self.verify_tun_44(self.params[socket.AF_INET], count=257)
840 class IpsecTun6(object):
841 """ verify methods for Tunnel v6 """
842 def verify_counters6(self, p_in, p_out, count):
843 if (hasattr(p_in, "tun_sa_in")):
844 pkts = p_in.tun_sa_in.get_stats()['packets']
845 self.assertEqual(pkts, count,
846 "incorrect SA in counts: expected %d != %d" %
848 if (hasattr(p_out, "tun_sa_out")):
849 pkts = p_out.tun_sa_out.get_stats()['packets']
850 self.assertEqual(pkts, count,
851 "incorrect SA out counts: expected %d != %d" %
853 self.assert_packet_counter_equal(self.tun6_encrypt_node_name, count)
854 self.assert_packet_counter_equal(self.tun6_decrypt_node_name, count)
856 def verify_decrypted6(self, p, rxs):
858 self.assert_equal(rx[IPv6].src, p.remote_tun_if_host)
859 self.assert_equal(rx[IPv6].dst, self.pg1.remote_ip6)
860 self.assert_packet_checksums_valid(rx)
862 def verify_encrypted6(self, p, sa, rxs):
864 self.assert_packet_checksums_valid(rx)
865 self.assertEqual(len(rx) - len(Ether()) - len(IPv6()),
868 decrypt_pkt = p.vpp_tun_sa.decrypt(rx[IPv6])
869 if not decrypt_pkt.haslayer(IPv6):
870 decrypt_pkt = IPv6(decrypt_pkt[Raw].load)
871 self.assert_packet_checksums_valid(decrypt_pkt)
872 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip6)
873 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
875 self.logger.debug(ppp("Unexpected packet:", rx))
877 self.logger.debug(ppp("Decrypted packet:", decrypt_pkt))
882 def verify_drop_tun_66(self, p_in, count=1, payload_size=64):
883 self.vapi.cli("clear errors")
884 self.vapi.cli("clear ipsec sa")
886 send_pkts = self.gen_encrypt_pkts6(p_in.scapy_tun_sa, self.tun_if,
887 src=p_in.remote_tun_if_host,
888 dst=self.pg1.remote_ip6,
890 self.send_and_assert_no_replies(self.tun_if, send_pkts)
891 self.logger.info(self.vapi.cli("sh punt stats"))
893 def verify_tun_66(self, p_in, p_out=None, count=1, payload_size=64):
894 self.vapi.cli("clear errors")
895 self.vapi.cli("clear ipsec sa")
899 send_pkts = self.gen_encrypt_pkts6(p_in.scapy_tun_sa, self.tun_if,
900 src=p_in.remote_tun_if_host,
901 dst=self.pg1.remote_ip6,
903 recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
904 self.verify_decrypted6(p_in, recv_pkts)
906 send_pkts = self.gen_pkts6(self.pg1, src=self.pg1.remote_ip6,
907 dst=p_out.remote_tun_if_host,
909 payload_size=payload_size)
910 recv_pkts = self.send_and_expect(self.pg1, send_pkts,
912 self.verify_encrypted6(p_out, p_out.vpp_tun_sa, recv_pkts)
915 self.logger.info(self.vapi.ppcli("show error"))
916 self.logger.info(self.vapi.ppcli("show ipsec all"))
917 self.verify_counters6(p_in, p_out, count)
919 def verify_tun_reass_66(self, p):
920 self.vapi.cli("clear errors")
921 self.vapi.ip_reassembly_enable_disable(
922 sw_if_index=self.tun_if.sw_if_index, enable_ip6=True)
925 send_pkts = self.gen_encrypt_pkts6(p.scapy_tun_sa, self.tun_if,
926 src=p.remote_tun_if_host,
927 dst=self.pg1.remote_ip6,
930 send_pkts = fragment_rfc8200(send_pkts[0], 1, 1400, self.logger)
931 recv_pkts = self.send_and_expect(self.tun_if, send_pkts,
933 self.verify_decrypted6(p, recv_pkts)
935 send_pkts = self.gen_pkts6(self.pg1, src=self.pg1.remote_ip6,
936 dst=p.remote_tun_if_host,
939 recv_pkts = self.send_and_expect(self.pg1, send_pkts,
941 self.verify_encrypted6(p, p.vpp_tun_sa, recv_pkts)
943 self.logger.info(self.vapi.ppcli("show error"))
944 self.logger.info(self.vapi.ppcli("show ipsec all"))
945 self.verify_counters6(p, p, 1)
946 self.vapi.ip_reassembly_enable_disable(
947 sw_if_index=self.tun_if.sw_if_index, enable_ip6=False)
949 def verify_tun_46(self, p, count=1):
950 """ ipsec 4o6 tunnel basic test """
951 self.vapi.cli("clear errors")
953 send_pkts = self.gen_encrypt_pkts(p.scapy_tun_sa, self.tun_if,
954 src=p.remote_tun_if_host4,
955 dst=self.pg1.remote_ip4,
957 recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
958 for recv_pkt in recv_pkts:
959 self.assert_equal(recv_pkt[IP].src, p.remote_tun_if_host4)
960 self.assert_equal(recv_pkt[IP].dst, self.pg1.remote_ip4)
961 self.assert_packet_checksums_valid(recv_pkt)
962 send_pkts = self.gen_pkts(self.pg1, src=self.pg1.remote_ip4,
963 dst=p.remote_tun_if_host4,
965 recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
966 for recv_pkt in recv_pkts:
968 decrypt_pkt = p.vpp_tun_sa.decrypt(recv_pkt[IPv6])
969 if not decrypt_pkt.haslayer(IP):
970 decrypt_pkt = IP(decrypt_pkt[Raw].load)
971 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip4)
972 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host4)
973 self.assert_packet_checksums_valid(decrypt_pkt)
975 self.logger.debug(ppp("Unexpected packet:", recv_pkt))
977 self.logger.debug(ppp("Decrypted packet:",
983 self.logger.info(self.vapi.ppcli("show error"))
984 self.logger.info(self.vapi.ppcli("show ipsec all"))
985 self.verify_counters6(p, p, count)
988 class IpsecTun6Tests(IpsecTun6):
989 """ UT test methods for Tunnel v6 """
991 def test_tun_basic66(self):
992 """ ipsec 6o6 tunnel basic test """
993 self.verify_tun_66(self.params[socket.AF_INET6], count=1)
995 def test_tun_reass_basic66(self):
996 """ ipsec 6o6 tunnel basic reassembly test """
997 self.verify_tun_reass_66(self.params[socket.AF_INET6])
999 def test_tun_burst66(self):
1000 """ ipsec 6o6 tunnel burst test """
1001 self.verify_tun_66(self.params[socket.AF_INET6], count=257)
1004 class IpsecTun46Tests(IpsecTun4Tests, IpsecTun6Tests):
1005 """ UT test methods for Tunnel v6 & v4 """
1009 if __name__ == '__main__':
1010 unittest.main(testRunner=VppTestRunner)