import socket import unittest from scapy.layers.ipsec import ESP from scapy.layers.inet import UDP from parameterized import parameterized from framework import VppTestRunner from template_ipsec import IpsecTra46Tests, IpsecTun46Tests, TemplateIpsec, \ IpsecTcpTests, IpsecTun4Tests, IpsecTra4Tests, config_tra_params, \ config_tun_params, IPsecIPv4Params, IPsecIPv6Params, \ IpsecTra4, IpsecTun4, IpsecTra6, IpsecTun6, \ IpsecTun6HandoffTests, IpsecTun4HandoffTests, \ IpsecTra6ExtTests 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 NUM_PKTS = 67 engines_supporting_chain_bufs = ["openssl"] class ConfigIpsecESP(TemplateIpsec): encryption_type = ESP 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" @classmethod def setUpClass(cls): super(ConfigIpsecESP, cls).setUpClass() @classmethod def tearDownClass(cls): super(ConfigIpsecESP, cls).tearDownClass() def setUp(self): super(ConfigIpsecESP, self).setUp() def tearDown(self): super(ConfigIpsecESP, self).tearDown() def config_network(self, params): self.net_objs = [] 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() self.net_objs.append(self.tra_spd) self.tun_spd = VppIpsecSpd(self, self.tun_spd_id) self.tun_spd.add_vpp_config() self.net_objs.append(self.tun_spd) b = VppIpsecSpdItfBinding(self, self.tun_spd, self.tun_if) b.add_vpp_config() self.net_objs.append(b) b = VppIpsecSpdItfBinding(self, self.tra_spd, self.tra_if) b.add_vpp_config() self.net_objs.append(b) for p in params: self.config_esp_tra(p) config_tra_params(p, self.encryption_type) for p in params: self.config_esp_tun(p) config_tun_params(p, self.encryption_type, self.tun_if) for p in params: d = DpoProto.DPO_PROTO_IP6 if p.is_ipv6 else DpoProto.DPO_PROTO_IP4 r = VppIpRoute(self, p.remote_tun_if_host, p.addr_len, [VppRoutePath(self.tun_if.remote_addr[p.addr_type], 0xffffffff, proto=d)]) r.add_vpp_config() self.net_objs.append(r) self.logger.info(self.vapi.ppcli("show ipsec all")) def unconfig_network(self): for o in reversed(self.net_objs): o.remove_vpp_config() self.net_objs = [] 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 flags = params.flags salt = params.salt objs = [] params.tun_sa_in = 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], flags=flags, salt=salt) params.tun_sa_out = 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], flags=flags, salt=salt) objs.append(params.tun_sa_in) objs.append(params.tun_sa_out) params.spd_policy_in_any = VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id, addr_any, addr_bcast, addr_any, addr_bcast, socket.IPPROTO_ESP) params.spd_policy_out_any = VppIpsecSpdEntry(self, self.tun_spd, scapy_tun
.. _hoststack:

==============
TCP Host Stack
==============

VPP’s host stack leverages VPP’s graph based forwarding model and vectorized packet
processing to ensure high throughput and scale transport protocol termination. It
exposes apis that apart from allowing for efficient user-space app consumption and
generation of data, also enables highly efficient local inter-app communication. 
 
At a high level VPP’s host stack consists of 3 major components: 

* A session layer that facilitates interaction between transport protocols and applications
* Pluggable transport protocols, including TCP, QUIC, TLS, UDP
* VCL (VPPComs library) a set of libraries meant to ease the consumability of the stack from application perspective
 
All of these components were custom built to fit within VPP’s architecture and to
leverage its speed. As a result, a significant amount of effort was invested into:

*  building a transport pluggable session layer that abstracts the interaction between applications and transports using a custom-built shared memory infrastructure. Notably, this also allows for transport protocols that are typically implemented in applications, like QUIC and TLS, to be implemented within VPP. 
* a clean slate TCP implementation that supports vectorized packet processing and follows VPP’s highly scalable threading model. The implementation is RFC compliant, supports a high number of high-speed TCP protocol features and it was validated using Defensic’s Codenomicon 1M+ tests suite. 
* VCL, a library that emulates traditional asynchronous communication functions in user-space, all while allowing for new patterns to be developed, if needed. 
* implementing a high performance “cut-through” communication mode that enables applications attached to vpp to transparently exchange data over shared memory without incurring the extra cost of a traditional transport protocol. Testing has shown this to be much more efficient than traditional inter-container networking.

