switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Packets / DefaultBundle / IPv6Extensions.test.cc
index 404ebc6..58ba51f 100644 (file)
@@ -2,24 +2,29 @@
 //
 // Copyright (C) 2007
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Stefan Bund <g0dil@berlios.de>
-//     Philipp Batroff <philipp.batroff@fokus.fraunhofer.de>
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
 //
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at 
+// http://senf.berlios.de/license.html
 //
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
+//
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Stefan Bund <g0dil@berlios.de>
+//   Philipp Batroff <pug@berlios.de>
 /** \file
     \brief IPv6Extensions unit tests */
 
 #include "ICMPv6Packet.hh"
 #include "ICMPv6TypePacket.hh"
 #include "EthernetPacket.hh"
-#include <senf/Utils/hexdump.hh>
 
 #include <senf/Utils/auto_unit_test.hh>
 #include <boost/test/test_tools.hpp>
 
 #define prefix_
-///////////////////////////////cc.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
-BOOST_AUTO_UNIT_TEST(ipv6Extensions_fragment)
+SENF_AUTO_UNIT_TEST(ipv6Extensions_fragment)
 {
     // Just for the fun of it, we test a nice chain: A fragment of a fragmented UDP packet
-
     unsigned char Fragment_packetData[] = {
         // IP header
         0x60, 0x00, 0x00, 0x00,         // IP Version, class, flow label
@@ -74,9 +77,9 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_fragment)
     BOOST_CHECK_EQUAL( pFragment_packet->version(), 6u );
     BOOST_CHECK_EQUAL( pFragment_packet->length(), 20u );
     BOOST_CHECK_EQUAL( pFragment_packet->nextHeader(), 44u );
-    BOOST_CHECK_EQUAL( pFragment_packet->source().value(), 
+    BOOST_CHECK_EQUAL( pFragment_packet->source().value(),
             senf::INet6Address::from_string("2001::1") );
-    BOOST_CHECK_EQUAL( pFragment_packet->destination().value(), 
+    BOOST_CHECK_EQUAL( pFragment_packet->destination().value(),
             senf::INet6Address::from_string("2001::2") );
 
     std::ostringstream oss (std::ostringstream::out);
@@ -105,15 +108,15 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_fragment)
 }
 
 
-BOOST_AUTO_UNIT_TEST(ipv6Extensions_routing)
+SENF_AUTO_UNIT_TEST(ipv6Extensions_routing)
 {
     unsigned char Routing_packetData[] = {
         // IP header
-        0x60, 0x30, 0x00, 0x00, 
+        0x60, 0x30, 0x00, 0x00,
         0x00, 0x10,             // payload Length
         0x2b,                   // next Header   (43 = Routing Header)
         0xff,                   // Hop Limit
-        0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+        0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
         0x02, 0x01, 0x02, 0xff, 0xfe, 0x00, 0x02, 0x00, // Src Addr
         0x35, 0x55, 0x55, 0x55, 0x66, 0x66, 0x66, 0x66,
         0x77, 0x77, 0x77, 0x77, 0x88, 0x88, 0x88, 0x88, // Dest. Addr
@@ -129,17 +132,17 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_routing)
         0xa3, 0xd3,             // checksum (incorrect in wireshark capture file, should be 0xa3c4)
         0x00, 0x00, 0x00, 0x00
     };
-    
+
     senf::IPv6Packet pRouting_packet (senf::IPv6Packet::create(Routing_packetData));
 
     BOOST_CHECK_EQUAL( pRouting_packet->version(), 6u );
     BOOST_CHECK_EQUAL( pRouting_packet->length(), 16u );
     BOOST_CHECK_EQUAL( pRouting_packet->nextHeader(), 43u );
-    BOOST_CHECK_EQUAL( pRouting_packet->source().value(), 
+    BOOST_CHECK_EQUAL( pRouting_packet->source().value(),
             senf::INet6Address::from_string("fe80::201:2ff:fe00:200") );
-    BOOST_CHECK_EQUAL( pRouting_packet->destination().value(), 
+    BOOST_CHECK_EQUAL( pRouting_packet->destination().value(),
             senf::INet6Address::from_string("3555:5555:6666:6666:7777:7777:8888:8888"));
-    
+
     std::ostringstream oss (std::ostringstream::out);
     SENF_CHECK_NO_THROW( pRouting_packet.dump( oss));
 
@@ -151,7 +154,7 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_routing)
     BOOST_CHECK_EQUAL( pRouting_extension->headerLength(), 0x00 );
     BOOST_CHECK_EQUAL( pRouting_extension->routingType(), 0x00 );
     BOOST_CHECK_EQUAL( pRouting_extension->segmentsLeft(), 0x00);
-    
+
     BOOST_CHECK_EQUAL( pRouting_extension->reserved(), 0u);
 
     BOOST_REQUIRE( pRouting_extension.next().is<senf::ICMPv6Packet>() );
@@ -162,16 +165,16 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_routing)
 }
 
 
