-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
"""IPsec utilities library."""
-from ipaddress import ip_network
+import os
-from enum import Enum
+from enum import Enum, IntEnum
+from io import open
+from random import choice
+from string import ascii_letters
-from resources.libraries.python.VatExecutor import VatExecutor
+from ipaddress import ip_network, ip_address
+
+from resources.libraries.python.IPUtil import IPUtil
+from resources.libraries.python.InterfaceUtil import InterfaceUtil, \
+ InterfaceStatusFlags
+from resources.libraries.python.PapiExecutor import PapiSocketExecutor
from resources.libraries.python.topology import Topology
-from resources.libraries.python.VatJsonUtil import VatJsonUtil
+from resources.libraries.python.VatExecutor import VatExecutor
+
+
+def gen_key(length):
+ """Generate random string as a key.
+
+ :param length: Length of generated payload.
+ :type length: int
+ :returns: The generated payload.
+ :rtype: bytes
+ """
+ return u"".join(
+ choice(ascii_letters) for _ in range(length)
+ ).encode(encoding=u"utf-8")
-# pylint: disable=too-few-public-methods
class PolicyAction(Enum):
"""Policy actions."""
- BYPASS = 'bypass'
- DISCARD = 'discard'
- PROTECT = 'protect'
+ BYPASS = (u"bypass", 0)
+ DISCARD = (u"discard", 1)
+ PROTECT = (u"protect", 3)
- def __init__(self, string):
- self.string = string
+ def __init__(self, policy_name, policy_int_repr):
+ self.policy_name = policy_name
+ self.policy_int_repr = policy_int_repr
class CryptoAlg(Enum):
"""Encryption algorithms."""
- AES_CBC_128 = ('aes-cbc-128', 'AES-CBC', 16)
- AES_CBC_192 = ('aes-cbc-128', 'AES-CBC', 24)
- AES_CBC_256 = ('aes-cbc-256', 'AES-CBC', 32)
+ AES_CBC_128 = (u"aes-cbc-128", 1, u"AES-CBC", 16)
+ AES_CBC_256 = (u"aes-cbc-256", 3, u"AES-CBC", 32)
+ AES_GCM_128 = (u"aes-gcm-128", 7, u"AES-GCM", 16)
+ AES_GCM_256 = (u"aes-gcm-256", 9, u"AES-GCM", 32)
- def __init__(self, alg_name, scapy_name, key_len):
+ def __init__(self, alg_name, alg_int_repr, scapy_name, key_len):
self.alg_name = alg_name
+ self.alg_int_repr = alg_int_repr
self.scapy_name = scapy_name
self.key_len = key_len
class IntegAlg(Enum):
"""Integrity algorithm."""
- SHA1_96 = ('sha1-96', 'HMAC-SHA1-96', 20)
- SHA_256_128 = ('sha-256-128', 'SHA2-256-128', 32)
- SHA_384_192 = ('sha-384-192', 'SHA2-384-192', 48)
- SHA_512_256 = ('sha-512-256', 'SHA2-512-256', 64)
+ SHA_256_128 = (u"sha-256-128", 4, u"SHA2-256-128", 32)
+ SHA_512_256 = (u"sha-512-256", 6, u"SHA2-512-256", 64)
- def __init__(self, alg_name, scapy_name, key_len):
+ def __init__(self, alg_name, alg_int_repr, scapy_name, key_len):
self.alg_name = alg_name
+ self.alg_int_repr = alg_int_repr
self.scapy_name = scapy_name
self.key_len = key_len
-class IPsecUtil(object):
- """IPsec utilities."""
+class IPsecProto(IntEnum):
+ """IPsec protocol."""
+ ESP = 1
+ SEC_AH = 0
+
- # pylint: disable=too-many-arguments
- # pylint: disable=too-many-locals
+class IPsecSadFlags(IntEnum):
+ """IPsec Security Association Database flags."""
+ IPSEC_API_SAD_FLAG_NONE = 0
+ IPSEC_API_SAD_FLAG_IS_TUNNEL = 4
+ IPSEC_API_SAD_FLAG_IS_TUNNEL_V6 = 8
+
+
+class IPsecUtil:
+ """IPsec utilities."""
@staticmethod
def policy_action_bypass():
"""Return policy action bypass.
- :return: PolicyAction enum BYPASS object.
+ :returns: PolicyAction enum BYPASS object.
:rtype: PolicyAction
"""
return PolicyAction.BYPASS
def policy_action_discard():
"""Return policy action discard.
- :return: PolicyAction enum DISCARD object.
+ :returns: PolicyAction enum DISCARD object.
:rtype: PolicyAction
"""
return PolicyAction.DISCARD
def policy_action_protect():
"""Return policy action protect.
- :return: PolicyAction enum PROTECT object.
+ :returns: PolicyAction enum PROTECT object.
:rtype: PolicyAction
"""
return PolicyAction.PROTECT
def crypto_alg_aes_cbc_128():
"""Return encryption algorithm aes-cbc-128.
- :return: CryptoAlg enum AES_CBC_128 object.
+ :returns: CryptoAlg enum AES_CBC_128 object.
:rtype: CryptoAlg
"""
return CryptoAlg.AES_CBC_128
@staticmethod
- def crypto_alg_aes_cbc_192():
- """Return encryption algorithm aes-cbc-192.
+ def crypto_alg_aes_cbc_256():
+ """Return encryption algorithm aes-cbc-256.
- :return: CryptoAlg enum AES_CBC_192 objec.
+ :returns: CryptoAlg enum AES_CBC_256 object.
:rtype: CryptoAlg
"""
- return CryptoAlg.AES_CBC_192
+ return CryptoAlg.AES_CBC_256
@staticmethod
- def crypto_alg_aes_cbc_256():
- """Return encryption algorithm aes-cbc-256.
+ def crypto_alg_aes_gcm_128():
+ """Return encryption algorithm aes-gcm-128.
- :return: CryptoAlg enum AES_CBC_256 object.
+ :returns: CryptoAlg enum AES_GCM_128 object.
:rtype: CryptoAlg
"""
- return CryptoAlg.AES_CBC_256
+ return CryptoAlg.AES_GCM_128
+
+ @staticmethod
+ def crypto_alg_aes_gcm_256():
+ """Return encryption algorithm aes-gcm-256.
+
+ :returns: CryptoAlg enum AES_GCM_128 object.
+ :rtype: CryptoAlg
+ """
+ return CryptoAlg.AES_GCM_256
@staticmethod
def get_crypto_alg_key_len(crypto_alg):
:param crypto_alg: Encryption algorithm.
:type crypto_alg: CryptoAlg
- :return: Key length.
+ :returns: Key length.
:rtype: int
"""
return crypto_alg.key_len
:param crypto_alg: Encryption algorithm.
:type crypto_alg: CryptoAlg
- :return: Algorithm scapy name.
+ :returns: Algorithm scapy name.
:rtype: str
"""
return crypto_alg.scapy_name
- @staticmethod
- def integ_alg_sha1_96():
- """Return integrity algorithm SHA1-96.
-
- :return: IntegAlg enum SHA1_96 object.
- :rtype: IntegAlg
- """
- return IntegAlg.SHA1_96
-
@staticmethod
def integ_alg_sha_256_128():
"""Return integrity algorithm SHA-256-128.
- :return: IntegAlg enum SHA_256_128 object.
+ :returns: IntegAlg enum SHA_256_128 object.
:rtype: IntegAlg
"""
return IntegAlg.SHA_256_128
- @staticmethod
- def integ_alg_sha_384_192():
- """Return integrity algorithm SHA-384-192.
-
- :return: IntegAlg enum SHA_384_192 object.
- :rtype: IntegAlg
- """
- return IntegAlg.SHA_384_192
-
@staticmethod
def integ_alg_sha_512_256():
"""Return integrity algorithm SHA-512-256.
- :return: IntegAlg enum SHA_512_256 object.
+ :returns: IntegAlg enum SHA_512_256 object.
:rtype: IntegAlg
"""
return IntegAlg.SHA_512_256
:param integ_alg: Integrity algorithm.
:type integ_alg: IntegAlg
- :return: Key length.
+ :returns: Key length.
:rtype: int
"""
return integ_alg.key_len
:param integ_alg: Integrity algorithm.
:type integ_alg: IntegAlg
- :return: Algorithm scapy name.
+ :returns: Algorithm scapy name.
:rtype: str
"""
return integ_alg.scapy_name
@staticmethod
- def vpp_ipsec_add_sad_entry(node, sad_id, spi, crypto_alg, crypto_key,
- integ_alg, integ_key, tunnel_src=None,
- tunnel_dst=None):
+ def ipsec_proto_esp():
+ """Return IPSec protocol ESP.
+
+ :returns: IPsecProto enum ESP object.
+ :rtype: IPsecProto
+ """
+ return int(IPsecProto.ESP)
+
+ @staticmethod
+ def ipsec_proto_ah():
+ """Return IPSec protocol AH.
+
+ :returns: IPsecProto enum AH object.
+ :rtype: IPsecProto
+ """
+ return int(IPsecProto.SEC_AH)
+
+ @staticmethod
+ def vpp_ipsec_select_backend(node, protocol, index=1):
+ """Select IPsec backend.
+
+ :param node: VPP node to select IPsec backend on.
+ :param protocol: IPsec protocol.
+ :param index: Backend index.
+ :type node: dict
+ :type protocol: IPsecProto
+ :type index: int
+ :raises RuntimeError: If failed to select IPsec backend or if no API
+ reply received.
+ """
+ cmd = u"ipsec_select_backend"
+ err_msg = f"Failed to select IPsec backend on host {node[u'host']}"
+ args = dict(
+ protocol=protocol,
+ index=index
+ )
+ with PapiSocketExecutor(node) as papi_exec:
+ papi_exec.add(cmd, **args).get_reply(err_msg)
+
+ @staticmethod
+ def vpp_ipsec_backend_dump(node):
+ """Dump IPsec backends.
+
+ :param node: VPP node to dump IPsec backend on.
+ :type node: dict
+ """
+ err_msg = f"Failed to dump IPsec backends on host {node[u'host']}"
+ with PapiSocketExecutor(node) as papi_exec:
+ papi_exec.add(u"ipsec_backend_dump").get_details(err_msg)
+
+ @staticmethod
+ def vpp_ipsec_add_sad_entry(
+ node, sad_id, spi, crypto_alg, crypto_key, integ_alg=None,
+ integ_key=u"", tunnel_src=None, tunnel_dst=None):
"""Create Security Association Database entry on the VPP node.
:param node: VPP node to add SAD entry on.
:type spi: int
:type crypto_alg: CryptoAlg
:type crypto_key: str
- :type integ_alg: str
+ :type integ_alg: IntegAlg
:type integ_key: str
:type tunnel_src: str
:type tunnel_dst: str
"""
- ckey = crypto_key.encode('hex')
- ikey = integ_key.encode('hex')
- tunnel = ''
- if tunnel_src is not None and tunnel_dst is not None:
- tunnel = 'tunnel_src {0} tunnel_dst {1}'.format(tunnel_src,
- tunnel_dst)
- out = VatExecutor.cmd_from_template(node,
- "ipsec/ipsec_sad_add_entry.vat",
- sad_id=sad_id, spi=spi,
- calg=crypto_alg.alg_name, ckey=ckey,
- ialg=integ_alg.alg_name, ikey=ikey,
- tunnel=tunnel)
- VatJsonUtil.verify_vat_retval(
- out[0],
- err_msg='Add SAD entry failed on {0}'.format(node['host']))
+ if isinstance(crypto_key, str):
+ crypto_key = crypto_key.encode(encoding=u"utf-8")
+ if isinstance(integ_key, str):
+ integ_key = integ_key.encode(encoding=u"utf-8")
+ ckey = dict(
+ length=len(crypto_key),
+ data=crypto_key
+ )
+ ikey = dict(
+ length=len(integ_key),
+ data=integ_key if integ_key else 0
+ )
+
+ flags = int(IPsecSadFlags.IPSEC_API_SAD_FLAG_NONE)
+ if tunnel_src and tunnel_dst:
+ flags = flags | int(IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_TUNNEL)
+ src_addr = ip_address(tunnel_src)
+ dst_addr = ip_address(tunnel_dst)
+ if src_addr.version == 6:
+ flags = \
+ flags | int(IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_TUNNEL_V6)
+ else:
+ src_addr = u""
+ dst_addr = u""
+
+ cmd = u"ipsec_sad_entry_add_del"
+ err_msg = f"Failed to add Security Association Database entry " \
+ f"on host {node[u'host']}"
+ sad_entry = dict(
+ sad_id=int(sad_id),
+ spi=int(spi),
+ crypto_algorithm=crypto_alg.alg_int_repr,
+ crypto_key=ckey,
+ integrity_algorithm=integ_alg.alg_int_repr if integ_alg else 0,
+ integrity_key=ikey,
+ flags=flags,
+ tunnel_src=str(src_addr),
+ tunnel_dst=str(dst_addr),
+ protocol=int(IPsecProto.ESP)
+ )
+ args = dict(
+ is_add=1,
+ entry=sad_entry
+ )
+ with PapiSocketExecutor(node) as papi_exec:
+ papi_exec.add(cmd, **args).get_reply(err_msg)
+
+ @staticmethod
+ def vpp_ipsec_add_sad_entries(
+ node, n_entries, sad_id, spi, crypto_alg, crypto_key,
+ integ_alg=None, integ_key=u"", tunnel_src=None, tunnel_dst=None):
+ """Create multiple Security Association Database entries on VPP node.
+
+ :param node: VPP node to add SAD entry on.
+ :param n_entries: Number of SAD entries to be created.
+ :param sad_id: First SAD entry ID. All subsequent SAD entries will have
+ id incremented by 1.
+ :param spi: Security Parameter Index of first SAD entry. All subsequent
+ SAD entries will have spi incremented by 1.
+ :param crypto_alg: The encryption algorithm name.
+ :param crypto_key: The encryption key string.
+ :param integ_alg: The integrity algorithm name.
+ :param integ_key: The integrity key string.
+ :param tunnel_src: Tunnel header source IPv4 or IPv6 address. If not
+ specified ESP transport mode is used.
+ :param tunnel_dst: Tunnel header destination IPv4 or IPv6 address. If
+ not specified ESP transport mode is used.
+ :type node: dict
+ :type n_entries: int
+ :type sad_id: int
+ :type spi: int
+ :type crypto_alg: CryptoAlg
+ :type crypto_key: str
+ :type integ_alg: IntegAlg
+ :type integ_key: str
+ :type tunnel_src: str
+ :type tunnel_dst: str
+ """
+ if isinstance(crypto_key, str):
+ crypto_key = crypto_key.encode(encoding=u"utf-8")
+ if isinstance(integ_key, str):
+ integ_key = integ_key.encode(encoding=u"utf-8")
+ if tunnel_src and tunnel_dst:
+ src_addr = ip_address(tunnel_src)
+ dst_addr = ip_address(tunnel_dst)
+ else:
+ src_addr = u""
+ dst_addr = u""
+
+ addr_incr = 1 << (128 - 96) if src_addr.version == 6 \
+ else 1 << (32 - 24)
+
+ if int(n_entries) > 10:
+ tmp_filename = f"/tmp/ipsec_sad_{sad_id}_add_del_entry.script"
+
+ with open(tmp_filename, 'w') as tmp_file:
+ for i in range(n_entries):
+ integ = f"integ-alg {integ_alg.alg_name} " \
+ f"integ-key {integ_key.hex()}" \
+ if integ_alg else u""
+ tunnel = f"tunnel-src {src_addr + i * addr_incr} " \
+ f"tunnel-dst {dst_addr + i * addr_incr}" \
+ if tunnel_src and tunnel_dst else u""
+ conf = f"exec ipsec sa add {sad_id + i} esp spi {spi + i} "\
+ f"crypto-alg {crypto_alg.alg_name} " \
+ f"crypto-key {crypto_key.hex()} " \
+ f"{integ} {tunnel}\n"
+ tmp_file.write(conf)
+ vat = VatExecutor()
+ vat.execute_script(
+ tmp_filename, node, timeout=300, json_out=False,
+ copy_on_execute=True
+ )
+ os.remove(tmp_filename)
+ return
+
+ ckey = dict(
+ length=len(crypto_key),
+ data=crypto_key
+ )
+ ikey = dict(
+ length=len(integ_key),
+ data=integ_key if integ_key else 0
+ )
+
+ flags = int(IPsecSadFlags.IPSEC_API_SAD_FLAG_NONE)
+ if tunnel_src and tunnel_dst:
+ flags = flags | int(IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_TUNNEL)
+ if src_addr.version == 6:
+ flags = flags | int(
+ IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_TUNNEL_V6
+ )
+
+ cmd = u"ipsec_sad_entry_add_del"
+ err_msg = f"Failed to add Security Association Database entry " \
+ f"on host {node[u'host']}"
+
+ sad_entry = dict(
+ sad_id=int(sad_id),
+ spi=int(spi),
+ crypto_algorithm=crypto_alg.alg_int_repr,
+ crypto_key=ckey,
+ integrity_algorithm=integ_alg.alg_int_repr if integ_alg else 0,
+ integrity_key=ikey,
+ flags=flags,
+ tunnel_src=str(src_addr),
+ tunnel_dst=str(dst_addr),
+ protocol=int(IPsecProto.ESP)
+ )
+ args = dict(
+ is_add=1,
+ entry=sad_entry
+ )
+ with PapiSocketExecutor(node) as papi_exec:
+ for i in range(n_entries):
+ args[u"entry"][u"sad_id"] = int(sad_id) + i
+ args[u"entry"][u"spi"] = int(spi) + i
+ args[u"entry"][u"tunnel_src"] = str(src_addr + i * addr_incr) \
+ if tunnel_src and tunnel_dst else src_addr
+ args[u"entry"][u"tunnel_dst"] = str(dst_addr + i * addr_incr) \
+ if tunnel_src and tunnel_dst else dst_addr
+ history = bool(not 1 < i < n_entries - 2)
+ papi_exec.add(cmd, history=history, **args)
+ papi_exec.get_replies(err_msg)
+
+ @staticmethod
+ def vpp_ipsec_set_ip_route(
+ node, n_tunnels, tunnel_src, traffic_addr, tunnel_dst, interface,
+ raddr_range):
+ """Set IP address and route on interface.
+
+ :param node: VPP node to add config on.
+ :param n_tunnels: Number of tunnels to create.
+ :param tunnel_src: Tunnel header source IPv4 or IPv6 address.
+ :param traffic_addr: Traffic destination IP address to route.
+ :param tunnel_dst: Tunnel header destination IPv4 or IPv6 address.
+ :param interface: Interface key on node 1.
+ :param raddr_range: Mask specifying range of Policy selector Remote IP
+ addresses. Valid values are from 1 to 32 in case of IPv4 and to 128
+ in case of IPv6.
+ :type node: dict
+ :type n_tunnels: int
+ :type tunnel_src: str
+ :type traffic_addr: str
+ :type tunnel_dst: str
+ :type interface: str
+ :type raddr_range: int
+ """
+ laddr = ip_address(tunnel_src)
+ raddr = ip_address(tunnel_dst)
+ taddr = ip_address(traffic_addr)
+ addr_incr = 1 << (128 - raddr_range) if laddr.version == 6 \
+ else 1 << (32 - raddr_range)
+
+ if int(n_tunnels) > 10:
+ tmp_filename = u"/tmp/ipsec_set_ip.script"
+
+ with open(tmp_filename, 'w') as tmp_file:
+ if_name = Topology.get_interface_name(node, interface)
+ for i in range(n_tunnels):
+ conf = f"exec set interface ip address {if_name} " \
+ f"{laddr + i * addr_incr}/{raddr_range}\n" \
+ f"exec ip route add {taddr + i}/" \
+ f"{128 if taddr.version == 6 else 32} " \
+ f"via {raddr + i * addr_incr} {if_name}\n"
+ tmp_file.write(conf)
+ vat = VatExecutor()
+ vat.execute_script(
+ tmp_filename, node, timeout=300, json_out=False,
+ copy_on_execute=True
+ )
+ os.remove(tmp_filename)
+ return
+
+ cmd1 = u"sw_interface_add_del_address"
+ args1 = dict(
+ sw_if_index=InterfaceUtil.get_interface_index(node, interface),
+ is_add=True,
+ del_all=False,
+ prefix=None
+ )
+ cmd2 = u"ip_route_add_del"
+ args2 = dict(
+ is_add=1,
+ is_multipath=0,
+ route=None
+ )
+ err_msg = f"Failed to configure IP addresses and IP routes " \
+ f"on interface {interface} on host {node[u'host']}"
+
+ with PapiSocketExecutor(node) as papi_exec:
+ for i in range(n_tunnels):
+ args1[u"prefix"] = IPUtil.create_prefix_object(
+ laddr + i * addr_incr, raddr_range
+ )
+ args2[u"route"] = IPUtil.compose_vpp_route_structure(
+ node, taddr + i,
+ prefix_len=128 if taddr.version == 6 else 32,
+ interface=interface, gateway=raddr + i * addr_incr
+ )
+ history = bool(not 1 < i < n_tunnels - 2)
+ papi_exec.add(cmd1, history=history, **args1).\
+ add(cmd2, history=history, **args2)
+ papi_exec.get_replies(err_msg)
@staticmethod
def vpp_ipsec_add_spd(node, spd_id):
:type node: dict
:type spd_id: int
"""
- out = VatExecutor.cmd_from_template(node, "ipsec/ipsec_spd_add.vat",
- spd_id=spd_id)
- VatJsonUtil.verify_vat_retval(
- out[0],
- err_msg='Add SPD {0} failed on {1}'.format(spd_id, node['host']))
+ cmd = u"ipsec_spd_add_del"
+ err_msg = f"Failed to add Security Policy Database " \
+ f"on host {node[u'host']}"
+ args = dict(
+ is_add=1,
+ spd_id=int(spd_id)
+ )
+ with PapiSocketExecutor(node) as papi_exec:
+ papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def vpp_ipsec_spd_add_if(node, spd_id, interface):
- """Add interface to the SPD.
+ """Add interface to the Security Policy Database.
:param node: VPP node.
:param spd_id: SPD ID to add interface on.
:type spd_id: int
:type interface: str or int
"""
- if isinstance(interface, basestring):
- sw_if_index = Topology.get_interface_sw_index(node, interface)
- else:
- sw_if_index = interface
- out = VatExecutor.cmd_from_template(node,
- "ipsec/ipsec_interface_add_spd.vat",
- spd_id=spd_id, sw_if_id=sw_if_index)
- VatJsonUtil.verify_vat_retval(
- out[0],
- err_msg='Add interface {0} to SPD {1} failed on {2}'.format(
- interface, spd_id, node['host']))
+ cmd = u"ipsec_interface_add_del_spd"
+ err_msg = f"Failed to add interface {interface} to Security Policy " \
+ f"Database {spd_id} on host {node[u'host']}"
+ args = dict(
+ is_add=1,
+ sw_if_index=InterfaceUtil.get_interface_index(node, interface),
+ spd_id=int(spd_id)
+ )
+ with PapiSocketExecutor(node) as papi_exec:
+ papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
- def vpp_ipsec_spd_add_entry(node, spd_id, priority, action, inbound=True,
- sa_id=None, laddr_range=None, raddr_range=None,
- proto=None, lport_range=None, rport_range=None):
+ def vpp_ipsec_policy_add(
+ node, spd_id, priority, action, inbound=True, sa_id=None,
+ laddr_range=None, raddr_range=None, proto=None, lport_range=None,
+ rport_range=None, is_ipv6=False):
"""Create Security Policy Database entry on the VPP node.
:param node: VPP node to add SPD entry on.
outbound.
:param sa_id: SAD entry ID for protect action.
:param laddr_range: Policy selector local IPv4 or IPv6 address range in
- format IP/prefix or IP/mask. If no mask is provided, it's considered
- to be /32.
+ format IP/prefix or IP/mask. If no mask is provided,
+ it's considered to be /32.
:param raddr_range: Policy selector remote IPv4 or IPv6 address range in
- format IP/prefix or IP/mask. If no mask is provided, it's considered
- to be /32.
+ format IP/prefix or IP/mask. If no mask is provided,
+ it's considered to be /32.
:param proto: Policy selector next layer protocol number.
- :param lport_range: Policy selector local TCP/UDP port range in foramt
+ :param lport_range: Policy selector local TCP/UDP port range in format
<port_start>-<port_end>.
- :param rport_range: Policy selector remote TCP/UDP port range in foramt
+ :param rport_range: Policy selector remote TCP/UDP port range in format
<port_start>-<port_end>.
+ :param is_ipv6: True in case of IPv6 policy when IPv6 address range is
+ not defined so it will default to address ::/0, otherwise False.
:type node: dict
:type spd_id: int
:type priority: int
:type proto: int
:type lport_range: string
:type rport_range: string
+ :type is_ipv6: bool
+ """
+ if laddr_range is None:
+ laddr_range = u"::/0" if is_ipv6 else u"0.0.0.0/0"
+
+ if raddr_range is None:
+ raddr_range = u"::/0" if is_ipv6 else u"0.0.0.0/0"
+
+ cmd = u"ipsec_spd_entry_add_del"
+ err_msg = f"Failed to add entry to Security Policy Database {spd_id} " \
+ f"on host {node[u'host']}"
+
+ spd_entry = dict(
+ spd_id=int(spd_id),
+ priority=int(priority),
+ is_outbound=0 if inbound else 1,
+ sa_id=int(sa_id) if sa_id else 0,
+ policy=action.policy_int_repr,
+ protocol=int(proto) if proto else 0,
+ remote_address_start=IPUtil.create_ip_address_object(
+ ip_network(raddr_range, strict=False).network_address
+ ),
+ remote_address_stop=IPUtil.create_ip_address_object(
+ ip_network(raddr_range, strict=False).broadcast_address
+ ),
+ local_address_start=IPUtil.create_ip_address_object(
+ ip_network(laddr_range, strict=False).network_address
+ ),
+ local_address_stop=IPUtil.create_ip_address_object(
+ ip_network(laddr_range, strict=False).broadcast_address
+ ),
+ remote_port_start=int(rport_range.split(u"-")[0]) if rport_range
+ else 0,
+ remote_port_stop=int(rport_range.split(u"-")[1]) if rport_range
+ else 65535,
+ local_port_start=int(lport_range.split(u"-")[0]) if lport_range
+ else 0,
+ local_port_stop=int(lport_range.split(u"-")[1]) if rport_range
+ else 65535
+ )
+ args = dict(
+ is_add=1,
+ entry=spd_entry
+ )
+ with PapiSocketExecutor(node) as papi_exec:
+ papi_exec.add(cmd, **args).get_reply(err_msg)
+
+ @staticmethod
+ def vpp_ipsec_spd_add_entries(
+ node, n_entries, spd_id, priority, inbound, sa_id, raddr_ip,
+ raddr_range=0):
+ """Create multiple Security Policy Database entries on the VPP node.
+
+ :param node: VPP node to add SPD entries on.
+ :param n_entries: Number of SPD entries to be added.
+ :param spd_id: SPD ID to add entries on.
+ :param priority: SPD entries priority, higher number = higher priority.
+ :param inbound: If True policy is for inbound traffic, otherwise
+ outbound.
+ :param sa_id: SAD entry ID for first entry. Each subsequent entry will
+ SAD entry ID incremented by 1.
+ :param raddr_ip: Policy selector remote IPv4 start address for the first
+ entry. Remote IPv4 end address will be calculated depending on
+ raddr_range parameter. Each subsequent entry will have start address
+ next after IPv4 end address of previous entry.
+ :param raddr_range: Required IP addres range.
+ :type node: dict
+ :type n_entries: int
+ :type spd_id: int
+ :type priority: int
+ :type inbound: bool
+ :type sa_id: int
+ :type raddr_ip: str
+ :type raddr_range: int
+ """
+ raddr_ip = ip_address(raddr_ip)
+ if int(n_entries) > 10:
+ tmp_filename = f"/tmp/ipsec_spd_{sa_id}_add_del_entry.script"
+
+ with open(tmp_filename, 'w') as tmp_file:
+ for i in range(n_entries):
+ direction = u'inbound' if inbound else u'outbound'
+ tunnel = f"exec ipsec policy add spd {spd_id} " \
+ f"priority {priority} {direction} " \
+ f"action protect sa {sa_id+i} " \
+ f"remote-ip-range {raddr_ip + i * (raddr_range + 1)} " \
+ f"- {raddr_ip + (i + 1) * raddr_range + i} " \
+ f"local-ip-range 0.0.0.0 - 255.255.255.255\n"
+ tmp_file.write(tunnel)
+ VatExecutor().execute_script(
+ tmp_filename, node, timeout=300, json_out=False,
+ copy_on_execute=True
+ )
+ os.remove(tmp_filename)
+ return
+
+ laddr_range = u"::/0" if raddr_ip.version == 6 else u"0.0.0.0/0"
+
+ cmd = u"ipsec_spd_entry_add_del"
+ err_msg = f"ailed to add entry to Security Policy Database '{spd_id} " \
+ f"on host {node[u'host']}"
+
+ spd_entry = dict(
+ spd_id=int(spd_id),
+ priority=int(priority),
+ is_outbound=0 if inbound else 1,
+ sa_id=int(sa_id) if sa_id else 0,
+ policy=IPsecUtil.policy_action_protect().policy_int_repr,
+ protocol=0,
+ remote_address_start=IPUtil.create_ip_address_object(raddr_ip),
+ remote_address_stop=IPUtil.create_ip_address_object(raddr_ip),
+ local_address_start=IPUtil.create_ip_address_object(
+ ip_network(laddr_range, strict=False).network_address
+ ),
+ local_address_stop=IPUtil.create_ip_address_object(
+ ip_network(laddr_range, strict=False).broadcast_address
+ ),
+ remote_port_start=0,
+ remote_port_stop=65535,
+ local_port_start=0,
+ local_port_stop=65535
+ )
+ args = dict(
+ is_add=1,
+ entry=spd_entry
+ )
+
+ with PapiSocketExecutor(node) as papi_exec:
+ for i in range(n_entries):
+ args[u"entry"][u"remote_address_start"][u"un"] = \
+ IPUtil.union_addr(raddr_ip + i)
+ args[u"entry"][u"remote_address_stop"][u"un"] = \
+ IPUtil.union_addr(raddr_ip + i)
+ history = bool(not 1 < i < n_entries - 2)
+ papi_exec.add(cmd, history=history, **args)
+ papi_exec.get_replies(err_msg)
+
+ @staticmethod
+ def vpp_ipsec_create_tunnel_interfaces(
+ nodes, if1_ip_addr, if2_ip_addr, if1_key, if2_key, n_tunnels,
+ crypto_alg, integ_alg, raddr_ip1, raddr_ip2, raddr_range):
+ """Create multiple IPsec tunnel interfaces between two VPP nodes.
+
+ :param nodes: VPP nodes to create tunnel interfaces.
+ :param if1_ip_addr: VPP node 1 interface IPv4/IPv6 address.
+ :param if2_ip_addr: VPP node 2 interface IPv4/IPv6 address.
+ :param if1_key: VPP node 1 interface key from topology file.
+ :param if2_key: VPP node 2 interface key from topology file.
+ :param n_tunnels: Number of tunnel interfaces to create.
+ :param crypto_alg: The encryption algorithm name.
+ :param integ_alg: The integrity algorithm name.
+ :param raddr_ip1: Policy selector remote IPv4/IPv6 start address for the
+ first tunnel in direction node1->node2.
+ :param raddr_ip2: Policy selector remote IPv4/IPv6 start address for the
+ first tunnel in direction node2->node1.
+ :param raddr_range: Mask specifying range of Policy selector Remote
+ IPv4/IPv6 addresses. Valid values are from 1 to 32 in case of IPv4
+ and to 128 in case of IPv6.
+ :type nodes: dict
+ :type if1_ip_addr: str
+ :type if2_ip_addr: str
+ :type if1_key: str
+ :type if2_key: str
+ :type n_tunnels: int
+ :type crypto_alg: CryptoAlg
+ :type integ_alg: IntegAlg
+ :type raddr_ip1: string
+ :type raddr_ip2: string
+ :type raddr_range: int
+ """
+ n_tunnels = int(n_tunnels)
+ spi_1 = 100000
+ spi_2 = 200000
+ if1_ip = ip_address(if1_ip_addr)
+ if2_ip = ip_address(if2_ip_addr)
+ raddr_ip1 = ip_address(raddr_ip1)
+ raddr_ip2 = ip_address(raddr_ip2)
+ addr_incr = 1 << (128 - raddr_range) if if1_ip.version == 6 \
+ else 1 << (32 - raddr_range)
+
+ if n_tunnels > 10:
+ tmp_fn1 = u"/tmp/ipsec_create_tunnel_dut1.config"
+ tmp_fn2 = u"/tmp/ipsec_create_tunnel_dut2.config"
+ if1_n = Topology.get_interface_name(nodes[u"DUT1"], if1_key)
+ if2_n = Topology.get_interface_name(nodes[u"DUT2"], if2_key)
+ mask = 96 if if2_ip.version == 6 else 24
+ mask2 = 128 if if2_ip.version == 6 else 32
+ vat = VatExecutor()
+ with open(tmp_fn1, 'w') as tmp_f1, open(tmp_fn2, 'w') as tmp_f2:
+ rmac = Topology.get_interface_mac(nodes[u"DUT2"], if2_key)
+ tmp_f1.write(
+ f"exec create loopback interface\n"
+ f"exec set interface state loop0 up\n"
+ f"exec set interface ip address "
+ f"{if1_n} {if2_ip - 1}/{mask}\n"
+ f"exec set ip arp {if1_n} {if2_ip}/{mask2} {rmac} static\n"
+ )
+ tmp_f2.write(
+ f"exec set interface ip address {if2_n} {if2_ip}/{mask}\n"
+ )
+ for i in range(n_tunnels):
+ ckey = gen_key(
+ IPsecUtil.get_crypto_alg_key_len(crypto_alg)
+ ).hex()
+ if integ_alg:
+ ikey = gen_key(
+ IPsecUtil.get_integ_alg_key_len(integ_alg)
+ ).hex()
+ integ = f"integ_alg {integ_alg.alg_name} " \
+ f"local_integ_key {ikey} remote_integ_key {ikey} "
+ else:
+ integ = u""
+ tmp_f1.write(
+ f"exec set interface ip address loop0 "
+ f"{if1_ip + i * addr_incr}/32\n"
+ f"ipsec_tunnel_if_add_del "
+ f"local_spi {spi_1 + i} remote_spi {spi_2 + i} "
+ f"crypto_alg {crypto_alg.alg_name} "
+ f"local_crypto_key {ckey} remote_crypto_key {ckey} "
+ f"{integ} "
+ f"local_ip {if1_ip + i * addr_incr} "
+ f"remote_ip {if2_ip}\n"
+ )
+ tmp_f2.write(
+ f"ipsec_tunnel_if_add_del "
+ f"local_spi {spi_2 + i} remote_spi {spi_1 + i} "
+ f"crypto_alg {crypto_alg.alg_name} "
+ f"local_crypto_key {ckey} remote_crypto_key {ckey} "
+ f"{integ} "
+ f"local_ip {if2_ip} "
+ f"remote_ip {if1_ip + i * addr_incr}\n"
+ )
+ vat.execute_script(
+ tmp_fn1, nodes[u"DUT1"], timeout=1800, json_out=False,
+ copy_on_execute=True,
+ history=bool(n_tunnels < 100)
+ )
+ vat.execute_script(
+ tmp_fn2, nodes[u"DUT2"], timeout=1800, json_out=False,
+ copy_on_execute=True,
+ history=bool(n_tunnels < 100)
+ )
+ os.remove(tmp_fn1)
+ os.remove(tmp_fn2)
+
+ with open(tmp_fn1, 'w') as tmp_f1, open(tmp_fn2, 'w') as tmp_f2:
+ raddr = ip_network(if1_ip_addr + u"/8", False)
+ tmp_f2.write(
+ f"exec ip route add {raddr} via {if2_n} {if2_ip - 1}\n"
+ )
+ for i in range(n_tunnels):
+ tmp_f1.write(
+ f"exec set interface unnumbered ipsec{i} use {if1_n}\n"
+ f"exec set interface state ipsec{i} up\n"
+ f"exec ip route add {raddr_ip2 + i}/{mask2} "
+ f"via ipsec{i}\n"
+ )
+ tmp_f2.write(
+ f"exec set interface unnumbered ipsec{i} use {if2_n}\n"
+ f"exec set interface state ipsec{i} up\n"
+ f"exec ip route add {raddr_ip1 + i}/{mask2} "
+ f"via ipsec{i}\n"
+ )
+ vat.execute_script(
+ tmp_fn1, nodes[u"DUT1"], timeout=1800, json_out=False,
+ copy_on_execute=True,
+ history=bool(n_tunnels < 100)
+ )
+ vat.execute_script(
+ tmp_fn2, nodes[u"DUT2"], timeout=1800, json_out=False,
+ copy_on_execute=True,
+ history=bool(n_tunnels < 100)
+ )
+ os.remove(tmp_fn1)
+ os.remove(tmp_fn2)
+ return
+
+ with PapiSocketExecutor(nodes[u"DUT1"]) as papi_exec:
+ # Create loopback interface on DUT1, set it to up state
+ cmd1 = u"create_loopback"
+ args1 = dict(
+ mac_address=0
+ )
+ err_msg = f"Failed to create loopback interface " \
+ f"on host {nodes[u'DUT1'][u'host']}"
+ loop_sw_if_idx = papi_exec.add(cmd1, **args1).\
+ get_sw_if_index(err_msg)
+ cmd1 = u"sw_interface_set_flags"
+ args1 = dict(
+ sw_if_index=loop_sw_if_idx,
+ flags=InterfaceStatusFlags.IF_STATUS_API_FLAG_ADMIN_UP.value
+ )
+ err_msg = f"Failed to set loopback interface state up " \
+ f"on host {nodes[u'DUT1'][u'host']}"
+ papi_exec.add(cmd1, **args1).get_reply(err_msg)
+ # Set IP address on VPP node 1 interface
+ cmd1 = u"sw_interface_add_del_address"
+ args1 = dict(
+ sw_if_index=InterfaceUtil.get_interface_index(
+ nodes[u"DUT1"], if1_key
+ ),
+ is_add=True,
+ del_all=False,
+ prefix=IPUtil.create_prefix_object(
+ if2_ip - 1, 96 if if2_ip.version == 6 else 24
+ )
+ )
+ err_msg = f"Failed to set IP address on interface {if1_key} " \
+ f"on host {nodes[u'DUT1'][u'host']}"
+ papi_exec.add(cmd1, **args1).get_reply(err_msg)
+ cmd4 = u"ip_neighbor_add_del"
+ args4 = dict(
+ is_add=1,
+ neighbor=dict(
+ sw_if_index=Topology.get_interface_sw_index(
+ nodes[u"DUT1"], if1_key
+ ),
+ flags=1,
+ mac_address=str(
+ Topology.get_interface_mac(nodes[u"DUT2"], if2_key)
+ ),
+ ip_address=str(ip_address(if2_ip_addr))
+ )
+ )
+ err_msg = f"Failed to add IP neighbor on interface {if1_key}"
+ papi_exec.add(cmd4, **args4).get_reply(err_msg)
+ # Configure IPsec tunnel interfaces
+ args1 = dict(
+ sw_if_index=loop_sw_if_idx,
+ is_add=True,
+ del_all=False,
+ prefix=None
+ )
+ cmd2 = u"ipsec_tunnel_if_add_del"
+ args2 = dict(
+ is_add=1,
+ local_ip=None,
+ remote_ip=None,
+ local_spi=0,
+ remote_spi=0,
+ crypto_alg=crypto_alg.alg_int_repr,
+ local_crypto_key_len=0,
+ local_crypto_key=None,
+ remote_crypto_key_len=0,
+ remote_crypto_key=None,
+ integ_alg=integ_alg.alg_int_repr if integ_alg else 0,
+ local_integ_key_len=0,
+ local_integ_key=None,
+ remote_integ_key_len=0,
+ remote_integ_key=None,
+ tx_table_id=0
+ )
+ err_msg = f"Failed to add IPsec tunnel interfaces " \
+ f"on host {nodes[u'DUT1'][u'host']}"
+ ipsec_tunnels = list()
+ ckeys = list()
+ ikeys = list()
+ for i in range(n_tunnels):
+ ckeys.append(
+ gen_key(IPsecUtil.get_crypto_alg_key_len(crypto_alg))
+ )
+ if integ_alg:
+ ikeys.append(
+ gen_key(IPsecUtil.get_integ_alg_key_len(integ_alg))
+ )
+ args1[u"prefix"] = IPUtil.create_prefix_object(
+ if1_ip + i * addr_incr, 128 if if1_ip.version == 6 else 32
+ )
+ args2[u"local_spi"] = spi_1 + i
+ args2[u"remote_spi"] = spi_2 + i
+ args2[u"local_ip"] = IPUtil.create_ip_address_object(
+ if1_ip + i * addr_incr
+ )
+ args2[u"remote_ip"] = IPUtil.create_ip_address_object(if2_ip)
+ args2[u"local_crypto_key_len"] = len(ckeys[i])
+ args2[u"local_crypto_key"] = ckeys[i]
+ args2[u"remote_crypto_key_len"] = len(ckeys[i])
+ args2[u"remote_crypto_key"] = ckeys[i]
+ if integ_alg:
+ args2[u"local_integ_key_len"] = len(ikeys[i])
+ args2[u"local_integ_key"] = ikeys[i]
+ args2[u"remote_integ_key_len"] = len(ikeys[i])
+ args2[u"remote_integ_key"] = ikeys[i]
+ history = bool(not 1 < i < n_tunnels - 2)
+ papi_exec.add(cmd1, history=history, **args1).\
+ add(cmd2, history=history, **args2)
+ replies = papi_exec.get_replies(err_msg)
+ for reply in replies:
+ if u"sw_if_index" in reply:
+ ipsec_tunnels.append(reply[u"sw_if_index"])
+ # Configure IP routes
+ cmd1 = u"sw_interface_set_unnumbered"
+ args1 = dict(
+ is_add=True,
+ sw_if_index=InterfaceUtil.get_interface_index(
+ nodes[u"DUT1"], if1_key
+ ),
+ unnumbered_sw_if_index=0
+ )
+ cmd2 = u"sw_interface_set_flags"
+ args2 = dict(
+ sw_if_index=0,
+ flags=InterfaceStatusFlags.IF_STATUS_API_FLAG_ADMIN_UP.value
+ )
+ cmd3 = u"ip_route_add_del"
+ args3 = dict(
+ is_add=1,
+ is_multipath=0,
+ route=None
+ )
+ err_msg = f"Failed to add IP routes " \
+ f"on host {nodes[u'DUT1'][u'host']}"
+ for i in range(n_tunnels):
+ args1[u"unnumbered_sw_if_index"] = ipsec_tunnels[i]
+ args2[u"sw_if_index"] = ipsec_tunnels[i]
+ args3[u"route"] = IPUtil.compose_vpp_route_structure(
+ nodes[u"DUT1"], (raddr_ip2 + i).compressed,
+ prefix_len=128 if raddr_ip2.version == 6 else 32,
+ interface=ipsec_tunnels[i]
+ )
+ history = bool(not 1 < i < n_tunnels - 2)
+ papi_exec.add(cmd1, history=history, **args1).\
+ add(cmd2, history=history, **args2).\
+ add(cmd3, history=history, **args3)
+ papi_exec.get_replies(err_msg)
+
+ with PapiSocketExecutor(nodes[u"DUT2"]) as papi_exec:
+ # Set IP address on VPP node 2 interface
+ cmd1 = u"sw_interface_add_del_address"
+ args1 = dict(
+ sw_if_index=InterfaceUtil.get_interface_index(
+ nodes[u"DUT2"], if2_key
+ ),
+ is_add=True,
+ del_all=False,
+ prefix=IPUtil.create_prefix_object(
+ if2_ip, 96 if if2_ip.version == 6 else 24
+ )
+ )
+ err_msg = f"Failed to set IP address on interface {if2_key} " \
+ f"on host {nodes[u'DUT2'][u'host']}"
+ papi_exec.add(cmd1, **args1).get_reply(err_msg)
+ # Configure IPsec tunnel interfaces
+ cmd2 = u"ipsec_tunnel_if_add_del"
+ args2 = dict(
+ is_add=1,
+ local_ip=IPUtil.create_ip_address_object(if2_ip),
+ remote_ip=None,
+ local_spi=0,
+ remote_spi=0,
+ crypto_alg=crypto_alg.alg_int_repr,
+ local_crypto_key_len=0,
+ local_crypto_key=None,
+ remote_crypto_key_len=0,
+ remote_crypto_key=None,
+ integ_alg=integ_alg.alg_int_repr if integ_alg else 0,
+ local_integ_key_len=0,
+ local_integ_key=None,
+ remote_integ_key_len=0,
+ remote_integ_key=None,
+ tx_table_id=0
+ )
+ err_msg = f"Failed to add IPsec tunnel interfaces " \
+ f"on host {nodes[u'DUT2'][u'host']}"
+ ipsec_tunnels = list()
+ for i in range(n_tunnels):
+ args2[u"local_spi"] = spi_2 + i
+ args2[u"remote_spi"] = spi_1 + i
+ args2[u"local_ip"] = IPUtil.create_ip_address_object(if2_ip)
+ args2[u"remote_ip"] = IPUtil.create_ip_address_object(
+ if1_ip + i * addr_incr)
+ args2[u"local_crypto_key_len"] = len(ckeys[i])
+ args2[u"local_crypto_key"] = ckeys[i]
+ args2[u"remote_crypto_key_len"] = len(ckeys[i])
+ args2[u"remote_crypto_key"] = ckeys[i]
+ if integ_alg:
+ args2[u"local_integ_key_len"] = len(ikeys[i])
+ args2[u"local_integ_key"] = ikeys[i]
+ args2[u"remote_integ_key_len"] = len(ikeys[i])
+ args2[u"remote_integ_key"] = ikeys[i]
+ history = bool(not 1 < i < n_tunnels - 2)
+ papi_exec.add(cmd2, history=history, **args2)
+ replies = papi_exec.get_replies(err_msg)
+ for reply in replies:
+ if u"sw_if_index" in reply:
+ ipsec_tunnels.append(reply[u"sw_if_index"])
+ # Configure IP routes
+ cmd1 = u"ip_route_add_del"
+ route = IPUtil.compose_vpp_route_structure(
+ nodes[u"DUT2"], if1_ip.compressed,
+ prefix_len=32 if if1_ip.version == 6 else 8,
+ interface=if2_key,
+ gateway=(if2_ip - 1).compressed
+ )
+ args1 = dict(
+ is_add=1,
+ is_multipath=0,
+ route=route
+ )
+ papi_exec.add(cmd1, **args1)
+ cmd1 = u"sw_interface_set_unnumbered"
+ args1 = dict(
+ is_add=True,
+ sw_if_index=InterfaceUtil.get_interface_index(
+ nodes[u"DUT2"], if2_key
+ ),
+ unnumbered_sw_if_index=0
+ )
+ cmd2 = u"sw_interface_set_flags"
+ args2 = dict(
+ sw_if_index=0,
+ flags=InterfaceStatusFlags.IF_STATUS_API_FLAG_ADMIN_UP.value
+ )
+ cmd3 = u"ip_route_add_del"
+ args3 = dict(
+ is_add=1,
+ is_multipath=0,
+ route=None
+ )
+ err_msg = f"Failed to add IP routes " \
+ f"on host {nodes[u'DUT2'][u'host']}"
+ for i in range(n_tunnels):
+ args1[u"unnumbered_sw_if_index"] = ipsec_tunnels[i]
+ args2[u"sw_if_index"] = ipsec_tunnels[i]
+ args3[u"route"] = IPUtil.compose_vpp_route_structure(
+ nodes[u"DUT1"], (raddr_ip1 + i).compressed,
+ prefix_len=128 if raddr_ip1.version == 6 else 32,
+ interface=ipsec_tunnels[i]
+ )
+ history = bool(not 1 < i < n_tunnels - 2)
+ papi_exec.add(cmd1, history=history, **args1). \
+ add(cmd2, history=history, **args2). \
+ add(cmd3, history=history, **args3)
+ papi_exec.get_replies(err_msg)
+
+ @staticmethod
+ def vpp_ipsec_add_multiple_tunnels(
+ nodes, interface1, interface2, n_tunnels, crypto_alg, integ_alg,
+ tunnel_ip1, tunnel_ip2, raddr_ip1, raddr_ip2, raddr_range):
+ """Create multiple IPsec tunnels between two VPP nodes.
+
+ :param nodes: VPP nodes to create tunnels.
+ :param interface1: Interface name or sw_if_index on node 1.
+ :param interface2: Interface name or sw_if_index on node 2.
+ :param n_tunnels: Number of tunnels to create.
+ :param crypto_alg: The encryption algorithm name.
+ :param integ_alg: The integrity algorithm name.
+ :param tunnel_ip1: Tunnel node1 IPv4 address.
+ :param tunnel_ip2: Tunnel node2 IPv4 address.
+ :param raddr_ip1: Policy selector remote IPv4 start address for the
+ first tunnel in direction node1->node2.
+ :param raddr_ip2: Policy selector remote IPv4 start address for the
+ first tunnel in direction node2->node1.
+ :param raddr_range: Mask specifying range of Policy selector Remote IPv4
+ addresses. Valid values are from 1 to 32.
+ :type nodes: dict
+ :type interface1: str or int
+ :type interface2: str or int
+ :type n_tunnels: int
+ :type crypto_alg: CryptoAlg
+ :type integ_alg: IntegAlg
+ :type tunnel_ip1: str
+ :type tunnel_ip2: str
+ :type raddr_ip1: string
+ :type raddr_ip2: string
+ :type raddr_range: int
"""
- direction = 'outbound'
- if inbound:
- direction = 'inbound'
-
- act_str = action.value
- if PolicyAction.PROTECT == action and sa_id is not None:
- act_str += 'sa_id {0}'.format(sa_id)
-
- selector = ''
- if laddr_range is not None:
- net = ip_network(unicode(laddr_range), strict=False)
- selector += 'laddr_start {0} laddr_stop {1} '.format(
- net.network_address, net.broadcast_address)
- if raddr_range is not None:
- net = ip_network(unicode(raddr_range), strict=False)
- selector += 'raddr_start {0} raddr_stop {1} '.format(
- net.network_address, net.broadcast_address)
- if proto is not None:
- selector += 'protocol {0} '.format(proto)
- if lport_range is not None:
- selector += 'lport_start {p[0]} lport_stop {p[1]} '.format(
- p=lport_range.split('-'))
- if rport_range is not None:
- selector += 'rport_start {p[0]} rport_stop {p[1]} '.format(
- p=rport_range.split('-'))
-
- out = VatExecutor.cmd_from_template(node,
- "ipsec/ipsec_spd_add_entry.vat",
- spd_id=spd_id, priority=priority,
- action=act_str, direction=direction,
- selector=selector)
- VatJsonUtil.verify_vat_retval(
- out[0],
- err_msg='Add entry to SPD {0} failed on {1}'.format(spd_id,
- node['host']))
+ spd_id = 1
+ p_hi = 100
+ p_lo = 10
+ sa_id_1 = 100000
+ sa_id_2 = 200000
+ spi_1 = 300000
+ spi_2 = 400000
+
+ crypto_key = gen_key(
+ IPsecUtil.get_crypto_alg_key_len(crypto_alg)
+ ).decode()
+ integ_key = gen_key(
+ IPsecUtil.get_integ_alg_key_len(integ_alg)
+ ).decode() if integ_alg else u""
+
+ IPsecUtil.vpp_ipsec_set_ip_route(
+ nodes[u"DUT1"], n_tunnels, tunnel_ip1, raddr_ip2, tunnel_ip2,
+ interface1, raddr_range)
+ IPsecUtil.vpp_ipsec_set_ip_route(
+ nodes[u"DUT2"], n_tunnels, tunnel_ip2, raddr_ip1, tunnel_ip1,
+ interface2, raddr_range)
+
+ IPsecUtil.vpp_ipsec_add_spd(nodes[u"DUT1"], spd_id)
+ IPsecUtil.vpp_ipsec_spd_add_if(nodes[u"DUT1"], spd_id, interface1)
+ IPsecUtil.vpp_ipsec_policy_add(
+ nodes[u"DUT1"], spd_id, p_hi, PolicyAction.BYPASS, inbound=False,
+ proto=50, laddr_range=u"100.0.0.0/8", raddr_range=u"100.0.0.0/8"
+ )
+ IPsecUtil.vpp_ipsec_policy_add(
+ nodes[u"DUT1"], spd_id, p_hi, PolicyAction.BYPASS, inbound=True,
+ proto=50, laddr_range=u"100.0.0.0/8", raddr_range=u"100.0.0.0/8"
+ )
+
+ IPsecUtil.vpp_ipsec_add_spd(nodes[u"DUT2"], spd_id)
+ IPsecUtil.vpp_ipsec_spd_add_if(nodes[u"DUT2"], spd_id, interface2)
+ IPsecUtil.vpp_ipsec_policy_add(
+ nodes[u"DUT2"], spd_id, p_hi, PolicyAction.BYPASS, inbound=False,
+ proto=50, laddr_range=u"100.0.0.0/8", raddr_range=u"100.0.0.0/8"
+ )
+ IPsecUtil.vpp_ipsec_policy_add(
+ nodes[u"DUT2"], spd_id, p_hi, PolicyAction.BYPASS, inbound=True,
+ proto=50, laddr_range=u"100.0.0.0/8", raddr_range=u"100.0.0.0/8"
+ )
+
+ IPsecUtil.vpp_ipsec_add_sad_entries(
+ nodes[u"DUT1"], n_tunnels, sa_id_1, spi_1, crypto_alg, crypto_key,
+ integ_alg, integ_key, tunnel_ip1, tunnel_ip2
+ )
+ IPsecUtil.vpp_ipsec_spd_add_entries(
+ nodes[u"DUT1"], n_tunnels, spd_id, p_lo, False, sa_id_1, raddr_ip2
+ )
+
+ IPsecUtil.vpp_ipsec_add_sad_entries(
+ nodes[u"DUT2"], n_tunnels, sa_id_1, spi_1, crypto_alg, crypto_key,
+ integ_alg, integ_key, tunnel_ip1, tunnel_ip2
+ )
+ IPsecUtil.vpp_ipsec_spd_add_entries(
+ nodes[u"DUT2"], n_tunnels, spd_id, p_lo, True, sa_id_1, raddr_ip2
+ )
+
+ IPsecUtil.vpp_ipsec_add_sad_entries(
+ nodes[u"DUT2"], n_tunnels, sa_id_2, spi_2, crypto_alg, crypto_key,
+ integ_alg, integ_key, tunnel_ip2, tunnel_ip1
+ )
+
+ IPsecUtil.vpp_ipsec_spd_add_entries(
+ nodes[u"DUT2"], n_tunnels, spd_id, p_lo, False, sa_id_2, raddr_ip1
+ )
+
+ IPsecUtil.vpp_ipsec_add_sad_entries(
+ nodes[u"DUT1"], n_tunnels, sa_id_2, spi_2, crypto_alg, crypto_key,
+ integ_alg, integ_key, tunnel_ip2, tunnel_ip1
+ )
+
+ IPsecUtil.vpp_ipsec_spd_add_entries(
+ nodes[u"DUT1"], n_tunnels, spd_id, p_lo, True, sa_id_2, raddr_ip1
+ )
@staticmethod
def vpp_ipsec_show(node):
:param node: Node to run command on.
:type node: dict
"""
- VatExecutor().execute_script("ipsec/ipsec_show.vat", node,
- json_out=False)
+ PapiSocketExecutor.run_cli_cmd(node, u"show ipsec")
Code Review / csit.git / blobdiff