switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Packets / 80221Bundle / TLVParser.cc
index 45622fb..ddc3340 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2007
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Thorsten Horstmann <tho@berlios.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.
+// 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
 //
-// 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 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.
 //
-// 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.
+// 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):
+//   Thorsten Horstmann <tho@berlios.de>
 
 /** \file
     \brief TLVParser non-inline non-template implementation */
 //#include "TLVParser.ih"
 
 // Custom includes
-#include <iomanip>
 #include <senf/Utils/hexdump.hh>
 #include <senf/Utils/Format.hh>
+#include "Exceptions.hh"
 
 #define prefix_
-///////////////////////////////cc.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 SENF_PACKET_TLV_REGISTRY_REGISTER( senf::MIHFSrcIdTLVParser );
 SENF_PACKET_TLV_REGISTRY_REGISTER( senf::MIHFDstIdTLVParser );
 SENF_PACKET_TLV_REGISTRY_REGISTER( senf::MIHStatusTLVParser );
 SENF_PACKET_TLV_REGISTRY_REGISTER( senf::MIHValidTimeIntervalTLVParser );
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// MIHBaseTLVParser
+
+prefix_ void senf::MIHBaseTLVParser::validateType(boost::uint8_t expectedType)
+    const
+{
+    if (! check( 1 + senf::bytes(length_()) + length()) )
+        throw InvalidMIHPacketException("truncated TLV.") << " Type: " << unsigned(type());
+    if (type() != expectedType)
+        throw InvalidMIHPacketException("wrong TLV type. expected ") << unsigned(expectedType) << " got " << unsigned(type());
+}
+
+prefix_ void senf::MIHBaseTLVParser::validateTypeLength(boost::uint8_t expectedType, MIHTLVLengthParser::value_type expectedLength)
+    const
+{
+    validateType( expectedType);
+    if (length() != expectedLength)
+        throw InvalidMIHPacketException("invalid length in TLV.") << " Type: " << unsigned(type());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// senf::MIHBaseListTLVParser
+
+prefix_ void senf::MIHBaseListTLVParser::maxListSize(MIHTLVLengthParser::value_type maxl)
+    const
+{
+    protect(), listSize_().capacity( maxl);
+    maxLength( maxl + senf::bytes(listSize_()));
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::MIHFIdTLVParser
 
 prefix_ void senf::MIHFIdTLVParser::dump(std::ostream & os)
@@ -49,67 +84,104 @@ prefix_ void senf::MIHFIdTLVParser::dump(std::ostream & os)
     os << indent << "type:   " << unsigned (type()) << std::endl
        << indent << "length: " << unsigned (length()) << std::endl
        << indent << "value:\n";
-    std::string src_mihfId (asString());
+    std::string src_mihfId (valueAsString());
     hexdump(src_mihfId.begin(), src_mihfId.end(), os);
 }
 
-prefix_ void senf::MIHFIdTLVParser::setString(std::string const &id)
+prefix_ void senf::MIHFIdTLVParser::finalize()
+{
+    protect(), idLength_().finalize();
+    length_() << idLength() + senf::bytes(idLength_());
+    MIHBaseTLVParser::finalize();
+}
+
+prefix_ void senf::MIHFIdTLVParser::maxIdLength(boost::uint8_t maxl)
+    const
+{
+    // the maximum length of a MIHF_ID is 253 octets (see F.3.11 in 802.21)
+    if (maxl > 253)
+        throw std::length_error("maximum length of a MIHF_ID is 253 octets");
+    protect(), idLength_().capacity( maxl);
+    maxLength( maxl + senf::bytes(idLength_()));
+}
+
+prefix_ senf::safe_data_iterator senf::MIHFIdTLVParser::resizeValueField(
+        MIHTLVLengthParser::value_type size)
+{
+    MIHTLVLengthParser::value_type current_length ( idLength());
+    idLength_() << size;
+    length_() << size + idLength_().bytes();
+
+    safe_data_iterator si (data(), valueBegin());
+    if (current_length > size)
+        data().erase( si, boost::next(si, current_length-size));
+    else
+        data().insert( si, size-current_length, 0);
+    return si;
+}
+
+prefix_ void senf::MIHFIdTLVParser::value(std::string const & id)
 {
     size_type str_size (id.size());
     // the maximum length of a MIHF_ID is 253 octets (see F.3.11 in 802.21)
-    if (str_size > 253) 
+    if (str_size > 253)
         throw std::length_error("maximum length of a MIHF_ID is 253 octets");
-    safe_data_iterator si = resizeValueField( str_size);   
+    safe_data_iterator si = resizeValueField( str_size);
     std::copy( id.begin(), id.end(), si);
 }
 
-prefix_ void senf::MIHFIdTLVParser::setMACAddress(senf::MACAddress const &mac)
+prefix_ void senf::MIHFIdTLVParser::value(senf::MACAddress const & addr)
 {
-    safe_data_iterator si = resizeValueField(12);
-    std::copy( mac.begin(), mac.end(), getNAIEncodedOutputIterator(si));
+    safe_data_iterator si = resizeValueField(6*2);
+    std::copy( addr.begin(), addr.end(), getNAIEncodedOutputIterator(si));
 }
 
-prefix_ void senf::MIHFIdTLVParser::setINet4Address(senf::INet4Address const &addr)
+prefix_ void senf::MIHFIdTLVParser::value(senf::INet4Address const & addr)
 {
-    safe_data_iterator si = resizeValueField(8);
+    safe_data_iterator si = resizeValueField(4*2);
     std::copy( addr.begin(), addr.end(), getNAIEncodedOutputIterator(si));
 }
 
-prefix_ void senf::MIHFIdTLVParser::setINet6Address(senf::INet6Address const &addr)
+prefix_ void senf::MIHFIdTLVParser::value(senf::INet6Address const & addr)
 {
-    safe_data_iterator si = resizeValueField(32);
+    safe_data_iterator si = resizeValueField(16*2);
     std::copy( addr.begin(), addr.end(), getNAIEncodedOutputIterator(si));
 }
 
-prefix_ void senf::MIHFIdTLVParser::setEUI64(senf::EUI64 const &addr)
+prefix_ void senf::MIHFIdTLVParser::value(senf::EUI64 const & addr)
 {
-    safe_data_iterator si = resizeValueField(16);
+    safe_data_iterator si = resizeValueField(8*2);
     std::copy( addr.begin(), addr.end(), getNAIEncodedOutputIterator(si));
 }
 
+prefix_ void senf::MIHFIdTLVParser::value( MIHFId const & id)
+{
+    boost::apply_visitor( ValueSetterVisitor(*this), id);
+}
+
 prefix_ senf::MIHFId senf::MIHFIdTLVParser::valueAs(MIHFId::Type type)
     const
 {
     if (length() == 0) return MIHFId();
     switch (type) {
-    case MIHFId::Empty:
+    case MIHFId::MulticastType:
         return MIHFId();
     case MIHFId::MACAddress:
-        return MIHFId( asMACAddress());
+        return MIHFId( valueAsMACAddress());
     case MIHFId::INet4Address:
-        return MIHFId( asINet4Address());
+        return MIHFId( valueAsINet4Address());
     case MIHFId::INet6Address:
-        return MIHFId( asINet6Address());
+        return MIHFId( valueAsINet6Address());
     case MIHFId::String:
-        return MIHFId( asINet6Address());
+        return MIHFId( valueAsString());
     case MIHFId::EUI64:
-        return MIHFId( asINet6Address());
+        return MIHFId( valueAsEUI64());
     }
     return MIHFId();
 }
 
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::MIHFSrcIdTLVParser
 
 prefix_ void senf::MIHFSrcIdTLVParser::dump(std::ostream & os)
@@ -120,7 +192,14 @@ prefix_ void senf::MIHFSrcIdTLVParser::dump(std::ostream & os)
     MIHFIdTLVParser::dump(os);
 }
 
