IPSEC: API modernisation
[vpp.git] / test / test_ipsec_esp.py
index 15ce4a9..ae62aec 100644 (file)
@@ -1,14 +1,18 @@
 import socket
 import unittest
+from scapy.layers.ipsec import ESP
 
-from scapy.layers.inet import IP, ICMP
-from scapy.layers.l2 import Ether
-from scapy.layers.ipsec import SecurityAssociation, ESP
+from framework import VppTestRunner
+from template_ipsec import IpsecTraTests, IpsecTunTests
+from template_ipsec import TemplateIpsec, IpsecTcpTests
+from vpp_ipsec import VppIpsecSpd, VppIpsecSpdEntry, VppIpsecSA,\
+        VppIpsecSpdItfBinding
+from vpp_ip_route import VppIpRoute, VppRoutePath
+from vpp_ip import DpoProto
+from vpp_papi import VppEnum
 
-from framework import VppTestCase, VppTestRunner
 
-
-class TestIpsecEsp(VppTestCase):
+class TemplateIpsecEsp(TemplateIpsec):
     """
     Basic test for ipsec esp sanity - tunnel and transport modes.
 
@@ -37,302 +41,186 @@ class TestIpsecEsp(VppTestCase):
      ---   decrypt   ---   plain   ---
     |pg0| ------->  |VPP| ------> |pg1|
      ---             ---           ---
-
-    Note : IPv6 is not covered
     """
 
