src/buffer.h

   1 /*
   2  *  anytun
   3  *
   4  *  The secure anycast tunneling protocol (satp) defines a protocol used
   5  *  for communication between any combination of unicast and anycast
   6  *  tunnel endpoints.  It has less protocol overhead than IPSec in Tunnel
   7  *  mode and allows tunneling of every ETHER TYPE protocol (e.g.
   8  *  ethernet, ip, arp ...). satp directly includes cryptography and
   9  *  message authentication based on the methods used by SRTP.  It is
  10  *  intended to deliver a generic, scaleable and secure solution for
  11  *  tunneling and relaying of packets of any protocol.
  12  *
  13  *
  14  *  Copyright (C) 2007-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl,
  15  *                          Christian Pointner <satp@wirdorange.org>
  16  *
  17  *  This file is part of Anytun.
  18  *
  19  *  Anytun is free software: you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation, either version 3 of the License, or
  22  *  any later version.
  23  *
  24  *  Anytun is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with Anytun.  If not, see <http://www.gnu.org/licenses/>.
  31  *
  32  *  In addition, as a special exception, the copyright holders give
  33  *  permission to link the code of portions of this program with the
  34  *  OpenSSL library under certain conditions as described in each
  35  *  individual source file, and distribute linked combinations
  36  *  including the two.
  37  *  You must obey the GNU General Public License in all respects
  38  *  for all of the code used other than OpenSSL.  If you modify
  39  *  file(s) with this exception, you may extend this exception to your
  40  *  version of the file(s), but you are not obligated to do so.  If you
  41  *  do not wish to do so, delete this exception statement from your
  42  *  version.  If you delete this exception statement from all source
  43  *  files in the program, then also delete it here.
  44  */
  45
  46 #ifndef ANYTUN_buffer_h_INCLUDED
  47 #define ANYTUN_buffer_h_INCLUDED
  48
  49 #include "datatypes.h"
  50 #include <string>
  51
  52 class TunDevice;
  53 class UDPPacketSource;
  54
  55 class Buffer
  56 {
  57 public:
  58   Buffer(bool allow_realloc = true);
  59   Buffer(uint32_t length, bool allow_realloc = true);
  60   Buffer(uint8_t* data, uint32_t length, bool allow_realloc = true);
  61   Buffer(std::string hex_data, bool allow_realloc = true);
  62   virtual ~Buffer();
  63   Buffer(const Buffer& src);
  64   void operator=(const Buffer& src);
  65   bool operator==(const Buffer& cmp) const;
  66   Buffer operator^(const Buffer& xor_by) const;
  67
  68   uint32_t getLength() const;
  69   virtual void setLength(uint32_t new_length);
  70   uint8_t* getBuf();
  71   uint8_t& operator[](uint32_t index);
  72   uint8_t operator[](uint32_t index) const;
  73   std::string getHexDump() const;
  74   std::string getHexDumpOneLine() const;
  75
  76   bool isReallocAllowed() const;
  77
  78   operator uint8_t*();
  79
  80 protected:
  81   virtual void reinit() {};
  82
  83   uint8_t* buf_;
  84   uint32_t length_;
  85   uint32_t real_length_;
  86   bool allow_realloc_;
  87
  88   static const uint32_t OVER_SIZE_ = 100;
  89 };
  90
  91 #endif