src/plugins/nat/test/test_nat44_ed.py

   1 #!/usr/bin/env python3
   2
   3 import unittest
   4 from io import BytesIO
   5 from random import randint, shuffle, choice
   6
   7 import scapy.compat
   8 from framework import VppTestCase, VppTestRunner
   9 from scapy.data import IP_PROTOS
  10 from scapy.layers.inet import IP, TCP, UDP, ICMP, GRE
  11 from scapy.layers.inet import IPerror, TCPerror
  12 from scapy.layers.l2 import Ether
  13 from scapy.packet import Raw
  14 from syslog_rfc5424_parser import SyslogMessage, ParseError
  15 from syslog_rfc5424_parser.constants import SyslogSeverity
  16 from util import ppp, ip4_range
  17 from vpp_acl import AclRule, VppAcl, VppAclInterface
  18 from vpp_ip_route import VppIpRoute, VppRoutePath
  19 from vpp_papi import VppEnum
  20
  21
  22 class NAT44EDTestCase(VppTestCase):
  23
  24     nat_addr = '10.0.0.3'
  25
  26     tcp_port_in = 6303
  27     tcp_port_out = 6303
  28
  29     udp_port_in = 6304
  30     udp_port_out = 6304
  31
  32     icmp_id_in = 6305
  33     icmp_id_out = 6305
  34
  35     tcp_external_port = 80
  36
  37     max_sessions = 100
  38
  39     def setUp(self):
  40         super(NAT44EDTestCase, self).setUp()
  41         self.plugin_enable()
  42
  43     def tearDown(self):
  44         super(NAT44EDTestCase, self).tearDown()
  45         if not self.vpp_dead:
  46             self.plugin_disable()
  47
  48     def plugin_enable(self):
  49         self.vapi.nat44_ed_plugin_enable_disable(
  50             sessions=self.max_sessions, enable=1)
  51
  52     def plugin_disable(self):
  53         self.vapi.nat44_ed_plugin_enable_disable(enable=0)
  54
  55     @property
  56     def config_flags(self):
  57         return VppEnum.vl_api_nat_config_flags_t
  58
  59     @property
  60     def nat44_config_flags(self):
  61         return VppEnum.vl_api_nat44_config_flags_t
  62
  63     @property
  64     def syslog_severity(self):
  65         return VppEnum.vl_api_syslog_severity_t
  66
  67     @property
  68     def server_addr(self):
  69         return self.pg1.remote_hosts[0].ip4
  70
  71     @staticmethod
  72     def random_port():
  73         return randint(1025, 65535)
  74
  75     @staticmethod
  76     def proto2layer(proto):
  77         if proto == IP_PROTOS.tcp:
  78             return TCP
  79         elif proto == IP_PROTOS.udp:
  80             return UDP
  81         elif proto == IP_PROTOS.icmp:
  82             return ICMP
  83         else:
  84             raise Exception("Unsupported protocol")
  85
  86     @classmethod
  87     def create_and_add_ip4_table(cls, i, table_id=0):
  88         cls.vapi.ip_table_add_del(is_add=1, table={'table_id': table_id})
  89         i.set_table_ip4(table_id)
  90
  91     @classmethod
  92     def configure_ip4_interface(cls, i, hosts=0, table_id=None):
  93         if table_id:
  94             cls.create_and_add_ip4_table(i, table_id)
  95
  96         i.admin_up()
  97         i.config_ip4()
  98         i.resolve_arp()
  99
 100         if hosts:
 101             i.generate_remote_hosts(hosts)
 102             i.configure_ipv4_neighbors()
 103
 104     @classmethod
 105     def nat_add_interface_address(cls, i):
 106         cls.vapi.nat44_add_del_interface_addr(
 107             sw_if_index=i.sw_if_index, is_add=1)
 108
 109     def nat_add_inside_interface(self, i):
 110         self.vapi.nat44_interface_add_del_feature(
 111             flags=self.config_flags.NAT_IS_INSIDE,
 112             sw_if_index=i.sw_if_index, is_add=1)
 113
 114     def nat_add_outside_interface(self, i):
 115         self.vapi.nat44_interface_add_del_feature(
 116             flags=self.config_flags.NAT_IS_OUTSIDE,
 117             sw_if_index=i.sw_if_index, is_add=1)
 118
 119     def nat_add_address(self, address, twice_nat=0,
 120                         vrf_id=0xFFFFFFFF, is_add=1):
 121         flags = self.config_flags.NAT_IS_TWICE_NAT if twice_nat else 0
 122         self.vapi.nat44_add_del_address_range(first_ip_address=address,
 123                                               last_ip_address=address,
 124                                               vrf_id=vrf_id,
 125                                               is_add=is_add,
 126                                               flags=flags)
 127
 128     def nat_add_static_mapping(self, local_ip, external_ip='0.0.0.0',
 129                                local_port=0, external_port=0, vrf_id=0,
 130                                is_add=1, external_sw_if_index=0xFFFFFFFF,
 131                                proto=0, tag="", flags=0):
 132
 133         if not (local_port and external_port):
 134             flags |= self.config_flags.NAT_IS_ADDR_ONLY
 135
 136         self.vapi.nat44_add_del_static_mapping(
 137             is_add=is_add,
 138             local_ip_address=local_ip,
 139             external_ip_address=external_ip,
 140             external_sw_if_index=external_sw_if_index,
 141             local_port=local_port,
 142             external_port=external_port,
 143             vrf_id=vrf_id, protocol=proto,
 144             flags=flags,
 145             tag=tag)
 146
 147     @classmethod
 148     def setUpClass(cls):
 149         super(NAT44EDTestCase, cls).setUpClass()
 150
 151         cls.create_pg_interfaces(range(12))
 152         cls.interfaces = list(cls.pg_interfaces[:4])
 153
 154         cls.create_and_add_ip4_table(cls.pg2, 10)
 155
 156         for i in cls.interfaces:
 157             cls.configure_ip4_interface(i, hosts=3)
 158
 159         # test specific (test-multiple-vrf)
 160         cls.vapi.ip_table_add_del(is_add=1, table={'table_id': 1})
 161
 162         # test specific (test-one-armed-nat44-static)
 163         cls.pg4.generate_remote_hosts(2)
 164         cls.pg4.config_ip4()
 165         cls.vapi.sw_interface_add_del_address(
 166             sw_if_index=cls.pg4.sw_if_index,
 167             prefix="10.0.0.1/24")
 168         cls.pg4.admin_up()
 169         cls.pg4.resolve_arp()
 170         cls.pg4._remote_hosts[1]._ip4 = cls.pg4._remote_hosts[0]._ip4
 171         cls.pg4.resolve_arp()
 172
 173         # test specific interface (pg5)
 174         cls.pg5._local_ip4 = "10.1.1.1"
 175         cls.pg5._remote_hosts[0]._ip4 = "10.1.1.2"
 176         cls.pg5.set_table_ip4(1)
 177         cls.pg5.config_ip4()
 178         cls.pg5.admin_up()
 179         cls.pg5.resolve_arp()
 180
 181         # test specific interface (pg6)
 182         cls.pg6._local_ip4 = "10.1.2.1"
 183         cls.pg6._remote_hosts[0]._ip4 = "10.1.2.2"
 184         cls.pg6.set_table_ip4(1)
 185         cls.pg6.config_ip4()
 186         cls.pg6.admin_up()
 187         cls.pg6.resolve_arp()
 188
 189         rl = list()
 190
 191         rl.append(VppIpRoute(cls, "0.0.0.0", 0,
 192                              [VppRoutePath("0.0.0.0", 0xffffffff,
 193                                            nh_table_id=0)],
 194                              register=False, table_id=1))
 195         rl.append(VppIpRoute(cls, "0.0.0.0", 0,
 196                              [VppRoutePath(cls.pg1.local_ip4,
 197                                            cls.pg1.sw_if_index)],
 198                              register=False))
 199         rl.append(VppIpRoute(cls, cls.pg5.remote_ip4, 32,
 200                              [VppRoutePath("0.0.0.0",
 201                                            cls.pg5.sw_if_index)],
 202                              register=False, table_id=1))
 203         rl.append(VppIpRoute(cls, cls.pg6.remote_ip4, 32,
 204                              [VppRoutePath("0.0.0.0",
 205                                            cls.pg6.sw_if_index)],
 206                              register=False, table_id=1))
 207         rl.append(VppIpRoute(cls, cls.pg6.remote_ip4, 16,
 208                              [VppRoutePath("0.0.0.0", 0xffffffff,
 209                                            nh_table_id=1)],
 210                              register=False, table_id=0))
 211
 212         for r in rl:
 213             r.add_vpp_config()
 214
 215     def get_err_counter(self, path):
 216         return self.statistics.get_err_counter(path)
 217
 218     def reass_hairpinning(self, server_addr, server_in_port, server_out_port,
 219                           host_in_port, proto=IP_PROTOS.tcp,
 220                           ignore_port=False):
 221         layer = self.proto2layer(proto)
 222
 223         if proto == IP_PROTOS.tcp:
 224             data = b"A" * 4 + b"B" * 16 + b"C" * 3
 225         else:
 226             data = b"A" * 16 + b"B" * 16 + b"C" * 3
 227
 228         # send packet from host to server
 229         pkts = self.create_stream_frag(self.pg0,
 230                                        self.nat_addr,
 231                                        host_in_port,
 232                                        server_out_port,
 233                                        data,
 234                                        proto)
 235         self.pg0.add_stream(pkts)
 236         self.pg_enable_capture(self.pg_interfaces)
 237         self.pg_start()
 238         frags = self.pg0.get_capture(len(pkts))
 239         p = self.reass_frags_and_verify(frags,
 240                                         self.nat_addr,
 241                                         server_addr)
 242         if proto != IP_PROTOS.icmp:
 243             if not ignore_port:
 244                 self.assertNotEqual(p[layer].sport, host_in_port)
 245             self.assertEqual(p[layer].dport, server_in_port)
 246         else:
 247             if not ignore_port:
 248                 self.assertNotEqual(p[layer].id, host_in_port)
 249         self.assertEqual(data, p[Raw].load)
 250
 251     def frag_out_of_order(self, proto=IP_PROTOS.tcp, dont_translate=False,
 252                           ignore_port=False):
 253         layer = self.proto2layer(proto)
 254
 255         if proto == IP_PROTOS.tcp:
 256             data = b"A" * 4 + b"B" * 16 + b"C" * 3
 257         else:
 258             data = b"A" * 16 + b"B" * 16 + b"C" * 3
 259         self.port_in = self.random_port()
 260
 261         for i in range(2):
 262             # in2out
 263             pkts = self.create_stream_frag(self.pg0, self.pg1.remote_ip4,
 264                                            self.port_in, 20, data, proto)
 265             pkts.reverse()
 266             self.pg0.add_stream(pkts)
 267             self.pg_enable_capture(self.pg_interfaces)
 268             self.pg_start()
 269             frags = self.pg1.get_capture(len(pkts))
 270             if not dont_translate:
 271                 p = self.reass_frags_and_verify(frags,
 272                                                 self.nat_addr,
 273                                                 self.pg1.remote_ip4)
 274             else:
 275                 p = self.reass_frags_and_verify(frags,
 276                                                 self.pg0.remote_ip4,
 277                                                 self.pg1.remote_ip4)
 278             if proto != IP_PROTOS.icmp:
 279                 if not dont_translate:
 280                     self.assertEqual(p[layer].dport, 20)
 281                     if not ignore_port:
 282                         self.assertNotEqual(p[layer].sport, self.port_in)
 283                 else:
 284                     self.assertEqual(p[layer].sport, self.port_in)
 285             else:
 286                 if not ignore_port:
 287                     if not dont_translate:
 288                         self.assertNotEqual(p[layer].id, self.port_in)
 289                     else:
 290                         self.assertEqual(p[layer].id, self.port_in)
 291             self.assertEqual(data, p[Raw].load)
 292
 293             # out2in
 294             if not dont_translate:
 295                 dst_addr = self.nat_addr
 296             else:
 297                 dst_addr = self.pg0.remote_ip4
 298             if proto != IP_PROTOS.icmp:
 299                 sport = 20
 300                 dport = p[layer].sport
 301             else:
 302                 sport = p[layer].id
 303                 dport = 0
 304             pkts = self.create_stream_frag(self.pg1, dst_addr, sport, dport,
 305                                            data, proto, echo_reply=True)
 306             pkts.reverse()
 307             self.pg1.add_stream(pkts)
 308             self.pg_enable_capture(self.pg_interfaces)
 309             self.logger.info(self.vapi.cli("show trace"))
 310             self.pg_start()
 311             frags = self.pg0.get_capture(len(pkts))
 312             p = self.reass_frags_and_verify(frags,
 313                                             self.pg1.remote_ip4,
 314                                             self.pg0.remote_ip4)
 315             if proto != IP_PROTOS.icmp:
 316                 self.assertEqual(p[layer].sport, 20)
 317                 self.assertEqual(p[layer].dport, self.port_in)
 318             else:
 319                 self.assertEqual(p[layer].id, self.port_in)
 320             self.assertEqual(data, p[Raw].load)
 321
 322     def reass_frags_and_verify(self, frags, src, dst):
 323         buffer = BytesIO()
 324         for p in frags:
 325             self.assertEqual(p[IP].src, src)
 326             self.assertEqual(p[IP].dst, dst)
 327             self.assert_ip_checksum_valid(p)
 328             buffer.seek(p[IP].frag * 8)
 329             buffer.write(bytes(p[IP].payload))
 330         ip = IP(src=frags[0][IP].src, dst=frags[0][IP].dst,
 331                 proto=frags[0][IP].proto)
 332         if ip.proto == IP_PROTOS.tcp:
 333             p = (ip / TCP(buffer.getvalue()))
 334             self.logger.debug(ppp("Reassembled:", p))
 335             self.assert_tcp_checksum_valid(p)
 336         elif ip.proto == IP_PROTOS.udp:
 337             p = (ip / UDP(buffer.getvalue()[:8]) /
 338                  Raw(buffer.getvalue()[8:]))
 339         elif ip.proto == IP_PROTOS.icmp:
 340             p = (ip / ICMP(buffer.getvalue()))
 341         return p
 342
 343     def frag_in_order(self, proto=IP_PROTOS.tcp, dont_translate=False,
 344                       ignore_port=False):
 345         layer = self.proto2layer(proto)
 346
 347         if proto == IP_PROTOS.tcp:
 348             data = b"A" * 4 + b"B" * 16 + b"C" * 3
 349         else:
 350             data = b"A" * 16 + b"B" * 16 + b"C" * 3
 351         self.port_in = self.random_port()
 352
 353         # in2out
 354         pkts = self.create_stream_frag(self.pg0, self.pg1.remote_ip4,
 355                                        self.port_in, 20, data, proto)
 356         self.pg0.add_stream(pkts)
 357         self.pg_enable_capture(self.pg_interfaces)
 358         self.pg_start()
 359         frags = self.pg1.get_capture(len(pkts))
 360         if not dont_translate:
 361             p = self.reass_frags_and_verify(frags,
 362                                             self.nat_addr,
 363                                             self.pg1.remote_ip4)
 364         else:
 365             p = self.reass_frags_and_verify(frags,
 366                                             self.pg0.remote_ip4,
 367                                             self.pg1.remote_ip4)
 368         if proto != IP_PROTOS.icmp:
 369             if not dont_translate:
 370                 self.assertEqual(p[layer].dport, 20)
 371                 if not ignore_port:
 372                     self.assertNotEqual(p[layer].sport, self.port_in)
 373             else:
 374                 self.assertEqual(p[layer].sport, self.port_in)
 375         else:
 376             if not ignore_port:
 377                 if not dont_translate:
 378                     self.assertNotEqual(p[layer].id, self.port_in)
 379                 else:
 380                     self.assertEqual(p[layer].id, self.port_in)
 381         self.assertEqual(data, p[Raw].load)
 382
 383         # out2in
 384         if not dont_translate:
 385             dst_addr = self.nat_addr
 386         else:
 387             dst_addr = self.pg0.remote_ip4
 388         if proto != IP_PROTOS.icmp:
 389             sport = 20
 390             dport = p[layer].sport
 391         else:
 392             sport = p[layer].id
 393             dport = 0
 394         pkts = self.create_stream_frag(self.pg1, dst_addr, sport, dport, data,
 395                                        proto, echo_reply=True)
 396         self.pg1.add_stream(pkts)
 397         self.pg_enable_capture(self.pg_interfaces)
 398         self.pg_start()
 399         frags = self.pg0.get_capture(len(pkts))
 400         p = self.reass_frags_and_verify(frags,
 401                                         self.pg1.remote_ip4,
 402                                         self.pg0.remote_ip4)
 403         if proto != IP_PROTOS.icmp:
 404             self.assertEqual(p[layer].sport, 20)
 405             self.assertEqual(p[layer].dport, self.port_in)
 406         else:
 407             self.assertEqual(p[layer].id, self.port_in)
 408         self.assertEqual(data, p[Raw].load)
 409
 410     def verify_capture_out(self, capture, nat_ip=None, same_port=False,
 411                            dst_ip=None, ignore_port=False):
 412         if nat_ip is None:
 413             nat_ip = self.nat_addr
 414         for packet in capture:
 415             try:
 416                 self.assert_packet_checksums_valid(packet)
 417                 self.assertEqual(packet[IP].src, nat_ip)
 418                 if dst_ip is not None:
 419                     self.assertEqual(packet[IP].dst, dst_ip)
 420                 if packet.haslayer(TCP):
 421                     if not ignore_port:
 422                         if same_port:
 423                             self.assertEqual(
 424                                 packet[TCP].sport, self.tcp_port_in)
 425                         else:
 426                             self.assertNotEqual(
 427                                 packet[TCP].sport, self.tcp_port_in)
 428                     self.tcp_port_out = packet[TCP].sport
 429                     self.assert_packet_checksums_valid(packet)
 430                 elif packet.haslayer(UDP):
 431                     if not ignore_port:
 432                         if same_port:
 433                             self.assertEqual(
 434                                 packet[UDP].sport, self.udp_port_in)
 435                         else:
 436                             self.assertNotEqual(
 437                                 packet[UDP].sport, self.udp_port_in)
 438                     self.udp_port_out = packet[UDP].sport
 439                 else:
 440                     if not ignore_port:
 441                         if same_port:
 442                             self.assertEqual(
 443                                 packet[ICMP].id, self.icmp_id_in)
 444                         else:
 445                             self.assertNotEqual(
 446                                 packet[ICMP].id, self.icmp_id_in)
 447                     self.icmp_id_out = packet[ICMP].id
 448                     self.assert_packet_checksums_valid(packet)
 449             except:
 450                 self.logger.error(ppp("Unexpected or invalid packet "
 451                                       "(outside network):", packet))
 452                 raise
 453
 454     def verify_capture_in(self, capture, in_if):
 455         for packet in capture:
 456             try:
 457                 self.assert_packet_checksums_valid(packet)
 458                 self.assertEqual(packet[IP].dst, in_if.remote_ip4)
 459                 if packet.haslayer(TCP):
 460                     self.assertEqual(packet[TCP].dport, self.tcp_port_in)
 461                 elif packet.haslayer(UDP):
 462                     self.assertEqual(packet[UDP].dport, self.udp_port_in)
 463                 else:
 464                     self.assertEqual(packet[ICMP].id, self.icmp_id_in)
 465             except:
 466                 self.logger.error(ppp("Unexpected or invalid packet "
 467                                       "(inside network):", packet))
 468                 raise
 469
 470     def create_stream_in(self, in_if, out_if, dst_ip=None, ttl=64):
 471         if dst_ip is None:
 472             dst_ip = out_if.remote_ip4
 473
 474         pkts = []
 475         # TCP
 476         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 477              IP(src=in_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 478              TCP(sport=self.tcp_port_in, dport=20))
 479         pkts.extend([p, p])
 480
 481         # UDP
 482         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 483              IP(src=in_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 484              UDP(sport=self.udp_port_in, dport=20))
 485         pkts.append(p)
 486
 487         # ICMP
 488         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 489              IP(src=in_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 490              ICMP(id=self.icmp_id_in, type='echo-request'))
 491         pkts.append(p)
 492
 493         return pkts
 494
 495     def create_stream_out(self, out_if, dst_ip=None, ttl=64,
 496                           use_inside_ports=False):
 497         if dst_ip is None:
 498             dst_ip = self.nat_addr
 499         if not use_inside_ports:
 500             tcp_port = self.tcp_port_out
 501             udp_port = self.udp_port_out
 502             icmp_id = self.icmp_id_out
 503         else:
 504             tcp_port = self.tcp_port_in
 505             udp_port = self.udp_port_in
 506             icmp_id = self.icmp_id_in
 507         pkts = []
 508         # TCP
 509         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 510              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 511              TCP(dport=tcp_port, sport=20))
 512         pkts.extend([p, p])
 513
 514         # UDP
 515         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 516              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 517              UDP(dport=udp_port, sport=20))
 518         pkts.append(p)
 519
 520         # ICMP
 521         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 522              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 523              ICMP(id=icmp_id, type='echo-reply'))
 524         pkts.append(p)
 525
 526         return pkts
 527
 528     def create_tcp_stream(self, in_if, out_if, count):
 529         pkts = []
 530         port = 6303
 531
 532         for i in range(count):
 533             p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 534                  IP(src=in_if.remote_ip4, dst=out_if.remote_ip4, ttl=64) /
 535                  TCP(sport=port + i, dport=20))
 536             pkts.append(p)
 537
 538         return pkts
 539
 540     def create_stream_frag(self, src_if, dst, sport, dport, data,
 541                            proto=IP_PROTOS.tcp, echo_reply=False):
 542         if proto == IP_PROTOS.tcp:
 543             p = (IP(src=src_if.remote_ip4, dst=dst) /
 544                  TCP(sport=sport, dport=dport) /
 545                  Raw(data))
 546             p = p.__class__(scapy.compat.raw(p))
 547             chksum = p[TCP].chksum
 548             proto_header = TCP(sport=sport, dport=dport, chksum=chksum)
 549         elif proto == IP_PROTOS.udp:
 550             proto_header = UDP(sport=sport, dport=dport)
 551         elif proto == IP_PROTOS.icmp:
 552             if not echo_reply:
 553                 proto_header = ICMP(id=sport, type='echo-request')
 554             else:
 555                 proto_header = ICMP(id=sport, type='echo-reply')
 556         else:
 557             raise Exception("Unsupported protocol")
 558         id = self.random_port()
 559         pkts = []
 560         if proto == IP_PROTOS.tcp:
 561             raw = Raw(data[0:4])
 562         else:
 563             raw = Raw(data[0:16])
 564         p = (Ether(src=src_if.remote_mac, dst=src_if.local_mac) /
 565              IP(src=src_if.remote_ip4, dst=dst, flags="MF", frag=0, id=id) /
 566              proto_header /
 567              raw)
 568         pkts.append(p)
 569         if proto == IP_PROTOS.tcp:
 570             raw = Raw(data[4:20])
 571         else:
 572             raw = Raw(data[16:32])
 573         p = (Ether(src=src_if.remote_mac, dst=src_if.local_mac) /
 574              IP(src=src_if.remote_ip4, dst=dst, flags="MF", frag=3, id=id,
 575                 proto=proto) /
 576              raw)
 577         pkts.append(p)
 578         if proto == IP_PROTOS.tcp:
 579             raw = Raw(data[20:])
 580         else:
 581             raw = Raw(data[32:])
 582         p = (Ether(src=src_if.remote_mac, dst=src_if.local_mac) /
 583              IP(src=src_if.remote_ip4, dst=dst, frag=5, proto=proto,
 584                 id=id) /
 585              raw)
 586         pkts.append(p)
 587         return pkts
 588
 589     def frag_in_order_in_plus_out(self, in_addr, out_addr, in_port, out_port,
 590                                   proto=IP_PROTOS.tcp):
 591
 592         layer = self.proto2layer(proto)
 593
 594         if proto == IP_PROTOS.tcp:
 595             data = b"A" * 4 + b"B" * 16 + b"C" * 3
 596         else:
 597             data = b"A" * 16 + b"B" * 16 + b"C" * 3
 598         port_in = self.random_port()
 599
 600         for i in range(2):
 601             # out2in
 602             pkts = self.create_stream_frag(self.pg0, out_addr,
 603                                            port_in, out_port,
 604                                            data, proto)
 605             self.pg0.add_stream(pkts)
 606             self.pg_enable_capture(self.pg_interfaces)
 607             self.pg_start()
 608             frags = self.pg1.get_capture(len(pkts))
 609             p = self.reass_frags_and_verify(frags,
 610                                             self.pg0.remote_ip4,
 611                                             in_addr)
 612             if proto != IP_PROTOS.icmp:
 613                 self.assertEqual(p[layer].sport, port_in)
 614                 self.assertEqual(p[layer].dport, in_port)
 615             else:
 616                 self.assertEqual(p[layer].id, port_in)
 617             self.assertEqual(data, p[Raw].load)
 618
 619             # in2out
 620             if proto != IP_PROTOS.icmp:
 621                 pkts = self.create_stream_frag(self.pg1, self.pg0.remote_ip4,
 622                                                in_port,
 623                                                p[layer].sport, data, proto)
 624             else:
 625                 pkts = self.create_stream_frag(self.pg1, self.pg0.remote_ip4,
 626                                                p[layer].id, 0, data, proto,
 627                                                echo_reply=True)
 628             self.pg1.add_stream(pkts)
 629             self.pg_enable_capture(self.pg_interfaces)
 630             self.pg_start()
 631             frags = self.pg0.get_capture(len(pkts))
 632             p = self.reass_frags_and_verify(frags,
 633                                             out_addr,
 634                                             self.pg0.remote_ip4)
 635             if proto != IP_PROTOS.icmp:
 636                 self.assertEqual(p[layer].sport, out_port)
 637                 self.assertEqual(p[layer].dport, port_in)
 638             else:
 639                 self.assertEqual(p[layer].id, port_in)
 640             self.assertEqual(data, p[Raw].load)
 641
 642     def frag_out_of_order_in_plus_out(self, in_addr, out_addr, in_port,
 643                                       out_port, proto=IP_PROTOS.tcp):
 644
 645         layer = self.proto2layer(proto)
 646
 647         if proto == IP_PROTOS.tcp:
 648             data = b"A" * 4 + b"B" * 16 + b"C" * 3
 649         else:
 650             data = b"A" * 16 + b"B" * 16 + b"C" * 3
 651         port_in = self.random_port()
 652
 653         for i in range(2):
 654             # out2in
 655             pkts = self.create_stream_frag(self.pg0, out_addr,
 656                                            port_in, out_port,
 657                                            data, proto)
 658             pkts.reverse()
 659             self.pg0.add_stream(pkts)
 660             self.pg_enable_capture(self.pg_interfaces)
 661             self.pg_start()
 662             frags = self.pg1.get_capture(len(pkts))
 663             p = self.reass_frags_and_verify(frags,
 664                                             self.pg0.remote_ip4,
 665                                             in_addr)
 666             if proto != IP_PROTOS.icmp:
 667                 self.assertEqual(p[layer].dport, in_port)
 668                 self.assertEqual(p[layer].sport, port_in)
 669                 self.assertEqual(p[layer].dport, in_port)
 670             else:
 671                 self.assertEqual(p[layer].id, port_in)
 672             self.assertEqual(data, p[Raw].load)
 673
 674             # in2out
 675             if proto != IP_PROTOS.icmp:
 676                 pkts = self.create_stream_frag(self.pg1, self.pg0.remote_ip4,
 677                                                in_port,
 678                                                p[layer].sport, data, proto)
 679             else:
 680                 pkts = self.create_stream_frag(self.pg1, self.pg0.remote_ip4,
 681                                                p[layer].id, 0, data, proto,
 682                                                echo_reply=True)
 683             pkts.reverse()
 684             self.pg1.add_stream(pkts)
 685             self.pg_enable_capture(self.pg_interfaces)
 686             self.pg_start()
 687             frags = self.pg0.get_capture(len(pkts))
 688             p = self.reass_frags_and_verify(frags,
 689                                             out_addr,
 690                                             self.pg0.remote_ip4)
 691             if proto != IP_PROTOS.icmp:
 692                 self.assertEqual(p[layer].sport, out_port)
 693                 self.assertEqual(p[layer].dport, port_in)
 694             else:
 695                 self.assertEqual(p[layer].id, port_in)
 696             self.assertEqual(data, p[Raw].load)
 697
 698     def init_tcp_session(self, in_if, out_if, in_port, ext_port):
 699         # SYN packet in->out
 700         p = (Ether(src=in_if.remote_mac, dst=in_if.local_mac) /
 701              IP(src=in_if.remote_ip4, dst=out_if.remote_ip4) /
 702              TCP(sport=in_port, dport=ext_port, flags="S"))
 703         in_if.add_stream(p)
 704         self.pg_enable_capture(self.pg_interfaces)
 705         self.pg_start()
 706         capture = out_if.get_capture(1)
 707         p = capture[0]
 708         out_port = p[TCP].sport
 709
 710         # SYN + ACK packet out->in
 711         p = (Ether(src=out_if.remote_mac, dst=out_if.local_mac) /
 712              IP(src=out_if.remote_ip4, dst=self.nat_addr) /
 713              TCP(sport=ext_port, dport=out_port, flags="SA"))
 714         out_if.add_stream(p)
 715         self.pg_enable_capture(self.pg_interfaces)
 716         self.pg_start()
 717         in_if.get_capture(1)
 718
 719         # ACK packet in->out
 720         p = (Ether(src=in_if.remote_mac, dst=in_if.local_mac) /
 721              IP(src=in_if.remote_ip4, dst=out_if.remote_ip4) /
 722              TCP(sport=in_port, dport=ext_port, flags="A"))
 723         in_if.add_stream(p)
 724         self.pg_enable_capture(self.pg_interfaces)
 725         self.pg_start()
 726         out_if.get_capture(1)
 727
 728         return out_port
 729
 730     def twice_nat_common(self, self_twice_nat=False, same_pg=False, lb=False,
 731                          client_id=None):
 732         twice_nat_addr = '10.0.1.3'
 733
 734         port_in = 8080
 735         if lb:
 736             if not same_pg:
 737                 port_in1 = port_in
 738                 port_in2 = port_in
 739             else:
 740                 port_in1 = port_in + 1
 741                 port_in2 = port_in + 2
 742
 743         port_out = 80
 744         eh_port_out = 4567
 745
 746         server1 = self.pg0.remote_hosts[0]
 747         server2 = self.pg0.remote_hosts[1]
 748         if lb and same_pg:
 749             server2 = server1
 750         if not lb:
 751             server = server1
 752
 753         pg0 = self.pg0
 754         if same_pg:
 755             pg1 = self.pg0
 756         else:
 757             pg1 = self.pg1
 758
 759         eh_translate = ((not self_twice_nat) or (not lb and same_pg) or
 760                         client_id == 1)
 761
 762         self.nat_add_address(self.nat_addr)
 763         self.nat_add_address(twice_nat_addr, twice_nat=1)
 764
 765         flags = 0
 766         if self_twice_nat:
 767             flags |= self.config_flags.NAT_IS_SELF_TWICE_NAT
 768         else:
 769             flags |= self.config_flags.NAT_IS_TWICE_NAT
 770
 771         if not lb:
 772             self.nat_add_static_mapping(pg0.remote_ip4, self.nat_addr,
 773                                         port_in, port_out,
 774                                         proto=IP_PROTOS.tcp,
 775                                         flags=flags)
 776         else:
 777             locals = [{'addr': server1.ip4,
 778                        'port': port_in1,
 779                        'probability': 50,
 780                        'vrf_id': 0},
 781                       {'addr': server2.ip4,
 782                        'port': port_in2,
 783                        'probability': 50,
 784                        'vrf_id': 0}]
 785             out_addr = self.nat_addr
 786
 787             self.vapi.nat44_add_del_lb_static_mapping(is_add=1, flags=flags,
 788                                                       external_addr=out_addr,
 789                                                       external_port=port_out,
 790                                                       protocol=IP_PROTOS.tcp,
 791                                                       local_num=len(locals),
 792                                                       locals=locals)
 793         self.nat_add_inside_interface(pg0)
 794         self.nat_add_outside_interface(pg1)
 795
 796         if same_pg:
 797             if not lb:
 798                 client = server
 799             else:
 800                 assert client_id is not None
 801                 if client_id == 1:
 802                     client = self.pg0.remote_hosts[0]
 803                 elif client_id == 2:
 804                     client = self.pg0.remote_hosts[1]
 805         else:
 806             client = pg1.remote_hosts[0]
 807         p = (Ether(src=pg1.remote_mac, dst=pg1.local_mac) /
 808              IP(src=client.ip4, dst=self.nat_addr) /
 809              TCP(sport=eh_port_out, dport=port_out))
 810         pg1.add_stream(p)
 811         self.pg_enable_capture(self.pg_interfaces)
 812         self.pg_start()
 813         capture = pg0.get_capture(1)
 814         p = capture[0]
 815         try:
 816             ip = p[IP]
 817             tcp = p[TCP]
 818             if lb:
 819                 if ip.dst == server1.ip4:
 820                     server = server1
 821                     port_in = port_in1
 822                 else:
 823                     server = server2
 824                     port_in = port_in2
 825             self.assertEqual(ip.dst, server.ip4)
 826             if lb and same_pg:
 827                 self.assertIn(tcp.dport, [port_in1, port_in2])
 828             else:
 829                 self.assertEqual(tcp.dport, port_in)
 830             if eh_translate:
 831                 self.assertEqual(ip.src, twice_nat_addr)
 832                 self.assertNotEqual(tcp.sport, eh_port_out)
 833             else:
 834                 self.assertEqual(ip.src, client.ip4)
 835                 self.assertEqual(tcp.sport, eh_port_out)
 836             eh_addr_in = ip.src
 837             eh_port_in = tcp.sport
 838             saved_port_in = tcp.dport
 839             self.assert_packet_checksums_valid(p)
 840         except:
 841             self.logger.error(ppp("Unexpected or invalid packet:", p))
 842             raise
 843
 844         p = (Ether(src=server.mac, dst=pg0.local_mac) /
 845              IP(src=server.ip4, dst=eh_addr_in) /
 846              TCP(sport=saved_port_in, dport=eh_port_in))
 847         pg0.add_stream(p)
 848         self.pg_enable_capture(self.pg_interfaces)
 849         self.pg_start()
 850         capture = pg1.get_capture(1)
 851         p = capture[0]
 852         try:
 853             ip = p[IP]
 854             tcp = p[TCP]
 855             self.assertEqual(ip.dst, client.ip4)
 856             self.assertEqual(ip.src, self.nat_addr)
 857             self.assertEqual(tcp.dport, eh_port_out)
 858             self.assertEqual(tcp.sport, port_out)
 859             self.assert_packet_checksums_valid(p)
 860         except:
 861             self.logger.error(ppp("Unexpected or invalid packet:", p))
 862             raise
 863
 864         if eh_translate:
 865             sessions = self.vapi.nat44_user_session_dump(server.ip4, 0)
 866             self.assertEqual(len(sessions), 1)
 867             self.assertTrue(sessions[0].flags &
 868                             self.config_flags.NAT_IS_EXT_HOST_VALID)
 869             self.assertTrue(sessions[0].flags &
 870                             self.config_flags.NAT_IS_TWICE_NAT)
 871             self.logger.info(self.vapi.cli("show nat44 sessions"))
 872             self.vapi.nat44_del_session(
 873                 address=sessions[0].inside_ip_address,
 874                 port=sessions[0].inside_port,
 875                 protocol=sessions[0].protocol,
 876                 flags=(self.config_flags.NAT_IS_INSIDE |
 877                        self.config_flags.NAT_IS_EXT_HOST_VALID),
 878                 ext_host_address=sessions[0].ext_host_nat_address,
 879                 ext_host_port=sessions[0].ext_host_nat_port)
 880             sessions = self.vapi.nat44_user_session_dump(server.ip4, 0)
 881             self.assertEqual(len(sessions), 0)
 882
 883     def verify_syslog_sess(self, data, is_add=True, is_ip6=False):
 884         message = data.decode('utf-8')
 885         try:
 886             message = SyslogMessage.parse(message)
 887         except ParseError as e:
 888             self.logger.error(e)
 889             raise
 890         else:
 891             self.assertEqual(message.severity, SyslogSeverity.info)
 892             self.assertEqual(message.appname, 'NAT')
 893             self.assertEqual(message.msgid, 'SADD' if is_add else 'SDEL')
 894             sd_params = message.sd.get('nsess')
 895             self.assertTrue(sd_params is not None)
 896             if is_ip6:
 897                 self.assertEqual(sd_params.get('IATYP'), 'IPv6')
 898                 self.assertEqual(sd_params.get('ISADDR'), self.pg0.remote_ip6)
 899             else:
 900                 self.assertEqual(sd_params.get('IATYP'), 'IPv4')
 901                 self.assertEqual(sd_params.get('ISADDR'), self.pg0.remote_ip4)
 902                 self.assertTrue(sd_params.get('SSUBIX') is not None)
 903             self.assertEqual(sd_params.get('ISPORT'), "%d" % self.tcp_port_in)
 904             self.assertEqual(sd_params.get('XATYP'), 'IPv4')
 905             self.assertEqual(sd_params.get('XSADDR'), self.nat_addr)
 906             self.assertEqual(sd_params.get('XSPORT'), "%d" % self.tcp_port_out)
 907             self.assertEqual(sd_params.get('PROTO'), "%d" % IP_PROTOS.tcp)
 908             self.assertEqual(sd_params.get('SVLAN'), '0')
 909             self.assertEqual(sd_params.get('XDADDR'), self.pg1.remote_ip4)
 910             self.assertEqual(sd_params.get('XDPORT'),
 911                              "%d" % self.tcp_external_port)
 912
 913
 914 class TestNAT44ED(NAT44EDTestCase):
 915     """ NAT44ED Test Case """
 916
 917     def test_users_dump(self):
 918         """ NAT44ED API test - nat44_user_dump """
 919
 920         self.nat_add_address(self.nat_addr)
 921         self.nat_add_inside_interface(self.pg0)
 922         self.nat_add_outside_interface(self.pg1)
 923
 924         self.vapi.nat44_forwarding_enable_disable(enable=1)
 925
 926         local_ip = self.pg0.remote_ip4
 927         external_ip = self.nat_addr
 928         self.nat_add_static_mapping(local_ip, external_ip)
 929
 930         users = self.vapi.nat44_user_dump()
 931         self.assertEqual(len(users), 0)
 932
 933         # in2out - static mapping match
 934
 935         pkts = self.create_stream_out(self.pg1)
 936         self.pg1.add_stream(pkts)
 937         self.pg_enable_capture(self.pg_interfaces)
 938         self.pg_start()
 939         capture = self.pg0.get_capture(len(pkts))
 940         self.verify_capture_in(capture, self.pg0)
 941
 942         pkts = self.create_stream_in(self.pg0, self.pg1)
 943         self.pg0.add_stream(pkts)
 944         self.pg_enable_capture(self.pg_interfaces)
 945         self.pg_start()
 946         capture = self.pg1.get_capture(len(pkts))
 947         self.verify_capture_out(capture, same_port=True)
 948
 949         users = self.vapi.nat44_user_dump()
 950         self.assertEqual(len(users), 1)
 951         static_user = users[0]
 952         self.assertEqual(static_user.nstaticsessions, 3)
 953         self.assertEqual(static_user.nsessions, 0)
 954
 955         # in2out - no static mapping match (forwarding test)
 956
 957         host0 = self.pg0.remote_hosts[0]
 958         self.pg0.remote_hosts[0] = self.pg0.remote_hosts[1]
 959         try:
 960             pkts = self.create_stream_out(self.pg1,
 961                                           dst_ip=self.pg0.remote_ip4,
 962                                           use_inside_ports=True)
 963             self.pg1.add_stream(pkts)
 964             self.pg_enable_capture(self.pg_interfaces)
 965             self.pg_start()
 966             capture = self.pg0.get_capture(len(pkts))
 967             self.verify_capture_in(capture, self.pg0)
 968
 969             pkts = self.create_stream_in(self.pg0, self.pg1)
 970             self.pg0.add_stream(pkts)
 971             self.pg_enable_capture(self.pg_interfaces)
 972             self.pg_start()
 973             capture = self.pg1.get_capture(len(pkts))
 974             self.verify_capture_out(capture, nat_ip=self.pg0.remote_ip4,
 975                                     same_port=True)
 976         finally:
 977             self.pg0.remote_hosts[0] = host0
 978
 979         users = self.vapi.nat44_user_dump()
 980         self.assertEqual(len(users), 2)
 981         if str(users[0].ip_address) == self.pg0.remote_hosts[0].ip4:
 982             non_static_user = users[1]
 983             static_user = users[0]
 984         else:
 985             non_static_user = users[0]
 986             static_user = users[1]
 987         self.assertEqual(static_user.nstaticsessions, 3)
 988         self.assertEqual(static_user.nsessions, 0)
 989         self.assertEqual(non_static_user.nstaticsessions, 0)
 990         self.assertEqual(non_static_user.nsessions, 3)
 991
 992         users = self.vapi.nat44_user_dump()
 993         self.assertEqual(len(users), 2)
 994         if str(users[0].ip_address) == self.pg0.remote_hosts[0].ip4:
 995             non_static_user = users[1]
 996             static_user = users[0]
 997         else:
 998             non_static_user = users[0]
 999             static_user = users[1]