-    remote_pg0_lb_addr = '1.1.1.1'
-    remote_pg1_lb_addr = '2.2.2.2'
-
-    @classmethod
-    def setUpClass(cls):
-        super(TestIpsecEsp, cls).setUpClass()
-        try:
-            cls.create_pg_interfaces(range(3))
-            cls.interfaces = list(cls.pg_interfaces)
-            for i in cls.interfaces:
-                i.admin_up()
-                i.config_ip4()
-                i.resolve_arp()
-            cls.logger.info(cls.vapi.ppcli("show int addr"))
-            cls.configEspTra()
-            cls.logger.info(cls.vapi.ppcli("show ipsec"))
-            cls.configEspTun()
-            cls.logger.info(cls.vapi.ppcli("show ipsec"))
-        except Exception:
-            super(TestIpsecEsp, cls).tearDownClass()
-            raise
-
-    @classmethod
-    def configEspTun(cls):
-        try:
-            spd_id = 1
-            remote_sa_id = 10
-            local_sa_id = 20
-            remote_tun_spi = 1001
-            local_tun_spi = 1000
-            src4 = socket.inet_pton(socket.AF_INET, cls.remote_pg0_lb_addr)
-            cls.vapi.ip_add_del_route(src4, 32, cls.pg0.remote_ip4n)
-            dst4 = socket.inet_pton(socket.AF_INET, cls.remote_pg1_lb_addr)
-            cls.vapi.ip_add_del_route(dst4, 32, cls.pg1.remote_ip4n)
-            cls.vapi.ipsec_sad_add_del_entry(
-                remote_sa_id,
-                remote_tun_spi,
-                cls.pg0.local_ip4n,
-                cls.pg0.remote_ip4n,
-                integrity_key_length=20,
-                crypto_key_length=16,
-                protocol=1)
-            cls.vapi.ipsec_sad_add_del_entry(
-                local_sa_id,
-                local_tun_spi,
-                cls.pg0.remote_ip4n,
-                cls.pg0.local_ip4n,
-                integrity_key_length=20,
-                crypto_key_length=16,
-                protocol=1)
-            cls.vapi.ipsec_spd_add_del(spd_id)
-            cls.vapi.ipsec_interface_add_del_spd(spd_id, cls.pg0.sw_if_index)
-            l_startaddr = r_startaddr = socket.inet_pton(
-                socket.AF_INET, "0.0.0.0")
-            l_stopaddr = r_stopaddr = socket.inet_pton(
-                socket.AF_INET, "255.255.255.255")
-            cls.vapi.ipsec_spd_add_del_entry(
-                spd_id,
-                l_startaddr,
-                l_stopaddr,
-                r_startaddr,
-                r_stopaddr,
-                protocol=socket.IPPROTO_ESP)
-            cls.vapi.ipsec_spd_add_del_entry(
-                spd_id,
-                l_startaddr,
-                l_stopaddr,
-                r_startaddr,
-                r_stopaddr,
-                protocol=socket.IPPROTO_ESP,
-                is_outbound=0)
-            l_startaddr = l_stopaddr = socket.inet_pton(
-                socket.AF_INET, cls.remote_pg0_lb_addr)
-            r_startaddr = r_stopaddr = socket.inet_pton(
-                socket.AF_INET, cls.remote_pg1_lb_addr)
-            cls.vapi.ipsec_spd_add_del_entry(
-                spd_id,
-                l_startaddr,
-                l_stopaddr,
-                r_startaddr,
-                r_stopaddr,
-                priority=10,
-                policy=3,
-                is_outbound=0,
-                sa_id=local_sa_id)
-            cls.vapi.ipsec_spd_add_del_entry(
-                spd_id,
-                r_startaddr,
-                r_stopaddr,
-                l_startaddr,
-                l_stopaddr,
-                priority=10,
-                policy=3,
-                sa_id=remote_sa_id)
-        except Exception:
-            raise
-
-    @classmethod
-    def configEspTra(cls):
-        try:
-            spd_id = 2
-            remote_sa_id = 30
-            local_sa_id = 40
-            remote_tra_spi = 2001
-            local_tra_spi = 2000
-            cls.vapi.ipsec_sad_add_del_entry(
-                remote_sa_id,
-                remote_tra_spi,
-                integrity_key_length=20,
-                crypto_key_length=16,
-                protocol=1,
-                is_tunnel=0)
-            cls.vapi.ipsec_sad_add_del_entry(
-                local_sa_id,
-                local_tra_spi,
-                integrity_key_length=20,
-                crypto_key_length=16,
-                protocol=1,
-                is_tunnel=0)
-            cls.vapi.ipsec_spd_add_del(spd_id)
-            cls.vapi.ipsec_interface_add_del_spd(spd_id, cls.pg2.sw_if_index)
-            l_startaddr = r_startaddr = socket.inet_pton(
-                socket.AF_INET, "0.0.0.0")
-            l_stopaddr = r_stopaddr = socket.inet_pton(
-                socket.AF_INET, "255.255.255.255")
-            cls.vapi.ipsec_spd_add_del_entry(
-                spd_id,
-                l_startaddr,
-                l_stopaddr,
-                r_startaddr,
-                r_stopaddr,
-                protocol=socket.IPPROTO_ESP)
-            cls.vapi.ipsec_spd_add_del_entry(
-                spd_id,
-                l_startaddr,
-                l_stopaddr,
-                r_startaddr,
-                r_stopaddr,
-                protocol=socket.IPPROTO_ESP,
-                is_outbound=0)
-            l_startaddr = l_stopaddr = cls.pg2.local_ip4n
-            r_startaddr = r_stopaddr = cls.pg2.remote_ip4n
-            cls.vapi.ipsec_spd_add_del_entry(
-                spd_id,
-                l_startaddr,
-                l_stopaddr,
-                r_startaddr,
-                r_stopaddr,
-                priority=10,
-                policy=3,
-                is_outbound=0,
-                sa_id=local_sa_id)
-            cls.vapi.ipsec_spd_add_del_entry(
-                spd_id,
-                l_startaddr,
-                l_stopaddr,
-                r_startaddr,
-                r_stopaddr,
-                priority=10,
-                policy=3,
-                sa_id=remote_sa_id)
-        except Exception:
-            raise
-
-    def configScapySA(self, is_tun=False):
-        if is_tun:
-            self.remote_tun_sa = SecurityAssociation(
-                ESP,
-                spi=0x000003e8,
-                crypt_algo='AES-CBC',
-                crypt_key='JPjyOWBeVEQiMe7h',
-                auth_algo='HMAC-SHA1-96',
-                auth_key='C91KUR9GYMm5GfkEvNjX',
-                tunnel_header=IP(
-                    src=self.pg0.remote_ip4,
-                    dst=self.pg0.local_ip4))
-            self.local_tun_sa = SecurityAssociation(
-                ESP,
-                spi=0x000003e9,
-                crypt_algo='AES-CBC',
-                crypt_key='JPjyOWBeVEQiMe7h',
-                auth_algo='HMAC-SHA1-96',
-                auth_key='C91KUR9GYMm5GfkEvNjX',
-                tunnel_header=IP(
-                    dst=self.pg0.remote_ip4,
-                    src=self.pg0.local_ip4))
-        else:
-            self.remote_tra_sa = SecurityAssociation(
-                ESP,
-                spi=0x000007d0,
-                crypt_algo='AES-CBC',
-                crypt_key='JPjyOWBeVEQiMe7h',
-                auth_algo='HMAC-SHA1-96',
-                auth_key='C91KUR9GYMm5GfkEvNjX')
-            self.local_tra_sa = SecurityAssociation(
-                ESP,
-                spi=0x000007d1,
-                crypt_algo='AES-CBC',
-                crypt_key='JPjyOWBeVEQiMe7h',
-                auth_algo='HMAC-SHA1-96',
-                auth_key='C91KUR9GYMm5GfkEvNjX')
+    def setUp(self):
+        super(TemplateIpsecEsp, self).setUp()
+        self.encryption_type = ESP
+        self.tun_if = self.pg0
+        self.tra_if = self.pg2
+        self.logger.info(self.vapi.ppcli("show int addr"))
+
+        self.tra_spd = VppIpsecSpd(self, self.tra_spd_id)
+        self.tra_spd.add_vpp_config()
+        VppIpsecSpdItfBinding(self, self.tra_spd,
+                              self.tra_if).add_vpp_config()
+
+        for _, p in self.params.items():
+            self.config_esp_tra(p)
+            self.configure_sa_tra(p)
+        self.logger.info(self.vapi.ppcli("show ipsec"))
+
+        self.tun_spd = VppIpsecSpd(self, self.tun_spd_id)
+        self.tun_spd.add_vpp_config()
+        VppIpsecSpdItfBinding(self, self.tun_spd,
+                              self.tun_if).add_vpp_config()
+
+        for _, p in self.params.items():
+            self.config_esp_tun(p)
+        self.logger.info(self.vapi.ppcli("show ipsec"))
+
+        for _, p in self.params.items():
+            d = DpoProto.DPO_PROTO_IP6 if p.is_ipv6 else DpoProto.DPO_PROTO_IP4
+            VppIpRoute(self,  p.remote_tun_if_host, p.addr_len,
+                       [VppRoutePath(self.tun_if.remote_addr[p.addr_type],
+                                     0xffffffff,
+                                     proto=d)],
+                       is_ip6=p.is_ipv6).add_vpp_config()
 
     def tearDown(self):
