test/test_nat.py

   1 #!/usr/bin/env python
   2
   3 import socket
   4 import unittest
   5 import struct
   6 import StringIO
   7 import random
   8
   9 from framework import VppTestCase, VppTestRunner, running_extended_tests
  10 from scapy.layers.inet import IP, TCP, UDP, ICMP
  11 from scapy.layers.inet import IPerror, TCPerror, UDPerror, ICMPerror
  12 from scapy.layers.inet6 import IPv6, ICMPv6EchoRequest, ICMPv6EchoReply, \
  13     ICMPv6ND_NS, ICMPv6ND_NA, ICMPv6NDOptDstLLAddr
  14 from scapy.layers.inet6 import ICMPv6DestUnreach, IPerror6, IPv6ExtHdrFragment
  15 from scapy.layers.l2 import Ether, ARP, GRE
  16 from scapy.data import IP_PROTOS
  17 from scapy.packet import bind_layers, Raw
  18 from scapy.all import fragment6
  19 from util import ppp
  20 from ipfix import IPFIX, Set, Template, Data, IPFIXDecoder
  21 from time import sleep
  22 from util import ip4_range
  23 from util import mactobinary
  24
  25
  26 class MethodHolder(VppTestCase):
  27     """ NAT create capture and verify method holder """
  28
  29     def clear_nat44(self):
  30         """
  31         Clear NAT44 configuration.
  32         """
  33         if hasattr(self, 'pg7') and hasattr(self, 'pg8'):
  34             # I found no elegant way to do this
  35             self.vapi.ip_add_del_route(
  36                 dst_address=self.pg7.remote_ip4n,
  37                 dst_address_length=32,
  38                 next_hop_address=self.pg7.remote_ip4n,
  39                 next_hop_sw_if_index=self.pg7.sw_if_index,
  40                 is_add=0)
  41             self.vapi.ip_add_del_route(
  42                 dst_address=self.pg8.remote_ip4n,
  43                 dst_address_length=32,
  44                 next_hop_address=self.pg8.remote_ip4n,
  45                 next_hop_sw_if_index=self.pg8.sw_if_index,
  46                 is_add=0)
  47
  48             for intf in [self.pg7, self.pg8]:
  49                 neighbors = self.vapi.ip_neighbor_dump(intf.sw_if_index)
  50                 for n in neighbors:
  51                     self.vapi.ip_neighbor_add_del(intf.sw_if_index,
  52                                                   n.mac_address,
  53                                                   n.ip_address,
  54                                                   is_add=0)
  55
  56             if self.pg7.has_ip4_config:
  57                 self.pg7.unconfig_ip4()
  58
  59         self.vapi.nat44_forwarding_enable_disable(0)
  60
  61         interfaces = self.vapi.nat44_interface_addr_dump()
  62         for intf in interfaces:
  63             self.vapi.nat44_add_interface_addr(intf.sw_if_index,
  64                                                twice_nat=intf.twice_nat,
  65                                                is_add=0)
  66
  67         self.vapi.nat_ipfix(enable=0, src_port=self.ipfix_src_port,
  68                             domain_id=self.ipfix_domain_id)
  69         self.ipfix_src_port = 4739
  70         self.ipfix_domain_id = 1
  71
  72         interfaces = self.vapi.nat44_interface_dump()
  73         for intf in interfaces:
  74             if intf.is_inside > 1:
  75                 self.vapi.nat44_interface_add_del_feature(intf.sw_if_index,
  76                                                           0,
  77                                                           is_add=0)
  78             self.vapi.nat44_interface_add_del_feature(intf.sw_if_index,
  79                                                       intf.is_inside,
  80                                                       is_add=0)
  81
  82         interfaces = self.vapi.nat44_interface_output_feature_dump()
  83         for intf in interfaces:
  84             self.vapi.nat44_interface_add_del_output_feature(intf.sw_if_index,
  85                                                              intf.is_inside,
  86                                                              is_add=0)
  87
  88         static_mappings = self.vapi.nat44_static_mapping_dump()
  89         for sm in static_mappings:
  90             self.vapi.nat44_add_del_static_mapping(
  91                 sm.local_ip_address,
  92                 sm.external_ip_address,
  93                 local_port=sm.local_port,
  94                 external_port=sm.external_port,
  95                 addr_only=sm.addr_only,
  96                 vrf_id=sm.vrf_id,
  97                 protocol=sm.protocol,
  98                 twice_nat=sm.twice_nat,
  99                 self_twice_nat=sm.self_twice_nat,
 100                 out2in_only=sm.out2in_only,
 101                 tag=sm.tag,
 102                 external_sw_if_index=sm.external_sw_if_index,
 103                 is_add=0)
 104
 105         lb_static_mappings = self.vapi.nat44_lb_static_mapping_dump()
 106         for lb_sm in lb_static_mappings:
 107             self.vapi.nat44_add_del_lb_static_mapping(
 108                 lb_sm.external_addr,
 109                 lb_sm.external_port,
 110                 lb_sm.protocol,
 111                 twice_nat=lb_sm.twice_nat,
 112                 self_twice_nat=lb_sm.self_twice_nat,
 113                 out2in_only=lb_sm.out2in_only,
 114                 tag=lb_sm.tag,
 115                 is_add=0,
 116                 local_num=0,
 117                 locals=[])
 118
 119         identity_mappings = self.vapi.nat44_identity_mapping_dump()
 120         for id_m in identity_mappings:
 121             self.vapi.nat44_add_del_identity_mapping(
 122                 addr_only=id_m.addr_only,
 123                 ip=id_m.ip_address,
 124                 port=id_m.port,
 125                 sw_if_index=id_m.sw_if_index,
 126                 vrf_id=id_m.vrf_id,
 127                 protocol=id_m.protocol,
 128                 is_add=0)
 129
 130         adresses = self.vapi.nat44_address_dump()
 131         for addr in adresses:
 132             self.vapi.nat44_add_del_address_range(addr.ip_address,
 133                                                   addr.ip_address,
 134                                                   twice_nat=addr.twice_nat,
 135                                                   is_add=0)
 136
 137         self.vapi.nat_set_reass()
 138         self.vapi.nat_set_reass(is_ip6=1)
 139         self.verify_no_nat44_user()
 140         self.vapi.nat_set_timeouts()
 141         self.vapi.nat_set_addr_and_port_alloc_alg()
 142         self.vapi.nat_set_mss_clamping()
 143
 144     def nat44_add_static_mapping(self, local_ip, external_ip='0.0.0.0',
 145                                  local_port=0, external_port=0, vrf_id=0,
 146                                  is_add=1, external_sw_if_index=0xFFFFFFFF,
 147                                  proto=0, twice_nat=0, self_twice_nat=0,
 148                                  out2in_only=0, tag=""):
 149         """
 150         Add/delete NAT44 static mapping
 151
 152         :param local_ip: Local IP address
 153         :param external_ip: External IP address
 154         :param local_port: Local port number (Optional)
 155         :param external_port: External port number (Optional)
 156         :param vrf_id: VRF ID (Default 0)
 157         :param is_add: 1 if add, 0 if delete (Default add)
 158         :param external_sw_if_index: External interface instead of IP address
 159         :param proto: IP protocol (Mandatory if port specified)
 160         :param twice_nat: 1 if translate external host address and port
 161         :param self_twice_nat: 1 if translate external host address and port
 162                                whenever external host address equals
 163                                local address of internal host
 164         :param out2in_only: if 1 rule is matching only out2in direction
 165         :param tag: Opaque string tag
 166         """
 167         addr_only = 1
 168         if local_port and external_port:
 169             addr_only = 0
 170         l_ip = socket.inet_pton(socket.AF_INET, local_ip)
 171         e_ip = socket.inet_pton(socket.AF_INET, external_ip)
 172         self.vapi.nat44_add_del_static_mapping(
 173             l_ip,
 174             e_ip,
 175             external_sw_if_index,
 176             local_port,
 177             external_port,
 178             addr_only,
 179             vrf_id,
 180             proto,
 181             twice_nat,
 182             self_twice_nat,
 183             out2in_only,
 184             tag,
 185             is_add)
 186
 187     def nat44_add_address(self, ip, is_add=1, vrf_id=0xFFFFFFFF, twice_nat=0):
 188         """
 189         Add/delete NAT44 address
 190
 191         :param ip: IP address
 192         :param is_add: 1 if add, 0 if delete (Default add)
 193         :param twice_nat: twice NAT address for extenal hosts
 194         """
 195         nat_addr = socket.inet_pton(socket.AF_INET, ip)
 196         self.vapi.nat44_add_del_address_range(nat_addr, nat_addr, is_add,
 197                                               vrf_id=vrf_id,
 198                                               twice_nat=twice_nat)
 199
 200     def create_stream_in(self, in_if, out_if, dst_ip=None, ttl=64):
 201         """
 202         Create packet stream for inside network
 203
 204         :param in_if: Inside interface
 205         :param out_if: Outside interface
 206         :param dst_ip: Destination address
 207         :param ttl: TTL of generated packets
 208         """
 209         if dst_ip is None:
 210             dst_ip = out_if.remote_ip4
 211
 212         pkts = []
 213         # TCP
 214         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 215              IP(src=in_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 216              TCP(sport=self.tcp_port_in, dport=20))
 217         pkts.append(p)
 218
 219         # UDP
 220         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 221              IP(src=in_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 222              UDP(sport=self.udp_port_in, dport=20))
 223         pkts.append(p)
 224
 225         # ICMP
 226         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 227              IP(src=in_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 228              ICMP(id=self.icmp_id_in, type='echo-request'))
 229         pkts.append(p)
 230
 231         return pkts
 232
 233     def compose_ip6(self, ip4, pref, plen):
 234         """
 235         Compose IPv4-embedded IPv6 addresses
 236
 237         :param ip4: IPv4 address
 238         :param pref: IPv6 prefix
 239         :param plen: IPv6 prefix length
 240         :returns: IPv4-embedded IPv6 addresses
 241         """
 242         pref_n = list(socket.inet_pton(socket.AF_INET6, pref))
 243         ip4_n = list(socket.inet_pton(socket.AF_INET, ip4))
 244         if plen == 32:
 245             pref_n[4] = ip4_n[0]
 246             pref_n[5] = ip4_n[1]
 247             pref_n[6] = ip4_n[2]
 248             pref_n[7] = ip4_n[3]
 249         elif plen == 40:
 250             pref_n[5] = ip4_n[0]
 251             pref_n[6] = ip4_n[1]
 252             pref_n[7] = ip4_n[2]
 253             pref_n[9] = ip4_n[3]
 254         elif plen == 48:
 255             pref_n[6] = ip4_n[0]
 256             pref_n[7] = ip4_n[1]
 257             pref_n[9] = ip4_n[2]
 258             pref_n[10] = ip4_n[3]
 259         elif plen == 56:
 260             pref_n[7] = ip4_n[0]
 261             pref_n[9] = ip4_n[1]
 262             pref_n[10] = ip4_n[2]
 263             pref_n[11] = ip4_n[3]
 264         elif plen == 64:
 265             pref_n[9] = ip4_n[0]
 266             pref_n[10] = ip4_n[1]
 267             pref_n[11] = ip4_n[2]
 268             pref_n[12] = ip4_n[3]
 269         elif plen == 96:
 270             pref_n[12] = ip4_n[0]
 271             pref_n[13] = ip4_n[1]
 272             pref_n[14] = ip4_n[2]
 273             pref_n[15] = ip4_n[3]
 274         return socket.inet_ntop(socket.AF_INET6, ''.join(pref_n))
 275
 276     def extract_ip4(self, ip6, plen):
 277         """
 278         Extract IPv4 address embedded in IPv6 addresses
 279
 280         :param ip6: IPv6 address
 281         :param plen: IPv6 prefix length
 282         :returns: extracted IPv4 address
 283         """
 284         ip6_n = list(socket.inet_pton(socket.AF_INET6, ip6))
 285         ip4_n = [None] * 4
 286         if plen == 32:
 287             ip4_n[0] = ip6_n[4]
 288             ip4_n[1] = ip6_n[5]
 289             ip4_n[2] = ip6_n[6]
 290             ip4_n[3] = ip6_n[7]
 291         elif plen == 40:
 292             ip4_n[0] = ip6_n[5]
 293             ip4_n[1] = ip6_n[6]
 294             ip4_n[2] = ip6_n[7]
 295             ip4_n[3] = ip6_n[9]
 296         elif plen == 48:
 297             ip4_n[0] = ip6_n[6]
 298             ip4_n[1] = ip6_n[7]
 299             ip4_n[2] = ip6_n[9]
 300             ip4_n[3] = ip6_n[10]
 301         elif plen == 56:
 302             ip4_n[0] = ip6_n[7]
 303             ip4_n[1] = ip6_n[9]
 304             ip4_n[2] = ip6_n[10]
 305             ip4_n[3] = ip6_n[11]
 306         elif plen == 64:
 307             ip4_n[0] = ip6_n[9]
 308             ip4_n[1] = ip6_n[10]
 309             ip4_n[2] = ip6_n[11]
 310             ip4_n[3] = ip6_n[12]
 311         elif plen == 96:
 312             ip4_n[0] = ip6_n[12]
 313             ip4_n[1] = ip6_n[13]
 314             ip4_n[2] = ip6_n[14]
 315             ip4_n[3] = ip6_n[15]
 316         return socket.inet_ntop(socket.AF_INET, ''.join(ip4_n))
 317
 318     def create_stream_in_ip6(self, in_if, out_if, hlim=64, pref=None, plen=0):
 319         """
 320         Create IPv6 packet stream for inside network
 321
 322         :param in_if: Inside interface
 323         :param out_if: Outside interface
 324         :param ttl: Hop Limit of generated packets
 325         :param pref: NAT64 prefix
 326         :param plen: NAT64 prefix length
 327         """
 328         pkts = []
 329         if pref is None:
 330             dst = ''.join(['64:ff9b::', out_if.remote_ip4])
 331         else:
 332             dst = self.compose_ip6(out_if.remote_ip4, pref, plen)
 333
 334         # TCP
 335         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 336              IPv6(src=in_if.remote_ip6, dst=dst, hlim=hlim) /
 337              TCP(sport=self.tcp_port_in, dport=20))
 338         pkts.append(p)
 339
 340         # UDP
 341         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 342              IPv6(src=in_if.remote_ip6, dst=dst, hlim=hlim) /
 343              UDP(sport=self.udp_port_in, dport=20))
 344         pkts.append(p)
 345
 346         # ICMP
 347         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
 348              IPv6(src=in_if.remote_ip6, dst=dst, hlim=hlim) /
 349              ICMPv6EchoRequest(id=self.icmp_id_in))
 350         pkts.append(p)
 351
 352         return pkts
 353
 354     def create_stream_out(self, out_if, dst_ip=None, ttl=64,
 355                           use_inside_ports=False):
 356         """
 357         Create packet stream for outside network
 358
 359         :param out_if: Outside interface
 360         :param dst_ip: Destination IP address (Default use global NAT address)
 361         :param ttl: TTL of generated packets
 362         :param use_inside_ports: Use inside NAT ports as destination ports
 363                instead of outside ports
 364         """
 365         if dst_ip is None:
 366             dst_ip = self.nat_addr
 367         if not use_inside_ports:
 368             tcp_port = self.tcp_port_out
 369             udp_port = self.udp_port_out
 370             icmp_id = self.icmp_id_out
 371         else:
 372             tcp_port = self.tcp_port_in
 373             udp_port = self.udp_port_in
 374             icmp_id = self.icmp_id_in
 375         pkts = []
 376         # TCP
 377         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 378              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 379              TCP(dport=tcp_port, sport=20))
 380         pkts.append(p)
 381
 382         # UDP
 383         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 384              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 385              UDP(dport=udp_port, sport=20))
 386         pkts.append(p)
 387
 388         # ICMP
 389         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 390              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
 391              ICMP(id=icmp_id, type='echo-reply'))
 392         pkts.append(p)
 393
 394         return pkts
 395
 396     def create_stream_out_ip6(self, out_if, src_ip, dst_ip, hl=64):
 397         """
 398         Create packet stream for outside network
 399
 400         :param out_if: Outside interface
 401         :param dst_ip: Destination IP address (Default use global NAT address)
 402         :param hl: HL of generated packets
 403         """
 404         pkts = []
 405         # TCP
 406         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 407              IPv6(src=src_ip, dst=dst_ip, hlim=hl) /
 408              TCP(dport=self.tcp_port_out, sport=20))
 409         pkts.append(p)
 410
 411         # UDP
 412         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 413              IPv6(src=src_ip, dst=dst_ip, hlim=hl) /
 414              UDP(dport=self.udp_port_out, sport=20))
 415         pkts.append(p)
 416
 417         # ICMP
 418         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
 419              IPv6(src=src_ip, dst=dst_ip, hlim=hl) /
 420              ICMPv6EchoReply(id=self.icmp_id_out))
 421         pkts.append(p)
 422
 423         return pkts
 424
 425     def verify_capture_out(self, capture, nat_ip=None, same_port=False,
 426                            dst_ip=None, is_ip6=False):
 427         """
 428         Verify captured packets on outside network
 429
 430         :param capture: Captured packets
 431         :param nat_ip: Translated IP address (Default use global NAT address)
 432         :param same_port: Sorce port number is not translated (Default False)
 433         :param dst_ip: Destination IP address (Default do not verify)
 434         :param is_ip6: If L3 protocol is IPv6 (Default False)
 435         """
 436         if is_ip6:
 437             IP46 = IPv6
 438             ICMP46 = ICMPv6EchoRequest
 439         else:
 440             IP46 = IP
 441             ICMP46 = ICMP
 442         if nat_ip is None:
 443             nat_ip = self.nat_addr
 444         for packet in capture:
 445             try:
 446                 if not is_ip6:
 447                     self.assert_packet_checksums_valid(packet)
 448                 self.assertEqual(packet[IP46].src, nat_ip)
 449                 if dst_ip is not None:
 450                     self.assertEqual(packet[IP46].dst, dst_ip)
 451                 if packet.haslayer(TCP):
 452                     if same_port:
 453                         self.assertEqual(packet[TCP].sport, self.tcp_port_in)
 454                     else:
 455                         self.assertNotEqual(
 456                             packet[TCP].sport, self.tcp_port_in)
 457                     self.tcp_port_out = packet[TCP].sport
 458                     self.assert_packet_checksums_valid(packet)
 459                 elif packet.haslayer(UDP):
 460                     if same_port:
 461                         self.assertEqual(packet[UDP].sport, self.udp_port_in)
 462                     else:
 463                         self.assertNotEqual(
 464                             packet[UDP].sport, self.udp_port_in)
 465                     self.udp_port_out = packet[UDP].sport
 466                 else:
 467                     if same_port:
 468                         self.assertEqual(packet[ICMP46].id, self.icmp_id_in)
 469                     else:
 470                         self.assertNotEqual(packet[ICMP46].id, self.icmp_id_in)
 471                     self.icmp_id_out = packet[ICMP46].id
 472                     self.assert_packet_checksums_valid(packet)
 473             except:
 474                 self.logger.error(ppp("Unexpected or invalid packet "
 475                                       "(outside network):", packet))
 476                 raise
 477
 478     def verify_capture_out_ip6(self, capture, nat_ip, same_port=False,
 479                                dst_ip=None):
 480         """
 481         Verify captured packets on outside network
 482
 483         :param capture: Captured packets
 484         :param nat_ip: Translated IP address
 485         :param same_port: Sorce port number is not translated (Default False)
 486         :param dst_ip: Destination IP address (Default do not verify)
 487         """
 488         return self.verify_capture_out(capture, nat_ip, same_port, dst_ip,
 489                                        True)
 490
 491     def verify_capture_in(self, capture, in_if):
 492         """
 493         Verify captured packets on inside network
 494
 495         :param capture: Captured packets
 496         :param in_if: Inside interface
 497         """
 498         for packet in capture:
 499             try:
 500                 self.assert_packet_checksums_valid(packet)
 501                 self.assertEqual(packet[IP].dst, in_if.remote_ip4)
 502                 if packet.haslayer(TCP):
 503                     self.assertEqual(packet[TCP].dport, self.tcp_port_in)
 504                 elif packet.haslayer(UDP):
 505                     self.assertEqual(packet[UDP].dport, self.udp_port_in)
 506                 else:
 507                     self.assertEqual(packet[ICMP].id, self.icmp_id_in)
 508             except:
 509                 self.logger.error(ppp("Unexpected or invalid packet "
 510                                       "(inside network):", packet))
 511                 raise
 512
 513     def verify_capture_in_ip6(self, capture, src_ip, dst_ip):
 514         """
 515         Verify captured IPv6 packets on inside network
 516
 517         :param capture: Captured packets
 518         :param src_ip: Source IP
 519         :param dst_ip: Destination IP address
 520         """
 521         for packet in capture:
 522             try:
 523                 self.assertEqual(packet[IPv6].src, src_ip)
 524                 self.assertEqual(packet[IPv6].dst, dst_ip)
 525                 self.assert_packet_checksums_valid(packet)
 526                 if packet.haslayer(TCP):
 527                     self.assertEqual(packet[TCP].dport, self.tcp_port_in)
 528                 elif packet.haslayer(UDP):
 529                     self.assertEqual(packet[UDP].dport, self.udp_port_in)
 530                 else:
 531                     self.assertEqual(packet[ICMPv6EchoReply].id,
 532                                      self.icmp_id_in)
 533             except:
 534                 self.logger.error(ppp("Unexpected or invalid packet "
 535                                       "(inside network):", packet))
 536                 raise
 537
 538     def verify_capture_no_translation(self, capture, ingress_if, egress_if):
 539         """
 540         Verify captured packet that don't have to be translated
 541
 542         :param capture: Captured packets
 543         :param ingress_if: Ingress interface
 544         :param egress_if: Egress interface
 545         """
 546         for packet in capture:
 547             try:
 548                 self.assertEqual(packet[IP].src, ingress_if.remote_ip4)
 549                 self.assertEqual(packet[IP].dst, egress_if.remote_ip4)
 550                 if packet.haslayer(TCP):
 551                     self.assertEqual(packet[TCP].sport, self.tcp_port_in)
 552                 elif packet.haslayer(UDP):
 553                     self.assertEqual(packet[UDP].sport, self.udp_port_in)
 554                 else:
 555                     self.assertEqual(packet[ICMP].id, self.icmp_id_in)
 556             except:
 557                 self.logger.error(ppp("Unexpected or invalid packet "
 558                                       "(inside network):", packet))
 559                 raise
 560
 561     def verify_capture_out_with_icmp_errors(self, capture, src_ip=None,
 562                                             icmp_type=11):
 563         """
 564         Verify captured packets with ICMP errors on outside network
 565
 566         :param capture: Captured packets
 567         :param src_ip: Translated IP address or IP address of VPP
 568                        (Default use global NAT address)
 569         :param icmp_type: Type of error ICMP packet
 570                           we are expecting (Default 11)
 571         """
 572         if src_ip is None:
 573             src_ip = self.nat_addr
 574         for packet in capture:
 575             try:
 576                 self.assertEqual(packet[IP].src, src_ip)
 577                 self.assertTrue(packet.haslayer(ICMP))
 578                 icmp = packet[ICMP]
 579                 self.assertEqual(icmp.type, icmp_type)
 580                 self.assertTrue(icmp.haslayer(IPerror))
 581                 inner_ip = icmp[IPerror]
 582                 if inner_ip.haslayer(TCPerror):
 583                     self.assertEqual(inner_ip[TCPerror].dport,
 584                                      self.tcp_port_out)
 585                 elif inner_ip.haslayer(UDPerror):
 586                     self.assertEqual(inner_ip[UDPerror].dport,
 587                                      self.udp_port_out)
 588                 else:
 589                     self.assertEqual(inner_ip[ICMPerror].id, self.icmp_id_out)
 590             except:
 591                 self.logger.error(ppp("Unexpected or invalid packet "
 592                                       "(outside network):", packet))
 593                 raise
 594
 595     def verify_capture_in_with_icmp_errors(self, capture, in_if, icmp_type=11):
 596         """
 597         Verify captured packets with ICMP errors on inside network
 598
 599         :param capture: Captured packets
 600         :param in_if: Inside interface
 601         :param icmp_type: Type of error ICMP packet
 602                           we are expecting (Default 11)
 603         """
 604         for packet in capture:
 605             try:
 606                 self.assertEqual(packet[IP].dst, in_if.remote_ip4)
 607                 self.assertTrue(packet.haslayer(ICMP))
 608                 icmp = packet[ICMP]
 609                 self.assertEqual(icmp.type, icmp_type)
 610                 self.assertTrue(icmp.haslayer(IPerror))
 611                 inner_ip = icmp[IPerror]
 612                 if inner_ip.haslayer(TCPerror):
 613                     self.assertEqual(inner_ip[TCPerror].sport,
 614                                      self.tcp_port_in)
 615                 elif inner_ip.haslayer(UDPerror):
 616                     self.assertEqual(inner_ip[UDPerror].sport,
 617                                      self.udp_port_in)
 618                 else:
 619                     self.assertEqual(inner_ip[ICMPerror].id, self.icmp_id_in)
 620             except:
 621                 self.logger.error(ppp("Unexpected or invalid packet "
 622                                       "(inside network):", packet))
 623                 raise
 624
 625     def create_stream_frag(self, src_if, dst, sport, dport, data,
 626                            proto=IP_PROTOS.tcp, echo_reply=False):
 627         """
 628         Create fragmented packet stream
 629
 630         :param src_if: Source interface
 631         :param dst: Destination IPv4 address
 632         :param sport: Source port
 633         :param dport: Destination port
 634         :param data: Payload data
 635         :param proto: protocol (TCP, UDP, ICMP)
 636         :param echo_reply: use echo_reply if protocol is ICMP
 637         :returns: Fragmets
 638         """
 639         if proto == IP_PROTOS.tcp:
 640             p = (IP(src=src_if.remote_ip4, dst=dst) /
 641                  TCP(sport=sport, dport=dport) /
 642                  Raw(data))
 643             p = p.__class__(str(p))
 644             chksum = p['TCP'].chksum
 645             proto_header = TCP(sport=sport, dport=dport, chksum=chksum)
 646         elif proto == IP_PROTOS.udp:
 647             proto_header = UDP(sport=sport, dport=dport)
 648         elif proto == IP_PROTOS.icmp:
 649             if not echo_reply:
 650                 proto_header = ICMP(id=sport, type='echo-request')
 651             else:
 652                 proto_header = ICMP(id=sport, type='echo-reply')
 653         else:
 654             raise Exception("Unsupported protocol")
 655         id = random.randint(0, 65535)
 656         pkts = []
 657         if proto == IP_PROTOS.tcp:
 658             raw = Raw(data[0:4])
 659         else:
 660             raw = Raw(data[0:16])
 661         p = (Ether(src=src_if.remote_mac, dst=src_if.local_mac) /
 662              IP(src=src_if.remote_ip4, dst=dst, flags="MF", frag=0, id=id) /
 663              proto_header /
 664              raw)
 665         pkts.append(p)
 666         if proto == IP_PROTOS.tcp:
 667             raw = Raw(data[4:20])
 668         else:
 669             raw = Raw(data[16:32])
 670         p = (Ether(src=src_if.remote_mac, dst=src_if.local_mac) /
 671              IP(src=src_if.remote_ip4, dst=dst, flags="MF", frag=3, id=id,
 672                 proto=proto) /
 673              raw)
 674         pkts.append(p)
 675         if proto == IP_PROTOS.tcp:
 676             raw = Raw(data[20:])
 677         else:
 678             raw = Raw(data[32:])
 679         p = (Ether(src=src_if.remote_mac, dst=src_if.local_mac) /
 680              IP(src=src_if.remote_ip4, dst=dst, frag=5, proto=proto,
 681                 id=id) /
 682              raw)
 683         pkts.append(p)
 684         return pkts
 685
 686     def create_stream_frag_ip6(self, src_if, dst, sport, dport, data,
 687                                pref=None, plen=0, frag_size=128):
 688         """
 689         Create fragmented packet stream
 690
 691         :param src_if: Source interface
 692         :param dst: Destination IPv4 address
 693         :param sport: Source TCP port
 694         :param dport: Destination TCP port
 695         :param data: Payload data
 696         :param pref: NAT64 prefix
 697         :param plen: NAT64 prefix length
 698         :param fragsize: size of fragments
 699         :returns: Fragmets
 700         """
 701         if pref is None:
 702             dst_ip6 = ''.join(['64:ff9b::', dst])
 703         else:
 704             dst_ip6 = self.compose_ip6(dst, pref, plen)
 705
 706         p = (Ether(dst=src_if.local_mac, src=src_if.remote_mac) /
 707              IPv6(src=src_if.remote_ip6, dst=dst_ip6) /
 708              IPv6ExtHdrFragment(id=random.randint(0, 65535)) /
 709              TCP(sport=sport, dport=dport) /
 710              Raw(data))
 711
 712         return fragment6(p, frag_size)
 713
 714     def reass_frags_and_verify(self, frags, src, dst):
 715         """
 716         Reassemble and verify fragmented packet
 717
 718         :param frags: Captured fragments
 719         :param src: Source IPv4 address to verify
 720         :param dst: Destination IPv4 address to verify
 721
 722         :returns: Reassembled IPv4 packet
 723         """
 724         buffer = StringIO.StringIO()
 725         for p in frags:
 726             self.assertEqual(p[IP].src, src)
 727             self.assertEqual(p[IP].dst, dst)
 728             self.assert_ip_checksum_valid(p)
 729             buffer.seek(p[IP].frag * 8)
 730             buffer.write(p[IP].payload)
 731         ip = IP(src=frags[0][IP].src, dst=frags[0][IP].dst,
 732                 proto=frags[0][IP].proto)
 733         if ip.proto == IP_PROTOS.tcp:
 734             p = (ip / TCP(buffer.getvalue()))
 735             self.assert_tcp_checksum_valid(p)
 736         elif ip.proto == IP_PROTOS.udp:
 737             p = (ip / UDP(buffer.getvalue()[:8]) /
 738                  Raw(buffer.getvalue()[8:]))
 739         elif ip.proto == IP_PROTOS.icmp:
 740             p = (ip / ICMP(buffer.getvalue()))
 741         return p
 742
 743     def reass_frags_and_verify_ip6(self, frags, src, dst):
 744         """
 745         Reassemble and verify fragmented packet
 746
 747         :param frags: Captured fragments
 748         :param src: Source IPv6 address to verify
 749         :param dst: Destination IPv6 address to verify
 750
 751         :returns: Reassembled IPv6 packet
 752         """
 753         buffer = StringIO.StringIO()
 754         for p in frags:
 755             self.assertEqual(p[IPv6].src, src)
 756             self.assertEqual(p[IPv6].dst, dst)
 757             buffer.seek(p[IPv6ExtHdrFragment].offset * 8)
 758             buffer.write(p[IPv6ExtHdrFragment].payload)
 759         ip = IPv6(src=frags[0][IPv6].src, dst=frags[0][IPv6].dst,
 760                   nh=frags[0][IPv6ExtHdrFragment].nh)
 761         if ip.nh == IP_PROTOS.tcp:
 762             p = (ip / TCP(buffer.getvalue()))
 763         elif ip.nh == IP_PROTOS.udp:
 764             p = (ip / UDP(buffer.getvalue()))
 765         self.assert_packet_checksums_valid(p)
 766         return p
 767
 768     def initiate_tcp_session(self, in_if, out_if):
 769         """
 770         Initiates TCP session
 771
 772         :param in_if: Inside interface
 773         :param out_if: Outside interface
 774         """
 775         try:
 776             # SYN packet in->out
 777             p = (Ether(src=in_if.remote_mac, dst=in_if.local_mac) /
 778                  IP(src=in_if.remote_ip4, dst=out_if.remote_ip4) /
 779                  TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
 780                      flags="S"))
 781             in_if.add_stream(p)
 782             self.pg_enable_capture(self.pg_interfaces)
 783             self.pg_start()
 784             capture = out_if.get_capture(1)
 785             p = capture[0]
 786             self.tcp_port_out = p[TCP].sport
 787
 788             # SYN + ACK packet out->in
 789             p = (Ether(src=out_if.remote_mac, dst=out_if.local_mac) /
 790                  IP(src=out_if.remote_ip4, dst=self.nat_addr) /
 791                  TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
 792                      flags="SA"))
 793             out_if.add_stream(p)
 794             self.pg_enable_capture(self.pg_interfaces)
 795             self.pg_start()
 796             in_if.get_capture(1)
 797
 798             # ACK packet in->out
 799             p = (Ether(src=in_if.remote_mac, dst=in_if.local_mac) /
 800                  IP(src=in_if.remote_ip4, dst=out_if.remote_ip4) /
 801                  TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
 802                      flags="A"))
 803             in_if.add_stream(p)
 804             self.pg_enable_capture(self.pg_interfaces)
 805             self.pg_start()
 806             out_if.get_capture(1)
 807
 808         except:
 809             self.logger.error("TCP 3 way handshake failed")
 810             raise
 811
 812     def verify_ipfix_nat44_ses(self, data):
 813         """
 814         Verify IPFIX NAT44 session create/delete event
 815
 816         :param data: Decoded IPFIX data records
 817         """
 818         nat44_ses_create_num = 0
 819         nat44_ses_delete_num = 0
 820         self.assertEqual(6, len(data))
 821         for record in data:
 822             # natEvent
 823             self.assertIn(ord(record[230]), [4, 5])
 824             if ord(record[230]) == 4:
 825                 nat44_ses_create_num += 1
 826             else:
 827                 nat44_ses_delete_num += 1
 828             # sourceIPv4Address
 829             self.assertEqual(self.pg0.remote_ip4n, record[8])
 830             # postNATSourceIPv4Address
 831             self.assertEqual(socket.inet_pton(socket.AF_INET, self.nat_addr),
 832                              record[225])
 833             # ingressVRFID
 834             self.assertEqual(struct.pack("!I", 0), record[234])
 835             # protocolIdentifier/sourceTransportPort/postNAPTSourceTransportPort
 836             if IP_PROTOS.icmp == ord(record[4]):
 837                 self.assertEqual(struct.pack("!H", self.icmp_id_in), record[7])
 838                 self.assertEqual(struct.pack("!H", self.icmp_id_out),
 839                                  record[227])
 840             elif IP_PROTOS.tcp == ord(record[4]):
 841                 self.assertEqual(struct.pack("!H", self.tcp_port_in),
 842                                  record[7])
 843                 self.assertEqual(struct.pack("!H", self.tcp_port_out),
 844                                  record[227])
 845             elif IP_PROTOS.udp == ord(record[4]):
 846                 self.assertEqual(struct.pack("!H", self.udp_port_in),
 847                                  record[7])
 848                 self.assertEqual(struct.pack("!H", self.udp_port_out),
 849                                  record[227])
 850             else:
 851                 self.fail("Invalid protocol")
 852         self.assertEqual(3, nat44_ses_create_num)
 853         self.assertEqual(3, nat44_ses_delete_num)
 854
 855     def verify_ipfix_addr_exhausted(self, data):
 856         """
 857         Verify IPFIX NAT addresses event
 858
 859         :param data: Decoded IPFIX data records
 860         """
 861         self.assertEqual(1, len(data))
 862         record = data[0]
 863         # natEvent
 864         self.assertEqual(ord(record[230]), 3)
 865         # natPoolID
 866         self.assertEqual(struct.pack("!I", 0), record[283])
 867
 868     def verify_ipfix_max_sessions(self, data, limit):
 869         """
 870         Verify IPFIX maximum session entries exceeded event
 871
 872         :param data: Decoded IPFIX data records
 873         :param limit: Number of maximum session entries that can be created.
 874         """
 875         self.assertEqual(1, len(data))
 876         record = data[0]
 877         # natEvent
 878         self.assertEqual(ord(record[230]), 13)
 879         # natQuotaExceededEvent
 880         self.assertEqual(struct.pack("I", 1), record[466])
 881         # maxSessionEntries
 882         self.assertEqual(struct.pack("I", limit), record[471])
 883
 884     def verify_ipfix_max_bibs(self, data, limit):
 885         """
 886         Verify IPFIX maximum BIB entries exceeded event
 887
 888         :param data: Decoded IPFIX data records
 889         :param limit: Number of maximum BIB entries that can be created.
 890         """
 891         self.assertEqual(1, len(data))
 892         record = data[0]
 893         # natEvent
 894         self.assertEqual(ord(record[230]), 13)
 895         # natQuotaExceededEvent
 896         self.assertEqual(struct.pack("I", 2), record[466])
 897         # maxBIBEntries
 898         self.assertEqual(struct.pack("I", limit), record[472])
 899
 900     def verify_ipfix_max_fragments_ip6(self, data, limit, src_addr):
 901         """
 902         Verify IPFIX maximum IPv6 fragments pending reassembly exceeded event
 903
 904         :param data: Decoded IPFIX data records
 905         :param limit: Number of maximum fragments pending reassembly
 906         :param src_addr: IPv6 source address
 907         """
 908         self.assertEqual(1, len(data))
 909         record = data[0]
 910         # natEvent
 911         self.assertEqual(ord(record[230]), 13)
 912         # natQuotaExceededEvent
 913         self.assertEqual(struct.pack("I", 5), record[466])
 914         # maxFragmentsPendingReassembly
 915         self.assertEqual(struct.pack("I", limit), record[475])
 916         # sourceIPv6Address
 917         self.assertEqual(src_addr, record[27])
 918
 919     def verify_ipfix_max_fragments_ip4(self, data, limit, src_addr):
 920         """
 921         Verify IPFIX maximum IPv4 fragments pending reassembly exceeded event
 922
 923         :param data: Decoded IPFIX data records
 924         :param limit: Number of maximum fragments pending reassembly
 925         :param src_addr: IPv4 source address
 926         """
 927         self.assertEqual(1, len(data))
 928         record = data[0]
 929         # natEvent
 930         self.assertEqual(ord(record[230]), 13)
 931         # natQuotaExceededEvent
 932         self.assertEqual(struct.pack("I", 5), record[466])
 933         # maxFragmentsPendingReassembly
 934         self.assertEqual(struct.pack("I", limit), record[475])
 935         # sourceIPv4Address
 936         self.assertEqual(src_addr, record[8])
 937
 938     def verify_ipfix_bib(self, data, is_create, src_addr):
 939         """
 940         Verify IPFIX NAT64 BIB create and delete events
 941
 942         :param data: Decoded IPFIX data records
 943         :param is_create: Create event if nonzero value otherwise delete event
 944         :param src_addr: IPv6 source address
 945         """
 946         self.assertEqual(1, len(data))
 947         record = data[0]
 948         # natEvent
 949         if is_create:
 950             self.assertEqual(ord(record[230]), 10)
 951         else:
 952             self.assertEqual(ord(record[230]), 11)
 953         # sourceIPv6Address
 954         self.assertEqual(src_addr, record[27])
 955         # postNATSourceIPv4Address
 956         self.assertEqual(self.nat_addr_n, record[225])
 957         # protocolIdentifier
 958         self.assertEqual(IP_PROTOS.tcp, ord(record[4]))
 959         # ingressVRFID
 960         self.assertEqual(struct.pack("!I", 0), record[234])
 961         # sourceTransportPort
 962         self.assertEqual(struct.pack("!H", self.tcp_port_in), record[7])
 963         # postNAPTSourceTransportPort
 964         self.assertEqual(struct.pack("!H", self.tcp_port_out), record[227])
 965
 966     def verify_ipfix_nat64_ses(self, data, is_create, src_addr, dst_addr,
 967                                dst_port):
 968         """
 969         Verify IPFIX NAT64 session create and delete events
 970
 971         :param data: Decoded IPFIX data records
 972         :param is_create: Create event if nonzero value otherwise delete event
 973         :param src_addr: IPv6 source address
 974         :param dst_addr: IPv4 destination address
 975         :param dst_port: destination TCP port
 976         """
 977         self.assertEqual(1, len(data))
 978         record = data[0]
 979         # natEvent
 980         if is_create:
 981             self.assertEqual(ord(record[230]), 6)
 982         else:
 983             self.assertEqual(ord(record[230]), 7)
 984         # sourceIPv6Address
 985         self.assertEqual(src_addr, record[27])
 986         # destinationIPv6Address
 987         self.assertEqual(socket.inet_pton(socket.AF_INET6,
 988                                           self.compose_ip6(dst_addr,
 989                                                            '64:ff9b::',
 990                                                            96)),
 991                          record[28])
 992         # postNATSourceIPv4Address
 993         self.assertEqual(self.nat_addr_n, record[225])
 994         # postNATDestinationIPv4Address
 995         self.assertEqual(socket.inet_pton(socket.AF_INET, dst_addr),
 996                          record[226])
 997         # protocolIdentifier
 998         self.assertEqual(IP_PROTOS.tcp, ord(record[4]))
 999         # ingressVRFID
1000         self.assertEqual(struct.pack("!I", 0), record[234])
1001         # sourceTransportPort
1002         self.assertEqual(struct.pack("!H", self.tcp_port_in), record[7])
1003         # postNAPTSourceTransportPort
1004         self.assertEqual(struct.pack("!H", self.tcp_port_out), record[227])
1005         # destinationTransportPort
1006         self.assertEqual(struct.pack("!H", dst_port), record[11])
1007         # postNAPTDestinationTransportPort
1008         self.assertEqual(struct.pack("!H", dst_port), record[228])
1009
1010     def verify_no_nat44_user(self):
1011         """ Verify that there is no NAT44 user """
1012         users = self.vapi.nat44_user_dump()
1013         self.assertEqual(len(users), 0)
1014
1015     def verify_ipfix_max_entries_per_user(self, data, limit, src_addr):
1016         """
1017         Verify IPFIX maximum entries per user exceeded event
1018
1019         :param data: Decoded IPFIX data records
1020         :param limit: Number of maximum entries per user
1021         :param src_addr: IPv4 source address
1022         """
1023         self.assertEqual(1, len(data))
1024         record = data[0]
1025         # natEvent
1026         self.assertEqual(ord(record[230]), 13)
1027         # natQuotaExceededEvent
1028         self.assertEqual(struct.pack("I", 3), record[466])
1029         # maxEntriesPerUser
1030         self.assertEqual(struct.pack("I", limit), record[473])
1031         # sourceIPv4Address
1032         self.assertEqual(src_addr, record[8])
1033
1034     def verify_mss_value(self, pkt, mss):
1035         """
1036         Verify TCP MSS value
1037
1038         :param pkt:
1039         :param mss:
1040         """
1041         if not pkt.haslayer(IP) or not pkt.haslayer(TCP):
1042             raise TypeError("Not a TCP/IP packet")
1043
1044         for option in pkt[TCP].options:
1045             if option[0] == 'MSS':
1046                 self.assertEqual(option[1], mss)
1047                 self.assert_tcp_checksum_valid(pkt)
1048
1049     @staticmethod
1050     def proto2layer(proto):
1051         if proto == IP_PROTOS.tcp:
1052             return TCP
1053         elif proto == IP_PROTOS.udp:
1054             return UDP
1055         elif proto == IP_PROTOS.icmp:
1056             return ICMP
1057         else:
1058             raise Exception("Unsupported protocol")
1059
1060     def frag_in_order(self, proto=IP_PROTOS.tcp, dont_translate=False):
1061         layer = self.proto2layer(proto)
1062
1063         if proto == IP_PROTOS.tcp:
1064             data = "A" * 4 + "B" * 16 + "C" * 3
1065         else:
1066             data = "A" * 16 + "B" * 16 + "C" * 3
1067         self.port_in = random.randint(1025, 65535)
1068
1069         reass = self.vapi.nat_reass_dump()
1070         reass_n_start = len(reass)
1071
1072         # in2out
1073         pkts = self.create_stream_frag(self.pg0,
1074                                        self.pg1.remote_ip4,
1075                                        self.port_in,
1076                                        20,
1077                                        data,
1078                                        proto)
1079         self.pg0.add_stream(pkts)
1080         self.pg_enable_capture(self.pg_interfaces)
1081         self.pg_start()
1082         frags = self.pg1.get_capture(len(pkts))
1083         if not dont_translate:
1084             p = self.reass_frags_and_verify(frags,
1085                                             self.nat_addr,
1086                                             self.pg1.remote_ip4)
1087         else:
1088             p = self.reass_frags_and_verify(frags,
1089                                             self.pg0.remote_ip4,
1090                                             self.pg1.remote_ip4)
1091         if proto != IP_PROTOS.icmp:
1092             if not dont_translate:
1093                 self.assertEqual(p[layer].dport, 20)
1094                 self.assertNotEqual(p[layer].sport, self.port_in)
1095             else:
1096                 self.assertEqual(p[layer].sport, self.port_in)
1097         else:
1098             if not dont_translate:
1099                 self.assertNotEqual(p[layer].id, self.port_in)
1100             else:
1101                 self.assertEqual(p[layer].id, self.port_in)
1102         self.assertEqual(data, p[Raw].load)
1103
1104         # out2in
1105         if not dont_translate:
1106             dst_addr = self.nat_addr
1107         else:
1108             dst_addr = self.pg0.remote_ip4
1109         if proto != IP_PROTOS.icmp:
1110             sport = 20
1111             dport = p[layer].sport
1112         else:
1113             sport = p[layer].id
1114             dport = 0
1115         pkts = self.create_stream_frag(self.pg1,
1116                                        dst_addr,
1117                                        sport,
1118                                        dport,
1119                                        data,
1120                                        proto,
1121                                        echo_reply=True)
1122         self.pg1.add_stream(pkts)
1123         self.pg_enable_capture(self.pg_interfaces)
1124         self.pg_start()
1125         frags = self.pg0.get_capture(len(pkts))
1126         p = self.reass_frags_and_verify(frags,
1127                                         self.pg1.remote_ip4,
1128                                         self.pg0.remote_ip4)
1129         if proto != IP_PROTOS.icmp:
1130             self.assertEqual(p[layer].sport, 20)
1131             self.assertEqual(p[layer].dport, self.port_in)
1132         else:
1133             self.assertEqual(p[layer].id, self.port_in)
1134         self.assertEqual(data, p[Raw].load)
1135
1136         reass = self.vapi.nat_reass_dump()
1137         reass_n_end = len(reass)
1138
1139         self.assertEqual(reass_n_end - reass_n_start, 2)
1140
1141     def frag_in_order_in_plus_out(self, proto=IP_PROTOS.tcp):
1142         layer = self.proto2layer(proto)
1143
1144         if proto == IP_PROTOS.tcp:
1145             data = "A" * 4 + "B" * 16 + "C" * 3
1146         else:
1147             data = "A" * 16 + "B" * 16 + "C" * 3
1148         self.port_in = random.randint(1025, 65535)
1149
1150         for i in range(2):
1151             reass = self.vapi.nat_reass_dump()
1152             reass_n_start = len(reass)
1153
1154             # out2in
1155             pkts = self.create_stream_frag(self.pg0,
1156                                            self.server_out_addr,
1157                                            self.port_in,
1158                                            self.server_out_port,
1159                                            data,
1160                                            proto)
1161             self.pg0.add_stream(pkts)
1162             self.pg_enable_capture(self.pg_interfaces)
1163             self.pg_start()
1164             frags = self.pg1.get_capture(len(pkts))
1165             p = self.reass_frags_and_verify(frags,
1166                                             self.pg0.remote_ip4,
1167                                             self.server_in_addr)
1168             if proto != IP_PROTOS.icmp:
1169                 self.assertEqual(p[layer].sport, self.port_in)
1170                 self.assertEqual(p[layer].dport, self.server_in_port)
1171             else:
1172                 self.assertEqual(p[layer].id, self.port_in)
1173             self.assertEqual(data, p[Raw].load)
1174
1175             # in2out
1176             if proto != IP_PROTOS.icmp:
1177                 pkts = self.create_stream_frag(self.pg1,
1178                                                self.pg0.remote_ip4,
1179                                                self.server_in_port,
1180                                                p[layer].sport,
1181                                                data,
1182                                                proto)
1183             else:
1184                 pkts = self.create_stream_frag(self.pg1,
1185                                                self.pg0.remote_ip4,
1186                                                p[layer].id,
1187                                                0,
1188                                                data,
1189                                                proto,
1190                                                echo_reply=True)
1191             self.pg1.add_stream(pkts)
1192             self.pg_enable_capture(self.pg_interfaces)
1193             self.pg_start()
1194             frags = self.pg0.get_capture(len(pkts))
1195             p = self.reass_frags_and_verify(frags,
1196                                             self.server_out_addr,
1197                                             self.pg0.remote_ip4)
1198             if proto != IP_PROTOS.icmp:
1199                 self.assertEqual(p[layer].sport, self.server_out_port)
1200                 self.assertEqual(p[layer].dport, self.port_in)
1201             else:
1202                 self.assertEqual(p[layer].id, self.port_in)
1203             self.assertEqual(data, p[Raw].load)
1204
1205             reass = self.vapi.nat_reass_dump()
1206             reass_n_end = len(reass)
1207
1208             self.assertEqual(reass_n_end - reass_n_start, 2)
1209
1210     def reass_hairpinning(self, proto=IP_PROTOS.tcp):
1211         layer = self.proto2layer(proto)
1212
1213         if proto == IP_PROTOS.tcp:
1214             data = "A" * 4 + "B" * 16 + "C" * 3
1215         else:
1216             data = "A" * 16 + "B" * 16 + "C" * 3
1217
1218         # send packet from host to server
1219         pkts = self.create_stream_frag(self.pg0,
1220                                        self.nat_addr,
1221                                        self.host_in_port,
1222                                        self.server_out_port,
1223                                        data,
1224                                        proto)
1225         self.pg0.add_stream(pkts)
1226         self.pg_enable_capture(self.pg_interfaces)
1227         self.pg_start()
1228         frags = self.pg0.get_capture(len(pkts))
1229         p = self.reass_frags_and_verify(frags,
1230                                         self.nat_addr,
1231                                         self.server.ip4)
1232         if proto != IP_PROTOS.icmp:
1233             self.assertNotEqual(p[layer].sport, self.host_in_port)
1234             self.assertEqual(p[layer].dport, self.server_in_port)
1235         else:
1236             self.assertNotEqual(p[layer].id, self.host_in_port)
1237         self.assertEqual(data, p[Raw].load)
1238
1239     def frag_out_of_order(self, proto=IP_PROTOS.tcp, dont_translate=False):
1240         layer = self.proto2layer(proto)
1241
1242         if proto == IP_PROTOS.tcp:
1243             data = "A" * 4 + "B" * 16 + "C" * 3
1244         else:
1245             data = "A" * 16 + "B" * 16 + "C" * 3
1246         self.port_in = random.randint(1025, 65535)
1247
1248         for i in range(2):
1249             # in2out
1250             pkts = self.create_stream_frag(self.pg0,
1251                                            self.pg1.remote_ip4,
1252                                            self.port_in,
1253                                            20,
1254                                            data,
1255                                            proto)
1256             pkts.reverse()
1257             self.pg0.add_stream(pkts)
1258             self.pg_enable_capture(self.pg_interfaces)
1259             self.pg_start()
1260             frags = self.pg1.get_capture(len(pkts))
1261             if not dont_translate:
1262                 p = self.reass_frags_and_verify(frags,
1263                                                 self.nat_addr,
1264                                                 self.pg1.remote_ip4)
1265             else:
1266                 p = self.reass_frags_and_verify(frags,
1267                                                 self.pg0.remote_ip4,
1268                                                 self.pg1.remote_ip4)
1269             if proto != IP_PROTOS.icmp:
1270                 if not dont_translate:
1271                     self.assertEqual(p[layer].dport, 20)
1272                     self.assertNotEqual(p[layer].sport, self.port_in)
1273                 else:
1274                     self.assertEqual(p[layer].sport, self.port_in)
1275             else:
1276                 if not dont_translate:
1277                     self.assertNotEqual(p[layer].id, self.port_in)
1278                 else:
1279                     self.assertEqual(p[layer].id, self.port_in)
1280             self.assertEqual(data, p[Raw].load)
1281
1282             # out2in
1283             if not dont_translate:
1284                 dst_addr = self.nat_addr
1285             else:
1286                 dst_addr = self.pg0.remote_ip4
1287             if proto != IP_PROTOS.icmp:
1288                 sport = 20
1289                 dport = p[layer].sport
1290             else:
1291                 sport = p[layer].id
1292                 dport = 0
1293             pkts = self.create_stream_frag(self.pg1,
1294                                            dst_addr,
1295                                            sport,
1296                                            dport,
1297                                            data,
1298                                            proto,
1299                                            echo_reply=True)
1300             pkts.reverse()
1301             self.pg1.add_stream(pkts)
1302             self.pg_enable_capture(self.pg_interfaces)
1303             self.pg_start()
1304             frags = self.pg0.get_capture(len(pkts))
1305             p = self.reass_frags_and_verify(frags,
1306                                             self.pg1.remote_ip4,
1307                                             self.pg0.remote_ip4)
1308             if proto != IP_PROTOS.icmp:
1309                 self.assertEqual(p[layer].sport, 20)
1310                 self.assertEqual(p[layer].dport, self.port_in)
1311             else:
1312                 self.assertEqual(p[layer].id, self.port_in)
1313             self.assertEqual(data, p[Raw].load)
1314
1315     def frag_out_of_order_in_plus_out(self, proto=IP_PROTOS.tcp):
1316         layer = self.proto2layer(proto)
1317
1318         if proto == IP_PROTOS.tcp:
1319             data = "A" * 4 + "B" * 16 + "C" * 3
1320         else:
1321             data = "A" * 16 + "B" * 16 + "C" * 3
1322         self.port_in = random.randint(1025, 65535)
1323
1324         for i in range(2):
1325             # out2in
1326             pkts = self.create_stream_frag(self.pg0,
1327                                            self.server_out_addr,
1328                                            self.port_in,
1329                                            self.server_out_port,
1330                                            data,
1331                                            proto)
1332             pkts.reverse()
1333             self.pg0.add_stream(pkts)
1334             self.pg_enable_capture(self.pg_interfaces)
1335             self.pg_start()
1336             frags = self.pg1.get_capture(len(pkts))
1337             p = self.reass_frags_and_verify(frags,
1338                                             self.pg0.remote_ip4,
1339                                             self.server_in_addr)
1340             if proto != IP_PROTOS.icmp:
1341                 self.assertEqual(p[layer].dport, self.server_in_port)
1342                 self.assertEqual(p[layer].sport, self.port_in)
1343                 self.assertEqual(p[layer].dport, self.server_in_port)
1344             else:
1345                 self.assertEqual(p[layer].id, self.port_in)
1346             self.assertEqual(data, p[Raw].load)
1347
1348             # in2out
1349             if proto != IP_PROTOS.icmp:
1350                 pkts = self.create_stream_frag(self.pg1,
1351                                                self.pg0.remote_ip4,
1352                                                self.server_in_port,
1353                                                p[layer].sport,
1354                                                data,
1355                                                proto)
1356             else:
1357                 pkts = self.create_stream_frag(self.pg1,
1358                                                self.pg0.remote_ip4,
1359                                                p[layer].id,
1360                                                0,
1361                                                data,
1362                                                proto,
1363                                                echo_reply=True)
1364             pkts.reverse()
1365             self.pg1.add_stream(pkts)
1366             self.pg_enable_capture(self.pg_interfaces)
1367             self.pg_start()
1368             frags = self.pg0.get_capture(len(pkts))
1369             p = self.reass_frags_and_verify(frags,
1370                                             self.server_out_addr,
1371                                             self.pg0.remote_ip4)
1372             if proto != IP_PROTOS.icmp:
1373                 self.assertEqual(p[layer].sport, self.server_out_port)
1374                 self.assertEqual(p[layer].dport, self.port_in)
1375             else:
1376                 self.assertEqual(p[layer].id, self.port_in)
1377             self.assertEqual(data, p[Raw].load)
1378
1379
1380 class TestNAT44(MethodHolder):
1381     """ NAT44 Test Cases """
1382
1383     @classmethod
1384     def setUpClass(cls):
1385         super(TestNAT44, cls).setUpClass()
1386         cls.vapi.cli("set log class nat level debug")
1387
1388         try:
1389             cls.tcp_port_in = 6303
1390             cls.tcp_port_out = 6303
1391             cls.udp_port_in = 6304
1392             cls.udp_port_out = 6304
1393             cls.icmp_id_in = 6305
1394             cls.icmp_id_out = 6305
1395             cls.nat_addr = '10.0.0.3'
1396             cls.nat_addr_n = socket.inet_pton(socket.AF_INET, cls.nat_addr)
1397             cls.ipfix_src_port = 4739
1398             cls.ipfix_domain_id = 1
1399             cls.tcp_external_port = 80
1400
1401             cls.create_pg_interfaces(range(10))
1402             cls.interfaces = list(cls.pg_interfaces[0:4])
1403
1404             for i in cls.interfaces:
1405                 i.admin_up()
1406                 i.config_ip4()
1407                 i.resolve_arp()
1408
1409             cls.pg0.generate_remote_hosts(3)
1410             cls.pg0.configure_ipv4_neighbors()
1411
1412             cls.pg1.generate_remote_hosts(1)
1413             cls.pg1.configure_ipv4_neighbors()
1414
1415             cls.overlapping_interfaces = list(list(cls.pg_interfaces[4:7]))
1416             cls.vapi.ip_table_add_del(10, is_add=1)
1417             cls.vapi.ip_table_add_del(20, is_add=1)
1418
1419             cls.pg4._local_ip4 = "172.16.255.1"
1420             cls.pg4._local_ip4n = socket.inet_pton(socket.AF_INET, i.local_ip4)
1421             cls.pg4._remote_hosts[0]._ip4 = "172.16.255.2"
1422             cls.pg4.set_table_ip4(10)
1423             cls.pg5._local_ip4 = "172.17.255.3"
1424             cls.pg5._local_ip4n = socket.inet_pton(socket.AF_INET, i.local_ip4)
1425             cls.pg5._remote_hosts[0]._ip4 = "172.17.255.4"
1426             cls.pg5.set_table_ip4(10)
1427             cls.pg6._local_ip4 = "172.16.255.1"
1428             cls.pg6._local_ip4n = socket.inet_pton(socket.AF_INET, i.local_ip4)
1429             cls.pg6._remote_hosts[0]._ip4 = "172.16.255.2"
1430             cls.pg6.set_table_ip4(20)
1431             for i in cls.overlapping_interfaces:
1432                 i.config_ip4()
1433                 i.admin_up()
1434                 i.resolve_arp()
1435
1436             cls.pg7.admin_up()
1437             cls.pg8.admin_up()
1438
1439             cls.pg9.generate_remote_hosts(2)
1440             cls.pg9.config_ip4()
1441             ip_addr_n = socket.inet_pton(socket.AF_INET, "10.0.0.1")
1442             cls.vapi.sw_interface_add_del_address(cls.pg9.sw_if_index,
1443                                                   ip_addr_n,
1444                                                   24)
1445             cls.pg9.admin_up()
1446             cls.pg9.resolve_arp()
1447             cls.pg9._remote_hosts[1]._ip4 = cls.pg9._remote_hosts[0]._ip4
1448             cls.pg4._remote_ip4 = cls.pg9._remote_hosts[0]._ip4 = "10.0.0.2"
1449             cls.pg9.resolve_arp()
1450
1451         except Exception:
1452             super(TestNAT44, cls).tearDownClass()
1453             raise
1454
1455     def test_dynamic(self):
1456         """ NAT44 dynamic translation test """
1457
1458         self.nat44_add_address(self.nat_addr)
1459         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1460         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1461                                                   is_inside=0)
1462
1463         # in2out
1464         pkts = self.create_stream_in(self.pg0, self.pg1)
1465         self.pg0.add_stream(pkts)
1466         self.pg_enable_capture(self.pg_interfaces)
1467         self.pg_start()
1468         capture = self.pg1.get_capture(len(pkts))
1469         self.verify_capture_out(capture)
1470
1471         # out2in
1472         pkts = self.create_stream_out(self.pg1)
1473         self.pg1.add_stream(pkts)
1474         self.pg_enable_capture(self.pg_interfaces)
1475         self.pg_start()
1476         capture = self.pg0.get_capture(len(pkts))
1477         self.verify_capture_in(capture, self.pg0)
1478
1479     def test_dynamic_icmp_errors_in2out_ttl_1(self):
1480         """ NAT44 handling of client packets with TTL=1 """
1481
1482         self.nat44_add_address(self.nat_addr)
1483         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1484         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1485                                                   is_inside=0)
1486
1487         # Client side - generate traffic
1488         pkts = self.create_stream_in(self.pg0, self.pg1, ttl=1)
1489         self.pg0.add_stream(pkts)
1490         self.pg_enable_capture(self.pg_interfaces)
1491         self.pg_start()
1492
1493         # Client side - verify ICMP type 11 packets
1494         capture = self.pg0.get_capture(len(pkts))
1495         self.verify_capture_in_with_icmp_errors(capture, self.pg0)
1496
1497     def test_dynamic_icmp_errors_out2in_ttl_1(self):
1498         """ NAT44 handling of server packets with TTL=1 """
1499
1500         self.nat44_add_address(self.nat_addr)
1501         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1502         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1503                                                   is_inside=0)
1504
1505         # Client side - create sessions
1506         pkts = self.create_stream_in(self.pg0, self.pg1)
1507         self.pg0.add_stream(pkts)
1508         self.pg_enable_capture(self.pg_interfaces)
1509         self.pg_start()
1510
1511         # Server side - generate traffic
1512         capture = self.pg1.get_capture(len(pkts))
1513         self.verify_capture_out(capture)
1514         pkts = self.create_stream_out(self.pg1, ttl=1)
1515         self.pg1.add_stream(pkts)
1516         self.pg_enable_capture(self.pg_interfaces)
1517         self.pg_start()
1518
1519         # Server side - verify ICMP type 11 packets
1520         capture = self.pg1.get_capture(len(pkts))
1521         self.verify_capture_out_with_icmp_errors(capture,
1522                                                  src_ip=self.pg1.local_ip4)
1523
1524     def test_dynamic_icmp_errors_in2out_ttl_2(self):
1525         """ NAT44 handling of error responses to client packets with TTL=2 """
1526
1527         self.nat44_add_address(self.nat_addr)
1528         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1529         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1530                                                   is_inside=0)
1531
1532         # Client side - generate traffic
1533         pkts = self.create_stream_in(self.pg0, self.pg1, ttl=2)
1534         self.pg0.add_stream(pkts)
1535         self.pg_enable_capture(self.pg_interfaces)
1536         self.pg_start()
1537
1538         # Server side - simulate ICMP type 11 response
1539         capture = self.pg1.get_capture(len(pkts))
1540         pkts = [Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
1541                 IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
1542                 ICMP(type=11) / packet[IP] for packet in capture]
1543         self.pg1.add_stream(pkts)
1544         self.pg_enable_capture(self.pg_interfaces)
1545         self.pg_start()
1546
1547         # Client side - verify ICMP type 11 packets
1548         capture = self.pg0.get_capture(len(pkts))
1549         self.verify_capture_in_with_icmp_errors(capture, self.pg0)
1550
1551     def test_dynamic_icmp_errors_out2in_ttl_2(self):
1552         """ NAT44 handling of error responses to server packets with TTL=2 """
1553
1554         self.nat44_add_address(self.nat_addr)
1555         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1556         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1557                                                   is_inside=0)
1558
1559         # Client side - create sessions
1560         pkts = self.create_stream_in(self.pg0, self.pg1)
1561         self.pg0.add_stream(pkts)
1562         self.pg_enable_capture(self.pg_interfaces)
1563         self.pg_start()
1564
1565         # Server side - generate traffic
1566         capture = self.pg1.get_capture(len(pkts))
1567         self.verify_capture_out(capture)
1568         pkts = self.create_stream_out(self.pg1, ttl=2)
1569         self.pg1.add_stream(pkts)
1570         self.pg_enable_capture(self.pg_interfaces)
1571         self.pg_start()
1572
1573         # Client side - simulate ICMP type 11 response
1574         capture = self.pg0.get_capture(len(pkts))
1575         pkts = [Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
1576                 IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
1577                 ICMP(type=11) / packet[IP] for packet in capture]
1578         self.pg0.add_stream(pkts)
1579         self.pg_enable_capture(self.pg_interfaces)
1580         self.pg_start()
1581
1582         # Server side - verify ICMP type 11 packets
1583         capture = self.pg1.get_capture(len(pkts))
1584         self.verify_capture_out_with_icmp_errors(capture)
1585
1586     def test_ping_out_interface_from_outside(self):
1587         """ Ping NAT44 out interface from outside network """
1588
1589         self.nat44_add_address(self.nat_addr)
1590         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1591         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1592                                                   is_inside=0)
1593
1594         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
1595              IP(src=self.pg1.remote_ip4, dst=self.pg1.local_ip4) /
1596              ICMP(id=self.icmp_id_out, type='echo-request'))
1597         pkts = [p]
1598         self.pg1.add_stream(pkts)
1599         self.pg_enable_capture(self.pg_interfaces)
1600         self.pg_start()
1601         capture = self.pg1.get_capture(len(pkts))
1602         packet = capture[0]
1603         try:
1604             self.assertEqual(packet[IP].src, self.pg1.local_ip4)
1605             self.assertEqual(packet[IP].dst, self.pg1.remote_ip4)
1606             self.assertEqual(packet[ICMP].id, self.icmp_id_in)
1607             self.assertEqual(packet[ICMP].type, 0)  # echo reply
1608         except:
1609             self.logger.error(ppp("Unexpected or invalid packet "
1610                                   "(outside network):", packet))
1611             raise
1612
1613     def test_ping_internal_host_from_outside(self):
1614         """ Ping internal host from outside network """
1615
1616         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr)
1617         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1618         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1619                                                   is_inside=0)
1620
1621         # out2in
1622         pkt = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
1623                IP(src=self.pg1.remote_ip4, dst=self.nat_addr, ttl=64) /
1624                ICMP(id=self.icmp_id_out, type='echo-request'))
1625         self.pg1.add_stream(pkt)
1626         self.pg_enable_capture(self.pg_interfaces)
1627         self.pg_start()
1628         capture = self.pg0.get_capture(1)
1629         self.verify_capture_in(capture, self.pg0)
1630         self.assert_equal(capture[0][IP].proto, IP_PROTOS.icmp)
1631
1632         # in2out
1633         pkt = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
1634                IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4, ttl=64) /
1635                ICMP(id=self.icmp_id_in, type='echo-reply'))
1636         self.pg0.add_stream(pkt)
1637         self.pg_enable_capture(self.pg_interfaces)
1638         self.pg_start()
1639         capture = self.pg1.get_capture(1)
1640         self.verify_capture_out(capture, same_port=True)
1641         self.assert_equal(capture[0][IP].proto, IP_PROTOS.icmp)
1642
1643     def test_forwarding(self):
1644         """ NAT44 forwarding test """
1645
1646         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1647         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1648                                                   is_inside=0)
1649         self.vapi.nat44_forwarding_enable_disable(1)
1650
1651         real_ip = self.pg0.remote_ip4n
1652         alias_ip = self.nat_addr_n
1653         self.vapi.nat44_add_del_static_mapping(local_ip=real_ip,
1654                                                external_ip=alias_ip)
1655
1656         try:
1657             # static mapping match
1658
1659             pkts = self.create_stream_out(self.pg1)
1660             self.pg1.add_stream(pkts)
1661             self.pg_enable_capture(self.pg_interfaces)
1662             self.pg_start()
1663             capture = self.pg0.get_capture(len(pkts))
1664             self.verify_capture_in(capture, self.pg0)
1665
1666             pkts = self.create_stream_in(self.pg0, self.pg1)
1667             self.pg0.add_stream(pkts)
1668             self.pg_enable_capture(self.pg_interfaces)
1669             self.pg_start()
1670             capture = self.pg1.get_capture(len(pkts))
1671             self.verify_capture_out(capture, same_port=True)
1672
1673             # no static mapping match
1674
1675             host0 = self.pg0.remote_hosts[0]
1676             self.pg0.remote_hosts[0] = self.pg0.remote_hosts[1]
1677             try:
1678                 pkts = self.create_stream_out(self.pg1,
1679                                               dst_ip=self.pg0.remote_ip4,
1680                                               use_inside_ports=True)
1681                 self.pg1.add_stream(pkts)
1682                 self.pg_enable_capture(self.pg_interfaces)
1683                 self.pg_start()
1684                 capture = self.pg0.get_capture(len(pkts))
1685                 self.verify_capture_in(capture, self.pg0)
1686
1687                 pkts = self.create_stream_in(self.pg0, self.pg1)
1688                 self.pg0.add_stream(pkts)
1689                 self.pg_enable_capture(self.pg_interfaces)
1690                 self.pg_start()
1691                 capture = self.pg1.get_capture(len(pkts))
1692                 self.verify_capture_out(capture, nat_ip=self.pg0.remote_ip4,
1693                                         same_port=True)
1694             finally:
1695                 self.pg0.remote_hosts[0] = host0
1696
1697         finally:
1698             self.vapi.nat44_forwarding_enable_disable(0)
1699             self.vapi.nat44_add_del_static_mapping(local_ip=real_ip,
1700                                                    external_ip=alias_ip,
1701                                                    is_add=0)
1702
1703     def test_static_in(self):
1704         """ 1:1 NAT initialized from inside network """
1705
1706         nat_ip = "10.0.0.10"
1707         self.tcp_port_out = 6303
1708         self.udp_port_out = 6304
1709         self.icmp_id_out = 6305
1710
1711         self.nat44_add_static_mapping(self.pg0.remote_ip4, nat_ip)
1712         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1713         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1714                                                   is_inside=0)
1715         sm = self.vapi.nat44_static_mapping_dump()
1716         self.assertEqual(len(sm), 1)
1717         self.assertEqual((sm[0].tag).split('\0', 1)[0], '')
1718         self.assertEqual(sm[0].protocol, 0)
1719         self.assertEqual(sm[0].local_port, 0)
1720         self.assertEqual(sm[0].external_port, 0)
1721
1722         # in2out
1723         pkts = self.create_stream_in(self.pg0, self.pg1)
1724         self.pg0.add_stream(pkts)
1725         self.pg_enable_capture(self.pg_interfaces)
1726         self.pg_start()
1727         capture = self.pg1.get_capture(len(pkts))
1728         self.verify_capture_out(capture, nat_ip, True)
1729
1730         # out2in
1731         pkts = self.create_stream_out(self.pg1, nat_ip)
1732         self.pg1.add_stream(pkts)
1733         self.pg_enable_capture(self.pg_interfaces)
1734         self.pg_start()
1735         capture = self.pg0.get_capture(len(pkts))
1736         self.verify_capture_in(capture, self.pg0)
1737
1738     def test_static_out(self):
1739         """ 1:1 NAT initialized from outside network """
1740
1741         nat_ip = "10.0.0.20"
1742         self.tcp_port_out = 6303
1743         self.udp_port_out = 6304
1744         self.icmp_id_out = 6305
1745         tag = "testTAG"
1746
1747         self.nat44_add_static_mapping(self.pg0.remote_ip4, nat_ip, tag=tag)
1748         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1749         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1750                                                   is_inside=0)
1751         sm = self.vapi.nat44_static_mapping_dump()
1752         self.assertEqual(len(sm), 1)
1753         self.assertEqual((sm[0].tag).split('\0', 1)[0], tag)
1754
1755         # out2in
1756         pkts = self.create_stream_out(self.pg1, nat_ip)
1757         self.pg1.add_stream(pkts)
1758         self.pg_enable_capture(self.pg_interfaces)
1759         self.pg_start()
1760         capture = self.pg0.get_capture(len(pkts))
1761         self.verify_capture_in(capture, self.pg0)
1762
1763         # in2out
1764         pkts = self.create_stream_in(self.pg0, self.pg1)
1765         self.pg0.add_stream(pkts)
1766         self.pg_enable_capture(self.pg_interfaces)
1767         self.pg_start()
1768         capture = self.pg1.get_capture(len(pkts))
1769         self.verify_capture_out(capture, nat_ip, True)
1770
1771     def test_static_with_port_in(self):
1772         """ 1:1 NAPT initialized from inside network """
1773
1774         self.tcp_port_out = 3606
1775         self.udp_port_out = 3607
1776         self.icmp_id_out = 3608
1777
1778         self.nat44_add_address(self.nat_addr)
1779         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
1780                                       self.tcp_port_in, self.tcp_port_out,
1781                                       proto=IP_PROTOS.tcp)
1782         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
1783                                       self.udp_port_in, self.udp_port_out,
1784                                       proto=IP_PROTOS.udp)
1785         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
1786                                       self.icmp_id_in, self.icmp_id_out,
1787                                       proto=IP_PROTOS.icmp)
1788         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1789         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1790                                                   is_inside=0)
1791
1792         # in2out
1793         pkts = self.create_stream_in(self.pg0, self.pg1)
1794         self.pg0.add_stream(pkts)
1795         self.pg_enable_capture(self.pg_interfaces)
1796         self.pg_start()
1797         capture = self.pg1.get_capture(len(pkts))
1798         self.verify_capture_out(capture)
1799
1800         # out2in
1801         pkts = self.create_stream_out(self.pg1)
1802         self.pg1.add_stream(pkts)
1803         self.pg_enable_capture(self.pg_interfaces)
1804         self.pg_start()
1805         capture = self.pg0.get_capture(len(pkts))
1806         self.verify_capture_in(capture, self.pg0)
1807
1808     def test_static_with_port_out(self):
1809         """ 1:1 NAPT initialized from outside network """
1810
1811         self.tcp_port_out = 30606
1812         self.udp_port_out = 30607
1813         self.icmp_id_out = 30608
1814
1815         self.nat44_add_address(self.nat_addr)
1816         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
1817                                       self.tcp_port_in, self.tcp_port_out,
1818                                       proto=IP_PROTOS.tcp)
1819         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
1820                                       self.udp_port_in, self.udp_port_out,
1821                                       proto=IP_PROTOS.udp)
1822         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
1823                                       self.icmp_id_in, self.icmp_id_out,
1824                                       proto=IP_PROTOS.icmp)
1825         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1826         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1827                                                   is_inside=0)
1828
1829         # out2in
1830         pkts = self.create_stream_out(self.pg1)
1831         self.pg1.add_stream(pkts)
1832         self.pg_enable_capture(self.pg_interfaces)
1833         self.pg_start()
1834         capture = self.pg0.get_capture(len(pkts))
1835         self.verify_capture_in(capture, self.pg0)
1836
1837         # in2out
1838         pkts = self.create_stream_in(self.pg0, self.pg1)
1839         self.pg0.add_stream(pkts)
1840         self.pg_enable_capture(self.pg_interfaces)
1841         self.pg_start()
1842         capture = self.pg1.get_capture(len(pkts))
1843         self.verify_capture_out(capture)
1844
1845     def test_static_vrf_aware(self):
1846         """ 1:1 NAT VRF awareness """
1847
1848         nat_ip1 = "10.0.0.30"
1849         nat_ip2 = "10.0.0.40"
1850         self.tcp_port_out = 6303
1851         self.udp_port_out = 6304
1852         self.icmp_id_out = 6305
1853
1854         self.nat44_add_static_mapping(self.pg4.remote_ip4, nat_ip1,
1855                                       vrf_id=10)
1856         self.nat44_add_static_mapping(self.pg0.remote_ip4, nat_ip2,
1857                                       vrf_id=10)
1858         self.vapi.nat44_interface_add_del_feature(self.pg3.sw_if_index,
1859                                                   is_inside=0)
1860         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1861         self.vapi.nat44_interface_add_del_feature(self.pg4.sw_if_index)
1862
1863         # inside interface VRF match NAT44 static mapping VRF
1864         pkts = self.create_stream_in(self.pg4, self.pg3)
1865         self.pg4.add_stream(pkts)
1866         self.pg_enable_capture(self.pg_interfaces)
1867         self.pg_start()
1868         capture = self.pg3.get_capture(len(pkts))
1869         self.verify_capture_out(capture, nat_ip1, True)
1870
1871         # inside interface VRF don't match NAT44 static mapping VRF (packets
1872         # are dropped)
1873         pkts = self.create_stream_in(self.pg0, self.pg3)
1874         self.pg0.add_stream(pkts)
1875         self.pg_enable_capture(self.pg_interfaces)
1876         self.pg_start()
1877         self.pg3.assert_nothing_captured()
1878
1879     def test_dynamic_to_static(self):
1880         """ Switch from dynamic translation to 1:1NAT """
1881         nat_ip = "10.0.0.10"
1882         self.tcp_port_out = 6303
1883         self.udp_port_out = 6304
1884         self.icmp_id_out = 6305
1885
1886         self.nat44_add_address(self.nat_addr)
1887         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1888         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1889                                                   is_inside=0)
1890
1891         # dynamic
1892         pkts = self.create_stream_in(self.pg0, self.pg1)
1893         self.pg0.add_stream(pkts)
1894         self.pg_enable_capture(self.pg_interfaces)
1895         self.pg_start()
1896         capture = self.pg1.get_capture(len(pkts))
1897         self.verify_capture_out(capture)
1898
1899         # 1:1NAT
1900         self.nat44_add_static_mapping(self.pg0.remote_ip4, nat_ip)
1901         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n, 0)
1902         self.assertEqual(len(sessions), 0)
1903         pkts = self.create_stream_in(self.pg0, self.pg1)
1904         self.pg0.add_stream(pkts)
1905         self.pg_enable_capture(self.pg_interfaces)
1906         self.pg_start()
1907         capture = self.pg1.get_capture(len(pkts))
1908         self.verify_capture_out(capture, nat_ip, True)
1909
1910     def test_identity_nat(self):
1911         """ Identity NAT """
1912
1913         self.vapi.nat44_add_del_identity_mapping(ip=self.pg0.remote_ip4n)
1914         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1915         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
1916                                                   is_inside=0)
1917
1918         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
1919              IP(src=self.pg1.remote_ip4, dst=self.pg0.remote_ip4) /
1920              TCP(sport=12345, dport=56789))
1921         self.pg1.add_stream(p)
1922         self.pg_enable_capture(self.pg_interfaces)
1923         self.pg_start()
1924         capture = self.pg0.get_capture(1)
1925         p = capture[0]
1926         try:
1927             ip = p[IP]
1928             tcp = p[TCP]
1929             self.assertEqual(ip.dst, self.pg0.remote_ip4)
1930             self.assertEqual(ip.src, self.pg1.remote_ip4)
1931             self.assertEqual(tcp.dport, 56789)
1932             self.assertEqual(tcp.sport, 12345)
1933             self.assert_packet_checksums_valid(p)
1934         except:
1935             self.logger.error(ppp("Unexpected or invalid packet:", p))
1936             raise
1937
1938         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n, 0)
1939         self.assertEqual(len(sessions), 0)
1940         self.vapi.nat44_add_del_identity_mapping(ip=self.pg0.remote_ip4n,
1941                                                  vrf_id=1)
1942         identity_mappings = self.vapi.nat44_identity_mapping_dump()
1943         self.assertEqual(len(identity_mappings), 2)
1944
1945     def test_multiple_inside_interfaces(self):
1946         """ NAT44 multiple non-overlapping address space inside interfaces """
1947
1948         self.nat44_add_address(self.nat_addr)
1949         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
1950         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index)
1951         self.vapi.nat44_interface_add_del_feature(self.pg3.sw_if_index,
1952                                                   is_inside=0)
1953
1954         # between two NAT44 inside interfaces (no translation)
1955         pkts = self.create_stream_in(self.pg0, self.pg1)
1956         self.pg0.add_stream(pkts)
1957         self.pg_enable_capture(self.pg_interfaces)
1958         self.pg_start()
1959         capture = self.pg1.get_capture(len(pkts))
1960         self.verify_capture_no_translation(capture, self.pg0, self.pg1)
1961
1962         # from NAT44 inside to interface without NAT44 feature (no translation)
1963         pkts = self.create_stream_in(self.pg0, self.pg2)
1964         self.pg0.add_stream(pkts)
1965         self.pg_enable_capture(self.pg_interfaces)
1966         self.pg_start()
1967         capture = self.pg2.get_capture(len(pkts))
1968         self.verify_capture_no_translation(capture, self.pg0, self.pg2)
1969
1970         # in2out 1st interface
1971         pkts = self.create_stream_in(self.pg0, self.pg3)
1972         self.pg0.add_stream(pkts)
1973         self.pg_enable_capture(self.pg_interfaces)
1974         self.pg_start()
1975         capture = self.pg3.get_capture(len(pkts))
1976         self.verify_capture_out(capture)
1977
1978         # out2in 1st interface
1979         pkts = self.create_stream_out(self.pg3)
1980         self.pg3.add_stream(pkts)
1981         self.pg_enable_capture(self.pg_interfaces)
1982         self.pg_start()
1983         capture = self.pg0.get_capture(len(pkts))
1984         self.verify_capture_in(capture, self.pg0)
1985
1986         # in2out 2nd interface
1987         pkts = self.create_stream_in(self.pg1, self.pg3)
1988         self.pg1.add_stream(pkts)
1989         self.pg_enable_capture(self.pg_interfaces)
1990         self.pg_start()
1991         capture = self.pg3.get_capture(len(pkts))
1992         self.verify_capture_out(capture)
1993
1994         # out2in 2nd interface
1995         pkts = self.create_stream_out(self.pg3)
1996         self.pg3.add_stream(pkts)
1997         self.pg_enable_capture(self.pg_interfaces)
1998         self.pg_start()
1999         capture = self.pg1.get_capture(len(pkts))
2000         self.verify_capture_in(capture, self.pg1)
2001
2002     def test_inside_overlapping_interfaces(self):
2003         """ NAT44 multiple inside interfaces with overlapping address space """
2004
2005         static_nat_ip = "10.0.0.10"
2006         self.nat44_add_address(self.nat_addr)
2007         self.vapi.nat44_interface_add_del_feature(self.pg3.sw_if_index,
2008                                                   is_inside=0)
2009         self.vapi.nat44_interface_add_del_feature(self.pg4.sw_if_index)
2010         self.vapi.nat44_interface_add_del_feature(self.pg5.sw_if_index)
2011         self.vapi.nat44_interface_add_del_feature(self.pg6.sw_if_index)
2012         self.nat44_add_static_mapping(self.pg6.remote_ip4, static_nat_ip,
2013                                       vrf_id=20)
2014
2015         # between NAT44 inside interfaces with same VRF (no translation)
2016         pkts = self.create_stream_in(self.pg4, self.pg5)
2017         self.pg4.add_stream(pkts)
2018         self.pg_enable_capture(self.pg_interfaces)
2019         self.pg_start()
2020         capture = self.pg5.get_capture(len(pkts))
2021         self.verify_capture_no_translation(capture, self.pg4, self.pg5)
2022
2023         # between NAT44 inside interfaces with different VRF (hairpinning)
2024         p = (Ether(src=self.pg4.remote_mac, dst=self.pg4.local_mac) /
2025              IP(src=self.pg4.remote_ip4, dst=static_nat_ip) /
2026              TCP(sport=1234, dport=5678))
2027         self.pg4.add_stream(p)
2028         self.pg_enable_capture(self.pg_interfaces)
2029         self.pg_start()
2030         capture = self.pg6.get_capture(1)
2031         p = capture[0]
2032         try:
2033             ip = p[IP]
2034             tcp = p[TCP]
2035             self.assertEqual(ip.src, self.nat_addr)
2036             self.assertEqual(ip.dst, self.pg6.remote_ip4)
2037             self.assertNotEqual(tcp.sport, 1234)
2038             self.assertEqual(tcp.dport, 5678)
2039         except:
2040             self.logger.error(ppp("Unexpected or invalid packet:", p))
2041             raise
2042
2043         # in2out 1st interface
2044         pkts = self.create_stream_in(self.pg4, self.pg3)
2045         self.pg4.add_stream(pkts)
2046         self.pg_enable_capture(self.pg_interfaces)
2047         self.pg_start()
2048         capture = self.pg3.get_capture(len(pkts))
2049         self.verify_capture_out(capture)
2050
2051         # out2in 1st interface
2052         pkts = self.create_stream_out(self.pg3)
2053         self.pg3.add_stream(pkts)
2054         self.pg_enable_capture(self.pg_interfaces)
2055         self.pg_start()
2056         capture = self.pg4.get_capture(len(pkts))
2057         self.verify_capture_in(capture, self.pg4)
2058
2059         # in2out 2nd interface
2060         pkts = self.create_stream_in(self.pg5, self.pg3)
2061         self.pg5.add_stream(pkts)
2062         self.pg_enable_capture(self.pg_interfaces)
2063         self.pg_start()
2064         capture = self.pg3.get_capture(len(pkts))
2065         self.verify_capture_out(capture)
2066
2067         # out2in 2nd interface
2068         pkts = self.create_stream_out(self.pg3)
2069         self.pg3.add_stream(pkts)
2070         self.pg_enable_capture(self.pg_interfaces)
2071         self.pg_start()
2072         capture = self.pg5.get_capture(len(pkts))
2073         self.verify_capture_in(capture, self.pg5)
2074
2075         # pg5 session dump
2076         addresses = self.vapi.nat44_address_dump()
2077         self.assertEqual(len(addresses), 1)
2078         sessions = self.vapi.nat44_user_session_dump(self.pg5.remote_ip4n, 10)
2079         self.assertEqual(len(sessions), 3)
2080         for session in sessions:
2081             self.assertFalse(session.is_static)
2082             self.assertEqual(session.inside_ip_address[0:4],
2083                              self.pg5.remote_ip4n)
2084             self.assertEqual(session.outside_ip_address,
2085                              addresses[0].ip_address)
2086         self.assertEqual(sessions[0].protocol, IP_PROTOS.tcp)
2087         self.assertEqual(sessions[1].protocol, IP_PROTOS.udp)
2088         self.assertEqual(sessions[2].protocol, IP_PROTOS.icmp)
2089         self.assertEqual(sessions[0].inside_port, self.tcp_port_in)
2090         self.assertEqual(sessions[1].inside_port, self.udp_port_in)
2091         self.assertEqual(sessions[2].inside_port, self.icmp_id_in)
2092         self.assertEqual(sessions[0].outside_port, self.tcp_port_out)
2093         self.assertEqual(sessions[1].outside_port, self.udp_port_out)
2094         self.assertEqual(sessions[2].outside_port, self.icmp_id_out)
2095
2096         # in2out 3rd interface
2097         pkts = self.create_stream_in(self.pg6, self.pg3)
2098         self.pg6.add_stream(pkts)
2099         self.pg_enable_capture(self.pg_interfaces)
2100         self.pg_start()
2101         capture = self.pg3.get_capture(len(pkts))
2102         self.verify_capture_out(capture, static_nat_ip, True)
2103
2104         # out2in 3rd interface
2105         pkts = self.create_stream_out(self.pg3, static_nat_ip)
2106         self.pg3.add_stream(pkts)
2107         self.pg_enable_capture(self.pg_interfaces)
2108         self.pg_start()
2109         capture = self.pg6.get_capture(len(pkts))
2110         self.verify_capture_in(capture, self.pg6)
2111
2112         # general user and session dump verifications
2113         users = self.vapi.nat44_user_dump()
2114         self.assertTrue(len(users) >= 3)
2115         addresses = self.vapi.nat44_address_dump()
2116         self.assertEqual(len(addresses), 1)
2117         for user in users:
2118             sessions = self.vapi.nat44_user_session_dump(user.ip_address,
2119                                                          user.vrf_id)
2120             for session in sessions:
2121                 self.assertEqual(user.ip_address, session.inside_ip_address)
2122                 self.assertTrue(session.total_bytes > session.total_pkts > 0)
2123                 self.assertTrue(session.protocol in
2124                                 [IP_PROTOS.tcp, IP_PROTOS.udp,
2125                                  IP_PROTOS.icmp])
2126                 self.assertFalse(session.ext_host_valid)
2127
2128         # pg4 session dump
2129         sessions = self.vapi.nat44_user_session_dump(self.pg4.remote_ip4n, 10)
2130         self.assertTrue(len(sessions) >= 4)
2131         for session in sessions:
2132             self.assertFalse(session.is_static)
2133             self.assertEqual(session.inside_ip_address[0:4],
2134                              self.pg4.remote_ip4n)
2135             self.assertEqual(session.outside_ip_address,
2136                              addresses[0].ip_address)
2137
2138         # pg6 session dump
2139         sessions = self.vapi.nat44_user_session_dump(self.pg6.remote_ip4n, 20)
2140         self.assertTrue(len(sessions) >= 3)
2141         for session in sessions:
2142             self.assertTrue(session.is_static)
2143             self.assertEqual(session.inside_ip_address[0:4],
2144                              self.pg6.remote_ip4n)
2145             self.assertEqual(map(ord, session.outside_ip_address[0:4]),
2146                              map(int, static_nat_ip.split('.')))
2147             self.assertTrue(session.inside_port in
2148                             [self.tcp_port_in, self.udp_port_in,
2149                              self.icmp_id_in])
2150
2151     def test_hairpinning(self):
2152         """ NAT44 hairpinning - 1:1 NAPT """
2153
2154         host = self.pg0.remote_hosts[0]
2155         server = self.pg0.remote_hosts[1]
2156         host_in_port = 1234
2157         host_out_port = 0
2158         server_in_port = 5678
2159         server_out_port = 8765
2160
2161         self.nat44_add_address(self.nat_addr)
2162         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2163         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
2164                                                   is_inside=0)
2165         # add static mapping for server
2166         self.nat44_add_static_mapping(server.ip4, self.nat_addr,
2167                                       server_in_port, server_out_port,
2168                                       proto=IP_PROTOS.tcp)
2169
2170         # send packet from host to server
2171         p = (Ether(src=host.mac, dst=self.pg0.local_mac) /
2172              IP(src=host.ip4, dst=self.nat_addr) /
2173              TCP(sport=host_in_port, dport=server_out_port))
2174         self.pg0.add_stream(p)
2175         self.pg_enable_capture(self.pg_interfaces)
2176         self.pg_start()
2177         capture = self.pg0.get_capture(1)
2178         p = capture[0]
2179         try:
2180             ip = p[IP]
2181             tcp = p[TCP]
2182             self.assertEqual(ip.src, self.nat_addr)
2183             self.assertEqual(ip.dst, server.ip4)
2184             self.assertNotEqual(tcp.sport, host_in_port)
2185             self.assertEqual(tcp.dport, server_in_port)
2186             self.assert_packet_checksums_valid(p)
2187             host_out_port = tcp.sport
2188         except:
2189             self.logger.error(ppp("Unexpected or invalid packet:", p))
2190             raise
2191
2192         # send reply from server to host
2193         p = (Ether(src=server.mac, dst=self.pg0.local_mac) /
2194              IP(src=server.ip4, dst=self.nat_addr) /
2195              TCP(sport=server_in_port, dport=host_out_port))
2196         self.pg0.add_stream(p)
2197         self.pg_enable_capture(self.pg_interfaces)
2198         self.pg_start()
2199         capture = self.pg0.get_capture(1)
2200         p = capture[0]
2201         try:
2202             ip = p[IP]
2203             tcp = p[TCP]
2204             self.assertEqual(ip.src, self.nat_addr)
2205             self.assertEqual(ip.dst, host.ip4)
2206             self.assertEqual(tcp.sport, server_out_port)
2207             self.assertEqual(tcp.dport, host_in_port)
2208             self.assert_packet_checksums_valid(p)
2209         except:
2210             self.logger.error(ppp("Unexpected or invalid packet:", p))
2211             raise
2212
2213     def test_hairpinning2(self):
2214         """ NAT44 hairpinning - 1:1 NAT"""
2215
2216         server1_nat_ip = "10.0.0.10"
2217         server2_nat_ip = "10.0.0.11"
2218         host = self.pg0.remote_hosts[0]
2219         server1 = self.pg0.remote_hosts[1]
2220         server2 = self.pg0.remote_hosts[2]
2221         server_tcp_port = 22
2222         server_udp_port = 20
2223
2224         self.nat44_add_address(self.nat_addr)
2225         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2226         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
2227                                                   is_inside=0)
2228
2229         # add static mapping for servers
2230         self.nat44_add_static_mapping(server1.ip4, server1_nat_ip)
2231         self.nat44_add_static_mapping(server2.ip4, server2_nat_ip)
2232
2233         # host to server1
2234         pkts = []
2235         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2236              IP(src=host.ip4, dst=server1_nat_ip) /
2237              TCP(sport=self.tcp_port_in, dport=server_tcp_port))
2238         pkts.append(p)
2239         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2240              IP(src=host.ip4, dst=server1_nat_ip) /
2241              UDP(sport=self.udp_port_in, dport=server_udp_port))
2242         pkts.append(p)
2243         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2244              IP(src=host.ip4, dst=server1_nat_ip) /
2245              ICMP(id=self.icmp_id_in, type='echo-request'))
2246         pkts.append(p)
2247         self.pg0.add_stream(pkts)
2248         self.pg_enable_capture(self.pg_interfaces)
2249         self.pg_start()
2250         capture = self.pg0.get_capture(len(pkts))
2251         for packet in capture:
2252             try:
2253                 self.assertEqual(packet[IP].src, self.nat_addr)
2254                 self.assertEqual(packet[IP].dst, server1.ip4)
2255                 if packet.haslayer(TCP):
2256                     self.assertNotEqual(packet[TCP].sport, self.tcp_port_in)
2257                     self.assertEqual(packet[TCP].dport, server_tcp_port)
2258                     self.tcp_port_out = packet[TCP].sport
2259                     self.assert_packet_checksums_valid(packet)
2260                 elif packet.haslayer(UDP):
2261                     self.assertNotEqual(packet[UDP].sport, self.udp_port_in)
2262                     self.assertEqual(packet[UDP].dport, server_udp_port)
2263                     self.udp_port_out = packet[UDP].sport
2264                 else:
2265                     self.assertNotEqual(packet[ICMP].id, self.icmp_id_in)
2266                     self.icmp_id_out = packet[ICMP].id
2267             except:
2268                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
2269                 raise
2270
2271         # server1 to host
2272         pkts = []
2273         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2274              IP(src=server1.ip4, dst=self.nat_addr) /
2275              TCP(sport=server_tcp_port, dport=self.tcp_port_out))
2276         pkts.append(p)
2277         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2278              IP(src=server1.ip4, dst=self.nat_addr) /
2279              UDP(sport=server_udp_port, dport=self.udp_port_out))
2280         pkts.append(p)
2281         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2282              IP(src=server1.ip4, dst=self.nat_addr) /
2283              ICMP(id=self.icmp_id_out, type='echo-reply'))
2284         pkts.append(p)
2285         self.pg0.add_stream(pkts)
2286         self.pg_enable_capture(self.pg_interfaces)
2287         self.pg_start()
2288         capture = self.pg0.get_capture(len(pkts))
2289         for packet in capture:
2290             try:
2291                 self.assertEqual(packet[IP].src, server1_nat_ip)
2292                 self.assertEqual(packet[IP].dst, host.ip4)
2293                 if packet.haslayer(TCP):
2294                     self.assertEqual(packet[TCP].dport, self.tcp_port_in)
2295                     self.assertEqual(packet[TCP].sport, server_tcp_port)
2296                     self.assert_packet_checksums_valid(packet)
2297                 elif packet.haslayer(UDP):
2298                     self.assertEqual(packet[UDP].dport, self.udp_port_in)
2299                     self.assertEqual(packet[UDP].sport, server_udp_port)
2300                 else:
2301                     self.assertEqual(packet[ICMP].id, self.icmp_id_in)
2302             except:
2303                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
2304                 raise
2305
2306         # server2 to server1
2307         pkts = []
2308         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2309              IP(src=server2.ip4, dst=server1_nat_ip) /
2310              TCP(sport=self.tcp_port_in, dport=server_tcp_port))
2311         pkts.append(p)
2312         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2313              IP(src=server2.ip4, dst=server1_nat_ip) /
2314              UDP(sport=self.udp_port_in, dport=server_udp_port))
2315         pkts.append(p)
2316         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2317              IP(src=server2.ip4, dst=server1_nat_ip) /
2318              ICMP(id=self.icmp_id_in, type='echo-request'))
2319         pkts.append(p)
2320         self.pg0.add_stream(pkts)
2321         self.pg_enable_capture(self.pg_interfaces)
2322         self.pg_start()
2323         capture = self.pg0.get_capture(len(pkts))
2324         for packet in capture:
2325             try:
2326                 self.assertEqual(packet[IP].src, server2_nat_ip)
2327                 self.assertEqual(packet[IP].dst, server1.ip4)
2328                 if packet.haslayer(TCP):
2329                     self.assertEqual(packet[TCP].sport, self.tcp_port_in)
2330                     self.assertEqual(packet[TCP].dport, server_tcp_port)
2331                     self.tcp_port_out = packet[TCP].sport
2332                     self.assert_packet_checksums_valid(packet)
2333                 elif packet.haslayer(UDP):
2334                     self.assertEqual(packet[UDP].sport, self.udp_port_in)
2335                     self.assertEqual(packet[UDP].dport, server_udp_port)
2336                     self.udp_port_out = packet[UDP].sport
2337                 else:
2338                     self.assertEqual(packet[ICMP].id, self.icmp_id_in)
2339                     self.icmp_id_out = packet[ICMP].id
2340             except:
2341                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
2342                 raise
2343
2344         # server1 to server2
2345         pkts = []
2346         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2347              IP(src=server1.ip4, dst=server2_nat_ip) /
2348              TCP(sport=server_tcp_port, dport=self.tcp_port_out))
2349         pkts.append(p)
2350         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2351              IP(src=server1.ip4, dst=server2_nat_ip) /
2352              UDP(sport=server_udp_port, dport=self.udp_port_out))
2353         pkts.append(p)
2354         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2355              IP(src=server1.ip4, dst=server2_nat_ip) /
2356              ICMP(id=self.icmp_id_out, type='echo-reply'))
2357         pkts.append(p)
2358         self.pg0.add_stream(pkts)
2359         self.pg_enable_capture(self.pg_interfaces)
2360         self.pg_start()
2361         capture = self.pg0.get_capture(len(pkts))
2362         for packet in capture:
2363             try:
2364                 self.assertEqual(packet[IP].src, server1_nat_ip)
2365                 self.assertEqual(packet[IP].dst, server2.ip4)
2366                 if packet.haslayer(TCP):
2367                     self.assertEqual(packet[TCP].dport, self.tcp_port_in)
2368                     self.assertEqual(packet[TCP].sport, server_tcp_port)
2369                     self.assert_packet_checksums_valid(packet)
2370                 elif packet.haslayer(UDP):
2371                     self.assertEqual(packet[UDP].dport, self.udp_port_in)
2372                     self.assertEqual(packet[UDP].sport, server_udp_port)
2373                 else:
2374                     self.assertEqual(packet[ICMP].id, self.icmp_id_in)
2375             except:
2376                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
2377                 raise
2378
2379     def test_max_translations_per_user(self):
2380         """ MAX translations per user - recycle the least recently used """
2381
2382         self.nat44_add_address(self.nat_addr)
2383         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2384         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
2385                                                   is_inside=0)
2386
2387         # get maximum number of translations per user
2388         nat44_config = self.vapi.nat_show_config()
2389
2390         # send more than maximum number of translations per user packets
2391         pkts_num = nat44_config.max_translations_per_user + 5
2392         pkts = []
2393         for port in range(0, pkts_num):
2394             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2395                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2396                  TCP(sport=1025 + port))
2397             pkts.append(p)
2398         self.pg0.add_stream(pkts)
2399         self.pg_enable_capture(self.pg_interfaces)
2400         self.pg_start()
2401
2402         # verify number of translated packet
2403         self.pg1.get_capture(pkts_num)
2404
2405         users = self.vapi.nat44_user_dump()
2406         for user in users:
2407             if user.ip_address == self.pg0.remote_ip4n:
2408                 self.assertEqual(user.nsessions,
2409                                  nat44_config.max_translations_per_user)
2410                 self.assertEqual(user.nstaticsessions, 0)
2411
2412         tcp_port = 22
2413         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
2414                                       tcp_port, tcp_port,
2415                                       proto=IP_PROTOS.tcp)
2416         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2417              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2418              TCP(sport=tcp_port))
2419         self.pg0.add_stream(p)
2420         self.pg_enable_capture(self.pg_interfaces)
2421         self.pg_start()
2422         self.pg1.get_capture(1)
2423         users = self.vapi.nat44_user_dump()
2424         for user in users:
2425             if user.ip_address == self.pg0.remote_ip4n:
2426                 self.assertEqual(user.nsessions,
2427                                  nat44_config.max_translations_per_user - 1)
2428                 self.assertEqual(user.nstaticsessions, 1)
2429
2430     def test_interface_addr(self):
2431         """ Acquire NAT44 addresses from interface """
2432         self.vapi.nat44_add_interface_addr(self.pg7.sw_if_index)
2433
2434         # no address in NAT pool
2435         adresses = self.vapi.nat44_address_dump()
2436         self.assertEqual(0, len(adresses))
2437
2438         # configure interface address and check NAT address pool
2439         self.pg7.config_ip4()
2440         adresses = self.vapi.nat44_address_dump()
2441         self.assertEqual(1, len(adresses))
2442         self.assertEqual(adresses[0].ip_address[0:4], self.pg7.local_ip4n)
2443
2444         # remove interface address and check NAT address pool
2445         self.pg7.unconfig_ip4()
2446         adresses = self.vapi.nat44_address_dump()
2447         self.assertEqual(0, len(adresses))
2448
2449     def test_interface_addr_static_mapping(self):
2450         """ Static mapping with addresses from interface """
2451         tag = "testTAG"
2452
2453         self.vapi.nat44_add_interface_addr(self.pg7.sw_if_index)
2454         self.nat44_add_static_mapping(
2455             '1.2.3.4',
2456             external_sw_if_index=self.pg7.sw_if_index,
2457             tag=tag)
2458
2459         # static mappings with external interface
2460         static_mappings = self.vapi.nat44_static_mapping_dump()
2461         self.assertEqual(1, len(static_mappings))
2462         self.assertEqual(self.pg7.sw_if_index,
2463                          static_mappings[0].external_sw_if_index)
2464         self.assertEqual((static_mappings[0].tag).split('\0', 1)[0], tag)
2465
2466         # configure interface address and check static mappings
2467         self.pg7.config_ip4()
2468         static_mappings = self.vapi.nat44_static_mapping_dump()
2469         self.assertEqual(2, len(static_mappings))
2470         resolved = False
2471         for sm in static_mappings:
2472             if sm.external_sw_if_index == 0xFFFFFFFF:
2473                 self.assertEqual(sm.external_ip_address[0:4],
2474                                  self.pg7.local_ip4n)
2475                 self.assertEqual((sm.tag).split('\0', 1)[0], tag)
2476                 resolved = True
2477         self.assertTrue(resolved)
2478
2479         # remove interface address and check static mappings
2480         self.pg7.unconfig_ip4()
2481         static_mappings = self.vapi.nat44_static_mapping_dump()
2482         self.assertEqual(1, len(static_mappings))
2483         self.assertEqual(self.pg7.sw_if_index,
2484                          static_mappings[0].external_sw_if_index)
2485         self.assertEqual((static_mappings[0].tag).split('\0', 1)[0], tag)
2486
2487         # configure interface address again and check static mappings
2488         self.pg7.config_ip4()
2489         static_mappings = self.vapi.nat44_static_mapping_dump()
2490         self.assertEqual(2, len(static_mappings))
2491         resolved = False
2492         for sm in static_mappings:
2493             if sm.external_sw_if_index == 0xFFFFFFFF:
2494                 self.assertEqual(sm.external_ip_address[0:4],
2495                                  self.pg7.local_ip4n)
2496                 self.assertEqual((sm.tag).split('\0', 1)[0], tag)
2497                 resolved = True
2498         self.assertTrue(resolved)
2499
2500         # remove static mapping
2501         self.nat44_add_static_mapping(
2502             '1.2.3.4',
2503             external_sw_if_index=self.pg7.sw_if_index,
2504             tag=tag,
2505             is_add=0)
2506         static_mappings = self.vapi.nat44_static_mapping_dump()
2507         self.assertEqual(0, len(static_mappings))
2508
2509     def test_interface_addr_identity_nat(self):
2510         """ Identity NAT with addresses from interface """
2511
2512         port = 53053
2513         self.vapi.nat44_add_interface_addr(self.pg7.sw_if_index)
2514         self.vapi.nat44_add_del_identity_mapping(
2515             sw_if_index=self.pg7.sw_if_index,
2516             port=port,
2517             protocol=IP_PROTOS.tcp,
2518             addr_only=0)
2519
2520         # identity mappings with external interface
2521         identity_mappings = self.vapi.nat44_identity_mapping_dump()
2522         self.assertEqual(1, len(identity_mappings))
2523         self.assertEqual(self.pg7.sw_if_index,
2524                          identity_mappings[0].sw_if_index)
2525
2526         # configure interface address and check identity mappings
2527         self.pg7.config_ip4()
2528         identity_mappings = self.vapi.nat44_identity_mapping_dump()
2529         resolved = False
2530         self.assertEqual(2, len(identity_mappings))
2531         for sm in identity_mappings:
2532             if sm.sw_if_index == 0xFFFFFFFF:
2533                 self.assertEqual(identity_mappings[0].ip_address,
2534                                  self.pg7.local_ip4n)
2535                 self.assertEqual(port, identity_mappings[0].port)
2536                 self.assertEqual(IP_PROTOS.tcp, identity_mappings[0].protocol)
2537                 resolved = True
2538         self.assertTrue(resolved)
2539
2540         # remove interface address and check identity mappings
2541         self.pg7.unconfig_ip4()
2542         identity_mappings = self.vapi.nat44_identity_mapping_dump()
2543         self.assertEqual(1, len(identity_mappings))
2544         self.assertEqual(self.pg7.sw_if_index,
2545                          identity_mappings[0].sw_if_index)
2546
2547     def test_ipfix_nat44_sess(self):
2548         """ IPFIX logging NAT44 session created/delted """
2549         self.ipfix_domain_id = 10
2550         self.ipfix_src_port = 20202
2551         colector_port = 30303
2552         bind_layers(UDP, IPFIX, dport=30303)
2553         self.nat44_add_address(self.nat_addr)
2554         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2555         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
2556                                                   is_inside=0)
2557         self.vapi.set_ipfix_exporter(collector_address=self.pg3.remote_ip4n,
2558                                      src_address=self.pg3.local_ip4n,
2559                                      path_mtu=512,
2560                                      template_interval=10,
2561                                      collector_port=colector_port)
2562         self.vapi.nat_ipfix(domain_id=self.ipfix_domain_id,
2563                             src_port=self.ipfix_src_port)
2564
2565         pkts = self.create_stream_in(self.pg0, self.pg1)
2566         self.pg0.add_stream(pkts)
2567         self.pg_enable_capture(self.pg_interfaces)
2568         self.pg_start()
2569         capture = self.pg1.get_capture(len(pkts))
2570         self.verify_capture_out(capture)
2571         self.nat44_add_address(self.nat_addr, is_add=0)
2572         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
2573         capture = self.pg3.get_capture(9)
2574         ipfix = IPFIXDecoder()
2575         # first load template
2576         for p in capture:
2577             self.assertTrue(p.haslayer(IPFIX))
2578             self.assertEqual(p[IP].src, self.pg3.local_ip4)
2579             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
2580             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
2581             self.assertEqual(p[UDP].dport, colector_port)
2582             self.assertEqual(p[IPFIX].observationDomainID,
2583                              self.ipfix_domain_id)
2584             if p.haslayer(Template):
2585                 ipfix.add_template(p.getlayer(Template))
2586         # verify events in data set
2587         for p in capture:
2588             if p.haslayer(Data):
2589                 data = ipfix.decode_data_set(p.getlayer(Set))
2590                 self.verify_ipfix_nat44_ses(data)
2591
2592     def test_ipfix_addr_exhausted(self):
2593         """ IPFIX logging NAT addresses exhausted """
2594         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2595         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
2596                                                   is_inside=0)
2597         self.vapi.set_ipfix_exporter(collector_address=self.pg3.remote_ip4n,
2598                                      src_address=self.pg3.local_ip4n,
2599                                      path_mtu=512,
2600                                      template_interval=10)
2601         self.vapi.nat_ipfix(domain_id=self.ipfix_domain_id,
2602                             src_port=self.ipfix_src_port)
2603
2604         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
2605              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2606              TCP(sport=3025))
2607         self.pg0.add_stream(p)
2608         self.pg_enable_capture(self.pg_interfaces)
2609         self.pg_start()
2610         self.pg1.assert_nothing_captured()
2611         sleep(1)
2612         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
2613         capture = self.pg3.get_capture(9)
2614         ipfix = IPFIXDecoder()
2615         # first load template
2616         for p in capture:
2617             self.assertTrue(p.haslayer(IPFIX))
2618             self.assertEqual(p[IP].src, self.pg3.local_ip4)
2619             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
2620             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
2621             self.assertEqual(p[UDP].dport, 4739)
2622             self.assertEqual(p[IPFIX].observationDomainID,
2623                              self.ipfix_domain_id)
2624             if p.haslayer(Template):
2625                 ipfix.add_template(p.getlayer(Template))
2626         # verify events in data set
2627         for p in capture:
2628             if p.haslayer(Data):
2629                 data = ipfix.decode_data_set(p.getlayer(Set))
2630                 self.verify_ipfix_addr_exhausted(data)
2631
2632     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
2633     def test_ipfix_max_sessions(self):
2634         """ IPFIX logging maximum session entries exceeded """
2635         self.nat44_add_address(self.nat_addr)
2636         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2637         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
2638                                                   is_inside=0)
2639
2640         nat44_config = self.vapi.nat_show_config()
2641         max_sessions = 10 * nat44_config.translation_buckets
2642
2643         pkts = []
2644         for i in range(0, max_sessions):
2645             src = "10.10.%u.%u" % ((i & 0xFF00) >> 8, i & 0xFF)
2646             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2647                  IP(src=src, dst=self.pg1.remote_ip4) /
2648                  TCP(sport=1025))
2649             pkts.append(p)
2650         self.pg0.add_stream(pkts)
2651         self.pg_enable_capture(self.pg_interfaces)
2652         self.pg_start()
2653
2654         self.pg1.get_capture(max_sessions)
2655         self.vapi.set_ipfix_exporter(collector_address=self.pg3.remote_ip4n,
2656                                      src_address=self.pg3.local_ip4n,
2657                                      path_mtu=512,
2658                                      template_interval=10)
2659         self.vapi.nat_ipfix(domain_id=self.ipfix_domain_id,
2660                             src_port=self.ipfix_src_port)
2661
2662         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2663              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2664              TCP(sport=1025))
2665         self.pg0.add_stream(p)
2666         self.pg_enable_capture(self.pg_interfaces)
2667         self.pg_start()
2668         self.pg1.assert_nothing_captured()
2669         sleep(1)
2670         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
2671         capture = self.pg3.get_capture(9)
2672         ipfix = IPFIXDecoder()
2673         # first load template
2674         for p in capture:
2675             self.assertTrue(p.haslayer(IPFIX))
2676             self.assertEqual(p[IP].src, self.pg3.local_ip4)
2677             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
2678             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
2679             self.assertEqual(p[UDP].dport, 4739)
2680             self.assertEqual(p[IPFIX].observationDomainID,
2681                              self.ipfix_domain_id)
2682             if p.haslayer(Template):
2683                 ipfix.add_template(p.getlayer(Template))
2684         # verify events in data set
2685         for p in capture:
2686             if p.haslayer(Data):
2687                 data = ipfix.decode_data_set(p.getlayer(Set))
2688                 self.verify_ipfix_max_sessions(data, max_sessions)
2689
2690     def test_pool_addr_fib(self):
2691         """ NAT44 add pool addresses to FIB """
2692         static_addr = '10.0.0.10'
2693         self.nat44_add_address(self.nat_addr)
2694         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2695         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
2696                                                   is_inside=0)
2697         self.nat44_add_static_mapping(self.pg0.remote_ip4, static_addr)
2698
2699         # NAT44 address
2700         p = (Ether(src=self.pg1.remote_mac, dst='ff:ff:ff:ff:ff:ff') /
2701              ARP(op=ARP.who_has, pdst=self.nat_addr,
2702                  psrc=self.pg1.remote_ip4, hwsrc=self.pg1.remote_mac))
2703         self.pg1.add_stream(p)
2704         self.pg_enable_capture(self.pg_interfaces)
2705         self.pg_start()
2706         capture = self.pg1.get_capture(1)
2707         self.assertTrue(capture[0].haslayer(ARP))
2708         self.assertTrue(capture[0][ARP].op, ARP.is_at)
2709
2710         # 1:1 NAT address
2711         p = (Ether(src=self.pg1.remote_mac, dst='ff:ff:ff:ff:ff:ff') /
2712              ARP(op=ARP.who_has, pdst=static_addr,
2713                  psrc=self.pg1.remote_ip4, hwsrc=self.pg1.remote_mac))
2714         self.pg1.add_stream(p)
2715         self.pg_enable_capture(self.pg_interfaces)
2716         self.pg_start()
2717         capture = self.pg1.get_capture(1)
2718         self.assertTrue(capture[0].haslayer(ARP))
2719         self.assertTrue(capture[0][ARP].op, ARP.is_at)
2720
2721         # send ARP to non-NAT44 interface
2722         p = (Ether(src=self.pg2.remote_mac, dst='ff:ff:ff:ff:ff:ff') /
2723              ARP(op=ARP.who_has, pdst=self.nat_addr,
2724                  psrc=self.pg2.remote_ip4, hwsrc=self.pg2.remote_mac))
2725         self.pg2.add_stream(p)
2726         self.pg_enable_capture(self.pg_interfaces)
2727         self.pg_start()
2728         self.pg1.assert_nothing_captured()
2729
2730         # remove addresses and verify
2731         self.nat44_add_address(self.nat_addr, is_add=0)
2732         self.nat44_add_static_mapping(self.pg0.remote_ip4, static_addr,
2733                                       is_add=0)
2734
2735         p = (Ether(src=self.pg1.remote_mac, dst='ff:ff:ff:ff:ff:ff') /
2736              ARP(op=ARP.who_has, pdst=self.nat_addr,
2737                  psrc=self.pg1.remote_ip4, hwsrc=self.pg1.remote_mac))
2738         self.pg1.add_stream(p)
2739         self.pg_enable_capture(self.pg_interfaces)
2740         self.pg_start()
2741         self.pg1.assert_nothing_captured()
2742
2743         p = (Ether(src=self.pg1.remote_mac, dst='ff:ff:ff:ff:ff:ff') /
2744              ARP(op=ARP.who_has, pdst=static_addr,
2745                  psrc=self.pg1.remote_ip4, hwsrc=self.pg1.remote_mac))
2746         self.pg1.add_stream(p)
2747         self.pg_enable_capture(self.pg_interfaces)
2748         self.pg_start()
2749         self.pg1.assert_nothing_captured()
2750
2751     def test_vrf_mode(self):
2752         """ NAT44 tenant VRF aware address pool mode """
2753
2754         vrf_id1 = 1
2755         vrf_id2 = 2
2756         nat_ip1 = "10.0.0.10"
2757         nat_ip2 = "10.0.0.11"
2758
2759         self.pg0.unconfig_ip4()
2760         self.pg1.unconfig_ip4()
2761         self.vapi.ip_table_add_del(vrf_id1, is_add=1)
2762         self.vapi.ip_table_add_del(vrf_id2, is_add=1)
2763         self.pg0.set_table_ip4(vrf_id1)
2764         self.pg1.set_table_ip4(vrf_id2)
2765         self.pg0.config_ip4()
2766         self.pg1.config_ip4()
2767         self.pg0.resolve_arp()
2768         self.pg1.resolve_arp()
2769
2770         self.nat44_add_address(nat_ip1, vrf_id=vrf_id1)
2771         self.nat44_add_address(nat_ip2, vrf_id=vrf_id2)
2772         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2773         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index)
2774         self.vapi.nat44_interface_add_del_feature(self.pg2.sw_if_index,
2775                                                   is_inside=0)
2776
2777         try:
2778             # first VRF
2779             pkts = self.create_stream_in(self.pg0, self.pg2)
2780             self.pg0.add_stream(pkts)
2781             self.pg_enable_capture(self.pg_interfaces)
2782             self.pg_start()
2783             capture = self.pg2.get_capture(len(pkts))
2784             self.verify_capture_out(capture, nat_ip1)
2785
2786             # second VRF
2787             pkts = self.create_stream_in(self.pg1, self.pg2)
2788             self.pg1.add_stream(pkts)
2789             self.pg_enable_capture(self.pg_interfaces)
2790             self.pg_start()
2791             capture = self.pg2.get_capture(len(pkts))
2792             self.verify_capture_out(capture, nat_ip2)
2793
2794         finally:
2795             self.pg0.unconfig_ip4()
2796             self.pg1.unconfig_ip4()
2797             self.pg0.set_table_ip4(0)
2798             self.pg1.set_table_ip4(0)
2799             self.pg0.config_ip4()
2800             self.pg1.config_ip4()
2801             self.pg0.resolve_arp()
2802             self.pg1.resolve_arp()
2803             self.vapi.ip_table_add_del(vrf_id1, is_add=0)
2804             self.vapi.ip_table_add_del(vrf_id2, is_add=0)
2805
2806     def test_vrf_feature_independent(self):
2807         """ NAT44 tenant VRF independent address pool mode """
2808
2809         nat_ip1 = "10.0.0.10"
2810         nat_ip2 = "10.0.0.11"
2811
2812         self.nat44_add_address(nat_ip1)
2813         self.nat44_add_address(nat_ip2, vrf_id=99)
2814         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2815         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index)
2816         self.vapi.nat44_interface_add_del_feature(self.pg2.sw_if_index,
2817                                                   is_inside=0)
2818
2819         # first VRF
2820         pkts = self.create_stream_in(self.pg0, self.pg2)
2821         self.pg0.add_stream(pkts)
2822         self.pg_enable_capture(self.pg_interfaces)
2823         self.pg_start()
2824         capture = self.pg2.get_capture(len(pkts))
2825         self.verify_capture_out(capture, nat_ip1)
2826
2827         # second VRF
2828         pkts = self.create_stream_in(self.pg1, self.pg2)
2829         self.pg1.add_stream(pkts)
2830         self.pg_enable_capture(self.pg_interfaces)
2831         self.pg_start()
2832         capture = self.pg2.get_capture(len(pkts))
2833         self.verify_capture_out(capture, nat_ip1)
2834
2835     def test_dynamic_ipless_interfaces(self):
2836         """ NAT44 interfaces without configured IP address """
2837
2838         self.vapi.ip_neighbor_add_del(self.pg7.sw_if_index,
2839                                       mactobinary(self.pg7.remote_mac),
2840                                       self.pg7.remote_ip4n,
2841                                       is_static=1)
2842         self.vapi.ip_neighbor_add_del(self.pg8.sw_if_index,
2843                                       mactobinary(self.pg8.remote_mac),
2844                                       self.pg8.remote_ip4n,
2845                                       is_static=1)
2846
2847         self.vapi.ip_add_del_route(dst_address=self.pg7.remote_ip4n,
2848                                    dst_address_length=32,
2849                                    next_hop_address=self.pg7.remote_ip4n,
2850                                    next_hop_sw_if_index=self.pg7.sw_if_index)
2851         self.vapi.ip_add_del_route(dst_address=self.pg8.remote_ip4n,
2852                                    dst_address_length=32,
2853                                    next_hop_address=self.pg8.remote_ip4n,
2854                                    next_hop_sw_if_index=self.pg8.sw_if_index)
2855
2856         self.nat44_add_address(self.nat_addr)
2857         self.vapi.nat44_interface_add_del_feature(self.pg7.sw_if_index)
2858         self.vapi.nat44_interface_add_del_feature(self.pg8.sw_if_index,
2859                                                   is_inside=0)
2860
2861         # in2out
2862         pkts = self.create_stream_in(self.pg7, self.pg8)
2863         self.pg7.add_stream(pkts)
2864         self.pg_enable_capture(self.pg_interfaces)
2865         self.pg_start()
2866         capture = self.pg8.get_capture(len(pkts))
2867         self.verify_capture_out(capture)
2868
2869         # out2in
2870         pkts = self.create_stream_out(self.pg8, self.nat_addr)
2871         self.pg8.add_stream(pkts)
2872         self.pg_enable_capture(self.pg_interfaces)
2873         self.pg_start()
2874         capture = self.pg7.get_capture(len(pkts))
2875         self.verify_capture_in(capture, self.pg7)
2876
2877     def test_static_ipless_interfaces(self):
2878         """ NAT44 interfaces without configured IP address - 1:1 NAT """
2879
2880         self.vapi.ip_neighbor_add_del(self.pg7.sw_if_index,
2881                                       mactobinary(self.pg7.remote_mac),
2882                                       self.pg7.remote_ip4n,
2883                                       is_static=1)
2884         self.vapi.ip_neighbor_add_del(self.pg8.sw_if_index,
2885                                       mactobinary(self.pg8.remote_mac),
2886                                       self.pg8.remote_ip4n,
2887                                       is_static=1)
2888
2889         self.vapi.ip_add_del_route(dst_address=self.pg7.remote_ip4n,
2890                                    dst_address_length=32,
2891                                    next_hop_address=self.pg7.remote_ip4n,
2892                                    next_hop_sw_if_index=self.pg7.sw_if_index)
2893         self.vapi.ip_add_del_route(dst_address=self.pg8.remote_ip4n,
2894                                    dst_address_length=32,
2895                                    next_hop_address=self.pg8.remote_ip4n,
2896                                    next_hop_sw_if_index=self.pg8.sw_if_index)
2897
2898         self.nat44_add_static_mapping(self.pg7.remote_ip4, self.nat_addr)
2899         self.vapi.nat44_interface_add_del_feature(self.pg7.sw_if_index)
2900         self.vapi.nat44_interface_add_del_feature(self.pg8.sw_if_index,
2901                                                   is_inside=0)
2902
2903         # out2in
2904         pkts = self.create_stream_out(self.pg8)
2905         self.pg8.add_stream(pkts)
2906         self.pg_enable_capture(self.pg_interfaces)
2907         self.pg_start()
2908         capture = self.pg7.get_capture(len(pkts))
2909         self.verify_capture_in(capture, self.pg7)
2910
2911         # in2out
2912         pkts = self.create_stream_in(self.pg7, self.pg8)
2913         self.pg7.add_stream(pkts)
2914         self.pg_enable_capture(self.pg_interfaces)
2915         self.pg_start()
2916         capture = self.pg8.get_capture(len(pkts))
2917         self.verify_capture_out(capture, self.nat_addr, True)
2918
2919     def test_static_with_port_ipless_interfaces(self):
2920         """ NAT44 interfaces without configured IP address - 1:1 NAPT """
2921
2922         self.tcp_port_out = 30606
2923         self.udp_port_out = 30607
2924         self.icmp_id_out = 30608
2925
2926         self.vapi.ip_neighbor_add_del(self.pg7.sw_if_index,
2927                                       mactobinary(self.pg7.remote_mac),
2928                                       self.pg7.remote_ip4n,
2929                                       is_static=1)
2930         self.vapi.ip_neighbor_add_del(self.pg8.sw_if_index,
2931                                       mactobinary(self.pg8.remote_mac),
2932                                       self.pg8.remote_ip4n,
2933                                       is_static=1)
2934
2935         self.vapi.ip_add_del_route(dst_address=self.pg7.remote_ip4n,
2936                                    dst_address_length=32,
2937                                    next_hop_address=self.pg7.remote_ip4n,
2938                                    next_hop_sw_if_index=self.pg7.sw_if_index)
2939         self.vapi.ip_add_del_route(dst_address=self.pg8.remote_ip4n,
2940                                    dst_address_length=32,
2941                                    next_hop_address=self.pg8.remote_ip4n,
2942                                    next_hop_sw_if_index=self.pg8.sw_if_index)
2943
2944         self.nat44_add_address(self.nat_addr)
2945         self.nat44_add_static_mapping(self.pg7.remote_ip4, self.nat_addr,
2946                                       self.tcp_port_in, self.tcp_port_out,
2947                                       proto=IP_PROTOS.tcp)
2948         self.nat44_add_static_mapping(self.pg7.remote_ip4, self.nat_addr,
2949                                       self.udp_port_in, self.udp_port_out,
2950                                       proto=IP_PROTOS.udp)
2951         self.nat44_add_static_mapping(self.pg7.remote_ip4, self.nat_addr,
2952                                       self.icmp_id_in, self.icmp_id_out,
2953                                       proto=IP_PROTOS.icmp)
2954         self.vapi.nat44_interface_add_del_feature(self.pg7.sw_if_index)
2955         self.vapi.nat44_interface_add_del_feature(self.pg8.sw_if_index,
2956                                                   is_inside=0)
2957
2958         # out2in
2959         pkts = self.create_stream_out(self.pg8)
2960         self.pg8.add_stream(pkts)
2961         self.pg_enable_capture(self.pg_interfaces)
2962         self.pg_start()
2963         capture = self.pg7.get_capture(len(pkts))
2964         self.verify_capture_in(capture, self.pg7)
2965
2966         # in2out
2967         pkts = self.create_stream_in(self.pg7, self.pg8)
2968         self.pg7.add_stream(pkts)
2969         self.pg_enable_capture(self.pg_interfaces)
2970         self.pg_start()
2971         capture = self.pg8.get_capture(len(pkts))
2972         self.verify_capture_out(capture)
2973
2974     def test_static_unknown_proto(self):
2975         """ 1:1 NAT translate packet with unknown protocol """
2976         nat_ip = "10.0.0.10"
2977         self.nat44_add_static_mapping(self.pg0.remote_ip4, nat_ip)
2978         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
2979         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
2980                                                   is_inside=0)
2981
2982         # in2out
2983         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
2984              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
2985              GRE() /
2986              IP(src=self.pg2.remote_ip4, dst=self.pg3.remote_ip4) /
2987              TCP(sport=1234, dport=1234))
2988         self.pg0.add_stream(p)
2989         self.pg_enable_capture(self.pg_interfaces)
2990         self.pg_start()
2991         p = self.pg1.get_capture(1)
2992         packet = p[0]
2993         try:
2994             self.assertEqual(packet[IP].src, nat_ip)
2995             self.assertEqual(packet[IP].dst, self.pg1.remote_ip4)
2996             self.assertTrue(packet.haslayer(GRE))
2997             self.assert_packet_checksums_valid(packet)
2998         except:
2999             self.logger.error(ppp("Unexpected or invalid packet:", packet))
3000             raise
3001
3002         # out2in
3003         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
3004              IP(src=self.pg1.remote_ip4, dst=nat_ip) /
3005              GRE() /
3006              IP(src=self.pg3.remote_ip4, dst=self.pg2.remote_ip4) /
3007              TCP(sport=1234, dport=1234))
3008         self.pg1.add_stream(p)
3009         self.pg_enable_capture(self.pg_interfaces)
3010         self.pg_start()
3011         p = self.pg0.get_capture(1)
3012         packet = p[0]
3013         try:
3014             self.assertEqual(packet[IP].src, self.pg1.remote_ip4)
3015             self.assertEqual(packet[IP].dst, self.pg0.remote_ip4)
3016             self.assertTrue(packet.haslayer(GRE))
3017             self.assert_packet_checksums_valid(packet)
3018         except:
3019             self.logger.error(ppp("Unexpected or invalid packet:", packet))
3020             raise
3021
3022     def test_hairpinning_static_unknown_proto(self):
3023         """ 1:1 NAT translate packet with unknown protocol - hairpinning """
3024
3025         host = self.pg0.remote_hosts[0]
3026         server = self.pg0.remote_hosts[1]
3027
3028         host_nat_ip = "10.0.0.10"
3029         server_nat_ip = "10.0.0.11"
3030
3031         self.nat44_add_static_mapping(host.ip4, host_nat_ip)
3032         self.nat44_add_static_mapping(server.ip4, server_nat_ip)
3033         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3034         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3035                                                   is_inside=0)
3036
3037         # host to server
3038         p = (Ether(dst=self.pg0.local_mac, src=host.mac) /
3039              IP(src=host.ip4, dst=server_nat_ip) /
3040              GRE() /
3041              IP(src=self.pg2.remote_ip4, dst=self.pg3.remote_ip4) /
3042              TCP(sport=1234, dport=1234))
3043         self.pg0.add_stream(p)
3044         self.pg_enable_capture(self.pg_interfaces)
3045         self.pg_start()
3046         p = self.pg0.get_capture(1)
3047         packet = p[0]
3048         try:
3049             self.assertEqual(packet[IP].src, host_nat_ip)
3050             self.assertEqual(packet[IP].dst, server.ip4)
3051             self.assertTrue(packet.haslayer(GRE))
3052             self.assert_packet_checksums_valid(packet)
3053         except:
3054             self.logger.error(ppp("Unexpected or invalid packet:", packet))
3055             raise
3056
3057         # server to host
3058         p = (Ether(dst=self.pg0.local_mac, src=server.mac) /
3059              IP(src=server.ip4, dst=host_nat_ip) /
3060              GRE() /
3061              IP(src=self.pg3.remote_ip4, dst=self.pg2.remote_ip4) /
3062              TCP(sport=1234, dport=1234))
3063         self.pg0.add_stream(p)
3064         self.pg_enable_capture(self.pg_interfaces)
3065         self.pg_start()
3066         p = self.pg0.get_capture(1)
3067         packet = p[0]
3068         try:
3069             self.assertEqual(packet[IP].src, server_nat_ip)
3070             self.assertEqual(packet[IP].dst, host.ip4)
3071             self.assertTrue(packet.haslayer(GRE))
3072             self.assert_packet_checksums_valid(packet)
3073         except:
3074             self.logger.error(ppp("Unexpected or invalid packet:", packet))
3075             raise
3076
3077     def test_output_feature(self):
3078         """ NAT44 interface output feature (in2out postrouting) """
3079         self.nat44_add_address(self.nat_addr)
3080         self.vapi.nat44_interface_add_del_output_feature(self.pg0.sw_if_index)
3081         self.vapi.nat44_interface_add_del_output_feature(self.pg1.sw_if_index)
3082         self.vapi.nat44_interface_add_del_output_feature(self.pg3.sw_if_index,
3083                                                          is_inside=0)
3084
3085         # in2out
3086         pkts = self.create_stream_in(self.pg0, self.pg3)
3087         self.pg0.add_stream(pkts)
3088         self.pg_enable_capture(self.pg_interfaces)
3089         self.pg_start()
3090         capture = self.pg3.get_capture(len(pkts))
3091         self.verify_capture_out(capture)
3092
3093         # out2in
3094         pkts = self.create_stream_out(self.pg3)
3095         self.pg3.add_stream(pkts)
3096         self.pg_enable_capture(self.pg_interfaces)
3097         self.pg_start()
3098         capture = self.pg0.get_capture(len(pkts))
3099         self.verify_capture_in(capture, self.pg0)
3100
3101         # from non-NAT interface to NAT inside interface
3102         pkts = self.create_stream_in(self.pg2, self.pg0)
3103         self.pg2.add_stream(pkts)
3104         self.pg_enable_capture(self.pg_interfaces)
3105         self.pg_start()
3106         capture = self.pg0.get_capture(len(pkts))
3107         self.verify_capture_no_translation(capture, self.pg2, self.pg0)
3108
3109     def test_output_feature_vrf_aware(self):
3110         """ NAT44 interface output feature VRF aware (in2out postrouting) """
3111         nat_ip_vrf10 = "10.0.0.10"
3112         nat_ip_vrf20 = "10.0.0.20"
3113
3114         self.vapi.ip_add_del_route(dst_address=self.pg3.remote_ip4n,
3115                                    dst_address_length=32,
3116                                    next_hop_address=self.pg3.remote_ip4n,
3117                                    next_hop_sw_if_index=self.pg3.sw_if_index,
3118                                    table_id=10)
3119         self.vapi.ip_add_del_route(dst_address=self.pg3.remote_ip4n,
3120                                    dst_address_length=32,
3121                                    next_hop_address=self.pg3.remote_ip4n,
3122                                    next_hop_sw_if_index=self.pg3.sw_if_index,
3123                                    table_id=20)
3124
3125         self.nat44_add_address(nat_ip_vrf10, vrf_id=10)
3126         self.nat44_add_address(nat_ip_vrf20, vrf_id=20)
3127         self.vapi.nat44_interface_add_del_output_feature(self.pg4.sw_if_index)
3128         self.vapi.nat44_interface_add_del_output_feature(self.pg6.sw_if_index)
3129         self.vapi.nat44_interface_add_del_output_feature(self.pg3.sw_if_index,
3130                                                          is_inside=0)
3131
3132         # in2out VRF 10
3133         pkts = self.create_stream_in(self.pg4, self.pg3)
3134         self.pg4.add_stream(pkts)
3135         self.pg_enable_capture(self.pg_interfaces)
3136         self.pg_start()
3137         capture = self.pg3.get_capture(len(pkts))
3138         self.verify_capture_out(capture, nat_ip=nat_ip_vrf10)
3139
3140         # out2in VRF 10
3141         pkts = self.create_stream_out(self.pg3, dst_ip=nat_ip_vrf10)
3142         self.pg3.add_stream(pkts)
3143         self.pg_enable_capture(self.pg_interfaces)
3144         self.pg_start()
3145         capture = self.pg4.get_capture(len(pkts))
3146         self.verify_capture_in(capture, self.pg4)
3147
3148         # in2out VRF 20
3149         pkts = self.create_stream_in(self.pg6, self.pg3)
3150         self.pg6.add_stream(pkts)
3151         self.pg_enable_capture(self.pg_interfaces)
3152         self.pg_start()
3153         capture = self.pg3.get_capture(len(pkts))
3154         self.verify_capture_out(capture, nat_ip=nat_ip_vrf20)
3155
3156         # out2in VRF 20
3157         pkts = self.create_stream_out(self.pg3, dst_ip=nat_ip_vrf20)
3158         self.pg3.add_stream(pkts)
3159         self.pg_enable_capture(self.pg_interfaces)
3160         self.pg_start()
3161         capture = self.pg6.get_capture(len(pkts))
3162         self.verify_capture_in(capture, self.pg6)
3163
3164     def test_output_feature_hairpinning(self):
3165         """ NAT44 interface output feature hairpinning (in2out postrouting) """
3166         host = self.pg0.remote_hosts[0]
3167         server = self.pg0.remote_hosts[1]
3168         host_in_port = 1234
3169         host_out_port = 0
3170         server_in_port = 5678
3171         server_out_port = 8765
3172
3173         self.nat44_add_address(self.nat_addr)
3174         self.vapi.nat44_interface_add_del_output_feature(self.pg0.sw_if_index)
3175         self.vapi.nat44_interface_add_del_output_feature(self.pg1.sw_if_index,
3176                                                          is_inside=0)
3177
3178         # add static mapping for server
3179         self.nat44_add_static_mapping(server.ip4, self.nat_addr,
3180                                       server_in_port, server_out_port,
3181                                       proto=IP_PROTOS.tcp)
3182
3183         # send packet from host to server
3184         p = (Ether(src=host.mac, dst=self.pg0.local_mac) /
3185              IP(src=host.ip4, dst=self.nat_addr) /
3186              TCP(sport=host_in_port, dport=server_out_port))
3187         self.pg0.add_stream(p)
3188         self.pg_enable_capture(self.pg_interfaces)
3189         self.pg_start()
3190         capture = self.pg0.get_capture(1)
3191         p = capture[0]
3192         try:
3193             ip = p[IP]
3194             tcp = p[TCP]
3195             self.assertEqual(ip.src, self.nat_addr)
3196             self.assertEqual(ip.dst, server.ip4)
3197             self.assertNotEqual(tcp.sport, host_in_port)
3198             self.assertEqual(tcp.dport, server_in_port)
3199             self.assert_packet_checksums_valid(p)
3200             host_out_port = tcp.sport
3201         except:
3202             self.logger.error(ppp("Unexpected or invalid packet:", p))
3203             raise
3204
3205         # send reply from server to host
3206         p = (Ether(src=server.mac, dst=self.pg0.local_mac) /
3207              IP(src=server.ip4, dst=self.nat_addr) /
3208              TCP(sport=server_in_port, dport=host_out_port))
3209         self.pg0.add_stream(p)
3210         self.pg_enable_capture(self.pg_interfaces)
3211         self.pg_start()
3212         capture = self.pg0.get_capture(1)
3213         p = capture[0]
3214         try:
3215             ip = p[IP]
3216             tcp = p[TCP]
3217             self.assertEqual(ip.src, self.nat_addr)
3218             self.assertEqual(ip.dst, host.ip4)
3219             self.assertEqual(tcp.sport, server_out_port)
3220             self.assertEqual(tcp.dport, host_in_port)
3221             self.assert_packet_checksums_valid(p)
3222         except:
3223             self.logger.error(ppp("Unexpected or invalid packet:", p))
3224             raise
3225
3226     def test_one_armed_nat44(self):
3227         """ One armed NAT44 """
3228         remote_host = self.pg9.remote_hosts[0]
3229         local_host = self.pg9.remote_hosts[1]
3230         external_port = 0
3231
3232         self.nat44_add_address(self.nat_addr)
3233         self.vapi.nat44_interface_add_del_feature(self.pg9.sw_if_index)
3234         self.vapi.nat44_interface_add_del_feature(self.pg9.sw_if_index,
3235                                                   is_inside=0)
3236
3237         # in2out
3238         p = (Ether(src=self.pg9.remote_mac, dst=self.pg9.local_mac) /
3239              IP(src=local_host.ip4, dst=remote_host.ip4) /
3240              TCP(sport=12345, dport=80))
3241         self.pg9.add_stream(p)
3242         self.pg_enable_capture(self.pg_interfaces)
3243         self.pg_start()
3244         capture = self.pg9.get_capture(1)
3245         p = capture[0]
3246         try:
3247             ip = p[IP]
3248             tcp = p[TCP]
3249             self.assertEqual(ip.src, self.nat_addr)
3250             self.assertEqual(ip.dst, remote_host.ip4)
3251             self.assertNotEqual(tcp.sport, 12345)
3252             external_port = tcp.sport
3253             self.assertEqual(tcp.dport, 80)
3254             self.assert_packet_checksums_valid(p)
3255         except:
3256             self.logger.error(ppp("Unexpected or invalid packet:", p))
3257             raise
3258
3259         # out2in
3260         p = (Ether(src=self.pg9.remote_mac, dst=self.pg9.local_mac) /
3261              IP(src=remote_host.ip4, dst=self.nat_addr) /
3262              TCP(sport=80, dport=external_port))
3263         self.pg9.add_stream(p)
3264         self.pg_enable_capture(self.pg_interfaces)
3265         self.pg_start()
3266         capture = self.pg9.get_capture(1)
3267         p = capture[0]
3268         try:
3269             ip = p[IP]
3270             tcp = p[TCP]
3271             self.assertEqual(ip.src, remote_host.ip4)
3272             self.assertEqual(ip.dst, local_host.ip4)
3273             self.assertEqual(tcp.sport, 80)
3274             self.assertEqual(tcp.dport, 12345)
3275             self.assert_packet_checksums_valid(p)
3276         except:
3277             self.logger.error(ppp("Unexpected or invalid packet:", p))
3278             raise
3279
3280     def test_del_session(self):
3281         """ Delete NAT44 session """
3282         self.nat44_add_address(self.nat_addr)
3283         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3284         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3285                                                   is_inside=0)
3286
3287         pkts = self.create_stream_in(self.pg0, self.pg1)
3288         self.pg0.add_stream(pkts)
3289         self.pg_enable_capture(self.pg_interfaces)
3290         self.pg_start()
3291         self.pg1.get_capture(len(pkts))
3292
3293         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n, 0)
3294         nsessions = len(sessions)
3295
3296         self.vapi.nat44_del_session(sessions[0].inside_ip_address,
3297                                     sessions[0].inside_port,
3298                                     sessions[0].protocol)
3299         self.vapi.nat44_del_session(sessions[1].outside_ip_address,
3300                                     sessions[1].outside_port,
3301                                     sessions[1].protocol,
3302                                     is_in=0)
3303
3304         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n, 0)
3305         self.assertEqual(nsessions - len(sessions), 2)
3306
3307         self.vapi.nat44_del_session(sessions[0].inside_ip_address,
3308                                     sessions[0].inside_port,
3309                                     sessions[0].protocol)
3310
3311         self.verify_no_nat44_user()
3312
3313     def test_set_get_reass(self):
3314         """ NAT44 set/get virtual fragmentation reassembly """
3315         reas_cfg1 = self.vapi.nat_get_reass()
3316
3317         self.vapi.nat_set_reass(timeout=reas_cfg1.ip4_timeout + 5,
3318                                 max_reass=reas_cfg1.ip4_max_reass * 2,
3319                                 max_frag=reas_cfg1.ip4_max_frag * 2)
3320
3321         reas_cfg2 = self.vapi.nat_get_reass()
3322
3323         self.assertEqual(reas_cfg1.ip4_timeout + 5, reas_cfg2.ip4_timeout)
3324         self.assertEqual(reas_cfg1.ip4_max_reass * 2, reas_cfg2.ip4_max_reass)
3325         self.assertEqual(reas_cfg1.ip4_max_frag * 2, reas_cfg2.ip4_max_frag)
3326
3327         self.vapi.nat_set_reass(drop_frag=1)
3328         self.assertTrue(self.vapi.nat_get_reass().ip4_drop_frag)
3329
3330     def test_frag_in_order(self):
3331         """ NAT44 translate fragments arriving in order """
3332
3333         self.nat44_add_address(self.nat_addr)
3334         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3335         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3336                                                   is_inside=0)
3337
3338         self.frag_in_order(proto=IP_PROTOS.tcp)
3339         self.frag_in_order(proto=IP_PROTOS.udp)
3340         self.frag_in_order(proto=IP_PROTOS.icmp)
3341
3342     def test_frag_forwarding(self):
3343         """ NAT44 forwarding fragment test """
3344         self.vapi.nat44_add_interface_addr(self.pg1.sw_if_index)
3345         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3346         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3347                                                   is_inside=0)
3348         self.vapi.nat44_forwarding_enable_disable(1)
3349
3350         data = "A" * 16 + "B" * 16 + "C" * 3
3351         pkts = self.create_stream_frag(self.pg1,
3352                                        self.pg0.remote_ip4,
3353                                        4789,
3354                                        4789,
3355                                        data,
3356                                        proto=IP_PROTOS.udp)
3357         self.pg1.add_stream(pkts)
3358         self.pg_enable_capture(self.pg_interfaces)
3359         self.pg_start()
3360         frags = self.pg0.get_capture(len(pkts))
3361         p = self.reass_frags_and_verify(frags,
3362                                         self.pg1.remote_ip4,
3363                                         self.pg0.remote_ip4)
3364         self.assertEqual(p[UDP].sport, 4789)
3365         self.assertEqual(p[UDP].dport, 4789)
3366         self.assertEqual(data, p[Raw].load)
3367
3368     def test_reass_hairpinning(self):
3369         """ NAT44 fragments hairpinning """
3370
3371         self.server = self.pg0.remote_hosts[1]
3372         self.host_in_port = random.randint(1025, 65535)
3373         self.server_in_port = random.randint(1025, 65535)
3374         self.server_out_port = random.randint(1025, 65535)
3375
3376         self.nat44_add_address(self.nat_addr)
3377         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3378         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3379                                                   is_inside=0)
3380         # add static mapping for server
3381         self.nat44_add_static_mapping(self.server.ip4, self.nat_addr,
3382                                       self.server_in_port,
3383                                       self.server_out_port,
3384                                       proto=IP_PROTOS.tcp)
3385         self.nat44_add_static_mapping(self.server.ip4, self.nat_addr,
3386                                       self.server_in_port,
3387                                       self.server_out_port,
3388                                       proto=IP_PROTOS.udp)
3389         self.nat44_add_static_mapping(self.server.ip4, self.nat_addr)
3390
3391         self.reass_hairpinning(proto=IP_PROTOS.tcp)
3392         self.reass_hairpinning(proto=IP_PROTOS.udp)
3393         self.reass_hairpinning(proto=IP_PROTOS.icmp)
3394
3395     def test_frag_out_of_order(self):
3396         """ NAT44 translate fragments arriving out of order """
3397
3398         self.nat44_add_address(self.nat_addr)
3399         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3400         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3401                                                   is_inside=0)
3402
3403         self.frag_out_of_order(proto=IP_PROTOS.tcp)
3404         self.frag_out_of_order(proto=IP_PROTOS.udp)
3405         self.frag_out_of_order(proto=IP_PROTOS.icmp)
3406
3407     def test_port_restricted(self):
3408         """ Port restricted NAT44 (MAP-E CE) """
3409         self.nat44_add_address(self.nat_addr)
3410         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3411         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3412                                                   is_inside=0)
3413         self.vapi.nat_set_addr_and_port_alloc_alg(alg=1,
3414                                                   psid_offset=6,
3415                                                   psid_length=6,
3416                                                   psid=10)
3417
3418         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3419              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3420              TCP(sport=4567, dport=22))
3421         self.pg0.add_stream(p)
3422         self.pg_enable_capture(self.pg_interfaces)
3423         self.pg_start()
3424         capture = self.pg1.get_capture(1)
3425         p = capture[0]
3426         try:
3427             ip = p[IP]
3428             tcp = p[TCP]
3429             self.assertEqual(ip.dst, self.pg1.remote_ip4)
3430             self.assertEqual(ip.src, self.nat_addr)
3431             self.assertEqual(tcp.dport, 22)
3432             self.assertNotEqual(tcp.sport, 4567)
3433             self.assertEqual((tcp.sport >> 6) & 63, 10)
3434             self.assert_packet_checksums_valid(p)
3435         except:
3436             self.logger.error(ppp("Unexpected or invalid packet:", p))
3437             raise
3438
3439     def test_port_range(self):
3440         """ External address port range """
3441         self.nat44_add_address(self.nat_addr)
3442         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3443         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3444                                                   is_inside=0)
3445         self.vapi.nat_set_addr_and_port_alloc_alg(alg=2,
3446                                                   start_port=1025,
3447                                                   end_port=1027)
3448
3449         pkts = []
3450         for port in range(0, 5):
3451             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
3452                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3453                  TCP(sport=1125 + port))
3454             pkts.append(p)
3455         self.pg0.add_stream(pkts)
3456         self.pg_enable_capture(self.pg_interfaces)
3457         self.pg_start()
3458         capture = self.pg1.get_capture(3)
3459         for p in capture:
3460             tcp = p[TCP]
3461             self.assertGreaterEqual(tcp.sport, 1025)
3462             self.assertLessEqual(tcp.sport, 1027)
3463
3464     def test_ipfix_max_frags(self):
3465         """ IPFIX logging maximum fragments pending reassembly exceeded """
3466         self.nat44_add_address(self.nat_addr)
3467         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3468         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3469                                                   is_inside=0)
3470         self.vapi.nat_set_reass(max_frag=1)
3471         self.vapi.set_ipfix_exporter(collector_address=self.pg3.remote_ip4n,
3472                                      src_address=self.pg3.local_ip4n,
3473                                      path_mtu=512,
3474                                      template_interval=10)
3475         self.vapi.nat_ipfix(domain_id=self.ipfix_domain_id,
3476                             src_port=self.ipfix_src_port)
3477
3478         data = "A" * 4 + "B" * 16 + "C" * 3
3479         self.tcp_port_in = random.randint(1025, 65535)
3480         pkts = self.create_stream_frag(self.pg0,
3481                                        self.pg1.remote_ip4,
3482                                        self.tcp_port_in,
3483                                        20,
3484                                        data)
3485         pkts.reverse()
3486         self.pg0.add_stream(pkts)
3487         self.pg_enable_capture(self.pg_interfaces)
3488         self.pg_start()
3489         self.pg1.assert_nothing_captured()
3490         sleep(1)
3491         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
3492         capture = self.pg3.get_capture(9)
3493         ipfix = IPFIXDecoder()
3494         # first load template
3495         for p in capture:
3496             self.assertTrue(p.haslayer(IPFIX))
3497             self.assertEqual(p[IP].src, self.pg3.local_ip4)
3498             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
3499             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
3500             self.assertEqual(p[UDP].dport, 4739)
3501             self.assertEqual(p[IPFIX].observationDomainID,
3502                              self.ipfix_domain_id)
3503             if p.haslayer(Template):
3504                 ipfix.add_template(p.getlayer(Template))
3505         # verify events in data set
3506         for p in capture:
3507             if p.haslayer(Data):
3508                 data = ipfix.decode_data_set(p.getlayer(Set))
3509                 self.verify_ipfix_max_fragments_ip4(data, 1,
3510                                                     self.pg0.remote_ip4n)
3511
3512     def test_multiple_outside_vrf(self):
3513         """ Multiple outside VRF """
3514         vrf_id1 = 1
3515         vrf_id2 = 2
3516
3517         self.pg1.unconfig_ip4()
3518         self.pg2.unconfig_ip4()
3519         self.vapi.ip_table_add_del(vrf_id1, is_add=1)
3520         self.vapi.ip_table_add_del(vrf_id2, is_add=1)
3521         self.pg1.set_table_ip4(vrf_id1)
3522         self.pg2.set_table_ip4(vrf_id2)
3523         self.pg1.config_ip4()
3524         self.pg2.config_ip4()
3525         self.pg1.resolve_arp()
3526         self.pg2.resolve_arp()
3527
3528         self.nat44_add_address(self.nat_addr)
3529         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3530         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3531                                                   is_inside=0)
3532         self.vapi.nat44_interface_add_del_feature(self.pg2.sw_if_index,
3533                                                   is_inside=0)
3534
3535         try:
3536             # first VRF
3537             pkts = self.create_stream_in(self.pg0, self.pg1)
3538             self.pg0.add_stream(pkts)
3539             self.pg_enable_capture(self.pg_interfaces)
3540             self.pg_start()
3541             capture = self.pg1.get_capture(len(pkts))
3542             self.verify_capture_out(capture, self.nat_addr)
3543
3544             pkts = self.create_stream_out(self.pg1, self.nat_addr)
3545             self.pg1.add_stream(pkts)
3546             self.pg_enable_capture(self.pg_interfaces)
3547             self.pg_start()
3548             capture = self.pg0.get_capture(len(pkts))
3549             self.verify_capture_in(capture, self.pg0)
3550
3551             self.tcp_port_in = 60303
3552             self.udp_port_in = 60304
3553             self.icmp_id_in = 60305
3554
3555             # second VRF
3556             pkts = self.create_stream_in(self.pg0, self.pg2)
3557             self.pg0.add_stream(pkts)
3558             self.pg_enable_capture(self.pg_interfaces)
3559             self.pg_start()
3560             capture = self.pg2.get_capture(len(pkts))
3561             self.verify_capture_out(capture, self.nat_addr)
3562
3563             pkts = self.create_stream_out(self.pg2, self.nat_addr)
3564             self.pg2.add_stream(pkts)
3565             self.pg_enable_capture(self.pg_interfaces)
3566             self.pg_start()
3567             capture = self.pg0.get_capture(len(pkts))
3568             self.verify_capture_in(capture, self.pg0)
3569
3570         finally:
3571             self.pg1.unconfig_ip4()
3572             self.pg2.unconfig_ip4()
3573             self.pg1.set_table_ip4(0)
3574             self.pg2.set_table_ip4(0)
3575             self.pg1.config_ip4()
3576             self.pg2.config_ip4()
3577             self.pg1.resolve_arp()
3578             self.pg2.resolve_arp()
3579
3580     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
3581     def test_session_timeout(self):
3582         """ NAT44 session timeouts """
3583         self.nat44_add_address(self.nat_addr)
3584         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3585         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3586                                                   is_inside=0)
3587         self.vapi.nat_set_timeouts(udp=5)
3588
3589         max_sessions = 1000
3590         pkts = []
3591         for i in range(0, max_sessions):
3592             src = "10.10.%u.%u" % ((i & 0xFF00) >> 8, i & 0xFF)
3593             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
3594                  IP(src=src, dst=self.pg1.remote_ip4) /
3595                  UDP(sport=1025, dport=53))
3596             pkts.append(p)
3597         self.pg0.add_stream(pkts)
3598         self.pg_enable_capture(self.pg_interfaces)
3599         self.pg_start()
3600         self.pg1.get_capture(max_sessions)
3601
3602         sleep(6)
3603
3604         pkts = []
3605         for i in range(0, max_sessions):
3606             src = "10.10.%u.%u" % ((i & 0xFF00) >> 8, i & 0xFF)
3607             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
3608                  IP(src=src, dst=self.pg1.remote_ip4) /
3609                  UDP(sport=1026, dport=53))
3610             pkts.append(p)
3611         self.pg0.add_stream(pkts)
3612         self.pg_enable_capture(self.pg_interfaces)
3613         self.pg_start()
3614         self.pg1.get_capture(max_sessions)
3615
3616         nsessions = 0
3617         users = self.vapi.nat44_user_dump()
3618         for user in users:
3619             nsessions = nsessions + user.nsessions
3620         self.assertLess(nsessions, 2 * max_sessions)
3621
3622     def test_mss_clamping(self):
3623         """ TCP MSS clamping """
3624         self.nat44_add_address(self.nat_addr)
3625         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3626         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3627                                                   is_inside=0)
3628
3629         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
3630              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
3631              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
3632                  flags="S", options=[('MSS', 1400)]))
3633
3634         self.vapi.nat_set_mss_clamping(enable=1, mss_value=1000)
3635         self.pg0.add_stream(p)
3636         self.pg_enable_capture(self.pg_interfaces)
3637         self.pg_start()
3638         capture = self.pg1.get_capture(1)
3639         # Negotiated MSS value greater than configured - changed
3640         self.verify_mss_value(capture[0], 1000)
3641
3642         self.vapi.nat_set_mss_clamping(enable=0)
3643         self.pg0.add_stream(p)
3644         self.pg_enable_capture(self.pg_interfaces)
3645         self.pg_start()
3646         capture = self.pg1.get_capture(1)
3647         # MSS clamping disabled - negotiated MSS unchanged
3648         self.verify_mss_value(capture[0], 1400)
3649
3650         self.vapi.nat_set_mss_clamping(enable=1, mss_value=1500)
3651         self.pg0.add_stream(p)
3652         self.pg_enable_capture(self.pg_interfaces)
3653         self.pg_start()
3654         capture = self.pg1.get_capture(1)
3655         # Negotiated MSS value smaller than configured - unchanged
3656         self.verify_mss_value(capture[0], 1400)
3657
3658     def tearDown(self):
3659         super(TestNAT44, self).tearDown()
3660         if not self.vpp_dead:
3661             self.logger.info(self.vapi.cli("show nat44 addresses"))
3662             self.logger.info(self.vapi.cli("show nat44 interfaces"))
3663             self.logger.info(self.vapi.cli("show nat44 static mappings"))
3664             self.logger.info(self.vapi.cli("show nat44 interface address"))
3665             self.logger.info(self.vapi.cli("show nat44 sessions detail"))
3666             self.logger.info(self.vapi.cli("show nat virtual-reassembly"))
3667             self.logger.info(self.vapi.cli("show nat44 hash tables detail"))
3668             self.logger.info(self.vapi.cli("show nat timeouts"))
3669             self.logger.info(
3670                 self.vapi.cli("show nat addr-port-assignment-alg"))
3671             self.clear_nat44()
3672             self.vapi.cli("clear logging")
3673
3674
3675 class TestNAT44EndpointDependent(MethodHolder):
3676     """ Endpoint-Dependent mapping and filtering test cases """
3677
3678     @classmethod
3679     def setUpConstants(cls):
3680         super(TestNAT44EndpointDependent, cls).setUpConstants()
3681         cls.vpp_cmdline.extend(["nat", "{", "endpoint-dependent", "}"])
3682
3683     @classmethod
3684     def setUpClass(cls):
3685         super(TestNAT44EndpointDependent, cls).setUpClass()
3686         cls.vapi.cli("set log class nat level debug")
3687         try:
3688             cls.tcp_port_in = 6303
3689             cls.tcp_port_out = 6303
3690             cls.udp_port_in = 6304
3691             cls.udp_port_out = 6304
3692             cls.icmp_id_in = 6305
3693             cls.icmp_id_out = 6305
3694             cls.nat_addr = '10.0.0.3'
3695             cls.nat_addr_n = socket.inet_pton(socket.AF_INET, cls.nat_addr)
3696             cls.ipfix_src_port = 4739
3697             cls.ipfix_domain_id = 1
3698             cls.tcp_external_port = 80
3699
3700             cls.create_pg_interfaces(range(7))
3701             cls.interfaces = list(cls.pg_interfaces[0:3])
3702
3703             for i in cls.interfaces:
3704                 i.admin_up()
3705                 i.config_ip4()
3706                 i.resolve_arp()
3707
3708             cls.pg0.generate_remote_hosts(3)
3709             cls.pg0.configure_ipv4_neighbors()
3710
3711             cls.pg3.admin_up()
3712
3713             cls.pg4.generate_remote_hosts(2)
3714             cls.pg4.config_ip4()
3715             ip_addr_n = socket.inet_pton(socket.AF_INET, "10.0.0.1")
3716             cls.vapi.sw_interface_add_del_address(cls.pg4.sw_if_index,
3717                                                   ip_addr_n,
3718                                                   24)
3719             cls.pg4.admin_up()
3720             cls.pg4.resolve_arp()
3721             cls.pg4._remote_hosts[1]._ip4 = cls.pg4._remote_hosts[0]._ip4
3722             cls.pg4.resolve_arp()
3723
3724             zero_ip4n = socket.inet_pton(socket.AF_INET, "0.0.0.0")
3725             cls.vapi.ip_table_add_del(1, is_add=1)
3726
3727             cls.pg5._local_ip4 = "10.1.1.1"
3728             cls.pg5._local_ip4n = socket.inet_pton(socket.AF_INET,
3729                                                    cls.pg5.local_ip4)
3730             cls.pg5._remote_hosts[0]._ip4 = "10.1.1.2"
3731             cls.pg5._remote_hosts[0]._ip4n = socket.inet_pton(
3732                 socket.AF_INET, cls.pg5.remote_ip4)
3733             cls.pg5.set_table_ip4(1)
3734             cls.pg5.config_ip4()
3735             cls.pg5.admin_up()
3736             cls.vapi.ip_add_del_route(dst_address=cls.pg5.remote_ip4n,
3737                                       dst_address_length=32,
3738                                       table_id=1,
3739                                       next_hop_sw_if_index=cls.pg5.sw_if_index,
3740                                       next_hop_address=zero_ip4n)
3741
3742             cls.pg6._local_ip4 = "10.1.2.1"
3743             cls.pg6._local_ip4n = socket.inet_pton(socket.AF_INET,
3744                                                    cls.pg6.local_ip4)
3745             cls.pg6._remote_hosts[0]._ip4 = "10.1.2.2"
3746             cls.pg6._remote_hosts[0]._ip4n = socket.inet_pton(
3747                 socket.AF_INET, cls.pg6.remote_ip4)
3748             cls.pg6.set_table_ip4(1)
3749             cls.pg6.config_ip4()
3750             cls.pg6.admin_up()
3751             cls.vapi.ip_add_del_route(dst_address=cls.pg6.remote_ip4n,
3752                                       dst_address_length=32,
3753                                       table_id=1,
3754                                       next_hop_sw_if_index=cls.pg6.sw_if_index,
3755                                       next_hop_address=zero_ip4n)
3756
3757             cls.vapi.ip_add_del_route(dst_address=cls.pg6.remote_ip4n,
3758                                       dst_address_length=16,
3759                                       next_hop_address=zero_ip4n,
3760                                       table_id=0,
3761                                       next_hop_table_id=1)
3762             cls.vapi.ip_add_del_route(dst_address=zero_ip4n,
3763                                       dst_address_length=0,
3764                                       next_hop_address=zero_ip4n,
3765                                       table_id=1,
3766                                       next_hop_table_id=0)
3767             cls.vapi.ip_add_del_route(dst_address=zero_ip4n,
3768                                       dst_address_length=0,
3769                                       table_id=0,
3770                                       next_hop_sw_if_index=cls.pg1.sw_if_index,
3771                                       next_hop_address=cls.pg1.local_ip4n)
3772
3773             cls.pg5.resolve_arp()
3774             cls.pg6.resolve_arp()
3775
3776         except Exception:
3777             super(TestNAT44EndpointDependent, cls).tearDownClass()
3778             raise
3779
3780     def test_frag_in_order(self):
3781         """ NAT44 translate fragments arriving in order """
3782         self.nat44_add_address(self.nat_addr)
3783         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3784         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3785                                                   is_inside=0)
3786         self.frag_in_order(proto=IP_PROTOS.tcp)
3787         self.frag_in_order(proto=IP_PROTOS.udp)
3788         self.frag_in_order(proto=IP_PROTOS.icmp)
3789
3790     def test_frag_in_order_dont_translate(self):
3791         """ NAT44 don't translate fragments arriving in order """
3792         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3793         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3794                                                   is_inside=0)
3795         self.vapi.nat44_forwarding_enable_disable(enable=True)
3796         self.frag_in_order(proto=IP_PROTOS.tcp, dont_translate=True)
3797
3798     def test_frag_out_of_order(self):
3799         """ NAT44 translate fragments arriving out of order """
3800         self.nat44_add_address(self.nat_addr)
3801         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3802         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3803                                                   is_inside=0)
3804         self.frag_out_of_order(proto=IP_PROTOS.tcp)
3805         self.frag_out_of_order(proto=IP_PROTOS.udp)
3806         self.frag_out_of_order(proto=IP_PROTOS.icmp)
3807
3808     def test_frag_out_of_order_dont_translate(self):
3809         """ NAT44 don't translate fragments arriving out of order """
3810         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3811         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3812                                                   is_inside=0)
3813         self.vapi.nat44_forwarding_enable_disable(enable=True)
3814         self.frag_out_of_order(proto=IP_PROTOS.tcp, dont_translate=True)
3815
3816     def test_frag_in_order_in_plus_out(self):
3817         """ in+out interface fragments in order """
3818         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3819         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index,
3820                                                   is_inside=0)
3821         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index)
3822         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3823                                                   is_inside=0)
3824
3825         self.server = self.pg1.remote_hosts[0]
3826
3827         self.server_in_addr = self.server.ip4
3828         self.server_out_addr = '11.11.11.11'
3829         self.server_in_port = random.randint(1025, 65535)
3830         self.server_out_port = random.randint(1025, 65535)
3831
3832         self.nat44_add_address(self.server_out_addr)
3833
3834         # add static mappings for server
3835         self.nat44_add_static_mapping(self.server_in_addr,
3836                                       self.server_out_addr,
3837                                       self.server_in_port,
3838                                       self.server_out_port,
3839                                       proto=IP_PROTOS.tcp)
3840         self.nat44_add_static_mapping(self.server_in_addr,
3841                                       self.server_out_addr,
3842                                       self.server_in_port,
3843                                       self.server_out_port,
3844                                       proto=IP_PROTOS.udp)
3845         self.nat44_add_static_mapping(self.server_in_addr,
3846                                       self.server_out_addr,
3847                                       proto=IP_PROTOS.icmp)
3848
3849         self.vapi.nat_set_reass(timeout=10)
3850
3851         self.frag_in_order_in_plus_out(proto=IP_PROTOS.tcp)
3852         self.frag_in_order_in_plus_out(proto=IP_PROTOS.udp)
3853         self.frag_in_order_in_plus_out(proto=IP_PROTOS.icmp)
3854
3855     def test_frag_out_of_order_in_plus_out(self):
3856         """ in+out interface fragments out of order """
3857         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3858         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index,
3859                                                   is_inside=0)
3860         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index)
3861         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3862                                                   is_inside=0)
3863
3864         self.server = self.pg1.remote_hosts[0]
3865
3866         self.server_in_addr = self.server.ip4
3867         self.server_out_addr = '11.11.11.11'
3868         self.server_in_port = random.randint(1025, 65535)
3869         self.server_out_port = random.randint(1025, 65535)
3870
3871         self.nat44_add_address(self.server_out_addr)
3872
3873         # add static mappings for server
3874         self.nat44_add_static_mapping(self.server_in_addr,
3875                                       self.server_out_addr,
3876                                       self.server_in_port,
3877                                       self.server_out_port,
3878                                       proto=IP_PROTOS.tcp)
3879         self.nat44_add_static_mapping(self.server_in_addr,
3880                                       self.server_out_addr,
3881                                       self.server_in_port,
3882                                       self.server_out_port,
3883                                       proto=IP_PROTOS.udp)
3884         self.nat44_add_static_mapping(self.server_in_addr,
3885                                       self.server_out_addr,
3886                                       proto=IP_PROTOS.icmp)
3887
3888         self.vapi.nat_set_reass(timeout=10)
3889
3890         self.frag_out_of_order_in_plus_out(proto=IP_PROTOS.tcp)
3891         self.frag_out_of_order_in_plus_out(proto=IP_PROTOS.udp)
3892         self.frag_out_of_order_in_plus_out(proto=IP_PROTOS.icmp)
3893
3894     def test_reass_hairpinning(self):
3895         """ NAT44 fragments hairpinning """
3896         self.server = self.pg0.remote_hosts[1]
3897         self.host_in_port = random.randint(1025, 65535)
3898         self.server_in_port = random.randint(1025, 65535)
3899         self.server_out_port = random.randint(1025, 65535)
3900
3901         self.nat44_add_address(self.nat_addr)
3902         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3903         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3904                                                   is_inside=0)
3905         # add static mapping for server
3906         self.nat44_add_static_mapping(self.server.ip4, self.nat_addr,
3907                                       self.server_in_port,
3908                                       self.server_out_port,
3909                                       proto=IP_PROTOS.tcp)
3910         self.nat44_add_static_mapping(self.server.ip4, self.nat_addr,
3911                                       self.server_in_port,
3912                                       self.server_out_port,
3913                                       proto=IP_PROTOS.udp)
3914         self.nat44_add_static_mapping(self.server.ip4, self.nat_addr)
3915
3916         self.reass_hairpinning(proto=IP_PROTOS.tcp)
3917         self.reass_hairpinning(proto=IP_PROTOS.udp)
3918         self.reass_hairpinning(proto=IP_PROTOS.icmp)
3919
3920     def test_dynamic(self):
3921         """ NAT44 dynamic translation test """
3922
3923         self.nat44_add_address(self.nat_addr)
3924         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3925         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3926                                                   is_inside=0)
3927
3928         nat_config = self.vapi.nat_show_config()
3929         self.assertEqual(1, nat_config.endpoint_dependent)
3930
3931         # in2out
3932         pkts = self.create_stream_in(self.pg0, self.pg1)
3933         self.pg0.add_stream(pkts)
3934         self.pg_enable_capture(self.pg_interfaces)
3935         self.pg_start()
3936         capture = self.pg1.get_capture(len(pkts))
3937         self.verify_capture_out(capture)
3938
3939         # out2in
3940         pkts = self.create_stream_out(self.pg1)
3941         self.pg1.add_stream(pkts)
3942         self.pg_enable_capture(self.pg_interfaces)
3943         self.pg_start()
3944         capture = self.pg0.get_capture(len(pkts))
3945         self.verify_capture_in(capture, self.pg0)
3946
3947     def test_forwarding(self):
3948         """ NAT44 forwarding test """
3949
3950         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
3951         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
3952                                                   is_inside=0)
3953         self.vapi.nat44_forwarding_enable_disable(1)
3954
3955         real_ip = self.pg0.remote_ip4n
3956         alias_ip = self.nat_addr_n
3957         self.vapi.nat44_add_del_static_mapping(local_ip=real_ip,
3958                                                external_ip=alias_ip)
3959
3960         try:
3961             # in2out - static mapping match
3962
3963             pkts = self.create_stream_out(self.pg1)
3964             self.pg1.add_stream(pkts)
3965             self.pg_enable_capture(self.pg_interfaces)
3966             self.pg_start()
3967             capture = self.pg0.get_capture(len(pkts))
3968             self.verify_capture_in(capture, self.pg0)
3969
3970             pkts = self.create_stream_in(self.pg0, self.pg1)
3971             self.pg0.add_stream(pkts)
3972             self.pg_enable_capture(self.pg_interfaces)
3973             self.pg_start()
3974             capture = self.pg1.get_capture(len(pkts))
3975             self.verify_capture_out(capture, same_port=True)
3976
3977             # in2out - no static mapping match
3978
3979             host0 = self.pg0.remote_hosts[0]
3980             self.pg0.remote_hosts[0] = self.pg0.remote_hosts[1]
3981             try:
3982                 pkts = self.create_stream_out(self.pg1,
3983                                               dst_ip=self.pg0.remote_ip4,
3984                                               use_inside_ports=True)
3985                 self.pg1.add_stream(pkts)
3986                 self.pg_enable_capture(self.pg_interfaces)
3987                 self.pg_start()
3988                 capture = self.pg0.get_capture(len(pkts))
3989                 self.verify_capture_in(capture, self.pg0)
3990
3991                 pkts = self.create_stream_in(self.pg0, self.pg1)
3992                 self.pg0.add_stream(pkts)
3993                 self.pg_enable_capture(self.pg_interfaces)
3994                 self.pg_start()
3995                 capture = self.pg1.get_capture(len(pkts))
3996                 self.verify_capture_out(capture, nat_ip=self.pg0.remote_ip4,
3997                                         same_port=True)
3998             finally:
3999                 self.pg0.remote_hosts[0] = host0
4000
4001             user = self.pg0.remote_hosts[1]
4002             sessions = self.vapi.nat44_user_session_dump(user.ip4n, 0)
4003             self.assertEqual(len(sessions), 3)
4004             self.assertTrue(sessions[0].ext_host_valid)
4005             self.vapi.nat44_del_session(
4006                 sessions[0].inside_ip_address,
4007                 sessions[0].inside_port,
4008                 sessions[0].protocol,
4009                 ext_host_address=sessions[0].ext_host_address,
4010                 ext_host_port=sessions[0].ext_host_port)
4011             sessions = self.vapi.nat44_user_session_dump(user.ip4n, 0)
4012             self.assertEqual(len(sessions), 2)
4013
4014         finally:
4015             self.vapi.nat44_forwarding_enable_disable(0)
4016             self.vapi.nat44_add_del_static_mapping(local_ip=real_ip,
4017                                                    external_ip=alias_ip,
4018                                                    is_add=0)
4019
4020     def test_static_lb(self):
4021         """ NAT44 local service load balancing """
4022         external_addr_n = socket.inet_pton(socket.AF_INET, self.nat_addr)
4023         external_port = 80
4024         local_port = 8080
4025         server1 = self.pg0.remote_hosts[0]
4026         server2 = self.pg0.remote_hosts[1]
4027
4028         locals = [{'addr': server1.ip4n,
4029                    'port': local_port,
4030                    'probability': 70,
4031                    'vrf_id': 0},
4032                   {'addr': server2.ip4n,
4033                    'port': local_port,
4034                    'probability': 30,
4035                    'vrf_id': 0}]
4036
4037         self.nat44_add_address(self.nat_addr)
4038         self.vapi.nat44_add_del_lb_static_mapping(external_addr_n,
4039                                                   external_port,
4040                                                   IP_PROTOS.tcp,
4041                                                   local_num=len(locals),
4042                                                   locals=locals)
4043         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4044         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
4045                                                   is_inside=0)
4046
4047         # from client to service
4048         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4049              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
4050              TCP(sport=12345, dport=external_port))
4051         self.pg1.add_stream(p)
4052         self.pg_enable_capture(self.pg_interfaces)
4053         self.pg_start()
4054         capture = self.pg0.get_capture(1)
4055         p = capture[0]
4056         server = None
4057         try:
4058             ip = p[IP]
4059             tcp = p[TCP]
4060             self.assertIn(ip.dst, [server1.ip4, server2.ip4])
4061             if ip.dst == server1.ip4:
4062                 server = server1
4063             else:
4064                 server = server2
4065             self.assertEqual(tcp.dport, local_port)
4066             self.assert_packet_checksums_valid(p)
4067         except:
4068             self.logger.error(ppp("Unexpected or invalid packet:", p))
4069             raise
4070
4071         # from service back to client
4072         p = (Ether(src=server.mac, dst=self.pg0.local_mac) /
4073              IP(src=server.ip4, dst=self.pg1.remote_ip4) /
4074              TCP(sport=local_port, dport=12345))
4075         self.pg0.add_stream(p)
4076         self.pg_enable_capture(self.pg_interfaces)
4077         self.pg_start()
4078         capture = self.pg1.get_capture(1)
4079         p = capture[0]
4080         try:
4081             ip = p[IP]
4082             tcp = p[TCP]
4083             self.assertEqual(ip.src, self.nat_addr)
4084             self.assertEqual(tcp.sport, external_port)
4085             self.assert_packet_checksums_valid(p)
4086         except:
4087             self.logger.error(ppp("Unexpected or invalid packet:", p))
4088             raise
4089
4090         sessions = self.vapi.nat44_user_session_dump(server.ip4n, 0)
4091         self.assertEqual(len(sessions), 1)
4092         self.assertTrue(sessions[0].ext_host_valid)
4093         self.vapi.nat44_del_session(
4094             sessions[0].inside_ip_address,
4095             sessions[0].inside_port,
4096             sessions[0].protocol,
4097             ext_host_address=sessions[0].ext_host_address,
4098             ext_host_port=sessions[0].ext_host_port)
4099         sessions = self.vapi.nat44_user_session_dump(server.ip4n, 0)
4100         self.assertEqual(len(sessions), 0)
4101
4102     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
4103     def test_static_lb_multi_clients(self):
4104         """ NAT44 local service load balancing - multiple clients"""
4105
4106         external_addr_n = socket.inet_pton(socket.AF_INET, self.nat_addr)
4107         external_port = 80
4108         local_port = 8080
4109         server1 = self.pg0.remote_hosts[0]
4110         server2 = self.pg0.remote_hosts[1]
4111
4112         locals = [{'addr': server1.ip4n,
4113                    'port': local_port,
4114                    'probability': 90,
4115                    'vrf_id': 0},
4116                   {'addr': server2.ip4n,
4117                    'port': local_port,
4118                    'probability': 10,
4119                    'vrf_id': 0}]
4120
4121         self.nat44_add_address(self.nat_addr)
4122         self.vapi.nat44_add_del_lb_static_mapping(external_addr_n,
4123                                                   external_port,
4124                                                   IP_PROTOS.tcp,
4125                                                   local_num=len(locals),
4126                                                   locals=locals)
4127         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4128         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
4129                                                   is_inside=0)
4130
4131         server1_n = 0
4132         server2_n = 0
4133         clients = ip4_range(self.pg1.remote_ip4, 10, 50)
4134         pkts = []
4135         for client in clients:
4136             p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4137                  IP(src=client, dst=self.nat_addr) /
4138                  TCP(sport=12345, dport=external_port))
4139             pkts.append(p)
4140         self.pg1.add_stream(pkts)
4141         self.pg_enable_capture(self.pg_interfaces)
4142         self.pg_start()
4143         capture = self.pg0.get_capture(len(pkts))
4144         for p in capture:
4145             if p[IP].dst == server1.ip4:
4146                 server1_n += 1
4147             else:
4148                 server2_n += 1
4149         self.assertTrue(server1_n > server2_n)
4150
4151     def test_static_lb_2(self):
4152         """ NAT44 local service load balancing (asymmetrical rule) """
4153         external_addr_n = socket.inet_pton(socket.AF_INET, self.nat_addr)
4154         external_port = 80
4155         local_port = 8080
4156         server1 = self.pg0.remote_hosts[0]
4157         server2 = self.pg0.remote_hosts[1]
4158
4159         locals = [{'addr': server1.ip4n,
4160                    'port': local_port,
4161                    'probability': 70,
4162                    'vrf_id': 0},
4163                   {'addr': server2.ip4n,
4164                    'port': local_port,
4165                    'probability': 30,
4166                    'vrf_id': 0}]
4167
4168         self.vapi.nat44_forwarding_enable_disable(1)
4169         self.vapi.nat44_add_del_lb_static_mapping(external_addr_n,
4170                                                   external_port,
4171                                                   IP_PROTOS.tcp,
4172                                                   out2in_only=1,
4173                                                   local_num=len(locals),
4174                                                   locals=locals)
4175         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4176         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
4177                                                   is_inside=0)
4178
4179         # from client to service
4180         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4181              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
4182              TCP(sport=12345, dport=external_port))
4183         self.pg1.add_stream(p)
4184         self.pg_enable_capture(self.pg_interfaces)
4185         self.pg_start()
4186         capture = self.pg0.get_capture(1)
4187         p = capture[0]
4188         server = None
4189         try:
4190             ip = p[IP]
4191             tcp = p[TCP]
4192             self.assertIn(ip.dst, [server1.ip4, server2.ip4])
4193             if ip.dst == server1.ip4:
4194                 server = server1
4195             else:
4196                 server = server2
4197             self.assertEqual(tcp.dport, local_port)
4198             self.assert_packet_checksums_valid(p)
4199         except:
4200             self.logger.error(ppp("Unexpected or invalid packet:", p))
4201             raise
4202
4203         # from service back to client
4204         p = (Ether(src=server.mac, dst=self.pg0.local_mac) /
4205              IP(src=server.ip4, dst=self.pg1.remote_ip4) /
4206              TCP(sport=local_port, dport=12345))
4207         self.pg0.add_stream(p)
4208         self.pg_enable_capture(self.pg_interfaces)
4209         self.pg_start()
4210         capture = self.pg1.get_capture(1)
4211         p = capture[0]
4212         try:
4213             ip = p[IP]
4214             tcp = p[TCP]
4215             self.assertEqual(ip.src, self.nat_addr)
4216             self.assertEqual(tcp.sport, external_port)
4217             self.assert_packet_checksums_valid(p)
4218         except:
4219             self.logger.error(ppp("Unexpected or invalid packet:", p))
4220             raise
4221
4222         # from client to server (no translation)
4223         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4224              IP(src=self.pg1.remote_ip4, dst=server1.ip4) /
4225              TCP(sport=12346, dport=local_port))
4226         self.pg1.add_stream(p)
4227         self.pg_enable_capture(self.pg_interfaces)
4228         self.pg_start()
4229         capture = self.pg0.get_capture(1)
4230         p = capture[0]
4231         server = None
4232         try:
4233             ip = p[IP]
4234             tcp = p[TCP]
4235             self.assertEqual(ip.dst, server1.ip4)
4236             self.assertEqual(tcp.dport, local_port)
4237             self.assert_packet_checksums_valid(p)
4238         except:
4239             self.logger.error(ppp("Unexpected or invalid packet:", p))
4240             raise
4241
4242         # from service back to client (no translation)
4243         p = (Ether(src=server1.mac, dst=self.pg0.local_mac) /
4244              IP(src=server1.ip4, dst=self.pg1.remote_ip4) /
4245              TCP(sport=local_port, dport=12346))
4246         self.pg0.add_stream(p)
4247         self.pg_enable_capture(self.pg_interfaces)
4248         self.pg_start()
4249         capture = self.pg1.get_capture(1)
4250         p = capture[0]
4251         try:
4252             ip = p[IP]
4253             tcp = p[TCP]
4254             self.assertEqual(ip.src, server1.ip4)
4255             self.assertEqual(tcp.sport, local_port)
4256             self.assert_packet_checksums_valid(p)
4257         except:
4258             self.logger.error(ppp("Unexpected or invalid packet:", p))
4259             raise
4260
4261     def test_lb_affinity(self):
4262         """ NAT44 local service load balancing affinity """
4263         external_addr_n = socket.inet_pton(socket.AF_INET, self.nat_addr)
4264         external_port = 80
4265         local_port = 8080
4266         server1 = self.pg0.remote_hosts[0]
4267         server2 = self.pg0.remote_hosts[1]
4268
4269         locals = [{'addr': server1.ip4n,
4270                    'port': local_port,
4271                    'probability': 50,
4272                    'vrf_id': 0},
4273                   {'addr': server2.ip4n,
4274                    'port': local_port,
4275                    'probability': 50,
4276                    'vrf_id': 0}]
4277
4278         self.nat44_add_address(self.nat_addr)
4279         self.vapi.nat44_add_del_lb_static_mapping(external_addr_n,
4280                                                   external_port,
4281                                                   IP_PROTOS.tcp,
4282                                                   affinity=10800,
4283                                                   local_num=len(locals),
4284                                                   locals=locals)
4285         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4286         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
4287                                                   is_inside=0)
4288
4289         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
4290              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
4291              TCP(sport=1025, dport=external_port))
4292         self.pg1.add_stream(p)
4293         self.pg_enable_capture(self.pg_interfaces)
4294         self.pg_start()
4295         capture = self.pg0.get_capture(1)
4296         backend = capture[0][IP].dst
4297
4298         sessions = self.vapi.nat44_user_session_dump(
4299             socket.inet_pton(socket.AF_INET, backend), 0)
4300         self.assertEqual(len(sessions), 1)
4301         self.assertTrue(sessions[0].ext_host_valid)
4302         self.vapi.nat44_del_session(
4303             sessions[0].inside_ip_address,
4304             sessions[0].inside_port,
4305             sessions[0].protocol,
4306             ext_host_address=sessions[0].ext_host_address,
4307             ext_host_port=sessions[0].ext_host_port)
4308
4309         pkts = []
4310         for port in range(1030, 1100):
4311             p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
4312                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
4313                  TCP(sport=port, dport=external_port))
4314             pkts.append(p)
4315         self.pg1.add_stream(pkts)
4316         self.pg_enable_capture(self.pg_interfaces)
4317         self.pg_start()
4318         capture = self.pg0.get_capture(len(pkts))
4319         for p in capture:
4320             self.assertEqual(p[IP].dst, backend)
4321
4322     def test_unknown_proto(self):
4323         """ NAT44 translate packet with unknown protocol """
4324         self.nat44_add_address(self.nat_addr)
4325         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4326         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
4327                                                   is_inside=0)
4328
4329         # in2out
4330         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
4331              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
4332              TCP(sport=self.tcp_port_in, dport=20))
4333         self.pg0.add_stream(p)
4334         self.pg_enable_capture(self.pg_interfaces)
4335         self.pg_start()
4336         p = self.pg1.get_capture(1)
4337
4338         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
4339              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
4340              GRE() /
4341              IP(src=self.pg2.remote_ip4, dst=self.pg2.remote_ip4) /
4342              TCP(sport=1234, dport=1234))
4343         self.pg0.add_stream(p)
4344         self.pg_enable_capture(self.pg_interfaces)
4345         self.pg_start()
4346         p = self.pg1.get_capture(1)
4347         packet = p[0]
4348         try:
4349             self.assertEqual(packet[IP].src, self.nat_addr)
4350             self.assertEqual(packet[IP].dst, self.pg1.remote_ip4)
4351             self.assertTrue(packet.haslayer(GRE))
4352             self.assert_packet_checksums_valid(packet)
4353         except:
4354             self.logger.error(ppp("Unexpected or invalid packet:", packet))
4355             raise
4356
4357         # out2in
4358         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
4359              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
4360              GRE() /
4361              IP(src=self.pg2.remote_ip4, dst=self.pg2.remote_ip4) /
4362              TCP(sport=1234, dport=1234))
4363         self.pg1.add_stream(p)
4364         self.pg_enable_capture(self.pg_interfaces)
4365         self.pg_start()
4366         p = self.pg0.get_capture(1)
4367         packet = p[0]
4368         try:
4369             self.assertEqual(packet[IP].src, self.pg1.remote_ip4)
4370             self.assertEqual(packet[IP].dst, self.pg0.remote_ip4)
4371             self.assertTrue(packet.haslayer(GRE))
4372             self.assert_packet_checksums_valid(packet)
4373         except:
4374             self.logger.error(ppp("Unexpected or invalid packet:", packet))
4375             raise
4376
4377     def test_hairpinning_unknown_proto(self):
4378         """ NAT44 translate packet with unknown protocol - hairpinning """
4379         host = self.pg0.remote_hosts[0]
4380         server = self.pg0.remote_hosts[1]
4381         host_in_port = 1234
4382         server_out_port = 8765
4383         server_nat_ip = "10.0.0.11"
4384
4385         self.nat44_add_address(self.nat_addr)
4386         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4387         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
4388                                                   is_inside=0)
4389
4390         # add static mapping for server
4391         self.nat44_add_static_mapping(server.ip4, server_nat_ip)
4392
4393         # host to server
4394         p = (Ether(src=host.mac, dst=self.pg0.local_mac) /
4395              IP(src=host.ip4, dst=server_nat_ip) /
4396              TCP(sport=host_in_port, dport=server_out_port))
4397         self.pg0.add_stream(p)
4398         self.pg_enable_capture(self.pg_interfaces)
4399         self.pg_start()
4400         self.pg0.get_capture(1)
4401
4402         p = (Ether(dst=self.pg0.local_mac, src=host.mac) /
4403              IP(src=host.ip4, dst=server_nat_ip) /
4404              GRE() /
4405              IP(src=self.pg2.remote_ip4, dst=self.pg2.remote_ip4) /
4406              TCP(sport=1234, dport=1234))
4407         self.pg0.add_stream(p)
4408         self.pg_enable_capture(self.pg_interfaces)
4409         self.pg_start()
4410         p = self.pg0.get_capture(1)
4411         packet = p[0]
4412         try:
4413             self.assertEqual(packet[IP].src, self.nat_addr)
4414             self.assertEqual(packet[IP].dst, server.ip4)
4415             self.assertTrue(packet.haslayer(GRE))
4416             self.assert_packet_checksums_valid(packet)
4417         except:
4418             self.logger.error(ppp("Unexpected or invalid packet:", packet))
4419             raise
4420
4421         # server to host
4422         p = (Ether(dst=self.pg0.local_mac, src=server.mac) /
4423              IP(src=server.ip4, dst=self.nat_addr) /
4424              GRE() /
4425              IP(src=self.pg2.remote_ip4, dst=self.pg2.remote_ip4) /
4426              TCP(sport=1234, dport=1234))
4427         self.pg0.add_stream(p)
4428         self.pg_enable_capture(self.pg_interfaces)
4429         self.pg_start()
4430         p = self.pg0.get_capture(1)
4431         packet = p[0]
4432         try:
4433             self.assertEqual(packet[IP].src, server_nat_ip)
4434             self.assertEqual(packet[IP].dst, host.ip4)
4435             self.assertTrue(packet.haslayer(GRE))
4436             self.assert_packet_checksums_valid(packet)
4437         except:
4438             self.logger.error(ppp("Unexpected or invalid packet:", packet))
4439             raise
4440
4441     def test_output_feature_and_service(self):
4442         """ NAT44 interface output feature and services """
4443         external_addr = '1.2.3.4'
4444         external_port = 80
4445         local_port = 8080
4446
4447         self.vapi.nat44_forwarding_enable_disable(1)
4448         self.nat44_add_address(self.nat_addr)
4449         self.vapi.nat44_add_del_identity_mapping(ip=self.pg1.remote_ip4n)
4450         self.nat44_add_static_mapping(self.pg0.remote_ip4, external_addr,
4451                                       local_port, external_port,
4452                                       proto=IP_PROTOS.tcp, out2in_only=1)
4453         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4454         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index,
4455                                                   is_inside=0)
4456         self.vapi.nat44_interface_add_del_output_feature(self.pg1.sw_if_index,
4457                                                          is_inside=0)
4458
4459         # from client to service
4460         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4461              IP(src=self.pg1.remote_ip4, dst=external_addr) /
4462              TCP(sport=12345, dport=external_port))
4463         self.pg1.add_stream(p)
4464         self.pg_enable_capture(self.pg_interfaces)
4465         self.pg_start()
4466         capture = self.pg0.get_capture(1)
4467         p = capture[0]
4468         try:
4469             ip = p[IP]
4470             tcp = p[TCP]
4471             self.assertEqual(ip.dst, self.pg0.remote_ip4)
4472             self.assertEqual(tcp.dport, local_port)
4473             self.assert_packet_checksums_valid(p)
4474         except:
4475             self.logger.error(ppp("Unexpected or invalid packet:", p))
4476             raise
4477
4478         # from service back to client
4479         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
4480              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
4481              TCP(sport=local_port, dport=12345))
4482         self.pg0.add_stream(p)
4483         self.pg_enable_capture(self.pg_interfaces)
4484         self.pg_start()
4485         capture = self.pg1.get_capture(1)
4486         p = capture[0]
4487         try:
4488             ip = p[IP]
4489             tcp = p[TCP]
4490             self.assertEqual(ip.src, external_addr)
4491             self.assertEqual(tcp.sport, external_port)
4492             self.assert_packet_checksums_valid(p)
4493         except:
4494             self.logger.error(ppp("Unexpected or invalid packet:", p))
4495             raise
4496
4497         # from local network host to external network
4498         pkts = self.create_stream_in(self.pg0, self.pg1)
4499         self.pg0.add_stream(pkts)
4500         self.pg_enable_capture(self.pg_interfaces)
4501         self.pg_start()
4502         capture = self.pg1.get_capture(len(pkts))
4503         self.verify_capture_out(capture)
4504         pkts = self.create_stream_in(self.pg0, self.pg1)
4505         self.pg0.add_stream(pkts)
4506         self.pg_enable_capture(self.pg_interfaces)
4507         self.pg_start()
4508         capture = self.pg1.get_capture(len(pkts))
4509         self.verify_capture_out(capture)
4510
4511         # from external network back to local network host
4512         pkts = self.create_stream_out(self.pg1)
4513         self.pg1.add_stream(pkts)
4514         self.pg_enable_capture(self.pg_interfaces)
4515         self.pg_start()
4516         capture = self.pg0.get_capture(len(pkts))
4517         self.verify_capture_in(capture, self.pg0)
4518
4519     def test_output_feature_and_service2(self):
4520         """ NAT44 interface output feature and service host direct access """
4521         self.vapi.nat44_forwarding_enable_disable(1)
4522         self.nat44_add_address(self.nat_addr)
4523         self.vapi.nat44_interface_add_del_output_feature(self.pg1.sw_if_index,
4524                                                          is_inside=0)
4525
4526         # session initiaded from service host - translate
4527         pkts = self.create_stream_in(self.pg0, self.pg1)
4528         self.pg0.add_stream(pkts)
4529         self.pg_enable_capture(self.pg_interfaces)
4530         self.pg_start()
4531         capture = self.pg1.get_capture(len(pkts))
4532         self.verify_capture_out(capture)
4533
4534         pkts = self.create_stream_out(self.pg1)
4535         self.pg1.add_stream(pkts)
4536         self.pg_enable_capture(self.pg_interfaces)
4537         self.pg_start()
4538         capture = self.pg0.get_capture(len(pkts))
4539         self.verify_capture_in(capture, self.pg0)
4540
4541         # session initiaded from remote host - do not translate
4542         self.tcp_port_in = 60303
4543         self.udp_port_in = 60304
4544         self.icmp_id_in = 60305
4545         pkts = self.create_stream_out(self.pg1,
4546                                       self.pg0.remote_ip4,
4547                                       use_inside_ports=True)
4548         self.pg1.add_stream(pkts)
4549         self.pg_enable_capture(self.pg_interfaces)
4550         self.pg_start()
4551         capture = self.pg0.get_capture(len(pkts))
4552         self.verify_capture_in(capture, self.pg0)
4553
4554         pkts = self.create_stream_in(self.pg0, self.pg1)
4555         self.pg0.add_stream(pkts)
4556         self.pg_enable_capture(self.pg_interfaces)
4557         self.pg_start()
4558         capture = self.pg1.get_capture(len(pkts))
4559         self.verify_capture_out(capture, nat_ip=self.pg0.remote_ip4,
4560                                 same_port=True)
4561
4562     def test_output_feature_and_service3(self):
4563         """ NAT44 interface output feature and DST NAT """
4564         external_addr = '1.2.3.4'
4565         external_port = 80
4566         local_port = 8080
4567
4568         self.vapi.nat44_forwarding_enable_disable(1)
4569         self.nat44_add_address(self.nat_addr)
4570         self.nat44_add_static_mapping(self.pg1.remote_ip4, external_addr,
4571                                       local_port, external_port,
4572                                       proto=IP_PROTOS.tcp, out2in_only=1)
4573         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4574         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index,
4575                                                   is_inside=0)
4576         self.vapi.nat44_interface_add_del_output_feature(self.pg1.sw_if_index,
4577                                                          is_inside=0)
4578
4579         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
4580              IP(src=self.pg0.remote_ip4, dst=external_addr) /
4581              TCP(sport=12345, dport=external_port))
4582         self.pg0.add_stream(p)
4583         self.pg_enable_capture(self.pg_interfaces)
4584         self.pg_start()
4585         capture = self.pg1.get_capture(1)
4586         p = capture[0]
4587         try:
4588             ip = p[IP]
4589             tcp = p[TCP]
4590             self.assertEqual(ip.src, self.pg0.remote_ip4)
4591             self.assertEqual(tcp.sport, 12345)
4592             self.assertEqual(ip.dst, self.pg1.remote_ip4)
4593             self.assertEqual(tcp.dport, local_port)
4594             self.assert_packet_checksums_valid(p)
4595         except:
4596             self.logger.error(ppp("Unexpected or invalid packet:", p))
4597             raise
4598
4599         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4600              IP(src=self.pg1.remote_ip4, dst=self.pg0.remote_ip4) /
4601              TCP(sport=local_port, dport=12345))
4602         self.pg1.add_stream(p)
4603         self.pg_enable_capture(self.pg_interfaces)
4604         self.pg_start()
4605         capture = self.pg0.get_capture(1)
4606         p = capture[0]
4607         try:
4608             ip = p[IP]
4609             tcp = p[TCP]
4610             self.assertEqual(ip.src, external_addr)
4611             self.assertEqual(tcp.sport, external_port)
4612             self.assertEqual(ip.dst, self.pg0.remote_ip4)
4613             self.assertEqual(tcp.dport, 12345)
4614             self.assert_packet_checksums_valid(p)
4615         except:
4616             self.logger.error(ppp("Unexpected or invalid packet:", p))
4617             raise
4618
4619     def test_next_src_nat(self):
4620         """ On way back forward packet to nat44-in2out node. """
4621         twice_nat_addr = '10.0.1.3'
4622         external_port = 80
4623         local_port = 8080
4624         post_twice_nat_port = 0
4625
4626         self.vapi.nat44_forwarding_enable_disable(1)
4627         self.nat44_add_address(twice_nat_addr, twice_nat=1)
4628         self.nat44_add_static_mapping(self.pg6.remote_ip4, self.pg1.remote_ip4,
4629                                       local_port, external_port,
4630                                       proto=IP_PROTOS.tcp, out2in_only=1,
4631                                       self_twice_nat=1, vrf_id=1)
4632         self.vapi.nat44_interface_add_del_feature(self.pg6.sw_if_index,
4633                                                   is_inside=0)
4634
4635         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
4636              IP(src=self.pg6.remote_ip4, dst=self.pg1.remote_ip4) /
4637              TCP(sport=12345, dport=external_port))
4638         self.pg6.add_stream(p)
4639         self.pg_enable_capture(self.pg_interfaces)
4640         self.pg_start()
4641         capture = self.pg6.get_capture(1)
4642         p = capture[0]
4643         try:
4644             ip = p[IP]
4645             tcp = p[TCP]
4646             self.assertEqual(ip.src, twice_nat_addr)
4647             self.assertNotEqual(tcp.sport, 12345)
4648             post_twice_nat_port = tcp.sport
4649             self.assertEqual(ip.dst, self.pg6.remote_ip4)
4650             self.assertEqual(tcp.dport, local_port)
4651             self.assert_packet_checksums_valid(p)
4652         except:
4653             self.logger.error(ppp("Unexpected or invalid packet:", p))
4654             raise
4655
4656         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
4657              IP(src=self.pg6.remote_ip4, dst=twice_nat_addr) /
4658              TCP(sport=local_port, dport=post_twice_nat_port))
4659         self.pg6.add_stream(p)
4660         self.pg_enable_capture(self.pg_interfaces)
4661         self.pg_start()
4662         capture = self.pg6.get_capture(1)
4663         p = capture[0]
4664         try:
4665             ip = p[IP]
4666             tcp = p[TCP]
4667             self.assertEqual(ip.src, self.pg1.remote_ip4)
4668             self.assertEqual(tcp.sport, external_port)
4669             self.assertEqual(ip.dst, self.pg6.remote_ip4)
4670             self.assertEqual(tcp.dport, 12345)
4671             self.assert_packet_checksums_valid(p)
4672         except:
4673             self.logger.error(ppp("Unexpected or invalid packet:", p))
4674             raise
4675
4676     def twice_nat_common(self, self_twice_nat=False, same_pg=False, lb=False,
4677                          client_id=None):
4678         twice_nat_addr = '10.0.1.3'
4679
4680         port_in = 8080
4681         if lb:
4682             if not same_pg:
4683                 port_in1 = port_in
4684                 port_in2 = port_in
4685             else:
4686                 port_in1 = port_in+1
4687                 port_in2 = port_in+2
4688
4689         port_out = 80
4690         eh_port_out = 4567
4691
4692         server1 = self.pg0.remote_hosts[0]
4693         server2 = self.pg0.remote_hosts[1]
4694         if lb and same_pg:
4695             server2 = server1
4696         if not lb:
4697             server = server1
4698
4699         pg0 = self.pg0
4700         if same_pg:
4701             pg1 = self.pg0
4702         else:
4703             pg1 = self.pg1
4704
4705         eh_translate = ((not self_twice_nat) or (not lb and same_pg) or
4706                         client_id == 1)
4707
4708         self.nat44_add_address(self.nat_addr)
4709         self.nat44_add_address(twice_nat_addr, twice_nat=1)
4710         if not lb:
4711             self.nat44_add_static_mapping(pg0.remote_ip4, self.nat_addr,
4712                                           port_in, port_out,
4713                                           proto=IP_PROTOS.tcp,
4714                                           twice_nat=int(not self_twice_nat),
4715                                           self_twice_nat=int(self_twice_nat))
4716         else:
4717             locals = [{'addr': server1.ip4n,
4718                        'port': port_in1,
4719                        'probability': 50,
4720                        'vrf_id': 0},
4721                       {'addr': server2.ip4n,
4722                        'port': port_in2,
4723                        'probability': 50,
4724                        'vrf_id': 0}]
4725             out_addr_n = socket.inet_pton(socket.AF_INET, self.nat_addr)
4726             self.vapi.nat44_add_del_lb_static_mapping(out_addr_n,
4727                                                       port_out,
4728                                                       IP_PROTOS.tcp,
4729                                                       twice_nat=int(
4730                                                           not self_twice_nat),
4731                                                       self_twice_nat=int(
4732                                                           self_twice_nat),
4733                                                       local_num=len(locals),
4734                                                       locals=locals)
4735         self.vapi.nat44_interface_add_del_feature(pg0.sw_if_index)
4736         self.vapi.nat44_interface_add_del_feature(pg1.sw_if_index,
4737                                                   is_inside=0)
4738
4739         if same_pg:
4740             if not lb:
4741                 client = server
4742             else:
4743                 assert client_id is not None
4744                 if client_id == 1:
4745                     client = self.pg0.remote_hosts[0]
4746                 elif client_id == 2:
4747                     client = self.pg0.remote_hosts[1]
4748         else:
4749             client = pg1.remote_hosts[0]
4750         p = (Ether(src=pg1.remote_mac, dst=pg1.local_mac) /
4751              IP(src=client.ip4, dst=self.nat_addr) /
4752              TCP(sport=eh_port_out, dport=port_out))
4753         pg1.add_stream(p)
4754         self.pg_enable_capture(self.pg_interfaces)
4755         self.pg_start()
4756         capture = pg0.get_capture(1)
4757         p = capture[0]
4758         try:
4759             ip = p[IP]
4760             tcp = p[TCP]
4761             if lb:
4762                 if ip.dst == server1.ip4:
4763                     server = server1
4764                     port_in = port_in1
4765                 else:
4766                     server = server2
4767                     port_in = port_in2
4768             self.assertEqual(ip.dst, server.ip4)
4769             if lb and same_pg:
4770                 self.assertIn(tcp.dport, [port_in1, port_in2])
4771             else:
4772                 self.assertEqual(tcp.dport, port_in)
4773             if eh_translate:
4774                 self.assertEqual(ip.src, twice_nat_addr)
4775                 self.assertNotEqual(tcp.sport, eh_port_out)
4776             else:
4777                 self.assertEqual(ip.src, client.ip4)
4778                 self.assertEqual(tcp.sport, eh_port_out)
4779             eh_addr_in = ip.src
4780             eh_port_in = tcp.sport
4781             saved_port_in = tcp.dport
4782             self.assert_packet_checksums_valid(p)
4783         except:
4784             self.logger.error(ppp("Unexpected or invalid packet:", p))
4785             raise
4786
4787         p = (Ether(src=server.mac, dst=pg0.local_mac) /
4788              IP(src=server.ip4, dst=eh_addr_in) /
4789              TCP(sport=saved_port_in, dport=eh_port_in))
4790         pg0.add_stream(p)
4791         self.pg_enable_capture(self.pg_interfaces)
4792         self.pg_start()
4793         capture = pg1.get_capture(1)
4794         p = capture[0]
4795         try:
4796             ip = p[IP]
4797             tcp = p[TCP]
4798             self.assertEqual(ip.dst, client.ip4)
4799             self.assertEqual(ip.src, self.nat_addr)
4800             self.assertEqual(tcp.dport, eh_port_out)
4801             self.assertEqual(tcp.sport, port_out)
4802             self.assert_packet_checksums_valid(p)
4803         except:
4804             self.logger.error(ppp("Unexpected or invalid packet:", p))
4805             raise
4806
4807         if eh_translate:
4808             sessions = self.vapi.nat44_user_session_dump(server.ip4n, 0)
4809             self.assertEqual(len(sessions), 1)
4810             self.assertTrue(sessions[0].ext_host_valid)
4811             self.assertTrue(sessions[0].is_twicenat)
4812             self.vapi.nat44_del_session(
4813                 sessions[0].inside_ip_address,
4814                 sessions[0].inside_port,
4815                 sessions[0].protocol,
4816                 ext_host_address=sessions[0].ext_host_nat_address,
4817                 ext_host_port=sessions[0].ext_host_nat_port)
4818             sessions = self.vapi.nat44_user_session_dump(server.ip4n, 0)
4819             self.assertEqual(len(sessions), 0)
4820
4821     def test_twice_nat(self):
4822         """ Twice NAT44 """
4823         self.twice_nat_common()
4824
4825     def test_self_twice_nat_positive(self):
4826         """ Self Twice NAT44 (positive test) """
4827         self.twice_nat_common(self_twice_nat=True, same_pg=True)
4828
4829     def test_self_twice_nat_negative(self):
4830         """ Self Twice NAT44 (negative test) """
4831         self.twice_nat_common(self_twice_nat=True)
4832
4833     def test_twice_nat_lb(self):
4834         """ Twice NAT44 local service load balancing """
4835         self.twice_nat_common(lb=True)
4836
4837     def test_self_twice_nat_lb_positive(self):
4838         """ Self Twice NAT44 local service load balancing (positive test) """
4839         self.twice_nat_common(lb=True, self_twice_nat=True, same_pg=True,
4840                               client_id=1)
4841
4842     def test_self_twice_nat_lb_negative(self):
4843         """ Self Twice NAT44 local service load balancing (negative test) """
4844         self.twice_nat_common(lb=True, self_twice_nat=True, same_pg=True,
4845                               client_id=2)
4846
4847     def test_twice_nat_interface_addr(self):
4848         """ Acquire twice NAT44 addresses from interface """
4849         self.vapi.nat44_add_interface_addr(self.pg3.sw_if_index, twice_nat=1)
4850
4851         # no address in NAT pool
4852         adresses = self.vapi.nat44_address_dump()
4853         self.assertEqual(0, len(adresses))
4854
4855         # configure interface address and check NAT address pool
4856         self.pg3.config_ip4()
4857         adresses = self.vapi.nat44_address_dump()
4858         self.assertEqual(1, len(adresses))
4859         self.assertEqual(adresses[0].ip_address[0:4], self.pg3.local_ip4n)
4860         self.assertEqual(adresses[0].twice_nat, 1)
4861
4862         # remove interface address and check NAT address pool
4863         self.pg3.unconfig_ip4()
4864         adresses = self.vapi.nat44_address_dump()
4865         self.assertEqual(0, len(adresses))
4866
4867     def test_tcp_close(self):
4868         """ Close TCP session from inside network - output feature """
4869         self.vapi.nat44_forwarding_enable_disable(1)
4870         self.nat44_add_address(self.pg1.local_ip4)
4871         twice_nat_addr = '10.0.1.3'
4872         service_ip = '192.168.16.150'
4873         self.nat44_add_address(twice_nat_addr, twice_nat=1)
4874         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4875         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index,
4876                                                   is_inside=0)
4877         self.vapi.nat44_interface_add_del_output_feature(self.pg1.sw_if_index,
4878                                                          is_inside=0)
4879         self.nat44_add_static_mapping(self.pg0.remote_ip4,
4880                                       service_ip,
4881                                       80,
4882                                       80,
4883                                       proto=IP_PROTOS.tcp,
4884                                       out2in_only=1,
4885                                       twice_nat=1)
4886         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n, 0)
4887         start_sessnum = len(sessions)
4888
4889         # SYN packet out->in
4890         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4891              IP(src=self.pg1.remote_ip4, dst=service_ip) /
4892              TCP(sport=33898, dport=80, flags="S"))
4893         self.pg1.add_stream(p)
4894         self.pg_enable_capture(self.pg_interfaces)
4895         self.pg_start()
4896         capture = self.pg0.get_capture(1)
4897         p = capture[0]
4898         tcp_port = p[TCP].sport
4899
4900         # SYN + ACK packet in->out
4901         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
4902              IP(src=self.pg0.remote_ip4, dst=twice_nat_addr) /
4903              TCP(sport=80, dport=tcp_port, flags="SA"))
4904         self.pg0.add_stream(p)
4905         self.pg_enable_capture(self.pg_interfaces)
4906         self.pg_start()
4907         self.pg1.get_capture(1)
4908
4909         # ACK packet out->in
4910         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4911              IP(src=self.pg1.remote_ip4, dst=service_ip) /
4912              TCP(sport=33898, dport=80, flags="A"))
4913         self.pg1.add_stream(p)
4914         self.pg_enable_capture(self.pg_interfaces)
4915         self.pg_start()
4916         self.pg0.get_capture(1)
4917
4918         # FIN packet in -> out
4919         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
4920              IP(src=self.pg0.remote_ip4, dst=twice_nat_addr) /
4921              TCP(sport=80, dport=tcp_port, flags="FA", seq=100, ack=300))
4922         self.pg0.add_stream(p)
4923         self.pg_enable_capture(self.pg_interfaces)
4924         self.pg_start()
4925         self.pg1.get_capture(1)
4926
4927         # FIN+ACK packet out -> in
4928         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4929              IP(src=self.pg1.remote_ip4, dst=service_ip) /
4930              TCP(sport=33898, dport=80, flags="FA", seq=300, ack=101))
4931         self.pg1.add_stream(p)
4932         self.pg_enable_capture(self.pg_interfaces)
4933         self.pg_start()
4934         self.pg0.get_capture(1)
4935
4936         # ACK packet in -> out
4937         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
4938              IP(src=self.pg0.remote_ip4, dst=twice_nat_addr) /
4939              TCP(sport=80, dport=tcp_port, flags="A", seq=101, ack=301))
4940         self.pg0.add_stream(p)
4941         self.pg_enable_capture(self.pg_interfaces)
4942         self.pg_start()
4943         self.pg1.get_capture(1)
4944
4945         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n,
4946                                                      0)
4947         self.assertEqual(len(sessions) - start_sessnum, 0)
4948
4949     def test_tcp_session_close_in(self):
4950         """ Close TCP session from inside network """
4951         self.tcp_port_out = 10505
4952         self.nat44_add_address(self.nat_addr)
4953         self.nat44_add_static_mapping(self.pg0.remote_ip4,
4954                                       self.nat_addr,
4955                                       self.tcp_port_in,
4956                                       self.tcp_port_out,
4957                                       proto=IP_PROTOS.tcp,
4958                                       twice_nat=1)
4959         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
4960         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
4961                                                   is_inside=0)
4962
4963         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n, 0)
4964         start_sessnum = len(sessions)
4965
4966         self.initiate_tcp_session(self.pg0, self.pg1)
4967
4968         # FIN packet in -> out
4969         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
4970              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
4971              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
4972                  flags="FA", seq=100, ack=300))
4973         self.pg0.add_stream(p)
4974         self.pg_enable_capture(self.pg_interfaces)
4975         self.pg_start()
4976         self.pg1.get_capture(1)
4977
4978         pkts = []
4979
4980         # ACK packet out -> in
4981         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4982              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
4983              TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
4984                  flags="A", seq=300, ack=101))
4985         pkts.append(p)
4986
4987         # FIN packet out -> in
4988         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
4989              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
4990              TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
4991                  flags="FA", seq=300, ack=101))
4992         pkts.append(p)
4993
4994         self.pg1.add_stream(pkts)
4995         self.pg_enable_capture(self.pg_interfaces)
4996         self.pg_start()
4997         self.pg0.get_capture(2)
4998
4999         # ACK packet in -> out
5000         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5001              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5002              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
5003                  flags="A", seq=101, ack=301))
5004         self.pg0.add_stream(p)
5005         self.pg_enable_capture(self.pg_interfaces)
5006         self.pg_start()
5007         self.pg1.get_capture(1)
5008
5009         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n,
5010                                                      0)
5011         self.assertEqual(len(sessions) - start_sessnum, 0)
5012
5013     def test_tcp_session_close_out(self):
5014         """ Close TCP session from outside network """
5015         self.tcp_port_out = 10505
5016         self.nat44_add_address(self.nat_addr)
5017         self.nat44_add_static_mapping(self.pg0.remote_ip4,
5018                                       self.nat_addr,
5019                                       self.tcp_port_in,
5020                                       self.tcp_port_out,
5021                                       proto=IP_PROTOS.tcp,
5022                                       twice_nat=1)
5023         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
5024         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
5025                                                   is_inside=0)
5026
5027         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n, 0)
5028         start_sessnum = len(sessions)
5029
5030         self.initiate_tcp_session(self.pg0, self.pg1)
5031
5032         # FIN packet out -> in
5033         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
5034              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
5035              TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
5036                  flags="FA", seq=100, ack=300))
5037         self.pg1.add_stream(p)
5038         self.pg_enable_capture(self.pg_interfaces)
5039         self.pg_start()
5040         self.pg0.get_capture(1)
5041
5042         # FIN+ACK packet in -> out
5043         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5044              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5045              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
5046                  flags="FA", seq=300, ack=101))
5047
5048         self.pg0.add_stream(p)
5049         self.pg_enable_capture(self.pg_interfaces)
5050         self.pg_start()
5051         self.pg1.get_capture(1)
5052
5053         # ACK packet out -> in
5054         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
5055              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
5056              TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
5057                  flags="A", seq=101, ack=301))
5058         self.pg1.add_stream(p)
5059         self.pg_enable_capture(self.pg_interfaces)
5060         self.pg_start()
5061         self.pg0.get_capture(1)
5062
5063         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n,
5064                                                      0)
5065         self.assertEqual(len(sessions) - start_sessnum, 0)
5066
5067     def test_tcp_session_close_simultaneous(self):
5068         """ Close TCP session from inside network """
5069         self.tcp_port_out = 10505
5070         self.nat44_add_address(self.nat_addr)
5071         self.nat44_add_static_mapping(self.pg0.remote_ip4,
5072                                       self.nat_addr,
5073                                       self.tcp_port_in,
5074                                       self.tcp_port_out,
5075                                       proto=IP_PROTOS.tcp,
5076                                       twice_nat=1)
5077         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
5078         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
5079                                                   is_inside=0)
5080
5081         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n, 0)
5082         start_sessnum = len(sessions)
5083
5084         self.initiate_tcp_session(self.pg0, self.pg1)
5085
5086         # FIN packet in -> out
5087         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5088              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5089              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
5090                  flags="FA", seq=100, ack=300))
5091         self.pg0.add_stream(p)
5092         self.pg_enable_capture(self.pg_interfaces)
5093         self.pg_start()
5094         self.pg1.get_capture(1)
5095
5096         # FIN packet out -> in
5097         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
5098              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
5099              TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
5100                  flags="FA", seq=300, ack=100))
5101         self.pg1.add_stream(p)
5102         self.pg_enable_capture(self.pg_interfaces)
5103         self.pg_start()
5104         self.pg0.get_capture(1)
5105
5106         # ACK packet in -> out
5107         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5108              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5109              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
5110                  flags="A", seq=101, ack=301))
5111         self.pg0.add_stream(p)
5112         self.pg_enable_capture(self.pg_interfaces)
5113         self.pg_start()
5114         self.pg1.get_capture(1)
5115
5116         # ACK packet out -> in
5117         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
5118              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
5119              TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
5120                  flags="A", seq=301, ack=101))
5121         self.pg1.add_stream(p)
5122         self.pg_enable_capture(self.pg_interfaces)
5123         self.pg_start()
5124         self.pg0.get_capture(1)
5125
5126         sessions = self.vapi.nat44_user_session_dump(self.pg0.remote_ip4n,
5127                                                      0)
5128         self.assertEqual(len(sessions) - start_sessnum, 0)
5129
5130     def test_one_armed_nat44_static(self):
5131         """ One armed NAT44 and 1:1 NAPT asymmetrical rule """
5132         remote_host = self.pg4.remote_hosts[0]
5133         local_host = self.pg4.remote_hosts[1]
5134         external_port = 80
5135         local_port = 8080
5136         eh_port_in = 0
5137
5138         self.vapi.nat44_forwarding_enable_disable(1)
5139         self.nat44_add_address(self.nat_addr, twice_nat=1)
5140         self.nat44_add_static_mapping(local_host.ip4, self.nat_addr,
5141                                       local_port, external_port,
5142                                       proto=IP_PROTOS.tcp, out2in_only=1,
5143                                       twice_nat=1)
5144         self.vapi.nat44_interface_add_del_feature(self.pg4.sw_if_index)
5145         self.vapi.nat44_interface_add_del_feature(self.pg4.sw_if_index,
5146                                                   is_inside=0)
5147
5148         # from client to service
5149         p = (Ether(src=self.pg4.remote_mac, dst=self.pg4.local_mac) /
5150              IP(src=remote_host.ip4, dst=self.nat_addr) /
5151              TCP(sport=12345, dport=external_port))
5152         self.pg4.add_stream(p)
5153         self.pg_enable_capture(self.pg_interfaces)
5154         self.pg_start()
5155         capture = self.pg4.get_capture(1)
5156         p = capture[0]
5157         try:
5158             ip = p[IP]
5159             tcp = p[TCP]
5160             self.assertEqual(ip.dst, local_host.ip4)
5161             self.assertEqual(ip.src, self.nat_addr)
5162             self.assertEqual(tcp.dport, local_port)
5163             self.assertNotEqual(tcp.sport, 12345)
5164             eh_port_in = tcp.sport
5165             self.assert_packet_checksums_valid(p)
5166         except:
5167             self.logger.error(ppp("Unexpected or invalid packet:", p))
5168             raise
5169
5170         # from service back to client
5171         p = (Ether(src=self.pg4.remote_mac, dst=self.pg4.local_mac) /
5172              IP(src=local_host.ip4, dst=self.nat_addr) /
5173              TCP(sport=local_port, dport=eh_port_in))
5174         self.pg4.add_stream(p)
5175         self.pg_enable_capture(self.pg_interfaces)
5176         self.pg_start()
5177         capture = self.pg4.get_capture(1)
5178         p = capture[0]
5179         try:
5180             ip = p[IP]
5181             tcp = p[TCP]
5182             self.assertEqual(ip.src, self.nat_addr)
5183             self.assertEqual(ip.dst, remote_host.ip4)
5184             self.assertEqual(tcp.sport, external_port)
5185             self.assertEqual(tcp.dport, 12345)
5186             self.assert_packet_checksums_valid(p)
5187         except:
5188             self.logger.error(ppp("Unexpected or invalid packet:", p))
5189             raise
5190
5191     def test_static_with_port_out2(self):
5192         """ 1:1 NAPT asymmetrical rule """
5193
5194         external_port = 80
5195         local_port = 8080
5196
5197         self.vapi.nat44_forwarding_enable_disable(1)
5198         self.nat44_add_static_mapping(self.pg0.remote_ip4, self.nat_addr,
5199                                       local_port, external_port,
5200                                       proto=IP_PROTOS.tcp, out2in_only=1)
5201         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
5202         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
5203                                                   is_inside=0)
5204
5205         # from client to service
5206         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
5207              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
5208              TCP(sport=12345, dport=external_port))
5209         self.pg1.add_stream(p)
5210         self.pg_enable_capture(self.pg_interfaces)
5211         self.pg_start()
5212         capture = self.pg0.get_capture(1)
5213         p = capture[0]
5214         try:
5215             ip = p[IP]
5216             tcp = p[TCP]
5217             self.assertEqual(ip.dst, self.pg0.remote_ip4)
5218             self.assertEqual(tcp.dport, local_port)
5219             self.assert_packet_checksums_valid(p)
5220         except:
5221             self.logger.error(ppp("Unexpected or invalid packet:", p))
5222             raise
5223
5224         # ICMP error
5225         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
5226              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5227              ICMP(type=11) / capture[0][IP])
5228         self.pg0.add_stream(p)
5229         self.pg_enable_capture(self.pg_interfaces)
5230         self.pg_start()
5231         capture = self.pg1.get_capture(1)
5232         p = capture[0]
5233         try:
5234             self.assertEqual(p[IP].src, self.nat_addr)
5235             inner = p[IPerror]
5236             self.assertEqual(inner.dst, self.nat_addr)
5237             self.assertEqual(inner[TCPerror].dport, external_port)
5238         except:
5239             self.logger.error(ppp("Unexpected or invalid packet:", p))
5240             raise
5241
5242         # from service back to client
5243         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5244              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5245              TCP(sport=local_port, dport=12345))
5246         self.pg0.add_stream(p)
5247         self.pg_enable_capture(self.pg_interfaces)
5248         self.pg_start()
5249         capture = self.pg1.get_capture(1)
5250         p = capture[0]
5251         try:
5252             ip = p[IP]
5253             tcp = p[TCP]
5254             self.assertEqual(ip.src, self.nat_addr)
5255             self.assertEqual(tcp.sport, external_port)
5256             self.assert_packet_checksums_valid(p)
5257         except:
5258             self.logger.error(ppp("Unexpected or invalid packet:", p))
5259             raise
5260
5261         # ICMP error
5262         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
5263              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
5264              ICMP(type=11) / capture[0][IP])
5265         self.pg1.add_stream(p)
5266         self.pg_enable_capture(self.pg_interfaces)
5267         self.pg_start()
5268         capture = self.pg0.get_capture(1)
5269         p = capture[0]
5270         try:
5271             self.assertEqual(p[IP].dst, self.pg0.remote_ip4)
5272             inner = p[IPerror]
5273             self.assertEqual(inner.src, self.pg0.remote_ip4)
5274             self.assertEqual(inner[TCPerror].sport, local_port)
5275         except:
5276             self.logger.error(ppp("Unexpected or invalid packet:", p))
5277             raise
5278
5279         # from client to server (no translation)
5280         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
5281              IP(src=self.pg1.remote_ip4, dst=self.pg0.remote_ip4) /
5282              TCP(sport=12346, dport=local_port))
5283         self.pg1.add_stream(p)
5284         self.pg_enable_capture(self.pg_interfaces)
5285         self.pg_start()
5286         capture = self.pg0.get_capture(1)
5287         p = capture[0]
5288         try:
5289             ip = p[IP]
5290             tcp = p[TCP]
5291             self.assertEqual(ip.dst, self.pg0.remote_ip4)
5292             self.assertEqual(tcp.dport, local_port)
5293             self.assert_packet_checksums_valid(p)
5294         except:
5295             self.logger.error(ppp("Unexpected or invalid packet:", p))
5296             raise
5297
5298         # from service back to client (no translation)
5299         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5300              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5301              TCP(sport=local_port, dport=12346))
5302         self.pg0.add_stream(p)
5303         self.pg_enable_capture(self.pg_interfaces)
5304         self.pg_start()
5305         capture = self.pg1.get_capture(1)
5306         p = capture[0]
5307         try:
5308             ip = p[IP]
5309             tcp = p[TCP]
5310             self.assertEqual(ip.src, self.pg0.remote_ip4)
5311             self.assertEqual(tcp.sport, local_port)
5312             self.assert_packet_checksums_valid(p)
5313         except:
5314             self.logger.error(ppp("Unexpected or invalid packet:", p))
5315             raise
5316
5317     def test_output_feature(self):
5318         """ NAT44 interface output feature (in2out postrouting) """
5319         self.vapi.nat44_forwarding_enable_disable(1)
5320         self.nat44_add_address(self.nat_addr)
5321         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index,
5322                                                   is_inside=0)
5323         self.vapi.nat44_interface_add_del_output_feature(self.pg1.sw_if_index,
5324                                                          is_inside=0)
5325
5326         # in2out
5327         pkts = self.create_stream_in(self.pg0, self.pg1)
5328         self.pg0.add_stream(pkts)
5329         self.pg_enable_capture(self.pg_interfaces)
5330         self.pg_start()
5331         capture = self.pg1.get_capture(len(pkts))
5332         self.verify_capture_out(capture)
5333
5334         # out2in
5335         pkts = self.create_stream_out(self.pg1)
5336         self.pg1.add_stream(pkts)
5337         self.pg_enable_capture(self.pg_interfaces)
5338         self.pg_start()
5339         capture = self.pg0.get_capture(len(pkts))
5340         self.verify_capture_in(capture, self.pg0)
5341
5342     def test_multiple_vrf(self):
5343         """ Multiple VRF setup """
5344         external_addr = '1.2.3.4'
5345         external_port = 80
5346         local_port = 8080
5347         port = 0
5348
5349         self.vapi.nat44_forwarding_enable_disable(1)
5350         self.nat44_add_address(self.nat_addr)
5351         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
5352         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index,
5353                                                   is_inside=0)
5354         self.vapi.nat44_interface_add_del_output_feature(self.pg1.sw_if_index,
5355                                                          is_inside=0)
5356         self.vapi.nat44_interface_add_del_feature(self.pg5.sw_if_index)
5357         self.vapi.nat44_interface_add_del_feature(self.pg5.sw_if_index,
5358                                                   is_inside=0)
5359         self.vapi.nat44_interface_add_del_feature(self.pg6.sw_if_index,
5360                                                   is_inside=0)
5361         self.nat44_add_static_mapping(self.pg5.remote_ip4, external_addr,
5362                                       local_port, external_port, vrf_id=1,
5363                                       proto=IP_PROTOS.tcp, out2in_only=1)
5364         self.nat44_add_static_mapping(
5365              self.pg0.remote_ip4, external_sw_if_index=self.pg0.sw_if_index,
5366              local_port=local_port, vrf_id=0, external_port=external_port,
5367              proto=IP_PROTOS.tcp, out2in_only=1)
5368
5369         # from client to service (both VRF1)
5370         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
5371              IP(src=self.pg6.remote_ip4, dst=external_addr) /
5372              TCP(sport=12345, dport=external_port))
5373         self.pg6.add_stream(p)
5374         self.pg_enable_capture(self.pg_interfaces)
5375         self.pg_start()
5376         capture = self.pg5.get_capture(1)
5377         p = capture[0]
5378         try:
5379             ip = p[IP]
5380             tcp = p[TCP]
5381             self.assertEqual(ip.dst, self.pg5.remote_ip4)
5382             self.assertEqual(tcp.dport, local_port)
5383             self.assert_packet_checksums_valid(p)
5384         except:
5385             self.logger.error(ppp("Unexpected or invalid packet:", p))
5386             raise
5387
5388         # from service back to client (both VRF1)
5389         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
5390              IP(src=self.pg5.remote_ip4, dst=self.pg6.remote_ip4) /
5391              TCP(sport=local_port, dport=12345))
5392         self.pg5.add_stream(p)
5393         self.pg_enable_capture(self.pg_interfaces)
5394         self.pg_start()
5395         capture = self.pg6.get_capture(1)
5396         p = capture[0]
5397         try:
5398             ip = p[IP]
5399             tcp = p[TCP]
5400             self.assertEqual(ip.src, external_addr)
5401             self.assertEqual(tcp.sport, external_port)
5402             self.assert_packet_checksums_valid(p)
5403         except:
5404             self.logger.error(ppp("Unexpected or invalid packet:", p))
5405             raise
5406
5407         # dynamic NAT from VRF1 to VRF0 (output-feature)
5408         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
5409              IP(src=self.pg5.remote_ip4, dst=self.pg1.remote_ip4) /
5410              TCP(sport=2345, dport=22))
5411         self.pg5.add_stream(p)
5412         self.pg_enable_capture(self.pg_interfaces)
5413         self.pg_start()
5414         capture = self.pg1.get_capture(1)
5415         p = capture[0]
5416         try:
5417             ip = p[IP]
5418             tcp = p[TCP]
5419             self.assertEqual(ip.src, self.nat_addr)
5420             self.assertNotEqual(tcp.sport, 2345)
5421             self.assert_packet_checksums_valid(p)
5422             port = tcp.sport
5423         except:
5424             self.logger.error(ppp("Unexpected or invalid packet:", p))
5425             raise
5426
5427         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
5428              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
5429              TCP(sport=22, dport=port))
5430         self.pg1.add_stream(p)
5431         self.pg_enable_capture(self.pg_interfaces)
5432         self.pg_start()
5433         capture = self.pg5.get_capture(1)
5434         p = capture[0]
5435         try:
5436             ip = p[IP]
5437             tcp = p[TCP]
5438             self.assertEqual(ip.dst, self.pg5.remote_ip4)
5439             self.assertEqual(tcp.dport, 2345)
5440             self.assert_packet_checksums_valid(p)
5441         except:
5442             self.logger.error(ppp("Unexpected or invalid packet:", p))
5443             raise
5444
5445         # from client VRF1 to service VRF0
5446         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
5447              IP(src=self.pg6.remote_ip4, dst=self.pg0.local_ip4) /
5448              TCP(sport=12346, dport=external_port))
5449         self.pg6.add_stream(p)
5450         self.pg_enable_capture(self.pg_interfaces)
5451         self.pg_start()
5452         capture = self.pg0.get_capture(1)
5453         p = capture[0]
5454         try:
5455             ip = p[IP]
5456             tcp = p[TCP]
5457             self.assertEqual(ip.dst, self.pg0.remote_ip4)
5458             self.assertEqual(tcp.dport, local_port)
5459             self.assert_packet_checksums_valid(p)
5460         except:
5461             self.logger.error(ppp("Unexpected or invalid packet:", p))
5462             raise
5463
5464         # from service VRF0 back to client VRF1
5465         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5466              IP(src=self.pg0.remote_ip4, dst=self.pg6.remote_ip4) /
5467              TCP(sport=local_port, dport=12346))
5468         self.pg0.add_stream(p)
5469         self.pg_enable_capture(self.pg_interfaces)
5470         self.pg_start()
5471         capture = self.pg6.get_capture(1)
5472         p = capture[0]
5473         try:
5474             ip = p[IP]
5475             tcp = p[TCP]
5476             self.assertEqual(ip.src, self.pg0.local_ip4)
5477             self.assertEqual(tcp.sport, external_port)
5478             self.assert_packet_checksums_valid(p)
5479         except:
5480             self.logger.error(ppp("Unexpected or invalid packet:", p))
5481             raise
5482
5483         # from client VRF0 to service VRF1
5484         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5485              IP(src=self.pg0.remote_ip4, dst=external_addr) /
5486              TCP(sport=12347, dport=external_port))
5487         self.pg0.add_stream(p)
5488         self.pg_enable_capture(self.pg_interfaces)
5489         self.pg_start()
5490         capture = self.pg5.get_capture(1)
5491         p = capture[0]
5492         try:
5493             ip = p[IP]
5494             tcp = p[TCP]
5495             self.assertEqual(ip.dst, self.pg5.remote_ip4)
5496             self.assertEqual(tcp.dport, local_port)
5497             self.assert_packet_checksums_valid(p)
5498         except:
5499             self.logger.error(ppp("Unexpected or invalid packet:", p))
5500             raise
5501
5502         # from service VRF1 back to client VRF0
5503         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
5504              IP(src=self.pg5.remote_ip4, dst=self.pg0.remote_ip4) /
5505              TCP(sport=local_port, dport=12347))
5506         self.pg5.add_stream(p)
5507         self.pg_enable_capture(self.pg_interfaces)
5508         self.pg_start()
5509         capture = self.pg0.get_capture(1)
5510         p = capture[0]
5511         try:
5512             ip = p[IP]
5513             tcp = p[TCP]
5514             self.assertEqual(ip.src, external_addr)
5515             self.assertEqual(tcp.sport, external_port)
5516             self.assert_packet_checksums_valid(p)
5517         except:
5518             self.logger.error(ppp("Unexpected or invalid packet:", p))
5519             raise
5520
5521         # from client to server (both VRF1, no translation)
5522         p = (Ether(src=self.pg6.remote_mac, dst=self.pg6.local_mac) /
5523              IP(src=self.pg6.remote_ip4, dst=self.pg5.remote_ip4) /
5524              TCP(sport=12348, dport=local_port))
5525         self.pg6.add_stream(p)
5526         self.pg_enable_capture(self.pg_interfaces)
5527         self.pg_start()
5528         capture = self.pg5.get_capture(1)
5529         p = capture[0]
5530         try:
5531             ip = p[IP]
5532             tcp = p[TCP]
5533             self.assertEqual(ip.dst, self.pg5.remote_ip4)
5534             self.assertEqual(tcp.dport, local_port)
5535             self.assert_packet_checksums_valid(p)
5536         except:
5537             self.logger.error(ppp("Unexpected or invalid packet:", p))
5538             raise
5539
5540         # from server back to client (both VRF1, no translation)
5541         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
5542              IP(src=self.pg5.remote_ip4, dst=self.pg6.remote_ip4) /
5543              TCP(sport=local_port, dport=12348))
5544         self.pg5.add_stream(p)
5545         self.pg_enable_capture(self.pg_interfaces)
5546         self.pg_start()
5547         capture = self.pg6.get_capture(1)
5548         p = capture[0]
5549         try:
5550             ip = p[IP]
5551             tcp = p[TCP]
5552             self.assertEqual(ip.src, self.pg5.remote_ip4)
5553             self.assertEqual(tcp.sport, local_port)
5554             self.assert_packet_checksums_valid(p)
5555         except:
5556             self.logger.error(ppp("Unexpected or invalid packet:", p))
5557             raise
5558
5559         # from client VRF1 to server VRF0 (no translation)
5560         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5561              IP(src=self.pg0.remote_ip4, dst=self.pg6.remote_ip4) /
5562              TCP(sport=local_port, dport=12349))
5563         self.pg0.add_stream(p)
5564         self.pg_enable_capture(self.pg_interfaces)
5565         self.pg_start()
5566         capture = self.pg6.get_capture(1)
5567         p = capture[0]
5568         try:
5569             ip = p[IP]
5570             tcp = p[TCP]
5571             self.assertEqual(ip.src, self.pg0.remote_ip4)
5572             self.assertEqual(tcp.sport, local_port)
5573             self.assert_packet_checksums_valid(p)
5574         except:
5575             self.logger.error(ppp("Unexpected or invalid packet:", p))
5576             raise
5577
5578         # from server VRF0 back to client VRF1 (no translation)
5579         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5580              IP(src=self.pg0.remote_ip4, dst=self.pg6.remote_ip4) /
5581              TCP(sport=local_port, dport=12349))
5582         self.pg0.add_stream(p)
5583         self.pg_enable_capture(self.pg_interfaces)
5584         self.pg_start()
5585         capture = self.pg6.get_capture(1)
5586         p = capture[0]
5587         try:
5588             ip = p[IP]
5589             tcp = p[TCP]
5590             self.assertEqual(ip.src, self.pg0.remote_ip4)
5591             self.assertEqual(tcp.sport, local_port)
5592             self.assert_packet_checksums_valid(p)
5593         except:
5594             self.logger.error(ppp("Unexpected or invalid packet:", p))
5595             raise
5596
5597         # from client VRF0 to server VRF1 (no translation)
5598         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5599              IP(src=self.pg0.remote_ip4, dst=self.pg5.remote_ip4) /
5600              TCP(sport=12344, dport=local_port))
5601         self.pg0.add_stream(p)
5602         self.pg_enable_capture(self.pg_interfaces)
5603         self.pg_start()
5604         capture = self.pg5.get_capture(1)
5605         p = capture[0]
5606         try:
5607             ip = p[IP]
5608             tcp = p[TCP]
5609             self.assertEqual(ip.dst, self.pg5.remote_ip4)
5610             self.assertEqual(tcp.dport, local_port)
5611             self.assert_packet_checksums_valid(p)
5612         except:
5613             self.logger.error(ppp("Unexpected or invalid packet:", p))
5614             raise
5615
5616         # from server VRF1 back to client VRF0 (no translation)
5617         p = (Ether(src=self.pg5.remote_mac, dst=self.pg5.local_mac) /
5618              IP(src=self.pg5.remote_ip4, dst=self.pg0.remote_ip4) /
5619              TCP(sport=local_port, dport=12344))
5620         self.pg5.add_stream(p)
5621         self.pg_enable_capture(self.pg_interfaces)
5622         self.pg_start()
5623         capture = self.pg0.get_capture(1)
5624         p = capture[0]
5625         try:
5626             ip = p[IP]
5627             tcp = p[TCP]
5628             self.assertEqual(ip.src, self.pg5.remote_ip4)
5629             self.assertEqual(tcp.sport, local_port)
5630             self.assert_packet_checksums_valid(p)
5631         except:
5632             self.logger.error(ppp("Unexpected or invalid packet:", p))
5633             raise
5634
5635     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
5636     def test_session_timeout(self):
5637         """ NAT44 session timeouts """
5638         self.nat44_add_address(self.nat_addr)
5639         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
5640         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
5641                                                   is_inside=0)
5642         self.vapi.nat_set_timeouts(icmp=5)
5643
5644         max_sessions = 1000
5645         pkts = []
5646         for i in range(0, max_sessions):
5647             src = "10.10.%u.%u" % ((i & 0xFF00) >> 8, i & 0xFF)
5648             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
5649                  IP(src=src, dst=self.pg1.remote_ip4) /
5650                  ICMP(id=1025, type='echo-request'))
5651             pkts.append(p)
5652         self.pg0.add_stream(pkts)
5653         self.pg_enable_capture(self.pg_interfaces)
5654         self.pg_start()
5655         self.pg1.get_capture(max_sessions)
5656
5657         sleep(10)
5658
5659         pkts = []
5660         for i in range(0, max_sessions):
5661             src = "10.10.%u.%u" % ((i & 0xFF00) >> 8, i & 0xFF)
5662             p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
5663                  IP(src=src, dst=self.pg1.remote_ip4) /
5664                  ICMP(id=1026, type='echo-request'))
5665             pkts.append(p)
5666         self.pg0.add_stream(pkts)
5667         self.pg_enable_capture(self.pg_interfaces)
5668         self.pg_start()
5669         self.pg1.get_capture(max_sessions)
5670
5671         nsessions = 0
5672         users = self.vapi.nat44_user_dump()
5673         for user in users:
5674             nsessions = nsessions + user.nsessions
5675         self.assertLess(nsessions, 2 * max_sessions)
5676
5677     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
5678     def test_session_limit_per_user(self):
5679         """ Maximum sessions per user limit """
5680         self.nat44_add_address(self.nat_addr)
5681         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
5682         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
5683                                                   is_inside=0)
5684         self.vapi.set_ipfix_exporter(collector_address=self.pg2.remote_ip4n,
5685                                      src_address=self.pg2.local_ip4n,
5686                                      path_mtu=512,
5687                                      template_interval=10)
5688         self.vapi.nat_set_timeouts(udp=5)
5689
5690         # get maximum number of translations per user
5691         nat44_config = self.vapi.nat_show_config()
5692
5693         pkts = []
5694         for port in range(0, nat44_config.max_translations_per_user):
5695             p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5696                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5697                  UDP(sport=1025 + port, dport=1025 + port))
5698             pkts.append(p)
5699
5700         self.pg0.add_stream(pkts)
5701         self.pg_enable_capture(self.pg_interfaces)
5702         self.pg_start()
5703         capture = self.pg1.get_capture(len(pkts))
5704
5705         self.vapi.nat_ipfix(domain_id=self.ipfix_domain_id,
5706                             src_port=self.ipfix_src_port)
5707
5708         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5709              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5710              UDP(sport=3001, dport=3002))
5711         self.pg0.add_stream(p)
5712         self.pg_enable_capture(self.pg_interfaces)
5713         self.pg_start()
5714         capture = self.pg1.assert_nothing_captured()
5715
5716         # verify IPFIX logging
5717         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
5718         sleep(1)
5719         capture = self.pg2.get_capture(10)
5720         ipfix = IPFIXDecoder()
5721         # first load template
5722         for p in capture:
5723             self.assertTrue(p.haslayer(IPFIX))
5724             if p.haslayer(Template):
5725                 ipfix.add_template(p.getlayer(Template))
5726         # verify events in data set
5727         for p in capture:
5728             if p.haslayer(Data):
5729                 data = ipfix.decode_data_set(p.getlayer(Set))
5730                 self.verify_ipfix_max_entries_per_user(
5731                     data,
5732                     nat44_config.max_translations_per_user,
5733                     self.pg0.remote_ip4n)
5734
5735         sleep(6)
5736         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
5737              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
5738              UDP(sport=3001, dport=3002))
5739         self.pg0.add_stream(p)
5740         self.pg_enable_capture(self.pg_interfaces)
5741         self.pg_start()
5742         self.pg1.get_capture(1)
5743
5744     def tearDown(self):
5745         super(TestNAT44EndpointDependent, self).tearDown()
5746         if not self.vpp_dead:
5747             self.logger.info(self.vapi.cli("show nat44 addresses"))
5748             self.logger.info(self.vapi.cli("show nat44 interfaces"))
5749             self.logger.info(self.vapi.cli("show nat44 static mappings"))
5750             self.logger.info(self.vapi.cli("show nat44 interface address"))
5751             self.logger.info(self.vapi.cli("show nat44 sessions detail"))
5752             self.logger.info(self.vapi.cli("show nat44 hash tables detail"))
5753             self.logger.info(self.vapi.cli("show nat timeouts"))
5754             self.clear_nat44()
5755             self.vapi.cli("clear logging")
5756
5757
5758 class TestNAT44Out2InDPO(MethodHolder):
5759     """ NAT44 Test Cases using out2in DPO """
5760
5761     @classmethod
5762     def setUpConstants(cls):
5763         super(TestNAT44Out2InDPO, cls).setUpConstants()
5764         cls.vpp_cmdline.extend(["nat", "{", "out2in dpo", "}"])
5765
5766     @classmethod
5767     def setUpClass(cls):
5768         super(TestNAT44Out2InDPO, cls).setUpClass()
5769         cls.vapi.cli("set log class nat level debug")
5770
5771         try:
5772             cls.tcp_port_in = 6303
5773             cls.tcp_port_out = 6303
5774             cls.udp_port_in = 6304
5775             cls.udp_port_out = 6304
5776             cls.icmp_id_in = 6305
5777             cls.icmp_id_out = 6305
5778             cls.nat_addr = '10.0.0.3'
5779             cls.nat_addr_n = socket.inet_pton(socket.AF_INET, cls.nat_addr)
5780             cls.dst_ip4 = '192.168.70.1'
5781
5782             cls.create_pg_interfaces(range(2))
5783
5784             cls.pg0.admin_up()
5785             cls.pg0.config_ip4()
5786             cls.pg0.resolve_arp()
5787
5788             cls.pg1.admin_up()
5789             cls.pg1.config_ip6()
5790             cls.pg1.resolve_ndp()
5791
5792             cls.vapi.ip_add_del_route(is_ipv6=True, dst_address='\x00'*16,
5793                                       dst_address_length=0,
5794                                       next_hop_address=cls.pg1.remote_ip6n,
5795                                       next_hop_sw_if_index=cls.pg1.sw_if_index)
5796
5797         except Exception:
5798             super(TestNAT44Out2InDPO, cls).tearDownClass()
5799             raise
5800
5801     def configure_xlat(self):
5802         self.dst_ip6_pfx = '1:2:3::'
5803         self.dst_ip6_pfx_n = socket.inet_pton(socket.AF_INET6,
5804                                               self.dst_ip6_pfx)
5805         self.dst_ip6_pfx_len = 96
5806         self.src_ip6_pfx = '4:5:6::'
5807         self.src_ip6_pfx_n = socket.inet_pton(socket.AF_INET6,
5808                                               self.src_ip6_pfx)
5809         self.src_ip6_pfx_len = 96
5810         self.vapi.map_add_domain(self.dst_ip6_pfx_n, self.dst_ip6_pfx_len,
5811                                  self.src_ip6_pfx_n, self.src_ip6_pfx_len,
5812                                  '\x00\x00\x00\x00', 0, is_translation=1,
5813                                  is_rfc6052=1)
5814
5815     def test_464xlat_ce(self):
5816         """ Test 464XLAT CE with NAT44 """
5817
5818         nat_config = self.vapi.nat_show_config()
5819         self.assertEqual(1, nat_config.out2in_dpo)
5820
5821         self.configure_xlat()
5822
5823         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
5824         self.vapi.nat44_add_del_address_range(self.nat_addr_n, self.nat_addr_n)
5825
5826         out_src_ip6 = self.compose_ip6(self.dst_ip4, self.dst_ip6_pfx,
5827                                        self.dst_ip6_pfx_len)
5828         out_dst_ip6 = self.compose_ip6(self.nat_addr, self.src_ip6_pfx,
5829                                        self.src_ip6_pfx_len)
5830
5831         try:
5832             pkts = self.create_stream_in(self.pg0, self.pg1, self.dst_ip4)
5833             self.pg0.add_stream(pkts)
5834             self.pg_enable_capture(self.pg_interfaces)
5835             self.pg_start()
5836             capture = self.pg1.get_capture(len(pkts))
5837             self.verify_capture_out_ip6(capture, nat_ip=out_dst_ip6,
5838                                         dst_ip=out_src_ip6)
5839
5840             pkts = self.create_stream_out_ip6(self.pg1, out_src_ip6,
5841                                               out_dst_ip6)
5842             self.pg1.add_stream(pkts)
5843             self.pg_enable_capture(self.pg_interfaces)
5844             self.pg_start()
5845             capture = self.pg0.get_capture(len(pkts))
5846             self.verify_capture_in(capture, self.pg0)
5847         finally:
5848             self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index,
5849                                                       is_add=0)
5850             self.vapi.nat44_add_del_address_range(self.nat_addr_n,
5851                                                   self.nat_addr_n, is_add=0)
5852
5853     def test_464xlat_ce_no_nat(self):
5854         """ Test 464XLAT CE without NAT44 """
5855
5856         self.configure_xlat()
5857
5858         out_src_ip6 = self.compose_ip6(self.dst_ip4, self.dst_ip6_pfx,
5859                                        self.dst_ip6_pfx_len)
5860         out_dst_ip6 = self.compose_ip6(self.pg0.remote_ip4, self.src_ip6_pfx,
5861                                        self.src_ip6_pfx_len)
5862
5863         pkts = self.create_stream_in(self.pg0, self.pg1, self.dst_ip4)
5864         self.pg0.add_stream(pkts)
5865         self.pg_enable_capture(self.pg_interfaces)
5866         self.pg_start()
5867         capture = self.pg1.get_capture(len(pkts))
5868         self.verify_capture_out_ip6(capture, dst_ip=out_src_ip6,
5869                                     nat_ip=out_dst_ip6, same_port=True)
5870
5871         pkts = self.create_stream_out_ip6(self.pg1, out_src_ip6, out_dst_ip6)
5872         self.pg1.add_stream(pkts)
5873         self.pg_enable_capture(self.pg_interfaces)
5874         self.pg_start()
5875         capture = self.pg0.get_capture(len(pkts))
5876         self.verify_capture_in(capture, self.pg0)
5877
5878
5879 class TestDeterministicNAT(MethodHolder):
5880     """ Deterministic NAT Test Cases """
5881
5882     @classmethod
5883     def setUpConstants(cls):
5884         super(TestDeterministicNAT, cls).setUpConstants()
5885         cls.vpp_cmdline.extend(["nat", "{", "deterministic", "}"])
5886
5887     @classmethod
5888     def setUpClass(cls):
5889         super(TestDeterministicNAT, cls).setUpClass()
5890         cls.vapi.cli("set log class nat level debug")
5891
5892         try:
5893             cls.tcp_port_in = 6303
5894             cls.tcp_external_port = 6303
5895             cls.udp_port_in = 6304
5896             cls.udp_external_port = 6304
5897             cls.icmp_id_in = 6305
5898             cls.nat_addr = '10.0.0.3'
5899
5900             cls.create_pg_interfaces(range(3))
5901             cls.interfaces = list(cls.pg_interfaces)
5902
5903             for i in cls.interfaces:
5904                 i.admin_up()
5905                 i.config_ip4()
5906                 i.resolve_arp()
5907
5908             cls.pg0.generate_remote_hosts(2)
5909             cls.pg0.configure_ipv4_neighbors()
5910
5911         except Exception:
5912             super(TestDeterministicNAT, cls).tearDownClass()
5913             raise
5914
5915     def create_stream_in(self, in_if, out_if, ttl=64):
5916         """
5917         Create packet stream for inside network
5918
5919         :param in_if: Inside interface
5920         :param out_if: Outside interface
5921         :param ttl: TTL of generated packets
5922         """
5923         pkts = []
5924         # TCP
5925         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
5926              IP(src=in_if.remote_ip4, dst=out_if.remote_ip4, ttl=ttl) /
5927              TCP(sport=self.tcp_port_in, dport=self.tcp_external_port))
5928         pkts.append(p)
5929
5930         # UDP
5931         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
5932              IP(src=in_if.remote_ip4, dst=out_if.remote_ip4, ttl=ttl) /
5933              UDP(sport=self.udp_port_in, dport=self.udp_external_port))
5934         pkts.append(p)
5935
5936         # ICMP
5937         p = (Ether(dst=in_if.local_mac, src=in_if.remote_mac) /
5938              IP(src=in_if.remote_ip4, dst=out_if.remote_ip4, ttl=ttl) /
5939              ICMP(id=self.icmp_id_in, type='echo-request'))
5940         pkts.append(p)
5941
5942         return pkts
5943
5944     def create_stream_out(self, out_if, dst_ip=None, ttl=64):
5945         """
5946         Create packet stream for outside network
5947
5948         :param out_if: Outside interface
5949         :param dst_ip: Destination IP address (Default use global NAT address)
5950         :param ttl: TTL of generated packets
5951         """
5952         if dst_ip is None:
5953             dst_ip = self.nat_addr
5954         pkts = []
5955         # TCP
5956         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
5957              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
5958              TCP(dport=self.tcp_port_out, sport=self.tcp_external_port))
5959         pkts.append(p)
5960
5961         # UDP
5962         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
5963              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
5964              UDP(dport=self.udp_port_out, sport=self.udp_external_port))
5965         pkts.append(p)
5966
5967         # ICMP
5968         p = (Ether(dst=out_if.local_mac, src=out_if.remote_mac) /
5969              IP(src=out_if.remote_ip4, dst=dst_ip, ttl=ttl) /
5970              ICMP(id=self.icmp_external_id, type='echo-reply'))
5971         pkts.append(p)
5972
5973         return pkts
5974
5975     def verify_capture_out(self, capture, nat_ip=None):
5976         """
5977         Verify captured packets on outside network
5978
5979         :param capture: Captured packets
5980         :param nat_ip: Translated IP address (Default use global NAT address)
5981         :param same_port: Sorce port number is not translated (Default False)
5982         """
5983         if nat_ip is None:
5984             nat_ip = self.nat_addr
5985         for packet in capture:
5986             try:
5987                 self.assertEqual(packet[IP].src, nat_ip)
5988                 if packet.haslayer(TCP):
5989                     self.tcp_port_out = packet[TCP].sport
5990                 elif packet.haslayer(UDP):
5991                     self.udp_port_out = packet[UDP].sport
5992                 else:
5993                     self.icmp_external_id = packet[ICMP].id
5994             except:
5995                 self.logger.error(ppp("Unexpected or invalid packet "
5996                                       "(outside network):", packet))
5997                 raise
5998
5999     def test_deterministic_mode(self):
6000         """ NAT plugin run deterministic mode """
6001         in_addr = '172.16.255.0'
6002         out_addr = '172.17.255.50'
6003         in_addr_t = '172.16.255.20'
6004         in_addr_n = socket.inet_aton(in_addr)
6005         out_addr_n = socket.inet_aton(out_addr)
6006         in_addr_t_n = socket.inet_aton(in_addr_t)
6007         in_plen = 24
6008         out_plen = 32
6009
6010         nat_config = self.vapi.nat_show_config()
6011         self.assertEqual(1, nat_config.deterministic)
6012
6013         self.vapi.nat_det_add_del_map(in_addr_n, in_plen, out_addr_n, out_plen)
6014
6015         rep1 = self.vapi.nat_det_forward(in_addr_t_n)
6016         self.assertEqual(rep1.out_addr[:4], out_addr_n)
6017         rep2 = self.vapi.nat_det_reverse(out_addr_n, rep1.out_port_hi)
6018         self.assertEqual(rep2.in_addr[:4], in_addr_t_n)
6019
6020         deterministic_mappings = self.vapi.nat_det_map_dump()
6021         self.assertEqual(len(deterministic_mappings), 1)
6022         dsm = deterministic_mappings[0]
6023         self.assertEqual(in_addr_n, dsm.in_addr[:4])
6024         self.assertEqual(in_plen, dsm.in_plen)
6025         self.assertEqual(out_addr_n, dsm.out_addr[:4])
6026         self.assertEqual(out_plen, dsm.out_plen)
6027
6028         self.clear_nat_det()
6029         deterministic_mappings = self.vapi.nat_det_map_dump()
6030         self.assertEqual(len(deterministic_mappings), 0)
6031
6032     def test_set_timeouts(self):
6033         """ Set deterministic NAT timeouts """
6034         timeouts_before = self.vapi.nat_get_timeouts()
6035
6036         self.vapi.nat_set_timeouts(timeouts_before.udp + 10,
6037                                    timeouts_before.tcp_established + 10,
6038                                    timeouts_before.tcp_transitory + 10,
6039                                    timeouts_before.icmp + 10)
6040
6041         timeouts_after = self.vapi.nat_get_timeouts()
6042
6043         self.assertNotEqual(timeouts_before.udp, timeouts_after.udp)
6044         self.assertNotEqual(timeouts_before.icmp, timeouts_after.icmp)
6045         self.assertNotEqual(timeouts_before.tcp_established,
6046                             timeouts_after.tcp_established)
6047         self.assertNotEqual(timeouts_before.tcp_transitory,
6048                             timeouts_after.tcp_transitory)
6049
6050     def test_det_in(self):
6051         """ Deterministic NAT translation test (TCP, UDP, ICMP) """
6052
6053         nat_ip = "10.0.0.10"
6054
6055         self.vapi.nat_det_add_del_map(self.pg0.remote_ip4n,
6056                                       32,
6057                                       socket.inet_aton(nat_ip),
6058                                       32)
6059         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
6060         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
6061                                                   is_inside=0)
6062
6063         # in2out
6064         pkts = self.create_stream_in(self.pg0, self.pg1)
6065         self.pg0.add_stream(pkts)
6066         self.pg_enable_capture(self.pg_interfaces)
6067         self.pg_start()
6068         capture = self.pg1.get_capture(len(pkts))
6069         self.verify_capture_out(capture, nat_ip)
6070
6071         # out2in
6072         pkts = self.create_stream_out(self.pg1, nat_ip)
6073         self.pg1.add_stream(pkts)
6074         self.pg_enable_capture(self.pg_interfaces)
6075         self.pg_start()
6076         capture = self.pg0.get_capture(len(pkts))
6077         self.verify_capture_in(capture, self.pg0)
6078
6079         # session dump test
6080         sessions = self.vapi.nat_det_session_dump(self.pg0.remote_ip4n)
6081         self.assertEqual(len(sessions), 3)
6082
6083         # TCP session
6084         s = sessions[0]
6085         self.assertEqual(s.ext_addr[:4], self.pg1.remote_ip4n)
6086         self.assertEqual(s.in_port, self.tcp_port_in)
6087         self.assertEqual(s.out_port, self.tcp_port_out)
6088         self.assertEqual(s.ext_port, self.tcp_external_port)
6089
6090         # UDP session
6091         s = sessions[1]
6092         self.assertEqual(s.ext_addr[:4], self.pg1.remote_ip4n)
6093         self.assertEqual(s.in_port, self.udp_port_in)
6094         self.assertEqual(s.out_port, self.udp_port_out)
6095         self.assertEqual(s.ext_port, self.udp_external_port)
6096
6097         # ICMP session
6098         s = sessions[2]
6099         self.assertEqual(s.ext_addr[:4], self.pg1.remote_ip4n)
6100         self.assertEqual(s.in_port, self.icmp_id_in)
6101         self.assertEqual(s.out_port, self.icmp_external_id)
6102
6103     def test_multiple_users(self):
6104         """ Deterministic NAT multiple users """
6105
6106         nat_ip = "10.0.0.10"
6107         port_in = 80
6108         external_port = 6303
6109
6110         host0 = self.pg0.remote_hosts[0]
6111         host1 = self.pg0.remote_hosts[1]
6112
6113         self.vapi.nat_det_add_del_map(host0.ip4n,
6114                                       24,
6115                                       socket.inet_aton(nat_ip),
6116                                       32)
6117         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
6118         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
6119                                                   is_inside=0)
6120
6121         # host0 to out
6122         p = (Ether(src=host0.mac, dst=self.pg0.local_mac) /
6123              IP(src=host0.ip4, dst=self.pg1.remote_ip4) /
6124              TCP(sport=port_in, dport=external_port))
6125         self.pg0.add_stream(p)
6126         self.pg_enable_capture(self.pg_interfaces)
6127         self.pg_start()
6128         capture = self.pg1.get_capture(1)
6129         p = capture[0]
6130         try:
6131             ip = p[IP]
6132             tcp = p[TCP]
6133             self.assertEqual(ip.src, nat_ip)
6134             self.assertEqual(ip.dst, self.pg1.remote_ip4)
6135             self.assertEqual(tcp.dport, external_port)
6136             port_out0 = tcp.sport
6137         except:
6138             self.logger.error(ppp("Unexpected or invalid packet:", p))
6139             raise
6140
6141         # host1 to out
6142         p = (Ether(src=host1.mac, dst=self.pg0.local_mac) /
6143              IP(src=host1.ip4, dst=self.pg1.remote_ip4) /
6144              TCP(sport=port_in, dport=external_port))
6145         self.pg0.add_stream(p)
6146         self.pg_enable_capture(self.pg_interfaces)
6147         self.pg_start()
6148         capture = self.pg1.get_capture(1)
6149         p = capture[0]
6150         try:
6151             ip = p[IP]
6152             tcp = p[TCP]
6153             self.assertEqual(ip.src, nat_ip)
6154             self.assertEqual(ip.dst, self.pg1.remote_ip4)
6155             self.assertEqual(tcp.dport, external_port)
6156             port_out1 = tcp.sport
6157         except:
6158             self.logger.error(ppp("Unexpected or invalid packet:", p))
6159             raise
6160
6161         dms = self.vapi.nat_det_map_dump()
6162         self.assertEqual(1, len(dms))
6163         self.assertEqual(2, dms[0].ses_num)
6164
6165         # out to host0
6166         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
6167              IP(src=self.pg1.remote_ip4, dst=nat_ip) /
6168              TCP(sport=external_port, dport=port_out0))
6169         self.pg1.add_stream(p)
6170         self.pg_enable_capture(self.pg_interfaces)
6171         self.pg_start()
6172         capture = self.pg0.get_capture(1)
6173         p = capture[0]
6174         try:
6175             ip = p[IP]
6176             tcp = p[TCP]
6177             self.assertEqual(ip.src, self.pg1.remote_ip4)
6178             self.assertEqual(ip.dst, host0.ip4)
6179             self.assertEqual(tcp.dport, port_in)
6180             self.assertEqual(tcp.sport, external_port)
6181         except:
6182             self.logger.error(ppp("Unexpected or invalid packet:", p))
6183             raise
6184
6185         # out to host1
6186         p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
6187              IP(src=self.pg1.remote_ip4, dst=nat_ip) /
6188              TCP(sport=external_port, dport=port_out1))
6189         self.pg1.add_stream(p)
6190         self.pg_enable_capture(self.pg_interfaces)
6191         self.pg_start()
6192         capture = self.pg0.get_capture(1)
6193         p = capture[0]
6194         try:
6195             ip = p[IP]
6196             tcp = p[TCP]
6197             self.assertEqual(ip.src, self.pg1.remote_ip4)
6198             self.assertEqual(ip.dst, host1.ip4)
6199             self.assertEqual(tcp.dport, port_in)
6200             self.assertEqual(tcp.sport, external_port)
6201         except:
6202             self.logger.error(ppp("Unexpected or invalid packet", p))
6203             raise
6204
6205         # session close api test
6206         self.vapi.nat_det_close_session_out(socket.inet_aton(nat_ip),
6207                                             port_out1,
6208                                             self.pg1.remote_ip4n,
6209                                             external_port)
6210         dms = self.vapi.nat_det_map_dump()
6211         self.assertEqual(dms[0].ses_num, 1)
6212
6213         self.vapi.nat_det_close_session_in(host0.ip4n,
6214                                            port_in,
6215                                            self.pg1.remote_ip4n,
6216                                            external_port)
6217         dms = self.vapi.nat_det_map_dump()
6218         self.assertEqual(dms[0].ses_num, 0)
6219
6220     def test_tcp_session_close_detection_in(self):
6221         """ Deterministic NAT TCP session close from inside network """
6222         self.vapi.nat_det_add_del_map(self.pg0.remote_ip4n,
6223                                       32,
6224                                       socket.inet_aton(self.nat_addr),
6225                                       32)
6226         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
6227         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
6228                                                   is_inside=0)
6229
6230         self.initiate_tcp_session(self.pg0, self.pg1)
6231
6232         # close the session from inside
6233         try:
6234             # FIN packet in -> out
6235             p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
6236                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
6237                  TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
6238                      flags="F"))
6239             self.pg0.add_stream(p)
6240             self.pg_enable_capture(self.pg_interfaces)
6241             self.pg_start()
6242             self.pg1.get_capture(1)
6243
6244             pkts = []
6245
6246             # ACK packet out -> in
6247             p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
6248                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
6249                  TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
6250                      flags="A"))
6251             pkts.append(p)
6252
6253             # FIN packet out -> in
6254             p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
6255                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
6256                  TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
6257                      flags="F"))
6258             pkts.append(p)
6259
6260             self.pg1.add_stream(pkts)
6261             self.pg_enable_capture(self.pg_interfaces)
6262             self.pg_start()
6263             self.pg0.get_capture(2)
6264
6265             # ACK packet in -> out
6266             p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
6267                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
6268                  TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
6269                      flags="A"))
6270             self.pg0.add_stream(p)
6271             self.pg_enable_capture(self.pg_interfaces)
6272             self.pg_start()
6273             self.pg1.get_capture(1)
6274
6275             # Check if deterministic NAT44 closed the session
6276             dms = self.vapi.nat_det_map_dump()
6277             self.assertEqual(0, dms[0].ses_num)
6278         except:
6279             self.logger.error("TCP session termination failed")
6280             raise
6281
6282     def test_tcp_session_close_detection_out(self):
6283         """ Deterministic NAT TCP session close from outside network """
6284         self.vapi.nat_det_add_del_map(self.pg0.remote_ip4n,
6285                                       32,
6286                                       socket.inet_aton(self.nat_addr),
6287                                       32)
6288         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
6289         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
6290                                                   is_inside=0)
6291
6292         self.initiate_tcp_session(self.pg0, self.pg1)
6293
6294         # close the session from outside
6295         try:
6296             # FIN packet out -> in
6297             p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
6298                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
6299                  TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
6300                      flags="F"))
6301             self.pg1.add_stream(p)
6302             self.pg_enable_capture(self.pg_interfaces)
6303             self.pg_start()
6304             self.pg0.get_capture(1)
6305
6306             pkts = []
6307
6308             # ACK packet in -> out
6309             p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
6310                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
6311                  TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
6312                      flags="A"))
6313             pkts.append(p)
6314
6315             # ACK packet in -> out
6316             p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
6317                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
6318                  TCP(sport=self.tcp_port_in, dport=self.tcp_external_port,
6319                      flags="F"))
6320             pkts.append(p)
6321
6322             self.pg0.add_stream(pkts)
6323             self.pg_enable_capture(self.pg_interfaces)
6324             self.pg_start()
6325             self.pg1.get_capture(2)
6326
6327             # ACK packet out -> in
6328             p = (Ether(src=self.pg1.remote_mac, dst=self.pg1.local_mac) /
6329                  IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
6330                  TCP(sport=self.tcp_external_port, dport=self.tcp_port_out,
6331                      flags="A"))
6332             self.pg1.add_stream(p)
6333             self.pg_enable_capture(self.pg_interfaces)
6334             self.pg_start()
6335             self.pg0.get_capture(1)
6336
6337             # Check if deterministic NAT44 closed the session
6338             dms = self.vapi.nat_det_map_dump()
6339             self.assertEqual(0, dms[0].ses_num)
6340         except:
6341             self.logger.error("TCP session termination failed")
6342             raise
6343
6344     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
6345     def test_session_timeout(self):
6346         """ Deterministic NAT session timeouts """
6347         self.vapi.nat_det_add_del_map(self.pg0.remote_ip4n,
6348                                       32,
6349                                       socket.inet_aton(self.nat_addr),
6350                                       32)
6351         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
6352         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
6353                                                   is_inside=0)
6354
6355         self.initiate_tcp_session(self.pg0, self.pg1)
6356         self.vapi.nat_set_timeouts(5, 5, 5, 5)
6357         pkts = self.create_stream_in(self.pg0, self.pg1)
6358         self.pg0.add_stream(pkts)
6359         self.pg_enable_capture(self.pg_interfaces)
6360         self.pg_start()
6361         capture = self.pg1.get_capture(len(pkts))
6362         sleep(15)
6363
6364         dms = self.vapi.nat_det_map_dump()
6365         self.assertEqual(0, dms[0].ses_num)
6366
6367     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
6368     def test_session_limit_per_user(self):
6369         """ Deterministic NAT maximum sessions per user limit """
6370         self.vapi.nat_det_add_del_map(self.pg0.remote_ip4n,
6371                                       32,
6372                                       socket.inet_aton(self.nat_addr),
6373                                       32)
6374         self.vapi.nat44_interface_add_del_feature(self.pg0.sw_if_index)
6375         self.vapi.nat44_interface_add_del_feature(self.pg1.sw_if_index,
6376                                                   is_inside=0)
6377         self.vapi.set_ipfix_exporter(collector_address=self.pg2.remote_ip4n,
6378                                      src_address=self.pg2.local_ip4n,
6379                                      path_mtu=512,
6380                                      template_interval=10)
6381         self.vapi.nat_ipfix()
6382
6383         pkts = []
6384         for port in range(1025, 2025):
6385             p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
6386                  IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
6387                  UDP(sport=port, dport=port))
6388             pkts.append(p)
6389
6390         self.pg0.add_stream(pkts)
6391         self.pg_enable_capture(self.pg_interfaces)
6392         self.pg_start()
6393         capture = self.pg1.get_capture(len(pkts))
6394
6395         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
6396              IP(src=self.pg0.remote_ip4, dst=self.pg1.remote_ip4) /
6397              UDP(sport=3001, dport=3002))
6398         self.pg0.add_stream(p)
6399         self.pg_enable_capture(self.pg_interfaces)
6400         self.pg_start()
6401         capture = self.pg1.assert_nothing_captured()
6402
6403         # verify ICMP error packet
6404         capture = self.pg0.get_capture(1)
6405         p = capture[0]
6406         self.assertTrue(p.haslayer(ICMP))
6407         icmp = p[ICMP]
6408         self.assertEqual(icmp.type, 3)
6409         self.assertEqual(icmp.code, 1)
6410         self.assertTrue(icmp.haslayer(IPerror))
6411         inner_ip = icmp[IPerror]
6412         self.assertEqual(inner_ip[UDPerror].sport, 3001)
6413         self.assertEqual(inner_ip[UDPerror].dport, 3002)
6414
6415         dms = self.vapi.nat_det_map_dump()
6416
6417         self.assertEqual(1000, dms[0].ses_num)
6418
6419         # verify IPFIX logging
6420         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
6421         sleep(1)
6422         capture = self.pg2.get_capture(2)
6423         ipfix = IPFIXDecoder()
6424         # first load template
6425         for p in capture:
6426             self.assertTrue(p.haslayer(IPFIX))
6427             if p.haslayer(Template):
6428                 ipfix.add_template(p.getlayer(Template))
6429         # verify events in data set
6430         for p in capture:
6431             if p.haslayer(Data):
6432                 data = ipfix.decode_data_set(p.getlayer(Set))
6433                 self.verify_ipfix_max_entries_per_user(data,
6434                                                        1000,
6435                                                        self.pg0.remote_ip4n)
6436
6437     def clear_nat_det(self):
6438         """
6439         Clear deterministic NAT configuration.
6440         """
6441         self.vapi.nat_ipfix(enable=0)
6442         self.vapi.nat_set_timeouts()
6443         deterministic_mappings = self.vapi.nat_det_map_dump()
6444         for dsm in deterministic_mappings:
6445             self.vapi.nat_det_add_del_map(dsm.in_addr,
6446                                           dsm.in_plen,
6447                                           dsm.out_addr,
6448                                           dsm.out_plen,
6449                                           is_add=0)
6450
6451         interfaces = self.vapi.nat44_interface_dump()
6452         for intf in interfaces:
6453             self.vapi.nat44_interface_add_del_feature(intf.sw_if_index,
6454                                                       intf.is_inside,
6455                                                       is_add=0)
6456
6457     def tearDown(self):
6458         super(TestDeterministicNAT, self).tearDown()
6459         if not self.vpp_dead:
6460             self.logger.info(self.vapi.cli("show nat44 interfaces"))
6461             self.logger.info(self.vapi.cli("show nat timeouts"))
6462             self.logger.info(
6463                 self.vapi.cli("show nat44 deterministic mappings"))
6464             self.logger.info(
6465                 self.vapi.cli("show nat44 deterministic sessions"))
6466             self.clear_nat_det()
6467
6468
6469 class TestNAT64(MethodHolder):
6470     """ NAT64 Test Cases """
6471
6472     @classmethod
6473     def setUpConstants(cls):
6474         super(TestNAT64, cls).setUpConstants()
6475         cls.vpp_cmdline.extend(["nat", "{", "nat64 bib hash buckets 128",
6476                                 "nat64 st hash buckets 256", "}"])
6477
6478     @classmethod
6479     def setUpClass(cls):
6480         super(TestNAT64, cls).setUpClass()
6481
6482         try:
6483             cls.tcp_port_in = 6303
6484             cls.tcp_port_out = 6303
6485             cls.udp_port_in = 6304
6486             cls.udp_port_out = 6304
6487             cls.icmp_id_in = 6305
6488             cls.icmp_id_out = 6305
6489             cls.nat_addr = '10.0.0.3'
6490             cls.nat_addr_n = socket.inet_pton(socket.AF_INET, cls.nat_addr)
6491             cls.vrf1_id = 10
6492             cls.vrf1_nat_addr = '10.0.10.3'
6493             cls.vrf1_nat_addr_n = socket.inet_pton(socket.AF_INET,
6494                                                    cls.vrf1_nat_addr)
6495             cls.ipfix_src_port = 4739
6496             cls.ipfix_domain_id = 1
6497
6498             cls.create_pg_interfaces(range(6))
6499             cls.ip6_interfaces = list(cls.pg_interfaces[0:1])
6500             cls.ip6_interfaces.append(cls.pg_interfaces[2])
6501             cls.ip4_interfaces = list(cls.pg_interfaces[1:2])
6502
6503             cls.vapi.ip_table_add_del(cls.vrf1_id, is_add=1, is_ipv6=1)
6504
6505             cls.pg_interfaces[2].set_table_ip6(cls.vrf1_id)
6506
6507             cls.pg0.generate_remote_hosts(2)
6508
6509             for i in cls.ip6_interfaces:
6510                 i.admin_up()
6511                 i.config_ip6()
6512                 i.configure_ipv6_neighbors()
6513
6514             for i in cls.ip4_interfaces:
6515                 i.admin_up()
6516                 i.config_ip4()
6517                 i.resolve_arp()
6518
6519             cls.pg3.admin_up()
6520             cls.pg3.config_ip4()
6521             cls.pg3.resolve_arp()
6522             cls.pg3.config_ip6()
6523             cls.pg3.configure_ipv6_neighbors()
6524
6525             cls.pg5.admin_up()
6526             cls.pg5.config_ip6()
6527
6528         except Exception:
6529             super(TestNAT64, cls).tearDownClass()
6530             raise
6531
6532     def test_nat64_inside_interface_handles_neighbor_advertisement(self):
6533         """ NAT64 inside interface handles Neighbor Advertisement """
6534
6535         self.vapi.nat64_add_del_interface(self.pg5.sw_if_index)
6536
6537         # Try to send ping
6538         ping = (Ether(dst=self.pg5.local_mac, src=self.pg5.remote_mac) /
6539                 IPv6(src=self.pg5.remote_ip6, dst=self.pg5.local_ip6) /
6540                 ICMPv6EchoRequest())
6541         pkts = [ping]
6542         self.pg5.add_stream(pkts)
6543         self.pg_enable_capture(self.pg_interfaces)
6544         self.pg_start()
6545
6546         # Wait for Neighbor Solicitation
6547         capture = self.pg5.get_capture(len(pkts))
6548         packet = capture[0]
6549         try:
6550             self.assertEqual(packet[IPv6].src, self.pg5.local_ip6)
6551             self.assertTrue(packet.haslayer(ICMPv6ND_NS))
6552             tgt = packet[ICMPv6ND_NS].tgt
6553         except:
6554             self.logger.error(ppp("Unexpected or invalid packet:", packet))
6555             raise
6556
6557         # Send Neighbor Advertisement
6558         p = (Ether(dst=self.pg5.local_mac, src=self.pg5.remote_mac) /
6559              IPv6(src=self.pg5.remote_ip6, dst=self.pg5.local_ip6) /
6560              ICMPv6ND_NA(tgt=tgt) /
6561              ICMPv6NDOptDstLLAddr(lladdr=self.pg5.remote_mac))
6562         pkts = [p]
6563         self.pg5.add_stream(pkts)
6564         self.pg_enable_capture(self.pg_interfaces)
6565         self.pg_start()
6566
6567         # Try to send ping again
6568         pkts = [ping]
6569         self.pg5.add_stream(pkts)
6570         self.pg_enable_capture(self.pg_interfaces)
6571         self.pg_start()
6572
6573         # Wait for ping reply
6574         capture = self.pg5.get_capture(len(pkts))
6575         packet = capture[0]
6576         try:
6577             self.assertEqual(packet[IPv6].src, self.pg5.local_ip6)
6578             self.assertEqual(packet[IPv6].dst, self.pg5.remote_ip6)
6579             self.assertTrue(packet.haslayer(ICMPv6EchoReply))
6580         except:
6581             self.logger.error(ppp("Unexpected or invalid packet:", packet))
6582             raise
6583
6584     def test_pool(self):
6585         """ Add/delete address to NAT64 pool """
6586         nat_addr = socket.inet_pton(socket.AF_INET, '1.2.3.4')
6587
6588         self.vapi.nat64_add_del_pool_addr_range(nat_addr, nat_addr)
6589
6590         addresses = self.vapi.nat64_pool_addr_dump()
6591         self.assertEqual(len(addresses), 1)
6592         self.assertEqual(addresses[0].address, nat_addr)
6593
6594         self.vapi.nat64_add_del_pool_addr_range(nat_addr, nat_addr, is_add=0)
6595
6596         addresses = self.vapi.nat64_pool_addr_dump()
6597         self.assertEqual(len(addresses), 0)
6598
6599     def test_interface(self):
6600         """ Enable/disable NAT64 feature on the interface """
6601         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
6602         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
6603
6604         interfaces = self.vapi.nat64_interface_dump()
6605         self.assertEqual(len(interfaces), 2)
6606         pg0_found = False
6607         pg1_found = False
6608         for intf in interfaces:
6609             if intf.sw_if_index == self.pg0.sw_if_index:
6610                 self.assertEqual(intf.is_inside, 1)
6611                 pg0_found = True
6612             elif intf.sw_if_index == self.pg1.sw_if_index:
6613                 self.assertEqual(intf.is_inside, 0)
6614                 pg1_found = True
6615         self.assertTrue(pg0_found)
6616         self.assertTrue(pg1_found)
6617
6618         features = self.vapi.cli("show interface features pg0")
6619         self.assertNotEqual(features.find('nat64-in2out'), -1)
6620         features = self.vapi.cli("show interface features pg1")
6621         self.assertNotEqual(features.find('nat64-out2in'), -1)
6622
6623         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index, is_add=0)
6624         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_add=0)
6625
6626         interfaces = self.vapi.nat64_interface_dump()
6627         self.assertEqual(len(interfaces), 0)
6628
6629     def test_static_bib(self):
6630         """ Add/delete static BIB entry """
6631         in_addr = socket.inet_pton(socket.AF_INET6,
6632                                    '2001:db8:85a3::8a2e:370:7334')
6633         out_addr = socket.inet_pton(socket.AF_INET, '10.1.1.3')
6634         in_port = 1234
6635         out_port = 5678
6636         proto = IP_PROTOS.tcp
6637
6638         self.vapi.nat64_add_del_static_bib(in_addr,
6639                                            out_addr,
6640                                            in_port,
6641                                            out_port,
6642                                            proto)
6643         bib = self.vapi.nat64_bib_dump(IP_PROTOS.tcp)
6644         static_bib_num = 0
6645         for bibe in bib:
6646             if bibe.is_static:
6647                 static_bib_num += 1
6648                 self.assertEqual(bibe.i_addr, in_addr)
6649                 self.assertEqual(bibe.o_addr, out_addr)
6650                 self.assertEqual(bibe.i_port, in_port)
6651                 self.assertEqual(bibe.o_port, out_port)
6652         self.assertEqual(static_bib_num, 1)
6653
6654         self.vapi.nat64_add_del_static_bib(in_addr,
6655                                            out_addr,
6656                                            in_port,
6657                                            out_port,
6658                                            proto,
6659                                            is_add=0)
6660         bib = self.vapi.nat64_bib_dump(IP_PROTOS.tcp)
6661         static_bib_num = 0
6662         for bibe in bib:
6663             if bibe.is_static:
6664                 static_bib_num += 1
6665         self.assertEqual(static_bib_num, 0)
6666
6667     def test_set_timeouts(self):
6668         """ Set NAT64 timeouts """
6669         # verify default values
6670         timeouts = self.vapi.nat_get_timeouts()
6671         self.assertEqual(timeouts.udp, 300)
6672         self.assertEqual(timeouts.icmp, 60)
6673         self.assertEqual(timeouts.tcp_transitory, 240)
6674         self.assertEqual(timeouts.tcp_established, 7440)
6675
6676         # set and verify custom values
6677         self.vapi.nat_set_timeouts(udp=200, icmp=30, tcp_transitory=250,
6678                                    tcp_established=7450)
6679         timeouts = self.vapi.nat_get_timeouts()
6680         self.assertEqual(timeouts.udp, 200)
6681         self.assertEqual(timeouts.icmp, 30)
6682         self.assertEqual(timeouts.tcp_transitory, 250)
6683         self.assertEqual(timeouts.tcp_established, 7450)
6684
6685     def test_dynamic(self):
6686         """ NAT64 dynamic translation test """
6687         self.tcp_port_in = 6303
6688         self.udp_port_in = 6304
6689         self.icmp_id_in = 6305
6690
6691         ses_num_start = self.nat64_get_ses_num()
6692
6693         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
6694                                                 self.nat_addr_n)
6695         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
6696         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
6697
6698         # in2out
6699         pkts = self.create_stream_in_ip6(self.pg0, self.pg1)
6700         self.pg0.add_stream(pkts)
6701         self.pg_enable_capture(self.pg_interfaces)
6702         self.pg_start()
6703         capture = self.pg1.get_capture(len(pkts))
6704         self.verify_capture_out(capture, nat_ip=self.nat_addr,
6705                                 dst_ip=self.pg1.remote_ip4)
6706
6707         # out2in
6708         pkts = self.create_stream_out(self.pg1, dst_ip=self.nat_addr)
6709         self.pg1.add_stream(pkts)
6710         self.pg_enable_capture(self.pg_interfaces)
6711         self.pg_start()
6712         capture = self.pg0.get_capture(len(pkts))
6713         ip = IPv6(src=''.join(['64:ff9b::', self.pg1.remote_ip4]))
6714         self.verify_capture_in_ip6(capture, ip[IPv6].src, self.pg0.remote_ip6)
6715
6716         # in2out
6717         pkts = self.create_stream_in_ip6(self.pg0, self.pg1)
6718         self.pg0.add_stream(pkts)
6719         self.pg_enable_capture(self.pg_interfaces)
6720         self.pg_start()
6721         capture = self.pg1.get_capture(len(pkts))
6722         self.verify_capture_out(capture, nat_ip=self.nat_addr,
6723                                 dst_ip=self.pg1.remote_ip4)
6724
6725         # out2in
6726         pkts = self.create_stream_out(self.pg1, dst_ip=self.nat_addr)
6727         self.pg1.add_stream(pkts)
6728         self.pg_enable_capture(self.pg_interfaces)
6729         self.pg_start()
6730         capture = self.pg0.get_capture(len(pkts))
6731         self.verify_capture_in_ip6(capture, ip[IPv6].src, self.pg0.remote_ip6)
6732
6733         ses_num_end = self.nat64_get_ses_num()
6734
6735         self.assertEqual(ses_num_end - ses_num_start, 3)
6736
6737         # tenant with specific VRF
6738         self.vapi.nat64_add_del_pool_addr_range(self.vrf1_nat_addr_n,
6739                                                 self.vrf1_nat_addr_n,
6740                                                 vrf_id=self.vrf1_id)
6741         self.vapi.nat64_add_del_interface(self.pg2.sw_if_index)
6742
6743         pkts = self.create_stream_in_ip6(self.pg2, self.pg1)
6744         self.pg2.add_stream(pkts)
6745         self.pg_enable_capture(self.pg_interfaces)
6746         self.pg_start()
6747         capture = self.pg1.get_capture(len(pkts))
6748         self.verify_capture_out(capture, nat_ip=self.vrf1_nat_addr,
6749                                 dst_ip=self.pg1.remote_ip4)
6750
6751         pkts = self.create_stream_out(self.pg1, dst_ip=self.vrf1_nat_addr)
6752         self.pg1.add_stream(pkts)
6753         self.pg_enable_capture(self.pg_interfaces)
6754         self.pg_start()
6755         capture = self.pg2.get_capture(len(pkts))
6756         self.verify_capture_in_ip6(capture, ip[IPv6].src, self.pg2.remote_ip6)
6757
6758     def test_static(self):
6759         """ NAT64 static translation test """
6760         self.tcp_port_in = 60303
6761         self.udp_port_in = 60304
6762         self.icmp_id_in = 60305
6763         self.tcp_port_out = 60303
6764         self.udp_port_out = 60304
6765         self.icmp_id_out = 60305
6766
6767         ses_num_start = self.nat64_get_ses_num()
6768
6769         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
6770                                                 self.nat_addr_n)
6771         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
6772         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
6773
6774         self.vapi.nat64_add_del_static_bib(self.pg0.remote_ip6n,
6775                                            self.nat_addr_n,
6776                                            self.tcp_port_in,
6777                                            self.tcp_port_out,
6778                                            IP_PROTOS.tcp)
6779         self.vapi.nat64_add_del_static_bib(self.pg0.remote_ip6n,
6780                                            self.nat_addr_n,
6781                                            self.udp_port_in,
6782                                            self.udp_port_out,
6783                                            IP_PROTOS.udp)
6784         self.vapi.nat64_add_del_static_bib(self.pg0.remote_ip6n,
6785                                            self.nat_addr_n,
6786                                            self.icmp_id_in,
6787                                            self.icmp_id_out,
6788                                            IP_PROTOS.icmp)
6789
6790         # in2out
6791         pkts = self.create_stream_in_ip6(self.pg0, self.pg1)
6792         self.pg0.add_stream(pkts)
6793         self.pg_enable_capture(self.pg_interfaces)
6794         self.pg_start()
6795         capture = self.pg1.get_capture(len(pkts))
6796         self.verify_capture_out(capture, nat_ip=self.nat_addr,
6797                                 dst_ip=self.pg1.remote_ip4, same_port=True)
6798
6799         # out2in
6800         pkts = self.create_stream_out(self.pg1, dst_ip=self.nat_addr)
6801         self.pg1.add_stream(pkts)
6802         self.pg_enable_capture(self.pg_interfaces)
6803         self.pg_start()
6804         capture = self.pg0.get_capture(len(pkts))
6805         ip = IPv6(src=''.join(['64:ff9b::', self.pg1.remote_ip4]))
6806         self.verify_capture_in_ip6(capture, ip[IPv6].src, self.pg0.remote_ip6)
6807
6808         ses_num_end = self.nat64_get_ses_num()
6809
6810         self.assertEqual(ses_num_end - ses_num_start, 3)
6811
6812     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
6813     def test_session_timeout(self):
6814         """ NAT64 session timeout """
6815         self.icmp_id_in = 1234
6816         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
6817                                                 self.nat_addr_n)
6818         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
6819         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
6820         self.vapi.nat_set_timeouts(icmp=5, tcp_transitory=5, tcp_established=5)
6821
6822         pkts = self.create_stream_in_ip6(self.pg0, self.pg1)
6823         self.pg0.add_stream(pkts)
6824         self.pg_enable_capture(self.pg_interfaces)
6825         self.pg_start()
6826         capture = self.pg1.get_capture(len(pkts))
6827
6828         ses_num_before_timeout = self.nat64_get_ses_num()
6829
6830         sleep(15)
6831
6832         # ICMP and TCP session after timeout
6833         ses_num_after_timeout = self.nat64_get_ses_num()
6834         self.assertEqual(ses_num_before_timeout - ses_num_after_timeout, 2)
6835
6836     def test_icmp_error(self):
6837         """ NAT64 ICMP Error message translation """
6838         self.tcp_port_in = 6303
6839         self.udp_port_in = 6304
6840         self.icmp_id_in = 6305
6841
6842         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
6843                                                 self.nat_addr_n)
6844         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
6845         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
6846
6847         # send some packets to create sessions
6848         pkts = self.create_stream_in_ip6(self.pg0, self.pg1)
6849         self.pg0.add_stream(pkts)
6850         self.pg_enable_capture(self.pg_interfaces)
6851         self.pg_start()
6852         capture_ip4 = self.pg1.get_capture(len(pkts))
6853         self.verify_capture_out(capture_ip4,
6854                                 nat_ip=self.nat_addr,
6855                                 dst_ip=self.pg1.remote_ip4)
6856
6857         pkts = self.create_stream_out(self.pg1, dst_ip=self.nat_addr)
6858         self.pg1.add_stream(pkts)
6859         self.pg_enable_capture(self.pg_interfaces)
6860         self.pg_start()
6861         capture_ip6 = self.pg0.get_capture(len(pkts))
6862         ip = IPv6(src=''.join(['64:ff9b::', self.pg1.remote_ip4]))
6863         self.verify_capture_in_ip6(capture_ip6, ip[IPv6].src,
6864                                    self.pg0.remote_ip6)
6865
6866         # in2out
6867         pkts = [Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
6868                 IPv6(src=self.pg0.remote_ip6, dst=ip[IPv6].src) /
6869                 ICMPv6DestUnreach(code=1) /
6870                 packet[IPv6] for packet in capture_ip6]
6871         self.pg0.add_stream(pkts)
6872         self.pg_enable_capture(self.pg_interfaces)
6873         self.pg_start()
6874         capture = self.pg1.get_capture(len(pkts))
6875         for packet in capture:
6876             try:
6877                 self.assertEqual(packet[IP].src, self.nat_addr)
6878                 self.assertEqual(packet[IP].dst, self.pg1.remote_ip4)
6879                 self.assertEqual(packet[ICMP].type, 3)
6880                 self.assertEqual(packet[ICMP].code, 13)
6881                 inner = packet[IPerror]
6882                 self.assertEqual(inner.src, self.pg1.remote_ip4)
6883                 self.assertEqual(inner.dst, self.nat_addr)
6884                 self.assert_packet_checksums_valid(packet)
6885                 if inner.haslayer(TCPerror):
6886                     self.assertEqual(inner[TCPerror].dport, self.tcp_port_out)
6887                 elif inner.haslayer(UDPerror):
6888                     self.assertEqual(inner[UDPerror].dport, self.udp_port_out)
6889                 else:
6890                     self.assertEqual(inner[ICMPerror].id, self.icmp_id_out)
6891             except:
6892                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
6893                 raise
6894
6895         # out2in
6896         pkts = [Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
6897                 IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
6898                 ICMP(type=3, code=13) /
6899                 packet[IP] for packet in capture_ip4]
6900         self.pg1.add_stream(pkts)
6901         self.pg_enable_capture(self.pg_interfaces)
6902         self.pg_start()
6903         capture = self.pg0.get_capture(len(pkts))
6904         for packet in capture:
6905             try:
6906                 self.assertEqual(packet[IPv6].src, ip.src)
6907                 self.assertEqual(packet[IPv6].dst, self.pg0.remote_ip6)
6908                 icmp = packet[ICMPv6DestUnreach]
6909                 self.assertEqual(icmp.code, 1)
6910                 inner = icmp[IPerror6]
6911                 self.assertEqual(inner.src, self.pg0.remote_ip6)
6912                 self.assertEqual(inner.dst, ip.src)
6913                 self.assert_icmpv6_checksum_valid(packet)
6914                 if inner.haslayer(TCPerror):
6915                     self.assertEqual(inner[TCPerror].sport, self.tcp_port_in)
6916                 elif inner.haslayer(UDPerror):
6917                     self.assertEqual(inner[UDPerror].sport, self.udp_port_in)
6918                 else:
6919                     self.assertEqual(inner[ICMPv6EchoRequest].id,
6920                                      self.icmp_id_in)
6921             except:
6922                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
6923                 raise
6924
6925     def test_hairpinning(self):
6926         """ NAT64 hairpinning """
6927
6928         client = self.pg0.remote_hosts[0]
6929         server = self.pg0.remote_hosts[1]
6930         server_tcp_in_port = 22
6931         server_tcp_out_port = 4022
6932         server_udp_in_port = 23
6933         server_udp_out_port = 4023
6934         client_tcp_in_port = 1234
6935         client_udp_in_port = 1235
6936         client_tcp_out_port = 0
6937         client_udp_out_port = 0
6938         ip = IPv6(src=''.join(['64:ff9b::', self.nat_addr]))
6939         nat_addr_ip6 = ip.src
6940
6941         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
6942                                                 self.nat_addr_n)
6943         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
6944         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
6945
6946         self.vapi.nat64_add_del_static_bib(server.ip6n,
6947                                            self.nat_addr_n,
6948                                            server_tcp_in_port,
6949                                            server_tcp_out_port,
6950                                            IP_PROTOS.tcp)
6951         self.vapi.nat64_add_del_static_bib(server.ip6n,
6952                                            self.nat_addr_n,
6953                                            server_udp_in_port,
6954                                            server_udp_out_port,
6955                                            IP_PROTOS.udp)
6956
6957         # client to server
6958         pkts = []
6959         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
6960              IPv6(src=client.ip6, dst=nat_addr_ip6) /
6961              TCP(sport=client_tcp_in_port, dport=server_tcp_out_port))
6962         pkts.append(p)
6963         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
6964              IPv6(src=client.ip6, dst=nat_addr_ip6) /
6965              UDP(sport=client_udp_in_port, dport=server_udp_out_port))
6966         pkts.append(p)
6967         self.pg0.add_stream(pkts)
6968         self.pg_enable_capture(self.pg_interfaces)
6969         self.pg_start()
6970         capture = self.pg0.get_capture(len(pkts))
6971         for packet in capture:
6972             try:
6973                 self.assertEqual(packet[IPv6].src, nat_addr_ip6)
6974                 self.assertEqual(packet[IPv6].dst, server.ip6)
6975                 self.assert_packet_checksums_valid(packet)
6976                 if packet.haslayer(TCP):
6977                     self.assertNotEqual(packet[TCP].sport, client_tcp_in_port)
6978                     self.assertEqual(packet[TCP].dport, server_tcp_in_port)
6979                     client_tcp_out_port = packet[TCP].sport
6980                 else:
6981                     self.assertNotEqual(packet[UDP].sport, client_udp_in_port)
6982                     self.assertEqual(packet[UDP].dport, server_udp_in_port)
6983                     client_udp_out_port = packet[UDP].sport
6984             except:
6985                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
6986                 raise
6987
6988         # server to client
6989         pkts = []
6990         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
6991              IPv6(src=server.ip6, dst=nat_addr_ip6) /
6992              TCP(sport=server_tcp_in_port, dport=client_tcp_out_port))
6993         pkts.append(p)
6994         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
6995              IPv6(src=server.ip6, dst=nat_addr_ip6) /
6996              UDP(sport=server_udp_in_port, dport=client_udp_out_port))
6997         pkts.append(p)
6998         self.pg0.add_stream(pkts)
6999         self.pg_enable_capture(self.pg_interfaces)
7000         self.pg_start()
7001         capture = self.pg0.get_capture(len(pkts))
7002         for packet in capture:
7003             try:
7004                 self.assertEqual(packet[IPv6].src, nat_addr_ip6)
7005                 self.assertEqual(packet[IPv6].dst, client.ip6)
7006                 self.assert_packet_checksums_valid(packet)
7007                 if packet.haslayer(TCP):
7008                     self.assertEqual(packet[TCP].sport, server_tcp_out_port)
7009                     self.assertEqual(packet[TCP].dport, client_tcp_in_port)
7010                 else:
7011                     self.assertEqual(packet[UDP].sport, server_udp_out_port)
7012                     self.assertEqual(packet[UDP].dport, client_udp_in_port)
7013             except:
7014                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
7015                 raise
7016
7017         # ICMP error
7018         pkts = []
7019         pkts = [Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7020                 IPv6(src=client.ip6, dst=nat_addr_ip6) /
7021                 ICMPv6DestUnreach(code=1) /
7022                 packet[IPv6] for packet in capture]
7023         self.pg0.add_stream(pkts)
7024         self.pg_enable_capture(self.pg_interfaces)
7025         self.pg_start()
7026         capture = self.pg0.get_capture(len(pkts))
7027         for packet in capture:
7028             try:
7029                 self.assertEqual(packet[IPv6].src, nat_addr_ip6)
7030                 self.assertEqual(packet[IPv6].dst, server.ip6)
7031                 icmp = packet[ICMPv6DestUnreach]
7032                 self.assertEqual(icmp.code, 1)
7033                 inner = icmp[IPerror6]
7034                 self.assertEqual(inner.src, server.ip6)
7035                 self.assertEqual(inner.dst, nat_addr_ip6)
7036                 self.assert_packet_checksums_valid(packet)
7037                 if inner.haslayer(TCPerror):
7038                     self.assertEqual(inner[TCPerror].sport, server_tcp_in_port)
7039                     self.assertEqual(inner[TCPerror].dport,
7040                                      client_tcp_out_port)
7041                 else:
7042                     self.assertEqual(inner[UDPerror].sport, server_udp_in_port)
7043                     self.assertEqual(inner[UDPerror].dport,
7044                                      client_udp_out_port)
7045             except:
7046                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
7047                 raise
7048
7049     def test_prefix(self):
7050         """ NAT64 Network-Specific Prefix """
7051
7052         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7053                                                 self.nat_addr_n)
7054         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7055         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7056         self.vapi.nat64_add_del_pool_addr_range(self.vrf1_nat_addr_n,
7057                                                 self.vrf1_nat_addr_n,
7058                                                 vrf_id=self.vrf1_id)
7059         self.vapi.nat64_add_del_interface(self.pg2.sw_if_index)
7060
7061         # Add global prefix
7062         global_pref64 = "2001:db8::"
7063         global_pref64_n = socket.inet_pton(socket.AF_INET6, global_pref64)
7064         global_pref64_len = 32
7065         self.vapi.nat64_add_del_prefix(global_pref64_n, global_pref64_len)
7066
7067         prefix = self.vapi.nat64_prefix_dump()
7068         self.assertEqual(len(prefix), 1)
7069         self.assertEqual(prefix[0].prefix, global_pref64_n)
7070         self.assertEqual(prefix[0].prefix_len, global_pref64_len)
7071         self.assertEqual(prefix[0].vrf_id, 0)
7072
7073         # Add tenant specific prefix
7074         vrf1_pref64 = "2001:db8:122:300::"
7075         vrf1_pref64_n = socket.inet_pton(socket.AF_INET6, vrf1_pref64)
7076         vrf1_pref64_len = 56
7077         self.vapi.nat64_add_del_prefix(vrf1_pref64_n,
7078                                        vrf1_pref64_len,
7079                                        vrf_id=self.vrf1_id)
7080         prefix = self.vapi.nat64_prefix_dump()
7081         self.assertEqual(len(prefix), 2)
7082
7083         # Global prefix
7084         pkts = self.create_stream_in_ip6(self.pg0,
7085                                          self.pg1,
7086                                          pref=global_pref64,
7087                                          plen=global_pref64_len)
7088         self.pg0.add_stream(pkts)
7089         self.pg_enable_capture(self.pg_interfaces)
7090         self.pg_start()
7091         capture = self.pg1.get_capture(len(pkts))
7092         self.verify_capture_out(capture, nat_ip=self.nat_addr,
7093                                 dst_ip=self.pg1.remote_ip4)
7094
7095         pkts = self.create_stream_out(self.pg1, dst_ip=self.nat_addr)
7096         self.pg1.add_stream(pkts)
7097         self.pg_enable_capture(self.pg_interfaces)
7098         self.pg_start()
7099         capture = self.pg0.get_capture(len(pkts))
7100         dst_ip = self.compose_ip6(self.pg1.remote_ip4,
7101                                   global_pref64,
7102                                   global_pref64_len)
7103         self.verify_capture_in_ip6(capture, dst_ip, self.pg0.remote_ip6)
7104
7105         # Tenant specific prefix
7106         pkts = self.create_stream_in_ip6(self.pg2,
7107                                          self.pg1,
7108                                          pref=vrf1_pref64,
7109                                          plen=vrf1_pref64_len)
7110         self.pg2.add_stream(pkts)
7111         self.pg_enable_capture(self.pg_interfaces)
7112         self.pg_start()
7113         capture = self.pg1.get_capture(len(pkts))
7114         self.verify_capture_out(capture, nat_ip=self.vrf1_nat_addr,
7115                                 dst_ip=self.pg1.remote_ip4)
7116
7117         pkts = self.create_stream_out(self.pg1, dst_ip=self.vrf1_nat_addr)
7118         self.pg1.add_stream(pkts)
7119         self.pg_enable_capture(self.pg_interfaces)
7120         self.pg_start()
7121         capture = self.pg2.get_capture(len(pkts))
7122         dst_ip = self.compose_ip6(self.pg1.remote_ip4,
7123                                   vrf1_pref64,
7124                                   vrf1_pref64_len)
7125         self.verify_capture_in_ip6(capture, dst_ip, self.pg2.remote_ip6)
7126
7127     def test_unknown_proto(self):
7128         """ NAT64 translate packet with unknown protocol """
7129
7130         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7131                                                 self.nat_addr_n)
7132         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7133         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7134         remote_ip6 = self.compose_ip6(self.pg1.remote_ip4, '64:ff9b::', 96)
7135
7136         # in2out
7137         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7138              IPv6(src=self.pg0.remote_ip6, dst=remote_ip6) /
7139              TCP(sport=self.tcp_port_in, dport=20))
7140         self.pg0.add_stream(p)
7141         self.pg_enable_capture(self.pg_interfaces)
7142         self.pg_start()
7143         p = self.pg1.get_capture(1)
7144
7145         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7146              IPv6(src=self.pg0.remote_ip6, dst=remote_ip6, nh=47) /
7147              GRE() /
7148              IP(src=self.pg2.local_ip4, dst=self.pg2.remote_ip4) /
7149              TCP(sport=1234, dport=1234))
7150         self.pg0.add_stream(p)
7151         self.pg_enable_capture(self.pg_interfaces)
7152         self.pg_start()
7153         p = self.pg1.get_capture(1)
7154         packet = p[0]
7155         try:
7156             self.assertEqual(packet[IP].src, self.nat_addr)
7157             self.assertEqual(packet[IP].dst, self.pg1.remote_ip4)
7158             self.assertTrue(packet.haslayer(GRE))
7159             self.assert_packet_checksums_valid(packet)
7160         except:
7161             self.logger.error(ppp("Unexpected or invalid packet:", packet))
7162             raise
7163
7164         # out2in
7165         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
7166              IP(src=self.pg1.remote_ip4, dst=self.nat_addr) /
7167              GRE() /
7168              IP(src=self.pg2.remote_ip4, dst=self.pg2.local_ip4) /
7169              TCP(sport=1234, dport=1234))
7170         self.pg1.add_stream(p)
7171         self.pg_enable_capture(self.pg_interfaces)
7172         self.pg_start()
7173         p = self.pg0.get_capture(1)
7174         packet = p[0]
7175         try:
7176             self.assertEqual(packet[IPv6].src, remote_ip6)
7177             self.assertEqual(packet[IPv6].dst, self.pg0.remote_ip6)
7178             self.assertEqual(packet[IPv6].nh, 47)
7179         except:
7180             self.logger.error(ppp("Unexpected or invalid packet:", packet))
7181             raise
7182
7183     def test_hairpinning_unknown_proto(self):
7184         """ NAT64 translate packet with unknown protocol - hairpinning """
7185
7186         client = self.pg0.remote_hosts[0]
7187         server = self.pg0.remote_hosts[1]
7188         server_tcp_in_port = 22
7189         server_tcp_out_port = 4022
7190         client_tcp_in_port = 1234
7191         client_tcp_out_port = 1235
7192         server_nat_ip = "10.0.0.100"
7193         client_nat_ip = "10.0.0.110"
7194         server_nat_ip_n = socket.inet_pton(socket.AF_INET, server_nat_ip)
7195         client_nat_ip_n = socket.inet_pton(socket.AF_INET, client_nat_ip)
7196         server_nat_ip6 = self.compose_ip6(server_nat_ip, '64:ff9b::', 96)
7197         client_nat_ip6 = self.compose_ip6(client_nat_ip, '64:ff9b::', 96)
7198
7199         self.vapi.nat64_add_del_pool_addr_range(server_nat_ip_n,
7200                                                 client_nat_ip_n)
7201         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7202         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7203
7204         self.vapi.nat64_add_del_static_bib(server.ip6n,
7205                                            server_nat_ip_n,
7206                                            server_tcp_in_port,
7207                                            server_tcp_out_port,
7208                                            IP_PROTOS.tcp)
7209
7210         self.vapi.nat64_add_del_static_bib(server.ip6n,
7211                                            server_nat_ip_n,
7212                                            0,
7213                                            0,
7214                                            IP_PROTOS.gre)
7215
7216         self.vapi.nat64_add_del_static_bib(client.ip6n,
7217                                            client_nat_ip_n,
7218                                            client_tcp_in_port,
7219                                            client_tcp_out_port,
7220                                            IP_PROTOS.tcp)
7221
7222         # client to server
7223         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7224              IPv6(src=client.ip6, dst=server_nat_ip6) /
7225              TCP(sport=client_tcp_in_port, dport=server_tcp_out_port))
7226         self.pg0.add_stream(p)
7227         self.pg_enable_capture(self.pg_interfaces)
7228         self.pg_start()
7229         p = self.pg0.get_capture(1)
7230
7231         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7232              IPv6(src=client.ip6, dst=server_nat_ip6, nh=IP_PROTOS.gre) /
7233              GRE() /
7234              IP(src=self.pg2.local_ip4, dst=self.pg2.remote_ip4) /
7235              TCP(sport=1234, dport=1234))
7236         self.pg0.add_stream(p)
7237         self.pg_enable_capture(self.pg_interfaces)
7238         self.pg_start()
7239         p = self.pg0.get_capture(1)
7240         packet = p[0]
7241         try:
7242             self.assertEqual(packet[IPv6].src, client_nat_ip6)
7243             self.assertEqual(packet[IPv6].dst, server.ip6)
7244             self.assertEqual(packet[IPv6].nh, IP_PROTOS.gre)
7245         except:
7246             self.logger.error(ppp("Unexpected or invalid packet:", packet))
7247             raise
7248
7249         # server to client
7250         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7251              IPv6(src=server.ip6, dst=client_nat_ip6, nh=IP_PROTOS.gre) /
7252              GRE() /
7253              IP(src=self.pg2.remote_ip4, dst=self.pg2.local_ip4) /
7254              TCP(sport=1234, dport=1234))
7255         self.pg0.add_stream(p)
7256         self.pg_enable_capture(self.pg_interfaces)
7257         self.pg_start()
7258         p = self.pg0.get_capture(1)
7259         packet = p[0]
7260         try:
7261             self.assertEqual(packet[IPv6].src, server_nat_ip6)
7262             self.assertEqual(packet[IPv6].dst, client.ip6)
7263             self.assertEqual(packet[IPv6].nh, IP_PROTOS.gre)
7264         except:
7265             self.logger.error(ppp("Unexpected or invalid packet:", packet))
7266             raise
7267
7268     def test_one_armed_nat64(self):
7269         """ One armed NAT64 """
7270         external_port = 0
7271         remote_host_ip6 = self.compose_ip6(self.pg3.remote_ip4,
7272                                            '64:ff9b::',
7273                                            96)
7274
7275         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7276                                                 self.nat_addr_n)
7277         self.vapi.nat64_add_del_interface(self.pg3.sw_if_index)
7278         self.vapi.nat64_add_del_interface(self.pg3.sw_if_index, is_inside=0)
7279
7280         # in2out
7281         p = (Ether(src=self.pg3.remote_mac, dst=self.pg3.local_mac) /
7282              IPv6(src=self.pg3.remote_ip6, dst=remote_host_ip6) /
7283              TCP(sport=12345, dport=80))
7284         self.pg3.add_stream(p)
7285         self.pg_enable_capture(self.pg_interfaces)
7286         self.pg_start()
7287         capture = self.pg3.get_capture(1)
7288         p = capture[0]
7289         try:
7290             ip = p[IP]
7291             tcp = p[TCP]
7292             self.assertEqual(ip.src, self.nat_addr)
7293             self.assertEqual(ip.dst, self.pg3.remote_ip4)
7294             self.assertNotEqual(tcp.sport, 12345)
7295             external_port = tcp.sport
7296             self.assertEqual(tcp.dport, 80)
7297             self.assert_packet_checksums_valid(p)
7298         except:
7299             self.logger.error(ppp("Unexpected or invalid packet:", p))
7300             raise
7301
7302         # out2in
7303         p = (Ether(src=self.pg3.remote_mac, dst=self.pg3.local_mac) /
7304              IP(src=self.pg3.remote_ip4, dst=self.nat_addr) /
7305              TCP(sport=80, dport=external_port))
7306         self.pg3.add_stream(p)
7307         self.pg_enable_capture(self.pg_interfaces)
7308         self.pg_start()
7309         capture = self.pg3.get_capture(1)
7310         p = capture[0]
7311         try:
7312             ip = p[IPv6]
7313             tcp = p[TCP]
7314             self.assertEqual(ip.src, remote_host_ip6)
7315             self.assertEqual(ip.dst, self.pg3.remote_ip6)
7316             self.assertEqual(tcp.sport, 80)
7317             self.assertEqual(tcp.dport, 12345)
7318             self.assert_packet_checksums_valid(p)
7319         except:
7320             self.logger.error(ppp("Unexpected or invalid packet:", p))
7321             raise
7322
7323     def test_frag_in_order(self):
7324         """ NAT64 translate fragments arriving in order """
7325         self.tcp_port_in = random.randint(1025, 65535)
7326
7327         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7328                                                 self.nat_addr_n)
7329         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7330         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7331
7332         reass = self.vapi.nat_reass_dump()
7333         reass_n_start = len(reass)
7334
7335         # in2out
7336         data = 'a' * 200
7337         pkts = self.create_stream_frag_ip6(self.pg0, self.pg1.remote_ip4,
7338                                            self.tcp_port_in, 20, data)
7339         self.pg0.add_stream(pkts)
7340         self.pg_enable_capture(self.pg_interfaces)
7341         self.pg_start()
7342         frags = self.pg1.get_capture(len(pkts))
7343         p = self.reass_frags_and_verify(frags,
7344                                         self.nat_addr,
7345                                         self.pg1.remote_ip4)
7346         self.assertEqual(p[TCP].dport, 20)
7347         self.assertNotEqual(p[TCP].sport, self.tcp_port_in)
7348         self.tcp_port_out = p[TCP].sport
7349         self.assertEqual(data, p[Raw].load)
7350
7351         # out2in
7352         data = "A" * 4 + "b" * 16 + "C" * 3
7353         pkts = self.create_stream_frag(self.pg1,
7354                                        self.nat_addr,
7355                                        20,
7356                                        self.tcp_port_out,
7357                                        data)
7358         self.pg1.add_stream(pkts)
7359         self.pg_enable_capture(self.pg_interfaces)
7360         self.pg_start()
7361         frags = self.pg0.get_capture(len(pkts))
7362         src = self.compose_ip6(self.pg1.remote_ip4, '64:ff9b::', 96)
7363         p = self.reass_frags_and_verify_ip6(frags, src, self.pg0.remote_ip6)
7364         self.assertEqual(p[TCP].sport, 20)
7365         self.assertEqual(p[TCP].dport, self.tcp_port_in)
7366         self.assertEqual(data, p[Raw].load)
7367
7368         reass = self.vapi.nat_reass_dump()
7369         reass_n_end = len(reass)
7370
7371         self.assertEqual(reass_n_end - reass_n_start, 2)
7372
7373     def test_reass_hairpinning(self):
7374         """ NAT64 fragments hairpinning """
7375         data = 'a' * 200
7376         server = self.pg0.remote_hosts[1]
7377         server_in_port = random.randint(1025, 65535)
7378         server_out_port = random.randint(1025, 65535)
7379         client_in_port = random.randint(1025, 65535)
7380         ip = IPv6(src=''.join(['64:ff9b::', self.nat_addr]))
7381         nat_addr_ip6 = ip.src
7382
7383         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7384                                                 self.nat_addr_n)
7385         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7386         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7387
7388         # add static BIB entry for server
7389         self.vapi.nat64_add_del_static_bib(server.ip6n,
7390                                            self.nat_addr_n,
7391                                            server_in_port,
7392                                            server_out_port,
7393                                            IP_PROTOS.tcp)
7394
7395         # send packet from host to server
7396         pkts = self.create_stream_frag_ip6(self.pg0,
7397                                            self.nat_addr,
7398                                            client_in_port,
7399                                            server_out_port,
7400                                            data)
7401         self.pg0.add_stream(pkts)
7402         self.pg_enable_capture(self.pg_interfaces)
7403         self.pg_start()
7404         frags = self.pg0.get_capture(len(pkts))
7405         p = self.reass_frags_and_verify_ip6(frags, nat_addr_ip6, server.ip6)
7406         self.assertNotEqual(p[TCP].sport, client_in_port)
7407         self.assertEqual(p[TCP].dport, server_in_port)
7408         self.assertEqual(data, p[Raw].load)
7409
7410     def test_frag_out_of_order(self):
7411         """ NAT64 translate fragments arriving out of order """
7412         self.tcp_port_in = random.randint(1025, 65535)
7413
7414         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7415                                                 self.nat_addr_n)
7416         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7417         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7418
7419         # in2out
7420         data = 'a' * 200
7421         pkts = self.create_stream_frag_ip6(self.pg0, self.pg1.remote_ip4,
7422                                            self.tcp_port_in, 20, data)
7423         pkts.reverse()
7424         self.pg0.add_stream(pkts)
7425         self.pg_enable_capture(self.pg_interfaces)
7426         self.pg_start()
7427         frags = self.pg1.get_capture(len(pkts))
7428         p = self.reass_frags_and_verify(frags,
7429                                         self.nat_addr,
7430                                         self.pg1.remote_ip4)
7431         self.assertEqual(p[TCP].dport, 20)
7432         self.assertNotEqual(p[TCP].sport, self.tcp_port_in)
7433         self.tcp_port_out = p[TCP].sport
7434         self.assertEqual(data, p[Raw].load)
7435
7436         # out2in
7437         data = "A" * 4 + "B" * 16 + "C" * 3
7438         pkts = self.create_stream_frag(self.pg1,
7439                                        self.nat_addr,
7440                                        20,
7441                                        self.tcp_port_out,
7442                                        data)
7443         pkts.reverse()
7444         self.pg1.add_stream(pkts)
7445         self.pg_enable_capture(self.pg_interfaces)
7446         self.pg_start()
7447         frags = self.pg0.get_capture(len(pkts))
7448         src = self.compose_ip6(self.pg1.remote_ip4, '64:ff9b::', 96)
7449         p = self.reass_frags_and_verify_ip6(frags, src, self.pg0.remote_ip6)
7450         self.assertEqual(p[TCP].sport, 20)
7451         self.assertEqual(p[TCP].dport, self.tcp_port_in)
7452         self.assertEqual(data, p[Raw].load)
7453
7454     def test_interface_addr(self):
7455         """ Acquire NAT64 pool addresses from interface """
7456         self.vapi.nat64_add_interface_addr(self.pg4.sw_if_index)
7457
7458         # no address in NAT64 pool
7459         adresses = self.vapi.nat44_address_dump()
7460         self.assertEqual(0, len(adresses))
7461
7462         # configure interface address and check NAT64 address pool
7463         self.pg4.config_ip4()
7464         addresses = self.vapi.nat64_pool_addr_dump()
7465         self.assertEqual(len(addresses), 1)
7466         self.assertEqual(addresses[0].address, self.pg4.local_ip4n)
7467
7468         # remove interface address and check NAT64 address pool
7469         self.pg4.unconfig_ip4()
7470         addresses = self.vapi.nat64_pool_addr_dump()
7471         self.assertEqual(0, len(adresses))
7472
7473     @unittest.skipUnless(running_extended_tests(), "part of extended tests")
7474     def test_ipfix_max_bibs_sessions(self):
7475         """ IPFIX logging maximum session and BIB entries exceeded """
7476         max_bibs = 1280
7477         max_sessions = 2560
7478         remote_host_ip6 = self.compose_ip6(self.pg1.remote_ip4,
7479                                            '64:ff9b::',
7480                                            96)
7481
7482         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7483                                                 self.nat_addr_n)
7484         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7485         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7486
7487         pkts = []
7488         src = ""
7489         for i in range(0, max_bibs):
7490             src = "fd01:aa::%x" % (i)
7491             p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
7492                  IPv6(src=src, dst=remote_host_ip6) /
7493                  TCP(sport=12345, dport=80))
7494             pkts.append(p)
7495             p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
7496                  IPv6(src=src, dst=remote_host_ip6) /
7497                  TCP(sport=12345, dport=22))
7498             pkts.append(p)
7499         self.pg0.add_stream(pkts)
7500         self.pg_enable_capture(self.pg_interfaces)
7501         self.pg_start()
7502         self.pg1.get_capture(max_sessions)
7503
7504         self.vapi.set_ipfix_exporter(collector_address=self.pg3.remote_ip4n,
7505                                      src_address=self.pg3.local_ip4n,
7506                                      path_mtu=512,
7507                                      template_interval=10)
7508         self.vapi.nat_ipfix(domain_id=self.ipfix_domain_id,
7509                             src_port=self.ipfix_src_port)
7510
7511         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
7512              IPv6(src=src, dst=remote_host_ip6) /
7513              TCP(sport=12345, dport=25))
7514         self.pg0.add_stream(p)
7515         self.pg_enable_capture(self.pg_interfaces)
7516         self.pg_start()
7517         self.pg1.assert_nothing_captured()
7518         sleep(1)
7519         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
7520         capture = self.pg3.get_capture(9)
7521         ipfix = IPFIXDecoder()
7522         # first load template
7523         for p in capture:
7524             self.assertTrue(p.haslayer(IPFIX))
7525             self.assertEqual(p[IP].src, self.pg3.local_ip4)
7526             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
7527             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
7528             self.assertEqual(p[UDP].dport, 4739)
7529             self.assertEqual(p[IPFIX].observationDomainID,
7530                              self.ipfix_domain_id)
7531             if p.haslayer(Template):
7532                 ipfix.add_template(p.getlayer(Template))
7533         # verify events in data set
7534         for p in capture:
7535             if p.haslayer(Data):
7536                 data = ipfix.decode_data_set(p.getlayer(Set))
7537                 self.verify_ipfix_max_sessions(data, max_sessions)
7538
7539         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
7540              IPv6(src=self.pg0.remote_ip6, dst=remote_host_ip6) /
7541              TCP(sport=12345, dport=80))
7542         self.pg0.add_stream(p)
7543         self.pg_enable_capture(self.pg_interfaces)
7544         self.pg_start()
7545         self.pg1.assert_nothing_captured()
7546         sleep(1)
7547         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
7548         capture = self.pg3.get_capture(1)
7549         # verify events in data set
7550         for p in capture:
7551             self.assertTrue(p.haslayer(IPFIX))
7552             self.assertEqual(p[IP].src, self.pg3.local_ip4)
7553             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
7554             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
7555             self.assertEqual(p[UDP].dport, 4739)
7556             self.assertEqual(p[IPFIX].observationDomainID,
7557                              self.ipfix_domain_id)
7558             if p.haslayer(Data):
7559                 data = ipfix.decode_data_set(p.getlayer(Set))
7560                 self.verify_ipfix_max_bibs(data, max_bibs)
7561
7562     def test_ipfix_max_frags(self):
7563         """ IPFIX logging maximum fragments pending reassembly exceeded """
7564         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7565                                                 self.nat_addr_n)
7566         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7567         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7568         self.vapi.nat_set_reass(max_frag=1, is_ip6=1)
7569         self.vapi.set_ipfix_exporter(collector_address=self.pg3.remote_ip4n,
7570                                      src_address=self.pg3.local_ip4n,
7571                                      path_mtu=512,
7572                                      template_interval=10)
7573         self.vapi.nat_ipfix(domain_id=self.ipfix_domain_id,
7574                             src_port=self.ipfix_src_port)
7575
7576         data = 'a' * 200
7577         pkts = self.create_stream_frag_ip6(self.pg0, self.pg1.remote_ip4,
7578                                            self.tcp_port_in, 20, data)
7579         pkts.reverse()
7580         self.pg0.add_stream(pkts)
7581         self.pg_enable_capture(self.pg_interfaces)
7582         self.pg_start()
7583         self.pg1.assert_nothing_captured()
7584         sleep(1)
7585         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
7586         capture = self.pg3.get_capture(9)
7587         ipfix = IPFIXDecoder()
7588         # first load template
7589         for p in capture:
7590             self.assertTrue(p.haslayer(IPFIX))
7591             self.assertEqual(p[IP].src, self.pg3.local_ip4)
7592             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
7593             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
7594             self.assertEqual(p[UDP].dport, 4739)
7595             self.assertEqual(p[IPFIX].observationDomainID,
7596                              self.ipfix_domain_id)
7597             if p.haslayer(Template):
7598                 ipfix.add_template(p.getlayer(Template))
7599         # verify events in data set
7600         for p in capture:
7601             if p.haslayer(Data):
7602                 data = ipfix.decode_data_set(p.getlayer(Set))
7603                 self.verify_ipfix_max_fragments_ip6(data, 1,
7604                                                     self.pg0.remote_ip6n)
7605
7606     def test_ipfix_bib_ses(self):
7607         """ IPFIX logging NAT64 BIB/session create and delete events """
7608         self.tcp_port_in = random.randint(1025, 65535)
7609         remote_host_ip6 = self.compose_ip6(self.pg1.remote_ip4,
7610                                            '64:ff9b::',
7611                                            96)
7612
7613         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7614                                                 self.nat_addr_n)
7615         self.vapi.nat64_add_del_interface(self.pg0.sw_if_index)
7616         self.vapi.nat64_add_del_interface(self.pg1.sw_if_index, is_inside=0)
7617         self.vapi.set_ipfix_exporter(collector_address=self.pg3.remote_ip4n,
7618                                      src_address=self.pg3.local_ip4n,
7619                                      path_mtu=512,
7620                                      template_interval=10)
7621         self.vapi.nat_ipfix(domain_id=self.ipfix_domain_id,
7622                             src_port=self.ipfix_src_port)
7623
7624         # Create
7625         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
7626              IPv6(src=self.pg0.remote_ip6, dst=remote_host_ip6) /
7627              TCP(sport=self.tcp_port_in, dport=25))
7628         self.pg0.add_stream(p)
7629         self.pg_enable_capture(self.pg_interfaces)
7630         self.pg_start()
7631         p = self.pg1.get_capture(1)
7632         self.tcp_port_out = p[0][TCP].sport
7633         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
7634         capture = self.pg3.get_capture(10)
7635         ipfix = IPFIXDecoder()
7636         # first load template
7637         for p in capture:
7638             self.assertTrue(p.haslayer(IPFIX))
7639             self.assertEqual(p[IP].src, self.pg3.local_ip4)
7640             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
7641             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
7642             self.assertEqual(p[UDP].dport, 4739)
7643             self.assertEqual(p[IPFIX].observationDomainID,
7644                              self.ipfix_domain_id)
7645             if p.haslayer(Template):
7646                 ipfix.add_template(p.getlayer(Template))
7647         # verify events in data set
7648         for p in capture:
7649             if p.haslayer(Data):
7650                 data = ipfix.decode_data_set(p.getlayer(Set))
7651                 if ord(data[0][230]) == 10:
7652                     self.verify_ipfix_bib(data, 1, self.pg0.remote_ip6n)
7653                 elif ord(data[0][230]) == 6:
7654                     self.verify_ipfix_nat64_ses(data,
7655                                                 1,
7656                                                 self.pg0.remote_ip6n,
7657                                                 self.pg1.remote_ip4,
7658                                                 25)
7659                 else:
7660                     self.logger.error(ppp("Unexpected or invalid packet: ", p))
7661
7662         # Delete
7663         self.pg_enable_capture(self.pg_interfaces)
7664         self.vapi.nat64_add_del_pool_addr_range(self.nat_addr_n,
7665                                                 self.nat_addr_n,
7666                                                 is_add=0)
7667         self.vapi.cli("ipfix flush")  # FIXME this should be an API call
7668         capture = self.pg3.get_capture(2)
7669         # verify events in data set
7670         for p in capture:
7671             self.assertTrue(p.haslayer(IPFIX))
7672             self.assertEqual(p[IP].src, self.pg3.local_ip4)
7673             self.assertEqual(p[IP].dst, self.pg3.remote_ip4)
7674             self.assertEqual(p[UDP].sport, self.ipfix_src_port)
7675             self.assertEqual(p[UDP].dport, 4739)
7676             self.assertEqual(p[IPFIX].observationDomainID,
7677                              self.ipfix_domain_id)
7678             if p.haslayer(Data):
7679                 data = ipfix.decode_data_set(p.getlayer(Set))
7680                 if ord(data[0][230]) == 11:
7681                     self.verify_ipfix_bib(data, 0, self.pg0.remote_ip6n)
7682                 elif ord(data[0][230]) == 7:
7683                     self.verify_ipfix_nat64_ses(data,
7684                                                 0,
7685                                                 self.pg0.remote_ip6n,
7686                                                 self.pg1.remote_ip4,
7687                                                 25)
7688                 else:
7689                     self.logger.error(ppp("Unexpected or invalid packet: ", p))
7690
7691     def nat64_get_ses_num(self):
7692         """
7693         Return number of active NAT64 sessions.
7694         """
7695         st = self.vapi.nat64_st_dump()
7696         return len(st)
7697
7698     def clear_nat64(self):
7699         """
7700         Clear NAT64 configuration.
7701         """
7702         self.vapi.nat_ipfix(enable=0, src_port=self.ipfix_src_port,
7703                             domain_id=self.ipfix_domain_id)
7704         self.ipfix_src_port = 4739
7705         self.ipfix_domain_id = 1
7706
7707         self.vapi.nat_set_timeouts()
7708
7709         interfaces = self.vapi.nat64_interface_dump()
7710         for intf in interfaces:
7711             if intf.is_inside > 1:
7712                 self.vapi.nat64_add_del_interface(intf.sw_if_index,
7713                                                   0,
7714                                                   is_add=0)
7715             self.vapi.nat64_add_del_interface(intf.sw_if_index,
7716                                               intf.is_inside,
7717                                               is_add=0)
7718
7719         bib = self.vapi.nat64_bib_dump(255)
7720         for bibe in bib:
7721             if bibe.is_static:
7722                 self.vapi.nat64_add_del_static_bib(bibe.i_addr,
7723                                                    bibe.o_addr,
7724                                                    bibe.i_port,
7725                                                    bibe.o_port,
7726                                                    bibe.proto,
7727                                                    bibe.vrf_id,
7728                                                    is_add=0)
7729
7730         adresses = self.vapi.nat64_pool_addr_dump()
7731         for addr in adresses:
7732             self.vapi.nat64_add_del_pool_addr_range(addr.address,
7733                                                     addr.address,
7734                                                     vrf_id=addr.vrf_id,
7735                                                     is_add=0)
7736
7737         prefixes = self.vapi.nat64_prefix_dump()
7738         for prefix in prefixes:
7739             self.vapi.nat64_add_del_prefix(prefix.prefix,
7740                                            prefix.prefix_len,
7741                                            vrf_id=prefix.vrf_id,
7742                                            is_add=0)
7743
7744     def tearDown(self):
7745         super(TestNAT64, self).tearDown()
7746         if not self.vpp_dead:
7747             self.logger.info(self.vapi.cli("show nat64 pool"))
7748             self.logger.info(self.vapi.cli("show nat64 interfaces"))
7749             self.logger.info(self.vapi.cli("show nat64 prefix"))
7750             self.logger.info(self.vapi.cli("show nat64 bib all"))
7751             self.logger.info(self.vapi.cli("show nat64 session table all"))
7752             self.logger.info(self.vapi.cli("show nat virtual-reassembly"))
7753             self.clear_nat64()
7754
7755
7756 class TestDSlite(MethodHolder):
7757     """ DS-Lite Test Cases """
7758
7759     @classmethod
7760     def setUpClass(cls):
7761         super(TestDSlite, cls).setUpClass()
7762
7763         try:
7764             cls.nat_addr = '10.0.0.3'
7765             cls.nat_addr_n = socket.inet_pton(socket.AF_INET, cls.nat_addr)
7766
7767             cls.create_pg_interfaces(range(2))
7768             cls.pg0.admin_up()
7769             cls.pg0.config_ip4()
7770             cls.pg0.resolve_arp()
7771             cls.pg1.admin_up()
7772             cls.pg1.config_ip6()
7773             cls.pg1.generate_remote_hosts(2)
7774             cls.pg1.configure_ipv6_neighbors()
7775
7776         except Exception:
7777             super(TestDSlite, cls).tearDownClass()
7778             raise
7779
7780     def test_dslite(self):
7781         """ Test DS-Lite """
7782         nat_config = self.vapi.nat_show_config()
7783         self.assertEqual(0, nat_config.dslite_ce)
7784
7785         self.vapi.dslite_add_del_pool_addr_range(self.nat_addr_n,
7786                                                  self.nat_addr_n)
7787         aftr_ip4 = '192.0.0.1'
7788         aftr_ip4_n = socket.inet_pton(socket.AF_INET, aftr_ip4)
7789         aftr_ip6 = '2001:db8:85a3::8a2e:370:1'
7790         aftr_ip6_n = socket.inet_pton(socket.AF_INET6, aftr_ip6)
7791         self.vapi.dslite_set_aftr_addr(aftr_ip6_n, aftr_ip4_n)
7792
7793         # UDP
7794         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
7795              IPv6(dst=aftr_ip6, src=self.pg1.remote_hosts[0].ip6) /
7796              IP(dst=self.pg0.remote_ip4, src='192.168.1.1') /
7797              UDP(sport=20000, dport=10000))
7798         self.pg1.add_stream(p)
7799         self.pg_enable_capture(self.pg_interfaces)
7800         self.pg_start()
7801         capture = self.pg0.get_capture(1)
7802         capture = capture[0]
7803         self.assertFalse(capture.haslayer(IPv6))
7804         self.assertEqual(capture[IP].src, self.nat_addr)
7805         self.assertEqual(capture[IP].dst, self.pg0.remote_ip4)
7806         self.assertNotEqual(capture[UDP].sport, 20000)
7807         self.assertEqual(capture[UDP].dport, 10000)
7808         self.assert_packet_checksums_valid(capture)
7809         out_port = capture[UDP].sport
7810
7811         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7812              IP(dst=self.nat_addr, src=self.pg0.remote_ip4) /
7813              UDP(sport=10000, dport=out_port))
7814         self.pg0.add_stream(p)
7815         self.pg_enable_capture(self.pg_interfaces)
7816         self.pg_start()
7817         capture = self.pg1.get_capture(1)
7818         capture = capture[0]
7819         self.assertEqual(capture[IPv6].src, aftr_ip6)
7820         self.assertEqual(capture[IPv6].dst, self.pg1.remote_hosts[0].ip6)
7821         self.assertEqual(capture[IP].src, self.pg0.remote_ip4)
7822         self.assertEqual(capture[IP].dst, '192.168.1.1')
7823         self.assertEqual(capture[UDP].sport, 10000)
7824         self.assertEqual(capture[UDP].dport, 20000)
7825         self.assert_packet_checksums_valid(capture)
7826
7827         # TCP
7828         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
7829              IPv6(dst=aftr_ip6, src=self.pg1.remote_hosts[1].ip6) /
7830              IP(dst=self.pg0.remote_ip4, src='192.168.1.1') /
7831              TCP(sport=20001, dport=10001))
7832         self.pg1.add_stream(p)
7833         self.pg_enable_capture(self.pg_interfaces)
7834         self.pg_start()
7835         capture = self.pg0.get_capture(1)
7836         capture = capture[0]
7837         self.assertFalse(capture.haslayer(IPv6))
7838         self.assertEqual(capture[IP].src, self.nat_addr)
7839         self.assertEqual(capture[IP].dst, self.pg0.remote_ip4)
7840         self.assertNotEqual(capture[TCP].sport, 20001)
7841         self.assertEqual(capture[TCP].dport, 10001)
7842         self.assert_packet_checksums_valid(capture)
7843         out_port = capture[TCP].sport
7844
7845         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7846              IP(dst=self.nat_addr, src=self.pg0.remote_ip4) /
7847              TCP(sport=10001, dport=out_port))
7848         self.pg0.add_stream(p)
7849         self.pg_enable_capture(self.pg_interfaces)
7850         self.pg_start()
7851         capture = self.pg1.get_capture(1)
7852         capture = capture[0]
7853         self.assertEqual(capture[IPv6].src, aftr_ip6)
7854         self.assertEqual(capture[IPv6].dst, self.pg1.remote_hosts[1].ip6)
7855         self.assertEqual(capture[IP].src, self.pg0.remote_ip4)
7856         self.assertEqual(capture[IP].dst, '192.168.1.1')
7857         self.assertEqual(capture[TCP].sport, 10001)
7858         self.assertEqual(capture[TCP].dport, 20001)
7859         self.assert_packet_checksums_valid(capture)
7860
7861         # ICMP
7862         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
7863              IPv6(dst=aftr_ip6, src=self.pg1.remote_hosts[1].ip6) /
7864              IP(dst=self.pg0.remote_ip4, src='192.168.1.1') /
7865              ICMP(id=4000, type='echo-request'))
7866         self.pg1.add_stream(p)
7867         self.pg_enable_capture(self.pg_interfaces)
7868         self.pg_start()
7869         capture = self.pg0.get_capture(1)
7870         capture = capture[0]
7871         self.assertFalse(capture.haslayer(IPv6))
7872         self.assertEqual(capture[IP].src, self.nat_addr)
7873         self.assertEqual(capture[IP].dst, self.pg0.remote_ip4)
7874         self.assertNotEqual(capture[ICMP].id, 4000)
7875         self.assert_packet_checksums_valid(capture)
7876         out_id = capture[ICMP].id
7877
7878         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7879              IP(dst=self.nat_addr, src=self.pg0.remote_ip4) /
7880              ICMP(id=out_id, type='echo-reply'))
7881         self.pg0.add_stream(p)
7882         self.pg_enable_capture(self.pg_interfaces)
7883         self.pg_start()
7884         capture = self.pg1.get_capture(1)
7885         capture = capture[0]
7886         self.assertEqual(capture[IPv6].src, aftr_ip6)
7887         self.assertEqual(capture[IPv6].dst, self.pg1.remote_hosts[1].ip6)
7888         self.assertEqual(capture[IP].src, self.pg0.remote_ip4)
7889         self.assertEqual(capture[IP].dst, '192.168.1.1')
7890         self.assertEqual(capture[ICMP].id, 4000)
7891         self.assert_packet_checksums_valid(capture)
7892
7893         # ping DS-Lite AFTR tunnel endpoint address
7894         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
7895              IPv6(src=self.pg1.remote_hosts[1].ip6, dst=aftr_ip6) /
7896              ICMPv6EchoRequest())
7897         self.pg1.add_stream(p)
7898         self.pg_enable_capture(self.pg_interfaces)
7899         self.pg_start()
7900         capture = self.pg1.get_capture(1)
7901         capture = capture[0]
7902         self.assertEqual(capture[IPv6].src, aftr_ip6)
7903         self.assertEqual(capture[IPv6].dst, self.pg1.remote_hosts[1].ip6)
7904         self.assertTrue(capture.haslayer(ICMPv6EchoReply))
7905
7906     def tearDown(self):
7907         super(TestDSlite, self).tearDown()
7908         if not self.vpp_dead:
7909             self.logger.info(self.vapi.cli("show dslite pool"))
7910             self.logger.info(
7911                 self.vapi.cli("show dslite aftr-tunnel-endpoint-address"))
7912             self.logger.info(self.vapi.cli("show dslite sessions"))
7913
7914
7915 class TestDSliteCE(MethodHolder):
7916     """ DS-Lite CE Test Cases """
7917
7918     @classmethod
7919     def setUpConstants(cls):
7920         super(TestDSliteCE, cls).setUpConstants()
7921         cls.vpp_cmdline.extend(["nat", "{", "dslite ce", "}"])
7922
7923     @classmethod
7924     def setUpClass(cls):
7925         super(TestDSliteCE, cls).setUpClass()
7926
7927         try:
7928             cls.create_pg_interfaces(range(2))
7929             cls.pg0.admin_up()
7930             cls.pg0.config_ip4()
7931             cls.pg0.resolve_arp()
7932             cls.pg1.admin_up()
7933             cls.pg1.config_ip6()
7934             cls.pg1.generate_remote_hosts(1)
7935             cls.pg1.configure_ipv6_neighbors()
7936
7937         except Exception:
7938             super(TestDSliteCE, cls).tearDownClass()
7939             raise
7940
7941     def test_dslite_ce(self):
7942         """ Test DS-Lite CE """
7943
7944         nat_config = self.vapi.nat_show_config()
7945         self.assertEqual(1, nat_config.dslite_ce)
7946
7947         b4_ip4 = '192.0.0.2'
7948         b4_ip4_n = socket.inet_pton(socket.AF_INET, b4_ip4)
7949         b4_ip6 = '2001:db8:62aa::375e:f4c1:1'
7950         b4_ip6_n = socket.inet_pton(socket.AF_INET6, b4_ip6)
7951         self.vapi.dslite_set_b4_addr(b4_ip6_n, b4_ip4_n)
7952
7953         aftr_ip4 = '192.0.0.1'
7954         aftr_ip4_n = socket.inet_pton(socket.AF_INET, aftr_ip4)
7955         aftr_ip6 = '2001:db8:85a3::8a2e:370:1'
7956         aftr_ip6_n = socket.inet_pton(socket.AF_INET6, aftr_ip6)
7957         self.vapi.dslite_set_aftr_addr(aftr_ip6_n, aftr_ip4_n)
7958
7959         self.vapi.ip_add_del_route(dst_address=aftr_ip6_n,
7960                                    dst_address_length=128,
7961                                    next_hop_address=self.pg1.remote_ip6n,
7962                                    next_hop_sw_if_index=self.pg1.sw_if_index,
7963                                    is_ipv6=1)
7964
7965         # UDP encapsulation
7966         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
7967              IP(dst=self.pg1.remote_ip4, src=self.pg0.remote_ip4) /
7968              UDP(sport=10000, dport=20000))
7969         self.pg0.add_stream(p)
7970         self.pg_enable_capture(self.pg_interfaces)
7971         self.pg_start()
7972         capture = self.pg1.get_capture(1)
7973         capture = capture[0]
7974         self.assertEqual(capture[IPv6].src, b4_ip6)
7975         self.assertEqual(capture[IPv6].dst, aftr_ip6)
7976         self.assertEqual(capture[IP].src, self.pg0.remote_ip4)
7977         self.assertEqual(capture[IP].dst, self.pg1.remote_ip4)
7978         self.assertEqual(capture[UDP].sport, 10000)
7979         self.assertEqual(capture[UDP].dport, 20000)
7980         self.assert_packet_checksums_valid(capture)
7981
7982         # UDP decapsulation
7983         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
7984              IPv6(dst=b4_ip6, src=aftr_ip6) /
7985              IP(dst=self.pg0.remote_ip4, src=self.pg1.remote_ip4) /
7986              UDP(sport=20000, dport=10000))
7987         self.pg1.add_stream(p)
7988         self.pg_enable_capture(self.pg_interfaces)
7989         self.pg_start()
7990         capture = self.pg0.get_capture(1)
7991         capture = capture[0]
7992         self.assertFalse(capture.haslayer(IPv6))
7993         self.assertEqual(capture[IP].src, self.pg1.remote_ip4)
7994         self.assertEqual(capture[IP].dst, self.pg0.remote_ip4)
7995         self.assertEqual(capture[UDP].sport, 20000)
7996         self.assertEqual(capture[UDP].dport, 10000)
7997         self.assert_packet_checksums_valid(capture)
7998
7999         # ping DS-Lite B4 tunnel endpoint address
8000         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
8001              IPv6(src=self.pg1.remote_hosts[0].ip6, dst=b4_ip6) /
8002              ICMPv6EchoRequest())
8003         self.pg1.add_stream(p)
8004         self.pg_enable_capture(self.pg_interfaces)
8005         self.pg_start()
8006         capture = self.pg1.get_capture(1)
8007         capture = capture[0]
8008         self.assertEqual(capture[IPv6].src, b4_ip6)
8009         self.assertEqual(capture[IPv6].dst, self.pg1.remote_hosts[0].ip6)
8010         self.assertTrue(capture.haslayer(ICMPv6EchoReply))
8011
8012     def tearDown(self):
8013         super(TestDSliteCE, self).tearDown()
8014         if not self.vpp_dead:
8015             self.logger.info(
8016                 self.vapi.cli("show dslite aftr-tunnel-endpoint-address"))
8017             self.logger.info(
8018                 self.vapi.cli("show dslite b4-tunnel-endpoint-address"))
8019
8020
8021 class TestNAT66(MethodHolder):
8022     """ NAT66 Test Cases """
8023
8024     @classmethod
8025     def setUpClass(cls):
8026         super(TestNAT66, cls).setUpClass()
8027
8028         try:
8029             cls.nat_addr = 'fd01:ff::2'
8030             cls.nat_addr_n = socket.inet_pton(socket.AF_INET6, cls.nat_addr)
8031
8032             cls.create_pg_interfaces(range(2))
8033             cls.interfaces = list(cls.pg_interfaces)
8034
8035             for i in cls.interfaces:
8036                 i.admin_up()
8037                 i.config_ip6()
8038                 i.configure_ipv6_neighbors()
8039
8040         except Exception:
8041             super(TestNAT66, cls).tearDownClass()
8042             raise
8043
8044     def test_static(self):
8045         """ 1:1 NAT66 test """
8046         self.vapi.nat66_add_del_interface(self.pg0.sw_if_index)
8047         self.vapi.nat66_add_del_interface(self.pg1.sw_if_index, is_inside=0)
8048         self.vapi.nat66_add_del_static_mapping(self.pg0.remote_ip6n,
8049                                                self.nat_addr_n)
8050
8051         # in2out
8052         pkts = []
8053         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
8054              IPv6(src=self.pg0.remote_ip6, dst=self.pg1.remote_ip6) /
8055              TCP())
8056         pkts.append(p)
8057         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
8058              IPv6(src=self.pg0.remote_ip6, dst=self.pg1.remote_ip6) /
8059              UDP())
8060         pkts.append(p)
8061         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
8062              IPv6(src=self.pg0.remote_ip6, dst=self.pg1.remote_ip6) /
8063              ICMPv6EchoRequest())
8064         pkts.append(p)
8065         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
8066              IPv6(src=self.pg0.remote_ip6, dst=self.pg1.remote_ip6) /
8067              GRE() / IP() / TCP())
8068         pkts.append(p)
8069         self.pg0.add_stream(pkts)
8070         self.pg_enable_capture(self.pg_interfaces)
8071         self.pg_start()
8072         capture = self.pg1.get_capture(len(pkts))
8073         for packet in capture:
8074             try:
8075                 self.assertEqual(packet[IPv6].src, self.nat_addr)
8076                 self.assertEqual(packet[IPv6].dst, self.pg1.remote_ip6)
8077                 self.assert_packet_checksums_valid(packet)
8078             except:
8079                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
8080                 raise
8081
8082         # out2in
8083         pkts = []
8084         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
8085              IPv6(src=self.pg1.remote_ip6, dst=self.nat_addr) /
8086              TCP())
8087         pkts.append(p)
8088         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
8089              IPv6(src=self.pg1.remote_ip6, dst=self.nat_addr) /
8090              UDP())
8091         pkts.append(p)
8092         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
8093              IPv6(src=self.pg1.remote_ip6, dst=self.nat_addr) /
8094              ICMPv6EchoReply())
8095         pkts.append(p)
8096         p = (Ether(dst=self.pg1.local_mac, src=self.pg1.remote_mac) /
8097              IPv6(src=self.pg1.remote_ip6, dst=self.nat_addr) /
8098              GRE() / IP() / TCP())
8099         pkts.append(p)
8100         self.pg1.add_stream(pkts)
8101         self.pg_enable_capture(self.pg_interfaces)
8102         self.pg_start()
8103         capture = self.pg0.get_capture(len(pkts))
8104         for packet in capture:
8105             try:
8106                 self.assertEqual(packet[IPv6].src, self.pg1.remote_ip6)
8107                 self.assertEqual(packet[IPv6].dst, self.pg0.remote_ip6)
8108                 self.assert_packet_checksums_valid(packet)
8109             except:
8110                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
8111                 raise
8112
8113         sm = self.vapi.nat66_static_mapping_dump()
8114         self.assertEqual(len(sm), 1)
8115         self.assertEqual(sm[0].total_pkts, 8)
8116
8117     def test_check_no_translate(self):
8118         """ NAT66 translate only when egress interface is outside interface """
8119         self.vapi.nat66_add_del_interface(self.pg0.sw_if_index)
8120         self.vapi.nat66_add_del_interface(self.pg1.sw_if_index)
8121         self.vapi.nat66_add_del_static_mapping(self.pg0.remote_ip6n,
8122                                                self.nat_addr_n)
8123
8124         # in2out
8125         p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
8126              IPv6(src=self.pg0.remote_ip6, dst=self.pg1.remote_ip6) /
8127              UDP())
8128         self.pg0.add_stream([p])
8129         self.pg_enable_capture(self.pg_interfaces)
8130         self.pg_start()
8131         capture = self.pg1.get_capture(1)
8132         packet = capture[0]
8133         try:
8134             self.assertEqual(packet[IPv6].src, self.pg0.remote_ip6)
8135             self.assertEqual(packet[IPv6].dst, self.pg1.remote_ip6)
8136         except:
8137             self.logger.error(ppp("Unexpected or invalid packet:", packet))
8138             raise
8139
8140     def clear_nat66(self):
8141         """
8142         Clear NAT66 configuration.
8143         """
8144         interfaces = self.vapi.nat66_interface_dump()
8145         for intf in interfaces:
8146             self.vapi.nat66_add_del_interface(intf.sw_if_index,
8147                                               intf.is_inside,
8148                                               is_add=0)
8149
8150         static_mappings = self.vapi.nat66_static_mapping_dump()
8151         for sm in static_mappings:
8152             self.vapi.nat66_add_del_static_mapping(sm.local_ip_address,
8153                                                    sm.external_ip_address,
8154                                                    sm.vrf_id,
8155                                                    is_add=0)
8156
8157     def tearDown(self):
8158         super(TestNAT66, self).tearDown()
8159         if not self.vpp_dead:
8160             self.logger.info(self.vapi.cli("show nat66 interfaces"))
8161             self.logger.info(self.vapi.cli("show nat66 static mappings"))
8162             self.clear_nat66()
8163
8164
8165 if __name__ == '__main__':
8166     unittest.main(testRunner=VppTestRunner)