-BOOST_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_parse)
+SENF_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_parse)
 {
     unsigned char HopByHop_packetData[] = {
         0x60, 0x00, 0x00, 0x00, // IP version, class, flow label
         0x00, 0x24,             // payload length
         0x00,                   // next header: IPv6 hop-by-hop option (0)
         0x01,                   // hop limit (1)
-        0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 
+        0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
         0x02, 0x19, 0xb9, 0xff, 0xfe, 0xeb, 0xb2, 0x26, // IPv6 Source address
-        0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,     
+        0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16, // IPv6 Destination address ff02::16
         // HopByHop option
         0x3a, // next Header (ICMPv6)
@@ -192,7 +195,7 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_parse)
     BOOST_CHECK_EQUAL( pHop_packet->version(), 6u );
     BOOST_CHECK_EQUAL( pHop_packet->length(), 36u );
     BOOST_CHECK_EQUAL( pHop_packet->nextHeader(), 0u );
-    BOOST_CHECK_EQUAL( pHop_packet->source().value(), 
+    BOOST_CHECK_EQUAL( pHop_packet->source().value(),
             senf::INet6Address::from_string("fe80::219:b9ff:feeb:b226") );
     BOOST_CHECK_EQUAL( pHop_packet->destination().value(), senf::INet6Address::from_string("ff02::16") );
 
@@ -210,12 +213,12 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_parse)
     BOOST_CHECK_EQUAL( listIter->altAction(), 0u);
     BOOST_CHECK_EQUAL( listIter->changeFlag(), 0u);
     BOOST_CHECK_EQUAL( listIter->optionType(), 5u);
-    BOOST_CHECK_EQUAL( listIter->optionLength(), 2u);
+    BOOST_CHECK_EQUAL( listIter->length(), 2u);
     ++listIter;
     BOOST_CHECK_EQUAL( listIter->altAction(), 0u);
     BOOST_CHECK_EQUAL( listIter->changeFlag(), 0u);
     BOOST_CHECK_EQUAL( listIter->optionType(), 2u);
-    BOOST_CHECK_EQUAL( listIter->optionLength(), 0);
+    BOOST_CHECK_EQUAL( listIter->length(), 0);
 
     BOOST_REQUIRE( pHop_extension.next().is<senf::ICMPv6Packet>() );
     senf::ICMPv6Packet pICMPv6  (pHop_extension.next().as<senf::ICMPv6Packet>());
@@ -224,45 +227,43 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_parse)
     BOOST_CHECK_EQUAL( pICMPv6->checksum(), 0x50cc);
 }
 
