src/encryptedPacket.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_encryptedPacket_h_INCLUDED
  47 #define ANYTUN_encryptedPacket_h_INCLUDED
  48
  49 #include "datatypes.h"
  50 #include "buffer.h"
  51
  52 class Cipher;
  53 class EncryptedPacket : public Buffer
  54 {
  55 public:
  56
  57   /**
  58    * Packet constructor
  59    * @param the length of the payload
  60    * @param allow reallocation of buffer
  61    */
  62   EncryptedPacket(uint32_t payload_length, uint32_t auth_tag_length, bool allow_realloc = false);
  63
  64   /**
  65    * Packet destructor
  66    */
  67   ~EncryptedPacket() {};
  68
  69   /**
  70    * Get the length of the header
  71    * @return the length of the header
  72    */
  73   static uint32_t getHeaderLength();
  74
  75   /**
  76    * Get the sequence number
  77    * @return seqence number
  78    */
  79   seq_nr_t getSeqNr() const;
  80
  81   /**
  82    * Set the seqence number
  83    * @param seq_nr sequence number
  84    */
  85   void setSeqNr(seq_nr_t seq_nr);
  86
  87   /**
  88    * Get the sender id
  89    * @return sender id
  90    */
  91   sender_id_t getSenderId() const;
  92
  93   /**
  94    * Set the sender id
  95    * @param sender_id sender id
  96    */
  97   void setSenderId(sender_id_t sender_id);
  98
  99   /**
 100    * Get the mulitplex id
 101    * @return multiplex id
 102    */
 103   mux_t getMux() const;
 104
 105   /**
 106    * Set the multiplex id
 107    * @param mux multiplex id
 108    */
 109   void setMux(mux_t mux);
 110
 111   /**
 112    * Set the header of a packet
 113    * @param seq_nr sequence number
 114    * @param sender_id sender id
 115    * @param mux multiplex id
 116    */
 117   void setHeader(seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
 118
 119   /**
 120    * Get the length of the payload
 121    * @return the length of the payload
 122    */
 123   uint32_t getPayloadLength() const;
 124
 125   /**
 126    * Set the length of the payload
 127    * @param length length of the payload
 128    */
 129   void setPayloadLength(uint32_t payload_length);
 130
 131   /**
 132    * Get the the payload
 133    * @return the Pointer to the payload
 134    */
 135   uint8_t* getPayload();
 136
 137
 138   uint8_t* getAuthenticatedPortion();
 139   uint32_t getAuthenticatedPortionLength();
 140
 141   void withAuthTag(bool b);
 142   void addAuthTag();
 143   void removeAuthTag();
 144   uint8_t* getAuthTag();
 145   uint32_t getAuthTagLength();
 146
 147 private:
 148   EncryptedPacket();
 149   EncryptedPacket(const EncryptedPacket& src);
 150
 151   void reinit();
 152
 153 #ifdef _MSC_VER
 154 #pragma pack(push, 1)
 155 #endif
 156   struct ATTR_PACKED HeaderStruct {
 157     seq_nr_t seq_nr;
 158     sender_id_t sender_id;
 159     mux_t mux;
 160   };
 161 #ifdef _MSC_VER
 162 #pragma pack(pop)
 163 #endif
 164
 165   struct HeaderStruct* header_;
 166   uint8_t* payload_;
 167   uint8_t* auth_tag_;
 168   uint32_t  auth_tag_length_;
 169 };
 170
 171 #endif