-# Copyright (c) 2018 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.topology import Topology
+from resources.libraries.python.VatExecutor import VatExecutor
from resources.libraries.python.VatJsonUtil import VatJsonUtil
self.key_len = key_len
+class IPsecProto(IntEnum):
+ """IPsec protocol."""
+ ESP = 1
+ SEC_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.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 = 'ipsec_select_backend'
+ cmd_reply = 'ipsec_select_backend_reply'
+ err_msg = 'Failed to select IPsec backend on host {host}'.format(
+ host=node['host'])
+ args = dict(protocol=protocol, index=index)
+ with PapiExecutor(node) as papi_exec:
+ papi_resp = papi_exec.add(cmd, **args).execute_should_pass(err_msg)
+ data = papi_resp.reply[0]['api_reply'][cmd_reply]
+ if data['retval'] != 0:
+ raise RuntimeError('Failed to select IPsec backend 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
+ """
+
+ err_msg = 'Failed to dump IPsec backends on host {host}'.format(
+ host=node['host'])
+ with PapiExecutor(node) as papi_exec:
+ papi_resp = papi_exec.add('ipsec_backend_dump').execute_should_pass(
+ err_msg, process_reply=False)
+ # After API change there is returned VPP internal enum object
+ # representing VPP IPSEC protocol instead of integer representation
+ # so JSON fails to decode it - we need to check if it is Python API
+ # bug or we need to adapt vpp_papi_provider to correctly encode
+ # such object into JSON
+ # logger.trace('IPsec backend dump\n{dump}'.
+ # format(dump=papi_resp.reply))
+ logger.trace('IPsec backend dump\n{dump}'.format(dump=papi_resp.stdout))
+
@staticmethod
def vpp_ipsec_add_sad_entry(node, sad_id, spi, crypto_alg, crypto_key,
integ_alg, integ_key, tunnel_src=None,
: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 = 'tunnel_src {0} tunnel_dst {1}'.format(tunnel_src, tunnel_dst)\
+ tunnel = 'tunnel-src {0} tunnel-dst {1}'.format(tunnel_src, tunnel_dst)\
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,
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 = 'tunnel-src {0} tunnel-dst {1}'.format(tunnel_src, tunnel_dst)\
if tunnel_src is not None and tunnel_dst is not None else ''
- integ = 'integ_alg {0} integ_key {1}'.format(integ_alg.alg_name, ikey)\
+ integ = 'integ-alg {0} integ-key {1}'.format(integ_alg.alg_name, ikey)\
if crypto_alg.alg_name != 'aes-gcm-128' else ''
with open(tmp_filename, 'w') as tmp_file:
for i in range(0, n_entries):
- buf_str = 'ipsec_sad_add_del_entry esp sad_id {0} spi {1} ' \
- 'crypto_alg {2} crypto_key {3} {4} {5}\n'.format(
+ buf_str = 'exec ipsec sa add {0} esp spi {1} ' \
+ 'crypto-alg {2} crypto-key {3} {4} {5}\n'.format(
sad_id+i, spi+i, crypto_alg.alg_name, ckey, integ,
tunnel)
tmp_file.write(buf_str)
ckey = crypto_key.encode('hex')
ikey = integ_key.encode('hex')
- out = VatExecutor.cmd_from_template(node,
- "ipsec/ipsec_sa_set_key.vat",
- sa_id=sa_id,
- ckey=ckey, ikey=ikey)
+ out = VatExecutor.cmd_from_template(
+ node, 'ipsec/ipsec_sa_set_key.vat', json_param=False, sa_id=sa_id,
+ ckey=ckey, ikey=ikey)
VatJsonUtil.verify_vat_retval(
out[0],
err_msg='Update SA key failed on {0}'.format(node['host']))
: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],
interface, spd_id, node['host']))
@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.
<port_start>-<port_end>.
: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
"""
direction = 'inbound' if inbound else 'outbound'
+ if laddr_range is None and is_ipv6:
+ laddr_range = '::/0'
+
+ if raddr_range is None and is_ipv6:
+ raddr_range = '::/0'
+
act_str = action.value
if PolicyAction.PROTECT == action and sa_id is not None:
- act_str += 'sa_id {0}'.format(sa_id)
+ act_str += ' sa {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(
+ selector += 'local-ip-range {0} - {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(
+ selector += 'remote-ip-range {0} - {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('-'))
+ selector += 'local-port-range {0} '.format(lport_range)
if rport_range is not None:
- selector += 'rport_start {p[0]} rport_stop {p[1]} '.format(
- p=rport_range.split('-'))
+ selector += 'remote-port-range {0} '.format(rport_range)
- 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)
+ out = VatExecutor.cmd_from_template(
+ node, 'ipsec/ipsec_policy_add.vat', json_param=False, 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']))
+ err_msg='Add IPsec policy ID {0} failed on {1}'.format(
+ spd_id, node['host']))
@staticmethod
def vpp_ipsec_spd_add_entries(node, n_entries, spd_id, priority, inbound,
direction = 'inbound' if inbound else 'outbound'
addr_incr = 1 << (32 - raddr_range)
addr_ip = int(ip_address(unicode(raddr_ip)))
- start_str = 'ipsec_spd_add_del_entry spd_id {0} priority {1} {2} ' \
- 'action protect sa_id'.format(spd_id, priority, direction)
+ start_str = 'exec ipsec policy add spd {0} priority {1} {2} ' \
+ 'action protect sa'.format(spd_id, priority, direction)
with open(tmp_filename, 'w') as tmp_file:
for i in range(0, n_entries):
r_ip_s = ip_address(addr_ip + addr_incr * i)
r_ip_e = ip_address(addr_ip + addr_incr * (i+1) - 1)
- buf_str = '{0} {1} raddr_start {2} raddr_stop {3}\n'.format(
+ buf_str = '{0} {1} remote-ip-range {2} - {3}\n'.format(
start_str, sa_id+i, r_ip_s, r_ip_e)
tmp_file.write(buf_str)
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} '\
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 = 'ip_add_del_route {raddr}/{mask} via {addr} ipsec{i}\n'\
+ dut1 = 'exec ip route add {raddr}/{mask} via {addr} ipsec{i}\n'\
'exec set interface unnumbered ipsec{i} use {uifc}\n'\
- 'sw_interface_set_flags ipsec{i} admin-up\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 = 'ip_add_del_route {raddr}/{mask} via {addr} ipsec{i}\n'\
+ dut2 = 'exec ip route add {raddr}/{mask} via {addr} ipsec{i}\n'\
'exec set interface unnumbered ipsec{i} use {uifc}\n'\
- 'sw_interface_set_flags ipsec{i} admin-up\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)
IPsecUtil.vpp_ipsec_add_spd(node1, spd_id)
IPsecUtil.vpp_ipsec_spd_add_if(node1, spd_id, interface1)
- IPsecUtil.vpp_ipsec_spd_add_entry(node1, spd_id, p_hi,
- PolicyAction.BYPASS, inbound=False,
- proto=proto)
- IPsecUtil.vpp_ipsec_spd_add_entry(node1, spd_id, p_hi,
- PolicyAction.BYPASS, inbound=True,
- proto=proto)
+ IPsecUtil.vpp_ipsec_policy_add(node1, spd_id, p_hi, PolicyAction.BYPASS,
+ inbound=False, proto=proto)
+ IPsecUtil.vpp_ipsec_policy_add(node1, spd_id, p_hi, PolicyAction.BYPASS,
+ inbound=True, proto=proto)
IPsecUtil.vpp_ipsec_add_spd(node2, spd_id)
IPsecUtil.vpp_ipsec_spd_add_if(node2, spd_id, interface2)
- IPsecUtil.vpp_ipsec_spd_add_entry(node2, spd_id, p_hi,
- PolicyAction.BYPASS, inbound=False,
- proto=proto)
- IPsecUtil.vpp_ipsec_spd_add_entry(node2, spd_id, p_hi,
- PolicyAction.BYPASS, inbound=True,
- proto=proto)
+ IPsecUtil.vpp_ipsec_policy_add(node2, spd_id, p_hi, PolicyAction.BYPASS,
+ inbound=False, proto=proto)
+ IPsecUtil.vpp_ipsec_policy_add(node2, spd_id, p_hi, PolicyAction.BYPASS,
+ inbound=True, proto=proto)
IPsecUtil.vpp_ipsec_add_sad_entries(node1, n_tunnels, sa_id_1, spi_1,
crypto_alg, crypto_key, integ_alg,
: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