For developer features press next.
AD_FLAG_UDP_ENCAP) p.nat_header = UDP(sport=5454, dport=4500) 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() self.config_esp_tra(p) config_tra_params(p, self.encryption_type) 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() self.config_esp_tun(p) self.logger.info(self.vapi.ppcli("show ipsec all")) d = 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)]).add_vpp_config() def tearDown(self): super(TemplateIpsecEspUdp, self).tearDown() def show_commands_at_teardown(self): self.logger.info(self.vapi.cli("show hardware")) class TestIpsecEspUdp(TemplateIpsecEspUdp, IpsecTra4Tests): """ Ipsec NAT-T ESP UDP tests """ pass class MyParameters(): def __init__(self): self.engines = ["ia32", "ipsecmb", "openssl"] flag_esn = VppEnum.vl_api_ipsec_sad_flags_t.IPSEC_API_SAD_FLAG_USE_ESN self.flags = [0, flag_esn] # foreach crypto algorithm self.algos = { 'AES-GCM-128/NONE': { 'vpp-crypto': (VppEnum.vl_api_ipsec_crypto_alg_t. IPSEC_API_CRYPTO_ALG_AES_GCM_128), 'vpp-integ': (VppEnum.vl_api_ipsec_integ_alg_t. IPSEC_API_INTEG_ALG_NONE), 'scapy-crypto': "AES-GCM", 'scapy-integ': "NULL", 'key': b"JPjyOWBeVEQiMe7h", 'salt': 0}, 'AES-GCM-192/NONE': { 'vpp-crypto': (VppEnum.vl_api_ipsec_crypto_alg_t. IPSEC_API_CRYPTO_ALG_AES_GCM_192), 'vpp-integ': (VppEnum.vl_api_ipsec_integ_alg_t. IPSEC_API_INTEG_ALG_NONE), 'scapy-crypto': "AES-GCM", 'scapy-integ': "NULL", 'key': b"JPjyOWBeVEQiMe7h01234567", 'salt': 1010}, 'AES-GCM-256/NONE': { 'vpp-crypto': (VppEnum.vl_api_ipsec_crypto_alg_t. IPSEC_API_CRYPTO_ALG_AES_GCM_256), 'vpp-integ': (VppEnum.vl_api_ipsec_integ_alg_t. IPSEC_API_INTEG_ALG_NONE), 'scapy-crypto': "AES-GCM", 'scapy-integ': "NULL", 'key': b"JPjyOWBeVEQiMe7h0123456787654321", 'salt': 2020}, 'AES-CBC-128/MD5-96': { 'vpp-crypto': (VppEnum.vl_api_ipsec_crypto_alg_t. IPSEC_API_CRYPTO_ALG_AES_CBC_128), 'vpp-integ': (VppEnum.vl_api_ipsec_integ_alg_t. IPSEC_API_INTEG_ALG_MD5_96), 'scapy-crypto': "AES-CBC", 'scapy-integ': "HMAC-MD5-96", 'salt': 0, 'key': b"JPjyOWBeVEQiMe7h"}, 'AES-CBC-192/SHA1-96': { 'vpp-crypto': (VppEnum.vl_api_ipsec_crypto_alg_t. IPSEC_API_CRYPTO_ALG_AES_CBC_192), 'vpp-integ': (VppEnum.vl_api_ipsec_integ_alg_t. IPSEC_API_INTEG_ALG_SHA1_96), 'scapy-crypto': "AES-CBC", 'scapy-integ': "HMAC-SHA1-96", 'salt': 0, 'key': b"JPjyOWBeVEQiMe7hJPjyOWBe"}, 'AES-CBC-256/SHA1-96': { 'vpp-crypto': (VppEnum.vl_api_ipsec_crypto_alg_t. IPSEC_API_CRYPTO_ALG_AES_CBC_256), 'vpp-integ': (VppEnum.vl_api_ipsec_integ_alg_t. IPSEC_API_INTEG_ALG_SHA1_96), 'scapy-crypto': "AES-CBC", 'scapy-integ': "HMAC-SHA1-96", 'salt': 0, 'key': b"JPjyOWBeVEQiMe7hJPjyOWBeVEQiMe7h"}, '3DES-CBC/SHA1-96': { 'vpp-crypto': (VppEnum.vl_api_ipsec_crypto_alg_t. IPSEC_API_CRYPTO_ALG_3DES_CBC), 'vpp-integ': (VppEnum.vl_api_ipsec_integ_alg_t. IPSEC_API_INTEG_ALG_SHA1_96), 'scapy-crypto': "3DES", 'scapy-integ': "HMAC-SHA1-96", 'salt': 0, 'key': b"JPjyOWBeVEQiMe7h00112233"}, 'NONE/SHA1-96': { 'vpp-crypto': (VppEnum.vl_api_ipsec_crypto_alg_t. IPSEC_API_CRYPTO_ALG_NONE), 'vpp-integ': (VppEnum.vl_api_ipsec_integ_alg_t. IPSEC_API_INTEG_ALG_SHA1_96), 'scapy-crypto': "NULL", 'scapy-integ': "HMAC-SHA1-96", 'salt': 0, 'key': b"JPjyOWBeVEQiMe7h00112233"}} class RunTestIpsecEspAll(ConfigIpsecESP, IpsecTra4, IpsecTra6, IpsecTun4, IpsecTun6): """ Ipsec ESP all Algos """ def setUp(self): super(RunTestIpsecEspAll, self).setUp() test_args = str.split(self.__doc__, " ") params = MyParameters() self.engine = test_args[0] self.flag = params.flags[0] if test_args[1] == 'ESN': self.flag = params.flags[1] self.algo = params.algos[test_args[2]] def tearDown(self): super(RunTestIpsecEspAll, self).tearDown() def run_test(self): self.run_a_test(self.engine, self.flag, self.algo) def run_a_test(self, engine, flag, algo, payload_size=None): self.vapi.cli("set crypto handler all %s" % engine) self.ipv4_params = IPsecIPv4Params() self.ipv6_params = IPsecIPv6Params() self.params = {self.ipv4_params.addr_type: self.ipv4_params, self.ipv6_params.addr_type: self.ipv6_params} for _, p in self.params.items(): p.auth_algo_vpp_id = algo['vpp-integ'] p.crypt_algo_vpp_id = algo['vpp-crypto'] p.crypt_algo = algo['scapy-crypto'] p.auth_algo = algo['scapy-integ'] p.crypt_key = algo['key'] p.salt = algo['salt'] p.flags = p.flags | flag self.reporter.send_keep_alive(self) # # configure the SPDs. SAs, etc # self.config_network(self.params.values()) # # run some traffic. # An exhautsive 4o6, 6o4 is not necessary # for each algo # self.verify_tra_basic6(count=NUM_PKTS) self.verify_tra_basic4(count=NUM_PKTS) self.verify_tun_66(self.params[socket.AF_INET6], count=NUM_PKTS) self.verify_tun_44(self.params[socket.AF_INET], count=NUM_PKTS) LARGE_PKT_SZ = [ 1970, # results in 2 chained buffers entering decrypt node # but leaving as simple buffer due to ICV removal (tra4) 4010, # ICV ends up splitted accross 2 buffers in esp_decrypt # for transport4; transport6 takes normal path 4020, # same as above but tra4 and tra6 are switched ] if self.engine in engines_supporting_chain_bufs: for sz in LARGE_PKT_SZ: self.verify_tra_basic4(count=NUM_PKTS, payload_size=sz) self.verify_tra_basic6(count=NUM_PKTS, payload_size=sz) self.verify_tun_66(self.params[socket.AF_INET6], count=NUM_PKTS, payload_size=sz) self.verify_tun_44(self.params[socket.AF_INET], count=NUM_PKTS, payload_size=sz) # # remove the SPDs, SAs, etc # self.unconfig_network() # # reconfigure the network and SA to run the # anti replay tests # self.config_network(self.params.values()) self.verify_tra_anti_replay() self.unconfig_network() # # To generate test classes, do: # grep '# GEN' test_ipsec_esp.py | sed -e 's/# GEN //g' | bash # # GEN for ENG in ia32 ipsecmb openssl; do \ # GEN for FLG in noESN ESN; do for ALG in AES-GCM-128/NONE \ # GEN AES-GCM-192/NONE AES-GCM-256/NONE AES-CBC-128/MD5-96 \ # GEN AES-CBC-192/SHA1-96 AES-CBC-256/SHA1-96 \ # GEN 3DES-CBC/SHA1-96 NONE/SHA1-96; do \ # GEN [[ ${FLG} == "ESN" && ${ALG} == *"NONE" ]] && continue # GEN echo -e "\n\nclass Test_${ENG}_${FLG}_${ALG}(RunTestIpsecEspAll):" | # GEN sed -e 's/-/_/g' -e 's#/#_#g' ; \ # GEN echo ' """'$ENG $FLG $ALG IPSec test'"""' ; # GEN echo " def test_ipsec(self):"; # GEN echo " self.run_test()"; # GEN done; done; done class Test_ia32_noESN_AES_GCM_128_NONE(RunTestIpsecEspAll): """ia32 noESN AES-GCM-128/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_noESN_AES_GCM_192_NONE(RunTestIpsecEspAll): """ia32 noESN AES-GCM-192/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_noESN_AES_GCM_256_NONE(RunTestIpsecEspAll): """ia32 noESN AES-GCM-256/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_noESN_AES_CBC_128_MD5_96(RunTestIpsecEspAll): """ia32 noESN AES-CBC-128/MD5-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_noESN_AES_CBC_192_SHA1_96(RunTestIpsecEspAll): """ia32 noESN AES-CBC-192/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_noESN_AES_CBC_256_SHA1_96(RunTestIpsecEspAll): """ia32 noESN AES-CBC-256/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_noESN_3DES_CBC_SHA1_96(RunTestIpsecEspAll): """ia32 noESN 3DES-CBC/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_noESN_NONE_SHA1_96(RunTestIpsecEspAll): """ia32 noESN NONE/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_ESN_AES_CBC_128_MD5_96(RunTestIpsecEspAll): """ia32 ESN AES-CBC-128/MD5-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_ESN_AES_CBC_192_SHA1_96(RunTestIpsecEspAll): """ia32 ESN AES-CBC-192/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_ESN_AES_CBC_256_SHA1_96(RunTestIpsecEspAll): """ia32 ESN AES-CBC-256/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_ESN_3DES_CBC_SHA1_96(RunTestIpsecEspAll): """ia32 ESN 3DES-CBC/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ia32_ESN_NONE_SHA1_96(RunTestIpsecEspAll): """ia32 ESN NONE/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_noESN_AES_GCM_128_NONE(RunTestIpsecEspAll): """ipsecmb noESN AES-GCM-128/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_noESN_AES_GCM_192_NONE(RunTestIpsecEspAll): """ipsecmb noESN AES-GCM-192/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_noESN_AES_GCM_256_NONE(RunTestIpsecEspAll): """ipsecmb noESN AES-GCM-256/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_noESN_AES_CBC_128_MD5_96(RunTestIpsecEspAll): """ipsecmb noESN AES-CBC-128/MD5-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_noESN_AES_CBC_192_SHA1_96(RunTestIpsecEspAll): """ipsecmb noESN AES-CBC-192/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_noESN_AES_CBC_256_SHA1_96(RunTestIpsecEspAll): """ipsecmb noESN AES-CBC-256/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_noESN_3DES_CBC_SHA1_96(RunTestIpsecEspAll): """ipsecmb noESN 3DES-CBC/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_noESN_NONE_SHA1_96(RunTestIpsecEspAll): """ipsecmb noESN NONE/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_ESN_AES_CBC_128_MD5_96(RunTestIpsecEspAll): """ipsecmb ESN AES-CBC-128/MD5-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_ESN_AES_CBC_192_SHA1_96(RunTestIpsecEspAll): """ipsecmb ESN AES-CBC-192/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_ESN_AES_CBC_256_SHA1_96(RunTestIpsecEspAll): """ipsecmb ESN AES-CBC-256/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_ESN_3DES_CBC_SHA1_96(RunTestIpsecEspAll): """ipsecmb ESN 3DES-CBC/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_ipsecmb_ESN_NONE_SHA1_96(RunTestIpsecEspAll): """ipsecmb ESN NONE/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_noESN_AES_GCM_128_NONE(RunTestIpsecEspAll): """openssl noESN AES-GCM-128/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_noESN_AES_GCM_192_NONE(RunTestIpsecEspAll): """openssl noESN AES-GCM-192/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_noESN_AES_GCM_256_NONE(RunTestIpsecEspAll): """openssl noESN AES-GCM-256/NONE IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_noESN_AES_CBC_128_MD5_96(RunTestIpsecEspAll): """openssl noESN AES-CBC-128/MD5-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_noESN_AES_CBC_192_SHA1_96(RunTestIpsecEspAll): """openssl noESN AES-CBC-192/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_noESN_AES_CBC_256_SHA1_96(RunTestIpsecEspAll): """openssl noESN AES-CBC-256/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_noESN_3DES_CBC_SHA1_96(RunTestIpsecEspAll): """openssl noESN 3DES-CBC/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_noESN_NONE_SHA1_96(RunTestIpsecEspAll): """openssl noESN NONE/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_ESN_AES_CBC_128_MD5_96(RunTestIpsecEspAll): """openssl ESN AES-CBC-128/MD5-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_ESN_AES_CBC_192_SHA1_96(RunTestIpsecEspAll): """openssl ESN AES-CBC-192/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_ESN_AES_CBC_256_SHA1_96(RunTestIpsecEspAll): """openssl ESN AES-CBC-256/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_ESN_3DES_CBC_SHA1_96(RunTestIpsecEspAll): """openssl ESN 3DES-CBC/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() class Test_openssl_ESN_NONE_SHA1_96(RunTestIpsecEspAll): """openssl ESN NONE/SHA1-96 IPSec test""" def test_ipsec(self): self.run_test() if __name__ == '__main__': unittest.main(testRunner=VppTestRunner)