fixed typo
[anytun.git] / encryptedPacket.h
blobfc6fe96cec957407c3b6512c0b3d69c548de5ab0
1 /*
2 * anytun
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.
14 * Copyright (C) 2007 anytun.org <satp@wirdorange.org>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License version 2
18 * as published by the Free Software Foundation.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program (see the file COPYING included with this
27 * distribution); if not, write to the Free Software Foundation, Inc.,
28 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 #ifndef _ENCRYPTED_PACKET_H_
32 #define _ENCRYPTED_PACKET_H_
34 #include "datatypes.h"
35 #include "buffer.h"
37 class Cipher;
38 class EncryptedPacket : public Buffer
40 public:
42 /**
43 * Packet constructor
44 * @param the length of the payload
45 * @param allow reallocation of buffer
47 EncryptedPacket(u_int32_t payload_length, bool allow_realloc = false);
49 /**
50 * Packet destructor
52 ~EncryptedPacket() {};
54 /**
55 * Get the sequence number
56 * @return seqence number
58 seq_nr_t getSeqNr() const;
60 /**
61 * Set the seqence number
62 * @param seq_nr sequence number
64 void setSeqNr(seq_nr_t seq_nr);
66 /**
67 * Get the sender id
68 * @return sender id
70 sender_id_t getSenderId() const;
72 /**
73 * Set the sender id
74 * @param sender_id sender id
76 void setSenderId(sender_id_t sender_id);
78 /**
79 * Get the mulitplex id
80 * @return multiplex id
82 mux_t getMux() const;
84 /**
85 * Set the multiplex id
86 * @param mux multiplex id
88 void setMux(mux_t mux);
90 /**
91 * Set the header of a packet
92 * @param seq_nr sequence number
93 * @param sender_id sender id
94 * @param mux multiplex id
96 void setHeader(seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
98 /**
99 * Get the length of the payload
100 * @return the length of the payload
102 u_int32_t getPayloadLength() const;
105 * Set the length of the payload
106 * @param length length of the payload
108 void setPayloadLength(u_int32_t payload_length);
111 * Get the the payload
112 * @return the Pointer to the payload
114 u_int8_t* getPayload();
117 u_int8_t* getAuthenticatedPortion();
118 u_int32_t getAuthenticatedPortionLength();
120 void withAuthTag(bool b);
121 void addAuthTag();
122 void removeAuthTag();
123 u_int8_t* getAuthTag();
124 u_int32_t getAuthTagLength();
126 private:
127 EncryptedPacket();
128 EncryptedPacket(const EncryptedPacket &src);
130 void reinit();
132 struct HeaderStruct
134 seq_nr_t seq_nr;
135 sender_id_t sender_id;
136 mux_t mux;
137 }__attribute__((__packed__));
139 struct HeaderStruct* header_;
140 u_int8_t * payload_;
141 u_int8_t * auth_tag_;
142 static const u_int32_t AUTHTAG_SIZE = 10; // TODO: hardcoded size
145 #endif