path: root/src/lib/protocols/protobuf.c

/*
 * protobuf.c
 *
 * Copyright (C) 2023 by ntop.org
 *
 * This file is part of nDPI, an open source deep packet inspection
 * library based on the OpenDPI and PACE technology by ipoque GmbH
 *
 * nDPI is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * nDPI 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with nDPI.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include "ndpi_protocol_ids.h"

#define NDPI_CURRENT_PROTO NDPI_PROTOCOL_PROTOBUF
//#define DEBUG_PROTOBUF
#define PROTOBUF_MIN_ELEMENTS 2
#define PROTOBUF_MAX_ELEMENTS 32
#define PROTOBUF_REQUIRED_ELEMENTS 8
#define PROTOBUF_MIN_PACKETS 4
#define PROTOBUF_MAX_PACKETS 8

#include "ndpi_api.h"
#include "ndpi_private.h"

enum protobuf_type {
  PT_INVALID = -1,
  PT_VARINT = 0,
  PT_I64,
  PT_LEN,
  PT_SGROUP, // deprecated
  PT_EGROUP, // deprecated
  PT_I32
};

static void ndpi_int_protobuf_add_connection(struct ndpi_detection_module_struct *ndpi_struct,
                                             struct ndpi_flow_struct *flow)
{
  NDPI_LOG_INFO(ndpi_struct, "found Protobuf\n");
  ndpi_set_detected_protocol(ndpi_struct, flow, NDPI_PROTOCOL_PROTOBUF, NDPI_PROTOCOL_UNKNOWN, NDPI_CONFIDENCE_DPI);
}

static enum protobuf_type
protobuf_dissect_tag(uint64_t tag, uint64_t * const field_number)
{
  uint8_t const wire_type = tag & 0x07;
  *field_number = tag >> 3;

  switch (wire_type)
  {
    case PT_VARINT:
    case PT_I64:
    case PT_LEN:
    case PT_SGROUP:
    case PT_EGROUP:
    case PT_I32:
      return wire_type;
  }

  return PT_INVALID;
}

static int
protobuf_dissect_varint(struct ndpi_packet_struct const * const packet,
                        size_t * const offset, uint64_t * const value)
{
  size_t i;
  *value = 0;

  for (i = 0; i < 9; ++i)
  {
    if (packet->payload_packet_len < *offset + i + 1)
    {
      return -1;
    }

    *value |= ((uint64_t)(packet->payload[*offset + i] & 0x7F)) << (i * 8 - i);
    if ((packet->payload[*offset + i] & 0x80) == 0)
    {
      break;
    }
  }

  if (i == 10)
  {
    return -1;
  }

  *offset += i + 1;
  return 0;
}

static void ndpi_search_protobuf(struct ndpi_detection_module_struct *ndpi_struct,
                                 struct ndpi_flow_struct *flow)
{
  struct ndpi_packet_struct const * const packet = &ndpi_struct->packet;

  NDPI_LOG_DBG(ndpi_struct, "search Protobuf\n");

  size_t protobuf_elements = 0;
  size_t protobuf_len_elements = 0;
  size_t offset = 0;

#ifdef DEBUG_PROTOBUF
  printf("Protobuf:");
#endif
  do {
#ifdef DEBUG_PROTOBUF
    printf(" ");
#endif
    uint64_t tag;
    // A Protobuf tag has a type and a field number stored as u32 varint.
    if (protobuf_dissect_varint(packet, &offset, &tag) != 0)
    {
      break;
    }

    uint64_t field_number;
    enum protobuf_type type = protobuf_dissect_tag(tag, &field_number);
    if (type == PT_INVALID || field_number == 0 || field_number > (UINT_MAX >> 3))
    {
      NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
      return;
    }

#ifdef DEBUG_PROTOBUF
    printf("[id: %llu]", (unsigned long long int)field_number);
#endif
    switch (type)
    {
      case PT_VARINT:
      {
        uint64_t value;
        if (protobuf_dissect_varint(packet, &offset, &value) != 0)
        {
          NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
          return;
        }
#ifdef DEBUG_PROTOBUF
        printf("[VARINT: %llu / %llx]", (unsigned long long int)value,
               (unsigned long long int)value);
#endif
        break;
      }
      case PT_I64: {
        if (packet->payload_packet_len < offset + sizeof(uint64_t))
        {
          NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
          return;
        }
#ifdef DEBUG_PROTOBUF
        union {
          int64_t as_i64;
          uint64_t as_u64;
          double as_double;
        } value;
        value.as_u64 = le64toh(*(uint64_t *)&packet->payload[offset]);
        printf("[I64: %lld / %llu / %lf]", (long long int)value.as_i64,
               (unsigned long long int)value.as_u64, value.as_double);
#endif
        offset += 8;
        break;
      }
      case PT_LEN:
      {
        uint64_t length;
        if (protobuf_dissect_varint(packet, &offset, &length) != 0)
        {
          if (packet->payload_packet_len >= offset)
          {
            break; // We are not excluding the protocol immediately. Let's wait for more packets to arrive..
          } else {
            NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
            return;
          }
        }
        if (length == 0 || length > INT_MAX)
        {
          NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
          return;
        }
        offset += length;
        protobuf_len_elements++;
#ifdef DEBUG_PROTOBUF
        printf("[LEN length: %llu]", (unsigned long long int)length);
#endif
        break;
      }
      case PT_SGROUP:
      case PT_EGROUP:
        // Start/End groups are deprecated and therefor ignored to reduce false positives.
        NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
        return;
      case PT_I32: {
        if (packet->payload_packet_len < offset + sizeof(uint32_t))
        {
          NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
          break;
        }
#ifdef DEBUG_PROTOBUF
        union {
          int32_t as_i32;
          uint32_t as_u32;
          float as_float;
        } value;
        value.as_u32 = le32toh(*(uint32_t *)&packet->payload[offset]);
        printf("[I32: %d / %u / %f]", value.as_i32, value.as_u32, value.as_float);
#endif
        offset += 4;
        break;
      }
      case PT_INVALID:
        break;
    }
  } while (++protobuf_elements < PROTOBUF_MAX_ELEMENTS);

#ifdef DEBUG_PROTOBUF
  printf(" [offset: %llu][length: %u][elems: %llu][len_elems: %llu]\n",
         (unsigned long long int)offset, packet->payload_packet_len,
         (unsigned long long int)protobuf_elements,
         (unsigned long long int)protobuf_len_elements);
#endif
  if ((protobuf_elements >= PROTOBUF_REQUIRED_ELEMENTS && protobuf_len_elements > 0)
      || (flow->packet_counter >= PROTOBUF_MIN_PACKETS && protobuf_elements >= PROTOBUF_MIN_ELEMENTS))
  {
#ifdef DEBUG_PROTOBUF
    printf("Protobuf found after %u packets.\n", flow->packet_counter);
#endif
    ndpi_int_protobuf_add_connection(ndpi_struct, flow);
    return;
  }

  if (packet->payload_packet_len >= offset
      && protobuf_elements > 0
      && flow->packet_counter <= PROTOBUF_MAX_PACKETS)
  {
    return; // We probably need more packets to dissect.
  }

  NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
}


void init_protobuf_dissector(struct ndpi_detection_module_struct *ndpi_struct,
                             u_int32_t *id)
{
  ndpi_set_bitmask_protocol_detection("Protobuf", ndpi_struct, *id,
                                      NDPI_PROTOCOL_PROTOBUF,
                                      ndpi_search_protobuf,
                                      NDPI_SELECTION_BITMASK_PROTOCOL_V4_V6_TCP_OR_UDP_WITH_PAYLOAD_WITHOUT_RETRANSMISSION,
                                      SAVE_DETECTION_BITMASK_AS_UNKNOWN,
                                      ADD_TO_DETECTION_BITMASK);
  *id += 1;
}