1 # Copyright (c) 2024 Cisco and/or its affiliates.
2 # Copyright (c) 2024 PANTHEON.tech s.r.o.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at:
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 """IPsec utilities library."""
17 from enum import Enum, IntEnum
19 from ipaddress import ip_network, ip_address
20 from random import choice
21 from string import ascii_letters
23 from robot.libraries.BuiltIn import BuiltIn
25 from resources.libraries.python.Constants import Constants
26 from resources.libraries.python.IncrementUtil import ObjIncrement
27 from resources.libraries.python.InterfaceUtil import (
31 from resources.libraries.python.IPAddress import IPAddress
32 from resources.libraries.python.IPUtil import (
38 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
39 from resources.libraries.python.ssh import scp_node
40 from resources.libraries.python.topology import Topology, NodeType
41 from resources.libraries.python.VPPUtil import VPPUtil
42 from resources.libraries.python.FlowUtil import FlowUtil
45 IPSEC_UDP_PORT_DEFAULT = 4500
46 IPSEC_REPLAY_WINDOW_DEFAULT = 64
50 """Generate random string as a key.
52 :param length: Length of generated payload.
54 :returns: The generated payload.
57 return "".join(choice(ascii_letters) for _ in range(length)).encode(
62 class PolicyAction(Enum):
65 BYPASS = ("bypass", 0)
66 DISCARD = ("discard", 1)
67 PROTECT = ("protect", 3)
69 def __init__(self, policy_name, policy_int_repr):
70 self.policy_name = policy_name
71 self.policy_int_repr = policy_int_repr
74 return self.policy_name
77 return self.policy_int_repr
80 class CryptoAlg(Enum):
81 """Encryption algorithms."""
83 AES_CBC_128 = ("aes-cbc-128", 1, "AES-CBC", 16)
84 AES_CBC_256 = ("aes-cbc-256", 3, "AES-CBC", 32)
85 AES_GCM_128 = ("aes-gcm-128", 7, "AES-GCM", 16)
86 AES_GCM_256 = ("aes-gcm-256", 9, "AES-GCM", 32)
88 def __init__(self, alg_name, alg_int_repr, scapy_name, key_len):
89 self.alg_name = alg_name
90 self.alg_int_repr = alg_int_repr
91 self.scapy_name = scapy_name
92 self.key_len = key_len
96 """Integrity algorithm."""
98 SHA_256_128 = ("sha-256-128", 4, "SHA2-256-128", 32)
99 SHA_512_256 = ("sha-512-256", 6, "SHA2-512-256", 64)
101 def __init__(self, alg_name, alg_int_repr, scapy_name, key_len):
102 self.alg_name = alg_name
103 self.alg_int_repr = alg_int_repr
104 self.scapy_name = scapy_name
105 self.key_len = key_len
108 class IPsecProto(IntEnum):
109 """IPsec protocol."""
111 IPSEC_API_PROTO_ESP = 50
112 IPSEC_API_PROTO_AH = 51
115 class IPsecSadFlags(IntEnum):
116 """IPsec Security Association Database flags."""
118 IPSEC_API_SAD_FLAG_NONE = 0
119 # Enable extended sequence numbers
120 IPSEC_API_SAD_FLAG_USE_ESN = 0x01
121 # Enable Anti - replay
122 IPSEC_API_SAD_FLAG_USE_ANTI_REPLAY = 0x02
123 # IPsec tunnel mode if non-zero, else transport mode
124 IPSEC_API_SAD_FLAG_IS_TUNNEL = 0x04
125 # IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel
126 # only valid if is_tunnel is non-zero
127 IPSEC_API_SAD_FLAG_IS_TUNNEL_V6 = 0x08
128 # Enable UDP encapsulation for NAT traversal
129 IPSEC_API_SAD_FLAG_UDP_ENCAP = 0x10
130 # IPsec SA is or inbound traffic
131 IPSEC_API_SAD_FLAG_IS_INBOUND = 0x40
134 class TunnelEncpaDecapFlags(IntEnum):
135 """Flags controlling tunnel behaviour."""
137 TUNNEL_API_ENCAP_DECAP_FLAG_NONE = 0
138 # at encap, copy the DF bit of the payload into the tunnel header
139 TUNNEL_API_ENCAP_DECAP_FLAG_ENCAP_COPY_DF = 1
140 # at encap, set the DF bit in the tunnel header
141 TUNNEL_API_ENCAP_DECAP_FLAG_ENCAP_SET_DF = 2
142 # at encap, copy the DSCP bits of the payload into the tunnel header
143 TUNNEL_API_ENCAP_DECAP_FLAG_ENCAP_COPY_DSCP = 4
144 # at encap, copy the ECN bit of the payload into the tunnel header
145 TUNNEL_API_ENCAP_DECAP_FLAG_ENCAP_COPY_ECN = 8
146 # at decap, copy the ECN bit of the tunnel header into the payload
147 TUNNEL_API_ENCAP_DECAP_FLAG_ENCAP_SET_ECN = 16
150 class TunnelMode(IntEnum):
154 TUNNEL_API_MODE_P2P = 0
156 TUNNEL_API_MODE_MP = 1
160 """IPsec utilities."""
163 def policy_action_bypass():
164 """Return policy action bypass.
166 :returns: PolicyAction enum BYPASS object.
169 return PolicyAction.BYPASS
172 def policy_action_discard():
173 """Return policy action discard.
175 :returns: PolicyAction enum DISCARD object.
178 return PolicyAction.DISCARD
181 def policy_action_protect():
182 """Return policy action protect.
184 :returns: PolicyAction enum PROTECT object.
187 return PolicyAction.PROTECT
190 def crypto_alg_aes_cbc_128():
191 """Return encryption algorithm aes-cbc-128.
193 :returns: CryptoAlg enum AES_CBC_128 object.
196 return CryptoAlg.AES_CBC_128
199 def crypto_alg_aes_cbc_256():
200 """Return encryption algorithm aes-cbc-256.
202 :returns: CryptoAlg enum AES_CBC_256 object.
205 return CryptoAlg.AES_CBC_256
208 def crypto_alg_aes_gcm_128():
209 """Return encryption algorithm aes-gcm-128.
211 :returns: CryptoAlg enum AES_GCM_128 object.
214 return CryptoAlg.AES_GCM_128
217 def crypto_alg_aes_gcm_256():
218 """Return encryption algorithm aes-gcm-256.
220 :returns: CryptoAlg enum AES_GCM_128 object.
223 return CryptoAlg.AES_GCM_256
226 def get_crypto_alg_key_len(crypto_alg):
227 """Return encryption algorithm key length.
229 :param crypto_alg: Encryption algorithm.
230 :type crypto_alg: CryptoAlg
231 :returns: Key length.
234 return crypto_alg.key_len
237 def get_crypto_alg_scapy_name(crypto_alg):
238 """Return encryption algorithm scapy name.
240 :param crypto_alg: Encryption algorithm.
241 :type crypto_alg: CryptoAlg
242 :returns: Algorithm scapy name.
245 return crypto_alg.scapy_name
248 def integ_alg_sha_256_128():
249 """Return integrity algorithm SHA-256-128.
251 :returns: IntegAlg enum SHA_256_128 object.
254 return IntegAlg.SHA_256_128
257 def integ_alg_sha_512_256():
258 """Return integrity algorithm SHA-512-256.
260 :returns: IntegAlg enum SHA_512_256 object.
263 return IntegAlg.SHA_512_256
266 def get_integ_alg_key_len(integ_alg):
267 """Return integrity algorithm key length.
269 None argument is accepted, returning zero.
271 :param integ_alg: Integrity algorithm.
272 :type integ_alg: Optional[IntegAlg]
273 :returns: Key length.
276 return 0 if integ_alg is None else integ_alg.key_len
279 def get_integ_alg_scapy_name(integ_alg):
280 """Return integrity algorithm scapy name.
282 :param integ_alg: Integrity algorithm.
283 :type integ_alg: IntegAlg
284 :returns: Algorithm scapy name.
287 return integ_alg.scapy_name
290 def ipsec_proto_esp():
291 """Return IPSec protocol ESP.
293 :returns: IPsecProto enum ESP object.
296 return int(IPsecProto.IPSEC_API_PROTO_ESP)
299 def ipsec_proto_ah():
300 """Return IPSec protocol AH.
302 :returns: IPsecProto enum AH object.
305 return int(IPsecProto.IPSEC_API_PROTO_AH)
308 def vpp_ipsec_select_backend(node, protocol, index=1):
309 """Select IPsec backend.
311 :param node: VPP node to select IPsec backend on.
312 :param protocol: IPsec protocol.
313 :param index: Backend index.
315 :type protocol: IPsecProto
317 :raises RuntimeError: If failed to select IPsec backend or if no API
320 cmd = "ipsec_select_backend"
321 err_msg = f"Failed to select IPsec backend on host {node['host']}"
322 args = dict(protocol=protocol, index=index)
323 with PapiSocketExecutor(node) as papi_exec:
324 papi_exec.add(cmd, **args).get_reply(err_msg)
327 def vpp_ipsec_set_async_mode(node, async_enable=1):
328 """Set IPsec async mode on|off.
330 Unconditionally, attempt to switch crypto dispatch into polling mode.
332 :param node: VPP node to set IPsec async mode.
333 :param async_enable: Async mode on or off.
335 :type async_enable: int
336 :raises RuntimeError: If failed to set IPsec async mode or if no API
339 with PapiSocketExecutor(node) as papi_exec:
340 cmd = "ipsec_set_async_mode"
341 err_msg = f"Failed to set IPsec async mode on host {node['host']}"
342 args = dict(async_enable=async_enable)
343 papi_exec.add(cmd, **args).get_reply(err_msg)
344 cmd = "crypto_set_async_dispatch_v2"
345 err_msg = "Failed to set dispatch mode."
346 args = dict(mode=0, adaptive=False)
348 papi_exec.add(cmd, **args).get_reply(err_msg)
349 except (AttributeError, RuntimeError):
350 # Expected when VPP build does not have the _v2 yet
351 # (after and before the first CRC check).
352 # TODO: Fail here when testing of pre-23.10 builds is over.
356 def vpp_ipsec_crypto_sw_scheduler_set_worker(
357 node, workers, crypto_enable=False
359 """Enable or disable crypto on specific vpp worker threads.
361 :param node: VPP node to enable or disable crypto for worker threads.
362 :param workers: List of VPP thread numbers.
363 :param crypto_enable: Disable or enable crypto work.
365 :type workers: Iterable[int]
366 :type crypto_enable: bool
367 :raises RuntimeError: If failed to enable or disable crypto for worker
368 thread or if no API reply received.
370 for worker in workers:
371 cmd = "crypto_sw_scheduler_set_worker"
373 "Failed to disable/enable crypto for worker thread"
374 f" on host {node['host']}"
376 args = dict(worker_index=worker - 1, crypto_enable=crypto_enable)
377 with PapiSocketExecutor(node) as papi_exec:
378 papi_exec.add(cmd, **args).get_reply(err_msg)
381 def vpp_ipsec_crypto_sw_scheduler_set_worker_on_all_duts(
382 nodes, crypto_enable=False
384 """Enable or disable crypto on specific vpp worker threads.
386 :param node: VPP node to enable or disable crypto for worker threads.
387 :param crypto_enable: Disable or enable crypto work.
389 :type crypto_enable: bool
390 :raises RuntimeError: If failed to enable or disable crypto for worker
391 thread or if no API reply received.
393 for node_name, node in nodes.items():
394 if node["type"] == NodeType.DUT:
395 thread_data = VPPUtil.vpp_show_threads(node)
396 worker_cnt = len(thread_data) - 1
400 workers = BuiltIn().get_variable_value(
401 f"${{{node_name}_cpu_dp}}"
403 for item in thread_data:
404 if str(item.cpu_id) in workers.split(","):
405 worker_ids.append(item.id)
407 IPsecUtil.vpp_ipsec_crypto_sw_scheduler_set_worker(
408 node, workers=worker_ids, crypto_enable=crypto_enable
412 def vpp_ipsec_add_sad_entry(
423 """Create Security Association Database entry on the VPP node.
425 :param node: VPP node to add SAD entry on.
426 :param sad_id: SAD entry ID.
427 :param spi: Security Parameter Index of this SAD entry.
428 :param crypto_alg: The encryption algorithm name.
429 :param crypto_key: The encryption key string.
430 :param integ_alg: The integrity algorithm name.
431 :param integ_key: The integrity key string.
432 :param tunnel_src: Tunnel header source IPv4 or IPv6 address. If not
433 specified ESP transport mode is used.
434 :param tunnel_dst: Tunnel header destination IPv4 or IPv6 address. If
435 not specified ESP transport mode is used.
439 :type crypto_alg: CryptoAlg
440 :type crypto_key: str
441 :type integ_alg: Optional[IntegAlg]
443 :type tunnel_src: str
444 :type tunnel_dst: str
446 if isinstance(crypto_key, str):
447 crypto_key = crypto_key.encode(encoding="utf-8")
448 if isinstance(integ_key, str):
449 integ_key = integ_key.encode(encoding="utf-8")
450 ckey = dict(length=len(crypto_key), data=crypto_key)
451 ikey = dict(length=len(integ_key), data=integ_key if integ_key else 0)
453 flags = int(IPsecSadFlags.IPSEC_API_SAD_FLAG_NONE)
454 if tunnel_src and tunnel_dst:
455 flags = flags | int(IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_TUNNEL)
456 src_addr = ip_address(tunnel_src)
457 dst_addr = ip_address(tunnel_dst)
458 if src_addr.version == 6:
460 IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_TUNNEL_V6
466 cmd = "ipsec_sad_entry_add_v2"
468 "Failed to add Security Association Database entry"
469 f" on host {node['host']}"
474 crypto_algorithm=crypto_alg.alg_int_repr,
476 integrity_algorithm=integ_alg.alg_int_repr if integ_alg else 0,
483 encap_decap_flags=int(
484 TunnelEncpaDecapFlags.TUNNEL_API_ENCAP_DECAP_FLAG_NONE
486 dscp=int(IpDscp.IP_API_DSCP_CS0),
488 protocol=int(IPsecProto.IPSEC_API_PROTO_ESP),
489 udp_src_port=IPSEC_UDP_PORT_DEFAULT,
490 udp_dst_port=IPSEC_UDP_PORT_DEFAULT,
491 anti_replay_window_size=IPSEC_REPLAY_WINDOW_DEFAULT,
493 args = dict(entry=sad_entry)
494 with PapiSocketExecutor(node) as papi_exec:
495 papi_exec.add(cmd, **args).get_reply(err_msg)
498 def vpp_ipsec_add_sad_entries(
509 tunnel_addr_incr=True,
511 """Create multiple Security Association Database entries on VPP node.
513 :param node: VPP node to add SAD entry on.
514 :param n_entries: Number of SAD entries to be created.
515 :param sad_id: First SAD entry ID. All subsequent SAD entries will have
517 :param spi: Security Parameter Index of first SAD entry. All subsequent
518 SAD entries will have spi incremented by 1.
519 :param crypto_alg: The encryption algorithm name.
520 :param crypto_key: The encryption key string.
521 :param integ_alg: The integrity algorithm name.
522 :param integ_key: The integrity key string.
523 :param tunnel_src: Tunnel header source IPv4 or IPv6 address. If not
524 specified ESP transport mode is used.
525 :param tunnel_dst: Tunnel header destination IPv4 or IPv6 address. If
526 not specified ESP transport mode is used.
527 :param tunnel_addr_incr: Enable or disable tunnel IP address
533 :type crypto_alg: CryptoAlg
534 :type crypto_key: str
535 :type integ_alg: Optional[IntegAlg]
537 :type tunnel_src: str
538 :type tunnel_dst: str
539 :type tunnel_addr_incr: bool
541 if isinstance(crypto_key, str):
542 crypto_key = crypto_key.encode(encoding="utf-8")
543 if isinstance(integ_key, str):
544 integ_key = integ_key.encode(encoding="utf-8")
545 if tunnel_src and tunnel_dst:
546 src_addr = ip_address(tunnel_src)
547 dst_addr = ip_address(tunnel_dst)
554 1 << (128 - 96) if src_addr.version == 6 else 1 << (32 - 24)
559 ckey = dict(length=len(crypto_key), data=crypto_key)
560 ikey = dict(length=len(integ_key), data=integ_key if integ_key else 0)
562 flags = int(IPsecSadFlags.IPSEC_API_SAD_FLAG_NONE)
563 if tunnel_src and tunnel_dst:
564 flags = flags | int(IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_TUNNEL)
565 if src_addr.version == 6:
567 IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_TUNNEL_V6
570 cmd = "ipsec_sad_entry_add_v2"
572 "Failed to add Security Association Database entry"
573 f" on host {node['host']}"
579 crypto_algorithm=crypto_alg.alg_int_repr,
581 integrity_algorithm=integ_alg.alg_int_repr if integ_alg else 0,
588 encap_decap_flags=int(
589 TunnelEncpaDecapFlags.TUNNEL_API_ENCAP_DECAP_FLAG_NONE
591 dscp=int(IpDscp.IP_API_DSCP_CS0),
593 protocol=int(IPsecProto.IPSEC_API_PROTO_ESP),
594 udp_src_port=IPSEC_UDP_PORT_DEFAULT,
595 udp_dst_port=IPSEC_UDP_PORT_DEFAULT,
596 anti_replay_window_size=IPSEC_REPLAY_WINDOW_DEFAULT,
598 args = dict(entry=sad_entry)
599 with PapiSocketExecutor(node, is_async=True) as papi_exec:
600 for i in range(n_entries):
601 args["entry"]["sad_id"] = int(sad_id) + i
602 args["entry"]["spi"] = int(spi) + i
603 args["entry"]["tunnel"]["src"] = (
604 str(src_addr + i * addr_incr)
605 if tunnel_src and tunnel_dst
608 args["entry"]["tunnel"]["dst"] = (
609 str(dst_addr + i * addr_incr)
610 if tunnel_src and tunnel_dst
613 history = bool(not 1 < i < n_entries - 2)
614 papi_exec.add(cmd, history=history, **args)
615 papi_exec.get_replies(err_msg)
618 def vpp_ipsec_set_ip_route(
628 """Set IP address and route on interface.
630 :param node: VPP node to add config on.
631 :param n_tunnels: Number of tunnels to create.
632 :param tunnel_src: Tunnel header source IPv4 or IPv6 address.
633 :param traffic_addr: Traffic destination IP address to route.
634 :param tunnel_dst: Tunnel header destination IPv4 or IPv6 address.
635 :param interface: Interface key on node 1.
636 :param raddr_range: Mask specifying range of Policy selector Remote IP
637 addresses. Valid values are from 1 to 32 in case of IPv4 and to 128
639 :param dst_mac: The MAC address of destination tunnels.
642 :type tunnel_src: str
643 :type traffic_addr: str
644 :type tunnel_dst: str
646 :type raddr_range: int
649 tunnel_src = ip_address(tunnel_src)
650 tunnel_dst = ip_address(tunnel_dst)
651 traffic_addr = ip_address(traffic_addr)
652 tunnel_dst_prefix = 128 if tunnel_dst.version == 6 else 32
654 1 << (128 - raddr_range)
655 if tunnel_src.version == 6
656 else 1 << (32 - raddr_range)
659 cmd1 = "sw_interface_add_del_address"
661 sw_if_index=InterfaceUtil.get_interface_index(node, interface),
666 cmd2 = "ip_route_add_del"
667 args2 = dict(is_add=1, is_multipath=0, route=None)
668 cmd3 = "ip_neighbor_add_del"
672 sw_if_index=Topology.get_interface_sw_index(node, interface),
674 mac_address=str(dst_mac),
679 "Failed to configure IP addresses, IP routes and"
680 f" IP neighbor on interface {interface} on host {node['host']}"
682 else "Failed to configure IP addresses and IP routes"
683 f" on interface {interface} on host {node['host']}"
686 with PapiSocketExecutor(node, is_async=True) as papi_exec:
687 for i in range(n_tunnels):
688 tunnel_dst_addr = tunnel_dst + i * addr_incr
689 args1["prefix"] = IPUtil.create_prefix_object(
690 tunnel_src + i * addr_incr, raddr_range
692 args2["route"] = IPUtil.compose_vpp_route_structure(
695 prefix_len=tunnel_dst_prefix,
697 gateway=tunnel_dst_addr,
699 history = bool(not 1 < i < n_tunnels - 2)
700 papi_exec.add(cmd1, history=history, **args1)
701 papi_exec.add(cmd2, history=history, **args2)
703 args2["route"] = IPUtil.compose_vpp_route_structure(
706 prefix_len=tunnel_dst_prefix,
708 gateway=tunnel_dst_addr,
710 papi_exec.add(cmd2, history=history, **args2)
713 args3["neighbor"]["ip_address"] = ip_address(
716 papi_exec.add(cmd3, history=history, **args3)
717 papi_exec.get_replies(err_msg)
720 def vpp_ipsec_add_spd(node, spd_id):
721 """Create Security Policy Database on the VPP node.
723 :param node: VPP node to add SPD on.
724 :param spd_id: SPD ID.
728 cmd = "ipsec_spd_add_del"
730 f"Failed to add Security Policy Database on host {node['host']}"
732 args = dict(is_add=True, spd_id=int(spd_id))
733 with PapiSocketExecutor(node) as papi_exec:
734 papi_exec.add(cmd, **args).get_reply(err_msg)
737 def vpp_ipsec_spd_add_if(node, spd_id, interface):
738 """Add interface to the Security Policy Database.
740 :param node: VPP node.
741 :param spd_id: SPD ID to add interface on.
742 :param interface: Interface name or sw_if_index.
745 :type interface: str or int
747 cmd = "ipsec_interface_add_del_spd"
749 f"Failed to add interface {interface} to Security Policy"
750 f" Database {spd_id} on host {node['host']}"
754 sw_if_index=InterfaceUtil.get_interface_index(node, interface),
757 with PapiSocketExecutor(node) as papi_exec:
758 papi_exec.add(cmd, **args).get_reply(err_msg)
761 def vpp_ipsec_create_spds_match_nth_entry(
768 action=PolicyAction.BYPASS,
772 """Create one matching SPD entry for inbound or outbound traffic on
773 a DUT for each traffic direction and also create entry_amount - 1
774 non-matching SPD entries. Create a Security Policy Database on each
775 outbound interface where these entries will be configured.
776 The matching SPD entry will have the lowest priority, input action and
777 will be configured to match the IP flow. The non-matching entries will
778 be the same, except with higher priority and non-matching IP flows.
780 Action Protect is currently not supported.
782 :param node: VPP node to configured the SPDs and their entries.
783 :param dir1_interface: The interface in direction 1 where the entries
785 :param dir2_interface: The interface in direction 2 where the entries
787 :param entry_amount: The number of SPD entries to configure. If
788 entry_amount == 1, no non-matching entries will be configured.
789 :param local_addr_range: Matching local address range in direction 1
790 in format IP/prefix or IP/mask. If no mask is provided, it's
791 considered to be /32.
792 :param remote_addr_range: Matching remote address range in
793 direction 1 in format IP/prefix or IP/mask. If no mask is
794 provided, it's considered to be /32.
795 :param action: Policy action.
796 :param inbound: If True policy is for inbound traffic, otherwise
798 :param bidirectional: When True, will create SPDs in both directions
799 of traffic. When False, only in one direction.
801 :type dir1_interface: Union[string, int]
802 :type dir2_interface: Union[string, int]
803 :type entry_amount: int
804 :type local_addr_range:
805 Union[string, ipaddress.IPv4Address, ipaddress.IPv6Address]
806 :type remote_addr_range:
807 Union[string, ipaddress.IPv4Address, ipaddress.IPv6Address]
808 :type action: IPsecUtil.PolicyAction
810 :type bidirectional: bool
811 :raises NotImplementedError: When the action is PolicyAction.PROTECT.
814 if action == PolicyAction.PROTECT:
815 raise NotImplementedError("Policy action PROTECT is not supported.")
819 matching_priority = 1
821 IPsecUtil.vpp_ipsec_add_spd(node, spd_id_dir1)
822 IPsecUtil.vpp_ipsec_spd_add_if(node, spd_id_dir1, dir1_interface)
823 # matching entry direction 1
824 IPsecUtil.vpp_ipsec_add_spd_entry(
830 laddr_range=local_addr_range,
831 raddr_range=remote_addr_range,
835 IPsecUtil.vpp_ipsec_add_spd(node, spd_id_dir2)
836 IPsecUtil.vpp_ipsec_spd_add_if(node, spd_id_dir2, dir2_interface)
838 # matching entry direction 2, the address ranges are switched
839 IPsecUtil.vpp_ipsec_add_spd_entry(
845 laddr_range=remote_addr_range,
846 raddr_range=local_addr_range,
849 # non-matching entries
850 no_match_entry_amount = entry_amount - 1
851 if no_match_entry_amount > 0:
852 # create a NetworkIncrement representation of the network,
853 # then skip the matching network
854 no_match_local_addr_range = NetworkIncrement(
855 ip_network(local_addr_range)
857 next(no_match_local_addr_range)
859 no_match_remote_addr_range = NetworkIncrement(
860 ip_network(remote_addr_range)
862 next(no_match_remote_addr_range)
864 # non-matching entries direction 1
865 IPsecUtil.vpp_ipsec_add_spd_entries(
867 no_match_entry_amount,
869 ObjIncrement(matching_priority + 1, 1),
872 laddr_range=no_match_local_addr_range,
873 raddr_range=no_match_remote_addr_range,
877 # reset the networks so that we're using a unified config
878 # the address ranges are switched
879 no_match_remote_addr_range = NetworkIncrement(
880 ip_network(local_addr_range)
882 next(no_match_remote_addr_range)
884 no_match_local_addr_range = NetworkIncrement(
885 ip_network(remote_addr_range)
887 next(no_match_local_addr_range)
888 # non-matching entries direction 2
889 IPsecUtil.vpp_ipsec_add_spd_entries(
891 no_match_entry_amount,
893 ObjIncrement(matching_priority + 1, 1),
896 laddr_range=no_match_local_addr_range,
897 raddr_range=no_match_remote_addr_range,
900 IPsecUtil.vpp_ipsec_show_all(node)
903 def _vpp_ipsec_add_spd_entry_internal(
917 """Prepare to create Security Policy Database entry on the VPP node.
919 This just adds one more command to the executor.
920 The call site shall get replies once all entries are added,
921 to get speed benefit from async PAPI.
923 :param executor: Open PAPI executor (async handling) to add commands to.
924 :param spd_id: SPD ID to add entry on.
925 :param priority: SPD entry priority, higher number = higher priority.
926 :param action: Policy action.
927 :param inbound: If True policy is for inbound traffic, otherwise
929 :param sa_id: SAD entry ID for action PolicyAction.PROTECT.
930 :param proto: Policy selector next layer protocol number.
931 :param laddr_range: Policy selector local IPv4 or IPv6 address range
932 in format IP/prefix or IP/mask. If no mask is provided,
933 it's considered to be /32.
934 :param raddr_range: Policy selector remote IPv4 or IPv6 address range
935 in format IP/prefix or IP/mask. If no mask is provided,
936 it's considered to be /32.
937 :param lport_range: Policy selector local TCP/UDP port range in format
938 <port_start>-<port_end>.
939 :param rport_range: Policy selector remote TCP/UDP port range in format
940 <port_start>-<port_end>.
941 :param is_ipv6: True in case of IPv6 policy when IPv6 address range is
942 not defined so it will default to address ::/0, otherwise False.
943 :type executor: PapiSocketExecutor
946 :type action: IPsecUtil.PolicyAction
950 :type laddr_range: string
951 :type raddr_range: string
952 :type lport_range: string
953 :type rport_range: string
956 if laddr_range is None:
957 laddr_range = "::/0" if is_ipv6 else "0.0.0.0/0"
959 if raddr_range is None:
960 raddr_range = "::/0" if is_ipv6 else "0.0.0.0/0"
962 local_net = ip_network(laddr_range, strict=False)
963 remote_net = ip_network(raddr_range, strict=False)
965 cmd = "ipsec_spd_entry_add_del_v2"
969 priority=int(priority),
970 is_outbound=not inbound,
971 sa_id=int(sa_id) if sa_id else 0,
973 protocol=255 if proto is None else int(proto),
974 remote_address_start=IPAddress.create_ip_address_object(
975 remote_net.network_address
977 remote_address_stop=IPAddress.create_ip_address_object(
978 remote_net.broadcast_address
980 local_address_start=IPAddress.create_ip_address_object(
981 local_net.network_address
983 local_address_stop=IPAddress.create_ip_address_object(
984 local_net.broadcast_address
987 int(rport_range.split("-")[0]) if rport_range else 0
990 int(rport_range.split("-")[1]) if rport_range else 65535
993 int(lport_range.split("-")[0]) if lport_range else 0
996 int(lport_range.split("-")[1]) if rport_range else 65535
999 args = dict(is_add=True, entry=spd_entry)
1000 executor.add(cmd, **args)
1003 def vpp_ipsec_add_spd_entry(
1017 """Create Security Policy Database entry on the VPP node.
1019 :param node: VPP node to add SPD entry on.
1020 :param spd_id: SPD ID to add entry on.
1021 :param priority: SPD entry priority, higher number = higher priority.
1022 :param action: Policy action.
1023 :param inbound: If True policy is for inbound traffic, otherwise
1025 :param sa_id: SAD entry ID for action PolicyAction.PROTECT.
1026 :param proto: Policy selector next layer protocol number.
1027 :param laddr_range: Policy selector local IPv4 or IPv6 address range
1028 in format IP/prefix or IP/mask. If no mask is provided,
1029 it's considered to be /32.
1030 :param raddr_range: Policy selector remote IPv4 or IPv6 address range
1031 in format IP/prefix or IP/mask. If no mask is provided,
1032 it's considered to be /32.
1033 :param lport_range: Policy selector local TCP/UDP port range in format
1034 <port_start>-<port_end>.
1035 :param rport_range: Policy selector remote TCP/UDP port range in format
1036 <port_start>-<port_end>.
1037 :param is_ipv6: True in case of IPv6 policy when IPv6 address range is
1038 not defined so it will default to address ::/0, otherwise False.
1042 :type action: IPsecUtil.PolicyAction
1046 :type laddr_range: string
1047 :type raddr_range: string
1048 :type lport_range: string
1049 :type rport_range: string
1053 "Failed to add entry to Security Policy Database"
1054 f" {spd_id} on host {node['host']}"
1056 with PapiSocketExecutor(node, is_async=True) as papi_exec:
1057 IPsecUtil._vpp_ipsec_add_spd_entry_internal(
1071 papi_exec.get_replies(err_msg)
1074 def vpp_ipsec_add_spd_entries(
1089 """Create multiple Security Policy Database entries on the VPP node.
1091 :param node: VPP node to add SPD entries on.
1092 :param n_entries: Number of SPD entries to be added.
1093 :param spd_id: SPD ID to add entries on.
1094 :param priority: SPD entries priority, higher number = higher priority.
1095 :param action: Policy action.
1096 :param inbound: If True policy is for inbound traffic, otherwise
1098 :param sa_id: SAD entry ID for action PolicyAction.PROTECT.
1099 :param proto: Policy selector next layer protocol number.
1100 :param laddr_range: Policy selector local IPv4 or IPv6 address range
1101 in format IP/prefix or IP/mask. If no mask is provided,
1102 it's considered to be /32.
1103 :param raddr_range: Policy selector remote IPv4 or IPv6 address range
1104 in format IP/prefix or IP/mask. If no mask is provided,
1105 it's considered to be /32.
1106 :param lport_range: Policy selector local TCP/UDP port range in format
1107 <port_start>-<port_end>.
1108 :param rport_range: Policy selector remote TCP/UDP port range in format
1109 <port_start>-<port_end>.
1110 :param is_ipv6: True in case of IPv6 policy when IPv6 address range is
1111 not defined so it will default to address ::/0, otherwise False.
1113 :type n_entries: int
1115 :type priority: IPsecUtil.ObjIncrement
1116 :type action: IPsecUtil.PolicyAction
1118 :type sa_id: IPsecUtil.ObjIncrement
1120 :type laddr_range: IPsecUtil.NetworkIncrement
1121 :type raddr_range: IPsecUtil.NetworkIncrement
1122 :type lport_range: string
1123 :type rport_range: string
1126 if laddr_range is None:
1127 laddr_range = "::/0" if is_ipv6 else "0.0.0.0/0"
1128 laddr_range = NetworkIncrement(ip_network(laddr_range), 0)
1130 if raddr_range is None:
1131 raddr_range = "::/0" if is_ipv6 else "0.0.0.0/0"
1132 raddr_range = NetworkIncrement(ip_network(raddr_range), 0)
1135 "Failed to add entry to Security Policy Database"
1136 f" {spd_id} on host {node['host']}"
1138 with PapiSocketExecutor(node, is_async=True) as papi_exec:
1139 for _ in range(n_entries):
1140 IPsecUtil._vpp_ipsec_add_spd_entry_internal(
1146 next(sa_id) if sa_id is not None else sa_id,
1154 papi_exec.get_replies(err_msg)
1157 def _ipsec_create_loopback_dut1_papi(nodes, tun_ips, if1_key, if2_key):
1158 """Create loopback interface and set IP address on VPP node 1 interface
1161 :param nodes: VPP nodes to create tunnel interfaces.
1162 :param tun_ips: Dictionary with VPP node 1 ipsec tunnel interface
1163 IPv4/IPv6 address (ip1) and VPP node 2 ipsec tunnel interface
1164 IPv4/IPv6 address (ip2).
1165 :param if1_key: VPP node 1 interface key from topology file.
1166 :param if2_key: VPP node 2 / TG node (in case of 2-node topology)
1167 interface key from topology file.
1173 with PapiSocketExecutor(nodes["DUT1"]) as papi_exec:
1174 # Create loopback interface on DUT1, set it to up state
1175 cmd = "create_loopback_instance"
1182 "Failed to create loopback interface"
1183 f" on host {nodes['DUT1']['host']}"
1185 papi_exec.add(cmd, **args)
1186 loop_sw_if_idx = papi_exec.get_sw_if_index(err_msg)
1187 cmd = "sw_interface_set_flags"
1189 sw_if_index=loop_sw_if_idx,
1190 flags=InterfaceStatusFlags.IF_STATUS_API_FLAG_ADMIN_UP.value,
1193 "Failed to set loopback interface state up"
1194 f" on host {nodes['DUT1']['host']}"
1196 papi_exec.add(cmd, **args).get_reply(err_msg)
1197 # Set IP address on VPP node 1 interface
1198 cmd = "sw_interface_add_del_address"
1200 sw_if_index=InterfaceUtil.get_interface_index(
1201 nodes["DUT1"], if1_key
1205 prefix=IPUtil.create_prefix_object(
1207 96 if tun_ips["ip2"].version == 6 else 24,
1211 f"Failed to set IP address on interface {if1_key}"
1212 f" on host {nodes['DUT1']['host']}"
1214 papi_exec.add(cmd, **args).get_reply(err_msg)
1215 cmd2 = "ip_neighbor_add_del"
1219 sw_if_index=Topology.get_interface_sw_index(
1220 nodes["DUT1"], if1_key
1224 Topology.get_interface_mac(nodes["DUT2"], if2_key)
1225 if "DUT2" in nodes.keys()
1226 else Topology.get_interface_mac(nodes["TG"], if2_key)
1228 ip_address=tun_ips["ip2"].compressed,
1231 err_msg = f"Failed to add IP neighbor on interface {if1_key}"
1232 papi_exec.add(cmd2, **args2).get_reply(err_msg)
1234 return loop_sw_if_idx
1237 def _ipsec_create_tunnel_interfaces_dut1_papi(
1250 """Create multiple IPsec tunnel interfaces on DUT1 node using PAPI.
1252 Generate random keys and return them (so DUT2 or TG can decrypt).
1254 :param nodes: VPP nodes to create tunnel interfaces.
1255 :param tun_ips: Dictionary with VPP node 1 ipsec tunnel interface
1256 IPv4/IPv6 address (ip1) and VPP node 2 ipsec tunnel interface
1257 IPv4/IPv6 address (ip2).
1258 :param if1_key: VPP node 1 interface key from topology file.
1259 :param if2_key: VPP node 2 / TG node (in case of 2-node topology)
1260 interface key from topology file.
1261 :param n_tunnels: Number of tunnel interfaces to be there at the end.
1262 :param crypto_alg: The encryption algorithm name.
1263 :param integ_alg: The integrity algorithm name.
1264 :param raddr_ip2: Policy selector remote IPv4/IPv6 start address for the
1265 first tunnel in direction node2->node1.
1266 :param spi_d: Dictionary with SPIs for VPP node 1 and VPP node 2.
1267 :param addr_incr: IP / IPv6 address incremental step.
1268 :param existing_tunnels: Number of tunnel interfaces before creation.
1269 Useful mainly for reconf tests. Default 0.
1274 :type n_tunnels: int
1275 :type crypto_alg: CryptoAlg
1276 :type integ_alg: Optional[IntegAlg]
1277 :type raddr_ip2: IPv4Address or IPv6Address
1278 :type addr_incr: int
1280 :type existing_tunnels: int
1281 :returns: Generated ckeys and ikeys.
1282 :rtype: List[bytes], List[bytes]
1284 if not existing_tunnels:
1285 loop_sw_if_idx = IPsecUtil._ipsec_create_loopback_dut1_papi(
1286 nodes, tun_ips, if1_key, if2_key
1289 loop_sw_if_idx = InterfaceUtil.vpp_get_interface_sw_index(
1290 nodes["DUT1"], "loop0"
1292 with PapiSocketExecutor(nodes["DUT1"], is_async=True) as papi_exec:
1293 # Configure IP addresses on loop0 interface
1294 cmd = "sw_interface_add_del_address"
1296 sw_if_index=loop_sw_if_idx,
1301 for i in range(existing_tunnels, n_tunnels):
1302 args["prefix"] = IPUtil.create_prefix_object(
1303 tun_ips["ip1"] + i * addr_incr,
1304 128 if tun_ips["ip1"].version == 6 else 32,
1307 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1309 # Configure IPIP tunnel interfaces
1310 cmd = "ipip_add_tunnel"
1312 instance=Constants.BITWISE_NON_ZERO,
1317 TunnelEncpaDecapFlags.TUNNEL_API_ENCAP_DECAP_FLAG_NONE
1319 mode=int(TunnelMode.TUNNEL_API_MODE_P2P),
1320 dscp=int(IpDscp.IP_API_DSCP_CS0),
1322 args = dict(tunnel=ipip_tunnel)
1323 ipip_tunnels = [None] * existing_tunnels
1324 for i in range(existing_tunnels, n_tunnels):
1325 ipip_tunnel["src"] = IPAddress.create_ip_address_object(
1326 tun_ips["ip1"] + i * addr_incr
1328 ipip_tunnel["dst"] = IPAddress.create_ip_address_object(
1332 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1335 "Failed to add IPIP tunnel interfaces on host"
1336 f" {nodes['DUT1']['host']}"
1338 ipip_tunnels.extend(
1340 reply["sw_if_index"]
1341 for reply in papi_exec.get_replies(err_msg)
1342 if "sw_if_index" in reply
1345 # Configure IPSec SAD entries
1346 ckeys = [bytes()] * existing_tunnels
1347 ikeys = [bytes()] * existing_tunnels
1348 cmd = "ipsec_sad_entry_add_v2"
1349 c_key = dict(length=0, data=None)
1350 i_key = dict(length=0, data=None)
1351 common_flags = IPsecSadFlags.IPSEC_API_SAD_FLAG_NONE
1355 protocol=int(IPsecProto.IPSEC_API_PROTO_ESP),
1356 crypto_algorithm=crypto_alg.alg_int_repr,
1358 integrity_algorithm=integ_alg.alg_int_repr if integ_alg else 0,
1359 integrity_key=i_key,
1365 encap_decap_flags=int(
1366 TunnelEncpaDecapFlags.TUNNEL_API_ENCAP_DECAP_FLAG_NONE
1368 dscp=int(IpDscp.IP_API_DSCP_CS0),
1371 udp_src_port=IPSEC_UDP_PORT_DEFAULT,
1372 udp_dst_port=IPSEC_UDP_PORT_DEFAULT,
1373 anti_replay_window_size=IPSEC_REPLAY_WINDOW_DEFAULT,
1375 args = dict(entry=sad_entry)
1376 for i in range(existing_tunnels, n_tunnels):
1378 gen_key(IPsecUtil.get_crypto_alg_key_len(crypto_alg))
1381 gen_key(IPsecUtil.get_integ_alg_key_len(integ_alg))
1383 # SAD entry for outband / tx path
1384 sad_entry["sad_id"] = i
1385 sad_entry["spi"] = spi_d["spi_1"] + i
1387 sad_entry["crypto_key"]["length"] = len(ckeys[i])
1388 sad_entry["crypto_key"]["data"] = ckeys[i]
1390 sad_entry["integrity_key"]["length"] = len(ikeys[i])
1391 sad_entry["integrity_key"]["data"] = ikeys[i]
1393 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1395 sad_entry["flags"] |= IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_INBOUND
1396 for i in range(existing_tunnels, n_tunnels):
1397 # SAD entry for inband / rx path
1398 sad_entry["sad_id"] = 100000 + i
1399 sad_entry["spi"] = spi_d["spi_2"] + i
1401 sad_entry["crypto_key"]["length"] = len(ckeys[i])
1402 sad_entry["crypto_key"]["data"] = ckeys[i]
1404 sad_entry["integrity_key"]["length"] = len(ikeys[i])
1405 sad_entry["integrity_key"]["data"] = ikeys[i]
1407 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1410 "Failed to add IPsec SAD entries on host"
1411 f" {nodes['DUT1']['host']}"
1413 papi_exec.get_replies(err_msg)
1414 # Add protection for tunnels with IPSEC
1415 cmd = "ipsec_tunnel_protect_update"
1418 via_label=MPLS_LABEL_INVALID,
1419 obj_id=Constants.BITWISE_NON_ZERO,
1421 ipsec_tunnel_protect = dict(
1422 sw_if_index=None, nh=n_hop, sa_out=None, n_sa_in=1, sa_in=None
1424 args = dict(tunnel=ipsec_tunnel_protect)
1425 for i in range(existing_tunnels, n_tunnels):
1426 args["tunnel"]["sw_if_index"] = ipip_tunnels[i]
1427 args["tunnel"]["sa_out"] = i
1428 args["tunnel"]["sa_in"] = [100000 + i]
1430 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1433 "Failed to add protection for tunnels with IPSEC"
1434 f" on host {nodes['DUT1']['host']}"
1436 papi_exec.get_replies(err_msg)
1438 # Configure unnumbered interfaces
1439 cmd = "sw_interface_set_unnumbered"
1442 sw_if_index=InterfaceUtil.get_interface_index(
1443 nodes["DUT1"], if1_key
1445 unnumbered_sw_if_index=0,
1447 for i in range(existing_tunnels, n_tunnels):
1448 args["unnumbered_sw_if_index"] = ipip_tunnels[i]
1450 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1453 cmd = "sw_interface_set_flags"
1456 flags=InterfaceStatusFlags.IF_STATUS_API_FLAG_ADMIN_UP.value,
1458 for i in range(existing_tunnels, n_tunnels):
1459 args["sw_if_index"] = ipip_tunnels[i]
1461 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1463 # Configure IP routes
1464 cmd = "ip_route_add_del"
1465 args = dict(is_add=1, is_multipath=0, route=None)
1466 for i in range(existing_tunnels, n_tunnels):
1467 args["route"] = IPUtil.compose_vpp_route_structure(
1469 (raddr_ip2 + i).compressed,
1470 prefix_len=128 if raddr_ip2.version == 6 else 32,
1471 interface=ipip_tunnels[i],
1474 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1476 err_msg = f"Failed to add IP routes on host {nodes['DUT1']['host']}"
1477 papi_exec.get_replies(err_msg)
1482 def _ipsec_create_tunnel_interfaces_dut2_papi(
1496 """Create multiple IPsec tunnel interfaces on DUT2 node using PAPI.
1498 This method accesses keys generated by DUT1 method
1499 and does not return anything.
1501 :param nodes: VPP nodes to create tunnel interfaces.
1502 :param tun_ips: Dictionary with VPP node 1 ipsec tunnel interface
1503 IPv4/IPv6 address (ip1) and VPP node 2 ipsec tunnel interface
1504 IPv4/IPv6 address (ip2).
1505 :param if2_key: VPP node 2 / TG node (in case of 2-node topology)
1506 interface key from topology file.
1507 :param n_tunnels: Number of tunnel interfaces to be there at the end.
1508 :param crypto_alg: The encryption algorithm name.
1509 :param ckeys: List of encryption keys.
1510 :param integ_alg: The integrity algorithm name.
1511 :param ikeys: List of integrity keys.
1512 :param spi_d: Dictionary with SPIs for VPP node 1 and VPP node 2.
1513 :param addr_incr: IP / IPv6 address incremental step.
1514 :param existing_tunnels: Number of tunnel interfaces before creation.
1515 Useful mainly for reconf tests. Default 0.
1519 :type n_tunnels: int
1520 :type crypto_alg: CryptoAlg
1521 :type ckeys: Sequence[bytes]
1522 :type integ_alg: Optional[IntegAlg]
1523 :type ikeys: Sequence[bytes]
1524 :type addr_incr: int
1526 :type existing_tunnels: int
1528 with PapiSocketExecutor(nodes["DUT2"], is_async=True) as papi_exec:
1529 if not existing_tunnels:
1530 # Set IP address on VPP node 2 interface
1531 cmd = "sw_interface_add_del_address"
1533 sw_if_index=InterfaceUtil.get_interface_index(
1534 nodes["DUT2"], if2_key
1538 prefix=IPUtil.create_prefix_object(
1540 96 if tun_ips["ip2"].version == 6 else 24,
1544 f"Failed to set IP address on interface {if2_key}"
1545 f" on host {nodes['DUT2']['host']}"
1547 papi_exec.add(cmd, **args).get_replies(err_msg)
1548 # Configure IPIP tunnel interfaces
1549 cmd = "ipip_add_tunnel"
1551 instance=Constants.BITWISE_NON_ZERO,
1556 TunnelEncpaDecapFlags.TUNNEL_API_ENCAP_DECAP_FLAG_NONE
1558 mode=int(TunnelMode.TUNNEL_API_MODE_P2P),
1559 dscp=int(IpDscp.IP_API_DSCP_CS0),
1561 args = dict(tunnel=ipip_tunnel)
1562 ipip_tunnels = [None] * existing_tunnels
1563 for i in range(existing_tunnels, n_tunnels):
1564 ipip_tunnel["src"] = IPAddress.create_ip_address_object(
1567 ipip_tunnel["dst"] = IPAddress.create_ip_address_object(
1568 tun_ips["ip1"] + i * addr_incr
1571 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1574 "Failed to add IPIP tunnel interfaces on host"
1575 f" {nodes['DUT2']['host']}"
1577 ipip_tunnels.extend(
1579 reply["sw_if_index"]
1580 for reply in papi_exec.get_replies(err_msg)
1581 if "sw_if_index" in reply
1584 # Configure IPSec SAD entries
1585 cmd = "ipsec_sad_entry_add_v2"
1586 c_key = dict(length=0, data=None)
1587 i_key = dict(length=0, data=None)
1588 common_flags = IPsecSadFlags.IPSEC_API_SAD_FLAG_NONE
1592 protocol=int(IPsecProto.IPSEC_API_PROTO_ESP),
1593 crypto_algorithm=crypto_alg.alg_int_repr,
1595 integrity_algorithm=integ_alg.alg_int_repr if integ_alg else 0,
1596 integrity_key=i_key,
1602 encap_decap_flags=int(
1603 TunnelEncpaDecapFlags.TUNNEL_API_ENCAP_DECAP_FLAG_NONE
1605 dscp=int(IpDscp.IP_API_DSCP_CS0),
1608 udp_src_port=IPSEC_UDP_PORT_DEFAULT,
1609 udp_dst_port=IPSEC_UDP_PORT_DEFAULT,
1610 anti_replay_window_size=IPSEC_REPLAY_WINDOW_DEFAULT,
1612 args = dict(entry=sad_entry)
1613 for i in range(existing_tunnels, n_tunnels):
1615 gen_key(IPsecUtil.get_crypto_alg_key_len(crypto_alg))
1618 gen_key(IPsecUtil.get_integ_alg_key_len(integ_alg))
1620 # SAD entry for outband / tx path
1621 sad_entry["sad_id"] = 100000 + i
1622 sad_entry["spi"] = spi_d["spi_2"] + i
1624 sad_entry["crypto_key"]["length"] = len(ckeys[i])
1625 sad_entry["crypto_key"]["data"] = ckeys[i]
1627 sad_entry["integrity_key"]["length"] = len(ikeys[i])
1628 sad_entry["integrity_key"]["data"] = ikeys[i]
1630 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1632 sad_entry["flags"] |= IPsecSadFlags.IPSEC_API_SAD_FLAG_IS_INBOUND
1633 for i in range(existing_tunnels, n_tunnels):
1634 # SAD entry for inband / rx path
1635 sad_entry["sad_id"] = i
1636 sad_entry["spi"] = spi_d["spi_1"] + i
1638 sad_entry["crypto_key"]["length"] = len(ckeys[i])
1639 sad_entry["crypto_key"]["data"] = ckeys[i]
1641 sad_entry["integrity_key"]["length"] = len(ikeys[i])
1642 sad_entry["integrity_key"]["data"] = ikeys[i]
1644 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1647 f"Failed to add IPsec SAD entries on host"
1648 f" {nodes['DUT2']['host']}"
1650 papi_exec.get_replies(err_msg)
1651 # Add protection for tunnels with IPSEC
1652 cmd = "ipsec_tunnel_protect_update"
1655 via_label=MPLS_LABEL_INVALID,
1656 obj_id=Constants.BITWISE_NON_ZERO,
1658 ipsec_tunnel_protect = dict(
1659 sw_if_index=None, nh=n_hop, sa_out=None, n_sa_in=1, sa_in=None
1661 args = dict(tunnel=ipsec_tunnel_protect)
1662 for i in range(existing_tunnels, n_tunnels):
1663 args["tunnel"]["sw_if_index"] = ipip_tunnels[i]
1664 args["tunnel"]["sa_out"] = 100000 + i
1665 args["tunnel"]["sa_in"] = [i]
1667 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1670 "Failed to add protection for tunnels with IPSEC"
1671 f" on host {nodes['DUT2']['host']}"
1673 papi_exec.get_replies(err_msg)
1675 if not existing_tunnels:
1676 # Configure IP route
1677 cmd = "ip_route_add_del"
1678 route = IPUtil.compose_vpp_route_structure(
1680 tun_ips["ip1"].compressed,
1681 prefix_len=32 if tun_ips["ip1"].version == 6 else 8,
1683 gateway=(tun_ips["ip2"] - 1).compressed,
1685 args = dict(is_add=1, is_multipath=0, route=route)
1686 papi_exec.add(cmd, **args)
1687 # Configure unnumbered interfaces
1688 cmd = "sw_interface_set_unnumbered"
1691 sw_if_index=InterfaceUtil.get_interface_index(
1692 nodes["DUT2"], if2_key
1694 unnumbered_sw_if_index=0,
1696 for i in range(existing_tunnels, n_tunnels):
1697 args["unnumbered_sw_if_index"] = ipip_tunnels[i]
1699 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1702 cmd = "sw_interface_set_flags"
1705 flags=InterfaceStatusFlags.IF_STATUS_API_FLAG_ADMIN_UP.value,
1707 for i in range(existing_tunnels, n_tunnels):
1708 args["sw_if_index"] = ipip_tunnels[i]
1710 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1712 # Configure IP routes
1713 cmd = "ip_route_add_del"
1714 args = dict(is_add=1, is_multipath=0, route=None)
1715 for i in range(existing_tunnels, n_tunnels):
1716 args["route"] = IPUtil.compose_vpp_route_structure(
1718 (raddr_ip1 + i).compressed,
1719 prefix_len=128 if raddr_ip1.version == 6 else 32,
1720 interface=ipip_tunnels[i],
1723 cmd, history=bool(not 1 < i < n_tunnels - 2), **args
1725 err_msg = f"Failed to add IP routes on host {nodes['DUT2']['host']}"
1726 papi_exec.get_replies(err_msg)
1729 def vpp_ipsec_create_tunnel_interfaces(
1744 """Create multiple IPsec tunnel interfaces between two VPP nodes.
1746 Some deployments (e.g. devicetest) need to know the generated keys.
1747 But other deployments (e.g. scale perf test) would get spammed
1748 if we returned keys every time.
1750 :param nodes: VPP nodes to create tunnel interfaces.
1751 :param tun_if1_ip_addr: VPP node 1 ipsec tunnel interface IPv4/IPv6
1753 :param tun_if2_ip_addr: VPP node 2 ipsec tunnel interface IPv4/IPv6
1755 :param if1_key: VPP node 1 interface key from topology file.
1756 :param if2_key: VPP node 2 / TG node (in case of 2-node topology)
1757 interface key from topology file.
1758 :param n_tunnels: Number of tunnel interfaces to be there at the end.
1759 :param crypto_alg: The encryption algorithm name.
1760 :param integ_alg: The integrity algorithm name.
1761 :param raddr_ip1: Policy selector remote IPv4/IPv6 start address for the
1762 first tunnel in direction node1->node2.
1763 :param raddr_ip2: Policy selector remote IPv4/IPv6 start address for the
1764 first tunnel in direction node2->node1.
1765 :param raddr_range: Mask specifying range of Policy selector Remote
1766 IPv4/IPv6 addresses. Valid values are from 1 to 32 in case of IPv4
1767 and to 128 in case of IPv6.
1768 :param existing_tunnels: Number of tunnel interfaces before creation.
1769 Useful mainly for reconf tests. Default 0.
1770 :param return_keys: Whether generated keys should be returned.
1772 :type tun_if1_ip_addr: str
1773 :type tun_if2_ip_addr: str
1776 :type n_tunnels: int
1777 :type crypto_alg: CryptoAlg
1778 :type integ_alg: Optonal[IntegAlg]
1779 :type raddr_ip1: string
1780 :type raddr_ip2: string
1781 :type raddr_range: int
1782 :type existing_tunnels: int
1783 :type return_keys: bool
1784 :returns: Ckeys, ikeys, spi_1, spi_2.
1785 :rtype: Optional[List[bytes], List[bytes], int, int]
1787 n_tunnels = int(n_tunnels)
1788 existing_tunnels = int(existing_tunnels)
1789 spi_d = dict(spi_1=100000, spi_2=200000)
1791 ip1=ip_address(tun_if1_ip_addr), ip2=ip_address(tun_if2_ip_addr)
1793 raddr_ip1 = ip_address(raddr_ip1)
1794 raddr_ip2 = ip_address(raddr_ip2)
1796 1 << (128 - raddr_range)
1797 if tun_ips["ip1"].version == 6
1798 else 1 << (32 - raddr_range)
1801 ckeys, ikeys = IPsecUtil._ipsec_create_tunnel_interfaces_dut1_papi(
1814 if "DUT2" in nodes.keys():
1815 IPsecUtil._ipsec_create_tunnel_interfaces_dut2_papi(
1831 return ckeys, ikeys, spi_d["spi_1"], spi_d["spi_2"]
1835 def _create_ipsec_script_files(dut, instances):
1836 """Create script files for configuring IPsec in containers
1838 :param dut: DUT node on which to create the script files
1839 :param instances: number of containers on DUT node
1841 :type instances: int
1844 for cnf in range(0, instances):
1846 f"/tmp/ipsec_create_tunnel_cnf_{dut}_{cnf + 1}.config"
1848 scripts.append(open(script_filename, "w", encoding="utf-8"))
1852 def _close_and_copy_ipsec_script_files(dut, nodes, instances, scripts):
1853 """Close created scripts and copy them to containers
1855 :param dut: DUT node on which to create the script files
1856 :param nodes: VPP nodes
1857 :param instances: number of containers on DUT node
1858 :param scripts: dictionary holding the script files
1861 :type instances: int
1864 for cnf in range(0, instances):
1865 scripts[cnf].close()
1867 f"/tmp/ipsec_create_tunnel_cnf_{dut}_{cnf + 1}.config"
1869 scp_node(nodes[dut], script_filename, script_filename)
1872 def vpp_ipsec_create_tunnel_interfaces_in_containers(
1884 """Create multiple IPsec tunnel interfaces between two VPP nodes.
1886 :param nodes: VPP nodes to create tunnel interfaces.
1887 :param if1_ip_addr: VPP node 1 interface IP4 address.
1888 :param if2_ip_addr: VPP node 2 interface IP4 address.
1889 :param n_tunnels: Number of tunnell interfaces to create.
1890 :param crypto_alg: The encryption algorithm name.
1891 :param integ_alg: The integrity algorithm name.
1892 :param raddr_ip1: Policy selector remote IPv4 start address for the
1893 first tunnel in direction node1->node2.
1894 :param raddr_ip2: Policy selector remote IPv4 start address for the
1895 first tunnel in direction node2->node1.
1896 :param raddr_range: Mask specifying range of Policy selector Remote
1897 IPv4 addresses. Valid values are from 1 to 32.
1898 :param n_instances: Number of containers.
1900 :type if1_ip_addr: str
1901 :type if2_ip_addr: str
1902 :type n_tunnels: int
1903 :type crypto_alg: CryptoAlg
1904 :type integ_alg: Optional[IntegAlg]
1905 :type raddr_ip1: string
1906 :type raddr_ip2: string
1907 :type raddr_range: int
1908 :type n_instances: int
1912 addr_incr = 1 << (32 - raddr_range)
1914 dut1_scripts = IPsecUtil._create_ipsec_script_files("DUT1", n_instances)
1915 dut2_scripts = IPsecUtil._create_ipsec_script_files("DUT2", n_instances)
1917 for cnf in range(0, n_instances):
1918 dut1_scripts[cnf].write(
1919 "create loopback interface\nset interface state loop0 up\n\n"
1921 dut2_scripts[cnf].write(
1922 f"ip route add {if1_ip_addr}/8 via"
1923 f" {ip_address(if2_ip_addr) + cnf + 100} memif1/{cnf + 1}\n\n"
1926 for tnl in range(0, n_tunnels):
1927 cnf = tnl % n_instances
1929 gen_key(IPsecUtil.get_crypto_alg_key_len(crypto_alg)), "hex"
1933 gen_key(IPsecUtil.get_integ_alg_key_len(integ_alg)), "hex"
1937 f"integ-alg {integ_alg.alg_name}"
1938 f" local-integ-key {ikey}"
1939 f" remote-integ-key {ikey}"
1941 # Configure tunnel end point(s) on left side
1942 dut1_scripts[cnf].write(
1943 "set interface ip address loop0"
1944 f" {ip_address(if1_ip_addr) + tnl * addr_incr}/32\n"
1945 "create ipsec tunnel"
1946 f" local-ip {ip_address(if1_ip_addr) + tnl * addr_incr}"
1947 f" local-spi {spi_1 + tnl}"
1948 f" remote-ip {ip_address(if2_ip_addr) + cnf}"
1949 f" remote-spi {spi_2 + tnl}"
1950 f" crypto-alg {crypto_alg.alg_name}"
1951 f" local-crypto-key {ckey}"
1952 f" remote-crypto-key {ckey}"
1953 f" instance {tnl // n_instances}"
1954 f" salt 0x0 {integ}\n"
1955 f"set interface unnumbered ipip{tnl // n_instances} use loop0\n"
1956 f"set interface state ipip{tnl // n_instances} up\n"
1957 f"ip route add {ip_address(raddr_ip2)+tnl}/32"
1958 f" via ipip{tnl // n_instances}\n\n"
1960 # Configure tunnel end point(s) on right side
1961 dut2_scripts[cnf].write(
1962 f"set ip neighbor memif1/{cnf + 1}"
1963 f" {ip_address(if1_ip_addr) + tnl * addr_incr}"
1964 f" 02:02:00:00:{17:02X}:{cnf:02X} static\n"
1965 f"create ipsec tunnel local-ip {ip_address(if2_ip_addr) + cnf}"
1966 f" local-spi {spi_2 + tnl}"
1967 f" remote-ip {ip_address(if1_ip_addr) + tnl * addr_incr}"
1968 f" remote-spi {spi_1 + tnl}"
1969 f" crypto-alg {crypto_alg.alg_name}"
1970 f" local-crypto-key {ckey}"
1971 f" remote-crypto-key {ckey}"
1972 f" instance {tnl // n_instances}"
1973 f" salt 0x0 {integ}\n"
1974 f"set interface unnumbered ipip{tnl // n_instances}"
1975 f" use memif1/{cnf + 1}\n"
1976 f"set interface state ipip{tnl // n_instances} up\n"
1977 f"ip route add {ip_address(raddr_ip1) + tnl}/32"
1978 f" via ipip{tnl // n_instances}\n\n"
1981 IPsecUtil._close_and_copy_ipsec_script_files(
1982 "DUT1", nodes, n_instances, dut1_scripts
1984 IPsecUtil._close_and_copy_ipsec_script_files(
1985 "DUT2", nodes, n_instances, dut2_scripts
1989 def vpp_ipsec_add_multiple_tunnels(
2001 tunnel_addr_incr=True,
2003 """Create multiple IPsec tunnels between two VPP nodes.
2005 :param nodes: VPP nodes to create tunnels.
2006 :param interface1: Interface name or sw_if_index on node 1.
2007 :param interface2: Interface name or sw_if_index on node 2.
2008 :param n_tunnels: Number of tunnels to create.
2009 :param crypto_alg: The encryption algorithm name.
2010 :param integ_alg: The integrity algorithm name.
2011 :param tunnel_ip1: Tunnel node1 IPv4 address.
2012 :param tunnel_ip2: Tunnel node2 IPv4 address.
2013 :param raddr_ip1: Policy selector remote IPv4 start address for the
2014 first tunnel in direction node1->node2.
2015 :param raddr_ip2: Policy selector remote IPv4 start address for the
2016 first tunnel in direction node2->node1.
2017 :param raddr_range: Mask specifying range of Policy selector Remote
2018 IPv4 addresses. Valid values are from 1 to 32.
2019 :param tunnel_addr_incr: Enable or disable tunnel IP address
2022 :type interface1: str or int
2023 :type interface2: str or int
2024 :type n_tunnels: int
2025 :type crypto_alg: CryptoAlg
2026 :type integ_alg: Optional[IntegAlg]
2027 :type tunnel_ip1: str
2028 :type tunnel_ip2: str
2029 :type raddr_ip1: string
2030 :type raddr_ip2: string
2031 :type raddr_range: int
2032 :type tunnel_addr_incr: bool
2042 crypto_key = gen_key(
2043 IPsecUtil.get_crypto_alg_key_len(crypto_alg)
2046 gen_key(IPsecUtil.get_integ_alg_key_len(integ_alg)).decode()
2052 Topology.get_interface_mac(nodes["DUT2"], interface2)
2053 if "DUT2" in nodes.keys()
2054 else Topology.get_interface_mac(nodes["TG"], interface2)
2056 IPsecUtil.vpp_ipsec_set_ip_route(
2067 IPsecUtil.vpp_ipsec_add_spd(nodes["DUT1"], spd_id)
2068 IPsecUtil.vpp_ipsec_spd_add_if(nodes["DUT1"], spd_id, interface1)
2072 if ip_address(tunnel_ip1).version == 6
2075 for i in range(n_tunnels // (addr_incr**2) + 1):
2076 dut1_local_outbound_range = ip_network(
2077 f"{ip_address(tunnel_ip1) + i*(addr_incr**3)}/8", False
2079 dut1_remote_outbound_range = ip_network(
2080 f"{ip_address(tunnel_ip2) + i*(addr_incr**3)}/8", False
2083 IPsecUtil.vpp_ipsec_add_spd_entry(
2087 PolicyAction.BYPASS,
2090 laddr_range=dut1_local_outbound_range,
2091 raddr_range=dut1_remote_outbound_range,
2093 IPsecUtil.vpp_ipsec_add_spd_entry(
2097 PolicyAction.BYPASS,
2100 laddr_range=dut1_remote_outbound_range,
2101 raddr_range=dut1_local_outbound_range,
2104 IPsecUtil.vpp_ipsec_add_sad_entries(
2118 IPsecUtil.vpp_ipsec_add_spd_entries(
2122 priority=ObjIncrement(p_lo, 0),
2123 action=PolicyAction.PROTECT,
2125 sa_id=ObjIncrement(sa_id_1, 1),
2126 raddr_range=NetworkIncrement(ip_network(raddr_ip2)),
2129 IPsecUtil.vpp_ipsec_add_sad_entries(
2142 IPsecUtil.vpp_ipsec_add_spd_entries(
2146 priority=ObjIncrement(p_lo, 0),
2147 action=PolicyAction.PROTECT,
2149 sa_id=ObjIncrement(sa_id_2, 1),
2150 raddr_range=NetworkIncrement(ip_network(raddr_ip1)),
2153 if "DUT2" in nodes.keys():
2154 rmac = Topology.get_interface_mac(nodes["DUT1"], interface1)
2155 IPsecUtil.vpp_ipsec_set_ip_route(
2166 IPsecUtil.vpp_ipsec_add_spd(nodes["DUT2"], spd_id)
2167 IPsecUtil.vpp_ipsec_spd_add_if(nodes["DUT2"], spd_id, interface2)
2168 for i in range(n_tunnels // (addr_incr**2) + 1):
2169 dut2_local_outbound_range = ip_network(
2170 f"{ip_address(tunnel_ip1) + i*(addr_incr**3)}/8", False
2172 dut2_remote_outbound_range = ip_network(
2173 f"{ip_address(tunnel_ip2) + i*(addr_incr**3)}/8", False
2176 IPsecUtil.vpp_ipsec_add_spd_entry(
2180 PolicyAction.BYPASS,
2183 laddr_range=dut2_remote_outbound_range,
2184 raddr_range=dut2_local_outbound_range,
2186 IPsecUtil.vpp_ipsec_add_spd_entry(
2190 PolicyAction.BYPASS,
2193 laddr_range=dut2_local_outbound_range,
2194 raddr_range=dut2_remote_outbound_range,
2197 IPsecUtil.vpp_ipsec_add_sad_entries(
2210 IPsecUtil.vpp_ipsec_add_spd_entries(
2214 priority=ObjIncrement(p_lo, 0),
2215 action=PolicyAction.PROTECT,
2217 sa_id=ObjIncrement(sa_id_1, 1),
2218 raddr_range=NetworkIncrement(ip_network(raddr_ip2)),
2221 IPsecUtil.vpp_ipsec_add_sad_entries(
2234 IPsecUtil.vpp_ipsec_add_spd_entries(
2238 priority=ObjIncrement(p_lo, 0),
2239 action=PolicyAction.PROTECT,
2241 sa_id=ObjIncrement(sa_id_2, 1),
2242 raddr_range=NetworkIncrement(ip_network(raddr_ip1)),
2246 def vpp_ipsec_show_all(node):
2247 """Run "show ipsec all" debug CLI command.
2249 :param node: Node to run command on.
2252 PapiSocketExecutor.run_cli_cmd(node, "show ipsec all")
2255 def show_ipsec_security_association(node):
2256 """Show IPSec security association.
2258 :param node: DUT node.
2261 cmd = "ipsec_sa_v5_dump"
2262 PapiSocketExecutor.dump_and_log(node, [cmd])
2265 def vpp_ipsec_flow_enable_rss(node, proto, rss_type, function="default"):
2266 """Ipsec flow enable rss action.
2268 :param node: DUT node.
2269 :param proto: The flow protocol.
2270 :param rss_type: RSS type.
2271 :param function: RSS function.
2277 :returns: flow_index.
2279 # TODO: to be fixed to use full PAPI when it is ready in VPP
2281 f"test flow add src-ip any proto {proto} rss function"
2282 f" {function} rss types {rss_type}"
2284 stdout = PapiSocketExecutor.run_cli_cmd(node, cmd)
2285 flow_index = stdout.split()[1]
2290 def vpp_create_ipsec_flows_on_dut(
2291 node, n_flows, rx_queues, spi_start, interface
2293 """Create mutiple ipsec flows and enable flows onto interface.
2295 :param node: DUT node.
2296 :param n_flows: Number of flows to create.
2297 :param rx_queues: NUmber of RX queues.
2298 :param spi_start: The start spi.
2299 :param interface: Name of the interface.
2303 :type rx_queues: int
2304 :type spi_start: int
2305 :type interface: str
2306 :returns: flow_index.
2309 for i in range(0, n_flows):
2310 rx_queue = i % rx_queues
2312 flow_index = FlowUtil.vpp_create_ip4_ipsec_flow(
2313 node, "ESP", spi, "redirect-to-queue", value=rx_queue
2315 FlowUtil.vpp_flow_enable(node, interface, flow_index)