-///////////////////////////////////////////////////////////////////////////
+prefix_ void senf::MIHFSrcIdTLVParser::validate()
+    const
+{
+    validateType( typeId);
+}
+
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::MIHFDstIdTLVParser
 
 prefix_ void senf::MIHFDstIdTLVParser::dump(std::ostream & os)
@@ -131,7 +210,13 @@ prefix_ void senf::MIHFDstIdTLVParser::dump(std::ostream & os)
     MIHFIdTLVParser::dump(os);
 }
 
-///////////////////////////////////////////////////////////////////////////
+prefix_ void senf::MIHFDstIdTLVParser::validate()
+    const
+{
+    validateType( typeId);
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::MIHStatusTLVParser
 
 prefix_ void senf::MIHStatusTLVParser::dump(std::ostream & os)
@@ -147,7 +232,7 @@ prefix_ void senf::MIHStatusTLVParser::dump(std::ostream & os)
     case Success:
         os << " (Success)" << std::endl;
         return;
-    case UnspecifiedFailure:  
+    case UnspecifiedFailure:
         os << " (Unspecified Failure)" << std::endl;
         return;
     case Rejected:
@@ -163,7 +248,15 @@ prefix_ void senf::MIHStatusTLVParser::dump(std::ostream & os)
     os << " (???; invalid value!)" << std::endl;
 }
 
