test/vpp_ipsec.py

   1 from vpp_object import VppObject
   2 from ipaddress import ip_address
   3 from vpp_papi import VppEnum
   4 from vpp_interface import VppInterface
   5
   6 try:
   7     text_type = unicode
   8 except NameError:
   9     text_type = str
  10
  11
  12 def mk_counter():
  13     return {'packets': 0, 'bytes': 0}
  14
  15
  16 class VppIpsecSpd(VppObject):
  17     """
  18     VPP SPD DB
  19     """
  20
  21     def __init__(self, test, id):
  22         self.test = test
  23         self.id = id
  24
  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)
  28
  29     def remove_vpp_config(self):
  30         self.test.vapi.ipsec_spd_add_del(self.id, is_add=0)
  31
  32     def object_id(self):
  33         return "ipsec-spd-%d" % self.id
  34
  35     def query_vpp_config(self):
  36         spds = self.test.vapi.ipsec_spds_dump()
  37         for spd in spds:
  38             if spd.spd_id == self.id:
  39                 return True
  40         return False
  41
  42
  43 class VppIpsecSpdItfBinding(VppObject):
  44     """
  45     VPP SPD DB to interface binding
  46     (i.e. this SPD is used on this interface)
  47     """
  48
  49     def __init__(self, test, spd, itf):
  50         self.test = test
  51         self.spd = spd
  52         self.itf = itf
  53
  54     def add_vpp_config(self):
  55         self.test.vapi.ipsec_interface_add_del_spd(self.spd.id,
  56                                                    self.itf.sw_if_index)
  57         self.test.registry.register(self, self.test.logger)
  58
  59     def remove_vpp_config(self):
  60         self.test.vapi.ipsec_interface_add_del_spd(self.spd.id,
  61                                                    self.itf.sw_if_index,
  62                                                    is_add=0)
  63
  64     def object_id(self):
  65         return "bind-%s-to-%s" % (self.spd.id, self.itf)
  66
  67     def query_vpp_config(self):
  68         bs = self.test.vapi.ipsec_spd_interface_dump()
  69         for b in bs:
  70             if b.sw_if_index == self.itf.sw_if_index:
  71                 return True
  72         return False
  73
  74
  75 class VppIpsecSpdEntry(VppObject):
  76     """
  77     VPP SPD DB Entry
  78     """
  79
  80     def __init__(self, test, spd, sa_id,
  81                  local_start, local_stop,
  82                  remote_start, remote_stop,
  83                  proto,
  84                  priority=100,
  85                  policy=None,
  86                  is_outbound=1,
  87                  remote_port_start=0,
  88                  remote_port_stop=65535,
  89                  local_port_start=0,
  90                  local_port_stop=65535):
  91         self.test = test
  92         self.spd = spd
  93         self.sa_id = sa_id
  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))
  98         self.proto = proto
  99         self.is_outbound = is_outbound
 100         self.priority = priority
 101         if not policy:
 102             self.policy = (VppEnum.vl_api_ipsec_spd_action_t.
 103                            IPSEC_API_SPD_ACTION_BYPASS)
 104         else:
 105             self.policy = policy
 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
 111
 112     def add_vpp_config(self):
 113         rv = self.test.vapi.ipsec_spd_entry_add_del(
 114             self.spd.id,
 115             self.sa_id,
 116             self.local_start,
 117             self.local_stop,
 118             self.remote_start,
 119             self.remote_stop,
 120             protocol=self.proto,
 121             is_ipv6=self.is_ipv6,
 122             is_outbound=self.is_outbound,
 123             priority=self.priority,
 124             policy=self.policy,
 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)
 131
 132     def remove_vpp_config(self):
 133         self.test.vapi.ipsec_spd_entry_add_del(
 134             self.spd.id,
 135             self.sa_id,
 136             self.local_start,
 137             self.local_stop,
 138             self.remote_start,
 139             self.remote_stop,
 140             protocol=self.proto,
 141             is_ipv6=self.is_ipv6,
 142             is_outbound=self.is_outbound,
 143             priority=self.priority,
 144             policy=self.policy,
 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,
 149             is_add=0)
 150
 151     def object_id(self):
 152         return "spd-entry-%d-%d-%d-%d-%d-%d" % (self.spd.id,
 153                                                 self.priority,
 154                                                 self.policy,
 155                                                 self.is_outbound,
 156                                                 self.is_ipv6,
 157                                                 self.remote_port_start)
 158
 159     def query_vpp_config(self):
 160         ss = self.test.vapi.ipsec_spd_dump(self.spd.id)
 161         for s in ss:
 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:
 168                 return True
 169         return False
 170
 171     def get_stats(self, worker=None):
 172         c = self.test.statistics.get_counter("/net/ipsec/policy")
 173         if worker is None:
 174             total = mk_counter()
 175             for t in c:
 176                 total['packets'] += t[self.stat_index]['packets']
 177             return total
 178         else:
 179             # +1 to skip main thread
 180             return c[worker+1][self.stat_index]
 181
 182
 183 class VppIpsecSA(VppObject):
 184     """
 185     VPP SAD Entry
 186     """
 187
 188     DEFAULT_UDP_PORT = 4500
 189
 190     def __init__(self, test, id, spi,
 191                  integ_alg, integ_key,
 192                  crypto_alg, crypto_key,
 193                  proto,
 194                  tun_src=None, tun_dst=None,
 195                  flags=None, salt=0, tun_flags=None,
 196                  dscp=None,
 197                  udp_src=None, udp_dst=None, hop_limit=None):
 198         e = VppEnum.vl_api_ipsec_sad_flags_t
 199         self.test = test
 200         self.id = id
 201         self.spi = spi
 202         self.integ_alg = integ_alg
 203         self.integ_key = integ_key
 204         self.crypto_alg = crypto_alg
 205         self.crypto_key = crypto_key
 206         self.proto = proto
 207         self.salt = salt
 208
 209         self.table_id = 0
 210         self.tun_src = tun_src
 211         self.tun_dst = tun_dst
 212         if not flags:
 213             self.flags = e.IPSEC_API_SAD_FLAG_NONE
 214         else:
 215             self.flags = flags
 216         if (tun_src):
 217             self.tun_src = ip_address(text_type(tun_src))
 218             self.flags = self.flags | e.IPSEC_API_SAD_FLAG_IS_TUNNEL
 219             if (self.tun_src.version == 6):
 220                 self.flags = self.flags | e.IPSEC_API_SAD_FLAG_IS_TUNNEL_V6
 221         if (tun_dst):
 222             self.tun_dst = ip_address(text_type(tun_dst))
 223         self.udp_src = udp_src
 224         self.udp_dst = udp_dst
 225         self.tun_flags = (VppEnum.vl_api_tunnel_encap_decap_flags_t.
 226                           TUNNEL_API_ENCAP_DECAP_FLAG_NONE)
 227         if tun_flags:
 228             self.tun_flags = tun_flags
 229         self.dscp = VppEnum.vl_api_ip_dscp_t.IP_API_DSCP_CS0
 230         if dscp:
 231             self.dscp = dscp
 232         self.hop_limit = 255
 233         if hop_limit:
 234             self.hop_limit = hop_limit
 235
 236     def tunnel_encode(self):
 237         return {'src': (self.tun_src if self.tun_src else []),
 238                 'dst': (self.tun_dst if self.tun_dst else []),
 239                 'encap_decap_flags': self.tun_flags,
 240                 'dscp': self.dscp,
 241                 'hop_limit': self.hop_limit,
 242                 'table_id': self.table_id
 243                 }
 244
 245     def add_vpp_config(self):
 246         entry = {
 247             'sad_id': self.id,
 248             'spi': self.spi,
 249             'integrity_algorithm': self.integ_alg,
 250             'integrity_key': {
 251                 'length': len(self.integ_key),
 252                 'data': self.integ_key,
 253             },
 254             'crypto_algorithm': self.crypto_alg,
 255             'crypto_key': {
 256                 'data': self.crypto_key,
 257                 'length': len(self.crypto_key),
 258             },
 259             'protocol': self.proto,
 260             'tunnel': self.tunnel_encode(),
 261             'flags': self.flags,
 262             'salt': self.salt
 263         }
 264         # don't explicitly send the defaults, let papi fill them in
 265         if self.udp_src:
 266             entry['udp_src_port'] = self.udp_src
 267         if self.udp_dst:
 268             entry['udp_dst_port'] = self.udp_dst
 269         r = self.test.vapi.ipsec_sad_entry_add_del_v3(is_add=1, entry=entry)
 270         self.stat_index = r.stat_index
 271         self.test.registry.register(self, self.test.logger)
 272         return self
 273
 274     def remove_vpp_config(self):
 275         r = self.test.vapi.ipsec_sad_entry_add_del_v3(
 276             is_add=0,
 277             entry={
 278                 'sad_id': self.id,
 279                 'spi': self.spi,
 280                 'integrity_algorithm': self.integ_alg,
 281                 'integrity_key': {
 282                     'length': len(self.integ_key),
 283                     'data': self.integ_key,
 284                 },
 285                 'crypto_algorithm': self.crypto_alg,
 286                 'crypto_key': {
 287                     'data': self.crypto_key,
 288                     'length': len(self.crypto_key),
 289                 },
 290                 'protocol': self.proto,
 291                 'tunnel': self.tunnel_encode(),
 292                 'salt': self.salt
 293             })
 294
 295     def object_id(self):
 296         return "ipsec-sa-%d" % self.id
 297
 298     def query_vpp_config(self):
 299         e = VppEnum.vl_api_ipsec_sad_flags_t
 300
 301         bs = self.test.vapi.ipsec_sa_v3_dump()
 302         for b in bs:
 303             if b.entry.sad_id == self.id:
 304                 # if udp encap is configured then the ports should match
 305                 # those configured or the default
 306                 if (self.flags & e.IPSEC_API_SAD_FLAG_UDP_ENCAP):
 307                     if not b.entry.flags & e.IPSEC_API_SAD_FLAG_UDP_ENCAP:
 308                         return False
 309                     if self.udp_src:
 310                         if self.udp_src != b.entry.udp_src_port:
 311                             return False
 312                     else:
 313                         if self.DEFAULT_UDP_PORT != b.entry.udp_src_port:
 314                             return False
 315                     if self.udp_dst:
 316                         if self.udp_dst != b.entry.udp_dst_port:
 317                             return False
 318                     else:
 319                         if self.DEFAULT_UDP_PORT != b.entry.udp_dst_port:
 320                             return False
 321                 return True
 322         return False
 323
 324     def get_stats(self, worker=None):
 325         c = self.test.statistics.get_counter("/net/ipsec/sa")
 326         if worker is None:
 327             total = mk_counter()
 328             for t in c:
 329                 total['packets'] += t[self.stat_index]['packets']
 330             return total
 331         else:
 332             # +1 to skip main thread
 333             return c[worker+1][self.stat_index]
 334
 335
 336 class VppIpsecTunProtect(VppObject):
 337     """
 338     VPP IPSEC tunnel protection
 339     """
 340
 341     def __init__(self, test, itf, sa_out, sas_in, nh=None):
 342         self.test = test
 343         self.itf = itf
 344         self.sas_in = []
 345         for sa in sas_in:
 346             self.sas_in.append(sa.id)
 347         self.sa_out = sa_out.id
 348         self.nh = nh
 349         if not self.nh:
 350             self.nh = "0.0.0.0"
 351
 352     def update_vpp_config(self, sa_out, sas_in):
 353         self.sas_in = []
 354         for sa in sas_in:
 355             self.sas_in.append(sa.id)
 356         self.sa_out = sa_out.id
 357         self.test.vapi.ipsec_tunnel_protect_update(
 358             tunnel={
 359                 'sw_if_index': self.itf._sw_if_index,
 360                 'n_sa_in': len(self.sas_in),
 361                 'sa_out': self.sa_out,
 362                 'sa_in': self.sas_in,
 363                 'nh': self.nh})
 364
 365     def object_id(self):
 366         return "ipsec-tun-protect-%s-%s" % (self.itf, self.nh)
 367
 368     def add_vpp_config(self):
 369         self.test.vapi.ipsec_tunnel_protect_update(
 370             tunnel={
 371                 'sw_if_index': self.itf._sw_if_index,
 372                 'n_sa_in': len(self.sas_in),
 373                 'sa_out': self.sa_out,
 374                 'sa_in': self.sas_in,
 375                 'nh': self.nh})
 376         self.test.registry.register(self, self.test.logger)
 377
 378     def remove_vpp_config(self):
 379         self.test.vapi.ipsec_tunnel_protect_del(
 380             sw_if_index=self.itf.sw_if_index,
 381             nh=self.nh)
 382
 383     def query_vpp_config(self):
 384         bs = self.test.vapi.ipsec_tunnel_protect_dump(
 385             sw_if_index=self.itf.sw_if_index)
 386         for b in bs:
 387             if b.tun.sw_if_index == self.itf.sw_if_index and \
 388                self.nh == str(b.tun.nh):
 389                 return True
 390         return False
 391
 392
 393 class VppIpsecInterface(VppInterface):
 394     """
 395     VPP IPSec interface
 396     """
 397
 398     def __init__(self, test, mode=None, instance=0xffffffff):
 399         super(VppIpsecInterface, self).__init__(test)
 400
 401         self.mode = mode
 402         if not self.mode:
 403             self.mode = (VppEnum.vl_api_tunnel_mode_t.
 404                          TUNNEL_API_MODE_P2P)
 405         self.instance = instance
 406
 407     def add_vpp_config(self):
 408         r = self.test.vapi.ipsec_itf_create(itf={
 409             'user_instance': self.instance,
 410             'mode': self.mode,
 411         })
 412         self.set_sw_if_index(r.sw_if_index)
 413         self.test.registry.register(self, self.test.logger)
 414         return self
 415
 416     def remove_vpp_config(self):
 417         self.test.vapi.ipsec_itf_delete(sw_if_index=self._sw_if_index)
 418
 419     def query_vpp_config(self):
 420         ts = self.test.vapi.ipsec_itf_dump(sw_if_index=0xffffffff)
 421         for t in ts:
 422             if t.tunnel.sw_if_index == self._sw_if_index:
 423                 return True
 424         return False
 425
 426     def __str__(self):
 427         return self.object_id()
 428
 429     def object_id(self):
 430         return "ipsec-%d" % self._sw_if_index