test/template_ipsec.py

   1 import unittest
   2 import socket
   3
   4 from scapy.layers.inet import IP, ICMP, TCP
   5 from scapy.layers.ipsec import SecurityAssociation
   6 from scapy.layers.l2 import Ether, Raw
   7 from scapy.layers.inet6 import IPv6, ICMPv6EchoRequest
   8
   9 from framework import VppTestCase, VppTestRunner
  10 from util import ppp
  11
  12
  13 class IPsecIPv4Params(object):
  14     addr_type = socket.AF_INET
  15     addr_any = "0.0.0.0"
  16     addr_bcast = "255.255.255.255"
  17     addr_len = 32
  18     is_ipv6 = 0
  19     remote_tun_if_host = '1.1.1.1'
  20
  21     scapy_tun_sa_id = 10
  22     scapy_tun_spi = 1001
  23     vpp_tun_sa_id = 20
  24     vpp_tun_spi = 1000
  25
  26     scapy_tra_sa_id = 30
  27     scapy_tra_spi = 2001
  28     vpp_tra_sa_id = 40
  29     vpp_tra_spi = 2000
  30
  31     auth_algo_vpp_id = 2  # internal VPP enum value for SHA1_96
  32     auth_algo = 'HMAC-SHA1-96'  # scapy name
  33     auth_key = 'C91KUR9GYMm5GfkEvNjX'
  34
  35     crypt_algo_vpp_id = 1  # internal VPP enum value for AES_CBC_128
  36     crypt_algo = 'AES-CBC'  # scapy name
  37     crypt_key = 'JPjyOWBeVEQiMe7h'
  38
  39
  40 class IPsecIPv6Params(object):
  41     addr_type = socket.AF_INET6
  42     addr_any = "0::0"
  43     addr_bcast = "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"
  44     addr_len = 128
  45     is_ipv6 = 1
  46     remote_tun_if_host = '1111:1111:1111:1111:1111:1111:1111:1111'
  47
  48     scapy_tun_sa_id = 50
  49     scapy_tun_spi = 3001
  50     vpp_tun_sa_id = 60
  51     vpp_tun_spi = 3000
  52
  53     scapy_tra_sa_id = 70
  54     scapy_tra_spi = 4001
  55     vpp_tra_sa_id = 80
  56     vpp_tra_spi = 4000
  57
  58     auth_algo_vpp_id = 4  # internal VPP enum value for SHA_256_128
  59     auth_algo = 'SHA2-256-128'  # scapy name
  60     auth_key = 'C91KUR9GYMm5GfkEvNjX'
  61
  62     crypt_algo_vpp_id = 3  # internal VPP enum value for AES_CBC_256
  63     crypt_algo = 'AES-CBC'  # scapy name
  64     crypt_key = 'JPjyOWBeVEQiMe7hJPjyOWBeVEQiMe7h'
  65
  66
  67 class TemplateIpsec(VppTestCase):
  68     """
  69     TRANSPORT MODE:
  70
  71      ------   encrypt   ---
  72     |tra_if| <-------> |VPP|
  73      ------   decrypt   ---
  74
  75     TUNNEL MODE:
  76
  77      ------   encrypt   ---   plain   ---
  78     |tun_if| <-------  |VPP| <------ |pg1|
  79      ------             ---           ---
  80
  81      ------   decrypt   ---   plain   ---
  82     |tun_if| ------->  |VPP| ------> |pg1|
  83      ------             ---           ---
  84     """
  85     ipv4_params = IPsecIPv4Params()
  86     ipv6_params = IPsecIPv6Params()
  87     params = {ipv4_params.addr_type: ipv4_params,
  88               ipv6_params.addr_type: ipv6_params}
  89
  90     payload = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  91
  92     tun_spd_id = 1
  93     tra_spd_id = 2
  94
  95     vpp_esp_protocol = 1
  96     vpp_ah_protocol = 0
  97
  98     @classmethod
  99     def ipsec_select_backend(cls):
 100         """ empty method to be overloaded when necessary """
 101         pass
 102
 103     @classmethod
 104     def setUpClass(cls):
 105         super(TemplateIpsec, cls).setUpClass()
 106         cls.create_pg_interfaces(range(3))
 107         cls.interfaces = list(cls.pg_interfaces)
 108         for i in cls.interfaces:
 109             i.admin_up()
 110             i.config_ip4()
 111             i.resolve_arp()
 112             i.config_ip6()
 113             i.resolve_ndp()
 114         cls.ipsec_select_backend()
 115
 116     def tearDown(self):
 117         super(TemplateIpsec, self).tearDown()
 118         if not self.vpp_dead:
 119             self.vapi.cli("show hardware")
 120
 121     def gen_encrypt_pkts(self, sa, sw_intf, src, dst, count=1):
 122         return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
 123                 sa.encrypt(IP(src=src, dst=dst) / ICMP() / self.payload)
 124                 for i in range(count)]
 125
 126     def gen_encrypt_pkts6(self, sa, sw_intf, src, dst, count=1):
 127         return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
 128                 sa.encrypt(IPv6(src=src, dst=dst) /
 129                            ICMPv6EchoRequest(id=0, seq=1, data=self.payload))
 130                 for i in range(count)]
 131
 132     def gen_pkts(self, sw_intf, src, dst, count=1):
 133         return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
 134                 IP(src=src, dst=dst) / ICMP() / self.payload
 135                 for i in range(count)]
 136
 137     def gen_pkts6(self, sw_intf, src, dst, count=1):
 138         return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
 139                 IPv6(src=src, dst=dst) /
 140                 ICMPv6EchoRequest(id=0, seq=1, data=self.payload)
 141                 for i in range(count)]
 142
 143     def configure_sa_tun(self, params):
 144         ip_class_by_addr_type = {socket.AF_INET: IP, socket.AF_INET6: IPv6}
 145         scapy_tun_sa = SecurityAssociation(
 146             self.encryption_type, spi=params.vpp_tun_spi,
 147             crypt_algo=params.crypt_algo, crypt_key=params.crypt_key,
 148             auth_algo=params.auth_algo, auth_key=params.auth_key,
 149             tunnel_header=ip_class_by_addr_type[params.addr_type](
 150                 src=self.tun_if.remote_addr[params.addr_type],
 151                 dst=self.tun_if.local_addr[params.addr_type]))
 152         vpp_tun_sa = SecurityAssociation(
 153             self.encryption_type, spi=params.scapy_tun_spi,
 154             crypt_algo=params.crypt_algo, crypt_key=params.crypt_key,
 155             auth_algo=params.auth_algo, auth_key=params.auth_key,
 156             tunnel_header=ip_class_by_addr_type[params.addr_type](
 157                 dst=self.tun_if.remote_addr[params.addr_type],
 158                 src=self.tun_if.local_addr[params.addr_type]))
 159         return vpp_tun_sa, scapy_tun_sa
 160
 161     @classmethod
 162     def configure_sa_tra(cls, params):
 163         params.scapy_tra_sa = SecurityAssociation(cls.encryption_type,
 164                                                   spi=params.vpp_tra_spi,
 165                                                   crypt_algo=params.crypt_algo,
 166                                                   crypt_key=params.crypt_key,
 167                                                   auth_algo=params.auth_algo,
 168                                                   auth_key=params.auth_key)
 169         params.vpp_tra_sa = SecurityAssociation(cls.encryption_type,
 170                                                 spi=params.scapy_tra_spi,
 171                                                 crypt_algo=params.crypt_algo,
 172                                                 crypt_key=params.crypt_key,
 173                                                 auth_algo=params.auth_algo,
 174                                                 auth_key=params.auth_key)
 175
 176
 177 class IpsecTcpTests(object):
 178     def test_tcp_checksum(self):
 179         """ verify checksum correctness for vpp generated packets """
 180         self.vapi.cli("test http server")
 181         p = self.params[socket.AF_INET]
 182         vpp_tun_sa, scapy_tun_sa = self.configure_sa_tun(p)
 183         send = (Ether(src=self.tun_if.remote_mac, dst=self.tun_if.local_mac) /
 184                 scapy_tun_sa.encrypt(IP(src=p.remote_tun_if_host,
 185                                         dst=self.tun_if.local_ip4) /
 186                                      TCP(flags='S', dport=80)))
 187         self.logger.debug(ppp("Sending packet:", send))
 188         recv = self.send_and_expect(self.tun_if, [send], self.tun_if)
 189         recv = recv[0]
 190         decrypted = vpp_tun_sa.decrypt(recv[IP])
 191         self.assert_packet_checksums_valid(decrypted)
 192
 193
 194 class IpsecTraTests(object):
 195     def test_tra_anti_replay(self, count=1):
 196         """ ipsec v4 transport anti-reply test """
 197         p = self.params[socket.AF_INET]
 198
 199         # fire in a packet with seq number 1
 200         pkt = (Ether(src=self.tra_if.remote_mac,
 201                      dst=self.tra_if.local_mac) /
 202                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 203                                          dst=self.tra_if.local_ip4) /
 204                                       ICMP(),
 205                                       seq_num=1))
 206         recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 207
 208         # now move the window over to 235
 209         pkt = (Ether(src=self.tra_if.remote_mac,
 210                      dst=self.tra_if.local_mac) /
 211                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 212                                          dst=self.tra_if.local_ip4) /
 213                                       ICMP(),
 214                                       seq_num=235))
 215         recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 216
 217         # the window size is 64 packets
 218         # in window are still accepted
 219         pkt = (Ether(src=self.tra_if.remote_mac,
 220                      dst=self.tra_if.local_mac) /
 221                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 222                                          dst=self.tra_if.local_ip4) /
 223                                       ICMP(),
 224                                       seq_num=172))
 225         recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 226
 227         # out of window are dropped
 228         pkt = (Ether(src=self.tra_if.remote_mac,
 229                      dst=self.tra_if.local_mac) /
 230                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 231                                          dst=self.tra_if.local_ip4) /
 232                                       ICMP(),
 233                                       seq_num=17))
 234         self.send_and_assert_no_replies(self.tra_if, pkt * 17)
 235
 236         self.assert_packet_counter_equal(
 237             '/err/%s/SA replayed packet' % self.tra4_decrypt_node_name, 17)
 238
 239         # a packet that does not decrypt does not move the window forward
 240         bogus_sa = SecurityAssociation(self.encryption_type,
 241                                        p.vpp_tra_spi)
 242         pkt = (Ether(src=self.tra_if.remote_mac,
 243                      dst=self.tra_if.local_mac) /
 244                bogus_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 245                                    dst=self.tra_if.local_ip4) /
 246                                 ICMP(),
 247                                 seq_num=350))
 248         self.send_and_assert_no_replies(self.tra_if, pkt * 17)
 249
 250         self.assert_packet_counter_equal(
 251             '/err/%s/Integrity check failed' % self.tra4_decrypt_node_name, 17)
 252
 253         # which we can determine since this packet is still in the window
 254         pkt = (Ether(src=self.tra_if.remote_mac,
 255                      dst=self.tra_if.local_mac) /
 256                p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
 257                                          dst=self.tra_if.local_ip4) /
 258                                       ICMP(),
 259                                       seq_num=234))
 260         self.send_and_expect(self.tra_if, [pkt], self.tra_if)
 261
 262         # move the security-associations seq number on to the last we used
 263         p.scapy_tra_sa.seq_num = 351
 264         p.vpp_tra_sa.seq_num = 351
 265
 266     def test_tra_basic(self, count=1):
 267         """ ipsec v4 transport basic test """
 268         self.vapi.cli("clear errors")
 269         try:
 270             p = self.params[socket.AF_INET]
 271             send_pkts = self.gen_encrypt_pkts(p.scapy_tra_sa, self.tra_if,
 272                                               src=self.tra_if.remote_ip4,
 273                                               dst=self.tra_if.local_ip4,
 274                                               count=count)
 275             recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
 276                                              self.tra_if)
 277             for rx in recv_pkts:
 278                 try:
 279                     decrypted = p.vpp_tra_sa.decrypt(rx[IP])
 280                     self.assert_packet_checksums_valid(decrypted)
 281                 except:
 282                     self.logger.debug(ppp("Unexpected packet:", rx))
 283                     raise
 284         finally:
 285             self.logger.info(self.vapi.ppcli("show error"))
 286             self.logger.info(self.vapi.ppcli("show ipsec"))
 287
 288         self.assert_packet_counter_equal(self.tra4_encrypt_node_name, count)
 289         self.assert_packet_counter_equal(self.tra4_decrypt_node_name, count)
 290
 291     def test_tra_burst(self):
 292         """ ipsec v4 transport burst test """
 293         self.test_tra_basic(count=257)
 294
 295     def test_tra_basic6(self, count=1):
 296         """ ipsec v6 transport basic test """
 297         self.vapi.cli("clear errors")
 298         try:
 299             p = self.params[socket.AF_INET6]
 300             send_pkts = self.gen_encrypt_pkts6(p.scapy_tra_sa, self.tra_if,
 301                                                src=self.tra_if.remote_ip6,
 302                                                dst=self.tra_if.local_ip6,
 303                                                count=count)
 304             recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
 305                                              self.tra_if)
 306             for rx in recv_pkts:
 307                 try:
 308                     decrypted = p.vpp_tra_sa.decrypt(rx[IPv6])
 309                     self.assert_packet_checksums_valid(decrypted)
 310                 except:
 311                     self.logger.debug(ppp("Unexpected packet:", rx))
 312                     raise
 313         finally:
 314             self.logger.info(self.vapi.ppcli("show error"))
 315             self.logger.info(self.vapi.ppcli("show ipsec"))
 316
 317         self.assert_packet_counter_equal(self.tra6_encrypt_node_name, count)
 318         self.assert_packet_counter_equal(self.tra6_decrypt_node_name, count)
 319
 320     def test_tra_burst6(self):
 321         """ ipsec v6 transport burst test """
 322         self.test_tra_basic6(count=257)
 323
 324
 325 class IpsecTun4Tests(object):
 326     def test_tun_basic44(self, count=1):
 327         """ ipsec 4o4 tunnel basic test """
 328         self.vapi.cli("clear errors")
 329         try:
 330             p = self.params[socket.AF_INET]
 331             vpp_tun_sa, scapy_tun_sa = self.configure_sa_tun(p)
 332             send_pkts = self.gen_encrypt_pkts(scapy_tun_sa, self.tun_if,
 333                                               src=p.remote_tun_if_host,
 334                                               dst=self.pg1.remote_ip4,
 335                                               count=count)
 336             recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
 337             for recv_pkt in recv_pkts:
 338                 self.assert_equal(recv_pkt[IP].src, p.remote_tun_if_host)
 339                 self.assert_equal(recv_pkt[IP].dst, self.pg1.remote_ip4)
 340                 self.assert_packet_checksums_valid(recv_pkt)
 341             send_pkts = self.gen_pkts(self.pg1, src=self.pg1.remote_ip4,
 342                                       dst=p.remote_tun_if_host, count=count)
 343             recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
 344             for recv_pkt in recv_pkts:
 345                 try:
 346                     decrypt_pkt = vpp_tun_sa.decrypt(recv_pkt[IP])
 347                     if not decrypt_pkt.haslayer(IP):
 348                         decrypt_pkt = IP(decrypt_pkt[Raw].load)
 349                     self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip4)
 350                     self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
 351                     self.assert_packet_checksums_valid(decrypt_pkt)
 352                 except:
 353                     self.logger.debug(ppp("Unexpected packet:", recv_pkt))
 354                     try:
 355                         self.logger.debug(
 356                             ppp("Decrypted packet:", decrypt_pkt))
 357                     except:
 358                         pass
 359                     raise
 360         finally:
 361             self.logger.info(self.vapi.ppcli("show error"))
 362             self.logger.info(self.vapi.ppcli("show ipsec"))
 363
 364         self.assert_packet_counter_equal(self.tun4_encrypt_node_name, count)
 365         self.assert_packet_counter_equal(self.tun4_decrypt_node_name, count)
 366
 367     def test_tun_burst44(self):
 368         """ ipsec 4o4 tunnel burst test """
 369         self.test_tun_basic44(count=257)
 370
 371
 372 class IpsecTun6Tests(object):
 373     def test_tun_basic66(self, count=1):
 374         """ ipsec 6o6 tunnel basic test """
 375         self.vapi.cli("clear errors")
 376         try:
 377             p = self.params[socket.AF_INET6]
 378             vpp_tun_sa, scapy_tun_sa = self.configure_sa_tun(p)
 379             send_pkts = self.gen_encrypt_pkts6(scapy_tun_sa, self.tun_if,
 380                                                src=p.remote_tun_if_host,
 381                                                dst=self.pg1.remote_ip6,
 382                                                count=count)
 383             recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
 384             for recv_pkt in recv_pkts:
 385                 self.assert_equal(recv_pkt[IPv6].src, p.remote_tun_if_host)
 386                 self.assert_equal(recv_pkt[IPv6].dst, self.pg1.remote_ip6)
 387                 self.assert_packet_checksums_valid(recv_pkt)
 388             send_pkts = self.gen_pkts6(self.pg1, src=self.pg1.remote_ip6,
 389                                        dst=p.remote_tun_if_host,
 390                                        count=count)
 391             recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
 392             for recv_pkt in recv_pkts:
 393                 try:
 394                     decrypt_pkt = vpp_tun_sa.decrypt(recv_pkt[IPv6])
 395                     if not decrypt_pkt.haslayer(IPv6):
 396                         decrypt_pkt = IPv6(decrypt_pkt[Raw].load)
 397                     self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip6)
 398                     self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
 399                     self.assert_packet_checksums_valid(decrypt_pkt)
 400                 except:
 401                     self.logger.debug(ppp("Unexpected packet:", recv_pkt))
 402                     try:
 403                         self.logger.debug(
 404                             ppp("Decrypted packet:", decrypt_pkt))
 405                     except:
 406                         pass
 407                     raise
 408         finally:
 409             self.logger.info(self.vapi.ppcli("show error"))
 410             self.logger.info(self.vapi.ppcli("show ipsec"))
 411
 412         self.assert_packet_counter_equal(self.tun6_encrypt_node_name, count)
 413         self.assert_packet_counter_equal(self.tun6_decrypt_node_name, count)
 414
 415     def test_tun_burst66(self):
 416         """ ipsec 6o6 tunnel burst test """
 417         self.test_tun_basic66(count=257)
 418
 419
 420 class IpsecTunTests(IpsecTun4Tests, IpsecTun6Tests):
 421     pass
 422
 423
 424 if __name__ == '__main__':
 425     unittest.main(testRunner=VppTestRunner)