1000         self.assertEqual(static_user.nstaticsessions, 3)
1001         self.assertEqual(static_user.nsessions, 0)
1002         self.assertEqual(non_static_user.nstaticsessions, 0)
1003         self.assertEqual(non_static_user.nsessions, 3)
1004
1005     def test_frag_out_of_order_do_not_translate(self):
1006         """ NAT44ED don't translate fragments arriving out of order """
1007         self.nat_add_inside_interface(self.pg0)
1008         self.nat_add_outside_interface(self.pg1)
1009         self.vapi.nat44_forwarding_enable_disable(enable=True)
1010         self.frag_out_of_order(proto=IP_PROTOS.tcp, dont_translate=True)
1011
1012     def test_forwarding(self):
1013         """ NAT44ED forwarding test """
1014
1015         self.nat_add_inside_interface(self.pg0)
1016         self.nat_add_outside_interface(self.pg1)
1017         self.vapi.nat44_forwarding_enable_disable(enable=1)
1018
1019         real_ip = self.pg0.remote_ip4
1020         alias_ip = self.nat_addr
1021         flags = self.config_flags.NAT_IS_ADDR_ONLY
1022         self.vapi.nat44_add_del_static_mapping(is_add=1,
1023                                                local_ip_address=real_ip,
1024                                                external_ip_address=alias_ip,
1025                                                external_sw_if_index=0xFFFFFFFF,
1026                                                flags=flags)
1027
1028         try:
1029             # in2out - static mapping match
1030
1031             pkts = self.create_stream_out(self.pg1)
1032             self.pg1.add_stream(pkts)
1033             self.pg_enable_capture(self.pg_interfaces)
1034             self.pg_start()
1035             capture = self.pg0.get_capture(len(pkts))
1036             self.verify_capture_in(capture, self.pg0)
1037
1038             pkts = self.create_stream_in(self.pg0, self.pg1)
1039             self.pg0.add_stream(pkts)
1040             self.pg_enable_capture(self.pg_interfaces)
1041             self.pg_start()
1042             capture = self.pg1.get_capture(len(pkts))
1043             self.verify_capture_out(capture, same_port=True)
1044
1045             # in2out - no static mapping match
1046
1047             host0 = self.pg0.remote_hosts[0]
1048             self.pg0.remote_hosts[0] = self.pg0.remote_hosts[1]
1049             try:
1050                 pkts = self.create_stream_out(self.pg1,
1051                                               dst_ip=self.pg0.remote_ip4,
1052                                               use_inside_ports=True)
1053                 self.pg1.add_stream(pkts)
1054                 self.pg_enable_capture(self.pg_interfaces)
1055                 self.pg_start()
1056                 capture = self.pg0.get_capture(len(pkts))
1057                 self.verify_capture_in(capture, self.pg0)
1058
1059                 pkts = self.create_stream_in(self.pg0, self.pg1)
1060                 self.pg0.add_stream(pkts)
1061                 self.pg_enable_capture(self.pg_interfaces)
1062                 self.pg_start()
1063                 capture = self.pg1.get_capture(len(pkts))
1064                 self.verify_capture_out(capture, nat_ip=self.pg0.remote_ip4,
1065                                         same_port=True)
1066             finally:
1067                 self.pg0.remote_hosts[0] = host0
1068
1069             user = self.pg0.remote_hosts[1]
1070             sessions = self.vapi.nat44_user_session_dump(user.ip4, 0)
1071             self.assertEqual(len(sessions), 3)
1072             self.assertTrue(sessions[0].flags &
1073                             self.config_flags.NAT_IS_EXT_HOST_VALID)
1074             self.vapi.nat44_del_session(
1075                 address=sessions[0].inside_ip_address,
1076                 port=sessions[0].inside_port,
1077                 protocol=sessions[0].protocol,
1078                 flags=(self.config_flags.NAT_IS_INSIDE |
1079                        self.config_flags.NAT_IS_EXT_HOST_VALID),
1080                 ext_host_address=sessions[0].ext_host_address,
1081                 ext_host_port=sessions[0].ext_host_port)
1082             sessions = self.vapi.nat44_user_session_dump(user.ip4, 0)
1083             self.assertEqual(len(sessions), 2)
1084
1085         finally:
1086             self.vapi.nat44_forwarding_enable_disable(enable=0)
1087             flags = self.config_flags.NAT_IS_ADDR_ONLY
1088             self.vapi.nat44_add_del_static_mapping(
1089                 is_add=0,
1090                 local_ip_address=real_ip,
1091                 external_ip_address=alias_ip,
1092                 external_sw_if_index=0xFFFFFFFF,
1093                 flags=flags)
1094
1095     def test_output_feature_and_service2(self):
1096         """ NAT44ED interface output feature and service host direct access """
1097         self.vapi.nat44_forwarding_enable_disable(enable=1)
1098         self.nat_add_address(self.nat_addr)
1099
1100         self.vapi.nat44_interface_add_del_output_feature(
1101             sw_if_index=self.pg1.sw_if_index, is_add=1,)
1102
1103         # session initiated from service host - translate
1104         pkts = self.create_stream_in(self.pg0, self.pg1)
1105         self.pg0.add_stream(pkts)
1106         self.pg_enable_capture(self.pg_interfaces)
1107         self.pg_start()
1108         capture = self.pg1.get_capture(len(pkts))
1109         self.verify_capture_out(capture, ignore_port=True)
1110
1111         pkts = self.create_stream_out(self.pg1)
1112         self.pg1.add_stream(pkts)
1113         self.pg_enable_capture(self.pg_interfaces)
1114         self.pg_start()
1115         capture = self.pg0.get_capture(len(pkts))
1116         self.verify_capture_in(capture, self.pg0)
1117
1118         # session initiated from remote host - do not translate
1119         tcp_port_in = self.tcp_port_in
1120         udp_port_in = self.udp_port_in
1121         icmp_id_in = self.icmp_id_in
1122
1123         self.tcp_port_in = 60303
1124         self.udp_port_in = 60304
1125         self.icmp_id_in = 60305
1126
1127         try:
1128             pkts = self.create_stream_out(self.pg1,
1129                                           self.pg0.remote_ip4,
1130                                           use_inside_ports=True)
1131             self.pg1.add_stream(pkts)
1132             self.pg_enable_capture(self.pg_interfaces)
1133             self.pg_start()
1134             capture = self.pg0.get_capture(len(pkts))
1135             self.verify_capture_in(capture, self.pg0)
1136
1137             pkts = self.create_stream_in(self.pg0, self.pg1)
1138             self.pg0.add_stream(pkts)
1139             self.pg_enable_capture(self.pg_interfaces)
1140             self.pg_start()
1141             capture = self.pg1.get_capture(len(pkts))
1142             self.verify_capture_out(capture, nat_ip=self.pg0.remote_ip4,
1143                                     same_port=True)
1144         finally:
1145             self.tcp_port_in = tcp_port_in
1146             self.udp_port_in = udp_port_in
1147             self.icmp_id_in = icmp_id_in
1148
1149     def test_twice_nat(self):
1150         """ NAT44ED Twice NAT """
1151         self.twice_nat_common()
1152
1153     def test_self_twice_nat_positive(self):
1154         """ NAT44ED Self Twice NAT (positive test) """
1155         self.twice_nat_common(self_twice_nat=True, same_pg=True)
1156
1157     def test_self_twice_nat_lb_positive(self):
1158         """ NAT44ED Self Twice NAT local service load balancing (positive test)
1159         """
1160         self.twice_nat_common(lb=True, self_twice_nat=True, same_pg=True,
1161                               client_id=1)
1162
1163     def test_twice_nat_lb(self):
1164         """ NAT44ED Twice NAT local service load balancing """
1165         self.twice_nat_common(lb=True)
1166
1167     def test_output_feature(self):
1168         """ NAT44ED interface output feature (in2out postrouting) """
1169         self.vapi.nat44_forwarding_enable_disable(enable=1)
1170         self.nat_add_address(self.nat_addr)
1171
1172         self.nat_add_outside_interface(self.pg0)
1173         self.vapi.nat44_interface_add_del_output_feature(
1174             sw_if_index=self.pg1.sw_if_index, is_add=1)
1175
1176         # in2out
1177         pkts = self.create_stream_in(self.pg0, self.pg1)
1178         self.pg0.add_stream(pkts)
1179         self.pg_enable_capture(self.pg_interfaces)
1180         self.pg_start()
1181         capture = self.pg1.get_capture(len(pkts))
1182         self.verify_capture_out(capture, ignore_port=True)
1183
1184         # out2in
1185         pkts = self.create_stream_out(self.pg1)
1186         self.pg1.add_stream(pkts)
1187         self.pg_enable_capture(self.pg_interfaces)
1188         self.pg_start()
1189         capture = self.pg0.get_capture(len(pkts))
1190         self.verify_capture_in(capture, self.pg0)
1191
1192     def test_static_with_port_out2(self):
1193         """ NAT44ED 1:1 NAPT asymmetrical rule """
1194
1195         external_port = 80
1196         local_port = 8080
1197
1198         self.vapi.nat44_forwarding_enable_disable(enable=1)
1199         flags = self.config_flags.NAT_IS_OUT2IN_ONLY
1200         self.nat_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
1201                                     local_port, external_port,
1202                                     proto=IP_PROTOS.tcp, flags=flags)
1203
1204         self.nat_add_inside_interface(self.pg0)
1205         self.nat_add_outside_interface(self.pg1)
1206
1207         # from client to service
1208         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
1209              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
1210              TCP(sport=12345, dport=external_port))
1211         self.pg1.add_stream(p)
1212         self.pg_enable_capture(self.pg_interfaces)
1213         self.pg_start()
1214         capture = self.pg0.get_capture(1)
1215         p = capture[0]
1216         try:
1217             ip = p[IP]
1218             tcp = p[TCP]
1219             self.assertEqual(ip.dst, self.pg0.remote_ip4)
1220             self.assertEqual(tcp.dport, local_port)
1221             self.assert_packet_checksums_valid(p)
1222         except:
1223             self.logger.error(ppp("Unexpected or invalid packet:", p))
1224             raise
1225
1226         # ICMP error
1227         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
1228              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
1229              ICMP(type=11) / capture[0][IP])
1230         self.pg0.add_stream(p)
1231         self.pg_enable_capture(self.pg_interfaces)
1232         self.pg_start()
1233         capture = self.pg1.get_capture(1)
1234         p = capture[0]
1235         try:
1236             self.assertEqual(p[IP].src, self.nat_addr)
1237             inner = p[IPerror]
1238             self.assertEqual(inner.dst, self.nat_addr)
1239             self.assertEqual(inner[TCPerror].dport, external_port)
1240         except:
1241             self.logger.error(ppp("Unexpected or invalid packet:", p))
1242             raise
1243
1244         # from service back to client
1245         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
1246              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
1247              TCP(sport=local_port, dport=12345))
1248         self.pg0.add_stream(p)
1249         self.pg_enable_capture(self.pg_interfaces)
1250         self.pg_start()
1251         capture = self.pg1.get_capture(1)
1252         p = capture[0]
1253         try:
1254             ip = p[IP]
1255             tcp = p[TCP]
1256             self.assertEqual(ip.src, self.nat_addr)
1257             self.assertEqual(tcp.sport, external_port)
1258             self.assert_packet_checksums_valid(p)
1259         except:
1260             self.logger.error(ppp("Unexpected or invalid packet:", p))
1261             raise
1262
1263         # ICMP error
1264         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
1265              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
1266              ICMP(type=11) / capture[0][IP])
1267         self.pg1.add_stream(p)
1268         self.pg_enable_capture(self.pg_interfaces)
1269         self.pg_start()
1270         capture = self.pg0.get_capture(1)
1271         p = capture[0]
1272         try:
1273             self.assertEqual(p[IP].dst, self.pg0.remote_ip4)
1274             inner = p[IPerror]
1275             self.assertEqual(inner.src, self.pg0.remote_ip4)
1276             self.assertEqual(inner[TCPerror].sport, local_port)
1277         except:
1278             self.logger.error(ppp("Unexpected or invalid packet:", p))
1279             raise
1280
1281         # from client to server (no translation)
1282         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
1283              IP(src=self.pg1.remote_ip4, dst=self.pg0.remote_ip4) /
1284              TCP(sport=12346, dport=local_port))
1285         self.pg1.add_stream(p)
1286         self.pg_enable_capture(self.pg_interfaces)
1287         self.pg_start()
1288         capture = self.pg0.get_capture(1)
1289         p = capture[0]
1290         try:
1291             ip = p[IP]
1292             tcp = p[TCP]
1293             self.assertEqual(ip.dst, self.pg0.remote_ip4)
1294             self.assertEqual(tcp.dport, local_port)
1295             self.assert_packet_checksums_valid(p)
1296         except:
1297             self.logger.error(ppp("Unexpected or invalid packet:", p))
1298             raise
1299
1300         # from service back to client (no translation)
1301         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
1302              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
1303              TCP(sport=local_port, dport=12346))
1304         self.pg0.add_stream(p)
1305         self.pg_enable_capture(self.pg_interfaces)
1306         self.pg_start()
1307         capture = self.pg1.get_capture(1)
1308         p = capture[0]
1309         try:
1310             ip = p[IP]
1311             tcp = p[TCP]
1312             self.assertEqual(ip.src, self.pg0.remote_ip4)
1313             self.assertEqual(tcp.sport, local_port)
1314             self.assert_packet_checksums_valid(p)
1315         except:
1316             self.logger.error(ppp("Unexpected or invalid packet:", p))
1317             raise
1318
1319     def test_static_lb(self):
1320         """ NAT44ED local service load balancing """
1321         external_addr_n = self.nat_addr
1322         external_port = 80
1323         local_port = 8080
1324         server1 = self.pg0.remote_hosts[0]
1325         server2 = self.pg0.remote_hosts[1]
1326
1327         locals = [{'addr': server1.ip4,
1328                    'port': local_port,
1329                    'probability': 70,
1330                    'vrf_id': 0},
1331                   {'addr': server2.ip4,
1332                    'port': local_port,
1333                    'probability': 30,
1334                    'vrf_id': 0}]
1335
1336         self.nat_add_address(self.nat_addr)
1337         self.vapi.nat44_add_del_lb_static_mapping(
1338             is_add=1,
1339             external_addr=external_addr_n,
1340             external_port=external_port,
1341             protocol=IP_PROTOS.tcp,
1342             local_num=len(locals),
1343             locals=locals)
1344         flags = self.config_flags.NAT_IS_INSIDE
1345         self.vapi.nat44_interface_add_del_feature(
1346             sw_if_index=self.pg0.sw_if_index,
1347             flags=flags, is_add=1)
1348         self.vapi.nat44_interface_add_del_feature(
1349             sw_if_index=self.pg1.sw_if_index,
1350             is_add=1)
1351
1352         # from client to service
1353         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
1354              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
1355              TCP(sport=12345, dport=external_port))
1356         self.pg1.add_stream(p)
1357         self.pg_enable_capture(self.pg_interfaces)
1358         self.pg_start()
1359         capture = self.pg0.get_capture(1)
1360         p = capture[0]
1361         server = None
1362         try:
1363             ip = p[IP]
1364             tcp = p[TCP]
1365             self.assertIn(ip.dst, [server1.ip4, server2.ip4])
1366             if ip.dst == server1.ip4:
1367                 server = server1
1368             else:
1369                 server = server2
1370             self.assertEqual(tcp.dport, local_port)
1371             self.assert_packet_checksums_valid(p)
1372         except:
1373             self.logger.error(ppp("Unexpected or invalid packet:", p))
1374             raise
1375
1376         # from service back to client
1377         p = (Ether(src=server.mac, dst=self.pg0.local_mac) /
1378              IP(src=server.ip4, dst=self.pg1.remote_ip4) /
1379              TCP(sport=local_port, dport=12345))
1380         self.pg0.add_stream(p)
1381         self.pg_enable_capture(self.pg_interfaces)
1382         self.pg_start()
1383         capture = self.pg1.get_capture(1)
1384         p = capture[0]
1385         try:
1386             ip = p[IP]
1387             tcp = p[TCP]
1388             self.assertEqual(ip.src, self.nat_addr)
1389             self.assertEqual(tcp.sport, external_port)
1390             self.assert_packet_checksums_valid(p)
1391         except:
1392             self.logger.error(ppp("Unexpected or invalid packet:", p))
1393             raise
1394
1395         sessions = self.vapi.nat44_user_session_dump(server.ip4, 0)
1396         self.assertEqual(len(sessions), 1)
1397         self.assertTrue(sessions[0].flags &
1398                         self.config_flags.NAT_IS_EXT_HOST_VALID)
1399         self.vapi.nat44_del_session(
1400             address=sessions[0].inside_ip_address,
1401             port=sessions[0].inside_port,
1402             protocol=sessions[0].protocol,
1403             flags=(self.config_flags.NAT_IS_INSIDE |
1404                    self.config_flags.NAT_IS_EXT_HOST_VALID),
1405             ext_host_address=sessions[0].ext_host_address,
1406             ext_host_port=sessions[0].ext_host_port)
1407         sessions = self.vapi.nat44_user_session_dump(server.ip4, 0)
1408         self.assertEqual(len(sessions), 0)
1409
1410     def test_static_lb_2(self):
1411         """ NAT44ED local service load balancing (asymmetrical rule) """
1412         external_addr = self.nat_addr
1413         external_port = 80
1414         local_port = 8080
1415         server1 = self.pg0.remote_hosts[0]
1416         server2 = self.pg0.remote_hosts[1]
1417
1418         locals = [{'addr': server1.ip4,
1419                    'port': local_port,
1420                    'probability': 70,
1421                    'vrf_id': 0},
1422                   {'addr': server2.ip4,
1423                    'port': local_port,
1424                    'probability': 30,
1425                    'vrf_id': 0}]
1426
1427         self.vapi.nat44_forwarding_enable_disable(enable=1)
1428         flags = self.config_flags.NAT_IS_OUT2IN_ONLY
1429         self.vapi.nat44_add_del_lb_static_mapping(is_add=1, flags=flags,
1430                                                   external_addr=external_addr,
1431                                                   external_port=external_port,
1432                                                   protocol=IP_PROTOS.tcp,
1433                                                   local_num=len(locals),
1434                                                   locals=locals)
1435         flags = self.config_flags.NAT_IS_INSIDE
1436         self.vapi.nat44_interface_add_del_feature(
1437             sw_if_index=self.pg0.sw_if_index,
1438             flags=flags, is_add=1)
1439         self.vapi.nat44_interface_add_del_feature(
1440             sw_if_index=self.pg1.sw_if_index,
1441             is_add=1)
1442
1443         # from client to service
1444         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
1445              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
1446              TCP(sport=12345, dport=external_port))
1447         self.pg1.add_stream(p)
1448         self.pg_enable_capture(self.pg_interfaces)
1449         self.pg_start()
1450         capture = self.pg0.get_capture(1)
1451         p = capture[0]
1452         server = None
1453         try:
1454             ip = p[IP]
1455             tcp = p[TCP]
1456             self.assertIn(ip.dst, [server1.ip4, server2.ip4])
1457             if ip.dst == server1.ip4:
1458                 server = server1
1459             else:
1460                 server = server2
1461             self.assertEqual(tcp.dport, local_port)
1462             self.assert_packet_checksums_valid(p)
1463         except:
1464             self.logger.error(ppp("Unexpected or invalid packet:", p))
1465             raise
1466
1467         # from service back to client
1468         p = (Ether(src=server.mac, dst=self.pg0.local_mac) /
1469              IP(src=server.ip4, dst=self.pg1.remote_ip4) /
1470              TCP(sport=local_port, dport=12345))
1471         self.pg0.add_stream(p)
1472         self.pg_enable_capture(self.pg_interfaces)
1473         self.pg_start()
1474         capture = self.pg1.get_capture(1)
1475         p = capture[0]
1476         try:
1477             ip = p[IP]
1478             tcp = p[TCP]
1479             self.assertEqual(ip.src, self.nat_addr)
1480             self.assertEqual(tcp.sport, external_port)
1481             self.assert_packet_checksums_valid(p)
1482         except:
1483             self.logger.error(ppp("Unexpected or invalid packet:", p))
1484             raise
1485
1486         # from client to server (no translation)
1487         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
1488              IP(src=self.pg1.remote_ip4, dst=server1.ip4) /
1489              TCP(sport=12346, dport=local_port))
1490         self.pg1.add_stream(p)
1491         self.pg_enable_capture(self.pg_interfaces)
1492         self.pg_start()
1493         capture = self.pg0.get_capture(1)
1494         p = capture[0]
1495         server = None
1496         try:
1497             ip = p[IP]
1498             tcp = p[TCP]
1499             self.assertEqual(ip.dst, server1.ip4)
1500             self.assertEqual(tcp.dport, local_port)
1501             self.assert_packet_checksums_valid(p)
1502         except:
1503             self.logger.error(ppp("Unexpected or invalid packet:", p))
1504             raise
1505
1506         # from service back to client (no translation)
1507         p = (Ether(src=server1.mac, dst=self.pg0.local_mac) /
1508              IP(src=server1.ip4, dst=self.pg1.remote_ip4) /
1509              TCP(sport=local_port, dport=12346))
1510         self.pg0.add_stream(p)
1511         self.pg_enable_capture(self.pg_interfaces)
1512         self.pg_start()
1513         capture = self.pg1.get_capture(1)
1514         p = capture[0]
1515         try:
1516             ip = p[IP]
1517             tcp = p[TCP]
1518             self.assertEqual(ip.src, server1.ip4)
1519             self.assertEqual(tcp.sport, local_port)
1520             self.assert_packet_checksums_valid(p)
1521         except:
1522             self.logger.error(ppp("Unexpected or invalid packet:", p))
1523             raise
1524
1525     def test_lb_affinity(self):
1526         """ NAT44ED local service load balancing affinity """
1527         external_addr = self.nat_addr
1528         external_port = 80
1529         local_port = 8080
1530         server1 = self.pg0.remote_hosts[0]
1531         server2 = self.pg0.remote_hosts[1]
1532
1533         locals = [{'addr': server1.ip4,
1534                    'port': local_port,
1535                    'probability': 50,
1536                    'vrf_id': 0},
1537                   {'addr': server2.ip4,
1538                    'port': local_port,
1539                    'probability': 50,
1540                    'vrf_id': 0}]
1541
1542         self.nat_add_address(self.nat_addr)
1543         self.vapi.nat44_add_del_lb_static_mapping(is_add=1,
1544                                                   external_addr=external_addr,
1545                                                   external_port=external_port,
1546                                                   protocol=IP_PROTOS.tcp,
1547                                                   affinity=10800,
1548                                                   local_num=len(locals),
1549                                                   locals=locals)
1550         flags = self.config_flags.NAT_IS_INSIDE
1551         self.vapi.nat44_interface_add_del_feature(
1552             sw_if_index=self.pg0.sw_if_index,
1553             flags=flags, is_add=1)
1554         self.vapi.nat44_interface_add_del_feature(
1555             sw_if_index=self.pg1.sw_if_index,
1556             is_add=1)
1557
1558         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
1559              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
1560              TCP(sport=1025, dport=external_port))
1561         self.pg1.add_stream(p)
1562         self.pg_enable_capture(self.pg_interfaces)
1563         self.pg_start()
1564         capture = self.pg0.get_capture(1)
1565         backend = capture[0][IP].dst
1566
1567         sessions = self.vapi.nat44_user_session_dump(backend, 0)
1568         self.assertEqual(len(sessions), 1)
1569         self.assertTrue(sessions[0].flags &
1570                         self.config_flags.NAT_IS_EXT_HOST_VALID)
1571         self.vapi.nat44_del_session(
1572             address=sessions[0].inside_ip_address,
1573             port=sessions[0].inside_port,
1574             protocol=sessions[0].protocol,
1575             flags=(self.config_flags.NAT_IS_INSIDE |
1576                    self.config_flags.NAT_IS_EXT_HOST_VALID),
1577             ext_host_address=sessions[0].ext_host_address,
1578             ext_host_port=sessions[0].ext_host_port)
1579
1580         pkts = []
1581         for port in range(1030, 1100):
1582             p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
1583                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
1584                  TCP(sport=port, dport=external_port))
1585             pkts.append(p)
1586         self.pg1.add_stream(pkts)
1587         self.pg_enable_capture(self.pg_interfaces)
1588         self.pg_start()
1589         capture = self.pg0.get_capture(len(pkts))
1590         for p in capture:
1591             self.assertEqual(p[IP].dst, backend)
1592
1593     def test_multiple_vrf(self):
1594         """ NAT44ED Multiple VRF setup """
1595
1596         external_addr = '1.2.3.4'
1597         external_port = 80
1598         local_port = 8080
1599         port = 0
1600
1601         self.vapi.nat44_forwarding_enable_disable(enable=1)
1602         self.nat_add_address(self.nat_addr)
1603         flags = self.config_flags.NAT_IS_INSIDE
1604         self.vapi.nat44_interface_add_del_feature(
1605             sw_if_index=self.pg0.sw_if_index,
1606             is_add=1)
1607         self.vapi.nat44_interface_add_del_feature(
1608             sw_if_index=self.pg0.sw_if_index,
1609             is_add=1, flags=flags)
1610         self.vapi.nat44_interface_add_del_output_feature(
1611             sw_if_index=self.pg1.sw_if_index,
1612             is_add=1)
1613         self.vapi.nat44_interface_add_del_feature(
1614             sw_if_index=self.pg5.sw_if_index,
1615             is_add=1)
1616         self.vapi.nat44_interface_add_del_feature(
1617             sw_if_index=self.pg5.sw_if_index,
1618             is_add=1, flags=flags)
1619         self.vapi.nat44_interface_add_del_feature(
1620             sw_if_index=self.pg6.sw_if_index,
1621             is_add=1)
1622         flags = self.config_flags.NAT_IS_OUT2IN_ONLY
1623         self.nat_add_static_mapping(self.pg5.remote_ip4, external_addr,
1624                                     local_port, external_port, vrf_id=1,
1625                                     proto=IP_PROTOS.tcp, flags=flags)
1626         self.nat_add_static_mapping(
1627             self.pg0.remote_ip4,
1628             external_sw_if_index=self.pg0.sw_if_index,
1629             local_port=local_port,
1630             vrf_id=0,
1631             external_port=external_port,
1632             proto=IP_PROTOS.tcp,
1633             flags=flags
1634         )
1635
1636         # from client to service (both VRF1)
1637         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
1638              IP(src=self.pg6.remote_ip4, dst=external_addr) /
1639              TCP(sport=12345, dport=external_port))
1640         self.pg6.add_stream(p)
1641         self.pg_enable_capture(self.pg_interfaces)
1642         self.pg_start()
1643         capture = self.pg5.get_capture(1)
1644         p = capture[0]
1645         try:
1646             ip = p[IP]
1647             tcp = p[TCP]
1648             self.assertEqual(ip.dst, self.pg5.remote_ip4)
1649             self.assertEqual(tcp.dport, local_port)
1650             self.assert_packet_checksums_valid(p)
1651         except:
1652             self.logger.error(ppp("Unexpected or invalid packet:", p))
1653             raise
1654
1655         # from service back to client (both VRF1)
1656         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
1657              IP(src=self.pg5.remote_ip4, dst=self.pg6.remote_ip4) /
1658              TCP(sport=local_port, dport=12345))
1659         self.pg5.add_stream(p)
1660         self.pg_enable_capture(self.pg_interfaces)
1661         self.pg_start()
1662         capture = self.pg6.get_capture(1)
1663         p = capture[0]
1664         try:
1665             ip = p[IP]
1666             tcp = p[TCP]
1667             self.assertEqual(ip.src, external_addr)
1668             self.assertEqual(tcp.sport, external_port)
1669             self.assert_packet_checksums_valid(p)
1670         except:
1671             self.logger.error(ppp("Unexpected or invalid packet:", p))
1672             raise
1673
1674         # dynamic NAT from VRF1 to VRF0 (output-feature)
1675         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
1676              IP(src=self.pg5.remote_ip4, dst=self.pg1.remote_ip4) /
1677              TCP(sport=2345, dport=22))
1678         self.pg5.add_stream(p)
1679         self.pg_enable_capture(self.pg_interfaces)
1680         self.pg_start()
1681         capture = self.pg1.get_capture(1)
1682         p = capture[0]
1683         try:
1684             ip = p[IP]
1685             tcp = p[TCP]
1686             self.assertEqual(ip.src, self.nat_addr)
1687             self.assert_packet_checksums_valid(p)
1688             port = tcp.sport
1689         except:
1690             self.logger.error(ppp("Unexpected or invalid packet:", p))
1691             raise
1692
1693         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
1694              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
1695              TCP(sport=22, dport=port))
1696         self.pg1.add_stream(p)
1697         self.pg_enable_capture(self.pg_interfaces)
1698         self.pg_start()
1699         capture = self.pg5.get_capture(1)
1700         p = capture[0]
1701         try:
1702             ip = p[IP]
1703             tcp = p[TCP]
1704             self.assertEqual(ip.dst, self.pg5.remote_ip4)
1705             self.assertEqual(tcp.dport, 2345)
1706             self.assert_packet_checksums_valid(p)
1707         except:
1708             self.logger.error(ppp("Unexpected or invalid packet:", p))
1709             raise
1710
1711         # from client VRF1 to service VRF0
1712         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
1713              IP(src=self.pg6.remote_ip4, dst=self.pg0.local_ip4) /
1714              TCP(sport=12346, dport=external_port))
1715         self.pg6.add_stream(p)
1716         self.pg_enable_capture(self.pg_interfaces)
1717         self.pg_start()
1718         capture = self.pg0.get_capture(1)
1719         p = capture[0]
1720         try:
1721             ip = p[IP]
1722             tcp = p[TCP]
1723             self.assertEqual(ip.dst, self.pg0.remote_ip4)
1724             self.assertEqual(tcp.dport, local_port)
1725             self.assert_packet_checksums_valid(p)
1726         except:
1727             self.logger.error(ppp("Unexpected or invalid packet:", p))
1728             raise
1729
1730         # from service VRF0 back to client VRF1
1731         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
1732              IP(src=self.pg0.remote_ip4, dst=self.pg6.remote_ip4) /
1733              TCP(sport=local_port, dport=12346))
1734         self.pg0.add_stream(p)
1735         self.pg_enable_capture(self.pg_interfaces)
1736         self.pg_start()
1737         capture = self.pg6.get_capture(1)
1738         p = capture[0]
1739         try:
1740             ip = p[IP]
1741             tcp = p[TCP]
1742             self.assertEqual(ip.src, self.pg0.local_ip4)
1743             self.assertEqual(tcp.sport, external_port)
1744             self.assert_packet_checksums_valid(p)
1745         except:
1746             self.logger.error(ppp("Unexpected or invalid packet:", p))
1747             raise
1748
1749         # from client VRF0 to service VRF1
1750         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
1751              IP(src=self.pg0.remote_ip4, dst=external_addr) /
1752              TCP(sport=12347, dport=external_port))
1753         self.pg0.add_stream(p)
1754         self.pg_enable_capture(self.pg_interfaces)
1755         self.pg_start()
1756         capture = self.pg5.get_capture(1)
1757         p = capture[0]
1758         try:
1759             ip = p[IP]
1760             tcp = p[TCP]
1761             self.assertEqual(ip.dst, self.pg5.remote_ip4)
1762             self.assertEqual(tcp.dport, local_port)
1763             self.assert_packet_checksums_valid(p)
1764         except:
1765             self.logger.error(ppp("Unexpected or invalid packet:", p))
1766             raise
1767
1768         # from service VRF1 back to client VRF0
1769         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
1770              IP(src=self.pg5.remote_ip4, dst=self.pg0.remote_ip4) /
1771              TCP(sport=local_port, dport=12347))
1772         self.pg5.add_stream(p)
1773         self.pg_enable_capture(self.pg_interfaces)
1774         self.pg_start()
1775         capture = self.pg0.get_capture(1)
1776         p = capture[0]
1777         try:
1778             ip = p[IP]
1779             tcp = p[TCP]
1780             self.assertEqual(ip.src, external_addr)
1781             self.assertEqual(tcp.sport, external_port)
1782             self.assert_packet_checksums_valid(p)
1783         except:
1784             self.logger.error(ppp("Unexpected or invalid packet:", p))
1785             raise
1786
1787         # from client to server (both VRF1, no translation)
1788         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
1789              IP(src=self.pg6.remote_ip4, dst=self.pg5.remote_ip4) /
1790              TCP(sport=12348, dport=local_port))
1791         self.pg6.add_stream(p)
1792         self.pg_enable_capture(self.pg_interfaces)
1793         self.pg_start()
1794         capture = self.pg5.get_capture(1)
1795         p = capture[0]
1796         try:
1797             ip = p[IP]
1798             tcp = p[TCP]
1799             self.assertEqual(ip.dst, self.pg5.remote_ip4)
1800             self.assertEqual(tcp.dport, local_port)
1801             self.assert_packet_checksums_valid(p)
1802         except:
1803             self.logger.error(ppp("Unexpected or invalid packet:", p))
1804             raise
1805
1806         # from server back to client (both VRF1, no translation)
1807         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
1808              IP(src=self.pg5.remote_ip4, dst=self.pg6.remote_ip4) /
1809              TCP(sport=local_port, dport=12348))
1810         self.pg5.add_stream(p)
1811         self.pg_enable_capture(self.pg_interfaces)
1812         self.pg_start()
1813         capture = self.pg6.get_capture(1)
1814         p = capture[0]
1815         try:
1816             ip = p[IP]
1817             tcp = p[TCP]
1818             self.assertEqual(ip.src, self.pg5.remote_ip4)
1819             self.assertEqual(tcp.sport, local_port)
1820             self.assert_packet_checksums_valid(p)
1821         except:
1822             self.logger.error(ppp("Unexpected or invalid packet:", p))
1823             raise
1824
1825         # from client VRF1 to server VRF0 (no translation)
1826         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
1827              IP(src=self.pg0.remote_ip4, dst=self.pg6.remote_ip4) /
1828              TCP(sport=local_port, dport=12349))
1829         self.pg0.add_stream(p)
1830         self.pg_enable_capture(self.pg_interfaces)
1831         self.pg_start()
1832         capture = self.pg6.get_capture(1)
1833         p = capture[0]
1834         try:
1835             ip = p[IP]
1836             tcp = p[TCP]
1837             self.assertEqual(ip.src, self.pg0.remote_ip4)
1838             self.assertEqual(tcp.sport, local_port)
1839             self.assert_packet_checksums_valid(p)
1840         except:
1841             self.logger.error(ppp("Unexpected or invalid packet:", p))
1842             raise
1843
1844         # from server VRF0 back to client VRF1 (no translation)
1845         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
1846              IP(src=self.pg0.remote_ip4, dst=self.pg6.remote_ip4) /
1847              TCP(sport=local_port, dport=12349))
1848         self.pg0.add_stream(p)
1849         self.pg_enable_capture(self.pg_interfaces)
1850         self.pg_start()
1851         capture = self.pg6.get_capture(1)
1852         p = capture[0]
1853         try:
1854             ip = p[IP]
1855             tcp = p[TCP]
1856             self.assertEqual(ip.src, self.pg0.remote_ip4)
1857             self.assertEqual(tcp.sport, local_port)
1858             self.assert_packet_checksums_valid(p)
1859         except:
1860             self.logger.error(ppp("Unexpected or invalid packet:", p))
1861             raise
1862
1863         # from client VRF0 to server VRF1 (no translation)
1864         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
1865              IP(src=self.pg0.remote_ip4, dst=self.pg5.remote_ip4) /
1866              TCP(sport=12344, dport=local_port))
1867         self.pg0.add_stream(p)
1868         self.pg_enable_capture(self.pg_interfaces)
1869         self.pg_start()
1870         capture = self.pg5.get_capture(1)
1871         p = capture[0]
1872         try:
1873             ip = p[IP]
1874             tcp = p[TCP]
1875             self.assertEqual(ip.dst, self.pg5.remote_ip4)
1876             self.assertEqual(tcp.dport, local_port)
1877             self.assert_packet_checksums_valid(p)
1878         except:
1879             self.logger.error(ppp("Unexpected or invalid packet:", p))
1880             raise
1881
1882         # from server VRF1 back to client VRF0 (no translation)
1883         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
1884              IP(src=self.pg5.remote_ip4, dst=self.pg0.remote_ip4) /
1885              TCP(sport=local_port, dport=12344))
1886         self.pg5.add_stream(p)
1887         self.pg_enable_capture(self.pg_interfaces)
1888         self.pg_start()
1889         capture = self.pg0.get_capture(1)
1890         p = capture[0]
1891         try:
1892             ip = p[IP]
1893             tcp = p[TCP]
1894             self.assertEqual(ip.src, self.pg5.remote_ip4)
1895             self.assertEqual(tcp.sport, local_port)
1896             self.assert_packet_checksums_valid(p)
1897         except:
1898             self.logger.error(ppp("Unexpected or invalid packet:", p))
1899             raise
1900
1901     def test_outside_address_distribution(self):
1902         """ Outside address distribution based on source address """
1903
1904         x = 100
1905         nat_addresses = []
1906
1907         for i in range(1, x):
1908             a = "10.0.0.%d" % i
1909             nat_addresses.append(a)
1910
1911         self.nat_add_inside_interface(self.pg0)
1912         self.nat_add_outside_interface(self.pg1)
1913
1914         self.vapi.nat44_add_del_address_range(
1915             first_ip_address=nat_addresses[0],
1916             last_ip_address=nat_addresses[-1],
1917             vrf_id=0xFFFFFFFF, is_add=1, flags=0)
1918
1919         self.pg0.generate_remote_hosts(x)
1920
1921         pkts = []
1922         for i in range(x):
1923             info = self.create_packet_info(self.pg0, self.pg1)
1924             payload = self.info_to_payload(info)
1925             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
1926                  IP(src=self.pg0.remote_hosts[i].ip4,
1927                      dst=self.pg1.remote_ip4) /
1928                  UDP(sport=7000+i, dport=8000+i) /
1929                  Raw(payload))
1930             info.data = p
1931             pkts.append(p)
1932
1933         self.pg0.add_stream(pkts)
1934         self.pg_enable_capture(self.pg_interfaces)
1935         self.pg_start()
1936         recvd = self.pg1.get_capture(len(pkts))
1937         for p_recvd in recvd:
1938             payload_info = self.payload_to_info(p_recvd[Raw])
1939             packet_index = payload_info.index
1940             info = self._packet_infos[packet_index]
1941             self.assertTrue(info is not None)
1942             self.assertEqual(packet_index, info.index)
1943             p_sent = info.data
1944             packed = socket.inet_aton(p_sent[IP].src)
1945             numeric = struct.unpack("!L", packed)[0]
1946             numeric = socket.htonl(numeric)
1947             a = nat_addresses[(numeric-1) % len(nat_addresses)]
1948             self.assertEqual(
1949                 a, p_recvd[IP].src,
1950                 "Invalid packet (src IP %s translated to %s, but expected %s)"
1951                 % (p_sent[IP].src, p_recvd[IP].src, a))
1952
1953
1954 class TestNAT44EDMW(TestNAT44ED):
1955     """ NAT44ED MW Test Case """
1956     vpp_worker_count = 4
1957     max_sessions = 5000
1958
1959     @unittest.skip('MW fix required')
1960     def test_users_dump(self):
1961         """ NAT44ED API test - nat44_user_dump """
1962
1963     @unittest.skip('MW fix required')
1964     def test_frag_out_of_order_do_not_translate(self):
1965         """ NAT44ED don't translate fragments arriving out of order """
1966
1967     @unittest.skip('MW fix required')
1968     def test_forwarding(self):
1969         """ NAT44ED forwarding test """
1970
1971     @unittest.skip('MW fix required')
1972     def test_twice_nat(self):
1973         """ NAT44ED Twice NAT """
1974
1975     @unittest.skip('MW fix required')
1976     def test_twice_nat_lb(self):
1977         """ NAT44ED Twice NAT local service load balancing """
1978
1979     @unittest.skip('MW fix required')
1980     def test_output_feature(self):
1981         """ NAT44ED interface output feature (in2out postrouting) """
1982
1983     @unittest.skip('MW fix required')
1984     def test_static_with_port_out2(self):
1985         """ NAT44ED 1:1 NAPT asymmetrical rule """
1986
1987     @unittest.skip('MW fix required')
1988     def test_output_feature_and_service2(self):
1989         """ NAT44ED interface output feature and service host direct access """
1990
1991     @unittest.skip('MW fix required')
1992     def test_static_lb(self):
1993         """ NAT44ED local service load balancing """
1994
1995     @unittest.skip('MW fix required')
1996     def test_static_lb_2(self):
1997         """ NAT44ED local service load balancing (asymmetrical rule) """
1998
1999     @unittest.skip('MW fix required')
2000     def test_lb_affinity(self):
2001         """ NAT44ED local service load balancing affinity """
2002
2003     @unittest.skip('MW fix required')
2004     def test_multiple_vrf(self):
2005         """ NAT44ED Multiple VRF setup """
2006
2007     @unittest.skip('MW fix required')
2008     def test_self_twice_nat_positive(self):
2009         """ NAT44ED Self Twice NAT (positive test) """
2010
2011     @unittest.skip('MW fix required')
2012     def test_self_twice_nat_lb_positive(self):
2013         """ NAT44ED Self Twice NAT local service load balancing (positive test)
2014         """
2015
2016     def test_dynamic(self):
2017         """ NAT44ED dynamic translation test """
2018         pkt_count = 1500
2019         tcp_port_offset = 20
2020         udp_port_offset = 20
2021         icmp_id_offset = 20
2022
2023         self.nat_add_address(self.nat_addr)
2024         self.nat_add_inside_interface(self.pg0)
2025         self.nat_add_outside_interface(self.pg1)
2026
2027         # in2out
2028         tc1 = self.statistics['/nat44-ed/in2out/slowpath/tcp']
2029         uc1 = self.statistics['/nat44-ed/in2out/slowpath/udp']
2030         ic1 = self.statistics['/nat44-ed/in2out/slowpath/icmp']
2031         dc1 = self.statistics['/nat44-ed/in2out/slowpath/drops']
2032
2033         i2o_pkts = [[] for x in range(0, self.vpp_worker_count)]
2034
2035         for i in range(pkt_count):
2036             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2037                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2038                  TCP(sport=tcp_port_offset + i, dport=20))
2039             i2o_pkts[p[TCP].sport % self.vpp_worker_count].append(p)
2040
2041             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2042                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2043                  UDP(sport=udp_port_offset + i, dport=20))
2044             i2o_pkts[p[UDP].sport % self.vpp_worker_count].append(p)
2045
2046             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2047                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2048                  ICMP(id=icmp_id_offset + i, type='echo-request'))
2049             i2o_pkts[p[ICMP].id % self.vpp_worker_count].append(p)
2050
2051         for i in range(0, self.vpp_worker_count):
2052             if len(i2o_pkts[i]) > 0:
2053                 self.pg0.add_stream(i2o_pkts[i], worker=i)
2054
2055         self.pg_enable_capture(self.pg_interfaces)
2056         self.pg_start()
2057         capture = self.pg1.get_capture(pkt_count * 3)
2058
2059         if_idx = self.pg0.sw_if_index
2060         tc2 = self.statistics['/nat44-ed/in2out/slowpath/tcp']
2061         uc2 = self.statistics['/nat44-ed/in2out/slowpath/udp']
2062         ic2 = self.statistics['/nat44-ed/in2out/slowpath/icmp']
2063         dc2 = self.statistics['/nat44-ed/in2out/slowpath/drops']
2064
2065         self.assertEqual(
2066             tc2[:, if_idx].sum() - tc1[:, if_idx].sum(), pkt_count)
2067         self.assertEqual(
2068             uc2[:, if_idx].sum() - uc1[:, if_idx].sum(), pkt_count)
2069         self.assertEqual(
2070             ic2[:, if_idx].sum() - ic1[:, if_idx].sum(), pkt_count)
2071         self.assertEqual(dc2[:, if_idx].sum() - dc1[:, if_idx].sum(), 0)
2072
2073         self.logger.info(self.vapi.cli("show trace"))
2074
2075         # out2in
2076         tc1 = self.statistics['/nat44-ed/out2in/fastpath/tcp']
2077         uc1 = self.statistics['/nat44-ed/out2in/fastpath/udp']
2078         ic1 = self.statistics['/nat44-ed/out2in/fastpath/icmp']
2079         dc1 = self.statistics['/nat44-ed/out2in/fastpath/drops']
2080
2081         recvd_tcp_ports = set()
2082         recvd_udp_ports = set()
2083         recvd_icmp_ids = set()
2084
2085         for p in capture:
2086             if TCP in p:
2087                 recvd_tcp_ports.add(p[TCP].sport)
2088             if UDP in p:
2089                 recvd_udp_ports.add(p[UDP].sport)
2090             if ICMP in p:
2091                 recvd_icmp_ids.add(p[ICMP].id)
2092
2093         recvd_tcp_ports = list(recvd_tcp_ports)
2094         recvd_udp_ports = list(recvd_udp_ports)
2095         recvd_icmp_ids = list(recvd_icmp_ids)
2096
2097         o2i_pkts = [[] for x in range(0, self.vpp_worker_count)]
2098         for i in range(pkt_count):
2099             p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
2100                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
2101                  TCP(dport=choice(recvd_tcp_ports), sport=20))
2102             o2i_pkts[p[TCP].dport % self.vpp_worker_count].append(p)
2103
2104             p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
2105                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
2106                  UDP(dport=choice(recvd_udp_ports), sport=20))
2107             o2i_pkts[p[UDP].dport % self.vpp_worker_count].append(p)
2108
2109             p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
2110                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
2111                  ICMP(id=choice(recvd_icmp_ids), type='echo-reply'))
2112             o2i_pkts[p[ICMP].id % self.vpp_worker_count].append(p)
2113
2114         for i in range(0, self.vpp_worker_count):
2115             if len(o2i_pkts[i]) > 0:
2116                 self.pg1.add_stream(o2i_pkts[i], worker=i)
2117
2118         self.pg_enable_capture(self.pg_interfaces)
2119         self.pg_start()
2120         capture = self.pg0.get_capture(pkt_count * 3)
2121         for packet in capture:
2122             try:
2123                 self.assert_packet_checksums_valid(packet)
2124                 self.assertEqual(packet[IP].dst, self.pg0.remote_ip4)
2125                 if packet.haslayer(TCP):
2126                     self.assert_in_range(
2127                         packet[TCP].dport, tcp_port_offset,
2128                         tcp_port_offset + pkt_count, "dst TCP port")
2129                 elif packet.haslayer(UDP):
2130                     self.assert_in_range(
2131                         packet[UDP].dport, udp_port_offset,
2132                         udp_port_offset + pkt_count, "dst UDP port")
2133                 else:
2134                     self.assert_in_range(
2135                         packet[ICMP].id, icmp_id_offset,
2136                         icmp_id_offset + pkt_count, "ICMP id")
2137             except:
2138                 self.logger.error(ppp("Unexpected or invalid packet "
2139                                       "(inside network):", packet))
2140                 raise
2141
2142         if_idx = self.pg1.sw_if_index
2143         tc2 = self.statistics['/nat44-ed/out2in/fastpath/tcp']
2144         uc2 = self.statistics['/nat44-ed/out2in/fastpath/udp']
2145         ic2 = self.statistics['/nat44-ed/out2in/fastpath/icmp']
2146         dc2 = self.statistics['/nat44-ed/out2in/fastpath/drops']
2147
2148         self.assertEqual(
2149             tc2[:, if_idx].sum() - tc1[:, if_idx].sum(), pkt_count)
2150         self.assertEqual(
2151             uc2[:, if_idx].sum() - uc1[:, if_idx].sum(), pkt_count)
2152         self.assertEqual(
2153             ic2[:, if_idx].sum() - ic1[:, if_idx].sum(), pkt_count)
2154         self.assertEqual(dc2[:, if_idx].sum() - dc1[:, if_idx].sum(), 0)
2155
2156         sc = self.statistics['/nat44-ed/total-sessions']
2157         self.assertEqual(sc[:, 0].sum(), len(recvd_tcp_ports) +
2158                          len(recvd_udp_ports) + len(recvd_icmp_ids))
2159
2160     def test_frag_in_order(self):
2161         """ NAT44ED translate fragments arriving in order """
2162
2163         self.nat_add_address(self.nat_addr)
2164         self.nat_add_inside_interface(self.pg0)
2165         self.nat_add_outside_interface(self.pg1)
2166
2167         self.frag_in_order(proto=IP_PROTOS.tcp, ignore_port=True)
2168         self.frag_in_order(proto=IP_PROTOS.udp, ignore_port=True)
2169         self.frag_in_order(proto=IP_PROTOS.icmp, ignore_port=True)
2170
2171     def test_frag_in_order_do_not_translate(self):
2172         """ NAT44ED don't translate fragments arriving in order """
2173
2174         self.nat_add_address(self.nat_addr)
2175         self.nat_add_inside_interface(self.pg0)
2176         self.nat_add_outside_interface(self.pg1)
2177         self.vapi.nat44_forwarding_enable_disable(enable=True)
2178
2179         self.frag_in_order(proto=IP_PROTOS.tcp, dont_translate=True)
2180
2181     def test_frag_out_of_order(self):
2182         """ NAT44ED translate fragments arriving out of order """
2183
2184         self.nat_add_address(self.nat_addr)
2185         self.nat_add_inside_interface(self.pg0)
2186         self.nat_add_outside_interface(self.pg1)
2187
2188         self.frag_out_of_order(proto=IP_PROTOS.tcp, ignore_port=True)
2189         self.frag_out_of_order(proto=IP_PROTOS.udp, ignore_port=True)
2190         self.frag_out_of_order(proto=IP_PROTOS.icmp, ignore_port=True)
2191
2192     def test_frag_in_order_in_plus_out(self):
2193         """ NAT44ED in+out interface fragments in order """
2194
2195         in_port = self.random_port()
2196         out_port = self.random_port()
2197
2198         self.nat_add_address(self.nat_addr)
2199         self.nat_add_inside_interface(self.pg0)
2200         self.nat_add_outside_interface(self.pg0)
2201         self.nat_add_inside_interface(self.pg1)
2202         self.nat_add_outside_interface(self.pg1)
2203
2204         # add static mappings for server
2205         self.nat_add_static_mapping(self.server_addr,
2206                                     self.nat_addr,
2207                                     in_port,
2208                                     out_port,
2209                                     proto=IP_PROTOS.tcp)
2210         self.nat_add_static_mapping(self.server_addr,
2211                                     self.nat_addr,
2212                                     in_port,
2213                                     out_port,
2214                                     proto=IP_PROTOS.udp)
2215         self.nat_add_static_mapping(self.server_addr,
2216                                     self.nat_addr,
2217                                     proto=IP_PROTOS.icmp)
2218
2219         # run tests for each protocol
2220         self.frag_in_order_in_plus_out(self.server_addr,
2221                                        self.nat_addr,
2222                                        in_port,
2223                                        out_port,
2224                                        IP_PROTOS.tcp)
2225         self.frag_in_order_in_plus_out(self.server_addr,
2226                                        self.nat_addr,
2227                                        in_port,
2228                                        out_port,
2229                                        IP_PROTOS.udp)
2230         self.frag_in_order_in_plus_out(self.server_addr,
2231                                        self.nat_addr,
2232                                        in_port,
2233                                        out_port,
2234                                        IP_PROTOS.icmp)
2235
2236     def test_frag_out_of_order_in_plus_out(self):
2237         """ NAT44ED in+out interface fragments out of order """
2238
2239         in_port = self.random_port()
2240         out_port = self.random_port()
2241
2242         self.nat_add_address(self.nat_addr)
2243         self.nat_add_inside_interface(self.pg0)
2244         self.nat_add_outside_interface(self.pg0)
2245         self.nat_add_inside_interface(self.pg1)
2246         self.nat_add_outside_interface(self.pg1)
2247
2248         # add static mappings for server
2249         self.nat_add_static_mapping(self.server_addr,
2250                                     self.nat_addr,
2251                                     in_port,
2252                                     out_port,
2253                                     proto=IP_PROTOS.tcp)
2254         self.nat_add_static_mapping(self.server_addr,
2255                                     self.nat_addr,
2256                                     in_port,
2257                                     out_port,
2258                                     proto=IP_PROTOS.udp)
2259         self.nat_add_static_mapping(self.server_addr,
2260                                     self.nat_addr,
2261                                     proto=IP_PROTOS.icmp)
2262
2263         # run tests for each protocol
2264         self.frag_out_of_order_in_plus_out(self.server_addr,
2265                                            self.nat_addr,
2266                                            in_port,
2267                                            out_port,
2268                                            IP_PROTOS.tcp)
2269         self.frag_out_of_order_in_plus_out(self.server_addr,
2270                                            self.nat_addr,
2271                                            in_port,
2272                                            out_port,
2273                                            IP_PROTOS.udp)
2274         self.frag_out_of_order_in_plus_out(self.server_addr,
2275                                            self.nat_addr,
2276                                            in_port,
2277                                            out_port,
2278                                            IP_PROTOS.icmp)
2279
2280     def test_reass_hairpinning(self):
2281         """ NAT44ED fragments hairpinning """
2282
2283         server_addr = self.pg0.remote_hosts[1].ip4
2284
2285         host_in_port = self.random_port()
2286         server_in_port = self.random_port()
2287         server_out_port = self.random_port()
2288
2289         self.nat_add_address(self.nat_addr)
2290         self.nat_add_inside_interface(self.pg0)
2291         self.nat_add_outside_interface(self.pg1)
2292
2293         # add static mapping for server
2294         self.nat_add_static_mapping(server_addr, self.nat_addr,
2295                                     server_in_port, server_out_port,
2296                                     proto=IP_PROTOS.tcp)
2297         self.nat_add_static_mapping(server_addr, self.nat_addr,
2298                                     server_in_port, server_out_port,
2299                                     proto=IP_PROTOS.udp)
2300         self.nat_add_static_mapping(server_addr, self.nat_addr)
2301
2302         self.reass_hairpinning(server_addr, server_in_port, server_out_port,
2303                                host_in_port, proto=IP_PROTOS.tcp,
2304                                ignore_port=True)
2305         self.reass_hairpinning(server_addr, server_in_port, server_out_port,
2306                                host_in_port, proto=IP_PROTOS.udp,
2307                                ignore_port=True)
2308         self.reass_hairpinning(server_addr, server_in_port, server_out_port,
2309                                host_in_port, proto=IP_PROTOS.icmp,
2310                                ignore_port=True)
2311
2312     def test_session_limit_per_vrf(self):
2313         """ NAT44ED per vrf session limit """
2314
2315         inside = self.pg0
2316         inside_vrf10 = self.pg2
2317         outside = self.pg1
2318
2319         limit = 5
2320
2321         # 2 interfaces pg0, pg1 (vrf10, limit 1 tcp session)
2322         # non existing vrf_id makes process core dump
2323         self.vapi.nat44_set_session_limit(session_limit=limit, vrf_id=10)
2324
2325         self.nat_add_inside_interface(inside)
2326         self.nat_add_inside_interface(inside_vrf10)
2327         self.nat_add_outside_interface(outside)
2328
2329         # vrf independent
2330         self.nat_add_interface_address(outside)
2331
2332         # BUG: causing core dump - when bad vrf_id is specified
2333         # self.nat_add_address(outside.local_ip4, vrf_id=20)
2334
2335         stream = self.create_tcp_stream(inside_vrf10, outside, limit * 2)
2336         inside_vrf10.add_stream(stream)
2337
2338         self.pg_enable_capture(self.pg_interfaces)
2339         self.pg_start()
2340
2341         capture = outside.get_capture(limit)
2342
2343         stream = self.create_tcp_stream(inside, outside, limit * 2)
2344         inside.add_stream(stream)
2345
2346         self.pg_enable_capture(self.pg_interfaces)
2347         self.pg_start()
2348
2349         capture = outside.get_capture(len(stream))
2350
2351     def test_show_max_translations(self):
2352         """ NAT44ED API test - max translations per thread """
2353         nat_config = self.vapi.nat_show_config_2()
2354         self.assertEqual(self.max_sessions,
2355                          nat_config.max_translations_per_thread)
2356
2357     def test_lru_cleanup(self):
2358         """ NAT44ED LRU cleanup algorithm """
2359
2360         self.nat_add_address(self.nat_addr)
2361         self.nat_add_inside_interface(self.pg0)
2362         self.nat_add_outside_interface(self.pg1)
2363
2364         self.vapi.nat_set_timeouts(
2365             udp=1, tcp_established=7440, tcp_transitory=30, icmp=1)
2366
2367         tcp_port_out = self.init_tcp_session(self.pg0, self.pg1, 2000, 80)
2368         pkts = []
2369         for i in range(0, self.max_sessions - 1):
2370             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2371                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4, ttl=64) /
2372                  UDP(sport=7000+i, dport=80))
2373             pkts.append(p)
2374
2375         self.pg0.add_stream(pkts)
2376         self.pg_enable_capture(self.pg_interfaces)
2377         self.pg_start()
2378         self.pg1.get_capture(len(pkts))
2379         self.sleep(1.5, "wait for timeouts")
2380
2381         pkts = []
2382         for i in range(0, self.max_sessions - 1):
2383             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2384                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4, ttl=64) /
2385                  ICMP(id=8000+i, type='echo-request'))
2386             pkts.append(p)
2387
2388         self.pg0.add_stream(pkts)
2389         self.pg_enable_capture(self.pg_interfaces)
2390         self.pg_start()
2391         self.pg1.get_capture(len(pkts))
2392
2393     def test_session_rst_timeout(self):
2394         """ NAT44ED session RST timeouts """
2395
2396         self.nat_add_address(self.nat_addr)
2397         self.nat_add_inside_interface(self.pg0)
2398         self.nat_add_outside_interface(self.pg1)
2399
2400         self.vapi.nat_set_timeouts(udp=300, tcp_established=7440,
2401                                    tcp_transitory=5, icmp=60)
2402
2403         self.init_tcp_session(self.pg0, self.pg1, self.tcp_port_in,
2404                               self.tcp_external_port)
2405         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
2406              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2407              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
2408                  flags="R"))
2409         self.pg0.add_stream(p)
2410         self.pg_enable_capture(self.pg_interfaces)
2411         self.pg_start()
2412         self.pg1.get_capture(1)
2413
2414         self.sleep(6)
2415
2416         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
2417              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2418              TCP(sport=self.tcp_port_in + 1, dport=self.tcp_external_port + 1,
2419                  flags="S"))
2420         self.pg0.add_stream(p)
2421         self.pg_enable_capture(self.pg_interfaces)
2422         self.pg_start()
2423         self.pg1.get_capture(1)
2424
2425     def test_dynamic_out_of_ports(self):
2426         """ NAT44ED dynamic translation test: out of ports """
2427
2428         self.nat_add_inside_interface(self.pg0)
2429         self.nat_add_outside_interface(self.pg1)
2430
2431         # in2out and no NAT addresses added
2432         err_old = self.statistics.get_err_counter(
2433             '/err/nat44-ed-in2out-slowpath/out of ports')
2434
2435         pkts = self.create_stream_in(self.pg0, self.pg1)
2436         self.pg0.add_stream(pkts)
2437         self.pg_enable_capture(self.pg_interfaces)
2438         self.pg_start()
2439         self.pg1.get_capture(0, timeout=1)
2440
2441         err_new = self.statistics.get_err_counter(
2442             '/err/nat44-ed-in2out-slowpath/out of ports')
2443
2444         self.assertEqual(err_new - err_old, len(pkts))
2445
2446         # in2out after NAT addresses added
2447         self.nat_add_address(self.nat_addr)
2448
2449         err_old = self.statistics.get_err_counter(
2450             '/err/nat44-ed-in2out-slowpath/out of ports')
2451
2452         pkts = self.create_stream_in(self.pg0, self.pg1)
2453         self.pg0.add_stream(pkts)
2454         self.pg_enable_capture(self.pg_interfaces)
2455         self.pg_start()
2456         capture = self.pg1.get_capture(len(pkts))
2457         self.verify_capture_out(capture, ignore_port=True)
2458
2459         err_new = self.statistics.get_err_counter(
2460             '/err/nat44-ed-in2out-slowpath/out of ports')
2461
2462         self.assertEqual(err_new, err_old)
2463
2464     def test_unknown_proto(self):
2465         """ NAT44ED translate packet with unknown protocol """
2466
2467         self.nat_add_address(self.nat_addr)
2468         self.nat_add_inside_interface(self.pg0)
2469         self.nat_add_outside_interface(self.pg1)
2470
2471         # in2out
2472         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2473              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2474              TCP(sport=self.tcp_port_in, dport=20))
2475         self.pg0.add_stream(p)
2476         self.pg_enable_capture(self.pg_interfaces)
2477         self.pg_start()
2478         p = self.pg1.get_capture(1)
2479
2480         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2481              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2482              GRE() /
2483              IP(src=self.pg2.remote_ip4, dst=self.pg2.remote_ip4) /
2484              TCP(sport=1234, dport=1234))
2485         self.pg0.add_stream(p)
2486         self.pg_enable_capture(self.pg_interfaces)
2487         self.pg_start()
2488         p = self.pg1.get_capture(1)
2489         packet = p[0]
2490         try:
2491             self.assertEqual(packet[IP].src, self.nat_addr)
2492             self.assertEqual(packet[IP].dst, self.pg1.remote_ip4)
2493             self.assertEqual(packet.haslayer(GRE), 1)
2494             self.assert_packet_checksums_valid(packet)
2495         except:
2496             self.logger.error(ppp("Unexpected or invalid packet:", packet))
2497             raise
2498
2499         # out2in
2500         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
2501              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
2502              GRE() /
2503              IP(src=self.pg2.remote_ip4, dst=self.pg2.remote_ip4) /
2504              TCP(sport=1234, dport=1234))
2505         self.pg1.add_stream(p)
2506         self.pg_enable_capture(self.pg_interfaces)
2507         self.pg_start()
2508         p = self.pg0.get_capture(1)
2509         packet = p[0]
2510         try:
2511             self.assertEqual(packet[IP].src, self.pg1.remote_ip4)
2512             self.assertEqual(packet[IP].dst, self.pg0.remote_ip4)
2513             self.assertEqual(packet.haslayer(GRE), 1)
2514             self.assert_packet_checksums_valid(packet)
2515         except:
2516             self.logger.error(ppp("Unexpected or invalid packet:", packet))
2517             raise
2518
2519     def test_hairpinning_unknown_proto(self):
2520         """ NAT44ED translate packet with unknown protocol - hairpinning """
2521         host = self.pg0.remote_hosts[0]
2522         server = self.pg0.remote_hosts[1]
2523         host_in_port = 1234
2524         server_out_port = 8765
2525         server_nat_ip = "10.0.0.11"
2526
2527         self.nat_add_address(self.nat_addr)
2528         self.nat_add_inside_interface(self.pg0)
2529         self.nat_add_outside_interface(self.pg1)
2530
2531         # add static mapping for server
2532         self.nat_add_static_mapping(server.ip4, server_nat_ip)
2533
2534         # host to server
2535         p = (Ether(src=host.mac, dst=self.pg0.local_mac) /
2536              IP(src=host.ip4, dst=server_nat_ip) /
2537              TCP(sport=host_in_port, dport=server_out_port))
2538         self.pg0.add_stream(p)
2539         self.pg_enable_capture(self.pg_interfaces)
2540         self.pg_start()
2541         self.pg0.get_capture(1)
2542
2543         p = (Ether(dst=self.pg0.local_mac, src=host.mac) /
2544              IP(src=host.ip4, dst=server_nat_ip) /
2545              GRE() /
2546              IP(src=self.pg2.remote_ip4, dst=self.pg2.remote_ip4) /
2547              TCP(sport=1234, dport=1234))
2548         self.pg0.add_stream(p)
2549         self.pg_enable_capture(self.pg_interfaces)
2550         self.pg_start()
2551         p = self.pg0.get_capture(1)
2552         packet = p[0]
2553         try:
2554             self.assertEqual(packet[IP].src, self.nat_addr)
2555             self.assertEqual(packet[IP].dst, server.ip4)
2556             self.assertEqual(packet.haslayer(GRE), 1)
2557             self.assert_packet_checksums_valid(packet)
2558         except:
2559             self.logger.error(ppp("Unexpected or invalid packet:", packet))
2560             raise
2561
2562         # server to host
2563         p = (Ether(dst=self.pg0.local_mac, src=server.mac) /
2564              IP(src=server.ip4, dst=self.nat_addr) /
2565              GRE() /
2566              IP(src=self.pg2.remote_ip4, dst=self.pg2.remote_ip4) /
2567              TCP(sport=1234, dport=1234))
2568         self.pg0.add_stream(p)
2569         self.pg_enable_capture(self.pg_interfaces)
2570         self.pg_start()
2571         p = self.pg0.get_capture(1)
2572         packet = p[0]
2573         try:
2574             self.assertEqual(packet[IP].src, server_nat_ip)
2575             self.assertEqual(packet[IP].dst, host.ip4)
2576             self.assertEqual(packet.haslayer(GRE), 1)
2577             self.assert_packet_checksums_valid(packet)
2578         except:
2579             self.logger.error(ppp("Unexpected or invalid packet:", packet))
2580             raise
2581
2582     def test_output_feature_and_service(self):
2583         """ NAT44ED interface output feature and services """
2584         external_addr = '1.2.3.4'
2585         external_port = 80
2586         local_port = 8080
2587
2588         self.vapi.nat44_forwarding_enable_disable(enable=1)
2589         self.nat_add_address(self.nat_addr)
2590         flags = self.config_flags.NAT_IS_ADDR_ONLY
2591         self.vapi.nat44_add_del_identity_mapping(
2592             ip_address=self.pg1.remote_ip4, sw_if_index=0xFFFFFFFF,
2593             flags=flags, is_add=1)
2594         flags = self.config_flags.NAT_IS_OUT2IN_ONLY
2595         self.nat_add_static_mapping(self.pg0.remote_ip4, external_addr,
2596                                     local_port, external_port,
2597                                     proto=IP_PROTOS.tcp, flags=flags)
2598
2599         self.nat_add_inside_interface(self.pg0)
2600         self.nat_add_outside_interface(self.pg0)
2601         self.vapi.nat44_interface_add_del_output_feature(
2602             sw_if_index=self.pg1.sw_if_index, is_add=1)
2603
2604         # from client to service
2605         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
2606              IP(src=self.pg1.remote_ip4, dst=external_addr) /
2607              TCP(sport=12345, dport=external_port))
2608         self.pg1.add_stream(p)
2609         self.pg_enable_capture(self.pg_interfaces)
2610         self.pg_start()
2611         capture = self.pg0.get_capture(1)
2612         p = capture[0]
2613         try:
2614             ip = p[IP]
2615             tcp = p[TCP]
2616             self.assertEqual(ip.dst, self.pg0.remote_ip4)
2617             self.assertEqual(tcp.dport, local_port)
2618             self.assert_packet_checksums_valid(p)
2619         except:
2620             self.logger.error(ppp("Unexpected or invalid packet:", p))
2621             raise
2622
2623         # from service back to client
2624         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
2625              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2626              TCP(sport=local_port, dport=12345))
2627         self.pg0.add_stream(p)
2628         self.pg_enable_capture(self.pg_interfaces)
2629         self.pg_start()
2630         capture = self.pg1.get_capture(1)
2631         p = capture[0]
2632         try:
2633             ip = p[IP]
2634             tcp = p[TCP]
2635             self.assertEqual(ip.src, external_addr)
2636             self.assertEqual(tcp.sport, external_port)
2637             self.assert_packet_checksums_valid(p)
2638         except:
2639             self.logger.error(ppp("Unexpected or invalid packet:", p))
2640             raise
2641
2642         # from local network host to external network
2643         pkts = self.create_stream_in(self.pg0, self.pg1)
2644         self.pg0.add_stream(pkts)
2645         self.pg_enable_capture(self.pg_interfaces)
2646         self.pg_start()
2647         capture = self.pg1.get_capture(len(pkts))
2648         self.verify_capture_out(capture, ignore_port=True)
2649         pkts = self.create_stream_in(self.pg0, self.pg1)
2650         self.pg0.add_stream(pkts)
2651         self.pg_enable_capture(self.pg_interfaces)
2652         self.pg_start()
2653         capture = self.pg1.get_capture(len(pkts))
2654         self.verify_capture_out(capture, ignore_port=True)
2655
2656         # from external network back to local network host
2657         pkts = self.create_stream_out(self.pg1)
2658         self.pg1.add_stream(pkts)
2659         self.pg_enable_capture(self.pg_interfaces)
2660         self.pg_start()
2661         capture = self.pg0.get_capture(len(pkts))
2662         self.verify_capture_in(capture, self.pg0)
2663
2664     def test_output_feature_and_service3(self):
2665         """ NAT44ED interface output feature and DST NAT """
2666         external_addr = '1.2.3.4'
2667         external_port = 80
2668         local_port = 8080
2669
2670         self.vapi.nat44_forwarding_enable_disable(enable=1)
2671         self.nat_add_address(self.nat_addr)
2672         flags = self.config_flags.NAT_IS_OUT2IN_ONLY
2673         self.nat_add_static_mapping(self.pg1.remote_ip4, external_addr,
2674                                     local_port, external_port,
2675                                     proto=IP_PROTOS.tcp, flags=flags)
2676
2677         self.nat_add_inside_interface(self.pg0)
2678         self.nat_add_outside_interface(self.pg0)
2679         self.vapi.nat44_interface_add_del_output_feature(
2680             sw_if_index=self.pg1.sw_if_index, is_add=1)
2681
2682         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
2683              IP(src=self.pg0.remote_ip4, dst=external_addr) /
2684              TCP(sport=12345, dport=external_port))
2685         self.pg0.add_stream(p)
2686         self.pg_enable_capture(self.pg_interfaces)
2687         self.pg_start()
2688         capture = self.pg1.get_capture(1)
2689         p = capture[0]
2690         try:
2691             ip = p[IP]
2692             tcp = p[TCP]
2693             self.assertEqual(ip.src, self.pg0.remote_ip4)
2694             self.assertEqual(tcp.sport, 12345)
2695             self.assertEqual(ip.dst, self.pg1.remote_ip4)
2696             self.assertEqual(tcp.dport, local_port)
2697             self.assert_packet_checksums_valid(p)
2698         except:
2699             self.logger.error(ppp("Unexpected or invalid packet:", p))
2700             raise
2701
2702         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
2703              IP(src=self.pg1.remote_ip4, dst=self.pg0.remote_ip4) /
2704              TCP(sport=local_port, dport=12345))
2705         self.pg1.add_stream(p)
2706         self.pg_enable_capture(self.pg_interfaces)
2707         self.pg_start()
2708         capture = self.pg0.get_capture(1)
2709         p = capture[0]
2710         try:
2711             ip = p[IP]
2712             tcp = p[TCP]
2713             self.assertEqual(ip.src, external_addr)
2714             self.assertEqual(tcp.sport, external_port)
2715             self.assertEqual(ip.dst, self.pg0.remote_ip4)
2716             self.assertEqual(tcp.dport, 12345)
2717             self.assert_packet_checksums_valid(p)
2718         except:
2719             self.logger.error(ppp("Unexpected or invalid packet:", p))
2720             raise
2721
2722     def test_self_twice_nat_lb_negative(self):
2723         """ NAT44ED Self Twice NAT local service load balancing (negative test)
2724         """
2725         self.twice_nat_common(lb=True, self_twice_nat=True, same_pg=True,
2726                               client_id=2)
2727
2728     def test_self_twice_nat_negative(self):
2729         """ NAT44ED Self Twice NAT (negative test) """
2730         self.twice_nat_common(self_twice_nat=True)
2731
2732     def test_static_lb_multi_clients(self):
2733         """ NAT44ED local service load balancing - multiple clients"""
2734
2735         external_addr = self.nat_addr
2736         external_port = 80
2737         local_port = 8080
2738         server1 = self.pg0.remote_hosts[0]
2739         server2 = self.pg0.remote_hosts[1]
2740         server3 = self.pg0.remote_hosts[2]
2741
2742         locals = [{'addr': server1.ip4,
2743                    'port': local_port,
2744                    'probability': 90,
2745                    'vrf_id': 0},
2746                   {'addr': server2.ip4,
2747                    'port': local_port,
2748                    'probability': 10,
2749                    'vrf_id': 0}]
2750
2751         flags = self.config_flags.NAT_IS_INSIDE
2752         self.vapi.nat44_interface_add_del_feature(
2753             sw_if_index=self.pg0.sw_if_index,
2754             flags=flags, is_add=1)
2755         self.vapi.nat44_interface_add_del_feature(
2756             sw_if_index=self.pg1.sw_if_index,
2757             is_add=1)
2758
2759         self.nat_add_address(self.nat_addr)
2760         self.vapi.nat44_add_del_lb_static_mapping(is_add=1,
2761                                                   external_addr=external_addr,
2762                                                   external_port=external_port,
2763                                                   protocol=IP_PROTOS.tcp,
2764                                                   local_num=len(locals),
2765                                                   locals=locals)
2766
2767         server1_n = 0
2768         server2_n = 0
2769         clients = ip4_range(self.pg1.remote_ip4, 10, 50)
2770         pkts = []
2771         for client in clients:
2772             p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
2773                  IP(src=client, dst=self.nat_addr) /
2774                  TCP(sport=12345, dport=external_port))
2775             pkts.append(p)
2776         self.pg1.add_stream(pkts)
2777         self.pg_enable_capture(self.pg_interfaces)
2778         self.pg_start()
2779         capture = self.pg0.get_capture(len(pkts))
2780         for p in capture:
2781             if p[IP].dst == server1.ip4:
2782                 server1_n += 1
2783             else:
2784                 server2_n += 1
2785         self.assertGreaterEqual(server1_n, server2_n)
2786
2787         local = {
2788             'addr': server3.ip4,
2789             'port': local_port,
2790             'probability': 20,
2791             'vrf_id': 0
2792         }
2793
2794         # add new back-end
2795         self.vapi.nat44_lb_static_mapping_add_del_local(
2796             is_add=1,
2797             external_addr=external_addr,
2798             external_port=external_port,
2799             local=local,
2800             protocol=IP_PROTOS.tcp)
2801         server1_n = 0
2802         server2_n = 0
2803         server3_n = 0
2804         clients = ip4_range(self.pg1.remote_ip4, 60, 110)
2805         pkts = []
2806         for client in clients:
2807             p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
2808                  IP(src=client, dst=self.nat_addr) /
2809                  TCP(sport=12346, dport=external_port))
2810             pkts.append(p)
2811         self.assertGreater(len(pkts), 0)
2812         self.pg1.add_stream(pkts)
2813         self.pg_enable_capture(self.pg_interfaces)
2814         self.pg_start()
2815         capture = self.pg0.get_capture(len(pkts))
2816         for p in capture:
2817             if p[IP].dst == server1.ip4:
2818                 server1_n += 1
2819             elif p[IP].dst == server2.ip4:
2820                 server2_n += 1
2821             else:
2822                 server3_n += 1
2823         self.assertGreater(server1_n, 0)
2824         self.assertGreater(server2_n, 0)
2825         self.assertGreater(server3_n, 0)
2826
2827         local = {
2828             'addr': server2.ip4,
2829             'port': local_port,
2830             'probability': 10,
2831             'vrf_id': 0
2832         }
2833
2834         # remove one back-end
2835         self.vapi.nat44_lb_static_mapping_add_del_local(
2836             is_add=0,
2837             external_addr=external_addr,
2838             external_port=external_port,
2839             local=local,
2840             protocol=IP_PROTOS.tcp)
2841         server1_n = 0
2842         server2_n = 0
2843         server3_n = 0
2844         self.pg1.add_stream(pkts)
2845         self.pg_enable_capture(self.pg_interfaces)
2846         self.pg_start()
2847         capture = self.pg0.get_capture(len(pkts))
2848         for p in capture:
2849             if p[IP].dst == server1.ip4:
2850                 server1_n += 1
2851             elif p[IP].dst == server2.ip4:
2852                 server2_n += 1
2853             else:
2854                 server3_n += 1
2855         self.assertGreater(server1_n, 0)
2856         self.assertEqual(server2_n, 0)
2857         self.assertGreater(server3_n, 0)
2858
2859     def test_syslog_sess(self):
2860         """ NAT44ED Test syslog session creation and deletion """
2861         self.vapi.syslog_set_filter(
2862             self.syslog_severity.SYSLOG_API_SEVERITY_INFO)
2863         self.vapi.syslog_set_sender(self.pg3.local_ip4, self.pg3.remote_ip4)
2864
2865         self.nat_add_address(self.nat_addr)
2866         self.nat_add_inside_interface(self.pg0)
2867         self.nat_add_outside_interface(self.pg1)
2868
2869         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2870              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2871              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port))
2872         self.pg0.add_stream(p)
2873         self.pg_enable_capture(self.pg_interfaces)
2874         self.pg_start()
2875         capture = self.pg1.get_capture(1)
2876         self.tcp_port_out = capture[0][TCP].sport
2877         capture = self.pg3.get_capture(1)
2878         self.verify_syslog_sess(capture[0][Raw].load)
2879
2880         self.pg_enable_capture(self.pg_interfaces)
2881         self.pg_start()
2882         self.nat_add_address(self.nat_addr, is_add=0)
2883         capture = self.pg3.get_capture(1)
2884         self.verify_syslog_sess(capture[0][Raw].load, False)
2885
2886     def test_twice_nat_interface_addr(self):
2887         """ NAT44ED Acquire twice NAT addresses from interface """
2888         flags = self.config_flags.NAT_IS_TWICE_NAT
2889         self.vapi.nat44_add_del_interface_addr(
2890             sw_if_index=self.pg11.sw_if_index,
2891             flags=flags, is_add=1)
2892
2893         # no address in NAT pool
2894         adresses = self.vapi.nat44_address_dump()
2895         self.assertEqual(0, len(adresses))
2896
2897         # configure interface address and check NAT address pool
2898         self.pg11.config_ip4()
2899         adresses = self.vapi.nat44_address_dump()
2900         self.assertEqual(1, len(adresses))
2901         self.assertEqual(str(adresses[0].ip_address),
2902                          self.pg11.local_ip4)
2903         self.assertEqual(adresses[0].flags, flags)
2904
2905         # remove interface address and check NAT address pool
2906         self.pg11.unconfig_ip4()
2907         adresses = self.vapi.nat44_address_dump()
2908         self.assertEqual(0, len(adresses))
2909
2910     def test_output_feature_stateful_acl(self):
2911         """ NAT44ED output feature works with stateful ACL """
2912
2913         self.nat_add_address(self.nat_addr)
2914         self.vapi.nat44_interface_add_del_output_feature(
2915             sw_if_index=self.pg0.sw_if_index,
2916             flags=self.config_flags.NAT_IS_INSIDE, is_add=1)
2917         self.vapi.nat44_interface_add_del_output_feature(
2918             sw_if_index=self.pg1.sw_if_index,
2919             flags=self.config_flags.NAT_IS_OUTSIDE, is_add=1)
2920
2921         # First ensure that the NAT is working sans ACL
2922
2923         # send packets out2in, no sessions yet so packets should drop
2924         pkts_out2in = self.create_stream_out(self.pg1)
2925         self.send_and_assert_no_replies(self.pg1, pkts_out2in)
2926
2927         # send packets into inside intf, ensure received via outside intf
2928         pkts_in2out = self.create_stream_in(self.pg0, self.pg1)
2929         capture = self.send_and_expect(self.pg0, pkts_in2out, self.pg1,
2930                                        len(pkts_in2out))
2931         self.verify_capture_out(capture, ignore_port=True)
2932
2933         # send out2in again, with sessions created it should work now
2934         pkts_out2in = self.create_stream_out(self.pg1)
2935         capture = self.send_and_expect(self.pg1, pkts_out2in, self.pg0,
2936                                        len(pkts_out2in))
2937         self.verify_capture_in(capture, self.pg0)
2938
2939         # Create an ACL blocking everything
2940         out2in_deny_rule = AclRule(is_permit=0)
2941         out2in_acl = VppAcl(self, rules=[out2in_deny_rule])
2942         out2in_acl.add_vpp_config()
2943
2944         # create an ACL to permit/reflect everything
2945         in2out_reflect_rule = AclRule(is_permit=2)
2946         in2out_acl = VppAcl(self, rules=[in2out_reflect_rule])
2947         in2out_acl.add_vpp_config()
2948
2949         # apply as input acl on interface and confirm it blocks everything
2950         acl_if = VppAclInterface(self, sw_if_index=self.pg1.sw_if_index,
2951                                  n_input=1, acls=[out2in_acl])
2952         acl_if.add_vpp_config()
2953         self.send_and_assert_no_replies(self.pg1, pkts_out2in)
2954
2955         # apply output acl
2956         acl_if.acls = [out2in_acl, in2out_acl]
2957         acl_if.add_vpp_config()
2958         # send in2out to generate ACL state (NAT state was created earlier)
2959         capture = self.send_and_expect(self.pg0, pkts_in2out, self.pg1,
2960                                        len(pkts_in2out))
2961         self.verify_capture_out(capture, ignore_port=True)
2962
2963         # send out2in again. ACL state exists so it should work now.
2964         # TCP packets with the syn flag set also need the ack flag
2965         for p in pkts_out2in:
2966             if p.haslayer(TCP) and p[TCP].flags & 0x02:
2967                 p[TCP].flags |= 0x10
2968         capture = self.send_and_expect(self.pg1, pkts_out2in, self.pg0,
2969                                        len(pkts_out2in))
2970         self.verify_capture_in(capture, self.pg0)
2971         self.logger.info(self.vapi.cli("show trace"))
2972
2973     def test_tcp_close(self):
2974         """ NAT44ED Close TCP session from inside network - output feature """
2975         old_timeouts = self.vapi.nat_get_timeouts()
2976         new_transitory = 2
2977         self.vapi.nat_set_timeouts(
2978             udp=old_timeouts.udp,
2979             tcp_established=old_timeouts.tcp_established,
2980             icmp=old_timeouts.icmp,
2981             tcp_transitory=new_transitory)
2982
2983         self.vapi.nat44_forwarding_enable_disable(enable=1)
2984         self.nat_add_address(self.pg1.local_ip4)
2985         twice_nat_addr = '10.0.1.3'
2986         service_ip = '192.168.16.150'
2987         self.nat_add_address(twice_nat_addr, twice_nat=1)
2988
2989         flags = self.config_flags.NAT_IS_INSIDE
2990         self.vapi.nat44_interface_add_del_feature(
2991             sw_if_index=self.pg0.sw_if_index,
2992             is_add=1)
2993         self.vapi.nat44_interface_add_del_feature(
2994             sw_if_index=self.pg0.sw_if_index,
2995             flags=flags, is_add=1)
2996         self.vapi.nat44_interface_add_del_output_feature(
2997             is_add=1,
2998             sw_if_index=self.pg1.sw_if_index)
2999
3000         flags = (self.config_flags.NAT_IS_OUT2IN_ONLY |
3001                  self.config_flags.NAT_IS_TWICE_NAT)
3002         self.nat_add_static_mapping(self.pg0.remote_ip4,
3003                                     service_ip, 80, 80,
3004                                     proto=IP_PROTOS.tcp,
3005                                     flags=flags)
3006         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3007         start_sessnum = len(sessions)
3008
3009         # SYN packet out->in
3010         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3011              IP(src=self.pg1.remote_ip4, dst=service_ip) /
3012              TCP(sport=33898, dport=80, flags="S"))
3013         self.pg1.add_stream(p)
3014         self.pg_enable_capture(self.pg_interfaces)
3015         self.pg_start()
3016         capture = self.pg0.get_capture(1)
3017         p = capture[0]
3018         tcp_port = p[TCP].sport
3019
3020         # SYN + ACK packet in->out
3021         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3022              IP(src=self.pg0.remote_ip4, dst=twice_nat_addr) /
3023              TCP(sport=80, dport=tcp_port, flags="SA"))
3024         self.pg0.add_stream(p)
3025         self.pg_enable_capture(self.pg_interfaces)
3026         self.pg_start()
3027         self.pg1.get_capture(1)
3028
3029         # ACK packet out->in
3030         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3031              IP(src=self.pg1.remote_ip4, dst=service_ip) /
3032              TCP(sport=33898, dport=80, flags="A"))
3033         self.pg1.add_stream(p)
3034         self.pg_enable_capture(self.pg_interfaces)
3035         self.pg_start()
3036         self.pg0.get_capture(1)
3037
3038         # FIN packet in -> out
3039         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3040              IP(src=self.pg0.remote_ip4, dst=twice_nat_addr) /
3041              TCP(sport=80, dport=tcp_port, flags="FA", seq=100, ack=300))
3042         self.pg0.add_stream(p)
3043         self.pg_enable_capture(self.pg_interfaces)
3044         self.pg_start()
3045         self.pg1.get_capture(1)
3046
3047         # FIN+ACK packet out -> in
3048         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3049              IP(src=self.pg1.remote_ip4, dst=service_ip) /
3050              TCP(sport=33898, dport=80, flags="FA", seq=300, ack=101))
3051         self.pg1.add_stream(p)
3052         self.pg_enable_capture(self.pg_interfaces)
3053         self.pg_start()
3054         self.pg0.get_capture(1)
3055
3056         # ACK packet in -> out
3057         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3058              IP(src=self.pg0.remote_ip4, dst=twice_nat_addr) /
3059              TCP(sport=80, dport=tcp_port, flags="A", seq=101, ack=301))
3060         self.pg0.add_stream(p)
3061         self.pg_enable_capture(self.pg_interfaces)
3062         self.pg_start()
3063         self.pg1.get_capture(1)
3064
3065         # session now in transitory timeout
3066         # try SYN packet out->in - should be dropped
3067         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3068              IP(src=self.pg1.remote_ip4, dst=service_ip) /
3069              TCP(sport=33898, dport=80, flags="S"))
3070         self.pg1.add_stream(p)
3071         self.pg_enable_capture(self.pg_interfaces)
3072         self.pg_start()
3073
3074         self.sleep(new_transitory, "wait for transitory timeout")
3075         self.pg0.assert_nothing_captured(0)
3076
3077         # session should still exist
3078         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3079         self.assertEqual(len(sessions) - start_sessnum, 1)
3080
3081         # send FIN+ACK packet out -> in - will cause session to be wiped
3082         # but won't create a new session
3083         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3084              IP(src=self.pg1.remote_ip4, dst=service_ip) /
3085              TCP(sport=33898, dport=80, flags="FA", seq=300, ack=101))
3086         self.pg1.add_stream(p)
3087         self.pg_enable_capture(self.pg_interfaces)
3088         self.pg_start()
3089
3090         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3091         self.assertEqual(len(sessions) - start_sessnum, 0)
3092         self.pg0.assert_nothing_captured(0)
3093
3094     def test_tcp_session_close_in(self):
3095         """ NAT44ED Close TCP session from inside network """
3096
3097         in_port = self.tcp_port_in
3098         out_port = 10505
3099         ext_port = self.tcp_external_port
3100
3101         self.nat_add_address(self.nat_addr)
3102         self.nat_add_inside_interface(self.pg0)
3103         self.nat_add_outside_interface(self.pg1)
3104         self.nat_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
3105                                     in_port, out_port, proto=IP_PROTOS.tcp,
3106                                     flags=self.config_flags.NAT_IS_TWICE_NAT)
3107
3108         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3109         session_n = len(sessions)
3110
3111         self.vapi.nat_set_timeouts(udp=300, tcp_established=7440,
3112                                    tcp_transitory=2, icmp=5)
3113
3114         self.init_tcp_session(self.pg0, self.pg1, in_port, ext_port)
3115
3116         # FIN packet in -> out
3117         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3118              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3119              TCP(sport=in_port, dport=ext_port,
3120                  flags="FA", seq=100, ack=300))
3121         self.pg0.add_stream(p)
3122         self.pg_enable_capture(self.pg_interfaces)
3123         self.pg_start()
3124         self.pg1.get_capture(1)
3125
3126         pkts = []
3127
3128         # ACK packet out -> in
3129         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3130              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3131              TCP(sport=ext_port, dport=out_port,
3132                  flags="A", seq=300, ack=101))
3133         pkts.append(p)
3134
3135         # FIN packet out -> in
3136         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3137              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3138              TCP(sport=ext_port, dport=out_port,
3139                  flags="FA", seq=300, ack=101))
3140         pkts.append(p)
3141
3142         self.pg1.add_stream(pkts)
3143         self.pg_enable_capture(self.pg_interfaces)
3144         self.pg_start()
3145         self.pg0.get_capture(2)
3146
3147         # ACK packet in -> out
3148         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3149              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3150              TCP(sport=in_port, dport=ext_port,
3151                  flags="A", seq=101, ack=301))
3152         self.pg0.add_stream(p)
3153         self.pg_enable_capture(self.pg_interfaces)
3154         self.pg_start()
3155         self.pg1.get_capture(1)
3156
3157         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3158         self.assertEqual(len(sessions) - session_n, 1)
3159
3160         out2in_drops = self.get_err_counter(
3161             '/err/nat44-ed-out2in/drops due to TCP in transitory timeout')
3162         in2out_drops = self.get_err_counter(
3163             '/err/nat44-ed-in2out/drops due to TCP in transitory timeout')
3164
3165         # extra FIN packet out -> in - this should be dropped
3166         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3167              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3168              TCP(sport=ext_port, dport=out_port,
3169                  flags="FA", seq=300, ack=101))
3170
3171         self.pg1.add_stream(p)
3172         self.pg_enable_capture(self.pg_interfaces)
3173         self.pg_start()
3174         self.pg0.assert_nothing_captured()
3175
3176         # extra ACK packet in -> out - this should be dropped
3177         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3178              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3179              TCP(sport=in_port, dport=ext_port,
3180                  flags="A", seq=101, ack=301))
3181         self.pg0.add_stream(p)
3182         self.pg_enable_capture(self.pg_interfaces)
3183         self.pg_start()
3184         self.pg1.assert_nothing_captured()
3185
3186         stats = self.get_err_counter(
3187             '/err/nat44-ed-out2in/drops due to TCP in transitory timeout')
3188         self.assertEqual(stats - out2in_drops, 1)
3189         stats = self.get_err_counter(
3190             '/err/nat44-ed-in2out/drops due to TCP in transitory timeout')
3191         self.assertEqual(stats - in2out_drops, 1)
3192
3193         self.sleep(3)
3194         # extra ACK packet in -> out - this will cause session to be wiped
3195         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3196              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3197              TCP(sport=in_port, dport=ext_port,
3198                  flags="A", seq=101, ack=301))
3199         self.pg0.add_stream(p)
3200         self.pg_enable_capture(self.pg_interfaces)
3201         self.pg_start()
3202         self.pg1.assert_nothing_captured()
3203         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3204         self.assertEqual(len(sessions) - session_n, 0)
3205
3206     def test_tcp_session_close_out(self):
3207         """ NAT44ED Close TCP session from outside network """
3208
3209         in_port = self.tcp_port_in
3210         out_port = 10505
3211         ext_port = self.tcp_external_port
3212
3213         self.nat_add_address(self.nat_addr)
3214         self.nat_add_inside_interface(self.pg0)
3215         self.nat_add_outside_interface(self.pg1)
3216         self.nat_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
3217                                     in_port, out_port, proto=IP_PROTOS.tcp,
3218                                     flags=self.config_flags.NAT_IS_TWICE_NAT)
3219
3220         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3221         session_n = len(sessions)
3222
3223         self.vapi.nat_set_timeouts(udp=300, tcp_established=7440,
3224                                    tcp_transitory=2, icmp=5)
3225
3226         _ = self.init_tcp_session(self.pg0, self.pg1, in_port, ext_port)
3227
3228         # FIN packet out -> in
3229         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3230              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3231              TCP(sport=ext_port, dport=out_port,
3232                  flags="FA", seq=100, ack=300))
3233         self.pg1.add_stream(p)
3234         self.pg_enable_capture(self.pg_interfaces)
3235         self.pg_start()
3236         self.pg0.get_capture(1)
3237
3238         # FIN+ACK packet in -> out
3239         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3240              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3241              TCP(sport=in_port, dport=ext_port,
3242                  flags="FA", seq=300, ack=101))
3243
3244         self.pg0.add_stream(p)
3245         self.pg_enable_capture(self.pg_interfaces)
3246         self.pg_start()
3247         self.pg1.get_capture(1)
3248
3249         # ACK packet out -> in
3250         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3251              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3252              TCP(sport=ext_port, dport=out_port,
3253                  flags="A", seq=101, ack=301))
3254         self.pg1.add_stream(p)
3255         self.pg_enable_capture(self.pg_interfaces)
3256         self.pg_start()
3257         self.pg0.get_capture(1)
3258
3259         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3260         self.assertEqual(len(sessions) - session_n, 1)
3261
3262         out2in_drops = self.get_err_counter(
3263             '/err/nat44-ed-out2in/drops due to TCP in transitory timeout')
3264         in2out_drops = self.get_err_counter(
3265             '/err/nat44-ed-in2out/drops due to TCP in transitory timeout')
3266
3267         # extra FIN packet out -> in - this should be dropped
3268         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3269              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3270              TCP(sport=ext_port, dport=out_port,
3271                  flags="FA", seq=300, ack=101))
3272
3273         self.pg1.add_stream(p)
3274         self.pg_enable_capture(self.pg_interfaces)
3275         self.pg_start()
3276         self.pg0.assert_nothing_captured()
3277
3278         # extra ACK packet in -> out - this should be dropped
3279         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3280              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3281              TCP(sport=in_port, dport=ext_port,
3282                  flags="A", seq=101, ack=301))
3283         self.pg0.add_stream(p)
3284         self.pg_enable_capture(self.pg_interfaces)
3285         self.pg_start()
3286         self.pg1.assert_nothing_captured()
3287
3288         stats = self.get_err_counter(
3289             '/err/nat44-ed-out2in/drops due to TCP in transitory timeout')
3290         self.assertEqual(stats - out2in_drops, 1)
3291         stats = self.get_err_counter(
3292             '/err/nat44-ed-in2out/drops due to TCP in transitory timeout')
3293         self.assertEqual(stats - in2out_drops, 1)
3294
3295         self.sleep(3)
3296         # extra ACK packet in -> out - this will cause session to be wiped
3297         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3298              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3299              TCP(sport=in_port, dport=ext_port,
3300                  flags="A", seq=101, ack=301))
3301         self.pg0.add_stream(p)
3302         self.pg_enable_capture(self.pg_interfaces)
3303         self.pg_start()
3304         self.pg1.assert_nothing_captured()
3305         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3306         self.assertEqual(len(sessions) - session_n, 0)
3307
3308     def test_tcp_session_close_simultaneous(self):
3309         """ NAT44ED Close TCP session from inside network """
3310
3311         in_port = self.tcp_port_in
3312         ext_port = 10505
3313
3314         self.nat_add_address(self.nat_addr)
3315         self.nat_add_inside_interface(self.pg0)
3316         self.nat_add_outside_interface(self.pg1)
3317         self.nat_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
3318                                     in_port, ext_port, proto=IP_PROTOS.tcp,
3319                                     flags=self.config_flags.NAT_IS_TWICE_NAT)
3320
3321         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3322         session_n = len(sessions)
3323
3324         self.vapi.nat_set_timeouts(udp=300, tcp_established=7440,
3325                                    tcp_transitory=2, icmp=5)
3326
3327         out_port = self.init_tcp_session(self.pg0, self.pg1, in_port, ext_port)
3328
3329         # FIN packet in -> out
3330         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3331              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3332              TCP(sport=in_port, dport=ext_port,
3333                  flags="FA", seq=100, ack=300))
3334         self.pg0.add_stream(p)
3335         self.pg_enable_capture(self.pg_interfaces)
3336         self.pg_start()
3337         self.pg1.get_capture(1)
3338
3339         # FIN packet out -> in
3340         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3341              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3342              TCP(sport=ext_port, dport=out_port,
3343                  flags="FA", seq=300, ack=100))
3344         self.pg1.add_stream(p)
3345         self.pg_enable_capture(self.pg_interfaces)
3346         self.pg_start()
3347         self.pg0.get_capture(1)
3348
3349         # ACK packet in -> out
3350         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3351              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3352              TCP(sport=in_port, dport=ext_port,
3353                  flags="A", seq=101, ack=301))
3354         self.pg0.add_stream(p)
3355         self.pg_enable_capture(self.pg_interfaces)
3356         self.pg_start()
3357         self.pg1.get_capture(1)
3358
3359         # ACK packet out -> in
3360         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3361              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3362              TCP(sport=ext_port, dport=out_port,
3363                  flags="A", seq=301, ack=101))
3364         self.pg1.add_stream(p)
3365         self.pg_enable_capture(self.pg_interfaces)
3366         self.pg_start()
3367         self.pg0.get_capture(1)
3368
3369         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3370         self.assertEqual(len(sessions) - session_n, 1)
3371
3372         out2in_drops = self.get_err_counter(
3373             '/err/nat44-ed-out2in/drops due to TCP in transitory timeout')
3374         in2out_drops = self.get_err_counter(
3375             '/err/nat44-ed-in2out/drops due to TCP in transitory timeout')
3376
3377         # extra FIN packet out -> in - this should be dropped
3378         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
3379              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
3380              TCP(sport=ext_port, dport=out_port,
3381                  flags="FA", seq=300, ack=101))
3382
3383         self.pg1.add_stream(p)
3384         self.pg_enable_capture(self.pg_interfaces)
3385         self.pg_start()
3386         self.pg0.assert_nothing_captured()
3387
3388         # extra ACK packet in -> out - this should be dropped
3389         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3390              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3391              TCP(sport=in_port, dport=ext_port,
3392                  flags="A", seq=101, ack=301))
3393         self.pg0.add_stream(p)
3394         self.pg_enable_capture(self.pg_interfaces)
3395         self.pg_start()
3396         self.pg1.assert_nothing_captured()
3397
3398         stats = self.get_err_counter(
3399             '/err/nat44-ed-out2in/drops due to TCP in transitory timeout')
3400         self.assertEqual(stats - out2in_drops, 1)
3401         stats = self.get_err_counter(
3402             '/err/nat44-ed-in2out/drops due to TCP in transitory timeout')
3403         self.assertEqual(stats - in2out_drops, 1)
3404
3405         self.sleep(3)
3406         # extra ACK packet in -> out - this will cause session to be wiped
3407         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3408              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3409              TCP(sport=in_port, dport=ext_port,
3410                  flags="A", seq=101, ack=301))
3411         self.pg0.add_stream(p)
3412         self.pg_enable_capture(self.pg_interfaces)
3413         self.pg_start()
3414         self.pg1.assert_nothing_captured()
3415         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4, 0)
3416         self.assertEqual(len(sessions) - session_n, 0)
3417
3418     def test_dynamic_vrf(self):
3419         """ NAT44ED dynamic translation test: different VRF"""
3420
3421         vrf_id_in = 33
3422         vrf_id_out = 34
3423
3424         self.nat_add_address(self.nat_addr, vrf_id=vrf_id_in)
3425
3426         try:
3427             self.configure_ip4_interface(self.pg7, table_id=vrf_id_in)
3428             self.configure_ip4_interface(self.pg8, table_id=vrf_id_out)
3429
3430             self.nat_add_inside_interface(self.pg7)
3431             self.nat_add_outside_interface(self.pg8)
3432
3433             # just basic stuff nothing special
3434             pkts = self.create_stream_in(self.pg7, self.pg8)
3435             self.pg7.add_stream(pkts)
3436             self.pg_enable_capture(self.pg_interfaces)
3437             self.pg_start()
3438             capture = self.pg8.get_capture(len(pkts))
3439             self.verify_capture_out(capture, ignore_port=True)
3440
3441             pkts = self.create_stream_out(self.pg8)
3442             self.pg8.add_stream(pkts)
3443             self.pg_enable_capture(self.pg_interfaces)
3444             self.pg_start()
3445             capture = self.pg7.get_capture(len(pkts))
3446             self.verify_capture_in(capture, self.pg7)
3447
3448         finally:
3449             self.pg7.unconfig()
3450             self.pg8.unconfig()
3451
3452             self.vapi.ip_table_add_del(is_add=0,
3453                                        table={'table_id': vrf_id_in})
3454             self.vapi.ip_table_add_del(is_add=0,
3455                                        table={'table_id': vrf_id_out})
3456
3457     def test_dynamic_output_feature_vrf(self):
3458         """ NAT44ED dynamic translation test: output-feature, VRF"""
3459
3460         # other then default (0)
3461         new_vrf_id = 22
3462
3463         self.nat_add_address(self.nat_addr)
3464         flags = self.config_flags.NAT_IS_INSIDE
3465         self.vapi.nat44_interface_add_del_output_feature(
3466             sw_if_index=self.pg7.sw_if_index,
3467             flags=flags, is_add=1)
3468         self.vapi.nat44_interface_add_del_output_feature(
3469             sw_if_index=self.pg8.sw_if_index,
3470             is_add=1)
3471
3472         try:
3473             self.configure_ip4_interface(self.pg7, table_id=new_vrf_id)
3474             self.configure_ip4_interface(self.pg8, table_id=new_vrf_id)
3475
3476             # in2out
3477             tcpn = self.statistics['/nat44-ed/in2out/slowpath/tcp']
3478             udpn = self.statistics['/nat44-ed/in2out/slowpath/udp']
3479             icmpn = self.statistics['/nat44-ed/in2out/slowpath/icmp']
3480             drops = self.statistics['/nat44-ed/in2out/slowpath/drops']
3481
3482             pkts = self.create_stream_in(self.pg7, self.pg8)
3483             self.pg7.add_stream(pkts)
3484             self.pg_enable_capture(self.pg_interfaces)
3485             self.pg_start()
3486             capture = self.pg8.get_capture(len(pkts))
3487             self.verify_capture_out(capture, ignore_port=True)
3488
3489             if_idx = self.pg7.sw_if_index
3490             cnt = self.statistics['/nat44-ed/in2out/slowpath/tcp']
3491             self.assertEqual(cnt[:, if_idx].sum() - tcpn[:, if_idx].sum(), 2)
3492             cnt = self.statistics['/nat44-ed/in2out/slowpath/udp']
3493             self.assertEqual(cnt[:, if_idx].sum() - udpn[:, if_idx].sum(), 1)
3494             cnt = self.statistics['/nat44-ed/in2out/slowpath/icmp']
3495             self.assertEqual(cnt[:, if_idx].sum() - icmpn[:, if_idx].sum(), 1)
3496             cnt = self.statistics['/nat44-ed/in2out/slowpath/drops']
3497             self.assertEqual(cnt[:, if_idx].sum() - drops[:, if_idx].sum(), 0)
3498
3499             # out2in
3500             tcpn = self.statistics['/nat44-ed/out2in/fastpath/tcp']
3501             udpn = self.statistics['/nat44-ed/out2in/fastpath/udp']
3502             icmpn = self.statistics['/nat44-ed/out2in/fastpath/icmp']
3503             drops = self.statistics['/nat44-ed/out2in/fastpath/drops']
3504
3505             pkts = self.create_stream_out(self.pg8)
3506             self.pg8.add_stream(pkts)
3507             self.pg_enable_capture(self.pg_interfaces)
3508             self.pg_start()
3509             capture = self.pg7.get_capture(len(pkts))
3510             self.verify_capture_in(capture, self.pg7)
3511
3512             if_idx = self.pg8.sw_if_index
3513             cnt = self.statistics['/nat44-ed/out2in/fastpath/tcp']
3514             self.assertEqual(cnt[:, if_idx].sum() - tcpn[:, if_idx].sum(), 2)
3515             cnt = self.statistics['/nat44-ed/out2in/fastpath/udp']
3516             self.assertEqual(cnt[:, if_idx].sum() - udpn[:, if_idx].sum(), 1)
3517             cnt = self.statistics['/nat44-ed/out2in/fastpath/icmp']
3518             self.assertEqual(cnt[:, if_idx].sum() - icmpn[:, if_idx].sum(), 1)
3519             cnt = self.statistics['/nat44-ed/out2in/fastpath/drops']
3520             self.assertEqual(cnt[:, if_idx].sum() - drops[:, if_idx].sum(), 0)
3521
3522             sessions = self.statistics['/nat44-ed/total-sessions']
3523             self.assertEqual(sessions[:, 0].sum(), 3)
3524
3525         finally:
3526             self.pg7.unconfig()
3527             self.pg8.unconfig()
3528
3529             self.vapi.ip_table_add_del(is_add=0,
3530                                        table={'table_id': new_vrf_id})
3531
3532     def test_next_src_nat(self):
3533         """ NAT44ED On way back forward packet to nat44-in2out node. """
3534
3535         twice_nat_addr = '10.0.1.3'
3536         external_port = 80
3537         local_port = 8080
3538         post_twice_nat_port = 0
3539
3540         self.vapi.nat44_forwarding_enable_disable(enable=1)
3541         self.nat_add_address(twice_nat_addr, twice_nat=1)
3542         flags = (self.config_flags.NAT_IS_OUT2IN_ONLY |
3543                  self.config_flags.NAT_IS_SELF_TWICE_NAT)
3544         self.nat_add_static_mapping(self.pg6.remote_ip4, self.pg1.remote_ip4,
3545                                     local_port, external_port,
3546                                     proto=IP_PROTOS.tcp, vrf_id=1,
3547                                     flags=flags)
3548         self.vapi.nat44_interface_add_del_feature(
3549             sw_if_index=self.pg6.sw_if_index,
3550             is_add=1)
3551
3552         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
3553              IP(src=self.pg6.remote_ip4, dst=self.pg1.remote_ip4) /
3554              TCP(sport=12345, dport=external_port))
3555         self.pg6.add_stream(p)
3556         self.pg_enable_capture(self.pg_interfaces)
3557         self.pg_start()
3558         capture = self.pg6.get_capture(1)
3559         p = capture[0]
3560         try:
3561             ip = p[IP]
3562             tcp = p[TCP]
3563             self.assertEqual(ip.src, twice_nat_addr)
3564             self.assertNotEqual(tcp.sport, 12345)
3565             post_twice_nat_port = tcp.sport
3566             self.assertEqual(ip.dst, self.pg6.remote_ip4)
3567             self.assertEqual(tcp.dport, local_port)
3568             self.assert_packet_checksums_valid(p)
3569         except:
3570             self.logger.error(ppp("Unexpected or invalid packet:", p))
3571             raise
3572
3573         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
3574              IP(src=self.pg6.remote_ip4, dst=twice_nat_addr) /
3575              TCP(sport=local_port, dport=post_twice_nat_port))
3576         self.pg6.add_stream(p)
3577         self.pg_enable_capture(self.pg_interfaces)
3578         self.pg_start()
3579         capture = self.pg6.get_capture(1)
3580         p = capture[0]
3581         try:
3582             ip = p[IP]
3583             tcp = p[TCP]
3584             self.assertEqual(ip.src, self.pg1.remote_ip4)
3585             self.assertEqual(tcp.sport, external_port)
3586             self.assertEqual(ip.dst, self.pg6.remote_ip4)
3587             self.assertEqual(tcp.dport, 12345)
3588             self.assert_packet_checksums_valid(p)
3589         except:
3590             self.logger.error(ppp("Unexpected or invalid packet:", p))
3591             raise
3592
3593     def test_one_armed_nat44_static(self):
3594         """ NAT44ED One armed NAT and 1:1 NAPT asymmetrical rule """
3595
3596         remote_host = self.pg4.remote_hosts[0]
3597         local_host = self.pg4.remote_hosts[1]
3598         external_port = 80
3599         local_port = 8080
3600         eh_port_in = 0
3601
3602         self.vapi.nat44_forwarding_enable_disable(enable=1)
3603         self.nat_add_address(self.nat_addr, twice_nat=1)
3604         flags = (self.config_flags.NAT_IS_OUT2IN_ONLY |
3605                  self.config_flags.NAT_IS_TWICE_NAT)
3606         self.nat_add_static_mapping(local_host.ip4, self.nat_addr,
3607                                     local_port, external_port,
3608                                     proto=IP_PROTOS.tcp, flags=flags)
3609         flags = self.config_flags.NAT_IS_INSIDE
3610         self.vapi.nat44_interface_add_del_feature(
3611             sw_if_index=self.pg4.sw_if_index,
3612             is_add=1)
3613         self.vapi.nat44_interface_add_del_feature(
3614             sw_if_index=self.pg4.sw_if_index,
3615             flags=flags, is_add=1)
3616
3617         # from client to service
3618         p = (Ether(src=self.pg4.remote_mac, dst=self.pg4.local_mac) /
3619              IP(src=remote_host.ip4, dst=self.nat_addr) /
3620              TCP(sport=12345, dport=external_port))
3621         self.pg4.add_stream(p)
3622         self.pg_enable_capture(self.pg_interfaces)
3623         self.pg_start()
3624         capture = self.pg4.get_capture(1)
3625         p = capture[0]
3626         try:
3627             ip = p[IP]
3628             tcp = p[TCP]
3629             self.assertEqual(ip.dst, local_host.ip4)
3630             self.assertEqual(ip.src, self.nat_addr)
3631             self.assertEqual(tcp.dport, local_port)
3632             self.assertNotEqual(tcp.sport, 12345)
3633             eh_port_in = tcp.sport
3634             self.assert_packet_checksums_valid(p)
3635         except:
3636             self.logger.error(ppp("Unexpected or invalid packet:", p))
3637             raise
3638
3639         # from service back to client
3640         p = (Ether(src=self.pg4.remote_mac, dst=self.pg4.local_mac) /
3641              IP(src=local_host.ip4, dst=self.nat_addr) /
3642              TCP(sport=local_port, dport=eh_port_in))
3643         self.pg4.add_stream(p)
3644         self.pg_enable_capture(self.pg_interfaces)
3645         self.pg_start()
3646         capture = self.pg4.get_capture(1)
3647         p = capture[0]
3648         try:
3649             ip = p[IP]
3650             tcp = p[TCP]
3651             self.assertEqual(ip.src, self.nat_addr)
3652             self.assertEqual(ip.dst, remote_host.ip4)
3653             self.assertEqual(tcp.sport, external_port)
3654             self.assertEqual(tcp.dport, 12345)
3655             self.assert_packet_checksums_valid(p)
3656         except:
3657             self.logger.error(ppp("Unexpected or invalid packet:", p))
3658             raise
3659
3660
3661 if __name__ == '__main__':
3662     unittest.main(testRunner=VppTestRunner)