test/test_ipsec_esp.py

   1 import socket
   2 import unittest
   3 from scapy.layers.ipsec import ESP
   4 from scapy.layers.inet import UDP
   5
   6 from framework import VppTestRunner
   7 from template_ipsec import IpsecTra46Tests, IpsecTun46Tests, TemplateIpsec, \
   8     IpsecTcpTests, IpsecTun4Tests, IpsecTra4Tests, config_tra_params, \
   9     IPsecIPv4Params, IPsecIPv6Params, \
  10     IpsecTra4, IpsecTun4, IpsecTra6, IpsecTun6
  11 from vpp_ipsec import VppIpsecSpd, VppIpsecSpdEntry, VppIpsecSA,\
  12     VppIpsecSpdItfBinding
  13 from vpp_ip_route import VppIpRoute, VppRoutePath
  14 from vpp_ip import DpoProto
  15 from vpp_papi import VppEnum
  16
  17
  18 class ConfigIpsecESP(TemplateIpsec):
  19     encryption_type = ESP
  20     tra4_encrypt_node_name = "esp4-encrypt"
  21     tra4_decrypt_node_name = "esp4-decrypt"
  22     tra6_encrypt_node_name = "esp6-encrypt"
  23     tra6_decrypt_node_name = "esp6-decrypt"
  24     tun4_encrypt_node_name = "esp4-encrypt"
  25     tun4_decrypt_node_name = "esp4-decrypt"
  26     tun6_encrypt_node_name = "esp6-encrypt"
  27     tun6_decrypt_node_name = "esp6-decrypt"
  28
  29     @classmethod
  30     def setUpClass(cls):
  31         super(ConfigIpsecESP, cls).setUpClass()
  32
  33     @classmethod
  34     def tearDownClass(cls):
  35         super(ConfigIpsecESP, cls).tearDownClass()
  36
  37     def setUp(self):
  38         super(ConfigIpsecESP, self).setUp()
  39
  40     def tearDown(self):
  41         super(ConfigIpsecESP, self).tearDown()
  42
  43     def config_network(self, params):
  44         self.net_objs = []
  45         self.tun_if = self.pg0
  46         self.tra_if = self.pg2
  47         self.logger.info(self.vapi.ppcli("show int addr"))
  48
  49         self.tra_spd = VppIpsecSpd(self, self.tra_spd_id)
  50         self.tra_spd.add_vpp_config()
  51         self.net_objs.append(self.tra_spd)
  52         self.tun_spd = VppIpsecSpd(self, self.tun_spd_id)
  53         self.tun_spd.add_vpp_config()
  54         self.net_objs.append(self.tun_spd)
  55
  56         b = VppIpsecSpdItfBinding(self, self.tun_spd,
  57                                   self.tun_if)
  58         b.add_vpp_config()
  59         self.net_objs.append(b)
  60
  61         b = VppIpsecSpdItfBinding(self, self.tra_spd,
  62                                   self.tra_if)
  63         b.add_vpp_config()
  64         self.net_objs.append(b)
  65
  66         for p in params:
  67             self.config_esp_tra(p)
  68             config_tra_params(p, self.encryption_type)
  69         for p in params:
  70             self.config_esp_tun(p)
  71
  72         for p in params:
  73             d = DpoProto.DPO_PROTO_IP6 if p.is_ipv6 else DpoProto.DPO_PROTO_IP4
  74             r = VppIpRoute(self,  p.remote_tun_if_host, p.addr_len,
  75                            [VppRoutePath(self.tun_if.remote_addr[p.addr_type],
  76                                          0xffffffff,
  77                                          proto=d)],
  78                            is_ip6=p.is_ipv6)
  79             r.add_vpp_config()
  80             self.net_objs.append(r)
  81
  82         self.logger.info(self.vapi.ppcli("show ipsec all"))
  83
  84     def unconfig_network(self):
  85         for o in reversed(self.net_objs):
  86             o.remove_vpp_config()
  87         self.net_objs = []
  88
  89     def config_esp_tun(self, params):
  90         addr_type = params.addr_type
  91         scapy_tun_sa_id = params.scapy_tun_sa_id
  92         scapy_tun_spi = params.scapy_tun_spi
  93         vpp_tun_sa_id = params.vpp_tun_sa_id
  94         vpp_tun_spi = params.vpp_tun_spi
  95         auth_algo_vpp_id = params.auth_algo_vpp_id
  96         auth_key = params.auth_key
  97         crypt_algo_vpp_id = params.crypt_algo_vpp_id
  98         crypt_key = params.crypt_key
  99         remote_tun_if_host = params.remote_tun_if_host
 100         addr_any = params.addr_any
 101         addr_bcast = params.addr_bcast
 102         e = VppEnum.vl_api_ipsec_spd_action_t
 103         flags = params.flags
 104         objs = []
 105
 106         params.tun_sa_in = VppIpsecSA(self, scapy_tun_sa_id, scapy_tun_spi,
 107                                       auth_algo_vpp_id, auth_key,
 108                                       crypt_algo_vpp_id, crypt_key,
 109                                       self.vpp_esp_protocol,
 110                                       self.tun_if.local_addr[addr_type],
 111                                       self.tun_if.remote_addr[addr_type],
 112                                       flags=flags)
 113         params.tun_sa_out = VppIpsecSA(self, vpp_tun_sa_id, vpp_tun_spi,
 114                                        auth_algo_vpp_id, auth_key,
 115                                        crypt_algo_vpp_id, crypt_key,
 116                                        self.vpp_esp_protocol,
 117                                        self.tun_if.remote_addr[addr_type],
 118                                        self.tun_if.local_addr[addr_type],
 119                                        flags=flags)
 120         objs.append(params.tun_sa_in)
 121         objs.append(params.tun_sa_out)
 122
 123         params.spd_policy_in_any = VppIpsecSpdEntry(self, self.tun_spd,
 124                                                     scapy_tun_sa_id,
 125                                                     addr_any, addr_bcast,
 126                                                     addr_any, addr_bcast,
 127                                                     socket.IPPROTO_ESP)
 128         params.spd_policy_out_any = VppIpsecSpdEntry(self, self.tun_spd,
 129                                                      scapy_tun_sa_id,
 130                                                      addr_any, addr_bcast,
 131                                                      addr_any, addr_bcast,
 132                                                      socket.IPPROTO_ESP,
 133                                                      is_outbound=0)
 134         objs.append(params.spd_policy_out_any)
 135         objs.append(params.spd_policy_in_any)
 136
 137         objs.append(VppIpsecSpdEntry(self, self.tun_spd, vpp_tun_sa_id,
 138                                      remote_tun_if_host, remote_tun_if_host,
 139                                      self.pg1.remote_addr[addr_type],
 140                                      self.pg1.remote_addr[addr_type],
 141                                      0,
 142                                      priority=10,
 143                                      policy=e.IPSEC_API_SPD_ACTION_PROTECT,
 144                                      is_outbound=0))
 145         objs.append(VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
 146                                      self.pg1.remote_addr[addr_type],
 147                                      self.pg1.remote_addr[addr_type],
 148                                      remote_tun_if_host, remote_tun_if_host,
 149                                      0,
 150                                      policy=e.IPSEC_API_SPD_ACTION_PROTECT,
 151                                      priority=10))
 152         objs.append(VppIpsecSpdEntry(self, self.tun_spd, vpp_tun_sa_id,
 153                                      remote_tun_if_host, remote_tun_if_host,
 154                                      self.pg0.local_addr[addr_type],
 155                                      self.pg0.local_addr[addr_type],
 156                                      0,
 157                                      priority=20,
 158                                      policy=e.IPSEC_API_SPD_ACTION_PROTECT,
 159                                      is_outbound=0))
 160         objs.append(VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
 161                                      self.pg0.local_addr[addr_type],
 162                                      self.pg0.local_addr[addr_type],
 163                                      remote_tun_if_host, remote_tun_if_host,
 164                                      0,
 165                                      policy=e.IPSEC_API_SPD_ACTION_PROTECT,
 166                                      priority=20))
 167         for o in objs:
 168             o.add_vpp_config()
 169         self.net_objs = self.net_objs + objs
 170
 171     def config_esp_tra(self, params):
 172         addr_type = params.addr_type
 173         scapy_tra_sa_id = params.scapy_tra_sa_id
 174         scapy_tra_spi = params.scapy_tra_spi
 175         vpp_tra_sa_id = params.vpp_tra_sa_id
 176         vpp_tra_spi = params.vpp_tra_spi
 177         auth_algo_vpp_id = params.auth_algo_vpp_id
 178         auth_key = params.auth_key
 179         crypt_algo_vpp_id = params.crypt_algo_vpp_id
 180         crypt_key = params.crypt_key
 181         addr_any = params.addr_any
 182         addr_bcast = params.addr_bcast
 183         flags = (VppEnum.vl_api_ipsec_sad_flags_t.
 184                  IPSEC_API_SAD_FLAG_USE_ANTI_REPLAY)
 185         e = VppEnum.vl_api_ipsec_spd_action_t
 186         flags = params.flags | flags
 187         objs = []
 188
 189         params.tra_sa_in = VppIpsecSA(self, scapy_tra_sa_id, scapy_tra_spi,
 190                                       auth_algo_vpp_id, auth_key,
 191                                       crypt_algo_vpp_id, crypt_key,
 192                                       self.vpp_esp_protocol,
 193                                       flags=flags)
 194         params.tra_sa_out = VppIpsecSA(self, vpp_tra_sa_id, vpp_tra_spi,
 195                                        auth_algo_vpp_id, auth_key,
 196                                        crypt_algo_vpp_id, crypt_key,
 197                                        self.vpp_esp_protocol,
 198                                        flags=flags)
 199         objs.append(params.tra_sa_in)
 200         objs.append(params.tra_sa_out)
 201
 202         objs.append(VppIpsecSpdEntry(self, self.tra_spd, vpp_tra_sa_id,
 203                                      addr_any, addr_bcast,
 204                                      addr_any, addr_bcast,
 205                                      socket.IPPROTO_ESP))
 206         objs.append(VppIpsecSpdEntry(self, self.tra_spd, vpp_tra_sa_id,
 207                                      addr_any, addr_bcast,
 208                                      addr_any, addr_bcast,
 209                                      socket.IPPROTO_ESP,
 210                                      is_outbound=0))
 211         objs.append(VppIpsecSpdEntry(self, self.tra_spd, vpp_tra_sa_id,
 212                                      self.tra_if.local_addr[addr_type],
 213                                      self.tra_if.local_addr[addr_type],
 214                                      self.tra_if.remote_addr[addr_type],
 215                                      self.tra_if.remote_addr[addr_type],
 216                                      0, priority=10,
 217                                      policy=e.IPSEC_API_SPD_ACTION_PROTECT,
 218                                      is_outbound=0))
 219         objs.append(VppIpsecSpdEntry(self, self.tra_spd, scapy_tra_sa_id,
 220                                      self.tra_if.local_addr[addr_type],
 221                                      self.tra_if.local_addr[addr_type],
 222                                      self.tra_if.remote_addr[addr_type],
 223                                      self.tra_if.remote_addr[addr_type],
 224                                      0, policy=e.IPSEC_API_SPD_ACTION_PROTECT,
 225                                      priority=10))
 226         for o in objs:
 227             o.add_vpp_config()
 228         self.net_objs = self.net_objs + objs
 229
 230
 231 class TemplateIpsecEsp(ConfigIpsecESP):
 232     """
 233     Basic test for ipsec esp sanity - tunnel and transport modes.
 234
 235     Below 4 cases are covered as part of this test
 236     1) ipsec esp v4 transport basic test  - IPv4 Transport mode
 237         scenario using HMAC-SHA1-96 integrity algo
 238     2) ipsec esp v4 transport burst test
 239         Above test for 257 pkts
 240     3) ipsec esp 4o4 tunnel basic test    - IPv4 Tunnel mode
 241         scenario using HMAC-SHA1-96 integrity algo
 242     4) ipsec esp 4o4 tunnel burst test
 243         Above test for 257 pkts
 244
 245     TRANSPORT MODE:
 246
 247      ---   encrypt   ---
 248     |pg2| <-------> |VPP|
 249      ---   decrypt   ---
 250
 251     TUNNEL MODE:
 252
 253      ---   encrypt   ---   plain   ---
 254     |pg0| <-------  |VPP| <------ |pg1|
 255      ---             ---           ---
 256
 257      ---   decrypt   ---   plain   ---
 258     |pg0| ------->  |VPP| ------> |pg1|
 259      ---             ---           ---
 260     """
 261
 262     @classmethod
 263     def setUpClass(cls):
 264         super(TemplateIpsecEsp, cls).setUpClass()
 265
 266     @classmethod
 267     def tearDownClass(cls):
 268         super(TemplateIpsecEsp, cls).tearDownClass()
 269
 270     def setUp(self):
 271         super(TemplateIpsecEsp, self).setUp()
 272         self.config_network(self.params.values())
 273
 274     def tearDown(self):
 275         self.unconfig_network()
 276         super(TemplateIpsecEsp, self).tearDown()
 277
 278
 279 class TestIpsecEsp1(TemplateIpsecEsp, IpsecTra46Tests, IpsecTun46Tests):
 280     """ Ipsec ESP - TUN & TRA tests """
 281     pass
 282
 283
 284 class TestIpsecEsp2(TemplateIpsecEsp, IpsecTcpTests):
 285     """ Ipsec ESP - TCP tests """
 286     pass
 287
 288
 289 class TemplateIpsecEspUdp(ConfigIpsecESP):
 290     """
 291     UDP encapped ESP
 292     """
 293
 294     @classmethod
 295     def setUpClass(cls):
 296         super(TemplateIpsecEspUdp, cls).setUpClass()
 297
 298     @classmethod
 299     def tearDownClass(cls):
 300         super(TemplateIpsecEspUdp, cls).tearDownClass()
 301
 302     def setUp(self):
 303         super(TemplateIpsecEspUdp, self).setUp()
 304         self.net_objs = []
 305         self.tun_if = self.pg0
 306         self.tra_if = self.pg2
 307         self.logger.info(self.vapi.ppcli("show int addr"))
 308
 309         p = self.ipv4_params
 310         p.flags = (VppEnum.vl_api_ipsec_sad_flags_t.
 311                    IPSEC_API_SAD_FLAG_UDP_ENCAP)
 312         p.nat_header = UDP(sport=5454, dport=4500)
 313
 314         self.tra_spd = VppIpsecSpd(self, self.tra_spd_id)
 315         self.tra_spd.add_vpp_config()
 316         VppIpsecSpdItfBinding(self, self.tra_spd,
 317                               self.tra_if).add_vpp_config()
 318
 319         self.config_esp_tra(p)
 320         config_tra_params(p, self.encryption_type)
 321
 322         self.tun_spd = VppIpsecSpd(self, self.tun_spd_id)
 323         self.tun_spd.add_vpp_config()
 324         VppIpsecSpdItfBinding(self, self.tun_spd,
 325                               self.tun_if).add_vpp_config()
 326
 327         self.config_esp_tun(p)
 328         self.logger.info(self.vapi.ppcli("show ipsec all"))
 329
 330         d = DpoProto.DPO_PROTO_IP4
 331         VppIpRoute(self,  p.remote_tun_if_host, p.addr_len,
 332                    [VppRoutePath(self.tun_if.remote_addr[p.addr_type],
 333                                  0xffffffff,
 334                                  proto=d)]).add_vpp_config()
 335
 336     def tearDown(self):
 337         super(TemplateIpsecEspUdp, self).tearDown()
 338
 339     def show_commands_at_teardown(self):
 340         self.logger.info(self.vapi.cli("show hardware"))
 341
 342
 343 class TestIpsecEspUdp(TemplateIpsecEspUdp, IpsecTra4Tests):
 344     """ Ipsec NAT-T ESP UDP tests """
 345     pass
 346
 347
 348 class TestIpsecEspAll(ConfigIpsecESP,
 349                       IpsecTra4, IpsecTra6,
 350                       IpsecTun4, IpsecTun6):
 351     """ Ipsec ESP all Algos """
 352
 353     def setUp(self):
 354         super(TestIpsecEspAll, self).setUp()
 355
 356     def tearDown(self):
 357         super(TestIpsecEspAll, self).tearDown()
 358
 359     def test_crypto_algs(self):
 360         """All engines AES-CBC-[128, 192, 256] w/ & w/o ESN"""
 361
 362         # foreach VPP crypto engine
 363         engines = ["ia32", "ipsecmb", "openssl"]
 364
 365         # foreach crypto algorithm
 366         algos = [{'vpp': VppEnum.vl_api_ipsec_crypto_alg_t.
 367                   IPSEC_API_CRYPTO_ALG_AES_CBC_128,
 368                   'scapy': "AES-CBC",
 369                   'key': "JPjyOWBeVEQiMe7h"},
 370                  {'vpp': VppEnum.vl_api_ipsec_crypto_alg_t.
 371                   IPSEC_API_CRYPTO_ALG_AES_CBC_192,
 372                   'scapy': "AES-CBC",
 373                   'key': "JPjyOWBeVEQiMe7hJPjyOWBe"},
 374                  {'vpp': VppEnum.vl_api_ipsec_crypto_alg_t.
 375                   IPSEC_API_CRYPTO_ALG_AES_CBC_256,
 376                   'scapy': "AES-CBC",
 377                   'key': "JPjyOWBeVEQiMe7hJPjyOWBeVEQiMe7h"}]
 378
 379         # with and without ESN
 380         flags = [0,
 381                  VppEnum.vl_api_ipsec_sad_flags_t.IPSEC_API_SAD_FLAG_USE_ESN]
 382
 383         #
 384         # loop through the VPP engines
 385         #
 386         for engine in engines:
 387             self.vapi.cli("set crypto handler all %s" % engine)
 388
 389             #
 390             # loop through each of the algorithms
 391             #
 392             for algo in algos:
 393                 # with self.subTest(algo=algo['scapy']):
 394                 for flag in flags:
 395                     #
 396                     # setup up the config paramters
 397                     #
 398                     self.ipv4_params = IPsecIPv4Params()
 399                     self.ipv6_params = IPsecIPv6Params()
 400
 401                     self.params = {self.ipv4_params.addr_type:
 402                                    self.ipv4_params,
 403                                    self.ipv6_params.addr_type:
 404                                    self.ipv6_params}
 405
 406                     for _, p in self.params.items():
 407                         p.crypt_algo_vpp_id = algo['vpp']
 408                         p.crypt_algo = algo['scapy']
 409                         p.crypt_key = algo['key']
 410                         p.flags = p.flags | flag
 411
 412                     #
 413                     # configure the SPDs. SAs, etc
 414                     #
 415                     self.config_network(self.params.values())
 416
 417                     #
 418                     # run some traffic.
 419                     #  An exhautsive 4o6, 6o4 is not necessary
 420                     #  for each algo
 421                     #
 422                     self.verify_tra_basic6(count=17)
 423                     self.verify_tra_basic4(count=17)
 424                     self.verify_tun_66(self.params[socket.AF_INET6], 1)
 425                     self.verify_tun_44(self.params[socket.AF_INET], 1)
 426
 427                     #
 428                     # remove the SPDs, SAs, etc
 429                     #
 430                     self.unconfig_network()
 431
 432
 433 if __name__ == '__main__':
 434     unittest.main(testRunner=VppTestRunner)