1 from vpp_object import VppObject
2 from ipaddress import ip_address
3 from vpp_papi import VppEnum
4 from vpp_interface import VppInterface
13 return {"packets": 0, "bytes": 0}
16 class VppIpsecSpd(VppObject):
21 def __init__(self, test, id):
25 def add_vpp_config(self):
26 self.test.vapi.ipsec_spd_add_del(self.id)
27 self.test.registry.register(self, self.test.logger)
29 def remove_vpp_config(self):
30 self.test.vapi.ipsec_spd_add_del(self.id, is_add=0)
33 return "ipsec-spd-%d" % self.id
35 def query_vpp_config(self):
36 spds = self.test.vapi.ipsec_spds_dump()
38 if spd.spd_id == self.id:
43 class VppIpsecSpdItfBinding(VppObject):
45 VPP SPD DB to interface binding
46 (i.e. this SPD is used on this interface)
49 def __init__(self, test, spd, itf):
54 def add_vpp_config(self):
55 self.test.vapi.ipsec_interface_add_del_spd(self.spd.id, self.itf.sw_if_index)
56 self.test.registry.register(self, self.test.logger)
58 def remove_vpp_config(self):
59 self.test.vapi.ipsec_interface_add_del_spd(
60 self.spd.id, self.itf.sw_if_index, is_add=0
64 return "bind-%s-to-%s" % (self.spd.id, self.itf)
66 def query_vpp_config(self):
67 bs = self.test.vapi.ipsec_spd_interface_dump()
69 if b.sw_if_index == self.itf.sw_if_index:
74 class VppIpsecSpdEntry(VppObject):
88 proto=socket.IPPROTO_RAW,
93 remote_port_stop=65535,
95 local_port_stop=65535,
100 self.local_start = ip_address(text_type(local_start))
101 self.local_stop = ip_address(text_type(local_stop))
102 self.remote_start = ip_address(text_type(remote_start))
103 self.remote_stop = ip_address(text_type(remote_stop))
105 self.is_outbound = is_outbound
106 self.priority = priority
108 self.policy = VppEnum.vl_api_ipsec_spd_action_t.IPSEC_API_SPD_ACTION_BYPASS
111 self.is_ipv6 = 0 if self.local_start.version == 4 else 1
112 self.local_port_start = local_port_start
113 self.local_port_stop = local_port_stop
114 self.remote_port_start = remote_port_start
115 self.remote_port_stop = remote_port_stop
117 def add_vpp_config(self):
118 rv = self.test.vapi.ipsec_spd_entry_add_del(
126 is_ipv6=self.is_ipv6,
127 is_outbound=self.is_outbound,
128 priority=self.priority,
130 local_port_start=self.local_port_start,
131 local_port_stop=self.local_port_stop,
132 remote_port_start=self.remote_port_start,
133 remote_port_stop=self.remote_port_stop,
135 self.stat_index = rv.stat_index
136 self.test.registry.register(self, self.test.logger)
139 def remove_vpp_config(self):
140 self.test.vapi.ipsec_spd_entry_add_del(
148 is_ipv6=self.is_ipv6,
149 is_outbound=self.is_outbound,
150 priority=self.priority,
152 local_port_start=self.local_port_start,
153 local_port_stop=self.local_port_stop,
154 remote_port_start=self.remote_port_start,
155 remote_port_stop=self.remote_port_stop,
160 return "spd-entry-%d-%d-%d-%d-%d-%d" % (
166 self.remote_port_start,
169 def query_vpp_config(self):
170 ss = self.test.vapi.ipsec_spd_dump(self.spd.id)
173 s.entry.sa_id == self.sa_id
174 and s.entry.is_outbound == self.is_outbound
175 and s.entry.priority == self.priority
176 and s.entry.policy == self.policy
177 and s.entry.remote_address_start == self.remote_start
178 and s.entry.remote_port_start == self.remote_port_start
183 def get_stats(self, worker=None):
184 c = self.test.statistics.get_counter("/net/ipsec/policy")
188 total["packets"] += t[self.stat_index]["packets"]
191 # +1 to skip main thread
192 return c[worker + 1][self.stat_index]
195 class VppIpsecSA(VppObject):
200 DEFAULT_UDP_PORT = 4500
221 anti_replay_window_size=0,
223 e = VppEnum.vl_api_ipsec_sad_flags_t
227 self.integ_alg = integ_alg
228 self.integ_key = integ_key
229 self.crypto_alg = crypto_alg
230 self.crypto_key = crypto_key
233 self.anti_replay_window_size = anti_replay_window_size
236 self.tun_src = tun_src
237 self.tun_dst = tun_dst
239 self.flags = e.IPSEC_API_SAD_FLAG_NONE
243 self.tun_src = ip_address(text_type(tun_src))
244 self.flags = self.flags | e.IPSEC_API_SAD_FLAG_IS_TUNNEL
246 self.tun_dst = ip_address(text_type(tun_dst))
247 self.udp_src = udp_src
248 self.udp_dst = udp_dst
250 VppEnum.vl_api_tunnel_encap_decap_flags_t.TUNNEL_API_ENCAP_DECAP_FLAG_NONE
253 self.tun_flags = tun_flags
254 self.dscp = VppEnum.vl_api_ip_dscp_t.IP_API_DSCP_CS0
259 self.hop_limit = hop_limit
261 def tunnel_encode(self):
263 "src": (self.tun_src if self.tun_src else []),
264 "dst": (self.tun_dst if self.tun_dst else []),
265 "encap_decap_flags": self.tun_flags,
267 "hop_limit": self.hop_limit,
268 "table_id": self.table_id,
271 def add_vpp_config(self):
275 "integrity_algorithm": self.integ_alg,
277 "length": len(self.integ_key),
278 "data": self.integ_key,
280 "crypto_algorithm": self.crypto_alg,
282 "data": self.crypto_key,
283 "length": len(self.crypto_key),
285 "protocol": self.proto,
286 "tunnel": self.tunnel_encode(),
289 "anti_replay_window_size": self.anti_replay_window_size,
291 # don't explicitly send the defaults, let papi fill them in
293 entry["udp_src_port"] = self.udp_src
295 entry["udp_dst_port"] = self.udp_dst
296 r = self.test.vapi.ipsec_sad_entry_add_v2(entry=entry)
297 self.stat_index = r.stat_index
298 self.test.registry.register(self, self.test.logger)
301 def update_vpp_config(
302 self, udp_src=None, udp_dst=None, is_tun=False, tun_src=None, tun_dst=None
306 self.tun_src = ip_address(text_type(tun_src))
308 self.tun_dst = ip_address(text_type(tun_dst))
310 self.udp_src = udp_src
312 self.udp_dst = udp_dst
313 self.test.vapi.ipsec_sad_entry_update(
316 tunnel=self.tunnel_encode(),
317 udp_src_port=udp_src,
318 udp_dst_port=udp_dst,
321 def remove_vpp_config(self):
322 self.test.vapi.ipsec_sad_entry_del(id=self.id)
325 return "ipsec-sa-%d" % self.id
327 def query_vpp_config(self):
328 e = VppEnum.vl_api_ipsec_sad_flags_t
330 bs = self.test.vapi.ipsec_sa_v5_dump()
332 if b.entry.sad_id == self.id:
333 # if udp encap is configured then the ports should match
334 # those configured or the default
335 if self.flags & e.IPSEC_API_SAD_FLAG_UDP_ENCAP:
336 if not b.entry.flags & e.IPSEC_API_SAD_FLAG_UDP_ENCAP:
339 if self.udp_src != b.entry.udp_src_port:
342 if self.DEFAULT_UDP_PORT != b.entry.udp_src_port:
345 if self.udp_dst != b.entry.udp_dst_port:
348 if self.DEFAULT_UDP_PORT != b.entry.udp_dst_port:
353 def get_stats(self, worker=None):
354 c = self.test.statistics.get_counter("/net/ipsec/sa")
358 total["packets"] += t[self.stat_index]["packets"]
361 # +1 to skip main thread
362 return c[worker + 1][self.stat_index]
364 def get_err(self, name, worker=None):
365 c = self.test.statistics.get_counter("/net/ipsec/sa/err/" + name)
369 total += t[self.stat_index]
372 # +1 to skip main thread
373 return c[worker + 1][self.stat_index]
376 class VppIpsecTunProtect(VppObject):
378 VPP IPSEC tunnel protection
381 def __init__(self, test, itf, sa_out, sas_in, nh=None):
386 self.sas_in.append(sa.id)
387 self.sa_out = sa_out.id
392 def update_vpp_config(self, sa_out, sas_in):
395 self.sas_in.append(sa.id)
396 self.sa_out = sa_out.id
397 self.test.vapi.ipsec_tunnel_protect_update(
399 "sw_if_index": self.itf._sw_if_index,
400 "n_sa_in": len(self.sas_in),
401 "sa_out": self.sa_out,
402 "sa_in": self.sas_in,
408 return "ipsec-tun-protect-%s-%s" % (self.itf, self.nh)
410 def add_vpp_config(self):
411 self.test.vapi.ipsec_tunnel_protect_update(
413 "sw_if_index": self.itf._sw_if_index,
414 "n_sa_in": len(self.sas_in),
415 "sa_out": self.sa_out,
416 "sa_in": self.sas_in,
420 self.test.registry.register(self, self.test.logger)
422 def remove_vpp_config(self):
423 self.test.vapi.ipsec_tunnel_protect_del(
424 sw_if_index=self.itf.sw_if_index, nh=self.nh
427 def query_vpp_config(self):
428 bs = self.test.vapi.ipsec_tunnel_protect_dump(sw_if_index=self.itf.sw_if_index)
430 if b.tun.sw_if_index == self.itf.sw_if_index and self.nh == str(b.tun.nh):
435 class VppIpsecInterface(VppInterface):
440 def __init__(self, test, mode=None, instance=0xFFFFFFFF):
441 super(VppIpsecInterface, self).__init__(test)
445 self.mode = VppEnum.vl_api_tunnel_mode_t.TUNNEL_API_MODE_P2P
446 self.instance = instance
448 def add_vpp_config(self):
449 r = self.test.vapi.ipsec_itf_create(
451 "user_instance": self.instance,
455 self.set_sw_if_index(r.sw_if_index)
456 self.test.registry.register(self, self.test.logger)
457 ts = self.test.vapi.ipsec_itf_dump(sw_if_index=self._sw_if_index)
458 self.instance = ts[0].itf.user_instance
461 def remove_vpp_config(self):
462 self.test.vapi.ipsec_itf_delete(sw_if_index=self._sw_if_index)
464 def query_vpp_config(self):
465 ts = self.test.vapi.ipsec_itf_dump(sw_if_index=0xFFFFFFFF)
467 if t.itf.sw_if_index == self._sw_if_index:
472 return self.object_id()
475 return "ipsec%d" % self.instance