test/test_punt.py

   1 #!/usr/bin/env python3
   2 import binascii
   3 import random
   4 import socket
   5 import os
   6 import threading
   7 import struct
   8 import copy
   9 import fcntl
  10 import time
  11
  12 from struct import unpack, unpack_from
  13
  14 try:
  15     import unittest2 as unittest
  16 except ImportError:
  17     import unittest
  18
  19 from util import ppp, ppc
  20 from re import compile
  21 import scapy.compat
  22 from scapy.packet import Raw
  23 from scapy.layers.l2 import Ether
  24 from scapy.layers.inet import IP, UDP, ICMP
  25 from scapy.layers.ipsec import ESP
  26 import scapy.layers.inet6 as inet6
  27 from scapy.layers.inet6 import IPv6, ICMPv6DestUnreach
  28 from scapy.contrib.ospf import OSPF_Hdr, OSPFv3_Hello
  29 from framework import VppTestCase, VppTestRunner
  30
  31 from vpp_ip import DpoProto
  32 from vpp_ip_route import VppIpRoute, VppRoutePath
  33 from vpp_papi import VppEnum
  34 from vpp_ipsec_tun_interface import VppIpsecTunInterface
  35
  36 NUM_PKTS = 67
  37
  38
  39 class serverSocketThread(threading.Thread):
  40     """ Socket server thread"""
  41
  42     def __init__(self, threadID, sockName):
  43         threading.Thread.__init__(self)
  44         self.threadID = threadID
  45         self.sockName = sockName
  46         self.sock = None
  47         self.rx_pkts = []
  48         self.keep_running = True
  49
  50     def rx_packets(self):
  51         # Wait for some packets on socket
  52         while self.keep_running:
  53             try:
  54                 data = self.sock.recv(65536)
  55
  56                 # punt socket metadata
  57                 # packet_desc = data[0:8]
  58
  59                 # Ethernet
  60                 self.rx_pkts.append(Ether(data[8:]))
  61             except IOError as e:
  62                 if e.errno == 11:
  63                     # nothing to receive, sleep a little
  64                     time.sleep(0.1)
  65                     pass
  66                 else:
  67                     raise
  68
  69     def run(self):
  70         self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
  71         try:
  72             os.unlink(self.sockName)
  73         except:
  74             pass
  75         self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_SNDBUF, 65536)
  76         self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_RCVBUF, 65536)
  77         fcntl.fcntl(self.sock, fcntl.F_SETFL, os.O_NONBLOCK)
  78         self.sock.bind(self.sockName)
  79
  80         self.rx_packets()
  81
  82     def close(self):
  83         self.sock.close()
  84         self.keep_running = False
  85         return self.rx_pkts
  86
  87
  88 class TestPuntSocket(VppTestCase):
  89     """ Punt Socket """
  90
  91     ports = [1111, 2222, 3333, 4444]
  92     sock_servers = list()
  93     # FIXME: nr_packets > 3 results in failure
  94     # nr_packets = 3 makes the test unstable
  95     nr_packets = 2
  96
  97     @classmethod
  98     def setUpClass(cls):
  99         super(TestPuntSocket, cls).setUpClass()
 100
 101     @classmethod
 102     def tearDownClass(cls):
 103         super(TestPuntSocket, cls).tearDownClass()
 104
 105     @classmethod
 106     def setUpConstants(cls):
 107         cls.extra_vpp_punt_config = [
 108             "punt", "{", "socket", cls.tempdir+"/socket_punt", "}"]
 109         super(TestPuntSocket, cls).setUpConstants()
 110
 111     def setUp(self):
 112         super(TestPuntSocket, self).setUp()
 113         random.seed()
 114
 115         self.create_pg_interfaces(range(2))
 116         for i in self.pg_interfaces:
 117             i.admin_up()
 118
 119     def tearDown(self):
 120         del self.sock_servers[:]
 121         super(TestPuntSocket, self).tearDown()
 122
 123     def socket_client_create(self, sock_name, id=None):
 124         thread = serverSocketThread(id, sock_name)
 125         self.sock_servers.append(thread)
 126         thread.start()
 127         return thread
 128
 129     def socket_client_close(self):
 130         rx_pkts = []
 131         for thread in self.sock_servers:
 132             rx_pkts += thread.close()
 133             thread.join()
 134         return rx_pkts
 135
 136     def verify_port(self, pr, vpr):
 137         self.assertEqual(vpr.punt.type, pr['type'])
 138         self.assertEqual(vpr.punt.punt.l4.port,
 139                          pr['punt']['l4']['port'])
 140         self.assertEqual(vpr.punt.punt.l4.protocol,
 141                          pr['punt']['l4']['protocol'])
 142         self.assertEqual(vpr.punt.punt.l4.af,
 143                          pr['punt']['l4']['af'])
 144
 145     def verify_exception(self, pr, vpr):
 146         self.assertEqual(vpr.punt.type, pr['type'])
 147         self.assertEqual(vpr.punt.punt.exception.id,
 148                          pr['punt']['exception']['id'])
 149
 150     def verify_ip_proto(self, pr, vpr):
 151         self.assertEqual(vpr.punt.type, pr['type'])
 152         self.assertEqual(vpr.punt.punt.ip_proto.af,
 153                          pr['punt']['ip_proto']['af'])
 154         self.assertEqual(vpr.punt.punt.ip_proto.protocol,
 155                          pr['punt']['ip_proto']['protocol'])
 156
 157     def verify_udp_pkts(self, rxs, n_rx, port):
 158         n_match = 0
 159         for rx in rxs:
 160             self.assertTrue(rx.haslayer(UDP))
 161             if rx[UDP].dport == port:
 162                 n_match += 1
 163         self.assertEqual(n_match, n_rx)
 164
 165
 166 def set_port(pr, port):
 167     pr['punt']['l4']['port'] = port
 168     return pr
 169
 170
 171 def set_reason(pr, reason):
 172     pr['punt']['exception']['id'] = reason
 173     return pr
 174
 175
 176 def mk_vpp_cfg4():
 177     pt_l4 = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_L4
 178     af_ip4 = VppEnum.vl_api_address_family_t.ADDRESS_IP4
 179     udp_proto = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_UDP
 180     punt_l4 = {
 181         'type': pt_l4,
 182         'punt': {
 183             'l4': {
 184                 'af': af_ip4,
 185                 'protocol': udp_proto
 186             }
 187         }
 188     }
 189     return punt_l4
 190
 191
 192 def mk_vpp_cfg6():
 193     pt_l4 = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_L4
 194     af_ip6 = VppEnum.vl_api_address_family_t.ADDRESS_IP6
 195     udp_proto = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_UDP
 196     punt_l4 = {
 197         'type': pt_l4,
 198         'punt': {
 199             'l4': {
 200                 'af': af_ip6,
 201                 'protocol': udp_proto
 202             }
 203         }
 204     }
 205     return punt_l4
 206
 207
 208 class TestIP4PuntSocket(TestPuntSocket):
 209     """ Punt Socket for IPv4 UDP """
 210
 211     @classmethod
 212     def setUpClass(cls):
 213         super(TestIP4PuntSocket, cls).setUpClass()
 214
 215     @classmethod
 216     def tearDownClass(cls):
 217         super(TestIP4PuntSocket, cls).tearDownClass()
 218
 219     def setUp(self):
 220         super(TestIP4PuntSocket, self).setUp()
 221
 222         for i in self.pg_interfaces:
 223             i.config_ip4()
 224             i.resolve_arp()
 225
 226     def tearDown(self):
 227         super(TestIP4PuntSocket, self).tearDown()
 228         for i in self.pg_interfaces:
 229             i.unconfig_ip4()
 230             i.admin_down()
 231
 232     def test_punt_socket_dump(self):
 233         """ Punt socket registration/deregistration"""
 234
 235         pt_l4 = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_L4
 236         af_ip4 = VppEnum.vl_api_address_family_t.ADDRESS_IP4
 237         udp_proto = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_UDP
 238
 239         punts = self.vapi.punt_socket_dump(type=pt_l4)
 240         self.assertEqual(len(punts), 0)
 241
 242         #
 243         # configure a punt socket
 244         #
 245         punt_l4 = mk_vpp_cfg4()
 246
 247         self.vapi.punt_socket_register(set_port(punt_l4, 1111),
 248                                        "%s/socket_punt_1111" % self.tempdir)
 249         self.vapi.punt_socket_register(set_port(punt_l4, 2222),
 250                                        "%s/socket_punt_2222" % self.tempdir)
 251         punts = self.vapi.punt_socket_dump(type=pt_l4)
 252         self.assertEqual(len(punts), 2)
 253         self.verify_port(set_port(punt_l4, 1111), punts[0])
 254         self.verify_port(set_port(punt_l4, 2222), punts[1])
 255
 256         #
 257         # deregister a punt socket
 258         #
 259         self.vapi.punt_socket_deregister(set_port(punt_l4, 1111))
 260         punts = self.vapi.punt_socket_dump(type=pt_l4)
 261         self.assertEqual(len(punts), 1)
 262
 263         #
 264         # configure a punt socket again
 265         #
 266         self.vapi.punt_socket_register(set_port(punt_l4, 1111),
 267                                        "%s/socket_punt_1111" % self.tempdir)
 268         self.vapi.punt_socket_register(set_port(punt_l4, 3333),
 269                                        "%s/socket_punt_3333" % self.tempdir)
 270         punts = self.vapi.punt_socket_dump(type=pt_l4)
 271         self.assertEqual(len(punts), 3)
 272
 273         self.logger.info(self.vapi.cli("sh punt sock reg"))
 274
 275         #
 276         # deregister all punt socket
 277         #
 278         self.vapi.punt_socket_deregister(set_port(punt_l4, 1111))
 279         self.vapi.punt_socket_deregister(set_port(punt_l4, 2222))
 280         self.vapi.punt_socket_deregister(set_port(punt_l4, 3333))
 281         punts = self.vapi.punt_socket_dump(type=pt_l4)
 282         self.assertEqual(len(punts), 0)
 283
 284     def test_punt_socket_traffic_single_port_single_socket(self):
 285         """ Punt socket traffic single port single socket"""
 286
 287         port = self.ports[0]
 288         pt_l4 = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_L4
 289         punt_l4 = set_port(mk_vpp_cfg4(), port)
 290
 291         p = (Ether(src=self.pg0.remote_mac,
 292                    dst=self.pg0.local_mac) /
 293              IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
 294              UDP(sport=9876, dport=port) /
 295              Raw(b'\xa5' * 100))
 296
 297         pkts = p * self.nr_packets
 298
 299         punts = self.vapi.punt_socket_dump(type=pt_l4)
 300         self.assertEqual(len(punts), 0)
 301
 302         #
 303         # expect ICMP - port unreachable for all packets
 304         #
 305         rx = self.send_and_expect(self.pg0, pkts, self.pg0)
 306
 307         for p in rx:
 308             self.assertEqual(int(p[IP].proto), 1)   # ICMP
 309             self.assertEqual(int(p[ICMP].code), 3)  # unreachable
 310
 311         #
 312         # configure a punt socket
 313         #
 314         self.socket_client_create("%s/socket_%d" % (self.tempdir, port))
 315         self.vapi.punt_socket_register(punt_l4, "%s/socket_%d" %
 316                                        (self.tempdir, port))
 317         punts = self.vapi.punt_socket_dump(type=pt_l4)
 318         self.assertEqual(len(punts), 1)
 319
 320         #
 321         # expect punt socket and no packets on pg0
 322         #
 323         self.send_and_assert_no_replies(self.pg0, pkts)
 324         rx = self.socket_client_close()
 325         self.verify_udp_pkts(rx, len(pkts), port)
 326
 327         #
 328         # remove punt socket. expect ICMP - port unreachable for all packets
 329         #
 330         self.vapi.punt_socket_deregister(punt_l4)
 331         punts = self.vapi.punt_socket_dump(type=pt_l4)
 332         self.assertEqual(len(punts), 0)
 333
 334         rx = self.send_and_expect(self.pg0, pkts, self.pg0)
 335         for p in rx:
 336             self.assertEqual(int(p[IP].proto), 1)   # ICMP
 337             self.assertEqual(int(p[ICMP].code), 3)  # unreachable
 338
 339     def test_punt_socket_traffic_multi_ports_multi_sockets(self):
 340         """ Punt socket traffic multi ports and multi sockets"""
 341
 342         punt_l4 = mk_vpp_cfg4()
 343
 344         # configuration for each UDP port
 345         cfgs = dict()
 346
 347         #
 348         # create stream of packets for each port
 349         #
 350         for port in self.ports:
 351             # choose port from port list
 352             cfgs[port] = {}
 353
 354             pkt = (Ether(src=self.pg0.remote_mac,
 355                          dst=self.pg0.local_mac) /
 356                    IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
 357                    UDP(sport=9876, dport=port) /
 358                    Raw(b'\xa5' * 100))
 359             cfgs[port]['pkts'] = pkt * self.nr_packets
 360             cfgs[port]['port'] = port
 361             cfgs[port]['vpp'] = copy.deepcopy(set_port(punt_l4, port))
 362
 363             # configure punt sockets
 364             cfgs[port]['sock'] = self.socket_client_create(
 365                 "%s/socket_%d" % (self.tempdir, port))
 366             self.vapi.punt_socket_register(
 367                 cfgs[port]['vpp'],
 368                 "%s/socket_%d" % (self.tempdir, port))
 369
 370         #
 371         # send the packets that get punted
 372         #
 373         for cfg in cfgs.values():
 374             self.send_and_assert_no_replies(self.pg0, cfg['pkts'])
 375
 376         #
 377         # test that we got the excepted packets on the expected socket
 378         #
 379         for cfg in cfgs.values():
 380             rx = cfg['sock'].close()
 381             self.verify_udp_pkts(rx, len(cfg['pkts']), cfg['port'])
 382             self.vapi.punt_socket_deregister(cfg['vpp'])
 383
 384     def test_punt_socket_traffic_multi_ports_single_socket(self):
 385         """ Punt socket traffic multi ports and single socket"""
 386
 387         pt_l4 = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_L4
 388         punt_l4 = mk_vpp_cfg4()
 389
 390         #
 391         # create stream of packets with each port
 392         #
 393         pkts = []
 394         for port in self.ports:
 395             # choose port from port list
 396             pkt = (Ether(src=self.pg0.remote_mac,
 397                          dst=self.pg0.local_mac) /
 398                    IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
 399                    UDP(sport=9876, dport=port) /
 400                    Raw(b'\xa5' * 100))
 401             pkts += pkt * self.nr_packets
 402
 403         #
 404         # configure a punt socket
 405         #
 406         self.socket_client_create("%s/socket_multi" % self.tempdir)
 407         for p in self.ports:
 408             self.vapi.punt_socket_register(set_port(punt_l4, p),
 409                                            "%s/socket_multi" % self.tempdir)
 410         punts = self.vapi.punt_socket_dump(type=pt_l4)
 411         self.assertEqual(len(punts), len(self.ports))
 412
 413         #
 414         # expect punt socket and no packets on pg0
 415         #
 416         self.send_and_assert_no_replies(self.pg0, pkts)
 417         self.logger.info(self.vapi.cli("show trace"))
 418         rx = self.socket_client_close()
 419
 420         for p in self.ports:
 421             self.verify_udp_pkts(rx, self.nr_packets, p)
 422             self.vapi.punt_socket_deregister(set_port(punt_l4, p))
 423         punts = self.vapi.punt_socket_dump(type=pt_l4)
 424         self.assertEqual(len(punts), 0)
 425
 426
 427 class TestIP6PuntSocket(TestPuntSocket):
 428     """ Punt Socket for IPv6 UDP """
 429
 430     @classmethod
 431     def setUpClass(cls):
 432         super(TestIP6PuntSocket, cls).setUpClass()
 433
 434     @classmethod
 435     def tearDownClass(cls):
 436         super(TestIP6PuntSocket, cls).tearDownClass()
 437
 438     def setUp(self):
 439         super(TestIP6PuntSocket, self).setUp()
 440
 441         for i in self.pg_interfaces:
 442             i.config_ip6()
 443             i.resolve_ndp()
 444
 445     def tearDown(self):
 446         super(TestIP6PuntSocket, self).tearDown()
 447         for i in self.pg_interfaces:
 448             i.unconfig_ip6()
 449             i.admin_down()
 450
 451     def test_punt_socket_dump(self):
 452         """ Punt socket registration """
 453
 454         pt_l4 = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_L4
 455         af_ip6 = VppEnum.vl_api_address_family_t.ADDRESS_IP6
 456         udp_proto = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_UDP
 457         #
 458         # configure a punt socket
 459         #
 460         punt_l4 = {
 461             'type': pt_l4,
 462             'punt': {
 463                 'l4': {
 464                     'af': af_ip6,
 465                     'protocol': udp_proto
 466                 }
 467             }
 468         }
 469
 470         punts = self.vapi.punt_socket_dump(type=pt_l4)
 471         self.assertEqual(len(punts), 0)
 472
 473         #
 474         # configure a punt socket
 475         #
 476         self.vapi.punt_socket_register(set_port(punt_l4, 1111),
 477                                        "%s/socket_1111" % self.tempdir)
 478         self.vapi.punt_socket_register(set_port(punt_l4, 2222),
 479                                        "%s/socket_2222" % self.tempdir)
 480         punts = self.vapi.punt_socket_dump(type=pt_l4)
 481         self.assertEqual(len(punts), 2)
 482         self.verify_port(set_port(punt_l4, 1111), punts[0])
 483         self.verify_port(set_port(punt_l4, 2222), punts[1])
 484
 485         #
 486         # deregister a punt socket
 487         #
 488         self.vapi.punt_socket_deregister(set_port(punt_l4, 1111))
 489         punts = self.vapi.punt_socket_dump(type=pt_l4)
 490         self.assertEqual(len(punts), 1)
 491
 492         #
 493         # configure a punt socket again
 494         #
 495         self.vapi.punt_socket_register(set_port(punt_l4, 1111),
 496                                        "%s/socket_1111" % self.tempdir)
 497         punts = self.vapi.punt_socket_dump(type=pt_l4)
 498         self.assertEqual(len(punts), 2)
 499
 500         #
 501         # deregister all punt socket
 502         #
 503         self.vapi.punt_socket_deregister(set_port(punt_l4, 1111))
 504         self.vapi.punt_socket_deregister(set_port(punt_l4, 2222))
 505         self.vapi.punt_socket_deregister(set_port(punt_l4, 3333))
 506         punts = self.vapi.punt_socket_dump(type=pt_l4)
 507         self.assertEqual(len(punts), 0)
 508
 509     def test_punt_socket_traffic_single_port_single_socket(self):
 510         """ Punt socket traffic single port single socket"""
 511
 512         port = self.ports[0]
 513         pt_l4 = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_L4
 514         af_ip6 = VppEnum.vl_api_address_family_t.ADDRESS_IP6
 515         udp_proto = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_UDP
 516         punt_l4 = {
 517             'type': pt_l4,
 518             'punt': {
 519                 'l4': {
 520                     'af': af_ip6,
 521                     'protocol': udp_proto,
 522                     'port': port,
 523                 }
 524             }
 525         }
 526
 527         p = (Ether(src=self.pg0.remote_mac,
 528                    dst=self.pg0.local_mac) /
 529              IPv6(src=self.pg0.remote_ip6, dst=self.pg0.local_ip6) /
 530              inet6.UDP(sport=9876, dport=port) /
 531              Raw(b'\xa5' * 100))
 532
 533         pkts = p * self.nr_packets
 534
 535         punts = self.vapi.punt_socket_dump(type=pt_l4)
 536         self.assertEqual(len(punts), 0)
 537
 538         #
 539         # expect ICMPv6 - destination unreachable for all packets
 540         #
 541         self.vapi.cli("clear trace")
 542         self.pg0.add_stream(pkts)
 543         self.pg_enable_capture(self.pg_interfaces)
 544         self.pg_start()
 545         # FIXME - when punt socket deregister is implemented
 546         # rx = self.pg0.get_capture(self.nr_packets)
 547         # for p in rx:
 548         #     self.assertEqual(int(p[IPv6].nh), 58)                # ICMPv6
 549         #     self.assertEqual(int(p[ICMPv6DestUnreach].code),4)  # unreachable
 550
 551         #
 552         # configure a punt socket
 553         #
 554         self.socket_client_create("%s/socket_%d" % (self.tempdir, port))
 555         self.vapi.punt_socket_register(punt_l4, "%s/socket_%d" %
 556                                        (self.tempdir, port))
 557         punts = self.vapi.punt_socket_dump(type=pt_l4)
 558         self.assertEqual(len(punts), 1)
 559
 560         #
 561         # expect punt socket and no packets on pg0
 562         #
 563         self.vapi.cli("clear errors")
 564         self.vapi.cli("clear trace")
 565         self.pg0.add_stream(pkts)
 566         self.pg_enable_capture(self.pg_interfaces)
 567         self.pg_start()
 568         self.pg0.get_capture(0)
 569         self.logger.info(self.vapi.cli("show trace"))
 570         rx = self.socket_client_close()
 571         self.verify_udp_pkts(rx, len(pkts), port)
 572
 573         #
 574         # remove punt socket. expect ICMP - dest. unreachable for all packets
 575         #
 576         self.vapi.punt_socket_deregister(punt_l4)
 577         punts = self.vapi.punt_socket_dump(type=pt_l4)
 578         self.assertEqual(len(punts), 0)
 579         self.pg0.add_stream(pkts)
 580         self.pg_enable_capture(self.pg_interfaces)
 581         self.pg_start()
 582         # FIXME - when punt socket deregister is implemented
 583         # self.pg0.get_capture(nr_packets)
 584
 585     def test_punt_socket_traffic_multi_ports_multi_sockets(self):
 586         """ Punt socket traffic multi ports and multi sockets"""
 587
 588         punt_l4 = mk_vpp_cfg6()
 589
 590         # configuration for each UDP port
 591         cfgs = dict()
 592
 593         #
 594         # create stream of packets for each port
 595         #
 596         for port in self.ports:
 597             # choose port from port list
 598             cfgs[port] = {}
 599
 600             pkt = (Ether(src=self.pg0.remote_mac,
 601                          dst=self.pg0.local_mac) /
 602                    IPv6(src=self.pg0.remote_ip6, dst=self.pg0.local_ip6) /
 603                    UDP(sport=9876, dport=port) /
 604                    Raw(b'\xa5' * 100))
 605             cfgs[port]['pkts'] = pkt * self.nr_packets
 606             cfgs[port]['port'] = port
 607             cfgs[port]['vpp'] = copy.deepcopy(set_port(punt_l4, port))
 608
 609             # configure punt sockets
 610             cfgs[port]['sock'] = self.socket_client_create(
 611                 "%s/socket_%d" % (self.tempdir, port))
 612             self.vapi.punt_socket_register(
 613                 cfgs[port]['vpp'],
 614                 "%s/socket_%d" % (self.tempdir, port))
 615
 616         #
 617         # send the packets that get punted
 618         #
 619         for cfg in cfgs.values():
 620             self.send_and_assert_no_replies(self.pg0, cfg['pkts'])
 621
 622         #
 623         # test that we got the excepted packets on the expected socket
 624         #
 625         for cfg in cfgs.values():
 626             rx = cfg['sock'].close()
 627             self.verify_udp_pkts(rx, len(cfg['pkts']), cfg['port'])
 628             self.vapi.punt_socket_deregister(cfg['vpp'])
 629
 630     def test_punt_socket_traffic_multi_ports_single_socket(self):
 631         """ Punt socket traffic multi ports and single socket"""
 632
 633         pt_l4 = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_L4
 634         af_ip6 = VppEnum.vl_api_address_family_t.ADDRESS_IP6
 635         udp_proto = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_UDP
 636         punt_l4 = {
 637             'type': pt_l4,
 638             'punt': {
 639                 'l4': {
 640                     'af': af_ip6,
 641                     'protocol': udp_proto,
 642                 }
 643             }
 644         }
 645
 646         #
 647         # create stream of packets with each port
 648         #
 649         pkts = []
 650         for port in self.ports:
 651             # choose port from port list
 652             pkt = (Ether(src=self.pg0.remote_mac,
 653                          dst=self.pg0.local_mac) /
 654                    IPv6(src=self.pg0.remote_ip6, dst=self.pg0.local_ip6) /
 655                    UDP(sport=9876, dport=port) /
 656                    Raw(b'\xa5' * 100))
 657             pkts += pkt * self.nr_packets
 658
 659         #
 660         # no punt socket
 661         #
 662         punts = self.vapi.punt_socket_dump(type=pt_l4)
 663         self.assertEqual(len(punts), 0)
 664
 665         #
 666         # configure a punt socket
 667         #
 668         self.socket_client_create("%s/socket_multi" % self.tempdir)
 669         for p in self.ports:
 670             self.vapi.punt_socket_register(set_port(punt_l4, p),
 671                                            "%s/socket_multi" % self.tempdir)
 672         punts = self.vapi.punt_socket_dump(type=pt_l4)
 673         self.assertEqual(len(punts), len(self.ports))
 674
 675         #
 676         # expect punt socket and no packets on pg0
 677         #
 678         self.vapi.cli("clear errors")
 679         self.vapi.cli("clear trace")
 680         self.pg0.add_stream(pkts)
 681         self.pg_enable_capture(self.pg_interfaces)
 682         self.pg_start()
 683         # give a chance to punt socket to collect all packets
 684         self.sleep(1)
 685         self.pg0.get_capture(0)
 686         rx = self.socket_client_close()
 687
 688         for p in self.ports:
 689             self.verify_udp_pkts(rx, self.nr_packets, p)
 690             self.vapi.punt_socket_deregister(set_port(punt_l4, p))
 691         punts = self.vapi.punt_socket_dump(type=pt_l4)
 692         self.assertEqual(len(punts), 0)
 693
 694
 695 class TestExceptionPuntSocket(TestPuntSocket):
 696     """ Punt Socket for Exceptions """
 697
 698     @classmethod
 699     def setUpClass(cls):
 700         super(TestExceptionPuntSocket, cls).setUpClass()
 701
 702     @classmethod
 703     def tearDownClass(cls):
 704         super(TestExceptionPuntSocket, cls).tearDownClass()
 705
 706     def setUp(self):
 707         super(TestExceptionPuntSocket, self).setUp()
 708
 709         for i in self.pg_interfaces:
 710             i.config_ip4()
 711             i.resolve_arp()
 712
 713     def tearDown(self):
 714         super(TestExceptionPuntSocket, self).tearDown()
 715         for i in self.pg_interfaces:
 716             i.unconfig_ip4()
 717             i.admin_down()
 718
 719     def test_registration(self):
 720         """ Punt socket registration/deregistration"""
 721
 722         pt_ex = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_EXCEPTION
 723
 724         punts = self.vapi.punt_socket_dump(type=pt_ex)
 725         self.assertEqual(len(punts), 0)
 726
 727         #
 728         # configure a punt socket
 729         #
 730         punt_ex = {
 731             'type': pt_ex,
 732             'punt': {
 733                 'exception': {}
 734             }
 735         }
 736
 737         self.vapi.punt_socket_register(set_reason(punt_ex, 1),
 738                                        "%s/socket_punt_1" % self.tempdir)
 739         self.vapi.punt_socket_register(set_reason(punt_ex, 2),
 740                                        "%s/socket_punt_2" % self.tempdir)
 741         punts = self.vapi.punt_socket_dump(type=pt_ex)
 742         self.assertEqual(len(punts), 2)
 743         self.verify_exception(set_reason(punt_ex, 1), punts[0])
 744         self.verify_exception(set_reason(punt_ex, 2), punts[1])
 745
 746         #
 747         # deregister a punt socket
 748         #
 749         self.vapi.punt_socket_deregister(set_reason(punt_ex, 1))
 750         punts = self.vapi.punt_socket_dump(type=pt_ex)
 751         self.assertEqual(len(punts), 1)
 752
 753         #
 754         # configure a punt socket again
 755         #
 756         self.vapi.punt_socket_register(set_reason(punt_ex, 1),
 757                                        "%s/socket_punt_1" % self.tempdir)
 758         self.vapi.punt_socket_register(set_reason(punt_ex, 3),
 759                                        "%s/socket_punt_3" % self.tempdir)
 760         punts = self.vapi.punt_socket_dump(type=pt_ex)
 761         self.assertEqual(len(punts), 3)
 762
 763         self.logger.info(self.vapi.cli("sh punt sock reg exception"))
 764
 765         #
 766         # deregister all punt socket
 767         #
 768         self.vapi.punt_socket_deregister(set_reason(punt_ex, 1))
 769         self.vapi.punt_socket_deregister(set_reason(punt_ex, 2))
 770         self.vapi.punt_socket_deregister(set_reason(punt_ex, 3))
 771         punts = self.vapi.punt_socket_dump(type=pt_ex)
 772         self.assertEqual(len(punts), 0)
 773
 774     def verify_esp_pkts(self, rxs, n_sent, spi, has_udp):
 775         self.assertEqual(len(rxs), n_sent)
 776         for rx in rxs:
 777             self.assertTrue(rx.haslayer(IP))
 778             self.assertTrue(rx.haslayer(ESP))
 779             self.assertEqual(rx[ESP].spi, spi)
 780             if has_udp:
 781                 self.assertTrue(rx.haslayer(UDP))
 782
 783     def test_traffic(self):
 784         """ Punt socket traffic """
 785
 786         port = self.ports[0]
 787         pt_ex = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_EXCEPTION
 788         punt_ex = {
 789             'type': pt_ex,
 790             'punt': {
 791                 'exception': {}
 792             }
 793         }
 794
 795         #
 796         # we need an IPSec tunnels for this to work otherwise ESP gets dropped
 797         # due to unknown IP proto
 798         #
 799         VppIpsecTunInterface(self, self.pg0, 1000, 1000,
 800                              (VppEnum.vl_api_ipsec_crypto_alg_t.
 801                               IPSEC_API_CRYPTO_ALG_AES_CBC_128),
 802                              b"0123456701234567",
 803                              b"0123456701234567",
 804                              (VppEnum.vl_api_ipsec_integ_alg_t.
 805                               IPSEC_API_INTEG_ALG_SHA1_96),
 806                              b"0123456701234567",
 807                              b"0123456701234567").add_vpp_config()
 808         VppIpsecTunInterface(self, self.pg0, 1001, 1001,
 809                              (VppEnum.vl_api_ipsec_crypto_alg_t.
 810                               IPSEC_API_CRYPTO_ALG_AES_CBC_128),
 811                              b"0123456701234567",
 812                              b"0123456701234567",
 813                              (VppEnum.vl_api_ipsec_integ_alg_t.
 814                               IPSEC_API_INTEG_ALG_SHA1_96),
 815                              b"0123456701234567",
 816                              b"0123456701234567",
 817                              udp_encap=True).add_vpp_config()
 818
 819         #
 820         # we're dealing with IPSec tunnels punting for no-such-tunnel
 821         # adn SPI=0
 822         #
 823         cfgs = dict()
 824         cfgs['ipsec4-no-such-tunnel'] = {'spi': 99, 'udp': False}
 825         cfgs['ipsec4-spi-o-udp-0'] = {'spi': 0, 'udp': True}
 826
 827         #
 828         # find the VPP ID for these punt exception reasin
 829         #
 830         rs = self.vapi.punt_reason_dump()
 831         for key in cfgs:
 832             for r in rs:
 833                 if r.reason.name == key:
 834                     cfgs[key]['id'] = r.reason.id
 835                     cfgs[key]['vpp'] = copy.deepcopy(
 836                         set_reason(punt_ex,
 837                                    cfgs[key]['id']))
 838                     break
 839
 840         #
 841         # configure punt sockets
 842         #
 843         for cfg in cfgs.values():
 844             cfg['sock'] = self.socket_client_create("%s/socket_%d" %
 845                                                     (self.tempdir, cfg['id']))
 846             self.vapi.punt_socket_register(
 847                 cfg['vpp'], "%s/socket_%d" % (self.tempdir, cfg['id']))
 848
 849         #
 850         # create packet streams for 'no-such-tunnel' exception
 851         #
 852         for cfg in cfgs.values():
 853             pkt = (Ether(src=self.pg0.remote_mac,
 854                          dst=self.pg0.local_mac) /
 855                    IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4))
 856             if (cfg['udp']):
 857                 pkt = pkt / UDP(sport=666, dport=4500)
 858             pkt = (pkt / ESP(spi=cfg['spi'], seq=3) /
 859                    Raw(b'\xa5' * 100))
 860             cfg['pkts'] = [pkt]
 861
 862         #
 863         # send packets for each SPI we expect to be punted
 864         #
 865         for cfg in cfgs.values():
 866             self.send_and_assert_no_replies(self.pg0, cfg['pkts'])
 867
 868         #
 869         # verify the punted packets arrived on the associated socket
 870         #
 871         for cfg in cfgs.values():
 872             rx = cfg['sock'].close()
 873             self.verify_esp_pkts(rx, len(cfg['pkts']),
 874                                  cfg['spi'], cfg['udp'])
 875
 876         #
 877         # socket deregister
 878         #
 879         for cfg in cfgs.values():
 880             self.vapi.punt_socket_deregister(cfg['vpp'])
 881
 882
 883 class TestIpProtoPuntSocket(TestPuntSocket):
 884     """ Punt Socket for IP packets """
 885
 886     @classmethod
 887     def setUpClass(cls):
 888         super(TestIpProtoPuntSocket, cls).setUpClass()
 889
 890     @classmethod
 891     def tearDownClass(cls):
 892         super(TestIpProtoPuntSocket, cls).tearDownClass()
 893
 894     def setUp(self):
 895         super(TestIpProtoPuntSocket, self).setUp()
 896
 897         for i in self.pg_interfaces:
 898             i.config_ip4()
 899             i.resolve_arp()
 900
 901     def tearDown(self):
 902         super(TestIpProtoPuntSocket, self).tearDown()
 903         for i in self.pg_interfaces:
 904             i.unconfig_ip4()
 905             i.admin_down()
 906
 907     def test_registration(self):
 908         """ Punt socket registration/deregistration"""
 909
 910         af_ip4 = VppEnum.vl_api_address_family_t.ADDRESS_IP4
 911         pt_ip = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_IP_PROTO
 912         proto_ospf = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_OSPF
 913         proto_eigrp = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_EIGRP
 914
 915         punts = self.vapi.punt_socket_dump(type=pt_ip)
 916         self.assertEqual(len(punts), 0)
 917
 918         #
 919         # configure a punt socket
 920         #
 921         punt_ospf = {
 922             'type': pt_ip,
 923             'punt': {
 924                 'ip_proto': {
 925                     'af': af_ip4,
 926                     'protocol': proto_ospf
 927                 }
 928             }
 929         }
 930         punt_eigrp = {
 931             'type': pt_ip,
 932             'punt': {
 933                 'ip_proto': {
 934                     'af': af_ip4,
 935                     'protocol': proto_eigrp
 936                 }
 937             }
 938         }
 939
 940         self.vapi.punt_socket_register(punt_ospf,
 941                                        "%s/socket_punt_1" % self.tempdir)
 942         self.vapi.punt_socket_register(punt_eigrp,
 943                                        "%s/socket_punt_2" % self.tempdir)
 944         self.logger.info(self.vapi.cli("sh punt sock reg ip"))
 945         punts = self.vapi.punt_socket_dump(type=pt_ip)
 946         self.assertEqual(len(punts), 2)
 947         self.verify_ip_proto(punt_ospf, punts[0])
 948         self.verify_ip_proto(punt_eigrp, punts[1])
 949
 950         #
 951         # deregister a punt socket
 952         #
 953         self.vapi.punt_socket_deregister(punt_ospf)
 954         punts = self.vapi.punt_socket_dump(type=pt_ip)
 955         self.assertEqual(len(punts), 1)
 956
 957         #
 958         # configure a punt socket again
 959         #
 960         self.vapi.punt_socket_register(punt_ospf,
 961                                        "%s/socket_punt_3" % self.tempdir)
 962         punts = self.vapi.punt_socket_dump(type=pt_ip)
 963         self.assertEqual(len(punts), 2)
 964
 965         self.logger.info(self.vapi.cli("sh punt sock reg exception"))
 966
 967         #
 968         # deregister all punt socket
 969         #
 970         self.vapi.punt_socket_deregister(punt_eigrp)
 971         self.vapi.punt_socket_deregister(punt_ospf)
 972         punts = self.vapi.punt_socket_dump(type=pt_ip)
 973         self.assertEqual(len(punts), 0)
 974
 975     def verify_ospf_pkts(self, rxs, n_sent):
 976         self.assertEqual(len(rxs), n_sent)
 977         for rx in rxs:
 978             self.assertTrue(rx.haslayer(OSPF_Hdr))
 979
 980     def test_traffic(self):
 981         """ Punt socket traffic """
 982
 983         af_ip4 = VppEnum.vl_api_address_family_t.ADDRESS_IP4
 984         pt_ip = VppEnum.vl_api_punt_type_t.PUNT_API_TYPE_IP_PROTO
 985         proto_ospf = VppEnum.vl_api_ip_proto_t.IP_API_PROTO_OSPF
 986
 987         #
 988         # configure a punt socket to capture OSPF packets
 989         #
 990         punt_ospf = {
 991             'type': pt_ip,
 992             'punt': {
 993                 'ip_proto': {
 994                     'af': af_ip4,
 995                     'protocol': proto_ospf
 996                 }
 997             }
 998         }
 999
