From 4a58e49cfe03150034a65e147a2ffe8d24391b86 Mon Sep 17 00:00:00 2001 From: Neale Ranns Date: Mon, 21 Dec 2020 13:19:10 +0000 Subject: ipsec: Support MPLS over IPSec[46] interface Type: feature Signed-off-by: Neale Ranns Change-Id: I89dc3815eabfee135cd5b3c910dea5e2e2ef1333 --- test/patches/scapy-2.4.3/ipsec.patch | 51 ++++++++---- test/test_ipsec_tun_if_esp.py | 157 ++++++++++++++++++++++++++++++++++- 2 files changed, 190 insertions(+), 18 deletions(-) (limited to 'test') diff --git a/test/patches/scapy-2.4.3/ipsec.patch b/test/patches/scapy-2.4.3/ipsec.patch index d97de7fe9b7..12c24e5057f 100644 --- a/test/patches/scapy-2.4.3/ipsec.patch +++ b/test/patches/scapy-2.4.3/ipsec.patch @@ -1,8 +1,16 @@ diff --git a/scapy/layers/ipsec.py b/scapy/layers/ipsec.py -index ae057ee1..24a1f6ea 100644 +index ae057ee1..d7a21e8b 100644 --- a/scapy/layers/ipsec.py +++ b/scapy/layers/ipsec.py -@@ -138,6 +138,7 @@ bind_layers(IP, ESP, proto=socket.IPPROTO_ESP) +@@ -56,6 +56,7 @@ from scapy.fields import ByteEnumField, ByteField, IntField, PacketField, \ + ShortField, StrField, XIntField, XStrField, XStrLenField + from scapy.packet import Packet, bind_layers, Raw + from scapy.layers.inet import IP, UDP ++from scapy.contrib.mpls import MPLS + import scapy.modules.six as six + from scapy.modules.six.moves import range + from scapy.layers.inet6 import IPv6, IPv6ExtHdrHopByHop, IPv6ExtHdrDestOpt, \ +@@ -138,6 +139,7 @@ bind_layers(IP, ESP, proto=socket.IPPROTO_ESP) bind_layers(IPv6, ESP, nh=socket.IPPROTO_ESP) bind_layers(UDP, ESP, dport=4500) # NAT-Traversal encapsulation bind_layers(UDP, ESP, sport=4500) # NAT-Traversal encapsulation @@ -10,7 +18,7 @@ index ae057ee1..24a1f6ea 100644 ############################################################################### -@@ -359,11 +360,8 @@ class CryptAlgo(object): +@@ -359,11 +361,8 @@ class CryptAlgo(object): encryptor = cipher.encryptor() if self.is_aead: @@ -24,7 +32,7 @@ index ae057ee1..24a1f6ea 100644 data = encryptor.update(data) + encryptor.finalize() data += encryptor.tag[:self.icv_size] else: -@@ -400,12 +398,7 @@ class CryptAlgo(object): +@@ -400,12 +399,7 @@ class CryptAlgo(object): if self.is_aead: # Tag value check is done during the finalize method @@ -38,7 +46,7 @@ index ae057ee1..24a1f6ea 100644 try: data = decryptor.update(data) + decryptor.finalize() except InvalidTag as err: -@@ -445,6 +438,7 @@ if algorithms: +@@ -445,6 +439,7 @@ if algorithms: CRYPT_ALGOS['AES-CTR'] = CryptAlgo('AES-CTR', cipher=algorithms.AES, mode=modes.CTR, @@ -46,7 +54,7 @@ index ae057ee1..24a1f6ea 100644 iv_size=8, salt_size=4, format_mode_iv=_aes_ctr_format_mode_iv) -@@ -452,6 +446,7 @@ if algorithms: +@@ -452,6 +447,7 @@ if algorithms: CRYPT_ALGOS['AES-GCM'] = CryptAlgo('AES-GCM', cipher=algorithms.AES, mode=modes.GCM, @@ -54,7 +62,7 @@ index ae057ee1..24a1f6ea 100644 salt_size=4, iv_size=8, icv_size=16, -@@ -460,6 +455,7 @@ if algorithms: +@@ -460,6 +456,7 @@ if algorithms: CRYPT_ALGOS['AES-CCM'] = CryptAlgo('AES-CCM', cipher=algorithms.AES, mode=modes.CCM, @@ -62,7 +70,7 @@ index ae057ee1..24a1f6ea 100644 iv_size=8, salt_size=3, icv_size=16, -@@ -544,7 +540,7 @@ class AuthAlgo(object): +@@ -544,7 +541,7 @@ class AuthAlgo(object): else: return self.mac(key, self.digestmod(), default_backend()) @@ -71,7 +79,7 @@ index ae057ee1..24a1f6ea 100644 """ Sign an IPsec (ESP or AH) packet with this algo. -@@ -560,16 +556,20 @@ class AuthAlgo(object): +@@ -560,16 +557,20 @@ class AuthAlgo(object): if pkt.haslayer(ESP): mac.update(raw(pkt[ESP])) @@ -93,7 +101,7 @@ index ae057ee1..24a1f6ea 100644 """ Check that the integrity check value (icv) of a packet is valid. -@@ -600,6 +600,8 @@ class AuthAlgo(object): +@@ -600,6 +601,8 @@ class AuthAlgo(object): clone = zero_mutable_fields(pkt.copy(), sending=False) mac.update(raw(clone)) @@ -102,7 +110,16 @@ index ae057ee1..24a1f6ea 100644 computed_icv = mac.finalize()[:self.icv_size] # XXX: Cannot use mac.verify because the ICV can be truncated -@@ -862,6 +864,23 @@ class SecurityAssociation(object): +@@ -788,7 +791,7 @@ class SecurityAssociation(object): + This class is responsible of "encryption" and "decryption" of IPsec packets. # noqa: E501 + """ + +- SUPPORTED_PROTOS = (IP, IPv6) ++ SUPPORTED_PROTOS = (IP, IPv6, MPLS) + + def __init__(self, proto, spi, seq_num=1, crypt_algo=None, crypt_key=None, + auth_algo=None, auth_key=None, tunnel_header=None, nat_t_header=None, esn_en=False, esn=0): # noqa: E501 +@@ -862,6 +865,23 @@ class SecurityAssociation(object): raise TypeError('nat_t_header must be %s' % UDP.name) self.nat_t_header = nat_t_header @@ -126,7 +143,7 @@ index ae057ee1..24a1f6ea 100644 def check_spi(self, pkt): if pkt.spi != self.spi: raise TypeError('packet spi=0x%x does not match the SA spi=0x%x' % -@@ -875,7 +894,8 @@ class SecurityAssociation(object): +@@ -875,7 +895,8 @@ class SecurityAssociation(object): if len(iv) != self.crypt_algo.iv_size: raise TypeError('iv length must be %s' % self.crypt_algo.iv_size) # noqa: E501 @@ -136,7 +153,7 @@ index ae057ee1..24a1f6ea 100644 if self.tunnel_header: tunnel = self.tunnel_header.copy() -@@ -899,7 +919,7 @@ class SecurityAssociation(object): +@@ -899,7 +920,7 @@ class SecurityAssociation(object): esn_en=esn_en or self.esn_en, esn=esn or self.esn) @@ -145,7 +162,7 @@ index ae057ee1..24a1f6ea 100644 if self.nat_t_header: nat_t_header = self.nat_t_header.copy() -@@ -926,7 +946,8 @@ class SecurityAssociation(object): +@@ -926,7 +947,8 @@ class SecurityAssociation(object): def _encrypt_ah(self, pkt, seq_num=None): @@ -155,7 +172,7 @@ index ae057ee1..24a1f6ea 100644 icv=b"\x00" * self.auth_algo.icv_size) if self.tunnel_header: -@@ -966,7 +987,8 @@ class SecurityAssociation(object): +@@ -966,7 +988,8 @@ class SecurityAssociation(object): else: ip_header.plen = len(ip_header.payload) + len(ah) + len(payload) @@ -165,7 +182,7 @@ index ae057ee1..24a1f6ea 100644 # sequence number must always change, unless specified by the user if seq_num is None: -@@ -1003,11 +1025,12 @@ class SecurityAssociation(object): +@@ -1003,11 +1026,12 @@ class SecurityAssociation(object): def _decrypt_esp(self, pkt, verify=True, esn_en=None, esn=None): @@ -179,7 +196,7 @@ index ae057ee1..24a1f6ea 100644 esp = self.crypt_algo.decrypt(self, encrypted, self.crypt_key, self.crypt_algo.icv_size or -@@ -1048,9 +1071,10 @@ class SecurityAssociation(object): +@@ -1048,9 +1072,10 @@ class SecurityAssociation(object): def _decrypt_ah(self, pkt, verify=True): diff --git a/test/test_ipsec_tun_if_esp.py b/test/test_ipsec_tun_if_esp.py index 7e36d1345be..5bcd9ddfae0 100644 --- a/test/test_ipsec_tun_if_esp.py +++ b/test/test_ipsec_tun_if_esp.py @@ -7,13 +7,15 @@ from scapy.layers.l2 import Ether, GRE, Dot1Q from scapy.packet import Raw from scapy.layers.inet import IP, UDP from scapy.layers.inet6 import IPv6 +from scapy.contrib.mpls import MPLS from framework import VppTestRunner from template_ipsec import TemplateIpsec, IpsecTun4Tests, IpsecTun6Tests, \ IpsecTun4, IpsecTun6, IpsecTcpTests, mk_scapy_crypt_key, \ IpsecTun6HandoffTests, IpsecTun4HandoffTests, config_tun_params from vpp_gre_interface import VppGreInterface from vpp_ipip_tun_interface import VppIpIpTunInterface -from vpp_ip_route import VppIpRoute, VppRoutePath, DpoProto +from vpp_ip_route import VppIpRoute, VppRoutePath, DpoProto, VppMplsLabel, \ + VppMplsTable, VppMplsRoute, FibPathProto from vpp_ipsec import VppIpsecSA, VppIpsecTunProtect, VppIpsecInterface from vpp_l2 import VppBridgeDomain, VppBridgeDomainPort from vpp_sub_interface import L2_VTR_OP, VppDot1QSubint @@ -2570,6 +2572,82 @@ class TestIpsecItf4(TemplateIpsec, self.unconfig_network(p) +class TestIpsecItf4MPLS(TemplateIpsec, + TemplateIpsecItf4, + IpsecTun4): + """ IPsec Interface MPLSoIPv4 """ + + tun4_encrypt_node_name = "esp-mpls-encrypt-tun" + + def setUp(self): + super(TestIpsecItf4MPLS, self).setUp() + + self.tun_if = self.pg0 + + def tearDown(self): + super(TestIpsecItf4MPLS, self).tearDown() + + def gen_encrypt_pkts(self, p, sa, sw_intf, src, dst, count=1, + payload_size=100): + return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) / + sa.encrypt(MPLS(label=44, ttl=3) / + IP(src=src, dst=dst) / + UDP(sport=1166, dport=2233) / + Raw(b'X' * payload_size)) + for i in range(count)] + + def verify_encrypted(self, p, sa, rxs): + for rx in rxs: + try: + pkt = sa.decrypt(rx[IP]) + if not pkt.haslayer(IP): + pkt = IP(pkt[Raw].load) + self.assert_packet_checksums_valid(pkt) + self.assert_equal(pkt[MPLS].label, 44) + self.assert_equal(pkt[IP].dst, p.remote_tun_if_host) + except (IndexError, AssertionError): + self.logger.debug(ppp("Unexpected packet:", rx)) + try: + self.logger.debug(ppp("Decrypted packet:", pkt)) + except: + pass + raise + + def test_tun_mpls_o_ip4(self): + """IPSEC interface MPLS over IPv4""" + + n_pkts = 127 + p = self.ipv4_params + f = FibPathProto + + tbl = VppMplsTable(self, 0) + tbl.add_vpp_config() + + self.config_network(p) + # deag MPLS routes from the tunnel + r4 = VppMplsRoute(self, 44, 1, + [VppRoutePath( + self.pg1.remote_ip4, + self.pg1.sw_if_index)]).add_vpp_config() + p.route.modify([VppRoutePath(p.tun_if.remote_ip4, + p.tun_if.sw_if_index, + labels=[VppMplsLabel(44)])]) + p.tun_if.enable_mpls() + + self.config_sa_tun(p, + self.pg0.local_ip4, + self.pg0.remote_ip4) + self.config_protect(p) + + self.verify_tun_44(p, count=n_pkts) + + # cleanup + p.tun_if.disable_mpls() + self.unconfig_protect(p) + self.unconfig_sa(p) + self.unconfig_network(p) + + class TemplateIpsecItf6(object): """ IPsec Interface IPv6 """ @@ -2848,5 +2926,82 @@ class TestIpsecMIfEsp4(TemplateIpsec, IpsecTun4): self.verify_tun_44(p, count=N_PKTS) +class TestIpsecItf6MPLS(TemplateIpsec, + TemplateIpsecItf6, + IpsecTun6): + """ IPsec Interface MPLSoIPv6 """ + + tun6_encrypt_node_name = "esp-mpls-encrypt-tun" + + def setUp(self): + super(TestIpsecItf6MPLS, self).setUp() + + self.tun_if = self.pg0 + + def tearDown(self): + super(TestIpsecItf6MPLS, self).tearDown() + + def gen_encrypt_pkts6(self, p, sa, sw_intf, src, dst, count=1, + payload_size=100): + return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) / + sa.encrypt(MPLS(label=66, ttl=3) / + IPv6(src=src, dst=dst) / + UDP(sport=1166, dport=2233) / + Raw(b'X' * payload_size)) + for i in range(count)] + + def verify_encrypted6(self, p, sa, rxs): + for rx in rxs: + try: + pkt = sa.decrypt(rx[IPv6]) + if not pkt.haslayer(IPv6): + pkt = IP(pkt[Raw].load) + self.assert_packet_checksums_valid(pkt) + self.assert_equal(pkt[MPLS].label, 66) + self.assert_equal(pkt[IPv6].dst, p.remote_tun_if_host) + except (IndexError, AssertionError): + self.logger.debug(ppp("Unexpected packet:", rx)) + try: + self.logger.debug(ppp("Decrypted packet:", pkt)) + except: + pass + raise + + def test_tun_mpls_o_ip6(self): + """IPSEC interface MPLS over IPv6""" + + n_pkts = 127 + p = self.ipv6_params + f = FibPathProto + + tbl = VppMplsTable(self, 0) + tbl.add_vpp_config() + + self.config_network(p) + # deag MPLS routes from the tunnel + r6 = VppMplsRoute(self, 66, 1, + [VppRoutePath( + self.pg1.remote_ip6, + self.pg1.sw_if_index)], + eos_proto=f.FIB_PATH_NH_PROTO_IP6).add_vpp_config() + p.route.modify([VppRoutePath(p.tun_if.remote_ip6, + p.tun_if.sw_if_index, + labels=[VppMplsLabel(66)])]) + p.tun_if.enable_mpls() + + self.config_sa_tun(p, + self.pg0.local_ip6, + self.pg0.remote_ip6) + self.config_protect(p) + + self.verify_tun_66(p, count=n_pkts) + + # cleanup + p.tun_if.disable_mpls() + self.unconfig_protect(p) + self.unconfig_sa(p) + self.unconfig_network(p) + + if __name__ == '__main__': unittest.main(testRunner=VppTestRunner) -- cgit 1.2.3-korg