srsRAN_4G/srsue/test/upper/tft_test.cc

/**
 * Copyright 2013-2021 Software Radio Systems Limited
 *
 * This file is part of srsRAN.
 *
 * srsRAN is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * srsRAN is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * A copy of the GNU Affero General Public License can be found in
 * the LICENSE file in the top-level directory of this distribution
 * and at http://www.gnu.org/licenses/.
 *
 */

#include "srsran/asn1/liblte_mme.h"
#include "srsran/common/buffer_pool.h"
#include "srsran/common/int_helpers.h"
#include "srsran/srsran.h"
#include "srsue/hdr/stack/upper/tft_packet_filter.h"
#include <iostream>

#define TESTASSERT(cond)                                                                                               \
  {                                                                                                                    \
    if (!(cond)) {                                                                                                     \
      std::cout << "[" << __FUNCTION__ << "][Line " << __LINE__ << "]: FAIL at " << (#cond) << std::endl;              \
      return -1;                                                                                                       \
    }                                                                                                                  \
  }
using namespace srsue;
using namespace srsran;

// IP test message 1
// Source IP 127.0.0.1, Destination IP 127.0.0.2
// Protocol UDP
// Source port 2222, Destination port 2001
uint8_t ip_tst_message1[] = {
    0x45, 0x04, 0x00, 0x5c, 0xb5, 0x8e, 0x40, 0x00, 0x40, 0x11, 0x86, 0xfb, 0x7f, 0x00, 0x00, 0x01, 0x7f, 0x00, 0x00,
    0x02, 0x08, 0xae, 0x07, 0xd1, 0x00, 0x48, 0xfe, 0x5c, 0xaf, 0xed, 0x69, 0x5a, 0x77, 0x80, 0x6e, 0x2f, 0x5e, 0xf3,
    0x76, 0x17, 0x05, 0xe4, 0x2b, 0xca, 0xb2, 0xd2, 0xcb, 0xa5, 0x58, 0x06, 0xc5, 0x02, 0x8d, 0xf1, 0x7a, 0x3d, 0x4f,
    0x14, 0x34, 0x58, 0x92, 0x37, 0x7c, 0x95, 0x53, 0x18, 0xa3, 0xff, 0x08, 0x1b, 0x07, 0x99, 0x94, 0xe2, 0x10, 0x0d,
    0x3d, 0x25, 0x20, 0x13, 0x95, 0x84, 0x53, 0x4b, 0x6a, 0x92, 0x64, 0x5a, 0xce, 0xbb, 0x6c, 0x3a,
};
uint32_t ip_message_len1 = sizeof(ip_tst_message1);

// IP test message 2
// Source IP 172.16.3.40, Destination IP 172.16.3.41
// Protocol UDP
// Source port 8000, Destination Port 9000
uint8_t ip_tst_message2[] = {
    0x45, 0x00, 0x00, 0x5c, 0x7a, 0x02, 0x40, 0x00, 0x40, 0x11, 0x62, 0x1d, 0xac, 0x10, 0x03, 0x28, 0xac, 0x10, 0x03,
    0x29, 0x1f, 0x40, 0x23, 0x28, 0x00, 0x48, 0x5e, 0xcb, 0xcc, 0x29, 0x54, 0x9a, 0xf5, 0x18, 0xab, 0x86, 0x8b, 0x5e,
    0x5c, 0xc8, 0x80, 0x55, 0x85, 0xd4, 0xcd, 0x25, 0xa2, 0x94, 0x28, 0xcc, 0xbc, 0xa4, 0xe6, 0x69, 0xcc, 0x45, 0x0c,
    0x9e, 0xb4, 0xf3, 0x78, 0xaf, 0xa0, 0xba, 0xcf, 0xd1, 0xd2, 0xce, 0x7d, 0x7f, 0x94, 0x4a, 0x73, 0xd4, 0x2d, 0xd2,
    0x88, 0x29, 0x60, 0x02, 0xde, 0x41, 0x11, 0xc2, 0xaa, 0x5e, 0x9e, 0x27, 0x74, 0xa5, 0xd3, 0x19};
uint32_t ip_message_len2 = sizeof(ip_tst_message2);

// IPv6 test filter
//   Packet filter: 0
//       Packet filter component type identifier: Protocol identifier/Next header type (48)
//           Protocol/header: UDP (0x11)
//       Packet filter component type identifier: IPv6 remote address type (32)
//           IPv6 address: 2a02:14f:ffc0:51::6
//           IPv6 address mask: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff
//       Packet filter component type identifier: Single remote port type (80)
//           Port: 35082
//       Packet filter component type identifier: Single local port type (64)
//        Port: 50010
uint8_t ipv6_filter[] = {0x30, 0x11, 0x20, 0x2a, 0x02, 0x01, 0x4f, 0xff, 0xc0, 0x00, 0x51, 0x00, 0x00, 0x00,
                         0x00, 0x00, 0x00, 0x00, 0x06, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
                         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x50, 0x89, 0x0a, 0x40, 0xc3, 0x5a};

// IPv6 test packets
uint8_t ipv6_matched_packet[] = {0x60, 0x0e, 0xa3, 0x96, 0x00, 0x16, 0x11, 0xff, 0x2a, 0x02, 0x01, 0x4f, 0x01,
                                 0x9f, 0xec, 0xe9, 0xfc, 0xf5, 0x73, 0x48, 0xc6, 0xed, 0x19, 0xe6, 0x2a, 0x02,
                                 0x01, 0x4f, 0xff, 0xc0, 0x00, 0x51, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                                 0x06, 0xc3, 0x5a, 0x89, 0x0a, 0x00, 0x16, 0x31, 0xd9, 0x80, 0x61, 0x00, 0x01,
                                 0x00, 0x00, 0x0c, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77};

uint8_t ipv6_unmatched_packet_tcp[] = {
    0x60, 0x0e, 0xa3, 0x96, 0x00, 0x16, /**/ 0x06 /**/, 0xff, 0x2a, 0x02, 0x01, 0x4f, 0x01, 0x9f, 0xec, 0xe9,
    0xfc, 0xf5, 0x73, 0x48, 0xc6, 0xed, 0x19,           0xe6, 0x2a, 0x02, 0x01, 0x4f, 0xff, 0xc0, 0x00, 0x51,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,           0x06, 0xc3, 0x5a, 0x89, 0x0a, 0x00, 0x16, 0x31, 0xd9,
    0x80, 0x61, 0x00, 0x01, 0x00, 0x00, 0x0c,           0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77};

uint8_t ipv6_unmatched_packet_daddr[] = {
    0x60, 0x0e, 0xa3, 0x96, 0x00, 0x16, 0x11, 0xff,      0x2a,      0x02, 0x01, 0x4f, 0x01, 0x9f, 0xec, 0xe9,
    0xfc, 0xf5, 0x73, 0x48, 0xc6, 0xed, 0x19, 0xe6,      0x2a,      0x02, 0x01, 0x4f, 0xff, 0xc0, 0x00, 0x51,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /**/ 0x07, /**/ 0xc3, 0x5a, 0x89, 0x0a, 0x00, 0x16, 0x31, 0xd9,
    0x80, 0x61, 0x00, 0x01, 0x00, 0x00, 0x0c, 0x11,      0x22,      0x33, 0x44, 0x55, 0x66, 0x77};

uint8_t ipv6_unmatched_packet_rport[] = {
    0x60, 0x0e, 0xa3, 0x96, 0x00, 0x16, 0x11, 0xff, 0x2a, 0x02, 0x01, 0x4f,           0x01, 0x9f, 0xec, 0xe9,
    0xfc, 0xf5, 0x73, 0x48, 0xc6, 0xed, 0x19, 0xe6, 0x2a, 0x02, 0x01, 0x4f,           0xff, 0xc0, 0x00, 0x51,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x06, 0xc3, 0x5a, 0x89, /**/ 0x0b /**/, 0x00, 0x16, 0x31, 0xd9,
    0x80, 0x61, 0x00, 0x01, 0x00, 0x00, 0x0c, 0x11, 0x22, 0x33, 0x44, 0x55,           0x66, 0x77};

uint8_t ipv6_unmatched_packet_lport[] = {
    0x60, 0x0e, 0xa3, 0x96, 0x00, 0x16, 0x11, 0xff, 0x2a, 0x02,           0x01, 0x4f, 0x01, 0x9f, 0xec, 0xe9,
    0xfc, 0xf5, 0x73, 0x48, 0xc6, 0xed, 0x19, 0xe6, 0x2a, 0x02,           0x01, 0x4f, 0xff, 0xc0, 0x00, 0x51,
    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x06, 0xc3, /**/ 0x5b /**/, 0x89, 0x0b, 0x00, 0x16, 0x31, 0xd9,
    0x80, 0x61, 0x00, 0x01, 0x00, 0x00, 0x0c, 0x11, 0x22, 0x33,           0x44, 0x55, 0x66, 0x77};

#define EPS_BEARER_ID 6
#define LCID 1

int tft_filter_test_ipv6_combined()
{
  srslog::basic_logger&        logger = srslog::fetch_basic_logger("TFT");
  srsran::unique_byte_buffer_t ip_msg1, ip_msg2, ip_msg3, ip_msg4, ip_msg5;
  ip_msg1 = make_byte_buffer();
  TESTASSERT(ip_msg1 != nullptr);
  ip_msg2 = make_byte_buffer();
  TESTASSERT(ip_msg2 != nullptr);
  ip_msg3 = make_byte_buffer();
  TESTASSERT(ip_msg3 != nullptr);
  ip_msg4 = make_byte_buffer();
  TESTASSERT(ip_msg4 != nullptr);
  ip_msg5 = make_byte_buffer();
  TESTASSERT(ip_msg5 != nullptr);

  // Set IP test message
  ip_msg1->N_bytes = sizeof(ipv6_matched_packet);
  memcpy(ip_msg1->msg, ipv6_matched_packet, sizeof(ipv6_matched_packet));
  logger.info(ip_msg1->msg, ip_msg1->N_bytes, "IPv6 test message - match");

  // Set IP test message
  ip_msg2->N_bytes = sizeof(ipv6_unmatched_packet_tcp);
  memcpy(ip_msg2->msg, ipv6_unmatched_packet_tcp, sizeof(ipv6_unmatched_packet_tcp));
  logger.info(ip_msg2->msg, ip_msg2->N_bytes, "IPv6 test message - unmatched tcp");

  // Set IP test message
  ip_msg3->N_bytes = sizeof(ipv6_unmatched_packet_daddr);
  memcpy(ip_msg3->msg, ipv6_unmatched_packet_daddr, sizeof(ipv6_unmatched_packet_daddr));
  logger.info(ip_msg3->msg, ip_msg3->N_bytes, "IPv6 test message - unmatched daddr");

  // Set IP test message
  ip_msg4->N_bytes = sizeof(ipv6_unmatched_packet_rport);
  memcpy(ip_msg4->msg, ipv6_unmatched_packet_rport, sizeof(ipv6_unmatched_packet_rport));
  logger.info(ip_msg4->msg, ip_msg4->N_bytes, "IPv6 test message - unmatched rport");

  // Set IP test message
  ip_msg5->N_bytes = sizeof(ipv6_unmatched_packet_lport);
  memcpy(ip_msg5->msg, ipv6_unmatched_packet_lport, sizeof(ipv6_unmatched_packet_lport));
  logger.info(ip_msg5->msg, ip_msg5->N_bytes, "IPv6 test message - unmatched lport");

  // Packet filter
  LIBLTE_MME_PACKET_FILTER_STRUCT packet_filter;

  packet_filter.dir             = LIBLTE_MME_TFT_PACKET_FILTER_DIRECTION_BIDIRECTIONAL;
  packet_filter.id              = 1;
  packet_filter.eval_precedence = 0;
  packet_filter.filter_size     = sizeof(ipv6_filter);
  memcpy(packet_filter.filter, ipv6_filter, sizeof(ipv6_filter));

  srsue::tft_packet_filter_t filter(EPS_BEARER_ID, LCID, packet_filter, logger);

  // Check filter
  TESTASSERT(filter.match(ip_msg1));
  TESTASSERT(!filter.match(ip_msg2));
  TESTASSERT(!filter.match(ip_msg3));
  TESTASSERT(!filter.match(ip_msg4));
  TESTASSERT(!filter.match(ip_msg5));

  printf("Test TFT filter ipv6 combined successfull\n");
  return 0;
}

int tft_filter_test_single_local_port()
{
  srslog::basic_logger& logger = srslog::fetch_basic_logger("TFT");

  srsran::unique_byte_buffer_t ip_msg1, ip_msg2;
  ip_msg1 = make_byte_buffer();
  TESTASSERT(ip_msg1 != nullptr);
  ip_msg2 = make_byte_buffer();
  TESTASSERT(ip_msg2 != nullptr);

  // Filter length: 3 bytes
  // Filter type:   Single local port
  // Local port:    2222
  uint8_t filter_message[3];
  filter_message[0] = SINGLE_LOCAL_PORT_TYPE;
  srsran::uint16_to_uint8(2222, &filter_message[1]);

  // Set IP test message
  ip_msg1->N_bytes = ip_message_len1;
  memcpy(ip_msg1->msg, ip_tst_message1, ip_message_len1);
  logger.info(ip_msg1->msg, ip_msg1->N_bytes, "IP test message");

  // Set IP test message
  ip_msg2->N_bytes = ip_message_len2;
  memcpy(ip_msg2->msg, ip_tst_message2, ip_message_len1);
  logger.info(ip_msg2->msg, ip_msg2->N_bytes, "IP test message");

  // Packet filter
  LIBLTE_MME_PACKET_FILTER_STRUCT packet_filter;

  packet_filter.dir             = LIBLTE_MME_TFT_PACKET_FILTER_DIRECTION_BIDIRECTIONAL;
  packet_filter.id              = 1;
  packet_filter.eval_precedence = 0;
  packet_filter.filter_size     = 3;
  memcpy(packet_filter.filter, filter_message, 3);

  srsue::tft_packet_filter_t filter(EPS_BEARER_ID, LCID, packet_filter, logger);

  // Check filter
  TESTASSERT(filter.match(ip_msg1));
  TESTASSERT(!filter.match(ip_msg2));

  printf("Test TFT filter single local port successfull\n");
  return 0;
}

int tft_filter_test_single_remote_port()
{
  srslog::basic_logger& logger = srslog::fetch_basic_logger("TFT");

  srsran::unique_byte_buffer_t ip_msg1, ip_msg2;
  ip_msg1 = make_byte_buffer();
  TESTASSERT(ip_msg1 != nullptr);
  ip_msg2 = make_byte_buffer();
  TESTASSERT(ip_msg2 != nullptr);

  // Filter length: 3 bytes
  // Filter type:   Single remote port
  // Remote port:   2001
  uint8_t filter_message[3];
  filter_message[0] = SINGLE_REMOTE_PORT_TYPE;
  srsran::uint16_to_uint8(2001, &filter_message[1]);

  // Set IP test message
  ip_msg1->N_bytes = ip_message_len1;
  memcpy(ip_msg1->msg, ip_tst_message1, ip_message_len1);
  logger.info(ip_msg1->msg, ip_msg1->N_bytes, "IP test message");

  // Set IP test message
  ip_msg2->N_bytes = ip_message_len2;
  memcpy(ip_msg2->msg, ip_tst_message2, ip_message_len1);
  logger.info(ip_msg2->msg, ip_msg2->N_bytes, "IP test message");

  // Packet filter
  LIBLTE_MME_PACKET_FILTER_STRUCT packet_filter;

  packet_filter.dir             = LIBLTE_MME_TFT_PACKET_FILTER_DIRECTION_BIDIRECTIONAL;
  packet_filter.id              = 1;
  packet_filter.eval_precedence = 0;
  packet_filter.filter_size     = 3;
  memcpy(packet_filter.filter, filter_message, 3);

  srsue::tft_packet_filter_t filter(EPS_BEARER_ID, LCID, packet_filter, logger);

  // Check filter
  TESTASSERT(filter.match(ip_msg1));
  TESTASSERT(!filter.match(ip_msg2));

  printf("Test TFT packet filter single remote port successfull\n");
  return 0;
}

int tft_filter_test_ipv4_local_addr()
{
  srslog::basic_logger& logger = srslog::fetch_basic_logger("TFT");

  srsran::unique_byte_buffer_t ip_msg1, ip_msg2;
  ip_msg1 = make_byte_buffer();
  TESTASSERT(ip_msg1 != nullptr);
  ip_msg2 = make_byte_buffer();
  TESTASSERT(ip_msg2 != nullptr);

  // Filter length: 9 bytes
  // Filter type:   IPv4 local address
  // Local address: 127.0.0.1
  // Subnet mask:   255.0.0.0
  uint8_t filter_message[9];
  uint8_t filter_size = 9;
  filter_message[0]   = IPV4_LOCAL_ADDR_TYPE;
  inet_pton(AF_INET, "127.0.0.1", &filter_message[1]);
  inet_pton(AF_INET, "255.0.0.0", &filter_message[5]);

  // Set IP test message
  ip_msg1->N_bytes = ip_message_len1;
  memcpy(ip_msg1->msg, ip_tst_message1, ip_message_len1);
  logger.info(ip_msg1->msg, ip_msg1->N_bytes, "IP test message");

  // Set IP test message
  ip_msg2->N_bytes = ip_message_len2;
  memcpy(ip_msg2->msg, ip_tst_message2, ip_message_len2);
  logger.info(ip_msg1->msg, ip_msg1->N_bytes, "IP test message");

  // Packet filter
  LIBLTE_MME_PACKET_FILTER_STRUCT packet_filter;

  packet_filter.dir             = LIBLTE_MME_TFT_PACKET_FILTER_DIRECTION_BIDIRECTIONAL;
  packet_filter.id              = 1;
  packet_filter.eval_precedence = 0;
  packet_filter.filter_size     = filter_size;
  memcpy(packet_filter.filter, filter_message, filter_size);

  srsue::tft_packet_filter_t filter(EPS_BEARER_ID, LCID, packet_filter, logger);

  // Check filter
  TESTASSERT(filter.match(ip_msg1));
  TESTASSERT(!filter.match(ip_msg2));

  printf("Test TFT packet filter local IPv4 address successfull\n");
  return 0;
}

int tft_filter_test_ipv4_remote_addr()
{
  srslog::basic_logger& logger = srslog::fetch_basic_logger("TFT");

  srsran::unique_byte_buffer_t ip_msg1, ip_msg2;
  ip_msg1 = make_byte_buffer();
  TESTASSERT(ip_msg1 != nullptr);
  ip_msg2 = make_byte_buffer();
  TESTASSERT(ip_msg2 != nullptr);

  // Filter length: 5 bytes
  // Filter type:   IPv4 local address
  // Remote address: 127.0.0.2
  uint8_t filter_message[9];
  uint8_t filter_size = 9;
  filter_message[0]   = IPV4_REMOTE_ADDR_TYPE;
  inet_pton(AF_INET, "127.0.0.2", &filter_message[1]);
  inet_pton(AF_INET, "255.0.0.0", &filter_message[5]);

  // Set IP test message
  ip_msg1->N_bytes = ip_message_len1;
  memcpy(ip_msg1->msg, ip_tst_message1, ip_message_len1);
  logger.info(ip_msg1->msg, ip_msg1->N_bytes, "IP test message");

  // Set IP test message
  ip_msg2->N_bytes = ip_message_len2;
  memcpy(ip_msg2->msg, ip_tst_message2, ip_message_len2);
  logger.info(ip_msg2->msg, ip_msg2->N_bytes, "IP test message");

  // Packet filter
  LIBLTE_MME_PACKET_FILTER_STRUCT packet_filter;

  packet_filter.dir             = LIBLTE_MME_TFT_PACKET_FILTER_DIRECTION_BIDIRECTIONAL;
  packet_filter.id              = 1;
  packet_filter.eval_precedence = 0;
  packet_filter.filter_size     = filter_size;
  memcpy(packet_filter.filter, filter_message, filter_size);

  srsue::tft_packet_filter_t filter(EPS_BEARER_ID, LCID, packet_filter, logger);

  // Check filter
  TESTASSERT(filter.match(ip_msg1));
  TESTASSERT(!filter.match(ip_msg2));

  printf("Test TFT packet filter remote IPv4 address successfull\n");
  return 0;
}

int tft_filter_test_ipv4_tos()
{
  srslog::basic_logger& logger = srslog::fetch_basic_logger("TFT");

  srsran::unique_byte_buffer_t ip_msg1, ip_msg2;
  ip_msg1 = make_byte_buffer();
  TESTASSERT(ip_msg1 != nullptr);
  ip_msg2 = make_byte_buffer();
  TESTASSERT(ip_msg2 != nullptr);

  // Filter length: 3 bytes
  // Filter type:   Type of service
  // ToS:           4
  // ToS mask:      255
  uint8_t filter_message[3];
  uint8_t filter_size = 3;
  filter_message[0]   = TYPE_OF_SERVICE_TYPE;
  filter_message[1]   = 4;
  filter_message[2]   = 255;

  // Set IP test message
  ip_msg1->N_bytes = ip_message_len1;
  memcpy(ip_msg1->msg, ip_tst_message1, ip_message_len1);
  logger.info(ip_msg1->msg, ip_msg1->N_bytes, "IP test message");

  // Set IP test message
  ip_msg2->N_bytes = ip_message_len2;
  memcpy(ip_msg2->msg, ip_tst_message2, ip_message_len2);
  logger.info(ip_msg2->msg, ip_msg2->N_bytes, "IP test message");

  // Packet filter
  LIBLTE_MME_PACKET_FILTER_STRUCT packet_filter;

  packet_filter.dir             = LIBLTE_MME_TFT_PACKET_FILTER_DIRECTION_BIDIRECTIONAL;
  packet_filter.id              = 1;
  packet_filter.eval_precedence = 0;
  packet_filter.filter_size     = filter_size;
  memcpy(packet_filter.filter, filter_message, filter_size);

  srsue::tft_packet_filter_t filter(EPS_BEARER_ID, LCID, packet_filter, logger);

  // Check filter
  TESTASSERT(filter.match(ip_msg1));
  TESTASSERT(!filter.match(ip_msg2));

  printf("Test TFT packet filter type of service successfull\n");
  return 0;
}

int main(int argc, char** argv)
{
  srslog::basic_logger& logger = srslog::fetch_basic_logger("TFT", false);
  logger.set_level(srslog::basic_levels::debug);
  logger.set_hex_dump_max_size(128);
  srslog::init();

  srsran::byte_buffer_pool::get_instance();
  if (tft_filter_test_single_local_port()) {
    return -1;
  }
  if (tft_filter_test_single_remote_port()) {
    return -1;
  }
  if (tft_filter_test_ipv4_local_addr()) {
    return -1;
  }
  if (tft_filter_test_ipv4_remote_addr()) {
    return -1;
  }
  if (tft_filter_test_ipv4_tos()) {
    return -1;
  }
  if (tft_filter_test_ipv6_combined()) {
    return -1;
  }
}