switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Packets / DefaultBundle / IPv6Extensions.test.cc
1 // $Id$
2 //
3 // Copyright (C) 2007
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 //
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at 
9 // http://senf.berlios.de/license.html
10 //
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on, 
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
14 //
15 // Software distributed under the License is distributed on an "AS IS" basis, 
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
17 // for the specific language governing rights and limitations under the License.
18 //
19 // The Original Code is Fraunhofer FOKUS code.
20 //
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
24 //
25 // Contributor(s):
26 //   Stefan Bund <g0dil@berlios.de>
27 //   Philipp Batroff <pug@berlios.de>
28 /** \file
29     \brief IPv6Extensions unit tests */
30
31 //#include "IPv6Extensions.test.hh"
32 //#include "IPv6Extensions.test.ih"
33
34 // Custom includes
35 #include "IPv6Extensions.hh"
36 #include "IPv6Packet.hh"
37 #include "UDPPacket.hh"
38 #include "ICMPv6Packet.hh"
39 #include "ICMPv6TypePacket.hh"
40 #include "EthernetPacket.hh"
41
42 #include <senf/Utils/auto_unit_test.hh>
43 #include <boost/test/test_tools.hpp>
44
45 #define prefix_
46 //-/////////////////////////////////////////////////////////////////////////////////////////////////
47
48 SENF_AUTO_UNIT_TEST(ipv6Extensions_fragment)
49 {
50     // Just for the fun of it, we test a nice chain: A fragment of a fragmented UDP packet
51     unsigned char Fragment_packetData[] = {
52         // IP header
53         0x60, 0x00, 0x00, 0x00,         // IP Version, class, flow label
54         0, 20,                          // payload length
55         44,                             // next header (IPv6 Fragment)
56         32,                             // hop limit
57         0x20, 0x01, 0, 0, 0, 0, 0, 0,   // source ip = 2001::1
58            0, 0, 0, 0, 0, 0, 0, 0x01,
59         0x20, 0x01, 0, 0, 0, 0, 0, 0,   // destination ip = 2001::2
60            0, 0, 0, 0, 0, 0, 0, 0x02,
61         // IPv6 Fragment header
62         17,                             // next header (UDP)
63         0,                              // reserved
64         0x05, 0x00,                     // fragment offset, last fragment
65         0x01, 0x02, 0x03, 0x04,         // id
66         // UDP header
67         0x10, 0x00,                     // source port
68         0x20, 0x00,                     // destination port
69         0, 12,                          // length
70         0x00, 0x00,                     // CRC (no, I won't calculate this one ...)
71         // Payload data
72         0x11, 0x12, 0x13, 0x14
73     };
74
75     senf::IPv6Packet pFragment_packet (senf::IPv6Packet::create(Fragment_packetData));
76
77     BOOST_CHECK_EQUAL( pFragment_packet->version(), 6u );
78     BOOST_CHECK_EQUAL( pFragment_packet->length(), 20u );
79     BOOST_CHECK_EQUAL( pFragment_packet->nextHeader(), 44u );
80     BOOST_CHECK_EQUAL( pFragment_packet->source().value(),
81             senf::INet6Address::from_string("2001::1") );
82     BOOST_CHECK_EQUAL( pFragment_packet->destination().value(),
83             senf::INet6Address::from_string("2001::2") );
84
85     std::ostringstream oss (std::ostringstream::out);
86     SENF_CHECK_NO_THROW( pFragment_packet.dump( oss));
87
88     BOOST_CHECK( pFragment_packet.next().is<senf::IPv6FragmentPacket>() );
89
90     senf::IPv6FragmentPacket fFragment_packet (pFragment_packet.next().as<senf::IPv6FragmentPacket>());
91
92     BOOST_CHECK_EQUAL( fFragment_packet->nextHeader(), 17u );
93     BOOST_CHECK_EQUAL( fFragment_packet->fragmentOffset(), 160u );
94     BOOST_CHECK_EQUAL( fFragment_packet->id(), 0x01020304u );
95     BOOST_CHECK( fFragment_packet.next().is<senf::UDPPacket>() );
96
97     senf::UDPPacket uFragment_packet (fFragment_packet.next().as<senf::UDPPacket>());
98
99     BOOST_CHECK_EQUAL( uFragment_packet->source(), 0x1000u );
100     BOOST_CHECK_EQUAL( uFragment_packet->destination(), 0x2000u );
101     BOOST_CHECK_EQUAL( uFragment_packet->length(), 12u );
102     BOOST_CHECK( uFragment_packet.next().is<senf::DataPacket>() );
103
104     senf::DataPacket dFragment_packet (uFragment_packet.next().as<senf::DataPacket>());
105     senf::PacketData::iterator i (uFragment_packet.next().data().begin());
106     BOOST_CHECK_EQUAL( dFragment_packet.size(), 4u );
107     BOOST_CHECK_EQUAL( dFragment_packet.data()[0], 0x11 );
108 }
109
110
111 SENF_AUTO_UNIT_TEST(ipv6Extensions_routing)
112 {
113     unsigned char Routing_packetData[] = {
114         // IP header
115         0x60, 0x30, 0x00, 0x00,
116         0x00, 0x10,             // payload Length
117         0x2b,                   // next Header   (43 = Routing Header)
118         0xff,                   // Hop Limit
119         0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
120         0x02, 0x01, 0x02, 0xff, 0xfe, 0x00, 0x02, 0x00, // Src Addr
121         0x35, 0x55, 0x55, 0x55, 0x66, 0x66, 0x66, 0x66,
122         0x77, 0x77, 0x77, 0x77, 0x88, 0x88, 0x88, 0x88, // Dest. Addr
123         // Routing Header
124         0x3a,                   // nextHeader (58)
125         0x00,                   // length ( 0 )
126         0x00,                   // routing type ( 0 )
127         0x00,                   // Left Segments ( 0 )
128         0x00, 0x00, 0x00, 0x00, // reserved
129         // ICMPv6
130         0x01,                   // type: 1 (unreachable )
131         0x00,                   // code: 0 (route unreachable)
132         0xa3, 0xd3,             // checksum (incorrect in wireshark capture file, should be 0xa3c4)
133         0x00, 0x00, 0x00, 0x00
134     };
135
136     senf::IPv6Packet pRouting_packet (senf::IPv6Packet::create(Routing_packetData));
137
138     BOOST_CHECK_EQUAL( pRouting_packet->version(), 6u );
139     BOOST_CHECK_EQUAL( pRouting_packet->length(), 16u );
140     BOOST_CHECK_EQUAL( pRouting_packet->nextHeader(), 43u );
141     BOOST_CHECK_EQUAL( pRouting_packet->source().value(),
142             senf::INet6Address::from_string("fe80::201:2ff:fe00:200") );
143     BOOST_CHECK_EQUAL( pRouting_packet->destination().value(),
144             senf::INet6Address::from_string("3555:5555:6666:6666:7777:7777:8888:8888"));
145
146     std::ostringstream oss (std::ostringstream::out);
147     SENF_CHECK_NO_THROW( pRouting_packet.dump( oss));
148
149     BOOST_REQUIRE( pRouting_packet.next().is<senf::IPv6RoutingPacket>() );
150
151     senf::IPv6RoutingPacket pRouting_extension (pRouting_packet.next().as<senf::IPv6RoutingPacket>());
152
153     BOOST_CHECK_EQUAL( pRouting_extension->nextHeader(), 58u );
154     BOOST_CHECK_EQUAL( pRouting_extension->headerLength(), 0x00 );
155     BOOST_CHECK_EQUAL( pRouting_extension->routingType(), 0x00 );
156     BOOST_CHECK_EQUAL( pRouting_extension->segmentsLeft(), 0x00);
157
158     BOOST_CHECK_EQUAL( pRouting_extension->reserved(), 0u);
159
160     BOOST_REQUIRE( pRouting_extension.next().is<senf::ICMPv6Packet>() );
161     senf::ICMPv6Packet pICMPv6 (pRouting_extension.next().as<senf::ICMPv6Packet>());
162     BOOST_CHECK_EQUAL( pICMPv6->type(), 1u);
163     BOOST_CHECK_EQUAL( pICMPv6->code(), 0u);
164     BOOST_CHECK_EQUAL( pICMPv6->checksum(), 0xa3d3);
165 }
166
167
168 SENF_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_parse)
169 {
170     unsigned char HopByHop_packetData[] = {
171         0x60, 0x00, 0x00, 0x00, // IP version, class, flow label
172         0x00, 0x24,             // payload length
173         0x00,                   // next header: IPv6 hop-by-hop option (0)
174         0x01,                   // hop limit (1)
175         0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
176         0x02, 0x19, 0xb9, 0xff, 0xfe, 0xeb, 0xb2, 0x26, // IPv6 Source address
177         0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
178         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16, // IPv6 Destination address ff02::16
179         // HopByHop option
180         0x3a, // next Header (ICMPv6)
181         0x00, // Length (0 = 8Bytes)
182         // option Header
183         0x05, // option type
184         0x02, // option Length (= 2 byte)
185         0x00, 0x00, //data (zero data here ...)
186         0x02, //option type (2, set for testing purposes only)
187         0x00,  //option Type length (=0, no data field needed here)
188         // ICMPv6
189         0x8f, // type 143
190         0x00, // code 0, should always be 0
191         0x50, 0xcc, // checksum
192     };
193
194     senf::IPv6Packet pHop_packet (senf::IPv6Packet::create(HopByHop_packetData));
195     BOOST_CHECK_EQUAL( pHop_packet->version(), 6u );
196     BOOST_CHECK_EQUAL( pHop_packet->length(), 36u );
197     BOOST_CHECK_EQUAL( pHop_packet->nextHeader(), 0u );
198     BOOST_CHECK_EQUAL( pHop_packet->source().value(),
199             senf::INet6Address::from_string("fe80::219:b9ff:feeb:b226") );
200     BOOST_CHECK_EQUAL( pHop_packet->destination().value(), senf::INet6Address::from_string("ff02::16") );
201
202     std::ostringstream oss (std::ostringstream::out);
203     SENF_CHECK_NO_THROW( pHop_packet.dump( oss ));
204
205     BOOST_REQUIRE( pHop_packet.next().is<senf::IPv6HopByHopOptionsPacket>() );
206     senf::IPv6HopByHopOptionsPacket pHop_extension (pHop_packet.next().as<senf::IPv6HopByHopOptionsPacket>());
207     BOOST_CHECK_EQUAL( pHop_extension->nextHeader(), 58u );
208     BOOST_CHECK_EQUAL( pHop_extension->headerLength(), 0x00 );
209
210     senf::IPv6HopByHopOptionsPacket::Parser::options_t::container optC(pHop_extension->options() );
211     senf::IPv6HopByHopOptionsPacket::Parser::options_t::container::iterator listIter (optC.begin());
212
213     BOOST_CHECK_EQUAL( listIter->altAction(), 0u);
214     BOOST_CHECK_EQUAL( listIter->changeFlag(), 0u);
215     BOOST_CHECK_EQUAL( listIter->optionType(), 5u);
216     BOOST_CHECK_EQUAL( listIter->length(), 2u);
217     ++listIter;
218     BOOST_CHECK_EQUAL( listIter->altAction(), 0u);
219     BOOST_CHECK_EQUAL( listIter->changeFlag(), 0u);
220     BOOST_CHECK_EQUAL( listIter->optionType(), 2u);
221     BOOST_CHECK_EQUAL( listIter->length(), 0);
222
223     BOOST_REQUIRE( pHop_extension.next().is<senf::ICMPv6Packet>() );
224     senf::ICMPv6Packet pICMPv6  (pHop_extension.next().as<senf::ICMPv6Packet>());
225     BOOST_CHECK_EQUAL( pICMPv6->type(), 0x8f);
226     BOOST_CHECK_EQUAL( pICMPv6->code(), 0u);
227     BOOST_CHECK_EQUAL( pICMPv6->checksum(), 0x50cc);
228 }
229
230
231 SENF_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_create)
232 {
233     std::ostringstream oss (std::ostringstream::out);
234     unsigned char HopByHop_packetData[] = {
235         // Ethernet
236         0x33 ,0x33 ,0x00 ,0x00 ,0x00 ,0x16 , // destination MAC
237         0x00 ,0x19 ,0xb9 ,0xeb ,0xb2 ,0x26 , // source MAC
238         0x86 ,0xdd,                          // type (IPv6)
239         // IPv6
240         0x60, 0x00, 0x00, 0x00, // IP version, class, flow label
241         0x00, 0x24,             // payload length
242         0x00,                   // next header: IPv6 hop-by-hop option (0)
243         0x01,                   // hop limit (1)
244         0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // IPv6 Source address
245         0x02, 0x19, 0xb9, 0xff, 0xfe, 0xeb, 0xb2, 0x26, // (fe80::219:b9ff:feeb:b226)
246         0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // IPv6 Destination address
247         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16, // (ff02::16)
248         // HopByHop option
249         0x3a, // next Header (ICMPv6)
250         0x00, // Length (0 = 8Bytes)
251         // option Header
252         0x05, // option type
253         0x02, // option Length (= 2 byte)
254         0x00, 0x00, // data (zero data here ...)
255         0x01, 0x00, // padding
256         // ICMPv6
257         0x8f, // type 143
258         0x00, // code 0, should always be 0
259         0x50 ,0xcc , // checksum
260         // MLDv2
261         0x00 ,0x00 , // reserved, zero by default
262         0x00 ,0x01 , // nr of McAddressRecords
263         0x04 ,       // recordType
264         0x00 ,       // auxiliarydatalength
265         0x00 ,0x00 , // number of sources
266         0xff ,0x02 ,0x00 ,0x00, 0x00 ,0x00 ,0x00 ,0x00 ,  // ipv6McAddress ff02::1:ffeb:b226
267         0x00 ,0x00 ,0x00 ,0x01 ,0xff ,0xeb ,0xb2 ,0x26
268     };
269     senf::EthernetPacket eth (senf::EthernetPacket::create() );
270     eth->destination() = senf::MACAddress::from_string( "33:33:00:00:00:16" );
271     eth->source() = senf::MACAddress::from_string( "00:19:b9:eb:b2:26" );
272     eth->type_length() = 0x86dd;
273
274     senf::IPv6Packet ip (senf::IPv6Packet::createAfter(eth));
275     ip->version() = 6u;
276     ip->length() = 12u;
277     ip->nextHeader() = 0u;
278     ip->hopLimit() = 1u;
279     ip->source() = senf::INet6Address::from_string("fe80::219:b9ff:feeb:b226");
280     ip->destination() = senf::INet6Address::from_string("ff02::16");
281
282     senf::IPv6HopByHopOptionsPacket pext (senf::IPv6HopByHopOptionsPacket::createAfter(ip) );
283     pext->nextHeader() = 58u;
284     {
285         senf::IPv6HopByHopOptionsPacket::Parser::options_t::container optC(pext->options() );
286         {
287             senf::IPv6GenericOptionParser opt (
288                     optC.push_back_space().init<senf::IPv6GenericOptionParser>());
289             opt.altAction() = 0u;
290             opt.changeFlag() = 0u;
291             opt.optionType() = 5u;
292             unsigned char val[] = {0x00, 0x00};
293             opt.value(val);
294         }
295     }
296
297     senf::ICMPv6Packet icmp (senf::ICMPv6Packet::createAfter (pext));
298     icmp->code() = 0u;
299     senf::MLDv2ListenerReport mld ( senf::MLDv2ListenerReport::createAfter(icmp) );
300     {
301         senf::MLDv2ListenerReport::Parser::mcastAddrRecords_t::container c (mld->mcastAddrRecords() );
302         c.push_back_space();
303         c.back().recordType() = 4u;
304         senf::INet6Address addr( senf::INet6Address::from_string("ff02::1:ffeb:b226") );
305         c.back().mcAddress() = addr;
306     }
307     eth.finalizeAll();
308     SENF_CHECK_NO_THROW( eth.dump(oss) );
309     SENF_CHECK_EQUAL_COLLECTIONS(
310             HopByHop_packetData, HopByHop_packetData+sizeof(HopByHop_packetData),
311             eth.data().begin(), eth.data().end() );
312 }
313
314
315 namespace {
316     struct IPv6ChecksumOptionParser : public senf::IPv6OptionParser
317     {
318     #   include SENF_PARSER()
319         SENF_PARSER_INHERIT ( IPv6OptionParser );
320         SENF_PARSER_FIELD ( extendedType, senf::UInt8Parser );
321         SENF_PARSER_FIELD ( checksum,   senf::UInt32Parser  );
322         SENF_PARSER_FINALIZE ( IPv6ChecksumOptionParser     );
323
324         SENF_PARSER_INIT() {
325             optionType() = typeId;
326             length() = 5u;
327             extendedType() = extendedTypeId;
328         }
329
330         static const boost::uint8_t typeId = 0x0d;
331         static const boost::uint8_t extendedTypeId = 0x4d;
332     };
333 }
334
335 SENF_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_create_SN)
336 {
337     senf::IPv6HopByHopOptionsPacket p ( senf::IPv6HopByHopOptionsPacket::create() );
338     p->nextHeader() = 0x3a;
339     {
340         senf::IPv6HopByHopOptionsPacket::Parser::options_t::container optC (p->options() );
341         {
342             IPv6ChecksumOptionParser opt (
343                     optC.push_back_space().init<IPv6ChecksumOptionParser>());
344             opt.checksum() = 0x01234567u;
345         }
346     }
347
348     unsigned char data[] = {
349             0x3a, 0x01,  // Hop-By-Hop Header (nextHeader, length)
350             0x0d, 0x05,  // option type, length
351             // option value: extendedType, checksum
352             0x4d, 0x01, 0x23, 0x45, 0x67,
353             // padding (PadN option: type, length, 0-padding)
354             0x01, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00
355     };
356     SENF_CHECK_EQUAL_COLLECTIONS( data, data+sizeof(data),
357                                  p.data().begin(), p.data().end() );
358 }
359
360
361 SENF_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_parse_SN)
362 {
363     unsigned char data[] = {
364             0x3a, 0x01,  // Hop-By-Hop Header (nextHeader, length)
365             0x0d, 0x05,  // option type, length
366             // option value: slfNetType, checksum
367             0x4d, 0x01, 0x23, 0x45, 0x67,
368             // padding (PadN option: type, length, 0-padding)
369             0x01, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00
370     };
371
372     senf::IPv6HopByHopOptionsPacket p ( senf::IPv6HopByHopOptionsPacket::create(data) );
373     BOOST_CHECK_EQUAL( p->nextHeader(), 0x3a);
374
375     {
376         typedef senf::IPv6HopByHopOptionsPacket::Parser::options_t::container optContainer_t;
377         optContainer_t optC (p->options() );
378         optContainer_t::iterator listIter (optC.begin());
379
380         BOOST_CHECK_EQUAL( listIter->optionType(), 0x0d);
381         BOOST_CHECK( listIter->is<IPv6ChecksumOptionParser>());
382         IPv6ChecksumOptionParser opt ( listIter->as<IPv6ChecksumOptionParser>());
383         BOOST_CHECK_EQUAL( opt.extendedType(), 0x4d);
384         BOOST_CHECK_EQUAL( opt.checksum(), 0x01234567);
385     }
386
387     std::ostringstream oss (std::ostringstream::out);
388     SENF_CHECK_NO_THROW( p.dump( oss));
389 }
390
391 //-/////////////////////////////////////////////////////////////////////////////////////////////////
392 #undef prefix_
393
394 \f
395 // Local Variables:
396 // mode: c++
397 // fill-column: 100
398 // c-file-style: "senf"
399 // indent-tabs-mode: nil
400 // ispell-local-dictionary: "american"
401 // compile-command: "scons -u test"
402 // comment-column: 40
403 // End: