doc/html/buffer_8h-source.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>anytun: buffer.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
  <ul>
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="annotated.html"><span>Classes</span></a></li>
    <li id="current"><a href="files.html"><span>Files</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
  </ul></div>
<h1>buffer.h</h1><a href="buffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> *  anytun</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> *  The secure anycast tunneling protocol (satp) defines a protocol used</span>
<a name="l00005"></a>00005 <span class="comment"> *  for communication between any combination of unicast and anycast</span>
<a name="l00006"></a>00006 <span class="comment"> *  tunnel endpoints.  It has less protocol overhead than IPSec in Tunnel</span>
<a name="l00007"></a>00007 <span class="comment"> *  mode and allows tunneling of every ETHER TYPE protocol (e.g.</span>
<a name="l00008"></a>00008 <span class="comment"> *  ethernet, ip, arp ...). satp directly includes cryptography and</span>
<a name="l00009"></a>00009 <span class="comment"> *  message authentication based on the methodes used by SRTP.  It is</span>
<a name="l00010"></a>00010 <span class="comment"> *  intended to deliver a generic, scaleable and secure solution for</span>
<a name="l00011"></a>00011 <span class="comment"> *  tunneling and relaying of packets of any protocol.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> *  Copyright (C) 2007 anytun.org &lt;satp@wirdorange.org&gt;</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> *  This program is free software; you can redistribute it and/or modify</span>
<a name="l00017"></a>00017 <span class="comment"> *  it under the terms of the GNU General Public License version 2</span>
<a name="l00018"></a>00018 <span class="comment"> *  as published by the Free Software Foundation.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> *  This program is distributed in the hope that it will be useful,</span>
<a name="l00021"></a>00021 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00022"></a>00022 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00023"></a>00023 <span class="comment"> *  GNU General Public License for more details.</span>
<a name="l00024"></a>00024 <span class="comment"> *</span>
<a name="l00025"></a>00025 <span class="comment"> *  You should have received a copy of the GNU General Public License</span>
<a name="l00026"></a>00026 <span class="comment"> *  along with this program (see the file COPYING included with this</span>
<a name="l00027"></a>00027 <span class="comment"> *  distribution); if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00028"></a>00028 <span class="comment"> *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00029"></a>00029 <span class="comment"> */</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="preprocessor">#ifndef _BUFFER_H_</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define _BUFFER_H_</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="datatypes_8h.html">datatypes.h</a>"</span>
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classTunDevice.html">TunDevice</a>;
<a name="l00037"></a>00037 <span class="keyword">class </span><a class="code" href="classUDPPacketSource.html">UDPPacketSource</a>;
<a name="l00038"></a>00038 
<a name="l00039"></a><a class="code" href="classBuffer.html">00039</a> <span class="keyword">class </span><a class="code" href="classBuffer.html">Buffer</a>
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a>00042   <a class="code" href="classBuffer.html#e7ef2cd201190fde551dcb902627112b">Buffer</a>();
<a name="l00043"></a>00043   <a class="code" href="classBuffer.html#e7ef2cd201190fde551dcb902627112b">Buffer</a>(<a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> length);
<a name="l00044"></a>00044   <a class="code" href="classBuffer.html#e7ef2cd201190fde551dcb902627112b">Buffer</a>(<a class="code" href="datatypes_8h.html#40a40c6e9649a4e3806e76fef247d241">u_int8_t</a>* data, <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> length);
<a name="l00045"></a>00045   <span class="keyword">virtual</span> <a class="code" href="classBuffer.html#59b8743e4a5f731bdd0c4185c9ef263b">~Buffer</a>();
<a name="l00046"></a>00046   <a class="code" href="classBuffer.html#e7ef2cd201190fde551dcb902627112b">Buffer</a>(<span class="keyword">const</span> <a class="code" href="classBuffer.html">Buffer</a> &amp;src);
<a name="l00047"></a>00047   <span class="keywordtype">void</span> <a class="code" href="classBuffer.html#14cec0d3bf4f3f1a4a9930a8c53eb43a">operator=</a>(<span class="keyword">const</span> <a class="code" href="classBuffer.html">Buffer</a> &amp;src);
<a name="l00048"></a>00048 
<a name="l00049"></a>00049   <span class="comment">// math operations to calculate IVs and keys</span>
<a name="l00050"></a>00050   <span class="keyword">virtual</span> <a class="code" href="classBuffer.html">Buffer</a> <a class="code" href="classBuffer.html#d56159a415541fcff34ef8aed1eb7183">operator^</a>(<span class="keyword">const</span> <a class="code" href="classBuffer.html">Buffer</a> &amp;xor_by) <span class="keyword">const</span>;
<a name="l00051"></a>00051   <span class="keyword">virtual</span> <a class="code" href="classBuffer.html">Buffer</a> <a class="code" href="classBuffer.html#13200a4925b1b3c08f99e09ccb6854a1">leftByteShift</a>(<a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> width) <span class="keyword">const</span>;
<a name="l00052"></a>00052   <span class="keyword">virtual</span> <a class="code" href="classBuffer.html">Buffer</a> <a class="code" href="classBuffer.html#298949899f3f78e4a8b3df7fa5ec532d">rightByteShift</a>(<a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> width) <span class="keyword">const</span>;
<a name="l00053"></a>00053 
<a name="l00054"></a>00054   <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="code" href="classBuffer.html#fe4b10487b4930e0407bdf61857629d6">resizeFront</a>(<a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> new_length);
<a name="l00055"></a>00055   <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="code" href="classBuffer.html#5698b2d64238f1f38578dc8e9e2b1bc9">resizeBack</a>(<a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> new_length);
<a name="l00056"></a>00056   <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="code" href="classBuffer.html#09ced241e4d0a46c52f0f20398076435">getLength</a>() <span class="keyword">const</span>;
<a name="l00057"></a>00057   <a class="code" href="datatypes_8h.html#40a40c6e9649a4e3806e76fef247d241">u_int8_t</a>* <a class="code" href="classBuffer.html#7890e20c6c77eb631c39728ea08b35b8">getBuf</a>();
<a name="l00058"></a>00058   <a class="code" href="datatypes_8h.html#40a40c6e9649a4e3806e76fef247d241">u_int8_t</a>&amp; <a class="code" href="classBuffer.html#763882c627db10206f78b090556b00fa">operator[]</a>(<a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> index);
<a name="l00059"></a>00059   <a class="code" href="datatypes_8h.html#40a40c6e9649a4e3806e76fef247d241">u_int8_t</a> <a class="code" href="classBuffer.html#763882c627db10206f78b090556b00fa">operator[]</a>(<a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> index) <span class="keyword">const</span>;
<a name="l00060"></a>00060   <span class="keywordtype">void</span> <a class="code" href="classBuffer.html#13d927c471a7516b37bc9ad8fc1741ce">printHexDump</a>() <span class="keyword">const</span>;
<a name="l00061"></a>00061 
<a name="l00062"></a>00062   <a class="code" href="classBuffer.html#dcf367d5f1b7fced7aa61bb919af7943">operator u_int8_t*</a>(); <span class="comment">// just for write/read tun and packetSource</span>
<a name="l00063"></a>00063 <span class="keyword">protected</span>:
<a name="l00064"></a><a class="code" href="classBuffer.html#51b494563d277beb4740f86c519f30fb">00064</a>   <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classTunDevice.html">TunDevice</a>;
<a name="l00065"></a><a class="code" href="classBuffer.html#940a382a5e3a8622e6689e13dc453481">00065</a>   <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classUDPPacketSource.html">UDPPacketSource</a>;
<a name="l00066"></a><a class="code" href="classBuffer.html#41d791e5b640813dea34c24c11056581">00066</a>   <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classAesIcmCypher.html">AesIcmCypher</a>;
<a name="l00067"></a><a class="code" href="classBuffer.html#1d039eb05e29b8eeadca9b474bb6d49f">00067</a>   <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classKeyDerivation.html">KeyDerivation</a>;   <span class="comment">// </span>
<a name="l00068"></a>00068 
<a name="l00069"></a><a class="code" href="classBuffer.html#e60240b77a315e6b3c2bf88592d0be48">00069</a>   <a class="code" href="datatypes_8h.html#40a40c6e9649a4e3806e76fef247d241">u_int8_t</a> *<a class="code" href="classBuffer.html#e60240b77a315e6b3c2bf88592d0be48">buf_</a>;
<a name="l00070"></a><a class="code" href="classBuffer.html#d3a779d2403b5183427f12554e2f51c3">00070</a>   <a class="code" href="datatypes_8h.html#1382fcaa92d837ce7c0961788c8243d7">u_int32_t</a> <a class="code" href="classBuffer.html#d3a779d2403b5183427f12554e2f51c3">length_</a>;
<a name="l00071"></a>00071 
<a name="l00072"></a>00072 };
<a name="l00073"></a>00073 
<a name="l00074"></a>00074 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 7 23:43:49 2007 for anytun by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>