-///////////////////////////////////////////////////////////////////////////
+prefix_ void senf::MIHStatusTLVParser::validate()
+    const
+{
+    validateTypeLength( typeId, 1);
+    if (value() >= 4)
+        throw InvalidMIHPacketException("invalid value in MIHStatusTLV ") << unsigned( value());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::MIHRegisterReqCodeTLVParser
 
 prefix_ void senf::MIHRegisterReqCodeTLVParser::dump(std::ostream & os)
@@ -186,7 +279,15 @@ prefix_ void senf::MIHRegisterReqCodeTLVParser::dump(std::ostream & os)
     os << " (???; invalid value!)" << std::endl;
 }
 
-///////////////////////////////////////////////////////////////////////////
+prefix_ void senf::MIHRegisterReqCodeTLVParser::validate()
+    const
+{
+    validateTypeLength( typeId, 1);
+    if (value() >= 2)
+        throw InvalidMIHPacketException("invalid value in MIHRegisterReqCodeTLV ") << unsigned( value());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::MIHValidTimeIntervalTLVParser
 
 prefix_ void senf::MIHValidTimeIntervalTLVParser::dump(std::ostream & os)
@@ -201,29 +302,16 @@ prefix_ void senf::MIHValidTimeIntervalTLVParser::dump(std::ostream & os)
        << ( value()==0 ? " (infinite)" : " seconds") << std::endl;
 }
 
-
-///////////////////////////////////////////////////////////////////////////
-// senf::MIHBaseTLVParser
-
-prefix_ senf::safe_data_iterator senf::MIHBaseTLVParser::resizeValueField(
-        MIHTLVLengthParser::value_type size) 
+prefix_ void senf::MIHValidTimeIntervalTLVParser::validate()
+    const
 {
-    MIHTLVLengthParser::value_type current_length ( length());
-    length_() << size;
-
-    safe_data_iterator si (data(), boost::next(i(), 1 + length_().bytes() ));
-    if (current_length > size)
-        data().erase( si, boost::next(si, current_length-size));
-    else
-        data().insert( si, size-current_length, 0);
-    return si;
+    validateTypeLength( typeId, 4);
 }
 
-
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::MIHTLVLengthParser
 
-prefix_ senf::MIHTLVLengthParser::value_type senf::MIHTLVLengthParser::value() const 
+prefix_ senf::MIHTLVLengthParser::value_type senf::MIHTLVLengthParser::value() const
 {
     switch (bytes() ) {
     case 1:
@@ -241,7 +329,7 @@ prefix_ senf::MIHTLVLengthParser::value_type senf::MIHTLVLengthParser::value() c
     };
 }
 
-prefix_ void senf::MIHTLVLengthParser::value(value_type const & v) 
+prefix_ void senf::MIHTLVLengthParser::value(value_type const & v)
 {
     switch (bytes() ) {
     case 1:
@@ -269,7 +357,7 @@ prefix_ void senf::MIHTLVLengthParser::value(value_type const & v)
     underflow_flag() = (v <= 128);
 }
 
-prefix_ senf::MIHTLVLengthParser::value_type senf::MIHTLVLengthParser::maxValue()
+prefix_ senf::MIHTLVLengthParser::value_type senf::MIHTLVLengthParser::capacity()
     const
 {
     switch (bytes() ) {
@@ -282,19 +370,19 @@ prefix_ senf::MIHTLVLengthParser::value_type senf::MIHTLVLengthParser::maxValue(
     case 4:
         return UInt24Parser::max_value + 128;
     case 5:
-        return UInt32Parser::max_value; 
+        return UInt32Parser::max_value;
     default:
         throw( MIHTLVLengthException());
     };
 }
 
-prefix_ senf::MIHTLVLengthParser const & senf::MIHTLVLengthParser::operator= (value_type other) 
+prefix_ senf::MIHTLVLengthParser const & senf::MIHTLVLengthParser::operator= (value_type other)
 {
     value(other);
-    return *this; 
+    return *this;
 }
 
-prefix_ void senf::MIHTLVLengthParser::init() const 
+prefix_ void senf::MIHTLVLengthParser::init() const
 {
     defaultInit();
     extended_length_flag() = false;
@@ -323,7 +411,7 @@ prefix_ void senf::MIHTLVLengthParser::finalize()
     if (b != 5) resize_(5);
 }
 
-prefix_ void senf::MIHTLVLengthParser:: maxValue(MIHTLVLengthParser::value_type v)
+prefix_ void senf::MIHTLVLengthParser::capacity(MIHTLVLengthParser::value_type v)
 {
     if (v <= 128)
         return;
@@ -357,7 +445,7 @@ prefix_ void senf::MIHTLVLengthParser::resize_(size_type size)
 }
 
 
-///////////////////////////////cc.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #undef prefix_
 
 \f