X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FIPsecUtil.py;h=c4fdefb1809a0bf6fe8b8d01a8306ebf3bb682c4;hp=fc3f8874aecbd8d15d7c0cc21f176a269bade889;hb=acac11dbf7c5011945b9d5fded1a02aa63b5f964;hpb=3e75fd82a125894db2c56eaa6c3f4798e7dea076 diff --git a/resources/libraries/python/IPsecUtil.py b/resources/libraries/python/IPsecUtil.py index fc3f8874ae..c4fdefb180 100644 --- a/resources/libraries/python/IPsecUtil.py +++ b/resources/libraries/python/IPsecUtil.py @@ -1,4 +1,4 @@ -# 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: @@ -13,16 +13,29 @@ """IPsec utilities library.""" -from ipaddress import ip_network +import os +from random import choice +from string import letters +from ipaddress import ip_network, ip_address -from enum import Enum +from enum import Enum, IntEnum -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 -# pylint: disable=too-few-public-methods +def gen_key(length): + """Generate random string as a key. + + :param length: Length of generated payload. + :type length: int + :returns: The generated payload. + :rtype: str + """ + return ''.join(choice(letters) for _ in range(length)).encode('hex') + class PolicyAction(Enum): """Policy actions.""" BYPASS = 'bypass' @@ -36,8 +49,9 @@ class PolicyAction(Enum): 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_GCM_128 = ('aes-gcm-128', 'AES-GCM', 16) + AES_GCM_256 = ('aes-gcm-256', 'AES-GCM', 32) def __init__(self, alg_name, scapy_name, key_len): self.alg_name = alg_name @@ -47,10 +61,10 @@ class CryptoAlg(Enum): 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) + AES_GCM_128 = ('aes-gcm-128', 'AES-GCM', 16) + AES_GCM_256 = ('aes-gcm-256', 'AES-GCM', 32) def __init__(self, alg_name, scapy_name, key_len): self.alg_name = alg_name @@ -58,17 +72,20 @@ class IntegAlg(Enum): self.key_len = key_len +class IPsecProto(IntEnum): + """IPsec protocol.""" + ESP = 1 + SEC_AH = 0 + + class IPsecUtil(object): """IPsec utilities.""" - # pylint: disable=too-many-arguments - # pylint: disable=too-many-locals - @staticmethod def policy_action_bypass(): """Return policy action bypass. - :return: PolicyAction enum BYPASS object. + :returns: PolicyAction enum BYPASS object. :rtype: PolicyAction """ return PolicyAction.BYPASS @@ -77,7 +94,7 @@ class IPsecUtil(object): def policy_action_discard(): """Return policy action discard. - :return: PolicyAction enum DISCARD object. + :returns: PolicyAction enum DISCARD object. :rtype: PolicyAction """ return PolicyAction.DISCARD @@ -86,7 +103,7 @@ class IPsecUtil(object): def policy_action_protect(): """Return policy action protect. - :return: PolicyAction enum PROTECT object. + :returns: PolicyAction enum PROTECT object. :rtype: PolicyAction """ return PolicyAction.PROTECT @@ -95,7 +112,7 @@ class IPsecUtil(object): 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 @@ -104,7 +121,7 @@ class IPsecUtil(object): def crypto_alg_aes_cbc_192(): """Return encryption algorithm aes-cbc-192. - :return: CryptoAlg enum AES_CBC_192 objec. + :returns: CryptoAlg enum AES_CBC_192 objec. :rtype: CryptoAlg """ return CryptoAlg.AES_CBC_192 @@ -113,18 +130,36 @@ class IPsecUtil(object): def crypto_alg_aes_cbc_256(): """Return encryption algorithm aes-cbc-256. - :return: CryptoAlg enum AES_CBC_256 object. + :returns: CryptoAlg enum AES_CBC_256 object. :rtype: CryptoAlg """ return CryptoAlg.AES_CBC_256 + @staticmethod + def crypto_alg_aes_gcm_128(): + """Return encryption algorithm aes-gcm-128. + + :returns: CryptoAlg enum AES_GCM_128 object. + :rtype: CryptoAlg + """ + 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): """Return encryption algorithm key length. :param crypto_alg: Encryption algorithm. :type crypto_alg: CryptoAlg - :return: Key length. + :returns: Key length. :rtype: int """ return crypto_alg.key_len @@ -135,7 +170,7 @@ class IPsecUtil(object): :param crypto_alg: Encryption algorithm. :type crypto_alg: CryptoAlg - :return: Algorithm scapy name. + :returns: Algorithm scapy name. :rtype: str """ return crypto_alg.scapy_name @@ -144,7 +179,7 @@ class IPsecUtil(object): def integ_alg_sha1_96(): """Return integrity algorithm SHA1-96. - :return: IntegAlg enum SHA1_96 object. + :returns: IntegAlg enum SHA1_96 object. :rtype: IntegAlg """ return IntegAlg.SHA1_96 @@ -153,7 +188,7 @@ class IPsecUtil(object): 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 @@ -162,7 +197,7 @@ class IPsecUtil(object): def integ_alg_sha_384_192(): """Return integrity algorithm SHA-384-192. - :return: IntegAlg enum SHA_384_192 object. + :returns: IntegAlg enum SHA_384_192 object. :rtype: IntegAlg """ return IntegAlg.SHA_384_192 @@ -171,18 +206,36 @@ class IPsecUtil(object): 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 + @staticmethod + def integ_alg_aes_gcm_128(): + """Return integrity algorithm AES-GCM-128. + + :returns: IntegAlg enum AES_GCM_128 object. + :rtype: IntegAlg + """ + return IntegAlg.AES_GCM_128 + + @staticmethod + def integ_alg_aes_gcm_256(): + """Return integrity algorithm AES-GCM-256. + + :returns: IntegAlg enum AES_GCM_256 object. + :rtype: IntegAlg + """ + return IntegAlg.AES_GCM_256 + @staticmethod def get_integ_alg_key_len(integ_alg): """Return integrity algorithm key length. :param integ_alg: Integrity algorithm. :type integ_alg: IntegAlg - :return: Key length. + :returns: Key length. :rtype: int """ return integ_alg.key_len @@ -193,11 +246,69 @@ class IPsecUtil(object): :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 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_exec.add('ipsec_backend_dump').execute_should_pass( + err_msg, process_reply=False) + @staticmethod def vpp_ipsec_add_sad_entry(node, sad_id, spi, crypto_alg, crypto_key, integ_alg, integ_key, tunnel_src=None, @@ -220,19 +331,18 @@ class IPsecUtil(object): :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) + 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, @@ -241,6 +351,137 @@ class IPsecUtil(object): out[0], err_msg='Add SAD entry failed on {0}'.format(node['host'])) + @staticmethod + def vpp_ipsec_add_sad_entries(node, n_entries, sad_id, spi, crypto_alg, + crypto_key, integ_alg, integ_key, + 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 + """ + tmp_filename = '/tmp/ipsec_sad_{0}_add_del_entry.script'.format(sad_id) + + addr_incr = 1 << (32 - 24) + + with open(tmp_filename, 'w') as tmp_file: + for i in range(0, n_entries): + integ = '' + if not crypto_alg.alg_name.startswith('aes-gcm-'): + integ = ( + 'integ-alg {integ_alg} integ-key {integ_key}'. + format( + integ_alg=integ_alg.alg_name, + integ_key=integ_key)) + tunnel = ( + 'tunnel-src {laddr} tunnel-dst {raddr}'. + format( + laddr=ip_address(unicode(tunnel_src)) + i * addr_incr, + raddr=ip_address(unicode(tunnel_dst)) + i * addr_incr) + if tunnel_src and tunnel_dst is not None else '') + conf = ( + 'exec ipsec sa add {sad_id} esp spi {spi} ' + 'crypto-alg {crypto_alg} crypto-key {crypto_key} ' + '{integ} {tunnel}\n'. + format( + sad_id=sad_id + i, + spi=spi + i, + crypto_alg=crypto_alg.alg_name, + crypto_key=crypto_key, + integ=integ, + tunnel=tunnel)) + 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) + + @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 IPv4 + addresses. Valid values are from 1 to 32. + :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 + """ + tmp_filename = '/tmp/ipsec_set_ip.script' + + addr_incr = 1 << (32 - raddr_range) + + with open(tmp_filename, 'w') as tmp_file: + for i in range(0, n_tunnels): + conf = ( + 'exec set interface ip address {interface} {laddr}/24\n' + 'exec ip route add {taddr}/32 via {raddr} {interface}\n'. + format( + interface=Topology.get_interface_name(node, interface), + laddr=ip_address(unicode(tunnel_src)) + i * addr_incr, + raddr=ip_address(unicode(tunnel_dst)) + i * addr_incr, + taddr=ip_address(unicode(traffic_addr)) + i)) + 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) + + @staticmethod + def vpp_ipsec_sa_set_key(node, sa_id, crypto_key, integ_key): + """Update Security Association (SA) keys. + + :param node: VPP node to update SA keys. + :param sa_id: SAD entry ID. + :param crypto_key: The encryption key string. + :param integ_key: The integrity key string. + :type node: dict + :type sa_id: int + :type crypto_key: str + :type integ_key: str + """ + ckey = crypto_key.encode('hex') + ikey = integ_key.encode('hex') + + 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'])) + @staticmethod def vpp_ipsec_add_spd(node, spd_id): """Create Security Policy Database on the VPP node. @@ -250,7 +491,7 @@ class IPsecUtil(object): :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], @@ -258,7 +499,7 @@ class IPsecUtil(object): @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. @@ -267,12 +508,11 @@ class IPsecUtil(object): :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 + sw_if_index = Topology.get_interface_sw_index(node, interface)\ + 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], @@ -280,9 +520,10 @@ class IPsecUtil(object): 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. @@ -293,16 +534,18 @@ class IPsecUtil(object): 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 -. - :param rport_range: Policy selector remote TCP/UDP port range in foramt + :param rport_range: Policy selector remote TCP/UDP port range in format -. + :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 @@ -314,42 +557,329 @@ class IPsecUtil(object): :type proto: int :type lport_range: string :type rport_range: string + :type is_ipv6: bool """ - direction = 'outbound' - if inbound: - direction = 'inbound' + 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, + sa_id, raddr_ip): + """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. + :type node: dict + :type n_entries: int + :type spd_id: int + :type priority: int + :type inbound: bool + :type sa_id: int + :type raddr_ip: string + """ + tmp_filename = '/tmp/ipsec_spd_{0}_add_del_entry.script'.format(sa_id) + + with open(tmp_filename, 'w') as tmp_file: + for i in range(0, n_entries): + raddr_s = ip_address(unicode(raddr_ip)) + i + raddr_e = ip_address(unicode(raddr_ip)) + (i + 1) - 1 + tunnel = ( + 'exec ipsec policy add spd {spd_id} priority {priority} ' + '{direction} action protect sa {sa_id} ' + 'remote-ip-range {raddr_s} - {raddr_e}\n'. + format( + spd_id=spd_id, + priority=priority, + direction='inbound' if inbound else 'outbound', + sa_id=sa_id+i, + raddr_s=raddr_s, + raddr_e=raddr_e)) + tmp_file.write(tunnel) + vat = VatExecutor() + vat.execute_script(tmp_filename, node, timeout=300, json_out=False, + copy_on_execute=True) + os.remove(tmp_filename) + + @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 IP4 address. + :param if2_ip_addr: VPP node 2 interface IP4 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 tunnell interfaces to create. + :param crypto_alg: The encryption algorithm name. + :param integ_alg: The integrity algorithm name. + :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 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 + """ + spi_1 = 100000 + spi_2 = 200000 + addr_incr = 1 << (32 - raddr_range) + + tmp_fn1 = '/tmp/ipsec_create_tunnel_dut1.config' + tmp_fn2 = '/tmp/ipsec_create_tunnel_dut2.config' + + vat = VatExecutor() + + with open(tmp_fn1, 'w') as tmp_f1, open(tmp_fn2, 'w') as tmp_f2: + for i in range(0, n_tunnels): + ckey = gen_key(IPsecUtil.get_crypto_alg_key_len(crypto_alg)) + ikey = gen_key(IPsecUtil.get_integ_alg_key_len(integ_alg)) + integ = '' + 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)) + tmp_f1.write( + 'exec set interface ip address {uifc} {laddr}/24\n' + '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 {laddr} ' + 'remote_ip {raddr}\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, + laddr=ip_address(unicode(if1_ip_addr)) + i * addr_incr, + raddr=ip_address(unicode(if2_ip_addr)) + i * addr_incr, + uifc=Topology.get_interface_name(nodes['DUT1'], + if1_key))) + tmp_f2.write( + 'exec set interface ip address {uifc} {laddr}/24\n' + '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 {laddr} ' + 'remote_ip {raddr}\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, + laddr=ip_address(unicode(if2_ip_addr)) + i * addr_incr, + raddr=ip_address(unicode(if1_ip_addr)) + i * addr_incr, + uifc=Topology.get_interface_name(nodes['DUT2'], + if2_key))) + vat.execute_script(tmp_fn1, nodes['DUT1'], timeout=300, json_out=False, + copy_on_execute=True) + vat.execute_script(tmp_fn2, nodes['DUT2'], 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): + tmp_f1.write( + 'exec set interface unnumbered ipsec{i} use {uifc}\n' + 'exec set interface state ipsec{i} up\n' + 'exec ip route add {taddr}/32 via {raddr} ipsec{i}\n' + .format( + taddr=ip_address(unicode(raddr_ip2)) + i, + raddr=ip_address(unicode(if2_ip_addr)) + i * addr_incr, + i=i, + uifc=Topology.get_interface_name(nodes['DUT1'], + if1_key))) + tmp_f2.write( + 'exec set interface unnumbered ipsec{i} use {uifc}\n' + 'exec set interface state ipsec{i} up\n' + 'exec ip route add {taddr}/32 via {raddr} ipsec{i}\n' + .format( + taddr=ip_address(unicode(raddr_ip1)) + i, + raddr=ip_address(unicode(if1_ip_addr)) + i * addr_incr, + i=i, + uifc=Topology.get_interface_name(nodes['DUT2'], + if2_key))) + vat.execute_script(tmp_fn1, nodes['DUT1'], timeout=300, json_out=False, + copy_on_execute=True) + vat.execute_script(tmp_fn2, nodes['DUT2'], timeout=300, json_out=False, + copy_on_execute=True) + os.remove(tmp_fn1) + os.remove(tmp_fn2) + + @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: str + :type tunnel_ip1: str + :type tunnel_ip2: str + :type raddr_ip1: string + :type raddr_ip2: string + :type raddr_range: int + """ + 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)) + integ_key = gen_key(IPsecUtil.get_integ_alg_key_len(integ_alg)) + + IPsecUtil.vpp_ipsec_set_ip_route( + nodes['DUT1'], n_tunnels, tunnel_ip1, raddr_ip2, tunnel_ip2, + interface1, raddr_range) + IPsecUtil.vpp_ipsec_set_ip_route( + nodes['DUT2'], n_tunnels, tunnel_ip2, raddr_ip1, tunnel_ip1, + interface2, raddr_range) + + IPsecUtil.vpp_ipsec_add_spd( + nodes['DUT1'], spd_id) + IPsecUtil.vpp_ipsec_spd_add_if( + nodes['DUT1'], spd_id, interface1) + IPsecUtil.vpp_ipsec_policy_add( + nodes['DUT1'], spd_id, p_hi, PolicyAction.BYPASS, inbound=False, + proto=50) + IPsecUtil.vpp_ipsec_policy_add( + nodes['DUT1'], spd_id, p_hi, PolicyAction.BYPASS, inbound=True, + proto=50) + + IPsecUtil.vpp_ipsec_add_spd( + nodes['DUT2'], spd_id) + IPsecUtil.vpp_ipsec_spd_add_if( + nodes['DUT2'], spd_id, interface2) + IPsecUtil.vpp_ipsec_policy_add( + nodes['DUT2'], spd_id, p_hi, PolicyAction.BYPASS, inbound=False, + proto=50) + IPsecUtil.vpp_ipsec_policy_add( + nodes['DUT2'], spd_id, p_hi, PolicyAction.BYPASS, inbound=True, + proto=50) + + IPsecUtil.vpp_ipsec_add_sad_entries( + nodes['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['DUT1'], n_tunnels, spd_id, p_lo, False, sa_id_1, raddr_ip2) + + IPsecUtil.vpp_ipsec_add_sad_entries( + nodes['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['DUT2'], n_tunnels, spd_id, p_lo, True, sa_id_1, raddr_ip2) + + IPsecUtil.vpp_ipsec_add_sad_entries( + nodes['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['DUT2'], n_tunnels, spd_id, p_lo, False, sa_id_2, raddr_ip1) + + IPsecUtil.vpp_ipsec_add_sad_entries( + nodes['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['DUT1'], n_tunnels, spd_id, p_lo, True, sa_id_2, raddr_ip1) @staticmethod def vpp_ipsec_show(node): @@ -358,5 +888,5 @@ class IPsecUtil(object): :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)