-BOOST_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_create)
+
+SENF_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_create)
 {
     std::ostringstream oss (std::ostringstream::out);
     unsigned char HopByHop_packetData[] = {
-        //Ethernet
-        0x33 ,0x33 ,0x00 ,0x00 ,0x00 ,0x16 ,    //destination MAC
-        0x00 ,0x19 ,0xb9 ,0xeb ,0xb2 ,0x26 ,    //source MAC
-        0x86 ,0xdd,                             //type (IPv6)
-        //IPv6
-        0x60, 0x00, 0x00, 0x00, //IP version, class, flow label
-        0x00, 0x24,           //payload length
-        0x00,                 //next header: IPv6 hop-by-hop option (0)
-        0x01,                 //hop limit (1)
-        0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,     //IPv6 Source address (fe80::219:b9ff:feeb:b226)
-        0x02, 0x19, 0xb9, 0xff, 0xfe, 0xeb, 0xb2, 0x26,
-
-        0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,     //IPv6 Destination address ff02::16
-        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16,
-//         HopByHop option
-        0x3a,   //next Header (ICMPv6)
-        0x00,   //Length (0 = 8Bytes)
-
-//         option Header
-        0x05, //option type
-        0x02, //option Length (= 2 byte)
-        0x00, 0x00, //data (zero data here ...)
-        0x01, 0x00, //padding
-//         ICMPv6
-        0x8f, //type 143
-        0x00, //code 0, should always be 0
-        0x50 ,0xcc , //checksum
-
-//         MLDv2
-        0x00 ,0x00 , //reserved, zero by default
-        0x00 ,0x01 , //nr of McAddressRecords
-        0x04 ,  //recordType
-        0x00 ,  //auxiliarydatalength
-        0x00 ,0x00 ,    // number of sources
-        0xff ,0x02 ,0x00 ,0x00, 0x00 ,0x00 ,0x00 ,0x00 ,    //ipv6McAddress ff02::1:ffeb:b226
+        // Ethernet
+        0x33 ,0x33 ,0x00 ,0x00 ,0x00 ,0x16 , // destination MAC
+        0x00 ,0x19 ,0xb9 ,0xeb ,0xb2 ,0x26 , // source MAC
+        0x86 ,0xdd,                          // type (IPv6)
+        // IPv6
+        0x60, 0x00, 0x00, 0x00, // IP version, class, flow label
+        0x00, 0x24,             // payload length
+        0x00,                   // next header: IPv6 hop-by-hop option (0)
+        0x01,                   // hop limit (1)
+        0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // IPv6 Source address
+        0x02, 0x19, 0xb9, 0xff, 0xfe, 0xeb, 0xb2, 0x26, // (fe80::219:b9ff:feeb:b226)
+        0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // IPv6 Destination address
+        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16, // (ff02::16)
+        // HopByHop option
+        0x3a, // next Header (ICMPv6)
+        0x00, // Length (0 = 8Bytes)
+        // option Header
+        0x05, // option type
+        0x02, // option Length (= 2 byte)
+        0x00, 0x00, // data (zero data here ...)
+        0x01, 0x00, // padding
+        // ICMPv6
+        0x8f, // type 143
+        0x00, // code 0, should always be 0
+        0x50 ,0xcc , // checksum
+        // MLDv2
+        0x00 ,0x00 , // reserved, zero by default
+        0x00 ,0x01 , // nr of McAddressRecords
+        0x04 ,       // recordType
+        0x00 ,       // auxiliarydatalength
+        0x00 ,0x00 , // number of sources
+        0xff ,0x02 ,0x00 ,0x00, 0x00 ,0x00 ,0x00 ,0x00 ,  // ipv6McAddress ff02::1:ffeb:b226
         0x00 ,0x00 ,0x00 ,0x01 ,0xff ,0xeb ,0xb2 ,0x26
     };
     senf::EthernetPacket eth (senf::EthernetPacket::create() );
@@ -280,16 +281,16 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_create)
 
     senf::IPv6HopByHopOptionsPacket pext (senf::IPv6HopByHopOptionsPacket::createAfter(ip) );
     pext->nextHeader() = 58u;
-    pext->headerLength() = 0u;
     {
         senf::IPv6HopByHopOptionsPacket::Parser::options_t::container optC(pext->options() );
         {
-            senf::IPv6GenericOptionTLVParser opt ( optC.push_back_space().init<senf::IPv6GenericOptionTLVParser>());
+            senf::IPv6GenericOptionParser opt (
+                    optC.push_back_space().init<senf::IPv6GenericOptionParser>());
             opt.altAction() = 0u;
             opt.changeFlag() = 0u;
             opt.optionType() = 5u;
             unsigned char val[] = {0x00, 0x00};
-            opt.setPayload(val);
+            opt.value(val);
         }
     }
 
@@ -310,32 +311,87 @@ BOOST_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_create)
             eth.data().begin(), eth.data().end() );
 }
 
