test/template_ipsec.py

   1 import unittest
   2 import socket
   3 import struct
   4
   5 from scapy.layers.inet import IP, ICMP, TCP, UDP
   6 from scapy.layers.ipsec import SecurityAssociation
   7 from scapy.layers.l2 import Ether, Raw
   8 from scapy.layers.inet6 import IPv6, ICMPv6EchoRequest
   9
  10 from framework import VppTestCase, VppTestRunner
  11 from util import ppp, reassemble4
  12 from vpp_papi import VppEnum
  13
  14
  15 class IPsecIPv4Params(object):
  16
  17     addr_type = socket.AF_INET
  18     addr_any = "0.0.0.0"
  19     addr_bcast = "255.255.255.255"
  20     addr_len = 32
  21     is_ipv6 = 0
  22
  23     def __init__(self):
  24         self.remote_tun_if_host = '1.1.1.1'
  25         self.remote_tun_if_host6 = '1111::1'
  26
  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
  31
  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
  36
  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 = 'C91KUR9GYMm5GfkEvNjX'
  41
  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 = 'JPjyOWBeVEQiMe7h'
  46         self.salt = 0
  47         self.flags = 0
  48         self.nat_header = None
  49
  50
  51 class IPsecIPv6Params(object):
  52
  53     addr_type = socket.AF_INET6
  54     addr_any = "0::0"
  55     addr_bcast = "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"
  56     addr_len = 128
  57     is_ipv6 = 1
  58
  59     def __init__(self):
  60         self.remote_tun_if_host = '1111:1111:1111:1111:1111:1111:1111:1111'
  61         self.remote_tun_if_host4 = '1.1.1.1'
  62
  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
  67
  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
  72
  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 = 'C91KUR9GYMm5GfkEvNjX'
  77
  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 = 'JPjyOWBeVEQiMe7h'
  82         self.salt = 0
  83         self.flags = 0
  84         self.nat_header = None
  85
  86
  87 def config_tun_params(p, encryption_type, tun_if):
  88     ip_class_by_addr_type = {socket.AF_INET: IP, socket.AF_INET6: IPv6}
  89     use_esn = bool(p.flags & (VppEnum.vl_api_ipsec_sad_flags_t.
  90                               IPSEC_API_SAD_FLAG_USE_ESN))
  91     if p.crypt_algo == "AES-GCM":
  92         crypt_key = p.crypt_key + struct.pack("!I", p.salt)
  93     else:
  94         crypt_key = p.crypt_key
  95     p.scapy_tun_sa = SecurityAssociation(
  96         encryption_type, spi=p.vpp_tun_spi,
  97         crypt_algo=p.crypt_algo,
  98         crypt_key=crypt_key,
  99         auth_algo=p.auth_algo, auth_key=p.auth_key,
 100         tunnel_header=ip_class_by_addr_type[p.addr_type](
 101             src=tun_if.remote_addr[p.addr_type],
 102             dst=tun_if.local_addr[p.addr_type]),
 103         nat_t_header=p.nat_header,
 104         use_esn=use_esn)
 105     p.vpp_tun_sa = SecurityAssociation(
 106         encryption_type, spi=p.scapy_tun_spi,
 107         crypt_algo=p.crypt_algo,
 108         crypt_key=crypt_key,
 109         auth_algo=p.auth_algo, auth_key=p.auth_key,
 110         tunnel_header=ip_class_by_addr_type[p.addr_type](
 111             dst=tun_if.remote_addr[p.addr_type],
 112             src=tun_if.local_addr[p.addr_type]),
 113         nat_t_header=p.nat_header,
 114         use_esn=use_esn)
 115
 116
 117 def config_tra_params(p, encryption_type):
 118     use_esn = bool(p.flags & (VppEnum.vl_api_ipsec_sad_flags_t.
 119                               IPSEC_API_SAD_FLAG_USE_ESN))
 120     if p.crypt_algo == "AES-GCM":
 121         crypt_key = p.crypt_key + struct.pack("!I", p.salt)
 122     else:
 123         crypt_key = p.crypt_key
 124     p.scapy_tra_sa = SecurityAssociation(
 125         encryption_type,
 126         spi=p.vpp_tra_spi,
 127         crypt_algo=p.crypt_algo,
 128         crypt_key=crypt_key,
 129         auth_algo=p.auth_algo,
 130         auth_key=p.auth_key,
 131         nat_t_header=p.nat_header,
 132         use_esn=use_esn)
 133     p.vpp_tra_sa = SecurityAssociation(
 134         encryption_type,
 135         spi=p.scapy_tra_spi,
 136         crypt_algo=p.crypt_algo,
 137         crypt_key=crypt_key,
 138         auth_algo=p.auth_algo,
 139         auth_key=p.auth_key,
 140         nat_t_header=p.nat_header,
 141         use_esn=use_esn)
 142
 143
 144 class TemplateIpsec(VppTestCase):
 145     """
 146     TRANSPORT MODE:
 147
 148      ------   encrypt   ---
 149     |tra_if| <-------> |VPP|
 150      ------   decrypt   ---
 151
 152     TUNNEL MODE:
 153
 154      ------   encrypt   ---   plain   ---
 155     |tun_if| <-------  |VPP| <------ |pg1|
 156      ------             ---           ---
 157
 158      ------   decrypt   ---   plain   ---
 159     |tun_if| ------->  |VPP| ------> |pg1|
 160      ------             ---           ---
 161     """
 162     tun_spd_id = 1
 163     tra_spd_id = 2
 164
 165     def ipsec_select_backend(self):
 166         """ empty method to be overloaded when necessary """
 167         pass
 168
 169     @classmethod
 170     def setUpClass(cls):
 171         super(TemplateIpsec, cls).setUpClass()
 172
 173     @classmethod
 174     def tearDownClass(cls):
 175         super(TemplateIpsec, cls).tearDownClass()
 176
 177     def setup_params(self):
 178         self.ipv4_params = IPsecIPv4Params()
 179         self.ipv6_params = IPsecIPv6Params()
 180         self.params = {self.ipv4_params.addr_type: self.ipv4_params,
 181                        self.ipv6_params.addr_type: self.ipv6_params}
 182
 183     def config_interfaces(self):
 184         self.create_pg_interfaces(range(3))
 185         self.interfaces = list(self.pg_interfaces)
 186         for i in self.interfaces:
 187             i.admin_up()
 188             i.config_ip4()
 189             i.resolve_arp()
 190             i.config_ip6()
 191             i.resolve_ndp()
 192
 193     def setUp(self):
 194         super(TemplateIpsec, self).setUp()
 195
 196         self.setup_params()
 197
 198         self.vpp_esp_protocol = (VppEnum.vl_api_ipsec_proto_t.
 199                                  IPSEC_API_PROTO_ESP)
 200         self.vpp_ah_protocol = (VppEnum.vl_api_ipsec_proto_t.
 201                                 IPSEC_API_PROTO_AH)
 202
 203         self.config_interfaces()
 204
 205         self.ipsec_select_backend()
 206
 207     def unconfig_interfaces(self):
 208         for i in self.interfaces:
 209             i.admin_down()
 210             i.unconfig_ip4()
 211             i.unconfig_ip6()
 212
 213     def tearDown(self):
 214         super(TemplateIpsec, self).tearDown()
 215
 216         self.unconfig_interfaces()
 217
 218     def show_commands_at_teardown(self):
 219         self.logger.info(self.vapi.cli("show hardware"))
 220
 221     def gen_encrypt_pkts(self, sa, sw_intf, src, dst, count=1,
 222                          payload_size=54):
 223         return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
 224                 sa.encrypt(IP(src=src, dst=dst) /
 225                            ICMP() / Raw('X' * payload_size))
 226                 for i in range(count)]
 227
 228     def gen_encrypt_pkts6(self, sa, sw_intf, src, dst, count=1,
 229                           payload_size=54):
 230         return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
 231                 sa.encrypt(IPv6(src=src, dst=dst) /
 232                            ICMPv6EchoRequest(id=0, seq=1,
 233                                              data='X' * payload_size))
 234                 for i in range(count)]
 235
 236     def gen_pkts(self, sw_intf, src, dst, count=1, payload_size=54):
 237         return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
 238                 IP(src=src, dst=dst) / ICMP() / Raw('X' * payload_size)
 239                 for i in range(count)]
 240
 241     def gen_pkts6(self, sw_intf, src, dst, count=1, payload_size=54):
 242         return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
 243                 IPv6(src=src, dst=dst) /
 244                 ICMPv6EchoRequest(id=0, seq=1, data='X' * payload_size)
 245                 for i in range(count)]
 246
 247
 248 class IpsecTcp(object):
 249     def verify_tcp_checksum(self):
 250         self.vapi.cli("test http server")
 251         p = self.params[socket.AF_INET]
 252         config_tun_params(p, self.encryption_type, self.tun_if)
 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)
 259         recv = recv[0]
 260         decrypted = p.vpp_tun_sa.decrypt(recv[IP])
 261         self.assert_packet_checksums_valid(decrypted)
 262
 263
 264 class IpsecTcpTests(IpsecTcp):
 265     def test_tcp_checksum(self):
 266         """ verify checksum correctness for vpp generated packets """
 267         self.verify_tcp_checksum()
 268
 269
 270 class IpsecTra4(object):
 271     """ verify methods for Transport v4 """
 272     def verify_tra_anti_replay(self, count=1):
 273         p = self.params[socket.AF_INET]
 274         use_esn = p.vpp_tra_sa.use_esn
 275
 276         # fire in a packet with seq number 1
 277         pkt = (Ether(src=self.tra_if.remote_mac,
 278                      dst=self.tra_if.local_mac) /
 279                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 280                                          dst=self.tra_if.local_ip4) /
 281                                       ICMP(),
 282                                       seq_num=1))
 283         recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 284
 285         # now move the window over to 235
 286         pkt = (Ether(src=self.tra_if.remote_mac,
 287                      dst=self.tra_if.local_mac) /
 288                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 289                                          dst=self.tra_if.local_ip4) /
 290                                       ICMP(),
 291                                       seq_num=235))
 292         recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 293
 294         # replayed packets are dropped
 295         self.send_and_assert_no_replies(self.tra_if, pkt * 3)
 296         self.assert_packet_counter_equal(
 297             '/err/%s/SA replayed packet' % self.tra4_decrypt_node_name, 3)
 298
 299         # the window size is 64 packets
 300         # in window are still accepted
 301         pkt = (Ether(src=self.tra_if.remote_mac,
 302                      dst=self.tra_if.local_mac) /
 303                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 304                                          dst=self.tra_if.local_ip4) /
 305                                       ICMP(),
 306                                       seq_num=172))
 307         recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 308
 309         # a packet that does not decrypt does not move the window forward
 310         bogus_sa = SecurityAssociation(self.encryption_type,
 311                                        p.vpp_tra_spi)
 312         pkt = (Ether(src=self.tra_if.remote_mac,
 313                      dst=self.tra_if.local_mac) /
 314                bogus_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 315                                    dst=self.tra_if.local_ip4) /
 316                                 ICMP(),
 317                                 seq_num=350))
 318         self.send_and_assert_no_replies(self.tra_if, pkt * 17)
 319
 320         self.assert_packet_counter_equal(
 321             '/err/%s/Integrity check failed' % self.tra4_decrypt_node_name, 17)
 322
 323         # which we can determine since this packet is still in the window
 324         pkt = (Ether(src=self.tra_if.remote_mac,
 325                      dst=self.tra_if.local_mac) /
 326                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 327                                          dst=self.tra_if.local_ip4) /
 328                                       ICMP(),
 329                                       seq_num=234))
 330         self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 331
 332         # out of window are dropped
 333         pkt = (Ether(src=self.tra_if.remote_mac,
 334                      dst=self.tra_if.local_mac) /
 335                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 336                                          dst=self.tra_if.local_ip4) /
 337                                       ICMP(),
 338                                       seq_num=17))
 339         self.send_and_assert_no_replies(self.tra_if, pkt * 17)
 340
 341         if use_esn:
 342             # an out of window error with ESN looks like a high sequence
 343             # wrap. but since it isn't then the verify will fail.
 344             self.assert_packet_counter_equal(
 345                 '/err/%s/Integrity check failed' %
 346                 self.tra4_decrypt_node_name, 34)
 347
 348         else:
 349             self.assert_packet_counter_equal(
 350                 '/err/%s/SA replayed packet' %
 351                 self.tra4_decrypt_node_name, 20)
 352
 353         # valid packet moves the window over to 236
 354         pkt = (Ether(src=self.tra_if.remote_mac,
 355                      dst=self.tra_if.local_mac) /
 356                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 357                                          dst=self.tra_if.local_ip4) /
 358                                       ICMP(),
 359                                       seq_num=236))
 360         rx = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 361         decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
 362
 363         # move VPP's SA to just before the seq-number wrap
 364         self.vapi.cli("test ipsec sa %d seq 0xffffffff" % p.scapy_tra_sa_id)
 365
 366         # then fire in a packet that VPP should drop because it causes the
 367         # seq number to wrap  unless we're using extended.
 368         pkt = (Ether(src=self.tra_if.remote_mac,
 369                      dst=self.tra_if.local_mac) /
 370                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 371                                          dst=self.tra_if.local_ip4) /
 372                                       ICMP(),
 373                                       seq_num=237))
 374
 375         if use_esn:
 376             rx = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 377             # in order to decrpyt the high order number needs to wrap
 378             p.vpp_tra_sa.seq_num = 0x100000000
 379             decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
 380
 381             # send packets with high bits set
 382             p.scapy_tra_sa.seq_num = 0x100000005
 383             pkt = (Ether(src=self.tra_if.remote_mac,
 384                          dst=self.tra_if.local_mac) /
 385                    p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 386                                              dst=self.tra_if.local_ip4) /
 387                                           ICMP(),
 388                                           seq_num=0x100000005))
 389             rx = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 390             # in order to decrpyt the high order number needs to wrap
 391             decrypted = p.vpp_tra_sa.decrypt(rx[0][IP])
 392         else:
 393             self.send_and_assert_no_replies(self.tra_if, [pkt])
 394             self.assert_packet_counter_equal(
 395                 '/err/%s/sequence number cycled' %
 396                 self.tra4_encrypt_node_name, 1)
 397
 398         # move the security-associations seq number on to the last we used
 399         self.vapi.cli("test ipsec sa %d seq 0x15f" % p.scapy_tra_sa_id)
 400         p.scapy_tra_sa.seq_num = 351
 401         p.vpp_tra_sa.seq_num = 351
 402
 403     def verify_tra_basic4(self, count=1):
 404         """ ipsec v4 transport basic test """
 405         self.vapi.cli("clear errors")
 406         try:
 407             p = self.params[socket.AF_INET]
 408             send_pkts = self.gen_encrypt_pkts(p.scapy_tra_sa, self.tra_if,
 409                                               src=self.tra_if.remote_ip4,
 410                                               dst=self.tra_if.local_ip4,
 411                                               count=count)
 412             recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
 413                                              self.tra_if)
 414             for rx in recv_pkts:
 415                 self.assertEqual(len(rx) - len(Ether()), rx[IP].len)
 416                 self.assert_packet_checksums_valid(rx)
 417                 try:
 418                     decrypted = p.vpp_tra_sa.decrypt(rx[IP])
 419                     self.assert_packet_checksums_valid(decrypted)
 420                 except:
 421                     self.logger.debug(ppp("Unexpected packet:", rx))
 422                     raise
 423         finally:
 424             self.logger.info(self.vapi.ppcli("show error"))
 425             self.logger.info(self.vapi.ppcli("show ipsec"))
 426
 427         pkts = p.tra_sa_in.get_stats()['packets']
 428         self.assertEqual(pkts, count,
 429                          "incorrect SA in counts: expected %d != %d" %
 430                          (count, pkts))
 431         pkts = p.tra_sa_out.get_stats()['packets']
 432         self.assertEqual(pkts, count,
 433                          "incorrect SA out counts: expected %d != %d" %
 434                          (count, pkts))
 435
 436         self.assert_packet_counter_equal(self.tra4_encrypt_node_name, count)
 437         self.assert_packet_counter_equal(self.tra4_decrypt_node_name, count)
 438
 439
 440 class IpsecTra4Tests(IpsecTra4):
 441     """ UT test methods for Transport v4 """
 442     def test_tra_anti_replay(self):
 443         """ ipsec v4 transport anti-reply test """
 444         self.verify_tra_anti_replay(count=1)
 445
 446     def test_tra_basic(self, count=1):
 447         """ ipsec v4 transport basic test """
 448         self.verify_tra_basic4(count=1)
 449
 450     def test_tra_burst(self):
 451         """ ipsec v4 transport burst test """
 452         self.verify_tra_basic4(count=257)
 453
 454
 455 class IpsecTra6(object):
 456     """ verify methods for Transport v6 """
 457     def verify_tra_basic6(self, count=1):
 458         self.vapi.cli("clear errors")
 459         try:
 460             p = self.params[socket.AF_INET6]
 461             send_pkts = self.gen_encrypt_pkts6(p.scapy_tra_sa, self.tra_if,
 462                                                src=self.tra_if.remote_ip6,
 463                                                dst=self.tra_if.local_ip6,
 464                                                count=count)
 465             recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
 466                                              self.tra_if)
 467             for rx in recv_pkts:
 468                 self.assertEqual(len(rx) - len(Ether()) - len(IPv6()),
 469                                  rx[IPv6].plen)
 470                 try:
 471                     decrypted = p.vpp_tra_sa.decrypt(rx[IPv6])
 472                     self.assert_packet_checksums_valid(decrypted)
 473                 except:
 474                     self.logger.debug(ppp("Unexpected packet:", rx))
 475                     raise
 476         finally:
 477             self.logger.info(self.vapi.ppcli("show error"))
 478             self.logger.info(self.vapi.ppcli("show ipsec"))
 479
 480         pkts = p.tra_sa_in.get_stats()['packets']
 481         self.assertEqual(pkts, count,
 482                          "incorrect SA in counts: expected %d != %d" %
 483                          (count, pkts))
 484         pkts = p.tra_sa_out.get_stats()['packets']
 485         self.assertEqual(pkts, count,
 486                          "incorrect SA out counts: expected %d != %d" %
 487                          (count, pkts))
 488         self.assert_packet_counter_equal(self.tra6_encrypt_node_name, count)
 489         self.assert_packet_counter_equal(self.tra6_decrypt_node_name, count)
 490
 491
 492 class IpsecTra6Tests(IpsecTra6):
 493     """ UT test methods for Transport v6 """
 494     def test_tra_basic6(self):
 495         """ ipsec v6 transport basic test """
 496         self.verify_tra_basic6(count=1)
 497
 498     def test_tra_burst6(self):
 499         """ ipsec v6 transport burst test """
 500         self.verify_tra_basic6(count=257)
 501
 502
 503 class IpsecTra46Tests(IpsecTra4Tests, IpsecTra6Tests):
 504     """ UT test methods for Transport v6 and v4"""
 505     pass
 506
 507
 508 class IpsecTun4(object):
 509     """ verify methods for Tunnel v4 """
 510     def verify_counters(self, p, count):
 511         if (hasattr(p, "spd_policy_in_any")):
 512             pkts = p.spd_policy_in_any.get_stats()['packets']
 513             self.assertEqual(pkts, count,
 514                              "incorrect SPD any policy: expected %d != %d" %
 515                              (count, pkts))
 516
 517         if (hasattr(p, "tun_sa_in")):
 518             pkts = p.tun_sa_in.get_stats()['packets']
 519             self.assertEqual(pkts, count,
 520                              "incorrect SA in counts: expected %d != %d" %
 521                              (count, pkts))
 522             pkts = p.tun_sa_out.get_stats()['packets']
 523             self.assertEqual(pkts, count,
 524                              "incorrect SA out counts: expected %d != %d" %
 525                              (count, pkts))
 526
 527         self.assert_packet_counter_equal(self.tun4_encrypt_node_name, count)
 528         self.assert_packet_counter_equal(self.tun4_decrypt_node_name, count)
 529
 530     def verify_decrypted(self, p, rxs):
 531         for rx in rxs:
 532             self.assert_equal(rx[IP].src, p.remote_tun_if_host)
 533             self.assert_equal(rx[IP].dst, self.pg1.remote_ip4)
 534             self.assert_packet_checksums_valid(rx)
 535
 536     def verify_encrypted(self, p, sa, rxs):
 537         decrypt_pkts = []
 538         for rx in rxs:
 539             self.assert_packet_checksums_valid(rx)
 540             self.assertEqual(len(rx) - len(Ether()), rx[IP].len)
 541             try:
 542                 decrypt_pkt = p.vpp_tun_sa.decrypt(rx[IP])
 543                 if not decrypt_pkt.haslayer(IP):
 544                     decrypt_pkt = IP(decrypt_pkt[Raw].load)
 545                 decrypt_pkts.append(decrypt_pkt)
 546                 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip4)
 547                 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
 548             except:
 549                 self.logger.debug(ppp("Unexpected packet:", rx))
 550                 try:
 551                     self.logger.debug(ppp("Decrypted packet:", decrypt_pkt))
 552                 except:
 553                     pass
 554                 raise
 555         pkts = reassemble4(decrypt_pkts)
 556         for pkt in pkts:
 557             self.assert_packet_checksums_valid(pkt)
 558
 559     def verify_tun_44(self, p, count=1, payload_size=64, n_rx=None):
 560         self.vapi.cli("clear errors")
 561         if not n_rx:
 562             n_rx = count
 563         try:
 564             config_tun_params(p, self.encryption_type, self.tun_if)
 565             send_pkts = self.gen_encrypt_pkts(p.scapy_tun_sa, self.tun_if,
 566                                               src=p.remote_tun_if_host,
 567                                               dst=self.pg1.remote_ip4,
 568                                               count=count)
 569             recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
 570             self.verify_decrypted(p, recv_pkts)
 571
 572             send_pkts = self.gen_pkts(self.pg1, src=self.pg1.remote_ip4,
 573                                       dst=p.remote_tun_if_host, count=count,
 574                                       payload_size=payload_size)
 575             recv_pkts = self.send_and_expect(self.pg1, send_pkts,
 576                                              self.tun_if, n_rx)
 577             self.verify_encrypted(p, p.vpp_tun_sa, recv_pkts)
 578
 579         finally:
 580             self.logger.info(self.vapi.ppcli("show error"))
 581             self.logger.info(self.vapi.ppcli("show ipsec"))
 582
 583         self.verify_counters(p, count)
 584
 585     def verify_tun_64(self, p, count=1):
 586         self.vapi.cli("clear errors")
 587         try:
 588             config_tun_params(p, self.encryption_type, self.tun_if)
 589             send_pkts = self.gen_encrypt_pkts6(p.scapy_tun_sa, self.tun_if,
 590                                                src=p.remote_tun_if_host6,
 591                                                dst=self.pg1.remote_ip6,
 592                                                count=count)
 593             recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
 594             for recv_pkt in recv_pkts:
 595                 self.assert_equal(recv_pkt[IPv6].src, p.remote_tun_if_host6)
 596                 self.assert_equal(recv_pkt[IPv6].dst, self.pg1.remote_ip6)
 597                 self.assert_packet_checksums_valid(recv_pkt)
 598             send_pkts = self.gen_pkts6(self.pg1, src=self.pg1.remote_ip6,
 599                                        dst=p.remote_tun_if_host6, count=count)
 600             recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
 601             for recv_pkt in recv_pkts:
 602                 try:
 603                     decrypt_pkt = p.vpp_tun_sa.decrypt(recv_pkt[IP])
 604                     if not decrypt_pkt.haslayer(IPv6):
 605                         decrypt_pkt = IPv6(decrypt_pkt[Raw].load)
 606                     self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip6)
 607                     self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host6)
 608                     self.assert_packet_checksums_valid(decrypt_pkt)
 609                 except:
 610                     self.logger.error(ppp("Unexpected packet:", recv_pkt))
 611                     try:
 612                         self.logger.debug(
 613                             ppp("Decrypted packet:", decrypt_pkt))
 614                     except:
 615                         pass
 616                     raise
 617         finally:
 618             self.logger.info(self.vapi.ppcli("show error"))
 619             self.logger.info(self.vapi.ppcli("show ipsec"))
 620
 621         self.verify_counters(p, count)
 622
 623
 624 class IpsecTun4Tests(IpsecTun4):
 625     """ UT test methods for Tunnel v4 """
 626     def test_tun_basic44(self):
 627         """ ipsec 4o4 tunnel basic test """
 628         self.verify_tun_44(self.params[socket.AF_INET], count=1)
 629
 630     def test_tun_burst44(self):
 631         """ ipsec 4o4 tunnel burst test """
 632         self.verify_tun_44(self.params[socket.AF_INET], count=257)
 633
 634
 635 class IpsecTun6(object):
 636     """ verify methods for Tunnel v6 """
 637     def verify_counters(self, p, count):
 638         if (hasattr(p, "tun_sa_in")):
 639             pkts = p.tun_sa_in.get_stats()['packets']
 640             self.assertEqual(pkts, count,
 641                              "incorrect SA in counts: expected %d != %d" %
 642                              (count, pkts))
 643             pkts = p.tun_sa_out.get_stats()['packets']
 644             self.assertEqual(pkts, count,
 645                              "incorrect SA out counts: expected %d != %d" %
 646                              (count, pkts))
 647         self.assert_packet_counter_equal(self.tun6_encrypt_node_name, count)
 648         self.assert_packet_counter_equal(self.tun6_decrypt_node_name, count)
 649
 650     def verify_tun_66(self, p, count=1):
 651         """ ipsec 6o6 tunnel basic test """
 652         self.vapi.cli("clear errors")
 653         try:
 654             config_tun_params(p, self.encryption_type, self.tun_if)
 655             send_pkts = self.gen_encrypt_pkts6(p.scapy_tun_sa, self.tun_if,
 656                                                src=p.remote_tun_if_host,
 657                                                dst=self.pg1.remote_ip6,
 658                                                count=count)
 659             recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
 660             for recv_pkt in recv_pkts:
 661                 self.assert_equal(recv_pkt[IPv6].src, p.remote_tun_if_host)
 662                 self.assert_equal(recv_pkt[IPv6].dst, self.pg1.remote_ip6)
 663                 self.assert_packet_checksums_valid(recv_pkt)
 664             send_pkts = self.gen_pkts6(self.pg1, src=self.pg1.remote_ip6,
 665                                        dst=p.remote_tun_if_host,
 666                                        count=count)
 667             recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
 668             for recv_pkt in recv_pkts:
 669                 self.assertEqual(len(recv_pkt) - len(Ether()) - len(IPv6()),
 670                                  recv_pkt[IPv6].plen)
 671                 try:
 672                     decrypt_pkt = p.vpp_tun_sa.decrypt(recv_pkt[IPv6])
 673                     if not decrypt_pkt.haslayer(IPv6):
 674                         decrypt_pkt = IPv6(decrypt_pkt[Raw].load)
 675                     self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip6)
 676                     self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
 677                     self.assert_packet_checksums_valid(decrypt_pkt)
 678                 except:
 679                     self.logger.debug(ppp("Unexpected packet:", recv_pkt))
 680                     try:
 681                         self.logger.debug(
 682                             ppp("Decrypted packet:", decrypt_pkt))
 683                     except:
 684                         pass
 685                     raise
 686         finally:
 687             self.logger.info(self.vapi.ppcli("show error"))
 688             self.logger.info(self.vapi.ppcli("show ipsec"))
 689         self.verify_counters(p, count)
 690
 691     def verify_tun_46(self, p, count=1):
 692         """ ipsec 4o6 tunnel basic test """
 693         self.vapi.cli("clear errors")
 694         try:
 695             config_tun_params(p, self.encryption_type, self.tun_if)
 696             send_pkts = self.gen_encrypt_pkts(p.scapy_tun_sa, self.tun_if,
 697                                               src=p.remote_tun_if_host4,
 698                                               dst=self.pg1.remote_ip4,
 699                                               count=count)
 700             recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
 701             for recv_pkt in recv_pkts:
 702                 self.assert_equal(recv_pkt[IP].src, p.remote_tun_if_host4)
 703                 self.assert_equal(recv_pkt[IP].dst, self.pg1.remote_ip4)
 704                 self.assert_packet_checksums_valid(recv_pkt)
 705             send_pkts = self.gen_pkts(self.pg1, src=self.pg1.remote_ip4,
 706                                       dst=p.remote_tun_if_host4,
 707                                       count=count)
 708             recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
 709             for recv_pkt in recv_pkts:
 710                 try:
 711                     decrypt_pkt = p.vpp_tun_sa.decrypt(recv_pkt[IPv6])
 712                     if not decrypt_pkt.haslayer(IP):
 713                         decrypt_pkt = IP(decrypt_pkt[Raw].load)
 714                     self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip4)
 715                     self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host4)
 716                     self.assert_packet_checksums_valid(decrypt_pkt)
 717                 except:
 718                     self.logger.debug(ppp("Unexpected packet:", recv_pkt))
 719                     try:
 720                         self.logger.debug(ppp("Decrypted packet:",
 721                                               decrypt_pkt))
 722                     except:
 723                         pass
 724                     raise
 725         finally:
 726             self.logger.info(self.vapi.ppcli("show error"))
 727             self.logger.info(self.vapi.ppcli("show ipsec"))
 728         self.verify_counters(p, count)
 729
 730
 731 class IpsecTun6Tests(IpsecTun6):
 732     """ UT test methods for Tunnel v6 """
 733
 734     def test_tun_basic66(self):
 735         """ ipsec 6o6 tunnel basic test """
 736         self.verify_tun_66(self.params[socket.AF_INET6], count=1)
 737
 738     def test_tun_burst66(self):
 739         """ ipsec 6o6 tunnel burst test """
 740         self.verify_tun_66(self.params[socket.AF_INET6], count=257)
 741
 742
 743 class IpsecTun46Tests(IpsecTun4Tests, IpsecTun6Tests):
 744     """ UT test methods for Tunnel v6 & v4 """
 745     pass
 746
 747
 748 if __name__ == '__main__':
 749     unittest.main(testRunner=VppTestRunner)