src/plainPacket.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_plainPacket_h_INCLUDED
  47 #define ANYTUN_plainPacket_h_INCLUDED
  48
  49 #include "datatypes.h"
  50 #include "buffer.h"
  51
  52 #include "networkAddress.h"
  53
  54 class Cipher;
  55 /**
  56  * plain SATP packet class<br>
  57  * includes payload_type and payload
  58  */
  59
  60 #define PAYLOAD_TYPE_TAP 0x6558
  61 #define PAYLOAD_TYPE_TUN 0x0000
  62 #define PAYLOAD_TYPE_TUN4 0x0800
  63 #define PAYLOAD_TYPE_TUN6 0x86DD
  64
  65 class PlainPacket : public Buffer
  66 {
  67 public:
  68   /**
  69    * Packet constructor
  70    * @param the length of the payload
  71    * @param allow reallocation of buffer
  72    */
  73   PlainPacket(uint32_t payload_length, bool allow_realloc = false);
  74
  75   /**
  76    * Packet destructor
  77    */
  78   ~PlainPacket() {};
  79
  80   /**
  81    * Get the length of the header
  82    * @return the length of the header
  83    */
  84   static uint32_t getHeaderLength();
  85
  86   /**
  87    * Get the payload type
  88    * @return the id of the payload type
  89    */
  90   payload_type_t getPayloadType() const;
  91
  92   /**
  93    * Set the payload type
  94    * @param payload_type payload type id
  95    */
  96   void setPayloadType(payload_type_t payload_type);
  97
  98   /**
  99    * Get the length of the payload
 100    * @return the length of the payload
 101    */
 102   uint32_t getPayloadLength() const;
 103
 104   /**
 105    * Set the length of the payload
 106    * @param length length of the payload
 107    */
 108   void setPayloadLength(uint32_t payload_length);
 109
 110   /**
 111    * Get the the payload
 112    * @return the Pointer to the payload
 113    */
 114   uint8_t* getPayload();
 115
 116   //  NetworkAddress getSrcAddr() const;
 117   NetworkAddress getDstAddr() const;
 118
 119 private:
 120   PlainPacket();
 121   PlainPacket(const PlainPacket& src);
 122
 123   void reinit();
 124
 125   payload_type_t* payload_type_;
 126   uint8_t* payload_;
 127 };
 128
 129 #endif