-# 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:
import os
from ipaddress import ip_network, ip_address
-from enum import Enum
+from enum import Enum, IntEnum
+from robot.api import logger
-from resources.libraries.python.VatExecutor import VatExecutor
+from resources.libraries.python.PapiExecutor import PapiExecutor
+from resources.libraries.python.PapiErrors import PapiError, PapiCommandError
from resources.libraries.python.topology import Topology
+from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
from resources.libraries.python.VatJsonUtil import VatJsonUtil
self.key_len = key_len
+class IPsecProto(IntEnum):
+ """IPsec protocol."""
+ ESP = 1
+ AH = 0
+
+
class IPsecUtil(object):
"""IPsec utilities."""
"""
return integ_alg.scapy_name
+ @staticmethod
+ 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.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
+ """
+ # TODO: move composition of api data to separate method
+ api_data = list()
+ api = dict(api_name='ipsec_select_backend')
+ api_args = dict(protocol=protocol)
+ api_args['index'] = index
+ api['api_args'] = api_args
+ api_data.append(api)
+
+ api_reply = None
+ with PapiExecutor(node) as papi_executor:
+ papi_executor.execute_papi(api_data)
+ try:
+ papi_executor.papi_should_have_passed()
+ except AssertionError:
+ raise PapiError('Failed to select IPsec backend on host {host}'.
+ format(host=node['host']))
+ api_reply = papi_executor.get_papi_reply()
+
+ if api_reply is not None:
+ api_r = api_reply[0]['api_reply']['ipsec_select_backend_reply']
+ if api_r['retval'] == 0:
+ logger.trace('IPsec backend successfully selected on host '
+ '{host}'.format(host=node['host']))
+ else:
+ raise PapiError('Failed to select IPsec backend on host {host}'.
+ format(host=node['host']))
+ else:
+ raise PapiError('No reply received for ipsec_select_backend API '
+ 'command on host {host}'.format(host=node['host']))
+
+ @staticmethod
+ def vpp_ipsec_backend_dump(node):
+ """Dump IPsec backends.
+
+ :param node: VPP node to dump IPsec backend on.
+ :type node: dict
+ """
+ # TODO: move composition of api data to separate method
+ api_data = list()
+ api = dict(api_name='ipsec_backend_dump')
+ api_args = dict()
+ api['api_args'] = api_args
+ api_data.append(api)
+
+ api_reply = None
+ with PapiExecutor(node) as papi_executor:
+ papi_executor.execute_papi(api_data)
+ try:
+ papi_executor.papi_should_have_passed()
+ except AssertionError:
+ raise PapiError('Failed to dump IPsec backends on host {host}'.
+ format(host=node['host']))
+ api_reply = papi_executor.get_papi_reply()
+
+ if api_reply is not None:
+ # api_r = api_reply[0]['api_reply']['ipsec_select_backend_reply']
+ # if api_r['retval'] == 0:
+ # logger.trace('IPsec backend successfully selected on host '
+ # '{host}'.format(host=node['host']))
+ # else:
+ # raise PapiError('Failed to select IPsec backend on host {host}'.
+ # format(host=node['host']))
+ logger.trace('IPsec backend dump\n{dump}'.format(dump=api_reply))
+ else:
+ raise PapiError('No reply received for ipsec_select_backend API '
+ 'command on host {host}'.format(host=node['host']))
+
@staticmethod
def vpp_ipsec_add_sad_entry(node, sad_id, spi, crypto_alg, crypto_key,
integ_alg, integ_key, tunnel_src=None,
: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.
+ specified ESP transport mode is used.
:param tunnel_dst: Tunnel header destination IPv4 or IPv6 address. If
- not specified ESP transport mode is used.
+ not specified ESP transport mode is used.
:type node: dict
:type sad_id: int
: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
if tunnel_src is not None and tunnel_dst is not None else ''
out = VatExecutor.cmd_from_template(node,
- "ipsec/ipsec_sad_add_entry.vat",
+ '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,
: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.
+ id incremented by 1.
:param spi: Security Parameter Index of first SAD entry. All subsequent
- SAD entries will have spi incremented by 1.
+ 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.
+ specified ESP transport mode is used.
:param tunnel_dst: Tunnel header destination IPv4 or IPv6 address. If
- not specified ESP transport mode is used.
+ not specified ESP transport mode is used.
:type node: dict
:type n_entries: int
:type sad_id: int
:type tunnel_src: str
:type tunnel_dst: str
"""
- tmp_filename = '/tmp/ipsec_sad_{}_add_del_entry.vat'.format(sad_id)
+ tmp_filename = '/tmp/ipsec_sad_{0}_add_del_entry.script'.format(sad_id)
ckey = crypto_key.encode('hex')
ikey = integ_key.encode('hex')
tunnel = 'tunnel_src {0} tunnel_dst {1}'.format(tunnel_src, tunnel_dst)\
tunnel)
tmp_file.write(buf_str)
vat = VatExecutor()
- vat.scp_and_execute_script(tmp_filename, node, 300)
+ vat.execute_script(tmp_filename, node, timeout=300, json_out=False,
+ copy_on_execute=True)
os.remove(tmp_filename)
@staticmethod
ikey = integ_key.encode('hex')
out = VatExecutor.cmd_from_template(node,
- "ipsec/ipsec_sa_set_key.vat",
+ 'ipsec/ipsec_sa_set_key.vat',
sa_id=sa_id,
ckey=ckey, ikey=ikey)
VatJsonUtil.verify_vat_retval(
:type node: dict
:type spd_id: int
"""
- out = VatExecutor.cmd_from_template(node, "ipsec/ipsec_spd_add.vat",
+ out = VatExecutor.cmd_from_template(node, 'ipsec/ipsec_spd_add.vat',
spd_id=spd_id)
VatJsonUtil.verify_vat_retval(
out[0],
if isinstance(interface, basestring) else interface
out = VatExecutor.cmd_from_template(node,
- "ipsec/ipsec_interface_add_spd.vat",
+ 'ipsec/ipsec_interface_add_spd.vat',
spd_id=spd_id, sw_if_id=sw_if_index)
VatJsonUtil.verify_vat_retval(
out[0],
:param priority: SPD entry priority, higher number = higher priority.
:param action: Policy action.
:param inbound: If True policy is for inbound traffic, otherwise
- outbound.
+ 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 format
- <port_start>-<port_end>.
+
<port_start>-<port_end>.
:param rport_range: Policy selector remote TCP/UDP port range in format
- <port_start>-<port_end>.
+
<port_start>-<port_end>.
:type node: dict
:type spd_id: int
:type priority: int
p=rport_range.split('-'))
out = VatExecutor.cmd_from_template(node,
- "ipsec/ipsec_spd_add_entry.vat",
+ 'ipsec/ipsec_spd_add_entry.vat',
spd_id=spd_id, priority=priority,
action=act_str, direction=direction,
selector=selector)
: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.
+ outbound.
:param sa_id: SAD entry ID for first entry. Each subsequent entry will
- SAD entry ID incremented by 1.
+ 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.
+ 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: Mask specifying range of Policy selector Remote IPv4
- addresses. Valid values are from 1 to 32.
+ addresses. Valid values are from 1 to 32.
:type node: dict
:type n_entries: int
:type spd_id: int
:type raddr_ip: string
:type raddr_range: int
"""
- tmp_filename = '/tmp/ipsec_spd_{}_add_del_entry.vat'.format(sa_id)
+ tmp_filename = '/tmp/ipsec_spd_{0}_add_del_entry.script'.format(sa_id)
+
direction = 'inbound' if inbound else 'outbound'
addr_incr = 1 << (32 - raddr_range)
addr_ip = int(ip_address(unicode(raddr_ip)))
start_str, sa_id+i, r_ip_s, r_ip_e)
tmp_file.write(buf_str)
vat = VatExecutor()
- vat.scp_and_execute_script(tmp_filename, node, 300)
+ vat.execute_script(tmp_filename, node, timeout=300, json_out=False,
+ copy_on_execute=True)
os.remove(tmp_filename)
@staticmethod
:param integ_alg: The integrity algorithm name.
:param integ_key: The integrity key string.
:param raddr_ip1: Policy selector remote IPv4 start address for the
- first tunnel in direction node1->node2.
+ first tunnel in direction node1->node2.
:param raddr_ip2: Policy selector remote IPv4 start address for the
- first tunnel in direction node2->node1.
+ 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.
+ addresses. Valid values are from 1 to 32.
:type node1: dict
:type node2: dict
:type if1_ip_addr: str
:type raddr_ip2: string
:type raddr_range: int
"""
-
spi_1 = 10000
spi_2 = 20000
ckey = crypto_key.encode('hex')
ikey = integ_key.encode('hex')
+ vat = VatExecutor()
+ with open(tmp_fn1, 'w') as tmp_f1, open(tmp_fn2, 'w') as tmp_f2:
+ for i in range(0, n_tunnels):
+ integ = ''
+ # if crypto_alg.alg_name != 'aes-gcm-128':
+ if not crypto_alg.alg_name.startswith('aes-gcm-'):
+ integ = 'integ_alg {integ_alg} '\
+ 'local_integ_key {local_integ_key} '\
+ 'remote_integ_key {remote_integ_key} '\
+ .format(integ_alg=integ_alg.alg_name,
+ local_integ_key=ikey,
+ remote_integ_key=ikey)
+ dut1_tunnel = 'ipsec_tunnel_if_add_del '\
+ 'local_spi {local_spi} '\
+ 'remote_spi {remote_spi} '\
+ 'crypto_alg {crypto_alg} '\
+ 'local_crypto_key {local_crypto_key} '\
+ 'remote_crypto_key {remote_crypto_key} '\
+ '{integ} '\
+ 'local_ip {local_ip} '\
+ 'remote_ip {remote_ip}\n'\
+ .format(local_spi=spi_1+i,
+ remote_spi=spi_2+i,
+ crypto_alg=crypto_alg.alg_name,
+ local_crypto_key=ckey,
+ remote_crypto_key=ckey,
+ integ=integ,
+ local_ip=if1_ip_addr,
+ remote_ip=if2_ip_addr)
+ dut2_tunnel = 'ipsec_tunnel_if_add_del '\
+ 'local_spi {local_spi} '\
+ 'remote_spi {remote_spi} '\
+ 'crypto_alg {crypto_alg} '\
+ 'local_crypto_key {local_crypto_key} '\
+ 'remote_crypto_key {remote_crypto_key} '\
+ '{integ} '\
+ 'local_ip {local_ip} '\
+ 'remote_ip {remote_ip}\n'\
+ .format(local_spi=spi_2+i,
+ remote_spi=spi_1+i,
+ crypto_alg=crypto_alg.alg_name,
+ local_crypto_key=ckey,
+ remote_crypto_key=ckey,
+ integ=integ,
+ local_ip=if2_ip_addr,
+ remote_ip=if1_ip_addr)
+ tmp_f1.write(dut1_tunnel)
+ tmp_f2.write(dut2_tunnel)
+ vat.execute_script(tmp_fn1, node1, timeout=300, json_out=False,
+ copy_on_execute=True)
+ vat.execute_script(tmp_fn2, node2, timeout=300, json_out=False,
+ copy_on_execute=True)
+ os.remove(tmp_fn1)
+ os.remove(tmp_fn2)
+
with open(tmp_fn1, 'w') as tmp_f1, open(tmp_fn2, 'w') as tmp_f2:
for i in range(0, n_tunnels):
- if_s = 'ipsec{}'.format(i)
- dut1_tunnel_s = 'create ipsec tunnel local-ip {0} local-spi ' \
- '{1} remote-ip {2} remote-spi {3}\n'.format(
- if1_ip_addr, spi_1+i, if2_ip_addr, spi_2+i)
- tmp_f1.write(dut1_tunnel_s)
- dut2_tunnel_s = 'create ipsec tunnel local-ip {0} local-spi ' \
- '{1} remote-ip {2} remote-spi {3}\n'.format(
- if2_ip_addr, spi_2+i, if1_ip_addr, spi_1+i)
- tmp_f2.write(dut2_tunnel_s)
- loc_c_key = 'set interface ipsec key {0} local crypto {1} ' \
- '{2}\n'.format(if_s, crypto_alg.alg_name, ckey)
- tmp_f1.write(loc_c_key)
- tmp_f2.write(loc_c_key)
- rem_c_key = 'set interface ipsec key {0} remote crypto {1} ' \
- '{2}\n'.format(if_s, crypto_alg.alg_name, ckey)
- tmp_f1.write(rem_c_key)
- tmp_f2.write(rem_c_key)
- if crypto_alg.alg_name != 'aes-gcm-128':
- loc_i_key = 'set interface ipsec key {0} local integ {1} ' \
- '{2}\n'.format(if_s, integ_alg.alg_name, ikey)
- tmp_f1.write(loc_i_key)
- tmp_f2.write(loc_i_key)
- rem_i_key = 'set interface ipsec key {0} remote integ {1}' \
- ' {2}\n'.format(if_s, integ_alg.alg_name, ikey)
- tmp_f1.write(rem_i_key)
- tmp_f2.write(rem_i_key)
- raddr_ip1_s = ip_address(raddr_ip1_i + addr_incr*i)
- raddr_ip2_s = ip_address(raddr_ip2_i + addr_incr*i)
- dut1_rte_s = 'ip route add {0}/{1} via {2} {3}\n'.format(
- raddr_ip2_s, raddr_range, if2_ip_addr, if_s)
- tmp_f1.write(dut1_rte_s)
- dut2_rte_s = 'ip route add {0}/{1} via {2} {3}\n'.format(
- raddr_ip1_s, raddr_range, if1_ip_addr, if_s)
- tmp_f2.write(dut2_rte_s)
+ raddr_ip1 = ip_address(raddr_ip1_i + addr_incr*i)
+ raddr_ip2 = ip_address(raddr_ip2_i + addr_incr*i)
dut1_if = Topology.get_interface_name(node1, if1_key)
- dut1_unnum_s = 'set interface unnumbered {0} use {1}\n'.format(
- if_s, dut1_if)
- tmp_f1.write(dut1_unnum_s)
+ dut1 = 'exec ip route add {raddr}/{mask} via {addr} ipsec{i}\n'\
+ 'exec set interface unnumbered ipsec{i} use {uifc}\n'\
+ 'exec set interface state ipsec{i} up\n'\
+ .format(raddr=raddr_ip2, mask=raddr_range,
+ addr=if2_ip_addr, i=i, uifc=dut1_if)
dut2_if = Topology.get_interface_name(node2, if2_key)
- dut2_unnum_s = 'set interface unnumbered {0} use {1}\n'.format(
- if_s, dut2_if)
- tmp_f2.write(dut2_unnum_s)
- up_s = 'set int state {0} up\n'.format(if_s)
- tmp_f1.write(up_s)
- tmp_f2.write(up_s)
-
- vat = VatExecutor()
- vat.scp_and_execute_cli_script(tmp_fn1, node1, 300)
- vat.scp_and_execute_cli_script(tmp_fn2, node2, 300)
+ dut2 = 'exec ip route add {raddr}/{mask} via {addr} ipsec{i}\n'\
+ 'exec set interface unnumbered ipsec{i} use {uifc}\n'\
+ 'exec set interface state ipsec{i} up\n'\
+ .format(raddr=raddr_ip1, mask=raddr_range,
+ addr=if1_ip_addr, i=i, uifc=dut2_if)
+ tmp_f1.write(dut1)
+ tmp_f2.write(dut2)
+
+ vat.execute_script(tmp_fn1, node1, timeout=300, json_out=False,
+ copy_on_execute=True)
+ vat.execute_script(tmp_fn2, node2, timeout=300, json_out=False,
+ copy_on_execute=True)
os.remove(tmp_fn1)
os.remove(tmp_fn2)
: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.
+ first tunnel in direction node1->node2.
:param raddr_ip2: Policy selector remote IPv4 start address for the
- first tunnel in direction node2->node1.
+ 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.
+ addresses. Valid values are from 1 to 32.
:type node1: dict
:type node2: dict
:type interface1: str or int
:param node: Node to run command on.
:type node: dict
"""
- VatExecutor().execute_script("ipsec/ipsec_show.vat", node,
+ VatExecutor().execute_script('ipsec/ipsec_show.vat', node,
json_out=False)
Code Review / csit.git / blobdiff