Release new version 0.3.3-3
[anytun.git] / 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 methodes 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-2009 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
33 #ifndef ANYTUN_plainPacket_h_INCLUDED
34 #define ANYTUN_plainPacket_h_INCLUDED
35
36 #include "datatypes.h"
37 #include "buffer.h"
38
39 #include "networkAddress.h"
40
41 class Cipher;
42 /**
43  * plain SATP packet class<br>
44  * includes payload_type and payload
45  */
46
47 #define PAYLOAD_TYPE_TAP 0x6558
48 #define PAYLOAD_TYPE_TUN 0x0000
49 #define PAYLOAD_TYPE_TUN4 0x0800
50 #define PAYLOAD_TYPE_TUN6 0x86DD 
51
52 class PlainPacket : public Buffer
53 {
54 public:
55   /**
56    * Packet constructor
57    * @param the length of the payload 
58    * @param allow reallocation of buffer
59    */
60   PlainPacket(u_int32_t payload_length, bool allow_realloc = false);
61
62   /**
63    * Packet destructor
64    */
65   ~PlainPacket() {};
66
67   /**
68    * Get the length of the header
69    * @return the length of the header
70    */
71   static u_int32_t getHeaderLength();
72
73   /**
74    * Get the payload type
75    * @return the id of the payload type 
76    */
77   payload_type_t getPayloadType() const;
78
79   /**
80    * Set the payload type
81    * @param payload_type payload type id
82    */
83   void setPayloadType(payload_type_t payload_type);
84
85   /**
86    * Get the length of the payload
87    * @return the length of the payload
88    */
89   u_int32_t getPayloadLength() const;
90
91   /**
92    * Set the length of the payload
93    * @param length length of the payload
94    */
95   void setPayloadLength(u_int32_t payload_length);
96
97   /**
98    * Get the the payload
99    * @return the Pointer to the payload
100    */
101   u_int8_t* getPayload();
102
103 //  NetworkAddress getSrcAddr() const;
104   NetworkAddress getDstAddr() const;
105
106 private:
107   PlainPacket();
108   PlainPacket(const PlainPacket &src);
109
110   void reinit();
111
112   payload_type_t* payload_type_;
113   u_int8_t* payload_;
114 };
115
116 #endif