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,
57 self.test.registry.register(self, self.test.logger)
59 def remove_vpp_config(self):
60 self.test.vapi.ipsec_interface_add_del_spd(self.spd.id,
65 return "bind-%s-to-%s" % (self.spd.id, self.itf)
67 def query_vpp_config(self):
68 bs = self.test.vapi.ipsec_spd_interface_dump()
70 if b.sw_if_index == self.itf.sw_if_index:
75 class VppIpsecSpdEntry(VppObject):
80 def __init__(self, test, spd, sa_id,
81 local_start, local_stop,
82 remote_start, remote_stop,
88 remote_port_stop=65535,
90 local_port_stop=65535):
94 self.local_start = ip_address(text_type(local_start))
95 self.local_stop = ip_address(text_type(local_stop))
96 self.remote_start = ip_address(text_type(remote_start))
97 self.remote_stop = ip_address(text_type(remote_stop))
99 self.is_outbound = is_outbound
100 self.priority = priority
102 self.policy = (VppEnum.vl_api_ipsec_spd_action_t.
103 IPSEC_API_SPD_ACTION_BYPASS)
106 self.is_ipv6 = (0 if self.local_start.version == 4 else 1)
107 self.local_port_start = local_port_start
108 self.local_port_stop = local_port_stop
109 self.remote_port_start = remote_port_start
110 self.remote_port_stop = remote_port_stop
112 def add_vpp_config(self):
113 rv = self.test.vapi.ipsec_spd_entry_add_del(
121 is_ipv6=self.is_ipv6,
122 is_outbound=self.is_outbound,
123 priority=self.priority,
125 local_port_start=self.local_port_start,
126 local_port_stop=self.local_port_stop,
127 remote_port_start=self.remote_port_start,
128 remote_port_stop=self.remote_port_stop)
129 self.stat_index = rv.stat_index
130 self.test.registry.register(self, self.test.logger)
132 def remove_vpp_config(self):
133 self.test.vapi.ipsec_spd_entry_add_del(
141 is_ipv6=self.is_ipv6,
142 is_outbound=self.is_outbound,
143 priority=self.priority,
145 local_port_start=self.local_port_start,
146 local_port_stop=self.local_port_stop,
147 remote_port_start=self.remote_port_start,
148 remote_port_stop=self.remote_port_stop,
152 return "spd-entry-%d-%d-%d-%d-%d-%d" % (self.spd.id,
157 self.remote_port_start)
159 def query_vpp_config(self):
160 ss = self.test.vapi.ipsec_spd_dump(self.spd.id)
162 if s.entry.sa_id == self.sa_id and \
163 s.entry.is_outbound == self.is_outbound and \
164 s.entry.priority == self.priority and \
165 s.entry.policy == self.policy and \
166 s.entry.remote_address_start == self.remote_start and \
167 s.entry.remote_port_start == self.remote_port_start:
171 def get_stats(self, worker=None):
172 c = self.test.statistics.get_counter("/net/ipsec/policy")
176 total['packets'] += t[self.stat_index]['packets']
179 # +1 to skip main thread
180 return c[worker+1][self.stat_index]
183 class VppIpsecSA(VppObject):
188 DEFAULT_UDP_PORT = 4500
190 def __init__(self, test, id, spi,
191 integ_alg, integ_key,
192 crypto_alg, crypto_key,
194 tun_src=None, tun_dst=None,
195 flags=None, salt=0, tun_flags=None,
197 udp_src=None, udp_dst=None):
198 e = VppEnum.vl_api_ipsec_sad_flags_t
202 self.integ_alg = integ_alg
203 self.integ_key = integ_key
204 self.crypto_alg = crypto_alg
205 self.crypto_key = crypto_key
209 self.tun_src = tun_src
210 self.tun_dst = tun_dst
212 self.flags = e.IPSEC_API_SAD_FLAG_NONE
216 self.tun_src = ip_address(text_type(tun_src))
217 self.flags = self.flags | e.IPSEC_API_SAD_FLAG_IS_TUNNEL
218 if (self.tun_src.version == 6):
219 self.flags = self.flags | e.IPSEC_API_SAD_FLAG_IS_TUNNEL_V6
221 self.tun_dst = ip_address(text_type(tun_dst))
222 self.udp_src = udp_src
223 self.udp_dst = udp_dst
224 self.tun_flags = (VppEnum.vl_api_tunnel_encap_decap_flags_t.
225 TUNNEL_API_ENCAP_DECAP_FLAG_NONE)
227 self.tun_flags = tun_flags
228 self.dscp = VppEnum.vl_api_ip_dscp_t.IP_API_DSCP_CS0
232 def add_vpp_config(self):
236 'integrity_algorithm': self.integ_alg,
238 'length': len(self.integ_key),
239 'data': self.integ_key,
241 'crypto_algorithm': self.crypto_alg,
243 'data': self.crypto_key,
244 'length': len(self.crypto_key),
246 'protocol': self.proto,
247 'tunnel_src': (self.tun_src if self.tun_src else []),
248 'tunnel_dst': (self.tun_dst if self.tun_dst else []),
249 'tunnel_flags': self.tun_flags,
254 # don't explicitly send the defaults, let papi fill them in
256 entry['udp_src_port'] = self.udp_src
258 entry['udp_dst_port'] = self.udp_dst
259 r = self.test.vapi.ipsec_sad_entry_add_del_v2(is_add=1, entry=entry)
260 self.stat_index = r.stat_index
261 self.test.registry.register(self, self.test.logger)
263 def remove_vpp_config(self):
264 r = self.test.vapi.ipsec_sad_entry_add_del_v2(
269 'integrity_algorithm': self.integ_alg,
271 'length': len(self.integ_key),
272 'data': self.integ_key,
274 'crypto_algorithm': self.crypto_alg,
276 'data': self.crypto_key,
277 'length': len(self.crypto_key),
279 'protocol': self.proto,
280 'tunnel_src': (self.tun_src if self.tun_src else []),
281 'tunnel_dst': (self.tun_dst if self.tun_dst else []),
287 return "ipsec-sa-%d" % self.id
289 def query_vpp_config(self):
290 e = VppEnum.vl_api_ipsec_sad_flags_t
292 bs = self.test.vapi.ipsec_sa_v2_dump()
294 if b.entry.sad_id == self.id:
295 # if udp encap is configured then the ports should match
296 # those configured or the default
297 if (self.flags & e.IPSEC_API_SAD_FLAG_UDP_ENCAP):
298 if not b.entry.flags & e.IPSEC_API_SAD_FLAG_UDP_ENCAP:
301 if self.udp_src != b.entry.udp_src_port:
304 if self.DEFAULT_UDP_PORT != b.entry.udp_src_port:
307 if self.udp_dst != b.entry.udp_dst_port:
310 if self.DEFAULT_UDP_PORT != b.entry.udp_dst_port:
315 def get_stats(self, worker=None):
316 c = self.test.statistics.get_counter("/net/ipsec/sa")
320 total['packets'] += t[self.stat_index]['packets']
323 # +1 to skip main thread
324 return c[worker+1][self.stat_index]
327 class VppIpsecTunProtect(VppObject):
329 VPP IPSEC tunnel protection
332 def __init__(self, test, itf, sa_out, sas_in, nh=None):
337 self.sas_in.append(sa.id)
338 self.sa_out = sa_out.id
343 def update_vpp_config(self, sa_out, sas_in):
346 self.sas_in.append(sa.id)
347 self.sa_out = sa_out.id
348 self.test.vapi.ipsec_tunnel_protect_update(
350 'sw_if_index': self.itf._sw_if_index,
351 'n_sa_in': len(self.sas_in),
352 'sa_out': self.sa_out,
353 'sa_in': self.sas_in,
357 return "ipsec-tun-protect-%s-%s" % (self.itf, self.nh)
359 def add_vpp_config(self):
360 self.test.vapi.ipsec_tunnel_protect_update(
362 'sw_if_index': self.itf._sw_if_index,
363 'n_sa_in': len(self.sas_in),
364 'sa_out': self.sa_out,
365 'sa_in': self.sas_in,
367 self.test.registry.register(self, self.test.logger)
369 def remove_vpp_config(self):
370 self.test.vapi.ipsec_tunnel_protect_del(
371 sw_if_index=self.itf.sw_if_index,
374 def query_vpp_config(self):
375 bs = self.test.vapi.ipsec_tunnel_protect_dump(
376 sw_if_index=self.itf.sw_if_index)
378 if b.tun.sw_if_index == self.itf.sw_if_index and \
379 self.nh == str(b.tun.nh):
384 class VppIpsecInterface(VppInterface):
389 def __init__(self, test, mode=None, instance=0xffffffff):
390 super(VppIpsecInterface, self).__init__(test)
394 self.mode = (VppEnum.vl_api_tunnel_mode_t.
396 self.instance = instance
398 def add_vpp_config(self):
399 r = self.test.vapi.ipsec_itf_create(itf={
400 'user_instance': self.instance,
403 self.set_sw_if_index(r.sw_if_index)
404 self.test.registry.register(self, self.test.logger)
407 def remove_vpp_config(self):
408 self.test.vapi.ipsec_itf_delete(sw_if_index=self._sw_if_index)
410 def query_vpp_config(self):
411 ts = self.test.vapi.ipsec_itf_dump(sw_if_index=0xffffffff)
413 if t.tunnel.sw_if_index == self._sw_if_index:
418 return self.object_id()
421 return "ipsec-%d" % self._sw_if_index