1000         #
1001         # create packet streams and configure a punt sockets
1002         #
1003         pkt = (Ether(src=self.pg0.remote_mac,
1004                      dst=self.pg0.local_mac) /
1005                IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
1006                OSPF_Hdr() /
1007                OSPFv3_Hello())
1008         pkts = pkt * 7
1009
1010         sock = self.socket_client_create("%s/socket_1" % self.tempdir)
1011         self.vapi.punt_socket_register(
1012             punt_ospf, "%s/socket_1" % self.tempdir)
1013
1014         #
1015         # send packets for each SPI we expect to be punted
1016         #
1017         self.send_and_assert_no_replies(self.pg0, pkts)
1018
1019         #
1020         # verify the punted packets arrived on the associated socket
1021         #
1022         rx = sock.close()
1023         self.verify_ospf_pkts(rx, len(pkts))
1024         self.vapi.punt_socket_deregister(punt_ospf)
1025
1026
1027 class TestPunt(VppTestCase):
1028     """ Exception Punt Test Case """
1029
1030     @classmethod
1031     def setUpClass(cls):
1032         super(TestPunt, cls).setUpClass()
1033
1034     @classmethod
1035     def tearDownClass(cls):
1036         super(TestPunt, cls).tearDownClass()
1037
1038     def setUp(self):
1039         super(TestPunt, self).setUp()
1040
1041         self.create_pg_interfaces(range(4))
1042
1043         for i in self.pg_interfaces:
1044             i.admin_up()
1045             i.config_ip4()
1046             i.resolve_arp()
1047             i.config_ip6()
1048             i.resolve_ndp()
1049
1050     def tearDown(self):
1051         for i in self.pg_interfaces:
1052             i.unconfig_ip4()
1053             i.unconfig_ip6()
1054             i.ip6_disable()
1055             i.admin_down()
1056         super(TestPunt, self).tearDown()
1057
1058     def test_punt(self):
1059         """ Exception Path testing """
1060
1061         #
1062         # dump the punt registered reasons
1063         #  search for a few we know should be there
1064         #
1065         rs = self.vapi.punt_reason_dump()
1066
1067         reasons = ["ipsec6-no-such-tunnel",
1068                    "ipsec4-no-such-tunnel",
1069                    "ipsec4-spi-o-udp-0"]
1070
1071         for reason in reasons:
1072             found = False
1073             for r in rs:
1074                 if r.reason.name == reason:
1075                     found = True
1076                     break
1077             self.assertTrue(found)
1078
1079         #
1080         # Using the test CLI we will hook in a exception path to
1081         # send ACL deny packets out of pg0 and pg1.
1082         # the ACL is src,dst = 1.1.1.1,1.1.1.2
1083         #
1084         ip_1_1_1_2 = VppIpRoute(self, "1.1.1.2", 32,
1085                                 [VppRoutePath(self.pg3.remote_ip4,
1086                                               self.pg3.sw_if_index)])
1087         ip_1_1_1_2.add_vpp_config()
1088         ip_1_2 = VppIpRoute(self, "1::2", 128,
1089                             [VppRoutePath(self.pg3.remote_ip6,
1090                                           self.pg3.sw_if_index,
1091                                           proto=DpoProto.DPO_PROTO_IP6)])
1092         ip_1_2.add_vpp_config()
1093
1094         p4 = (Ether(src=self.pg2.remote_mac,
1095                     dst=self.pg2.local_mac) /
1096               IP(src="1.1.1.1", dst="1.1.1.2") /
1097               UDP(sport=1234, dport=1234) /
1098               Raw(b'\xa5' * 100))
1099         p6 = (Ether(src=self.pg2.remote_mac,
1100                     dst=self.pg2.local_mac) /
1101               IPv6(src="1::1", dst="1::2") /
1102               UDP(sport=1234, dport=1234) /
1103               Raw(b'\xa5' * 100))
1104         self.send_and_expect(self.pg2, p4*1, self.pg3)
1105         self.send_and_expect(self.pg2, p6*1, self.pg3)
1106
1107         #
1108         # apply the punting features
1109         #
1110         self.vapi.cli("test punt pg2")
1111
1112         #
1113         # dump the punt reasons to learn the IDs assigned
1114         #
1115         rs = self.vapi.punt_reason_dump(reason={'name': "reason-v4"})
1116         r4 = rs[0].reason.id
1117         rs = self.vapi.punt_reason_dump(reason={'name': "reason-v6"})
1118         r6 = rs[0].reason.id
1119
1120         #
1121         # pkts now dropped
1122         #
1123         self.send_and_assert_no_replies(self.pg2, p4*NUM_PKTS)
1124         self.send_and_assert_no_replies(self.pg2, p6*NUM_PKTS)
1125
1126         #
1127         # Check state:
1128         #  1 - node error counters
1129         #  2 - per-reason counters
1130         #    2, 3 are the index of the assigned punt reason
1131         #
1132         stats = self.statistics.get_err_counter(
1133             "/err/punt-dispatch/No registrations")
1134         self.assertEqual(stats, 2*NUM_PKTS)
1135
1136         stats = self.statistics.get_counter("/net/punt")
1137         self.assertEqual(stats[0][r4]['packets'], NUM_PKTS)
1138         self.assertEqual(stats[0][r6]['packets'], NUM_PKTS)
1139
1140         #
1141         # use the test CLI to test a client that punts exception
1142         # packets out of pg0
1143         #
1144         self.vapi.cli("test punt pg0 %s" % self.pg0.remote_ip4)
1145         self.vapi.cli("test punt pg0 %s" % self.pg0.remote_ip6)
1146
1147         rx4s = self.send_and_expect(self.pg2, p4*NUM_PKTS, self.pg0)
1148         rx6s = self.send_and_expect(self.pg2, p6*NUM_PKTS, self.pg0)
1149
1150         #
1151         # check the packets come out IP unmodified but destined to pg0 host
1152         #
1153         for rx in rx4s:
1154             self.assertEqual(rx[Ether].dst, self.pg0.remote_mac)
1155             self.assertEqual(rx[Ether].src, self.pg0.local_mac)
1156             self.assertEqual(p4[IP].dst, rx[IP].dst)
1157             self.assertEqual(p4[IP].ttl, rx[IP].ttl)
1158         for rx in rx6s:
1159             self.assertEqual(rx[Ether].dst, self.pg0.remote_mac)
1160             self.assertEqual(rx[Ether].src, self.pg0.local_mac)
1161             self.assertEqual(p6[IPv6].dst, rx[IPv6].dst)
1162             self.assertEqual(p6[IPv6].hlim, rx[IPv6].hlim)
1163
1164         stats = self.statistics.get_counter("/net/punt")
1165         self.assertEqual(stats[0][r4]['packets'], 2*NUM_PKTS)
1166         self.assertEqual(stats[0][r6]['packets'], 2*NUM_PKTS)
1167
1168         #
1169         # add another registration for the same reason to send packets
1170         # out of pg1
1171         #
1172         self.vapi.cli("test punt pg1 %s" % self.pg1.remote_ip4)
1173         self.vapi.cli("test punt pg1 %s" % self.pg1.remote_ip6)
1174
1175         self.vapi.cli("clear trace")
1176         self.pg2.add_stream(p4 * NUM_PKTS)
1177         self.pg_enable_capture(self.pg_interfaces)
1178         self.pg_start()
1179
1180         rxd = self.pg0.get_capture(NUM_PKTS)
1181         for rx in rxd:
1182             self.assertEqual(rx[Ether].dst, self.pg0.remote_mac)
1183             self.assertEqual(rx[Ether].src, self.pg0.local_mac)
1184             self.assertEqual(p4[IP].dst, rx[IP].dst)
1185             self.assertEqual(p4[IP].ttl, rx[IP].ttl)
1186         rxd = self.pg1.get_capture(NUM_PKTS)
1187         for rx in rxd:
1188             self.assertEqual(rx[Ether].dst, self.pg1.remote_mac)
1189             self.assertEqual(rx[Ether].src, self.pg1.local_mac)
1190             self.assertEqual(p4[IP].dst, rx[IP].dst)
1191             self.assertEqual(p4[IP].ttl, rx[IP].ttl)
1192
1193         self.vapi.cli("clear trace")
1194         self.pg2.add_stream(p6 * NUM_PKTS)
1195         self.pg_enable_capture(self.pg_interfaces)
1196         self.pg_start()
1197
1198         rxd = self.pg0.get_capture(NUM_PKTS)
1199         for rx in rxd:
1200             self.assertEqual(rx[Ether].dst, self.pg0.remote_mac)
1201             self.assertEqual(rx[Ether].src, self.pg0.local_mac)
1202             self.assertEqual(p6[IPv6].dst, rx[IPv6].dst)
1203             self.assertEqual(p6[IPv6].hlim, rx[IPv6].hlim)
1204         rxd = self.pg1.get_capture(NUM_PKTS)
1205         for rx in rxd:
1206             self.assertEqual(rx[Ether].dst, self.pg1.remote_mac)
1207             self.assertEqual(rx[Ether].src, self.pg1.local_mac)
1208             self.assertEqual(p6[IPv6].dst, rx[IPv6].dst)
1209             self.assertEqual(p6[IPv6].hlim, rx[IPv6].hlim)
1210
1211         stats = self.statistics.get_counter("/net/punt")
1212         self.assertEqual(stats[0][r4]['packets'], 3*NUM_PKTS)
1213         self.assertEqual(stats[0][r6]['packets'], 3*NUM_PKTS)
1214
1215         self.logger.info(self.vapi.cli("show vlib graph punt-dispatch"))
1216         self.logger.info(self.vapi.cli("show punt client"))
1217         self.logger.info(self.vapi.cli("show punt reason"))
1218         self.logger.info(self.vapi.cli("show punt stats"))
1219         self.logger.info(self.vapi.cli("show punt db"))
1220
1221
1222 if __name__ == '__main__':
1223     unittest.main(testRunner=VppTestRunner)