-        super(TestIpsecEsp, self).tearDown()
+        super(TemplateIpsecEsp, self).tearDown()
         if not self.vpp_dead:
             self.vapi.cli("show hardware")
 
-    def send_and_expect(self, input, pkts, output, count=1):
-        input.add_stream(pkts)
-        self.pg_enable_capture(self.pg_interfaces)
-        self.pg_start()
-        rx = output.get_capture(count)
-        return rx
-
-    def gen_encrypt_pkts(self, sa, sw_intf, src, dst, count=1):
-        return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
-                sa.encrypt(IP(src=src, dst=dst) / ICMP() /
-                "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
-                ] * count
-
-    def gen_pkts(self, sw_intf, src, dst, count=1):
-        return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
-                IP(src=src, dst=dst) / ICMP() /
-                "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
-                ] * count
-
-    def test_ipsec_esp_tra_basic(self, count=1):
-        """ ipsec esp v4 transport basic test """
-        try:
-            self.configScapySA()
-            send_pkts = self.gen_encrypt_pkts(
-                self.remote_tra_sa,
-                self.pg2,
-                src=self.pg2.remote_ip4,
-                dst=self.pg2.local_ip4,
-                count=count)
-            recv_pkts = self.send_and_expect(
-                self.pg2, send_pkts, self.pg2, count=count)
-            # ESP TRA VPP encryption/decryption verification
-            for Pkts in recv_pkts:
-                self.local_tra_sa.decrypt(Pkts[IP])
-        finally:
-            self.logger.info(self.vapi.ppcli("show error"))
-            self.logger.info(self.vapi.ppcli("show ipsec"))
-
-    def test_ipsec_esp_tra_burst(self):
-        """ ipsec esp v4 transport burst test """
-        try:
-            self.test_ipsec_esp_tra_basic(count=257)
-        finally:
-            self.logger.info(self.vapi.ppcli("show error"))
-            self.logger.info(self.vapi.ppcli("show ipsec"))
-
-    def test_ipsec_esp_tun_basic(self, count=1):
-        """ ipsec esp 4o4 tunnel basic test """
-        try:
-            self.configScapySA(is_tun=True)
-            send_pkts = self.gen_encrypt_pkts(
-                self.remote_tun_sa,
-                self.pg0,
-                src=self.remote_pg0_lb_addr,
-                dst=self.remote_pg1_lb_addr,
-                count=count)
-            recv_pkts = self.send_and_expect(
-                self.pg0, send_pkts, self.pg1, count=count)
-            # ESP TUN VPP decryption verification
-            for recv_pkt in recv_pkts:
-                self.assert_equal(recv_pkt[IP].src, self.remote_pg0_lb_addr)
-                self.assert_equal(recv_pkt[IP].dst, self.remote_pg1_lb_addr)
-            send_pkts = self.gen_pkts(
-                self.pg1,
-                src=self.remote_pg1_lb_addr,
-                dst=self.remote_pg0_lb_addr,
-                count=count)
-            recv_pkts = self.send_and_expect(
-                self.pg1, send_pkts, self.pg0, count=count)
-            # ESP TUN VPP encryption verification
-            for recv_pkt in recv_pkts:
-                decrypt_pkt = self.local_tun_sa.decrypt(recv_pkt[IP])
-                self.assert_equal(decrypt_pkt.src, self.remote_pg1_lb_addr)
-                self.assert_equal(decrypt_pkt.dst, self.remote_pg0_lb_addr)
-        finally:
-            self.logger.info(self.vapi.ppcli("show error"))
-            self.logger.info(self.vapi.ppcli("show ipsec"))
-
-    def test_ipsec_esp_tun_burst(self):
-        """ ipsec esp 4o4 tunnel burst test """
-        try:
-            self.test_ipsec_esp_tun_basic(count=257)
-        finally:
-            self.logger.info(self.vapi.ppcli("show error"))
-            self.logger.info(self.vapi.ppcli("show ipsec"))
+    def config_esp_tun(self, params):
+        addr_type = params.addr_type
+        scapy_tun_sa_id = params.scapy_tun_sa_id
+        scapy_tun_spi = params.scapy_tun_spi
+        vpp_tun_sa_id = params.vpp_tun_sa_id
+        vpp_tun_spi = params.vpp_tun_spi
+        auth_algo_vpp_id = params.auth_algo_vpp_id
+        auth_key = params.auth_key
+        crypt_algo_vpp_id = params.crypt_algo_vpp_id
+        crypt_key = params.crypt_key
+        remote_tun_if_host = params.remote_tun_if_host
+        addr_any = params.addr_any
+        addr_bcast = params.addr_bcast
+        e = VppEnum.vl_api_ipsec_spd_action_t
+
+        VppIpsecSA(self, scapy_tun_sa_id, scapy_tun_spi,
+                   auth_algo_vpp_id, auth_key,
+                   crypt_algo_vpp_id, crypt_key,
+                   self.vpp_esp_protocol,
+                   self.tun_if.local_addr[addr_type],
+                   self.tun_if.remote_addr[addr_type]).add_vpp_config()
+        VppIpsecSA(self, vpp_tun_sa_id, vpp_tun_spi,
+                   auth_algo_vpp_id, auth_key,
+                   crypt_algo_vpp_id, crypt_key,
+                   self.vpp_esp_protocol,
+                   self.tun_if.remote_addr[addr_type],
+                   self.tun_if.local_addr[addr_type]).add_vpp_config()
+
+        VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
+                         addr_any, addr_bcast,
+                         addr_any, addr_bcast,
+                         socket.IPPROTO_ESP).add_vpp_config()
+        VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
+                         addr_any, addr_bcast,
+                         addr_any, addr_bcast,
+                         socket.IPPROTO_ESP,
+                         is_outbound=0).add_vpp_config()
+
+        VppIpsecSpdEntry(self, self.tun_spd, vpp_tun_sa_id,
+                         remote_tun_if_host, remote_tun_if_host,
+                         self.pg1.remote_addr[addr_type],
+                         self.pg1.remote_addr[addr_type],
+                         0,
+                         priority=10,
+                         policy=e.IPSEC_API_SPD_ACTION_PROTECT,
+                         is_outbound=0).add_vpp_config()
+        VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
+                         self.pg1.remote_addr[addr_type],
+                         self.pg1.remote_addr[addr_type],
+                         remote_tun_if_host, remote_tun_if_host,
+                         0,
+                         policy=e.IPSEC_API_SPD_ACTION_PROTECT,
+                         priority=10).add_vpp_config()
+
+        VppIpsecSpdEntry(self, self.tun_spd, vpp_tun_sa_id,
+                         remote_tun_if_host, remote_tun_if_host,
+                         self.pg0.local_addr[addr_type],
+                         self.pg0.local_addr[addr_type],
+                         0,
+                         priority=20,
+                         policy=e.IPSEC_API_SPD_ACTION_PROTECT,
+                         is_outbound=0).add_vpp_config()
+        VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
+                         self.pg0.local_addr[addr_type],
+                         self.pg0.local_addr[addr_type],
+                         remote_tun_if_host, remote_tun_if_host,
+                         0,
+                         policy=e.IPSEC_API_SPD_ACTION_PROTECT,
+                         priority=20).add_vpp_config()
+
+    def config_esp_tra(self, params):
+        addr_type = params.addr_type
+        scapy_tra_sa_id = params.scapy_tra_sa_id
+        scapy_tra_spi = params.scapy_tra_spi
+        vpp_tra_sa_id = params.vpp_tra_sa_id
+        vpp_tra_spi = params.vpp_tra_spi
+        auth_algo_vpp_id = params.auth_algo_vpp_id
+        auth_key = params.auth_key
+        crypt_algo_vpp_id = params.crypt_algo_vpp_id
+        crypt_key = params.crypt_key
+        addr_any = params.addr_any
+        addr_bcast = params.addr_bcast
+        flags = (VppEnum.vl_api_ipsec_sad_flags_t.
+                 IPSEC_API_SAD_FLAG_USE_ANTI_REPLAY)
+        e = VppEnum.vl_api_ipsec_spd_action_t
+
+        VppIpsecSA(self, scapy_tra_sa_id, scapy_tra_spi,
+                   auth_algo_vpp_id, auth_key,
+                   crypt_algo_vpp_id, crypt_key,
+                   self.vpp_esp_protocol,
+                   flags=flags).add_vpp_config()
+        VppIpsecSA(self, vpp_tra_sa_id, vpp_tra_spi,
+                   auth_algo_vpp_id, auth_key,
+                   crypt_algo_vpp_id, crypt_key,
+                   self.vpp_esp_protocol,
+                   flags=flags).add_vpp_config()
+
+        VppIpsecSpdEntry(self, self.tra_spd, vpp_tra_sa_id,
+                         addr_any, addr_bcast,
+                         addr_any, addr_bcast,
+                         socket.IPPROTO_ESP).add_vpp_config()
+        VppIpsecSpdEntry(self, self.tra_spd, vpp_tra_sa_id,
+                         addr_any, addr_bcast,
+                         addr_any, addr_bcast,
+                         socket.IPPROTO_ESP,
+                         is_outbound=0).add_vpp_config()
+
+        VppIpsecSpdEntry(self, self.tra_spd, vpp_tra_sa_id,
+                         self.tra_if.local_addr[addr_type],
+                         self.tra_if.local_addr[addr_type],
+                         self.tra_if.remote_addr[addr_type],
+                         self.tra_if.remote_addr[addr_type],
+                         0, priority=10,
+                         policy=e.IPSEC_API_SPD_ACTION_PROTECT,
+                         is_outbound=0).add_vpp_config()
+        VppIpsecSpdEntry(self, self.tra_spd, scapy_tra_sa_id,
+                         self.tra_if.local_addr[addr_type],
+                         self.tra_if.local_addr[addr_type],
+                         self.tra_if.remote_addr[addr_type],
+                         self.tra_if.remote_addr[addr_type],
+                         0, policy=e.IPSEC_API_SPD_ACTION_PROTECT,
+                         priority=10).add_vpp_config()
+
+
+class TestIpsecEsp1(TemplateIpsecEsp, IpsecTraTests, IpsecTunTests):
+    """ Ipsec ESP - TUN & TRA tests """
+    tra4_encrypt_node_name = "esp4-encrypt"
+    tra4_decrypt_node_name = "esp4-decrypt"
+    tra6_encrypt_node_name = "esp6-encrypt"
+    tra6_decrypt_node_name = "esp6-decrypt"
+    tun4_encrypt_node_name = "esp4-encrypt"
+    tun4_decrypt_node_name = "esp4-decrypt"
+    tun6_encrypt_node_name = "esp6-encrypt"
+    tun6_decrypt_node_name = "esp6-decrypt"
+
+
+class TestIpsecEsp2(TemplateIpsecEsp, IpsecTcpTests):
+    """ Ipsec ESP - TCP tests """
+    pass
 
 
 if __name__ == '__main__':