pstatsplugin.h

/**
 * \file pstatsplugin.h
 * \brief Plugin for parsing pstats traffic.
 * \author Tomas Cejka <cejkat@cesnet.cz>
 * \author Karel Hynek <hynekkar@cesnet.cz>
 * \date 2020
 */
/*
 * Copyright (C) 2020 CESNET
 *
 * LICENSE TERMS
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of the Company nor the names of its contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * ALTERNATIVELY, provided that this notice is retained in full, this
 * product may be distributed under the terms of the GNU General Public
 * License (GPL) version 2 or later, in which case the provisions
 * of the GPL apply INSTEAD OF those given above.
 *
 * This software is provided as is'', and any express or implied
 * warranties, including, but not limited to, the implied warranties of
 * merchantability and fitness for a particular purpose are disclaimed.
 * In no event shall the company or contributors be liable for any
 * direct, indirect, incidental, special, exemplary, or consequential
 * damages (including, but not limited to, procurement of substitute
 * goods or services; loss of use, data, or profits; or business
 * interruption) however caused and on any theory of liability, whether
 * in contract, strict liability, or tort (including negligence or
 * otherwise) arising in any way out of the use of this software, even
 * if advised of the possibility of such damage.
 *
 */

#ifndef PSTATSPLUGIN_H
#define PSTATSPLUGIN_H

#include <string>
#include <cstring>

#ifdef WITH_NEMEA
# include "fields.h"
#endif

#include "flowifc.h"
#include "flowcacheplugin.h"
#include "packet.h"
#include "ipfixprobe.h"
#include "byte-utils.h"
#include "ipfix-basiclist.h"

#ifndef PSTATS_MAXELEMCOUNT
# define PSTATS_MAXELEMCOUNT 30
#endif

using namespace std;

/**
 * \brief Flow record extension header for storing parsed PSTATS packets.
 */
struct RecordExtPSTATS : RecordExt {
   uint16_t       pkt_sizes[PSTATS_MAXELEMCOUNT];
   uint8_t        pkt_tcp_flgs[PSTATS_MAXELEMCOUNT];
   struct timeval pkt_timestamps[PSTATS_MAXELEMCOUNT];
   int8_t         pkt_dirs[PSTATS_MAXELEMCOUNT];
   uint16_t       pkt_count;
   uint32_t       tcp_seq[2];
   uint32_t       tcp_ack[2];
   uint16_t       tcp_len[2];
   uint8_t        tcp_flg[2];

   typedef enum eHdrFieldID {
      PktSize  = 1013,
      PktFlags = 1015,
      PktDir   = 1016,
      PktTmstp = 1014
   } eHdrSemantic;

   static const uint32_t CesnetPem = 8057;


   RecordExtPSTATS() : RecordExt(pstats)
   {
      pkt_count = 0;
   }

   #ifdef WITH_NEMEA
   virtual void fillUnirec(ur_template_t *tmplt, void *record)
   {
      ur_array_allocate(tmplt, record, F_PPI_PKT_TIMES, pkt_count);
      ur_array_allocate(tmplt, record, F_PPI_PKT_LENGTHS, pkt_count);
      ur_array_allocate(tmplt, record, F_PPI_PKT_FLAGS, pkt_count);
      ur_array_allocate(tmplt, record, F_PPI_PKT_DIRECTIONS, pkt_count);

      for (int i = 0; i < pkt_count; i++) {
         ur_time_t ts = ur_time_from_sec_usec(pkt_timestamps[i].tv_sec, pkt_timestamps[i].tv_usec);
         ur_array_set(tmplt, record, F_PPI_PKT_TIMES, i, ts);
         ur_array_set(tmplt, record, F_PPI_PKT_LENGTHS, i, pkt_sizes[i]);
         ur_array_set(tmplt, record, F_PPI_PKT_FLAGS, i, pkt_tcp_flgs[i]);
         ur_array_set(tmplt, record, F_PPI_PKT_DIRECTIONS, i, pkt_dirs[i]);
      }
   }

   #endif // ifdef WITH_NEMEA

   virtual int fillIPFIX(uint8_t *buffer, int size)
   {
      int32_t bufferPtr;
      IpfixBasicList basiclist;
      basiclist.hdrEnterpriseNum = IpfixBasicList::CesnetPEM;
      //Check sufficient size of buffer
      int req_size = 4 * basiclist.HeaderSize() /* sizes, times, flags, dirs */ +
                       pkt_count * sizeof(uint16_t) /* sizes */ +
                       2 * pkt_count * sizeof(uint32_t) /* times */ +
                       pkt_count /* flags */ +
                       pkt_count /* dirs */;

      if (req_size > size) {
         return -1;
      }
      // Fill packet sizes
      bufferPtr = basiclist.FillBuffer(buffer, pkt_sizes, pkt_count, (uint16_t) PktSize);
      // Fill timestamps
      bufferPtr += basiclist.FillBuffer(buffer + bufferPtr, pkt_timestamps, pkt_count,(uint16_t) PktTmstp);
      // Fill tcp flags
      bufferPtr += basiclist.FillBuffer(buffer + bufferPtr, pkt_tcp_flgs, pkt_count, (uint16_t) PktFlags);
      // Fill directions
      bufferPtr += basiclist.FillBuffer(buffer + bufferPtr, pkt_dirs, pkt_count,(uint16_t) PktDir);

      return bufferPtr;
   } // fillIPFIX
};

/**
 * \brief Flow cache plugin for parsing PSTATS packets.
 */
class PSTATSPlugin : public FlowCachePlugin
{
public:
   PSTATSPlugin(const options_t &module_options);
   PSTATSPlugin(const options_t &module_options, vector<plugin_opt> plugin_options);
   FlowCachePlugin *copy();
   int post_create(Flow &rec, const Packet &pkt);
   int post_update(Flow &rec, const Packet &pkt);
   void update_record(RecordExtPSTATS *pstats_data, const Packet &pkt);
   const char **get_ipfix_string();
   string get_unirec_field_string();

private:
   void check_plugin_options(vector<plugin_opt>& plugin_options);
   bool print_stats; /**< Indicator whether to print stats when flow cache is finishing or not. */
   bool use_zeros;
   bool skip_dup_pkts;
};

#endif // ifndef PSTATSPLUGIN_H