-//provisionary unittest, only creating extensino Header Packet type
-BOOST_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_create_SN) {
-    
-    unsigned char data[] = { 0x3a, 0x00, 0x0d, 0x03, 0x01, 0xab, 0xcd, 0x00 };
-    
+
+namespace {
+    struct IPv6ChecksumOptionParser : public senf::IPv6OptionParser
+    {
+    #   include SENF_PARSER()
+        SENF_PARSER_INHERIT ( IPv6OptionParser );
+        SENF_PARSER_FIELD ( extendedType, senf::UInt8Parser );
+        SENF_PARSER_FIELD ( checksum,   senf::UInt32Parser  );
+        SENF_PARSER_FINALIZE ( IPv6ChecksumOptionParser     );
+
+        SENF_PARSER_INIT() {
+            optionType() = typeId;
+            length() = 5u;
+            extendedType() = extendedTypeId;
+        }
+
+        static const boost::uint8_t typeId = 0x0d;
+        static const boost::uint8_t extendedTypeId = 0x4d;
+    };
+}
+
+SENF_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_create_SN)
+{
     senf::IPv6HopByHopOptionsPacket p ( senf::IPv6HopByHopOptionsPacket::create() );
-    p->nextHeader() = 58u;
+    p->nextHeader() = 0x3a;
     {
-        senf::IPv6HopByHopOptionsPacket::Parser::options_t::container optC(p->options() );
+        senf::IPv6HopByHopOptionsPacket::Parser::options_t::container optC (p->options() );
         {
-            senf::IPv6ChecksumOptionTLVParser opt ( optC.push_back_space().init<senf::IPv6ChecksumOptionTLVParser>());
-//             opt.altAction() = 0u;
-//             opt.changeFlag() = 0u;
-//             opt.optionType() = 5u;
-            SENF_CHECK_NO_THROW( opt.SlfNetType() = 1u) ;
-            opt.checksum() = 0xabcdu;
+            IPv6ChecksumOptionParser opt (
+                    optC.push_back_space().init<IPv6ChecksumOptionParser>());
+            opt.checksum() = 0x01234567u;
         }
     }
+
+    unsigned char data[] = {
+            0x3a, 0x01,  // Hop-By-Hop Header (nextHeader, length)
+            0x0d, 0x05,  // option type, length
+            // option value: extendedType, checksum
+            0x4d, 0x01, 0x23, 0x45, 0x67,
+            // padding (PadN option: type, length, 0-padding)
+            0x01, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00
+    };
     SENF_CHECK_EQUAL_COLLECTIONS( data, data+sizeof(data),
-                                 p.data().begin(), p.data().end() );    
+                                 p.data().begin(), p.data().end() );
 }
 
-///////////////////////////////cc.e////////////////////////////////////////
-#undef prefix_
 
+SENF_AUTO_UNIT_TEST(ipv6Extensions_hopByHop_parse_SN)
+{
+    unsigned char data[] = {
+            0x3a, 0x01,  // Hop-By-Hop Header (nextHeader, length)
+            0x0d, 0x05,  // option type, length
+            // option value: slfNetType, checksum
+            0x4d, 0x01, 0x23, 0x45, 0x67,
+            // padding (PadN option: type, length, 0-padding)
+            0x01, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00
+    };
+
+    senf::IPv6HopByHopOptionsPacket p ( senf::IPv6HopByHopOptionsPacket::create(data) );
+    BOOST_CHECK_EQUAL( p->nextHeader(), 0x3a);
+
+    {
+        typedef senf::IPv6HopByHopOptionsPacket::Parser::options_t::container optContainer_t;
+        optContainer_t optC (p->options() );
+        optContainer_t::iterator listIter (optC.begin());
+
+        BOOST_CHECK_EQUAL( listIter->optionType(), 0x0d);
+        BOOST_CHECK( listIter->is<IPv6ChecksumOptionParser>());
+        IPv6ChecksumOptionParser opt ( listIter->as<IPv6ChecksumOptionParser>());
+        BOOST_CHECK_EQUAL( opt.extendedType(), 0x4d);
+        BOOST_CHECK_EQUAL( opt.checksum(), 0x01234567);
+    }
+
+    std::ostringstream oss (std::ostringstream::out);
+    SENF_CHECK_NO_THROW( p.dump( oss));
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+#undef prefix_
 
+\f
 // Local Variables:
 // mode: c++
 // fill-column: 100